X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fconfigreader.h;h=aea3555833169e2e5014983a2d13779884c8ac63;hb=99a1ea0892b575c6d66d9f4c0aab5042c261ce4a;hp=c6775bc298e3983e094f2abb96f8310b754aadc7;hpb=5d18f26b6bfb7a575b50dc2e3ad909131b9f75da;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/configreader.h b/include/configreader.h index c6775bc29..aea355583 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-2008 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 @@ -25,40 +28,212 @@ #include "inspircd.h" #include "globals.h" #include "modules.h" +#include "socketengine.h" +#include "socket.h" + +/* Required forward definitions */ +class ServerConfig; +class InspIRCd; +class BufferedSocket; + +/** Types of data in the core config + */ +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 */ +}; -typedef bool (*Validator)(const char*, const char*, void*); -typedef bool (*MultiValidator)(const char*, char**, void**, int*); -typedef bool (*MultiNotify)(const char*); +/** 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. + * The callback function can then alter the values of the ValueItem + * classes to validate the settings. + */ +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(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(); +}; -enum ConfigDataType { DT_NOTHING, DT_INTEGER, DT_CHARPTR, DT_BOOLEAN }; +/** The base class of the container 'ValueContainer' + * used internally by the core to hold core values. + */ +class ValueContainerBase +{ + public: + /** Constructor */ + ValueContainerBase() { } + /** Destructor */ + virtual ~ValueContainerBase() { } +}; + +/** ValueContainer is used to contain pointers to different + * core values such as the server name, maximum number of + * clients etc. + * It is specialized to hold a data type, then pointed at + * a value in the ServerConfig class. When the value has been + * read and validated, the Set method is called to write the + * value safely in a type-safe manner. + */ +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); + } +}; + +/** A specialization of ValueContainer to hold a pointer to a bool + */ +typedef ValueContainer ValueContainerBool; + +/** A specialization of ValueContainer to hold a pointer to + * an unsigned int + */ +typedef ValueContainer ValueContainerUInt; + +/** A specialization of ValueContainer to hold a pointer to + * a char array. + */ +typedef ValueContainer ValueContainerChar; + +/** A specialization of ValueContainer to hold a pointer to + * an int + */ +typedef ValueContainer ValueContainerInt; +/** A set of ValueItems used by multi-value validator functions + */ +typedef std::deque ValueList; + +/** A callback for validating a single value + */ +typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&); +/** A callback for validating multiple value entries + */ +typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*); +/** A callback indicating the end of a group of entries + */ +typedef bool (*MultiNotify)(ServerConfig* conf, const char*); + +/** Holds a core configuration item and its callbacks + */ struct InitialConfig { - char* tag; - char* value; - void* val; - ConfigDataType datatype; + /** Tag name */ + const char* tag; + /** Value name */ + const char* value; + /** Default, if not defined */ + const char* default_value; + /** Value containers */ + ValueContainerBase* val; + /** Data types */ + int datatype; + /** Validation function */ Validator validation_function; }; -struct MultiConfig +struct Deprecated { const char* tag; - char* items[12]; - int datatype[12]; + 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; + /** 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; }; +/** A set of oper types + */ +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; + + /** 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 pointer + */ + InspIRCd* ServerInstance; + /** This variable holds the names of all * files included from the main one. This * is used to make sure that no files are @@ -70,25 +245,73 @@ 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 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. */ ConfigDataHash config_data; + /** Max number of WhoWas entries per user. + */ + int WhoWasGroupSize; + + /** Max number of cumulative user-entries in WhoWas. + * When max reached and added to, push out oldest entry FIFO style. + */ + int WhoWasMaxGroups; + + /** Max seconds a user is kept in WhoWas before being pruned. + */ + int WhoWasMaxKeep; + /** 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 @@ -124,6 +347,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. */ @@ -138,6 +365,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. */ @@ -160,10 +407,6 @@ class ServerConfig : public Extensible */ char ModPath[1024]; - /** The temporary directory where modules are copied - */ - char TempDir[1024]; - /** The full pathname to the executable, as * given in argv[0] when the program starts. */ @@ -207,6 +450,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. */ @@ -243,10 +497,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. */ @@ -261,6 +511,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. */ @@ -270,10 +524,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. */ @@ -292,30 +545,13 @@ 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 - */ - int openSockfd[MAX_DESCRIPTORS]; - - /** Boolean sets of which modules implement which functions - */ - char implement_lists[255][255]; - - /** Global implementation list + /** A list of the classes for listening client ports */ - char global_implementation[255]; + std::vector ports; - /** A list of ports claimed by IO Modules + /** socket objects that are attached to by modules */ - std::map IOHookModule; + std::map SocketIOHookModule; /** The 005 tokens of this server (ISUPPORT) * populated/repopulated upon loading or unloading @@ -323,77 +559,301 @@ class ServerConfig : public Extensible */ std::string data005; + /** isupport strings + */ + std::vector isupport; + /** STATS characters in this list are available * only to operators. */ - char OperOnlyStats[MAXBUF]; + char UserStats[MAXBUF]; /** The path and filename of the ircd.log file */ 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 */ bool NoUserDns; - ServerConfig(); + /** If set to true, provide syntax hints for unknown commands + */ + bool SyntaxHints; + + /** If set to true, users appear to quit then rejoin when their hosts change. + * This keeps clients synchronized properly. + */ + 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; - /** Clears the include stack in preperation for - * a Read() call. + /** All oper type definitions from the config file + */ + opertype_t opertypes; + + /** All oper class definitions from the config file + */ + 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); + + /** Clears the include stack in preperation for a Read() call. */ 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(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); + + /** 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 opers. + */ + 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, const std::string &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, 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 ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result); + /** 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' */ + /** 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 */ + /** 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 */ + /** Returns the number of occurences of tag in the config file + */ int ConfValueEnum(ConfigDataHash &target, const char* tag); + /** Returns the number of occurences of tag in the config file + */ int ConfValueEnum(ConfigDataHash &target, const std::string &tag); - /* Returns the numbers of vars inside the index'th 'tag in the config file */ + /** Returns the numbers of vars inside the index'th 'tag in the config file + */ int ConfVarEnum(ConfigDataHash &target, const char* tag, int index); + /** Returns the numbers of vars inside the index'th 'tag in the config file + */ int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index); + + 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); - Module* GetIOHook(int port); - bool AddIOHook(int port, Module* iomod); - bool DelIOHook(int port); }; -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 +