VF_OPTCOMMON = 8
};
-/** Used to represent an event type, for user, channel or server
- */
-enum TargetTypeFlags {
- TYPE_USER = 1,
- TYPE_CHANNEL,
- TYPE_SERVER,
- TYPE_OTHER
-};
-
-/** Used to represent wether a message was PRIVMSG or NOTICE
- */
-enum MessageType {
- MSG_PRIVMSG = 0,
- MSG_NOTICE = 1
-};
-
#define MOD_RES_ALLOW (ModResult(1))
#define MOD_RES_PASSTHRU (ModResult(0))
#define MOD_RES_DENY (ModResult(-1))
* 'FOREACH_MOD(OnConnect,(user));'
*/
#define FOREACH_MOD(y,x) do { \
- const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
- for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
+ const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
+ for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
{ \
_next = _i+1; \
try \
*/
#define DO_EACH_HOOK(n,v,args) \
do { \
- const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
- for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
+ const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
+ for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
{ \
_next = _i+1; \
try \
I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
- I_OnUserMessage, I_OnMode,
+ I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode,
I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, 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_OnPreTopicChange,
- I_OnPostTopicChange, I_OnPostConnect,
- I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
+ I_OnChangeLocalUserHost, I_OnPreTopicChange,
+ I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
+ I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
I_OnPostOper, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
- I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
+ I_OnUserMessage, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
I_OnServiceAdd, I_OnServiceDel,
I_END
void DetachEvent(Implementation i);
public:
+ /** A list of modules. */
+ typedef std::vector<Module*> List;
+
/** File that this module was loaded from
*/
std::string ModuleSourceFile;
+
/** Reference to the dlopen() value
*/
DLLManager* ModuleDLLManager;
*/
virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
+ /** Called after a user deopers locally.
+ * @param user The user who has deopered.
+ */
+ virtual void OnPostDeoper(User* user);
+
/** 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).
*/
virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
- /** 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,
- * notices etc. This is useful for modules which may want to filter or redirect messages.
- * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
- * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
- * of where the message is destined to be sent.
- * @param user The user sending the message
- * @param dest The target of the message (Channel* or User*)
- * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
- * @param text Changeable text being sent by the user
- * @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.
- * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
- * @return 1 to deny the message, 0 to allow it
- */
- virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
+ /** Called before a user sends a message to a channel, a user, or a server glob mask.
+ * @param user The user sending the message.
+ * @param target The target of the message. This can either be a channel, a user, or a server
+ * glob mask.
+ * @param details Details about the message such as the message text and type. See the
+ * MessageDetails class for more information.
+ * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
+ * message, or MOD_RES_PASSTHRU to let another module handle the event.
+ */
+ virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
/** 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
*/
virtual ModResult OnUserPreNick(LocalUser* 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*
- * if target_type is TYPE_CHANNEL.
- * @param user The user sending the message
- * @param dest The target of the message
- * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
- * @param text the text being sent by the user
- * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
- * @param exempt_list A list of users to not send to.
- * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
- */
- virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
-
- /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
- * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
- * if target_type is TYPE_CHANNEL.
- * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
- * the message has already been vetted. In the case of the other two methods, a later module may stop your
- * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
- * @param user The user sending the message
- * @param dest The target of the message
- * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
- * @param text the text being sent by the user
- * @param status The status being used, e.g. NOTICE @#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.
- */
- virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
+ /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
+ * @param user The user sending the message.
+ * @param target The target of the message. This can either be a channel, a user, or a server
+ * glob mask.
+ * @param details Details about the message such as the message text and type. See the
+ * MessageDetails class for more information.
+ */
+ virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
+
+ /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
+ * @param user The user sending the message.
+ * @param target The target of the message. This can either be a channel, a user, or a server
+ * glob mask.
+ * @param details Details about the message such as the message text and type. See the
+ * MessageDetails class for more information.
+ */
+ virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
+
+ /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
+ * @param user The user sending the message.
+ * @param target The target of the message. This can either be a channel, a user, or a server
+ * glob mask.
+ * @param details Details about the message such as the message text and type. See the
+ * MessageDetails class for more information.
+ */
+ virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
/** Called after every MODE command sent from a user
* Either the usertarget or the chantarget variable contains the target of the modes,
*/
virtual void OnChangeHost(User* user, const std::string &newhost);
- /** Called whenever a user's GECOS (realname) is changed.
+ /** Called whenever a user's real name is changed.
* This event triggers after the name has been set.
- * @param user The user who's GECOS is being changed
- * @param gecos The new GECOS being set on the user
+ * @param user The user who's real name is being changed
+ * @param name The new real name being set on the user
*/
- virtual void OnChangeName(User* user, const std::string &gecos);
+ virtual void OnChangeName(User* user, const std::string& real);
/** Called whenever a user's IDENT is changed.
* This event triggers after the name has been set.
* @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 ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
+ virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* 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(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
+ virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
/** Called when a user is first connecting, prior to starting DNS lookups, checking initial
* connect class, or accepting any commands.
*/
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.
- * @param stats Context of the /STATS request, contains requesting user, list of answer rows etc.
- * @return 1 to block the /STATS from being processed by the core, 0 to allow it
- */
- virtual ModResult OnStats(Stats::Context& stats);
-
/** 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 user The user whos host will be changed
*/
virtual ModResult OnChangeLocalUserHost(LocalUser* 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 user The user whos GECOS will be changed
- * @param newhost The new GECOS
- * @return 1 to deny the GECOS change, 0 to allow
+ /** Called whenever a change of a local users real name is attempted.
+ * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
+ * @param user The user whos real name will be changed
+ * @param newhost The new real name.
+ * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
*/
- virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
+ virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
/** 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
virtual void OnServiceDel(ServiceProvider& service);
};
-/** A list of modules
- */
-typedef std::vector<Module*> IntModuleList;
-
/** ModuleManager takes care of all things module-related
* in the core.
*/
/** Event handler hooks.
* This needs to be public to be used by FOREACH_MOD and friends.
*/
- IntModuleList EventHandlers[I_END];
+ Module::List EventHandlers[I_END];
/** List of data services keyed by name */
std::multimap<std::string, ServiceProvider*> DataProviders;
* and functions needed to make a module loadable by the OS.
* It defines the class factory and external init_module function.
*/
-#ifdef _WIN32
-
-#define MODULE_INIT(y) \
- extern "C" DllExport Module * MODULE_INIT_SYM() \
- { \
- 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; \
- } \
- extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
-
-#else
-
#define MODULE_INIT(y) \
extern "C" DllExport Module * MODULE_INIT_SYM() \
{ \
return new y; \
} \
extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
-#endif
#define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)
projects / user / henk / code / inspircd.git / blobdiff