X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=a46f9cf95ce2bb5b370f0b85062bb2fa7538d069;hb=02830985a18950497003f3392cf8d6cc30c15c50;hp=553f49d60e09d814623c4211f978f75f5fe35835;hpb=a2cb0fcf3688ad5729a4c42875553f66b0af3045;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 553f49d60..a46f9cf95 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,18 +1,27 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2006-2008 Craig Edwards + * Copyright (C) 2006-2008 Robin Burchell + * Copyright (C) 2006 Oliver Lupton * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef INSPIRCD_CONFIGREADER -#define INSPIRCD_CONFIGREADER + +#pragma once #include #include @@ -23,45 +32,62 @@ #include "socketengine.h" #include "socket.h" -/* Required forward definitions */ -class ServerConfig; -class ServerLimits; -class InspIRCd; -class BufferedSocket; - -/** A cached text file stored with its contents as lines - */ -typedef std::vector file_cache; - -/** A configuration key and value pair - */ -typedef std::pair KeyVal; - -struct CoreExport ConfigTag : public refcountbase +/** Structure representing a single \ in config */ +class CoreExport ConfigTag : public refcountbase { + std::vector items; + public: const std::string tag; const std::string src_name; const int src_line; - std::vector items; - - ConfigTag(const std::string& Tag, const std::string& file, int line) - : tag(Tag), src_name(file), src_line(line) {} + /** Get the value of an option, using def if it does not exist */ std::string getString(const std::string& key, const std::string& def = ""); - long getInt(const std::string& key, long def = 0); + /** Get the value of an option, using def if it does not exist */ + long getInt(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX); + /** Get the value of an option, using def if it does not exist */ double getFloat(const std::string& key, double def = 0); + /** Get the value of an option, using def if it does not exist */ bool getBool(const std::string& key, bool def = false); + /** Get the value in seconds of a duration that is in the user-friendly "1h2m3s" format, + * using a default value if it does not exist or is out of bounds. + * @param key The config key name + * @param def Default value (optional) + * @param min Minimum acceptable value (optional) + * @param max Maximum acceptable value (optional) + * @return The duration in seconds + */ + long getDuration(const std::string& key, long def = 0, long min = LONG_MIN, long max = LONG_MAX); + + /** Get the value of an option + * @param key The option to get + * @param value The location to store the value (unmodified if does not exist) + * @param allow_newline Allow newlines in the option (normally replaced with spaces) + * @return true if the option exists + */ bool readString(const std::string& key, std::string& value, bool allow_newline = false); + /** Check for an out of range value. If the value falls outside the boundaries a warning is + * logged and the value is corrected (set to def). + * @param key The key name, used in the warning message + * @param res The value to verify and modify if needed + * @param def The default value, res will be set to this if (min <= res <= max) doesn't hold true + * @param min Minimum accepted value for res + * @param max Maximum accepted value for res + */ + void CheckRange(const std::string& key, long& res, long def, long min, long max); + std::string getTagLocation(); -}; -/** An entire config file, built up of KeyValLists - */ -typedef std::multimap > ConfigDataHash; + inline const std::vector& getItems() const { return items; } -typedef std::map > TagIndex; + /** Create a new ConfigTag, giving access to the private KeyVal item list */ + static ConfigTag* create(const std::string& Tag, const std::string& file, int line, + std::vector*&items); + private: + ConfigTag(const std::string& Tag, const std::string& file, int line); +}; /** Defines the server's length limits on various length-limited * items such as topics, nicknames, channel names etc. @@ -87,29 +113,83 @@ class ServerLimits size_t MaxGecos; /** Maximum away message length */ size_t MaxAway; + /** Maximum line length */ + size_t MaxLine; /** Creating the class initialises it to the defaults * as in 1.1's ./configure script. Reading other values * from the config will change these values. */ - ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200) - { - } + ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), + MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200), + MaxLine(512) { } +}; - /** Finalises the settings by adding one. This allows for them to be used as-is - * without a 'value+1' when using the std::string assignment methods etc. +struct CommandLineConf +{ + /** If this value is true, the owner of the + * server specified -nofork on the command + * line, causing the daemon to stay in the + * foreground. */ - void Finalise() - { - NickMax++; - ChanMax++; - IdentMax++; - MaxQuit++; - MaxTopic++; - MaxKick++; - MaxGecos++; - MaxAway++; - } + bool nofork; + + /** If this value if true then all log + * messages will be output, regardless of + * the level given in the config file. + * This is set with the -debug commandline + * option. + */ + bool forcedebug; + + /** If this is true then log output will be + * written to the logfile. This is the default. + * If you put -nolog on the commandline then + * the logfile will not be written. + * This is meant to be used in conjunction with + * -debug for debugging without filling up the + * hard disk. + */ + bool writelog; + + /** True if we have been told to run the testsuite from the commandline, + * rather than entering the mainloop. + */ + bool TestSuite; + + /** Saved argc from startup + */ + int argc; + + /** Saved argv from startup + */ + char** argv; +}; + +class CoreExport OperInfo : public refcountbase +{ + public: + std::set AllowedOperCommands; + std::set AllowedPrivs; + + /** Allowed user modes from oper classes. */ + std::bitset<64> AllowedUserModes; + + /** Allowed channel modes from oper classes. */ + std::bitset<64> AllowedChanModes; + + /** \ block used for this oper-up. May be NULL. */ + reference oper_block; + /** \ block used for this oper-up. Valid for local users, may be NULL on remote */ + reference type_block; + /** \ blocks referenced from the \ block. These define individual permissions */ + std::vector > class_blocks; + /** Name of the oper type; i.e. the one shown in WHOIS */ + std::string name; + + /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */ + std::string getConfig(const std::string& key); + void init(); }; /** This class holds the bulk of the runtime configuration for the ircd. @@ -117,13 +197,47 @@ class ServerLimits * and storage of the configuration data needed to run the ircd, such as * the servername, connect classes, /ADMIN data, MOTDs and filenames etc. */ -class CoreExport ServerConfig : public classbase +class CoreExport ServerConfig { private: void CrossCheckOperClassType(); void CrossCheckConnectBlocks(ServerConfig* current); public: + class ServerPaths + { + public: + /** Config path */ + std::string Config; + + /** Data path */ + std::string Data; + + /** Log path */ + std::string Log; + + /** Module path */ + std::string Module; + + ServerPaths() + : Config(CONFIG_PATH) + , Data(DATA_PATH) + , Log(LOG_PATH) + , Module(MOD_PATH) { } + + std::string PrependConfig(const std::string& fn) const { return FileSystem::ExpandPath(Config, fn); } + std::string PrependData(const std::string& fn) const { return FileSystem::ExpandPath(Data, fn); } + std::string PrependLog(const std::string& fn) const { return FileSystem::ExpandPath(Log, fn); } + std::string PrependModule(const std::string& fn) const { return FileSystem::ExpandPath(Module, fn); } + }; + + /** Get a configuration tag + * @param tag The name of the tag to get + */ + ConfigTag* ConfValue(const std::string& tag); + + ConfigTagList ConfTags(const std::string& tag); + /** Error stream, contains error output from any failed configuration parsing. */ std::stringstream errstr; @@ -131,22 +245,34 @@ class CoreExport ServerConfig : public classbase /** True if this configuration is valid enough to run with */ bool valid; + /** Bind to IPv6 by default */ + bool WildcardIPv6; + /** Used to indicate who we announce invites to on a channel */ enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC }; - - /** Not used any more as it is named, can probably be removed or renamed. - */ - int DoDownloads(); + enum OperSpyWhoisState { SPYWHOIS_NONE, SPYWHOIS_SINGLEMSG, SPYWHOIS_SPLITMSG }; /** This holds all the information in the config file, * it's indexed by tag name to a vector of key/values. */ ConfigDataHash config_data; + /** This holds all extra files that have been read in the configuration + * (for example, MOTD and RULES files are stored here) + */ + ConfigFileCache Files; + /** Length limits, see definition of ServerLimits class */ ServerLimits Limits; + /** Locations of various types of file (config, module, etc). */ + ServerPaths Paths; + + /** Configuration parsed from the command line. + */ + CommandLineConf cmdline; + /** Clones CIDR range for ipv4 (0-32) * Defaults to 32 (checks clones on all IPs seperately) */ @@ -157,32 +283,14 @@ class CoreExport ServerConfig : public classbase */ int c_ipv6_range; - /** Max number of WhoWas entries per user. - */ - int WhoWasGroupSize; - - /** Max number of cumulative user-entries in WhoWas. - * When max reached and added to, push out oldest entry FIFO style. - */ - int WhoWasMaxGroups; - - /** Max seconds a user is kept in WhoWas before being pruned. - */ - int WhoWasMaxKeep; - - /** Both for set(g|u)id. - */ - std::string SetUser; - std::string SetGroup; - /** Holds the server name of the local server * as defined by the administrator. */ std::string ServerName; - /** Notice to give to users when they are Xlined + /** Notice to give to users when they are banned by an XLine */ - std::string MoronBanner; + std::string XLineMessage; /* Holds the network name the local server * belongs to. This is an arbitary field defined @@ -256,15 +364,6 @@ class CoreExport ServerConfig : public classbase */ std::string FixedPart; - /** The last string found within a tag, or - * an empty string. - */ - std::string DieValue; - - /** The DNS server to use for DNS queries - */ - std::string DNSServer; - /** Pretend disabled commands don't exist. */ bool DisabledDontExist; @@ -277,53 +376,12 @@ class CoreExport ServerConfig : public classbase /** This variable identifies which usermodes have been diabled. */ - char DisabledUModes[64]; /** This variable identifies which chanmodes have been disabled. */ char DisabledCModes[64]; - /** The full path to the modules directory. - * This is either set at compile time, or - * overridden in the configuration file via - * the tag. - */ - std::string ModPath; - - /** The file handle of the logfile. If this - * value is NULL, the log file is not open, - * probably due to a permissions error on - * startup (this should not happen in normal - * operation!). - */ - FILE *log_file; - - /** If this value is true, the owner of the - * server specified -nofork on the command - * line, causing the daemon to stay in the - * foreground. - */ - bool nofork; - - /** If this value if true then all log - * messages will be output, regardless of - * the level given in the config file. - * This is set with the -debug commandline - * option. - */ - bool forcedebug; - - /** If this is true then log output will be - * written to the logfile. This is the default. - * If you put -nolog on the commandline then - * the logfile will not be written. - * This is meant to be used in conjunction with - * -debug for debugging without filling up the - * hard disk. - */ - bool writelog; - /** If set to true, then all opers on this server are * shown with a generic 'is an IRC operator' line rather * than the oper type. Oper types are still used internally. @@ -335,13 +393,8 @@ class CoreExport ServerConfig : public classbase */ bool RestrictBannedUsers; - /** If this value is true, halfops have been - * enabled in the configuration file. - */ - bool AllowHalfop; - /** If this is set to true, then mode lists (e.g - * MODE #chan b) are hidden from unprivileged + * MODE \#chan b) are hidden from unprivileged * users. */ bool HideModeLists[256]; @@ -362,6 +415,13 @@ class CoreExport ServerConfig : public classbase */ int MaxConn; + /** If we should check for clones during CheckClass() in AddUser() + * Setting this to false allows to not trigger on maxclones for users + * that may belong to another class after DNS-lookup is complete. + * It does, however, make the server spend more time on users we may potentially not want. + */ + bool CCOnConnect; + /** The soft limit value assigned to the irc server. * The IRC server will not allow more than this * number of local users. @@ -373,20 +433,6 @@ class CoreExport ServerConfig : public classbase */ unsigned int MaxTargets; - /** The maximum number of /WHO results allowed - * in any single /WHO command. - */ - int MaxWhoResults; - - /** True if the DEBUG loglevel is selected. - */ - int debugging; - - /** How many seconds to wait before exiting - * the program when /DIE is correctly issued. - */ - int DieDelay; - /** True if we're going to hide netsplits as *.net *.split for non-opers */ bool HideSplits; @@ -403,7 +449,10 @@ class CoreExport ServerConfig : public classbase /** If this is enabled then operators will * see invisible (+i) channels in /whois. */ - bool OperSpyWhois; + OperSpyWhoisState OperSpyWhois; + + /** True if raw I/O is being logged */ + bool RawLog; /** Set to a non-empty string to obfuscate the server name of users in WHOIS */ @@ -413,14 +462,6 @@ class CoreExport ServerConfig : public classbase */ std::string HideKillsServer; - /** The MOTD file, cached in a file_cache type. - */ - file_cache MOTD; - - /** The RULES file, cached in a file_cache type. - */ - file_cache RULES; - /** The full pathname and filename of the PID * file as defined in the configuration. */ @@ -430,25 +471,11 @@ class CoreExport ServerConfig : public classbase */ ClassVector Classes; - /** The 005 tokens of this server (ISUPPORT) - * populated/repopulated upon loading or unloading - * modules. - */ - std::string data005; - - /** isupport strings - */ - std::vector isupport; - /** STATS characters in this list are available * only to operators. */ std::string UserStats; - /** The path and filename of the ircd.log file - */ - std::string logpath; - /** Default channel modes */ std::string DefaultModes; @@ -461,52 +488,32 @@ class CoreExport ServerConfig : public classbase */ std::map ulines; - /** Max banlist sizes for channels (the std::string is a glob) - */ - std::map maxbans; - - /** Directory where the inspircd binary resides - */ - std::string MyDir; - - /** If set to true, no user DNS lookups are to be performed - */ - bool NoUserDns; - /** If set to true, provide syntax hints for unknown commands */ bool SyntaxHints; - /** If set to true, users appear to quit then rejoin when their hosts change. - * This keeps clients synchronized properly. + /** If set to true, the CycleHosts mode change will be sourced from the user, + * rather than the server */ - bool CycleHosts; + bool CycleHostsFromUser; /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix * added to the outgoing text for undernet style msg prefixing. */ bool UndernetMsgPrefix; - /** If set to true, the full nick!user@host will be shown in the TOPIC command + /** If set to true, the full nick!user\@host will be shown in the TOPIC command * for who set the topic last. If false, only the nick is shown. */ bool FullHostInTopic; - /** All oper type definitions from the config file - */ - TagIndex opertypes; - - /** All oper class definitions from the config file - */ - TagIndex operclass; - - /** Saved argv from startup + /** Oper blocks keyed by their name */ - char** argv; + OperIndex oper_blocks; - /** Saved argc from startup + /** Oper types keyed by their name */ - int argc; + OperIndex OperTypes; /** Max channels per user */ @@ -523,26 +530,13 @@ class CoreExport ServerConfig : public classbase */ std::string sid; - /** True if we have been told to run the testsuite from the commandline, - * rather than entering the mainloop. - */ - bool TestSuite; - /** Construct a new ServerConfig */ ServerConfig(); /** Get server ID as string with required leading zeroes */ - std::string GetSID(); - - /** Update the 005 vector - */ - void Update005(); - - /** Send the 005 numerics (ISUPPORT) to a user - */ - void Send005(User* user); + const std::string& GetSID() const { return sid; } /** Read the entire configuration into memory * and initialize this class. All other methods @@ -557,43 +551,55 @@ class CoreExport ServerConfig : public classbase void Fill(); - /** Read a file into a file_cache object - */ - bool ReadFile(file_cache &F, const std::string& fname); + bool ApplyDisabledCommands(const std::string& data); - /* Returns true if the given string starts with a windows drive letter + /** Escapes a value for storage in a configuration key. + * @param str The string to escape. + * @param xml Are we using the XML config format? */ - bool StartsWithWindowsDriveLetter(const std::string &path); + static std::string Escape(const std::string& str, bool xml = true); - /** Load 'filename' into 'target', with the new config parser everything is parsed into - * tag/key/value at load-time rather than at read-value time. + /** If this value is true, invites will bypass more than just +i */ - bool LoadConf(FILE* &conf, const char* filename, bool allowexeinc); + bool InvBypassModes; - /** Load 'filename' into 'target', with the new config parser everything is parsed into - * tag/key/value at load-time rather than at read-value time. + /** If this value is true, snotices will not stack when repeats are sent */ - bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc); - - ConfigTag* ConfValue(const std::string& tag, int offset = 0); + bool NoSnoticeStack; +}; - bool ApplyDisabledCommands(const std::string& data); +/** The background thread for config reading, so that reading from executable includes + * does not block. + */ +class CoreExport ConfigReaderThread : public Thread +{ + ServerConfig* Config; + volatile bool done; + public: + const std::string TheUserUID; + ConfigReaderThread(const std::string &useruid) + : Config(new ServerConfig), done(false), TheUserUID(useruid) + { + } - /** Clean a filename, stripping the directories (and drives) from string. - * @param name Directory to tidy - * @return The cleaned filename - */ - static const char* CleanFilename(const char* name); + virtual ~ConfigReaderThread() + { + delete Config; + } - /** Check if a file exists. - * @param file The full path to a file - * @return True if the file exists and is readable. - */ - static bool FileExists(const char* file); + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } +}; - /** If this value is true, invites will bypass more than just +i - */ - bool InvBypassModes; +class CoreExport ConfigStatus +{ + public: + User* const srcuser; + ConfigStatus(User* user = NULL) + : srcuser(user) + { + } }; -#endif