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 * ---------------------------------------------------
19 /** Used with OnAccessCheck() method of modules
21 enum AccessControlType {
22 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
23 ACR_DENY, // deny the action
24 ACR_ALLOW, // allow the action
25 AC_KICK, // a user is being kicked
26 AC_DEOP, // a user is being deopped
27 AC_OP, // a user is being opped
28 AC_VOICE, // a user is being voiced
29 AC_DEVOICE, // a user is being devoiced
30 AC_HALFOP, // a user is being halfopped
31 AC_DEHALFOP, // a user is being dehalfopped
32 AC_INVITE, // a user is being invited
33 AC_GENERAL_MODE // a channel mode is being changed
36 /** Used to define a set of behavior bits for a module
39 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
40 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
41 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
42 VF_COMMON = 8 // module needs to be common on all servers in a network to link
45 /** Used with SendToMode()
52 /** Used to represent an event type, for user, channel or server
54 enum TargetTypeFlags {
61 /** Used to represent wether a message was PRIVMSG or NOTICE
72 #include "inspsocket.h"
80 /** If you change the module API, change this value.
81 * If you have enabled ipv6, the sizes of structs is
82 * different, and modules will be incompatible with
83 * ipv4 servers, so this value will be ten times as
84 * high on ipv6 servers.
86 #define NATIVE_API_VERSION 12000
88 #define API_VERSION (NATIVE_API_VERSION * 10)
90 #define API_VERSION (NATIVE_API_VERSION * 1)
95 /* Forward-delacare module for ModuleMessage etc
100 /** Low level definition of a FileReader classes file cache area -
101 * a text file seperated into lines.
103 typedef std::deque<std::string> file_cache;
105 /** A set of strings.
107 typedef file_cache string_list;
109 /** Holds a list of 'published features' for modules.
111 typedef std::map<std::string,Module*> featurelist;
113 /** Holds a list of modules which implement an interface
115 typedef std::deque<Module*> modulelist;
117 /** Holds a list of all modules which implement interfaces, by interface name
119 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
122 * This #define allows us to call a method in all
123 * loaded modules in a readable simple way, e.g.:
124 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
126 #define FOREACH_MOD(y,x) if (!ServerInstance->Modules->EventHandlers[y].empty()) \
128 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ++_i) \
134 catch (CoreException& modexcept) \
136 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
142 * This #define allows us to call a method in all
143 * loaded modules in a readable simple way and pass
144 * an instance pointer to the macro. e.g.:
145 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
147 #define FOREACH_MOD_I(z,y,x) if (!z->Modules->EventHandlers[y].empty()) \
149 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ++_i) \
155 catch (CoreException& modexcept) \
157 z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
163 * This define is similar to the one above but returns a result in MOD_RESULT.
164 * The first module to return a nonzero result is the value to be accepted,
165 * and any modules after are ignored.
167 #define FOREACH_RESULT(y,x) if (!ServerInstance->Modules->EventHandlers[y].empty()) \
170 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ++_i) \
174 int res = (*_i)->x ; \
180 catch (CoreException& modexcept) \
182 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
189 * This define is similar to the one above but returns a result in MOD_RESULT.
190 * The first module to return a nonzero result is the value to be accepted,
191 * and any modules after are ignored.
193 #define FOREACH_RESULT_I(z,y,x) if (!z->Modules->EventHandlers[y].empty()) \
196 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ++_i) \
200 int res = (*_i)->x ; \
206 catch (CoreException& modexcept) \
208 z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
213 /** Represents a non-local user.
214 * (in fact, any FD less than -1 does)
216 #define FD_MAGIC_NUMBER -42
220 /** Is a local user */
221 #define IS_LOCAL(x) ((x->GetFd() > -1))
223 /** Is a local user */
224 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
226 /** Is a remote user */
227 #define IS_REMOTE(x) (x->GetFd() < 0)
228 /** Is a module created user */
229 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
231 #define IS_OPER(x) (*x->oper)
233 #define IS_AWAY(x) (*x->awaymsg)
235 /** Holds a module's Version information.
236 * The four members (set by the constructor only) indicate details as to the version number
237 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
238 * The flags and API values represent the module flags and API version of the module.
239 * The API version of a module must match the API version of the core exactly for the module to
242 class CoreExport Version : public classbase
245 /** Version numbers, build number, flags and API version
247 const int Major, Minor, Revision, Build, Flags, API;
249 /** Initialize version class
251 Version(int major, int minor, int revision, int build, int flags, int api_ver);
254 /** The ModuleMessage class is the base class of Request and Event
255 * This class is used to represent a basic data structure which is passed
256 * between modules for safe inter-module communications.
258 class CoreExport ModuleMessage : public Extensible
263 virtual ~ModuleMessage() {};
266 /** The Request class is a unicast message directed at a given module.
267 * When this class is properly instantiated it may be sent to a module
268 * using the Send() method, which will call the given module's OnRequest
269 * method with this class as its parameter.
271 class CoreExport Request : public ModuleMessage
274 /** This member holds a pointer to arbitary data set by the emitter of the message
277 /** This should be a null-terminated string identifying the type of request,
278 * all modules should define this and use it to determine the nature of the
279 * request before they attempt to cast the Request in any way.
282 /** This is a pointer to the sender of the message, which can be used to
283 * directly trigger events, or to create a reply.
286 /** The single destination of the Request
290 /** Create a new Request
291 * This is for the 'old' way of casting whatever the data is
292 * to char* and hoping you get the right thing at the other end.
293 * This is slowly being depreciated in favor of the 'new' way.
295 Request(char* anydata, Module* src, Module* dst);
296 /** Create a new Request
297 * This is for the 'new' way of defining a subclass
298 * of Request and defining it in a common header,
299 * passing an object of your Request subclass through
300 * as a Request* and using the ID string to determine
301 * what to cast it back to and the other end. This is
302 * much safer as there are no casts not confirmed by
303 * the ID string, and all casts are child->parent and
304 * can be checked at runtime with dynamic_cast<>()
306 Request(Module* src, Module* dst, const char* idstr);
307 /** Fetch the Request data
310 /** Fetch the ID string
313 /** Fetch the request source
316 /** Fetch the request destination (should be 'this' in the receiving module)
319 /** Send the Request.
320 * Upon returning the result will be arbitary data returned by the module you
321 * sent the request to. It is up to your module to know what this data is and
322 * how to deal with it.
328 /** The Event class is a unicast message directed at all modules.
329 * When the class is properly instantiated it may be sent to all modules
330 * using the Send() method, which will trigger the OnEvent method in
331 * all modules passing the object as its parameter.
333 class CoreExport Event : public ModuleMessage
336 /** This member holds a pointer to arbitary data set by the emitter of the message
339 /** This is a pointer to the sender of the message, which can be used to
340 * directly trigger events, or to create a reply.
343 /** The event identifier.
344 * This is arbitary text which should be used to distinguish
345 * one type of event from another.
349 /** Create a new Event
351 Event(char* anydata, Module* src, const std::string &eventid);
352 /** Get the Event data
355 /** Get the event Source
358 /** Get the event ID.
359 * Use this to determine the event type for safe casting of the data
361 std::string GetEventID();
363 * The return result of an Event::Send() will always be NULL as
364 * no replies are expected.
366 char* Send(InspIRCd* ServerInstance);
369 /** Priority types which can be returned from Module::Prioritize()
371 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
373 /** Implementation-specific flags which may be set in Module::Implements()
378 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
379 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
380 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
381 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
382 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
383 I_OnDelLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
384 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
385 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
386 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
387 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
388 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
389 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
394 /** Base class for all InspIRCd modules
395 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
396 * its methods will be called when irc server events occur. class inherited from module must be
397 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
399 class CoreExport Module : public Extensible
402 /** Creator/owner pointer
404 InspIRCd* ServerInstance;
407 /** Default constructor.
408 * Creates a module class.
409 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
410 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
412 Module(InspIRCd* Me);
414 /** Default destructor.
415 * destroys a module class
419 /** Returns the version number of a Module.
420 * The method should return a Version object with its version information assigned via
423 virtual Version GetVersion();
425 /** The Implements function specifies which methods a module should receive events for.
426 * The char* parameter passed to this function contains a set of true or false values
427 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
428 * enum (documented elsewhere on this page) to mark functions as active. For example, to
429 * receive events for OnUserJoin():
431 * Implements[I_OnUserJoin] = 1;
433 * @param The implement list
435 virtual void Implements(char* Implements);
437 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
438 * Some modules prefer to be called before other modules, due to their design. For example, a
439 * module which is expected to operate on complete information would expect to be placed last, so
440 * that any other modules which wish to adjust that information would execute before it, to be sure
441 * its information is correct. You can change your module's priority by returning one of:
443 * PRIORITY_FIRST - To place your module first in the list
445 * PRIORITY_LAST - To place your module last in the list
447 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
449 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
451 * The result of InspIRCd::PriorityLast() - To move your module after another named module
453 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
454 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
455 * your module has a real need to reorder its priority, it should not implement this function,
456 * as many modules changing their priorities can make the system redundant.
458 virtual Priority Prioritize();
460 /** Called when a user connects.
461 * The details of the connecting user are available to you in the parameter User *user
462 * @param user The user who is connecting
464 virtual void OnUserConnect(User* user);
466 /** Called when a user quits.
467 * The details of the exiting user are available to you in the parameter User *user
468 * This event is only called when the user is fully registered when they quit. To catch
469 * raw disconnections, use the OnUserDisconnect method.
470 * @param user The user who is quitting
471 * @param message The user's quit message (as seen by non-opers)
472 * @param oper_message The user's quit message (as seen by opers)
474 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
476 /** Called whenever a user's socket is closed.
477 * The details of the exiting user are available to you in the parameter User *user
478 * This event is called for all users, registered or not, as a cleanup method for modules
479 * which might assign resources to user, such as dns lookups, objects and sockets.
480 * @param user The user who is disconnecting
482 virtual void OnUserDisconnect(User* user);
484 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
485 * @param chan The channel being deleted
487 virtual void OnChannelDelete(Channel* chan);
489 /** Called when a user joins a channel.
490 * The details of the joining user are available to you in the parameter User *user,
491 * and the details of the channel they have joined is available in the variable Channel *channel
492 * @param user The user who is joining
493 * @param channel The channel being joined
494 * @param silent Change this to true if you want to conceal the JOIN command from the other users
495 * of the channel (useful for modules such as auditorium)
497 virtual void OnUserJoin(User* user, Channel* channel, bool &silent);
499 /** Called after a user joins a channel
500 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
502 * @param user The user who is joining
503 * @param channel The channel being joined
505 virtual void OnPostJoin(User* user, Channel* channel);
507 /** Called when a user parts a channel.
508 * The details of the leaving user are available to you in the parameter User *user,
509 * and the details of the channel they have left is available in the variable Channel *channel
510 * @param user The user who is parting
511 * @param channel The channel being parted
512 * @param partmessage The part message, or an empty string
513 * @param silent Change this to true if you want to conceal the PART command from the other users
514 * of the channel (useful for modules such as auditorium)
516 virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
518 /** Called on rehash.
519 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
520 * system. You should use it to reload any files so that your module keeps in step with the
521 * rest of the application. If a parameter is given, the core has done nothing. The module
522 * receiving the event can decide if this parameter has any relevence to it.
523 * @param user The user performing the rehash, if any -- if this is server initiated, the
524 * value of this variable will be NULL.
525 * @param parameter The (optional) parameter given to REHASH from the user.
527 virtual void OnRehash(User* user, const std::string ¶meter);
529 /** Called when a raw command is transmitted or received.
530 * This method is the lowest level of handler available to a module. It will be called with raw
531 * data which is passing through a connected socket. If you wish, you may munge this data by changing
532 * the string parameter "raw". If you do this, after your function exits it will immediately be
533 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
534 * inbound is set to true) the value of user will be the User of the connection sending the
535 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
536 * @param raw The raw string in RFC1459 format
537 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
538 * @param user The user record sending the text, when inbound == true.
540 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
542 /** Called whenever a user is about to join a channel, before any processing is done.
543 * Returning a value of 1 from this function stops the process immediately, causing no
544 * output to be sent to the user by the core. If you do this you must produce your own numerics,
545 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
546 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
550 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
551 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
552 * processing on the actual channel record at this point, however the channel NAME will still be passed in
553 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
554 * @param user The user joining the channel
555 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
556 * @param cname The channel name being joined. For new channels this is valid where chan is not.
557 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
558 * You may alter this string to alter the user's modes on the channel.
559 * @return 1 To prevent the join, 0 to allow it.
561 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs);
563 /** Called whenever a user is about to be kicked.
564 * Returning a value of 1 from this function stops the process immediately, causing no
565 * output to be sent to the user by the core. If you do this you must produce your own numerics,
567 * @param source The user issuing the kick
568 * @param user The user being kicked
569 * @param chan The channel the user is being kicked from
570 * @param reason The kick reason
571 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
573 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
575 /** Called whenever a user is kicked.
576 * If this method is called, the kick is already underway and cannot be prevented, so
577 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
578 * @param source The user issuing the kick
579 * @param user The user being kicked
580 * @param chan The channel the user is being kicked from
581 * @param reason The kick reason
582 * @param silent Change this to true if you want to conceal the PART command from the other users
583 * of the channel (useful for modules such as auditorium)
585 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
587 /** Called whenever a user opers locally.
588 * The User will contain the oper mode 'o' as this function is called after any modifications
589 * are made to the user's structure by the core.
590 * @param user The user who is opering up
591 * @param opertype The opers type name
593 virtual void OnOper(User* user, const std::string &opertype);
595 /** Called after a user opers locally.
596 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
597 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
598 * out the OPERTYPE, etc.
599 * @param user The user who is opering up
600 * @param opertype The opers type name
602 virtual void OnPostOper(User* user, const std::string &opertype);
604 /** Called whenever a user types /INFO.
605 * The User will contain the information of the user who typed the command. Modules may use this
606 * method to output their own credits in /INFO (which is the ircd's version of an about box).
607 * It is purposefully not possible to modify any info that has already been output, or halt the list.
608 * You must write a 371 numeric to the user, containing your info in the following format:
610 * <nick> :information here
612 * @param user The user issuing /INFO
614 virtual void OnInfo(User* user);
616 /** Called whenever a /WHOIS is performed on a local user.
617 * The source parameter contains the details of the user who issued the WHOIS command, and
618 * the dest parameter contains the information of the user they are whoising.
619 * @param source The user issuing the WHOIS command
620 * @param dest The user who is being WHOISed
622 virtual void OnWhois(User* source, User* dest);
624 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
625 * Returning 1 from this function stops the process immediately, causing no
626 * output to be sent to the user by the core. If you do this you must produce your own numerics,
627 * notices etc. This is useful for modules which may want to filter invites to channels.
628 * @param source The user who is issuing the INVITE
629 * @param dest The user being invited
630 * @param channel The channel the user is being invited to
631 * @return 1 to deny the invite, 0 to allow
633 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel);
635 /** Called after a user has been successfully invited to a channel.
636 * You cannot prevent the invite from occuring using this function, to do that,
637 * use OnUserPreInvite instead.
638 * @param source The user who is issuing the INVITE
639 * @param dest The user being invited
640 * @param channel The channel the user is being invited to
642 virtual void OnUserInvite(User* source,User* dest,Channel* channel);
644 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
645 * Returning any nonzero value from this function stops the process immediately, causing no
646 * output to be sent to the user by the core. If you do this you must produce your own numerics,
647 * notices etc. This is useful for modules which may want to filter or redirect messages.
648 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
649 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
650 * of where the message is destined to be sent.
651 * @param user The user sending the message
652 * @param dest The target of the message (Channel* or User*)
653 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
654 * @param text Changeable text being sent by the user
655 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
656 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
657 * It will be ignored for private messages.
658 * @return 1 to deny the NOTICE, 0 to allow it
660 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
662 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
663 * Returning any nonzero value from this function stops the process immediately, causing no
664 * output to be sent to the user by the core. If you do this you must produce your own numerics,
665 * notices etc. This is useful for modules which may want to filter or redirect messages.
666 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
667 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
668 * of where the message is destined to be sent.
669 * You may alter the message text as you wish before relinquishing control to the next module
670 * in the chain, and if no other modules block the text this altered form of the text will be sent out
671 * to the user and possibly to other servers.
672 * @param user The user sending the message
673 * @param dest The target of the message (Channel* or User*)
674 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
675 * @param text Changeable text being sent by the user
676 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
677 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
678 * It will be ignored for private notices.
679 * @return 1 to deny the NOTICE, 0 to allow it
681 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
683 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
684 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
685 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
686 * @param chan The channel to build the exempt list of
687 * @param sender The original sender of the PRIVMSG or NOTICE
688 * @param status The status char to be used for the channel list
689 * @param exempt_list The exempt list to be populated
690 * @param text The original message text causing the exempt list to be built
692 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
694 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
695 * Please note that although you can see remote nickchanges through this function, you should
696 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
697 * check user->server before taking any action (including returning nonzero from the method).
698 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
699 * module to generate some meaninful output.
700 * @param user The username changing their nick
701 * @param newnick Their new nickname
702 * @return 1 to deny the change, 0 to allow
704 virtual int OnUserPreNick(User* user, const std::string &newnick);
706 /** Called after any PRIVMSG sent from a user.
707 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
708 * if target_type is TYPE_CHANNEL.
709 * @param user The user sending the message
710 * @param dest The target of the message
711 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
712 * @param text the text being sent by the user
713 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
715 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
717 /** Called after any NOTICE sent from a user.
718 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
719 * if target_type is TYPE_CHANNEL.
720 * @param user The user sending the message
721 * @param dest The target of the message
722 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
723 * @param text the text being sent by the user
724 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
726 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
728 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
729 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
730 * if target_type is TYPE_CHANNEL.
731 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
732 * the message has already been vetted. In the case of the other two methods, a later module may stop your
733 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
734 * @param user The user sending the message
735 * @param dest The target of the message
736 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
737 * @param text the text being sent by the user
738 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
740 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
742 /** Called after every MODE command sent from a user
743 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
744 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
745 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
746 * @param user The user sending the MODEs
747 * @param dest The target of the modes (User* or Channel*)
748 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
749 * @param text The actual modes and their parameters if any
751 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
753 /** Allows modules to alter or create server descriptions
754 * Whenever a module requires a server description, for example for display in
755 * WHOIS, this function is called in all modules. You may change or define the
756 * description given in std::string &description. If you do, this description
757 * will be shown in the WHOIS fields.
758 * @param servername The servername being searched for
759 * @param description Alterable server description for this server
761 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
763 /** Allows modules to synchronize data which relates to users during a netburst.
764 * When this function is called, it will be called from the module which implements
765 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
766 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
767 * (see below). This function will be called for every user visible on your side
768 * of the burst, allowing you to for example set modes, etc. Do not use this call to
769 * synchronize data which you have stored using class Extensible -- There is a specialist
770 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
771 * @param user The user being syncronized
772 * @param proto A pointer to the module handling network protocol
773 * @param opaque An opaque pointer set by the protocol module, should not be modified!
775 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
777 /** Allows modules to synchronize data which relates to channels during a netburst.
778 * When this function is called, it will be called from the module which implements
779 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
780 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
781 * (see below). This function will be called for every user visible on your side
782 * of the burst, allowing you to for example set modes, etc. Do not use this call to
783 * synchronize data which you have stored using class Extensible -- There is a specialist
784 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
786 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
788 * @param chan The channel being syncronized
789 * @param proto A pointer to the module handling network protocol
790 * @param opaque An opaque pointer set by the protocol module, should not be modified!
792 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
794 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
795 * Whenever the linking module wants to send out data, but doesnt know what the data
796 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
797 * this method is called.You should use the ProtoSendMetaData function after you've
798 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
799 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
800 * @param chan The channel whos metadata is being syncronized
801 * @param proto A pointer to the module handling network protocol
802 * @param opaque An opaque pointer set by the protocol module, should not be modified!
803 * @param extname The extensions name which is being searched for
804 * @param displayable If this value is true, the data is going to be displayed to a user,
805 * and not sent across the network. Use this to determine wether or not to show sensitive data.
807 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
809 /* Allows modules to syncronize metadata related to users over the network during a netburst.
810 * Whenever the linking module wants to send out data, but doesnt know what the data
811 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
812 * this method is called. You should use the ProtoSendMetaData function after you've
813 * correctly decided how the data should be represented, to send the metadata on its way if
814 * if it belongs to your module.
815 * @param user The user whos metadata is being syncronized
816 * @param proto A pointer to the module handling network protocol
817 * @param opaque An opaque pointer set by the protocol module, should not be modified!
818 * @param extname The extensions name which is being searched for
819 * @param displayable If this value is true, the data is going to be displayed to a user,
820 * and not sent across the network. Use this to determine wether or not to show sensitive data.
822 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
824 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
825 * Whenever the linking module wants to send out data, but doesnt know what the data
826 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
827 * this method is called. You should use the ProtoSendMetaData function after you've
828 * correctly decided how the data should be represented, to send the metadata on its way if
829 * if it belongs to your module.
830 * @param proto A pointer to the module handling network protocol
831 * @param opaque An opaque pointer set by the protocol module, should not be modified!
832 * @param displayable If this value is true, the data is going to be displayed to a user,
833 * and not sent across the network. Use this to determine wether or not to show sensitive data.
835 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
837 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
838 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
839 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
840 * @param target The Channel* or User* that data should be added to
841 * @param extname The extension name which is being sent
842 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
844 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
846 /** Implemented by modules which provide the ability to link servers.
847 * These modules will implement this method, which allows transparent sending of servermodes
848 * down the network link as a broadcast, without a module calling it having to know the format
849 * of the MODE command before the actual mode string.
851 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
852 * of how to use this function.
854 * @param opaque An opaque pointer set by the protocol module, should not be modified!
855 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
856 * @param target The Channel* or User* that modes should be sent for
857 * @param modeline The modes and parameters to be sent
859 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
861 /** Implemented by modules which provide the ability to link servers.
862 * These modules will implement this method, which allows metadata (extra data added to
863 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
864 * to other servers on a netburst and decoded at the other end by the same module on a
867 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
868 * how to use this function.
869 * @param opaque An opaque pointer set by the protocol module, should not be modified!
870 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
871 * @param target The Channel* or User* that metadata should be sent for
872 * @param extname The extension name to send metadata for
873 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
875 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
877 /** Called after every WALLOPS command.
878 * @param user The user sending the WALLOPS
879 * @param text The content of the WALLOPS message
881 virtual void OnWallops(User* user, const std::string &text);
883 /** Called whenever a user's hostname is changed.
884 * This event triggers after the host has been set.
885 * @param user The user whos host is being changed
886 * @param newhost The new hostname being set
888 virtual void OnChangeHost(User* user, const std::string &newhost);
890 /** Called whenever a user's GECOS (realname) is changed.
891 * This event triggers after the name has been set.
892 * @param user The user who's GECOS is being changed
893 * @param gecos The new GECOS being set on the user
895 virtual void OnChangeName(User* user, const std::string &gecos);
897 /** Called whenever an xline is added by a local user.
898 * This method is triggered after the line is added.
899 * @param source The sender of the line or NULL for local server
900 * @param line The xline being added
902 virtual void OnAddLine(User* source, XLine* line);
904 /** Called whenever an xline is deleted.
905 * This method is triggered after the line is deleted.
906 * @param source The user removing the line or NULL for local server
907 * @param line the line being deleted
909 virtual void OnDelLine(User* source, XLine* line);
911 /** Called whenever a zline is deleted.
912 * This method is triggered after the line is deleted.
913 * @param source The user removing the line
914 * @param hostmask The hostmask to delete
917 /** Called before your module is unloaded to clean up Extensibles.
918 * This method is called once for every user and channel on the network,
919 * so that when your module unloads it may clear up any remaining data
920 * in the form of Extensibles added using Extensible::Extend().
921 * If the target_type variable is TYPE_USER, then void* item refers to
922 * a User*, otherwise it refers to a Channel*.
923 * @param target_type The type of item being cleaned
924 * @param item A pointer to the item's class
926 virtual void OnCleanup(int target_type, void* item);
928 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
929 * have been applied. Please note that although you can see remote nickchanges through this function, you should
930 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
931 * check user->server before taking any action (including returning nonzero from the method).
932 * Because this method is called after the nickchange is taken place, no return values are possible
933 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
934 * @param user The user changing their nick
935 * @param oldnick The old nickname of the user before the nickchange
937 virtual void OnUserPostNick(User* user, const std::string &oldnick);
939 /** Called before an action which requires a channel privilage check.
940 * This function is called before many functions which check a users status on a channel, for example
941 * before opping a user, deopping a user, kicking a user, etc.
942 * There are several values for access_type which indicate for what reason access is being checked.
944 * AC_KICK (0) - A user is being kicked<br>
945 * AC_DEOP (1) - a user is being deopped<br>
946 * AC_OP (2) - a user is being opped<br>
947 * AC_VOICE (3) - a user is being voiced<br>
948 * AC_DEVOICE (4) - a user is being devoiced<br>
949 * AC_HALFOP (5) - a user is being halfopped<br>
950 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
951 * AC_INVITE () - a user is being invited<br>
952 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
953 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
954 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
955 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
956 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
957 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
958 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
959 * @param source The source of the access check
960 * @param dest The destination of the access check
961 * @param channel The channel which is being checked
962 * @param access_type See above
964 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
966 /** Called when a 005 numeric is about to be output.
967 * The module should modify the 005 numeric if needed to indicate its features.
968 * @param output The 005 string to be modified if neccessary.
970 virtual void On005Numeric(std::string &output);
972 /** Called when a client is disconnected by KILL.
973 * If a client is killed by a server, e.g. a nickname collision or protocol error,
975 * Return 1 from this function to prevent the kill, and 0 from this function to allow
976 * it as normal. If you prevent the kill no output will be sent to the client, it is
977 * down to your module to generate this information.
978 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
979 * If you do so youre risking race conditions, desyncs and worse!
980 * @param source The user sending the KILL
981 * @param dest The user being killed
982 * @param reason The kill reason
983 * @return 1 to prevent the kill, 0 to allow
985 virtual int OnKill(User* source, User* dest, const std::string &reason);
987 /** Called when an oper wants to disconnect a remote user via KILL
988 * @param source The user sending the KILL
989 * @param dest The user being killed
990 * @param reason The kill reason
992 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
994 /** Called whenever a module is loaded.
995 * mod will contain a pointer to the module, and string will contain its name,
996 * for example m_widgets.so. This function is primary for dependency checking,
997 * your module may decide to enable some extra features if it sees that you have
998 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
999 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1000 * but instead operate under reduced functionality, unless the dependency is
1001 * absolutely neccessary (e.g. a module that extends the features of another
1003 * @param mod A pointer to the new module
1004 * @param name The new module's filename
1006 virtual void OnLoadModule(Module* mod,const std::string &name);
1008 /** Called whenever a module is unloaded.
1009 * mod will contain a pointer to the module, and string will contain its name,
1010 * for example m_widgets.so. This function is primary for dependency checking,
1011 * your module may decide to enable some extra features if it sees that you have
1012 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1013 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1014 * but instead operate under reduced functionality, unless the dependency is
1015 * absolutely neccessary (e.g. a module that extends the features of another
1017 * @param mod Pointer to the module being unloaded (still valid)
1018 * @param name The filename of the module being unloaded
1020 virtual void OnUnloadModule(Module* mod,const std::string &name);
1022 /** Called once every five seconds for background processing.
1023 * This timer can be used to control timed features. Its period is not accurate
1024 * enough to be used as a clock, but it is gauranteed to be called at least once in
1025 * any five second period, directly from the main loop of the server.
1026 * @param curtime The current timer derived from time(2)
1028 virtual void OnBackgroundTimer(time_t curtime);
1030 /** Called whenever any command is about to be executed.
1031 * This event occurs for all registered commands, wether they are registered in the core,
1032 * or another module, and for invalid commands. Invalid commands may only be sent to this
1033 * function when the value of validated is false. By returning 1 from this method you may prevent the
1034 * command being executed. If you do this, no output is created by the core, and it is
1035 * down to your module to produce any output neccessary.
1036 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1037 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1038 * method returns, it will be passed an invalid pointer to the user object and crash!)
1039 * @param command The command being executed
1040 * @param parameters An array of array of characters containing the parameters for the command
1041 * @param pcnt The nuimber of parameters passed to the command
1042 * @param user the user issuing the command
1043 * @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.
1044 * @param original_line The entire original line as passed to the parser from the user
1045 * @return 1 to block the command, 0 to allow
1047 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line);
1049 /** Called after any command has been executed.
1050 * This event occurs for all registered commands, wether they are registered in the core,
1051 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1052 * exist within the command table). The result code returned by the command handler is
1054 * @param command The command being executed
1055 * @param parameters An array of array of characters containing the parameters for the command
1056 * @param pcnt The nuimber of parameters passed to the command
1057 * @param user the user issuing the command
1058 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1059 * @param original_line The entire original line as passed to the parser from the user
1061 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, User *user, CmdResult result, const std::string &original_line);
1063 /** Called to check if a user who is connecting can now be allowed to register
1064 * If any modules return false for this function, the user is held in the waiting
1065 * state until all modules return true. For example a module which implements ident
1066 * lookups will continue to return false for a user until their ident lookup is completed.
1067 * Note that the registration timeout for a user overrides these checks, if the registration
1068 * timeout is reached, the user is disconnected even if modules report that the user is
1069 * not ready to connect.
1070 * @param user The user to check
1071 * @return true to indicate readiness, false if otherwise
1073 virtual bool OnCheckReady(User* user);
1075 /** Called whenever a user is about to register their connection (e.g. before the user
1076 * is sent the MOTD etc). Modules can use this method if they are performing a function
1077 * which must be done before the actual connection is completed (e.g. ident lookups,
1078 * dnsbl lookups, etc).
1079 * Note that you should NOT delete the user record here by causing a disconnection!
1080 * Use OnUserConnect for that instead.
1081 * @param user The user registering
1082 * @return 1 to indicate user quit, 0 to continue
1084 virtual int OnUserRegister(User* user);
1086 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1087 * This method will always be called for each join, wether or not the channel is actually +i, and
1088 * determines the outcome of an if statement around the whole section of invite checking code.
1089 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1090 * @param user The user joining the channel
1091 * @param chan The channel being joined
1092 * @return 1 to explicitly allow the join, 0 to proceed as normal
1094 virtual int OnCheckInvite(User* user, Channel* chan);
1096 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1097 * This method will always be called for each join, wether or not the channel is actually +k, and
1098 * determines the outcome of an if statement around the whole section of key checking code.
1099 * if the user specified no key, the keygiven string will be a valid but empty value.
1100 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1101 * @param user The user joining the channel
1102 * @param chan The channel being joined
1103 * @return 1 to explicitly allow the join, 0 to proceed as normal
1105 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1107 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1108 * This method will always be called for each join, wether or not the channel is actually +l, and
1109 * determines the outcome of an if statement around the whole section of channel limit checking code.
1110 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1111 * @param user The user joining the channel
1112 * @param chan The channel being joined
1113 * @return 1 to explicitly allow the join, 0 to proceed as normal
1115 virtual int OnCheckLimit(User* user, Channel* chan);
1117 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1118 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1119 * determines the outcome of an if statement around the whole section of ban checking code.
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 OnCheckBan(User* user, Channel* chan);
1127 /** Called on all /STATS commands
1128 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1129 * @param symbol the symbol provided to /STATS
1130 * @param user the user issuing the /STATS command
1131 * @param results A string_list to append results into. You should put all your results
1132 * into this string_list, rather than displaying them directly, so that your handler will
1133 * work when remote STATS queries are received.
1134 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1136 virtual int OnStats(char symbol, User* user, string_list &results);
1138 /** Called whenever a change of a local users displayed host is attempted.
1139 * Return 1 to deny the host change, or 0 to allow it.
1140 * @param user The user whos host will be changed
1141 * @param newhost The new hostname
1142 * @return 1 to deny the host change, 0 to allow
1144 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1146 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1147 * return 1 to deny the name change, or 0 to allow it.
1148 * @param user The user whos GECOS will be changed
1149 * @param newhost The new GECOS
1150 * @return 1 to deny the GECOS change, 0 to allow
1152 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1154 /** Called whenever a topic is changed by a local user.
1155 * Return 1 to deny the topic change, or 0 to allow it.
1156 * @param user The user changing the topic
1157 * @param chan The channels who's topic is being changed
1158 * @param topic The actual topic text
1159 * @param 1 to block the topic change, 0 to allow
1161 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1163 /** Called whenever a local topic has been changed.
1164 * To block topic changes you must use OnLocalTopicChange instead.
1165 * @param user The user changing the topic
1166 * @param chan The channels who's topic is being changed
1167 * @param topic The actual topic text
1169 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1171 /** Called whenever an Event class is sent to all module by another module.
1172 * Please see the documentation of Event::Send() for further information. The Event sent can
1173 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1174 * before doing anything to the event data, and you should *not* change the event data in any way!
1175 * @param event The Event class being received
1177 virtual void OnEvent(Event* event);
1179 /** Called whenever a Request class is sent to your module by another module.
1180 * Please see the documentation of Request::Send() for further information. The Request sent
1181 * can always be assumed to be non-NULL, you should not change the request object or its data.
1182 * Your method may return arbitary data in the char* result which the requesting module
1183 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1184 * @param request The Request class being received
1186 virtual char* OnRequest(Request* request);
1188 /** Called whenever an oper password is to be compared to what a user has input.
1189 * The password field (from the config file) is in 'password' and is to be compared against
1190 * 'input'. This method allows for encryption of oper passwords and much more besides.
1191 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1193 * @param password The oper's password
1194 * @param input The password entered
1195 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1196 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1198 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1200 /** Called whenever a user is given usermode +o, anywhere on the network.
1201 * You cannot override this and prevent it from happening as it is already happened and
1202 * such a task must be performed by another server. You can however bounce modes by sending
1203 * servermodes out to reverse mode changes.
1204 * @param user The user who is opering
1206 virtual void OnGlobalOper(User* user);
1208 /** Called after a user has fully connected and all modules have executed OnUserConnect
1209 * This event is informational only. You should not change any user information in this
1210 * event. To do so, use the OnUserConnect method to change the state of local users.
1211 * This is called for both local and remote users.
1212 * @param user The user who is connecting
1214 virtual void OnPostConnect(User* user);
1216 /** Called whenever a ban is added to a channel's list.
1217 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1218 * @param source The user adding the ban
1219 * @param channel The channel the ban is being added to
1220 * @param banmask The ban mask being added
1221 * @return 1 to block the ban, 0 to continue as normal
1223 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1225 /** Called whenever a ban is removed from a channel's list.
1226 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1227 * @param source The user deleting the ban
1228 * @param channel The channel the ban is being deleted from
1229 * @param banmask The ban mask being deleted
1230 * @return 1 to block the unban, 0 to continue as normal
1232 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1234 /** Called immediately after any connection is accepted. This is intended for raw socket
1235 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1236 * no information relating to a user record as the connection has not been assigned yet.
1237 * There are no return values from this call as all modules get an opportunity if required to
1238 * process the connection.
1239 * @param fd The file descriptor returned from accept()
1240 * @param ip The IP address of the connecting user
1241 * @param localport The local port number the user connected to
1243 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1245 /** Called immediately before any write() operation on a user's socket in the core. Because
1246 * this event is a low level event no user information is associated with it. It is intended
1247 * for use by modules which may wrap connections within another API such as SSL for example.
1248 * return a non-zero result if you have handled the write operation, in which case the core
1249 * will not call write().
1250 * @param fd The file descriptor of the socket
1251 * @param buffer A char* buffer being written
1252 * @param Number of characters to write
1253 * @return Number of characters actually written or 0 if you didn't handle the operation
1255 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1257 /** Called immediately before any socket is closed. When this event is called, shutdown()
1258 * has not yet been called on the socket.
1259 * @param fd The file descriptor of the socket prior to close()
1261 virtual void OnRawSocketClose(int fd);
1263 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1265 * @param fd The file descriptor of the socket immediately after connect()
1267 virtual void OnRawSocketConnect(int fd);
1269 /** Called immediately before any read() operation on a client socket in the core.
1270 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1271 * when this event occurs.
1272 * Your event should return 1 if it has handled the reading itself, which prevents the core
1273 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1274 * the value of count. The value of readresult must be identical to an actual result that might
1275 * be returned from the read() system call, for example, number of bytes read upon success,
1276 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1277 * you MUST set readresult.
1278 * @param fd The file descriptor of the socket
1279 * @param buffer A char* buffer being read to
1280 * @param count The size of the buffer
1281 * @param readresult The amount of characters read, or 0
1282 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1284 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1286 /** Called whenever a user sets away.
1287 * This method has no parameter for the away message, as it is available in the
1288 * user record as User::awaymsg.
1289 * @param user The user setting away
1291 virtual void OnSetAway(User* user);
1293 /** Called when a user cancels their away state.
1294 * @param user The user returning from away
1296 virtual void OnCancelAway(User* user);
1298 /** Called whenever a NAMES list is requested.
1299 * You can produce the nameslist yourself, overriding the current list,
1300 * and if you do you must return 1. If you do not handle the names list,
1302 * @param The user requesting the NAMES list
1303 * @param Ptr The channel the NAMES list is requested for
1304 * @param userlist The user list for the channel (you may change this pointer.
1305 * If you want to change the values, take a copy first, and change the copy, then
1306 * point the pointer at your copy)
1307 * @return 1 to prevent the user list being sent to the client, 0 to allow it
1309 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1311 /** Called whenever a line of WHOIS output is sent to a user.
1312 * You may change the numeric and the text of the output by changing
1313 * the values numeric and text, but you cannot change the user the
1314 * numeric is sent to. You may however change the user's User values.
1315 * @param user The user the numeric is being sent to
1316 * @param dest The user being WHOISed
1317 * @param numeric The numeric of the line being sent
1318 * @param text The text of the numeric, including any parameters
1319 * @return nonzero to drop the line completely so that the user does not
1320 * receive it, or zero to allow the line to be sent.
1322 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1324 /** Called at intervals for modules to garbage-collect any hashes etc.
1325 * Certain data types such as hash_map 'leak' buckets, which must be
1326 * tidied up and freed by copying into a new item every so often. This
1327 * method is called when it is time to do that.
1329 virtual void OnGarbageCollect();
1331 /** Called whenever a user's write buffer has been completely sent.
1332 * This is called when the user's write buffer is completely empty, and
1333 * there are no more pending bytes to be written and no pending write events
1334 * in the socket engine's queue. This may be used to refill the buffer with
1335 * data which is being spooled in a controlled manner, e.g. LIST lines.
1336 * @param user The user who's buffer is now empty.
1338 virtual void OnBufferFlushed(User* user);
1342 #define CONF_NO_ERROR 0x000000
1343 #define CONF_NOT_A_NUMBER 0x000010
1344 #define CONF_INT_NEGATIVE 0x000080
1345 #define CONF_VALUE_NOT_FOUND 0x000100
1346 #define CONF_FILE_NOT_FOUND 0x000200
1349 /** Allows reading of values from configuration files
1350 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1351 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1352 * Constructing the class using one parameter allows you to specify a path to your own configuration
1353 * file, otherwise, inspircd.conf is read.
1355 class CoreExport ConfigReader : public classbase
1358 InspIRCd* ServerInstance;
1359 /** The contents of the configuration file
1360 * This protected member should never be accessed by a module (and cannot be accessed unless the
1361 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1362 * (such as comments) stripped from it.
1364 ConfigDataHash* data;
1365 /** Used to store errors
1367 std::ostringstream* errorlog;
1368 /** If we're using our own config data hash or not
1371 /** True if an error occured reading the config file
1379 /** Default constructor.
1380 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1381 * as specified when running ./configure.
1383 ConfigReader(InspIRCd* Instance);
1384 /** Overloaded constructor.
1385 * This constructor initialises the ConfigReader class to read a user-specified config file
1387 ConfigReader(InspIRCd* Instance, const std::string &filename);
1388 /** Default destructor.
1389 * This method destroys the ConfigReader class.
1393 /** Retrieves a value from the config file.
1394 * This method retrieves a value from the config file. Where multiple copies of the tag
1395 * exist in the config file, index indicates which of the values to retrieve.
1397 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1398 /** Retrieves a value from the config file.
1399 * This method retrieves a value from the config file. Where multiple copies of the tag
1400 * exist in the config file, index indicates which of the values to retrieve. If the
1401 * tag is not found the default value is returned instead.
1403 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1405 /** Retrieves a boolean value from the config file.
1406 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1407 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1408 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1410 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1411 /** Retrieves a boolean value from the config file.
1412 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1413 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1414 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1415 * If the tag is not found, the default value is used instead.
1417 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1419 /** Retrieves an integer value from the config file.
1420 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1421 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1422 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1423 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1424 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1425 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1426 * should cast the result to achieve that effect.
1428 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1429 /** Retrieves an integer value from the config file.
1430 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1431 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1432 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1433 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1434 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1435 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1437 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1439 /** Returns the last error to occur.
1440 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1441 * A call to GetError() resets the error flag back to 0.
1444 /** Counts the number of times a given tag appears in the config file.
1445 * This method counts the number of times a tag appears in a config file, for use where
1446 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1447 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1448 * multiple instance tag.
1450 int Enumerate(const std::string &tag);
1451 /** Returns true if a config file is valid.
1452 * This method is partially implemented and will only return false if the config
1453 * file does not exist or could not be opened.
1456 /** Dumps the list of errors in a config file to an output location. If bail is true,
1457 * then the program will abort. If bail is false and user points to a valid user
1458 * record, the error report will be spooled to the given user by means of NOTICE.
1459 * if bool is false AND user is false, the error report will be spooled to all opers
1460 * by means of a NOTICE to all opers.
1462 void DumpErrors(bool bail,User* user);
1464 /** Returns the number of items within a tag.
1465 * For example if the tag was <test tag="blah" data="foo"> then this
1466 * function would return 2. Spaces and newlines both qualify as valid seperators
1469 int EnumerateValues(const std::string &tag, int index);
1474 /** Caches a text file into memory and can be used to retrieve lines from it.
1475 * This class contains methods for read-only manipulation of a text file in memory.
1476 * Either use the constructor type with one parameter to load a file into memory
1477 * at construction, or use the LoadFile method to load a file.
1479 class CoreExport FileReader : public classbase
1481 InspIRCd* ServerInstance;
1482 /** The file contents
1486 /** Content size in bytes
1488 unsigned long contentsize;
1490 /** Calculate content size in bytes
1495 /** Default constructor.
1496 * This method does not load any file into memory, you must use the LoadFile method
1497 * after constructing the class this way.
1499 FileReader(InspIRCd* Instance);
1501 /** Secondary constructor.
1502 * This method initialises the class with a file loaded into it ready for GetLine and
1503 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1506 FileReader(InspIRCd* Instance, const std::string &filename);
1508 /** Default destructor.
1509 * This deletes the memory allocated to the file.
1513 /** Used to load a file.
1514 * This method loads a file into the class ready for GetLine and
1515 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1518 void LoadFile(const std::string &filename);
1520 /** Returns the whole content of the file as std::string
1522 std::string Contents();
1524 /** Returns the entire size of the file as std::string
1526 unsigned long ContentSize();
1528 /** Returns true if the file exists
1529 * This function will return false if the file could not be opened.
1533 /** Retrieve one line from the file.
1534 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1535 * the index was out of bounds, or the line had no data on it.
1537 std::string GetLine(int x);
1539 /** Returns the size of the file in lines.
1540 * This method returns the number of lines in the read file. If it is 0, no lines have been
1541 * read into memory, either because the file is empty or it does not exist, or cannot be
1542 * opened due to permission problems.
1547 /** A DLLFactory (designed to load shared objects) containing a
1548 * handle to a module's init_module() function.
1550 typedef DLLFactory<Module> ircd_module;
1552 /** A list of loaded Modules
1554 typedef std::vector<Module*> ModuleList;
1556 /** A list of loaded module handles (ircd_module)
1558 typedef std::vector<ircd_module*> ModuleHandleList;
1560 typedef std::list<Module*> IntModuleList;
1561 typedef std::vector<IntModuleList> EventHandlerList;
1562 typedef IntModuleList::iterator EventHandlerIter;
1564 /** ModuleManager takes care of all things module-related
1567 class CoreExport ModuleManager : public classbase
1570 /** Holds a string describing the last module error to occur
1572 char MODERR[MAXBUF];
1574 /** The feature names published by various modules
1576 featurelist Features;
1578 /** The interface names published by various modules
1580 interfacelist Interfaces;
1582 /** Total number of modules loaded into the ircd, minus one
1586 /** Our pointer to the main insp instance
1592 EventHandlerList EventHandlers;
1594 /** A list of ircd_module* module handles
1595 * Note that this list is always exactly 255 in size.
1596 * The actual number of loaded modules is available from GetModuleCount()
1598 ModuleHandleList handles;
1600 /** A list of Module* module classes
1601 * Note that this list is always exactly 255 in size.
1602 * The actual number of loaded modules is available from GetModuleCount()
1606 /** Simple, bog-standard, boring constructor.
1608 ModuleManager(InspIRCd* Ins);
1612 /** Attach an event to a module
1613 * @param i Event type to attach
1614 * @param mod Module to attach event to
1615 * @return True if the event was attached
1617 bool Attach(Implementation i, Module* mod);
1619 /** Detatch an event from a module
1620 * @param i Event type to detach
1621 * @param mod Module to detach event from
1622 * @param Detach true if the event was detached
1624 bool Detach(Implementation i, Module* mod);
1626 /** Attach an array of events to a module
1627 * @param i Event types (array) to attach
1628 * @param mod Module to attach events to
1630 void Attach(Implementation* i, Module* mod, size_t sz);
1632 /** Detach all events from a module (used on unload)
1633 * @param mod Module to detach from
1635 void DetachAll(Module* mod);
1637 /** Returns text describing the last module error
1638 * @return The last error message to occur
1640 const char* LastError();
1642 /** Load a given module file
1643 * @param filename The file to load
1644 * @return True if the module was found and loaded
1646 bool Load(const char* filename);
1648 /** Unload a given module file
1649 * @param filename The file to unload
1650 * @return True if the module was unloaded
1652 bool Unload(const char* filename);
1654 /** Called by the InspIRCd constructor to load all modules from the config file.
1658 /** Get the total number of currently loaded modules
1659 * @return The number of loaded modules
1663 return this->ModCount;
1666 /** Find a module by name, and return a Module* to it.
1667 * This is preferred over iterating the module lists yourself.
1668 * @param name The module name to look up
1669 * @return A pointer to the module, or NULL if the module cannot be found
1671 Module* Find(const std::string &name);
1673 /** Remove a module handle pointer
1674 * @param j Index number of the module handle to remove
1675 * @return True if a handle existed at the given index, false otherwise
1677 bool EraseHandle(unsigned int j);
1679 /** Remove a Module pointer
1680 * @param j Index number of the Module to remove
1681 * @return True if a handle existed at the given index, false otherwise
1683 bool EraseModule(unsigned int j);
1685 /** Move a given module to a specific slot in the list
1686 * @param modulename The module name to relocate
1687 * @param slot The slot to move the module into
1689 void MoveTo(std::string modulename,int slot);
1691 /** Moves the given module to the last slot in the list
1692 * @param modulename The module name to relocate
1694 void MoveToLast(std::string modulename);
1696 /** Moves the given module to the first slot in the list
1697 * @param modulename The module name to relocate
1699 void MoveToFirst(std::string modulename);
1701 /** Moves one module to be placed after another in the list
1702 * @param modulename The module name to relocate
1703 * @param after The module name to place the module after
1705 void MoveAfter(std::string modulename, std::string after);
1707 /** Moves one module to be placed before another in the list
1708 * @param modulename The module name to relocate
1709 * @param after The module name to place the module before
1711 void MoveBefore(std::string modulename, std::string before);
1713 /** For use with Module::Prioritize().
1714 * When the return value of this function is returned from
1715 * Module::Prioritize(), this specifies that the module wishes
1716 * to be ordered exactly BEFORE 'modulename'. For more information
1717 * please see Module::Prioritize().
1718 * @param modulename The module your module wants to be before in the call list
1719 * @returns a priority ID which the core uses to relocate the module in the list
1721 long PriorityBefore(const std::string &modulename);
1723 /** For use with Module::Prioritize().
1724 * When the return value of this function is returned from
1725 * Module::Prioritize(), this specifies that the module wishes
1726 * to be ordered exactly AFTER 'modulename'. For more information please
1727 * see Module::Prioritize().
1728 * @param modulename The module your module wants to be after in the call list
1729 * @returns a priority ID which the core uses to relocate the module in the list
1731 long PriorityAfter(const std::string &modulename);
1733 /** Publish a 'feature'.
1734 * There are two ways for a module to find another module it depends on.
1735 * Either by name, using InspIRCd::FindModule, or by feature, using this
1736 * function. A feature is an arbitary string which identifies something this
1737 * module can do. For example, if your module provides SSL support, but other
1738 * modules provide SSL support too, all the modules supporting SSL should
1739 * publish an identical 'SSL' feature. This way, any module requiring use
1740 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1741 * then use the module pointer they are given.
1742 * @param FeatureName The case sensitive feature name to make available
1743 * @param Mod a pointer to your module class
1744 * @returns True on success, false if the feature is already published by
1747 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1749 /** Publish a module to an 'interface'.
1750 * Modules which implement the same interface (the same way of communicating
1751 * with other modules) can publish themselves to an interface, using this
1752 * method. When they do so, they become part of a list of related or
1753 * compatible modules, and a third module may then query for that list
1754 * and know that all modules within that list offer the same API.
1755 * A prime example of this is the hashing modules, which all accept the
1756 * same types of Request class. Consider this to be similar to PublishFeature,
1757 * except for that multiple modules may publish the same 'feature'.
1758 * @param InterfaceName The case sensitive interface name to make available
1759 * @param Mod a pointer to your module class
1760 * @returns True on success, false on failure (there are currently no failure
1763 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1765 /** Return a pair saying how many other modules are currently using the
1766 * interfaces provided by module m.
1767 * @param m The module to count usage for
1768 * @return A pair, where the first value is the number of uses of the interface,
1769 * and the second value is the interface name being used.
1771 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1773 /** Mark your module as using an interface.
1774 * If you mark your module as using an interface, then that interface
1775 * module may not unload until your module has unloaded first.
1776 * This can be used to prevent crashes by ensuring code you depend on
1777 * is always in memory while your module is active.
1778 * @param InterfaceName The interface to use
1780 void UseInterface(const std::string &InterfaceName);
1782 /** Mark your module as finished with an interface.
1783 * If you used UseInterface() above, you should use this method when
1784 * your module is finished with the interface (usually in its destructor)
1785 * to allow the modules which implement the given interface to be unloaded.
1786 * @param InterfaceName The interface you are finished with using.
1788 void DoneWithInterface(const std::string &InterfaceName);
1790 /** Unpublish a 'feature'.
1791 * When your module exits, it must call this method for every feature it
1792 * is providing so that the feature table is cleaned up.
1793 * @param FeatureName the feature to remove
1795 bool UnpublishFeature(const std::string &FeatureName);
1797 /** Unpublish your module from an interface
1798 * When your module exits, it must call this method for every interface
1799 * it is part of so that the interfaces table is cleaned up. Only when
1800 * the last item is deleted from an interface does the interface get
1802 * @param InterfaceName the interface to be removed from
1803 * @param Mod The module to remove from the interface list
1805 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1807 /** Find a 'feature'.
1808 * There are two ways for a module to find another module it depends on.
1809 * Either by name, using InspIRCd::FindModule, or by feature, using the
1810 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1811 * identifies something this module can do. For example, if your module
1812 * provides SSL support, but other modules provide SSL support too, all
1813 * the modules supporting SSL should publish an identical 'SSL' feature.
1814 * To find a module capable of providing the feature you want, simply
1815 * call this method with the feature name you are looking for.
1816 * @param FeatureName The feature name you wish to obtain the module for
1817 * @returns A pointer to a valid module class on success, NULL on failure.
1819 Module* FindFeature(const std::string &FeatureName);
1821 /** Find an 'interface'.
1822 * An interface is a list of modules which all implement the same API.
1823 * @param InterfaceName The Interface you wish to obtain the module
1825 * @return A pointer to a deque of Module*, or NULL if the interface
1828 modulelist* FindInterface(const std::string &InterfaceName);
1830 /** Given a pointer to a Module, return its filename
1831 * @param m The module pointer to identify
1832 * @return The module name or an empty string
1834 const std::string& GetModuleName(Module* m);
1837 /** This definition is used as shorthand for the various classes
1838 * and functions needed to make a module loadable by the OS.
1839 * It defines the class factory and external init_module function.
1841 #define MODULE_INIT(y) \
1842 extern "C" DllExport Module * init_module(InspIRCd* Me) \