[irc/evilnet/x3.git] / src / hash.h

/* hash.h - IRC network state database
 * Copyright 2000-2004 srvx Development Team
 *
 * This file is part of x3.
 *
 * x3 is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with srvx; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */

#ifndef HASH_H
#define HASH_H

#include "common.h"
#include "dict.h"
#include "policer.h"

#define MODE_CHANOP		0x00000001 /* +o USER */
#define MODE_VOICE		0x00000002 /* +v USER */
#define MODE_PRIVATE		0x00000004 /* +p */
#define MODE_SECRET		0x00000008 /* +s */
#define MODE_MODERATED		0x00000010 /* +m */
#define MODE_TOPICLIMIT		0x00000020 /* +t */
#define MODE_INVITEONLY		0x00000040 /* +i */
#define MODE_NOPRIVMSGS		0x00000080 /* +n */
#define MODE_KEY		0x00000100 /* +k KEY */
#define MODE_BAN		0x00000200 /* +b BAN */
#define MODE_LIMIT		0x00000400 /* +l LIMIT */
#define MODE_DELAYJOINS         0x00000800 /* +D */
#define MODE_REGONLY            0x00001000 /* ircu +r */
#define MODE_NOCOLORS           0x00002000 /* +c */
#define MODE_NOCTCPS            0x00004000 /* +C */
#define MODE_REGISTERED         0x00008000 /* Bahamut +r */
#define MODE_STRIPCOLOR         0x00010000 /* +S Strip mirc color codes */
#define MODE_MODUNREG           0x00020000 /* +M mod unregister */
#define MODE_NONOTICE           0x00040000 /* +N no notices */
#define MODE_OPERSONLY          0x00080000 /* +O Opers only */
#define MODE_NOQUITMSGS         0x00100000 /* +Q suppress messages from quit notices */
#define MODE_NOAMSG             0x00200000 /* +T no multi-target messages */
#define MODE_SSLONLY            0x00400000 /* +Z ssl only */
#define MODE_HALFOP             0x00800000 /* +h USER */
#define MODE_EXEMPT             0x01000000 /* +e exempt */
#define MODE_HIDEMODE		0x02000000 /* +L hide modes */
#define MODE_APASS		0x04000000 /* +A adminpass */
#define MODE_UPASS		0x08000000 /* +U userpass */
#define MODE_ADMINSONLY         0x10000000 /* +a Admins only */
#define MODE_REMOVE             0x80000000

#define FLAGS_OPER		0x000001 /* Operator +O */
#define FLAGS_LOCOP		0x000002 /* Local operator +o */
#define FLAGS_INVISIBLE		0x000004 /* invisible +i */
#define FLAGS_WALLOP		0x000008 /* receives wallops +w */
#define FLAGS_DUMMY             0x000010 /* user is not announced to other servers */
#define FLAGS_DEAF		0x000020 /* deaf +d */
#define FLAGS_SERVICE		0x000040 /* cannot be kicked, killed or deoped +k */
#define FLAGS_GLOBAL		0x000080 /* receives global messages +g */
#define FLAGS_SETHOST		0x000100 /* sethost +h */
#define FLAGS_PERSISTENT	0x000200 /* for reserved nicks, this isn't just one-shot */
#define FLAGS_GAGGED		0x000400 /* for gagged users */
#define FLAGS_AWAY		0x000800 /* for away users */
#define FLAGS_STAMPED           0x001000 /* for users who have been stamped */
#define FLAGS_HIDDEN_HOST       0x002000 /* user's host is masked by their account */
#define FLAGS_REGNICK           0x004000 /* user owns their current nick */
#define FLAGS_REGISTERING	0x008000 /* user has issued account register command, is waiting for email cookie */
#define FLAGS_BOT		0x010000 /* Bot +B */
#define FLAGS_HIDECHANS		0x020000 /* Hidden channels +n */
#define FLAGS_HIDEIDLE		0x040000 /* Hidden idle time +I */
#define FLAGS_XTRAOP		0x080000 /* Hidden idle time  */
#define FLAGS_CLOAKHOST         0x100000 /* user has cloaked host */
#define FLAGS_CLOAKIP           0x200000 /* user has cloaked ip */

