include/configreader.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *                <omster@gmail.com>
  10  *
  11  * Written by Craig Edwards, Craig McLure, and others.
  12  * This program is free but copyrighted software; see
  13  *            the file COPYING for details.
  14  *
  15  * ---------------------------------------------------
  16  */
  17
  18 #ifndef INSPIRCD_CONFIGREADER
  19 #define INSPIRCD_CONFIGREADER
  20
  21 #include <sstream>
  22 #include <string>
  23 #include <vector>
  24 #include <map>
  25 #include "inspircd.h"
  26 #include "globals.h"
  27 #include "modules.h"
  28
  29 class ServerConfig;
  30 class InspIRCd;
  31
  32 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
  33 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, void**, int*);
  34 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
  35
  36 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
  37
  38 struct InitialConfig
  39 {
  40         char* tag;
  41         char* value;
  42         void* val;
  43         ConfigDataType datatype;
  44         Validator validation_function;
  45 };
  46
  47 struct MultiConfig
  48 {
  49         const char* tag;
  50         char* items[12];
  51         int datatype[12];
  52         MultiNotify     init_function;
  53         MultiValidator  validation_function;
  54         MultiNotify     finish_function;
  55 };
  56
  57 /** This class holds the bulk of the runtime configuration for the ircd.
  58  * It allows for reading new config values, accessing configuration files,
  59  * and storage of the configuration data needed to run the ircd, such as
  60  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
  61  */
  62 class ServerConfig : public Extensible
  63 {
  64   private:
  65         InspIRCd* ServerInstance;
  66
  67         /** This variable holds the names of all
  68          * files included from the main one. This
  69          * is used to make sure that no files are
  70          * recursively included.
  71          */
  72         std::vector<std::string> include_stack;
  73
  74         /** This private method processes one line of
  75          * configutation, appending errors to errorstream
  76          * and setting error if an error has occured.
  77          */
  78         bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
  79
  80         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
  81
  82         /** Check that there is only one of each configuration item
  83          */
  84         bool CheckOnce(char* tag, bool bail, userrec* user);
  85
  86   public:
  87
  88         /** This holds all the information in the config file,
  89          * it's indexed by tag name to a vector of key/values.
  90          */
  91         ConfigDataHash config_data;
  92
  93         /** Holds the server name of the local server
  94          * as defined by the administrator.
  95          */
  96         char ServerName[MAXBUF];
  97
  98         /* Holds the network name the local server
  99          * belongs to. This is an arbitary field defined
 100          * by the administrator.
 101          */
 102         char Network[MAXBUF];
 103
 104         /** Holds the description of the local server
 105          * as defined by the administrator.
 106          */
 107         char ServerDesc[MAXBUF];
 108
 109         /** Holds the admin's name, for output in
 110          * the /ADMIN command.
 111          */
 112         char AdminName[MAXBUF];
 113
 114         /** Holds the email address of the admin,
 115          * for output in the /ADMIN command.
 116          */
 117         char AdminEmail[MAXBUF];
 118
 119         /** Holds the admin's nickname, for output
 120          * in the /ADMIN command
 121          */
 122         char AdminNick[MAXBUF];
 123
 124         /** The admin-configured /DIE password
 125          */
 126         char diepass[MAXBUF];
 127
 128         /** The admin-configured /RESTART password
 129          */
 130         char restartpass[MAXBUF];
 131
 132         /** The pathname and filename of the message of the
 133          * day file, as defined by the administrator.
 134          */
 135         char motd[MAXBUF];
 136
 137         /** The pathname and filename of the rules file,
 138          * as defined by the administrator.
 139          */
 140         char rules[MAXBUF];
 141
 142         /** The quit prefix in use, or an empty string
 143          */
 144         char PrefixQuit[MAXBUF];
 145
 146         /** The last string found within a <die> tag, or
 147          * an empty string.
 148          */
 149         char DieValue[MAXBUF];
 150
 151         /** The DNS server to use for DNS queries
 152          */
 153         char DNSServer[MAXBUF];
 154
 155         /** This variable contains a space-seperated list
 156          * of commands which are disabled by the
 157          * administrator of the server for non-opers.
 158          */
 159         char DisabledCommands[MAXBUF];
 160
 161         /** The full path to the modules directory.
 162          * This is either set at compile time, or
 163          * overridden in the configuration file via
 164          * the <options> tag.
 165          */
 166         char ModPath[1024];
 167
 168         /** The temporary directory where modules are copied
 169          */
 170         char TempDir[1024];
 171
 172         /** The full pathname to the executable, as
 173          * given in argv[0] when the program starts.
 174          */
 175         char MyExecutable[1024];
 176
 177         /** The file handle of the logfile. If this
 178          * value is NULL, the log file is not open,
 179          * probably due to a permissions error on
 180          * startup (this should not happen in normal
 181          * operation!).
 182          */
 183         FILE *log_file;
 184
 185         /** If this value is true, the owner of the
 186          * server specified -nofork on the command
 187          * line, causing the daemon to stay in the
 188          * foreground.
 189          */
 190         bool nofork;
 191
 192         /** If this value if true then all log
 193          * messages will be output, regardless of
 194          * the level given in the config file.
 195          * This is set with the -debug commandline
 196          * option.
 197          */
 198         bool forcedebug;
 199
 200         /** If this is true then log output will be
 201          * written to the logfile. This is the default.
 202          * If you put -nolog on the commandline then
 203          * the logfile will not be written.
 204          * This is meant to be used in conjunction with
 205          * -debug for debugging without filling up the
 206          * hard disk.
 207          */
 208         bool writelog;
 209
 210         /** If this value is true, halfops have been
 211          * enabled in the configuration file.
 212          */
 213         bool AllowHalfop;
 214
 215         /** The number of seconds the DNS subsystem
 216          * will wait before timing out any request.
 217          */
 218         int dns_timeout;
 219
 220         /** The size of the read() buffer in the user
 221          * handling code, used to read data into a user's
 222          * recvQ.
 223          */
 224         int NetBufferSize;
 225
 226         /** The value to be used for listen() backlogs
 227          * as default.
 228          */
 229         int MaxConn;
 230
 231         /** The soft limit value assigned to the irc server.
 232          * The IRC server will not allow more than this
 233          * number of local users.
 234          */
 235         unsigned int SoftLimit;
 236
 237         /** Maximum number of targets for a multi target command
 238          * such as PRIVMSG or KICK
 239          */
 240         unsigned int MaxTargets;
 241
 242         /** The maximum number of /WHO results allowed
 243          * in any single /WHO command.
 244          */
 245         int MaxWhoResults;
 246
 247         /** True if the DEBUG loglevel is selected.
 248          */
 249         int debugging;
 250
 251         /** The loglevel in use by the IRC server
 252          */
 253         int LogLevel;
 254
 255         /** How many seconds to wait before exiting
 256          * the program when /DIE is correctly issued.
 257          */
 258         int DieDelay;
 259
 260         /** True if we're going to hide netsplits as *.net *.split for non-opers
 261          */
 262         bool HideSplits;
 263
 264         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 265          * K-Lines, Z-Lines)
 266          */
 267         bool HideBans;
 268
 269         /** If this is enabled then operators will
 270          * see invisible (+i) channels in /whois.
 271          */
 272         bool OperSpyWhois;
 273
 274         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 275          */
 276         char HideWhoisServer[MAXBUF];
 277
 278         /** A list of IP addresses the server is listening
 279          * on.
 280          */
 281         char addrs[MAXBUF][255];
 282
 283         /** The MOTD file, cached in a file_cache type.
 284          */
 285         file_cache MOTD;
 286
 287         /** The RULES file, cached in a file_cache type.
 288          */
 289         file_cache RULES;
 290
 291         /** The full pathname and filename of the PID
 292          * file as defined in the configuration.
 293          */
 294         char PID[1024];
 295
 296         /** The connect classes in use by the IRC server.
 297          */
 298         ClassVector Classes;
 299
 300         /** A list of module names (names only, no paths)
 301          * which are currently loaded by the server.
 302          */
 303         std::vector<std::string> module_names;
 304
 305         /** A list of ports which the server is listening on
 306          */
 307         int ports[255];
 308
 309         /** A list of the file descriptors for the listening client ports
 310          */
 311         int openSockfd[MAX_DESCRIPTORS];
 312
 313         /** Boolean sets of which modules implement which functions
 314          */
 315         char implement_lists[255][255];
 316
 317         /** Global implementation list
 318          */
 319         char global_implementation[255];
 320
 321         /** A list of ports claimed by IO Modules
 322          */
 323         std::map<int,Module*> IOHookModule;
 324
 325         /** The 005 tokens of this server (ISUPPORT)
 326          * populated/repopulated upon loading or unloading
 327          * modules.
 328          */
 329         std::string data005;
 330
 331         /** STATS characters in this list are available
 332          * only to operators.
 333          */
 334         char OperOnlyStats[MAXBUF];
 335
 336         /** The path and filename of the ircd.log file
 337          */
 338         std::string logpath;
 339
 340         /** Custom version string, which if defined can replace the system info in VERSION.
 341          */
 342         char CustomVersion[MAXBUF];
 343
 344         /** List of u-lined servers
 345          */
 346         std::vector<irc::string> ulines;
 347
 348         /** Max banlist sizes for channels (the std::string is a glob)
 349          */
 350         std::map<std::string,int> maxbans;
 351
 352         /** If set to true, no user DNS lookups are to be performed
 353          */
 354         bool NoUserDns;
 355
 356         /** If set to true, provide syntax hints for unknown commands
 357          */
 358         bool SyntaxHints;
 359
 360         ServerConfig(InspIRCd* Instance);
 361
 362         /** Clears the include stack in preperation for
 363          * a Read() call.
 364          */
 365         void ClearStack();
 366
 367         /** Read the entire configuration into memory
 368          * and initialize this class. All other methods
 369          * should be used only by the core.
 370          */
 371         void Read(bool bail, userrec* user);
 372
 373         /** Read a file into a file_cache object
 374          */
 375         bool ReadFile(file_cache &F, const char* fname);
 376
 377         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 378          * tag/key/value at load-time rather than at read-value time.
 379          */
 380         bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
 381         bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
 382
 383         /* Both these return true if the value existed or false otherwise */
 384
 385         /* Writes 'length' chars into 'result' as a string */
 386         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
 387         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
 388
 389         /* Tries to convert the value to an integer and write it to 'result' */
 390         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
 391         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
 392
 393         /* Returns true if the value exists and has a true value, false otherwise */
 394         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
 395         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
 396
 397         /* Returns the number of occurences of tag in the config file */
 398         int ConfValueEnum(ConfigDataHash &target, const char* tag);
 399         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
 400
 401         /* Returns the numbers of vars inside the index'th 'tag in the config file */
 402         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
 403         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 404
 405         Module* GetIOHook(int port);
 406         bool AddIOHook(int port, Module* iomod);
 407         bool DelIOHook(int port);
 408 };
 409
 410 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 411
 412 #endif