Fix bug spotted by KingTarquin, if an empty string is given to /stats with "STATS...

[user/henk/code/inspircd.git] / include / modules.h

diff --git a/include/modules.h b/include/modules.h
index e9ada30ff367aab31e1a477810c3a2d71ad1f42a..02af1dc7df939cfb5c80e3b2a88fb8e4b5690d22 100644 (file)
--- a/include/modules.h
+++ b/include/modules.h
@@ -400,7 +400,7 @@ enum Implementation
        I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
        I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
        I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
-       I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO,
+       I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO, I_OnHostCycle,
        I_END
 };
 
@@ -660,7 +660,7 @@ class CoreExport Module : public Extensible
         * @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);
 
@@ -861,7 +861,7 @@ class CoreExport Module : public Extensible
         * @param target The Channel* or User* that modes should be sent for
         * @param modeline The modes and parameters to be sent
         */
-       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::string &modeline);
 
        /** Implemented by modules which provide the ability to link servers.
         * These modules will implement this method, which allows metadata (extra data added to
@@ -877,7 +877,7 @@ class CoreExport Module : public Extensible
         * @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, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
        
        /** Called after every WALLOPS command.
         * @param user The user sending the WALLOPS
@@ -946,15 +946,15 @@ class CoreExport Module : public Extensible
         * 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>
+        * AC_KICK - A user is being kicked<br>
+        * AC_DEOP - a user is being deopped<br>
+        * AC_OP - a user is being opped<br>
+        * AC_VOICE - a user is being voiced<br>
+        * AC_DEVOICE - a user is being devoiced<br>
+        * AC_HALFOP - a user is being halfopped<br>
+        * AC_DEHALFOP - a user is being dehalfopped<br>
+        * AC_INVITE - a user is being invited<br>
+        * AC_GENERAL_MODE - 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
@@ -1385,6 +1385,12 @@ class CoreExport Module : public Extensible
        virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
 
        virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
+
+       /** Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host'
+        * message should be sent, if enabled. Certain modules such as auditorium may opt to hide this message
+        * even if it is enabled.
+        */
+       virtual bool OnHostCycle(User* user);
 };