include/configreader.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef INSPIRCD_CONFIGREADER
  15 #define INSPIRCD_CONFIGREADER
  16
  17 #include <sstream>
  18 #include <string>
  19 #include <vector>
  20 #include <map>
  21 #include "inspircd.h"
  22 #include "globals.h"
  23 #include "modules.h"
  24 #include "socketengine.h"
  25 #include "socket.h"
  26
  27 class ServerConfig;
  28 class InspIRCd;
  29 class InspSocket;
  30
  31 /** Types of data in the core config
  32  */
  33 enum ConfigDataType
  34 {
  35         DT_NOTHING       = 0,
  36         DT_INTEGER       = 1,
  37         DT_CHARPTR       = 2,
  38         DT_BOOLEAN       = 3,
  39         DT_ALLOW_NEWLINE = 128
  40 };
  41
  42 /** Holds a config value, either string, integer or boolean.
  43  * Callback functions receive one or more of these, either on
  44  * their own as a reference, or in a reference to a deque of them.
  45  * The callback function can then alter the values of the ValueItem
  46  * classes to validate the settings.
  47  */
  48 class ValueItem
  49 {
  50         std::string v;
  51  public:
  52         ValueItem(int value);
  53         ValueItem(bool value);
  54         ValueItem(char* value);
  55         void Set(char* value);
  56         void Set(const char* val);
  57         void Set(int value);
  58         int GetInteger();
  59         char* GetString();
  60         bool GetBool();
  61 };
  62
  63 /** The base class of the container 'ValueContainer'
  64  * used internally by the core to hold core values.
  65  */
  66 class ValueContainerBase
  67 {
  68  public:
  69         ValueContainerBase() { }
  70         virtual ~ValueContainerBase() { }
  71 };
  72
  73 /** ValueContainer is used to contain pointers to different
  74  * core values such as the server name, maximum number of
  75  * clients etc.
  76  * It is specialized to hold a data type, then pointed at
  77  * a value in the ServerConfig class. When the value has been
  78  * read and validated, the Set method is called to write the
  79  * value safely in a type-safe manner.
  80  */
  81 template<typename T> class ValueContainer : public ValueContainerBase
  82 {
  83         T val;
  84
  85  public:
  86
  87         ValueContainer()
  88         {
  89                 val = NULL;
  90         }
  91
  92         ValueContainer(T Val)
  93         {
  94                 val = Val;
  95         }
  96
  97         void Set(T newval, size_t s)
  98         {
  99                 memcpy(val, newval, s);
 100         }
 101 };
 102
 103 /** A specialization of ValueContainer to hold a pointer to a bool
 104  */
 105 typedef ValueContainer<bool*> ValueContainerBool;
 106
 107 /** A specialization of ValueContainer to hold a pointer to
 108  * an unsigned int
 109  */
 110 typedef ValueContainer<unsigned int*> ValueContainerUInt;
 111
 112 /** A specialization of ValueContainer to hold a pointer to
 113  * a char array.
 114  */
 115 typedef ValueContainer<char*> ValueContainerChar;
 116
 117 /** A specialization of ValueContainer to hold a pointer to
 118  * an int
 119  */
 120 typedef ValueContainer<int*> ValueContainerInt;
 121
 122 /** A set of ValueItems used by multi-value validator functions
 123  */
 124 typedef std::deque<ValueItem> ValueList;
 125
 126 /** A callback for validating a single value
 127  */
 128 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
 129 /** A callback for validating multiple value entries
 130  */
 131 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
 132 /** A callback indicating the end of a group of entries
 133  */
 134 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 135
 136 /** Holds a core configuration item and its callbacks
 137  */
 138 struct InitialConfig
 139 {
 140         char* tag;
 141         char* value;
 142         char* default_value;
 143         ValueContainerBase* val;
 144         ConfigDataType datatype;
 145         Validator validation_function;
 146 };
 147
 148 /** Holds a core configuration item and its callbacks
 149  * where there may be more than one item
 150  */
 151 struct MultiConfig
 152 {
 153         const char*     tag;
 154         char*           items[12];
 155         int             datatype[12];
 156         MultiNotify     init_function;
 157         MultiValidator  validation_function;
 158         MultiNotify     finish_function;
 159 };
 160
 161 /** A set of oper types
 162  */
 163 typedef std::map<irc::string,char*> opertype_t;
 164
 165 /** A Set of oper classes
 166  */
 167 typedef std::map<irc::string,char*> operclass_t;
 168
 169
 170 /** This class holds the bulk of the runtime configuration for the ircd.
 171  * It allows for reading new config values, accessing configuration files,
 172  * and storage of the configuration data needed to run the ircd, such as
 173  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 174  */
 175 class ServerConfig : public Extensible
 176 {
 177   private:
 178         /** Creator/owner
 179          */
 180         InspIRCd* ServerInstance;
 181
 182         /** This variable holds the names of all
 183          * files included from the main one. This
 184          * is used to make sure that no files are
 185          * recursively included.
 186          */
 187         std::vector<std::string> include_stack;
 188
 189         /** This private method processes one line of
 190          * configutation, appending errors to errorstream
 191          * and setting error if an error has occured.
 192          */
 193         bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
 194
 195         /** Process an include directive
 196          */
 197         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 198
 199         /** Check that there is only one of each configuration item
 200          */
 201         bool CheckOnce(char* tag, bool bail, userrec* user);
 202
 203   public:
 204
 205         InspIRCd* GetInstance();
 206
 207         /** This holds all the information in the config file,
 208          * it's indexed by tag name to a vector of key/values.
 209          */
 210         ConfigDataHash config_data;
 211
 212         /** Max number of WhoWas entries per user.
 213          */
 214         int WhoWasGroupSize;
 215
 216         /** Max number of cumulative user-entries in WhoWas.
 217          *  When max reached and added to, push out oldest entry FIFO style.
 218          */
 219         int WhoWasMaxGroups;
 220
 221         /** Max seconds a user is kept in WhoWas before being pruned.
 222          */
 223         int WhoWasMaxKeep;
 224
 225         /** Holds the server name of the local server
 226          * as defined by the administrator.
 227          */
 228         char ServerName[MAXBUF];
 229
 230         /* Holds the network name the local server
 231          * belongs to. This is an arbitary field defined
 232          * by the administrator.
 233          */
 234         char Network[MAXBUF];
 235
 236         /** Holds the description of the local server
 237          * as defined by the administrator.
 238          */
 239         char ServerDesc[MAXBUF];
 240
 241         /** Holds the admin's name, for output in
 242          * the /ADMIN command.
 243          */
 244         char AdminName[MAXBUF];
 245
 246         /** Holds the email address of the admin,
 247          * for output in the /ADMIN command.
 248          */
 249         char AdminEmail[MAXBUF];
 250
 251         /** Holds the admin's nickname, for output
 252          * in the /ADMIN command
 253          */
 254         char AdminNick[MAXBUF];
 255
 256         /** The admin-configured /DIE password
 257          */
 258         char diepass[MAXBUF];
 259
 260         /** The admin-configured /RESTART password
 261          */
 262         char restartpass[MAXBUF];
 263
 264         /** The pathname and filename of the message of the
 265          * day file, as defined by the administrator.
 266          */
 267         char motd[MAXBUF];
 268
 269         /** The pathname and filename of the rules file,
 270          * as defined by the administrator.
 271          */
 272         char rules[MAXBUF];
 273
 274         /** The quit prefix in use, or an empty string
 275          */
 276         char PrefixQuit[MAXBUF];
 277
 278         /** The last string found within a <die> tag, or
 279          * an empty string.
 280          */
 281         char DieValue[MAXBUF];
 282
 283         /** The DNS server to use for DNS queries
 284          */
 285         char DNSServer[MAXBUF];
 286
 287         /** This variable contains a space-seperated list
 288          * of commands which are disabled by the
 289          * administrator of the server for non-opers.
 290          */
 291         char DisabledCommands[MAXBUF];
 292
 293         /** The full path to the modules directory.
 294          * This is either set at compile time, or
 295          * overridden in the configuration file via
 296          * the <options> tag.
 297          */
 298         char ModPath[1024];
 299
 300         /** The full pathname to the executable, as
 301          * given in argv[0] when the program starts.
 302          */
 303         char MyExecutable[1024];
 304
 305         /** The file handle of the logfile. If this
 306          * value is NULL, the log file is not open,
 307          * probably due to a permissions error on
 308          * startup (this should not happen in normal
 309          * operation!).
 310          */
 311         FILE *log_file;
 312
 313         /** If this value is true, the owner of the
 314          * server specified -nofork on the command
 315          * line, causing the daemon to stay in the
 316          * foreground.
 317          */
 318         bool nofork;
 319
 320         /** If this value if true then all log
 321          * messages will be output, regardless of
 322          * the level given in the config file.
 323          * This is set with the -debug commandline
 324          * option.
 325          */
 326         bool forcedebug;
 327
 328         /** If this is true then log output will be
 329          * written to the logfile. This is the default.
 330          * If you put -nolog on the commandline then
 331          * the logfile will not be written.
 332          * This is meant to be used in conjunction with
 333          * -debug for debugging without filling up the
 334          * hard disk.
 335          */
 336         bool writelog;
 337
 338         /** If this value is true, halfops have been
 339          * enabled in the configuration file.
 340          */
 341         bool AllowHalfop;
 342
 343         /** The number of seconds the DNS subsystem
 344          * will wait before timing out any request.
 345          */
 346         int dns_timeout;
 347
 348         /** The size of the read() buffer in the user
 349          * handling code, used to read data into a user's
 350          * recvQ.
 351          */
 352         int NetBufferSize;
 353
 354         /** The value to be used for listen() backlogs
 355          * as default.
 356          */
 357         int MaxConn;
 358
 359         /** The soft limit value assigned to the irc server.
 360          * The IRC server will not allow more than this
 361          * number of local users.
 362          */
 363         unsigned int SoftLimit;
 364
 365         /** Maximum number of targets for a multi target command
 366          * such as PRIVMSG or KICK
 367          */
 368         unsigned int MaxTargets;
 369
 370         /** The maximum number of /WHO results allowed
 371          * in any single /WHO command.
 372          */
 373         int MaxWhoResults;
 374
 375         /** True if the DEBUG loglevel is selected.
 376          */
 377         int debugging;
 378
 379         /** The loglevel in use by the IRC server
 380          */
 381         int LogLevel;
 382
 383         /** How many seconds to wait before exiting
 384          * the program when /DIE is correctly issued.
 385          */
 386         int DieDelay;
 387
 388         /** True if we're going to hide netsplits as *.net *.split for non-opers
 389          */
 390         bool HideSplits;
 391
 392         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 393          * K-Lines, Z-Lines)
 394          */
 395         bool HideBans;
 396
 397         /** If this is enabled then operators will
 398          * see invisible (+i) channels in /whois.
 399          */
 400         bool OperSpyWhois;
 401
 402         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 403          */
 404         char HideWhoisServer[MAXBUF];
 405
 406         /** A list of IP addresses the server is listening
 407          * on.
 408          */
 409         char addrs[MAXBUF][255];
 410
 411         /** The MOTD file, cached in a file_cache type.
 412          */
 413         file_cache MOTD;
 414
 415         /** The RULES file, cached in a file_cache type.
 416          */
 417         file_cache RULES;
 418
 419         /** The full pathname and filename of the PID
 420          * file as defined in the configuration.
 421          */
 422         char PID[1024];
 423
 424         /** The connect classes in use by the IRC server.
 425          */
 426         ClassVector Classes;
 427
 428         /** A list of module names (names only, no paths)
 429          * which are currently loaded by the server.
 430          */
 431         std::vector<std::string> module_names;
 432
 433         /** A list of ports which the server is listening on
 434          */
 435         int ports[255];
 436
 437         /** A list of the file descriptors for the listening client ports
 438          */
 439         ListenSocket* openSockfd[255];
 440
 441         /** Boolean sets of which modules implement which functions
 442          */
 443         char implement_lists[255][255];
 444
 445         /** Global implementation list
 446          */
 447         char global_implementation[255];
 448
 449         /** A list of ports claimed by IO Modules
 450          */
 451         std::map<int,Module*> IOHookModule;
 452
 453         std::map<InspSocket*, Module*> SocketIOHookModule;
 454
 455         /** The 005 tokens of this server (ISUPPORT)
 456          * populated/repopulated upon loading or unloading
 457          * modules.
 458          */
 459         std::string data005;
 460         std::vector<std::string> isupport;
 461
 462         /** STATS characters in this list are available
 463          * only to operators.
 464          */
 465         char UserStats[MAXBUF];
 466
 467         /** The path and filename of the ircd.log file
 468          */
 469         std::string logpath;
 470
 471         /** Custom version string, which if defined can replace the system info in VERSION.
 472          */
 473         char CustomVersion[MAXBUF];
 474
 475         /** List of u-lined servers
 476          */
 477         std::vector<irc::string> ulines;
 478
 479         /** Max banlist sizes for channels (the std::string is a glob)
 480          */
 481         std::map<std::string,int> maxbans;
 482
 483         /** Directory where the inspircd binary resides
 484          */
 485         std::string MyDir;
 486
 487         /** If set to true, no user DNS lookups are to be performed
 488          */
 489         bool NoUserDns;
 490
 491         /** If set to true, provide syntax hints for unknown commands
 492          */
 493         bool SyntaxHints;
 494
 495         /** If set to true, users appear to quit then rejoin when their hosts change.
 496          * This keeps clients synchronized properly.
 497          */
 498         bool CycleHosts;
 499
 500         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 501          *  added to the outgoing text for undernet style msg prefixing.
 502          */
 503         bool UndernetMsgPrefix;
 504
 505         /** All oper type definitions from the config file
 506          */
 507         opertype_t opertypes;
 508
 509         /** All oper class definitions from the config file
 510          */
 511         operclass_t operclass;
 512
 513         /** Saved argv from startup
 514          */
 515         char** argv;
 516
 517         /** Saved argc from startup
 518          */
 519         int argc;
 520
 521         /** Construct a new ServerConfig
 522          */
 523         ServerConfig(InspIRCd* Instance);
 524
 525         /** Clears the include stack in preperation for a Read() call.
 526          */
 527         void ClearStack();
 528
 529         /** Update the 005 vector
 530          */
 531         void Update005();
 532
 533         /** Send the 005 numerics (ISUPPORT) to a user
 534          */
 535         void Send005(userrec* user);
 536
 537         /** Read the entire configuration into memory
 538          * and initialize this class. All other methods
 539          * should be used only by the core.
 540          */
 541         void Read(bool bail, userrec* user);
 542
 543         /** Read a file into a file_cache object
 544          */
 545         bool ReadFile(file_cache &F, const char* fname);
 546
 547         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 548          * tag/key/value at load-time rather than at read-value time.
 549          */
 550
 551         /** Report a configuration error given in errormessage.
 552          * @param bail If this is set to true, the error is sent to the console, and the program exits
 553          * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
 554          * this user as SNOTICEs.
 555          * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
 556          */
 557         void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
 558
 559         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 560          * tag/key/value at load-time rather than at read-value time.
 561          */
 562         bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
 563
 564         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 565          * tag/key/value at load-time rather than at read-value time.
 566          */
 567         bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
 568
 569         /* Both these return true if the value existed or false otherwise */
 570
 571         /** Writes 'length' chars into 'result' as a string
 572          */
 573         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
 574         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
 575
 576         /** Writes 'length' chars into 'result' as a string
 577          */
 578         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
 579         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false);
 580
 581         /** Tries to convert the value to an integer and write it to 'result'
 582          */
 583         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
 584         /** Tries to convert the value to an integer and write it to 'result'
 585          */
 586         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
 587
 588         /** Returns true if the value exists and has a true value, false otherwise
 589          */
 590         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
 591         /** Returns true if the value exists and has a true value, false otherwise
 592          */
 593         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
 594
 595         /** Returns the number of occurences of tag in the config file
 596          */
 597         int ConfValueEnum(ConfigDataHash &target, const char* tag);
 598         /** Returns the number of occurences of tag in the config file
 599          */
 600         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
 601
 602         /** Returns the numbers of vars inside the index'th 'tag in the config file
 603          */
 604         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
 605         /** Returns the numbers of vars inside the index'th 'tag in the config file
 606          */
 607         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 608
 609         Module* GetIOHook(int port);
 610         bool AddIOHook(int port, Module* iomod);
 611         bool DelIOHook(int port);
 612         Module* GetIOHook(InspSocket* is);
 613         bool AddIOHook(Module* iomod, InspSocket* is);
 614         bool DelIOHook(InspSocket* is);
 615
 616         static std::string GetFullProgDir(char** argv, int argc);
 617         static bool DirValid(const char* dirandfile);
 618         static char* CleanFilename(char* name);
 619         static bool FileExists(const char* file);
 620
 621 };
 622
 623 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 624
 625 bool InitTypes(ServerConfig* conf, const char* tag);
 626 bool InitClasses(ServerConfig* conf, const char* tag);
 627 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 628 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 629 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
 630
 631 #endif