include/configreader.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 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 /* handy defines */
  18
  19 /** Determines if a channel op is exempt from given mode m,
  20  * in config of server instance s.
  21  */
  22 #define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
  23
  24 #include <sstream>
  25 #include <string>
  26 #include <vector>
  27 #include <map>
  28 #include "inspircd.h"
  29 #include "modules.h"
  30 #include "socketengine.h"
  31 #include "socket.h"
  32
  33 /* Required forward definitions */
  34 class ServerConfig;
  35 class InspIRCd;
  36 class BufferedSocket;
  37
  38 /** Types of data in the core config
  39  */
  40 enum ConfigDataType
  41 {
  42         DT_NOTHING       = 0,           /* No data */
  43         DT_INTEGER       = 1,           /* Integer */
  44         DT_CHARPTR       = 2,           /* Char pointer */
  45         DT_BOOLEAN       = 3,           /* Boolean */
  46         DT_HOSTNAME      = 4,           /* Hostname syntax */
  47         DT_NOSPACES      = 5,           /* No spaces */
  48         DT_IPADDRESS     = 6,           /* IP address (v4, v6) */
  49         DT_CHANNEL       = 7,           /* Channel name */
  50         DT_ALLOW_WILD    = 64,          /* Allow wildcards/CIDR in DT_IPADDRESS */
  51         DT_ALLOW_NEWLINE = 128,         /* New line characters allowed in DT_CHARPTR */
  52         DT_BOOTONLY      = 256          /* Can only be set on startup, not on rehash */
  53 };
  54
  55 /** The maximum number of values in a core configuration tag. Can be increased if needed.
  56  */
  57 #define MAX_VALUES_PER_TAG 18
  58
  59 /** Holds a config value, either string, integer or boolean.
  60  * Callback functions receive one or more of these, either on
  61  * their own as a reference, or in a reference to a deque of them.
  62  * The callback function can then alter the values of the ValueItem
  63  * classes to validate the settings.
  64  */
  65 class ValueItem
  66 {
  67         /** Actual data */
  68         std::string v;
  69  public:
  70         /** Initialize with an int */
  71         ValueItem(int value);
  72         /** Initialize with a bool */
  73         ValueItem(bool value);
  74         /** Initialize with a char pointer */
  75         ValueItem(const char* value);
  76         /** Change value to a char pointer */
  77         void Set(const char* val);
  78         /** Change value to an int */
  79         void Set(int value);
  80         /** Get value as an int */
  81         int GetInteger();
  82         /** Get value as a string */
  83         char* GetString();
  84         /** Get value as a bool */
  85         bool GetBool();
  86 };
  87
  88 /** The base class of the container 'ValueContainer'
  89  * used internally by the core to hold core values.
  90  */
  91 class ValueContainerBase
  92 {
  93  public:
  94         /** Constructor */
  95         ValueContainerBase() { }
  96         /** Destructor */
  97         virtual ~ValueContainerBase() { }
  98 };
  99
 100 /** ValueContainer is used to contain pointers to different
 101  * core values such as the server name, maximum number of
 102  * clients etc.
 103  * It is specialized to hold a data type, then pointed at
 104  * a value in the ServerConfig class. When the value has been
 105  * read and validated, the Set method is called to write the
 106  * value safely in a type-safe manner.
 107  */
 108 template<typename T> class ValueContainer : public ValueContainerBase
 109 {
 110         /** Contained item */
 111         T val;
 112  public:
 113
 114         /** Initialize with nothing */
 115         ValueContainer()
 116         {
 117                 val = NULL;
 118         }
 119
 120         /** Initialize with a value of type T */
 121         ValueContainer(T Val)
 122         {
 123                 val = Val;
 124         }
 125
 126         /** Change value to type T of size s */
 127         void Set(T newval, size_t s)
 128         {
 129                 memcpy(val, newval, s);
 130         }
 131 };
 132
 133 /** A specialization of ValueContainer to hold a pointer to a bool
 134  */
 135 typedef ValueContainer<bool*> ValueContainerBool;
 136
 137 /** A specialization of ValueContainer to hold a pointer to
 138  * an unsigned int
 139  */
 140 typedef ValueContainer<unsigned int*> ValueContainerUInt;
 141
 142 /** A specialization of ValueContainer to hold a pointer to
 143  * a char array.
 144  */
 145 typedef ValueContainer<char*> ValueContainerChar;
 146
 147 /** A specialization of ValueContainer to hold a pointer to
 148  * an int
 149  */
 150 typedef ValueContainer<int*> ValueContainerInt;
 151
 152 /** A specialization of ValueContainer to hold a pointer to
 153  * a size_t.
 154  */
 155 typedef ValueContainer<size_t*> ValueContainerST;
 156
 157 /** A set of ValueItems used by multi-value validator functions
 158  */
 159 typedef std::deque<ValueItem> ValueList;
 160
 161 /** A callback for validating a single value
 162  */
 163 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
 164 /** A callback for validating multiple value entries
 165  */
 166 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
 167 /** A callback indicating the end of a group of entries
 168  */
 169 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 170
 171 /** Holds a core configuration item and its callbacks
 172  */
 173 struct InitialConfig
 174 {
 175         /** Tag name */
 176         const char* tag;
 177         /** Value name */
 178         const char* value;
 179         /** Default, if not defined */
 180         const char* default_value;
 181         /** Value containers */
 182         ValueContainerBase* val;
 183         /** Data types */
 184         int datatype;
 185         /** Validation function */
 186         Validator validation_function;
 187 };
 188
 189 /** Represents a deprecated configuration tag.
 190  */
 191 struct Deprecated
 192 {
 193         /** Tag name
 194          */
 195         const char* tag;
 196         /** Tag value
 197          */
 198         const char* value;
 199         /** Reason for deprecation
 200          */
 201         const char* reason;
 202 };
 203
 204 /** Holds a core configuration item and its callbacks
 205  * where there may be more than one item
 206  */
 207 struct MultiConfig
 208 {
 209         /** Tag name */
 210         const char*     tag;
 211         /** One or more items within tag */
 212         const char*     items[MAX_VALUES_PER_TAG];
 213         /** One or more defaults for items within tags */
 214         const char* items_default[MAX_VALUES_PER_TAG];
 215         /** One or more data types */
 216         int             datatype[MAX_VALUES_PER_TAG];
 217         /** Initialization function */
 218         MultiNotify     init_function;
 219         /** Validation function */
 220         MultiValidator  validation_function;
 221         /** Completion function */
 222         MultiNotify     finish_function;
 223 };
 224
 225 /** A set of oper types
 226  */
 227 typedef std::map<irc::string,char*> opertype_t;
 228
 229 /** Holds an oper class.
 230  */
 231 struct operclass_data : public Extensible
 232 {
 233         /** Command list for the class
 234          */
 235         char* commandlist;
 236         /** Channel mode list for the class
 237          */
 238         char* cmodelist;
 239         /** User mode list for the class
 240          */
 241         char* umodelist;
 242 };
 243
 244 /** A Set of oper classes
 245  */
 246 typedef std::map<irc::string, operclass_data> operclass_t;
 247
 248 /** Defines the server's length limits on various length-limited
 249  * items such as topics, nicknames, channel names etc.
 250  */
 251 class ServerLimits : public Extensible
 252 {
 253  public:
 254         /** Maximum nickname length */
 255         size_t NickMax;
 256         /** Maximum channel length */
 257         size_t ChanMax;
 258         /** Maximum number of modes per line */
 259         size_t MaxModes;
 260         /** Maximum length of ident, not including ~ etc */
 261         size_t IdentMax;
 262         /** Maximum length of a quit message */
 263         size_t MaxQuit;
 264         /** Maximum topic length */
 265         size_t MaxTopic;
 266         /** Maximum kick message length */
 267         size_t MaxKick;
 268         /** Maximum GECOS (real name) length */
 269         size_t MaxGecos;
 270         /** Maximum away message length */
 271         size_t MaxAway;
 272
 273         /** Creating the class initialises it to the defaults
 274          * as in 1.1's ./configure script. Reading other values
 275          * from the config will change these values.
 276          */
 277         ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
 278         {
 279         }
 280
 281         /** Finalises the settings by adding one. This allows for them to be used as-is
 282          * without a 'value+1' when using the std::string assignment methods etc.
 283          */
 284         void Finalise()
 285         {
 286                 NickMax++;
 287                 ChanMax++;
 288                 IdentMax++;
 289                 MaxQuit++;
 290                 MaxTopic++;
 291                 MaxKick++;
 292                 MaxGecos++;
 293                 MaxAway++;
 294         }
 295 };
 296
 297 /** This class holds the bulk of the runtime configuration for the ircd.
 298  * It allows for reading new config values, accessing configuration files,
 299  * and storage of the configuration data needed to run the ircd, such as
 300  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
 301  */
 302 class CoreExport ServerConfig : public Extensible
 303 {
 304   private:
 305         /** Creator/owner pointer
 306          */
 307         InspIRCd* ServerInstance;
 308
 309         /** This variable holds the names of all
 310          * files included from the main one. This
 311          * is used to make sure that no files are
 312          * recursively included.
 313          */
 314         std::vector<std::string> include_stack;
 315
 316         /** This private method processes one line of
 317          * configutation, appending errors to errorstream
 318          * and setting error if an error has occured.
 319          */
 320         bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
 321
 322         /** Check that there is only one of each configuration item
 323          */
 324         bool CheckOnce(const char* tag, ConfigDataHash &newconf);
 325
 326  public:
 327         /** Process an include executable directive
 328          */
 329         bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 330
 331         /** Process an include file directive
 332          */
 333         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 334
 335         /** User that is currently performing a rehash, needed because the
 336          * rehash code is now threaded and needs to know who to give errors and feedback to.
 337          */
 338         User* RehashUser;
 339
 340         /** Rehash parameter, as above
 341          */
 342         std::string RehashParameter;
 343
 344         /** Error stream, contains error output from any failed configuration parsing.
 345          */
 346         std::ostringstream errstr;
 347
 348         /** Holds the new configuration when a rehash occurs so we dont overwrite the existing
 349          * working config with a broken one without checking it first and swapping pointers.
 350          */
 351         ConfigDataHash newconfig;
 352
 353         /** Set of included files. Do we use this any more?
 354          */
 355         std::map<std::string, std::istream*> IncludedFiles;
 356
 357         /** Used to indicate who we announce invites to on a channel */
 358         enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
 359
 360         /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
 361         Validator DNSServerValidator;
 362
 363         /** Returns the creator InspIRCd pointer
 364          */
 365         InspIRCd* GetInstance();
 366
 367         /** Not used any more as it is named, can probably be removed or renamed.
 368          */
 369         int DoDownloads();
 370
 371         /** This holds all the information in the config file,
 372          * it's indexed by tag name to a vector of key/values.
 373          */
 374         ConfigDataHash config_data;
 375
 376         /** Length limits, see definition of ServerLimits class
 377          */
 378         ServerLimits Limits;
 379
 380         /** Clones CIDR range for ipv4 (0-32)
 381          * Defaults to 32 (checks clones on all IPs seperately)
 382          */
 383         int c_ipv4_range;
 384
 385         /** Clones CIDR range for ipv6 (0-128)
 386          * Defaults to 128 (checks on all IPs seperately)
 387          */
 388         int c_ipv6_range;
 389
 390         /** Max number of WhoWas entries per user.
 391          */
 392         int WhoWasGroupSize;
 393
 394         /** Max number of cumulative user-entries in WhoWas.
 395          *  When max reached and added to, push out oldest entry FIFO style.
 396          */
 397         int WhoWasMaxGroups;
 398
 399         /** Max seconds a user is kept in WhoWas before being pruned.
 400          */
 401         int WhoWasMaxKeep;
 402
 403         /** Holds the server name of the local server
 404          * as defined by the administrator.
 405          */
 406         char ServerName[MAXBUF];
 407
 408         /** Notice to give to users when they are Xlined
 409          */
 410         char MoronBanner[MAXBUF];
 411
 412         /* Holds the network name the local server
 413          * belongs to. This is an arbitary field defined
 414          * by the administrator.
 415          */
 416         char Network[MAXBUF];
 417
 418         /** Holds the description of the local server
 419          * as defined by the administrator.
 420          */
 421         char ServerDesc[MAXBUF];
 422
 423         /** Holds the admin's name, for output in
 424          * the /ADMIN command.
 425          */
 426         char AdminName[MAXBUF];
 427
 428         /** Holds the email address of the admin,
 429          * for output in the /ADMIN command.
 430          */
 431         char AdminEmail[MAXBUF];
 432
 433         /** Holds the admin's nickname, for output
 434          * in the /ADMIN command
 435          */
 436         char AdminNick[MAXBUF];
 437
 438         /** The admin-configured /DIE password
 439          */
 440         char diepass[MAXBUF];
 441
 442         /** The admin-configured /RESTART password
 443          */
 444         char restartpass[MAXBUF];
 445
 446         /** The hash method for *BOTH* the die and restart passwords.
 447          */
 448         char powerhash[MAXBUF];
 449
 450         /** The pathname and filename of the message of the
 451          * day file, as defined by the administrator.
 452          */
 453         char motd[MAXBUF];
 454
 455         /** The pathname and filename of the rules file,
 456          * as defined by the administrator.
 457          */
 458         char rules[MAXBUF];
 459
 460         /** The quit prefix in use, or an empty string
 461          */
 462         char PrefixQuit[MAXBUF];
 463
 464         /** The quit suffix in use, or an empty string
 465          */
 466         char SuffixQuit[MAXBUF];
 467
 468         /** The fixed quit message in use, or an empty string
 469          */
 470         char FixedQuit[MAXBUF];
 471
 472         /** The part prefix in use, or an empty string
 473          */
 474         char PrefixPart[MAXBUF];
 475
 476         /** The part suffix in use, or an empty string
 477          */
 478         char SuffixPart[MAXBUF];
 479
 480         /** The fixed part message in use, or an empty string
 481          */
 482         char FixedPart[MAXBUF];
 483
 484         /** The last string found within a <die> tag, or
 485          * an empty string.
 486          */
 487         char DieValue[MAXBUF];
 488
 489         /** The DNS server to use for DNS queries
 490          */
 491         char DNSServer[MAXBUF];
 492
 493         /** Pretend disabled commands don't exist.
 494          */
 495         bool DisabledDontExist;
 496
 497         /** This variable contains a space-seperated list
 498          * of commands which are disabled by the
 499          * administrator of the server for non-opers.
 500          */
 501         char DisabledCommands[MAXBUF];
 502
 503         /** This variable identifies which usermodes have been diabled.
 504          */
 505
 506         char DisabledUModes[64];
 507
 508         /** This variable identifies which chanmodes have been disabled.
 509          */
 510         char DisabledCModes[64];
 511
 512         /** The full path to the modules directory.
 513          * This is either set at compile time, or
 514          * overridden in the configuration file via
 515          * the <options> tag.
 516          */
 517         char ModPath[1024];
 518
 519         /** The full pathname to the executable, as
 520          * given in argv[0] when the program starts.
 521          */
 522         char MyExecutable[1024];
 523
 524         /** The file handle of the logfile. If this
 525          * value is NULL, the log file is not open,
 526          * probably due to a permissions error on
 527          * startup (this should not happen in normal
 528          * operation!).
 529          */
 530         FILE *log_file;
 531
 532         /** If this value is true, the owner of the
 533          * server specified -nofork on the command
 534          * line, causing the daemon to stay in the
 535          * foreground.
 536          */
 537         bool nofork;
 538
 539         /** If this value if true then all log
 540          * messages will be output, regardless of
 541          * the level given in the config file.
 542          * This is set with the -debug commandline
 543          * option.
 544          */
 545         bool forcedebug;
 546
 547         /** If this is true then log output will be
 548          * written to the logfile. This is the default.
 549          * If you put -nolog on the commandline then
 550          * the logfile will not be written.
 551          * This is meant to be used in conjunction with
 552          * -debug for debugging without filling up the
 553          * hard disk.
 554          */
 555         bool writelog;
 556
 557         /** If this value is true, halfops have been
 558          * enabled in the configuration file.
 559          */
 560         bool AllowHalfop;
 561
 562         /** If this is set to true, then mode lists (e.g
 563          * MODE #chan b) are hidden from unprivileged
 564          * users.
 565          */
 566         bool HideModeLists[256];
 567
 568         /** If this is set to true, then channel operators
 569          * are exempt from this channel mode. Used for +Sc etc.
 570          */
 571         bool ExemptChanOps[256];
 572
 573         /** The number of seconds the DNS subsystem
 574          * will wait before timing out any request.
 575          */
 576         int dns_timeout;
 577
 578         /** The size of the read() buffer in the user
 579          * handling code, used to read data into a user's
 580          * recvQ.
 581          */
 582         int NetBufferSize;
 583
 584         /** The value to be used for listen() backlogs
 585          * as default.
 586          */
 587         int MaxConn;
 588
 589         /** The soft limit value assigned to the irc server.
 590          * The IRC server will not allow more than this
 591          * number of local users.
 592          */
 593         unsigned int SoftLimit;
 594
 595         /** Maximum number of targets for a multi target command
 596          * such as PRIVMSG or KICK
 597          */
 598         unsigned int MaxTargets;
 599
 600         /** The maximum number of /WHO results allowed
 601          * in any single /WHO command.
 602          */
 603         int MaxWhoResults;
 604
 605         /** True if the DEBUG loglevel is selected.
 606          */
 607         int debugging;
 608
 609         /** How many seconds to wait before exiting
 610          * the program when /DIE is correctly issued.
 611          */
 612         int DieDelay;
 613
 614         /** True if we're going to hide netsplits as *.net *.split for non-opers
 615          */
 616         bool HideSplits;
 617
 618         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 619          * K-Lines, Z-Lines)
 620          */
 621         bool HideBans;
 622
 623         /** Announce invites to the channel with a server notice
 624          */
 625         InviteAnnounceState AnnounceInvites;
 626
 627         /** If this is enabled then operators will
 628          * see invisible (+i) channels in /whois.
 629          */
 630         bool OperSpyWhois;
 631
 632         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 633          */
 634         char HideWhoisServer[MAXBUF];
 635
 636         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 637          */
 638         char HideKillsServer[MAXBUF];
 639
 640         /** The MOTD file, cached in a file_cache type.
 641          */
 642         file_cache MOTD;
 643
 644         /** The RULES file, cached in a file_cache type.
 645          */
 646         file_cache RULES;
 647
 648         /** The full pathname and filename of the PID
 649          * file as defined in the configuration.
 650          */
 651         char PID[1024];
 652
 653         /** The connect classes in use by the IRC server.
 654          */
 655         ClassVector Classes;
 656
 657         /** A list of the classes for listening ports
 658          */
 659         std::vector<ListenSocketBase *> ports;
 660
 661         /** The 005 tokens of this server (ISUPPORT)
 662          * populated/repopulated upon loading or unloading
 663          * modules.
 664          */
 665         std::string data005;
 666
 667         /** isupport strings
 668          */
 669         std::vector<std::string> isupport;
 670
 671         /** STATS characters in this list are available
 672          * only to operators.
 673          */
 674         char UserStats[MAXBUF];
 675
 676         /** The path and filename of the ircd.log file
 677          */
 678         std::string logpath;
 679
 680         /** Default channel modes
 681          */
 682         char DefaultModes[MAXBUF];
 683
 684         /** Custom version string, which if defined can replace the system info in VERSION.
 685          */
 686         char CustomVersion[MAXBUF];
 687
 688         /** List of u-lined servers
 689          */
 690         std::map<irc::string, bool> ulines;
 691
 692         /** Max banlist sizes for channels (the std::string is a glob)
 693          */
 694         std::map<std::string, int> maxbans;
 695
 696         /** Directory where the inspircd binary resides
 697          */
 698         std::string MyDir;
 699
 700         /** If set to true, no user DNS lookups are to be performed
 701          */
 702         bool NoUserDns;
 703
 704         /** If set to true, provide syntax hints for unknown commands
 705          */
 706         bool SyntaxHints;
 707
 708         /** If set to true, users appear to quit then rejoin when their hosts change.
 709          * This keeps clients synchronized properly.
 710          */
 711         bool CycleHosts;
 712
 713         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 714          *  added to the outgoing text for undernet style msg prefixing.
 715          */
 716         bool UndernetMsgPrefix;
 717
 718         /** If set to true, the full nick!user@host will be shown in the TOPIC command
 719          * for who set the topic last. If false, only the nick is shown.
 720          */
 721         bool FullHostInTopic;
 722
 723         /** All oper type definitions from the config file
 724          */
 725         opertype_t opertypes;
 726
 727         /** All oper class definitions from the config file
 728          */
 729         operclass_t operclass;
 730
 731         /** Saved argv from startup
 732          */
 733         char** argv;
 734
 735         /** Saved argc from startup
 736          */
 737         int argc;
 738
 739         /** Max channels per user
 740          */
 741         unsigned int MaxChans;
 742
 743         /** Oper max channels per user
 744          */
 745         unsigned int OperMaxChans;
 746
 747         /** TS6-like server ID.
 748          * NOTE: 000...999 are usable for InspIRCd servers. This
 749          * makes code simpler. 0AA, 1BB etc with letters are reserved
 750          * for services use.
 751          */
 752         char sid[MAXBUF];
 753
 754         /** True if we have been told to run the testsuite from the commandline,
 755          * rather than entering the mainloop.
 756          */
 757         bool TestSuite;
 758
 759         /** Construct a new ServerConfig
 760          */
 761         ServerConfig(InspIRCd* Instance);
 762
 763         /** Clears the include stack in preperation for a Read() call.
 764          */
 765         void ClearStack();
 766
 767         /** Get server ID as string with required leading zeroes
 768          */
 769         std::string GetSID();
 770
 771         /** Update the 005 vector
 772          */
 773         void Update005();
 774
 775         /** Send the 005 numerics (ISUPPORT) to a user
 776          */
 777         void Send005(User* user);
 778
 779         /** Read the entire configuration into memory
 780          * and initialize this class. All other methods
 781          * should be used only by the core.
 782          */
 783         void Read(bool bail, User* user);
 784
 785         /** Read a file into a file_cache object
 786          */
 787         bool ReadFile(file_cache &F, const char* fname);
 788
 789         /* Returns true if the given string starts with a windows drive letter
 790          */
 791         bool StartsWithWindowsDriveLetter(const std::string &path);
 792
 793         /** Report a configuration error given in errormessage.
 794          * @param bail If this is set to true, the error is sent to the console, and the program exits
 795          * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
 796          * this user as SNOTICEs.
 797          * If the parameter is NULL, the messages are spooled to all opers.
 798          */
 799         void ReportConfigError(const std::string &errormessage, bool bail, User* user);
 800
 801         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 802          * tag/key/value at load-time rather than at read-value time.
 803          */
 804         bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
 805
 806         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 807          * tag/key/value at load-time rather than at read-value time.
 808          */
 809         bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
 810
 811         /** Writes 'length' chars into 'result' as a string
 812          */
 813         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
 814
 815         /** Writes 'length' chars into 'result' as a string
 816          */
 817         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
 818
 819         /** Writes 'length' chars into 'result' as a string
 820          */
 821         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
 822
 823         /** Writes 'length' chars into 'result' as a string
 824          */
 825         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);
 826
 827         /** Tries to convert the value to an integer and write it to 'result'
 828          */
 829         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
 830
 831         /** Tries to convert the value to an integer and write it to 'result'
 832          */
 833         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
 834
 835         /** Tries to convert the value to an integer and write it to 'result'
 836          */
 837         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
 838
 839         /** Tries to convert the value to an integer and write it to 'result'
 840          */
 841         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
 842
 843         /** Returns true if the value exists and has a true value, false otherwise
 844          */
 845         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
 846
 847         /** Returns true if the value exists and has a true value, false otherwise
 848          */
 849         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
 850
 851         /** Returns true if the value exists and has a true value, false otherwise
 852          */
 853         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
 854
 855         /** Returns true if the value exists and has a true value, false otherwise
 856          */
 857         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
 858
 859         /** Returns the number of occurences of tag in the config file
 860          */
 861         int ConfValueEnum(ConfigDataHash &target, const char* tag);
 862         /** Returns the number of occurences of tag in the config file
 863          */
 864         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
 865
 866         /** Returns the numbers of vars inside the index'th 'tag in the config file
 867          */
 868         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
 869         /** Returns the numbers of vars inside the index'th 'tag in the config file
 870          */
 871         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 872
 873         /** Validates a hostname value, throwing ConfigException if it is not valid
 874          */
 875         void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
 876
 877         /** Validates an IP address value, throwing ConfigException if it is not valid
 878          */
 879         void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
 880
 881         /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
 882          */
 883         void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
 884
 885         /** Returns the fully qualified path to the inspircd directory
 886          * @return The full program directory
 887          */
 888         std::string GetFullProgDir();
 889
 890         /** Returns true if a directory is valid (within the modules directory).
 891          * @param dirandfile The directory and filename to check
 892          * @return True if the directory is valid
 893          */
 894         static bool DirValid(const char* dirandfile);
 895
 896         /** Clean a filename, stripping the directories (and drives) from string.
 897          * @param name Directory to tidy
 898          * @return The cleaned filename
 899          */
 900         static char* CleanFilename(char* name);
 901
 902         /** Check if a file exists.
 903          * @param file The full path to a file
 904          * @return True if the file exists and is readable.
 905          */
 906         static bool FileExists(const char* file);
 907
 908         /** If this value is true, invites will bypass more than just +i
 909          */
 910         bool InvBypassModes;
 911
 912 };
 913
 914 /** Initialize the disabled commands list
 915  */
 916 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 917
 918 /** Initialize the oper types
 919  */
 920 bool InitTypes(ServerConfig* conf, const char* tag);
 921
 922 /** Initialize the oper classes
 923  */
 924 bool InitClasses(ServerConfig* conf, const char* tag);
 925
 926 /** Initialize an oper type
 927  */
 928 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 929
 930 /** Initialize an oper class
 931  */
 932 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 933
 934 /** Finish initializing the oper types and classes
 935  */
 936 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
 937
 938
 939
 940 /** Initialize x line
 941  */
 942 bool InitXLine(ServerConfig* conf, const char* tag);
 943
 944 /** Add a config-defined zline
 945  */
 946 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 947
 948 /** Add a config-defined qline
 949  */
 950 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 951
 952 /** Add a config-defined kline
 953  */
 954 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 955
 956 /** Add a config-defined eline
 957  */
 958 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 959
 960
 961
 962
 963 #endif
 964