X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=66f7920be7471b6d9f0ad4c9513e407c6506f3b9;hb=c05f81cac83e80c7727594e3929e0709eccca689;hp=4a697d05c314a1edbe5de12ec9240978f2cb3b43;hpb=8ba9242952053fba069319afd064c80beda5ea84;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 4a697d05c..66f7920be 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,11 +1,18 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2007, 2009 Dennis Friis - * Copyright (C) 2006-2008 Craig Edwards - * Copyright (C) 2006-2008 Robin Burchell - * Copyright (C) 2006 Oliver Lupton + * Copyright (C) 2019 Matt Schatz + * Copyright (C) 2018 Chris Novakovic + * Copyright (C) 2013-2014, 2016 Attila Molnar + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012-2014, 2016-2021 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2008 Craig Edwards + * Copyright (C) 2006 Oliver Lupton * * 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 @@ -21,36 +28,43 @@ */ -#ifndef INSPIRCD_CONFIGREADER -#define INSPIRCD_CONFIGREADER +#pragma once -#include -#include -#include -#include #include "inspircd.h" -#include "modules.h" -#include "socketengine.h" -#include "socket.h" +#include "token_list.h" /** Structure representing a single \ in config */ class CoreExport ConfigTag : public refcountbase { - std::vector items; + ConfigItems items; public: const std::string tag; const std::string src_name; const int src_line; /** Get the value of an option, using def if it does not exist */ - std::string getString(const std::string& key, const std::string& def = ""); + std::string getString(const std::string& key, const std::string& def, const TR1NS::function& validator); /** Get the value of an option, using def if it does not exist */ - long getInt(const std::string& key, long def = 0); + std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX); /** Get the value of an option, using def if it does not exist */ - double getFloat(const std::string& key, double def = 0); + long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX); + /** Get the value of an option, using def if it does not exist */ + unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX); + /** Get the value of an option, using def if it does not exist */ + double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX); /** Get the value of an option, using def if it does not exist */ bool getBool(const std::string& key, bool def = false); + /** 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) @@ -61,10 +75,10 @@ class CoreExport ConfigTag : public refcountbase std::string getTagLocation(); - inline const std::vector& getItems() const { return items; } + inline const ConfigItems& getItems() const { return items; } - /** Create a new ConfigTag, giving access to the private KeyVal item list */ - static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector*& 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); }; @@ -75,6 +89,8 @@ class CoreExport ConfigTag : public refcountbase class ServerLimits { public: + /** Maximum line length */ + size_t MaxLine; /** Maximum nickname length */ size_t NickMax; /** Maximum channel length */ @@ -89,18 +105,20 @@ class ServerLimits size_t MaxTopic; /** Maximum kick message length */ size_t MaxKick; - /** Maximum GECOS (real name) length */ - size_t MaxGecos; + /** Maximum real name length */ + size_t MaxReal; /** Maximum away message length */ size_t MaxAway; + /** Maximum 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); + + /** Maximum length of a n!u\@h mask */ + size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; } }; struct CommandLineConf @@ -130,27 +148,33 @@ struct CommandLineConf */ bool writelog; - /** True if we have been told to run the testsuite from the commandline, - * rather than entering the mainloop. + /** If this is true, a PID file will be written + * to the file given in the "file" variable of + * the \ 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 \ + * tag is not defined in the config file. */ - bool TestSuite; + bool writepid; - /** Saved argc from startup - */ + /* Whether the --runasroot option was specified at boot. */ + bool runasroot; + + /** Saved argc from startup. */ int argc; - /** Saved argv from startup - */ + /** Saved argv from startup. */ char** argv; - - std::string startup_log; }; class CoreExport OperInfo : public refcountbase { public: - std::set AllowedOperCommands; - std::set AllowedPrivs; + TokenList AllowedOperCommands; + TokenList AllowedPrivs; /** Allowed user modes from oper classes. */ std::bitset<64> AllowedUserModes; @@ -158,6 +182,9 @@ class CoreExport OperInfo : public refcountbase /** Allowed channel modes from oper classes. */ std::bitset<64> AllowedChanModes; + /** Allowed snomasks from oper classes. */ + std::bitset<64> AllowedSnomasks; + /** \ block used for this oper-up. May be NULL. */ reference oper_block; /** \ block used for this oper-up. Valid for local users, may be NULL on remote */ @@ -167,14 +194,14 @@ class CoreExport OperInfo : public refcountbase /** Name of the oper type; i.e. the one shown in WHOIS */ std::string name; + /** Creates a new OperInfo with the specified oper type name. + * @param Name The name of the oper type. + */ + OperInfo(const std::string& Name); + /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */ std::string getConfig(const std::string& key); void init(); - - inline const char* NameStr() - { - return irc::Spacify(name.c_str()); - } }; /** This class holds the bulk of the runtime configuration for the ircd. @@ -189,12 +216,64 @@ class CoreExport ServerConfig void CrossCheckConnectBlocks(ServerConfig* current); public: + /** How to treat a user in a channel who is banned. */ + enum BannedUserTreatment + { + /** Don't treat a banned user any different to normal. */ + BUT_NORMAL, - /** Get a configuration tag - * @param tag The name of the tag to get + /** Restrict the actions of a banned user. */ + BUT_RESTRICT_SILENT, + + /** Restrict the actions of a banned user and notify them of their treatment. */ + BUT_RESTRICT_NOTIFY + }; + + class ServerPaths + { + public: + /** Config path */ + std::string Config; + + /** Data path */ + std::string Data; + + /** Log path */ + std::string Log; + + /** Module path */ + std::string Module; + + /** Runtime path */ + std::string Runtime; + + ServerPaths(ConfigTag* tag); + + std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); } + std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); } + 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); } + std::string PrependRuntime(const std::string& fn) const { return FileSystem::ExpandPath(Runtime, fn); } + }; + + /** Holds a complete list of all connect blocks + */ + typedef std::vector > ClassVector; + + /** Index of valid oper blocks and types + */ + typedef insp::flat_map > OperIndex; + + /** 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. */ ConfigTag* ConfValue(const std::string& tag); + /** 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. + */ ConfigTagList ConfTags(const std::string& tag); /** An empty configuration tag. */ @@ -210,11 +289,7 @@ class CoreExport ServerConfig /** Bind to IPv6 by default */ bool WildcardIPv6; - /** Used to indicate who we announce invites to on a channel */ - enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC }; - enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG }; - - /** This holds all the information in the config file, + /** This holds all the information in the config file, * it's indexed by tag name to a vector of key/values. */ ConfigDataHash config_data; @@ -228,44 +303,34 @@ class CoreExport ServerConfig */ ServerLimits Limits; + /** Locations of various types of file (config, module, etc). */ + ServerPaths Paths; + /** Configuration parsed from the command line. */ CommandLineConf cmdline; /** Clones CIDR range for ipv4 (0-32) - * Defaults to 32 (checks clones on all IPs seperately) + * Defaults to 32 (checks clones on all IPs separately) */ - int c_ipv4_range; + unsigned char c_ipv4_range; /** Clones CIDR range for ipv6 (0-128) - * Defaults to 128 (checks on all IPs seperately) + * Defaults to 128 (checks on all IPs separately) */ - 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; + unsigned char c_ipv6_range; /** 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 + * belongs to. This is an arbitrary field defined * by the administrator. */ std::string Network; @@ -275,117 +340,8 @@ class CoreExport ServerConfig */ std::string ServerDesc; - /** Holds the admin's name, for output in - * the /ADMIN command. - */ - std::string AdminName; - - /** Holds the email address of the admin, - * for output in the /ADMIN command. - */ - std::string AdminEmail; - - /** Holds the admin's nickname, for output - * in the /ADMIN command - */ - std::string AdminNick; - - /** The admin-configured /DIE password - */ - std::string diepass; - - /** The admin-configured /RESTART password - */ - std::string restartpass; - - /** The hash method for *BOTH* the die and restart passwords. - */ - std::string powerhash; - - /** The pathname and filename of the message of the - * day file, as defined by the administrator. - */ - std::string motd; - - /** The pathname and filename of the rules file, - * as defined by the administrator. - */ - std::string rules; - - /** The quit prefix in use, or an empty string - */ - std::string PrefixQuit; - - /** The quit suffix in use, or an empty string - */ - std::string SuffixQuit; - - /** The fixed quit message in use, or an empty string - */ - std::string FixedQuit; - - /** The part prefix in use, or an empty string - */ - std::string PrefixPart; - - /** The part suffix in use, or an empty string - */ - std::string SuffixPart; - - /** The fixed part message in use, or an empty string - */ - std::string FixedPart; - - /** The DNS server to use for DNS queries - */ - std::string DNSServer; - - /** Pretend disabled commands don't exist. - */ - bool DisabledDontExist; - - /** This variable contains a space-seperated list - * of commands which are disabled by the - * administrator of the server for non-opers. - */ - std::string DisabledCommands; - - /** This variable identifies which usermodes have been diabled. - */ - char DisabledUModes[64]; - - /** This variable identifies which chanmodes have been disabled. - */ - char DisabledCModes[64]; - - /** The full path to the modules directory. - * This is either set at compile time, or - * overridden in the configuration file via - * the \ tag. - */ - std::string ModPath; - - /** 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. - */ - bool GenericOper; - - /** If this value is true, banned users (+b, not extbans) will not be able to change nick - * if banned on any channel, nor to message them. - */ - bool RestrictBannedUsers; - - /** If this is set to true, then mode lists (e.g - * MODE \#chan b) are hidden from unprivileged - * users. - */ - bool HideModeLists[256]; - - /** 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 @@ -398,6 +354,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. @@ -409,38 +372,19 @@ class CoreExport ServerConfig */ unsigned int MaxTargets; - /** True if we're going to hide netsplits as *.net *.split for non-opers - */ - bool HideSplits; + /** 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 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. - */ - OperSpyWhoisState OperSpyWhois; - /** True if raw I/O is being logged */ bool RawLog; - /** Set to a non-empty string to obfuscate the server name of users in WHOIS - */ - std::string HideWhoisServer; - - /** Set to a non empty string to obfuscate nicknames prepended to a KILL. - */ - std::string HideKillsServer; - - /** Set to hide kills from clients of ulined servers in snotices. - */ - bool HideULineKills; + /** 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. @@ -451,21 +395,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 isupport; - - /** STATS characters in this list are available - * only to operators. - */ - std::string UserStats; - /** Default channel modes */ std::string DefaultModes; @@ -474,56 +403,36 @@ class CoreExport ServerConfig */ std::string CustomVersion; - /** List of u-lined servers - */ - std::map ulines; - - /** Max banlist sizes for channels (the std::string is a glob) - */ - std::map 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. + /** The name of the casemapping method used by this server. */ - 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; + std::string CaseMapping; /** 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; - /** Oper block and type index. - * For anonymous oper blocks (type only), prefix with a space. + /** Oper blocks keyed by their name */ OperIndex oper_blocks; - /** Max channels per user + /** Oper types keyed by their name + */ + OperIndex OperTypes; + + /** Default value for , deprecated in 3.0 */ unsigned int MaxChans; - /** Oper max channels per user + /** Default value for , deprecated in 3.0 */ unsigned int OperMaxChans; - /** TS6-like server ID. + /** Unique server ID. * NOTE: 000...999 are usable for InspIRCd servers. This * makes code simpler. 0AA, 1BB etc with letters are reserved * for services use. @@ -538,15 +447,13 @@ class CoreExport ServerConfig /** Get server ID as string with required leading zeroes */ - const std::string& GetSID(); + const std::string& GetSID() const { return sid; } - /** Update the 005 vector - */ - void Update005(); + /** Retrieves the server name which should be shown to users. */ + const std::string& GetServerName() const { return HideServer.empty() ? ServerName : HideServer; } - /** Send the 005 numerics (ISUPPORT) to a user - */ - void Send005(User* user); + /** Retrieves the server description which should be shown to users. */ + const std::string& GetServerDesc() const { return HideServer.empty() ? ServerDesc : HideServer; } /** Read the entire configuration into memory * and initialize this class. All other methods @@ -561,36 +468,15 @@ class CoreExport ServerConfig void Fill(); - /** Returns true if the given string starts with a windows drive letter + /** Escapes a value for storage in a configuration key. + * @param str The string to escape. + * @param xml Are we using the XML config format? */ - bool StartsWithWindowsDriveLetter(const std::string &path); - - bool ApplyDisabledCommands(const std::string& data); - - /** Clean a filename, stripping the directories (and drives) from string. - * @param name Directory to tidy - * @return The cleaned filename - */ - static const char* CleanFilename(const 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); - - /** If this value is true, invites will bypass more than just +i - */ - bool InvBypassModes; + static std::string Escape(const std::string& str, bool xml = true); /** If this value is true, snotices will not stack when repeats are sent */ bool NoSnoticeStack; - - /** If true, a "Welcome to !" NOTICE will be sent to - * connecting users - */ - bool WelcomeNotice; }; /** The background thread for config reading, so that reading from executable includes @@ -612,10 +498,29 @@ class CoreExport ConfigReaderThread : public Thread delete Config; } - void Run(); + void Run() CXX11_OVERRIDE; /** Run in the main thread to apply the configuration */ void Finish(); bool IsDone() { return done; } }; -#endif +/** Represents the status of a config load. */ +class CoreExport ConfigStatus +{ + public: + /** Whether this is the initial config load. */ + bool const initial; + + /** 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) + { + } +};