* | 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-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.
*
/** RFC1459 channel modes
*/
enum ChannelModes {
- CM_TOPICLOCK = 't'-65,
- CM_NOEXTERNAL = 'n'-65,
- CM_INVITEONLY = 'i'-65,
- CM_MODERATED = 'm'-65,
- CM_SECRET = 's'-65,
- CM_PRIVATE = 'p'-65,
- CM_KEY = 'k'-65,
- CM_LIMIT = 'l'-65
+ 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 userrec;
class chanrec;
{
};
-/** A subclass of HostItem designed to hold channel exempts (+e)
- */
-class ExemptItem : public HostItem
-{
-};
-
-/** A subclass of HostItem designed to hold channel invites (+I)
- */
-class InviteItem : public HostItem
-{
-};
-
/** Holds a complete ban list
*/
typedef std::vector<BanItem> BanList;
-/** Holds a complete exempt list
- */
-typedef std::vector<ExemptItem> ExemptList;
-
-/** Holds a complete invite list
- */
-typedef std::vector<InviteItem> InviteList;
-
/** A list of users on a channel
*/
-typedef std::map<userrec*,userrec*> CUList;
+typedef std::map<userrec*,std::string> CUList;
/** Shorthand for CUList::iterator
*/
/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
*/
enum UserChannelModes {
- UCMODE_OP = 1,
- UCMODE_VOICE = 2,
- UCMODE_HOP = 4
-};
-
-/** Holds a user's modes on a channel
- * This class associates a users privilages with a channel by creating a pointer link between
- * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
- * has on the channel, such as op, voice, etc.
- */
-class ucrec : public classbase
-{
- public:
- /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
- * If this value is zero, the user has no privilages upon the channel.
- */
- char uc_modes;
-
- /** Points to the channel record where the given modes apply.
- * If the record is not in use, this value will be NULL.
- */
- chanrec *channel;
-
- /** Constructor for ucrec
- */
- ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
-
- /** Destructor for ucrec
- */
- virtual ~ucrec() { /* stub */ }
+ 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<userrec*, 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 chanrec : public Extensible
+class CoreExport chanrec : public Extensible
{
private:
/** Connect a chanrec to a userrec
*/
- static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr,ucrec *a,userrec* user, int created);
+ static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr, userrec* user, const std::string &privs);
+
+ /** 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 channels name.
+ /** The channel's name.
*/
char name[CHANMAX];
*/
char modes[64];
- /** User lists
+ /** 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
+ /** 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
+ /** 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
+ /** 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
+ /** Parameters for custom modes.
+ * One for each custom mode letter.
*/
CustomModeList custom_mode_params;
* 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 chanrec::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[NICKMAX];
+ char setby[128];
/** Contains the channel user limit.
* If this value is zero, there is no limit in place.
*/
void AddVoicedUser(userrec* user);
- /** Delete a user pointer to the internal reference list
+ /** 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(userrec* user);
/** Delete a user pointer to the internal reference list of opped users
* 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 chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key = "");
+ static chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key, 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
/** 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 prefi
+ * @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, ...);
*/
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
+ /** 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(userrec* 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 text A printf-style format string which builds the output line without prefi
+ * @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 WriteAllExceptSender(userrec* user, char status, char* text, ...);
+ void WriteAllExcept(userrec* 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(userrec* user, bool serversource, char status, const std::string& text);
- /** Write to all users on a channel except a specific user, using std::string for 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 WriteAllExceptSender(userrec* user, char status, const std::string& text);
+ void WriteAllExcept(userrec* 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
char* ChanModes(bool showkey);
/** Spool the NAMES list for this channel to the given user
- * @param The user to spool the NAMES list to
+ * @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(userrec *user);
+ void UserList(userrec *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 The user to look up
+ * @param user The user to look up
* @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.
*/
int GetStatus(userrec *user);
/** Get a users status on this channel in a bitmask
- * @param The user to look up
+ * @param user The user to look up
* @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE
*/
int GetStatusFlags(userrec *user);
- /** Get a users status on this channel in a string
- * @param The user to look up
- * @return A character array containing the string "@", "%", "+" or ""
+ /** 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(userrec *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(userrec* 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(userrec* 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(userrec* 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
*/
- const char* GetStatusChar(userrec *user);
-
void SetPrefix(userrec* 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(userrec* user);
+
+ /** Clears the cached max bans value
+ */
+ void ResetMaxBans();
+
/** Destructor for chanrec
*/
virtual ~chanrec() { /* stub */ }
projects / user / henk / code / inspircd.git / blobdiff