]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/mode.cpp
Make classbase and refcountbase uncopyable; expand comments on their indended uses
[user/henk/code/inspircd.git] / src / mode.cpp
index 22b1e261f52338ee353e6c75877b6b8b57570431..47553f238294278fa8ebc4f166044943a9e87d7c 100644 (file)
@@ -11,8 +11,6 @@
  * ---------------------------------------------------
  */
 
-/* $Core */
-
 #include "inspircd.h"
 #include "inspstring.h"
 
 /* +s (server notice masks) */
 #include "modes/umode_s.h"
 
-ModeHandler::ModeHandler(InspIRCd* Instance, Module* Creator, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix, char prefixrequired, TranslateType translate)
-       : ServerInstance(Instance), mode(modeletter), n_params_on(parameters_on), n_params_off(parameters_off), list(listmode), m_type(type), m_paramtype(translate), oper(operonly), prefix(mprefix), count(0), prefixneeded(prefixrequired), creator(Creator)
+ModeHandler::ModeHandler(Module* Creator, const std::string& Name, char modeletter, ParamSpec Params, ModeType type)
+       : m_paramtype(TR_TEXT), parameters_taken(Params), mode(modeletter), prefix(0), oper(false),
+       list(false), m_type(type), count(0), levelrequired(HALFOP_VALUE), creator(Creator), name(Name)
 {
 }
 
-ModeHandler::~ModeHandler()
+CullResult ModeHandler::cull()
 {
+       ServerInstance->Modes->DelMode(this);
+       return classbase::cull();
 }
 
-bool ModeHandler::IsListMode()
-{
-       return list;
-}
-
-char ModeHandler::GetNeededPrefix()
+ModeHandler::~ModeHandler()
 {
-       if (prefixneeded == '%' && !ServerInstance->Config->AllowHalfop)
-               return '@';
-       return prefixneeded;
+       if (ServerInstance && ServerInstance->Modes->FindMode(mode, m_type) == this)
+               ServerInstance->Logs->Log("MODE", DEBUG, "ERROR: Destructor for mode %c called while not culled", mode);
 }
 
-void ModeHandler::SetNeededPrefix(char needsprefix)
+bool ModeHandler::IsListMode()
 {
-       prefixneeded = needsprefix;
+       return list;
 }
 
 unsigned int ModeHandler::GetPrefixRank()
@@ -91,29 +86,18 @@ void ModeHandler::ChangeCount(int modifier)
        ServerInstance->Logs->Log("MODE", DEBUG,"Change count for mode %c is now %d", mode, count);
 }
 
-ModeType ModeHandler::GetModeType()
-{
-       return m_type;
-}
-
-TranslateType ModeHandler::GetTranslateType()
-{
-       return m_paramtype;
-}
-
-bool ModeHandler::NeedsOper()
-{
-       return oper;
-}
-
-char ModeHandler::GetPrefix()
-{
-       return prefix;
-}
-
 int ModeHandler::GetNumParams(bool adding)
 {
-       return adding ? n_params_on : n_params_off;
+       switch (parameters_taken)
+       {
+               case PARAM_ALWAYS:
+                       return 1;
+               case PARAM_SETONLY:
+                       return adding ? 1 : 0;
+               case PARAM_NONE:
+                       break;
+       }
+       return 0;
 }
 
 char ModeHandler::GetModeChar()
@@ -126,6 +110,11 @@ std::string ModeHandler::GetUserParameter(User* user)
        return "";
 }
 
+ModResult ModeHandler::AccessCheck(User*, Channel*, std::string &, bool)
+{
+       return MOD_RES_PASSTHRU;
+}
+
 ModeAction ModeHandler::OnModeChange(User*, User*, Channel*, std::string&, bool)
 {
        return MODEACTION_DENY;
@@ -155,7 +144,7 @@ void ModeHandler::OnParameterMissing(User* user, User* dest, Channel* channel)
 {
 }
 
-bool ModeHandler::CheckTimeStamp(std::string& theirs, const std::string& ours, Channel*)
+bool ModeHandler::ResolveModeConflict(std::string& theirs, const std::string& ours, Channel*)
 {
        return (theirs < ours);
 }
@@ -205,7 +194,8 @@ ModeAction SimpleChannelModeHandler::OnModeChange(User* source, User* dest, Chan
        return MODEACTION_DENY;
 }
 
-ModeWatcher::ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type) : ServerInstance(Instance), mode(modeletter), m_type(type)
+ModeWatcher::ModeWatcher(Module* Creator, char modeletter, ModeType type)
+       : mode(modeletter), m_type(type), creator(Creator)
 {
 }
 
