[irc/evilnet/x3.git] / src / hash.h

/* hash.h - IRC network state database
 * Copyright 2000-2004 srvx Development Team
 *
 * This file is part of srvx.
 *
 * srvx 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 srvx; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */

#ifndef HASH_H
#define HASH_H

#include "common.h"
#include "dict.h"
#include "policer.h"

#define MODE_CHANOP		0x00000001 /* +o USER */
#define MODE_VOICE		0x00000002 /* +v USER */
#define MODE_PRIVATE		0x00000004 /* +p */
#define MODE_SECRET		0x00000008 /* +s */
#define MODE_MODERATED		0x00000010 /* +m */
#define MODE_TOPICLIMIT		0x00000020 /* +t */
#define MODE_INVITEONLY		0x00000040 /* +i */
#define MODE_NOPRIVMSGS		0x00000080 /* +n */
#define MODE_KEY		0x00000100 /* +k KEY */
#define MODE_BAN		0x00000200 /* +b BAN */
#define MODE_LIMIT		0x00000400 /* +l LIMIT */
#define MODE_DELAYJOINS         0x00000800 /* +D */
#define MODE_REGONLY            0x00001000 /* ircu +r, Bahamut +R */
#define MODE_NOCOLORS           0x00002000 /* +c */
#define MODE_NOCTCPS            0x00004000 /* +C */
#define MODE_REGISTERED         0x00008000 /* Bahamut +r */
#define MODE_STRIPCOLOR         0x00010000 /* +S Strip mirc color codes */
#define MODE_MODUNREG           0x00020000 /* +M mod unregister */
#define MODE_NONOTICE           0x00040000 /* +N no notices */
#define MODE_OPERSONLY          0x00080000 /* +O Opers only */
#define MODE_NOQUITMSGS         0x00100000 /* +Q suppress messages from quit notices */
#define MODE_NOAMSG             0x00200000 /* +T no multi-target messages */
#define MODE_SSLONLY            0x00400000 /* +z ssl only */
#define MODE_REMOVE             0x80000000

#define FLAGS_OPER		0x0001 /* Operator +O */
#define FLAGS_LOCOP		0x0002 /* Local operator +o */
#define FLAGS_INVISIBLE		0x0004 /* invisible +i */
#define FLAGS_WALLOP		0x0008 /* receives wallops +w */
#define FLAGS_SERVNOTICE	0x0010 /* receives server notices +s */
#define FLAGS_DEAF		0x0020 /* deaf +d */
#define FLAGS_SERVICE		0x0040 /* cannot be kicked, killed or deoped +k */
#define FLAGS_GLOBAL		0x0080 /* receives global messages +g */

// sethost - reed/apples
// #define FLAGS_HELPER		0x0100 /* (network?) helper +h */
#define FLAGS_SETHOST		0x0100 /* sethost +h */

#define FLAGS_PERSISTENT	0x0200 /* for reserved nicks, this isn't just one-shot */
#define FLAGS_GAGGED		0x0400 /* for gagged users */
#define FLAGS_AWAY		0x0800 /* for away users */
#define FLAGS_STAMPED           0x1000 /* for users who have been stamped */
#define FLAGS_HIDDEN_HOST       0x2000 /* user's host is masked by their account */
#define FLAGS_REGNICK           0x4000 /* user owns their current nick */
#define FLAGS_REGISTERING	0x8000 /* user has issued account register command, is waiting for email cookie */

#define IsOper(x)               ((x)->modes & FLAGS_OPER)
#define IsService(x)            ((x)->modes & FLAGS_SERVICE)
#define IsDeaf(x)               ((x)->modes & FLAGS_DEAF)
#define IsInvisible(x)          ((x)->modes & FLAGS_INVISIBLE)
#define IsGlobal(x)             ((x)->modes & FLAGS_GLOBAL)
#define IsWallOp(x)             ((x)->modes & FLAGS_WALLOP)
#define IsServNotice(x)         ((x)->modes & FLAGS_SERVNOTICE)

// sethost - reed/apples
// #define IsHelperIrcu(x)         ((x)->modes & FLAGS_HELPER)
#define IsSetHost(x)		((x)->modes & FLAGS_SETHOST)

