]>
jfr.im git - irc/quakenet/snircd.git/blob - ircd/s_misc.c
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,v 1.50.2.2 2007/07/14 02:40:01 isomer Exp $
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 assert(UserStats
.inv_clients
> 0);
228 --UserStats
.inv_clients
;
231 assert(UserStats
.opers
> 0);
234 if (MyConnect(bcptr
))
235 Count_clientdisconnects(bcptr
, UserStats
);
237 Count_remoteclientquits(UserStats
, bcptr
);
239 else if (IsServer(bcptr
))
241 /* Remove downlink list node of uplink */
242 remove_dlink(&(cli_serv(cli_serv(bcptr
)->up
))->down
, cli_serv(bcptr
)->updown
);
243 cli_serv(bcptr
)->updown
= 0;
245 if (MyConnect(bcptr
))
246 Count_serverdisconnects(UserStats
);
248 Count_remoteserverquits(UserStats
);
250 else if (IsMe(bcptr
))
252 sendto_opmask_butone(0, SNO_OLDSNO
, "ERROR: tried to exit me! : %s",
254 return; /* ...must *never* exit self! */
256 else if (IsUnknown(bcptr
) || IsConnecting(bcptr
) || IsHandshake(bcptr
))
257 Count_unknowndisconnects(UserStats
);
262 if (IsIPChecked(bcptr
))
263 IPcheck_disconnect(bcptr
);
266 * Remove from serv->client_list
267 * NOTE: user is *always* NULL if this is a server
269 if (cli_user(bcptr
)) {
270 assert(!IsServer(bcptr
));
271 /* bcptr->user->server->serv->client_list[IndexYXX(bcptr)] = NULL; */
272 RemoveYXXClient(cli_user(bcptr
)->server
, cli_yxx(bcptr
));
275 /* Remove bcptr from the client list */
277 if (hRemClient(bcptr
) != 0)
278 Debug((DEBUG_ERROR
, "%p !in tab %s[%s] %p %p %p %d %d %p",
279 bcptr
, cli_name(bcptr
), cli_from(bcptr
) ? cli_sockhost(cli_from(bcptr
)) : "??host",
280 cli_from(bcptr
), cli_next(bcptr
), cli_prev(bcptr
), cli_fd(bcptr
),
281 cli_status(bcptr
), cli_user(bcptr
)));
285 remove_client_from_list(bcptr
);
288 /* exit_downlinks - added by Run 25-9-94 */
290 * Removes all clients and downlinks (+clients) of any server
291 * QUITs are generated and sent to local users.
292 * @param cptr server that must have all dependents removed
293 * @param sptr source who thought that this was a good idea
294 * @param comment comment sent as sign off message to local clients
296 static void exit_downlinks(struct Client
*cptr
, struct Client
*sptr
, char *comment
)
298 struct Client
*acptr
;
301 struct Client
**acptrp
;
304 /* Run over all its downlinks */
305 for (lp
= cli_serv(cptr
)->down
; lp
; lp
= next
)
308 acptr
= lp
->value
.cptr
;
309 /* Remove the downlinks and client of the downlink */
310 exit_downlinks(acptr
, sptr
, comment
);
311 /* Remove the downlink itself */
312 exit_one_client(acptr
, cli_name(&me
));
314 /* Remove all clients of this server */
315 acptrp
= cli_serv(cptr
)->client_list
;
316 for (i
= 0; i
<= cli_serv(cptr
)->nn_mask
; ++acptrp
, ++i
) {
318 exit_one_client(*acptrp
, comment
);
322 /* exit_client, rewritten 25-9-94 by Run */
324 * Exits a client of *any* type (user, server, etc)
325 * from this server. Also, this generates all necessary prototol
326 * messages that this exit may cause.
328 * This function implicitly exits all other clients depending on
331 * For convenience, this function returns a suitable value for
332 * m_function return value:
334 * CPTR_KILLED if (cptr == bcptr)
335 * 0 if (cptr != bcptr)
337 * This function can be called in two ways:
338 * 1) From before or in parse(), exiting the 'cptr', in which case it was
339 * invoked as exit_client(cptr, cptr, &me,...), causing it to always
340 * return CPTR_KILLED.
341 * 2) Via parse from a m_function call, in which case it was invoked as
342 * exit_client(cptr, acptr, sptr, ...). Here 'sptr' is known; the client
343 * that generated the message in a way that we can assume he already
344 * did remove acptr from memory himself (or in other cases we don't mind
345 * because he will be delinked.) Or invoked as:
346 * exit_client(cptr, acptr/sptr, &me, ...) when WE decide this one should
348 * In general: No generated SQUIT or QUIT should be sent to source link
349 * sptr->from. And CPTR_KILLED should be returned if cptr got removed (too).
352 * @param cptr Connection currently being handled by read_message.
353 * @param victim Client being killed.
354 * @param killer Client that made the decision to remove \a victim.
355 * @param comment Reason for the exit.
356 * @return CPTR_KILLED if cptr == bcptr, else 0.
358 int exit_client(struct Client
*cptr
,
359 struct Client
* victim
,
360 struct Client
* killer
,
363 struct Client
* acptr
= 0;
367 char comment1
[HOSTLEN
+ HOSTLEN
+ 2];
369 if (MyConnect(victim
))
371 SetFlag(victim
, FLAG_CLOSING
);
373 if (feature_bool(FEAT_CONNEXIT_NOTICES
) && IsUser(victim
))
374 sendto_opmask_butone(0, SNO_CONNEXIT
,
375 "Client exiting: %s (%s@%s) [%s] [%s] <%s%s>",
376 cli_name(victim
), cli_user(victim
)->username
,
377 cli_user(victim
)->host
, comment
,
378 ircd_ntoa(&cli_ip(victim
)),
379 NumNick(victim
) /* two %s's */);
382 on_for
= CurrentTime
- cli_firsttime(victim
);
384 if (IsUser(victim
) || IsUserPort(victim
))
385 auth_send_exit(victim
);
388 log_write(LS_USER
, L_TRACE
, 0, "%Tu %i %s@%s %s %s %s%s %s :%s",
389 cli_firsttime(victim
), on_for
,
390 cli_user(victim
)->username
, cli_sockhost(victim
),
391 ircd_ntoa(&cli_ip(victim
)),
392 IsAccount(victim
) ? cli_username(victim
) : "0",
393 NumNick(victim
), /* two %s's */
394 cli_name(victim
), cli_info(victim
));
396 if (victim
!= cli_from(killer
) /* The source knows already */
397 && IsClient(victim
)) /* Not a Ping struct or Log file */
399 if (IsServer(victim
) || IsHandshake(victim
))
400 sendcmdto_one(killer
, CMD_SQUIT
, victim
, "%s 0 :%s", cli_name(&me
), comment
);
401 else if (!IsConnecting(victim
)) {
402 if (!IsDead(victim
)) {
403 if (IsServer(victim
))
404 sendcmdto_one(killer
, CMD_ERROR
, victim
,
405 ":Closing Link: %s by %s (%s)", cli_name(victim
),
406 cli_name(killer
), comment
);
408 sendrawto_one(victim
, MSG_ERROR
" :Closing Link: %s by %s (%s)",
410 cli_name(IsServer(killer
) ? &his
: killer
),
414 if ((IsServer(victim
) || IsHandshake(victim
) || IsConnecting(victim
)) &&
415 (killer
== &me
|| (IsServer(killer
) &&
416 (strncmp(comment
, "Leaf-only link", 14) ||
417 strncmp(comment
, "Non-Hub link", 12)))))
420 * Note: check user == user needed to make sure we have the same
423 if (cli_serv(victim
)->user
&& *(cli_serv(victim
))->by
&&
424 (acptr
= findNUser(cli_serv(victim
)->by
))) {
425 if (cli_user(acptr
) == cli_serv(victim
)->user
) {
426 sendcmdto_one(&me
, CMD_NOTICE
, acptr
,
427 "%C :Link with %s canceled: %s", acptr
,
428 cli_name(victim
), comment
);
432 * not right client, set by to empty string
435 *(cli_serv(victim
))->by
= '\0';
439 sendto_opmask_butone(acptr
, SNO_OLDSNO
, "Link with %s canceled: %s",
440 cli_name(victim
), comment
);
444 * Close the Client connection first.
446 close_connection(victim
);
449 if (IsServer(victim
))
451 if (feature_bool(FEAT_HIS_NETSPLIT
))
452 strcpy(comment1
, "*.net *.split");
455 strcpy(comment1
, cli_name(cli_serv(victim
)->up
));
456 strcat(comment1
, " ");
457 strcat(comment1
, cli_name(victim
));
461 sendto_opmask_butone(killer
, SNO_OLDSNO
, "%s SQUIT by %s [%s]:",
462 (cli_user(killer
)->server
== victim
||
463 cli_user(killer
)->server
== cli_serv(victim
)->up
) ?
465 get_client_name(killer
, HIDE_IP
),
466 cli_name(cli_user(killer
)->server
));
467 else if (killer
!= &me
&& cli_serv(victim
)->up
!= killer
)
468 sendto_opmask_butone(0, SNO_OLDSNO
, "Received SQUIT %s from %s :",
469 cli_name(victim
), IsServer(killer
) ? cli_name(killer
) :
470 get_client_name(killer
, HIDE_IP
));
471 sendto_opmask_butone(0, SNO_NETWORK
, "Net break: %C %C (%s)",
472 cli_serv(victim
)->up
, victim
, comment
);
476 * First generate the needed protocol for the other server links
479 for (dlp
= cli_serv(&me
)->down
; dlp
; dlp
= dlp
->next
) {
480 if (dlp
->value
.cptr
!= cli_from(killer
) && dlp
->value
.cptr
!= victim
)
482 if (IsServer(victim
))
483 sendcmdto_one(killer
, CMD_SQUIT
, dlp
->value
.cptr
, "%s %Tu :%s",
484 cli_name(victim
), cli_serv(victim
)->timestamp
, comment
);
485 else if (IsUser(victim
) && !HasFlag(victim
, FLAG_KILLED
))
486 sendcmdto_one(victim
, CMD_QUIT
, dlp
->value
.cptr
, ":%s", comment
);
489 /* Then remove the client structures */
490 if (IsServer(victim
))
491 exit_downlinks(victim
, killer
, comment1
);
493 if (strncmp(comment
, "G-lined", 7))
494 exit_one_client(victim
, comment
);
496 exit_one_client(victim
, "G-lined");
499 * cptr can only have been killed if it was cptr itself that got killed here,
500 * because cptr can never have been a dependent of victim --Run
502 return (cptr
== victim
) ? CPTR_KILLED
: 0;
506 * Exit client with formatted va_list message.
507 * Thin wrapper around exit_client().
508 * @param cptr Connection being processed.
509 * @param bcptr Connection being closed.
510 * @param sptr Connection who asked to close the victim.
511 * @param pattern Format string for message.
512 * @param vl Stdargs argument list.
513 * @return Has a tail call to exit_client().
515 /* added 25-9-94 by Run */
516 int vexit_client_msg(struct Client
*cptr
, struct Client
*bcptr
, struct Client
*sptr
,
517 const char *pattern
, va_list vl
)
520 ircd_vsnprintf(0, msgbuf
, sizeof(msgbuf
), pattern
, vl
);
521 return exit_client(cptr
, bcptr
, sptr
, msgbuf
);
525 * Exit client with formatted message using a variable-length argument list.
526 * Thin wrapper around exit_client().
527 * @param cptr Connection being processed.
528 * @param bcptr Connection being closed.
529 * @param sptr Connection who asked to close the victim.
530 * @param pattern Format string for message.
531 * @return Has a tail call to exit_client().
533 int exit_client_msg(struct Client
*cptr
, struct Client
*bcptr
,
534 struct Client
*sptr
, const char *pattern
, ...)
539 va_start(vl
, pattern
);
540 ircd_vsnprintf(0, msgbuf
, sizeof(msgbuf
), pattern
, vl
);
543 return exit_client(cptr
, bcptr
, sptr
, msgbuf
);
546 /** Initialize global server statistics. */
547 /* (Kind of pointless since C guarantees it's already zero'ed, but... */
550 memset(&ircst
, 0, sizeof(ircst
));
553 /** Report server statistics to a client.
554 * @param cptr Client who wants statistics.
555 * @param sd StatDesc structure being looked up (unused).
556 * @param param Extra parameter passed by user (unused).
558 void tstats(struct Client
*cptr
, const struct StatDesc
*sd
, char *param
)
560 struct Client
*acptr
;
562 struct ServerStatistics
*sp
;
563 struct ServerStatistics tmp
;
566 memcpy(sp
, ServerStats
, sizeof(struct ServerStatistics
));
567 for (i
= 0; i
< MAXCONNECTIONS
; i
++)
569 if (!(acptr
= LocalClientArray
[i
]))
573 sp
->is_sbs
+= cli_sendB(acptr
);
574 sp
->is_sbr
+= cli_receiveB(acptr
);
575 sp
->is_sti
+= CurrentTime
- cli_firsttime(acptr
);
578 else if (IsUser(acptr
))
580 sp
->is_cbs
+= cli_sendB(acptr
);
581 sp
->is_cbr
+= cli_receiveB(acptr
);
582 sp
->is_cti
+= CurrentTime
- cli_firsttime(acptr
);
585 else if (IsUnknown(acptr
))
589 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":accepts %u refused %u",
590 sp
->is_ac
, sp
->is_ref
);
591 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
592 ":unknown commands %u prefixes %u", sp
->is_unco
, sp
->is_unpf
);
593 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
594 ":nick collisions %u unknown closes %u", sp
->is_kill
, sp
->is_ni
);
595 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
596 ":wrong direction %u empty %u", sp
->is_wrdi
, sp
->is_empt
);
597 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
598 ":numerics seen %u mode fakes %u", sp
->is_num
, sp
->is_fake
);
599 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
600 ":auth successes %u fails %u", sp
->is_asuc
, sp
->is_abad
);
601 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":local connections %u",
603 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":Client server");
604 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":connected %u %u",
605 sp
->is_cl
, sp
->is_sv
);
606 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":bytes sent %Lu %Lu",
607 sp
->is_cbs
, sp
->is_sbs
);
608 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":bytes recv %Lu %Lu",
609 sp
->is_cbr
, sp
->is_sbr
);
610 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":time connected %Lu %Lu",
611 sp
->is_cti
, sp
->is_sti
);