X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=4deef83f49a7b31c8c26f683bf078cea7d55f17d;hb=8df3d792bc99d9dd73db7a601ebe8d4a397c3522;hp=bb4c03fae2c1f1a9ba8e84bc06f7db382bb5c178;hpb=7ef2f87e39bd22c7914caf7f2afbb1a3bf8fbd43;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index bb4c03fae..4deef83f4 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,11 +1,17 @@ /* * 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-2019 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-2008 Craig Edwards + * Copyright (C) 2007 Dennis Friis * * 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 @@ -42,12 +48,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, 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); + 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); @@ -59,7 +69,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, 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 +79,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; } @@ -109,8 +109,8 @@ 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 */ @@ -154,12 +154,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; }; @@ -206,6 +219,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: @@ -237,11 +263,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. */ @@ -308,28 +339,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 @@ -360,12 +371,11 @@ 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; @@ -375,14 +385,6 @@ class CoreExport ServerConfig /** Set to a non-empty string to obfuscate server names. */ std::string HideServer; - /** 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; - /** The full pathname and filename of the PID * file as defined in the configuration. */ @@ -392,11 +394,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; @@ -413,11 +410,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. */ @@ -469,9 +461,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? @@ -508,13 +497,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) { } };