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_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
43 VF_COMMON = 4, // module needs to be common on all servers in a network to link
44 VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
45 VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
48 /** Used to represent an event type, for user, channel or server
50 enum TargetTypeFlags {
57 /** Used to represent wether a message was PRIVMSG or NOTICE
64 #define MOD_RES_ALLOW (ModResult(1))
65 #define MOD_RES_PASSTHRU (ModResult(0))
66 #define MOD_RES_DENY (ModResult(-1))
68 /** Used to represent an allow/deny module result.
69 * Not constructed as an enum because it reverses the value logic of some functions;
70 * the compiler will inline accesses to have the same efficiency as integer operations.
74 ModResult() : res(0) {}
75 explicit ModResult(int r) : res(r) {}
76 inline bool operator==(const ModResult& r) const
80 inline bool operator!=(const ModResult& r) const
84 inline bool operator!() const
88 inline bool check(bool def) const
90 return (res == 1 || (res == 0 && def));
93 * Merges two results, preferring ALLOW to DENY
95 inline ModResult operator+(const ModResult& r) const
97 if (res == r.res || r.res == 0)
101 // they are different, and neither is passthru
102 return MOD_RES_ALLOW;
106 /** InspIRCd major version.
107 * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
109 #define INSPIRCD_VERSION_MAJ 202
110 /** InspIRCd API version.
111 * If you change any API elements, increment this value. This counter should be
112 * reset whenever the major version is changed. Modules can use these two values
113 * and numerical comparisons in preprocessor macros if they wish to support
114 * multiple versions of InspIRCd in one file.
116 #define INSPIRCD_VERSION_API 1
119 * This #define allows us to call a method in all
120 * loaded modules in a readable simple way, e.g.:
121 * 'FOREACH_MOD(OnConnect,(user));'
123 #define FOREACH_MOD(y,x) do { \
124 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
125 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
132 catch (CoreException& modexcept) \
134 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
140 * Custom module result handling loop. This is a paired macro, and should only
141 * be used with while_each_hook.
143 * See src/channels.cpp for an example of use.
145 #define DO_EACH_HOOK(n,v,args) \
147 const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
148 for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
155 #define WHILE_EACH_HOOK(n) \
157 catch (CoreException& except_ ## n) \
159 ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
165 * Module result iterator
166 * Runs the given hook until some module returns a useful result.
168 * Example: ModResult result;
169 * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
171 #define FIRST_MOD_RESULT(n,v,args) do { \
172 v = MOD_RES_PASSTHRU; \
173 DO_EACH_HOOK(n,v,args) \
175 if (v != MOD_RES_PASSTHRU) \
178 WHILE_EACH_HOOK(n); \
181 /** Holds a module's Version information.
182 * The members (set by the constructor only) indicate details as to the version number
183 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
185 class CoreExport Version
188 /** Module description
190 const std::string description;
196 /** Server linking description string */
197 const std::string link_data;
199 /** Simple module version */
200 Version(const std::string &desc, int flags = VF_NONE);
202 /** Complex version information, including linking compatability data */
203 Version(const std::string &desc, int flags, const std::string& linkdata);
205 virtual ~Version() {}
208 class CoreExport DataProvider : public ServiceProvider
211 DataProvider(Module* Creator, const std::string& Name)
212 : ServiceProvider(Creator, Name, SERVICE_DATA) {}
215 /** Priority types which can be used by Module::Prioritize()
217 enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
219 /** Implementation-specific flags which may be set in Module::Implements()
223 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
224 I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo,
225 I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
226 I_OnUserMessage, I_OnMode, I_OnSyncUser,
227 I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
228 I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
229 I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
230 I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
231 I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
232 I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
233 I_OnPostTopicChange, I_OnPostConnect,
234 I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
235 I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
236 I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
237 I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
238 I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
242 /** Base class for all InspIRCd modules
243 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
244 * its methods will be called when irc server events occur. class inherited from module must be
245 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
247 class CoreExport Module : public classbase, public usecountbase
249 /** Detach an event from this module
250 * @param i Event type to detach
252 void DetachEvent(Implementation i);
255 /** File that this module was loaded from
257 std::string ModuleSourceFile;
258 /** Reference to the dlopen() value
260 DLLManager* ModuleDLLManager;
262 /** If true, this module will be unloaded soon, further unload attempts will fail
263 * Value is used by the ModuleManager internally, you should not modify it
267 /** Default constructor.
268 * Creates a module class. Don't do any type of hook registration or checks
269 * for other modules here; do that in init().
274 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
276 virtual void init() {}
278 /** Clean up prior to destruction
279 * If you override, you must call this AFTER your module's cleanup
281 virtual CullResult cull();
283 /** Default destructor.
284 * destroys a module class
288 virtual void Prioritize()
292 /** This method is called when you should reload module specific configuration:
293 * on boot, on a /REHASH and on module load.
294 * @param status The current status, can be inspected for more information;
295 * also used for reporting configuration errors and warnings.
297 virtual void ReadConfig(ConfigStatus& status);
299 /** Returns the version number of a Module.
300 * The method should return a Version object with its version information assigned via
303 virtual Version GetVersion() = 0;
305 /** Called when a user connects.
306 * The details of the connecting user are available to you in the parameter User *user
307 * @param user The user who is connecting
309 virtual void OnUserConnect(LocalUser* user);
311 /** Called when a user quits.
312 * The details of the exiting user are available to you in the parameter User *user
313 * This event is only called when the user is fully registered when they quit. To catch
314 * raw disconnections, use the OnUserDisconnect method.
315 * @param user The user who is quitting
316 * @param message The user's quit message (as seen by non-opers)
317 * @param oper_message The user's quit message (as seen by opers)
319 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
321 /** Called whenever a user's socket is closed.
322 * The details of the exiting user are available to you in the parameter User *user
323 * This event is called for all users, registered or not, as a cleanup method for modules
324 * which might assign resources to user, such as dns lookups, objects and sockets.
325 * @param user The user who is disconnecting
327 virtual void OnUserDisconnect(LocalUser* user);
329 /** Called whenever a channel is about to be deleted
330 * @param chan The channel being deleted
331 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
333 virtual ModResult OnChannelPreDelete(Channel *chan);
335 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
336 * @param chan The channel being deleted
338 virtual void OnChannelDelete(Channel* chan);
340 /** Called when a user joins a channel.
341 * The details of the joining user are available to you in the parameter User *user,
342 * and the details of the channel they have joined is available in the variable Channel *channel
343 * @param memb The channel membership being created
344 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
345 * to a channel due to the network sync.
346 * @param created This is true if the join created the channel
347 * @param except_list A list of users not to send to.
349 virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
351 /** Called after a user joins a channel
352 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
354 * @param memb The channel membership created
356 virtual void OnPostJoin(Membership* memb);
358 /** Called when a user parts a channel.
359 * The details of the leaving user are available to you in the parameter User *user,
360 * and the details of the channel they have left is available in the variable Channel *channel
361 * @param memb The channel membership being destroyed
362 * @param partmessage The part message, or an empty string (may be modified)
363 * @param except_list A list of users to not send to.
365 virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
367 /** Called on rehash.
368 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
369 * system. This is called in all cases -- including when this server will not execute the
370 * rehash because it is directed at a remote server.
372 * @param user The user performing the rehash, if any. If this is server initiated, the value of
373 * this variable will be NULL.
374 * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
377 virtual void OnPreRehash(User* user, const std::string ¶meter);
379 /** Called on rehash.
380 * This method is called when a user initiates a module-specific rehash. This can be used to do
381 * expensive operations (such as reloading SSL certificates) that are not executed on a normal
382 * rehash for efficiency. A rehash of this type does not reload the core configuration.
384 * @param user The user performing the rehash.
385 * @param parameter The parameter given to REHASH
387 virtual void OnModuleRehash(User* user, const std::string ¶meter);
389 /** Called whenever a snotice is about to be sent to a snomask.
390 * snomask and type may both be modified; the message may not.
391 * @param snomask The snomask the message is going to (e.g. 'A')
392 * @param type The textual description the snomask will go to (e.g. 'OPER')
393 * @param message The text message to be sent via snotice
394 * @return 1 to block the snotice from being sent entirely, 0 else.
396 virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
398 /** Called whenever a user is about to join a channel, before any processing is done.
399 * Returning a value of 1 from this function stops the process immediately, causing no
400 * output to be sent to the user by the core. If you do this you must produce your own numerics,
401 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
402 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
406 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
407 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
408 * processing on the actual channel record at this point, however the channel NAME will still be passed in
409 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
410 * @param user The user joining the channel
411 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
412 * @param cname The channel name being joined. For new channels this is valid where chan is not.
413 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
414 * You may alter this string to alter the user's modes on the channel.
415 * @param keygiven The key given to join the channel, or an empty string if none was provided
416 * @return 1 To prevent the join, 0 to allow it.
418 virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
420 /** Called whenever a user is about to be kicked.
421 * Returning a value of 1 from this function stops the process immediately, causing no
422 * output to be sent to the user by the core. If you do this you must produce your own numerics,
424 * @param source The user issuing the kick
425 * @param memb The channel membership of the user who is being kicked.
426 * @param reason The kick reason
427 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
429 virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
431 /** Called whenever a user is kicked.
432 * If this method is called, the kick is already underway and cannot be prevented, so
433 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
434 * @param source The user issuing the kick
435 * @param memb The channel membership of the user who was kicked.
436 * @param reason The kick reason
437 * @param except_list A list of users to not send to.
439 virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
441 /** Called whenever a user opers locally.
442 * The User will contain the oper mode 'o' as this function is called after any modifications
443 * are made to the user's structure by the core.
444 * @param user The user who is opering up
445 * @param opertype The opers type name
447 virtual void OnOper(User* user, const std::string &opertype);
449 /** Called after a user opers locally.
450 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
451 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
452 * out the OPERTYPE, etc.
453 * @param user The user who is opering up
454 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
455 * @param opertype The opers type name
457 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
459 /** Called whenever a user types /INFO.
460 * The User will contain the information of the user who typed the command. Modules may use this
461 * method to output their own credits in /INFO (which is the ircd's version of an about box).
462 * It is purposefully not possible to modify any info that has already been output, or halt the list.
463 * You must write a 371 numeric to the user, containing your info in the following format:
465 * <nick> :information here
467 * @param user The user issuing /INFO
469 virtual void OnInfo(User* user);
471 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
472 * Returning 1 from this function stops the process immediately, causing no
473 * output to be sent to the user by the core. If you do this you must produce your own numerics,
474 * notices etc. This is useful for modules which may want to filter invites to channels.
475 * @param source The user who is issuing the INVITE
476 * @param dest The user being invited
477 * @param channel The channel the user is being invited to
478 * @param timeout The time the invite will expire (0 == never)
479 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
481 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
483 /** Called after a user has been successfully invited to a channel.
484 * You cannot prevent the invite from occuring using this function, to do that,
485 * use OnUserPreInvite instead.
486 * @param source The user who is issuing the INVITE
487 * @param dest The user being invited
488 * @param channel The channel the user is being invited to
489 * @param timeout The time the invite will expire (0 == never)
490 * @param notifyrank Rank required to get an invite announcement (if enabled)
491 * @param notifyexcepts List of users to not send the default NOTICE invite announcement to
493 virtual void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts);
495 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
496 * Returning any nonzero value from this function stops the process immediately, causing no
497 * output to be sent to the user by the core. If you do this you must produce your own numerics,
498 * notices etc. This is useful for modules which may want to filter or redirect messages.
499 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
500 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
501 * of where the message is destined to be sent.
502 * @param user The user sending the message
503 * @param dest The target of the message (Channel* or User*)
504 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
505 * @param text Changeable text being sent by the user
506 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
507 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
508 * It will be ignored for private messages.
509 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
510 * @return 1 to deny the message, 0 to allow it
512 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
514 /** Called when sending a message to all "neighbors" of a given user -
515 * that is, all users that share a common channel. This is used in
516 * commands such as NICK, QUIT, etc.
517 * @param source The source of the message
518 * @param include_c Channels to scan for users to include
519 * @param exceptions Map of user->bool that overrides the inclusion decision
521 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
523 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
525 /** Called before local nickname changes. This can be used to implement Q-lines etc.
526 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
527 * module to generate some meaninful output.
528 * @param user The username changing their nick
529 * @param newnick Their new nickname
530 * @return 1 to deny the change, 0 to allow
532 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
534 /** Called after any PRIVMSG sent from a user.
535 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
536 * if target_type is TYPE_CHANNEL.
537 * @param user The user sending the message
538 * @param dest The target of the message
539 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
540 * @param text the text being sent by the user
541 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
542 * @param exempt_list A list of users to not send to.
543 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
545 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
547 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
548 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
549 * if target_type is TYPE_CHANNEL.
550 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
551 * the message has already been vetted. In the case of the other two methods, a later module may stop your
552 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
553 * @param user The user sending the message
554 * @param dest The target of the message
555 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
556 * @param text the text being sent by the user
557 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
558 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
560 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
562 /** Called after every MODE command sent from a user
563 * Either the usertarget or the chantarget variable contains the target of the modes,
564 * the actual target will have a non-NULL pointer.
565 * All changed modes are available in the changelist object.
566 * @param user The user sending the MODEs
567 * @param usertarget The target user of the modes, NULL if the target is a channel
568 * @param chantarget The target channel of the modes, NULL if the target is a user
569 * @param changelist The changed modes.
570 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
571 * for the possible flags.
572 * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
574 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
576 /** Allows modules to synchronize data which relates to users during a netburst.
577 * When this function is called, it will be called from the module which implements
578 * the linking protocol. This currently is m_spanningtree.so.
579 * This function will be called for every user visible on your side
580 * of the burst, allowing you to for example set modes, etc.
581 * @param user The user being syncronized
582 * @param server The target of the burst
584 virtual void OnSyncUser(User* user, ProtocolServer& server);
586 /** Allows modules to synchronize data which relates to channels during a netburst.
587 * When this function is called, it will be called from the module which implements
588 * the linking protocol. This currently is m_spanningtree.so.
589 * This function will be called for every channel visible on your side of the burst,
590 * allowing you to for example set modes, etc.
592 * @param chan The channel being syncronized
593 * @param server The target of the burst
595 virtual void OnSyncChannel(Channel* chan, ProtocolServer& server);
597 /** Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
598 * When the linking module has finished sending all data it wanted to send during a netburst, then
599 * this method is called. You should use the SendMetaData() function after you've
600 * correctly decided how the data should be represented, to send the data.
601 * @param server The target of the burst
603 virtual void OnSyncNetwork(ProtocolServer& server);
605 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
606 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
607 * @param target The Channel* or User* that data should be added to
608 * @param extname The extension name which is being sent
609 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
611 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
613 /** Called whenever a user's hostname is changed.
614 * This event triggers after the host has been set.
615 * @param user The user whos host is being changed
616 * @param newhost The new hostname being set
618 virtual void OnChangeHost(User* user, const std::string &newhost);
620 /** Called whenever a user's GECOS (realname) is changed.
621 * This event triggers after the name has been set.
622 * @param user The user who's GECOS is being changed
623 * @param gecos The new GECOS being set on the user
625 virtual void OnChangeName(User* user, const std::string &gecos);
627 /** Called whenever a user's IDENT is changed.
628 * This event triggers after the name has been set.
629 * @param user The user who's IDENT is being changed
630 * @param ident The new IDENT being set on the user
632 virtual void OnChangeIdent(User* user, const std::string &ident);
634 /** Called whenever an xline is added by a local user.
635 * This method is triggered after the line is added.
636 * @param source The sender of the line or NULL for local server
637 * @param line The xline being added
639 virtual void OnAddLine(User* source, XLine* line);
641 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
642 * This method is triggered after the line is deleted.
643 * @param source The user removing the line or NULL for local server
644 * @param line the line being deleted
646 virtual void OnDelLine(User* source, XLine* line);
648 /** Called whenever an xline expires.
649 * This method is triggered after the line is deleted.
650 * @param line The line being deleted.
652 virtual void OnExpireLine(XLine *line);
654 /** Called before your module is unloaded to clean up Extensibles.
655 * This method is called once for every user and channel on the network,
656 * so that when your module unloads it may clear up any remaining data
657 * in the form of Extensibles added using Extensible::Extend().
658 * If the target_type variable is TYPE_USER, then void* item refers to
659 * a User*, otherwise it refers to a Channel*.
660 * @param target_type The type of item being cleaned
661 * @param item A pointer to the item's class
663 virtual void OnCleanup(int target_type, void* item);
665 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
666 * have been applied. Please note that although you can see remote nickchanges through this function, you should
667 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
668 * check user->server before taking any action (including returning nonzero from the method).
669 * Because this method is called after the nickchange is taken place, no return values are possible
670 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
671 * @param user The user changing their nick
672 * @param oldnick The old nickname of the user before the nickchange
674 virtual void OnUserPostNick(User* user, const std::string &oldnick);
676 /** Called before a mode change via the MODE command, to allow a single access check for
677 * a full mode change (use OnRawMode to check individual modes)
679 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
680 * OnRawMode for each individual mode
682 * @param source the user making the mode change
683 * @param dest the user destination of the umode change (NULL if a channel mode)
684 * @param channel the channel destination of the mode change
685 * @param modes Modes being changed, can be edited
687 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
689 /** Called when a 005 numeric is about to be output.
690 * The module should modify the 005 numeric if needed to indicate its features.
691 * @param tokens The 005 map to be modified if neccessary.
693 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
695 /** Called when a client is disconnected by KILL.
696 * If a client is killed by a server, e.g. a nickname collision or protocol error,
698 * Return 1 from this function to prevent the kill, and 0 from this function to allow
699 * it as normal. If you prevent the kill no output will be sent to the client, it is
700 * down to your module to generate this information.
701 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
702 * If you do so youre risking race conditions, desyncs and worse!
703 * @param source The user sending the KILL
704 * @param dest The user being killed
705 * @param reason The kill reason
706 * @return 1 to prevent the kill, 0 to allow
708 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
710 /** Called whenever a module is loaded.
711 * mod will contain a pointer to the module, and string will contain its name,
712 * for example m_widgets.so. This function is primary for dependency checking,
713 * your module may decide to enable some extra features if it sees that you have
714 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
715 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
716 * but instead operate under reduced functionality, unless the dependency is
717 * absolutely neccessary (e.g. a module that extends the features of another
719 * @param mod A pointer to the new module
721 virtual void OnLoadModule(Module* mod);
723 /** Called whenever a module is unloaded.
724 * mod will contain a pointer to the module, and string will contain its name,
725 * for example m_widgets.so. This function is primary for dependency checking,
726 * your module may decide to enable some extra features if it sees that you have
727 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
728 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
729 * but instead operate under reduced functionality, unless the dependency is
730 * absolutely neccessary (e.g. a module that extends the features of another
732 * @param mod Pointer to the module being unloaded (still valid)
734 virtual void OnUnloadModule(Module* mod);
736 /** Called once every five seconds for background processing.
737 * This timer can be used to control timed features. Its period is not accurate
738 * enough to be used as a clock, but it is gauranteed to be called at least once in
739 * any five second period, directly from the main loop of the server.
740 * @param curtime The current timer derived from time(2)
742 virtual void OnBackgroundTimer(time_t curtime);
744 /** Called whenever any command is about to be executed.
745 * This event occurs for all registered commands, wether they are registered in the core,
746 * or another module, and for invalid commands. Invalid commands may only be sent to this
747 * function when the value of validated is false. By returning 1 from this method you may prevent the
748 * command being executed. If you do this, no output is created by the core, and it is
749 * down to your module to produce any output neccessary.
750 * Note that unless you return 1, you should not destroy any structures (e.g. by using
751 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
752 * method returns, it will be passed an invalid pointer to the user object and crash!)
753 * @param command The command being executed
754 * @param parameters An array of array of characters containing the parameters for the command
755 * @param user the user issuing the command
756 * @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.
757 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
758 * @param original_line The entire original line as passed to the parser from the user
759 * @return 1 to block the command, 0 to allow
761 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
763 /** Called after any command has been executed.
764 * This event occurs for all registered commands, wether they are registered in the core,
765 * or another module, but it will not occur for invalid commands (e.g. ones which do not
766 * exist within the command table). The result code returned by the command handler is
768 * @param command The command being executed
769 * @param parameters An array of array of characters containing the parameters for the command
770 * @param user the user issuing the command
771 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
772 * @param original_line The entire original line as passed to the parser from the user
774 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
776 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
777 * connect class, or accepting any commands.
779 virtual void OnUserInit(LocalUser* user);
781 /** Called to check if a user who is connecting can now be allowed to register
782 * If any modules return false for this function, the user is held in the waiting
783 * state until all modules return true. For example a module which implements ident
784 * lookups will continue to return false for a user until their ident lookup is completed.
785 * Note that the registration timeout for a user overrides these checks, if the registration
786 * timeout is reached, the user is disconnected even if modules report that the user is
787 * not ready to connect.
788 * @param user The user to check
789 * @return true to indicate readiness, false if otherwise
791 virtual ModResult OnCheckReady(LocalUser* user);
793 /** Called whenever a user is about to register their connection (e.g. before the user
794 * is sent the MOTD etc). Modules can use this method if they are performing a function
795 * which must be done before the actual connection is completed (e.g. ident lookups,
796 * dnsbl lookups, etc).
797 * Note that you should NOT delete the user record here by causing a disconnection!
798 * Use OnUserConnect for that instead.
799 * @param user The user registering
800 * @return 1 to indicate user quit, 0 to continue
802 virtual ModResult OnUserRegister(LocalUser* user);
804 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
805 * This method will always be called for each join, wether or not the channel is actually +i, and
806 * determines the outcome of an if statement around the whole section of invite checking code.
807 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
808 * @param user The user joining the channel
809 * @param chan The channel being joined
810 * @return 1 to explicitly allow the join, 0 to proceed as normal
812 virtual ModResult OnCheckInvite(User* user, Channel* chan);
814 /** Called whenever a mode character is processed.
815 * Return 1 from this function to block the mode character from being processed entirely.
816 * @param user The user who is sending the mode
817 * @param chan The channel the mode is being sent to (or NULL if a usermode)
818 * @param mh The mode handler for the mode being changed
819 * @param param The parameter for the mode or an empty string
820 * @param adding true of the mode is being added, false if it is being removed
821 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
822 * to skip all permission checking. Please note that for remote mode changes, your return value
825 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
827 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
828 * This method will always be called for each join, wether or not the channel is actually +k, and
829 * determines the outcome of an if statement around the whole section of key checking code.
830 * if the user specified no key, the keygiven string will be a valid but empty value.
831 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
832 * @param user The user joining the channel
833 * @param chan The channel being joined
834 * @param keygiven The key given on joining the channel.
835 * @return 1 to explicitly allow the join, 0 to proceed as normal
837 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
839 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
840 * This method will always be called for each join, wether or not the channel is actually +l, and
841 * determines the outcome of an if statement around the whole section of channel limit checking code.
842 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
843 * @param user The user joining the channel
844 * @param chan The channel being joined
845 * @return 1 to explicitly allow the join, 0 to proceed as normal
847 virtual ModResult OnCheckLimit(User* user, Channel* chan);
850 * Checks for a user's ban from the channel
851 * @param user The user to check
852 * @param chan The channel to check in
853 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
854 * ban check, or MOD_RES_PASSTHRU to check bans normally
856 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
859 * Checks for a user's match of a single ban
860 * @param user The user to check for match
861 * @param chan The channel on which the match is being checked
862 * @param mask The mask being checked
863 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
864 * ban check, or MOD_RES_PASSTHRU to check bans normally
866 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
868 /** Checks for a match on a given extban type
869 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
870 * ban check, or MOD_RES_PASSTHRU to check bans normally
872 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
874 /** Called on all /STATS commands
875 * This method is triggered for all /STATS use, including stats symbols handled by the core.
876 * @param stats Context of the /STATS request, contains requesting user, list of answer rows etc.
877 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
879 virtual ModResult OnStats(Stats::Context& stats);
881 /** Called whenever a change of a local users displayed host is attempted.
882 * Return 1 to deny the host change, or 0 to allow it.
883 * @param user The user whos host will be changed
884 * @param newhost The new hostname
885 * @return 1 to deny the host change, 0 to allow
887 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
889 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
890 * return 1 to deny the name change, or 0 to allow it.
891 * @param user The user whos GECOS will be changed
892 * @param newhost The new GECOS
893 * @return 1 to deny the GECOS change, 0 to allow
895 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
897 /** Called before a topic is changed.
898 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
899 * As with other 'pre' events, you should only ever block a local event.
900 * @param user The user changing the topic
901 * @param chan The channels who's topic is being changed
902 * @param topic The actual topic text
903 * @return 1 to block the topic change, 0 to allow
905 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
907 /** Called whenever a topic has been changed.
908 * To block topic changes you must use OnPreTopicChange instead.
909 * @param user The user changing the topic
910 * @param chan The channels who's topic is being changed
911 * @param topic The actual topic text
913 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
915 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
916 * The password field (from the config file) is in 'password' and is to be compared against
917 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
918 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
919 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
920 * @param password The password from the configuration file (the password="" value).
921 * @param input The password entered by the user or whoever.
922 * @param hashtype The hash value from the config
923 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
925 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
927 /** Called after a user has fully connected and all modules have executed OnUserConnect
928 * This event is informational only. You should not change any user information in this
929 * event. To do so, use the OnUserConnect method to change the state of local users.
930 * This is called for both local and remote users.
931 * @param user The user who is connecting
933 virtual void OnPostConnect(User* user);
935 /** Called when a port accepts a connection
936 * Return MOD_RES_ACCEPT if you have used the file descriptor.
937 * @param fd The file descriptor returned from accept()
938 * @param sock The socket connection for the new user
939 * @param client The client IP address and port
940 * @param server The server IP address and port
942 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
944 /** Called whenever a user sets away or returns from being away.
945 * The away message is available as a parameter, but should not be modified.
946 * At this stage, it has already been copied into the user record.
947 * If awaymsg is empty, the user is returning from away.
948 * @param user The user setting away
949 * @param awaymsg The away message of the user, or empty if returning from away
950 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
952 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
954 /** Called at intervals for modules to garbage-collect any hashes etc.
955 * Certain data types such as hash_map 'leak' buckets, which must be
956 * tidied up and freed by copying into a new item every so often. This
957 * method is called when it is time to do that.
959 virtual void OnGarbageCollect();
961 /** Called when a user's connect class is being matched
962 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
963 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
965 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
967 #ifdef INSPIRCD_ENABLE_TESTSUITE
968 /** Add test suite hooks here. These are used for testing functionality of a module
969 * via the --testsuite debugging parameter.
971 virtual void OnRunTestSuite();
974 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
975 * For example NAMESX, channel mode +u and +I, and UHNAMES.
976 * @param issuer The user who is going to receive the NAMES list being built
977 * @param item The channel member being considered for inclusion
978 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
979 * prefix mode the member has, can be changed
980 * @param nick The nick to display, initially set to the member's nick, can be changed
981 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
982 * excluded from this NAMES list
984 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
986 virtual ModResult OnNumeric(User* user, const Numeric::Numeric& numeric);
988 /** Called whenever a result from /WHO is about to be returned
989 * @param source The user running the /WHO query
990 * @param params The parameters to the /WHO query
991 * @param user The user that this line of the query is about
992 * @param memb The member shown in this line, NULL if no channel is in this line
993 * @param numeric Numeric to send; modifiable.
994 * @param Return MOD_RES_PASSTHRU to allow the line to be displayed, MOD_RES_DENY to hide it
996 virtual ModResult OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, Numeric::Numeric& numeric);
998 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
999 * a module like m_cgiirc changing it.
1000 * @param user The user whose IP is being set
1002 virtual void OnSetUserIP(LocalUser* user);
1005 /** A list of modules
1007 typedef std::vector<Module*> IntModuleList;
1009 /** An event handler iterator
1011 typedef IntModuleList::iterator EventHandlerIter;
1013 /** ModuleManager takes care of all things module-related
1016 class CoreExport ModuleManager : public fakederef<ModuleManager>
1019 typedef std::vector<ServiceProvider*> ServiceList;
1022 /** Holds a string describing the last module error to occur
1024 std::string LastModuleError;
1026 /** List of loaded modules and shared object/dll handles
1027 * keyed by module name
1029 std::map<std::string, Module*> Modules;
1035 } prioritizationState;
1037 /** Loads all core modules (cmd_*)
1039 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1041 /** Calls the Prioritize() method in all loaded modules
1042 * @return True if all went well, false if a dependency loop was detected
1044 bool PrioritizeHooks();
1047 typedef std::map<std::string, Module*> ModuleMap;
1049 /** Event handler hooks.
1050 * This needs to be public to be used by FOREACH_MOD and friends.
1052 IntModuleList EventHandlers[I_END];
1054 /** List of data services keyed by name */
1055 std::multimap<std::string, ServiceProvider*> DataProviders;
1057 /** A list of ServiceProviders waiting to be registered.
1058 * Non-NULL when constructing a Module, NULL otherwise.
1059 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1060 * automatically registers them (that is, call AddService()) after the Module is constructed,
1061 * and before Module::init() is called.
1062 * If a service is created after the construction of the Module (for example in init()) it
1063 * has to be registered manually.
1065 ServiceList* NewServices;
1067 /** Expands the name of a module by prepending "m_" and appending ".so".
1068 * No-op if the name already has the ".so" extension.
1069 * @param modname Module name to expand
1070 * @return Module name starting with "m_" and ending with ".so"
1072 static std::string ExpandModName(const std::string& modname);
1074 /** Simple, bog-standard, boring constructor.
1082 /** Change the priority of one event in a module.
1083 * Each module event has a list of modules which are attached to that event type.
1084 * If you wish to be called before or after other specific modules, you may use this
1085 * method (usually within void Module::Prioritize()) to set your events priority.
1086 * You may use this call in other methods too, however, this is not supported behaviour
1088 * @param mod The module to change the priority of
1089 * @param i The event to change the priority of
1090 * @param s The state you wish to use for this event. Use one of
1091 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1092 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1093 * to set it to be before or after one or more other modules.
1094 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1095 * then this contains a the module that your module must be placed before
1098 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1100 /** Change the priority of all events in a module.
1101 * @param mod The module to set the priority of
1102 * @param s The priority of all events in the module.
1103 * Note that with this method, it is not possible to effectively use
1104 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1105 * SetPriority method for this, where you may specify other modules to
1106 * be prioritized against.
1108 void SetPriority(Module* mod, Priority s);
1110 /** Attach an event to a module.
1111 * You may later detatch the event with ModuleManager::Detach().
1112 * If your module is unloaded, all events are automatically detatched.
1113 * @param i Event type to attach
1114 * @param mod Module to attach event to
1115 * @return True if the event was attached
1117 bool Attach(Implementation i, Module* mod);
1119 /** Detatch an event from a module.
1120 * This is not required when your module unloads, as the core will
1121 * automatically detatch your module from all events it is attached to.
1122 * @param i Event type to detach
1123 * @param mod Module to detach event from
1124 * @return True if the event was detached
1126 bool Detach(Implementation i, Module* mod);
1128 /** Attach an array of events to a module
1129 * @param i Event types (array) to attach
1130 * @param mod Module to attach events to
1131 * @param sz The size of the implementation array
1133 void Attach(Implementation* i, Module* mod, size_t sz);
1135 /** Detach all events from a module (used on unload)
1136 * @param mod Module to detach from
1138 void DetachAll(Module* mod);
1140 /** Attach all events to a module (used on module load)
1141 * @param mod Module to attach to all events
1143 void AttachAll(Module* mod);
1145 /** Returns text describing the last module error
1146 * @return The last error message to occur
1148 std::string& LastError();
1150 /** Load a given module file
1151 * @param filename The file to load
1152 * @param defer Defer module init (loading many modules)
1153 * @return True if the module was found and loaded
1155 bool Load(const std::string& filename, bool defer = false);
1157 /** Unload a given module file. Note that the module will not be
1158 * completely gone until the cull list has finished processing.
1160 * @return true on success; if false, LastError will give a reason
1162 bool Unload(Module* module);
1164 /** Called by the InspIRCd constructor to load all modules from the config file.
1168 void DoSafeUnload(Module*);
1170 /** Check if a module can be unloaded and if yes, prepare it for unload
1171 * @param mod Module to be unloaded
1172 * @return True if the module is unloadable, false otherwise.
1173 * If true the module must be unloaded in the current main loop iteration.
1175 bool CanUnload(Module* mod);
1177 /** Find a module by name, and return a Module* to it.
1178 * This is preferred over iterating the module lists yourself.
1179 * @param name The module name to look up
1180 * @return A pointer to the module, or NULL if the module cannot be found
1182 Module* Find(const std::string &name);
1184 /** Register a service provided by a module */
1185 void AddService(ServiceProvider&);
1187 /** Unregister a service provided by a module */
1188 void DelService(ServiceProvider&);
1190 /** Register all services in a given ServiceList
1191 * @param list The list containing the services to register
1193 void AddServices(const ServiceList& list);
1195 inline void AddServices(ServiceProvider** list, int count)
1197 for(int i=0; i < count; i++)
1198 AddService(*list[i]);
1201 /** Find a service by name.
1202 * If multiple modules provide a given service, the first one loaded will be chosen.
1204 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1206 template<typename T> inline T* FindDataService(const std::string& name)
1208 return static_cast<T*>(FindService(SERVICE_DATA, name));
1211 /** Get a map of all loaded modules keyed by their name
1212 * @return A ModuleMap containing all loaded modules
1214 const ModuleMap& GetModules() const { return Modules; }
1216 /** Make a service referenceable by dynamic_references
1217 * @param name Name that will be used by dynamic_references to find the object
1218 * @param service Service to make referenceable by dynamic_references
1220 void AddReferent(const std::string& name, ServiceProvider* service);
1222 /** Make a service no longer referenceable by dynamic_references
1223 * @param service Service to make no longer referenceable by dynamic_references
1225 void DelReferent(ServiceProvider* service);
1228 /** Do not mess with these functions unless you know the C preprocessor
1229 * well enough to explain why they are needed. The order is important.
1231 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1232 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1233 #define MODULE_INIT_STR_FN_1(x) #x
1234 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1235 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1236 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1240 struct AllCommandList {
1241 typedef Command* (*fn)(Module*);
1242 AllCommandList(fn cmd);
1244 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1245 static const AllCommandList PREP_ ## x(&MK_ ## x);
1247 struct AllModuleList {
1248 typedef Module* (*fn)();
1251 AllModuleList(fn mod, const std::string& Name);
1254 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1255 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1259 /** This definition is used as shorthand for the various classes
1260 * and functions needed to make a module loadable by the OS.
1261 * It defines the class factory and external init_module function.
1265 #define MODULE_INIT(y) \
1266 extern "C" DllExport Module * MODULE_INIT_SYM() \
1270 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1272 switch ( nReason ) \
1274 case DLL_PROCESS_ATTACH: \
1275 case DLL_PROCESS_DETACH: \
1280 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1284 #define MODULE_INIT(y) \
1285 extern "C" DllExport Module * MODULE_INIT_SYM() \
1289 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1292 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)