]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Replace most usages of "GECOS" with "real" or "real name".
[user/henk/code/inspircd.git] / include / configreader.h
index 005d4a37db8cdd4d7c5c5f0ebe385107465186c6..81ec014a029e60c9919f92ecc5bf4bb13c07186c 100644 (file)
 #include "modules.h"
 #include "socketengine.h"
 #include "socket.h"
+#include "token_list.h"
 
 /** Structure representing a single \<tag> in config */
 class CoreExport ConfigTag : public refcountbase
 {
-       std::vector<KeyVal> items;
+       ConfigItems items;
  public:
        const std::string tag;
        const std::string src_name;
        const int src_line;
 
        /** Get the value of an option, using def if it does not exist */
-       std::string getString(const std::string& key, const std::string& def = "");
+       std::string getString(const std::string& key, const std::string& def, const TR1NS::function<bool(const std::string&)>& validator);
        /** Get the value of an option, using def if it does not exist */
-       long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
+       std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
        /** Get the value of an option, using def if it does not exist */
-       double getFloat(const std::string& key, double def = 0);
+       long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
+       /** Get the value of an option, using def if it does not exist */
+       unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
+       /** Get the value of an option, using def if it does not exist */
+       double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX);
        /** Get the value of an option, using def if it does not exist */
        bool getBool(const std::string& key, bool def = false);
 
@@ -58,7 +63,7 @@ class CoreExport ConfigTag : public refcountbase
         * @param max Maximum acceptable value (optional)
         * @return The duration in seconds
         */
-       long getDuration(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
+       unsigned long getDuration(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
 
        /** Get the value of an option
         * @param key The option to get
@@ -68,22 +73,12 @@ class CoreExport ConfigTag : public refcountbase
         */
        bool readString(const std::string& key, std::string& value, bool allow_newline = false);
 
-       /** Check for an out of range value. If the value falls outside the boundaries a warning is
-        * logged and the value is corrected (set to def).
-        * @param key The key name, used in the warning message
-        * @param res The value to verify and modify if needed
-        * @param def The default value, res will be set to this if (min <= res <= max) doesn't hold true
-        * @param min Minimum accepted value for res
-        * @param max Maximum accepted value for res
-        */
-       void CheckRange(const std::string& key, long& res, long def, long min, long max);
-
        std::string getTagLocation();
 
-       inline const std::vector<KeyVal>& getItems() const { return items; }
+       inline const ConfigItems& getItems() const { return items; }
 
-       /** Create a new ConfigTag, giving access to the private KeyVal item list */
-       static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector<KeyVal>*& Items);
+       /** Create a new ConfigTag, giving access to the private ConfigItems item list */
+       static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
  private:
        ConfigTag(const std::string& Tag, const std::string& file, int line);
 };
@@ -108,8 +103,8 @@ class ServerLimits
        size_t MaxTopic;
        /** Maximum kick message length */
        size_t MaxKick;
-       /** Maximum GECOS (real name) length */
-       size_t MaxGecos;
+       /** Maximum real name length */
+       size_t MaxReal;
        /** Maximum away message length */
        size_t MaxAway;
        /** Maximum line length */
@@ -122,7 +117,7 @@ class ServerLimits
         */
        ServerLimits(ConfigTag* tag);
 
-       /** Maximum length of a n!u@h mask */
+       /** Maximum length of a n!u\@h mask */
        size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
 };
 
@@ -153,6 +148,18 @@ struct CommandLineConf
         */
        bool writelog;
 
+       /** If this is true, a PID file will be written
+        * to the file given in the "file" variable of
+        * the <pid> tag in the config file. This is
+        * the default.
+        * Passing --nopid as a command line argument
+        * sets this to false; in this case, a PID file
+        * will not be written, even the default PID
+        * file that is usually written when the <pid>
+        * tag is not defined in the config file.
+        */
+       bool writepid;
+
        /** Saved argc from startup
         */
        int argc;
