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 */
58 time_t last_knock
; /* don't allow knock to flood */
60 rb_dlink_list members
; /* channel members */
61 rb_dlink_list locmembers
; /* local channel members */
63 rb_dlink_list invites
;
64 rb_dlink_list banlist
;
65 rb_dlink_list exceptlist
;
66 rb_dlink_list invexlist
;
67 rb_dlink_list quietlist
;
69 time_t first_received_message_time
; /* channel flood control */
70 int received_number_of_privmsgs
;
73 unsigned int join_count
; /* joins within delta */
74 unsigned int join_delta
; /* last ts of join */
83 rb_dlink_node channode
;
84 rb_dlink_node locchannode
;
85 rb_dlink_node usernode
;
87 struct Channel
*chptr
;
88 struct Client
*client_p
;
119 typedef void (*ChannelModeFunc
)(struct Client
*source_p
, struct Channel
*chptr
,
120 int alevel
, int parc
, int *parn
,
121 const char **parv
, int *errors
, int dir
, char c
, long mode_type
);
125 ChannelModeFunc set_func
;
129 typedef int (*ExtbanFunc
)(const char *data
, struct Client
*client_p
,
130 struct Channel
*chptr
, long mode_type
);
132 /* can_send results */
133 #define CAN_SEND_NO 0
134 #define CAN_SEND_NONOP 1
135 #define CAN_SEND_OPV 2
137 /* channel status flags */
138 #define CHFL_PEON 0x0000 /* normal member of channel */
139 #define CHFL_VOICE 0x0001 /* the power to speak */
140 #define CHFL_CHANOP 0x0002 /* Channel operator */
142 #define CHFL_BANNED 0x0008 /* cached as banned */
143 #define CHFL_QUIETED 0x0010 /* cached as being +q victim */
144 #define ONLY_SERVERS 0x0020
145 #define ALL_MEMBERS CHFL_PEON
146 #define ONLY_CHANOPS CHFL_CHANOP
147 #define ONLY_CHANOPSVOICED (CHFL_CHANOP|CHFL_VOICE)
149 #define is_chanop(x) ((x) && (x)->flags & CHFL_CHANOP)
150 #define is_voiced(x) ((x) && (x)->flags & CHFL_VOICE)
151 #define is_chanop_voiced(x) ((x) && (x)->flags & (CHFL_CHANOP|CHFL_VOICE))
152 #define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))
154 /* channel modes ONLY */
155 #define MODE_PRIVATE 0x0001
156 #define MODE_SECRET 0x0002
157 #define MODE_MODERATED 0x0004
158 #define MODE_TOPICLIMIT 0x0008
159 #define MODE_INVITEONLY 0x0010
160 #define MODE_NOPRIVMSGS 0x0020
161 #define MODE_REGONLY 0x0040
162 #define MODE_EXLIMIT 0x0100 /* exempt from list limits, +b/+e/+I/+q */
163 #define MODE_PERMANENT 0x0200 /* permanant channel, +P */
164 #define MODE_OPMODERATE 0x0400 /* send rejected messages to ops */
165 #define MODE_FREEINVITE 0x0800 /* allow free use of /invite */
166 #define MODE_FREETARGET 0x1000 /* can be forwarded to without authorization */
167 #define MODE_DISFORWARD 0x2000 /* disable channel forwarding */
169 #define CHFL_BAN 0x10000000 /* ban channel flag */
170 #define CHFL_EXCEPTION 0x20000000 /* exception to ban channel flag */
171 #define CHFL_INVEX 0x40000000
172 #define CHFL_QUIET 0x80000000
174 /* mode flags for direction indication */
179 #define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
180 #define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
181 #define PubChannel(x) ((!x) || ((x)->mode.mode &\
182 (MODE_PRIVATE | MODE_SECRET)) == 0)
184 /* channel visible */
185 #define ShowChannel(v,c) (PubChannel(c) || IsMember((v),(c)))
187 #define IsMember(who, chan) ((who && who->user && \
188 find_channel_membership(chan, who)) ? 1 : 0)
190 #define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))
192 /* extban function results */
193 #define EXTBAN_INVALID -1 /* invalid mask, false even if negated */
194 #define EXTBAN_NOMATCH 0 /* valid mask, no match */
195 #define EXTBAN_MATCH 1 /* matches */
197 extern rb_dlink_list global_channel_list
;
198 void init_channels(void);
200 struct Channel
*allocate_channel(const char *chname
);
201 void free_channel(struct Channel
*chptr
);
202 struct Ban
*allocate_ban(const char *, const char *, const char *);
203 void free_ban(struct Ban
*bptr
);
206 extern void destroy_channel(struct Channel
*);
208 extern int can_send(struct Channel
*chptr
, struct Client
*who
,
209 struct membership
*);
210 extern int flood_attack_channel(int p_or_n
, struct Client
*source_p
,
211 struct Channel
*chptr
, char *chname
);
212 extern int is_banned(struct Channel
*chptr
, struct Client
*who
,
213 struct membership
*msptr
, const char *, const char *, const char **);
214 extern int is_quieted(struct Channel
*chptr
, struct Client
*who
,
215 struct membership
*msptr
, const char *, const char *);
216 extern int can_join(struct Client
*source_p
, struct Channel
*chptr
,
217 const char *key
, const char **forward
);
219 extern struct membership
*find_channel_membership(struct Channel
*, struct Client
*);
220 extern const char *find_channel_status(struct membership
*msptr
, int combine
);
221 extern void add_user_to_channel(struct Channel
*, struct Client
*, int flags
);
222 extern void remove_user_from_channel(struct membership
*);
223 extern void remove_user_from_channels(struct Client
*);
224 extern void invalidate_bancache_user(struct Client
*);
226 extern void free_channel_list(rb_dlink_list
*);
228 extern int check_channel_name(const char *name
);
230 extern void channel_member_names(struct Channel
*chptr
, struct Client
*,
233 extern void del_invite(struct Channel
*chptr
, struct Client
*who
);
235 const char *channel_modes(struct Channel
*chptr
, struct Client
*who
);
237 extern struct Channel
*find_bannickchange_channel(struct Client
*client_p
);
239 extern void check_spambot_warning(struct Client
*source_p
, const char *name
);
241 extern void check_splitmode(void *);
243 void set_channel_topic(struct Channel
*chptr
, const char *topic
,
244 const char *topic_info
, time_t topicts
);
246 extern void init_chcap_usage_counts(void);
247 extern void set_chcap_usage_counts(struct Client
*serv_p
);
248 extern void unset_chcap_usage_counts(struct Client
*serv_p
);
249 extern void send_cap_mode_changes(struct Client
*client_p
, struct Client
*source_p
,
250 struct Channel
*chptr
, struct ChModeChange foo
[], int);
252 void resv_chan_forcepart(const char *name
, const char *reason
, int temp_time
);
254 extern void set_channel_mode(struct Client
*client_p
, struct Client
*source_p
,
255 struct Channel
*chptr
, struct membership
*msptr
, int parc
, const char *parv
[]);
256 extern void set_channel_mlock(struct Client
*client_p
, struct Client
*source_p
,
257 struct Channel
*chptr
, const char *newmlock
, int propagate
);
259 extern struct ChannelMode chmode_table
[256];
261 extern int add_id(struct Client
*source_p
, struct Channel
*chptr
, const char *banid
,
262 const char *forward
, rb_dlink_list
* list
, long mode_type
);
264 extern struct Ban
* del_id(struct Channel
*chptr
, const char *banid
, rb_dlink_list
* list
,
267 extern ExtbanFunc extban_table
[256];
269 extern int match_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
270 extern int valid_extban(const char *banstr
, struct Client
*client_p
, struct Channel
*chptr
, long mode_type
);
271 const char * get_extban_string(void);
273 extern int get_channel_access(struct Client
*source_p
, struct membership
*msptr
, int dir
);
275 extern void send_channel_join(struct Channel
*chptr
, struct Client
*client_p
);
277 #endif /* INCLUDED_channel_h */