include/configreader.h

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