X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=a7d6ff2b0a8be8c3e44e26325e95fee8f82b9428;hb=31897d26f2ae1f0fc794a5af512dd4e81053611b;hp=83b8f31be88cb596d6952f1c5fd317eb8ceffb8e;hpb=d23c030c9a8fd58807438245a004e4aa5b7288ba;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 83b8f31be..a7d6ff2b0 100644 --- a/include/mode.h +++ b/include/mode.h @@ -1,10 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2013-2016 Attila Molnar + * Copyright (C) 2012-2013, 2017-2020 Sadie Powell + * Copyright (C) 2012 Robby * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2004-2006, 2008 Craig Edwards - * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2008 Robin Burchell * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2008, 2010 Craig Edwards * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public @@ -154,6 +158,9 @@ class CoreExport ModeHandler : public ServiceProvider /** 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: /** * The constructor for ModeHandler initalizes the mode handler. @@ -167,7 +174,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 @@ -329,6 +336,9 @@ class CoreExport ModeHandler : public ServiceProvider return adding ? ranktoset : ranktounset; } + /** Retrieves the syntax of the parameter for this mode. */ + const std::string& GetSyntax() const { return syntax; } + friend class ModeParser; }; @@ -396,7 +406,7 @@ 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. @@ -412,7 +422,7 @@ class CoreExport PrefixMode : public ModeHandler * @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; /** @@ -445,9 +455,13 @@ class CoreExport PrefixMode : public ModeHandler 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); + SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false) + : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) + { + oper = operonly; + } + + 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 @@ -458,9 +472,13 @@ class CoreExport SimpleUserModeHandler : public ModeHandler 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); + SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter, bool operonly = false) + : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) + { + oper = operonly; + } + + ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE; }; /** @@ -538,8 +556,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; @@ -594,35 +616,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 - */ - TR1NS::array Cached004ModeList; - public: typedef std::vector ListModeList; typedef std::vector PrefixModeList; @@ -661,10 +660,6 @@ 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. @@ -681,12 +676,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. @@ -736,7 +728,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. @@ -755,11 +747,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); @@ -790,14 +782,6 @@ class CoreExport ModeParser : public fakederef */ PrefixMode* FindPrefix(unsigned const char pfxletter); - /** Returns an array of modes: - * 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 TR1NS::array& 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 @@ -835,11 +819,6 @@ class CoreExport ModeParser : public fakederef void ShowListModeList(User* user, Channel* chan, ModeHandler* mh); }; -inline const TR1NS::array& ModeParser::GetModeListFor004Numeric() -{ - return Cached004ModeList; -} - inline PrefixMode* ModeHandler::IsPrefixMode() { return (this->type_id == MC_PREFIX ? static_cast(this) : NULL);