include/s_serv.h

   1 /*
   2  *  ircd-ratbox: A slightly useful ircd.
   3  *  s_serv.h: A header for the server functions.
   4  *
   5  *  Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
   6  *  Copyright (C) 1996-2002 Hybrid Development Team
   7  *  Copyright (C) 2002-2004 ircd-ratbox development team
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  22  *  USA
  23  *
  24  *  $Id: s_serv.h 1863 2006-08-27 13:40:37Z jilles $
  25  */
  26
  27 #ifndef INCLUDED_serv_h
  28 #define INCLUDED_serv_h
  29
  30 #include "config.h"
  31
  32 /*
  33  * The number of seconds between calls to try_connections(). Fiddle with
  34  * this ONLY if you KNOW what you're doing!
  35  */
  36 #define TRY_CONNECTIONS_TIME    60
  37
  38 /* collect ziplinks compression ratios/etc every minute */
  39 #define ZIPSTATS_TIME           60
  40
  41 /*
  42  * number of seconds to wait after server starts up, before
  43  * starting try_connections()
  44  * TOO SOON and you can nick collide like crazy.
  45  */
  46 #define STARTUP_CONNECTIONS_TIME 60
  47
  48 struct Client;
  49 struct server_conf;
  50 struct Channel;
  51
  52 /* Capabilities */
  53 struct Capability
  54 {
  55         const char *name;       /* name of capability */
  56         unsigned int cap;       /* mask value */
  57 };
  58
  59 #define CAP_CAP         0x00001 /* received a CAP to begin with */
  60 #define CAP_QS          0x00002 /* Can handle quit storm removal */
  61 #define CAP_EX          0x00004 /* Can do channel +e exemptions */
  62 #define CAP_CHW         0x00008 /* Can do channel wall @# */
  63 #define CAP_IE          0x00010 /* Can do invite exceptions */
  64 #define CAP_KLN         0x00040 /* Can do KLINE message */
  65 #define CAP_GLN         0x00080 /* Can do GLINE message */
  66 #define CAP_ZIP         0x00100 /* Can do ZIPlinks */
  67 #define CAP_KNOCK       0x00400 /* supports KNOCK */
  68 #define CAP_TB          0x00800 /* supports TBURST */
  69 #define CAP_UNKLN       0x01000 /* supports remote unkline */
  70 #define CAP_CLUSTER     0x02000 /* supports cluster stuff */
  71 #define CAP_ENCAP       0x04000 /* supports ENCAP */
  72 #define CAP_TS6         0x08000 /* supports TS6 or above */
  73 #define CAP_SERVICE     0x10000
  74 #define CAP_RSFNC       0x20000 /* rserv FNC */
  75 #define CAP_SAVE        0x40000 /* supports SAVE (nick collision FNC) */
  76 #define CAP_EUID        0x80000 /* supports EUID (ext UID + nonencap CHGHOST) */
  77
  78 #define CAP_MASK        (CAP_QS  | CAP_EX   | CAP_CHW  | \
  79                          CAP_IE  | CAP_KLN  | CAP_SERVICE |\
  80                          CAP_GLN | CAP_CLUSTER | CAP_ENCAP | \
  81                          CAP_ZIP  | CAP_KNOCK  | CAP_UNKLN | \
  82                          CAP_RSFNC | CAP_SAVE | CAP_EUID)
  83
  84 #ifdef HAVE_LIBZ
  85 #define CAP_ZIP_SUPPORTED       CAP_ZIP
  86 #else
  87 #define CAP_ZIP_SUPPORTED       0
  88 #endif
  89
  90 /*
  91  * Capability macros.
  92  */
  93 #define IsCapable(x, cap)       (((x)->localClient->caps & (cap)) == cap)
  94 #define NotCapable(x, cap)      (((x)->localClient->caps & (cap)) == 0)
  95 #define ClearCap(x, cap)        ((x)->localClient->caps &= ~(cap))
  96
  97 #define SLINKCMD_SET_ZIP_OUT_LEVEL           1  /* data */
  98 #define SLINKCMD_START_ZIP_OUT               2
  99 #define SLINKCMD_START_ZIP_IN                3
 100 #define SLINKCMD_INJECT_RECVQ                4  /* data */
 101 #define SLINKCMD_INJECT_SENDQ                5  /* data */
 102 #define SLINKCMD_INIT                        6
 103 #define SLINKCMD_ZIPSTATS                    7
 104
 105 #ifndef HAVE_SOCKETPAIR
 106 #define LAST_SLINK_FD   7
 107 #else
 108 #define LAST_SLINK_FD   5
 109 #endif
 110
 111 #define SLINKRPL_FLAG_DATA      0x0001  /* reply has data following */
 112 #define SLINKRPL_ERROR          1
 113 #define SLINKRPL_ZIPSTATS       2
 114
 115 #define MAX_SLINKRPL            2
 116
 117 typedef void SlinkRplHnd(unsigned int replyid, unsigned int datalen,
 118                          unsigned char *data, struct Client *client_p);
 119 struct SlinkRplDef
 120 {
 121         unsigned int replyid;
 122         SlinkRplHnd *handler;
 123         unsigned int flags;
 124 };
 125
 126 extern struct SlinkRplDef slinkrpltab[];
 127
 128 /*
 129  * Globals
 130  *
 131  *
 132  * list of recognized server capabilities.  "TS" is not on the list
 133  * because all servers that we talk to already do TS, and the kludged
 134  * extra argument to "PASS" takes care of checking that.  -orabidoo
 135  */
 136 extern struct Capability captab[];
 137
 138 extern int MaxClientCount;      /* GLOBAL - highest number of clients */
 139 extern int MaxConnectionCount;  /* GLOBAL - highest number of connections */
 140
 141 extern int refresh_user_links;
 142
 143 /*
 144  * return values for hunt_server()
 145  */
 146 #define HUNTED_NOSUCH   (-1)    /* if the hunted server is not found */
 147 #define HUNTED_ISME     0       /* if this server should execute the command */
 148 #define HUNTED_PASS     1       /* if message passed onwards successfully */
 149
 150
 151 extern int hunt_server(struct Client *client_pt,
 152                        struct Client *source_pt,
 153                        const char *command, int server, int parc, const char **parv);
 154 extern void send_capabilities(struct Client *, int);
 155 extern const char *show_capabilities(struct Client *client);
 156 extern void try_connections(void *unused);
 157 extern void start_collect_zipstats(void);
 158 extern void collect_zipstats(void *unused);
 159
 160 extern int check_server(const char *name, struct Client *server);
 161 extern int server_estab(struct Client *client_p);
 162
 163 extern int serv_connect(struct server_conf *, struct Client *);
 164
 165 #endif /* INCLUDED_s_serv_h */