-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
+ * Copyright (C) 2013-2014, 2016 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
+ * Copyright (C) 2012-2014, 2016-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
*
- * 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
-
-/* handy defines */
-/** Determines if a channel op is exempt from given mode m,
- * in config of server instance s.
- */
-#define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
+#pragma once
#include <sstream>
#include <string>
#include "modules.h"
#include "socketengine.h"
#include "socket.h"
+#include "token_list.h"
-/* Required forward definitions */
-class ServerConfig;
-class InspIRCd;
-class BufferedSocket;
-
-/** Types of data in the core config
- */
-enum ConfigDataType
-{
- DT_NOTHING = 0, /* No data */
- DT_INTEGER = 1, /* Integer */
- DT_CHARPTR = 2, /* Char pointer */
- DT_BOOLEAN = 3, /* Boolean */
- DT_HOSTNAME = 4, /* Hostname syntax */
- DT_NOSPACES = 5, /* No spaces */
- 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_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.
- * The callback function can then alter the values of the ValueItem
- * classes to validate the settings.
- */
-class ValueItem
-{
- /** Actual data */
- std::string v;
- public:
- /** Initialize with an int */
- ValueItem(int value);
- /** Initialize with a bool */
- ValueItem(bool value);
- /** Initialize with a char pointer */
- ValueItem(const char* value);
- /** Change value to a char pointer */
- void Set(const char* val);
- /** Change value to an int */
- void Set(int value);
- /** Get value as an int */
- int GetInteger();
- /** Get value as a string */
- char* GetString();
- /** Get value as a bool */
- bool GetBool();
-};
-
-/** The base class of the container 'ValueContainer'
- * used internally by the core to hold core values.
- */
-class ValueContainerBase
+/** Structure representing a single \<tag> in config */
+class CoreExport ConfigTag : public refcountbase
{
+ ConfigItems items;
public:
- /** Constructor */
- ValueContainerBase() { }
- /** Destructor */
- virtual ~ValueContainerBase() { }
-};
-
-/** ValueContainer is used to contain pointers to different
- * core values such as the server name, maximum number of
- * clients etc.
- * It is specialized to hold a data type, then pointed at
- * a value in the ServerConfig class. When the value has been
- * read and validated, the Set method is called to write the
- * value safely in a type-safe manner.
- */
-template<typename T> class ValueContainer : public ValueContainerBase
-{
- /** Contained item */
- T val;
- public:
-
- /** Initialize with nothing */
- ValueContainer()
- {
- val = NULL;
- }
-
- /** Initialize with a value of type T */
- ValueContainer(T Val)
- {
- val = Val;
- }
-
- /** Change value to type T of size s */
- void Set(T newval, size_t s)
- {
- memcpy(val, newval, s);
- }
+ 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, const TR1NS::function<bool(const std::string&)>& validator);
+ /** Get the value of an option, using def if it does not exist */
+ 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 */
+ 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);
+
+ /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
+ * using a default value if it does not exist or is out of bounds.
+ * @param key The config key name
+ * @param def Default value (optional)
+ * @param min Minimum acceptable value (optional)
+ * @param max Maximum acceptable value (optional)
+ * @return The duration in seconds
+ */
+ 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
+ * @param value The location to store the value (unmodified if does not exist)
+ * @param allow_newline Allow newlines in the option (normally replaced with spaces)
+ * @return true if the option exists
+ */
+ bool readString(const std::string& key, std::string& value, bool allow_newline = false);
+
+ std::string getTagLocation();
+
+ inline const ConfigItems& getItems() const { return 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);
};
-/** A specialization of ValueContainer to hold a pointer to a bool
- */
-typedef ValueContainer<bool*> ValueContainerBool;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an unsigned int
- */
-typedef ValueContainer<unsigned int*> ValueContainerUInt;
-
-/** A specialization of ValueContainer to hold a pointer to
- * a char array.
- */
-typedef ValueContainer<char*> ValueContainerChar;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an int
- */
-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;
-
-/** A callback for validating a single value
- */
-typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
-/** A callback for validating multiple value entries
- */
-typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
-/** A callback indicating the end of a group of entries
- */
-typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
-
-/** Holds a core configuration item and its callbacks
- */
-struct InitialConfig
-{
- /** Tag name */
- const char* tag;
- /** Value name */
- const char* value;
- /** Default, if not defined */
- const char* default_value;
- /** Value containers */
- ValueContainerBase* val;
- /** Data types */
- 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
- */
-struct MultiConfig
-{
- /** Tag name */
- const char* tag;
- /** One or more items within tag */
- const char* items[MAX_VALUES_PER_TAG];
- /** One or more defaults for items within tags */
- const char* items_default[MAX_VALUES_PER_TAG];
- /** One or more data types */
- int datatype[MAX_VALUES_PER_TAG];
- /** Initialization function */
- MultiNotify init_function;
- /** Validation function */
- MultiValidator validation_function;
- /** Completion function */
- MultiNotify finish_function;
-};
-
-/** A set of oper types
- */
-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, 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
+class ServerLimits
{
public:
+ /** Maximum line length */
+ size_t MaxLine;
/** Maximum nickname length */
size_t NickMax;
/** Maximum channel length */
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 hostname length */
+ size_t MaxHost;
- /** 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.
+ /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
+ * @param tag Configuration tag to read the limits from
*/
- ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
- {
- }
+ ServerLimits(ConfigTag* tag);
- /** 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++;
- }
+ /** Maximum length of a n!u\@h mask */
+ size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
};
-/** 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
- * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
- */
-class CoreExport ServerConfig : public Extensible
+struct CommandLineConf
{
- private:
- /** Creator/owner pointer
- */
- InspIRCd* ServerInstance;
-
- /** This variable holds the names of all
- * files included from the main one. This
- * is used to make sure that no files are
- * recursively included.
- */
- std::vector<std::string> include_stack;
-
- /** This private method processes one line of
- * configutation, appending errors to errorstream
- * and setting error if an error has occured.
- */
- 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);
-
- /** Process an include file directive
- */
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
-
- /** 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;
-
- /** Error stream, contains error output from any failed configuration parsing.
+ /** If this value is true, the owner of the
+ * server specified -nofork on the command
+ * line, causing the daemon to stay in the
+ * foreground.
*/
- std::ostringstream* errstr;
+ bool nofork;
- /** 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.
+ /** If this value if true then all log
+ * messages will be output, regardless of
+ * the level given in the config file.
+ * This is set with the -debug commandline
+ * option.
*/
- ConfigDataHash newconfig;
+ bool forcedebug;
- /** Set of included files. Do we use this any more?
+ /** If this is true then log output will be
+ * written to the logfile. This is the default.
+ * If you put -nolog on the commandline then
+ * the logfile will not be written.
+ * This is meant to be used in conjunction with
+ * -debug for debugging without filling up the
+ * hard disk.
*/
- 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 };
-
- /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
- Validator DNSServerValidator;
+ bool writelog;
- /** Returns the creator InspIRCd pointer
+ /** 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.
*/
- InspIRCd* GetInstance();
+ bool writepid;
- /** 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;
+ /* Whether the --runasroot option was specified at boot. */
+ bool runasroot;
- /** Length limits, see definition of ServerLimits class
- */
- ServerLimits Limits;
+ /** Saved argc from startup. */
+ int argc;
- /** Clones CIDR range for ipv4 (0-32)
- * Defaults to 32 (checks clones on all IPs seperately)
- */
- int c_ipv4_range;
+ /** Saved argv from startup. */
+ char** argv;
+};
- /** Clones CIDR range for ipv6 (0-128)
- * Defaults to 128 (checks on all IPs seperately)
- */
- int c_ipv6_range;
+class CoreExport OperInfo : public refcountbase
+{
+ public:
+ TokenList AllowedOperCommands;
+ TokenList AllowedPrivs;
- /** Max number of WhoWas entries per user.
- */
- int WhoWasGroupSize;
+ /** Allowed user modes from oper classes. */
+ std::bitset<64> AllowedUserModes;
- /** Max number of cumulative user-entries in WhoWas.
- * When max reached and added to, push out oldest entry FIFO style.
- */
- int WhoWasMaxGroups;
+ /** Allowed channel modes from oper classes. */
+ std::bitset<64> AllowedChanModes;
- /** Max seconds a user is kept in WhoWas before being pruned.
- */
- int WhoWasMaxKeep;
+ /** Allowed snomasks from oper classes. */
+ std::bitset<64> AllowedSnomasks;
- /** Both for set(g|u)id.
- */
- char SetUser[MAXBUF];
- char SetGroup[MAXBUF];
+ /** \<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 */
+ reference<ConfigTag> type_block;
+ /** \<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;
- /** Holds the server name of the local server
- * as defined by the administrator.
+ /** Creates a new OperInfo with the specified oper type name.
+ * @param Name The name of the oper type.
*/
- char ServerName[MAXBUF];
+ OperInfo(const std::string& Name);
- /** Notice to give to users when they are Xlined
- */
- char MoronBanner[MAXBUF];
-
- /* Holds the network name the local server
- * belongs to. This is an arbitary field defined
- * by the administrator.
- */
- char Network[MAXBUF];
+ /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
+ std::string getConfig(const std::string& key);
+ void init();
+};
- /** Holds the description of the local server
- * as defined by the administrator.
- */
- char ServerDesc[MAXBUF];
+/** 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
+ * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
+ */
+class CoreExport ServerConfig
+{
+ private:
+ void CrossCheckOperClassType();
+ void CrossCheckConnectBlocks(ServerConfig* current);
- /** Holds the admin's name, for output in
- * the /ADMIN command.
- */
- char AdminName[MAXBUF];
+ 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,
- /** Holds the email address of the admin,
- * for output in the /ADMIN command.
- */
- char AdminEmail[MAXBUF];
+ /** Restrict the actions of a banned user. */
+ BUT_RESTRICT_SILENT,
- /** Holds the admin's nickname, for output
- * in the /ADMIN command
- */
- char AdminNick[MAXBUF];
+ /** Restrict the actions of a banned user and notify them of their treatment. */
+ BUT_RESTRICT_NOTIFY
+ };
- /** The admin-configured /DIE password
- */
- char diepass[MAXBUF];
+ class ServerPaths
+ {
+ public:
+ /** Config path */
+ std::string Config;
- /** The admin-configured /RESTART password
- */
- char restartpass[MAXBUF];
+ /** Data path */
+ std::string Data;
- /** The hash method for *BOTH* the die and restart passwords.
- */
- char powerhash[MAXBUF];
+ /** Log path */
+ std::string Log;
- /** The pathname and filename of the message of the
- * day file, as defined by the administrator.
- */
- char motd[MAXBUF];
+ /** Module path */
+ std::string Module;
- /** The pathname and filename of the rules file,
- * as defined by the administrator.
- */
- char rules[MAXBUF];
+ ServerPaths(ConfigTag* tag);
- /** The quit prefix in use, or an empty string
- */
- char PrefixQuit[MAXBUF];
+ 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); }
+ std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
+ std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
+ };
- /** The quit suffix in use, or an empty string
+ /** Holds a complete list of all connect blocks
*/
- char SuffixQuit[MAXBUF];
+ typedef std::vector<reference<ConnectClass> > ClassVector;
- /** The fixed quit message in use, or an empty string
+ /** Index of valid oper blocks and types
*/
- char FixedQuit[MAXBUF];
+ typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
- /** The part prefix in use, or an empty string
+ /** Get a configuration tag by name. If one or more tags are present then the first is returned.
+ * @param tag The name of the tag to get.
+ * @returns Either a tag from the config or EmptyTag.
*/
- char PrefixPart[MAXBUF];
+ ConfigTag* ConfValue(const std::string& tag);
- /** The part suffix in use, or an empty string
+ /** Get a list of configuration tags by name.
+ * @param tag The name of the tags to get.
+ * @returns Either a list of tags from the config or an empty ConfigTagList.
*/
- char SuffixPart[MAXBUF];
+ ConfigTagList ConfTags(const std::string& tag);
- /** The fixed part message in use, or an empty string
- */
- char FixedPart[MAXBUF];
+ /** An empty configuration tag. */
+ ConfigTag* EmptyTag;
- /** The last string found within a <die> tag, or
- * an empty string.
+ /** Error stream, contains error output from any failed configuration parsing.
*/
- char DieValue[MAXBUF];
+ std::stringstream errstr;
- /** The DNS server to use for DNS queries
- */
- char DNSServer[MAXBUF];
+ /** True if this configuration is valid enough to run with */
+ bool valid;
- /** Pretend disabled commands don't exist.
- */
- bool DisabledDontExist;
+ /** Bind to IPv6 by default */
+ bool WildcardIPv6;
- /** This variable contains a space-seperated list
- * of commands which are disabled by the
- * administrator of the server for non-opers.
+ /** This holds all the information in the config file,
+ * it's indexed by tag name to a vector of key/values.
*/
- char DisabledCommands[MAXBUF];
+ ConfigDataHash config_data;
- /** This variable identifies which usermodes have been diabled.
+ /** This holds all extra files that have been read in the configuration
+ * (for example, MOTD and RULES files are stored here)
*/
+ ConfigFileCache Files;
- char DisabledUModes[64];
-
- /** This variable identifies which chanmodes have been disabled.
+ /** Length limits, see definition of ServerLimits class
*/
- char DisabledCModes[64];
+ ServerLimits Limits;
- /** The full path to the modules directory.
- * This is either set at compile time, or
- * overridden in the configuration file via
- * the <options> tag.
- */
- char ModPath[1024];
+ /** Locations of various types of file (config, module, etc). */
+ ServerPaths Paths;
- /** The full pathname to the executable, as
- * given in argv[0] when the program starts.
+ /** Configuration parsed from the command line.
*/
- char MyExecutable[1024];
+ CommandLineConf cmdline;
- /** The file handle of the logfile. If this
- * value is NULL, the log file is not open,
- * probably due to a permissions error on
- * startup (this should not happen in normal
- * operation!).
+ /** Clones CIDR range for ipv4 (0-32)
+ * Defaults to 32 (checks clones on all IPs separately)
*/
- FILE *log_file;
+ unsigned char c_ipv4_range;
- /** If this value is true, the owner of the
- * server specified -nofork on the command
- * line, causing the daemon to stay in the
- * foreground.
- */
- bool nofork;
-
- /** If this value if true then all log
- * messages will be output, regardless of
- * the level given in the config file.
- * This is set with the -debug commandline
- * option.
- */
- bool forcedebug;
-
- /** If this is true then log output will be
- * written to the logfile. This is the default.
- * If you put -nolog on the commandline then
- * the logfile will not be written.
- * This is meant to be used in conjunction with
- * -debug for debugging without filling up the
- * hard disk.
+ /** Clones CIDR range for ipv6 (0-128)
+ * Defaults to 128 (checks on all IPs separately)
*/
- bool writelog;
+ unsigned char c_ipv6_range;
- /** 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.
+ /** Holds the server name of the local server
+ * as defined by the administrator.
*/
- bool RestrictBannedUsers;
+ std::string ServerName;
- /** If this value is true, halfops have been
- * enabled in the configuration file.
+ /** Notice to give to users when they are banned by an XLine
*/
- bool AllowHalfop;
+ std::string XLineMessage;
- /** If this is set to true, then mode lists (e.g
- * MODE #chan b) are hidden from unprivileged
- * users.
+ /* Holds the network name the local server
+ * belongs to. This is an arbitrary field defined
+ * by the administrator.
*/
- bool HideModeLists[256];
+ std::string Network;
- /** If this is set to true, then channel operators
- * are exempt from this channel mode. Used for +Sc etc.
+ /** Holds the description of the local server
+ * as defined by the administrator.
*/
- bool ExemptChanOps[256];
+ std::string ServerDesc;
- /** 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
*/
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.
*/
unsigned int MaxTargets;
- /** The maximum number of /WHO results allowed
- * in any single /WHO command.
- */
- int MaxWhoResults;
-
- /** True if the DEBUG loglevel is selected.
- */
- int debugging;
-
- /** How many seconds to wait before exiting
- * the program when /DIE is correctly issued.
- */
- int DieDelay;
+ /** The number of seconds that the server clock can skip by before server operators are warned. */
+ time_t TimeSkipWarn;
- /** True if we're going to hide netsplits as *.net *.split for non-opers
- */
- bool HideSplits;
-
- /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
- * K-Lines, Z-Lines)
+ /** True if we're going to hide ban reasons for non-opers (e.g. G-lines,
+ * K-lines, Z-lines)
*/
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.
- */
- bool OperSpyWhois;
-
- /** Set to a non-empty string to obfuscate the server name of users in WHOIS
- */
- char HideWhoisServer[MAXBUF];
-
- /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
- */
- char HideKillsServer[MAXBUF];
+ /** True if raw I/O is being logged */
+ bool RawLog;
- /** The MOTD file, cached in a file_cache type.
- */
- file_cache MOTD;
-
- /** The RULES file, cached in a file_cache type.
- */
- file_cache RULES;
+ /** Set to a non-empty string to obfuscate server names. */
+ std::string HideServer;
/** The full pathname and filename of the PID
* file as defined in the configuration.
*/
- char PID[1024];
+ std::string PID;
/** The connect classes in use by the IRC server.
*/
ClassVector Classes;
- /** A list of the classes for listening ports
- */
- std::vector<ListenSocketBase *> ports;
-
- /** 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.
- */
- char UserStats[MAXBUF];
-
- /** The path and filename of the ircd.log file
- */
- std::string logpath;
-
/** Default channel modes
*/
- char DefaultModes[MAXBUF];
+ std::string DefaultModes;
/** Custom version string, which if defined can replace the system info in VERSION.
*/
- char CustomVersion[MAXBUF];
-
- /** List of u-lined servers
- */
- std::map<irc::string, bool> ulines;
-
- /** Max banlist sizes for channels (the std::string is a glob)
- */
- std::map<std::string, int> maxbans;
-
- /** Directory where the inspircd binary resides
- */
- std::string MyDir;
-
- /** If set to true, no user DNS lookups are to be performed
- */
- bool NoUserDns;
+ std::string CustomVersion;
/** 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.
+ /** The name of the casemapping method used by this server.
*/
- bool CycleHosts;
+ std::string CaseMapping;
- /** 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;
- /** All oper type definitions from the config file
- */
- opertype_t opertypes;
-
- /** All oper class definitions from the config file
+ /** Oper blocks keyed by their name
*/
- operclass_t operclass;
+ OperIndex oper_blocks;
- /** Saved argv from startup
+ /** Oper types keyed by their name
*/
- char** argv;
-
- /** Saved argc from startup
- */
- int argc;
+ OperIndex OperTypes;
- /** Max channels per user
+ /** Default value for <connect:maxchans>, deprecated in 3.0
*/
unsigned int MaxChans;
- /** Oper max channels per user
+ /** Default value for <oper:maxchans>, deprecated in 3.0
*/
unsigned int OperMaxChans;
* makes code simpler. 0AA, 1BB etc with letters are reserved
* for services use.
*/
- char sid[MAXBUF];
-
- /** True if we have been told to run the testsuite from the commandline,
- * rather than entering the mainloop.
- */
- bool TestSuite;
+ std::string sid;
/** Construct a new ServerConfig
*/
- ServerConfig(InspIRCd* Instance);
+ ServerConfig();
- /** Clears the include stack in preperation for a Read() call.
- */
- void ClearStack();
+ ~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
* should be used only by the core.
*/
- 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 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, 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, 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, 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);
-
- /** 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);
-
- /** 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);
-
- /** 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);
-
- /** Returns the number of occurences of tag in the config file
- */
- int ConfValueEnum(ConfigDataHash &target, const char* tag);
- /** Returns the number of occurences of tag in the config file
- */
- int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
-
- /** Returns the numbers of vars inside the index'th 'tag in the config file
- */
- int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
- /** Returns the numbers of vars inside the index'th 'tag in the config file
- */
- int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
-
- /** Validates a hostname value, throwing ConfigException if it is not valid
- */
- void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
-
- /** Validates an IP address value, throwing ConfigException if it is not valid
- */
- void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
+ void Read();
- /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
+ /** Apply configuration changes from the old configuration.
*/
- void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
+ void Apply(ServerConfig* old, const std::string &useruid);
+ void ApplyModules(User* user);
- /** Returns the fully qualified path to the inspircd directory
- * @return The full program directory
- */
- std::string GetFullProgDir();
-
- /** Returns true if a directory is valid (within the modules directory).
- * @param dirandfile The directory and filename to check
- * @return True if the directory is valid
- */
- static bool DirValid(const char* dirandfile);
+ void Fill();
- /** Clean a filename, stripping the directories (and drives) from string.
- * @param name Directory to tidy
- * @return The cleaned filename
+ /** 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 char* CleanFilename(char* name);
+ static std::string Escape(const std::string& str, bool xml = true);
- /** Check if a file exists.
- * @param file The full path to a file
- * @return True if the file exists and is readable.
+ /** If this value is true, snotices will not stack when repeats are sent
*/
- static bool FileExists(const char* file);
-
- /** If this value is true, invites will bypass more than just +i
- */
- bool InvBypassModes;
-
+ bool NoSnoticeStack;
};
-/** Initialize the disabled commands list
- */
-CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
-
-/** Initialize the oper types
+/** The background thread for config reading, so that reading from executable includes
+ * does not block.
*/
-bool InitTypes(ServerConfig* conf, const char* tag);
-
-/** Initialize the oper classes
- */
-bool InitClasses(ServerConfig* conf, const char* tag);
-
-/** Initialize an oper type
- */
-bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Initialize an oper class
- */
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Finish initializing the oper types and classes
- */
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
-
-
-
-/** Initialize x line
- */
-bool InitXLine(ServerConfig* conf, const char* tag);
-
-/** Add a config-defined zline
- */
-bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined qline
- */
-bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined kline
- */
-bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined eline
- */
-bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+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() CXX11_OVERRIDE;
+ /** Run in the main thread to apply the configuration */
+ void Finish();
+ bool IsDone() { return done; }
+};
+/** Represents the status of a config load. */
+class CoreExport ConfigStatus
+{
+ public:
+ /** Whether this is the initial config load. */
+ bool const initial;
-#endif
+ /** The user who initiated the config load or NULL if not initiated by a user. */
+ User* const srcuser;
+ /** Initializes a new instance of the ConfigStatus class.
+ * @param user The user who initiated the config load or NULL if not initiated by a user.
+ * @param isinitial Whether this is the initial config load.
+ */
+ ConfigStatus(User* user = NULL, bool isinitial = false)
+ : initial(isinitial)
+ , srcuser(user)
+ {
+ }
+};
projects / user / henk / code / inspircd.git / blobdiff