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 time_t getDuration(const std::string& key, time_t 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,
87 std::vector<KeyVal>*&items);
89 ConfigTag(const std::string& Tag, const std::string& file, int line);
92 /** Defines the server's length limits on various length-limited
93 * items such as topics, nicknames, channel names etc.
98 /** Maximum nickname length */
100 /** Maximum channel length */
102 /** Maximum number of modes per line */
104 /** Maximum length of ident, not including ~ etc */
106 /** Maximum length of a quit message */
108 /** Maximum topic length */
110 /** Maximum kick message length */
112 /** Maximum GECOS (real name) length */
114 /** Maximum away message length */
116 /** Maximum line length */
119 /** Creating the class initialises it to the defaults
120 * as in 1.1's ./configure script. Reading other values
121 * from the config will change these values.
123 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12),
124 MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200),
128 struct CommandLineConf
130 /** If this value is true, the owner of the
131 * server specified -nofork on the command
132 * line, causing the daemon to stay in the
137 /** If this value if true then all log
138 * messages will be output, regardless of
139 * the level given in the config file.
140 * This is set with the -debug commandline
145 /** If this is true then log output will be
146 * written to the logfile. This is the default.
147 * If you put -nolog on the commandline then
148 * the logfile will not be written.
149 * This is meant to be used in conjunction with
150 * -debug for debugging without filling up the
155 /** True if we have been told to run the testsuite from the commandline,
156 * rather than entering the mainloop.
160 /** Saved argc from startup
164 /** Saved argv from startup
169 class CoreExport OperInfo : public refcountbase
172 std::set<std::string> AllowedOperCommands;
173 std::set<std::string> AllowedPrivs;
175 /** Allowed user modes from oper classes. */
176 std::bitset<64> AllowedUserModes;
178 /** Allowed channel modes from oper classes. */
179 std::bitset<64> AllowedChanModes;
181 /** \<oper> block used for this oper-up. May be NULL. */
182 reference<ConfigTag> oper_block;
183 /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
184 reference<ConfigTag> type_block;
185 /** \<class> blocks referenced from the \<type> block. These define individual permissions */
186 std::vector<reference<ConfigTag> > class_blocks;
187 /** Name of the oper type; i.e. the one shown in WHOIS */
190 /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */
191 std::string getConfig(const std::string& key);
195 /** This class holds the bulk of the runtime configuration for the ircd.
196 * It allows for reading new config values, accessing configuration files,
197 * and storage of the configuration data needed to run the ircd, such as
198 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
200 class CoreExport ServerConfig
203 void CrossCheckOperClassType();
204 void CrossCheckConnectBlocks(ServerConfig* current);
223 : Config(CONFIG_PATH)
226 , Module(MOD_PATH) { }
228 std::string PrependConfig(const std::string& fn) const { return ServerConfig::ExpandPath(Config, fn); }
229 std::string PrependData(const std::string& fn) const { return ServerConfig::ExpandPath(Data, fn); }
230 std::string PrependLog(const std::string& fn) const { return ServerConfig::ExpandPath(Log, fn); }
231 std::string PrependModule(const std::string& fn) const { return ServerConfig::ExpandPath(Module, fn); }
234 /** Get a configuration tag
235 * @param tag The name of the tag to get
237 ConfigTag* ConfValue(const std::string& tag);
239 ConfigTagList ConfTags(const std::string& tag);
241 /** Error stream, contains error output from any failed configuration parsing.
243 std::stringstream errstr;
245 /** True if this configuration is valid enough to run with */
248 /** Bind to IPv6 by default */
251 /** Used to indicate who we announce invites to on a channel */
252 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
253 enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG };
255 /** This holds all the information in the config file,
256 * it's indexed by tag name to a vector of key/values.
258 ConfigDataHash config_data;
260 /** This holds all extra files that have been read in the configuration
261 * (for example, MOTD and RULES files are stored here)
263 ConfigFileCache Files;
265 /** Length limits, see definition of ServerLimits class
269 /** Locations of various types of file (config, module, etc). */
272 /** Configuration parsed from the command line.
274 CommandLineConf cmdline;
276 /** Clones CIDR range for ipv4 (0-32)
277 * Defaults to 32 (checks clones on all IPs seperately)
281 /** Clones CIDR range for ipv6 (0-128)
282 * Defaults to 128 (checks on all IPs seperately)
286 /** Holds the server name of the local server
287 * as defined by the administrator.
289 std::string ServerName;
291 /** Notice to give to users when they are banned by an XLine
293 std::string XLineMessage;
295 /* Holds the network name the local server
296 * belongs to. This is an arbitary field defined
297 * by the administrator.
301 /** Holds the description of the local server
302 * as defined by the administrator.
304 std::string ServerDesc;
306 /** Holds the admin's name, for output in
307 * the /ADMIN command.
309 std::string AdminName;
311 /** Holds the email address of the admin,
312 * for output in the /ADMIN command.
314 std::string AdminEmail;
316 /** Holds the admin's nickname, for output
317 * in the /ADMIN command
319 std::string AdminNick;
321 /** The admin-configured /DIE password
325 /** The admin-configured /RESTART password
327 std::string restartpass;
329 /** The hash method for *BOTH* the die and restart passwords.
331 std::string powerhash;
333 /** The pathname and filename of the message of the
334 * day file, as defined by the administrator.
338 /** The pathname and filename of the rules file,
339 * as defined by the administrator.
343 /** The quit prefix in use, or an empty string
345 std::string PrefixQuit;
347 /** The quit suffix in use, or an empty string
349 std::string SuffixQuit;
351 /** The fixed quit message in use, or an empty string
353 std::string FixedQuit;
355 /** The part prefix in use, or an empty string
357 std::string PrefixPart;
359 /** The part suffix in use, or an empty string
361 std::string SuffixPart;
363 /** The fixed part message in use, or an empty string
365 std::string FixedPart;
367 /** Pretend disabled commands don't exist.
369 bool DisabledDontExist;
371 /** This variable contains a space-seperated list
372 * of commands which are disabled by the
373 * administrator of the server for non-opers.
375 std::string DisabledCommands;
377 /** This variable identifies which usermodes have been diabled.
379 char DisabledUModes[64];
381 /** This variable identifies which chanmodes have been disabled.
383 char DisabledCModes[64];
385 /** If set to true, then all opers on this server are
386 * shown with a generic 'is an IRC operator' line rather
387 * than the oper type. Oper types are still used internally.
391 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
392 * if banned on any channel, nor to message them.
394 bool RestrictBannedUsers;
396 /** If this is set to true, then mode lists (e.g
397 * MODE \#chan b) are hidden from unprivileged
400 bool HideModeLists[256];
402 /** The number of seconds the DNS subsystem
403 * will wait before timing out any request.
407 /** The size of the read() buffer in the user
408 * handling code, used to read data into a user's
413 /** The value to be used for listen() backlogs
418 /** If we should check for clones during CheckClass() in AddUser()
419 * Setting this to false allows to not trigger on maxclones for users
420 * that may belong to another class after DNS-lookup is complete.
421 * It does, however, make the server spend more time on users we may potentially not want.
425 /** The soft limit value assigned to the irc server.
426 * The IRC server will not allow more than this
427 * number of local users.
429 unsigned int SoftLimit;
431 /** Maximum number of targets for a multi target command
432 * such as PRIVMSG or KICK
434 unsigned int MaxTargets;
436 /** True if we're going to hide netsplits as *.net *.split for non-opers
440 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
445 /** Announce invites to the channel with a server notice
447 InviteAnnounceState AnnounceInvites;
449 /** If this is enabled then operators will
450 * see invisible (+i) channels in /whois.
452 OperSpyWhoisState OperSpyWhois;
454 /** True if raw I/O is being logged */
457 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
459 std::string HideWhoisServer;
461 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
463 std::string HideKillsServer;
465 /** The full pathname and filename of the PID
466 * file as defined in the configuration.
470 /** The connect classes in use by the IRC server.
474 /** STATS characters in this list are available
477 std::string UserStats;
479 /** Default channel modes
481 std::string DefaultModes;
483 /** Custom version string, which if defined can replace the system info in VERSION.
485 std::string CustomVersion;
487 /** List of u-lined servers
489 std::map<irc::string, bool> ulines;
491 /** If set to true, provide syntax hints for unknown commands
495 /** If set to true, the CycleHosts mode change will be sourced from the user,
496 * rather than the server
498 bool CycleHostsFromUser;
500 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
501 * added to the outgoing text for undernet style msg prefixing.
503 bool UndernetMsgPrefix;
505 /** If set to true, the full nick!user\@host will be shown in the TOPIC command
506 * for who set the topic last. If false, only the nick is shown.
508 bool FullHostInTopic;
510 /** Oper block and type index.
511 * For anonymous oper blocks (type only), prefix with a space.
513 OperIndex oper_blocks;
515 /** Max channels per user
517 unsigned int MaxChans;
519 /** Oper max channels per user
521 unsigned int OperMaxChans;
523 /** TS6-like server ID.
524 * NOTE: 000...999 are usable for InspIRCd servers. This
525 * makes code simpler. 0AA, 1BB etc with letters are reserved
530 /** Construct a new ServerConfig
534 /** Get server ID as string with required leading zeroes
536 const std::string& GetSID() const { return sid; }
538 /** Read the entire configuration into memory
539 * and initialize this class. All other methods
540 * should be used only by the core.
544 /** Apply configuration changes from the old configuration.
546 void Apply(ServerConfig* old, const std::string &useruid);
547 void ApplyModules(User* user);
551 /** Returns true if the given string starts with a windows drive letter
553 static bool StartsWithWindowsDriveLetter(const std::string& path);
555 bool ApplyDisabledCommands(const std::string& data);
557 /** Clean a filename, stripping the directories (and drives) from string.
558 * @param name Directory to tidy
559 * @return The cleaned filename
561 static const char* CleanFilename(const char* name);
563 /** Check if a file exists.
564 * @param file The full path to a file
565 * @return True if the file exists and is readable.
567 static bool FileExists(const char* file);
569 /** Expands a path fragment to a full path.
570 * @param base The base path to expand from
571 * @param fragment The path fragment to expand on top of base.
573 static std::string ExpandPath(const std::string& base, const std::string& fragment);
575 /** Escapes a value for storage in a configuration key.
576 * @param str The string to escape.
577 * @param xml Are we using the XML config format?
579 static std::string Escape(const std::string& str, bool xml = true);
581 /** If this value is true, invites will bypass more than just +i
585 /** If this value is true, snotices will not stack when repeats are sent
590 /** The background thread for config reading, so that reading from executable includes
593 class CoreExport ConfigReaderThread : public Thread
595 ServerConfig* Config;
598 const std::string TheUserUID;
599 ConfigReaderThread(const std::string &useruid)
600 : Config(new ServerConfig), done(false), TheUserUID(useruid)
604 virtual ~ConfigReaderThread()
610 /** Run in the main thread to apply the configuration */
612 bool IsDone() { return done; }