]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Add call to protocol interface to get useful info on the server map. Return a std...
[user/henk/code/inspircd.git] / include / configreader.h
index 8a719f77e98344fd451fbe55506abb0d1ab3b8d1..aea3555833169e2e5014983a2d13779884c8ac63 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -34,7 +34,7 @@
 /* Required forward definitions */
 class ServerConfig;
 class InspIRCd;
-class InspSocket;
+class BufferedSocket;
 
 /** Types of data in the core config
  */
@@ -44,7 +44,13 @@ enum ConfigDataType
        DT_INTEGER       = 1,           /* Integer */
        DT_CHARPTR       = 2,           /* Char pointer */
        DT_BOOLEAN       = 3,           /* Boolean */
-       DT_ALLOW_NEWLINE = 128          /* New line characters allowed */
+       DT_HOSTNAME      = 4,           /* Hostname syntax */
+       DT_NOSPACES      = 5,           /* No spaces */
+       DT_IPADDRESS     = 6,           /* IP address (v4, v6) */
+       DT_CHANNEL       = 7,           /* Channel name */
+       DT_ALLOW_WILD    = 64,          /* Allow wildcards/CIDR in DT_IPADDRESS */
+       DT_ALLOW_NEWLINE = 128,         /* New line characters allowed in DT_CHARPTR */
+       DT_BOOTONLY      = 256          /* Can only be set on startup, not on rehash */
 };
 
 /** Holds a config value, either string, integer or boolean.
@@ -63,10 +69,8 @@ class ValueItem
        /** Initialize with a bool */
        ValueItem(bool value);
        /** Initialize with a char pointer */
-       ValueItem(char* value);
+       ValueItem(const char* value);
        /** Change value to a char pointer */
-       void Set(char* value);
-       /** Change value to a const char pointer */
        void Set(const char* val);
        /** Change value to an int */
        void Set(int value);
@@ -161,19 +165,26 @@ typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 struct InitialConfig
 {
        /** Tag name */
-       char* tag;
+       const char* tag;
        /** Value name */
-       char* value;
+       const char* value;
        /** Default, if not defined */
-       char* default_value;
+       const char* default_value;
        /** Value containers */
        ValueContainerBase* val;
        /** Data types */
-       ConfigDataType datatype;
+       int datatype;
        /** Validation function */
        Validator validation_function;
 };
 
+struct Deprecated
+{
+       const char* tag;
+       const char* value;
+       const char* reason;
+};
+
 /** Holds a core configuration item and its callbacks
  * where there may be more than one item
  */
@@ -182,11 +193,11 @@ struct MultiConfig
        /** Tag name */
        const char*     tag;
        /** One or more items within tag */
-       char*           items[13];
+       const char*     items[18];
        /** One or more defaults for items within tags */
-       char*           items_default[13];
+       const char* items_default[18];
        /** One or more data types */
-       int             datatype[13];
+       int             datatype[18];
        /** Initialization function */
        MultiNotify     init_function;
        /** Validation function */
@@ -199,9 +210,16 @@ struct MultiConfig
  */
 typedef std::map<irc::string,char*> opertype_t;
 
+struct operclass_data : public Extensible
+{
+       char* commandlist;
+       char* cmodelist;
+       char* umodelist;
+};
+
 /** A Set of oper classes
  */
-typedef std::map<irc::string,char*> operclass_t;
+typedef std::map<irc::string, operclass_data> operclass_t;
 
 
 /** This class holds the bulk of the runtime configuration for the ircd.
@@ -227,19 +245,46 @@ class CoreExport ServerConfig : public Extensible
         * configutation, appending errors to errorstream
         * and setting error if an error has occured.
         */
-       bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
-  
-       /** Process an include directive
-        */
-       bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+       bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream);
 
        /** Check that there is only one of each configuration item
         */
