]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
And fix typo
[user/henk/code/inspircd.git] / include / configreader.h
index 3bb7bb4ed4368aac2bb0a8cbeb6a614f9fb0138f..cce4e0f9dd85999efe3ce04dab95292eb4ca829b 100644 (file)
 #include "inspircd.h"
 #include "globals.h"
 #include "modules.h"
+#include "socketengine.h"
+#include "socket.h"
 
-typedef bool (*Validator)(const char*, const char*, void*);
-typedef bool (*MultiValidator)(const char*, char**, void**, int*);
-typedef bool (*MultiNotify)(const char*);
+class ServerConfig;
+class InspIRCd;
 
+/** A callback for validating a single value
+ */
+typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, void*);
+/** A callback for validating multiple value entries
+ */
+typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, void**, int*);
+/** A callback indicating the end of a group of entries
+ */
+typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
+
+/** Types of data in the core config
+ */
 enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
 
-struct InitialConfig {
+/** Holds a core configuration item and its callbacks
+ */
+struct InitialConfig
+{
        char* tag;
        char* value;
        void* val;
@@ -40,7 +56,11 @@ struct InitialConfig {
        Validator validation_function;
 };
 
-struct MultiConfig {
+/** Holds a core configuration item and its callbacks
+ * where there may be more than one item
+ */
+struct MultiConfig
+{
        const char* tag;
        char* items[12];
        int datatype[12];
@@ -49,6 +69,15 @@ struct MultiConfig {
        MultiNotify     finish_function;
 };
 
+/** A set of oper types
+ */
+typedef std::map<irc::string,char*> opertype_t;
+
+/** A Set of oper classes
+ */
+typedef opertype_t operclass_t;
+
+
 /** This class holds the bulk of the runtime configuration for the ircd.
  * It allows for reading new config values, accessing configuration files,
  * and storage of the configuration data needed to run the ircd, such as
@@ -57,6 +86,10 @@ struct MultiConfig {
 class ServerConfig : public Extensible
 {
   private:
+       /** Creator/owner
+        */
+       InspIRCd* ServerInstance;
+
        /** This variable holds the names of all
         * files included from the main one. This
         * is used to make sure that no files are
@@ -70,6 +103,8 @@ class ServerConfig : public Extensible
         */
        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);
 
        /** Check that there is only one of each configuration item
@@ -77,6 +112,8 @@ class ServerConfig : public Extensible
        bool CheckOnce(char* tag, bool bail, userrec* user);
   
   public:
+
+       InspIRCd* GetInstance();
          
        /** This holds all the information in the config file,
         * it's indexed by tag name to a vector of key/values.
@@ -299,6 +336,10 @@ class ServerConfig : public Extensible
         */
        int ports[255];
 
+       /** A list of the file descriptors for the listening client ports
+        */
+       ListenSocket* openSockfd[255];
+
        /** Boolean sets of which modules implement which functions
         */
        char implement_lists[255][255];
@@ -320,7 +361,7 @@ class ServerConfig : public Extensible
        /** STATS characters in this list are available
         * only to operators.
         */
-       char OperOnlyStats[MAXBUF];
+       char UserStats[MAXBUF];
        
        /** The path and filename of the ircd.log file
         */
@@ -338,10 +379,32 @@ class ServerConfig : public Extensible
         */
        std::map<std::string,int> maxbans;
 
-       ServerConfig();
+       /** If set to true, no user DNS lookups are to be performed
+        */
+       bool NoUserDns;
+
+       /** If set to true, provide syntax hints for unknown commands
+        */
+       bool SyntaxHints;
+
+       /** If set to true, users appear to quit then rejoin when their hosts change.
+        * This keeps clients synchronized properly.
+        */
+       bool CycleHosts;
 
-       /** Clears the include stack in preperation for
-        * a Read() call.
+       /* All oper type definitions from the config file
+        */
+       opertype_t opertypes;
+
+       /** All oper class definitions from the config file
+        */
+       operclass_t operclass;
+
+       /** Construct a new ServerConfig
+        */
+       ServerConfig(InspIRCd* Instance);
+
+       /** Clears the include stack in preperation for a Read() call.
         */
        void ClearStack();
 
@@ -351,37 +414,67 @@ class ServerConfig : public Extensible
         */
        void Read(bool bail, userrec* user);
 
+       /** Read a file into a file_cache object
+        */
+       bool ReadFile(file_cache &F, const char* fname);
+
        /** 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);
+       /** 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);
        
        /* Both these return true if the value existed or false otherwise */
        
-       /* Writes 'length' chars into 'result' as a string */
+       /** Writes 'length' chars into 'result' as a string
+        */
        bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
+       /** Writes 'length' chars into 'result' as a string
+        */
        bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
        
-       /* Tries to convert the value to an integer and write it to 'result' */
+       /** Tries to convert the value to an integer and write it to 'result'
+        */
        bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
+       /** Tries to convert the value to an integer and write it to 'result'
+        */
        bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
        
-       /* Returns true if the value exists and has a true value, false otherwise */
+       /** Returns true if the value exists and has a true value, false otherwise
+        */
        bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
+       /** Returns true if the value exists and has a true value, false otherwise
+        */
        bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
        
-       /* Returns the number of occurences of tag in the config file */
+       /** Returns the number of occurences of tag in the config file
+        */
        int ConfValueEnum(ConfigDataHash &target, const char* tag);
+       /** Returns the number of occurences of tag in the config file
+        */
        int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
        
-       /* Returns the numbers of vars inside the index'th 'tag in the config file */
+       /** Returns the numbers of vars inside the index'th 'tag in the config file
+        */
        int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
+       /** Returns the numbers of vars inside the index'th 'tag in the config file
+        */
        int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
        
        Module* GetIOHook(int port);
        bool AddIOHook(int port, Module* iomod);
        bool DelIOHook(int port);
+
+       static std::string GetFullProgDir(char** argv, int argc);
+       static bool DirValid(const char* dirandfile);
+       static char* CleanFilename(char* name);
+       static bool FileExists(const char* file);
+       
 };
 
+bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
+
 #endif