1 /* hash.h - IRC network state database
2 * Copyright 2000-2004 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_REMOVE 0x80000000
46 #define FLAGS_OPER 0x0001 /* Operator +O */
47 #define FLAGS_LOCOP 0x0002 /* Local operator +o */
48 #define FLAGS_INVISIBLE 0x0004 /* invisible +i */
49 #define FLAGS_WALLOP 0x0008 /* receives wallops +w */
50 #define FLAGS_SERVNOTICE 0x0010 /* receives server notices +s */
51 #define FLAGS_DEAF 0x0020 /* deaf +d */
52 #define FLAGS_SERVICE 0x0040 /* cannot be kicked, killed or deoped +k */
53 #define FLAGS_GLOBAL 0x0080 /* receives global messages +g */
54 #define FLAGS_HELPER 0x0100 /* (network?) helper +h */
55 #define FLAGS_PERSISTENT 0x0200 /* for reserved nicks, this isn't just one-shot */
56 #define FLAGS_GAGGED 0x0400 /* for gagged users */
57 #define FLAGS_AWAY 0x0800 /* for away users */
58 #define FLAGS_STAMPED 0x1000 /* for users who have been stamped */
59 #define FLAGS_HIDDEN_HOST 0x2000 /* user's host is masked by their account */
60 #define FLAGS_REGNICK 0x4000 /* user owns their current nick */
62 #define IsOper(x) ((x)->modes & FLAGS_OPER)
63 #define IsService(x) ((x)->modes & FLAGS_SERVICE)
64 #define IsDeaf(x) ((x)->modes & FLAGS_DEAF)
65 #define IsInvisible(x) ((x)->modes & FLAGS_INVISIBLE)
66 #define IsGlobal(x) ((x)->modes & FLAGS_GLOBAL)
67 #define IsWallOp(x) ((x)->modes & FLAGS_WALLOP)
68 #define IsServNotice(x) ((x)->modes & FLAGS_SERVNOTICE)
69 #define IsHelperIrcu(x) ((x)->modes & FLAGS_HELPER)
70 #define IsGagged(x) ((x)->modes & FLAGS_GAGGED)
71 #define IsPersistent(x) ((x)->modes & FLAGS_PERSISTENT)
72 #define IsAway(x) ((x)->modes & FLAGS_AWAY)
73 #define IsStamped(x) ((x)->modes & FLAGS_STAMPED)
74 #define IsHiddenHost(x) ((x)->modes & FLAGS_HIDDEN_HOST)
75 #define IsReggedNick(x) ((x)->modes & FLAGS_REGNICK)
76 #define IsLocal(x) ((x)->uplink == self)
83 #define CHANNELLEN 200
85 #define MAXMODEPARAMS 6
88 /* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
91 DECLARE_LIST(userList, struct userNode*);
92 DECLARE_LIST(modeList, struct modeNode*);
93 DECLARE_LIST(banList, struct banNode*);
94 DECLARE_LIST(channelList, struct chanNode*);
95 DECLARE_LIST(serverList, struct server*);
98 char *nick; /* Unique name of the client, nick or host */
99 char ident[USERLEN + 1]; /* Per-host identification for user */
100 char info[REALLEN + 1]; /* Free form additional client information */
101 char hostname[HOSTLEN + 1]; /* DNS name or IP address */
102 #ifdef WITH_PROTOCOL_P10
103 char numeric[COMBO_NUMERIC_LEN+1];
104 unsigned int num_local : 18;
106 unsigned int dead : 1; /* Is user waiting to be recycled? */
107 struct in_addr ip; /* User's IP address */
108 long modes; /* user flags +isw etc... */
110 time_t timestamp; /* Time of last nick change */
111 struct server *uplink; /* Server that user is connected to */
112 struct modeList channels; /* Vector of channels user is in */
115 struct handle_info *handle_info;
116 struct userNode *next_authed;
117 struct policer auth_policer;
122 unsigned int limit, locks;
123 char key[KEYLEN + 1];
124 time_t timestamp; /* creation time */
126 char topic[TOPICLEN + 1];
127 char topic_nick[NICKLEN + 1];
130 struct modeList members;
131 struct banList banlist;
132 struct policer join_policer;
133 unsigned int join_flooded : 1;
134 unsigned int bad_channel : 1;
136 struct chanData *channel_info;
137 struct channel_help *channel_help;
142 char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
143 char who[NICKLEN + 1]; /* who set ban */
144 time_t set; /* time ban was set */
148 struct chanNode *channel;
149 struct userNode *user;
154 #define SERVERNAMEMAX 64
155 #define SERVERDESCRIPTMAX 128
158 char name[SERVERNAMEMAX+1];
161 char description[SERVERDESCRIPTMAX+1];
162 #ifdef WITH_PROTOCOL_P10
163 char numeric[COMBO_NUMERIC_LEN+1];
164 unsigned int num_mask;
166 unsigned int hops, clients, max_clients;
167 unsigned int burst : 1, self_burst : 1;
168 struct server *uplink;
169 #ifdef WITH_PROTOCOL_P10
170 struct userNode **users; /* flat indexed by numeric */
172 dict_t users; /* indexed by nick */
174 struct serverList children;
177 extern struct server *self;
178 extern dict_t channels;
179 extern dict_t clients;
180 extern dict_t servers;
181 extern unsigned int max_clients, invis_clients;
182 extern time_t max_clients_time;
183 extern struct userList curr_opers, curr_helpers;
185 struct server* GetServerH(const char *name); /* using full name */
186 struct userNode* GetUserH(const char *nick); /* using nick */
187 struct chanNode* GetChannel(const char *name);
188 struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
190 typedef void (*server_link_func_t) (struct server *server);
191 void reg_server_link_func(server_link_func_t handler);
193 typedef int (*new_user_func_t) (struct userNode *user);
194 void reg_new_user_func(new_user_func_t handler);
195 typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
196 void reg_del_user_func(del_user_func_t handler);
197 void unreg_del_user_func(del_user_func_t handler);
198 void ReintroduceUser(struct userNode* user);
199 typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
200 void reg_nick_change_func(nick_change_func_t handler);
201 void NickChange(struct userNode* user, const char *new_nick, int no_announce);
203 typedef void (*account_func_t) (struct userNode *user, const char *stamp);
204 void reg_account_func(account_func_t handler);
205 void call_account_func(struct userNode *user, const char *stamp);
206 void StampUser(struct userNode *user, const char *stamp);
208 typedef void (*new_channel_func_t) (struct chanNode *chan);
209 void reg_new_channel_func(new_channel_func_t handler);
210 typedef int (*join_func_t) (struct modeNode *mNode);
211 void reg_join_func(join_func_t handler);
212 typedef void (*del_channel_func_t) (struct chanNode *chan);
213 void reg_del_channel_func(del_channel_func_t handler);
215 struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist);
216 void LockChannel(struct chanNode *channel);
217 void UnlockChannel(struct chanNode *channel);
219 struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
221 typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
222 void reg_part_func(part_func_t handler);
223 void unreg_part_func(part_func_t handler);
224 void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
225 void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);
227 typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
228 void reg_kick_func(kick_func_t handler);
229 void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
231 int ChannelBanExists(struct chanNode *channel, const char *ban);
233 typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
234 void reg_topic_func(topic_func_t handler);
235 void SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *topic, int announce);
237 void init_structs(void);