2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 iwalkalone <iwalkalone69@gmail.com>
5 * Copyright (C) 2013 Adam <Adam@anope.org>
6 * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
7 * Copyright (C) 2012-2013, 2016-2020 Sadie Powell <sadie@witchery.services>
8 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
9 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
10 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
11 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
12 * Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
13 * Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
14 * Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
15 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
17 * This file is part of InspIRCd. InspIRCd is free software: you can
18 * redistribute it and/or modify it under the terms of the GNU General Public
19 * License as published by the Free Software Foundation, version 2.
21 * This program is distributed in the hope that it will be useful, but WITHOUT
22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
23 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 #include "moduledefs.h"
37 #include "inspsocket.h"
41 /** Used to specify the behaviour of a module. */
44 /** The module has no special attributes. */
47 /** The module is a coremod and can be assumed to be loaded on all servers. */
50 /* The module is included with InspIRCd. */
53 /** The module MUST be loaded on all servers on a network to link. */
56 /** The module SHOULD be loaded on all servers on a network for consistency. */
60 #define MOD_RES_ALLOW (ModResult(1))
61 #define MOD_RES_PASSTHRU (ModResult(0))
62 #define MOD_RES_DENY (ModResult(-1))
64 /** Used to represent an allow/deny module result.
65 * Not constructed as an enum because it reverses the value logic of some functions;
66 * the compiler will inline accesses to have the same efficiency as integer operations.
70 ModResult() : res(0) {}
71 explicit ModResult(int r) : res(r) {}
72 inline bool operator==(const ModResult& r) const
76 inline bool operator!=(const ModResult& r) const
80 inline bool operator!() const
84 inline bool check(bool def) const
86 return (res == 1 || (res == 0 && def));
89 * Merges two results, preferring ALLOW to DENY
91 inline ModResult operator+(const ModResult& r) const
93 if (res == r.res || r.res == 0)
97 // they are different, and neither is passthru
103 * This #define allows us to call a method in all
104 * loaded modules in a readable simple way, e.g.:
105 * 'FOREACH_MOD(OnConnect,(user));'
107 #define FOREACH_MOD(y,x) do { \
108 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
109 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
117 catch (CoreException& modexcept) \
119 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
125 * Custom module result handling loop. This is a paired macro, and should only
126 * be used with while_each_hook.
128 * See src/channels.cpp for an example of use.
130 #define DO_EACH_HOOK(n,v,args) \
132 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
133 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
141 #define WHILE_EACH_HOOK(n) \
143 catch (CoreException& except_ ## n) \
145 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
151 * Module result iterator
152 * Runs the given hook until some module returns a useful result.
154 * Example: ModResult result;
155 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
157 #define FIRST_MOD_RESULT(n,v,args) do { \
158 v = MOD_RES_PASSTHRU; \
159 DO_EACH_HOOK(n,v,args) \
161 if (v != MOD_RES_PASSTHRU) \
164 WHILE_EACH_HOOK(n); \
167 /** Holds a module's Version information.
168 * The members (set by the constructor only) indicate details as to the version number
169 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
171 class CoreExport Version
174 /** Module description
176 const std::string description;
182 /** Server linking description string */
183 const std::string link_data;
185 /** Simple module version */
186 Version(const std::string &desc, int flags = VF_NONE);
188 /** Complex version information, including linking compatibility data */
189 Version(const std::string &desc, int flags, const std::string& linkdata);
192 class CoreExport DataProvider : public ServiceProvider
195 DataProvider(Module* Creator, const std::string& Name)
196 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
199 /** Priority types which can be used by Module::Prioritize()
201 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
203 /** Implementation-specific flags which may be set in Module::Implements()
207 I_OnUserConnect, I_OnUserPreQuit, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
208 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper,
209 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
210 I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode, I_OnShutdown,
211 I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit, I_OnUserPostInit,
212 I_OnChangeHost, I_OnChangeRealName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
213 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
214 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
215 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
216 I_OnPreChangeHost, I_OnPreTopicChange, I_OnConnectionFail,
217 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
218 I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
219 I_OnPostOper, I_OnPostCommand, I_OnCommandBlocked, I_OnPostJoin,
220 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
221 I_OnUserMessage, I_OnPassCompare, I_OnNumeric,
222 I_OnPreRehash, I_OnModuleRehash, I_OnChangeIdent, I_OnSetUserIP,
223 I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
227 /** Base class for all InspIRCd modules
228 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
229 * its methods will be called when irc server events occur. class inherited from module must be
230 * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised.
232 class CoreExport Module : public classbase, public usecountbase
234 /** Detach an event from this module
235 * @param i Event type to detach
237 void DetachEvent(Implementation i);
240 /** A list of modules. */
241 typedef std::vector<Module*> List;
243 /** File that this module was loaded from
245 std::string ModuleSourceFile;
247 /** Reference to the dlopen() value
249 DLLManager* ModuleDLLManager;
251 /** If true, this module will be unloaded soon, further unload attempts will fail
252 * Value is used by the ModuleManager internally, you should not modify it
256 /** Default constructor.
257 * Creates a module class. Don't do any type of hook registration or checks
258 * for other modules here; do that in init().
263 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
265 virtual void init() { }
267 /** Clean up prior to destruction
268 * If you override, you must call this AFTER your module's cleanup
270 CullResult cull() CXX11_OVERRIDE;
272 /** Default destructor.
273 * destroys a module class
277 /** Called when the hooks provided by a module need to be prioritised. */
278 virtual void Prioritize() { }
280 /** This method is called when you should reload module specific configuration:
281 * on boot, on a /REHASH and on module load.
282 * @param status The current status, can be inspected for more information;
283 * also used for reporting configuration errors and warnings.
285 virtual void ReadConfig(ConfigStatus& status);
287 /** Returns the version number of a Module.
288 * The method should return a Version object with its version information assigned via
291 virtual Version GetVersion() = 0;
293 /** Called when a user connects.
294 * The details of the connecting user are available to you in the parameter User *user
295 * @param user The user who is connecting
297 virtual void OnUserConnect(LocalUser* user);
299 /** Called when before a user quits.
300 * The details of the exiting user are available to you in the parameter User *user
301 * This event is only called when the user is fully registered when they quit. To catch
302 * raw disconnections, use the OnUserDisconnect method.
303 * @param user The user who is quitting
304 * @param message The user's quit message (as seen by non-opers)
305 * @param oper_message The user's quit message (as seen by opers)
307 virtual ModResult OnUserPreQuit(LocalUser* user, std::string& message, std::string& oper_message);
309 /** Called when a user quits.
310 * The details of the exiting user are available to you in the parameter User *user
311 * This event is only called when the user is fully registered when they quit. To catch
312 * raw disconnections, use the OnUserDisconnect method.
313 * @param user The user who is quitting
314 * @param message The user's quit message (as seen by non-opers)
315 * @param oper_message The user's quit message (as seen by opers)
317 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
319 /** Called whenever a user's socket is closed.
320 * The details of the exiting user are available to you in the parameter User *user
321 * This event is called for all users, registered or not, as a cleanup method for modules
322 * which might assign resources to user, such as dns lookups, objects and sockets.
323 * @param user The user who is disconnecting
325 virtual void OnUserDisconnect(LocalUser* user);
327 /** Called whenever a channel is about to be deleted
328 * @param chan The channel being deleted
329 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
331 virtual ModResult OnChannelPreDelete(Channel *chan);
333 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
334 * @param chan The channel being deleted
336 virtual void OnChannelDelete(Channel* chan);
338 /** Called when a user joins a channel.
339 * The details of the joining user are available to you in the parameter User *user,
340 * and the details of the channel they have joined is available in the variable Channel *channel
341 * @param memb The channel membership being created
342 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
343 * to a channel due to the network sync.
344 * @param created This is true if the join created the channel
345 * @param except_list A list of users not to send to.
347 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
349 /** Called after a user joins a channel
350 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
352 * @param memb The channel membership created
354 virtual void OnPostJoin(Membership* memb);
356 /** Called when a user parts a channel.
357 * The details of the leaving user are available to you in the parameter User *user,
358 * and the details of the channel they have left is available in the variable Channel *channel
359 * @param memb The channel membership being destroyed
360 * @param partmessage The part message, or an empty string (may be modified)
361 * @param except_list A list of users to not send to.
363 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
365 /** Called on rehash.
366 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
367 * system. This is called in all cases -- including when this server will not execute the
368 * rehash because it is directed at a remote server.
370 * @param user The user performing the rehash, if any. If this is server initiated, the value of
371 * this variable will be NULL.
372 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
375 virtual void OnPreRehash(User* user, const std::string ¶meter);
377 /** Called on rehash.
378 * This method is called when a user initiates a module-specific rehash. This can be used to do
379 * expensive operations (such as reloading TLS (SSL) certificates) that are not executed on a normal
380 * rehash for efficiency. A rehash of this type does not reload the core configuration.
382 * @param user The user performing the rehash.
383 * @param parameter The parameter given to REHASH
385 virtual void OnModuleRehash(User* user, const std::string ¶meter);
387 /** Called whenever a snotice is about to be sent to a snomask.
388 * snomask and type may both be modified; the message may not.
389 * @param snomask The snomask the message is going to (e.g. 'A')
390 * @param type The textual description the snomask will go to (e.g. 'OPER')
391 * @param message The text message to be sent via snotice
392 * @return 1 to block the snotice from being sent entirely, 0 else.
394 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
396 /** Called whenever a user is about to join a channel, before any processing is done.
397 * Returning a value of 1 from this function stops the process immediately, causing no
398 * output to be sent to the user by the core. If you do this you must produce your own numerics,
399 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
400 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
404 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
405 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
406 * processing on the actual channel record at this point, however the channel NAME will still be passed in
407 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
408 * @param user The user joining the channel
409 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
410 * @param cname The channel name being joined. For new channels this is valid where chan is not.
411 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
412 * You may alter this string to alter the user's modes on the channel.
413 * @param keygiven The key given to join the channel, or an empty string if none was provided
414 * @return 1 To prevent the join, 0 to allow it.
416 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
418 /** Called whenever a user is about to be kicked.
419 * Returning a value of 1 from this function stops the process immediately, causing no
420 * output to be sent to the user by the core. If you do this you must produce your own numerics,
422 * @param source The user issuing the kick
423 * @param memb The channel membership of the user who is being kicked.
424 * @param reason The kick reason
425 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
427 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
429 /** Called whenever a user is kicked.
430 * If this method is called, the kick is already underway and cannot be prevented, so
431 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
432 * @param source The user issuing the kick
433 * @param memb The channel membership of the user who was kicked.
434 * @param reason The kick reason
435 * @param except_list A list of users to not send to.
437 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
439 /** Called whenever a user opers locally.
440 * The User will contain the oper mode 'o' as this function is called after any modifications
441 * are made to the user's structure by the core.
442 * @param user The user who is opering up
443 * @param opertype The opers type name
445 virtual void OnOper(User* user, const std::string &opertype);
447 /** Called after a user opers locally.
448 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
449 * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent
450 * out the OPERTYPE, etc.
451 * @param user The user who is opering up
452 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
453 * @param opertype The opers type name
455 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
457 /** Called after a user deopers locally.
458 * @param user The user who has deopered.
460 virtual void OnPostDeoper(User* user);
462 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
463 * Returning 1 from this function stops the process immediately, causing no
464 * output to be sent to the user by the core. If you do this you must produce your own numerics,
465 * notices etc. This is useful for modules which may want to filter invites to channels.
466 * @param source The user who is issuing the INVITE
467 * @param dest The user being invited
468 * @param channel The channel the user is being invited to
469 * @param timeout The time the invite will expire (0 == never)
470 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
472 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
474 /** Called after a user has been successfully invited to a channel.
475 * You cannot prevent the invite from occurring using this function, to do that,
476 * use OnUserPreInvite instead.
477 * @param source The user who is issuing the INVITE
478 * @param dest The user being invited
479 * @param channel The channel the user is being invited to
480 * @param timeout The time the invite will expire (0 == never)
481 * @param notifyrank Rank required to get an invite announcement (if enabled)
482 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
484 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
486 /** Called before a user sends a message to a channel, a user, or a server glob mask.
487 * @param user The user sending the message.
488 * @param target The target of the message. This can either be a channel, a user, or a server
490 * @param details Details about the message such as the message text and type. See the
491 * MessageDetails class for more information.
492 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
493 * message, or MOD_RES_PASSTHRU to let another module handle the event.
495 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
497 /** Called when sending a message to all "neighbors" of a given user -
498 * that is, all users that share a common channel. This is used in
499 * commands such as NICK, QUIT, etc.
500 * @param source The source of the message
501 * @param include_c Channels to scan for users to include
502 * @param exceptions Map of user->bool that overrides the inclusion decision
504 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
506 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
508 /** Called before local nickname changes. This can be used to implement Q-lines etc.
509 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
510 * module to generate some meaninful output.
511 * @param user The username changing their nick
512 * @param newnick Their new nickname
513 * @return 1 to deny the change, 0 to allow
515 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
517 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
518 * @param user The user sending the message.
519 * @param target The target of the message. This can either be a channel, a user, or a server
521 * @param details Details about the message such as the message text and type. See the
522 * MessageDetails class for more information.
524 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
526 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
527 * @param user The user sending the message.
528 * @param target The target of the message. This can either be a channel, a user, or a server
530 * @param details Details about the message such as the message text and type. See the
531 * MessageDetails class for more information.
533 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
535 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
536 * @param user The user sending the message.
537 * @param target The target of the message. This can either be a channel, a user, or a server
539 * @param details Details about the message such as the message text and type. See the
540 * MessageDetails class for more information.
542 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
544 /** Called after every MODE command sent from a user
545 * Either the usertarget or the chantarget variable contains the target of the modes,
546 * the actual target will have a non-NULL pointer.
547 * All changed modes are available in the changelist object.
548 * @param user The user sending the MODEs
549 * @param usertarget The target user of the modes, NULL if the target is a channel
550 * @param chantarget The target channel of the modes, NULL if the target is a user
551 * @param changelist The changed modes.
552 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
553 * for the possible flags.
555 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
557 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
558 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
559 * @param target The Channel* or User* that data should be added to
560 * @param extname The extension name which is being sent
561 * @param extdata The extension data, encoded at the other end by an identical module
563 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
565 /** Called whenever a user's hostname is changed.
566 * This event triggers after the host has been set.
567 * @param user The user whos host is being changed
568 * @param newhost The new hostname being set
570 virtual void OnChangeHost(User* user, const std::string &newhost);
572 /** Called whenever a user's real name is changed.
573 * This event triggers after the name has been set.
574 * @param user The user who's real name is being changed
575 * @param real The new real name being set on the user
577 virtual void OnChangeRealName(User* user, const std::string& real);
579 /** Called whenever a user's IDENT is changed.
580 * This event triggers after the name has been set.
581 * @param user The user who's IDENT is being changed
582 * @param ident The new IDENT being set on the user
584 virtual void OnChangeIdent(User* user, const std::string &ident);
586 /** Called whenever an xline is added by a local user.
587 * This method is triggered after the line is added.
588 * @param source The sender of the line or NULL for local server
589 * @param line The xline being added
591 virtual void OnAddLine(User* source, XLine* line);
593 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
594 * This method is triggered after the line is deleted.
595 * @param source The user removing the line or NULL for local server
596 * @param line the line being deleted
598 virtual void OnDelLine(User* source, XLine* line);
600 /** Called whenever an xline expires.
601 * This method is triggered after the line is deleted.
602 * @param line The line being deleted.
604 virtual void OnExpireLine(XLine *line);
606 /** Called before the module is unloaded to clean up extensibles.
607 * This method is called once for every channel, membership, and user.
608 * so that you can clear up any data relating to the specified extensible.
609 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
610 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
611 * and EXT_USER then item is a User*.
612 * @param item A pointer to the extensible which is being cleaned up.
614 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
616 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
617 * have been applied. Please note that although you can see remote nickchanges through this function, you should
618 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
619 * check user->server before taking any action (including returning nonzero from the method).
620 * Because this method is called after the nickchange is taken place, no return values are possible
621 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
622 * @param user The user changing their nick
623 * @param oldnick The old nickname of the user before the nickchange
625 virtual void OnUserPostNick(User* user, const std::string &oldnick);
627 /** Called before a mode change via the MODE command, to allow a single access check for
628 * a full mode change (use OnRawMode to check individual modes)
630 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
631 * OnRawMode for each individual mode
633 * @param source the user making the mode change
634 * @param dest the user destination of the umode change (NULL if a channel mode)
635 * @param channel the channel destination of the mode change
636 * @param modes Modes being changed, can be edited
638 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
640 /** Called when a 005 numeric is about to be output.
641 * The module should modify the 005 numeric if needed to indicate its features.
642 * @param tokens The 005 map to be modified if necessary.
644 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
646 /** Called when a client is disconnected by KILL.
647 * If a client is killed by a server, e.g. a nickname collision or protocol error,
649 * Return 1 from this function to prevent the kill, and 0 from this function to allow
650 * it as normal. If you prevent the kill no output will be sent to the client, it is
651 * down to your module to generate this information.
652 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
653 * If you do so youre risking race conditions, desyncs and worse!
654 * @param source The user sending the KILL
655 * @param dest The user being killed
656 * @param reason The kill reason
657 * @return 1 to prevent the kill, 0 to allow
659 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
661 /** Called whenever a module is loaded.
662 * mod will contain a pointer to the module, and string will contain its name,
663 * for example m_widgets.so. This function is primary for dependency checking,
664 * your module may decide to enable some extra features if it sees that you have
665 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
666 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
667 * but instead operate under reduced functionality, unless the dependency is
668 * absolutely necessary (e.g. a module that extends the features of another
670 * @param mod A pointer to the new module
672 virtual void OnLoadModule(Module* mod);
674 /** Called whenever a module is unloaded.
675 * mod will contain a pointer to the module, and string will contain its name,
676 * for example m_widgets.so. This function is primary for dependency checking,
677 * your module may decide to enable some extra features if it sees that you have
678 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
679 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
680 * but instead operate under reduced functionality, unless the dependency is
681 * absolutely necessary (e.g. a module that extends the features of another
683 * @param mod Pointer to the module being unloaded (still valid)
685 virtual void OnUnloadModule(Module* mod);
687 /** Called once every five seconds for background processing.
688 * This timer can be used to control timed features. Its period is not accurate
689 * enough to be used as a clock, but it is guaranteed to be called at least once in
690 * any five second period, directly from the main loop of the server.
691 * @param curtime The current timer derived from time(2)
693 virtual void OnBackgroundTimer(time_t curtime);
695 /** Called whenever any command is about to be executed.
696 * This event occurs for all registered commands, whether they are registered in the core,
697 * or another module, and for invalid commands. Invalid commands may only be sent to this
698 * function when the value of validated is false. By returning 1 from this method you may prevent the
699 * command being executed. If you do this, no output is created by the core, and it is
700 * down to your module to produce any output necessary.
701 * Note that unless you return 1, you should not destroy any structures (e.g. by using
702 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
703 * method returns, it will be passed an invalid pointer to the user object and crash!)
704 * @param command The command being executed
705 * @param parameters An array of array of characters containing the parameters for the command
706 * @param user the user issuing the command
707 * @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.
708 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
709 * @return 1 to block the command, 0 to allow
711 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
713 /** Called after any command has been executed.
714 * This event occurs for all registered commands, whether they are registered in the core,
715 * or another module, but it will not occur for invalid commands (e.g. ones which do not
716 * exist within the command table). The result code returned by the command handler is
718 * @param command The command being executed
719 * @param parameters An array of array of characters containing the parameters for the command
720 * @param user the user issuing the command
721 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
722 * @param loop Whether the command is being called from LoopCall or directly.
724 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
726 /** Called when a command was blocked before it could be executed.
727 * @param command The command being executed.
728 * @param parameters The parameters for the command.
729 * @param user The user issuing the command.
731 virtual void OnCommandBlocked(const std::string& command, const CommandBase::Params& parameters, LocalUser* user);
733 /** Called after a user object is initialised and added to the user list.
734 * When this is called the user has not had their I/O hooks checked or had their initial
735 * connect class assigned and may not yet have a serialiser. You probably want to use
736 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
737 * @param user The connecting user.
739 virtual void OnUserInit(LocalUser* user);
741 /** Called after a user object has had their I/O hooks checked, their initial connection
742 * class assigned, and had a serialiser set.
743 * @param user The connecting user.
745 virtual void OnUserPostInit(LocalUser* user);
747 /** Called to check if a user who is connecting can now be allowed to register
748 * If any modules return false for this function, the user is held in the waiting
749 * state until all modules return true. For example a module which implements ident
750 * lookups will continue to return false for a user until their ident lookup is completed.
751 * Note that the registration timeout for a user overrides these checks, if the registration
752 * timeout is reached, the user is disconnected even if modules report that the user is
753 * not ready to connect.
754 * @param user The user to check
755 * @return true to indicate readiness, false if otherwise
757 virtual ModResult OnCheckReady(LocalUser* user);
759 /** Called whenever a user is about to register their connection (e.g. before the user
760 * is sent the MOTD etc). Modules can use this method if they are performing a function
761 * which must be done before the actual connection is completed (e.g. ident lookups,
762 * dnsbl lookups, etc).
763 * Note that you should NOT delete the user record here by causing a disconnection!
764 * Use OnUserConnect for that instead.
765 * @param user The user registering
766 * @return 1 to indicate user quit, 0 to continue
768 virtual ModResult OnUserRegister(LocalUser* user);
770 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
771 * This method will always be called for each join, whether or not the channel is actually +i, and
772 * determines the outcome of an if statement around the whole section of invite checking code.
773 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
774 * @param user The user joining the channel
775 * @param chan The channel being joined
776 * @return 1 to explicitly allow the join, 0 to proceed as normal
778 virtual ModResult OnCheckInvite(User* user, Channel* chan);
780 /** Called whenever a mode character is processed.
781 * Return 1 from this function to block the mode character from being processed entirely.
782 * @param user The user who is sending the mode
783 * @param chan The channel the mode is being sent to (or NULL if a usermode)
784 * @param mh The mode handler for the mode being changed
785 * @param param The parameter for the mode or an empty string
786 * @param adding true of the mode is being added, false if it is being removed
787 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
788 * to skip all permission checking. Please note that for remote mode changes, your return value
791 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
793 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
794 * This method will always be called for each join, whether or not the channel is actually +k, and
795 * determines the outcome of an if statement around the whole section of key checking code.
796 * if the user specified no key, the keygiven string will be a valid but empty value.
797 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
798 * @param user The user joining the channel
799 * @param chan The channel being joined
800 * @param keygiven The key given on joining the channel.
801 * @return 1 to explicitly allow the join, 0 to proceed as normal
803 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
805 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
806 * This method will always be called for each join, whether or not the channel is actually +l, and
807 * determines the outcome of an if statement around the whole section of channel limit checking code.
808 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
809 * @param user The user joining the channel
810 * @param chan The channel being joined
811 * @return 1 to explicitly allow the join, 0 to proceed as normal
813 virtual ModResult OnCheckLimit(User* user, Channel* chan);
816 * Checks for a user's ban from the channel
817 * @param user The user to check
818 * @param chan The channel to check in
819 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
820 * ban check, or MOD_RES_PASSTHRU to check bans normally
822 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
825 * Checks for a user's match of a single ban
826 * @param user The user to check for match
827 * @param chan The channel on which the match is being checked
828 * @param mask The mask being checked
829 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
830 * ban check, or MOD_RES_PASSTHRU to check bans normally
832 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
834 /** Checks for a match on a given extban type
835 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
836 * ban check, or MOD_RES_PASSTHRU to check bans normally
838 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
840 /** Called whenever a change of a local users displayed host is attempted.
841 * Return 1 to deny the host change, or 0 to allow it.
842 * @param user The user whos host will be changed
843 * @param newhost The new hostname
844 * @return 1 to deny the host change, 0 to allow
846 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
848 /** Called whenever a change of a local users real name is attempted.
849 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
850 * @param user The user whos real name will be changed
851 * @param newhost The new real name.
852 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
854 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
856 /** Called before a topic is changed.
857 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
858 * As with other 'pre' events, you should only ever block a local event.
859 * @param user The user changing the topic
860 * @param chan The channels who's topic is being changed
861 * @param topic The actual topic text
862 * @return 1 to block the topic change, 0 to allow
864 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
866 /** Called whenever a topic has been changed.
867 * To block topic changes you must use OnPreTopicChange instead.
868 * @param user The user changing the topic
869 * @param chan The channels who's topic is being changed
870 * @param topic The actual topic text
872 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
874 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
875 * The password field (from the config file) is in 'password' and is to be compared against
876 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
877 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
878 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
879 * @param password The password from the configuration file (the password="" value).
880 * @param input The password entered by the user or whoever.
881 * @param hashtype The hash value from the config
882 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
884 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
886 /** Called after a user has fully connected and all modules have executed OnUserConnect
887 * This event is informational only. You should not change any user information in this
888 * event. To do so, use the OnUserConnect method to change the state of local users.
889 * This is called for both local and remote users.
890 * @param user The user who is connecting
892 virtual void OnPostConnect(User* user);
894 /** Called when a port accepts a connection
895 * Return MOD_RES_ACCEPT if you have used the file descriptor.
896 * @param fd The file descriptor returned from accept()
897 * @param sock The socket connection for the new user
898 * @param client The client IP address and port
899 * @param server The server IP address and port
901 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
903 /** Called at intervals for modules to garbage-collect any hashes etc.
904 * Certain data types such as hash_map 'leak' buckets, which must be
905 * tidied up and freed by copying into a new item every so often. This
906 * method is called when it is time to do that.
908 virtual void OnGarbageCollect();
910 /** Called when a user's connect class is being matched
911 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
912 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
914 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
916 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
918 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
919 * a module like m_cgiirc changing it.
920 * @param user The user whose IP is being set
922 virtual void OnSetUserIP(LocalUser* user);
924 /** Called whenever a ServiceProvider is registered.
925 * @param service ServiceProvider being registered.
927 virtual void OnServiceAdd(ServiceProvider& service);
929 /** Called whenever a ServiceProvider is unregistered.
930 * @param service ServiceProvider being unregistered.
932 virtual void OnServiceDel(ServiceProvider& service);
934 /** Called whenever a message is about to be written to a user.
935 * @param user The user who is having a message sent to them.
936 * @param msg The message which is being written to the user.
937 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
938 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
940 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
942 /** Called when a user connection has been unexpectedly disconnected.
943 * @param user The user who has been unexpectedly disconnected.
944 * @param error The type of error which caused this connection failure.
945 * @return MOD_RES_ALLOW to explicitly retain the user as a zombie, MOD_RES_DENY to explicitly
946 * disconnect the user, or MOD_RES_PASSTHRU to let another module handle the event.
948 virtual ModResult OnConnectionFail(LocalUser* user, BufferedSocketError error);
950 /** Called before a server shuts down.
951 * @param reason The reason the server is shutting down.
953 virtual void OnShutdown(const std::string& reason);
956 /** ModuleManager takes care of all things module-related
959 class CoreExport ModuleManager : public fakederef<ModuleManager>
962 typedef std::vector<ServiceProvider*> ServiceList;
965 /** Holds a string describing the last module error to occur
967 std::string LastModuleError;
969 /** List of loaded modules and shared object/dll handles
970 * keyed by module name
972 std::map<std::string, Module*> Modules;
978 } prioritizationState;
980 /** Loads all core modules (core_*)
982 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
984 /** Calls the Prioritize() method in all loaded modules
985 * @return True if all went well, false if a dependency loop was detected
987 bool PrioritizeHooks();
989 /** Unregister all user modes or all channel modes owned by a module
990 * @param mod Module whose modes to unregister
991 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
993 void UnregisterModes(Module* mod, ModeType modetype);
996 typedef std::map<std::string, Module*> ModuleMap;
998 /** Event handler hooks.
999 * This needs to be public to be used by FOREACH_MOD and friends.
1001 Module::List EventHandlers[I_END];
1003 /** List of data services keyed by name */
1004 std::multimap<std::string, ServiceProvider*, irc::insensitive_swo> DataProviders;
1006 /** A list of ServiceProviders waiting to be registered.
1007 * Non-NULL when constructing a Module, NULL otherwise.
1008 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1009 * automatically registers them (that is, call AddService()) after the Module is constructed,
1010 * and before Module::init() is called.
1011 * If a service is created after the construction of the Module (for example in init()) it
1012 * has to be registered manually.
1014 ServiceList* NewServices;
1016 /** Expands the name of a module by prepending "m_" and appending ".so".
1017 * No-op if the name already has the ".so" extension.
1018 * @param modname Module name to expand
1019 * @return Module name starting with "m_" and ending with ".so"
1021 static std::string ExpandModName(const std::string& modname);
1023 /** Simple, bog-standard, boring constructor.
1031 /** Change the priority of one event in a module.
1032 * Each module event has a list of modules which are attached to that event type.
1033 * If you wish to be called before or after other specific modules, you may use this
1034 * method (usually within void Module::Prioritize()) to set your events priority.
1035 * You may use this call in other methods too, however, this is not supported behaviour
1037 * @param mod The module to change the priority of
1038 * @param i The event to change the priority of
1039 * @param s The state you wish to use for this event. Use one of
1040 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1041 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1042 * to set it to be before or after one or more other modules.
1043 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1044 * then this contains a the module that your module must be placed before
1047 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1049 /** Change the priority of all events in a module.
1050 * @param mod The module to set the priority of
1051 * @param s The priority of all events in the module.
1052 * Note that with this method, it is not possible to effectively use
1053 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1054 * SetPriority method for this, where you may specify other modules to
1055 * be prioritized against.
1057 void SetPriority(Module* mod, Priority s);
1059 /** Attach an event to a module.
1060 * You may later detach the event with ModuleManager::Detach().
1061 * If your module is unloaded, all events are automatically detached.
1062 * @param i Event type to attach
1063 * @param mod Module to attach event to
1064 * @return True if the event was attached
1066 bool Attach(Implementation i, Module* mod);
1068 /** Detach an event from a module.
1069 * This is not required when your module unloads, as the core will
1070 * automatically detach your module from all events it is attached to.
1071 * @param i Event type to detach
1072 * @param mod Module to detach event from
1073 * @return True if the event was detached
1075 bool Detach(Implementation i, Module* mod);
1077 /** Attach an array of events to a module
1078 * @param i Event types (array) to attach
1079 * @param mod Module to attach events to
1080 * @param sz The size of the implementation array
1082 void Attach(Implementation* i, Module* mod, size_t sz);
1084 /** Detach all events from a module (used on unload)
1085 * @param mod Module to detach from
1087 void DetachAll(Module* mod);
1089 /** Attach all events to a module (used on module load)
1090 * @param mod Module to attach to all events
1092 void AttachAll(Module* mod);
1094 /** Returns text describing the last module error
1095 * @return The last error message to occur
1097 std::string& LastError();
1099 /** Load a given module file
1100 * @param filename The file to load
1101 * @param defer Defer module init (loading many modules)
1102 * @return True if the module was found and loaded
1104 bool Load(const std::string& filename, bool defer = false);
1106 /** Unload a given module file. Note that the module will not be
1107 * completely gone until the cull list has finished processing.
1109 * @return true on success; if false, LastError will give a reason
1111 bool Unload(Module* module);
1113 /** Called by the InspIRCd constructor to load all modules from the config file.
1117 void DoSafeUnload(Module*);
1119 /** Check if a module can be unloaded and if yes, prepare it for unload
1120 * @param mod Module to be unloaded
1121 * @return True if the module is unloadable, false otherwise.
1122 * If true the module must be unloaded in the current main loop iteration.
1124 bool CanUnload(Module* mod);
1126 /** Find a module by name, and return a Module* to it.
1127 * This is preferred over iterating the module lists yourself.
1128 * @param name The module name to look up
1129 * @return A pointer to the module, or NULL if the module cannot be found
1131 Module* Find(const std::string &name);
1133 /** Register a service provided by a module */
1134 void AddService(ServiceProvider&);
1136 /** Unregister a service provided by a module */
1137 void DelService(ServiceProvider&);
1139 /** Register all services in a given ServiceList
1140 * @param list The list containing the services to register
1142 void AddServices(const ServiceList& list);
1144 inline void AddServices(ServiceProvider** list, int count)
1146 for(int i=0; i < count; i++)
1147 AddService(*list[i]);
1150 /** Find a service by name.
1151 * If multiple modules provide a given service, the first one loaded will be chosen.
1153 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1155 template<typename T> inline T* FindDataService(const std::string& name)
1157 return static_cast<T*>(FindService(SERVICE_DATA, name));
1160 /** Get a map of all loaded modules keyed by their name
1161 * @return A ModuleMap containing all loaded modules
1163 const ModuleMap& GetModules() const { return Modules; }
1165 /** Make a service referenceable by dynamic_references
1166 * @param name Name that will be used by dynamic_references to find the object
1167 * @param service Service to make referenceable by dynamic_references
1169 void AddReferent(const std::string& name, ServiceProvider* service);
1171 /** Make a service no longer referenceable by dynamic_references
1172 * @param service Service to make no longer referenceable by dynamic_references
1174 void DelReferent(ServiceProvider* service);