]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Rename <options:moronbanner> to <options:xlinemessage>.
[user/henk/code/inspircd.git] / include / configreader.h
index 54d9f7053d41b329102500bfe7192e66a7b30088..0d514e41d3d12a37013bf8e5d07d5d41fd17f834 100644 (file)
@@ -1,18 +1,27 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef INSPIRCD_CONFIGREADER
-#define INSPIRCD_CONFIGREADER
+
+#pragma once
 
 #include <sstream>
 #include <string>
 #include "socketengine.h"
 #include "socket.h"
 
-/* Required forward definitions */
-class ServerConfig;
-class ServerLimits;
-class InspIRCd;
-class BufferedSocket;
-
-/** A cached text file stored with its contents as lines
- */
-typedef std::vector<std::string> file_cache;
-
-/** A configuration key and value pair
- */
-typedef std::pair<std::string, std::string> KeyVal;
-
-/** Structure representing a single <tag> in config */
+/** Structure representing a single \<tag> in config */
 class CoreExport ConfigTag : public refcountbase
 {
        std::vector<KeyVal> items;
@@ -49,7 +44,7 @@ class CoreExport ConfigTag : public refcountbase
        /** Get the value of an option, using def if it does not exist */
        std::string getString(const std::string& key, const std::string& def = "");
        /** Get the value of an option, using def if it does not exist */
-       long getInt(const std::string& key, long def = 0);
+       long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
        /** Get the value of an option, using def if it does not exist */
        double getFloat(const std::string& key, double def = 0);
        /** Get the value of an option, using def if it does not exist */
@@ -65,6 +60,8 @@ class CoreExport ConfigTag : public refcountbase
 
        std::string getTagLocation();
 
+       inline const std::vector<KeyVal>& 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);
@@ -72,10 +69,6 @@ class CoreExport ConfigTag : public refcountbase
        ConfigTag(const std::string& Tag, const std::string& file, int line);
 };
 
-/** An entire config file, built up of KeyValLists
- */
-typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
-
 /** Defines the server's length limits on various length-limited
  * items such as topics, nicknames, channel names etc.
  */
@@ -100,29 +93,16 @@ class ServerLimits
        size_t MaxGecos;
        /** Maximum away message length */
        size_t MaxAway;
+       /** Maximum line length */
+       size_t MaxLine;
 
        /** 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++;
-       }
+       ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12),
+               MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200),
+               MaxLine(512) { }
 };
 
 struct CommandLineConf
@@ -164,8 +144,6 @@ struct CommandLineConf
        /** Saved argv from startup
         */
        char** argv;
-
-       std::string startup_log;
 };
 
 class CoreExport OperInfo : public refcountbase
@@ -180,11 +158,11 @@ class CoreExport OperInfo : public refcountbase
        /** Allowed channel modes from oper classes. */
        std::bitset<64> AllowedChanModes;
 
-       /** <oper> block used for this oper-up. May be NULL. */
+       /** \<oper> block used for this oper-up. May be NULL. */
        reference<ConfigTag> oper_block;
-       /** <type> block used for this oper-up. Valid for local users, may be NULL on remote */
+       /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
        reference<ConfigTag> type_block;
-       /** <class> blocks referenced from the <type> block. These define individual permissions */
+       /** \<class> blocks referenced from the \<type> block. These define individual permissions */
        std::vector<reference<ConfigTag> > class_blocks;
        /** Name of the oper type; i.e. the one shown in WHOIS */
        std::string name;
@@ -192,18 +170,8 @@ class CoreExport OperInfo : public refcountbase
        /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
        std::string getConfig(const std::string& key);
        void init();
-
-       inline const char* NameStr()
-       {
-               return irc::Spacify(name.c_str());
-       }
 };
 
