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 #include "socketengine.h"
  29 #include "socket.h"
  30
  31 class ServerConfig;
  32 class InspIRCd;
  33
  34 /** A callback for validating a single value
  35  */
  36 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
  37 /** A callback for validating multiple value entries
  38  */
  39 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, void**, int*);
  40 /** A callback indicating the end of a group of entries
  41  */
  42 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
  43
  44 /** Types of data in the core config
  45  */
  46 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
  47
  48 /** Holds a core configuration item and its callbacks
  49  */
  50 struct InitialConfig
  51 {
  52         char* tag;
  53         char* value;
  54         void* val;
  55         ConfigDataType datatype;
  56         Validator validation_function;
  57 };
  58
  59 /** Holds a core configuration item and its callbacks
  60  * where there may be more than one item
  61  */
  62 struct MultiConfig
  63 {
  64         const char* tag;
  65         char* items[12];
  66         int datatype[12];
  67         MultiNotify     init_function;
  68         MultiValidator  validation_function;
  69         MultiNotify     finish_function;
  70 };
  71
  72 /** A set of oper types
  73  */
  74 typedef std::map<irc::string,char*> opertype_t;
  75
  76 /** A Set of oper classes
  77  */
  78 typedef std::map<irc::string,char*> operclass_t;
  79
  80
  81 /** This class holds the bulk of the runtime configuration for the ircd.
  82  * It allows for reading new config values, accessing configuration files,
  83  * and storage of the configuration data needed to run the ircd, such as
  84  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
  85  */
  86 class ServerConfig : public Extensible
  87 {
  88   private:
  89         /** Creator/owner
  90          */
  91         InspIRCd* ServerInstance;
  92
  93         /** This variable holds the names of all
  94          * files included from the main one. This
  95          * is used to make sure that no files are
  96          * recursively included.
  97          */
  98         std::vector<std::string> include_stack;
  99
 100         /** This private method processes one line of
 101          * configutation, appending errors to errorstream
 102          * and setting error if an error has occured.
 103          */
 104         bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
 105
 106         /** Process an include directive
 107          */
 108         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 109
 110         /** Check that there is only one of each configuration item
 111          */
 112         bool CheckOnce(char* tag, bool bail, userrec* user);
 113
 114   public:
 115
 116         InspIRCd* GetInstance();
 117
 118         /** This holds all the information in the config file,
 119          * it's indexed by tag name to a vector of key/values.
 120          */
 121         ConfigDataHash config_data;
 122
 123         /** Max number of WhoWas entries per user.
 124          */
 125         int WhoWasGroupSize;
 126
 127         /** Max number of cumulative user-entries in WhoWas.
 128          *  When max reached and added to, push out oldest entry FIFO style.
 129          */
 130         int WhoWasMaxGroups;
 131
 132         /** Max seconds a user is kept in WhoWas before being pruned.
 133          */
 134         int WhoWasMaxKeep;
 135
 136         /** Holds the server name of the local server
 137          * as defined by the administrator.
 138          */
 139         char ServerName[MAXBUF];
 140
 141         /* Holds the network name the local server
 142          * belongs to. This is an arbitary field defined
 143          * by the administrator.
 144          */
 145         char Network[MAXBUF];
 146
 147         /** Holds the description of the local server
 148          * as defined by the administrator.
 149          */
 150         char ServerDesc[MAXBUF];
 151
 152         /** Holds the admin's name, for output in
 153          * the /ADMIN command.
 154          */
 155         char AdminName[MAXBUF];
 156
 157         /** Holds the email address of the admin,
 158          * for output in the /ADMIN command.
 159          */
 160         char AdminEmail[MAXBUF];
 161
 162         /** Holds the admin's nickname, for output
 163          * in the /ADMIN command
 164          */
 165         char AdminNick[MAXBUF];
 166
 167         /** The admin-configured /DIE password
 168          */
 169         char diepass[MAXBUF];
 170
 171         /** The admin-configured /RESTART password
 172          */
 173         char restartpass[MAXBUF];
 174
 175         /** The pathname and filename of the message of the
 176          * day file, as defined by the administrator.
 177          */
 178         char motd[MAXBUF];
 179
 180         /** The pathname and filename of the rules file,
 181          * as defined by the administrator.
 182          */
 183         char rules[MAXBUF];
 184
 185         /** The quit prefix in use, or an empty string
 186          */
 187         char PrefixQuit[MAXBUF];
 188
 189         /** The last string found within a <die> tag, or
 190          * an empty string.
 191          */
 192         char DieValue[MAXBUF];
 193
 194         /** The DNS server to use for DNS queries
 195          */
 196         char DNSServer[MAXBUF];
 197
 198         /** This variable contains a space-seperated list
 199          * of commands which are disabled by the
 200          * administrator of the server for non-opers.
 201          */
 202         char DisabledCommands[MAXBUF];
 203
 204         /** The full path to the modules directory.
 205          * This is either set at compile time, or
 206          * overridden in the configuration file via
 207          * the <options> tag.
 208          */
 209         char ModPath[1024];
 210
 211         /** The temporary directory where modules are copied
 212          */
 213         char TempDir[1024];
 214
 215         /** The full pathname to the executable, as
 216          * given in argv[0] when the program starts.
 217          */
 218         char MyExecutable[1024];
 219
 220         /** The file handle of the logfile. If this
 221          * value is NULL, the log file is not open,
 222          * probably due to a permissions error on
 223          * startup (this should not happen in normal
 224          * operation!).
 225          */
 226         FILE *log_file;
 227
 228         /** If this value is true, the owner of the
 229          * server specified -nofork on the command
 230          * line, causing the daemon to stay in the
 231          * foreground.
 232          */
 233         bool nofork;
 234
 235         /** If this value if true then all log
 236          * messages will be output, regardless of
 237          * the level given in the config file.
 238          * This is set with the -debug commandline
 239          * option.
 240          */
 241         bool forcedebug;
 242
 243         /** If this is true then log output will be
 244          * written to the logfile. This is the default.
 245          * If you put -nolog on the commandline then
 246          * the logfile will not be written.
 247          * This is meant to be used in conjunction with
 248          * -debug for debugging without filling up the
 249          * hard disk.
 250          */
 251         bool writelog;
 252
 253         /** If this value is true, halfops have been
 254          * enabled in the configuration file.
 255          */
 256         bool AllowHalfop;
 257
 258         /** The number of seconds the DNS subsystem
 259          * will wait before timing out any request.
 260          */
 261         int dns_timeout;
 262
 263         /** The size of the read() buffer in the user
 264          * handling code, used to read data into a user's
 265          * recvQ.
 266          */
 267         int NetBufferSize;
 268
 269         /** The value to be used for listen() backlogs
 270          * as default.
 271          */
 272         int MaxConn;
 273
 274         /** The soft limit value assigned to the irc server.
 275          * The IRC server will not allow more than this
 276          * number of local users.
 277          */
 278         unsigned int SoftLimit;
 279
 280         /** Maximum number of targets for a multi target command
 281          * such as PRIVMSG or KICK
 282          */
 283         unsigned int MaxTargets;
 284
 285         /** The maximum number of /WHO results allowed
 286          * in any single /WHO command.
 287          */
 288         int MaxWhoResults;
 289
 290         /** True if the DEBUG loglevel is selected.
 291          */
 292         int debugging;
 293
 294         /** The loglevel in use by the IRC server
 295          */
 296         int LogLevel;
 297
 298         /** How many seconds to wait before exiting
 299          * the program when /DIE is correctly issued.
 300          */
 301         int DieDelay;
 302
 303         /** True if we're going to hide netsplits as *.net *.split for non-opers
 304          */
 305         bool HideSplits;
 306
 307         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 308          * K-Lines, Z-Lines)
 309          */
 310         bool HideBans;
 311
 312         /** If this is enabled then operators will
 313          * see invisible (+i) channels in /whois.
 314          */
 315         bool OperSpyWhois;
 316
 317         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 318          */
 319         char HideWhoisServer[MAXBUF];
 320
 321         /** A list of IP addresses the server is listening
 322          * on.
 323          */
 324         char addrs[MAXBUF][255];
 325
 326         /** The MOTD file, cached in a file_cache type.
 327          */
 328         file_cache MOTD;
 329
 330         /** The RULES file, cached in a file_cache type.
 331          */
 332         file_cache RULES;
 333
 334         /** The full pathname and filename of the PID
 335          * file as defined in the configuration.
 336          */
 337         char PID[1024];
 338
 339         /** The connect classes in use by the IRC server.
 340          */
 341         ClassVector Classes;
 342
 343         /** A list of module names (names only, no paths)
 344          * which are currently loaded by the server.
 345          */
 346         std::vector<std::string> module_names;
 347
 348         /** A list of ports which the server is listening on
 349          */
 350         int ports[255];
 351
 352         /** A list of the file descriptors for the listening client ports
 353          */
 354         ListenSocket* openSockfd[255];
 355
 356         /** Boolean sets of which modules implement which functions
 357          */
 358         char implement_lists[255][255];
 359
 360         /** Global implementation list
 361          */
 362         char global_implementation[255];
 363
 364         /** A list of ports claimed by IO Modules
 365          */
 366         std::map<int,Module*> IOHookModule;
 367
 368         /** The 005 tokens of this server (ISUPPORT)
 369          * populated/repopulated upon loading or unloading
 370          * modules.
 371          */
 372         std::string data005;
 373
 374         /** STATS characters in this list are available
 375          * only to operators.
 376          */
 377         char UserStats[MAXBUF];
 378
 379         /** The path and filename of the ircd.log file
 380          */
 381         std::string logpath;
 382
 383         /** Custom version string, which if defined can replace the system info in VERSION.
 384          */
 385         char CustomVersion[MAXBUF];
 386
 387         /** List of u-lined servers
 388          */
 389         std::vector<irc::string> ulines;
 390
 391         /** Max banlist sizes for channels (the std::string is a glob)
 392          */
 393         std::map<std::string,int> maxbans;
 394
 395         /** If set to true, no user DNS lookups are to be performed
 396          */
 397         bool NoUserDns;
 398
 399         /** If set to true, provide syntax hints for unknown commands
 400          */
 401         bool SyntaxHints;
 402
 403         /** If set to true, users appear to quit then rejoin when their hosts change.
 404          * This keeps clients synchronized properly.
 405          */
 406         bool CycleHosts;
 407
 408
 409 #if __GNUC__ == 3 && __GNUC_MINOR__ == 3
 410         /** if we're being compiled with GCC 3.3 add
 411          *  dummy opertype on heap to fix GCC 3.3 crash
 412          */
 413         opertype_t dummyopertype;
 414 #endif
 415
 416         /** All oper type definitions from the config file
 417          */
 418         opertype_t opertypes;
 419
 420         /** All oper class definitions from the config file
 421          */
 422         operclass_t operclass;
 423
 424         /** Construct a new ServerConfig
 425          */
 426         ServerConfig(InspIRCd* Instance);
 427
 428         /** Clears the include stack in preperation for a Read() call.
 429          */
 430         void ClearStack();
 431
 432         /** Read the entire configuration into memory
 433          * and initialize this class. All other methods
 434          * should be used only by the core.
 435          */
 436         void Read(bool bail, userrec* user);
 437
 438         /** Read a file into a file_cache object
 439          */
 440         bool ReadFile(file_cache &F, const char* fname);
 441
 442         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 443          * tag/key/value at load-time rather than at read-value time.
 444          */
 445         bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
 446         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 447          * tag/key/value at load-time rather than at read-value time.
 448          */
 449         bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
 450
 451         /* Both these return true if the value existed or false otherwise */
 452
 453         /** Writes 'length' chars into 'result' as a string
 454          */
 455         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
 456         /** Writes 'length' chars into 'result' as a string
 457          */
 458         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
 459
 460         /** Tries to convert the value to an integer and write it to 'result'
 461          */
 462         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
 463         /** Tries to convert the value to an integer and write it to 'result'
 464          */
 465         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
 466
 467         /** Returns true if the value exists and has a true value, false otherwise
 468          */
 469         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
 470         /** Returns true if the value exists and has a true value, false otherwise
 471          */
 472         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
 473
 474         /** Returns the number of occurences of tag in the config file
 475          */
 476         int ConfValueEnum(ConfigDataHash &target, const char* tag);
 477         /** Returns the number of occurences of tag in the config file
 478          */
 479         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
 480
 481         /** Returns the numbers of vars inside the index'th 'tag in the config file
 482          */
 483         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
 484         /** Returns the numbers of vars inside the index'th 'tag in the config file
 485          */
 486         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 487
 488         Module* GetIOHook(int port);
 489         bool AddIOHook(int port, Module* iomod);
 490         bool DelIOHook(int port);
 491
 492         static std::string GetFullProgDir(char** argv, int argc);
 493         static bool DirValid(const char* dirandfile);
 494         static char* CleanFilename(char* name);
 495         static bool FileExists(const char* file);
 496
 497 };
 498
 499 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 500
 501 #endif