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.
22 #ifndef INCLUDED_channel_h
23 #define INCLUDED_channel_h
24 #ifndef INCLUDED_ircd_defs_h
25 #include "ircd_defs.h" /* NICKLEN */
27 #ifndef INCLUDED_sys_types_h
28 #include <sys/types.h>
29 #define INCLUDED_sys_types_h
39 #define MAXMODEPARAMS 6
40 #define MODEBUFLEN 200
44 #define CHANNELLEN 200
46 #define MAXJOINARGS 15 /* number of slots for join buffer */
47 #define STARTJOINLEN 10 /* fuzzy numbers */
48 #define STARTCREATELEN 20
54 #define ChannelExists(n) (0 != FindChannel(n))
56 #define CHFL_CHANOP 0x0001 /* Channel operator */
57 #define CHFL_VOICE 0x0002 /* the power to speak */
58 #define CHFL_DEOPPED 0x0004 /* Is de-opped by a server */
59 #define CHFL_SERVOPOK 0x0008 /* Server op allowed */
60 #define CHFL_ZOMBIE 0x0010 /* Kicked from channel */
61 #define CHFL_BAN 0x0020 /* ban channel flag */
62 #define CHFL_BAN_IPMASK 0x0040 /* ban mask is an IP-number mask */
63 #define CHFL_BAN_OVERLAPPED 0x0080 /* ban overlapped, need bounce */
64 #define CHFL_BURST_JOINED 0x0100 /* Just joined by net.junction */
65 #define CHFL_BURST_BAN 0x0200 /* Ban part of last BURST */
66 #define CHFL_BURST_BAN_WIPEOUT 0x0400 /* Ban will be wiped at end of BURST */
67 #define CHFL_BANVALID 0x0800 /* CHFL_BANNED bit is valid */
68 #define CHFL_BANNED 0x1000 /* Channel member is banned */
69 #define CHFL_SILENCE_IPMASK 0x2000 /* silence mask is an IP-number mask */
70 #define CHFL_BURST_ALREADY_OPPED 0x04000 /* In oob BURST, but was already joined and opped */
71 #define CHFL_BURST_ALREADY_VOICED 0x08000 /* In oob BURST, but was already joined and voiced */
73 #define CHFL_OVERLAP (CHFL_CHANOP | CHFL_VOICE)
74 #define CHFL_BANVALIDMASK (CHFL_BANVALID | CHFL_BANNED)
75 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
77 /* Channel Visibility macros */
79 #define MODE_CHANOP CHFL_CHANOP
80 #define MODE_VOICE CHFL_VOICE
81 #define MODE_PRIVATE 0x0004
82 #define MODE_SECRET 0x0008
83 #define MODE_MODERATED 0x0010
84 #define MODE_TOPICLIMIT 0x0020
85 #define MODE_INVITEONLY 0x0040
86 #define MODE_NOPRIVMSGS 0x0080
87 #define MODE_KEY 0x0100
88 #define MODE_BAN 0x0200
89 #define MODE_LIMIT 0x0400
90 #define MODE_REGONLY 0x0800 /* Only +r users may join */
91 #define MODE_LISTED 0x10000
92 #define MODE_SAVE 0x20000 /* save this mode-with-arg 'til later */
93 #define MODE_FREE 0x40000 /* string needs to be passed to MyFree() */
94 #define MODE_BURSTADDED 0x80000 /* channel was created by a BURST */
95 #define MODE_UPASS 0x100000
96 #define MODE_APASS 0x200000
98 * mode flags which take another parameter (With PARAmeterS)
100 #define MODE_WPARAS (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT|MODE_APASS|MODE_UPASS)
102 #define HoldChannel(x) (!(x))
104 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
105 /* channel not shown but names are */
106 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
107 /* channel visible */
108 #define ShowChannel(v,c) (PubChannel(c) || find_channel_member((v),(c)))
109 #define PubChannel(x) ((!x) || ((x)->mode.mode & \
110 (MODE_PRIVATE | MODE_SECRET)) == 0)
111 #define is_listed(x) ((x)->mode.mode & MODE_LISTED)
113 #define IsLocalChannel(name) (*(name) == '&')
114 #define IsModelessChannel(name) (*(name) == '+')
115 #define IsChannelName(name) (*(name) == '#' || \
116 IsModelessChannel(name) || IsLocalChannel(name))
118 typedef enum ChannelGetType {
123 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
126 #define MODE_ADD 0x40000000
127 #define MODE_DEL 0x20000000
130 * Maximum acceptable lag time in seconds: A channel younger than
131 * this is not protected against hacking admins.
132 * Mainly here to check if the TS clocks really sync (otherwise this
133 * will start causing HACK notices.
134 * This value must be the same on all servers.
136 * This value has been increased to 1 day in order to distinguish this
137 * "normal" type of HACK wallops / desyncs, from possiblity still
140 #define TS_LAG_TIME 86400
143 * A Magic TS that is used for channels that are created by JOIN,
144 * a channel with this TS accepts all TS without complaining that
145 * it might receive later via MODE or CREATE.
147 #define MAGIC_REMOTE_JOIN_TS 1270080000
150 * used in can_join to determine if an oper forced a join on a channel
152 #define MAGIC_OPER_OVERRIDE 1000
155 extern const char* const PartFmt1;
156 extern const char* const PartFmt2;
157 extern const char* const PartFmt1serv;
158 extern const char* const PartFmt2serv;
167 struct Channel* channel;
168 struct Membership* next_member;
169 struct Membership* prev_member;
170 struct Membership* next_channel;
171 struct Membership* prev_channel;
173 unsigned short oplevel;
176 #define MAXOPLEVELDIGITS 3
177 #define MAXOPLEVEL 999
179 #define IsZombie(x) ((x)->status & CHFL_ZOMBIE)
180 #define IsDeopped(x) ((x)->status & CHFL_DEOPPED)
181 #define IsBanned(x) ((x)->status & CHFL_BANNED)
182 #define IsBanValid(x) ((x)->status & CHFL_BANVALID)
183 #define IsChanOp(x) ((x)->status & CHFL_CHANOP)
184 #define OpLevel(x) ((x)->oplevel)
185 #define HasVoice(x) ((x)->status & CHFL_VOICE)
186 #define IsServOpOk(x) ((x)->status & CHFL_SERVOPOK)
187 #define IsBurstJoined(x) ((x)->status & CHFL_BURST_JOINED)
188 #define IsVoicedOrOpped(x) ((x)->status & CHFL_VOICED_OR_OPPED)
190 #define SetBanned(x) ((x)->status |= CHFL_BANNED)
191 #define SetBanValid(x) ((x)->status |= CHFL_BANVALID)
192 #define SetDeopped(x) ((x)->status |= CHFL_DEOPPED)
193 #define SetServOpOk(x) ((x)->status |= CHFL_SERVOPOK)
194 #define SetBurstJoined(x) ((x)->status |= CHFL_BURST_JOINED)
195 #define SetZombie(x) ((x)->status |= CHFL_ZOMBIE)
196 #define SetOpLevel(x, v) (void)((x)->oplevel = (v))
198 #define ClearBanned(x) ((x)->status &= ~CHFL_BANNED)
199 #define ClearBanValid(x) ((x)->status &= ~CHFL_BANVALID)
200 #define ClearDeopped(x) ((x)->status &= ~CHFL_DEOPPED)
201 #define ClearServOpOk(x) ((x)->status &= ~CHFL_SERVOPOK)
202 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
208 char key[KEYLEN + 1];
209 char upass[PASSLEN + 1];
210 char apass[PASSLEN + 1];
214 struct Channel* next;
215 struct Channel* prev;
216 struct Channel* hnext;
217 struct DestructEvent* destruct_event;
221 struct Membership* members;
222 struct SLink* invites;
223 struct SLink* banlist;
225 char topic[TOPICLEN + 1];
226 char topic_nick[NICKLEN + 1];
233 unsigned int max_users;
234 unsigned int min_users;
235 unsigned int topic_limits;
236 time_t max_topic_time;
237 time_t min_topic_time;
238 struct Channel *chptr;
242 unsigned int mb_add; /* Modes to add */
243 unsigned int mb_rem; /* Modes to remove */
244 struct Client *mb_source; /* Source of MODE changes */
245 struct Client *mb_connect; /* Connection of MODE changes */
246 struct Channel *mb_channel; /* Channel they affect */
247 unsigned int mb_dest; /* Destination of MODE changes */
248 unsigned int mb_count; /* Number of modes w/args */
250 unsigned int mbm_type; /* Type of argument */
252 unsigned int mbma_uint; /* A limit */
253 char *mbma_string; /* A string */
254 struct Client *mbma_client; /* A client */
255 } mbm_arg; /* The mode argument */
256 } mb_modeargs[MAXMODEPARAMS];
260 #define MODEBUF_DEST_CHANNEL 0x0001 /* Mode is flushed to channel */
261 #define MODEBUF_DEST_SERVER 0x0002 /* Mode is flushed to server */
263 #define MODEBUF_DEST_OPMODE 0x0100 /* Send server mode as OPMODE */
264 #define MODEBUF_DEST_DEOP 0x0200 /* Deop the offender */
265 #define MODEBUF_DEST_BOUNCE 0x0400 /* Bounce the modes */
266 #define MODEBUF_DEST_LOG 0x0800 /* Log the mode changes to OPATH */
268 #define MODEBUF_DEST_HACK2 0x2000 /* Send a HACK(2) notice, reverse */
269 #define MODEBUF_DEST_HACK3 0x4000 /* Send a HACK(3) notice, TS == 0 */
270 #define MODEBUF_DEST_HACK4 0x8000 /* Send a HACK(4) notice, TS == 0 */
272 #define MB_TYPE(mb, i) ((mb)->mb_modeargs[(i)].mbm_type)
273 #define MB_UINT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
274 #define MB_STRING(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
275 #define MB_CLIENT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
278 struct Client *jb_source; /* Source of joins (ie, joiner) */
279 struct Client *jb_connect; /* Connection of joiner */
280 unsigned int jb_type; /* Type of join (JOIN or CREATE) */
281 char *jb_comment; /* part comment */
282 time_t jb_create; /* Creation timestamp */
283 unsigned int jb_count; /* Number of channels */
284 unsigned int jb_strlen; /* length so far */
285 struct Channel *jb_channels[MAXJOINARGS];
286 /* channels joined or whatever */
289 #define JOINBUF_TYPE_JOIN 0 /* send JOINs */
290 #define JOINBUF_TYPE_CREATE 1 /* send CREATEs */
291 #define JOINBUF_TYPE_PART 2 /* send PARTs */
292 #define JOINBUF_TYPE_PARTALL 3 /* send local PARTs, but not remote */
294 extern struct Channel* GlobalChannelList;
295 extern int LocalChanOperMode;
300 extern void clean_channelname(char* name);
301 extern void channel_modes(struct Client *cptr, char *mbuf, char *pbuf,
302 int buflen, struct Channel *chptr);
303 extern int set_mode(struct Client* cptr, struct Client* sptr,
304 struct Channel* chptr, int parc, char* parv[],
305 char* mbuf, char* pbuf, char* npbuf, int* badop);
306 extern void send_hack_notice(struct Client *cptr, struct Client *sptr,
307 int parc, char *parv[], int badop, int mtype);
308 extern struct Channel *get_channel(struct Client *cptr,
309 char *chname, ChannelGetType flag);
310 extern struct Membership* find_member_link(struct Channel * chptr,
311 const struct Client* cptr);
312 extern int sub1_from_channel(struct Channel* chptr);
313 extern int destruct_channel(struct Channel* chptr);
314 extern int can_join(struct Client *sptr, struct Channel *chptr, char *key);
315 extern void add_user_to_channel(struct Channel* chptr, struct Client* who,
316 unsigned int flags, int oplevel);
317 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
318 const char *param, int *count);
319 extern void add_token_to_sendbuf(char *token, size_t *sblenp, int *firstp,
320 int *send_itp, char is_a_ban, int mode);
321 extern int add_banid(struct Client *cptr, struct Channel *chptr, char *banid,
322 int change, int firsttime);
323 extern struct SLink *next_removed_overlapped_ban(void);
324 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
325 const char *param, int *count);
326 extern void make_zombie(struct Membership* member, struct Client* who,
327 struct Client* cptr, struct Client* sptr,
328 struct Channel* chptr);
329 extern struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing);
330 void add_invite(struct Client *cptr, struct Channel *chptr);
331 int number_of_zombies(struct Channel *chptr);
333 extern const char* find_no_nickchange_channel(struct Client* cptr);
334 extern struct Membership* IsMember(struct Client *cptr, struct Channel *chptr);
335 extern struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr);
336 extern int member_can_send_to_channel(struct Membership* member);
337 extern int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr);
339 extern void remove_user_from_channel(struct Client *sptr, struct Channel *chptr);
340 extern void remove_user_from_all_channels(struct Client* cptr);
342 extern int is_chan_op(struct Client *cptr, struct Channel *chptr);
343 extern int is_zombie(struct Client *cptr, struct Channel *chptr);
344 extern int has_voice(struct Client *cptr, struct Channel *chptr);
345 extern void send_channel_modes(struct Client *cptr, struct Channel *chptr);
346 extern char *pretty_mask(char *mask);
347 extern void del_invite(struct Client *cptr, struct Channel *chptr);
348 extern void list_next_channels(struct Client *cptr, int nr);
349 extern void list_set_default(void); /* this belongs elsewhere! */
351 extern void modebuf_init(struct ModeBuf *mbuf, struct Client *source,
352 struct Client *connect, struct Channel *chan,
354 extern void modebuf_mode(struct ModeBuf *mbuf, unsigned int mode);
355 extern void modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode,
357 extern void modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode,
358 char *string, int free);
359 extern void modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
360 struct Client *client);
361 extern int modebuf_flush(struct ModeBuf *mbuf);
362 extern void modebuf_extract(struct ModeBuf *mbuf, char *buf);
364 extern void mode_ban_invalidate(struct Channel *chan);
365 extern void mode_invite_clear(struct Channel *chan);
367 extern int mode_parse(struct ModeBuf *mbuf, struct Client *cptr,
368 struct Client *sptr, struct Channel *chptr,
369 int parc, char *parv[], unsigned int flags,
370 struct Membership* member);
372 #define MODE_PARSE_SET 0x01 /* actually set channel modes */
373 #define MODE_PARSE_STRICT 0x02 /* +m +n +t style not supported */
374 #define MODE_PARSE_FORCE 0x04 /* force the mode to be applied */
375 #define MODE_PARSE_BOUNCE 0x08 /* we will be bouncing the modes */
376 #define MODE_PARSE_NOTOPER 0x10 /* send "not chanop" to user */
377 #define MODE_PARSE_NOTMEMBER 0x20 /* send "not member" to user */
378 #define MODE_PARSE_WIPEOUT 0x40 /* wipe out +k and +l during burst */
379 #define MODE_PARSE_BURST 0x80 /* be even more strict w/extra args */
381 extern void joinbuf_init(struct JoinBuf *jbuf, struct Client *source,
382 struct Client *connect, unsigned int type,
383 char *comment, time_t create);
384 extern void joinbuf_join(struct JoinBuf *jbuf, struct Channel *chan,
386 extern int joinbuf_flush(struct JoinBuf *jbuf);
388 #endif /* INCLUDED_channel_h */