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 */
  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 SOCKIPLEN       45
 105 #define ACCOUNTLEN      15
 106 #define REALLEN         50
 107 #define TOPICLEN        250
 108 #define CHANNELLEN      200
 109 #define MAXOPLEVEL      999
 110
 111 #define MAXMODEPARAMS   6
 112 #define MAXBANS         128
 113 #define MAXEXEMPTS      45
 114
 115 /* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
 116 #define IDLEN           6
 117
 118 /** Operator privileges. */
 119 enum Priv {
 120   PRIV_CHAN_LIMIT,      /**< no channel limit on oper */
 121   PRIV_MODE_LCHAN,      /**< oper can mode local chans */
 122   PRIV_WALK_LCHAN,      /**< oper can walk through local modes */
 123   PRIV_DEOP_LCHAN,      /**< no deop oper on local chans */
 124   PRIV_SHOW_INVIS,      /**< show local invisible users */
 125   PRIV_SHOW_ALL_INVIS,  /**< show all invisible users */
 126   PRIV_UNLIMIT_QUERY,   /**< unlimit who queries */
 127   PRIV_KILL,            /**< oper can KILL */
 128   PRIV_LOCAL_KILL,      /**< oper can local KILL */
 129   PRIV_REHASH,          /**< oper can REHASH */
 130   PRIV_REMOTEREHASH,    /**< oper can remote REHASH */
 131   PRIV_RESTART,         /**< oper can RESTART */
 132   PRIV_DIE,             /**< oper can DIE */
 133   PRIV_GLINE,           /**< oper can GLINE */
 134   PRIV_LOCAL_GLINE,     /**< oper can local GLINE */
 135   PRIV_SHUN,            /**< oper can SHUN */
 136   PRIV_LOCAL_SHUN,      /**< oper can local SHUN */
 137   PRIV_JUPE,            /**< oper can JUPE */
 138   PRIV_LOCAL_JUPE,      /**< oper can local JUPE */
 139   PRIV_OPMODE,          /**< oper can OP/CLEARMODE */
 140   PRIV_LOCAL_OPMODE,    /**< oper can local OP/CLEARMODE */
 141   PRIV_SET,             /**< oper can SET */
 142   PRIV_WHOX,            /**< oper can use /who x */
 143   PRIV_BADCHAN,         /**< oper can BADCHAN */
 144   PRIV_LOCAL_BADCHAN,   /**< oper can local BADCHAN */
 145   PRIV_SEE_CHAN,        /**< oper can see in secret chans */
 146   PRIV_PROPAGATE,       /**< propagate oper status */
 147   PRIV_DISPLAY,         /**< "Is an oper" displayed */
 148   PRIV_SEE_OPERS,       /**< display hidden opers */
 149   PRIV_WIDE_GLINE,      /**< oper can set wider G-lines */
 150   PRIV_WIDE_SHUN,       /**< oper can set wider G-lines */
 151   PRIV_LIST_CHAN,       /**< oper can list secret channels */
 152   PRIV_FORCE_OPMODE,    /**< can hack modes on quarantined channels */
 153   PRIV_FORCE_LOCAL_OPMODE, /**< can hack modes on quarantined local channels */
 154   PRIV_CHECK,           /**< oper can use CHECK */
 155   PRIV_SEE_SECRET_CHAN, /**< oper can see +s channels in whois */
 156   PRIV_LAST_PRIV        /**< number of privileges */
 157 };
 158
 159 /** Number of bits */
 160 #define _PRIV_NBITS             (8 * sizeof(unsigned long))
 161 /** Element number for priv \a priv. */
 162 #define _PRIV_IDX(priv)         ((priv) / _PRIV_NBITS)
 163 /** Element bit for priv \a priv. */
 164 #define _PRIV_BIT(priv)         (1UL << ((priv) % _PRIV_NBITS))
 165
 166 /** Operator privileges. */
 167 struct Privs {
 168   unsigned long priv_mask[(PRIV_LAST_PRIV + _PRIV_NBITS - 1) / _PRIV_NBITS];
 169 };
 170
 171 DECLARE_LIST(userList, struct userNode*);
 172 DECLARE_LIST(modeList, struct modeNode*);
 173 DECLARE_LIST(banList, struct banNode*);
 174 DECLARE_LIST(exemptList, struct exemptNode*);
 175 DECLARE_LIST(channelList, struct chanNode*);
 176 DECLARE_LIST(serverList, struct server*);
 177
 178 struct userNode {
 179     char *nick;                   /* Unique name of the client, nick or host */
 180     char ident[USERLEN + 1];      /* Per-host identification for user */
 181     char info[REALLEN + 1];       /* Free form additional client information */
 182     char hostname[HOSTLEN + 1];   /* DNS name or IP address */
 183     char fakehost[HOSTLEN + 1];   /* Assigned fake host */
 184     char crypthost[HOSTLEN + 30]; /* Crypted hostname */
 185     char cryptip[SOCKIPLEN + 30]; /* Crypted IP */
 186 #ifdef WITH_PROTOCOL_P10
 187     char numeric[COMBO_NUMERIC_LEN+1];
 188     unsigned int num_local : 18;
 189 #endif
 190     unsigned int loc;             /* Is user connecting via LOC? */
 191     unsigned int dead : 1;        /* Is user waiting to be recycled? */
 192     irc_in_addr_t ip;             /* User's IP address */
 193     long modes;                   /* user flags +isw etc... */
 194
 195     // sethost - reed/apples
 196     char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */
 197
 198     /* GeoIP Data */
 199     char *country_name;
 200
 201     /* GeoIP City Data */
 202     char *country_code;
 203     char *city;
 204     char *region;
 205     char *postal_code;
 206     float latitude;
 207     float longitude;
 208     int dma_code;
 209     int area_code;
 210
 211
 212     time_t timestamp;             /* Time of last nick change */
 213     struct server *uplink;        /* Server that user is connected to */
 214     struct modeList channels;     /* Vector of channels user is in */
 215     struct Privs   privs;
 216
 217     /* from nickserv */
 218     struct handle_info *handle_info;
 219     struct userNode *next_authed;
 220     struct policer auth_policer;
 221 };
 222
 223 #define privs(cli)             ((cli)->privs)
 224 #define PrivSet(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] |= \
 225                                  _PRIV_BIT(priv))
 226 #define PrivClr(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] &= \
 227                                  ~(_PRIV_BIT(priv)))
 228 #define PrivHas(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] & \
 229                                  _PRIV_BIT(priv))
 230
 231 #define PRIV_ADD 1
 232 #define PRIV_DEL 0
 233
 234 #define GrantPriv(cli, priv)    (PrivSet(&(privs(cli)), priv))
 235 #define RevokePriv(cli, priv)   (PrivClr(&(privs(cli)), priv))
 236 #define HasPriv(cli, priv)      (PrivHas(&(privs(cli)), priv))
 237
 238 struct chanNode {
 239     chan_mode_t modes;
 240     unsigned int limit, locks;
 241     char key[KEYLEN + 1];
 242     char upass[KEYLEN + 1];
 243     char apass[KEYLEN + 1];
 244     time_t timestamp; /* creation time */
 245
 246     char topic[TOPICLEN + 1];
 247     char topic_nick[NICKLEN + 1];
 248     time_t topic_time;
 249
 250     struct modeList members;
 251     struct banList banlist;
 252     struct exemptList exemptlist;
 253     struct policer join_policer;
 254     unsigned int join_flooded : 1;
 255     unsigned int bad_channel : 1;
 256
 257     struct chanData *channel_info;
 258     struct channel_help *channel_help;
 259     char name[1];
 260 };
 261
 262 struct banNode {
 263     char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
 264     char who[NICKLEN + 1]; /* who set ban */
 265     time_t set; /* time ban was set */
 266 };
 267
 268 struct exemptNode {
 269     char exempt[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
 270     char who[NICKLEN + 1]; /* who set exempt */
 271     time_t set; /* time exempt was set */
 272 };
 273
 274 struct modeNode {
 275     struct chanNode *channel;
 276     struct userNode *user;
 277     long modes;
 278     short oplevel;
 279     time_t idle_since;
 280 };
 281
 282 #define SERVERNAMEMAX 64
 283 #define SERVERDESCRIPTMAX 128
 284
 285 struct server {
 286     char name[SERVERNAMEMAX+1];
 287     time_t boot;
 288     time_t link;
 289     char description[SERVERDESCRIPTMAX+1];
 290 #ifdef WITH_PROTOCOL_P10
 291     char numeric[COMBO_NUMERIC_LEN+1];
 292     unsigned int num_mask;
 293 #endif
 294     unsigned int hops, clients, max_clients;
 295     unsigned int burst : 1, self_burst : 1;
 296     struct server *uplink;
 297 #ifdef WITH_PROTOCOL_P10
 298     struct userNode **users; /* flat indexed by numeric */
 299 #else
 300     dict_t users; /* indexed by nick */
 301 #endif
 302     struct serverList children;
 303 };
 304
 305 struct waitingConnection {
 306     char *server;
 307     char *target;
 308 };
 309
 310 struct routingPlan {
 311     dict_t servers;
 312 };
 313
 314 struct routingPlanServer {
 315     char *uplink;
 316     char *secondaryuplink;
 317     unsigned int port;
 318     int karma;
 319     int offline;
 320 };
 321
 322 /* Ported from X2 */
 323 struct routeList {
 324     char* server;              /* Name of the server */
 325     unsigned int   port;       /* connection port */
 326     char *uplink;              /* Server its linked to (towards us) */
 327     char *secondaryuplink;
 328     int outsideness;           /* 0 means leaf, 1 second layer, etc. my uplink is highest */
 329     struct routeList *next;
 330 };
 331
 332 /* Ported from X2 */
 333 struct route {
 334     int count;                 /* how many servers we have */
 335     int maxdepth;              /* biggest outsideness value */
 336     int centered;              /* set to TRUE when changerouteUplinks is run */
 337     struct routeList *servers;
 338 };
 339
 340
 341 extern struct server *self;
 342 extern dict_t channels;
 343 extern dict_t clients;
 344 extern dict_t servers;
 345 extern unsigned int max_clients, invis_clients;
 346 extern time_t max_clients_time;
 347 extern struct userList curr_opers, curr_helpers;
 348
 349 struct server* GetServerH(const char *name); /* using full name */
 350 struct userNode* GetUserH(const char *nick);   /* using nick */
 351 struct chanNode* GetChannel(const char *name);
 352 struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
 353
 354 typedef void (*server_link_func_t) (struct server *server);
 355 void reg_server_link_func(server_link_func_t handler);
 356
 357 typedef int (*new_user_func_t) (struct userNode *user);
 358 void reg_new_user_func(new_user_func_t handler);
 359 typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why);
 360 void reg_del_user_func(del_user_func_t handler);
 361 void unreg_del_user_func(del_user_func_t handler);
 362 void ReintroduceUser(struct userNode* user);
 363 typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick);
 364 void reg_nick_change_func(nick_change_func_t handler);
 365 void NickChange(struct userNode* user, const char *new_nick, int no_announce);
 366
 367 typedef void (*account_func_t) (struct userNode *user, const char *stamp);
 368 void reg_account_func(account_func_t handler);
 369 void call_account_func(struct userNode *user, const char *stamp);
 370 void StampUser(struct userNode *user, const char *stamp, time_t timestamp);
 371 void assign_fakehost(struct userNode *user, const char *host, int announce);
 372 void set_geoip_info(struct userNode *user);
 373
 374 typedef void (*new_channel_func_t) (struct chanNode *chan);
 375 void reg_new_channel_func(new_channel_func_t handler);
 376 typedef int (*join_func_t) (struct modeNode *mNode);
 377 void reg_join_func(join_func_t handler);
 378 typedef void (*del_channel_func_t) (struct chanNode *chan);
 379 void reg_del_channel_func(del_channel_func_t handler);
 380
 381 struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist, char *exemptlist);
 382 void LockChannel(struct chanNode *channel);
 383 void UnlockChannel(struct chanNode *channel);
 384
 385 struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);
 386
 387 typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
 388 void reg_part_func(part_func_t handler);
 389 void unreg_part_func(part_func_t handler);
 390 void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
 391 void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);
 392
 393 typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
 394 void reg_kick_func(kick_func_t handler);
 395 void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);
 396
 397 int ChannelBanExists(struct chanNode *channel, const char *ban);
 398 int ChannelExemptExists(struct chanNode *channel, const char *exempt);
 399
 400 typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
 401 void reg_topic_func(topic_func_t handler);
 402 void SetChannelTopic(struct chanNode *channel, struct userNode *service, struct userNode *user, const char *topic, int announce);
 403 struct userNode *IsInChannel(struct chanNode *channel, struct userNode *user);
 404
 405 void init_structs(void);
 406
 407 #endif