X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fconfigreader.h;h=022978766850785dc143ac4c4d5d7c4368279515;hb=8683e1c80d9d37ee7ffae54c0d888195a5e8d1a7;hp=6c000eb60c35ed0b7b42ecf9ff921a0a933811d2;hpb=f559b94fa33063e02b67fe589af04fddc20325ef;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 6c000eb60..022978766 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-2007 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,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 @@ -28,13 +31,21 @@ #include "socketengine.h" #include "socket.h" +/* Required forward definitions */ class ServerConfig; class InspIRCd; class InspSocket; /** 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_ALLOW_NEWLINE = 128 /* New line characters allowed */ +}; /** Holds a config value, either string, integer or boolean. * Callback functions receive one or more of these, either on @@ -44,16 +55,26 @@ 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); + /** Initialize with a char pointer */ ValueItem(char* value); + /** Change value to a char pointer */ void Set(char* value); + /** Change value to a const 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 +84,9 @@ class ValueItem class ValueContainerBase { public: + /** Constructor */ ValueContainerBase() { } + /** Destructor */ virtual ~ValueContainerBase() { } }; @@ -77,20 +100,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); @@ -134,10 +160,17 @@ typedef bool (*MultiNotify)(ServerConfig* conf, const char*); */ struct InitialConfig { + /** Tag name */ char* tag; + /** Value name */ char* value; + /** Default, if not defined */ + char* default_value; + /** Value containers */ ValueContainerBase* val; + /** Data types */ ConfigDataType datatype; + /** Validation function */ Validator validation_function; }; @@ -146,11 +179,19 @@ struct InitialConfig */ struct MultiConfig { + /** Tag name */ const char* tag; - char* items[12]; - int datatype[12]; + /** One or more items within tag */ + char* items[13]; + /** One or more defaults for items within tags */ + char* items_default[13]; + /** One or more data types */ + int datatype[13]; + /** Initialization function */ MultiNotify init_function; + /** Validation function */ MultiValidator validation_function; + /** Completion function */ MultiNotify finish_function; }; @@ -168,10 +209,10 @@ typedef std::map operclass_t; * 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; @@ -198,6 +239,9 @@ class ServerConfig : public Extensible public: + /* Pointer to function that validates dns server addresses (can be changed depending on platform) */ + Validator DNSServerValidator; + InspIRCd* GetInstance(); /** This holds all the information in the config file, @@ -222,6 +266,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 @@ -271,6 +319,14 @@ 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 last string found within a tag, or * an empty string. */ @@ -336,6 +392,17 @@ class ServerConfig : public Extensible */ 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. */ @@ -390,6 +457,10 @@ class ServerConfig : public Extensible */ bool HideBans; + /** Announce invites to the channel with a server notice + */ + bool AnnounceInvites; + /** If this is enabled then operators will * see invisible (+i) channels in /whois. */ @@ -399,10 +470,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. */ @@ -426,13 +496,9 @@ class ServerConfig : public Extensible */ std::vector module_names; - /** A list of ports which the server is listening on + /** A list of the classes for listening client ports */ - int ports[255]; - - /** A list of the file descriptors for the listening client ports - */ - ListenSocket* openSockfd[255]; + std::vector ports; /** Boolean sets of which modules implement which functions */ @@ -454,6 +520,10 @@ class ServerConfig : public Extensible */ std::string data005; + /** isupport strings + */ + std::vector isupport; + /** STATS characters in this list are available * only to operators. */ @@ -463,17 +533,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 */ @@ -488,6 +566,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; @@ -496,6 +584,22 @@ 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; + /** Construct a new ServerConfig */ ServerConfig(InspIRCd* Instance); @@ -504,6 +608,14 @@ class ServerConfig : public Extensible */ void ClearStack(); + /** Update the 005 vector + */ + void Update005(); + + /** Send the 005 numerics (ISUPPORT) to a user + */ + void Send005(userrec* user); + /** Read the entire configuration into memory * and initialize this class. All other methods * should be used only by the core. @@ -514,10 +626,19 @@ class ServerConfig : public Extensible */ 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. + */ + void ReportConfigError(const std::string &errormessage, bool bail, userrec* 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); + /** 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. */ @@ -527,24 +648,43 @@ class ServerConfig : public Extensible /** 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 */ @@ -560,26 +700,94 @@ class ServerConfig : public Extensible */ int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index); + /** 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); + + /** Delete a module hook from a client port. + * @param port The port to detatch from + * @return True if successful + */ bool DelIOHook(int port); + + /** Get a pointer to the module which has hooked the given InspSocket class. + * @parameter port Port number + * @return Returns a pointer to the hooking module, or NULL + */ Module* GetIOHook(InspSocket* is); + + /** Hook a module to an InspSocket class, so that it can receive notifications + * of low-level socket activity. + * @param iomod The module to hook to the socket + * @param is The InspSocket to attach to + * @return True if the hook was successful. + */ bool AddIOHook(Module* iomod, InspSocket* is); + + /** Delete a module hook from an InspSocket. + * @param is The InspSocket to detatch from. + * @return True if the unhook was successful + */ bool DelIOHook(InspSocket* is); - static std::string GetFullProgDir(char** argv, int argc); + /** 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); #endif +