-       bool CheckOnce(char* tag, bool bail, userrec* user);
-  
-  public:
+       bool CheckOnce(const char* tag, ConfigDataHash &newconf);
+
+ public:
+
+       /** Process an include executable directive
+        */
+       bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+
+       /** Process an include file directive
+        */
+       bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+
+       User* RehashUser;
+
+       std::string RehashParameter;
+
+       std::ostringstream errstr;
+
+       ConfigDataHash newconfig;
+
+       std::map<std::string, std::istream*> IncludedFiles;
+
+       std::map<std::string, bool> CompletedFiles;
+
+       size_t TotalDownloaded;
+       size_t FileErrors;
+
+       /** Used to indicate who we announce invites to on a channel */
+       enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
+
+       /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
+       Validator DNSServerValidator;
 
        InspIRCd* GetInstance();
+
+       int DoDownloads();
          
        /** This holds all the information in the config file,
         * it's indexed by tag name to a vector of key/values.
@@ -302,6 +347,10 @@ class CoreExport ServerConfig : public Extensible
         */
        char restartpass[MAXBUF];
 
+       /** The hash method for *BOTH* the die and restart passwords.
+        */
+       char powerhash[MAXBUF];
+
        /** The pathname and filename of the message of the
         * day file, as defined by the administrator.
         */
@@ -324,6 +373,18 @@ class CoreExport ServerConfig : public Extensible
         */
        char FixedQuit[MAXBUF];
 
+       /** The part prefix in use, or an empty string
+        */
+       char PrefixPart[MAXBUF];
+
+       /** The part suffix in use, or an empty string
+        */
+       char SuffixPart[MAXBUF];
+
+       /** The fixed part message in use, or an empty string
+        */
+       char FixedPart[MAXBUF];
+
        /** The last string found within a <die> tag, or
         * an empty string.
         */
@@ -436,10 +497,6 @@ class CoreExport ServerConfig : public Extensible
         */
        int debugging;
 
-       /** The loglevel in use by the IRC server
-        */
-       int LogLevel;
-
        /** How many seconds to wait before exiting
         * the program when /DIE is correctly issued.
         */
@@ -456,7 +513,7 @@ class CoreExport ServerConfig : public Extensible
 
        /** Announce invites to the channel with a server notice
         */
-       bool AnnounceInvites;
+       InviteAnnounceState AnnounceInvites;
 
        /** If this is enabled then operators will
         * see invisible (+i) channels in /whois.
@@ -488,28 +545,13 @@ class CoreExport ServerConfig : public Extensible
         */
        ClassVector Classes;
 
-       /** A list of module names (names only, no paths)
-        * which are currently loaded by the server.
-        */
-       std::vector<std::string> module_names;
-
        /** A list of the classes for listening client ports
         */
        std::vector<ListenSocket*> ports;
 
-       /** Boolean sets of which modules implement which functions
-        */
-       char implement_lists[255][255];
-
-       /** Global implementation list
-        */
-       char global_implementation[255];
-
-       /** A list of ports claimed by IO Modules
+       /** socket objects that are attached to by modules
         */
-       std::map<int,Module*> IOHookModule;
-
-       std::map<InspSocket*, Module*> SocketIOHookModule;
+       std::map<BufferedSocket*, Module*> SocketIOHookModule;
 
        /** The 005 tokens of this server (ISUPPORT)
         * populated/repopulated upon loading or unloading
@@ -597,6 +639,18 @@ class CoreExport ServerConfig : public Extensible
         */
        unsigned int OperMaxChans;
 
+       /** TS6-like server ID.
+        * NOTE: 000...999 are usable for InspIRCd servers. This
+        * makes code simpler. 0AA, 1BB etc with letters are reserved
+        * for services use.
+        */
+       char sid[MAXBUF];
+
+       /** True if we have been told to run the testsuite from the commandline,
+        * rather than entering the mainloop.
+        */
+       bool TestSuite;
+
        /** Construct a new ServerConfig
         */
        ServerConfig(InspIRCd* Instance);
@@ -605,19 +659,23 @@ class CoreExport ServerConfig : public Extensible
         */
        void ClearStack();
 
