* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
#ifndef __MODE_H
#define __MODE_H
-/* include the common header files */
-#include <string>
-#include <deque>
-#include <vector>
-#include "users.h"
-#include "channels.h"
-#include "ctables.h"
+/* Forward declarations. */
+class User;
-class InspIRCd;
+#include "ctables.h"
+#include "channels.h"
/**
* Holds the values for different type of modes
OP_VALUE = 30000
};
+enum ParamSpec
+{
+ /** No parameters */
+ PARAM_NONE,
+ /** Parameter required on mode setting only */
+ PARAM_SETONLY,
+ /** Parameter always required */
+ PARAM_ALWAYS
+};
+
/**
* 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,
* mode is expected to have a parameter, then this is
* equivalent to returning MODEACTION_DENY.
*/
-class CoreExport ModeHandler : public Extensible
+class CoreExport ModeHandler : public classbase
{
protected:
/**
- * Creator/owner pointer
+ * The mode parameter translation type
*/
- InspIRCd* ServerInstance;
+ TranslateType m_paramtype;
+
+ /** What kind of parameters does the mode take?
+ */
+ ParamSpec parameters_taken;
+
/**
* The mode letter you're implementing.
*/
- char mode;
- /**
- * Number of parameters when being set
+ const char mode;
+
+ /** 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;
- /**
- * 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
+ */
+ int levelrequired;
+
public:
+ /** Module that created this mode. NULL for core modes */
+ Module* const creator;
+ /** Long-form name
+ */
+ const std::string name;
+
/**
* 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 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)
*/
+ 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();
+ inline char GetPrefix() const { return prefix; }
/** Get number of items with this mode set on them
*/
virtual unsigned int GetCount();
*/
virtual unsigned int GetPrefixRank();
/**
- * Returns the modes type
+ * Returns the mode's type
*/
- ModeType GetModeType();
+ inline ModeType GetModeType() const { return m_type; }
+ /**
+ * Returns the mode's parameter translation type
+ */
+ 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.
*/
char GetModeChar();
+ /** 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.
*/
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
* 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, Channel* 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
* your mode properly from each user.
* @param user The user which the server wants to remove your mode from
*/
- virtual void RemoveMode(User* 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.
* 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(Channel* channel);
+ virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
+
+ 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
+ * 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);
};
/**
* 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 CoreExport ModeWatcher : public Extensible
+class CoreExport ModeWatcher : public classbase
{
protected:
- /**
- * Creator/owner pointer
- */
- InspIRCd* ServerInstance;
/**
* The mode letter this class is watching
*/
ModeType m_type;
public:
+ Module* const 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.
*/
class CoreExport ModeParser : public classbase
{
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
* Used by ModeParser::Process.
*/
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);
/** 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<std::string> LastParseParams;
+ std::vector<TranslateType> LastParseTranslate;
+
+ unsigned int sent[256];
+
+ 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
- */
- const char* Revoke(User *d,Channel *chan,int MASK);
/** 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
*
* 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();
+ const std::vector<std::string>& GetLastParseParams() { return LastParseParams; }
+ const std::vector<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
/** Add a mode to the mode parser.
* @return True if the mode was successfully added.
*/
* @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
/** 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' 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, User *user, bool servermode);
+ 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
*/
std::string ParaModeList();
- /** Generates the CHANMODES= 005 sequence
- */
- std::string ChanModes();
- /** Used by this class internally during std::sort and 005 generation
+ /** 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
*/
- static bool PrefixComparison(prefixtype one, prefixtype two);
+ std::string GiveModeList(ModeMasks m);
+
+ static bool PrefixComparison(ModeHandler* one, ModeHandler* two);
/** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
*/
* 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(User* user, Channel* channel);
+ std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff