1 /* hash.h - IRC network state database
2 * Copyright 2000-2006 srvx Development Team
4 * This file is part of srvx.
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.
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.
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.
28 #define MODE_CHANOP 0x0001 /* +o USER */
29 #define MODE_VOICE 0x0002 /* +v USER */
30 #define MODE_PRIVATE 0x0004 /* +p */
31 #define MODE_SECRET 0x0008 /* +s */
32 #define MODE_MODERATED 0x0010 /* +m */
33 #define MODE_TOPICLIMIT 0x0020 /* +t */
34 #define MODE_INVITEONLY 0x0040 /* +i */
35 #define MODE_NOPRIVMSGS 0x0080 /* +n */
36 #define MODE_KEY 0x0100 /* +k KEY */
37 #define MODE_BAN 0x0200 /* +b BAN */
38 #define MODE_LIMIT 0x0400 /* +l LIMIT */
39 #define MODE_DELAYJOINS 0x0800 /* +D */
40 #define MODE_REGONLY 0x1000 /* ircu +r, Bahamut +R */
41 #define MODE_NOCOLORS 0x2000 /* +c */
42 #define MODE_NOCTCPS 0x4000 /* +C */
43 #define MODE_REGISTERED 0x8000 /* Bahamut +r */
44 #define MODE_APASS 0x10000 /* +A adminpass */
45 #define MODE_UPASS 0x20000 /* +U userpass */
46 #define MODE_NONOTICES 0x40000 /* +N */
47 #define MODE_NOAMSGS 0x80000 /* +M */
48 #define MODE_ALTCHAN 0x100000 /* +F */
49 #define MODE_ACCESS 0x200000 /* +a */
50 #define MODE_NOFLOOD 0x400000 /* +f */
51 #define MODE_AUDITORIUM 0x800000 /* +u */
52 #define MODE_SSLCHAN 0x1000000 /* +S */
53 #define MODE_REMOVE 0x80000000
55 #define FLAGS_OPER 0x0001 /* +o global operator */
56 #define FLAGS_INVISIBLE 0x0004 /* +i invisible */
57 #define FLAGS_WALLOP 0x0008 /* +w receives wallops */
58 #define FLAGS_DEAF 0x0020 /* +d deaf */
59 #define FLAGS_SERVICE 0x0040 /* +k cannot be kicked, killed or deoped */
60 #define FLAGS_GLOBAL 0x0080 /* +g receives global messages */
61 #define FLAGS_NOCHAN 0x0100 /* +n hide channels in whois */
62 #define FLAGS_PERSISTENT 0x0200 /* for reserved nicks, this isn't just one-shot */
63 #define FLAGS_GAGGED 0x0400 /* for gagged users */
64 #define FLAGS_AWAY 0x0800 /* for away users */
65 #define FLAGS_STAMPED 0x1000 /* for users who have been stamped */
66 #define FLAGS_HIDDEN_HOST 0x2000 /* +x user's host is masked by their account */
67 #define FLAGS_REGNICK 0x4000 /* +r user owns their current nick */
68 #define FLAGS_REGISTERING 0x8000 /* user has issued account register command, is waiting for email cookie */
69 #define FLAGS_DUMMY 0x10000 /* user is not announced to other servers */
70 #define FLAGS_NOIDLE 0x20000 /* +I hide idle time in whois */
71 #define FLAGS_NETSERV 0x40000 /* +S */
72 #define FLAGS_SECURITYSERV 0x80000 /* +D */
73 #define FLAGS_XTRAOP 0x100000 /* +X */
74 #define FLAGS_HIDDENOPER 0x200000 /* +H */
75 #define FLAGS_SERVERNOTICE 0x400000 /* +s */
76 #define FLAGS_SEENOIDLE 0x800000 /* +t */
78 #define IsOper(x) ((x)->modes & FLAGS_OPER)
79 #define IsService(x) ((x)->modes & FLAGS_SERVICE)
80 #define IsDeaf(x) ((x)->modes & FLAGS_DEAF)
81 #define IsInvisible(x) ((x)->modes & FLAGS_INVISIBLE)
82 #define IsGlobal(x) ((x)->modes & FLAGS_GLOBAL)
83 #define IsNoChan(x) ((x)->modes & FLAGS_NOCHAN)
84 #define IsWallOp(x) ((x)->modes & FLAGS_WALLOP)
85 #define IsGagged(x) ((x)->modes & FLAGS_GAGGED)
86 #define IsPersistent(x) ((x)->modes & FLAGS_PERSISTENT)
87 #define IsAway(x) ((x)->modes & FLAGS_AWAY)
88 #define IsStamped(x) ((x)->modes & FLAGS_STAMPED)
89 #define IsHiddenHost(x) ((x)->modes & FLAGS_HIDDEN_HOST)
90 #define IsReggedNick(x) ((x)->modes & FLAGS_REGNICK)
91 #define IsRegistering(x) ((x)->modes & FLAGS_REGISTERING)
92 #define IsDummy(x) ((x)->modes & FLAGS_DUMMY)
93 #define IsNoIdle(x) ((x)->modes & FLAGS_NOIDLE)
94 #define IsSecurityServ(x) ((x)->modes & FLAGS_SECURITYSERV)
95 #define IsNetServ(x) ((x)->modes & FLAGS_NETSERV)
96 #define IsXtraOp(x) ((x)->modes & FLAGS_XTRAOP)
97 #define IsServerNotice(x) ((x)->modes & FLAGS_SERVERNOTICE)
98 #define IsHiddenOper(x) ((x)->modes & FLAGS_HIDDENOPER)
99 #define IsSeeNoIdle(x) ((x)->modes & FLAGS_SEENOIDLE)
100 #define IsFakeHost(x) ((x)->fakehost[0] != '\0')
101 #define IsFakeIdent(x) ((x)->fakeident[0] != '\0')
102 #define IsLocal(x) ((x)->uplink == self)
104 #define NOFLOODLEN 15
110 #define CHANNELLEN 200
111 #define MAXOPLEVEL 999
113 #define MAXMODEPARAMS 6
116 /* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
119 DECLARE_LIST(userList, struct userNode*);
120 DECLARE_LIST(modeList, struct modeNode*);
121 DECLARE_LIST(banList, struct banNode*);
122 DECLARE_LIST(channelList, struct chanNode*);
123 DECLARE_LIST(serverList, struct server*);
126 char *nick; /* Unique name of the client, nick or host */
127 char ident[USERLEN + 1]; /* Per-host identification for user */
128 char info[REALLEN + 1]; /* Free form additional client information */
129 char hostname[HOSTLEN + 1]; /* DNS name or IP address */
130 char fakehost[HOSTLEN + 1]; /* Assigned fake host */
131 char fakeident[USERLEN + 1]; /* Assigned fake ident */
132 #ifdef WITH_PROTOCOL_P10
133 char numeric[COMBO_NUMERIC_LEN+1];
134 unsigned int num_local : 18;
136 unsigned int dead : 1; /* Is user waiting to be recycled? */
137 irc_in_addr_t ip; /* User's IP address */
138 long modes; /* user flags +isw etc... */
140 unsigned long timestamp; /* Time of last nick change */
141 unsigned long idle_since; /* Last time user did something on or to a channel */
142 struct server *uplink; /* Server that user is connected to */
143 struct modeList channels; /* Vector of channels user is in */
146 struct handle_info *handle_info;
147 struct userNode *next_authed;
148 struct policer auth_policer;
156 char key[KEYLEN + 1];
157 char altchan[CHANNELLEN + 1];
158 char noflood[NOFLOODLEN + 1];
159 char upass[KEYLEN + 1];
160 char apass[KEYLEN + 1];
161 unsigned long timestamp; /* creation time */
163 char topic[TOPICLEN + 1];
164 char topic_nick[NICKLEN + 1];
165 unsigned long topic_time;
167 struct modeList members;
168 struct banList banlist;
169 struct policer join_policer;
170 struct userList invited;
171 unsigned int join_flooded : 1;
172 unsigned int bad_channel : 1;
174 struct chanData *channel_info;
175 struct channel_help *channel_help;
180 char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
181 char who[NICKLEN + 1]; /* who set ban */
182 unsigned long set; /* time ban was set */
186 struct chanNode *channel;
187 struct userNode *user;
188 unsigned short modes;
190 unsigned long idle_since;
193 #define SERVERNAMEMAX 64
194 #define SERVERDESCRIPTMAX 128
197 char name[SERVERNAMEMAX+1];
199 unsigned long link_time;
200 char description[SERVERDESCRIPTMAX+1];
201 #ifdef WITH_PROTOCOL_P10
202 char numeric[COMBO_NUMERIC_LEN+1];
203 unsigned int num_mask;
205 unsigned int hops, clients, max_clients;
206 unsigned int burst : 1, self_burst : 1;
207 struct server *uplink;
208 #ifdef WITH_PROTOCOL_P10
209 struct userNode **users; /* flat indexed by numeric */
211 dict_t users; /* indexed by nick */
213 struct serverList children;
216 extern struct server *self;
217 extern dict_t channels;
218 extern dict_t clients;
219 extern dict_t servers;
220 extern unsigned int max_clients, invis_clients;
221 extern unsigned long max_clients_time;
222 extern struct userList curr_opers, curr_helpers;
224 struct server* GetServerH(const char *name); /* using full name */
225 struct userNode* GetUserH(const char *nick); /* using nick */
226 struct chanNode* GetChannel(const char *name);
227 struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
229 int userList_contains(struct userList *list, struct userNode *user);
231 typedef void (*server_link_func_t) (struct server *server);
232 void reg_server_link_func(server_link_func_t handler);
234 typedef void (*new_user_func_t) (struct userNode *user);
235 void reg_new_user_func(new_user_func_t handler);
236 typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
237 void reg_del_user_func(del_user_func_t handler);
238 void unreg_del_user_func(del_user_func_t handler);
239 void ReintroduceUser(struct userNode* user);
240 typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
241 void reg_nick_change_func(nick_change_func_t handler);
242 void NickChange(struct userNode* user, const char *new_nick, int no_announce);
244 typedef void (*account_func_t) (struct userNode *user, const char *stamp, unsigned long timestamp, unsigned long serial);
245 void reg_account_func(account_func_t handler);
246 void call_account_func(struct userNode *user, const char *stamp, unsigned long timestamp, unsigned long serial);
247 void StampUser(struct userNode *user, const char *stamp, unsigned long timestamp, unsigned long serial);
248 void assign_fakehost(struct userNode *user, const char *host, const char *ident, int force, int announce);
250 typedef void (*new_channel_func_t) (struct chanNode *chan);
251 void reg_new_channel_func(new_channel_func_t handler);
252 typedef int (*join_func_t) (struct modeNode *mNode);
253 void reg_join_func(join_func_t handler);
254 typedef void (*del_channel_func_t) (struct chanNode *chan);
255 void reg_del_channel_func(del_channel_func_t handler);
257 struct chanNode* AddChannel(const char *name, unsigned long time_, const char *modes, char *banlist);
258 void LockChannel(struct chanNode *channel);
259 void UnlockChannel(struct chanNode *channel);
261 struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
263 int modeNode_sort(const void *pa, const void *pb);
264 typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
265 void reg_part_func(part_func_t handler);
266 void unreg_part_func(part_func_t handler);
267 void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
268 void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);
270 typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
271 void reg_kick_func(kick_func_t handler);
272 void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
274 int ChannelBanExists(struct chanNode *channel, const char *ban);
276 typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
277 void reg_topic_func(topic_func_t handler);
278 void SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *topic, int announce);
280 void init_structs(void);