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