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,
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_OnChangeRealName, 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_OnPreChangeHost, I_OnPreTopicChange,
224 I_OnPostTopicChange, I_OnPostConnect, I_OnPostDeoper,
225 I_OnPreChangeRealName, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
226 I_OnPostOper, 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_OnChangeIdent, I_OnSetUserIP,
230 I_OnServiceAdd, I_OnServiceDel, I_OnUserWrite,
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 is about to invite another user into a channel, before any processing is done.
461 * Returning 1 from this function stops the process immediately, causing no
462 * output to be sent to the user by the core. If you do this you must produce your own numerics,
463 * notices etc. This is useful for modules which may want to filter invites to channels.
464 * @param source The user who is issuing the INVITE
465 * @param dest The user being invited
466 * @param channel The channel the user is being invited to
467 * @param timeout The time the invite will expire (0 == never)
468 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
470 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
472 /** Called after a user has been successfully invited to a channel.
473 * You cannot prevent the invite from occuring using this function, to do that,
474 * use OnUserPreInvite instead.
475 * @param source The user who is issuing the INVITE
476 * @param dest The user being invited
477 * @param channel The channel the user is being invited to
478 * @param timeout The time the invite will expire (0 == never)
479 * @param notifyrank Rank required to get an invite announcement (if enabled)
480 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
482 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
484 /** Called before a user sends a message to a channel, a user, or a server glob mask.
485 * @param user The user sending the message.
486 * @param target The target of the message. This can either be a channel, a user, or a server
488 * @param details Details about the message such as the message text and type. See the
489 * MessageDetails class for more information.
490 * @return MOD_RES_ALLOW to explicitly allow the message, MOD_RES_DENY to explicitly deny the
491 * message, or MOD_RES_PASSTHRU to let another module handle the event.
493 virtual ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details);
495 /** Called when sending a message to all "neighbors" of a given user -
496 * that is, all users that share a common channel. This is used in
497 * commands such as NICK, QUIT, etc.
498 * @param source The source of the message
499 * @param include_c Channels to scan for users to include
500 * @param exceptions Map of user->bool that overrides the inclusion decision
502 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
504 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
506 /** Called before local nickname changes. This can be used to implement Q-lines etc.
507 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
508 * module to generate some meaninful output.
509 * @param user The username changing their nick
510 * @param newnick Their new nickname
511 * @return 1 to deny the change, 0 to allow
513 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
515 /** Called immediately after a user sends a message to a channel, a user, or a server glob mask.
516 * @param user The user sending the message.
517 * @param target The target of the message. This can either be a channel, a user, or a server
519 * @param details Details about the message such as the message text and type. See the
520 * MessageDetails class for more information.
522 virtual void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details);
524 /** Called immediately before a user sends a message to a channel, a user, or a server glob mask.
525 * @param user The user sending the message.
526 * @param target The target of the message. This can either be a channel, a user, or a server
528 * @param details Details about the message such as the message text and type. See the
529 * MessageDetails class for more information.
531 virtual void OnUserMessage(User* user, const MessageTarget& target, const MessageDetails& details);
533 /** Called when a message sent by a user to a channel, a user, or a server glob mask is blocked.
534 * @param user The user sending the message.
535 * @param target The target of the message. This can either be a channel, a user, or a server
537 * @param details Details about the message such as the message text and type. See the
538 * MessageDetails class for more information.
540 virtual void OnUserMessageBlocked(User* user, const MessageTarget& target, const MessageDetails& details);
542 /** Called after every MODE command sent from a user
543 * Either the usertarget or the chantarget variable contains the target of the modes,
544 * the actual target will have a non-NULL pointer.
545 * All changed modes are available in the changelist object.
546 * @param user The user sending the MODEs
547 * @param usertarget The target user of the modes, NULL if the target is a channel
548 * @param chantarget The target channel of the modes, NULL if the target is a user
549 * @param changelist The changed modes.
550 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
551 * for the possible flags.
553 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags);
555 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
556 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
557 * @param target The Channel* or User* that data should be added to
558 * @param extname The extension name which is being sent
559 * @param extdata The extension data, encoded at the other end by an identical module
561 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
563 /** Called whenever a user's hostname is changed.
564 * This event triggers after the host has been set.
565 * @param user The user whos host is being changed
566 * @param newhost The new hostname being set
568 virtual void OnChangeHost(User* user, const std::string &newhost);
570 /** Called whenever a user's real name is changed.
571 * This event triggers after the name has been set.
572 * @param user The user who's real name is being changed
573 * @param real The new real name being set on the user
575 virtual void OnChangeRealName(User* user, const std::string& real);
577 /** Called whenever a user's IDENT is changed.
578 * This event triggers after the name has been set.
579 * @param user The user who's IDENT is being changed
580 * @param ident The new IDENT being set on the user
582 virtual void OnChangeIdent(User* user, const std::string &ident);
584 /** Called whenever an xline is added by a local user.
585 * This method is triggered after the line is added.
586 * @param source The sender of the line or NULL for local server
587 * @param line The xline being added
589 virtual void OnAddLine(User* source, XLine* line);
591 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
592 * This method is triggered after the line is deleted.
593 * @param source The user removing the line or NULL for local server
594 * @param line the line being deleted
596 virtual void OnDelLine(User* source, XLine* line);
598 /** Called whenever an xline expires.
599 * This method is triggered after the line is deleted.
600 * @param line The line being deleted.
602 virtual void OnExpireLine(XLine *line);
604 /** Called before the module is unloaded to clean up extensibles.
605 * This method is called once for every channel, membership, and user.
606 * so that you can clear up any data relating to the specified extensible.
607 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
608 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
609 * and EXT_USER then item is a User*.
610 * @param item A pointer to the extensible which is being cleaned up.
612 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
614 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
615 * have been applied. Please note that although you can see remote nickchanges through this function, you should
616 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
617 * check user->server before taking any action (including returning nonzero from the method).
618 * Because this method is called after the nickchange is taken place, no return values are possible
619 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
620 * @param user The user changing their nick
621 * @param oldnick The old nickname of the user before the nickchange
623 virtual void OnUserPostNick(User* user, const std::string &oldnick);
625 /** Called before a mode change via the MODE command, to allow a single access check for
626 * a full mode change (use OnRawMode to check individual modes)
628 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
629 * OnRawMode for each individual mode
631 * @param source the user making the mode change
632 * @param dest the user destination of the umode change (NULL if a channel mode)
633 * @param channel the channel destination of the mode change
634 * @param modes Modes being changed, can be edited
636 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
638 /** Called when a 005 numeric is about to be output.
639 * The module should modify the 005 numeric if needed to indicate its features.
640 * @param tokens The 005 map to be modified if neccessary.
642 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
644 /** Called when a client is disconnected by KILL.
645 * If a client is killed by a server, e.g. a nickname collision or protocol error,
647 * Return 1 from this function to prevent the kill, and 0 from this function to allow
648 * it as normal. If you prevent the kill no output will be sent to the client, it is
649 * down to your module to generate this information.
650 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
651 * If you do so youre risking race conditions, desyncs and worse!
652 * @param source The user sending the KILL
653 * @param dest The user being killed
654 * @param reason The kill reason
655 * @return 1 to prevent the kill, 0 to allow
657 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
659 /** Called whenever a module is loaded.
660 * mod will contain a pointer to the module, and string will contain its name,
661 * for example m_widgets.so. This function is primary for dependency checking,
662 * your module may decide to enable some extra features if it sees that you have
663 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
664 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
665 * but instead operate under reduced functionality, unless the dependency is
666 * absolutely neccessary (e.g. a module that extends the features of another
668 * @param mod A pointer to the new module
670 virtual void OnLoadModule(Module* mod);
672 /** Called whenever a module is unloaded.
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 Pointer to the module being unloaded (still valid)
683 virtual void OnUnloadModule(Module* mod);
685 /** Called once every five seconds for background processing.
686 * This timer can be used to control timed features. Its period is not accurate
687 * enough to be used as a clock, but it is gauranteed to be called at least once in
688 * any five second period, directly from the main loop of the server.
689 * @param curtime The current timer derived from time(2)
691 virtual void OnBackgroundTimer(time_t curtime);
693 /** Called whenever any command is about to be executed.
694 * This event occurs for all registered commands, wether they are registered in the core,
695 * or another module, and for invalid commands. Invalid commands may only be sent to this
696 * function when the value of validated is false. By returning 1 from this method you may prevent the
697 * command being executed. If you do this, no output is created by the core, and it is
698 * down to your module to produce any output neccessary.
699 * Note that unless you return 1, you should not destroy any structures (e.g. by using
700 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
701 * method returns, it will be passed an invalid pointer to the user object and crash!)
702 * @param command The command being executed
703 * @param parameters An array of array of characters containing the parameters for the command
704 * @param user the user issuing the command
705 * @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.
706 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
707 * @return 1 to block the command, 0 to allow
709 virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated);
711 /** Called after any command has been executed.
712 * This event occurs for all registered commands, wether they are registered in the core,
713 * or another module, but it will not occur for invalid commands (e.g. ones which do not
714 * exist within the command table). The result code returned by the command handler is
716 * @param command The command being executed
717 * @param parameters An array of array of characters containing the parameters for the command
718 * @param user the user issuing the command
719 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
720 * @param loop Whether the command is being called from LoopCall or directly.
722 virtual void OnPostCommand(Command* command, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop);
724 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
725 * connect class, or accepting any commands.
727 virtual void OnUserInit(LocalUser* user);
729 /** Called to check if a user who is connecting can now be allowed to register
730 * If any modules return false for this function, the user is held in the waiting
731 * state until all modules return true. For example a module which implements ident
732 * lookups will continue to return false for a user until their ident lookup is completed.
733 * Note that the registration timeout for a user overrides these checks, if the registration
734 * timeout is reached, the user is disconnected even if modules report that the user is
735 * not ready to connect.
736 * @param user The user to check
737 * @return true to indicate readiness, false if otherwise
739 virtual ModResult OnCheckReady(LocalUser* user);
741 /** Called whenever a user is about to register their connection (e.g. before the user
742 * is sent the MOTD etc). Modules can use this method if they are performing a function
743 * which must be done before the actual connection is completed (e.g. ident lookups,
744 * dnsbl lookups, etc).
745 * Note that you should NOT delete the user record here by causing a disconnection!
746 * Use OnUserConnect for that instead.
747 * @param user The user registering
748 * @return 1 to indicate user quit, 0 to continue
750 virtual ModResult OnUserRegister(LocalUser* user);
752 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
753 * This method will always be called for each join, wether or not the channel is actually +i, and
754 * determines the outcome of an if statement around the whole section of invite checking code.
755 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
756 * @param user The user joining the channel
757 * @param chan The channel being joined
758 * @return 1 to explicitly allow the join, 0 to proceed as normal
760 virtual ModResult OnCheckInvite(User* user, Channel* chan);
762 /** Called whenever a mode character is processed.
763 * Return 1 from this function to block the mode character from being processed entirely.
764 * @param user The user who is sending the mode
765 * @param chan The channel the mode is being sent to (or NULL if a usermode)
766 * @param mh The mode handler for the mode being changed
767 * @param param The parameter for the mode or an empty string
768 * @param adding true of the mode is being added, false if it is being removed
769 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
770 * to skip all permission checking. Please note that for remote mode changes, your return value
773 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
775 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
776 * This method will always be called for each join, wether or not the channel is actually +k, and
777 * determines the outcome of an if statement around the whole section of key checking code.
778 * if the user specified no key, the keygiven string will be a valid but empty value.
779 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
780 * @param user The user joining the channel
781 * @param chan The channel being joined
782 * @param keygiven The key given on joining the channel.
783 * @return 1 to explicitly allow the join, 0 to proceed as normal
785 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
787 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
788 * This method will always be called for each join, wether or not the channel is actually +l, and
789 * determines the outcome of an if statement around the whole section of channel limit checking code.
790 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
791 * @param user The user joining the channel
792 * @param chan The channel being joined
793 * @return 1 to explicitly allow the join, 0 to proceed as normal
795 virtual ModResult OnCheckLimit(User* user, Channel* chan);
798 * Checks for a user's ban from the channel
799 * @param user The user to check
800 * @param chan The channel to check in
801 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
802 * ban check, or MOD_RES_PASSTHRU to check bans normally
804 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
807 * Checks for a user's match of a single ban
808 * @param user The user to check for match
809 * @param chan The channel on which the match is being checked
810 * @param mask The mask being checked
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 OnCheckBan(User* user, Channel* chan, const std::string& mask);
816 /** Checks for a match on a given extban type
817 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
818 * ban check, or MOD_RES_PASSTHRU to check bans normally
820 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
822 /** Called whenever a change of a local users displayed host is attempted.
823 * Return 1 to deny the host change, or 0 to allow it.
824 * @param user The user whos host will be changed
825 * @param newhost The new hostname
826 * @return 1 to deny the host change, 0 to allow
828 virtual ModResult OnPreChangeHost(LocalUser* user, const std::string &newhost);
830 /** Called whenever a change of a local users real name is attempted.
831 * return MOD_RES_DENY to deny the name change, or MOD_RES_ALLOW to allow it.
832 * @param user The user whos real name will be changed
833 * @param newhost The new real name.
834 * @return MOD_RES_DENY to deny the real name change, MOD_RES_ALLOW to allow
836 virtual ModResult OnPreChangeRealName(LocalUser* user, const std::string &newhost);
838 /** Called before a topic is changed.
839 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
840 * As with other 'pre' events, you should only ever block a local event.
841 * @param user The user changing the topic
842 * @param chan The channels who's topic is being changed
843 * @param topic The actual topic text
844 * @return 1 to block the topic change, 0 to allow
846 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
848 /** Called whenever a topic has been changed.
849 * To block topic changes you must use OnPreTopicChange instead.
850 * @param user The user changing the topic
851 * @param chan The channels who's topic is being changed
852 * @param topic The actual topic text
854 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
856 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
857 * The password field (from the config file) is in 'password' and is to be compared against
858 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
859 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
860 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
861 * @param password The password from the configuration file (the password="" value).
862 * @param input The password entered by the user or whoever.
863 * @param hashtype The hash value from the config
864 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
866 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
868 /** Called after a user has fully connected and all modules have executed OnUserConnect
869 * This event is informational only. You should not change any user information in this
870 * event. To do so, use the OnUserConnect method to change the state of local users.
871 * This is called for both local and remote users.
872 * @param user The user who is connecting
874 virtual void OnPostConnect(User* user);
876 /** Called when a port accepts a connection
877 * Return MOD_RES_ACCEPT if you have used the file descriptor.
878 * @param fd The file descriptor returned from accept()
879 * @param sock The socket connection for the new user
880 * @param client The client IP address and port
881 * @param server The server IP address and port
883 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
885 /** Called at intervals for modules to garbage-collect any hashes etc.
886 * Certain data types such as hash_map 'leak' buckets, which must be
887 * tidied up and freed by copying into a new item every so often. This
888 * method is called when it is time to do that.
890 virtual void OnGarbageCollect();
892 /** Called when a user's connect class is being matched
893 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
894 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
896 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
898 #ifdef INSPIRCD_ENABLE_TESTSUITE
899 /** Add test suite hooks here. These are used for testing functionality of a module
900 * via the --testsuite debugging parameter.
902 virtual void OnRunTestSuite();
905 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
906 * For example NAMESX, channel mode +u and +I, and UHNAMES.
907 * @param issuer The user who is going to receive the NAMES list being built
908 * @param item The channel member being considered for inclusion
909 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
910 * prefix mode the member has, can be changed
911 * @param nick The nick to display, initially set to the member's nick, can be changed
912 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
913 * excluded from this NAMES list
915 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
917 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
919 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
920 * a module like m_cgiirc changing it.
921 * @param user The user whose IP is being set
923 virtual void OnSetUserIP(LocalUser* user);
925 /** Called whenever a ServiceProvider is registered.
926 * @param service ServiceProvider being registered.
928 virtual void OnServiceAdd(ServiceProvider& service);
930 /** Called whenever a ServiceProvider is unregistered.
931 * @param service ServiceProvider being unregistered.
933 virtual void OnServiceDel(ServiceProvider& service);
935 virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
938 /** ModuleManager takes care of all things module-related
941 class CoreExport ModuleManager : public fakederef<ModuleManager>
944 typedef std::vector<ServiceProvider*> ServiceList;
947 /** Holds a string describing the last module error to occur
949 std::string LastModuleError;
951 /** List of loaded modules and shared object/dll handles
952 * keyed by module name
954 std::map<std::string, Module*> Modules;
960 } prioritizationState;
962 /** Loads all core modules (core_*)
964 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
966 /** Calls the Prioritize() method in all loaded modules
967 * @return True if all went well, false if a dependency loop was detected
969 bool PrioritizeHooks();
971 /** Unregister all user modes or all channel modes owned by a module
972 * @param mod Module whose modes to unregister
973 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
975 void UnregisterModes(Module* mod, ModeType modetype);
978 typedef std::map<std::string, Module*> ModuleMap;
980 /** Event handler hooks.
981 * This needs to be public to be used by FOREACH_MOD and friends.
983 Module::List EventHandlers[I_END];
985 /** List of data services keyed by name */
986 std::multimap<std::string, ServiceProvider*> DataProviders;
988 /** A list of ServiceProviders waiting to be registered.
989 * Non-NULL when constructing a Module, NULL otherwise.
990 * When non-NULL ServiceProviders add themselves to this list on creation and the core
991 * automatically registers them (that is, call AddService()) after the Module is constructed,
992 * and before Module::init() is called.
993 * If a service is created after the construction of the Module (for example in init()) it
994 * has to be registered manually.
996 ServiceList* NewServices;
998 /** Expands the name of a module by prepending "m_" and appending ".so".
999 * No-op if the name already has the ".so" extension.
1000 * @param modname Module name to expand
1001 * @return Module name starting with "m_" and ending with ".so"
1003 static std::string ExpandModName(const std::string& modname);
1005 /** Simple, bog-standard, boring constructor.
1013 /** Change the priority of one event in a module.
1014 * Each module event has a list of modules which are attached to that event type.
1015 * If you wish to be called before or after other specific modules, you may use this
1016 * method (usually within void Module::Prioritize()) to set your events priority.
1017 * You may use this call in other methods too, however, this is not supported behaviour
1019 * @param mod The module to change the priority of
1020 * @param i The event to change the priority of
1021 * @param s The state you wish to use for this event. Use one of
1022 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1023 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1024 * to set it to be before or after one or more other modules.
1025 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1026 * then this contains a the module that your module must be placed before
1029 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1031 /** Change the priority of all events in a module.
1032 * @param mod The module to set the priority of
1033 * @param s The priority of all events in the module.
1034 * Note that with this method, it is not possible to effectively use
1035 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1036 * SetPriority method for this, where you may specify other modules to
1037 * be prioritized against.
1039 void SetPriority(Module* mod, Priority s);
1041 /** Attach an event to a module.
1042 * You may later detatch the event with ModuleManager::Detach().
1043 * If your module is unloaded, all events are automatically detatched.
1044 * @param i Event type to attach
1045 * @param mod Module to attach event to
1046 * @return True if the event was attached
1048 bool Attach(Implementation i, Module* mod);
1050 /** Detatch an event from a module.
1051 * This is not required when your module unloads, as the core will
1052 * automatically detatch your module from all events it is attached to.
1053 * @param i Event type to detach
1054 * @param mod Module to detach event from
1055 * @return True if the event was detached
1057 bool Detach(Implementation i, Module* mod);
1059 /** Attach an array of events to a module
1060 * @param i Event types (array) to attach
1061 * @param mod Module to attach events to
1062 * @param sz The size of the implementation array
1064 void Attach(Implementation* i, Module* mod, size_t sz);
1066 /** Detach all events from a module (used on unload)
1067 * @param mod Module to detach from
1069 void DetachAll(Module* mod);
1071 /** Attach all events to a module (used on module load)
1072 * @param mod Module to attach to all events
1074 void AttachAll(Module* mod);
1076 /** Returns text describing the last module error
1077 * @return The last error message to occur
1079 std::string& LastError();
1081 /** Load a given module file
1082 * @param filename The file to load
1083 * @param defer Defer module init (loading many modules)
1084 * @return True if the module was found and loaded
1086 bool Load(const std::string& filename, bool defer = false);
1088 /** Unload a given module file. Note that the module will not be
1089 * completely gone until the cull list has finished processing.
1091 * @return true on success; if false, LastError will give a reason
1093 bool Unload(Module* module);
1095 /** Called by the InspIRCd constructor to load all modules from the config file.
1099 void DoSafeUnload(Module*);
1101 /** Check if a module can be unloaded and if yes, prepare it for unload
1102 * @param mod Module to be unloaded
1103 * @return True if the module is unloadable, false otherwise.
1104 * If true the module must be unloaded in the current main loop iteration.
1106 bool CanUnload(Module* mod);
1108 /** Find a module by name, and return a Module* to it.
1109 * This is preferred over iterating the module lists yourself.
1110 * @param name The module name to look up
1111 * @return A pointer to the module, or NULL if the module cannot be found
1113 Module* Find(const std::string &name);
1115 /** Register a service provided by a module */
1116 void AddService(ServiceProvider&);
1118 /** Unregister a service provided by a module */
1119 void DelService(ServiceProvider&);
1121 /** Register all services in a given ServiceList
1122 * @param list The list containing the services to register
1124 void AddServices(const ServiceList& list);
1126 inline void AddServices(ServiceProvider** list, int count)
1128 for(int i=0; i < count; i++)
1129 AddService(*list[i]);
1132 /** Find a service by name.
1133 * If multiple modules provide a given service, the first one loaded will be chosen.
1135 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1137 template<typename T> inline T* FindDataService(const std::string& name)
1139 return static_cast<T*>(FindService(SERVICE_DATA, name));
1142 /** Get a map of all loaded modules keyed by their name
1143 * @return A ModuleMap containing all loaded modules
1145 const ModuleMap& GetModules() const { return Modules; }
1147 /** Make a service referenceable by dynamic_references
1148 * @param name Name that will be used by dynamic_references to find the object
1149 * @param service Service to make referenceable by dynamic_references
1151 void AddReferent(const std::string& name, ServiceProvider* service);
1153 /** Make a service no longer referenceable by dynamic_references
1154 * @param service Service to make no longer referenceable by dynamic_references
1156 void DelReferent(ServiceProvider* service);
1159 /** Do not mess with these functions unless you know the C preprocessor
1160 * well enough to explain why they are needed. The order is important.
1162 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1163 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1164 #define MODULE_INIT_STR_FN_1(x) #x
1165 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1166 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1167 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1169 /** This definition is used as shorthand for the various classes
1170 * and functions needed to make a module loadable by the OS.
1171 * It defines the class factory and external init_module function.
1173 #define MODULE_INIT(y) \
1174 extern "C" DllExport Module * MODULE_INIT_SYM() \
1178 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;