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-2019 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/>.
36 #include "inspsocket.h"
43 /** Used to specify the behaviour of a module. */
46 /** The module has no special attributes. */
49 /** The module is a coremod and can be assumed to be loaded on all servers. */
52 /* The module is included with InspIRCd. */
55 /** The module MUST be loaded on all servers on a network to link. */
58 /** The module SHOULD be loaded on all servers on a network for consistency. */
62 #define MOD_RES_ALLOW (ModResult(1))
63 #define MOD_RES_PASSTHRU (ModResult(0))
64 #define MOD_RES_DENY (ModResult(-1))
66 /** Used to represent an allow/deny module result.
67 * Not constructed as an enum because it reverses the value logic of some functions;
68 * the compiler will inline accesses to have the same efficiency as integer operations.
72 ModResult() : res(0) {}
73 explicit ModResult(int r) : res(r) {}
74 inline bool operator==(const ModResult& r) const
78 inline bool operator!=(const ModResult& r) const
82 inline bool operator!() const
86 inline bool check(bool def) const
88 return (res == 1 || (res == 0 && def));
91 * Merges two results, preferring ALLOW to DENY
93 inline ModResult operator+(const ModResult& r) const
95 if (res == r.res || r.res == 0)
99 // they are different, and neither is passthru
100 return MOD_RES_ALLOW;
104 /** InspIRCd major version.
105 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
107 #define INSPIRCD_VERSION_MAJ 300
109 /** InspIRCd API version.
110 * If you change any API elements, increment this value. This counter should be
111 * reset whenever the major version is changed. Modules can use these two values
112 * and numerical comparisons in preprocessor macros if they wish to support
113 * multiple versions of InspIRCd in one file.
115 #define INSPIRCD_VERSION_API 9
118 * This #define allows us to call a method in all
119 * loaded modules in a readable simple way, e.g.:
120 * 'FOREACH_MOD(OnConnect,(user));'
122 #define FOREACH_MOD(y,x) do { \
123 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
124 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
132 catch (CoreException& modexcept) \
134 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
140 * Custom module result handling loop. This is a paired macro, and should only
141 * be used with while_each_hook.
143 * See src/channels.cpp for an example of use.
145 #define DO_EACH_HOOK(n,v,args) \
147 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
148 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
156 #define WHILE_EACH_HOOK(n) \
158 catch (CoreException& except_ ## n) \
160 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
166 * Module result iterator
167 * Runs the given hook until some module returns a useful result.
169 * Example: ModResult result;
170 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
172 #define FIRST_MOD_RESULT(n,v,args) do { \
173 v = MOD_RES_PASSTHRU; \
174 DO_EACH_HOOK(n,v,args) \
176 if (v != MOD_RES_PASSTHRU) \
179 WHILE_EACH_HOOK(n); \
182 /** Holds a module's Version information.
183 * The members (set by the constructor only) indicate details as to the version number
184 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
186 class CoreExport Version
189 /** Module description
191 const std::string description;
197 /** Server linking description string */
198 const std::string link_data;
200 /** Simple module version */
201 Version(const std::string &desc, int flags = VF_NONE);
203 /** Complex version information, including linking compatability data */
204 Version(const std::string &desc, int flags, const std::string& linkdata);
207 class CoreExport DataProvider : public ServiceProvider
210 DataProvider(Module* Creator, const std::string& Name)
211 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
214 /** Priority types which can be used by Module::Prioritize()
216 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
218 /** Implementation-specific flags which may be set in Module::Implements()
222 I_OnUserConnect, I_OnUserPreQuit, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
223 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper,
224 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
225 I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode, I_OnShutdown,
226 I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit, I_OnUserPostInit,
227 I_OnChangeHost, I_OnChangeRealName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
228 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
229 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
230 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
231 I_OnPreChangeHost, I_OnPreTopicChange, I_OnConnectionFail,
232 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
233 I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
234 I_OnPostOper, I_OnPostCommand, I_OnCommandBlocked, I_OnPostJoin,
235 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
236 I_OnUserMessage, I_OnPassCompare, I_OnNumeric,
237 I_OnPreRehash, I_OnModuleRehash, I_OnChangeIdent, I_OnSetUserIP,
238 I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
242 /** Base class for all InspIRCd modules
243 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
244 * its methods will be called when irc server events occur. class inherited from module must be
245 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
247 class CoreExport Module : public classbase, public usecountbase
249 /** Detach an event from this module
250 * @param i Event type to detach
252 void DetachEvent(Implementation i);
255 /** A list of modules. */
256 typedef std::vector<Module*> List;
258 /** File that this module was loaded from
260 std::string ModuleSourceFile;
262 /** Reference to the dlopen() value
264 DLLManager* ModuleDLLManager;
266 /** If true, this module will be unloaded soon, further unload attempts will fail
267 * Value is used by the ModuleManager internally, you should not modify it
271 /** Default constructor.
272 * Creates a module class. Don't do any type of hook registration or checks
273 * for other modules here; do that in init().
278 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
280 virtual void init() {}
282 /** Clean up prior to destruction
283 * If you override, you must call this AFTER your module's cleanup
285 CullResult cull() CXX11_OVERRIDE;
287 /** Default destructor.
288 * destroys a module class
292 virtual void Prioritize()
296 /** This method is called when you should reload module specific configuration:
297 * on boot, on a /REHASH and on module load.
298 * @param status The current status, can be inspected for more information;
299 * also used for reporting configuration errors and warnings.
301 virtual void ReadConfig(ConfigStatus& status);
303 /** Returns the version number of a Module.
304 * The method should return a Version object with its version information assigned via
307 virtual Version GetVersion() = 0;
309 /** Called when a user connects.
310 * The details of the connecting user are available to you in the parameter User *user
311 * @param user The user who is connecting
313 virtual void OnUserConnect(LocalUser* user);
315 /** Called when before a user quits.
316 * The details of the exiting user are available to you in the parameter User *user
317 * This event is only called when the user is fully registered when they quit. To catch
318 * raw disconnections, use the OnUserDisconnect method.
319 * @param user The user who is quitting
320 * @param message The user's quit message (as seen by non-opers)
321 * @param oper_message The user's quit message (as seen by opers)
323 virtual ModResult OnUserPreQuit(LocalUser* user, std::string& message, std::string& oper_message);
325 /** Called when a user quits.
326 * The details of the exiting user are available to you in the parameter User *user
327 * This event is only called when the user is fully registered when they quit. To catch
328 * raw disconnections, use the OnUserDisconnect method.
329 * @param user The user who is quitting
330 * @param message The user's quit message (as seen by non-opers)
331 * @param oper_message The user's quit message (as seen by opers)
333 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
335 /** Called whenever a user's socket is closed.
336 * The details of the exiting user are available to you in the parameter User *user
337 * This event is called for all users, registered or not, as a cleanup method for modules
338 * which might assign resources to user, such as dns lookups, objects and sockets.
339 * @param user The user who is disconnecting
341 virtual void OnUserDisconnect(LocalUser* user);
343 /** Called whenever a channel is about to be deleted
344 * @param chan The channel being deleted
345 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
347 virtual ModResult OnChannelPreDelete(Channel *chan);
349 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
350 * @param chan The channel being deleted
352 virtual void OnChannelDelete(Channel* chan);
354 /** Called when a user joins a channel.
355 * The details of the joining user are available to you in the parameter User *user,
356 * and the details of the channel they have joined is available in the variable Channel *channel
357 * @param memb The channel membership being created
358 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
359 * to a channel due to the network sync.
360 * @param created This is true if the join created the channel
361 * @param except_list A list of users not to send to.
363 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
365 /** Called after a user joins a channel
366 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
368 * @param memb The channel membership created
370 virtual void OnPostJoin(Membership* memb);
372 /** Called when a user parts a channel.
373 * The details of the leaving user are available to you in the parameter User *user,
374 * and the details of the channel they have left is available in the variable Channel *channel
375 * @param memb The channel membership being destroyed
376 * @param partmessage The part message, or an empty string (may be modified)
377 * @param except_list A list of users to not send to.
379 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
381 /** Called on rehash.
382 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
383 * system. This is called in all cases -- including when this server will not execute the
384 * rehash because it is directed at a remote server.
386 * @param user The user performing the rehash, if any. If this is server initiated, the value of
387 * this variable will be NULL.
388 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
391 virtual void OnPreRehash(User* user, const std::string ¶meter);
393 /** Called on rehash.
394 * This method is called when a user initiates a module-specific rehash. This can be used to do
395 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
396 * rehash for efficiency. A rehash of this type does not reload the core configuration.
398 * @param user The user performing the rehash.
399 * @param parameter The parameter given to REHASH
401 virtual void OnModuleRehash(User* user, const std::string ¶meter);
403 /** Called whenever a snotice is about to be sent to a snomask.
404 * snomask and type may both be modified; the message may not.
405 * @param snomask The snomask the message is going to (e.g. 'A')
406 * @param type The textual description the snomask will go to (e.g. 'OPER')
407 * @param message The text message to be sent via snotice
408 * @return 1 to block the snotice from being sent entirely, 0 else.
410 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
412 /** Called whenever a user is about to join a channel, before any processing is done.
413 * Returning a value of 1 from this function stops the process immediately, causing no
414 * output to be sent to the user by the core. If you do this you must produce your own numerics,
415 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
416 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
420 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
421 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
422 * processing on the actual channel record at this point, however the channel NAME will still be passed in
423 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
424 * @param user The user joining the channel
425 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
426 * @param cname The channel name being joined. For new channels this is valid where chan is not.
427 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
428 * You may alter this string to alter the user's modes on the channel.
429 * @param keygiven The key given to join the channel, or an empty string if none was provided
430 * @return 1 To prevent the join, 0 to allow it.
432 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
434 /** Called whenever a user is about to be kicked.
435 * Returning a value of 1 from this function stops the process immediately, causing no
436 * output to be sent to the user by the core. If you do this you must produce your own numerics,
438 * @param source The user issuing the kick
439 * @param memb The channel membership of the user who is being kicked.
440 * @param reason The kick reason
441 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
443 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
445 /** Called whenever a user is kicked.
446 * If this method is called, the kick is already underway and cannot be prevented, so
447 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
448 * @param source The user issuing the kick
449 * @param memb The channel membership of the user who was kicked.
450 * @param reason The kick reason
451 * @param except_list A list of users to not send to.
453 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
455 /** Called whenever a user opers locally.
456 * The User will contain the oper mode 'o' as this function is called after any modifications
457 * are made to the user's structure by the core.
458 * @param user The user who is opering up
459 * @param opertype The opers type name
461 virtual void OnOper(User* user, const std::string &opertype);
463 /** Called after a user opers locally.
464 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
465 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
466 * out the OPERTYPE, etc.
467 * @param user The user who is opering up
468 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
469 * @param opertype The opers type name
471 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
473 /** Called after a user deopers locally.
474 * @param user The user who has deopered.
476 virtual void OnPostDeoper(User* user);
478 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
479 * Returning 1 from this function stops the process immediately, causing no
480 * output to be sent to the user by the core. If you do this you must produce your own numerics,
481 * notices etc. This is useful for modules which may want to filter invites to channels.
482 * @param source The user who is issuing the INVITE
483 * @param dest The user being invited
484 * @param channel The channel the user is being invited to
485 * @param timeout The time the invite will expire (0 == never)
486 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
488 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
490 /** Called after a user has been successfully invited to a channel.
491 * You cannot prevent the invite from occuring using this function, to do that,
492 * use OnUserPreInvite instead.
493 * @param source The user who is issuing the INVITE
494 * @param dest The user being invited
495 * @param channel The channel the user is being invited to
496 * @param timeout The time the invite will expire (0 == never)
497 * @param notifyrank Rank required to get an invite announcement (if enabled)
498 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
500 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
502 /** Called before a user sends a message to a channel, a user, or a server glob mask.
503 * @param user The user sending the message.
504 * @param target The target of the message. This can either be a channel, a user, or a server
506 * @param details Details about the message such as the message text and type. See the
507 * MessageDetails class for more information.
508 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
509 * message, or MOD_RES_PASSTHRU to let another module handle the event.
511 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
513 /** Called when sending a message to all "neighbors" of a given user -
514 * that is, all users that share a common channel. This is used in
515 * commands such as NICK, QUIT, etc.
516 * @param source The source of the message
517 * @param include_c Channels to scan for users to include
518 * @param exceptions Map of user->bool that overrides the inclusion decision
520 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
522 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
524 /** Called before local nickname changes. This can be used to implement Q-lines etc.
525 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
526 * module to generate some meaninful output.
527 * @param user The username changing their nick
528 * @param newnick Their new nickname
529 * @return 1 to deny the change, 0 to allow
531 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
533 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
534 * @param user The user sending the message.
535 * @param target The target of the message. This can either be a channel, a user, or a server
537 * @param details Details about the message such as the message text and type. See the
538 * MessageDetails class for more information.
540 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
542 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
543 * @param user The user sending the message.
544 * @param target The target of the message. This can either be a channel, a user, or a server
546 * @param details Details about the message such as the message text and type. See the
547 * MessageDetails class for more information.
549 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
551 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
552 * @param user The user sending the message.
553 * @param target The target of the message. This can either be a channel, a user, or a server
555 * @param details Details about the message such as the message text and type. See the
556 * MessageDetails class for more information.
558 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
560 /** Called after every MODE command sent from a user
561 * Either the usertarget or the chantarget variable contains the target of the modes,
562 * the actual target will have a non-NULL pointer.
563 * All changed modes are available in the changelist object.
564 * @param user The user sending the MODEs
565 * @param usertarget The target user of the modes, NULL if the target is a channel
566 * @param chantarget The target channel of the modes, NULL if the target is a user
567 * @param changelist The changed modes.
568 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
569 * for the possible flags.
571 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
573 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
574 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
575 * @param target The Channel* or User* that data should be added to
576 * @param extname The extension name which is being sent
577 * @param extdata The extension data, encoded at the other end by an identical module
579 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
581 /** Called whenever a user's hostname is changed.
582 * This event triggers after the host has been set.
583 * @param user The user whos host is being changed
584 * @param newhost The new hostname being set
586 virtual void OnChangeHost(User* user, const std::string &newhost);
588 /** Called whenever a user's real name is changed.
589 * This event triggers after the name has been set.
590 * @param user The user who's real name is being changed
591 * @param real The new real name being set on the user
593 virtual void OnChangeRealName(User* user, const std::string& real);
595 /** Called whenever a user's IDENT is changed.
596 * This event triggers after the name has been set.
597 * @param user The user who's IDENT is being changed
598 * @param ident The new IDENT being set on the user
600 virtual void OnChangeIdent(User* user, const std::string &ident);
602 /** Called whenever an xline is added by a local user.
603 * This method is triggered after the line is added.
604 * @param source The sender of the line or NULL for local server
605 * @param line The xline being added
607 virtual void OnAddLine(User* source, XLine* line);
609 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
610 * This method is triggered after the line is deleted.
611 * @param source The user removing the line or NULL for local server
612 * @param line the line being deleted
614 virtual void OnDelLine(User* source, XLine* line);
616 /** Called whenever an xline expires.
617 * This method is triggered after the line is deleted.
618 * @param line The line being deleted.
620 virtual void OnExpireLine(XLine *line);
622 /** Called before the module is unloaded to clean up extensibles.
623 * This method is called once for every channel, membership, and user.
624 * so that you can clear up any data relating to the specified extensible.
625 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
626 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
627 * and EXT_USER then item is a User*.
628 * @param item A pointer to the extensible which is being cleaned up.
630 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
632 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
633 * have been applied. Please note that although you can see remote nickchanges through this function, you should
634 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
635 * check user->server before taking any action (including returning nonzero from the method).
636 * Because this method is called after the nickchange is taken place, no return values are possible
637 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
638 * @param user The user changing their nick
639 * @param oldnick The old nickname of the user before the nickchange
641 virtual void OnUserPostNick(User* user, const std::string &oldnick);
643 /** Called before a mode change via the MODE command, to allow a single access check for
644 * a full mode change (use OnRawMode to check individual modes)
646 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
647 * OnRawMode for each individual mode
649 * @param source the user making the mode change
650 * @param dest the user destination of the umode change (NULL if a channel mode)
651 * @param channel the channel destination of the mode change
652 * @param modes Modes being changed, can be edited
654 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
656 /** Called when a 005 numeric is about to be output.
657 * The module should modify the 005 numeric if needed to indicate its features.
658 * @param tokens The 005 map to be modified if neccessary.
660 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
662 /** Called when a client is disconnected by KILL.
663 * If a client is killed by a server, e.g. a nickname collision or protocol error,
665 * Return 1 from this function to prevent the kill, and 0 from this function to allow
666 * it as normal. If you prevent the kill no output will be sent to the client, it is
667 * down to your module to generate this information.
668 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
669 * If you do so youre risking race conditions, desyncs and worse!
670 * @param source The user sending the KILL
671 * @param dest The user being killed
672 * @param reason The kill reason
673 * @return 1 to prevent the kill, 0 to allow
675 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
677 /** Called whenever a module is loaded.
678 * mod will contain a pointer to the module, and string will contain its name,
679 * for example m_widgets.so. This function is primary for dependency checking,
680 * your module may decide to enable some extra features if it sees that you have
681 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
682 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
683 * but instead operate under reduced functionality, unless the dependency is
684 * absolutely neccessary (e.g. a module that extends the features of another
686 * @param mod A pointer to the new module
688 virtual void OnLoadModule(Module* mod);
690 /** Called whenever a module is unloaded.
691 * mod will contain a pointer to the module, and string will contain its name,
692 * for example m_widgets.so. This function is primary for dependency checking,
693 * your module may decide to enable some extra features if it sees that you have
694 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
695 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
696 * but instead operate under reduced functionality, unless the dependency is
697 * absolutely neccessary (e.g. a module that extends the features of another
699 * @param mod Pointer to the module being unloaded (still valid)
701 virtual void OnUnloadModule(Module* mod);
703 /** Called once every five seconds for background processing.
704 * This timer can be used to control timed features. Its period is not accurate
705 * enough to be used as a clock, but it is gauranteed to be called at least once in
706 * any five second period, directly from the main loop of the server.
707 * @param curtime The current timer derived from time(2)
709 virtual void OnBackgroundTimer(time_t curtime);
711 /** Called whenever any command is about to be executed.
712 * This event occurs for all registered commands, wether they are registered in the core,
713 * or another module, and for invalid commands. Invalid commands may only be sent to this
714 * function when the value of validated is false. By returning 1 from this method you may prevent the
715 * command being executed. If you do this, no output is created by the core, and it is
716 * down to your module to produce any output neccessary.
717 * Note that unless you return 1, you should not destroy any structures (e.g. by using
718 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
719 * method returns, it will be passed an invalid pointer to the user object and crash!)
720 * @param command The command being executed
721 * @param parameters An array of array of characters containing the parameters for the command
722 * @param user the user issuing the command
723 * @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.
724 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
725 * @return 1 to block the command, 0 to allow
727 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
729 /** Called after any command has been executed.
730 * This event occurs for all registered commands, wether they are registered in the core,
731 * or another module, but it will not occur for invalid commands (e.g. ones which do not
732 * exist within the command table). The result code returned by the command handler is
734 * @param command The command being executed
735 * @param parameters An array of array of characters containing the parameters for the command
736 * @param user the user issuing the command
737 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
738 * @param loop Whether the command is being called from LoopCall or directly.
740 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
742 /** Called when a command was blocked before it could be executed.
743 * @param command The command being executed.
744 * @param parameters The parameters for the command.
745 * @param user The user issuing the command.
747 virtual void OnCommandBlocked(const std::string& command, const CommandBase::Params& parameters, LocalUser* user);
749 /** Called after a user object is initialised and added to the user list.
750 * When this is called the user has not had their I/O hooks checked or had their initial
751 * connect class assigned and may not yet have a serialiser. You probably want to use
752 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
753 * @param user The connecting user.
755 virtual void OnUserInit(LocalUser* user);
757 /** Called after a user object has had their I/O hooks checked, their initial connection
758 * class assigned, and had a serialiser set.
759 * @param user The connecting user.
761 virtual void OnUserPostInit(LocalUser* user);
763 /** Called to check if a user who is connecting can now be allowed to register
764 * If any modules return false for this function, the user is held in the waiting
765 * state until all modules return true. For example a module which implements ident
766 * lookups will continue to return false for a user until their ident lookup is completed.
767 * Note that the registration timeout for a user overrides these checks, if the registration
768 * timeout is reached, the user is disconnected even if modules report that the user is
769 * not ready to connect.
770 * @param user The user to check
771 * @return true to indicate readiness, false if otherwise
773 virtual ModResult OnCheckReady(LocalUser* user);
775 /** Called whenever a user is about to register their connection (e.g. before the user
776 * is sent the MOTD etc). Modules can use this method if they are performing a function
777 * which must be done before the actual connection is completed (e.g. ident lookups,
778 * dnsbl lookups, etc).
779 * Note that you should NOT delete the user record here by causing a disconnection!
780 * Use OnUserConnect for that instead.
781 * @param user The user registering
782 * @return 1 to indicate user quit, 0 to continue
784 virtual ModResult OnUserRegister(LocalUser* user);
786 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
787 * This method will always be called for each join, wether or not the channel is actually +i, and
788 * determines the outcome of an if statement around the whole section of invite checking code.
789 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
790 * @param user The user joining the channel
791 * @param chan The channel being joined
792 * @return 1 to explicitly allow the join, 0 to proceed as normal
794 virtual ModResult OnCheckInvite(User* user, Channel* chan);
796 /** Called whenever a mode character is processed.
797 * Return 1 from this function to block the mode character from being processed entirely.
798 * @param user The user who is sending the mode
799 * @param chan The channel the mode is being sent to (or NULL if a usermode)
800 * @param mh The mode handler for the mode being changed
801 * @param param The parameter for the mode or an empty string
802 * @param adding true of the mode is being added, false if it is being removed
803 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
804 * to skip all permission checking. Please note that for remote mode changes, your return value
807 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
809 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
810 * This method will always be called for each join, wether or not the channel is actually +k, and
811 * determines the outcome of an if statement around the whole section of key checking code.
812 * if the user specified no key, the keygiven string will be a valid but empty value.
813 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
814 * @param user The user joining the channel
815 * @param chan The channel being joined
816 * @param keygiven The key given on joining the channel.
817 * @return 1 to explicitly allow the join, 0 to proceed as normal
819 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
821 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
822 * This method will always be called for each join, wether or not the channel is actually +l, and
823 * determines the outcome of an if statement around the whole section of channel limit checking code.
824 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
825 * @param user The user joining the channel
826 * @param chan The channel being joined
827 * @return 1 to explicitly allow the join, 0 to proceed as normal
829 virtual ModResult OnCheckLimit(User* user, Channel* chan);
832 * Checks for a user's ban from the channel
833 * @param user The user to check
834 * @param chan The channel to check in
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 OnCheckChannelBan(User* user, Channel* chan);
841 * Checks for a user's match of a single ban
842 * @param user The user to check for match
843 * @param chan The channel on which the match is being checked
844 * @param mask The mask being checked
845 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
846 * ban check, or MOD_RES_PASSTHRU to check bans normally
848 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
850 /** Checks for a match on a given extban type
851 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
852 * ban check, or MOD_RES_PASSTHRU to check bans normally
854 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
856 /** Called whenever a change of a local users displayed host is attempted.
857 * Return 1 to deny the host change, or 0 to allow it.
858 * @param user The user whos host will be changed
859 * @param newhost The new hostname
860 * @return 1 to deny the host change, 0 to allow
862 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
864 /** Called whenever a change of a local users real name is attempted.
865 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
866 * @param user The user whos real name will be changed
867 * @param newhost The new real name.
868 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
870 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
872 /** Called before a topic is changed.
873 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
874 * As with other 'pre' events, you should only ever block a local event.
875 * @param user The user changing the topic
876 * @param chan The channels who's topic is being changed
877 * @param topic The actual topic text
878 * @return 1 to block the topic change, 0 to allow
880 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
882 /** Called whenever a topic has been changed.
883 * To block topic changes you must use OnPreTopicChange instead.
884 * @param user The user changing the topic
885 * @param chan The channels who's topic is being changed
886 * @param topic The actual topic text
888 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
890 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
891 * The password field (from the config file) is in 'password' and is to be compared against
892 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
893 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
894 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
895 * @param password The password from the configuration file (the password="" value).
896 * @param input The password entered by the user or whoever.
897 * @param hashtype The hash value from the config
898 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
900 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
902 /** Called after a user has fully connected and all modules have executed OnUserConnect
903 * This event is informational only. You should not change any user information in this
904 * event. To do so, use the OnUserConnect method to change the state of local users.
905 * This is called for both local and remote users.
906 * @param user The user who is connecting
908 virtual void OnPostConnect(User* user);
910 /** Called when a port accepts a connection
911 * Return MOD_RES_ACCEPT if you have used the file descriptor.
912 * @param fd The file descriptor returned from accept()
913 * @param sock The socket connection for the new user
914 * @param client The client IP address and port
915 * @param server The server IP address and port
917 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
919 /** Called at intervals for modules to garbage-collect any hashes etc.
920 * Certain data types such as hash_map 'leak' buckets, which must be
921 * tidied up and freed by copying into a new item every so often. This
922 * method is called when it is time to do that.
924 virtual void OnGarbageCollect();
926 /** Called when a user's connect class is being matched
927 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
928 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
930 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
932 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
934 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
935 * a module like m_cgiirc changing it.
936 * @param user The user whose IP is being set
938 virtual void OnSetUserIP(LocalUser* user);
940 /** Called whenever a ServiceProvider is registered.
941 * @param service ServiceProvider being registered.
943 virtual void OnServiceAdd(ServiceProvider& service);
945 /** Called whenever a ServiceProvider is unregistered.
946 * @param service ServiceProvider being unregistered.
948 virtual void OnServiceDel(ServiceProvider& service);
950 /** Called whenever a message is about to be written to a user.
951 * @param user The user who is having a message sent to them.
952 * @param msg The message which is being written to the user.
953 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
954 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
956 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
958 /** Called when a user connection has been unexpectedly disconnected.
959 * @param user The user who has been unexpectedly disconnected.
960 * @param error The type of error which caused this connection failure.
961 * @return MOD_RES_ALLOW to explicitly retain the user as a zombie, MOD_RES_DENY to explicitly
962 * disconnect the user, or MOD_RES_PASSTHRU to let another module handle the event.
964 virtual ModResult OnConnectionFail(LocalUser* user, BufferedSocketError error);
966 /** Called before a server shuts down.
967 * @param reason The reason the server is shutting down.
968 * @param restart Whether the server is restarting.
970 virtual void OnShutdown(const std::string& reason);
973 /** ModuleManager takes care of all things module-related
976 class CoreExport ModuleManager : public fakederef<ModuleManager>
979 typedef std::vector<ServiceProvider*> ServiceList;
982 /** Holds a string describing the last module error to occur
984 std::string LastModuleError;
986 /** List of loaded modules and shared object/dll handles
987 * keyed by module name
989 std::map<std::string, Module*> Modules;
995 } prioritizationState;
997 /** Loads all core modules (core_*)
999 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1001 /** Calls the Prioritize() method in all loaded modules
1002 * @return True if all went well, false if a dependency loop was detected
1004 bool PrioritizeHooks();
1006 /** Unregister all user modes or all channel modes owned by a module
1007 * @param mod Module whose modes to unregister
1008 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1010 void UnregisterModes(Module* mod, ModeType modetype);
1013 typedef std::map<std::string, Module*> ModuleMap;
1015 /** Event handler hooks.
1016 * This needs to be public to be used by FOREACH_MOD and friends.
1018 Module::List EventHandlers[I_END];
1020 /** List of data services keyed by name */
1021 std::multimap<std::string, ServiceProvider*, irc::insensitive_swo> DataProviders;
1023 /** A list of ServiceProviders waiting to be registered.
1024 * Non-NULL when constructing a Module, NULL otherwise.
1025 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1026 * automatically registers them (that is, call AddService()) after the Module is constructed,
1027 * and before Module::init() is called.
1028 * If a service is created after the construction of the Module (for example in init()) it
1029 * has to be registered manually.
1031 ServiceList* NewServices;
1033 /** Expands the name of a module by prepending "m_" and appending ".so".
1034 * No-op if the name already has the ".so" extension.
1035 * @param modname Module name to expand
1036 * @return Module name starting with "m_" and ending with ".so"
1038 static std::string ExpandModName(const std::string& modname);
1040 /** Simple, bog-standard, boring constructor.
1048 /** Change the priority of one event in a module.
1049 * Each module event has a list of modules which are attached to that event type.
1050 * If you wish to be called before or after other specific modules, you may use this
1051 * method (usually within void Module::Prioritize()) to set your events priority.
1052 * You may use this call in other methods too, however, this is not supported behaviour
1054 * @param mod The module to change the priority of
1055 * @param i The event to change the priority of
1056 * @param s The state you wish to use for this event. Use one of
1057 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1058 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1059 * to set it to be before or after one or more other modules.
1060 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1061 * then this contains a the module that your module must be placed before
1064 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1066 /** Change the priority of all events in a module.
1067 * @param mod The module to set the priority of
1068 * @param s The priority of all events in the module.
1069 * Note that with this method, it is not possible to effectively use
1070 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1071 * SetPriority method for this, where you may specify other modules to
1072 * be prioritized against.
1074 void SetPriority(Module* mod, Priority s);
1076 /** Attach an event to a module.
1077 * You may later detatch the event with ModuleManager::Detach().
1078 * If your module is unloaded, all events are automatically detatched.
1079 * @param i Event type to attach
1080 * @param mod Module to attach event to
1081 * @return True if the event was attached
1083 bool Attach(Implementation i, Module* mod);
1085 /** Detatch an event from a module.
1086 * This is not required when your module unloads, as the core will
1087 * automatically detatch your module from all events it is attached to.
1088 * @param i Event type to detach
1089 * @param mod Module to detach event from
1090 * @return True if the event was detached
1092 bool Detach(Implementation i, Module* mod);
1094 /** Attach an array of events to a module
1095 * @param i Event types (array) to attach
1096 * @param mod Module to attach events to
1097 * @param sz The size of the implementation array
1099 void Attach(Implementation* i, Module* mod, size_t sz);
1101 /** Detach all events from a module (used on unload)
1102 * @param mod Module to detach from
1104 void DetachAll(Module* mod);
1106 /** Attach all events to a module (used on module load)
1107 * @param mod Module to attach to all events
1109 void AttachAll(Module* mod);
1111 /** Returns text describing the last module error
1112 * @return The last error message to occur
1114 std::string& LastError();
1116 /** Load a given module file
1117 * @param filename The file to load
1118 * @param defer Defer module init (loading many modules)
1119 * @return True if the module was found and loaded
1121 bool Load(const std::string& filename, bool defer = false);
1123 /** Unload a given module file. Note that the module will not be
1124 * completely gone until the cull list has finished processing.
1126 * @return true on success; if false, LastError will give a reason
1128 bool Unload(Module* module);
1130 /** Called by the InspIRCd constructor to load all modules from the config file.
1134 void DoSafeUnload(Module*);
1136 /** Check if a module can be unloaded and if yes, prepare it for unload
1137 * @param mod Module to be unloaded
1138 * @return True if the module is unloadable, false otherwise.
1139 * If true the module must be unloaded in the current main loop iteration.
1141 bool CanUnload(Module* mod);
1143 /** Find a module by name, and return a Module* to it.
1144 * This is preferred over iterating the module lists yourself.
1145 * @param name The module name to look up
1146 * @return A pointer to the module, or NULL if the module cannot be found
1148 Module* Find(const std::string &name);
1150 /** Register a service provided by a module */
1151 void AddService(ServiceProvider&);
1153 /** Unregister a service provided by a module */
1154 void DelService(ServiceProvider&);
1156 /** Register all services in a given ServiceList
1157 * @param list The list containing the services to register
1159 void AddServices(const ServiceList& list);
1161 inline void AddServices(ServiceProvider** list, int count)
1163 for(int i=0; i < count; i++)
1164 AddService(*list[i]);
1167 /** Find a service by name.
1168 * If multiple modules provide a given service, the first one loaded will be chosen.
1170 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1172 template<typename T> inline T* FindDataService(const std::string& name)
1174 return static_cast<T*>(FindService(SERVICE_DATA, name));
1177 /** Get a map of all loaded modules keyed by their name
1178 * @return A ModuleMap containing all loaded modules
1180 const ModuleMap& GetModules() const { return Modules; }
1182 /** Make a service referenceable by dynamic_references
1183 * @param name Name that will be used by dynamic_references to find the object
1184 * @param service Service to make referenceable by dynamic_references
1186 void AddReferent(const std::string& name, ServiceProvider* service);
1188 /** Make a service no longer referenceable by dynamic_references
1189 * @param service Service to make no longer referenceable by dynamic_references
1191 void DelReferent(ServiceProvider* service);
1194 /** Do not mess with these functions unless you know the C preprocessor
1195 * well enough to explain why they are needed. The order is important.
1197 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1198 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1199 #define MODULE_INIT_STR_FN_1(x) #x
1200 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1201 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1202 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1204 /** This definition is used as shorthand for the various classes
1205 * and functions needed to make a module loadable by the OS.
1206 * It defines the class factory and external init_module function.
1208 #define MODULE_INIT(y) \
1209 extern "C" DllExport Module * MODULE_INIT_SYM() \
1213 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;