X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=2bb7af091217e5fef51d2a8038dca673a4cc095a;hb=d3c7457dda8555e410f4fbc36bb1b1b4cb0ae3f2;hp=838814cc451de8fc4e37aea9452cc697e33a1404;hpb=d6fcf2726e4075fb323010e067964c84044cbf08;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index 838814cc4..2bb7af091 100644 --- a/include/configreader.h +++ b/include/configreader.h @@ -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,19 +31,20 @@ #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_ALLOW_NEWLINE = 128 /* New line characters allowed */ }; /** Holds a config value, either string, integer or boolean. @@ -47,16 +55,26 @@ enum ConfigDataType */ 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(); }; @@ -66,7 +84,9 @@ class ValueItem class ValueContainerBase { public: + /** Constructor */ ValueContainerBase() { } + /** Destructor */ virtual ~ValueContainerBase() { } }; @@ -80,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); @@ -137,11 +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; }; @@ -150,12 +179,19 @@ struct InitialConfig */ struct MultiConfig { + /** Tag name */ const char* tag; - char* items[13]; - char* items_default[13]; - int datatype[13]; + /** One or more items within tag */ + char* items[17]; + /** One or more defaults for items within tags */ + char* items_default[17]; + /** One or more data types */ + int datatype[17]; + /** Initialization function */ MultiNotify init_function; + /** Validation function */ MultiValidator validation_function; + /** Completion function */ MultiNotify finish_function; }; @@ -173,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; @@ -191,7 +227,7 @@ 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); + bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream); /** Process an include directive */ @@ -199,10 +235,16 @@ class ServerConfig : public Extensible /** Check that there is only one of each configuration item */ - bool CheckOnce(char* tag, bool bail, userrec* user); + bool CheckOnce(char* tag) throw (CoreException); public: + /** 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(); /** This holds all the information in the config file, @@ -227,6 +269,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 @@ -353,7 +399,12 @@ class ServerConfig : public Extensible * MODE #chan b) are hidden from unprivileged * users. */ - bool HideModeLists; + 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. @@ -411,7 +462,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. @@ -422,10 +473,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. */ @@ -449,13 +499,9 @@ class ServerConfig : public Extensible */ 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 */ @@ -469,13 +515,16 @@ class ServerConfig : public Extensible */ 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 @@ -487,6 +536,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]; @@ -497,7 +550,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 */ @@ -550,6 +603,13 @@ 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. + */ + int sid; + /** Construct a new ServerConfig */ ServerConfig(InspIRCd* Instance); @@ -558,35 +618,35 @@ 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. - */ - /** 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); + 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. @@ -603,29 +663,41 @@ 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 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 @@ -642,26 +714,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); - Module* GetIOHook(InspSocket* is); - bool AddIOHook(Module* iomod, InspSocket* is); - bool DelIOHook(InspSocket* is); + + /** 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(); - static std::string GetFullProgDir(char** argv, int argc); + /** 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 +