1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __CHANNELS_H__
18 #define __CHANNELS_H__
20 #include "inspircd_config.h"
27 #define CM_TOPICLOCK 1
28 #define CM_NOEXTERNAL 2
29 #define CM_INVITEONLY 4
30 #define CM_MODERATED 8
36 /** Holds an entry for a ban list, exemption list, or invite list.
37 * This class contains a single element in a channel list, such as a banlist.
39 class HostItem : public classbase
46 HostItem() { /* stub */ }
47 virtual ~HostItem() { /* stub */ }
50 // banlist is inherited from HostList mainly for readability
53 /** A subclass of HostItem designed to hold channel bans (+b)
55 class BanItem : public HostItem
61 /** A subclass of HostItem designed to hold channel exempts (+e)
63 class ExemptItem : public HostItem
69 /** A subclass of HostItem designed to hold channel invites (+I)
71 class InviteItem : public HostItem
75 /** Holds a complete ban list
77 typedef std::vector<BanItem> BanList;
79 /** Holds a complete exempt list
81 typedef std::vector<ExemptItem> ExemptList;
83 /** Holds a complete invite list
85 typedef std::vector<InviteItem> InviteList;
87 /** Holds all relevent information for a channel.
88 * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
89 * etc, and an instance of the BanList type.
91 class chanrec : public Extensible
94 /** The channels name.
96 char name[CHANMAX]; /* channel name */
97 /** Custom modes for the channel.
98 * Plugins may use this field in any way they see fit.
100 char custom_modes[96]; /* modes handled by modules */
102 /** User list (casted to char*'s to stop forward declaration stuff)
103 * (chicken and egg scenario!)
105 std::map<char*,char*> internal_userlist;
106 std::map<char*,char*> internal_op_userlist;
107 std::map<char*,char*> internal_halfop_userlist;
108 std::map<char*,char*> internal_voice_userlist;
110 /** Parameters for custom modes
112 std::map<char,char*> custom_mode_params;
115 * If this is an empty string, no channel topic is set.
121 /** Time topic was set.
122 * If no topic was ever set, this will be equal to chanrec::created
125 /** The last user to set the topic.
126 * If this member is an empty string, no topic was ever set.
130 /** Contains the channel user limit.
131 * If this value is zero, there is no limit in place.
135 /** Contains the channel key.
136 * If this value is an empty string, there is no channel key in place.
140 /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
144 /** The list of all bans set on the channel.
148 /** Sets or unsets a custom mode in the channels info
149 * @param mode The mode character to set or unset
150 * @param mode_on True if you want to set the mode or false if you want to remove it
152 void SetCustomMode(char mode,bool mode_on);
154 /** Sets or unsets the parameters for a custom mode in a channels info
155 * @param mode The mode character to set or unset
156 * @param parameter The parameter string to associate with this mode character
157 * @param mode_on True if you want to set the mode or false if you want to remove it
159 void SetCustomModeParam(char mode,char* parameter,bool mode_on);
161 /** Returns true if a custom mode is set on a channel
162 * @param mode The mode character you wish to query
163 * @return True if the custom mode is set, false if otherwise
165 bool IsCustomModeSet(char mode);
167 /** Returns the parameter for a custom mode on a channel.
168 * @param mode The mode character you wish to query
170 * For example if "+L #foo" is set, and you pass this method
171 * 'L', it will return '#foo'. If the mode is not set on the
172 * channel, or the mode has no parameters associated with it,
173 * it will return an empty string.
175 * @return The parameter for this mode is returned, or an empty string
177 std::string GetModeParameter(char mode);
179 /** Obtain the channel "user counter"
180 * This returns the channel reference counter, which is initialized
181 * to 0 when the channel is created and incremented/decremented
182 * upon joins, parts quits and kicks.
184 * @return The number of users on this channel
186 long GetUserCounter();
188 /** Add a user pointer to the internal reference list
189 * @param castuser This should be a pointer to a userrec, casted to char*
191 * The data inserted into the reference list is a table as it is
192 * an arbitary pointer compared to other users by its memory address,
193 * as this is a very fast 32 or 64 bit integer comparison.
195 void AddUser(char* castuser);
196 void AddOppedUser(char* castuser);
197 void AddHalfoppedUser(char* castuser);
198 void AddVoicedUser(char* castuser);
200 /** Delete a user pointer to the internal reference list
201 * @param castuser This should be a pointer to a userrec, casted to char*
203 * The data removed from the reference list is a table as it is
204 * an arbitary pointer compared to other users by its memory address,
205 * as this is a very fast 32 or 64 bit integer comparison.
207 void DelUser(char* castuser);
208 void DelOppedUser(char* castuser);
209 void DelHalfoppedUser(char* castuser);
210 void DelVoicedUser(char* castuser);
212 /** Obrain the internal reference list
213 * The internal reference list contains a list of userrec*
214 * cast to char*. These are used for rapid comparison to determine
215 * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
216 * The resulting pointer to the vector should be considered
217 * readonly and only modified via AddUser and DelUser.
219 * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
221 std::map<char*,char*> *GetUsers();
222 std::map<char*,char*> *GetOppedUsers();
223 std::map<char*,char*> *GetHalfoppedUsers();
224 std::map<char*,char*> *GetVoicedUsers();
226 /** Creates a channel record and initialises it with default values
230 virtual ~chanrec() { /* stub */ }
233 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
234 * needs to come AFTER struct chanrec */
237 #define UCMODE_VOICE 2
239 #define UCMODE_PROTECT 8
240 #define UCMODE_FOUNDER 16
242 /** Holds a user's modes on a channel
243 * This class associates a users privilages with a channel by creating a pointer link between
244 * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
245 * has on the channel, such as op, voice, etc.
247 class ucrec : public classbase
250 /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
251 * If this value is zero, the user has no privilages upon the channel.
255 /** Points to the channel record where the given modes apply.
256 * If the record is not in use, this value will be NULL.
260 ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
261 virtual ~ucrec() { /* stub */ }
264 chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
265 chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
266 void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
267 void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents);