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 * ---------------------------------------------------
20 #include "inspsocket.h"
30 /** Used with OnAccessCheck() method of modules
32 enum AccessControlType {
33 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
34 ACR_DENY, // deny the action
35 ACR_ALLOW, // allow the action
36 AC_KICK, // a user is being kicked
37 AC_DEOP, // a user is being deopped
38 AC_OP, // a user is being opped
39 AC_VOICE, // a user is being voiced
40 AC_DEVOICE, // a user is being devoiced
41 AC_HALFOP, // a user is being halfopped
42 AC_DEHALFOP, // a user is being dehalfopped
43 AC_INVITE, // a user is being invited
44 AC_GENERAL_MODE // a channel mode is being changed
47 /** Used to define a set of behavior bits for a module
50 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
51 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
52 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
53 VF_COMMON = 8 // module needs to be common on all servers in a network to link
56 /** Used with SendToMode()
63 /** Used to represent an event type, for user, channel or server
65 enum TargetTypeFlags {
72 /** Used to represent wether a message was PRIVMSG or NOTICE
79 /** If you change the module API, change this value.
80 * If you have enabled ipv6, the sizes of structs is
81 * different, and modules will be incompatible with
82 * ipv4 servers, so this value will be ten times as
83 * high on ipv6 servers.
85 #define NATIVE_API_VERSION 12000
87 #define API_VERSION (NATIVE_API_VERSION * 10)
89 #define API_VERSION (NATIVE_API_VERSION * 1)
94 /* Forward-delacare module for ModuleMessage etc
99 /** Low level definition of a FileReader classes file cache area -
100 * a text file seperated into lines.
102 typedef std::deque<std::string> file_cache;
104 /** A set of strings.
106 typedef file_cache string_list;
108 /** Holds a list of 'published features' for modules.
110 typedef std::map<std::string,Module*> featurelist;
112 /** Holds a list of modules which implement an interface
114 typedef std::deque<Module*> modulelist;
116 /** Holds a list of all modules which implement interfaces, by interface name
118 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
121 * This #define allows us to call a method in all
122 * loaded modules in a readable simple way, e.g.:
123 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
125 #define FOREACH_MOD(y,x) do { \
126 EventHandlerIter safei; \
127 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
135 catch (CoreException& modexcept) \
137 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
144 * This #define allows us to call a method in all
145 * loaded modules in a readable simple way and pass
146 * an instance pointer to the macro. e.g.:
147 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
149 #define FOREACH_MOD_I(z,y,x) do { \
150 EventHandlerIter safei; \
151 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
159 catch (CoreException& modexcept) \
161 z->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
168 * This define is similar to the one above but returns a result in MOD_RESULT.
169 * The first module to return a nonzero result is the value to be accepted,
170 * and any modules after are ignored.
172 #define FOREACH_RESULT(y,x) \
174 EventHandlerIter safei; \
176 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
182 int res = (*_i)->x ; \
188 catch (CoreException& modexcept) \
190 ServerInstance->Logs->Log("MODULE",DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
198 * This define is similar to the one above but returns a result in MOD_RESULT.
199 * The first module to return a nonzero result is the value to be accepted,
200 * and any modules after are ignored.
202 #define FOREACH_RESULT_I(z,y,x) \
204 EventHandlerIter safei; \
206 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
212 int res = (*_i)->x ; \
218 catch (CoreException& modexcept) \
220 z->Logs->Log("MODULE",DEBUG,"Exception caught: %s",modexcept.GetReason()); \
226 /** Represents a non-local user.
227 * (in fact, any FD less than -1 does)
229 #define FD_MAGIC_NUMBER -42
233 /** Is a local user */
234 #define IS_LOCAL(x) ((x->GetFd() > -1))
235 /** Is a remote user */
236 #define IS_REMOTE(x) (x->GetFd() < 0)
237 /** Is a module created user */
238 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
240 #define IS_OPER(x) (!x->oper.empty())
242 #define IS_AWAY(x) (!x->awaymsg.empty())
244 /** Holds a module's Version information.
245 * The four members (set by the constructor only) indicate details as to the version number
246 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
247 * The flags and API values represent the module flags and API version of the module.
248 * The API version of a module must match the API version of the core exactly for the module to
251 class CoreExport Version : public classbase
254 /** Version information.
258 /** Flags and API version
260 const int Flags, API;
262 /** Initialize version class
264 Version(const std::string &sversion, int flags, int api_ver);
267 /** The ModuleMessage class is the base class of Request and Event
268 * This class is used to represent a basic data structure which is passed
269 * between modules for safe inter-module communications.
271 class CoreExport ModuleMessage : public Extensible
276 virtual ~ModuleMessage() {};
279 /** The Request class is a unicast message directed at a given module.
280 * When this class is properly instantiated it may be sent to a module
281 * using the Send() method, which will call the given module's OnRequest
282 * method with this class as its parameter.
284 class CoreExport Request : public ModuleMessage
287 /** This member holds a pointer to arbitary data set by the emitter of the message
290 /** This should be a null-terminated string identifying the type of request,
291 * all modules should define this and use it to determine the nature of the
292 * request before they attempt to cast the Request in any way.
295 /** This is a pointer to the sender of the message, which can be used to
296 * directly trigger events, or to create a reply.
299 /** The single destination of the Request
303 /** Create a new Request
304 * This is for the 'old' way of casting whatever the data is
305 * to char* and hoping you get the right thing at the other end.
306 * This is slowly being depreciated in favor of the 'new' way.
308 Request(char* anydata, Module* src, Module* dst);
309 /** Create a new Request
310 * This is for the 'new' way of defining a subclass
311 * of Request and defining it in a common header,
312 * passing an object of your Request subclass through
313 * as a Request* and using the ID string to determine
314 * what to cast it back to and the other end. This is
315 * much safer as there are no casts not confirmed by
316 * the ID string, and all casts are child->parent and
317 * can be checked at runtime with dynamic_cast<>()
319 Request(Module* src, Module* dst, const char* idstr);
320 /** Fetch the Request data
323 /** Fetch the ID string
326 /** Fetch the request source
329 /** Fetch the request destination (should be 'this' in the receiving module)
332 /** Send the Request.
333 * Upon returning the result will be arbitary data returned by the module you
334 * sent the request to. It is up to your module to know what this data is and
335 * how to deal with it.
341 /** The Event class is a unicast message directed at all modules.
342 * When the class is properly instantiated it may be sent to all modules
343 * using the Send() method, which will trigger the OnEvent method in
344 * all modules passing the object as its parameter.
346 class CoreExport Event : public ModuleMessage
349 /** This member holds a pointer to arbitary data set by the emitter of the message
352 /** This is a pointer to the sender of the message, which can be used to
353 * directly trigger events, or to create a reply.
356 /** The event identifier.
357 * This is arbitary text which should be used to distinguish
358 * one type of event from another.
362 /** Create a new Event
364 Event(char* anydata, Module* src, const std::string &eventid);
365 /** Get the Event data
368 /** Get the event Source
371 /** Get the event ID.
372 * Use this to determine the event type for safe casting of the data
374 std::string GetEventID();
376 * The return result of an Event::Send() will always be NULL as
377 * no replies are expected.
379 char* Send(InspIRCd* ServerInstance);
382 /** Priority types which can be returned from Module::Prioritize()
384 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
386 /** Implementation-specific flags which may be set in Module::Implements()
391 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw, I_OnSendSnotice,
392 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
393 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
394 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
395 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
396 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
397 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
398 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckExtBan, I_OnCheckStringExtBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos,
399 I_OnLocalTopicChange, I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
400 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
401 I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnUserList,
402 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
403 I_OnText, I_OnPassCompare, I_OnRunTestSuite, I_OnNamesListItem, I_OnNumeric, I_OnHookUserIO,
409 /** Base class for all InspIRCd modules
410 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
411 * its methods will be called when irc server events occur. class inherited from module must be
412 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
414 class CoreExport Module : public Extensible
417 /** Creator/owner pointer
419 InspIRCd* ServerInstance;
422 /** Default constructor.
423 * Creates a module class.
424 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
425 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
427 Module(InspIRCd* Me);
429 /** Default destructor.
430 * destroys a module class
434 virtual void Prioritize()
438 /** Returns the version number of a Module.
439 * The method should return a Version object with its version information assigned via
442 virtual Version GetVersion();
444 /** Called when a user connects.
445 * The details of the connecting user are available to you in the parameter User *user
446 * @param user The user who is connecting
448 virtual void OnUserConnect(User* user);
450 /** Called when a user quits.
451 * The details of the exiting user are available to you in the parameter User *user
452 * This event is only called when the user is fully registered when they quit. To catch
453 * raw disconnections, use the OnUserDisconnect method.
454 * @param user The user who is quitting
455 * @param message The user's quit message (as seen by non-opers)
456 * @param oper_message The user's quit message (as seen by opers)
458 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
460 /** Called whenever a user's socket is closed.
461 * The details of the exiting user are available to you in the parameter User *user
462 * This event is called for all users, registered or not, as a cleanup method for modules
463 * which might assign resources to user, such as dns lookups, objects and sockets.
464 * @param user The user who is disconnecting
466 virtual void OnUserDisconnect(User* user);
468 /** Called whenever a channel is about to be deleted
469 * @param chan The channel being deleted
470 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
472 virtual int OnChannelPreDelete(Channel *chan);
474 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
475 * @param chan The channel being deleted
477 virtual void OnChannelDelete(Channel* chan);
479 /** Called when a user joins a channel.
480 * The details of the joining user are available to you in the parameter User *user,
481 * and the details of the channel they have joined is available in the variable Channel *channel
482 * @param user The user who is joining
483 * @param channel The channel being joined
484 * @param silent Change this to true if you want to conceal the JOIN command from the other users
485 * of the channel (useful for modules such as auditorium)
486 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
487 * to a channel due to the network sync.
489 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
491 /** Called after a user joins a channel
492 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
494 * @param user The user who is joining
495 * @param channel The channel being joined
497 virtual void OnPostJoin(User* user, Channel* channel);
499 /** Called when a user parts a channel.
500 * The details of the leaving user are available to you in the parameter User *user,
501 * and the details of the channel they have left is available in the variable Channel *channel
502 * @param user The user who is parting
503 * @param channel The channel being parted
504 * @param partmessage The part message, or an empty string (may be modified)
505 * @param silent Change this to true if you want to conceal the PART command from the other users
506 * of the channel (useful for modules such as auditorium)
508 virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
510 /** Called on rehash.
511 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
512 * system. You should use it to reload any files so that your module keeps in step with the
513 * rest of the application. If a parameter is given, the core has done nothing. The module
514 * receiving the event can decide if this parameter has any relevence to it.
515 * @param user The user performing the rehash, if any -- if this is server initiated, the
516 * value of this variable will be NULL.
517 * @param parameter The (optional) parameter given to REHASH from the user.
519 virtual void OnRehash(User* user, const std::string ¶meter);
521 /** Called when a raw command is transmitted or received.
522 * This method is the lowest level of handler available to a module. It will be called with raw
523 * data which is passing through a connected socket. If you wish, you may munge this data by changing
524 * the string parameter "raw". If you do this, after your function exits it will immediately be
525 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
526 * inbound is set to true) the value of user will be the User of the connection sending the
527 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
528 * @param raw The raw string in RFC1459 format
529 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
530 * @param user The user record sending the text, when inbound == true.
532 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
534 /** Called whenever a snotice is about to be sent to a snomask.
535 * snomask and type may both be modified; the message may not.
536 * @param snomask The snomask the message is going to (e.g. 'A')
537 * @param type The textual description the snomask will go to (e.g. 'OPER')
538 * @param message The text message to be sent via snotice
539 * @return 1 to block the snotice from being sent entirely, 0 else.
541 virtual int OnSendSnotice(char &snomask, std::string &type, const std::string &message);
543 /** Called whenever a user is about to join a channel, before any processing is done.
544 * Returning a value of 1 from this function stops the process immediately, causing no
545 * output to be sent to the user by the core. If you do this you must produce your own numerics,
546 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
547 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
551 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
552 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
553 * processing on the actual channel record at this point, however the channel NAME will still be passed in
554 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
555 * @param user The user joining the channel
556 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
557 * @param cname The channel name being joined. For new channels this is valid where chan is not.
558 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
559 * You may alter this string to alter the user's modes on the channel.
560 * @param keygiven The key given to join the channel, or an empty string if none was provided
561 * @return 1 To prevent the join, 0 to allow it.
563 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven);
565 /** Called whenever a user is about to be kicked.
566 * Returning a value of 1 from this function stops the process immediately, causing no
567 * output to be sent to the user by the core. If you do this you must produce your own numerics,
569 * @param source The user issuing the kick
570 * @param user The user being kicked
571 * @param chan The channel the user is being kicked from
572 * @param reason The kick reason
573 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
575 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
577 /** Called whenever a user is kicked.
578 * If this method is called, the kick is already underway and cannot be prevented, so
579 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
580 * @param source The user issuing the kick
581 * @param user The user being kicked
582 * @param chan The channel the user is being kicked from
583 * @param reason The kick reason
584 * @param silent Change this to true if you want to conceal the PART command from the other users
585 * of the channel (useful for modules such as auditorium)
587 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
589 /** Called whenever a user opers locally.
590 * The User will contain the oper mode 'o' as this function is called after any modifications
591 * are made to the user's structure by the core.
592 * @param user The user who is opering up
593 * @param opertype The opers type name
595 virtual void OnOper(User* user, const std::string &opertype);
597 /** Called after a user opers locally.
598 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
599 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
600 * out the OPERTYPE, etc.
601 * @param user The user who is opering up
602 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
603 * @param opertype The opers type name
605 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
607 /** Called whenever a user types /INFO.
608 * The User will contain the information of the user who typed the command. Modules may use this
609 * method to output their own credits in /INFO (which is the ircd's version of an about box).
610 * It is purposefully not possible to modify any info that has already been output, or halt the list.
611 * You must write a 371 numeric to the user, containing your info in the following format:
613 * <nick> :information here
615 * @param user The user issuing /INFO
617 virtual void OnInfo(User* user);
619 /** Called whenever a /WHOIS is performed on a local user.
620 * The source parameter contains the details of the user who issued the WHOIS command, and
621 * the dest parameter contains the information of the user they are whoising.
622 * @param source The user issuing the WHOIS command
623 * @param dest The user who is being WHOISed
625 virtual void OnWhois(User* source, User* dest);
627 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
628 * Returning 1 from this function stops the process immediately, causing no
629 * output to be sent to the user by the core. If you do this you must produce your own numerics,
630 * notices etc. This is useful for modules which may want to filter invites to channels.
631 * @param source The user who is issuing the INVITE
632 * @param dest The user being invited
633 * @param channel The channel the user is being invited to
634 * @param timeout The time the invite will expire (0 == never)
635 * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
637 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
639 /** Called after a user has been successfully invited to a channel.
640 * You cannot prevent the invite from occuring using this function, to do that,
641 * use OnUserPreInvite instead.
642 * @param source The user who is issuing the INVITE
643 * @param dest The user being invited
644 * @param channel The channel the user is being invited to
645 * @param timeout The time the invite will expire (0 == never)
647 virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
649 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
650 * Returning any nonzero value from this function stops the process immediately, causing no
651 * output to be sent to the user by the core. If you do this you must produce your own numerics,
652 * notices etc. This is useful for modules which may want to filter or redirect messages.
653 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
654 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
655 * of where the message is destined to be sent.
656 * @param user The user sending the message
657 * @param dest The target of the message (Channel* or User*)
658 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
659 * @param text Changeable text being sent by the user
660 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
661 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
662 * It will be ignored for private messages.
663 * @return 1 to deny the NOTICE, 0 to allow it
665 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
667 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
668 * Returning any nonzero value from this function stops the process immediately, causing no
669 * output to be sent to the user by the core. If you do this you must produce your own numerics,
670 * notices etc. This is useful for modules which may want to filter or redirect messages.
671 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
672 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
673 * of where the message is destined to be sent.
674 * You may alter the message text as you wish before relinquishing control to the next module
675 * in the chain, and if no other modules block the text this altered form of the text will be sent out
676 * to the user and possibly to other servers.
677 * @param user The user sending the message
678 * @param dest The target of the message (Channel* or User*)
679 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
680 * @param text Changeable text being sent by the user
681 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
682 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
683 * It will be ignored for private notices.
684 * @return 1 to deny the NOTICE, 0 to allow it
686 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
688 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
689 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
690 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
691 * @param chan The channel to build the exempt list of
692 * @param sender The original sender of the PRIVMSG or NOTICE
693 * @param status The status char to be used for the channel list
694 * @param exempt_list The exempt list to be populated
695 * @param text The original message text causing the exempt list to be built
697 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
699 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
700 * Please note that although you can see remote nickchanges through this function, you should
701 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
702 * check user->server before taking any action (including returning nonzero from the method).
703 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
704 * module to generate some meaninful output.
705 * @param user The username changing their nick
706 * @param newnick Their new nickname
707 * @return 1 to deny the change, 0 to allow
709 virtual int OnUserPreNick(User* user, const std::string &newnick);
711 /** Called after any PRIVMSG sent from a user.
712 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
713 * if target_type is TYPE_CHANNEL.
714 * @param user The user sending the message
715 * @param dest The target of the message
716 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
717 * @param text the text being sent by the user
718 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
720 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
722 /** Called after any NOTICE sent from a user.
723 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
724 * if target_type is TYPE_CHANNEL.
725 * @param user The user sending the message
726 * @param dest The target of the message
727 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
728 * @param text the text being sent by the user
729 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
731 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
733 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
734 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
735 * if target_type is TYPE_CHANNEL.
736 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
737 * the message has already been vetted. In the case of the other two methods, a later module may stop your
738 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
739 * @param user The user sending the message
740 * @param dest The target of the message
741 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
742 * @param text the text being sent by the user
743 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
745 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
747 /** Called after every MODE command sent from a user
748 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
749 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
750 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
751 * @param user The user sending the MODEs
752 * @param dest The target of the modes (User* or Channel*)
753 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
754 * @param text The actual modes and their parameters if any
756 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
758 /** Allows modules to alter or create server descriptions
759 * Whenever a module requires a server description, for example for display in
760 * WHOIS, this function is called in all modules. You may change or define the
761 * description given in std::string &description. If you do, this description
762 * will be shown in the WHOIS fields.
763 * @param servername The servername being searched for
764 * @param description Alterable server description for this server
766 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
768 /** Allows modules to synchronize data which relates to users during a netburst.
769 * When this function is called, it will be called from the module which implements
770 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
771 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
772 * (see below). This function will be called for every user visible on your side
773 * of the burst, allowing you to for example set modes, etc. Do not use this call to
774 * synchronize data which you have stored using class Extensible -- There is a specialist
775 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
776 * @param user The user being syncronized
777 * @param proto A pointer to the module handling network protocol
778 * @param opaque An opaque pointer set by the protocol module, should not be modified!
780 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
782 /** Allows modules to synchronize data which relates to channels during a netburst.
783 * When this function is called, it will be called from the module which implements
784 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
785 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
786 * (see below). This function will be called for every user visible on your side
787 * of the burst, allowing you to for example set modes, etc. Do not use this call to
788 * synchronize data which you have stored using class Extensible -- There is a specialist
789 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
791 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
793 * @param chan The channel 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!
797 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
799 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
800 * Whenever the linking module wants to send out data, but doesnt know what the data
801 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
802 * this method is called.You should use the ProtoSendMetaData function after you've
803 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
804 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
805 * @param chan The channel whos metadata is being syncronized
806 * @param proto A pointer to the module handling network protocol
807 * @param opaque An opaque pointer set by the protocol module, should not be modified!
808 * @param extname The extensions name which is being searched for
809 * @param displayable If this value is true, the data is going to be displayed to a user,
810 * and not sent across the network. Use this to determine wether or not to show sensitive data.
812 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
814 /* Allows modules to syncronize metadata related to users over the network during a netburst.
815 * Whenever the linking module wants to send out data, but doesnt know what the data
816 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
817 * this method is called. You should use the ProtoSendMetaData function after you've
818 * correctly decided how the data should be represented, to send the metadata on its way if
819 * if it belongs to your module.
820 * @param user The user whos metadata is being syncronized
821 * @param proto A pointer to the module handling network protocol
822 * @param opaque An opaque pointer set by the protocol module, should not be modified!
823 * @param extname The extensions name which is being searched for
824 * @param displayable If this value is true, the data is going to be displayed to a user,
825 * and not sent across the network. Use this to determine wether or not to show sensitive data.
827 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
829 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
830 * Whenever the linking module wants to send out data, but doesnt know what the data
831 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
832 * this method is called. You should use the ProtoSendMetaData function after you've
833 * correctly decided how the data should be represented, to send the metadata on its way if
834 * if it belongs to your module.
835 * @param proto A pointer to the module handling network protocol
836 * @param opaque An opaque pointer set by the protocol module, should not be modified!
837 * @param displayable If this value is true, the data is going to be displayed to a user,
838 * and not sent across the network. Use this to determine wether or not to show sensitive data.
840 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
842 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
843 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
844 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
845 * @param target The Channel* or User* that data should be added to
846 * @param extname The extension name which is being sent
847 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
849 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
851 /** Implemented by modules which provide the ability to link servers.
852 * These modules will implement this method, which allows transparent sending of servermodes
853 * down the network link as a broadcast, without a module calling it having to know the format
854 * of the MODE command before the actual mode string.
856 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
857 * of how to use this function.
859 * @param opaque An opaque pointer set by the protocol module, should not be modified!
860 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
861 * @param target The Channel* or User* that modes should be sent for
862 * @param modeline The modes and parameters to be sent
864 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
866 /** Implemented by modules which provide the ability to link servers.
867 * These modules will implement this method, which allows metadata (extra data added to
868 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
869 * to other servers on a netburst and decoded at the other end by the same module on a
872 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
873 * how to use this function.
874 * @param opaque An opaque pointer set by the protocol module, should not be modified!
875 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
876 * @param target The Channel* or User* that metadata should be sent for
877 * @param extname The extension name to send metadata for
878 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
880 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
882 /** Called after every WALLOPS command.
883 * @param user The user sending the WALLOPS
884 * @param text The content of the WALLOPS message
886 virtual void OnWallops(User* user, const std::string &text);
888 /** Called whenever a user's hostname is changed.
889 * This event triggers after the host has been set.
890 * @param user The user whos host is being changed
891 * @param newhost The new hostname being set
893 virtual void OnChangeHost(User* user, const std::string &newhost);
895 /** Called whenever a user's GECOS (realname) is changed.
896 * This event triggers after the name has been set.
897 * @param user The user who's GECOS is being changed
898 * @param gecos The new GECOS being set on the user
900 virtual void OnChangeName(User* user, const std::string &gecos);
902 /** Called whenever an xline is added by a local user.
903 * This method is triggered after the line is added.
904 * @param source The sender of the line or NULL for local server
905 * @param line The xline being added
907 virtual void OnAddLine(User* source, XLine* line);
909 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
910 * This method is triggered after the line is deleted.
911 * @param source The user removing the line or NULL for local server
912 * @param line the line being deleted
914 virtual void OnDelLine(User* source, XLine* line);
916 /** Called whenever an xline expires.
917 * This method is triggered after the line is deleted.
918 * @param line The line being deleted.
920 virtual void OnExpireLine(XLine *line);
922 /** Called before your module is unloaded to clean up Extensibles.
923 * This method is called once for every user and channel on the network,
924 * so that when your module unloads it may clear up any remaining data
925 * in the form of Extensibles added using Extensible::Extend().
926 * If the target_type variable is TYPE_USER, then void* item refers to
927 * a User*, otherwise it refers to a Channel*.
928 * @param target_type The type of item being cleaned
929 * @param item A pointer to the item's class
931 virtual void OnCleanup(int target_type, void* item);
933 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
934 * have been applied. Please note that although you can see remote nickchanges through this function, you should
935 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
936 * check user->server before taking any action (including returning nonzero from the method).
937 * Because this method is called after the nickchange is taken place, no return values are possible
938 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
939 * @param user The user changing their nick
940 * @param oldnick The old nickname of the user before the nickchange
942 virtual void OnUserPostNick(User* user, const std::string &oldnick);
944 /** Called before an action which requires a channel privilage check.
945 * This function is called before many functions which check a users status on a channel, for example
946 * before opping a user, deopping a user, kicking a user, etc.
947 * There are several values for access_type which indicate for what reason access is being checked.
949 * AC_KICK (0) - A user is being kicked<br>
950 * AC_DEOP (1) - a user is being deopped<br>
951 * AC_OP (2) - a user is being opped<br>
952 * AC_VOICE (3) - a user is being voiced<br>
953 * AC_DEVOICE (4) - a user is being devoiced<br>
954 * AC_HALFOP (5) - a user is being halfopped<br>
955 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
956 * AC_INVITE () - a user is being invited<br>
957 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
958 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
959 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
960 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
961 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
962 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
963 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
964 * @param source The source of the access check
965 * @param dest The destination of the access check
966 * @param channel The channel which is being checked
967 * @param access_type See above
969 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
971 /** Called when a 005 numeric is about to be output.
972 * The module should modify the 005 numeric if needed to indicate its features.
973 * @param output The 005 string to be modified if neccessary.
975 virtual void On005Numeric(std::string &output);
977 /** Called when a client is disconnected by KILL.
978 * If a client is killed by a server, e.g. a nickname collision or protocol error,
980 * Return 1 from this function to prevent the kill, and 0 from this function to allow
981 * it as normal. If you prevent the kill no output will be sent to the client, it is
982 * down to your module to generate this information.
983 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
984 * If you do so youre risking race conditions, desyncs and worse!
985 * @param source The user sending the KILL
986 * @param dest The user being killed
987 * @param reason The kill reason
988 * @return 1 to prevent the kill, 0 to allow
990 virtual int OnKill(User* source, User* dest, const std::string &reason);
992 /** Called when an oper wants to disconnect a remote user via KILL
993 * @param source The user sending the KILL
994 * @param dest The user being killed
995 * @param reason The kill reason
997 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
999 /** Called whenever a module is loaded.
1000 * mod will contain a pointer to the module, and string will contain its name,
1001 * for example m_widgets.so. This function is primary for dependency checking,
1002 * your module may decide to enable some extra features if it sees that you have
1003 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1004 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1005 * but instead operate under reduced functionality, unless the dependency is
1006 * absolutely neccessary (e.g. a module that extends the features of another
1008 * @param mod A pointer to the new module
1009 * @param name The new module's filename
1011 virtual void OnLoadModule(Module* mod,const std::string &name);
1013 /** Called whenever a module is unloaded.
1014 * mod will contain a pointer to the module, and string will contain its name,
1015 * for example m_widgets.so. This function is primary for dependency checking,
1016 * your module may decide to enable some extra features if it sees that you have
1017 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1018 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1019 * but instead operate under reduced functionality, unless the dependency is
1020 * absolutely neccessary (e.g. a module that extends the features of another
1022 * @param mod Pointer to the module being unloaded (still valid)
1023 * @param name The filename of the module being unloaded
1025 virtual void OnUnloadModule(Module* mod,const std::string &name);
1027 /** Called once every five seconds for background processing.
1028 * This timer can be used to control timed features. Its period is not accurate
1029 * enough to be used as a clock, but it is gauranteed to be called at least once in
1030 * any five second period, directly from the main loop of the server.
1031 * @param curtime The current timer derived from time(2)
1033 virtual void OnBackgroundTimer(time_t curtime);
1035 /** Called whenever any command is about to be executed.
1036 * This event occurs for all registered commands, wether they are registered in the core,
1037 * or another module, and for invalid commands. Invalid commands may only be sent to this
1038 * function when the value of validated is false. By returning 1 from this method you may prevent the
1039 * command being executed. If you do this, no output is created by the core, and it is
1040 * down to your module to produce any output neccessary.
1041 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1042 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1043 * method returns, it will be passed an invalid pointer to the user object and crash!)
1044 * @param command The command being executed
1045 * @param parameters An array of array of characters containing the parameters for the command
1046 * @param pcnt The nuimber of parameters passed to the command
1047 * @param user the user issuing the command
1048 * @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.
1049 * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
1050 * @param original_line The entire original line as passed to the parser from the user
1051 * @return 1 to block the command, 0 to allow
1053 virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
1055 /** Called after any command has been executed.
1056 * This event occurs for all registered commands, wether they are registered in the core,
1057 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1058 * exist within the command table). The result code returned by the command handler is
1060 * @param command The command being executed
1061 * @param parameters An array of array of characters containing the parameters for the command
1062 * @param pcnt The nuimber of parameters passed to the command
1063 * @param user the user issuing the command
1064 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1065 * @param original_line The entire original line as passed to the parser from the user
1067 virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
1069 /** Called to check if a user who is connecting can now be allowed to register
1070 * If any modules return false for this function, the user is held in the waiting
1071 * state until all modules return true. For example a module which implements ident
1072 * lookups will continue to return false for a user until their ident lookup is completed.
1073 * Note that the registration timeout for a user overrides these checks, if the registration
1074 * timeout is reached, the user is disconnected even if modules report that the user is
1075 * not ready to connect.
1076 * @param user The user to check
1077 * @return true to indicate readiness, false if otherwise
1079 virtual bool OnCheckReady(User* user);
1081 /** Called whenever a user is about to register their connection (e.g. before the user
1082 * is sent the MOTD etc). Modules can use this method if they are performing a function
1083 * which must be done before the actual connection is completed (e.g. ident lookups,
1084 * dnsbl lookups, etc).
1085 * Note that you should NOT delete the user record here by causing a disconnection!
1086 * Use OnUserConnect for that instead.
1087 * @param user The user registering
1088 * @return 1 to indicate user quit, 0 to continue
1090 virtual int OnUserRegister(User* user);
1092 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1093 * This method will always be called for each join, wether or not the channel is actually +i, and
1094 * determines the outcome of an if statement around the whole section of invite checking code.
1095 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1096 * @param user The user joining the channel
1097 * @param chan The channel being joined
1098 * @return 1 to explicitly allow the join, 0 to proceed as normal
1100 virtual int OnCheckInvite(User* user, Channel* chan);
1102 /** Called whenever a mode character is processed.
1103 * Return 1 from this function to block the mode character from being processed entirely.
1104 * @param user The user who is sending the mode
1105 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1106 * @param mode The mode character being set
1107 * @param param The parameter for the mode or an empty string
1108 * @param adding true of the mode is being added, false if it is being removed
1109 * @param pcnt The parameter count for the mode (0 or 1)
1110 * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
1111 * to skip all permission checking. Please note that for remote mode changes, your return value
1114 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt, bool servermode = true);
1116 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1117 * This method will always be called for each join, wether or not the channel is actually +k, and
1118 * determines the outcome of an if statement around the whole section of key checking code.
1119 * if the user specified no key, the keygiven string will be a valid but empty value.
1120 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1121 * @param user The user joining the channel
1122 * @param chan The channel being joined
1123 * @return 1 to explicitly allow the join, 0 to proceed as normal
1125 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1127 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1128 * This method will always be called for each join, wether or not the channel is actually +l, and
1129 * determines the outcome of an if statement around the whole section of channel limit checking code.
1130 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1131 * @param user The user joining the channel
1132 * @param chan The channel being joined
1133 * @return 1 to explicitly allow the join, 0 to proceed as normal
1135 virtual int OnCheckLimit(User* user, Channel* chan);
1137 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1138 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1139 * determines the outcome of an if statement around the whole section of ban checking code.
1140 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1141 * @param user The user joining the channel
1142 * @param chan The channel being joined
1143 * @return 1 to explicitly allow the join, 0 to proceed as normal. Return -1 to explicitly deny the
1144 * join to the channel.
1146 virtual int OnCheckBan(User* user, Channel* chan);
1148 /* Called whenever checking whether or not a user is matched by an applicable extended bantype.
1149 * NOTE: may also trigger extra OnCheckStringExtBan events!
1150 * @param u The user to check
1151 * @param c The channel the user is on
1152 * @param type The type of extended ban to check for.
1154 virtual int OnCheckExtBan(User *u, Channel *c, char type);
1156 /** Called whenever checking whether or not a string is extbanned. NOTE: one OnCheckExtBan will also trigger a number of
1157 * OnCheckStringExtBan events for seperate host/IP comnbinations.
1159 virtual int OnCheckStringExtBan(const std::string &s, Channel *c, char type);
1161 /** Called on all /STATS commands
1162 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1163 * @param symbol the symbol provided to /STATS
1164 * @param user the user issuing the /STATS command
1165 * @param results A string_list to append results into. You should put all your results
1166 * into this string_list, rather than displaying them directly, so that your handler will
1167 * work when remote STATS queries are received.
1168 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1170 virtual int OnStats(char symbol, User* user, string_list &results);
1172 /** Called whenever a change of a local users displayed host is attempted.
1173 * Return 1 to deny the host change, or 0 to allow it.
1174 * @param user The user whos host will be changed
1175 * @param newhost The new hostname
1176 * @return 1 to deny the host change, 0 to allow
1178 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1180 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1181 * return 1 to deny the name change, or 0 to allow it.
1182 * @param user The user whos GECOS will be changed
1183 * @param newhost The new GECOS
1184 * @return 1 to deny the GECOS change, 0 to allow
1186 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1188 /** Called whenever a topic is changed by a local user.
1189 * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
1190 * @param user The user changing the topic
1191 * @param chan The channels who's topic is being changed
1192 * @param topic The actual topic text
1193 * @param 1 to block the topic change, 0 to allow
1195 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1197 /** Called whenever a local topic has been changed.
1198 * To block topic changes you must use OnLocalTopicChange instead.
1199 * @param user The user changing the topic
1200 * @param chan The channels who's topic is being changed
1201 * @param topic The actual topic text
1203 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1205 /** Called whenever an Event class is sent to all module by another module.
1206 * Please see the documentation of Event::Send() for further information. The Event sent can
1207 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1208 * before doing anything to the event data, and you should *not* change the event data in any way!
1209 * @param event The Event class being received
1211 virtual void OnEvent(Event* event);
1213 /** Called whenever a Request class is sent to your module by another module.
1214 * Please see the documentation of Request::Send() for further information. The Request sent
1215 * can always be assumed to be non-NULL, you should not change the request object or its data.
1216 * Your method may return arbitary data in the char* result which the requesting module
1217 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1218 * @param request The Request class being received
1220 virtual const char* OnRequest(Request* request);
1222 /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
1223 * The password field (from the config file) is in 'password' and is to be compared against
1224 * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
1225 * You should return a nonzero value to override the normal comparison, or zero to pass it on.
1226 * @param ex The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
1227 * @param password The password from the configuration file (the password="" value).
1228 * @param input The password entered by the user or whoever.
1229 * @param hashtype The hash value from the config
1230 * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
1232 virtual int OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
1234 /** Called whenever a user is given usermode +o, anywhere on the network.
1235 * You cannot override this and prevent it from happening as it is already happened and
1236 * such a task must be performed by another server. You can however bounce modes by sending
1237 * servermodes out to reverse mode changes.
1238 * @param user The user who is opering
1240 virtual void OnGlobalOper(User* user);
1242 /** Called after a user has fully connected and all modules have executed OnUserConnect
1243 * This event is informational only. You should not change any user information in this
1244 * event. To do so, use the OnUserConnect method to change the state of local users.
1245 * This is called for both local and remote users.
1246 * @param user The user who is connecting
1248 virtual void OnPostConnect(User* user);
1250 /** Called whenever a ban is added to a channel's list.
1251 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1252 * @param source The user adding the ban
1253 * @param channel The channel the ban is being added to
1254 * @param banmask The ban mask being added
1255 * @return 1 to block the ban, 0 to continue as normal
1257 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1259 /** Called whenever a ban is removed from a channel's list.
1260 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1261 * @param source The user deleting the ban
1262 * @param channel The channel the ban is being deleted from
1263 * @param banmask The ban mask being deleted
1264 * @return 1 to block the unban, 0 to continue as normal
1266 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1268 virtual void OnHookUserIO(User* user, const std::string &targetip);
1270 /** Called immediately after any connection is accepted. This is intended for raw socket
1271 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1272 * no information relating to a user record as the connection has not been assigned yet.
1273 * There are no return values from this call as all modules get an opportunity if required to
1274 * process the connection.
1275 * @param fd The file descriptor returned from accept()
1276 * @param ip The IP address of the connecting user
1277 * @param localport The local port number the user connected to
1279 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1281 /** Called immediately before any write() operation on a user's socket in the core. Because
1282 * this event is a low level event no user information is associated with it. It is intended
1283 * for use by modules which may wrap connections within another API such as SSL for example.
1284 * return a non-zero result if you have handled the write operation, in which case the core
1285 * will not call write().
1286 * @param fd The file descriptor of the socket
1287 * @param buffer A char* buffer being written
1288 * @param Number of characters to write
1289 * @return Number of characters actually written or 0 if you didn't handle the operation
1291 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1293 /** Called immediately before any socket is closed. When this event is called, shutdown()
1294 * has not yet been called on the socket.
1295 * @param fd The file descriptor of the socket prior to close()
1297 virtual void OnRawSocketClose(int fd);
1299 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1301 * @param fd The file descriptor of the socket immediately after connect()
1303 virtual void OnRawSocketConnect(int fd);
1305 /** Called immediately before any read() operation on a client socket in the core.
1306 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1307 * when this event occurs.
1308 * Your event should return 1 if it has handled the reading itself, which prevents the core
1309 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1310 * the value of count. The value of readresult must be identical to an actual result that might
1311 * be returned from the read() system call, for example, number of bytes read upon success,
1312 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1313 * you MUST set readresult.
1314 * @param fd The file descriptor of the socket
1315 * @param buffer A char* buffer being read to
1316 * @param count The size of the buffer
1317 * @param readresult The amount of characters read, or 0
1318 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1320 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1322 /** Called whenever a user sets away or returns from being away.
1323 * The away message is available as a parameter, but should not be modified.
1324 * At this stage, it has already been copied into the user record.
1325 * If awaymsg is empty, the user is returning from away.
1326 * @param user The user setting away
1327 * @param awaymsg The away message of the user, or empty if returning from away
1328 * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
1330 virtual int OnSetAway(User* user, const std::string &awaymsg);
1332 /** Called whenever a NAMES list is requested.
1333 * You can produce the nameslist yourself, overriding the current list,
1334 * and if you do you must return 1. If you do not handle the names list,
1336 * @param The user requesting the NAMES list
1337 * @param Ptr The channel the NAMES list is requested for
1338 * @param userlist The user list for the channel (you may change this pointer.
1339 * If you want to change the values, take a copy first, and change the copy, then
1340 * point the pointer at your copy)
1341 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1342 * Returning -1 allows the names list, but bypasses any checks which check for
1343 * channel membership before sending the names list.
1345 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1347 /** Called whenever a line of WHOIS output is sent to a user.
1348 * You may change the numeric and the text of the output by changing
1349 * the values numeric and text, but you cannot change the user the
1350 * numeric is sent to. You may however change the user's User values.
1351 * @param user The user the numeric is being sent to
1352 * @param dest The user being WHOISed
1353 * @param numeric The numeric of the line being sent
1354 * @param text The text of the numeric, including any parameters
1355 * @return nonzero to drop the line completely so that the user does not
1356 * receive it, or zero to allow the line to be sent.
1358 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1360 /** Called at intervals for modules to garbage-collect any hashes etc.
1361 * Certain data types such as hash_map 'leak' buckets, which must be
1362 * tidied up and freed by copying into a new item every so often. This
1363 * method is called when it is time to do that.
1365 virtual void OnGarbageCollect();
1367 /** Called whenever a user's write buffer has been completely sent.
1368 * This is called when the user's write buffer is completely empty, and
1369 * there are no more pending bytes to be written and no pending write events
1370 * in the socket engine's queue. This may be used to refill the buffer with
1371 * data which is being spooled in a controlled manner, e.g. LIST lines.
1372 * @param user The user who's buffer is now empty.
1374 virtual void OnBufferFlushed(User* user);
1376 /** Add test suite hooks here. These are used for testing functionality of a module
1377 * via the --testsuite debugging parameter.
1379 virtual void OnRunTestSuite();
1381 /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
1382 * For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any
1383 * module, then this will cause the nickname not to be displayed at all.
1385 virtual void OnNamesListItem(User* issuer, User* user, Channel* channel, std::string &prefixes, std::string &nick);
1387 virtual int OnNumeric(User* user, unsigned int numeric, const std::string &text);
1391 #define CONF_NO_ERROR 0x000000
1392 #define CONF_NOT_A_NUMBER 0x000010
1393 #define CONF_INT_NEGATIVE 0x000080
1394 #define CONF_VALUE_NOT_FOUND 0x000100
1395 #define CONF_FILE_NOT_FOUND 0x000200
1398 /** Allows reading of values from configuration files
1399 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1400 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1401 * Constructing the class using one parameter allows you to specify a path to your own configuration
1402 * file, otherwise, inspircd.conf is read.
1404 class CoreExport ConfigReader : public classbase
1407 InspIRCd* ServerInstance;
1408 /** The contents of the configuration file
1409 * This protected member should never be accessed by a module (and cannot be accessed unless the
1410 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1411 * (such as comments) stripped from it.
1413 ConfigDataHash* data;
1414 /** Used to store errors
1416 std::ostringstream* errorlog;
1417 /** If we're using our own config data hash or not
1420 /** True if an error occured reading the config file
1428 /** Default constructor.
1429 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1430 * as specified when running ./configure.
1432 ConfigReader(InspIRCd* Instance);
1433 /** Overloaded constructor.
1434 * This constructor initialises the ConfigReader class to read a user-specified config file
1436 ConfigReader(InspIRCd* Instance, const std::string &filename);
1437 /** Default destructor.
1438 * This method destroys the ConfigReader class.
1442 /** Retrieves a value from the config file.
1443 * This method retrieves a 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.
1446 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1447 /** Retrieves a value from the config file.
1448 * This method retrieves a value from the config file. Where multiple copies of the tag
1449 * exist in the config file, index indicates which of the values to retrieve. If the
1450 * tag is not found the default value is returned instead.
1452 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1454 /** Retrieves a boolean value from the config file.
1455 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1456 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1457 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1459 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1460 /** Retrieves a boolean value from the config file.
1461 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1462 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1463 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1464 * If the tag is not found, the default value is used instead.
1466 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1468 /** Retrieves an integer value from the config file.
1469 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1470 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1471 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1472 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1473 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1474 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1475 * should cast the result to achieve that effect.
1477 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1478 /** Retrieves an integer value from the config file.
1479 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1480 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1481 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1482 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1483 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1484 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1486 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1488 /** Returns the last error to occur.
1489 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1490 * A call to GetError() resets the error flag back to 0.
1493 /** Counts the number of times a given tag appears in the config file.
1494 * This method counts the number of times a tag appears in a config file, for use where
1495 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1496 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1497 * multiple instance tag.
1499 int Enumerate(const std::string &tag);
1500 /** Returns true if a config file is valid.
1501 * This method is partially implemented and will only return false if the config
1502 * file does not exist or could not be opened.
1505 /** Dumps the list of errors in a config file to an output location. If bail is true,
1506 * then the program will abort. If bail is false and user points to a valid user
1507 * record, the error report will be spooled to the given user by means of NOTICE.
1508 * if bool is false AND user is false, the error report will be spooled to all opers
1509 * by means of a NOTICE to all opers.
1511 void DumpErrors(bool bail,User* user);
1513 /** Returns the number of items within a tag.
1514 * For example if the tag was <test tag="blah" data="foo"> then this
1515 * function would return 2. Spaces and newlines both qualify as valid seperators
1518 int EnumerateValues(const std::string &tag, int index);
1523 /** Caches a text file into memory and can be used to retrieve lines from it.
1524 * This class contains methods for read-only manipulation of a text file in memory.
1525 * Either use the constructor type with one parameter to load a file into memory
1526 * at construction, or use the LoadFile method to load a file.
1528 class CoreExport FileReader : public classbase
1530 InspIRCd* ServerInstance;
1531 /** The file contents
1535 /** Content size in bytes
1537 unsigned long contentsize;
1539 /** Calculate content size in bytes
1544 /** Default constructor.
1545 * This method does not load any file into memory, you must use the LoadFile method
1546 * after constructing the class this way.
1548 FileReader(InspIRCd* Instance);
1550 /** Secondary constructor.
1551 * This method initialises the class with a file loaded into it ready for GetLine and
1552 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1555 FileReader(InspIRCd* Instance, const std::string &filename);
1557 /** Default destructor.
1558 * This deletes the memory allocated to the file.
1562 /** Used to load a file.
1563 * This method loads a file into the class ready for GetLine and
1564 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1567 void LoadFile(const std::string &filename);
1569 /** Returns the whole content of the file as std::string
1571 std::string Contents();
1573 /** Returns the entire size of the file as std::string
1575 unsigned long ContentSize();
1577 /** Returns true if the file exists
1578 * This function will return false if the file could not be opened.
1582 /** Retrieve one line from the file.
1583 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1584 * the index was out of bounds, or the line had no data on it.
1586 std::string GetLine(int x);
1588 /** Returns the size of the file in lines.
1589 * This method returns the number of lines in the read file. If it is 0, no lines have been
1590 * read into memory, either because the file is empty or it does not exist, or cannot be
1591 * opened due to permission problems.
1596 /** A DLLFactory (designed to load shared objects) containing a
1597 * handle to a module's init_module() function. Unfortunately,
1598 * due to the design of shared object systems we must keep this
1599 * hanging around, as if we remove this handle, we remove the
1600 * shared object file from memory (!)
1602 typedef DLLFactory<Module> ircd_module;
1604 /** A list of modules
1606 typedef std::vector<Module*> IntModuleList;
1608 /** An event handler iterator
1610 typedef IntModuleList::iterator EventHandlerIter;
1612 /** Module priority states
1623 /** ModuleManager takes care of all things module-related
1626 class CoreExport ModuleManager : public classbase
1629 /** Holds a string describing the last module error to occur
1631 std::string LastModuleError;
1633 /** The feature names published by various modules
1635 featurelist Features;
1637 /** The interface names published by various modules
1639 interfacelist Interfaces;
1641 /** Total number of modules loaded into the ircd
1645 /** Our pointer to the main insp instance
1649 /** List of loaded modules and shared object/dll handles
1650 * keyed by module name
1652 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1656 /** Event handler hooks.
1657 * This needs to be public to be used by FOREACH_MOD and friends.
1659 IntModuleList EventHandlers[I_END];
1661 /** Simple, bog-standard, boring constructor.
1663 ModuleManager(InspIRCd* Ins);
1669 /** Change the priority of one event in a module.
1670 * Each module event has a list of modules which are attached to that event type.
1671 * If you wish to be called before or after other specific modules, you may use this
1672 * method (usually within void Module::Prioritize()) to set your events priority.
1673 * You may use this call in other methods too, however, this is not supported behaviour
1675 * @param mod The module to change the priority of
1676 * @param i The event to change the priority of
1677 * @param s The state you wish to use for this event. Use one of
1678 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1679 * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
1680 * to set it to be before or after one or more other modules.
1681 * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
1682 * then this contains a list of one or more modules your module must be
1683 * placed before or after. Your module will be placed before the highest
1684 * priority module in this list for PRIO_BEFORE, or after the lowest
1685 * priority module in this list for PRIO_AFTER.
1686 * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
1687 * Defaults to 1, as most of the time you will only want to prioritize your module
1688 * to be before or after one other module.
1690 bool SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules = NULL, size_t sz = 1);
1692 /** Change the priority of all events in a module.
1693 * @param mod The module to set the priority of
1694 * @param s The priority of all events in the module.
1695 * Note that with this method, it is not possible to effectively use
1696 * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
1697 * SetPriority method for this, where you may specify other modules to
1698 * be prioritized against.
1700 bool SetPriority(Module* mod, PriorityState s);
1702 /** Attach an event to a module.
1703 * You may later detatch the event with ModuleManager::Detach().
1704 * If your module is unloaded, all events are automatically detatched.
1705 * @param i Event type to attach
1706 * @param mod Module to attach event to
1707 * @return True if the event was attached
1709 bool Attach(Implementation i, Module* mod);
1711 /** Detatch an event from a module.
1712 * This is not required when your module unloads, as the core will
1713 * automatically detatch your module from all events it is attached to.
1714 * @param i Event type to detach
1715 * @param mod Module to detach event from
1716 * @param Detach true if the event was detached
1718 bool Detach(Implementation i, Module* mod);
1720 /** Attach an array of events to a module
1721 * @param i Event types (array) to attach
1722 * @param mod Module to attach events to
1724 void Attach(Implementation* i, Module* mod, size_t sz);
1726 /** Detach all events from a module (used on unload)
1727 * @param mod Module to detach from
1729 void DetachAll(Module* mod);
1731 /** Returns text describing the last module error
1732 * @return The last error message to occur
1734 std::string& LastError();
1736 /** Load a given module file
1737 * @param filename The file to load
1738 * @return True if the module was found and loaded
1740 bool Load(const char* filename);
1742 /** Unload a given module file
1743 * @param filename The file to unload
1744 * @return True if the module was unloaded
1746 bool Unload(const char* filename);
1748 /** Called by the InspIRCd constructor to load all modules from the config file.
1752 /** Get the total number of currently loaded modules
1753 * @return The number of loaded modules
1757 return this->ModCount;
1760 /** Find a module by name, and return a Module* to it.
1761 * This is preferred over iterating the module lists yourself.
1762 * @param name The module name to look up
1763 * @return A pointer to the module, or NULL if the module cannot be found
1765 Module* Find(const std::string &name);
1767 /** Publish a 'feature'.
1768 * There are two ways for a module to find another module it depends on.
1769 * Either by name, using InspIRCd::FindModule, or by feature, using this
1770 * function. A feature is an arbitary string which identifies something this
1771 * module can do. For example, if your module provides SSL support, but other
1772 * modules provide SSL support too, all the modules supporting SSL should
1773 * publish an identical 'SSL' feature. This way, any module requiring use
1774 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1775 * then use the module pointer they are given.
1776 * @param FeatureName The case sensitive feature name to make available
1777 * @param Mod a pointer to your module class
1778 * @returns True on success, false if the feature is already published by
1781 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1783 /** Publish a module to an 'interface'.
1784 * Modules which implement the same interface (the same way of communicating
1785 * with other modules) can publish themselves to an interface, using this
1786 * method. When they do so, they become part of a list of related or
1787 * compatible modules, and a third module may then query for that list
1788 * and know that all modules within that list offer the same API.
1789 * A prime example of this is the hashing modules, which all accept the
1790 * same types of Request class. Consider this to be similar to PublishFeature,
1791 * except for that multiple modules may publish the same 'feature'.
1792 * @param InterfaceName The case sensitive interface name to make available
1793 * @param Mod a pointer to your module class
1794 * @returns True on success, false on failure (there are currently no failure
1797 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1799 /** Return a pair saying how many other modules are currently using the
1800 * interfaces provided by module m.
1801 * @param m The module to count usage for
1802 * @return A pair, where the first value is the number of uses of the interface,
1803 * and the second value is the interface name being used.
1805 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1807 /** Mark your module as using an interface.
1808 * If you mark your module as using an interface, then that interface
1809 * module may not unload until your module has unloaded first.
1810 * This can be used to prevent crashes by ensuring code you depend on
1811 * is always in memory while your module is active.
1812 * @param InterfaceName The interface to use
1814 void UseInterface(const std::string &InterfaceName);
1816 /** Mark your module as finished with an interface.
1817 * If you used UseInterface() above, you should use this method when
1818 * your module is finished with the interface (usually in its destructor)
1819 * to allow the modules which implement the given interface to be unloaded.
1820 * @param InterfaceName The interface you are finished with using.
1822 void DoneWithInterface(const std::string &InterfaceName);
1824 /** Unpublish a 'feature'.
1825 * When your module exits, it must call this method for every feature it
1826 * is providing so that the feature table is cleaned up.
1827 * @param FeatureName the feature to remove
1829 bool UnpublishFeature(const std::string &FeatureName);
1831 /** Unpublish your module from an interface
1832 * When your module exits, it must call this method for every interface
1833 * it is part of so that the interfaces table is cleaned up. Only when
1834 * the last item is deleted from an interface does the interface get
1836 * @param InterfaceName the interface to be removed from
1837 * @param Mod The module to remove from the interface list
1839 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1841 /** Find a 'feature'.
1842 * There are two ways for a module to find another module it depends on.
1843 * Either by name, using InspIRCd::FindModule, or by feature, using the
1844 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1845 * identifies something this module can do. For example, if your module
1846 * provides SSL support, but other modules provide SSL support too, all
1847 * the modules supporting SSL should publish an identical 'SSL' feature.
1848 * To find a module capable of providing the feature you want, simply
1849 * call this method with the feature name you are looking for.
1850 * @param FeatureName The feature name you wish to obtain the module for
1851 * @returns A pointer to a valid module class on success, NULL on failure.
1853 Module* FindFeature(const std::string &FeatureName);
1855 /** Find an 'interface'.
1856 * An interface is a list of modules which all implement the same API.
1857 * @param InterfaceName The Interface you wish to obtain the module
1859 * @return A pointer to a deque of Module*, or NULL if the interface
1862 modulelist* FindInterface(const std::string &InterfaceName);
1864 /** Determine if a module has published the named interface.
1865 * This could be used in, for example, OnLoadModule to pick up other modules that can be used.
1866 * @param mod The module to check.
1867 * @param InterfaceName the interface you want to check for
1868 * @return True if the module provides the interface, false otherwise.
1870 bool ModuleHasInterface(Module* mod, const std::string& InterfaceName);
1872 /** Given a pointer to a Module, return its filename
1873 * @param m The module pointer to identify
1874 * @return The module name or an empty string
1876 const std::string& GetModuleName(Module* m);
1878 /** Return a list of all modules matching the given filter
1879 * @param filter This int is a bitmask of flags set in Module::Flags,
1880 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1881 * all modules with no filtering, set this to 0.
1882 * @return The list of module names
1884 const std::vector<std::string> GetAllModuleNames(int filter);
1887 /** This definition is used as shorthand for the various classes
1888 * and functions needed to make a module loadable by the OS.
1889 * It defines the class factory and external init_module function.
1893 #define MODULE_INIT(y) \
1894 extern "C" DllExport Module * init_module(InspIRCd* Me) \
1898 BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
1900 switch ( nReason ) \
1902 case DLL_PROCESS_ATTACH: \
1903 case DLL_PROCESS_DETACH: \
1911 #define MODULE_INIT(y) \
1912 extern "C" DllExport Module * init_module(InspIRCd* Me) \