]> 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 fb187048b3f6a2030af6a96bf45ceebde33a212b..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"
@@ -49,9 +48,14 @@ enum ConfigDataType
        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_ALLOW_NEWLINE = 128,         /* New line characters allowed in DT_CHARPTR */
+       DT_BOOTONLY      = 256          /* Can only be set on startup, not on rehash */
 };
 
+/** 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.
@@ -68,10 +72,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);
@@ -147,6 +149,11 @@ 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
  */
 typedef std::deque<ValueItem> ValueList;
@@ -166,19 +173,34 @@ 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;
 };
 
+/** 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
  */
@@ -187,11 +209,11 @@ struct MultiConfig
        /** Tag name */
        const char*     tag;
        /** One or more items within tag */
-       char*           items[18];
+       const char*     items[MAX_VALUES_PER_TAG];
        /** One or more defaults for items within tags */
-       char*           items_default[18];
+       const char* items_default[MAX_VALUES_PER_TAG];
        /** One or more data types */
-       int             datatype[18];
+       int             datatype[MAX_VALUES_PER_TAG];
        /** Initialization function */
        MultiNotify     init_function;
        /** Validation function */
@@ -204,10 +226,79 @@ struct MultiConfig
  */
 typedef std::map<irc::string,char*> opertype_t;
 
+/** Holds an oper class.
+ */
+struct operclass_data : public Extensible
+{
+       /** 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,char*> operclass_t;
+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
+        * as in 1.1's ./configure script. Reading other values
+        * from the config will change these values.
+        */
+       ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
+       {
+       }
+
+       /** 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++;
+               IdentMax++;
+               MaxQuit++;
+               MaxTopic++;
+               MaxKick++;
+               MaxGecos++;
+               MaxAway++;
+       }
+};
 
 /** This class holds the bulk of the runtime configuration for the ircd.
  * It allows for reading new config values, accessing configuration files,
@@ -232,28 +323,42 @@ 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, int pass, std::istream* scan_for_includes_only);
-  
-       /** Process an include directive
-        */
-       bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream, int pass, std::istream* scan_for_includes_only);
+       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(char* tag);
+       bool CheckOnce(const char* tag, ConfigDataHash &newconf);
 
  public:
+       /** Process an include executable directive
+        */
+       bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 
-       std::ostringstream errstr;
+       /** Process an include file directive
+        */
+       bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
 
-       ConfigDataHash newconfig;
+       /** 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;
 
-       std::map<std::string, std::istream*> IncludedFiles;
+       /** Rehash parameter, as above
+        */
+       std::string RehashParameter;
+
+       /** Error stream, contains error output from any failed configuration parsing.
+        */
+       std::ostringstream* errstr;
 
-       std::map<std::string, bool> CompletedFiles;
+       /** 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;
 
-       size_t TotalDownloaded;
-       size_t FileErrors;
+       /** 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 */
        enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
@@ -261,15 +366,33 @@ 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();
 
-       void DoDownloads();
+       /** 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,
         * it's indexed by tag name to a vector of key/values.
         */
        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;
@@ -283,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.
         */
@@ -373,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
@@ -424,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.
         */
@@ -476,10 +622,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.
         */
@@ -528,15 +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;
-
-       /** A list of ports claimed by IO Modules
-        */
-       std::map<int,Module*> IOHookModule;
-
-       std::map<BufferedSocket*, Module*> SocketIOHookModule;
+       std::vector<ListenSocketBase *> ports;
 
        /** The 005 tokens of this server (ISUPPORT)
         * populated/repopulated upon loading or unloading
@@ -631,6 +767,11 @@ class CoreExport ServerConfig : public Extensible
         */
        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);
@@ -655,35 +796,38 @@ 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, int pass);
+       void Read(bool bail, const std::string &useruid);
 
        /** Read a file into a file_cache object
         */
        bool ReadFile(file_cache &F, const char* fname);
 
+       /* Returns true if the given string starts with a windows drive letter
+        */
+       bool StartsWithWindowsDriveLetter(const std::string &path);
+
        /** 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.
         */
-       bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream, int pass, std::istream* scan_for_includs_only);
+       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, int pass, std::istream* scan_for_includs_only = NULL);
-       
-       /* Both these return true if the value existed or false otherwise */
+       bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
        
        /** 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);
@@ -691,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);
@@ -698,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);
@@ -711,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);
@@ -735,51 +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 port.
-        * @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(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);
-
-       /** 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 BufferedSocket class.
-        * @parameter port Port number
-        * @return Returns a pointer to the hooking module, or NULL
-        */
-       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
@@ -803,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