X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=aea3555833169e2e5014983a2d13779884c8ac63;hb=99a1ea0892b575c6d66d9f4c0aab5042c261ce4a;hp=4d5435b1ca43de55f5a4314c34083d0301678849;hpb=ef048989f89eb15b4fc92b83f3ff58805e44a064;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 4d5435b1c..aea355583 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 @@ -31,19 +31,26 @@ #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 */ }; /** Holds a config value, either string, integer or boolean. @@ -54,16 +61,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(); }; @@ -73,7 +88,9 @@ class ValueItem class ValueContainerBase { public: + /** Constructor */ ValueContainerBase() { } + /** Destructor */ virtual ~ValueContainerBase() { } }; @@ -87,20 +104,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); @@ -144,25 +164,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[18]; + /** One or more defaults for items within tags */ + const char* items_default[18]; + /** One or more data types */ + int datatype[18]; + /** Initialization function */ MultiNotify init_function; + /** Validation function */ MultiValidator validation_function; + /** Completion function */ MultiNotify finish_function; }; @@ -170,9 +210,16 @@ 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; /** This class holds the bulk of the runtime configuration for the ircd. @@ -183,7 +230,7 @@ typedef std::map operclass_t; class CoreExport ServerConfig : public Extensible { private: - /** Creator/owner + /** Creator/owner pointer */ InspIRCd* ServerInstance; @@ -198,19 +245,46 @@ 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); - - /** 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; + + std::map CompletedFiles; + + size_t TotalDownloaded; + size_t FileErrors; + + /** 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. @@ -273,6 +347,10 @@ class CoreExport 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. */ @@ -295,6 +373,18 @@ class CoreExport 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. */ @@ -407,10 +497,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. */ @@ -427,7 +513,7 @@ class CoreExport 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. @@ -459,34 +545,22 @@ class CoreExport 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 the classes for listening client ports */ std::vector ports; - /** 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 + /** socket objects that are attached to by 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 @@ -565,6 +639,18 @@ class CoreExport 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); @@ -573,74 +659,86 @@ class CoreExport 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. - */ - /** 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 @@ -656,27 +754,106 @@ class CoreExport 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); + 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); }; +/** 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 +