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 define a set of behavior bits for a module
41 VF_NONE = 0, // module is not special at all
42 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
43 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
44 VF_COMMON = 4, // module needs to be common on all servers in a network to link
45 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
46 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
49 /** Used to represent an event type, for user, channel or server
51 enum TargetTypeFlags {
58 /** Used to represent wether a message was PRIVMSG or NOTICE
65 #define MOD_RES_ALLOW (ModResult(1))
66 #define MOD_RES_PASSTHRU (ModResult(0))
67 #define MOD_RES_DENY (ModResult(-1))
69 /** Used to represent an allow/deny module result.
70 * Not constructed as an enum because it reverses the value logic of some functions;
71 * the compiler will inline accesses to have the same efficiency as integer operations.
75 ModResult() : res(0) {}
76 explicit ModResult(int r) : res(r) {}
77 inline bool operator==(const ModResult& r) const
81 inline bool operator!=(const ModResult& r) const
85 inline bool operator!() const
89 inline bool check(bool def) const
91 return (res == 1 || (res == 0 && def));
94 * Merges two results, preferring ALLOW to DENY
96 inline ModResult operator+(const ModResult& r) const
98 if (res == r.res || r.res == 0)
102 // they are different, and neither is passthru
103 return MOD_RES_ALLOW;
107 /** InspIRCd major version.
108 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
110 #define INSPIRCD_VERSION_MAJ 202
111 /** InspIRCd API version.
112 * If you change any API elements, increment this value. This counter should be
113 * reset whenever the major version is changed. Modules can use these two values
114 * and numerical comparisons in preprocessor macros if they wish to support
115 * multiple versions of InspIRCd in one file.
117 #define INSPIRCD_VERSION_API 1
120 * This #define allows us to call a method in all
121 * loaded modules in a readable simple way, e.g.:
122 * 'FOREACH_MOD(OnConnect,(user));'
124 #define FOREACH_MOD(y,x) do { \
125 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
126 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
133 catch (CoreException& modexcept) \
135 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
141 * Custom module result handling loop. This is a paired macro, and should only
142 * be used with while_each_hook.
144 * See src/channels.cpp for an example of use.
146 #define DO_EACH_HOOK(n,v,args) \
148 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
149 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
156 #define WHILE_EACH_HOOK(n) \
158 catch (CoreException& except_ ## n) \
160 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
166 * Module result iterator
167 * Runs the given hook until some module returns a useful result.
169 * Example: ModResult result;
170 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
172 #define FIRST_MOD_RESULT(n,v,args) do { \
173 v = MOD_RES_PASSTHRU; \
174 DO_EACH_HOOK(n,v,args) \
176 if (v != MOD_RES_PASSTHRU) \
179 WHILE_EACH_HOOK(n); \
182 /** Holds a module's Version information.
183 * The members (set by the constructor only) indicate details as to the version number
184 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
186 class CoreExport Version
189 /** Module description
191 const std::string description;
197 /** Server linking description string */
198 const std::string link_data;
200 /** Simple module version */
201 Version(const std::string &desc, int flags = VF_NONE);
203 /** Complex version information, including linking compatability data */
204 Version(const std::string &desc, int flags, const std::string& linkdata);
206 virtual ~Version() {}
209 class CoreExport DataProvider : public ServiceProvider
212 DataProvider(Module* Creator, const std::string& Name)
213 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
216 /** Priority types which can be used by Module::Prioritize()
218 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
220 /** Implementation-specific flags which may be set in Module::Implements()
225 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
226 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
227 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
228 I_OnUserMessage, I_OnMode, I_OnSyncUser,
229 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
230 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
231 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
232 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
233 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
234 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
235 I_OnPostTopicChange, I_OnPostConnect,
236 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
237 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
238 I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
239 I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
240 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
244 /** Base class for all InspIRCd modules
245 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
246 * its methods will be called when irc server events occur. class inherited from module must be
247 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
249 class CoreExport Module : public classbase, public usecountbase
251 /** Detach an event from this module
252 * @param i Event type to detach
254 void DetachEvent(Implementation i);
257 /** File that this module was loaded from
259 std::string ModuleSourceFile;
260 /** Reference to the dlopen() value
262 DLLManager* ModuleDLLManager;
264 /** If true, this module will be unloaded soon, further unload attempts will fail
265 * Value is used by the ModuleManager internally, you should not modify it
269 /** Default constructor.
270 * Creates a module class. Don't do any type of hook registration or checks
271 * for other modules here; do that in init().
276 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
278 virtual void init() {}
280 /** Clean up prior to destruction
281 * If you override, you must call this AFTER your module's cleanup
283 virtual CullResult cull();
285 /** Default destructor.
286 * destroys a module class
290 virtual void Prioritize()
294 /** This method is called when you should reload module specific configuration:
295 * on boot, on a /REHASH and on module load.
296 * @param status The current status, can be inspected for more information;
297 * also used for reporting configuration errors and warnings.
299 virtual void ReadConfig(ConfigStatus& status);
301 /** Returns the version number of a Module.
302 * The method should return a Version object with its version information assigned via
305 virtual Version GetVersion() = 0;
307 /** Called when a user connects.
308 * The details of the connecting user are available to you in the parameter User *user
309 * @param user The user who is connecting
311 virtual void OnUserConnect(LocalUser* user);
313 /** Called when a user quits.
314 * The details of the exiting user are available to you in the parameter User *user
315 * This event is only called when the user is fully registered when they quit. To catch
316 * raw disconnections, use the OnUserDisconnect method.
317 * @param user The user who is quitting
318 * @param message The user's quit message (as seen by non-opers)
319 * @param oper_message The user's quit message (as seen by opers)
321 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
323 /** Called whenever a user's socket is closed.
324 * The details of the exiting user are available to you in the parameter User *user
325 * This event is called for all users, registered or not, as a cleanup method for modules
326 * which might assign resources to user, such as dns lookups, objects and sockets.
327 * @param user The user who is disconnecting
329 virtual void OnUserDisconnect(LocalUser* user);
331 /** Called whenever a channel is about to be deleted
332 * @param chan The channel being deleted
333 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
335 virtual ModResult OnChannelPreDelete(Channel *chan);
337 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
338 * @param chan The channel being deleted
340 virtual void OnChannelDelete(Channel* chan);
342 /** Called when a user joins a channel.
343 * The details of the joining user are available to you in the parameter User *user,
344 * and the details of the channel they have joined is available in the variable Channel *channel
345 * @param memb The channel membership being created
346 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
347 * to a channel due to the network sync.
348 * @param created This is true if the join created the channel
349 * @param except_list A list of users not to send to.
351 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
353 /** Called after a user joins a channel
354 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
356 * @param memb The channel membership created
358 virtual void OnPostJoin(Membership* memb);
360 /** Called when a user parts a channel.
361 * The details of the leaving user are available to you in the parameter User *user,
362 * and the details of the channel they have left is available in the variable Channel *channel
363 * @param memb The channel membership being destroyed
364 * @param partmessage The part message, or an empty string (may be modified)
365 * @param except_list A list of users to not send to.
367 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
369 /** Called on rehash.
370 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
371 * system. This is called in all cases -- including when this server will not execute the
372 * rehash because it is directed at a remote server.
374 * @param user The user performing the rehash, if any. If this is server initiated, the value of
375 * this variable will be NULL.
376 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
379 virtual void OnPreRehash(User* user, const std::string ¶meter);
381 /** Called on rehash.
382 * This method is called when a user initiates a module-specific rehash. This can be used to do
383 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
384 * rehash for efficiency. A rehash of this type does not reload the core configuration.
386 * @param user The user performing the rehash.
387 * @param parameter The parameter given to REHASH
389 virtual void OnModuleRehash(User* user, const std::string ¶meter);
391 /** Called whenever a snotice is about to be sent to a snomask.
392 * snomask and type may both be modified; the message may not.
393 * @param snomask The snomask the message is going to (e.g. 'A')
394 * @param type The textual description the snomask will go to (e.g. 'OPER')
395 * @param message The text message to be sent via snotice
396 * @return 1 to block the snotice from being sent entirely, 0 else.
398 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
400 /** Called whenever a user is about to join a channel, before any processing is done.
401 * Returning a value of 1 from this function stops the process immediately, causing no
402 * output to be sent to the user by the core. If you do this you must produce your own numerics,
403 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
404 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
408 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
409 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
410 * processing on the actual channel record at this point, however the channel NAME will still be passed in
411 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
412 * @param user The user joining the channel
413 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
414 * @param cname The channel name being joined. For new channels this is valid where chan is not.
415 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
416 * You may alter this string to alter the user's modes on the channel.
417 * @param keygiven The key given to join the channel, or an empty string if none was provided
418 * @return 1 To prevent the join, 0 to allow it.
420 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
422 /** Called whenever a user is about to be kicked.
423 * Returning a value of 1 from this function stops the process immediately, causing no
424 * output to be sent to the user by the core. If you do this you must produce your own numerics,
426 * @param source The user issuing the kick
427 * @param memb The channel membership of the user who is being kicked.
428 * @param reason The kick reason
429 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
431 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
433 /** Called whenever a user is kicked.
434 * If this method is called, the kick is already underway and cannot be prevented, so
435 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
436 * @param source The user issuing the kick
437 * @param memb The channel membership of the user who was kicked.
438 * @param reason The kick reason
439 * @param except_list A list of users to not send to.
441 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
443 /** Called whenever a user opers locally.
444 * The User will contain the oper mode 'o' as this function is called after any modifications
445 * are made to the user's structure by the core.
446 * @param user The user who is opering up
447 * @param opertype The opers type name
449 virtual void OnOper(User* user, const std::string &opertype);
451 /** Called after a user opers locally.
452 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
453 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
454 * out the OPERTYPE, etc.
455 * @param user The user who is opering up
456 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
457 * @param opertype The opers type name
459 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
461 /** Called whenever a user types /INFO.
462 * The User will contain the information of the user who typed the command. Modules may use this
463 * method to output their own credits in /INFO (which is the ircd's version of an about box).
464 * It is purposefully not possible to modify any info that has already been output, or halt the list.
465 * You must write a 371 numeric to the user, containing your info in the following format:
467 * <nick> :information here
469 * @param user The user issuing /INFO
471 virtual void OnInfo(User* user);
473 /** Called whenever a /WHOIS is performed on a local user.
474 * The source parameter contains the details of the user who issued the WHOIS command, and
475 * the dest parameter contains the information of the user they are whoising.
476 * @param source The user issuing the WHOIS command
477 * @param dest The user who is being WHOISed
479 virtual void OnWhois(User* source, User* dest);
481 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
482 * Returning 1 from this function stops the process immediately, causing no
483 * output to be sent to the user by the core. If you do this you must produce your own numerics,
484 * notices etc. This is useful for modules which may want to filter invites to channels.
485 * @param source The user who is issuing the INVITE
486 * @param dest The user being invited
487 * @param channel The channel the user is being invited to
488 * @param timeout The time the invite will expire (0 == never)
489 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
491 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
493 /** Called after a user has been successfully invited to a channel.
494 * You cannot prevent the invite from occuring using this function, to do that,
495 * use OnUserPreInvite instead.
496 * @param source The user who is issuing the INVITE
497 * @param dest The user being invited
498 * @param channel The channel the user is being invited to
499 * @param timeout The time the invite will expire (0 == never)
501 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
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 your module is unloaded to clean up Extensibles.
663 * This method is called once for every user and channel on the network,
664 * so that when your module unloads it may clear up any remaining data
665 * in the form of Extensibles added using Extensible::Extend().
666 * If the target_type variable is TYPE_USER, then void* item refers to
667 * a User*, otherwise it refers to a Channel*.
668 * @param target_type The type of item being cleaned
669 * @param item A pointer to the item's class
671 virtual void OnCleanup(int target_type, void* item);
673 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
674 * have been applied. Please note that although you can see remote nickchanges through this function, you should
675 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
676 * check user->server before taking any action (including returning nonzero from the method).
677 * Because this method is called after the nickchange is taken place, no return values are possible
678 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
679 * @param user The user changing their nick
680 * @param oldnick The old nickname of the user before the nickchange
682 virtual void OnUserPostNick(User* user, const std::string &oldnick);
684 /** Called before a mode change via the MODE command, to allow a single access check for
685 * a full mode change (use OnRawMode to check individual modes)
687 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
688 * OnRawMode for each individual mode
690 * @param source the user making the mode change
691 * @param dest the user destination of the umode change (NULL if a channel mode)
692 * @param channel the channel destination of the mode change
693 * @param modes Modes being changed, can be edited
695 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
697 /** Called when a 005 numeric is about to be output.
698 * The module should modify the 005 numeric if needed to indicate its features.
699 * @param tokens The 005 map to be modified if neccessary.
701 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
703 /** Called when a client is disconnected by KILL.
704 * If a client is killed by a server, e.g. a nickname collision or protocol error,
706 * Return 1 from this function to prevent the kill, and 0 from this function to allow
707 * it as normal. If you prevent the kill no output will be sent to the client, it is
708 * down to your module to generate this information.
709 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
710 * If you do so youre risking race conditions, desyncs and worse!
711 * @param source The user sending the KILL
712 * @param dest The user being killed
713 * @param reason The kill reason
714 * @return 1 to prevent the kill, 0 to allow
716 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
718 /** Called whenever a module is loaded.
719 * mod will contain a pointer to the module, and string will contain its name,
720 * for example m_widgets.so. This function is primary for dependency checking,
721 * your module may decide to enable some extra features if it sees that you have
722 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
723 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
724 * but instead operate under reduced functionality, unless the dependency is
725 * absolutely neccessary (e.g. a module that extends the features of another
727 * @param mod A pointer to the new module
729 virtual void OnLoadModule(Module* mod);
731 /** Called whenever a module is unloaded.
732 * mod will contain a pointer to the module, and string will contain its name,
733 * for example m_widgets.so. This function is primary for dependency checking,
734 * your module may decide to enable some extra features if it sees that you have
735 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
736 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
737 * but instead operate under reduced functionality, unless the dependency is
738 * absolutely neccessary (e.g. a module that extends the features of another
740 * @param mod Pointer to the module being unloaded (still valid)
742 virtual void OnUnloadModule(Module* mod);
744 /** Called once every five seconds for background processing.
745 * This timer can be used to control timed features. Its period is not accurate
746 * enough to be used as a clock, but it is gauranteed to be called at least once in
747 * any five second period, directly from the main loop of the server.
748 * @param curtime The current timer derived from time(2)
750 virtual void OnBackgroundTimer(time_t curtime);
752 /** Called whenever any command is about to be executed.
753 * This event occurs for all registered commands, wether they are registered in the core,
754 * or another module, and for invalid commands. Invalid commands may only be sent to this
755 * function when the value of validated is false. By returning 1 from this method you may prevent the
756 * command being executed. If you do this, no output is created by the core, and it is
757 * down to your module to produce any output neccessary.
758 * Note that unless you return 1, you should not destroy any structures (e.g. by using
759 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
760 * method returns, it will be passed an invalid pointer to the user object and crash!)
761 * @param command The command being executed
762 * @param parameters An array of array of characters containing the parameters for the command
763 * @param user the user issuing the command
764 * @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.
765 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
766 * @param original_line The entire original line as passed to the parser from the user
767 * @return 1 to block the command, 0 to allow
769 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
771 /** Called after any command has been executed.
772 * This event occurs for all registered commands, wether they are registered in the core,
773 * or another module, but it will not occur for invalid commands (e.g. ones which do not
774 * exist within the command table). The result code returned by the command handler is
776 * @param command The command being executed
777 * @param parameters An array of array of characters containing the parameters for the command
778 * @param user the user issuing the command
779 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
780 * @param original_line The entire original line as passed to the parser from the user
782 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
784 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
785 * connect class, or accepting any commands.
787 virtual void OnUserInit(LocalUser* user);
789 /** Called to check if a user who is connecting can now be allowed to register
790 * If any modules return false for this function, the user is held in the waiting
791 * state until all modules return true. For example a module which implements ident
792 * lookups will continue to return false for a user until their ident lookup is completed.
793 * Note that the registration timeout for a user overrides these checks, if the registration
794 * timeout is reached, the user is disconnected even if modules report that the user is
795 * not ready to connect.
796 * @param user The user to check
797 * @return true to indicate readiness, false if otherwise
799 virtual ModResult OnCheckReady(LocalUser* user);
801 /** Called whenever a user is about to register their connection (e.g. before the user
802 * is sent the MOTD etc). Modules can use this method if they are performing a function
803 * which must be done before the actual connection is completed (e.g. ident lookups,
804 * dnsbl lookups, etc).
805 * Note that you should NOT delete the user record here by causing a disconnection!
806 * Use OnUserConnect for that instead.
807 * @param user The user registering
808 * @return 1 to indicate user quit, 0 to continue
810 virtual ModResult OnUserRegister(LocalUser* user);
812 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
813 * This method will always be called for each join, wether or not the channel is actually +i, and
814 * determines the outcome of an if statement around the whole section of invite checking code.
815 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
816 * @param user The user joining the channel
817 * @param chan The channel being joined
818 * @return 1 to explicitly allow the join, 0 to proceed as normal
820 virtual ModResult OnCheckInvite(User* user, Channel* chan);
822 /** Called whenever a mode character is processed.
823 * Return 1 from this function to block the mode character from being processed entirely.
824 * @param user The user who is sending the mode
825 * @param chan The channel the mode is being sent to (or NULL if a usermode)
826 * @param mh The mode handler for the mode being changed
827 * @param param The parameter for the mode or an empty string
828 * @param adding true of the mode is being added, false if it is being removed
829 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
830 * to skip all permission checking. Please note that for remote mode changes, your return value
833 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
835 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
836 * This method will always be called for each join, wether or not the channel is actually +k, and
837 * determines the outcome of an if statement around the whole section of key checking code.
838 * if the user specified no key, the keygiven string will be a valid but empty value.
839 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
840 * @param user The user joining the channel
841 * @param chan The channel being joined
842 * @param keygiven The key given on joining the channel.
843 * @return 1 to explicitly allow the join, 0 to proceed as normal
845 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
847 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
848 * This method will always be called for each join, wether or not the channel is actually +l, and
849 * determines the outcome of an if statement around the whole section of channel limit checking code.
850 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
851 * @param user The user joining the channel
852 * @param chan The channel being joined
853 * @return 1 to explicitly allow the join, 0 to proceed as normal
855 virtual ModResult OnCheckLimit(User* user, Channel* chan);
858 * Checks for a user's ban from the channel
859 * @param user The user to check
860 * @param chan The channel to check in
861 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
862 * ban check, or MOD_RES_PASSTHRU to check bans normally
864 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
867 * Checks for a user's match of a single ban
868 * @param user The user to check for match
869 * @param chan The channel on which the match is being checked
870 * @param mask The mask being checked
871 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
872 * ban check, or MOD_RES_PASSTHRU to check bans normally
874 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
876 /** Checks for a match on a given extban type
877 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
878 * ban check, or MOD_RES_PASSTHRU to check bans normally
880 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
882 /** Called on all /STATS commands
883 * This method is triggered for all /STATS use, including stats symbols handled by the core.
884 * @param symbol the symbol provided to /STATS
885 * @param user the user issuing the /STATS command
886 * @param results A string_list to append results into. You should put all your results
887 * into this string_list, rather than displaying them directly, so that your handler will
888 * work when remote STATS queries are received.
889 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
891 virtual ModResult OnStats(char symbol, User* user, string_list &results);
893 /** Called whenever a change of a local users displayed host is attempted.
894 * Return 1 to deny the host change, or 0 to allow it.
895 * @param user The user whos host will be changed
896 * @param newhost The new hostname
897 * @return 1 to deny the host change, 0 to allow
899 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
901 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
902 * return 1 to deny the name change, or 0 to allow it.
903 * @param user The user whos GECOS will be changed
904 * @param newhost The new GECOS
905 * @return 1 to deny the GECOS change, 0 to allow
907 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
909 /** Called before a topic is changed.
910 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
911 * As with other 'pre' events, you should only ever block a local event.
912 * @param user The user changing the topic
913 * @param chan The channels who's topic is being changed
914 * @param topic The actual topic text
915 * @return 1 to block the topic change, 0 to allow
917 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
919 /** Called whenever a topic has been changed.
920 * To block topic changes you must use OnPreTopicChange instead.
921 * @param user The user changing the topic
922 * @param chan The channels who's topic is being changed
923 * @param topic The actual topic text
925 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
927 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
928 * The password field (from the config file) is in 'password' and is to be compared against
929 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
930 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
931 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
932 * @param password The password from the configuration file (the password="" value).
933 * @param input The password entered by the user or whoever.
934 * @param hashtype The hash value from the config
935 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
937 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
939 /** Called after a user has fully connected and all modules have executed OnUserConnect
940 * This event is informational only. You should not change any user information in this
941 * event. To do so, use the OnUserConnect method to change the state of local users.
942 * This is called for both local and remote users.
943 * @param user The user who is connecting
945 virtual void OnPostConnect(User* user);
947 /** Called when a port accepts a connection
948 * Return MOD_RES_ACCEPT if you have used the file descriptor.
949 * @param fd The file descriptor returned from accept()
950 * @param sock The socket connection for the new user
951 * @param client The client IP address and port
952 * @param server The server IP address and port
954 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
956 /** Called whenever a user sets away or returns from being away.
957 * The away message is available as a parameter, but should not be modified.
958 * At this stage, it has already been copied into the user record.
959 * If awaymsg is empty, the user is returning from away.
960 * @param user The user setting away
961 * @param awaymsg The away message of the user, or empty if returning from away
962 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
964 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
966 /** Called whenever a line of WHOIS output is sent to a user.
967 * You may change the numeric and the text of the output by changing
968 * the values numeric and text, but you cannot change the user the
969 * numeric is sent to. You may however change the user's User values.
970 * @param user The user the numeric is being sent to
971 * @param dest The user being WHOISed
972 * @param numeric The numeric of the line being sent
973 * @param text The text of the numeric, including any parameters
974 * @return nonzero to drop the line completely so that the user does not
975 * receive it, or zero to allow the line to be sent.
977 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
979 /** Called at intervals for modules to garbage-collect any hashes etc.
980 * Certain data types such as hash_map 'leak' buckets, which must be
981 * tidied up and freed by copying into a new item every so often. This
982 * method is called when it is time to do that.
984 virtual void OnGarbageCollect();
986 /** Called when a user's connect class is being matched
987 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
988 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
990 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
992 #ifdef INSPIRCD_ENABLE_TESTSUITE
993 /** Add test suite hooks here. These are used for testing functionality of a module
994 * via the --testsuite debugging parameter.
996 virtual void OnRunTestSuite();
999 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1000 * For example NAMESX, channel mode +u and +I, and UHNAMES.
1001 * @param issuer The user who is going to receive the NAMES list being built
1002 * @param item The channel member being considered for inclusion
1003 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
1004 * prefix mode the member has, can be changed
1005 * @param nick The nick to display, initially set to the member's nick, can be changed
1006 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
1007 * excluded from this NAMES list
1009 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
1011 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1013 /** Called whenever a result from /WHO is about to be returned
1014 * @param source The user running the /WHO query
1015 * @param params The parameters to the /WHO query
1016 * @param user The user that this line of the query is about
1017 * @param memb The member shown in this line, NULL if no channel is in this line
1018 * @param line The raw line to send; modifiable, if empty no line will be returned.
1020 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, std::string& line);
1022 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1023 * a module like m_cgiirc changing it.
1024 * @param user The user whose IP is being set
1026 virtual void OnSetUserIP(LocalUser* user);
1029 /** A list of modules
1031 typedef std::vector<Module*> IntModuleList;
1033 /** An event handler iterator
1035 typedef IntModuleList::iterator EventHandlerIter;
1037 /** ModuleManager takes care of all things module-related
1040 class CoreExport ModuleManager : public fakederef<ModuleManager>
1043 typedef std::vector<ServiceProvider*> ServiceList;
1046 /** Holds a string describing the last module error to occur
1048 std::string LastModuleError;
1050 /** List of loaded modules and shared object/dll handles
1051 * keyed by module name
1053 std::map<std::string, Module*> Modules;
1059 } prioritizationState;
1061 /** Internal unload module hook */
1062 bool CanUnload(Module*);
1064 /** Loads all core modules (cmd_*)
1066 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1068 /** Calls the Prioritize() method in all loaded modules
1069 * @return True if all went well, false if a dependency loop was detected
1071 bool PrioritizeHooks();
1074 typedef std::map<std::string, Module*> ModuleMap;
1076 /** Event handler hooks.
1077 * This needs to be public to be used by FOREACH_MOD and friends.
1079 IntModuleList EventHandlers[I_END];
1081 /** List of data services keyed by name */
1082 std::multimap<std::string, ServiceProvider*> DataProviders;
1084 /** A list of ServiceProviders waiting to be registered.
1085 * Non-NULL when constructing a Module, NULL otherwise.
1086 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1087 * automatically registers them (that is, call AddService()) after the Module is constructed,
1088 * and before Module::init() is called.
1089 * If a service is created after the construction of the Module (for example in init()) it
1090 * has to be registered manually.
1092 ServiceList* NewServices;
1094 /** Simple, bog-standard, boring constructor.
1102 /** Change the priority of one event in a module.
1103 * Each module event has a list of modules which are attached to that event type.
1104 * If you wish to be called before or after other specific modules, you may use this
1105 * method (usually within void Module::Prioritize()) to set your events priority.
1106 * You may use this call in other methods too, however, this is not supported behaviour
1108 * @param mod The module to change the priority of
1109 * @param i The event to change the priority of
1110 * @param s The state you wish to use for this event. Use one of
1111 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1112 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1113 * to set it to be before or after one or more other modules.
1114 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1115 * then this contains a the module that your module must be placed before
1118 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1120 /** Backwards compat interface */
1121 inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
1123 return SetPriority(mod, i, s, *dptr);
1126 /** Change the priority of all events in a module.
1127 * @param mod The module to set the priority of
1128 * @param s The priority of all events in the module.
1129 * Note that with this method, it is not possible to effectively use
1130 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1131 * SetPriority method for this, where you may specify other modules to
1132 * be prioritized against.
1134 bool SetPriority(Module* mod, Priority s);
1136 /** Attach an event to a module.
1137 * You may later detatch the event with ModuleManager::Detach().
1138 * If your module is unloaded, all events are automatically detatched.
1139 * @param i Event type to attach
1140 * @param mod Module to attach event to
1141 * @return True if the event was attached
1143 bool Attach(Implementation i, Module* mod);
1145 /** Detatch an event from a module.
1146 * This is not required when your module unloads, as the core will
1147 * automatically detatch your module from all events it is attached to.
1148 * @param i Event type to detach
1149 * @param mod Module to detach event from
1150 * @return True if the event was detached
1152 bool Detach(Implementation i, Module* mod);
1154 /** Attach an array of events to a module
1155 * @param i Event types (array) to attach
1156 * @param mod Module to attach events to
1157 * @param sz The size of the implementation array
1159 void Attach(Implementation* i, Module* mod, size_t sz);
1161 /** Detach all events from a module (used on unload)
1162 * @param mod Module to detach from
1164 void DetachAll(Module* mod);
1166 /** Attach all events to a module (used on module load)
1167 * @param mod Module to attach to all events
1169 void AttachAll(Module* mod);
1171 /** Returns text describing the last module error
1172 * @return The last error message to occur
1174 std::string& LastError();
1176 /** Load a given module file
1177 * @param filename The file to load
1178 * @param defer Defer module init (loading many modules)
1179 * @return True if the module was found and loaded
1181 bool Load(const std::string& filename, bool defer = false);
1183 /** Unload a given module file. Note that the module will not be
1184 * completely gone until the cull list has finished processing.
1186 * @return true on success; if false, LastError will give a reason
1188 bool Unload(Module* module);
1190 /** Run an asynchronous reload of the given module. When the reload is
1191 * complete, the callback will be run with true if the reload succeeded
1192 * and false if it did not.
1194 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1196 /** Called by the InspIRCd constructor to load all modules from the config file.
1200 void DoSafeUnload(Module*);
1202 /** Find a module by name, and return a Module* to it.
1203 * This is preferred over iterating the module lists yourself.
1204 * @param name The module name to look up
1205 * @return A pointer to the module, or NULL if the module cannot be found
1207 Module* Find(const std::string &name);
1209 /** Register a service provided by a module */
1210 void AddService(ServiceProvider&);
1212 /** Unregister a service provided by a module */
1213 void DelService(ServiceProvider&);
1215 /** Register all services in a given ServiceList
1216 * @param list The list containing the services to register
1218 void AddServices(const ServiceList& list);
1220 inline void AddServices(ServiceProvider** list, int count)
1222 for(int i=0; i < count; i++)
1223 AddService(*list[i]);
1226 /** Find a service by name.
1227 * If multiple modules provide a given service, the first one loaded will be chosen.
1229 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1231 template<typename T> inline T* FindDataService(const std::string& name)
1233 return static_cast<T*>(FindService(SERVICE_DATA, name));
1236 /** Get a map of all loaded modules keyed by their name
1237 * @return A ModuleMap containing all loaded modules
1239 const ModuleMap& GetModules() const { return Modules; }
1242 /** Do not mess with these functions unless you know the C preprocessor
1243 * well enough to explain why they are needed. The order is important.
1245 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1246 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1247 #define MODULE_INIT_STR_FN_1(x) #x
1248 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1249 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1250 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1254 struct AllCommandList {
1255 typedef Command* (*fn)(Module*);
1256 AllCommandList(fn cmd);
1258 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1259 static const AllCommandList PREP_ ## x(&MK_ ## x);
1261 struct AllModuleList {
1262 typedef Module* (*fn)();
1265 AllModuleList(fn mod, const std::string& Name);
1268 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1269 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1273 /** This definition is used as shorthand for the various classes
1274 * and functions needed to make a module loadable by the OS.
1275 * It defines the class factory and external init_module function.
1279 #define MODULE_INIT(y) \
1280 extern "C" DllExport Module * MODULE_INIT_SYM() \
1284 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1286 switch ( nReason ) \
1288 case DLL_PROCESS_ATTACH: \
1289 case DLL_PROCESS_DETACH: \
1297 #define MODULE_INIT(y) \
1298 extern "C" DllExport Module * MODULE_INIT_SYM() \
1302 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1305 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)