X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=0b05262b436e30e7e2d5dabd73a4d1693b2feb0e;hb=a3fb932831ca09b2a931616f1701ea39429356c2;hp=622c44d0d9ae61b8138c418c1afb437ec533a5ab;hpb=f240285155d115ee3a0fd437944f2bec05a0c14c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 622c44d0d..0b05262b4 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -2,13 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -18,23 +14,47 @@ #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 #include #include #include #include "inspircd.h" -#include "globals.h" #include "modules.h" #include "socketengine.h" #include "socket.h" +/* Required forward definitions */ class ServerConfig; class InspIRCd; -class InspSocket; +class BufferedSocket; /** Types of data in the core config */ -enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN }; +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 */ +}; + +/** 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 @@ -44,16 +64,24 @@ enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN }; */ class ValueItem { + /** Actual data */ std::string v; public: + /** Initialize with an int */ ValueItem(int value); + /** Initialize with a bool */ ValueItem(bool value); - ValueItem(char* value); - void Set(char* 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(); }; @@ -63,7 +91,9 @@ class ValueItem class ValueContainerBase { public: + /** Constructor */ ValueContainerBase() { } + /** Destructor */ virtual ~ValueContainerBase() { } }; @@ -77,20 +107,23 @@ class ValueContainerBase */ template class ValueContainer : public ValueContainerBase { + /** Contained item */ T val; - public: + /** Initialize with nothing */ ValueContainer() { val = NULL; } + /** Initialize with a value of type T */ ValueContainer(T Val) { val = Val; } + /** Change value to type T of size s */ void Set(T newval, size_t s) { memcpy(val, newval, s); @@ -116,6 +149,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; @@ -134,23 +172,53 @@ typedef bool (*MultiNotify)(ServerConfig* conf, const char*); */ struct InitialConfig { - char* tag; - char* value; + /** Tag name */ + const char* tag; + /** Value name */ + const char* value; + /** Default, if not defined */ + const char* default_value; + /** Value containers */ ValueContainerBase* val; - ConfigDataType datatype; + /** 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; - char* items[12]; - int datatype[12]; + /** 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; }; @@ -158,20 +226,89 @@ struct MultiConfig */ 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, * 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 Extensible { private: - /** Creator/owner + /** Creator/owner pointer */ InspIRCd* ServerInstance; @@ -186,25 +323,76 @@ class 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); - - /** Process an include directive + 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); + + 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); - /** Check that there is only one of each configuration item + /** 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. */ - bool CheckOnce(char* tag, bool bail, userrec* user); - - public: + 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; + + /** 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 }; + + /** 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(); /** 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; @@ -218,10 +406,19 @@ class 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. */ 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 @@ -257,6 +454,10 @@ class ServerConfig : public Extensible */ 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. */ @@ -271,6 +472,26 @@ class ServerConfig : public Extensible */ 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 tag, or * an empty string. */ @@ -280,12 +501,25 @@ class 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 @@ -331,11 +565,27 @@ class ServerConfig : public Extensible */ bool writelog; + /** 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. */ @@ -372,10 +622,6 @@ class 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. */ @@ -390,6 +636,10 @@ class ServerConfig : public Extensible */ 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. */ @@ -399,10 +649,9 @@ class ServerConfig : public Extensible */ 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. */ @@ -421,38 +670,18 @@ class ServerConfig : public Extensible */ ClassVector Classes; - /** A list of module names (names only, no paths) - * which are currently loaded by the server. - */ - std::vector 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 + /** A list of the classes for listening ports */ - std::map IOHookModule; - - std::map SocketIOHookModule; + std::vector ports; /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading * modules. */ std::string data005; + + /** isupport strings + */ std::vector isupport; /** STATS characters in this list are available @@ -464,17 +693,25 @@ class ServerConfig : public Extensible */ 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 ulines; + std::map ulines; /** Max banlist sizes for channels (the std::string is a glob) */ - std::map maxbans; + std::map maxbans; + + /** Directory where the inspircd binary resides + */ + std::string MyDir; /** If set to true, no user DNS lookups are to be performed */ @@ -489,6 +726,16 @@ class ServerConfig : public Extensible */ bool CycleHosts; + /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix + * added to the outgoing text for undernet style msg prefixing. + */ + bool UndernetMsgPrefix; + + /** If set to true, the full nick!user@host will be shown in the TOPIC command + * for who set the topic last. If false, only the nick is shown. + */ + bool FullHostInTopic; + /** All oper type definitions from the config file */ opertype_t opertypes; @@ -497,6 +744,34 @@ class ServerConfig : public Extensible */ operclass_t operclass; + /** Saved argv from startup + */ + char** argv; + + /** Saved argc from startup + */ + 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); @@ -505,55 +780,97 @@ class ServerConfig : public Extensible */ void ClearStack(); + /** Get server ID as string with required leading zeroes + */ + std::string GetSID(); + /** Update the 005 vector */ void Update005(); /** Send the 005 numerics (ISUPPORT) to a user */ - void Send005(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(bool bail, 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 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, const char* filename, std::ostringstream &errorstream); + bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream); + /** 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(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream); /** 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 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); + /** 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 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 */ @@ -568,27 +885,96 @@ class ServerConfig : public Extensible /** 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); + + /** 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); + + /** 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; + }; -bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance); +/** 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 +