1 /* proto.h - IRC protocol output
2 * Copyright 2000-2004 srvx Development Team
4 * This file is part of x3.
6 * x3 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 x3,
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>
45 /* connection manager state */
55 #define UPLINK_UNAVAILABLE 0x001
64 struct sockaddr
*bind_addr
;
75 struct uplinkNode
*prev
;
76 struct uplinkNode
*next
;
81 struct uplinkNode
*uplinks
;
82 struct uplinkNode
*uplink
;
88 #ifdef WITH_PROTOCOL_P10
89 struct server
* GetServerN(const char *numeric
);
90 struct userNode
* GetUserN(const char *numeric
);
93 /* Basic protocol parsing support. */
94 void init_parse(void);
95 int parse_line(char *line
, int recursive
);
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
);
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
);
109 typedef void (*oper_func_t
) (struct userNode
*user
);
110 void reg_oper_func(oper_func_t handler
);
112 /* replay silliness */
113 void replay_read_line(void);
114 void replay_event_loop(void);
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 void irc_squit_route(struct server
*srv
, const char *message
, ...);
126 void irc_connect(struct userNode
*user
, char *server
, unsigned int port
, struct server
*target
);
129 void irc_privmsg(struct userNode
*from
, const char *to
, const char *message
);
130 void irc_notice(struct userNode
*from
, const char *to
, const char *message
);
131 void irc_notice_user(struct userNode
*from
, struct userNode
*to
, const char *message
);
132 void irc_wallchops(struct userNode
*from
, const char *to
, const char *message
);
133 void irc_wallops(const char *format
, ...);
135 /* channel maintenance */
136 void irc_join(struct userNode
*who
, struct chanNode
*what
);
137 void irc_invite(struct userNode
*from
, struct userNode
*who
, struct chanNode
*to
);
138 void irc_mode(struct userNode
*who
, struct chanNode
*target
, const char *modes
);
139 void irc_umode(struct userNode
*target
, const char *modes
);
140 void irc_kick(struct userNode
*who
, struct userNode
*target
, struct chanNode
*from
, const char *msg
);
141 void irc_part(struct userNode
*who
, struct chanNode
*what
, const char *reason
);
142 void irc_topic(struct userNode
*service
, struct userNode
*who
, struct chanNode
*what
, const char *topic
);
143 void irc_fetchtopic(struct userNode
*from
, const char *to
);
145 /* network maintenance */
146 void irc_silence(struct userNode
*who
, const char *mask
, int add
);
147 void irc_gline(struct server
*srv
, struct gline
*gline
, int silent
);
148 void irc_shun(struct server
*srv
, struct shun
*shun
);
149 void irc_settime(const char *srv_name_mask
, time_t new_time
);
150 void irc_ungline(const char *mask
);
151 void irc_unshun(const char *mask
);
152 void irc_error(const char *to
, const char *message
);
153 void irc_kill(struct userNode
*from
, struct userNode
*target
, const char *message
);
154 void irc_raw(const char *what
);
155 void irc_stats(struct userNode
*from
, struct server
*target
, char type
);
156 void irc_svsnick(struct userNode
*from
, struct userNode
*target
, const char *newnick
);
157 void irc_swhois(struct userNode
*from
, struct userNode
*target
, const char *message
);
159 /* account maintenance */
160 void irc_rename(struct userNode
*user
, const char *new_handle
);
161 void irc_delete(struct userNode
*user
);
162 void irc_account(struct userNode
*user
, const char *stamp
, time_t timestamp
);
163 void irc_regnick(struct userNode
*user
);
164 void irc_fakehost(struct userNode
*user
, const char *host
);
166 /* numeric messages */
167 void irc_numeric(struct userNode
*user
, unsigned int num
, const char *format
, ...);
168 /* RFC1459-compliant numeric responses */
169 #define RPL_ENDOFSTATS 219
170 #define RPL_STATSUPTIME 242
171 #define RPL_MAXCONNECTIONS 250
172 #define RPL_WHOISUSER 311
173 #define RPL_WHOISSERVER 312
174 #define RPL_WHOISOPERATOR 313
175 #define RPL_ENDOFWHOIS 318
176 #define ERR_NOSUCHNICK 401
178 /* stuff originally from other headers that is really protocol-specific */
179 int IsChannelName(const char *name
);
180 int is_valid_nick(const char *nick
);
181 struct userNode
*AddService(const char *nick
, const char *modes
, const char *desc
, const char *hostname
);
182 struct userNode
*AddClone(const char *nick
, const char *ident
, const char *hostname
, const char *desc
);
183 struct server
* AddServer(struct server
* uplink
, const char *name
, int hops
, time_t boot
, time_t link
, const char *numeric
, const char *description
);
184 void DelServer(struct server
* serv
, int announce
, const char *message
);
185 void DelUser(struct userNode
* user
, struct userNode
*killer
, int announce
, const char *why
);
186 /* Most protocols will want to make an AddUser helper function. */
189 void mod_usermode(struct userNode
*user
, const char *modes
);
191 /* Channel mode manipulation */
193 typedef unsigned long chan_mode_t
;
194 /* Rules for struct mod_chanmode:
195 * For a membership mode change, args[n].mode can contain more than
196 * one mode bit (e.g. MODE_CHANOP|MODE_VOICE). Hostmask strings are
197 * "owned" by the caller and are not freed by mod_chanmode_free().
199 struct mod_chanmode
{
200 chan_mode_t modes_set
, modes_clear
;
201 unsigned int new_limit
, argc
;
203 unsigned int alloc_argc
;
205 char new_key
[KEYLEN
+ 1];
206 char new_upass
[KEYLEN
+ 1];
207 char new_apass
[KEYLEN
+ 1];
211 struct modeNode
*member
;
212 const char *hostmask
;
216 #define MCP_ALLOW_OVB 0x0001 /* allow op, voice, ban manipulation */
217 #define MCP_FROM_SERVER 0x0002 /* parse as from a server */
218 #define MCP_KEY_FREE 0x0004 /* -k without a key argument */
219 #define MCP_REGISTERED 0x0008 /* chan is already registered; do not allow changes to MODE_REGISTERED */
220 #define MCP_UPASS_FREE 0x0010 /* -U without a key argument */
221 #define MCP_APASS_FREE 0x0020 /* -A without a key argument */
222 #define MC_ANNOUNCE 0x0100 /* send a mod_chanmode() change out */
223 #define MC_NOTIFY 0x0200 /* make local callbacks to announce */
225 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); } while (0)
227 #define mod_chanmode_init(CHANMODE) do { memset((CHANMODE), 0, sizeof(*CHANMODE)); (CHANMODE)->alloc_argc = ArrayLength((CHANMODE)->args); } while (0)
230 struct mod_chanmode
*mod_chanmode_alloc(unsigned int argc
);
231 struct mod_chanmode
*mod_chanmode_dup(struct mod_chanmode
*orig
, unsigned int extra
);
232 struct mod_chanmode
*mod_chanmode_parse(struct chanNode
*channel
, char **modes
, unsigned int argc
, unsigned int flags
, short base_oplevel
);
233 void mod_chanmode_apply(struct userNode
*who
, struct chanNode
*channel
, struct mod_chanmode
*change
);
234 void mod_chanmode_announce(struct userNode
*who
, struct chanNode
*channel
, struct mod_chanmode
*change
);
235 char *mod_chanmode_format(struct mod_chanmode
*desc
, char *buffer
);
236 void mod_chanmode_free(struct mod_chanmode
*change
);
237 int mod_chanmode(struct userNode
*who
, struct chanNode
*channel
, char **modes
, unsigned int argc
, unsigned int flags
);
238 typedef void (*mode_change_func_t
) (struct chanNode
*channel
, struct userNode
*user
, const struct mod_chanmode
*change
);
239 void reg_mode_change_func(mode_change_func_t handler
);
240 int irc_make_chanmode(struct chanNode
*chan
, char *out
);
242 /* The "default" for generate_hostmask is to have all of these options off. */
243 #define GENMASK_STRICT_HOST 1
244 #define GENMASK_STRICT_IDENT 32
245 #define GENMASK_ANY_IDENT 64
246 #define GENMASK_STRICT (GENMASK_STRICT_IDENT|GENMASK_STRICT_HOST)
247 #define GENMASK_USENICK 2
248 #define GENMASK_OMITNICK 4 /* Hurray for Kevin! */
249 #define GENMASK_BYIP 8
250 #define GENMASK_X3MASK 16
251 #define GENMASK_NO_HIDING 128
252 char *generate_hostmask(struct userNode
*user
, int options
);
254 #endif /* !defined(PROTO_H) */