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()
224 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
225 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
226 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
227 I_OnUserMessage, I_OnMode, I_OnSyncUser,
228 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
229 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
230 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
231 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
232 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
233 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
234 I_OnPostTopicChange, I_OnPostConnect,
235 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
236 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
237 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
238 I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
239 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
243 /** Base class for all InspIRCd modules
244 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
245 * its methods will be called when irc server events occur. class inherited from module must be
246 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
248 class CoreExport Module : public classbase, public usecountbase
250 /** Detach an event from this module
251 * @param i Event type to detach
253 void DetachEvent(Implementation i);
256 /** File that this module was loaded from
258 std::string ModuleSourceFile;
259 /** Reference to the dlopen() value
261 DLLManager* ModuleDLLManager;
263 /** If true, this module will be unloaded soon, further unload attempts will fail
264 * Value is used by the ModuleManager internally, you should not modify it
268 /** Default constructor.
269 * Creates a module class. Don't do any type of hook registration or checks
270 * for other modules here; do that in init().
275 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
277 virtual void init() {}
279 /** Clean up prior to destruction
280 * If you override, you must call this AFTER your module's cleanup
282 virtual CullResult cull();
284 /** Default destructor.
285 * destroys a module class
289 virtual void Prioritize()
293 /** This method is called when you should reload module specific configuration:
294 * on boot, on a /REHASH and on module load.
295 * @param status The current status, can be inspected for more information;
296 * also used for reporting configuration errors and warnings.
298 virtual void ReadConfig(ConfigStatus& status);
300 /** Returns the version number of a Module.
301 * The method should return a Version object with its version information assigned via
304 virtual Version GetVersion() = 0;
306 /** Called when a user connects.
307 * The details of the connecting user are available to you in the parameter User *user
308 * @param user The user who is connecting
310 virtual void OnUserConnect(LocalUser* user);
312 /** Called when a user quits.
313 * The details of the exiting user are available to you in the parameter User *user
314 * This event is only called when the user is fully registered when they quit. To catch
315 * raw disconnections, use the OnUserDisconnect method.
316 * @param user The user who is quitting
317 * @param message The user's quit message (as seen by non-opers)
318 * @param oper_message The user's quit message (as seen by opers)
320 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
322 /** Called whenever a user's socket is closed.
323 * The details of the exiting user are available to you in the parameter User *user
324 * This event is called for all users, registered or not, as a cleanup method for modules
325 * which might assign resources to user, such as dns lookups, objects and sockets.
326 * @param user The user who is disconnecting
328 virtual void OnUserDisconnect(LocalUser* user);
330 /** Called whenever a channel is about to be deleted
331 * @param chan The channel being deleted
332 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
334 virtual ModResult OnChannelPreDelete(Channel *chan);
336 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
337 * @param chan The channel being deleted
339 virtual void OnChannelDelete(Channel* chan);
341 /** Called when a user joins a channel.
342 * The details of the joining user are available to you in the parameter User *user,
343 * and the details of the channel they have joined is available in the variable Channel *channel
344 * @param memb The channel membership being created
345 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
346 * to a channel due to the network sync.
347 * @param created This is true if the join created the channel
348 * @param except_list A list of users not to send to.
350 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
352 /** Called after a user joins a channel
353 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
355 * @param memb The channel membership created
357 virtual void OnPostJoin(Membership* memb);
359 /** Called when a user parts a channel.
360 * The details of the leaving user are available to you in the parameter User *user,
361 * and the details of the channel they have left is available in the variable Channel *channel
362 * @param memb The channel membership being destroyed
363 * @param partmessage The part message, or an empty string (may be modified)
364 * @param except_list A list of users to not send to.
366 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
368 /** Called on rehash.
369 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
370 * system. This is called in all cases -- including when this server will not execute the
371 * rehash because it is directed at a remote server.
373 * @param user The user performing the rehash, if any. If this is server initiated, the value of
374 * this variable will be NULL.
375 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
378 virtual void OnPreRehash(User* user, const std::string ¶meter);
380 /** Called on rehash.
381 * This method is called when a user initiates a module-specific rehash. This can be used to do
382 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
383 * rehash for efficiency. A rehash of this type does not reload the core configuration.
385 * @param user The user performing the rehash.
386 * @param parameter The parameter given to REHASH
388 virtual void OnModuleRehash(User* user, const std::string ¶meter);
390 /** Called whenever a snotice is about to be sent to a snomask.
391 * snomask and type may both be modified; the message may not.
392 * @param snomask The snomask the message is going to (e.g. 'A')
393 * @param type The textual description the snomask will go to (e.g. 'OPER')
394 * @param message The text message to be sent via snotice
395 * @return 1 to block the snotice from being sent entirely, 0 else.
397 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
399 /** Called whenever a user is about to join a channel, before any processing is done.
400 * Returning a value of 1 from this function stops the process immediately, causing no
401 * output to be sent to the user by the core. If you do this you must produce your own numerics,
402 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
403 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
407 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
408 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
409 * processing on the actual channel record at this point, however the channel NAME will still be passed in
410 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
411 * @param user The user joining the channel
412 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
413 * @param cname The channel name being joined. For new channels this is valid where chan is not.
414 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
415 * You may alter this string to alter the user's modes on the channel.
416 * @param keygiven The key given to join the channel, or an empty string if none was provided
417 * @return 1 To prevent the join, 0 to allow it.
419 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
421 /** Called whenever a user is about to be kicked.
422 * Returning a value of 1 from this function stops the process immediately, causing no
423 * output to be sent to the user by the core. If you do this you must produce your own numerics,
425 * @param source The user issuing the kick
426 * @param memb The channel membership of the user who is being kicked.
427 * @param reason The kick reason
428 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
430 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
432 /** Called whenever a user is kicked.
433 * If this method is called, the kick is already underway and cannot be prevented, so
434 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
435 * @param source The user issuing the kick
436 * @param memb The channel membership of the user who was kicked.
437 * @param reason The kick reason
438 * @param except_list A list of users to not send to.
440 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
442 /** Called whenever a user opers locally.
443 * The User will contain the oper mode 'o' as this function is called after any modifications
444 * are made to the user's structure by the core.
445 * @param user The user who is opering up
446 * @param opertype The opers type name
448 virtual void OnOper(User* user, const std::string &opertype);
450 /** Called after a user opers locally.
451 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
452 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
453 * out the OPERTYPE, etc.
454 * @param user The user who is opering up
455 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
456 * @param opertype The opers type name
458 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
460 /** Called whenever a user types /INFO.
461 * The User will contain the information of the user who typed the command. Modules may use this
462 * method to output their own credits in /INFO (which is the ircd's version of an about box).
463 * It is purposefully not possible to modify any info that has already been output, or halt the list.
464 * You must write a 371 numeric to the user, containing your info in the following format:
466 * <nick> :information here
468 * @param user The user issuing /INFO
470 virtual void OnInfo(User* user);
472 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
473 * Returning 1 from this function stops the process immediately, causing no
474 * output to be sent to the user by the core. If you do this you must produce your own numerics,
475 * notices etc. This is useful for modules which may want to filter invites to channels.
476 * @param source The user who is issuing the INVITE
477 * @param dest The user being invited
478 * @param channel The channel the user is being invited to
479 * @param timeout The time the invite will expire (0 == never)
480 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
482 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
484 /** Called after a user has been successfully invited to a channel.
485 * You cannot prevent the invite from occuring using this function, to do that,
486 * use OnUserPreInvite instead.
487 * @param source The user who is issuing the INVITE
488 * @param dest The user being invited
489 * @param channel The channel the user is being invited to
490 * @param timeout The time the invite will expire (0 == never)
492 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
494 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
495 * Returning any nonzero value from this function stops the process immediately, causing no
496 * output to be sent to the user by the core. If you do this you must produce your own numerics,
497 * notices etc. This is useful for modules which may want to filter or redirect messages.
498 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
499 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
500 * of where the message is destined to be sent.
501 * @param user The user sending the message
502 * @param dest The target of the message (Channel* or User*)
503 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
504 * @param text Changeable text being sent by the user
505 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
506 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
507 * It will be ignored for private messages.
508 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
509 * @return 1 to deny the message, 0 to allow it
511 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
513 /** Called when sending a message to all "neighbors" of a given user -
514 * that is, all users that share a common channel. This is used in
515 * commands such as NICK, QUIT, etc.
516 * @param source The source of the message
517 * @param include_c Channels to scan for users to include
518 * @param exceptions Map of user->bool that overrides the inclusion decision
520 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
522 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
524 /** Called before local nickname changes. This can be used to implement Q-lines etc.
525 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
526 * module to generate some meaninful output.
527 * @param user The username changing their nick
528 * @param newnick Their new nickname
529 * @return 1 to deny the change, 0 to allow
531 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
533 /** Called after any PRIVMSG sent from a user.
534 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
535 * if target_type is TYPE_CHANNEL.
536 * @param user The user sending the message
537 * @param dest The target of the message
538 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
539 * @param text the text being sent by the user
540 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
541 * @param exempt_list A list of users to not send to.
542 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
544 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
546 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
547 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
548 * if target_type is TYPE_CHANNEL.
549 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
550 * the message has already been vetted. In the case of the other two methods, a later module may stop your
551 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
552 * @param user The user sending the message
553 * @param dest The target of the message
554 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
555 * @param text the text being sent by the user
556 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
557 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
559 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
561 /** Called after every MODE command sent from a user
562 * Either the usertarget or the chantarget variable contains the target of the modes,
563 * the actual target will have a non-NULL pointer.
564 * All changed modes are available in the changelist object.
565 * @param user The user sending the MODEs
566 * @param usertarget The target user of the modes, NULL if the target is a channel
567 * @param chantarget The target channel of the modes, NULL if the target is a user
568 * @param changelist The changed modes.
569 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
570 * for the possible flags.
571 * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
573 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
575 /** Allows modules to synchronize data which relates to users during a netburst.
576 * When this function is called, it will be called from the module which implements
577 * the linking protocol. This currently is m_spanningtree.so.
578 * This function will be called for every user visible on your side
579 * of the burst, allowing you to for example set modes, etc.
580 * @param user The user being syncronized
581 * @param server The target of the burst
583 virtual void OnSyncUser(User* user, ProtocolServer& server);
585 /** Allows modules to synchronize data which relates to channels during a netburst.
586 * When this function is called, it will be called from the module which implements
587 * the linking protocol. This currently is m_spanningtree.so.
588 * This function will be called for every channel visible on your side of the burst,
589 * allowing you to for example set modes, etc.
591 * @param chan The channel being syncronized
592 * @param server The target of the burst
594 virtual void OnSyncChannel(Channel* chan, ProtocolServer& server);
596 /** Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
597 * When the linking module has finished sending all data it wanted to send during a netburst, then
598 * this method is called. You should use the SendMetaData() function after you've
599 * correctly decided how the data should be represented, to send the data.
600 * @param server The target of the burst
602 virtual void OnSyncNetwork(ProtocolServer& server);
604 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
605 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
606 * @param target The Channel* or User* that data should be added to
607 * @param extname The extension name which is being sent
608 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
610 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
612 /** Called whenever a user's hostname is changed.
613 * This event triggers after the host has been set.
614 * @param user The user whos host is being changed
615 * @param newhost The new hostname being set
617 virtual void OnChangeHost(User* user, const std::string &newhost);
619 /** Called whenever a user's GECOS (realname) is changed.
620 * This event triggers after the name has been set.
621 * @param user The user who's GECOS is being changed
622 * @param gecos The new GECOS being set on the user
624 virtual void OnChangeName(User* user, const std::string &gecos);
626 /** Called whenever a user's IDENT is changed.
627 * This event triggers after the name has been set.
628 * @param user The user who's IDENT is being changed
629 * @param ident The new IDENT being set on the user
631 virtual void OnChangeIdent(User* user, const std::string &ident);
633 /** Called whenever an xline is added by a local user.
634 * This method is triggered after the line is added.
635 * @param source The sender of the line or NULL for local server
636 * @param line The xline being added
638 virtual void OnAddLine(User* source, XLine* line);
640 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
641 * This method is triggered after the line is deleted.
642 * @param source The user removing the line or NULL for local server
643 * @param line the line being deleted
645 virtual void OnDelLine(User* source, XLine* line);
647 /** Called whenever an xline expires.
648 * This method is triggered after the line is deleted.
649 * @param line The line being deleted.
651 virtual void OnExpireLine(XLine *line);
653 /** Called before your module is unloaded to clean up Extensibles.
654 * This method is called once for every user and channel on the network,
655 * so that when your module unloads it may clear up any remaining data
656 * in the form of Extensibles added using Extensible::Extend().
657 * If the target_type variable is TYPE_USER, then void* item refers to
658 * a User*, otherwise it refers to a Channel*.
659 * @param target_type The type of item being cleaned
660 * @param item A pointer to the item's class
662 virtual void OnCleanup(int target_type, void* item);
664 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
665 * have been applied. Please note that although you can see remote nickchanges through this function, you should
666 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
667 * check user->server before taking any action (including returning nonzero from the method).
668 * Because this method is called after the nickchange is taken place, no return values are possible
669 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
670 * @param user The user changing their nick
671 * @param oldnick The old nickname of the user before the nickchange
673 virtual void OnUserPostNick(User* user, const std::string &oldnick);
675 /** Called before a mode change via the MODE command, to allow a single access check for
676 * a full mode change (use OnRawMode to check individual modes)
678 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
679 * OnRawMode for each individual mode
681 * @param source the user making the mode change
682 * @param dest the user destination of the umode change (NULL if a channel mode)
683 * @param channel the channel destination of the mode change
684 * @param modes Modes being changed, can be edited
686 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
688 /** Called when a 005 numeric is about to be output.
689 * The module should modify the 005 numeric if needed to indicate its features.
690 * @param tokens The 005 map to be modified if neccessary.
692 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
694 /** Called when a client is disconnected by KILL.
695 * If a client is killed by a server, e.g. a nickname collision or protocol error,
697 * Return 1 from this function to prevent the kill, and 0 from this function to allow
698 * it as normal. If you prevent the kill no output will be sent to the client, it is
699 * down to your module to generate this information.
700 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
701 * If you do so youre risking race conditions, desyncs and worse!
702 * @param source The user sending the KILL
703 * @param dest The user being killed
704 * @param reason The kill reason
705 * @return 1 to prevent the kill, 0 to allow
707 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
709 /** Called whenever a module is loaded.
710 * mod will contain a pointer to the module, and string will contain its name,
711 * for example m_widgets.so. This function is primary for dependency checking,
712 * your module may decide to enable some extra features if it sees that you have
713 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
714 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
715 * but instead operate under reduced functionality, unless the dependency is
716 * absolutely neccessary (e.g. a module that extends the features of another
718 * @param mod A pointer to the new module
720 virtual void OnLoadModule(Module* mod);
722 /** Called whenever a module is unloaded.
723 * mod will contain a pointer to the module, and string will contain its name,
724 * for example m_widgets.so. This function is primary for dependency checking,
725 * your module may decide to enable some extra features if it sees that you have
726 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
727 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
728 * but instead operate under reduced functionality, unless the dependency is
729 * absolutely neccessary (e.g. a module that extends the features of another
731 * @param mod Pointer to the module being unloaded (still valid)
733 virtual void OnUnloadModule(Module* mod);
735 /** Called once every five seconds for background processing.
736 * This timer can be used to control timed features. Its period is not accurate
737 * enough to be used as a clock, but it is gauranteed to be called at least once in
738 * any five second period, directly from the main loop of the server.
739 * @param curtime The current timer derived from time(2)
741 virtual void OnBackgroundTimer(time_t curtime);
743 /** Called whenever any command is about to be executed.
744 * This event occurs for all registered commands, wether they are registered in the core,
745 * or another module, and for invalid commands. Invalid commands may only be sent to this
746 * function when the value of validated is false. By returning 1 from this method you may prevent the
747 * command being executed. If you do this, no output is created by the core, and it is
748 * down to your module to produce any output neccessary.
749 * Note that unless you return 1, you should not destroy any structures (e.g. by using
750 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
751 * method returns, it will be passed an invalid pointer to the user object and crash!)
752 * @param command The command being executed
753 * @param parameters An array of array of characters containing the parameters for the command
754 * @param user the user issuing the command
755 * @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.
756 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
757 * @param original_line The entire original line as passed to the parser from the user
758 * @return 1 to block the command, 0 to allow
760 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
762 /** Called after any command has been executed.
763 * This event occurs for all registered commands, wether they are registered in the core,
764 * or another module, but it will not occur for invalid commands (e.g. ones which do not
765 * exist within the command table). The result code returned by the command handler is
767 * @param command The command being executed
768 * @param parameters An array of array of characters containing the parameters for the command
769 * @param user the user issuing the command
770 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
771 * @param original_line The entire original line as passed to the parser from the user
773 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
775 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
776 * connect class, or accepting any commands.
778 virtual void OnUserInit(LocalUser* user);
780 /** Called to check if a user who is connecting can now be allowed to register
781 * If any modules return false for this function, the user is held in the waiting
782 * state until all modules return true. For example a module which implements ident
783 * lookups will continue to return false for a user until their ident lookup is completed.
784 * Note that the registration timeout for a user overrides these checks, if the registration
785 * timeout is reached, the user is disconnected even if modules report that the user is
786 * not ready to connect.
787 * @param user The user to check
788 * @return true to indicate readiness, false if otherwise
790 virtual ModResult OnCheckReady(LocalUser* user);
792 /** Called whenever a user is about to register their connection (e.g. before the user
793 * is sent the MOTD etc). Modules can use this method if they are performing a function
794 * which must be done before the actual connection is completed (e.g. ident lookups,
795 * dnsbl lookups, etc).
796 * Note that you should NOT delete the user record here by causing a disconnection!
797 * Use OnUserConnect for that instead.
798 * @param user The user registering
799 * @return 1 to indicate user quit, 0 to continue
801 virtual ModResult OnUserRegister(LocalUser* user);
803 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
804 * This method will always be called for each join, wether or not the channel is actually +i, and
805 * determines the outcome of an if statement around the whole section of invite checking code.
806 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
807 * @param user The user joining the channel
808 * @param chan The channel being joined
809 * @return 1 to explicitly allow the join, 0 to proceed as normal
811 virtual ModResult OnCheckInvite(User* user, Channel* chan);
813 /** Called whenever a mode character is processed.
814 * Return 1 from this function to block the mode character from being processed entirely.
815 * @param user The user who is sending the mode
816 * @param chan The channel the mode is being sent to (or NULL if a usermode)
817 * @param mh The mode handler for the mode being changed
818 * @param param The parameter for the mode or an empty string
819 * @param adding true of the mode is being added, false if it is being removed
820 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
821 * to skip all permission checking. Please note that for remote mode changes, your return value
824 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
826 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
827 * This method will always be called for each join, wether or not the channel is actually +k, and
828 * determines the outcome of an if statement around the whole section of key checking code.
829 * if the user specified no key, the keygiven string will be a valid but empty value.
830 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
831 * @param user The user joining the channel
832 * @param chan The channel being joined
833 * @param keygiven The key given on joining the channel.
834 * @return 1 to explicitly allow the join, 0 to proceed as normal
836 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
838 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
839 * This method will always be called for each join, wether or not the channel is actually +l, and
840 * determines the outcome of an if statement around the whole section of channel limit checking code.
841 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
842 * @param user The user joining the channel
843 * @param chan The channel being joined
844 * @return 1 to explicitly allow the join, 0 to proceed as normal
846 virtual ModResult OnCheckLimit(User* user, Channel* chan);
849 * Checks for a user's ban from the channel
850 * @param user The user to check
851 * @param chan The channel to check in
852 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
853 * ban check, or MOD_RES_PASSTHRU to check bans normally
855 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
858 * Checks for a user's match of a single ban
859 * @param user The user to check for match
860 * @param chan The channel on which the match is being checked
861 * @param mask The mask being checked
862 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
863 * ban check, or MOD_RES_PASSTHRU to check bans normally
865 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
867 /** Checks for a match on a given extban type
868 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
869 * ban check, or MOD_RES_PASSTHRU to check bans normally
871 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
873 /** Called on all /STATS commands
874 * This method is triggered for all /STATS use, including stats symbols handled by the core.
875 * @param symbol the symbol provided to /STATS
876 * @param user the user issuing the /STATS command
877 * @param results A string_list to append results into. You should put all your results
878 * into this string_list, rather than displaying them directly, so that your handler will
879 * work when remote STATS queries are received.
880 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
882 virtual ModResult OnStats(char symbol, User* user, string_list &results);
884 /** Called whenever a change of a local users displayed host is attempted.
885 * Return 1 to deny the host change, or 0 to allow it.
886 * @param user The user whos host will be changed
887 * @param newhost The new hostname
888 * @return 1 to deny the host change, 0 to allow
890 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
892 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
893 * return 1 to deny the name change, or 0 to allow it.
894 * @param user The user whos GECOS will be changed
895 * @param newhost The new GECOS
896 * @return 1 to deny the GECOS change, 0 to allow
898 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
900 /** Called before a topic is changed.
901 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
902 * As with other 'pre' events, you should only ever block a local event.
903 * @param user The user changing the topic
904 * @param chan The channels who's topic is being changed
905 * @param topic The actual topic text
906 * @return 1 to block the topic change, 0 to allow
908 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
910 /** Called whenever a topic has been changed.
911 * To block topic changes you must use OnPreTopicChange instead.
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
916 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
918 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
919 * The password field (from the config file) is in 'password' and is to be compared against
920 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
921 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
922 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
923 * @param password The password from the configuration file (the password="" value).
924 * @param input The password entered by the user or whoever.
925 * @param hashtype The hash value from the config
926 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
928 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
930 /** Called after a user has fully connected and all modules have executed OnUserConnect
931 * This event is informational only. You should not change any user information in this
932 * event. To do so, use the OnUserConnect method to change the state of local users.
933 * This is called for both local and remote users.
934 * @param user The user who is connecting
936 virtual void OnPostConnect(User* user);
938 /** Called when a port accepts a connection
939 * Return MOD_RES_ACCEPT if you have used the file descriptor.
940 * @param fd The file descriptor returned from accept()
941 * @param sock The socket connection for the new user
942 * @param client The client IP address and port
943 * @param server The server IP address and port
945 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
947 /** Called whenever a user sets away or returns from being away.
948 * The away message is available as a parameter, but should not be modified.
949 * At this stage, it has already been copied into the user record.
950 * If awaymsg is empty, the user is returning from away.
951 * @param user The user setting away
952 * @param awaymsg The away message of the user, or empty if returning from away
953 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
955 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
957 /** Called at intervals for modules to garbage-collect any hashes etc.
958 * Certain data types such as hash_map 'leak' buckets, which must be
959 * tidied up and freed by copying into a new item every so often. This
960 * method is called when it is time to do that.
962 virtual void OnGarbageCollect();
964 /** Called when a user's connect class is being matched
965 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
966 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
968 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
970 #ifdef INSPIRCD_ENABLE_TESTSUITE
971 /** Add test suite hooks here. These are used for testing functionality of a module
972 * via the --testsuite debugging parameter.
974 virtual void OnRunTestSuite();
977 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
978 * For example NAMESX, channel mode +u and +I, and UHNAMES.
979 * @param issuer The user who is going to receive the NAMES list being built
980 * @param item The channel member being considered for inclusion
981 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
982 * prefix mode the member has, can be changed
983 * @param nick The nick to display, initially set to the member's nick, can be changed
984 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
985 * excluded from this NAMES list
987 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
989 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
991 /** Called whenever a result from /WHO is about to be returned
992 * @param source The user running the /WHO query
993 * @param params The parameters to the /WHO query
994 * @param user The user that this line of the query is about
995 * @param memb The member shown in this line, NULL if no channel is in this line
996 * @param line The raw line to send; modifiable, if empty no line will be returned.
998 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, std::string& line);
1000 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1001 * a module like m_cgiirc changing it.
1002 * @param user The user whose IP is being set
1004 virtual void OnSetUserIP(LocalUser* user);
1007 /** A list of modules
1009 typedef std::vector<Module*> IntModuleList;
1011 /** An event handler iterator
1013 typedef IntModuleList::iterator EventHandlerIter;
1015 /** ModuleManager takes care of all things module-related
1018 class CoreExport ModuleManager : public fakederef<ModuleManager>
1021 typedef std::vector<ServiceProvider*> ServiceList;
1024 /** Holds a string describing the last module error to occur
1026 std::string LastModuleError;
1028 /** List of loaded modules and shared object/dll handles
1029 * keyed by module name
1031 std::map<std::string, Module*> Modules;
1037 } prioritizationState;
1039 /** Internal unload module hook */
1040 bool CanUnload(Module*);
1042 /** Loads all core modules (cmd_*)
1044 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1046 /** Calls the Prioritize() method in all loaded modules
1047 * @return True if all went well, false if a dependency loop was detected
1049 bool PrioritizeHooks();
1052 typedef std::map<std::string, Module*> ModuleMap;
1054 /** Event handler hooks.
1055 * This needs to be public to be used by FOREACH_MOD and friends.
1057 IntModuleList EventHandlers[I_END];
1059 /** List of data services keyed by name */
1060 std::multimap<std::string, ServiceProvider*> DataProviders;
1062 /** A list of ServiceProviders waiting to be registered.
1063 * Non-NULL when constructing a Module, NULL otherwise.
1064 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1065 * automatically registers them (that is, call AddService()) after the Module is constructed,
1066 * and before Module::init() is called.
1067 * If a service is created after the construction of the Module (for example in init()) it
1068 * has to be registered manually.
1070 ServiceList* NewServices;
1072 /** Simple, bog-standard, boring constructor.
1080 /** Change the priority of one event in a module.
1081 * Each module event has a list of modules which are attached to that event type.
1082 * If you wish to be called before or after other specific modules, you may use this
1083 * method (usually within void Module::Prioritize()) to set your events priority.
1084 * You may use this call in other methods too, however, this is not supported behaviour
1086 * @param mod The module to change the priority of
1087 * @param i The event to change the priority of
1088 * @param s The state you wish to use for this event. Use one of
1089 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1090 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1091 * to set it to be before or after one or more other modules.
1092 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1093 * then this contains a the module that your module must be placed before
1096 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1098 /** Change the priority of all events in a module.
1099 * @param mod The module to set the priority of
1100 * @param s The priority of all events in the module.
1101 * Note that with this method, it is not possible to effectively use
1102 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1103 * SetPriority method for this, where you may specify other modules to
1104 * be prioritized against.
1106 void SetPriority(Module* mod, Priority s);
1108 /** Attach an event to a module.
1109 * You may later detatch the event with ModuleManager::Detach().
1110 * If your module is unloaded, all events are automatically detatched.
1111 * @param i Event type to attach
1112 * @param mod Module to attach event to
1113 * @return True if the event was attached
1115 bool Attach(Implementation i, Module* mod);
1117 /** Detatch an event from a module.
1118 * This is not required when your module unloads, as the core will
1119 * automatically detatch your module from all events it is attached to.
1120 * @param i Event type to detach
1121 * @param mod Module to detach event from
1122 * @return True if the event was detached
1124 bool Detach(Implementation i, Module* mod);
1126 /** Attach an array of events to a module
1127 * @param i Event types (array) to attach
1128 * @param mod Module to attach events to
1129 * @param sz The size of the implementation array
1131 void Attach(Implementation* i, Module* mod, size_t sz);
1133 /** Detach all events from a module (used on unload)
1134 * @param mod Module to detach from
1136 void DetachAll(Module* mod);
1138 /** Attach all events to a module (used on module load)
1139 * @param mod Module to attach to all events
1141 void AttachAll(Module* mod);
1143 /** Returns text describing the last module error
1144 * @return The last error message to occur
1146 std::string& LastError();
1148 /** Load a given module file
1149 * @param filename The file to load
1150 * @param defer Defer module init (loading many modules)
1151 * @return True if the module was found and loaded
1153 bool Load(const std::string& filename, bool defer = false);
1155 /** Unload a given module file. Note that the module will not be
1156 * completely gone until the cull list has finished processing.
1158 * @return true on success; if false, LastError will give a reason
1160 bool Unload(Module* module);
1162 /** Run an asynchronous reload of the given module. When the reload is
1163 * complete, the callback will be run with true if the reload succeeded
1164 * and false if it did not.
1166 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1168 /** Called by the InspIRCd constructor to load all modules from the config file.
1172 void DoSafeUnload(Module*);
1174 /** Find a module by name, and return a Module* to it.
1175 * This is preferred over iterating the module lists yourself.
1176 * @param name The module name to look up
1177 * @return A pointer to the module, or NULL if the module cannot be found
1179 Module* Find(const std::string &name);
1181 /** Register a service provided by a module */
1182 void AddService(ServiceProvider&);
1184 /** Unregister a service provided by a module */
1185 void DelService(ServiceProvider&);
1187 /** Register all services in a given ServiceList
1188 * @param list The list containing the services to register
1190 void AddServices(const ServiceList& list);
1192 inline void AddServices(ServiceProvider** list, int count)
1194 for(int i=0; i < count; i++)
1195 AddService(*list[i]);
1198 /** Find a service by name.
1199 * If multiple modules provide a given service, the first one loaded will be chosen.
1201 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1203 template<typename T> inline T* FindDataService(const std::string& name)
1205 return static_cast<T*>(FindService(SERVICE_DATA, name));
1208 /** Get a map of all loaded modules keyed by their name
1209 * @return A ModuleMap containing all loaded modules
1211 const ModuleMap& GetModules() const { return Modules; }
1214 /** Do not mess with these functions unless you know the C preprocessor
1215 * well enough to explain why they are needed. The order is important.
1217 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1218 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1219 #define MODULE_INIT_STR_FN_1(x) #x
1220 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1221 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1222 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1226 struct AllCommandList {
1227 typedef Command* (*fn)(Module*);
1228 AllCommandList(fn cmd);
1230 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1231 static const AllCommandList PREP_ ## x(&MK_ ## x);
1233 struct AllModuleList {
1234 typedef Module* (*fn)();
1237 AllModuleList(fn mod, const std::string& Name);
1240 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1241 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1245 /** This definition is used as shorthand for the various classes
1246 * and functions needed to make a module loadable by the OS.
1247 * It defines the class factory and external init_module function.
1251 #define MODULE_INIT(y) \
1252 extern "C" DllExport Module * MODULE_INIT_SYM() \
1256 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1258 switch ( nReason ) \
1260 case DLL_PROCESS_ATTACH: \
1261 case DLL_PROCESS_DETACH: \
1266 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1270 #define MODULE_INIT(y) \
1271 extern "C" DllExport Module * MODULE_INIT_SYM() \
1275 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1278 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)