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