]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/fjoin.cpp
Fix the cloaking module on C++98 compilers.
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / fjoin.cpp
index d5b80fcb1f5d378b3405f900e8b7e7ee4fa1b1da..962539970fcd85fed63e69cbcc523a24e82134cc 100644 (file)
@@ -1,10 +1,12 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2015, 2018-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
  *   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>
+ *   Copyright (C) 2008, 2012 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
  *
  * 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
 #include "treeserver.h"
 #include "treesocket.h"
 
+/** FJOIN builder for rebuilding incoming FJOINs and splitting them up into multiple messages if necessary
+ */
+class FwdFJoinBuilder : public CommandFJoin::Builder
+{
+       TreeServer* const sourceserver;
+
+ public:
+       FwdFJoinBuilder(Channel* chan, TreeServer* server)
+               : CommandFJoin::Builder(chan, server)
+               , sourceserver(server)
+       {
+       }
+
+       void add(Membership* memb, std::string::const_iterator mbegin, std::string::const_iterator mend);
+};
+
 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
-CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
+CmdResult CommandFJoin::Handle(User* srcuser, Params& params)
 {
        /* 1.1+ FJOIN works as follows:
         *
@@ -54,6 +72,9 @@ CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
         * losing side, so only its own modes get applied. Life is simple for those
         * who succeed at internets. :-)
         *
+        * Outside of netbursts, the winning side also resyncs the losing side if it
+        * detects that the other side recreated the channel.
+        *
         * Syntax:
         * :<sid> FJOIN <chan> <TS> <modes> :[<member> [<member> ...]]
         * The last parameter is a list consisting of zero or more channel members
@@ -66,12 +87,36 @@ CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
         * 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
+        * had no prefix modes on the channel, InspIRCd 3.0 and later does not require
         * a comma in this case anymore.
         *
         * <membid> is a positive integer representing the id of the membership.
         * If not present (in FJOINs coming from pre-1205 servers), 0 is assumed.
         *
+        * Forwarding:
+        * FJOIN messages are forwarded with the new TS and modes. Prefix modes of
+        * members on the losing side are not forwarded.
+        * This is required to only have one server on each side of the network who
+        * decides the fate of a channel during a network merge. Otherwise, if the
+        * clock of a server is slightly off it may make a different decision than
+        * the rest of the network and desync.
+        * The prefix modes are always forwarded as-is, or not at all.
+        * One incoming FJOIN may result in more than one FJOIN being generated
+        * and forwarded mainly due to compatibility reasons with non-InspIRCd
+        * servers that don't handle more than 512 char long lines.
+        *
+        * Forwarding examples:
+        * Existing channel #chan with TS 1000, modes +n.
+        * Incoming:  :220 FJOIN #chan 1000 +t :o,220AAAAAB:0
+        * Forwarded: :220 FJOIN #chan 1000 +nt :o,220AAAAAB:0
+        * Merge modes and forward the result. Forward their prefix modes as well.
+        *
+        * Existing channel #chan with TS 1000, modes +nt.
+        * Incoming:  :220 FJOIN #CHAN 2000 +i :ov,220AAAAAB:0 o,220AAAAAC:20
+        * Forwarded: :220 FJOIN #chan 1000 +nt :,220AAAAAB:0 ,220AAAAAC:20
+        * Drop their modes, forward our modes and TS, use our channel name
+        * capitalization. Don't forward prefix modes.
+        *
         */
 
        time_t TS = ServerCommand::ExtractTS(params[1]);
@@ -79,6 +124,7 @@ CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
        const std::string& channel = params[0];
        Channel* chan = ServerInstance->FindChan(channel);
        bool apply_other_sides_modes = true;
+       TreeServer* const sourceserver = TreeServer::Get(srcuser);
 
        if (!chan)
        {
@@ -89,11 +135,19 @@ CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
                time_t ourTS = chan->age;
                if (TS != ourTS)
                {
-                       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));
+                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Merge FJOIN received for %s, ourTS: %lu, TS: %lu, difference: %ld",
+                               chan->name.c_str(), (unsigned long)ourTS, (unsigned long)TS, (long)(ourTS - TS));
                        /* If our TS is less than theirs, we dont accept their modes */
                        if (ourTS < TS)
                        {
+                               // If the source server isn't bursting then this FJOIN is the result of them recreating the channel with a higher TS.
+                               // This happens if the last user on the channel hops and before the PART propagates a user on another server joins. Fix it by doing a resync.
+                               // Servers behind us won't react this way because the forwarded FJOIN will have the correct TS.
+                               if (!sourceserver->IsBursting())
+                               {
+                                       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s recreated channel %s with higher TS, resyncing", sourceserver->GetName().c_str(), chan->name.c_str());
+                                       sourceserver->GetSocket()->SyncChannel(chan);
+                               }
                                apply_other_sides_modes = false;
                        }
                        else if (ourTS > TS)
@@ -112,61 +166,40 @@ CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
                }
        }
 
