-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- * <omster@gmail.com>
- *
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
*
- * ---------------------------------------------------
+ * 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 <http://www.gnu.org/licenses/>.
*/
+
#ifndef INSPIRCD_CONFIGREADER
#define INSPIRCD_CONFIGREADER
#include <vector>
#include <map>
#include "inspircd.h"
-#include "globals.h"
#include "modules.h"
+#include "socketengine.h"
+#include "socket.h"
-typedef bool (*Validator)(const char*, const char*, void*);
-typedef bool (*MultiValidator)(const char*, char**, void**, int*);
-typedef bool (*MultiNotify)(const char*);
+/** Structure representing a single \<tag> in config */
+class CoreExport ConfigTag : public refcountbase
+{
+ std::vector<KeyVal> items;
+ public:
+ const std::string tag;
+ const std::string src_name;
+ const int src_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();
+
+ inline const std::vector<KeyVal>& 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<KeyVal>*& Items);
+ private:
+ ConfigTag(const std::string& Tag, const std::string& file, int line);
+};
-enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN };
+/** Defines the server's length limits on various length-limited
+ * items such as topics, nicknames, channel names etc.
+ */
+class ServerLimits
+{
+ public:
+ /** Maximum nickname length */
+ size_t NickMax;
+ /** Maximum channel length */
+ size_t ChanMax;
+ /** Maximum number of modes per line */
+ size_t MaxModes;
+ /** Maximum length of ident, not including ~ etc */
+ size_t IdentMax;
+ /** Maximum length of a quit message */
+ size_t MaxQuit;
+ /** Maximum topic length */
+ size_t MaxTopic;
+ /** Maximum kick message length */
+ size_t MaxKick;
+ /** Maximum GECOS (real name) length */
+ size_t MaxGecos;
+ /** Maximum away message length */
+ size_t MaxAway;
+
+ /** 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)
+ {
+ }
+};
-struct InitialConfig
+struct CommandLineConf
{
- char* tag;
- char* value;
- void* val;
- ConfigDataType datatype;
- Validator validation_function;
+ /** 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;
+
+ /** 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;
};
-struct MultiConfig
+class CoreExport OperInfo : public refcountbase
{
- const char* tag;
- char* items[12];
- int datatype[12];
- MultiNotify init_function;
- MultiValidator validation_function;
- MultiNotify finish_function;
+ public:
+ std::set<std::string> AllowedOperCommands;
+ std::set<std::string> AllowedPrivs;
+
+ /** Allowed user modes from oper classes. */
+ std::bitset<64> AllowedUserModes;
+
+ /** Allowed channel modes from oper classes. */
+ std::bitset<64> AllowedChanModes;
+
+ /** \<oper> block used for this oper-up. May be NULL. */
+ reference<ConfigTag> oper_block;
+ /** \<type> block used for this oper-up. Valid for local users, may be NULL on remote */
+ reference<ConfigTag> type_block;
+ /** \<class> blocks referenced from the \<type> block. These define individual permissions */
+ std::vector<reference<ConfigTag> > 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();
+
+ inline const char* NameStr()
+ {
+ return irc::Spacify(name.c_str());
+ }
};
/** This class holds the bulk of the runtime configuration for the ircd.
* and storage of the configuration data needed to run the ircd, such as
* the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
*/
-class ServerConfig : public Extensible
+class CoreExport ServerConfig
{
private:
- /** This variable holds the names of all
- * files included from the main one. This
- * is used to make sure that no files are
- * recursively included.
- */
- std::vector<std::string> include_stack;
+ void CrossCheckOperClassType();
+ void CrossCheckConnectBlocks(ServerConfig* current);
- /** This private method processes one line of
- * configutation, appending errors to errorstream
- * and setting error if an error has occured.
+ public:
+
+ /** Get a configuration tag
+ * @param tag The name of the tag to get
*/
- bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
-
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+ ConfigTag* ConfValue(const std::string& tag);
+
+ ConfigTagList ConfTags(const std::string& tag);
+
+ /** An empty configuration tag. */
+ ConfigTag* EmptyTag;
- /** Check that there is only one of each configuration item
+ /** Error stream, contains error output from any failed configuration parsing.
*/
- bool CheckOnce(char* tag, bool bail, userrec* user);
-
- public:
-
+ std::stringstream errstr;
+
+ /** 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)
+ */
+ int c_ipv4_range;
+
+ /** Clones CIDR range for ipv6 (0-128)
+ * Defaults to 128 (checks on all IPs seperately)
+ */
+ 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.
*/
- char ServerName[MAXBUF];
-
+ std::string ServerName;
+
+ /** Notice to give to users when they are Xlined
+ */
+ std::string MoronBanner;
+
/* Holds the network name the local server
* belongs to. This is an arbitary field defined
* by the administrator.
*/
- char Network[MAXBUF];
+ std::string Network;
/** Holds the description of the local server
* as defined by the administrator.
*/
- char ServerDesc[MAXBUF];
+ std::string ServerDesc;
/** Holds the admin's name, for output in
* the /ADMIN command.
*/
- char AdminName[MAXBUF];
+ std::string AdminName;
/** Holds the email address of the admin,
* for output in the /ADMIN command.
*/
- char AdminEmail[MAXBUF];
+ std::string AdminEmail;
/** Holds the admin's nickname, for output
* in the /ADMIN command
*/
- char AdminNick[MAXBUF];
+ std::string AdminNick;
/** The admin-configured /DIE password
*/
- char diepass[MAXBUF];
+ std::string diepass;
/** The admin-configured /RESTART password
*/
- char restartpass[MAXBUF];
+ std::string restartpass;
+
+ /** The hash method for *BOTH* the die and restart passwords.
+ */
+ std::string powerhash;
/** The pathname and filename of the message of the
* day file, as defined by the administrator.
*/
- char motd[MAXBUF];
+ std::string motd;
/** The pathname and filename of the rules file,
* as defined by the administrator.
*/
- char rules[MAXBUF];
+ std::string rules;
/** The quit prefix in use, or an empty string
*/
- char PrefixQuit[MAXBUF];
+ std::string PrefixQuit;
+
+ /** The quit suffix in use, or an empty string
+ */
+ std::string SuffixQuit;
- /** The last string found within a <die> tag, or
- * an empty string.
+ /** The fixed quit message in use, or an empty string
*/
- char DieValue[MAXBUF];
+ std::string FixedQuit;
+
+ /** The part prefix in use, or an empty string
+ */
+ std::string PrefixPart;
+
+ /** The part suffix in use, or an empty string
+ */
+ std::string SuffixPart;
+
+ /** The fixed part message in use, or an empty string
+ */
+ std::string FixedPart;
/** The DNS server to use for DNS queries
*/
- char DNSServer[MAXBUF];
+ std::string DNSServer;
+
+ /** Pretend disabled commands don't exist.
+ */
+ bool DisabledDontExist;
/** This variable contains a space-seperated list
* of commands which are disabled by the
* administrator of the server for non-opers.
*/
- char DisabledCommands[MAXBUF];
+ std::string DisabledCommands;
- /** The full path to the modules directory.
- * This is either set at compile time, or
- * overridden in the configuration file via
- * the <options> tag.
+ /** This variable identifies which usermodes have been diabled.
*/
- char ModPath[1024];
+ char DisabledUModes[64];
- /** The temporary directory where modules are copied
+ /** This variable identifies which chanmodes have been disabled.
*/
- char TempDir[1024];
+ char DisabledCModes[64];
- /** The full pathname to the executable, as
- * given in argv[0] when the program starts.
+ /** The full path to the modules directory.
+ * This is either set at compile time, or
+ * overridden in the configuration file via
+ * the \<path> tag.
*/
- char MyExecutable[1024];
+ 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!).
+ /** 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.
*/
- FILE *log_file;
+ bool GenericOper;
- /** If this value is true, the owner of the
- * server specified -nofork on the command
- * line, causing the daemon to stay in the
- * foreground.
+ /** If this value is true, banned users (+b, not extbans) will not be able to change nick
+ * if banned on any channel, nor to message them.
*/
- 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;
+ bool RestrictBannedUsers;
- /** If this value is true, halfops have been
- * enabled in the configuration file.
+ /** If this is set to true, then mode lists (e.g
+ * MODE \#chan b) are hidden from unprivileged
+ * users.
*/
- bool AllowHalfop;
+ bool HideModeLists[256];
/** The number of seconds the DNS subsystem
* will wait before timing out any request.
*/
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;
-
- /** The loglevel in use by the IRC server
- */
- int LogLevel;
-
- /** 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;
*/
bool HideBans;
- /** If this is enabled then operators will
- * see invisible (+i) channels in /whois.
+ /** Announce invites to the channel with a server notice
*/
- bool OperSpyWhois;
+ InviteAnnounceState AnnounceInvites;
- /** Set to a non-empty string to obfuscate the server name of users in WHOIS
+ /** If this is enabled then operators will
+ * see invisible (+i) channels in /whois.
*/
- char HideWhoisServer[MAXBUF];
+ OperSpyWhoisState OperSpyWhois;
- /** A list of IP addresses the server is listening
- * on.
- */
- char addrs[MAXBUF][255];
+ /** True if raw I/O is being logged */
+ bool RawLog;
- /** The MOTD file, cached in a file_cache type.
+ /** Set to a non-empty string to obfuscate the server name of users in WHOIS
*/
- file_cache MOTD;
+ std::string HideWhoisServer;
- /** The RULES file, cached in a file_cache type.
+ /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
*/
- file_cache RULES;
+ std::string HideKillsServer;
/** The full pathname and filename of the PID
* file as defined in the configuration.
*/
- char PID[1024];
+ std::string PID;
/** The connect classes in use by the IRC server.
*/
ClassVector Classes;
- /** A list of module names (names only, no paths)
- * which are currently loaded by the server.
+ /** The 005 tokens of this server (ISUPPORT)
+ * populated/repopulated upon loading or unloading
+ * modules.
*/
- std::vector<std::string> module_names;
+ std::string data005;
- /** A list of ports which the server is listening on
+ /** isupport strings
*/
- int ports[255];
+ std::vector<std::string> isupport;
- /** A list of the file descriptors for the listening client ports
+ /** STATS characters in this list are available
+ * only to operators.
*/
- int openSockfd[MAX_DESCRIPTORS];
+ std::string UserStats;
- /** Boolean sets of which modules implement which functions
+ /** Default channel modes
*/
- char implement_lists[255][255];
+ std::string DefaultModes;
- /** Global implementation list
+ /** Custom version string, which if defined can replace the system info in VERSION.
*/
- char global_implementation[255];
+ std::string CustomVersion;
- /** A list of ports claimed by IO Modules
+ /** List of u-lined servers
*/
- std::map<int,Module*> IOHookModule;
+ std::map<irc::string, bool> ulines;
- /** The 005 tokens of this server (ISUPPORT)
- * populated/repopulated upon loading or unloading
- * modules.
+ /** Max banlist sizes for channels (the std::string is a glob)
*/
- std::string data005;
+ std::map<std::string, int> maxbans;
- /** STATS characters in this list are available
- * only to operators.
+ /** If set to true, no user DNS lookups are to be performed
*/
- char OperOnlyStats[MAXBUF];
-
- /** The path and filename of the ircd.log file
+ bool NoUserDns;
+
+ /** If set to true, provide syntax hints for unknown commands
*/
- std::string logpath;
+ bool SyntaxHints;
- /** Custom version string, which if defined can replace the system info in VERSION.
+ /** If set to true, users appear to quit then rejoin when their hosts change.
+ * This keeps clients synchronized properly.
*/
- char CustomVersion[MAXBUF];
+ bool CycleHosts;
- /** List of u-lined servers
+ /** If set to true, the CycleHosts mode change will be sourced from the user,
+ * rather than the server
*/
- std::vector<irc::string> ulines;
+ bool CycleHostsFromUser;
- /** Max banlist sizes for channels (the std::string is a glob)
+ /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
+ * added to the outgoing text for undernet style msg prefixing.
*/
- std::map<std::string,int> maxbans;
+ bool UndernetMsgPrefix;
- /** If set to true, no user DNS lookups are to be performed
+ /** 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 NoUserDns;
+ bool FullHostInTopic;
+
+ /** Oper block and type index.
+ * For anonymous oper blocks (type only), prefix with a space.
+ */
+ OperIndex oper_blocks;
+
+ /** Max channels per user
+ */
+ unsigned int MaxChans;
+ /** Oper max channels per user
+ */
+ unsigned int OperMaxChans;
+
+ /** TS6-like server ID.
+ * NOTE: 000...999 are usable for InspIRCd servers. This
+ * makes code simpler. 0AA, 1BB etc with letters are reserved
+ * for services use.
+ */
+ std::string sid;
+
+ /** Construct a new ServerConfig
+ */
ServerConfig();
- /** Clears the include stack in preperation for
- * a Read() call.
+ ~ServerConfig();
+
+ /** Get server ID as string with required leading zeroes
+ */
+ const std::string& GetSID();
+
+ /** Update the 005 vector
*/
- void ClearStack();
+ void Update005();
+
+ /** Send the 005 numerics (ISUPPORT) to a user
+ */
+ void Send005(User* user);
/** Read the entire configuration into memory
* and initialize this class. All other methods
* should be used only by the core.
*/
- void Read(bool bail, userrec* user);
-
- /** 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.
- */
- bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
- bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
-
- /* Both these return true if the value existed or false otherwise */
-
- /* Writes 'length' chars into 'result' as a string */
- bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length);
- bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result);
-
- /* Tries to convert the value to an integer and write it to 'result' */
- bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
- bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
-
- /* Returns true if the value exists and has a true value, false otherwise */
- bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
- bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
-
- /* Returns the number of occurences of tag in the config file */
- int ConfValueEnum(ConfigDataHash &target, const char* tag);
- int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
-
- /* Returns the numbers of vars inside the index'th 'tag in the config file */
- int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
- int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
-
- Module* GetIOHook(int port);
- bool AddIOHook(int port, Module* iomod);
- bool DelIOHook(int port);
+ void Read();
+
+ /** Apply configuration changes from the old configuration.
+ */
+ void Apply(ServerConfig* old, const std::string &useruid);
+ void ApplyModules(User* user);
+
+ void Fill();
+
+ /** Returns true if the given string starts with a windows drive letter
+ */
+ bool StartsWithWindowsDriveLetter(const std::string &path);
+
+ bool ApplyDisabledCommands(const std::string& data);
+
+ /** 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);
+
+ /** 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);
+
+ /** 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;
+
+ /** If true, a "Welcome to <networkname>!" 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
projects / user / henk / code / inspircd.git / blobdiff