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_config_h
27 #ifndef INCLUDED_ircd_defs_h
28 #include "ircd_defs.h" /* NICKLEN */
30 #ifndef INCLUDED_sys_types_h
31 #include <sys/types.h>
32 #define INCLUDED_sys_types_h
42 #define MAXMODEPARAMS 6
43 #define MODEBUFLEN 200
46 #define CHANNELLEN 200
48 #define MAXBANLENGTH 1024
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 */
71 #define CHFL_OVERLAP (CHFL_CHANOP | CHFL_VOICE)
72 #define CHFL_BANVALIDMASK (CHFL_BANVALID | CHFL_BANNED)
73 #define CHFL_VOICED_OR_OPPED (CHFL_CHANOP | CHFL_VOICE)
75 /* Channel Visibility macros */
77 #define MODE_CHANOP CHFL_CHANOP
78 #define MODE_VOICE CHFL_VOICE
79 #define MODE_PRIVATE 0x0004
80 #define MODE_SECRET 0x0008
81 #define MODE_MODERATED 0x0010
82 #define MODE_TOPICLIMIT 0x0020
83 #define MODE_INVITEONLY 0x0040
84 #define MODE_NOPRIVMSGS 0x0080
85 #define MODE_KEY 0x0100
86 #define MODE_BAN 0x0200
87 #define MODE_LIMIT 0x0400
88 #define MODE_SENDTS 0x0800 /* TS was 0 during a local user /join; send
89 * temporary TS; can be removed when all 2.10 */
90 #define MODE_LISTED 0x10000
93 * mode flags which take another parameter (With PARAmeterS)
95 #define MODE_WPARAS (MODE_CHANOP|MODE_VOICE|MODE_BAN|MODE_KEY|MODE_LIMIT)
97 #define HoldChannel(x) (!(x))
99 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
100 /* channel not shown but names are */
101 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
102 /* channel visible */
103 #define ShowChannel(v,c) (PubChannel(c) || find_channel_member((v),(c)))
104 #define PubChannel(x) ((!x) || ((x)->mode.mode & \
105 (MODE_PRIVATE | MODE_SECRET)) == 0)
106 #define is_listed(x) ((x)->mode.mode & MODE_LISTED)
108 #define IsLocalChannel(name) (*(name) == '&')
109 #define IsModelessChannel(name) (*(name) == '+')
110 #define IsChannelName(name) (*(name) == '#' || \
111 IsModelessChannel(name) || IsLocalChannel(name))
114 * Check if a sptr is an oper, and chptr is a local channel.
116 #define IsOperOnLocalChannel(sptr,chname) \
117 ((IsAnOper(sptr)) && (IsLocalChannel(chname)))
119 typedef enum ChannelGetType {
124 /* used in SetMode() in channel.c and m_umode() in s_msg.c */
127 #define MODE_ADD 0x40000000
128 #define MODE_DEL 0x20000000
131 * Maximum acceptable lag time in seconds: A channel younger than
132 * this is not protected against hacking admins.
133 * Mainly here to check if the TS clocks really sync (otherwise this
134 * will start causing HACK notices.
135 * This value must be the same on all servers.
137 * This value has been increased to 1 day in order to distinguish this
138 * "normal" type of HACK wallops / desyncs, from possiblity still
141 #define TS_LAG_TIME 86400
144 * A Magic TS that is used for channels that are created by JOIN,
145 * a channel with this TS accepts all TS without complaining that
146 * it might receive later via MODE or CREATE.
148 #define MAGIC_REMOTE_JOIN_TS 1270080000
150 #ifdef OPER_WALK_THROUGH_LMODES
152 * used in can_join to determine if an oper forced a join on a channel
154 #define MAGIC_OPER_OVERRIDE 1000
158 extern const char* const PartFmt1;
159 extern const char* const PartFmt2;
160 extern const char* const PartFmt1serv;
161 extern const char* const PartFmt2serv;
170 struct Channel* channel;
171 struct Membership* next_member;
172 struct Membership* prev_member;
173 struct Membership* next_channel;
174 struct Membership* prev_channel;
178 #define IsZombie(x) ((x)->status & CHFL_ZOMBIE)
179 #define IsDeopped(x) ((x)->status & CHFL_DEOPPED)
180 #define IsBanned(x) ((x)->status & CHFL_BANNED)
181 #define IsBanValid(x) ((x)->status & CHFL_BANVALID)
182 #define IsChanOp(x) ((x)->status & CHFL_CHANOP)
183 #define HasVoice(x) ((x)->status & CHFL_VOICE)
184 #define IsServOpOk(x) ((x)->status & CHFL_SERVOPOK)
185 #define IsBurstJoined(x) ((x)->status & CHFL_BURST_JOINED)
186 #define IsVoicedOrOpped(x) ((x)->status & CHFL_VOICED_OR_OPPED)
188 #define SetBanned(x) ((x)->status |= CHFL_BANNED)
189 #define SetBanValid(x) ((x)->status |= CHFL_BANVALID)
190 #define SetDeopped(x) ((x)->status |= CHFL_DEOPPED)
191 #define SetServOpOk(x) ((x)->status |= CHFL_SERVOPOK)
192 #define SetBurstJoined(x) ((x)->status |= CHFL_BURST_JOINED)
193 #define SetZombie(x) ((x)->status |= CHFL_ZOMBIE)
195 #define ClearBanned(x) ((x)->status &= ~CHFL_BANNED)
196 #define ClearBanValid(x) ((x)->status &= ~CHFL_BANVALID)
197 #define ClearDeopped(x) ((x)->status &= ~CHFL_DEOPPED)
198 #define ClearServOpOk(x) ((x)->status &= ~CHFL_SERVOPOK)
199 #define ClearBurstJoined(x) ((x)->status &= ~CHFL_BURST_JOINED)
205 char key[KEYLEN + 1];
209 struct Channel* next;
210 struct Channel* prev;
211 struct Channel* hnext;
215 struct Membership* members;
216 struct SLink* invites;
217 struct SLink* banlist;
219 char topic[TOPICLEN + 1];
220 char topic_nick[NICKLEN + 1];
227 unsigned int max_users;
228 unsigned int min_users;
229 unsigned int topic_limits;
230 time_t max_topic_time;
231 time_t min_topic_time;
232 struct Channel *chptr;
236 unsigned int mb_add; /* Modes to add */
237 unsigned int mb_rem; /* Modes to remove */
238 struct Client *mb_source; /* Source of MODE changes */
239 struct Client *mb_connect; /* Connection of MODE changes */
240 struct Channel *mb_channel; /* Channel they affect */
241 unsigned int mb_dest; /* Destination of MODE changes */
242 unsigned int mb_count; /* Number of modes w/args */
244 unsigned int mbm_type; /* Type of argument */
246 unsigned int mbma_uint; /* A limit */
247 char *mbma_string; /* A string */
248 struct Client *mbma_client; /* A client */
249 } mbm_arg; /* The mode argument */
250 } mb_modeargs[MAXMODEPARAMS];
254 #define MODEBUF_DEST_CHANNEL 0x01 /* Mode is flushed to channel */
255 #define MODEBUF_DEST_SERVER 0x02 /* Mode is flushed to server */
256 #define MODEBUF_DEST_HACK4 0x80 /* Send a HACK(4) notice and, on
257 server sends, use a TS of 0 */
259 #define MB_TYPE(mb, i) ((mb)->mb_modeargs[(i)].mbm_type)
260 #define MB_UINT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_uint)
261 #define MB_STRING(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_string)
262 #define MB_CLIENT(mb, i) ((mb)->mb_modeargs[(i)].mbm_arg.mbma_client)
264 extern struct Channel* GlobalChannelList;
265 extern int LocalChanOperMode;
270 extern void clean_channelname(char* name);
271 extern void channel_modes(struct Client *cptr, char *mbuf, char *pbuf,
272 struct Channel *chptr);
273 extern int set_mode(struct Client* cptr, struct Client* sptr,
274 struct Channel* chptr, int parc, char* parv[],
275 char* mbuf, char* pbuf, char* npbuf, int* badop);
276 extern void send_hack_notice(struct Client *cptr, struct Client *sptr,
277 int parc, char *parv[], int badop, int mtype);
278 extern struct Channel *get_channel(struct Client *cptr,
279 char *chname, ChannelGetType flag);
280 extern struct Membership* find_member_link(struct Channel * chptr,
281 const struct Client* cptr);
282 extern int sub1_from_channel(struct Channel* chptr);
283 extern int can_join(struct Client *sptr, struct Channel *chptr, char *key);
284 extern void add_user_to_channel(struct Channel* chptr, struct Client* who,
286 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
287 const char *param, int *count);
288 extern void add_token_to_sendbuf(char *token, size_t *sblenp, int *firstp,
289 int *send_itp, char is_a_ban, int mode);
290 extern int add_banid(struct Client *cptr, struct Channel *chptr, char *banid,
291 int change, int firsttime);
292 extern struct SLink *next_removed_overlapped_ban(void);
293 extern void cancel_mode(struct Client *sptr, struct Channel *chptr, char m,
294 const char *param, int *count);
295 extern void make_zombie(struct Membership* member, struct Client* who,
296 struct Client* cptr, struct Client* sptr,
297 struct Channel* chptr);
298 extern struct Client* find_chasing(struct Client* sptr, const char* user, int* chasing);
299 void add_invite(struct Client *cptr, struct Channel *chptr);
300 int number_of_zombies(struct Channel *chptr);
302 extern const char* find_no_nickchange_channel(struct Client* cptr);
303 extern struct Membership* IsMember(struct Client *cptr, struct Channel *chptr);
304 extern struct Membership* find_channel_member(struct Client* cptr, struct Channel* chptr);
305 extern int member_can_send_to_channel(struct Membership* member);
306 extern int client_can_send_to_channel(struct Client *cptr, struct Channel *chptr);
308 extern void remove_user_from_channel(struct Client *sptr, struct Channel *chptr);
309 extern void remove_user_from_all_channels(struct Client* cptr);
311 extern int is_chan_op(struct Client *cptr, struct Channel *chptr);
312 extern int is_zombie(struct Client *cptr, struct Channel *chptr);
313 extern int has_voice(struct Client *cptr, struct Channel *chptr);
314 extern void send_channel_modes(struct Client *cptr, struct Channel *chptr);
315 extern char *pretty_mask(char *mask);
316 extern void del_invite(struct Client *cptr, struct Channel *chptr);
317 extern void list_next_channels(struct Client *cptr, int nr);
318 extern void send_user_joins(struct Client *cptr, struct Client *user);
320 extern void modebuf_init(struct ModeBuf *mbuf, struct Client *source,
321 struct Client *connect, struct Channel *chan,
323 extern void modebuf_mode(struct ModeBuf *mbuf, unsigned int mode);
324 extern void modebuf_mode_uint(struct ModeBuf *mbuf, unsigned int mode,
326 extern void modebuf_mode_string(struct ModeBuf *mbuf, unsigned int mode,
328 extern void modebuf_mode_client(struct ModeBuf *mbuf, unsigned int mode,
329 struct Client *client);
330 extern void modebuf_flush(struct ModeBuf *mbuf);
332 #endif /* INCLUDED_channel_h */