src/proto.h

   1 /* proto.h - IRC protocol output
   2  * Copyright 2000-2004 srvx Development Team
   3  *
   4  * This file is part of srvx.
   5  *
   6  * srvx 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 of the License, or
   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 #if !defined(PROTO_H)
  22 #define PROTO_H
  23
  24 /* Warning for those looking at how this code does multi-protocol
  25  * support: It's an awful, nasty hack job.  It is intended for short
  26  * term use, not long term, since we are already developing srvx2,
  27  * which has much nicer interfaces that hide most of the ugly
  28  * differences between protocol dialects. */
  29
  30 #define COMBO_NUMERIC_LEN 5   /* 1/2, 1/3 or 2/3 digits for server/client parts */
  31 #define MAXLEN          512   /* Maximum IRC line length */
  32 #define MAXNUMPARAMS    200
  33
  34 #ifdef HAVE_NETINET_IN_H
  35 #include <netinet/in.h>
  36 #endif
  37
  38 struct gline;
  39 struct server;
  40 struct userNode;
  41 struct chanNode;
  42
  43 /* connection manager state */
  44
  45 enum cState
  46 {
  47     DISCONNECTED,
  48     AUTHENTICATING,
  49     BURSTING,
  50     CONNECTED
  51 };
  52
  53 #define UPLINK_UNAVAILABLE      0x001
  54
  55 struct uplinkNode
  56 {
  57     char                *name;
  58
  59     char                *host;
  60     int                 port;
  61
  62     struct sockaddr_in  *bind_addr;
  63     int                 bind_addr_len;
  64
  65     char                *password;
  66     char                *their_password;
  67
  68     enum cState         state;
  69     int                 tries;
  70     int                 max_tries;
  71     long                flags;
  72
  73     struct uplinkNode   *prev;
  74     struct uplinkNode   *next;
  75 };
  76
  77 struct cManagerNode
  78 {
  79     struct uplinkNode   *uplinks;
  80     struct uplinkNode   *uplink;
  81
  82     int                 cycles;
  83     int                 enabled;
  84 };
  85
  86 #ifdef WITH_PROTOCOL_P10
  87 struct server* GetServerN(const char *numeric);
  88 struct userNode* GetUserN(const char *numeric);
  89 #endif
  90
  91 /* Basic protocol parsing support. */
  92 void init_parse(void);
  93 int parse_line(char *line, int recursive);
  94
  95 /* Callback notifications for protocol support. */
  96 typedef void (*chanmsg_func_t) (struct userNode *user, struct chanNode *chan, char *text, struct userNode *bot);
  97 void reg_chanmsg_func(unsigned char prefix, struct userNode *service, chanmsg_func_t handler);
  98 struct userNode *get_chanmsg_bot(unsigned char prefix);
  99
 100 typedef void (*privmsg_func_t) (struct userNode *user, struct userNode *target, char *text, int server_qualified);
 101 void reg_privmsg_func(struct userNode *user, privmsg_func_t handler);
 102 void reg_notice_func(struct userNode *user, privmsg_func_t handler);
 103
 104 typedef void (*oper_func_t) (struct userNode *user);
 105 void reg_oper_func(oper_func_t handler);
 106
 107 extern struct userList dead_users;
 108
 109 /* replay silliness */
 110 void replay_read_line(void);
 111 void replay_event_loop(void);
 112
 113 /* connection maintenance */
 114 void irc_server(struct server *srv);
 115 void irc_user(struct userNode *user);
 116 void irc_nick(struct userNode *user, const char *old_nick);
 117 void irc_introduce(const char *passwd);
 118 void irc_ping(const char *something);
 119 void irc_pong(const char *who, const char *data);
 120 void irc_quit(struct userNode *user, const char *message);
 121 void irc_squit(struct server *srv, const char *message, const char *service_message);
 122
 123 /* messages */
 124 void irc_privmsg(struct userNode *from, const char *to, const char *message);
 125 void irc_notice(struct userNode *from, const char *to, const char *message);
 126 void irc_notice_user(struct userNode *from, struct userNode *to, const char *message);
 127 void irc_wallchops(struct userNode *from, const char *to, const char *message);
 128
 129 /* channel maintenance */
 130 void irc_join(struct userNode *who, struct chanNode *what);
 131 void irc_invite(struct userNode *from, struct userNode *who, struct chanNode *to);
 132 void irc_mode(struct userNode *who, struct chanNode *target, const char *modes);
 133 void irc_kick(struct userNode *who, struct userNode *target, struct chanNode *from, const char *msg);
 134 void irc_part(struct userNode *who, struct chanNode *what, const char *reason);
 135 void irc_topic(struct userNode *who, struct chanNode *what, const char *topic);
 136 void irc_fetchtopic(struct userNode *from, const char *to);
 137
 138 /* network maintenance */
 139 void irc_gline(struct server *srv, struct gline *gline);
 140 void irc_settime(const char *srv_name_mask, time_t new_time);
 141 void irc_ungline(const char *mask);
 142 void irc_error(const char *to, const char *message);
 143 void irc_kill(struct userNode *from, struct userNode *target, const char *message);
 144 void irc_raw(const char *what);
 145 void irc_stats(struct userNode *from, struct server *target, char type);
 146 void irc_svsnick(struct userNode *from, struct userNode *target, const char *newnick);
 147
 148 /* account maintenance */
 149 void irc_account(struct userNode *user, const char *stamp);
 150 void irc_regnick(struct userNode *user);
 151
 152 /* numeric messages */
 153 void irc_numeric(struct userNode *user, unsigned int num, const char *format, ...);
 154 /* RFC1459-compliant numeric responses */
 155 #define RPL_ENDOFSTATS          219
 156 #define RPL_STATSUPTIME         242
 157 #define RPL_MAXCONNECTIONS      250
 158 #define RPL_WHOISUSER           311
 159 #define RPL_WHOISSERVER         312
 160 #define RPL_WHOISOPERATOR       313
 161 #define RPL_ENDOFWHOIS          318
 162 #define ERR_NOSUCHNICK          401
 163
 164 /* stuff originally from other headers that is really protocol-specific */
 165 int IsChannelName(const char *name);
 166 int is_valid_nick(const char *nick);
 167 struct userNode *AddService(const char *nick, const char *desc);
 168 struct userNode *AddClone(const char *nick, const char *ident, const char *hostname, const char *desc);
 169 struct server* AddServer(struct server* uplink, const char *name, int hops, time_t boot, time_t link, const char *numeric, const char *description);
 170 void DelServer(struct server* serv, int announce, const char *message);
 171 void DelUser(struct userNode* user, struct userNode *killer, int announce, const char *why);
 172 /* Most protocols will want to make an AddUser helper function. */
 173
 174 /* User modes */
 175 void mod_usermode(struct userNode *user, const char *modes);
 176
 177 /* Channel mode manipulation */
 178 #define KEYLEN          23
 179 typedef unsigned long chan_mode_t;
 180 /* Rules for struct mod_chanmode:
 181  * For a membership mode change, args[n].mode can contain more than
 182  * one mode bit (e.g. MODE_CHANOP|MODE_VOICE).  Hostmask strings are
 183  * "owned" by the caller and are not freed by mod_chanmode_free().
 184  */
 185 struct mod_chanmode {
 186     chan_mode_t modes_set, modes_clear;
 187     unsigned int new_limit, argc;
 188 #ifndef NDEBUG
 189     unsigned int alloc_argc;
 190 #endif
 191     char new_key[KEYLEN + 1];
 192     struct {
 193         unsigned int mode;
 194         union {
 195             struct modeNode *member;
 196             const char *hostmask;
 197         };
 198     } args[1];
 199 };
 200 #define MCP_ALLOW_OVB     0x0001 /* allow op, voice, ban manipulation */
 201 #define MCP_FROM_SERVER   0x0002 /* parse as from a server */
 202 #define MCP_KEY_FREE      0x0004 /* -k without a key argument */
 203 #define MC_ANNOUNCE       0x0100 /* send a mod_chanmode() change out */
 204 #define MC_NOTIFY         0x0200 /* make local callbacks to announce */
 205 #ifdef NDEBUG
 206 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
 207 #else
 208 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
 209 #endif
 210
 211 struct mod_chanmode *mod_chanmode_alloc(unsigned int argc);
 212 struct mod_chanmode *mod_chanmode_dup(struct mod_chanmode *orig, unsigned int extra);
 213 struct mod_chanmode *mod_chanmode_parse(struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
 214 void mod_chanmode_apply(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
 215 void mod_chanmode_announce(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
 216 char *mod_chanmode_format(struct mod_chanmode *desc, char *buffer);
 217 void mod_chanmode_free(struct mod_chanmode *change);
 218 int mod_chanmode(struct userNode *who, struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
 219 typedef void (*mode_change_func_t) (struct chanNode *channel, struct userNode *user, const struct mod_chanmode *change);
 220 void reg_mode_change_func(mode_change_func_t handler);
 221 int irc_make_chanmode(struct chanNode *chan, char *out);
 222
 223 /* The "default" for generate_hostmask is to have all of these options off. */
 224 #define GENMASK_STRICT_HOST   1
 225 #define GENMASK_STRICT_IDENT  32
 226 #define GENMASK_ANY_IDENT     64
 227 #define GENMASK_STRICT   (GENMASK_STRICT_IDENT|GENMASK_STRICT_HOST)
 228 #define GENMASK_USENICK  2
 229 #define GENMASK_OMITNICK 4  /* Hurray for Kevin! */
 230 #define GENMASK_BYIP     8
 231 #define GENMASK_SRVXMASK 16
 232 #define GENMASK_NO_HIDING 128
 233 char *generate_hostmask(struct userNode *user, int options);
 234
 235 #endif /* !defined(PROTO_H) */