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, I_OnWhois,
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_OnWhoisLine, 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 /WHOIS is performed on a local user.
473 * The source parameter contains the details of the user who issued the WHOIS command, and
474 * the dest parameter contains the information of the user they are whoising.
475 * @param source The user issuing the WHOIS command
476 * @param dest The user who is being WHOISed
478 virtual void OnWhois(User* source, User* dest);
480 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
481 * Returning 1 from this function stops the process immediately, causing no
482 * output to be sent to the user by the core. If you do this you must produce your own numerics,
483 * notices etc. This is useful for modules which may want to filter invites to channels.
484 * @param source The user who is issuing the INVITE
485 * @param dest The user being invited
486 * @param channel The channel the user is being invited to
487 * @param timeout The time the invite will expire (0 == never)
488 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
490 virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
492 /** Called after a user has been successfully invited to a channel.
493 * You cannot prevent the invite from occuring using this function, to do that,
494 * use OnUserPreInvite instead.
495 * @param source The user who is issuing the INVITE
496 * @param dest The user being invited
497 * @param channel The channel the user is being invited to
498 * @param timeout The time the invite will expire (0 == never)
500 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
502 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
503 * Returning any nonzero value from this function stops the process immediately, causing no
504 * output to be sent to the user by the core. If you do this you must produce your own numerics,
505 * notices etc. This is useful for modules which may want to filter or redirect messages.
506 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
507 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
508 * of where the message is destined to be sent.
509 * @param user The user sending the message
510 * @param dest The target of the message (Channel* or User*)
511 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
512 * @param text Changeable text being sent by the user
513 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
514 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
515 * It will be ignored for private messages.
516 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
517 * @return 1 to deny the message, 0 to allow it
519 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
521 /** Called when sending a message to all "neighbors" of a given user -
522 * that is, all users that share a common channel. This is used in
523 * commands such as NICK, QUIT, etc.
524 * @param source The source of the message
525 * @param include_c Channels to scan for users to include
526 * @param exceptions Map of user->bool that overrides the inclusion decision
528 * Set exceptions[user] = true to include, exceptions[user] = false to exclude
530 virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
532 /** Called before local nickname changes. This can be used to implement Q-lines etc.
533 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
534 * module to generate some meaninful output.
535 * @param user The username changing their nick
536 * @param newnick Their new nickname
537 * @return 1 to deny the change, 0 to allow
539 virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
541 /** Called after any PRIVMSG sent from a user.
542 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
543 * if target_type is TYPE_CHANNEL.
544 * @param user The user sending the message
545 * @param dest The target of the message
546 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
547 * @param text the text being sent by the user
548 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
549 * @param exempt_list A list of users to not send to.
550 * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
552 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
554 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
555 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
556 * if target_type is TYPE_CHANNEL.
557 * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
558 * the message has already been vetted. In the case of the other two methods, a later module may stop your
559 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
560 * @param user The user sending the message
561 * @param dest The target of the message
562 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
563 * @param text the text being sent by the user
564 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
565 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
567 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
569 /** Called after every MODE command sent from a user
570 * Either the usertarget or the chantarget variable contains the target of the modes,
571 * the actual target will have a non-NULL pointer.
572 * All changed modes are available in the changelist object.
573 * @param user The user sending the MODEs
574 * @param usertarget The target user of the modes, NULL if the target is a channel
575 * @param chantarget The target channel of the modes, NULL if the target is a user
576 * @param changelist The changed modes.
577 * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
578 * for the possible flags.
579 * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
581 virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
583 /** Allows modules to synchronize data which relates to users during a netburst.
584 * When this function is called, it will be called from the module which implements
585 * the linking protocol. This currently is m_spanningtree.so.
586 * This function will be called for every user visible on your side
587 * of the burst, allowing you to for example set modes, etc.
588 * @param user The user being syncronized
589 * @param server The target of the burst
591 virtual void OnSyncUser(User* user, ProtocolServer& server);
593 /** Allows modules to synchronize data which relates to channels during a netburst.
594 * When this function is called, it will be called from the module which implements
595 * the linking protocol. This currently is m_spanningtree.so.
596 * This function will be called for every channel visible on your side of the burst,
597 * allowing you to for example set modes, etc.
599 * @param chan The channel being syncronized
600 * @param server The target of the burst
602 virtual void OnSyncChannel(Channel* chan, ProtocolServer& server);
604 /** Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
605 * When the linking module has finished sending all data it wanted to send during a netburst, then
606 * this method is called. You should use the SendMetaData() function after you've
607 * correctly decided how the data should be represented, to send the data.
608 * @param server The target of the burst
610 virtual void OnSyncNetwork(ProtocolServer& server);
612 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
613 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
614 * @param target The Channel* or User* that data should be added to
615 * @param extname The extension name which is being sent
616 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
618 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
620 /** Called whenever a user's hostname is changed.
621 * This event triggers after the host has been set.
622 * @param user The user whos host is being changed
623 * @param newhost The new hostname being set
625 virtual void OnChangeHost(User* user, const std::string &newhost);
627 /** Called whenever a user's GECOS (realname) is changed.
628 * This event triggers after the name has been set.
629 * @param user The user who's GECOS is being changed
630 * @param gecos The new GECOS being set on the user
632 virtual void OnChangeName(User* user, const std::string &gecos);
634 /** Called whenever a user's IDENT is changed.
635 * This event triggers after the name has been set.
636 * @param user The user who's IDENT is being changed
637 * @param ident The new IDENT being set on the user
639 virtual void OnChangeIdent(User* user, const std::string &ident);
641 /** Called whenever an xline is added by a local user.
642 * This method is triggered after the line is added.
643 * @param source The sender of the line or NULL for local server
644 * @param line The xline being added
646 virtual void OnAddLine(User* source, XLine* line);
648 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
649 * This method is triggered after the line is deleted.
650 * @param source The user removing the line or NULL for local server
651 * @param line the line being deleted
653 virtual void OnDelLine(User* source, XLine* line);
655 /** Called whenever an xline expires.
656 * This method is triggered after the line is deleted.
657 * @param line The line being deleted.
659 virtual void OnExpireLine(XLine *line);
661 /** Called before your module is unloaded to clean up Extensibles.
662 * This method is called once for every user and channel on the network,
663 * so that when your module unloads it may clear up any remaining data
664 * in the form of Extensibles added using Extensible::Extend().
665 * If the target_type variable is TYPE_USER, then void* item refers to
666 * a User*, otherwise it refers to a Channel*.
667 * @param target_type The type of item being cleaned
668 * @param item A pointer to the item's class
670 virtual void OnCleanup(int target_type, void* item);
672 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
673 * have been applied. Please note that although you can see remote nickchanges through this function, you should
674 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
675 * check user->server before taking any action (including returning nonzero from the method).
676 * Because this method is called after the nickchange is taken place, no return values are possible
677 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
678 * @param user The user changing their nick
679 * @param oldnick The old nickname of the user before the nickchange
681 virtual void OnUserPostNick(User* user, const std::string &oldnick);
683 /** Called before a mode change via the MODE command, to allow a single access check for
684 * a full mode change (use OnRawMode to check individual modes)
686 * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
687 * OnRawMode for each individual mode
689 * @param source the user making the mode change
690 * @param dest the user destination of the umode change (NULL if a channel mode)
691 * @param channel the channel destination of the mode change
692 * @param modes Modes being changed, can be edited
694 virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, Modes::ChangeList& modes);
696 /** Called when a 005 numeric is about to be output.
697 * The module should modify the 005 numeric if needed to indicate its features.
698 * @param tokens The 005 map to be modified if neccessary.
700 virtual void On005Numeric(std::map<std::string, std::string>& tokens);
702 /** Called when a client is disconnected by KILL.
703 * If a client is killed by a server, e.g. a nickname collision or protocol error,
705 * Return 1 from this function to prevent the kill, and 0 from this function to allow
706 * it as normal. If you prevent the kill no output will be sent to the client, it is
707 * down to your module to generate this information.
708 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
709 * If you do so youre risking race conditions, desyncs and worse!
710 * @param source The user sending the KILL
711 * @param dest The user being killed
712 * @param reason The kill reason
713 * @return 1 to prevent the kill, 0 to allow
715 virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
717 /** Called whenever a module is loaded.
718 * mod will contain a pointer to the module, and string will contain its name,
719 * for example m_widgets.so. This function is primary for dependency checking,
720 * your module may decide to enable some extra features if it sees that you have
721 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
722 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
723 * but instead operate under reduced functionality, unless the dependency is
724 * absolutely neccessary (e.g. a module that extends the features of another
726 * @param mod A pointer to the new module
728 virtual void OnLoadModule(Module* mod);
730 /** Called whenever a module is unloaded.
731 * mod will contain a pointer to the module, and string will contain its name,
732 * for example m_widgets.so. This function is primary for dependency checking,
733 * your module may decide to enable some extra features if it sees that you have
734 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
735 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
736 * but instead operate under reduced functionality, unless the dependency is
737 * absolutely neccessary (e.g. a module that extends the features of another
739 * @param mod Pointer to the module being unloaded (still valid)
741 virtual void OnUnloadModule(Module* mod);
743 /** Called once every five seconds for background processing.
744 * This timer can be used to control timed features. Its period is not accurate
745 * enough to be used as a clock, but it is gauranteed to be called at least once in
746 * any five second period, directly from the main loop of the server.
747 * @param curtime The current timer derived from time(2)
749 virtual void OnBackgroundTimer(time_t curtime);
751 /** Called whenever any command is about to be executed.
752 * This event occurs for all registered commands, wether they are registered in the core,
753 * or another module, and for invalid commands. Invalid commands may only be sent to this
754 * function when the value of validated is false. By returning 1 from this method you may prevent the
755 * command being executed. If you do this, no output is created by the core, and it is
756 * down to your module to produce any output neccessary.
757 * Note that unless you return 1, you should not destroy any structures (e.g. by using
758 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
759 * method returns, it will be passed an invalid pointer to the user object and crash!)
760 * @param command The command being executed
761 * @param parameters An array of array of characters containing the parameters for the command
762 * @param user the user issuing the command
763 * @param validated True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc.
764 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
765 * @param original_line The entire original line as passed to the parser from the user
766 * @return 1 to block the command, 0 to allow
768 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
770 /** Called after any command has been executed.
771 * This event occurs for all registered commands, wether they are registered in the core,
772 * or another module, but it will not occur for invalid commands (e.g. ones which do not
773 * exist within the command table). The result code returned by the command handler is
775 * @param command The command being executed
776 * @param parameters An array of array of characters containing the parameters for the command
777 * @param user the user issuing the command
778 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
779 * @param original_line The entire original line as passed to the parser from the user
781 virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
783 /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
784 * connect class, or accepting any commands.
786 virtual void OnUserInit(LocalUser* user);
788 /** Called to check if a user who is connecting can now be allowed to register
789 * If any modules return false for this function, the user is held in the waiting
790 * state until all modules return true. For example a module which implements ident
791 * lookups will continue to return false for a user until their ident lookup is completed.
792 * Note that the registration timeout for a user overrides these checks, if the registration
793 * timeout is reached, the user is disconnected even if modules report that the user is
794 * not ready to connect.
795 * @param user The user to check
796 * @return true to indicate readiness, false if otherwise
798 virtual ModResult OnCheckReady(LocalUser* user);
800 /** Called whenever a user is about to register their connection (e.g. before the user
801 * is sent the MOTD etc). Modules can use this method if they are performing a function
802 * which must be done before the actual connection is completed (e.g. ident lookups,
803 * dnsbl lookups, etc).
804 * Note that you should NOT delete the user record here by causing a disconnection!
805 * Use OnUserConnect for that instead.
806 * @param user The user registering
807 * @return 1 to indicate user quit, 0 to continue
809 virtual ModResult OnUserRegister(LocalUser* user);
811 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
812 * This method will always be called for each join, wether or not the channel is actually +i, and
813 * determines the outcome of an if statement around the whole section of invite checking code.
814 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
815 * @param user The user joining the channel
816 * @param chan The channel being joined
817 * @return 1 to explicitly allow the join, 0 to proceed as normal
819 virtual ModResult OnCheckInvite(User* user, Channel* chan);
821 /** Called whenever a mode character is processed.
822 * Return 1 from this function to block the mode character from being processed entirely.
823 * @param user The user who is sending the mode
824 * @param chan The channel the mode is being sent to (or NULL if a usermode)
825 * @param mh The mode handler for the mode being changed
826 * @param param The parameter for the mode or an empty string
827 * @param adding true of the mode is being added, false if it is being removed
828 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
829 * to skip all permission checking. Please note that for remote mode changes, your return value
832 virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
834 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
835 * This method will always be called for each join, wether or not the channel is actually +k, and
836 * determines the outcome of an if statement around the whole section of key checking code.
837 * if the user specified no key, the keygiven string will be a valid but empty value.
838 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
839 * @param user The user joining the channel
840 * @param chan The channel being joined
841 * @param keygiven The key given on joining the channel.
842 * @return 1 to explicitly allow the join, 0 to proceed as normal
844 virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
846 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
847 * This method will always be called for each join, wether or not the channel is actually +l, and
848 * determines the outcome of an if statement around the whole section of channel limit checking code.
849 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
850 * @param user The user joining the channel
851 * @param chan The channel being joined
852 * @return 1 to explicitly allow the join, 0 to proceed as normal
854 virtual ModResult OnCheckLimit(User* user, Channel* chan);
857 * Checks for a user's ban from the channel
858 * @param user The user to check
859 * @param chan The channel to check in
860 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
861 * ban check, or MOD_RES_PASSTHRU to check bans normally
863 virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
866 * Checks for a user's match of a single ban
867 * @param user The user to check for match
868 * @param chan The channel on which the match is being checked
869 * @param mask The mask being checked
870 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
871 * ban check, or MOD_RES_PASSTHRU to check bans normally
873 virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
875 /** Checks for a match on a given extban type
876 * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
877 * ban check, or MOD_RES_PASSTHRU to check bans normally
879 virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
881 /** Called on all /STATS commands
882 * This method is triggered for all /STATS use, including stats symbols handled by the core.
883 * @param symbol the symbol provided to /STATS
884 * @param user the user issuing the /STATS command
885 * @param results A string_list to append results into. You should put all your results
886 * into this string_list, rather than displaying them directly, so that your handler will
887 * work when remote STATS queries are received.
888 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
890 virtual ModResult OnStats(char symbol, User* user, string_list &results);
892 /** Called whenever a change of a local users displayed host is attempted.
893 * Return 1 to deny the host change, or 0 to allow it.
894 * @param user The user whos host will be changed
895 * @param newhost The new hostname
896 * @return 1 to deny the host change, 0 to allow
898 virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
900 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
901 * return 1 to deny the name change, or 0 to allow it.
902 * @param user The user whos GECOS will be changed
903 * @param newhost The new GECOS
904 * @return 1 to deny the GECOS change, 0 to allow
906 virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
908 /** Called before a topic is changed.
909 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
910 * As with other 'pre' events, you should only ever block a local event.
911 * @param user The user changing the topic
912 * @param chan The channels who's topic is being changed
913 * @param topic The actual topic text
914 * @return 1 to block the topic change, 0 to allow
916 virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
918 /** Called whenever a topic has been changed.
919 * To block topic changes you must use OnPreTopicChange instead.
920 * @param user The user changing the topic
921 * @param chan The channels who's topic is being changed
922 * @param topic The actual topic text
924 virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
926 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
927 * The password field (from the config file) is in 'password' and is to be compared against
928 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
929 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
930 * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
931 * @param password The password from the configuration file (the password="" value).
932 * @param input The password entered by the user or whoever.
933 * @param hashtype The hash value from the config
934 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
936 virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
938 /** Called after a user has fully connected and all modules have executed OnUserConnect
939 * This event is informational only. You should not change any user information in this
940 * event. To do so, use the OnUserConnect method to change the state of local users.
941 * This is called for both local and remote users.
942 * @param user The user who is connecting
944 virtual void OnPostConnect(User* user);
946 /** Called when a port accepts a connection
947 * Return MOD_RES_ACCEPT if you have used the file descriptor.
948 * @param fd The file descriptor returned from accept()
949 * @param sock The socket connection for the new user
950 * @param client The client IP address and port
951 * @param server The server IP address and port
953 virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
955 /** Called whenever a user sets away or returns from being away.
956 * The away message is available as a parameter, but should not be modified.
957 * At this stage, it has already been copied into the user record.
958 * If awaymsg is empty, the user is returning from away.
959 * @param user The user setting away
960 * @param awaymsg The away message of the user, or empty if returning from away
961 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
963 virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
965 /** Called whenever a line of WHOIS output is sent to a user.
966 * You may change the numeric and the text of the output by changing
967 * the values numeric and text, but you cannot change the user the
968 * numeric is sent to. You may however change the user's User values.
969 * @param user The user the numeric is being sent to
970 * @param dest The user being WHOISed
971 * @param numeric The numeric of the line being sent
972 * @param text The text of the numeric, including any parameters
973 * @return nonzero to drop the line completely so that the user does not
974 * receive it, or zero to allow the line to be sent.
976 virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
978 /** Called at intervals for modules to garbage-collect any hashes etc.
979 * Certain data types such as hash_map 'leak' buckets, which must be
980 * tidied up and freed by copying into a new item every so often. This
981 * method is called when it is time to do that.
983 virtual void OnGarbageCollect();
985 /** Called when a user's connect class is being matched
986 * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
987 * MOD_RES_PASSTHRU to allow normal matching (by host/port).
989 virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
991 #ifdef INSPIRCD_ENABLE_TESTSUITE
992 /** Add test suite hooks here. These are used for testing functionality of a module
993 * via the --testsuite debugging parameter.
995 virtual void OnRunTestSuite();
998 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
999 * For example NAMESX, channel mode +u and +I, and UHNAMES.
1000 * @param issuer The user who is going to receive the NAMES list being built
1001 * @param item The channel member being considered for inclusion
1002 * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
1003 * prefix mode the member has, can be changed
1004 * @param nick The nick to display, initially set to the member's nick, can be changed
1005 * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
1006 * excluded from this NAMES list
1008 virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
1010 virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
1012 /** Called whenever a result from /WHO is about to be returned
1013 * @param source The user running the /WHO query
1014 * @param params The parameters to the /WHO query
1015 * @param user The user that this line of the query is about
1016 * @param memb The member shown in this line, NULL if no channel is in this line
1017 * @param line The raw line to send; modifiable, if empty no line will be returned.
1019 virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, std::string& line);
1021 /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
1022 * a module like m_cgiirc changing it.
1023 * @param user The user whose IP is being set
1025 virtual void OnSetUserIP(LocalUser* user);
1028 /** A list of modules
1030 typedef std::vector<Module*> IntModuleList;
1032 /** An event handler iterator
1034 typedef IntModuleList::iterator EventHandlerIter;
1036 /** ModuleManager takes care of all things module-related
1039 class CoreExport ModuleManager : public fakederef<ModuleManager>
1042 typedef std::vector<ServiceProvider*> ServiceList;
1045 /** Holds a string describing the last module error to occur
1047 std::string LastModuleError;
1049 /** List of loaded modules and shared object/dll handles
1050 * keyed by module name
1052 std::map<std::string, Module*> Modules;
1058 } prioritizationState;
1060 /** Internal unload module hook */
1061 bool CanUnload(Module*);
1063 /** Loads all core modules (cmd_*)
1065 void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
1067 /** Calls the Prioritize() method in all loaded modules
1068 * @return True if all went well, false if a dependency loop was detected
1070 bool PrioritizeHooks();
1073 typedef std::map<std::string, Module*> ModuleMap;
1075 /** Event handler hooks.
1076 * This needs to be public to be used by FOREACH_MOD and friends.
1078 IntModuleList EventHandlers[I_END];
1080 /** List of data services keyed by name */
1081 std::multimap<std::string, ServiceProvider*> DataProviders;
1083 /** A list of ServiceProviders waiting to be registered.
1084 * Non-NULL when constructing a Module, NULL otherwise.
1085 * When non-NULL ServiceProviders add themselves to this list on creation and the core
1086 * automatically registers them (that is, call AddService()) after the Module is constructed,
1087 * and before Module::init() is called.
1088 * If a service is created after the construction of the Module (for example in init()) it
1089 * has to be registered manually.
1091 ServiceList* NewServices;
1093 /** Simple, bog-standard, boring constructor.
1101 /** Change the priority of one event in a module.
1102 * Each module event has a list of modules which are attached to that event type.
1103 * If you wish to be called before or after other specific modules, you may use this
1104 * method (usually within void Module::Prioritize()) to set your events priority.
1105 * You may use this call in other methods too, however, this is not supported behaviour
1107 * @param mod The module to change the priority of
1108 * @param i The event to change the priority of
1109 * @param s The state you wish to use for this event. Use one of
1110 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1111 * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
1112 * to set it to be before or after one or more other modules.
1113 * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
1114 * then this contains a the module that your module must be placed before
1117 bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
1119 /** Change the priority of all events in a module.
1120 * @param mod The module to set the priority of
1121 * @param s The priority of all events in the module.
1122 * Note that with this method, it is not possible to effectively use
1123 * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
1124 * SetPriority method for this, where you may specify other modules to
1125 * be prioritized against.
1127 void SetPriority(Module* mod, Priority s);
1129 /** Attach an event to a module.
1130 * You may later detatch the event with ModuleManager::Detach().
1131 * If your module is unloaded, all events are automatically detatched.
1132 * @param i Event type to attach
1133 * @param mod Module to attach event to
1134 * @return True if the event was attached
1136 bool Attach(Implementation i, Module* mod);
1138 /** Detatch an event from a module.
1139 * This is not required when your module unloads, as the core will
1140 * automatically detatch your module from all events it is attached to.
1141 * @param i Event type to detach
1142 * @param mod Module to detach event from
1143 * @return True if the event was detached
1145 bool Detach(Implementation i, Module* mod);
1147 /** Attach an array of events to a module
1148 * @param i Event types (array) to attach
1149 * @param mod Module to attach events to
1150 * @param sz The size of the implementation array
1152 void Attach(Implementation* i, Module* mod, size_t sz);
1154 /** Detach all events from a module (used on unload)
1155 * @param mod Module to detach from
1157 void DetachAll(Module* mod);
1159 /** Attach all events to a module (used on module load)
1160 * @param mod Module to attach to all events
1162 void AttachAll(Module* mod);
1164 /** Returns text describing the last module error
1165 * @return The last error message to occur
1167 std::string& LastError();
1169 /** Load a given module file
1170 * @param filename The file to load
1171 * @param defer Defer module init (loading many modules)
1172 * @return True if the module was found and loaded
1174 bool Load(const std::string& filename, bool defer = false);
1176 /** Unload a given module file. Note that the module will not be
1177 * completely gone until the cull list has finished processing.
1179 * @return true on success; if false, LastError will give a reason
1181 bool Unload(Module* module);
1183 /** Run an asynchronous reload of the given module. When the reload is
1184 * complete, the callback will be run with true if the reload succeeded
1185 * and false if it did not.
1187 void Reload(Module* module, HandlerBase1<void, bool>* callback);
1189 /** Called by the InspIRCd constructor to load all modules from the config file.
1193 void DoSafeUnload(Module*);
1195 /** Find a module by name, and return a Module* to it.
1196 * This is preferred over iterating the module lists yourself.
1197 * @param name The module name to look up
1198 * @return A pointer to the module, or NULL if the module cannot be found
1200 Module* Find(const std::string &name);
1202 /** Register a service provided by a module */
1203 void AddService(ServiceProvider&);
1205 /** Unregister a service provided by a module */
1206 void DelService(ServiceProvider&);
1208 /** Register all services in a given ServiceList
1209 * @param list The list containing the services to register
1211 void AddServices(const ServiceList& list);
1213 inline void AddServices(ServiceProvider** list, int count)
1215 for(int i=0; i < count; i++)
1216 AddService(*list[i]);
1219 /** Find a service by name.
1220 * If multiple modules provide a given service, the first one loaded will be chosen.
1222 ServiceProvider* FindService(ServiceType Type, const std::string& name);
1224 template<typename T> inline T* FindDataService(const std::string& name)
1226 return static_cast<T*>(FindService(SERVICE_DATA, name));
1229 /** Get a map of all loaded modules keyed by their name
1230 * @return A ModuleMap containing all loaded modules
1232 const ModuleMap& GetModules() const { return Modules; }
1235 /** Do not mess with these functions unless you know the C preprocessor
1236 * well enough to explain why they are needed. The order is important.
1238 #define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
1239 #define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
1240 #define MODULE_INIT_STR_FN_1(x) #x
1241 #define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
1242 #define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
1243 #define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
1247 struct AllCommandList {
1248 typedef Command* (*fn)(Module*);
1249 AllCommandList(fn cmd);
1251 #define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
1252 static const AllCommandList PREP_ ## x(&MK_ ## x);
1254 struct AllModuleList {
1255 typedef Module* (*fn)();
1258 AllModuleList(fn mod, const std::string& Name);
1261 #define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
1262 static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
1266 /** This definition is used as shorthand for the various classes
1267 * and functions needed to make a module loadable by the OS.
1268 * It defines the class factory and external init_module function.
1272 #define MODULE_INIT(y) \
1273 extern "C" DllExport Module * MODULE_INIT_SYM() \
1277 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1279 switch ( nReason ) \
1281 case DLL_PROCESS_ATTACH: \
1282 case DLL_PROCESS_DETACH: \
1287 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1291 #define MODULE_INIT(y) \
1292 extern "C" DllExport Module * MODULE_INIT_SYM() \
1296 extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
1299 #define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)