X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=7dc7feaec88234d323e6888bec449aec03e4e5f2;hb=37b46ade4b760602c814e24adaa0f0278b4f43f4;hp=2e9ed22f31279aa94b86614af753a8b61aa52615;hpb=02497bfa999da26c19a92d8620c35bb97f1da711;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 2e9ed22f3..7dc7feaec 100644 --- a/include/mode.h +++ b/include/mode.h @@ -148,10 +148,14 @@ class CoreExport ModeHandler : public ServiceProvider */ const Class type_id; - /** The prefix char needed on channel to use this mode, - * only checked for channel modes - */ - int levelrequired; + /** The prefix rank required to set this mode on channels. */ + unsigned int ranktoset; + + /** The prefix rank required to unset this mode on channels. */ + unsigned int ranktounset; + + /** If non-empty then the syntax of the parameter for this mode. */ + std::string syntax; public: /** @@ -166,7 +170,7 @@ class CoreExport ModeHandler : public ServiceProvider * @param mclass The object type of this mode handler, one of ModeHandler::Class */ ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type, Class mclass = MC_OTHER); - virtual CullResult cull() CXX11_OVERRIDE; + CullResult cull() CXX11_OVERRIDE; virtual ~ModeHandler(); /** Register this object in the ModeParser @@ -320,7 +324,16 @@ class CoreExport ModeHandler : public ServiceProvider */ virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist); - inline unsigned int GetLevelRequired() const { return levelrequired; } + /** Retrieves the level required to modify this mode. + * @param adding Whether the mode is being added or removed. + */ + inline unsigned int GetLevelRequired(bool adding) const + { + return adding ? ranktoset : ranktounset; + } + + /** Retrieves the syntax of the parameter for this mode. */ + const std::string& GetSyntax() const { return syntax; } friend class ModeParser; }; @@ -352,6 +365,9 @@ class CoreExport PrefixMode : public ModeHandler */ unsigned int prefixrank; + /** Whether a client with this prefix can remove it from themself. */ + bool selfremove; + public: /** * Constructor @@ -363,6 +379,16 @@ class CoreExport PrefixMode : public ModeHandler */ PrefixMode(Module* Creator, const std::string& Name, char ModeLetter, unsigned int Rank = 0, char PrefixChar = 0); + /** + * Called when a channel mode change access check for your mode occurs. + * @param source Contains the user setting the mode. + * @param channel contains the destination channel the modes are being set on. + * @param parameter The parameter for your mode. This is modifiable. + * @param adding This value is true when the mode is being set, or false when it is being unset. + * @return allow, deny, or passthru to check against the required level + */ + ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding) CXX11_OVERRIDE; + /** * Handles setting and unsetting the prefix mode. * Finds the given member of the given channel, if it's not found an error message is sent to 'source' @@ -376,14 +402,29 @@ class CoreExport PrefixMode : public ModeHandler * The latter occurs either when the member cannot be found or when the member already has this prefix set * (when setting) or doesn't have this prefix set (when unsetting). */ - ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& param, bool adding); + ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& param, bool adding) CXX11_OVERRIDE; + + /** + * Updates the configuration of this prefix. + * @param rank The prefix rank of this mode. + * @param setrank The prefix rank required to set this mode on channels. + * @param unsetrank The prefix rank required to set this unmode on channels. + * @param selfrm Whether a client with this prefix can remove it from themself. + */ + void Update(unsigned int rank, unsigned int setrank, unsigned int unsetrank, bool selfrm); /** * 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 channel The channel which the server wants to remove your mode from * @param changelist Mode change list to populate with the removal of this mode */ - void RemoveMode(Channel* channel, Modes::ChangeList& changelist); + void RemoveMode(Channel* channel, Modes::ChangeList& changelist) CXX11_OVERRIDE; + + + /** + * Determines whether a user with this prefix mode can remove it. + */ + bool CanSelfRemove() const { return selfremove; } /** * Mode prefix or 0. If this is defined, you should @@ -412,7 +453,7 @@ class CoreExport SimpleUserModeHandler : public ModeHandler public: SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter) : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {} - virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); + ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE; }; /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra @@ -425,7 +466,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 ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); + ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE; }; /** @@ -503,8 +544,12 @@ class CoreExport ModeWatcher : public classbase class CoreExport ModeParser : public fakederef { public: + /** The maximum number of modes which can be created. */ static const ModeHandler::Id MODEID_MAX = 64; + /** The maximum length of a mode parameter. */ + static const size_t MODE_PARAM_MAX = 250; + /** Type of the container that maps mode names to ModeHandlers */ typedef TR1NS::unordered_map ModeHandlerMap; @@ -559,35 +604,12 @@ class CoreExport ModeParser : public fakederef */ 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. - * @param mt Controls whether to list user modes or channel modes - * @param needparam Return modes only if they require a parameter to be set - * @return The available mode letters that satisfy the given conditions - */ - std::string CreateModeList(ModeType mt, bool needparam = false); - - /** Recreate the cached mode list that is displayed in the 004 numeric - * in Cached004ModeList. - * Called when a mode handler is added or removed. - */ - 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; - - /** Cached mode list for use in 004 numeric - */ - std::string Cached004ModeList; - public: typedef std::vector ListModeList; typedef std::vector PrefixModeList; @@ -616,7 +638,7 @@ class CoreExport ModeParser : public fakederef /** 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(). + * ModeHandler::ranktoset 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. */ @@ -626,9 +648,7 @@ class CoreExport ModeParser : public fakederef ModeParser(); ~ModeParser(); - /** Initialize all built-in modes - */ - static void InitBuiltinModes(); + static bool IsModeChar(char chr); /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. @@ -644,12 +664,9 @@ class CoreExport ModeParser : public fakederef * This method can be used on both IPV4 and IPV6 user masks. */ static void CleanMask(std::string &mask); - /** Get the last string to be processed, as it was sent to the user or channel. - * Use this to display a string you just sent to be parsed, as the actual output - * may be different to what you sent after it has been 'cleaned up' by the parser. - * @return Last parsed string, as seen by users. - */ - const std::string& GetLastParse() const { return LastParse; } + + /** Gets the last mode change to be processed. */ + const Modes::ChangeList& GetLastChangeList() const { return LastChangeList; } /** Add a mode to the mode parser. * Throws a ModuleException if the mode cannot be added. @@ -699,7 +716,7 @@ class CoreExport ModeParser : public fakederef * @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 + * @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. @@ -718,11 +735,11 @@ class CoreExport ModeParser : public fakederef * 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. + * @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); @@ -753,14 +770,6 @@ class CoreExport ModeParser : public fakederef */ PrefixMode* FindPrefix(unsigned const char pfxletter); - /** Returns a list of modes, space seperated by type: - * 1. User modes - * 2. Channel modes - * 3. Channel modes that require a parameter when set - * This is sent to users as the last part of the 004 numeric - */ - const std::string& GetModeListFor004Numeric(); - /** Generates a list of modes, comma seperated by type: * 1; Listmodes EXCEPT those with a prefix * 2; Modes that take a param when adding or removing @@ -798,11 +807,6 @@ class CoreExport ModeParser : public fakederef void ShowListModeList(User* user, Channel* chan, ModeHandler* mh); }; -inline const std::string& ModeParser::GetModeListFor004Numeric() -{ - return Cached004ModeList; -} - inline PrefixMode* ModeHandler::IsPrefixMode() { return (this->type_id == MC_PREFIX ? static_cast(this) : NULL);