[irc/evilnet/x3.git] / src / proto.h

/* proto.h - IRC protocol output
 * Copyright 2000-2004 srvx Development Team
 *
 * This file is part of x3.
 *
 * srvx is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with srvx; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */

#if !defined(PROTO_H)
#define PROTO_H

/* Warning for those looking at how this code does multi-protocol
 * support: It's an awful, nasty hack job.  It is intended for short
 * term use, not long term, since we are already developing x3,
 * which has much nicer interfaces that hide most of the ugly
 * differences between protocol dialects. */

#define COMBO_NUMERIC_LEN 5   /* 1/2, 1/3 or 2/3 digits for server/client parts */
#define MAXLEN		512   /* Maximum IRC line length */
#define MAXNUMPARAMS    200
#define ALLCHANMSG_FUNCS_MAX  4 /* +1 == 5 potential 'allchanmsg' funcs */

#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif

struct gline;
struct shun;
struct server;
struct userNode;
struct chanNode;

/* connection manager state */

enum cState
{
    DISCONNECTED,
    AUTHENTICATING,
    BURSTING,
    CONNECTED
};

#define UPLINK_UNAVAILABLE	0x001

struct uplinkNode
{
    char		*name;

    char		*host;
    int			port;

    struct sockaddr_in 	*bind_addr;
    int 		bind_addr_len;

    char		*password;
    char		*their_password;

    enum cState		state;
    int			tries;
    int			max_tries;
    long		flags;

    struct uplinkNode	*prev;
    struct uplinkNode	*next;
};

struct cManagerNode
{
    struct uplinkNode	*uplinks;
    struct uplinkNode	*uplink;

    int			cycles;
    int			enabled;
};

#ifdef WITH_PROTOCOL_P10
struct server* GetServerN(const char *numeric);
struct userNode* GetUserN(const char *numeric);
#endif

/* Basic protocol parsing support. */
void init_parse(void);
int parse_line(char *line, int recursive);

/* Callback notifications for protocol support. */
typedef void (*chanmsg_func_t) (struct userNode *user, struct chanNode *chan, char *text, struct userNode *bot);
void reg_chanmsg_func(unsigned char prefix, struct userNode *service, chanmsg_func_t handler);
void reg_allchanmsg_func(struct userNode *service, chanmsg_func_t handler);
struct userNode *get_chanmsg_bot(unsigned char prefix);

typedef void (*privmsg_func_t) (struct userNode *user, struct userNode *target, char *text, int server_qualified);
void reg_privmsg_func(struct userNode *user, privmsg_func_t handler);
void reg_notice_func(struct userNode *user, privmsg_func_t handler);
void unreg_privmsg_func(struct userNode *user, privmsg_func_t handler);
void unreg_notice_func(struct userNode *user, privmsg_func_t handler);

typedef void (*oper_func_t) (struct userNode *user);
void reg_oper_func(oper_func_t handler);

/* replay silliness */
void replay_read_line(void);
void replay_event_loop(void);

/* connection maintenance */
void irc_server(struct server *srv);
void irc_user(struct userNode *user);
void irc_nick(struct userNode *user, const char *old_nick);
void irc_introduce(const char *passwd);
void irc_ping(const char *something);
void irc_pong(const char *who, const char *data);
void irc_quit(struct userNode *user, const char *message);
void irc_squit(struct server *srv, const char *message, const char *service_message);

/* messages */
void irc_privmsg(struct userNode *from, const char *to, const char *message);
void irc_notice(struct userNode *from, const char *to, const char *message);
void irc_notice_user(struct userNode *from, struct userNode *to, const char *message);
void irc_wallchops(struct userNode *from, const char *to, const char *message);

/* channel maintenance */
void irc_join(struct userNode *who, struct chanNode *what);
void irc_invite(struct userNode *from, struct userNode *who, struct chanNode *to);
void irc_mode(struct userNode *who, struct chanNode *target, const char *modes);
void irc_umode(struct userNode *target, const char *modes);
void irc_kick(struct userNode *who, struct userNode *target, struct chanNode *from, const char *msg);
void irc_part(struct userNode *who, struct chanNode *what, const char *reason);
void irc_topic(struct userNode *service, struct userNode *who, struct chanNode *what, const char *topic);
void irc_fetchtopic(struct userNode *from, const char *to);

/* network maintenance */
void irc_gline(struct server *srv, struct gline *gline);
void irc_shun(struct server *srv, struct shun *shun);
void irc_settime(const char *srv_name_mask, time_t new_time);
void irc_ungline(const char *mask);
void irc_unshun(const char *mask);
void irc_error(const char *to, const char *message);
void irc_kill(struct userNode *from, struct userNode *target, const char *message);
void irc_raw(const char *what);
void irc_stats(struct userNode *from, struct server *target, char type);
void irc_svsnick(struct userNode *from, struct userNode *target, const char *newnick);

