]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/modules.h
Add support for the IRCv3 account-tag specification.
[user/henk/code/inspircd.git] / include / modules.h
index a5e5461493e040b6c605189603584510f3adb772..ba84c4ccc30a308a035637e2c03709ef764f91ac 100644 (file)
@@ -114,8 +114,8 @@ struct ModResult {
  * '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 \
@@ -137,8 +137,8 @@ struct ModResult {
  */
 #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 \
@@ -214,20 +214,20 @@ 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_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
-       I_OnUserPostMessage, 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_OnChangeHost, I_OnChangeRealName, 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_OnPostOper, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
+       I_OnChangeLocalUserHost, 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_OnServiceAdd, I_OnServiceDel,
+       I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
        I_END
 };
 
@@ -244,9 +244,13 @@ class CoreExport Module : public classbase, public usecountbase
        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;
@@ -448,6 +452,11 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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).
@@ -533,6 +542,15 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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,
         * the actual target will have a non-NULL pointer.
@@ -543,9 +561,8 @@ class CoreExport Module : public classbase, public usecountbase
         * @param changelist The changed modes.
         * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
         * for the possible flags.
-        * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
         */
-       virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
+       virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
 
        /** 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.
@@ -562,12 +579,12 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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 OnChangeRealName(User* user, const std::string& real);
 
        /** Called whenever a user's IDENT is changed.
         * This event triggers after the name has been set.
@@ -699,10 +716,9 @@ class CoreExport Module : public classbase, public usecountbase
         * @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 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);
 
        /** Called after any command has been executed.
         * This event occurs for all registered commands, wether they are registered in the core,
@@ -713,9 +729,8 @@ 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 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);
 
        /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
         * connect class, or accepting any commands.
@@ -815,13 +830,6 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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
@@ -830,13 +838,13 @@ class CoreExport Module : public classbase, public usecountbase
         */
        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
@@ -885,16 +893,6 @@ class CoreExport Module : public classbase, public usecountbase
         */
        virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
-       /** 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 ModResult OnSetAway(User* user, const std::string &awaymsg);
-
        /** Called at intervals for modules to garbage-collect any hashes etc.
         * Certain data types such as hash_map 'leak' buckets, which must be
         * tidied up and freed by copying into a new item every so often. This
@@ -954,11 +952,9 @@ class CoreExport Module : public classbase, public usecountbase
         * @param service ServiceProvider being unregistered.
         */
        virtual void OnServiceDel(ServiceProvider& service);
-};
 
-/** A list of modules
- */
-typedef std::vector<Module*> IntModuleList;
+       virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
+};
 
 /** ModuleManager takes care of all things module-related
  * in the core.
@@ -1005,7 +1001,7 @@ class CoreExport ModuleManager : public fakederef<ModuleManager>
        /** 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;
@@ -1191,27 +1187,6 @@ class CoreExport ModuleManager : public fakederef<ModuleManager>
 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
 
-#ifdef INSPIRCD_STATIC
-
-struct AllCommandList {
-       typedef Command* (*fn)(Module*);
-       AllCommandList(fn cmd);
-};
-#define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
-       static const AllCommandList PREP_ ## x(&MK_ ## x);
-
-struct AllModuleList {
-       typedef Module* (*fn)();
-       fn init;
-       std::string name;
-       AllModuleList(fn mod, const std::string& Name);
-};
-
-#define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
-       static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
-
-#else
-
 /** 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.
@@ -1224,5 +1199,3 @@ struct AllModuleList {
        extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
 
 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)
-
-#endif