@@ -248,66 +238,6 @@ User* ModeParser::SanityChecks(User *user, const char *dest, Channel *chan, int)
        return d;
 }
 
-const char* ModeParser::Grant(User *d,Channel *chan,int MASK)
-{
-       if (!chan)
-               return "";
-
-       UCListIter n = d->chans.find(chan);
-       if (n != d->chans.end())
-       {
-               if (n->second & MASK)
-               {
-                       return "";
-               }
-               n->second = n->second | MASK;
-               switch (MASK)
-               {
-                       case UCMODE_OP:
-                               n->first->AddOppedUser(d);
-                       break;
-                       case UCMODE_HOP:
-                               n->first->AddHalfoppedUser(d);
-                       break;
-                       case UCMODE_VOICE:
-                               n->first->AddVoicedUser(d);
-                       break;
-               }
-               return d->nick.c_str();
-       }
-       return "";
-}
-
-const char* ModeParser::Revoke(User *d,Channel *chan,int MASK)
-{
-       if (!chan)
-               return "";
-
-       UCListIter n = d->chans.find(chan);
-       if (n != d->chans.end())
-       {
-               if ((n->second & MASK) == 0)
-               {
-                       return "";
-               }
-               n->second ^= MASK;
-               switch (MASK)
-               {
-                       case UCMODE_OP:
-                               n->first->DelOppedUser(d);
-                       break;
-                       case UCMODE_HOP:
-                               n->first->DelHalfoppedUser(d);
-                       break;
-                       case UCMODE_VOICE:
-                               n->first->DelVoicedUser(d);
-                       break;
-               }
-               return d->nick.c_str();
-       }
-       return "";
-}
-
 void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text)
 {
        if (targetchannel)
@@ -329,7 +259,7 @@ void ModeParser::DisplayCurrentModes(User *user, User* targetuser, Channel* targ
                }
                else
                {
-                       user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't change mode for other users", user->nick.c_str());
+                       user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't view modes for other users", user->nick.c_str());
                        return;
                }
        }
@@ -345,41 +275,31 @@ ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool
        int pcnt = mh->GetNumParams(adding);
 
        ModResult MOD_RESULT;
