fix for bug #175, change OnUserRegister to return int, and if greater than 0 = user...

[user/henk/code/inspircd.git] / include / configreader.h

diff --git a/include/configreader.h b/include/configreader.h
index be952f0510f02258ef2ae4b2d40d648c695bda09..f3816ba32b61c1756918fae6eae917ac202a843f 100644 (file)
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -31,27 +31,111 @@
 class ServerConfig;
 class InspIRCd;
 
+/** Types of data in the core config
+ */
+enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
+
+/** 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
+{
+       std::string v;
+ public:
+       ValueItem(int value);
+       ValueItem(bool value);
+       ValueItem(char* value);
+       void Set(char* value);
+       void Set(const char* val);
+       void Set(int value);
+       int GetInteger();
+       char* GetString();
+       bool GetBool();
+};
+
+/** The base class of the container 'ValueContainer'
+ * used internally by the core to hold core values.
+ */
+class ValueContainerBase
+{
+ public:
+       ValueContainerBase() { }
+       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
+{
+       T val;
+
+ public:
+
+       ValueContainer()
+       {
+               val = NULL;
+       }
+
+       ValueContainer(T Val)
+       {
+               val = Val;
+       }
+
+       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 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*, void*);
+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**, void**, int*);
+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*);
 
-/** Types of data in the core config
- */
-enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
-
 /** Holds a core configuration item and its callbacks
  */
 struct InitialConfig
 {
        char* tag;
        char* value;
-       void* val;
+       ValueContainerBase* val;
        ConfigDataType datatype;
        Validator validation_function;
 };
@@ -61,9 +145,9 @@ struct InitialConfig
  */
 struct MultiConfig
 {
-       const char* tag;
-       char* items[12];
-       int datatype[12];
+       const char*     tag;
+       char*           items[12];
+       int             datatype[12];
        MultiNotify     init_function;
        MultiValidator  validation_function;
        MultiNotify     finish_function;
@@ -75,7 +159,7 @@ typedef std::map<irc::string,char*> opertype_t;
 
 /** A Set of oper classes
  */
-typedef opertype_t operclass_t;
+typedef std::map<irc::string,char*> operclass_t;
 
 
 /** This class holds the bulk of the runtime configuration for the ircd.
@@ -120,6 +204,19 @@ class ServerConfig : public Extensible
         */
        ConfigDataHash config_data;
 
+       /** Max number of WhoWas entries per user.
+        */
+       int WhoWasGroupSize;
+
+       /** Max number of cumulative user-entries in WhoWas.
+        *  When max reached and added to, push out oldest entry FIFO style.
+        */
+       int WhoWasMaxGroups;
+
+       /** Max seconds a user is kept in WhoWas before being pruned.
+        */
+       int WhoWasMaxKeep;
+
        /** Holds the server name of the local server
         * as defined by the administrator.
         */
@@ -361,7 +458,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
         */
@@ -392,7 +489,7 @@ class ServerConfig : public Extensible
         */
        bool CycleHosts;
 
-       /* All oper type definitions from the config file
+       /** All oper type definitions from the config file
         */
        opertype_t opertypes;
 
@@ -477,4 +574,10 @@ class ServerConfig : public Extensible
 
 bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
 
+bool InitTypes(ServerConfig* conf, const char* tag);
+bool InitClasses(ServerConfig* conf, const char* tag);
+bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
+
 #endif