2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
6 * Copyright (C) 2013-2014, 2016 Attila Molnar <attilamolnar@hush.com>
7 * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
8 * Copyright (C) 2012-2014, 2016-2019 Sadie Powell <sadie@witchery.services>
9 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
10 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
11 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
12 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
13 * Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
14 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
16 * This file is part of InspIRCd. InspIRCd is free software: you can
17 * redistribute it and/or modify it under the terms of the GNU General Public
18 * License as published by the Free Software Foundation, version 2.
20 * This program is distributed in the hope that it will be useful, but WITHOUT
21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 #include "socketengine.h"
40 #include "token_list.h"
42 /** Structure representing a single \<tag> in config */
43 class CoreExport ConfigTag : public refcountbase
47 const std::string tag;
48 const std::string src_name;
51 /** Get the value of an option, using def if it does not exist */
52 std::string getString(const std::string& key, const std::string& def, const TR1NS::function<bool(const std::string&)>& validator);
53 /** Get the value of an option, using def if it does not exist */
54 std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
55 /** Get the value of an option, using def if it does not exist */
56 long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
57 /** Get the value of an option, using def if it does not exist */
58 unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
59 /** Get the value of an option, using def if it does not exist */
60 double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX);
61 /** Get the value of an option, using def if it does not exist */
62 bool getBool(const std::string& key, bool def = false);
64 /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
65 * using a default value if it does not exist or is out of bounds.
66 * @param key The config key name
67 * @param def Default value (optional)
68 * @param min Minimum acceptable value (optional)
69 * @param max Maximum acceptable value (optional)
70 * @return The duration in seconds
72 unsigned long getDuration(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
74 /** Get the value of an option
75 * @param key The option to get
76 * @param value The location to store the value (unmodified if does not exist)
77 * @param allow_newline Allow newlines in the option (normally replaced with spaces)
78 * @return true if the option exists
80 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
82 std::string getTagLocation();
84 inline const ConfigItems& getItems() const { return items; }
86 /** Create a new ConfigTag, giving access to the private ConfigItems item list */
87 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
89 ConfigTag(const std::string& Tag, const std::string& file, int line);
92 /** Defines the server's length limits on various length-limited
93 * items such as topics, nicknames, channel names etc.
98 /** Maximum nickname length */
100 /** Maximum channel length */
102 /** Maximum number of modes per line */
104 /** Maximum length of ident, not including ~ etc */
106 /** Maximum length of a quit message */
108 /** Maximum topic length */
110 /** Maximum kick message length */
112 /** Maximum real name length */
114 /** Maximum away message length */
116 /** Maximum line length */
118 /** Maximum hostname length */
121 /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
122 * @param tag Configuration tag to read the limits from
124 ServerLimits(ConfigTag* tag);
126 /** Maximum length of a n!u\@h mask */
127 size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
130 struct CommandLineConf
132 /** If this value is true, the owner of the
133 * server specified -nofork on the command
134 * line, causing the daemon to stay in the
139 /** If this value if true then all log
140 * messages will be output, regardless of
141 * the level given in the config file.
142 * This is set with the -debug commandline
147 /** If this is true then log output will be
148 * written to the logfile. This is the default.
149 * If you put -nolog on the commandline then
150 * the logfile will not be written.
151 * This is meant to be used in conjunction with
152 * -debug for debugging without filling up the
157 /** If this is true, a PID file will be written
158 * to the file given in the "file" variable of
159 * the \<pid> tag in the config file. This is
161 * Passing --nopid as a command line argument
162 * sets this to false; in this case, a PID file
163 * will not be written, even the default PID
164 * file that is usually written when the \<pid>
165 * tag is not defined in the config file.
169 /* Whether the --runasroot option was specified at boot. */
172 /** Saved argc from startup. */
175 /** Saved argv from startup. */
179 class CoreExport OperInfo : public refcountbase
182 TokenList AllowedOperCommands;
183 TokenList AllowedPrivs;
185 /** Allowed user modes from oper classes. */
186 std::bitset<64> AllowedUserModes;
188 /** Allowed channel modes from oper classes. */
189 std::bitset<64> AllowedChanModes;
191 /** \<oper> block used for this oper-up. May be NULL. */
192 reference<ConfigTag> oper_block;
193 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
194 reference<ConfigTag> type_block;
195 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
196 std::vector<reference<ConfigTag> > class_blocks;
197 /** Name of the oper type; i.e. the one shown in WHOIS */
200 /** Creates a new OperInfo with the specified oper type name.
201 * @param Name The name of the oper type.
203 OperInfo(const std::string& Name);
205 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
206 std::string getConfig(const std::string& key);
210 /** This class holds the bulk of the runtime configuration for the ircd.
211 * It allows for reading new config values, accessing configuration files,
212 * and storage of the configuration data needed to run the ircd, such as
213 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
215 class CoreExport ServerConfig
218 void CrossCheckOperClassType();
219 void CrossCheckConnectBlocks(ServerConfig* current);
222 /** How to treat a user in a channel who is banned. */
223 enum BannedUserTreatment
225 /** Don't treat a banned user any different to normal. */
228 /** Restrict the actions of a banned user. */
231 /** Restrict the actions of a banned user and notify them of their treatment. */
250 ServerPaths(ConfigTag* tag);
252 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
253 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
254 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
255 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
258 /** Holds a complete list of all connect blocks
260 typedef std::vector<reference<ConnectClass> > ClassVector;
262 /** Index of valid oper blocks and types
264 typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
266 /** Get a configuration tag by name. If one or more tags are present then the first is returned.
267 * @param tag The name of the tag to get.
268 * @returns Either a tag from the config or EmptyTag.
270 ConfigTag* ConfValue(const std::string& tag);
272 /** Get a list of configuration tags by name.
273 * @param tag The name of the tags to get.
274 * @returns Either a list of tags from the config or an empty ConfigTagList.
276 ConfigTagList ConfTags(const std::string& tag);
278 /** An empty configuration tag. */
281 /** Error stream, contains error output from any failed configuration parsing.
283 std::stringstream errstr;
285 /** True if this configuration is valid enough to run with */
288 /** Bind to IPv6 by default */
291 /** This holds all the information in the config file,
292 * it's indexed by tag name to a vector of key/values.
294 ConfigDataHash config_data;
296 /** This holds all extra files that have been read in the configuration
297 * (for example, MOTD and RULES files are stored here)
299 ConfigFileCache Files;
301 /** Length limits, see definition of ServerLimits class
305 /** Locations of various types of file (config, module, etc). */
308 /** Configuration parsed from the command line.
310 CommandLineConf cmdline;
312 /** Clones CIDR range for ipv4 (0-32)
313 * Defaults to 32 (checks clones on all IPs seperately)
315 unsigned char c_ipv4_range;
317 /** Clones CIDR range for ipv6 (0-128)
318 * Defaults to 128 (checks on all IPs seperately)
320 unsigned char c_ipv6_range;
322 /** Holds the server name of the local server
323 * as defined by the administrator.
325 std::string ServerName;
327 /** Notice to give to users when they are banned by an XLine
329 std::string XLineMessage;
331 /* Holds the network name the local server
332 * belongs to. This is an arbitary field defined
333 * by the administrator.
337 /** Holds the description of the local server
338 * as defined by the administrator.
340 std::string ServerDesc;
342 /** How to treat a user in a channel who is banned. */
343 BannedUserTreatment RestrictBannedUsers;
345 /** The size of the read() buffer in the user
346 * handling code, used to read data into a user's
351 /** The value to be used for listen() backlogs
356 /** If we should check for clones during CheckClass() in AddUser()
357 * Setting this to false allows to not trigger on maxclones for users
358 * that may belong to another class after DNS-lookup is complete.
359 * It does, however, make the server spend more time on users we may potentially not want.
363 /** The soft limit value assigned to the irc server.
364 * The IRC server will not allow more than this
365 * number of local users.
367 unsigned int SoftLimit;
369 /** Maximum number of targets for a multi target command
370 * such as PRIVMSG or KICK
372 unsigned int MaxTargets;
374 /** The number of seconds that the server clock can skip by before server operators are warned. */
377 /** True if we're going to hide ban reasons for non-opers (e.g. G-lines,
382 /** True if raw I/O is being logged */
385 /** Set to a non-empty string to obfuscate server names. */
386 std::string HideServer;
388 /** The full pathname and filename of the PID
389 * file as defined in the configuration.
393 /** The connect classes in use by the IRC server.
397 /** Default channel modes
399 std::string DefaultModes;
401 /** Custom version string, which if defined can replace the system info in VERSION.
403 std::string CustomVersion;
405 /** If set to true, provide syntax hints for unknown commands
409 /** The name of the casemapping method used by this server.
411 std::string CaseMapping;
413 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
414 * for who set the topic last. If false, only the nick is shown.
416 bool FullHostInTopic;
418 /** Oper blocks keyed by their name
420 OperIndex oper_blocks;
422 /** Oper types keyed by their name
426 /** Default value for <connect:maxchans>, deprecated in 3.0
428 unsigned int MaxChans;
430 /** Default value for <oper:maxchans>, deprecated in 3.0
432 unsigned int OperMaxChans;
434 /** TS6-like server ID.
435 * NOTE: 000...999 are usable for InspIRCd servers. This
436 * makes code simpler. 0AA, 1BB etc with letters are reserved
441 /** Construct a new ServerConfig
447 /** Get server ID as string with required leading zeroes
449 const std::string& GetSID() const { return sid; }
451 /** Read the entire configuration into memory
452 * and initialize this class. All other methods
453 * should be used only by the core.
457 /** Apply configuration changes from the old configuration.
459 void Apply(ServerConfig* old, const std::string &useruid);
460 void ApplyModules(User* user);
464 /** Escapes a value for storage in a configuration key.
465 * @param str The string to escape.
466 * @param xml Are we using the XML config format?
468 static std::string Escape(const std::string& str, bool xml = true);
470 /** If this value is true, snotices will not stack when repeats are sent
475 /** The background thread for config reading, so that reading from executable includes
478 class CoreExport ConfigReaderThread : public Thread
480 ServerConfig* Config;
483 const std::string TheUserUID;
484 ConfigReaderThread(const std::string &useruid)
485 : Config(new ServerConfig), done(false), TheUserUID(useruid)
489 virtual ~ConfigReaderThread()
494 void Run() CXX11_OVERRIDE;
495 /** Run in the main thread to apply the configuration */
497 bool IsDone() { return done; }
500 /** Represents the status of a config load. */
501 class CoreExport ConfigStatus
504 /** Whether this is the initial config load. */
507 /** The user who initiated the config load or NULL if not initiated by a user. */
510 /** Initializes a new instance of the ConfigStatus class.
511 * @param user The user who initiated the config load or NULL if not initiated by a user.
512 * @param isinitial Whether this is the initial config load.
514 ConfigStatus(User* user = NULL, bool isinitial = false)