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