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 /** Used to represent an event type, for user, channel or server
59 enum TargetTypeFlags {
66 /** Used to represent wether a message was PRIVMSG or NOTICE
73 #define MOD_RES_ALLOW (ModResult(1))
74 #define MOD_RES_PASSTHRU (ModResult(0))
75 #define MOD_RES_DENY (ModResult(-1))
77 /** Used to represent an allow/deny module result.
78 * Not constructed as an enum because it reverses the value logic of some functions;
79 * the compiler will inline accesses to have the same efficiency as integer operations.
83 ModResult() : res(0) {}
84 explicit ModResult(int r) : res(r) {}
85 inline bool operator==(const ModResult& r) const
89 inline bool operator!=(const ModResult& r) const
93 inline bool operator!() const
97 inline bool check(bool def) const
99 return (res == 1 || (res == 0 && def));
102 * Merges two results, preferring ALLOW to DENY
104 inline ModResult operator+(const ModResult& r) const
106 if (res == r.res || r.res == 0)
110 // they are different, and neither is passthru
111 return MOD_RES_ALLOW;
115 /** InspIRCd major version.
116 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
118 #define INSPIRCD_VERSION_MAJ 202
119 /** InspIRCd API version.
120 * If you change any API elements, increment this value. This counter should be
121 * reset whenever the major version is changed. Modules can use these two values
122 * and numerical comparisons in preprocessor macros if they wish to support
123 * multiple versions of InspIRCd in one file.
125 #define INSPIRCD_VERSION_API 1
128 * This #define allows us to call a method in all
129 * loaded modules in a readable simple way, e.g.:
130 * 'FOREACH_MOD(OnConnect,(user));'
132 #define FOREACH_MOD(y,x) do { \
133 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
134 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
141 catch (CoreException& modexcept) \
143 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
149 * Custom module result handling loop. This is a paired macro, and should only
150 * be used with while_each_hook.
152 * See src/channels.cpp for an example of use.
154 #define DO_EACH_HOOK(n,v,args) \
156 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
157 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
164 #define WHILE_EACH_HOOK(n) \
166 catch (CoreException& except_ ## n) \
168 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
174 * Module result iterator
175 * Runs the given hook until some module returns a useful result.
177 * Example: ModResult result;
178 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
180 #define FIRST_MOD_RESULT(n,v,args) do { \
181 v = MOD_RES_PASSTHRU; \
182 DO_EACH_HOOK(n,v,args) \
184 if (v != MOD_RES_PASSTHRU) \
187 WHILE_EACH_HOOK(n); \
190 /** Holds a module's Version information.
191 * The members (set by the constructor only) indicate details as to the version number
192 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
194 class CoreExport Version
197 /** Module description
199 const std::string description;
205 /** Server linking description string */
206 const std::string link_data;
208 /** Simple module version */
209 Version(const std::string &desc, int flags = VF_NONE);
211 /** Complex version information, including linking compatability data */
212 Version(const std::string &desc, int flags, const std::string& linkdata);
215 class CoreExport DataProvider : public ServiceProvider
218 DataProvider(Module* Creator, const std::string& Name)
219 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
222 /** Priority types which can be used by Module::Prioritize()
224 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
226 /** Implementation-specific flags which may be set in Module::Implements()
230 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
231 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
232 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
233 I_OnUserMessage, I_OnMode, I_OnSyncUser,
234 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
235 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
236 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
237 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
238 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
239 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
240 I_OnPostTopicChange, I_OnPostConnect,
241 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
242 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
243 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
244 I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
245 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
246 I_OnServiceAdd, I_OnServiceDel,
250 /** Base class for all InspIRCd modules
251 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
252 * its methods will be called when irc server events occur. class inherited from module must be
253 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
255 class CoreExport Module : public classbase, public usecountbase
257 /** Detach an event from this module
258 * @param i Event type to detach
260 void DetachEvent(Implementation i);
263 /** File that this module was loaded from
265 std::string ModuleSourceFile;
266 /** Reference to the dlopen() value
268 DLLManager* ModuleDLLManager;
270 /** If true, this module will be unloaded soon, further unload attempts will fail
271 * Value is used by the ModuleManager internally, you should not modify it
275 /** Default constructor.
276 * Creates a module class. Don't do any type of hook registration or checks
277 * for other modules here; do that in init().
282 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
284 virtual void init() {}
286 /** Clean up prior to destruction
287 * If you override, you must call this AFTER your module's cleanup
289 CullResult cull() CXX11_OVERRIDE;
291 /** Default destructor.
292 * destroys a module class
296 virtual void Prioritize()
300 /** This method is called when you should reload module specific configuration:
301 * on boot, on a /REHASH and on module load.
302 * @param status The current status, can be inspected for more information;
303 * also used for reporting configuration errors and warnings.
305 virtual void ReadConfig(ConfigStatus& status);
307 /** Returns the version number of a Module.
308 * The method should return a Version object with its version information assigned via
311 virtual Version GetVersion() = 0;
313 /** Called when a user connects.
314 * The details of the connecting user are available to you in the parameter User *user
315 * @param user The user who is connecting
317 virtual void OnUserConnect(LocalUser* user);
319 /** Called when a user quits.
320 * The details of the exiting user are available to you in the parameter User *user
321 * This event is only called when the user is fully registered when they quit. To catch
322 * raw disconnections, use the OnUserDisconnect method.
323 * @param user The user who is quitting
324 * @param message The user's quit message (as seen by non-opers)
325 * @param oper_message The user's quit message (as seen by opers)
327 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
329 /** Called whenever a user's socket is closed.
330 * The details of the exiting user are available to you in the parameter User *user
331 * This event is called for all users, registered or not, as a cleanup method for modules
332 * which might assign resources to user, such as dns lookups, objects and sockets.
333 * @param user The user who is disconnecting
335 virtual void OnUserDisconnect(LocalUser* user);
337 /** Called whenever a channel is about to be deleted
338 * @param chan The channel being deleted
339 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
341 virtual ModResult OnChannelPreDelete(Channel *chan);
343 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
344 * @param chan The channel being deleted
346 virtual void OnChannelDelete(Channel* chan);
348 /** Called when a user joins a channel.
349 * The details of the joining user are available to you in the parameter User *user,
350 * and the details of the channel they have joined is available in the variable Channel *channel
351 * @param memb The channel membership being created
352 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
353 * to a channel due to the network sync.
354 * @param created This is true if the join created the channel
355 * @param except_list A list of users not to send to.
357 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
359 /** Called after a user joins a channel
360 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
362 * @param memb The channel membership created
364 virtual void OnPostJoin(Membership* memb);
366 /** Called when a user parts a channel.
367 * The details of the leaving user are available to you in the parameter User *user,
368 * and the details of the channel they have left is available in the variable Channel *channel
369 * @param memb The channel membership being destroyed
370 * @param partmessage The part message, or an empty string (may be modified)
371 * @param except_list A list of users to not send to.
373 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
375 /** Called on rehash.
376 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
377 * system. This is called in all cases -- including when this server will not execute the
378 * rehash because it is directed at a remote server.
380 * @param user The user performing the rehash, if any. If this is server initiated, the value of
381 * this variable will be NULL.
382 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
385 virtual void OnPreRehash(User* user, const std::string ¶meter);
387 /** Called on rehash.
388 * This method is called when a user initiates a module-specific rehash. This can be used to do
389 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
390 * rehash for efficiency. A rehash of this type does not reload the core configuration.
392 * @param user The user performing the rehash.
393 * @param parameter The parameter given to REHASH
395 virtual void OnModuleRehash(User* user, const std::string ¶meter);
397 /** Called whenever a snotice is about to be sent to a snomask.
398 * snomask and type may both be modified; the message may not.
399 * @param snomask The snomask the message is going to (e.g. 'A')
400 * @param type The textual description the snomask will go to (e.g. 'OPER')
401 * @param message The text message to be sent via snotice
402 * @return 1 to block the snotice from being sent entirely, 0 else.
404 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
406 /** Called whenever a user is about to join a channel, before any processing is done.
407 * Returning a value of 1 from this function stops the process immediately, causing no
408 * output to be sent to the user by the core. If you do this you must produce your own numerics,
409 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
410 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
414 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
415 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
416 * processing on the actual channel record at this point, however the channel NAME will still be passed in
417 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
418 * @param user The user joining the channel
419 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
420 * @param cname The channel name being joined. For new channels this is valid where chan is not.
421 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
422 * You may alter this string to alter the user's modes on the channel.
423 * @param keygiven The key given to join the channel, or an empty string if none was provided
424 * @return 1 To prevent the join, 0 to allow it.
426 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
428 /** Called whenever a user is about to be kicked.
429 * Returning a value of 1 from this function stops the process immediately, causing no
430 * output to be sent to the user by the core. If you do this you must produce your own numerics,
432 * @param source The user issuing the kick
433 * @param memb The channel membership of the user who is being kicked.
434 * @param reason The kick reason
435 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
437 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
439 /** Called whenever a user is kicked.
440 * If this method is called, the kick is already underway and cannot be prevented, so
441 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
442 * @param source The user issuing the kick
443 * @param memb The channel membership of the user who was kicked.
444 * @param reason The kick reason
445 * @param except_list A list of users to not send to.
447 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
449 /** Called whenever a user opers locally.
450 * The User will contain the oper mode 'o' as this function is called after any modifications
451 * are made to the user's structure by the core.
452 * @param user The user who is opering up
453 * @param opertype The opers type name
455 virtual void OnOper(User* user, const std::string &opertype);
457 /** Called after a user opers locally.
458 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
459 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
460 * out the OPERTYPE, etc.
461 * @param user The user who is opering up
462 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
463 * @param opertype The opers type name
465 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
467 /** Called whenever a user types /INFO.
468 * The User will contain the information of the user who typed the command. Modules may use this
469 * method to output their own credits in /INFO (which is the ircd's version of an about box).
470 * It is purposefully not possible to modify any info that has already been output, or halt the list.
471 * You must write a 371 numeric to the user, containing your info in the following format:
473 * <nick> :information here
475 * @param user The user issuing /INFO
477 virtual void OnInfo(User* user);
479 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
480 * Returning 1 from this function stops the process immediately, causing no
481 * output to be sent to the user by the core. If you do this you must produce your own numerics,
482 * notices etc. This is useful for modules which may want to filter invites to channels.
483 * @param source The user who is issuing the INVITE
484 * @param dest The user being invited
485 * @param channel The channel the user is being invited to
486 * @param timeout The time the invite will expire (0 == never)
487 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
489 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
491 /** Called after a user has been successfully invited to a channel.
492 * You cannot prevent the invite from occuring using this function, to do that,
493 * use OnUserPreInvite instead.
494 * @param source The user who is issuing the INVITE
495 * @param dest The user being invited
496 * @param channel The channel the user is being invited to
497 * @param timeout The time the invite will expire (0 == never)
498 * @param notifyrank Rank required to get an invite announcement (if enabled)
499 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
501 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
503 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
504 * Returning any nonzero value from this function stops the process immediately, causing no
505 * output to be sent to the user by the core. If you do this you must produce your own numerics,
506 * notices etc. This is useful for modules which may want to filter or redirect messages.
507 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
508 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
509 * of where the message is destined to be sent.
510 * @param user The user sending the message
511 * @param dest The target of the message (Channel* or User*)
512 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
513 * @param text Changeable text being sent by the user
514 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
515 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
516 * It will be ignored for private messages.
517 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
518 * @return 1 to deny the message, 0 to allow it
520 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
522 /** Called when sending a message to all "neighbors" of a given user -
523 * that is, all users that share a common channel. This is used in
524 * commands such as NICK, QUIT, etc.
525 * @param source The source of the message
526 * @param include_c Channels to scan for users to include
527 * @param exceptions Map of user->bool that overrides the inclusion decision
529 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
531 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
533 /** Called before local nickname changes. This can be used to implement Q-lines etc.
534 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
535 * module to generate some meaninful output.
536 * @param user The username changing their nick
537 * @param newnick Their new nickname
538 * @return 1 to deny the change, 0 to allow
540 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
542 /** Called after any PRIVMSG sent from a user.
543 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
544 * if target_type is TYPE_CHANNEL.
545 * @param user The user sending the message
546 * @param dest The target of the message
547 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
548 * @param text the text being sent by the user
549 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
550 * @param exempt_list A list of users to not send to.
551 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
553 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
555 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
556 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
557 * if target_type is TYPE_CHANNEL.
558 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
559 * the message has already been vetted. In the case of the other two methods, a later module may stop your
560 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
561 * @param user The user sending the message
562 * @param dest The target of the message
563 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
564 * @param text the text being sent by the user
565 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
566 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
568 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
570 /** Called after every MODE command sent from a user
571 * Either the usertarget or the chantarget variable contains the target of the modes,
572 * the actual target will have a non-NULL pointer.
573 * All changed modes are available in the changelist object.
574 * @param user The user sending the MODEs
575 * @param usertarget The target user of the modes, NULL if the target is a channel
576 * @param chantarget The target channel of the modes, NULL if the target is a user
577 * @param changelist The changed modes.
578 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
579 * for the possible flags.
580 * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
582 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
584 /** Allows modules to synchronize data which relates to users during a netburst.
585 * When this function is called, it will be called from the module which implements
586 * the linking protocol. This currently is m_spanningtree.so.
587 * This function will be called for every user visible on your side
588 * of the burst, allowing you to for example set modes, etc.
589 * @param user The user being syncronized
590 * @param server The target of the burst
592 virtual void OnSyncUser(User* user, ProtocolServer& server);
594 /** Allows modules to synchronize data which relates to channels during a netburst.
595 * When this function is called, it will be called from the module which implements
596 * the linking protocol. This currently is m_spanningtree.so.
597 * This function will be called for every channel visible on your side of the burst,
598 * allowing you to for example set modes, etc.
600 * @param chan The channel being syncronized
601 * @param server The target of the burst
603 virtual void OnSyncChannel(Channel* chan, ProtocolServer& server);
605 /** Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
606 * When the linking module has finished sending all data it wanted to send during a netburst, then
607 * this method is called. You should use the SendMetaData() function after you've
608 * correctly decided how the data should be represented, to send the data.
609 * @param server The target of the burst
611 virtual void OnSyncNetwork(ProtocolServer& server);
613 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
614 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
615 * @param target The Channel* or User* that data should be added to
616 * @param extname The extension name which is being sent
617 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
619 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
621 /** Called whenever a user's hostname is changed.
622 * This event triggers after the host has been set.
623 * @param user The user whos host is being changed
624 * @param newhost The new hostname being set
626 virtual void OnChangeHost(User* user, const std::string &newhost);
628 /** Called whenever a user's GECOS (realname) is changed.
629 * This event triggers after the name has been set.
630 * @param user The user who's GECOS is being changed
631 * @param gecos The new GECOS being set on the user
633 virtual void OnChangeName(User* user, const std::string &gecos);
635 /** Called whenever a user's IDENT is changed.
636 * This event triggers after the name has been set.
637 * @param user The user who's IDENT is being changed
638 * @param ident The new IDENT being set on the user
640 virtual void OnChangeIdent(User* user, const std::string &ident);
642 /** Called whenever an xline is added by a local user.
643 * This method is triggered after the line is added.
644 * @param source The sender of the line or NULL for local server
645 * @param line The xline being added
647 virtual void OnAddLine(User* source, XLine* line);
649 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
650 * This method is triggered after the line is deleted.
651 * @param source The user removing the line or NULL for local server
652 * @param line the line being deleted
654 virtual void OnDelLine(User* source, XLine* line);
656 /** Called whenever an xline expires.
657 * This method is triggered after the line is deleted.
658 * @param line The line being deleted.
660 virtual void OnExpireLine(XLine *line);
662 /** Called before the module is unloaded to clean up extensibles.
663 * This method is called once for every channel, membership, and user.
664 * so that you can clear up any data relating to the specified extensible.
665 * @param type The type of extensible being cleaned up. If this is EXT_CHANNEL
666 * then item is a Channel*, EXT_MEMBERSHIP then item is a Membership*,
667 * and EXT_USER then item is a User*.
668 * @param item A pointer to the extensible which is being cleaned up.
670 virtual void OnCleanup(ExtensionItem::ExtensibleType type, Extensible* item);
672 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
673 * have been applied. Please note that although you can see remote nickchanges through this function, you should
674 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
675 * check user->server before taking any action (including returning nonzero from the method).
676 * Because this method is called after the nickchange is taken place, no return values are possible
677 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
678 * @param user The user changing their nick
679 * @param oldnick The old nickname of the user before the nickchange
681 virtual void OnUserPostNick(User* user, const std::string &oldnick);
683 /** Called before a mode change via the MODE command, to allow a single access check for
684 * a full mode change (use OnRawMode to check individual modes)
686 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
687 * OnRawMode for each individual mode
689 * @param source the user making the mode change
690 * @param dest the user destination of the umode change (NULL if a channel mode)
691 * @param channel the channel destination of the mode change
692 * @param modes Modes being changed, can be edited
694 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
696 /** Called when a 005 numeric is about to be output.
697 * The module should modify the 005 numeric if needed to indicate its features.
698 * @param tokens The 005 map to be modified if neccessary.
700 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
702 /** Called when a client is disconnected by KILL.
703 * If a client is killed by a server, e.g. a nickname collision or protocol error,
705 * Return 1 from this function to prevent the kill, and 0 from this function to allow
706 * it as normal. If you prevent the kill no output will be sent to the client, it is
707 * down to your module to generate this information.
708 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
709 * If you do so youre risking race conditions, desyncs and worse!
710 * @param source The user sending the KILL
711 * @param dest The user being killed
712 * @param reason The kill reason
713 * @return 1 to prevent the kill, 0 to allow
715 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
717 /** Called whenever a module is loaded.
718 * mod will contain a pointer to the module, and string will contain its name,
719 * for example m_widgets.so. This function is primary for dependency checking,
720 * your module may decide to enable some extra features if it sees that you have
721 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
722 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
723 * but instead operate under reduced functionality, unless the dependency is
724 * absolutely neccessary (e.g. a module that extends the features of another
726 * @param mod A pointer to the new module
728 virtual void OnLoadModule(Module* mod);
730 /** Called whenever a module is unloaded.
731 * mod will contain a pointer to the module, and string will contain its name,
732 * for example m_widgets.so. This function is primary for dependency checking,
733 * your module may decide to enable some extra features if it sees that you have
734 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
735 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
736 * but instead operate under reduced functionality, unless the dependency is
737 * absolutely neccessary (e.g. a module that extends the features of another
739 * @param mod Pointer to the module being unloaded (still valid)
741 virtual void OnUnloadModule(Module* mod);
743 /** Called once every five seconds for background processing.
744 * This timer can be used to control timed features. Its period is not accurate
745 * enough to be used as a clock, but it is gauranteed to be called at least once in
746 * any five second period, directly from the main loop of the server.
747 * @param curtime The current timer derived from time(2)
749 virtual void OnBackgroundTimer(time_t curtime);
751 /** Called whenever any command is about to be executed.
752 * This event occurs for all registered commands, wether they are registered in the core,
753 * or another module, and for invalid commands. Invalid commands may only be sent to this
754 * function when the value of validated is false. By returning 1 from this method you may prevent the
755 * command being executed. If you do this, no output is created by the core, and it is
756 * down to your module to produce any output neccessary.
757 * Note that unless you return 1, you should not destroy any structures (e.g. by using
758 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
759 * method returns, it will be passed an invalid pointer to the user object and crash!)
760 * @param command The command being executed
761 * @param parameters An array of array of characters containing the parameters for the command
762 * @param user the user issuing the command
763 * @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.
764 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
765 * @param original_line The entire original line as passed to the parser from the user
766 * @return 1 to block the command, 0 to allow
768 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
770 /** Called after any command has been executed.
771 * This event occurs for all registered commands, wether they are registered in the core,
772 * or another module, but it will not occur for invalid commands (e.g. ones which do not
773 * exist within the command table). The result code returned by the command handler is
775 * @param command The command being executed
776 * @param parameters An array of array of characters containing the parameters for the command
777 * @param user the user issuing the command
778 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
779 * @param original_line The entire original line as passed to the parser from the user
781 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
783 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
784 * connect class, or accepting any commands.
786 virtual void OnUserInit(LocalUser* user);
788 /** Called to check if a user who is connecting can now be allowed to register
789 * If any modules return false for this function, the user is held in the waiting
790 * state until all modules return true. For example a module which implements ident
791 * lookups will continue to return false for a user until their ident lookup is completed.
792 * Note that the registration timeout for a user overrides these checks, if the registration
793 * timeout is reached, the user is disconnected even if modules report that the user is
794 * not ready to connect.
795 * @param user The user to check
796 * @return true to indicate readiness, false if otherwise
798 virtual ModResult OnCheckReady(LocalUser* user);
800 /** Called whenever a user is about to register their connection (e.g. before the user
801 * is sent the MOTD etc). Modules can use this method if they are performing a function
802 * which must be done before the actual connection is completed (e.g. ident lookups,
803 * dnsbl lookups, etc).
804 * Note that you should NOT delete the user record here by causing a disconnection!
805 * Use OnUserConnect for that instead.
806 * @param user The user registering
807 * @return 1 to indicate user quit, 0 to continue
809 virtual ModResult OnUserRegister(LocalUser* user);
811 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
812 * This method will always be called for each join, wether or not the channel is actually +i, and
813 * determines the outcome of an if statement around the whole section of invite checking code.
814 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
815 * @param user The user joining the channel
816 * @param chan The channel being joined
817 * @return 1 to explicitly allow the join, 0 to proceed as normal
819 virtual ModResult OnCheckInvite(User* user, Channel* chan);
821 /** Called whenever a mode character is processed.
822 * Return 1 from this function to block the mode character from being processed entirely.
823 * @param user The user who is sending the mode
824 * @param chan The channel the mode is being sent to (or NULL if a usermode)
825 * @param mh The mode handler for the mode being changed
826 * @param param The parameter for the mode or an empty string
827 * @param adding true of the mode is being added, false if it is being removed
828 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
829 * to skip all permission checking. Please note that for remote mode changes, your return value
832 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
834 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
835 * This method will always be called for each join, wether or not the channel is actually +k, and
836 * determines the outcome of an if statement around the whole section of key checking code.
837 * if the user specified no key, the keygiven string will be a valid but empty value.
838 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
839 * @param user The user joining the channel
840 * @param chan The channel being joined
841 * @param keygiven The key given on joining the channel.
842 * @return 1 to explicitly allow the join, 0 to proceed as normal
844 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
846 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
847 * This method will always be called for each join, wether or not the channel is actually +l, and
848 * determines the outcome of an if statement around the whole section of channel limit checking code.
849 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
850 * @param user The user joining the channel
851 * @param chan The channel being joined
852 * @return 1 to explicitly allow the join, 0 to proceed as normal
854 virtual ModResult OnCheckLimit(User* user, Channel* chan);
857 * Checks for a user's ban from the channel
858 * @param user The user to check
859 * @param chan The channel to check in
860 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
861 * ban check, or MOD_RES_PASSTHRU to check bans normally
863 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
866 * Checks for a user's match of a single ban
867 * @param user The user to check for match
868 * @param chan The channel on which the match is being checked
869 * @param mask The mask being checked
870 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
871 * ban check, or MOD_RES_PASSTHRU to check bans normally
873 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
875 /** Checks for a match on a given extban type
876 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
877 * ban check, or MOD_RES_PASSTHRU to check bans normally
879 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
881 /** Called on all /STATS commands
882 * This method is triggered for all /STATS use, including stats symbols handled by the core.
883 * @param stats Context of the /STATS request, contains requesting user, list of answer rows etc.
884 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
886 virtual ModResult OnStats(Stats::Context& stats);
888 /** Called whenever a change of a local users displayed host is attempted.
889 * Return 1 to deny the host change, or 0 to allow it.
890 * @param user The user whos host will be changed
891 * @param newhost The new hostname
892 * @return 1 to deny the host change, 0 to allow
894 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
896 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
897 * return 1 to deny the name change, or 0 to allow it.
898 * @param user The user whos GECOS will be changed
899 * @param newhost The new GECOS
900 * @return 1 to deny the GECOS change, 0 to allow
902 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
904 /** Called before a topic is changed.
905 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
906 * As with other 'pre' events, you should only ever block a local event.
907 * @param user The user changing the topic
908 * @param chan The channels who's topic is being changed
909 * @param topic The actual topic text
910 * @return 1 to block the topic change, 0 to allow
912 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
914 /** Called whenever a topic has been changed.
915 * To block topic changes you must use OnPreTopicChange instead.
916 * @param user The user changing the topic
917 * @param chan The channels who's topic is being changed
918 * @param topic The actual topic text
920 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
922 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
923 * The password field (from the config file) is in 'password' and is to be compared against
924 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
925 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
926 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
927 * @param password The password from the configuration file (the password="" value).
928 * @param input The password entered by the user or whoever.
929 * @param hashtype The hash value from the config
930 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
932 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
934 /** Called after a user has fully connected and all modules have executed OnUserConnect
935 * This event is informational only. You should not change any user information in this
936 * event. To do so, use the OnUserConnect method to change the state of local users.
937 * This is called for both local and remote users.
938 * @param user The user who is connecting
940 virtual void OnPostConnect(User* user);
942 /** Called when a port accepts a connection
943 * Return MOD_RES_ACCEPT if you have used the file descriptor.
944 * @param fd The file descriptor returned from accept()
945 * @param sock The socket connection for the new user
946 * @param client The client IP address and port
947 * @param server The server IP address and port
949 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
951 /** Called whenever a user sets away or returns from being away.
952 * The away message is available as a parameter, but should not be modified.
953 * At this stage, it has already been copied into the user record.
954 * If awaymsg is empty, the user is returning from away.
955 * @param user The user setting away
956 * @param awaymsg The away message of the user, or empty if returning from away
957 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
959 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
961 /** Called at intervals for modules to garbage-collect any hashes etc.
962 * Certain data types such as hash_map 'leak' buckets, which must be
963 * tidied up and freed by copying into a new item every so often. This
964 * method is called when it is time to do that.
966 virtual void OnGarbageCollect();
968 /** Called when a user's connect class is being matched
969 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
970 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
972 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
974 #ifdef INSPIRCD_ENABLE_TESTSUITE
975 /** Add test suite hooks here. These are used for testing functionality of a module
976 * via the --testsuite debugging parameter.
978 virtual void OnRunTestSuite();
981 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
982 * For example NAMESX, channel mode +u and +I, and UHNAMES.
983 * @param issuer The user who is going to receive the NAMES list being built
984 * @param item The channel member being considered for inclusion
985 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
986 * prefix mode the member has, can be changed
987 * @param nick The nick to display, initially set to the member's nick, can be changed
988 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
989 * excluded from this NAMES list
991 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
993 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
995 /** Called whenever a result from /WHO is about to be returned
996 * @param source The user running the /WHO query
997 * @param params The parameters to the /WHO query
998 * @param user The user that this line of the query is about
999 * @param memb The member shown in this line, NULL if no channel is in this line
1000 * @param numeric Numeric to send; modifiable.
1001 * @return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
1003 virtual ModResult OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, Numeric::Numeric& numeric);
1005 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1006 * a module like m_cgiirc changing it.
1007 * @param user The user whose IP is being set
1009 virtual void OnSetUserIP(LocalUser* user);
1011 /** Called whenever a ServiceProvider is registered.
1012 * @param service ServiceProvider being registered.
1014 virtual void OnServiceAdd(ServiceProvider& service);
1016 /** Called whenever a ServiceProvider is unregistered.
1017 * @param service ServiceProvider being unregistered.
1019 virtual void OnServiceDel(ServiceProvider& service);
1022 /** A list of modules
1024 typedef std::vector<Module*> IntModuleList;
1026 /** ModuleManager takes care of all things module-related
1029 class CoreExport ModuleManager : public fakederef<ModuleManager>
1032 typedef std::vector<ServiceProvider*> ServiceList;
1035 /** Holds a string describing the last module error to occur
1037 std::string LastModuleError;
1039 /** List of loaded modules and shared object/dll handles
1040 * keyed by module name
1042 std::map<std::string, Module*> Modules;
1048 } prioritizationState;
1050 /** Loads all core modules (core_*)
1052 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1054 /** Calls the Prioritize() method in all loaded modules
1055 * @return True if all went well, false if a dependency loop was detected
1057 bool PrioritizeHooks();
1059 /** Unregister all user modes or all channel modes owned by a module
1060 * @param mod Module whose modes to unregister
1061 * @param modetype MODETYPE_USER to unregister user modes, MODETYPE_CHANNEL to unregister channel modes
1063 void UnregisterModes(Module* mod, ModeType modetype);
1066 typedef std::map<std::string, Module*> ModuleMap;
1068 /** Event handler hooks.
1069 * This needs to be public to be used by FOREACH_MOD and friends.
1071 IntModuleList EventHandlers[I_END];
1073 /** List of data services keyed by name */
1074 std::multimap<std::string, ServiceProvider*> DataProviders;
1076 /** A list of ServiceProviders waiting to be registered.
1077 * Non-NULL when constructing a Module, NULL otherwise.
1078 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1079 * automatically registers them (that is, call AddService()) after the Module is constructed,
1080 * and before Module::init() is called.
1081 * If a service is created after the construction of the Module (for example in init()) it
1082 * has to be registered manually.
1084 ServiceList* NewServices;
1086 /** Expands the name of a module by prepending "m_" and appending ".so".
1087 * No-op if the name already has the ".so" extension.
1088 * @param modname Module name to expand
1089 * @return Module name starting with "m_" and ending with ".so"
1091 static std::string ExpandModName(const std::string& modname);
1093 /** Simple, bog-standard, boring constructor.
1101 /** Change the priority of one event in a module.
1102 * Each module event has a list of modules which are attached to that event type.
1103 * If you wish to be called before or after other specific modules, you may use this
1104 * method (usually within void Module::Prioritize()) to set your events priority.
1105 * You may use this call in other methods too, however, this is not supported behaviour
1107 * @param mod The module to change the priority of
1108 * @param i The event to change the priority of
1109 * @param s The state you wish to use for this event. Use one of
1110 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1111 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1112 * to set it to be before or after one or more other modules.
1113 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1114 * then this contains a the module that your module must be placed before
1117 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1119 /** Change the priority of all events in a module.
1120 * @param mod The module to set the priority of
1121 * @param s The priority of all events in the module.
1122 * Note that with this method, it is not possible to effectively use
1123 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1124 * SetPriority method for this, where you may specify other modules to
1125 * be prioritized against.
1127 void SetPriority(Module* mod, Priority s);
1129 /** Attach an event to a module.
1130 * You may later detatch the event with ModuleManager::Detach().
1131 * If your module is unloaded, all events are automatically detatched.
1132 * @param i Event type to attach
1133 * @param mod Module to attach event to
1134 * @return True if the event was attached
1136 bool Attach(Implementation i, Module* mod);
1138 /** Detatch an event from a module.
1139 * This is not required when your module unloads, as the core will
1140 * automatically detatch your module from all events it is attached to.
1141 * @param i Event type to detach
1142 * @param mod Module to detach event from
1143 * @return True if the event was detached
1145 bool Detach(Implementation i, Module* mod);
1147 /** Attach an array of events to a module
1148 * @param i Event types (array) to attach
1149 * @param mod Module to attach events to
1150 * @param sz The size of the implementation array
1152 void Attach(Implementation* i, Module* mod, size_t sz);
1154 /** Detach all events from a module (used on unload)
1155 * @param mod Module to detach from
1157 void DetachAll(Module* mod);
1159 /** Attach all events to a module (used on module load)
1160 * @param mod Module to attach to all events
1162 void AttachAll(Module* mod);
1164 /** Returns text describing the last module error
1165 * @return The last error message to occur
1167 std::string& LastError();
1169 /** Load a given module file
1170 * @param filename The file to load
1171 * @param defer Defer module init (loading many modules)
1172 * @return True if the module was found and loaded
1174 bool Load(const std::string& filename, bool defer = false);
1176 /** Unload a given module file. Note that the module will not be
1177 * completely gone until the cull list has finished processing.
1179 * @return true on success; if false, LastError will give a reason
1181 bool Unload(Module* module);
1183 /** Called by the InspIRCd constructor to load all modules from the config file.
1187 void DoSafeUnload(Module*);
1189 /** Check if a module can be unloaded and if yes, prepare it for unload
1190 * @param mod Module to be unloaded
1191 * @return True if the module is unloadable, false otherwise.
1192 * If true the module must be unloaded in the current main loop iteration.
1194 bool CanUnload(Module* mod);
1196 /** Find a module by name, and return a Module* to it.
1197 * This is preferred over iterating the module lists yourself.
1198 * @param name The module name to look up
1199 * @return A pointer to the module, or NULL if the module cannot be found
1201 Module* Find(const std::string &name);
1203 /** Register a service provided by a module */
1204 void AddService(ServiceProvider&);
1206 /** Unregister a service provided by a module */
1207 void DelService(ServiceProvider&);
1209 /** Register all services in a given ServiceList
1210 * @param list The list containing the services to register
1212 void AddServices(const ServiceList& list);
1214 inline void AddServices(ServiceProvider** list, int count)
1216 for(int i=0; i < count; i++)
1217 AddService(*list[i]);
1220 /** Find a service by name.
1221 * If multiple modules provide a given service, the first one loaded will be chosen.
1223 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1225 template<typename T> inline T* FindDataService(const std::string& name)
1227 return static_cast<T*>(FindService(SERVICE_DATA, name));
1230 /** Get a map of all loaded modules keyed by their name
1231 * @return A ModuleMap containing all loaded modules
1233 const ModuleMap& GetModules() const { return Modules; }
1235 /** Make a service referenceable by dynamic_references
1236 * @param name Name that will be used by dynamic_references to find the object
1237 * @param service Service to make referenceable by dynamic_references
1239 void AddReferent(const std::string& name, ServiceProvider* service);
1241 /** Make a service no longer referenceable by dynamic_references
1242 * @param service Service to make no longer referenceable by dynamic_references
1244 void DelReferent(ServiceProvider* service);
1247 /** Do not mess with these functions unless you know the C preprocessor
1248 * well enough to explain why they are needed. The order is important.
1250 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1251 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1252 #define MODULE_INIT_STR_FN_1(x) #x
1253 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1254 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1255 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1257 #ifdef INSPIRCD_STATIC
1259 struct AllCommandList {
1260 typedef Command* (*fn)(Module*);
1261 AllCommandList(fn cmd);
1263 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1264 static const AllCommandList PREP_ ## x(&MK_ ## x);
1266 struct AllModuleList {
1267 typedef Module* (*fn)();
1270 AllModuleList(fn mod, const std::string& Name);
1273 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1274 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1278 /** This definition is used as shorthand for the various classes
1279 * and functions needed to make a module loadable by the OS.
1280 * It defines the class factory and external init_module function.
1284 #define MODULE_INIT(y) \
1285 extern "C" DllExport Module * MODULE_INIT_SYM() \
1289 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1291 switch ( nReason ) \
1293 case DLL_PROCESS_ATTACH: \
1294 case DLL_PROCESS_DETACH: \
1299 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
1303 #define MODULE_INIT(y) \
1304 extern "C" DllExport Module * MODULE_INIT_SYM() \
1308 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION;
1311 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)