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/>.
24 #ifndef INSPIRCD_CONFIGREADER
25 #define INSPIRCD_CONFIGREADER
33 #include "socketengine.h"
36 /** Structure representing a single \<tag> in config */
37 class CoreExport ConfigTag : public refcountbase
39 std::vector<KeyVal> items;
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 = "");
47 /** Get the value of an option, using def if it does not exist */
48 long getInt(const std::string& key, long def = 0);
49 /** Get the value of an option, using def if it does not exist */
50 double getFloat(const std::string& key, double def = 0);
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 of an option
55 * @param key The option to get
56 * @param value The location to store the value (unmodified if does not exist)
57 * @param allow_newline Allow newlines in the option (normally replaced with spaces)
58 * @return true if the option exists
60 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
62 std::string getTagLocation();
64 inline const std::vector<KeyVal>& getItems() const { return items; }
66 /** Create a new ConfigTag, giving access to the private KeyVal item list */
67 static ConfigTag* create(const std::string& Tag, const std::string& file, int line, std::vector<KeyVal>*& Items);
69 ConfigTag(const std::string& Tag, const std::string& file, int line);
72 /** Defines the server's length limits on various length-limited
73 * items such as topics, nicknames, channel names etc.
78 /** Maximum nickname length */
80 /** Maximum channel length */
82 /** Maximum number of modes per line */
84 /** Maximum length of ident, not including ~ etc */
86 /** Maximum length of a quit message */
88 /** Maximum topic length */
90 /** Maximum kick message length */
92 /** Maximum GECOS (real name) length */
94 /** Maximum away message length */
97 /** Creating the class initialises it to the defaults
98 * as in 1.1's ./configure script. Reading other values
99 * from the config will change these values.
101 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
106 struct CommandLineConf
108 /** If this value is true, the owner of the
109 * server specified -nofork on the command
110 * line, causing the daemon to stay in the
115 /** If this value if true then all log
116 * messages will be output, regardless of
117 * the level given in the config file.
118 * This is set with the -debug commandline
123 /** If this is true then log output will be
124 * written to the logfile. This is the default.
125 * If you put -nolog on the commandline then
126 * the logfile will not be written.
127 * This is meant to be used in conjunction with
128 * -debug for debugging without filling up the
133 /** True if we have been told to run the testsuite from the commandline,
134 * rather than entering the mainloop.
138 /** Saved argc from startup
142 /** Saved argv from startup
146 std::string startup_log;
149 class CoreExport OperInfo : public refcountbase
152 std::set<std::string> AllowedOperCommands;
153 std::set<std::string> AllowedPrivs;
155 /** Allowed user modes from oper classes. */
156 std::bitset<64> AllowedUserModes;
158 /** Allowed channel modes from oper classes. */
159 std::bitset<64> AllowedChanModes;
161 /** \<oper> block used for this oper-up. May be NULL. */
162 reference<ConfigTag> oper_block;
163 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
164 reference<ConfigTag> type_block;
165 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
166 std::vector<reference<ConfigTag> > class_blocks;
167 /** Name of the oper type; i.e. the one shown in WHOIS */
170 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
171 std::string getConfig(const std::string& key);
174 inline const char* NameStr()
176 return irc::Spacify(name.c_str());
180 /** This class holds the bulk of the runtime configuration for the ircd.
181 * It allows for reading new config values, accessing configuration files,
182 * and storage of the configuration data needed to run the ircd, such as
183 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
185 class CoreExport ServerConfig
188 void CrossCheckOperClassType();
189 void CrossCheckConnectBlocks(ServerConfig* current);
193 /** Get a configuration tag
194 * @param tag The name of the tag to get
196 ConfigTag* ConfValue(const std::string& tag);
198 ConfigTagList ConfTags(const std::string& tag);
200 /** Error stream, contains error output from any failed configuration parsing.
202 std::stringstream errstr;
204 /** True if this configuration is valid enough to run with */
207 /** Bind to IPv6 by default */
210 /** Used to indicate who we announce invites to on a channel */
211 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
212 enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
214 /** This holds all the information in the config file,
215 * it's indexed by tag name to a vector of key/values.
217 ConfigDataHash config_data;
219 /** This holds all extra files that have been read in the configuration
220 * (for example, MOTD and RULES files are stored here)
222 ConfigFileCache Files;
224 /** Length limits, see definition of ServerLimits class
228 /** Configuration parsed from the command line.
230 CommandLineConf cmdline;
232 /** Clones CIDR range for ipv4 (0-32)
233 * Defaults to 32 (checks clones on all IPs seperately)
237 /** Clones CIDR range for ipv6 (0-128)
238 * Defaults to 128 (checks on all IPs seperately)
242 /** Max number of WhoWas entries per user.
246 /** Max number of cumulative user-entries in WhoWas.
247 * When max reached and added to, push out oldest entry FIFO style.
251 /** Max seconds a user is kept in WhoWas before being pruned.
255 /** Holds the server name of the local server
256 * as defined by the administrator.
258 std::string ServerName;
260 /** Notice to give to users when they are Xlined
262 std::string MoronBanner;
264 /* Holds the network name the local server
265 * belongs to. This is an arbitary field defined
266 * by the administrator.
270 /** Holds the description of the local server
271 * as defined by the administrator.
273 std::string ServerDesc;
275 /** Holds the admin's name, for output in
276 * the /ADMIN command.
278 std::string AdminName;
280 /** Holds the email address of the admin,
281 * for output in the /ADMIN command.
283 std::string AdminEmail;
285 /** Holds the admin's nickname, for output
286 * in the /ADMIN command
288 std::string AdminNick;
290 /** The admin-configured /DIE password
294 /** The admin-configured /RESTART password
296 std::string restartpass;
298 /** The hash method for *BOTH* the die and restart passwords.
300 std::string powerhash;
302 /** The pathname and filename of the message of the
303 * day file, as defined by the administrator.
307 /** The pathname and filename of the rules file,
308 * as defined by the administrator.
312 /** The quit prefix in use, or an empty string
314 std::string PrefixQuit;
316 /** The quit suffix in use, or an empty string
318 std::string SuffixQuit;
320 /** The fixed quit message in use, or an empty string
322 std::string FixedQuit;
324 /** The part prefix in use, or an empty string
326 std::string PrefixPart;
328 /** The part suffix in use, or an empty string
330 std::string SuffixPart;
332 /** The fixed part message in use, or an empty string
334 std::string FixedPart;
336 /** The DNS server to use for DNS queries
338 std::string DNSServer;
340 /** Pretend disabled commands don't exist.
342 bool DisabledDontExist;
344 /** This variable contains a space-seperated list
345 * of commands which are disabled by the
346 * administrator of the server for non-opers.
348 std::string DisabledCommands;
350 /** This variable identifies which usermodes have been diabled.
352 char DisabledUModes[64];
354 /** This variable identifies which chanmodes have been disabled.
356 char DisabledCModes[64];
358 /** The full path to the modules directory.
359 * This is either set at compile time, or
360 * overridden in the configuration file via
365 /** If set to true, then all opers on this server are
366 * shown with a generic 'is an IRC operator' line rather
367 * than the oper type. Oper types are still used internally.
371 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
372 * if banned on any channel, nor to message them.
374 bool RestrictBannedUsers;
376 /** If this is set to true, then mode lists (e.g
377 * MODE \#chan b) are hidden from unprivileged
380 bool HideModeLists[256];
382 /** The number of seconds the DNS subsystem
383 * will wait before timing out any request.
387 /** The size of the read() buffer in the user
388 * handling code, used to read data into a user's
393 /** The value to be used for listen() backlogs
398 /** The soft limit value assigned to the irc server.
399 * The IRC server will not allow more than this
400 * number of local users.
402 unsigned int SoftLimit;
404 /** Maximum number of targets for a multi target command
405 * such as PRIVMSG or KICK
407 unsigned int MaxTargets;
409 /** True if we're going to hide netsplits as *.net *.split for non-opers
413 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
418 /** Announce invites to the channel with a server notice
420 InviteAnnounceState AnnounceInvites;
422 /** If this is enabled then operators will
423 * see invisible (+i) channels in /whois.
425 OperSpyWhoisState OperSpyWhois;
427 /** True if raw I/O is being logged */
430 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
432 std::string HideWhoisServer;
434 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
436 std::string HideKillsServer;
438 /** The full pathname and filename of the PID
439 * file as defined in the configuration.
443 /** The connect classes in use by the IRC server.
447 /** The 005 tokens of this server (ISUPPORT)
448 * populated/repopulated upon loading or unloading
455 std::vector<std::string> isupport;
457 /** STATS characters in this list are available
460 std::string UserStats;
462 /** Default channel modes
464 std::string DefaultModes;
466 /** Custom version string, which if defined can replace the system info in VERSION.
468 std::string CustomVersion;
470 /** List of u-lined servers
472 std::map<irc::string, bool> ulines;
474 /** Max banlist sizes for channels (the std::string is a glob)
476 std::map<std::string, int> maxbans;
478 /** If set to true, no user DNS lookups are to be performed
482 /** If set to true, provide syntax hints for unknown commands
486 /** If set to true, users appear to quit then rejoin when their hosts change.
487 * This keeps clients synchronized properly.
491 /** If set to true, the CycleHosts mode change will be sourced from the user,
492 * rather than the server
494 bool CycleHostsFromUser;
496 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
497 * added to the outgoing text for undernet style msg prefixing.
499 bool UndernetMsgPrefix;
501 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
502 * for who set the topic last. If false, only the nick is shown.
504 bool FullHostInTopic;
506 /** Oper block and type index.
507 * For anonymous oper blocks (type only), prefix with a space.
509 OperIndex oper_blocks;
511 /** Max channels per user
513 unsigned int MaxChans;
515 /** Oper max channels per user
517 unsigned int OperMaxChans;
519 /** TS6-like server ID.
520 * NOTE: 000...999 are usable for InspIRCd servers. This
521 * makes code simpler. 0AA, 1BB etc with letters are reserved
526 /** Construct a new ServerConfig
530 /** Get server ID as string with required leading zeroes
532 const std::string& GetSID();
534 /** Update the 005 vector
538 /** Send the 005 numerics (ISUPPORT) to a user
540 void Send005(User* user);
542 /** Read the entire configuration into memory
543 * and initialize this class. All other methods
544 * should be used only by the core.
548 /** Apply configuration changes from the old configuration.
550 void Apply(ServerConfig* old, const std::string &useruid);
551 void ApplyModules(User* user);
555 /** Returns true if the given string starts with a windows drive letter
557 bool StartsWithWindowsDriveLetter(const std::string &path);
559 bool ApplyDisabledCommands(const std::string& data);
561 /** Clean a filename, stripping the directories (and drives) from string.
562 * @param name Directory to tidy
563 * @return The cleaned filename
565 static const char* CleanFilename(const char* name);
567 /** Check if a file exists.
568 * @param file The full path to a file
569 * @return True if the file exists and is readable.
571 static bool FileExists(const char* file);
573 /** If this value is true, invites will bypass more than just +i
577 /** If this value is true, snotices will not stack when repeats are sent
581 /** If true, a "Welcome to <networkname>!" NOTICE will be sent to
587 /** The background thread for config reading, so that reading from executable includes
590 class CoreExport ConfigReaderThread : public Thread
592 ServerConfig* Config;
595 const std::string TheUserUID;
596 ConfigReaderThread(const std::string &useruid)
597 : Config(new ServerConfig), done(false), TheUserUID(useruid)
601 virtual ~ConfigReaderThread()
607 /** Run in the main thread to apply the configuration */
609 bool IsDone() { return done; }