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