2 * IRC - Internet Relay Chat, ircd/channel.h
3 * Copyright (C) 1990 Jarkko Oikarinen
4 * Copyright (C) 1996 - 1997 Carlo Wood
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2, or (at your option)
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief Channel management and maintenance.
22 * @version $Id: channel.h 1860 2007-12-28 15:52:43Z klmitch $
24 #ifndef INCLUDED_channel_h
25 #define INCLUDED_channel_h
26 #ifndef INCLUDED_ircd_defs_h
27 #include "ircd_defs.h" /* NICKLEN */
29 #ifndef INCLUDED_sys_types_h
30 #include <sys/types.h>
31 #define INCLUDED_sys_types_h
33 #ifndef INCLUDED_res_h
44 #define MAXMODEPARAMS 6 /**< Maximum number of mode parameters */
45 #define MODEBUFLEN 200 /**< Maximum length of a mode */
47 #define KEYLEN 23 /**< Maximum length of a key */
48 #define CHANNELLEN 200 /**< Maximum length of a channel */
50 #define MAXJOINARGS 15 /**< number of slots for join buffer */
51 #define STARTJOINLEN 10 /**< fuzzy numbers */
52 #define STARTCREATELEN 20
58 #define ChannelExists(n) (0 != FindChannel(n))
60 #define CHFL_CHANOP 0x0001 /**< Channel operator */
61 #define CHFL_VOICE 0x0002 /**< the power to speak */
62 #define CHFL_DEOPPED 0x0004 /**< Is de-opped by a server */
63 #define CHFL_SERVOPOK 0x0008 /**< Server op allowed */
64 #define CHFL_ZOMBIE 0x0010 /**< Kicked from channel */
65 #define CHFL_BURST_JOINED 0x0100 /**< Just joined by net.junction */
66 #define CHFL_BANVALID 0x0800 /**< CHFL_BANNED bit is valid */
67 #define CHFL_BANNED 0x1000 /**< Channel member is banned */
68 #define CHFL_SILENCE_IPMASK 0x2000 /**< silence mask is a CIDR */
69 #define CHFL_BURST_ALREADY_OPPED 0x04000
70 /**< In oob BURST, but was already
73 #define CHFL_BURST_ALREADY_VOICED 0x08000
74 /**, In oob BURST, but was already
77 #define CHFL_CHANNEL_MANAGER 0x10000 /**< Set when creating channel or using
80 #define CHFL_USER_PARTING 0x20000 /**< User is already parting that
83 #define CHFL_DELAYED 0x40000 /**< User's join message is delayed */
84 #define CHFL_INVISIBLE 0x80000 /**< User's join message is delayed */
86 #define CHFL_OVERLAP (CHFL_CHANOP | CHFL_VOICE)
87 #define CHFL_BANVALIDMASK (CHFL_BANVALID | CHFL_BANNED)
88 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
90 /* Channel Visibility macros */
92 #define MODE_CHANOP CHFL_CHANOP /**< +o Chanop */
93 #define MODE_VOICE CHFL_VOICE /**< +v Voice */
94 #define MODE_PRIVATE 0x0004 /**< +p Private */
95 #define MODE_SECRET 0x0008 /**< +s Secret */
96 #define MODE_MODERATED 0x0010 /**< +m Moderated */
97 #define MODE_TOPICLIMIT 0x0020 /**< +t Topic Limited */
98 #define MODE_INVITEONLY 0x0040 /**< +i Invite only */
99 #define MODE_NOPRIVMSGS 0x0080 /**< +n No Private Messages */
100 #define MODE_KEY 0x0100 /**< +k Keyed */
101 #define MODE_BAN 0x0200 /**< +b Ban */
102 #define MODE_LIMIT 0x0400 /**< +l Limit */
103 #define MODE_REGONLY 0x0800 /**< Only +r users may join */
104 #define MODE_DELJOINS 0x1000 /**< New join messages are delayed */
105 #define MODE_REGISTERED 0x2000 /**< Channel marked as registered
106 * (for future semantic expansion) */
107 #define MODE_PERSIST 0x4000 /**< +z persistant channel */
108 #define MODE_NOCOLOUR 0x8000 /**< no ANSI color codes */
109 #define MODE_NOCTCP 0x10000 /**< no channel CTCPs */
110 #define MODE_SAVE 0x20000 /**< save this mode-with-arg 'til
112 #define MODE_FREE 0x40000 /**< string needs to be passed to
114 #define MODE_BURSTADDED 0x80000 /**< channel was created by a BURST */
115 #define MODE_UPASS 0x100000
116 #define MODE_APASS 0x200000
117 #define MODE_WASDELJOINS 0x400000 /**< Not DELJOINS, but some joins
119 #define MODE_EXCEPTION 0x800000 /**< ban exceptions */
120 #define MODE_NOAMSGS 0x1000000 /**< No multi target messages */
121 #define MODE_NONOTICE 0x2000000 /**< No channel notices */
122 #define MODE_QUARANTINE 0x4000000 /**< No channel notices */
123 #define MODE_ALTCHAN 0x8000000 /**< Alternative channel */
124 #define MODE_ACCESS 0x10000000 /**< ChanServ access */
125 /** mode flags which take another parameter (With PARAmeterS)
127 #define MODE_WPARAS (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT|MODE_APASS|MODE_UPASS|MODE_EXCEPTION|MODE_ALTCHAN|MODE_ACCESS)
129 /** Available Channel modes */
130 #define infochanmodes feature_bool(FEAT_OPLEVELS) ? "AcCbiklmMnNopstUvrDRzQ" : "cCbiklmMnNopstvrDRzQ"
131 /** Available Channel modes that take parameters */
132 #define infochanmodeswithparams feature_bool(FEAT_OPLEVELS) ? "AbkloUvFa" : "bklovFa"
134 #define HoldChannel(x) (!(x))
135 /** name invisible */
136 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
137 /** channel not shown but names are */
138 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
139 /** channel visible */
140 #define ShowChannel(v,c) (PubChannel(c) || find_channel_member((v),(c)))
141 #define PubChannel(x) ((!x) || ((x)->mode.mode & \
142 (MODE_PRIVATE | MODE_SECRET)) == 0)
144 #define IsGlobalChannel(name) (*(name) == '#')
145 #define IsLocalChannel(name) (*(name) == '&')
146 #define IsChannelName(name) (IsGlobalChannel(name) || IsLocalChannel(name))
148 typedef enum ChannelGetType {
153 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
156 #define MODE_ADD 0x40000000
157 #define MODE_DEL 0x20000000
159 /* used in ListingArgs.flags */
161 #define LISTARG_TOPICLIMITS 0x0001
162 #define LISTARG_SHOWSECRET 0x0002
163 #define LISTARG_NEGATEWILDCARD 0x0004
164 #define LISTARG_SHOWMODES 0x0008
167 * Maximum acceptable lag time in seconds: A channel younger than
168 * this is not protected against hacking admins.
169 * Mainly here to check if the TS clocks really sync (otherwise this
170 * will start causing HACK notices.
171 * This value must be the same on all servers.
173 * This value has been increased to 1 day in order to distinguish this
174 * "normal" type of HACK wallops / desyncs, from possiblity still
177 #define TS_LAG_TIME 86400
181 extern const char* const PartFmt1;
182 extern const char* const PartFmt2;
183 extern const char* const PartFmt1serv;
184 extern const char* const PartFmt2serv;
191 /** Information about a client on one channel
193 * This structure forms a sparse matrix with users down the side, and
194 * channels across the top. This matrix holds all the information about
195 * which users are on what channels, and what modes that user has on that
196 * channel (if they are op'd, voice'd and cached information if they are
200 struct Client* user; /**< The user */
201 struct Channel* channel; /**< The channel */
202 struct Membership* next_member; /**< The next user on this channel */
203 struct Membership* prev_member; /**< The previous user on this channel*/
204 struct Membership* next_channel; /**< Next channel this user is on */
205 struct Membership* prev_channel; /**< Previous channel this user is on*/
206 unsigned int status; /**< Flags for op'd, voice'd, etc */
207 unsigned short oplevel; /**< Op level */
210 #define MAXOPLEVELDIGITS 3
211 #define MAXOPLEVEL 999
213 #define IsZombie(x) ((x)->status & CHFL_ZOMBIE) /**< see \ref zombie */
214 #define IsDeopped(x) ((x)->status & CHFL_DEOPPED)
215 #define IsBanned(x) ((x)->status & CHFL_BANNED)
216 #define IsBanValid(x) ((x)->status & CHFL_BANVALID)
217 #define IsChanOp(x) ((x)->status & CHFL_CHANOP)
218 #define OpLevel(x) ((x)->oplevel)
219 #define HasVoice(x) ((x)->status & CHFL_VOICE)
220 #define IsServOpOk(x) ((x)->status & CHFL_SERVOPOK)
221 #define IsBurstJoined(x) ((x)->status & CHFL_BURST_JOINED)
222 #define IsVoicedOrOpped(x) ((x)->status & CHFL_VOICED_OR_OPPED)
223 #define IsChannelManager(x) ((x)->status & CHFL_CHANNEL_MANAGER)
224 #define IsUserParting(x) ((x)->status & CHFL_USER_PARTING)
225 #define IsDelayedJoin(x) ((x)->status & CHFL_DELAYED)
226 #define IsInvisibleJoin(x) ((x)->status & CHFL_INVISIBLE)
228 #define SetBanned(x) ((x)->status |= CHFL_BANNED)
229 #define SetBanValid(x) ((x)->status |= CHFL_BANVALID)
230 #define SetDeopped(x) ((x)->status |= CHFL_DEOPPED)
231 #define SetServOpOk(x) ((x)->status |= CHFL_SERVOPOK)
232 #define SetBurstJoined(x) ((x)->status |= CHFL_BURST_JOINED)
233 #define SetZombie(x) ((x)->status |= CHFL_ZOMBIE)
234 #define SetChannelManager(x) ((x)->status |= CHFL_CHANNEL_MANAGER)
235 #define SetOpLevel(x, v) (void)((x)->oplevel = (v))
236 #define SetUserParting(x) ((x)->status |= CHFL_USER_PARTING)
237 #define SetDelayedJoin(x) ((x)->status |= CHFL_DELAYED)
239 #define ClearBanned(x) ((x)->status &= ~CHFL_BANNED)
240 #define ClearBanValid(x) ((x)->status &= ~CHFL_BANVALID)
241 #define ClearDeopped(x) ((x)->status &= ~CHFL_DEOPPED)
242 #define ClearServOpOk(x) ((x)->status &= ~CHFL_SERVOPOK)
243 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
244 #define ClearDelayedJoin(x) ((x)->status &= ~CHFL_DELAYED)
245 #define ClearInvisibleJoin(x) ((x)->status &= ~CHFL_DELAYED)
247 /** Mode information for a channel */
252 char key[KEYLEN + 1];
253 char upass[KEYLEN + 1];
254 char apass[KEYLEN + 1];
255 char altchan[CHANNELLEN + 1];
258 #define BAN_IPMASK 0x0001 /**< ban mask is an IP-number mask */
259 #define BAN_OVERLAPPED 0x0002 /**< ban overlapped, need bounce */
260 #define BAN_BURSTED 0x0004 /**< Ban part of last BURST */
261 #define BAN_BURST_WIPEOUT 0x0008 /**< Ban will be wiped at EOB */
262 #define BAN_EXCEPTION 0x0010 /**< Ban is an exception */
263 #define BAN_DEL 0x4000 /**< Ban is being removed */
264 #define BAN_ADD 0x8000 /**< Ban is being added */
266 /** A single ban for a channel. */
268 struct Ban* next; /**< next ban in the channel */
269 struct irc_in_addr address; /**< address for BAN_IPMASK bans */
270 time_t when; /**< timestamp when ban was added */
271 unsigned short flags; /**< modifier flags for the ban */
272 unsigned char nu_len; /**< length of nick!user part of banstr */
273 unsigned char addrbits; /**< netmask length for BAN_IPMASK bans */
274 char who[NICKLEN+1]; /**< name of client that set the ban */
275 char banstr[NICKLEN+USERLEN+HOSTLEN+3]; /**< hostmask that the ban matches */
278 /** Information about a channel */
280 struct Channel* next; /**< next channel in the global channel list */
281 struct Channel* prev; /**< previous channel */
282 struct Channel* hnext; /**< Next channel in the hash table */
283 struct DestructEvent* destruct_event;
284 time_t creationtime; /**< Creation time of this channel */
285 time_t topic_time; /**< Modification time of the topic */
286 unsigned int users; /**< Number of clients on this channel */
287 struct Membership* members; /**< Pointer to the clients on this channel*/
288 struct SLink* invites; /**< List of invites on this channel */
289 struct Ban* banlist; /**< List of bans on this channel */
290 struct Mode mode; /**< This channels mode */
291 char topic[TOPICLEN + 1]; /**< Channels topic */
292 char topic_nick[NICKLEN + 1]; /**< Nick of the person who set
295 char chanowner[NICKLEN + 1]; //channel owner (auth)
296 char chname[1]; /**< Dynamically allocated string of the
301 /** Information about a /list in progress */
305 unsigned int max_users;
306 unsigned int min_users;
308 time_t max_topic_time;
309 time_t min_topic_time;
311 char wildcard[CHANNELLEN];
315 unsigned int mb_add; /**< Modes to add */
316 unsigned int mb_rem; /**< Modes to remove */
317 struct Client *mb_source; /**< Source of MODE changes */
318 struct Client *mb_connect; /**< Connection of MODE changes */
319 struct Channel *mb_channel; /**< Channel they affect */
320 unsigned int mb_dest; /**< Destination of MODE changes */
321 unsigned int mb_count; /**< Number of modes w/args */
323 unsigned int mbm_type; /**< Type of argument */
325 unsigned int mbma_uint; /**< A limit */
326 char *mbma_string; /**< A string */
327 struct Client *mbma_client; /**< A client */
328 } mbm_arg; /**< The mode argument */
329 unsigned short mbm_oplevel; /**< Oplevel for a bounce */
330 } mb_modeargs[MAXMODEPARAMS];
331 /**< A mode w/args */
334 #define MODEBUF_DEST_CHANNEL 0x00001 /**< Mode is flushed to channel */
335 #define MODEBUF_DEST_SERVER 0x00002 /**< Mode is flushed to server */
337 #define MODEBUF_DEST_OPMODE 0x00100 /**< Send server mode as OPMODE */
338 #define MODEBUF_DEST_DEOP 0x00200 /**< Deop the offender */
339 #define MODEBUF_DEST_BOUNCE 0x00400 /**< Bounce the modes */
340 #define MODEBUF_DEST_LOG 0x00800 /**< Log the mode changes to OPATH */
342 #define MODEBUF_DEST_HACK2 0x02000 /**< Send a HACK(2) notice, reverse */
343 #define MODEBUF_DEST_HACK3 0x04000 /**< Send a HACK(3) notice, TS == 0 */
344 #define MODEBUF_DEST_HACK4 0x08000 /**< Send a HACK(4) notice, TS == 0 */
346 #define MODEBUF_DEST_NOKEY 0x10000 /**< Don't send the real key */
348 #define MB_TYPE(mb, i) ((mb)->mb_modeargs[(i)].mbm_type)
349 #define MB_UINT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
350 #define MB_STRING(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
351 #define MB_CLIENT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
352 #define MB_OPLEVEL(mb, i) ((mb)->mb_modeargs[(i)].mbm_oplevel)
354 /** A buffer represeting a list of joins to send */
356 struct Client *jb_source; /**< Source of joins (ie, joiner) */
357 struct Client *jb_connect; /**< Connection of joiner */
358 unsigned int jb_type; /**< Type of join (JOIN or CREATE) */
359 char *jb_comment; /**< part comment */
360 time_t jb_create; /**< Creation timestamp */
361 unsigned int jb_count; /**< Number of channels */
362 unsigned int jb_strlen; /**< length so far */
363 struct Channel *jb_channels[MAXJOINARGS];
364 /**< channels joined or whatever */
367 #define JOINBUF_TYPE_JOIN 0 /**< send JOINs */
368 #define JOINBUF_TYPE_CREATE 1 /**< send CREATEs */
369 #define JOINBUF_TYPE_PART 2 /**< send PARTs */
370 #define JOINBUF_TYPE_PARTALL 3 /**< send local PARTs, but not remote */
372 extern struct Channel* GlobalChannelList;
373 extern int LocalChanOperMode;
378 extern void channel_modes(struct Client *cptr, char *mbuf, char *pbuf,
379 int buflen, struct Channel *chptr,
380 struct Membership *member);
381 extern int set_mode(struct Client* cptr, struct Client* sptr,
382 struct Channel* chptr, int parc, char* parv[],
383 char* mbuf, char* pbuf, char* npbuf, int* badop);
384 extern void send_hack_notice(struct Client *cptr, struct Client *sptr,
385 int parc, char *parv[], int badop, int mtype);
386 extern struct Channel *get_channel(struct Client *cptr,
387 char *chname, ChannelGetType flag);
388 extern struct Membership* find_member_link(struct Channel * chptr,
389 const struct Client* cptr);
390 extern int sub1_from_channel(struct Channel* chptr);
391 extern int destruct_channel(struct Channel* chptr);
392 extern void add_user_to_channel(struct Channel* chptr, struct Client* who,
393 unsigned int flags, int oplevel);
394 extern void make_zombie(struct Membership* member, struct Client* who,
395 struct Client* cptr, struct Client* sptr,
396 struct Channel* chptr);
397 extern struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing);
398 void add_invite(struct Client *cptr, struct Channel *chptr);
399 int number_of_zombies(struct Channel *chptr);
401 extern const char* find_no_nickchange_channel(struct Client* cptr);
402 extern struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr);
403 extern int member_can_send_to_channel(struct Membership* member, int reveal);
404 extern int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr, int reveal);
406 extern void remove_user_from_channel(struct Client *sptr, struct Channel *chptr);
407 extern void remove_user_from_all_channels(struct Client* cptr);
409 extern int is_chan_op(struct Client *cptr, struct Channel *chptr);
410 extern int is_zombie(struct Client *cptr, struct Channel *chptr);
411 extern int has_voice(struct Client *cptr, struct Channel *chptr);
413 NOTE: pointer is compared, and not dereferenced, called by
414 add_target with a void*, since targets could be anything,
415 this function can't make any assumptions that it has a channel
417 extern int IsInvited(struct Client* cptr, const void* chptr);
418 extern void send_channel_modes(struct Client *cptr, struct Channel *chptr);
419 extern char *pretty_mask(char *mask);
420 extern void del_invite(struct Client *cptr, struct Channel *chptr);
421 extern void list_set_default(void); /* this belongs elsewhere! */
423 extern void RevealDelayedJoinIfNeeded(struct Client *sptr, struct Channel *chptr);
424 extern void RevealDelayedJoin(struct Membership *member);
425 extern void CheckDelayedJoins(struct Channel *chan);
427 extern void modebuf_init(struct ModeBuf *mbuf, struct Client *source,
428 struct Client *connect, struct Channel *chan,
430 extern void modebuf_mode(struct ModeBuf *mbuf, unsigned int mode);
431 extern void modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode,
433 extern void modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode,
434 char *string, int free);
435 extern void modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
436 struct Client *client, int oplevel);
437 extern int modebuf_flush(struct ModeBuf *mbuf);
438 extern void modebuf_extract(struct ModeBuf *mbuf, char *buf);
440 extern void mode_ban_invalidate(struct Channel *chan);
441 extern void mode_invite_clear(struct Channel *chan);
443 extern int mode_parse(struct ModeBuf *mbuf, struct Client *cptr,
444 struct Client *sptr, struct Channel *chptr,
445 int parc, char *parv[], unsigned int flags,
446 struct Membership* member);
448 #define MODE_PARSE_SET 0x01 /**< actually set channel modes */
449 #define MODE_PARSE_STRICT 0x02 /**< +m +n +t style not supported */
450 #define MODE_PARSE_FORCE 0x04 /**< force the mode to be applied */
451 #define MODE_PARSE_BOUNCE 0x08 /**< we will be bouncing the modes */
452 #define MODE_PARSE_NOTOPER 0x10 /**< send "not chanop" to user */
453 #define MODE_PARSE_NOTMEMBER 0x20 /**< send "not member" to user */
454 #define MODE_PARSE_WIPEOUT 0x40 /**< wipe out +k and +l during burst */
455 #define MODE_PARSE_BURST 0x80 /**< be even more strict w/extra args */
457 extern void joinbuf_init(struct JoinBuf *jbuf, struct Client *source,
458 struct Client *connect, unsigned int type,
459 char *comment, time_t create);
460 extern void joinbuf_join(struct JoinBuf *jbuf, struct Channel *chan,
462 extern int joinbuf_flush(struct JoinBuf *jbuf);
463 extern struct Ban *make_ban(const char *banstr);
464 extern struct Ban *find_ban(struct Client *cptr, struct Ban *banlist);
465 extern int apply_ban(struct Ban **banlist, struct Ban *newban, int free);
466 extern void free_ban(struct Ban *ban);
467 extern signed int destruct_nonpers_channel(struct Channel *chptr);
468 extern int ext_amsg_block(struct Client *cptr, struct Channel *chptr, const char *msg);
470 #endif /* INCLUDED_channel_h */