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 #include "capability.h"
  32
  33 /*
  34  * The number of seconds between calls to try_connections(). Fiddle with
  35  * this ONLY if you KNOW what you're doing!
  36  */
  37 #define TRY_CONNECTIONS_TIME    60
  38
  39 /*
  40  * number of seconds to wait after server starts up, before
  41  * starting try_connections()
  42  * TOO SOON and you can nick collide like crazy.
  43  */
  44 #define STARTUP_CONNECTIONS_TIME 60
  45
  46 struct Client;
  47 struct server_conf;
  48 struct Channel;
  49
  50 /* Capabilities */
  51 extern struct CapabilityIndex *serv_capindex;
  52 extern struct CapabilityIndex *cli_capindex;
  53
  54 /* register client capabilities with this structure for 3.2 enhanced capability negotiation */
  55 #define CLICAP_FLAGS_STICKY    0x001
  56 #define CLICAP_FLAGS_REQACK    0x002
  57
  58 struct ClientCapability {
  59         int (*visible)(void);                   /* whether or not to display the capability.  set to NULL or true return value = displayed */
  60         const char *(*data)(void);              /* any custom data for the capability.  set to NULL or return NULL = no data */
  61         unsigned int flags;
  62 };
  63
  64 /* builtin client capabilities */
  65 extern unsigned int CLICAP_MULTI_PREFIX;
  66 extern unsigned int CLICAP_SASL;
  67 extern unsigned int CLICAP_ACCOUNT_NOTIFY;
  68 extern unsigned int CLICAP_EXTENDED_JOIN;
  69 extern unsigned int CLICAP_AWAY_NOTIFY;
  70 extern unsigned int CLICAP_USERHOST_IN_NAMES;
  71 extern unsigned int CLICAP_CAP_NOTIFY;
  72 extern unsigned int CLICAP_CHGHOST;
  73
  74 /*
  75  * XXX: this is kind of ugly, but this allows us to have backwards
  76  * API-compatibility.
  77  */
  78 extern unsigned int CAP_CAP;                    /* received a CAP to begin with */
  79 extern unsigned int CAP_QS;                     /* Can handle quit storm removal */
  80 extern unsigned int CAP_EX;                     /* Can do channel +e exemptions */
  81 extern unsigned int CAP_CHW;                    /* Can do channel wall @# */
  82 extern unsigned int CAP_IE;                     /* Can do invite exceptions */
  83 extern unsigned int CAP_KLN;                    /* Can do KLINE message */
  84 extern unsigned int CAP_ZIP;                    /* Can do ZIPlinks */
  85 extern unsigned int CAP_KNOCK;                  /* supports KNOCK */
  86 extern unsigned int CAP_TB;                     /* supports TBURST */
  87 extern unsigned int CAP_UNKLN;                  /* supports remote unkline */
  88 extern unsigned int CAP_CLUSTER;                /* supports cluster stuff */
  89 extern unsigned int CAP_ENCAP;                  /* supports ENCAP */
  90 extern unsigned int CAP_TS6;                    /* supports TS6 or above */
  91 extern unsigned int CAP_SERVICE;                /* supports services */
  92 extern unsigned int CAP_RSFNC;                  /* rserv FNC */
  93 extern unsigned int CAP_SAVE;                   /* supports SAVE (nick collision FNC) */
  94 extern unsigned int CAP_EUID;                   /* supports EUID (ext UID + nonencap CHGHOST) */
  95 extern unsigned int CAP_EOPMOD;                 /* supports EOPMOD (ext +z + ext topic) */
  96 extern unsigned int CAP_BAN;                    /* supports propagated bans */
  97 extern unsigned int CAP_MLOCK;                  /* supports MLOCK messages */
  98
  99 /* XXX: added for backwards compatibility. --nenolod */
 100 #define CAP_MASK        (capability_index_mask(serv_capindex) & ~(CAP_TS6 | CAP_CAP))
 101
 102 #ifdef HAVE_LIBZ
 103 #define CAP_ZIP_SUPPORTED       CAP_ZIP
 104 #else
 105 #define CAP_ZIP_SUPPORTED       0
 106 #endif
 107
 108 /*
 109  * Capability macros.
 110  */
 111 #define IsCapable(x, cap)       (((x)->localClient->caps & (cap)) == cap)
 112 #define NotCapable(x, cap)      (((x)->localClient->caps & (cap)) == 0)
 113 #define ClearCap(x, cap)        ((x)->localClient->caps &= ~(cap))
 114
 115 /*
 116  * Globals
 117  *
 118  *
 119  * list of recognized server capabilities.  "TS" is not on the list
 120  * because all servers that we talk to already do TS, and the kludged
 121  * extra argument to "PASS" takes care of checking that.  -orabidoo
 122  */
 123 extern int MaxClientCount;      /* GLOBAL - highest number of clients */
 124 extern int MaxConnectionCount;  /* GLOBAL - highest number of connections */
 125
 126 extern int refresh_user_links;
 127
 128 /*
 129  * return values for hunt_server()
 130  */
 131 #define HUNTED_NOSUCH   (-1)    /* if the hunted server is not found */
 132 #define HUNTED_ISME     0       /* if this server should execute the command */
 133 #define HUNTED_PASS     1       /* if message passed onwards successfully */
 134
 135 extern void init_builtin_capabs(void);
 136
 137 extern int hunt_server(struct Client *client_pt,
 138                        struct Client *source_pt,
 139                        const char *command, int server, int parc, const char **parv);
 140 extern void send_capabilities(struct Client *, unsigned int);
 141 extern const char *show_capabilities(struct Client *client);
 142 extern void try_connections(void *unused);
 143
 144 extern int check_server(const char *name, struct Client *server);
 145 extern int server_estab(struct Client *client_p);
 146
 147 extern int serv_connect(struct server_conf *, struct Client *);
 148
 149 #endif /* INCLUDED_s_serv_h */