1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 * ---------------------------------------------------
17 /** Used with OnAccessCheck() method of modules
19 enum AccessControlType {
20 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
21 ACR_DENY, // deny the action
22 ACR_ALLOW, // allow the action
23 AC_KICK, // a user is being kicked
24 AC_DEOP, // a user is being deopped
25 AC_OP, // a user is being opped
26 AC_VOICE, // a user is being voiced
27 AC_DEVOICE, // a user is being devoiced
28 AC_HALFOP, // a user is being halfopped
29 AC_DEHALFOP, // a user is being dehalfopped
30 AC_INVITE, // a user is being invited
31 AC_GENERAL_MODE // a channel mode is being changed
34 /** Used to define a set of behavior bits for a module
37 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
38 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
39 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
40 VF_COMMON = 8 // module needs to be common on all servers in a network to link
43 /** Used with SendToMode()
50 /** Used to represent an event type, for user, channel or server
52 enum TargetTypeFlags {
59 /** Used to represent wether a message was PRIVMSG or NOTICE
70 #include "inspsocket.h"
78 /** If you change the module API, change this value.
79 * If you have enabled ipv6, the sizes of structs is
80 * different, and modules will be incompatible with
81 * ipv4 servers, so this value will be ten times as
82 * high on ipv6 servers.
84 #define NATIVE_API_VERSION 12000
86 #define API_VERSION (NATIVE_API_VERSION * 10)
88 #define API_VERSION (NATIVE_API_VERSION * 1)
93 /* Forward-delacare module for ModuleMessage etc
98 /** Low level definition of a FileReader classes file cache area -
99 * a text file seperated into lines.
101 typedef std::deque<std::string> file_cache;
103 /** A set of strings.
105 typedef file_cache string_list;
107 /** Holds a list of 'published features' for modules.
109 typedef std::map<std::string,Module*> featurelist;
111 /** Holds a list of modules which implement an interface
113 typedef std::deque<Module*> modulelist;
115 /** Holds a list of all modules which implement interfaces, by interface name
117 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
120 * This #define allows us to call a method in all
121 * loaded modules in a readable simple way, e.g.:
122 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
124 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
125 for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
126 if (ServerInstance->Config->implement_lists[_i][y]) \
129 ServerInstance->Modules->modules[_i]->x ; \
131 catch (CoreException& modexcept) \
133 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
139 * This #define allows us to call a method in all
140 * loaded modules in a readable simple way and pass
141 * an instance pointer to the macro. e.g.:
142 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
144 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
145 for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
146 if (z->Config->implement_lists[_i][y]) \
149 z->Modules->modules[_i]->x ; \
151 catch (CoreException& modexcept) \
153 z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
158 * This define is similar to the one above but returns a result in MOD_RESULT.
159 * The first module to return a nonzero result is the value to be accepted,
160 * and any modules after are ignored.
162 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
164 for (int _i = 0; _i <= ServerInstance->Modules->GetCount(); _i++) { \
165 if (ServerInstance->Config->implement_lists[_i][y]) { \
168 int res = ServerInstance->Modules->modules[_i]->x ; \
174 catch (CoreException& modexcept) \
176 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
184 * This define is similar to the one above but returns a result in MOD_RESULT.
185 * The first module to return a nonzero result is the value to be accepted,
186 * and any modules after are ignored.
188 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
190 for (int _i = 0; _i <= z->Modules->GetCount(); _i++) { \
191 if (z->Config->implement_lists[_i][y]) { \
194 int res = z->Modules->modules[_i]->x ; \
200 catch (CoreException& modexcept) \
202 z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
209 /** Represents a non-local user.
210 * (in fact, any FD less than -1 does)
212 #define FD_MAGIC_NUMBER -42
216 /** Is a local user */
217 #define IS_LOCAL(x) ((x->GetFd() > -1))
219 /** Is a local user */
220 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
222 /** Is a remote user */
223 #define IS_REMOTE(x) (x->GetFd() < 0)
224 /** Is a module created user */
225 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
227 #define IS_OPER(x) (*x->oper)
229 #define IS_AWAY(x) (*x->awaymsg)
231 /** Holds a module's Version information.
232 * The four members (set by the constructor only) indicate details as to the version number
233 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
234 * The flags and API values represent the module flags and API version of the module.
235 * The API version of a module must match the API version of the core exactly for the module to
238 class CoreExport Version : public classbase
241 /** Version numbers, build number, flags and API version
243 const int Major, Minor, Revision, Build, Flags, API;
245 /** Initialize version class
247 Version(int major, int minor, int revision, int build, int flags, int api_ver);
250 /** The ModuleMessage class is the base class of Request and Event
251 * This class is used to represent a basic data structure which is passed
252 * between modules for safe inter-module communications.
254 class CoreExport ModuleMessage : public Extensible
259 virtual ~ModuleMessage() {};
262 /** The Request class is a unicast message directed at a given module.
263 * When this class is properly instantiated it may be sent to a module
264 * using the Send() method, which will call the given module's OnRequest
265 * method with this class as its parameter.
267 class CoreExport Request : public ModuleMessage
270 /** This member holds a pointer to arbitary data set by the emitter of the message
273 /** This should be a null-terminated string identifying the type of request,
274 * all modules should define this and use it to determine the nature of the
275 * request before they attempt to cast the Request in any way.
278 /** This is a pointer to the sender of the message, which can be used to
279 * directly trigger events, or to create a reply.
282 /** The single destination of the Request
286 /** Create a new Request
287 * This is for the 'old' way of casting whatever the data is
288 * to char* and hoping you get the right thing at the other end.
289 * This is slowly being depreciated in favor of the 'new' way.
291 Request(char* anydata, Module* src, Module* dst);
292 /** Create a new Request
293 * This is for the 'new' way of defining a subclass
294 * of Request and defining it in a common header,
295 * passing an object of your Request subclass through
296 * as a Request* and using the ID string to determine
297 * what to cast it back to and the other end. This is
298 * much safer as there are no casts not confirmed by
299 * the ID string, and all casts are child->parent and
300 * can be checked at runtime with dynamic_cast<>()
302 Request(Module* src, Module* dst, const char* idstr);
303 /** Fetch the Request data
306 /** Fetch the ID string
309 /** Fetch the request source
312 /** Fetch the request destination (should be 'this' in the receiving module)
315 /** Send the Request.
316 * Upon returning the result will be arbitary data returned by the module you
317 * sent the request to. It is up to your module to know what this data is and
318 * how to deal with it.
324 /** The Event class is a unicast message directed at all modules.
325 * When the class is properly instantiated it may be sent to all modules
326 * using the Send() method, which will trigger the OnEvent method in
327 * all modules passing the object as its parameter.
329 class CoreExport Event : public ModuleMessage
332 /** This member holds a pointer to arbitary data set by the emitter of the message
335 /** This is a pointer to the sender of the message, which can be used to
336 * directly trigger events, or to create a reply.
339 /** The event identifier.
340 * This is arbitary text which should be used to distinguish
341 * one type of event from another.
345 /** Create a new Event
347 Event(char* anydata, Module* src, const std::string &eventid);
348 /** Get the Event data
351 /** Get the event Source
354 /** Get the event ID.
355 * Use this to determine the event type for safe casting of the data
357 std::string GetEventID();
359 * The return result of an Event::Send() will always be NULL as
360 * no replies are expected.
362 char* Send(InspIRCd* ServerInstance);
365 /** Priority types which can be returned from Module::Prioritize()
367 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
369 /** Implementation-specific flags which may be set in Module::Implements()
371 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
372 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
373 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
374 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
375 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
376 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
377 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
378 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
379 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
380 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
381 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
382 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
383 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed };
385 /** Base class for all InspIRCd modules
386 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
387 * its methods will be called when irc server events occur. class inherited from module must be
388 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
390 class CoreExport Module : public Extensible
393 /** Creator/owner pointer
395 InspIRCd* ServerInstance;
398 /** Default constructor.
399 * Creates a module class.
400 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
401 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
403 Module(InspIRCd* Me);
405 /** Default destructor.
406 * destroys a module class
410 /** Returns the version number of a Module.
411 * The method should return a Version object with its version information assigned via
414 virtual Version GetVersion();
416 /** The Implements function specifies which methods a module should receive events for.
417 * The char* parameter passed to this function contains a set of true or false values
418 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
419 * enum (documented elsewhere on this page) to mark functions as active. For example, to
420 * receive events for OnUserJoin():
422 * Implements[I_OnUserJoin] = 1;
424 * @param The implement list
426 virtual void Implements(char* Implements);
428 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
429 * Some modules prefer to be called before other modules, due to their design. For example, a
430 * module which is expected to operate on complete information would expect to be placed last, so
431 * that any other modules which wish to adjust that information would execute before it, to be sure
432 * its information is correct. You can change your module's priority by returning one of:
434 * PRIORITY_FIRST - To place your module first in the list
436 * PRIORITY_LAST - To place your module last in the list
438 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
440 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
442 * The result of InspIRCd::PriorityLast() - To move your module after another named module
444 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
445 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
446 * your module has a real need to reorder its priority, it should not implement this function,
447 * as many modules changing their priorities can make the system redundant.
449 virtual Priority Prioritize();
451 /** Called when a user connects.
452 * The details of the connecting user are available to you in the parameter userrec *user
453 * @param user The user who is connecting
455 virtual void OnUserConnect(userrec* user);
457 /** Called when a user quits.
458 * The details of the exiting user are available to you in the parameter userrec *user
459 * This event is only called when the user is fully registered when they quit. To catch
460 * raw disconnections, use the OnUserDisconnect method.
461 * @param user The user who is quitting
462 * @param message The user's quit message (as seen by non-opers)
463 * @param oper_message The user's quit message (as seen by opers)
465 virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message);
467 /** Called whenever a user's socket is closed.
468 * The details of the exiting user are available to you in the parameter userrec *user
469 * This event is called for all users, registered or not, as a cleanup method for modules
470 * which might assign resources to user, such as dns lookups, objects and sockets.
471 * @param user The user who is disconnecting
473 virtual void OnUserDisconnect(userrec* user);
475 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
476 * @param chan The channel being deleted
478 virtual void OnChannelDelete(chanrec* chan);
480 /** Called when a user joins a channel.
481 * The details of the joining user are available to you in the parameter userrec *user,
482 * and the details of the channel they have joined is available in the variable chanrec *channel
483 * @param user The user who is joining
484 * @param channel The channel being joined
485 * @param silent Change this to true if you want to conceal the JOIN command from the other users
486 * of the channel (useful for modules such as auditorium)
488 virtual void OnUserJoin(userrec* user, chanrec* channel, bool &silent);
490 /** Called after a user joins a channel
491 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
493 * @param user The user who is joining
494 * @param channel The channel being joined
496 virtual void OnPostJoin(userrec* user, chanrec* channel);
498 /** Called when a user parts a channel.
499 * The details of the leaving user are available to you in the parameter userrec *user,
500 * and the details of the channel they have left is available in the variable chanrec *channel
501 * @param user The user who is parting
502 * @param channel The channel being parted
503 * @param partmessage The part message, or an empty string
504 * @param silent Change this to true if you want to conceal the PART command from the other users
505 * of the channel (useful for modules such as auditorium)
507 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent);
509 /** Called on rehash.
510 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
511 * system. You should use it to reload any files so that your module keeps in step with the
512 * rest of the application. If a parameter is given, the core has done nothing. The module
513 * receiving the event can decide if this parameter has any relevence to it.
514 * @param user The user performing the rehash, if any -- if this is server initiated, the
515 * value of this variable will be NULL.
516 * @param parameter The (optional) parameter given to REHASH from the user.
518 virtual void OnRehash(userrec* user, const std::string ¶meter);
520 /** Called when a raw command is transmitted or received.
521 * This method is the lowest level of handler available to a module. It will be called with raw
522 * data which is passing through a connected socket. If you wish, you may munge this data by changing
523 * the string parameter "raw". If you do this, after your function exits it will immediately be
524 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
525 * inbound is set to true) the value of user will be the userrec of the connection sending the
526 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
527 * @param raw The raw string in RFC1459 format
528 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
529 * @param user The user record sending the text, when inbound == true.
531 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
533 /** Called whenever a user is about to join a channel, before any processing is done.
534 * Returning a value of 1 from this function stops the process immediately, causing no
535 * output to be sent to the user by the core. If you do this you must produce your own numerics,
536 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
537 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
541 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
542 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
543 * processing on the actual channel record at this point, however the channel NAME will still be passed in
544 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
545 * @param user The user joining the channel
546 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
547 * @param cname The channel name being joined. For new channels this is valid where chan is not.
548 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
549 * You may alter this string to alter the user's modes on the channel.
550 * @return 1 To prevent the join, 0 to allow it.
552 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
554 /** Called whenever a user is about to be kicked.
555 * Returning a value of 1 from this function stops the process immediately, causing no
556 * output to be sent to the user by the core. If you do this you must produce your own numerics,
558 * @param source The user issuing the kick
559 * @param user The user being kicked
560 * @param chan The channel the user is being kicked from
561 * @param reason The kick reason
562 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
564 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
566 /** Called whenever a user is kicked.
567 * If this method is called, the kick is already underway and cannot be prevented, so
568 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
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 * @param silent Change this to true if you want to conceal the PART command from the other users
574 * of the channel (useful for modules such as auditorium)
576 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent);
578 /** Called whenever a user opers locally.
579 * The userrec will contain the oper mode 'o' as this function is called after any modifications
580 * are made to the user's structure by the core.
581 * @param user The user who is opering up
582 * @param opertype The opers type name
584 virtual void OnOper(userrec* user, const std::string &opertype);
586 /** Called after a user opers locally.
587 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
588 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
589 * out the OPERTYPE, etc.
590 * @param user The user who is opering up
591 * @param opertype The opers type name
593 virtual void OnPostOper(userrec* user, const std::string &opertype);
595 /** Called whenever a user types /INFO.
596 * The userrec 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(userrec* 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(userrec* source, userrec* 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 * @return 1 to deny the invite, 0 to allow
624 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
626 /** Called after a user has been successfully invited to a channel.
627 * You cannot prevent the invite from occuring using this function, to do that,
628 * use OnUserPreInvite instead.
629 * @param source The user who is issuing the INVITE
630 * @param dest The user being invited
631 * @param channel The channel the user is being invited to
633 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
635 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
636 * Returning any nonzero value from this function stops the process immediately, causing no
637 * output to be sent to the user by the core. If you do this you must produce your own numerics,
638 * notices etc. This is useful for modules which may want to filter or redirect messages.
639 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
640 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
641 * of where the message is destined to be sent.
642 * @param user The user sending the message
643 * @param dest The target of the message (chanrec* or userrec*)
644 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
645 * @param text Changeable text being sent by the user
646 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
647 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
648 * It will be ignored for private messages.
649 * @return 1 to deny the NOTICE, 0 to allow it
651 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
653 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
654 * Returning any nonzero value from this function stops the process immediately, causing no
655 * output to be sent to the user by the core. If you do this you must produce your own numerics,
656 * notices etc. This is useful for modules which may want to filter or redirect messages.
657 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
658 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
659 * of where the message is destined to be sent.
660 * You may alter the message text as you wish before relinquishing control to the next module
661 * in the chain, and if no other modules block the text this altered form of the text will be sent out
662 * to the user and possibly to other servers.
663 * @param user The user sending the message
664 * @param dest The target of the message (chanrec* or userrec*)
665 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
666 * @param text Changeable text being sent by the user
667 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
668 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
669 * It will be ignored for private notices.
670 * @return 1 to deny the NOTICE, 0 to allow it
672 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
674 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
675 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
676 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
677 * @param chan The channel to build the exempt list of
678 * @param sender The original sender of the PRIVMSG or NOTICE
679 * @param status The status char to be used for the channel list
680 * @param exempt_list The exempt list to be populated
682 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
684 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
685 * Please note that although you can see remote nickchanges through this function, you should
686 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
687 * check user->server before taking any action (including returning nonzero from the method).
688 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
689 * module to generate some meaninful output.
690 * @param user The username changing their nick
691 * @param newnick Their new nickname
692 * @return 1 to deny the change, 0 to allow
694 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
696 /** Called after any PRIVMSG sent from a user.
697 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
698 * if target_type is TYPE_CHANNEL.
699 * @param user The user sending the message
700 * @param dest The target of the message
701 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
702 * @param text the text being sent by the user
703 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
705 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
707 /** Called after any NOTICE sent from a user.
708 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
709 * if target_type is TYPE_CHANNEL.
710 * @param user The user sending the message
711 * @param dest The target of the message
712 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
713 * @param text the text being sent by the user
714 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
716 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
718 /** Called after every MODE command sent from a user
719 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
720 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
721 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
722 * @param user The user sending the MODEs
723 * @param dest The target of the modes (userrec* or chanrec*)
724 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
725 * @param text The actual modes and their parameters if any
727 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
729 /** Allows modules to alter or create server descriptions
730 * Whenever a module requires a server description, for example for display in
731 * WHOIS, this function is called in all modules. You may change or define the
732 * description given in std::string &description. If you do, this description
733 * will be shown in the WHOIS fields.
734 * @param servername The servername being searched for
735 * @param description Alterable server description for this server
737 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
739 /** Allows modules to synchronize data which relates to users during a netburst.
740 * When this function is called, it will be called from the module which implements
741 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
742 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
743 * (see below). This function will be called for every user visible on your side
744 * of the burst, allowing you to for example set modes, etc. Do not use this call to
745 * synchronize data which you have stored using class Extensible -- There is a specialist
746 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
747 * @param user The user being syncronized
748 * @param proto A pointer to the module handling network protocol
749 * @param opaque An opaque pointer set by the protocol module, should not be modified!
751 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
753 /** Allows modules to synchronize data which relates to channels during a netburst.
754 * When this function is called, it will be called from the module which implements
755 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
756 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
757 * (see below). This function will be called for every user visible on your side
758 * of the burst, allowing you to for example set modes, etc. Do not use this call to
759 * synchronize data which you have stored using class Extensible -- There is a specialist
760 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
762 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
764 * @param chan The channel 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 OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
770 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
771 * Whenever the linking module wants to send out data, but doesnt know what the data
772 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
773 * this method is called.You should use the ProtoSendMetaData function after you've
774 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
775 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
776 * @param chan The channel whos metadata is 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!
779 * @param extname The extensions name which is being searched for
780 * @param displayable If this value is true, the data is going to be displayed to a user,
781 * and not sent across the network. Use this to determine wether or not to show sensitive data.
783 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
785 /* Allows modules to syncronize metadata related to users over the network during a netburst.
786 * Whenever the linking module wants to send out data, but doesnt know what the data
787 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
788 * this method is called. You should use the ProtoSendMetaData function after you've
789 * correctly decided how the data should be represented, to send the metadata on its way if
790 * if it belongs to your module.
791 * @param user The user whos metadata is being syncronized
792 * @param proto A pointer to the module handling network protocol
793 * @param opaque An opaque pointer set by the protocol module, should not be modified!
794 * @param extname The extensions name which is being searched for
795 * @param displayable If this value is true, the data is going to be displayed to a user,
796 * and not sent across the network. Use this to determine wether or not to show sensitive data.
798 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
800 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
801 * Whenever the linking module wants to send out data, but doesnt know what the data
802 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
803 * this method is called. You should use the ProtoSendMetaData function after you've
804 * correctly decided how the data should be represented, to send the metadata on its way if
805 * if it belongs to your module.
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 displayable If this value is true, the data is going to be displayed to a user,
809 * and not sent across the network. Use this to determine wether or not to show sensitive data.
811 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
813 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
814 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
815 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
816 * @param target The chanrec* or userrec* that data should be added to
817 * @param extname The extension name which is being sent
818 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
820 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
822 /** Implemented by modules which provide the ability to link servers.
823 * These modules will implement this method, which allows transparent sending of servermodes
824 * down the network link as a broadcast, without a module calling it having to know the format
825 * of the MODE command before the actual mode string.
827 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
828 * of how to use this function.
830 * @param opaque An opaque pointer set by the protocol module, should not be modified!
831 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
832 * @param target The chanrec* or userrec* that modes should be sent for
833 * @param modeline The modes and parameters to be sent
835 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
837 /** Implemented by modules which provide the ability to link servers.
838 * These modules will implement this method, which allows metadata (extra data added to
839 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
840 * to other servers on a netburst and decoded at the other end by the same module on a
843 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
844 * how to use this function.
845 * @param opaque An opaque pointer set by the protocol module, should not be modified!
846 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
847 * @param target The chanrec* or userrec* that metadata should be sent for
848 * @param extname The extension name to send metadata for
849 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
851 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
853 /** Called after every WALLOPS command.
854 * @param user The user sending the WALLOPS
855 * @param text The content of the WALLOPS message
857 virtual void OnWallops(userrec* user, const std::string &text);
859 /** Called whenever a user's hostname is changed.
860 * This event triggers after the host has been set.
861 * @param user The user whos host is being changed
862 * @param newhost The new hostname being set
864 virtual void OnChangeHost(userrec* user, const std::string &newhost);
866 /** Called whenever a user's GECOS (realname) is changed.
867 * This event triggers after the name has been set.
868 * @param user The user who's GECOS is being changed
869 * @param gecos The new GECOS being set on the user
871 virtual void OnChangeName(userrec* user, const std::string &gecos);
873 /** Called whenever a gline is added by a local user.
874 * This method is triggered after the line is added.
875 * @param duration The duration of the line in seconds
876 * @param source The sender of the line
877 * @param reason The reason text to be displayed
878 * @param hostmask The hostmask to add
880 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
882 /** Called whenever a zline is added by a local user.
883 * This method is triggered after the line is added.
884 * @param duration The duration of the line in seconds
885 * @param source The sender of the line
886 * @param reason The reason text to be displayed
887 * @param ipmask The hostmask to add
889 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
891 /** Called whenever a kline is added by a local user.
892 * This method is triggered after the line is added.
893 * @param duration The duration of the line in seconds
894 * @param source The sender of the line
895 * @param reason The reason text to be displayed
896 * @param hostmask The hostmask to add
898 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
900 /** Called whenever a qline is added by a local user.
901 * This method is triggered after the line is added.
902 * @param duration The duration of the line in seconds
903 * @param source The sender of the line
904 * @param reason The reason text to be displayed
905 * @param nickmask The hostmask to add
907 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
909 /** Called whenever a eline is added by a local user.
910 * This method is triggered after the line is added.
911 * @param duration The duration of the line in seconds
912 * @param source The sender of the line
913 * @param reason The reason text to be displayed
914 * @param hostmask The hostmask to add
916 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
918 /** Called whenever a gline is deleted.
919 * This method is triggered after the line is deleted.
920 * @param source The user removing the line
921 * @param hostmask The hostmask to delete
923 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
925 /** Called whenever a zline is deleted.
926 * This method is triggered after the line is deleted.
927 * @param source The user removing the line
928 * @param hostmask The hostmask to delete
930 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
932 /** Called whenever a kline is deleted.
933 * This method is triggered after the line is deleted.
934 * @param source The user removing the line
935 * @param hostmask The hostmask to delete
937 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
939 /** Called whenever a qline is deleted.
940 * This method is triggered after the line is deleted.
941 * @param source The user removing the line
942 * @param hostmask The hostmask to delete
944 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
946 /** Called whenever a eline is deleted.
947 * This method is triggered after the line is deleted.
948 * @param source The user removing the line
949 * @param hostmask The hostmask to delete
951 virtual void OnDelELine(userrec* source, const std::string &hostmask);
953 /** Called before your module is unloaded to clean up Extensibles.
954 * This method is called once for every user and channel on the network,
955 * so that when your module unloads it may clear up any remaining data
956 * in the form of Extensibles added using Extensible::Extend().
957 * If the target_type variable is TYPE_USER, then void* item refers to
958 * a userrec*, otherwise it refers to a chanrec*.
959 * @param target_type The type of item being cleaned
960 * @param item A pointer to the item's class
962 virtual void OnCleanup(int target_type, void* item);
964 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
965 * have been applied. Please note that although you can see remote nickchanges through this function, you should
966 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
967 * check user->server before taking any action (including returning nonzero from the method).
968 * Because this method is called after the nickchange is taken place, no return values are possible
969 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
970 * @param user The user changing their nick
971 * @param oldnick The old nickname of the user before the nickchange
973 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
975 /** Called before an action which requires a channel privilage check.
976 * This function is called before many functions which check a users status on a channel, for example
977 * before opping a user, deopping a user, kicking a user, etc.
978 * There are several values for access_type which indicate for what reason access is being checked.
980 * AC_KICK (0) - A user is being kicked<br>
981 * AC_DEOP (1) - a user is being deopped<br>
982 * AC_OP (2) - a user is being opped<br>
983 * AC_VOICE (3) - a user is being voiced<br>
984 * AC_DEVOICE (4) - a user is being devoiced<br>
985 * AC_HALFOP (5) - a user is being halfopped<br>
986 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
987 * AC_INVITE () - a user is being invited<br>
988 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
989 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
990 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
991 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
992 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
993 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
994 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
995 * @param source The source of the access check
996 * @param dest The destination of the access check
997 * @param channel The channel which is being checked
998 * @param access_type See above
1000 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
1002 /** Called when a 005 numeric is about to be output.
1003 * The module should modify the 005 numeric if needed to indicate its features.
1004 * @param output The 005 string to be modified if neccessary.
1006 virtual void On005Numeric(std::string &output);
1008 /** Called when a client is disconnected by KILL.
1009 * If a client is killed by a server, e.g. a nickname collision or protocol error,
1011 * Return 1 from this function to prevent the kill, and 0 from this function to allow
1012 * it as normal. If you prevent the kill no output will be sent to the client, it is
1013 * down to your module to generate this information.
1014 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
1015 * If you do so youre risking race conditions, desyncs and worse!
1016 * @param source The user sending the KILL
1017 * @param dest The user being killed
1018 * @param reason The kill reason
1019 * @return 1 to prevent the kill, 0 to allow
1021 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
1023 /** Called when an oper wants to disconnect a remote user via KILL
1024 * @param source The user sending the KILL
1025 * @param dest The user being killed
1026 * @param reason The kill reason
1028 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason);
1030 /** Called whenever a module is loaded.
1031 * mod will contain a pointer to the module, and string will contain its name,
1032 * for example m_widgets.so. This function is primary for dependency checking,
1033 * your module may decide to enable some extra features if it sees that you have
1034 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1035 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1036 * but instead operate under reduced functionality, unless the dependency is
1037 * absolutely neccessary (e.g. a module that extends the features of another
1039 * @param mod A pointer to the new module
1040 * @param name The new module's filename
1042 virtual void OnLoadModule(Module* mod,const std::string &name);
1044 /** Called whenever a module is unloaded.
1045 * mod will contain a pointer to the module, and string will contain its name,
1046 * for example m_widgets.so. This function is primary for dependency checking,
1047 * your module may decide to enable some extra features if it sees that you have
1048 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1049 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1050 * but instead operate under reduced functionality, unless the dependency is
1051 * absolutely neccessary (e.g. a module that extends the features of another
1053 * @param mod Pointer to the module being unloaded (still valid)
1054 * @param name The filename of the module being unloaded
1056 virtual void OnUnloadModule(Module* mod,const std::string &name);
1058 /** Called once every five seconds for background processing.
1059 * This timer can be used to control timed features. Its period is not accurate
1060 * enough to be used as a clock, but it is gauranteed to be called at least once in
1061 * any five second period, directly from the main loop of the server.
1062 * @param curtime The current timer derived from time(2)
1064 virtual void OnBackgroundTimer(time_t curtime);
1066 /** Called whenever any command is about to be executed.
1067 * This event occurs for all registered commands, wether they are registered in the core,
1068 * or another module, and for invalid commands. Invalid commands may only be sent to this
1069 * function when the value of validated is false. By returning 1 from this method you may prevent the
1070 * command being executed. If you do this, no output is created by the core, and it is
1071 * down to your module to produce any output neccessary.
1072 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1073 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1074 * method returns, it will be passed an invalid pointer to the user object and crash!)
1075 * @param command The command being executed
1076 * @param parameters An array of array of characters containing the parameters for the command
1077 * @param pcnt The nuimber of parameters passed to the command
1078 * @param user the user issuing the command
1079 * @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.
1080 * @param original_line The entire original line as passed to the parser from the user
1081 * @return 1 to block the command, 0 to allow
1083 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1085 /** Called after any command has been executed.
1086 * This event occurs for all registered commands, wether they are registered in the core,
1087 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1088 * exist within the command table). The result code returned by the command handler is
1090 * @param command The command being executed
1091 * @param parameters An array of array of characters containing the parameters for the command
1092 * @param pcnt The nuimber of parameters passed to the command
1093 * @param user the user issuing the command
1094 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1095 * @param original_line The entire original line as passed to the parser from the user
1097 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1099 /** Called to check if a user who is connecting can now be allowed to register
1100 * If any modules return false for this function, the user is held in the waiting
1101 * state until all modules return true. For example a module which implements ident
1102 * lookups will continue to return false for a user until their ident lookup is completed.
1103 * Note that the registration timeout for a user overrides these checks, if the registration
1104 * timeout is reached, the user is disconnected even if modules report that the user is
1105 * not ready to connect.
1106 * @param user The user to check
1107 * @return true to indicate readiness, false if otherwise
1109 virtual bool OnCheckReady(userrec* user);
1111 /** Called whenever a user is about to register their connection (e.g. before the user
1112 * is sent the MOTD etc). Modules can use this method if they are performing a function
1113 * which must be done before the actual connection is completed (e.g. ident lookups,
1114 * dnsbl lookups, etc).
1115 * Note that you should NOT delete the user record here by causing a disconnection!
1116 * Use OnUserConnect for that instead.
1117 * @param user The user registering
1118 * @return 1 to indicate user quit, 0 to continue
1120 virtual int OnUserRegister(userrec* user);
1122 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1123 * This method will always be called for each join, wether or not the channel is actually +i, and
1124 * determines the outcome of an if statement around the whole section of invite checking code.
1125 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1126 * @param user The user joining the channel
1127 * @param chan The channel being joined
1128 * @return 1 to explicitly allow the join, 0 to proceed as normal
1130 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1132 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1133 * This method will always be called for each join, wether or not the channel is actually +k, and
1134 * determines the outcome of an if statement around the whole section of key checking code.
1135 * if the user specified no key, the keygiven string will be a valid but empty value.
1136 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1137 * @param user The user joining the channel
1138 * @param chan The channel being joined
1139 * @return 1 to explicitly allow the join, 0 to proceed as normal
1141 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1143 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1144 * This method will always be called for each join, wether or not the channel is actually +l, and
1145 * determines the outcome of an if statement around the whole section of channel limit checking code.
1146 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1147 * @param user The user joining the channel
1148 * @param chan The channel being joined
1149 * @return 1 to explicitly allow the join, 0 to proceed as normal
1151 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1153 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1154 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1155 * determines the outcome of an if statement around the whole section of ban checking code.
1156 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1157 * @param user The user joining the channel
1158 * @param chan The channel being joined
1159 * @return 1 to explicitly allow the join, 0 to proceed as normal
1161 virtual int OnCheckBan(userrec* user, chanrec* chan);
1163 /** Called on all /STATS commands
1164 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1165 * @param symbol the symbol provided to /STATS
1166 * @param user the user issuing the /STATS command
1167 * @param results A string_list to append results into. You should put all your results
1168 * into this string_list, rather than displaying them directly, so that your handler will
1169 * work when remote STATS queries are received.
1170 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1172 virtual int OnStats(char symbol, userrec* user, string_list &results);
1174 /** Called whenever a change of a local users displayed host is attempted.
1175 * Return 1 to deny the host change, or 0 to allow it.
1176 * @param user The user whos host will be changed
1177 * @param newhost The new hostname
1178 * @return 1 to deny the host change, 0 to allow
1180 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1182 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1183 * return 1 to deny the name change, or 0 to allow it.
1184 * @param user The user whos GECOS will be changed
1185 * @param newhost The new GECOS
1186 * @return 1 to deny the GECOS change, 0 to allow
1188 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1190 /** Called whenever a topic is changed by a local user.
1191 * Return 1 to deny the topic change, or 0 to allow it.
1192 * @param user The user changing the topic
1193 * @param chan The channels who's topic is being changed
1194 * @param topic The actual topic text
1195 * @param 1 to block the topic change, 0 to allow
1197 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1199 /** Called whenever a local topic has been changed.
1200 * To block topic changes you must use OnLocalTopicChange instead.
1201 * @param user The user changing the topic
1202 * @param chan The channels who's topic is being changed
1203 * @param topic The actual topic text
1205 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1207 /** Called whenever an Event class is sent to all module by another module.
1208 * Please see the documentation of Event::Send() for further information. The Event sent can
1209 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1210 * before doing anything to the event data, and you should *not* change the event data in any way!
1211 * @param event The Event class being received
1213 virtual void OnEvent(Event* event);
1215 /** Called whenever a Request class is sent to your module by another module.
1216 * Please see the documentation of Request::Send() for further information. The Request sent
1217 * can always be assumed to be non-NULL, you should not change the request object or its data.
1218 * Your method may return arbitary data in the char* result which the requesting module
1219 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1220 * @param request The Request class being received
1222 virtual char* OnRequest(Request* request);
1224 /** Called whenever an oper password is to be compared to what a user has input.
1225 * The password field (from the config file) is in 'password' and is to be compared against
1226 * 'input'. This method allows for encryption of oper passwords and much more besides.
1227 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1229 * @param password The oper's password
1230 * @param input The password entered
1231 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1232 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1234 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1236 /** Called whenever a user is given usermode +o, anywhere on the network.
1237 * You cannot override this and prevent it from happening as it is already happened and
1238 * such a task must be performed by another server. You can however bounce modes by sending
1239 * servermodes out to reverse mode changes.
1240 * @param user The user who is opering
1242 virtual void OnGlobalOper(userrec* user);
1244 /** Called after a user has fully connected and all modules have executed OnUserConnect
1245 * This event is informational only. You should not change any user information in this
1246 * event. To do so, use the OnUserConnect method to change the state of local users.
1247 * This is called for both local and remote users.
1248 * @param user The user who is connecting
1250 virtual void OnPostConnect(userrec* user);
1252 /** Called whenever a ban is added to a channel's list.
1253 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1254 * @param source The user adding the ban
1255 * @param channel The channel the ban is being added to
1256 * @param banmask The ban mask being added
1257 * @return 1 to block the ban, 0 to continue as normal
1259 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1261 /** Called whenever a ban is removed from a channel's list.
1262 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1263 * @param source The user deleting the ban
1264 * @param channel The channel the ban is being deleted from
1265 * @param banmask The ban mask being deleted
1266 * @return 1 to block the unban, 0 to continue as normal
1268 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
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 InspSocket 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.
1323 * This method has no parameter for the away message, as it is available in the
1324 * user record as userrec::awaymsg.
1325 * @param user The user setting away
1327 virtual void OnSetAway(userrec* user);
1329 /** Called when a user cancels their away state.
1330 * @param user The user returning from away
1332 virtual void OnCancelAway(userrec* user);
1334 /** Called whenever a NAMES list is requested.
1335 * You can produce the nameslist yourself, overriding the current list,
1336 * and if you do you must return 1. If you do not handle the names list,
1338 * @param The user requesting the NAMES list
1339 * @param Ptr The channel the NAMES list is requested for
1340 * @param userlist The user list for the channel (you may change this pointer.
1341 * If you want to change the values, take a copy first, and change the copy, then
1342 * point the pointer at your copy)
1343 * @return 1 to prevent the user list being sent to the client, 0 to allow it
1345 virtual int OnUserList(userrec* user, chanrec* 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 userrec 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(userrec* user, userrec* 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(userrec* user);
1378 #define CONF_NOT_A_NUMBER 0x000010
1379 #define CONF_NOT_UNSIGNED 0x000080
1380 #define CONF_VALUE_NOT_FOUND 0x000100
1381 #define CONF_FILE_NOT_FOUND 0x000200
1384 /** Allows reading of values from configuration files
1385 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1386 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1387 * Constructing the class using one parameter allows you to specify a path to your own configuration
1388 * file, otherwise, inspircd.conf is read.
1390 class CoreExport ConfigReader : public classbase
1393 InspIRCd* ServerInstance;
1394 /** The contents of the configuration file
1395 * This protected member should never be accessed by a module (and cannot be accessed unless the
1396 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1397 * (such as comments) stripped from it.
1399 ConfigDataHash* data;
1400 /** Used to store errors
1402 std::ostringstream* errorlog;
1403 /** If we're using our own config data hash or not
1406 /** True if an error occured reading the config file
1414 /** Default constructor.
1415 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1416 * as specified when running ./configure.
1418 ConfigReader(InspIRCd* Instance);
1419 /** Overloaded constructor.
1420 * This constructor initialises the ConfigReader class to read a user-specified config file
1422 ConfigReader(InspIRCd* Instance, const std::string &filename);
1423 /** Default destructor.
1424 * This method destroys the ConfigReader class.
1428 /** Retrieves a value from the config file.
1429 * This method retrieves a 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.
1432 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1433 /** Retrieves a value from the config file.
1434 * This method retrieves a value from the config file. Where multiple copies of the tag
1435 * exist in the config file, index indicates which of the values to retrieve. If the
1436 * tag is not found the default value is returned instead.
1438 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1440 /** Retrieves a boolean value from the config file.
1441 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1442 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1443 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1445 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1446 /** Retrieves a boolean value from the config file.
1447 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1448 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1449 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1450 * If the tag is not found, the default value is used instead.
1452 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1454 /** Retrieves an integer value from the config file.
1455 * This method retrieves an integer 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. Any invalid integer
1457 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1458 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1459 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1460 * will return CONF_NOT_UNSIGNED
1462 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1463 /** Retrieves an integer value from the config file.
1464 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1465 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1466 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1467 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1468 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1469 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1471 long ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned);
1473 /** Returns the last error to occur.
1474 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1475 * A call to GetError() resets the error flag back to 0.
1478 /** Counts the number of times a given tag appears in the config file.
1479 * This method counts the number of times a tag appears in a config file, for use where
1480 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1481 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1482 * multiple instance tag.
1484 int Enumerate(const std::string &tag);
1485 /** Returns true if a config file is valid.
1486 * This method is partially implemented and will only return false if the config
1487 * file does not exist or could not be opened.
1490 /** Dumps the list of errors in a config file to an output location. If bail is true,
1491 * then the program will abort. If bail is false and user points to a valid user
1492 * record, the error report will be spooled to the given user by means of NOTICE.
1493 * if bool is false AND user is false, the error report will be spooled to all opers
1494 * by means of a NOTICE to all opers.
1496 void DumpErrors(bool bail,userrec* user);
1498 /** Returns the number of items within a tag.
1499 * For example if the tag was <test tag="blah" data="foo"> then this
1500 * function would return 2. Spaces and newlines both qualify as valid seperators
1503 int EnumerateValues(const std::string &tag, int index);
1508 /** Caches a text file into memory and can be used to retrieve lines from it.
1509 * This class contains methods for read-only manipulation of a text file in memory.
1510 * Either use the constructor type with one parameter to load a file into memory
1511 * at construction, or use the LoadFile method to load a file.
1513 class CoreExport FileReader : public classbase
1515 InspIRCd* ServerInstance;
1516 /** The file contents
1520 /** Content size in bytes
1522 unsigned long contentsize;
1524 /** Calculate content size in bytes
1529 /** Default constructor.
1530 * This method does not load any file into memory, you must use the LoadFile method
1531 * after constructing the class this way.
1533 FileReader(InspIRCd* Instance);
1535 /** Secondary constructor.
1536 * This method initialises the class with a file loaded into it ready for GetLine and
1537 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1540 FileReader(InspIRCd* Instance, const std::string &filename);
1542 /** Default destructor.
1543 * This deletes the memory allocated to the file.
1547 /** Used to load a file.
1548 * This method loads a file into the class ready for GetLine and
1549 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1552 void LoadFile(const std::string &filename);
1554 /** Returns the whole content of the file as std::string
1556 std::string Contents();
1558 /** Returns the entire size of the file as std::string
1560 unsigned long ContentSize();
1562 /** Returns true if the file exists
1563 * This function will return false if the file could not be opened.
1567 /** Retrieve one line from the file.
1568 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1569 * the index was out of bounds, or the line had no data on it.
1571 std::string GetLine(int x);
1573 /** Returns the size of the file in lines.
1574 * This method returns the number of lines in the read file. If it is 0, no lines have been
1575 * read into memory, either because the file is empty or it does not exist, or cannot be
1576 * opened due to permission problems.
1581 /** A DLLFactory (designed to load shared objects) containing a
1582 * handle to a module's init_module() function.
1584 typedef DLLFactory<Module> ircd_module;
1586 /** A list of loaded Modules
1588 typedef std::vector<Module*> ModuleList;
1590 /** A list of loaded module handles (ircd_module)
1592 typedef std::vector<ircd_module*> ModuleHandleList;
1594 /** ModuleManager takes care of all things module-related
1597 class CoreExport ModuleManager : public classbase
1600 /** Holds a string describing the last module error to occur
1602 char MODERR[MAXBUF];
1604 /** The feature names published by various modules
1606 featurelist Features;
1608 /** The interface names published by various modules
1610 interfacelist Interfaces;
1612 /** Total number of modules loaded into the ircd, minus one
1616 /** Our pointer to the main insp instance
1621 /** A list of ircd_module* module handles
1622 * Note that this list is always exactly 255 in size.
1623 * The actual number of loaded modules is available from GetModuleCount()
1625 ModuleHandleList handles;
1627 /** A list of Module* module classes
1628 * Note that this list is always exactly 255 in size.
1629 * The actual number of loaded modules is available from GetModuleCount()
1633 /** Simple, bog-standard, boring constructor.
1635 ModuleManager(InspIRCd* Ins);
1639 /** Returns text describing the last module error
1640 * @return The last error message to occur
1642 const char* LastError();
1644 /** Load a given module file
1645 * @param filename The file to load
1646 * @return True if the module was found and loaded
1648 bool Load(const char* filename);
1650 /** Unload a given module file
1651 * @param filename The file to unload
1652 * @return True if the module was unloaded
1654 bool Unload(const char* filename);
1656 /** Called by the InspIRCd constructor to load all modules from the config file.
1660 /** Get the total number of currently loaded modules
1661 * @return The number of loaded modules
1665 return this->ModCount;
1668 /** Find a module by name, and return a Module* to it.
1669 * This is preferred over iterating the module lists yourself.
1670 * @param name The module name to look up
1671 * @return A pointer to the module, or NULL if the module cannot be found
1673 Module* Find(const std::string &name);
1675 /** Remove a module handle pointer
1676 * @param j Index number of the module handle to remove
1677 * @return True if a handle existed at the given index, false otherwise
1679 bool EraseHandle(unsigned int j);
1681 /** Remove a Module pointer
1682 * @param j Index number of the Module to remove
1683 * @return True if a handle existed at the given index, false otherwise
1685 bool EraseModule(unsigned int j);
1687 /** Move a given module to a specific slot in the list
1688 * @param modulename The module name to relocate
1689 * @param slot The slot to move the module into
1691 void MoveTo(std::string modulename,int slot);
1693 /** Moves the given module to the last slot in the list
1694 * @param modulename The module name to relocate
1696 void MoveToLast(std::string modulename);
1698 /** Moves the given module to the first slot in the list
1699 * @param modulename The module name to relocate
1701 void MoveToFirst(std::string modulename);
1703 /** Moves one module to be placed after another in the list
1704 * @param modulename The module name to relocate
1705 * @param after The module name to place the module after
1707 void MoveAfter(std::string modulename, std::string after);
1709 /** Moves one module to be placed before another in the list
1710 * @param modulename The module name to relocate
1711 * @param after The module name to place the module before
1713 void MoveBefore(std::string modulename, std::string before);
1715 /** For use with Module::Prioritize().
1716 * When the return value of this function is returned from
1717 * Module::Prioritize(), this specifies that the module wishes
1718 * to be ordered exactly BEFORE 'modulename'. For more information
1719 * please see Module::Prioritize().
1720 * @param modulename The module your module wants to be before in the call list
1721 * @returns a priority ID which the core uses to relocate the module in the list
1723 long PriorityBefore(const std::string &modulename);
1725 /** For use with Module::Prioritize().
1726 * When the return value of this function is returned from
1727 * Module::Prioritize(), this specifies that the module wishes
1728 * to be ordered exactly AFTER 'modulename'. For more information please
1729 * see Module::Prioritize().
1730 * @param modulename The module your module wants to be after in the call list
1731 * @returns a priority ID which the core uses to relocate the module in the list
1733 long PriorityAfter(const std::string &modulename);
1735 /** Publish a 'feature'.
1736 * There are two ways for a module to find another module it depends on.
1737 * Either by name, using InspIRCd::FindModule, or by feature, using this
1738 * function. A feature is an arbitary string which identifies something this
1739 * module can do. For example, if your module provides SSL support, but other
1740 * modules provide SSL support too, all the modules supporting SSL should
1741 * publish an identical 'SSL' feature. This way, any module requiring use
1742 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1743 * then use the module pointer they are given.
1744 * @param FeatureName The case sensitive feature name to make available
1745 * @param Mod a pointer to your module class
1746 * @returns True on success, false if the feature is already published by
1749 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1751 /** Publish a module to an 'interface'.
1752 * Modules which implement the same interface (the same way of communicating
1753 * with other modules) can publish themselves to an interface, using this
1754 * method. When they do so, they become part of a list of related or
1755 * compatible modules, and a third module may then query for that list
1756 * and know that all modules within that list offer the same API.
1757 * A prime example of this is the hashing modules, which all accept the
1758 * same types of Request class. Consider this to be similar to PublishFeature,
1759 * except for that multiple modules may publish the same 'feature'.
1760 * @param InterfaceName The case sensitive interface name to make available
1761 * @param Mod a pointer to your module class
1762 * @returns True on success, false on failure (there are currently no failure
1765 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1767 /** Return a pair saying how many other modules are currently using the
1768 * interfaces provided by module m.
1769 * @param m The module to count usage for
1770 * @return A pair, where the first value is the number of uses of the interface,
1771 * and the second value is the interface name being used.
1773 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1775 /** Mark your module as using an interface.
1776 * If you mark your module as using an interface, then that interface
1777 * module may not unload until your module has unloaded first.
1778 * This can be used to prevent crashes by ensuring code you depend on
1779 * is always in memory while your module is active.
1780 * @param InterfaceName The interface to use
1782 void UseInterface(const std::string &InterfaceName);
1784 /** Mark your module as finished with an interface.
1785 * If you used UseInterface() above, you should use this method when
1786 * your module is finished with the interface (usually in its destructor)
1787 * to allow the modules which implement the given interface to be unloaded.
1788 * @param InterfaceName The interface you are finished with using.
1790 void DoneWithInterface(const std::string &InterfaceName);
1792 /** Unpublish a 'feature'.
1793 * When your module exits, it must call this method for every feature it
1794 * is providing so that the feature table is cleaned up.
1795 * @param FeatureName the feature to remove
1797 bool UnpublishFeature(const std::string &FeatureName);
1799 /** Unpublish your module from an interface
1800 * When your module exits, it must call this method for every interface
1801 * it is part of so that the interfaces table is cleaned up. Only when
1802 * the last item is deleted from an interface does the interface get
1804 * @param InterfaceName the interface to be removed from
1805 * @param Mod The module to remove from the interface list
1807 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1809 /** Find a 'feature'.
1810 * There are two ways for a module to find another module it depends on.
1811 * Either by name, using InspIRCd::FindModule, or by feature, using the
1812 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1813 * identifies something this module can do. For example, if your module
1814 * provides SSL support, but other modules provide SSL support too, all
1815 * the modules supporting SSL should publish an identical 'SSL' feature.
1816 * To find a module capable of providing the feature you want, simply
1817 * call this method with the feature name you are looking for.
1818 * @param FeatureName The feature name you wish to obtain the module for
1819 * @returns A pointer to a valid module class on success, NULL on failure.
1821 Module* FindFeature(const std::string &FeatureName);
1823 /** Find an 'interface'.
1824 * An interface is a list of modules which all implement the same API.
1825 * @param InterfaceName The Interface you wish to obtain the module
1827 * @return A pointer to a deque of Module*, or NULL if the interface
1830 modulelist* FindInterface(const std::string &InterfaceName);
1832 /** Given a pointer to a Module, return its filename
1833 * @param m The module pointer to identify
1834 * @return The module name or an empty string
1836 const std::string& GetModuleName(Module* m);
1839 /** This definition is used as shorthand for the various classes
1840 * and functions needed to make a module loadable by the OS.
1841 * It defines the class factory and external init_module function.
1843 #define MODULE_INIT(y) \
1844 extern "C" DllExport Module * init_module(InspIRCd* Me) \