X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=b01a979a7c2703384bb17155e52688370af0d3df;hb=e6601069038c35c546fd3f3dce95024b0d13f1b4;hp=024e28909fcaf0dd365691fc5377224ffc0536ac;hpb=d8f98565a8617658f610bc94a5d87266930beee4;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 024e28909..b01a979a7 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -1,16 +1,26 @@ -/* +------------------------------------+ - * | 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 @@ -23,43 +33,41 @@ #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 = ""); + /** Get the value of an option, using def if it does not exist */ long getInt(const std::string& key, long def = 0); + /** 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 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); std::string getTagLocation(); -}; -/** An entire config file, built up of KeyValLists - */ -typedef std::multimap > ConfigDataHash; + inline const std::vector& getItems() const { return items; } + + /** 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. @@ -93,21 +101,49 @@ class ServerLimits ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200) { } +}; - /** 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; + + std::string startup_log; }; class CoreExport OperInfo : public refcountbase @@ -122,11 +158,11 @@ class CoreExport OperInfo : public refcountbase /** Allowed channel modes from oper classes. */ std::bitset<64> AllowedChanModes; - /** block used for this oper-up. May be NULL. */ + /** \ 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 */ + /** \ 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 */ + /** \ 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; @@ -141,11 +177,6 @@ class CoreExport OperInfo : public refcountbase } }; -typedef std::map > TagIndex; -typedef std::map > OperIndex; -typedef ConfigDataHash::iterator ConfigIter; -typedef std::pair ConfigTagList; - /** This class holds the bulk of the runtime configuration for the ircd. * It allows for reading new config values, accessing configuration files, * and storage of the configuration data needed to run the ircd, such as @@ -161,12 +192,14 @@ class CoreExport ServerConfig /** Get a configuration tag * @param tag The name of the tag to get - * @param offset get the Nth occurance of the tag */ ConfigTag* ConfValue(const std::string& tag); ConfigTagList ConfTags(const std::string& tag); + /** An empty configuration tag. */ + ConfigTag* EmptyTag; + /** Error stream, contains error output from any failed configuration parsing. */ std::stringstream errstr; @@ -174,18 +207,31 @@ class CoreExport ServerConfig /** 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 }; + 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; + /** Configuration parsed from the command line. + */ + CommandLineConf cmdline; + /** Clones CIDR range for ipv4 (0-32) * Defaults to 32 (checks clones on all IPs seperately) */ @@ -209,11 +255,6 @@ class CoreExport ServerConfig */ 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. */ @@ -295,11 +336,6 @@ class CoreExport ServerConfig */ 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; @@ -316,7 +352,6 @@ class CoreExport ServerConfig /** This variable identifies which usermodes have been diabled. */ - char DisabledUModes[64]; /** This variable identifies which chanmodes have been disabled. @@ -326,43 +361,10 @@ class CoreExport ServerConfig /** The full path to the modules directory. * This is either set at compile time, or * overridden in the configuration file via - * the tag. + * 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. @@ -374,13 +376,8 @@ class CoreExport ServerConfig */ 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]; @@ -412,20 +409,6 @@ class CoreExport ServerConfig */ 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; @@ -442,7 +425,10 @@ class CoreExport ServerConfig /** 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 */ @@ -452,14 +438,6 @@ class CoreExport ServerConfig */ 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. */ @@ -484,10 +462,6 @@ class CoreExport ServerConfig */ std::string UserStats; - /** The path and filename of the ircd.log file - */ - std::string logpath; - /** Default channel modes */ std::string DefaultModes; @@ -504,10 +478,6 @@ class CoreExport ServerConfig */ 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; @@ -521,12 +491,17 @@ class CoreExport ServerConfig */ bool CycleHosts; + /** If set to true, the CycleHosts mode change will be sourced from the user, + * rather than the server + */ + 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; @@ -536,14 +511,6 @@ class CoreExport ServerConfig */ OperIndex oper_blocks; - /** Saved argv from startup - */ - char** argv; - - /** Saved argc from startup - */ - int argc; - /** Max channels per user */ unsigned int MaxChans; @@ -559,18 +526,15 @@ class CoreExport ServerConfig */ 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(); + ~ServerConfig(); + /** Get server ID as string with required leading zeroes */ - std::string GetSID(); + const std::string& GetSID(); /** Update the 005 vector */ @@ -593,11 +557,7 @@ class CoreExport ServerConfig void Fill(); - /** Read a file into a file_cache object - */ - bool ReadFile(file_cache &F, const std::string& fname); - - /* Returns true if the given string starts with a windows drive letter + /** Returns true if the given string starts with a windows drive letter */ bool StartsWithWindowsDriveLetter(const std::string &path); @@ -619,6 +579,39 @@ class CoreExport ServerConfig */ bool InvBypassModes; + /** If this value is true, snotices will not stack when repeats are sent + */ + bool NoSnoticeStack; + + /** If true, a "Welcome to !" NOTICE will be sent to + * connecting users + */ + bool WelcomeNotice; +}; + +/** 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) + { + } + + virtual ~ConfigReaderThread() + { + delete Config; + } + + void Run(); + /** Run in the main thread to apply the configuration */ + void Finish(); + bool IsDone() { return done; } }; #endif