src/modules/m_spanningtree/fjoin.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/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 "xline.h"
  16
  17 #include "m_spanningtree/treesocket.h"
  18 #include "m_spanningtree/treeserver.h"
  19 #include "m_spanningtree/utils.h"
  20
  21 /* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/treesocket.h */
  22
  23
  24 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
  25 bool TreeSocket::ForceJoin(const std::string &source, std::deque<std::string> &params)
  26 {
  27         /* 1.1 FJOIN works as follows:
  28          *
  29          * Each FJOIN is sent along with a timestamp, and the side with the lowest
  30          * timestamp 'wins'. From this point on we will refer to this side as the
  31          * winner. The side with the higher timestamp loses, from this point on we
  32          * will call this side the loser or losing side. This should be familiar to
  33          * anyone who's dealt with dreamforge or TS6 before.
  34          *
  35          * When two sides of a split heal and this occurs, the following things
  36          * will happen:
  37          *
  38          * If the timestamps are exactly equal, both sides merge their privilages
  39          * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been
  40          * re-created during a split, this is safe to do.
  41          *
  42          * If the timestamps are NOT equal, the losing side removes all of its
  43          * modes from the channel, before introducing new users into the channel
  44          * which are listed in the FJOIN command's parameters. The losing side then
  45          * LOWERS its timestamp value of the channel to match that of the winning
  46          * side, and the modes of the users of the winning side are merged in with
  47          * the losing side.
  48          *
  49          * The winning side on the other hand will ignore all user modes from the
  50          * losing side, so only its own modes get applied. Life is simple for those
  51          * who succeed at internets. :-)
  52          *
  53          * NOTE: Unlike TS6 and dreamforge and other protocols which have SJOIN,
  54          * FJOIN does not contain the simple-modes such as +iklmnsp. Why not,
  55          * you ask? Well, quite simply because we don't need to. They'll be sent
  56          * after the FJOIN by FMODE, and FMODE is timestamped, so in the event
  57          * the losing side sends any modes for the channel which shouldnt win,
  58          * they wont as their timestamp will be too high :-)
  59          */
  60         if (params.size() < 3)
  61                 return true;
  62
  63         irc::modestacker modestack(Instance, true);                     /* Modes to apply from the users in the user list */
  64         User* who = NULL;                                               /* User we are currently checking */
  65         std::string channel = params[0];                                /* Channel name, as a string */
  66         time_t TS = atoi(params[1].c_str());                            /* Timestamp given to us for remote side */
  67         irc::tokenstream users((params.size() > 3) ? params[params.size() - 1] : "");   /* users from the user list */
  68         bool apply_other_sides_modes = true;                            /* True if we are accepting the other side's modes */
  69         Channel* chan = this->Instance->FindChan(channel);              /* The channel we're sending joins to */
  70         time_t ourTS = chan ? chan->age : Instance->Time()+600; /* The TS of our side of the link */
  71         bool created = !chan;                                           /* True if the channel doesnt exist here yet */
  72         std::string item;                                               /* One item in the list of nicks */
  73
  74         if (params.size() > 3)
  75                 params[params.size() - 1] = ":" + params[params.size() - 1];
  76
  77         Utils->DoOneToAllButSender(source,"FJOIN",params,source);
  78
  79         if (!TS)
  80         {
  81                 Instance->Logs->Log("m_spanningtree",DEFAULT,"*** BUG? *** TS of 0 sent to FJOIN. Are some services authors smoking craq, or is it 1970 again?. Dropped.");
  82                 Instance->SNO->WriteToSnoMask('d', "WARNING: The server %s is sending FJOIN with a TS of zero. Total craq. Command was dropped.", source.c_str());
  83                 return true;
  84         }
  85
  86         if (created)
  87                 chan = new Channel(Instance, channel, ourTS);
  88
  89         /* If our TS is less than theirs, we dont accept their modes */
  90         if (ourTS < TS)
  91                 apply_other_sides_modes = false;
  92
  93         /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
  94         if (ourTS > TS)
  95         {
  96                 std::deque<std::string> param_list;
  97                 if (Utils->AnnounceTSChange && chan)
  98                         chan->WriteChannelWithServ(Instance->Config->ServerName, "NOTICE %s :TS for %s changed from %lu to %lu", chan->name.c_str(), chan->name.c_str(), (unsigned long) ourTS, (unsigned long) TS);
  99                 ourTS = TS;
 100                 if (!created)
 101                 {
 102                         chan->age = TS;
 103                         param_list.push_back(channel);
 104                         this->RemoveStatus(Instance->Config->GetSID(), param_list);
 105                 }
 106         }
 107
 108         /* First up, apply their modes if they won the TS war */
 109         if (apply_other_sides_modes)
 110         {
 111                 unsigned int idx = 2;
 112                 std::vector<std::string> modelist;
 113
 114                 // Mode parser needs to know what channel to act on.
 115                 modelist.push_back(params[0]);
 116
 117                 /* Remember, params[params.size() - 1] is nicklist, and we don't want to apply *that* */
 118                 for (idx = 2; idx != (params.size() - 1); idx++)
 119                 {
 120                         modelist.push_back(params[idx]);
 121                 }
 122
 123                 this->Instance->SendMode(modelist, this->Instance->FakeClient);
 124         }
 125
 126         /* Now, process every 'modes,nick' pair */
 127         while (users.GetToken(item))
 128         {
 129                 const char* usr = item.c_str();
 130                 if (usr && *usr)
 131                 {
 132                         const char* unparsedmodes = usr;
 133                         std::string modes;
 134
 135
 136                         /* Iterate through all modes for this user and check they are valid. */
 137                         while ((*unparsedmodes) && (*unparsedmodes != ','))
 138                         {
 139                                 ModeHandler *mh = Instance->Modes->FindMode(*unparsedmodes, MODETYPE_CHANNEL);
 140                                 if (mh)
 141                                         modes += *unparsedmodes;
 142                                 else
 143                                 {
 144                                         this->SendError(std::string("Unknown status mode '")+(*unparsedmodes)+"' in FJOIN");
 145                                         return false;
 146                                 }
 147
 148                                 usr++;
 149                                 unparsedmodes++;
 150                         }
 151
 152                         /* Advance past the comma, to the nick */
 153                         usr++;
 154
 155                         /* Check the user actually exists */
 156                         who = this->Instance->FindUUID(usr);
 157                         if (who)
 158                         {
 159                                 /* Check that the user's 'direction' is correct */
 160                                 TreeServer* route_back_again = Utils->BestRouteTo(who->server);
 161                                 if ((!route_back_again) || (route_back_again->GetSocket() != this))
 162                                         continue;
 163
 164                                 /* Add any modes this user had to the mode stack */
 165                                 for (std::string::iterator x = modes.begin(); x != modes.end(); ++x)
 166                                         modestack.Push(*x, who->nick);
 167
 168                                 Channel::JoinUser(this->Instance, who, channel.c_str(), true, "", true, TS);
 169                         }
 170                         else
 171                         {
 172                                 Instance->Logs->Log("m_spanningtree",SPARSE, "Ignored nonexistant user %s in fjoin to %s (probably quit?)", usr, channel.c_str());
 173                                 continue;
 174                         }
 175                 }
 176         }
 177
 178         /* Flush mode stacker if we lost the FJOIN or had equal TS */
 179         if (apply_other_sides_modes)
 180         {
 181                 std::deque<std::string> stackresult;
 182                 std::vector<std::string> mode_junk;
 183                 mode_junk.push_back(channel);
 184
 185                 while (modestack.GetStackedLine(stackresult))
 186                 {
 187                         for (size_t j = 0; j < stackresult.size(); j++)
 188                         {
 189                                 mode_junk.push_back(stackresult[j]);
 190                         }
 191                         Instance->SendMode(mode_junk, Instance->FakeClient);
 192                 }
 193         }
 194
 195         return true;
 196 }
 197
 198 /** TODO: This creates a total mess of output and needs to really use irc::modestacker.
 199  */
 200 bool TreeSocket::RemoveStatus(const std::string &prefix, std::deque<std::string> &params)
 201 {
 202         if (params.size() < 1)
 203                 return true;
 204
 205         Channel* c = Instance->FindChan(params[0]);
 206
 207         if (c)
 208         {
 209                 irc::modestacker stack(Instance, false);
 210                 std::deque<std::string> stackresult;
 211                 std::vector<std::string> mode_junk;
 212                 mode_junk.push_back(c->name);
 213
 214                 for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
 215                 {
 216                         ModeHandler* mh = Instance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
 217
 218                         /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
 219                          * rather than applied immediately. Module unloads require this to be done immediately,
 220                          * for this function we require tidyness instead. Fixes bug #493
 221                          */
 222                         if (mh)
 223                                 mh->RemoveMode(c, &stack);
 224                 }
 225
 226                 while (stack.GetStackedLine(stackresult))
 227                 {
 228                         for (size_t j = 0; j < stackresult.size(); j++)
 229                                 mode_junk.push_back(stackresult[j]);
 230
 231                         Instance->SendMode(mode_junk, Instance->FakeClient);
 232                 }
 233         }
 234         return true;
 235 }
 236