X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=d00ec30211ab11bb1026a0a639bf4647350ff260;hb=99a1ea0892b575c6d66d9f4c0aab5042c261ce4a;hp=6d91de1a89b0ea329bba1bb64beb0702f396be3a;hpb=f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 6d91de1a8..d00ec3021 100644 --- a/include/mode.h +++ b/include/mode.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * InspIRCd: (C) 2002-2008 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see @@ -14,15 +14,10 @@ #ifndef __MODE_H #define __MODE_H -/* include the common header files */ -#include -#include -#include -#include "users.h" -#include "channels.h" -#include "ctables.h" +/* Forward declarations. */ +class User; -class InspIRCd; +#include "channels.h" /** * Holds the values for different type of modes @@ -58,7 +53,7 @@ enum ModeMasks /** * 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 + * For example, if your module queries a Channel, 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. @@ -144,6 +139,11 @@ class CoreExport ModeHandler : public Extensible */ unsigned int count; + /** The prefix char needed on channel to use this mode, + * only checked for channel modes + */ + char prefixneeded; + public: /** * The constructor for ModeHandler initalizes the mode handler. @@ -161,7 +161,7 @@ class CoreExport ModeHandler : public Extensible * 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); + 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 */ @@ -186,7 +186,7 @@ class CoreExport ModeHandler : public Extensible * 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 + * PrefixModeValue enum and Channel::GetPrefixValue() for * more information. */ virtual unsigned int GetPrefixRank(); @@ -223,14 +223,22 @@ 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(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */ + 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 */ /** * 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. * @param user The user issuing the command - * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc) + * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc) + */ + virtual void DisplayList(User* user, Channel* channel); + + /** + * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric) + * @param user The user issuing the command + * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc) */ - virtual void DisplayList(userrec* user, chanrec* channel); + virtual void DisplayEmptyList(User* user, Channel* channel); + /** * If your mode needs special action during a server sync to determine which side wins when comparing timestamps, * override this function and use it to return true or false. The default implementation just returns true if @@ -243,7 +251,7 @@ class CoreExport ModeHandler : public Extensible * @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, chanrec* channel); + virtual bool CheckTimeStamp(time_t theirs, time_t ours, const 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 @@ -258,7 +266,7 @@ class CoreExport ModeHandler : public Extensible * the current setting for this mode set locally, when the bool is true, or, the parameter given. * 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); + virtual ModePair ModeSet(User* source, User* dest, Channel* 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. @@ -268,7 +276,7 @@ class CoreExport ModeHandler : public Extensible * your mode properly from each user. * @param user The user which the server wants to remove your mode from */ - virtual void RemoveMode(userrec* user); + virtual void RemoveMode(User* user, irc::modestacker* stack = NULL); /** * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server. @@ -278,7 +286,37 @@ class CoreExport ModeHandler : public Extensible * 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); + virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL); + + char GetNeededPrefix(); + + void SetNeededPrefix(char needsprefix); +}; + +/** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra + * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it + * is already set and not allowing it to be unset if it is already unset. + * An example of a simple user mode is user mode +w. + */ +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); +}; + +/** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra + * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it + * is already set and not allowing it to be unset if it is already unset. + * An example of a simple channel mode is channel mode +s. + */ +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); }; /** @@ -337,7 +375,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(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding, ModeType type); + virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type, bool servermode = false); /** * After the mode character has been processed by the ModeHandler, this method will be called. * @param source The sender of the mode @@ -348,7 +386,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(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter, bool adding, ModeType type); + virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type, bool servermode = false); }; typedef std::vector::iterator ModeWatchIter; @@ -379,13 +417,17 @@ class CoreExport ModeParser : public classbase /** Displays the current modes of a channel or user. * Used by ModeParser::Process. */ - void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text); + void DisplayCurrentModes(User *user, User* targetuser, Channel* 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; + unsigned int sent[256]; + + unsigned int seq; + public: /** The constructor initializes all the RFC basic modes by using ModeParserAddMode(). @@ -395,13 +437,13 @@ class CoreExport ModeParser : public classbase /** 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); + 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(userrec *d,chanrec *chan,int MASK); + 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(userrec *d,chanrec *chan,int MASK); + const char* Revoke(User *d,Channel *chan,int MASK); /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out. * E.g. * @@ -422,12 +464,10 @@ class CoreExport ModeParser : public classbase * @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(). + /** Add a mode to the mode parser. * @return True if the mode was successfully added. */ - bool AddMode(ModeHandler* mh, unsigned const char modeletter); + bool AddMode(ModeHandler* mh); /** 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 @@ -456,13 +496,12 @@ class CoreExport ModeParser : public classbase /** 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 * @param user The user setting or removing the modes. When the modes are set - * by a server, an 'uninitialized' userrec is used, where *user::nick == NULL + * 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 char** parameters, int pcnt, userrec *user, bool servermode); + void Process(const std::vector& parameters, User *user, bool servermode); /** Find the mode handler for a given mode and type. * @param modeletter mode letter to search for @@ -510,9 +549,11 @@ class CoreExport ModeParser : public classbase * similar purposes. * @param user The username to look up * @param channel The channel name to look up the privilages of the user for + * @param nick_suffix true (the default) if you want nicknames in the mode string, for easy + * use with the mode stacker, false if you just want the "avh" part of "avh nick nick nick". * @return The mode string. */ - std::string ModeString(userrec* user, chanrec* channel); + std::string ModeString(User* user, Channel* channel, bool nick_suffix = true); }; #endif