-       /* First up, apply their channel modes if they won the TS war */
+       // Apply their channel modes if we have to
+       Modes::ChangeList modechangelist;
        if (apply_other_sides_modes)
        {
-               // Need to use a modestacker here due to maxmodes
-               irc::modestacker stack(true);
-               std::vector<std::string>::const_iterator paramit = params.begin() + 3;
-               const std::vector<std::string>::const_iterator lastparamit = ((params.size() > 3) ? (params.end() - 1) : params.end());
-               for (std::string::const_iterator i = params[2].begin(); i != params[2].end(); ++i)
-               {
-                       ModeHandler* mh = ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL);
-                       if (!mh)
-                               continue;
-
-                       std::string modeparam;
-                       if ((paramit != lastparamit) && (mh->GetNumParams(true)))
-                       {
-                               modeparam = *paramit;
-                               ++paramit;
-                       }
-
-                       stack.Push(*i, modeparam);
-               }
-
-               std::vector<std::string> modelist;
-
-               // Mode parser needs to know what channel to act on.
-               modelist.push_back(params[0]);
-
-               while (stack.GetStackedLine(modelist))
-               {
-                       ServerInstance->Modes->Process(modelist, srcuser, ModeParser::MODE_LOCALONLY | ModeParser::MODE_MERGE);
-                       modelist.erase(modelist.begin() + 1, modelist.end());
-               }
+               ServerInstance->Modes.ModeParamsToChangeList(srcuser, MODETYPE_CHANNEL, params, modechangelist, 2, params.size() - 1);
+               ServerInstance->Modes->Process(srcuser, chan, NULL, modechangelist, ModeParser::MODE_LOCALONLY | ModeParser::MODE_MERGE);
+               // Reuse for prefix modes
+               modechangelist.clear();
        }
 
-       irc::modestacker modestack(true);
-       TreeServer* const sourceserver = TreeServer::Get(srcuser);
+       // Build a new FJOIN for forwarding. Put the correct TS in it and the current modes of the channel
+       // after applying theirs. If they lost, the prefix modes from their message are not forwarded.
+       FwdFJoinBuilder fwdfjoin(chan, sourceserver);
 
-       /* Now, process every 'modes,uuid' pair */
-       irc::tokenstream users(params.back());
+       // Process every member in the message
+       irc::spacesepstream users(params.back());
        std::string item;
-       irc::modestacker* modestackptr = (apply_other_sides_modes ? &modestack : NULL);
+       Modes::ChangeList* modechangelistptr = (apply_other_sides_modes ? &modechangelist : NULL);
        while (users.GetToken(item))
        {
-               ProcessModeUUIDPair(item, sourceserver, chan, modestackptr);
+               ProcessModeUUIDPair(item, sourceserver, chan, modechangelistptr, fwdfjoin);
        }
 
-       /* Flush mode stacker if we lost the FJOIN or had equal TS */
+       fwdfjoin.finalize();
+       fwdfjoin.Forward(sourceserver->GetRoute());
+
+       // Set prefix modes on their users if we lost the FJOIN or had equal TS
        if (apply_other_sides_modes)
-               CommandFJoin::ApplyModeStack(srcuser, chan, modestack);
+               ServerInstance->Modes->Process(srcuser, chan, NULL, modechangelist, ModeParser::MODE_LOCALONLY);
 
        return CMD_SUCCESS;
 }
 
-void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeServer* sourceserver, Channel* chan, irc::modestacker* modestack)
+void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeServer* sourceserver, Channel* chan, Modes::ChangeList* modechangelist, FwdFJoinBuilder& fwdfjoin)
 {
        std::string::size_type comma = item.find(',');
 
@@ -188,24 +221,32 @@ void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeServer* sour
                return;
        }
 
+       std::string::const_iterator modeendit = item.begin(); // End of the "ov" mode string
        /* Check if the user received at least one mode */
-       if ((modestack) && (comma > 0) && (comma != std::string::npos))
+       if ((modechangelist) && (comma != std::string::npos))
        {
+               modeendit += comma;
                /* 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 (std::string::const_iterator i = item.begin(); i != modeendit; ++i)
                {
-                       if (!ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL))
+                       ModeHandler* mh = ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL);
+                       if (!mh)
                                throw ProtocolException("Unrecognised mode '" + std::string(1, *i) + "'");
 
                        /* Add any modes this user had to the mode stack */
-                       modestack->Push(*i, who->nick);
+                       modechangelist->push_add(mh, who->nick);
                }
        }
 
-       Membership* memb = chan->ForceJoin(who, NULL, sourceserver->bursting);
+       Membership* memb = chan->ForceJoin(who, NULL, sourceserver->IsBursting());
        if (!memb)
+       {
+               // User was already on the channel, forward because of the modes they potentially got
+               memb = chan->GetUser(who);
+               if (memb)
+                       fwdfjoin.add(memb, item.begin(), modeendit);
                return;
+       }
 
        // Assign the id to the new Membership
        Membership::Id membid = 0;
@@ -213,85 +254,69 @@ void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeServer* sour
        if (colon != std::string::npos)
                membid = Membership::IdFromString(item.substr(colon+1));
        memb->id = membid;
+
+       // Add member to fwdfjoin with prefix modes
+       fwdfjoin.add(memb, item.begin(), modeendit);
 }
 
 void CommandFJoin::RemoveStatus(Channel* c)
 {
-       irc::modestacker stack(false);
+       Modes::ChangeList changelist;
 
        const ModeParser::ModeHandlerMap& mhs = ServerInstance->Modes->GetModes(MODETYPE_CHANNEL);
        for (ModeParser::ModeHandlerMap::const_iterator i = mhs.begin(); i != mhs.end(); ++i)
        {
                ModeHandler* mh = i->second;
 
-               /* 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
-                */
-               mh->RemoveMode(c, stack);
+               // Add the removal of this mode to the changelist. This handles all kinds of modes, including prefix modes.
+               mh->RemoveMode(c, changelist);
        }
 
-       ApplyModeStack(ServerInstance->FakeClient, c, stack);
-}
-
-void CommandFJoin::ApplyModeStack(User* srcuser, Channel* c, irc::modestacker& stack)
-{
-       parameterlist stackresult;
-       stackresult.push_back(c->name);
-
-       while (stack.GetStackedLine(stackresult))
-       {
-               ServerInstance->Modes->Process(stackresult, srcuser, ModeParser::MODE_LOCALONLY);
-               stackresult.erase(stackresult.begin() + 1, stackresult.end());
-       }
+       ServerInstance->Modes->Process(ServerInstance->FakeClient, c, NULL, changelist, ModeParser::MODE_LOCALONLY);
 }
 
 void CommandFJoin::LowerTS(Channel* chan, time_t TS, const std::string& newname)
 {
        if (Utils->AnnounceTSChange)
-               chan->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :TS for %s changed from %lu to %lu", chan->name.c_str(), newname.c_str(), (unsigned long) chan->age, (unsigned long) TS);
+       {
+               // WriteRemoteNotice is not used here because the message only needs to go to the local server.
+               chan->WriteNotice(InspIRCd::Format("Creation time of %s changed from %s to %s", newname.c_str(),
+                       InspIRCd::TimeString(chan->age).c_str(), InspIRCd::TimeString(TS).c_str()));
+       }
 
        // While the name is equal in case-insensitive compare, it might differ in case; use the remote version
        chan->name = newname;
        chan->age = TS;
 
-       // Remove all pending invites
-       chan->ClearInvites();
-
        // Clear all modes
        CommandFJoin::RemoveStatus(chan);
 
        // Unset all extensions
        chan->FreeAllExtItems();
 
-       // Clear the topic, if it isn't empty then send a topic change message to local users
-       if (!chan->topic.empty())
-       {
-               chan->topic.clear();
-               chan->WriteChannelWithServ(ServerInstance->Config->ServerName, "TOPIC %s :", chan->name.c_str());
-       }
+       // Clear the topic
+       chan->SetTopic(ServerInstance->FakeClient, std::string(), 0);
        chan->setby.clear();
-       chan->topicset = 0;
 }
 
-CommandFJoin::Builder::Builder(Channel* chan)
-       : CmdBuilder("FJOIN")
+CommandFJoin::Builder::Builder(Channel* chan, TreeServer* source)
+       : CmdBuilder(source, "FJOIN")
 {
        push(chan->name).push_int(chan->age).push_raw(" +");
        pos = str().size();
        push_raw(chan->ChanModes(true)).push_raw(" :");
 }
 
-void CommandFJoin::Builder::add(Membership* memb)
+void CommandFJoin::Builder::add(Membership* memb, std::string::const_iterator mbegin, std::string::const_iterator mend)
 {
-       push_raw(memb->modes).push_raw(',').push_raw(memb->user->uuid);
+       push_raw(mbegin, mend).push_raw(',').push_raw(memb->user->uuid);
        push_raw(':').push_raw_int(memb->id);
        push_raw(' ');
 }
 
-bool CommandFJoin::Builder::has_room(Membership* memb) const
+bool CommandFJoin::Builder::has_room(std::string::size_type nummodes) const
 {
-       return ((str().size() + memb->modes.size() + UIDGenerator::UUID_LENGTH + 2 + membid_max_digits + 1) <= maxline);
+       return ((str().size() + nummodes + UIDGenerator::UUID_LENGTH + 2 + membid_max_digits + 1) <= maxline);
 }
 
 void CommandFJoin::Builder::clear()
@@ -306,3 +331,20 @@ const std::string& CommandFJoin::Builder::finalize()
                content.erase(content.size()-1);
        return str();
 }
+
+void FwdFJoinBuilder::add(Membership* memb, std::string::const_iterator mbegin, std::string::const_iterator mend)
+{
+       // Pseudoserver compatibility:
+       // Some pseudoservers do not handle lines longer than 512 so we split long FJOINs into multiple messages.
+       // The forwarded FJOIN can end up being longer than the original one if we have more modes set and won, for example.
+
+       // Check if the member fits into the current message. If not, send it and prepare a new one.
+       if (!has_room(std::distance(mbegin, mend)))
+       {
+               finalize();
+               Forward(sourceserver);
+               clear();
+       }
+       // Add the member and their modes exactly as they sent them
+       CommandFJoin::Builder::add(memb, mbegin, mend);
+}