* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
VF_COMMON = 8 // module needs to be common on all servers in a network to link
};
+/** Used with SendToMode()
+ */
enum WriteModeFlags {
WM_AND = 1,
WM_OR = 2
};
+/** Used to represent an event type, for user, channel or server
+ */
enum TargetTypeFlags {
TYPE_USER = 1,
TYPE_CHANNEL,
TYPE_OTHER
};
+/** Used to represent wether a message was PRIVMSG or NOTICE
+ */
enum MessageType {
MSG_PRIVMSG = 0,
MSG_NOTICE = 1
* ipv4 servers, so this value will be ten times as
* high on ipv6 servers.
*/
-#define NATIVE_API_VERSION 11020
+#define NATIVE_API_VERSION 12000
#ifdef IPV6
#define API_VERSION (NATIVE_API_VERSION * 10)
#else
/* Forward-delacare module for ModuleMessage etc
*/
class Module;
+class InspIRCd;
-/** Low level definition of a FileReader classes file cache area
+/** Low level definition of a FileReader classes file cache area -
+ * a text file seperated into lines.
*/
typedef std::deque<std::string> file_cache;
+
+/** A set of strings.
+ */
typedef file_cache string_list;
/** Holds a list of 'published features' for modules.
/**
* This #define allows us to call a method in all
* loaded modules in a readable simple way, e.g.:
- * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
+ * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
*/
#define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
- for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
+ for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
if (ServerInstance->Config->implement_lists[_i][y]) \
try \
{ \
- ServerInstance->modules[_i]->x ; \
+ ServerInstance->Modules->modules[_i]->x ; \
} \
catch (CoreException& modexcept) \
{ \
- ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
+ ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
} \
} \
}
+/**
+ * This #define allows us to call a method in all
+ * loaded modules in a readable simple way and pass
+ * an instance pointer to the macro. e.g.:
+ * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
+ */
#define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
- for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
+ for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
if (z->Config->implement_lists[_i][y]) \
try \
{ \
- z->modules[_i]->x ; \
+ z->Modules->modules[_i]->x ; \
} \
catch (CoreException& modexcept) \
{ \
- z->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
+ z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
} \
} \
}
/**
- * This define is similar to the one above but returns a result in MOD_RESULT.
+ * This define is similar to the one above but returns a result in MOD_RESULT.
* The first module to return a nonzero result is the value to be accepted,
* and any modules after are ignored.
*/
#define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
MOD_RESULT = 0; \
- for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
+ for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
if (ServerInstance->Config->implement_lists[_i][y]) { \
try \
{ \
- int res = ServerInstance->modules[_i]->x ; \
+ int res = ServerInstance->Modules->modules[_i]->x ; \
if (res != 0) { \
MOD_RESULT = res; \
break; \
} \
catch (CoreException& modexcept) \
{ \
- ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
+ ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
} \
} \
} \
} \
}
+/**
+ * This define is similar to the one above but returns a result in MOD_RESULT.
+ * The first module to return a nonzero result is the value to be accepted,
+ * and any modules after are ignored.
+ */
#define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
MOD_RESULT = 0; \
- for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
+ for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
if (z->Config->implement_lists[_i][y]) { \
try \
{ \
- int res = z->modules[_i]->x ; \
+ int res = z->Modules->modules[_i]->x ; \
if (res != 0) { \
MOD_RESULT = res; \
break; \
} \
catch (CoreException& modexcept) \
{ \
- z->Log(DEBUG,"Exception cought: %s",modexcept.GetReason()); \
+ z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
} \
} \
} \
} \
}
+/** Represents a non-local user.
+ * (in fact, any FD less than -1 does)
+ */
#define FD_MAGIC_NUMBER -42
-// useful macros
-
+/* Useful macros */
+#ifdef WINDOWS
+/** Is a local user */
+#define IS_LOCAL(x) ((x->GetFd() > -1))
+#else
+/** Is a local user */
#define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
+#endif
+/** Is a remote user */
#define IS_REMOTE(x) (x->GetFd() < 0)
+/** Is a module created user */
#define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
+/** Is an oper */
#define IS_OPER(x) (*x->oper)
+/** Is away */
#define IS_AWAY(x) (*x->awaymsg)
-/** Holds a module's Version information
+/** Holds a module's Version information.
* The four members (set by the constructor only) indicate details as to the version number
* of a module. A class of type Version is returned by the GetVersion method of the Module class.
+ * The flags and API values represent the module flags and API version of the module.
+ * The API version of a module must match the API version of the core exactly for the module to
+ * load successfully.
*/
-class Version : public classbase
+class CoreExport Version : public classbase
{
public:
+ /** Version numbers, build number, flags and API version
+ */
const int Major, Minor, Revision, Build, Flags, API;
+
+ /** Initialize version class
+ */
Version(int major, int minor, int revision, int build, int flags, int api_ver);
};
* This class is used to represent a basic data structure which is passed
* between modules for safe inter-module communications.
*/
-class ModuleMessage : public Extensible
+class CoreExport ModuleMessage : public Extensible
{
public:
+ /** Destructor
+ */
virtual ~ModuleMessage() {};
};
* using the Send() method, which will call the given module's OnRequest
* method with this class as its parameter.
*/
-class Request : public ModuleMessage
+class CoreExport Request : public ModuleMessage
{
protected:
/** This member holds a pointer to arbitary data set by the emitter of the message
* using the Send() method, which will trigger the OnEvent method in
* all modules passing the object as its parameter.
*/
-class Event : public ModuleMessage
+class CoreExport Event : public ModuleMessage
{
protected:
/** This member holds a pointer to arbitary data set by the emitter of the message
char* Send(InspIRCd* ServerInstance);
};
-/** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
- * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
- * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
- * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
- * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
- */
-class CoreException : public std::exception
-{
- protected:
- /** Holds the error message to be displayed
- */
- const std::string err;
- const std::string source;
- public:
- /** Default constructor, just uses the error mesage 'Core threw an exception'.
- */
- CoreException() : err("Core threw an exception"), source("The core") {}
- /** This constructor can be used to specify an error message before throwing.
- */
- CoreException(const std::string &message) : err(message), source("The core") {}
- /** This constructor can be used to specify an error message before throwing,
- * and to specify the source of the exception.
- */
- CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
- */
- virtual ~CoreException() throw() {};
- /** Returns the reason for the exception.
- * The module should probably put something informative here as the user will see this upon failure.
- */
- virtual const char* GetReason()
- {
- return err.c_str();
- }
-
- virtual const char* GetSource()
- {
- return source.c_str();
- }
-};
-
-class ModuleException : public CoreException
-{
- public:
- /** Default constructor, just uses the error mesage 'Module threw an exception'.
- */
- ModuleException() : CoreException("Module threw an exception", "A Module") {}
-
- /** This constructor can be used to specify an error message before throwing.
- */
- ModuleException(const std::string &message) : CoreException(message, "A Module") {}
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
- */
- virtual ~ModuleException() throw() {};
-};
-
/** Priority types which can be returned from Module::Prioritize()
*/
enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
* its methods will be called when irc server events occur. class inherited from module must be
* instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
*/
-class Module : public Extensible
+class CoreExport Module : public Extensible
{
protected:
+ /** Creator/owner pointer
+ */
InspIRCd* ServerInstance;
public:
- /** Default constructor
+ /** Default constructor.
* Creates a module class.
* @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
* \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
*/
Module(InspIRCd* Me);
- /** Default destructor
+ /** Default destructor.
* destroys a module class
*/
virtual ~Module();
* @param sender The original sender of the PRIVMSG or NOTICE
* @param status The status char to be used for the channel list
* @param exempt_list The exempt list to be populated
+ * @param text The original message text causing the exempt list to be built
*/
- virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
+ virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list, const std::string &text);
/** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
* Please note that although you can see remote nickchanges through this function, you should
* @param proto A pointer to the module handling network protocol
* @param opaque An opaque pointer set by the protocol module, should not be modified!
* @param extname The extensions name which is being searched for
+ * @param displayable If this value is true, the data is going to be displayed to a user,
+ * and not sent across the network. Use this to determine wether or not to show sensitive data.
*/
- virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
+ virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
/* Allows modules to syncronize metadata related to users over the network during a netburst.
* Whenever the linking module wants to send out data, but doesnt know what the data
* @param proto A pointer to the module handling network protocol
* @param opaque An opaque pointer set by the protocol module, should not be modified!
* @param extname The extensions name which is being searched for
+ * @param displayable If this value is true, the data is going to be displayed to a user,
+ * and not sent across the network. Use this to determine wether or not to show sensitive data.
*/
- virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
+ virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
/* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
* Whenever the linking module wants to send out data, but doesnt know what the data
* if it belongs to your module.
* @param proto A pointer to the module handling network protocol
* @param opaque An opaque pointer set by the protocol module, should not be modified!
+ * @param displayable If this value is true, the data is going to be displayed to a user,
+ * and not sent across the network. Use this to determine wether or not to show sensitive data.
*/
- virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
+ virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
/** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
* Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
* @param dest The user being killed
* @param reason The kill reason
*/
- virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
+ virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason);
/** Called whenever a module is loaded.
* mod will contain a pointer to the module, and string will contain its name,
*/
virtual void OnRawSocketClose(int fd);
+ /** Called immediately upon connection of an outbound InspSocket which has been hooked
+ * by a module.
+ * @param fd The file descriptor of the socket immediately after connect()
+ */
virtual void OnRawSocketConnect(int fd);
/** Called immediately before any read() operation on a client socket in the core.
/** Called whenever a user sets away.
* This method has no parameter for the away message, as it is available in the
* user record as userrec::awaymsg.
+ * @param user The user setting away
*/
virtual void OnSetAway(userrec* user);
/** Called when a user cancels their away state.
+ * @param user The user returning from away
*/
virtual void OnCancelAway(userrec* user);
* You can produce the nameslist yourself, overriding the current list,
* and if you do you must return 1. If you do not handle the names list,
* return 0.
+ * @param The user requesting the NAMES list
+ * @param Ptr The channel the NAMES list is requested for
+ * @param userlist The user list for the channel (you may change this pointer.
+ * If you want to change the values, take a copy first, and change the copy, then
+ * point the pointer at your copy)
+ * @return 1 to prevent the user list being sent to the client, 0 to allow it
*/
- virtual int OnUserList(userrec* user, chanrec* Ptr);
+ virtual int OnUserList(userrec* user, chanrec* Ptr, CUList* &userlist);
/** Called whenever a line of WHOIS output is sent to a user.
* You may change the numeric and the text of the output by changing
#define CONF_NOT_A_NUMBER 0x000010
-#define CONF_NOT_UNSIGNED 0x000080
+#define CONF_INT_NEGATIVE 0x000080
#define CONF_VALUE_NOT_FOUND 0x000100
#define CONF_FILE_NOT_FOUND 0x000200
* Constructing the class using one parameter allows you to specify a path to your own configuration
* file, otherwise, inspircd.conf is read.
*/
-class ConfigReader : public classbase
+class CoreExport ConfigReader : public classbase
{
protected:
InspIRCd* ServerInstance;
* (such as comments) stripped from it.
*/
ConfigDataHash* data;
- std::ostringstream* errorlog;;
/** Used to store errors
*/
- bool privatehash; // If we're using our own config data hash or not.
+ std::ostringstream* errorlog;
+ /** If we're using our own config data hash or not
+ */
+ bool privatehash;
+ /** True if an error occured reading the config file
+ */
bool readerror;
+ /** Error code
+ */
long error;
public:
* This method retrieves an integer value from the config file. Where multiple copies of the tag
* exist in the config file, index indicates which of the values to retrieve. Any invalid integer
* values in the tag will cause the objects error value to be set, and any call to GetError() will
- * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
- * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
- * will return CONF_NOT_UNSIGNED
+ * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
+ * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
+ * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
+ * should cast the result to achieve that effect.
*/
- long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
+ int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
/** Retrieves an integer value from the config file.
* This method retrieves an integer value from the config file. Where multiple copies of the tag
* exist in the config file, index indicates which of the values to retrieve. Any invalid integer
* If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
* will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
*/
- long ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned);
+ int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
/** Returns the last error to occur.
* Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
* Either use the constructor type with one parameter to load a file into memory
* at construction, or use the LoadFile method to load a file.
*/
-class FileReader : public classbase
+class CoreExport FileReader : public classbase
{
InspIRCd* ServerInstance;
/** The file contents
*/
file_cache fc;
+ /** Content size in bytes
+ */
unsigned long contentsize;
+ /** Calculate content size in bytes
+ */
void CalcSize();
public:
int FileSize();
};
+/** A DLLFactory (designed to load shared objects) containing a
+ * handle to a module's init_module() function.
+ */
+typedef DLLFactory<Module> ircd_module;
+
+/** A list of loaded Modules
+ */
+typedef std::vector<Module*> ModuleList;
+
+/** A list of loaded module handles (ircd_module)
+ */
+typedef std::vector<ircd_module*> ModuleHandleList;
-/** Instantiates classes inherited from Module.
- * This class creates a class inherited from type Module, using new. This is to allow for modules
- * to create many different variants of Module, dependent on architecture, configuration, etc.
- * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
- * modules.
+/** ModuleManager takes care of all things module-related
+ * in the core.
*/
-class ModuleFactory : public classbase
+class CoreExport ModuleManager : public classbase
{
+ private:
+ /** Holds a string describing the last module error to occur
+ */
+ char MODERR[MAXBUF];
+
+ /** The feature names published by various modules
+ */
+ featurelist Features;
+
+ /** The interface names published by various modules
+ */
+ interfacelist Interfaces;
+
+ /** Total number of modules loaded into the ircd, minus one
+ */
+ int ModCount;
+
+ /** Our pointer to the main insp instance
+ */
+ InspIRCd* Instance;
+
public:
- /** The default constructor does nothing.
+ /** A list of ircd_module* module handles
+ * Note that this list is always exactly 255 in size.
+ * The actual number of loaded modules is available from GetModuleCount()
*/
- ModuleFactory() { }
- /** The default destructor does nothing
+ ModuleHandleList handles;
+
+ /** A list of Module* module classes
+ * Note that this list is always exactly 255 in size.
+ * The actual number of loaded modules is available from GetModuleCount()
*/
- virtual ~ModuleFactory() { }
- /** Creates a new module.
- * Your inherited class of ModuleFactory must return a pointer to your Module class
- * using this method.
+ ModuleList modules;
+
+ /** Simple, bog-standard, boring constructor.
*/
- virtual Module * CreateModule(InspIRCd* Me) = 0;
-};
+ ModuleManager(InspIRCd* Ins);
-/** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
- */
-typedef DLLFactory<ModuleFactory> ircd_module;
+ ~ModuleManager();
+
+ /** Returns text describing the last module error
+ * @return The last error message to occur
+ */
+ const char* LastError();
-/** A list of loaded Modules
- */
-typedef std::vector<Module*> ModuleList;
+ /** Load a given module file
+ * @param filename The file to load
+ * @return True if the module was found and loaded
+ */
+ bool Load(const char* filename);
-/** A list of loaded ModuleFactories
+ /** Unload a given module file
+ * @param filename The file to unload
+ * @return True if the module was unloaded
+ */
+ bool Unload(const char* filename);
+
+ /** Called by the InspIRCd constructor to load all modules from the config file.
+ */
+ void LoadAll();
+
+ /** Get the total number of currently loaded modules
+ * @return The number of loaded modules
+ */
+ int GetCount()
+ {
+ return this->ModCount;
+ }
+
+ /** Find a module by name, and return a Module* to it.
+ * This is preferred over iterating the module lists yourself.
+ * @param name The module name to look up
+ * @return A pointer to the module, or NULL if the module cannot be found
+ */
+ Module* Find(const std::string &name);
+
+ /** Remove a module handle pointer
+ * @param j Index number of the module handle to remove
+ * @return True if a handle existed at the given index, false otherwise
+ */
+ bool EraseHandle(unsigned int j);
+
+ /** Remove a Module pointer
+ * @param j Index number of the Module to remove
+ * @return True if a handle existed at the given index, false otherwise
+ */
+ bool EraseModule(unsigned int j);
+
+ /** Move a given module to a specific slot in the list
+ * @param modulename The module name to relocate
+ * @param slot The slot to move the module into
+ */
+ void MoveTo(std::string modulename,int slot);
+
+ /** Moves the given module to the last slot in the list
+ * @param modulename The module name to relocate
+ */
+ void MoveToLast(std::string modulename);
+
+ /** Moves the given module to the first slot in the list
+ * @param modulename The module name to relocate
+ */
+ void MoveToFirst(std::string modulename);
+
+ /** Moves one module to be placed after another in the list
+ * @param modulename The module name to relocate
+ * @param after The module name to place the module after
+ */
+ void MoveAfter(std::string modulename, std::string after);
+
+ /** Moves one module to be placed before another in the list
+ * @param modulename The module name to relocate
+ * @param after The module name to place the module before
+ */
+ void MoveBefore(std::string modulename, std::string before);
+
+ /** For use with Module::Prioritize().
+ * When the return value of this function is returned from
+ * Module::Prioritize(), this specifies that the module wishes
+ * to be ordered exactly BEFORE 'modulename'. For more information
+ * please see Module::Prioritize().
+ * @param modulename The module your module wants to be before in the call list
+ * @returns a priority ID which the core uses to relocate the module in the list
+ */
+ long PriorityBefore(const std::string &modulename);
+
+ /** For use with Module::Prioritize().
+ * When the return value of this function is returned from
+ * Module::Prioritize(), this specifies that the module wishes
+ * to be ordered exactly AFTER 'modulename'. For more information please
+ * see Module::Prioritize().
+ * @param modulename The module your module wants to be after in the call list
+ * @returns a priority ID which the core uses to relocate the module in the list
+ */
+ long PriorityAfter(const std::string &modulename);
+
+ /** Publish a 'feature'.
+ * There are two ways for a module to find another module it depends on.
+ * Either by name, using InspIRCd::FindModule, or by feature, using this
+ * function. A feature is an arbitary string which identifies something this
+ * module can do. For example, if your module provides SSL support, but other
+ * modules provide SSL support too, all the modules supporting SSL should
+ * publish an identical 'SSL' feature. This way, any module requiring use
+ * of SSL functions can just look up the 'SSL' feature using FindFeature,
+ * then use the module pointer they are given.
+ * @param FeatureName The case sensitive feature name to make available
+ * @param Mod a pointer to your module class
+ * @returns True on success, false if the feature is already published by
+ * another module.
+ */
+ bool PublishFeature(const std::string &FeatureName, Module* Mod);
+
+ /** Publish a module to an 'interface'.
+ * Modules which implement the same interface (the same way of communicating
+ * with other modules) can publish themselves to an interface, using this
+ * method. When they do so, they become part of a list of related or
+ * compatible modules, and a third module may then query for that list
+ * and know that all modules within that list offer the same API.
+ * A prime example of this is the hashing modules, which all accept the
+ * same types of Request class. Consider this to be similar to PublishFeature,
+ * except for that multiple modules may publish the same 'feature'.
+ * @param InterfaceName The case sensitive interface name to make available
+ * @param Mod a pointer to your module class
+ * @returns True on success, false on failure (there are currently no failure
+ * cases)
+ */
+ bool PublishInterface(const std::string &InterfaceName, Module* Mod);
+
+ /** Return a pair saying how many other modules are currently using the
+ * interfaces provided by module m.
+ * @param m The module to count usage for
+ * @return A pair, where the first value is the number of uses of the interface,
+ * and the second value is the interface name being used.
+ */
+ std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
+
+ /** Mark your module as using an interface.
+ * If you mark your module as using an interface, then that interface
+ * module may not unload until your module has unloaded first.
+ * This can be used to prevent crashes by ensuring code you depend on
+ * is always in memory while your module is active.
+ * @param InterfaceName The interface to use
+ */
+ void UseInterface(const std::string &InterfaceName);
+
+ /** Mark your module as finished with an interface.
+ * If you used UseInterface() above, you should use this method when
+ * your module is finished with the interface (usually in its destructor)
+ * to allow the modules which implement the given interface to be unloaded.
+ * @param InterfaceName The interface you are finished with using.
+ */
+ void DoneWithInterface(const std::string &InterfaceName);
+
+ /** Unpublish a 'feature'.
+ * When your module exits, it must call this method for every feature it
+ * is providing so that the feature table is cleaned up.
+ * @param FeatureName the feature to remove
+ */
+ bool UnpublishFeature(const std::string &FeatureName);
+
+ /** Unpublish your module from an interface
+ * When your module exits, it must call this method for every interface
+ * it is part of so that the interfaces table is cleaned up. Only when
+ * the last item is deleted from an interface does the interface get
+ * removed.
+ * @param InterfaceName the interface to be removed from
+ * @param Mod The module to remove from the interface list
+ */
+ bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
+
+ /** Find a 'feature'.
+ * There are two ways for a module to find another module it depends on.
+ * Either by name, using InspIRCd::FindModule, or by feature, using the
+ * InspIRCd::PublishFeature method. A feature is an arbitary string which
+ * identifies something this module can do. For example, if your module
+ * provides SSL support, but other modules provide SSL support too, all
+ * the modules supporting SSL should publish an identical 'SSL' feature.
+ * To find a module capable of providing the feature you want, simply
+ * call this method with the feature name you are looking for.
+ * @param FeatureName The feature name you wish to obtain the module for
+ * @returns A pointer to a valid module class on success, NULL on failure.
+ */
+ Module* FindFeature(const std::string &FeatureName);
+
+ /** Find an 'interface'.
+ * An interface is a list of modules which all implement the same API.
+ * @param InterfaceName The Interface you wish to obtain the module
+ * list of.
+ * @return A pointer to a deque of Module*, or NULL if the interface
+ * does not exist.
+ */
+ modulelist* FindInterface(const std::string &InterfaceName);
+
+ /** Given a pointer to a Module, return its filename
+ * @param m The module pointer to identify
+ * @return The module name or an empty string
+ */
+ const std::string& GetModuleName(Module* m);
+};
+
+/** This definition is used as shorthand for the various classes
+ * and functions needed to make a module loadable by the OS.
+ * It defines the class factory and external init_module function.
*/
-typedef std::vector<ircd_module*> FactoryList;
+#define MODULE_INIT(y) \
+ extern "C" DllExport Module * init_module(InspIRCd* Me) \
+ { \
+ return new y(Me); \
+ }
#endif
projects / user / henk / code / inspircd.git / blobdiff