]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/mode.cpp
Use Modes::ChangeList in ModeHandler::RemoveMode()
[user/henk/code/inspircd.git] / src / mode.cpp
index 053a10ba11d5209afbcb633a19a00a005785c8ea..d9dba196d4419ff9e3fe9f575ec948811b3ad8ac 100644 (file)
@@ -27,7 +27,7 @@
 #include "builtinmodes.h"
 
 ModeHandler::ModeHandler(Module* Creator, const std::string& Name, char modeletter, ParamSpec Params, ModeType type, Class mclass)
-       : ServiceProvider(Creator, Name, SERVICE_MODE), m_paramtype(TR_TEXT),
+       : ServiceProvider(Creator, Name, SERVICE_MODE), modeid(ModeParser::MODEID_MAX),
        parameters_taken(Params), mode(modeletter), oper(false),
        list(false), m_type(type), type_id(mclass), levelrequired(HALFOP_VALUE)
 {
@@ -35,7 +35,7 @@ ModeHandler::ModeHandler(Module* Creator, const std::string& Name, char modelett
 
 CullResult ModeHandler::cull()
 {
-       if (ServerInstance->Modes)
+       if (ServerInstance)
                ServerInstance->Modes->DelMode(this);
        return classbase::cull();
 }
@@ -182,12 +182,11 @@ void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targ
        }
 }
 
-PrefixMode::PrefixMode(Module* Creator, const std::string& Name, char ModeLetter)
+PrefixMode::PrefixMode(Module* Creator, const std::string& Name, char ModeLetter, unsigned int Rank, char PrefixChar)
        : ModeHandler(Creator, Name, ModeLetter, PARAM_ALWAYS, MODETYPE_CHANNEL, MC_PREFIX)
-       , prefix(0), prefixrank(0)
+       , prefix(PrefixChar), prefixrank(Rank)
 {
        list = true;
-       m_paramtype = TR_NICK;
 }
 
 ModeAction PrefixMode::OnModeChange(User* source, User*, Channel* chan, std::string& parameter, bool adding)
@@ -238,14 +237,15 @@ ModeAction ParamModeBase::OnModeChange(User* source, User*, Channel* chan, std::
        return MODEACTION_ALLOW;
 }
 
-ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool adding, const unsigned char modechar,
-               std::string &parameter, bool SkipACL)
+ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, Modes::Change& mcitem, bool SkipACL)
 {
        ModeType type = chan ? MODETYPE_CHANNEL : MODETYPE_USER;
 
-       ModeHandler *mh = FindMode(modechar, type);
+       ModeHandler* mh = mcitem.mh;
+       bool adding = mcitem.adding;
        int pcnt = mh->GetNumParams(adding);
 
+       std::string& parameter = mcitem.param;
        // crop mode parameter size to 250 characters
        if (parameter.length() > 250 && adding)
                parameter = parameter.substr(0, 250);
@@ -256,6 +256,8 @@ ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool
        if (IS_LOCAL(user) && (MOD_RESULT == MOD_RES_DENY))
                return MODEACTION_DENY;
 
+       const char modechar = mh->GetModeChar();
+
        if (chan && !SkipACL && (MOD_RESULT != MOD_RES_ALLOW))
        {
                MOD_RESULT = mh->AccessCheck(user, chan, parameter, adding);
@@ -373,8 +375,7 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User* user,
        ModeType type = targetchannel ? MODETYPE_CHANNEL : MODETYPE_USER;
 
        LastParse.clear();
-       LastParseParams.clear();
-       LastParseTranslate.clear();
+       LastChangeList.clear();
 
        if ((!targetchannel) && ((!targetuser) || (IS_SERVER(targetuser))))
        {
@@ -387,31 +388,48 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User* user,
                return;
        }
 
+       // Populate a temporary Modes::ChangeList with the parameters
+       Modes::ChangeList changelist;
+       ModeParamsToChangeList(user, type, parameters, changelist);
+
        ModResult MOD_RESULT;
        FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
 
-       bool SkipAccessChecks = false;
+       if (IS_LOCAL(user))
+       {
+               if (MOD_RESULT == MOD_RES_PASSTHRU)
+               {
+                       if ((targetuser) && (user != targetuser))
+                       {
+                               // Local users may only change the modes of other users if a module explicitly allows it
+                               user->WriteNumeric(ERR_USERSDONTMATCH, ":Can't change mode for other users");
+                               return;
+                       }
+
+                       // This is a mode change by a local user and modules didn't explicitly allow/deny.
+                       // Ensure access checks will happen for each mode being changed.
+                       flags |= MODE_CHECKACCESS;
+               }
+               else if (MOD_RESULT == MOD_RES_DENY)
+                       return; // Entire mode change denied by a module
+       }
 
-       if (!IS_LOCAL(user) || MOD_RESULT == MOD_RES_ALLOW)
-               SkipAccessChecks = true;
-       else if (MOD_RESULT == MOD_RES_DENY)
-               return;
+       ProcessSingle(user, targetchannel, targetuser, changelist, flags);
 
-       if (targetuser && !SkipAccessChecks && user != targetuser)
+       if ((LastParse.empty()) && (targetchannel) && (parameters.size() == 2))
        {
-               user->WriteNumeric(ERR_USERSDONTMATCH, ":Can't change mode for other users");
-               return;
+               /* Special case for displaying the list for listmodes,
+                * e.g. MODE #chan b, or MODE #chan +b without a parameter
+                */
+               this->DisplayListModes(user, targetchannel, parameters[1]);
        }
+}
 
-       std::string mode_sequence = parameters[1];
-
-       std::string output_mode;
-       std::ostringstream output_parameters;
-       LastParseParams.push_back(output_mode);
-       LastParseTranslate.push_back(TR_TEXT);
+void ModeParser::ModeParamsToChangeList(User* user, ModeType type, const std::vector<std::string>& parameters, Modes::ChangeList& changelist)
+{
+       const std::string& mode_sequence = parameters[1];
 
        bool adding = true;
-       char output_pm = '\0'; // current output state, '+' or '-'
        unsigned int param_at = 2;
 
        for (std::string::const_iterator letter = mode_sequence.begin(); letter != mode_sequence.end(); letter++)
@@ -432,86 +450,134 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User* user,
                }
 
                std::string parameter;
-               int pcnt = mh->GetNumParams(adding);
-               if (pcnt && param_at == parameters.size())
-               {
-                       /* No parameter, continue to the next mode */
-                       mh->OnParameterMissing(user, targetuser, targetchannel);
-                       continue;
-               }
-               else if (pcnt)
-               {
+               if (mh->GetNumParams(adding) && param_at < parameters.size())
                        parameter = parameters[param_at++];
-                       /* Make sure the user isn't trying to slip in an invalid parameter */
-                       if ((parameter.find(':') == 0) || (parameter.rfind(' ') != std::string::npos))
+
+               changelist.push(mh, adding, parameter);
+       }
+}
+
+static bool IsModeParamValid(User* user, Channel* targetchannel, User* targetuser, const Modes::Change& item)
+{
+       // An empty parameter is never acceptable
+       if (item.param.empty())
+       {
+               item.mh->OnParameterMissing(user, targetuser, targetchannel);
+               return false;
+       }
+
+       // The parameter cannot begin with a ':' character or contain a space
+       if ((item.param[0] == ':') || (item.param.find(' ') != std::string::npos))
+               return false;
+
+       return true;
+}
+
+// Returns true if we should apply a merged mode, false if we should skip it
+static bool ShouldApplyMergedMode(Channel* chan, Modes::Change& item)
+{
+       ModeHandler* mh = item.mh;
+       if ((!chan) || (!chan->IsModeSet(mh)) || (mh->IsListMode()))
+               // Mode not set here or merge is not applicable, apply the incoming mode
+               return true;
+
+       // Mode handler decides
+       std::string ours = chan->GetModeParameter(mh);
+       return mh->ResolveModeConflict(item.param, ours, chan);
+}
+
+void ModeParser::Process(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags)
+{
+       // Call ProcessSingle until the entire list is processed, but at least once to ensure
+       // LastParse and LastChangeList are cleared
+       unsigned int processed = 0;
+       do
+       {
+               unsigned int n = ProcessSingle(user, targetchannel, targetuser, changelist, flags, processed);
+               processed += n;
+       }
+       while (processed < changelist.size());
+}
+
+unsigned int ModeParser::ProcessSingle(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags, unsigned int beginindex)
+{
+       LastParse.clear();
+       LastChangeList.clear();
+
+       unsigned int modes_processed = 0;
+       std::string output_mode;
+       std::string output_parameters;
+
+       char output_pm = '\0'; // current output state, '+' or '-'
+       Modes::ChangeList::List& list = changelist.getlist();
+       for (Modes::ChangeList::List::iterator i = list.begin()+beginindex; i != list.end(); ++i)
+       {
+               modes_processed++;
+
+               Modes::Change& item = *i;
+               ModeHandler* mh = item.mh;
+
+               // If the mode is supposed to have a parameter then we first take a look at item.param
+               // and, if we were asked to, also handle mode merges now
+               if (mh->GetNumParams(item.adding))
+               {
+                       // Skip the mode if the parameter does not pass basic validation
+                       if (!IsModeParamValid(user, targetchannel, targetuser, item))
+                               continue;
+
+                       // If this is a merge and we won we don't apply this mode
+                       if ((flags & MODE_MERGE) && (!ShouldApplyMergedMode(targetchannel, item)))
                                continue;
-                       if ((flags & MODE_MERGE) && targetchannel && targetchannel->IsModeSet(mh) && !mh->IsListMode())
-                       {
-                               std::string ours = targetchannel->GetModeParameter(mh);
-                               if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
-                                       /* we won the mode merge, don't apply this mode */
-                                       continue;
-                       }
                }
 
-               ModeAction ma = TryMode(user, targetuser, targetchannel, adding, modechar, parameter, SkipAccessChecks);
+               ModeAction ma = TryMode(user, targetuser, targetchannel, item, (!(flags & MODE_CHECKACCESS)));
 
                if (ma != MODEACTION_ALLOW)
                        continue;
 
-               char needed_pm = adding ? '+' : '-';
+               char needed_pm = item.adding ? '+' : '-';
                if (needed_pm != output_pm)
                {
                        output_pm = needed_pm;
                        output_mode.append(1, output_pm);
                }
-               output_mode.append(1, modechar);
+               output_mode.push_back(mh->GetModeChar());
 
-               if (pcnt)
+               if (!item.param.empty())
                {
-                       output_parameters << " " << parameter;
-                       LastParseParams.push_back(parameter);
-                       LastParseTranslate.push_back(mh->GetTranslateType());
+                       output_parameters.push_back(' ');
+                       output_parameters.append(item.param);
                }
+               LastChangeList.push(mh, item.adding, item.param);
 
-               if ( (output_mode.length() + output_parameters.str().length() > 450)
+               if ((output_mode.length() + output_parameters.length() > 450)
                                || (output_mode.length() > 100)
-                               || (LastParseParams.size() > ServerInstance->Config->Limits.MaxModes))
+                               || (LastChangeList.size() >= ServerInstance->Config->Limits.MaxModes))
                {
                        /* mode sequence is getting too long */
                        break;
                }
        }
 
-       LastParseParams[0] = output_mode;
-
        if (!output_mode.empty())
        {
                LastParse = targetchannel ? targetchannel->name : targetuser->nick;
                LastParse.append(" ");
                LastParse.append(output_mode);
-               LastParse.append(output_parameters.str());
-
-               if (!(flags & MODE_LOCALONLY))
-                       ServerInstance->PI->SendMode(user, targetuser, targetchannel, LastParseParams, LastParseTranslate);
+               LastParse.append(output_parameters);
 
                if (targetchannel)
                        targetchannel->WriteChannel(user, "MODE " + LastParse);
                else
                        targetuser->WriteFrom(user, "MODE " + LastParse);
 
-               FOREACH_MOD(OnMode, (user, targetuser, targetchannel, LastParseParams, LastParseTranslate));
-       }
-       else if (targetchannel && parameters.size() == 2)
-       {
-               /* Special case for displaying the list for listmodes,
-                * e.g. MODE #chan b, or MODE #chan +b without a parameter
-                */
-               this->DisplayListModes(user, targetchannel, mode_sequence);
+               FOREACH_MOD(OnMode, (user, targetuser, targetchannel, LastChangeList, flags, output_mode));
        }
+
+       return modes_processed;
 }
 
