]> jfr.im git - irc/evilnet/x3.git/blame - src/proto.h
Added tempshun support to OpServ trace and addalert
[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. */
1c14af0b 97typedef void (*chanmsg_func_t) (struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot, unsigned int is_notice, void *extra);
98void reg_chanmsg_func(unsigned char prefix, struct userNode *service, chanmsg_func_t handler, void *extra);
d76ed9a9 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
e9b00805 108typedef void (*oper_func_t) (struct userNode *user, void *extra);
109void reg_oper_func(oper_func_t handler, void *extra);
d76ed9a9 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);
f20f0ab5 147void irc_svsquit(struct userNode *from, struct userNode *who, char const *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);
5f233568 162void irc_tempshun(struct userNode *from, struct userNode *target, int remove, const char *reason);
6c34bb5a 163void irc_privs(struct userNode *target, char *flag, int add);
6ae87c77 164void irc_raw_privs(struct userNode *target, const char *privs);
d76ed9a9 165
166/* account maintenance */
a45e6ec7 167void irc_rename(struct userNode *user, const char *new_handle);
168void irc_delete(struct userNode *user);
b21e2cfe 169void irc_account(struct userNode *user, const char *stamp, time_t timestamp);
d76ed9a9 170void irc_regnick(struct userNode *user);
171void irc_fakehost(struct userNode *user, const char *host);
d82cf2f0 172void irc_mark(struct userNode *user, char *mark);
10be9be0 173void irc_sno(unsigned int mask, char const* format, ...);
c8b4b87b 174void irc_sasl(struct server* dest, const char *identifier, const char *subcmd, const char *data);
d76ed9a9 175
176/* numeric messages */
177void irc_numeric(struct userNode *user, unsigned int num, const char *format, ...);
178/* RFC1459-compliant numeric responses */
179#define RPL_ENDOFSTATS 219
180#define RPL_STATSUPTIME 242
181#define RPL_MAXCONNECTIONS 250
1136f709 182#define RPL_AWAY 301
d76ed9a9 183#define RPL_WHOISUSER 311
184#define RPL_WHOISSERVER 312
185#define RPL_WHOISOPERATOR 313
1136f709 186#define RPL_WHOISIDLE 317
d76ed9a9 187#define RPL_ENDOFWHOIS 318
1136f709 188#define RPL_WHOISCHANNELS 319
189#define RPL_WHOISACCOUNT 330
190#define RPL_WHOISACTUALLY 338
d76ed9a9 191#define ERR_NOSUCHNICK 401
192
193/* stuff originally from other headers that is really protocol-specific */
194int IsChannelName(const char *name);
195int is_valid_nick(const char *nick);
1136f709 196struct userNode *AddLocalUser(const char *nick, const char *ident, const char *hostname, const char *desc, const char *modes);
d76ed9a9 197struct server* AddServer(struct server* uplink, const char *name, int hops, time_t boot, time_t link, const char *numeric, const char *description);
198void DelServer(struct server* serv, int announce, const char *message);
199void DelUser(struct userNode* user, struct userNode *killer, int announce, const char *why);
200/* Most protocols will want to make an AddUser helper function. */
201
202/* User modes */
203void mod_usermode(struct userNode *user, const char *modes);
57fdf922 204extern const char irc_user_mode_chars[];
205unsigned int irc_user_modes(const struct userNode *user, char modes[], size_t length);
d76ed9a9 206
207/* Channel mode manipulation */
208#define KEYLEN 23
209typedef unsigned long chan_mode_t;
210/* Rules for struct mod_chanmode:
211 * For a membership mode change, args[n].mode can contain more than
212 * one mode bit (e.g. MODE_CHANOP|MODE_VOICE). Hostmask strings are
213 * "owned" by the caller and are not freed by mod_chanmode_free().
214 */
215struct mod_chanmode {
216 chan_mode_t modes_set, modes_clear;
217 unsigned int new_limit, argc;
218#ifndef NDEBUG
219 unsigned int alloc_argc;
220#endif
221 char new_key[KEYLEN + 1];
2f61d1d7 222 char new_upass[KEYLEN + 1];
223 char new_apass[KEYLEN + 1];
d76ed9a9 224 struct {
225 unsigned int mode;
226 union {
227 struct modeNode *member;
228 const char *hostmask;
a32da4c7 229 } u;
d76ed9a9 230 } args[1];
231};
232#define MCP_ALLOW_OVB 0x0001 /* allow op, voice, ban manipulation */
233#define MCP_FROM_SERVER 0x0002 /* parse as from a server */
234#define MCP_KEY_FREE 0x0004 /* -k without a key argument */
a32da4c7 235#define MCP_REGISTERED 0x0008 /* chan is already registered; do not allow changes to MODE_REGISTERED */
2f61d1d7 236#define MCP_UPASS_FREE 0x0010 /* -U without a key argument */
237#define MCP_APASS_FREE 0x0020 /* -A without a key argument */
d76ed9a9 238#define MC_ANNOUNCE 0x0100 /* send a mod_chanmode() change out */
239#define MC_NOTIFY 0x0200 /* make local callbacks to announce */
240#ifdef NDEBUG
241#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
242#else
243#define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
244#endif
245
246struct mod_chanmode *mod_chanmode_alloc(unsigned int argc);
247struct mod_chanmode *mod_chanmode_dup(struct mod_chanmode *orig, unsigned int extra);
2f61d1d7 248struct mod_chanmode *mod_chanmode_parse(struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags, short base_oplevel);
d76ed9a9 249void mod_chanmode_apply(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
250void mod_chanmode_announce(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
251char *mod_chanmode_format(struct mod_chanmode *desc, char *buffer);
252void mod_chanmode_free(struct mod_chanmode *change);
253int mod_chanmode(struct userNode *who, struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
f14b32b8 254typedef void (*mode_change_func_t) (struct chanNode *channel, struct userNode *user, const struct mod_chanmode *change, void *extra);
255void reg_mode_change_func(mode_change_func_t handler, void *extra);
d76ed9a9 256int irc_make_chanmode(struct chanNode *chan, char *out);
69517d70 257int client_modify_priv_by_name(struct userNode *who, char *priv, int what);
d76ed9a9 258
259/* The "default" for generate_hostmask is to have all of these options off. */
260#define GENMASK_STRICT_HOST 1
261#define GENMASK_STRICT_IDENT 32
262#define GENMASK_ANY_IDENT 64
263#define GENMASK_STRICT (GENMASK_STRICT_IDENT|GENMASK_STRICT_HOST)
264#define GENMASK_USENICK 2
265#define GENMASK_OMITNICK 4 /* Hurray for Kevin! */
266#define GENMASK_BYIP 8
921592dd 267#define GENMASK_X3MASK 16
d76ed9a9 268#define GENMASK_NO_HIDING 128
269char *generate_hostmask(struct userNode *user, int options);
270
271#endif /* !defined(PROTO_H) */