-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
*
- * 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 <http://www.gnu.org/licenses/>.
*/
-#ifndef __MODE_H
-#define __MODE_H
-/* Forward declarations. */
-class User;
+#pragma once
#include "ctables.h"
-#include "channels.h"
/**
* Holds the values for different type of modes
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<bool,std::string> ModePair;
+enum ParamSpec
+{
+ /** No parameters */
+ PARAM_NONE,
+ /** Parameter required on mode setting only */
+ PARAM_SETONLY,
+ /** Parameter always required */
+ PARAM_ALWAYS
+};
/** Each mode is implemented by ONE ModeHandler class.
* You must derive ModeHandler and add the child class to
* mode is expected to have a parameter, then this is
* equivalent to returning MODEACTION_DENY.
*/
-class CoreExport ModeHandler : public classbase
+class CoreExport ModeHandler : public ServiceProvider
{
protected:
/**
- * Creator/owner pointer
+ * The mode parameter translation type
+ */
+ TranslateType m_paramtype;
+
+ /** What kind of parameters does the mode take?
*/
- InspIRCd* ServerInstance;
+ ParamSpec parameters_taken;
+
/**
* The mode letter you're implementing.
*/
char mode;
- /**
- * Number of parameters when being set
+
+ /** Mode prefix, or 0
*/
- int n_params_on;
+ char prefix;
+
/**
- * 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
* (e.g. banlists, etc)
*/
bool list;
+
/**
* The mode type, either MODETYPE_USER or
* MODETYPE_CHANNEL.
*/
ModeType m_type;
- /**
- * The mode parameter translation type
- */
- TranslateType m_paramtype;
- /**
- * True if the mode requires oper status
- * to set.
- */
- bool oper;
-
- /** Mode prefix, or 0
- */
- char prefix;
-
- /** Number of items with this mode set on them
- */
- unsigned int count;
/** The prefix char needed on channel to use this mode,
* only checked for channel modes
*/
- char prefixneeded;
+ int levelrequired;
public:
- /** Module that created this mode. NULL for core modes */
- Module* creator;
-
/**
* 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.
- * @param prefixrequired The prefix required to change this mode
- * @param translate The translation type for the argument(s) of this mode
- */
- ModeHandler(InspIRCd* Instance, Module* me, char modeletter, int parameters_on, int parameters_off,
- bool listmode, ModeType type, bool operonly, char mprefix = 0,
- char prefixrequired = '%', TranslateType translate = TR_TEXT);
- /**
- * The default destructor does nothing
+ * @param params Parameters taken by the mode
+ * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL)
*/
+ ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type);
+ virtual CullResult cull();
virtual ~ModeHandler();
/**
* Returns true if the mode is a list mode
* 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);
+ inline char GetPrefix() const { return prefix; }
/**
* Get the 'value' of this modes prefix.
* determines which to display when there are multiple.
/**
* Returns the mode's type
*/
- ModeType GetModeType();
+ inline ModeType GetModeType() const { return m_type; }
/**
* Returns the mode's parameter translation type
*/
- TranslateType GetTranslateType();
+ 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.
* 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.
* @param source Contains the user setting the mode.
* @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(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool servermode = false); /* 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
* @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
* @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(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(User* source, User* dest, Channel* channel, const std::string ¶meter);
+ virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
/**
* When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
* 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
+ * @param stack The mode stack to add the mode change to
*/
virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
* 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
+ * @param stack The mode stack to add the mode change to
*/
virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
- char GetNeededPrefix();
-
- void SetNeededPrefix(char needsprefix);
+ inline unsigned int GetLevelRequired() const { return levelrequired; }
};
/** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
class CoreExport SimpleUserModeHandler : public ModeHandler
{
public:
- SimpleUserModeHandler(InspIRCd* Instance, Module* Creator, char modeletter)
- : ModeHandler(Instance, Creator, modeletter, 0, 0, false, MODETYPE_USER, false) {}
+ 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, bool servermode = false);
+ 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
class CoreExport SimpleChannelModeHandler : public ModeHandler
{
public:
- SimpleChannelModeHandler(InspIRCd* Instance, Module* Creator, char modeletter)
- : ModeHandler(Instance, Creator, modeletter, 0, 0, false, MODETYPE_CHANNEL, false) {}
+ 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, bool servermode = false);
+ 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);
};
/**
class CoreExport ModeWatcher : public classbase
{
protected:
- /**
- * Creator/owner pointer
- */
- InspIRCd* ServerInstance;
/**
* The mode letter this class is watching
*/
char 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, char modeletter, ModeType type);
/**
* The default destructor does nothing.
*/
* 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
+ * @param 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(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type, bool servermode = false);
+ virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type);
/**
* After the mode character has been processed by the ModeHandler, this method will be called.
* @param source The sender of the mode
* @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
+ * @param type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
*/
- virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type, bool servermode = false);
+ virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type);
};
typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
* parses client to server MODE strings for user and channel modes, and performs
* processing for the 004 mode list numeric, amongst other things.
*/
-class CoreExport ModeParser : public classbase
+class CoreExport ModeParser
{
private:
- /**
- * Creator/owner pointer
- */
- 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
/**
* 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 servermode, bool SkipACL);
+ ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string ¶m, bool SkipACL);
/** The string representing the last set of modes to be parsed.
* Use GetLastParse() to get this value, to be used for display purposes.
unsigned int seq;
public:
-
- /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
- */
- ModeParser(InspIRCd* Instance);
+ ModeParser();
~ModeParser();
/** 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'.
*/
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(User *d,Channel *chan,int MASK);
- /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
+
+ /** Initialize all built-in modes
*/
- const char* Revoke(User *d,Channel *chan,int MASK);
+ static void InitBuiltinModes();
+
/** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
* E.g.
*
*
* nick!ident -> nick!ident@*
*
- * host.name -> *!*@host.name
+ * host.name -> *!*\@host.name
*
- * ident@host.name -> *!ident@host.name
+ * ident@host.name -> *!ident\@host.name
*
* This method can be used on both IPV4 and IPV6 user masks.
*/
* @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
* @param parameters The parameters of the mode change, in the format
* they would be from a MODE command.
* @param user The user setting or removing the modes. When the modes are set
- * by a server, an 'uninitialized' User 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.
+ * @param merge Should the mode parameters be merged?
*/
- void Process(const std::vector<std::string>& parameters, User *user, bool servermode, bool merge = false);
+ void Process(const std::vector<std::string>& parameters, User *user, bool merge = false);
/** 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);
*/
std::string GiveModeList(ModeMasks m);
- /** Used by this class internally during std::sort and 005 generation
- */
- static bool PrefixComparison(prefixtype one, prefixtype two);
-
- /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
- */
- std::string BuildPrefixes();
+ static bool PrefixComparison(ModeHandler* one, ModeHandler* two);
- /** 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
- * @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.
+ /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or
+ * just the "@%+" part if the parameter false
*/
- std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
+ std::string BuildPrefixes(bool lettersAndModes = true);
};
-
-#endif