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"
35 /** Structure representing a single \<tag> in config */
36 class CoreExport ConfigTag : public refcountbase
40 const std::string tag;
41 const std::string src_name;
44 /** Get the value of an option, using def if it does not exist */
45 std::string getString(const std::string& key, const std::string& def = "");
46 /** Get the value of an option, using def if it does not exist */
47 long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
48 /** Get the value of an option, using def if it does not exist */
49 double getFloat(const std::string& key, double def = 0);
50 /** Get the value of an option, using def if it does not exist */
51 bool getBool(const std::string& key, bool def = false);
53 /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format,
54 * using a default value if it does not exist or is out of bounds.
55 * @param key The config key name
56 * @param def Default value (optional)
57 * @param min Minimum acceptable value (optional)
58 * @param max Maximum acceptable value (optional)
59 * @return The duration in seconds
61 long getDuration(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX);
63 /** Get the value of an option
64 * @param key The option to get
65 * @param value The location to store the value (unmodified if does not exist)
66 * @param allow_newline Allow newlines in the option (normally replaced with spaces)
67 * @return true if the option exists
69 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
71 /** Check for an out of range value. If the value falls outside the boundaries a warning is
72 * logged and the value is corrected (set to def).
73 * @param key The key name, used in the warning message
74 * @param res The value to verify and modify if needed
75 * @param def The default value, res will be set to this if (min <= res <= max) doesn't hold true
76 * @param min Minimum accepted value for res
77 * @param max Maximum accepted value for res
79 void CheckRange(const std::string& key, long& res, long def, long min, long max);
81 std::string getTagLocation();
83 inline const ConfigItems& getItems() const { return items; }
85 /** Create a new ConfigTag, giving access to the private ConfigItems item list */
86 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, ConfigItems*& Items);
88 ConfigTag(const std::string& Tag, const std::string& file, int line);
91 /** Defines the server's length limits on various length-limited
92 * items such as topics, nicknames, channel names etc.
97 /** Maximum nickname length */
99 /** Maximum channel length */
101 /** Maximum number of modes per line */
103 /** Maximum length of ident, not including ~ etc */
105 /** Maximum length of a quit message */
107 /** Maximum topic length */
109 /** Maximum kick message length */
111 /** Maximum GECOS (real name) length */
113 /** Maximum away message length */
115 /** Maximum line length */
117 /** Maximum hostname length */
120 /** Read all limits from a config tag. Limits which aren't specified in the tag are set to a default value.
121 * @param tag Configuration tag to read the limits from
123 ServerLimits(ConfigTag* tag);
125 /** Maximum length of a n!u@h mask */
126 size_t GetMaxMask() const { return NickMax + 1 + IdentMax + 1 + MaxHost; }
129 struct CommandLineConf
131 /** If this value is true, the owner of the
132 * server specified -nofork on the command
133 * line, causing the daemon to stay in the
138 /** If this value if true then all log
139 * messages will be output, regardless of
140 * the level given in the config file.
141 * This is set with the -debug commandline
146 /** If this is true then log output will be
147 * written to the logfile. This is the default.
148 * If you put -nolog on the commandline then
149 * the logfile will not be written.
150 * This is meant to be used in conjunction with
151 * -debug for debugging without filling up the
156 /** Saved argc from startup
160 /** Saved argv from startup
165 class CoreExport OperInfo : public refcountbase
168 typedef insp::flat_set<std::string> PrivSet;
169 PrivSet AllowedOperCommands;
170 PrivSet AllowedPrivs;
172 /** Allowed user modes from oper classes. */
173 std::bitset<64> AllowedUserModes;
175 /** Allowed channel modes from oper classes. */
176 std::bitset<64> AllowedChanModes;
178 /** \<oper> block used for this oper-up. May be NULL. */
179 reference<ConfigTag> oper_block;
180 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
181 reference<ConfigTag> type_block;
182 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
183 std::vector<reference<ConfigTag> > class_blocks;
184 /** Name of the oper type; i.e. the one shown in WHOIS */
187 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
188 std::string getConfig(const std::string& key);
192 /** This class holds the bulk of the runtime configuration for the ircd.
193 * It allows for reading new config values, accessing configuration files,
194 * and storage of the configuration data needed to run the ircd, such as
195 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
197 class CoreExport ServerConfig
200 void CrossCheckOperClassType();
201 void CrossCheckConnectBlocks(ServerConfig* current);
220 : Config(INSPIRCD_CONFIG_PATH)
221 , Data(INSPIRCD_DATA_PATH)
222 , Log(INSPIRCD_LOG_PATH)
223 , Module(INSPIRCD_MODULE_PATH) { }
225 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
226 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
227 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
228 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
231 /** Holds a complete list of all connect blocks
233 typedef std::vector<reference<ConnectClass> > ClassVector;
235 /** Index of valid oper blocks and types
237 typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
239 /** Get a configuration tag
240 * @param tag The name of the tag to get
242 ConfigTag* ConfValue(const std::string& tag);
244 ConfigTagList ConfTags(const std::string& tag);
246 /** An empty configuration tag. */
249 /** Error stream, contains error output from any failed configuration parsing.
251 std::stringstream errstr;
253 /** True if this configuration is valid enough to run with */
256 /** Bind to IPv6 by default */
259 /** Used to indicate who we announce invites to on a channel */
260 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
261 enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
263 /** This holds all the information in the config file,
264 * it's indexed by tag name to a vector of key/values.
266 ConfigDataHash config_data;
268 /** This holds all extra files that have been read in the configuration
269 * (for example, MOTD and RULES files are stored here)
271 ConfigFileCache Files;
273 /** Length limits, see definition of ServerLimits class
277 /** Locations of various types of file (config, module, etc). */
280 /** Configuration parsed from the command line.
282 CommandLineConf cmdline;
284 /** Clones CIDR range for ipv4 (0-32)
285 * Defaults to 32 (checks clones on all IPs seperately)
289 /** Clones CIDR range for ipv6 (0-128)
290 * Defaults to 128 (checks on all IPs seperately)
294 /** Holds the server name of the local server
295 * as defined by the administrator.
297 std::string ServerName;
299 /** Notice to give to users when they are banned by an XLine
301 std::string XLineMessage;
303 /* Holds the network name the local server
304 * belongs to. This is an arbitary field defined
305 * by the administrator.
309 /** Holds the description of the local server
310 * as defined by the administrator.
312 std::string ServerDesc;
314 /** Pretend disabled commands don't exist.
316 bool DisabledDontExist;
318 /** This variable contains a space-seperated list
319 * of commands which are disabled by the
320 * administrator of the server for non-opers.
322 std::string DisabledCommands;
324 /** This variable identifies which usermodes have been diabled.
326 char DisabledUModes[64];
328 /** This variable identifies which chanmodes have been disabled.
330 char DisabledCModes[64];
332 /** If set to true, then all opers on this server are
333 * shown with a generic 'is an IRC operator' line rather
334 * than the oper type. Oper types are still used internally.
338 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
339 * if banned on any channel, nor to message them.
341 bool RestrictBannedUsers;
343 /** The number of seconds the DNS subsystem
344 * will wait before timing out any request.
348 /** The size of the read() buffer in the user
349 * handling code, used to read data into a user's
354 /** The value to be used for listen() backlogs
359 /** If we should check for clones during CheckClass() in AddUser()
360 * Setting this to false allows to not trigger on maxclones for users
361 * that may belong to another class after DNS-lookup is complete.
362 * It does, however, make the server spend more time on users we may potentially not want.
366 /** The soft limit value assigned to the irc server.
367 * The IRC server will not allow more than this
368 * number of local users.
370 unsigned int SoftLimit;
372 /** Maximum number of targets for a multi target command
373 * such as PRIVMSG or KICK
375 unsigned int MaxTargets;
377 /** True if we're going to hide netsplits as *.net *.split for non-opers
381 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
386 /** Announce invites to the channel with a server notice
388 InviteAnnounceState AnnounceInvites;
390 /** If this is enabled then operators will
391 * see invisible (+i) channels in /whois.
393 OperSpyWhoisState OperSpyWhois;
395 /** True if raw I/O is being logged */
398 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
400 std::string HideWhoisServer;
402 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
404 std::string HideKillsServer;
406 /** Set to hide kills from clients of ulined servers in snotices.
410 /** The full pathname and filename of the PID
411 * file as defined in the configuration.
415 /** The connect classes in use by the IRC server.
419 /** STATS characters in this list are available
422 std::string UserStats;
424 /** Default channel modes
426 std::string DefaultModes;
428 /** Custom version string, which if defined can replace the system info in VERSION.
430 std::string CustomVersion;
432 /** If set to true, provide syntax hints for unknown commands
436 /** If set to true, the CycleHosts mode change will be sourced from the user,
437 * rather than the server
439 bool CycleHostsFromUser;
441 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
442 * for who set the topic last. If false, only the nick is shown.
444 bool FullHostInTopic;
446 /** Oper blocks keyed by their name
448 OperIndex oper_blocks;
450 /** Oper types keyed by their name
454 /** Default value for <connect:maxchans>, deprecated in 3.0
456 unsigned int MaxChans;
458 /** Default value for <oper:maxchans>, deprecated in 3.0
460 unsigned int OperMaxChans;
462 /** TS6-like server ID.
463 * NOTE: 000...999 are usable for InspIRCd servers. This
464 * makes code simpler. 0AA, 1BB etc with letters are reserved
469 /** Construct a new ServerConfig
475 /** Get server ID as string with required leading zeroes
477 const std::string& GetSID() const { return sid; }
479 /** Read the entire configuration into memory
480 * and initialize this class. All other methods
481 * should be used only by the core.
485 /** Apply configuration changes from the old configuration.
487 void Apply(ServerConfig* old, const std::string &useruid);
488 void ApplyModules(User* user);
492 bool ApplyDisabledCommands(const std::string& data);
494 /** Escapes a value for storage in a configuration key.
495 * @param str The string to escape.
496 * @param xml Are we using the XML config format?
498 static std::string Escape(const std::string& str, bool xml = true);
500 /** If this value is true, snotices will not stack when repeats are sent
505 /** The background thread for config reading, so that reading from executable includes
508 class CoreExport ConfigReaderThread : public Thread
510 ServerConfig* Config;
513 const std::string TheUserUID;
514 ConfigReaderThread(const std::string &useruid)
515 : Config(new ServerConfig), done(false), TheUserUID(useruid)
519 virtual ~ConfigReaderThread()
525 /** Run in the main thread to apply the configuration */
527 bool IsDone() { return done; }
530 class CoreExport ConfigStatus
535 ConfigStatus(User* user = NULL)