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