src/hash.h

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