2 * IRC - Internet Relay Chat, ircd/s_misc.c (formerly ircd/date.c)
3 * Copyright (C) 1990 Jarkko Oikarinen and
4 * University of Oulu, Computing Center
6 * See file AUTHORS in IRC package for additional names of
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 1, or (at your option)
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * @brief Miscellaneous support functions.
25 * @version $Id: s_misc.c 1818 2007-07-14 02:40:01Z isomer $
35 #include "ircd_alloc.h"
36 #include "ircd_features.h"
38 #include "ircd_reply.h"
39 #include "ircd_snprintf.h"
40 #include "ircd_string.h"
47 #include "querycmds.h"
61 /* #include <assert.h> -- Now using assert in ircd_log.h */
69 /** Array of English month names (0 = January). */
70 static char *months[] = {
71 "January", "February", "March", "April",
72 "May", "June", "July", "August",
73 "September", "October", "November", "December"
76 /** Array of English day names (0 = Sunday). */
77 static char *weekdays[] = {
78 "Sunday", "Monday", "Tuesday", "Wednesday",
79 "Thursday", "Friday", "Saturday"
85 /** Global statistics structure. */
86 static struct ServerStatistics ircst;
87 /** Public pointer to global statistics structure. */
88 struct ServerStatistics* ServerStats = &ircst;
90 /** Formats a Unix time as a readable string.
91 * @param clock Unix time to format (0 means #CurrentTime).
92 * @return Pointer to a static buffer containing something like
93 * "Sunday January 1 2000 -- 09:30 +01:00"
95 char *date(time_t clock)
97 static char buf[80], plus;
105 memcpy(&gmbuf, gm, sizeof(gmbuf));
107 lt = localtime(&clock);
109 /* There is unfortunately no clean portable way to extract time zone
110 * offset information, so do ugly things.
112 minswest = (gm->tm_hour - lt->tm_hour) * 60 + (gm->tm_min - lt->tm_min);
113 if (lt->tm_yday != gm->tm_yday)
115 if ((lt->tm_yday > gm->tm_yday && lt->tm_year == gm->tm_year) ||
116 (lt->tm_yday < gm->tm_yday && lt->tm_year != gm->tm_year))
122 plus = (minswest > 0) ? '-' : '+';
124 minswest = -minswest;
126 sprintf(buf, "%s %s %d %d -- %02d:%02d %c%02d:%02d",
127 weekdays[lt->tm_wday], months[lt->tm_mon], lt->tm_mday,
128 1900 + lt->tm_year, lt->tm_hour, lt->tm_min,
129 plus, minswest / 60, minswest % 60);
134 /** Like ctime() but with no trailing newline. Also, it takes
135 * the time value as parameter, instead of pointer to it.
136 * @param value Unix time to format.
137 * @return Pointer to a static buffer containing formatted time.
139 char *myctime(time_t value)
141 /* Use a secondary buffer in case ctime() would not replace an
142 * overwritten newline.
147 strcpy(buf, ctime(&value));
148 if ((p = strchr(buf, '\n')) != NULL)
154 /** Return the name of the client for various tracking and admin
155 * purposes. The main purpose of this function is to return the
156 * "socket host" name of the client, if that differs from the
157 * advertised name (other than case). But, this can be used on any
159 * @param sptr Client to operate on.
160 * @param showip If non-zero, append [username\@text-ip] to name.
161 * @return Either cli_name(\a sptr) or a static buffer.
163 const char* get_client_name(const struct Client* sptr, int showip)
165 static char nbuf[HOSTLEN * 2 + USERLEN + 5];
167 if (!MyConnect(sptr) || !showip)
168 return cli_name(sptr);
169 ircd_snprintf(0, nbuf, sizeof(nbuf), "%s[%s@%s]", cli_name(sptr),
170 IsIdented(sptr) ? cli_username(sptr) : "",
176 * Exit one client, local or remote. Assuming for local client that
177 * all dependents already have been removed, and socket is closed.
178 * @param bcptr Client being (s)quitted.
179 * @param comment The QUIT comment to send.
181 /* Rewritten by Run - 24 sept 94 */
182 static void exit_one_client(struct Client* bcptr, const char* comment)
187 if (cli_serv(bcptr) && cli_serv(bcptr)->client_list) /* Was SetServerYXX called ? */
188 ClearServerYXX(bcptr); /* Removes server from server_list[] */
191 * clear out uping requests
194 uping_cancel(bcptr, 0);
196 * Stop a running /LIST clean
198 if (MyUser(bcptr) && cli_listing(bcptr)) {
199 MyFree(cli_listing(bcptr));
200 cli_listing(bcptr) = NULL;
203 * If a person is on a channel, send a QUIT notice
204 * to every client (person) on the same channel (so
205 * that the client can show the "**signoff" message).
206 * (Note: The notice is to the local clients *only*)
209 sendcmdto_common_channels_butone_audit(bcptr, CMD_QUIT, NULL, ":%s", comment);
211 remove_user_from_all_channels(bcptr);
213 /* Clean up invitefield */
214 while ((lp = cli_user(bcptr)->invited))
215 del_invite(bcptr, lp->value.chptr);
217 /* Clean up silencefield */
218 while ((bp = cli_user(bcptr)->silence)) {
219 cli_user(bcptr)->silence = bp->next;
223 /* Clean up snotice lists */
225 set_snomask(bcptr, ~0, SNO_DEL);
227 if (IsInvisible(bcptr)) {
228 assert(UserStats.inv_clients > 0);
229 --UserStats.inv_clients;
232 assert(UserStats.opers > 0);
235 if (MyConnect(bcptr))
236 Count_clientdisconnects(bcptr, UserStats);
238 Count_remoteclientquits(UserStats, bcptr);
240 else if (IsServer(bcptr))
242 /* Remove downlink list node of uplink */
243 remove_dlink(&(cli_serv(cli_serv(bcptr)->up))->down, cli_serv(bcptr)->updown);
244 cli_serv(bcptr)->updown = 0;
246 if (MyConnect(bcptr))
247 Count_serverdisconnects(UserStats);
249 Count_remoteserverquits(UserStats);
251 else if (IsMe(bcptr))
253 sendto_opmask_butone(0, SNO_OLDSNO, "ERROR: tried to exit me! : %s",
255 return; /* ...must *never* exit self! */
257 else if (IsUnknown(bcptr) || IsConnecting(bcptr) || IsHandshake(bcptr))
258 Count_unknowndisconnects(UserStats);
263 if (IsIPChecked(bcptr))
264 IPcheck_disconnect(bcptr);
267 * Remove from serv->client_list
268 * NOTE: user is *always* NULL if this is a server
270 if (cli_user(bcptr)) {
271 assert(!IsServer(bcptr));
272 /* bcptr->user->server->serv->client_list[IndexYXX(bcptr)] = NULL; */
273 RemoveYXXClient(cli_user(bcptr)->server, cli_yxx(bcptr));
276 /* Remove bcptr from the client list */
278 if (hRemClient(bcptr) != 0)
279 Debug((DEBUG_ERROR, "%p !in tab %s[%s] %p %p %p %d %d %p",
280 bcptr, cli_name(bcptr), cli_from(bcptr) ? cli_sockhost(cli_from(bcptr)) : "??host",
281 cli_from(bcptr), cli_next(bcptr), cli_prev(bcptr), cli_fd(bcptr),
282 cli_status(bcptr), cli_user(bcptr)));
286 remove_client_from_list(bcptr);
289 /* exit_downlinks - added by Run 25-9-94 */
291 * Removes all clients and downlinks (+clients) of any server
292 * QUITs are generated and sent to local users.
293 * @param cptr server that must have all dependents removed
294 * @param sptr source who thought that this was a good idea
295 * @param comment comment sent as sign off message to local clients
297 static void exit_downlinks(struct Client *cptr, struct Client *sptr, char *comment)
299 struct Client *acptr;
302 struct Client **acptrp;
305 /* Run over all its downlinks */
306 for (lp = cli_serv(cptr)->down; lp; lp = next)
309 acptr = lp->value.cptr;
310 /* Remove the downlinks and client of the downlink */
311 exit_downlinks(acptr, sptr, comment);
312 /* Remove the downlink itself */
313 exit_one_client(acptr, cli_name(&me));
315 /* Remove all clients of this server */
316 acptrp = cli_serv(cptr)->client_list;
317 for (i = 0; i <= cli_serv(cptr)->nn_mask; ++acptrp, ++i) {
319 exit_one_client(*acptrp, comment);
324 * Marks a local client as disconnected, and close its link if it is a local client.
326 * @param cptr server that notified us
327 * @param killer origin of decision to zombie \a victim
328 * @param victim zombied client
330 void zombie_client(struct Client *cptr, struct Client *killer, struct Client *victim)
332 assert(IsServer(cptr) || IsMe(cptr));
333 assert(IsServer(killer) || IsMe(killer));
334 assert(IsUser(victim));
337 * Stop a running /LIST clean
339 if (MyUser(victim) && cli_listing(victim)) {
340 MyFree(cli_listing(victim));
341 cli_listing(victim) = NULL;
344 if (MyConnect(victim))
345 close_connection(victim);
346 /* need this so that main loop doesn't exit the client */
347 ClrFlag(victim, FLAG_DEADSOCKET);
350 sendcmdto_serv_butone(killer, CMD_ZOMBIE, cptr, "%C", victim);
354 * Attaches a client to a zombied client, removing the superfluous client in the process.
356 * @param cptr server that notified us
357 * @param sptr origin server of unzombie operation
358 * @param acptr client that is attaching to \a victim
359 * @param victim zombied client that someone is attaching to
361 void unzombie_client(struct Client *cptr, struct Client *sptr, struct Client *acptr, struct Client *victim)
363 assert(IsServer(cptr) || IsMe(cptr));
364 assert(IsServer(sptr) || IsMe(sptr));
365 assert(IsUser(acptr));
366 assert(IsNotConn(victim));
368 if (MyConnect(acptr))
369 connection_switch_to_client(acptr, victim);
372 ClearNotConn(victim);
374 /* announce "disconnect" of the source client */
375 sendcmdto_common_channels_butone_audit(acptr, CMD_QUIT, NULL, ":Switched to %s", cli_name(victim));
376 remove_user_from_all_channels(acptr);
378 if (MyConnect(victim)) {
379 /* inform client about "new" modes */
380 struct Flags setflags = cli_flags(acptr);
381 struct Membership *chan;
382 sendcmdto_one(acptr, CMD_NICK, victim, "%C", victim);
383 send_umode(victim, victim, &setflags, ALL_UMODES, 0);
386 * mark current client as zombie on all channels so that it does not show
387 * up in the memberships we'll resend below
389 for (chan = cli_user(acptr)->channel; chan; chan = chan->next_channel) {
393 /* resend channel memberships */
394 for (chan = cli_user(victim)->channel; chan; chan = chan->next_channel) {
395 struct Channel *chptr = chan->channel;
396 /* pretty unlikely to happen but let's handle this anyway */
399 sendcmdto_one(victim, CMD_JOIN, victim, ":%H", chptr);
400 if (chptr->topic[0]) {
401 send_reply(victim, RPL_TOPIC, chptr->chname, chptr->topic);
402 send_reply(victim, RPL_TOPICWHOTIME, chptr->chname, chptr->topic_nick,
405 do_names(victim, chptr, NAMES_ALL|NAMES_EON); /* send /names list */
409 sendcmdto_serv_butone(sptr, CMD_UNZOMBIE, cptr, "%C %C", acptr, victim);
412 /* exit_client, rewritten 25-9-94 by Run */
414 * Exits a client of *any* type (user, server, etc)
415 * from this server. Also, this generates all necessary prototol
416 * messages that this exit may cause.
418 * This function implicitly exits all other clients depending on
421 * For convenience, this function returns a suitable value for
422 * m_function return value:
424 * CPTR_KILLED if (cptr == bcptr)
425 * 0 if (cptr != bcptr)
427 * This function can be called in two ways:
428 * 1) From before or in parse(), exiting the 'cptr', in which case it was
429 * invoked as exit_client(cptr, cptr, &me,...), causing it to always
430 * return CPTR_KILLED.
431 * 2) Via parse from a m_function call, in which case it was invoked as
432 * exit_client(cptr, acptr, sptr, ...). Here 'sptr' is known; the client
433 * that generated the message in a way that we can assume he already
434 * did remove acptr from memory himself (or in other cases we don't mind
435 * because he will be delinked.) Or invoked as:
436 * exit_client(cptr, acptr/sptr, &me, ...) when WE decide this one should
438 * In general: No generated SQUIT or QUIT should be sent to source link
439 * sptr->from. And CPTR_KILLED should be returned if cptr got removed (too).
442 * @param cptr Connection currently being handled by read_message.
443 * @param victim Client being killed.
444 * @param killer Client that made the decision to remove \a victim.
445 * @param comment Reason for the exit.
446 * @return CPTR_KILLED if cptr == bcptr, else 0.
448 int exit_client(struct Client *cptr,
449 struct Client* victim,
450 struct Client* killer,
453 struct Client* acptr = 0;
457 char comment1[HOSTLEN + HOSTLEN + 2];
459 if (MyConnect(victim))
461 SetFlag(victim, FLAG_CLOSING);
463 if (feature_bool(FEAT_CONNEXIT_NOTICES) && IsUser(victim))
464 sendto_opmask_butone(0, SNO_CONNEXIT,
465 "Client exiting: %s (%s@%s) [%s] [%s] <%s%s>",
466 cli_name(victim), cli_user(victim)->username,
467 cli_user(victim)->host, comment,
468 ircd_ntoa(&cli_ip(victim)),
469 NumNick(victim) /* two %s's */);
472 on_for = CurrentTime - cli_firsttime(victim);
474 if (IsUser(victim) || IsUserPort(victim))
475 auth_send_exit(victim);
478 log_write(LS_USER, L_TRACE, 0, "%Tu %i %s@%s %s %s %s%s %s :%s",
479 cli_firsttime(victim), on_for,
480 cli_user(victim)->username, cli_sockhost(victim),
481 ircd_ntoa(&cli_ip(victim)),
482 IsAccount(victim) ? cli_username(victim) : "0",
483 NumNick(victim), /* two %s's */
484 cli_name(victim), cli_info(victim));
486 if (victim != cli_from(killer) /* The source knows already */
487 && IsClient(victim)) /* Not a Ping struct or Log file */
489 if (IsServer(victim) || IsHandshake(victim))
490 sendcmdto_one(killer, CMD_SQUIT, victim, "%s 0 :%s", cli_name(&me), comment);
491 else if (!IsConnecting(victim)) {
492 if (!IsDead(victim)) {
493 if (IsServer(victim))
494 sendcmdto_one(killer, CMD_ERROR, victim,
495 ":Closing Link: %s by %s (%s)", cli_name(victim),
496 cli_name(killer), comment);
498 sendrawto_one(victim, MSG_ERROR " :Closing Link: %s by %s (%s)",
500 cli_name(IsServer(killer) ? &his : killer),
504 if ((IsServer(victim) || IsHandshake(victim) || IsConnecting(victim)) &&
505 (killer == &me || (IsServer(killer) &&
506 (strncmp(comment, "Leaf-only link", 14) ||
507 strncmp(comment, "Non-Hub link", 12)))))
510 * Note: check user == user needed to make sure we have the same
513 if (cli_serv(victim)->user && *(cli_serv(victim))->by &&
514 (acptr = findNUser(cli_serv(victim)->by))) {
515 if (cli_user(acptr) == cli_serv(victim)->user) {
516 sendcmdto_one(&me, CMD_NOTICE, acptr,
517 "%C :Link with %s canceled: %s", acptr,
518 cli_name(victim), comment);
522 * not right client, set by to empty string
525 *(cli_serv(victim))->by = '\0';
529 sendto_opmask_butone(acptr, SNO_OLDSNO, "Link with %s canceled: %s",
530 cli_name(victim), comment);
534 * Close the Client connection first.
536 close_connection(victim);
539 if (IsServer(victim))
541 if (feature_bool(FEAT_HIS_NETSPLIT))
542 strcpy(comment1, "*.net *.split");
545 strcpy(comment1, cli_name(cli_serv(victim)->up));
546 strcat(comment1, " ");
547 strcat(comment1, cli_name(victim));
551 sendto_opmask_butone(killer, SNO_OLDSNO, "%s SQUIT by %s [%s]:",
552 (cli_user(killer)->server == victim ||
553 cli_user(killer)->server == cli_serv(victim)->up) ?
555 get_client_name(killer, HIDE_IP),
556 cli_name(cli_user(killer)->server));
557 else if (killer != &me && cli_serv(victim)->up != killer)
558 sendto_opmask_butone(0, SNO_OLDSNO, "Received SQUIT %s from %s :",
559 cli_name(victim), IsServer(killer) ? cli_name(killer) :
560 get_client_name(killer, HIDE_IP));
561 sendto_opmask_butone(0, SNO_NETWORK, "Net break: %C %C (%s)",
562 cli_serv(victim)->up, victim, comment);
566 * First generate the needed protocol for the other server links
569 for (dlp = cli_serv(&me)->down; dlp; dlp = dlp->next) {
570 if (dlp->value.cptr != cli_from(killer) && dlp->value.cptr != victim)
572 if (IsServer(victim))
573 sendcmdto_one(killer, CMD_SQUIT, dlp->value.cptr, "%s %Tu :%s",
574 cli_name(victim), cli_serv(victim)->timestamp, comment);
575 else if (IsUser(victim) && !HasFlag(victim, FLAG_KILLED))
576 sendcmdto_one(victim, CMD_QUIT, dlp->value.cptr, ":%s", comment);
579 /* Then remove the client structures */
580 if (IsServer(victim))
581 exit_downlinks(victim, killer, comment1);
582 exit_one_client(victim, comment);
585 * cptr can only have been killed if it was cptr itself that got killed here,
586 * because cptr can never have been a dependent of victim --Run
588 return (cptr == victim) ? CPTR_KILLED : 0;
592 * Exit client with formatted va_list message.
593 * Thin wrapper around exit_client().
594 * @param cptr Connection being processed.
595 * @param bcptr Connection being closed.
596 * @param sptr Connection who asked to close the victim.
597 * @param pattern Format string for message.
598 * @param vl Stdargs argument list.
599 * @return Has a tail call to exit_client().
601 /* added 25-9-94 by Run */
602 int vexit_client_msg(struct Client *cptr, struct Client *bcptr, struct Client *sptr,
603 const char *pattern, va_list vl)
606 ircd_vsnprintf(0, msgbuf, sizeof(msgbuf), pattern, vl);
607 return exit_client(cptr, bcptr, sptr, msgbuf);
611 * Exit client with formatted message using a variable-length argument list.
612 * Thin wrapper around exit_client().
613 * @param cptr Connection being processed.
614 * @param bcptr Connection being closed.
615 * @param sptr Connection who asked to close the victim.
616 * @param pattern Format string for message.
617 * @return Has a tail call to exit_client().
619 int exit_client_msg(struct Client *cptr, struct Client *bcptr,
620 struct Client *sptr, const char *pattern, ...)
625 va_start(vl, pattern);
626 ircd_vsnprintf(0, msgbuf, sizeof(msgbuf), pattern, vl);
629 return exit_client(cptr, bcptr, sptr, msgbuf);
632 /** Initialize global server statistics. */
633 /* (Kind of pointless since C guarantees it's already zero'ed, but... */
636 memset(&ircst, 0, sizeof(ircst));
639 /** Report server statistics to a client.
640 * @param cptr Client who wants statistics.
641 * @param sd StatDesc structure being looked up (unused).
642 * @param param Extra parameter passed by user (unused).
644 void tstats(struct Client *cptr, const struct StatDesc *sd, char *param)
646 struct Client *acptr;
648 struct ServerStatistics *sp;
649 struct ServerStatistics tmp;
652 memcpy(sp, ServerStats, sizeof(struct ServerStatistics));
653 for (i = 0; i < MAXCONNECTIONS; i++)
655 if (!(acptr = LocalClientArray[i]))
659 sp->is_sbs += cli_sendB(acptr);
660 sp->is_sbr += cli_receiveB(acptr);
661 sp->is_sti += CurrentTime - cli_firsttime(acptr);
664 else if (IsUser(acptr))
666 sp->is_cbs += cli_sendB(acptr);
667 sp->is_cbr += cli_receiveB(acptr);
668 sp->is_cti += CurrentTime - cli_firsttime(acptr);
671 else if (IsUnknown(acptr))
675 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":accepts %u refused %u",
676 sp->is_ac, sp->is_ref);
677 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
678 ":unknown commands %u prefixes %u", sp->is_unco, sp->is_unpf);
679 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
680 ":nick collisions %u unknown closes %u", sp->is_kill, sp->is_ni);
681 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
682 ":wrong direction %u empty %u", sp->is_wrdi, sp->is_empt);
683 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
684 ":numerics seen %u mode fakes %u", sp->is_num, sp->is_fake);
685 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
686 ":auth successes %u fails %u", sp->is_asuc, sp->is_abad);
687 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":local connections %u",
689 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Client server");
690 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":connected %u %u",
691 sp->is_cl, sp->is_sv);
692 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":bytes sent %Lu %Lu",
693 sp->is_cbs, sp->is_sbs);
694 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":bytes recv %Lu %Lu",
695 sp->is_cbr, sp->is_sbr);
696 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":time connected %Lu %Lu",
697 sp->is_cti, sp->is_sti);