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, int pass);
 236
 237         /** Process an include directive
 238          */
 239         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream, int pass);
 240
 241         /** Check that there is only one of each configuration item
 242          */
 243         bool CheckOnce(char* tag);
 244
 245         std::map<std::string, std::stringstream*> IncludedFiles;
 246
 247   public:
 248
 249         /** Used to indicate who we announce invites to on a channel */
 250         enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
 251
 252         /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
 253         Validator DNSServerValidator;
 254
 255         InspIRCd* GetInstance();
 256
 257         bool Downloading();
 258
 259         void StartDownloads();
 260
 261         /** This holds all the information in the config file,
 262          * it's indexed by tag name to a vector of key/values.
 263          */
 264         ConfigDataHash config_data;
 265
 266         /** Max number of WhoWas entries per user.
 267          */
 268         int WhoWasGroupSize;
 269
 270         /** Max number of cumulative user-entries in WhoWas.
 271          *  When max reached and added to, push out oldest entry FIFO style.
 272          */
 273         int WhoWasMaxGroups;
 274
 275         /** Max seconds a user is kept in WhoWas before being pruned.
 276          */
 277         int WhoWasMaxKeep;
 278
 279         /** Holds the server name of the local server
 280          * as defined by the administrator.
 281          */
 282         char ServerName[MAXBUF];
 283
 284         /** Notice to give to users when they are Xlined
 285          */
 286         char MoronBanner[MAXBUF];
 287
 288         /* Holds the network name the local server
 289          * belongs to. This is an arbitary field defined
 290          * by the administrator.
 291          */
 292         char Network[MAXBUF];
 293
 294         /** Holds the description of the local server
 295          * as defined by the administrator.
 296          */
 297         char ServerDesc[MAXBUF];
 298
 299         /** Holds the admin's name, for output in
 300          * the /ADMIN command.
 301          */
 302         char AdminName[MAXBUF];
 303
 304         /** Holds the email address of the admin,
 305          * for output in the /ADMIN command.
 306          */
 307         char AdminEmail[MAXBUF];
 308
 309         /** Holds the admin's nickname, for output
 310          * in the /ADMIN command
 311          */
 312         char AdminNick[MAXBUF];
 313
 314         /** The admin-configured /DIE password
 315          */
 316         char diepass[MAXBUF];
 317
 318         /** The admin-configured /RESTART password
 319          */
 320         char restartpass[MAXBUF];
 321
 322         /** The pathname and filename of the message of the
 323          * day file, as defined by the administrator.
 324          */
 325         char motd[MAXBUF];
 326
 327         /** The pathname and filename of the rules file,
 328          * as defined by the administrator.
 329          */
 330         char rules[MAXBUF];
 331
 332         /** The quit prefix in use, or an empty string
 333          */
 334         char PrefixQuit[MAXBUF];
 335
 336         /** The quit suffix in use, or an empty string
 337          */
 338         char SuffixQuit[MAXBUF];
 339
 340         /** The fixed quit message in use, or an empty string
 341          */
 342         char FixedQuit[MAXBUF];
 343
 344         /** The last string found within a <die> tag, or
 345          * an empty string.
 346          */
 347         char DieValue[MAXBUF];
 348
 349         /** The DNS server to use for DNS queries
 350          */
 351         char DNSServer[MAXBUF];
 352
 353         /** This variable contains a space-seperated list
 354          * of commands which are disabled by the
 355          * administrator of the server for non-opers.
 356          */
 357         char DisabledCommands[MAXBUF];
 358
 359         /** The full path to the modules directory.
 360          * This is either set at compile time, or
 361          * overridden in the configuration file via
 362          * the <options> tag.
 363          */
 364         char ModPath[1024];
 365
 366         /** The full pathname to the executable, as
 367          * given in argv[0] when the program starts.
 368          */
 369         char MyExecutable[1024];
 370
 371         /** The file handle of the logfile. If this
 372          * value is NULL, the log file is not open,
 373          * probably due to a permissions error on
 374          * startup (this should not happen in normal
 375          * operation!).
 376          */
 377         FILE *log_file;
 378
 379         /** If this value is true, the owner of the
 380          * server specified -nofork on the command
 381          * line, causing the daemon to stay in the
 382          * foreground.
 383          */
 384         bool nofork;
 385
 386         /** If this value if true then all log
 387          * messages will be output, regardless of
 388          * the level given in the config file.
 389          * This is set with the -debug commandline
 390          * option.
 391          */
 392         bool forcedebug;
 393
 394         /** If this is true then log output will be
 395          * written to the logfile. This is the default.
 396          * If you put -nolog on the commandline then
 397          * the logfile will not be written.
 398          * This is meant to be used in conjunction with
 399          * -debug for debugging without filling up the
 400          * hard disk.
 401          */
 402         bool writelog;
 403
 404         /** If this value is true, halfops have been
 405          * enabled in the configuration file.
 406          */
 407         bool AllowHalfop;
 408
 409         /** If this is set to true, then mode lists (e.g
 410          * MODE #chan b) are hidden from unprivileged
 411          * users.
 412          */
 413         bool HideModeLists[256];
 414
 415         /** If this is set to true, then channel operators
 416          * are exempt from this channel mode. Used for +Sc etc.
 417          */
 418         bool ExemptChanOps[256];
 419
 420         /** The number of seconds the DNS subsystem
 421          * will wait before timing out any request.
 422          */
 423         int dns_timeout;
 424
 425         /** The size of the read() buffer in the user
 426          * handling code, used to read data into a user's
 427          * recvQ.
 428          */
 429         int NetBufferSize;
 430
 431         /** The value to be used for listen() backlogs
 432          * as default.
 433          */
 434         int MaxConn;
 435
 436         /** The soft limit value assigned to the irc server.
 437          * The IRC server will not allow more than this
 438          * number of local users.
 439          */
 440         unsigned int SoftLimit;
 441
 442         /** Maximum number of targets for a multi target command
 443          * such as PRIVMSG or KICK
 444          */
 445         unsigned int MaxTargets;
 446
 447         /** The maximum number of /WHO results allowed
 448          * in any single /WHO command.
 449          */
 450         int MaxWhoResults;
 451
 452         /** True if the DEBUG loglevel is selected.
 453          */
 454         int debugging;
 455
 456         /** The loglevel in use by the IRC server
 457          */
 458         int LogLevel;
 459
 460         /** How many seconds to wait before exiting
 461          * the program when /DIE is correctly issued.
 462          */
 463         int DieDelay;
 464
 465         /** True if we're going to hide netsplits as *.net *.split for non-opers
 466          */
 467         bool HideSplits;
 468
 469         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
 470          * K-Lines, Z-Lines)
 471          */
 472         bool HideBans;
 473
 474         /** Announce invites to the channel with a server notice
 475          */
 476         InviteAnnounceState AnnounceInvites;
 477
 478         /** If this is enabled then operators will
 479          * see invisible (+i) channels in /whois.
 480          */
 481         bool OperSpyWhois;
 482
 483         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
 484          */
 485         char HideWhoisServer[MAXBUF];
 486
 487         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
 488          */
 489         char HideKillsServer[MAXBUF];
 490
 491         /** The MOTD file, cached in a file_cache type.
 492          */
 493         file_cache MOTD;
 494
 495         /** The RULES file, cached in a file_cache type.
 496          */
 497         file_cache RULES;
 498
 499         /** The full pathname and filename of the PID
 500          * file as defined in the configuration.
 501          */
 502         char PID[1024];
 503
 504         /** The connect classes in use by the IRC server.
 505          */
 506         ClassVector Classes;
 507
 508         /** A list of the classes for listening client ports
 509          */
 510         std::vector<ListenSocket*> ports;
 511
 512         /** A list of ports claimed by IO Modules
 513          */
 514         std::map<int,Module*> IOHookModule;
 515
 516         std::map<BufferedSocket*, Module*> SocketIOHookModule;
 517
 518         /** The 005 tokens of this server (ISUPPORT)
 519          * populated/repopulated upon loading or unloading
 520          * modules.
 521          */
 522         std::string data005;
 523
 524         /** isupport strings
 525          */
 526         std::vector<std::string> isupport;
 527
 528         /** STATS characters in this list are available
 529          * only to operators.
 530          */
 531         char UserStats[MAXBUF];
 532
 533         /** The path and filename of the ircd.log file
 534          */
 535         std::string logpath;
 536
 537         /** Default channel modes
 538          */
 539         char DefaultModes[MAXBUF];
 540
 541         /** Custom version string, which if defined can replace the system info in VERSION.
 542          */
 543         char CustomVersion[MAXBUF];
 544
 545         /** List of u-lined servers
 546          */
 547         std::map<irc::string, bool> ulines;
 548
 549         /** Max banlist sizes for channels (the std::string is a glob)
 550          */
 551         std::map<std::string, int> maxbans;
 552
 553         /** Directory where the inspircd binary resides
 554          */
 555         std::string MyDir;
 556
 557         /** If set to true, no user DNS lookups are to be performed
 558          */
 559         bool NoUserDns;
 560
 561         /** If set to true, provide syntax hints for unknown commands
 562          */
 563         bool SyntaxHints;
 564
 565         /** If set to true, users appear to quit then rejoin when their hosts change.
 566          * This keeps clients synchronized properly.
 567          */
 568         bool CycleHosts;
 569
 570         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
 571          *  added to the outgoing text for undernet style msg prefixing.
 572          */
 573         bool UndernetMsgPrefix;
 574
 575         /** If set to true, the full nick!user@host will be shown in the TOPIC command
 576          * for who set the topic last. If false, only the nick is shown.
 577          */
 578         bool FullHostInTopic;
 579
 580         /** All oper type definitions from the config file
 581          */
 582         opertype_t opertypes;
 583
 584         /** All oper class definitions from the config file
 585          */
 586         operclass_t operclass;
 587
 588         /** Saved argv from startup
 589          */
 590         char** argv;
 591
 592         /** Saved argc from startup
 593          */
 594         int argc;
 595
 596         /** Max channels per user
 597          */
 598         unsigned int MaxChans;
 599
 600         /** Oper max channels per user
 601          */
 602         unsigned int OperMaxChans;
 603
 604         /** TS6-like server ID.
 605          * NOTE: 000...999 are usable for InspIRCd servers. This
 606          * makes code simpler. 0AA, 1BB etc with letters are reserved
 607          * for services use.
 608          */
 609         int sid;
 610
 611         /** Construct a new ServerConfig
 612          */
 613         ServerConfig(InspIRCd* Instance);
 614
 615         /** Clears the include stack in preperation for a Read() call.
 616          */
 617         void ClearStack();
 618
 619         /** Get server ID as string with required leading zeroes
 620          */
 621         std::string GetSID();
 622
 623         /** Update the 005 vector
 624          */
 625         void Update005();
 626
 627         /** Send the 005 numerics (ISUPPORT) to a user
 628          */
 629         void Send005(User* user);
 630
 631         /** Read the entire configuration into memory
 632          * and initialize this class. All other methods
 633          * should be used only by the core.
 634          */
 635         void Read(bool bail, User* user, int pass);
 636
 637         /** Read a file into a file_cache object
 638          */
 639         bool ReadFile(file_cache &F, const char* fname);
 640
 641         /** Report a configuration error given in errormessage.
 642          * @param bail If this is set to true, the error is sent to the console, and the program exits
 643          * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
 644          * this user as SNOTICEs.
 645          * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
 646          */
 647         void ReportConfigError(const std::string &errormessage, bool bail, User* user);
 648
 649         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 650          * tag/key/value at load-time rather than at read-value time.
 651          */
 652         bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream, int pass);
 653
 654         /** Load 'filename' into 'target', with the new config parser everything is parsed into
 655          * tag/key/value at load-time rather than at read-value time.
 656          */
 657         bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream, int pass);
 658
 659         /* Both these return true if the value existed or false otherwise */
 660
 661         /** Writes 'length' chars into 'result' as a string
 662          */
 663         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
 664         /** Writes 'length' chars into 'result' as a string
 665          */
 666         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
 667
 668         /** Writes 'length' chars into 'result' as a string
 669          */
 670         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
 671         /** Writes 'length' chars into 'result' as a string
 672          */
 673         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);
 674
 675         /** Tries to convert the value to an integer and write it to 'result'
 676          */
 677         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
 678         /** Tries to convert the value to an integer and write it to 'result'
 679          */
 680         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
 681         /** Tries to convert the value to an integer and write it to 'result'
 682          */
 683         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
 684         /** Tries to convert the value to an integer and write it to 'result'
 685          */
 686         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
 687
 688         /** Returns true if the value exists and has a true value, false otherwise
 689          */
 690         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
 691         /** Returns true if the value exists and has a true value, false otherwise
 692          */
 693         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
 694         /** Returns true if the value exists and has a true value, false otherwise
 695          */
 696         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
 697         /** Returns true if the value exists and has a true value, false otherwise
 698          */
 699         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
 700
 701         /** Returns the number of occurences of tag in the config file
 702          */
 703         int ConfValueEnum(ConfigDataHash &target, const char* tag);
 704         /** Returns the number of occurences of tag in the config file
 705          */
 706         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
 707
 708         /** Returns the numbers of vars inside the index'th 'tag in the config file
 709          */
 710         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
 711         /** Returns the numbers of vars inside the index'th 'tag in the config file
 712          */
 713         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 714
 715         void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
 716
 717         void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
 718
 719         void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
 720
 721         /** Get a pointer to the module which has hooked the given port.
 722          * @parameter port Port number
 723          * @return Returns a pointer to the hooking module, or NULL
 724          */
 725         Module* GetIOHook(int port);
 726
 727         /** Hook a module to a client port, so that it can receive notifications
 728          * of low-level port activity.
 729          * @param port The port number
 730          * @param Module the module to hook to the port
 731          * @return True if the hook was successful.
 732          */
 733         bool AddIOHook(int port, Module* iomod);
 734
 735         /** Delete a module hook from a client port.
 736          * @param port The port to detatch from
 737          * @return True if successful
 738          */
 739         bool DelIOHook(int port);
 740
 741         /** Get a pointer to the module which has hooked the given BufferedSocket class.
 742          * @parameter port Port number
 743          * @return Returns a pointer to the hooking module, or NULL
 744          */
 745         Module* GetIOHook(BufferedSocket* is);
 746
 747         /** Hook a module to an BufferedSocket class, so that it can receive notifications
 748          * of low-level socket activity.
 749          * @param iomod The module to hook to the socket
 750          * @param is The BufferedSocket to attach to
 751          * @return True if the hook was successful.
 752          */
 753         bool AddIOHook(Module* iomod, BufferedSocket* is);
 754
 755         /** Delete a module hook from an BufferedSocket.
 756          * @param is The BufferedSocket to detatch from.
 757          * @return True if the unhook was successful
 758          */
 759         bool DelIOHook(BufferedSocket* is);
 760
 761         /** Returns the fully qualified path to the inspircd directory
 762          * @return The full program directory
 763          */
 764         std::string GetFullProgDir();
 765
 766         /** Returns true if a directory is valid (within the modules directory).
 767          * @param dirandfile The directory and filename to check
 768          * @return True if the directory is valid
 769          */
 770         static bool DirValid(const char* dirandfile);
 771
 772         /** Clean a filename, stripping the directories (and drives) from string.
 773          * @param name Directory to tidy
 774          * @return The cleaned filename
 775          */
 776         static char* CleanFilename(char* name);
 777
 778         /** Check if a file exists.
 779          * @param file The full path to a file
 780          * @return True if the file exists and is readable.
 781          */
 782         static bool FileExists(const char* file);
 783
 784 };
 785
 786 /** Initialize the disabled commands list
 787  */
 788 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 789
 790 /** Initialize the oper types
 791  */
 792 bool InitTypes(ServerConfig* conf, const char* tag);
 793
 794 /** Initialize the oper classes
 795  */
 796 bool InitClasses(ServerConfig* conf, const char* tag);
 797
 798 /** Initialize an oper type
 799  */
 800 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 801
 802 /** Initialize an oper class
 803  */
 804 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 805
 806 /** Finish initializing the oper types and classes
 807  */
 808 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
 809
 810
 811
 812 /** Initialize x line
 813  */
 814 bool InitXLine(ServerConfig* conf, const char* tag);
 815
 816 /** Add a config-defined zline
 817  */
 818 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 819
 820 /** Add a config-defined qline
 821  */
 822 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 823
 824 /** Add a config-defined kline
 825  */
 826 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 827
 828 /** Add a config-defined eline
 829  */
 830 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
 831
 832
 833
 834
 835 #endif
 836