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
38 std::vector<KeyVal> items;
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 std::vector<KeyVal>& getItems() const { return items; }
85 /** Create a new ConfigTag, giving access to the private KeyVal item list */
86 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector<KeyVal>*& 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);
126 struct CommandLineConf
128 /** If this value is true, the owner of the
129 * server specified -nofork on the command
130 * line, causing the daemon to stay in the
135 /** If this value if true then all log
136 * messages will be output, regardless of
137 * the level given in the config file.
138 * This is set with the -debug commandline
143 /** If this is true then log output will be
144 * written to the logfile. This is the default.
145 * If you put -nolog on the commandline then
146 * the logfile will not be written.
147 * This is meant to be used in conjunction with
148 * -debug for debugging without filling up the
153 /** Saved argc from startup
157 /** Saved argv from startup
162 class CoreExport OperInfo : public refcountbase
165 typedef insp::flat_set<std::string> PrivSet;
166 PrivSet AllowedOperCommands;
167 PrivSet AllowedPrivs;
169 /** Allowed user modes from oper classes. */
170 std::bitset<64> AllowedUserModes;
172 /** Allowed channel modes from oper classes. */
173 std::bitset<64> AllowedChanModes;
175 /** \<oper> block used for this oper-up. May be NULL. */
176 reference<ConfigTag> oper_block;
177 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
178 reference<ConfigTag> type_block;
179 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
180 std::vector<reference<ConfigTag> > class_blocks;
181 /** Name of the oper type; i.e. the one shown in WHOIS */
184 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
185 std::string getConfig(const std::string& key);
189 /** This class holds the bulk of the runtime configuration for the ircd.
190 * It allows for reading new config values, accessing configuration files,
191 * and storage of the configuration data needed to run the ircd, such as
192 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
194 class CoreExport ServerConfig
197 void CrossCheckOperClassType();
198 void CrossCheckConnectBlocks(ServerConfig* current);
217 : Config(INSPIRCD_CONFIG_PATH)
218 , Data(INSPIRCD_DATA_PATH)
219 , Log(INSPIRCD_LOG_PATH)
220 , Module(INSPIRCD_MODULE_PATH) { }
222 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
223 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
224 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
225 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
228 /** Holds a complete list of all connect blocks
230 typedef std::vector<reference<ConnectClass> > ClassVector;
232 /** Index of valid oper blocks and types
234 typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
236 /** Get a configuration tag
237 * @param tag The name of the tag to get
239 ConfigTag* ConfValue(const std::string& tag);
241 ConfigTagList ConfTags(const std::string& tag);
243 /** An empty configuration tag. */
246 /** Error stream, contains error output from any failed configuration parsing.
248 std::stringstream errstr;
250 /** True if this configuration is valid enough to run with */
253 /** Bind to IPv6 by default */
256 /** Used to indicate who we announce invites to on a channel */
257 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
258 enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
260 /** This holds all the information in the config file,
261 * it's indexed by tag name to a vector of key/values.
263 ConfigDataHash config_data;
265 /** This holds all extra files that have been read in the configuration
266 * (for example, MOTD and RULES files are stored here)
268 ConfigFileCache Files;
270 /** Length limits, see definition of ServerLimits class
274 /** Locations of various types of file (config, module, etc). */
277 /** Configuration parsed from the command line.
279 CommandLineConf cmdline;
281 /** Clones CIDR range for ipv4 (0-32)
282 * Defaults to 32 (checks clones on all IPs seperately)
286 /** Clones CIDR range for ipv6 (0-128)
287 * Defaults to 128 (checks on all IPs seperately)
291 /** Holds the server name of the local server
292 * as defined by the administrator.
294 std::string ServerName;
296 /** Notice to give to users when they are banned by an XLine
298 std::string XLineMessage;
300 /* Holds the network name the local server
301 * belongs to. This is an arbitary field defined
302 * by the administrator.
306 /** Holds the description of the local server
307 * as defined by the administrator.
309 std::string ServerDesc;
311 /** Pretend disabled commands don't exist.
313 bool DisabledDontExist;
315 /** This variable contains a space-seperated list
316 * of commands which are disabled by the
317 * administrator of the server for non-opers.
319 std::string DisabledCommands;
321 /** This variable identifies which usermodes have been diabled.
323 char DisabledUModes[64];
325 /** This variable identifies which chanmodes have been disabled.
327 char DisabledCModes[64];
329 /** If set to true, then all opers on this server are
330 * shown with a generic 'is an IRC operator' line rather
331 * than the oper type. Oper types are still used internally.
335 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
336 * if banned on any channel, nor to message them.
338 bool RestrictBannedUsers;
340 /** The number of seconds the DNS subsystem
341 * will wait before timing out any request.
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 /** True if we're going to hide netsplits as *.net *.split for non-opers
378 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
383 /** Announce invites to the channel with a server notice
385 InviteAnnounceState AnnounceInvites;
387 /** If this is enabled then operators will
388 * see invisible (+i) channels in /whois.
390 OperSpyWhoisState OperSpyWhois;
392 /** True if raw I/O is being logged */
395 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
397 std::string HideWhoisServer;
399 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
401 std::string HideKillsServer;
403 /** The full pathname and filename of the PID
404 * file as defined in the configuration.
408 /** The connect classes in use by the IRC server.
412 /** STATS characters in this list are available
415 std::string UserStats;
417 /** Default channel modes
419 std::string DefaultModes;
421 /** Custom version string, which if defined can replace the system info in VERSION.
423 std::string CustomVersion;
425 /** If set to true, provide syntax hints for unknown commands
429 /** If set to true, the CycleHosts mode change will be sourced from the user,
430 * rather than the server
432 bool CycleHostsFromUser;
434 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
435 * added to the outgoing text for undernet style msg prefixing.
437 bool UndernetMsgPrefix;
439 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
440 * for who set the topic last. If false, only the nick is shown.
442 bool FullHostInTopic;
444 /** Oper blocks keyed by their name
446 OperIndex oper_blocks;
448 /** Oper types keyed by their name
452 /** Default value for <connect:maxchans>, deprecated in 2.2
454 unsigned int MaxChans;
456 /** Default value for <oper:maxchans>, deprecated in 2.2
458 unsigned int OperMaxChans;
460 /** TS6-like server ID.
461 * NOTE: 000...999 are usable for InspIRCd servers. This
462 * makes code simpler. 0AA, 1BB etc with letters are reserved
467 /** Construct a new ServerConfig
473 /** Get server ID as string with required leading zeroes
475 const std::string& GetSID() const { return sid; }
477 /** Read the entire configuration into memory
478 * and initialize this class. All other methods
479 * should be used only by the core.
483 /** Apply configuration changes from the old configuration.
485 void Apply(ServerConfig* old, const std::string &useruid);
486 void ApplyModules(User* user);
490 bool ApplyDisabledCommands(const std::string& data);
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, invites will bypass more than just +i
502 /** If this value is true, snotices will not stack when repeats are sent
507 /** The background thread for config reading, so that reading from executable includes
510 class CoreExport ConfigReaderThread : public Thread
512 ServerConfig* Config;
515 const std::string TheUserUID;
516 ConfigReaderThread(const std::string &useruid)
517 : Config(new ServerConfig), done(false), TheUserUID(useruid)
521 virtual ~ConfigReaderThread()
527 /** Run in the main thread to apply the configuration */
529 bool IsDone() { return done; }
532 class CoreExport ConfigStatus
537 ConfigStatus(User* user = NULL)