-void ModeParser::DisplayListModes(User* user, Channel* chan, std::string &mode_sequence)
+void ModeParser::DisplayListModes(User* user, Channel* chan, const std::string& mode_sequence)
 {
        seq++;
 
@@ -608,14 +674,25 @@ void ModeParser::CleanMask(std::string &mask)
        }
 }
 
-bool ModeParser::AddMode(ModeHandler* mh)
+ModeHandler::Id ModeParser::AllocateModeId(ModeType mt)
+{
+       for (ModeHandler::Id i = 0; i != MODEID_MAX; ++i)
+       {
+               if (!modehandlersbyid[mt][i])
+                       return i;
+       }
+
+       throw ModuleException("Out of ModeIds");
+}
+
+void ModeParser::AddMode(ModeHandler* mh)
 {
        /* Yes, i know, this might let people declare modes like '_' or '^'.
         * If they do that, thats their problem, and if i ever EVER see an
         * official InspIRCd developer do that, i'll beat them with a paddle!
         */
        if ((mh->GetModeChar() < 'A') || (mh->GetModeChar() > 'z'))
-               return false;
+               throw ModuleException("Invalid letter for mode " + mh->name);
 
        /* A mode prefix of ',' is not acceptable, it would fuck up server to server.
         * A mode prefix of ':' will fuck up both server to server, and client to server.
@@ -625,20 +702,34 @@ bool ModeParser::AddMode(ModeHandler* mh)
        if (pm)
        {
                if ((pm->GetPrefix() > 126) || (pm->GetPrefix() == ',') || (pm->GetPrefix() == ':') || (pm->GetPrefix() == '#'))
-                       return false;
+                       throw ModuleException("Invalid prefix for mode " + mh->name);
 
                if (FindPrefix(pm->GetPrefix()))
-                       return false;
+                       throw ModuleException("Prefix already exists for mode " + mh->name);
        }
 
        ModeHandler*& slot = modehandlers[mh->GetModeType()][mh->GetModeChar()-65];
        if (slot)
-               return false;
+               throw ModuleException("Letter is already in use for mode " + mh->name);
+
+       // The mode needs an id if it is either a user mode, a simple mode (flag) or a parameter mode.
+       // Otherwise (for listmodes and prefix modes) the id remains MODEID_MAX, which is invalid.
+       ModeHandler::Id modeid = MODEID_MAX;
+       if ((mh->GetModeType() == MODETYPE_USER) || (mh->IsParameterMode()) || (!mh->IsListMode()))
+               modeid = AllocateModeId(mh->GetModeType());
 
        if (!modehandlersbyname[mh->GetModeType()].insert(std::make_pair(mh->name, mh)).second)
-               return false;
+               throw ModuleException("Mode name already in use: " + mh->name);
 
        // Everything is fine, add the mode
+
+       // If we allocated an id for this mode then save it and put the mode handler into the slot
+       if (modeid != MODEID_MAX)
+       {
+               mh->modeid = modeid;
+               modehandlersbyid[mh->GetModeType()][modeid] = mh;
+       }
+
        slot = mh;
        if (pm)
                mhlist.prefix.push_back(pm);
@@ -646,7 +737,6 @@ bool ModeParser::AddMode(ModeHandler* mh)
                mhlist.list.push_back(mh->IsListModeBase());
 
        RecreateModeListFor004Numeric();
-       return true;
 }
 
 bool ModeParser::DelMode(ModeHandler* mh)
@@ -669,35 +759,36 @@ bool ModeParser::DelMode(ModeHandler* mh)
        switch (mh->GetModeType())
        {
                case MODETYPE_USER:
-                       for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); )
+               {
+                       const user_hash& users = ServerInstance->Users->GetUsers();
+                       for (user_hash::const_iterator i = users.begin(); i != users.end(); )
                        {
                                User* user = i->second;
                                ++i;
                                mh->RemoveMode(user);
                        }
+               }
                break;
                case MODETYPE_CHANNEL:
-                       for (chan_hash::iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); )
+               {
+                       const chan_hash& chans = ServerInstance->GetChans();
+                       for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); )
                        {
                                // The channel may not be in the hash after RemoveMode(), see m_permchannels
                                Channel* chan = i->second;
                                ++i;
 
-                               irc::modestacker stack(false);
-                               mh->RemoveMode(chan, stack);
-
-                               std::vector<std::string> stackresult;
-                               stackresult.push_back(chan->name);
-                               while (stack.GetStackedLine(stackresult))
-                               {
-                                       this->Process(stackresult, ServerInstance->FakeClient, MODE_LOCALONLY);
-                                       stackresult.erase(stackresult.begin() + 1, stackresult.end());
-                               }
+                               Modes::ChangeList changelist;
+                               mh->RemoveMode(chan, changelist);
+                               this->Process(ServerInstance->FakeClient, chan, NULL, changelist, MODE_LOCALONLY);
                        }
+               }
                break;
        }
 
        mhmap.erase(mhmapit);
+       if (mh->GetId() != MODEID_MAX)
+               modehandlersbyid[mh->GetModeType()][mh->GetId()] = NULL;
        slot = NULL;
        if (mh->IsPrefixMode())
                mhlist.prefix.erase(std::find(mhlist.prefix.begin(), mhlist.prefix.end(), mh->IsPrefixMode()));
@@ -861,45 +952,43 @@ void ModeHandler::RemoveMode(User* user)
        // Remove the mode if it's set on the user
        if (user->IsModeSet(this->GetModeChar()))
        {
-               std::vector<std::string> parameters;
-               parameters.push_back(user->nick);
-               parameters.push_back("-");
-               parameters[1].push_back(this->GetModeChar());
-               ServerInstance->Modes->Process(parameters, ServerInstance->FakeClient, ModeParser::MODE_LOCALONLY);
+               Modes::ChangeList changelist;
+               changelist.push_remove(this);
+               ServerInstance->Modes->Process(ServerInstance->FakeClient, NULL, user, changelist, ModeParser::MODE_LOCALONLY);
        }
 }
 
-void ModeHandler::RemoveMode(Channel* channel, irc::modestacker& stack)
+void ModeHandler::RemoveMode(Channel* channel, Modes::ChangeList& changelist)
 {
        if (channel->IsModeSet(this))
        {
                if (this->GetNumParams(false))
                        // Removing this mode requires a parameter
-                       stack.Push(this->GetModeChar(), channel->GetModeParameter(this));
+                       changelist.push_remove(this, channel->GetModeParameter(this));
                else
-                       stack.Push(this->GetModeChar());
+                       changelist.push_remove(this);
        }
 }
 
-void PrefixMode::RemoveMode(Channel* chan, irc::modestacker& stack)
+void PrefixMode::RemoveMode(Channel* chan, Modes::ChangeList& changelist)
 {
-       const UserMembList* userlist = chan->GetUsers();
-       for (UserMembCIter i = userlist->begin(); i != userlist->end(); ++i)
+       const Channel::MemberMap& userlist = chan->GetUsers();
+       for (Channel::MemberMap::const_iterator i = userlist.begin(); i != userlist.end(); ++i)
        {
                if (i->second->hasMode(this->GetModeChar()))
-                       stack.Push(this->GetModeChar(), i->first->nick);
+                       changelist.push_remove(this, i->first->nick);
        }
 }
 
 struct builtin_modes
 {
-       ModeChannelSecret s;
-       ModeChannelPrivate p;
-       ModeChannelModerated m;
-       ModeChannelTopicOps t;
+       SimpleChannelModeHandler s;
+       SimpleChannelModeHandler p;
+       SimpleChannelModeHandler m;
+       SimpleChannelModeHandler t;
 
-       ModeChannelNoExternal n;
-       ModeChannelInviteOnly i;
+       SimpleChannelModeHandler n;
+       SimpleChannelModeHandler i;
        ModeChannelKey k;
        ModeChannelLimit l;
 
@@ -907,15 +996,25 @@ struct builtin_modes
        ModeChannelOp o;
        ModeChannelVoice v;
 
-       ModeUserWallops uw;
-       ModeUserInvisible ui;
+       SimpleUserModeHandler ui;
        ModeUserOperator uo;
        ModeUserServerNoticeMask us;
 
+       builtin_modes()
+               : s(NULL, "secret", 's')
+               , p(NULL, "private", 'p')
+               , m(NULL, "moderated", 'm')
+               , t(NULL, "topiclock", 't')
+               , n(NULL, "noextmsg", 'n')
+               , i(NULL, "inviteonly", 'i')
+               , ui(NULL, "invisible", 'i')
+       {
+       }
+
        void init()
        {
                ServiceProvider* modes[] = { &s, &p, &m, &t, &n, &i, &k, &l, &b, &o, &v,
-                                                                        &uw, &ui, &uo, &us };
+                                                                        &ui, &uo, &us };
                ServerInstance->Modules->AddServices(modes, sizeof(modes)/sizeof(ServiceProvider*));
        }
 };
@@ -932,6 +1031,7 @@ ModeParser::ModeParser()
 {
        /* Clear mode handler list */
        memset(modehandlers, 0, sizeof(modehandlers));
+       memset(modehandlersbyid, 0, sizeof(modehandlersbyid));
 
        seq = 0;
        memset(&sent, 0, sizeof(sent));