]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/configreader.h
Merge pull request #1018 from SaberUK/insp20+hidekills
[user/henk/code/inspircd.git] / include / configreader.h
index 54d9f7053d41b329102500bfe7192e66a7b30088..b01a979a7c2703384bb17155e52688370af0d3df 100644 (file)
@@ -1,16 +1,26 @@
-/*       +------------------------------------+
- *       | 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
 
 #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;
@@ -65,17 +61,14 @@ 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);
+       static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector<KeyVal>*& Items);
  private:
        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.
  */
@@ -108,21 +101,6 @@ class ServerLimits
        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++;
-       }
 };
 
 struct CommandLineConf
@@ -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;
@@ -199,11 +177,6 @@ class CoreExport OperInfo : public refcountbase
        }
 };
 
-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,12 +192,14 @@ 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);
 
        ConfigTagList ConfTags(const std::string& tag);
 
+       /** An empty configuration tag. */
+       ConfigTag* EmptyTag;
+
        /** Error stream, contains error output from any failed configuration parsing.
         */
        std::stringstream errstr;
@@ -232,14 +207,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;
@@ -352,11 +336,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;
@@ -382,7 +361,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 +376,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];
@@ -435,16 +409,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 +425,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 +438,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.
         */
@@ -532,12 +491,17 @@ class CoreExport ServerConfig
         */
        bool CycleHosts;
 
+       /** If set to true, the CycleHosts mode change will be sourced from the user,
+        * rather than the server
+        */
+       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;
@@ -566,9 +530,11 @@ class CoreExport ServerConfig
         */
        ServerConfig();
 
+       ~ServerConfig();
+
        /** Get server ID as string with required leading zeroes
         */
-       std::string GetSID();
+       const std::string& GetSID();
 
        /** Update the 005 vector
         */
@@ -591,11 +557,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);
 
@@ -617,6 +579,39 @@ class CoreExport ServerConfig
         */
        bool InvBypassModes;
 
+       /** If this value is true, snotices will not stack when repeats are sent
+        */
+       bool NoSnoticeStack;
+
+       /** If true, a "Welcome to <networkname>!" NOTICE will be sent to
+        * connecting users
+        */
+       bool WelcomeNotice;
+};
+
+/** 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; }
 };
 
 #endif