]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/modules.h
Use SQUERY instead of PRIVMSG in alias/passforward config.
[user/henk/code/inspircd.git] / include / modules.h
index ba84c4ccc30a308a035637e2c03709ef764f91ac..de418a785777971b74063b16a6aba5875a0a411a 100644 (file)
@@ -99,14 +99,15 @@ struct ModResult {
 /** InspIRCd major version.
  * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
  */
-#define INSPIRCD_VERSION_MAJ 202
+#define INSPIRCD_VERSION_MAJ 300
+
 /** InspIRCd API version.
  * If you change any API elements, increment this value. This counter should be
  * reset whenever the major version is changed. Modules can use these two values
  * and numerical comparisons in preprocessor macros if they wish to support
  * multiple versions of InspIRCd in one file.
  */
-#define INSPIRCD_VERSION_API 1
+#define INSPIRCD_VERSION_API 2
 
 /**
  * This #define allows us to call a method in all
@@ -212,7 +213,7 @@ enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER }
 enum Implementation
 {
        I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
-       I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
+       I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper,
        I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
        I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode,
        I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
@@ -220,13 +221,13 @@ enum Implementation
        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_OnChangeLocalUserHost, I_OnPreTopicChange,
+       I_OnPreChangeHost, I_OnPreTopicChange,
        I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
        I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
        I_OnPostOper, I_OnPostCommand, I_OnPostJoin,
        I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
        I_OnUserMessage, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
-       I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
+       I_OnPreRehash, I_OnModuleRehash, I_OnChangeIdent, I_OnSetUserIP,
        I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
        I_END
 };
@@ -457,18 +458,6 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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).
-        * It is purposefully not possible to modify any info that has already been output, or halt the list.
-        * You must write a 371 numeric to the user, containing your info in the following format:
-        *
-        * <nick> :information here
-        *
-        * @param user The user issuing /INFO
-        */
-       virtual void OnInfo(User* user);
-
        /** 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,
@@ -582,7 +571,7 @@ class CoreExport Module : public classbase, public usecountbase
        /** Called whenever a user's real name is changed.
         * This event triggers after the name has been set.
         * @param user The user who's real name is being changed
-        * @param name The new real name being set on the user
+        * @param real The new real name being set on the user
         */
        virtual void OnChangeRealName(User* user, const std::string& real);
 
@@ -729,8 +718,9 @@ class CoreExport Module : public classbase, public usecountbase
         * @param parameters An array of array of characters containing the parameters for the command
         * @param user the user issuing the command
         * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
+        * @param loop Whether the command is being called from LoopCall or directly.
         */
-       virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result);
+       virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
 
        /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
         * connect class, or accepting any commands.
@@ -836,7 +826,7 @@ class CoreExport Module : public classbase, public usecountbase
         * @param newhost The new hostname
         * @return 1 to deny the host change, 0 to allow
         */
-       virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
+       virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
 
        /** 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.
@@ -906,13 +896,6 @@ class CoreExport Module : public classbase, public usecountbase
         */
        virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
 
-#ifdef INSPIRCD_ENABLE_TESTSUITE
-       /** Add test suite hooks here. These are used for testing functionality of a module
-        * via the --testsuite debugging parameter.
-        */
-       virtual void OnRunTestSuite();
-#endif
-
        /** 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.
         * @param issuer The user who is going to receive the NAMES list being built
@@ -927,16 +910,6 @@ class CoreExport Module : public classbase, public usecountbase
 
        virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
 
-       /** Called whenever a result from /WHO is about to be returned
-        * @param source The user running the /WHO query
-        * @param params The parameters to the /WHO query
-        * @param user The user that this line of the query is about
-        * @param memb The member shown in this line, NULL if no channel is in this line
-        * @param numeric Numeric to send; modifiable.
-        * @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
-        */
-       virtual ModResult OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, Numeric::Numeric& numeric);
-
        /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
         * a module like m_cgiirc changing it.
         * @param user The user whose IP is being set
@@ -953,6 +926,12 @@ class CoreExport Module : public classbase, public usecountbase
         */
        virtual void OnServiceDel(ServiceProvider& service);
 
+       /** Called whenever a message is about to be written to a user.
+        * @param user The user who is having a message sent to them.
+        * @param msg The message which is being written to the user.
+        * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
+        * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
+        */
        virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
 };
 
@@ -1197,5 +1176,3 @@ class CoreExport ModuleManager : public fakederef<ModuleManager>
                return new y; \
        } \
        extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
-
-#define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)