include/configreader.h

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