#define IsGagged(x)             ((x)->modes & FLAGS_GAGGED)
#define IsPersistent(x)         ((x)->modes & FLAGS_PERSISTENT) 
#define IsAway(x)               ((x)->modes & FLAGS_AWAY)
#define IsStamped(x)            ((x)->modes & FLAGS_STAMPED)
#define IsHiddenHost(x)         ((x)->modes & FLAGS_HIDDEN_HOST)
#define IsReggedNick(x)         ((x)->modes & FLAGS_REGNICK)
#define IsRegistering(x)	((x)->modes & FLAGS_REGISTERING)
#define IsFakeHost(x)           ((x)->fakehost[0] != '\0')
#define IsLocal(x)              ((x)->uplink == self)

#define NICKLEN         30
#define USERLEN         10
#define HOSTLEN         63
#define REALLEN         50
#define TOPICLEN        250
#define CHANNELLEN      200

#define MAXMODEPARAMS	6
#define MAXBANS		45

/* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
#define IDLEN           6

DECLARE_LIST(userList, struct userNode*);
DECLARE_LIST(modeList, struct modeNode*);
DECLARE_LIST(banList, struct banNode*);
DECLARE_LIST(channelList, struct chanNode*);
DECLARE_LIST(serverList, struct server*);

struct userNode {
    char *nick;                   /* Unique name of the client, nick or host */
    char ident[USERLEN + 1];      /* Per-host identification for user */
    char info[REALLEN + 1];       /* Free form additional client information */
    char hostname[HOSTLEN + 1];   /* DNS name or IP address */
    char fakehost[HOSTLEN + 1];   /* Assigned fake host */
#ifdef WITH_PROTOCOL_P10
    char numeric[COMBO_NUMERIC_LEN+1];
    unsigned int num_local : 18;
#endif
    unsigned int dead : 1;        /* Is user waiting to be recycled? */
    struct in_addr ip;            /* User's IP address */
    long modes;                   /* user flags +isw etc... */

    // sethost - reed/apples
    char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */

    time_t timestamp;             /* Time of last nick change */
    struct server *uplink;        /* Server that user is connected to */
    struct modeList channels;     /* Vector of channels user is in */

    /* from nickserv */
    struct handle_info *handle_info;
    struct userNode *next_authed;
    struct policer auth_policer;
};

struct chanNode {
    chan_mode_t modes;
    unsigned int limit, locks;
    char key[KEYLEN + 1];
    time_t timestamp; /* creation time */
  
    char topic[TOPICLEN + 1];
    char topic_nick[NICKLEN + 1];
    time_t topic_time;

    struct modeList members;
    struct banList banlist;
    struct policer join_policer;
    unsigned int join_flooded : 1;
    unsigned int bad_channel : 1;

    struct chanData *channel_info;
    struct channel_help *channel_help;
    char name[1];
};

struct banNode {
    char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
    char who[NICKLEN + 1]; /* who set ban */
    time_t set; /* time ban was set */
};

struct modeNode {
    struct chanNode *channel;
    struct userNode *user;
    long modes;
    time_t idle_since;
};

#define SERVERNAMEMAX 64
#define SERVERDESCRIPTMAX 128

struct server {
    char name[SERVERNAMEMAX+1];
    time_t boot;
    time_t link;
    char description[SERVERDESCRIPTMAX+1];
#ifdef WITH_PROTOCOL_P10
    char numeric[COMBO_NUMERIC_LEN+1];
    unsigned int num_mask;
#endif
    unsigned int hops, clients, max_clients;
    unsigned int burst : 1, self_burst : 1;
    struct server *uplink;
#ifdef WITH_PROTOCOL_P10
    struct userNode **users; /* flat indexed by numeric */
#else
    dict_t users; /* indexed by nick */
#endif
    struct serverList children;
};

extern struct server *self;
extern dict_t channels;
extern dict_t clients;
extern dict_t servers;
extern unsigned int max_clients, invis_clients;
extern time_t max_clients_time;
extern struct userList curr_opers, curr_helpers;

struct server* GetServerH(const char *name); /* using full name */
struct userNode* GetUserH(const char *nick);   /* using nick */
struct chanNode* GetChannel(const char *name);
struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);

typedef void (*server_link_func_t) (struct server *server);
void reg_server_link_func(server_link_func_t handler);

typedef int (*new_user_func_t) (struct userNode *user);
void reg_new_user_func(new_user_func_t handler);
typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
void reg_del_user_func(del_user_func_t handler);
void unreg_del_user_func(del_user_func_t handler);
void ReintroduceUser(struct userNode* user);
typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
void reg_nick_change_func(nick_change_func_t handler);
void NickChange(struct userNode* user, const char *new_nick, int no_announce);

