* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2008 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.
*
#ifndef __MODE_H
#define __MODE_H
-/* include the common header files */
-#include <typeinfo>
-#include <iostream>
-#include <string>
-#include <deque>
-#include <sstream>
-#include <vector>
-#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
*/
enum ModeType
{
+ /** User mode */
MODETYPE_USER = 0,
+ /** Channel mode */
MODETYPE_CHANNEL = 1
};
/**
* 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.
*/
enum PrefixModeValue
{
+ /* +v */
VOICE_VALUE = 10000,
+ /* +h */
HALFOP_VALUE = 20000,
+ /* +o */
OP_VALUE = 30000
};
* mode is expected to have a parameter, then this is
* equivalent to returning MODEACTION_DENY.
*/
-class ModeHandler : public Extensible
+class CoreExport ModeHandler : public Extensible
{
protected:
+ /**
+ * Creator/owner pointer
+ */
InspIRCd* ServerInstance;
/**
* The mode letter you're implementing.
*/
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;
+
public:
/**
* The constructor for ModeHandler initalizes the mode handler.
* 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
*/
* 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.
* 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();
* @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(userrec* user, chanrec* channel);
+ 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 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
* @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
* 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.
+ * 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(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 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(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);
};
/**
* 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 Extensible
{
protected:
+ /**
+ * Creator/owner pointer
+ */
InspIRCd* ServerInstance;
/**
* The mode letter this class is watching
* @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
* @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<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 ModeParser : public classbase
+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.
/** 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:
/** 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.
*
* This method can be used on both IPV4 and IPV6 user masks.
*/
static void CleanMask(std::string &mask);
- /** 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().
+ /** 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.
* @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
+ * (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
/** 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<std::string>& parameters, User *user, bool servermode);
/** Find the mode handler for a given mode and type.
* @param modeletter mode letter to search for
std::string ChanModes();
/** Used by this class internally during std::sort and 005 generation
*/
- static bool ModeParser::PrefixComparison(const prefixtype one, const prefixtype two);
+ static bool PrefixComparison(prefixtype one, prefixtype two);
/** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
*/
std::string BuildPrefixes();
-};
-/** 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 = "<target> <modes> {<mode-parameters>}"; }
- /** Handle MODE
- */
- void Handle(const char** parameters, int pcnt, userrec *user);
+ /** 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.
+ */
+ std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
};
#endif
+