2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
6 * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 #include "socketengine.h"
34 #include "token_list.h"
36 /** Structure representing a single \<tag> in config */
37 class CoreExport ConfigTag : public refcountbase
41 const std::string tag;
42 const std::string src_name;
45 /** Get the value of an option, using def if it does not exist */
46 std::string getString(const std::string& key, const std::string& def, const TR1NS::function<bool(const std::string&)>& validator);
47 /** Get the value of an option, using def if it does not exist */
48 std::string getString(const std::string& key, const std::string& def = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
49 /** Get the value of an option, using def if it does not exist */
50 long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
51 /** Get the value of an option, using def if it does not exist */
52 unsigned long getUInt(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
53 /** Get the value of an option, using def if it does not exist */
54 double getFloat(const std::string& key, double def, double min = DBL_MIN, double max = DBL_MAX);
55 /** Get the value of an option, using def if it does not exist */
56 bool getBool(const std::string& key, bool def = false);
58 /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
59 * using a default value if it does not exist or is out of bounds.
60 * @param key The config key name
61 * @param def Default value (optional)
62 * @param min Minimum acceptable value (optional)
63 * @param max Maximum acceptable value (optional)
64 * @return The duration in seconds
66 unsigned long getDuration(const std::string& key, unsigned long def, unsigned long min = 0, unsigned long max = ULONG_MAX);
68 /** Get the value of an option
69 * @param key The option to get
70 * @param value The location to store the value (unmodified if does not exist)
71 * @param allow_newline Allow newlines in the option (normally replaced with spaces)
72 * @return true if the option exists
74 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
76 std::string getTagLocation();
78 inline const ConfigItems& getItems() const { return items; }
80 /** Create a new ConfigTag, giving access to the private ConfigItems item list */
81 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
83 ConfigTag(const std::string& Tag, const std::string& file, int line);
86 /** Defines the server's length limits on various length-limited
87 * items such as topics, nicknames, channel names etc.
92 /** Maximum nickname length */
94 /** Maximum channel length */
96 /** Maximum number of modes per line */
98 /** Maximum length of ident, not including ~ etc */
100 /** Maximum length of a quit message */
102 /** Maximum topic length */
104 /** Maximum kick message length */
106 /** Maximum real name length */
108 /** Maximum away message length */
110 /** Maximum line length */
112 /** Maximum hostname length */
115 /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
116 * @param tag Configuration tag to read the limits from
118 ServerLimits(ConfigTag* tag);
120 /** Maximum length of a n!u\@h mask */
121 size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
124 struct CommandLineConf
126 /** If this value is true, the owner of the
127 * server specified -nofork on the command
128 * line, causing the daemon to stay in the
133 /** If this value if true then all log
134 * messages will be output, regardless of
135 * the level given in the config file.
136 * This is set with the -debug commandline
141 /** If this is true then log output will be
142 * written to the logfile. This is the default.
143 * If you put -nolog on the commandline then
144 * the logfile will not be written.
145 * This is meant to be used in conjunction with
146 * -debug for debugging without filling up the
151 /** If this is true, a PID file will be written
152 * to the file given in the "file" variable of
153 * the <pid> tag in the config file. This is
155 * Passing --nopid as a command line argument
156 * sets this to false; in this case, a PID file
157 * will not be written, even the default PID
158 * file that is usually written when the <pid>
159 * tag is not defined in the config file.
163 /** Saved argc from startup
167 /** Saved argv from startup
172 class CoreExport OperInfo : public refcountbase
175 TokenList AllowedOperCommands;
176 TokenList AllowedPrivs;
178 /** Allowed user modes from oper classes. */
179 std::bitset<64> AllowedUserModes;
181 /** Allowed channel modes from oper classes. */
182 std::bitset<64> AllowedChanModes;
184 /** \<oper> block used for this oper-up. May be NULL. */
185 reference<ConfigTag> oper_block;
186 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
187 reference<ConfigTag> type_block;
188 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
189 std::vector<reference<ConfigTag> > class_blocks;
190 /** Name of the oper type; i.e. the one shown in WHOIS */
193 /** Creates a new OperInfo with the specified oper type name.
194 * @param Name The name of the oper type.
196 OperInfo(const std::string& Name);
198 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
199 std::string getConfig(const std::string& key);
203 /** This class holds the bulk of the runtime configuration for the ircd.
204 * It allows for reading new config values, accessing configuration files,
205 * and storage of the configuration data needed to run the ircd, such as
206 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
208 class CoreExport ServerConfig
211 void CrossCheckOperClassType();
212 void CrossCheckConnectBlocks(ServerConfig* current);
215 /** How to treat a user in a channel who is banned. */
216 enum BannedUserTreatment
218 /** Don't treat a banned user any different to normal. */
221 /** Restrict the actions of a banned user. */
224 /** Restrict the actions of a banned user and notify them of their treatment. */
243 ServerPaths(ConfigTag* tag);
245 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
246 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
247 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
248 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
251 /** Holds a complete list of all connect blocks
253 typedef std::vector<reference<ConnectClass> > ClassVector;
255 /** Index of valid oper blocks and types
257 typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
259 /** Get a configuration tag by name. If one or more tags are present then the first is returned.
260 * @param tag The name of the tag to get.
261 * @returns Either a tag from the config or EmptyTag.
263 ConfigTag* ConfValue(const std::string& tag);
265 /** Get a list of configuration tags by name.
266 * @param tag The name of the tags to get.
267 * @returns Either a list of tags from the config or an empty ConfigTagList.
269 ConfigTagList ConfTags(const std::string& tag);
271 /** An empty configuration tag. */
274 /** Error stream, contains error output from any failed configuration parsing.
276 std::stringstream errstr;
278 /** True if this configuration is valid enough to run with */
281 /** Bind to IPv6 by default */
284 /** This holds all the information in the config file,
285 * it's indexed by tag name to a vector of key/values.
287 ConfigDataHash config_data;
289 /** This holds all extra files that have been read in the configuration
290 * (for example, MOTD and RULES files are stored here)
292 ConfigFileCache Files;
294 /** Length limits, see definition of ServerLimits class
298 /** Locations of various types of file (config, module, etc). */
301 /** Configuration parsed from the command line.
303 CommandLineConf cmdline;
305 /** Clones CIDR range for ipv4 (0-32)
306 * Defaults to 32 (checks clones on all IPs seperately)
308 unsigned char c_ipv4_range;
310 /** Clones CIDR range for ipv6 (0-128)
311 * Defaults to 128 (checks on all IPs seperately)
313 unsigned char c_ipv6_range;
315 /** Holds the server name of the local server
316 * as defined by the administrator.
318 std::string ServerName;
320 /** Notice to give to users when they are banned by an XLine
322 std::string XLineMessage;
324 /* Holds the network name the local server
325 * belongs to. This is an arbitary field defined
326 * by the administrator.
330 /** Holds the description of the local server
331 * as defined by the administrator.
333 std::string ServerDesc;
335 /** Pretend disabled commands don't exist.
337 bool DisabledDontExist;
339 /** This variable identifies which usermodes have been diabled.
341 std::bitset<64> DisabledUModes;
343 /** This variable identifies which chanmodes have been disabled.
345 std::bitset<64> DisabledCModes;
347 /** If set to true, then all opers on this server are
348 * shown with a generic 'is an IRC operator' line rather
349 * than the oper type. Oper types are still used internally.
353 /** How to treat a user in a channel who is banned. */
354 BannedUserTreatment RestrictBannedUsers;
356 /** The size of the read() buffer in the user
357 * handling code, used to read data into a user's
362 /** The value to be used for listen() backlogs
367 /** If we should check for clones during CheckClass() in AddUser()
368 * Setting this to false allows to not trigger on maxclones for users
369 * that may belong to another class after DNS-lookup is complete.
370 * It does, however, make the server spend more time on users we may potentially not want.
374 /** The soft limit value assigned to the irc server.
375 * The IRC server will not allow more than this
376 * number of local users.
378 unsigned int SoftLimit;
380 /** Maximum number of targets for a multi target command
381 * such as PRIVMSG or KICK
383 unsigned int MaxTargets;
385 /** True if we're going to hide netsplits as *.net *.split for non-opers
389 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
394 /** True if raw I/O is being logged */
397 /** Set to a non-empty string to obfuscate server names. */
398 std::string HideServer;
400 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
402 std::string HideKillsServer;
404 /** Set to hide kills from clients of ulined servers in snotices.
408 /** The full pathname and filename of the PID
409 * file as defined in the configuration.
413 /** The connect classes in use by the IRC server.
417 /** STATS characters in this list are available
420 std::string UserStats;
422 /** Default channel modes
424 std::string DefaultModes;
426 /** Custom version string, which if defined can replace the system info in VERSION.
428 std::string CustomVersion;
430 /** If set to true, provide syntax hints for unknown commands
434 /** The name of the casemapping method used by this server.
436 std::string CaseMapping;
438 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
439 * for who set the topic last. If false, only the nick is shown.
441 bool FullHostInTopic;
443 /** Oper blocks keyed by their name
445 OperIndex oper_blocks;
447 /** Oper types keyed by their name
451 /** Default value for <connect:maxchans>, deprecated in 3.0
453 unsigned int MaxChans;
455 /** Default value for <oper:maxchans>, deprecated in 3.0
457 unsigned int OperMaxChans;
459 /** TS6-like server ID.
460 * NOTE: 000...999 are usable for InspIRCd servers. This
461 * makes code simpler. 0AA, 1BB etc with letters are reserved
466 /** Construct a new ServerConfig
472 /** Get server ID as string with required leading zeroes
474 const std::string& GetSID() const { return sid; }
476 /** Read the entire configuration into memory
477 * and initialize this class. All other methods
478 * should be used only by the core.
482 /** Apply configuration changes from the old configuration.
484 void Apply(ServerConfig* old, const std::string &useruid);
485 void ApplyModules(User* user);
489 /** Disables the commands specified in <disabled:commands>. */
490 bool ApplyDisabledCommands();
492 /** Escapes a value for storage in a configuration key.
493 * @param str The string to escape.
494 * @param xml Are we using the XML config format?
496 static std::string Escape(const std::string& str, bool xml = true);
498 /** If this value is true, snotices will not stack when repeats are sent
503 /** The background thread for config reading, so that reading from executable includes
506 class CoreExport ConfigReaderThread : public Thread
508 ServerConfig* Config;
511 const std::string TheUserUID;
512 ConfigReaderThread(const std::string &useruid)
513 : Config(new ServerConfig), done(false), TheUserUID(useruid)
517 virtual ~ConfigReaderThread()
522 void Run() CXX11_OVERRIDE;
523 /** Run in the main thread to apply the configuration */
525 bool IsDone() { return done; }
528 class CoreExport ConfigStatus
533 ConfigStatus(User* user = NULL)