]>
jfr.im git - irc/quakenet/snircd.git/blob - include/channel.h
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,v 1.55 2005/09/27 02:41:57 entrope Exp $
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 */
85 #define CHFL_OVERLAP (CHFL_CHANOP | CHFL_VOICE)
86 #define CHFL_BANVALIDMASK (CHFL_BANVALID | CHFL_BANNED)
87 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
89 /* Channel Visibility macros */
91 #define MODE_CHANOP CHFL_CHANOP /**< +o Chanop */
92 #define MODE_VOICE CHFL_VOICE /**< +v Voice */
93 #define MODE_PRIVATE 0x0004 /**< +p Private */
94 #define MODE_SECRET 0x0008 /**< +s Secret */
95 #define MODE_MODERATED 0x0010 /**< +m Moderated */
96 #define MODE_TOPICLIMIT 0x0020 /**< +t Topic Limited */
97 #define MODE_INVITEONLY 0x0040 /**< +i Invite only */
98 #define MODE_NOPRIVMSGS 0x0080 /**< +n No Private Messages */
99 #define MODE_KEY 0x0100 /**< +k Keyed */
100 #define MODE_BAN 0x0200 /**< +b Ban */
101 #define MODE_LIMIT 0x0400 /**< +l Limit */
102 #define MODE_REGONLY 0x0800 /**< Only +r users may join */
103 #define MODE_DELJOINS 0x1000 /**< New join messages are delayed */
104 #define MODE_SAVE 0x20000 /**< save this mode-with-arg 'til
106 #define MODE_FREE 0x40000 /**< string needs to be passed to
108 #define MODE_BURSTADDED 0x80000 /**< channel was created by a BURST */
109 #define MODE_UPASS 0x100000
110 #define MODE_APASS 0x200000
111 #define MODE_WASDELJOINS 0x400000 /**< Not DELJOINS, but some joins
113 /** mode flags which take another parameter (With PARAmeterS)
115 #define MODE_WPARAS (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT|MODE_APASS|MODE_UPASS)
117 /** Available Channel modes */
118 #define infochanmodes feature_bool(FEAT_OPLEVELS) ? "AbiklmnopstUvrD" : "biklmnopstvrD"
119 /** Available Channel modes that take parameters */
120 #define infochanmodeswithparams feature_bool(FEAT_OPLEVELS) ? "AbkloUv" : "bklov"
122 #define HoldChannel(x) (!(x))
123 /** name invisible */
124 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
125 /** channel not shown but names are */
126 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
127 /** channel visible */
128 #define ShowChannel(v,c) (PubChannel(c) || find_channel_member((v),(c)))
129 #define PubChannel(x) ((!x) || ((x)->mode.mode & \
130 (MODE_PRIVATE | MODE_SECRET)) == 0)
132 #define IsGlobalChannel(name) (*(name) == '#')
133 #define IsLocalChannel(name) (*(name) == '&')
134 #define IsChannelName(name) (IsGlobalChannel(name) || IsLocalChannel(name))
136 typedef enum ChannelGetType
{
141 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
144 #define MODE_ADD 0x40000000
145 #define MODE_DEL 0x20000000
147 /* used in ListingArgs.flags */
149 #define LISTARG_TOPICLIMITS 0x0001
150 #define LISTARG_SHOWSECRET 0x0002
151 #define LISTARG_NEGATEWILDCARD 0x0004
154 * Maximum acceptable lag time in seconds: A channel younger than
155 * this is not protected against hacking admins.
156 * Mainly here to check if the TS clocks really sync (otherwise this
157 * will start causing HACK notices.
158 * This value must be the same on all servers.
160 * This value has been increased to 1 day in order to distinguish this
161 * "normal" type of HACK wallops / desyncs, from possiblity still
164 #define TS_LAG_TIME 86400
167 * A Magic TS that is used for channels that are created by JOIN,
168 * a channel with this TS accepts all TS without complaining that
169 * it might receive later via MODE or CREATE.
171 * Part of the P9 compatibility, shouldn't occur on a P10 network.
173 #define MAGIC_REMOTE_JOIN_TS 1270080000
177 extern const char* const PartFmt1
;
178 extern const char* const PartFmt2
;
179 extern const char* const PartFmt1serv
;
180 extern const char* const PartFmt2serv
;
187 /** Information about a client on one channel
189 * This structure forms a sparse matrix with users down the side, and
190 * channels across the top. This matrix holds all the information about
191 * which users are on what channels, and what modes that user has on that
192 * channel (if they are op'd, voice'd and cached information if they are
196 struct Client
* user
; /**< The user */
197 struct Channel
* channel
; /**< The channel */
198 struct Membership
* next_member
; /**< The next user on this channel */
199 struct Membership
* prev_member
; /**< The previous user on this channel*/
200 struct Membership
* next_channel
; /**< Next channel this user is on */
201 struct Membership
* prev_channel
; /**< Previous channel this user is on*/
202 unsigned int status
; /**< Flags for op'd, voice'd, etc */
203 unsigned short oplevel
; /**< Op level */
206 #define MAXOPLEVELDIGITS 3
207 #define MAXOPLEVEL 999
209 #define IsZombie(x) ((x)->status & CHFL_ZOMBIE) /**< see \ref zombie */
210 #define IsDeopped(x) ((x)->status & CHFL_DEOPPED)
211 #define IsBanned(x) ((x)->status & CHFL_BANNED)
212 #define IsBanValid(x) ((x)->status & CHFL_BANVALID)
213 #define IsChanOp(x) ((x)->status & CHFL_CHANOP)
214 #define OpLevel(x) ((x)->oplevel)
215 #define HasVoice(x) ((x)->status & CHFL_VOICE)
216 #define IsServOpOk(x) ((x)->status & CHFL_SERVOPOK)
217 #define IsBurstJoined(x) ((x)->status & CHFL_BURST_JOINED)
218 #define IsVoicedOrOpped(x) ((x)->status & CHFL_VOICED_OR_OPPED)
219 #define IsChannelManager(x) ((x)->status & CHFL_CHANNEL_MANAGER)
220 #define IsUserParting(x) ((x)->status & CHFL_USER_PARTING)
221 #define IsDelayedJoin(x) ((x)->status & CHFL_DELAYED)
223 #define SetBanned(x) ((x)->status |= CHFL_BANNED)
224 #define SetBanValid(x) ((x)->status |= CHFL_BANVALID)
225 #define SetDeopped(x) ((x)->status |= CHFL_DEOPPED)
226 #define SetServOpOk(x) ((x)->status |= CHFL_SERVOPOK)
227 #define SetBurstJoined(x) ((x)->status |= CHFL_BURST_JOINED)
228 #define SetZombie(x) ((x)->status |= CHFL_ZOMBIE)
229 #define SetChannelManager(x) ((x)->status |= CHFL_CHANNEL_MANAGER)
230 #define SetOpLevel(x, v) (void)((x)->oplevel = (v))
231 #define SetUserParting(x) ((x)->status |= CHFL_USER_PARTING)
232 #define SetDelayedJoin(x) ((x)->status |= CHFL_DELAYED)
234 #define ClearBanned(x) ((x)->status &= ~CHFL_BANNED)
235 #define ClearBanValid(x) ((x)->status &= ~CHFL_BANVALID)
236 #define ClearDeopped(x) ((x)->status &= ~CHFL_DEOPPED)
237 #define ClearServOpOk(x) ((x)->status &= ~CHFL_SERVOPOK)
238 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
239 #define ClearDelayedJoin(x) ((x)->status &= ~CHFL_DELAYED)
241 /** Mode information for a channel */
245 char key
[KEYLEN
+ 1];
246 char upass
[KEYLEN
+ 1];
247 char apass
[KEYLEN
+ 1];
250 #define BAN_IPMASK 0x0001 /**< ban mask is an IP-number mask */
251 #define BAN_OVERLAPPED 0x0002 /**< ban overlapped, need bounce */
252 #define BAN_BURSTED 0x0004 /**< Ban part of last BURST */
253 #define BAN_BURST_WIPEOUT 0x0008 /**< Ban will be wiped at EOB */
254 #define BAN_EXCEPTION 0x0010 /**< Ban is an exception */
255 #define BAN_DEL 0x4000 /**< Ban is being removed */
256 #define BAN_ADD 0x8000 /**< Ban is being added */
258 /** A single ban for a channel. */
260 struct Ban
* next
; /**< next ban in the channel */
261 struct irc_in_addr address
; /**< addres for BAN_IPMASK bans */
262 time_t when
; /**< timestamp when ban was added */
263 unsigned short flags
; /**< modifier flags for the ban */
264 unsigned char nu_len
; /**< length of nick!user part of banstr */
265 unsigned char addrbits
; /**< netmask length for BAN_IPMASK bans */
266 char who
[NICKLEN
+1]; /**< name of client that set the ban */
267 char banstr
[NICKLEN
+USERLEN
+HOSTLEN
+3]; /**< hostmask that the ban matches */
270 /** Information about a channel */
272 struct Channel
* next
; /**< next channel in the global channel list */
273 struct Channel
* prev
; /**< previous channel */
274 struct Channel
* hnext
; /**< Next channel in the hash table */
275 struct DestructEvent
* destruct_event
;
276 time_t creationtime
; /**< Creation time of this channel */
277 time_t topic_time
; /**< Modification time of the topic */
278 unsigned int users
; /**< Number of clients on this channel */
279 struct Membership
* members
; /**< Pointer to the clients on this channel*/
280 struct SLink
* invites
; /**< List of invites on this channel */
281 struct Ban
* banlist
; /**< List of bans on this channel */
282 struct Mode mode
; /**< This channels mode */
283 char topic
[TOPICLEN
+ 1]; /**< Channels topic */
284 char topic_nick
[NICKLEN
+ 1]; /**< Nick of the person who set
287 char chname
[1]; /**< Dynamically allocated string of the
292 /** Information about a /list in progress */
296 unsigned int max_users
;
297 unsigned int min_users
;
299 time_t max_topic_time
;
300 time_t min_topic_time
;
302 char wildcard
[CHANNELLEN
];
306 unsigned int mb_add
; /**< Modes to add */
307 unsigned int mb_rem
; /**< Modes to remove */
308 struct Client
*mb_source
; /**< Source of MODE changes */
309 struct Client
*mb_connect
; /**< Connection of MODE changes */
310 struct Channel
*mb_channel
; /**< Channel they affect */
311 unsigned int mb_dest
; /**< Destination of MODE changes */
312 unsigned int mb_count
; /**< Number of modes w/args */
314 unsigned int mbm_type
; /**< Type of argument */
316 unsigned int mbma_uint
; /**< A limit */
317 char *mbma_string
; /**< A string */
318 struct Client
*mbma_client
; /**< A client */
319 } mbm_arg
; /**< The mode argument */
320 unsigned short mbm_oplevel
; /**< Oplevel for a bounce */
321 } mb_modeargs
[MAXMODEPARAMS
];
322 /**< A mode w/args */
325 #define MODEBUF_DEST_CHANNEL 0x00001 /**< Mode is flushed to channel */
326 #define MODEBUF_DEST_SERVER 0x00002 /**< Mode is flushed to server */
328 #define MODEBUF_DEST_OPMODE 0x00100 /**< Send server mode as OPMODE */
329 #define MODEBUF_DEST_DEOP 0x00200 /**< Deop the offender */
330 #define MODEBUF_DEST_BOUNCE 0x00400 /**< Bounce the modes */
331 #define MODEBUF_DEST_LOG 0x00800 /**< Log the mode changes to OPATH */
333 #define MODEBUF_DEST_HACK2 0x02000 /**< Send a HACK(2) notice, reverse */
334 #define MODEBUF_DEST_HACK3 0x04000 /**< Send a HACK(3) notice, TS == 0 */
335 #define MODEBUF_DEST_HACK4 0x08000 /**< Send a HACK(4) notice, TS == 0 */
337 #define MODEBUF_DEST_NOKEY 0x10000 /**< Don't send the real key */
339 #define MB_TYPE(mb, i) ((mb)->mb_modeargs[(i)].mbm_type)
340 #define MB_UINT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
341 #define MB_STRING(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
342 #define MB_CLIENT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
343 #define MB_OPLEVEL(mb, i) ((mb)->mb_modeargs[(i)].mbm_oplevel)
345 /** A buffer represeting a list of joins to send */
347 struct Client
*jb_source
; /**< Source of joins (ie, joiner) */
348 struct Client
*jb_connect
; /**< Connection of joiner */
349 unsigned int jb_type
; /**< Type of join (JOIN or CREATE) */
350 char *jb_comment
; /**< part comment */
351 time_t jb_create
; /**< Creation timestamp */
352 unsigned int jb_count
; /**< Number of channels */
353 unsigned int jb_strlen
; /**< length so far */
354 struct Channel
*jb_channels
[MAXJOINARGS
];
355 /**< channels joined or whatever */
358 #define JOINBUF_TYPE_JOIN 0 /**< send JOINs */
359 #define JOINBUF_TYPE_CREATE 1 /**< send CREATEs */
360 #define JOINBUF_TYPE_PART 2 /**< send PARTs */
361 #define JOINBUF_TYPE_PARTALL 3 /**< send local PARTs, but not remote */
363 extern struct Channel
* GlobalChannelList
;
364 extern int LocalChanOperMode
;
369 extern void channel_modes(struct Client
*cptr
, char *mbuf
, char *pbuf
,
370 int buflen
, struct Channel
*chptr
,
371 struct Membership
*member
);
372 extern int set_mode(struct Client
* cptr
, struct Client
* sptr
,
373 struct Channel
* chptr
, int parc
, char* parv
[],
374 char* mbuf
, char* pbuf
, char* npbuf
, int* badop
);
375 extern void send_hack_notice(struct Client
*cptr
, struct Client
*sptr
,
376 int parc
, char *parv
[], int badop
, int mtype
);
377 extern struct Channel
*get_channel(struct Client
*cptr
,
378 char *chname
, ChannelGetType flag
);
379 extern struct Membership
* find_member_link(struct Channel
* chptr
,
380 const struct Client
* cptr
);
381 extern int sub1_from_channel(struct Channel
* chptr
);
382 extern int destruct_channel(struct Channel
* chptr
);
383 extern void add_user_to_channel(struct Channel
* chptr
, struct Client
* who
,
384 unsigned int flags
, int oplevel
);
385 extern void make_zombie(struct Membership
* member
, struct Client
* who
,
386 struct Client
* cptr
, struct Client
* sptr
,
387 struct Channel
* chptr
);
388 extern struct Client
* find_chasing(struct Client
* sptr
, const char* user
, int* chasing
);
389 void add_invite(struct Client
*cptr
, struct Channel
*chptr
);
390 int number_of_zombies(struct Channel
*chptr
);
392 extern const char* find_no_nickchange_channel(struct Client
* cptr
);
393 extern struct Membership
* find_channel_member(struct Client
* cptr
, struct Channel
* chptr
);
394 extern int member_can_send_to_channel(struct Membership
* member
, int reveal
);
395 extern int client_can_send_to_channel(struct Client
*cptr
, struct Channel
*chptr
, int reveal
);
397 extern void remove_user_from_channel(struct Client
*sptr
, struct Channel
*chptr
);
398 extern void remove_user_from_all_channels(struct Client
* cptr
);
400 extern int is_chan_op(struct Client
*cptr
, struct Channel
*chptr
);
401 extern int is_zombie(struct Client
*cptr
, struct Channel
*chptr
);
402 extern int has_voice(struct Client
*cptr
, struct Channel
*chptr
);
404 NOTE: pointer is compared, and not dereferenced, called by
405 add_target with a void*, since targets could be anything,
406 this function can't make any assumptions that it has a channel
408 extern int IsInvited(struct Client
* cptr
, const void* chptr
);
409 extern void send_channel_modes(struct Client
*cptr
, struct Channel
*chptr
);
410 extern char *pretty_mask(char *mask
);
411 extern void del_invite(struct Client
*cptr
, struct Channel
*chptr
);
412 extern void list_set_default(void); /* this belongs elsewhere! */
414 extern void RevealDelayedJoin(struct Membership
*member
);
415 extern void CheckDelayedJoins(struct Channel
*chan
);
417 extern void modebuf_init(struct ModeBuf
*mbuf
, struct Client
*source
,
418 struct Client
*connect
, struct Channel
*chan
,
420 extern void modebuf_mode(struct ModeBuf
*mbuf
, unsigned int mode
);
421 extern void modebuf_mode_uint(struct ModeBuf
*mbuf
, unsigned int mode
,
423 extern void modebuf_mode_string(struct ModeBuf
*mbuf
, unsigned int mode
,
424 char *string
, int free
);
425 extern void modebuf_mode_client(struct ModeBuf
*mbuf
, unsigned int mode
,
426 struct Client
*client
, int oplevel
);
427 extern int modebuf_flush(struct ModeBuf
*mbuf
);
428 extern void modebuf_extract(struct ModeBuf
*mbuf
, char *buf
);
430 extern void mode_ban_invalidate(struct Channel
*chan
);
431 extern void mode_invite_clear(struct Channel
*chan
);
433 extern int mode_parse(struct ModeBuf
*mbuf
, struct Client
*cptr
,
434 struct Client
*sptr
, struct Channel
*chptr
,
435 int parc
, char *parv
[], unsigned int flags
,
436 struct Membership
* member
);
438 #define MODE_PARSE_SET 0x01 /**< actually set channel modes */
439 #define MODE_PARSE_STRICT 0x02 /**< +m +n +t style not supported */
440 #define MODE_PARSE_FORCE 0x04 /**< force the mode to be applied */
441 #define MODE_PARSE_BOUNCE 0x08 /**< we will be bouncing the modes */
442 #define MODE_PARSE_NOTOPER 0x10 /**< send "not chanop" to user */
443 #define MODE_PARSE_NOTMEMBER 0x20 /**< send "not member" to user */
444 #define MODE_PARSE_WIPEOUT 0x40 /**< wipe out +k and +l during burst */
445 #define MODE_PARSE_BURST 0x80 /**< be even more strict w/extra args */
447 extern void joinbuf_init(struct JoinBuf
*jbuf
, struct Client
*source
,
448 struct Client
*connect
, unsigned int type
,
449 char *comment
, time_t create
);
450 extern void joinbuf_join(struct JoinBuf
*jbuf
, struct Channel
*chan
,
452 extern int joinbuf_flush(struct JoinBuf
*jbuf
);
453 extern struct Ban
*make_ban(const char *banstr
);
454 extern struct Ban
*find_ban(struct Client
*cptr
, struct Ban
*banlist
);
455 extern int apply_ban(struct Ban
**banlist
, struct Ban
*newban
, int free
);
456 extern void free_ban(struct Ban
*ban
);
458 #endif /* INCLUDED_channel_h */