2 * ircd-ratbox: A slightly useful ircd.
3 * channel.h: The ircd channel header.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2004 ircd-ratbox development team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 * $Id: channel.h 3580 2007-11-07 23:45:14Z jilles $
27 #ifndef INCLUDED_channel_h
28 #define INCLUDED_channel_h
30 #define MODEBUFLEN 200
32 /* Maximum mode changes allowed per client, per server is different */
33 #define MAXMODEPARAMS 4
34 #define MAXMODEPARAMSSERV 10
38 /* mode structure for channels */
44 unsigned int join_num
;
45 unsigned int join_time
;
46 char forward
[LOC_CHANNELLEN
+ 1];
49 /* channel structure */
57 time_t last_knock
; /* don't allow knock to flood */
59 rb_dlink_list members
; /* channel members */
60 rb_dlink_list locmembers
; /* local channel members */
62 rb_dlink_list invites
;
63 rb_dlink_list banlist
;
64 rb_dlink_list exceptlist
;
65 rb_dlink_list invexlist
;
66 rb_dlink_list quietlist
;
68 time_t first_received_message_time
; /* channel flood control */
69 int received_number_of_privmsgs
;
72 unsigned int join_count
; /* joins within delta */
73 unsigned int join_delta
; /* last ts of join */
75 struct Dictionary
*metadata
;
84 rb_dlink_node channode
;
85 rb_dlink_node locchannode
;
86 rb_dlink_node usernode
;
88 struct Channel
*chptr
;
89 struct Client
*client_p
;
120 struct Client
*client
;
132 void (*set_func
) (struct Client
* source_p
, struct Channel
* chptr
,
133 int alevel
, int parc
, int *parn
,
134 const char **parv
, int *errors
, int dir
, char c
, long mode_type
);
138 typedef int (*ExtbanFunc
)(const char *data
, struct Client
*client_p
,
139 struct Channel
*chptr
, long mode_type
);
141 /* can_send results */
142 #define CAN_SEND_NO 0
143 #define CAN_SEND_NONOP 1
144 #define CAN_SEND_OPV 2
146 /* channel status flags */
147 #define CHFL_PEON 0x0000 /* normal member of channel */
148 #define CHFL_CHANOP 0x0001 /* Channel operator */
149 #define CHFL_VOICE 0x0002 /* the power to speak */
150 #define CHFL_BANNED 0x0008 /* cached as banned */
151 #define CHFL_QUIETED 0x0010 /* cached as being +q victim */
152 #define ONLY_SERVERS 0x0020
153 #define CHFL_HALFOP 0x0040
154 #define CHFL_ADMIN 0x0080
155 #define ONLY_OPERS 0x0100
156 #define ALL_MEMBERS CHFL_PEON
157 #define ONLY_CHANOPS CHFL_CHANOP
158 #define ONLY_CHANOPSVOICED (CHFL_CHANOP|CHFL_VOICE)
160 #define is_chmode_h(x) ((x) && (x)->flags & CHFL_HALFOP) /* does not check if halfop is enabled, should typically not be used */
161 #define is_chmode_a(x) ((x) && (x)->flags & CHFL_ADMIN) /* does not check if admin is enabled, should typically not be used */
162 #define is_chanop(x) ((x) && (x)->flags & CHFL_CHANOP)
163 #define is_voiced(x) ((x) && (x)->flags & CHFL_VOICE)
164 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
166 /* channel modes ONLY */
167 #define MODE_PRIVATE 0x0001
168 #define MODE_SECRET 0x0002
169 #define MODE_MODERATED 0x0004
170 #define MODE_TOPICLIMIT 0x0008
171 #define MODE_INVITEONLY 0x0010
172 #define MODE_NOPRIVMSGS 0x0020
173 #define MODE_REGONLY 0x0040
174 #define MODE_NOCOLOR 0x0080
175 #define MODE_EXLIMIT 0x0100 /* exempt from list limits, +b/+e/+I/+q */
176 #define MODE_PERMANENT 0x0200 /* permanant channel, +P */
177 #define MODE_OPMODERATE 0x0400 /* send rejected messages to ops */
178 #define MODE_FREEINVITE 0x0800 /* allow free use of /invite */
179 #define MODE_FREETARGET 0x1000 /* can be forwarded to without authorization */
180 #define MODE_DISFORWARD 0x2000 /* disable channel forwarding */
181 #define MODE_NOCTCP 0x8000 /* Block CTCPs directed to this channel */
182 #define MODE_NONOTICE 0x10000 /* Block notices directed to this channel */
183 #define MODE_NOACTION 0x20000 /* Block CTCP ACTION directed to this channel */
184 #define MODE_NOKICK 0x40000 /* Disable /kick on this channel */
185 #define MODE_NONICK 0x80000 /* Disable /nick for anyone on this channel */
186 #define MODE_NOCAPS 0x100000 /* Block messages in all capital letters */
187 #define MODE_NOREJOIN 0x200000 /* Block rejoin immediately after kick */
188 #define MODE_NOREPEAT 0x400000 /* Block repeat messages */
189 #define MODE_NOOPERKICK 0x800000 /* disallow kicking opers */
191 #define CHFL_BAN 0x10000000 /* ban channel flag */
192 #define CHFL_EXCEPTION 0x20000000 /* exception to ban channel flag */
193 #define CHFL_INVEX 0x40000000
194 #define CHFL_QUIET 0x80000000
196 /* mode flags for direction indication */
201 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
202 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
203 #define PubChannel(x) ((!x) || ((x)->mode.mode &\
204 (MODE_PRIVATE | MODE_SECRET)) == 0)
206 /* channel visible */
207 #define ShowChannel(v,c) (PubChannel(c) || IsMember((v),(c)))
209 #define IsMember(who, chan) ((who && who->user && \
210 find_channel_membership(chan, who)) ? 1 : 0)
212 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
214 /* extban function results */
215 #define EXTBAN_INVALID -1 /* invalid mask, false even if negated */
216 #define EXTBAN_NOMATCH 0 /* valid mask, no match */
217 #define EXTBAN_MATCH 1 /* matches */
219 extern rb_dlink_list global_channel_list
;
220 void init_channels(void);
222 struct Channel
*allocate_channel(const char *chname
);
223 void free_channel(struct Channel
*chptr
);
224 struct Ban
*allocate_ban(const char *, const char *);
225 void free_ban(struct Ban
*bptr
);
228 extern void destroy_channel(struct Channel
*);
230 extern int can_send(struct Channel
*chptr
, struct Client
*who
,
231 struct membership
*);
232 extern int is_banned(struct Channel
*chptr
, struct Client
*who
,
233 struct membership
*msptr
, const char *, const char *);
234 extern int is_quieted(struct Channel
*chptr
, struct Client
*who
,
235 struct membership
*msptr
, const char *, const char *);
236 extern int can_join(struct Client
*source_p
, struct Channel
*chptr
, char *key
);
238 extern struct membership
*find_channel_membership(struct Channel
*, struct Client
*);
239 extern const char *find_channel_status(struct membership
*msptr
, int combine
);
240 extern int is_halfop(struct membership
*msptr
);
241 extern int is_admin(struct membership
*msptr
);
242 extern int is_any_op(struct membership
*msptr
);
243 extern int is_chanop_voiced(struct membership
*msptr
);
244 extern int can_kick_deop(struct membership
*source
, struct membership
*target
);
245 extern void add_user_to_channel(struct Channel
*, struct Client
*, int flags
);
246 extern void remove_user_from_channel(struct membership
*);
247 extern void remove_user_from_channels(struct Client
*);
248 extern void invalidate_bancache_user(struct Client
*);
250 extern void free_channel_list(rb_dlink_list
*);
252 extern int check_channel_name(const char *name
);
254 extern void channel_member_names(struct Channel
*chptr
, struct Client
*,
257 extern void del_invite(struct Channel
*chptr
, struct Client
*who
);
259 const char *channel_modes(struct Channel
*chptr
, struct Client
*who
);
261 extern int has_common_channel(struct Client
*client1
, struct Client
*client2
);
263 extern struct Channel
*find_bannickchange_channel(struct Client
*client_p
);
265 extern struct Channel
*find_nonickchange_channel(struct Client
*client_p
);
267 extern void check_spambot_warning(struct Client
*source_p
, const char *name
);
269 extern void check_splitmode(void *);
271 void set_channel_topic(struct Channel
*chptr
, const char *topic
,
272 const char *topic_info
, time_t topicts
);
274 extern void init_chcap_usage_counts(void);
275 extern void set_chcap_usage_counts(struct Client
*serv_p
);
276 extern void unset_chcap_usage_counts(struct Client
*serv_p
);
277 extern void send_cap_mode_changes(struct Client
*client_p
, struct Client
*source_p
,
278 struct Channel
*chptr
, struct ChModeChange foo
[], int);
280 void resv_chan_forcepart(const char *name
, const char *reason
, int temp_time
);
282 extern void set_channel_mode(struct Client
*client_p
, struct Client
*source_p
,
283 struct Channel
*chptr
, struct membership
*msptr
, int parc
, const char *parv
[]);
285 extern struct ChannelMode chmode_table
[256];
287 extern int add_id(struct Client
*source_p
, struct Channel
*chptr
, const char *banid
,
288 rb_dlink_list
* list
, long mode_type
);
290 extern int del_id(struct Channel
*chptr
, const char *banid
, rb_dlink_list
* list
, long mode_type
);
292 extern ExtbanFunc extban_table
[256];
294 extern int match_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
295 extern int valid_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
296 const char * get_extban_string(void);
298 extern struct Channel
* check_forward(struct Client
*source_p
, struct Channel
*chptr
, char *key
);
299 extern void user_join(struct Client
* client_p
, struct Client
* source_p
, const char * channels
, const char * keys
);
300 extern void do_join_0(struct Client
*client_p
, struct Client
*source_p
);
301 extern int check_channel_name_loc(struct Client
*source_p
, const char *name
);
303 extern struct Metadata
*channel_metadata_add(struct Channel
*target
, const char *name
, const char *value
, int propegate
);
304 extern struct Metadata
*channel_metadata_time_add(struct Channel
*target
, const char *name
, time_t timevalue
, const char *value
);
305 extern void channel_metadata_delete(struct Channel
*target
, const char *name
, int propegate
);
306 extern struct Metadata
*channel_metadata_find(struct Channel
*target
, const char *name
);
307 extern void channel_metadata_clear(struct Channel
*target
);
310 #endif /* INCLUDED_channel_h */