/* account maintenance */
void irc_rename(struct userNode *user, const char *new_handle);
void irc_delete(struct userNode *user);
void irc_account(struct userNode *user, const char *stamp, time_t timestamp);
void irc_regnick(struct userNode *user);
void irc_fakehost(struct userNode *user, const char *host);

/* numeric messages */
void irc_numeric(struct userNode *user, unsigned int num, const char *format, ...);
/* RFC1459-compliant numeric responses */
#define RPL_ENDOFSTATS          219
#define RPL_STATSUPTIME         242
#define RPL_MAXCONNECTIONS      250
#define RPL_WHOISUSER           311
#define RPL_WHOISSERVER         312
#define RPL_WHOISOPERATOR       313
#define RPL_ENDOFWHOIS          318
#define ERR_NOSUCHNICK          401

/* stuff originally from other headers that is really protocol-specific */
int IsChannelName(const char *name);
int is_valid_nick(const char *nick);
struct userNode *AddService(const char *nick, const char *modes, const char *desc, const char *hostname);
struct userNode *AddClone(const char *nick, const char *ident, const char *hostname, const char *desc);
struct server* AddServer(struct server* uplink, const char *name, int hops, time_t boot, time_t link, const char *numeric, const char *description);
void DelServer(struct server* serv, int announce, const char *message);
void DelUser(struct userNode* user, struct userNode *killer, int announce, const char *why);
/* Most protocols will want to make an AddUser helper function. */

/* User modes */
void mod_usermode(struct userNode *user, const char *modes);

/* Channel mode manipulation */
#define KEYLEN          23
typedef unsigned long chan_mode_t;
/* Rules for struct mod_chanmode:
 * For a membership mode change, args[n].mode can contain more than
 * one mode bit (e.g. MODE_CHANOP|MODE_VOICE).  Hostmask strings are
 * "owned" by the caller and are not freed by mod_chanmode_free().
 */
struct mod_chanmode {
    chan_mode_t modes_set, modes_clear;
    unsigned int new_limit, argc;
#ifndef NDEBUG
    unsigned int alloc_argc;
#endif
    char new_key[KEYLEN + 1];
    struct {
        unsigned int mode;
        union {
            struct modeNode *member;
            const char *hostmask;
        } u;
    } args[1];
};
#define MCP_ALLOW_OVB     0x0001 /* allow op, voice, ban manipulation */
#define MCP_FROM_SERVER   0x0002 /* parse as from a server */
#define MCP_KEY_FREE      0x0004 /* -k without a key argument */
#define MCP_REGISTERED	  0x0008 /* chan is already registered; do not allow changes to MODE_REGISTERED */
#define MC_ANNOUNCE       0x0100 /* send a mod_chanmode() change out */
#define MC_NOTIFY         0x0200 /* make local callbacks to announce */
#ifdef NDEBUG
#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
#else
#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
#endif

