]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Fix m_nationalchars using a copy and paste of my unsafe copy and paste algorithm...
[user/henk/code/inspircd.git] / include / configreader.h
index 2556cf08898b9fecb3c114c91c2a63d5aa4969c5..0b05262b436e30e7e2d5dabd73a4d1693b2feb0e 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -26,7 +26,6 @@
 #include <vector>
 #include <map>
 #include "inspircd.h"
-#include "globals.h"
 #include "modules.h"
 #include "socketengine.h"
 #include "socket.h"
@@ -150,6 +149,9 @@ typedef ValueContainer<char*> ValueContainerChar;
  */
 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
@@ -184,10 +186,18 @@ struct InitialConfig
        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;
 };
 
@@ -216,32 +226,57 @@ struct MultiConfig
  */
 typedef std::map<irc::string,char*> opertype_t;
 
+/** Holds an oper class.
+ */
 struct operclass_data : public Extensible
 {
-       char* commandlist;
-       char* cmodelist;
-       char* umodelist;
+       /** Command list for the class
+        */
+       char *commandlist;
+
+       /** Channel mode list for the class
+        */
+       char *cmodelist;
+
+       /** User mode list for the class
+        */
+       char *umodelist;
+
+       /** Priviledges given by this class
+        */
+       char *privs;
 };
 
 /** A Set of oper classes
  */
 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
 {
  public:
+       /** Maximum nickname length */
        size_t NickMax;
+       /** Maximum channel length */
        size_t ChanMax;
+       /** Maximum number of modes per line */
        size_t MaxModes;
+       /** Maximum length of ident, not including ~ etc */
        size_t IdentMax;
+       /** Maximum length of a quit message */
        size_t MaxQuit;
+       /** Maximum topic length */
        size_t MaxTopic;
+       /** Maximum kick message length */
        size_t MaxKick;
+       /** Maximum GECOS (real name) length */
        size_t MaxGecos;
+       /** Maximum away message length */
        size_t MaxAway;
 
-       /* Creating the class initialises it to the defaults
+       /** Creating the class initialises it to the defaults
         * as in 1.1's ./configure script. Reading other values
         * from the config will change these values.
         */
@@ -249,11 +284,13 @@ class ServerLimits : public Extensible
        {
        }
 
+       /** Finalises the settings by adding one. This allows for them to be used as-is
+        * without a 'value+1' when using the std::string assignment methods etc.
+        */
        void Finalise()
        {
                NickMax++;
                ChanMax++;
-               MaxModes++;
                IdentMax++;
                MaxQuit++;
                MaxTopic++;
@@ -286,14 +323,13 @@ 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);
+       bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
 
        /** Check that there is only one of each configuration item
         */
        bool CheckOnce(const char* tag, ConfigDataHash &newconf);
 
  public:
-
        /** Process an include executable directive
         */
        bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
@@ -302,14 +338,26 @@ class CoreExport ServerConfig : public Extensible
         */
        bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 
-       User* RehashUser;
+       /** User that is currently performing a rehash, needed because the
+        * rehash code is now threaded and needs to know who to give errors and feedback to.
+        */
+       std::string RehashUserUID;
 
+       /** Rehash parameter, as above
+        */
        std::string RehashParameter;
 
-       std::ostringstream errstr;
+       /** Error stream, contains error output from any failed configuration parsing.
+        */
+       std::ostringstream* errstr;
 
+       /** Holds the new configuration when a rehash occurs so we dont overwrite the existing
+        * working config with a broken one without checking it first and swapping pointers.
+        */
        ConfigDataHash newconfig;
 
+       /** Set of included files. Do we use this any more?
+        */
        std::map<std::string, std::istream*> IncludedFiles;
 
        /** Used to indicate who we announce invites to on a channel */
@@ -318,8 +366,12 @@ class CoreExport ServerConfig : public Extensible
        /** 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();
          
        /** This holds all the information in the config file,
@@ -327,8 +379,20 @@ class CoreExport ServerConfig : public Extensible
         */
        ConfigDataHash config_data;
 
+       /** Length limits, see definition of ServerLimits class
+        */
        ServerLimits Limits;
 
+       /** Clones CIDR range for ipv4 (0-32)
+        * Defaults to 32 (checks clones on all IPs seperately)
+        */
+       int c_ipv4_range;
+
+       /** Clones CIDR range for ipv6 (0-128)
+        * Defaults to 128 (checks on all IPs seperately)
+        */
+       int c_ipv6_range;
+
        /** Max number of WhoWas entries per user.
         */
        int WhoWasGroupSize;
@@ -342,6 +406,11 @@ class CoreExport ServerConfig : public Extensible
         */
        int WhoWasMaxKeep;
 
+       /** Both for set(g|u)id.
+        */
+       char SetUser[MAXBUF];
+       char SetGroup[MAXBUF];
+
        /** Holds the server name of the local server
         * as defined by the administrator.
         */
@@ -432,12 +501,25 @@ class CoreExport ServerConfig : public Extensible
         */
        char DNSServer[MAXBUF];
 
+       /** Pretend disabled commands don't exist.
+        */
+       bool DisabledDontExist;
+
        /** This variable contains a space-seperated list
         * of commands which are disabled by the
         * administrator of the server for non-opers.
         */
        char DisabledCommands[MAXBUF];
 
+       /** This variable identifies which usermodes have been diabled.
+        */
+
+       char DisabledUModes[64];
+
+       /** This variable identifies which chanmodes have been disabled.
+        */
+       char DisabledCModes[64];
+
        /** The full path to the modules directory.
         * This is either set at compile time, or
         * overridden in the configuration file via
@@ -483,6 +565,11 @@ class CoreExport ServerConfig : public Extensible
         */
        bool writelog;
 
+       /** If this value is true, banned users (+b, not extbans) will not be able to change nick
+        * if banned on any channel, nor to message them.
+        */
+       bool RestrictBannedUsers;
+
        /** If this value is true, halfops have been
         * enabled in the configuration file.
         */
@@ -583,13 +670,9 @@ class CoreExport ServerConfig : public Extensible
         */
        ClassVector Classes;
 
-       /** A list of the classes for listening client ports
+       /** A list of the classes for listening ports
         */
-       std::vector<ListenSocket*> ports;
-
-       /** socket objects that are attached to by modules
-        */
-       std::map<BufferedSocket*, Module*> SocketIOHookModule;
+       std::vector<ListenSocketBase *> ports;
 
        /** The 005 tokens of this server (ISUPPORT)
         * populated/repopulated upon loading or unloading
@@ -713,7 +796,7 @@ class CoreExport ServerConfig : public Extensible
         * and initialize this class. All other methods
         * should be used only by the core.
         */
-       void Read(bool bail, User* user);
+       void Read(bool bail, const std::string &useruid);
 
        /** Read a file into a file_cache object
         */
@@ -725,11 +808,11 @@ class CoreExport ServerConfig : public Extensible
 
        /** Report a configuration error given in errormessage.
         * @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 opers.
+        * @param useruid If this is set to a non-empty value which is a valid UID, and bail is false,
+        * the errors are spooled to this user as SNOTICEs.
+        * If the parameter is not a valid UID, the messages are spooled to all opers.
         */
-       void ReportConfigError(const std::string &errormessage, bool bail, User* user);
+       void ReportConfigError(const std::string &errormessage, bool bail, const std::string &useruid);
 
        /** 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.
@@ -741,11 +824,10 @@ class CoreExport ServerConfig : public Extensible
         */
        bool LoadConf(ConfigDataHash &target, FILE* &conf, 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
         */
        bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
+
        /** Writes 'length' chars into 'result' as a string
         */
        bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
@@ -753,6 +835,7 @@ class CoreExport ServerConfig : public Extensible
        /** 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, bool allow_linefeeds = false);
+
        /** Writes 'length' chars into 'result' as a string
         */
        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);
@@ -760,12 +843,15 @@ class CoreExport ServerConfig : public Extensible
        /** 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 char* tag, const char* var, const char* default_value, 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);
+
        /** 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, const std::string &default_value, int index, int &result);
@@ -773,12 +859,15 @@ class CoreExport ServerConfig : public Extensible
        /** 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 char* tag, const char* var, const char* default_value, 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 true if the value exists and has a true value, false otherwise
         */
        bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
@@ -797,31 +886,17 @@ class CoreExport ServerConfig : public Extensible
         */
        int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
 
-       void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
-
-       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
+       /** Validates a hostname value, throwing ConfigException if it is not valid
         */
-       Module* GetIOHook(BufferedSocket* is);
+       void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
 
-       /** 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 BufferedSocket to attach to
-        * @return True if the hook was successful.
+       /** Validates an IP address value, throwing ConfigException if it is not valid
         */
-       bool AddIOHook(Module* iomod, BufferedSocket* is);
+       void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
 
-       /** Delete a module hook from an BufferedSocket.
-        * @param is The BufferedSocket to detatch from.
-        * @return True if the unhook was successful
+       /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
         */
-       bool DelIOHook(BufferedSocket* is);
+       void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
 
        /** Returns the fully qualified path to the inspircd directory
         * @return The full program directory
@@ -845,7 +920,11 @@ class CoreExport ServerConfig : public Extensible
         * @return True if the file exists and is readable.
         */
        static bool FileExists(const char* file);
-       
+
+       /** If this value is true, invites will bypass more than just +i
+        */
+       bool InvBypassModes;
+
 };
 
 /** Initialize the disabled commands list