* | 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.
#ifndef __MODULES_H
#define __MODULES_H
-#include "globals.h"
#include "dynamic.h"
#include "base.h"
#include "ctables.h"
class XLine;
-/** Used with OnAccessCheck() method of modules
- */
-enum AccessControlType {
- ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
- ACR_DENY, // deny the action
- ACR_ALLOW, // allow the action
- AC_KICK, // a user is being kicked
- AC_DEOP, // a user is being deopped
- AC_OP, // a user is being opped
- AC_VOICE, // a user is being voiced
- AC_DEVOICE, // a user is being devoiced
- AC_HALFOP, // a user is being halfopped
- AC_DEHALFOP, // a user is being dehalfopped
- AC_INVITE, // a user is being invited
- AC_GENERAL_MODE // a channel mode is being changed
-};
-
/** Used to define a set of behavior bits for a module
*/
enum ModuleFlags {
+ VF_NONE = 0, // module is not special at all
VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
- VF_COMMON = 8 // module needs to be common on all servers in a network to link
+ VF_COMMON = 8, // module needs to be common on all servers in a network to link
+ VF_OPTCOMMON = 16, // module should be common on all servers for unsurprising behavior
+ VF_CORE = 32 // module is a core command, can be assumed loaded on all servers
};
/** Used with SendToMode()
MSG_NOTICE = 1
};
-/** If you change the module API, change this value.
- * If you have enabled ipv6, the sizes of structs is
- * different, and modules will be incompatible with
- * ipv4 servers, so this value will be ten times as
- * high on ipv6 servers.
+#define MOD_RES_ALLOW (ModResult(1))
+#define MOD_RES_PASSTHRU (ModResult(0))
+#define MOD_RES_DENY (ModResult(-1))
+
+/** Used to represent an allow/deny module result.
+ * Not constructed as an enum because it reverses the value logic of some functions;
+ * the compiler will inline accesses to have the same efficiency as integer operations.
*/
-#define NATIVE_API_VERSION 12000
-#ifdef IPV6
-#define API_VERSION (NATIVE_API_VERSION * 10)
-#else
-#define API_VERSION (NATIVE_API_VERSION * 1)
-#endif
+struct ModResult {
+ int res;
+ ModResult() : res(0) {}
+ explicit ModResult(int r) : res(r) {}
+ bool operator==(const ModResult& r) const
+ {
+ return res == r.res;
+ }
+ bool operator!=(const ModResult& r) const
+ {
+ return res != r.res;
+ }
+ bool operator!() const
+ {
+ return !res;
+ }
+ bool check(bool def) const
+ {
+ return (res == 1 || (res == 0 && def));
+ }
+ /**
+ * Merges two results, preferring ALLOW to DENY
+ */
+ ModResult operator+(const ModResult& r) const
+ {
+ if (res == r.res || r.res == 0)
+ return *this;
+ if (res == 0)
+ return r;
+ // they are different, and neither is passthru
+ return MOD_RES_ALLOW;
+ }
+};
+
+/** If you change the module API in any way, increment this value.
+ * This MUST be a pure integer, with no parenthesis
+ */
+#define API_VERSION 134
class ServerConfig;
class Module;
class InspIRCd;
-/** 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;
+typedef std::vector<std::string> string_list;
/** Holds a list of 'published features' for modules.
*/
} \
catch (CoreException& modexcept) \
{ \
- ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
+ ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
} \
_i = safei; \
} \
} while (0);
/**
- * 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) do { \
- EventHandlerIter safei; \
- for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
- { \
- safei = _i; \
- ++safei; \
- try \
- { \
- (*_i)->x ; \
- } \
- catch (CoreException& modexcept) \
- { \
- z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
- } \
- _i = safei; \
- } \
-} while (0);
-
-/**
- * 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.
+ * Custom module result handling loop. This is a paired macro, and should only
+ * be used with while_each_hook.
+ *
+ * See src/channels.cpp for an example of use.
*/
-#define FOREACH_RESULT(y,x) \
+#define DO_EACH_HOOK(n,v,args) \
do { \
- EventHandlerIter safei; \
- MOD_RESULT = 0; \
- for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
+ EventHandlerIter iter_ ## n = ServerInstance->Modules->EventHandlers[I_ ## n].begin(); \
+ while (iter_ ## n != ServerInstance->Modules->EventHandlers[I_ ## n].end()) \
{ \
- safei = _i; \
- ++safei; \
+ Module* mod_ ## n = *iter_ ## n; \
+ iter_ ## n ++; \
try \
{ \
- int res = (*_i)->x ; \
- if (res != 0) { \
- MOD_RESULT = res; \
- break; \
- } \
+ v = (mod_ ## n)->n args;
+
+#define WHILE_EACH_HOOK(n) \
} \
- catch (CoreException& modexcept) \
+ catch (CoreException& except_ ## n) \
{ \
- ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
+ ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s", (except_ ## n).GetReason()); \
+ (void) mod_ ## n; /* catch mismatched pairs */ \
} \
- _i = safei; \
} \
-} while(0);
-
+} while(0)
/**
- * 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.
+ * Module result iterator
+ * Runs the given hook until some module returns a useful result.
+ *
+ * Example: ModResult result;
+ * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
*/
-#define FOREACH_RESULT_I(z,y,x) \
-do { \
- EventHandlerIter safei; \
- MOD_RESULT = 0; \
- for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
+#define FIRST_MOD_RESULT(n,v,args) do { \
+ v = MOD_RES_PASSTHRU; \
+ DO_EACH_HOOK(n,v,args) \
{ \
- safei = _i; \
- ++safei; \
- try \
- { \
- int res = (*_i)->x ; \
- if (res != 0) { \
- MOD_RESULT = res; \
- break; \
- } \
- } \
- catch (CoreException& modexcept) \
- { \
- z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
- } \
- _i = safei; \
+ if (v != MOD_RES_PASSTHRU) \
+ break; \
} \
-} while (0);
+ WHILE_EACH_HOOK(n); \
+} while (0)
/** Represents a non-local user.
* (in fact, any FD less than -1 does)
*/
#define FD_MAGIC_NUMBER -42
+/** Represents a fake user (i.e. a server)
+ */
+#define FD_FAKEUSER_NUMBER -7
/* 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
+#define IS_LOCAL(x) (x->GetFd() > -1)
/** Is a remote user */
#define IS_REMOTE(x) (x->GetFd() < 0)
+/** Is a fake user */
+#define IS_SERVER(x) (x->GetFd() == FD_FAKEUSER_NUMBER)
/** Is a module created user */
#define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
/** Is an oper */
-#define IS_OPER(x) (*x->oper)
+#define IS_OPER(x) (!x->oper.empty())
/** Is away */
-#define IS_AWAY(x) (*x->awaymsg)
+#define IS_AWAY(x) (!x->awaymsg.empty())
/** 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.
+ * The 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 core provides only one implementation of the template, causing a run-time linking
+ * error when attempting to load a module compiled against a different API_VERSION.
*/
-class CoreExport Version : public classbase
+template<int api>
+class CoreExport VersionBase
{
public:
- /** Version numbers, build number, flags and API version
- */
- const int Major, Minor, Revision, Build, Flags, API;
+ /** Module description
+ */
+ const std::string description;
+ /** Version information.
+ */
+ const std::string version;
- /** Initialize version class
- */
- Version(int major, int minor, int revision, int build, int flags, int api_ver);
-};
+ /** Flags
+ */
+ const int Flags;
-/** The ModuleMessage class is the base class of Request and Event
- * This class is used to represent a basic data structure which is passed
- * between modules for safe inter-module communications.
- */
-class CoreExport ModuleMessage : public Extensible
-{
- public:
- /** Destructor
+ /** Initialize version class
*/
- virtual ~ModuleMessage() {};
+ VersionBase(const std::string &desc, int flags = VF_NONE, const std::string& src_rev = VERSION " r" REVISION);
};
+typedef VersionBase<API_VERSION> Version;
+
/** The Request class is a unicast message directed at a given module.
* When this class is properly instantiated it may be sent to a module
* using the Send() method, which will call the given module's OnRequest
* method with this class as its parameter.
*/
-class CoreExport Request : public ModuleMessage
+class CoreExport Request : public classbase
{
- protected:
- /** This member holds a pointer to arbitary data set by the emitter of the message
- */
- char* data;
- /** This should be a null-terminated string identifying the type of request,
- * all modules should define this and use it to determine the nature of the
- * request before they attempt to cast the Request in any way.
- */
- const char* id;
+ public:
+ /** This should be a null-terminated string identifying the type of request,
+ * all modules should define this and use it to determine the nature of the
+ * request before they attempt to cast the Request in any way.
+ */
+ const char* const id;
/** This is a pointer to the sender of the message, which can be used to
* directly trigger events, or to create a reply.
*/
- Module* source;
+ Module* const source;
/** The single destination of the Request
*/
- Module* dest;
- public:
+ Module* const dest;
+
/** Create a new Request
- * This is for the 'old' way of casting whatever the data is
- * to char* and hoping you get the right thing at the other end.
- * This is slowly being depreciated in favor of the 'new' way.
- */
- Request(char* anydata, Module* src, Module* dst);
- /** Create a new Request
- * This is for the 'new' way of defining a subclass
- * of Request and defining it in a common header,
+ * This is for the 'new' way of defining a subclass
+ * of Request and defining it in a common header,
* passing an object of your Request subclass through
- * as a Request* and using the ID string to determine
- * what to cast it back to and the other end. This is
- * much safer as there are no casts not confirmed by
- * the ID string, and all casts are child->parent and
- * can be checked at runtime with dynamic_cast<>()
- */
- Request(Module* src, Module* dst, const char* idstr);
- /** Fetch the Request data
- */
- char* GetData();
- /** Fetch the ID string
- */
- const char* GetId();
- /** Fetch the request source
+ * as a Request* and using the ID string to determine
+ * what to cast it back to and the other end.
*/
- Module* GetSource();
- /** Fetch the request destination (should be 'this' in the receiving module)
- */
- Module* GetDest();
+ Request(Module* src, Module* dst, const char* idstr);
/** Send the Request.
- * Upon returning the result will be arbitary data returned by the module you
- * sent the request to. It is up to your module to know what this data is and
- * how to deal with it.
*/
- char* Send();
+ void Send();
};
* using the Send() method, which will trigger the OnEvent method in
* all modules passing the object as its parameter.
*/
-class CoreExport Event : public ModuleMessage
+class CoreExport Event : public classbase
{
- protected:
- /** This member holds a pointer to arbitary data set by the emitter of the message
- */
- char* data;
+ public:
/** This is a pointer to the sender of the message, which can be used to
* directly trigger events, or to create a reply.
*/
- Module* source;
+ Module* const source;
/** The event identifier.
* This is arbitary text which should be used to distinguish
* one type of event from another.
*/
- std::string id;
- public:
+ const std::string id;
+
/** Create a new Event
*/
- Event(char* anydata, Module* src, const std::string &eventid);
- /** Get the Event data
- */
- char* GetData();
- /** Get the event Source
- */
- Module* GetSource();
- /** Get the event ID.
- * Use this to determine the event type for safe casting of the data
- */
- std::string GetEventID();
+ Event(Module* src, const std::string &eventid);
/** Send the Event.
* The return result of an Event::Send() will always be NULL as
* no replies are expected.
*/
- char* Send(InspIRCd* ServerInstance);
+ void Send();
};
/** Priority types which can be returned from Module::Prioritize()
enum Implementation
{
I_BEGIN,
- I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
- I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
- I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
- I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
- I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
- I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
- I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
- I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
- I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
- I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
- I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
- I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
- I_OnText, I_OnReadConfig, I_OnDownloadFile, I_OnPassCompare,
+ I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash,
+ I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
+ I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick,
+ I_OnUserMessage, I_OnUserNotice, I_OnMode, I_OnGetServerDescription, I_OnSyncUser,
+ I_OnSyncChannel, I_OnDecodeMetaData, I_OnWallops,
+ I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
+ I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule,
+ I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
+ I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
+ I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnPreTopicChange,
+ I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan,
+ I_OnDelBan, I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
+ I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnUserList, I_OnPostCommand, I_OnPostJoin,
+ I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect,
+ I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookIO,
+ I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnChannelRestrictionApply,
I_END
};
* 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 CoreExport Module : public Extensible
+class CoreExport Module : public classbase
{
- protected:
- /** Creator/owner pointer
- */
- InspIRCd* ServerInstance;
public:
+ /** File that this module was loaded from
+ */
+ std::string ModuleSourceFile;
+ /** Reference to the dlopen() value
+ */
+ DLLManager* ModuleDLLManager;
/** 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);
+ Module();
+
+ /** Clean up prior to destruction
+ * If you override, you must call this AFTER your module's cleanup
+ */
+ virtual CullResult cull();
/** Default destructor.
* destroys a module class
{
}
- virtual void OnReadConfig(ServerConfig* config, ConfigReader* coreconf);
-
- virtual int OnDownloadFile(const std::string &filename, std::istream* &filedata);
-
/** Returns the version number of a Module.
* The method should return a Version object with its version information assigned via
* Version::Version
*/
- virtual Version GetVersion();
+ virtual Version GetVersion() = 0;
/** Called when a user connects.
* The details of the connecting user are available to you in the parameter User *user
* @param chan The channel being deleted
* @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
*/
- virtual int OnChannelPreDelete(Channel *chan);
+ virtual ModResult OnChannelPreDelete(Channel *chan);
/** Called whenever a channel is deleted, either by QUIT, KICK or PART.
* @param chan The channel being deleted
/** Called when a user joins a channel.
* The details of the joining user are available to you in the parameter User *user,
* and the details of the channel they have joined is available in the variable Channel *channel
- * @param user The user who is joining
- * @param channel The channel being joined
- * @param silent Change this to true if you want to conceal the JOIN command from the other users
- * of the channel (useful for modules such as auditorium)
+ * @param memb The channel membership being created
* @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
* to a channel due to the network sync.
+ * @param created This is true if the join created the channel
*/
- virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
+ virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
/** Called after a user joins a channel
* Identical to OnUserJoin, but called immediately afterwards, when any linking module has
* seen the join.
- * @param user The user who is joining
- * @param channel The channel being joined
+ * @param memb The channel membership created
*/
- virtual void OnPostJoin(User* user, Channel* channel);
+ virtual void OnPostJoin(Membership*);
/** Called when a user parts a channel.
* The details of the leaving user are available to you in the parameter User *user,
* and the details of the channel they have left is available in the variable Channel *channel
- * @param user The user who is parting
- * @param channel The channel being parted
- * @param partmessage The part message, or an empty string
- * @param silent Change this to true if you want to conceal the PART command from the other users
- * of the channel (useful for modules such as auditorium)
+ * @param memb The channel membership being destroyed
+ * @param partmessage The part message, or an empty string (may be modified)
*/
- virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
+ virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
/** Called on rehash.
* This method is called prior to a /REHASH or when a SIGHUP is received from the operating
- * system. You should use it to reload any files so that your module keeps in step with the
- * rest of the application. If a parameter is given, the core has done nothing. The module
- * receiving the event can decide if this parameter has any relevence to it.
- * @param user The user performing the rehash, if any -- if this is server initiated, the
- * value of this variable will be NULL.
- * @param parameter The (optional) parameter given to REHASH from the user.
- */
- virtual void OnRehash(User* user, const std::string ¶meter);
-
- /** Called when a raw command is transmitted or received.
- * This method is the lowest level of handler available to a module. It will be called with raw
- * data which is passing through a connected socket. If you wish, you may munge this data by changing
- * the string parameter "raw". If you do this, after your function exits it will immediately be
- * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
- * inbound is set to true) the value of user will be the User of the connection sending the
- * data. This is not possible for outbound data because the data may be being routed to multiple targets.
- * @param raw The raw string in RFC1459 format
- * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
- * @param user The user record sending the text, when inbound == true.
- */
- virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
+ * system. This is called in all cases -- including when this server will not execute the
+ * rehash because it is directed at a remote server.
+ *
+ * @param user The user performing the rehash, if any. If this is server initiated, the value of
+ * this variable will be NULL.
+ * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
+ * initiated.
+ */
+ virtual void OnPreRehash(User* user, const std::string ¶meter);
+
+ /** Called on rehash.
+ * This method is called when a user initiates a module-specific rehash. This can be used to do
+ * expensive operations (such as reloading SSL certificates) that are not executed on a normal
+ * rehash for efficiency. A rehash of this type does not reload the core configuration.
+ *
+ * @param user The user performing the rehash.
+ * @param parameter The parameter given to REHASH
+ */
+ virtual void OnModuleRehash(User* user, const std::string ¶meter);
+
+ /** Called on rehash.
+ * This method is called after a rehash has completed. You should use it to reload any module
+ * configuration from the main configuration file.
+ * @param user The user that performed the rehash, if it was initiated by a user and that user
+ * is still connected.
+ */
+ virtual void OnRehash(User* user);
+
+ /** Called whenever a snotice is about to be sent to a snomask.
+ * snomask and type may both be modified; the message may not.
+ * @param snomask The snomask the message is going to (e.g. 'A')
+ * @param type The textual description the snomask will go to (e.g. 'OPER')
+ * @param message The text message to be sent via snotice
+ * @return 1 to block the snotice from being sent entirely, 0 else.
+ */
+ virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
/** Called whenever a user is about to join a channel, before any processing is done.
* Returning a value of 1 from this function stops the process immediately, causing no
* @param user The user joining the channel
* @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
* @param cname The channel name being joined. For new channels this is valid where chan is not.
- * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
+ * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
* You may alter this string to alter the user's modes on the channel.
+ * @param keygiven The key given to join the channel, or an empty string if none was provided
* @return 1 To prevent the join, 0 to allow it.
*/
- virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs);
-
+ virtual ModResult OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
+
/** Called whenever a user is about to be kicked.
* Returning a value of 1 from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* @param reason The kick reason
* @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
*/
- virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
+ virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
/** Called whenever a user is kicked.
* If this method is called, the kick is already underway and cannot be prevented, so
* @param user The user being kicked
* @param chan The channel the user is being kicked from
* @param reason The kick reason
- * @param silent Change this to true if you want to conceal the PART command from the other users
- * of the channel (useful for modules such as auditorium)
*/
- virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
+ virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
/** Called whenever a user opers locally.
* The User will contain the oper mode 'o' as this function is called after any modifications
* @param opertype The opers type name
*/
virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
-
+
/** Called whenever a user types /INFO.
* The User will contain the information of the user who typed the command. Modules may use this
* method to output their own credits in /INFO (which is the ircd's version of an about box).
* @param user The user issuing /INFO
*/
virtual void OnInfo(User* user);
-
+
/** Called whenever a /WHOIS is performed on a local user.
* The source parameter contains the details of the user who issued the WHOIS command, and
* the dest parameter contains the information of the user they are whoising.
* @param dest The user who is being WHOISed
*/
virtual void OnWhois(User* source, User* dest);
-
+
/** Called whenever a user is about to invite another user into a channel, before any processing is done.
* Returning 1 from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* @param source The user who is issuing the INVITE
* @param dest The user being invited
* @param channel The channel the user is being invited to
- * @return 1 to deny the invite, 0 to allow
+ * @param timeout The time the invite will expire (0 == never)
+ * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
*/
- virtual int OnUserPreInvite(User* source,User* dest,Channel* channel);
-
+ virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
+
/** Called after a user has been successfully invited to a channel.
* You cannot prevent the invite from occuring using this function, to do that,
* use OnUserPreInvite instead.
* @param source The user who is issuing the INVITE
* @param dest The user being invited
* @param channel The channel the user is being invited to
+ * @param timeout The time the invite will expire (0 == never)
*/
- virtual void OnUserInvite(User* source,User* dest,Channel* channel);
-
+ virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
+
/** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
* Returning any nonzero value from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
* @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
* It will be ignored for private messages.
- * @return 1 to deny the NOTICE, 0 to allow it
+ * @return 1 to deny the message, 0 to allow it
*/
- virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
+ virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
/** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
* Returning any nonzero value from this function stops the process immediately, causing no
* It will be ignored for private notices.
* @return 1 to deny the NOTICE, 0 to allow it
*/
- virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
+ virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
- /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
- * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
- * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
- * @param chan The channel to build the exempt list of
- * @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
+ /** Called when sending a message to all "neighbors" of a given user -
+ * that is, all users that share a common channel. This is used in
+ * commands such as NICK, QUIT, etc.
+ * @param source The source of the message
+ * @param include_c Channels to scan for users to include
+ * @param exceptions Map of user->bool that overrides the inclusion decision
+ *
+ * Set exceptions[user] = true to include, exceptions[user] = false to exclude
*/
- virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
-
+ virtual void OnBuildNeighborList(User* source, UserChanList &include_c, std::map<User*,bool> &exceptions);
+
/** 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
* NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
* @param newnick Their new nickname
* @return 1 to deny the change, 0 to allow
*/
- virtual int OnUserPreNick(User* user, const std::string &newnick);
+ virtual ModResult OnUserPreNick(User* user, const std::string &newnick);
/** Called after any PRIVMSG sent from a user.
* The dest variable contains a User* if target_type is TYPE_USER and a Channel*
* @param dest The target of the modes (User* or Channel*)
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text The actual modes and their parameters if any
+ * @param translate The translation types of the mode parameters
*/
- virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
+ virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
/** Allows modules to alter or create server descriptions
* Whenever a module requires a server description, for example for display in
* the linking protocol. This currently is m_spanningtree.so. A pointer to this module
* is given in Module* proto, so that you may call its methods such as ProtoSendMode
* (see below). This function will be called for every user visible on your side
- * of the burst, allowing you to for example set modes, etc. Do not use this call to
- * synchronize data which you have stored using class Extensible -- There is a specialist
- * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
+ * of the burst, allowing you to for example set modes, etc.
*
* For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
*
*/
virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
- /* Allows modules to syncronize metadata related to channels over the network during a netburst.
- * Whenever the linking module wants to send out data, but doesnt know what the data
- * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
- * this method is called.You should use the ProtoSendMetaData function after you've
- * correctly decided how the data should be represented, to send the metadata on its way if it belongs
- * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
- * @param chan The channel whos metadata is being syncronized
- * @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(Channel* 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
- * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
- * this method is called. You should use the ProtoSendMetaData function after you've
- * correctly decided how the data should be represented, to send the metadata on its way if
- * if it belongs to your module.
- * @param user The user whos metadata is being syncronized
- * @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(User* 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
* represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
* @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, bool displayable = false);
+ virtual void OnSyncNetwork(Module* proto, void* opaque);
/** 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 extname The extension name which is being sent
* @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
*/
- virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
+ virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
/** Implemented by modules which provide the ability to link servers.
* These modules will implement this method, which allows transparent sending of servermodes
* @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
* @param target The Channel* or User* that modes should be sent for
* @param modeline The modes and parameters to be sent
+ * @param translate The translation types of the mode parameters
*/
- virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
+ virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
/** Implemented by modules which provide the ability to link servers.
* These modules will implement this method, which allows metadata (extra data added to
* @param extname The extension name to send metadata for
* @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
*/
- virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
-
+ virtual void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
+
/** Called after every WALLOPS command.
* @param user The user sending the WALLOPS
* @param text The content of the WALLOPS message
*/
virtual void OnChangeName(User* user, const std::string &gecos);
+ /** Called whenever a user's IDENT is changed.
+ * This event triggers after the name has been set.
+ * @param user The user who's IDENT is being changed
+ * @param gecos The new IDENT being set on the user
+ */
+ virtual void OnChangeIdent(User* user, const std::string &ident);
+
/** Called whenever an xline is added by a local user.
* This method is triggered after the line is added.
* @param source The sender of the line or NULL for local server
*/
virtual void OnUserPostNick(User* user, const std::string &oldnick);
- /** Called before an action which requires a channel privilage check.
- * This function is called before many functions which check a users status on a channel, for example
- * before opping a user, deopping a user, kicking a user, etc.
- * There are several values for access_type which indicate for what reason access is being checked.
- * These are:<br><br>
- * AC_KICK (0) - A user is being kicked<br>
- * AC_DEOP (1) - a user is being deopped<br>
- * AC_OP (2) - a user is being opped<br>
- * AC_VOICE (3) - a user is being voiced<br>
- * AC_DEVOICE (4) - a user is being devoiced<br>
- * AC_HALFOP (5) - a user is being halfopped<br>
- * AC_DEHALFOP (6) - a user is being dehalfopped<br>
- * AC_INVITE () - a user is being invited<br>
- * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
- * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
- * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
- * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
- * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
- * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
- * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
- * @param source The source of the access check
- * @param dest The destination of the access check
- * @param channel The channel which is being checked
- * @param access_type See above
- */
- virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
+ /** Called before any mode change, to allow a single access check for
+ * a full mode change (use OnRawMode to check individual modes)
+ *
+ * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
+ * OnRawMode for each individual mode
+ *
+ * @param source the user making the mode change
+ * @param dest the user destination of the umode change (NULL if a channel mode)
+ * @param channel the channel destination of the mode change
+ * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
+ */
+ virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
/** Called when a 005 numeric is about to be output.
* The module should modify the 005 numeric if needed to indicate its features.
* @param reason The kill reason
* @return 1 to prevent the kill, 0 to allow
*/
- virtual int OnKill(User* source, User* dest, const std::string &reason);
+ virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
/** Called when an oper wants to disconnect a remote user via KILL
* @param source The user sending the KILL
* absolutely neccessary (e.g. a module that extends the features of another
* module).
* @param mod A pointer to the new module
- * @param name The new module's filename
*/
- virtual void OnLoadModule(Module* mod,const std::string &name);
+ virtual void OnLoadModule(Module* mod);
/** Called whenever a module is unloaded.
* mod will contain a pointer to the module, and string will contain its name,
* @param mod Pointer to the module being unloaded (still valid)
* @param name The filename of the module being unloaded
*/
- virtual void OnUnloadModule(Module* mod,const std::string &name);
+ virtual void OnUnloadModule(Module* mod);
/** Called once every five seconds for background processing.
* This timer can be used to control timed features. Its period is not accurate
* @param pcnt The nuimber of parameters passed to the command
* @param user the user issuing the command
* @param validated True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc.
+ * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
* @param original_line The entire original line as passed to the parser from the user
* @return 1 to block the command, 0 to allow
*/
- virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line);
+ virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
/** Called after any command has been executed.
* This event occurs for all registered commands, wether they are registered in the core,
* @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
* @param original_line The entire original line as passed to the parser from the user
*/
- virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, User *user, CmdResult result, const std::string &original_line);
+ virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
/** Called to check if a user who is connecting can now be allowed to register
* If any modules return false for this function, the user is held in the waiting
* @param user The user to check
* @return true to indicate readiness, false if otherwise
*/
- virtual bool OnCheckReady(User* user);
+ virtual ModResult OnCheckReady(User* user);
/** Called whenever a user is about to register their connection (e.g. before the user
* is sent the MOTD etc). Modules can use this method if they are performing a function
* @param user The user registering
* @return 1 to indicate user quit, 0 to continue
*/
- virtual int OnUserRegister(User* user);
+ virtual ModResult OnUserRegister(User* user);
/** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +i, and
* @param chan The channel being joined
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckInvite(User* user, Channel* chan);
+ virtual ModResult OnCheckInvite(User* user, Channel* chan);
/** Called whenever a mode character is processed.
* Return 1 from this function to block the mode character from being processed entirely.
* @param param The parameter for the mode or an empty string
* @param adding true of the mode is being added, false if it is being removed
* @param pcnt The parameter count for the mode (0 or 1)
- * @return 1 to deny the mode, 0 to allow
+ * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
+ * to skip all permission checking. Please note that for remote mode changes, your return value
+ * will be ignored!
*/
- virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
+ virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
/** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +k, and
* @param chan The channel being joined
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
+ virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
/** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +l, and
* @param chan The channel being joined
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckLimit(User* user, Channel* chan);
+ virtual ModResult OnCheckLimit(User* user, Channel* chan);
- /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
- * This method will always be called for each join, wether or not the user actually matches a channel ban, and
- * determines the outcome of an if statement around the whole section of ban checking code.
- * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
- * @param user The user joining the channel
- * @param chan The channel being joined
- * @return 1 to explicitly allow the join, 0 to proceed as normal
+ /**
+ * Checks for a user's ban from the channel
+ * @param user The user to check
+ * @param chan The channel to check in
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
*/
- virtual int OnCheckBan(User* user, Channel* chan);
+ virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
+
+ /**
+ * Checks for a user's match of a single ban
+ * @param user The user to check for match
+ * @param chan The channel on which the match is being checked
+ * @param mask The mask being checked
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
+ */
+ virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
+
+ /** Checks for a match on a given extban type
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
+ */
+ virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
/** Called on all /STATS commands
* This method is triggered for all /STATS use, including stats symbols handled by the core.
* work when remote STATS queries are received.
* @return 1 to block the /STATS from being processed by the core, 0 to allow it
*/
- virtual int OnStats(char symbol, User* user, string_list &results);
+ virtual ModResult OnStats(char symbol, User* user, string_list &results);
/** Called whenever a change of a local users displayed host is attempted.
* Return 1 to deny the host change, or 0 to allow it.
* @param newhost The new hostname
* @return 1 to deny the host change, 0 to allow
*/
- virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
+ virtual ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
/** Called whenever a change of a local users GECOS (fullname field) is attempted.
* return 1 to deny the name change, or 0 to allow it.
* @param newhost The new GECOS
* @return 1 to deny the GECOS change, 0 to allow
*/
- virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
+ virtual ModResult OnChangeLocalUserGECOS(User* user, const std::string &newhost);
- /** Called whenever a topic is changed by a local user.
- * Return 1 to deny the topic change, or 0 to allow it.
+ /** Called before a topic is changed.
+ * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
+ * As with other 'pre' events, you should only ever block a local event.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text
* @param 1 to block the topic change, 0 to allow
*/
- virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
+ virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
- /** Called whenever a local topic has been changed.
- * To block topic changes you must use OnLocalTopicChange instead.
+ /** Called whenever a topic has been changed.
+ * To block topic changes you must use OnPreTopicChange instead.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text
*/
- virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
+ virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
- /** Called whenever an Event class is sent to all module by another module.
- * Please see the documentation of Event::Send() for further information. The Event sent can
- * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
- * before doing anything to the event data, and you should *not* change the event data in any way!
+ /** Called whenever an Event class is sent to all modules by another module.
+ * You should *always* check the value of Event::id to determine the event type.
* @param event The Event class being received
*/
- virtual void OnEvent(Event* event);
+ virtual void OnEvent(Event& event);
/** Called whenever a Request class is sent to your module by another module.
- * Please see the documentation of Request::Send() for further information. The Request sent
- * can always be assumed to be non-NULL, you should not change the request object or its data.
- * Your method may return arbitary data in the char* result which the requesting module
- * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
+ * The value of Request::id should be used to determine the type of request.
* @param request The Request class being received
*/
- virtual char* OnRequest(Request* request);
+ virtual void OnRequest(Request& request);
/** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
* The password field (from the config file) is in 'password' and is to be compared against
* @param hashtype The hash value from the config
* @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
*/
- virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
+ virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
/** Called whenever a user is given usermode +o, anywhere on the network.
* You cannot override this and prevent it from happening as it is already happened and
* @param banmask The ban mask being added
* @return 1 to block the ban, 0 to continue as normal
*/
- virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
+ virtual ModResult OnAddBan(User* source, Channel* channel,const std::string &banmask);
/** Called whenever a ban is removed from a channel's list.
* Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
* @param banmask The ban mask being deleted
* @return 1 to block the unban, 0 to continue as normal
*/
- virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
+ virtual ModResult OnDelBan(User* source, Channel* channel,const std::string &banmask);
+
+ /** Called to install an I/O hook on an event handler
+ * @param user The item to possibly install the I/O hook on
+ * @param via The port that <user> connected on
+ */
+ virtual void OnHookIO(StreamSocket*, ListenSocketBase* via);
- /** Called immediately after any connection is accepted. This is intended for raw socket
+ /** Called immediately after any connection is accepted. This is intended for raw socket
* processing (e.g. modules which wrap the tcp connection within another library) and provides
* no information relating to a user record as the connection has not been assigned yet.
* There are no return values from this call as all modules get an opportunity if required to
* process the connection.
* @param fd The file descriptor returned from accept()
- * @param ip The IP address of the connecting user
+ * @param client The client IP address and port
+ * @param server The server IP address and port
* @param localport The local port number the user connected to
*/
- virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
+ virtual void OnStreamSocketAccept(StreamSocket*, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
- /** Called immediately before any write() operation on a user's socket in the core. Because
- * this event is a low level event no user information is associated with it. It is intended
- * for use by modules which may wrap connections within another API such as SSL for example.
- * return a non-zero result if you have handled the write operation, in which case the core
- * will not call write().
- * @param fd The file descriptor of the socket
- * @param buffer A char* buffer being written
- * @param Number of characters to write
- * @return Number of characters actually written or 0 if you didn't handle the operation
+ /**
+ * Called when a hooked stream has data to write, or when the socket
+ * engine returns it as writable
+ * @param socket The socket in question
+ * @param sendq Data to send to the socket
+ * @return 1 if the sendq has been completely emptied, 0 if there is
+ * still data to send, and -1 if there was an error
*/
- virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
+ virtual int OnStreamSocketWrite(StreamSocket*, std::string& sendq);
/** Called immediately before any socket is closed. When this event is called, shutdown()
* has not yet been called on the socket.
* @param fd The file descriptor of the socket prior to close()
*/
- virtual void OnRawSocketClose(int fd);
+ virtual void OnStreamSocketClose(StreamSocket*);
/** Called immediately upon connection of an outbound BufferedSocket 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.
- * This occurs AFTER the select() or poll() so there is always data waiting to be read
- * when this event occurs.
- * Your event should return 1 if it has handled the reading itself, which prevents the core
- * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
- * the value of count. The value of readresult must be identical to an actual result that might
- * be returned from the read() system call, for example, number of bytes read upon success,
- * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
- * you MUST set readresult.
- * @param fd The file descriptor of the socket
- * @param buffer A char* buffer being read to
- * @param count The size of the buffer
- * @param readresult The amount of characters read, or 0
- * @return nonzero if the event was handled, in which case readresult must be valid on exit
- */
- virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
-
- /** Called whenever a user sets away.
- * This method has no parameter for the away message, as it is available in the
- * user record as User::awaymsg.
- * @param user The user setting away
+ virtual void OnStreamSocketConnect(StreamSocket*);
+
+ /**
+ * Called when the stream socket has data to read
+ * @param socket The socket that is ready
+ * @param recvq The receive queue that new data should be appended to
+ * @return 1 if new data has been read, 0 if no new data is ready (but the
+ * socket is still connected), -1 if there was an error or close
*/
- virtual void OnSetAway(User* user);
+ virtual int OnStreamSocketRead(StreamSocket*, std::string& recvq);
- /** Called when a user cancels their away state.
- * @param user The user returning from away
+ /** Called whenever a user sets away or returns from being away.
+ * The away message is available as a parameter, but should not be modified.
+ * At this stage, it has already been copied into the user record.
+ * If awaymsg is empty, the user is returning from away.
+ * @param user The user setting away
+ * @param awaymsg The away message of the user, or empty if returning from away
+ * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
*/
- virtual void OnCancelAway(User* user);
+ virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
/** Called whenever a NAMES list is requested.
* You can produce the nameslist yourself, overriding the current 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.
- * Returning -1 allows the names list, but bypasses any checks which check for
- * channel membership before sending the names list.
*/
- virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
+ virtual ModResult OnUserList(User* user, Channel* Ptr);
/** 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
* @return nonzero to drop the line completely so that the user does not
* receive it, or zero to allow the line to be sent.
*/
- virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
+ virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
/** Called at intervals for modules to garbage-collect any hashes etc.
* Certain data types such as hash_map 'leak' buckets, which must be
*/
virtual void OnGarbageCollect();
- /** Called whenever a user's write buffer has been completely sent.
- * This is called when the user's write buffer is completely empty, and
- * there are no more pending bytes to be written and no pending write events
- * in the socket engine's queue. This may be used to refill the buffer with
- * data which is being spooled in a controlled manner, e.g. LIST lines.
- * @param user The user who's buffer is now empty.
+ /** Add test suite hooks here. These are used for testing functionality of a module
+ * via the --testsuite debugging parameter.
*/
- virtual void OnBufferFlushed(User* user);
+ virtual void OnRunTestSuite();
+
+ /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
+ * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
+ * module, then this will cause the nickname not to be displayed at all.
+ */
+ virtual void OnNamesListItem(User* issuer, Membership* item, std::string &prefixes, std::string &nick);
+
+ virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
+
+ /** Called whenever a result from /WHO is about to be returned
+ * @param source The user running the /WHO query
+ * @param user The user that this line of the query is about
+ * @param channel The channel being queried (or NULL if not a channel query)
+ * @param line The raw line to send; modifiable, if empty no line will be returned.
+ */
+ virtual void OnSendWhoLine(User* source, User* user, Channel* channel, std::string& line);
+
+ /** Called to check whether a channel restriction mode applies to a user on it
+ * @return MOD_RES_DENY to apply the restriction, MOD_RES_ALLOW to bypass
+ * the restriction, or MOD_RES_PASSTHRU to check restriction status normally
+ */
+ virtual ModResult OnChannelRestrictionApply(User* user, Channel* chan, const char* restriction);
};
class CoreExport ConfigReader : public classbase
{
protected:
- InspIRCd* ServerInstance;
- /** The contents of the configuration file
- * This protected member should never be accessed by a module (and cannot be accessed unless the
- * core is changed). It will contain a pointer to the configuration file data with unneeded data
- * (such as comments) stripped from it.
- */
- ConfigDataHash* data;
- /** Used to store errors
- */
- 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:
/** Default constructor.
* This constructor initialises the ConfigReader class to read the inspircd.conf file
* as specified when running ./configure.
*/
- ConfigReader(InspIRCd* Instance);
- /** Overloaded constructor.
- * This constructor initialises the ConfigReader class to read a user-specified config file
- */
- ConfigReader(InspIRCd* Instance, const std::string &filename);
+ ConfigReader();
/** Default destructor.
* This method destroys the ConfigReader class.
*/
* A call to GetError() resets the error flag back to 0.
*/
long GetError();
+
/** Counts the number of times a given tag appears in the config file.
* This method counts the number of times a tag appears in a config file, for use where
* there are several tags of the same kind, e.g. with opers and connect types. It can be
* multiple instance tag.
*/
int Enumerate(const std::string &tag);
- /** Returns true if a config file is valid.
- * This method is partially implemented and will only return false if the config
- * file does not exist or could not be opened.
- */
- bool Verify();
- /** Dumps the list of errors in a config file to an output location. If bail is true,
- * then the program will abort. If bail is false and user points to a valid user
- * record, the error report will be spooled to the given user by means of NOTICE.
- * if bool is false AND user is false, the error report will be spooled to all opers
- * by means of a NOTICE to all opers.
- */
- void DumpErrors(bool bail,User* user);
-
- /** Returns the number of items within a tag.
- * For example if the tag was <test tag="blah" data="foo"> then this
- * function would return 2. Spaces and newlines both qualify as valid seperators
- * between values.
- */
- int EnumerateValues(const std::string &tag, int index);
};
*/
class CoreExport FileReader : public classbase
{
- InspIRCd* ServerInstance;
/** The file contents
*/
- file_cache fc;
+ std::vector<std::string> fc;
/** Content size in bytes
*/
* This method does not load any file into memory, you must use the LoadFile method
* after constructing the class this way.
*/
- FileReader(InspIRCd* Instance);
+ FileReader();
/** Secondary constructor.
* This method initialises the class with a file loaded into it ready for GetLine and
* and other methods to be called. If the file could not be loaded, FileReader::FileSize
* returns 0.
*/
- FileReader(InspIRCd* Instance, const std::string &filename);
+ FileReader(const std::string &filename);
/** Default destructor.
* This deletes the memory allocated to the file.
* This function will return false if the file could not be opened.
*/
bool Exists();
-
+
/** Retrieve one line from the file.
* This method retrieves one line from the text file. If an empty non-NULL string is returned,
* the index was out of bounds, or the line had no data on it.
int FileSize();
};
-/** A DLLFactory (designed to load shared objects) containing a
- * handle to a module's init_module() function. Unfortunately,
- * due to the design of shared object systems we must keep this
- * hanging around, as if we remove this handle, we remove the
- * shared object file from memory (!)
- */
-typedef DLLFactory<Module> ircd_module;
-
/** A list of modules
*/
typedef std::vector<Module*> IntModuleList;
*/
typedef IntModuleList::iterator EventHandlerIter;
-/** Module priority states
- */
-enum PriorityState
-{
- PRIO_DONTCARE,
- PRIO_FIRST,
- PRIO_LAST,
- PRIO_AFTER,
- PRIO_BEFORE
-};
-
/** ModuleManager takes care of all things module-related
* in the core.
*/
/** Holds a string describing the last module error to occur
*/
std::string LastModuleError;
-
- /** The feature names published by various modules
+
+ /** 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
*/
- int ModCount;
-
- /** Our pointer to the main insp instance
- */
- InspIRCd* Instance;
+ int ModCount;
/** List of loaded modules and shared object/dll handles
* keyed by module name
*/
- std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
+ std::map<std::string, Module*> Modules;
+
+ enum {
+ PRIO_STATE_FIRST,
+ PRIO_STATE_AGAIN,
+ PRIO_STATE_LAST
+ } prioritizationState;
+ /** Internal unload module hook */
+ bool CanUnload(Module*);
public:
/** Event handler hooks.
/** Simple, bog-standard, boring constructor.
*/
- ModuleManager(InspIRCd* Ins);
+ ModuleManager();
/** Destructor
*/
- ~ModuleManager();
+ ~ModuleManager();
/** Change the priority of one event in a module.
* Each module event has a list of modules which are attached to that event type.
* @param i The event to change the priority of
* @param s The state you wish to use for this event. Use one of
* PRIO_FIRST to set the event to be first called, PRIO_LAST to
- * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
+ * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
* to set it to be before or after one or more other modules.
- * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
- * then this contains a list of one or more modules your module must be
+ * @param modules If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
+ * then this contains a list of one or more modules your module must be
* placed before or after. Your module will be placed before the highest
* priority module in this list for PRIO_BEFORE, or after the lowest
- * priority module in this list for PRIO_AFTER.
- * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
+ * priority module in this list for PRIORITY_AFTER.
+ * @param sz The number of modules being passed for PRIO_BEFORE and PRIORITY_AFTER.
* Defaults to 1, as most of the time you will only want to prioritize your module
* to be before or after one other module.
*/
- bool SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules = NULL, size_t sz = 1);
+ bool SetPriority(Module* mod, Implementation i, Priority s, Module** modules = NULL, size_t sz = 1);
/** Change the priority of all events in a module.
* @param mod The module to set the priority of
* @param s The priority of all events in the module.
* Note that with this method, it is not possible to effectively use
- * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
+ * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
* SetPriority method for this, where you may specify other modules to
* be prioritized against.
*/
- bool SetPriority(Module* mod, PriorityState s);
+ bool SetPriority(Module* mod, Priority s);
/** Attach an event to a module.
* You may later detatch the event with ModuleManager::Detach().
* @param mod Module to detach from
*/
void DetachAll(Module* mod);
-
+
/** Returns text describing the last module error
* @return The last error message to occur
*/
*/
bool Load(const char* filename);
- /** Unload a given module file
- * @param filename The file to unload
- * @return True if the module was unloaded
+ /** Unload a given module file. Note that the module will not be
+ * completely gone until the cull list has finished processing.
+ *
+ * @return true on success; if false, LastError will give a reason
*/
- bool Unload(const char* filename);
-
+ bool Unload(Module* module);
+
+ /** Run an asynchronous reload of the given module. When the reload is
+ * complete, the callback will be run with true if the reload succeeded
+ * and false if it did not.
+ */
+ void Reload(Module* module, HandlerBase1<void, bool>* callback);
+
/** Called by the InspIRCd constructor to load all modules from the config file.
*/
void LoadAll();
-
+ void UnloadAll();
+ void DoSafeUnload(Module*);
+
/** Get the total number of currently loaded modules
* @return The number of loaded modules
*/
{
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);
-
+
/** 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
const std::vector<std::string> GetAllModuleNames(int filter);
};
+/** Do not mess with these functions unless you know the C preprocessor
+ * well enough to explain why they are needed. The order is important.
+ */
+#define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
+#define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
+#define MODULE_INIT_STR_FN_1(x) #x
+#define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(API_VERSION)
+#define MODULE_INIT_SYM_FN_2(x) MODULE_INIT_SYM_FN_1(x)
+#define MODULE_INIT_SYM_FN_1(x) inspircd_module_ ## x
+
/** 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.
*/
+#ifdef WINDOWS
+
#define MODULE_INIT(y) \
- extern "C" DllExport Module * init_module(InspIRCd* Me) \
+ extern "C" DllExport Module * MODULE_INIT_SYM() \
{ \
- return new y(Me); \
+ return new y; \
+ } \
+ BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
+ { \
+ switch ( nReason ) \
+ { \
+ case DLL_PROCESS_ATTACH: \
+ case DLL_PROCESS_DETACH: \
+ break; \
+ } \
+ return TRUE; \
}
+#else
+
+#define MODULE_INIT(y) \
+ extern "C" DllExport Module * MODULE_INIT_SYM() \
+ { \
+ return new y; \
+ }
+#endif
+
+#define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)
+
#endif
projects / user / henk / code / inspircd.git / blobdiff