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
  59         irc::modestacker modestack(true);                       /* Modes to apply from the users in the user list */
  60         User* who = NULL;                                               /* User we are currently checking */
  61         std::string channel = params[0];                                /* Channel name, as a string */
  62         time_t TS = atoi(params[1].c_str());                            /* Timestamp given to us for remote side */
  63         irc::tokenstream users((params.size() > 3) ? params[params.size() - 1] : "");   /* users from the user list */
  64         bool apply_other_sides_modes = true;                            /* True if we are accepting the other side's modes */
  65         Channel* chan = ServerInstance->FindChan(channel);              /* The channel we're sending joins to */
  66         bool created = !chan;                                           /* True if the channel doesnt exist here yet */
  67         std::string item;                                               /* One item in the list of nicks */
  68
  69         TreeSocket* src_socket = Utils->FindServer(srcuser->server)->GetRoute()->GetSocket();
  70
  71         if (!TS)
  72         {
  73                 ServerInstance->Logs->Log("m_spanningtree",DEFAULT,"*** BUG? *** TS of 0 sent to FJOIN. Are some services authors smoking craq, or is it 1970 again?. Dropped.");
  74                 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());
  75                 return CMD_INVALID;
  76         }
  77
  78         if (created)
  79         {
  80                 chan = new Channel(channel, TS);
  81                 ServerInstance->SNO->WriteToSnoMask('d', "Creation FJOIN received for %s, timestamp: %lu", chan->name.c_str(), (unsigned long)TS);
  82         }
  83         else
  84         {
  85                 time_t ourTS = chan->age;
  86
  87                 if (TS != ourTS)
  88                         ServerInstance->SNO->WriteToSnoMask('d', "Merge FJOIN received for %s, ourTS: %lu, TS: %lu, difference: %lu",
  89                                 chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (unsigned long)(ourTS - TS));
  90                 /* If our TS is less than theirs, we dont accept their modes */
  91                 if (ourTS < TS)
  92                 {
  93                         ServerInstance->SNO->WriteToSnoMask('d', "NOT Applying modes from other side");
  94                         apply_other_sides_modes = false;
  95                 }
  96                 else if (ourTS > TS)
  97                 {
  98                         /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
  99                         ServerInstance->SNO->WriteToSnoMask('d', "Removing our modes, accepting remote");
 100                         parameterlist param_list;
 101                         if (Utils->AnnounceTSChange)
 102                                 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);
 103                         // while the name is equal in case-insensitive compare, it might differ in case; use the remote version
 104                         chan->name = channel;
 105                         chan->age = TS;
 106                         chan->ClearInvites();
 107                         param_list.push_back(channel);
 108                         this->RemoveStatus(ServerInstance->FakeClient, param_list);
 109
 110                         // 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.
 111                         // This happens to 0-user permanent channels on the losing side, because those are removed (from the chan hash, then
 112                         // deleted later) as soon as the permchan mode is removed from them.
 113                         if (ServerInstance->FindChan(channel) == NULL)
 114                         {
 115                                 chan = new Channel(channel, TS);
 116                         }
 117                 }
 118                 // The silent case here is ourTS == TS, we don't need to remove modes here, just to merge them later on.
 119         }
 120
 121         /* First up, apply their modes if they won the TS war */
 122         if (apply_other_sides_modes)
 123         {
 124                 // Need to use a modestacker here due to maxmodes
 125                 irc::modestacker stack(true);
 126                 std::vector<std::string>::const_iterator paramit = params.begin() + 3;
 127                 const std::vector<std::string>::const_iterator lastparamit = ((params.size() > 3) ? (params.end() - 1) : params.end());
 128                 for (std::string::const_iterator i = params[2].begin(); i != params[2].end(); ++i)
 129                 {
 130                         ModeHandler* mh = ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL);
 131                         if (!mh)
 132                                 continue;
 133
 134                         std::string modeparam;
 135                         if ((paramit != lastparamit) && (mh->GetNumParams(true)))
 136                         {
 137                                 modeparam = *paramit;
 138                                 ++paramit;
 139                         }
 140
 141                         stack.Push(*i, modeparam);
 142                 }
 143
 144                 std::vector<std::string> modelist;
 145
 146                 // Mode parser needs to know what channel to act on.
 147                 modelist.push_back(params[0]);
 148
 149                 while (stack.GetStackedLine(modelist))
 150                 {
 151                         ServerInstance->Modes->Process(modelist, srcuser, true);
 152                         modelist.erase(modelist.begin() + 1, modelist.end());
 153                 }
 154
 155                 ServerInstance->Modes->Process(modelist, srcuser, true);
 156         }
 157
 158         /* Now, process every 'modes,nick' pair */
 159         while (users.GetToken(item))
 160         {
 161                 const char* usr = item.c_str();
 162                 if (usr && *usr)
 163                 {
 164                         const char* unparsedmodes = usr;
 165                         std::string modes;
 166
 167
 168                         /* Iterate through all modes for this user and check they are valid. */
 169                         while ((*unparsedmodes) && (*unparsedmodes != ','))
 170                         {
 171                                 ModeHandler *mh = ServerInstance->Modes->FindMode(*unparsedmodes, MODETYPE_CHANNEL);
 172                                 if (!mh)
 173                                 {
 174                                         ServerInstance->Logs->Log("m_spanningtree", SPARSE, "Unrecognised mode %c, dropping link", *unparsedmodes);
 175                                         return CMD_INVALID;
 176                                 }
 177
 178                                 modes += *unparsedmodes;
 179                                 usr++;
 180                                 unparsedmodes++;
 181                         }
 182
 183                         /* Advance past the comma, to the nick */
 184                         usr++;
 185
 186                         /* Check the user actually exists */
 187                         who = ServerInstance->FindUUID(usr);
 188                         if (who)
 189                         {
 190                                 /* Check that the user's 'direction' is correct */
 191                                 TreeServer* route_back_again = Utils->BestRouteTo(who->server);
 192                                 if ((!route_back_again) || (route_back_again->GetSocket() != src_socket))
 193                                         continue;
 194
 195                                 /* Add any modes this user had to the mode stack */
 196                                 for (std::string::iterator x = modes.begin(); x != modes.end(); ++x)
 197                                         modestack.Push(*x, who->nick);
 198
 199                                 Channel::JoinUser(who, channel.c_str(), true, "", route_back_again->bursting, TS);
 200                         }
 201                         else
 202                         {
 203                                 ServerInstance->Logs->Log("m_spanningtree",SPARSE, "Ignored nonexistant user %s in fjoin to %s (probably quit?)", usr, channel.c_str());
 204                                 continue;
 205                         }
 206                 }
 207         }
 208
 209         /* Flush mode stacker if we lost the FJOIN or had equal TS */
 210         if (apply_other_sides_modes)
 211         {
 212                 parameterlist stackresult;
 213                 stackresult.push_back(channel);
 214
 215                 while (modestack.GetStackedLine(stackresult))
 216                 {
 217                         ServerInstance->SendMode(stackresult, srcuser);
 218                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
 219                 }
 220         }
 221         return CMD_SUCCESS;
 222 }
 223
 224 void CommandFJoin::RemoveStatus(User* srcuser, parameterlist &params)
 225 {
 226         if (params.size() < 1)
 227                 return;
 228
 229         Channel* c = ServerInstance->FindChan(params[0]);
 230
 231         if (c)
 232         {
 233                 irc::modestacker stack(false);
 234                 parameterlist stackresult;
 235                 stackresult.push_back(c->name);
 236
 237                 for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
 238                 {
 239                         ModeHandler* mh = ServerInstance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
 240
 241                         /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
 242                          * rather than applied immediately. Module unloads require this to be done immediately,
 243                          * for this function we require tidyness instead. Fixes bug #493
 244                          */
 245                         if (mh)
 246                                 mh->RemoveMode(c, &stack);
 247                 }
 248
 249                 while (stack.GetStackedLine(stackresult))
 250                 {
 251                         ServerInstance->SendMode(stackresult, srcuser);
 252                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
 253                 }
 254         }
 255 }
 256