-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __CHANNELS_H__\r#define __CHANNELS_H__\r\r#include "inspircd_config.h"\r#include "base.h"\r#include <time.h>\r#include <vector>\r#include <string>\r#include <map>\r\r/** RFC1459 channel modes\r */\renum ChannelModes {\r CM_TOPICLOCK = 't'-65, /* +t: Only operators can change topic */\r CM_NOEXTERNAL = 'n'-65, /* +n: Only users in the channel can message it */\r CM_INVITEONLY = 'i'-65, /* +i: Invite only */\r CM_MODERATED = 'm'-65, /* +m: Only voices and above can talk */\r CM_SECRET = 's'-65, /* +s: Secret channel */\r CM_PRIVATE = 'p'-65, /* +p: Private channel */\r CM_KEY = 'k'-65, /* +k: Keyed channel */\r CM_LIMIT = 'l'-65 /* +l: Maximum user limit */\r};\r\r/* Forward declarations - needed */\rclass userrec;\rclass chanrec;\r\r/** Holds an entry for a ban list, exemption list, or invite list.\r * This class contains a single element in a channel list, such as a banlist.\r */\rclass HostItem : public classbase\r{\r public:\r /** Time the item was added\r */\r time_t set_time;\r /** Who added the item\r */\r char set_by[NICKMAX];\r /** The actual item data\r */\r char data[MAXBUF];\r\r HostItem() { /* stub */ }\r virtual ~HostItem() { /* stub */ }\r};\r\r/** A subclass of HostItem designed to hold channel bans (+b)\r */\rclass BanItem : public HostItem\r{\r};\r\r/** Holds a complete ban list\r */\rtypedef std::vector<BanItem> BanList;\r\r/** A list of users on a channel\r */\rtypedef std::map<userrec*,std::string> CUList;\r\r/** Shorthand for CUList::iterator\r */\rtypedef CUList::iterator CUListIter;\r\r/** Shorthand for CUList::const_iterator\r */\rtypedef CUList::const_iterator CUListConstIter;\r\r/** A list of custom modes parameters on a channel\r */\rtypedef std::map<char,char*> CustomModeList;\r\r\r/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o\r */\renum UserChannelModes {\r UCMODE_OP = 1, /* Opped user */\r UCMODE_VOICE = 2, /* Voiced user */\r UCMODE_HOP = 4 /* Halfopped user */\r};\r\r/* Forward declaration -- required */\rclass InspIRCd;\r\r/** A stored prefix and its rank\r */\rtypedef std::pair<char, unsigned int> prefixtype;\r\r/** A list of prefixes set on a user in a channel\r */\rtypedef std::vector<prefixtype> pfxcontainer;\r\r/** A list of users with zero or more prefixes set on them\r */\rtypedef std::map<userrec*, std::vector<prefixtype> > prefixlist;\r\r/** Holds all relevent information for a channel.\r * This class represents a channel, and contains its name, modes, time created, topic, topic set time,\r * etc, and an instance of the BanList type.\r */\rclass CoreExport chanrec : public Extensible\r{\r private:\r\r /** Pointer to creator object\r */\r InspIRCd* ServerInstance;\r\r /** Connect a chanrec to a userrec\r */\r static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr, userrec* user, const std::string &privs);\r\r /** Set default modes for the channel on creation\r */\r void SetDefaultModes();\r\r /** A list of prefixes associated with each user in the channel\r * (e.g. &%+ etc)\r */\r prefixlist prefixes;\r\r /** Maximum number of bans (cached)\r */\r int maxbans;\r\r public:\r /** The channel's name.\r */\r char name[CHANMAX];\r\r /** Modes for the channel.\r * This is not a null terminated string! It is a hash where\r * each item in it represents if a mode is set. For example\r * for mode +A, index 0. Use modechar-65 to calculate which\r * field to check.\r */\r char modes[64];\r\r /** User lists.\r * There are four user lists, one for \r * all the users, one for the ops, one for\r * the halfops and another for the voices.\r */\r CUList internal_userlist;\r\r /** Opped users.\r * There are four user lists, one for \r * all the users, one for the ops, one for\r * the halfops and another for the voices.\r */\r CUList internal_op_userlist;\r\r /** Halfopped users.\r * There are four user lists, one for \r * all the users, one for the ops, one for\r * the halfops and another for the voices.\r */\r CUList internal_halfop_userlist;\r\r /** Voiced users.\r * There are four user lists, one for\r * all the users, one for the ops, one for\r * the halfops and another for the voices.\r */\r CUList internal_voice_userlist;\r\r /** Parameters for custom modes.\r * One for each custom mode letter.\r */\r CustomModeList custom_mode_params;\r\r /** Channel topic.\r * If this is an empty string, no channel topic is set.\r */\r char topic[MAXTOPIC];\r\r /** Creation time.\r * This is a timestamp (TS) value.\r */\r time_t created;\r\r /** Time topic was set.\r * If no topic was ever set, this will be equal to chanrec::created\r */\r time_t topicset;\r\r /** The last user to set the topic.\r * If this member is an empty string, no topic was ever set.\r */\r char setby[128];\r\r /** Contains the channel user limit.\r * If this value is zero, there is no limit in place.\r */\r short int limit;\r \r /** Contains the channel key.\r * If this value is an empty string, there is no channel key in place.\r */\r char key[32];\r\r /** The list of all bans set on the channel.\r */\r BanList bans;\r \r /** Sets or unsets a custom mode in the channels info\r * @param mode The mode character to set or unset\r * @param mode_on True if you want to set the mode or false if you want to remove it\r */\r void SetMode(char mode,bool mode_on);\r\r /** Sets or unsets the parameters for a custom mode in a channels info\r * @param mode The mode character to set or unset\r * @param parameter The parameter string to associate with this mode character\r * @param mode_on True if you want to set the mode or false if you want to remove it\r */\r void SetModeParam(char mode,const char* parameter,bool mode_on);\r \r /** Returns true if a mode is set on a channel\r * @param mode The mode character you wish to query\r * @return True if the custom mode is set, false if otherwise\r */\r bool IsModeSet(char mode);\r\r /** Returns the parameter for a custom mode on a channel.\r * @param mode The mode character you wish to query\r *\r * For example if "+L #foo" is set, and you pass this method\r * 'L', it will return '#foo'. If the mode is not set on the\r * channel, or the mode has no parameters associated with it,\r * it will return an empty string.\r *\r * @return The parameter for this mode is returned, or an empty string\r */\r std::string GetModeParameter(char mode);\r\r /** Obtain the channel "user counter"\r * This returns the channel reference counter, which is initialized\r * to 0 when the channel is created and incremented/decremented\r * upon joins, parts quits and kicks.\r *\r * @return The number of users on this channel\r */\r long GetUserCounter();\r\r /** Add a user pointer to the internal reference list\r * @param user The user to add\r *\r * The data inserted into the reference list is a table as it is\r * an arbitary pointer compared to other users by its memory address,\r * as this is a very fast 32 or 64 bit integer comparison.\r */\r void AddUser(userrec* user);\r\r /** Add a user pointer to the internal reference list of opped users\r * @param user The user to add\r */\r void AddOppedUser(userrec* user);\r\r /** Add a user pointer to the internal reference list of halfopped users\r * @param user The user to add\r */\r void AddHalfoppedUser(userrec* user);\r\r /** Add a user pointer to the internal reference list of voiced users\r * @param user The user to add\r */\r void AddVoicedUser(userrec* user);\r\r /** Delete a user pointer to the internal reference list\r * @param user The user to delete\r * @return number of users left on the channel after deletion of the user\r */\r unsigned long DelUser(userrec* user);\r\r /** Delete a user pointer to the internal reference list of opped users\r * @param user The user to delete\r */\r void DelOppedUser(userrec* user);\r\r /** Delete a user pointer to the internal reference list of halfopped users\r * @param user The user to delete\r */\r void DelHalfoppedUser(userrec* user);\r\r /** Delete a user pointer to the internal reference list of voiced users\r * @param user The user to delete\r */\r void DelVoicedUser(userrec* user);\r\r /** Obtain the internal reference list\r * The internal reference list contains a list of userrec*.\r * These are used for rapid comparison to determine\r * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.\r * The resulting pointer to the vector should be considered\r * readonly and only modified via AddUser and DelUser.\r *\r * @return This function returns pointer to a map of userrec pointers (CUList*).\r */\r CUList* GetUsers();\r\r /** Obtain the internal reference list of opped users\r * @return This function returns pointer to a map of userrec pointers (CUList*).\r */\r CUList* GetOppedUsers();\r\r /** Obtain the internal reference list of halfopped users\r * @return This function returns pointer to a map of userrec pointers (CUList*).\r */\r CUList* GetHalfoppedUsers();\r\r /** Obtain the internal reference list of voiced users\r * @return This function returns pointer to a map of userrec pointers (CUList*).\r */\r CUList* GetVoicedUsers();\r\r /** Returns true if the user given is on the given channel.\r * @param The user to look for\r * @return True if the user is on this channel\r */\r bool HasUser(userrec* user);\r\r /** Creates a channel record and initialises it with default values\r * @throw Nothing at present.\r */\r chanrec(InspIRCd* Instance);\r\r /** Make src kick user from this channel with the given reason.\r * @param src The source of the kick\r * @param user The user being kicked (must be on this channel)\r * @param reason The reason for the kick\r * @return The number of users left on the channel. If this is zero\r * when the method returns, you MUST delete the chanrec immediately!\r */\r long KickUser(userrec *src, userrec *user, const char* reason);\r\r /** Make the server kick user from this channel with the given reason.\r * @param user The user being kicked (must be on this channel)\r * @param reason The reason for the kick\r * @param triggerevents True if you wish this kick to trigger module events\r * @return The number of users left on the channel. If this is zero\r * when the method returns, you MUST delete the chanrec immediately!\r */\r long ServerKickUser(userrec* user, const char* reason, bool triggerevents);\r\r /** Part a user from this channel with the given reason.\r * If the reason field is NULL, no reason will be sent.\r * @param user The user who is parting (must be on this channel)\r * @param reason The (optional) part reason\r * @return The number of users left on the channel. If this is zero\r * when the method returns, you MUST delete the chanrec immediately!\r */\r long PartUser(userrec *user, const char* reason = NULL);\r\r /* Join a user to a channel. May be a channel that doesnt exist yet.\r * @param user The user to join to the channel.\r * @param cn The channel name to join to. Does not have to exist.\r * @param key The key of the channel, if given\r * @param override If true, override all join restrictions such as +bkil\r * @return A pointer to the chanrec the user was joined to. A new chanrec may have\r * been created if the channel did not exist before the user was joined to it.\r * If the user could not be joined to a channel, the return value may be NULL.\r */\r static chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key, time_t TS = 0);\r\r /** Write to a channel, from a user, using va_args for text\r * @param user User whos details to prefix the line with\r * @param text A printf-style format string which builds the output line without prefix\r * @param ... Zero or more POD types\r */\r void WriteChannel(userrec* user, char* text, ...);\r\r /** Write to a channel, from a user, using std::string for text\r * @param user User whos details to prefix the line with\r * @param text A std::string containing the output line without prefix\r */\r void WriteChannel(userrec* user, const std::string &text);\r\r /** Write to a channel, from a server, using va_args for text\r * @param ServName Server name to prefix the line with\r * @param text A printf-style format string which builds the output line without prefix\r * @param ... Zero or more POD type\r */\r void WriteChannelWithServ(const char* ServName, const char* text, ...);\r\r /** Write to a channel, from a server, using std::string for text\r * @param ServName Server name to prefix the line with\r * @param text A std::string containing the output line without prefix\r */\r void WriteChannelWithServ(const char* ServName, const std::string &text);\r\r /** Write to all users on a channel except a specific user, using va_args for text.\r * Internally, this calls WriteAllExcept().\r * @param user User whos details to prefix the line with, and to omit from receipt of the message\r * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,\r * use the nick!user@host of the user.\r * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone\r * @param text A printf-style format string which builds the output line without prefix\r * @param ... Zero or more POD type\r */\r void WriteAllExceptSender(userrec* user, bool serversource, char status, char* text, ...);\r\r /** Write to all users on a channel except a list of users, using va_args for text\r * @param user User whos details to prefix the line with, and to omit from receipt of the message\r * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,\r * use the nick!user@host of the user.\r * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone\r * @param except_list A list of users NOT to send the text to\r * @param text A printf-style format string which builds the output line without prefix\r * @param ... Zero or more POD type\r */\r void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, char* text, ...);\r\r /** Write to all users on a channel except a specific user, using std::string for text.\r * Internally, this calls WriteAllExcept().\r * @param user User whos details to prefix the line with, and to omit from receipt of the message\r * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,\r * use the nick!user@host of the user.\r * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone\r * @param text A std::string containing the output line without prefix\r */\r void WriteAllExceptSender(userrec* user, bool serversource, char status, const std::string& text);\r\r /** Write to all users on a channel except a list of users, using std::string for text\r * @param user User whos details to prefix the line with, and to omit from receipt of the message\r * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,\r * use the nick!user@host of the user.\r * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone\r * @param except_list A list of users NOT to send the text to\r * @param text A std::string containing the output line without prefix\r */\r void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, const std::string& text);\r\r /** Returns the maximum number of bans allowed to be set on this channel\r * @return The maximum number of bans allowed\r */\r long GetMaxBans();\r\r /** Return the channel's modes with parameters.\r * @param showkey If this is set to true, the actual key is shown,\r * otherwise it is replaced with '<KEY>'\r * @return The channel mode string\r */\r char* ChanModes(bool showkey);\r\r /** Spool the NAMES list for this channel to the given user\r * @param user The user to spool the NAMES list to\r * @param ulist The user list to send, NULL to use the\r * channel's default names list of everyone\r */\r void UserList(userrec *user, CUList* ulist = NULL);\r\r /** Get the number of invisible users on this channel\r * @return Number of invisible users\r */\r int CountInvisible();\r\r /** Get a users status on this channel\r * @param user The user to look up\r * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.\r */\r int GetStatus(userrec *user);\r\r /** Get a users status on this channel in a bitmask\r * @param user The user to look up\r * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE\r */\r int GetStatusFlags(userrec *user);\r\r /** Get a users prefix on this channel in a string.\r * @param user The user to look up\r * @return A character array containing the prefix string.\r * Unlike GetStatus and GetStatusFlags which will only return the\r * core specified modes @, % and + (op, halfop and voice), GetPrefixChar\r * will also return module-defined prefixes. If the user has to prefix,\r * an empty but non-null string is returned. If the user has multiple\r * prefixes, the highest is returned. If you do not recognise the prefix\r * character you can get, you can deal with it in a 'proprtional' manner\r * compared to known prefixes, using GetPrefixValue().\r */\r const char* GetPrefixChar(userrec *user);\r\r /** Return all of a users mode prefixes into a char* string.\r * @param user The user to look up\r * @return A list of all prefix characters. The prefixes will always\r * be in rank order, greatest first, as certain IRC clients require\r * this when multiple prefixes are used names lists.\r */\r const char* GetAllPrefixChars(userrec* user);\r\r /** Get the value of a users prefix on this channel.\r * @param user The user to look up\r * @return The module or core-defined value of the users prefix.\r * The values for op, halfop and voice status are constants in\r * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.\r * If the value you are given does not match one of these three, it is\r * a module-defined mode, and it should be compared in proportion to\r * these three constants. For example a value greater than OP_VALUE\r * is a prefix of greater 'worth' than ops, and a value less than\r * VOICE_VALUE is of lesser 'worth' than a voice.\r */\r unsigned int GetPrefixValue(userrec* user);\r\r /** This method removes all prefix characters from a user.\r * It will not inform the user or the channel of the removal of prefixes,\r * and should be used when the user parts or quits.\r * @param user The user to remove all prefixes from\r */\r void RemoveAllPrefixes(userrec* user);\r\r /** Add a prefix character to a user.\r * Only the core should call this method, usually from\r * within the mode parser or when the first user joins\r * the channel (to grant ops to them)\r * @param user The user to associate the privilage with\r * @param prefix The prefix character to associate\r * @param prefix_rank The rank (value) of this prefix character\r * @param adding True if adding the prefix, false when removing\r */\r void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding);\r\r /** Check if a user is banned on this channel\r * @param user A user to check against the banlist\r * @returns True if the user given is banned\r */\r bool IsBanned(userrec* user);\r\r /** Clears the cached max bans value\r */\r void ResetMaxBans();\r\r /** Destructor for chanrec\r */\r virtual ~chanrec() { /* stub */ }\r};\r\r#endif\r
\ No newline at end of file
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2007 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 __CHANNELS_H__
+#define __CHANNELS_H__
+
+#include "inspircd_config.h"
+#include "base.h"
+#include <time.h>
+#include <vector>
+#include <string>
+#include <map>
+
+/** RFC1459 channel modes
+ */
+enum ChannelModes {
+ CM_TOPICLOCK = 't'-65, /* +t: Only operators can change topic */
+ CM_NOEXTERNAL = 'n'-65, /* +n: Only users in the channel can message it */
+ CM_INVITEONLY = 'i'-65, /* +i: Invite only */
+ CM_MODERATED = 'm'-65, /* +m: Only voices and above can talk */
+ CM_SECRET = 's'-65, /* +s: Secret channel */
+ CM_PRIVATE = 'p'-65, /* +p: Private channel */
+ CM_KEY = 'k'-65, /* +k: Keyed channel */
+ CM_LIMIT = 'l'-65 /* +l: Maximum user limit */
+};
+
+/* Forward declarations - needed */
+class User;
+class Channel;
+
+/** Holds an entry for a ban list, exemption list, or invite list.
+ * This class contains a single element in a channel list, such as a banlist.
+ */
+class HostItem : public classbase
+{
+ public:
+ /** Time the item was added
+ */
+ time_t set_time;
+ /** Who added the item
+ */
+ char set_by[NICKMAX];
+ /** The actual item data
+ */
+ char data[MAXBUF];
+
+ HostItem() { /* stub */ }
+ virtual ~HostItem() { /* stub */ }
+};
+
+/** A subclass of HostItem designed to hold channel bans (+b)
+ */
+class BanItem : public HostItem
+{
+};
+
+/** Holds a complete ban list
+ */
+typedef std::vector<BanItem> BanList;
+
+/** A list of users on a channel
+ */
+typedef std::map<User*,std::string> CUList;
+
+/** Shorthand for CUList::iterator
+ */
+typedef CUList::iterator CUListIter;
+
+/** Shorthand for CUList::const_iterator
+ */
+typedef CUList::const_iterator CUListConstIter;
+
+/** A list of custom modes parameters on a channel
+ */
+typedef std::map<char,char*> CustomModeList;
+
+
+/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
+ */
+enum UserChannelModes {
+ UCMODE_OP = 1, /* Opped user */
+ UCMODE_VOICE = 2, /* Voiced user */
+ UCMODE_HOP = 4 /* Halfopped user */
+};
+
+/* Forward declaration -- required */
+class InspIRCd;
+
+/** A stored prefix and its rank
+ */
+typedef std::pair<char, unsigned int> prefixtype;
+
+/** A list of prefixes set on a user in a channel
+ */
+typedef std::vector<prefixtype> pfxcontainer;
+
+/** A list of users with zero or more prefixes set on them
+ */
+typedef std::map<User*, std::vector<prefixtype> > prefixlist;
+
+/** Holds all relevent information for a channel.
+ * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
+ * etc, and an instance of the BanList type.
+ */
+class CoreExport Channel : public Extensible
+{
+ private:
+
+ /** Pointer to creator object
+ */
+ InspIRCd* ServerInstance;
+
+ /** Connect a Channel to a User
+ */
+ static Channel* ForceChan(InspIRCd* Instance, Channel* Ptr, User* user, const std::string &privs, bool bursting);
+
+ /** Set default modes for the channel on creation
+ */
+ void SetDefaultModes();
+
+ /** A list of prefixes associated with each user in the channel
+ * (e.g. &%+ etc)
+ */
+ prefixlist prefixes;
+
+ /** Maximum number of bans (cached)
+ */
+ int maxbans;
+
+ public:
+ /** The channel's name.
+ */
+ char name[CHANMAX];
+
+ /** Modes for the channel.
+ * This is not a null terminated string! It is a hash where
+ * each item in it represents if a mode is set. For example
+ * for mode +A, index 0. Use modechar-65 to calculate which
+ * field to check.
+ */
+ char modes[64];
+
+ /** User lists.
+ * There are four user lists, one for
+ * all the users, one for the ops, one for
+ * the halfops and another for the voices.
+ */
+ CUList internal_userlist;
+
+ /** Opped users.
+ * There are four user lists, one for
+ * all the users, one for the ops, one for
+ * the halfops and another for the voices.
+ */
+ CUList internal_op_userlist;
+
+ /** Halfopped users.
+ * There are four user lists, one for
+ * all the users, one for the ops, one for
+ * the halfops and another for the voices.
+ */
+ CUList internal_halfop_userlist;
+
+ /** Voiced users.
+ * There are four user lists, one for
+ * all the users, one for the ops, one for
+ * the halfops and another for the voices.
+ */
+ CUList internal_voice_userlist;
+
+ /** Parameters for custom modes.
+ * One for each custom mode letter.
+ */
+ CustomModeList custom_mode_params;
+
+ /** Channel topic.
+ * If this is an empty string, no channel topic is set.
+ */
+ char topic[MAXTOPIC];
+
+ /** Creation time.
+ * This is a timestamp (TS) value.
+ */
+ time_t created;
+
+ /** Time topic was set.
+ * If no topic was ever set, this will be equal to Channel::created
+ */
+ time_t topicset;
+
+ /** The last user to set the topic.
+ * If this member is an empty string, no topic was ever set.
+ */
+ char setby[128];
+
+ /** Contains the channel user limit.
+ * If this value is zero, there is no limit in place.
+ */
+ short int limit;
+
+ /** Contains the channel key.
+ * If this value is an empty string, there is no channel key in place.
+ */
+ char key[32];
+
+ /** The list of all bans set on the channel.
+ */
+ BanList bans;
+
+ /** Sets or unsets a custom mode in the channels info
+ * @param mode The mode character to set or unset
+ * @param mode_on True if you want to set the mode or false if you want to remove it
+ */
+ void SetMode(char mode,bool mode_on);
+
+ /** Sets or unsets the parameters for a custom mode in a channels info
+ * @param mode The mode character to set or unset
+ * @param parameter The parameter string to associate with this mode character
+ * @param mode_on True if you want to set the mode or false if you want to remove it
+ */
+ void SetModeParam(char mode,const char* parameter,bool mode_on);
+
+ /** Returns true if a mode is set on a channel
+ * @param mode The mode character you wish to query
+ * @return True if the custom mode is set, false if otherwise
+ */
+ bool IsModeSet(char mode);
+
+ /** Returns the parameter for a custom mode on a channel.
+ * @param mode The mode character you wish to query
+ *
+ * For example if "+L #foo" is set, and you pass this method
+ * 'L', it will return '#foo'. If the mode is not set on the
+ * channel, or the mode has no parameters associated with it,
+ * it will return an empty string.
+ *
+ * @return The parameter for this mode is returned, or an empty string
+ */
+ std::string GetModeParameter(char mode);
+
+ /** Obtain the channel "user counter"
+ * This returns the channel reference counter, which is initialized
+ * to 0 when the channel is created and incremented/decremented
+ * upon joins, parts quits and kicks.
+ *
+ * @return The number of users on this channel
+ */
+ long GetUserCounter();
+
+ /** Add a user pointer to the internal reference list
+ * @param user The user to add
+ *
+ * The data inserted into the reference list is a table as it is
+ * an arbitary pointer compared to other users by its memory address,
+ * as this is a very fast 32 or 64 bit integer comparison.
+ */
+ void AddUser(User* user);
+
+ /** Add a user pointer to the internal reference list of opped users
+ * @param user The user to add
+ */
+ void AddOppedUser(User* user);
+
+ /** Add a user pointer to the internal reference list of halfopped users
+ * @param user The user to add
+ */
+ void AddHalfoppedUser(User* user);
+
+ /** Add a user pointer to the internal reference list of voiced users
+ * @param user The user to add
+ */
+ void AddVoicedUser(User* user);
+
+ /** Delete a user pointer to the internal reference list
+ * @param user The user to delete
+ * @return number of users left on the channel after deletion of the user
+ */
+ unsigned long DelUser(User* user);
+
+ /** Delete a user pointer to the internal reference list of opped users
+ * @param user The user to delete
+ */
+ void DelOppedUser(User* user);
+
+ /** Delete a user pointer to the internal reference list of halfopped users
+ * @param user The user to delete
+ */
+ void DelHalfoppedUser(User* user);
+
+ /** Delete a user pointer to the internal reference list of voiced users
+ * @param user The user to delete
+ */
+ void DelVoicedUser(User* user);
+
+ /** Obtain the internal reference list
+ * The internal reference list contains a list of User*.
+ * These are used for rapid comparison to determine
+ * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
+ * The resulting pointer to the vector should be considered
+ * readonly and only modified via AddUser and DelUser.
+ *
+ * @return This function returns pointer to a map of User pointers (CUList*).
+ */
+ CUList* GetUsers();
+
+ /** Obtain the internal reference list of opped users
+ * @return This function returns pointer to a map of User pointers (CUList*).
+ */
+ CUList* GetOppedUsers();
+
+ /** Obtain the internal reference list of halfopped users
+ * @return This function returns pointer to a map of User pointers (CUList*).
+ */
+ CUList* GetHalfoppedUsers();
+
+ /** Obtain the internal reference list of voiced users
+ * @return This function returns pointer to a map of User pointers (CUList*).
+ */
+ CUList* GetVoicedUsers();
+
+ /** Returns true if the user given is on the given channel.
+ * @param The user to look for
+ * @return True if the user is on this channel
+ */
+ bool HasUser(User* user);
+
+ /** Creates a channel record and initialises it with default values
+ * @throw Nothing at present.
+ */
+ Channel(InspIRCd* Instance);
+
+ /** Make src kick user from this channel with the given reason.
+ * @param src The source of the kick
+ * @param user The user being kicked (must be on this channel)
+ * @param reason The reason for the kick
+ * @return The number of users left on the channel. If this is zero
+ * when the method returns, you MUST delete the Channel immediately!
+ */
+ long KickUser(User *src, User *user, const char* reason);
+
+ /** Make the server kick user from this channel with the given reason.
+ * @param user The user being kicked (must be on this channel)
+ * @param reason The reason for the kick
+ * @param triggerevents True if you wish this kick to trigger module events
+ * @return The number of users left on the channel. If this is zero
+ * when the method returns, you MUST delete the Channel immediately!
+ */
+ long ServerKickUser(User* user, const char* reason, bool triggerevents);
+
+ /** Part a user from this channel with the given reason.
+ * If the reason field is NULL, no reason will be sent.
+ * @param user The user who is parting (must be on this channel)
+ * @param reason The (optional) part reason
+ * @return The number of users left on the channel. If this is zero
+ * when the method returns, you MUST delete the Channel immediately!
+ */
+ long PartUser(User *user, const char* reason = NULL);
+
+ /* Join a user to a channel. May be a channel that doesnt exist yet.
+ * @param user The user to join to the channel.
+ * @param cn The channel name to join to. Does not have to exist.
+ * @param key The key of the channel, if given
+ * @param override If true, override all join restrictions such as +bkil
+ * @return A pointer to the Channel the user was joined to. A new Channel may have
+ * been created if the channel did not exist before the user was joined to it.
+ * If the user could not be joined to a channel, the return value may be NULL.
+ */
+ static Channel* JoinUser(InspIRCd* ServerInstance, User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
+
+ /** Write to a channel, from a user, using va_args for text
+ * @param user User whos details to prefix the line with
+ * @param text A printf-style format string which builds the output line without prefix
+ * @param ... Zero or more POD types
+ */
+ void WriteChannel(User* user, char* text, ...);
+
+ /** Write to a channel, from a user, using std::string for text
+ * @param user User whos details to prefix the line with
+ * @param text A std::string containing the output line without prefix
+ */
+ void WriteChannel(User* user, const std::string &text);
+
+ /** Write to a channel, from a server, using va_args for text
+ * @param ServName Server name to prefix the line with
+ * @param text A printf-style format string which builds the output line without prefix
+ * @param ... Zero or more POD type
+ */
+ void WriteChannelWithServ(const char* ServName, const char* text, ...);
+
+ /** Write to a channel, from a server, using std::string for text
+ * @param ServName Server name to prefix the line with
+ * @param text A std::string containing the output line without prefix
+ */
+ void WriteChannelWithServ(const char* ServName, const std::string &text);
+
+ /** Write to all users on a channel except a specific user, using va_args for text.
+ * Internally, this calls WriteAllExcept().
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+ * use the nick!user@host of the user.
+ * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+ * @param text A printf-style format string which builds the output line without prefix
+ * @param ... Zero or more POD type
+ */
+ void WriteAllExceptSender(User* user, bool serversource, char status, char* text, ...);
+
+ /** Write to all users on a channel except a list of users, using va_args for text
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+ * use the nick!user@host of the user.
+ * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+ * @param except_list A list of users NOT to send the text to
+ * @param text A printf-style format string which builds the output line without prefix
+ * @param ... Zero or more POD type
+ */
+ void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, char* text, ...);
+
+ /** Write to all users on a channel except a specific user, using std::string for text.
+ * Internally, this calls WriteAllExcept().
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+ * use the nick!user@host of the user.
+ * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+ * @param text A std::string containing the output line without prefix
+ */
+ void WriteAllExceptSender(User* user, bool serversource, char status, const std::string& text);
+
+ /** Write to all users on a channel except a list of users, using std::string for text
+ * @param user User whos details to prefix the line with, and to omit from receipt of the message
+ * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
+ * use the nick!user@host of the user.
+ * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
+ * @param except_list A list of users NOT to send the text to
+ * @param text A std::string containing the output line without prefix
+ */
+ void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text);
+
+ /** Returns the maximum number of bans allowed to be set on this channel
+ * @return The maximum number of bans allowed
+ */
+ long GetMaxBans();
+
+ /** Return the channel's modes with parameters.
+ * @param showkey If this is set to true, the actual key is shown,
+ * otherwise it is replaced with '<KEY>'
+ * @return The channel mode string
+ */
+ char* ChanModes(bool showkey);
+
+ /** Spool the NAMES list for this channel to the given user
+ * @param user The user to spool the NAMES list to
+ * @param ulist The user list to send, NULL to use the
+ * channel's default names list of everyone
+ */
+ void UserList(User *user, CUList* ulist = NULL);
+
+ /** Get the number of invisible users on this channel
+ * @return Number of invisible users
+ */
+ int CountInvisible();
+
+ /** Get a users status on this channel
+ * @param user The user to look up
+ * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.
+ */
+ int GetStatus(User *user);
+
+ /** Get a users status on this channel in a bitmask
+ * @param user The user to look up
+ * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE
+ */
+ int GetStatusFlags(User *user);
+
+ /** Get a users prefix on this channel in a string.
+ * @param user The user to look up
+ * @return A character array containing the prefix string.
+ * Unlike GetStatus and GetStatusFlags which will only return the
+ * core specified modes @, % and + (op, halfop and voice), GetPrefixChar
+ * will also return module-defined prefixes. If the user has to prefix,
+ * an empty but non-null string is returned. If the user has multiple
+ * prefixes, the highest is returned. If you do not recognise the prefix
+ * character you can get, you can deal with it in a 'proprtional' manner
+ * compared to known prefixes, using GetPrefixValue().
+ */
+ const char* GetPrefixChar(User *user);
+
+ /** Return all of a users mode prefixes into a char* string.
+ * @param user The user to look up
+ * @return A list of all prefix characters. The prefixes will always
+ * be in rank order, greatest first, as certain IRC clients require
+ * this when multiple prefixes are used names lists.
+ */
+ const char* GetAllPrefixChars(User* user);
+
+ /** Get the value of a users prefix on this channel.
+ * @param user The user to look up
+ * @return The module or core-defined value of the users prefix.
+ * The values for op, halfop and voice status are constants in
+ * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
+ * If the value you are given does not match one of these three, it is
+ * a module-defined mode, and it should be compared in proportion to
+ * these three constants. For example a value greater than OP_VALUE
+ * is a prefix of greater 'worth' than ops, and a value less than
+ * VOICE_VALUE is of lesser 'worth' than a voice.
+ */
+ unsigned int GetPrefixValue(User* user);
+
+ /** This method removes all prefix characters from a user.
+ * It will not inform the user or the channel of the removal of prefixes,
+ * and should be used when the user parts or quits.
+ * @param user The user to remove all prefixes from
+ */
+ void RemoveAllPrefixes(User* user);
+
+ /** Add a prefix character to a user.
+ * Only the core should call this method, usually from
+ * within the mode parser or when the first user joins
+ * the channel (to grant ops to them)
+ * @param user The user to associate the privilage with
+ * @param prefix The prefix character to associate
+ * @param prefix_rank The rank (value) of this prefix character
+ * @param adding True if adding the prefix, false when removing
+ */
+ void SetPrefix(User* user, char prefix, unsigned int prefix_rank, bool adding);
+
+ /** Check if a user is banned on this channel
+ * @param user A user to check against the banlist
+ * @returns True if the user given is banned
+ */
+ bool IsBanned(User* user);
+
+ /** Clears the cached max bans value
+ */
+ void ResetMaxBans();
+
+ /** Destructor for Channel
+ */
+ virtual ~Channel() { /* stub */ }
+};
+
+#endif