1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef INSPIRCD_CONFIGREADER
15 #define INSPIRCD_CONFIGREADER
23 #include "socketengine.h"
26 /* Required forward definitions */
32 /** A cached text file stored with its contents as lines
34 typedef std::vector<std::string> file_cache;
36 /** A configuration key and value pair
38 typedef std::pair<std::string, std::string> KeyVal;
40 struct CoreExport ConfigTag : public refcountbase
42 const std::string tag;
43 const std::string src_name;
45 std::vector<KeyVal> items;
47 ConfigTag(const std::string& Tag, const std::string& file, int line)
48 : tag(Tag), src_name(file), src_line(line) {}
50 std::string getString(const std::string& key, const std::string& def = "");
51 long getInt(const std::string& key, long def = 0);
52 double getFloat(const std::string& key, double def = 0);
53 bool getBool(const std::string& key, bool def = false);
55 bool readString(const std::string& key, std::string& value, bool allow_newline = false);
57 std::string getTagLocation();
60 /** An entire config file, built up of KeyValLists
62 typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
64 typedef std::map<std::string, reference<ConfigTag> > TagIndex;
66 /** Defines the server's length limits on various length-limited
67 * items such as topics, nicknames, channel names etc.
72 /** Maximum nickname length */
74 /** Maximum channel length */
76 /** Maximum number of modes per line */
78 /** Maximum length of ident, not including ~ etc */
80 /** Maximum length of a quit message */
82 /** Maximum topic length */
84 /** Maximum kick message length */
86 /** Maximum GECOS (real name) length */
88 /** Maximum away message length */
91 /** Creating the class initialises it to the defaults
92 * as in 1.1's ./configure script. Reading other values
93 * from the config will change these values.
95 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
99 /** Finalises the settings by adding one. This allows for them to be used as-is
100 * without a 'value+1' when using the std::string assignment methods etc.
115 /** This class holds the bulk of the runtime configuration for the ircd.
116 * It allows for reading new config values, accessing configuration files,
117 * and storage of the configuration data needed to run the ircd, such as
118 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
120 class CoreExport ServerConfig
123 void CrossCheckOperClassType();
124 void CrossCheckConnectBlocks(ServerConfig* current);
128 /** Get a configuration tag
129 * @param tag The name of the tag to get
130 * @param offset get the Nth occurance of the tag
132 ConfigTag* ConfValue(const std::string& tag, int offset = 0);
134 /** Error stream, contains error output from any failed configuration parsing.
136 std::stringstream errstr;
138 /** True if this configuration is valid enough to run with */
141 /** Used to indicate who we announce invites to on a channel */
142 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
144 /** This holds all the information in the config file,
145 * it's indexed by tag name to a vector of key/values.
147 ConfigDataHash config_data;
149 /** Length limits, see definition of ServerLimits class
153 /** Clones CIDR range for ipv4 (0-32)
154 * Defaults to 32 (checks clones on all IPs seperately)
158 /** Clones CIDR range for ipv6 (0-128)
159 * Defaults to 128 (checks on all IPs seperately)
163 /** Max number of WhoWas entries per user.
167 /** Max number of cumulative user-entries in WhoWas.
168 * When max reached and added to, push out oldest entry FIFO style.
172 /** Max seconds a user is kept in WhoWas before being pruned.
176 /** Both for set(g|u)id.
179 std::string SetGroup;
181 /** Holds the server name of the local server
182 * as defined by the administrator.
184 std::string ServerName;
186 /** Notice to give to users when they are Xlined
188 std::string MoronBanner;
190 /* Holds the network name the local server
191 * belongs to. This is an arbitary field defined
192 * by the administrator.
196 /** Holds the description of the local server
197 * as defined by the administrator.
199 std::string ServerDesc;
201 /** Holds the admin's name, for output in
202 * the /ADMIN command.
204 std::string AdminName;
206 /** Holds the email address of the admin,
207 * for output in the /ADMIN command.
209 std::string AdminEmail;
211 /** Holds the admin's nickname, for output
212 * in the /ADMIN command
214 std::string AdminNick;
216 /** The admin-configured /DIE password
220 /** The admin-configured /RESTART password
222 std::string restartpass;
224 /** The hash method for *BOTH* the die and restart passwords.
226 std::string powerhash;
228 /** The pathname and filename of the message of the
229 * day file, as defined by the administrator.
233 /** The pathname and filename of the rules file,
234 * as defined by the administrator.
238 /** The quit prefix in use, or an empty string
240 std::string PrefixQuit;
242 /** The quit suffix in use, or an empty string
244 std::string SuffixQuit;
246 /** The fixed quit message in use, or an empty string
248 std::string FixedQuit;
250 /** The part prefix in use, or an empty string
252 std::string PrefixPart;
254 /** The part suffix in use, or an empty string
256 std::string SuffixPart;
258 /** The fixed part message in use, or an empty string
260 std::string FixedPart;
262 /** The last string found within a <die> tag, or
265 std::string DieValue;
267 /** The DNS server to use for DNS queries
269 std::string DNSServer;
271 /** Pretend disabled commands don't exist.
273 bool DisabledDontExist;
275 /** This variable contains a space-seperated list
276 * of commands which are disabled by the
277 * administrator of the server for non-opers.
279 std::string DisabledCommands;
281 /** This variable identifies which usermodes have been diabled.
284 char DisabledUModes[64];
286 /** This variable identifies which chanmodes have been disabled.
288 char DisabledCModes[64];
290 /** The full path to the modules directory.
291 * This is either set at compile time, or
292 * overridden in the configuration file via
297 /** The file handle of the logfile. If this
298 * value is NULL, the log file is not open,
299 * probably due to a permissions error on
300 * startup (this should not happen in normal
305 /** If this value is true, the owner of the
306 * server specified -nofork on the command
307 * line, causing the daemon to stay in the
312 /** If this value if true then all log
313 * messages will be output, regardless of
314 * the level given in the config file.
315 * This is set with the -debug commandline
320 /** If this is true then log output will be
321 * written to the logfile. This is the default.
322 * If you put -nolog on the commandline then
323 * the logfile will not be written.
324 * This is meant to be used in conjunction with
325 * -debug for debugging without filling up the
330 /** If set to true, then all opers on this server are
331 * shown with a generic 'is an IRC operator' line rather
332 * than the oper type. Oper types are still used internally.
336 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
337 * if banned on any channel, nor to message them.
339 bool RestrictBannedUsers;
341 /** If this value is true, halfops have been
342 * enabled in the configuration file.
346 /** If this is set to true, then mode lists (e.g
347 * MODE #chan b) are hidden from unprivileged
350 bool HideModeLists[256];
352 /** The number of seconds the DNS subsystem
353 * will wait before timing out any request.
357 /** The size of the read() buffer in the user
358 * handling code, used to read data into a user's
363 /** The value to be used for listen() backlogs
368 /** The soft limit value assigned to the irc server.
369 * The IRC server will not allow more than this
370 * number of local users.
372 unsigned int SoftLimit;
374 /** Maximum number of targets for a multi target command
375 * such as PRIVMSG or KICK
377 unsigned int MaxTargets;
379 /** The maximum number of /WHO results allowed
380 * in any single /WHO command.
384 /** True if the DEBUG loglevel is selected.
388 /** How many seconds to wait before exiting
389 * the program when /DIE is correctly issued.
393 /** True if we're going to hide netsplits as *.net *.split for non-opers
397 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
402 /** Announce invites to the channel with a server notice
404 InviteAnnounceState AnnounceInvites;
406 /** If this is enabled then operators will
407 * see invisible (+i) channels in /whois.
411 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
413 std::string HideWhoisServer;
415 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
417 std::string HideKillsServer;
419 /** The MOTD file, cached in a file_cache type.
423 /** The RULES file, cached in a file_cache type.
427 /** The full pathname and filename of the PID
428 * file as defined in the configuration.
432 /** The connect classes in use by the IRC server.
436 /** The 005 tokens of this server (ISUPPORT)
437 * populated/repopulated upon loading or unloading
444 std::vector<std::string> isupport;
446 /** STATS characters in this list are available
449 std::string UserStats;
451 /** The path and filename of the ircd.log file
455 /** Default channel modes
457 std::string DefaultModes;
459 /** Custom version string, which if defined can replace the system info in VERSION.
461 std::string CustomVersion;
463 /** List of u-lined servers
465 std::map<irc::string, bool> ulines;
467 /** Max banlist sizes for channels (the std::string is a glob)
469 std::map<std::string, int> maxbans;
471 /** Directory where the inspircd binary resides
475 /** If set to true, no user DNS lookups are to be performed
479 /** If set to true, provide syntax hints for unknown commands
483 /** If set to true, users appear to quit then rejoin when their hosts change.
484 * This keeps clients synchronized properly.
488 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
489 * added to the outgoing text for undernet style msg prefixing.
491 bool UndernetMsgPrefix;
493 /** If set to true, the full nick!user@host will be shown in the TOPIC command
494 * for who set the topic last. If false, only the nick is shown.
496 bool FullHostInTopic;
498 /** All oper type definitions from the config file
502 /** All oper class definitions from the config file
506 /** Saved argv from startup
510 /** Saved argc from startup
514 /** Max channels per user
516 unsigned int MaxChans;
518 /** Oper max channels per user
520 unsigned int OperMaxChans;
522 /** TS6-like server ID.
523 * NOTE: 000...999 are usable for InspIRCd servers. This
524 * makes code simpler. 0AA, 1BB etc with letters are reserved
529 /** True if we have been told to run the testsuite from the commandline,
530 * rather than entering the mainloop.
534 /** Construct a new ServerConfig
538 /** Get server ID as string with required leading zeroes
540 std::string GetSID();
542 /** Update the 005 vector
546 /** Send the 005 numerics (ISUPPORT) to a user
548 void Send005(User* user);
550 /** Read the entire configuration into memory
551 * and initialize this class. All other methods
552 * should be used only by the core.
556 /** Apply configuration changes from the old configuration.
558 void Apply(ServerConfig* old, const std::string &useruid);
559 void ApplyModules(User* user);
563 /** Read a file into a file_cache object
565 bool ReadFile(file_cache &F, const std::string& fname);
567 /* Returns true if the given string starts with a windows drive letter
569 bool StartsWithWindowsDriveLetter(const std::string &path);
571 bool ApplyDisabledCommands(const std::string& data);
573 /** Clean a filename, stripping the directories (and drives) from string.
574 * @param name Directory to tidy
575 * @return The cleaned filename
577 static const char* CleanFilename(const char* name);
579 /** Check if a file exists.
580 * @param file The full path to a file
581 * @return True if the file exists and is readable.
583 static bool FileExists(const char* file);
585 /** If this value is true, invites will bypass more than just +i