X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=27cdd890f40f735c532a83d1d92ab99f54c53ae1;hb=7f9c5d0bb0aee8939a92c9003121c53c7a6d1057;hp=58586a0017b586da2956e33ee36c09895656acca;hpb=a1f073f66f4b985bf776b9be2015136209c0c311;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 58586a001..27cdd890f 100644 --- a/include/mode.h +++ b/include/mode.h @@ -18,21 +18,21 @@ #define __MODE_H /* include the common header files */ -#include -#include #include #include -#include #include #include "users.h" #include "channels.h" #include "ctables.h" +class InspIRCd; + /** * Holds the values for different type of modes * that can exist, USER or CHANNEL type. */ -enum ModeType { +enum ModeType +{ MODETYPE_USER = 0, MODETYPE_CHANNEL = 1 }; @@ -40,7 +40,8 @@ enum ModeType { /** * Holds mode actions - modes can be allowed or denied. */ -enum ModeAction { +enum ModeAction +{ MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */ MODEACTION_ALLOW = 1 /* Allow the mode */ }; @@ -50,11 +51,27 @@ enum ModeAction { * array. Used in a simple two instruction hashing function * "(modeletter - 65) OR mask" */ -enum ModeMasks { +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 chanrec, and is told that user 'joebloggs' has the prefix + * '$', and you dont know what $ means, then you can compare it to these three values to determine + * its worth against them. For example if '$' had a value of 15000, you would know it is of higher + * status than voice, but lower status than halfop. + * No two modes should have equal prefix values. + */ +enum PrefixModeValue +{ + VOICE_VALUE = 10000, + HALFOP_VALUE = 20000, + OP_VALUE = 30000 +}; + /** * 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, @@ -79,6 +96,7 @@ typedef std::pair ModePair; class ModeHandler : public Extensible { protected: + InspIRCd* ServerInstance; /** * The mode letter you're implementing. */ @@ -113,6 +131,10 @@ class ModeHandler : public Extensible */ bool oper; + /** Mode prefix, or 0 + */ + char prefix; + public: /** * The constructor for ModeHandler initalizes the mode handler. @@ -124,17 +146,35 @@ class ModeHandler : public Extensible * @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(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly); + ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0); /** * The default destructor does nothing */ virtual ~ModeHandler(); - /** * Returns true if the mode is a list mode */ bool IsListMode(); + /** + * Mode prefix or 0. If this is defined, you should + * also implement GetPrefixRank() to return an integer + * value for this mode prefix. + */ + char GetPrefix(); + /** + * Get the 'value' of this modes prefix. + * determines which to display when there are multiple. + * The mode with the highest value is ranked first. See the + * PrefixModeValue enum and chanrec::GetPrefixValue() for + * more information. + */ + virtual unsigned int GetPrefixRank(); /** * Returns the modes type */ @@ -204,6 +244,26 @@ class ModeHandler : public Extensible * This allows the local server to enforce our locally set parameters back to a remote server. */ virtual ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter); + + /** + * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server. + * Your mode handler should remove its user mode from the user by sending the appropriate server modes using + * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters, + * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove + * your mode properly from each user. + * @param user The user which the server wants to remove your mode from + */ + virtual void RemoveMode(userrec* user); + + /** + * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server. + * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using + * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters, + * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove + * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items. + * @param channel The channel which the server wants to remove your mode from + */ + virtual void RemoveMode(chanrec* channel); }; /** @@ -215,6 +275,7 @@ class ModeHandler : public Extensible class ModeWatcher : public Extensible { protected: + InspIRCd* ServerInstance; /** * The mode letter this class is watching */ @@ -228,7 +289,7 @@ class ModeWatcher : public Extensible /** * The constructor initializes the mode and the mode type */ - ModeWatcher(char modeletter, ModeType type); + ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type); /** * The default destructor does nothing. */ @@ -274,50 +335,48 @@ class ModeWatcher : public Extensible typedef std::vector::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 ModeParser : public classbase { private: - /** - * Mode handlers for each mode, to access a handler subtract + 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 * or a channel mode, so we have 256 of them not 64. */ ModeHandler* modehandlers[256]; - /** - * Mode watcher classes arranged in the same way as the + /** Mode watcher classes arranged in the same way as the * mode handlers, except for instead of having 256 of them * we have 256 lists of them. */ std::vector modewatchers[256]; - /** - * Displays the current modes of a channel or user. + /** Displays the current modes of a channel or user. * Used by ModeParser::Process. */ void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text); public: - /** - * The constructor initializes all the RFC basic modes by using ModeParserAddMode(). + /** The constructor initializes all the RFC basic modes by using ModeParserAddMode(). */ - ModeParser(); + ModeParser(InspIRCd* Instance); - /** - * Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'. + /** 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'. */ - static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status); - /** - * Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel + userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status); + /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel */ - static const char* Grant(userrec *d,chanrec *chan,int MASK); - /** - * Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel + const char* Grant(userrec *d,chanrec *chan,int MASK); + /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel */ - static const char* Revoke(userrec *d,chanrec *chan,int MASK); - /** - * Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. + const char* Revoke(userrec *d,chanrec *chan,int MASK); + /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. * * nick -> nick!*@* @@ -331,15 +390,22 @@ class ModeParser : public classbase * This method can be used on both IPV4 and IPV6 user masks. */ static void CleanMask(std::string &mask); - /** - * Add a mode to the mode parser. The modeletter parameter + /** Add a mode to the mode parser. The modeletter parameter * is purely to save on doing a lookup in the function, as * strictly it could be obtained via ModeHandler::GetModeChar(). * @return True if the mode was successfully added. */ bool AddMode(ModeHandler* mh, unsigned const char modeletter); - /** - * Add a mode watcher. + /** 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 + * (if it is a channel mode) to unset the mode on all objects. + * This prevents modes staying in the system which no longer exist. + * @param mh The mode handler to remove + * @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 * information. @@ -347,8 +413,7 @@ class ModeParser : public classbase * @return True if the ModeWatcher was added correctly */ bool AddModeWatcher(ModeWatcher* mw); - /** - * Delete a mode watcher. + /** Delete a mode watcher. * A mode watcher is triggered before and after a mode handler is * triggered. See the documentation of class ModeWatcher for more * information. @@ -356,8 +421,7 @@ class ModeParser : public classbase * @return True if the ModeWatcher was deleted correctly */ bool DelModeWatcher(ModeWatcher* mw); - /** - * Process a set of mode changes from a server or user. + /** 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. * @param pcnt The number of items in the parameters array @@ -368,28 +432,67 @@ class ModeParser : public classbase */ void Process(const char** parameters, int pcnt, userrec *user, bool servermode); - /** - * Find the mode handler for a given mode and type + /** Find the mode handler for a given mode and type. * @param modeletter mode letter to search for * @param type of mode to search for, user or channel * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode */ ModeHandler* FindMode(unsigned const char modeletter, ModeType mt); + + /** Find a mode handler by its prefix. + * If there is no mode handler with the given prefix, NULL will be returned. + * @param pfxletter The prefix to find, e.g. '@' + * @return The mode handler which handles this prefix, or NULL if there is none. + */ + ModeHandler* FindPrefix(unsigned const char pfxletter); + + /** Returns a list of mode characters which are usermodes. + * This is used in the 004 numeric when users connect. + */ + std::string UserModeList(); + + /** Returns a list of channel mode characters which are listmodes. + * This is used in the 004 numeric when users connect. + */ + std::string ChannelModeList(); + + /** Returns a list of channel mode characters which take parameters. + * This is used in the 004 numeric when users connect. + */ + std::string ParaModeList(); + + /** Generates the CHANMODES= 005 sequence + */ + std::string ChanModes(); + /** Used by this class internally during std::sort and 005 generation + */ + static bool PrefixComparison(const prefixtype one, const prefixtype two); + + /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric. + */ + std::string BuildPrefixes(); + + /** This returns the privilages of a user upon a channel, in the format of a mode change. + * For example, if a user has privilages +avh, this will return the string "avh nick nick nick". + * This is used by the core when cycling a user to refresh their hostname. You may use it for + * similar purposes. + * @param user The username to look up + * @param channel The channel name to look up the privilages of the user for + * @return The mode string. + */ + std::string ModeString(userrec* user, chanrec* channel); }; -/** - * Command handler class for the MODE command. +/** Command handler class for the MODE command. * put here for completeness. */ class cmd_mode : public command_t { public: - /** - * Standard constructor + /** Standard constructor */ - cmd_mode () : command_t("MODE",0,1) { } - /** - * Handle MODE + cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = " {}"; } + /** Handle MODE */ void Handle(const char** parameters, int pcnt, userrec *user); };