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 = "", size_t minlen = 0, size_t maxlen = UINT32_MAX);
47 /** Get the value of an option, using def if it does not exist */
48 long getInt(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
49 /** Get the value of an option, using def if it does not exist */
50 double getFloat(const std::string& key, double def);
51 /** Get the value of an option, using def if it does not exist */
52 bool getBool(const std::string& key, bool def = false);
54 /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
55 * using a default value if it does not exist or is out of bounds.
56 * @param key The config key name
57 * @param def Default value (optional)
58 * @param min Minimum acceptable value (optional)
59 * @param max Maximum acceptable value (optional)
60 * @return The duration in seconds
62 long getDuration(const std::string& key, long def, long min = LONG_MIN, long max = LONG_MAX);
64 /** Get the value of an option
65 * @param key The option to get
66 * @param value The location to store the value (unmodified if does not exist)
67 * @param allow_newline Allow newlines in the option (normally replaced with spaces)
68 * @return true if the option exists
70 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
72 std::string getTagLocation();
74 inline const ConfigItems& getItems() const { return items; }
76 /** Create a new ConfigTag, giving access to the private ConfigItems item list */
77 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
79 ConfigTag(const std::string& Tag, const std::string& file, int line);
82 /** Defines the server's length limits on various length-limited
83 * items such as topics, nicknames, channel names etc.
88 /** Maximum nickname length */
90 /** Maximum channel length */
92 /** Maximum number of modes per line */
94 /** Maximum length of ident, not including ~ etc */
96 /** Maximum length of a quit message */
98 /** Maximum topic length */
100 /** Maximum kick message length */
102 /** Maximum GECOS (real name) length */
104 /** Maximum away message length */
106 /** Maximum line length */
108 /** Maximum hostname length */
111 /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
112 * @param tag Configuration tag to read the limits from
114 ServerLimits(ConfigTag* tag);
116 /** Maximum length of a n!u\@h mask */
117 size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
120 struct CommandLineConf
122 /** If this value is true, the owner of the
123 * server specified -nofork on the command
124 * line, causing the daemon to stay in the
129 /** If this value if true then all log
130 * messages will be output, regardless of
131 * the level given in the config file.
132 * This is set with the -debug commandline
137 /** If this is true then log output will be
138 * written to the logfile. This is the default.
139 * If you put -nolog on the commandline then
140 * the logfile will not be written.
141 * This is meant to be used in conjunction with
142 * -debug for debugging without filling up the
147 /** Saved argc from startup
151 /** Saved argv from startup
156 class CoreExport OperInfo : public refcountbase
159 TokenList AllowedOperCommands;
160 TokenList AllowedPrivs;
162 /** Allowed user modes from oper classes. */
163 std::bitset<64> AllowedUserModes;
165 /** Allowed channel modes from oper classes. */
166 std::bitset<64> AllowedChanModes;
168 /** \<oper> block used for this oper-up. May be NULL. */
169 reference<ConfigTag> oper_block;
170 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
171 reference<ConfigTag> type_block;
172 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
173 std::vector<reference<ConfigTag> > class_blocks;
174 /** Name of the oper type; i.e. the one shown in WHOIS */
177 /** Creates a new OperInfo with the specified oper type name.
178 * @param Name The name of the oper type.
180 OperInfo(const std::string& Name);
182 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
183 std::string getConfig(const std::string& key);
187 /** This class holds the bulk of the runtime configuration for the ircd.
188 * It allows for reading new config values, accessing configuration files,
189 * and storage of the configuration data needed to run the ircd, such as
190 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
192 class CoreExport ServerConfig
195 void CrossCheckOperClassType();
196 void CrossCheckConnectBlocks(ServerConfig* current);
214 ServerPaths(ConfigTag* tag);
216 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
217 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
218 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
219 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
222 /** Holds a complete list of all connect blocks
224 typedef std::vector<reference<ConnectClass> > ClassVector;
226 /** Index of valid oper blocks and types
228 typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
230 /** Get a configuration tag
231 * @param tag The name of the tag to get
233 ConfigTag* ConfValue(const std::string& tag);
235 ConfigTagList ConfTags(const std::string& tag);
237 /** An empty configuration tag. */
240 /** Error stream, contains error output from any failed configuration parsing.
242 std::stringstream errstr;
244 /** True if this configuration is valid enough to run with */
247 /** Bind to IPv6 by default */
250 /** This holds all the information in the config file,
251 * it's indexed by tag name to a vector of key/values.
253 ConfigDataHash config_data;
255 /** This holds all extra files that have been read in the configuration
256 * (for example, MOTD and RULES files are stored here)
258 ConfigFileCache Files;
260 /** Length limits, see definition of ServerLimits class
264 /** Locations of various types of file (config, module, etc). */
267 /** Configuration parsed from the command line.
269 CommandLineConf cmdline;
271 /** Clones CIDR range for ipv4 (0-32)
272 * Defaults to 32 (checks clones on all IPs seperately)
274 unsigned char c_ipv4_range;
276 /** Clones CIDR range for ipv6 (0-128)
277 * Defaults to 128 (checks on all IPs seperately)
279 unsigned char c_ipv6_range;
281 /** Holds the server name of the local server
282 * as defined by the administrator.
284 std::string ServerName;
286 /** Notice to give to users when they are banned by an XLine
288 std::string XLineMessage;
290 /* Holds the network name the local server
291 * belongs to. This is an arbitary field defined
292 * by the administrator.
296 /** Holds the description of the local server
297 * as defined by the administrator.
299 std::string ServerDesc;
301 /** Pretend disabled commands don't exist.
303 bool DisabledDontExist;
305 /** This variable identifies which usermodes have been diabled.
307 std::bitset<64> DisabledUModes;
309 /** This variable identifies which chanmodes have been disabled.
311 std::bitset<64> DisabledCModes;
313 /** If set to true, then all opers on this server are
314 * shown with a generic 'is an IRC operator' line rather
315 * than the oper type. Oper types are still used internally.
319 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
320 * if banned on any channel, nor to message them.
322 bool RestrictBannedUsers;
324 /** The size of the read() buffer in the user
325 * handling code, used to read data into a user's
330 /** The value to be used for listen() backlogs
335 /** If we should check for clones during CheckClass() in AddUser()
336 * Setting this to false allows to not trigger on maxclones for users
337 * that may belong to another class after DNS-lookup is complete.
338 * It does, however, make the server spend more time on users we may potentially not want.
342 /** The soft limit value assigned to the irc server.
343 * The IRC server will not allow more than this
344 * number of local users.
346 unsigned int SoftLimit;
348 /** Maximum number of targets for a multi target command
349 * such as PRIVMSG or KICK
351 unsigned int MaxTargets;
353 /** True if we're going to hide netsplits as *.net *.split for non-opers
357 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
362 /** True if raw I/O is being logged */
365 /** Set to a non-empty string to obfuscate server names. */
366 std::string HideServer;
368 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
370 std::string HideKillsServer;
372 /** Set to hide kills from clients of ulined servers in snotices.
376 /** The full pathname and filename of the PID
377 * file as defined in the configuration.
381 /** The connect classes in use by the IRC server.
385 /** STATS characters in this list are available
388 std::string UserStats;
390 /** Default channel modes
392 std::string DefaultModes;
394 /** Custom version string, which if defined can replace the system info in VERSION.
396 std::string CustomVersion;
398 /** If set to true, provide syntax hints for unknown commands
402 /** The name of the casemapping method used by this server.
404 std::string CaseMapping;
406 /** If set to true, the CycleHosts mode change will be sourced from the user,
407 * rather than the server
409 bool CycleHostsFromUser;
411 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
412 * for who set the topic last. If false, only the nick is shown.
414 bool FullHostInTopic;
416 /** Oper blocks keyed by their name
418 OperIndex oper_blocks;
420 /** Oper types keyed by their name
424 /** Default value for <connect:maxchans>, deprecated in 3.0
426 unsigned int MaxChans;
428 /** Default value for <oper:maxchans>, deprecated in 3.0
430 unsigned int OperMaxChans;
432 /** TS6-like server ID.
433 * NOTE: 000...999 are usable for InspIRCd servers. This
434 * makes code simpler. 0AA, 1BB etc with letters are reserved
439 /** Construct a new ServerConfig
445 /** Get server ID as string with required leading zeroes
447 const std::string& GetSID() const { return sid; }
449 /** Read the entire configuration into memory
450 * and initialize this class. All other methods
451 * should be used only by the core.
455 /** Apply configuration changes from the old configuration.
457 void Apply(ServerConfig* old, const std::string &useruid);
458 void ApplyModules(User* user);
462 /** Disables the commands specified in <disabled:commands>. */
463 bool ApplyDisabledCommands();
465 /** Escapes a value for storage in a configuration key.
466 * @param str The string to escape.
467 * @param xml Are we using the XML config format?
469 static std::string Escape(const std::string& str, bool xml = true);
471 /** If this value is true, snotices will not stack when repeats are sent
476 /** The background thread for config reading, so that reading from executable includes
479 class CoreExport ConfigReaderThread : public Thread
481 ServerConfig* Config;
484 const std::string TheUserUID;
485 ConfigReaderThread(const std::string &useruid)
486 : Config(new ServerConfig), done(false), TheUserUID(useruid)
490 virtual ~ConfigReaderThread()
495 void Run() CXX11_OVERRIDE;
496 /** Run in the main thread to apply the configuration */
498 bool IsDone() { return done; }
501 class CoreExport ConfigStatus
506 ConfigStatus(User* user = NULL)