[solanum.git] / include / channel.h

/*
 *  ircd-ratbox: A slightly useful ircd.
 *  channel.h: The ircd channel header.
 *
 *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
 *  Copyright (C) 1996-2002 Hybrid Development Team
 *  Copyright (C) 2002-2004 ircd-ratbox development team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 *
 *  $Id: channel.h 3580 2007-11-07 23:45:14Z jilles $
 */

#ifndef INCLUDED_channel_h
#define INCLUDED_channel_h

#define MODEBUFLEN      200

/* Maximum mode changes allowed per client, per server is different */
#define MAXMODEPARAMS   4
#define MAXMODEPARAMSSERV 10

struct Client;

/* mode structure for channels */
struct Mode
{
	unsigned int mode;
	int limit;
	char key[KEYLEN];
	unsigned int join_num;
	unsigned int join_time;
	char forward[LOC_CHANNELLEN + 1];
};

/* channel structure */
struct Channel
{
	rb_dlink_node node;
	struct Mode mode;
	char *mode_lock;
	char *topic;
	char *topic_info;
	time_t topic_time;
	time_t last_knock;	/* don't allow knock to flood */

	rb_dlink_list members;	/* channel members */
	rb_dlink_list locmembers;	/* local channel members */

	rb_dlink_list invites;
	rb_dlink_list banlist;
	rb_dlink_list exceptlist;
	rb_dlink_list invexlist;
	rb_dlink_list quietlist;

	time_t first_received_message_time;	/* channel flood control */
	int received_number_of_privmsgs;
	int flood_noticed;

	unsigned int join_count;  /* joins within delta */
	unsigned int join_delta;  /* last ts of join */

	unsigned long bants;
	time_t channelts;
	char *chname;
};

struct membership
{
	rb_dlink_node channode;
	rb_dlink_node locchannode;
	rb_dlink_node usernode;

	struct Channel *chptr;
	struct Client *client_p;
	unsigned int flags;

	unsigned long bants;
};

#define BANLEN 195
struct Ban
{
	char *banstr;
	char *who;
	time_t when;
	char *forward;
	rb_dlink_node node;
};

struct mode_letter
{
	int mode;
	char letter;
};

struct ChModeChange
{
	char letter;
	const char *arg;
	const char *id;
	int dir;
	int mems;
};

typedef void (*ChannelModeFunc)(struct Client *source_p, struct Channel *chptr,
		int alevel, int parc, int *parn,
		const char **parv, int *errors, int dir, char c, long mode_type);

struct ChannelMode
{
	ChannelModeFunc set_func;
	long mode_type;
};

typedef int (*ExtbanFunc)(const char *data, struct Client *client_p,
		struct Channel *chptr, long mode_type);

/* can_send results */
#define CAN_SEND_NO	0
#define CAN_SEND_NONOP  1
#define CAN_SEND_OPV	2

/* channel status flags */
#define CHFL_PEON		0x0000	/* normal member of channel */
#define CHFL_VOICE      	0x0001	/* the power to speak */
#define CHFL_CHANOP	     	0x0002	/* Channel operator */

#define CHFL_BANNED		0x0008  /* cached as banned */
#define CHFL_QUIETED		0x0010  /* cached as being +q victim */
#define ONLY_SERVERS		0x0020
#define ALL_MEMBERS		CHFL_PEON
#define ONLY_CHANOPS		CHFL_CHANOP
#define ONLY_CHANOPSVOICED	(CHFL_CHANOP|CHFL_VOICE)

#define is_chanop(x)	((x) && (x)->flags & CHFL_CHANOP)
#define is_voiced(x)	((x) && (x)->flags & CHFL_VOICE)
#define is_chanop_voiced(x) ((x) && (x)->flags & (CHFL_CHANOP|CHFL_VOICE))
#define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED|CHFL_QUIETED))

/* channel modes ONLY */
#define MODE_PRIVATE    0x0001
#define MODE_SECRET     0x0002
#define MODE_MODERATED  0x0004
#define MODE_TOPICLIMIT 0x0008
#define MODE_INVITEONLY 0x0010
#define MODE_NOPRIVMSGS 0x0020
#define MODE_REGONLY	0x0040
#define MODE_EXLIMIT	0x0100  /* exempt from list limits, +b/+e/+I/+q */
#define MODE_PERMANENT  0x0200  /* permanant channel, +P */
#define MODE_OPMODERATE 0x0400  /* send rejected messages to ops */
#define MODE_FREEINVITE 0x0800  /* allow free use of /invite */
#define MODE_FREETARGET 0x1000  /* can be forwarded to without authorization */
#define MODE_DISFORWARD 0x2000  /* disable channel forwarding */

