X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=bf5acbbc8a5f0333b559ed504139899211f7ebe3;hb=9d4efff3957f1ad163f726bc44bed3a4870afb94;hp=3d01d7e9168ec01ec7a41e653cff71cf6b4971c6;hpb=96e4434f9078bf3db0dad96d56f35cbee53252d5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 3d01d7e91..bf5acbbc8 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-2010 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,7 +32,7 @@ #include "socketengine.h" #include "socket.h" -/** Structure representing a single in config */ +/** Structure representing a single \ in config */ class CoreExport ConfigTag : public refcountbase { std::vector items; @@ -35,7 +44,7 @@ class CoreExport ConfigTag : public refcountbase /** 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); + 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 */ @@ -84,29 +93,16 @@ 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) - { - } - - /** 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. - */ - void Finalise() - { - NickMax++; - ChanMax++; - IdentMax++; - MaxQuit++; - MaxTopic++; - MaxKick++; - MaxGecos++; - MaxAway++; - } + ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), + MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200), + MaxLine(512) { } }; struct CommandLineConf @@ -148,8 +144,6 @@ struct CommandLineConf /** Saved argv from startup */ char** argv; - - std::string startup_log; }; class CoreExport OperInfo : public refcountbase @@ -164,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; @@ -176,11 +170,6 @@ class CoreExport OperInfo : public refcountbase /** Get a configuration item, searching in the oper, type, and class blocks (in that order) */ std::string getConfig(const std::string& key); void init(); - - inline const char* NameStr() - { - return irc::Spacify(name.c_str()); - } }; /** This class holds the bulk of the runtime configuration for the ircd. @@ -195,10 +184,35 @@ class CoreExport ServerConfig 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 ServerConfig::ExpandPath(Config, fn); } + std::string PrependData(const std::string& fn) const { return ServerConfig::ExpandPath(Data, fn); } + std::string PrependLog(const std::string& fn) const { return ServerConfig::ExpandPath(Log, fn); } + std::string PrependModule(const std::string& fn) const { return ServerConfig::ExpandPath(Module, fn); } + }; /** 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); @@ -211,18 +225,30 @@ 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; + /** Locations of various types of file (config, module, etc). */ + ServerPaths Paths; + /** Configuration parsed from the command line. */ CommandLineConf cmdline; @@ -237,27 +263,14 @@ class CoreExport ServerConfig */ 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; - /** 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 @@ -331,15 +344,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; - /** Pretend disabled commands don't exist. */ bool DisabledDontExist; @@ -358,13 +362,6 @@ class CoreExport ServerConfig */ 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; - /** 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. @@ -377,7 +374,7 @@ class CoreExport ServerConfig bool RestrictBannedUsers; /** 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]; @@ -398,6 +395,13 @@ class CoreExport ServerConfig */ 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. @@ -425,7 +429,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 */ @@ -435,14 +442,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. */ @@ -452,16 +451,6 @@ class CoreExport ServerConfig */ 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. */ @@ -479,29 +468,21 @@ class CoreExport ServerConfig */ std::map ulines; - /** Max banlist sizes for channels (the std::string is a glob) - */ - std::map maxbans; - - /** 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; @@ -532,15 +513,7 @@ class CoreExport 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 @@ -555,13 +528,9 @@ class CoreExport ServerConfig void Fill(); - /** Read a file into a file_cache object + /** Returns true if the given string starts with a windows drive letter */ - bool ReadFile(file_cache &F, const std::string& fname); - - /* Returns true if the given string starts with a windows drive letter - */ - bool StartsWithWindowsDriveLetter(const std::string &path); + static bool StartsWithWindowsDriveLetter(const std::string& path); bool ApplyDisabledCommands(const std::string& data); @@ -577,10 +546,25 @@ class CoreExport ServerConfig */ static bool FileExists(const char* file); + /** Expands a path fragment to a full path. + * @param base The base path to expand from + * @param fragment The path fragment to expand on top of base. + */ + static std::string ExpandPath(const std::string& base, const std::string& fragment); + + /** Escapes a value for storage in a configuration key. + * @param str The string to escape. + * @param xml Are we using the XML config format? + */ + static std::string Escape(const std::string& str, bool xml = true); + /** If this value is true, invites will bypass more than just +i */ bool InvBypassModes; + /** If this value is true, snotices will not stack when repeats are sent + */ + bool NoSnoticeStack; }; /** The background thread for config reading, so that reading from executable includes @@ -607,5 +591,3 @@ class CoreExport ConfigReaderThread : public Thread void Finish(); bool IsDone() { return done; } }; - -#endif