@@ -165,9 +172,8 @@ struct CommandLineConf
 class CoreExport OperInfo : public refcountbase
 {
  public:
-       typedef insp::flat_set<std::string> PrivSet;
-       PrivSet AllowedOperCommands;
-       PrivSet AllowedPrivs;
+       TokenList AllowedOperCommands;
+       TokenList AllowedPrivs;
 
        /** Allowed user modes from oper classes. */
        std::bitset<64> AllowedUserModes;
@@ -184,6 +190,11 @@ class CoreExport OperInfo : public refcountbase
        /** Name of the oper type; i.e. the one shown in WHOIS */
        std::string name;
 
+       /** Creates a new OperInfo with the specified oper type name.
+        * @param Name The name of the oper type.
+        */
+       OperInfo(const std::string& Name);
+
        /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
        std::string getConfig(const std::string& key);
        void init();
@@ -201,6 +212,19 @@ class CoreExport ServerConfig
        void CrossCheckConnectBlocks(ServerConfig* current);
 
  public:
+       /** How to treat a user in a channel who is banned. */
+       enum BannedUserTreatment
+       {
+               /** Don't treat a banned user any different to normal. */
+               BUT_NORMAL,
+
+               /** Restrict the actions of a banned user. */
+               BUT_RESTRICT_SILENT,
+
+               /** Restrict the actions of a banned user and notify them of their treatment. */
+               BUT_RESTRICT_NOTIFY
+       };
+
        class ServerPaths
        {
         public:
@@ -216,11 +240,7 @@ class CoreExport ServerConfig
                /** Module path */
                std::string Module;
 
-               ServerPaths()
-                       : Config(INSPIRCD_CONFIG_PATH)
-                       , Data(INSPIRCD_DATA_PATH)
-                       , Log(INSPIRCD_LOG_PATH)
-                       , Module(INSPIRCD_MODULE_PATH) { }
+               ServerPaths(ConfigTag* tag);
 
                std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
                std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
@@ -256,11 +276,7 @@ class CoreExport ServerConfig
        /** Bind to IPv6 by default */
        bool WildcardIPv6;
 
-       /** 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 };
-       enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
-
-       /** This holds all the information in the config file,
+       /** This holds all the information in the config file,
         * it's indexed by tag name to a vector of key/values.
         */
        ConfigDataHash config_data;
@@ -284,12 +300,12 @@ class CoreExport ServerConfig
        /** Clones CIDR range for ipv4 (0-32)
         * Defaults to 32 (checks clones on all IPs seperately)
         */
-       int c_ipv4_range;
+       unsigned char c_ipv4_range;
 
        /** Clones CIDR range for ipv6 (0-128)
         * Defaults to 128 (checks on all IPs seperately)
         */
-       int c_ipv6_range;
+       unsigned char c_ipv6_range;
 
        /** Holds the server name of the local server
         * as defined by the administrator.
@@ -315,19 +331,13 @@ class CoreExport ServerConfig
         */
        bool DisabledDontExist;
 
-       /** This variable contains a space-seperated list
-        * of commands which are disabled by the
-        * administrator of the server for non-opers.
-        */
-       std::string DisabledCommands;
-
        /** This variable identifies which usermodes have been diabled.
         */
-       char DisabledUModes[64];
+       std::bitset<64> DisabledUModes;
 
        /** This variable identifies which chanmodes have been disabled.
         */
-       char DisabledCModes[64];
+       std::bitset<64> DisabledCModes;
 
        /** If set to true, then all opers on this server are
         * shown with a generic 'is an IRC operator' line rather
@@ -335,15 +345,8 @@ class CoreExport ServerConfig
         */
        bool GenericOper;
 
-       /** 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;
-
-       /** The number of seconds the DNS subsystem
-        * will wait before timing out any request.
-        */
-       int dns_timeout;
+       /** How to treat a user in a channel who is banned. */
+       BannedUserTreatment RestrictBannedUsers;
 
        /** The size of the read() buffer in the user
         * handling code, used to read data into a user's
@@ -383,21 +386,11 @@ class CoreExport ServerConfig
         */
        bool HideBans;
 
-       /** Announce invites to the channel with a server notice
-        */
-       InviteAnnounceState AnnounceInvites;
-
-       /** If this is enabled then operators will
-        * see invisible (+i) channels in /whois.
-        */
-       OperSpyWhoisState OperSpyWhois;
-
        /** True if raw I/O is being logged */
        bool RawLog;
 
-       /** Set to a non-empty string to obfuscate the server name of users in WHOIS
-        */
-       std::string HideWhoisServer;
+       /** Set to a non-empty string to obfuscate server names. */
+       std::string HideServer;
 
        /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
         */
@@ -433,6 +426,10 @@ class CoreExport ServerConfig
         */
        bool SyntaxHints;
 
+       /** The name of the casemapping method used by this server.
+        */
+       std::string CaseMapping;
+
        /** If set to true, the CycleHosts mode change will be sourced from the user,
         * rather than the server
         */
@@ -489,7 +486,8 @@ class CoreExport ServerConfig
 
        void Fill();
 
-       bool ApplyDisabledCommands(const std::string& data);
+       /** Disables the commands specified in <disabled:commands>. */
+       bool ApplyDisabledCommands();
 
        /** Escapes a value for storage in a configuration key.
         * @param str The string to escape.
@@ -521,7 +519,7 @@ class CoreExport ConfigReaderThread : public Thread
                delete Config;
        }
 
-       void Run();
+       void Run() CXX11_OVERRIDE;
        /** Run in the main thread to apply the configuration */
        void Finish();
        bool IsDone() { return done; }