typedef void (*account_func_t) (struct userNode *user, const char *stamp);
void reg_account_func(account_func_t handler);
void call_account_func(struct userNode *user, const char *stamp);
void StampUser(struct userNode *user, const char *stamp);
void assign_fakehost(struct userNode *user, const char *host, int announce);

typedef void (*new_channel_func_t) (struct chanNode *chan);
void reg_new_channel_func(new_channel_func_t handler);
typedef int (*join_func_t) (struct modeNode *mNode);
void reg_join_func(join_func_t handler);
typedef void (*del_channel_func_t) (struct chanNode *chan);
void reg_del_channel_func(del_channel_func_t handler);

struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist);
void LockChannel(struct chanNode *channel);
void UnlockChannel(struct chanNode *channel);

struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);

typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
void reg_part_func(part_func_t handler);
void unreg_part_func(part_func_t handler);
void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);

typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
void reg_kick_func(kick_func_t handler);
void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);

int ChannelBanExists(struct chanNode *channel, const char *ban);

typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
void reg_topic_func(topic_func_t handler);
void SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *topic, int announce);

void init_structs(void);

#endif
Commit	Line	Data
d76ed9a9	1	/* hash.h - IRC network state database
	2	* Copyright 2000-2004 srvx Development Team
	3	*
	4	* This file is part of srvx.
	5	*
	6	* srvx is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with srvx; if not, write to the Free Software Foundation,
	18	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
	19	*/
	20
	21	#ifndef HASH_H
	22	#define HASH_H
	23
	24	#include "common.h"
	25	#include "dict.h"
	26	#include "policer.h"
	27
d0cb2fb6	28	#define MODE_CHANOP 0x00000001 /* +o USER */
	29	#define MODE_VOICE 0x00000002 /* +v USER */
	30	#define MODE_PRIVATE 0x00000004 /* +p */
	31	#define MODE_SECRET 0x00000008 /* +s */
	32	#define MODE_MODERATED 0x00000010 /* +m */
	33	#define MODE_TOPICLIMIT 0x00000020 /* +t */
	34	#define MODE_INVITEONLY 0x00000040 /* +i */
	35	#define MODE_NOPRIVMSGS 0x00000080 /* +n */
	36	#define MODE_KEY 0x00000100 /* +k KEY */
	37	#define MODE_BAN 0x00000200 /* +b BAN */
	38	#define MODE_LIMIT 0x00000400 /* +l LIMIT */
	39	#define MODE_DELAYJOINS 0x00000800 /* +D */
	40	#define MODE_REGONLY 0x00001000 /* ircu +r, Bahamut +R */
	41	#define MODE_NOCOLORS 0x00002000 /* +c */
	42	#define MODE_NOCTCPS 0x00004000 /* +C */
	43	#define MODE_REGISTERED 0x00008000 /* Bahamut +r */
	44	#define MODE_STRIPCOLOR 0x00010000 /* +S Strip mirc color codes */
	45	#define MODE_MODUNREG 0x00020000 /* +M mod unregister */
	46	#define MODE_NONOTICE 0x00040000 /* +N no notices */
	47	#define MODE_OPERSONLY 0x00080000 /* +O Opers only */
	48	#define MODE_NOQUITMSGS 0x00100000 /* +Q suppress messages from quit notices */
	49	#define MODE_NOAMSG 0x00200000 /* +T no multi-target messages */
	50	#define MODE_SSLONLY 0x00400000 /* +z ssl only */
d76ed9a9	51	#define MODE_REMOVE 0x80000000
	52
	53	#define FLAGS_OPER 0x0001 /* Operator +O */
	54	#define FLAGS_LOCOP 0x0002 /* Local operator +o */
	55	#define FLAGS_INVISIBLE 0x0004 /* invisible +i */
	56	#define FLAGS_WALLOP 0x0008 /* receives wallops +w */
	57	#define FLAGS_SERVNOTICE 0x0010 /* receives server notices +s */
	58	#define FLAGS_DEAF 0x0020 /* deaf +d */
	59	#define FLAGS_SERVICE 0x0040 /* cannot be kicked, killed or deoped +k */
	60	#define FLAGS_GLOBAL 0x0080 /* receives global messages +g */
182dd032	61
	62	// sethost - reed/apples
	63	// #define FLAGS_HELPER 0x0100 /* (network?) helper +h */
	64	#define FLAGS_SETHOST 0x0100 /* sethost +h */
	65
