* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * 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>
#include <map>
#include "inspircd.h"
-#include "globals.h"
#include "modules.h"
#include "socketengine.h"
#include "socket.h"
+/* Required forward definitions */
class ServerConfig;
+class ServerLimits;
class InspIRCd;
-class InspSocket;
+class BufferedSocket;
-/** Types of data in the core config
+/** A set of oper types
*/
-enum ConfigDataType
-{
- DT_NOTHING = 0,
- DT_INTEGER = 1,
- DT_CHARPTR = 2,
- DT_BOOLEAN = 3,
- DT_ALLOW_NEWLINE = 128
-};
+typedef std::map<irc::string,std::string> opertype_t;
-/** 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.
+/** Holds an oper class.
*/
-class ValueItem
+struct operclass_data : public classbase
{
- std::string v;
- public:
- ValueItem(int value);
- ValueItem(bool value);
- ValueItem(char* value);
- void Set(char* value);
- void Set(const char* val);
- void Set(int value);
- int GetInteger();
- char* GetString();
- bool GetBool();
+ /** 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;
};
-/** The base class of the container 'ValueContainer'
- * used internally by the core to hold core values.
+/** A Set of oper classes
*/
-class ValueContainerBase
-{
- public:
- ValueContainerBase() { }
- virtual ~ValueContainerBase() { }
-};
+typedef std::map<irc::string, operclass_data> operclass_t;
-/** 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.
+/** Defines the server's length limits on various length-limited
+ * items such as topics, nicknames, channel names etc.
*/
-template<typename T> class ValueContainer : public ValueContainerBase
+class ServerLimits
{
- T val;
-
public:
-
- ValueContainer()
- {
- val = NULL;
- }
-
- ValueContainer(T Val)
+ /** 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)
{
- val = Val;
}
- void Set(T newval, size_t s)
+ /** 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()
{
- memcpy(val, newval, s);
+ NickMax++;
+ ChanMax++;
+ IdentMax++;
+ MaxQuit++;
+ MaxTopic++;
+ MaxKick++;
+ MaxGecos++;
+ MaxAway++;
}
};
-/** 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 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
- */
-typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
-
-/** Holds a core configuration item and its callbacks
- */
-struct InitialConfig
-{
- char* tag;
- char* value;
- char* default_value;
- ValueContainerBase* val;
- ConfigDataType datatype;
- Validator validation_function;
-};
-
-/** Holds a core configuration item and its callbacks
- * where there may be more than one item
- */
-struct MultiConfig
-{
- const char* tag;
- char* items[12];
- char* items_default[12];
- int datatype[12];
- MultiNotify init_function;
- MultiValidator validation_function;
- MultiNotify finish_function;
-};
-
-/** A set of oper types
- */
-typedef std::map<irc::string,char*> opertype_t;
-
-/** A Set of oper classes
- */
-typedef std::map<irc::string,char*> operclass_t;
-
-
/** 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
* the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
*/
-class ServerConfig : public Extensible
+class CoreExport ServerConfig : public classbase
{
private:
- /** Creator/owner
+ /** Creator/owner pointer
*/
InspIRCd* ServerInstance;
*/
std::vector<std::string> include_stack;
+ /* classes removed by this rehash */
+ std::vector<ConnectClass*> removed_classes;
+
/** This private method processes one line of
* configutation, appending errors to errorstream
* and setting error if an error has occured.
*/
- bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
-
- /** Process an include directive
- */
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+ bool ParseLine(const std::string &filename, std::string &line, long &linenumber);
/** Check that there is only one of each configuration item
*/
- bool CheckOnce(char* tag, bool bail, userrec* user);
-
- public:
+ bool CheckOnce(const char* tag);
+
+ void CrossCheckOperClassType();
+ void CrossCheckConnectBlocks(ServerConfig* current);
+
+ public:
+ /** Process an include executable directive
+ */
+ bool DoPipe(const std::string &file);
+
+ /** Process an include file directive
+ */
+ bool DoInclude(const std::string &file);
+
+ /** Error stream, contains error output from any failed configuration parsing.
+ */
+ std::stringstream errstr;
+
+ /** True if this configuration is valid enough to run with */
+ bool valid;
+
+ /** Set of included files. Do we use this any more?
+ */
+ std::map<std::string, std::istream*> IncludedFiles;
+ /** 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 };
+
+ /** Returns the creator InspIRCd pointer
+ */
InspIRCd* GetInstance();
-
+
+ /** Not used any more as it is named, can probably be removed or renamed.
+ */
+ int DoDownloads();
+
/** This holds all the information in the config file,
* it's indexed by tag name to a vector of key/values.
*/
ConfigDataHash config_data;
+ /** Length limits, see definition of ServerLimits class
+ */
+ ServerLimits Limits;
+
+ /** 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;
*/
int WhoWasMaxKeep;
+ /** Both for set(g|u)id.
+ */
+ char SetUser[MAXBUF];
+ char SetGroup[MAXBUF];
+
/** Holds the server name of the local server
* as defined by the administrator.
*/
char ServerName[MAXBUF];
-
+
+ /** Notice to give to users when they are Xlined
+ */
+ char MoronBanner[MAXBUF];
+
/* Holds the network name the local server
* belongs to. This is an arbitary field defined
* by the administrator.
*/
char restartpass[MAXBUF];
+ /** The hash method for *BOTH* the die and restart passwords.
+ */
+ char powerhash[MAXBUF];
+
/** The pathname and filename of the message of the
* day file, as defined by the administrator.
*/
*/
char PrefixQuit[MAXBUF];
+ /** The quit suffix in use, or an empty string
+ */
+ char SuffixQuit[MAXBUF];
+
+ /** The fixed quit message in use, or an empty string
+ */
+ char FixedQuit[MAXBUF];
+
+ /** The part prefix in use, or an empty string
+ */
+ char PrefixPart[MAXBUF];
+
+ /** The part suffix in use, or an empty string
+ */
+ char SuffixPart[MAXBUF];
+
+ /** The fixed part message in use, or an empty string
+ */
+ char FixedPart[MAXBUF];
+
/** The last string found within a <die> tag, or
* an empty string.
*/
*/
char DNSServer[MAXBUF];
+ /** 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];
+ /** 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 <options> tag.
*/
- char ModPath[1024];
+ std::string ModPath;
/** The full pathname to the executable, as
* given in argv[0] when the program starts.
*/
- char MyExecutable[1024];
+ std::string MyExecutable;
/** The file handle of the logfile. If this
* value is NULL, the log file is not open,
* foreground.
*/
bool nofork;
-
+
/** If this value if true then all log
* messages will be output, regardless of
* the level given in the config file.
* 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
*/
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.
+ */
+ bool GenericOper;
+
+ /** 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 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
+ * users.
+ */
+ 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.
*/
*/
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.
*/
*/
bool HideBans;
+ /** Announce invites to the channel with a server notice
+ */
+ InviteAnnounceState AnnounceInvites;
+
/** If this is enabled then operators will
* see invisible (+i) channels in /whois.
*/
*/
char HideWhoisServer[MAXBUF];
- /** A list of IP addresses the server is listening
- * on.
+ /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
*/
- char addrs[MAXBUF][255];
+ char HideKillsServer[MAXBUF];
/** 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 module names (names only, no paths)
- * which are currently loaded by the server.
- */
- std::vector<std::string> module_names;
-
- /** A list of ports which the server is listening on
- */
- int ports[255];
-
- /** A list of the file descriptors for the listening client ports
- */
- ListenSocket* openSockfd[255];
-
- /** Boolean sets of which modules implement which functions
- */
- char implement_lists[255][255];
-
- /** Global implementation list
- */
- char global_implementation[255];
-
- /** A list of ports claimed by IO Modules
- */
- std::map<int,Module*> IOHookModule;
-
- std::map<InspSocket*, Module*> SocketIOHookModule;
-
/** The 005 tokens of this server (ISUPPORT)
* populated/repopulated upon loading or unloading
* modules.
*/
std::string data005;
+
+ /** isupport strings
+ */
std::vector<std::string> isupport;
/** STATS characters in this list are available
* only to operators.
*/
char UserStats[MAXBUF];
-
+
/** The path and filename of the ircd.log file
*/
std::string logpath;
+ /** Default channel modes
+ */
+ char DefaultModes[MAXBUF];
+
/** Custom version string, which if defined can replace the system info in VERSION.
*/
char CustomVersion[MAXBUF];
/** List of u-lined servers
*/
- std::vector<irc::string> ulines;
+ std::map<irc::string, bool> ulines;
/** Max banlist sizes for channels (the std::string is a glob)
*/
- std::map<std::string,int> maxbans;
+ std::map<std::string, int> maxbans;
/** Directory where the inspircd binary resides
*/
*/
int argc;
+ /** 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.
+ */
+ char sid[MAXBUF];
+
+ /** 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(InspIRCd* Instance);
- /** Clears the include stack in preperation for a Read() call.
+ /** Get server ID as string with required leading zeroes
*/
- void ClearStack();
+ std::string GetSID();
/** Update the 005 vector
*/
/** Send the 005 numerics (ISUPPORT) to a user
*/
- void Send005(userrec* 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);
+ void Read();
- /** Read a file into a file_cache object
+ /** Apply configuration changes from the old configuration.
*/
- bool ReadFile(file_cache &F, const char* fname);
+ void Apply(ServerConfig* old, const std::string &useruid);
+ void ApplyModules(User* 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.
+ /** Read a file into a file_cache object
*/
+ bool ReadFile(file_cache &F, const char* fname);
- /** 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 user If this is set to a non-null value, and bail is false, the errors are spooled to
- * this user as SNOTICEs.
- * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
+ /* Returns true if the given string starts with a windows drive letter
*/
- void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
+ bool StartsWithWindowsDriveLetter(const std::string &path);
/** 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(FILE* &conf, const char* filename);
/** 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 std::string &filename, std::ostringstream &errorstream);
-
- /* Both these return true if the value existed or false otherwise */
-
+ bool LoadConf(FILE* &conf, const std::string &filename);
+
+ /** Writes 'length' chars into 'result' as a string
+ */
+ bool ConfValue(const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
+
+ /** Writes 'length' chars into 'result' as a string
+ */
+ bool ConfValue(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 char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
- bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
+ bool ConfValue(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, int index, std::string &result, bool allow_linefeeds = false);
- 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);
-
+ bool ConfValue(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(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(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 char* tag, const char* var, int index, int &result);
- bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
+ bool ConfValueInteger(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, int index, int &result);
- bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
-
+ bool ConfValueInteger(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);
- bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
+ bool ConfValueBool(const char* tag, const char* var, int index);
+
+ /** Returns true if the value exists and has a true value, false otherwise
+ */
+ bool ConfValueBool(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(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, int index);
- bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
-
+ bool ConfValueBool(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);
+ int ConfValueEnum(const char* tag);
/** Returns the number of occurences of tag in the config file
*/
- int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
-
+ int ConfValueEnum(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(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);
-
- Module* GetIOHook(int port);
- bool AddIOHook(int port, Module* iomod);
- bool DelIOHook(int port);
- Module* GetIOHook(InspSocket* is);
- bool AddIOHook(Module* iomod, InspSocket* is);
- bool DelIOHook(InspSocket* is);
-
- static std::string GetFullProgDir(char** argv, int argc);
- static bool DirValid(const char* dirandfile);
+ int ConfVarEnum(const std::string &tag, int index);
+
+ bool ApplyDisabledCommands(const char* data);
+
+ /** Returns the fully qualified path to the inspircd directory
+ * @return The full program directory
+ */
+ std::string GetFullProgDir();
+
+ /** Clean a filename, stripping the directories (and drives) from string.
+ * @param name Directory to tidy
+ * @return The cleaned filename
+ */
static char* CleanFilename(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;
+
+};
+
+
+/** Types of data in the core config
+ */
+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_LIMIT = 8, /* size_t */
+ DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */
+ DT_ALLOW_NEWLINE = 128 /* New line characters allowed in DT_CHARPTR */
+};
+
+/** The maximum number of values in a core configuration tag. Can be increased if needed.
+ */
+#define MAX_VALUES_PER_TAG 18
+
+/** 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
+{
+ /** Actual data */
+ std::string v;
+ public:
+ /** Initialize with an int */
+ ValueItem(int value);
+ /** Initialize with a bool */
+ ValueItem(bool value);
+ /** Initialize with a string */
+ ValueItem(const char* value) : v(value) { }
+ /** Change value to a string */
+ void Set(const std::string &val);
+ /** Change value to an int */
+ void Set(int value);
+ /** Get value as an int */
+ int GetInteger();
+ /** Get value as a string */
+ const char* GetString() const;
+ /** Get value as a string */
+ inline const std::string& GetValue() const { return v; }
+ /** Get value as a bool */
+ bool GetBool();
+};
+
+/** 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
+{
+ T ServerConfig::* const vptr;
+ public:
+ /** Initialize with a value of type T */
+ ValueContainer(T ServerConfig::* const offset) : vptr(offset)
+ {
+ }
+
+ /** Change value to type T of size s */
+ void Set(ServerConfig* conf, const T& value)
+ {
+ conf->*vptr = value;
+ }
+
+ void Set(ServerConfig* conf, const ValueItem& item);
+};
+
+template<> void ValueContainer<char[MAXBUF]>::Set(ServerConfig* conf, ValueItem const& item);
+
+
+class ValueContainerLimit : public ValueContainerBase
+{
+ size_t ServerLimits::* const vptr;
+ public:
+ /** Initialize with a value of type T */
+ ValueContainerLimit(size_t ServerLimits::* const offset) : vptr(offset)
+ {
+ }
+
+ /** Change value to type T of size s */
+ void Set(ServerConfig* conf, const size_t& value)
+ {
+ conf->Limits.*vptr = value;
+ }
+};
+
+/** 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[MAXBUF]> ValueContainerChar;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * a char array.
+ */
+typedef ValueContainer<std::string> ValueContainerString;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * an int
+ */
+typedef ValueContainer<int> ValueContainerInt;
+
+/** 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*, const char**, ValueList&, int*);
+/** A callback indicating the end of a group of entries
+ */
+typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
+
+/** 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;
};
-bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
+/** Represents a deprecated configuration tag.
+ */
+struct Deprecated
+{
+ /** Tag name
+ */
+ const char* tag;
+ /** Tag value
+ */
+ const char* value;
+ /** Reason for deprecation
+ */
+ const char* reason;
+};
-bool InitTypes(ServerConfig* conf, const char* tag);
-bool InitClasses(ServerConfig* conf, const char* tag);
-bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
+/** 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];
+ /** Validation function */
+ MultiValidator validation_function;
+};
#endif
projects / user / henk / code / inspircd.git / blobdiff