1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
21 #include "inspsocket.h"
31 /** Used with OnAccessCheck() method of modules
33 enum AccessControlType {
34 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
35 ACR_DENY, // deny the action
36 ACR_ALLOW, // allow the action
37 AC_KICK, // a user is being kicked
38 AC_DEOP, // a user is being deopped
39 AC_OP, // a user is being opped
40 AC_VOICE, // a user is being voiced
41 AC_DEVOICE, // a user is being devoiced
42 AC_HALFOP, // a user is being halfopped
43 AC_DEHALFOP, // a user is being dehalfopped
44 AC_INVITE, // a user is being invited
45 AC_GENERAL_MODE // a channel mode is being changed
48 /** Used to define a set of behavior bits for a module
51 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
52 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
53 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
54 VF_COMMON = 8 // module needs to be common on all servers in a network to link
57 /** Used with SendToMode()
64 /** Used to represent an event type, for user, channel or server
66 enum TargetTypeFlags {
73 /** Used to represent wether a message was PRIVMSG or NOTICE
80 /** If you change the module API, change this value.
81 * If you have enabled ipv6, the sizes of structs is
82 * different, and modules will be incompatible with
83 * ipv4 servers, so this value will be ten times as
84 * high on ipv6 servers.
86 #define NATIVE_API_VERSION 12000
88 #define API_VERSION (NATIVE_API_VERSION * 10)
90 #define API_VERSION (NATIVE_API_VERSION * 1)
95 /* Forward-delacare module for ModuleMessage etc
100 /** Low level definition of a FileReader classes file cache area -
101 * a text file seperated into lines.
103 typedef std::deque<std::string> file_cache;
105 /** A set of strings.
107 typedef file_cache string_list;
109 /** Holds a list of 'published features' for modules.
111 typedef std::map<std::string,Module*> featurelist;
113 /** Holds a list of modules which implement an interface
115 typedef std::deque<Module*> modulelist;
117 /** Holds a list of all modules which implement interfaces, by interface name
119 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
122 * This #define allows us to call a method in all
123 * loaded modules in a readable simple way, e.g.:
124 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
126 #define FOREACH_MOD(y,x) do { \
127 EventHandlerIter safei; \
128 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
136 catch (CoreException& modexcept) \
138 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
145 * This #define allows us to call a method in all
146 * loaded modules in a readable simple way and pass
147 * an instance pointer to the macro. e.g.:
148 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
150 #define FOREACH_MOD_I(z,y,x) do { \
151 EventHandlerIter safei; \
152 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
160 catch (CoreException& modexcept) \
162 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
169 * This define is similar to the one above but returns a result in MOD_RESULT.
170 * The first module to return a nonzero result is the value to be accepted,
171 * and any modules after are ignored.
173 #define FOREACH_RESULT(y,x) \
175 EventHandlerIter safei; \
177 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
183 int res = (*_i)->x ; \
189 catch (CoreException& modexcept) \
191 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
199 * This define is similar to the one above but returns a result in MOD_RESULT.
200 * The first module to return a nonzero result is the value to be accepted,
201 * and any modules after are ignored.
203 #define FOREACH_RESULT_I(z,y,x) \
205 EventHandlerIter safei; \
207 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
213 int res = (*_i)->x ; \
219 catch (CoreException& modexcept) \
221 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
227 /** Represents a non-local user.
228 * (in fact, any FD less than -1 does)
230 #define FD_MAGIC_NUMBER -42
234 /** Is a local user */
235 #define IS_LOCAL(x) ((x->GetFd() > -1))
236 /** Is a remote user */
237 #define IS_REMOTE(x) (x->GetFd() < 0)
238 /** Is a module created user */
239 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
241 #define IS_OPER(x) (!x->oper.empty())
243 #define IS_AWAY(x) (!x->awaymsg.empty())
245 /** Holds a module's Version information.
246 * The four members (set by the constructor only) indicate details as to the version number
247 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
248 * The flags and API values represent the module flags and API version of the module.
249 * The API version of a module must match the API version of the core exactly for the module to
252 class CoreExport Version : public classbase
255 /** Version numbers, build number, flags and API version
257 const int Major, Minor, Revision, Build, Flags, API;
259 /** Initialize version class
261 Version(int major, int minor, int revision, int build, int flags, int api_ver);
264 /** The ModuleMessage class is the base class of Request and Event
265 * This class is used to represent a basic data structure which is passed
266 * between modules for safe inter-module communications.
268 class CoreExport ModuleMessage : public Extensible
273 virtual ~ModuleMessage() {};
276 /** The Request class is a unicast message directed at a given module.
277 * When this class is properly instantiated it may be sent to a module
278 * using the Send() method, which will call the given module's OnRequest
279 * method with this class as its parameter.
281 class CoreExport Request : public ModuleMessage
284 /** This member holds a pointer to arbitary data set by the emitter of the message
287 /** This should be a null-terminated string identifying the type of request,
288 * all modules should define this and use it to determine the nature of the
289 * request before they attempt to cast the Request in any way.
292 /** This is a pointer to the sender of the message, which can be used to
293 * directly trigger events, or to create a reply.
296 /** The single destination of the Request
300 /** Create a new Request
301 * This is for the 'old' way of casting whatever the data is
302 * to char* and hoping you get the right thing at the other end.
303 * This is slowly being depreciated in favor of the 'new' way.
305 Request(char* anydata, Module* src, Module* dst);
306 /** Create a new Request
307 * This is for the 'new' way of defining a subclass
308 * of Request and defining it in a common header,
309 * passing an object of your Request subclass through
310 * as a Request* and using the ID string to determine
311 * what to cast it back to and the other end. This is
312 * much safer as there are no casts not confirmed by
313 * the ID string, and all casts are child->parent and
314 * can be checked at runtime with dynamic_cast<>()
316 Request(Module* src, Module* dst, const char* idstr);
317 /** Fetch the Request data
320 /** Fetch the ID string
323 /** Fetch the request source
326 /** Fetch the request destination (should be 'this' in the receiving module)
329 /** Send the Request.
330 * Upon returning the result will be arbitary data returned by the module you
331 * sent the request to. It is up to your module to know what this data is and
332 * how to deal with it.
338 /** The Event class is a unicast message directed at all modules.
339 * When the class is properly instantiated it may be sent to all modules
340 * using the Send() method, which will trigger the OnEvent method in
341 * all modules passing the object as its parameter.
343 class CoreExport Event : public ModuleMessage
346 /** This member holds a pointer to arbitary data set by the emitter of the message
349 /** This is a pointer to the sender of the message, which can be used to
350 * directly trigger events, or to create a reply.
353 /** The event identifier.
354 * This is arbitary text which should be used to distinguish
355 * one type of event from another.
359 /** Create a new Event
361 Event(char* anydata, Module* src, const std::string &eventid);
362 /** Get the Event data
365 /** Get the event Source
368 /** Get the event ID.
369 * Use this to determine the event type for safe casting of the data
371 std::string GetEventID();
373 * The return result of an Event::Send() will always be NULL as
374 * no replies are expected.
376 char* Send(InspIRCd* ServerInstance);
379 /** Priority types which can be returned from Module::Prioritize()
381 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
383 /** Implementation-specific flags which may be set in Module::Implements()
388 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
389 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
390 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
391 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
392 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
393 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
394 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
395 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
396 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
397 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
398 I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
399 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
400 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO,
406 /** Base class for all InspIRCd modules
407 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
408 * its methods will be called when irc server events occur. class inherited from module must be
409 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
411 class CoreExport Module : public Extensible
414 /** Creator/owner pointer
416 InspIRCd* ServerInstance;
419 /** Default constructor.
420 * Creates a module class.
421 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
422 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
424 Module(InspIRCd* Me);
426 /** Default destructor.
427 * destroys a module class
431 virtual void Prioritize()
435 /** Returns the version number of a Module.
436 * The method should return a Version object with its version information assigned via
439 virtual Version GetVersion();
441 /** Called when a user connects.
442 * The details of the connecting user are available to you in the parameter User *user
443 * @param user The user who is connecting
445 virtual void OnUserConnect(User* user);
447 /** Called when a user quits.
448 * The details of the exiting user are available to you in the parameter User *user
449 * This event is only called when the user is fully registered when they quit. To catch
450 * raw disconnections, use the OnUserDisconnect method.
451 * @param user The user who is quitting
452 * @param message The user's quit message (as seen by non-opers)
453 * @param oper_message The user's quit message (as seen by opers)
455 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
457 /** Called whenever a user's socket is closed.
458 * The details of the exiting user are available to you in the parameter User *user
459 * This event is called for all users, registered or not, as a cleanup method for modules
460 * which might assign resources to user, such as dns lookups, objects and sockets.
461 * @param user The user who is disconnecting
463 virtual void OnUserDisconnect(User* user);
465 /** Called whenever a channel is about to be deleted
466 * @param chan The channel being deleted
467 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
469 virtual int OnChannelPreDelete(Channel *chan);
471 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
472 * @param chan The channel being deleted
474 virtual void OnChannelDelete(Channel* chan);
476 /** Called when a user joins a channel.
477 * The details of the joining user are available to you in the parameter User *user,
478 * and the details of the channel they have joined is available in the variable Channel *channel
479 * @param user The user who is joining
480 * @param channel The channel being joined
481 * @param silent Change this to true if you want to conceal the JOIN command from the other users
482 * of the channel (useful for modules such as auditorium)
483 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
484 * to a channel due to the network sync.
486 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
488 /** Called after a user joins a channel
489 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
491 * @param user The user who is joining
492 * @param channel The channel being joined
494 virtual void OnPostJoin(User* user, Channel* channel);
496 /** Called when a user parts a channel.
497 * The details of the leaving user are available to you in the parameter User *user,
498 * and the details of the channel they have left is available in the variable Channel *channel
499 * @param user The user who is parting
500 * @param channel The channel being parted
501 * @param partmessage The part message, or an empty string
502 * @param silent Change this to true if you want to conceal the PART command from the other users
503 * of the channel (useful for modules such as auditorium)
505 virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
507 /** Called on rehash.
508 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
509 * system. You should use it to reload any files so that your module keeps in step with the
510 * rest of the application. If a parameter is given, the core has done nothing. The module
511 * receiving the event can decide if this parameter has any relevence to it.
512 * @param user The user performing the rehash, if any -- if this is server initiated, the
513 * value of this variable will be NULL.
514 * @param parameter The (optional) parameter given to REHASH from the user.
516 virtual void OnRehash(User* user, const std::string ¶meter);
518 /** Called when a raw command is transmitted or received.
519 * This method is the lowest level of handler available to a module. It will be called with raw
520 * data which is passing through a connected socket. If you wish, you may munge this data by changing
521 * the string parameter "raw". If you do this, after your function exits it will immediately be
522 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
523 * inbound is set to true) the value of user will be the User of the connection sending the
524 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
525 * @param raw The raw string in RFC1459 format
526 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
527 * @param user The user record sending the text, when inbound == true.
529 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
531 /** Called whenever a user is about to join a channel, before any processing is done.
532 * Returning a value of 1 from this function stops the process immediately, causing no
533 * output to be sent to the user by the core. If you do this you must produce your own numerics,
534 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
535 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
539 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
540 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
541 * processing on the actual channel record at this point, however the channel NAME will still be passed in
542 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
543 * @param user The user joining the channel
544 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
545 * @param cname The channel name being joined. For new channels this is valid where chan is not.
546 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
547 * You may alter this string to alter the user's modes on the channel.
548 * @param keygiven The key given to join the channel, or an empty string if none was provided
549 * @return 1 To prevent the join, 0 to allow it.
551 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
553 /** Called whenever a user is about to be kicked.
554 * Returning a value of 1 from this function stops the process immediately, causing no
555 * output to be sent to the user by the core. If you do this you must produce your own numerics,
557 * @param source The user issuing the kick
558 * @param user The user being kicked
559 * @param chan The channel the user is being kicked from
560 * @param reason The kick reason
561 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
563 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
565 /** Called whenever a user is kicked.
566 * If this method is called, the kick is already underway and cannot be prevented, so
567 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
568 * @param source The user issuing the kick
569 * @param user The user being kicked
570 * @param chan The channel the user is being kicked from
571 * @param reason The kick reason
572 * @param silent Change this to true if you want to conceal the PART command from the other users
573 * of the channel (useful for modules such as auditorium)
575 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
577 /** Called whenever a user opers locally.
578 * The User will contain the oper mode 'o' as this function is called after any modifications
579 * are made to the user's structure by the core.
580 * @param user The user who is opering up
581 * @param opertype The opers type name
583 virtual void OnOper(User* user, const std::string &opertype);
585 /** Called after a user opers locally.
586 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
587 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
588 * out the OPERTYPE, etc.
589 * @param user The user who is opering up
590 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
591 * @param opertype The opers type name
593 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
595 /** Called whenever a user types /INFO.
596 * The User will contain the information of the user who typed the command. Modules may use this
597 * method to output their own credits in /INFO (which is the ircd's version of an about box).
598 * It is purposefully not possible to modify any info that has already been output, or halt the list.
599 * You must write a 371 numeric to the user, containing your info in the following format:
601 * <nick> :information here
603 * @param user The user issuing /INFO
605 virtual void OnInfo(User* user);
607 /** Called whenever a /WHOIS is performed on a local user.
608 * The source parameter contains the details of the user who issued the WHOIS command, and
609 * the dest parameter contains the information of the user they are whoising.
610 * @param source The user issuing the WHOIS command
611 * @param dest The user who is being WHOISed
613 virtual void OnWhois(User* source, User* dest);
615 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
616 * Returning 1 from this function stops the process immediately, causing no
617 * output to be sent to the user by the core. If you do this you must produce your own numerics,
618 * notices etc. This is useful for modules which may want to filter invites to channels.
619 * @param source The user who is issuing the INVITE
620 * @param dest The user being invited
621 * @param channel The channel the user is being invited to
622 * @param timeout The time the invite will expire (0 == never)
623 * @return 1 to deny the invite, 0 to allow
625 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
627 /** Called after a user has been successfully invited to a channel.
628 * You cannot prevent the invite from occuring using this function, to do that,
629 * use OnUserPreInvite instead.
630 * @param source The user who is issuing the INVITE
631 * @param dest The user being invited
632 * @param channel The channel the user is being invited to
633 * @param timeout The time the invite will expire (0 == never)
635 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
637 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
638 * Returning any nonzero value from this function stops the process immediately, causing no
639 * output to be sent to the user by the core. If you do this you must produce your own numerics,
640 * notices etc. This is useful for modules which may want to filter or redirect messages.
641 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
642 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
643 * of where the message is destined to be sent.
644 * @param user The user sending the message
645 * @param dest The target of the message (Channel* or User*)
646 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
647 * @param text Changeable text being sent by the user
648 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
649 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
650 * It will be ignored for private messages.
651 * @return 1 to deny the NOTICE, 0 to allow it
653 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
655 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
656 * Returning any nonzero value from this function stops the process immediately, causing no
657 * output to be sent to the user by the core. If you do this you must produce your own numerics,
658 * notices etc. This is useful for modules which may want to filter or redirect messages.
659 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
660 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
661 * of where the message is destined to be sent.
662 * You may alter the message text as you wish before relinquishing control to the next module
663 * in the chain, and if no other modules block the text this altered form of the text will be sent out
664 * to the user and possibly to other servers.
665 * @param user The user sending the message
666 * @param dest The target of the message (Channel* or User*)
667 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
668 * @param text Changeable text being sent by the user
669 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
670 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
671 * It will be ignored for private notices.
672 * @return 1 to deny the NOTICE, 0 to allow it
674 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
676 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
677 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
678 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
679 * @param chan The channel to build the exempt list of
680 * @param sender The original sender of the PRIVMSG or NOTICE
681 * @param status The status char to be used for the channel list
682 * @param exempt_list The exempt list to be populated
683 * @param text The original message text causing the exempt list to be built
685 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
687 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
688 * Please note that although you can see remote nickchanges through this function, you should
689 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
690 * check user->server before taking any action (including returning nonzero from the method).
691 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
692 * module to generate some meaninful output.
693 * @param user The username changing their nick
694 * @param newnick Their new nickname
695 * @return 1 to deny the change, 0 to allow
697 virtual int OnUserPreNick(User* user, const std::string &newnick);
699 /** Called after any PRIVMSG sent from a user.
700 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
701 * if target_type is TYPE_CHANNEL.
702 * @param user The user sending the message
703 * @param dest The target of the message
704 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
705 * @param text the text being sent by the user
706 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
708 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
710 /** Called after any NOTICE sent from a user.
711 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
712 * if target_type is TYPE_CHANNEL.
713 * @param user The user sending the message
714 * @param dest The target of the message
715 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
716 * @param text the text being sent by the user
717 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
719 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
721 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
722 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
723 * if target_type is TYPE_CHANNEL.
724 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
725 * the message has already been vetted. In the case of the other two methods, a later module may stop your
726 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
727 * @param user The user sending the message
728 * @param dest The target of the message
729 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
730 * @param text the text being sent by the user
731 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
733 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
735 /** Called after every MODE command sent from a user
736 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
737 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
738 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
739 * @param user The user sending the MODEs
740 * @param dest The target of the modes (User* or Channel*)
741 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
742 * @param text The actual modes and their parameters if any
744 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
746 /** Allows modules to alter or create server descriptions
747 * Whenever a module requires a server description, for example for display in
748 * WHOIS, this function is called in all modules. You may change or define the
749 * description given in std::string &description. If you do, this description
750 * will be shown in the WHOIS fields.
751 * @param servername The servername being searched for
752 * @param description Alterable server description for this server
754 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
756 /** Allows modules to synchronize data which relates to users during a netburst.
757 * When this function is called, it will be called from the module which implements
758 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
759 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
760 * (see below). This function will be called for every user visible on your side
761 * of the burst, allowing you to for example set modes, etc. Do not use this call to
762 * synchronize data which you have stored using class Extensible -- There is a specialist
763 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
764 * @param user The user being syncronized
765 * @param proto A pointer to the module handling network protocol
766 * @param opaque An opaque pointer set by the protocol module, should not be modified!
768 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
770 /** Allows modules to synchronize data which relates to channels during a netburst.
771 * When this function is called, it will be called from the module which implements
772 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
773 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
774 * (see below). This function will be called for every user visible on your side
775 * of the burst, allowing you to for example set modes, etc. Do not use this call to
776 * synchronize data which you have stored using class Extensible -- There is a specialist
777 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
779 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
781 * @param chan The channel being syncronized
782 * @param proto A pointer to the module handling network protocol
783 * @param opaque An opaque pointer set by the protocol module, should not be modified!
785 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
787 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
788 * Whenever the linking module wants to send out data, but doesnt know what the data
789 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
790 * this method is called.You should use the ProtoSendMetaData function after you've
791 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
792 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
793 * @param chan The channel whos metadata is being syncronized
794 * @param proto A pointer to the module handling network protocol
795 * @param opaque An opaque pointer set by the protocol module, should not be modified!
796 * @param extname The extensions name which is being searched for
797 * @param displayable If this value is true, the data is going to be displayed to a user,
798 * and not sent across the network. Use this to determine wether or not to show sensitive data.
800 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
802 /* Allows modules to syncronize metadata related to users over the network during a netburst.
803 * Whenever the linking module wants to send out data, but doesnt know what the data
804 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
805 * this method is called. You should use the ProtoSendMetaData function after you've
806 * correctly decided how the data should be represented, to send the metadata on its way if
807 * if it belongs to your module.
808 * @param user The user whos metadata is being syncronized
809 * @param proto A pointer to the module handling network protocol
810 * @param opaque An opaque pointer set by the protocol module, should not be modified!
811 * @param extname The extensions name which is being searched for
812 * @param displayable If this value is true, the data is going to be displayed to a user,
813 * and not sent across the network. Use this to determine wether or not to show sensitive data.
815 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
817 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
818 * Whenever the linking module wants to send out data, but doesnt know what the data
819 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
820 * this method is called. You should use the ProtoSendMetaData function after you've
821 * correctly decided how the data should be represented, to send the metadata on its way if
822 * if it belongs to your module.
823 * @param proto A pointer to the module handling network protocol
824 * @param opaque An opaque pointer set by the protocol module, should not be modified!
825 * @param displayable If this value is true, the data is going to be displayed to a user,
826 * and not sent across the network. Use this to determine wether or not to show sensitive data.
828 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
830 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
831 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
832 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
833 * @param target The Channel* or User* that data should be added to
834 * @param extname The extension name which is being sent
835 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
837 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
839 /** Implemented by modules which provide the ability to link servers.
840 * These modules will implement this method, which allows transparent sending of servermodes
841 * down the network link as a broadcast, without a module calling it having to know the format
842 * of the MODE command before the actual mode string.
844 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
845 * of how to use this function.
847 * @param opaque An opaque pointer set by the protocol module, should not be modified!
848 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
849 * @param target The Channel* or User* that modes should be sent for
850 * @param modeline The modes and parameters to be sent
852 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
854 /** Implemented by modules which provide the ability to link servers.
855 * These modules will implement this method, which allows metadata (extra data added to
856 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
857 * to other servers on a netburst and decoded at the other end by the same module on a
860 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
861 * how to use this function.
862 * @param opaque An opaque pointer set by the protocol module, should not be modified!
863 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
864 * @param target The Channel* or User* that metadata should be sent for
865 * @param extname The extension name to send metadata for
866 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
868 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
870 /** Called after every WALLOPS command.
871 * @param user The user sending the WALLOPS
872 * @param text The content of the WALLOPS message
874 virtual void OnWallops(User* user, const std::string &text);
876 /** Called whenever a user's hostname is changed.
877 * This event triggers after the host has been set.
878 * @param user The user whos host is being changed
879 * @param newhost The new hostname being set
881 virtual void OnChangeHost(User* user, const std::string &newhost);
883 /** Called whenever a user's GECOS (realname) is changed.
884 * This event triggers after the name has been set.
885 * @param user The user who's GECOS is being changed
886 * @param gecos The new GECOS being set on the user
888 virtual void OnChangeName(User* user, const std::string &gecos);
890 /** Called whenever an xline is added by a local user.
891 * This method is triggered after the line is added.
892 * @param source The sender of the line or NULL for local server
893 * @param line The xline being added
895 virtual void OnAddLine(User* source, XLine* line);
897 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
898 * This method is triggered after the line is deleted.
899 * @param source The user removing the line or NULL for local server
900 * @param line the line being deleted
902 virtual void OnDelLine(User* source, XLine* line);
904 /** Called whenever an xline expires.
905 * This method is triggered after the line is deleted.
906 * @param line The line being deleted.
908 virtual void OnExpireLine(XLine *line);
910 /** Called before your module is unloaded to clean up Extensibles.
911 * This method is called once for every user and channel on the network,
912 * so that when your module unloads it may clear up any remaining data
913 * in the form of Extensibles added using Extensible::Extend().
914 * If the target_type variable is TYPE_USER, then void* item refers to
915 * a User*, otherwise it refers to a Channel*.
916 * @param target_type The type of item being cleaned
917 * @param item A pointer to the item's class
919 virtual void OnCleanup(int target_type, void* item);
921 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
922 * have been applied. Please note that although you can see remote nickchanges through this function, you should
923 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
924 * check user->server before taking any action (including returning nonzero from the method).
925 * Because this method is called after the nickchange is taken place, no return values are possible
926 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
927 * @param user The user changing their nick
928 * @param oldnick The old nickname of the user before the nickchange
930 virtual void OnUserPostNick(User* user, const std::string &oldnick);
932 /** Called before an action which requires a channel privilage check.
933 * This function is called before many functions which check a users status on a channel, for example
934 * before opping a user, deopping a user, kicking a user, etc.
935 * There are several values for access_type which indicate for what reason access is being checked.
937 * AC_KICK (0) - A user is being kicked<br>
938 * AC_DEOP (1) - a user is being deopped<br>
939 * AC_OP (2) - a user is being opped<br>
940 * AC_VOICE (3) - a user is being voiced<br>
941 * AC_DEVOICE (4) - a user is being devoiced<br>
942 * AC_HALFOP (5) - a user is being halfopped<br>
943 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
944 * AC_INVITE () - a user is being invited<br>
945 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
946 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
947 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
948 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
949 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
950 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
951 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
952 * @param source The source of the access check
953 * @param dest The destination of the access check
954 * @param channel The channel which is being checked
955 * @param access_type See above
957 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
959 /** Called when a 005 numeric is about to be output.
960 * The module should modify the 005 numeric if needed to indicate its features.
961 * @param output The 005 string to be modified if neccessary.
963 virtual void On005Numeric(std::string &output);
965 /** Called when a client is disconnected by KILL.
966 * If a client is killed by a server, e.g. a nickname collision or protocol error,
968 * Return 1 from this function to prevent the kill, and 0 from this function to allow
969 * it as normal. If you prevent the kill no output will be sent to the client, it is
970 * down to your module to generate this information.
971 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
972 * If you do so youre risking race conditions, desyncs and worse!
973 * @param source The user sending the KILL
974 * @param dest The user being killed
975 * @param reason The kill reason
976 * @return 1 to prevent the kill, 0 to allow
978 virtual int OnKill(User* source, User* dest, const std::string &reason);
980 /** Called when an oper wants to disconnect a remote user via KILL
981 * @param source The user sending the KILL
982 * @param dest The user being killed
983 * @param reason The kill reason
985 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
987 /** Called whenever a module is loaded.
988 * mod will contain a pointer to the module, and string will contain its name,
989 * for example m_widgets.so. This function is primary for dependency checking,
990 * your module may decide to enable some extra features if it sees that you have
991 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
992 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
993 * but instead operate under reduced functionality, unless the dependency is
994 * absolutely neccessary (e.g. a module that extends the features of another
996 * @param mod A pointer to the new module
997 * @param name The new module's filename
999 virtual void OnLoadModule(Module* mod,const std::string &name);
1001 /** Called whenever a module is unloaded.
1002 * mod will contain a pointer to the module, and string will contain its name,
1003 * for example m_widgets.so. This function is primary for dependency checking,
1004 * your module may decide to enable some extra features if it sees that you have
1005 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1006 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1007 * but instead operate under reduced functionality, unless the dependency is
1008 * absolutely neccessary (e.g. a module that extends the features of another
1010 * @param mod Pointer to the module being unloaded (still valid)
1011 * @param name The filename of the module being unloaded
1013 virtual void OnUnloadModule(Module* mod,const std::string &name);
1015 /** Called once every five seconds for background processing.
1016 * This timer can be used to control timed features. Its period is not accurate
1017 * enough to be used as a clock, but it is gauranteed to be called at least once in
1018 * any five second period, directly from the main loop of the server.
1019 * @param curtime The current timer derived from time(2)
1021 virtual void OnBackgroundTimer(time_t curtime);
1023 /** Called whenever any command is about to be executed.
1024 * This event occurs for all registered commands, wether they are registered in the core,
1025 * or another module, and for invalid commands. Invalid commands may only be sent to this
1026 * function when the value of validated is false. By returning 1 from this method you may prevent the
1027 * command being executed. If you do this, no output is created by the core, and it is
1028 * down to your module to produce any output neccessary.
1029 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1030 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1031 * method returns, it will be passed an invalid pointer to the user object and crash!)
1032 * @param command The command being executed
1033 * @param parameters An array of array of characters containing the parameters for the command
1034 * @param pcnt The nuimber of parameters passed to the command
1035 * @param user the user issuing the command
1036 * @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.
1037 * @param original_line The entire original line as passed to the parser from the user
1038 * @return 1 to block the command, 0 to allow
1040 virtual int OnPreCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1042 /** Called after any command has been executed.
1043 * This event occurs for all registered commands, wether they are registered in the core,
1044 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1045 * exist within the command table). The result code returned by the command handler is
1047 * @param command The command being executed
1048 * @param parameters An array of array of characters containing the parameters for the command
1049 * @param pcnt The nuimber of parameters passed to the command
1050 * @param user the user issuing the command
1051 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1052 * @param original_line The entire original line as passed to the parser from the user
1054 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1056 /** Called to check if a user who is connecting can now be allowed to register
1057 * If any modules return false for this function, the user is held in the waiting
1058 * state until all modules return true. For example a module which implements ident
1059 * lookups will continue to return false for a user until their ident lookup is completed.
1060 * Note that the registration timeout for a user overrides these checks, if the registration
1061 * timeout is reached, the user is disconnected even if modules report that the user is
1062 * not ready to connect.
1063 * @param user The user to check
1064 * @return true to indicate readiness, false if otherwise
1066 virtual bool OnCheckReady(User* user);
1068 /** Called whenever a user is about to register their connection (e.g. before the user
1069 * is sent the MOTD etc). Modules can use this method if they are performing a function
1070 * which must be done before the actual connection is completed (e.g. ident lookups,
1071 * dnsbl lookups, etc).
1072 * Note that you should NOT delete the user record here by causing a disconnection!
1073 * Use OnUserConnect for that instead.
1074 * @param user The user registering
1075 * @return 1 to indicate user quit, 0 to continue
1077 virtual int OnUserRegister(User* user);
1079 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1080 * This method will always be called for each join, wether or not the channel is actually +i, and
1081 * determines the outcome of an if statement around the whole section of invite checking code.
1082 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1083 * @param user The user joining the channel
1084 * @param chan The channel being joined
1085 * @return 1 to explicitly allow the join, 0 to proceed as normal
1087 virtual int OnCheckInvite(User* user, Channel* chan);
1089 /** Called whenever a mode character is processed.
1090 * Return 1 from this function to block the mode character from being processed entirely.
1091 * @param user The user who is sending the mode
1092 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1093 * @param mode The mode character being set
1094 * @param param The parameter for the mode or an empty string
1095 * @param adding true of the mode is being added, false if it is being removed
1096 * @param pcnt The parameter count for the mode (0 or 1)
1097 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1098 * to skip all permission checking. Please note that for remote mode changes, your return value
1101 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1103 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1104 * This method will always be called for each join, wether or not the channel is actually +k, and
1105 * determines the outcome of an if statement around the whole section of key checking code.
1106 * if the user specified no key, the keygiven string will be a valid but empty value.
1107 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1108 * @param user The user joining the channel
1109 * @param chan The channel being joined
1110 * @return 1 to explicitly allow the join, 0 to proceed as normal
1112 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1114 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1115 * This method will always be called for each join, wether or not the channel is actually +l, and
1116 * determines the outcome of an if statement around the whole section of channel limit checking code.
1117 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1118 * @param user The user joining the channel
1119 * @param chan The channel being joined
1120 * @return 1 to explicitly allow the join, 0 to proceed as normal
1122 virtual int OnCheckLimit(User* user, Channel* chan);
1124 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1125 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1126 * determines the outcome of an if statement around the whole section of ban checking code.
1127 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1128 * @param user The user joining the channel
1129 * @param chan The channel being joined
1130 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1131 * join to the channel.
1133 virtual int OnCheckBan(User* user, Channel* chan);
1135 /** Called on all /STATS commands
1136 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1137 * @param symbol the symbol provided to /STATS
1138 * @param user the user issuing the /STATS command
1139 * @param results A string_list to append results into. You should put all your results
1140 * into this string_list, rather than displaying them directly, so that your handler will
1141 * work when remote STATS queries are received.
1142 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1144 virtual int OnStats(char symbol, User* user, string_list &results);
1146 /** Called whenever a change of a local users displayed host is attempted.
1147 * Return 1 to deny the host change, or 0 to allow it.
1148 * @param user The user whos host will be changed
1149 * @param newhost The new hostname
1150 * @return 1 to deny the host change, 0 to allow
1152 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1154 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1155 * return 1 to deny the name change, or 0 to allow it.
1156 * @param user The user whos GECOS will be changed
1157 * @param newhost The new GECOS
1158 * @return 1 to deny the GECOS change, 0 to allow
1160 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1162 /** Called whenever a topic is changed by a local user.
1163 * Return 1 to deny the topic change, or 0 to allow it.
1164 * @param user The user changing the topic
1165 * @param chan The channels who's topic is being changed
1166 * @param topic The actual topic text
1167 * @param 1 to block the topic change, 0 to allow
1169 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1171 /** Called whenever a local topic has been changed.
1172 * To block topic changes you must use OnLocalTopicChange instead.
1173 * @param user The user changing the topic
1174 * @param chan The channels who's topic is being changed
1175 * @param topic The actual topic text
1177 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1179 /** Called whenever an Event class is sent to all module by another module.
1180 * Please see the documentation of Event::Send() for further information. The Event sent can
1181 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1182 * before doing anything to the event data, and you should *not* change the event data in any way!
1183 * @param event The Event class being received
1185 virtual void OnEvent(Event* event);
1187 /** Called whenever a Request class is sent to your module by another module.
1188 * Please see the documentation of Request::Send() for further information. The Request sent
1189 * can always be assumed to be non-NULL, you should not change the request object or its data.
1190 * Your method may return arbitary data in the char* result which the requesting module
1191 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1192 * @param request The Request class being received
1194 virtual const char* OnRequest(Request* request);
1196 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1197 * The password field (from the config file) is in 'password' and is to be compared against
1198 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1199 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1200 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1201 * @param password The password from the configuration file (the password="" value).
1202 * @param input The password entered by the user or whoever.
1203 * @param hashtype The hash value from the config
1204 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1206 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1208 /** Called whenever a user is given usermode +o, anywhere on the network.
1209 * You cannot override this and prevent it from happening as it is already happened and
1210 * such a task must be performed by another server. You can however bounce modes by sending
1211 * servermodes out to reverse mode changes.
1212 * @param user The user who is opering
1214 virtual void OnGlobalOper(User* user);
1216 /** Called after a user has fully connected and all modules have executed OnUserConnect
1217 * This event is informational only. You should not change any user information in this
1218 * event. To do so, use the OnUserConnect method to change the state of local users.
1219 * This is called for both local and remote users.
1220 * @param user The user who is connecting
1222 virtual void OnPostConnect(User* user);
1224 /** Called whenever a ban is added to a channel's list.
1225 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1226 * @param source The user adding the ban
1227 * @param channel The channel the ban is being added to
1228 * @param banmask The ban mask being added
1229 * @return 1 to block the ban, 0 to continue as normal
1231 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1233 /** Called whenever a ban is removed from a channel's list.
1234 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1235 * @param source The user deleting the ban
1236 * @param channel The channel the ban is being deleted from
1237 * @param banmask The ban mask being deleted
1238 * @return 1 to block the unban, 0 to continue as normal
1240 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1242 virtual void OnHookUserIO(User* user, const std::string &targetip);
1244 /** Called immediately after any connection is accepted. This is intended for raw socket
1245 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1246 * no information relating to a user record as the connection has not been assigned yet.
1247 * There are no return values from this call as all modules get an opportunity if required to
1248 * process the connection.
1249 * @param fd The file descriptor returned from accept()
1250 * @param ip The IP address of the connecting user
1251 * @param localport The local port number the user connected to
1253 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1255 /** Called immediately before any write() operation on a user's socket in the core. Because
1256 * this event is a low level event no user information is associated with it. It is intended
1257 * for use by modules which may wrap connections within another API such as SSL for example.
1258 * return a non-zero result if you have handled the write operation, in which case the core
1259 * will not call write().
1260 * @param fd The file descriptor of the socket
1261 * @param buffer A char* buffer being written
1262 * @param Number of characters to write
1263 * @return Number of characters actually written or 0 if you didn't handle the operation
1265 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1267 /** Called immediately before any socket is closed. When this event is called, shutdown()
1268 * has not yet been called on the socket.
1269 * @param fd The file descriptor of the socket prior to close()
1271 virtual void OnRawSocketClose(int fd);
1273 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1275 * @param fd The file descriptor of the socket immediately after connect()
1277 virtual void OnRawSocketConnect(int fd);
1279 /** Called immediately before any read() operation on a client socket in the core.
1280 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1281 * when this event occurs.
1282 * Your event should return 1 if it has handled the reading itself, which prevents the core
1283 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1284 * the value of count. The value of readresult must be identical to an actual result that might
1285 * be returned from the read() system call, for example, number of bytes read upon success,
1286 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1287 * you MUST set readresult.
1288 * @param fd The file descriptor of the socket
1289 * @param buffer A char* buffer being read to
1290 * @param count The size of the buffer
1291 * @param readresult The amount of characters read, or 0
1292 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1294 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1296 /** Called whenever a user sets away or returns from being away.
1297 * The away message is available as a parameter, but should not be modified.
1298 * At this stage, it has already been copied into the user record.
1299 * If awaymsg is empty, the user is returning from away.
1300 * @param user The user setting away
1301 * @param awaymsg The away message of the user, or empty if returning from away
1302 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1304 virtual int OnSetAway(User* user, const std::string &awaymsg);
1306 /** Called whenever a NAMES list is requested.
1307 * You can produce the nameslist yourself, overriding the current list,
1308 * and if you do you must return 1. If you do not handle the names list,
1310 * @param The user requesting the NAMES list
1311 * @param Ptr The channel the NAMES list is requested for
1312 * @param userlist The user list for the channel (you may change this pointer.
1313 * If you want to change the values, take a copy first, and change the copy, then
1314 * point the pointer at your copy)
1315 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1316 * Returning -1 allows the names list, but bypasses any checks which check for
1317 * channel membership before sending the names list.
1319 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1321 /** Called whenever a line of WHOIS output is sent to a user.
1322 * You may change the numeric and the text of the output by changing
1323 * the values numeric and text, but you cannot change the user the
1324 * numeric is sent to. You may however change the user's User values.
1325 * @param user The user the numeric is being sent to
1326 * @param dest The user being WHOISed
1327 * @param numeric The numeric of the line being sent
1328 * @param text The text of the numeric, including any parameters
1329 * @return nonzero to drop the line completely so that the user does not
1330 * receive it, or zero to allow the line to be sent.
1332 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1334 /** Called at intervals for modules to garbage-collect any hashes etc.
1335 * Certain data types such as hash_map 'leak' buckets, which must be
1336 * tidied up and freed by copying into a new item every so often. This
1337 * method is called when it is time to do that.
1339 virtual void OnGarbageCollect();
1341 /** Called whenever a user's write buffer has been completely sent.
1342 * This is called when the user's write buffer is completely empty, and
1343 * there are no more pending bytes to be written and no pending write events
1344 * in the socket engine's queue. This may be used to refill the buffer with
1345 * data which is being spooled in a controlled manner, e.g. LIST lines.
1346 * @param user The user who's buffer is now empty.
1348 virtual void OnBufferFlushed(User* user);
1350 /** Add test suite hooks here. These are used for testing functionality of a module
1351 * via the --testsuite debugging parameter.
1353 virtual void OnRunTestSuite();
1355 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1356 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1357 * module, then this will cause the nickname not to be displayed at all.
1359 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1361 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1365 #define CONF_NO_ERROR 0x000000
1366 #define CONF_NOT_A_NUMBER 0x000010
1367 #define CONF_INT_NEGATIVE 0x000080
1368 #define CONF_VALUE_NOT_FOUND 0x000100
1369 #define CONF_FILE_NOT_FOUND 0x000200
1372 /** Allows reading of values from configuration files
1373 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1374 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1375 * Constructing the class using one parameter allows you to specify a path to your own configuration
1376 * file, otherwise, inspircd.conf is read.
1378 class CoreExport ConfigReader : public classbase
1381 InspIRCd* ServerInstance;
1382 /** The contents of the configuration file
1383 * This protected member should never be accessed by a module (and cannot be accessed unless the
1384 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1385 * (such as comments) stripped from it.
1387 ConfigDataHash* data;
1388 /** Used to store errors
1390 std::ostringstream* errorlog;
1391 /** If we're using our own config data hash or not
1394 /** True if an error occured reading the config file
1402 /** Default constructor.
1403 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1404 * as specified when running ./configure.
1406 ConfigReader(InspIRCd* Instance);
1407 /** Overloaded constructor.
1408 * This constructor initialises the ConfigReader class to read a user-specified config file
1410 ConfigReader(InspIRCd* Instance, const std::string &filename);
1411 /** Default destructor.
1412 * This method destroys the ConfigReader class.
1416 /** Retrieves a value from the config file.
1417 * This method retrieves a value from the config file. Where multiple copies of the tag
1418 * exist in the config file, index indicates which of the values to retrieve.
1420 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1421 /** Retrieves a value from the config file.
1422 * This method retrieves a value from the config file. Where multiple copies of the tag
1423 * exist in the config file, index indicates which of the values to retrieve. If the
1424 * tag is not found the default value is returned instead.
1426 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1428 /** Retrieves a boolean value from the config file.
1429 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1430 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1431 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1433 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1434 /** Retrieves a boolean value from the config file.
1435 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1436 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1437 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1438 * If the tag is not found, the default value is used instead.
1440 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1442 /** Retrieves an integer value from the config file.
1443 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1444 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1445 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1446 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1447 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1448 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1449 * should cast the result to achieve that effect.
1451 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1452 /** Retrieves an integer value from the config file.
1453 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1454 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1455 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1456 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1457 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1458 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1460 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1462 /** Returns the last error to occur.
1463 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1464 * A call to GetError() resets the error flag back to 0.
1467 /** Counts the number of times a given tag appears in the config file.
1468 * This method counts the number of times a tag appears in a config file, for use where
1469 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1470 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1471 * multiple instance tag.
1473 int Enumerate(const std::string &tag);
1474 /** Returns true if a config file is valid.
1475 * This method is partially implemented and will only return false if the config
1476 * file does not exist or could not be opened.
1479 /** Dumps the list of errors in a config file to an output location. If bail is true,
1480 * then the program will abort. If bail is false and user points to a valid user
1481 * record, the error report will be spooled to the given user by means of NOTICE.
1482 * if bool is false AND user is false, the error report will be spooled to all opers
1483 * by means of a NOTICE to all opers.
1485 void DumpErrors(bool bail,User* user);
1487 /** Returns the number of items within a tag.
1488 * For example if the tag was <test tag="blah" data="foo"> then this
1489 * function would return 2. Spaces and newlines both qualify as valid seperators
1492 int EnumerateValues(const std::string &tag, int index);
1497 /** Caches a text file into memory and can be used to retrieve lines from it.
1498 * This class contains methods for read-only manipulation of a text file in memory.
1499 * Either use the constructor type with one parameter to load a file into memory
1500 * at construction, or use the LoadFile method to load a file.
1502 class CoreExport FileReader : public classbase
1504 InspIRCd* ServerInstance;
1505 /** The file contents
1509 /** Content size in bytes
1511 unsigned long contentsize;
1513 /** Calculate content size in bytes
1518 /** Default constructor.
1519 * This method does not load any file into memory, you must use the LoadFile method
1520 * after constructing the class this way.
1522 FileReader(InspIRCd* Instance);
1524 /** Secondary constructor.
1525 * This method initialises the class with a file loaded into it ready for GetLine and
1526 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1529 FileReader(InspIRCd* Instance, const std::string &filename);
1531 /** Default destructor.
1532 * This deletes the memory allocated to the file.
1536 /** Used to load a file.
1537 * This method loads a file into the class ready for GetLine and
1538 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1541 void LoadFile(const std::string &filename);
1543 /** Returns the whole content of the file as std::string
1545 std::string Contents();
1547 /** Returns the entire size of the file as std::string
1549 unsigned long ContentSize();
1551 /** Returns true if the file exists
1552 * This function will return false if the file could not be opened.
1556 /** Retrieve one line from the file.
1557 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1558 * the index was out of bounds, or the line had no data on it.
1560 std::string GetLine(int x);
1562 /** Returns the size of the file in lines.
1563 * This method returns the number of lines in the read file. If it is 0, no lines have been
1564 * read into memory, either because the file is empty or it does not exist, or cannot be
1565 * opened due to permission problems.
1570 /** A DLLFactory (designed to load shared objects) containing a
1571 * handle to a module's init_module() function. Unfortunately,
1572 * due to the design of shared object systems we must keep this
1573 * hanging around, as if we remove this handle, we remove the
1574 * shared object file from memory (!)
1576 typedef DLLFactory<Module> ircd_module;
1578 /** A list of modules
1580 typedef std::vector<Module*> IntModuleList;
1582 /** An event handler iterator
1584 typedef IntModuleList::iterator EventHandlerIter;
1586 /** Module priority states
1597 /** ModuleManager takes care of all things module-related
1600 class CoreExport ModuleManager : public classbase
1603 /** Holds a string describing the last module error to occur
1605 std::string LastModuleError;
1607 /** The feature names published by various modules
1609 featurelist Features;
1611 /** The interface names published by various modules
1613 interfacelist Interfaces;
1615 /** Total number of modules loaded into the ircd
1619 /** Our pointer to the main insp instance
1623 /** List of loaded modules and shared object/dll handles
1624 * keyed by module name
1626 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1630 /** Event handler hooks.
1631 * This needs to be public to be used by FOREACH_MOD and friends.
1633 IntModuleList EventHandlers[I_END];
1635 /** Simple, bog-standard, boring constructor.
1637 ModuleManager(InspIRCd* Ins);
1643 /** Change the priority of one event in a module.
1644 * Each module event has a list of modules which are attached to that event type.
1645 * If you wish to be called before or after other specific modules, you may use this
1646 * method (usually within void Module::Prioritize()) to set your events priority.
1647 * You may use this call in other methods too, however, this is not supported behaviour
1649 * @param mod The module to change the priority of
1650 * @param i The event to change the priority of
1651 * @param s The state you wish to use for this event. Use one of
1652 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1653 * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
1654 * to set it to be before or after one or more other modules.
1655 * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
1656 * then this contains a list of one or more modules your module must be
1657 * placed before or after. Your module will be placed before the highest
1658 * priority module in this list for PRIO_BEFORE, or after the lowest
1659 * priority module in this list for PRIO_AFTER.
1660 * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
1661 * Defaults to 1, as most of the time you will only want to prioritize your module
1662 * to be before or after one other module.
1664 bool SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules = NULL, size_t sz = 1);
1666 /** Change the priority of all events in a module.
1667 * @param mod The module to set the priority of
1668 * @param s The priority of all events in the module.
1669 * Note that with this method, it is not possible to effectively use
1670 * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
1671 * SetPriority method for this, where you may specify other modules to
1672 * be prioritized against.
1674 bool SetPriority(Module* mod, PriorityState s);
1676 /** Attach an event to a module.
1677 * You may later detatch the event with ModuleManager::Detach().
1678 * If your module is unloaded, all events are automatically detatched.
1679 * @param i Event type to attach
1680 * @param mod Module to attach event to
1681 * @return True if the event was attached
1683 bool Attach(Implementation i, Module* mod);
1685 /** Detatch an event from a module.
1686 * This is not required when your module unloads, as the core will
1687 * automatically detatch your module from all events it is attached to.
1688 * @param i Event type to detach
1689 * @param mod Module to detach event from
1690 * @param Detach true if the event was detached
1692 bool Detach(Implementation i, Module* mod);
1694 /** Attach an array of events to a module
1695 * @param i Event types (array) to attach
1696 * @param mod Module to attach events to
1698 void Attach(Implementation* i, Module* mod, size_t sz);
1700 /** Detach all events from a module (used on unload)
1701 * @param mod Module to detach from
1703 void DetachAll(Module* mod);
1705 /** Returns text describing the last module error
1706 * @return The last error message to occur
1708 std::string& LastError();
1710 /** Load a given module file
1711 * @param filename The file to load
1712 * @return True if the module was found and loaded
1714 bool Load(const char* filename);
1716 /** Unload a given module file
1717 * @param filename The file to unload
1718 * @return True if the module was unloaded
1720 bool Unload(const char* filename);
1722 /** Called by the InspIRCd constructor to load all modules from the config file.
1726 /** Get the total number of currently loaded modules
1727 * @return The number of loaded modules
1731 return this->ModCount;
1734 /** Find a module by name, and return a Module* to it.
1735 * This is preferred over iterating the module lists yourself.
1736 * @param name The module name to look up
1737 * @return A pointer to the module, or NULL if the module cannot be found
1739 Module* Find(const std::string &name);
1741 /** Publish a 'feature'.
1742 * There are two ways for a module to find another module it depends on.
1743 * Either by name, using InspIRCd::FindModule, or by feature, using this
1744 * function. A feature is an arbitary string which identifies something this
1745 * module can do. For example, if your module provides SSL support, but other
1746 * modules provide SSL support too, all the modules supporting SSL should
1747 * publish an identical 'SSL' feature. This way, any module requiring use
1748 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1749 * then use the module pointer they are given.
1750 * @param FeatureName The case sensitive feature name to make available
1751 * @param Mod a pointer to your module class
1752 * @returns True on success, false if the feature is already published by
1755 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1757 /** Publish a module to an 'interface'.
1758 * Modules which implement the same interface (the same way of communicating
1759 * with other modules) can publish themselves to an interface, using this
1760 * method. When they do so, they become part of a list of related or
1761 * compatible modules, and a third module may then query for that list
1762 * and know that all modules within that list offer the same API.
1763 * A prime example of this is the hashing modules, which all accept the
1764 * same types of Request class. Consider this to be similar to PublishFeature,
1765 * except for that multiple modules may publish the same 'feature'.
1766 * @param InterfaceName The case sensitive interface name to make available
1767 * @param Mod a pointer to your module class
1768 * @returns True on success, false on failure (there are currently no failure
1771 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1773 /** Return a pair saying how many other modules are currently using the
1774 * interfaces provided by module m.
1775 * @param m The module to count usage for
1776 * @return A pair, where the first value is the number of uses of the interface,
1777 * and the second value is the interface name being used.
1779 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1781 /** Mark your module as using an interface.
1782 * If you mark your module as using an interface, then that interface
1783 * module may not unload until your module has unloaded first.
1784 * This can be used to prevent crashes by ensuring code you depend on
1785 * is always in memory while your module is active.
1786 * @param InterfaceName The interface to use
1788 void UseInterface(const std::string &InterfaceName);
1790 /** Mark your module as finished with an interface.
1791 * If you used UseInterface() above, you should use this method when
1792 * your module is finished with the interface (usually in its destructor)
1793 * to allow the modules which implement the given interface to be unloaded.
1794 * @param InterfaceName The interface you are finished with using.
1796 void DoneWithInterface(const std::string &InterfaceName);
1798 /** Unpublish a 'feature'.
1799 * When your module exits, it must call this method for every feature it
1800 * is providing so that the feature table is cleaned up.
1801 * @param FeatureName the feature to remove
1803 bool UnpublishFeature(const std::string &FeatureName);
1805 /** Unpublish your module from an interface
1806 * When your module exits, it must call this method for every interface
1807 * it is part of so that the interfaces table is cleaned up. Only when
1808 * the last item is deleted from an interface does the interface get
1810 * @param InterfaceName the interface to be removed from
1811 * @param Mod The module to remove from the interface list
1813 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1815 /** Find a 'feature'.
1816 * There are two ways for a module to find another module it depends on.
1817 * Either by name, using InspIRCd::FindModule, or by feature, using the
1818 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1819 * identifies something this module can do. For example, if your module
1820 * provides SSL support, but other modules provide SSL support too, all
1821 * the modules supporting SSL should publish an identical 'SSL' feature.
1822 * To find a module capable of providing the feature you want, simply
1823 * call this method with the feature name you are looking for.
1824 * @param FeatureName The feature name you wish to obtain the module for
1825 * @returns A pointer to a valid module class on success, NULL on failure.
1827 Module* FindFeature(const std::string &FeatureName);
1829 /** Find an 'interface'.
1830 * An interface is a list of modules which all implement the same API.
1831 * @param InterfaceName The Interface you wish to obtain the module
1833 * @return A pointer to a deque of Module*, or NULL if the interface
1836 modulelist* FindInterface(const std::string &InterfaceName);
1838 /** Determine if a module has published the named interface.
1839 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1840 * @param mod The module to check.
1841 * @param InterfaceName the interface you want to check for
1842 * @return True if the module provides the interface, false otherwise.
1844 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1846 /** Given a pointer to a Module, return its filename
1847 * @param m The module pointer to identify
1848 * @return The module name or an empty string
1850 const std::string& GetModuleName(Module* m);
1852 /** Return a list of all modules matching the given filter
1853 * @param filter This int is a bitmask of flags set in Module::Flags,
1854 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1855 * all modules with no filtering, set this to 0.
1856 * @return The list of module names
1858 const std::vector<std::string> GetAllModuleNames(int filter);
1861 /** This definition is used as shorthand for the various classes
1862 * and functions needed to make a module loadable by the OS.
1863 * It defines the class factory and external init_module function.
1867 #define MODULE_INIT(y) \
1868 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1872 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1874 switch ( nReason ) \
1876 case DLL_PROCESS_ATTACH: \
1877 case DLL_PROCESS_DETACH: \
1885 #define MODULE_INIT(y) \
1886 extern "C" DllExport Module * init_module(InspIRCd* Me) \