src/modules/m_spanningtree/nickcollide.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #include "inspircd.h"
  22
  23 #include "treesocket.h"
  24 #include "treeserver.h"
  25 #include "utils.h"
  26 #include "commandbuilder.h"
  27
  28 /*
  29  * Yes, this function looks a little ugly.
  30  * However, in some circumstances we may not have a User, so we need to do things this way.
  31  * Returns 1 if colliding local client, 2 if colliding remote, 3 if colliding both.
  32  * Sends SAVEs as appropriate and forces nick change of the user 'u' if our side loses or if both lose.
  33  * Does not change the nick of the user that is trying to claim the nick of 'u', i.e. the "remote" user.
  34  */
  35 int SpanningTreeUtilities::DoCollision(User* u, TreeServer* server, time_t remotets, const std::string& remoteident, const std::string& remoteip, const std::string& remoteuid)
  36 {
  37         // At this point we're sure that a collision happened, increment the counter regardless of who wins
  38         ServerInstance->stats.Collisions++;
  39
  40         /*
  41          * Under old protocol rules, we would have had to kill both clients.
  42          * Really, this sucks.
  43          * These days, we have UID. And, so what we do is, force nick change client(s)
  44          * involved according to timestamp rules.
  45          *
  46          * RULES:
  47          *  user@ip equal:
  48          *   Force nick change on OLDER timestamped client
  49          *  user@ip differ:
  50          *   Force nick change on NEWER timestamped client
  51          *  TS EQUAL:
  52          *   FNC both.
  53          *
  54          * This stops abusive use of collisions, simplifies problems with loops, and so on.
  55          *   -- w00t
  56          */
  57         bool bChangeLocal = true;
  58         bool bChangeRemote = true;
  59
  60         /* for brevity, don't use the User - use defines to avoid any copy */
  61         #define localts u->age
  62         #define localident u->ident
  63         #define localip u->GetIPString()
  64
  65         // If the timestamps are not equal only one of the users has to change nick,
  66         // otherwise both have to change
  67         if (remotets != localts)
  68         {
  69                 /* first, let's see if ident@host matches. */
  70                 bool SamePerson = (localident == remoteident)
  71                                 && (localip == remoteip);
  72
  73                 /*
  74                  * if ident@ip is equal, and theirs is newer, or
  75                  * ident@ip differ, and ours is newer
  76                  */
  77                 if((SamePerson && remotets < localts) ||
  78                    (!SamePerson && remotets > localts))
  79                 {
  80                         // Only remote needs to change
  81                         bChangeLocal = false;
  82                 }
  83                 else
  84                 {
  85                         // Only ours needs to change
  86                         bChangeRemote = false;
  87                 }
  88         }
  89
  90         /*
  91          * Send SAVE and accept the losing client with its UID (as we know the SAVE will
  92          * not fail under any circumstances -- UIDs are netwide exclusive).
  93          *
  94          * This means that each side of a collide will generate one extra NICK back to where
  95          * they have just linked (and where it got the SAVE from), however, it will
  96          * be dropped harmlessly as it will come in as :928AAAB NICK 928AAAB, and we already
  97          * have 928AAAB's nick set to that.
  98          *   -- w00t
  99          */
 100
 101         if (bChangeLocal)
 102         {
 103                 /*
 104                  * Local-side nick needs to change. Just in case we are hub, and
 105                  * this "local" nick is actually behind us, send a SAVE out.
 106                  */
 107                 CmdBuilder params("SAVE");
 108                 params.push_back(u->uuid);
 109                 params.push_back(ConvToStr(u->age));
 110                 params.Broadcast();
 111
 112                 u->ChangeNick(u->uuid);
 113
 114                 if (!bChangeRemote)
 115                         return 1;
 116         }
 117         if (bChangeRemote)
 118         {
 119                 /*
 120                  * Remote side needs to change. If this happens, we modify the UID or NICK and
 121                  * send back a SAVE to the source.
 122                  */
 123                 TreeSocket* sock = server->GetSocket();
 124                 sock->WriteLine(CmdBuilder("SAVE").push(remoteuid).push_int(remotets));
 125
 126                 if (!bChangeLocal)
 127                         return 2;
 128         }
 129
 130         return 3;
 131 }