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 Oliver Lupton <om@inspircd.org>
15 * Copyright (C) 2006-2007 Dennis Friis <peavey@inspircd.org>
16 * Copyright (C) 2006 John Brooks <special@inspircd.org>
17 * Copyright (C) 2003-2008, 2010 Craig Edwards <brain@inspircd.org>
19 * This file is part of InspIRCd. InspIRCd is free software: you can
20 * redistribute it and/or modify it under the terms of the GNU General Public
21 * License as published by the Free Software Foundation, version 2.
23 * This program is distributed in the hope that it will be useful, but WITHOUT
24 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
25 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 #include "moduledefs.h"
39 #include "inspsocket.h"
43 /** Used to specify the behaviour of a module. */
46 /** The module has no special attributes. */
49 /** The module is a coremod and can be assumed to be loaded on all servers. */
52 /* The module is included with InspIRCd. */
55 /** The module MUST be loaded on all servers on a network to link. */
58 /** The module SHOULD be loaded on all servers on a network for consistency. */
62 /** The event was explicitly allowed. */
63 #define MOD_RES_ALLOW (ModResult(1))
65 /** The event was not explicitly allowed or denied. */
66 #define MOD_RES_PASSTHRU (ModResult(0))
68 /** The event was explicitly denied. */
69 #define MOD_RES_DENY (ModResult(-1))
71 /** Represents the result of a module event. */
75 /** The underlying result value. */
79 /** Creates a new instance of the ModResult class which defaults to MOD_RES_PASSTHRU. */
85 /** Creates a new instance of the ModResult class with the specified value. */
86 explicit ModResult(char res)
91 /** Determines whether this ModResult has.the same value as \p res */
92 inline bool operator==(const ModResult& res) const
94 return result == res.result;
97 /** Determines whether this ModResult has.a different value to \p res */
98 inline bool operator!=(const ModResult& res) const
100 return result != res.result;
103 /** Determines whether a non-MOD_RES_PASSTHRU result has been set. */
104 inline bool operator!() const
109 /** Checks whether the result is an MOD_RES_ALLOW or MOD_RES_PASSTHRU when the default is to allow. */
110 inline bool check(bool def) const
112 return (result == 1 || (result == 0 && def));
115 /* Merges two results preferring MOD_RES_ALLOW to MOD_RES_DENY. */
116 inline ModResult operator+(const ModResult& res) const
118 // If the results are identical or the other result is MOD_RES_PASSTHRU
119 // then return this result.
120 if (result == res.result || res.result == 0)
123 // If this result is MOD_RES_PASSTHRU then return the other result.
127 // Otherwise, they are different, and neither is MOD_RES_PASSTHRU.
128 return MOD_RES_ALLOW;
133 * This #define allows us to call a method in all
134 * loaded modules in a readable simple way, e.g.:
135 * 'FOREACH_MOD(OnConnect,(user));'
137 #define FOREACH_MOD(y,x) do { \
138 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
139 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
147 catch (CoreException& modexcept) \
149 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
155 * Custom module result handling loop. This is a paired macro, and should only
156 * be used with while_each_hook.
158 * See src/channels.cpp for an example of use.
160 #define DO_EACH_HOOK(n,v,args) \
162 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
163 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
171 #define WHILE_EACH_HOOK(n) \
173 catch (CoreException& except_ ## n) \
175 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
181 * Module result iterator
182 * Runs the given hook until some module returns a useful result.
184 * Example: ModResult result;
185 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
187 #define FIRST_MOD_RESULT(n,v,args) do { \
188 v = MOD_RES_PASSTHRU; \
189 DO_EACH_HOOK(n,v,args) \
191 if (v != MOD_RES_PASSTHRU) \
194 WHILE_EACH_HOOK(n); \
197 /** Holds a module's Version information.
198 * The members (set by the constructor only) indicate details as to the version number
199 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
201 class CoreExport Version
204 /** Module description
206 const std::string description;
212 /** Server linking description string */
213 const std::string link_data;
215 /** Simple module version */
216 Version(const std::string &desc, int flags = VF_NONE);
218 /** Complex version information, including linking compatibility data */
219 Version(const std::string &desc, int flags, const std::string& linkdata);
222 class CoreExport DataProvider : public ServiceProvider
225 DataProvider(Module* Creator, const std::string& Name)
226 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
229 /** Priority types which can be used by Module::Prioritize()
231 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
233 /** Implementation-specific flags which may be set in Module::Implements()
238 I_OnAcceptConnection,
241 I_OnBuildNeighborList,
247 I_OnChannelPreDelete,
275 I_OnPreChangeRealName,
295 I_OnUserMessageBlocked,
312 /** Base class for all InspIRCd modules
313 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
314 * its methods will be called when irc server events occur. class inherited from module must be
315 * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised.
317 class CoreExport Module : public classbase, public usecountbase
319 /** Detach an event from this module
320 * @param i Event type to detach
322 void DetachEvent(Implementation i);
325 /** A list of modules. */
326 typedef std::vector<Module*> List;
328 /** File that this module was loaded from
330 std::string ModuleSourceFile;
332 /** Reference to the dlopen() value
334 DLLManager* ModuleDLLManager;
336 /** If true, this module will be unloaded soon, further unload attempts will fail
337 * Value is used by the ModuleManager internally, you should not modify it
341 /** Default constructor.
342 * Creates a module class. Don't do any type of hook registration or checks
343 * for other modules here; do that in init().
348 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
350 virtual void init() { }
352 /** Clean up prior to destruction
353 * If you override, you must call this AFTER your module's cleanup
355 CullResult cull() CXX11_OVERRIDE;
357 /** Default destructor.
358 * destroys a module class
362 /** Called when the hooks provided by a module need to be prioritised. */
363 virtual void Prioritize() { }
365 /** This method is called when you should reload module specific configuration:
366 * on boot, on a /REHASH and on module load.
367 * @param status The current status, can be inspected for more information;
368 * also used for reporting configuration errors and warnings.
370 virtual void ReadConfig(ConfigStatus& status);
372 /** Returns the version number of a Module.
373 * The method should return a Version object with its version information assigned via
376 virtual Version GetVersion() = 0;
378 /** Called when a user connects.
379 * The details of the connecting user are available to you in the parameter User *user
380 * @param user The user who is connecting
382 virtual void OnUserConnect(LocalUser* user);
384 /** Called when before a user quits.
385 * The details of the exiting user are available to you in the parameter User *user
386 * This event is only called when the user is fully registered when they quit. To catch
387 * raw disconnections, use the OnUserDisconnect method.
388 * @param user The user who is quitting
389 * @param message The user's quit message (as seen by non-opers)
390 * @param oper_message The user's quit message (as seen by opers)
392 virtual ModResult OnUserPreQuit(LocalUser* user, std::string& message, std::string& oper_message);
394 /** Called when a user quits.
395 * The details of the exiting user are available to you in the parameter User *user
396 * This event is only called when the user is fully registered when they quit. To catch
397 * raw disconnections, use the OnUserDisconnect method.
398 * @param user The user who is quitting
399 * @param message The user's quit message (as seen by non-opers)
400 * @param oper_message The user's quit message (as seen by opers)
402 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
404 /** Called whenever a user's socket is closed.
405 * The details of the exiting user are available to you in the parameter User *user
406 * This event is called for all users, registered or not, as a cleanup method for modules
407 * which might assign resources to user, such as dns lookups, objects and sockets.
408 * @param user The user who is disconnecting
410 virtual void OnUserDisconnect(LocalUser* user);
412 /** Called whenever a channel is about to be deleted
413 * @param chan The channel being deleted
414 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
416 virtual ModResult OnChannelPreDelete(Channel *chan);
418 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
419 * @param chan The channel being deleted
421 virtual void OnChannelDelete(Channel* chan);
423 /** Called when a user joins a channel.
424 * The details of the joining user are available to you in the parameter User *user,
425 * and the details of the channel they have joined is available in the variable Channel *channel
426 * @param memb The channel membership being created
427 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
428 * to a channel due to the network sync.
429 * @param created This is true if the join created the channel
430 * @param except_list A list of users not to send to.
432 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
434 /** Called after a user joins a channel
435 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
437 * @param memb The channel membership created
439 virtual void OnPostJoin(Membership* memb);
441 /** Called when a user parts a channel.
442 * The details of the leaving user are available to you in the parameter User *user,
443 * and the details of the channel they have left is available in the variable Channel *channel
444 * @param memb The channel membership being destroyed
445 * @param partmessage The part message, or an empty string (may be modified)
446 * @param except_list A list of users to not send to.
448 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
450 /** Called on rehash.
451 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
452 * system. This is called in all cases -- including when this server will not execute the
453 * rehash because it is directed at a remote server.
455 * @param user The user performing the rehash, if any. If this is server initiated, the value of
456 * this variable will be NULL.
457 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
460 virtual void OnPreRehash(User* user, const std::string ¶meter);
462 /** Called on rehash.
463 * This method is called when a user initiates a module-specific rehash. This can be used to do
464 * expensive operations (such as reloading TLS (SSL) certificates) that are not executed on a normal
465 * rehash for efficiency. A rehash of this type does not reload the core configuration.
467 * @param user The user performing the rehash.
468 * @param parameter The parameter given to REHASH
470 virtual void OnModuleRehash(User* user, const std::string ¶meter);
472 /** Called whenever a snotice is about to be sent to a snomask.
473 * snomask and type may both be modified; the message may not.
474 * @param snomask The snomask the message is going to (e.g. 'A')
475 * @param type The textual description the snomask will go to (e.g. 'OPER')
476 * @param message The text message to be sent via snotice
477 * @return 1 to block the snotice from being sent entirely, 0 else.
479 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
481 /** Called whenever a user is about to join a channel, before any processing is done.
482 * Returning a value of 1 from this function stops the process immediately, causing no
483 * output to be sent to the user by the core. If you do this you must produce your own numerics,
484 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
485 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
489 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
490 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
491 * processing on the actual channel record at this point, however the channel NAME will still be passed in
492 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
493 * @param user The user joining the channel
494 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
495 * @param cname The channel name being joined. For new channels this is valid where chan is not.
496 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
497 * You may alter this string to alter the user's modes on the channel.
498 * @param keygiven The key given to join the channel, or an empty string if none was provided
499 * @return 1 To prevent the join, 0 to allow it.
501 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
503 /** Called whenever a user is about to be kicked.
504 * Returning a value of 1 from this function stops the process immediately, causing no
505 * output to be sent to the user by the core. If you do this you must produce your own numerics,
507 * @param source The user issuing the kick
508 * @param memb The channel membership of the user who is being kicked.
509 * @param reason The kick reason
510 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
512 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
514 /** Called whenever a user is kicked.
515 * If this method is called, the kick is already underway and cannot be prevented, so
516 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
517 * @param source The user issuing the kick
518 * @param memb The channel membership of the user who was kicked.
519 * @param reason The kick reason
520 * @param except_list A list of users to not send to.
522 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
524 /** Called whenever a user opers locally.
525 * The User will contain the oper mode 'o' as this function is called after any modifications
526 * are made to the user's structure by the core.
527 * @param user The user who is opering up
528 * @param opertype The opers type name
530 virtual void OnOper(User* user, const std::string &opertype);
532 /** Called after a user opers locally.
533 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
534 * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent
535 * out the OPERTYPE, etc.
536 * @param user The user who is opering up
537 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
538 * @param opertype The opers type name
540 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
542 /** Called after a user deopers locally.
543 * @param user The user who has deopered.
545 virtual void OnPostDeoper(User* user);
547 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
548 * Returning 1 from this function stops the process immediately, causing no
549 * output to be sent to the user by the core. If you do this you must produce your own numerics,
550 * notices etc. This is useful for modules which may want to filter invites to channels.
551 * @param source The user who is issuing the INVITE
552 * @param dest The user being invited
553 * @param channel The channel the user is being invited to
554 * @param timeout The time the invite will expire (0 == never)
555 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
557 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
559 /** Called after a user has been successfully invited to a channel.
560 * You cannot prevent the invite from occurring using this function, to do that,
561 * use OnUserPreInvite instead.
562 * @param source The user who is issuing the INVITE
563 * @param dest The user being invited
564 * @param channel The channel the user is being invited to
565 * @param timeout The time the invite will expire (0 == never)
566 * @param notifyrank Rank required to get an invite announcement (if enabled)
567 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
569 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
571 /** Called before a user sends a message to a channel, a user, or a server glob mask.
572 * @param user The user sending the message.
573 * @param target The target of the message. This can either be a channel, a user, or a server
575 * @param details Details about the message such as the message text and type. See the
576 * MessageDetails class for more information.
577 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
578 * message, or MOD_RES_PASSTHRU to let another module handle the event.
580 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
582 /** Called when sending a message to all "neighbors" of a given user -
583 * that is, all users that share a common channel. This is used in
584 * commands such as NICK, QUIT, etc.
585 * @param source The source of the message
586 * @param include_c Channels to scan for users to include
587 * @param exceptions Map of user->bool that overrides the inclusion decision
589 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
591 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
593 /** Called before local nickname changes. This can be used to implement Q-lines etc.
594 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
595 * module to generate some meaninful output.
596 * @param user The username changing their nick
597 * @param newnick Their new nickname
598 * @return 1 to deny the change, 0 to allow
600 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
602 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
603 * @param user The user sending the message.
604 * @param target The target of the message. This can either be a channel, a user, or a server
606 * @param details Details about the message such as the message text and type. See the
607 * MessageDetails class for more information.
609 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
611 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
612 * @param user The user sending the message.
613 * @param target The target of the message. This can either be a channel, a user, or a server
615 * @param details Details about the message such as the message text and type. See the
616 * MessageDetails class for more information.
618 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
620 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
621 * @param user The user sending the message.
622 * @param target The target of the message. This can either be a channel, a user, or a server
624 * @param details Details about the message such as the message text and type. See the
625 * MessageDetails class for more information.
627 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
629 /** Called after every MODE command sent from a user
630 * Either the usertarget or the chantarget variable contains the target of the modes,
631 * the actual target will have a non-NULL pointer.
632 * All changed modes are available in the changelist object.
633 * @param user The user sending the MODEs
634 * @param usertarget The target user of the modes, NULL if the target is a channel
635 * @param chantarget The target channel of the modes, NULL if the target is a user
636 * @param changelist The changed modes.
637 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
638 * for the possible flags.
640 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
642 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
643 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
644 * @param target The Channel* or User* that data should be added to
645 * @param extname The extension name which is being sent
646 * @param extdata The extension data, encoded at the other end by an identical module
648 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
650 /** Called whenever a user's hostname is changed.
651 * This event triggers after the host has been set.
652 * @param user The user whos host is being changed
653 * @param newhost The new hostname being set
655 virtual void OnChangeHost(User* user, const std::string &newhost);
657 /** Called whenever a user's real hostname is changed.
658 * This event triggers after the host has been set.
659 * @param user The user whos host is being changed
660 * @param newhost The new hostname being set
662 virtual void OnChangeRealHost(User* user, const std::string& newhost);
664 /** Called whenever a user's real name is changed.
665 * This event triggers after the name has been set.
666 * @param user The user who's real name is being changed
667 * @param real The new real name being set on the user
669 virtual void OnChangeRealName(User* user, const std::string& real);
671 /** Called whenever a user's IDENT is changed.
672 * This event triggers after the name has been set.
673 * @param user The user who's IDENT is being changed
674 * @param ident The new IDENT being set on the user
676 virtual void OnChangeIdent(User* user, const std::string &ident);
678 /** Called whenever an xline is added by a local user.
679 * This method is triggered after the line is added.
680 * @param source The sender of the line or NULL for local server
681 * @param line The xline being added
683 virtual void OnAddLine(User* source, XLine* line);
685 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
686 * This method is triggered after the line is deleted.
687 * @param source The user removing the line or NULL for local server
688 * @param line the line being deleted
690 virtual void OnDelLine(User* source, XLine* line);
692 /** Called whenever an xline expires.
693 * This method is triggered after the line is deleted.
694 * @param line The line being deleted.
696 virtual void OnExpireLine(XLine *line);
698 /** Called before the module is unloaded to clean up extensibles.
699 * This method is called once for every channel, membership, and user.
700 * so that you can clear up any data relating to the specified extensible.
701 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
702 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
703 * and EXT_USER then item is a User*.
704 * @param item A pointer to the extensible which is being cleaned up.
706 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
708 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
709 * have been applied. Please note that although you can see remote nickchanges through this function, you should
710 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
711 * check user->server before taking any action (including returning nonzero from the method).
712 * Because this method is called after the nickchange is taken place, no return values are possible
713 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
714 * @param user The user changing their nick
715 * @param oldnick The old nickname of the user before the nickchange
717 virtual void OnUserPostNick(User* user, const std::string &oldnick);
719 /** Called before a mode change via the MODE command, to allow a single access check for
720 * a full mode change (use OnRawMode to check individual modes)
722 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
723 * OnRawMode for each individual mode
725 * @param source the user making the mode change
726 * @param dest the user destination of the umode change (NULL if a channel mode)
727 * @param channel the channel destination of the mode change
728 * @param modes Modes being changed, can be edited
730 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
732 /** Called when a 005 numeric is about to be output.
733 * The module should modify the 005 numeric if needed to indicate its features.
734 * @param tokens The 005 map to be modified if necessary.
736 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
738 /** Called when a client is disconnected by KILL.
739 * If a client is killed by a server, e.g. a nickname collision or protocol error,
741 * Return 1 from this function to prevent the kill, and 0 from this function to allow
742 * it as normal. If you prevent the kill no output will be sent to the client, it is
743 * down to your module to generate this information.
744 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
745 * If you do so youre risking race conditions, desyncs and worse!
746 * @param source The user sending the KILL
747 * @param dest The user being killed
748 * @param reason The kill reason
749 * @return 1 to prevent the kill, 0 to allow
751 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
753 /** Called whenever a module is loaded.
754 * mod will contain a pointer to the module, and string will contain its name,
755 * for example m_widgets.so. This function is primary for dependency checking,
756 * your module may decide to enable some extra features if it sees that you have
757 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
758 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
759 * but instead operate under reduced functionality, unless the dependency is
760 * absolutely necessary (e.g. a module that extends the features of another
762 * @param mod A pointer to the new module
764 virtual void OnLoadModule(Module* mod);
766 /** Called whenever a module is unloaded.
767 * mod will contain a pointer to the module, and string will contain its name,
768 * for example m_widgets.so. This function is primary for dependency checking,
769 * your module may decide to enable some extra features if it sees that you have
770 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
771 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
772 * but instead operate under reduced functionality, unless the dependency is
773 * absolutely necessary (e.g. a module that extends the features of another
775 * @param mod Pointer to the module being unloaded (still valid)
777 virtual void OnUnloadModule(Module* mod);
779 /** Called once every five seconds for background processing.
780 * This timer can be used to control timed features. Its period is not accurate
781 * enough to be used as a clock, but it is guaranteed to be called at least once in
782 * any five second period, directly from the main loop of the server.
783 * @param curtime The current timer derived from time(2)
785 virtual void OnBackgroundTimer(time_t curtime);
787 /** Called whenever any command is about to be executed.
788 * This event occurs for all registered commands, whether they are registered in the core,
789 * or another module, and for invalid commands. Invalid commands may only be sent to this
790 * function when the value of validated is false. By returning 1 from this method you may prevent the
791 * command being executed. If you do this, no output is created by the core, and it is
792 * down to your module to produce any output necessary.
793 * Note that unless you return 1, you should not destroy any structures (e.g. by using
794 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
795 * method returns, it will be passed an invalid pointer to the user object and crash!)
796 * @param command The command being executed
797 * @param parameters An array of array of characters containing the parameters for the command
798 * @param user the user issuing the command
799 * @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.
800 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
801 * @return 1 to block the command, 0 to allow
803 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
805 /** Called after any command has been executed.
806 * This event occurs for all registered commands, whether they are registered in the core,
807 * or another module, but it will not occur for invalid commands (e.g. ones which do not
808 * exist within the command table). The result code returned by the command handler is
810 * @param command The command being executed
811 * @param parameters An array of array of characters containing the parameters for the command
812 * @param user the user issuing the command
813 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
814 * @param loop Whether the command is being called from LoopCall or directly.
816 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
818 /** Called when a command was blocked before it could be executed.
819 * @param command The command being executed.
820 * @param parameters The parameters for the command.
821 * @param user The user issuing the command.
823 virtual void OnCommandBlocked(const std::string& command, const CommandBase::Params& parameters, LocalUser* user);
825 /** Called after a user object is initialised and added to the user list.
826 * When this is called the user has not had their I/O hooks checked or had their initial
827 * connect class assigned and may not yet have a serialiser. You probably want to use
828 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
829 * @param user The connecting user.
831 virtual void OnUserInit(LocalUser* user);
833 /** Called after a user object has had their I/O hooks checked, their initial connection
834 * class assigned, and had a serialiser set.
835 * @param user The connecting user.
837 virtual void OnUserPostInit(LocalUser* user);
839 /** Called to check if a user who is connecting can now be allowed to register
840 * If any modules return false for this function, the user is held in the waiting
841 * state until all modules return true. For example a module which implements ident
842 * lookups will continue to return false for a user until their ident lookup is completed.
843 * Note that the registration timeout for a user overrides these checks, if the registration
844 * timeout is reached, the user is disconnected even if modules report that the user is
845 * not ready to connect.
846 * @param user The user to check
847 * @return true to indicate readiness, false if otherwise
849 virtual ModResult OnCheckReady(LocalUser* user);
851 /** Called whenever a user is about to register their connection (e.g. before the user
852 * is sent the MOTD etc). Modules can use this method if they are performing a function
853 * which must be done before the actual connection is completed (e.g. ident lookups,
854 * dnsbl lookups, etc).
855 * Note that you should NOT delete the user record here by causing a disconnection!
856 * Use OnUserConnect for that instead.
857 * @param user The user registering
858 * @return 1 to indicate user quit, 0 to continue
860 virtual ModResult OnUserRegister(LocalUser* user);
862 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
863 * This method will always be called for each join, whether or not the channel is actually +i, and
864 * determines the outcome of an if statement around the whole section of invite checking code.
865 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
866 * @param user The user joining the channel
867 * @param chan The channel being joined
868 * @return 1 to explicitly allow the join, 0 to proceed as normal
870 virtual ModResult OnCheckInvite(User* user, Channel* chan);
872 /** Called whenever a mode character is processed.
873 * Return 1 from this function to block the mode character from being processed entirely.
874 * @param user The user who is sending the mode
875 * @param chan The channel the mode is being sent to (or NULL if a usermode)
876 * @param mh The mode handler for the mode being changed
877 * @param param The parameter for the mode or an empty string
878 * @param adding true of the mode is being added, false if it is being removed
879 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
880 * to skip all permission checking. Please note that for remote mode changes, your return value
883 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
885 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
886 * This method will always be called for each join, whether or not the channel is actually +k, and
887 * determines the outcome of an if statement around the whole section of key checking code.
888 * if the user specified no key, the keygiven string will be a valid but empty value.
889 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
890 * @param user The user joining the channel
891 * @param chan The channel being joined
892 * @param keygiven The key given on joining the channel.
893 * @return 1 to explicitly allow the join, 0 to proceed as normal
895 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
897 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
898 * This method will always be called for each join, whether or not the channel is actually +l, and
899 * determines the outcome of an if statement around the whole section of channel limit checking code.
900 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
901 * @param user The user joining the channel
902 * @param chan The channel being joined
903 * @return 1 to explicitly allow the join, 0 to proceed as normal
905 virtual ModResult OnCheckLimit(User* user, Channel* chan);
908 * Checks for a user's ban from the channel
909 * @param user The user to check
910 * @param chan The channel to check in
911 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
912 * ban check, or MOD_RES_PASSTHRU to check bans normally
914 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
917 * Checks for a user's match of a single ban
918 * @param user The user to check for match
919 * @param chan The channel on which the match is being checked
920 * @param mask The mask being checked
921 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
922 * ban check, or MOD_RES_PASSTHRU to check bans normally
924 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
926 /** Checks for a match on a given extban type
927 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
928 * ban check, or MOD_RES_PASSTHRU to check bans normally
930 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
932 /** Called whenever a change of a local users displayed host is attempted.
933 * Return 1 to deny the host change, or 0 to allow it.
934 * @param user The user whos host will be changed
935 * @param newhost The new hostname
936 * @return 1 to deny the host change, 0 to allow
938 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
940 /** Called whenever a change of a local users real name is attempted.
941 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
942 * @param user The user whos real name will be changed
943 * @param newhost The new real name.
944 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
946 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
948 /** Called before a topic is changed.
949 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
950 * As with other 'pre' events, you should only ever block a local event.
951 * @param user The user changing the topic
952 * @param chan The channels who's topic is being changed
953 * @param topic The actual topic text
954 * @return 1 to block the topic change, 0 to allow
956 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
958 /** Called whenever a topic has been changed.
959 * To block topic changes you must use OnPreTopicChange instead.
960 * @param user The user changing the topic
961 * @param chan The channels who's topic is being changed
962 * @param topic The actual topic text
964 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
966 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
967 * The password field (from the config file) is in 'password' and is to be compared against
968 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
969 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
970 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
971 * @param password The password from the configuration file (the password="" value).
972 * @param input The password entered by the user or whoever.
973 * @param hashtype The hash value from the config
974 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
976 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
978 /** Called after a user has fully connected and all modules have executed OnUserConnect
979 * This event is informational only. You should not change any user information in this
980 * event. To do so, use the OnUserConnect method to change the state of local users.
981 * This is called for both local and remote users.
982 * @param user The user who is connecting
984 virtual void OnPostConnect(User* user);
986 /** Called when a port accepts a connection
987 * Return MOD_RES_ACCEPT if you have used the file descriptor.
988 * @param fd The file descriptor returned from accept()
989 * @param sock The socket connection for the new user
990 * @param client The client IP address and port
991 * @param server The server IP address and port
993 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
995 /** Called at intervals for modules to garbage-collect any hashes etc.
996 * Certain data types such as hash_map 'leak' buckets, which must be
997 * tidied up and freed by copying into a new item every so often. This
998 * method is called when it is time to do that.
1000 virtual void OnGarbageCollect();
1002 /** Called when a user's connect class is being matched
1003 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1004 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1006 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1008 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
1010 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1011 * a module like m_cgiirc changing it.
1012 * @param user The user whose IP is being set
1014 virtual void OnSetUserIP(LocalUser* user);
1016 /** Called whenever a ServiceProvider is registered.
1017 * @param service ServiceProvider being registered.
1019 virtual void OnServiceAdd(ServiceProvider& service);
1021 /** Called whenever a ServiceProvider is unregistered.
1022 * @param service ServiceProvider being unregistered.
1024 virtual void OnServiceDel(ServiceProvider& service);
1026 /** Called whenever a message is about to be written to a user.
1027 * @param user The user who is having a message sent to them.
1028 * @param msg The message which is being written to the user.
1029 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
1030 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
1032 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
1034 /** Called when a user connection has been unexpectedly disconnected.
1035 * @param user The user who has been unexpectedly disconnected.
1036 * @param error The type of error which caused this connection failure.
1037 * @return MOD_RES_ALLOW to explicitly retain the user as a zombie, MOD_RES_DENY to explicitly
1038 * disconnect the user, or MOD_RES_PASSTHRU to let another module handle the event.
1040 virtual ModResult OnConnectionFail(LocalUser* user, BufferedSocketError error);
1042 /** Called before a server shuts down.
1043 * @param reason The reason the server is shutting down.
1045 virtual void OnShutdown(const std::string& reason);
1048 /** ModuleManager takes care of all things module-related
1051 class CoreExport ModuleManager : public fakederef<ModuleManager>
1054 typedef std::multimap<std::string, ServiceProvider*, irc::insensitive_swo> DataProviderMap;
1055 typedef std::vector<ServiceProvider*> ServiceList;
1058 /** Holds a string describing the last module error to occur
1060 std::string LastModuleError;
1062 /** List of loaded modules and shared object/dll handles
1063 * keyed by module name
1065 std::map<std::string, Module*> Modules;
1071 } prioritizationState;
1073 /** Loads all core modules (core_*)
1075 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1077 /** Calls the Prioritize() method in all loaded modules
1078 * @return True if all went well, false if a dependency loop was detected
1080 bool PrioritizeHooks();
1082 /** Unregister all user modes or all channel modes owned by a module
1083 * @param mod Module whose modes to unregister
1084 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1086 void UnregisterModes(Module* mod, ModeType modetype);
1089 typedef std::map<std::string, Module*> ModuleMap;
1091 /** Event handler hooks.
1092 * This needs to be public to be used by FOREACH_MOD and friends.
1094 Module::List EventHandlers[I_END];
1096 /** List of data services keyed by name */
1097 DataProviderMap DataProviders;
1099 /** A list of ServiceProviders waiting to be registered.
1100 * Non-NULL when constructing a Module, NULL otherwise.
1101 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1102 * automatically registers them (that is, call AddService()) after the Module is constructed,
1103 * and before Module::init() is called.
1104 * If a service is created after the construction of the Module (for example in init()) it
1105 * has to be registered manually.
1107 ServiceList* NewServices;
1109 /** Expands the name of a module by prepending "m_" and appending ".so".
1110 * No-op if the name already has the ".so" extension.
1111 * @param modname Module name to expand
1112 * @return Module name starting with "m_" and ending with ".so"
1114 static std::string ExpandModName(const std::string& modname);
1116 /** Simple, bog-standard, boring constructor.
1124 /** Change the priority of one event in a module.
1125 * Each module event has a list of modules which are attached to that event type.
1126 * If you wish to be called before or after other specific modules, you may use this
1127 * method (usually within void Module::Prioritize()) to set your events priority.
1128 * You may use this call in other methods too, however, this is not supported behaviour
1130 * @param mod The module to change the priority of
1131 * @param i The event to change the priority of
1132 * @param s The state you wish to use for this event. Use one of
1133 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1134 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1135 * to set it to be before or after one or more other modules.
1136 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1137 * then this contains a the module that your module must be placed before
1140 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1142 /** Change the priority of all events in a module.
1143 * @param mod The module to set the priority of
1144 * @param s The priority of all events in the module.
1145 * Note that with this method, it is not possible to effectively use
1146 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1147 * SetPriority method for this, where you may specify other modules to
1148 * be prioritized against.
1150 void SetPriority(Module* mod, Priority s);
1152 /** Attach an event to a module.
1153 * You may later detach the event with ModuleManager::Detach().
1154 * If your module is unloaded, all events are automatically detached.
1155 * @param i Event type to attach
1156 * @param mod Module to attach event to
1157 * @return True if the event was attached
1159 bool Attach(Implementation i, Module* mod);
1161 /** Detach an event from a module.
1162 * This is not required when your module unloads, as the core will
1163 * automatically detach your module from all events it is attached to.
1164 * @param i Event type to detach
1165 * @param mod Module to detach event from
1166 * @return True if the event was detached
1168 bool Detach(Implementation i, Module* mod);
1170 /** Attach an array of events to a module
1171 * @param i Event types (array) to attach
1172 * @param mod Module to attach events to
1173 * @param sz The size of the implementation array
1175 void Attach(Implementation* i, Module* mod, size_t sz);
1177 /** Detach all events from a module (used on unload)
1178 * @param mod Module to detach from
1180 void DetachAll(Module* mod);
1182 /** Attach all events to a module (used on module load)
1183 * @param mod Module to attach to all events
1185 void AttachAll(Module* mod);
1187 /** Returns text describing the last module error
1188 * @return The last error message to occur
1190 std::string& LastError();
1192 /** Load a given module file
1193 * @param filename The file to load
1194 * @param defer Defer module init (loading many modules)
1195 * @return True if the module was found and loaded
1197 bool Load(const std::string& filename, bool defer = false);
1199 /** Unload a given module file. Note that the module will not be
1200 * completely gone until the cull list has finished processing.
1202 * @return true on success; if false, LastError will give a reason
1204 bool Unload(Module* module);
1206 /** Called by the InspIRCd constructor to load all modules from the config file.
1210 void DoSafeUnload(Module*);
1212 /** Check if a module can be unloaded and if yes, prepare it for unload
1213 * @param mod Module to be unloaded
1214 * @return True if the module is unloadable, false otherwise.
1215 * If true the module must be unloaded in the current main loop iteration.
1217 bool CanUnload(Module* mod);
1219 /** Find a module by name, and return a Module* to it.
1220 * This is preferred over iterating the module lists yourself.
1221 * @param name The module name to look up
1222 * @return A pointer to the module, or NULL if the module cannot be found
1224 Module* Find(const std::string &name);
1226 /** Register a service provided by a module */
1227 void AddService(ServiceProvider&);
1229 /** Unregister a service provided by a module */
1230 void DelService(ServiceProvider&);
1232 /** Register all services in a given ServiceList
1233 * @param list The list containing the services to register
1235 void AddServices(const ServiceList& list);
1237 inline void AddServices(ServiceProvider** list, int count)
1239 for(int i=0; i < count; i++)
1240 AddService(*list[i]);
1243 /** Find a service by name.
1244 * If multiple modules provide a given service, the first one loaded will be chosen.
1246 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1248 template<typename T> inline T* FindDataService(const std::string& name)
1250 return static_cast<T*>(FindService(SERVICE_DATA, name));
1253 /** Get a map of all loaded modules keyed by their name
1254 * @return A ModuleMap containing all loaded modules
1256 const ModuleMap& GetModules() const { return Modules; }
1258 /** Make a service referenceable by dynamic_references
1259 * @param name Name that will be used by dynamic_references to find the object
1260 * @param service Service to make referenceable by dynamic_references
1262 void AddReferent(const std::string& name, ServiceProvider* service);
1264 /** Make a service no longer referenceable by dynamic_references
1265 * @param service Service to make no longer referenceable by dynamic_references
1267 void DelReferent(ServiceProvider* service);