X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=e7ac756ecdaa636faf524166a272776f3fcea400;hb=932748db6dd2a7225c9f12bc34339fcb2f37c319;hp=7c5682135c7475f3d09353dbe0b734ac0230e8f2;hpb=5a64433015f5a25af133a136468093a140595bc5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 7c5682135..e7ac756ec 100644 --- a/include/mode.h +++ b/include/mode.h @@ -23,6 +23,7 @@ #pragma once #include "ctables.h" +#include "modechange.h" /** * Holds the values for different type of modes @@ -110,11 +111,6 @@ class CoreExport ModeHandler : public ServiceProvider Id modeid; protected: - /** - * The mode parameter translation type - */ - TranslateType m_paramtype; - /** What kind of parameters does the mode take? */ ParamSpec parameters_taken; @@ -172,6 +168,11 @@ class CoreExport ModeHandler : public ServiceProvider ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type, Class mclass = MC_OTHER); virtual CullResult cull(); virtual ~ModeHandler(); + + /** Register this object in the ModeParser + */ + void RegisterService() CXX11_OVERRIDE; + /** * Returns true if the mode is a list mode */ @@ -199,10 +200,6 @@ class CoreExport ModeHandler : public ServiceProvider * Returns the mode's type */ inline ModeType GetModeType() const { return m_type; } - /** - * Returns the mode's parameter translation type - */ - inline TranslateType GetTranslateType() const { return m_paramtype; } /** * Returns true if the mode can only be set/unset by an oper */ @@ -302,9 +299,9 @@ class CoreExport ModeHandler : public ServiceProvider * so if you inherit from it or your mode can be removed by the default implementation then you do not have to implement * this function). * @param channel The channel which the server wants to remove your mode from - * @param stack The mode stack to add the mode change to + * @param changelist Mode change list to populate with the removal of this mode */ - virtual void RemoveMode(Channel* channel, irc::modestacker& stack); + virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist); inline unsigned int GetLevelRequired() const { return levelrequired; } @@ -344,8 +341,10 @@ class CoreExport PrefixMode : public ModeHandler * @param Creator The module creating this mode * @param Name The user-friendly one word name of the prefix mode, e.g.: "op", "voice" * @param ModeLetter The mode letter of this mode + * @param Rank Rank given by this prefix mode, see explanation above + * @param PrefixChar Prefix character, or 0 if the mode has no prefix character */ - PrefixMode(Module* Creator, const std::string& Name, char ModeLetter); + PrefixMode(Module* Creator, const std::string& Name, char ModeLetter, unsigned int Rank = 0, char PrefixChar = 0); /** * Handles setting and unsetting the prefix mode. @@ -365,9 +364,9 @@ class CoreExport PrefixMode : public ModeHandler /** * Removes this prefix mode from all users on the given channel * @param chan The channel which the server wants to remove your mode from - * @param stack The mode stack to add the mode change to + * @param changelist Mode change list to populate with the removal of this mode */ - void RemoveMode(Channel* chan, irc::modestacker& stack); + void RemoveMode(Channel* channel, Modes::ChangeList& changelist); /** * Mode prefix or 0. If this is defined, you should @@ -479,14 +478,12 @@ class CoreExport ModeWatcher : public classbase virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string& parameter, bool adding); }; -typedef std::multimap::iterator ModeWatchIter; - /** The mode parser handles routing of modes and handling of mode strings. * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes, * parses client to server MODE strings for user and channel modes, and performs * processing for the 004 mode list numeric, amongst other things. */ -class CoreExport ModeParser +class CoreExport ModeParser : public fakederef { public: static const ModeHandler::Id MODEID_MAX = 64; @@ -496,6 +493,10 @@ class CoreExport ModeParser typedef TR1NS::unordered_map ModeHandlerMap; private: + /** Type of the container that maps mode names to ModeWatchers + */ + typedef insp::flat_multimap ModeWatcherMap; + /** Last item in the ModeType enum */ static const unsigned int MODETYPE_LAST = 2; @@ -530,21 +531,16 @@ class CoreExport ModeParser /** Mode watcher classes */ - std::multimap modewatchermap; + ModeWatcherMap modewatchermap; - /** Displays the current modes of a channel or user. - * Used by ModeParser::Process. - */ - void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text); - /** Displays the value of a list mode - * Used by ModeParser::Process. + /** Last processed mode change */ - void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence); + Modes::ChangeList LastChangeList; /** * Attempts to apply a mode change to a user or channel */ - ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string ¶m, bool SkipACL); + ModeAction TryMode(User* user, User* targu, Channel* targc, Modes::Change& mcitem, bool SkipACL); /** Returns a list of user or channel mode characters. * Used for constructing the parts of the mode list in the 004 numeric. @@ -570,12 +566,6 @@ class CoreExport ModeParser * Use GetLastParse() to get this value, to be used for display purposes. */ std::string LastParse; - std::vector LastParseParams; - std::vector LastParseTranslate; - - unsigned int sent[256]; - - unsigned int seq; /** Cached mode list for use in 004 numeric */ @@ -601,11 +591,19 @@ class CoreExport ModeParser */ MODE_MERGE = 1, - /** If this flag is set then the mode change won't be handed over to - * the linking module to be sent to other servers, but will be processed + /** If this flag is set then the linking module will ignore the mode change + * and not send it to other servers. The mode change will be processed * locally and sent to local user(s) as usual. */ - MODE_LOCALONLY = 2 + MODE_LOCALONLY = 2, + + /** If this flag is set then the mode change will be subject to access checks. + * For more information see the documentation of the PrefixMode class, + * ModeHandler::levelrequired and ModeHandler::AccessCheck(). + * Modules may explicitly allow a mode change regardless of this flag by returning + * MOD_RES_ALLOW from the OnPreMode hook. Only affects channel mode changes. + */ + MODE_CHECKACCESS = 4 }; ModeParser(); @@ -635,8 +633,6 @@ class CoreExport ModeParser * @return Last parsed string, as seen by users. */ const std::string& GetLastParse() const { return LastParse; } - const std::vector& GetLastParseParams() { return LastParseParams; } - const std::vector& GetLastParseTranslate() { return LastParseTranslate; } /** Add a mode to the mode parser. * Throws a ModuleException if the mode cannot be added. @@ -669,14 +665,49 @@ class CoreExport ModeParser * @return True if the ModeWatcher was deleted correctly */ bool DelModeWatcher(ModeWatcher* mw); - /** Process a set of mode changes from a server or user. - * @param parameters The parameters of the mode change, in the format - * they would be from a MODE command. + + /** Process a list of mode changes entirely. If the mode changes do not fit into one MODE line + * then multiple MODE lines are generated. * @param user The source of the mode change, can be a server user. + * @param targetchannel Channel to apply the mode change on. NULL if changing modes on a channel. + * @param targetuser User to apply the mode change on. NULL if changing modes on a user. + * @param changelist Modes to change in form of a Modes::ChangeList. * @param flags Optional flags controlling how the mode change is processed, * defaults to MODE_NONE. */ - void Process(const std::vector& parameters, User* user, ModeProcessFlag flags = MODE_NONE); + void Process(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags = MODE_NONE); + + /** Process a single MODE line's worth of mode changes, taking max modes and line length limits + * into consideration. Return value indicates how many modes were processed. + * @param user The source of the mode change, can be a server user. + * @param targetchannel Channel to apply the mode change on. NULL if changing modes on a channel. + * @param targetuser User to apply the mode change on. NULL if changing modes on a user. + * @param changelist Modes to change in form of a Modes::ChangeList. May not process + * the entire list due to MODE line length and max modes limitations. + * @param flags Optional flags controlling how the mode change is processed, + * defaults to MODE_NONE. + * @param beginindex Index of the first element in changelist to process. Mode changes before + * the element with this index are ignored. + * @return Number of mode changes processed from changelist. + */ + unsigned int ProcessSingle(User* user, Channel* targetchannel, User* targetuser, Modes::ChangeList& changelist, ModeProcessFlag flags = MODE_NONE, unsigned int beginindex = 0); + + /** Turn a list of parameters compatible with the format of the MODE command into + * Modes::ChangeList form. All modes are processed, regardless of max modes. Unknown modes + * are skipped. + * @param user The source of the mode change, can be a server user. Error numerics are sent to + * this user. + * @param type MODETYPE_USER if this is a user mode change or MODETYPE_CHANNEL if this + * is a channel mode change. + * @param parameters List of strings describing the mode change to convert to a ChangeList. + * Must be using the same format as the parameters of a MODE command. + * @param changelist ChangeList object to populate. + * @param beginindex Index of the first element that is part of the MODE list in the parameters + * container. Defaults to 1. + * @param endindex Index of the first element that is not part of the MODE list. By default, + * the entire container is considered part of the MODE list. + */ + void ModeParamsToChangeList(User* user, ModeType type, const std::vector& parameters, Modes::ChangeList& changelist, unsigned int beginindex = 1, unsigned int endindex = UINT_MAX); /** Find the mode handler for a given mode name and type. * @param modename The mode name to search for. @@ -741,6 +772,13 @@ class CoreExport ModeParser * @return A map of mode handlers of the given type */ const ModeHandlerMap& GetModes(ModeType mt) const { return modehandlersbyname[mt]; } + + /** Show the list of a list mode to a user. Modules can deny the listing. + * @param user User to show the list to. + * @param chan Channel to show the list of. + * @param mh List mode to show the list of. + */ + void ShowListModeList(User* user, Channel* chan, ModeHandler* mh); }; inline const std::string& ModeParser::GetModeListFor004Numeric()