X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fmodules.h;h=5244930d003f181c0e338fea984b4e8408d0a59f;hb=63e300ed082b82530ad5ae0949f45686746b7c9b;hp=378aec1eeb023febfe1336054d144efae095da88;hpb=a39bd397cd0052dd8e23ba5c4c5dfc9b3a11a70c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/modules.h b/include/modules.h index 378aec1ee..5244930d0 100644 --- a/include/modules.h +++ b/include/modules.h @@ -35,14 +35,23 @@ #include "timer.h" #include "mode.h" -/** Used to define a set of behavior bits for a module - */ -enum ModuleFlags { - VF_NONE = 0, // module is not special at all - VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party) - VF_COMMON = 4, // module needs to be common on all servers in a network to link - VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior - VF_CORE = 16 // module is a core command, can be assumed loaded on all servers +/** Used to specify the behaviour of a module. */ +enum ModuleFlags +{ + /** The module has no special attributes. */ + VF_NONE = 0, + + /** The module is a coremod and can be assumed to be loaded on all servers. */ + VF_CORE = 1, + + /* The module is included with InspIRCd. */ + VF_VENDOR = 2, + + /** The module MUST be loaded on all servers on a network to link. */ + VF_COMMON = 4, + + /** The module SHOULD be loaded on all servers on a network for consistency. */ + VF_OPTCOMMON = 8 }; /** Used to represent an event type, for user, channel or server @@ -201,8 +210,6 @@ class CoreExport Version /** Complex version information, including linking compatability data */ Version(const std::string &desc, int flags, const std::string& linkdata); - - virtual ~Version() {} }; class CoreExport DataProvider : public ServiceProvider @@ -278,7 +285,7 @@ class CoreExport Module : public classbase, public usecountbase /** Clean up prior to destruction * If you override, you must call this AFTER your module's cleanup */ - virtual CullResult cull(); + virtual CullResult cull() CXX11_OVERRIDE; /** Default destructor. * destroys a module class @@ -487,8 +494,10 @@ class CoreExport Module : public classbase, public usecountbase * @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) + * @param notifyrank Rank required to get an invite announcement (if enabled) + * @param notifyexcepts List of users to not send the default NOTICE invite announcement to */ - virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout); + 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 @@ -649,16 +658,15 @@ class CoreExport Module : public classbase, public usecountbase */ virtual void OnExpireLine(XLine *line); - /** Called before your module is unloaded to clean up Extensibles. - * This method is called once for every user and channel on the network, - * so that when your module unloads it may clear up any remaining data - * in the form of Extensibles added using Extensible::Extend(). - * If the target_type variable is TYPE_USER, then void* item refers to - * a User*, otherwise it refers to a Channel*. - * @param target_type The type of item being cleaned - * @param item A pointer to the item's class + /** Called before the module is unloaded to clean up extensibles. + * This method is called once for every channel, membership, and user. + * so that you can clear up any data relating to the specified extensible. + * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL + * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*, + * and EXT_USER then item is a User*. + * @param item A pointer to the extensible which is being cleaned up. */ - virtual void OnCleanup(int target_type, void* item); + virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item); /** Called after any nickchange, local or remote. This can be used to track users after nickchanges * have been applied. Please note that although you can see remote nickchanges through this function, you should @@ -871,14 +879,10 @@ class CoreExport Module : public classbase, public usecountbase /** Called on all /STATS commands * This method is triggered for all /STATS use, including stats symbols handled by the core. - * @param symbol the symbol provided to /STATS - * @param user the user issuing the /STATS command - * @param results A string_list to append results into. You should put all your results - * into this string_list, rather than displaying them directly, so that your handler will - * work when remote STATS queries are received. + * @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(char symbol, User* user, string_list &results); + 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. @@ -985,16 +989,17 @@ class CoreExport Module : public classbase, public usecountbase */ virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick); - virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text); + 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 line The raw line to send; modifiable, if empty no line will be returned. + * @param numeric Numeric to send; modifiable. + * @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it */ - virtual void OnSendWhoLine(User* source, const std::vector& params, User* user, Membership* memb, std::string& line); + virtual ModResult OnSendWhoLine(User* source, const std::vector& 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. @@ -1007,10 +1012,6 @@ class CoreExport Module : public classbase, public usecountbase */ typedef std::vector IntModuleList; -/** An event handler iterator - */ -typedef IntModuleList::iterator EventHandlerIter; - /** ModuleManager takes care of all things module-related * in the core. */ @@ -1035,10 +1036,7 @@ class CoreExport ModuleManager : public fakederef PRIO_STATE_LAST } prioritizationState; - /** Internal unload module hook */ - bool CanUnload(Module*); - - /** Loads all core modules (cmd_*) + /** Loads all core modules (core_*) */ void LoadCoreModules(std::map& servicemap); @@ -1047,6 +1045,12 @@ class CoreExport ModuleManager : public fakederef */ bool PrioritizeHooks(); + /** Unregister all user modes or all channel modes owned by a module + * @param mod Module whose modes to unregister + * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes + */ + void UnregisterModes(Module* mod, ModeType modetype); + public: typedef std::map ModuleMap; @@ -1165,18 +1169,19 @@ class CoreExport ModuleManager : public fakederef */ 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* callback); - /** Called by the InspIRCd constructor to load all modules from the config file. */ void LoadAll(); void UnloadAll(); void DoSafeUnload(Module*); + /** Check if a module can be unloaded and if yes, prepare it for unload + * @param mod Module to be unloaded + * @return True if the module is unloadable, false otherwise. + * If true the module must be unloaded in the current main loop iteration. + */ + bool CanUnload(Module* mod); + /** 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 @@ -1238,7 +1243,7 @@ class CoreExport ModuleManager : public fakederef #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 PURE_STATIC +#ifdef INSPIRCD_STATIC struct AllCommandList { typedef Command* (*fn)(Module*); @@ -1280,7 +1285,7 @@ struct AllModuleList { } \ return TRUE; \ } \ - extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION; + extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION; #else @@ -1289,7 +1294,7 @@ struct AllModuleList { { \ return new y; \ } \ - extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION; + extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION; #endif #define COMMAND_INIT(c) MODULE_INIT(CommandModule)