#define IsOper(x)               ((x)->modes & FLAGS_OPER)
#define IsService(x)            ((x)->modes & FLAGS_SERVICE)
#define IsDeaf(x)               ((x)->modes & FLAGS_DEAF)
#define IsInvisible(x)          ((x)->modes & FLAGS_INVISIBLE)
#define IsGlobal(x)             ((x)->modes & FLAGS_GLOBAL)
#define IsWallOp(x)             ((x)->modes & FLAGS_WALLOP)
#define IsBotM(x)      		((x)->modes & FLAGS_BOT)
#define IsHideChans(x)   	((x)->modes & FLAGS_HIDECHANS)
#define IsHideIdle(x)      	((x)->modes & FLAGS_HIDEIDLE)
#define IsXtraOp(x)		((x)->modes & FLAGS_XTRAOP)
#define IsSetHost(x)		((x)->modes & FLAGS_SETHOST)
#define IsGagged(x)             ((x)->modes & FLAGS_GAGGED)
#define IsPersistent(x)         ((x)->modes & FLAGS_PERSISTENT) 
#define IsAway(x)               ((x)->modes & FLAGS_AWAY)
#define IsStamped(x)            ((x)->modes & FLAGS_STAMPED)
#define IsHiddenHost(x)         ((x)->modes & FLAGS_HIDDEN_HOST)
#define IsReggedNick(x)         ((x)->modes & FLAGS_REGNICK)
#define IsRegistering(x)	((x)->modes & FLAGS_REGISTERING)
#define IsDummy(x)              ((x)->modes & FLAGS_DUMMY)
#define IsFakeHost(x)           ((x)->fakehost[0] != '\0')
#define IsLocal(x)              ((x)->uplink == self)

#define NICKLEN         30
#define USERLEN         10
#define HOSTLEN         63
#define SOCKIPLEN       45
#define ACCOUNTLEN      15
#define REALLEN         50
#define TOPICLEN        250
#define CHANNELLEN      200
#define MARKLEN         200
#define MAXOPLEVEL      999

#define MAXMODEPARAMS	6
#define MAXBANS		128
#define MAXEXEMPTS	45

/* IDLEN is 6 because it takes 5.33 Base64 digits to store 32 bytes. */
#define IDLEN           6

