[irc/rqf/shadowircd.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 *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;
	rb_dlink_node node;
};

struct mode_letter
{
	int mode;
	char letter;
};

struct ChModeChange
{
	char letter;
	const char *arg;
	const char *id;
	int dir;
	int caps;
	int nocaps;
	int mems;
	struct Client *client;
};

struct ChCapCombo
{
	int count;
	int cap_yes;
	int cap_no;
};

struct ChannelMode
{
	void (*set_func) (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);
	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_CHANOP     	0x0001	/* Channel operator */
#define CHFL_VOICE      	0x0002	/* the power to speak */
#define CHFL_BANNED		0x0008  /* cached as banned */
#define CHFL_QUIETED		0x0010  /* cached as being +q victim */
#define ONLY_SERVERS		0x0020
#define CHFL_HALFOP		0x0040
#define CHFL_OWNER		0x0080
#define ALL_MEMBERS		CHFL_PEON
#define ONLY_CHANOPS		CHFL_CHANOP
#define ONLY_CHANOPSVOICED	(CHFL_CHANOP|CHFL_VOICE)

#define is_chmode_h(x)	((x) && (x)->flags & CHFL_HALFOP) /* does not check if halfop is enabled, should typically not be used */
#define is_chmode_a(x)	((x) && (x)->flags & CHFL_OWNER) /* does not check if owner is enabled, should typically not be used */
#define is_chanop(x)	((x) && (x)->flags & CHFL_CHANOP)
#define is_voiced(x)	((x) && (x)->flags & 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_NOCOLOR	0x0080
#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 MODE_NOCTCP     0x8000  /* Block CTCPs directed to this channel */
#define MODE_NONOTICE	0x16000	/* Block notices directed to this channel */
#define MODE_NOACTION	0x32000 /* Block CTCP ACTION directed to this channel */
#define MODE_NOKICK	0x64000 /* Disable /kick on this channel */
#define MODE_NONICK	0x128000 /* Disable /nick for anyone on this channel */
#define MODE_NOCAPS	0x256000 /* Block messages in all capital letters */
#define MODE_NOREJOIN	0x512000 /* Block rejoin immediately after kick */

#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 *);
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 is_banned(struct Channel *chptr, struct Client *who,
		     struct membership *msptr, 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, char *key);

extern struct membership *find_channel_membership(struct Channel *, struct Client *);
extern const char *find_channel_status(struct membership *msptr, int combine);
extern int is_halfop(struct membership *msptr);
extern int is_owner(struct membership *msptr);
extern int is_any_op(struct membership *msptr);
extern int is_chanop_voiced(struct membership *msptr);
extern int can_kick_deop(struct membership *source, struct membership *target);
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 int has_common_channel(struct Client *client1, struct Client *client2);

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

extern struct Channel *find_nonickchange_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);

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 struct ChannelMode chmode_table[256];

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

extern int 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 struct Channel * check_forward(struct Client *source_p, struct Channel *chptr, char *key);
extern void user_join(struct Client * client_p, struct Client * source_p, const char * channels, const char * keys);
extern void do_join_0(struct Client *client_p, struct Client *source_p);
extern int check_channel_name_loc(struct Client *source_p, const char *name);

#endif /* INCLUDED_channel_h */
Commit	Line	Data
212380e3	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	25	*/
	26
	27	#ifndef INCLUDED_channel_h
	28	#define INCLUDED_channel_h
212380e3	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	{
08d11e34	52	rb_dlink_node node;
212380e3	53	struct Mode mode;
	54	char *topic;
	55	char *topic_info;
	56	time_t topic_time;
212380e3	57	time_t last_knock; /* don't allow knock to flood */
212380e3	58
08d11e34 WP	59	rb_dlink_list members; /* channel members */
08d11e34 WP	60	rb_dlink_list locmembers; /* local channel members */
212380e3	61
08d11e34 WP	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;
212380e3	67
	68	time_t first_received_message_time; /* channel flood control */
	69	int received_number_of_privmsgs;
	70	int flood_noticed;
	71
	72	unsigned int join_count; /* joins within delta */
	73	unsigned int join_delta; /* last ts of join */
	74
	75	unsigned long bants;
	76	time_t channelts;
	77	char *chname;
	78	};
	79
	80	struct membership
	81	{
08d11e34 WP	82	rb_dlink_node channode;
	83	rb_dlink_node locchannode;
	84	rb_dlink_node usernode;
212380e3	85
	86	struct Channel *chptr;
	87	struct Client *client_p;
	88	unsigned int flags;
	89
	90	unsigned long bants;
	91	};
	92
83294285	93	#define BANLEN 195
212380e3	94	struct Ban
	95	{
	96	char *banstr;
	97	char *who;
	98	time_t when;
08d11e34	99	rb_dlink_node node;
212380e3	100	};
212380e3	101
2a719c44 JT	102	struct mode_letter
	103	{
	104	int mode;
	105	char letter;
	106	};
	107
