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