+       /** Get server ID as string with required leading zeroes
+        */
+       std::string GetSID();
+
        /** Update the 005 vector
         */
        void Update005();
 
        /** Send the 005 numerics (ISUPPORT) to a user
         */
-       void Send005(userrec* user);
+       void Send005(User* user);
 
        /** Read the entire configuration into memory
         * and initialize this class. All other methods
         * should be used only by the core.
         */
-       void Read(bool bail, userrec* user);
+       void Read(bool bail, User* user);
 
        /** Read a file into a file_cache object
         */
@@ -627,19 +685,19 @@ class CoreExport ServerConfig : public Extensible
         * @param bail If this is set to true, the error is sent to the console, and the program exits
         * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
         * this user as SNOTICEs.
-        * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
+        * If the parameter is NULL, the messages are spooled to all opers.
         */
-       void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
+       void ReportConfigError(const std::string &errormessage, bool bail, User* user);
 
        /** Load 'filename' into 'target', with the new config parser everything is parsed into
         * tag/key/value at load-time rather than at read-value time.
         */
-       bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
+       bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
 
        /** Load 'filename' into 'target', with the new config parser everything is parsed into
         * tag/key/value at load-time rather than at read-value time.
         */
-       bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
+       bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
        
        /* Both these return true if the value existed or false otherwise */
        
@@ -696,46 +754,32 @@ class CoreExport ServerConfig : public Extensible
        /** Returns the numbers of vars inside the index'th 'tag in the config file
         */
        int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
-       
-       /** Get a pointer to the module which has hooked the given port.
-        * @parameter port Port number
-        * @return Returns a pointer to the hooking module, or NULL
-        */
-       Module* GetIOHook(int port);
 
-       /** Hook a module to a client port, so that it can receive notifications
-        * of low-level port activity.
-        * @param port The port number
-        * @param Module the module to hook to the port
-        * @return True if the hook was successful.
-        */
-       bool AddIOHook(int port, Module* iomod);
+       void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
 
-       /** Delete a module hook from a client port.
-        * @param port The port to detatch from
-        * @return True if successful
-        */
-       bool DelIOHook(int port);
-       
-       /** Get a pointer to the module which has hooked the given InspSocket class.
+       void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
+
+       void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
+
+       /** Get a pointer to the module which has hooked the given BufferedSocket class.
         * @parameter port Port number
         * @return Returns a pointer to the hooking module, or NULL
         */
-       Module* GetIOHook(InspSocket* is);
+       Module* GetIOHook(BufferedSocket* is);
 
-       /** Hook a module to an InspSocket class, so that it can receive notifications
+       /** Hook a module to an BufferedSocket class, so that it can receive notifications
         * of low-level socket activity.
         * @param iomod The module to hook to the socket
-        * @param is The InspSocket to attach to
+        * @param is The BufferedSocket to attach to
         * @return True if the hook was successful.
         */
-       bool AddIOHook(Module* iomod, InspSocket* is);
+       bool AddIOHook(Module* iomod, BufferedSocket* is);
 
-       /** Delete a module hook from an InspSocket.
-        * @param is The InspSocket to detatch from.
+       /** Delete a module hook from an BufferedSocket.
+        * @param is The BufferedSocket to detatch from.
         * @return True if the unhook was successful
         */
-       bool DelIOHook(InspSocket* is);
+       bool DelIOHook(BufferedSocket* is);
 
        /** Returns the fully qualified path to the inspircd directory
         * @return The full program directory
@@ -786,5 +830,30 @@ bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &val
  */
 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
 
+
+
+/** Initialize x line
+ */
+bool InitXLine(ServerConfig* conf, const char* tag);
+/** Add a config-defined zline
+ */
+bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+
+/** Add a config-defined qline
+ */
+bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+
+/** Add a config-defined kline
+ */
+bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+
+/** Add a config-defined eline
+ */
+bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+
+
+
+
 #endif