/** Operator privileges. */
enum Priv {
  PRIV_CHAN_LIMIT,      /**< no channel limit on oper */
  PRIV_MODE_LCHAN,      /**< oper can mode local chans */
  PRIV_WALK_LCHAN,      /**< oper can walk through local modes */
  PRIV_DEOP_LCHAN,      /**< no deop oper on local chans */
  PRIV_SHOW_INVIS,      /**< show local invisible users */
  PRIV_SHOW_ALL_INVIS,  /**< show all invisible users */
  PRIV_UNLIMIT_QUERY,   /**< unlimit who queries */
  PRIV_KILL,            /**< oper can KILL */
  PRIV_LOCAL_KILL,      /**< oper can local KILL */
  PRIV_REHASH,          /**< oper can REHASH */
  PRIV_REMOTEREHASH,    /**< oper can remote REHASH */
  PRIV_RESTART,         /**< oper can RESTART */
  PRIV_DIE,             /**< oper can DIE */
  PRIV_ZLINE,           /**< oper can ZLINE */
  PRIV_LOCAL_ZLINE,     /**< oper can local ZLINE */
  PRIV_GLINE,           /**< oper can GLINE */
  PRIV_LOCAL_GLINE,     /**< oper can local GLINE */
  PRIV_SHUN,            /**< oper can SHUN */
  PRIV_LOCAL_SHUN,      /**< oper can local SHUN */
  PRIV_JUPE,            /**< oper can JUPE */
  PRIV_LOCAL_JUPE,      /**< oper can local JUPE */
  PRIV_OPMODE,          /**< oper can OP/CLEARMODE */
  PRIV_LOCAL_OPMODE,    /**< oper can local OP/CLEARMODE */
  PRIV_SET,             /**< oper can SET */
  PRIV_WHOX,            /**< oper can use /who x */
  PRIV_BADCHAN,         /**< oper can BADCHAN */
  PRIV_LOCAL_BADCHAN,   /**< oper can local BADCHAN */
  PRIV_SEE_CHAN,        /**< oper can see in secret chans */
  PRIV_PROPAGATE,       /**< propagate oper status */
  PRIV_DISPLAY,         /**< "Is an oper" displayed */
  PRIV_DISPLAY_MODE,    /**< oper can set +H hide oper */
  PRIV_SEE_OPERS,       /**< display hidden opers */
  PRIV_WIDE_GLINE,      /**< oper can set wider G-lines */
  PRIV_WIDE_ZLINE,      /**< oper can set wider Z-Lines */
  PRIV_WIDE_SHUN,       /**< oper can set wider G-lines */
  PRIV_LIST_CHAN,       /**< oper can list secret channels */
  PRIV_FORCE_OPMODE,    /**< can hack modes on quarantined channels */
  PRIV_FORCE_LOCAL_OPMODE, /**< can hack modes on quarantined local channels */
  PRIV_CHECK,           /**< oper can use CHECK */
  PRIV_SEE_SECRET_CHAN, /**< oper can see +s channels in whois */
  PRIV_WHOIS_NOTICE,    /**< oper can set/unset user mode +W */
  PRIV_HIDE_IDLE,       /**< oper can set/unset user mode +I */
  PRIV_XTRAOP,          /**< oper can set/unset user mode +X */
  PRIV_HIDE_CHANNELS,   /**< oper can set/unset user mode +n */
  PRIV_FREEFORM,        /**< oper can set any host on themseves using set host
                              as long as its a valid host */
  PRIV_REMOVE,          /**< oper can force remove deactivated glines,
                             shuns and zlines. */
  PRIV_SPAMFILTER,      /**< oper can set spamfilters via SPAMFILTER */
  PRIV_LAST_PRIV        /**< number of privileges */
};

/** Number of bits */
#define _PRIV_NBITS             (8 * sizeof(unsigned long))
/** Element number for priv \a priv. */
#define _PRIV_IDX(priv)         ((priv) / _PRIV_NBITS)
/** Element bit for priv \a priv. */
#define _PRIV_BIT(priv)         (1UL << ((priv) % _PRIV_NBITS))

/** Operator privileges. */
struct Privs {
  unsigned long priv_mask[(PRIV_LAST_PRIV + _PRIV_NBITS - 1) / _PRIV_NBITS];
};

DECLARE_LIST(userList, struct userNode*);
DECLARE_LIST(modeList, struct modeNode*);
DECLARE_LIST(banList, struct banNode*);
DECLARE_LIST(exemptList, struct exemptNode*);
DECLARE_LIST(channelList, struct chanNode*);
DECLARE_LIST(serverList, struct server*);

struct userNode {
    char *nick;                   /* Unique name of the client, nick or host */
    char ident[USERLEN + 1];      /* Per-host identification for user */
    char info[REALLEN + 1];       /* Free form additional client information */
    char hostname[HOSTLEN + 1];   /* DNS name or IP address */
    char fakehost[HOSTLEN + 1];   /* Assigned fake host */
    char crypthost[HOSTLEN + 30]; /* Crypted hostname */
    char cryptip[SOCKIPLEN + 30]; /* Crypted IP */
#ifdef WITH_PROTOCOL_P10
    char numeric[COMBO_NUMERIC_LEN+1];
    unsigned int num_local : 18;
#endif
    unsigned int loc;             /* Is user connecting via LOC? */
    unsigned int no_notice;       /* Does the users client not see notices? */
    unsigned int dead : 1;        /* Is user waiting to be recycled? */
    irc_in_addr_t ip;             /* User's IP address */
    long modes;                   /* user flags +isw etc... */

