src/modules/m_spanningtree/fjoin.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "commands.h"
  16 #include "treeserver.h"
  17 #include "treesocket.h"
  18
  19 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
  20 CmdResult CommandFJoin::Handle(const std::vector<std::string>& params, User *srcuser)
  21 {
  22         SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
  23         /* 1.1 FJOIN works as follows:
  24          *
  25          * Each FJOIN is sent along with a timestamp, and the side with the lowest
  26          * timestamp 'wins'. From this point on we will refer to this side as the
  27          * winner. The side with the higher timestamp loses, from this point on we
  28          * will call this side the loser or losing side. This should be familiar to
  29          * anyone who's dealt with dreamforge or TS6 before.
  30          *
  31          * When two sides of a split heal and this occurs, the following things
  32          * will happen:
  33          *
  34          * If the timestamps are exactly equal, both sides merge their privilages
  35          * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been
  36          * re-created during a split, this is safe to do.
  37          *
  38          * If the timestamps are NOT equal, the losing side removes all of its
  39          * modes from the channel, before introducing new users into the channel
  40          * which are listed in the FJOIN command's parameters. The losing side then
  41          * LOWERS its timestamp value of the channel to match that of the winning
  42          * side, and the modes of the users of the winning side are merged in with
  43          * the losing side.
  44          *
  45          * The winning side on the other hand will ignore all user modes from the
  46          * losing side, so only its own modes get applied. Life is simple for those
  47          * who succeed at internets. :-)
  48          */
  49         if (params.size() < 3)
  50                 return CMD_INVALID;
  51
  52         irc::modestacker modestack(true);                       /* Modes to apply from the users in the user list */
  53         User* who = NULL;                                               /* User we are currently checking */
  54         std::string channel = params[0];                                /* Channel name, as a string */
  55         time_t TS = atoi(params[1].c_str());                            /* Timestamp given to us for remote side */
  56         irc::tokenstream users((params.size() > 3) ? params[params.size() - 1] : "");   /* users from the user list */
  57         bool apply_other_sides_modes = true;                            /* True if we are accepting the other side's modes */
  58         Channel* chan = ServerInstance->FindChan(channel);              /* The channel we're sending joins to */
  59         bool created = !chan;                                           /* True if the channel doesnt exist here yet */
  60         std::string item;                                               /* One item in the list of nicks */
  61
  62         TreeSocket* src_socket = Utils->FindServer(srcuser->server)->GetRoute()->GetSocket();
  63
  64         if (!TS)
  65         {
  66                 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.");
  67                 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());
  68                 return CMD_INVALID;
  69         }
  70
  71         if (created)
  72         {
  73                 chan = new Channel(channel, TS);
  74                 ServerInstance->SNO->WriteToSnoMask('d', "Creation FJOIN recieved for %s, timestamp: %lu", chan->name.c_str(), (unsigned long)TS);
  75         }
  76         else
  77         {
  78                 time_t ourTS = chan->age;
  79
  80                 if (TS != ourTS)
  81                         ServerInstance->SNO->WriteToSnoMask('d', "Merge FJOIN recieved for %s, ourTS: %lu, TS: %lu, difference: %lu",
  82                                 chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (unsigned long)(ourTS - TS));
  83                 /* If our TS is less than theirs, we dont accept their modes */
  84                 if (ourTS < TS)
  85                 {
  86                         ServerInstance->SNO->WriteToSnoMask('d', "NOT Applying modes from other side");
  87                         apply_other_sides_modes = false;
  88                 }
  89                 else if (ourTS > TS)
  90                 {
  91                         /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
  92                         ServerInstance->SNO->WriteToSnoMask('d', "Removing our modes, accepting remote");
  93                         parameterlist param_list;
  94                         if (Utils->AnnounceTSChange)
  95                                 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);
  96                         ourTS = TS;
  97                         // while the name is equal in case-insensitive compare, it might differ in case; use the remote version
  98                         chan->name = channel;
  99                         chan->age = TS;
 100                         param_list.push_back(channel);
 101                         this->RemoveStatus(ServerInstance->FakeClient, param_list);
 102                 }
 103                 // The silent case here is ourTS == TS, we don't need to remove modes here, just to merge them later on.
 104         }
 105
 106         /* First up, apply their modes if they won the TS war */
 107         if (apply_other_sides_modes)
 108         {
 109                 unsigned int idx = 2;
 110                 std::vector<std::string> modelist;
 111
 112                 // Mode parser needs to know what channel to act on.
 113                 modelist.push_back(params[0]);
 114
 115                 /* Remember, params[params.size() - 1] is nicklist, and we don't want to apply *that* */
 116                 for (idx = 2; idx != (params.size() - 1); idx++)
 117                 {
 118                         modelist.push_back(params[idx]);
 119                 }
 120
 121                 ServerInstance->SendMode(modelist, srcuser);
 122         }
 123
 124         /* Now, process every 'modes,nick' pair */
 125         while (users.GetToken(item))
 126         {
 127                 const char* usr = item.c_str();
 128                 if (usr && *usr)
 129                 {
 130                         const char* unparsedmodes = usr;
 131                         std::string modes;
 132
 133
 134                         /* Iterate through all modes for this user and check they are valid. */
 135                         while ((*unparsedmodes) && (*unparsedmodes != ','))
 136                         {
 137                                 ModeHandler *mh = ServerInstance->Modes->FindMode(*unparsedmodes, MODETYPE_CHANNEL);
 138                                 if (mh)
 139                                         modes += *unparsedmodes;
 140                                 else
 141                                         return CMD_INVALID;
 142
 143                                 usr++;
 144                                 unparsedmodes++;
 145                         }
 146
 147                         /* Advance past the comma, to the nick */
 148                         usr++;
 149
 150                         /* Check the user actually exists */
 151                         who = ServerInstance->FindUUID(usr);
 152                         if (who)
 153                         {
 154                                 /* Check that the user's 'direction' is correct */
 155                                 TreeServer* route_back_again = Utils->BestRouteTo(who->server);
 156                                 if ((!route_back_again) || (route_back_again->GetSocket() != src_socket))
 157                                         continue;
 158
 159                                 /* Add any modes this user had to the mode stack */
 160                                 for (std::string::iterator x = modes.begin(); x != modes.end(); ++x)
 161                                         modestack.Push(*x, who->nick);
 162
 163                                 Channel::JoinUser(who, channel.c_str(), true, "", route_back_again->bursting, TS);
 164                         }
 165                         else
 166                         {
 167                                 ServerInstance->Logs->Log("m_spanningtree",SPARSE, "Ignored nonexistant user %s in fjoin to %s (probably quit?)", usr, channel.c_str());
 168                                 continue;
 169                         }
 170                 }
 171         }
 172
 173         /* Flush mode stacker if we lost the FJOIN or had equal TS */
 174         if (apply_other_sides_modes)
 175         {
 176                 parameterlist stackresult;
 177                 stackresult.push_back(channel);
 178
 179                 while (modestack.GetStackedLine(stackresult))
 180                 {
 181                         ServerInstance->SendMode(stackresult, srcuser);
 182                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
 183                 }
 184         }
 185         return CMD_SUCCESS;
 186 }
 187
 188 void CommandFJoin::RemoveStatus(User* srcuser, parameterlist &params)
 189 {
 190         if (params.size() < 1)
 191                 return;
 192
 193         Channel* c = ServerInstance->FindChan(params[0]);
 194
 195         if (c)
 196         {
 197                 irc::modestacker stack(false);
 198                 parameterlist stackresult;
 199                 stackresult.push_back(c->name);
 200
 201                 for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
 202                 {
 203                         ModeHandler* mh = ServerInstance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
 204
 205                         /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
 206                          * rather than applied immediately. Module unloads require this to be done immediately,
 207                          * for this function we require tidyness instead. Fixes bug #493
 208                          */
 209                         if (mh)
 210                                 mh->RemoveMode(c, &stack);
 211                 }
 212
 213                 while (stack.GetStackedLine(stackresult))
 214                 {
 215                         ServerInstance->SendMode(stackresult, srcuser);
 216                         stackresult.erase(stackresult.begin() + 1, stackresult.end());
 217                 }
 218         }
 219 }
 220