]> jfr.im git - irc/evilnet/x3.git/blame - src/hash.h
more python work. Not safe to run yet
[irc/evilnet/x3.git] / src / hash.h
CommitLineData
d76ed9a9
AS
1/* hash.h - IRC network state database
2 * Copyright 2000-2004 srvx Development Team
3 *
83ff05c3 4 * This file is part of x3.
d76ed9a9 5 *
d0f04f71 6 * x3 is free software; you can redistribute it and/or modify
d76ed9a9 7 * it under the terms of the GNU General Public License as published by
348683aa 8 * the Free Software Foundation; either version 3 of the License, or
d76ed9a9
AS
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
AS
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 */
7827220c 40#define MODE_REGONLY 0x00001000 /* ircu +r */
d0cb2fb6
AS
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 */
c8ca69a0 50#define MODE_SSLONLY 0x00400000 /* +Z ssl only */
55342ce8 51#define MODE_HALFOP 0x00800000 /* +h USER */
2aef5f4b 52#define MODE_EXEMPT 0x01000000 /* +e exempt */
88c7cb10 53#define MODE_HIDEMODE 0x02000000 /* +L hide modes */
2f61d1d7 54#define MODE_APASS 0x04000000 /* +A adminpass */
55#define MODE_UPASS 0x08000000 /* +U userpass */
4648ded2 56#define MODE_ADMINSONLY 0x10000000 /* +a Admins only */
d76ed9a9
AS
57#define MODE_REMOVE 0x80000000
58
cf8bedff 59#define FLAGS_OPER 0x000001 /* Operator +O */
60#define FLAGS_LOCOP 0x000002 /* Local operator +o */
61#define FLAGS_INVISIBLE 0x000004 /* invisible +i */
62#define FLAGS_WALLOP 0x000008 /* receives wallops +w */
63#define FLAGS_SERVNOTICE 0x000010 /* receives server notices +s */
64#define FLAGS_DEAF 0x000020 /* deaf +d */
65#define FLAGS_SERVICE 0x000040 /* cannot be kicked, killed or deoped +k */
66#define FLAGS_GLOBAL 0x000080 /* receives global messages +g */
67#define FLAGS_SETHOST 0x000100 /* sethost +h */
68#define FLAGS_PERSISTENT 0x000200 /* for reserved nicks, this isn't just one-shot */
69#define FLAGS_GAGGED 0x000400 /* for gagged users */
70#define FLAGS_AWAY 0x000800 /* for away users */
71#define FLAGS_STAMPED 0x001000 /* for users who have been stamped */
72#define FLAGS_HIDDEN_HOST 0x002000 /* user's host is masked by their account */
73#define FLAGS_REGNICK 0x004000 /* user owns their current nick */
74#define FLAGS_REGISTERING 0x008000 /* user has issued account register command, is waiting for email cookie */
75#define FLAGS_BOT 0x010000 /* Bot +B */
76#define FLAGS_HIDECHANS 0x020000 /* Hidden channels +n */
77#define FLAGS_HIDEIDLE 0x040000 /* Hidden idle time +I */
78#define FLAGS_XTRAOP 0x080000 /* Hidden idle time */
79#define FLAGS_CLOAKHOST 0x100000 /* user has cloaked host */
80#define FLAGS_CLOAKIP 0x200000 /* user has cloaked ip */
d76ed9a9
AS
81
82#define IsOper(x) ((x)->modes & FLAGS_OPER)
83#define IsService(x) ((x)->modes & FLAGS_SERVICE)
84#define IsDeaf(x) ((x)->modes & FLAGS_DEAF)
85#define IsInvisible(x) ((x)->modes & FLAGS_INVISIBLE)
86#define IsGlobal(x) ((x)->modes & FLAGS_GLOBAL)
87#define IsWallOp(x) ((x)->modes & FLAGS_WALLOP)
88#define IsServNotice(x) ((x)->modes & FLAGS_SERVNOTICE)
cf8bedff 89#define IsBotM(x) ((x)->modes & FLAGS_BOT)
90#define IsHideChans(x) ((x)->modes & FLAGS_HIDECHANS)
91#define IsHideIdle(x) ((x)->modes & FLAGS_HIDEIDLE)
92#define IsXtraOp(x) ((x)->modes & FLAGS_XTRAOP)
182dd032 93#define IsSetHost(x) ((x)->modes & FLAGS_SETHOST)
d76ed9a9
AS
94#define IsGagged(x) ((x)->modes & FLAGS_GAGGED)
95#define IsPersistent(x) ((x)->modes & FLAGS_PERSISTENT)
96#define IsAway(x) ((x)->modes & FLAGS_AWAY)
97#define IsStamped(x) ((x)->modes & FLAGS_STAMPED)
98#define IsHiddenHost(x) ((x)->modes & FLAGS_HIDDEN_HOST)
99#define IsReggedNick(x) ((x)->modes & FLAGS_REGNICK)
100#define IsRegistering(x) ((x)->modes & FLAGS_REGISTERING)
101#define IsFakeHost(x) ((x)->fakehost[0] != '\0')
102#define IsLocal(x) ((x)->uplink == self)
103
104#define NICKLEN 30
105#define USERLEN 10
106#define HOSTLEN 63
68b75482 107#define SOCKIPLEN 45
258d1427 108#define ACCOUNTLEN 15
d76ed9a9
AS
109#define REALLEN 50
110#define TOPICLEN 250
111#define CHANNELLEN 200
6d58d26f 112#define MARKLEN 200
2f61d1d7 113#define MAXOPLEVEL 999
d76ed9a9
AS
114
115#define MAXMODEPARAMS 6
ac3bdc8d 116#define MAXBANS 128
2aef5f4b 117#define MAXEXEMPTS 45
d76ed9a9
AS
118
119/* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
120#define IDLEN 6
121
89d871d8 122/** Operator privileges. */
123enum Priv {
124 PRIV_CHAN_LIMIT, /**< no channel limit on oper */
125 PRIV_MODE_LCHAN, /**< oper can mode local chans */
126 PRIV_WALK_LCHAN, /**< oper can walk through local modes */
127 PRIV_DEOP_LCHAN, /**< no deop oper on local chans */
128 PRIV_SHOW_INVIS, /**< show local invisible users */
129 PRIV_SHOW_ALL_INVIS, /**< show all invisible users */
130 PRIV_UNLIMIT_QUERY, /**< unlimit who queries */
131 PRIV_KILL, /**< oper can KILL */
132 PRIV_LOCAL_KILL, /**< oper can local KILL */
133 PRIV_REHASH, /**< oper can REHASH */
134 PRIV_REMOTEREHASH, /**< oper can remote REHASH */
135 PRIV_RESTART, /**< oper can RESTART */
136 PRIV_DIE, /**< oper can DIE */
625ccd4e
MB
137 PRIV_ZLINE, /**< oper can ZLINE */
138 PRIV_LOCAL_ZLINE, /**< oper can local ZLINE */
89d871d8 139 PRIV_GLINE, /**< oper can GLINE */
140 PRIV_LOCAL_GLINE, /**< oper can local GLINE */
141 PRIV_SHUN, /**< oper can SHUN */
142 PRIV_LOCAL_SHUN, /**< oper can local SHUN */
143 PRIV_JUPE, /**< oper can JUPE */
144 PRIV_LOCAL_JUPE, /**< oper can local JUPE */
145 PRIV_OPMODE, /**< oper can OP/CLEARMODE */
146 PRIV_LOCAL_OPMODE, /**< oper can local OP/CLEARMODE */
147 PRIV_SET, /**< oper can SET */
148 PRIV_WHOX, /**< oper can use /who x */
149 PRIV_BADCHAN, /**< oper can BADCHAN */
150 PRIV_LOCAL_BADCHAN, /**< oper can local BADCHAN */
151 PRIV_SEE_CHAN, /**< oper can see in secret chans */
152 PRIV_PROPAGATE, /**< propagate oper status */
153 PRIV_DISPLAY, /**< "Is an oper" displayed */
154 PRIV_SEE_OPERS, /**< display hidden opers */
155 PRIV_WIDE_GLINE, /**< oper can set wider G-lines */
625ccd4e 156 PRIV_WIDE_ZLINE, /**< oper can set wider Z-Lines */
89d871d8 157 PRIV_WIDE_SHUN, /**< oper can set wider G-lines */
158 PRIV_LIST_CHAN, /**< oper can list secret channels */
159 PRIV_FORCE_OPMODE, /**< can hack modes on quarantined channels */
160 PRIV_FORCE_LOCAL_OPMODE, /**< can hack modes on quarantined local channels */
161 PRIV_CHECK, /**< oper can use CHECK */
162 PRIV_SEE_SECRET_CHAN, /**< oper can see +s channels in whois */
055f3f30
MB
163 PRIV_WHOIS_NOTICE, /**< oper can set/unset user mode +W */
164 PRIV_HIDE_IDLE, /**< oper can set/unset user mode +I */
165 PRIV_XTRAOP, /**< oper can set/unset user mode +X */
166 PRIV_HIDE_CHANNELS, /**< oper can set/unset user mode +n */
89d871d8 167 PRIV_LAST_PRIV /**< number of privileges */
168};
169
170/** Number of bits */
171#define _PRIV_NBITS (8 * sizeof(unsigned long))
172/** Element number for priv \a priv. */
173#define _PRIV_IDX(priv) ((priv) / _PRIV_NBITS)
174/** Element bit for priv \a priv. */
175#define _PRIV_BIT(priv) (1UL << ((priv) % _PRIV_NBITS))
176
177/** Operator privileges. */
178struct Privs {
179 unsigned long priv_mask[(PRIV_LAST_PRIV + _PRIV_NBITS - 1) / _PRIV_NBITS];
180};
181
d76ed9a9
AS
182DECLARE_LIST(userList, struct userNode*);
183DECLARE_LIST(modeList, struct modeNode*);
184DECLARE_LIST(banList, struct banNode*);
2aef5f4b 185DECLARE_LIST(exemptList, struct exemptNode*);
d76ed9a9
AS
186DECLARE_LIST(channelList, struct chanNode*);
187DECLARE_LIST(serverList, struct server*);
188
189struct userNode {
190 char *nick; /* Unique name of the client, nick or host */
191 char ident[USERLEN + 1]; /* Per-host identification for user */
192 char info[REALLEN + 1]; /* Free form additional client information */
193 char hostname[HOSTLEN + 1]; /* DNS name or IP address */
194 char fakehost[HOSTLEN + 1]; /* Assigned fake host */
37ef8ee3 195 char crypthost[HOSTLEN + 30]; /* Crypted hostname */
196 char cryptip[SOCKIPLEN + 30]; /* Crypted IP */
d76ed9a9
AS
197#ifdef WITH_PROTOCOL_P10
198 char numeric[COMBO_NUMERIC_LEN+1];
199 unsigned int num_local : 18;
200#endif
3fdd6a74 201 unsigned int loc; /* Is user connecting via LOC? */
da5b7dfc 202 unsigned int no_notice; /* Does the users client not see notices? */
d76ed9a9 203 unsigned int dead : 1; /* Is user waiting to be recycled? */
2f61d1d7 204 irc_in_addr_t ip; /* User's IP address */
d76ed9a9
AS
205 long modes; /* user flags +isw etc... */
206
182dd032
AS
207 // sethost - reed/apples
208 char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */
209
21f6caee 210 /* GeoIP Data */
211 char *country_name;
212
213 /* GeoIP City Data */
214 char *country_code;
215 char *city;
216 char *region;
217 char *postal_code;
218 float latitude;
219 float longitude;
220 int dma_code;
221 int area_code;
222
2c00fbc2 223 char *mark; /* only filled if they are marked */
0e08a8e0 224 char *version_reply; /* only filled in if a version query was triggered */
21f6caee 225
d76ed9a9
AS
226 time_t timestamp; /* Time of last nick change */
227 struct server *uplink; /* Server that user is connected to */
228 struct modeList channels; /* Vector of channels user is in */
89d871d8 229 struct Privs privs;
d76ed9a9
AS
230
231 /* from nickserv */
232 struct handle_info *handle_info;
233 struct userNode *next_authed;
234 struct policer auth_policer;
235};
236
89d871d8 237#define privs(cli) ((cli)->privs)
238#define PrivSet(pset, priv) ((pset)->priv_mask[_PRIV_IDX(priv)] |= \
239 _PRIV_BIT(priv))
240#define PrivClr(pset, priv) ((pset)->priv_mask[_PRIV_IDX(priv)] &= \
241 ~(_PRIV_BIT(priv)))
242#define PrivHas(pset, priv) ((pset)->priv_mask[_PRIV_IDX(priv)] & \
243 _PRIV_BIT(priv))
244
245#define PRIV_ADD 1
246#define PRIV_DEL 0
247
248#define GrantPriv(cli, priv) (PrivSet(&(privs(cli)), priv))
249#define RevokePriv(cli, priv) (PrivClr(&(privs(cli)), priv))
250#define HasPriv(cli, priv) (PrivHas(&(privs(cli)), priv))
251
d76ed9a9
AS
252struct chanNode {
253 chan_mode_t modes;
254 unsigned int limit, locks;
255 char key[KEYLEN + 1];
2f61d1d7 256 char upass[KEYLEN + 1];
257 char apass[KEYLEN + 1];
d76ed9a9
AS
258 time_t timestamp; /* creation time */
259
260 char topic[TOPICLEN + 1];
261 char topic_nick[NICKLEN + 1];
262 time_t topic_time;
263
264 struct modeList members;
265 struct banList banlist;
2aef5f4b 266 struct exemptList exemptlist;
d76ed9a9
AS
267 struct policer join_policer;
268 unsigned int join_flooded : 1;
269 unsigned int bad_channel : 1;
270
271 struct chanData *channel_info;
272 struct channel_help *channel_help;
273 char name[1];
274};
275
276struct banNode {
277 char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
278 char who[NICKLEN + 1]; /* who set ban */
279 time_t set; /* time ban was set */
280};
281
2aef5f4b 282struct exemptNode {
283 char exempt[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
284 char who[NICKLEN + 1]; /* who set exempt */
285 time_t set; /* time exempt was set */
286};
287
d76ed9a9
AS
288struct modeNode {
289 struct chanNode *channel;
290 struct userNode *user;
acf3c6d5 291 long modes;
2f61d1d7 292 short oplevel;
d76ed9a9
AS
293 time_t idle_since;
294};
295
296#define SERVERNAMEMAX 64
297#define SERVERDESCRIPTMAX 128
298
299struct server {
300 char name[SERVERNAMEMAX+1];
301 time_t boot;
302 time_t link;
303 char description[SERVERDESCRIPTMAX+1];
304#ifdef WITH_PROTOCOL_P10
305 char numeric[COMBO_NUMERIC_LEN+1];
306 unsigned int num_mask;
307#endif
308 unsigned int hops, clients, max_clients;
309 unsigned int burst : 1, self_burst : 1;
310 struct server *uplink;
311#ifdef WITH_PROTOCOL_P10
312 struct userNode **users; /* flat indexed by numeric */
313#else
314 dict_t users; /* indexed by nick */
315#endif
316 struct serverList children;
317};
318
47956fc5
AS
319struct waitingConnection {
320 char *server;
321 char *target;
322};
323
324struct routingPlan {
325 dict_t servers;
326};
327
328struct routingPlanServer {
329 char *uplink;
330 char *secondaryuplink;
331 unsigned int port;
332 int karma;
333 int offline;
334};
335
336/* Ported from X2 */
337struct routeList {
338 char* server; /* Name of the server */
339 unsigned int port; /* connection port */
340 char *uplink; /* Server its linked to (towards us) */
341 char *secondaryuplink;
342 int outsideness; /* 0 means leaf, 1 second layer, etc. my uplink is highest */
343 struct routeList *next;
344};
345
346/* Ported from X2 */
347struct route {
348 int count; /* how many servers we have */
349 int maxdepth; /* biggest outsideness value */
350 int centered; /* set to TRUE when changerouteUplinks is run */
351 struct routeList *servers;
352};
353
354
d76ed9a9
AS
355extern struct server *self;
356extern dict_t channels;
357extern dict_t clients;
358extern dict_t servers;
359extern unsigned int max_clients, invis_clients;
360extern time_t max_clients_time;
361extern struct userList curr_opers, curr_helpers;
362
363struct server* GetServerH(const char *name); /* using full name */
364struct userNode* GetUserH(const char *nick); /* using nick */
365struct chanNode* GetChannel(const char *name);
366struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
367
368typedef void (*server_link_func_t) (struct server *server);
369void reg_server_link_func(server_link_func_t handler);
370
371typedef int (*new_user_func_t) (struct userNode *user);
372void reg_new_user_func(new_user_func_t handler);
373typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
374void reg_del_user_func(del_user_func_t handler);
375void unreg_del_user_func(del_user_func_t handler);
376void ReintroduceUser(struct userNode* user);
377typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
378void reg_nick_change_func(nick_change_func_t handler);
379void NickChange(struct userNode* user, const char *new_nick, int no_announce);
cf8bedff 380void SVSNickChange(struct userNode* user, const char *new_nick);
d76ed9a9
AS
381
382typedef void (*account_func_t) (struct userNode *user, const char *stamp);
383void reg_account_func(account_func_t handler);
384void call_account_func(struct userNode *user, const char *stamp);
b21e2cfe 385void StampUser(struct userNode *user, const char *stamp, time_t timestamp);
d76ed9a9 386void assign_fakehost(struct userNode *user, const char *host, int announce);
21f6caee 387void set_geoip_info(struct userNode *user);
d76ed9a9
AS
388
389typedef void (*new_channel_func_t) (struct chanNode *chan);
390void reg_new_channel_func(new_channel_func_t handler);
391typedef int (*join_func_t) (struct modeNode *mNode);
392void reg_join_func(join_func_t handler);
393typedef void (*del_channel_func_t) (struct chanNode *chan);
394void reg_del_channel_func(del_channel_func_t handler);
395
2aef5f4b 396struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist, char *exemptlist);
d76ed9a9
AS
397void LockChannel(struct chanNode *channel);
398void UnlockChannel(struct chanNode *channel);
399
400struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
401
402typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
403void reg_part_func(part_func_t handler);
404void unreg_part_func(part_func_t handler);
405void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
406void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);
407
408typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
409void reg_kick_func(kick_func_t handler);
410void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
411
412int ChannelBanExists(struct chanNode *channel, const char *ban);
2aef5f4b 413int ChannelExemptExists(struct chanNode *channel, const char *exempt);
d76ed9a9
AS
414
415typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
416void reg_topic_func(topic_func_t handler);
7fda2b52 417void SetChannelTopic(struct chanNode *channel, struct userNode *service, struct userNode *user, const char *topic, int announce);
ac3bdc8d 418struct userNode *IsInChannel(struct chanNode *channel, struct userNode *user);
d76ed9a9
AS
419
420void init_structs(void);
421
422#endif