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 "ircd_features.h"
  22 #include "client.h"
  23 #include "hash.h"
  24 #include "ircd.h"
  25 #include "ircd_alloc.h"
  26 #include "ircd_log.h"
  27 #include "ircd_reply.h"
  28 #include "ircd_string.h"
  29 #include "match.h"
  30 #include "msg.h"
  31 #include "numeric.h"
  32 #include "numnicks.h"
  33 #include "s_bsd.h"
  34 #include "s_debug.h"
  35 #include "s_misc.h"
  36 #include "send.h"
  37 #include "struct.h"
  38 #include "support.h"
  39 #include "sys.h"    /* FALSE bleah */
  40
  41 #include <assert.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44
  45 /* List of log output types that can be set */
  46 static struct LogTypes {
  47   char *type;
  48   int (*set)(const char *, const char *);
  49   char *(*get)(const char *);
  50 } logTypes[] = {
  51   { "FILE", log_set_file, log_get_file },
  52   { "FACILITY", log_set_facility, log_get_facility },
  53   { "SNOMASK", log_set_snomask, log_get_snomask },
  54   { "LEVEL", log_set_level, log_get_level },
  55   { 0, 0, 0 }
  56 };
  57
  58 /* Look up a struct LogType given the type string */
  59 static struct LogTypes *
  60 feature_log_desc(struct Client* from, const char *type)
  61 {
  62   int i;
  63
  64   assert(0 != type);
  65
  66   for (i = 0; logTypes[i].type; i++) /* find appropriate descriptor */
  67     if (!ircd_strcmp(type, logTypes[i].type))
  68       return &logTypes[i];
  69
  70   Debug((DEBUG_ERROR, "Unknown log feature type \"%s\"", type));
  71   if (from) /* send an error; if from is NULL, called from conf parser */
  72     send_reply(from, ERR_BADLOGTYPE, type);
  73   else
  74     log_write(LS_CONFIG, L_ERROR, 0, "Unknown log feature type \"%s\"", type);
  75
  76   return 0; /* not found */
  77 }
  78
  79 /* Set the value of a log output type for a log subsystem */
  80 static int
  81 feature_log_set(struct Client* from, const char* const* fields, int count)
  82 {
  83   struct LogTypes *desc;
  84   char *subsys;
  85
  86   if (count < 2) { /* set default facility */
  87     if (log_set_default(count < 1 ? 0 : fields[0])) {
  88       assert(count >= 1); /* should always accept default */
  89
  90       if (from) /* send an error */
  91         send_reply(from, ERR_BADLOGVALUE, fields[0]);
  92       else
  93         log_write(LS_CONFIG, L_ERROR, 0,
  94                   "Bad value \"%s\" for default facility", fields[0]);
  95     } else
  96       return count < 1 ? -1 : 1; /* tell feature to set or clear mark */
  97   } else if (!(subsys = log_canon(fields[0]))) { /* no such subsystem */
  98     if (from) /* send an error */
  99       send_reply(from, ERR_BADLOGSYS, fields[0]);
 100     else
 101       log_write(LS_CONFIG, L_ERROR, 0,
 102                 "No such logging subsystem \"%s\"", fields[0]);
 103   } else if ((desc = feature_log_desc(from, fields[1]))) { /* set value */
 104     if ((*desc->set)(fields[0], count < 3 ? 0 : fields[2])) {
 105       assert(count >= 3); /* should always accept default */
 106
 107       if (from) /* send an error */
 108         send_reply(from, ERR_BADLOGVALUE, fields[2]);
 109       else
 110         log_write(LS_CONFIG, L_ERROR, 0,
 111                   "Bad value \"%s\" for log type %s (subsystem %s)",
 112                   fields[2], desc->type, subsys);
 113     }
 114   }
 115
 116   return 0;
 117 }
 118
 119 /* reset a log type for a subsystem to its default value */
 120 static int
 121 feature_log_reset(struct Client* from, const char* const* fields, int count)
 122 {
 123   struct LogTypes *desc;
 124   char *subsys;
 125
 126   assert(0 != from); /* Never called by the .conf parser */
 127
 128   if (count < 1) { /* reset default facility */
 129     log_set_default(0);
 130     return -1; /* unmark this entry */
 131   } else if (count < 2)
 132     need_more_params(from, "RESET");
 133   else if (!(subsys = log_canon(fields[0]))) /* no such subsystem */
 134     send_reply(from, ERR_BADLOGSYS, fields[0]);
 135   else if ((desc = feature_log_desc(from, fields[1]))) /* reset value */
 136     (*desc->set)(fields[0], 0); /* default should always be accepted */
 137
 138   return 0;
 139 }
 140
 141 /* report the value of a log setting */
 142 static void
 143 feature_log_get(struct Client* from, const char* const* fields, int count)
 144 {
 145   struct LogTypes *desc;
 146   char *value, *subsys;
 147
 148   assert(0 != from); /* never called by .conf parser */
 149
 150   if (count < 1) /* return default facility */
 151     send_reply(from, SND_EXPLICIT | RPL_FEATURE, ":Log facility: %s",
 152                log_get_default());
 153   else if (count < 2)
 154     need_more_params(from, "GET");
 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]))) {
 158     if ((value = (*desc->get)(fields[0]))) /* send along value */
 159       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 160                  ":Log %s for subsystem %s: %s", desc->type, subsys,
 161                  (*desc->get)(subsys));
 162     else
 163       send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 164                  ":No log %s is set for subsystem %s", desc->type, subsys);
 165   }
 166 }
 167
 168 /* sets a feature to the given value */
 169 typedef int  (*feat_set_call)(struct Client*, const char* const*, int);
 170 /* gets the value of a feature */
 171 typedef void (*feat_get_call)(struct Client*, const char* const*, int);
 172 /* unmarks all sub-feature values prior to reading .conf */
 173 typedef void (*feat_unmark_call)(void);
 174 /* resets to defaults all currently unmarked values */
 175 typedef void (*feat_mark_call)(int);
 176 /* reports features as a /stats f list */
 177 typedef void (*feat_report_call)(struct Client*, int);
 178
 179 #define FEAT_NONE   0x0000      /* no value */
 180 #define FEAT_INT    0x0001      /* set if entry contains an integer value */
 181 #define FEAT_BOOL   0x0002      /* set if entry contains a boolean value */
 182 #define FEAT_STR    0x0003      /* set if entry contains a string value */
 183 #define FEAT_MASK   0x000f      /* possible value types */
 184
 185 #define FEAT_MARK   0x0010      /* set if entry has been changed */
 186 #define FEAT_NULL   0x0020      /* NULL string is permitted */
 187 #define FEAT_CASE   0x0040      /* string is case-sensitive */
 188
 189 #define FEAT_OPER   0x0100      /* set to display only to opers */
 190 #define FEAT_MYOPER 0x0200      /* set to display only to local opers */
 191
 192 static struct FeatureDesc {
 193   enum Feature     feat;    /* feature identifier */
 194   char*            type;    /* string describing type */
 195   unsigned int     flags;   /* flags for feature */
 196   int              v_int;   /* integer value */
 197   int              def_int; /* default value */
 198   char*            v_str;   /* string value */
 199   char*            def_str; /* default value */
 200   feat_set_call    set;     /* set feature values */
 201   feat_set_call    reset;   /* reset feature values to defaults */
 202   feat_get_call    get;     /* get feature values */
 203   feat_unmark_call unmark;  /* unmark all feature change values */
 204   feat_mark_call   mark;    /* reset to defaults all unchanged features */
 205   feat_report_call report;  /* report feature values */
 206 } features[] = {
 207 #define F(type, flags, v_int, v_str, set, reset, get, unmark, mark, report)   \
 208   { FEAT_ ## type, #type, (flags), 0, (v_int), 0, (v_str),                    \
 209     (set), (reset), (get), (unmark), (mark), (report) }
 210 #define F_I(type, v_int)                                                      \
 211   { FEAT_ ## type, #type, FEAT_INT, 0, (v_int), 0, 0, 0, 0, 0, 0, 0, 0 }
 212 #define F_B(type, v_int)                                                      \
 213   { FEAT_ ## type, #type, FEAT_BOOL, 0, (v_int), 0, 0, 0, 0, 0, 0, 0, 0 }
 214 #define F_S(type, flags, v_int)                                               \
 215   { FEAT_ ## type, #type, FEAT_STR | (flags), 0, 0, 0, (v_str),               \
 216     0, 0, 0, 0, 0, 0 }
 217
 218   F(LOG, FEAT_NONE | FEAT_MYOPER, 0, 0,
 219     feature_log_set, feature_log_reset, feature_log_get,
 220     log_feature_unmark, log_feature_mark, log_feature_report),
 221
 222   F_B(OPER_NO_CHAN_LIMIT, 1),
 223   F_B(OPER_MODE_LCHAN, 1),
 224   F_B(OPER_WALK_THROUGH_LMODES, 0),
 225   F_B(NO_OPER_DEOP_LCHAN, 0),
 226   F_B(SHOW_INVISIBLE_USERS, 1),
 227   F_B(SHOW_ALL_INVISIBLE_USERS, 1),
 228   F_B(UNLIMIT_OPER_QUERY, 0),
 229   F_B(LOCAL_KILL_ONLY, 0),
 230   F_B(CONFIG_OPERCMDS, 1), /* XXX change default before release */
 231
 232   F_B(OPER_KILL, 1),
 233   F_B(OPER_REHASH, 1),
 234   F_B(OPER_RESTART, 1),
 235   F_B(OPER_DIE, 1),
 236   F_B(OPER_GLINE, 1),
 237   F_B(OPER_LGLINE, 1),
 238   F_B(OPER_JUPE, 1),
 239   F_B(OPER_LJUPE, 1),
 240   F_B(OPER_OPMODE, 1),
 241   F_B(OPER_LOPMODE, 1),
 242   F_B(OPER_BADCHAN, 0),
 243   F_B(OPER_LBADCHAN, 0),
 244   F_B(OPERS_SEE_IN_SECRET_CHANNELS, 1),
 245
 246   F_B(LOCOP_KILL, 0),
 247   F_B(LOCOP_REHASH, 1),
 248   F_B(LOCOP_RESTART, 0),
 249   F_B(LOCOP_DIE, 0),
 250   F_B(LOCOP_LGLINE, 1),
 251   F_B(LOCOP_LJUPE, 1),
 252   F_B(LOCOP_LOPMODE, 1),
 253   F_B(LOCOP_LBADCHAN, 0),
 254   F_B(LOCOP_SEE_IN_SECRET_CHANNELS, 0),
 255
 256 #undef F_S
 257 #undef F_B
 258 #undef F_I
 259 #undef F
 260   { FEAT_LAST_F, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
 261 };
 262
 263 /* Given a feature's identifier, look up the feature descriptor */
 264 static struct FeatureDesc *
 265 feature_desc(struct Client* from, const char *feature)
 266 {
 267   int i;
 268
 269   assert(0 != feature);
 270
 271   for (i = 0; features[i].type; i++) /* find appropriate descriptor */
 272     if (!ircd_strcmp(feature, features[i].type))
 273       return &features[i];
 274
 275   Debug((DEBUG_ERROR, "Unknown feature \"%s\"", feature));
 276   if (from) /* report an error */
 277     send_reply(from, ERR_NOFEATURE, feature);
 278   else
 279     log_write(LS_CONFIG, L_ERROR, 0, "Unknown feature \"%s\"", feature);
 280
 281   return 0; /* not found */
 282 }
 283
 284 /* Given a feature vector string, set the value of a feature */
 285 int
 286 feature_set(struct Client* from, const char* const* fields, int count)
 287 {
 288   int i;
 289   struct FeatureDesc *feat;
 290
 291   if (from && !HasPriv(from, PRIV_SET))
 292     return send_reply(from, ERR_NOPRIVILEGES);
 293
 294   if (count < 1) {
 295     if (from) /* report an error in the number of arguments */
 296       need_more_params(from, "SET");
 297     else
 298       log_write(LS_CONFIG, L_ERROR, 0, "Not enough fields in F line");
 299   } else if ((feat = feature_desc(from, fields[0]))) { /* find feature */
 300     if (feat->set && (i = (*feat->set)(from, fields + 1, count - 1))) {
 301       if (i > 0) /* call the set callback and do marking */
 302         feat->flags |= FEAT_MARK;
 303       else /* i < 0 */
 304         feat->flags &= ~FEAT_MARK;
 305     } else /* Ok, it's a value we can fiddle with */
 306       switch (feat->flags & FEAT_MASK) {
 307       case FEAT_INT: /* an integer value */
 308         if (count < 2) { /* reset value */
 309           feat->v_int = feat->def_int;
 310           feat->flags &= ~FEAT_MARK;
 311         } else { /* ok, figure out the value and whether to mark it */
 312           feat->v_int = atoi(fields[1]);
 313           if (feat->v_int == feat->def_int)
 314             feat->flags &= ~FEAT_MARK;
 315           else
 316             feat->flags |= FEAT_MARK;
 317         }
 318         break;
 319
 320       case FEAT_BOOL: /* it's a boolean value--true or false */
 321         if (count < 2) { /* reset value */
 322           feat->v_int = feat->def_int;
 323           feat->flags &= ~FEAT_MARK;
 324         } else { /* figure out the value and whether to mark it */
 325           if (!ircd_strncmp(fields[1], "TRUE", strlen(fields[1])))
 326             feat->v_int = 1;
 327           else if (!ircd_strncmp(fields[1], "YES", strlen(fields[1])))
 328             feat->v_int = 1;
 329           else if (!ircd_strncmp(fields[1], "FALSE", strlen(fields[1])))
 330             feat->v_int = 0;
 331           else if (!ircd_strncmp(fields[1], "NO", strlen(fields[1])))
 332             feat->v_int = 0;
 333           else if (from) /* report an error... */
 334             return send_reply(from, ERR_BADFEATVALUE, fields[1], feat->type);
 335           else {
 336             log_write(LS_CONFIG, L_ERROR, 0, "Bad value \"%s\" for feature %s",
 337                       fields[1], feat->type);
 338             return 0;
 339           }
 340
 341           if (feat->v_int == feat->def_int) /* figure out whether to mark it */
 342             feat->flags &= ~FEAT_MARK;
 343           else
 344             feat->flags |= FEAT_MARK;
 345         }
 346         break;
 347
 348       case FEAT_STR: /* it's a string value */
 349         if (count < 2 ||
 350             !(feat->flags & FEAT_CASE ? strcmp(fields[1], feat->def_str) :
 351               ircd_strcmp(fields[1], feat->def_str))) { /* reset to default */
 352           if (feat->v_str && feat->v_str != feat->def_str)
 353             MyFree(feat->v_str); /* free old value */
 354           feat->v_str = feat->def_str; /* very special... */
 355
 356           feat->flags &= ~FEAT_MARK; /* unmark it */
 357         } else {
 358           if (!*fields[1]) { /* empty string translates to NULL */
 359             if (feat->flags & FEAT_NULL) { /* permitted? */
 360               if (feat->v_str && feat->v_str != feat->def_str)
 361                 MyFree(feat->v_str); /* free old value */
 362               feat->v_str = 0; /* set it to NULL */
 363             } else if (from) /* hmmm...not permitted; report error */
 364               return send_reply(from, ERR_BADFEATVALUE, "NULL", feat->type);
 365             else {
 366               log_write(LS_CONFIG, L_ERROR, 0,
 367                         "Bad value \"NULL\" for feature %s", feat->type);
 368               return 0;
 369             }
 370           } else if ((feat->flags & FEAT_CASE ?
 371                       strcmp(fields[1], feat->v_str) :
 372                       ircd_strcmp(fields[1], feat->v_str))) { /* new value */
 373             if (feat->v_str && feat->v_str != feat->def_str)
 374               MyFree(feat->v_str); /* free old value */
 375             DupString(feat->v_str, fields[1]); /* store new value */
 376           }
 377
 378           feat->flags |= FEAT_MARK; /* mark it as having been touched */
 379         }
 380         break;
 381       }
 382   }
 383
 384   return 0;
 385 }
 386
 387 /* reset a feature to its default values */
 388 int
 389 feature_reset(struct Client* from, const char* const* fields, int count)
 390 {
 391   int i;
 392   struct FeatureDesc *feat;
 393
 394   assert(0 != from);
 395
 396   if (!HasPriv(from, PRIV_SET))
 397     return send_reply(from, ERR_NOPRIVILEGES);
 398
 399   if (count < 1) /* check arguments */
 400     need_more_params(from, "RESET");
 401   else if ((feat = feature_desc(from, fields[0]))) { /* get descriptor */
 402     if (feat->reset && (i = (*feat->reset)(from, fields + 1, count - 1))) {
 403       if (i > 0) /* call reset callback and parse mark return */
 404         feat->flags |= FEAT_MARK;
 405       else /* i < 0 */
 406         feat->flags &= ~FEAT_MARK;
 407     } else { /* oh, it's something we own... */
 408       switch (feat->flags & FEAT_MASK) {
 409       case FEAT_INT:  /* Integer... */
 410       case FEAT_BOOL: /* Boolean... */
 411         feat->v_int = feat->def_int; /* set the default */
 412         break;
 413
 414       case FEAT_STR: /* string! */
 415         if (feat->v_str && feat->v_str != feat->def_str)
 416           MyFree(feat->v_str); /* free old value */
 417         feat->v_str = feat->def_str; /* set it to default */
 418         break;
 419       }
 420
 421       feat->flags &= ~FEAT_MARK; /* unmark it */
 422     }
 423   }
 424
 425   return 0;
 426 }
 427
 428 /* Gets the value of a specific feature and reports it to the user */
 429 int
 430 feature_get(struct Client* from, const char* const* fields, int count)
 431 {
 432   struct FeatureDesc *feat;
 433
 434   assert(0 != from);
 435
 436   if (count < 1) /* check parameters */
 437     need_more_params(from, "GET");
 438   else if ((feat = feature_desc(from, fields[0]))) {
 439     if ((feat->flags & FEAT_MYOPER && !MyOper(from)) ||
 440         (feat->flags & FEAT_OPER && !IsAnOper(from))) /* check privs */
 441       return send_reply(from, ERR_NOPRIVILEGES);
 442
 443     if (feat->get) /* if there's a callback, use it */
 444       (*feat->get)(from, fields + 1, count - 1);
 445     else /* something we own */
 446       switch (feat->flags & FEAT_MASK) {
 447       case FEAT_INT: /* integer, report integer value */
 448         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 449                    ":Integer value of %s: %d", feat->type, feat->v_int);
 450         break;
 451
 452       case FEAT_BOOL: /* boolean, report boolean value */
 453         send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 454                    ":Boolean value of %s: %s", feat->type,
 455                    feat->v_int ? "TRUE" : "FALSE");
 456         break;
 457
 458       case FEAT_STR: /* string, report string value */
 459         if (feat->v_str) /* deal with null case */
 460           send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 461                      ":String value of %s: %s", feat->type, feat->v_str);
 462         else
 463           send_reply(from, SND_EXPLICIT | RPL_FEATURE,
 464                      ":String value for %s not set", feat->type);
 465         break;
 466       }
 467   }
 468
 469   return 0;
 470 }
 471
 472 /* called before reading the .conf to clear all marks */
 473 void
 474 feature_unmark(void)
 475 {
 476   int i;
 477
 478   for (i = 0; features[i].type; i++) {
 479     features[i].flags &= ~FEAT_MARK; /* clear the marks... */
 480     if (features[i].unmark) /* call the unmark callback if necessary */
 481       (*features[i].unmark)();
 482   }
 483 }
 484
 485 /* Called after reading the .conf to reset unmodified values to defaults */
 486 void
 487 feature_mark(void)
 488 {
 489   int i;
 490
 491   for (i = 0; features[i].type; i++) {
 492     if (!(features[i].flags & FEAT_MARK)) { /* not changed? */
 493       switch (features[i].flags & FEAT_MASK) {
 494       case FEAT_INT:  /* Integers or Booleans... */
 495       case FEAT_BOOL:
 496         features[i].v_int = features[i].def_int;
 497         break;
 498
 499       case FEAT_STR: /* strings... */
 500         if (features[i].v_str && features[i].v_str != features[i].def_str)
 501           MyFree(features[i].v_str); /* free old value */
 502         features[i].v_str = features[i].def_str;
 503         break;
 504       }
 505     }
 506
 507     if (features[i].mark) /* call the mark callback if necessary */
 508       (*features[i].mark)(features[i].flags & FEAT_MARK ? 1 : 0);
 509   }
 510 }
 511
 512 /* report all F-lines */
 513 void
 514 feature_report(struct Client* to)
 515 {
 516   int i;
 517
 518   for (i = 0; features[i].type; i++) {
 519     if ((features[i].flags & FEAT_MYOPER && !MyOper(to)) ||
 520         (features[i].flags & FEAT_OPER && !IsAnOper(to)))
 521       continue; /* skip this one */
 522
 523     if (features[i].report) /* let the callback handle this */
 524       (*features[i].report)(to, features[i].flags & FEAT_MARK ? 1 : 0);
 525     else if (features[i].flags & FEAT_MARK) { /* it's been changed */
 526       switch (features[i].flags & FEAT_MASK) {
 527       case FEAT_INT: /* Report an F-line with integer values */
 528         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %d",
 529                    features[i].type, features[i].v_int);
 530         break;
 531
 532       case FEAT_BOOL: /* Report an F-line with boolean values */
 533         send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
 534                    features[i].type, features[i].v_int ? "TRUE" : "FALSE");
 535         break;
 536
 537       case FEAT_STR: /* Report an F-line with string values */
 538         if (features[i].v_str)
 539           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s %s",
 540                      features[i].type, features[i].v_str);
 541         else /* Actually, F:<type> would reset it; you want F:<type>: */
 542           send_reply(to, SND_EXPLICIT | RPL_STATSFLINE, "F %s",
 543                      features[i].type);
 544         break;
 545       }
 546     }
 547   }
 548 }
 549
 550 /* return a feature's integer value */
 551 int
 552 feature_int(enum Feature feat)
 553 {
 554   assert(features[feat].feat == feat);
 555   assert((features[feat].flags & FEAT_MASK) == FEAT_INT);
 556
 557   return features[feat].v_int;
 558 }
 559
 560 /* return a feature's boolean value */
 561 int
 562 feature_bool(enum Feature feat)
 563 {
 564   assert(features[feat].feat == feat);
 565   assert((features[feat].flags & FEAT_MASK) == FEAT_BOOL);
 566
 567   return features[feat].v_int;
 568 }
 569
 570 /* return a feature's string value */
 571 const char *
 572 feature_str(enum Feature feat)
 573 {
 574   assert(features[feat].feat == feat);
 575   assert((features[feat].flags & FEAT_MASK) == FEAT_STR);
 576
 577   return features[feat].v_str;
 578 }