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
26 #ifndef INCLUDED_channel_h
27 #define INCLUDED_channel_h
29 #define MODEBUFLEN 200
31 /* Maximum mode changes allowed per client, per server is different */
32 #define MAXMODEPARAMS 4
33 #define MAXMODEPARAMSSERV 10
37 /* mode structure for channels */
43 unsigned int join_num
;
44 unsigned int join_time
;
45 char forward
[LOC_CHANNELLEN
+ 1];
48 /* 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
;
130 typedef void (*ChannelModeFunc
)(struct Client
*source_p
, struct Channel
*chptr
,
131 int alevel
, int parc
, int *parn
,
132 const char **parv
, int *errors
, int dir
, char c
, long mode_type
);
136 ChannelModeFunc set_func
;
140 /* modes added by the module files in modes/ */
143 unsigned int MODE_REGONLY
;
144 unsigned int MODE_NOCTCP
; /* Block CTCPs directed to this channel */
145 unsigned int MODE_NOCOLOR
;
146 unsigned int MODE_EXLIMIT
; /* exempt from list limits, +b/+e/+I/+q */
147 unsigned int MODE_PERMANENT
; /* permanant channel, +P */
148 unsigned int MODE_OPMODERATE
; /* send rejected messages to ops */
149 unsigned int MODE_FREEINVITE
; /* allow free use of /invite */
150 unsigned int MODE_FREETARGET
; /* can be forwarded to without authorization */
151 unsigned int MODE_DISFORWARD
; /* disable channel forwarding */
152 unsigned int MODE_THROTTLE
; /* throttle joins */
153 unsigned int MODE_FORWARD
;
154 unsigned int MODE_NONOTICE
; /* Block notices directed to this channel */
155 unsigned int MODE_NOACTION
; /* Block CTCP ACTION directed to this channel */
156 unsigned int MODE_NOKICK
; /* Disable /kick on this channel */
157 unsigned int MODE_NONICK
; /* Disable /nick for anyone on this channel */
158 unsigned int MODE_NOCAPS
; /* Block messages in all capital letters */
159 unsigned int MODE_NOREJOIN
; /* Block rejoin immediately after kick */
160 unsigned int MODE_NOREPEAT
; /* Block repeat messages */
161 unsigned int MODE_NOOPERKICK
; /* disallow kicking opers */
163 unsigned int CHFL_QUIET
;
166 typedef int (*ExtbanFunc
)(const char *data
, struct Client
*client_p
,
167 struct Channel
*chptr
, long mode_type
);
169 /* can_send results */
170 #define CAN_SEND_NO 0
171 #define CAN_SEND_NONOP 1
172 #define CAN_SEND_OPV 2
174 /* channel status flags */
175 #define CHFL_PEON 0x0000 /* normal member of channel */
176 #define CHFL_CHANOP 0x0001 /* Channel operator */
177 #define CHFL_VOICE 0x0002 /* the power to speak */
178 #define CHFL_BANNED 0x0008 /* cached as banned */
179 #define CHFL_QUIETED 0x0010 /* cached as being +q victim */
180 #define ONLY_SERVERS 0x0020
181 #define CHFL_HALFOP 0x0040
182 #define CHFL_ADMIN 0x0080
183 #define ONLY_OPERS 0x0100
184 #define ALL_MEMBERS CHFL_PEON
185 #define ONLY_CHANOPS (CHFL_ADMIN|CHFL_CHANOP|CHFL_HALFOP)
186 #define ONLY_CHANOPSVOICED (CHFL_ADMIN|CHFL_CHANOP|CHFL_HALFOP|CHFL_VOICE)
188 #define is_chmode_h(x) ((x) && (x)->flags & CHFL_HALFOP) /* does not check if halfop is enabled, should typically not be used */
189 #define is_chmode_a(x) ((x) && (x)->flags & CHFL_ADMIN) /* does not check if admin is enabled, should typically not be used */
190 #define is_chanop(x) ((x) && (x)->flags & CHFL_CHANOP)
191 #define is_voiced(x) ((x) && (x)->flags & CHFL_VOICE)
192 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
194 /* channel modes ONLY */
195 #define MODE_PRIVATE 0x0001
196 #define MODE_SECRET 0x0002
197 #define MODE_MODERATED 0x0004
198 #define MODE_TOPICLIMIT 0x0008
199 #define MODE_INVITEONLY 0x0010
200 #define MODE_NOPRIVMSGS 0x0020
202 #define CHFL_BAN 0x10000000 /* ban channel flag */
203 #define CHFL_EXCEPTION 0x20000000 /* exception to ban channel flag */
204 #define CHFL_INVEX 0x40000000
206 /* mode flags for direction indication */
211 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
212 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
213 #define PubChannel(x) ((!x) || ((x)->mode.mode &\
214 (MODE_PRIVATE | MODE_SECRET)) == 0)
216 /* channel visible */
217 #define ShowChannel(v,c) (PubChannel(c) || IsMember((v),(c)))
219 #define IsMember(who, chan) ((who && who->user && \
220 find_channel_membership(chan, who)) ? 1 : 0)
222 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
224 /* extban function results */
225 #define EXTBAN_INVALID -1 /* invalid mask, false even if negated */
226 #define EXTBAN_NOMATCH 0 /* valid mask, no match */
227 #define EXTBAN_MATCH 1 /* matches */
229 extern rb_dlink_list global_channel_list
;
230 void init_channels(void);
231 void init_module_modes(void);
233 struct Channel
*allocate_channel(const char *chname
);
234 void free_channel(struct Channel
*chptr
);
235 struct Ban
*allocate_ban(const char *, const char *);
236 void free_ban(struct Ban
*bptr
);
239 extern void destroy_channel(struct Channel
*);
241 extern int can_send(struct Channel
*chptr
, struct Client
*who
,
242 struct membership
*);
243 extern int is_banned(struct Channel
*chptr
, struct Client
*who
,
244 struct membership
*msptr
, const char *, const char *);
245 extern int is_quieted(struct Channel
*chptr
, struct Client
*who
,
246 struct membership
*msptr
, const char *, const char *);
247 extern int can_join(struct Client
*source_p
, struct Channel
*chptr
, char *key
);
249 extern struct membership
*find_channel_membership(struct Channel
*, struct Client
*);
250 extern const char *find_channel_status(struct membership
*msptr
, int combine
);
251 extern int is_halfop(struct membership
*msptr
);
252 extern int is_admin(struct membership
*msptr
);
253 extern int is_any_op(struct membership
*msptr
);
254 extern int is_chanop_voiced(struct membership
*msptr
);
255 extern int can_kick_deop(struct membership
*source
, struct membership
*target
);
256 extern void add_user_to_channel(struct Channel
*, struct Client
*, int flags
);
257 extern void remove_user_from_channel(struct membership
*);
258 extern void remove_user_from_channels(struct Client
*);
259 extern void invalidate_bancache_user(struct Client
*);
261 extern void free_channel_list(rb_dlink_list
*);
263 extern int check_channel_name(const char *name
);
265 extern void channel_member_names(struct Channel
*chptr
, struct Client
*,
268 extern void del_invite(struct Channel
*chptr
, struct Client
*who
);
270 const char *channel_modes(struct Channel
*chptr
, struct Client
*who
);
272 extern int has_common_channel(struct Client
*client1
, struct Client
*client2
);
274 extern struct Channel
*find_bannickchange_channel(struct Client
*client_p
);
276 extern struct Channel
*find_nonickchange_channel(struct Client
*client_p
);
278 extern void check_spambot_warning(struct Client
*source_p
, const char *name
);
280 extern void check_splitmode(void *);
282 void set_channel_topic(struct Channel
*chptr
, const char *topic
,
283 const char *topic_info
, time_t topicts
);
285 extern void init_chcap_usage_counts(void);
286 extern void set_chcap_usage_counts(struct Client
*serv_p
);
287 extern void unset_chcap_usage_counts(struct Client
*serv_p
);
288 extern void send_cap_mode_changes(struct Client
*client_p
, struct Client
*source_p
,
289 struct Channel
*chptr
, struct ChModeChange foo
[], int);
291 void resv_chan_forcepart(const char *name
, const char *reason
, int temp_time
);
293 extern void set_channel_mode(struct Client
*client_p
, struct Client
*source_p
,
294 struct Channel
*chptr
, struct membership
*msptr
, int parc
, const char *parv
[]);
295 extern void set_channel_mlock(struct Client
*client_p
, struct Client
*source_p
,
296 struct Channel
*chptr
, const char *newmlock
);
298 extern struct ChannelMode chmode_table
[256];
300 extern int add_id(struct Client
*source_p
, struct Channel
*chptr
, const char *banid
,
301 rb_dlink_list
* list
, long mode_type
);
303 extern int del_id(struct Channel
*chptr
, const char *banid
, rb_dlink_list
* list
, long mode_type
);
305 extern ExtbanFunc extban_table
[256];
307 extern int match_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
308 extern int valid_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
309 const char * get_extban_string(void);
311 extern struct Channel
* check_forward(struct Client
*source_p
, struct Channel
*chptr
, char *key
);
312 extern void user_join(struct Client
* client_p
, struct Client
* source_p
, const char * channels
, const char * keys
);
313 extern void do_join_0(struct Client
*client_p
, struct Client
*source_p
);
314 extern int check_channel_name_loc(struct Client
*source_p
, const char *name
);
316 extern struct Metadata
*channel_metadata_add(struct Channel
*target
, const char *name
, const char *value
, int propegate
);
317 extern struct Metadata
*channel_metadata_time_add(struct Channel
*target
, const char *name
, time_t timevalue
, const char *value
);
318 extern void channel_metadata_delete(struct Channel
*target
, const char *name
, int propegate
);
319 extern struct Metadata
*channel_metadata_find(struct Channel
*target
, const char *name
);
320 extern void channel_metadata_clear(struct Channel
*target
);
323 #endif /* INCLUDED_channel_h */