]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/fjoin.cpp
Introduce ModeProcessFlags, can be passed to ModeParser::Process() to indicate local...
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / fjoin.cpp
index ee6c6c02a16443304c38b08874daadb6f13d5dbe..faf5345427a6e2828a27e34c4d91e62fef015f89 100644 (file)
@@ -1,30 +1,35 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
-#include "xline.h"
-
-#include "m_spanningtree/treesocket.h"
-#include "m_spanningtree/treeserver.h"
-#include "m_spanningtree/utils.h"
-
-/* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/treesocket.h */
 
+#include "inspircd.h"
+#include "commands.h"
+#include "treeserver.h"
+#include "treesocket.h"
 
 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
-bool TreeSocket::ForceJoin(const std::string &source, std::deque<std::string> &params)
+CmdResult CommandFJoin::Handle(const std::vector<std::string>& params, User *srcuser)
 {
-       /* 1.1 FJOIN works as follows:
+       SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
+       /* 1.1+ FJOIN works as follows:
         *
         * Each FJOIN is sent along with a timestamp, and the side with the lowest
         * timestamp 'wins'. From this point on we will refer to this side as the
@@ -49,181 +54,175 @@ bool TreeSocket::ForceJoin(const std::string &source, std::deque<std::string> &p
         * The winning side on the other hand will ignore all user modes from the
         * losing side, so only its own modes get applied. Life is simple for those
         * who succeed at internets. :-)
+        *
+        * Syntax:
+        * :<sid> FJOIN <chan> <TS> <modes> :[[modes,]<uuid> [[modes,]<uuid> ... ]]
+        * The last parameter is a list consisting of zero or more (modelist, uuid)
+        * pairs (permanent channels may have zero users). The mode list for each
+        * user is a concatenation of the mode letters the user has on the channel
+        * (e.g.: "ov" if the user is opped and voiced). The order of the mode letters
+        * are not important but if a server ecounters an unknown mode letter, it will
+        * drop the link to avoid desync.
+        *
+        * InspIRCd 2.0 and older required a comma before the uuid even if the user
+        * had no prefix modes on the channel, InspIRCd 2.2 and later does not require
+        * a comma in this case anymore.
+        *
         */
-       if (params.size() < 3)
-               return true;
-
-       irc::modestacker modestack(ServerInstance, true);                       /* Modes to apply from the users in the user list */
-       User* who = NULL;                                               /* User we are currently checking */
-       std::string channel = params[0];                                /* Channel name, as a string */
-       time_t TS = atoi(params[1].c_str());                            /* Timestamp given to us for remote side */
-       irc::tokenstream users((params.size() > 3) ? params[params.size() - 1] : "");   /* users from the user list */
-       bool apply_other_sides_modes = true;                            /* True if we are accepting the other side's modes */
-       Channel* chan = this->ServerInstance->FindChan(channel);                /* The channel we're sending joins to */
-       time_t ourTS = chan ? chan->age : ServerInstance->Time()+600;   /* The TS of our side of the link */
-       bool created = !chan;                                           /* True if the channel doesnt exist here yet */
-       std::string item;                                               /* One item in the list of nicks */
-
-       if (params.size() > 3)
-               params[params.size() - 1] = ":" + params[params.size() - 1];
-
-       Utils->DoOneToAllButSender(source,"FJOIN",params,source);
 
+       time_t TS = ConvToInt(params[1]);
        if (!TS)
        {
-               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.");
-               ServerInstance->SNO->WriteToSnoMask('d', "WARNING: The server %s is sending FJOIN with a TS of zero. Total craq. Command was dropped.", source.c_str());
-               return true;
+               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.");
+               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());
+               return CMD_INVALID;
        }
 
-       if (created)
-               chan = new Channel(ServerInstance, channel, ourTS);
-
-       /* If our TS is less than theirs, we dont accept their modes */
-       if (ourTS < TS)
-               apply_other_sides_modes = false;
+       const std::string& channel = params[0];
+       Channel* chan = ServerInstance->FindChan(channel);
+       bool apply_other_sides_modes = true;
 
