X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=cc0c06d38ebfff6cb4dab121caa10f4678bd5063;hb=b9e42dee051a50f448b87d4d670d897c915fd55b;hp=e74895e8bd1315d555f68a3e7c2353c373f3e70a;hpb=bfaf7e3b27981a5144faba6d17c6e29fac735dbb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index e74895e8b..cc0c06d38 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 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. @@ -17,7 +17,7 @@ /* handy defines */ /** Determines if a channel op is exempt from given mode m, - * in config of server instance s. + * in config of server instance s. */ #define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m]) @@ -26,7 +26,6 @@ #include #include #include "inspircd.h" -#include "globals.h" #include "modules.h" #include "socketengine.h" #include "socket.h" @@ -52,6 +51,10 @@ enum ConfigDataType 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. @@ -145,6 +148,11 @@ typedef ValueContainer ValueContainerChar; */ typedef ValueContainer ValueContainerInt; +/** A specialization of ValueContainer to hold a pointer to + * a size_t. + */ +typedef ValueContainer ValueContainerST; + /** A set of ValueItems used by multi-value validator functions */ typedef std::deque ValueList; @@ -172,11 +180,26 @@ struct InitialConfig /** Value containers */ ValueContainerBase* val; /** Data types */ - ConfigDataType datatype; + 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 */ @@ -185,11 +208,11 @@ struct MultiConfig /** Tag name */ const char* tag; /** One or more items within tag */ - const char* items[18]; + const char* items[MAX_VALUES_PER_TAG]; /** One or more defaults for items within tags */ - const char* items_default[18]; + const char* items_default[MAX_VALUES_PER_TAG]; /** One or more data types */ - int datatype[18]; + int datatype[MAX_VALUES_PER_TAG]; /** Initialization function */ MultiNotify init_function; /** Validation function */ @@ -200,12 +223,81 @@ struct MultiConfig /** A set of oper types */ -typedef std::map opertype_t; +typedef std::map 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 operclass_t; +typedef std::map operclass_t; +/** Defines the server's length limits on various length-limited + * items such as topics, nicknames, channel names etc. + */ +class ServerLimits : public Extensible +{ + 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) + { + } + + /** 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++; + } +}; /** This class holds the bulk of the runtime configuration for the ircd. * It allows for reading new config values, accessing configuration files, @@ -230,28 +322,31 @@ class CoreExport ServerConfig : public Extensible * 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, int pass, std::istream* scan_for_includes_only); - - /** Process an include directive - */ - bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream, int pass, std::istream* scan_for_includes_only); + bool ParseLine(const std::string &filename, std::string &line, long &linenumber); /** Check that there is only one of each configuration item */ bool CheckOnce(const char* tag); public: + /** Process an include executable directive + */ + bool DoPipe(const std::string &file); - std::ostringstream errstr; - - ConfigDataHash newconfig; + /** Process an include file directive + */ + bool DoInclude(const std::string &file); - std::map IncludedFiles; + /** Error stream, contains error output from any failed configuration parsing. + */ + std::stringstream errstr; - std::map CompletedFiles; + /** True if this configuration is valid enough to run with */ + bool valid; - size_t TotalDownloaded; - size_t FileErrors; + /** Set of included files. Do we use this any more? + */ + std::map 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 }; @@ -259,15 +354,33 @@ class CoreExport ServerConfig : public Extensible /** Pointer to function that validates dns server addresses (can be changed depending on platform) */ Validator DNSServerValidator; + /** Returns the creator InspIRCd pointer + */ InspIRCd* GetInstance(); - void DoDownloads(); - + /** 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; @@ -281,6 +394,11 @@ class CoreExport ServerConfig : public Extensible */ 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. */ @@ -289,7 +407,7 @@ class CoreExport ServerConfig : public Extensible /** 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. @@ -371,12 +489,25 @@ class CoreExport ServerConfig : public Extensible */ 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 @@ -403,7 +534,7 @@ class CoreExport ServerConfig : public Extensible * foreground. */ bool nofork; - + /** If this value if true then all log * messages will be output, regardless of * the level given in the config file. @@ -411,7 +542,7 @@ class CoreExport ServerConfig : public Extensible * 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 @@ -422,6 +553,17 @@ class CoreExport ServerConfig : public Extensible */ 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. */ @@ -474,10 +616,6 @@ class CoreExport ServerConfig : public Extensible */ 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. */ @@ -526,16 +664,6 @@ class CoreExport ServerConfig : public Extensible */ ClassVector Classes; - /** A list of the classes for listening client ports - */ - std::vector ports; - - /** A list of ports claimed by IO Modules - */ - std::map IOHookModule; - - std::map SocketIOHookModule; - /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading * modules. @@ -550,7 +678,7 @@ class CoreExport ServerConfig : public Extensible * only to operators. */ char UserStats[MAXBUF]; - + /** The path and filename of the ircd.log file */ std::string logpath; @@ -629,6 +757,11 @@ class CoreExport ServerConfig : public Extensible */ 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); @@ -653,143 +786,113 @@ class CoreExport ServerConfig : public Extensible * and initialize this class. All other methods * should be used only by the core. */ - void Read(bool bail, User* user, int pass); + void Read(); + + /** Apply configuration changes from the old configuration. + */ + void Apply(ServerConfig* old, const std::string &useruid); /** Read a file into a file_cache object */ bool ReadFile(file_cache &F, const char* 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 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 opers. */ - void ReportConfigError(const std::string &errormessage, bool bail, User* user); + void ReportConfigError(const std::string &errormessage); /** 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, int pass, std::istream* scan_for_includs_only); + 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, int pass, std::istream* scan_for_includs_only = NULL); - - /* 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(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false); + 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(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 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); + 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, 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(ConfigDataHash &target, const char* tag, const char* var, int index, int &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(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &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 std::string &tag, const std::string &var, 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, 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(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); + 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(ConfigDataHash &target, const std::string &tag, const std::string &var, int index); + 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, 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); - - void ValidateHostname(const char* p, const std::string &tag, const std::string &val); - - void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild); - - void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val); - - /** Get a pointer to the module which has hooked the given port. - * @parameter port Port number - * @return Returns a pointer to the hooking module, or NULL - */ - Module* GetIOHook(int port); - - /** Hook a module to a client port, so that it can receive notifications - * of low-level port activity. - * @param port The port number - * @param Module the module to hook to the port - * @return True if the hook was successful. - */ - bool AddIOHook(int port, Module* iomod); + int ConfVarEnum(const std::string &tag, int index); - /** Delete a module hook from a client port. - * @param port The port to detatch from - * @return True if successful + /** Validates a hostname value, throwing ConfigException if it is not valid */ - bool DelIOHook(int port); - - /** Get a pointer to the module which has hooked the given BufferedSocket class. - * @parameter port Port number - * @return Returns a pointer to the hooking module, or NULL - */ - Module* GetIOHook(BufferedSocket* is); + void ValidateHostname(const char* p, const std::string &tag, const std::string &val); - /** Hook a module to an BufferedSocket class, so that it can receive notifications - * of low-level socket activity. - * @param iomod The module to hook to the socket - * @param is The BufferedSocket to attach to - * @return True if the hook was successful. + /** Validates an IP address value, throwing ConfigException if it is not valid */ - bool AddIOHook(Module* iomod, BufferedSocket* is); + void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild); - /** Delete a module hook from an BufferedSocket. - * @param is The BufferedSocket to detatch from. - * @return True if the unhook was successful + /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid */ - bool DelIOHook(BufferedSocket* is); + 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); - /** Clean a filename, stripping the directories (and drives) from string. * @param name Directory to tidy * @return The cleaned filename @@ -801,7 +904,11 @@ class CoreExport ServerConfig : public Extensible * @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; + }; /** Initialize the disabled commands list @@ -816,7 +923,7 @@ bool InitTypes(ServerConfig* conf, const char* tag); */ bool InitClasses(ServerConfig* conf, const char* tag); -/** Initialize an oper type +/** Initialize an oper type */ bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); @@ -833,7 +940,7 @@ 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); @@ -850,8 +957,4 @@ bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &val */ bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); - - - #endif -