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(const std::vector<std::string>& params, User *srcuser)
  30 {
  31         SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
  32         /* 1.1+ FJOIN works as follows:
  33          *
  34          * Each FJOIN is sent along with a timestamp, and the side with the lowest
  35          * timestamp 'wins'. From this point on we will refer to this side as the
  36          * winner. The side with the higher timestamp loses, from this point on we
  37          * will call this side the loser or losing side. This should be familiar to
  38          * anyone who's dealt with dreamforge or TS6 before.
  39          *
  40          * When two sides of a split heal and this occurs, the following things
  41          * will happen:
  42          *
  43          * If the timestamps are exactly equal, both sides merge their privilages
  44          * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been
  45          * re-created during a split, this is safe to do.
  46          *
  47          * If the timestamps are NOT equal, the losing side removes all of its
  48          * modes from the channel, before introducing new users into the channel
  49          * which are listed in the FJOIN command's parameters. The losing side then
  50          * LOWERS its timestamp value of the channel to match that of the winning
  51          * side, and the modes of the users of the winning side are merged in with
  52          * the losing side.
  53          *
  54          * The winning side on the other hand will ignore all user modes from the
  55          * losing side, so only its own modes get applied. Life is simple for those
  56          * who succeed at internets. :-)
  57          *
  58          * Syntax:
  59          * :<sid> FJOIN <chan> <TS> <modes> :[[modes,]<uuid> [[modes,]<uuid> ... ]]
  60          * The last parameter is a list consisting of zero or more (modelist, uuid)
  61          * pairs (permanent channels may have zero users). The mode list for each
  62          * user is a concatenation of the mode letters the user has on the channel
  63          * (e.g.: "ov" if the user is opped and voiced). The order of the mode letters
  64          * are not important but if a server ecounters an unknown mode letter, it will
  65          * drop the link to avoid desync.
  66          *
  67          * InspIRCd 2.0 and older required a comma before the uuid even if the user
  68          * had no prefix modes on the channel, InspIRCd 2.2 and later does not require
  69          * a comma in this case anymore.
  70          *
  71          */
  72
  73         time_t TS = ConvToInt(params[1]);
  74         if (!TS)
  75         {
  76                 ServerInstance->Logs->Log("m_spanningtree", LOG_DEFAULT, "*** BUG? *** TS of 0 sent to FJOIN. Are some services authors smoking craq, or is it 1970 again?. Dropped.");
  77                 ServerInstance->SNO->WriteToSnoMask('d', "WARNING: The server %s is sending FJOIN with a TS of zero. Total craq. Command was dropped.", srcuser->server.c_str());
  78                 return CMD_INVALID;
  79         }
  80
  81         const std::string& channel = params[0];
  82         Channel* chan = ServerInstance->FindChan(channel);
  83         bool apply_other_sides_modes = true;
  84
  85         if (!chan)
  86         {
  87                 chan = new Channel(channel, TS);
  88         }
  89         else
  90         {
  91                 time_t ourTS = chan->age;
  92                 if (TS != ourTS)
  93                 {
  94                         ServerInstance->SNO->WriteToSnoMask('d', "Merge FJOIN received for %s, ourTS: %lu, TS: %lu, difference: %lu",
  95                                 chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (unsigned long)(ourTS - TS));
  96                         /* If our TS is less than theirs, we dont accept their modes */
  97                         if (ourTS < TS)
  98                         {
  99                                 apply_other_sides_modes = false;
 100                         }
 101                         else if (ourTS > TS)
 102                         {
 103                                 /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
 104                                 if (Utils->AnnounceTSChange)
 105                                         chan->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :TS for %s changed from %lu to %lu", chan->name.c_str(), channel.c_str(), (unsigned long) ourTS, (unsigned long) TS);
 106
 107                                 // while the name is equal in case-insensitive compare, it might differ in case; use the remote version
 108                                 chan->name = channel;
 109                                 chan->age = TS;
 110                                 chan->ClearInvites();
 111
 112                                 CommandFJoin::RemoveStatus(chan);
 113
 114                                 // 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.
 115                                 // This happens to 0-user permanent channels on the losing side, because those are removed (from the chan hash, then
 116                                 // deleted later) as soon as the permchan mode is removed from them.
 117                                 if (ServerInstance->FindChan(channel) == NULL)
 118                                 {
 119                                         chan = new Channel(channel, TS);
 120                                 }
 121                         }
 122                 }
 123         }
 124
 125         /* First up, apply their channel modes if they won the TS war */
 126         if (apply_other_sides_modes)
 127         {
 128                 std::vector<std::string> modelist;
 129                 modelist.push_back(channel);
 130
 131                 /* Remember, params[params.size() - 1] is userlist, and we don't want to apply *that* */
 132                 modelist.insert(modelist.end(), params.begin()+2, params.end()-1);
 133                 ServerInstance->SendMode(modelist, srcuser);
 134         }
 135
 136         irc::modestacker modestack(true);
 137         TreeSocket* src_socket = Utils->FindServer(srcuser->server)->GetRoute()->GetSocket();
 138
 139         /* Now, process every 'modes,uuid' pair */
 140         irc::tokenstream users(*params.rbegin());
 141         std::string item;
 142         irc::modestacker* modestackptr = (apply_other_sides_modes ? &modestack : NULL);
 143         while (users.GetToken(item))
 144         {
 145                 if (!ProcessModeUUIDPair(item, src_socket, chan, modestackptr))
 146                         return CMD_INVALID;
 147         }
 148
 149         /* Flush mode stacker if we lost the FJOIN or had equal TS */
 150         if (apply_other_sides_modes)
 151                 CommandFJoin::ApplyModeStack(srcuser, chan, modestack);
 152
 153         return CMD_SUCCESS;
 154 }
 155
 156 bool CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeSocket* src_socket, Channel* chan, irc::modestacker* modestack)
 157 {
 158         std::string::size_type comma = item.find(',');
 159
 160         // Comma not required anymore if the user has no modes
 161         std::string uuid = ((comma == std::string::npos) ? item : item.substr(comma+1));
 162         User* who = ServerInstance->FindUUID(uuid);
 163         if (!who)
 164         {
 165                 // Probably KILLed, ignore
 166                 return true;
 167         }
 168
 169         /* Check that the user's 'direction' is correct */
 170         SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
 171         TreeServer* route_back_again = Utils->BestRouteTo(who->server);
 172         if ((!route_back_again) || (route_back_again->GetSocket() != src_socket))
 173         {
 174                 return true;
 175         }
 176
 177         /* Check if the user received at least one mode */
 178         if ((modestack) && (comma > 0) && (comma != std::string::npos))
 179         {
 180                 /* Iterate through the modes and see if they are valid here, if so, apply */
 181                 std::string::const_iterator commait = item.begin()+comma;
 182                 for (std::string::const_iterator i = item.begin(); i != commait; ++i)
 183                 {
 184                         if (!ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL))
 185                         {
 186                                 ServerInstance->SNO->WriteToSnoMask('d', "Unrecognised mode '%c' for a user in FJOIN, dropping link", *i);
 187                                 return false;
 188                         }
 189
 190                         /* Add any modes this user had to the mode stack */
 191                         modestack->Push(*i, who->nick);
 192                 }
 193         }
 194
 195         chan->ForceJoin(who, NULL, route_back_again->bursting);
 196         return true;
 197 }
 198
 199 void CommandFJoin::RemoveStatus(Channel* c)
 200 {
 201         irc::modestacker stack(false);
 202
 203         for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
 204         {
 205                 ModeHandler* mh = ServerInstance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
 206
 207                 /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
 208                  * rather than applied immediately. Module unloads require this to be done immediately,
 209                  * for this function we require tidyness instead. Fixes bug #493
 210                  */
 211                 if (mh)
 212                         mh->RemoveMode(c, stack);
 213         }
 214
 215         ApplyModeStack(ServerInstance->FakeClient, c, stack);
 216 }
 217
 218 void CommandFJoin::ApplyModeStack(User* srcuser, Channel* c, irc::modestacker& stack)
 219 {
 220         parameterlist stackresult;
 221         stackresult.push_back(c->name);
 222
 223         while (stack.GetStackedLine(stackresult))
 224         {
 225                 ServerInstance->SendMode(stackresult, srcuser);
 226                 stackresult.erase(stackresult.begin() + 1, stackresult.end());
 227         }
 228 }