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 202
103 /** InspIRCd API version.
104 * If you change any API elements, increment this value. This counter should be
105 * reset whenever the major version is changed. Modules can use these two values
106 * and numerical comparisons in preprocessor macros if they wish to support
107 * multiple versions of InspIRCd in one file.
109 #define INSPIRCD_VERSION_API 1
112 * This #define allows us to call a method in all
113 * loaded modules in a readable simple way, e.g.:
114 * 'FOREACH_MOD(OnConnect,(user));'
116 #define FOREACH_MOD(y,x) do { \
117 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
118 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
125 catch (CoreException& modexcept) \
127 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
133 * Custom module result handling loop. This is a paired macro, and should only
134 * be used with while_each_hook.
136 * See src/channels.cpp for an example of use.
138 #define DO_EACH_HOOK(n,v,args) \
140 const Module::List& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
141 for (Module::List::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
148 #define WHILE_EACH_HOOK(n) \
150 catch (CoreException& except_ ## n) \
152 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
158 * Module result iterator
159 * Runs the given hook until some module returns a useful result.
161 * Example: ModResult result;
162 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
164 #define FIRST_MOD_RESULT(n,v,args) do { \
165 v = MOD_RES_PASSTHRU; \
166 DO_EACH_HOOK(n,v,args) \
168 if (v != MOD_RES_PASSTHRU) \
171 WHILE_EACH_HOOK(n); \
174 /** Holds a module's Version information.
175 * The members (set by the constructor only) indicate details as to the version number
176 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
178 class CoreExport Version
181 /** Module description
183 const std::string description;
189 /** Server linking description string */
190 const std::string link_data;
192 /** Simple module version */
193 Version(const std::string &desc, int flags = VF_NONE);
195 /** Complex version information, including linking compatability data */
196 Version(const std::string &desc, int flags, const std::string& linkdata);
199 class CoreExport DataProvider : public ServiceProvider
202 DataProvider(Module* Creator, const std::string& Name)
203 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
206 /** Priority types which can be used by Module::Prioritize()
208 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
210 /** Implementation-specific flags which may be set in Module::Implements()
214 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
215 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
216 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
217 I_OnUserPostMessage, I_OnUserMessageBlocked, I_OnMode,
218 I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
219 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
220 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
221 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
222 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
223 I_OnChangeLocalUserHost, I_OnPreTopicChange,
224 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
225 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
226 I_OnPostOper, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
227 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
228 I_OnUserMessage, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
229 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
230 I_OnServiceAdd, I_OnServiceDel,
234 /** Base class for all InspIRCd modules
235 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
236 * its methods will be called when irc server events occur. class inherited from module must be
237 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
239 class CoreExport Module : public classbase, public usecountbase
241 /** Detach an event from this module
242 * @param i Event type to detach
244 void DetachEvent(Implementation i);
247 /** A list of modules. */
248 typedef std::vector<Module*> List;
250 /** File that this module was loaded from
252 std::string ModuleSourceFile;
254 /** Reference to the dlopen() value
256 DLLManager* ModuleDLLManager;
258 /** If true, this module will be unloaded soon, further unload attempts will fail
259 * Value is used by the ModuleManager internally, you should not modify it
263 /** Default constructor.
264 * Creates a module class. Don't do any type of hook registration or checks
265 * for other modules here; do that in init().
270 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
272 virtual void init() {}
274 /** Clean up prior to destruction
275 * If you override, you must call this AFTER your module's cleanup
277 CullResult cull() CXX11_OVERRIDE;
279 /** Default destructor.
280 * destroys a module class
284 virtual void Prioritize()
288 /** This method is called when you should reload module specific configuration:
289 * on boot, on a /REHASH and on module load.
290 * @param status The current status, can be inspected for more information;
291 * also used for reporting configuration errors and warnings.
293 virtual void ReadConfig(ConfigStatus& status);
295 /** Returns the version number of a Module.
296 * The method should return a Version object with its version information assigned via
299 virtual Version GetVersion() = 0;
301 /** Called when a user connects.
302 * The details of the connecting user are available to you in the parameter User *user
303 * @param user The user who is connecting
305 virtual void OnUserConnect(LocalUser* user);
307 /** Called when a user quits.
308 * The details of the exiting user are available to you in the parameter User *user
309 * This event is only called when the user is fully registered when they quit. To catch
310 * raw disconnections, use the OnUserDisconnect method.
311 * @param user The user who is quitting
312 * @param message The user's quit message (as seen by non-opers)
313 * @param oper_message The user's quit message (as seen by opers)
315 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
317 /** Called whenever a user's socket is closed.
318 * The details of the exiting user are available to you in the parameter User *user
319 * This event is called for all users, registered or not, as a cleanup method for modules
320 * which might assign resources to user, such as dns lookups, objects and sockets.
321 * @param user The user who is disconnecting
323 virtual void OnUserDisconnect(LocalUser* user);
325 /** Called whenever a channel is about to be deleted
326 * @param chan The channel being deleted
327 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
329 virtual ModResult OnChannelPreDelete(Channel *chan);
331 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
332 * @param chan The channel being deleted
334 virtual void OnChannelDelete(Channel* chan);
336 /** Called when a user joins a channel.
337 * The details of the joining user are available to you in the parameter User *user,
338 * and the details of the channel they have joined is available in the variable Channel *channel
339 * @param memb The channel membership being created
340 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
341 * to a channel due to the network sync.
342 * @param created This is true if the join created the channel
343 * @param except_list A list of users not to send to.
345 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
347 /** Called after a user joins a channel
348 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
350 * @param memb The channel membership created
352 virtual void OnPostJoin(Membership* memb);
354 /** Called when a user parts a channel.
355 * The details of the leaving user are available to you in the parameter User *user,
356 * and the details of the channel they have left is available in the variable Channel *channel
357 * @param memb The channel membership being destroyed
358 * @param partmessage The part message, or an empty string (may be modified)
359 * @param except_list A list of users to not send to.
361 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
363 /** Called on rehash.
364 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
365 * system. This is called in all cases -- including when this server will not execute the
366 * rehash because it is directed at a remote server.
368 * @param user The user performing the rehash, if any. If this is server initiated, the value of
369 * this variable will be NULL.
370 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
373 virtual void OnPreRehash(User* user, const std::string ¶meter);
375 /** Called on rehash.
376 * This method is called when a user initiates a module-specific rehash. This can be used to do
377 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
378 * rehash for efficiency. A rehash of this type does not reload the core configuration.
380 * @param user The user performing the rehash.
381 * @param parameter The parameter given to REHASH
383 virtual void OnModuleRehash(User* user, const std::string ¶meter);
385 /** Called whenever a snotice is about to be sent to a snomask.
386 * snomask and type may both be modified; the message may not.
387 * @param snomask The snomask the message is going to (e.g. 'A')
388 * @param type The textual description the snomask will go to (e.g. 'OPER')
389 * @param message The text message to be sent via snotice
390 * @return 1 to block the snotice from being sent entirely, 0 else.
392 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
394 /** Called whenever a user is about to join a channel, before any processing is done.
395 * Returning a value of 1 from this function stops the process immediately, causing no
396 * output to be sent to the user by the core. If you do this you must produce your own numerics,
397 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
398 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
402 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
403 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
404 * processing on the actual channel record at this point, however the channel NAME will still be passed in
405 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
406 * @param user The user joining the channel
407 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
408 * @param cname The channel name being joined. For new channels this is valid where chan is not.
409 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
410 * You may alter this string to alter the user's modes on the channel.
411 * @param keygiven The key given to join the channel, or an empty string if none was provided
412 * @return 1 To prevent the join, 0 to allow it.
414 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
416 /** Called whenever a user is about to be kicked.
417 * Returning a value of 1 from this function stops the process immediately, causing no
418 * output to be sent to the user by the core. If you do this you must produce your own numerics,
420 * @param source The user issuing the kick
421 * @param memb The channel membership of the user who is being kicked.
422 * @param reason The kick reason
423 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
425 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
427 /** Called whenever a user is kicked.
428 * If this method is called, the kick is already underway and cannot be prevented, so
429 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
430 * @param source The user issuing the kick
431 * @param memb The channel membership of the user who was kicked.
432 * @param reason The kick reason
433 * @param except_list A list of users to not send to.
435 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
437 /** Called whenever a user opers locally.
438 * The User will contain the oper mode 'o' as this function is called after any modifications
439 * are made to the user's structure by the core.
440 * @param user The user who is opering up
441 * @param opertype The opers type name
443 virtual void OnOper(User* user, const std::string &opertype);
445 /** Called after a user opers locally.
446 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
447 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
448 * out the OPERTYPE, etc.
449 * @param user The user who is opering up
450 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
451 * @param opertype The opers type name
453 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
455 /** Called after a user deopers locally.
456 * @param user The user who has deopered.
458 virtual void OnPostDeoper(User* user);
460 /** Called whenever a user types /INFO.
461 * The User will contain the information of the user who typed the command. Modules may use this
462 * method to output their own credits in /INFO (which is the ircd's version of an about box).
463 * It is purposefully not possible to modify any info that has already been output, or halt the list.
464 * You must write a 371 numeric to the user, containing your info in the following format:
466 * <nick> :information here
468 * @param user The user issuing /INFO
470 virtual void OnInfo(User* user);
472 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
473 * Returning 1 from this function stops the process immediately, causing no
474 * output to be sent to the user by the core. If you do this you must produce your own numerics,
475 * notices etc. This is useful for modules which may want to filter invites to channels.
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 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
482 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
484 /** Called after a user has been successfully invited to a channel.
485 * You cannot prevent the invite from occuring using this function, to do that,
486 * use OnUserPreInvite instead.
487 * @param source The user who is issuing the INVITE
488 * @param dest The user being invited
489 * @param channel The channel the user is being invited to
490 * @param timeout The time the invite will expire (0 == never)
491 * @param notifyrank Rank required to get an invite announcement (if enabled)
492 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
494 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
496 /** Called before a user sends a message to a channel, a user, or a server glob mask.
497 * @param user The user sending the message.
498 * @param target The target of the message. This can either be a channel, a user, or a server
500 * @param details Details about the message such as the message text and type. See the
501 * MessageDetails class for more information.
502 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
503 * message, or MOD_RES_PASSTHRU to let another module handle the event.
505 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
507 /** Called when sending a message to all "neighbors" of a given user -
508 * that is, all users that share a common channel. This is used in
509 * commands such as NICK, QUIT, etc.
510 * @param source The source of the message
511 * @param include_c Channels to scan for users to include
512 * @param exceptions Map of user->bool that overrides the inclusion decision
514 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
516 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
518 /** Called before local nickname changes. This can be used to implement Q-lines etc.
519 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
520 * module to generate some meaninful output.
521 * @param user The username changing their nick
522 * @param newnick Their new nickname
523 * @return 1 to deny the change, 0 to allow
525 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
527 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
528 * @param user The user sending the message.
529 * @param target The target of the message. This can either be a channel, a user, or a server
531 * @param details Details about the message such as the message text and type. See the
532 * MessageDetails class for more information.
534 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
536 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
537 * @param user The user sending the message.
538 * @param target The target of the message. This can either be a channel, a user, or a server
540 * @param details Details about the message such as the message text and type. See the
541 * MessageDetails class for more information.
543 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
545 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
546 * @param user The user sending the message.
547 * @param target The target of the message. This can either be a channel, a user, or a server
549 * @param details Details about the message such as the message text and type. See the
550 * MessageDetails class for more information.
552 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
554 /** Called after every MODE command sent from a user
555 * Either the usertarget or the chantarget variable contains the target of the modes,
556 * the actual target will have a non-NULL pointer.
557 * All changed modes are available in the changelist object.
558 * @param user The user sending the MODEs
559 * @param usertarget The target user of the modes, NULL if the target is a channel
560 * @param chantarget The target channel of the modes, NULL if the target is a user
561 * @param changelist The changed modes.
562 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
563 * for the possible flags.
564 * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
566 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
568 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
569 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
570 * @param target The Channel* or User* that data should be added to
571 * @param extname The extension name which is being sent
572 * @param extdata The extension data, encoded at the other end by an identical module
574 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
576 /** Called whenever a user's hostname is changed.
577 * This event triggers after the host has been set.
578 * @param user The user whos host is being changed
579 * @param newhost The new hostname being set
581 virtual void OnChangeHost(User* user, const std::string &newhost);
583 /** Called whenever a user's GECOS (realname) is changed.
584 * This event triggers after the name has been set.
585 * @param user The user who's GECOS is being changed
586 * @param gecos The new GECOS being set on the user
588 virtual void OnChangeName(User* user, const std::string &gecos);
590 /** Called whenever a user's IDENT is changed.
591 * This event triggers after the name has been set.
592 * @param user The user who's IDENT is being changed
593 * @param ident The new IDENT being set on the user
595 virtual void OnChangeIdent(User* user, const std::string &ident);
597 /** Called whenever an xline is added by a local user.
598 * This method is triggered after the line is added.
599 * @param source The sender of the line or NULL for local server
600 * @param line The xline being added
602 virtual void OnAddLine(User* source, XLine* line);
604 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
605 * This method is triggered after the line is deleted.
606 * @param source The user removing the line or NULL for local server
607 * @param line the line being deleted
609 virtual void OnDelLine(User* source, XLine* line);
611 /** Called whenever an xline expires.
612 * This method is triggered after the line is deleted.
613 * @param line The line being deleted.
615 virtual void OnExpireLine(XLine *line);
617 /** Called before the module is unloaded to clean up extensibles.
618 * This method is called once for every channel, membership, and user.
619 * so that you can clear up any data relating to the specified extensible.
620 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
621 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
622 * and EXT_USER then item is a User*.
623 * @param item A pointer to the extensible which is being cleaned up.
625 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
627 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
628 * have been applied. Please note that although you can see remote nickchanges through this function, you should
629 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
630 * check user->server before taking any action (including returning nonzero from the method).
631 * Because this method is called after the nickchange is taken place, no return values are possible
632 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
633 * @param user The user changing their nick
634 * @param oldnick The old nickname of the user before the nickchange
636 virtual void OnUserPostNick(User* user, const std::string &oldnick);
638 /** Called before a mode change via the MODE command, to allow a single access check for
639 * a full mode change (use OnRawMode to check individual modes)
641 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
642 * OnRawMode for each individual mode
644 * @param source the user making the mode change
645 * @param dest the user destination of the umode change (NULL if a channel mode)
646 * @param channel the channel destination of the mode change
647 * @param modes Modes being changed, can be edited
649 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
651 /** Called when a 005 numeric is about to be output.
652 * The module should modify the 005 numeric if needed to indicate its features.
653 * @param tokens The 005 map to be modified if neccessary.
655 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
657 /** Called when a client is disconnected by KILL.
658 * If a client is killed by a server, e.g. a nickname collision or protocol error,
660 * Return 1 from this function to prevent the kill, and 0 from this function to allow
661 * it as normal. If you prevent the kill no output will be sent to the client, it is
662 * down to your module to generate this information.
663 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
664 * If you do so youre risking race conditions, desyncs and worse!
665 * @param source The user sending the KILL
666 * @param dest The user being killed
667 * @param reason The kill reason
668 * @return 1 to prevent the kill, 0 to allow
670 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
672 /** Called whenever a module is loaded.
673 * mod will contain a pointer to the module, and string will contain its name,
674 * for example m_widgets.so. This function is primary for dependency checking,
675 * your module may decide to enable some extra features if it sees that you have
676 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
677 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
678 * but instead operate under reduced functionality, unless the dependency is
679 * absolutely neccessary (e.g. a module that extends the features of another
681 * @param mod A pointer to the new module
683 virtual void OnLoadModule(Module* mod);
685 /** Called whenever a module is unloaded.
686 * mod will contain a pointer to the module, and string will contain its name,
687 * for example m_widgets.so. This function is primary for dependency checking,
688 * your module may decide to enable some extra features if it sees that you have
689 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
690 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
691 * but instead operate under reduced functionality, unless the dependency is
692 * absolutely neccessary (e.g. a module that extends the features of another
694 * @param mod Pointer to the module being unloaded (still valid)
696 virtual void OnUnloadModule(Module* mod);
698 /** Called once every five seconds for background processing.
699 * This timer can be used to control timed features. Its period is not accurate
700 * enough to be used as a clock, but it is gauranteed to be called at least once in
701 * any five second period, directly from the main loop of the server.
702 * @param curtime The current timer derived from time(2)
704 virtual void OnBackgroundTimer(time_t curtime);
706 /** Called whenever any command is about to be executed.
707 * This event occurs for all registered commands, wether they are registered in the core,
708 * or another module, and for invalid commands. Invalid commands may only be sent to this
709 * function when the value of validated is false. By returning 1 from this method you may prevent the
710 * command being executed. If you do this, no output is created by the core, and it is
711 * down to your module to produce any output neccessary.
712 * Note that unless you return 1, you should not destroy any structures (e.g. by using
713 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
714 * method returns, it will be passed an invalid pointer to the user object and crash!)
715 * @param command The command being executed
716 * @param parameters An array of array of characters containing the parameters for the command
717 * @param user the user issuing the command
718 * @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.
719 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
720 * @param original_line The entire original line as passed to the parser from the user
721 * @return 1 to block the command, 0 to allow
723 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
725 /** Called after any command has been executed.
726 * This event occurs for all registered commands, wether they are registered in the core,
727 * or another module, but it will not occur for invalid commands (e.g. ones which do not
728 * exist within the command table). The result code returned by the command handler is
730 * @param command The command being executed
731 * @param parameters An array of array of characters containing the parameters for the command
732 * @param user the user issuing the command
733 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
734 * @param original_line The entire original line as passed to the parser from the user
736 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
738 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
739 * connect class, or accepting any commands.
741 virtual void OnUserInit(LocalUser* user);
743 /** Called to check if a user who is connecting can now be allowed to register
744 * If any modules return false for this function, the user is held in the waiting
745 * state until all modules return true. For example a module which implements ident
746 * lookups will continue to return false for a user until their ident lookup is completed.
747 * Note that the registration timeout for a user overrides these checks, if the registration
748 * timeout is reached, the user is disconnected even if modules report that the user is
749 * not ready to connect.
750 * @param user The user to check
751 * @return true to indicate readiness, false if otherwise
753 virtual ModResult OnCheckReady(LocalUser* user);
755 /** Called whenever a user is about to register their connection (e.g. before the user
756 * is sent the MOTD etc). Modules can use this method if they are performing a function
757 * which must be done before the actual connection is completed (e.g. ident lookups,
758 * dnsbl lookups, etc).
759 * Note that you should NOT delete the user record here by causing a disconnection!
760 * Use OnUserConnect for that instead.
761 * @param user The user registering
762 * @return 1 to indicate user quit, 0 to continue
764 virtual ModResult OnUserRegister(LocalUser* user);
766 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
767 * This method will always be called for each join, wether or not the channel is actually +i, and
768 * determines the outcome of an if statement around the whole section of invite checking code.
769 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
770 * @param user The user joining the channel
771 * @param chan The channel being joined
772 * @return 1 to explicitly allow the join, 0 to proceed as normal
774 virtual ModResult OnCheckInvite(User* user, Channel* chan);
776 /** Called whenever a mode character is processed.
777 * Return 1 from this function to block the mode character from being processed entirely.
778 * @param user The user who is sending the mode
779 * @param chan The channel the mode is being sent to (or NULL if a usermode)
780 * @param mh The mode handler for the mode being changed
781 * @param param The parameter for the mode or an empty string
782 * @param adding true of the mode is being added, false if it is being removed
783 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
784 * to skip all permission checking. Please note that for remote mode changes, your return value
787 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
789 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
790 * This method will always be called for each join, wether or not the channel is actually +k, and
791 * determines the outcome of an if statement around the whole section of key checking code.
792 * if the user specified no key, the keygiven string will be a valid but empty value.
793 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
794 * @param user The user joining the channel
795 * @param chan The channel being joined
796 * @param keygiven The key given on joining the channel.
797 * @return 1 to explicitly allow the join, 0 to proceed as normal
799 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
801 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
802 * This method will always be called for each join, wether or not the channel is actually +l, and
803 * determines the outcome of an if statement around the whole section of channel limit checking code.
804 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
805 * @param user The user joining the channel
806 * @param chan The channel being joined
807 * @return 1 to explicitly allow the join, 0 to proceed as normal
809 virtual ModResult OnCheckLimit(User* user, Channel* chan);
812 * Checks for a user's ban from the channel
813 * @param user The user to check
814 * @param chan The channel to check in
815 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
816 * ban check, or MOD_RES_PASSTHRU to check bans normally
818 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
821 * Checks for a user's match of a single ban
822 * @param user The user to check for match
823 * @param chan The channel on which the match is being checked
824 * @param mask The mask being checked
825 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
826 * ban check, or MOD_RES_PASSTHRU to check bans normally
828 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
830 /** Checks for a match on a given extban type
831 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
832 * ban check, or MOD_RES_PASSTHRU to check bans normally
834 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
836 /** Called whenever a change of a local users displayed host is attempted.
837 * Return 1 to deny the host change, or 0 to allow it.
838 * @param user The user whos host will be changed
839 * @param newhost The new hostname
840 * @return 1 to deny the host change, 0 to allow
842 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
844 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
845 * return 1 to deny the name change, or 0 to allow it.
846 * @param user The user whos GECOS will be changed
847 * @param newhost The new GECOS
848 * @return 1 to deny the GECOS change, 0 to allow
850 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
852 /** Called before a topic is changed.
853 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
854 * As with other 'pre' events, you should only ever block a local event.
855 * @param user The user changing the topic
856 * @param chan The channels who's topic is being changed
857 * @param topic The actual topic text
858 * @return 1 to block the topic change, 0 to allow
860 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
862 /** Called whenever a topic has been changed.
863 * To block topic changes you must use OnPreTopicChange instead.
864 * @param user The user changing the topic
865 * @param chan The channels who's topic is being changed
866 * @param topic The actual topic text
868 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
870 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
871 * The password field (from the config file) is in 'password' and is to be compared against
872 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
873 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
874 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
875 * @param password The password from the configuration file (the password="" value).
876 * @param input The password entered by the user or whoever.
877 * @param hashtype The hash value from the config
878 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
880 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
882 /** Called after a user has fully connected and all modules have executed OnUserConnect
883 * This event is informational only. You should not change any user information in this
884 * event. To do so, use the OnUserConnect method to change the state of local users.
885 * This is called for both local and remote users.
886 * @param user The user who is connecting
888 virtual void OnPostConnect(User* user);
890 /** Called when a port accepts a connection
891 * Return MOD_RES_ACCEPT if you have used the file descriptor.
892 * @param fd The file descriptor returned from accept()
893 * @param sock The socket connection for the new user
894 * @param client The client IP address and port
895 * @param server The server IP address and port
897 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
899 /** Called whenever a user sets away or returns from being away.
900 * The away message is available as a parameter, but should not be modified.
901 * At this stage, it has already been copied into the user record.
902 * If awaymsg is empty, the user is returning from away.
903 * @param user The user setting away
904 * @param awaymsg The away message of the user, or empty if returning from away
905 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
907 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
909 /** Called at intervals for modules to garbage-collect any hashes etc.
910 * Certain data types such as hash_map 'leak' buckets, which must be
911 * tidied up and freed by copying into a new item every so often. This
912 * method is called when it is time to do that.
914 virtual void OnGarbageCollect();
916 /** Called when a user's connect class is being matched
917 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
918 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
920 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
922 #ifdef INSPIRCD_ENABLE_TESTSUITE
923 /** Add test suite hooks here. These are used for testing functionality of a module
924 * via the --testsuite debugging parameter.
926 virtual void OnRunTestSuite();
929 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
930 * For example NAMESX, channel mode +u and +I, and UHNAMES.
931 * @param issuer The user who is going to receive the NAMES list being built
932 * @param item The channel member being considered for inclusion
933 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
934 * prefix mode the member has, can be changed
935 * @param nick The nick to display, initially set to the member's nick, can be changed
936 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
937 * excluded from this NAMES list
939 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
941 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
943 /** Called whenever a result from /WHO is about to be returned
944 * @param source The user running the /WHO query
945 * @param params The parameters to the /WHO query
946 * @param user The user that this line of the query is about
947 * @param memb The member shown in this line, NULL if no channel is in this line
948 * @param numeric Numeric to send; modifiable.
949 * @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
951 virtual ModResult OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, Numeric::Numeric& numeric);
953 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
954 * a module like m_cgiirc changing it.
955 * @param user The user whose IP is being set
957 virtual void OnSetUserIP(LocalUser* user);
959 /** Called whenever a ServiceProvider is registered.
960 * @param service ServiceProvider being registered.
962 virtual void OnServiceAdd(ServiceProvider& service);
964 /** Called whenever a ServiceProvider is unregistered.
965 * @param service ServiceProvider being unregistered.
967 virtual void OnServiceDel(ServiceProvider& service);
970 /** ModuleManager takes care of all things module-related
973 class CoreExport ModuleManager : public fakederef<ModuleManager>
976 typedef std::vector<ServiceProvider*> ServiceList;
979 /** Holds a string describing the last module error to occur
981 std::string LastModuleError;
983 /** List of loaded modules and shared object/dll handles
984 * keyed by module name
986 std::map<std::string, Module*> Modules;
992 } prioritizationState;
994 /** Loads all core modules (core_*)
996 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
998 /** Calls the Prioritize() method in all loaded modules
999 * @return True if all went well, false if a dependency loop was detected
1001 bool PrioritizeHooks();
1003 /** Unregister all user modes or all channel modes owned by a module
1004 * @param mod Module whose modes to unregister
1005 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1007 void UnregisterModes(Module* mod, ModeType modetype);
1010 typedef std::map<std::string, Module*> ModuleMap;
1012 /** Event handler hooks.
1013 * This needs to be public to be used by FOREACH_MOD and friends.
1015 Module::List EventHandlers[I_END];
1017 /** List of data services keyed by name */
1018 std::multimap<std::string, ServiceProvider*> DataProviders;
1020 /** A list of ServiceProviders waiting to be registered.
1021 * Non-NULL when constructing a Module, NULL otherwise.
1022 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1023 * automatically registers them (that is, call AddService()) after the Module is constructed,
1024 * and before Module::init() is called.
1025 * If a service is created after the construction of the Module (for example in init()) it
1026 * has to be registered manually.
1028 ServiceList* NewServices;
1030 /** Expands the name of a module by prepending "m_" and appending ".so".
1031 * No-op if the name already has the ".so" extension.
1032 * @param modname Module name to expand
1033 * @return Module name starting with "m_" and ending with ".so"
1035 static std::string ExpandModName(const std::string& modname);
1037 /** Simple, bog-standard, boring constructor.
1045 /** Change the priority of one event in a module.
1046 * Each module event has a list of modules which are attached to that event type.
1047 * If you wish to be called before or after other specific modules, you may use this
1048 * method (usually within void Module::Prioritize()) to set your events priority.
1049 * You may use this call in other methods too, however, this is not supported behaviour
1051 * @param mod The module to change the priority of
1052 * @param i The event to change the priority of
1053 * @param s The state you wish to use for this event. Use one of
1054 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1055 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1056 * to set it to be before or after one or more other modules.
1057 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1058 * then this contains a the module that your module must be placed before
1061 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1063 /** Change the priority of all events in a module.
1064 * @param mod The module to set the priority of
1065 * @param s The priority of all events in the module.
1066 * Note that with this method, it is not possible to effectively use
1067 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1068 * SetPriority method for this, where you may specify other modules to
1069 * be prioritized against.
1071 void SetPriority(Module* mod, Priority s);
1073 /** Attach an event to a module.
1074 * You may later detatch the event with ModuleManager::Detach().
1075 * If your module is unloaded, all events are automatically detatched.
1076 * @param i Event type to attach
1077 * @param mod Module to attach event to
1078 * @return True if the event was attached
1080 bool Attach(Implementation i, Module* mod);
1082 /** Detatch an event from a module.
1083 * This is not required when your module unloads, as the core will
1084 * automatically detatch your module from all events it is attached to.
1085 * @param i Event type to detach
1086 * @param mod Module to detach event from
1087 * @return True if the event was detached
1089 bool Detach(Implementation i, Module* mod);
1091 /** Attach an array of events to a module
1092 * @param i Event types (array) to attach
1093 * @param mod Module to attach events to
1094 * @param sz The size of the implementation array
1096 void Attach(Implementation* i, Module* mod, size_t sz);
1098 /** Detach all events from a module (used on unload)
1099 * @param mod Module to detach from
1101 void DetachAll(Module* mod);
1103 /** Attach all events to a module (used on module load)
1104 * @param mod Module to attach to all events
1106 void AttachAll(Module* mod);
1108 /** Returns text describing the last module error
1109 * @return The last error message to occur
1111 std::string& LastError();
1113 /** Load a given module file
1114 * @param filename The file to load
1115 * @param defer Defer module init (loading many modules)
1116 * @return True if the module was found and loaded
1118 bool Load(const std::string& filename, bool defer = false);
1120 /** Unload a given module file. Note that the module will not be
1121 * completely gone until the cull list has finished processing.
1123 * @return true on success; if false, LastError will give a reason
1125 bool Unload(Module* module);
1127 /** Called by the InspIRCd constructor to load all modules from the config file.
1131 void DoSafeUnload(Module*);
1133 /** Check if a module can be unloaded and if yes, prepare it for unload
1134 * @param mod Module to be unloaded
1135 * @return True if the module is unloadable, false otherwise.
1136 * If true the module must be unloaded in the current main loop iteration.
1138 bool CanUnload(Module* mod);
1140 /** Find a module by name, and return a Module* to it.
1141 * This is preferred over iterating the module lists yourself.
1142 * @param name The module name to look up
1143 * @return A pointer to the module, or NULL if the module cannot be found
1145 Module* Find(const std::string &name);
1147 /** Register a service provided by a module */
1148 void AddService(ServiceProvider&);
1150 /** Unregister a service provided by a module */
1151 void DelService(ServiceProvider&);
1153 /** Register all services in a given ServiceList
1154 * @param list The list containing the services to register
1156 void AddServices(const ServiceList& list);
1158 inline void AddServices(ServiceProvider** list, int count)
1160 for(int i=0; i < count; i++)
1161 AddService(*list[i]);
1164 /** Find a service by name.
1165 * If multiple modules provide a given service, the first one loaded will be chosen.
1167 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1169 template<typename T> inline T* FindDataService(const std::string& name)
1171 return static_cast<T*>(FindService(SERVICE_DATA, name));
1174 /** Get a map of all loaded modules keyed by their name
1175 * @return A ModuleMap containing all loaded modules
1177 const ModuleMap& GetModules() const { return Modules; }
1179 /** Make a service referenceable by dynamic_references
1180 * @param name Name that will be used by dynamic_references to find the object
1181 * @param service Service to make referenceable by dynamic_references
1183 void AddReferent(const std::string& name, ServiceProvider* service);
1185 /** Make a service no longer referenceable by dynamic_references
1186 * @param service Service to make no longer referenceable by dynamic_references
1188 void DelReferent(ServiceProvider* service);
1191 /** Do not mess with these functions unless you know the C preprocessor
1192 * well enough to explain why they are needed. The order is important.
1194 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1195 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1196 #define MODULE_INIT_STR_FN_1(x) #x
1197 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1198 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1199 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1201 #ifdef INSPIRCD_STATIC
1203 struct AllCommandList {
1204 typedef Command* (*fn)(Module*);
1205 AllCommandList(fn cmd);
1207 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1208 static const AllCommandList PREP_ ## x(&MK_ ## x);
1210 struct AllModuleList {
1211 typedef Module* (*fn)();
1214 AllModuleList(fn mod, const std::string& Name);
1217 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1218 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1222 /** This definition is used as shorthand for the various classes
1223 * and functions needed to make a module loadable by the OS.
1224 * It defines the class factory and external init_module function.
1226 #define MODULE_INIT(y) \
1227 extern "C" DllExport Module * MODULE_INIT_SYM() \
1231 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
1233 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)