X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=56a2ee6988185d3b82894acb9dbb2d573e251514;hb=7d7250484c352c13830e63ae41ee8faae40a9bd5;hp=eefa359c9e523567a90d3643a05afce4350620a4;hpb=cba3552f3a77f1c98dd2a718b4b5d9864267b48d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index eefa359c9..56a2ee698 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * InspIRCd: (C) 2002-2008 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see @@ -14,6 +14,13 @@ #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 @@ -24,21 +31,32 @@ #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 = 0, - DT_INTEGER = 1, - DT_CHARPTR = 2, - DT_BOOLEAN = 3, - DT_ALLOW_NEWLINE = 128 + 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 * their own as a reference, or in a reference to a deque of them. @@ -47,16 +65,24 @@ enum ConfigDataType */ 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(); }; @@ -66,7 +92,9 @@ class ValueItem class ValueContainerBase { public: + /** Constructor */ ValueContainerBase() { } + /** Destructor */ virtual ~ValueContainerBase() { } }; @@ -80,20 +108,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); @@ -137,25 +168,45 @@ typedef bool (*MultiNotify)(ServerConfig* conf, const char*); */ struct InitialConfig { - char* tag; - char* value; - char* default_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; }; +struct Deprecated +{ + const char* tag; + const char* value; + 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[13]; - char* items_default[13]; - int datatype[13]; + /** 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; }; @@ -163,20 +214,49 @@ struct MultiConfig */ typedef std::map opertype_t; +struct operclass_data : public Extensible +{ + char* commandlist; + char* cmodelist; + char* umodelist; +}; + /** A Set of oper classes */ -typedef std::map operclass_t; +typedef std::map operclass_t; +class ServerLimits : public Extensible +{ + public: + size_t NickMax; + size_t ChanMax; + size_t MaxModes; + size_t IdentMax; + size_t MaxQuit; + size_t MaxTopic; + size_t MaxKick; + size_t MaxGecos; + 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) + { + } +}; + /** 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; @@ -191,25 +271,49 @@ 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 DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream); + bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream); /** Check that there is only one of each configuration item */ - bool CheckOnce(char* tag, bool bail, userrec* user); - - public: + 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); + + User* RehashUser; + + std::string RehashParameter; + + std::ostringstream errstr; + + ConfigDataHash newconfig; + + 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; InspIRCd* GetInstance(); + + 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; + ServerLimits Limits; + /** Max number of WhoWas entries per user. */ int WhoWasGroupSize; @@ -227,6 +331,10 @@ class ServerConfig : public Extensible * 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 @@ -262,6 +370,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. */ @@ -284,6 +396,18 @@ class ServerConfig : public Extensible */ 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. */ @@ -355,6 +479,11 @@ class ServerConfig : public Extensible */ 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. */ @@ -391,10 +520,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. */ @@ -411,7 +536,7 @@ class ServerConfig : public Extensible /** Announce invites to the channel with a server notice */ - bool AnnounceInvites; + InviteAnnounceState AnnounceInvites; /** If this is enabled then operators will * see invisible (+i) channels in /whois. @@ -426,11 +551,6 @@ class ServerConfig : public Extensible */ char HideKillsServer[MAXBUF]; - /** A list of IP addresses the server is listening - * on. - */ - char addrs[MAXBUF][255]; - /** The MOTD file, cached in a file_cache type. */ file_cache MOTD; @@ -448,38 +568,22 @@ 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 + /** A list of the classes for listening client ports */ - ListenSocket* openSockfd[255]; + std::vector ports; - /** Boolean sets of which modules implement which functions + /** socket objects that are attached to by modules */ - char implement_lists[255][255]; - - /** Global implementation list - */ - char global_implementation[255]; - - /** A list of ports claimed by IO Modules - */ - std::map IOHookModule; - - std::map SocketIOHookModule; + std::map SocketIOHookModule; /** 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 @@ -491,6 +595,10 @@ 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]; @@ -501,7 +609,7 @@ class ServerConfig : public Extensible /** Max banlist sizes for channels (the std::string is a glob) */ - std::map maxbans; + std::map maxbans; /** Directory where the inspircd binary resides */ @@ -554,6 +662,18 @@ class ServerConfig : public Extensible */ 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); @@ -562,74 +682,90 @@ 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, User* user); /** Read a file into a file_cache object */ bool ReadFile(file_cache &F, const char* fname); - /** 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. + /* 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 users via WriteOpers as SNOTICEs. + * If the parameter is NULL, the messages are spooled to all opers. */ - void ReportConfigError(const std::string &errormessage, bool bail, userrec* user); + void ReportConfigError(const std::string &errormessage, bool bail, 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. */ - 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); + bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream); /* Both these return true if the value existed or false otherwise */ /** Writes 'length' chars into 'result' as a string */ bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool 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 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 @@ -645,27 +781,106 @@ 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); + + 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 BufferedSocket class. + * @parameter port Port number + * @return Returns a pointer to the hooking module, or NULL + */ + Module* GetIOHook(BufferedSocket* is); + + /** 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. + */ + bool AddIOHook(Module* iomod, BufferedSocket* is); + + /** Delete a module hook from an BufferedSocket. + * @param is The BufferedSocket to detatch from. + * @return True if the unhook was successful + */ + bool DelIOHook(BufferedSocket* is); + + /** 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); }; -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 +