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