-       /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
-       if (ourTS > TS)
+       if (!chan)
        {
-               std::deque<std::string> param_list;
-               if (Utils->AnnounceTSChange && chan)
-                       chan->WriteChannelWithServ(ServerInstance->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);
-               ourTS = TS;
-               if (!created)
+               chan = new Channel(channel, TS);
+       }
+       else
+       {
+               time_t ourTS = chan->age;
+               if (TS != ourTS)
                {
-                       chan->age = TS;
-                       param_list.push_back(channel);
-                       this->RemoveStatus(ServerInstance->Config->GetSID(), param_list);
+                       ServerInstance->SNO->WriteToSnoMask('d', "Merge FJOIN received for %s, ourTS: %lu, TS: %lu, difference: %lu",
+                               chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (unsigned long)(ourTS - TS));
+                       /* If our TS is less than theirs, we dont accept their modes */
+                       if (ourTS < TS)
+                       {
+                               apply_other_sides_modes = false;
+                       }
+                       else if (ourTS > TS)
+                       {
+                               /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
+                               if (Utils->AnnounceTSChange)
+                                       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);
+
+                               // while the name is equal in case-insensitive compare, it might differ in case; use the remote version
+                               chan->name = channel;
+                               chan->age = TS;
+                               chan->ClearInvites();
+
+                               CommandFJoin::RemoveStatus(chan);
+
+                               // 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.
+                               // This happens to 0-user permanent channels on the losing side, because those are removed (from the chan hash, then
+                               // deleted later) as soon as the permchan mode is removed from them.
+                               if (ServerInstance->FindChan(channel) == NULL)
+                               {
+                                       chan = new Channel(channel, TS);
+                               }
+                       }
                }
        }
 
-       /* First up, apply their modes if they won the TS war */
+       /* First up, apply their channel modes if they won the TS war */
        if (apply_other_sides_modes)
        {
-               unsigned int idx = 2;
                std::vector<std::string> modelist;
+               modelist.push_back(channel);
 
-               // Mode parser needs to know what channel to act on.
-               modelist.push_back(params[0]);
-
-               /* Remember, params[params.size() - 1] is nicklist, and we don't want to apply *that* */
-               for (idx = 2; idx != (params.size() - 1); idx++)
-               {
-                       modelist.push_back(params[idx]);
-               }
-
-               this->ServerInstance->SendMode(modelist, this->ServerInstance->FakeClient);
+               /* Remember, params[params.size() - 1] is userlist, and we don't want to apply *that* */
+               modelist.insert(modelist.end(), params.begin()+2, params.end()-1);
+               ServerInstance->Modes->Process(modelist, srcuser, ModeParser::MODE_LOCALONLY | ModeParser::MODE_MERGE);
        }
 
-       /* Now, process every 'modes,nick' pair */
+       irc::modestacker modestack(true);
+       TreeSocket* src_socket = Utils->FindServer(srcuser->server)->GetRoute()->GetSocket();
+
+       /* Now, process every 'modes,uuid' pair */
+       irc::tokenstream users(*params.rbegin());
+       std::string item;
+       irc::modestacker* modestackptr = (apply_other_sides_modes ? &modestack : NULL);
        while (users.GetToken(item))
        {
-               const char* usr = item.c_str();
-               if (usr && *usr)
-               {
-                       const char* unparsedmodes = usr;
-                       std::string modes;
-
-
-                       /* Iterate through all modes for this user and check they are valid. */
-                       while ((*unparsedmodes) && (*unparsedmodes != ','))
-                       {
-                               ModeHandler *mh = ServerInstance->Modes->FindMode(*unparsedmodes, MODETYPE_CHANNEL);
-                               if (mh)
-                                       modes += *unparsedmodes;
-                               else
-                               {
-                                       this->SendError(std::string("Unknown status mode '")+(*unparsedmodes)+"' in FJOIN");
-                                       return false;
-                               }
-
-                               usr++;
-                               unparsedmodes++;
-                       }
+               if (!ProcessModeUUIDPair(item, src_socket, chan, modestackptr))
+                       return CMD_INVALID;
+       }
 
-                       /* Advance past the comma, to the nick */
-                       usr++;
+       /* Flush mode stacker if we lost the FJOIN or had equal TS */
+       if (apply_other_sides_modes)
+               CommandFJoin::ApplyModeStack(srcuser, chan, modestack);
 
-                       /* Check the user actually exists */
-                       who = this->ServerInstance->FindUUID(usr);
-                       if (who)
-                       {
-                               /* Check that the user's 'direction' is correct */
-                               TreeServer* route_back_again = Utils->BestRouteTo(who->server);
-                               if ((!route_back_again) || (route_back_again->GetSocket() != this))
-                                       continue;
+       return CMD_SUCCESS;
+}
 
-                               /* Add any modes this user had to the mode stack */
-                               for (std::string::iterator x = modes.begin(); x != modes.end(); ++x)
-                                       modestack.Push(*x, who->nick);
+bool CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeSocket* src_socket, Channel* chan, irc::modestacker* modestack)
+{
+       std::string::size_type comma = item.find(',');
 
-                               Channel::JoinUser(this->ServerInstance, who, channel.c_str(), true, "", true, TS);
-                       }
-                       else
-                       {
-                               ServerInstance->Logs->Log("m_spanningtree",SPARSE, "Ignored nonexistant user %s in fjoin to %s (probably quit?)", usr, channel.c_str());
-                               continue;
-                       }
-               }
+       // Comma not required anymore if the user has no modes
+       std::string uuid = ((comma == std::string::npos) ? item : item.substr(comma+1));
+       User* who = ServerInstance->FindUUID(uuid);
+       if (!who)
+       {
+               // Probably KILLed, ignore
+               return true;
        }
 
