src/hash.h

   1 /* hash.h - IRC network state database
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of x3.
   5  *
   6  * x3 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             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 */
  51 #define MODE_HALFOP             0x00800000 /* +h USER */
  52 #define MODE_EXEMPT             0x01000000 /* +e exempt */
  53 #define MODE_HIDEMODE           0x02000000 /* +L hide modes */
  54 #define MODE_APASS              0x04000000 /* +A adminpass */
  55 #define MODE_UPASS              0x08000000 /* +U userpass */
  56 #define MODE_REMOVE             0x80000000
  57
  58 #define FLAGS_OPER              0x0001 /* Operator +O */
  59 #define FLAGS_LOCOP             0x0002 /* Local operator +o */
  60 #define FLAGS_INVISIBLE         0x0004 /* invisible +i */
  61 #define FLAGS_WALLOP            0x0008 /* receives wallops +w */
  62 #define FLAGS_SERVNOTICE        0x0010 /* receives server notices +s */
  63 #define FLAGS_DEAF              0x0020 /* deaf +d */
  64 #define FLAGS_SERVICE           0x0040 /* cannot be kicked, killed or deoped +k */
  65 #define FLAGS_GLOBAL            0x0080 /* receives global messages +g */
  66
  67 // sethost - reed/apples
  68 // #define FLAGS_HELPER         0x0100 /* (network?) helper +h */
  69 #define FLAGS_SETHOST           0x0100 /* sethost +h */
  70
  71 #define FLAGS_PERSISTENT        0x0200 /* for reserved nicks, this isn't just one-shot */
  72 #define FLAGS_GAGGED            0x0400 /* for gagged users */
  73 #define FLAGS_AWAY              0x0800 /* for away users */
  74 #define FLAGS_STAMPED           0x1000 /* for users who have been stamped */
  75 #define FLAGS_HIDDEN_HOST       0x2000 /* user's host is masked by their account */
  76 #define FLAGS_REGNICK           0x4000 /* user owns their current nick */
  77 #define FLAGS_REGISTERING       0x8000 /* user has issued account register command, is waiting for email cookie */
  78
  79 #define IsOper(x)               ((x)->modes & FLAGS_OPER)
  80 #define IsService(x)            ((x)->modes & FLAGS_SERVICE)
  81 #define IsDeaf(x)               ((x)->modes & FLAGS_DEAF)
  82 #define IsInvisible(x)          ((x)->modes & FLAGS_INVISIBLE)
  83 #define IsGlobal(x)             ((x)->modes & FLAGS_GLOBAL)
  84 #define IsWallOp(x)             ((x)->modes & FLAGS_WALLOP)
  85 #define IsServNotice(x)         ((x)->modes & FLAGS_SERVNOTICE)
  86
  87 // sethost - reed/apples
  88 // #define IsHelperIrcu(x)         ((x)->modes & FLAGS_HELPER)
  89 #define IsSetHost(x)            ((x)->modes & FLAGS_SETHOST)
  90
  91 #define IsGagged(x)             ((x)->modes & FLAGS_GAGGED)
  92 #define IsPersistent(x)         ((x)->modes & FLAGS_PERSISTENT)
  93 #define IsAway(x)               ((x)->modes & FLAGS_AWAY)
  94 #define IsStamped(x)            ((x)->modes & FLAGS_STAMPED)
  95 #define IsHiddenHost(x)         ((x)->modes & FLAGS_HIDDEN_HOST)
  96 #define IsReggedNick(x)         ((x)->modes & FLAGS_REGNICK)
  97 #define IsRegistering(x)        ((x)->modes & FLAGS_REGISTERING)
  98 #define IsFakeHost(x)           ((x)->fakehost[0] != '\0')
  99 #define IsLocal(x)              ((x)->uplink == self)
 100
 101 #define NICKLEN         30
 102 #define USERLEN         10
 103 #define HOSTLEN         63
 104 #define ACCOUNTLEN      15
 105 #define REALLEN         50
 106 #define TOPICLEN        250
 107 #define CHANNELLEN      200
 108 #define MAXOPLEVEL      999
 109
 110 #define MAXMODEPARAMS   6
 111 #define MAXBANS         128
 112 #define MAXEXEMPTS      45
 113
 114 /* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
 115 #define IDLEN           6
 116
 117 DECLARE_LIST(userList, struct userNode*);
 118 DECLARE_LIST(modeList, struct modeNode*);
 119 DECLARE_LIST(banList, struct banNode*);
 120 DECLARE_LIST(exemptList, struct exemptNode*);
 121 DECLARE_LIST(channelList, struct chanNode*);
 122 DECLARE_LIST(serverList, struct server*);
 123
 124 struct userNode {
 125     char *nick;                   /* Unique name of the client, nick or host */
 126     char ident[USERLEN + 1];      /* Per-host identification for user */
 127     char info[REALLEN + 1];       /* Free form additional client information */
 128     char hostname[HOSTLEN + 1];   /* DNS name or IP address */
 129     char fakehost[HOSTLEN + 1];   /* Assigned fake host */
 130 #ifdef WITH_PROTOCOL_P10
 131     char numeric[COMBO_NUMERIC_LEN+1];
 132     unsigned int num_local : 18;
 133 #endif
 134     unsigned int loc;             /* Is user connecting via LOC? */
 135     unsigned int dead : 1;        /* Is user waiting to be recycled? */
 136     irc_in_addr_t ip;             /* User's IP address */
 137     long modes;                   /* user flags +isw etc... */
 138
 139     // sethost - reed/apples
 140     char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */
 141
 142     time_t timestamp;             /* Time of last nick change */
 143     struct server *uplink;        /* Server that user is connected to */
 144     struct modeList channels;     /* Vector of channels user is in */
 145
 146     /* from nickserv */
 147     struct handle_info *handle_info;
 148     struct userNode *next_authed;
 149     struct policer auth_policer;
 150 };
 151
 152 struct chanNode {
 153     chan_mode_t modes;
 154     unsigned int limit, locks;
 155     char key[KEYLEN + 1];
 156     char upass[KEYLEN + 1];
 157     char apass[KEYLEN + 1];
 158     time_t timestamp; /* creation time */
 159
 160     char topic[TOPICLEN + 1];
 161     char topic_nick[NICKLEN + 1];
 162     time_t topic_time;
 163
 164     struct modeList members;
 165     struct banList banlist;
 166     struct exemptList exemptlist;
 167     struct policer join_policer;
 168     unsigned int join_flooded : 1;
 169     unsigned int bad_channel : 1;
 170
 171     struct chanData *channel_info;
 172     struct channel_help *channel_help;
 173     char name[1];
 174 };
 175
 176 struct banNode {
 177     char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
 178     char who[NICKLEN + 1]; /* who set ban */
 179     time_t set; /* time ban was set */
 180 };
 181
 182 struct exemptNode {
 183     char exempt[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
 184     char who[NICKLEN + 1]; /* who set exempt */
 185     time_t set; /* time exempt was set */
 186 };
 187
 188 struct modeNode {
 189     struct chanNode *channel;
 190     struct userNode *user;
 191     unsigned short modes;
 192     short oplevel;
 193     time_t idle_since;
 194 };
 195
 196 #define SERVERNAMEMAX 64
 197 #define SERVERDESCRIPTMAX 128
 198
 199 struct server {
 200     char name[SERVERNAMEMAX+1];
 201     time_t boot;
 202     time_t link;
 203     char description[SERVERDESCRIPTMAX+1];
 204 #ifdef WITH_PROTOCOL_P10
 205     char numeric[COMBO_NUMERIC_LEN+1];
 206     unsigned int num_mask;
 207 #endif
 208     unsigned int hops, clients, max_clients;
 209     unsigned int burst : 1, self_burst : 1;
 210     struct server *uplink;
 211 #ifdef WITH_PROTOCOL_P10
 212     struct userNode **users; /* flat indexed by numeric */
 213 #else
 214     dict_t users; /* indexed by nick */
 215 #endif
 216     struct serverList children;
 217 };
 218
 219 extern struct server *self;
 220 extern dict_t channels;
 221 extern dict_t clients;
 222 extern dict_t servers;
 223 extern unsigned int max_clients, invis_clients;
 224 extern time_t max_clients_time;
 225 extern struct userList curr_opers, curr_helpers;
 226
 227 struct server* GetServerH(const char *name); /* using full name */
 228 struct userNode* GetUserH(const char *nick);   /* using nick */
 229 struct chanNode* GetChannel(const char *name);
 230 struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
 231
 232 typedef void (*server_link_func_t) (struct server *server);
 233 void reg_server_link_func(server_link_func_t handler);
 234
 235 typedef int (*new_user_func_t) (struct userNode *user);
 236 void reg_new_user_func(new_user_func_t handler);
 237 typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
 238 void reg_del_user_func(del_user_func_t handler);
 239 void unreg_del_user_func(del_user_func_t handler);
 240 void ReintroduceUser(struct userNode* user);
 241 typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
 242 void reg_nick_change_func(nick_change_func_t handler);
 243 void NickChange(struct userNode* user, const char *new_nick, int no_announce);
 244
 245 typedef void (*account_func_t) (struct userNode *user, const char *stamp);
 246 void reg_account_func(account_func_t handler);
 247 void call_account_func(struct userNode *user, const char *stamp);
 248 void StampUser(struct userNode *user, const char *stamp, time_t timestamp);
 249 void assign_fakehost(struct userNode *user, const char *host, int announce);
 250
 251 typedef void (*new_channel_func_t) (struct chanNode *chan);
 252 void reg_new_channel_func(new_channel_func_t handler);
 253 typedef int (*join_func_t) (struct modeNode *mNode);
 254 void reg_join_func(join_func_t handler);
 255 typedef void (*del_channel_func_t) (struct chanNode *chan);
 256 void reg_del_channel_func(del_channel_func_t handler);
 257
 258 struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist, char *exemptlist);
 259 void LockChannel(struct chanNode *channel);
 260 void UnlockChannel(struct chanNode *channel);
 261
 262 struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
 263
 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);
 269
 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);
 273
 274 int ChannelBanExists(struct chanNode *channel, const char *ban);
 275 int ChannelExemptExists(struct chanNode *channel, const char *exempt);
 276
 277 typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
 278 void reg_topic_func(topic_func_t handler);
 279 void SetChannelTopic(struct chanNode *channel, struct userNode *service, struct userNode *user, const char *topic, int announce);
 280 struct userNode *IsInChannel(struct chanNode *channel, struct userNode *user);
 281
 282 void init_structs(void);
 283
 284 #endif