X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=66f7920be7471b6d9f0ad4c9513e407c6506f3b9;hb=c05f81cac83e80c7727594e3929e0709eccca689;hp=db7258d4e2b8114805eea909017f75ffcc29f789;hpb=91e0af0fc4889f20d2f63426f8fe379674fc0393;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index db7258d4e..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 @@ -23,14 +30,7 @@ #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 */ @@ -42,12 +42,16 @@ class CoreExport ConfigTag : public refcountbase 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& 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 = 0, long min = LONG_MIN, long max = LONG_MAX); + 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 = 0); + 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); @@ -59,7 +63,7 @@ class CoreExport ConfigTag : public refcountbase * @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); + 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 @@ -69,16 +73,6 @@ class CoreExport ConfigTag : public refcountbase */ 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 ConfigItems& getItems() const { return items; } @@ -95,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 */ @@ -109,12 +105,10 @@ 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 line length */ - size_t MaxLine; /** Maximum hostname length */ size_t MaxHost; @@ -154,12 +148,25 @@ struct CommandLineConf */ bool writelog; - /** Saved argc from startup + /** 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 writepid; + + /* 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; }; @@ -175,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 */ @@ -206,6 +216,19 @@ 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, + + /** 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: @@ -221,12 +244,16 @@ class CoreExport ServerConfig /** 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 @@ -237,11 +264,16 @@ class CoreExport ServerConfig */ typedef insp::flat_map > OperIndex; - /** Get a configuration tag - * @param tag The name of the tag to get + /** 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. */ @@ -257,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; @@ -283,12 +311,12 @@ class CoreExport ServerConfig 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) */ 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) */ unsigned char c_ipv6_range; @@ -302,7 +330,7 @@ class CoreExport ServerConfig 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; @@ -312,28 +340,8 @@ class CoreExport ServerConfig */ std::string ServerDesc; - /** Pretend disabled commands don't exist. - */ - bool DisabledDontExist; - - /** This variable identifies which usermodes have been diabled. - */ - std::bitset<64> DisabledUModes; - - /** This variable identifies which chanmodes have been disabled. - */ - std::bitset<64> DisabledCModes; - - /** 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; + /** 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 @@ -364,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. @@ -406,11 +395,6 @@ class CoreExport ServerConfig */ ClassVector Classes; - /** STATS characters in this list are available - * only to operators. - */ - std::string UserStats; - /** Default channel modes */ std::string DefaultModes; @@ -427,11 +411,6 @@ class CoreExport ServerConfig */ std::string CaseMapping; - /** If set to true, the CycleHosts mode change will be sourced from the user, - * rather than the server - */ - bool CycleHostsFromUser; - /** 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. */ @@ -453,7 +432,7 @@ class CoreExport ServerConfig */ 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. @@ -470,6 +449,12 @@ class CoreExport ServerConfig */ const std::string& GetSID() const { return sid; } + /** Retrieves the server name which should be shown to users. */ + const std::string& GetServerName() const { return HideServer.empty() ? ServerName : HideServer; } + + /** 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 * should be used only by the core. @@ -483,9 +468,6 @@ class CoreExport ServerConfig void Fill(); - /** Disables the commands specified in . */ - bool ApplyDisabledCommands(); - /** Escapes a value for storage in a configuration key. * @param str The string to escape. * @param xml Are we using the XML config format? @@ -522,13 +504,23 @@ class CoreExport ConfigReaderThread : public Thread 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; + + /** The user who initiated the config load or NULL if not initiated by a user. */ User* const srcuser; - ConfigStatus(User* user = NULL) - : srcuser(user) + /** 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) { } };