include/client.h

   1 /*
   2  * IRC - Internet Relay Chat, include/client.h
   3  * Copyright (C) 1990 Jarkko Oikarinen and
   4  *                    University of Oulu, Computing Center
   5  *
   6  * This program 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, or (at your option)
   9  * 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 this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20 /** @file
  21  * @brief Structures and functions for handling local clients.
  22  * @version $Id$
  23  */
  24 #ifndef INCLUDED_client_h
  25 #define INCLUDED_client_h
  26 #ifndef INCLUDED_ircd_defs_h
  27 #include "ircd_defs.h"
  28 #endif
  29 #ifndef INCLUDED_dbuf_h
  30 #include "dbuf.h"
  31 #endif
  32 #ifndef INCLUDED_msgq_h
  33 #include "msgq.h"
  34 #endif
  35 #ifndef INCLUDED_ircd_events_h
  36 #include "ircd_events.h"
  37 #endif
  38 #ifndef INCLUDED_ircd_handler_h
  39 #include "ircd_handler.h"
  40 #endif
  41 #ifndef INCLUDED_res_h
  42 #include "res.h"
  43 #endif
  44 #ifndef INCLUDED_sys_types_h
  45 #include <sys/types.h>          /* time_t, size_t */
  46 #define INCLUDED_sys_types_h
  47 #endif
  48
  49 struct ConfItem;
  50 struct Listener;
  51 struct ListingArgs;
  52 struct SLink;
  53 struct Server;
  54 struct User;
  55 struct Whowas;
  56 struct hostent;
  57 struct Privs;
  58 struct AuthRequest;
  59
  60 /*
  61  * Structures
  62  *
  63  * Only put structures here that are being used in a very large number of
  64  * source files. Other structures go in the header file of there corresponding
  65  * source file, or in the source file itself (when only used in that file).
  66  */
  67
  68 /** Single element in a flag bitset array. */
  69 typedef unsigned long flagpage_t;
  70
  71 /** Number of bits in a flagpage_t. */
  72 #define FLAGSET_NBITS (8 * sizeof(flagpage_t))
  73 /** Element number for flag \a flag. */
  74 #define FLAGSET_INDEX(flag) ((flag) / FLAGSET_NBITS)
  75 /** Element bit for flag \a flag. */
  76 #define FLAGSET_MASK(flag) (1ul<<((flag) % FLAGSET_NBITS))
  77
  78 /** Declare a flagset structure of a particular size. */
  79 #define DECLARE_FLAGSET(name,max) \
  80   struct name \
  81   { \
  82     unsigned long bits[((max + FLAGSET_NBITS - 1) / FLAGSET_NBITS)]; \
  83   }
  84
  85 /** Test whether a flag is set in a flagset. */
  86 #define FlagHas(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] & FLAGSET_MASK(flag))
  87 /** Set a flag in a flagset. */
  88 #define FlagSet(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] |= FLAGSET_MASK(flag))
  89 /** Clear a flag in a flagset. */
  90 #define FlagClr(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] &= ~FLAGSET_MASK(flag))
  91
  92 /** String containing valid user modes, in no particular order. */
  93 #define infousermodes "dioswkgx"
  94
  95 /** Operator privileges. */
  96 enum Priv
  97   {
  98     PRIV_CHAN_LIMIT, /**< no channel limit on oper */
  99     PRIV_MODE_LCHAN, /**< oper can mode local chans */
 100     PRIV_WALK_LCHAN, /**< oper can walk through local modes */
 101     PRIV_DEOP_LCHAN, /**< no deop oper on local chans */
 102     PRIV_SHOW_INVIS, /**< show local invisible users */
 103     PRIV_SHOW_ALL_INVIS, /**< show all invisible users */
 104     PRIV_UNLIMIT_QUERY, /**< unlimit who queries */
 105     PRIV_KILL, /**< oper can KILL */
 106     PRIV_LOCAL_KILL, /**< oper can local KILL */
 107     PRIV_REHASH, /**< oper can REHASH */
 108     PRIV_RESTART, /**< oper can RESTART */
 109     PRIV_DIE, /**< oper can DIE */
 110     PRIV_GLINE, /**< oper can GLINE */
 111     PRIV_LOCAL_GLINE, /**< oper can local GLINE */
 112     PRIV_JUPE, /**< oper can JUPE */
 113     PRIV_LOCAL_JUPE, /**< oper can local JUPE */
 114     PRIV_OPMODE, /**< oper can OP/CLEARMODE */
 115     PRIV_LOCAL_OPMODE, /**< oper can local OP/CLEARMODE */
 116     PRIV_SET,  /**< oper can SET */
 117     PRIV_WHOX, /**< oper can use /who x */
 118     PRIV_BADCHAN, /**< oper can BADCHAN */
 119     PRIV_LOCAL_BADCHAN, /**< oper can local BADCHAN */
 120     PRIV_SEE_CHAN, /**< oper can see in secret chans */
 121     PRIV_PROPAGATE, /**< propagate oper status */
 122     PRIV_DISPLAY, /**< "Is an oper" displayed */
 123     PRIV_SEE_OPERS, /**< display hidden opers */
 124     PRIV_WIDE_GLINE, /**< oper can set wider G-lines */
 125     PRIV_LIST_CHAN, /**< oper can list secret channels */
 126     PRIV_FORCE_OPMODE, /**< can hack modes on quarantined channels */
 127     PRIV_FORCE_LOCAL_OPMODE, /**< can hack modes on quarantined local channels */
 128     PRIV_APASS_OPMODE, /**< can hack modes +A/-A/+U/-U */
 129     PRIV_LAST_PRIV /**< number of privileges */
 130   };
 131
 132 /** Client flags and modes.
 133  * Note that flags at least FLAG_LOCAL_UMODES but less than
 134  * FLAG_GLOBAL_UMODES are treated as local modes, and flags at least
 135  * FLAG_GLOBAL_UMODES (but less than FLAG_LAST_FLAG) are treated as
 136  * global modes.
 137  */
 138 enum Flag
 139   {
 140     FLAG_PINGSENT,                  /**< Unreplied ping sent */
 141     FLAG_DEADSOCKET,                /**< Local socket is dead--Exiting soon */
 142     FLAG_KILLED,                    /**< Prevents "QUIT" from being sent for this */
 143     FLAG_BLOCKED,                   /**< socket is in a blocked condition */
 144     FLAG_CLOSING,                   /**< set when closing to suppress errors */
 145     FLAG_UPING,                     /**< has active UDP ping request */
 146     FLAG_HUB,                       /**< server is a hub */
 147     FLAG_IPV6,                      /**< server understands P10 IPv6 addrs */
 148     FLAG_SERVICE,                   /**< server is a service */
 149     FLAG_GOTID,                     /**< successful ident lookup achieved */
 150     FLAG_DOID,                      /**< I-lines say must use ident return */
 151     FLAG_NONL,                      /**< No \n in buffer */
 152     FLAG_TS8,                       /**< Why do you want to know? */
 153     FLAG_MAP,                       /**< Show server on the map */
 154     FLAG_JUNCTION,                  /**< Junction causing the net.burst. */
 155     FLAG_BURST,                     /**< Server is receiving a net.burst */
 156     FLAG_BURST_ACK,                 /**< Server is waiting for eob ack */
 157     FLAG_IPCHECK,                   /**< Added or updated IPregistry data */
 158     FLAG_LOCOP,                     /**< Local operator -- SRB */
 159     FLAG_SERVNOTICE,                /**< server notices such as kill */
 160     FLAG_OPER,                      /**< Operator */
 161     FLAG_INVISIBLE,                 /**< makes user invisible */
 162     FLAG_WALLOP,                    /**< send wallops to them */
 163     FLAG_DEAF,                      /**< Makes user deaf */
 164     FLAG_CHSERV,                    /**< Disallow KICK or MODE -o on the user;
 165                                        don't display channels in /whois */
 166     FLAG_DEBUG,                     /**< send global debug/anti-hack info */
 167     FLAG_ACCOUNT,                   /**< account name has been set */
 168     FLAG_HIDDENHOST,                /**< user's host is hidden */
 169     FLAG_LAST_FLAG,                 /**< number of flags */
 170     FLAG_LOCAL_UMODES = FLAG_LOCOP, /**< First local mode flag */
 171     FLAG_GLOBAL_UMODES = FLAG_OPER  /**< First global mode flag */
 172   };
 173
 174 /** Declare flagset type for operator privileges. */
 175 DECLARE_FLAGSET(Privs, PRIV_LAST_PRIV);
 176 /** Declare flagset type for user flags. */
 177 DECLARE_FLAGSET(Flags, FLAG_LAST_FLAG);
 178
 179 #include "capab.h" /* client capabilities */
 180
 181 /** Represents a local connection.
 182  * This contains a lot of stuff irrelevant to server connections, but
 183  * those are so rare as to not be worth special-casing.
 184  */
 185 struct Connection
 186 {
 187   unsigned long       con_magic;     /**< magic number */
 188   struct Connection*  con_next;      /**< Next connection with queued data */
 189   struct Connection** con_prev_p;    /**< What points to us */
 190   struct Client*      con_client;    /**< Client associated with connection */
 191   unsigned int        con_count;     /**< Amount of data in buffer */
 192   int                 con_freeflag;  /**< indicates if connection can be freed */
 193   int                 con_error;     /**< last socket level error for client */
 194   int                 con_sentalong; /**< sentalong marker for connection */
 195   unsigned int        con_snomask;   /**< mask for server messages */
 196   time_t              con_nextnick;  /**< Next time a nick change is allowed */
 197   time_t              con_nexttarget;/**< Next time a target change is allowed */
 198   time_t              con_lasttime;  /**< Last time data read from socket */
 199   time_t              con_since;     /**< Last time we accepted a command */
 200   struct MsgQ         con_sendQ;     /**< Outgoing message queue */
 201   struct DBuf         con_recvQ;     /**< Incoming data yet to be parsed */
 202   unsigned int        con_sendM;     /**< Stats: protocol messages sent */
 203   unsigned int        con_receiveM;  /**< Stats: protocol messages received */
 204   uint64_t            con_sendB;     /**< Bytes sent. */
 205   uint64_t            con_receiveB;  /**< Bytes received. */
 206   struct Listener*    con_listener;  /**< Listening socket which we accepted
 207                                         from. */
 208   struct SLink*       con_confs;     /**< Associated configuration records. */
 209   HandlerType         con_handler;   /**< Message index into command table
 210                                         for parsing. */
 211   struct ListingArgs* con_listing;   /**< Current LIST status. */
 212   unsigned int        con_max_sendq; /**< cached max send queue for client */
 213   unsigned int        con_ping_freq; /**< cached ping freq */
 214   unsigned short      con_lastsq;    /**< # 2k blocks when sendqueued
 215                                         called last. */
 216   unsigned char       con_targets[MAXTARGETS]; /**< Hash values of
 217                                                   current targets. */
 218   char con_sock_ip[SOCKIPLEN + 1];   /**< Remote IP address as a string. */
 219   char con_sockhost[HOSTLEN + 1];    /**< This is the host name from
 220                                         the socket and after which the
 221                                         connection was accepted. */
 222   char con_passwd[PASSWDLEN + 1];    /**< Password given by user. */
 223   char con_buffer[BUFSIZE];          /**< Incoming message buffer; or
 224                                         the error that caused this
 225                                         clients socket to close. */
 226   struct Socket       con_socket;    /**< socket descriptor for
 227                                       client */
 228   struct Timer        con_proc;      /**< process latent messages from
 229                                       client */
 230   struct Privs        con_privs;     /**< Oper privileges */
 231   struct CapSet       con_capab;     /**< Client capabilities (from us) */
 232   struct CapSet       con_active;    /**< Active capabilities (to us) */
 233   struct AuthRequest* con_auth;      /**< Auth request for client */
 234 };
 235
 236 /** Magic constant to identify valid Connection structures. */
 237 #define CONNECTION_MAGIC 0x12f955f3
 238
 239 /** Represents a client anywhere on the network. */
 240 struct Client {
 241   unsigned long  cli_magic;       /**< magic number */
 242   struct Client* cli_next;        /**< link in GlobalClientList */
 243   struct Client* cli_prev;        /**< link in GlobalClientList */
 244   struct Client* cli_hnext;       /**< link in hash table bucket or this */
 245   struct Connection* cli_connect; /**< Connection structure associated with us */
 246   struct User*   cli_user;        /**< Defined if this client is a user */
 247   struct Server* cli_serv;        /**< Defined if this client is a server */
 248   struct Whowas* cli_whowas;      /**< Pointer to ww struct to be freed on quit */
 249   char           cli_yxx[4];      /**< Numeric Nick: YY if this is a
 250                                      server, XXX if this is a user */
 251   time_t         cli_firsttime;   /**< time client was created */
 252   time_t         cli_lastnick;    /**< TimeStamp on nick */
 253   int            cli_marker;      /**< /who processing marker */
 254   struct Flags   cli_flags;       /**< client flags */
 255   unsigned int   cli_hopcount;    /**< number of servers to this 0 = local */
 256   struct irc_in_addr cli_ip;      /**< Real IP of client */
 257   short          cli_status;      /**< Client type */
 258   char cli_name[HOSTLEN + 1];     /**< Unique name of the client, nick or host */
 259   char cli_username[USERLEN + 1]; /**< Username determined by ident lookup */
 260   char cli_info[REALLEN + 1];     /**< Free form additional client information */
 261 };
 262
 263 /** Magic constant to identify valid Client structures. */
 264 #define CLIENT_MAGIC 0x4ca08286
 265
 266 /** Verify that a client is valid. */
 267 #define cli_verify(cli)         ((cli)->cli_magic == CLIENT_MAGIC)
 268 /** Get client's magic number. */
 269 #define cli_magic(cli)          ((cli)->cli_magic)
 270 /** Get global next client. */
 271 #define cli_next(cli)           ((cli)->cli_next)
 272 /** Get global previous client. */
 273 #define cli_prev(cli)           ((cli)->cli_prev)
 274 /** Get next client in hash bucket chain. */
 275 #define cli_hnext(cli)          ((cli)->cli_hnext)
 276 /** Get connection associated with client. */
 277 #define cli_connect(cli)        ((cli)->cli_connect)
 278 /** Get local client that links us to \a cli. */
 279 #define cli_from(cli)           con_client(cli_connect(cli))
 280 /** Get User structure for client, if client is a user. */
 281 #define cli_user(cli)           ((cli)->cli_user)
 282 /** Get Server structure for client, if client is a server. */
 283 #define cli_serv(cli)           ((cli)->cli_serv)
 284 /** Get Whowas link for client. */
 285 #define cli_whowas(cli)         ((cli)->cli_whowas)
 286 /** Get client numnick. */
 287 #define cli_yxx(cli)            ((cli)->cli_yxx)
 288 /** Get time we last read data from the client socket. */
 289 #define cli_lasttime(cli)       con_lasttime(cli_connect(cli))
 290 /** Get time we last parsed something from the client. */
 291 #define cli_since(cli)          con_since(cli_connect(cli))
 292 /** Get time client was created. */
 293 #define cli_firsttime(cli)      ((cli)->cli_firsttime)
 294 /** Get time client last changed nickname. */
 295 #define cli_lastnick(cli)       ((cli)->cli_lastnick)
 296 /** Get WHO marker for client. */
 297 #define cli_marker(cli)         ((cli)->cli_marker)
 298 /** Get flags flagset for client. */
 299 #define cli_flags(cli)          ((cli)->cli_flags)
 300 /** Get hop count to client. */
 301 #define cli_hopcount(cli)       ((cli)->cli_hopcount)
 302 /** Get client IP address. */
 303 #define cli_ip(cli)             ((cli)->cli_ip)
 304 /** Get status bitmask for client. */
 305 #define cli_status(cli)         ((cli)->cli_status)
 306 /** Return non-zero if the client is local. */
 307 #define cli_local(cli)          (cli_from(cli) == cli)
 308 /** Get oper privileges for client. */
 309 #define cli_privs(cli)          con_privs(cli_connect(cli))
 310 /** Get client capabilities for client */
 311 #define cli_capab(cli)          con_capab(cli_connect(cli))
 312 /** Get active client capabilities for client */
 313 #define cli_active(cli)         con_active(cli_connect(cli))
 314 /** Get client name. */
 315 #define cli_name(cli)           ((cli)->cli_name)
 316 /** Get client username (ident). */
 317 #define cli_username(cli)       ((cli)->cli_username)
 318 /** Get client realname (information field). */
 319 #define cli_info(cli)           ((cli)->cli_info)
 320
 321 /** Get number of incoming bytes queued for client. */
 322 #define cli_count(cli)          con_count(cli_connect(cli))
 323 /** Get file descriptor for sending in client's direction. */
 324 #define cli_fd(cli)             con_fd(cli_connect(cli))
 325 /** Get free flags for the client's connection. */
 326 #define cli_freeflag(cli)       con_freeflag(cli_connect(cli))
 327 /** Get last error code for the client's connection. */
 328 #define cli_error(cli)          con_error(cli_connect(cli))
 329 /** Get server notice mask for the client. */
 330 #define cli_snomask(cli)        con_snomask(cli_connect(cli))
 331 /** Get next time a nick change is allowed for the client. */
 332 #define cli_nextnick(cli)       con_nextnick(cli_connect(cli))
 333 /** Get next time a target change is allowed for the client. */
 334 #define cli_nexttarget(cli)     con_nexttarget(cli_connect(cli))
 335 /** Get SendQ for client. */
 336 #define cli_sendQ(cli)          con_sendQ(cli_connect(cli))
 337 /** Get RecvQ for client. */
 338 #define cli_recvQ(cli)          con_recvQ(cli_connect(cli))
 339 /** Get count of messages sent to client. */
 340 #define cli_sendM(cli)          con_sendM(cli_connect(cli))
 341 /** Get number of messages received from client. */
 342 #define cli_receiveM(cli)       con_receiveM(cli_connect(cli))
 343 /** Get number of bytes (modulo 1024) sent to client. */
 344 #define cli_sendB(cli)          con_sendB(cli_connect(cli))
 345 /** Get number of bytes (modulo 1024) received from client. */
 346 #define cli_receiveB(cli)       con_receiveB(cli_connect(cli))
 347 /** Get listener that accepted the client's connection. */
 348 #define cli_listener(cli)       con_listener(cli_connect(cli))
 349 /** Get list of attached conf lines. */
 350 #define cli_confs(cli)          con_confs(cli_connect(cli))
 351 /** Get handler type for client. */
 352 #define cli_handler(cli)        con_handler(cli_connect(cli))
 353 /** Get LIST status for client. */
 354 #define cli_listing(cli)        con_listing(cli_connect(cli))
 355 /** Get cached max SendQ for client. */
 356 #define cli_max_sendq(cli)      con_max_sendq(cli_connect(cli))
 357 /** Get ping frequency for client. */
 358 #define cli_ping_freq(cli)      con_ping_freq(cli_connect(cli))
 359 /** Get lastsq for client's connection. */
 360 #define cli_lastsq(cli)         con_lastsq(cli_connect(cli))
 361 /** Get the array of current targets for the client.  */
 362 #define cli_targets(cli)        con_targets(cli_connect(cli))
 363 /** Get the string form of the client's IP address. */
 364 #define cli_sock_ip(cli)        con_sock_ip(cli_connect(cli))
 365 /** Get the resolved hostname for the client. */
 366 #define cli_sockhost(cli)       con_sockhost(cli_connect(cli))
 367 /** Get the client's password. */
 368 #define cli_passwd(cli)         con_passwd(cli_connect(cli))
 369 /** Get the unprocessed input buffer for a client's connection.  */
 370 #define cli_buffer(cli)         con_buffer(cli_connect(cli))
 371 /** Get the Socket structure for sending to a client. */
 372 #define cli_socket(cli)         con_socket(cli_connect(cli))
 373 /** Get Timer for processing waiting messages from the client. */
 374 #define cli_proc(cli)           con_proc(cli_connect(cli))
 375 /** Get auth request for client. */
 376 #define cli_auth(cli)           con_auth(cli_connect(cli))
 377 /** Get sentalong marker for client. */
 378 #define cli_sentalong(cli)      con_sentalong(cli_connect(cli))
 379
 380 /** Verify that a connection is valid. */
 381 #define con_verify(con)         ((con)->con_magic == CONNECTION_MAGIC)
 382 /** Get connection's magic number. */
 383 #define con_magic(con)          ((con)->con_magic)
 384 /** Get global next connection. */
 385 #define con_next(con)           ((con)->con_next)
 386 /** Get global previous connection. */
 387 #define con_prev_p(con)         ((con)->con_prev_p)
 388 /** Get locally connected client for connection. */
 389 #define con_client(con)         ((con)->con_client)
 390 /** Get number of unprocessed data bytes from connection. */
 391 #define con_count(con)          ((con)->con_count)
 392 /** Get file descriptor for connection. */
 393 #define con_fd(con)             s_fd(&(con)->con_socket)
 394 /** Get freeable flags for connection. */
 395 #define con_freeflag(con)       ((con)->con_freeflag)
 396 /** Get last error code on connection. */
 397 #define con_error(con)          ((con)->con_error)
 398 /** Get sentalong marker for connection. */
 399 #define con_sentalong(con)      ((con)->con_sentalong)
 400 /** Get server notice mask for connection. */
 401 #define con_snomask(con)        ((con)->con_snomask)
 402 /** Get next nick change time for connection. */
 403 #define con_nextnick(con)       ((con)->con_nextnick)
 404 /** Get next new target time for connection. */
 405 #define con_nexttarget(con)     ((con)->con_nexttarget)
 406 /** Get last time we read from the connection. */
 407 #define con_lasttime(con)       ((con)->con_lasttime)
 408 /** Get last time we accepted a command from the connection. */
 409 #define con_since(con)          ((con)->con_since)
 410 /** Get SendQ for connection. */
 411 #define con_sendQ(con)          ((con)->con_sendQ)
 412 /** Get RecvQ for connection. */
 413 #define con_recvQ(con)          ((con)->con_recvQ)
 414 /** Get number of messages sent to connection. */
 415 #define con_sendM(con)          ((con)->con_sendM)
 416 /** Get number of messages received from connection. */
 417 #define con_receiveM(con)       ((con)->con_receiveM)
 418 /** Get number of bytes (modulo 1024) sent to connection. */
 419 #define con_sendB(con)          ((con)->con_sendB)
 420 /** Get number of bytes (modulo 1024) received from connection. */
 421 #define con_receiveB(con)       ((con)->con_receiveB)
 422 /** Get listener that accepted the connection. */
 423 #define con_listener(con)       ((con)->con_listener)
 424 /** Get list of ConfItems attached to the connection. */
 425 #define con_confs(con)          ((con)->con_confs)
 426 /** Get command handler for the connection. */
 427 #define con_handler(con)        ((con)->con_handler)
 428 /** Get the LIST status for the connection. */
 429 #define con_listing(con)        ((con)->con_listing)
 430 /** Get the maximum permitted SendQ size for the connection. */
 431 #define con_max_sendq(con)      ((con)->con_max_sendq)
 432 /** Get the ping frequency for the connection. */
 433 #define con_ping_freq(con)      ((con)->con_ping_freq)
 434 /** Get the lastsq for the connection. */
 435 #define con_lastsq(con)         ((con)->con_lastsq)
 436 /** Get the current targets array for the connection. */
 437 #define con_targets(con)        ((con)->con_targets)
 438 /** Get the string-formatted IP address for the connection. */
 439 #define con_sock_ip(con)        ((con)->con_sock_ip)
 440 /** Get the resolved hostname for the connection. */
 441 #define con_sockhost(con)       ((con)->con_sockhost)
 442 /** Get the password sent by the remote end of the connection.  */
 443 #define con_passwd(con)         ((con)->con_passwd)
 444 /** Get the buffer of unprocessed incoming data from the connection. */
 445 #define con_buffer(con)         ((con)->con_buffer)
 446 /** Get the Socket for the connection. */
 447 #define con_socket(con)         ((con)->con_socket)
 448 /** Get the Timer for processing more data from the connection. */
 449 #define con_proc(con)           ((con)->con_proc)
 450 /** Get the oper privilege set for the connection. */
 451 #define con_privs(con)          (&(con)->con_privs)
 452 /** Get the peer's capabilities for the connection. */
 453 #define con_capab(con)          (&(con)->con_capab)
 454 /** Get the active capabilities for the connection. */
 455 #define con_active(con)         (&(con)->con_active)
 456 /** Get the auth request for the connection. */
 457 #define con_auth(con)           ((con)->con_auth)
 458
 459 #define STAT_CONNECTING         0x001 /**< connecting to another server */
 460 #define STAT_HANDSHAKE          0x002 /**< pass - server sent */
 461 #define STAT_ME                 0x004 /**< this server */
 462 #define STAT_UNKNOWN            0x008 /**< unidentified connection */
 463 #define STAT_UNKNOWN_USER       0x010 /**< connection on a client port */
 464 #define STAT_UNKNOWN_SERVER     0x020 /**< connection on a server port */
 465 #define STAT_SERVER             0x040 /**< fully registered server */
 466 #define STAT_USER               0x080 /**< fully registered user */
 467
 468 /*
 469  * status macros.
 470  */
 471 /** Return non-zero if the client is registered. */
 472 #define IsRegistered(x)         (cli_status(x) & (STAT_SERVER | STAT_USER))
 473 /** Return non-zero if the client is an outbound connection that is
 474  * still connecting. */
 475 #define IsConnecting(x)         (cli_status(x) == STAT_CONNECTING)
 476 /** Return non-zero if the client is an outbound connection that has
 477  * sent our password. */
 478 #define IsHandshake(x)          (cli_status(x) == STAT_HANDSHAKE)
 479 /** Return non-zero if the client is this server. */
 480 #define IsMe(x)                 (cli_status(x) == STAT_ME)
 481 /** Return non-zero if the client has not yet registered. */
 482 #define IsUnknown(x)            (cli_status(x) & \
 483         (STAT_UNKNOWN | STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER))
 484 /** Return non-zero if the client is an unregistered connection on a
 485  * server port. */
 486 #define IsServerPort(x)         (cli_status(x) == STAT_UNKNOWN_SERVER )
 487 /** Return non-zero if the client is an unregistered connection on a
 488  * user port. */
 489 #define IsUserPort(x)           (cli_status(x) == STAT_UNKNOWN_USER )
 490 /** Return non-zero if the client is a real client connection. */
 491 #define IsClient(x)             (cli_status(x) & \
 492         (STAT_HANDSHAKE | STAT_ME | STAT_UNKNOWN |\
 493          STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER | STAT_SERVER | STAT_USER))
 494 /** Return non-zero if the client ignores flood limits. */
 495 #define IsTrusted(x)            (cli_status(x) & \
 496         (STAT_CONNECTING | STAT_HANDSHAKE | STAT_ME | STAT_SERVER))
 497 /** Return non-zero if the client is a registered server. */
 498 #define IsServer(x)             (cli_status(x) == STAT_SERVER)
 499 /** Return non-zero if the client is a registered user. */
 500 #define IsUser(x)               (cli_status(x) == STAT_USER)
 501
 502
 503 /** Mark a client with STAT_CONNECTING. */
 504 #define SetConnecting(x)        (cli_status(x) = STAT_CONNECTING)
 505 /** Mark a client with STAT_HANDSHAKE. */
 506 #define SetHandshake(x)         (cli_status(x) = STAT_HANDSHAKE)
 507 /** Mark a client with STAT_SERVER. */
 508 #define SetServer(x)            (cli_status(x) = STAT_SERVER)
 509 /** Mark a client with STAT_ME. */
 510 #define SetMe(x)                (cli_status(x) = STAT_ME)
 511 /** Mark a client with STAT_USER. */
 512 #define SetUser(x)              (cli_status(x) = STAT_USER)
 513
 514 /** Return non-zero if a client is directly connected to me. */
 515 #define MyConnect(x)    (cli_from(x) == (x))
 516 /** Return non-zero if a client is a locally connected user. */
 517 #define MyUser(x)       (MyConnect(x) && IsUser(x))
 518 /** Return non-zero if a client is a locally connected IRC operator. */
 519 #define MyOper(x)       (MyConnect(x) && IsOper(x))
 520 /** Return protocol version used by a server. */
 521 #define Protocol(x)     ((cli_serv(x))->prot)
 522
 523 /*
 524  * flags macros
 525  */
 526 /** Set a flag in a client's flags. */
 527 #define SetFlag(cli, flag)  FlagSet(&cli_flags(cli), flag)
 528 /** Clear a flag from a client's flags. */
 529 #define ClrFlag(cli, flag)  FlagClr(&cli_flags(cli), flag)
 530 /** Return non-zero if a flag is set in a client's flags. */
 531 #define HasFlag(cli, flag)  FlagHas(&cli_flags(cli), flag)
 532
 533 /** Return non-zero if the client is an IRC operator (global or local). */
 534 #define IsAnOper(x)             (IsOper(x) || IsLocOp(x))
 535 /** Return non-zero if the client's connection is blocked. */
 536 #define IsBlocked(x)            HasFlag(x, FLAG_BLOCKED)
 537 /** Return non-zero if the client's connection is still being burst. */
 538 #define IsBurst(x)              HasFlag(x, FLAG_BURST)
 539 /** Return non-zero if we have received the peer's entire burst but
 540  * not their EOB ack. */
 541 #define IsBurstAck(x)           HasFlag(x, FLAG_BURST_ACK)
 542 /** Return non-zero if we are still bursting to the client. */
 543 #define IsBurstOrBurstAck(x)    (HasFlag(x, FLAG_BURST) || HasFlag(x, FLAG_BURST_ACK))
 544 /** Return non-zero if the client has set mode +k (channel service). */
 545 #define IsChannelService(x)     HasFlag(x, FLAG_CHSERV)
 546 /** Return non-zero if the client's socket is disconnected. */
 547 #define IsDead(x)               HasFlag(x, FLAG_DEADSOCKET)
 548 /** Return non-zero if the client has set mode +d (deaf). */
 549 #define IsDeaf(x)               HasFlag(x, FLAG_DEAF)
 550 /** Return non-zero if the client has been IP-checked for clones. */
 551 #define IsIPChecked(x)          HasFlag(x, FLAG_IPCHECK)
 552 /** Return non-zero if we have received an ident response for the client. */
 553 #define IsIdented(x)            HasFlag(x, FLAG_GOTID)
 554 /** Return non-zero if the client has set mode +i (invisible). */
 555 #define IsInvisible(x)          HasFlag(x, FLAG_INVISIBLE)
 556 /** Return non-zero if the client caused a net.burst. */
 557 #define IsJunction(x)           HasFlag(x, FLAG_JUNCTION)
 558 /** Return non-zero if the client has set mode +O (local operator) locally. */
 559 #define IsLocOp(x)              (MyConnect(x) && HasFlag(x, FLAG_LOCOP))
 560 /** Return non-zero if the client has set mode +o (global operator). */
 561 #define IsOper(x)               HasFlag(x, FLAG_OPER)
 562 /** Return non-zero if the client has an active UDP ping request. */
 563 #define IsUPing(x)              HasFlag(x, FLAG_UPING)
 564 /** Return non-zero if the client has no '\n' in its buffer. */
 565 #define NoNewLine(x)            HasFlag(x, FLAG_NONL)
 566 /** Return non-zero if the client has set mode +g (debugging). */
 567 #define SendDebug(x)            HasFlag(x, FLAG_DEBUG)
 568 /** Return non-zero if the client has set mode +s (server notices). */
 569 #define SendServNotice(x)       HasFlag(x, FLAG_SERVNOTICE)
 570 /** Return non-zero if the client has set mode +w (wallops). */
 571 #define SendWallops(x)          HasFlag(x, FLAG_WALLOP)
 572 /** Return non-zero if the client claims to be a hub. */
 573 #define IsHub(x)                HasFlag(x, FLAG_HUB)
 574 /** Return non-zero if the client understands IPv6 addresses in P10. */
 575 #define IsIPv6(x)               HasFlag(x, FLAG_IPV6)
 576 /** Return non-zero if the client claims to be a services server. */
 577 #define IsService(x)            HasFlag(x, FLAG_SERVICE)
 578 /** Return non-zero if the client has an account stamp. */
 579 #define IsAccount(x)            HasFlag(x, FLAG_ACCOUNT)
 580 /** Return non-zero if the client has set mode +x (hidden host). */
 581 #define IsHiddenHost(x)         HasFlag(x, FLAG_HIDDENHOST)
 582 /** Return non-zero if the client has an active PING request. */
 583 #define IsPingSent(x)           HasFlag(x, FLAG_PINGSENT)
 584
 585 /** Return non-zero if the client has operator or server privileges. */
 586 #define IsPrivileged(x)         (IsAnOper(x) || IsServer(x))
 587 /** Return non-zero if the client's host is hidden. */
 588 #define HasHiddenHost(x)        (IsHiddenHost(x) && IsAccount(x))
 589
 590 /** Mark a client as having an in-progress net.burst. */
 591 #define SetBurst(x)             SetFlag(x, FLAG_BURST)
 592 /** Mark a client as being between EOB and EOB ACK. */
 593 #define SetBurstAck(x)          SetFlag(x, FLAG_BURST_ACK)
 594 /** Mark a client as having mode +k (channel service). */
 595 #define SetChannelService(x)    SetFlag(x, FLAG_CHSERV)
 596 /** Mark a client as having mode +d (deaf). */
 597 #define SetDeaf(x)              SetFlag(x, FLAG_DEAF)
 598 /** Mark a client as having mode +g (debugging). */
 599 #define SetDebug(x)             SetFlag(x, FLAG_DEBUG)
 600 /** Mark a client as having ident looked up. */
 601 #define SetGotId(x)             SetFlag(x, FLAG_GOTID)
 602 /** Mark a client as being IP-checked. */
 603 #define SetIPChecked(x)         SetFlag(x, FLAG_IPCHECK)
 604 /** Mark a client as having mode +i (invisible). */
 605 #define SetInvisible(x)         SetFlag(x, FLAG_INVISIBLE)
 606 /** Mark a client as causing a net.join. */
 607 #define SetJunction(x)          SetFlag(x, FLAG_JUNCTION)
 608 /** Mark a client as having mode +O (local operator). */
 609 #define SetLocOp(x)             SetFlag(x, FLAG_LOCOP)
 610 /** Mark a client as having mode +o (global operator). */
 611 #define SetOper(x)              SetFlag(x, FLAG_OPER)
 612 /** Mark a client as having a pending UDP ping. */
 613 #define SetUPing(x)             SetFlag(x, FLAG_UPING)
 614 /** Mark a client as having mode +w (wallops). */
 615 #define SetWallops(x)           SetFlag(x, FLAG_WALLOP)
 616 /** Mark a client as having mode +s (server notices). */
 617 #define SetServNotice(x)        SetFlag(x, FLAG_SERVNOTICE)
 618 /** Mark a client as being a hub server. */
 619 #define SetHub(x)               SetFlag(x, FLAG_HUB)
 620 /** Mark a client as being an IPv6-grokking server. */
 621 #define SetIPv6(x)              SetFlag(x, FLAG_IPV6)
 622 /** Mark a client as being a services server. */
 623 #define SetService(x)           SetFlag(x, FLAG_SERVICE)
 624 /** Mark a client as having an account stamp. */
 625 #define SetAccount(x)           SetFlag(x, FLAG_ACCOUNT)
 626 /** Mark a client as having mode +x (hidden host). */
 627 #define SetHiddenHost(x)        SetFlag(x, FLAG_HIDDENHOST)
 628 /** Mark a client as having a pending PING. */
 629 #define SetPingSent(x)          SetFlag(x, FLAG_PINGSENT)
 630
 631 /** Return non-zero if \a sptr sees \a acptr as an operator. */
 632 #define SeeOper(sptr,acptr) (IsAnOper(acptr) && (HasPriv(acptr, PRIV_DISPLAY) \
 633                             || HasPriv(sptr, PRIV_SEE_OPERS)))
 634
 635 /** Clear the client's net.burst in-progress flag. */
 636 #define ClearBurst(x)           ClrFlag(x, FLAG_BURST)
 637 /** Clear the client's between EOB and EOB ACK flag. */
 638 #define ClearBurstAck(x)        ClrFlag(x, FLAG_BURST_ACK)
 639 /** Remove mode +k (channel service) from the client. */
 640 #define ClearChannelService(x)  ClrFlag(x, FLAG_CHSERV)
 641 /** Remove mode +d (deaf) from the client. */
 642 #define ClearDeaf(x)            ClrFlag(x, FLAG_DEAF)
 643 /** Remove mode +g (debugging) from the client. */
 644 #define ClearDebug(x)           ClrFlag(x, FLAG_DEBUG)
 645 /** Remove the client's IP-checked flag. */
 646 #define ClearIPChecked(x)       ClrFlag(x, FLAG_IPCHECK)
 647 /** Remove mode +i (invisible) from the client. */
 648 #define ClearInvisible(x)       ClrFlag(x, FLAG_INVISIBLE)
 649 /** Remove mode +O (local operator) from the client. */
 650 #define ClearLocOp(x)           ClrFlag(x, FLAG_LOCOP)
 651 /** Remove mode +o (global operator) from the client. */
 652 #define ClearOper(x)            ClrFlag(x, FLAG_OPER)
 653 /** Clear the client's pending UDP ping flag. */
 654 #define ClearUPing(x)           ClrFlag(x, FLAG_UPING)
 655 /** Remove mode +w (wallops) from the client. */
 656 #define ClearWallops(x)         ClrFlag(x, FLAG_WALLOP)
 657 /** Remove mode +s (server notices) from the client. */
 658 #define ClearServNotice(x)      ClrFlag(x, FLAG_SERVNOTICE)
 659 /** Remove mode +x (hidden host) from the client. */
 660 #define ClearHiddenHost(x)      ClrFlag(x, FLAG_HIDDENHOST)
 661 /** Clear the client's pending PING flag. */
 662 #define ClearPingSent(x)        ClrFlag(x, FLAG_PINGSENT)
 663 /** Clear the client's HUB flag. */
 664 #define ClearHub(x)             ClrFlag(x, FLAG_HUB)
 665
 666 /* free flags */
 667 #define FREEFLAG_SOCKET 0x0001  /**< socket needs to be freed */
 668 #define FREEFLAG_TIMER  0x0002  /**< timer needs to be freed */
 669
 670 /* server notice stuff */
 671
 672 #define SNO_ADD         1       /**< Perform "or" on server notice mask. */
 673 #define SNO_DEL         2       /**< Perform "and ~x" on server notice mask. */
 674 #define SNO_SET         3       /**< Set server notice mask. */
 675                                 /* DON'T CHANGE THESE VALUES ! */
 676                                 /* THE CLIENTS DEPEND ON IT  ! */
 677 #define SNO_OLDSNO      0x1     /**< unsorted old messages */
 678 #define SNO_SERVKILL    0x2     /**< server kills (nick collisions) */
 679 #define SNO_OPERKILL    0x4     /**< oper kills */
 680 #define SNO_HACK2       0x8     /**< desyncs */
 681 #define SNO_HACK3       0x10    /**< temporary desyncs */
 682 #define SNO_UNAUTH      0x20    /**< unauthorized connections */
 683 #define SNO_TCPCOMMON   0x40    /**< common TCP or socket errors */
 684 #define SNO_TOOMANY     0x80    /**< too many connections */
 685 #define SNO_HACK4       0x100   /**< Uworld actions on channels */
 686 #define SNO_GLINE       0x200   /**< glines */
 687 #define SNO_NETWORK     0x400   /**< net join/break, etc */
 688 #define SNO_IPMISMATCH  0x800   /**< IP mismatches */
 689 #define SNO_THROTTLE    0x1000  /**< host throttle add/remove notices */
 690 #define SNO_OLDREALOP   0x2000  /**< old oper-only messages */
 691 #define SNO_CONNEXIT    0x4000  /**< client connect/exit (ugh) */
 692 #define SNO_AUTO        0x8000  /**< AUTO G-Lines */
 693 #define SNO_DEBUG       0x10000 /**< debugging messages (DEBUGMODE only) */
 694 #define SNO_AUTH        0x20000 /**< IAuth notices */
 695
 696 /** Bitmask of all valid server notice bits. */
 697 #ifdef DEBUGMODE
 698 # define SNO_ALL        0x3ffff
 699 #else
 700 # define SNO_ALL        0x2ffff
 701 #endif
 702
 703 /** Server notice bits allowed to normal users. */
 704 #define SNO_USER        (SNO_ALL & ~SNO_OPER)
 705
 706 /** Server notice bits enabled by default for normal users. */
 707 #define SNO_DEFAULT (SNO_NETWORK|SNO_OPERKILL|SNO_GLINE)
 708 /** Server notice bits enabled by default for IRC operators. */
 709 #define SNO_OPERDEFAULT (SNO_DEFAULT|SNO_HACK2|SNO_HACK4|SNO_THROTTLE|SNO_OLDSNO)
 710 /** Server notice bits reserved to IRC operators. */
 711 #define SNO_OPER (SNO_CONNEXIT|SNO_OLDREALOP|SNO_AUTH)
 712 /** Noisy server notice bits that cause other bits to be cleared during connect. */
 713 #define SNO_NOISY (SNO_SERVKILL|SNO_UNAUTH)
 714
 715 /** Test whether a privilege has been granted to a client. */
 716 #define HasPriv(cli, priv)  FlagHas(cli_privs(cli), priv)
 717 /** Grant a privilege to a client. */
 718 #define SetPriv(cli, priv)  FlagSet(cli_privs(cli), priv)
 719 /** Revoke a privilege from a client. */
 720 #define ClrPriv(cli, priv)  FlagClr(cli_privs(cli), priv)
 721
 722 /** Test whether a client has a capability */
 723 #define HasCap(cli, cap)    CapHas(cli_capab(cli), (cap))
 724 /** Test whether a client has the capability active */
 725 #define CapActive(cli, cap) CapHas(cli_active(cli), (cap))
 726
 727 #define HIDE_IP 0 /**< Do not show IP address in get_client_name() */
 728 #define SHOW_IP 1 /**< Show ident and IP address in get_client_name() */
 729
 730 extern const char* get_client_name(const struct Client* sptr, int showip);
 731 extern const char* client_get_default_umode(const struct Client* sptr);
 732 extern int client_get_ping(const struct Client* local_client);
 733 extern void client_drop_sendq(struct Connection* con);
 734 extern void client_add_sendq(struct Connection* con,
 735                              struct Connection** con_p);
 736 extern void client_set_privs(struct Client *client, struct ConfItem *oper);
 737 extern int client_report_privs(struct Client* to, struct Client* client);
 738
 739 #endif /* INCLUDED_client_h */
 740