src/proto.h

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