212380e3	108	struct ChModeChange
	109	{
	110	char letter;
	111	const char *arg;
	112	const char *id;
	113	int dir;
	114	int caps;
	115	int nocaps;
	116	int mems;
	117	struct Client *client;
	118	};
	119
	120	struct ChCapCombo
	121	{
	122	int count;
	123	int cap_yes;
	124	int cap_no;
	125	};
	126
	127	struct ChannelMode
	128	{
	129	void (set_func) (struct Client source_p, struct Channel * chptr,
	130	int alevel, int parc, int *parn,
	131	const char *parv, int errors, int dir, char c, long mode_type);
	132	long mode_type;
	133	};
	134
	135	typedef int (ExtbanFunc)(const char data, struct Client *client_p,
	136	struct Channel *chptr, long mode_type);
	137
	138	/* can_send results */
	139	#define CAN_SEND_NO 0
	140	#define CAN_SEND_NONOP 1
	141	#define CAN_SEND_OPV 2
	142
	143	/* channel status flags */
	144	#define CHFL_PEON 0x0000 /* normal member of channel */
	145	#define CHFL_CHANOP 0x0001 /* Channel operator */
	146	#define CHFL_VOICE 0x0002 /* the power to speak */
212380e3	147	#define CHFL_BANNED 0x0008 /* cached as banned */
	148	#define CHFL_QUIETED 0x0010 /* cached as being +q victim */
	149	#define ONLY_SERVERS 0x0020
82f8e812 G	150	#define CHFL_HALFOP 0x0040
82f8e812 G	151	#define CHFL_OWNER 0x0080
212380e3	152	#define ALL_MEMBERS CHFL_PEON
	153	#define ONLY_CHANOPS CHFL_CHANOP
	154	#define ONLY_CHANOPSVOICED (CHFL_CHANOP\|CHFL_VOICE)
	155
82f8e812 G	156	#define is_chmode_h(x) ((x) && (x)->flags & CHFL_HALFOP) /* does not check if halfop is enabled, should typically not be used */
82f8e812 G	157	#define is_chmode_a(x) ((x) && (x)->flags & CHFL_OWNER) /* does not check if owner is enabled, should typically not be used */
212380e3	158	#define is_chanop(x) ((x) && (x)->flags & CHFL_CHANOP)
212380e3	159	#define is_voiced(x) ((x) && (x)->flags & CHFL_VOICE)
212380e3	160	#define can_send_banned(x) ((x) && (x)->flags & (CHFL_BANNED\|CHFL_QUIETED))
	161
	162	/* channel modes ONLY */
	163	#define MODE_PRIVATE 0x0001
	164	#define MODE_SECRET 0x0002
	165	#define MODE_MODERATED 0x0004
	166	#define MODE_TOPICLIMIT 0x0008
	167	#define MODE_INVITEONLY 0x0010
	168	#define MODE_NOPRIVMSGS 0x0020
	169	#define MODE_REGONLY 0x0040
	170	#define MODE_NOCOLOR 0x0080
	171	#define MODE_EXLIMIT 0x0100 /* exempt from list limits, +b/+e/+I/+q */
	172	#define MODE_PERMANENT 0x0200 /* permanant channel, +P */
	173	#define MODE_OPMODERATE 0x0400 /* send rejected messages to ops */
	174	#define MODE_FREEINVITE 0x0800 /* allow free use of /invite */
	175	#define MODE_FREETARGET 0x1000 /* can be forwarded to without authorization */
	176	#define MODE_DISFORWARD 0x2000 /* disable channel forwarding */
92a79951	177	#define MODE_NOCTCP 0x8000 /* Block CTCPs directed to this channel */
6afd4b91	178	#define MODE_NONOTICE 0x16000 /* Block notices directed to this channel */
7e6c9180	179	#define MODE_NOACTION 0x32000 /* Block CTCP ACTION directed to this channel */
f9e91ece	180	#define MODE_NOKICK 0x64000 /* Disable /kick on this channel */
afd4834b	181	#define MODE_NONICK 0x128000 /* Disable /nick for anyone on this channel */
2b3c7c29	182	#define MODE_NOCAPS 0x256000 /* Block messages in all capital letters */
846aa234	183	#define MODE_NOREJOIN 0x512000 /* Block rejoin immediately after kick */
212380e3	184
	185	#define CHFL_BAN 0x10000000 /* ban channel flag */
	186	#define CHFL_EXCEPTION 0x20000000 /* exception to ban channel flag */
	187	#define CHFL_INVEX 0x40000000
	188	#define CHFL_QUIET 0x80000000
	189
	190	/* mode flags for direction indication */
	191	#define MODE_QUERY 0
	192	#define MODE_ADD 1
	193	#define MODE_DEL -1
	194
	195	#define SecretChannel(x) ((x) && ((x)->mode.mode & MODE_SECRET))
	196	#define HiddenChannel(x) ((x) && ((x)->mode.mode & MODE_PRIVATE))
	197	#define PubChannel(x) ((!x) \|\| ((x)->mode.mode &\
	198	(MODE_PRIVATE \| MODE_SECRET)) == 0)
	199
	200	/* channel visible */
	201	#define ShowChannel(v,c) (PubChannel(c) \|\| IsMember((v),(c)))
	202
	203	#define IsMember(who, chan) ((who && who->user && \
	204	find_channel_membership(chan, who)) ? 1 : 0)
	205
	206	#define IsChannelName(name) ((name) && ((name) == '#' \|\| (name) == '&'))
	207
	208	/* extban function results */
	209	#define EXTBAN_INVALID -1 /* invalid mask, false even if negated */
	210	#define EXTBAN_NOMATCH 0 /* valid mask, no match */
	211	#define EXTBAN_MATCH 1 /* matches */
	212
