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