-typedef std::map<std::string, reference<ConfigTag> > TagIndex;
-typedef std::map<std::string, reference<OperInfo> > OperIndex;
-typedef ConfigDataHash::iterator ConfigIter;
-typedef std::pair<ConfigDataHash::iterator, ConfigDataHash::iterator> ConfigTagList;
-
 /** This class holds the bulk of the runtime configuration for the ircd.
  * It allows for reading new config values, accessing configuration files,
  * and storage of the configuration data needed to run the ircd, such as
@@ -219,7 +187,6 @@ class CoreExport ServerConfig
 
        /** Get a configuration tag
         * @param tag The name of the tag to get
-        * @param offset get the Nth occurance of the tag
         */
        ConfigTag* ConfValue(const std::string& tag);
 
@@ -232,14 +199,23 @@ class CoreExport ServerConfig
        /** True if this configuration is valid enough to run with */
        bool valid;
 
+       /** 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,
         * it's indexed by tag name to a vector of key/values.
         */
        ConfigDataHash config_data;
 
+       /** This holds all extra files that have been read in the configuration
+        * (for example, MOTD and RULES files are stored here)
+        */
+       ConfigFileCache Files;
+
        /** Length limits, see definition of ServerLimits class
         */
        ServerLimits Limits;
@@ -258,27 +234,14 @@ class CoreExport ServerConfig
         */
        int c_ipv6_range;
 
-       /** 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.
         */
        std::string ServerName;
 
-       /** Notice to give to users when they are Xlined
+       /** Notice to give to users when they are banned by an XLine
         */
-       std::string MoronBanner;
+       std::string XLineMessage;
 
        /* Holds the network name the local server
         * belongs to. This is an arbitary field defined
@@ -352,15 +315,6 @@ class CoreExport ServerConfig
         */
        std::string FixedPart;
 
-       /** The last string found within a <die> tag, or
-        * an empty string.
-        */
-       std::string DieValue;
-
-       /** The DNS server to use for DNS queries
-        */
-       std::string DNSServer;
-
        /** Pretend disabled commands don't exist.
         */
        bool DisabledDontExist;
@@ -382,7 +336,7 @@ class CoreExport ServerConfig
        /** The full path to the modules directory.
         * This is either set at compile time, or
         * overridden in the configuration file via
-        * the <path> tag.
+        * the \<path> tag.
         */
        std::string ModPath;
 
@@ -397,13 +351,8 @@ class CoreExport ServerConfig
         */
        bool RestrictBannedUsers;
 
-       /** If this value is true, halfops have been
-        * enabled in the configuration file.
-        */
-       bool AllowHalfop;
-
        /** If this is set to true, then mode lists (e.g
-        * MODE #chan b) are hidden from unprivileged
+        * MODE \#chan b) are hidden from unprivileged
         * users.
         */
        bool HideModeLists[256];
@@ -424,6 +373,13 @@ class CoreExport ServerConfig
         */
        int MaxConn;
 
+       /** If we should check for clones during CheckClass() in AddUser()
+        * Setting this to false allows to not trigger on maxclones for users
+        * that may belong to another class after DNS-lookup is complete.
+        * It does, however, make the server spend more time on users we may potentially not want.
+        */
+       bool CCOnConnect;
+
        /** The soft limit value assigned to the irc server.
         * The IRC server will not allow more than this
         * number of local users.
@@ -435,16 +391,6 @@ class CoreExport ServerConfig
         */
        unsigned int MaxTargets;
 
-       /** The maximum number of /WHO results allowed
-        * in any single /WHO command.
-        */
-       int MaxWhoResults;
-
-       /** How many seconds to wait before exiting
-        * the program when /DIE is correctly issued.
-        */
-       int DieDelay;
-
        /** True if we're going to hide netsplits as *.net *.split for non-opers
         */
        bool HideSplits;
@@ -461,7 +407,10 @@ class CoreExport ServerConfig
        /** If this is enabled then operators will
         * see invisible (+i) channels in /whois.
         */
-       bool OperSpyWhois;
+       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
         */
@@ -471,14 +420,6 @@ class CoreExport ServerConfig
         */
        std::string HideKillsServer;
 