08d11e34	213	extern rb_dlink_list global_channel_list;
212380e3	214	void init_channels(void);
	215
	216	struct Channel allocate_channel(const char chname);
	217	void free_channel(struct Channel *chptr);
	218	struct Ban allocate_ban(const char , const char *);
	219	void free_ban(struct Ban *bptr);
	220
	221
	222	extern void destroy_channel(struct Channel *);
	223
	224	extern int can_send(struct Channel chptr, struct Client who,
	225	struct membership *);
	226	extern int is_banned(struct Channel chptr, struct Client who,
	227	struct membership msptr, const char , const char *);
	228	extern int is_quieted(struct Channel chptr, struct Client who,
	229	struct membership msptr, const char , const char *);
	230	extern int can_join(struct Client source_p, struct Channel chptr, char *key);
	231
	232	extern struct membership find_channel_membership(struct Channel , struct Client *);
	233	extern const char find_channel_status(struct membership msptr, int combine);
40c6b59b G	234	extern int is_halfop(struct membership *msptr);
40c6b59b G	235	extern int is_owner(struct membership *msptr);
d1c7eccf	236	extern int is_any_op(struct membership *msptr);
bbc69733	237	extern int is_chanop_voiced(struct membership *msptr);
b3b2ed97	238	extern int can_kick_deop(struct membership source, struct membership target);
212380e3	239	extern void add_user_to_channel(struct Channel , struct Client , int flags);
	240	extern void remove_user_from_channel(struct membership *);
	241	extern void remove_user_from_channels(struct Client *);
	242	extern void invalidate_bancache_user(struct Client *);
	243
08d11e34	244	extern void free_channel_list(rb_dlink_list *);
212380e3	245
	246	extern int check_channel_name(const char *name);
	247
	248	extern void channel_member_names(struct Channel chptr, struct Client ,
	249	int show_eon);
	250
	251	extern void del_invite(struct Channel chptr, struct Client who);
	252
	253	const char channel_modes(struct Channel chptr, struct Client *who);
	254
c279d43b G	255	extern int has_common_channel(struct Client client1, struct Client client2);
c279d43b G	256
212380e3	257	extern struct Channel find_bannickchange_channel(struct Client client_p);
212380e3	258
afd4834b G	259	extern struct Channel find_nonickchange_channel(struct Client client_p);
afd4834b G	260
212380e3	261	extern void check_spambot_warning(struct Client source_p, const char name);
	262
	263	extern void check_splitmode(void *);
	264
	265	void set_channel_topic(struct Channel chptr, const char topic,
	266	const char *topic_info, time_t topicts);
	267
	268	extern void init_chcap_usage_counts(void);
	269	extern void set_chcap_usage_counts(struct Client *serv_p);
	270	extern void unset_chcap_usage_counts(struct Client *serv_p);
	271	extern void send_cap_mode_changes(struct Client client_p, struct Client source_p,
	272	struct Channel *chptr, struct ChModeChange foo[], int);
	273
	274	extern void set_channel_mode(struct Client client_p, struct Client source_p,
	275	struct Channel chptr, struct membership msptr, int parc, const char *parv[]);
	276
	277	extern struct ChannelMode chmode_table[256];
	278
	279	extern int add_id(struct Client source_p, struct Channel chptr, const char *banid,
08d11e34	280	rb_dlink_list * list, long mode_type);
212380e3	281
08d11e34	282	extern int del_id(struct Channel chptr, const char banid, rb_dlink_list * list, long mode_type);
212380e3	283
	284	extern ExtbanFunc extban_table[256];
	285
	286	extern int match_extban(const char banstr, struct Client client_p, struct Channel *chptr, long mode_type);
	287	extern int valid_extban(const char banstr, struct Client client_p, struct Channel *chptr, long mode_type);
	288	const char * get_extban_string(void);
	289
67b90240	290	extern struct Channel * check_forward(struct Client source_p, struct Channel chptr, char *key);
677e21a4	291	extern void user_join(struct Client * client_p, struct Client * source_p, const char * channels, const char * keys);
9230426e JH	292	extern void do_join_0(struct Client client_p, struct Client source_p);
9230426e JH	293	extern int check_channel_name_loc(struct Client source_p, const char name);
212380e3	294
212380e3	295	#endif /* INCLUDED_channel_h */