    // sethost - reed/apples
    char sethost[USERLEN + HOSTLEN + 2]; /* 1 for '\0' and 1 for @ = 2 */

    /* GeoIP Data */
    char *country_name;

    /* GeoIP City Data */
    char *country_code;
    char *city;
    char *region;
    char *postal_code;
    float latitude;
    float longitude;
    int dma_code;
    int area_code;
    
    char *mark;                   /* only filled if they are marked */
    char *version_reply;          /* only filled in if a version query was triggered */

    time_t timestamp;             /* Time of last nick change */
    time_t idle_since;
    struct server *uplink;        /* Server that user is connected to */
    struct modeList channels;     /* Vector of channels user is in */
    struct Privs   privs;

    /* from nickserv */
    struct handle_info *handle_info;
    struct userNode *next_authed;
    struct policer auth_policer;
};

#define privs(cli)             ((cli)->privs)
#define PrivSet(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] |= \
                                 _PRIV_BIT(priv))
#define PrivClr(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] &= \
                                 ~(_PRIV_BIT(priv)))
#define PrivHas(pset, priv)     ((pset)->priv_mask[_PRIV_IDX(priv)] & \
                                 _PRIV_BIT(priv))

#define PRIV_ADD 1
#define PRIV_DEL 0

#define GrantPriv(cli, priv)    (PrivSet(&(privs(cli)), priv))
#define RevokePriv(cli, priv)   (PrivClr(&(privs(cli)), priv))
#define HasPriv(cli, priv)      (PrivHas(&(privs(cli)), priv))

struct chanNode {
    chan_mode_t modes;
    unsigned int limit, locks;
    char key[KEYLEN + 1];
    char upass[KEYLEN + 1];
    char apass[KEYLEN + 1];
    time_t timestamp; /* creation time */
  
    char topic[TOPICLEN + 1];
    char topic_nick[NICKLEN + 1];
    time_t topic_time;

    struct modeList members;
    struct banList banlist;
    struct exemptList exemptlist;
    struct policer join_policer;
    unsigned int join_flooded : 1;
    unsigned int bad_channel : 1;

    struct chanData *channel_info;
    struct channel_help *channel_help;
    char name[1];
};