d76ed9a9	66	#define FLAGS_PERSISTENT 0x0200 /* for reserved nicks, this isn't just one-shot */
	67	#define FLAGS_GAGGED 0x0400 /* for gagged users */
	68	#define FLAGS_AWAY 0x0800 /* for away users */
	69	#define FLAGS_STAMPED 0x1000 /* for users who have been stamped */
	70	#define FLAGS_HIDDEN_HOST 0x2000 /* user's host is masked by their account */
	71	#define FLAGS_REGNICK 0x4000 /* user owns their current nick */
	72	#define FLAGS_REGISTERING 0x8000 /* user has issued account register command, is waiting for email cookie */
	73
	74	#define IsOper(x) ((x)->modes & FLAGS_OPER)
	75	#define IsService(x) ((x)->modes & FLAGS_SERVICE)
	76	#define IsDeaf(x) ((x)->modes & FLAGS_DEAF)
	77	#define IsInvisible(x) ((x)->modes & FLAGS_INVISIBLE)
	78	#define IsGlobal(x) ((x)->modes & FLAGS_GLOBAL)
	79	#define IsWallOp(x) ((x)->modes & FLAGS_WALLOP)
	80	#define IsServNotice(x) ((x)->modes & FLAGS_SERVNOTICE)
182dd032	81
	82	// sethost - reed/apples
	83	// #define IsHelperIrcu(x) ((x)->modes & FLAGS_HELPER)
	84	#define IsSetHost(x) ((x)->modes & FLAGS_SETHOST)
	85
d76ed9a9	86	#define IsGagged(x) ((x)->modes & FLAGS_GAGGED)
	87	#define IsPersistent(x) ((x)->modes & FLAGS_PERSISTENT)
	88	#define IsAway(x) ((x)->modes & FLAGS_AWAY)
	89	#define IsStamped(x) ((x)->modes & FLAGS_STAMPED)
	90	#define IsHiddenHost(x) ((x)->modes & FLAGS_HIDDEN_HOST)
	91	#define IsReggedNick(x) ((x)->modes & FLAGS_REGNICK)
	92	#define IsRegistering(x) ((x)->modes & FLAGS_REGISTERING)
	93	#define IsFakeHost(x) ((x)->fakehost[0] != '\0')
	94	#define IsLocal(x) ((x)->uplink == self)
	95
	96	#define NICKLEN 30
	97	#define USERLEN 10
	98	#define HOSTLEN 63
	99	#define REALLEN 50
	100	#define TOPICLEN 250
	101	#define CHANNELLEN 200
	102
	103	#define MAXMODEPARAMS 6
	104	#define MAXBANS 45
	105
	106	/* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
	107	#define IDLEN 6
	108
	109	DECLARE_LIST(userList, struct userNode*);
	110	DECLARE_LIST(modeList, struct modeNode*);
	111	DECLARE_LIST(banList, struct banNode*);
	112	DECLARE_LIST(channelList, struct chanNode*);
	113	DECLARE_LIST(serverList, struct server*);
	114
	115	struct userNode {
	116	char nick; / Unique name of the client, nick or host */
	117	char ident[USERLEN + 1]; /* Per-host identification for user */
	118	char info[REALLEN + 1]; /* Free form additional client information */
	119	char hostname[HOSTLEN + 1]; /* DNS name or IP address */
	120	char fakehost[HOSTLEN + 1]; /* Assigned fake host */
	121	#ifdef WITH_PROTOCOL_P10
	122	char numeric[COMBO_NUMERIC_LEN+1];
	123	unsigned int num_local : 18;
	124	#endif
	125	unsigned int dead : 1; /* Is user waiting to be recycled? */
	126	struct in_addr ip; /* User's IP address */
	127	long modes; /* user flags +isw etc... */
	128
182dd032	129	// sethost - reed/apples
	130	char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */
	131
