]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Remove InspIRCd* parameters and fields
[user/henk/code/inspircd.git] / include / configreader.h
index 36e5badfd0c455a80acd4f8f22cdb8fe612d0786..28138edd65f537443cd31bbd2852c3cf85a3a216 100644 (file)
@@ -19,7 +19,7 @@
 /** Determines if a channel op is exempt from given mode m,
  * in config of server instance s.
  */
-#define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
+#define CHANOPS_EXEMPT(m) (ServerInstance->Config->ExemptChanOps[(unsigned char)m])
 
 #include <sstream>
 #include <string>
 
 /* Required forward definitions */
 class ServerConfig;
+class ServerLimits;
 class InspIRCd;
 class BufferedSocket;
 
-/** Types of data in the core config
- */
-enum ConfigDataType
-{
-       DT_NOTHING       = 0,           /* No data */
-       DT_INTEGER       = 1,           /* Integer */
-       DT_CHARPTR       = 2,           /* Char pointer */
-       DT_BOOLEAN       = 3,           /* Boolean */
-       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 */
-};
-
-/** The maximum number of values in a core configuration tag. Can be increased if needed.
- */
-#define MAX_VALUES_PER_TAG 18
-
-/** Holds a config value, either string, integer or boolean.
- * Callback functions receive one or more of these, either on
- * their own as a reference, or in a reference to a deque of them.
- * The callback function can then alter the values of the ValueItem
- * classes to validate the settings.
- */
-class ValueItem
-{
-       /** Actual data */
-       std::string v;
- public:
-       /** Initialize with an int */
-       ValueItem(int value);
-       /** Initialize with a bool */
-       ValueItem(bool value);
-       /** Initialize with a char pointer */
-       ValueItem(const char* value);
-       /** Change value to a char pointer */
-       void Set(const char* val);
-       /** Change value to an int */
-       void Set(int value);
-       /** Get value as an int */
-       int GetInteger();
-       /** Get value as a string */
-       char* GetString();
-       /** Get value as a bool */
-       bool GetBool();
-};
-
-/** The base class of the container 'ValueContainer'
- * used internally by the core to hold core values.
- */
-class ValueContainerBase
-{
- public:
-       /** Constructor */
-       ValueContainerBase() { }
-       /** Destructor */
-       virtual ~ValueContainerBase() { }
-};
-
-/** ValueContainer is used to contain pointers to different
- * core values such as the server name, maximum number of
- * clients etc.
- * It is specialized to hold a data type, then pointed at
- * a value in the ServerConfig class. When the value has been
- * read and validated, the Set method is called to write the
- * value safely in a type-safe manner.
- */
-template<typename T> class ValueContainer : public ValueContainerBase
-{
-       /** Contained item */
-       T val;
- public:
-
-       /** Initialize with nothing */
-       ValueContainer()
-       {
-               val = NULL;
-       }
-
-       /** Initialize with a value of type T */
-       ValueContainer(T Val)
-       {
-               val = Val;
-       }
-
-       /** Change value to type T of size s */
-       void Set(T newval, size_t s)
-       {
-               memcpy(val, newval, s);
-       }
-};
-
-/** A specialization of ValueContainer to hold a pointer to a bool
- */
-typedef ValueContainer<bool*> ValueContainerBool;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an unsigned int
- */
-typedef ValueContainer<unsigned int*> ValueContainerUInt;
-
-/** A specialization of ValueContainer to hold a pointer to
- * a char array.
- */
-typedef ValueContainer<char*> ValueContainerChar;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an int
- */
-typedef ValueContainer<int*> ValueContainerInt;
-
-/** A specialization of ValueContainer to hold a pointer to
- * a size_t.
- */
-typedef ValueContainer<size_t*> ValueContainerST;
-
-/** A set of ValueItems used by multi-value validator functions
- */
-typedef std::deque<ValueItem> ValueList;
-
-/** A callback for validating a single value
- */
-typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
-/** A callback for validating multiple value entries
- */
-typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
-/** A callback indicating the end of a group of entries
- */
-typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
-
-/** Holds a core configuration item and its callbacks
- */
-struct InitialConfig
-{
-       /** Tag name */
-       const char* tag;
-       /** Value name */
-       const char* value;
-       /** Default, if not defined */
-       const char* default_value;
-       /** Value containers */
-       ValueContainerBase* val;
-       /** Data types */
-       int datatype;
-       /** Validation function */
-       Validator validation_function;
-};
-
-/** Represents a deprecated configuration tag.
- */
-struct Deprecated
-{
-       /** Tag name
-        */
-       const char* tag;
-       /** Tag value
-        */
-       const char* value;
-       /** Reason for deprecation
-        */
-       const char* reason;
-};
-
-/** Holds a core configuration item and its callbacks
- * where there may be more than one item
- */
-struct MultiConfig
-{
-       /** Tag name */
-       const char*     tag;
-       /** One or more items within tag */
-       const char*     items[MAX_VALUES_PER_TAG];
-       /** One or more defaults for items within tags */
-       const char* items_default[MAX_VALUES_PER_TAG];
-       /** One or more data types */
-       int             datatype[MAX_VALUES_PER_TAG];
-       /** Initialization function */
-       MultiNotify     init_function;
-       /** Validation function */
-       MultiValidator  validation_function;
-       /** Completion function */
-       MultiNotify     finish_function;
-};
-
 /** A set of oper types
  */
 typedef std::map<irc::string,std::string> opertype_t;
 
 /** Holds an oper class.
  */