#define CHFL_BAN        0x10000000	/* ban channel flag */
#define CHFL_EXCEPTION  0x20000000	/* exception to ban channel flag */
#define CHFL_INVEX      0x40000000
#define CHFL_QUIET      0x80000000

/* mode flags for direction indication */
#define MODE_QUERY     0
#define MODE_ADD       1
#define MODE_DEL       -1

#define SecretChannel(x)        ((x) && ((x)->mode.mode & MODE_SECRET))
#define HiddenChannel(x)        ((x) && ((x)->mode.mode & MODE_PRIVATE))
#define PubChannel(x)           ((!x) || ((x)->mode.mode &\
                                 (MODE_PRIVATE | MODE_SECRET)) == 0)

/* channel visible */
#define ShowChannel(v,c)        (PubChannel(c) || IsMember((v),(c)))

#define IsMember(who, chan) ((who && who->user && \
                find_channel_membership(chan, who)) ? 1 : 0)

#define IsChannelName(name) ((name) && (*(name) == '#' || *(name) == '&'))

/* extban function results */
#define EXTBAN_INVALID -1  /* invalid mask, false even if negated */
#define EXTBAN_NOMATCH  0  /* valid mask, no match */
#define EXTBAN_MATCH    1  /* matches */

extern rb_dlink_list global_channel_list;
void init_channels(void);

struct Channel *allocate_channel(const char *chname);
void free_channel(struct Channel *chptr);
struct Ban *allocate_ban(const char *, const char *, const char *);
void free_ban(struct Ban *bptr);


extern void destroy_channel(struct Channel *);

extern int can_send(struct Channel *chptr, struct Client *who,
		    struct membership *);
extern int flood_attack_channel(int p_or_n, struct Client *source_p,
				struct Channel *chptr, char *chname);
extern int is_banned(struct Channel *chptr, struct Client *who,
		    struct membership *msptr, const char *, const char *, const char **);
extern int is_quieted(struct Channel *chptr, struct Client *who,
		     struct membership *msptr, const char *, const char *);
extern int can_join(struct Client *source_p, struct Channel *chptr,
		    const char *key, const char **forward);

extern struct membership *find_channel_membership(struct Channel *, struct Client *);
extern const char *find_channel_status(struct membership *msptr, int combine);
extern void add_user_to_channel(struct Channel *, struct Client *, int flags);
extern void remove_user_from_channel(struct membership *);
extern void remove_user_from_channels(struct Client *);
extern void invalidate_bancache_user(struct Client *);

extern void free_channel_list(rb_dlink_list *);

extern int check_channel_name(const char *name);

extern void channel_member_names(struct Channel *chptr, struct Client *,
				 int show_eon);

extern void del_invite(struct Channel *chptr, struct Client *who);

const char *channel_modes(struct Channel *chptr, struct Client *who);

extern struct Channel *find_bannickchange_channel(struct Client *client_p);

extern void check_spambot_warning(struct Client *source_p, const char *name);

extern void check_splitmode(void *);

void set_channel_topic(struct Channel *chptr, const char *topic,
		       const char *topic_info, time_t topicts);

extern void init_chcap_usage_counts(void);
extern void set_chcap_usage_counts(struct Client *serv_p);
extern void unset_chcap_usage_counts(struct Client *serv_p);
extern void send_cap_mode_changes(struct Client *client_p, struct Client *source_p,
				  struct Channel *chptr, struct ChModeChange foo[], int);

void resv_chan_forcepart(const char *name, const char *reason, int temp_time);

extern void set_channel_mode(struct Client *client_p, struct Client *source_p,
            	struct Channel *chptr, struct membership *msptr, int parc, const char *parv[]);
extern void set_channel_mlock(struct Client *client_p, struct Client *source_p,
            	struct Channel *chptr, const char *newmlock, int propagate);

extern struct ChannelMode chmode_table[256];

extern int add_id(struct Client *source_p, struct Channel *chptr, const char *banid,
	const char *forward, rb_dlink_list * list, long mode_type);