-       FIRST_MOD_RESULT(ServerInstance, OnRawMode, MOD_RESULT, (user, chan, modechar, parameter, adding, pcnt));
+       FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, modechar, parameter, adding, pcnt));
 
        if (IS_LOCAL(user) && (MOD_RESULT == MOD_RES_DENY))
                return MODEACTION_DENY;
 
        if (chan && !SkipACL && (MOD_RESULT != MOD_RES_ALLOW))
        {
-               char needed = mh->GetNeededPrefix();
-               ModeHandler* prefixmode = FindPrefix(needed);
+               MOD_RESULT = mh->AccessCheck(user, chan, parameter, adding);
 
-               /* If the mode defined by the handler is not '\0', but the handler for it
-                * cannot be found, they probably dont have the right module loaded to implement
-                * the prefix they want to compare the mode against, e.g. '&' for m_chanprotect.
-                * Revert to checking against the minimum core prefix, '%'.
-                */
-               if (needed && !prefixmode)
-               {
-                       needed = ServerInstance->Config->AllowHalfop ? '%' : '@';
-                       prefixmode = FindPrefix(needed);
-               }
-
-               if (needed)
+               if (MOD_RESULT == MOD_RES_DENY)
+                       return MODEACTION_DENY;
+               if (MOD_RESULT == MOD_RES_PASSTHRU)
                {
-                       unsigned int neededrank = prefixmode->GetPrefixRank();
+                       unsigned int neededrank = mh->GetLevelRequired();
                        /* Compare our rank on the channel against the rank of the required prefix,
                         * allow if >= ours. Because mIRC and xchat throw a tizz if the modes shown
                         * in NAMES(X) are not in rank order, we know the most powerful mode is listed
                         * first, so we don't need to iterate, we just look up the first instead.
                         */
-                       std::string modestring = chan->GetAllPrefixChars(user);
-                       char ml = (modestring.empty() ? '\0' : modestring[0]);
-                       ModeHandler* ourmode = FindPrefix(ml);
-                       if (!ourmode || ourmode->GetPrefixRank() < neededrank)
+                       unsigned int ourrank = chan->GetPrefixValue(user);
+                       if (ourrank < neededrank)
                        {
                                /* Bog off */
+                               // TODO replace with a real search for the proper prefix
+                               char needed = neededrank > HALFOP_VALUE ? '@' : '%';
                                user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :You must have channel privilege %c or above to %sset channel mode %c",
                                                user->nick.c_str(), chan->name.c_str(), needed, adding ? "" : "un", modechar);
                                return MODEACTION_DENY;
@@ -415,7 +335,7 @@ ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool
                if (IS_OPER(user))
                {
                        user->WriteNumeric(ERR_NOPRIVILEGES, "%s :Permission Denied - Oper type %s does not have access to set %s mode %c",
-                                       user->nick.c_str(), user->oper.c_str(), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
+                                       user->nick.c_str(), irc::Spacify(user->oper.c_str()), type == MODETYPE_CHANNEL ? "channel" : "user", modechar);
                }
                else
                {
@@ -425,6 +345,12 @@ ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool
                return MODEACTION_DENY;
        }
 
+       if (mh->GetTranslateType() == TR_NICK && !ServerInstance->FindNick(parameter))
+       {
+               user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nick/channel", user->nick.c_str(), parameter.c_str());
+               return MODEACTION_DENY;
+       }
+
        /* Call the handler for the mode */
        ModeAction ma = mh->OnModeChange(user, targetuser, chan, parameter, adding);
 
@@ -436,11 +362,11 @@ ModeAction ModeParser::TryMode(User* user, User* targetuser, Channel* chan, bool
 
        mh->ChangeCount(adding ? 1 : -1);
 
-       if (mh->GetPrefix() && chan)
+       if (mh->GetPrefixRank() && chan)
        {
                User* user_to_prefix = ServerInstance->FindNick(parameter);
                if (user_to_prefix)
-                       chan->SetPrefix(user_to_prefix, mh->GetPrefix(), mh->GetPrefixRank(), adding);
+                       chan->SetPrefix(user_to_prefix, modechar, adding);
        }
 
        for (ModeWatchIter watchers = modewatchers[handler_id].begin(); watchers != modewatchers[handler_id].end(); watchers++)
@@ -471,34 +397,23 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User *user,
                return;
        }
 
-       std::string mode_sequence = parameters[1];
+       ModResult MOD_RESULT;
+       FIRST_MOD_RESULT(OnPreMode, MOD_RESULT, (user, targetuser, targetchannel, parameters));
 
        bool SkipAccessChecks = false;
 
-       if (!IS_LOCAL(user) || ServerInstance->ULine(user->server))
-       {
+       if (!IS_LOCAL(user) || ServerInstance->ULine(user->server) || MOD_RESULT == MOD_RES_ALLOW)
                SkipAccessChecks = true;
-       }
-       else if (targetchannel)
-       {
-               /* Overall access control hook for mode change */
-               LastParse = mode_sequence;
-               ModResult MOD_RESULT;
-               FIRST_MOD_RESULT(ServerInstance, OnAccessCheck, MOD_RESULT, (user, NULL, targetchannel, AC_GENERAL_MODE));
-               LastParse.clear();
-               if (MOD_RESULT == MOD_RES_DENY)
-                       return;
-               SkipAccessChecks = (MOD_RESULT == MOD_RES_ALLOW);
-       }
-       else
+       else if (MOD_RESULT == MOD_RES_DENY)
+               return;
+
+       if (targetuser && !SkipAccessChecks && user != targetuser)
        {
-               if (user != targetuser)
-               {
-                       user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't change mode for other users", user->nick.c_str());
-                       return;
-               }
+               user->WriteNumeric(ERR_USERSDONTMATCH, "%s :Can't change mode for other users", user->nick.c_str());
+               return;
        }
 
+       std::string mode_sequence = parameters[1];
 
        std::string output_mode;
        std::ostringstream output_parameters;
@@ -543,7 +458,7 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User *user,
                        if (merge && targetchannel && targetchannel->IsModeSet(modechar) && !mh->IsListMode())
                        {
                                std::string ours = targetchannel->GetModeParameter(modechar);
-                               if (!mh->CheckTimeStamp(parameter, ours, targetchannel))
+                               if (!mh->ResolveModeConflict(parameter, ours, targetchannel))
                                        /* we won the mode merge, don't apply this mode */
                                        continue;
                        }
@@ -564,9 +479,16 @@ void ModeParser::Process(const std::vector<std::string>& parameters, User *user,
 
                if (pcnt)
                {
+                       TranslateType tt = mh->GetTranslateType();
+                       if (tt == TR_NICK)
+                       {
+                               User* u = ServerInstance->FindNick(parameter);
+                               if (u)
+                                       parameter = u->nick;
+                       }
                        output_parameters << " " << parameter;
                        LastParseParams.push_back(parameter);
-                       LastParseTranslate.push_back(mh->GetTranslateType());
+                       LastParseTranslate.push_back(tt);
                }
 
                if ( (output_mode.length() + output_parameters.str().length() > 450)
@@ -631,12 +553,12 @@ void ModeParser::DisplayListModes(User* user, Channel* chan, std::string &mode_s
                        return;
 
                ModResult MOD_RESULT;
-               FIRST_MOD_RESULT(ServerInstance, OnRawMode, MOD_RESULT, (user, chan, mletter, "", true, 0));
+               FIRST_MOD_RESULT(OnRawMode, MOD_RESULT, (user, chan, mletter, "", true, 0));
                if (MOD_RESULT == MOD_RES_DENY)
                        continue;
 
                bool display = true;
-               if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetStatus(user) < STATUS_HOP))
+               if (!user->HasPrivPermission("channels/auspex") && ServerInstance->Config->HideModeLists[mletter] && (chan->GetPrefixValue(user) < HALFOP_VALUE))
                {
                        user->WriteNumeric(ERR_CHANOPRIVSNEEDED, "%s %s :Only half-operators and above may view the +%c list",
                                user->nick.c_str(), chan->name.c_str(), mletter);
@@ -742,7 +664,7 @@ bool ModeParser::DelMode(ModeHandler* mh)
        mh->GetModeType() == MODETYPE_USER ? mask = MASK_USER : mask = MASK_CHANNEL;
        pos = (mh->GetModeChar()-65) | mask;
 
-       if (!modehandlers[pos])
+       if (modehandlers[pos] != mh)
                return false;
 
        /* Note: We can't stack here, as we have modes potentially being removed across many different channels.
@@ -926,17 +848,11 @@ std::string ModeParser::GiveModeList(ModeMasks m)
        return type1 + "," + type2 + "," + type3 + "," + type4;
 }
 
-bool ModeParser::PrefixComparison(prefixtype one, prefixtype two)
-{
-       return one.second > two.second;
-}
-
 std::string ModeParser::BuildPrefixes()
 {
        std::string mletters;
        std::string mprefixes;
-       pfxcontainer pfx;
-       std::map<char,char> prefix_to_mode;
+       std::map<int,std::pair<char,char> > prefixes;
 
        for (unsigned char mode = 'A'; mode <= 'z'; mode++)
        {
@@ -944,17 +860,15 @@ std::string ModeParser::BuildPrefixes()
 
                if ((modehandlers[pos]) && (modehandlers[pos]->GetPrefix()))
                {
-                       pfx.push_back(std::make_pair<char,unsigned int>(modehandlers[pos]->GetPrefix(), modehandlers[pos]->GetPrefixRank()));
-                       prefix_to_mode[modehandlers[pos]->GetPrefix()] = modehandlers[pos]->GetModeChar();
+                       prefixes[modehandlers[pos]->GetPrefixRank()] = std::make_pair(
+                               modehandlers[pos]->GetPrefix(), modehandlers[pos]->GetModeChar());
                }
        }
 
-       sort(pfx.begin(), pfx.end(), ModeParser::PrefixComparison);
-
-       for (pfxcontainer::iterator n = pfx.begin(); n != pfx.end(); n++)
+       for(std::map<int,std::pair<char,char> >::reverse_iterator n = prefixes.rbegin(); n != prefixes.rend(); n++)
        {
-               mletters = mletters + n->first;
-               mprefixes = mprefixes + prefix_to_mode.find(n->first)->second;
+               mletters = mletters + n->second.first;
+               mprefixes = mprefixes + n->second.second;
        }
 
        return "(" + mprefixes + ")" + mletters;
@@ -1052,58 +966,70 @@ void ModeHandler::RemoveMode(Channel* channel, irc::modestacker* stack)
        }
 }
 
-ModeParser::ModeParser(InspIRCd* Instance) : ServerInstance(Instance)
+struct builtin_modes
 {
-       ModeHandler* modes[] =
+       ModeChannelSecret s;
+       ModeChannelPrivate p;
+       ModeChannelModerated m;
+       ModeChannelTopicOps t;
+
+       ModeChannelNoExternal n;
+       ModeChannelInviteOnly i;
+       ModeChannelKey k;
+       ModeChannelLimit l;
+
+       ModeChannelBan b;
+       ModeChannelOp o;
+       // halfop is added by configreader
+       ModeChannelVoice v;
+
+       ModeUserWallops uw;
+       ModeUserInvisible ui;
+       ModeUserOperator uo;
+       ModeUserServerNoticeMask us;
+
+       void init(ModeParser* modes)
        {
-               new ModeChannelSecret(Instance),
-               new ModeChannelPrivate(Instance),
-               new ModeChannelModerated(Instance),
-               new ModeChannelTopicOps(Instance),
-
-               new ModeChannelNoExternal(Instance),
-               new ModeChannelInviteOnly(Instance),
-               new ModeChannelKey(Instance),
-               new ModeChannelLimit(Instance),
-
-               new ModeChannelBan(Instance),
-               new ModeChannelOp(Instance),
-               new ModeChannelHalfOp(Instance),
-               new ModeChannelVoice(Instance),
-
-               new ModeUserWallops(Instance),
-               new ModeUserInvisible(Instance),
-               new ModeUserOperator(Instance),
-               new ModeUserServerNoticeMask(Instance),
-#define BUILTIN_MODE_COUNT 16
-       };
+               modes->AddMode(&s);
+               modes->AddMode(&p);
+               modes->AddMode(&m);
+               modes->AddMode(&t);
+               modes->AddMode(&n);
+               modes->AddMode(&i);
+               modes->AddMode(&k);
+               modes->AddMode(&l);
+               modes->AddMode(&b);
+               modes->AddMode(&o);
+               modes->AddMode(&v);
+               modes->AddMode(&uw);
+               modes->AddMode(&ui);
+               modes->AddMode(&uo);
+               modes->AddMode(&us);
+       }
+};
 
+static builtin_modes static_modes;
+
+ModeParser::ModeParser()
+{
        /* Clear mode handler list */
        memset(modehandlers, 0, sizeof(modehandlers));
 
        /* Last parse string */
        LastParse.clear();
 
-       /* Initialise the RFC mode letters */
-       for (int index = 0; index < BUILTIN_MODE_COUNT; index++)
-               this->AddMode(modes[index]);
-
        seq = 0;
        memset(&sent, 0, sizeof(sent));
+
+       static_modes.init(this);
 }
 
 ModeParser::~ModeParser()
 {
-       int count = 0;
-       for(int i=0; i < 256; i++)
+       ModeHandler* mh = ServerInstance->Modes->FindMode('h', MODETYPE_CHANNEL);
+       if (mh)
        {
-               ModeHandler* mh = modehandlers[i];
-               if (mh)
-               {
-                       count++;
-                       delete mh;
-               }
+               mh->cull();
+               delete mh;
        }
-       if (count != BUILTIN_MODE_COUNT)
-               throw CoreException("Mode handler found non-core modes remaining at deallocation");
 }