2 * IRC - Internet Relay Chat, ircd/features.c
3 * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 1, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * @brief Implementation of configurable feature support.
25 #include "ircd_features.h"
26 #include "channel.h" /* list_set_default */
31 #include "ircd_alloc.h"
33 #include "ircd_reply.h"
34 #include "ircd_string.h"
40 #include "random.h" /* random_seed_set */
47 #include "sys.h" /* FALSE bleah */
48 #include "whowas.h" /* whowas_realloc */
50 /* #include <assert.h> -- Now using assert in ircd_log.h */
56 /** List of log output types that can be set */
57 static struct LogTypes {
58 char *type; /**< Settable name. */
59 int (*set)(const char *, const char *); /**< Function to set the value. */
60 char *(*get)(const char *); /**< Function to get the value. */
62 { "FILE", log_set_file, log_get_file },
63 { "FACILITY", log_set_facility, log_get_facility },
64 { "SNOMASK", log_set_snomask, log_get_snomask },
65 { "LEVEL", log_set_level, log_get_level },
69 /** Look up a struct LogType given the type string.
70 * @param[in] from &Client requesting type, or NULL.
71 * @param[in] type Name of log type to find.
72 * @return Pointer to the found LogType, or NULL if none was found.
74 static struct LogTypes *
75 feature_log_desc(struct Client* from, const char *type)
81 for (i = 0; logTypes[i].type; i++) /* find appropriate descriptor */
82 if (!ircd_strcmp(type, logTypes[i].type))
85 Debug((DEBUG_ERROR, "Unknown log feature type \"%s\"", type));
86 if (from) /* send an error; if from is NULL, called from conf parser */
87 send_reply(from, ERR_BADLOGTYPE, type);
89 log_write(LS_CONFIG, L_ERROR, 0, "Unknown log feature type \"%s\"", type);
91 return 0; /* not found */
94 /** Set the value of a log output type for a log subsystem.
95 * @param[in] from &Client trying to set the log type, or NULL.
96 * @param[in] fields Array of parameters to set.
97 * @param[in] count Number of parameters in \a fields.
98 * @return -1 to clear the mark, 0 to leave the mask alone, 1 to set the mask.
101 feature_log_set(struct Client* from, const char* const* fields, int count)
103 struct LogTypes *desc;
106 if (count < 2) { /* set default facility */
107 if (log_set_default(count < 1 ? 0 : fields[0])) {
108 assert(count >= 1); /* should always accept default */
110 if (from) /* send an error */
111 send_reply(from, ERR_BADLOGVALUE, fields[0]);
113 log_write(LS_CONFIG, L_ERROR, 0,
114 "Bad value \"%s\" for default facility", fields[0]);
116 return count < 1 ? -1 : 1; /* tell feature to set or clear mark */
117 } else if (!(subsys = log_canon(fields[0]))) { /* no such subsystem */
118 if (from) /* send an error */
119 send_reply(from, ERR_BADLOGSYS, fields[0]);
121 log_write(LS_CONFIG, L_ERROR, 0,
122 "No such logging subsystem \"%s\"", fields[0]);
123 } else if ((desc = feature_log_desc(from, fields[1]))) { /* set value */
124 if ((*desc->set)(fields[0], count < 3 ? 0 : fields[2])) {
125 assert(count >= 3); /* should always accept default */
127 if (from) /* send an error */
128 send_reply(from, ERR_BADLOGVALUE, fields[2]);
130 log_write(LS_CONFIG, L_ERROR, 0,
131 "Bad value \"%s\" for log type %s (subsystem %s)",
132 fields[2], desc->type, subsys);
139 /** Reset a log type for a subsystem to its default value.
140 * @param[in] from &Client trying to reset the subsystem.
141 * @param[in] fields Array of parameters to reset.
142 * @param[in] count Number of fields in \a fields.
143 * @return -1 to unmark the entry, or zero to leave it alone.
146 feature_log_reset(struct Client* from, const char* const* fields, int count)
148 struct LogTypes *desc;
151 assert(0 != from); /* Never called by the .conf parser */
153 if (count < 1) { /* reset default facility */
155 return -1; /* unmark this entry */
156 } else if (count < 2)
157 need_more_params(from, "RESET");
158 else if (!(subsys = log_canon(fields[0]))) /* no such subsystem */
159 send_reply(from, ERR_BADLOGSYS, fields[0]);
160 else if ((desc = feature_log_desc(from, fields[1]))) /* reset value */
161 (*desc->set)(fields[0], 0); /* default should always be accepted */
166 /** Handle an update to FEAT_HIS_SERVERNAME. */
168 feature_notify_servername(void)
170 ircd_strncpy(cli_name(&his), feature_str(FEAT_HIS_SERVERNAME), HOSTLEN);
173 /** Handle an update to FEAT_HIS_SERVERINFO. */
175 feature_notify_serverinfo(void)
177 ircd_strncpy(cli_info(&his), feature_str(FEAT_HIS_SERVERINFO), REALLEN);
180 /** Report the value of a log setting.
181 * @param[in] from &Client asking for details.
182 * @param[in] fields Array of parameters to get.
183 * @param[in] count Number of fields in \a fields.
186 feature_log_get(struct Client* from, const char* const* fields, int count)
188 struct LogTypes *desc;
189 char *value, *subsys;
191 assert(0 != from); /* never called by .conf parser */
193 if (count < 1) /* return default facility */
194 send_reply(from, SND_EXPLICIT | RPL_FEATURE, ":Log facility: %s",
197 need_more_params(from, "GET");
198 else if (!(subsys = log_canon(fields[0]))) { /* no such subsystem */
199 send_reply(from, ERR_BADLOGSYS, fields[0]);
200 } else if ((desc = feature_log_desc(from, fields[1]))) {
201 if ((value = (*desc->get)(fields[0]))) /* send along value */
202 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
203 ":Log %s for subsystem %s: %s", desc->type, subsys,
204 (*desc->get)(subsys));
206 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
207 ":No log %s is set for subsystem %s", desc->type, subsys);
211 /** Update whether #me is a hub or not.
214 feature_notify_hub(void)
216 if (feature_bool(FEAT_HUB))
222 /** Sets a feature to the given value.
223 * @param[in] from Client trying to set parameters.
224 * @param[in] fields Array of parameters to set.
225 * @param[in] count Number of fields in \a count.
226 * @return <0 to clear the feature mark, 0 to leave it, >0 to set the feature mark.
228 typedef int (*feat_set_call)(struct Client* from, const char* const* fields, int count);
229 /** Gets the value of a feature.
230 * @param[in] from Client trying to get parameters.
231 * @param[in] fields Array of parameters to set.
232 * @param[in] count Number of fields in \a count.
234 typedef void (*feat_get_call)(struct Client* from, const char* const* fields, int count);
235 /** Callback to notify of a feature's change. */
236 typedef void (*feat_notify_call)(void);
237 /** Unmarks all sub-feature values prior to reading .conf. */
238 typedef void (*feat_unmark_call)(void);
239 /** Resets to defaults all currently unmarked values.
240 * @param[in] marked Non-zero if the feature is marked.
242 typedef int (*feat_mark_call)(int marked);
243 /* Reports features as a /stats f list.
244 * @param[in] sptr Client asking for feature list.
245 * @param[in] marked Non-zero if the feature is marked.
247 typedef void (*feat_report_call)(struct Client* sptr, int marked);
249 #define FEAT_NONE 0x0000 /**< no value */
250 #define FEAT_INT 0x0001 /**< set if entry contains an integer value */
251 #define FEAT_BOOL 0x0002 /**< set if entry contains a boolean value */
252 #define FEAT_STR 0x0003 /**< set if entry contains a string value */
253 #define FEAT_MASK 0x000f /**< possible value types */
255 #define FEAT_MARK 0x0010 /**< set if entry has been changed */
256 #define FEAT_NULL 0x0020 /**< NULL string is permitted */
257 #define FEAT_CASE 0x0040 /**< string is case-sensitive */
259 #define FEAT_OPER 0x0100 /**< set to display only to opers */
260 #define FEAT_MYOPER 0x0200 /**< set to display only to local opers */
261 #define FEAT_NODISP 0x0400 /**< feature must never be displayed */
263 #define FEAT_READ 0x1000 /**< feature is read-only (for now, perhaps?) */
265 /** Declare a feature with custom behavior. */
266 #define F_N(type, flags, set, reset, get, notify, unmark, mark, report) \
267 { FEAT_ ## type, #type, FEAT_NONE | (flags), 0, 0, 0, 0, \
268 (set), (reset), (get), (notify), (unmark), (mark), (report) }
269 /** Declare a feature that takes integer values. */
270 #define F_I(type, flags, v_int, notify) \
271 { FEAT_ ## type, #type, FEAT_INT | (flags), 0, (v_int), 0, 0, \
272 0, 0, 0, (notify), 0, 0, 0 }
273 /** Declare a feature that takes boolean values. */
274 #define F_B(type, flags, v_int, notify) \
275 { FEAT_ ## type, #type, FEAT_BOOL | (flags), 0, (v_int), 0, 0, \
276 0, 0, 0, (notify), 0, 0, 0 }
277 /** Declare a feature that takes string values. */
278 #define F_S(type, flags, v_str, notify) \
279 { FEAT_ ## type, #type, FEAT_STR | (flags), 0, 0, 0, (v_str), \
280 0, 0, 0, (notify), 0, 0, 0 }
282 /** Table of feature descriptions. */
283 static struct FeatureDesc {
284 enum Feature feat; /**< feature identifier */
285 char* type; /**< string describing type */
286 unsigned int flags; /**< flags for feature */
287 int v_int; /**< integer value */
288 int def_int; /**< default value */
289 char* v_str; /**< string value */
290 char* def_str; /**< default value */
291 feat_set_call set; /**< set feature values */
292 feat_set_call reset; /**< reset feature values to defaults */
293 feat_get_call get; /**< get feature values */
294 feat_notify_call notify; /**< notify of value change */
295 feat_unmark_call unmark; /**< unmark all feature change values */
296 feat_mark_call mark; /**< reset to defaults all unchanged features */
297 feat_report_call report; /**< report feature values */
300 F_N(LOG, FEAT_MYOPER, feature_log_set, feature_log_reset, feature_log_get,
301 0, log_feature_unmark, log_feature_mark, log_feature_report),
302 F_S(DOMAINNAME, 0, DOMAINNAME, 0),
303 F_B(RELIABLE_CLOCK, 0, 0, 0),
304 F_I(BUFFERPOOL, 0, 27000000, 0),
305 F_B(HAS_FERGUSON_FLUSHER, 0, 0, 0),
306 F_I(CLIENT_FLOOD, 0, 1024, 0),
307 F_I(SERVER_PORT, FEAT_OPER, 4400, 0),
308 F_B(NODEFAULTMOTD, 0, 1, 0),
309 F_S(MOTD_BANNER, FEAT_NULL, 0, 0),
310 F_S(PROVIDER, FEAT_NULL, 0, 0),
311 F_B(KILL_IPMISMATCH, FEAT_OPER, 0, 0),
312 F_B(IDLE_FROM_MSG, 0, 1, 0),
313 F_B(HUB, 0, 0, feature_notify_hub),
314 F_B(WALLOPS_OPER_ONLY, 0, 0, 0),
316 F_N(RANDOM_SEED, FEAT_NODISP, random_seed_set, 0, 0, 0, 0, 0, 0),
317 F_S(DEFAULT_LIST_PARAM, FEAT_NULL, 0, list_set_default),
318 F_I(NICKNAMEHISTORYLENGTH, 0, 800, whowas_realloc),
319 F_B(HOST_HIDING, 0, 1, 0),
320 F_S(HIDDEN_HOST, FEAT_CASE, "users.undernet.org", 0),
321 F_S(HIDDEN_IP, 0, "127.0.0.1", 0),
322 F_B(CONNEXIT_NOTICES, 0, 0, 0),
323 F_B(OPLEVELS, 0, 1, 0),
324 F_B(ZANNELS, 0, 1, 0),
325 F_B(LOCAL_CHANNELS, 0, 1, 0),
326 F_B(TOPIC_BURST, 0, 0, 0),
327 F_B(DISABLE_GLINES, 0, 0, 0),
329 /* features that probably should not be touched */
330 F_I(KILLCHASETIMELIMIT, 0, 30, 0),
331 F_I(MAXCHANNELSPERUSER, 0, 10, 0),
332 F_I(NICKLEN, 0, 12, 0),
333 F_I(AVBANLEN, 0, 40, 0),
334 F_I(MAXBANS, 0, 50, 0),
335 F_I(MAXSILES, 0, 25, 0),
336 F_I(HANGONGOODLINK, 0, 300, 0),
337 F_I(HANGONRETRYDELAY, 0, 10, 0),
338 F_I(CONNECTTIMEOUT, 0, 90, 0),
339 F_I(MAXIMUM_LINKS, 0, 1, init_class), /* reinit class 0 as needed */
340 F_I(PINGFREQUENCY, 0, 120, init_class),
341 F_I(CONNECTFREQUENCY, 0, 600, init_class),
342 F_I(DEFAULTMAXSENDQLENGTH, 0, 40000, init_class),
343 F_I(GLINEMAXUSERCOUNT, 0, 20, 0),
344 F_I(SOCKSENDBUF, 0, SERVER_TCP_WINDOW, 0),
345 F_I(SOCKRECVBUF, 0, SERVER_TCP_WINDOW, 0),
346 F_I(IPCHECK_CLONE_LIMIT, 0, 4, 0),
347 F_I(IPCHECK_CLONE_PERIOD, 0, 40, 0),
348 F_I(IPCHECK_CLONE_DELAY, 0, 600, 0),
349 F_I(CHANNELLEN, 0, 200, 0),
351 /* Some misc. default paths */
352 F_S(MPATH, FEAT_CASE | FEAT_MYOPER, "ircd.motd", motd_init),
353 F_S(RPATH, FEAT_CASE | FEAT_MYOPER, "remote.motd", motd_init),
354 F_S(PPATH, FEAT_CASE | FEAT_MYOPER | FEAT_READ, "ircd.pid", 0),
356 /* Networking features */
357 F_I(TOS_SERVER, 0, 0x08, 0),
358 F_I(TOS_CLIENT, 0, 0x08, 0),
359 F_I(POLLS_PER_LOOP, 0, 200, 0),
360 F_I(IRCD_RES_RETRIES, 0, 2, 0),
361 F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
362 F_I(AUTH_TIMEOUT, 0, 9, 0),
363 F_B(ANNOUNCE_INVITES, 0, 0, 0),
365 /* features that affect all operators */
366 F_B(CONFIG_OPERCMDS, 0, 0, 0),
368 /* HEAD_IN_SAND Features */
369 F_B(HIS_SNOTICES, 0, 1, 0),
370 F_B(HIS_SNOTICES_OPER_ONLY, 0, 1, 0),
371 F_B(HIS_DEBUG_OPER_ONLY, 0, 1, 0),
372 F_B(HIS_WALLOPS, 0, 1, 0),
373 F_B(HIS_MAP, 0, 1, 0),
374 F_B(HIS_LINKS, 0, 1, 0),
375 F_B(HIS_TRACE, 0, 1, 0),
376 F_B(HIS_STATS_a, 0, 1, 0),
377 F_B(HIS_STATS_c, 0, 1, 0),
378 F_B(HIS_STATS_d, 0, 1, 0),
379 F_B(HIS_STATS_e, 0, 1, 0),
380 F_B(HIS_STATS_f, 0, 1, 0),
381 F_B(HIS_STATS_g, 0, 1, 0),
382 F_B(HIS_STATS_i, 0, 1, 0),
383 F_B(HIS_STATS_j, 0, 1, 0),
384 F_B(HIS_STATS_J, 0, 1, 0),
385 F_B(HIS_STATS_k, 0, 1, 0),
386 F_B(HIS_STATS_l, 0, 1, 0),
387 F_B(HIS_STATS_L, 0, 1, 0),
388 F_B(HIS_STATS_M, 0, 1, 0),
389 F_B(HIS_STATS_m, 0, 1, 0),
390 F_B(HIS_STATS_o, 0, 1, 0),
391 F_B(HIS_STATS_p, 0, 1, 0),
392 F_B(HIS_STATS_q, 0, 1, 0),
393 F_B(HIS_STATS_R, 0, 1, 0),
394 F_B(HIS_STATS_r, 0, 1, 0),
395 F_B(HIS_STATS_t, 0, 1, 0),
396 F_B(HIS_STATS_T, 0, 1, 0),
397 F_B(HIS_STATS_u, 0, 0, 0),
398 F_B(HIS_STATS_U, 0, 1, 0),
399 F_B(HIS_STATS_v, 0, 1, 0),
400 F_B(HIS_STATS_w, 0, 0, 0),
401 F_B(HIS_STATS_x, 0, 1, 0),
402 F_B(HIS_STATS_y, 0, 1, 0),
403 F_B(HIS_STATS_z, 0, 1, 0),
404 F_B(HIS_STATS_IAUTH, 0, 1, 0),
405 F_B(HIS_WHOIS_SERVERNAME, 0, 1, 0),
406 F_B(HIS_WHOIS_IDLETIME, 0, 1, 0),
407 F_B(HIS_WHOIS_LOCALCHAN, 0, 1, 0),
408 F_B(HIS_WHO_SERVERNAME, 0, 1, 0),
409 F_B(HIS_WHO_HOPCOUNT, 0, 1, 0),
410 F_B(HIS_MODEWHO, 0, 1, 0),
411 F_B(HIS_BANWHO, 0, 1, 0),
412 F_B(HIS_KILLWHO, 0, 1, 0),
413 F_B(HIS_REWRITE, 0, 1, 0),
414 F_I(HIS_REMOTE, 0, 1, 0),
415 F_B(HIS_NETSPLIT, 0, 1, 0),
416 F_S(HIS_SERVERNAME, 0, "*.undernet.org", feature_notify_servername),
417 F_S(HIS_SERVERINFO, 0, "The Undernet Underworld", feature_notify_serverinfo),
418 F_S(HIS_URLSERVERS, 0, "http://www.undernet.org/servers.php", 0),
420 /* Misc. random stuff */
421 F_S(NETWORK, 0, "UnderNet", 0),
422 F_S(URL_CLIENTS, 0, "ftp://ftp.undernet.org/pub/irc/clients", 0),
423 F_S(URLREG, 0, "http://cservice.undernet.org/live/", 0),
429 { FEAT_LAST_F, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
432 /** Given a feature's identifier, look up the feature descriptor.
433 * @param[in] from Client looking up feature, or NULL.
434 * @param[in] feature Feature name to find.
435 * @return Pointer to a FeatureDesc, or NULL if none was found.
437 static struct FeatureDesc *
438 feature_desc(struct Client* from, const char *feature)
442 assert(0 != feature);
444 for (i = 0; features[i].type; i++) /* find appropriate descriptor */
445 if (!strcmp(feature, features[i].type))
448 Debug((DEBUG_ERROR, "Unknown feature \"%s\"", feature));
449 if (from) /* report an error */
450 send_reply(from, ERR_NOFEATURE, feature);
452 log_write(LS_CONFIG, L_ERROR, 0, "Unknown feature \"%s\"", feature);
454 return 0; /* not found */
457 /** Given a feature vector string, set the value of a feature.
458 * @param[in] from Client trying to set the feature, or NULL.
459 * @param[in] fields Parameters to set, starting with feature name.
460 * @param[in] count Number of fields in \a fields.
461 * @return Zero (or, theoretically, CPTR_KILLED).
464 feature_set(struct Client* from, const char* const* fields, int count)
466 int i, change = 0, tmp;
468 struct FeatureDesc *feat;
470 if (from && !HasPriv(from, PRIV_SET))
471 return send_reply(from, ERR_NOPRIVILEGES);
474 if (from) /* report an error in the number of arguments */
475 need_more_params(from, "SET");
477 log_write(LS_CONFIG, L_ERROR, 0, "Not enough fields in F line");
478 } else if ((feat = feature_desc(from, fields[0]))) { /* find feature */
479 if (from && feat->flags & FEAT_READ)
480 return send_reply(from, ERR_NOFEATURE, fields[0]);
482 switch (feat->flags & FEAT_MASK) {
484 if (feat->set && (i = (*feat->set)(from, fields + 1, count - 1))) {
485 change++; /* feature handler wants a change recorded */
487 if (i > 0) /* call the set callback and do marking */
488 feat->flags |= FEAT_MARK;
490 feat->flags &= ~FEAT_MARK;
494 case FEAT_INT: /* an integer value */
495 tmp = feat->v_int; /* detect changes... */
497 if (count < 2) { /* reset value */
498 feat->v_int = feat->def_int;
499 feat->flags &= ~FEAT_MARK;
500 } else { /* ok, figure out the value and whether to mark it */
501 feat->v_int = strtoul(fields[1], 0, 0);
502 if (feat->v_int == feat->def_int)
503 feat->flags &= ~FEAT_MARK;
505 feat->flags |= FEAT_MARK;
508 if (feat->v_int != tmp) /* check for change */
512 case FEAT_BOOL: /* it's a boolean value--true or false */
513 tmp = feat->v_int; /* detect changes... */
515 if (count < 2) { /* reset value */
516 feat->v_int = feat->def_int;
517 feat->flags &= ~FEAT_MARK;
518 } else { /* figure out the value and whether to mark it */
519 if (!ircd_strncmp(fields[1], "TRUE", strlen(fields[1])) ||
520 !ircd_strncmp(fields[1], "YES", strlen(fields[1])) ||
521 (strlen(fields[1]) >= 2 &&
522 !ircd_strncmp(fields[1], "ON", strlen(fields[1]))))
524 else if (!ircd_strncmp(fields[1], "FALSE", strlen(fields[1])) ||
525 !ircd_strncmp(fields[1], "NO", strlen(fields[1])) ||
526 (strlen(fields[1]) >= 2 &&
527 !ircd_strncmp(fields[1], "OFF", strlen(fields[1]))))
529 else if (from) /* report an error... */
530 return send_reply(from, ERR_BADFEATVALUE, fields[1], feat->type);
532 log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"%s\" for feature %s",
533 fields[1], feat->type);
537 if (feat->v_int == feat->def_int) /* figure out whether to mark it */
538 feat->flags &= ~FEAT_MARK;
540 feat->flags |= FEAT_MARK;
543 if (feat->v_int != tmp) /* check for change */
547 case FEAT_STR: /* it's a string value */
549 t_str = feat->def_str; /* changing to default */
551 t_str = *fields[1] ? fields[1] : 0;
553 if (!t_str && !(feat->flags & FEAT_NULL)) { /* NULL value permitted? */
555 return send_reply(from, ERR_BADFEATVALUE, "NULL", feat->type);
557 log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"NULL\" for feature %s",
563 if (t_str == feat->def_str ||
564 (t_str && feat->def_str &&
565 !(feat->flags & FEAT_CASE ? strcmp(t_str, feat->def_str) :
566 ircd_strcmp(t_str, feat->def_str)))) { /* resetting to default */
567 if (feat->v_str != feat->def_str) {
568 change++; /* change from previous value */
571 MyFree(feat->v_str); /* free old value */
574 feat->v_str = feat->def_str; /* very special... */
576 feat->flags &= ~FEAT_MARK;
579 change++; /* change from previous value */
581 if (feat->v_str != feat->def_str)
582 MyFree(feat->v_str); /* free old value */
585 feat->v_str = 0; /* set it to NULL */
587 feat->flags |= FEAT_MARK;
588 } else if (!feat->v_str ||
589 (feat->flags & FEAT_CASE ? strcmp(t_str, feat->v_str) :
590 ircd_strcmp(t_str, feat->v_str))) { /* new value */
591 change++; /* change from previous value */
593 if (feat->v_str && feat->v_str != feat->def_str)
594 MyFree(feat->v_str); /* free old value */
595 DupString(feat->v_str, t_str); /* store new value */
597 feat->flags |= FEAT_MARK;
598 } else /* they match, but don't match the default */
599 feat->flags |= FEAT_MARK;
603 if (change && feat->notify) /* call change notify function */
607 return feature_get(from, fields, count);
613 /** Reset a feature to its default values.
614 * @param[in] from Client trying to reset the feature, or NULL.
615 * @param[in] fields Parameters to set, starting with feature name.
616 * @param[in] count Number of fields in \a fields.
617 * @return Zero (or, theoretically, CPTR_KILLED).
620 feature_reset(struct Client* from, const char* const* fields, int count)
623 struct FeatureDesc *feat;
627 if (!HasPriv(from, PRIV_SET))
628 return send_reply(from, ERR_NOPRIVILEGES);
630 if (count < 1) /* check arguments */
631 need_more_params(from, "RESET");
632 else if ((feat = feature_desc(from, fields[0]))) { /* get descriptor */
633 if (from && feat->flags & FEAT_READ)
634 return send_reply(from, ERR_NOFEATURE, fields[0]);
636 switch (feat->flags & FEAT_MASK) {
637 case FEAT_NONE: /* None... */
638 if (feat->reset && (i = (*feat->reset)(from, fields + 1, count - 1))) {
639 change++; /* feature handler wants a change recorded */
641 if (i > 0) /* call reset callback and parse mark return */
642 feat->flags |= FEAT_MARK;
644 feat->flags &= ~FEAT_MARK;
648 case FEAT_INT: /* Integer... */
649 case FEAT_BOOL: /* Boolean... */
650 if (feat->v_int != feat->def_int)
651 change++; /* change will be made */
653 feat->v_int = feat->def_int; /* set the default */
654 feat->flags &= ~FEAT_MARK; /* unmark it */
657 case FEAT_STR: /* string! */
658 if (feat->v_str != feat->def_str) {
659 change++; /* change has been made */
661 MyFree(feat->v_str); /* free old value */
664 feat->v_str = feat->def_str; /* set it to default */
665 feat->flags &= ~FEAT_MARK; /* unmark it */
669 if (change && feat->notify) /* call change notify function */
673 return feature_get(from, fields, count);
679 /** Gets the value of a specific feature and reports it to the user.
680 * @param[in] from Client trying to get the feature.
681 * @param[in] fields Parameters to set, starting with feature name.
682 * @param[in] count Number of fields in \a fields.
683 * @return Zero (or, theoretically, CPTR_KILLED).
686 feature_get(struct Client* from, const char* const* fields, int count)
688 struct FeatureDesc *feat;
692 if (count < 1) /* check parameters */
693 need_more_params(from, "GET");
694 else if ((feat = feature_desc(from, fields[0]))) {
695 if ((feat->flags & FEAT_NODISP) ||
696 (feat->flags & FEAT_MYOPER && !MyOper(from)) ||
697 (feat->flags & FEAT_OPER && !IsAnOper(from))) /* check privs */
698 return send_reply(from, ERR_NOPRIVILEGES);
700 switch (feat->flags & FEAT_MASK) {
701 case FEAT_NONE: /* none, call the callback... */
702 if (feat->get) /* if there's a callback, use it */
703 (*feat->get)(from, fields + 1, count - 1);
706 case FEAT_INT: /* integer, report integer value */
707 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
708 ":Integer value of %s: %d", feat->type, feat->v_int);
711 case FEAT_BOOL: /* boolean, report boolean value */
712 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
713 ":Boolean value of %s: %s", feat->type,
714 feat->v_int ? "TRUE" : "FALSE");
717 case FEAT_STR: /* string, report string value */
718 if (feat->v_str) /* deal with null case */
719 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
720 ":String value of %s: %s", feat->type, feat->v_str);
722 send_reply(from, SND_EXPLICIT | RPL_FEATURE,
723 ":String value for %s not set", feat->type);
731 /** Called before reading the .conf to clear all dirty marks. */
737 for (i = 0; features[i].type; i++) {
738 features[i].flags &= ~FEAT_MARK; /* clear the marks... */
739 if (features[i].unmark) /* call the unmark callback if necessary */
740 (*features[i].unmark)();
744 /** Called after reading the .conf to reset unmodified values to defaults. */
750 for (i = 0; features[i].type; i++) {
753 switch (features[i].flags & FEAT_MASK) {
755 if (features[i].mark &&
756 (*features[i].mark)(features[i].flags & FEAT_MARK ? 1 : 0))
757 change++; /* feature handler wants a change recorded */
760 case FEAT_INT: /* Integers or Booleans... */
762 if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
763 if (features[i].v_int != features[i].def_int)
764 change++; /* we're making a change */
765 features[i].v_int = features[i].def_int;
769 case FEAT_STR: /* strings... */
770 if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
771 if (features[i].v_str != features[i].def_str) {
772 change++; /* we're making a change */
773 if (features[i].v_str)
774 MyFree(features[i].v_str); /* free old value */
776 features[i].v_str = features[i].def_str;
781 if (change && features[i].notify)
782 (*features[i].notify)(); /* call change notify function */
786 /** Initialize the features subsystem. */
792 for (i = 0; features[i].type; i++) {
793 switch (features[i].flags & FEAT_MASK) {
794 case FEAT_NONE: /* you're on your own */
797 case FEAT_INT: /* Integers or Booleans... */
799 features[i].v_int = features[i].def_int;
802 case FEAT_STR: /* Strings */
803 features[i].v_str = features[i].def_str;
804 assert(features[i].def_str || (features[i].flags & FEAT_NULL));
809 cli_magic(&his) = CLIENT_MAGIC;
810 cli_status(&his) = STAT_SERVER;
811 feature_notify_servername();
812 feature_notify_serverinfo();
815 /** Report all F-lines to a user.
816 * @param[in] to Client requesting statistics.
817 * @param[in] sd Stats descriptor for request (ignored).
818 * @param[in] param Extra parameter from user (ignored).
821 feature_report(struct Client* to, const struct StatDesc* sd, char* param)
827 for (i = 0; features[i].type; i++) {
828 if ((features[i].flags & FEAT_NODISP) ||
829 (features[i].flags & FEAT_MYOPER && !MyOper(to)) ||
830 (features[i].flags & FEAT_OPER && !IsAnOper(to)))
831 continue; /* skip this one */
833 changed = (features[i].flags & FEAT_MARK) ? 'F' : 'f';
834 report = (features[i].flags & FEAT_MARK) || sd->sd_funcdata;
836 switch (features[i].flags & FEAT_MASK) {
838 if (features[i].report) /* let the callback handle this */
839 (*features[i].report)(to, report);
843 case FEAT_INT: /* Report an F-line with integer values */
844 if (report) /* it's been changed */
845 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "%c %s %d",
846 changed, features[i].type, features[i].v_int);
849 case FEAT_BOOL: /* Report an F-line with boolean values */
850 if (report) /* it's been changed */
851 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "%c %s %s",
852 changed, features[i].type, features[i].v_int ? "TRUE" : "FALSE");
855 case FEAT_STR: /* Report an F-line with string values */
856 if (report) { /* it's been changed */
857 if (features[i].v_str)
858 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "%c %s %s",
859 changed, features[i].type, features[i].v_str);
860 else /* Actually, F:<type> would reset it; you want F:<type>: */
861 send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "%c %s",
862 changed, features[i].type);
869 /** Return a feature's integer value.
870 * @param[in] feat &Feature identifier.
871 * @return Integer value of feature.
874 feature_int(enum Feature feat)
876 assert(features[feat].feat == feat);
877 assert((features[feat].flags & FEAT_MASK) == FEAT_INT);
879 return features[feat].v_int;
882 /** Return a feature's boolean value.
883 * @param[in] feat &Feature identifier.
884 * @return Boolean value of feature.
887 feature_bool(enum Feature feat)
889 assert(feat <= FEAT_LAST_F);
890 if (FEAT_LAST_F < feat)
892 assert(features[feat].feat == feat);
893 assert((features[feat].flags & FEAT_MASK) == FEAT_BOOL);
895 return features[feat].v_int;
898 /** Return a feature's string value.
899 * @param[in] feat &Feature identifier.
900 * @return String value of feature.
903 feature_str(enum Feature feat)
905 assert(features[feat].feat == feat);
906 assert((features[feat].flags & FEAT_MASK) == FEAT_STR);
908 return features[feat].v_str;