extern struct Ban * del_id(struct Channel *chptr, const char *banid, rb_dlink_list * list,
	long mode_type);

extern ExtbanFunc extban_table[256];

extern int match_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
extern int valid_extban(const char *banstr, struct Client *client_p, struct Channel *chptr, long mode_type);
const char * get_extban_string(void);

extern int get_channel_access(struct Client *source_p, struct membership *msptr, int dir);

extern void send_channel_join(struct Channel *chptr, struct Client *client_p);

#endif /* INCLUDED_channel_h */
Commit	Line	Data
212380e3 AC	1	/*
	2	* ircd-ratbox: A slightly useful ircd.
	3	* channel.h: The ircd channel header.
	4	*
	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
	8	*
	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.
	13	*
	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.
	18	*
	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
	22	* USA
	23	*
83294285	24	* $Id: channel.h 3580 2007-11-07 23:45:14Z jilles $
212380e3 AC	25	*/
	26
	27	#ifndef INCLUDED_channel_h
	28	#define INCLUDED_channel_h
212380e3 AC	29
	30	#define MODEBUFLEN 200
	31
	32	/* Maximum mode changes allowed per client, per server is different */
	33	#define MAXMODEPARAMS 4
	34	#define MAXMODEPARAMSSERV 10
	35
	36	struct Client;
	37
	38	/* mode structure for channels */
	39	struct Mode
	40	{
	41	unsigned int mode;
	42	int limit;
	43	char key[KEYLEN];
	44	unsigned int join_num;
	45	unsigned int join_time;
	46	char forward[LOC_CHANNELLEN + 1];
	47	};
	48
	49	/* channel structure */
	50	struct Channel
	51	{
5b96d9a6	52	rb_dlink_node node;
212380e3	53	struct Mode mode;
78e6b731	54	char *mode_lock;
212380e3 AC	55	char *topic;
	56	char *topic_info;
	57	time_t topic_time;
212380e3 AC	58	time_t last_knock; /* don't allow knock to flood */
212380e3 AC	59
5b96d9a6 AC	60	rb_dlink_list members; /* channel members */
5b96d9a6 AC	61	rb_dlink_list locmembers; /* local channel members */
212380e3	62
8aabb973	63	rb_dlink_list invites;
5b96d9a6 AC	64	rb_dlink_list banlist;
	65	rb_dlink_list exceptlist;
	66	rb_dlink_list invexlist;
	67	rb_dlink_list quietlist;
212380e3 AC	68
	69	time_t first_received_message_time; /* channel flood control */
	70	int received_number_of_privmsgs;
	71	int flood_noticed;
	72
	73	unsigned int join_count; /* joins within delta */
	74	unsigned int join_delta; /* last ts of join */
	75
	76	unsigned long bants;
	77	time_t channelts;
	78	char *chname;
	79	};
	80
	81	struct membership
	82	{
5b96d9a6 AC	83	rb_dlink_node channode;
	84	rb_dlink_node locchannode;
	85	rb_dlink_node usernode;
212380e3 AC	86
	87	struct Channel *chptr;
	88	struct Client *client_p;
	89	unsigned int flags;
	90
	91	unsigned long bants;
	92	};
	93
83294285	94	#define BANLEN 195
212380e3 AC	95	struct Ban
	96	{
	97	char *banstr;
	98	char *who;
	99	time_t when;
765d839d	100	char *forward;
5b96d9a6	101	rb_dlink_node node;
212380e3 AC	102	};
212380e3 AC	103
7d1f9131 JT	104	struct mode_letter
	105	{
	106	int mode;
	107	char letter;
	108	};
	109
212380e3 AC	110	struct ChModeChange
	111	{
	112	char letter;
	113	const char *arg;
	114	const char *id;
	115	int dir;
212380e3	116	int mems;
212380e3 AC	117	};
212380e3 AC	118
19716b9f JT	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);
	122
212380e3 AC	123	struct ChannelMode
212380e3 AC	124	{
19716b9f	125	ChannelModeFunc set_func;
212380e3 AC	126	long mode_type;
	127	};
	128
	129	typedef int (ExtbanFunc)(const char data, struct Client *client_p,
	130	struct Channel *chptr, long mode_type);
	131
	132	/* can_send results */
	133	#define CAN_SEND_NO 0
	134	#define CAN_SEND_NONOP 1
	135	#define CAN_SEND_OPV 2
	136
	137	/* channel status flags */
	138	#define CHFL_PEON 0x0000 /* normal member of channel */
