Author: Kev <klmitch@mit.edu>
[ircu2.10.12-pk.git] / include / client.h
index ba6217d676b23e7e137a59bfe3e2a517b4bbc0e2..91ceba1cfbb1a48512e41fd5a8327f001df9db57 100644 (file)
 #ifndef INCLUDED_ircd_defs_h
 #include "ircd_defs.h"
 #endif
-#ifndef INCLUDED_config_h
-#include "config.h"
-#endif
 #ifndef INCLUDED_dbuf_h
 #include "dbuf.h"
 #endif
 #ifndef INCLUDED_msgq_h
 #include "msgq.h"
 #endif
+#ifndef INCLUDED_ircd_events_h
+#include "ircd_events.h"
+#endif
 #ifndef INCLUDED_ircd_handler_h
 #include "ircd_handler.h"
 #endif
@@ -55,6 +55,8 @@ struct User;
 struct Whowas;
 struct DNSReply;
 struct hostent;
+struct Privs;
+struct AuthRequest;
 
 /*
  * Structures
@@ -64,6 +66,48 @@ struct hostent;
  * source file, or in the source file itself (when only used in that file).
  */
 
+#define PRIV_CHAN_LIMIT                 1 /* no channel limit on oper */
+#define PRIV_MODE_LCHAN                 2 /* oper can mode local chans */
+#define PRIV_WALK_LCHAN                 3 /* oper can walk thru local modes */
+#define PRIV_DEOP_LCHAN                 4 /* no deop oper on local chans */
+#define PRIV_SHOW_INVIS                 5 /* show local invisible users */
+#define PRIV_SHOW_ALL_INVIS     6 /* show all invisible users */
+#define PRIV_UNLIMIT_QUERY      7 /* unlimit who queries */
+
+#define PRIV_KILL               8 /* oper can KILL */
+#define PRIV_LOCAL_KILL                 9 /* oper can local KILL */
+#define PRIV_REHASH            10 /* oper can REHASH */
+#define PRIV_RESTART           11 /* oper can RESTART */
+#define PRIV_DIE               12 /* oper can DIE */
+#define PRIV_GLINE             13 /* oper can GLINE */
+#define PRIV_LOCAL_GLINE       14 /* oper can local GLINE */
+#define PRIV_JUPE              15 /* oper can JUPE */
+#define PRIV_LOCAL_JUPE                16 /* oper can local JUPE */
+#define PRIV_OPMODE            17 /* oper can OP/CLEARMODE */
+#define PRIV_LOCAL_OPMODE      18 /* oper can local OP/CLEARMODE */
+#define PRIV_SET               19 /* oper can SET */
+#define PRIV_WHOX              20 /* oper can use /who x */
+#define PRIV_BADCHAN           21 /* oper can BADCHAN */
+#define PRIV_LOCAL_BADCHAN     22 /* oper can local BADCHAN */
+#define PRIV_SEE_CHAN          23 /* oper can see in secret chans */
+
+#define PRIV_PROPAGATE         24 /* propagate oper status */
+#define PRIV_DISPLAY           25 /* "Is an oper" displayed */
+#define PRIV_SEE_OPERS         26 /* display hidden opers */
+
+#define PRIV_WIDE_GLINE                27 /* oper can set wider G-lines */
+
+#define PRIV_LAST_PRIV         27 /* must be the same as the last priv */
+
+#define _PRIV_NBITS            (8 * sizeof(unsigned long))
+
+#define _PRIV_IDX(priv)                ((priv) / _PRIV_NBITS)
+#define _PRIV_BIT(priv)                (1 << ((priv) % _PRIV_NBITS))
+
+struct Privs {
+  unsigned long priv_mask[(PRIV_LAST_PRIV / _PRIV_NBITS) + 1];
+};
+
 struct Connection {
   /*
    *  The following fields are allocated only for local clients
@@ -72,11 +116,13 @@ struct Connection {
    *  to which the allocation is tied to! *Never* refer to
    *  these fields, if (from != self).
    */
+  unsigned long       con_magic; /* magic number */
   struct Connection*  con_next;  /* Next connection with queued data */
   struct Connection** con_prev_p; /* What points to us */
   struct Client*      con_client; /* Client associated with connection */
   unsigned int        con_count; /* Amount of data in buffer */
   int                 con_fd;    /* >= 0, for local clients */
+  int                 con_freeflag; /* indicates if connection can be freed */
   int                 con_error; /* last socket level error for client */
   unsigned int        con_snomask; /* mask for server messages */
   time_t              con_nextnick; /* Next time a nick change is allowed */
@@ -111,9 +157,15 @@ struct Connection {
   char con_passwd[PASSWDLEN + 1];
   char con_buffer[BUFSIZE];     /* Incoming message buffer; or the error that
                                    caused this clients socket to be `dead' */
+  struct Socket       con_socket; /* socket descriptor for client */
+  struct Timer        con_proc; /* process latent messages from client */
+  struct AuthRequest* con_auth; /* auth request for client */
 };
 
+#define CONNECTION_MAGIC 0x12f955f3
+
 struct Client {
+  unsigned long  cli_magic;     /* magic number */
   struct Client* cli_next;      /* link in GlobalClientList */
   struct Client* cli_prev;      /* link in GlobalClientList */
   struct Client* cli_hnext;     /* link in hash table bucket or this */
@@ -138,12 +190,16 @@ struct Client {
   struct in_addr cli_ip;        /* Real ip# NOT defined for remote servers! */
   short          cli_status;    /* Client type */
   unsigned char  cli_local;     /* local or remote client */
-  unsigned int   cli_privs;     /* Oper privileges */
+  struct Privs   cli_privs;     /* Oper privileges */
   char cli_name[HOSTLEN + 1];   /* Unique name of the client, nick or host */
   char cli_username[USERLEN + 1]; /* username here now for auth stuff */
   char cli_info[REALLEN + 1];   /* Free form additional client information */
 };
 
+#define CLIENT_MAGIC 0x4ca08286
+
+#define cli_verify(cli)                ((cli)->cli_magic == CLIENT_MAGIC)
+#define cli_magic(cli)         ((cli)->cli_magic)
 #define cli_next(cli)          ((cli)->cli_next)
 #define cli_prev(cli)          ((cli)->cli_prev)
 #define cli_hnext(cli)         ((cli)->cli_hnext)
@@ -170,6 +226,7 @@ struct Client {
 
 #define cli_count(cli)         ((cli)->cli_connect->con_count)
 #define cli_fd(cli)            ((cli)->cli_connect->con_fd)
+#define cli_freeflag(cli)      ((cli)->cli_connect->con_freeflag)
 #define cli_error(cli)         ((cli)->cli_connect->con_error)
 #define cli_snomask(cli)       ((cli)->cli_connect->con_snomask)
 #define cli_nextnick(cli)      ((cli)->cli_connect->con_nextnick)
@@ -197,12 +254,18 @@ struct Client {
 #define cli_sockhost(cli)      ((cli)->cli_connect->con_sockhost)
 #define cli_passwd(cli)                ((cli)->cli_connect->con_passwd)
 #define cli_buffer(cli)                ((cli)->cli_connect->con_buffer)
+#define cli_socket(cli)                ((cli)->cli_connect->con_socket)
+#define cli_proc(cli)          ((cli)->cli_connect->con_proc)
+#define cli_auth(cli)          ((cli)->cli_connect->con_auth)
 
+#define con_verify(con)                ((con)->con_magic == CONNECTION_MAGIC)
+#define con_magic(con)         ((con)->con_magic)
 #define con_next(con)          ((con)->con_next)
 #define con_prev_p(con)                ((con)->con_prev_p)
 #define con_client(con)                ((con)->con_client)
 #define con_count(con)         ((con)->con_count)
 #define con_fd(con)            ((con)->con_fd)
+#define con_freeflag(con)      ((con)->con_freeflag)
 #define con_error(con)         ((con)->con_error)
 #define con_snomask(con)       ((con)->con_snomask)
 #define con_nextnick(con)      ((con)->con_nextnick)
@@ -230,6 +293,9 @@ struct Client {
 #define con_sockhost(con)      ((con)->con_sockhost)
 #define con_passwd(con)                ((con)->con_passwd)
 #define con_buffer(con)                ((con)->con_buffer)
+#define con_socket(con)                ((con)->con_socket)
+#define con_proc(con)          ((con)->con_proc)
+#define con_auth(con)          ((con)->con_auth)
 
 #define STAT_CONNECTING         0x001 /* connecting to another server */
 #define STAT_HANDSHAKE          0x002 /* pass - server sent */
@@ -292,6 +358,8 @@ struct Client {
 #define FLAGS_CLOSING    0x0400 /* set when closing to suppress errors */
 #define FLAGS_UPING      0x0800 /* has active UDP ping request */
 #define FLAGS_CHKACCESS  0x1000 /* ok to check clients access if set */
+#define FLAGS_HUB        0x2000 /* server is a hub */
+#define FLAGS_SERVICE    0x4000 /* server is a service */
 #define FLAGS_LOCAL     0x00010000      /* set for local clients */
 #define FLAGS_GOTID     0x00020000      /* successful ident lookup achieved */
 #define FLAGS_DOID      0x00040000      /* I-lines say must use ident return */
@@ -336,6 +404,8 @@ struct Client {
 #define SendDebug(x)            (cli_flags(x) & FLAGS_DEBUG)
 #define SendServNotice(x)       (cli_flags(x) & FLAGS_SERVNOTICE)
 #define SendWallops(x)          (cli_flags(x) & FLAGS_WALLOP)
+#define IsHub(x)                (cli_flags(x) & FLAGS_HUB)
+#define IsService(x)            (cli_flags(x) & FLAGS_SERVICE)
 
 #define IsPrivileged(x)         (IsAnOper(x) || IsServer(x))
 
@@ -353,6 +423,9 @@ struct Client {
 #define SetOper(x)              (cli_flags(x) |= FLAGS_OPER)
 #define SetUPing(x)             (cli_flags(x) |= FLAGS_UPING)
 #define SetWallops(x)           (cli_flags(x) |= FLAGS_WALLOP)
+#define SetServNotice(x)        (cli_flags(x) |= FLAGS_SERVNOTICE)
+#define SetHub(x)               (cli_flags(x) |= FLAGS_HUB)
+#define SetService(x)           (cli_flags(x) |= FLAGS_SERVICE)
 
 #define ClearAccess(x)          (cli_flags(x) &= ~FLAGS_CHKACCESS)
 #define ClearBurst(x)           (cli_flags(x) &= ~FLAGS_BURST)
@@ -366,6 +439,11 @@ struct Client {
 #define ClearOper(x)            (cli_flags(x) &= ~FLAGS_OPER)
 #define ClearUPing(x)           (cli_flags(x) &= ~FLAGS_UPING)
 #define ClearWallops(x)         (cli_flags(x) &= ~FLAGS_WALLOP)
+#define ClearServNotice(x)      (cli_flags(x) &= ~FLAGS_SERVNOTICE)
+
+/* free flags */
+#define FREEFLAG_SOCKET        0x0001  /* socket needs to be freed */
+#define FREEFLAG_TIMER 0x0002  /* timer needs to be freed */
 
 /* server notice stuff */
 
@@ -405,36 +483,16 @@ struct Client {
 #define SNO_OPER (SNO_CONNEXIT|SNO_OLDREALOP)
 #define SNO_NOISY (SNO_SERVKILL|SNO_UNAUTH)
 
-#define PRIV_CHAN_LIMIT                0x00000001 /* no channel limit on oper */
-#define PRIV_MODE_LCHAN                0x00000002 /* oper can mode local chans */
-#define PRIV_WALK_LCHAN                0x00000004 /* oper can walk thru local modes */
-#define PRIV_DEOP_LCHAN                0x00000008 /* no deop oper on local chans */
-#define PRIV_SHOW_INVIS                0x00000010 /* show local invisible users */
-#define PRIV_SHOW_ALL_INVIS    0x00000020 /* show all invisible users */
-#define PRIV_UNLIMIT_QUERY     0x00000040 /* unlimit who queries */
-
-#define PRIV_KILL              0x00000080 /* oper can KILL */
-#define PRIV_LOCAL_KILL                0x00000100 /* oper can local KILL */
-#define PRIV_REHASH            0x00000200 /* oper can REHASH */
-#define PRIV_RESTART           0x00000400 /* oper can RESTART */
-#define PRIV_DIE               0x00000800 /* oper can DIE */
-#define PRIV_GLINE             0x00001000 /* oper can GLINE */
-#define PRIV_LOCAL_GLINE       0x00002000 /* oper can local GLINE */
-#define PRIV_JUPE              0x00004000 /* oper can JUPE */
-#define PRIV_LOCAL_JUPE                0x00008000 /* oper can local JUPE */
-#define PRIV_OPMODE            0x00010000 /* oper can OP/CLEARMODE */
-#define PRIV_LOCAL_OPMODE      0x00020000 /* oper can local OP/CLEARMODE */
-#define PRIV_SET               0x00040000 /* oper can SET */
-#define PRIV_WHOX              0x00080000 /* oper can use /who x */
-#define PRIV_BADCHAN           0x00100000 /* oper can BADCHAN */
-#define PRIV_LOCAL_BADCHAN     0x00200000 /* oper can local BADCHAN */
-#define PRIV_SEE_CHAN          0x00400000 /* oper can see in secret chans */
-
-#define PRIV_PROPAGATE         0x00800000 /* propagate oper status */
-#define PRIV_DISPLAY           0x01000000 /* "Is an oper" displayed */
-#define PRIV_SEE_OPERS         0x02000000 /* display hidden opers */
-
-#define HasPriv(cli, priv)     (cli_privs(cli) & (priv))
+#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 GrantPriv(cli, priv)   (PrivSet(&(cli_privs(cli)), priv))
+#define RevokePriv(cli, priv)  (PrivClr(&(cli_privs(cli)), priv))
+#define HasPriv(cli, priv)     (PrivHas(&(cli_privs(cli)), priv))
 
 typedef enum ShowIPType {
   HIDE_IP,