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