Add CHANNELLEN feature, analogous to NICKLEN feature.
[ircu2.10.12-pk.git] / ircd / ircd_features.c
1 /*
2  * IRC - Internet Relay Chat, ircd/features.c
3  * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
4  *
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)
8  * any later version.
9  *
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.
14  *
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.
18  */
19 /** @file
20  * @brief Implementation of configurable feature support.
21  * @version $Id$
22  */
23 #include "config.h"
24
25 #include "ircd_features.h"
26 #include "channel.h"    /* list_set_default */
27 #include "class.h"
28 #include "client.h"
29 #include "hash.h"
30 #include "ircd.h"
31 #include "ircd_alloc.h"
32 #include "ircd_log.h"
33 #include "ircd_reply.h"
34 #include "ircd_string.h"
35 #include "match.h"
36 #include "motd.h"
37 #include "msg.h"
38 #include "numeric.h"
39 #include "numnicks.h"
40 #include "random.h"     /* random_seed_set */
41 #include "s_bsd.h"
42 #include "s_debug.h"
43 #include "s_misc.h"
44 #include "send.h"
45 #include "struct.h"
46 #include "sys.h"    /* FALSE bleah */
47 #include "whowas.h"     /* whowas_realloc */
48
49 /* #include <assert.h> -- Now using assert in ircd_log.h */
50 #include <stdlib.h>
51 #include <string.h>
52
53 /** List of log output types that can be set */
54 static struct LogTypes {
55   char *type; /**< Settable name. */
56   int (*set)(const char *, const char *); /**< Function to set the value. */
57   char *(*get)(const char *); /**< Function to get the value. */
58 } logTypes[] = {
59   { "FILE", log_set_file, log_get_file },
60   { "FACILITY", log_set_facility, log_get_facility },
61   { "SNOMASK", log_set_snomask, log_get_snomask },
62   { "LEVEL", log_set_level, log_get_level },
63   { 0, 0, 0 }
64 };
65
66 /** Look up a struct LogType given the type string.
67  * @param[in] from &Client requesting type, or NULL.
68  * @param[in] type Name of log type to find.
69  * @return Pointer to the found LogType, or NULL if none was found.
70  */
71 static struct LogTypes *
72 feature_log_desc(struct Client* from, const char *type)
73 {
74   int i;
75
76   assert(0 != type);
77
78   for (i = 0; logTypes[i].type; i++) /* find appropriate descriptor */
79     if (!ircd_strcmp(type, logTypes[i].type))
80       return &logTypes[i];
81
82   Debug((DEBUG_ERROR, "Unknown log feature type \"%s\"", type));
83   if (from) /* send an error; if from is NULL, called from conf parser */
84     send_reply(from, ERR_BADLOGTYPE, type);
85   else
86     log_write(LS_CONFIG, L_ERROR, 0, "Unknown log feature type \"%s\"", type);
87
88   return 0; /* not found */
89 }
90
91 /** Set the value of a log output type for a log subsystem.
92  * @param[in] from &Client trying to set the log type, or NULL.
93  * @param[in] fields Array of parameters to set.
94  * @param[in] count Number of parameters in \a fields.
95  * @return -1 to clear the mark, 0 to leave the mask alone, 1 to set the mask.
96  */
97 static int
98 feature_log_set(struct Client* from, const char* const* fields, int count)
99 {
100   struct LogTypes *desc;
101   char *subsys;
102
103   if (count < 2) { /* set default facility */
104     if (log_set_default(count < 1 ? 0 : fields[0])) {
105       assert(count >= 1); /* should always accept default */
106
107       if (from) /* send an error */
108         send_reply(from, ERR_BADLOGVALUE, fields[0]);
109       else
110         log_write(LS_CONFIG, L_ERROR, 0,
111                   "Bad value \"%s\" for default facility", fields[0]);
112     } else
113       return count < 1 ? -1 : 1; /* tell feature to set or clear mark */
114   } else if (!(subsys = log_canon(fields[0]))) { /* no such subsystem */
115     if (from) /* send an error */
116       send_reply(from, ERR_BADLOGSYS, fields[0]);
117     else
118       log_write(LS_CONFIG, L_ERROR, 0,
119                 "No such logging subsystem \"%s\"", fields[0]);
120   } else if ((desc = feature_log_desc(from, fields[1]))) { /* set value */
121     if ((*desc->set)(fields[0], count < 3 ? 0 : fields[2])) {
122       assert(count >= 3); /* should always accept default */
123
124       if (from) /* send an error */
125         send_reply(from, ERR_BADLOGVALUE, fields[2]);
126       else
127         log_write(LS_CONFIG, L_ERROR, 0,
128                   "Bad value \"%s\" for log type %s (subsystem %s)",
129                   fields[2], desc->type, subsys);
130     }
131   }
132
133   return 0;
134 }
135
136 /** Reset a log type for a subsystem to its default value.
137  * @param[in] from &Client trying to reset the subsystem.
138  * @param[in] fields Array of parameters to reset.
139  * @param[in] count Number of fields in \a fields.
140  * @return -1 to unmark the entry, or zero to leave it alone.
141  */
142 static int
143 feature_log_reset(struct Client* from, const char* const* fields, int count)
144 {
145   struct LogTypes *desc;
146   char *subsys;
147
148   assert(0 != from); /* Never called by the .conf parser */
149
150   if (count < 1) { /* reset default facility */
151     log_set_default(0);
152     return -1; /* unmark this entry */
153   } else if (count < 2)
154     need_more_params(from, "RESET");
155   else if (!(subsys = log_canon(fields[0]))) /* no such subsystem */
156     send_reply(from, ERR_BADLOGSYS, fields[0]);
157   else if ((desc = feature_log_desc(from, fields[1]))) /* reset value */
158     (*desc->set)(fields[0], 0); /* default should always be accepted */
159
160   return 0;
161 }
162
163 /** Report the value of a log setting.
164  * @param[in] from &Client asking for details.
165  * @param[in] fields Array of parameters to get.
166  * @param[in] count Number of fields in \a fields.
167  */
168 static void
169 feature_log_get(struct Client* from, const char* const* fields, int count)
170 {
171   struct LogTypes *desc;
172   char *value, *subsys;
173
174   assert(0 != from); /* never called by .conf parser */
175
176   if (count < 1) /* return default facility */
177     send_reply(from, SND_EXPLICIT | RPL_FEATURE, ":Log facility: %s",
178                log_get_default());
179   else if (count < 2)
180     need_more_params(from, "GET");
181   else if (!(subsys = log_canon(fields[0]))) { /* no such subsystem */
182     send_reply(from, ERR_BADLOGSYS, fields[0]);
183   } else if ((desc = feature_log_desc(from, fields[1]))) {
184     if ((value = (*desc->get)(fields[0]))) /* send along value */
185       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
186                  ":Log %s for subsystem %s: %s", desc->type, subsys,
187                  (*desc->get)(subsys));
188     else
189       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
190                  ":No log %s is set for subsystem %s", desc->type, subsys);
191   }
192 }
193
194 /** Sets a feature to the given value.
195  * @param[in] from Client trying to set parameters.
196  * @param[in] fields Array of parameters to set.
197  * @param[in] count Number of fields in \a count.
198  * @return <0 to clear the feature mark, 0 to leave it, >0 to set the feature mark.
199  */
200 typedef int  (*feat_set_call)(struct Client* from, const char* const* fields, int count);
201 /** Gets the value of a feature.
202  * @param[in] from Client trying to get parameters.
203  * @param[in] fields Array of parameters to set.
204  * @param[in] count Number of fields in \a count.
205  */
206 typedef void (*feat_get_call)(struct Client* from, const char* const* fields, int count);
207 /** Callback to notify of a feature's change. */
208 typedef void (*feat_notify_call)(void);
209 /** Unmarks all sub-feature values prior to reading .conf. */
210 typedef void (*feat_unmark_call)(void);
211 /** Resets to defaults all currently unmarked values.
212  * @param[in] marked Non-zero if the feature is marked.
213  */
214 typedef int  (*feat_mark_call)(int marked);
215 /* Reports features as a /stats f list.
216  * @param[in] sptr Client asking for feature list.
217  * @param[in] marked Non-zero if the feature is marked.
218  */
219 typedef void (*feat_report_call)(struct Client* sptr, int marked);
220
221 #define FEAT_NONE   0x0000      /**< no value */
222 #define FEAT_INT    0x0001      /**< set if entry contains an integer value */
223 #define FEAT_BOOL   0x0002      /**< set if entry contains a boolean value */
224 #define FEAT_STR    0x0003      /**< set if entry contains a string value */
225 #define FEAT_MASK   0x000f      /**< possible value types */
226
227 #define FEAT_MARK   0x0010      /**< set if entry has been changed */
228 #define FEAT_NULL   0x0020      /**< NULL string is permitted */
229 #define FEAT_CASE   0x0040      /**< string is case-sensitive */
230
231 #define FEAT_OPER   0x0100      /**< set to display only to opers */
232 #define FEAT_MYOPER 0x0200      /**< set to display only to local opers */
233 #define FEAT_NODISP 0x0400      /**< feature must never be displayed */
234
235 #define FEAT_READ   0x1000      /**< feature is read-only (for now, perhaps?) */
236
237 /** Declare a feature with custom behavior. */
238 #define F_N(type, flags, set, reset, get, notify, unmark, mark, report)       \
239   { FEAT_ ## type, #type, FEAT_NONE | (flags), 0, 0, 0, 0,                    \
240     (set), (reset), (get), (notify), (unmark), (mark), (report) }
241 /** Declare a feature that takes integer values. */
242 #define F_I(type, flags, v_int, notify)                                       \
243   { FEAT_ ## type, #type, FEAT_INT | (flags), 0, (v_int), 0, 0,               \
244     0, 0, 0, (notify), 0, 0, 0 }
245 /** Declare a feature that takes boolean values. */
246 #define F_B(type, flags, v_int, notify)                                       \
247   { FEAT_ ## type, #type, FEAT_BOOL | (flags), 0, (v_int), 0, 0,              \
248     0, 0, 0, (notify), 0, 0, 0 }
249 /** Declare a feature that takes string values. */
250 #define F_S(type, flags, v_str, notify)                                       \
251   { FEAT_ ## type, #type, FEAT_STR | (flags), 0, 0, 0, (v_str),               \
252     0, 0, 0, (notify), 0, 0, 0 }
253
254 /** Table of feature descriptions. */
255 static struct FeatureDesc {
256   enum Feature     feat;    /**< feature identifier */
257   char*            type;    /**< string describing type */
258   unsigned int     flags;   /**< flags for feature */
259   int              v_int;   /**< integer value */
260   int              def_int; /**< default value */
261   char*            v_str;   /**< string value */
262   char*            def_str; /**< default value */
263   feat_set_call    set;     /**< set feature values */
264   feat_set_call    reset;   /**< reset feature values to defaults */
265   feat_get_call    get;     /**< get feature values */
266   feat_notify_call notify;  /**< notify of value change */
267   feat_unmark_call unmark;  /**< unmark all feature change values */
268   feat_mark_call   mark;    /**< reset to defaults all unchanged features */
269   feat_report_call report;  /**< report feature values */
270 } features[] = {
271   /* Misc. features */
272   F_N(LOG, FEAT_MYOPER, feature_log_set, feature_log_reset, feature_log_get,
273       0, log_feature_unmark, log_feature_mark, log_feature_report),
274   F_S(DOMAINNAME, 0, DOMAINNAME, 0),
275   F_B(RELIABLE_CLOCK, 0, 0, 0),
276   F_I(BUFFERPOOL, 0, 27000000, 0),
277   F_B(HAS_FERGUSON_FLUSHER, 0, 0, 0),
278   F_I(CLIENT_FLOOD, 0, 1024, 0),
279   F_I(SERVER_PORT, FEAT_OPER, 4400, 0),
280   F_B(NODEFAULTMOTD, 0, 1, 0),
281   F_S(MOTD_BANNER, FEAT_NULL, 0, 0),
282   F_S(PROVIDER, FEAT_NULL, 0, 0),
283   F_B(KILL_IPMISMATCH, FEAT_OPER, 0, 0),
284   F_B(IDLE_FROM_MSG, 0, 1, 0),
285   F_B(HUB, 0, 0, 0),
286   F_B(WALLOPS_OPER_ONLY, 0, 0, 0),
287   F_B(NODNS, 0, 0, 0),
288   F_N(RANDOM_SEED, FEAT_NODISP, random_seed_set, 0, 0, 0, 0, 0, 0),
289   F_S(DEFAULT_LIST_PARAM, FEAT_NULL, 0, list_set_default),
290   F_I(NICKNAMEHISTORYLENGTH, 0, 800, whowas_realloc),
291   F_B(HOST_HIDING, 0, 1, 0),
292   F_S(HIDDEN_HOST, FEAT_CASE, "users.undernet.org", 0),
293   F_S(HIDDEN_IP, 0, "127.0.0.1", 0),
294   F_B(CONNEXIT_NOTICES, 0, 0, 0),
295   F_B(OPLEVELS, 0, 1, 0),
296   F_B(LOCAL_CHANNELS, 0, 1, 0),
297   F_B(TOPIC_BURST, 0, 0, 0),
298
299   /* features that probably should not be touched */
300   F_I(KILLCHASETIMELIMIT, 0, 30, 0),
301   F_I(MAXCHANNELSPERUSER, 0, 10, 0),
302   F_I(NICKLEN, 0, 12, 0),
303   F_I(AVBANLEN, 0, 40, 0),
304   F_I(MAXBANS, 0, 45, 0),
305   F_I(MAXSILES, 0, 15, 0),
306   F_I(HANGONGOODLINK, 0, 300, 0),
307   F_I(HANGONRETRYDELAY, 0, 10, 0),
308   F_I(CONNECTTIMEOUT, 0, 90, 0),
309   F_I(MAXIMUM_LINKS, 0, 1, init_class), /* reinit class 0 as needed */
310   F_I(PINGFREQUENCY, 0, 120, init_class),
311   F_I(CONNECTFREQUENCY, 0, 600, init_class),
312   F_I(DEFAULTMAXSENDQLENGTH, 0, 40000, init_class),
313   F_I(GLINEMAXUSERCOUNT, 0, 20, 0),
314   F_I(SOCKSENDBUF, 0, SERVER_TCP_WINDOW, 0),
315   F_I(SOCKRECVBUF, 0, SERVER_TCP_WINDOW, 0),
316   F_I(IPCHECK_CLONE_LIMIT, 0, 4, 0),
317   F_I(IPCHECK_CLONE_PERIOD, 0, 40, 0),
318   F_I(IPCHECK_CLONE_DELAY, 0, 600, 0),
319   F_I(CHANNELLEN, 0, 200, 0),
320
321   /* Some misc. default paths */
322   F_S(MPATH, FEAT_CASE | FEAT_MYOPER, "ircd.motd", motd_init),
323   F_S(RPATH, FEAT_CASE | FEAT_MYOPER, "remote.motd", motd_init),
324   F_S(PPATH, FEAT_CASE | FEAT_MYOPER | FEAT_READ, "ircd.pid", 0),
325
326   /* Networking features */
327   F_I(TOS_SERVER, 0, 0x08, 0),
328   F_I(TOS_CLIENT, 0, 0x08, 0),
329   F_I(POLLS_PER_LOOP, 0, 200, 0),
330   F_I(IRCD_RES_RETRIES, 0, 2, 0),
331   F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
332   F_I(AUTH_TIMEOUT, 0, 9, 0),
333   F_B(ANNOUNCE_INVITES, 0, 0, 0),
334
335   /* features that affect all operators */
336   F_B(CONFIG_OPERCMDS, 0, 0, 0),
337
338   /* HEAD_IN_SAND Features */
339   F_B(HIS_SNOTICES, 0, 1, 0),
340   F_B(HIS_SNOTICES_OPER_ONLY, 0, 1, 0),
341   F_B(HIS_DEBUG_OPER_ONLY, 0, 1, 0),
342   F_B(HIS_WALLOPS, 0, 1, 0),
343   F_B(HIS_MAP, 0, 1, 0),
344   F_B(HIS_LINKS, 0, 1, 0),
345   F_B(HIS_TRACE, 0, 1, 0),
346   F_B(HIS_STATS_a, 0, 1, 0),
347   F_B(HIS_STATS_c, 0, 1, 0),
348   F_B(HIS_STATS_d, 0, 1, 0),
349   F_B(HIS_STATS_e, 0, 1, 0),
350   F_B(HIS_STATS_f, 0, 1, 0),
351   F_B(HIS_STATS_g, 0, 1, 0),
352   F_B(HIS_STATS_i, 0, 1, 0),
353   F_B(HIS_STATS_j, 0, 1, 0),
354   F_B(HIS_STATS_J, 0, 1, 0),
355   F_B(HIS_STATS_k, 0, 1, 0),
356   F_B(HIS_STATS_l, 0, 1, 0),
357   F_B(HIS_STATS_L, 0, 1, 0),
358   F_B(HIS_STATS_M, 0, 1, 0),
359   F_B(HIS_STATS_m, 0, 1, 0),
360   F_B(HIS_STATS_o, 0, 1, 0),
361   F_B(HIS_STATS_p, 0, 1, 0),
362   F_B(HIS_STATS_q, 0, 1, 0),
363   F_B(HIS_STATS_R, 0, 1, 0),
364   F_B(HIS_STATS_r, 0, 1, 0),
365   F_B(HIS_STATS_t, 0, 1, 0),
366   F_B(HIS_STATS_T, 0, 1, 0),
367   F_B(HIS_STATS_u, 0, 0, 0),
368   F_B(HIS_STATS_U, 0, 1, 0),
369   F_B(HIS_STATS_v, 0, 1, 0),
370   F_B(HIS_STATS_w, 0, 0, 0),
371   F_B(HIS_STATS_x, 0, 1, 0),
372   F_B(HIS_STATS_y, 0, 1, 0),
373   F_B(HIS_STATS_z, 0, 1, 0),
374   F_B(HIS_WHOIS_SERVERNAME, 0, 1, 0),
375   F_B(HIS_WHOIS_IDLETIME, 0, 1, 0),
376   F_B(HIS_WHOIS_LOCALCHAN, 0, 1, 0),
377   F_B(HIS_WHO_SERVERNAME, 0, 1, 0),
378   F_B(HIS_WHO_HOPCOUNT, 0, 1, 0),
379   F_B(HIS_BANWHO, 0, 1, 0),
380   F_B(HIS_KILLWHO, 0, 1, 0),
381   F_B(HIS_REWRITE, 0, 1, 0),
382   F_I(HIS_REMOTE, 0, 1, 0),
383   F_B(HIS_NETSPLIT, 0, 1, 0),
384   F_S(HIS_SERVERNAME, 0, "*.undernet.org", 0),
385   F_S(HIS_SERVERINFO, 0, "The Undernet Underworld", 0),
386   F_S(HIS_URLSERVERS, 0, "http://www.undernet.org/servers.php", 0),
387
388   /* Misc. random stuff */
389   F_S(NETWORK, 0, "UnderNet", 0),
390   F_S(URL_CLIENTS, 0, "ftp://ftp.undernet.org/pub/irc/clients", 0),
391
392 #undef F_S
393 #undef F_B
394 #undef F_I
395 #undef F_N
396   { FEAT_LAST_F, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
397 };
398
399 /** Given a feature's identifier, look up the feature descriptor.
400  * @param[in] from Client looking up feature, or NULL.
401  * @param[in] feature Feature name to find.
402  * @return Pointer to a FeatureDesc, or NULL if none was found.
403  */
404 static struct FeatureDesc *
405 feature_desc(struct Client* from, const char *feature)
406 {
407   int i;
408
409   assert(0 != feature);
410
411   for (i = 0; features[i].type; i++) /* find appropriate descriptor */
412     if (!strcmp(feature, features[i].type))
413       return &features[i];
414
415   Debug((DEBUG_ERROR, "Unknown feature \"%s\"", feature));
416   if (from) /* report an error */
417     send_reply(from, ERR_NOFEATURE, feature);
418   else
419     log_write(LS_CONFIG, L_ERROR, 0, "Unknown feature \"%s\"", feature);
420
421   return 0; /* not found */
422 }
423
424 /** Given a feature vector string, set the value of a feature.
425  * @param[in] from Client trying to set the feature, or NULL.
426  * @param[in] fields Parameters to set, starting with feature name.
427  * @param[in] count Number of fields in \a fields.
428  * @return Zero (or, theoretically, CPTR_KILLED).
429  */
430 int
431 feature_set(struct Client* from, const char* const* fields, int count)
432 {
433   int i, change = 0, tmp;
434   const char *t_str;
435   struct FeatureDesc *feat;
436
437   if (from && !HasPriv(from, PRIV_SET))
438     return send_reply(from, ERR_NOPRIVILEGES);
439
440   if (count < 1) {
441     if (from) /* report an error in the number of arguments */
442       need_more_params(from, "SET");
443     else
444       log_write(LS_CONFIG, L_ERROR, 0, "Not enough fields in F line");
445   } else if ((feat = feature_desc(from, fields[0]))) { /* find feature */
446     if (from && feat->flags & FEAT_READ)
447       return send_reply(from, ERR_NOFEATURE, fields[0]);
448
449     switch (feat->flags & FEAT_MASK) {
450     case FEAT_NONE:
451       if (feat->set && (i = (*feat->set)(from, fields + 1, count - 1))) {
452         change++; /* feature handler wants a change recorded */
453
454         if (i > 0) /* call the set callback and do marking */
455           feat->flags |= FEAT_MARK;
456         else /* i < 0 */
457           feat->flags &= ~FEAT_MARK;
458         break;
459       }
460
461     case FEAT_INT: /* an integer value */
462       tmp = feat->v_int; /* detect changes... */
463
464       if (count < 2) { /* reset value */
465         feat->v_int = feat->def_int;
466         feat->flags &= ~FEAT_MARK;
467       } else { /* ok, figure out the value and whether to mark it */
468         feat->v_int = strtoul(fields[1], 0, 0);
469         if (feat->v_int == feat->def_int)
470           feat->flags &= ~FEAT_MARK;
471         else
472           feat->flags |= FEAT_MARK;
473       }
474
475       if (feat->v_int != tmp) /* check for change */
476         change++;
477       break;
478
479     case FEAT_BOOL: /* it's a boolean value--true or false */
480       tmp = feat->v_int; /* detect changes... */
481
482       if (count < 2) { /* reset value */
483         feat->v_int = feat->def_int;
484         feat->flags &= ~FEAT_MARK;
485       } else { /* figure out the value and whether to mark it */
486         if (!ircd_strncmp(fields[1], "TRUE", strlen(fields[1])) ||
487             !ircd_strncmp(fields[1], "YES", strlen(fields[1])) ||
488             (strlen(fields[1]) >= 2 &&
489              !ircd_strncmp(fields[1], "ON", strlen(fields[1]))))
490           feat->v_int = 1;
491         else if (!ircd_strncmp(fields[1], "FALSE", strlen(fields[1])) ||
492                  !ircd_strncmp(fields[1], "NO", strlen(fields[1])) ||
493                  (strlen(fields[1]) >= 2 &&
494                   !ircd_strncmp(fields[1], "OFF", strlen(fields[1]))))
495           feat->v_int = 0;
496         else if (from) /* report an error... */
497           return send_reply(from, ERR_BADFEATVALUE, fields[1], feat->type);
498         else {
499           log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"%s\" for feature %s",
500                     fields[1], feat->type);
501           return 0;
502         }
503
504         if (feat->v_int == feat->def_int) /* figure out whether to mark it */
505           feat->flags &= ~FEAT_MARK;
506         else
507           feat->flags |= FEAT_MARK;
508       }
509
510       if (feat->v_int != tmp) /* check for change */
511         change++;
512       break;
513
514     case FEAT_STR: /* it's a string value */
515       if (count < 2)
516         t_str = feat->def_str; /* changing to default */
517       else
518         t_str = *fields[1] ? fields[1] : 0;
519
520       if (!t_str && !(feat->flags & FEAT_NULL)) { /* NULL value permitted? */
521         if (from)
522           return send_reply(from, ERR_BADFEATVALUE, "NULL", feat->type);
523         else {
524           log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"NULL\" for feature %s",
525                     feat->type);
526           return 0;
527         }
528       }
529
530       if (t_str == feat->def_str ||
531           (t_str && feat->def_str &&
532            !(feat->flags & FEAT_CASE ? strcmp(t_str, feat->def_str) :
533              ircd_strcmp(t_str, feat->def_str)))) { /* resetting to default */
534         if (feat->v_str != feat->def_str) {
535           change++; /* change from previous value */
536
537           if (feat->v_str)
538             MyFree(feat->v_str); /* free old value */
539         }
540
541         feat->v_str = feat->def_str; /* very special... */
542
543         feat->flags &= ~FEAT_MARK;
544       } else if (!t_str) {
545         if (feat->v_str) {
546           change++; /* change from previous value */
547
548           if (feat->v_str != feat->def_str)
549             MyFree(feat->v_str); /* free old value */
550         }
551
552         feat->v_str = 0; /* set it to NULL */
553
554         feat->flags |= FEAT_MARK;
555       } else if (!feat->v_str ||
556                  (feat->flags & FEAT_CASE ? strcmp(t_str, feat->v_str) :
557                   ircd_strcmp(t_str, feat->v_str))) { /* new value */
558         change++; /* change from previous value */
559
560         if (feat->v_str && feat->v_str != feat->def_str)
561           MyFree(feat->v_str); /* free old value */
562         DupString(feat->v_str, t_str); /* store new value */
563
564         feat->flags |= FEAT_MARK;
565       } else /* they match, but don't match the default */
566         feat->flags |= FEAT_MARK;
567       break;
568     }
569
570     if (change && feat->notify) /* call change notify function */
571       (*feat->notify)();
572   }
573
574   return 0;
575 }
576
577 /** Reset a feature to its default values.
578  * @param[in] from Client trying to reset the feature, or NULL.
579  * @param[in] fields Parameters to set, starting with feature name.
580  * @param[in] count Number of fields in \a fields.
581  * @return Zero (or, theoretically, CPTR_KILLED).
582  */
583 int
584 feature_reset(struct Client* from, const char* const* fields, int count)
585 {
586   int i, change = 0;
587   struct FeatureDesc *feat;
588
589   assert(0 != from);
590
591   if (!HasPriv(from, PRIV_SET))
592     return send_reply(from, ERR_NOPRIVILEGES);
593
594   if (count < 1) /* check arguments */
595     need_more_params(from, "RESET");
596   else if ((feat = feature_desc(from, fields[0]))) { /* get descriptor */
597     if (from && feat->flags & FEAT_READ)
598       return send_reply(from, ERR_NOFEATURE, fields[0]);
599
600     switch (feat->flags & FEAT_MASK) {
601     case FEAT_NONE: /* None... */
602       if (feat->reset && (i = (*feat->reset)(from, fields + 1, count - 1))) {
603         change++; /* feature handler wants a change recorded */
604
605         if (i > 0) /* call reset callback and parse mark return */
606           feat->flags |= FEAT_MARK;
607         else /* i < 0 */
608           feat->flags &= ~FEAT_MARK;
609       }
610       break;
611
612     case FEAT_INT:  /* Integer... */
613     case FEAT_BOOL: /* Boolean... */
614       if (feat->v_int != feat->def_int)
615         change++; /* change will be made */
616
617       feat->v_int = feat->def_int; /* set the default */
618       feat->flags &= ~FEAT_MARK; /* unmark it */
619       break;
620
621     case FEAT_STR: /* string! */
622       if (feat->v_str != feat->def_str) {
623         change++; /* change has been made */
624         if (feat->v_str)
625           MyFree(feat->v_str); /* free old value */
626       }
627
628       feat->v_str = feat->def_str; /* set it to default */
629       feat->flags &= ~FEAT_MARK; /* unmark it */
630       break;
631     }
632
633     if (change && feat->notify) /* call change notify function */
634       (*feat->notify)();
635   }
636
637   return 0;
638 }
639
640 /** Gets the value of a specific feature and reports it to the user.
641  * @param[in] from Client trying to get the feature.
642  * @param[in] fields Parameters to set, starting with feature name.
643  * @param[in] count Number of fields in \a fields.
644  * @return Zero (or, theoretically, CPTR_KILLED).
645  */
646 int
647 feature_get(struct Client* from, const char* const* fields, int count)
648 {
649   struct FeatureDesc *feat;
650
651   assert(0 != from);
652
653   if (count < 1) /* check parameters */
654     need_more_params(from, "GET");
655   else if ((feat = feature_desc(from, fields[0]))) {
656     if ((feat->flags & FEAT_NODISP) ||
657         (feat->flags & FEAT_MYOPER && !MyOper(from)) ||
658         (feat->flags & FEAT_OPER && !IsAnOper(from))) /* check privs */
659       return send_reply(from, ERR_NOPRIVILEGES);
660
661     switch (feat->flags & FEAT_MASK) {
662     case FEAT_NONE: /* none, call the callback... */
663       if (feat->get) /* if there's a callback, use it */
664         (*feat->get)(from, fields + 1, count - 1);
665       break;
666
667     case FEAT_INT: /* integer, report integer value */
668       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
669                  ":Integer value of %s: %d", feat->type, feat->v_int);
670       break;
671
672     case FEAT_BOOL: /* boolean, report boolean value */
673       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
674                  ":Boolean value of %s: %s", feat->type,
675                  feat->v_int ? "TRUE" : "FALSE");
676       break;
677
678     case FEAT_STR: /* string, report string value */
679       if (feat->v_str) /* deal with null case */
680         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
681                    ":String value of %s: %s", feat->type, feat->v_str);
682       else
683         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
684                    ":String value for %s not set", feat->type);
685       break;
686     }
687   }
688
689   return 0;
690 }
691
692 /** Called before reading the .conf to clear all dirty marks. */
693 void
694 feature_unmark(void)
695 {
696   int i;
697
698   for (i = 0; features[i].type; i++) {
699     features[i].flags &= ~FEAT_MARK; /* clear the marks... */
700     if (features[i].unmark) /* call the unmark callback if necessary */
701       (*features[i].unmark)();
702   }
703 }
704
705 /** Called after reading the .conf to reset unmodified values to defaults. */
706 void
707 feature_mark(void)
708 {
709   int i, change;
710
711   for (i = 0; features[i].type; i++) {
712     change = 0;
713
714     switch (features[i].flags & FEAT_MASK) {
715     case FEAT_NONE:
716       if (features[i].mark &&
717           (*features[i].mark)(features[i].flags & FEAT_MARK ? 1 : 0))
718         change++; /* feature handler wants a change recorded */
719       break;
720
721     case FEAT_INT:  /* Integers or Booleans... */
722     case FEAT_BOOL:
723       if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
724         if (features[i].v_int != features[i].def_int)
725           change++; /* we're making a change */
726         features[i].v_int = features[i].def_int;
727       }
728       break;
729
730     case FEAT_STR: /* strings... */
731       if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
732         if (features[i].v_str != features[i].def_str) {
733           change++; /* we're making a change */
734           if (features[i].v_str)
735             MyFree(features[i].v_str); /* free old value */
736         }
737         features[i].v_str = features[i].def_str;
738       }
739       break;
740     }
741
742     if (change && features[i].notify)
743       (*features[i].notify)(); /* call change notify function */
744   }
745 }
746
747 /** Initialize the features subsystem. */
748 void
749 feature_init(void)
750 {
751   int i;
752
753   for (i = 0; features[i].type; i++) {
754     switch (features[i].flags & FEAT_MASK) {
755     case FEAT_NONE: /* you're on your own */
756       break;
757
758     case FEAT_INT:  /* Integers or Booleans... */
759     case FEAT_BOOL:
760       features[i].v_int = features[i].def_int;
761       break;
762
763     case FEAT_STR:  /* Strings */
764       features[i].v_str = features[i].def_str;
765       assert(features[i].def_str || (features[i].flags & FEAT_NULL));
766       break;
767     }
768   }
769 }
770
771 /** Report all F-lines to a user.
772  * @param[in] to Client requesting statistics.
773  * @param[in] sd Stats descriptor for request (ignored).
774  * @param[in] param Extra parameter from user (ignored).
775  */
776 void
777 feature_report(struct Client* to, const struct StatDesc* sd, char* param)
778 {
779   int i;
780
781   for (i = 0; features[i].type; i++) {
782     if ((features[i].flags & FEAT_NODISP) ||
783         (features[i].flags & FEAT_MYOPER && !MyOper(to)) ||
784         (features[i].flags & FEAT_OPER && !IsAnOper(to)))
785       continue; /* skip this one */
786
787     switch (features[i].flags & FEAT_MASK) {
788     case FEAT_NONE:
789       if (features[i].report) /* let the callback handle this */
790         (*features[i].report)(to, features[i].flags & FEAT_MARK ? 1 : 0);
791       break;
792
793
794     case FEAT_INT: /* Report an F-line with integer values */
795       if (features[i].flags & FEAT_MARK) /* it's been changed */
796         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %d",
797                    features[i].type, features[i].v_int);
798       break;
799
800     case FEAT_BOOL: /* Report an F-line with boolean values */
801       if (features[i].flags & FEAT_MARK) /* it's been changed */
802         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
803                    features[i].type, features[i].v_int ? "TRUE" : "FALSE");
804       break;
805
806     case FEAT_STR: /* Report an F-line with string values */
807       if (features[i].flags & FEAT_MARK) { /* it's been changed */
808         if (features[i].v_str)
809           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
810                      features[i].type, features[i].v_str);
811         else /* Actually, F:<type> would reset it; you want F:<type>: */
812           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s",
813                      features[i].type);
814       }
815       break;
816     }
817   }
818 }
819
820 /** Return a feature's integer value.
821  * @param[in] feat &Feature identifier.
822  * @return Integer value of feature.
823  */
824 int
825 feature_int(enum Feature feat)
826 {
827   assert(features[feat].feat == feat);
828   assert((features[feat].flags & FEAT_MASK) == FEAT_INT);
829
830   return features[feat].v_int;
831 }
832
833 /** Return a feature's boolean value.
834  * @param[in] feat &Feature identifier.
835  * @return Boolean value of feature.
836  */
837 int
838 feature_bool(enum Feature feat)
839 {
840   assert(feat <= FEAT_LAST_F);
841   if (FEAT_LAST_F < feat)
842     return 0;
843   assert(features[feat].feat == feat);
844   assert((features[feat].flags & FEAT_MASK) == FEAT_BOOL);
845
846   return features[feat].v_int;
847 }
848
849 /** Return a feature's string value.
850  * @param[in] feat &Feature identifier.
851  * @return String value of feature.
852  */
853 const char *
854 feature_str(enum Feature feat)
855 {
856   assert(features[feat].feat == feat);
857   assert((features[feat].flags & FEAT_MASK) == FEAT_STR);
858
859   return features[feat].v_str;
860 }