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