a0626e7c AC	139	#define CHFL_VOICE 0x0001 /* the power to speak */
	140	#define CHFL_CHANOP 0x0002 /* Channel operator */
	141
212380e3 AC	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)
	148
	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))
212380e3 AC	152	#define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED\|CHFL_QUIETED))
	153
	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
212380e3 AC	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 */
	168
	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
	173
	174	/* mode flags for direction indication */
	175	#define MODE_QUERY 0
	176	#define MODE_ADD 1
	177	#define MODE_DEL -1
	178
	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)
	183
	184	/* channel visible */
	185	#define ShowChannel(v,c) (PubChannel(c) \|\| IsMember((v),(c)))
	186
	187	#define IsMember(who, chan) ((who && who->user && \
	188	find_channel_membership(chan, who)) ? 1 : 0)
	189
	190	#define IsChannelName(name) ((name) && ((name) == '#' \|\| (name) == '&'))
	191
	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 */
	196
5b96d9a6	197	extern rb_dlink_list global_channel_list;
212380e3 AC	198	void init_channels(void);
	199
	200	struct Channel allocate_channel(const char chname);
	201	void free_channel(struct Channel *chptr);
765d839d	202	struct Ban allocate_ban(const char , const char , const char );
212380e3 AC	203	void free_ban(struct Ban *bptr);
	204
	205
	206	extern void destroy_channel(struct Channel *);
	207
55abcbb2	208	extern int can_send(struct Channel chptr, struct Client who,
212380e3	209	struct membership *);
15484f02 BG	210	extern int flood_attack_channel(int p_or_n, struct Client *source_p,
15484f02 BG	211	struct Channel chptr, char chname);
212380e3	212	extern int is_banned(struct Channel chptr, struct Client who,
765d839d	213	struct membership msptr, const char , const char , const char *);
212380e3 AC	214	extern int is_quieted(struct Channel chptr, struct Client who,
212380e3 AC	215	struct membership msptr, const char , const char *);
fe74401b JT	216	extern int can_join(struct Client source_p, struct Channel chptr,
fe74401b JT	217	const char key, const char *forward);
212380e3 AC	218
	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 *);
	225
5b96d9a6	226	extern void free_channel_list(rb_dlink_list *);
212380e3 AC	227
	228	extern int check_channel_name(const char *name);
	229
	230	extern void channel_member_names(struct Channel chptr, struct Client ,
	231	int show_eon);
	232
	233	extern void del_invite(struct Channel chptr, struct Client who);
	234
3b8a6350	235	const char channel_modes(struct Channel chptr, struct Client *who);
212380e3 AC	236
	237	extern struct Channel find_bannickchange_channel(struct Client client_p);
	238
	239	extern void check_spambot_warning(struct Client source_p, const char name);
	240
	241	extern void check_splitmode(void *);
	242
	243	void set_channel_topic(struct Channel chptr, const char topic,
	244	const char *topic_info, time_t topicts);
	245
	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);
	251
dca9e552 JT	252	void resv_chan_forcepart(const char name, const char reason, int temp_time);
dca9e552 JT	253
212380e3 AC	254	extern void set_channel_mode(struct Client client_p, struct Client source_p,
212380e3 AC	255	struct Channel chptr, struct membership msptr, int parc, const char *parv[]);
8727cbe8	256	extern void set_channel_mlock(struct Client client_p, struct Client source_p,
6fb6bd15	257	struct Channel chptr, const char newmlock, int propagate);
212380e3 AC	258
	259	extern struct ChannelMode chmode_table[256];
	260
	261	extern int add_id(struct Client source_p, struct Channel chptr, const char *banid,
765d839d	262	const char forward, rb_dlink_list list, long mode_type);
212380e3	263
765d839d EM	264	extern struct Ban * del_id(struct Channel chptr, const char banid, rb_dlink_list * list,
765d839d EM	265	long mode_type);
212380e3 AC	266
	267	extern ExtbanFunc extban_table[256];
	268
	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);
	272
202d4966	273	extern int get_channel_access(struct Client source_p, struct membership msptr, int dir);
212380e3	274
27912fd4 AC	275	extern void send_channel_join(struct Channel chptr, struct Client client_p);
27912fd4 AC	276
212380e3	277	#endif /* INCLUDED_channel_h */