2 * ircd-ratbox: A slightly useful ircd.
3 * m_info.c: Sends information about the server.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2005 ircd-ratbox development team
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 2 of the License, or
12 * (at your option) any later version.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
42 static const char info_desc
[] =
43 "Provides the INFO command for retrieving server copyright, credits, and other info";
45 static void send_conf_options(struct Client
*source_p
);
46 static void send_birthdate_online_time(struct Client
*source_p
);
47 static void send_info_text(struct Client
*source_p
);
48 static void info_spy(struct Client
*);
50 static void m_info(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
51 static void mo_info(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
53 struct Message info_msgtab
= {
55 {mg_unreg
, {m_info
, 0}, {mo_info
, 0}, mg_ignore
, mg_ignore
, {mo_info
, 0}}
60 mapi_clist_av1 info_clist
[] = { &info_msgtab
, NULL
};
61 mapi_hlist_av1 info_hlist
[] = {
62 { "doing_info", &doing_info_hook
},
66 DECLARE_MODULE_AV2(info
, NULL
, NULL
, info_clist
, info_hlist
, NULL
, NULL
, NULL
, info_desc
);
69 * jdc -- Structure for our configuration value table
73 const char *name
; /* Displayed variable name */
74 unsigned int output_type
; /* See below #defines */
75 void *option
; /* Pointer reference to the value */
76 const char *desc
; /* ASCII description of the variable */
78 /* Types for output_type in InfoStruct */
79 #define OUTPUT_STRING 0x0001 /* Output option as %s w/ dereference */
80 #define OUTPUT_STRING_PTR 0x0002 /* Output option as %s w/out deference */
81 #define OUTPUT_DECIMAL 0x0004 /* Output option as decimal (%d) */
82 #define OUTPUT_BOOLEAN 0x0008 /* Output option as "ON" or "OFF" */
83 #define OUTPUT_BOOLEAN_YN 0x0010 /* Output option as "YES" or "NO" */
84 #define OUTPUT_BOOLEAN2 0x0020 /* Output option as "YES/NO/MASKED" */
87 static struct InfoStruct info_table
[] = {
88 /* --[ START OF TABLE ]-------------------------------------------- */
90 "opers_see_all_users",
93 "Farconnect notices available or operspy accountability limited"
99 "Max number connections"
104 &ConfigFileEntry
.anti_nick_flood
,
105 "NICK flood protection"
108 "anti_spam_exit_message_time",
110 &ConfigFileEntry
.anti_spam_exit_message_time
,
111 "Duration a client must be connected for to have an exit message"
116 &ConfigFileEntry
.caller_id_wait
,
117 "Minimum delay between notifying UMODE +g users of messages"
122 &ConfigFileEntry
.client_exit
,
123 "Prepend 'Quit:' to user QUIT messages"
126 "client_flood_max_lines",
128 &ConfigFileEntry
.client_flood_max_lines
,
129 "Number of lines before a client Excess Flood's",
132 "client_flood_burst_rate",
134 &ConfigFileEntry
.client_flood_burst_rate
,
135 "Maximum lines per second during flood grace period",
138 "client_flood_burst_max",
140 &ConfigFileEntry
.client_flood_burst_max
,
141 "Number of lines to process at once before delaying",
144 "client_flood_message_num",
146 &ConfigFileEntry
.client_flood_message_num
,
147 "Number of messages to allow per client_flood_message_time outside of burst",
150 "client_flood_message_time",
152 &ConfigFileEntry
.client_flood_message_time
,
153 "Time to allow per client_flood_message_num outside of burst",
158 &ConfigFileEntry
.connect_timeout
,
159 "Connect timeout for connections to servers"
162 "default_ident_timeout",
164 &ConfigFileEntry
.default_ident_timeout
,
165 "Amount of time the server waits for ident responses from clients",
168 "default_floodcount",
170 &ConfigFileEntry
.default_floodcount
,
171 "Startup value of FLOODCOUNT",
174 "default_adminstring",
176 &ConfigFileEntry
.default_adminstring
,
177 "Default adminstring at startup.",
180 "default_operstring",
182 &ConfigFileEntry
.default_operstring
,
183 "Default operstring at startup.",
188 &ConfigFileEntry
.servicestring
,
189 "String shown in whois for opered services.",
194 &ConfigFileEntry
.disable_auth
,
195 "Controls whether auth checking is disabled or not"
198 "disable_fake_channels",
200 &ConfigFileEntry
.disable_fake_channels
,
201 "Controls whether bold etc are disabled for JOIN"
206 &ConfigFileEntry
.dots_in_ident
,
207 "Number of permissable dots in an ident"
210 "failed_oper_notice",
212 &ConfigFileEntry
.failed_oper_notice
,
213 "Inform opers if someone /oper's with the wrong password"
218 &ConfigFileEntry
.fname_userlog
,
224 &ConfigFileEntry
.fname_fuserlog
,
225 "Failed user log file"
231 &ConfigFileEntry
.fname_operlog
,
237 &ConfigFileEntry
.fname_foperlog
,
238 "Failed operator log file"
243 &ConfigFileEntry
.fname_serverlog
,
244 "Server connect/disconnect log file"
249 &ConfigFileEntry
.fname_killlog
,
255 &ConfigFileEntry
.fname_klinelog
,
261 &ConfigFileEntry
.fname_operspylog
,
267 &ConfigFileEntry
.fname_ioerrorlog
,
273 &ConfigFileEntry
.global_snotices
,
274 "Send out certain server notices globally"
277 "hide_error_messages",
279 &ConfigFileEntry
.hide_error_messages
,
280 "Hide ERROR messages coming from servers"
285 &ConfigFileEntry
.hide_spoof_ips
,
286 "Hide IPs of spoofed users"
291 &ConfigFileEntry
.kline_delay
,
292 "Duration of time to delay kline checking"
297 &ConfigFileEntry
.kline_reason
,
298 "K-lined clients sign off with this reason"
303 &ConfigFileEntry
.dline_with_reason
,
304 "Display D-line reason to client on disconnect"
309 &ConfigFileEntry
.kline_with_reason
,
310 "Display K-line reason to client on disconnect"
315 &ConfigFileEntry
.max_accept
,
316 "Maximum nicknames on accept list",
321 &ConfigFileEntry
.max_nick_changes
,
322 "NICK change threshhold setting"
327 &ConfigFileEntry
.max_nick_time
,
328 "NICK flood protection time interval"
333 &ConfigFileEntry
.max_targets
,
334 "The maximum number of PRIVMSG/NOTICE targets"
339 &ConfigFileEntry
.min_nonwildcard
,
340 "Minimum non-wildcard chars in K lines",
343 "min_nonwildcard_simple",
345 &ConfigFileEntry
.min_nonwildcard_simple
,
346 "Minimum non-wildcard chars in xlines/resvs",
351 &ServerInfo
.network_name
,
357 &ConfigFileEntry
.nick_delay
,
358 "Delay nicks are locked for on split",
363 &ConfigFileEntry
.no_oper_flood
,
364 "Disable flood control for operators",
367 "non_redundant_klines",
369 &ConfigFileEntry
.non_redundant_klines
,
370 "Check for and disallow redundant K-lines"
373 "operspy_admin_only",
375 &ConfigFileEntry
.operspy_admin_only
,
376 "Send +Z operspy notices to admins only"
379 "operspy_dont_care_user_info",
381 &ConfigFileEntry
.operspy_dont_care_user_info
,
382 "Remove accountability and some '!' requirement from non-channel operspy"
387 &ConfigFileEntry
.pace_wait
,
388 "Minimum delay between uses of certain commands"
393 &ConfigFileEntry
.pace_wait_simple
,
394 "Minimum delay between less intensive commands"
399 &ConfigFileEntry
.ping_cookie
,
400 "Require ping cookies to connect",
403 "reject_after_count",
405 &ConfigFileEntry
.reject_after_count
,
406 "Client rejection threshold setting",
411 &ConfigFileEntry
.reject_ban_time
,
412 "Client rejection time interval",
417 &ConfigFileEntry
.reject_duration
,
418 "Client rejection cache duration",
423 &ConfigFileEntry
.short_motd
,
424 "Do not show MOTD; only tell clients they should read it"
429 &ConfigFileEntry
.stats_e_disabled
,
430 "STATS e output is disabled",
435 &ConfigFileEntry
.stats_c_oper_only
,
436 "STATS C output is only shown to operators",
441 &ConfigFileEntry
.stats_h_oper_only
,
442 "STATS H output is only shown to operators",
447 &ConfigFileEntry
.stats_i_oper_only
,
448 "STATS I output is only shown to operators",
453 &ConfigFileEntry
.stats_k_oper_only
,
454 "STATS K output is only shown to operators",
459 &ConfigFileEntry
.stats_o_oper_only
,
460 "STATS O output is only shown to operators",
465 &ConfigFileEntry
.stats_P_oper_only
,
466 "STATS P is only shown to operators",
471 &ConfigFileEntry
.stats_y_oper_only
,
472 "STATS Y is only shown to operators",
477 &ConfigFileEntry
.throttle_count
,
478 "Connection throttle threshold",
483 &ConfigFileEntry
.throttle_duration
,
484 "Connection throttle duration",
487 "tkline_expire_notices",
489 &ConfigFileEntry
.tkline_expire_notices
,
490 "Notices given to opers when tklines expire"
495 &ConfigFileEntry
.ts_max_delta
,
496 "Maximum permitted TS delta from another server"
501 &ConfigFileEntry
.ts_warn_delta
,
502 "Maximum permitted TS delta before displaying a warning"
507 &ConfigFileEntry
.warn_no_nline
,
508 "Display warning if connecting server lacks connect block"
511 "use_propagated_bans",
513 &ConfigFileEntry
.use_propagated_bans
,
514 "KLINE sets fully propagated bans"
517 "max_ratelimit_tokens",
519 &ConfigFileEntry
.max_ratelimit_tokens
,
520 "The maximum number of tokens that can be accumulated for executing rate-limited commands",
525 &ConfigFileEntry
.away_interval
,
526 "The minimum time between aways",
529 "default_split_server_count",
531 &ConfigChannel
.default_split_server_count
,
532 "Startup value of SPLITNUM",
535 "default_split_user_count",
537 &ConfigChannel
.default_split_user_count
,
538 "Startup value of SPLITUSERS",
543 &ConfigChannel
.knock_delay
,
544 "Delay between a users KNOCK attempts"
547 "knock_delay_channel",
549 &ConfigChannel
.knock_delay_channel
,
550 "Delay between KNOCK attempts to a channel",
553 "kick_on_split_riding",
555 &ConfigChannel
.kick_on_split_riding
,
556 "Kick users riding splits to join +i or +k channels"
559 "disable_local_channels",
561 &ConfigChannel
.disable_local_channels
,
562 "Disable local channels (&channels)"
567 &ConfigChannel
.max_bans
,
568 "Total +b/e/I/q modes allowed in a channel",
573 &ConfigChannel
.max_bans_large
,
574 "Total +b/e/I/q modes allowed in a +L channel",
577 "max_chans_per_user",
579 &ConfigChannel
.max_chans_per_user
,
580 "Maximum number of channels a user can join",
583 "max_chans_per_user_large",
585 &ConfigChannel
.max_chans_per_user_large
,
586 "Maximum extended number of channels a user can join",
589 "no_create_on_split",
591 &ConfigChannel
.no_create_on_split
,
592 "Disallow creation of channels when split",
597 &ConfigChannel
.no_join_on_split
,
598 "Disallow joining channels when split",
601 "only_ascii_channels",
603 &ConfigChannel
.only_ascii_channels
,
604 "Controls whether non-ASCII is disabled for JOIN"
609 &ConfigChannel
.use_except
,
610 "Enable chanmode +e (ban exceptions)",
615 &ConfigChannel
.use_invex
,
616 "Enable chanmode +I (invite exceptions)",
621 &ConfigChannel
.use_forward
,
622 "Enable chanmode +f (channel forwarding)",
627 &ConfigChannel
.use_knock
,
633 &ConfigChannel
.resv_forcepart
,
634 "Force-part local users on channel RESV"
639 &ConfigServerHide
.disable_hidden
,
640 "Prevent servers from hiding themselves from a flattened /links",
645 &ConfigServerHide
.flatten_links
,
646 "Flatten /links list",
651 &ConfigServerHide
.hidden
,
652 "Hide this server from a flattened /links on remote servers",
657 &ConfigServerHide
.links_delay
,
660 /* --[ END OF TABLE ]---------------------------------------------- */
661 { (char *) 0, (unsigned int) 0, (void *) 0, (char *) 0}
667 ** parv[1] = servername
670 m_info(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
672 static time_t last_used
= 0L;
674 if((last_used
+ ConfigFileEntry
.pace_wait
) > rb_current_time())
676 /* safe enough to give this on a local connect only */
677 sendto_one(source_p
, form_str(RPL_LOAD2HI
),
678 me
.name
, source_p
->name
, "INFO");
679 sendto_one_numeric(source_p
, RPL_ENDOFINFO
, form_str(RPL_ENDOFINFO
));
683 last_used
= rb_current_time();
685 if(hunt_server(client_p
, source_p
, ":%s INFO :%s", 1, parc
, parv
) != HUNTED_ISME
)
690 send_info_text(source_p
);
691 send_birthdate_online_time(source_p
);
693 sendto_one_numeric(source_p
, RPL_ENDOFINFO
, form_str(RPL_ENDOFINFO
));
698 ** parv[1] = servername
701 mo_info(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
703 if(hunt_server(client_p
, source_p
, ":%s INFO :%s", 1, parc
, parv
) == HUNTED_ISME
)
706 send_info_text(source_p
);
710 send_conf_options(source_p
);
711 sendto_one_numeric(source_p
, RPL_INFO
, ":%s",
715 send_birthdate_online_time(source_p
);
717 sendto_one_numeric(source_p
, RPL_ENDOFINFO
, form_str(RPL_ENDOFINFO
));
724 * inputs - client pointer to send info text to
726 * side effects - info text is sent to client
729 send_info_text(struct Client
*source_p
)
731 const char **text
= infotext
;
735 sendto_one_numeric(source_p
, RPL_INFO
, form_str(RPL_INFO
), *text
++);
738 sendto_one_numeric(source_p
, RPL_INFO
, form_str(RPL_INFO
), "");
742 * send_birthdate_online_time
744 * inputs - client pointer to send to
746 * side effects - birthdate and online time are sent
749 send_birthdate_online_time(struct Client
*source_p
)
751 char tbuf
[26]; /* this needs to be 26 - see ctime_r manpage */
752 sendto_one(source_p
, ":%s %d %s :Birth Date: %s, compile # %s",
753 get_id(&me
, source_p
), RPL_INFO
,
754 get_id(source_p
, source_p
), creation
, generation
);
756 sendto_one(source_p
, ":%s %d %s :On-line since %s",
757 get_id(&me
, source_p
), RPL_INFO
,
758 get_id(source_p
, source_p
), rb_ctime(startup_time
, tbuf
, sizeof(tbuf
)));
764 * inputs - client pointer to send to
766 * side effects - send config options to client
769 send_conf_options(struct Client
*source_p
)
775 * Now send them a list of all our configuration options
776 * (mostly from defaults.h)
778 for (infoptr
= MyInformation
; infoptr
->name
; infoptr
++)
780 if(infoptr
->intvalue
)
782 sendto_one(source_p
, ":%s %d %s :%-30s %-16d [%s]",
783 get_id(&me
, source_p
), RPL_INFO
,
784 get_id(source_p
, source_p
),
785 infoptr
->name
, infoptr
->intvalue
,
790 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
791 get_id(&me
, source_p
), RPL_INFO
,
792 get_id(source_p
, source_p
),
793 infoptr
->name
, infoptr
->strvalue
,
799 * Parse the info_table[] and do the magic.
801 for (i
= 0; info_table
[i
].name
; i
++)
803 switch (info_table
[i
].output_type
)
806 * For "char *" references
810 char *option
= *((char **) info_table
[i
].option
);
812 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
813 get_id(&me
, source_p
), RPL_INFO
,
814 get_id(source_p
, source_p
),
816 option
? option
: "NONE",
817 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
822 * For "char foo[]" references
824 case OUTPUT_STRING_PTR
:
826 char *option
= (char *) info_table
[i
].option
;
828 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
829 get_id(&me
, source_p
), RPL_INFO
,
830 get_id(source_p
, source_p
),
832 EmptyString(option
) ? "NONE" : option
,
833 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
838 * Output info_table[i].option as a decimal value.
842 int option
= *((int *) info_table
[i
].option
);
844 sendto_one(source_p
, ":%s %d %s :%-30s %-16d [%s]",
845 get_id(&me
, source_p
), RPL_INFO
,
846 get_id(source_p
, source_p
),
849 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
855 * Output info_table[i].option as "ON" or "OFF"
859 int option
= *((int *) info_table
[i
].option
);
861 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
862 get_id(&me
, source_p
), RPL_INFO
,
863 get_id(source_p
, source_p
),
865 option
? "ON" : "OFF",
866 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
871 * Output info_table[i].option as "YES" or "NO"
873 case OUTPUT_BOOLEAN_YN
:
875 int option
= *((int *) info_table
[i
].option
);
877 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
878 get_id(&me
, source_p
), RPL_INFO
,
879 get_id(source_p
, source_p
),
881 option
? "YES" : "NO",
882 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
887 case OUTPUT_BOOLEAN2
:
889 int option
= *((int *) info_table
[i
].option
);
891 sendto_one(source_p
, ":%s %d %s :%-30s %-16s [%s]",
892 me
.name
, RPL_INFO
, source_p
->name
,
894 option
? ((option
== 1) ? "MASK" : "YES") : "NO",
895 info_table
[i
].desc
? info_table
[i
].desc
: "<none>");
896 } /* switch (info_table[i].output_type) */
901 /* Don't send oper_only_umodes...it's a bit mask, we will have to decode it
902 ** in order for it to show up properly to opers who issue INFO
905 sendto_one_numeric(source_p
, RPL_INFO
, form_str(RPL_INFO
), "");
910 * input - pointer to client
912 * side effects - hook doing_info is called
915 info_spy(struct Client
*source_p
)
919 hd
.client
= source_p
;
920 hd
.arg1
= hd
.arg2
= NULL
;
922 call_hook(doing_info_hook
, &hd
);