* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- * <omster@gmail.com>
- *
- * 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.
*
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,
+ DT_INTEGER = 1,
+ DT_CHARPTR = 2,
+ DT_BOOLEAN = 3,
+ DT_ALLOW_NEWLINE = 128
+};
+/** 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
{
std::string v;
public:
- ValueItem(int value)
- {
- std::stringstream n;
- n << value;
- v = n.str();
- }
-
- ValueItem(bool value)
- {
- std::stringstream n;
- n << value;
- v = n.str();
- }
-
- ValueItem(char* value)
- {
- v = value;
- }
-
- void Set(char* value)
- {
- v = value;
- }
-
- void Set(const char* value)
- {
- v = value;
- }
-
- void Set(int value)
- {
- std::stringstream n;
- n << value;
- v = n.str();
- }
-
- int GetInteger()
- {
- return atoi(v.c_str());
- }
-
- char* GetString()
- {
- return (char*)v.c_str();
- }
-
- bool GetBool()
- {
- return (GetInteger() || v == "yes" || v == "true");
- }
+ ValueItem(int value);
+ ValueItem(bool value);
+ ValueItem(char* value);
+ void Set(char* value);
+ void Set(const char* val);
+ void Set(int value);
+ int GetInteger();
+ char* GetString();
+ bool GetBool();
};
+/** The base class of the container 'ValueContainer'
+ * used internally by the core to hold core values.
+ */
class ValueContainerBase
{
public:
- ValueContainerBase()
- {
- }
-
- virtual ~ValueContainerBase()
- {
- }
+ ValueContainerBase() { }
+ 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<typename T> class ValueContainer : public ValueContainerBase
{
T val;
}
};
+/** A specialization of ValueContainer to hold a pointer to a bool
+ */
typedef ValueContainer<bool*> ValueContainerBool;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * an unsigned int
+ */
typedef ValueContainer<unsigned int*> ValueContainerUInt;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * a char array.
+ */
typedef ValueContainer<char*> ValueContainerChar;
+
+/** A specialization of ValueContainer to hold a pointer to
+ * an int
+ */
typedef ValueContainer<int*> ValueContainerInt;
+/** A set of ValueItems used by multi-value validator functions
+ */
typedef std::deque<ValueItem> ValueList;
/** A callback for validating a single value
*/
typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
-
/** Holds a core configuration item and its callbacks
*/
struct InitialConfig
{
char* tag;
char* value;
+ char* default_value;
ValueContainerBase* val;
ConfigDataType datatype;
Validator validation_function;
*/
struct MultiConfig
{
- const char* tag;
- char* items[12];
- int datatype[12];
+ const char* tag;
+ char* items[13];
+ char* items_default[13];
+ int datatype[13];
MultiNotify init_function;
MultiValidator validation_function;
MultiNotify finish_function;
*/
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.
*/
*/
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.
*/
*/
bool AllowHalfop;
+ /** If this is set to true, then mode lists (e.g
+ * MODE #chan b) are hidden from unprivileged
+ * users.
+ */
+ bool HideModeLists[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
+ */
+ bool AnnounceInvites;
+
/** If this is enabled then operators will
* see invisible (+i) channels in /whois.
*/
*/
char HideWhoisServer[MAXBUF];
+ /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
+ */
+ char HideKillsServer[MAXBUF];
+
/** A list of IP addresses the server is listening
* on.
*/
*/
std::map<int,Module*> IOHookModule;
+ std::map<InspSocket*, Module*> SocketIOHookModule;
+
/** The 005 tokens of this server (ISUPPORT)
* populated/repopulated upon loading or unloading
* modules.
*/
std::string data005;
+ std::vector<std::string> isupport;
/** STATS characters in this list are available
* only to operators.
/** 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;
+ /** Directory where the inspircd binary resides
+ */
+ std::string MyDir;
+
/** If set to true, no user DNS lookups are to be performed
*/
bool NoUserDns;
*/
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;
*/
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);
*/
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.
*/
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);
+
/** 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.
*/
/** 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);
+ 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);
+ 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);
+ 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);
+ 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);
+ 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);
+ 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
*/
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);
static std::string GetFullProgDir(char** argv, int argc);
static bool DirValid(const char* dirandfile);