-struct operclass_data : public Extensible
+struct operclass_data : public classbase
 {
        /** Command list for the class
         */
-       char *commandlist;
+       std::string commandlist;
 
        /** Channel mode list for the class
         */
-       char *cmodelist;
+       std::string cmodelist;
 
        /** User mode list for the class
         */
-       char *umodelist;
+       std::string umodelist;
 
        /** Priviledges given by this class
         */
-       char *privs;
+       std::string privs;
 };
 
 /** A Set of oper classes
@@ -253,7 +68,7 @@ typedef std::map<irc::string, operclass_data> operclass_t;
 /** Defines the server's length limits on various length-limited
  * items such as topics, nicknames, channel names etc.
  */
-class ServerLimits : public Extensible
+class ServerLimits
 {
  public:
        /** Maximum nickname length */
@@ -304,13 +119,9 @@ class ServerLimits : public Extensible
  * and storage of the configuration data needed to run the ircd, such as
  * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
  */
-class CoreExport ServerConfig : public Extensible
+class CoreExport ServerConfig : public classbase
 {
   private:
-       /** Creator/owner pointer
-        */
-       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
@@ -318,16 +129,22 @@ class CoreExport ServerConfig : public Extensible
         */
        std::vector<std::string> include_stack;
 
+       /* classes removed by this rehash */
+       std::vector<ConnectClass*> removed_classes;
+
        /** This private method processes one line of
         * configutation, appending errors to errorstream
         * and setting error if an error has occured.
         */
-       bool ParseLine(const std::string &filename, std::string &line, long &linenumber);
+       bool ParseLine(const std::string &filename, std::string &line, long &linenumber, bool allowexeinc);
 
        /** Check that there is only one of each configuration item
         */
        bool CheckOnce(const char* tag);
 
+       void CrossCheckOperClassType();
+       void CrossCheckConnectBlocks(ServerConfig* current);
+
  public:
        /** Process an include executable directive
         */
@@ -335,11 +152,11 @@ class CoreExport ServerConfig : public Extensible
 
        /** Process an include file directive
         */
-       bool DoInclude(const std::string &file);
+       bool DoInclude(const std::string &file, bool allowexeinc);
 
        /** Error stream, contains error output from any failed configuration parsing.
         */
-       std::ostringstream errstr;
+       std::stringstream errstr;
 
        /** True if this configuration is valid enough to run with */
        bool valid;
@@ -351,13 +168,6 @@ class CoreExport ServerConfig : public Extensible
        /** 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;
-
-       /** Returns the creator InspIRCd pointer
-        */
-       InspIRCd* GetInstance();
-
        /** Not used any more as it is named, can probably be removed or renamed.
         */
        int DoDownloads();
@@ -513,12 +323,12 @@ class CoreExport ServerConfig : public Extensible
         * overridden in the configuration file via
         * the <options> tag.
         */
-       char ModPath[1024];
+       std::string ModPath;
 
        /** The full pathname to the executable, as
         * given in argv[0] when the program starts.
         */
-       char MyExecutable[1024];
+       std::string MyExecutable;
 
        /** The file handle of the logfile. If this
         * value is NULL, the log file is not open,
@@ -658,7 +468,7 @@ class CoreExport ServerConfig : public Extensible
        /** The full pathname and filename of the PID
         * file as defined in the configuration.
         */
-       char PID[1024];
+       std::string PID;
 
        /** The connect classes in use by the IRC server.
         */
@@ -764,11 +574,7 @@ class CoreExport ServerConfig : public Extensible
 
        /** Construct a new ServerConfig
         */
-       ServerConfig(InspIRCd* Instance);
-
-       /** Clears the include stack in preperation for a Read() call.
-        */
-       void ClearStack();
+       ServerConfig();
 
        /** Get server ID as string with required leading zeroes
         */
@@ -791,6 +597,7 @@ class CoreExport ServerConfig : public Extensible
        /** Apply configuration changes from the old configuration.
         */
        void Apply(ServerConfig* old, const std::string &useruid);
+       void ApplyModules(User* user);
 
        /** Read a file into a file_cache object
         */
@@ -800,19 +607,15 @@ class CoreExport ServerConfig : public Extensible
         */
        bool StartsWithWindowsDriveLetter(const std::string &path);
 
-       /** Report a configuration error given in errormessage.
-        */
-       void ReportConfigError(const std::string &errormessage);
-
        /** 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(FILE* &conf, const char* filename);
+       bool LoadConf(FILE* &conf, const char* filename, bool allowexeinc);
 
        /** 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(FILE* &conf, const std::string &filename);
+       bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc);
 
        /** Writes 'length' chars into 'result' as a string
         */
@@ -876,17 +679,7 @@ class CoreExport ServerConfig : public Extensible
         */
        int ConfVarEnum(const std::string &tag, int index);
 
-       /** Validates a hostname value, throwing ConfigException if it is not valid
-        */
-       void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
-
-       /** Validates an IP address value, throwing ConfigException if it is not valid
-        */
-       void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
-
-       /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
-        */
-       void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
+       bool ApplyDisabledCommands(const char* data);
 
        /** Returns the fully qualified path to the inspircd directory
         * @return The full program directory
@@ -897,7 +690,7 @@ class CoreExport ServerConfig : public Extensible
         * @param name Directory to tidy
         * @return The cleaned filename
         */
-       static char* CleanFilename(char* name);
+       static const char* CleanFilename(const char* name);
 
        /** Check if a file exists.
         * @param file The full path to a file
@@ -911,50 +704,202 @@ class CoreExport ServerConfig : public Extensible
 
 };
 
-/** Initialize the disabled commands list
+
+/** Types of data in the core config
  */
-CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
+enum ConfigDataType
+{
+       DT_NOTHING       = 0,           /* No data */
+       DT_INTEGER       = 1,           /* Integer */
+       DT_CHARPTR       = 2,           /* Char pointer */
+       DT_BOOLEAN       = 3,           /* Boolean */
+       DT_HOSTNAME      = 4,           /* Hostname syntax */
+       DT_NOSPACES      = 5,           /* No spaces */
+       DT_IPADDRESS     = 6,           /* IP address (v4, v6) */
+       DT_CHANNEL       = 7,           /* Channel name */
+       DT_LIMIT     = 8,       /* size_t */
+       DT_ALLOW_WILD    = 64,          /* Allow wildcards/CIDR in DT_IPADDRESS */
+       DT_ALLOW_NEWLINE = 128          /* New line characters allowed in DT_CHARPTR */
+};
 
-/** Initialize the oper types
+/** The maximum number of values in a core configuration tag. Can be increased if needed.
  */
-bool InitTypes(ServerConfig* conf, const char* tag);
+#define MAX_VALUES_PER_TAG 18
 
-/** Initialize the oper classes
+/** Holds a config value, either string, integer or boolean.
+ * Callback functions receive one or more of these, either on
+ * their own as a reference, or in a reference to a deque of them.
+ * The callback function can then alter the values of the ValueItem
+ * classes to validate the settings.
  */
-bool InitClasses(ServerConfig* conf, const char* tag);
+class ValueItem
+{
+       /** Actual data */
+       std::string v;
+ public:
+       /** Initialize with an int */
+       ValueItem(int value);
+       /** Initialize with a bool */
+       ValueItem(bool value);
+       /** Initialize with a string */
+       ValueItem(const char* value) : v(value) { }
+       /** Change value to a string */
+       void Set(const std::string &val);
+       /** Change value to an int */
+       void Set(int value);
+       /** Get value as an int */
+       int GetInteger();
+       /** Get value as a string */
+       const char* GetString() const;
+       /** Get value as a string */
+       inline const std::string& GetValue() const { return v; }
+       /** Get value as a bool */
+       bool GetBool();
+};
 
-/** Initialize an oper type
+/** The base class of the container 'ValueContainer'
+ * used internally by the core to hold core values.
  */
-bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+class ValueContainerBase
+{
+ public:
+       /** Constructor */
+       ValueContainerBase() { }
+       /** Destructor */
+       virtual ~ValueContainerBase() { }
+};
 
-/** Initialize an oper class
+/** ValueContainer is used to contain pointers to different
+ * core values such as the server name, maximum number of
+ * clients etc.
+ * It is specialized to hold a data type, then pointed at
+ * a value in the ServerConfig class. When the value has been
+ * read and validated, the Set method is called to write the
+ * value safely in a type-safe manner.
  */
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+template<typename T> class ValueContainer : public ValueContainerBase
+{
+       T ServerConfig::* const vptr;
+ public:
+       /** Initialize with a value of type T */
+       ValueContainer(T ServerConfig::* const offset) : vptr(offset)
+       {
+       }
+
+       /** Change value to type T of size s */
+       void Set(ServerConfig* conf, const T& value)
+       {
+               conf->*vptr = value;
+       }
+
+       void Set(ServerConfig* conf, const ValueItem& item);
+};
 
-/** Finish initializing the oper types and classes
+template<> void ValueContainer<char[MAXBUF]>::Set(ServerConfig* conf, ValueItem const& item);
+
+
+class ValueContainerLimit : public ValueContainerBase
+{
+       size_t ServerLimits::* const vptr;
+ public:
+       /** Initialize with a value of type T */
+       ValueContainerLimit(size_t ServerLimits::* const offset) : vptr(offset)
+       {
+       }
+
+       /** Change value to type T of size s */
+       void Set(ServerConfig* conf, const size_t& value)
+       {
+               conf->Limits.*vptr = value;
+       }
+};
+
+/** A specialization of ValueContainer to hold a pointer to a bool
  */
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
+typedef ValueContainer<bool> ValueContainerBool;
 
+/** A specialization of ValueContainer to hold a pointer to
+ * an unsigned int
+ */
+typedef ValueContainer<unsigned int> ValueContainerUInt;
 
+/** A specialization of ValueContainer to hold a pointer to
+ * a char array.
+ */
+typedef ValueContainer<char[MAXBUF]> ValueContainerChar;
 
-/** Initialize x line
+/** A specialization of ValueContainer to hold a pointer to
+ * a char array.
  */
-bool InitXLine(ServerConfig* conf, const char* tag);
+typedef ValueContainer<std::string> ValueContainerString;
 
-/** Add a config-defined zline
+/** A specialization of ValueContainer to hold a pointer to
+ * an int
  */
-bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+typedef ValueContainer<int> ValueContainerInt;
 
-/** Add a config-defined qline
+/** A set of ValueItems used by multi-value validator functions
  */
-bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+typedef std::deque<ValueItem> ValueList;
 
-/** Add a config-defined kline
+/** A callback for validating a single value
+ */
+typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
+/** A callback for validating multiple value entries
+ */
+typedef bool (*MultiValidator)(ServerConfig* conf, const char*, const char**, ValueList&, int*);
+/** A callback indicating the end of a group of entries
  */
-bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
 
-/** Add a config-defined eline
+/** Holds a core configuration item and its callbacks
  */
-bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+struct InitialConfig
+{
+       /** Tag name */
+       const char* tag;
+       /** Value name */
+       const char* value;
+       /** Default, if not defined */
+       const char* default_value;
+       /** Value containers */
+       ValueContainerBase* val;
+       /** Data types */
+       int datatype;
+       /** Validation function */
+       Validator validation_function;
+};
+
+/** Represents a deprecated configuration tag.
+ */
+struct Deprecated
+{
+       /** Tag name
+        */
+       const char* tag;
+       /** Tag value
+        */
+       const char* value;
+       /** Reason for deprecation
+        */
+       const char* reason;
+};
+
+/** Holds a core configuration item and its callbacks
+ * where there may be more than one item
+ */
+struct MultiConfig
+{
+       /** Tag name */
+       const char*     tag;
+       /** One or more items within tag */
+       const char*     items[MAX_VALUES_PER_TAG];
+       /** One or more defaults for items within tags */
+       const char* items_default[MAX_VALUES_PER_TAG];
+       /** One or more data types */
+       int             datatype[MAX_VALUES_PER_TAG];
+       /** Validation function */
+       MultiValidator  validation_function;
+};
 
 #endif