struct mod_chanmode *mod_chanmode_alloc(unsigned int argc);
struct mod_chanmode *mod_chanmode_dup(struct mod_chanmode *orig, unsigned int extra);
struct mod_chanmode *mod_chanmode_parse(struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
void mod_chanmode_apply(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
void mod_chanmode_announce(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
char *mod_chanmode_format(struct mod_chanmode *desc, char *buffer);
void mod_chanmode_free(struct mod_chanmode *change);
int mod_chanmode(struct userNode *who, struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
typedef void (*mode_change_func_t) (struct chanNode *channel, struct userNode *user, const struct mod_chanmode *change);
void reg_mode_change_func(mode_change_func_t handler);
int irc_make_chanmode(struct chanNode *chan, char *out);

/* The "default" for generate_hostmask is to have all of these options off. */
#define GENMASK_STRICT_HOST   1
#define GENMASK_STRICT_IDENT  32
#define GENMASK_ANY_IDENT     64
#define GENMASK_STRICT   (GENMASK_STRICT_IDENT|GENMASK_STRICT_HOST)
#define GENMASK_USENICK  2
#define GENMASK_OMITNICK 4  /* Hurray for Kevin! */
#define GENMASK_BYIP     8
#define GENMASK_X3MASK 16
#define GENMASK_NO_HIDING 128
char *generate_hostmask(struct userNode *user, int options);

#endif /* !defined(PROTO_H) */
Commit	Line	Data
d76ed9a9	1	/* proto.h - IRC protocol output
	2	* Copyright 2000-2004 srvx Development Team
	3	*
83ff05c3	4	* This file is part of x3.
d76ed9a9	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
921592dd	26	* term use, not long term, since we are already developing x3,
d76ed9a9	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	#ifdef HAVE_NETINET_IN_H
	36	#include <netinet/in.h>
	37	#endif
	38
	39	struct gline;
d914d1cb	40	struct shun;
d76ed9a9	41	struct server;
	42	struct userNode;
	43	struct chanNode;
	44
	45	/* connection manager state */
	46
	47	enum cState
	48	{
	49	DISCONNECTED,
	50	AUTHENTICATING,
	51	BURSTING,
	52	CONNECTED
	53	};
	54
	55	#define UPLINK_UNAVAILABLE 0x001
	56
	57	struct uplinkNode
	58	{
	59	char *name;
	60
	61	char *host;
	62	int port;
	63
	64	struct sockaddr_in *bind_addr;
	65	int bind_addr_len;
	66
	67	char *password;
	68	char *their_password;
	69
	70	enum cState state;
	71	int tries;
	72	int max_tries;
	73	long flags;
	74
	75	struct uplinkNode *prev;
	76	struct uplinkNode *next;
	77	};
	78
	79	struct cManagerNode
	80	{
	81	struct uplinkNode *uplinks;
	82	struct uplinkNode *uplink;
	83
	84	int cycles;
	85	int enabled;
	86	};
	87
	88	#ifdef WITH_PROTOCOL_P10
	89	struct server* GetServerN(const char *numeric);
	90	struct userNode* GetUserN(const char *numeric);
	91	#endif
	92
	93	/* Basic protocol parsing support. */
	94	void init_parse(void);
	95	int parse_line(char *line, int recursive);
	96
	97	/* Callback notifications for protocol support. */
	98	typedef void (chanmsg_func_t) (struct userNode user, struct chanNode chan, char text, struct userNode *bot);
	99	void reg_chanmsg_func(unsigned char prefix, struct userNode *service, chanmsg_func_t handler);
	100	void reg_allchanmsg_func(struct userNode *service, chanmsg_func_t handler);
	101	struct userNode *get_chanmsg_bot(unsigned char prefix);
	102
	103	typedef void (privmsg_func_t) (struct userNode user, struct userNode target, char text, int server_qualified);
	104	void reg_privmsg_func(struct userNode *user, privmsg_func_t handler);
105	void reg_notice_func(struct userNode *user, privmsg_func_t handler);
106	void unreg_privmsg_func(struct userNode *user, privmsg_func_t handler);
107	void unreg_notice_func(struct userNode *user, privmsg_func_t handler);
108
109	typedef void (oper_func_t) (struct userNode user);
110	void reg_oper_func(oper_func_t handler);
111
d76ed9a9	112	/* replay silliness */
	113	void replay_read_line(void);
	114	void replay_event_loop(void);
	115
	116	/* connection maintenance */
	117	void irc_server(struct server *srv);
	118	void irc_user(struct userNode *user);
	119	void irc_nick(struct userNode user, const char old_nick);
	120	void irc_introduce(const char *passwd);
	121	void irc_ping(const char *something);
	122	void irc_pong(const char who, const char data);
	123	void irc_quit(struct userNode user, const char message);
	124	void irc_squit(struct server srv, const char message, const char *service_message);
	125
	126	/* messages */
	127	void irc_privmsg(struct userNode from, const char to, const char *message);
	128	void irc_notice(struct userNode from, const char to, const char *message);
	129	void irc_notice_user(struct userNode from, struct userNode to, const char *message);
	130	void irc_wallchops(struct userNode from, const char to, const char *message);
	131
	132	/* channel maintenance */
	133	void irc_join(struct userNode who, struct chanNode what);
	134	void irc_invite(struct userNode from, struct userNode who, struct chanNode *to);
	135	void irc_mode(struct userNode who, struct chanNode target, const char *modes);
5a1daaab	136	void irc_umode(struct userNode target, const char modes);
d76ed9a9	137	void irc_kick(struct userNode who, struct userNode target, struct chanNode from, const char msg);
d76ed9a9	138	void irc_part(struct userNode who, struct chanNode what, const char *reason);
7fda2b52	139	void irc_topic(struct userNode service, struct userNode who, struct chanNode what, const char topic);
d76ed9a9	140	void irc_fetchtopic(struct userNode from, const char to);
	141
	142	/* network maintenance */
	143	void irc_gline(struct server srv, struct gline gline);
d914d1cb	144	void irc_shun(struct server srv, struct shun shun);
d76ed9a9	145	void irc_settime(const char *srv_name_mask, time_t new_time);
d76ed9a9	146	void irc_ungline(const char *mask);
d914d1cb	147	void irc_unshun(const char *mask);
d76ed9a9	148	void irc_error(const char to, const char message);
	149	void irc_kill(struct userNode from, struct userNode target, const char *message);
	150	void irc_raw(const char *what);
	151	void irc_stats(struct userNode from, struct server target, char type);
	152	void irc_svsnick(struct userNode from, struct userNode target, const char *newnick);
	153
	154	/* account maintenance */
a45e6ec7	155	void irc_rename(struct userNode user, const char new_handle);
a45e6ec7	156	void irc_delete(struct userNode *user);
b21e2cfe	157	void irc_account(struct userNode user, const char stamp, time_t timestamp);
d76ed9a9	158	void irc_regnick(struct userNode *user);
	159	void irc_fakehost(struct userNode user, const char host);
	160
	161	/* numeric messages */
	162	void irc_numeric(struct userNode user, unsigned int num, const char format, ...);
	163	/* RFC1459-compliant numeric responses */
	164	#define RPL_ENDOFSTATS 219
	165	#define RPL_STATSUPTIME 242
	166	#define RPL_MAXCONNECTIONS 250
	167	#define RPL_WHOISUSER 311
	168	#define RPL_WHOISSERVER 312
	169	#define RPL_WHOISOPERATOR 313
	170	#define RPL_ENDOFWHOIS 318
	171	#define ERR_NOSUCHNICK 401
	172
	173	/* stuff originally from other headers that is really protocol-specific */
	174	int IsChannelName(const char *name);
	175	int is_valid_nick(const char *nick);
a32da4c7	176	struct userNode AddService(const char nick, const char modes, const char desc, const char *hostname);
d76ed9a9	177	struct userNode AddClone(const char nick, const char ident, const char hostname, const char *desc);
	178	struct server* AddServer(struct server* uplink, const char name, int hops, time_t boot, time_t link, const char numeric, const char *description);
	179	void DelServer(struct server* serv, int announce, const char *message);
	180	void DelUser(struct userNode* user, struct userNode killer, int announce, const char why);
	181	/* Most protocols will want to make an AddUser helper function. */
	182
	183	/* User modes */
	184	void mod_usermode(struct userNode user, const char modes);
	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	struct {
	202	unsigned int mode;
	203	union {
	204	struct modeNode *member;
	205	const char *hostmask;
a32da4c7	206	} u;
d76ed9a9	207	} args[1];
	208	};
	209	#define MCP_ALLOW_OVB 0x0001 /* allow op, voice, ban manipulation */
	210	#define MCP_FROM_SERVER 0x0002 /* parse as from a server */
	211	#define MCP_KEY_FREE 0x0004 /* -k without a key argument */
a32da4c7	212	#define MCP_REGISTERED 0x0008 /* chan is already registered; do not allow changes to MODE_REGISTERED */
d76ed9a9	213	#define MC_ANNOUNCE 0x0100 /* send a mod_chanmode() change out */
	214	#define MC_NOTIFY 0x0200 /* make local callbacks to announce */
	215	#ifdef NDEBUG
	216	#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
	217	#else
	218	#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
	219	#endif
	220
	221	struct mod_chanmode *mod_chanmode_alloc(unsigned int argc);
	222	struct mod_chanmode mod_chanmode_dup(struct mod_chanmode orig, unsigned int extra);
	223	struct mod_chanmode mod_chanmode_parse(struct chanNode channel, char **modes, unsigned int argc, unsigned int flags);
	224	void mod_chanmode_apply(struct userNode who, struct chanNode channel, struct mod_chanmode *change);
	225	void mod_chanmode_announce(struct userNode who, struct chanNode channel, struct mod_chanmode *change);
	226	char mod_chanmode_format(struct mod_chanmode desc, char *buffer);
	227	void mod_chanmode_free(struct mod_chanmode *change);
	228	int mod_chanmode(struct userNode who, struct chanNode channel, char **modes, unsigned int argc, unsigned int flags);
	229	typedef void (mode_change_func_t) (struct chanNode channel, struct userNode user, const struct mod_chanmode change);
	230	void reg_mode_change_func(mode_change_func_t handler);
	231	int irc_make_chanmode(struct chanNode chan, char out);
	232
	233	/* The "default" for generate_hostmask is to have all of these options off. */
	234	#define GENMASK_STRICT_HOST 1
	235	#define GENMASK_STRICT_IDENT 32
	236	#define GENMASK_ANY_IDENT 64
	237	#define GENMASK_STRICT (GENMASK_STRICT_IDENT\|GENMASK_STRICT_HOST)
	238	#define GENMASK_USENICK 2
	239	#define GENMASK_OMITNICK 4 /* Hurray for Kevin! */
	240	#define GENMASK_BYIP 8
921592dd	241	#define GENMASK_X3MASK 16
d76ed9a9	242	#define GENMASK_NO_HIDING 128
	243	char generate_hostmask(struct userNode user, int options);
	244
	245	#endif /* !defined(PROTO_H) */