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.
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 "diOoswkgx"
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_LAST_PRIV /**< number of privileges */
132 /** Client flags and modes.
133 * Note that flags at least FLAG_LOCAL_UMODES but less than
134 * FLAG_GLOBAL_UMODES are treated as local modes, and flags at least
135 * FLAG_GLOBAL_UMODES (but less than FLAG_LAST_FLAG) are treated as
140 FLAG_PINGSENT, /**< Unreplied ping sent */
141 FLAG_DEADSOCKET, /**< Local socket is dead--Exiting soon */
142 FLAG_KILLED, /**< Prevents "QUIT" from being sent for this */
143 FLAG_BLOCKED, /**< socket is in a blocked condition */
144 FLAG_CLOSING, /**< set when closing to suppress errors */
145 FLAG_UPING, /**< has active UDP ping request */
146 FLAG_HUB, /**< server is a hub */
147 FLAG_IPV6, /**< server understands P10 IPv6 addrs */
148 FLAG_SERVICE, /**< server is a service */
149 FLAG_GOTID, /**< successful ident lookup achieved */
150 FLAG_DOID, /**< I-lines say must use ident return */
151 FLAG_NONL, /**< No \n in buffer */
152 FLAG_TS8, /**< Why do you want to know? */
153 FLAG_MAP, /**< Show server on the map */
154 FLAG_JUNCTION, /**< Junction causing the net.burst. */
155 FLAG_BURST, /**< Server is receiving a net.burst */
156 FLAG_BURST_ACK, /**< Server is waiting for eob ack */
157 FLAG_IPCHECK, /**< Added or updated IPregistry data */
158 FLAG_LOCOP, /**< Local operator -- SRB */
159 FLAG_SERVNOTICE, /**< server notices such as kill */
160 FLAG_OPER, /**< Operator */
161 FLAG_INVISIBLE, /**< makes user invisible */
162 FLAG_WALLOP, /**< send wallops to them */
163 FLAG_DEAF, /**< Makes user deaf */
164 FLAG_CHSERV, /**< Disallow KICK or MODE -o on the user;
165 don't display channels in /whois */
166 FLAG_DEBUG, /**< send global debug/anti-hack info */
167 FLAG_ACCOUNT, /**< account name has been set */
168 FLAG_HIDDENHOST, /**< user's host is hidden */
169 FLAG_LAST_FLAG, /**< number of flags */
170 FLAG_LOCAL_UMODES = FLAG_LOCOP, /**< First local mode flag */
171 FLAG_GLOBAL_UMODES = FLAG_OPER /**< First global mode flag */
174 /** Declare flagset type for operator privileges. */
175 DECLARE_FLAGSET(Privs, PRIV_LAST_PRIV);
176 /** Declare flagset type for user flags. */
177 DECLARE_FLAGSET(Flags, FLAG_LAST_FLAG);
179 #include "capab.h" /* client capabilities */
181 /** Represents a local connection.
182 * This contains a lot of stuff irrelevant to server connections, but
183 * those are so rare as to not be worth special-casing.
187 unsigned long con_magic; /**< magic number */
188 struct Connection* con_next; /**< Next connection with queued data */
189 struct Connection** con_prev_p; /**< What points to us */
190 struct Client* con_client; /**< Client associated with connection */
191 unsigned int con_count; /**< Amount of data in buffer */
192 int con_freeflag; /**< indicates if connection can be freed */
193 int con_error; /**< last socket level error for client */
194 int con_sentalong; /**< sentalong marker for connection */
195 unsigned int con_snomask; /**< mask for server messages */
196 time_t con_nextnick; /**< Next time a nick change is allowed */
197 time_t con_nexttarget;/**< Next time a target change is allowed */
198 time_t con_lasttime; /**< Last time data read from socket */
199 time_t con_since; /**< Last time we accepted a command */
200 struct MsgQ con_sendQ; /**< Outgoing message queue */
201 struct DBuf con_recvQ; /**< Incoming data yet to be parsed */
202 unsigned int con_sendM; /**< Stats: protocol messages sent */
203 unsigned int con_receiveM; /**< Stats: protocol messages received */
204 uint64_t con_sendB; /**< Bytes sent. */
205 uint64_t con_receiveB; /**< Bytes received. */
206 struct Listener* con_listener; /**< Listening socket which we accepted
208 struct SLink* con_confs; /**< Associated configuration records. */
209 HandlerType con_handler; /**< Message index into command table
211 struct ListingArgs* con_listing; /**< Current LIST status. */
212 unsigned int con_max_sendq; /**< cached max send queue for client */
213 unsigned int con_ping_freq; /**< cached ping freq */
214 unsigned short con_lastsq; /**< # 2k blocks when sendqueued
216 unsigned char con_targets[MAXTARGETS]; /**< Hash values of
218 char con_sock_ip[SOCKIPLEN + 1]; /**< Remote IP address as a string. */
219 char con_sockhost[HOSTLEN + 1]; /**< This is the host name from
220 the socket and after which the
221 connection was accepted. */
222 char con_passwd[PASSWDLEN + 1]; /**< Password given by user. */
223 char con_buffer[BUFSIZE]; /**< Incoming message buffer; or
224 the error that caused this
225 clients socket to close. */
226 struct Socket con_socket; /**< socket descriptor for
228 struct Timer con_proc; /**< process latent messages from
230 struct Privs con_privs; /**< Oper privileges */
231 struct CapSet con_capab; /**< Client capabilities (from us) */
232 struct CapSet con_active; /**< Active capabilities (to us) */
233 struct AuthRequest* con_auth; /**< Auth request for client */
236 /** Magic constant to identify valid Connection structures. */
237 #define CONNECTION_MAGIC 0x12f955f3
239 /** Represents a client anywhere on the network. */
241 unsigned long cli_magic; /**< magic number */
242 struct Client* cli_next; /**< link in GlobalClientList */
243 struct Client* cli_prev; /**< link in GlobalClientList */
244 struct Client* cli_hnext; /**< link in hash table bucket or this */
245 struct Connection* cli_connect; /**< Connection structure associated with us */
246 struct User* cli_user; /**< Defined if this client is a user */
247 struct Server* cli_serv; /**< Defined if this client is a server */
248 struct Whowas* cli_whowas; /**< Pointer to ww struct to be freed on quit */
249 char cli_yxx[4]; /**< Numeric Nick: YY if this is a
250 server, XXX if this is a user */
251 time_t cli_firsttime; /**< time client was created */
252 time_t cli_lastnick; /**< TimeStamp on nick */
253 int cli_marker; /**< /who processing marker */
254 struct Flags cli_flags; /**< client flags */
255 unsigned int cli_hopcount; /**< number of servers to this 0 = local */
256 struct irc_in_addr cli_ip; /**< Real IP of client */
257 short cli_status; /**< Client type */
258 char cli_name[HOSTLEN + 1]; /**< Unique name of the client, nick or host */
259 char cli_username[USERLEN + 1]; /**< Username determined by ident lookup */
260 char cli_info[REALLEN + 1]; /**< Free form additional client information */
263 /** Magic constant to identify valid Client structures. */
264 #define CLIENT_MAGIC 0x4ca08286
266 /** Verify that a client is valid. */
267 #define cli_verify(cli) ((cli)->cli_magic == CLIENT_MAGIC)
268 /** Get client's magic number. */
269 #define cli_magic(cli) ((cli)->cli_magic)
270 /** Get global next client. */
271 #define cli_next(cli) ((cli)->cli_next)
272 /** Get global previous client. */
273 #define cli_prev(cli) ((cli)->cli_prev)
274 /** Get next client in hash bucket chain. */
275 #define cli_hnext(cli) ((cli)->cli_hnext)
276 /** Get connection associated with client. */
277 #define cli_connect(cli) ((cli)->cli_connect)
278 /** Get local client that links us to \a cli. */
279 #define cli_from(cli) con_client(cli_connect(cli))
280 /** Get User structure for client, if client is a user. */
281 #define cli_user(cli) ((cli)->cli_user)
282 /** Get Server structure for client, if client is a server. */
283 #define cli_serv(cli) ((cli)->cli_serv)
284 /** Get Whowas link for client. */
285 #define cli_whowas(cli) ((cli)->cli_whowas)
286 /** Get client numnick. */
287 #define cli_yxx(cli) ((cli)->cli_yxx)
288 /** Get time we last read data from the client socket. */
289 #define cli_lasttime(cli) con_lasttime(cli_connect(cli))
290 /** Get time we last parsed something from the client. */
291 #define cli_since(cli) con_since(cli_connect(cli))
292 /** Get time client was created. */
293 #define cli_firsttime(cli) ((cli)->cli_firsttime)
294 /** Get time client last changed nickname. */
295 #define cli_lastnick(cli) ((cli)->cli_lastnick)
296 /** Get WHO marker for client. */
297 #define cli_marker(cli) ((cli)->cli_marker)
298 /** Get flags flagset for client. */
299 #define cli_flags(cli) ((cli)->cli_flags)
300 /** Get hop count to client. */
301 #define cli_hopcount(cli) ((cli)->cli_hopcount)
302 /** Get client IP address. */
303 #define cli_ip(cli) ((cli)->cli_ip)
304 /** Get status bitmask for client. */
305 #define cli_status(cli) ((cli)->cli_status)
306 /** Return non-zero if the client is local. */
307 #define cli_local(cli) (cli_from(cli) == cli)
308 /** Get oper privileges for client. */
309 #define cli_privs(cli) con_privs(cli_connect(cli))
310 /** Get client capabilities for client */
311 #define cli_capab(cli) con_capab(cli_connect(cli))
312 /** Get active client capabilities for client */
313 #define cli_active(cli) con_active(cli_connect(cli))
314 /** Get client name. */
315 #define cli_name(cli) ((cli)->cli_name)
316 /** Get client username (ident). */
317 #define cli_username(cli) ((cli)->cli_username)
318 /** Get client realname (information field). */
319 #define cli_info(cli) ((cli)->cli_info)
320 /** Get client account string. */
321 #define cli_account(cli) (cli_user(cli) ? cli_user(cli)->account : "0")
323 /** Get number of incoming bytes queued for client. */
324 #define cli_count(cli) con_count(cli_connect(cli))
325 /** Get file descriptor for sending in client's direction. */
326 #define cli_fd(cli) con_fd(cli_connect(cli))
327 /** Get free flags for the client's connection. */
328 #define cli_freeflag(cli) con_freeflag(cli_connect(cli))
329 /** Get last error code for the client's connection. */
330 #define cli_error(cli) con_error(cli_connect(cli))
331 /** Get server notice mask for the client. */
332 #define cli_snomask(cli) con_snomask(cli_connect(cli))
333 /** Get next time a nick change is allowed for the client. */
334 #define cli_nextnick(cli) con_nextnick(cli_connect(cli))
335 /** Get next time a target change is allowed for the client. */
336 #define cli_nexttarget(cli) con_nexttarget(cli_connect(cli))
337 /** Get SendQ for client. */
338 #define cli_sendQ(cli) con_sendQ(cli_connect(cli))
339 /** Get RecvQ for client. */
340 #define cli_recvQ(cli) con_recvQ(cli_connect(cli))
341 /** Get count of messages sent to client. */
342 #define cli_sendM(cli) con_sendM(cli_connect(cli))
343 /** Get number of messages received from client. */
344 #define cli_receiveM(cli) con_receiveM(cli_connect(cli))
345 /** Get number of bytes (modulo 1024) sent to client. */
346 #define cli_sendB(cli) con_sendB(cli_connect(cli))
347 /** Get number of bytes (modulo 1024) received from client. */
348 #define cli_receiveB(cli) con_receiveB(cli_connect(cli))
349 /** Get listener that accepted the client's connection. */
350 #define cli_listener(cli) con_listener(cli_connect(cli))
351 /** Get list of attached conf lines. */
352 #define cli_confs(cli) con_confs(cli_connect(cli))
353 /** Get handler type for client. */
354 #define cli_handler(cli) con_handler(cli_connect(cli))
355 /** Get LIST status for client. */
356 #define cli_listing(cli) con_listing(cli_connect(cli))
357 /** Get cached max SendQ for client. */
358 #define cli_max_sendq(cli) con_max_sendq(cli_connect(cli))
359 /** Get ping frequency for client. */
360 #define cli_ping_freq(cli) con_ping_freq(cli_connect(cli))
361 /** Get lastsq for client's connection. */
362 #define cli_lastsq(cli) con_lastsq(cli_connect(cli))
363 /** Get the array of current targets for the client. */
364 #define cli_targets(cli) con_targets(cli_connect(cli))
365 /** Get the string form of the client's IP address. */
366 #define cli_sock_ip(cli) con_sock_ip(cli_connect(cli))
367 /** Get the resolved hostname for the client. */
368 #define cli_sockhost(cli) con_sockhost(cli_connect(cli))
369 /** Get the client's password. */
370 #define cli_passwd(cli) con_passwd(cli_connect(cli))
371 /** Get the unprocessed input buffer for a client's connection. */
372 #define cli_buffer(cli) con_buffer(cli_connect(cli))
373 /** Get the Socket structure for sending to a client. */
374 #define cli_socket(cli) con_socket(cli_connect(cli))
375 /** Get Timer for processing waiting messages from the client. */
376 #define cli_proc(cli) con_proc(cli_connect(cli))
377 /** Get auth request for client. */
378 #define cli_auth(cli) con_auth(cli_connect(cli))
379 /** Get sentalong marker for client. */
380 #define cli_sentalong(cli) con_sentalong(cli_connect(cli))
382 /** Verify that a connection is valid. */
383 #define con_verify(con) ((con)->con_magic == CONNECTION_MAGIC)
384 /** Get connection's magic number. */
385 #define con_magic(con) ((con)->con_magic)
386 /** Get global next connection. */
387 #define con_next(con) ((con)->con_next)
388 /** Get global previous connection. */
389 #define con_prev_p(con) ((con)->con_prev_p)
390 /** Get locally connected client for connection. */
391 #define con_client(con) ((con)->con_client)
392 /** Get number of unprocessed data bytes from connection. */
393 #define con_count(con) ((con)->con_count)
394 /** Get file descriptor for connection. */
395 #define con_fd(con) s_fd(&(con)->con_socket)
396 /** Get freeable flags for connection. */
397 #define con_freeflag(con) ((con)->con_freeflag)
398 /** Get last error code on connection. */
399 #define con_error(con) ((con)->con_error)
400 /** Get sentalong marker for connection. */
401 #define con_sentalong(con) ((con)->con_sentalong)
402 /** Get server notice mask for connection. */
403 #define con_snomask(con) ((con)->con_snomask)
404 /** Get next nick change time for connection. */
405 #define con_nextnick(con) ((con)->con_nextnick)
406 /** Get next new target time for connection. */
407 #define con_nexttarget(con) ((con)->con_nexttarget)
408 /** Get last time we read from the connection. */
409 #define con_lasttime(con) ((con)->con_lasttime)
410 /** Get last time we accepted a command from the connection. */
411 #define con_since(con) ((con)->con_since)
412 /** Get SendQ for connection. */
413 #define con_sendQ(con) ((con)->con_sendQ)
414 /** Get RecvQ for connection. */
415 #define con_recvQ(con) ((con)->con_recvQ)
416 /** Get number of messages sent to connection. */
417 #define con_sendM(con) ((con)->con_sendM)
418 /** Get number of messages received from connection. */
419 #define con_receiveM(con) ((con)->con_receiveM)
420 /** Get number of bytes (modulo 1024) sent to connection. */
421 #define con_sendB(con) ((con)->con_sendB)
422 /** Get number of bytes (modulo 1024) received from connection. */
423 #define con_receiveB(con) ((con)->con_receiveB)
424 /** Get listener that accepted the connection. */
425 #define con_listener(con) ((con)->con_listener)
426 /** Get list of ConfItems attached to the connection. */
427 #define con_confs(con) ((con)->con_confs)
428 /** Get command handler for the connection. */
429 #define con_handler(con) ((con)->con_handler)
430 /** Get the LIST status for the connection. */
431 #define con_listing(con) ((con)->con_listing)
432 /** Get the maximum permitted SendQ size for the connection. */
433 #define con_max_sendq(con) ((con)->con_max_sendq)
434 /** Get the ping frequency for the connection. */
435 #define con_ping_freq(con) ((con)->con_ping_freq)
436 /** Get the lastsq for the connection. */
437 #define con_lastsq(con) ((con)->con_lastsq)
438 /** Get the current targets array for the connection. */
439 #define con_targets(con) ((con)->con_targets)
440 /** Get the string-formatted IP address for the connection. */
441 #define con_sock_ip(con) ((con)->con_sock_ip)
442 /** Get the resolved hostname for the connection. */
443 #define con_sockhost(con) ((con)->con_sockhost)
444 /** Get the password sent by the remote end of the connection. */
445 #define con_passwd(con) ((con)->con_passwd)
446 /** Get the buffer of unprocessed incoming data from the connection. */
447 #define con_buffer(con) ((con)->con_buffer)
448 /** Get the Socket for the connection. */
449 #define con_socket(con) ((con)->con_socket)
450 /** Get the Timer for processing more data from the connection. */
451 #define con_proc(con) ((con)->con_proc)
452 /** Get the oper privilege set for the connection. */
453 #define con_privs(con) (&(con)->con_privs)
454 /** Get the peer's capabilities for the connection. */
455 #define con_capab(con) (&(con)->con_capab)
456 /** Get the active capabilities for the connection. */
457 #define con_active(con) (&(con)->con_active)
458 /** Get the auth request for the connection. */
459 #define con_auth(con) ((con)->con_auth)
461 #define STAT_CONNECTING 0x001 /**< connecting to another server */
462 #define STAT_HANDSHAKE 0x002 /**< pass - server sent */
463 #define STAT_ME 0x004 /**< this server */
464 #define STAT_UNKNOWN 0x008 /**< unidentified connection */
465 #define STAT_UNKNOWN_USER 0x010 /**< connection on a client port */
466 #define STAT_UNKNOWN_SERVER 0x020 /**< connection on a server port */
467 #define STAT_SERVER 0x040 /**< fully registered server */
468 #define STAT_USER 0x080 /**< fully registered user */
473 /** Return non-zero if the client is registered. */
474 #define IsRegistered(x) (cli_status(x) & (STAT_SERVER | STAT_USER))
475 /** Return non-zero if the client is an outbound connection that is
476 * still connecting. */
477 #define IsConnecting(x) (cli_status(x) == STAT_CONNECTING)
478 /** Return non-zero if the client is an outbound connection that has
479 * sent our password. */
480 #define IsHandshake(x) (cli_status(x) == STAT_HANDSHAKE)
481 /** Return non-zero if the client is this server. */
482 #define IsMe(x) (cli_status(x) == STAT_ME)
483 /** Return non-zero if the client has not yet registered. */
484 #define IsUnknown(x) (cli_status(x) & \
485 (STAT_UNKNOWN | STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER))
486 /** Return non-zero if the client is an unregistered connection on a
488 #define IsServerPort(x) (cli_status(x) == STAT_UNKNOWN_SERVER )
489 /** Return non-zero if the client is an unregistered connection on a
491 #define IsUserPort(x) (cli_status(x) == STAT_UNKNOWN_USER )
492 /** Return non-zero if the client is a real client connection. */
493 #define IsClient(x) (cli_status(x) & \
494 (STAT_HANDSHAKE | STAT_ME | STAT_UNKNOWN |\
495 STAT_UNKNOWN_USER | STAT_UNKNOWN_SERVER | STAT_SERVER | STAT_USER))
496 /** Return non-zero if the client ignores flood limits. */
497 #define IsTrusted(x) (cli_status(x) & \
498 (STAT_CONNECTING | STAT_HANDSHAKE | STAT_ME | STAT_SERVER))
499 /** Return non-zero if the client is a registered server. */
500 #define IsServer(x) (cli_status(x) == STAT_SERVER)
501 /** Return non-zero if the client is a registered user. */
502 #define IsUser(x) (cli_status(x) == STAT_USER)
505 /** Mark a client with STAT_CONNECTING. */
506 #define SetConnecting(x) (cli_status(x) = STAT_CONNECTING)
507 /** Mark a client with STAT_HANDSHAKE. */
508 #define SetHandshake(x) (cli_status(x) = STAT_HANDSHAKE)
509 /** Mark a client with STAT_SERVER. */
510 #define SetServer(x) (cli_status(x) = STAT_SERVER)
511 /** Mark a client with STAT_ME. */
512 #define SetMe(x) (cli_status(x) = STAT_ME)
513 /** Mark a client with STAT_USER. */
514 #define SetUser(x) (cli_status(x) = STAT_USER)
516 /** Return non-zero if a client is directly connected to me. */
517 #define MyConnect(x) (cli_from(x) == (x))
518 /** Return non-zero if a client is a locally connected user. */
519 #define MyUser(x) (MyConnect(x) && IsUser(x))
520 /** Return non-zero if a client is a locally connected IRC operator. */
521 #define MyOper(x) (MyConnect(x) && IsOper(x))
522 /** Return protocol version used by a server. */
523 #define Protocol(x) ((cli_serv(x))->prot)
528 /** Set a flag in a client's flags. */
529 #define SetFlag(cli, flag) FlagSet(&cli_flags(cli), flag)
530 /** Clear a flag from a client's flags. */
531 #define ClrFlag(cli, flag) FlagClr(&cli_flags(cli), flag)
532 /** Return non-zero if a flag is set in a client's flags. */
533 #define HasFlag(cli, flag) FlagHas(&cli_flags(cli), flag)
535 /** Return non-zero if the client is an IRC operator (global or local). */
536 #define IsAnOper(x) (IsOper(x) || IsLocOp(x))
537 /** Return non-zero if the client's connection is blocked. */
538 #define IsBlocked(x) HasFlag(x, FLAG_BLOCKED)
539 /** Return non-zero if the client's connection is still being burst. */
540 #define IsBurst(x) HasFlag(x, FLAG_BURST)
541 /** Return non-zero if we have received the peer's entire burst but
542 * not their EOB ack. */
543 #define IsBurstAck(x) HasFlag(x, FLAG_BURST_ACK)
544 /** Return non-zero if we are still bursting to the client. */
545 #define IsBurstOrBurstAck(x) (HasFlag(x, FLAG_BURST) || HasFlag(x, FLAG_BURST_ACK))
546 /** Return non-zero if the client has set mode +k (channel service). */
547 #define IsChannelService(x) HasFlag(x, FLAG_CHSERV)
548 /** Return non-zero if the client's socket is disconnected. */
549 #define IsDead(x) HasFlag(x, FLAG_DEADSOCKET)
550 /** Return non-zero if the client has set mode +d (deaf). */
551 #define IsDeaf(x) HasFlag(x, FLAG_DEAF)
552 /** Return non-zero if the client has been IP-checked for clones. */
553 #define IsIPChecked(x) HasFlag(x, FLAG_IPCHECK)
554 /** Return non-zero if we have received an ident response for the client. */
555 #define IsIdented(x) HasFlag(x, FLAG_GOTID)
556 /** Return non-zero if the client has set mode +i (invisible). */
557 #define IsInvisible(x) HasFlag(x, FLAG_INVISIBLE)
558 /** Return non-zero if the client caused a net.burst. */
559 #define IsJunction(x) HasFlag(x, FLAG_JUNCTION)
560 /** Return non-zero if the client has set mode +O (local operator) locally. */
561 #define IsLocOp(x) (MyConnect(x) && HasFlag(x, FLAG_LOCOP))
562 /** Return non-zero if the client has set mode +o (global operator). */
563 #define IsOper(x) HasFlag(x, FLAG_OPER)
564 /** Return non-zero if the client has an active UDP ping request. */
565 #define IsUPing(x) HasFlag(x, FLAG_UPING)
566 /** Return non-zero if the client has no '\n' in its buffer. */
567 #define NoNewLine(x) HasFlag(x, FLAG_NONL)
568 /** Return non-zero if the client has set mode +g (debugging). */
569 #define SendDebug(x) HasFlag(x, FLAG_DEBUG)
570 /** Return non-zero if the client has set mode +s (server notices). */
571 #define SendServNotice(x) HasFlag(x, FLAG_SERVNOTICE)
572 /** Return non-zero if the client has set mode +w (wallops). */
573 #define SendWallops(x) HasFlag(x, FLAG_WALLOP)
574 /** Return non-zero if the client claims to be a hub. */
575 #define IsHub(x) HasFlag(x, FLAG_HUB)
576 /** Return non-zero if the client understands IPv6 addresses in P10. */
577 #define IsIPv6(x) HasFlag(x, FLAG_IPV6)
578 /** Return non-zero if the client claims to be a services server. */
579 #define IsService(x) HasFlag(x, FLAG_SERVICE)
580 /** Return non-zero if the client has an account stamp. */
581 #define IsAccount(x) HasFlag(x, FLAG_ACCOUNT)
582 /** Return non-zero if the client has set mode +x (hidden host). */
583 #define IsHiddenHost(x) HasFlag(x, FLAG_HIDDENHOST)
584 /** Return non-zero if the client has an active PING request. */
585 #define IsPingSent(x) HasFlag(x, FLAG_PINGSENT)
587 /** Return non-zero if the client has operator or server privileges. */
588 #define IsPrivileged(x) (IsAnOper(x) || IsServer(x))
589 /** Return non-zero if the client's host is hidden. */
590 #define HasHiddenHost(x) (IsHiddenHost(x) && IsAccount(x))
592 /** Mark a client as having an in-progress net.burst. */
593 #define SetBurst(x) SetFlag(x, FLAG_BURST)
594 /** Mark a client as being between EOB and EOB ACK. */
595 #define SetBurstAck(x) SetFlag(x, FLAG_BURST_ACK)
596 /** Mark a client as having mode +k (channel service). */
597 #define SetChannelService(x) SetFlag(x, FLAG_CHSERV)
598 /** Mark a client as having mode +d (deaf). */
599 #define SetDeaf(x) SetFlag(x, FLAG_DEAF)
600 /** Mark a client as having mode +g (debugging). */
601 #define SetDebug(x) SetFlag(x, FLAG_DEBUG)
602 /** Mark a client as having ident looked up. */
603 #define SetGotId(x) SetFlag(x, FLAG_GOTID)
604 /** Mark a client as being IP-checked. */
605 #define SetIPChecked(x) SetFlag(x, FLAG_IPCHECK)
606 /** Mark a client as having mode +i (invisible). */
607 #define SetInvisible(x) SetFlag(x, FLAG_INVISIBLE)
608 /** Mark a client as causing a net.join. */
609 #define SetJunction(x) SetFlag(x, FLAG_JUNCTION)
610 /** Mark a client as having mode +O (local operator). */
611 #define SetLocOp(x) SetFlag(x, FLAG_LOCOP)
612 /** Mark a client as having mode +o (global operator). */
613 #define SetOper(x) SetFlag(x, FLAG_OPER)
614 /** Mark a client as having a pending UDP ping. */
615 #define SetUPing(x) SetFlag(x, FLAG_UPING)
616 /** Mark a client as having mode +w (wallops). */
617 #define SetWallops(x) SetFlag(x, FLAG_WALLOP)
618 /** Mark a client as having mode +s (server notices). */
619 #define SetServNotice(x) SetFlag(x, FLAG_SERVNOTICE)
620 /** Mark a client as being a hub server. */
621 #define SetHub(x) SetFlag(x, FLAG_HUB)
622 /** Mark a client as being an IPv6-grokking server. */
623 #define SetIPv6(x) SetFlag(x, FLAG_IPV6)
624 /** Mark a client as being a services server. */
625 #define SetService(x) SetFlag(x, FLAG_SERVICE)
626 /** Mark a client as having an account stamp. */
627 #define SetAccount(x) SetFlag(x, FLAG_ACCOUNT)
628 /** Mark a client as having mode +x (hidden host). */
629 #define SetHiddenHost(x) SetFlag(x, FLAG_HIDDENHOST)
630 /** Mark a client as having a pending PING. */
631 #define SetPingSent(x) SetFlag(x, FLAG_PINGSENT)
633 /** Return non-zero if \a sptr sees \a acptr as an operator. */
634 #define SeeOper(sptr,acptr) (IsAnOper(acptr) && (HasPriv(acptr, PRIV_DISPLAY) \
635 || HasPriv(sptr, PRIV_SEE_OPERS)))
637 /** Clear the client's net.burst in-progress flag. */
638 #define ClearBurst(x) ClrFlag(x, FLAG_BURST)
639 /** Clear the client's between EOB and EOB ACK flag. */
640 #define ClearBurstAck(x) ClrFlag(x, FLAG_BURST_ACK)
641 /** Remove mode +k (channel service) from the client. */
642 #define ClearChannelService(x) ClrFlag(x, FLAG_CHSERV)
643 /** Remove mode +d (deaf) from the client. */
644 #define ClearDeaf(x) ClrFlag(x, FLAG_DEAF)
645 /** Remove mode +g (debugging) from the client. */
646 #define ClearDebug(x) ClrFlag(x, FLAG_DEBUG)
647 /** Remove the client's IP-checked flag. */
648 #define ClearIPChecked(x) ClrFlag(x, FLAG_IPCHECK)
649 /** Remove mode +i (invisible) from the client. */
650 #define ClearInvisible(x) ClrFlag(x, FLAG_INVISIBLE)
651 /** Remove mode +O (local operator) from the client. */
652 #define ClearLocOp(x) ClrFlag(x, FLAG_LOCOP)
653 /** Remove mode +o (global operator) from the client. */
654 #define ClearOper(x) ClrFlag(x, FLAG_OPER)
655 /** Clear the client's pending UDP ping flag. */
656 #define ClearUPing(x) ClrFlag(x, FLAG_UPING)
657 /** Remove mode +w (wallops) from the client. */
658 #define ClearWallops(x) ClrFlag(x, FLAG_WALLOP)
659 /** Remove mode +s (server notices) from the client. */
660 #define ClearServNotice(x) ClrFlag(x, FLAG_SERVNOTICE)
661 /** Remove mode +x (hidden host) from the client. */
662 #define ClearHiddenHost(x) ClrFlag(x, FLAG_HIDDENHOST)
663 /** Clear the client's pending PING flag. */
664 #define ClearPingSent(x) ClrFlag(x, FLAG_PINGSENT)
665 /** Clear the client's HUB flag. */
666 #define ClearHub(x) ClrFlag(x, FLAG_HUB)
669 #define FREEFLAG_SOCKET 0x0001 /**< socket needs to be freed */
670 #define FREEFLAG_TIMER 0x0002 /**< timer needs to be freed */
672 /* server notice stuff */
674 #define SNO_ADD 1 /**< Perform "or" on server notice mask. */
675 #define SNO_DEL 2 /**< Perform "and ~x" on server notice mask. */
676 #define SNO_SET 3 /**< Set server notice mask. */
677 /* DON'T CHANGE THESE VALUES ! */
678 /* THE CLIENTS DEPEND ON IT ! */
679 #define SNO_OLDSNO 0x1 /**< unsorted old messages */
680 #define SNO_SERVKILL 0x2 /**< server kills (nick collisions) */
681 #define SNO_OPERKILL 0x4 /**< oper kills */
682 #define SNO_HACK2 0x8 /**< desyncs */
683 #define SNO_HACK3 0x10 /**< temporary desyncs */
684 #define SNO_UNAUTH 0x20 /**< unauthorized connections */
685 #define SNO_TCPCOMMON 0x40 /**< common TCP or socket errors */
686 #define SNO_TOOMANY 0x80 /**< too many connections */
687 #define SNO_HACK4 0x100 /**< Uworld actions on channels */
688 #define SNO_GLINE 0x200 /**< glines */
689 #define SNO_NETWORK 0x400 /**< net join/break, etc */
690 #define SNO_IPMISMATCH 0x800 /**< IP mismatches */
691 #define SNO_THROTTLE 0x1000 /**< host throttle add/remove notices */
692 #define SNO_OLDREALOP 0x2000 /**< old oper-only messages */
693 #define SNO_CONNEXIT 0x4000 /**< client connect/exit (ugh) */
694 #define SNO_AUTO 0x8000 /**< AUTO G-Lines */
695 #define SNO_DEBUG 0x10000 /**< debugging messages (DEBUGMODE only) */
696 #define SNO_AUTH 0x20000 /**< IAuth notices */
698 /** Bitmask of all valid server notice bits. */
700 # define SNO_ALL 0x3ffff
702 # define SNO_ALL 0x2ffff
705 /** Server notice bits allowed to normal users. */
706 #define SNO_USER (SNO_ALL & ~SNO_OPER)
708 /** Server notice bits enabled by default for normal users. */
709 #define SNO_DEFAULT (SNO_NETWORK|SNO_OPERKILL|SNO_GLINE)
710 /** Server notice bits enabled by default for IRC operators. */
711 #define SNO_OPERDEFAULT (SNO_DEFAULT|SNO_HACK2|SNO_HACK4|SNO_THROTTLE|SNO_OLDSNO)
712 /** Server notice bits reserved to IRC operators. */
713 #define SNO_OPER (SNO_CONNEXIT|SNO_OLDREALOP|SNO_AUTH)
714 /** Noisy server notice bits that cause other bits to be cleared during connect. */
715 #define SNO_NOISY (SNO_SERVKILL|SNO_UNAUTH)
717 /** Test whether a privilege has been granted to a client. */
718 #define HasPriv(cli, priv) FlagHas(cli_privs(cli), priv)
719 /** Grant a privilege to a client. */
720 #define SetPriv(cli, priv) FlagSet(cli_privs(cli), priv)
721 /** Revoke a privilege from a client. */
722 #define ClrPriv(cli, priv) FlagClr(cli_privs(cli), priv)
724 /** Test whether a client has a capability */
725 #define HasCap(cli, cap) CapHas(cli_capab(cli), (cap))
726 /** Test whether a client has the capability active */
727 #define CapActive(cli, cap) CapHas(cli_active(cli), (cap))
729 #define HIDE_IP 0 /**< Do not show IP address in get_client_name() */
730 #define SHOW_IP 1 /**< Show ident and IP address in get_client_name() */
732 extern const char* get_client_name(const struct Client* sptr, int showip);
733 extern const char* client_get_default_umode(const struct Client* sptr);
734 extern int client_get_ping(const struct Client* local_client);
735 extern void client_drop_sendq(struct Connection* con);
736 extern void client_add_sendq(struct Connection* con,
737 struct Connection** con_p);
738 extern void client_set_privs(struct Client *client, struct ConfItem *oper);
739 extern int client_report_privs(struct Client* to, struct Client* client);
741 #endif /* INCLUDED_client_h */