d76ed9a9	132	time_t timestamp; /* Time of last nick change */
	133	struct server uplink; / Server that user is connected to */
	134	struct modeList channels; /* Vector of channels user is in */
	135
	136	/* from nickserv */
	137	struct handle_info *handle_info;
	138	struct userNode *next_authed;
	139	struct policer auth_policer;
	140	};
	141
	142	struct chanNode {
	143	chan_mode_t modes;
	144	unsigned int limit, locks;
	145	char key[KEYLEN + 1];
	146	time_t timestamp; /* creation time */
	147
	148	char topic[TOPICLEN + 1];
	149	char topic_nick[NICKLEN + 1];
	150	time_t topic_time;
	151
	152	struct modeList members;
	153	struct banList banlist;
	154	struct policer join_policer;
	155	unsigned int join_flooded : 1;
	156	unsigned int bad_channel : 1;
	157
	158	struct chanData *channel_info;
	159	struct channel_help *channel_help;
	160	char name[1];
	161	};
	162
	163	struct banNode {
	164	char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
	165	char who[NICKLEN + 1]; /* who set ban */
	166	time_t set; /* time ban was set */
	167	};
	168
	169	struct modeNode {
	170	struct chanNode *channel;
	171	struct userNode *user;
	172	long modes;
	173	time_t idle_since;
	174	};
	175
	176	#define SERVERNAMEMAX 64
	177	#define SERVERDESCRIPTMAX 128
	178
	179	struct server {
	180	char name[SERVERNAMEMAX+1];
	181	time_t boot;
	182	time_t link;
	183	char description[SERVERDESCRIPTMAX+1];
	184	#ifdef WITH_PROTOCOL_P10
	185	char numeric[COMBO_NUMERIC_LEN+1];
	186	unsigned int num_mask;
	187	#endif
	188	unsigned int hops, clients, max_clients;
	189	unsigned int burst : 1, self_burst : 1;
	190	struct server *uplink;
	191	#ifdef WITH_PROTOCOL_P10
	192	struct userNode *users; / flat indexed by numeric */
	193	#else
	194	dict_t users; /* indexed by nick */
	195	#endif
196	struct serverList children;
197	};
198
199	extern struct server *self;
200	extern dict_t channels;
201	extern dict_t clients;
202	extern dict_t servers;
203	extern unsigned int max_clients, invis_clients;
204	extern time_t max_clients_time;
205	extern struct userList curr_opers, curr_helpers;
206
207	struct server* GetServerH(const char name); / using full name */
208	struct userNode* GetUserH(const char nick); / using nick */
209	struct chanNode* GetChannel(const char *name);
210	struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
211
212	typedef void (server_link_func_t) (struct server server);
213	void reg_server_link_func(server_link_func_t handler);
214
215	typedef int (new_user_func_t) (struct userNode user);
216	void reg_new_user_func(new_user_func_t handler);
217	typedef void (del_user_func_t) (struct userNode user, struct userNode killer, const char why);
218	void reg_del_user_func(del_user_func_t handler);
219	void unreg_del_user_func(del_user_func_t handler);
220	void ReintroduceUser(struct userNode* user);
221	typedef void (nick_change_func_t)(struct userNode user, const char *old_nick);
222	void reg_nick_change_func(nick_change_func_t handler);
223	void NickChange(struct userNode* user, const char *new_nick, int no_announce);
224
225	typedef void (account_func_t) (struct userNode user, const char *stamp);
226	void reg_account_func(account_func_t handler);
227	void call_account_func(struct userNode user, const char stamp);
228	void StampUser(struct userNode user, const char stamp);
229	void assign_fakehost(struct userNode user, const char host, int announce);
230
231	typedef void (new_channel_func_t) (struct chanNode chan);
232	void reg_new_channel_func(new_channel_func_t handler);
233	typedef int (join_func_t) (struct modeNode mNode);
234	void reg_join_func(join_func_t handler);
235	typedef void (del_channel_func_t) (struct chanNode chan);
236	void reg_del_channel_func(del_channel_func_t handler);
237
238	struct chanNode* AddChannel(const char name, time_t time_, const char modes, char *banlist);
239	void LockChannel(struct chanNode *channel);
240	void UnlockChannel(struct chanNode *channel);
241
242	struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
243
244	typedef void (part_func_t) (struct modeNode mn, const char *reason);
245	void reg_part_func(part_func_t handler);
246	void unreg_part_func(part_func_t handler);
247	void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
248	void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode kicker, const char why);
249
250	typedef void (kick_func_t) (struct userNode kicker, struct userNode user, struct chanNode chan);
251	void reg_kick_func(kick_func_t handler);
252	void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
253
254	int ChannelBanExists(struct chanNode channel, const char ban);
255
256	typedef int (topic_func_t)(struct userNode who, struct chanNode chan, const char old_topic);
257	void reg_topic_func(topic_func_t handler);
258	void SetChannelTopic(struct chanNode channel, struct userNode user, const char *topic, int announce);
259
260	void init_structs(void);
261
262	#endif