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
 320   /* Some misc. default paths */
 321   F_S(MPATH, FEAT_CASE | FEAT_MYOPER, "ircd.motd", motd_init),
 322   F_S(RPATH, FEAT_CASE | FEAT_MYOPER, "remote.motd", motd_init),
 323   F_S(PPATH, FEAT_CASE | FEAT_MYOPER | FEAT_READ, "ircd.pid", 0),
 324
 325   /* Networking features */
 326   F_I(TOS_SERVER, 0, 0x08, 0),
 327   F_I(TOS_CLIENT, 0, 0x08, 0),
 328   F_I(POLLS_PER_LOOP, 0, 200, 0),
 329   F_I(IRCD_RES_RETRIES, 0, 2, 0),
 330   F_I(IRCD_RES_TIMEOUT, 0, 4, 0),
 331   F_I(AUTH_TIMEOUT, 0, 9, 0),
 332   F_B(ANNOUNCE_INVITES, 0, 0, 0),
 333
 334   /* features that affect all operators */
 335   F_B(CONFIG_OPERCMDS, 0, 0, 0),
 336
 337   /* HEAD_IN_SAND Features */
 338   F_B(HIS_SNOTICES, 0, 1, 0),
 339   F_B(HIS_SNOTICES_OPER_ONLY, 0, 1, 0),
 340   F_B(HIS_DEBUG_OPER_ONLY, 0, 1, 0),
 341   F_B(HIS_WALLOPS, 0, 1, 0),
 342   F_B(HIS_MAP, 0, 1, 0),
 343   F_B(HIS_LINKS, 0, 1, 0),
 344   F_B(HIS_TRACE, 0, 1, 0),
 345   F_B(HIS_STATS_a, 0, 1, 0),
 346   F_B(HIS_STATS_c, 0, 1, 0),
 347   F_B(HIS_STATS_d, 0, 1, 0),
 348   F_B(HIS_STATS_e, 0, 1, 0),
 349   F_B(HIS_STATS_f, 0, 1, 0),
 350   F_B(HIS_STATS_g, 0, 1, 0),
 351   F_B(HIS_STATS_i, 0, 1, 0),
 352   F_B(HIS_STATS_j, 0, 1, 0),
 353   F_B(HIS_STATS_J, 0, 1, 0),
 354   F_B(HIS_STATS_k, 0, 1, 0),
 355   F_B(HIS_STATS_l, 0, 1, 0),
 356   F_B(HIS_STATS_L, 0, 1, 0),
 357   F_B(HIS_STATS_M, 0, 1, 0),
 358   F_B(HIS_STATS_m, 0, 1, 0),
 359   F_B(HIS_STATS_o, 0, 1, 0),
 360   F_B(HIS_STATS_p, 0, 1, 0),
 361   F_B(HIS_STATS_q, 0, 1, 0),
 362   F_B(HIS_STATS_R, 0, 1, 0),
 363   F_B(HIS_STATS_r, 0, 1, 0),
 364   F_B(HIS_STATS_t, 0, 1, 0),
 365   F_B(HIS_STATS_T, 0, 1, 0),
 366   F_B(HIS_STATS_u, 0, 0, 0),
 367   F_B(HIS_STATS_U, 0, 1, 0),
 368   F_B(HIS_STATS_v, 0, 1, 0),
 369   F_B(HIS_STATS_w, 0, 0, 0),
 370   F_B(HIS_STATS_x, 0, 1, 0),
 371   F_B(HIS_STATS_y, 0, 1, 0),
 372   F_B(HIS_STATS_z, 0, 1, 0),
 373   F_B(HIS_WHOIS_SERVERNAME, 0, 1, 0),
 374   F_B(HIS_WHOIS_IDLETIME, 0, 1, 0),
 375   F_B(HIS_WHOIS_LOCALCHAN, 0, 1, 0),
 376   F_B(HIS_WHO_SERVERNAME, 0, 1, 0),
 377   F_B(HIS_WHO_HOPCOUNT, 0, 1, 0),
 378   F_B(HIS_BANWHO, 0, 1, 0),
 379   F_B(HIS_KILLWHO, 0, 1, 0),
 380   F_B(HIS_REWRITE, 0, 1, 0),
 381   F_I(HIS_REMOTE, 0, 1, 0),
 382   F_B(HIS_NETSPLIT, 0, 1, 0),
 383   F_S(HIS_SERVERNAME, 0, "*.undernet.org", 0),
 384   F_S(HIS_SERVERINFO, 0, "The Undernet Underworld", 0),
 385   F_S(HIS_URLSERVERS, 0, "http://www.undernet.org/servers.php", 0),
 386
 387   /* Misc. random stuff */
 388   F_S(NETWORK, 0, "UnderNet", 0),
 389   F_S(URL_CLIENTS, 0, "ftp://ftp.undernet.org/pub/irc/clients", 0),
 390
 391 #undef F_S
 392 #undef F_B
 393 #undef F_I
 394 #undef F_N
 395   { FEAT_LAST_F, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
 396 };
 397
 398 /** Given a feature's identifier, look up the feature descriptor.
 399  * @param[in] from Client looking up feature, or NULL.
 400  * @param[in] feature Feature name to find.
 401  * @return Pointer to a FeatureDesc, or NULL if none was found.
 402  */
 403 static struct FeatureDesc *
 404 feature_desc(struct Client* from, const char *feature)
 405 {
 406   int i;
 407
 408   assert(0 != feature);
 409
 410   for (i = 0; features[i].type; i++) /* find appropriate descriptor */
 411     if (!strcmp(feature, features[i].type))
 412       return &features[i];
 413
 414   Debug((DEBUG_ERROR, "Unknown feature \"%s\"", feature));
 415   if (from) /* report an error */
 416     send_reply(from, ERR_NOFEATURE, feature);
 417   else
 418     log_write(LS_CONFIG, L_ERROR, 0, "Unknown feature \"%s\"", feature);
 419
 420   return 0; /* not found */
 421 }
 422
 423 /** Given a feature vector string, set the value of a feature.
 424  * @param[in] from Client trying to set the feature, or NULL.
 425  * @param[in] fields Parameters to set, starting with feature name.
 426  * @param[in] count Number of fields in \a fields.
 427  * @return Zero (or, theoretically, CPTR_KILLED).
 428  */
 429 int
 430 feature_set(struct Client* from, const char* const* fields, int count)
 431 {
 432   int i, change = 0, tmp;
 433   const char *t_str;
 434   struct FeatureDesc *feat;
 435
 436   if (from && !HasPriv(from, PRIV_SET))
 437     return send_reply(from, ERR_NOPRIVILEGES);
 438
 439   if (count < 1) {
 440     if (from) /* report an error in the number of arguments */
 441       need_more_params(from, "SET");
 442     else
 443       log_write(LS_CONFIG, L_ERROR, 0, "Not enough fields in F line");
 444   } else if ((feat = feature_desc(from, fields[0]))) { /* find feature */
 445     if (from && feat->flags & FEAT_READ)
 446       return send_reply(from, ERR_NOFEATURE, fields[0]);
 447
 448     switch (feat->flags & FEAT_MASK) {
 449     case FEAT_NONE:
 450       if (feat->set && (i = (*feat->set)(from, fields + 1, count - 1))) {
 451         change++; /* feature handler wants a change recorded */
 452
 453         if (i > 0) /* call the set callback and do marking */
 454           feat->flags |= FEAT_MARK;
 455         else /* i < 0 */
 456           feat->flags &= ~FEAT_MARK;
 457         break;
 458       }
 459
 460     case FEAT_INT: /* an integer value */
 461       tmp = feat->v_int; /* detect changes... */
 462
 463       if (count < 2) { /* reset value */
 464         feat->v_int = feat->def_int;
 465         feat->flags &= ~FEAT_MARK;
 466       } else { /* ok, figure out the value and whether to mark it */
 467         feat->v_int = strtoul(fields[1], 0, 0);
 468         if (feat->v_int == feat->def_int)
 469           feat->flags &= ~FEAT_MARK;
 470         else
 471           feat->flags |= FEAT_MARK;
 472       }
 473
 474       if (feat->v_int != tmp) /* check for change */
 475         change++;
 476       break;
 477
 478     case FEAT_BOOL: /* it's a boolean value--true or false */
 479       tmp = feat->v_int; /* detect changes... */
 480
 481       if (count < 2) { /* reset value */
 482         feat->v_int = feat->def_int;
 483         feat->flags &= ~FEAT_MARK;
 484       } else { /* figure out the value and whether to mark it */
 485         if (!ircd_strncmp(fields[1], "TRUE", strlen(fields[1])) ||
 486             !ircd_strncmp(fields[1], "YES", strlen(fields[1])) ||
 487             (strlen(fields[1]) >= 2 &&
 488              !ircd_strncmp(fields[1], "ON", strlen(fields[1]))))
 489           feat->v_int = 1;
 490         else if (!ircd_strncmp(fields[1], "FALSE", strlen(fields[1])) ||
 491                  !ircd_strncmp(fields[1], "NO", strlen(fields[1])) ||
 492                  (strlen(fields[1]) >= 2 &&
 493                   !ircd_strncmp(fields[1], "OFF", strlen(fields[1]))))
 494           feat->v_int = 0;
 495         else if (from) /* report an error... */
 496           return send_reply(from, ERR_BADFEATVALUE, fields[1], feat->type);
 497         else {
 498           log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"%s\" for feature %s",
 499                     fields[1], feat->type);
 500           return 0;
 501         }
 502
 503         if (feat->v_int == feat->def_int) /* figure out whether to mark it */
 504           feat->flags &= ~FEAT_MARK;
 505         else
 506           feat->flags |= FEAT_MARK;
 507       }
 508
 509       if (feat->v_int != tmp) /* check for change */
 510         change++;
 511       break;
 512
 513     case FEAT_STR: /* it's a string value */
 514       if (count < 2)
 515         t_str = feat->def_str; /* changing to default */
 516       else
 517         t_str = *fields[1] ? fields[1] : 0;
 518
 519       if (!t_str && !(feat->flags & FEAT_NULL)) { /* NULL value permitted? */
 520         if (from)
 521           return send_reply(from, ERR_BADFEATVALUE, "NULL", feat->type);
 522         else {
 523           log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"NULL\" for feature %s",
 524                     feat->type);
 525           return 0;
 526         }
 527       }
 528
 529       if (t_str == feat->def_str ||
 530           (t_str && feat->def_str &&
 531            !(feat->flags & FEAT_CASE ? strcmp(t_str, feat->def_str) :
 532              ircd_strcmp(t_str, feat->def_str)))) { /* resetting to default */
 533         if (feat->v_str != feat->def_str) {
 534           change++; /* change from previous value */
 535
 536           if (feat->v_str)
 537             MyFree(feat->v_str); /* free old value */
 538         }
 539
 540         feat->v_str = feat->def_str; /* very special... */
 541
 542         feat->flags &= ~FEAT_MARK;
 543       } else if (!t_str) {
 544         if (feat->v_str) {
 545           change++; /* change from previous value */
 546
 547           if (feat->v_str != feat->def_str)
 548             MyFree(feat->v_str); /* free old value */
 549         }
 550
 551         feat->v_str = 0; /* set it to NULL */
 552
 553         feat->flags |= FEAT_MARK;
 554       } else if (!feat->v_str ||
 555                  (feat->flags & FEAT_CASE ? strcmp(t_str, feat->v_str) :
 556                   ircd_strcmp(t_str, feat->v_str))) { /* new value */
 557         change++; /* change from previous value */
 558
 559         if (feat->v_str && feat->v_str != feat->def_str)
 560           MyFree(feat->v_str); /* free old value */
 561         DupString(feat->v_str, t_str); /* store new value */
 562
 563         feat->flags |= FEAT_MARK;
 564       } else /* they match, but don't match the default */
 565         feat->flags |= FEAT_MARK;
 566       break;
 567     }
 568
 569     if (change && feat->notify) /* call change notify function */
 570       (*feat->notify)();
 571   }
 572
 573   return 0;
 574 }
 575
 576 /** Reset a feature to its default values.
 577  * @param[in] from Client trying to reset the feature, or NULL.
 578  * @param[in] fields Parameters to set, starting with feature name.
 579  * @param[in] count Number of fields in \a fields.
 580  * @return Zero (or, theoretically, CPTR_KILLED).
 581  */
 582 int
 583 feature_reset(struct Client* from, const char* const* fields, int count)
 584 {
 585   int i, change = 0;
 586   struct FeatureDesc *feat;
 587
 588   assert(0 != from);
 589
 590   if (!HasPriv(from, PRIV_SET))
 591     return send_reply(from, ERR_NOPRIVILEGES);
 592
 593   if (count < 1) /* check arguments */
 594     need_more_params(from, "RESET");
 595   else if ((feat = feature_desc(from, fields[0]))) { /* get descriptor */
 596     if (from && feat->flags & FEAT_READ)
 597       return send_reply(from, ERR_NOFEATURE, fields[0]);
 598
 599     switch (feat->flags & FEAT_MASK) {
 600     case FEAT_NONE: /* None... */
 601       if (feat->reset && (i = (*feat->reset)(from, fields + 1, count - 1))) {
 602         change++; /* feature handler wants a change recorded */
 603
 604         if (i > 0) /* call reset callback and parse mark return */
 605           feat->flags |= FEAT_MARK;
 606         else /* i < 0 */
 607           feat->flags &= ~FEAT_MARK;
 608       }
 609       break;
 610
 611     case FEAT_INT:  /* Integer... */
 612     case FEAT_BOOL: /* Boolean... */
 613       if (feat->v_int != feat->def_int)
 614         change++; /* change will be made */
 615
 616       feat->v_int = feat->def_int; /* set the default */
 617       feat->flags &= ~FEAT_MARK; /* unmark it */
 618       break;
 619
 620     case FEAT_STR: /* string! */
 621       if (feat->v_str != feat->def_str) {
 622         change++; /* change has been made */
 623         if (feat->v_str)
 624           MyFree(feat->v_str); /* free old value */
 625       }
 626
 627       feat->v_str = feat->def_str; /* set it to default */
 628       feat->flags &= ~FEAT_MARK; /* unmark it */
 629       break;
 630     }
 631
 632     if (change && feat->notify) /* call change notify function */
 633       (*feat->notify)();
 634   }
 635
 636   return 0;
 637 }
 638
 639 /** Gets the value of a specific feature and reports it to the user.
 640  * @param[in] from Client trying to get the feature.
 641  * @param[in] fields Parameters to set, starting with feature name.
 642  * @param[in] count Number of fields in \a fields.
 643  * @return Zero (or, theoretically, CPTR_KILLED).
 644  */
 645 int
 646 feature_get(struct Client* from, const char* const* fields, int count)
 647 {
 648   struct FeatureDesc *feat;
 649
 650   assert(0 != from);
 651
 652   if (count < 1) /* check parameters */
 653     need_more_params(from, "GET");
 654   else if ((feat = feature_desc(from, fields[0]))) {
 655     if ((feat->flags & FEAT_NODISP) ||
 656         (feat->flags & FEAT_MYOPER && !MyOper(from)) ||
 657         (feat->flags & FEAT_OPER && !IsAnOper(from))) /* check privs */
 658       return send_reply(from, ERR_NOPRIVILEGES);
 659
 660     switch (feat->flags & FEAT_MASK) {
 661     case FEAT_NONE: /* none, call the callback... */
 662       if (feat->get) /* if there's a callback, use it */
 663         (*feat->get)(from, fields + 1, count - 1);
 664       break;
 665
 666     case FEAT_INT: /* integer, report integer value */
 667       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 668                  ":Integer value of %s: %d", feat->type, feat->v_int);
 669       break;
 670
 671     case FEAT_BOOL: /* boolean, report boolean value */
 672       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 673                  ":Boolean value of %s: %s", feat->type,
 674                  feat->v_int ? "TRUE" : "FALSE");
 675       break;
 676
 677     case FEAT_STR: /* string, report string value */
 678       if (feat->v_str) /* deal with null case */
 679         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 680                    ":String value of %s: %s", feat->type, feat->v_str);
 681       else
 682         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 683                    ":String value for %s not set", feat->type);
 684       break;
 685     }
 686   }
 687
 688   return 0;
 689 }
 690
 691 /** Called before reading the .conf to clear all dirty marks. */
 692 void
 693 feature_unmark(void)
 694 {
 695   int i;
 696
 697   for (i = 0; features[i].type; i++) {
 698     features[i].flags &= ~FEAT_MARK; /* clear the marks... */
 699     if (features[i].unmark) /* call the unmark callback if necessary */
 700       (*features[i].unmark)();
 701   }
 702 }
 703
 704 /** Called after reading the .conf to reset unmodified values to defaults. */
 705 void
 706 feature_mark(void)
 707 {
 708   int i, change;
 709
 710   for (i = 0; features[i].type; i++) {
 711     change = 0;
 712
 713     switch (features[i].flags & FEAT_MASK) {
 714     case FEAT_NONE:
 715       if (features[i].mark &&
 716           (*features[i].mark)(features[i].flags & FEAT_MARK ? 1 : 0))
 717         change++; /* feature handler wants a change recorded */
 718       break;
 719
 720     case FEAT_INT:  /* Integers or Booleans... */
 721     case FEAT_BOOL:
 722       if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
 723         if (features[i].v_int != features[i].def_int)
 724           change++; /* we're making a change */
 725         features[i].v_int = features[i].def_int;
 726       }
 727       break;
 728
 729     case FEAT_STR: /* strings... */
 730       if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
 731         if (features[i].v_str != features[i].def_str) {
 732           change++; /* we're making a change */
 733           if (features[i].v_str)
 734             MyFree(features[i].v_str); /* free old value */
 735         }
 736         features[i].v_str = features[i].def_str;
 737       }
 738       break;
 739     }
 740
 741     if (change && features[i].notify)
 742       (*features[i].notify)(); /* call change notify function */
 743   }
 744 }
 745
 746 /** Initialize the features subsystem. */
 747 void
 748 feature_init(void)
 749 {
 750   int i;
 751
 752   for (i = 0; features[i].type; i++) {
 753     switch (features[i].flags & FEAT_MASK) {
 754     case FEAT_NONE: /* you're on your own */
 755       break;
 756
 757     case FEAT_INT:  /* Integers or Booleans... */
 758     case FEAT_BOOL:
 759       features[i].v_int = features[i].def_int;
 760       break;
 761
 762     case FEAT_STR:  /* Strings */
 763       features[i].v_str = features[i].def_str;
 764       assert(features[i].def_str || (features[i].flags & FEAT_NULL));
 765       break;
 766     }
 767   }
 768 }
 769
 770 /** Report all F-lines to a user.
 771  * @param[in] to Client requesting statistics.
 772  * @param[in] sd Stats descriptor for request (ignored).
 773  * @param[in] param Extra parameter from user (ignored).
 774  */
 775 void
 776 feature_report(struct Client* to, const struct StatDesc* sd, char* param)
 777 {
 778   int i;
 779
 780   for (i = 0; features[i].type; i++) {
 781     if ((features[i].flags & FEAT_NODISP) ||
 782         (features[i].flags & FEAT_MYOPER && !MyOper(to)) ||
 783         (features[i].flags & FEAT_OPER && !IsAnOper(to)))
 784       continue; /* skip this one */
 785
 786     switch (features[i].flags & FEAT_MASK) {
 787     case FEAT_NONE:
 788       if (features[i].report) /* let the callback handle this */
 789         (*features[i].report)(to, features[i].flags & FEAT_MARK ? 1 : 0);
 790       break;
 791
 792
 793     case FEAT_INT: /* Report an F-line with integer values */
 794       if (features[i].flags & FEAT_MARK) /* it's been changed */
 795         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %d",
 796                    features[i].type, features[i].v_int);
 797       break;
 798
 799     case FEAT_BOOL: /* Report an F-line with boolean values */
 800       if (features[i].flags & FEAT_MARK) /* it's been changed */
 801         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
 802                    features[i].type, features[i].v_int ? "TRUE" : "FALSE");
 803       break;
 804
 805     case FEAT_STR: /* Report an F-line with string values */
 806       if (features[i].flags & FEAT_MARK) { /* it's been changed */
 807         if (features[i].v_str)
 808           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
 809                      features[i].type, features[i].v_str);
 810         else /* Actually, F:<type> would reset it; you want F:<type>: */
 811           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s",
 812                      features[i].type);
 813       }
 814       break;
 815     }
 816   }
 817 }
 818
 819 /** Return a feature's integer value.
 820  * @param[in] feat &Feature identifier.
 821  * @return Integer value of feature.
 822  */
 823 int
 824 feature_int(enum Feature feat)
 825 {
 826   assert(features[feat].feat == feat);
 827   assert((features[feat].flags & FEAT_MASK) == FEAT_INT);
 828
 829   return features[feat].v_int;
 830 }
 831
 832 /** Return a feature's boolean value.
 833  * @param[in] feat &Feature identifier.
 834  * @return Boolean value of feature.
 835  */
 836 int
 837 feature_bool(enum Feature feat)
 838 {
 839   assert(feat <= FEAT_LAST_F);
 840   if (FEAT_LAST_F < feat)
 841     return 0;
 842   assert(features[feat].feat == feat);
 843   assert((features[feat].flags & FEAT_MASK) == FEAT_BOOL);
 844
 845   return features[feat].v_int;
 846 }
 847
 848 /** Return a feature's string value.
 849  * @param[in] feat &Feature identifier.
 850  * @return String value of feature.
 851  */
 852 const char *
 853 feature_str(enum Feature feat)
 854 {
 855   assert(features[feat].feat == feat);
 856   assert((features[feat].flags & FEAT_MASK) == FEAT_STR);
 857
 858   return features[feat].v_str;
 859 }