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"
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()
237 I_OnAcceptConnection,
240 I_OnBuildNeighborList,
246 I_OnChannelPreDelete,
274 I_OnPreChangeRealName,
294 I_OnUserMessageBlocked,
311 /** Base class for all InspIRCd modules
312 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
313 * its methods will be called when irc server events occur. class inherited from module must be
314 * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised.
316 class CoreExport Module : public classbase, public usecountbase
318 /** Detach an event from this module
319 * @param i Event type to detach
321 void DetachEvent(Implementation i);
324 /** A list of modules. */
325 typedef std::vector<Module*> List;
327 /** File that this module was loaded from
329 std::string ModuleSourceFile;
331 /** Reference to the dlopen() value
333 DLLManager* ModuleDLLManager;
335 /** If true, this module will be unloaded soon, further unload attempts will fail
336 * Value is used by the ModuleManager internally, you should not modify it
340 /** Default constructor.
341 * Creates a module class. Don't do any type of hook registration or checks
342 * for other modules here; do that in init().
347 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
349 virtual void init() { }
351 /** Clean up prior to destruction
352 * If you override, you must call this AFTER your module's cleanup
354 CullResult cull() CXX11_OVERRIDE;
356 /** Default destructor.
357 * destroys a module class
361 /** Called when the hooks provided by a module need to be prioritised. */
362 virtual void Prioritize() { }
364 /** This method is called when you should reload module specific configuration:
365 * on boot, on a /REHASH and on module load.
366 * @param status The current status, can be inspected for more information;
367 * also used for reporting configuration errors and warnings.
369 virtual void ReadConfig(ConfigStatus& status);
371 /** Returns the version number of a Module.
372 * The method should return a Version object with its version information assigned via
375 virtual Version GetVersion() = 0;
377 /** Called when a user connects.
378 * The details of the connecting user are available to you in the parameter User *user
379 * @param user The user who is connecting
381 virtual void OnUserConnect(LocalUser* user);
383 /** Called when before a user quits.
384 * The details of the exiting user are available to you in the parameter User *user
385 * This event is only called when the user is fully registered when they quit. To catch
386 * raw disconnections, use the OnUserDisconnect method.
387 * @param user The user who is quitting
388 * @param message The user's quit message (as seen by non-opers)
389 * @param oper_message The user's quit message (as seen by opers)
391 virtual ModResult OnUserPreQuit(LocalUser* user, std::string& message, std::string& oper_message);
393 /** Called when a user quits.
394 * The details of the exiting user are available to you in the parameter User *user
395 * This event is only called when the user is fully registered when they quit. To catch
396 * raw disconnections, use the OnUserDisconnect method.
397 * @param user The user who is quitting
398 * @param message The user's quit message (as seen by non-opers)
399 * @param oper_message The user's quit message (as seen by opers)
401 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
403 /** Called whenever a user's socket is closed.
404 * The details of the exiting user are available to you in the parameter User *user
405 * This event is called for all users, registered or not, as a cleanup method for modules
406 * which might assign resources to user, such as dns lookups, objects and sockets.
407 * @param user The user who is disconnecting
409 virtual void OnUserDisconnect(LocalUser* user);
411 /** Called whenever a channel is about to be deleted
412 * @param chan The channel being deleted
413 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
415 virtual ModResult OnChannelPreDelete(Channel *chan);
417 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
418 * @param chan The channel being deleted
420 virtual void OnChannelDelete(Channel* chan);
422 /** Called when a user joins a channel.
423 * The details of the joining user are available to you in the parameter User *user,
424 * and the details of the channel they have joined is available in the variable Channel *channel
425 * @param memb The channel membership being created
426 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
427 * to a channel due to the network sync.
428 * @param created This is true if the join created the channel
429 * @param except_list A list of users not to send to.
431 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
433 /** Called after a user joins a channel
434 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
436 * @param memb The channel membership created
438 virtual void OnPostJoin(Membership* memb);
440 /** Called when a user parts a channel.
441 * The details of the leaving user are available to you in the parameter User *user,
442 * and the details of the channel they have left is available in the variable Channel *channel
443 * @param memb The channel membership being destroyed
444 * @param partmessage The part message, or an empty string (may be modified)
445 * @param except_list A list of users to not send to.
447 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
449 /** Called on rehash.
450 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
451 * system. This is called in all cases -- including when this server will not execute the
452 * rehash because it is directed at a remote server.
454 * @param user The user performing the rehash, if any. If this is server initiated, the value of
455 * this variable will be NULL.
456 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
459 virtual void OnPreRehash(User* user, const std::string ¶meter);
461 /** Called on rehash.
462 * This method is called when a user initiates a module-specific rehash. This can be used to do
463 * expensive operations (such as reloading TLS (SSL) certificates) that are not executed on a normal
464 * rehash for efficiency. A rehash of this type does not reload the core configuration.
466 * @param user The user performing the rehash.
467 * @param parameter The parameter given to REHASH
469 virtual void OnModuleRehash(User* user, const std::string ¶meter);
471 /** Called whenever a snotice is about to be sent to a snomask.
472 * snomask and type may both be modified; the message may not.
473 * @param snomask The snomask the message is going to (e.g. 'A')
474 * @param type The textual description the snomask will go to (e.g. 'OPER')
475 * @param message The text message to be sent via snotice
476 * @return 1 to block the snotice from being sent entirely, 0 else.
478 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
480 /** Called whenever a user is about to join a channel, before any processing is done.
481 * Returning a value of 1 from this function stops the process immediately, causing no
482 * output to be sent to the user by the core. If you do this you must produce your own numerics,
483 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
484 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
488 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
489 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
490 * processing on the actual channel record at this point, however the channel NAME will still be passed in
491 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
492 * @param user The user joining the channel
493 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
494 * @param cname The channel name being joined. For new channels this is valid where chan is not.
495 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
496 * You may alter this string to alter the user's modes on the channel.
497 * @param keygiven The key given to join the channel, or an empty string if none was provided
498 * @return 1 To prevent the join, 0 to allow it.
500 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
502 /** Called whenever a user is about to be kicked.
503 * Returning a value of 1 from this function stops the process immediately, causing no
504 * output to be sent to the user by the core. If you do this you must produce your own numerics,
506 * @param source The user issuing the kick
507 * @param memb The channel membership of the user who is being kicked.
508 * @param reason The kick reason
509 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
511 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
513 /** Called whenever a user is kicked.
514 * If this method is called, the kick is already underway and cannot be prevented, so
515 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
516 * @param source The user issuing the kick
517 * @param memb The channel membership of the user who was kicked.
518 * @param reason The kick reason
519 * @param except_list A list of users to not send to.
521 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
523 /** Called whenever a user opers locally.
524 * The User will contain the oper mode 'o' as this function is called after any modifications
525 * are made to the user's structure by the core.
526 * @param user The user who is opering up
527 * @param opertype The opers type name
529 virtual void OnOper(User* user, const std::string &opertype);
531 /** Called after a user opers locally.
532 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
533 * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent
534 * out the OPERTYPE, etc.
535 * @param user The user who is opering up
536 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
537 * @param opertype The opers type name
539 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
541 /** Called after a user deopers locally.
542 * @param user The user who has deopered.
544 virtual void OnPostDeoper(User* user);
546 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
547 * Returning 1 from this function stops the process immediately, causing no
548 * output to be sent to the user by the core. If you do this you must produce your own numerics,
549 * notices etc. This is useful for modules which may want to filter invites to channels.
550 * @param source The user who is issuing the INVITE
551 * @param dest The user being invited
552 * @param channel The channel the user is being invited to
553 * @param timeout The time the invite will expire (0 == never)
554 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
556 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
558 /** Called after a user has been successfully invited to a channel.
559 * You cannot prevent the invite from occurring using this function, to do that,
560 * use OnUserPreInvite instead.
561 * @param source The user who is issuing the INVITE
562 * @param dest The user being invited
563 * @param channel The channel the user is being invited to
564 * @param timeout The time the invite will expire (0 == never)
565 * @param notifyrank Rank required to get an invite announcement (if enabled)
566 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
568 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
570 /** Called before a user sends a message to a channel, a user, or a server glob mask.
571 * @param user The user sending the message.
572 * @param target The target of the message. This can either be a channel, a user, or a server
574 * @param details Details about the message such as the message text and type. See the
575 * MessageDetails class for more information.
576 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
577 * message, or MOD_RES_PASSTHRU to let another module handle the event.
579 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
581 /** Called when sending a message to all "neighbors" of a given user -
582 * that is, all users that share a common channel. This is used in
583 * commands such as NICK, QUIT, etc.
584 * @param source The source of the message
585 * @param include_c Channels to scan for users to include
586 * @param exceptions Map of user->bool that overrides the inclusion decision
588 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
590 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
592 /** Called before local nickname changes. This can be used to implement Q-lines etc.
593 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
594 * module to generate some meaninful output.
595 * @param user The username changing their nick
596 * @param newnick Their new nickname
597 * @return 1 to deny the change, 0 to allow
599 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
601 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
602 * @param user The user sending the message.
603 * @param target The target of the message. This can either be a channel, a user, or a server
605 * @param details Details about the message such as the message text and type. See the
606 * MessageDetails class for more information.
608 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
610 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
611 * @param user The user sending the message.
612 * @param target The target of the message. This can either be a channel, a user, or a server
614 * @param details Details about the message such as the message text and type. See the
615 * MessageDetails class for more information.
617 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
619 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
620 * @param user The user sending the message.
621 * @param target The target of the message. This can either be a channel, a user, or a server
623 * @param details Details about the message such as the message text and type. See the
624 * MessageDetails class for more information.
626 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
628 /** Called after every MODE command sent from a user
629 * Either the usertarget or the chantarget variable contains the target of the modes,
630 * the actual target will have a non-NULL pointer.
631 * All changed modes are available in the changelist object.
632 * @param user The user sending the MODEs
633 * @param usertarget The target user of the modes, NULL if the target is a channel
634 * @param chantarget The target channel of the modes, NULL if the target is a user
635 * @param changelist The changed modes.
636 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
637 * for the possible flags.
639 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
641 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
642 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
643 * @param target The Channel* or User* that data should be added to
644 * @param extname The extension name which is being sent
645 * @param extdata The extension data, encoded at the other end by an identical module
647 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
649 /** Called whenever a user's hostname is changed.
650 * This event triggers after the host has been set.
651 * @param user The user whos host is being changed
652 * @param newhost The new hostname being set
654 virtual void OnChangeHost(User* user, const std::string &newhost);
656 /** Called whenever a user's real hostname is changed.
657 * This event triggers after the host has been set.
658 * @param user The user whos host is being changed
659 * @param newhost The new hostname being set
661 virtual void OnChangeRealHost(User* user, const std::string& newhost);
663 /** Called whenever a user's real name is changed.
664 * This event triggers after the name has been set.
665 * @param user The user who's real name is being changed
666 * @param real The new real name being set on the user
668 virtual void OnChangeRealName(User* user, const std::string& real);
670 /** Called whenever a user's IDENT is changed.
671 * This event triggers after the name has been set.
672 * @param user The user who's IDENT is being changed
673 * @param ident The new IDENT being set on the user
675 virtual void OnChangeIdent(User* user, const std::string &ident);
677 /** Called whenever an xline is added by a local user.
678 * This method is triggered after the line is added.
679 * @param source The sender of the line or NULL for local server
680 * @param line The xline being added
682 virtual void OnAddLine(User* source, XLine* line);
684 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
685 * This method is triggered after the line is deleted.
686 * @param source The user removing the line or NULL for local server
687 * @param line the line being deleted
689 virtual void OnDelLine(User* source, XLine* line);
691 /** Called whenever an xline expires.
692 * This method is triggered after the line is deleted.
693 * @param line The line being deleted.
695 virtual void OnExpireLine(XLine *line);
697 /** Called before the module is unloaded to clean up extensibles.
698 * This method is called once for every channel, membership, and user.
699 * so that you can clear up any data relating to the specified extensible.
700 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
701 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
702 * and EXT_USER then item is a User*.
703 * @param item A pointer to the extensible which is being cleaned up.
705 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
707 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
708 * have been applied. Please note that although you can see remote nickchanges through this function, you should
709 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
710 * check user->server before taking any action (including returning nonzero from the method).
711 * Because this method is called after the nickchange is taken place, no return values are possible
712 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
713 * @param user The user changing their nick
714 * @param oldnick The old nickname of the user before the nickchange
716 virtual void OnUserPostNick(User* user, const std::string &oldnick);
718 /** Called before a mode change via the MODE command, to allow a single access check for
719 * a full mode change (use OnRawMode to check individual modes)
721 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
722 * OnRawMode for each individual mode
724 * @param source the user making the mode change
725 * @param dest the user destination of the umode change (NULL if a channel mode)
726 * @param channel the channel destination of the mode change
727 * @param modes Modes being changed, can be edited
729 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
731 /** Called when a 005 numeric is about to be output.
732 * The module should modify the 005 numeric if needed to indicate its features.
733 * @param tokens The 005 map to be modified if necessary.
735 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
737 /** Called when a client is disconnected by KILL.
738 * If a client is killed by a server, e.g. a nickname collision or protocol error,
740 * Return 1 from this function to prevent the kill, and 0 from this function to allow
741 * it as normal. If you prevent the kill no output will be sent to the client, it is
742 * down to your module to generate this information.
743 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
744 * If you do so youre risking race conditions, desyncs and worse!
745 * @param source The user sending the KILL
746 * @param dest The user being killed
747 * @param reason The kill reason
748 * @return 1 to prevent the kill, 0 to allow
750 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
752 /** Called whenever a module is loaded.
753 * mod will contain a pointer to the module, and string will contain its name,
754 * for example m_widgets.so. This function is primary for dependency checking,
755 * your module may decide to enable some extra features if it sees that you have
756 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
757 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
758 * but instead operate under reduced functionality, unless the dependency is
759 * absolutely necessary (e.g. a module that extends the features of another
761 * @param mod A pointer to the new module
763 virtual void OnLoadModule(Module* mod);
765 /** Called whenever a module is unloaded.
766 * mod will contain a pointer to the module, and string will contain its name,
767 * for example m_widgets.so. This function is primary for dependency checking,
768 * your module may decide to enable some extra features if it sees that you have
769 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
770 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
771 * but instead operate under reduced functionality, unless the dependency is
772 * absolutely necessary (e.g. a module that extends the features of another
774 * @param mod Pointer to the module being unloaded (still valid)
776 virtual void OnUnloadModule(Module* mod);
778 /** Called once every five seconds for background processing.
779 * This timer can be used to control timed features. Its period is not accurate
780 * enough to be used as a clock, but it is guaranteed to be called at least once in
781 * any five second period, directly from the main loop of the server.
782 * @param curtime The current timer derived from time(2)
784 virtual void OnBackgroundTimer(time_t curtime);
786 /** Called whenever any command is about to be executed.
787 * This event occurs for all registered commands, whether they are registered in the core,
788 * or another module, and for invalid commands. Invalid commands may only be sent to this
789 * function when the value of validated is false. By returning 1 from this method you may prevent the
790 * command being executed. If you do this, no output is created by the core, and it is
791 * down to your module to produce any output necessary.
792 * Note that unless you return 1, you should not destroy any structures (e.g. by using
793 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
794 * method returns, it will be passed an invalid pointer to the user object and crash!)
795 * @param command The command being executed
796 * @param parameters An array of array of characters containing the parameters for the command
797 * @param user the user issuing the command
798 * @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.
799 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
800 * @return 1 to block the command, 0 to allow
802 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
804 /** Called after any command has been executed.
805 * This event occurs for all registered commands, whether they are registered in the core,
806 * or another module, but it will not occur for invalid commands (e.g. ones which do not
807 * exist within the command table). The result code returned by the command handler is
809 * @param command The command being executed
810 * @param parameters An array of array of characters containing the parameters for the command
811 * @param user the user issuing the command
812 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
813 * @param loop Whether the command is being called from LoopCall or directly.
815 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
817 /** Called when a command was blocked before it could be executed.
818 * @param command The command being executed.
819 * @param parameters The parameters for the command.
820 * @param user The user issuing the command.
822 virtual void OnCommandBlocked(const std::string& command, const CommandBase::Params& parameters, LocalUser* user);
824 /** Called after a user object is initialised and added to the user list.
825 * When this is called the user has not had their I/O hooks checked or had their initial
826 * connect class assigned and may not yet have a serialiser. You probably want to use
827 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
828 * @param user The connecting user.
830 virtual void OnUserInit(LocalUser* user);
832 /** Called after a user object has had their I/O hooks checked, their initial connection
833 * class assigned, and had a serialiser set.
834 * @param user The connecting user.
836 virtual void OnUserPostInit(LocalUser* user);
838 /** Called to check if a user who is connecting can now be allowed to register
839 * If any modules return false for this function, the user is held in the waiting
840 * state until all modules return true. For example a module which implements ident
841 * lookups will continue to return false for a user until their ident lookup is completed.
842 * Note that the registration timeout for a user overrides these checks, if the registration
843 * timeout is reached, the user is disconnected even if modules report that the user is
844 * not ready to connect.
845 * @param user The user to check
846 * @return true to indicate readiness, false if otherwise
848 virtual ModResult OnCheckReady(LocalUser* user);
850 /** Called whenever a user is about to register their connection (e.g. before the user
851 * is sent the MOTD etc). Modules can use this method if they are performing a function
852 * which must be done before the actual connection is completed (e.g. ident lookups,
853 * dnsbl lookups, etc).
854 * Note that you should NOT delete the user record here by causing a disconnection!
855 * Use OnUserConnect for that instead.
856 * @param user The user registering
857 * @return 1 to indicate user quit, 0 to continue
859 virtual ModResult OnUserRegister(LocalUser* user);
861 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
862 * This method will always be called for each join, whether or not the channel is actually +i, and
863 * determines the outcome of an if statement around the whole section of invite checking code.
864 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
865 * @param user The user joining the channel
866 * @param chan The channel being joined
867 * @return 1 to explicitly allow the join, 0 to proceed as normal
869 virtual ModResult OnCheckInvite(User* user, Channel* chan);
871 /** Called whenever a mode character is processed.
872 * Return 1 from this function to block the mode character from being processed entirely.
873 * @param user The user who is sending the mode
874 * @param chan The channel the mode is being sent to (or NULL if a usermode)
875 * @param mh The mode handler for the mode being changed
876 * @param param The parameter for the mode or an empty string
877 * @param adding true of the mode is being added, false if it is being removed
878 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
879 * to skip all permission checking. Please note that for remote mode changes, your return value
882 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
884 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
885 * This method will always be called for each join, whether or not the channel is actually +k, and
886 * determines the outcome of an if statement around the whole section of key checking code.
887 * if the user specified no key, the keygiven string will be a valid but empty value.
888 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
889 * @param user The user joining the channel
890 * @param chan The channel being joined
891 * @param keygiven The key given on joining the channel.
892 * @return 1 to explicitly allow the join, 0 to proceed as normal
894 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
896 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
897 * This method will always be called for each join, whether or not the channel is actually +l, and
898 * determines the outcome of an if statement around the whole section of channel limit checking code.
899 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
900 * @param user The user joining the channel
901 * @param chan The channel being joined
902 * @return 1 to explicitly allow the join, 0 to proceed as normal
904 virtual ModResult OnCheckLimit(User* user, Channel* chan);
907 * Checks for a user's ban from the channel
908 * @param user The user to check
909 * @param chan The channel to check in
910 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
911 * ban check, or MOD_RES_PASSTHRU to check bans normally
913 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
916 * Checks for a user's match of a single ban
917 * @param user The user to check for match
918 * @param chan The channel on which the match is being checked
919 * @param mask The mask being checked
920 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
921 * ban check, or MOD_RES_PASSTHRU to check bans normally
923 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
925 /** Checks for a match on a given extban type
926 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
927 * ban check, or MOD_RES_PASSTHRU to check bans normally
929 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
931 /** Called whenever a change of a local users displayed host is attempted.
932 * Return 1 to deny the host change, or 0 to allow it.
933 * @param user The user whos host will be changed
934 * @param newhost The new hostname
935 * @return 1 to deny the host change, 0 to allow
937 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
939 /** Called whenever a change of a local users real name is attempted.
940 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
941 * @param user The user whos real name will be changed
942 * @param newhost The new real name.
943 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
945 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
947 /** Called before a topic is changed.
948 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
949 * As with other 'pre' events, you should only ever block a local event.
950 * @param user The user changing the topic
951 * @param chan The channels who's topic is being changed
952 * @param topic The actual topic text
953 * @return 1 to block the topic change, 0 to allow
955 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
957 /** Called whenever a topic has been changed.
958 * To block topic changes you must use OnPreTopicChange instead.
959 * @param user The user changing the topic
960 * @param chan The channels who's topic is being changed
961 * @param topic The actual topic text
963 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
965 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
966 * The password field (from the config file) is in 'password' and is to be compared against
967 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
968 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
969 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
970 * @param password The password from the configuration file (the password="" value).
971 * @param input The password entered by the user or whoever.
972 * @param hashtype The hash value from the config
973 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
975 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
977 /** Called after a user has fully connected and all modules have executed OnUserConnect
978 * This event is informational only. You should not change any user information in this
979 * event. To do so, use the OnUserConnect method to change the state of local users.
980 * This is called for both local and remote users.
981 * @param user The user who is connecting
983 virtual void OnPostConnect(User* user);
985 /** Called when a port accepts a connection
986 * Return MOD_RES_ACCEPT if you have used the file descriptor.
987 * @param fd The file descriptor returned from accept()
988 * @param sock The socket connection for the new user
989 * @param client The client IP address and port
990 * @param server The server IP address and port
992 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
994 /** Called at intervals for modules to garbage-collect any hashes etc.
995 * Certain data types such as hash_map 'leak' buckets, which must be
996 * tidied up and freed by copying into a new item every so often. This
997 * method is called when it is time to do that.
999 virtual void OnGarbageCollect();
1001 /** Called when a user's connect class is being matched
1002 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
1003 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
1005 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
1007 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
1009 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1010 * a module like m_cgiirc changing it.
1011 * @param user The user whose IP is being set
1013 virtual void OnSetUserIP(LocalUser* user);
1015 /** Called whenever a ServiceProvider is registered.
1016 * @param service ServiceProvider being registered.
1018 virtual void OnServiceAdd(ServiceProvider& service);
1020 /** Called whenever a ServiceProvider is unregistered.
1021 * @param service ServiceProvider being unregistered.
1023 virtual void OnServiceDel(ServiceProvider& service);
1025 /** Called whenever a message is about to be written to a user.
1026 * @param user The user who is having a message sent to them.
1027 * @param msg The message which is being written to the user.
1028 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
1029 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
1031 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
1033 /** Called when a user connection has been unexpectedly disconnected.
1034 * @param user The user who has been unexpectedly disconnected.
1035 * @param error The type of error which caused this connection failure.
1036 * @return MOD_RES_ALLOW to explicitly retain the user as a zombie, MOD_RES_DENY to explicitly
1037 * disconnect the user, or MOD_RES_PASSTHRU to let another module handle the event.
1039 virtual ModResult OnConnectionFail(LocalUser* user, BufferedSocketError error);
1041 /** Called before a server shuts down.
1042 * @param reason The reason the server is shutting down.
1044 virtual void OnShutdown(const std::string& reason);
1047 /** ModuleManager takes care of all things module-related
1050 class CoreExport ModuleManager : public fakederef<ModuleManager>
1053 typedef std::multimap<std::string, ServiceProvider*, irc::insensitive_swo> DataProviderMap;
1054 typedef std::vector<ServiceProvider*> ServiceList;
1057 /** Holds a string describing the last module error to occur
1059 std::string LastModuleError;
1061 /** List of loaded modules and shared object/dll handles
1062 * keyed by module name
1064 std::map<std::string, Module*> Modules;
1070 } prioritizationState;
1072 /** Loads all core modules (core_*)
1074 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1076 /** Calls the Prioritize() method in all loaded modules
1077 * @return True if all went well, false if a dependency loop was detected
1079 bool PrioritizeHooks();
1081 /** Unregister all user modes or all channel modes owned by a module
1082 * @param mod Module whose modes to unregister
1083 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1085 void UnregisterModes(Module* mod, ModeType modetype);
1088 typedef std::map<std::string, Module*> ModuleMap;
1090 /** Event handler hooks.
1091 * This needs to be public to be used by FOREACH_MOD and friends.
1093 Module::List EventHandlers[I_END];
1095 /** List of data services keyed by name */
1096 DataProviderMap DataProviders;
1098 /** A list of ServiceProviders waiting to be registered.
1099 * Non-NULL when constructing a Module, NULL otherwise.
1100 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1101 * automatically registers them (that is, call AddService()) after the Module is constructed,
1102 * and before Module::init() is called.
1103 * If a service is created after the construction of the Module (for example in init()) it
1104 * has to be registered manually.
1106 ServiceList* NewServices;
1108 /** Expands the name of a module by prepending "m_" and appending ".so".
1109 * No-op if the name already has the ".so" extension.
1110 * @param modname Module name to expand
1111 * @return Module name starting with "m_" and ending with ".so"
1113 static std::string ExpandModName(const std::string& modname);
1115 /** Simple, bog-standard, boring constructor.
1123 /** Change the priority of one event in a module.
1124 * Each module event has a list of modules which are attached to that event type.
1125 * If you wish to be called before or after other specific modules, you may use this
1126 * method (usually within void Module::Prioritize()) to set your events priority.
1127 * You may use this call in other methods too, however, this is not supported behaviour
1129 * @param mod The module to change the priority of
1130 * @param i The event to change the priority of
1131 * @param s The state you wish to use for this event. Use one of
1132 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1133 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1134 * to set it to be before or after one or more other modules.
1135 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1136 * then this contains a the module that your module must be placed before
1139 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1141 /** Change the priority of all events in a module.
1142 * @param mod The module to set the priority of
1143 * @param s The priority of all events in the module.
1144 * Note that with this method, it is not possible to effectively use
1145 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1146 * SetPriority method for this, where you may specify other modules to
1147 * be prioritized against.
1149 void SetPriority(Module* mod, Priority s);
1151 /** Attach an event to a module.
1152 * You may later detach the event with ModuleManager::Detach().
1153 * If your module is unloaded, all events are automatically detached.
1154 * @param i Event type to attach
1155 * @param mod Module to attach event to
1156 * @return True if the event was attached
1158 bool Attach(Implementation i, Module* mod);
1160 /** Detach an event from a module.
1161 * This is not required when your module unloads, as the core will
1162 * automatically detach your module from all events it is attached to.
1163 * @param i Event type to detach
1164 * @param mod Module to detach event from
1165 * @return True if the event was detached
1167 bool Detach(Implementation i, Module* mod);
1169 /** Attach an array of events to a module
1170 * @param i Event types (array) to attach
1171 * @param mod Module to attach events to
1172 * @param sz The size of the implementation array
1174 void Attach(Implementation* i, Module* mod, size_t sz);
1176 /** Detach all events from a module (used on unload)
1177 * @param mod Module to detach from
1179 void DetachAll(Module* mod);
1181 /** Attach all events to a module (used on module load)
1182 * @param mod Module to attach to all events
1184 void AttachAll(Module* mod);
1186 /** Returns text describing the last module error
1187 * @return The last error message to occur
1189 std::string& LastError();
1191 /** Load a given module file
1192 * @param filename The file to load
1193 * @param defer Defer module init (loading many modules)
1194 * @return True if the module was found and loaded
1196 bool Load(const std::string& filename, bool defer = false);
1198 /** Unload a given module file. Note that the module will not be
1199 * completely gone until the cull list has finished processing.
1201 * @return true on success; if false, LastError will give a reason
1203 bool Unload(Module* module);
1205 /** Called by the InspIRCd constructor to load all modules from the config file.
1209 void DoSafeUnload(Module*);
1211 /** Check if a module can be unloaded and if yes, prepare it for unload
1212 * @param mod Module to be unloaded
1213 * @return True if the module is unloadable, false otherwise.
1214 * If true the module must be unloaded in the current main loop iteration.
1216 bool CanUnload(Module* mod);
1218 /** Find a module by name, and return a Module* to it.
1219 * This is preferred over iterating the module lists yourself.
1220 * @param name The module name to look up
1221 * @return A pointer to the module, or NULL if the module cannot be found
1223 Module* Find(const std::string &name);
1225 /** Register a service provided by a module */
1226 void AddService(ServiceProvider&);
1228 /** Unregister a service provided by a module */
1229 void DelService(ServiceProvider&);
1231 /** Register all services in a given ServiceList
1232 * @param list The list containing the services to register
1234 void AddServices(const ServiceList& list);
1236 inline void AddServices(ServiceProvider** list, int count)
1238 for(int i=0; i < count; i++)
1239 AddService(*list[i]);
1242 /** Find a service by name.
1243 * If multiple modules provide a given service, the first one loaded will be chosen.
1245 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1247 template<typename T> inline T* FindDataService(const std::string& name)
1249 return static_cast<T*>(FindService(SERVICE_DATA, name));
1252 /** Get a map of all loaded modules keyed by their name
1253 * @return A ModuleMap containing all loaded modules
1255 const ModuleMap& GetModules() const { return Modules; }
1257 /** Make a service referenceable by dynamic_references
1258 * @param name Name that will be used by dynamic_references to find the object
1259 * @param service Service to make referenceable by dynamic_references
1261 void AddReferent(const std::string& name, ServiceProvider* service);
1263 /** Make a service no longer referenceable by dynamic_references
1264 * @param service Service to make no longer referenceable by dynamic_references
1266 void DelReferent(ServiceProvider* service);