]>
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 2005/07/15 03:02:50 entrope Exp $
35 #include "ircd_alloc.h"
36 #include "ircd_auth.h"
37 #include "ircd_features.h"
39 #include "ircd_reply.h"
40 #include "ircd_snprintf.h"
41 #include "ircd_string.h"
48 #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
));
269 if (IsIAuthed(bcptr
) || cli_iauth(bcptr
))
270 iauth_exit_client(bcptr
);
273 /* Remove bcptr from the client list */
275 if (hRemClient(bcptr
) != 0)
276 Debug((DEBUG_ERROR
, "%p !in tab %s[%s] %p %p %p %d %d %p",
277 bcptr
, cli_name(bcptr
), cli_from(bcptr
) ? cli_sockhost(cli_from(bcptr
)) : "??host",
278 cli_from(bcptr
), cli_next(bcptr
), cli_prev(bcptr
), cli_fd(bcptr
),
279 cli_status(bcptr
), cli_user(bcptr
)));
283 remove_client_from_list(bcptr
);
286 /* exit_downlinks - added by Run 25-9-94 */
288 * Removes all clients and downlinks (+clients) of any server
289 * QUITs are generated and sent to local users.
290 * @param cptr server that must have all dependents removed
291 * @param sptr source who thought that this was a good idea
292 * @param comment comment sent as sign off message to local clients
294 static void exit_downlinks(struct Client
*cptr
, struct Client
*sptr
, char *comment
)
296 struct Client
*acptr
;
299 struct Client
**acptrp
;
302 /* Run over all its downlinks */
303 for (lp
= cli_serv(cptr
)->down
; lp
; lp
= next
)
306 acptr
= lp
->value
.cptr
;
307 /* Remove the downlinks and client of the downlink */
308 exit_downlinks(acptr
, sptr
, comment
);
309 /* Remove the downlink itself */
310 exit_one_client(acptr
, cli_name(&me
));
312 /* Remove all clients of this server */
313 acptrp
= cli_serv(cptr
)->client_list
;
314 for (i
= 0; i
<= cli_serv(cptr
)->nn_mask
; ++acptrp
, ++i
) {
316 exit_one_client(*acptrp
, comment
);
320 /* exit_client, rewritten 25-9-94 by Run */
322 * Exits a client of *any* type (user, server, etc)
323 * from this server. Also, this generates all necessary prototol
324 * messages that this exit may cause.
326 * This function implicitly exits all other clients depending on
329 * For convenience, this function returns a suitable value for
330 * m_function return value:
332 * CPTR_KILLED if (cptr == bcptr)
333 * 0 if (cptr != bcptr)
335 * This function can be called in two ways:
336 * 1) From before or in parse(), exiting the 'cptr', in which case it was
337 * invoked as exit_client(cptr, cptr, &me,...), causing it to always
338 * return CPTR_KILLED.
339 * 2) Via parse from a m_function call, in which case it was invoked as
340 * exit_client(cptr, acptr, sptr, ...). Here 'sptr' is known; the client
341 * that generated the message in a way that we can assume he already
342 * did remove acptr from memory himself (or in other cases we don't mind
343 * because he will be delinked.) Or invoked as:
344 * exit_client(cptr, acptr/sptr, &me, ...) when WE decide this one should
346 * In general: No generated SQUIT or QUIT should be sent to source link
347 * sptr->from. And CPTR_KILLED should be returned if cptr got removed (too).
350 * @param cptr Connection currently being handled by read_message.
351 * @param victim Client being killed.
352 * @param killer Client that made the decision to remove \a victim.
353 * @param comment Reason for the exit.
354 * @return CPTR_KILLED if cptr == bcptr, else 0.
356 int exit_client(struct Client
*cptr
,
357 struct Client
* victim
,
358 struct Client
* killer
,
361 struct Client
* acptr
= 0;
365 char comment1
[HOSTLEN
+ HOSTLEN
+ 2];
367 if (MyConnect(victim
))
369 SetFlag(victim
, FLAG_CLOSING
);
371 if (feature_bool(FEAT_CONNEXIT_NOTICES
) && IsUser(victim
))
372 sendto_opmask_butone(0, SNO_CONNEXIT
,
373 "Client exiting: %s (%s@%s) [%s] [%s] <%s%s>",
374 cli_name(victim
), cli_user(victim
)->username
,
375 cli_user(victim
)->host
, comment
,
376 ircd_ntoa(&cli_ip(victim
)),
377 NumNick(victim
) /* two %s's */);
380 on_for
= CurrentTime
- cli_firsttime(victim
);
383 log_write(LS_USER
, L_TRACE
, 0, "%Tu %i %s@%s %s %s %s%s %s :%s",
384 cli_firsttime(victim
), on_for
,
385 cli_user(victim
)->username
, cli_sockhost(victim
),
386 ircd_ntoa(&cli_ip(victim
)),
387 IsAccount(victim
) ? cli_username(victim
) : "0",
388 NumNick(victim
), /* two %s's */
389 cli_name(victim
), cli_info(victim
));
391 if (victim
!= cli_from(killer
) /* The source knows already */
392 && IsClient(victim
)) /* Not a Ping struct or Log file */
394 if (IsServer(victim
) || IsHandshake(victim
))
395 sendcmdto_one(killer
, CMD_SQUIT
, victim
, "%s 0 :%s", cli_name(&me
), comment
);
396 else if (!IsConnecting(victim
)) {
397 if (!IsDead(victim
)) {
398 if (IsServer(victim
))
399 sendcmdto_one(killer
, CMD_ERROR
, victim
,
400 ":Closing Link: %s by %s (%s)", cli_name(victim
),
401 cli_name(killer
), comment
);
403 sendrawto_one(victim
, MSG_ERROR
" :Closing Link: %s by %s (%s)",
405 cli_name(IsServer(killer
) ? &his
: killer
),
409 if ((IsServer(victim
) || IsHandshake(victim
) || IsConnecting(victim
)) &&
410 (killer
== &me
|| (IsServer(killer
) &&
411 (strncmp(comment
, "Leaf-only link", 14) ||
412 strncmp(comment
, "Non-Hub link", 12)))))
415 * Note: check user == user needed to make sure we have the same
418 if (cli_serv(victim
)->user
&& *(cli_serv(victim
))->by
&&
419 (acptr
= findNUser(cli_serv(victim
)->by
))) {
420 if (cli_user(acptr
) == cli_serv(victim
)->user
) {
421 sendcmdto_one(&me
, CMD_NOTICE
, acptr
,
422 "%C :Link with %s canceled: %s", acptr
,
423 cli_name(victim
), comment
);
427 * not right client, set by to empty string
430 *(cli_serv(victim
))->by
= '\0';
434 sendto_opmask_butone(acptr
, SNO_OLDSNO
, "Link with %s canceled: %s",
435 cli_name(victim
), comment
);
439 * Close the Client connection first.
441 close_connection(victim
);
444 if (IsServer(victim
))
446 if (feature_bool(FEAT_HIS_NETSPLIT
))
447 strcpy(comment1
, "*.net *.split");
450 strcpy(comment1
, cli_name(cli_serv(victim
)->up
));
451 strcat(comment1
, " ");
452 strcat(comment1
, cli_name(victim
));
456 sendto_opmask_butone(killer
, SNO_OLDSNO
, "%s SQUIT by %s [%s]:",
457 (cli_user(killer
)->server
== victim
||
458 cli_user(killer
)->server
== cli_serv(victim
)->up
) ?
460 get_client_name(killer
, HIDE_IP
),
461 cli_name(cli_user(killer
)->server
));
462 else if (killer
!= &me
&& cli_serv(victim
)->up
!= killer
)
463 sendto_opmask_butone(0, SNO_OLDSNO
, "Received SQUIT %s from %s :",
464 cli_name(victim
), IsServer(killer
) ? cli_name(killer
) :
465 get_client_name(killer
, HIDE_IP
));
466 sendto_opmask_butone(0, SNO_NETWORK
, "Net break: %C %C (%s)",
467 cli_serv(victim
)->up
, victim
, comment
);
471 * First generate the needed protocol for the other server links
474 for (dlp
= cli_serv(&me
)->down
; dlp
; dlp
= dlp
->next
) {
475 if (dlp
->value
.cptr
!= cli_from(killer
) && dlp
->value
.cptr
!= victim
)
477 if (IsServer(victim
))
478 sendcmdto_one(killer
, CMD_SQUIT
, dlp
->value
.cptr
, "%s %Tu :%s",
479 cli_name(victim
), cli_serv(victim
)->timestamp
, comment
);
480 else if (IsUser(victim
) && !HasFlag(victim
, FLAG_KILLED
))
481 sendcmdto_one(victim
, CMD_QUIT
, dlp
->value
.cptr
, ":%s", comment
);
484 /* Then remove the client structures */
485 if (IsServer(victim
))
486 exit_downlinks(victim
, killer
, comment1
);
487 exit_one_client(victim
, comment
);
490 * cptr can only have been killed if it was cptr itself that got killed here,
491 * because cptr can never have been a dependent of victim --Run
493 return (cptr
== victim
) ? CPTR_KILLED
: 0;
497 * Exit client with formatted va_list message.
498 * Thin wrapper around exit_client().
499 * @param cptr Connection being processed.
500 * @param bcptr Connection being closed.
501 * @param sptr Connection who asked to close the victim.
502 * @param pattern Format string for message.
503 * @param vl Stdargs argument list.
504 * @return Has a tail call to exit_client().
506 /* added 25-9-94 by Run */
507 int vexit_client_msg(struct Client
*cptr
, struct Client
*bcptr
, struct Client
*sptr
,
508 const char *pattern
, va_list vl
)
511 ircd_vsnprintf(0, msgbuf
, sizeof(msgbuf
), pattern
, vl
);
512 return exit_client(cptr
, bcptr
, sptr
, msgbuf
);
516 * Exit client with formatted message using a variable-length argument list.
517 * Thin wrapper around exit_client().
518 * @param cptr Connection being processed.
519 * @param bcptr Connection being closed.
520 * @param sptr Connection who asked to close the victim.
521 * @param pattern Format string for message.
522 * @return Has a tail call to exit_client().
524 int exit_client_msg(struct Client
*cptr
, struct Client
*bcptr
,
525 struct Client
*sptr
, const char *pattern
, ...)
530 va_start(vl
, pattern
);
531 ircd_vsnprintf(0, msgbuf
, sizeof(msgbuf
), pattern
, vl
);
534 return exit_client(cptr
, bcptr
, sptr
, msgbuf
);
537 /** Initialize global server statistics. */
538 /* (Kind of pointless since C guarantees it's already zero'ed, but... */
541 memset(&ircst
, 0, sizeof(ircst
));
544 /** Report server statistics to a client.
545 * @param cptr Client who wants statistics.
546 * @param sd StatDesc structure being looked up (unused).
547 * @param param Extra parameter passed by user (unused).
549 void tstats(struct Client
*cptr
, const struct StatDesc
*sd
, char *param
)
551 struct Client
*acptr
;
553 struct ServerStatistics
*sp
;
554 struct ServerStatistics tmp
;
557 memcpy(sp
, ServerStats
, sizeof(struct ServerStatistics
));
558 for (i
= 0; i
< MAXCONNECTIONS
; i
++)
560 if (!(acptr
= LocalClientArray
[i
]))
564 sp
->is_sbs
+= cli_sendB(acptr
);
565 sp
->is_sbr
+= cli_receiveB(acptr
);
566 sp
->is_sti
+= CurrentTime
- cli_firsttime(acptr
);
569 else if (IsUser(acptr
))
571 sp
->is_cbs
+= cli_sendB(acptr
);
572 sp
->is_cbr
+= cli_receiveB(acptr
);
573 sp
->is_cti
+= CurrentTime
- cli_firsttime(acptr
);
576 else if (IsUnknown(acptr
))
580 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":accepts %u refused %u",
581 sp
->is_ac
, sp
->is_ref
);
582 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
583 ":unknown commands %u prefixes %u", sp
->is_unco
, sp
->is_unpf
);
584 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
585 ":nick collisions %u unknown closes %u", sp
->is_kill
, sp
->is_ni
);
586 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
587 ":wrong direction %u empty %u", sp
->is_wrdi
, sp
->is_empt
);
588 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
589 ":numerics seen %u mode fakes %u", sp
->is_num
, sp
->is_fake
);
590 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
,
591 ":auth successes %u fails %u", sp
->is_asuc
, sp
->is_abad
);
592 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":local connections %u",
594 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":Client server");
595 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":connected %u %u",
596 sp
->is_cl
, sp
->is_sv
);
597 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":bytes sent %Lu %Lu",
598 sp
->is_cbs
, sp
->is_sbs
);
599 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":bytes recv %Lu %Lu",
600 sp
->is_cbr
, sp
->is_sbr
);
601 send_reply(cptr
, SND_EXPLICIT
| RPL_STATSDEBUG
, ":time connected %Lu %Lu",
602 sp
->is_cti
, sp
->is_sti
);