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 */
118 /** Creating the class initialises it to the defaults
119 * as in 1.1's ./configure script. Reading other values
120 * from the config will change these values.
122 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12),
123 MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200),
127 struct CommandLineConf
129 /** If this value is true, the owner of the
130 * server specified -nofork on the command
131 * line, causing the daemon to stay in the
136 /** If this value if true then all log
137 * messages will be output, regardless of
138 * the level given in the config file.
139 * This is set with the -debug commandline
144 /** If this is true then log output will be
145 * written to the logfile. This is the default.
146 * If you put -nolog on the commandline then
147 * the logfile will not be written.
148 * This is meant to be used in conjunction with
149 * -debug for debugging without filling up the
154 /** True if we have been told to run the testsuite from the commandline,
155 * rather than entering the mainloop.
159 /** Saved argc from startup
163 /** Saved argv from startup
168 class CoreExport OperInfo : public refcountbase
171 std::set<std::string> AllowedOperCommands;
172 std::set<std::string> AllowedPrivs;
174 /** Allowed user modes from oper classes. */
175 std::bitset<64> AllowedUserModes;
177 /** Allowed channel modes from oper classes. */
178 std::bitset<64> AllowedChanModes;
180 /** \<oper> block used for this oper-up. May be NULL. */
181 reference<ConfigTag> oper_block;
182 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
183 reference<ConfigTag> type_block;
184 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
185 std::vector<reference<ConfigTag> > class_blocks;
186 /** Name of the oper type; i.e. the one shown in WHOIS */
189 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
190 std::string getConfig(const std::string& key);
194 /** This class holds the bulk of the runtime configuration for the ircd.
195 * It allows for reading new config values, accessing configuration files,
196 * and storage of the configuration data needed to run the ircd, such as
197 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
199 class CoreExport ServerConfig
202 void CrossCheckOperClassType();
203 void CrossCheckConnectBlocks(ServerConfig* current);
222 : Config(CONFIG_PATH)
225 , Module(MOD_PATH) { }
227 std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); }
228 std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); }
229 std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); }
230 std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); }
233 /** Get a configuration tag
234 * @param tag The name of the tag to get
236 ConfigTag* ConfValue(const std::string& tag);
238 ConfigTagList ConfTags(const std::string& 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 /** Used to indicate who we announce invites to on a channel */
251 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
252 enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
254 /** This holds all the information in the config file,
255 * it's indexed by tag name to a vector of key/values.
257 ConfigDataHash config_data;
259 /** This holds all extra files that have been read in the configuration
260 * (for example, MOTD and RULES files are stored here)
262 ConfigFileCache Files;
264 /** Length limits, see definition of ServerLimits class
268 /** Locations of various types of file (config, module, etc). */
271 /** Configuration parsed from the command line.
273 CommandLineConf cmdline;
275 /** Clones CIDR range for ipv4 (0-32)
276 * Defaults to 32 (checks clones on all IPs seperately)
280 /** Clones CIDR range for ipv6 (0-128)
281 * Defaults to 128 (checks on all IPs seperately)
285 /** Holds the server name of the local server
286 * as defined by the administrator.
288 std::string ServerName;
290 /** Notice to give to users when they are banned by an XLine
292 std::string XLineMessage;
294 /* Holds the network name the local server
295 * belongs to. This is an arbitary field defined
296 * by the administrator.
300 /** Holds the description of the local server
301 * as defined by the administrator.
303 std::string ServerDesc;
305 /** Holds the admin's name, for output in
306 * the /ADMIN command.
308 std::string AdminName;
310 /** Holds the email address of the admin,
311 * for output in the /ADMIN command.
313 std::string AdminEmail;
315 /** Holds the admin's nickname, for output
316 * in the /ADMIN command
318 std::string AdminNick;
320 /** The admin-configured /DIE password
324 /** The admin-configured /RESTART password
326 std::string restartpass;
328 /** The hash method for *BOTH* the die and restart passwords.
330 std::string powerhash;
332 /** The quit prefix in use, or an empty string
334 std::string PrefixQuit;
336 /** The quit suffix in use, or an empty string
338 std::string SuffixQuit;
340 /** The fixed quit message in use, or an empty string
342 std::string FixedQuit;
344 /** The part prefix in use, or an empty string
346 std::string PrefixPart;
348 /** The part suffix in use, or an empty string
350 std::string SuffixPart;
352 /** The fixed part message in use, or an empty string
354 std::string FixedPart;
356 /** Pretend disabled commands don't exist.
358 bool DisabledDontExist;
360 /** This variable contains a space-seperated list
361 * of commands which are disabled by the
362 * administrator of the server for non-opers.
364 std::string DisabledCommands;
366 /** This variable identifies which usermodes have been diabled.
368 char DisabledUModes[64];
370 /** This variable identifies which chanmodes have been disabled.
372 char DisabledCModes[64];
374 /** If set to true, then all opers on this server are
375 * shown with a generic 'is an IRC operator' line rather
376 * than the oper type. Oper types are still used internally.
380 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
381 * if banned on any channel, nor to message them.
383 bool RestrictBannedUsers;
385 /** If this is set to true, then mode lists (e.g
386 * MODE \#chan b) are hidden from unprivileged
389 bool HideModeLists[256];
391 /** The number of seconds the DNS subsystem
392 * will wait before timing out any request.
396 /** The size of the read() buffer in the user
397 * handling code, used to read data into a user's
402 /** The value to be used for listen() backlogs
407 /** If we should check for clones during CheckClass() in AddUser()
408 * Setting this to false allows to not trigger on maxclones for users
409 * that may belong to another class after DNS-lookup is complete.
410 * It does, however, make the server spend more time on users we may potentially not want.
414 /** The soft limit value assigned to the irc server.
415 * The IRC server will not allow more than this
416 * number of local users.
418 unsigned int SoftLimit;
420 /** Maximum number of targets for a multi target command
421 * such as PRIVMSG or KICK
423 unsigned int MaxTargets;
425 /** True if we're going to hide netsplits as *.net *.split for non-opers
429 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
434 /** Announce invites to the channel with a server notice
436 InviteAnnounceState AnnounceInvites;
438 /** If this is enabled then operators will
439 * see invisible (+i) channels in /whois.
441 OperSpyWhoisState OperSpyWhois;
443 /** True if raw I/O is being logged */
446 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
448 std::string HideWhoisServer;
450 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
452 std::string HideKillsServer;
454 /** The full pathname and filename of the PID
455 * file as defined in the configuration.
459 /** The connect classes in use by the IRC server.
463 /** STATS characters in this list are available
466 std::string UserStats;
468 /** Default channel modes
470 std::string DefaultModes;
472 /** Custom version string, which if defined can replace the system info in VERSION.
474 std::string CustomVersion;
476 /** If set to true, provide syntax hints for unknown commands
480 /** If set to true, the CycleHosts mode change will be sourced from the user,
481 * rather than the server
483 bool CycleHostsFromUser;
485 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
486 * added to the outgoing text for undernet style msg prefixing.
488 bool UndernetMsgPrefix;
490 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
491 * for who set the topic last. If false, only the nick is shown.
493 bool FullHostInTopic;
495 /** Oper blocks keyed by their name
497 OperIndex oper_blocks;
499 /** Oper types keyed by their name
503 /** Max channels per user
505 unsigned int MaxChans;
507 /** Oper max channels per user
509 unsigned int OperMaxChans;
511 /** TS6-like server ID.
512 * NOTE: 000...999 are usable for InspIRCd servers. This
513 * makes code simpler. 0AA, 1BB etc with letters are reserved
518 /** Construct a new ServerConfig
522 /** Get server ID as string with required leading zeroes
524 const std::string& GetSID() const { return sid; }
526 /** Read the entire configuration into memory
527 * and initialize this class. All other methods
528 * should be used only by the core.
532 /** Apply configuration changes from the old configuration.
534 void Apply(ServerConfig* old, const std::string &useruid);
535 void ApplyModules(User* user);
539 bool ApplyDisabledCommands(const std::string& data);
541 /** Escapes a value for storage in a configuration key.
542 * @param str The string to escape.
543 * @param xml Are we using the XML config format?
545 static std::string Escape(const std::string& str, bool xml = true);
547 /** If this value is true, invites will bypass more than just +i
551 /** If this value is true, snotices will not stack when repeats are sent
556 /** The background thread for config reading, so that reading from executable includes
559 class CoreExport ConfigReaderThread : public Thread
561 ServerConfig* Config;
564 const std::string TheUserUID;
565 ConfigReaderThread(const std::string &useruid)
566 : Config(new ServerConfig), done(false), TheUserUID(useruid)
570 virtual ~ConfigReaderThread()
576 /** Run in the main thread to apply the configuration */
578 bool IsDone() { return done; }
581 class CoreExport ConfigStatus
586 ConfigStatus(User* user = NULL)