src/modules/m_spanningtree/fjoin.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "commands.h"
  25 #include "treeserver.h"
  26 #include "treesocket.h"
  27
  28 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
  29 CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
  30 {
  31         /* 1.1+ FJOIN works as follows:
  32          *
  33          * Each FJOIN is sent along with a timestamp, and the side with the lowest
  34          * timestamp 'wins'. From this point on we will refer to this side as the
  35          * winner. The side with the higher timestamp loses, from this point on we
  36          * will call this side the loser or losing side. This should be familiar to
  37          * anyone who's dealt with dreamforge or TS6 before.
  38          *
  39          * When two sides of a split heal and this occurs, the following things
  40          * will happen:
  41          *
  42          * If the timestamps are exactly equal, both sides merge their privilages
  43          * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been
  44          * re-created during a split, this is safe to do.
  45          *
  46          * If the timestamps are NOT equal, the losing side removes all of its
  47          * modes from the channel, before introducing new users into the channel
  48          * which are listed in the FJOIN command's parameters. The losing side then
  49          * LOWERS its timestamp value of the channel to match that of the winning
  50          * side, and the modes of the users of the winning side are merged in with
  51          * the losing side.
  52          *
  53          * The winning side on the other hand will ignore all user modes from the
  54          * losing side, so only its own modes get applied. Life is simple for those
  55          * who succeed at internets. :-)
  56          *
  57          * Syntax:
  58          * :<sid> FJOIN <chan> <TS> <modes> :[<member> [<member> ...]]
  59          * The last parameter is a list consisting of zero or more channel members
  60          * (permanent channels may have zero users). Each entry on the list is in the
  61          * following format:
  62          * [[<modes>,]<uuid>[:<membid>]
  63          * <modes> is a concatenation of the mode letters the user has on the channel
  64          * (e.g.: "ov" if the user is opped and voiced). The order of the mode letters
  65          * are not important but if a server ecounters an unknown mode letter, it will
  66          * drop the link to avoid desync.
  67          *
  68          * InspIRCd 2.0 and older required a comma before the uuid even if the user
  69          * had no prefix modes on the channel, InspIRCd 2.2 and later does not require
  70          * a comma in this case anymore.
  71          *
  72          * <membid> is a positive integer representing the id of the membership.
  73          * If not present (in FJOINs coming from pre-1205 servers), 0 is assumed.
  74          *
  75          */
  76
  77         time_t TS = ServerCommand::ExtractTS(params[1]);
  78
  79         const std::string& channel = params[0];
  80         Channel* chan = ServerInstance->FindChan(channel);
  81         bool apply_other_sides_modes = true;
  82
  83         if (!chan)
  84         {
  85                 chan = new Channel(channel, TS);
  86         }
  87         else
  88         {
  89                 time_t ourTS = chan->age;
  90                 if (TS != ourTS)
  91                 {
  92                         ServerInstance->SNO->WriteToSnoMask('d', "Merge FJOIN received for %s, ourTS: %lu, TS: %lu, difference: %lu",
  93                                 chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (unsigned long)(ourTS - TS));
  94                         /* If our TS is less than theirs, we dont accept their modes */
  95                         if (ourTS < TS)
  96                         {
  97                                 apply_other_sides_modes = false;
  98                         }
  99                         else if (ourTS > TS)
 100                         {
 101                                 // Our TS is greater than theirs, remove all modes, extensions, etc. from the channel
 102                                 LowerTS(chan, TS, channel);
 103
 104                                 // XXX: If the channel does not exist in the chan hash at this point, create it so the remote modes can be applied on it.
 105                                 // This happens to 0-user permanent channels on the losing side, because those are removed (from the chan hash, then
 106                                 // deleted later) as soon as the permchan mode is removed from them.
 107                                 if (ServerInstance->FindChan(channel) == NULL)
 108                                 {
 109                                         chan = new Channel(channel, TS);
 110                                 }
 111                         }
 112                 }
 113         }
 114
 115         /* First up, apply their channel modes if they won the TS war */
 116         Modes::ChangeList modechangelist;
 117         if (apply_other_sides_modes)
 118         {
 119                 ServerInstance->Modes.ModeParamsToChangeList(srcuser, MODETYPE_CHANNEL, params, modechangelist, 2, params.size() - 1);
 120                 ServerInstance->Modes->Process(srcuser, chan, NULL, modechangelist, ModeParser::MODE_LOCALONLY | ModeParser::MODE_MERGE);
 121                 // Reuse for prefix modes
 122                 modechangelist.clear();
 123         }
 124
 125         TreeServer* const sourceserver = TreeServer::Get(srcuser);
 126
 127         /* Now, process every 'modes,uuid' pair */
 128         irc::tokenstream users(params.back());
 129         std::string item;
 130         Modes::ChangeList* modechangelistptr = (apply_other_sides_modes ? &modechangelist : NULL);
 131         while (users.GetToken(item))
 132         {
 133                 ProcessModeUUIDPair(item, sourceserver, chan, modechangelistptr);
 134         }
 135
 136         // Set prefix modes on their users if we lost the FJOIN or had equal TS
 137         if (apply_other_sides_modes)
 138                 ServerInstance->Modes->Process(srcuser, chan, NULL, modechangelist, ModeParser::MODE_LOCALONLY);
 139
 140         return CMD_SUCCESS;
 141 }
 142
 143 void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeServer* sourceserver, Channel* chan, Modes::ChangeList* modechangelist)
 144 {
 145         std::string::size_type comma = item.find(',');
 146
 147         // Comma not required anymore if the user has no modes
 148         const std::string::size_type ubegin = (comma == std::string::npos ? 0 : comma+1);
 149         std::string uuid(item, ubegin, UIDGenerator::UUID_LENGTH);
 150         User* who = ServerInstance->FindUUID(uuid);
 151         if (!who)
 152         {
 153                 // Probably KILLed, ignore
 154                 return;
 155         }
 156
 157         TreeSocket* src_socket = sourceserver->GetSocket();
 158         /* Check that the user's 'direction' is correct */
 159         TreeServer* route_back_again = TreeServer::Get(who);
 160         if (route_back_again->GetSocket() != src_socket)
 161         {
 162                 return;
 163         }
 164
 165         /* Check if the user received at least one mode */
 166         if ((modechangelist) && (comma > 0) && (comma != std::string::npos))
 167         {
 168                 /* Iterate through the modes and see if they are valid here, if so, apply */
 169                 std::string::const_iterator commait = item.begin()+comma;
 170                 for (std::string::const_iterator i = item.begin(); i != commait; ++i)
 171                 {
 172                         ModeHandler* mh = ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL);
 173                         if (!mh)
 174                                 throw ProtocolException("Unrecognised mode '" + std::string(1, *i) + "'");
 175
 176                         /* Add any modes this user had to the mode stack */
 177                         modechangelist->push_add(mh, who->nick);
 178                 }
 179         }
 180
 181         Membership* memb = chan->ForceJoin(who, NULL, sourceserver->IsBursting());
 182         if (!memb)
 183                 return;
 184
 185         // Assign the id to the new Membership
 186         Membership::Id membid = 0;
 187         const std::string::size_type colon = item.rfind(':');
 188         if (colon != std::string::npos)
 189                 membid = Membership::IdFromString(item.substr(colon+1));
 190         memb->id = membid;
 191 }
 192
 193 void CommandFJoin::RemoveStatus(Channel* c)
 194 {
 195         Modes::ChangeList changelist;
 196
 197         const ModeParser::ModeHandlerMap& mhs = ServerInstance->Modes->GetModes(MODETYPE_CHANNEL);
 198         for (ModeParser::ModeHandlerMap::const_iterator i = mhs.begin(); i != mhs.end(); ++i)
 199         {
 200                 ModeHandler* mh = i->second;
 201
 202                 /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
 203                  * rather than applied immediately. Module unloads require this to be done immediately,
 204                  * for this function we require tidyness instead. Fixes bug #493
 205                  */
 206                 mh->RemoveMode(c, changelist);
 207         }
 208
 209         ServerInstance->Modes->Process(ServerInstance->FakeClient, c, NULL, changelist, ModeParser::MODE_LOCALONLY);
 210 }
 211
 212 void CommandFJoin::LowerTS(Channel* chan, time_t TS, const std::string& newname)
 213 {
 214         if (Utils->AnnounceTSChange)
 215                 chan->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :TS for %s changed from %lu to %lu", chan->name.c_str(), newname.c_str(), (unsigned long) chan->age, (unsigned long) TS);
 216
 217         // While the name is equal in case-insensitive compare, it might differ in case; use the remote version
 218         chan->name = newname;
 219         chan->age = TS;
 220
 221         // Remove all pending invites
 222         chan->ClearInvites();
 223
 224         // Clear all modes
 225         CommandFJoin::RemoveStatus(chan);
 226
 227         // Unset all extensions
 228         chan->FreeAllExtItems();
 229
 230         // Clear the topic, if it isn't empty then send a topic change message to local users
 231         if (!chan->topic.empty())
 232         {
 233                 chan->topic.clear();
 234                 chan->WriteChannelWithServ(ServerInstance->Config->ServerName, "TOPIC %s :", chan->name.c_str());
 235         }
 236         chan->setby.clear();
 237         chan->topicset = 0;
 238 }
 239
 240 CommandFJoin::Builder::Builder(Channel* chan)
 241         : CmdBuilder("FJOIN")
 242 {
 243         push(chan->name).push_int(chan->age).push_raw(" +");
 244         pos = str().size();
 245         push_raw(chan->ChanModes(true)).push_raw(" :");
 246 }
 247
 248 void CommandFJoin::Builder::add(Membership* memb)
 249 {
 250         push_raw(memb->modes).push_raw(',').push_raw(memb->user->uuid);
 251         push_raw(':').push_raw_int(memb->id);
 252         push_raw(' ');
 253 }
 254
 255 bool CommandFJoin::Builder::has_room(Membership* memb) const
 256 {
 257         return ((str().size() + memb->modes.size() + UIDGenerator::UUID_LENGTH + 2 + membid_max_digits + 1) <= maxline);
 258 }
 259
 260 void CommandFJoin::Builder::clear()
 261 {
 262         content.erase(pos);
 263         push_raw(" :");
 264 }
 265
 266 const std::string& CommandFJoin::Builder::finalize()
 267 {
 268         if (*content.rbegin() == ' ')
 269                 content.erase(content.size()-1);
 270         return str();
 271 }