#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 <sstream>
#include <string>
#include <vector>
#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.
*/
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();
};
class ValueContainerBase
{
public:
+ /** Constructor */
ValueContainerBase() { }
+ /** Destructor */
virtual ~ValueContainerBase() { }
};
*/
template<typename T> 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);
*/
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;
};
*/
struct MultiConfig
{
+ /** Tag name */
const char* tag;
- char* items[12];
- char* items_default[12];
- int datatype[12];
+ /** 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;
};
* 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;
* 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
*/
/** 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,
* 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
*/
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 <die> tag, or
* an empty string.
*/
*/
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.
*/
*/
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.
*/
*/
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.
*/
*/
std::vector<std::string> 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<ListenSocket*> ports;
/** Boolean sets of which modules implement which functions
*/
*/
std::map<int,Module*> IOHookModule;
- std::map<InspSocket*, Module*> SocketIOHookModule;
+ std::map<BufferedSocket*, Module*> SocketIOHookModule;
/** The 005 tokens of this server (ISUPPORT)
* populated/repopulated upon loading or unloading
* modules.
*/
std::string data005;
+
+ /** isupport strings
+ */
std::vector<std::string> isupport;
/** STATS characters in this list are available
*/
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<irc::string> ulines;
+ std::map<irc::string, bool> ulines;
/** Max banlist sizes for channels (the std::string is a glob)
*/
- std::map<std::string,int> maxbans;
+ std::map<std::string, int> maxbans;
/** Directory where the inspircd binary resides
*/
*/
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);
*/
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.
/** 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
*/
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);
- 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
+
projects / user / henk / code / inspircd.git / blobdiff