X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=2875d853ea72af62c272c7602962b407e8b1d064;hb=38ca8be9a3881a3cb3cf6864e67b779ffbab6874;hp=10b21a6b736cc0774a5efd2d3bee16be25774326;hpb=8b864c8a828d6ca97b5ec15fa7bf8fcc35027294;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 10b21a6b7..2875d853e 100644 --- a/include/mode.h +++ b/include/mode.h @@ -2,12 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -18,11 +15,8 @@ #define __MODE_H /* include the common header files */ -#include -#include #include #include -#include #include #include "users.h" #include "channels.h" @@ -60,6 +54,14 @@ enum ModeMasks 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, @@ -130,6 +132,10 @@ class ModeHandler : public Extensible */ char prefix; + /** Number of items with this mode set on them + */ + unsigned int count; + public: /** * The constructor for ModeHandler initalizes the mode handler. @@ -141,6 +147,11 @@ 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(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0); /** @@ -152,13 +163,23 @@ class ModeHandler : public Extensible */ bool IsListMode(); /** - * Mode prefix or 0 + * 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 number of items with this mode set on them + */ + virtual unsigned int GetCount(); + /** Adjust usage count returned by GetCount + */ + virtual void ChangeCount(int modifier); /** * Get the 'value' of this modes prefix. * determines which to display when there are multiple. - * The mode with the highest value is ranked first. + * The mode with the highest value is ranked first. See the + * PrefixModeValue enum and chanrec::GetPrefixValue() for + * more information. */ virtual unsigned int GetPrefixRank(); /** @@ -230,6 +251,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); }; /** @@ -310,47 +351,44 @@ class ModeParser : public classbase { private: InspIRCd* ServerInstance; - /** - * Mode handlers for each mode, to access a handler subtract + /** 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); + /** 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; + public: - /** - * The constructor initializes all the RFC basic modes by using ModeParserAddMode(). + /** The constructor initializes all the RFC basic modes by using ModeParserAddMode(). */ 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'. */ 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 + /** Grant 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 + /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel */ const char* Revoke(userrec *d,chanrec *chan,int MASK); - /** - * Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. + /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. * * nick -> nick!*@* @@ -364,15 +402,28 @@ 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 + /** 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(); + /** 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. @@ -380,8 +431,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. @@ -389,8 +439,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 @@ -401,38 +450,55 @@ 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(); - bool InsertMode(std::string &output, const char* mode, unsigned short section); -}; - -/** - * Command handler class for the MODE command. - * put here for completeness. - */ -class cmd_mode : public command_t -{ - public: - /** - * Standard constructor + /** Generates the CHANMODES= 005 sequence */ - cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = " {}"; } - /** - * Handle MODE + std::string ChanModes(); + /** Used by this class internally during std::sort and 005 generation */ - void Handle(const char** parameters, int pcnt, userrec *user); + 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); }; #endif