1 /* proto.h - IRC protocol output
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of srvx.
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.
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.
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.
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. */
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 */
35 #ifdef HAVE_NETINET_IN_H
36 #include <netinet/in.h>
44 /* connection manager state */
54 #define UPLINK_UNAVAILABLE 0x001
63 struct sockaddr_in *bind_addr;
74 struct uplinkNode *prev;
75 struct uplinkNode *next;
80 struct uplinkNode *uplinks;
81 struct uplinkNode *uplink;
87 #ifdef WITH_PROTOCOL_P10
88 struct server* GetServerN(const char *numeric);
89 struct userNode* GetUserN(const char *numeric);
92 /* Basic protocol parsing support. */
93 void init_parse(void);
94 int parse_line(char *line, int recursive);
96 /* Callback notifications for protocol support. */
97 typedef void (*chanmsg_func_t) (struct userNode *user, struct chanNode *chan, char *text, struct userNode *bot);
98 void reg_chanmsg_func(unsigned char prefix, struct userNode *service, chanmsg_func_t handler);
99 void reg_allchanmsg_func(struct userNode *service, chanmsg_func_t handler);
100 struct userNode *get_chanmsg_bot(unsigned char prefix);
102 typedef void (*privmsg_func_t) (struct userNode *user, struct userNode *target, char *text, int server_qualified);
103 void reg_privmsg_func(struct userNode *user, privmsg_func_t handler);
104 void reg_notice_func(struct userNode *user, privmsg_func_t handler);
106 typedef void (*oper_func_t) (struct userNode *user);
107 void reg_oper_func(oper_func_t handler);
109 extern struct userList dead_users;
111 /* replay silliness */
112 void replay_read_line(void);
113 void replay_event_loop(void);
115 /* connection maintenance */
116 void irc_server(struct server *srv);
117 void irc_user(struct userNode *user);
118 void irc_nick(struct userNode *user, const char *old_nick);
119 void irc_introduce(const char *passwd);
120 void irc_ping(const char *something);
121 void irc_pong(const char *who, const char *data);
122 void irc_quit(struct userNode *user, const char *message);
123 void irc_squit(struct server *srv, const char *message, const char *service_message);
126 void irc_privmsg(struct userNode *from, const char *to, const char *message);
127 void irc_notice(struct userNode *from, const char *to, const char *message);
128 void irc_notice_user(struct userNode *from, struct userNode *to, const char *message);
129 void irc_wallchops(struct userNode *from, const char *to, const char *message);
131 /* channel maintenance */
132 void irc_join(struct userNode *who, struct chanNode *what);
133 void irc_invite(struct userNode *from, struct userNode *who, struct chanNode *to);
134 void irc_mode(struct userNode *who, struct chanNode *target, const char *modes);
135 void irc_kick(struct userNode *who, struct userNode *target, struct chanNode *from, const char *msg);
136 void irc_part(struct userNode *who, struct chanNode *what, const char *reason);
137 void irc_topic(struct userNode *who, struct chanNode *what, const char *topic);
138 void irc_fetchtopic(struct userNode *from, const char *to);
140 /* network maintenance */
141 void irc_gline(struct server *srv, struct gline *gline);
142 void irc_settime(const char *srv_name_mask, time_t new_time);
143 void irc_ungline(const char *mask);
144 void irc_error(const char *to, const char *message);
145 void irc_kill(struct userNode *from, struct userNode *target, const char *message);
146 void irc_raw(const char *what);
147 void irc_stats(struct userNode *from, struct server *target, char type);
148 void irc_svsnick(struct userNode *from, struct userNode *target, const char *newnick);
150 /* account maintenance */
151 void irc_account(struct userNode *user, const char *stamp);
152 void irc_regnick(struct userNode *user);
154 /* numeric messages */
155 void irc_numeric(struct userNode *user, unsigned int num, const char *format, ...);
156 /* RFC1459-compliant numeric responses */
157 #define RPL_ENDOFSTATS 219
158 #define RPL_STATSUPTIME 242
159 #define RPL_MAXCONNECTIONS 250
160 #define RPL_WHOISUSER 311
161 #define RPL_WHOISSERVER 312
162 #define RPL_WHOISOPERATOR 313
163 #define RPL_ENDOFWHOIS 318
164 #define ERR_NOSUCHNICK 401
166 /* stuff originally from other headers that is really protocol-specific */
167 int IsChannelName(const char *name);
168 int is_valid_nick(const char *nick);
169 struct userNode *AddService(const char *nick, const char *desc, const char *hostname);
170 struct userNode *AddClone(const char *nick, const char *ident, const char *hostname, const char *desc);
171 struct server* AddServer(struct server* uplink, const char *name, int hops, time_t boot, time_t link, const char *numeric, const char *description);
172 void DelServer(struct server* serv, int announce, const char *message);
173 void DelUser(struct userNode* user, struct userNode *killer, int announce, const char *why);
174 /* Most protocols will want to make an AddUser helper function. */
177 void mod_usermode(struct userNode *user, const char *modes);
179 /* Channel mode manipulation */
181 typedef unsigned long chan_mode_t;
182 /* Rules for struct mod_chanmode:
183 * For a membership mode change, args[n].mode can contain more than
184 * one mode bit (e.g. MODE_CHANOP|MODE_VOICE). Hostmask strings are
185 * "owned" by the caller and are not freed by mod_chanmode_free().
187 struct mod_chanmode {
188 chan_mode_t modes_set, modes_clear;
189 unsigned int new_limit, argc;
191 unsigned int alloc_argc;
193 char new_key[KEYLEN + 1];
197 struct modeNode *member;
198 const char *hostmask;
202 #define MCP_ALLOW_OVB 0x0001 /* allow op, voice, ban manipulation */
203 #define MCP_FROM_SERVER 0x0002 /* parse as from a server */
204 #define MCP_KEY_FREE 0x0004 /* -k without a key argument */
205 #define MC_ANNOUNCE 0x0100 /* send a mod_chanmode() change out */
206 #define MC_NOTIFY 0x0200 /* make local callbacks to announce */
208 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
210 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
213 struct mod_chanmode *mod_chanmode_alloc(unsigned int argc);
214 struct mod_chanmode *mod_chanmode_dup(struct mod_chanmode *orig, unsigned int extra);
215 struct mod_chanmode *mod_chanmode_parse(struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
216 void mod_chanmode_apply(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
217 void mod_chanmode_announce(struct userNode *who, struct chanNode *channel, struct mod_chanmode *change);
218 char *mod_chanmode_format(struct mod_chanmode *desc, char *buffer);
219 void mod_chanmode_free(struct mod_chanmode *change);
220 int mod_chanmode(struct userNode *who, struct chanNode *channel, char **modes, unsigned int argc, unsigned int flags);
221 typedef void (*mode_change_func_t) (struct chanNode *channel, struct userNode *user, const struct mod_chanmode *change);
222 void reg_mode_change_func(mode_change_func_t handler);
223 int irc_make_chanmode(struct chanNode *chan, char *out);
225 /* The "default" for generate_hostmask is to have all of these options off. */
226 #define GENMASK_STRICT_HOST 1
227 #define GENMASK_STRICT_IDENT 32
228 #define GENMASK_ANY_IDENT 64
229 #define GENMASK_STRICT (GENMASK_STRICT_IDENT|GENMASK_STRICT_HOST)
230 #define GENMASK_USENICK 2
231 #define GENMASK_OMITNICK 4 /* Hurray for Kevin! */
232 #define GENMASK_BYIP 8
233 #define GENMASK_SRVXMASK 16
234 #define GENMASK_NO_HIDING 128
235 char *generate_hostmask(struct userNode *user, int options);
237 #endif /* !defined(PROTO_H) */