* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
/* handy defines */
/** Determines if a channel op is exempt from given mode m,
- * in config of server instance s.
+ * in config of server instance s.
*/
#define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
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 */
+ DT_ALLOW_NEWLINE = 128 /* New line characters allowed in DT_CHARPTR */
};
/** The maximum number of values in a core configuration tag. Can be increased if needed.
*/
typedef ValueContainer<int*> ValueContainerInt;
+/** A specialization of ValueContainer to hold a pointer to
+ * a size_t.
+ */
typedef ValueContainer<size_t*> ValueContainerST;
/** A set of ValueItems used by multi-value validator functions
Validator validation_function;
};
+/** Represents a deprecated configuration tag.
+ */
struct Deprecated
{
+ /** Tag name
+ */
const char* tag;
+ /** Tag value
+ */
const char* value;
+ /** Reason for deprecation
+ */
const char* reason;
};
/** A set of oper types
*/
-typedef std::map<irc::string,char*> opertype_t;
+typedef std::map<irc::string,std::string> opertype_t;
+/** Holds an oper class.
+ */
struct operclass_data : public Extensible
{
- char* commandlist;
- char* cmodelist;
- char* umodelist;
+ /** Command list for the class
+ */
+ char *commandlist;
+
+ /** Channel mode list for the class
+ */
+ char *cmodelist;
+
+ /** User mode list for the class
+ */
+ char *umodelist;
+
+ /** Priviledges given by this class
+ */
+ char *privs;
};
/** A Set of oper classes
*/
typedef std::map<irc::string, operclass_data> operclass_t;
-
+/** Defines the server's length limits on various length-limited
+ * items such as topics, nicknames, channel names etc.
+ */
class ServerLimits : public Extensible
{
public:
+ /** Maximum nickname length */
size_t NickMax;
+ /** Maximum channel length */
size_t ChanMax;
+ /** Maximum number of modes per line */
size_t MaxModes;
+ /** Maximum length of ident, not including ~ etc */
size_t IdentMax;
+ /** Maximum length of a quit message */
size_t MaxQuit;
+ /** Maximum topic length */
size_t MaxTopic;
+ /** Maximum kick message length */
size_t MaxKick;
+ /** Maximum GECOS (real name) length */
size_t MaxGecos;
+ /** Maximum away message length */
size_t MaxAway;
- /* Creating the class initialises it to the defaults
+ /** Creating the class initialises it to the defaults
* as in 1.1's ./configure script. Reading other values
* from the config will change these values.
*/
{
}
+ /** Finalises the settings by adding one. This allows for them to be used as-is
+ * without a 'value+1' when using the std::string assignment methods etc.
+ */
void Finalise()
{
NickMax++;
* configutation, appending errors to errorstream
* and setting error if an error has occured.
*/
- bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
+ bool ParseLine(const std::string &filename, std::string &line, long &linenumber);
/** Check that there is only one of each configuration item
*/
- bool CheckOnce(const char* tag, ConfigDataHash &newconf);
+ bool CheckOnce(const char* tag);
public:
/** Process an include executable directive
*/
- bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
+ bool DoPipe(const std::string &file);
/** Process an include file directive
*/
- bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
-
- User* RehashUser;
+ bool DoInclude(const std::string &file);
- std::string RehashParameter;
-
- std::ostringstream errstr;
+ /** Error stream, contains error output from any failed configuration parsing.
+ */
+ std::stringstream errstr;
- ConfigDataHash newconfig;
+ /** True if this configuration is valid enough to run with */
+ bool valid;
+ /** Set of included files. Do we use this any more?
+ */
std::map<std::string, std::istream*> IncludedFiles;
/** Used to indicate who we announce invites to on a channel */
/** Pointer to function that validates dns server addresses (can be changed depending on platform) */
Validator DNSServerValidator;
+ /** Returns the creator InspIRCd pointer
+ */
InspIRCd* GetInstance();
+ /** Not used any more as it is named, can probably be removed or renamed.
+ */
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;
+ /** Length limits, see definition of ServerLimits class
+ */
ServerLimits Limits;
/** Clones CIDR range for ipv4 (0-32)
*/
int WhoWasMaxKeep;
+ /** Both for set(g|u)id.
+ */
+ char SetUser[MAXBUF];
+ char SetGroup[MAXBUF];
+
/** Holds the server name of the local server
* as defined by the administrator.
*/
/** 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
* by the administrator.
*/
char DNSServer[MAXBUF];
+ /** Pretend disabled commands don't exist.
+ */
+ bool DisabledDontExist;
+
/** This variable contains a space-seperated list
* of commands which are disabled by the
* administrator of the server for non-opers.
* foreground.
*/
bool nofork;
-
+
/** If this value if true then all log
* messages will be output, regardless of
* the level given in the config file.
* option.
*/
bool forcedebug;
-
+
/** If this is true then log output will be
* written to the logfile. This is the default.
* If you put -nolog on the commandline then
*/
bool writelog;
+ /** If set to true, then all opers on this server are
+ * shown with a generic 'is an IRC operator' line rather
+ * than the oper type. Oper types are still used internally.
+ */
+ bool GenericOper;
+
+ /** If this value is true, banned users (+b, not extbans) will not be able to change nick
+ * if banned on any channel, nor to message them.
+ */
+ bool RestrictBannedUsers;
+
/** If this value is true, halfops have been
* enabled in the configuration file.
*/
*/
ClassVector Classes;
- /** A list of the classes for listening client ports
- */
- std::vector<ListenSocket*> ports;
-
- /** socket objects that are attached to by modules
- */
- std::map<BufferedSocket*, Module*> SocketIOHookModule;
-
/** The 005 tokens of this server (ISUPPORT)
* populated/repopulated upon loading or unloading
* modules.
* only to operators.
*/
char UserStats[MAXBUF];
-
+
/** The path and filename of the ircd.log file
*/
std::string logpath;
* and initialize this class. All other methods
* should be used only by the core.
*/
- void Read(bool bail, User* user);
+ void Read();
+
+ /** Apply configuration changes from the old configuration.
+ */
+ void Apply(ServerConfig* old, const std::string &useruid);
/** Read a file into a file_cache object
*/
bool StartsWithWindowsDriveLetter(const std::string &path);
/** 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);
+ void ReportConfigError(const std::string &errormessage);
/** 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 char* filename, std::ostringstream &errorstream);
+ bool LoadConf(FILE* &conf, const char* filename);
/** 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 */
-
+ bool LoadConf(FILE* &conf, const std::string &filename);
+
/** 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);
+ bool ConfValue(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);
+ bool ConfValue(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);
+ bool ConfValue(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);
-
+ bool ConfValue(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(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);
+ bool ConfValueInteger(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(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);
-
+ bool ConfValueInteger(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(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);
+ bool ConfValueBool(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(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);
-
+ bool ConfValueBool(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 ConfValueEnum(ConfigDataHash &target, const char* tag);
+ int ConfValueEnum(const char* tag);
/** Returns the number of occurences of tag in the config file
*/
- int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
-
+ int ConfValueEnum(const std::string &tag);
+
/** Returns the numbers of vars inside the index'th 'tag in the config file
*/
- int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
+ int ConfVarEnum(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);
+ int ConfVarEnum(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
+ /** Validates a hostname value, throwing ConfigException if it is not valid
*/
- Module* GetIOHook(BufferedSocket* is);
+ void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
- /** 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.
+ /** Validates an IP address value, throwing ConfigException if it is not valid
*/
- bool AddIOHook(Module* iomod, BufferedSocket* is);
+ void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
- /** Delete a module hook from an BufferedSocket.
- * @param is The BufferedSocket to detatch from.
- * @return True if the unhook was successful
+ /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
*/
- bool DelIOHook(BufferedSocket* is);
+ void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
/** 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
*/
bool InitClasses(ServerConfig* conf, const char* tag);
-/** Initialize an oper type
+/** Initialize an oper type
*/
bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
/** 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);
*/
bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-
-
-
#endif
-
projects / user / henk / code / inspircd.git / blobdiff