1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 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 #include "inspircd_config.h"
23 #ifndef __CHANNELS_H__
24 #define __CHANNELS_H__
26 #define CM_TOPICLOCK 1
27 #define CM_NOEXTERNAL 2
28 #define CM_INVITEONLY 4
29 #define CM_MODERATED 8
35 /** Holds an entry for a ban list, exemption list, or invite list.
36 * This class contains a single element in a channel list, such as a banlist.
38 class HostItem : public classbase
45 HostItem() { /* stub */ }
46 virtual ~HostItem() { /* stub */ }
49 // banlist is inherited from HostList mainly for readability
52 /** A subclass of HostItem designed to hold channel bans (+b)
54 class BanItem : public HostItem
60 /** A subclass of HostItem designed to hold channel exempts (+e)
62 class ExemptItem : public HostItem
68 /** A subclass of HostItem designed to hold channel invites (+I)
70 class InviteItem : public HostItem
75 /** Holds a custom parameter to a module-defined channel mode
76 * e.g. for +L this would hold the channel name.
79 class ModeParameter : public classbase
83 char parameter[MAXBUF];
84 char channel[CHANMAX];
87 /** Holds a complete ban list
89 typedef std::vector<BanItem> BanList;
91 /** Holds a complete exempt list
93 typedef std::vector<ExemptItem> ExemptList;
95 /** Holds a complete invite list
97 typedef std::vector<InviteItem> InviteList;
99 /** Holds all relevent information for a channel.
100 * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
101 * etc, and an instance of the BanList type.
103 class chanrec : public Extensible
106 /** The channels name.
108 char name[CHANMAX]; /* channel name */
109 /** Custom modes for the channel.
110 * Plugins may use this field in any way they see fit.
112 char custom_modes[MAXMODES]; /* modes handled by modules */
114 /** User list (casted to char*'s to stop forward declaration stuff)
115 * (chicken and egg scenario!)
117 std::vector<char*> internal_userlist;
120 * If this is an empty string, no channel topic is set.
126 /** Time topic was set.
127 * If no topic was ever set, this will be equal to chanrec::created
130 /** The last user to set the topic.
131 * If this member is an empty string, no topic was ever set.
135 /** Contains the channel user limit.
136 * If this value is zero, there is no limit in place.
140 /** Contains the channel key.
141 * If this value is an empty string, there is no channel key in place.
145 /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
149 /** The list of all bans set on the channel.
153 /** Sets or unsets a custom mode in the channels info
154 * @param mode The mode character to set or unset
155 * @param mode_on True if you want to set the mode or false if you want to remove it
157 void SetCustomMode(char mode,bool mode_on);
159 /** Sets or unsets the parameters for a custom mode in a channels info
160 * @param mode The mode character to set or unset
161 * @param parameter The parameter string to associate with this mode character
162 * @param mode_on True if you want to set the mode or false if you want to remove it
164 void SetCustomModeParam(char mode,char* parameter,bool mode_on);
166 /** Returns true if a custom mode is set on a channel
167 * @param mode The mode character you wish to query
168 * @return True if the custom mode is set, false if otherwise
170 bool IsCustomModeSet(char mode);
172 /** Returns the parameter for a custom mode on a channel.
173 * @param mode The mode character you wish to query
175 * For example if "+L #foo" is set, and you pass this method
176 * 'L', it will return '#foo'. If the mode is not set on the
177 * channel, or the mode has no parameters associated with it,
178 * it will return an empty string.
180 * @return The parameter for this mode is returned, or an empty string
182 std::string GetModeParameter(char mode);
184 /** Obtain the channel "user counter"
185 * This returns the channel reference counter, which is initialized
186 * to 0 when the channel is created and incremented/decremented
187 * upon joins, parts quits and kicks.
189 * @return The number of users on this channel
191 long GetUserCounter();
193 /** Add a user pointer to the internal reference list
194 * @param castuser This should be a pointer to a userrec, casted to char*
196 * The data inserted into the reference list is a table as it is
197 * an arbitary pointer compared to other users by its memory address,
198 * as this is a very fast 32 or 64 bit integer comparison.
200 void AddUser(char* castuser);
202 /** Delete a user pointer to the internal reference list
203 * @param castuser This should be a pointer to a userrec, casted to char*
205 * The data removed from the reference list is a table as it is
206 * an arbitary pointer compared to other users by its memory address,
207 * as this is a very fast 32 or 64 bit integer comparison.
209 void DelUser(char* castuser);
211 /** Obrain the internal reference list
212 * The internal reference list contains a list of userrec*
213 * cast to char*. These are used for rapid comparison to determine
214 * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
215 * The resulting pointer to the vector should be considered
216 * readonly and only modified via AddUser and DelUser.
218 * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
220 std::vector<char*> *GetUsers();
222 /** Creates a channel record and initialises it with default values
226 virtual ~chanrec() { /* stub */ }
229 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
230 * needs to come AFTER struct chanrec */
233 #define UCMODE_VOICE 2
235 #define UCMODE_PROTECT 8
236 #define UCMODE_FOUNDER 16
238 /** Holds a user's modes on a channel
239 * This class associates a users privilages with a channel by creating a pointer link between
240 * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
241 * has on the channel, such as op, voice, etc.
243 class ucrec : public classbase
246 /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
247 * If this value is zero, the user has no privilages upon the channel.
251 /** Points to the channel record where the given modes apply.
252 * If the record is not in use, this value will be NULL.
256 ucrec() { /* stub */ }
257 virtual ~ucrec() { /* stub */ }
260 chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
261 chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
262 void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);