]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/fjoin.cpp
Remove now needless User::ForceNickChange()
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / fjoin.cpp
index 50775be1d30f7f9931cb279f4bb162182b8bf6fd..d8027628fbd2fa0051d9f176c37311bc24338523 100644 (file)
 #include "treesocket.h"
 
 /** FJOIN, almost identical to TS6 SJOIN, except for nicklist handling. */
-CmdResult CommandFJoin::Handle(const std::vector<std::string>& params, User *srcuser)
+CmdResult CommandFJoin::Handle(User* srcuser, std::vector<std::string>& params)
 {
-       SpanningTreeUtilities* Utils = ((ModuleSpanningTree*)(Module*)creator)->Utils;
-       /* 1.1 FJOIN works as follows:
+       /* 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
@@ -54,177 +53,255 @@ CmdResult CommandFJoin::Handle(const std::vector<std::string>& params, User *src
         * 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> :[<member> [<member> ...]]
+        * The last parameter is a list consisting of zero or more channel members
+        * (permanent channels may have zero users). Each entry on the list is in the
+        * following format:
+        * [[<modes>,]<uuid>[:<membid>]
+        * <modes> 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.
+        *
+        * <membid> is a positive integer representing the id of the membership.
+        * If not present (in FJOINs coming from pre-1205 servers), 0 is assumed.
+        *
         */
-       if (params.size() < 3)
-               return CMD_INVALID;
-
-       irc::modestacker modestack(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 = ServerInstance->FindChan(channel);              /* The channel we're sending joins to */
-       bool created = !chan;                                           /* True if the channel doesnt exist here yet */
-       std::string item;                                               /* One item in the list of nicks */
-
-       TreeSocket* src_socket = Utils->FindServer(srcuser->server)->GetRoute()->GetSocket();
-
-       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.", srcuser->server.c_str());
-               return CMD_INVALID;
-       }
 
-       if (created)
+       time_t TS = ServerCommand::ExtractTS(params[1]);
+
+       const std::string& channel = params[0];
+       Channel* chan = ServerInstance->FindChan(channel);
+       bool apply_other_sides_modes = true;
+
+       if (!chan)
        {
                chan = new Channel(channel, TS);
-               ServerInstance->SNO->WriteToSnoMask('d', "Creation FJOIN received for %s, timestamp: %lu", chan->name.c_str(), (unsigned long)TS);
        }
        else
        {
                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));
-               /* If our TS is less than theirs, we dont accept their modes */
-               if (ourTS < TS)
-               {
-                       ServerInstance->SNO->WriteToSnoMask('d', "NOT Applying modes from other side");
-                       apply_other_sides_modes = false;
-               }
-               else if (ourTS > TS)
-               {
-                       /* Our TS greater than theirs, clear all our modes from the channel, accept theirs. */
-                       ServerInstance->SNO->WriteToSnoMask('d', "Removing our modes, accepting remote");
-                       parameterlist param_list;
-                       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;
-                       param_list.push_back(channel);
-                       this->RemoveStatus(ServerInstance->FakeClient, param_list);
+                       /* 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 is greater than theirs, remove all modes, extensions, etc. from the channel
+                               LowerTS(chan, TS, channel);
+
+                               // 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);
+                               }
+                       }
                }
-               // The silent case here is ourTS == TS, we don't need to remove modes here, just to merge them later on.
        }
 
-       /* 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;
+               // 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]);
 
-               /* Remember, params[params.size() - 1] is nicklist, and we don't want to apply *that* */
-               for (idx = 2; idx != (params.size() - 1); idx++)
+               while (stack.GetStackedLine(modelist))
                {
-                       modelist.push_back(params[idx]);
+                       ServerInstance->Modes->Process(modelist, srcuser, ModeParser::MODE_LOCALONLY | ModeParser::MODE_MERGE);
+                       modelist.erase(modelist.begin() + 1, modelist.end());
                }
-
-               ServerInstance->SendMode(modelist, srcuser);
        }
 
-       /* Now, process every 'modes,nick' pair */
+       irc::modestacker modestack(true);
+       TreeSocket* src_socket = TreeServer::Get(srcuser)->GetSocket();
+
+       /* Now, process every 'modes,uuid' pair */
+       irc::tokenstream users(params.back());
+       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;
+               ProcessModeUUIDPair(item, src_socket, chan, modestackptr);
+       }
 
+       /* Flush mode stacker if we lost the FJOIN or had equal TS */
+       if (apply_other_sides_modes)
+               CommandFJoin::ApplyModeStack(srcuser, chan, modestack);
 