-       /** The MOTD file, cached in a file_cache type.
-        */
-       file_cache MOTD;
-
-       /** The RULES file, cached in a file_cache type.
-        */
-       file_cache RULES;
-
        /** The full pathname and filename of the PID
         * file as defined in the configuration.
         */
@@ -488,16 +429,6 @@ class CoreExport ServerConfig
         */
        ClassVector Classes;
 
-       /** The 005 tokens of this server (ISUPPORT)
-        * populated/repopulated upon loading or unloading
-        * modules.
-        */
-       std::string data005;
-
-       /** isupport strings
-        */
-       std::vector<std::string> isupport;
-
        /** STATS characters in this list are available
         * only to operators.
         */
@@ -515,29 +446,21 @@ class CoreExport ServerConfig
         */
        std::map<irc::string, bool> ulines;
 
-       /** Max banlist sizes for channels (the std::string is a glob)
-        */
-       std::map<std::string, int> maxbans;
-
-       /** If set to true, no user DNS lookups are to be performed
-        */
-       bool NoUserDns;
-
        /** If set to true, provide syntax hints for unknown commands
         */
        bool SyntaxHints;
 
-       /** If set to true, users appear to quit then rejoin when their hosts change.
-        * This keeps clients synchronized properly.
+       /** If set to true, the CycleHosts mode change will be sourced from the user,
+        * rather than the server
         */
-       bool CycleHosts;
+       bool CycleHostsFromUser;
 
        /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
         *  added to the outgoing text for undernet style msg prefixing.
         */
        bool UndernetMsgPrefix;
 
-       /** If set to true, the full nick!user@host will be shown in the TOPIC command
+       /** If set to true, the full nick!user\@host will be shown in the TOPIC command
         * for who set the topic last. If false, only the nick is shown.
         */
        bool FullHostInTopic;
@@ -568,15 +491,7 @@ class CoreExport ServerConfig
 
        /** Get server ID as string with required leading zeroes
         */
-       std::string GetSID();
-
-       /** Update the 005 vector
-        */
-       void Update005();
-
-       /** Send the 005 numerics (ISUPPORT) to a user
-        */
-       void Send005(User* user);
+       const std::string& GetSID() const { return sid; }
 
        /** Read the entire configuration into memory
         * and initialize this class. All other methods
@@ -591,11 +506,7 @@ class CoreExport ServerConfig
 
        void Fill();
 
-       /** Read a file into a file_cache object
-        */
-       bool ReadFile(file_cache &F, const std::string& fname);
-
-       /* Returns true if the given string starts with a windows drive letter
+       /** Returns true if the given string starts with a windows drive letter
         */
        bool StartsWithWindowsDriveLetter(const std::string &path);
 
@@ -612,11 +523,43 @@ class CoreExport ServerConfig
         * @return True if the file exists and is readable.
         */
        static bool FileExists(const char* file);
+       
+       /** Escapes a value for storage in a configuration key.
+        * @param str The string to escape.
+        * @param xml Are we using the XML config format?
+        */
+       static std::string Escape(const std::string& str, bool xml = true);
 
        /** If this value is true, invites will bypass more than just +i
         */
        bool InvBypassModes;
 
+       /** If this value is true, snotices will not stack when repeats are sent
+        */
+       bool NoSnoticeStack;
 };
 
-#endif
+/** The background thread for config reading, so that reading from executable includes
+ * does not block.
+ */
+class CoreExport ConfigReaderThread : public Thread
+{
+       ServerConfig* Config;
+       volatile bool done;
+ public:
+       const std::string TheUserUID;
+       ConfigReaderThread(const std::string &useruid)
+               : Config(new ServerConfig), done(false), TheUserUID(useruid)
+       {
+       }
+
+       virtual ~ConfigReaderThread()
+       {
+               delete Config;
+       }
+
+       void Run();
+       /** Run in the main thread to apply the configuration */
+       void Finish();
+       bool IsDone() { return done; }
+};