struct banNode {
    char ban[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
    char who[NICKLEN + 1]; /* who set ban */
    time_t set; /* time ban was set */
};

struct exemptNode {
    char exempt[NICKLEN + USERLEN + HOSTLEN + 3]; /* 1 for '\0', 1 for ! and 1 for @ = 3 */
    char who[NICKLEN + 1]; /* who set exempt */
    time_t set; /* time exempt was set */
};

struct modeNode {
    struct chanNode *channel;
    struct userNode *user;
    long modes;
    short oplevel;
    time_t idle_since;
};

#define SERVERNAMEMAX 64
#define SERVERDESCRIPTMAX 128

struct server {
    char name[SERVERNAMEMAX+1];
    time_t boot;
    time_t link_time;
    char description[SERVERDESCRIPTMAX+1];
#ifdef WITH_PROTOCOL_P10
    char numeric[COMBO_NUMERIC_LEN+1];
    unsigned int num_mask;
#endif
    unsigned int hops, clients, max_clients;
    unsigned int burst : 1, self_burst : 1;
    struct server *uplink;
#ifdef WITH_PROTOCOL_P10
    struct userNode **users; /* flat indexed by numeric */
#else
    dict_t users; /* indexed by nick */
#endif
    struct serverList children;
};

struct waitingConnection {
    char *server;
    char *target;
};

struct routingPlan {
    dict_t servers;
};

struct routingPlanServer {
    char *uplink;
    char *secondaryuplink;
    unsigned int port;
    int karma;
    int offline;
};

/* Ported from X2 */
struct routeList {
    char* server;              /* Name of the server */
    unsigned int   port;       /* connection port */
    char *uplink;              /* Server its linked to (towards us) */
    char *secondaryuplink; 
    int outsideness;           /* 0 means leaf, 1 second layer, etc. my uplink is highest */
    struct routeList *next;
};

/* Ported from X2 */
struct route {
    int count;                 /* how many servers we have */
    int maxdepth;              /* biggest outsideness value */
    int centered;              /* set to TRUE when changerouteUplinks is run */
    struct routeList *servers;
};


extern struct server *self;
extern dict_t channels;
extern dict_t clients;
extern dict_t servers;
extern unsigned int max_clients, invis_clients;
extern time_t max_clients_time;
extern struct userList curr_opers, curr_helpers;

struct server* GetServerH(const char *name); /* using full name */
struct userNode* GetUserH(const char *nick);   /* using nick */
struct chanNode* GetChannel(const char *name);
struct modeNode* GetUserMode(struct chanNode* channel, struct userNode* user);
int userList_contains(struct userList *list, struct userNode *user);
unsigned int IsUserP(struct userNode *user);

typedef int (*server_link_func_t) (struct server *server, void *extra);
void reg_server_link_func(server_link_func_t handler, void *extra);
void call_server_link_funcs(struct server *server);

typedef int (*new_user_func_t) (struct userNode *user, void *extra);
void reg_new_user_func(new_user_func_t handler, void *extra);
void call_new_user_funcs(struct userNode *user);
typedef void (*del_user_func_t) (struct userNode *user, struct userNode *killer, const char *why, void *extra);
void reg_del_user_func(del_user_func_t handler, void *extra);
void call_del_user_funcs(struct userNode *user, struct userNode *killer, const char *why);
void unreg_del_user_func(del_user_func_t handler, void *extra);
void ReintroduceUser(struct userNode* user);
typedef void (*nick_change_func_t)(struct userNode *user, const char *old_nick, void *extra);
void reg_nick_change_func(nick_change_func_t handler, void *extra);
void NickChange(struct userNode* user, const char *new_nick, int no_announce);
void SVSNickChange(struct userNode* user, const char *new_nick);

typedef void (*account_func_t) (struct userNode *user, const char *stamp);
void reg_account_func(account_func_t handler);
void call_account_func(struct userNode *user, const char *stamp);
void StampUser(struct userNode *user, const char *stamp, time_t timestamp);
void assign_fakehost(struct userNode *user, const char *host, int announce);
void set_geoip_info(struct userNode *user);

typedef void (*new_channel_func_t) (struct chanNode *chan);
void reg_new_channel_func(new_channel_func_t handler);
typedef int (*join_func_t) (struct modeNode *mNode, void *extra);
void reg_join_func(join_func_t handler, void *extra);
typedef void (*del_channel_func_t) (struct chanNode *chan);
void reg_del_channel_func(del_channel_func_t handler);

struct chanNode* AddChannel(const char *name, time_t time_, const char *modes, char *banlist, char *exemptlist);
void LockChannel(struct chanNode *channel);
void UnlockChannel(struct chanNode *channel);

struct modeNode* AddChannelUser(struct userNode* user, struct chanNode* channel);

typedef void (*part_func_t) (struct modeNode *mn, const char *reason);
void reg_part_func(part_func_t handler);
void unreg_part_func(part_func_t handler);
void DelChannelUser(struct userNode* user, struct chanNode* channel, const char *reason, int deleting);
void KickChannelUser(struct userNode* target, struct chanNode* channel, struct userNode *kicker, const char *why);

typedef void (*kick_func_t) (struct userNode *kicker, struct userNode *user, struct chanNode *chan);
void reg_kick_func(kick_func_t handler);
void ChannelUserKicked(struct userNode* kicker, struct userNode* victim, struct chanNode* channel);

int ChannelBanExists(struct chanNode *channel, const char *ban);
int ChannelExemptExists(struct chanNode *channel, const char *exempt);

typedef int (*topic_func_t)(struct userNode *who, struct chanNode *chan, const char *old_topic);
void reg_topic_func(topic_func_t handler);
void SetChannelTopic(struct chanNode *channel, struct userNode *service, struct userNode *user, const char *topic, int announce);
struct userNode *IsInChannel(struct chanNode *channel, struct userNode *user);

void init_structs(void);

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