X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmode.h;h=9a5091e76a59f7bdbadc7f771e6652a10601e607;hb=3b38de5b6e2b968de03940e11d92cb3571c886e5;hp=2875d853ea72af62c272c7602962b407e8b1d064;hpb=2802a62272f4295ecc3bd73a44950749e8b96877;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/mode.h b/include/mode.h index 2875d853e..9a5091e76 100644 --- a/include/mode.h +++ b/include/mode.h @@ -1,28 +1,28 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2004-2006, 2008 Craig Edwards + * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2007 Dennis Friis * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __MODE_H -#define __MODE_H -/* include the common header files */ -#include -#include -#include -#include "users.h" -#include "channels.h" -#include "ctables.h" +#pragma once -class InspIRCd; +#include "ctables.h" /** * Holds the values for different type of modes @@ -30,7 +30,9 @@ class InspIRCd; */ enum ModeType { + /** User mode */ MODETYPE_USER = 0, + /** Channel mode */ MODETYPE_CHANNEL = 1 }; @@ -56,7 +58,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. @@ -64,17 +66,26 @@ enum ModeMasks */ enum PrefixModeValue { + /* +v */ VOICE_VALUE = 10000, + /* +h */ HALFOP_VALUE = 20000, + /* +o */ 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, - * and the parameter of the mode (or the parameter provided) in the std::string. - */ -typedef std::pair ModePair; +enum ParamSpec +{ + /** No parameters */ + PARAM_NONE, + /** Parameter required on mode setting only */ + PARAM_SETONLY, + /** Parameter always required */ + PARAM_ALWAYS +}; + +class PrefixMode; +class ListModeBase; /** Each mode is implemented by ONE ModeHandler class. * You must derive ModeHandler and add the child class to @@ -90,22 +101,37 @@ typedef std::pair ModePair; * mode is expected to have a parameter, then this is * equivalent to returning MODEACTION_DENY. */ -class ModeHandler : public Extensible +class CoreExport ModeHandler : public ServiceProvider { + public: + enum Class + { + MC_PREFIX, + MC_LIST, + MC_OTHER + }; + protected: - InspIRCd* ServerInstance; /** - * The mode letter you're implementing. + * The mode parameter translation type */ - char mode; + TranslateType m_paramtype; + + /** What kind of parameters does the mode take? + */ + ParamSpec parameters_taken; + /** - * Number of parameters when being set + * The mode letter you're implementing. */ - int n_params_on; + char mode; + /** - * 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 @@ -117,79 +143,66 @@ class 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 + /** The object type of this mode handler */ - char prefix; + const Class type_id; - /** Number of items with this mode set on them + /** The prefix char needed on channel to use this mode, + * only checked for channel modes */ - unsigned int count; + int levelrequired; public: /** * 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 me The module which created this mode + * @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); - /** - * The default destructor does nothing + * @param params Parameters taken by the mode + * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL) + * @param mclass The object type of this mode handler, one of ModeHandler::Class */ + ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type, Class mclass = MC_OTHER); + virtual CullResult cull(); virtual ~ModeHandler(); /** * Returns true if the mode is a list mode */ - bool IsListMode(); + bool IsListMode() const { return list; } + /** - * 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 + * Check whether this mode is a prefix mode + * @return non-NULL if this mode is a prefix mode, NULL otherwise */ - virtual unsigned int GetCount(); - /** Adjust usage count returned by GetCount + PrefixMode* IsPrefixMode(); + + /** + * Check whether this mode handler inherits from ListModeBase + * @return non-NULL if this mode handler inherits from ListModeBase, NULL otherwise */ - virtual void ChangeCount(int modifier); + ListModeBase* IsListModeBase(); + /** - * 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. + * Returns the mode's type */ - virtual unsigned int GetPrefixRank(); + inline ModeType GetModeType() const { return m_type; } /** - * Returns the modes type + * Returns the mode's parameter translation type */ - ModeType GetModeType(); + 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. @@ -201,7 +214,21 @@ class ModeHandler : public Extensible * Returns the mode character this handler handles. * @return The mode character */ - char GetModeChar(); + inline char GetModeChar() { return mode; } + + /** For user modes, return the current parameter, if any + */ + 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. @@ -215,62 +242,175 @@ class 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); /* 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 + * 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); + + /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called. + * This allows you to give special information to the user, or handle this any way you like. + * @param user The user issuing the mode change + * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL. + * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL. + */ + virtual void OnParameterMissing(User* user, User* dest, 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 * 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, chanrec* 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 - * in the mode string to determine if the mode is set or not. - * @param source of the mode change, this will be NULL for a server mode - * @param dest Target user of the mode change, if this is a user mode - * @param channel Target channel of the mode change, if this is a channel mode - * @param parameter The parameter given for the mode change, or an empty string - * @returns The first value of the pair should be true if the mode is set with the given parameter. - * In the case of permissions modes such as channelmode +o, this should return true if the user given - * as the parameter has the given privilage on the given channel. The string value of the pair will hold - * 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); - - /** - * 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. + * When a MODETYPE_USER mode handler is being removed, the core will call this method for every user on the server. + * The usermode will be removed using the appropiate server mode using InspIRCd::SendMode(). * @param user The user which the server wants to remove your mode from */ - virtual void RemoveMode(userrec* user); + void RemoveMode(User* 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. + * The mode handler has to populate the given modestacker with mode changes that remove the mode from the channel. + * The default implementation of this method can remove all kinds of channel modes except listmodes. + * In the case of listmodes, the entire list of items must be added to the modestacker (which is handled by ListModeBase, + * so if you inherit from it or your mode can be removed by the default implementation then you do not have to implement + * this function). * @param channel The channel which the server wants to remove your mode from + * @param stack The mode stack to add the mode change to */ - virtual void RemoveMode(chanrec* channel); + virtual void RemoveMode(Channel* channel, irc::modestacker& stack); + + inline unsigned int GetLevelRequired() const { return levelrequired; } +}; + +/** + * Prefix modes are channel modes that grant a specific rank to members having prefix mode set. + * They require a parameter when setting and unsetting; the parameter is always a member of the channel. + * A prefix mode may be set on any number of members on a channel, but for a given member a given prefix + * mode is either set or not set, in other words members cannot have the same prefix mode set more than once. + * + * A rank of a member is defined as the rank given by the 'strongest' prefix mode that member has. + * Other parts of the IRCd use this rank to determine whether a channel action is allowable for a user or not. + * The rank of a prefix mode is constant, i.e. the same rank value is given to all users having that prefix mode set. + * + * Note that it is possible that the same action requires a different rank on a different channel; + * for example changing the topic on a channel having +t set requires a rank that is >= than the rank of a halfop, + * but there is no such restriction when +t isn't set. + */ +class CoreExport PrefixMode : public ModeHandler +{ + protected: + /** The prefix character granted by this mode. '@' for op, '+' for voice, etc. + * If 0, this mode does not have a visible prefix character. + */ + char prefix; + + /** The prefix rank of this mode, used to compare prefix + * modes + */ + unsigned int prefixrank; + + public: + /** + * Constructor + * @param Creator The module creating this mode + * @param Name The user-friendly one word name of the prefix mode, e.g.: "op", "voice" + * @param ModeLetter The mode letter of this mode + */ + PrefixMode(Module* Creator, const std::string& Name, char ModeLetter); + + /** + * Handles setting and unsetting the prefix mode. + * Finds the given member of the given channel, if it's not found an error message is sent to 'source' + * and MODEACTION_DENY is returned. Otherwise the mode change is attempted. + * @param source Source of the mode change, an error message is sent to this user if the target is not found + * @param dest Unused + * @param channel The channel the mode change is happening on + * @param param The nickname or uuid of the target user + * @param adding True when the mode is being set, false when it is being unset + * @return MODEACTION_ALLOW if the change happened, MODEACTION_DENY if no change happened + * The latter occurs either when the member cannot be found or when the member already has this prefix set + * (when setting) or doesn't have this prefix set (when unsetting). + */ + ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& param, bool adding); + + /** + * Removes this prefix mode from all users on the given channel + * @param chan The channel which the server wants to remove your mode from + * @param stack The mode stack to add the mode change to + */ + void RemoveMode(Channel* chan, irc::modestacker& stack); + + /** + * Mode prefix or 0. If this is defined, you should + * also implement GetPrefixRank() to return an integer + * value for this mode prefix. + */ + char GetPrefix() const { return prefix; } + + /** + * 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 Channel::GetPrefixValue() for + * more information. + */ + unsigned int GetPrefixRank() const { return prefixrank; } +}; + +/** 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(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 + * 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(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); +}; + +class CoreExport ParamChannelModeHandler : public ModeHandler +{ + public: + ParamChannelModeHandler(Module* Creator, const std::string& Name, char modeletter) + : ModeHandler(Creator, Name, modeletter, PARAM_SETONLY, MODETYPE_CHANNEL) {} + virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); + /** Validate the parameter - you may change the value to normalize it. Return true if it is valid. */ + virtual bool ParamValidate(std::string& parameter); }; /** @@ -279,34 +419,36 @@ class ModeHandler : public Extensible * 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 ModeWatcher : public Extensible +class CoreExport ModeWatcher : public classbase { - protected: - InspIRCd* ServerInstance; + private: /** - * The mode letter this class is watching + * The mode name this class is watching */ - char mode; + const std::string mode; + /** - * The mode type being watched (user or channel) + * The mode type being watched (user or channel) */ ModeType m_type; public: + ModuleRef creator; /** * The constructor initializes the mode and the mode type */ - ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type); + ModeWatcher(Module* creator, const std::string& modename, ModeType type); /** * The default destructor does nothing. */ virtual ~ModeWatcher(); /** - * Get the mode character being watched - * @return The mode character being watched + * Get the mode name being watched + * @return The mode name being watched */ - char GetModeChar(); + const std::string& GetModeName() const { return mode; } + /** * Get the mode type being watched * @return The mode type being watched (user or channel) @@ -322,11 +464,10 @@ class ModeWatcher : public Extensible * If you alter the parameter you are given, the mode handler will see your atered version * when it handles the mode. * @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 * @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& parameter, bool adding); /** * After the mode character has been processed by the ModeHandler, this method will be called. * @param source The sender of the mode @@ -335,85 +476,147 @@ class ModeWatcher : public Extensible * @param parameter The parameter of the mode, if the mode is supposed to have a parameter. * You cannot alter the parameter here, as the mode handler has already processed it. * @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& parameter, bool adding); }; -typedef std::vector::iterator ModeWatchIter; +typedef std::multimap::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 +class CoreExport ModeParser { private: - 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 handlers, except for instead of having 256 of them - * we have 256 lists of them. + + /** Lists of mode handlers by type + */ + struct + { + /** List of mode handlers that inherit from ListModeBase + */ + std::vector list; + + /** List of mode handlers that inherit from PrefixMode + */ + std::vector prefix; + } mhlist; + + /** Mode watcher classes */ - std::vector modewatchers[256]; + std::multimap modewatchermap; + /** 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); + /** 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); + + /** Returns a list of user or channel mode characters. + * Used for constructing the parts of the mode list in the 004 numeric. + * @param mt Controls whether to list user modes or channel modes + * @param needparam Return modes only if they require a parameter to be set + * @return The available mode letters that satisfy the given conditions + */ + std::string CreateModeList(ModeType mt, bool needparam = false); + + /** Recreate the cached mode list that is displayed in the 004 numeric + * in Cached004ModeList. + * Called when a mode handler is added or removed. + */ + void RecreateModeListFor004Numeric(); /** 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; - public: + unsigned int sent[256]; - /** The constructor initializes all the RFC basic modes by using ModeParserAddMode(). - */ - ModeParser(InspIRCd* Instance); + unsigned int seq; - /** 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 - */ - 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 + /** Cached mode list for use in 004 numeric */ - const char* Revoke(userrec *d,chanrec *chan,int MASK); + std::string Cached004ModeList; + + public: + typedef std::vector ListModeList; + typedef std::vector PrefixModeList; + + typedef unsigned int ModeProcessFlag; + enum ModeProcessFlags + { + /** If only this flag is specified, the mode change will be global + * and parameter modes will have their parameters explicitly set + * (not merged). This is the default. + */ + MODE_NONE = 0, + + /** If this flag is set then the parameters of non-listmodes will be + * merged according to their conflict resolution rules. + * Does not affect user modes, channel modes without a parameter and + * listmodes. + */ + MODE_MERGE = 1, + + /** If this flag is set then the mode change won't be handed over to + * the linking module to be sent to other servers, but will be processed + * locally and sent to local user(s) as usual. + */ + MODE_LOCALONLY = 2 + }; + + ModeParser(); + ~ModeParser(); + + /** Initialize all built-in modes + */ + static void InitBuiltinModes(); + /** 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 + * + * 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(); - /** 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(). + const std::string& GetLastParse() const { return LastParse; } + 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. */ - 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 @@ -423,14 +626,15 @@ class 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 * information. * @param mw The ModeWatcher you want to add - * @return True if the ModeWatcher was added correctly */ - bool AddModeWatcher(ModeWatcher* mw); + void AddModeWatcher(ModeWatcher* mw); + /** 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 @@ -442,63 +646,75 @@ class 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 - * and *user->server == NULL. - * @param servermode True if a server is setting the mode. + * @param user The source of the mode change, can be a server user. + * @param flags Optional flags controlling how the mode change is processed, + * defaults to MODE_NONE. */ - void Process(const char** parameters, int pcnt, userrec *user, bool servermode); + void Process(const std::vector& parameters, User* user, ModeProcessFlag flags = MODE_NONE); /** 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 + * @param mt 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 the mode handler for the given prefix mode + * @param modeletter The mode letter to search for + * @return A pointer to the PrefixMode or NULL if the mode wasn't found or it isn't a prefix mode + */ + PrefixMode* FindPrefixMode(unsigned char modeletter); + /** 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); + PrefixMode* FindPrefix(unsigned const char pfxletter); - /** Returns a list of mode characters which are usermodes. - * This is used in the 004 numeric when users connect. + /** Returns a list of modes, space seperated by type: + * 1. User modes + * 2. Channel modes + * 3. Channel modes that require a parameter when set + * This is sent to users as the last part of the 004 numeric */ - std::string UserModeList(); + const std::string& GetModeListFor004Numeric(); - /** Returns a list of channel mode characters which are listmodes. - * This is used in the 004 numeric when users connect. + /** Generates a list of modes, comma seperated by type: + * 1; Listmodes EXCEPT those with a prefix + * 2; Modes that take a param when adding or removing + * 3; Modes that only take a param when adding + * 4; Modes that dont take a param */ - std::string ChannelModeList(); + std::string GiveModeList(ModeMasks m); - /** Returns a list of channel mode characters which take parameters. - * This is used in the 004 numeric when users connect. + /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or + * just the "@%+" part if the parameter false */ - std::string ParaModeList(); + std::string BuildPrefixes(bool lettersAndModes = true); - /** Generates the CHANMODES= 005 sequence - */ - std::string ChanModes(); - /** Used by this class internally during std::sort and 005 generation + /** Get a list of all mode handlers that inherit from ListModeBase + * @return A list containing ListModeBase modes */ - static bool PrefixComparison(const prefixtype one, const prefixtype two); + const ListModeList& GetListModes() const { return mhlist.list; } - /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric. + /** Get a list of all prefix modes + * @return A list containing all prefix modes */ - 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); + const PrefixModeList& GetPrefixModes() const { return mhlist.prefix; } }; -#endif +inline const std::string& ModeParser::GetModeListFor004Numeric() +{ + return Cached004ModeList; +} + +inline PrefixMode* ModeHandler::IsPrefixMode() +{ + return (this->type_id == MC_PREFIX ? static_cast(this) : NULL); +} + +inline ListModeBase* ModeHandler::IsListModeBase() +{ + return (this->type_id == MC_LIST ? reinterpret_cast(this) : NULL); +}