2 * IRC - Internet Relay Chat, include/client.h
3 * Copyright (C) 1990 Jarkko Oikarinen and
4 * University of Oulu, Computing Center
6 * This program 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, or (at your option)
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 this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief Structures and functions for handling local clients.
22 * @version $Id: client.h 1907 2009-02-09 04:11:04Z entrope $
24 #ifndef INCLUDED_client_h
25 #define INCLUDED_client_h
26 #ifndef INCLUDED_ircd_defs_h
27 #include "ircd_defs.h"
29 #ifndef INCLUDED_dbuf_h
32 #ifndef INCLUDED_msgq_h
35 #ifndef INCLUDED_ircd_events_h
36 #include "ircd_events.h"
38 #ifndef INCLUDED_ircd_handler_h
39 #include "ircd_handler.h"
41 #ifndef INCLUDED_res_h
44 #ifndef INCLUDED_sys_types_h
45 #include <sys/types.h> /* time_t, size_t */
46 #define INCLUDED_sys_types_h
63 * Only put structures here that are being used in a very large number of
64 * source files. Other structures go in the header file of there corresponding
65 * source file, or in the source file itself (when only used in that file).
68 /** Single element in a flag bitset array. */
69 typedef unsigned long flagpage_t;
71 /** Number of bits in a flagpage_t. */
72 #define FLAGSET_NBITS (8 * sizeof(flagpage_t))
73 /** Element number for flag \a flag. */
74 #define FLAGSET_INDEX(flag) ((flag) / FLAGSET_NBITS)
75 /** Element bit for flag \a flag. */
76 #define FLAGSET_MASK(flag) (1ul<<((flag) % FLAGSET_NBITS))
78 /** Declare a flagset structure of a particular size. */
79 #define DECLARE_FLAGSET(name,max) \
82 unsigned long bits[((max + FLAGSET_NBITS - 1) / FLAGSET_NBITS)]; \
85 /** Test whether a flag is set in a flagset. */
86 #define FlagHas(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] & FLAGSET_MASK(flag))
87 /** Set a flag in a flagset. */
88 #define FlagSet(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] |= FLAGSET_MASK(flag))
89 /** Clear a flag in a flagset. */
90 #define FlagClr(set,flag) ((set)->bits[FLAGSET_INDEX(flag)] &= ~FLAGSET_MASK(flag))
92 /** String containing valid user modes, in no particular order. */
93 #define infousermodes "dioswkgxnIXSHc"
95 /** Operator privileges. */
98 PRIV_CHAN_LIMIT, /**< no channel limit on oper */
99 PRIV_MODE_LCHAN, /**< oper can mode local chans */
100 PRIV_WALK_LCHAN, /**< oper can walk through local modes */
101 PRIV_DEOP_LCHAN, /**< no deop oper on local chans */
102 PRIV_SHOW_INVIS, /**< show local invisible users */
103 PRIV_SHOW_ALL_INVIS, /**< show all invisible users */
104 PRIV_UNLIMIT_QUERY, /**< unlimit who queries */
105 PRIV_KILL, /**< oper can KILL */
106 PRIV_LOCAL_KILL, /**< oper can local KILL */
107 PRIV_REHASH, /**< oper can REHASH */
108 PRIV_RESTART, /**< oper can RESTART */
109 PRIV_DIE, /**< oper can DIE */
110 PRIV_GLINE, /**< oper can GLINE */
111 PRIV_LOCAL_GLINE, /**< oper can local GLINE */
112 PRIV_JUPE, /**< oper can JUPE */
113 PRIV_LOCAL_JUPE, /**< oper can local JUPE */
114 PRIV_OPMODE, /**< oper can OP/CLEARMODE */
115 PRIV_LOCAL_OPMODE, /**< oper can local OP/CLEARMODE */
116 PRIV_SET, /**< oper can SET */
117 PRIV_WHOX, /**< oper can use /who x */
118 PRIV_BADCHAN, /**< oper can BADCHAN */
119 PRIV_LOCAL_BADCHAN, /**< oper can local BADCHAN */
120 PRIV_SEE_CHAN, /**< oper can see in secret chans */
121 PRIV_PROPAGATE, /**< propagate oper status */
122 PRIV_DISPLAY, /**< "Is an oper" displayed */
123 PRIV_SEE_OPERS, /**< display hidden opers */
124 PRIV_WIDE_GLINE, /**< oper can set wider G-lines */
125 PRIV_LIST_CHAN, /**< oper can list secret channels */
126 PRIV_FORCE_OPMODE, /**< can hack modes on quarantined channels */
127 PRIV_FORCE_LOCAL_OPMODE, /**< can hack modes on quarantined local channels */
128 PRIV_APASS_OPMODE, /**< can hack modes +A/-A/+U/-U */
129 PRIV_UMODE_NOCHAN, /**< can set umode +n (hide channels) */
130 PRIV_UMODE_NOIDLE, /**< can set umode +I (hide idle time) */
131 PRIV_UMODE_CHSERV, /**< can set umode +k (channel service) */
132 PRIV_UMODE_XTRAOP, /**< can set umode +X (eXtra oper; override +k) */
133 PRIV_UMODE_NETSERV, /**< can set umode +S (network service) */
134 PRIV_SEE_IDLETIME, /**< can see idle time of +I users */
135 PRIV_HIDE_IDLETIME, /**< hide idle time in 2nd layer */
136 PRIV_HALFFLOOD, /**< user has less throttling */
137 PRIV_FLOOD, /**< no more excess floods */
138 PRIV_UNLIMITED_TARGET, /**< unlimited target changes */
139 PRIV_UMODE_OVERRIDECC, /**< can set umode +c (override cmodes +cC) */
140 PRIV_NOAMSG_OVERRIDE, /**< can override the +M channelmode */
141 PRIV_LAST_PRIV /**< number of privileges */
144 /** Client flags and modes.
145 * Note that flags at least FLAG_LOCAL_UMODES but less than
146 * FLAG_GLOBAL_UMODES are treated as local modes, and flags at least
147 * FLAG_GLOBAL_UMODES (but less than FLAG_LAST_FLAG) are treated as
152 FLAG_PINGSENT, /**< Unreplied ping sent */
153 FLAG_DEADSOCKET, /**< Local socket is dead--Exiting soon */
154 FLAG_KILLED, /**< Prevents "QUIT" from being sent for this */
155 FLAG_BLOCKED, /**< socket is in a blocked condition */
156 FLAG_CLOSING, /**< set when closing to suppress errors */
157 FLAG_UPING, /**< has active UDP ping request */
158 FLAG_HUB, /**< server is a hub */
159 FLAG_IPV6, /**< server understands P10 IPv6 addrs */
160 FLAG_SERVICE, /**< server is a service */
161 FLAG_MASTER, /**< server is a master */
162 FLAG_GOTID, /**< successful ident lookup achieved */
163 FLAG_DOID, /**< I-lines say must use ident return */
164 FLAG_NONL, /**< No \n in buffer */
165 FLAG_TS8, /**< Why do you want to know? */
166 FLAG_MAP, /**< Show server on the map */
167 FLAG_JUNCTION, /**< Junction causing the net.burst. */
168 FLAG_BURST, /**< Server is receiving a net.burst */
169 FLAG_BURST_ACK, /**< Server is waiting for eob ack */
170 FLAG_IPCHECK, /**< Added or updated IPregistry data */
171 FLAG_LOCOP, /**< Local operator -- SRB */
172 FLAG_SERVNOTICE, /**< server notices such as kill */
173 FLAG_OPER, /**< Operator */
174 FLAG_INVISIBLE, /**< makes user invisible */
175 FLAG_WALLOP, /**< send wallops to them */
176 FLAG_DEAF, /**< Makes user deaf */
177 FLAG_CHSERV, /**< Disallow KICK or MODE -o on the user;
178 don't display channels in /whois */
179 FLAG_DEBUG, /**< send global debug/anti-hack info */
180 FLAG_ACCOUNT, /**< account name has been set */
181 FLAG_HIDDENHOST, /**< user's host is hidden */
182 FLAG_FAKEHOST, /**< user has a fakehost */
183 FLAG_FAKEIDENT, /**< user has a fakeident */
184 FLAG_NOCHAN, /**< hide user's channels for non-opers */
185 FLAG_NOIDLE, /**< hide user's idle time for non-opers */
186 FLAG_XTRAOP, /**< allow overriding +k */
187 FLAG_NETSERV, /**< mark as service; no special rights */
188 FLAG_HIDDENOPER, /**< mark as hidden oper */
189 FLAG_OVERRIDECC, /**< can override chanmodes +cCN */
190 FLAG_SSL, /**< SSL user */
191 FLAG_WEBIRC, /**< Is a WebIRC client with spoofed host/ip */
192 FLAG_SEE_IDLETIME, /**< Can see idletime of +I users. */
193 FLAG_SECURITY_SERV, /**< Securityflag, that can only be set by IAuth */
194 FLAG_LAST_FLAG, /**< number of flags */
195 FLAG_LOCAL_UMODES = FLAG_LOCOP, /**< First local mode flag */
196 FLAG_GLOBAL_UMODES = FLAG_OPER /**< First global mode flag */
199 /** Declare flagset type for operator privileges. */
200 DECLARE_FLAGSET(Privs, PRIV_LAST_PRIV);
201 /** Declare flagset type for user flags. */
202 DECLARE_FLAGSET(Flags, FLAG_LAST_FLAG);
204 #include "capab.h" /* client capabilities */
206 /** Represents a local connection.
207 * This contains a lot of stuff irrelevant to server connections, but
208 * those are so rare as to not be worth special-casing.
212 unsigned long con_magic; /**< magic number */
213 struct Connection* con_next; /**< Next connection with queued data */
214 struct Connection** con_prev_p; /**< What points to us */
215 struct Client* con_client; /**< Client associated with connection */
216 unsigned int con_count; /**< Amount of data in buffer */
217 int con_freeflag; /**< indicates if connection can be freed */
218 int con_error; /**< last socket level error for client */
219 int con_sentalong; /**< sentalong marker for connection */
220 unsigned int con_snomask; /**< mask for server messages */
221 time_t con_nextnick; /**< Next time a nick change is allowed */
222 time_t con_nexttarget;/**< Next time a target change is allowed */
223 time_t con_lasttime; /**< Last time data read from socket */
224 time_t con_since; /**< Last time we accepted a command */
225 struct MsgQ con_sendQ; /**< Outgoing message queue */
226 struct DBuf con_recvQ; /**< Incoming data yet to be parsed */
227 unsigned int con_sendM; /**< Stats: protocol messages sent */
228 unsigned int con_receiveM; /**< Stats: protocol messages received */
229 uint64_t con_sendB; /**< Bytes sent. */
230 uint64_t con_receiveB; /**< Bytes received. */
231 struct Listener* con_listener; /**< Listening socket which we accepted
233 struct SLink* con_confs; /**< Associated configuration records. */
234 HandlerType con_handler; /**< Message index into command table
236 struct ListingArgs* con_listing; /**< Current LIST status. */
237 unsigned int con_max_sendq; /**< cached max send queue for client */
238 unsigned int con_ping_freq; /**< cached ping freq */
239 unsigned short con_lastsq; /**< # 2k blocks when sendqueued
241 unsigned char con_targets[MAXTARGETS]; /**< Hash values of
243 char con_sock_ip[SOCKIPLEN + 1]; /**< Remote IP address as a string. */
244 char con_real_sock_ip[SOCKIPLEN + 1]; /**< Unspoofed ip address as a string. */
245 char con_sockhost[HOSTLEN + 1]; /**< This is the host name from
246 the socket and after which the
247 connection was accepted. */
248 char con_real_sockhost[HOSTLEN + 1]; /**< Unspoofed host name from the socket. */
249 char con_passwd[PASSWDLEN + 1]; /**< Password given by user. */
250 char con_buffer[BUFSIZE]; /**< Incoming message buffer; or
251 the error that caused this
252 clients socket to close. */
253 struct Socket con_socket; /**< socket descriptor for
255 struct Timer con_proc; /**< process latent messages from
257 struct Privs con_privs; /**< Oper privileges */
258 struct CapSet con_capab; /**< Client capabilities (from us) */
259 struct CapSet con_active; /**< Active capabilities (to us) */
260 struct AuthRequest* con_auth; /**< Auth request for client */
263 /** Magic constant to identify valid Connection structures. */
264 #define CONNECTION_MAGIC 0x12f955f3
266 /** Represents a client anywhere on the network. */
268 unsigned long cli_magic; /**< magic number */
269 struct Client* cli_next; /**< link in GlobalClientList */
270 struct Client* cli_prev; /**< link in GlobalClientList */
271 struct Client* cli_hnext; /**< link in hash table bucket or this */
272 struct Connection* cli_connect; /**< Connection structure associated with us */
273 struct User* cli_user; /**< Defined if this client is a user */
274 struct Server* cli_serv; /**< Defined if this client is a server */
275 struct Whowas* cli_whowas; /**< Pointer to ww struct to be freed on quit */
276 char cli_webirc[NICKLEN + 1]; /**< Contains the name of the WebIRC block */
277 char cli_yxx[4]; /**< Numeric Nick: YY if this is a
278 server, XXX if this is a user */
279 unsigned int maxchans;
280 char cli_connclass[NICKLEN + 1];
281 time_t cli_firsttime; /**< time client was created */
282 time_t cli_lastnick; /**< TimeStamp on nick */
283 int cli_marker; /**< /who processing marker */
284 struct Flags cli_flags; /**< client flags */
285 unsigned int cli_hopcount; /**< number of servers to this 0 = local */
286 struct irc_in_addr cli_ip; /**< Real IP of client */
287 struct irc_in_addr cli_real_ip; /**< Unspoofed ip of the client. */
288 short cli_status; /**< Client type */
289 char cli_name[HOSTLEN + 1]; /**< Unique name of the client, nick or host */
290 char cli_username[USERLEN + 1]; /**< Username determined by ident lookup */
291 char cli_info[REALLEN + 1]; /**< Free form additional client information */
294 /** Magic constant to identify valid Client structures. */
295 #define CLIENT_MAGIC 0x4ca08286
297 /** Verify that a client is valid. */
298 #define cli_verify(cli) ((cli)->cli_magic == CLIENT_MAGIC)
299 /** Get client's magic number. */
300 #define cli_magic(cli) ((cli)->cli_magic)
301 /** Get global next client. */
302 #define cli_next(cli) ((cli)->cli_next)
303 /** Get global previous client. */
304 #define cli_prev(cli) ((cli)->cli_prev)
305 /** Get next client in hash bucket chain. */
306 #define cli_hnext(cli) ((cli)->cli_hnext)
307 /** Get connection associated with client. */
308 #define cli_connect(cli) ((cli)->cli_connect)
309 /** Get local client that links us to \a cli. */
310 #define cli_from(cli) con_client(cli_connect(cli))
311 /** Get User structure for client, if client is a user. */
312 #define cli_user(cli) ((cli)->cli_user)
313 /** Get Server structure for client, if client is a server. */
314 #define cli_serv(cli) ((cli)->cli_serv)
315 /** Get Whowas link for client. */
316 #define cli_whowas(cli) ((cli)->cli_whowas)
317 /** Get WebIRC block name for client. */
318 #define cli_webirc(cli) ((cli)->cli_webirc)
319 /** Get ConnectionClass. */
320 #define cli_connclass(cli) ((cli)->cli_connclass)
321 /** Get client numnick. */
322 #define cli_yxx(cli) ((cli)->cli_yxx)
323 /** Get time we last read data from the client socket. */
324 #define cli_lasttime(cli) con_lasttime(cli_connect(cli))
325 /** Get time we last parsed something from the client. */
326 #define cli_since(cli) con_since(cli_connect(cli))
327 /** Get time client was created. */
328 #define cli_firsttime(cli) ((cli)->cli_firsttime)
329 /** Get time client last changed nickname. */
330 #define cli_lastnick(cli) ((cli)->cli_lastnick)
331 /** Get WHO marker for client. */
332 #define cli_marker(cli) ((cli)->cli_marker)
333 /** Get flags flagset for client. */
334 #define cli_flags(cli) ((cli)->cli_flags)
335 /** Get hop count to client. */
336 #define cli_hopcount(cli) ((cli)->cli_hopcount)
337 /** Get client IP address. */
338 #define cli_ip(cli) ((cli)->cli_ip)
339 /** Get unspoofed client IP address. */
340 #define cli_real_ip(cli) ((cli)->cli_real_ip)
341 /** Get status bitmask for client. */
342 #define cli_status(cli) ((cli)->cli_status)
343 /** Return non-zero if the client is local. */
344 #define cli_local(cli) (cli_from(cli) == cli)
345 /** Get oper privileges for client. */
346 #define cli_privs(cli) con_privs(cli_connect(cli))
347 /** Get client capabilities for client */
348 #define cli_capab(cli) con_capab(cli_connect(cli))
349 /** Get active client capabilities for client */
350 #define cli_active(cli) con_active(cli_connect(cli))
351 /** Get client name. */
352 #define cli_name(cli) ((cli)->cli_name)
353 /** Get client username (ident). */
354 #define cli_username(cli) ((cli)->cli_username)
355 /** Get client realname (information field). */
356 #define cli_info(cli) ((cli)->cli_info)
358 /** Get number of incoming bytes queued for client. */
359 #define cli_count(cli) con_count(cli_connect(cli))
360 /** Get file descriptor for sending in client's direction. */
361 #define cli_fd(cli) con_fd(cli_connect(cli))
362 /** Get free flags for the client's connection. */
363 #define cli_freeflag(cli) con_freeflag(cli_connect(cli))
364 /** Get last error code for the client's connection. */
365 #define cli_error(cli) con_error(cli_connect(cli))
366 /** Get server notice mask for the client. */
367 #define cli_snomask(cli) con_snomask(cli_connect(cli))
368 /** Get next time a nick change is allowed for the client. */
369 #define cli_nextnick(cli) con_nextnick(cli_connect(cli))
370 /** Get next time a target change is allowed for the client. */
371 #define cli_nexttarget(cli) con_nexttarget(cli_connect(cli))
372 /** Get SendQ for client. */
373 #define cli_sendQ(cli) con_sendQ(cli_connect(cli))
374 /** Get RecvQ for client. */
375 #define cli_recvQ(cli) con_recvQ(cli_connect(cli))
376 /** Get count of messages sent to client. */
377 #define cli_sendM(cli) con_sendM(cli_connect(cli))
378 /** Get number of messages received from client. */
379 #define cli_receiveM(cli) con_receiveM(cli_connect(cli))
380 /** Get number of bytes (modulo 1024) sent to client. */
381 #define cli_sendB(cli) con_sendB(cli_connect(cli))
382 /** Get number of bytes (modulo 1024) received from client. */
383 #define cli_receiveB(cli) con_receiveB(cli_connect(cli))
384 /** Get listener that accepted the client's connection. */
385 #define cli_listener(cli) con_listener(cli_connect(cli))
386 /** Get list of attached conf lines. */
387 #define cli_confs(cli) con_confs(cli_connect(cli))
388 /** Get handler type for client. */
389 #define cli_handler(cli) con_handler(cli_connect(cli))
390 /** Get LIST status for client. */
391 #define cli_listing(cli) con_listing(cli_connect(cli))
392 /** Get cached max SendQ for client. */
393 #define cli_max_sendq(cli) con_max_sendq(cli_connect(cli))
394 /** Get ping frequency for client. */
395 #define cli_ping_freq(cli) con_ping_freq(cli_connect(cli))
396 /** Get lastsq for client's connection. */
397 #define cli_lastsq(cli) con_lastsq(cli_connect(cli))
398 /** Get the array of current targets for the client. */
399 #define cli_targets(cli) con_targets(cli_connect(cli))
400 /** Get the string form of the client's IP address. */
401 #define cli_sock_ip(cli) con_sock_ip(cli_connect(cli))
402 /** Get the unspoofed string form of the client's IP address. */
403 #define cli_real_sock_ip(cli) con_real_sock_ip(cli_connect(cli))
404 /** Get the resolved hostname for the client. */
405 #define cli_sockhost(cli) con_sockhost(cli_connect(cli))
406 /** Get the unspoofed resolved hostname for the client. */
407 #define cli_real_sockhost(cli) con_real_sockhost(cli_connect(cli))
408 /** Get the client's password. */
409 #define cli_passwd(cli) con_passwd(cli_connect(cli))
410 /** Get the unprocessed input buffer for a client's connection. */
411 #define cli_buffer(cli) con_buffer(cli_connect(cli))
412 /** Get the Socket structure for sending to a client. */
413 #define cli_socket(cli) con_socket(cli_connect(cli))
414 /** Get Timer for processing waiting messages from the client. */
415 #define cli_proc(cli) con_proc(cli_connect(cli))
416 /** Get auth request for client. */
417 #define cli_auth(cli) con_auth(cli_connect(cli))
418 /** Get sentalong marker for client. */
419 #define cli_sentalong(cli) con_sentalong(cli_connect(cli))
421 /** Verify that a connection is valid. */
422 #define con_verify(con) ((con)->con_magic == CONNECTION_MAGIC)
423 /** Get connection's magic number. */
424 #define con_magic(con) ((con)->con_magic)
425 /** Get global next connection. */
426 #define con_next(con) ((con)->con_next)
427 /** Get global previous connection. */
428 #define con_prev_p(con) ((con)->con_prev_p)
429 /** Get locally connected client for connection. */
430 #define con_client(con) ((con)->con_client)
431 /** Get number of unprocessed data bytes from connection. */
432 #define con_count(con) ((con)->con_count)
433 /** Get file descriptor for connection. */
434 #define con_fd(con) s_fd(&(con)->con_socket)
435 /** Get freeable flags for connection. */
436 #define con_freeflag(con) ((con)->con_freeflag)
437 /** Get last error code on connection. */
438 #define con_error(con) ((con)->con_error)
439 /** Get sentalong marker for connection. */
440 #define con_sentalong(con) ((con)->con_sentalong)
441 /** Get server notice mask for connection. */
442 #define con_snomask(con) ((con)->con_snomask)
443 /** Get next nick change time for connection. */
444 #define con_nextnick(con) ((con)->con_nextnick)
445 /** Get next new target time for connection. */
446 #define con_nexttarget(con) ((con)->con_nexttarget)
447 /** Get last time we read from the connection. */
448 #define con_lasttime(con) ((con)->con_lasttime)
449 /** Get last time we accepted a command from the connection. */
450 #define con_since(con) ((con)->con_since)
451 /** Get SendQ for connection. */
452 #define con_sendQ(con) ((con)->con_sendQ)
453 /** Get RecvQ for connection. */
454 #define con_recvQ(con) ((con)->con_recvQ)
455 /** Get number of messages sent to connection. */
456 #define con_sendM(con) ((con)->con_sendM)
457 /** Get number of messages received from connection. */
458 #define con_receiveM(con) ((con)->con_receiveM)
459 /** Get number of bytes (modulo 1024) sent to connection. */
460 #define con_sendB(con) ((con)->con_sendB)
461 /** Get number of bytes (modulo 1024) received from connection. */
462 #define con_receiveB(con) ((con)->con_receiveB)
463 /** Get listener that accepted the connection. */
464 #define con_listener(con) ((con)->con_listener)
465 /** Get list of ConfItems attached to the connection. */
466 #define con_confs(con) ((con)->con_confs)
467 /** Get command handler for the connection. */
468 #define con_handler(con) ((con)->con_handler)
469 /** Get the LIST status for the connection. */
470 #define con_listing(con) ((con)->con_listing)
471 /** Get the maximum permitted SendQ size for the connection. */
472 #define con_max_sendq(con) ((con)->con_max_sendq)
473 /** Get the ping frequency for the connection. */
474 #define con_ping_freq(con) ((con)->con_ping_freq)
475 /** Get the lastsq for the connection. */
476 #define con_lastsq(con) ((con)->con_lastsq)
477 /** Get the current targets array for the connection. */
478 #define con_targets(con) ((con)->con_targets)
479 /** Get the string-formatted IP address for the connection. */
480 #define con_sock_ip(con) ((con)->con_sock_ip)
481 /** Get the unspoofed string-formatted IP address for the connection. */
482 #define con_real_sock_ip(con) ((con)->con_real_sock_ip)
483 /** Get the resolved hostname for the connection. */
484 #define con_sockhost(con) ((con)->con_sockhost)
485 /** Get the unspoofed resolved hostname for the connection. */
486 #define con_real_sockhost(con) ((con)->con_real_sockhost)
487 /** Get the password sent by the remote end of the connection. */
488 #define con_passwd(con) ((con)->con_passwd)
489 /** Get the buffer of unprocessed incoming data from the connection. */
490 #define con_buffer(con) ((con)->con_buffer)
491 /** Get the Socket for the connection. */
492 #define con_socket(con) ((con)->con_socket)
493 /** Get the Timer for processing more data from the connection. */
494 #define con_proc(con) ((con)->con_proc)
495 /** Get the oper privilege set for the connection. */
496 #define con_privs(con) (&(con)->con_privs)
497 /** Get the peer's capabilities for the connection. */
498 #define con_capab(con) (&(con)->con_capab)
499 /** Get the active capabilities for the connection. */
500 #define con_active(con) (&(con)->con_active)
501 /** Get the auth request for the connection. */
502 #define con_auth(con) ((con)->con_auth)
504 #define STAT_CONNECTING 0x001 /**< connecting to another server */
505 #define STAT_HANDSHAKE 0x002 /**< pass - server sent */
506 #define STAT_ME 0x004 /**< this server */
507 #define STAT_UNKNOWN 0x008 /**< unidentified connection */
508 #define STAT_UNKNOWN_USER 0x010 /**< connection on a client port */
509 #define STAT_UNKNOWN_SERVER 0x020 /**< connection on a server port */
510 #define STAT_SERVER 0x040 /**< fully registered server */
511 #define STAT_USER 0x080 /**< fully registered user */
516 /** Return non-zero if the client is registered. */
517 #define IsRegistered(x) (cli_status(x) & (STAT_SERVER | STAT_USER))
518 /** Return non-zero if the client is an outbound connection that is
519 * still connecting. */
520 #define IsConnecting(x) (cli_status(x) == STAT_CONNECTING)
521 /** Return non-zero if the client is an outbound connection that has
522 * sent our password. */
523 #define IsHandshake(x) (cli_status(x) == STAT_HANDSHAKE)
524 /** Return non-zero if the client is this server. */
525 #define IsMe(x) (cli_status(x) == STAT_ME)
526 /** Return non-zero if the client has not yet registered. */
527 #define IsUnknown(x) (cli_status(x) & \
528 (STAT_UNKNOWN | STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER))
529 /** Return non-zero if the client is an unregistered connection on a
531 #define IsServerPort(x) (cli_status(x) == STAT_UNKNOWN_SERVER )
532 /** Return non-zero if the client is an unregistered connection on a
534 #define IsUserPort(x) (cli_status(x) == STAT_UNKNOWN_USER )
535 /** Return non-zero if the client is a real client connection. */
536 #define IsClient(x) (cli_status(x) & \
537 (STAT_HANDSHAKE | STAT_ME | STAT_UNKNOWN |\
538 STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER | STAT_SERVER | STAT_USER))
539 /** Return non-zero if the client ignores flood limits. */
540 #define IsTrusted(x) (cli_status(x) & \
541 (STAT_CONNECTING | STAT_HANDSHAKE | STAT_ME | STAT_SERVER))
542 /** Return non-zero if the client is a registered server. */
543 #define IsServer(x) (cli_status(x) == STAT_SERVER)
544 /** Return non-zero if the client is a registered user. */
545 #define IsUser(x) (cli_status(x) == STAT_USER)
548 /** Mark a client with STAT_CONNECTING. */
549 #define SetConnecting(x) (cli_status(x) = STAT_CONNECTING)
550 /** Mark a client with STAT_HANDSHAKE. */
551 #define SetHandshake(x) (cli_status(x) = STAT_HANDSHAKE)
552 /** Mark a client with STAT_SERVER. */
553 #define SetServer(x) (cli_status(x) = STAT_SERVER)
554 /** Mark a client with STAT_ME. */
555 #define SetMe(x) (cli_status(x) = STAT_ME)
556 /** Mark a client with STAT_USER. */
557 #define SetUser(x) (cli_status(x) = STAT_USER)
559 /** Return non-zero if a client is directly connected to me. */
560 #define MyConnect(x) (cli_from(x) == (x))
561 /** Return non-zero if a client is a locally connected user. */
562 #define MyUser(x) (MyConnect(x) && IsUser(x))
563 /** Return non-zero if a client is a locally connected IRC operator. */
564 #define MyOper(x) (MyConnect(x) && IsOper(x))
565 /** Return protocol version used by a server. */
566 #define Protocol(x) ((cli_serv(x))->prot)
571 /** Set a flag in a client's flags. */
572 #define SetFlag(cli, flag) FlagSet(&cli_flags(cli), flag)
573 /** Clear a flag from a client's flags. */
574 #define ClrFlag(cli, flag) FlagClr(&cli_flags(cli), flag)
575 /** Return non-zero if a flag is set in a client's flags. */
576 #define HasFlag(cli, flag) FlagHas(&cli_flags(cli), flag)
578 /** Return non-zero if the client is an IRC operator (global or local). */
579 #define IsAnOper(x) (IsOper(x) || IsLocOp(x))
580 /** Return non-zero if the client's connection is blocked. */
581 #define IsBlocked(x) HasFlag(x, FLAG_BLOCKED)
582 /** Return non-zero if the client's connection is still being burst. */
583 #define IsBurst(x) HasFlag(x, FLAG_BURST)
584 /** Return non-zero if we have received the peer's entire burst but
585 * not their EOB ack. */
586 #define IsBurstAck(x) HasFlag(x, FLAG_BURST_ACK)
587 /** Return non-zero if we are still bursting to the client. */
588 #define IsBurstOrBurstAck(x) (HasFlag(x, FLAG_BURST) || HasFlag(x, FLAG_BURST_ACK))
589 /** Return non-zero if the client has set mode +k (channel service). */
590 #define IsChannelService(x) HasFlag(x, FLAG_CHSERV)
591 /** Return non-zero if the client's socket is disconnected. */
592 #define IsDead(x) HasFlag(x, FLAG_DEADSOCKET)
593 /** Return non-zero if the client has set mode +d (deaf). */
594 #define IsDeaf(x) HasFlag(x, FLAG_DEAF)
595 /** Return non-zero if the client has been IP-checked for clones. */
596 #define IsIPChecked(x) HasFlag(x, FLAG_IPCHECK)
597 /** Return non-zero if we have received an ident response for the client. */
598 #define IsIdented(x) HasFlag(x, FLAG_GOTID)
599 /** Return non-zero if the client has set mode +i (invisible). */
600 #define IsInvisible(x) HasFlag(x, FLAG_INVISIBLE)
601 /** Return non-zero if the client caused a net.burst. */
602 #define IsJunction(x) HasFlag(x, FLAG_JUNCTION)
603 /** Return non-zero if the client has set mode +O (local operator) locally. */
604 #define IsLocOp(x) (MyConnect(x) && HasFlag(x, FLAG_LOCOP))
605 /** Return non-zero if the client has set mode +o (global operator). */
606 #define IsOper(x) HasFlag(x, FLAG_OPER)
607 /** Return non-zero if the client has an active UDP ping request. */
608 #define IsUPing(x) HasFlag(x, FLAG_UPING)
609 /** Return non-zero if the client has no '\n' in its buffer. */
610 #define NoNewLine(x) HasFlag(x, FLAG_NONL)
611 /** Return non-zero if the client has set mode +g (debugging). */
612 #define SendDebug(x) HasFlag(x, FLAG_DEBUG)
613 /** Return non-zero if the client has set mode +s (server notices). */
614 #define SendServNotice(x) HasFlag(x, FLAG_SERVNOTICE)
615 /** Return non-zero if the client has set mode +w (wallops). */
616 #define SendWallops(x) HasFlag(x, FLAG_WALLOP)
617 /** Return non-zero if the client claims to be a hub. */
618 #define IsHub(x) HasFlag(x, FLAG_HUB)
619 /** Return non-zero if the client understands IPv6 addresses in P10. */
620 #define IsIPv6(x) HasFlag(x, FLAG_IPV6)
621 /** Return non-zero if the client claims to be a services server. */
622 #define IsService(x) HasFlag(x, FLAG_SERVICE)
623 /** Return non-zero if the client claims to be a master server. */
624 #define IsMaster(x) HasFlag(x, FLAG_MASTER)
625 /** Return non-zero if the client has an account stamp. */
626 #define IsAccount(x) HasFlag(x, FLAG_ACCOUNT)
627 /** Return non-zero if the client has set mode +x (hidden host). */
628 #define IsHiddenHost(x) HasFlag(x, FLAG_HIDDENHOST)
629 /** Return non-zero if the client has an active PING request. */
630 #define IsPingSent(x) HasFlag(x, FLAG_PINGSENT)
631 /** Return non-zero if the client's channels are hidden. */
632 #define IsNoChan(x) HasFlag(x, FLAG_NOCHAN)
633 /** Return non-zero if the client's idle time is hidden. */
634 #define IsNoIdle(x) HasFlag(x, FLAG_NOIDLE)
635 /** Return non-zero if the client is an extra op. */
636 #define IsXtraOp(x) HasFlag(x, FLAG_XTRAOP)
637 /** Return non-zero if the client is a network service. */
638 #define IsNetServ(x) HasFlag(x, FLAG_NETSERV)
639 /** Return non-zero if the client is an hidden oper. */
640 #define IsHiddenOper(x) HasFlag(x, FLAG_HIDDENOPER)
641 /** Return non-zero if the client has set umode +c. */
642 #define IsOverrideCC(x) HasFlag(x, FLAG_OVERRIDECC)
643 /** Return non-zero if the client is connected via SSL. */
644 #define IsSSL(x) HasFlag(x, FLAG_SSL)
645 /** Return non-zero if the client is an WebIRC user with spoofed host/ip. */
646 #define IsWebIRC(x) HasFlag(x, FLAG_WEBIRC)
647 /** Return non-zero if the client can see idletime of +I users. */
648 #define IsSeeIdletime(x) HasFlag(x, FLAG_SEE_IDLETIME)
649 #define IsSecurityServ(x) HasFlag(x, FLAG_SECURITY_SERV)
650 /** Return non-zero if the client has a fakehost. */
651 #define IsFakeHost(x) HasFlag(x, FLAG_FAKEHOST)
652 #define IsFakeIdent(x) HasFlag(x, FLAG_FAKEIDENT)
654 /** Return non-zero if the client has operator or server privileges. */
655 #define IsPrivileged(x) (IsAnOper(x) || IsServer(x))
656 /** Return non-zero if the client's host is hidden. */
657 #define HasHiddenHost(x) (IsHiddenHost(x) && (IsAccount(x) || IsFakeHost(x)))
659 /** Mark a client as having an in-progress net.burst. */
660 #define SetBurst(x) SetFlag(x, FLAG_BURST)
661 /** Mark a client as being between EOB and EOB ACK. */
662 #define SetBurstAck(x) SetFlag(x, FLAG_BURST_ACK)
663 /** Mark a client as having mode +k (channel service). */
664 #define SetChannelService(x) SetFlag(x, FLAG_CHSERV)
665 /** Mark a client as having mode +d (deaf). */
666 #define SetDeaf(x) SetFlag(x, FLAG_DEAF)
667 /** Mark a client as having mode +g (debugging). */
668 #define SetDebug(x) SetFlag(x, FLAG_DEBUG)
669 /** Mark a client as having ident looked up. */
670 #define SetGotId(x) SetFlag(x, FLAG_GOTID)
671 /** Mark a client as being IP-checked. */
672 #define SetIPChecked(x) SetFlag(x, FLAG_IPCHECK)
673 /** Mark a client as having mode +i (invisible). */
674 #define SetInvisible(x) SetFlag(x, FLAG_INVISIBLE)
675 /** Mark a client as causing a net.join. */
676 #define SetJunction(x) SetFlag(x, FLAG_JUNCTION)
677 /** Mark a client as having mode +O (local operator). */
678 #define SetLocOp(x) SetFlag(x, FLAG_LOCOP)
679 /** Mark a client as having mode +o (global operator). */
680 #define SetOper(x) SetFlag(x, FLAG_OPER)
681 /** Mark a client as having a pending UDP ping. */
682 #define SetUPing(x) SetFlag(x, FLAG_UPING)
683 /** Mark a client as having mode +w (wallops). */
684 #define SetWallops(x) SetFlag(x, FLAG_WALLOP)
685 /** Mark a client as having mode +s (server notices). */
686 #define SetServNotice(x) SetFlag(x, FLAG_SERVNOTICE)
687 /** Mark a client as being a hub server. */
688 #define SetHub(x) SetFlag(x, FLAG_HUB)
689 /** Mark a client as being an IPv6-grokking server. */
690 #define SetIPv6(x) SetFlag(x, FLAG_IPV6)
691 /** Mark a client as being a services server. */
692 #define SetService(x) SetFlag(x, FLAG_SERVICE)
693 /** Mark a client as being a master server. */
694 #define SetMaster(x) SetFlag(x, FLAG_MASTER)
695 /** Mark a client as having an account stamp. */
696 #define SetAccount(x) SetFlag(x, FLAG_ACCOUNT)
697 /** Mark a client as having mode +x (hidden host). */
698 #define SetHiddenHost(x) SetFlag(x, FLAG_HIDDENHOST)
699 /** Mark a client as having a fakehost. */
700 #define SetFakeHost(x) SetFlag(x, FLAG_FAKEHOST)
701 #define SetFakeIdent(x) SetFlag(x, FLAG_FAKEIDENT)
702 /** Mark a client as having a pending PING. */
703 #define SetPingSent(x) SetFlag(x, FLAG_PINGSENT)
704 /** Mark a client as having mode +n. */
705 #define SetNoChan(x) SetFlag(x, FLAG_NOCHAN)
706 /** Mark a client as having mode +I. */
707 #define SetNoIdle(x) SetFlag(x, FLAG_NOIDLE)
708 /** Mark a client as having mode +X. */
709 #define SetXtraOp(x) SetFlag(x, FLAG_XTRAOP)
710 /** Mark a client as having mode +S. */
711 #define SetNetServ(x) SetFlag(x, FLAG_NETSERV)
712 /** Mark a client as having mode +H. */
713 #define SetHiddenOper(x) SetFlag(x, FLAG_HIDDENOPER)
714 /** Mark a client as having umode +c. */
715 #define SetOverrideCC(x) SetFlag(x, FLAG_OVERRIDECC)
716 /** Mark a client as being connected via SSL. */
717 #define SetSSL(x) SetFlag(x, FLAG_SSL)
718 /** Mark a client as being an WebIRC user with spoofed host/ip. */
719 #define SetWebIRC(x) SetFlag(x, FLAG_WEBIRC)
720 /** Mark a client as being able to see idletime of +I users. */
721 #define SetSeeIdletime(x) SetFlag(x, FLAG_SEE_IDLETIME)
722 #define SetSecurityServ(x) SetFlag(x, FLAG_SECURITY_SERV)
724 /** Return non-zero if \a sptr sees \a acptr as an operator. */
725 #define SeeOper(sptr,acptr) ((IsAnOper(acptr) && \
726 (sptr == acptr || HasPriv(acptr, PRIV_DISPLAY) || HasPriv(sptr, PRIV_SEE_OPERS)) && \
727 (!IsHiddenOper(acptr) || IsAnOper(sptr))))
729 /** Clear the client's net.burst in-progress flag. */
730 #define ClearBurst(x) ClrFlag(x, FLAG_BURST)
731 /** Clear the client's between EOB and EOB ACK flag. */
732 #define ClearBurstAck(x) ClrFlag(x, FLAG_BURST_ACK)
733 /** Remove mode +k (channel service) from the client. */
734 #define ClearChannelService(x) ClrFlag(x, FLAG_CHSERV)
735 /** Remove mode +d (deaf) from the client. */
736 #define ClearDeaf(x) ClrFlag(x, FLAG_DEAF)
737 /** Remove mode +g (debugging) from the client. */
738 #define ClearDebug(x) ClrFlag(x, FLAG_DEBUG)
739 /** Remove the client's IP-checked flag. */
740 #define ClearIPChecked(x) ClrFlag(x, FLAG_IPCHECK)
741 /** Remove mode +i (invisible) from the client. */
742 #define ClearInvisible(x) ClrFlag(x, FLAG_INVISIBLE)
743 /** Remove mode +O (local operator) from the client. */
744 #define ClearLocOp(x) ClrFlag(x, FLAG_LOCOP)
745 /** Remove mode +o (global operator) from the client. */
746 #define ClearOper(x) ClrFlag(x, FLAG_OPER)
747 /** Clear the client's pending UDP ping flag. */
748 #define ClearUPing(x) ClrFlag(x, FLAG_UPING)
749 /** Remove mode +w (wallops) from the client. */
750 #define ClearWallops(x) ClrFlag(x, FLAG_WALLOP)
751 /** Remove mode +s (server notices) from the client. */
752 #define ClearServNotice(x) ClrFlag(x, FLAG_SERVNOTICE)
753 /** Remove mode +x (hidden host) from the client. */
754 #define ClearHiddenHost(x) ClrFlag(x, FLAG_HIDDENHOST)
755 /** Remove fakehost flag from the flient. */
756 #define ClearFakeHost(x) ClrFlag(x, FLAG_FAKEHOST)
757 #define ClearFakeIdent(x) ClrFlag(x, FLAG_FAKEIDENT)
758 /** Clear the client's pending PING flag. */
759 #define ClearPingSent(x) ClrFlag(x, FLAG_PINGSENT)
760 /** Clear the client's HUB flag. */
761 #define ClearHub(x) ClrFlag(x, FLAG_HUB)
762 /** Remove mode +n from the client. */
763 #define ClearNoChan(x) ClrFlag(x, FLAG_NOCHAN)
764 /** Remove mode +I from the client. */
765 #define ClearNoIdle(x) ClrFlag(x, FLAG_NOIDLE)
766 /** Remove mode +X from the client. */
767 #define ClearXtraOp(x) ClrFlag(x, FLAG_XTRAOP)
768 /** Remove mode +S from the client. */
769 #define ClearNetServ(x) ClrFlag(x, FLAG_NETSERV)
770 /** Remove mode +H from the client. */
771 #define ClearHiddenOper(x) ClrFlag(x, FLAG_HIDDENOPER)
772 /** Remove mode +c from the client. */
773 #define ClearOverrideCC(x) ClrFlag(x, FLAG_OVERRIDECC)
774 /** Remove ssl mode from the client. */
775 #define ClearSSL(x) ClrFlag(x, FLAG_SSL)
776 /** Remove mode +W (WebIRC user with spoofed host/ip) from the client. */
777 #define ClearWebIRC(x) ClrFlag(x, FLAG_WEBIRC)
778 /** Make client no longer being able to see idletime of +I users. */
779 #define ClearSeeIdletime(x) ClrFlag(x, FLAG_SEE_IDLETIME)
780 #define ClearSecurityServ(x) ClrFlag(x, FLAG_SECURITY_SERV)
783 #define FREEFLAG_SOCKET 0x0001 /**< socket needs to be freed */
784 #define FREEFLAG_TIMER 0x0002 /**< timer needs to be freed */
786 /* server notice stuff */
788 #define SNO_ADD 1 /**< Perform "or" on server notice mask. */
789 #define SNO_DEL 2 /**< Perform "and ~x" on server notice mask. */
790 #define SNO_SET 3 /**< Set server notice mask. */
791 /* DON'T CHANGE THESE VALUES ! */
792 /* THE CLIENTS DEPEND ON IT ! */
793 #define SNO_OLDSNO 0x1 /**< unsorted old messages */
794 #define SNO_SERVKILL 0x2 /**< server kills (nick collisions) */
795 #define SNO_OPERKILL 0x4 /**< oper kills */
796 #define SNO_HACK2 0x8 /**< desyncs */
797 #define SNO_HACK3 0x10 /**< temporary desyncs */
798 #define SNO_UNAUTH 0x20 /**< unauthorized connections */
799 #define SNO_TCPCOMMON 0x40 /**< common TCP or socket errors */
800 #define SNO_TOOMANY 0x80 /**< too many connections */
801 #define SNO_HACK4 0x100 /**< Uworld actions on channels */
802 #define SNO_GLINE 0x200 /**< glines */
803 #define SNO_NETWORK 0x400 /**< net join/break, etc */
804 #define SNO_IPMISMATCH 0x800 /**< IP mismatches */
805 #define SNO_THROTTLE 0x1000 /**< host throttle add/remove notices */
806 #define SNO_OLDREALOP 0x2000 /**< old oper-only messages */
807 #define SNO_CONNEXIT 0x4000 /**< client connect/exit (ugh) */
808 #define SNO_AUTO 0x8000 /**< AUTO G-Lines */
809 #define SNO_DEBUG 0x10000 /**< debugging messages (DEBUGMODE only) */
810 #define SNO_AUTH 0x20000 /**< IAuth notices */
812 /** Bitmask of all valid server notice bits. */
814 # define SNO_ALL 0x3ffff
816 # define SNO_ALL 0x2ffff
819 /** Server notice bits allowed to normal users. */
820 #define SNO_USER (SNO_ALL & ~SNO_OPER)
822 /** Server notice bits enabled by default for normal users. */
823 #define SNO_DEFAULT (SNO_NETWORK|SNO_OPERKILL|SNO_GLINE)
824 /** Server notice bits enabled by default for IRC operators. */
825 #define SNO_OPERDEFAULT (SNO_DEFAULT|SNO_HACK2|SNO_HACK4|SNO_THROTTLE|SNO_OLDSNO)
826 /** Server notice bits reserved to IRC operators. */
827 #define SNO_OPER (SNO_CONNEXIT|SNO_OLDREALOP|SNO_AUTH)
828 /** Noisy server notice bits that cause other bits to be cleared during connect. */
829 #define SNO_NOISY (SNO_SERVKILL|SNO_UNAUTH)
831 /** Test whether a privilege has been granted to a client. */
832 #define HasPriv(cli, priv) FlagHas(cli_privs(cli), priv)
833 /** Grant a privilege to a client. */
834 #define SetPriv(cli, priv) FlagSet(cli_privs(cli), priv)
835 /** Revoke a privilege from a client. */
836 #define ClrPriv(cli, priv) FlagClr(cli_privs(cli), priv)
838 /** Test whether a client has a capability */
839 #define HasCap(cli, cap) CapHas(cli_capab(cli), (cap))
840 /** Test whether a client has the capability active */
841 #define CapActive(cli, cap) CapHas(cli_active(cli), (cap))
843 /** Returns 1 if cptr can see the idletime of acptr. */
844 #define HasNoIdlePriv(cptr) (MyUser(cptr) && HasPriv(cptr, PRIV_HIDE_IDLETIME))
845 #define CanSeeIdletime(cptr, acptr) ( \
848 (!feature_bool(FEAT_HIS_WHOIS_IDLETIME) && ( \
849 (!IsNoIdle(acptr) || !IsAnOper(acptr)) && \
850 (!IsNoIdle(acptr) || (IsSeeIdletime(cptr) && (!HasNoIdlePriv(acptr) || HasNoIdlePriv(cptr)))) \
853 #define HIDE_IP 0 /**< Do not show IP address in get_client_name() */
854 #define SHOW_IP 1 /**< Show ident and IP address in get_client_name() */
856 extern const char* get_client_name(const struct Client* sptr, int showip);
857 extern const char* client_get_default_umode(const struct Client* sptr);
858 extern int client_get_ping(const struct Client* local_client);
859 extern void client_drop_sendq(struct Connection* con);
860 extern void client_add_sendq(struct Connection* con,
861 struct Connection** con_p);
862 extern void client_set_privs(struct Client *client, struct ConfItem *oper);
863 extern void client_set_uprivs(struct Client *client, struct ConfItem *aconf);
864 extern int client_report_privs(struct Client* to, struct Client* client);
866 #endif /* INCLUDED_client_h */