X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=e7ac756ecdaa636faf524166a272776f3fcea400;hb=932748db6dd2a7225c9f12bc34339fcb2f37c319;hp=e20815549bccca99449e26b475c33c612adff61f;hpb=16398df07d4ce1f1d4a2e43d97bc39043f8d44b5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index e20815549..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 @@ -45,17 +46,6 @@ enum ModeAction MODEACTION_ALLOW = 1 /* Allow the mode */ }; -/** - * Used to mask off the mode types in the mode handler - * array. Used in a simple two instruction hashing function - * "(modeletter - 65) OR mask" - */ -enum ModeMasks -{ - MASK_USER = 128, /* A user mode */ - MASK_CHANNEL = 0 /* A channel mode */ -}; - /** * These fixed values can be used to proportionally compare module-defined prefixes to known values. * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix @@ -85,6 +75,8 @@ enum ParamSpec }; class PrefixMode; +class ListModeBase; +class ParamModeBase; /** Each mode is implemented by ONE ModeHandler class. * You must derive ModeHandler and add the child class to @@ -103,18 +95,22 @@ class PrefixMode; class CoreExport ModeHandler : public ServiceProvider { public: + typedef size_t Id; + enum Class { MC_PREFIX, + MC_LIST, + MC_PARAM, MC_OTHER }; - protected: - /** - * The mode parameter translation type + private: + /** The opaque id of this mode assigned by the mode parser */ - TranslateType m_paramtype; + Id modeid; + protected: /** What kind of parameters does the mode take? */ ParamSpec parameters_taken; @@ -172,24 +168,38 @@ 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 */ bool IsListMode() const { return list; } /** - * Returns a PrefixMode* if this mode is a prefix mode, NULL otherwise + * Check whether this mode is a prefix mode + * @return non-NULL if this mode is a prefix mode, NULL otherwise */ PrefixMode* IsPrefixMode(); /** - * Returns the mode's type + * Check whether this mode handler inherits from ListModeBase + * @return non-NULL if this mode handler inherits from ListModeBase, NULL otherwise */ - inline ModeType GetModeType() const { return m_type; } + ListModeBase* IsListModeBase(); + /** - * Returns the mode's parameter translation type + * Check whether this mode handler inherits from ListModeBase + * @return non-NULL if this mode handler inherits from ParamModeBase, NULL otherwise */ - inline TranslateType GetTranslateType() const { return m_paramtype; } + ParamModeBase* IsParameterMode(); + + /** + * Returns the mode's type + */ + inline ModeType GetModeType() const { return m_type; } /** * Returns true if the mode can only be set/unset by an oper */ @@ -207,6 +217,11 @@ class CoreExport ModeHandler : public ServiceProvider */ inline char GetModeChar() { return mode; } + /** Return the id of this mode which is used in User::modes and + * Channel::modes as the index to determine whether a mode is set. + */ + Id GetId() const { return modeid; } + /** For user modes, return the current parameter, if any */ virtual std::string GetUserParameter(User* useor); @@ -284,11 +299,13 @@ 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; } + + friend class ModeParser; }; /** @@ -305,7 +322,7 @@ class CoreExport ModeHandler : public ServiceProvider * for example changing the topic on a channel having +t set requires a rank that is >= than the rank of a halfop, * but there is no such restriction when +t isn't set. */ -class PrefixMode : public ModeHandler +class CoreExport PrefixMode : public ModeHandler { protected: /** The prefix character granted by this mode. '@' for op, '+' for voice, etc. @@ -324,8 +341,10 @@ class 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. @@ -345,9 +364,9 @@ class 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 @@ -376,7 +395,6 @@ class CoreExport SimpleUserModeHandler : public ModeHandler public: SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter) : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {} - virtual ~SimpleUserModeHandler() {} virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); }; @@ -390,18 +408,7 @@ class CoreExport SimpleChannelModeHandler : public ModeHandler public: SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter) : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {} - virtual ~SimpleChannelModeHandler() {} - virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); -}; - -class CoreExport ParamChannelModeHandler : public ModeHandler -{ - public: - ParamChannelModeHandler(Module* Creator, const std::string& Name, char modeletter) - : ModeHandler(Creator, Name, modeletter, PARAM_SETONLY, MODETYPE_CHANNEL) {} virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); - /** Validate the parameter - you may change the value to normalize it. Return true if it is valid. */ - virtual bool ParamValidate(std::string& parameter); }; /** @@ -471,40 +478,69 @@ 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; + + /** Type of the container that maps mode names to ModeHandlers + */ + 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; + /** Mode handlers for each mode, to access a handler subtract * 65 from the ascii value of the mode letter. * The upper bit of the value indicates if its a usermode * or a channel mode, so we have 256 of them not 64. */ - ModeHandler* modehandlers[256]; + ModeHandler* modehandlers[MODETYPE_LAST][128]; - /** Mode watcher classes + /** An array of mode handlers indexed by the mode id */ - std::multimap modewatchermap; + ModeHandler* modehandlersbyid[MODETYPE_LAST][MODEID_MAX]; - /** Displays the current modes of a channel or user. - * Used by ModeParser::Process. + /** A map of mode handlers keyed by their name */ - void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text); - /** Displays the value of a list mode - * Used by ModeParser::Process. + ModeHandlerMap modehandlersbyname[MODETYPE_LAST]; + + /** Lists of mode handlers by type + */ + struct + { + /** List of mode handlers that inherit from ListModeBase + */ + std::vector list; + + /** List of mode handlers that inherit from PrefixMode + */ + std::vector prefix; + } mhlist; + + /** Mode watcher classes + */ + ModeWatcherMap modewatchermap; + + /** 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. @@ -520,22 +556,25 @@ class CoreExport ModeParser */ void RecreateModeListFor004Numeric(); + /** Allocates an unused id for the given mode type, throws a ModuleException if out of ids. + * @param mt The type of the mode to allocate the id for + * @return The id + */ + ModeHandler::Id AllocateModeId(ModeType mt); + /** The string representing the last set of modes to be parsed. * 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 */ std::string Cached004ModeList; public: + typedef std::vector ListModeList; + typedef std::vector PrefixModeList; + typedef unsigned int ModeProcessFlag; enum ModeProcessFlags { @@ -552,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(); @@ -586,12 +633,12 @@ 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. - * @return True if the mode was successfully added. + * Throws a ModuleException if the mode cannot be added. */ - bool AddMode(ModeHandler* mh); + void AddMode(ModeHandler* mh); + /** Delete a mode from the mode parser. * When a mode is deleted, the mode handler will be called * for every user (if it is a user mode) or for every channel @@ -618,14 +665,56 @@ 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. + * @param mt Type of mode to search for, user or channel. + * @return A pointer to a ModeHandler class, or NULL of there isn't a handler for the given mode name. + */ + ModeHandler* FindMode(const std::string& modename, ModeType mt); /** Find the mode handler for a given mode and type. * @param modeletter mode letter to search for @@ -661,12 +750,35 @@ class CoreExport ModeParser * 3; Modes that only take a param when adding * 4; Modes that dont take a param */ - std::string GiveModeList(ModeMasks m); + std::string GiveModeList(ModeType mt); /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or * just the "@%+" part if the parameter false */ std::string BuildPrefixes(bool lettersAndModes = true); + + /** Get a list of all mode handlers that inherit from ListModeBase + * @return A list containing ListModeBase modes + */ + const ListModeList& GetListModes() const { return mhlist.list; } + + /** Get a list of all prefix modes + * @return A list containing all prefix modes + */ + const PrefixModeList& GetPrefixModes() const { return mhlist.prefix; } + + /** Get a mode name -> ModeHandler* map containing all modes of the given type + * @param mt Type of modes to return, MODETYPE_USER or MODETYPE_CHANNEL + * @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() @@ -678,3 +790,13 @@ inline PrefixMode* ModeHandler::IsPrefixMode() { return (this->type_id == MC_PREFIX ? static_cast(this) : NULL); } + +inline ListModeBase* ModeHandler::IsListModeBase() +{ + return (this->type_id == MC_LIST ? reinterpret_cast(this) : NULL); +} + +inline ParamModeBase* ModeHandler::IsParameterMode() +{ + return (this->type_id == MC_PARAM ? reinterpret_cast(this) : NULL); +}