2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
6 * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
10 * Copyright (C) 2003 randomdan <???@???>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "inspsocket.h"
38 /** Used to specify the behaviour of a module. */
41 /** The module has no special attributes. */
44 /** The module is a coremod and can be assumed to be loaded on all servers. */
47 /* The module is included with InspIRCd. */
50 /** The module MUST be loaded on all servers on a network to link. */
53 /** The module SHOULD be loaded on all servers on a network for consistency. */
57 #define MOD_RES_ALLOW (ModResult(1))
58 #define MOD_RES_PASSTHRU (ModResult(0))
59 #define MOD_RES_DENY (ModResult(-1))
61 /** Used to represent an allow/deny module result.
62 * Not constructed as an enum because it reverses the value logic of some functions;
63 * the compiler will inline accesses to have the same efficiency as integer operations.
67 ModResult() : res(0) {}
68 explicit ModResult(int r) : res(r) {}
69 inline bool operator==(const ModResult& r) const
73 inline bool operator!=(const ModResult& r) const
77 inline bool operator!() const
81 inline bool check(bool def) const
83 return (res == 1 || (res == 0 && def));
86 * Merges two results, preferring ALLOW to DENY
88 inline ModResult operator+(const ModResult& r) const
90 if (res == r.res || r.res == 0)
94 // they are different, and neither is passthru
99 /** InspIRCd major version.
100 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
102 #define INSPIRCD_VERSION_MAJ 300
104 /** InspIRCd API version.
105 * If you change any API elements, increment this value. This counter should be
106 * reset whenever the major version is changed. Modules can use these two values
107 * and numerical comparisons in preprocessor macros if they wish to support
108 * multiple versions of InspIRCd in one file.
110 #define INSPIRCD_VERSION_API 3
113 * This #define allows us to call a method in all
114 * loaded modules in a readable simple way, e.g.:
115 * 'FOREACH_MOD(OnConnect,(user));'
117 #define FOREACH_MOD(y,x) do { \
118 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
119 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
126 catch (CoreException& modexcept) \
128 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
134 * Custom module result handling loop. This is a paired macro, and should only
135 * be used with while_each_hook.
137 * See src/channels.cpp for an example of use.
139 #define DO_EACH_HOOK(n,v,args) \
141 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
142 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
149 #define WHILE_EACH_HOOK(n) \
151 catch (CoreException& except_ ## n) \
153 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
159 * Module result iterator
160 * Runs the given hook until some module returns a useful result.
162 * Example: ModResult result;
163 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
165 #define FIRST_MOD_RESULT(n,v,args) do { \
166 v = MOD_RES_PASSTHRU; \
167 DO_EACH_HOOK(n,v,args) \
169 if (v != MOD_RES_PASSTHRU) \
172 WHILE_EACH_HOOK(n); \
175 /** Holds a module's Version information.
176 * The members (set by the constructor only) indicate details as to the version number
177 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
179 class CoreExport Version
182 /** Module description
184 const std::string description;
190 /** Server linking description string */
191 const std::string link_data;
193 /** Simple module version */
194 Version(const std::string &desc, int flags = VF_NONE);
196 /** Complex version information, including linking compatability data */
197 Version(const std::string &desc, int flags, const std::string& linkdata);
200 class CoreExport DataProvider : public ServiceProvider
203 DataProvider(Module* Creator, const std::string& Name)
204 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
207 /** Priority types which can be used by Module::Prioritize()
209 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
211 /** Implementation-specific flags which may be set in Module::Implements()
215 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
216 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper,
217 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
218 I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode,
219 I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit, I_OnUserPostInit,
220 I_OnChangeHost, I_OnChangeRealName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
221 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
222 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
223 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
224 I_OnPreChangeHost, I_OnPreTopicChange,
225 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
226 I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
227 I_OnPostOper, I_OnPostCommand, I_OnPostJoin,
228 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
229 I_OnUserMessage, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
230 I_OnPreRehash, I_OnModuleRehash, I_OnChangeIdent, I_OnSetUserIP,
231 I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
235 /** Base class for all InspIRCd modules
236 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
237 * its methods will be called when irc server events occur. class inherited from module must be
238 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
240 class CoreExport Module : public classbase, public usecountbase
242 /** Detach an event from this module
243 * @param i Event type to detach
245 void DetachEvent(Implementation i);
248 /** A list of modules. */
249 typedef std::vector<Module*> List;
251 /** File that this module was loaded from
253 std::string ModuleSourceFile;
255 /** Reference to the dlopen() value
257 DLLManager* ModuleDLLManager;
259 /** If true, this module will be unloaded soon, further unload attempts will fail
260 * Value is used by the ModuleManager internally, you should not modify it
264 /** Default constructor.
265 * Creates a module class. Don't do any type of hook registration or checks
266 * for other modules here; do that in init().
271 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
273 virtual void init() {}
275 /** Clean up prior to destruction
276 * If you override, you must call this AFTER your module's cleanup
278 CullResult cull() CXX11_OVERRIDE;
280 /** Default destructor.
281 * destroys a module class
285 virtual void Prioritize()
289 /** This method is called when you should reload module specific configuration:
290 * on boot, on a /REHASH and on module load.
291 * @param status The current status, can be inspected for more information;
292 * also used for reporting configuration errors and warnings.
294 virtual void ReadConfig(ConfigStatus& status);
296 /** Returns the version number of a Module.
297 * The method should return a Version object with its version information assigned via
300 virtual Version GetVersion() = 0;
302 /** Called when a user connects.
303 * The details of the connecting user are available to you in the parameter User *user
304 * @param user The user who is connecting
306 virtual void OnUserConnect(LocalUser* user);
308 /** Called when a user quits.
309 * The details of the exiting user are available to you in the parameter User *user
310 * This event is only called when the user is fully registered when they quit. To catch
311 * raw disconnections, use the OnUserDisconnect method.
312 * @param user The user who is quitting
313 * @param message The user's quit message (as seen by non-opers)
314 * @param oper_message The user's quit message (as seen by opers)
316 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
318 /** Called whenever a user's socket is closed.
319 * The details of the exiting user are available to you in the parameter User *user
320 * This event is called for all users, registered or not, as a cleanup method for modules
321 * which might assign resources to user, such as dns lookups, objects and sockets.
322 * @param user The user who is disconnecting
324 virtual void OnUserDisconnect(LocalUser* user);
326 /** Called whenever a channel is about to be deleted
327 * @param chan The channel being deleted
328 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
330 virtual ModResult OnChannelPreDelete(Channel *chan);
332 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
333 * @param chan The channel being deleted
335 virtual void OnChannelDelete(Channel* chan);
337 /** Called when a user joins a channel.
338 * The details of the joining user are available to you in the parameter User *user,
339 * and the details of the channel they have joined is available in the variable Channel *channel
340 * @param memb The channel membership being created
341 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
342 * to a channel due to the network sync.
343 * @param created This is true if the join created the channel
344 * @param except_list A list of users not to send to.
346 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
348 /** Called after a user joins a channel
349 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
351 * @param memb The channel membership created
353 virtual void OnPostJoin(Membership* memb);
355 /** Called when a user parts a channel.
356 * The details of the leaving user are available to you in the parameter User *user,
357 * and the details of the channel they have left is available in the variable Channel *channel
358 * @param memb The channel membership being destroyed
359 * @param partmessage The part message, or an empty string (may be modified)
360 * @param except_list A list of users to not send to.
362 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
364 /** Called on rehash.
365 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
366 * system. This is called in all cases -- including when this server will not execute the
367 * rehash because it is directed at a remote server.
369 * @param user The user performing the rehash, if any. If this is server initiated, the value of
370 * this variable will be NULL.
371 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
374 virtual void OnPreRehash(User* user, const std::string ¶meter);
376 /** Called on rehash.
377 * This method is called when a user initiates a module-specific rehash. This can be used to do
378 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
379 * rehash for efficiency. A rehash of this type does not reload the core configuration.
381 * @param user The user performing the rehash.
382 * @param parameter The parameter given to REHASH
384 virtual void OnModuleRehash(User* user, const std::string ¶meter);
386 /** Called whenever a snotice is about to be sent to a snomask.
387 * snomask and type may both be modified; the message may not.
388 * @param snomask The snomask the message is going to (e.g. 'A')
389 * @param type The textual description the snomask will go to (e.g. 'OPER')
390 * @param message The text message to be sent via snotice
391 * @return 1 to block the snotice from being sent entirely, 0 else.
393 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
395 /** Called whenever a user is about to join a channel, before any processing is done.
396 * Returning a value of 1 from this function stops the process immediately, causing no
397 * output to be sent to the user by the core. If you do this you must produce your own numerics,
398 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
399 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
403 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
404 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
405 * processing on the actual channel record at this point, however the channel NAME will still be passed in
406 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
407 * @param user The user joining the channel
408 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
409 * @param cname The channel name being joined. For new channels this is valid where chan is not.
410 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
411 * You may alter this string to alter the user's modes on the channel.
412 * @param keygiven The key given to join the channel, or an empty string if none was provided
413 * @return 1 To prevent the join, 0 to allow it.
415 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
417 /** Called whenever a user is about to be kicked.
418 * Returning a value of 1 from this function stops the process immediately, causing no
419 * output to be sent to the user by the core. If you do this you must produce your own numerics,
421 * @param source The user issuing the kick
422 * @param memb The channel membership of the user who is being kicked.
423 * @param reason The kick reason
424 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
426 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
428 /** Called whenever a user is kicked.
429 * If this method is called, the kick is already underway and cannot be prevented, so
430 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
431 * @param source The user issuing the kick
432 * @param memb The channel membership of the user who was kicked.
433 * @param reason The kick reason
434 * @param except_list A list of users to not send to.
436 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
438 /** Called whenever a user opers locally.
439 * The User will contain the oper mode 'o' as this function is called after any modifications
440 * are made to the user's structure by the core.
441 * @param user The user who is opering up
442 * @param opertype The opers type name
444 virtual void OnOper(User* user, const std::string &opertype);
446 /** Called after a user opers locally.
447 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
448 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
449 * out the OPERTYPE, etc.
450 * @param user The user who is opering up
451 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
452 * @param opertype The opers type name
454 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
456 /** Called after a user deopers locally.
457 * @param user The user who has deopered.
459 virtual void OnPostDeoper(User* user);
461 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
462 * Returning 1 from this function stops the process immediately, causing no
463 * output to be sent to the user by the core. If you do this you must produce your own numerics,
464 * notices etc. This is useful for modules which may want to filter invites to channels.
465 * @param source The user who is issuing the INVITE
466 * @param dest The user being invited
467 * @param channel The channel the user is being invited to
468 * @param timeout The time the invite will expire (0 == never)
469 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
471 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
473 /** Called after a user has been successfully invited to a channel.
474 * You cannot prevent the invite from occuring using this function, to do that,
475 * use OnUserPreInvite instead.
476 * @param source The user who is issuing the INVITE
477 * @param dest The user being invited
478 * @param channel The channel the user is being invited to
479 * @param timeout The time the invite will expire (0 == never)
480 * @param notifyrank Rank required to get an invite announcement (if enabled)
481 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
483 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
485 /** Called before a user sends a message to a channel, a user, or a server glob mask.
486 * @param user The user sending the message.
487 * @param target The target of the message. This can either be a channel, a user, or a server
489 * @param details Details about the message such as the message text and type. See the
490 * MessageDetails class for more information.
491 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
492 * message, or MOD_RES_PASSTHRU to let another module handle the event.
494 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
496 /** Called when sending a message to all "neighbors" of a given user -
497 * that is, all users that share a common channel. This is used in
498 * commands such as NICK, QUIT, etc.
499 * @param source The source of the message
500 * @param include_c Channels to scan for users to include
501 * @param exceptions Map of user->bool that overrides the inclusion decision
503 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
505 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
507 /** Called before local nickname changes. This can be used to implement Q-lines etc.
508 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
509 * module to generate some meaninful output.
510 * @param user The username changing their nick
511 * @param newnick Their new nickname
512 * @return 1 to deny the change, 0 to allow
514 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
516 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
517 * @param user The user sending the message.
518 * @param target The target of the message. This can either be a channel, a user, or a server
520 * @param details Details about the message such as the message text and type. See the
521 * MessageDetails class for more information.
523 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
525 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
526 * @param user The user sending the message.
527 * @param target The target of the message. This can either be a channel, a user, or a server
529 * @param details Details about the message such as the message text and type. See the
530 * MessageDetails class for more information.
532 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
534 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
535 * @param user The user sending the message.
536 * @param target The target of the message. This can either be a channel, a user, or a server
538 * @param details Details about the message such as the message text and type. See the
539 * MessageDetails class for more information.
541 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
543 /** Called after every MODE command sent from a user
544 * Either the usertarget or the chantarget variable contains the target of the modes,
545 * the actual target will have a non-NULL pointer.
546 * All changed modes are available in the changelist object.
547 * @param user The user sending the MODEs
548 * @param usertarget The target user of the modes, NULL if the target is a channel
549 * @param chantarget The target channel of the modes, NULL if the target is a user
550 * @param changelist The changed modes.
551 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
552 * for the possible flags.
554 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
556 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
557 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
558 * @param target The Channel* or User* that data should be added to
559 * @param extname The extension name which is being sent
560 * @param extdata The extension data, encoded at the other end by an identical module
562 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
564 /** Called whenever a user's hostname is changed.
565 * This event triggers after the host has been set.
566 * @param user The user whos host is being changed
567 * @param newhost The new hostname being set
569 virtual void OnChangeHost(User* user, const std::string &newhost);
571 /** Called whenever a user's real name is changed.
572 * This event triggers after the name has been set.
573 * @param user The user who's real name is being changed
574 * @param real The new real name being set on the user
576 virtual void OnChangeRealName(User* user, const std::string& real);
578 /** Called whenever a user's IDENT is changed.
579 * This event triggers after the name has been set.
580 * @param user The user who's IDENT is being changed
581 * @param ident The new IDENT being set on the user
583 virtual void OnChangeIdent(User* user, const std::string &ident);
585 /** Called whenever an xline is added by a local user.
586 * This method is triggered after the line is added.
587 * @param source The sender of the line or NULL for local server
588 * @param line The xline being added
590 virtual void OnAddLine(User* source, XLine* line);
592 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
593 * This method is triggered after the line is deleted.
594 * @param source The user removing the line or NULL for local server
595 * @param line the line being deleted
597 virtual void OnDelLine(User* source, XLine* line);
599 /** Called whenever an xline expires.
600 * This method is triggered after the line is deleted.
601 * @param line The line being deleted.
603 virtual void OnExpireLine(XLine *line);
605 /** Called before the module is unloaded to clean up extensibles.
606 * This method is called once for every channel, membership, and user.
607 * so that you can clear up any data relating to the specified extensible.
608 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
609 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
610 * and EXT_USER then item is a User*.
611 * @param item A pointer to the extensible which is being cleaned up.
613 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
615 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
616 * have been applied. Please note that although you can see remote nickchanges through this function, you should
617 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
618 * check user->server before taking any action (including returning nonzero from the method).
619 * Because this method is called after the nickchange is taken place, no return values are possible
620 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
621 * @param user The user changing their nick
622 * @param oldnick The old nickname of the user before the nickchange
624 virtual void OnUserPostNick(User* user, const std::string &oldnick);
626 /** Called before a mode change via the MODE command, to allow a single access check for
627 * a full mode change (use OnRawMode to check individual modes)
629 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
630 * OnRawMode for each individual mode
632 * @param source the user making the mode change
633 * @param dest the user destination of the umode change (NULL if a channel mode)
634 * @param channel the channel destination of the mode change
635 * @param modes Modes being changed, can be edited
637 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
639 /** Called when a 005 numeric is about to be output.
640 * The module should modify the 005 numeric if needed to indicate its features.
641 * @param tokens The 005 map to be modified if neccessary.
643 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
645 /** Called when a client is disconnected by KILL.
646 * If a client is killed by a server, e.g. a nickname collision or protocol error,
648 * Return 1 from this function to prevent the kill, and 0 from this function to allow
649 * it as normal. If you prevent the kill no output will be sent to the client, it is
650 * down to your module to generate this information.
651 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
652 * If you do so youre risking race conditions, desyncs and worse!
653 * @param source The user sending the KILL
654 * @param dest The user being killed
655 * @param reason The kill reason
656 * @return 1 to prevent the kill, 0 to allow
658 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
660 /** Called whenever a module is loaded.
661 * mod will contain a pointer to the module, and string will contain its name,
662 * for example m_widgets.so. This function is primary for dependency checking,
663 * your module may decide to enable some extra features if it sees that you have
664 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
665 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
666 * but instead operate under reduced functionality, unless the dependency is
667 * absolutely neccessary (e.g. a module that extends the features of another
669 * @param mod A pointer to the new module
671 virtual void OnLoadModule(Module* mod);
673 /** Called whenever a module is unloaded.
674 * mod will contain a pointer to the module, and string will contain its name,
675 * for example m_widgets.so. This function is primary for dependency checking,
676 * your module may decide to enable some extra features if it sees that you have
677 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
678 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
679 * but instead operate under reduced functionality, unless the dependency is
680 * absolutely neccessary (e.g. a module that extends the features of another
682 * @param mod Pointer to the module being unloaded (still valid)
684 virtual void OnUnloadModule(Module* mod);
686 /** Called once every five seconds for background processing.
687 * This timer can be used to control timed features. Its period is not accurate
688 * enough to be used as a clock, but it is gauranteed to be called at least once in
689 * any five second period, directly from the main loop of the server.
690 * @param curtime The current timer derived from time(2)
692 virtual void OnBackgroundTimer(time_t curtime);
694 /** Called whenever any command is about to be executed.
695 * This event occurs for all registered commands, wether they are registered in the core,
696 * or another module, and for invalid commands. Invalid commands may only be sent to this
697 * function when the value of validated is false. By returning 1 from this method you may prevent the
698 * command being executed. If you do this, no output is created by the core, and it is
699 * down to your module to produce any output neccessary.
700 * Note that unless you return 1, you should not destroy any structures (e.g. by using
701 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
702 * method returns, it will be passed an invalid pointer to the user object and crash!)
703 * @param command The command being executed
704 * @param parameters An array of array of characters containing the parameters for the command
705 * @param user the user issuing the command
706 * @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.
707 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
708 * @return 1 to block the command, 0 to allow
710 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
712 /** Called after any command has been executed.
713 * This event occurs for all registered commands, wether they are registered in the core,
714 * or another module, but it will not occur for invalid commands (e.g. ones which do not
715 * exist within the command table). The result code returned by the command handler is
717 * @param command The command being executed
718 * @param parameters An array of array of characters containing the parameters for the command
719 * @param user the user issuing the command
720 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
721 * @param loop Whether the command is being called from LoopCall or directly.
723 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
725 /** Called after a user object is initialised and added to the user list.
726 * When this is called the user has not their I/O hooks checked or had their initial
727 * connect class assigned and may not yet have a serialiser. You probably want to use
728 * the OnUserPostInit or OnUserSetIP hooks instead of this one.
729 * @param user The connecting user.
731 virtual void OnUserInit(LocalUser* user);
733 /** Called after a user object has had their I/O hooks checked, their initial connection
734 * class assigned, and had a serialiser set.
735 * @param user The connecting user.
737 virtual void OnUserPostInit(LocalUser* user);
739 /** Called to check if a user who is connecting can now be allowed to register
740 * If any modules return false for this function, the user is held in the waiting
741 * state until all modules return true. For example a module which implements ident
742 * lookups will continue to return false for a user until their ident lookup is completed.
743 * Note that the registration timeout for a user overrides these checks, if the registration
744 * timeout is reached, the user is disconnected even if modules report that the user is
745 * not ready to connect.
746 * @param user The user to check
747 * @return true to indicate readiness, false if otherwise
749 virtual ModResult OnCheckReady(LocalUser* user);
751 /** Called whenever a user is about to register their connection (e.g. before the user
752 * is sent the MOTD etc). Modules can use this method if they are performing a function
753 * which must be done before the actual connection is completed (e.g. ident lookups,
754 * dnsbl lookups, etc).
755 * Note that you should NOT delete the user record here by causing a disconnection!
756 * Use OnUserConnect for that instead.
757 * @param user The user registering
758 * @return 1 to indicate user quit, 0 to continue
760 virtual ModResult OnUserRegister(LocalUser* user);
762 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
763 * This method will always be called for each join, wether or not the channel is actually +i, and
764 * determines the outcome of an if statement around the whole section of invite checking code.
765 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
766 * @param user The user joining the channel
767 * @param chan The channel being joined
768 * @return 1 to explicitly allow the join, 0 to proceed as normal
770 virtual ModResult OnCheckInvite(User* user, Channel* chan);
772 /** Called whenever a mode character is processed.
773 * Return 1 from this function to block the mode character from being processed entirely.
774 * @param user The user who is sending the mode
775 * @param chan The channel the mode is being sent to (or NULL if a usermode)
776 * @param mh The mode handler for the mode being changed
777 * @param param The parameter for the mode or an empty string
778 * @param adding true of the mode is being added, false if it is being removed
779 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
780 * to skip all permission checking. Please note that for remote mode changes, your return value
783 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
785 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
786 * This method will always be called for each join, wether or not the channel is actually +k, and
787 * determines the outcome of an if statement around the whole section of key checking code.
788 * if the user specified no key, the keygiven string will be a valid but empty value.
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 * @param keygiven The key given on joining the channel.
793 * @return 1 to explicitly allow the join, 0 to proceed as normal
795 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
797 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
798 * This method will always be called for each join, wether or not the channel is actually +l, and
799 * determines the outcome of an if statement around the whole section of channel limit checking code.
800 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
801 * @param user The user joining the channel
802 * @param chan The channel being joined
803 * @return 1 to explicitly allow the join, 0 to proceed as normal
805 virtual ModResult OnCheckLimit(User* user, Channel* chan);
808 * Checks for a user's ban from the channel
809 * @param user The user to check
810 * @param chan The channel to check in
811 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
812 * ban check, or MOD_RES_PASSTHRU to check bans normally
814 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
817 * Checks for a user's match of a single ban
818 * @param user The user to check for match
819 * @param chan The channel on which the match is being checked
820 * @param mask The mask being checked
821 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
822 * ban check, or MOD_RES_PASSTHRU to check bans normally
824 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
826 /** Checks for a match on a given extban type
827 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
828 * ban check, or MOD_RES_PASSTHRU to check bans normally
830 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
832 /** Called whenever a change of a local users displayed host is attempted.
833 * Return 1 to deny the host change, or 0 to allow it.
834 * @param user The user whos host will be changed
835 * @param newhost The new hostname
836 * @return 1 to deny the host change, 0 to allow
838 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
840 /** Called whenever a change of a local users real name is attempted.
841 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
842 * @param user The user whos real name will be changed
843 * @param newhost The new real name.
844 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
846 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
848 /** Called before a topic is changed.
849 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
850 * As with other 'pre' events, you should only ever block a local event.
851 * @param user The user changing the topic
852 * @param chan The channels who's topic is being changed
853 * @param topic The actual topic text
854 * @return 1 to block the topic change, 0 to allow
856 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
858 /** Called whenever a topic has been changed.
859 * To block topic changes you must use OnPreTopicChange instead.
860 * @param user The user changing the topic
861 * @param chan The channels who's topic is being changed
862 * @param topic The actual topic text
864 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
866 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
867 * The password field (from the config file) is in 'password' and is to be compared against
868 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
869 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
870 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
871 * @param password The password from the configuration file (the password="" value).
872 * @param input The password entered by the user or whoever.
873 * @param hashtype The hash value from the config
874 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
876 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
878 /** Called after a user has fully connected and all modules have executed OnUserConnect
879 * This event is informational only. You should not change any user information in this
880 * event. To do so, use the OnUserConnect method to change the state of local users.
881 * This is called for both local and remote users.
882 * @param user The user who is connecting
884 virtual void OnPostConnect(User* user);
886 /** Called when a port accepts a connection
887 * Return MOD_RES_ACCEPT if you have used the file descriptor.
888 * @param fd The file descriptor returned from accept()
889 * @param sock The socket connection for the new user
890 * @param client The client IP address and port
891 * @param server The server IP address and port
893 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
895 /** Called at intervals for modules to garbage-collect any hashes etc.
896 * Certain data types such as hash_map 'leak' buckets, which must be
897 * tidied up and freed by copying into a new item every so often. This
898 * method is called when it is time to do that.
900 virtual void OnGarbageCollect();
902 /** Called when a user's connect class is being matched
903 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
904 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
906 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
908 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
909 * For example NAMESX, channel mode +u and +I, and UHNAMES.
910 * @param issuer The user who is going to receive the NAMES list being built
911 * @param item The channel member being considered for inclusion
912 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
913 * prefix mode the member has, can be changed
914 * @param nick The nick to display, initially set to the member's nick, can be changed
915 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
916 * excluded from this NAMES list
918 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
920 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
922 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
923 * a module like m_cgiirc changing it.
924 * @param user The user whose IP is being set
926 virtual void OnSetUserIP(LocalUser* user);
928 /** Called whenever a ServiceProvider is registered.
929 * @param service ServiceProvider being registered.
931 virtual void OnServiceAdd(ServiceProvider& service);
933 /** Called whenever a ServiceProvider is unregistered.
934 * @param service ServiceProvider being unregistered.
936 virtual void OnServiceDel(ServiceProvider& service);
938 /** Called whenever a message is about to be written to a user.
939 * @param user The user who is having a message sent to them.
940 * @param msg The message which is being written to the user.
941 * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
942 * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
944 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
947 /** ModuleManager takes care of all things module-related
950 class CoreExport ModuleManager : public fakederef<ModuleManager>
953 typedef std::vector<ServiceProvider*> ServiceList;
956 /** Holds a string describing the last module error to occur
958 std::string LastModuleError;
960 /** List of loaded modules and shared object/dll handles
961 * keyed by module name
963 std::map<std::string, Module*> Modules;
969 } prioritizationState;
971 /** Loads all core modules (core_*)
973 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
975 /** Calls the Prioritize() method in all loaded modules
976 * @return True if all went well, false if a dependency loop was detected
978 bool PrioritizeHooks();
980 /** Unregister all user modes or all channel modes owned by a module
981 * @param mod Module whose modes to unregister
982 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
984 void UnregisterModes(Module* mod, ModeType modetype);
987 typedef std::map<std::string, Module*> ModuleMap;
989 /** Event handler hooks.
990 * This needs to be public to be used by FOREACH_MOD and friends.
992 Module::List EventHandlers[I_END];
994 /** List of data services keyed by name */
995 std::multimap<std::string, ServiceProvider*> DataProviders;
997 /** A list of ServiceProviders waiting to be registered.
998 * Non-NULL when constructing a Module, NULL otherwise.
999 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1000 * automatically registers them (that is, call AddService()) after the Module is constructed,
1001 * and before Module::init() is called.
1002 * If a service is created after the construction of the Module (for example in init()) it
1003 * has to be registered manually.
1005 ServiceList* NewServices;
1007 /** Expands the name of a module by prepending "m_" and appending ".so".
1008 * No-op if the name already has the ".so" extension.
1009 * @param modname Module name to expand
1010 * @return Module name starting with "m_" and ending with ".so"
1012 static std::string ExpandModName(const std::string& modname);
1014 /** Simple, bog-standard, boring constructor.
1022 /** Change the priority of one event in a module.
1023 * Each module event has a list of modules which are attached to that event type.
1024 * If you wish to be called before or after other specific modules, you may use this
1025 * method (usually within void Module::Prioritize()) to set your events priority.
1026 * You may use this call in other methods too, however, this is not supported behaviour
1028 * @param mod The module to change the priority of
1029 * @param i The event to change the priority of
1030 * @param s The state you wish to use for this event. Use one of
1031 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1032 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1033 * to set it to be before or after one or more other modules.
1034 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1035 * then this contains a the module that your module must be placed before
1038 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1040 /** Change the priority of all events in a module.
1041 * @param mod The module to set the priority of
1042 * @param s The priority of all events in the module.
1043 * Note that with this method, it is not possible to effectively use
1044 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1045 * SetPriority method for this, where you may specify other modules to
1046 * be prioritized against.
1048 void SetPriority(Module* mod, Priority s);
1050 /** Attach an event to a module.
1051 * You may later detatch the event with ModuleManager::Detach().
1052 * If your module is unloaded, all events are automatically detatched.
1053 * @param i Event type to attach
1054 * @param mod Module to attach event to
1055 * @return True if the event was attached
1057 bool Attach(Implementation i, Module* mod);
1059 /** Detatch an event from a module.
1060 * This is not required when your module unloads, as the core will
1061 * automatically detatch your module from all events it is attached to.
1062 * @param i Event type to detach
1063 * @param mod Module to detach event from
1064 * @return True if the event was detached
1066 bool Detach(Implementation i, Module* mod);
1068 /** Attach an array of events to a module
1069 * @param i Event types (array) to attach
1070 * @param mod Module to attach events to
1071 * @param sz The size of the implementation array
1073 void Attach(Implementation* i, Module* mod, size_t sz);
1075 /** Detach all events from a module (used on unload)
1076 * @param mod Module to detach from
1078 void DetachAll(Module* mod);
1080 /** Attach all events to a module (used on module load)
1081 * @param mod Module to attach to all events
1083 void AttachAll(Module* mod);
1085 /** Returns text describing the last module error
1086 * @return The last error message to occur
1088 std::string& LastError();
1090 /** Load a given module file
1091 * @param filename The file to load
1092 * @param defer Defer module init (loading many modules)
1093 * @return True if the module was found and loaded
1095 bool Load(const std::string& filename, bool defer = false);
1097 /** Unload a given module file. Note that the module will not be
1098 * completely gone until the cull list has finished processing.
1100 * @return true on success; if false, LastError will give a reason
1102 bool Unload(Module* module);
1104 /** Called by the InspIRCd constructor to load all modules from the config file.
1108 void DoSafeUnload(Module*);
1110 /** Check if a module can be unloaded and if yes, prepare it for unload
1111 * @param mod Module to be unloaded
1112 * @return True if the module is unloadable, false otherwise.
1113 * If true the module must be unloaded in the current main loop iteration.
1115 bool CanUnload(Module* mod);
1117 /** Find a module by name, and return a Module* to it.
1118 * This is preferred over iterating the module lists yourself.
1119 * @param name The module name to look up
1120 * @return A pointer to the module, or NULL if the module cannot be found
1122 Module* Find(const std::string &name);
1124 /** Register a service provided by a module */
1125 void AddService(ServiceProvider&);
1127 /** Unregister a service provided by a module */
1128 void DelService(ServiceProvider&);
1130 /** Register all services in a given ServiceList
1131 * @param list The list containing the services to register
1133 void AddServices(const ServiceList& list);
1135 inline void AddServices(ServiceProvider** list, int count)
1137 for(int i=0; i < count; i++)
1138 AddService(*list[i]);
1141 /** Find a service by name.
1142 * If multiple modules provide a given service, the first one loaded will be chosen.
1144 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1146 template<typename T> inline T* FindDataService(const std::string& name)
1148 return static_cast<T*>(FindService(SERVICE_DATA, name));
1151 /** Get a map of all loaded modules keyed by their name
1152 * @return A ModuleMap containing all loaded modules
1154 const ModuleMap& GetModules() const { return Modules; }
1156 /** Make a service referenceable by dynamic_references
1157 * @param name Name that will be used by dynamic_references to find the object
1158 * @param service Service to make referenceable by dynamic_references
1160 void AddReferent(const std::string& name, ServiceProvider* service);
1162 /** Make a service no longer referenceable by dynamic_references
1163 * @param service Service to make no longer referenceable by dynamic_references
1165 void DelReferent(ServiceProvider* service);
1168 /** Do not mess with these functions unless you know the C preprocessor
1169 * well enough to explain why they are needed. The order is important.
1171 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1172 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1173 #define MODULE_INIT_STR_FN_1(x) #x
1174 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1175 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1176 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1178 /** This definition is used as shorthand for the various classes
1179 * and functions needed to make a module loadable by the OS.
1180 * It defines the class factory and external init_module function.
1182 #define MODULE_INIT(y) \
1183 extern "C" DllExport Module * MODULE_INIT_SYM() \
1187 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;