-       /* Flush mode stacker if we lost the FJOIN or had equal TS */
-       if (apply_other_sides_modes)
+       /* Check that the user's 'direction' is correct */
+       SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
+       TreeServer* route_back_again = Utils->BestRouteTo(who->server);
+       if ((!route_back_again) || (route_back_again->GetSocket() != src_socket))
        {
-               std::deque<std::string> stackresult;
-               std::vector<std::string> mode_junk;
-               mode_junk.push_back(channel);
+               return true;
+       }
 
-               while (modestack.GetStackedLine(stackresult))
+       /* Check if the user received at least one mode */
+       if ((modestack) && (comma > 0) && (comma != std::string::npos))
+       {
+               /* Iterate through the modes and see if they are valid here, if so, apply */
+               std::string::const_iterator commait = item.begin()+comma;
+               for (std::string::const_iterator i = item.begin(); i != commait; ++i)
                {
-                       for (size_t j = 0; j < stackresult.size(); j++)
+                       if (!ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL))
                        {
-                               mode_junk.push_back(stackresult[j]);
+                               ServerInstance->SNO->WriteToSnoMask('d', "Unrecognised mode '%c' for a user in FJOIN, dropping link", *i);
+                               return false;
                        }
-                       ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);
+
+                       /* Add any modes this user had to the mode stack */
+                       modestack->Push(*i, who->nick);
                }
        }
 
+       chan->ForceJoin(who, NULL, route_back_again->bursting);
        return true;
 }
 
-/** TODO: This creates a total mess of output and needs to really use irc::modestacker.
- */
-bool TreeSocket::RemoveStatus(const std::string &prefix, std::deque<std::string> &params)
+void CommandFJoin::RemoveStatus(Channel* c)
 {
-       if (params.size() < 1)
-               return true;
-
-       Channel* c = ServerInstance->FindChan(params[0]);
+       irc::modestacker stack(false);
 
-       if (c)
+       for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
        {
-               irc::modestacker stack(ServerInstance, false);
-               std::deque<std::string> stackresult;
-               std::vector<std::string> mode_junk;
-               mode_junk.push_back(c->name);
+               ModeHandler* mh = ServerInstance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
+
+               /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
+                * rather than applied immediately. Module unloads require this to be done immediately,
+                * for this function we require tidyness instead. Fixes bug #493
+                */
+               if (mh)
+                       mh->RemoveMode(c, stack);
+       }
 
-               for (char modeletter = 'A'; modeletter <= 'z'; ++modeletter)
-               {
-                       ModeHandler* mh = ServerInstance->Modes->FindMode(modeletter, MODETYPE_CHANNEL);
-
-                       /* Passing a pointer to a modestacker here causes the mode to be put onto the mode stack,
-                        * rather than applied immediately. Module unloads require this to be done immediately,
-                        * for this function we require tidyness instead. Fixes bug #493
-                        */
-                       if (mh)
-                               mh->RemoveMode(c, &stack);
-               }
+       ApplyModeStack(ServerInstance->FakeClient, c, stack);
+}
 
-               while (stack.GetStackedLine(stackresult))
-               {
-                       for (size_t j = 0; j < stackresult.size(); j++)
-                               mode_junk.push_back(stackresult[j]);
+void CommandFJoin::ApplyModeStack(User* srcuser, Channel* c, irc::modestacker& stack)
+{
+       parameterlist stackresult;
+       stackresult.push_back(c->name);
 
-                       ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);
-               }
+       while (stack.GetStackedLine(stackresult))
+       {
+               ServerInstance->Modes->Process(stackresult, srcuser, ModeParser::MODE_LOCALONLY);
+               stackresult.erase(stackresult.begin() + 1, stackresult.end());
        }
-       return true;
 }
-