X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=b63e5e6a91116f3cc860a3db789745255f7621fe;hb=9db7af579c46a9f0379fdf71fb773a0a76a94846;hp=a8dd839dd4ca47fd7b28c11bf44dd5f8cf5e29f7;hpb=1a738eb97eb7ac62b7d28bd40b03969d175ee6e3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index a8dd839dd..b63e5e6a9 100644 --- a/include/mode.h +++ b/include/mode.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -17,6 +17,7 @@ /* Forward declarations. */ class User; +#include "ctables.h" #include "channels.h" /** @@ -69,6 +70,16 @@ enum PrefixModeValue OP_VALUE = 30000 }; +enum ParamSpec +{ + /** No parameters */ + PARAM_NONE, + /** Parameter required on mode setting only */ + PARAM_SETONLY, + /** Parameter always required */ + PARAM_ALWAYS +}; + /** * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user. * The pair contains an activity flag, true if the mode is set with the given parameter, @@ -90,25 +101,33 @@ typedef std::pair ModePair; * mode is expected to have a parameter, then this is * equivalent to returning MODEACTION_DENY. */ -class CoreExport ModeHandler : public Extensible +class CoreExport ModeHandler : public classbase { protected: /** - * Creator/owner pointer + * The mode parameter translation type */ - InspIRCd* ServerInstance; + TranslateType m_paramtype; + + /** What kind of parameters does the mode take? + */ + ParamSpec parameters_taken; + /** * The mode letter you're implementing. */ - char mode; - /** - * Number of parameters when being set + const char mode; + + /** Mode prefix, or 0 */ - int n_params_on; + char prefix; + /** - * Number of parameters when being unset + * True if the mode requires oper status + * to set. */ - int n_params_off; + bool oper; + /** * Mode is a 'list' mode. The behaviour * of your mode is now set entirely within @@ -120,20 +139,12 @@ class CoreExport ModeHandler : public Extensible * (e.g. banlists, etc) */ bool list; + /** * The mode type, either MODETYPE_USER or * MODETYPE_CHANNEL. */ ModeType m_type; - /** - * True if the mode requires oper status - * to set. - */ - bool oper; - - /** Mode prefix, or 0 - */ - char prefix; /** Number of items with this mode set on them */ @@ -142,29 +153,26 @@ class CoreExport ModeHandler : public Extensible /** The prefix char needed on channel to use this mode, * only checked for channel modes */ - char prefixneeded; + int levelrequired; public: + /** Module that created this mode. NULL for core modes */ + Module* const creator; + /** Long-form name + */ + const std::string name; + /** * The constructor for ModeHandler initalizes the mode handler. * The constructor of any class you derive from ModeHandler should * probably call this constructor with the parameters set correctly. + * @param name A one-word name for the mode * @param modeletter The mode letter you wish to handle - * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1. - * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1. - * @param listmode Set to true if your mode is a listmode, e.g. it will respond to MODE #channel +modechar with a list of items - * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode. - * @param operonly Set this to true if only opers should be allowed to set or unset the mode. - * @param mprefix For listmodes where parameters are NICKNAMES which are on the channel (for example, +ohv), you may define a prefix. - * When you define a prefix, it can be returned in NAMES, WHO etc if it has the highest value (as returned by GetPrefixRank()) - * In the core, the only modes to implement prefixes are +ovh (ops, voice, halfop) which define the prefix characters @, % and + - * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional - * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example. - */ - ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0, char prefixrequired = '%'); - /** - * The default destructor does nothing + * @param params Parameters taken by the mode + * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL) */ + ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type); + virtual CullResult cull(); virtual ~ModeHandler(); /** * Returns true if the mode is a list mode @@ -175,7 +183,7 @@ class CoreExport ModeHandler : public Extensible * also implement GetPrefixRank() to return an integer * value for this mode prefix. */ - char GetPrefix(); + inline char GetPrefix() const { return prefix; } /** Get number of items with this mode set on them */ virtual unsigned int GetCount(); @@ -191,13 +199,17 @@ class CoreExport ModeHandler : public Extensible */ virtual unsigned int GetPrefixRank(); /** - * Returns the modes type + * Returns the mode's type */ - ModeType GetModeType(); + 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 */ - bool NeedsOper(); + inline bool NeedsOper() const { return oper; } /** * Returns the number of parameters for the mode. Any non-zero * value should be considered to be equivalent to one. @@ -215,6 +227,16 @@ class CoreExport ModeHandler : public Extensible */ virtual std::string GetUserParameter(User* useor); + /** + * 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 + */ + virtual ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding); + /** * Called when a mode change for your mode occurs. * @param source Contains the user setting the mode. @@ -227,7 +249,7 @@ class CoreExport ModeHandler : public Extensible * @param adding This value is true when the mode is being set, or false when it is being unset. * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'. */ - virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool servermode = false); /* Can change the mode parameter as its a ref */ + virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */ /** * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar * without any parameter or other modes in the command. @@ -256,14 +278,12 @@ class CoreExport ModeHandler : public Extensible * override this function and use it to return true or false. The default implementation just returns true if * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where * theirs == ours (therefore the default implementation will always return false). - * @param theirs The timestamp of the remote side - * @param ours The timestamp of the local side * @param their_param Their parameter if the mode has a parameter * @param our_param Our parameter if the mode has a parameter * @param channel The channel we are checking against * @return True if the other side wins the merge, false if we win the merge for this mode. */ - virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel); + virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel); /** * When a remote server needs to bounce a set of modes, it will call this method for every mode @@ -300,9 +320,7 @@ class CoreExport ModeHandler : public Extensible */ virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL); - char GetNeededPrefix(); - - void SetNeededPrefix(char needsprefix); + inline unsigned int GetLevelRequired() const { return levelrequired; } }; /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra @@ -313,9 +331,10 @@ class CoreExport ModeHandler : public Extensible class CoreExport SimpleUserModeHandler : public ModeHandler { public: - SimpleUserModeHandler(InspIRCd* Instance, char modeletter); - virtual ~SimpleUserModeHandler(); - virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool servermode = false); + 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); }; /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra @@ -326,9 +345,10 @@ class CoreExport SimpleUserModeHandler : public ModeHandler class CoreExport SimpleChannelModeHandler : public ModeHandler { public: - SimpleChannelModeHandler(InspIRCd* Instance, char modeletter); - virtual ~SimpleChannelModeHandler(); - virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool servermode = false); + 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); }; /** @@ -337,13 +357,9 @@ class CoreExport SimpleChannelModeHandler : public ModeHandler * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher. * A ModeWatcher will be called both before and after the mode change. */ -class CoreExport ModeWatcher : public Extensible +class CoreExport ModeWatcher : public classbase { protected: - /** - * Creator/owner pointer - */ - InspIRCd* ServerInstance; /** * The mode letter this class is watching */ @@ -354,10 +370,11 @@ class CoreExport ModeWatcher : public Extensible ModeType m_type; public: + Module* const creator; /** * The constructor initializes the mode and the mode type */ - ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type); + ModeWatcher(Module* creator, char modeletter, ModeType type); /** * The default destructor does nothing. */ @@ -387,7 +404,7 @@ class CoreExport ModeWatcher : public Extensible * @return True to allow the mode change to go ahead, false to abort it. If you abort the * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change. */ - virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type, bool servermode = false); + virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type); /** * After the mode character has been processed by the ModeHandler, this method will be called. * @param source The sender of the mode @@ -398,7 +415,7 @@ class CoreExport ModeWatcher : public Extensible * @param adding True if the mode is being added and false if it is being removed * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL */ - virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type, bool servermode = false); + virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type); }; typedef std::vector::iterator ModeWatchIter; @@ -411,10 +428,6 @@ typedef std::vector::iterator ModeWatchIter; class CoreExport ModeParser : public classbase { private: - /** - * Creator/owner pointer - */ - InspIRCd* ServerInstance; /** 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 @@ -430,11 +443,22 @@ class CoreExport ModeParser : public classbase * 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. + */ + void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence); + + /** + * 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); /** 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]; @@ -444,38 +468,35 @@ class CoreExport ModeParser : public classbase /** The constructor initializes all the RFC basic modes by using ModeParserAddMode(). */ - ModeParser(InspIRCd* Instance); + ModeParser(); + ~ModeParser(); /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'. * for example, should 'user A' be able to 'op' on 'channel B'. */ User* SanityChecks(User *user,const char *dest,Channel *chan,int status); - /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel - */ - const char* Grant(User *d,Channel *chan,int MASK); - /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel - */ - const char* Revoke(User *d,Channel *chan,int MASK); /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. * * nick -> nick!*@* - * + * * nick!ident -> nick!ident@* - * + * * host.name -> *!*@host.name - * + * * ident@host.name -> *!ident@host.name * * 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. + /** 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 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. */ @@ -489,6 +510,7 @@ class CoreExport ModeParser : public classbase * @return True if the mode was successfully removed. */ bool DelMode(ModeHandler* mh); + /** Add a mode watcher. * A mode watcher is triggered before and after a mode handler is * triggered. See the documentation of class ModeWatcher for more @@ -511,9 +533,8 @@ class CoreExport ModeParser : public classbase * @param user The user setting or removing the modes. When the modes are set * by a server, an 'uninitialized' User is used, where *user::nick == NULL * and *user->server == NULL. - * @param servermode True if a server is setting the mode. */ - void Process(const std::vector& parameters, User *user, bool servermode); + void Process(const std::vector& parameters, User *user, bool merge = false); /** Find the mode handler for a given mode and type. * @param modeletter mode letter to search for @@ -552,9 +573,7 @@ class CoreExport ModeParser : public classbase */ std::string GiveModeList(ModeMasks m); - /** Used by this class internally during std::sort and 005 generation - */ - static bool PrefixComparison(prefixtype one, prefixtype two); + static bool PrefixComparison(ModeHandler* one, ModeHandler* two); /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric. */ @@ -574,4 +593,3 @@ class CoreExport ModeParser : public classbase }; #endif -