-                       /* 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)
-                               {
-                                       ServerInstance->Logs->Log("m_spanningtree", SPARSE, "Unrecognised mode %c, dropping link", *unparsedmodes);
-                                       return CMD_INVALID;
-                               }
+       return CMD_SUCCESS;
+}
 
-                               modes += *unparsedmodes;
-                               usr++;
-                               unparsedmodes++;
-                       }
+void CommandFJoin::ProcessModeUUIDPair(const std::string& item, TreeSocket* src_socket, Channel* chan, irc::modestacker* modestack)
+{
+       std::string::size_type comma = item.find(',');
 
-                       /* Advance past the comma, to the nick */
-                       usr++;
+       // Comma not required anymore if the user has no modes
+       const std::string::size_type ubegin = (comma == std::string::npos ? 0 : comma+1);
+       std::string uuid(item, ubegin, UIDGenerator::UUID_LENGTH);
+       User* who = ServerInstance->FindUUID(uuid);
+       if (!who)
+       {
+               // Probably KILLed, ignore
+               return;
+       }
 
-                       /* Check the user actually exists */
-                       who = 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() != src_socket))
-                                       continue;
+       /* Check that the user's 'direction' is correct */
+       TreeServer* route_back_again = TreeServer::Get(who);
+       if (route_back_again->GetSocket() != src_socket)
+       {
+               return;
+       }
 
-                               /* 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);
+       /* 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)
+               {
+                       if (!ServerInstance->Modes->FindMode(*i, MODETYPE_CHANNEL))
+                               throw ProtocolException("Unrecognised mode '" + std::string(1, *i) + "'");
 
-                               Channel::JoinUser(who, channel.c_str(), true, "", route_back_again->bursting, TS);
-                       }
-                       else
-                       {
-                               ServerInstance->Logs->Log("m_spanningtree",SPARSE, "Ignored nonexistant user %s in fjoin to %s (probably quit?)", usr, channel.c_str());
-                               continue;
-                       }
+                       /* Add any modes this user had to the mode stack */
+                       modestack->Push(*i, who->nick);
                }
        }
 
-       /* Flush mode stacker if we lost the FJOIN or had equal TS */
-       if (apply_other_sides_modes)
+       Membership* memb = chan->ForceJoin(who, NULL, route_back_again->bursting);
+       if (!memb)
+               return;
+
+       // Assign the id to the new Membership
+       Membership::Id membid = 0;
+       const std::string::size_type colon = item.rfind(':');
+       if (colon != std::string::npos)
+               membid = Membership::IdFromString(item.substr(colon+1));
+       memb->id = membid;
+}
+
+void CommandFJoin::RemoveStatus(Channel* c)
+{
+       irc::modestacker stack(false);
+
+       const ModeParser::ModeHandlerMap& mhs = ServerInstance->Modes->GetModes(MODETYPE_CHANNEL);
+       for (ModeParser::ModeHandlerMap::const_iterator i = mhs.begin(); i != mhs.end(); ++i)
        {
-               parameterlist stackresult;
-               stackresult.push_back(channel);
+               ModeHandler* mh = i->second;
 
-               while (modestack.GetStackedLine(stackresult))
-               {
-                       ServerInstance->SendMode(stackresult, srcuser);
-                       stackresult.erase(stackresult.begin() + 1, stackresult.end());
-               }
+               /* 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);
        }
-       return CMD_SUCCESS;
+
+       ApplyModeStack(ServerInstance->FakeClient, c, stack);
 }
 
-void CommandFJoin::RemoveStatus(User* srcuser, parameterlist &params)
+void CommandFJoin::ApplyModeStack(User* srcuser, Channel* c, irc::modestacker& stack)
 {
-       if (params.size() < 1)
-               return;
-
-       Channel* c = ServerInstance->FindChan(params[0]);
+       parameterlist stackresult;
+       stackresult.push_back(c->name);
 
-       if (c)
+       while (stack.GetStackedLine(stackresult))
        {
-               irc::modestacker stack(false);
-               parameterlist stackresult;
-               stackresult.push_back(c->name);
+               ServerInstance->Modes->Process(stackresult, srcuser, ModeParser::MODE_LOCALONLY);
+               stackresult.erase(stackresult.begin() + 1, stackresult.end());
+       }
+}
 
-               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);
-               }
+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);
 
-               while (stack.GetStackedLine(stackresult))
-               {
-                       ServerInstance->SendMode(stackresult, srcuser);
-                       stackresult.erase(stackresult.begin() + 1, stackresult.end());
-               }
+       // 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());
        }
+       chan->setby.clear();
+       chan->topicset = 0;
+}
+
+CommandFJoin::Builder::Builder(Channel* chan)
+       : CmdBuilder("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)
+{
+       push_raw(memb->modes).push_raw(',').push_raw(memb->user->uuid);
+       push_raw(':').push_raw_int(memb->id);
+       push_raw(' ');
+}
+
+bool CommandFJoin::Builder::has_room(Membership* memb) const
+{
+       return ((str().size() + memb->modes.size() + UIDGenerator::UUID_LENGTH + 2 + membid_max_digits + 1) <= maxline);
+}
+
+void CommandFJoin::Builder::clear()
+{
+       content.erase(pos);
+       push_raw(" :");
+}
+
+const std::string& CommandFJoin::Builder::finalize()
+{
+       if (*content.rbegin() == ' ')
+               content.erase(content.size()-1);
+       return str();
+}