* +------------------------------------+
*
* InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
#ifndef INSPIRCD_CONFIGREADER
#define INSPIRCD_CONFIGREADER
-/* handy defines */
-
-/** Determines if a channel op is exempt from given mode m,
- * in config of server instance s.
- */
-#define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
-
#include <sstream>
#include <string>
#include <vector>
/* Required forward definitions */
class ServerConfig;
+class ServerLimits;
class InspIRCd;
class BufferedSocket;
-/** Types of data in the core config
+/** A cached text file stored with its contents as lines
*/
-enum ConfigDataType
-{
- DT_NOTHING = 0, /* No data */
- DT_INTEGER = 1, /* Integer */
- DT_CHARPTR = 2, /* Char pointer */
- DT_BOOLEAN = 3, /* Boolean */
- DT_HOSTNAME = 4, /* Hostname syntax */
- DT_NOSPACES = 5, /* No spaces */
- DT_IPADDRESS = 6, /* IP address (v4, v6) */
- DT_CHANNEL = 7, /* Channel name */
- DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */
- DT_ALLOW_NEWLINE = 128, /* New line characters allowed in DT_CHARPTR */
- DT_BOOTONLY = 256 /* Can only be set on startup, not on rehash */
-};
+typedef std::vector<std::string> file_cache;
-/** The maximum number of values in a core configuration tag. Can be increased if needed.
+/** A configuration key and value pair
*/
-#define MAX_VALUES_PER_TAG 18
+typedef std::pair<std::string, std::string> KeyVal;
-/** Holds a config value, either string, integer or boolean.
- * Callback functions receive one or more of these, either on
- * their own as a reference, or in a reference to a deque of them.
- * The callback function can then alter the values of the ValueItem
- * classes to validate the settings.
- */
-class ValueItem
+struct CoreExport ConfigTag : public refcountbase
{
- /** Actual data */
- std::string v;
- public:
- /** Initialize with an int */
- ValueItem(int value);
- /** Initialize with a bool */
- ValueItem(bool value);
- /** Initialize with a char pointer */
- ValueItem(const char* value);
- /** Change value to a char pointer */
- void Set(const char* val);
- /** Change value to an int */
- void Set(int value);
- /** Get value as an int */
- int GetInteger();
- /** Get value as a string */
- char* GetString();
- /** Get value as a bool */
- bool GetBool();
-};
+ const std::string tag;
+ const std::string src_name;
+ const int src_line;
+ std::vector<KeyVal> items;
-/** The base class of the container 'ValueContainer'
- * used internally by the core to hold core values.
- */
-class ValueContainerBase
-{
- public:
- /** Constructor */
- ValueContainerBase() { }
- /** Destructor */
- virtual ~ValueContainerBase() { }
-};
-
-/** ValueContainer is used to contain pointers to different
- * core values such as the server name, maximum number of
- * clients etc.
- * It is specialized to hold a data type, then pointed at
- * a value in the ServerConfig class. When the value has been
- * read and validated, the Set method is called to write the
- * value safely in a type-safe manner.
- */
-template<typename T> class ValueContainer : public ValueContainerBase
-{
- /** Contained item */
- T val;
- public:
+ ConfigTag(const std::string& Tag, const std::string& file, int line)
+ : tag(Tag), src_name(file), src_line(line) {}
- /** Initialize with nothing */
- ValueContainer()
- {
- val = NULL;
- }
+ std::string getString(const std::string& key, const std::string& def = "");
+ long getInt(const std::string& key, long def = 0);
+ double getFloat(const std::string& key, double def = 0);
+ bool getBool(const std::string& key, bool def = false);
- /** Initialize with a value of type T */
- ValueContainer(T Val)
- {
- val = Val;
- }
+ bool readString(const std::string& key, std::string& value, bool allow_newline = false);
- /** Change value to type T of size s */
- void Set(T newval, size_t s)
- {
- memcpy(val, newval, s);
- }
+ std::string getTagLocation();
};
-/** A specialization of ValueContainer to hold a pointer to a bool
- */
-typedef ValueContainer<bool*> ValueContainerBool;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an unsigned int
- */
-typedef ValueContainer<unsigned int*> ValueContainerUInt;
-
-/** A specialization of ValueContainer to hold a pointer to
- * a char array.
- */
-typedef ValueContainer<char*> ValueContainerChar;
-
-/** A specialization of ValueContainer to hold a pointer to
- * an int
- */
-typedef ValueContainer<int*> ValueContainerInt;
-
-/** A specialization of ValueContainer to hold a pointer to
- * a size_t.
- */
-typedef ValueContainer<size_t*> ValueContainerST;
-
-/** A set of ValueItems used by multi-value validator functions
- */
-typedef std::deque<ValueItem> ValueList;
-
-/** A callback for validating a single value
- */
-typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
-/** A callback for validating multiple value entries
- */
-typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
-/** A callback indicating the end of a group of entries
+/** An entire config file, built up of KeyValLists
*/
-typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
+typedef std::multimap<std::string, reference<ConfigTag> > ConfigDataHash;
-/** Holds a core configuration item and its callbacks
- */
-struct InitialConfig
-{
- /** Tag name */
- const char* tag;
- /** Value name */
- const char* value;
- /** Default, if not defined */
- const char* default_value;
- /** Value containers */
- ValueContainerBase* val;
- /** Data types */
- int datatype;
- /** Validation function */
- Validator validation_function;
-};
-
-/** Represents a deprecated configuration tag.
- */
-struct Deprecated
-{
- /** Tag name
- */
- const char* tag;
- /** Tag value
- */
- const char* value;
- /** Reason for deprecation
- */
- const char* reason;
-};
-
-/** Holds a core configuration item and its callbacks
- * where there may be more than one item
- */
-struct MultiConfig
-{
- /** Tag name */
- const char* tag;
- /** One or more items within tag */
- const char* items[MAX_VALUES_PER_TAG];
- /** One or more defaults for items within tags */
- const char* items_default[MAX_VALUES_PER_TAG];
- /** One or more data types */
- int datatype[MAX_VALUES_PER_TAG];
- /** Initialization function */
- MultiNotify init_function;
- /** Validation function */
- MultiValidator validation_function;
- /** Completion function */
- MultiNotify finish_function;
-};
-
-/** A set of oper types
- */
-typedef std::map<irc::string,char*> opertype_t;
-
-/** Holds an oper class.
- */
-struct operclass_data : public Extensible
-{
- /** Command list for the class
- */
- char *commandlist;
-
- /** Channel mode list for the class
- */
- char *cmodelist;
-
- /** User mode list for the class
- */
- char *umodelist;
-
- /** Priviledges given by this class
- */
- char *privs;
-};
-
-/** A Set of oper classes
- */
-typedef std::map<irc::string, operclass_data> operclass_t;
+typedef std::map<std::string, reference<ConfigTag> > TagIndex;
/** Defines the server's length limits on various length-limited
* items such as topics, nicknames, channel names etc.
*/
-class ServerLimits : public Extensible
+class ServerLimits
{
public:
/** Maximum nickname length */
* 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 Extensible
+class CoreExport ServerConfig
{
private:
- /** Creator/owner pointer
- */
- InspIRCd* ServerInstance;
-
- /** 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;
-
- /** This private method processes one line of
- * configutation, appending errors to errorstream
- * and setting error if an error has occured.
- */
- bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
-
- /** Check that there is only one of each configuration item
- */
- bool CheckOnce(const char* tag, ConfigDataHash &newconf);
+ void CrossCheckOperClassType();
+ void CrossCheckConnectBlocks(ServerConfig* current);
public:
- /** Process an include executable directive
- */
- bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
-
- /** Process an include file directive
- */
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
-
- /** User that is currently performing a rehash, needed because the
- * rehash code is now threaded and needs to know who to give errors and feedback to.
- */
- std::string RehashUserUID;
-
- /** Rehash parameter, as above
- */
- std::string RehashParameter;
-
/** Error stream, contains error output from any failed configuration parsing.
*/
- std::ostringstream* errstr;
-
- /** Holds the new configuration when a rehash occurs so we dont overwrite the existing
- * working config with a broken one without checking it first and swapping pointers.
- */
- ConfigDataHash newconfig;
+ std::stringstream errstr;
- /** Set of included files. Do we use this any more?
- */
- std::map<std::string, std::istream*> IncludedFiles;
+ /** True if this configuration is valid enough to run with */
+ bool valid;
/** 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 };
- /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
- Validator DNSServerValidator;
-
- /** Returns the creator InspIRCd pointer
- */
- InspIRCd* GetInstance();
-
/** Not used any more as it is named, can probably be removed or renamed.
*/
int DoDownloads();
/** Both for set(g|u)id.
*/
- char SetUser[MAXBUF];
- char SetGroup[MAXBUF];
+ std::string SetUser;
+ std::string SetGroup;
/** 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
*/
- char MoronBanner[MAXBUF];
+ 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.
*/
- char powerhash[MAXBUF];
+ 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
*/
- char SuffixQuit[MAXBUF];
+ std::string SuffixQuit;
/** The fixed quit message in use, or an empty string
*/
- char FixedQuit[MAXBUF];
+ std::string FixedQuit;
/** The part prefix in use, or an empty string
*/
- char PrefixPart[MAXBUF];
+ std::string PrefixPart;
/** The part suffix in use, or an empty string
*/
- char SuffixPart[MAXBUF];
+ std::string SuffixPart;
/** The fixed part message in use, or an empty string
*/
- char FixedPart[MAXBUF];
+ std::string FixedPart;
/** The last string found within a <die> tag, or
* an empty string.
*/
- char DieValue[MAXBUF];
+ std::string DieValue;
/** The DNS server to use for DNS queries
*/
- char DNSServer[MAXBUF];
+ std::string DNSServer;
/** Pretend disabled commands don't exist.
*/
* of commands which are disabled by the
* administrator of the server for non-opers.
*/
- char DisabledCommands[MAXBUF];
+ std::string DisabledCommands;
/** This variable identifies which usermodes have been diabled.
*/
* overridden in the configuration file via
* the <options> tag.
*/
- char ModPath[1024];
-
- /** The full pathname to the executable, as
- * given in argv[0] when the program starts.
- */
- char MyExecutable[1024];
+ std::string ModPath;
/** The file handle of the logfile. If this
* value is NULL, the log file is not open,
*/
bool HideModeLists[256];
- /** If this is set to true, then channel operators
- * are exempt from this channel mode. Used for +Sc etc.
- */
- bool ExemptChanOps[256];
-
/** The number of seconds the DNS subsystem
* will wait before timing out any request.
*/
/** Set to a non-empty string to obfuscate the server name of users in WHOIS
*/
- char HideWhoisServer[MAXBUF];
+ std::string HideWhoisServer;
/** Set to a non empty string to obfuscate nicknames prepended to a KILL.
*/
- char HideKillsServer[MAXBUF];
+ std::string HideKillsServer;
/** The MOTD file, cached in a file_cache type.
*/
/** 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 the classes for listening ports
- */
- std::vector<ListenSocketBase *> ports;
-
/** The 005 tokens of this server (ISUPPORT)
* populated/repopulated upon loading or unloading
* modules.
/** STATS characters in this list are available
* only to operators.
*/
- char UserStats[MAXBUF];
+ std::string UserStats;
/** The path and filename of the ircd.log file
*/
/** Default channel modes
*/
- char DefaultModes[MAXBUF];
+ std::string DefaultModes;
/** Custom version string, which if defined can replace the system info in VERSION.
*/
- char CustomVersion[MAXBUF];
+ std::string CustomVersion;
/** List of u-lined servers
*/
/** All oper type definitions from the config file
*/
- opertype_t opertypes;
+ TagIndex opertypes;
/** All oper class definitions from the config file
*/
- operclass_t operclass;
+ TagIndex operclass;
/** Saved argv from startup
*/
* makes code simpler. 0AA, 1BB etc with letters are reserved
* for services use.
*/
- char sid[MAXBUF];
+ std::string sid;
/** True if we have been told to run the testsuite from the commandline,
* rather than entering the mainloop.
/** Construct a new ServerConfig
*/
- ServerConfig(InspIRCd* Instance);
-
- /** Clears the include stack in preperation for a Read() call.
- */
- void ClearStack();
+ ServerConfig();
/** Get server ID as string with required leading zeroes
*/
* and initialize this class. All other methods
* should be used only by the core.
*/
- void Read(bool bail, const std::string &useruid);
+ void Read();
+
+ /** Apply configuration changes from the old configuration.
+ */
+ void Apply(ServerConfig* old, const std::string &useruid);
+ void ApplyModules(User* user);
+
+ void Fill();
/** Read a file into a file_cache object
*/
- bool ReadFile(file_cache &F, const char* fname);
+ 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);
- /** Report a configuration error given in errormessage.
- * @param bail If this is set to true, the error is sent to the console, and the program exits
- * @param useruid If this is set to a non-empty value which is a valid UID, and bail is false,
- * the errors are spooled to this user as SNOTICEs.
- * If the parameter is not a valid UID, the messages are spooled to all opers.
- */
- void ReportConfigError(const std::string &errormessage, bool bail, const std::string &useruid);
-
/** 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, FILE* &conf, const char* filename, std::ostringstream &errorstream);
+ bool LoadConf(FILE* &conf, const char* filename, bool allowexeinc);
/** 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, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
+ bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc);
- /** 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 allow_linefeeds = false);
+ ConfigTag* ConfValue(const std::string& tag, int offset = 0);
- /** Writes 'length' chars into 'result' as a string
- */
- bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
-
- /** Writes 'length' chars into 'result' as a string
- */
- bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
-
- /** Writes 'length' chars into 'result' as a string
- */
- bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false);
-
- /** 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);
-
- /** Tries to convert the value to an integer and write it to 'result'
- */
- bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
-
- /** Tries to convert the value to an integer and write it to 'result'
- */
- bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
-
- /** Tries to convert the value to an integer and write it to 'result'
- */
- bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, 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);
-
- /** Returns true if the value exists and has a true value, false otherwise
- */
- bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
-
- /** Returns true if the value exists and has a true value, false otherwise
- */
- bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
-
- /** Returns true if the value exists and has a true value, false otherwise
- */
- bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
-
- /** Returns the number of occurences of tag in the config file
- */
- int ConfValueEnum(ConfigDataHash &target, const char* tag);
- /** Returns the number of occurences of tag in the config file
- */
- 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);
- /** Returns the numbers of vars inside the index'th 'tag in the config file
- */
- int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
-
- /** Validates a hostname value, throwing ConfigException if it is not valid
- */
- void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
-
- /** Validates an IP address value, throwing ConfigException if it is not valid
- */
- void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
-
- /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
- */
- void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
-
- /** Returns the fully qualified path to the inspircd directory
- * @return The full program directory
- */
- std::string GetFullProgDir();
-
- /** Returns true if a directory is valid (within the modules directory).
- * @param dirandfile The directory and filename to check
- * @return True if the directory is valid
- */
- static bool DirValid(const char* dirandfile);
+ 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 char* CleanFilename(char* name);
+ static const char* CleanFilename(const char* name);
/** Check if a file exists.
* @param file The full path to a file
bool InvBypassModes;
};
-
-/** Initialize the disabled commands list
- */
-CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
-
-/** Initialize the oper types
- */
-bool InitTypes(ServerConfig* conf, const char* tag);
-
-/** Initialize the oper classes
- */
-bool InitClasses(ServerConfig* conf, const char* tag);
-
-/** Initialize an oper type
- */
-bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Initialize an oper class
- */
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Finish initializing the oper types and classes
- */
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
-
-
-
-/** Initialize x line
- */
-bool InitXLine(ServerConfig* conf, const char* tag);
-
-/** Add a config-defined zline
- */
-bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined qline
- */
-bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined kline
- */
-bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-/** Add a config-defined eline
- */
-bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
#endif
projects / user / henk / code / inspircd.git / blobdiff