-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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
-
-/* 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 <vector>
#include <map>
#include "inspircd.h"
-#include "globals.h"
#include "modules.h"
#include "socketengine.h"
#include "socket.h"
-/* Required forward definitions */
-class ServerConfig;
-class InspIRCd;
-class InspSocket;
-
-/** Types of data in the core config
- */
-enum ConfigDataType
+/** Structure representing a single \<tag> in config */
+class CoreExport ConfigTag : public refcountbase
{
- DT_NOTHING = 0, /* No data */
- DT_INTEGER = 1, /* Integer */
- DT_CHARPTR = 2, /* Char pointer */
- DT_BOOLEAN = 3, /* Boolean */
- DT_ALLOW_NEWLINE = 128 /* New line characters allowed */
-};
-
-/** 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;
+ std::vector<KeyVal> items;
public:
- /** Initialize with an int */
- ValueItem(int value);
- /** Initialize with a bool */
- ValueItem(bool value);
- /** Initialize with a char pointer */
- ValueItem(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);
- /** Get value as an int */
- int GetInteger();
- /** Get value as a string */
- char* GetString();
- /** Get value as a bool */
- bool GetBool();
+ 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 = "");
+ /** 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);
+ /** 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 */
+ 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
+ */
+ long getDuration(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_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);
+
+ /** 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; }
+
+ /** 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);
+ private:
+ ConfigTag(const std::string& Tag, const std::string& file, int line);
};
-/** The base class of the container 'ValueContainer'
- * used internally by the core to hold core values.
+/** Defines the server's length limits on various length-limited
+ * items such as topics, nicknames, channel names etc.
*/
-class ValueContainerBase
+class ServerLimits
{
public:
- /** Constructor */
- ValueContainerBase() { }
- /** Destructor */
- virtual ~ValueContainerBase() { }
+ /** 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;
+ /** Maximum line length */
+ size_t MaxLine;
+ /** Maximum hostname length */
+ size_t MaxHost;
+
+ /** 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(ConfigTag* tag);
+
+ /** Maximum length of a n!u@h mask */
+ size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
};
-/** 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
+struct CommandLineConf
{
- /** 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);
- }
-};
-
-/** 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;
+ /** 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;
-/** A specialization of ValueContainer to hold a pointer to
- * an int
- */
-typedef ValueContainer<int*> ValueContainerInt;
+ /** 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;
-/** A set of ValueItems used by multi-value validator functions
- */
-typedef std::deque<ValueItem> ValueList;
+ /** 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.
+ */
+ bool writelog;
-/** 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*);
+ /** Saved argc from startup
+ */
+ int argc;
-/** Holds a core configuration item and its callbacks
- */
-struct InitialConfig
-{
- /** Tag name */
- char* tag;
- /** Value name */
- char* value;
- /** Default, if not defined */
- char* default_value;
- /** Value containers */
- ValueContainerBase* val;
- /** Data types */
- ConfigDataType datatype;
- /** Validation function */
- Validator validation_function;
+ /** Saved argv from startup
+ */
+ char** argv;
};
-/** Holds a core configuration item and its callbacks
- * where there may be more than one item
- */
-struct MultiConfig
+class CoreExport OperInfo : public refcountbase
{
- /** Tag name */
- const char* tag;
- /** One or more items within tag */
- char* items[17];
- /** One or more defaults for items within tags */
- char* items_default[17];
- /** One or more data types */
- int datatype[17];
- /** Initialization function */
- MultiNotify init_function;
- /** Validation function */
- MultiValidator validation_function;
- /** Completion function */
- MultiNotify finish_function;
+ public:
+ typedef insp::flat_set<std::string> PrivSet;
+ PrivSet AllowedOperCommands;
+ PrivSet AllowedPrivs;
+
+ /** Allowed user modes from oper classes. */
+ std::bitset<64> AllowedUserModes;
+
+ /** Allowed channel modes from oper classes. */
+ std::bitset<64> AllowedChanModes;
+
+ /** \<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;
+
+ /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
+ std::string getConfig(const std::string& key);
+ void init();
};
-/** A set of oper types
- */
-typedef std::map<irc::string,char*> opertype_t;
-
-/** A Set of oper classes
- */
-typedef std::map<irc::string,char*> operclass_t;
-
-
/** 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
+class CoreExport ServerConfig
{
private:
- /** Creator/owner pointer
- */
- InspIRCd* ServerInstance;
+ void CrossCheckOperClassType();
+ void CrossCheckConnectBlocks(ServerConfig* current);
- /** 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;
+ public:
+ class ServerPaths
+ {
+ public:
+ /** Config path */
+ std::string Config;
- /** This private method processes one line of
- * 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);
-
- /** Process an include directive
- */
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+ /** Data path */
+ std::string Data;
- /** Check that there is only one of each configuration item
- */
- bool CheckOnce(char* tag, bool bail, userrec* user);
-
- public:
+ /** Log path */
+ std::string Log;
- /** Used to indicate who we announce invites to on a channel */
- enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS };
+ /** Module path */
+ std::string Module;
- /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
- Validator DNSServerValidator;
+ ServerPaths()
+ : Config(INSPIRCD_CONFIG_PATH)
+ , Data(INSPIRCD_DATA_PATH)
+ , Log(INSPIRCD_LOG_PATH)
+ , Module(INSPIRCD_MODULE_PATH) { }
- InspIRCd* GetInstance();
-
- /** This holds all the information in the config file,
- * it's indexed by tag name to a vector of key/values.
- */
- ConfigDataHash config_data;
+ 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); }
+ };
- /** Max number of WhoWas entries per user.
+ /** Holds a complete list of all connect blocks
*/
- int WhoWasGroupSize;
+ typedef std::vector<reference<ConnectClass> > ClassVector;
- /** Max number of cumulative user-entries in WhoWas.
- * When max reached and added to, push out oldest entry FIFO style.
+ /** Index of valid oper blocks and types
*/
- int WhoWasMaxGroups;
+ typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
- /** Max seconds a user is kept in WhoWas before being pruned.
+ /** Get a configuration tag
+ * @param tag The name of the tag to get
*/
- int WhoWasMaxKeep;
+ ConfigTag* ConfValue(const std::string& tag);
- /** Holds the server name of the local server
- * as defined by the administrator.
- */
- char ServerName[MAXBUF];
+ ConfigTagList ConfTags(const std::string& tag);
- /** 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];
+ /** An empty configuration tag. */
+ ConfigTag* EmptyTag;
- /** Holds the description of the local server
- * as defined by the administrator.
+ /** Error stream, contains error output from any failed configuration parsing.
*/
- char ServerDesc[MAXBUF];
+ std::stringstream errstr;
- /** Holds the admin's name, for output in
- * the /ADMIN command.
- */
- char AdminName[MAXBUF];
+ /** 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 };
- /** Holds the email address of the admin,
- * for output in the /ADMIN command.
+ /** This holds all the information in the config file,
+ * it's indexed by tag name to a vector of key/values.
*/
- char AdminEmail[MAXBUF];
+ ConfigDataHash config_data;
- /** Holds the admin's nickname, for output
- * in the /ADMIN command
+ /** This holds all extra files that have been read in the configuration
+ * (for example, MOTD and RULES files are stored here)
*/
- char AdminNick[MAXBUF];
+ ConfigFileCache Files;
- /** The admin-configured /DIE password
+ /** Length limits, see definition of ServerLimits class
*/
- char diepass[MAXBUF];
+ ServerLimits Limits;
- /** The admin-configured /RESTART password
+ /** Locations of various types of file (config, module, etc). */
+ ServerPaths Paths;
+
+ /** Configuration parsed from the command line.
*/
- char restartpass[MAXBUF];
+ CommandLineConf cmdline;
- /** The pathname and filename of the message of the
- * day file, as defined by the administrator.
+ /** Clones CIDR range for ipv4 (0-32)
+ * Defaults to 32 (checks clones on all IPs seperately)
*/
- char motd[MAXBUF];
+ int c_ipv4_range;
- /** The pathname and filename of the rules file,
- * as defined by the administrator.
+ /** Clones CIDR range for ipv6 (0-128)
+ * Defaults to 128 (checks on all IPs seperately)
*/
- char rules[MAXBUF];
+ int c_ipv6_range;
- /** The quit prefix in use, or an empty string
+ /** Holds the server name of the local server
+ * as defined by the administrator.
*/
- char PrefixQuit[MAXBUF];
+ std::string ServerName;
- /** The quit suffix in use, or an empty string
+ /** Notice to give to users when they are banned by an XLine
*/
- char SuffixQuit[MAXBUF];
+ std::string XLineMessage;
- /** The fixed quit message in use, or an empty string
+ /* Holds the network name the local server
+ * belongs to. This is an arbitary field defined
+ * by the administrator.
*/
- char FixedQuit[MAXBUF];
+ std::string Network;
- /** The last string found within a <die> tag, or
- * an empty string.
+ /** Holds the description of the local server
+ * as defined by the administrator.
*/
- char DieValue[MAXBUF];
+ std::string ServerDesc;
- /** The DNS server to use for DNS queries
+ /** Pretend disabled commands don't exist.
*/
- char DNSServer[MAXBUF];
+ 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];
+ std::string DisabledCommands;
- /** The full path to the modules directory.
- * This is either set at compile time, or
- * overridden in the configuration file via
- * the <options> tag.
+ /** This variable identifies which usermodes have been diabled.
*/
- char ModPath[1024];
+ char DisabledUModes[64];
- /** The full pathname to the executable, as
- * given in argv[0] when the program starts.
+ /** This variable identifies which chanmodes have been disabled.
*/
- char MyExecutable[1024];
+ char DisabledCModes[64];
- /** 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!).
+ /** If set to true, then all opers on this server are
+ * shown with a generic 'is an IRC operator' line rather
+ * than the oper type. Oper types are still used internally.
*/
- FILE *log_file;
+ bool GenericOper;
- /** If this value is true, the owner of the
- * server specified -nofork on the command
- * line, causing the daemon to stay in the
- * foreground.
+ /** 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 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.
- */
- bool writelog;
-
- /** 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
- * users.
- */
- bool HideModeLists[256];
-
- /** If this is set to true, then channel operators
- * are exempt from this channel mode. Used for +Sc etc.
- */
- bool ExemptChanOps[256];
+ bool RestrictBannedUsers;
/** The number of seconds the DNS subsystem
* will wait before timing out any request.
*/
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;
-
- /** The loglevel in use by the IRC server
- */
- int LogLevel;
-
- /** 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;
/** 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
*/
- char HideWhoisServer[MAXBUF];
+ std::string HideWhoisServer;
/** Set to a non empty string to obfuscate nicknames prepended to a KILL.
*/
- char HideKillsServer[MAXBUF];
-
- /** The MOTD file, cached in a file_cache type.
- */
- file_cache MOTD;
+ std::string HideKillsServer;
- /** The RULES file, cached in a file_cache type.
+ /** Set to hide kills from clients of ulined servers in snotices.
*/
- file_cache RULES;
+ bool HideULineKills;
/** 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 module names (names only, no paths)
- * which are currently loaded by the server.
- */
- std::vector<std::string> module_names;
-
- /** A list of the classes for listening client ports
- */
- std::vector<ListenSocket*> ports;
-
- /** Boolean sets of which modules implement which functions
- */
- char implement_lists[255][255];
-
- /** Global implementation list
- */
- char global_implementation[255];
-
- /** A list of ports claimed by IO Modules
- */
- std::map<int,Module*> IOHookModule;
-
- std::map<InspSocket*, Module*> SocketIOHookModule;
-
- /** 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;
+ std::string UserStats;
/** 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.
- */
- bool CycleHosts;
-
- /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
- * added to the outgoing text for undernet style msg prefixing.
+ /** If set to true, the CycleHosts mode change will be sourced from the user,
+ * rather than the server
*/
- bool UndernetMsgPrefix;
+ bool CycleHostsFromUser;
- /** 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
+ /** Oper blocks keyed by their name
*/
- opertype_t opertypes;
+ OperIndex oper_blocks;
- /** All oper class definitions from the config file
+ /** Oper types keyed by their name
*/
- operclass_t operclass;
+ OperIndex OperTypes;
- /** Saved argv from startup
- */
- char** argv;
-
- /** Saved argc from startup
- */
- int argc;
-
- /** Max channels per user
+ /** Default value for <connect:maxchans>, deprecated in 2.2
*/
unsigned int MaxChans;
- /** Oper max channels per user
+ /** Default value for <oper:maxchans>, deprecated in 2.2
*/
unsigned int OperMaxChans;
- /** Construct a new ServerConfig
+ /** TS6-like server ID.
+ * NOTE: 000...999 are usable for InspIRCd servers. This
+ * makes code simpler. 0AA, 1BB etc with letters are reserved
+ * for services use.
*/
- ServerConfig(InspIRCd* Instance);
+ std::string sid;
- /** Clears the include stack in preperation for a Read() call.
+ /** Construct a new ServerConfig
*/
- void ClearStack();
+ ServerConfig();
- /** Update the 005 vector
- */
- void Update005();
+ ~ServerConfig();
- /** Send the 005 numerics (ISUPPORT) to a user
+ /** Get server ID as string with required leading zeroes
*/
- void Send005(userrec* 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, userrec* user);
-
- /** Read a file into a file_cache object
- */
- bool ReadFile(file_cache &F, const char* fname);
-
- /** 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 users via WriteOpers as SNOTICEs.
- */
- void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
+ void Read();
- /** 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.
+ /** Apply configuration changes from the old configuration.
*/
- bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
+ void Apply(ServerConfig* old, const std::string &useruid);
+ void ApplyModules(User* user);
- /** 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);
-
- /* Both these return true if the value existed or false otherwise */
-
- /** 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);
-
- /** 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
- */
- Module* GetIOHook(int port);
+ void Fill();
- /** 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);
+ bool ApplyDisabledCommands(const std::string& data);
- /** 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 InspSocket class.
- * @parameter port Port number
- * @return Returns a pointer to the hooking module, or NULL
+ /** Escapes a value for storage in a configuration key.
+ * @param str The string to escape.
+ * @param xml Are we using the XML config format?
*/
- Module* GetIOHook(InspSocket* is);
+ static std::string Escape(const std::string& str, bool xml = true);
- /** Hook a module to an InspSocket class, so that it can receive notifications
- * of low-level socket activity.
- * @param iomod The module to hook to the socket
- * @param is The InspSocket to attach to
- * @return True if the hook was successful.
+ /** If this value is true, snotices will not stack when repeats are sent
*/
- bool AddIOHook(Module* iomod, InspSocket* is);
-
- /** Delete a module hook from an InspSocket.
- * @param is The InspSocket to detatch from.
- * @return True if the unhook was successful
- */
- bool DelIOHook(InspSocket* is);
-
- /** 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);
-
- /** Clean a filename, stripping the directories (and drives) from string.
- * @param name Directory to tidy
- * @return The cleaned filename
- */
- static char* CleanFilename(char* name);
-
- /** Check if a file exists.
- * @param file The full path to a file
- * @return True if the file exists and is readable.
- */
- static bool FileExists(const char* file);
-
+ bool NoSnoticeStack;
};
-/** Initialize the disabled commands list
- */
-CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
-
-/** Initialize the oper types
- */
-bool InitTypes(ServerConfig* conf, const char* tag);
-
-/** Initialize the oper classes
- */
-bool InitClasses(ServerConfig* conf, const char* tag);
-
-/** Initialize an oper type
+/** The background thread for config reading, so that reading from executable includes
+ * does not block.
*/
-bool DoType(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)
+ {
+ }
-/** Initialize an oper class
- */
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+ virtual ~ConfigReaderThread()
+ {
+ delete Config;
+ }
-/** Finish initializing the oper types and classes
- */
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
+ void Run();
+ /** Run in the main thread to apply the configuration */
+ void Finish();
+ bool IsDone() { return done; }
+};
-#endif
+class CoreExport ConfigStatus
+{
+ public:
+ User* const srcuser;
+ ConfigStatus(User* user = NULL)
+ : srcuser(user)
+ {
+ }
+};
projects / user / henk / code / inspircd.git / blobdiff