2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2019 iwalkalone <iwalkalone69@gmail.com>
6 * Copyright (C) 2013 Adam <Adam@anope.org>
7 * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
8 * Copyright (C) 2012-2013, 2017-2020 Sadie Powell <sadie@witchery.services>
9 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
10 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
11 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
12 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
13 * Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
14 * Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
15 * Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
16 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
18 * This file is part of InspIRCd. InspIRCd is free software: you can
19 * redistribute it and/or modify it under the terms of the GNU General Public
20 * License as published by the Free Software Foundation, version 2.
22 * This program is distributed in the hope that it will be useful, but WITHOUT
23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
24 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 #include "moduledefs.h"
38 #include "inspsocket.h"
42 /** Used to specify the behaviour of a module. */
45 /** The module has no special attributes. */
48 /** The module is a coremod and can be assumed to be loaded on all servers. */
51 /* The module is included with InspIRCd. */
54 /** The module MUST be loaded on all servers on a network to link. */
57 /** The module SHOULD be loaded on all servers on a network for consistency. */
61 /** The event was explicitly allowed. */
62 #define MOD_RES_ALLOW (ModResult(1))
64 /** The event was not explicitly allowed or denied. */
65 #define MOD_RES_PASSTHRU (ModResult(0))
67 /** The event was explicitly denied. */
68 #define MOD_RES_DENY (ModResult(-1))
70 /** Represents the result of a module event. */
74 /** The underlying result value. */
78 /** Creates a new instance of the ModResult class which defaults to MOD_RES_PASSTHRU. */
84 /** Creates a new instance of the ModResult class with the specified value. */
85 explicit ModResult(char res)
90 /** Determines whether this ModResult has.the same value as \p res */
91 inline bool operator==(const ModResult& res) const
93 return result == res.result;
96 /** Determines whether this ModResult has.a different value to \p res */
97 inline bool operator!=(const ModResult& res) const
99 return result != res.result;
102 /** Determines whether a non-MOD_RES_PASSTHRU result has been set. */
103 inline bool operator!() const
108 /** Checks whether the result is an MOD_RES_ALLOW or MOD_RES_PASSTHRU when the default is to allow. */
109 inline bool check(bool def) const
111 return (result == 1 || (result == 0 && def));
114 /* Merges two results preferring MOD_RES_ALLOW to MOD_RES_DENY. */
115 inline ModResult operator+(const ModResult& res) const
117 // If the results are identical or the other result is MOD_RES_PASSTHRU
118 // then return this result.
119 if (result == res.result || res.result == 0)
122 // If this result is MOD_RES_PASSTHRU then return the other result.
126 // Otherwise, they are different, and neither is MOD_RES_PASSTHRU.
127 return MOD_RES_ALLOW;
132 * This #define allows us to call a method in all
133 * loaded modules in a readable simple way, e.g.:
134 * 'FOREACH_MOD(OnConnect,(user));'
136 #define FOREACH_MOD(y,x) do { \
137 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
138 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
146 catch (CoreException& modexcept) \
148 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
154 * Custom module result handling loop. This is a paired macro, and should only
155 * be used with while_each_hook.
157 * See src/channels.cpp for an example of use.
159 #define DO_EACH_HOOK(n,v,args) \
161 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
162 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
170 #define WHILE_EACH_HOOK(n) \
172 catch (CoreException& except_ ## n) \
174 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
180 * Module result iterator
181 * Runs the given hook until some module returns a useful result.
183 * Example: ModResult result;
184 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
186 #define FIRST_MOD_RESULT(n,v,args) do { \
187 v = MOD_RES_PASSTHRU; \
188 DO_EACH_HOOK(n,v,args) \
190 if (v != MOD_RES_PASSTHRU) \
193 WHILE_EACH_HOOK(n); \
196 /** Holds a module's Version information.
197 * The members (set by the constructor only) indicate details as to the version number
198 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
200 class CoreExport Version
203 /** Module description
205 const std::string description;
211 /** Server linking description string */
212 const std::string link_data;
214 /** Simple module version */
215 Version(const std::string &desc, int flags = VF_NONE);
217 /** Complex version information, including linking compatibility data */
218 Version(const std::string &desc, int flags, const std::string& linkdata);
221 class CoreExport DataProvider : public ServiceProvider
224 DataProvider(Module* Creator, const std::string& Name)
225 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
228 /** Priority types which can be used by Module::Prioritize()
230 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
232 /** Implementation-specific flags which may be set in Module::Implements()
236 I_OnUserConnect, I_OnUserPreQuit, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
237 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper,
238 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
239 I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode, I_OnShutdown,
240 I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit, I_OnUserPostInit,
241 I_OnChangeHost, I_OnChangeRealName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
242 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
243 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
244 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
245 I_OnPreChangeHost, I_OnPreTopicChange, I_OnConnectionFail,
246 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
247 I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
248 I_OnPostOper, I_OnPostCommand, I_OnCommandBlocked, I_OnPostJoin,
249 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
250 I_OnUserMessage, I_OnPassCompare, I_OnNumeric,
251 I_OnPreRehash, I_OnModuleRehash, I_OnChangeIdent, I_OnSetUserIP,
252 I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
256 /** Base class for all InspIRCd modules
257 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
258 * its methods will be called when irc server events occur. class inherited from module must be
259 * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised.
261 class CoreExport Module : public classbase, public usecountbase
263 /** Detach an event from this module
264 * @param i Event type to detach
266 void DetachEvent(Implementation i);
269 /** A list of modules. */
270 typedef std::vector<Module*> List;
272 /** File that this module was loaded from
274 std::string ModuleSourceFile;
276 /** Reference to the dlopen() value
278 DLLManager* ModuleDLLManager;
280 /** If true, this module will be unloaded soon, further unload attempts will fail
281 * Value is used by the ModuleManager internally, you should not modify it
285 /** Default constructor.
286 * Creates a module class. Don't do any type of hook registration or checks
287 * for other modules here; do that in init().
292 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
294 virtual void init() { }
296 /** Clean up prior to destruction
297 * If you override, you must call this AFTER your module's cleanup
299 CullResult cull() CXX11_OVERRIDE;
301 /** Default destructor.
302 * destroys a module class
306 /** Called when the hooks provided by a module need to be prioritised. */
307 virtual void Prioritize() { }
309 /** This method is called when you should reload module specific configuration:
310 * on boot, on a /REHASH and on module load.
311 * @param status The current status, can be inspected for more information;
312 * also used for reporting configuration errors and warnings.
314 virtual void ReadConfig(ConfigStatus& status);
316 /** Returns the version number of a Module.
317 * The method should return a Version object with its version information assigned via
320 virtual Version GetVersion() = 0;
322 /** Called when a user connects.
323 * The details of the connecting user are available to you in the parameter User *user
324 * @param user The user who is connecting
326 virtual void OnUserConnect(LocalUser* user);
328 /** Called when before a user quits.
329 * The details of the exiting user are available to you in the parameter User *user
330 * This event is only called when the user is fully registered when they quit. To catch
331 * raw disconnections, use the OnUserDisconnect method.
332 * @param user The user who is quitting
333 * @param message The user's quit message (as seen by non-opers)
334 * @param oper_message The user's quit message (as seen by opers)
336 virtual ModResult OnUserPreQuit(LocalUser* user, std::string& message, std::string& oper_message);
338 /** Called when a user quits.
339 * The details of the exiting user are available to you in the parameter User *user
340 * This event is only called when the user is fully registered when they quit. To catch
341 * raw disconnections, use the OnUserDisconnect method.
342 * @param user The user who is quitting
343 * @param message The user's quit message (as seen by non-opers)
344 * @param oper_message The user's quit message (as seen by opers)
346 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
348 /** Called whenever a user's socket is closed.
349 * The details of the exiting user are available to you in the parameter User *user
350 * This event is called for all users, registered or not, as a cleanup method for modules
351 * which might assign resources to user, such as dns lookups, objects and sockets.
352 * @param user The user who is disconnecting
354 virtual void OnUserDisconnect(LocalUser* user);
356 /** Called whenever a channel is about to be deleted
357 * @param chan The channel being deleted
358 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
360 virtual ModResult OnChannelPreDelete(Channel *chan);
362 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
363 * @param chan The channel being deleted
365 virtual void OnChannelDelete(Channel* chan);
367 /** Called when a user joins a channel.
368 * The details of the joining user are available to you in the parameter User *user,
369 * and the details of the channel they have joined is available in the variable Channel *channel
370 * @param memb The channel membership being created
371 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
372 * to a channel due to the network sync.
373 * @param created This is true if the join created the channel
374 * @param except_list A list of users not to send to.
376 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
378 /** Called after a user joins a channel
379 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
381 * @param memb The channel membership created
383 virtual void OnPostJoin(Membership* memb);
385 /** Called when a user parts a channel.
386 * The details of the leaving user are available to you in the parameter User *user,
387 * and the details of the channel they have left is available in the variable Channel *channel
388 * @param memb The channel membership being destroyed
389 * @param partmessage The part message, or an empty string (may be modified)
390 * @param except_list A list of users to not send to.
392 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
394 /** Called on rehash.
395 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
396 * system. This is called in all cases -- including when this server will not execute the
397 * rehash because it is directed at a remote server.
399 * @param user The user performing the rehash, if any. If this is server initiated, the value of
400 * this variable will be NULL.
401 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
404 virtual void OnPreRehash(User* user, const std::string ¶meter);
406 /** Called on rehash.
407 * This method is called when a user initiates a module-specific rehash. This can be used to do
408 * expensive operations (such as reloading TLS (SSL) certificates) that are not executed on a normal
409 * rehash for efficiency. A rehash of this type does not reload the core configuration.
411 * @param user The user performing the rehash.
412 * @param parameter The parameter given to REHASH
414 virtual void OnModuleRehash(User* user, const std::string ¶meter);
416 /** Called whenever a snotice is about to be sent to a snomask.
417 * snomask and type may both be modified; the message may not.
418 * @param snomask The snomask the message is going to (e.g. 'A')
419 * @param type The textual description the snomask will go to (e.g. 'OPER')
420 * @param message The text message to be sent via snotice
421 * @return 1 to block the snotice from being sent entirely, 0 else.
423 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
425 /** Called whenever a user is about to join a channel, before any processing is done.
426 * Returning a value of 1 from this function stops the process immediately, causing no
427 * output to be sent to the user by the core. If you do this you must produce your own numerics,
428 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
429 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
433 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
434 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
435 * processing on the actual channel record at this point, however the channel NAME will still be passed in
436 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
437 * @param user The user joining the channel
438 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
439 * @param cname The channel name being joined. For new channels this is valid where chan is not.
440 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
441 * You may alter this string to alter the user's modes on the channel.
442 * @param keygiven The key given to join the channel, or an empty string if none was provided
443 * @return 1 To prevent the join, 0 to allow it.
445 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
447 /** Called whenever a user is about to be kicked.
448 * Returning a value of 1 from this function stops the process immediately, causing no
449 * output to be sent to the user by the core. If you do this you must produce your own numerics,
451 * @param source The user issuing the kick
452 * @param memb The channel membership of the user who is being kicked.
453 * @param reason The kick reason
454 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
456 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
458 /** Called whenever a user is kicked.
459 * If this method is called, the kick is already underway and cannot be prevented, so
460 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
461 * @param source The user issuing the kick
462 * @param memb The channel membership of the user who was kicked.
463 * @param reason The kick reason
464 * @param except_list A list of users to not send to.
466 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
468 /** Called whenever a user opers locally.
469 * The User will contain the oper mode 'o' as this function is called after any modifications
470 * are made to the user's structure by the core.
471 * @param user The user who is opering up
472 * @param opertype The opers type name
474 virtual void OnOper(User* user, const std::string &opertype);
476 /** Called after a user opers locally.
477 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
478 * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent
479 * out the OPERTYPE, etc.
480 * @param user The user who is opering up
481 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
482 * @param opertype The opers type name
484 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
486 /** Called after a user deopers locally.
487 * @param user The user who has deopered.
489 virtual void OnPostDeoper(User* user);
491 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
492 * Returning 1 from this function stops the process immediately, causing no
493 * output to be sent to the user by the core. If you do this you must produce your own numerics,
494 * notices etc. This is useful for modules which may want to filter invites to channels.
495 * @param source The user who is issuing the INVITE
496 * @param dest The user being invited
497 * @param channel The channel the user is being invited to
498 * @param timeout The time the invite will expire (0 == never)
499 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
501 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
503 /** Called after a user has been successfully invited to a channel.
504 * You cannot prevent the invite from occurring using this function, to do that,
505 * use OnUserPreInvite instead.
506 * @param source The user who is issuing the INVITE
507 * @param dest The user being invited
508 * @param channel The channel the user is being invited to
509 * @param timeout The time the invite will expire (0 == never)
510 * @param notifyrank Rank required to get an invite announcement (if enabled)
511 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
513 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
515 /** Called before a user sends a message to a channel, a user, or a server glob mask.
516 * @param user The user sending the message.
517 * @param target The target of the message. This can either be a channel, a user, or a server
519 * @param details Details about the message such as the message text and type. See the
520 * MessageDetails class for more information.
521 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
522 * message, or MOD_RES_PASSTHRU to let another module handle the event.
524 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
526 /** Called when sending a message to all "neighbors" of a given user -
527 * that is, all users that share a common channel. This is used in
528 * commands such as NICK, QUIT, etc.
529 * @param source The source of the message
530 * @param include_c Channels to scan for users to include
531 * @param exceptions Map of user->bool that overrides the inclusion decision
533 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
535 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
537 /** Called before local nickname changes. This can be used to implement Q-lines etc.
538 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
539 * module to generate some meaninful output.
540 * @param user The username changing their nick
541 * @param newnick Their new nickname
542 * @return 1 to deny the change, 0 to allow
544 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
546 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
547 * @param user The user sending the message.
548 * @param target The target of the message. This can either be a channel, a user, or a server
550 * @param details Details about the message such as the message text and type. See the
551 * MessageDetails class for more information.
553 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
555 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
556 * @param user The user sending the message.
557 * @param target The target of the message. This can either be a channel, a user, or a server
559 * @param details Details about the message such as the message text and type. See the
560 * MessageDetails class for more information.
562 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
564 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
565 * @param user The user sending the message.
566 * @param target The target of the message. This can either be a channel, a user, or a server
568 * @param details Details about the message such as the message text and type. See the
569 * MessageDetails class for more information.
571 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
573 /** Called after every MODE command sent from a user
574 * Either the usertarget or the chantarget variable contains the target of the modes,
575 * the actual target will have a non-NULL pointer.
576 * All changed modes are available in the changelist object.
577 * @param user The user sending the MODEs
578 * @param usertarget The target user of the modes, NULL if the target is a channel
579 * @param chantarget The target channel of the modes, NULL if the target is a user
580 * @param changelist The changed modes.
581 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
582 * for the possible flags.
584 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
586 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
587 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
588 * @param target The Channel* or User* that data should be added to
589 * @param extname The extension name which is being sent
590 * @param extdata The extension data, encoded at the other end by an identical module
592 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
594 /** Called whenever a user's hostname is changed.
595 * This event triggers after the host has been set.
596 * @param user The user whos host is being changed
597 * @param newhost The new hostname being set
599 virtual void OnChangeHost(User* user, const std::string &newhost);
601 /** Called whenever a user's real name is changed.
602 * This event triggers after the name has been set.
603 * @param user The user who's real name is being changed
604 * @param real The new real name being set on the user
606 virtual void OnChangeRealName(User* user, const std::string& real);
608 /** Called whenever a user's IDENT is changed.
609 * This event triggers after the name has been set.
610 * @param user The user who's IDENT is being changed
611 * @param ident The new IDENT being set on the user
613 virtual void OnChangeIdent(User* user, const std::string &ident);
615 /** Called whenever an xline is added by a local user.
616 * This method is triggered after the line is added.
617 * @param source The sender of the line or NULL for local server
618 * @param line The xline being added
620 virtual void OnAddLine(User* source, XLine* line);
622 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
623 * This method is triggered after the line is deleted.
624 * @param source The user removing the line or NULL for local server
625 * @param line the line being deleted
627 virtual void OnDelLine(User* source, XLine* line);
629 /** Called whenever an xline expires.
630 * This method is triggered after the line is deleted.
631 * @param line The line being deleted.
633 virtual void OnExpireLine(XLine *line);
635 /** Called before the module is unloaded to clean up extensibles.
636 * This method is called once for every channel, membership, and user.
637 * so that you can clear up any data relating to the specified extensible.
638 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
639 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
640 * and EXT_USER then item is a User*.
641 * @param item A pointer to the extensible which is being cleaned up.
643 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
645 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
646 * have been applied. Please note that although you can see remote nickchanges through this function, you should
647 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
648 * check user->server before taking any action (including returning nonzero from the method).
649 * Because this method is called after the nickchange is taken place, no return values are possible
650 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
651 * @param user The user changing their nick
652 * @param oldnick The old nickname of the user before the nickchange
654 virtual void OnUserPostNick(User* user, const std::string &oldnick);
656 /** Called before a mode change via the MODE command, to allow a single access check for
657 * a full mode change (use OnRawMode to check individual modes)
659 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
660 * OnRawMode for each individual mode
662 * @param source the user making the mode change
663 * @param dest the user destination of the umode change (NULL if a channel mode)
664 * @param channel the channel destination of the mode change
665 * @param modes Modes being changed, can be edited
667 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
669 /** Called when a 005 numeric is about to be output.
670 * The module should modify the 005 numeric if needed to indicate its features.
671 * @param tokens The 005 map to be modified if necessary.
673 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
675 /** Called when a client is disconnected by KILL.
676 * If a client is killed by a server, e.g. a nickname collision or protocol error,
678 * Return 1 from this function to prevent the kill, and 0 from this function to allow
679 * it as normal. If you prevent the kill no output will be sent to the client, it is
680 * down to your module to generate this information.
681 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
682 * If you do so youre risking race conditions, desyncs and worse!
683 * @param source The user sending the KILL
684 * @param dest The user being killed
685 * @param reason The kill reason
686 * @return 1 to prevent the kill, 0 to allow
688 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
690 /** Called whenever a module is loaded.
691 * mod will contain a pointer to the module, and string will contain its name,
692 * for example m_widgets.so. This function is primary for dependency checking,
693 * your module may decide to enable some extra features if it sees that you have
694 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
695 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
696 * but instead operate under reduced functionality, unless the dependency is
697 * absolutely necessary (e.g. a module that extends the features of another
699 * @param mod A pointer to the new module
701 virtual void OnLoadModule(Module* mod);
703 /** Called whenever a module is unloaded.
704 * mod will contain a pointer to the module, and string will contain its name,
705 * for example m_widgets.so. This function is primary for dependency checking,
706 * your module may decide to enable some extra features if it sees that you have
707 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
708 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
709 * but instead operate under reduced functionality, unless the dependency is
710 * absolutely necessary (e.g. a module that extends the features of another
712 * @param mod Pointer to the module being unloaded (still valid)
714 virtual void OnUnloadModule(Module* mod);
716 /** Called once every five seconds for background processing.
717 * This timer can be used to control timed features. Its period is not accurate
718 * enough to be used as a clock, but it is guaranteed to be called at least once in
719 * any five second period, directly from the main loop of the server.
720 * @param curtime The current timer derived from time(2)
722 virtual void OnBackgroundTimer(time_t curtime);
724 /** Called whenever any command is about to be executed.
725 * This event occurs for all registered commands, whether they are registered in the core,
726 * or another module, and for invalid commands. Invalid commands may only be sent to this
727 * function when the value of validated is false. By returning 1 from this method you may prevent the
728 * command being executed. If you do this, no output is created by the core, and it is
729 * down to your module to produce any output necessary.
730 * Note that unless you return 1, you should not destroy any structures (e.g. by using
731 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
732 * method returns, it will be passed an invalid pointer to the user object and crash!)
733 * @param command The command being executed
734 * @param parameters An array of array of characters containing the parameters for the command
735 * @param user the user issuing the command
736 * @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.
737 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
738 * @return 1 to block the command, 0 to allow
740 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
742 /** Called after any command has been executed.
743 * This event occurs for all registered commands, whether they are registered in the core,
744 * or another module, but it will not occur for invalid commands (e.g. ones which do not
745 * exist within the command table). The result code returned by the command handler is
747 * @param command The command being executed
748 * @param parameters An array of array of characters containing the parameters for the command
749 * @param user the user issuing the command
750 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
751 * @param loop Whether the command is being called from LoopCall or directly.
753 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
755 /** Called when a command was blocked before it could be executed.
756 * @param command The command being executed.
757 * @param parameters The parameters for the command.
758 * @param user The user issuing the command.
760 virtual void OnCommandBlocked(const std::string& command, const CommandBase::Params& parameters, LocalUser* user);
762 /** Called after a user object is initialised and added to the user list.
763 * When this is called the user has not had their I/O hooks checked or had their initial
764 * connect class assigned and may not yet have a serialiser. You probably want to use
765 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
766 * @param user The connecting user.
768 virtual void OnUserInit(LocalUser* user);
770 /** Called after a user object has had their I/O hooks checked, their initial connection
771 * class assigned, and had a serialiser set.
772 * @param user The connecting user.
774 virtual void OnUserPostInit(LocalUser* user);
776 /** Called to check if a user who is connecting can now be allowed to register
777 * If any modules return false for this function, the user is held in the waiting
778 * state until all modules return true. For example a module which implements ident
779 * lookups will continue to return false for a user until their ident lookup is completed.
780 * Note that the registration timeout for a user overrides these checks, if the registration
781 * timeout is reached, the user is disconnected even if modules report that the user is
782 * not ready to connect.
783 * @param user The user to check
784 * @return true to indicate readiness, false if otherwise
786 virtual ModResult OnCheckReady(LocalUser* user);
788 /** Called whenever a user is about to register their connection (e.g. before the user
789 * is sent the MOTD etc). Modules can use this method if they are performing a function
790 * which must be done before the actual connection is completed (e.g. ident lookups,
791 * dnsbl lookups, etc).
792 * Note that you should NOT delete the user record here by causing a disconnection!
793 * Use OnUserConnect for that instead.
794 * @param user The user registering
795 * @return 1 to indicate user quit, 0 to continue
797 virtual ModResult OnUserRegister(LocalUser* user);
799 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
800 * This method will always be called for each join, whether or not the channel is actually +i, and
801 * determines the outcome of an if statement around the whole section of invite checking code.
802 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
803 * @param user The user joining the channel
804 * @param chan The channel being joined
805 * @return 1 to explicitly allow the join, 0 to proceed as normal
807 virtual ModResult OnCheckInvite(User* user, Channel* chan);
809 /** Called whenever a mode character is processed.
810 * Return 1 from this function to block the mode character from being processed entirely.
811 * @param user The user who is sending the mode
812 * @param chan The channel the mode is being sent to (or NULL if a usermode)
813 * @param mh The mode handler for the mode being changed
814 * @param param The parameter for the mode or an empty string
815 * @param adding true of the mode is being added, false if it is being removed
816 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
817 * to skip all permission checking. Please note that for remote mode changes, your return value
820 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
822 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
823 * This method will always be called for each join, whether or not the channel is actually +k, and
824 * determines the outcome of an if statement around the whole section of key checking code.
825 * if the user specified no key, the keygiven string will be a valid but empty value.
826 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
827 * @param user The user joining the channel
828 * @param chan The channel being joined
829 * @param keygiven The key given on joining the channel.
830 * @return 1 to explicitly allow the join, 0 to proceed as normal
832 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
834 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
835 * This method will always be called for each join, whether or not the channel is actually +l, and
836 * determines the outcome of an if statement around the whole section of channel limit checking code.
837 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
838 * @param user The user joining the channel
839 * @param chan The channel being joined
840 * @return 1 to explicitly allow the join, 0 to proceed as normal
842 virtual ModResult OnCheckLimit(User* user, Channel* chan);
845 * Checks for a user's ban from the channel
846 * @param user The user to check
847 * @param chan The channel to check in
848 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
849 * ban check, or MOD_RES_PASSTHRU to check bans normally
851 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
854 * Checks for a user's match of a single ban
855 * @param user The user to check for match
856 * @param chan The channel on which the match is being checked
857 * @param mask The mask being checked
858 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
859 * ban check, or MOD_RES_PASSTHRU to check bans normally
861 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
863 /** Checks for a match on a given extban type
864 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
865 * ban check, or MOD_RES_PASSTHRU to check bans normally
867 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
869 /** Called whenever a change of a local users displayed host is attempted.
870 * Return 1 to deny the host change, or 0 to allow it.
871 * @param user The user whos host will be changed
872 * @param newhost The new hostname
873 * @return 1 to deny the host change, 0 to allow
875 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
877 /** Called whenever a change of a local users real name is attempted.
878 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
879 * @param user The user whos real name will be changed
880 * @param newhost The new real name.
881 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
883 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
885 /** Called before a topic is changed.
886 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
887 * As with other 'pre' events, you should only ever block a local event.
888 * @param user The user changing the topic
889 * @param chan The channels who's topic is being changed
890 * @param topic The actual topic text
891 * @return 1 to block the topic change, 0 to allow
893 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
895 /** Called whenever a topic has been changed.
896 * To block topic changes you must use OnPreTopicChange instead.
897 * @param user The user changing the topic
898 * @param chan The channels who's topic is being changed
899 * @param topic The actual topic text
901 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
903 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
904 * The password field (from the config file) is in 'password' and is to be compared against
905 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
906 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
907 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
908 * @param password The password from the configuration file (the password="" value).
909 * @param input The password entered by the user or whoever.
910 * @param hashtype The hash value from the config
911 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
913 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
915 /** Called after a user has fully connected and all modules have executed OnUserConnect
916 * This event is informational only. You should not change any user information in this
917 * event. To do so, use the OnUserConnect method to change the state of local users.
918 * This is called for both local and remote users.
919 * @param user The user who is connecting
921 virtual void OnPostConnect(User* user);
923 /** Called when a port accepts a connection
924 * Return MOD_RES_ACCEPT if you have used the file descriptor.
925 * @param fd The file descriptor returned from accept()
926 * @param sock The socket connection for the new user
927 * @param client The client IP address and port
928 * @param server The server IP address and port
930 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
932 /** Called at intervals for modules to garbage-collect any hashes etc.
933 * Certain data types such as hash_map 'leak' buckets, which must be
934 * tidied up and freed by copying into a new item every so often. This
935 * method is called when it is time to do that.
937 virtual void OnGarbageCollect();
939 /** Called when a user's connect class is being matched
940 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
941 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
943 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
945 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
947 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
948 * a module like m_cgiirc changing it.
949 * @param user The user whose IP is being set
951 virtual void OnSetUserIP(LocalUser* user);
953 /** Called whenever a ServiceProvider is registered.
954 * @param service ServiceProvider being registered.
956 virtual void OnServiceAdd(ServiceProvider& service);
958 /** Called whenever a ServiceProvider is unregistered.
959 * @param service ServiceProvider being unregistered.
961 virtual void OnServiceDel(ServiceProvider& service);
963 /** Called whenever a message is about to be written to a user.
964 * @param user The user who is having a message sent to them.
965 * @param msg The message which is being written to the user.
966 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
967 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
969 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
971 /** Called when a user connection has been unexpectedly disconnected.
972 * @param user The user who has been unexpectedly disconnected.
973 * @param error The type of error which caused this connection failure.
974 * @return MOD_RES_ALLOW to explicitly retain the user as a zombie, MOD_RES_DENY to explicitly
975 * disconnect the user, or MOD_RES_PASSTHRU to let another module handle the event.
977 virtual ModResult OnConnectionFail(LocalUser* user, BufferedSocketError error);
979 /** Called before a server shuts down.
980 * @param reason The reason the server is shutting down.
982 virtual void OnShutdown(const std::string& reason);
985 /** ModuleManager takes care of all things module-related
988 class CoreExport ModuleManager : public fakederef<ModuleManager>
991 typedef std::vector<ServiceProvider*> ServiceList;
994 /** Holds a string describing the last module error to occur
996 std::string LastModuleError;
998 /** List of loaded modules and shared object/dll handles
999 * keyed by module name
1001 std::map<std::string, Module*> Modules;
1007 } prioritizationState;
1009 /** Loads all core modules (core_*)
1011 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1013 /** Calls the Prioritize() method in all loaded modules
1014 * @return True if all went well, false if a dependency loop was detected
1016 bool PrioritizeHooks();
1018 /** Unregister all user modes or all channel modes owned by a module
1019 * @param mod Module whose modes to unregister
1020 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1022 void UnregisterModes(Module* mod, ModeType modetype);
1025 typedef std::map<std::string, Module*> ModuleMap;
1027 /** Event handler hooks.
1028 * This needs to be public to be used by FOREACH_MOD and friends.
1030 Module::List EventHandlers[I_END];
1032 /** List of data services keyed by name */
1033 std::multimap<std::string, ServiceProvider*, irc::insensitive_swo> DataProviders;
1035 /** A list of ServiceProviders waiting to be registered.
1036 * Non-NULL when constructing a Module, NULL otherwise.
1037 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1038 * automatically registers them (that is, call AddService()) after the Module is constructed,
1039 * and before Module::init() is called.
1040 * If a service is created after the construction of the Module (for example in init()) it
1041 * has to be registered manually.
1043 ServiceList* NewServices;
1045 /** Expands the name of a module by prepending "m_" and appending ".so".
1046 * No-op if the name already has the ".so" extension.
1047 * @param modname Module name to expand
1048 * @return Module name starting with "m_" and ending with ".so"
1050 static std::string ExpandModName(const std::string& modname);
1052 /** Simple, bog-standard, boring constructor.
1060 /** Change the priority of one event in a module.
1061 * Each module event has a list of modules which are attached to that event type.
1062 * If you wish to be called before or after other specific modules, you may use this
1063 * method (usually within void Module::Prioritize()) to set your events priority.
1064 * You may use this call in other methods too, however, this is not supported behaviour
1066 * @param mod The module to change the priority of
1067 * @param i The event to change the priority of
1068 * @param s The state you wish to use for this event. Use one of
1069 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1070 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1071 * to set it to be before or after one or more other modules.
1072 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1073 * then this contains a the module that your module must be placed before
1076 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1078 /** Change the priority of all events in a module.
1079 * @param mod The module to set the priority of
1080 * @param s The priority of all events in the module.
1081 * Note that with this method, it is not possible to effectively use
1082 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1083 * SetPriority method for this, where you may specify other modules to
1084 * be prioritized against.
1086 void SetPriority(Module* mod, Priority s);
1088 /** Attach an event to a module.
1089 * You may later detach the event with ModuleManager::Detach().
1090 * If your module is unloaded, all events are automatically detached.
1091 * @param i Event type to attach
1092 * @param mod Module to attach event to
1093 * @return True if the event was attached
1095 bool Attach(Implementation i, Module* mod);
1097 /** Detach an event from a module.
1098 * This is not required when your module unloads, as the core will
1099 * automatically detach your module from all events it is attached to.
1100 * @param i Event type to detach
1101 * @param mod Module to detach event from
1102 * @return True if the event was detached
1104 bool Detach(Implementation i, Module* mod);
1106 /** Attach an array of events to a module
1107 * @param i Event types (array) to attach
1108 * @param mod Module to attach events to
1109 * @param sz The size of the implementation array
1111 void Attach(Implementation* i, Module* mod, size_t sz);
1113 /** Detach all events from a module (used on unload)
1114 * @param mod Module to detach from
1116 void DetachAll(Module* mod);
1118 /** Attach all events to a module (used on module load)
1119 * @param mod Module to attach to all events
1121 void AttachAll(Module* mod);
1123 /** Returns text describing the last module error
1124 * @return The last error message to occur
1126 std::string& LastError();
1128 /** Load a given module file
1129 * @param filename The file to load
1130 * @param defer Defer module init (loading many modules)
1131 * @return True if the module was found and loaded
1133 bool Load(const std::string& filename, bool defer = false);
1135 /** Unload a given module file. Note that the module will not be
1136 * completely gone until the cull list has finished processing.
1138 * @return true on success; if false, LastError will give a reason
1140 bool Unload(Module* module);
1142 /** Called by the InspIRCd constructor to load all modules from the config file.
1146 void DoSafeUnload(Module*);
1148 /** Check if a module can be unloaded and if yes, prepare it for unload
1149 * @param mod Module to be unloaded
1150 * @return True if the module is unloadable, false otherwise.
1151 * If true the module must be unloaded in the current main loop iteration.
1153 bool CanUnload(Module* mod);
1155 /** Find a module by name, and return a Module* to it.
1156 * This is preferred over iterating the module lists yourself.
1157 * @param name The module name to look up
1158 * @return A pointer to the module, or NULL if the module cannot be found
1160 Module* Find(const std::string &name);
1162 /** Register a service provided by a module */
1163 void AddService(ServiceProvider&);
1165 /** Unregister a service provided by a module */
1166 void DelService(ServiceProvider&);
1168 /** Register all services in a given ServiceList
1169 * @param list The list containing the services to register
1171 void AddServices(const ServiceList& list);
1173 inline void AddServices(ServiceProvider** list, int count)
1175 for(int i=0; i < count; i++)
1176 AddService(*list[i]);
1179 /** Find a service by name.
1180 * If multiple modules provide a given service, the first one loaded will be chosen.
1182 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1184 template<typename T> inline T* FindDataService(const std::string& name)
1186 return static_cast<T*>(FindService(SERVICE_DATA, name));
1189 /** Get a map of all loaded modules keyed by their name
1190 * @return A ModuleMap containing all loaded modules
1192 const ModuleMap& GetModules() const { return Modules; }
1194 /** Make a service referenceable by dynamic_references
1195 * @param name Name that will be used by dynamic_references to find the object
1196 * @param service Service to make referenceable by dynamic_references
1198 void AddReferent(const std::string& name, ServiceProvider* service);
1200 /** Make a service no longer referenceable by dynamic_references
1201 * @param service Service to make no longer referenceable by dynamic_references
1203 void DelReferent(ServiceProvider* service);