X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=2875d853ea72af62c272c7602962b407e8b1d064;hb=38ca8be9a3881a3cb3cf6864e67b779ffbab6874;hp=22109d0acdd0700c5e9aa210cef278e601f41a16;hpb=932f1a6bc5dfec0a3b02c364fdf20d984af1c3a4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 22109d0ac..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" @@ -138,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. @@ -170,6 +168,12 @@ class ModeHandler : public Extensible * 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. @@ -247,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); }; /** @@ -343,6 +367,11 @@ class ModeParser : public classbase */ 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(). @@ -373,12 +402,27 @@ class ModeParser : public classbase * 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(); /** 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); + /** 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 @@ -435,29 +479,26 @@ class ModeParser : public classbase */ std::string ParaModeList(); - static bool ModeParser::PrefixComparison(const prefixtype one, const prefixtype two); + /** 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(); - /** Used to parse the CHANMODES= parameter of a 005 numeric. - */ - 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 - */ - cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = " {}"; } - /** Handle MODE + /** 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. */ - void Handle(const char** parameters, int pcnt, userrec *user); + std::string ModeString(userrec* user, chanrec* channel); }; #endif