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.
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*)
208 sendcmdto_common_channels_butone(bcptr, CMD_QUIT, NULL, ":%s", comment);
210 remove_user_from_all_channels(bcptr);
212 /* Clean up invitefield */
213 while ((lp = cli_user(bcptr)->invited))
214 del_invite(bcptr, lp->value.chptr);
216 /* Clean up silencefield */
217 while ((bp = cli_user(bcptr)->silence)) {
218 cli_user(bcptr)->silence = bp->next;
222 /* Clean up snotice lists */
224 set_snomask(bcptr, ~0, SNO_DEL);
226 if (IsInvisible(bcptr))
227 --UserStats.inv_clients;
230 if (MyConnect(bcptr))
231 Count_clientdisconnects(bcptr, UserStats);
233 Count_remoteclientquits(UserStats, bcptr);
235 else if (IsServer(bcptr))
237 /* Remove downlink list node of uplink */
238 remove_dlink(&(cli_serv(cli_serv(bcptr)->up))->down, cli_serv(bcptr)->updown);
239 cli_serv(bcptr)->updown = 0;
241 if (MyConnect(bcptr))
242 Count_serverdisconnects(UserStats);
244 Count_remoteserverquits(UserStats);
246 else if (IsMe(bcptr))
248 sendto_opmask_butone(0, SNO_OLDSNO, "ERROR: tried to exit me! : %s",
250 return; /* ...must *never* exit self! */
252 else if (IsUnknown(bcptr) || IsConnecting(bcptr) || IsHandshake(bcptr))
253 Count_unknowndisconnects(UserStats);
258 if (IsIPChecked(bcptr))
259 IPcheck_disconnect(bcptr);
262 * Remove from serv->client_list
263 * NOTE: user is *always* NULL if this is a server
265 if (cli_user(bcptr)) {
266 assert(!IsServer(bcptr));
267 /* bcptr->user->server->serv->client_list[IndexYXX(bcptr)] = NULL; */
268 RemoveYXXClient(cli_user(bcptr)->server, cli_yxx(bcptr));
271 /* Remove bcptr from the client list */
273 if (hRemClient(bcptr) != 0)
274 Debug((DEBUG_ERROR, "%p !in tab %s[%s] %p %p %p %d %d %p",
275 bcptr, cli_name(bcptr), cli_from(bcptr) ? cli_sockhost(cli_from(bcptr)) : "??host",
276 cli_from(bcptr), cli_next(bcptr), cli_prev(bcptr), cli_fd(bcptr),
277 cli_status(bcptr), cli_user(bcptr)));
281 remove_client_from_list(bcptr);
284 /* exit_downlinks - added by Run 25-9-94 */
286 * Removes all clients and downlinks (+clients) of any server
287 * QUITs are generated and sent to local users.
288 * @param cptr server that must have all dependents removed
289 * @param sptr source who thought that this was a good idea
290 * @param comment comment sent as sign off message to local clients
292 static void exit_downlinks(struct Client *cptr, struct Client *sptr, char *comment)
294 struct Client *acptr;
297 struct Client **acptrp;
300 /* Run over all its downlinks */
301 for (lp = cli_serv(cptr)->down; lp; lp = next)
304 acptr = lp->value.cptr;
305 /* Remove the downlinks and client of the downlink */
306 exit_downlinks(acptr, sptr, comment);
307 /* Remove the downlink itself */
308 exit_one_client(acptr, cli_name(&me));
310 /* Remove all clients of this server */
311 acptrp = cli_serv(cptr)->client_list;
312 for (i = 0; i <= cli_serv(cptr)->nn_mask; ++acptrp, ++i) {
314 exit_one_client(*acptrp, comment);
318 /* exit_client, rewritten 25-9-94 by Run */
320 * Exits a client of *any* type (user, server, etc)
321 * from this server. Also, this generates all necessary prototol
322 * messages that this exit may cause.
324 * This function implicitly exits all other clients depending on
327 * For convenience, this function returns a suitable value for
328 * m_function return value:
330 * CPTR_KILLED if (cptr == bcptr)
331 * 0 if (cptr != bcptr)
333 * This function can be called in two ways:
334 * 1) From before or in parse(), exiting the 'cptr', in which case it was
335 * invoked as exit_client(cptr, cptr, &me,...), causing it to always
336 * return CPTR_KILLED.
337 * 2) Via parse from a m_function call, in which case it was invoked as
338 * exit_client(cptr, acptr, sptr, ...). Here 'sptr' is known; the client
339 * that generated the message in a way that we can assume he already
340 * did remove acptr from memory himself (or in other cases we don't mind
341 * because he will be delinked.) Or invoked as:
342 * exit_client(cptr, acptr/sptr, &me, ...) when WE decide this one should
344 * In general: No generated SQUIT or QUIT should be sent to source link
345 * sptr->from. And CPTR_KILLED should be returned if cptr got removed (too).
348 * @param cptr Connection currently being handled by read_message.
349 * @param victim Client being killed.
350 * @param killer Client that made the decision to remove \a victim.
351 * @param comment Reason for the exit.
352 * @return CPTR_KILLED if cptr == bcptr, else 0.
354 int exit_client(struct Client *cptr,
355 struct Client* victim,
356 struct Client* killer,
359 struct Client* acptr = 0;
363 char comment1[HOSTLEN + HOSTLEN + 2];
365 if (MyConnect(victim))
367 SetFlag(victim, FLAG_CLOSING);
369 if (feature_bool(FEAT_CONNEXIT_NOTICES) && IsUser(victim))
370 sendto_opmask_butone(0, SNO_CONNEXIT,
371 "Client exiting: %s (%s@%s) [%s] [%s] <%s%s>",
372 cli_name(victim), cli_user(victim)->username,
373 cli_user(victim)->host, comment,
374 ircd_ntoa(&cli_ip(victim)),
375 NumNick(victim) /* two %s's */);
378 on_for = CurrentTime - cli_firsttime(victim);
380 if (IsUser(victim) || IsUserPort(victim))
381 auth_send_exit(victim);
384 log_write(LS_USER, L_TRACE, 0, "%Tu %i %s@%s %s %s %s%s %s :%s",
385 cli_firsttime(victim), on_for,
386 cli_user(victim)->username, cli_sockhost(victim),
387 ircd_ntoa(&cli_ip(victim)),
388 IsAccount(victim) ? cli_username(victim) : "0",
389 NumNick(victim), /* two %s's */
390 cli_name(victim), cli_info(victim));
392 if (victim != cli_from(killer) /* The source knows already */
393 && IsClient(victim)) /* Not a Ping struct or Log file */
395 if (IsServer(victim) || IsHandshake(victim))
396 sendcmdto_one(killer, CMD_SQUIT, victim, "%s 0 :%s", cli_name(&me), comment);
397 else if (!IsConnecting(victim)) {
398 if (!IsDead(victim)) {
399 if (IsServer(victim))
400 sendcmdto_one(killer, CMD_ERROR, victim,
401 ":Closing Link: %s by %s (%s)", cli_name(victim),
402 cli_name(killer), comment);
404 sendrawto_one(victim, MSG_ERROR " :Closing Link: %s by %s (%s)",
406 cli_name(IsServer(killer) ? &his : killer),
410 if ((IsServer(victim) || IsHandshake(victim) || IsConnecting(victim)) &&
411 (killer == &me || (IsServer(killer) &&
412 (strncmp(comment, "Leaf-only link", 14) ||
413 strncmp(comment, "Non-Hub link", 12)))))
416 * Note: check user == user needed to make sure we have the same
419 if (cli_serv(victim)->user && *(cli_serv(victim))->by &&
420 (acptr = findNUser(cli_serv(victim)->by))) {
421 if (cli_user(acptr) == cli_serv(victim)->user) {
422 sendcmdto_one(&me, CMD_NOTICE, acptr,
423 "%C :Link with %s canceled: %s", acptr,
424 cli_name(victim), comment);
428 * not right client, set by to empty string
431 *(cli_serv(victim))->by = '\0';
435 sendto_opmask_butone(acptr, SNO_OLDSNO, "Link with %s canceled: %s",
436 cli_name(victim), comment);
440 * Close the Client connection first.
442 close_connection(victim);
445 if (IsServer(victim))
447 if (feature_bool(FEAT_HIS_NETSPLIT))
448 strcpy(comment1, "*.net *.split");
451 strcpy(comment1, cli_name(cli_serv(victim)->up));
452 strcat(comment1, " ");
453 strcat(comment1, cli_name(victim));
457 sendto_opmask_butone(killer, SNO_OLDSNO, "%s SQUIT by %s [%s]:",
458 (cli_user(killer)->server == victim ||
459 cli_user(killer)->server == cli_serv(victim)->up) ?
461 get_client_name(killer, HIDE_IP),
462 cli_name(cli_user(killer)->server));
463 else if (killer != &me && cli_serv(victim)->up != killer)
464 sendto_opmask_butone(0, SNO_OLDSNO, "Received SQUIT %s from %s :",
465 cli_name(victim), IsServer(killer) ? cli_name(killer) :
466 get_client_name(killer, HIDE_IP));
467 sendto_opmask_butone(0, SNO_NETWORK, "Net break: %C %C (%s)",
468 cli_serv(victim)->up, victim, comment);
472 * First generate the needed protocol for the other server links
475 for (dlp = cli_serv(&me)->down; dlp; dlp = dlp->next) {
476 if (dlp->value.cptr != cli_from(killer) && dlp->value.cptr != victim)
478 if (IsServer(victim))
479 sendcmdto_one(killer, CMD_SQUIT, dlp->value.cptr, "%s %Tu :%s",
480 cli_name(victim), cli_serv(victim)->timestamp, comment);
481 else if (IsUser(victim) && !HasFlag(victim, FLAG_KILLED))
482 sendcmdto_one(victim, CMD_QUIT, dlp->value.cptr, ":%s", comment);
485 /* Then remove the client structures */
486 if (IsServer(victim))
487 exit_downlinks(victim, killer, comment1);
488 exit_one_client(victim, comment);
491 * cptr can only have been killed if it was cptr itself that got killed here,
492 * because cptr can never have been a dependent of victim --Run
494 return (cptr == victim) ? CPTR_KILLED : 0;
498 * Exit client with formatted va_list message.
499 * Thin wrapper around exit_client().
500 * @param cptr Connection being processed.
501 * @param bcptr Connection being closed.
502 * @param sptr Connection who asked to close the victim.
503 * @param pattern Format string for message.
504 * @param vl Stdargs argument list.
505 * @return Has a tail call to exit_client().
507 /* added 25-9-94 by Run */
508 int vexit_client_msg(struct Client *cptr, struct Client *bcptr, struct Client *sptr,
509 const char *pattern, va_list vl)
512 ircd_vsnprintf(0, msgbuf, sizeof(msgbuf), pattern, vl);
513 return exit_client(cptr, bcptr, sptr, msgbuf);
517 * Exit client with formatted message using a variable-length argument list.
518 * Thin wrapper around exit_client().
519 * @param cptr Connection being processed.
520 * @param bcptr Connection being closed.
521 * @param sptr Connection who asked to close the victim.
522 * @param pattern Format string for message.
523 * @return Has a tail call to exit_client().
525 int exit_client_msg(struct Client *cptr, struct Client *bcptr,
526 struct Client *sptr, const char *pattern, ...)
531 va_start(vl, pattern);
532 ircd_vsnprintf(0, msgbuf, sizeof(msgbuf), pattern, vl);
535 return exit_client(cptr, bcptr, sptr, msgbuf);
538 /** Initialize global server statistics. */
539 /* (Kind of pointless since C guarantees it's already zero'ed, but... */
542 memset(&ircst, 0, sizeof(ircst));
545 /** Report server statistics to a client.
546 * @param cptr Client who wants statistics.
547 * @param sd StatDesc structure being looked up (unused).
548 * @param param Extra parameter passed by user (unused).
550 void tstats(struct Client *cptr, const struct StatDesc *sd, char *param)
552 struct Client *acptr;
554 struct ServerStatistics *sp;
555 struct ServerStatistics tmp;
558 memcpy(sp, ServerStats, sizeof(struct ServerStatistics));
559 for (i = 0; i < MAXCONNECTIONS; i++)
561 if (!(acptr = LocalClientArray[i]))
565 sp->is_sbs += cli_sendB(acptr);
566 sp->is_sbr += cli_receiveB(acptr);
567 sp->is_sti += CurrentTime - cli_firsttime(acptr);
570 else if (IsUser(acptr))
572 sp->is_cbs += cli_sendB(acptr);
573 sp->is_cbr += cli_receiveB(acptr);
574 sp->is_cti += CurrentTime - cli_firsttime(acptr);
577 else if (IsUnknown(acptr))
581 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":accepts %u refused %u",
582 sp->is_ac, sp->is_ref);
583 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
584 ":unknown commands %u prefixes %u", sp->is_unco, sp->is_unpf);
585 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
586 ":nick collisions %u unknown closes %u", sp->is_kill, sp->is_ni);
587 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
588 ":wrong direction %u empty %u", sp->is_wrdi, sp->is_empt);
589 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
590 ":numerics seen %u mode fakes %u", sp->is_num, sp->is_fake);
591 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG,
592 ":auth successes %u fails %u", sp->is_asuc, sp->is_abad);
593 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":local connections %u",
595 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":Client server");
596 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":connected %u %u",
597 sp->is_cl, sp->is_sv);
598 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":bytes sent %Lu %Lu",
599 sp->is_cbs, sp->is_sbs);
600 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":bytes recv %Lu %Lu",
601 sp->is_cbr, sp->is_sbr);
602 send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":time connected %Lu %Lu",
603 sp->is_cti, sp->is_sti);