src/hash.h

   1 /* hash.h - IRC network state database
   2  * Copyright 2000-2006 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
  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_REMOVE         0x80000000
  47
  48 #define FLAGS_OPER          0x0001 /* global operator +o */
  49 #define FLAGS_INVISIBLE     0x0004 /* invisible +i */
  50 #define FLAGS_WALLOP        0x0008 /* receives wallops +w */
  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_NOCHAN        0x0100 /* hide channels in whois +n */
  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 */
  61 #define FLAGS_REGISTERING   0x8000 /* user has issued account register command, is waiting for email cookie */
  62 #define FLAGS_DUMMY         0x10000 /* user is not announced to other servers */
  63 #define FLAGS_NOIDLE        0x20000 /* hide idle time in whois +I */
  64
  65 #define IsOper(x)               ((x)->modes & FLAGS_OPER)
  66 #define IsService(x)            ((x)->modes & FLAGS_SERVICE)
  67 #define IsDeaf(x)               ((x)->modes & FLAGS_DEAF)
  68 #define IsInvisible(x)          ((x)->modes & FLAGS_INVISIBLE)
  69 #define IsGlobal(x)             ((x)->modes & FLAGS_GLOBAL)
  70 #define IsNoChan(x)             ((x)->modes & FLAGS_NOCHAN)
  71 #define IsWallOp(x)             ((x)->modes & FLAGS_WALLOP)
  72 #define IsGagged(x)             ((x)->modes & FLAGS_GAGGED)
  73 #define IsPersistent(x)         ((x)->modes & FLAGS_PERSISTENT)
  74 #define IsAway(x)               ((x)->modes & FLAGS_AWAY)
  75 #define IsStamped(x)            ((x)->modes & FLAGS_STAMPED)
  76 #define IsHiddenHost(x)         ((x)->modes & FLAGS_HIDDEN_HOST)
  77 #define IsReggedNick(x)         ((x)->modes & FLAGS_REGNICK)
  78 #define IsRegistering(x)        ((x)->modes & FLAGS_REGISTERING)
  79 #define IsDummy(x)              ((x)->modes & FLAGS_DUMMY)
  80 #define IsNoIdle(x)             ((x)->modes & FLAGS_NOIDLE)
  81 #define IsFakeHost(x)           ((x)->fakehost[0] != '\0')
  82 #define IsLocal(x)              ((x)->uplink == self)
  83
  84 #define NICKLEN         30
  85 #define USERLEN         10
  86 #define HOSTLEN         63
  87 #define REALLEN         50
  88 #define TOPICLEN        250
  89 #define CHANNELLEN      200
  90 #define MAXOPLEVEL      999
  91
  92 #define MAXMODEPARAMS   6
  93 #define MAXBANS         45
  94
  95 /* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
  96 #define IDLEN           6
  97
  98 DECLARE_LIST(userList, struct userNode*);
  99 DECLARE_LIST(modeList, struct modeNode*);
 100 DECLARE_LIST(banList, struct banNode*);
 101 DECLARE_LIST(channelList, struct chanNode*);
 102 DECLARE_LIST(serverList, struct server*);
 103
 104 struct userNode {
 105     char *nick;                   /* Unique name of the client, nick or host */
 106     char ident[USERLEN + 1];      /* Per-host identification for user */
 107     char info[REALLEN + 1];       /* Free form additional client information */
 108     char hostname[HOSTLEN + 1];   /* DNS name or IP address */
 109     char fakehost[HOSTLEN + 1];   /* Assigned fake host */
 110 #ifdef WITH_PROTOCOL_P10
 111     char numeric[COMBO_NUMERIC_LEN+1];
 112     unsigned int num_local : 18;
 113 #endif
 114     unsigned int dead : 1;        /* Is user waiting to be recycled? */
 115     irc_in_addr_t ip;             /* User's IP address */
 116     long modes;                   /* user flags +isw etc... */
 117
 118     unsigned long   timestamp;    /* Time of last nick change */
 119     unsigned long   idle_since;   /* Last time user did something on or to a channel */
 120     struct server   *uplink;      /* Server that user is connected to */
 121     struct modeList channels;     /* Vector of channels user is in */
 122
 123     /* from nickserv */
 124     struct handle_info *handle_info;
 125     struct userNode *next_authed;
 126     struct policer auth_policer;
 127 };
 128
 129 struct chanNode {
 130     chan_mode_t modes;
 131     unsigned int limit;
 132     unsigned int locks;
 133     char key[KEYLEN + 1];
 134     char upass[KEYLEN + 1];
 135     char apass[KEYLEN + 1];
 136     unsigned long timestamp; /* creation time */
 137
 138     char topic[TOPICLEN + 1];
 139     char topic_nick[NICKLEN + 1];
 140     unsigned long topic_time;
 141
 142     struct modeList members;
 143     struct banList banlist;
 144     struct policer join_policer;
 145     unsigned int join_flooded : 1;
 146     unsigned int bad_channel : 1;
 147
 148     struct chanData *channel_info;
 149     struct channel_help *channel_help;
 150     char name[1];
 151 };
 152
 153 struct banNode {
 154     char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
 155     char who[NICKLEN + 1]; /* who set ban */
 156     unsigned long set; /* time ban was set */
 157 };
 158
 159 struct modeNode {
 160     struct chanNode *channel;
 161     struct userNode *user;
 162     unsigned short modes;
 163     short oplevel;
 164     unsigned long idle_since;
 165 };
 166
 167 #define SERVERNAMEMAX 64
 168 #define SERVERDESCRIPTMAX 128
 169
 170 struct server {
 171     char name[SERVERNAMEMAX+1];
 172     unsigned long boot;
 173     unsigned long link;
 174     char description[SERVERDESCRIPTMAX+1];
 175 #ifdef WITH_PROTOCOL_P10
 176     char numeric[COMBO_NUMERIC_LEN+1];
 177     unsigned int num_mask;
 178 #endif
 179     unsigned int hops, clients, max_clients;
 180     unsigned int burst : 1, self_burst : 1;
 181     struct server *uplink;
 182 #ifdef WITH_PROTOCOL_P10
 183     struct userNode **users; /* flat indexed by numeric */
 184 #else
 185     dict_t users; /* indexed by nick */
 186 #endif
 187     struct serverList children;
 188 };
 189
 190 extern struct server *self;
 191 extern dict_t channels;
 192 extern dict_t clients;
 193 extern dict_t servers;
 194 extern unsigned int max_clients, invis_clients;
 195 extern unsigned long max_clients_time;
 196 extern struct userList curr_opers, curr_helpers;
 197
 198 struct server* GetServerH(const char *name); /* using full name */
 199 struct userNode* GetUserH(const char *nick);   /* using nick */
 200 struct chanNode* GetChannel(const char *name);
 201 struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
 202
 203 int userList_contains(struct userList *list, struct userNode *user);
 204
 205 typedef void (*server_link_func_t) (struct server *server);
 206 void reg_server_link_func(server_link_func_t handler);
 207
 208 typedef int (*new_user_func_t) (struct userNode *user);
 209 void reg_new_user_func(new_user_func_t handler);
 210 typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
 211 void reg_del_user_func(del_user_func_t handler);
 212 void unreg_del_user_func(del_user_func_t handler);
 213 void ReintroduceUser(struct userNode* user);
 214 typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
 215 void reg_nick_change_func(nick_change_func_t handler);
 216 void NickChange(struct userNode* user, const char *new_nick, int no_announce);
 217
 218 typedef void (*account_func_t) (struct userNode *user, const char *stamp);
 219 void reg_account_func(account_func_t handler);
 220 void call_account_func(struct userNode *user, const char *stamp);
 221 void StampUser(struct userNode *user, const char *stamp);
 222 void assign_fakehost(struct userNode *user, const char *host, int announce);
 223
 224 typedef void (*new_channel_func_t) (struct chanNode *chan);
 225 void reg_new_channel_func(new_channel_func_t handler);
 226 typedef int (*join_func_t) (struct modeNode *mNode);
 227 void reg_join_func(join_func_t handler);
 228 typedef void (*del_channel_func_t) (struct chanNode *chan);
 229 void reg_del_channel_func(del_channel_func_t handler);
 230
 231 struct chanNode* AddChannel(const char *name, unsigned long time_, const char *modes, char *banlist);
 232 void LockChannel(struct chanNode *channel);
 233 void UnlockChannel(struct chanNode *channel);
 234
 235 struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
 236
 237 typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
 238 void reg_part_func(part_func_t handler);
 239 void unreg_part_func(part_func_t handler);
 240 void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
 241 void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);
 242
 243 typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
 244 void reg_kick_func(kick_func_t handler);
 245 void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
 246
 247 int ChannelBanExists(struct chanNode *channel, const char *ban);
 248
 249 typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
 250 void reg_topic_func(topic_func_t handler);
 251 void SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *topic, int announce);
 252
 253 void init_structs(void);
 254
 255 #endif