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) \
127 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ++_i) \
133 catch (CoreException& modexcept) \
135 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
140 * This #define allows us to call a method in all
141 * loaded modules in a readable simple way and pass
142 * an instance pointer to the macro. e.g.:
143 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
145 #define FOREACH_MOD_I(z,y,x) \
146 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ++_i) \
152 catch (CoreException& modexcept) \
154 z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
159 * This define is similar to the one above but returns a result in MOD_RESULT.
160 * The first module to return a nonzero result is the value to be accepted,
161 * and any modules after are ignored.
163 #define FOREACH_RESULT(y,x) \
166 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ++_i) \
170 int res = (*_i)->x ; \
176 catch (CoreException& modexcept) \
178 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
185 * This define is similar to the one above but returns a result in MOD_RESULT.
186 * The first module to return a nonzero result is the value to be accepted,
187 * and any modules after are ignored.
189 #define FOREACH_RESULT_I(z,y,x) \
192 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ++_i) \
196 int res = (*_i)->x ; \
202 catch (CoreException& modexcept) \
204 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()
374 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
375 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
376 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
377 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
378 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
379 I_OnDelLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
380 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
381 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
382 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
383 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
384 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
385 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
390 /** Base class for all InspIRCd modules
391 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
392 * its methods will be called when irc server events occur. class inherited from module must be
393 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
395 class CoreExport Module : public Extensible
398 /** Creator/owner pointer
400 InspIRCd* ServerInstance;
403 /** Default constructor.
404 * Creates a module class.
405 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
406 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
408 Module(InspIRCd* Me);
410 /** Default destructor.
411 * destroys a module class
415 virtual void Prioritize()
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 /** Called when a user connects.
426 * The details of the connecting user are available to you in the parameter User *user
427 * @param user The user who is connecting
429 virtual void OnUserConnect(User* user);
431 /** Called when a user quits.
432 * The details of the exiting user are available to you in the parameter User *user
433 * This event is only called when the user is fully registered when they quit. To catch
434 * raw disconnections, use the OnUserDisconnect method.
435 * @param user The user who is quitting
436 * @param message The user's quit message (as seen by non-opers)
437 * @param oper_message The user's quit message (as seen by opers)
439 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
441 /** Called whenever a user's socket is closed.
442 * The details of the exiting user are available to you in the parameter User *user
443 * This event is called for all users, registered or not, as a cleanup method for modules
444 * which might assign resources to user, such as dns lookups, objects and sockets.
445 * @param user The user who is disconnecting
447 virtual void OnUserDisconnect(User* user);
449 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
450 * @param chan The channel being deleted
452 virtual void OnChannelDelete(Channel* chan);
454 /** Called when a user joins a channel.
455 * The details of the joining user are available to you in the parameter User *user,
456 * and the details of the channel they have joined is available in the variable Channel *channel
457 * @param user The user who is joining
458 * @param channel The channel being joined
459 * @param silent Change this to true if you want to conceal the JOIN command from the other users
460 * of the channel (useful for modules such as auditorium)
462 virtual void OnUserJoin(User* user, Channel* channel, bool &silent);
464 /** Called after a user joins a channel
465 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
467 * @param user The user who is joining
468 * @param channel The channel being joined
470 virtual void OnPostJoin(User* user, Channel* channel);
472 /** Called when a user parts a channel.
473 * The details of the leaving user are available to you in the parameter User *user,
474 * and the details of the channel they have left is available in the variable Channel *channel
475 * @param user The user who is parting
476 * @param channel The channel being parted
477 * @param partmessage The part message, or an empty string
478 * @param silent Change this to true if you want to conceal the PART command from the other users
479 * of the channel (useful for modules such as auditorium)
481 virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
483 /** Called on rehash.
484 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
485 * system. You should use it to reload any files so that your module keeps in step with the
486 * rest of the application. If a parameter is given, the core has done nothing. The module
487 * receiving the event can decide if this parameter has any relevence to it.
488 * @param user The user performing the rehash, if any -- if this is server initiated, the
489 * value of this variable will be NULL.
490 * @param parameter The (optional) parameter given to REHASH from the user.
492 virtual void OnRehash(User* user, const std::string ¶meter);
494 /** Called when a raw command is transmitted or received.
495 * This method is the lowest level of handler available to a module. It will be called with raw
496 * data which is passing through a connected socket. If you wish, you may munge this data by changing
497 * the string parameter "raw". If you do this, after your function exits it will immediately be
498 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
499 * inbound is set to true) the value of user will be the User of the connection sending the
500 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
501 * @param raw The raw string in RFC1459 format
502 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
503 * @param user The user record sending the text, when inbound == true.
505 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
507 /** Called whenever a user is about to join a channel, before any processing is done.
508 * Returning a value of 1 from this function stops the process immediately, causing no
509 * output to be sent to the user by the core. If you do this you must produce your own numerics,
510 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
511 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
515 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
516 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
517 * processing on the actual channel record at this point, however the channel NAME will still be passed in
518 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
519 * @param user The user joining the channel
520 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
521 * @param cname The channel name being joined. For new channels this is valid where chan is not.
522 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
523 * You may alter this string to alter the user's modes on the channel.
524 * @return 1 To prevent the join, 0 to allow it.
526 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs);
528 /** Called whenever a user is about to be kicked.
529 * Returning a value of 1 from this function stops the process immediately, causing no
530 * output to be sent to the user by the core. If you do this you must produce your own numerics,
532 * @param source The user issuing the kick
533 * @param user The user being kicked
534 * @param chan The channel the user is being kicked from
535 * @param reason The kick reason
536 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
538 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
540 /** Called whenever a user is kicked.
541 * If this method is called, the kick is already underway and cannot be prevented, so
542 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
543 * @param source The user issuing the kick
544 * @param user The user being kicked
545 * @param chan The channel the user is being kicked from
546 * @param reason The kick reason
547 * @param silent Change this to true if you want to conceal the PART command from the other users
548 * of the channel (useful for modules such as auditorium)
550 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
552 /** Called whenever a user opers locally.
553 * The User will contain the oper mode 'o' as this function is called after any modifications
554 * are made to the user's structure by the core.
555 * @param user The user who is opering up
556 * @param opertype The opers type name
558 virtual void OnOper(User* user, const std::string &opertype);
560 /** Called after a user opers locally.
561 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
562 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
563 * out the OPERTYPE, etc.
564 * @param user The user who is opering up
565 * @param opertype The opers type name
567 virtual void OnPostOper(User* user, const std::string &opertype);
569 /** Called whenever a user types /INFO.
570 * The User will contain the information of the user who typed the command. Modules may use this
571 * method to output their own credits in /INFO (which is the ircd's version of an about box).
572 * It is purposefully not possible to modify any info that has already been output, or halt the list.
573 * You must write a 371 numeric to the user, containing your info in the following format:
575 * <nick> :information here
577 * @param user The user issuing /INFO
579 virtual void OnInfo(User* user);
581 /** Called whenever a /WHOIS is performed on a local user.
582 * The source parameter contains the details of the user who issued the WHOIS command, and
583 * the dest parameter contains the information of the user they are whoising.
584 * @param source The user issuing the WHOIS command
585 * @param dest The user who is being WHOISed
587 virtual void OnWhois(User* source, User* dest);
589 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
590 * Returning 1 from this function stops the process immediately, causing no
591 * output to be sent to the user by the core. If you do this you must produce your own numerics,
592 * notices etc. This is useful for modules which may want to filter invites to channels.
593 * @param source The user who is issuing the INVITE
594 * @param dest The user being invited
595 * @param channel The channel the user is being invited to
596 * @return 1 to deny the invite, 0 to allow
598 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel);
600 /** Called after a user has been successfully invited to a channel.
601 * You cannot prevent the invite from occuring using this function, to do that,
602 * use OnUserPreInvite instead.
603 * @param source The user who is issuing the INVITE
604 * @param dest The user being invited
605 * @param channel The channel the user is being invited to
607 virtual void OnUserInvite(User* source,User* dest,Channel* channel);
609 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
610 * Returning any nonzero value from this function stops the process immediately, causing no
611 * output to be sent to the user by the core. If you do this you must produce your own numerics,
612 * notices etc. This is useful for modules which may want to filter or redirect messages.
613 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
614 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
615 * of where the message is destined to be sent.
616 * @param user The user sending the message
617 * @param dest The target of the message (Channel* or User*)
618 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
619 * @param text Changeable text being sent by the user
620 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
621 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
622 * It will be ignored for private messages.
623 * @return 1 to deny the NOTICE, 0 to allow it
625 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
627 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
628 * Returning any nonzero value from this function stops the process immediately, causing no
629 * output to be sent to the user by the core. If you do this you must produce your own numerics,
630 * notices etc. This is useful for modules which may want to filter or redirect messages.
631 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
632 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
633 * of where the message is destined to be sent.
634 * You may alter the message text as you wish before relinquishing control to the next module
635 * in the chain, and if no other modules block the text this altered form of the text will be sent out
636 * to the user and possibly to other servers.
637 * @param user The user sending the message
638 * @param dest The target of the message (Channel* or User*)
639 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
640 * @param text Changeable text being sent by the user
641 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
642 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
643 * It will be ignored for private notices.
644 * @return 1 to deny the NOTICE, 0 to allow it
646 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
648 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
649 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
650 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
651 * @param chan The channel to build the exempt list of
652 * @param sender The original sender of the PRIVMSG or NOTICE
653 * @param status The status char to be used for the channel list
654 * @param exempt_list The exempt list to be populated
655 * @param text The original message text causing the exempt list to be built
657 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
659 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
660 * Please note that although you can see remote nickchanges through this function, you should
661 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
662 * check user->server before taking any action (including returning nonzero from the method).
663 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
664 * module to generate some meaninful output.
665 * @param user The username changing their nick
666 * @param newnick Their new nickname
667 * @return 1 to deny the change, 0 to allow
669 virtual int OnUserPreNick(User* user, const std::string &newnick);
671 /** Called after any PRIVMSG sent from a user.
672 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
673 * if target_type is TYPE_CHANNEL.
674 * @param user The user sending the message
675 * @param dest The target of the message
676 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
677 * @param text the text being sent by the user
678 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
680 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
682 /** Called after any NOTICE sent from a user.
683 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
684 * if target_type is TYPE_CHANNEL.
685 * @param user The user sending the message
686 * @param dest The target of the message
687 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
688 * @param text the text being sent by the user
689 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
691 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
693 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
694 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
695 * if target_type is TYPE_CHANNEL.
696 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
697 * the message has already been vetted. In the case of the other two methods, a later module may stop your
698 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
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. NOTICE @#chan has status== '@', 0 to send to everyone.
705 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
707 /** Called after every MODE command sent from a user
708 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
709 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
710 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
711 * @param user The user sending the MODEs
712 * @param dest The target of the modes (User* or Channel*)
713 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
714 * @param text The actual modes and their parameters if any
716 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
718 /** Allows modules to alter or create server descriptions
719 * Whenever a module requires a server description, for example for display in
720 * WHOIS, this function is called in all modules. You may change or define the
721 * description given in std::string &description. If you do, this description
722 * will be shown in the WHOIS fields.
723 * @param servername The servername being searched for
724 * @param description Alterable server description for this server
726 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
728 /** Allows modules to synchronize data which relates to users during a netburst.
729 * When this function is called, it will be called from the module which implements
730 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
731 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
732 * (see below). This function will be called for every user visible on your side
733 * of the burst, allowing you to for example set modes, etc. Do not use this call to
734 * synchronize data which you have stored using class Extensible -- There is a specialist
735 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
736 * @param user The user being syncronized
737 * @param proto A pointer to the module handling network protocol
738 * @param opaque An opaque pointer set by the protocol module, should not be modified!
740 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
742 /** Allows modules to synchronize data which relates to channels during a netburst.
743 * When this function is called, it will be called from the module which implements
744 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
745 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
746 * (see below). This function will be called for every user visible on your side
747 * of the burst, allowing you to for example set modes, etc. Do not use this call to
748 * synchronize data which you have stored using class Extensible -- There is a specialist
749 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
751 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
753 * @param chan The channel being syncronized
754 * @param proto A pointer to the module handling network protocol
755 * @param opaque An opaque pointer set by the protocol module, should not be modified!
757 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
759 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
760 * Whenever the linking module wants to send out data, but doesnt know what the data
761 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
762 * this method is called.You should use the ProtoSendMetaData function after you've
763 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
764 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
765 * @param chan The channel whos metadata is being syncronized
766 * @param proto A pointer to the module handling network protocol
767 * @param opaque An opaque pointer set by the protocol module, should not be modified!
768 * @param extname The extensions name which is being searched for
769 * @param displayable If this value is true, the data is going to be displayed to a user,
770 * and not sent across the network. Use this to determine wether or not to show sensitive data.
772 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
774 /* Allows modules to syncronize metadata related to users over the network during a netburst.
775 * Whenever the linking module wants to send out data, but doesnt know what the data
776 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
777 * this method is called. You should use the ProtoSendMetaData function after you've
778 * correctly decided how the data should be represented, to send the metadata on its way if
779 * if it belongs to your module.
780 * @param user The user whos metadata is being syncronized
781 * @param proto A pointer to the module handling network protocol
782 * @param opaque An opaque pointer set by the protocol module, should not be modified!
783 * @param extname The extensions name which is being searched for
784 * @param displayable If this value is true, the data is going to be displayed to a user,
785 * and not sent across the network. Use this to determine wether or not to show sensitive data.
787 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
789 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
790 * Whenever the linking module wants to send out data, but doesnt know what the data
791 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
792 * this method is called. You should use the ProtoSendMetaData function after you've
793 * correctly decided how the data should be represented, to send the metadata on its way if
794 * if it belongs to your module.
795 * @param proto A pointer to the module handling network protocol
796 * @param opaque An opaque pointer set by the protocol module, should not be modified!
797 * @param displayable If this value is true, the data is going to be displayed to a user,
798 * and not sent across the network. Use this to determine wether or not to show sensitive data.
800 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
802 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
803 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
804 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
805 * @param target The Channel* or User* that data should be added to
806 * @param extname The extension name which is being sent
807 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
809 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
811 /** Implemented by modules which provide the ability to link servers.
812 * These modules will implement this method, which allows transparent sending of servermodes
813 * down the network link as a broadcast, without a module calling it having to know the format
814 * of the MODE command before the actual mode string.
816 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
817 * of how to use this function.
819 * @param opaque An opaque pointer set by the protocol module, should not be modified!
820 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
821 * @param target The Channel* or User* that modes should be sent for
822 * @param modeline The modes and parameters to be sent
824 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
826 /** Implemented by modules which provide the ability to link servers.
827 * These modules will implement this method, which allows metadata (extra data added to
828 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
829 * to other servers on a netburst and decoded at the other end by the same module on a
832 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
833 * how to use this function.
834 * @param opaque An opaque pointer set by the protocol module, should not be modified!
835 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
836 * @param target The Channel* or User* that metadata should be sent for
837 * @param extname The extension name to send metadata for
838 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
840 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
842 /** Called after every WALLOPS command.
843 * @param user The user sending the WALLOPS
844 * @param text The content of the WALLOPS message
846 virtual void OnWallops(User* user, const std::string &text);
848 /** Called whenever a user's hostname is changed.
849 * This event triggers after the host has been set.
850 * @param user The user whos host is being changed
851 * @param newhost The new hostname being set
853 virtual void OnChangeHost(User* user, const std::string &newhost);
855 /** Called whenever a user's GECOS (realname) is changed.
856 * This event triggers after the name has been set.
857 * @param user The user who's GECOS is being changed
858 * @param gecos The new GECOS being set on the user
860 virtual void OnChangeName(User* user, const std::string &gecos);
862 /** Called whenever an xline is added by a local user.
863 * This method is triggered after the line is added.
864 * @param source The sender of the line or NULL for local server
865 * @param line The xline being added
867 virtual void OnAddLine(User* source, XLine* line);
869 /** Called whenever an xline is deleted.
870 * This method is triggered after the line is deleted.
871 * @param source The user removing the line or NULL for local server
872 * @param line the line being deleted
874 virtual void OnDelLine(User* source, XLine* line);
876 /** Called whenever a zline is deleted.
877 * This method is triggered after the line is deleted.
878 * @param source The user removing the line
879 * @param hostmask The hostmask to delete
882 /** Called before your module is unloaded to clean up Extensibles.
883 * This method is called once for every user and channel on the network,
884 * so that when your module unloads it may clear up any remaining data
885 * in the form of Extensibles added using Extensible::Extend().
886 * If the target_type variable is TYPE_USER, then void* item refers to
887 * a User*, otherwise it refers to a Channel*.
888 * @param target_type The type of item being cleaned
889 * @param item A pointer to the item's class
891 virtual void OnCleanup(int target_type, void* item);
893 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
894 * have been applied. Please note that although you can see remote nickchanges through this function, you should
895 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
896 * check user->server before taking any action (including returning nonzero from the method).
897 * Because this method is called after the nickchange is taken place, no return values are possible
898 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
899 * @param user The user changing their nick
900 * @param oldnick The old nickname of the user before the nickchange
902 virtual void OnUserPostNick(User* user, const std::string &oldnick);
904 /** Called before an action which requires a channel privilage check.
905 * This function is called before many functions which check a users status on a channel, for example
906 * before opping a user, deopping a user, kicking a user, etc.
907 * There are several values for access_type which indicate for what reason access is being checked.
909 * AC_KICK (0) - A user is being kicked<br>
910 * AC_DEOP (1) - a user is being deopped<br>
911 * AC_OP (2) - a user is being opped<br>
912 * AC_VOICE (3) - a user is being voiced<br>
913 * AC_DEVOICE (4) - a user is being devoiced<br>
914 * AC_HALFOP (5) - a user is being halfopped<br>
915 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
916 * AC_INVITE () - a user is being invited<br>
917 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
918 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
919 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
920 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
921 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
922 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
923 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
924 * @param source The source of the access check
925 * @param dest The destination of the access check
926 * @param channel The channel which is being checked
927 * @param access_type See above
929 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
931 /** Called when a 005 numeric is about to be output.
932 * The module should modify the 005 numeric if needed to indicate its features.
933 * @param output The 005 string to be modified if neccessary.
935 virtual void On005Numeric(std::string &output);
937 /** Called when a client is disconnected by KILL.
938 * If a client is killed by a server, e.g. a nickname collision or protocol error,
940 * Return 1 from this function to prevent the kill, and 0 from this function to allow
941 * it as normal. If you prevent the kill no output will be sent to the client, it is
942 * down to your module to generate this information.
943 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
944 * If you do so youre risking race conditions, desyncs and worse!
945 * @param source The user sending the KILL
946 * @param dest The user being killed
947 * @param reason The kill reason
948 * @return 1 to prevent the kill, 0 to allow
950 virtual int OnKill(User* source, User* dest, const std::string &reason);
952 /** Called when an oper wants to disconnect a remote user via KILL
953 * @param source The user sending the KILL
954 * @param dest The user being killed
955 * @param reason The kill reason
957 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
959 /** Called whenever a module is loaded.
960 * mod will contain a pointer to the module, and string will contain its name,
961 * for example m_widgets.so. This function is primary for dependency checking,
962 * your module may decide to enable some extra features if it sees that you have
963 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
964 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
965 * but instead operate under reduced functionality, unless the dependency is
966 * absolutely neccessary (e.g. a module that extends the features of another
968 * @param mod A pointer to the new module
969 * @param name The new module's filename
971 virtual void OnLoadModule(Module* mod,const std::string &name);
973 /** Called whenever a module is unloaded.
974 * mod will contain a pointer to the module, and string will contain its name,
975 * for example m_widgets.so. This function is primary for dependency checking,
976 * your module may decide to enable some extra features if it sees that you have
977 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
978 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
979 * but instead operate under reduced functionality, unless the dependency is
980 * absolutely neccessary (e.g. a module that extends the features of another
982 * @param mod Pointer to the module being unloaded (still valid)
983 * @param name The filename of the module being unloaded
985 virtual void OnUnloadModule(Module* mod,const std::string &name);
987 /** Called once every five seconds for background processing.
988 * This timer can be used to control timed features. Its period is not accurate
989 * enough to be used as a clock, but it is gauranteed to be called at least once in
990 * any five second period, directly from the main loop of the server.
991 * @param curtime The current timer derived from time(2)
993 virtual void OnBackgroundTimer(time_t curtime);
995 /** Called whenever any command is about to be executed.
996 * This event occurs for all registered commands, wether they are registered in the core,
997 * or another module, and for invalid commands. Invalid commands may only be sent to this
998 * function when the value of validated is false. By returning 1 from this method you may prevent the
999 * command being executed. If you do this, no output is created by the core, and it is
1000 * down to your module to produce any output neccessary.
1001 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1002 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1003 * method returns, it will be passed an invalid pointer to the user object and crash!)
1004 * @param command The command being executed
1005 * @param parameters An array of array of characters containing the parameters for the command
1006 * @param pcnt The nuimber of parameters passed to the command
1007 * @param user the user issuing the command
1008 * @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.
1009 * @param original_line The entire original line as passed to the parser from the user
1010 * @return 1 to block the command, 0 to allow
1012 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line);
1014 /** Called after any command has been executed.
1015 * This event occurs for all registered commands, wether they are registered in the core,
1016 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1017 * exist within the command table). The result code returned by the command handler is
1019 * @param command The command being executed
1020 * @param parameters An array of array of characters containing the parameters for the command
1021 * @param pcnt The nuimber of parameters passed to the command
1022 * @param user the user issuing the command
1023 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1024 * @param original_line The entire original line as passed to the parser from the user
1026 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, User *user, CmdResult result, const std::string &original_line);
1028 /** Called to check if a user who is connecting can now be allowed to register
1029 * If any modules return false for this function, the user is held in the waiting
1030 * state until all modules return true. For example a module which implements ident
1031 * lookups will continue to return false for a user until their ident lookup is completed.
1032 * Note that the registration timeout for a user overrides these checks, if the registration
1033 * timeout is reached, the user is disconnected even if modules report that the user is
1034 * not ready to connect.
1035 * @param user The user to check
1036 * @return true to indicate readiness, false if otherwise
1038 virtual bool OnCheckReady(User* user);
1040 /** Called whenever a user is about to register their connection (e.g. before the user
1041 * is sent the MOTD etc). Modules can use this method if they are performing a function
1042 * which must be done before the actual connection is completed (e.g. ident lookups,
1043 * dnsbl lookups, etc).
1044 * Note that you should NOT delete the user record here by causing a disconnection!
1045 * Use OnUserConnect for that instead.
1046 * @param user The user registering
1047 * @return 1 to indicate user quit, 0 to continue
1049 virtual int OnUserRegister(User* user);
1051 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1052 * This method will always be called for each join, wether or not the channel is actually +i, and
1053 * determines the outcome of an if statement around the whole section of invite checking code.
1054 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1055 * @param user The user joining the channel
1056 * @param chan The channel being joined
1057 * @return 1 to explicitly allow the join, 0 to proceed as normal
1059 virtual int OnCheckInvite(User* user, Channel* chan);
1061 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1062 * This method will always be called for each join, wether or not the channel is actually +k, and
1063 * determines the outcome of an if statement around the whole section of key checking code.
1064 * if the user specified no key, the keygiven string will be a valid but empty value.
1065 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1066 * @param user The user joining the channel
1067 * @param chan The channel being joined
1068 * @return 1 to explicitly allow the join, 0 to proceed as normal
1070 virtual int OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1072 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1073 * This method will always be called for each join, wether or not the channel is actually +l, and
1074 * determines the outcome of an if statement around the whole section of channel limit checking code.
1075 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1076 * @param user The user joining the channel
1077 * @param chan The channel being joined
1078 * @return 1 to explicitly allow the join, 0 to proceed as normal
1080 virtual int OnCheckLimit(User* user, Channel* chan);
1082 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1083 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1084 * determines the outcome of an if statement around the whole section of ban checking code.
1085 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1086 * @param user The user joining the channel
1087 * @param chan The channel being joined
1088 * @return 1 to explicitly allow the join, 0 to proceed as normal
1090 virtual int OnCheckBan(User* user, Channel* chan);
1092 /** Called on all /STATS commands
1093 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1094 * @param symbol the symbol provided to /STATS
1095 * @param user the user issuing the /STATS command
1096 * @param results A string_list to append results into. You should put all your results
1097 * into this string_list, rather than displaying them directly, so that your handler will
1098 * work when remote STATS queries are received.
1099 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1101 virtual int OnStats(char symbol, User* user, string_list &results);
1103 /** Called whenever a change of a local users displayed host is attempted.
1104 * Return 1 to deny the host change, or 0 to allow it.
1105 * @param user The user whos host will be changed
1106 * @param newhost The new hostname
1107 * @return 1 to deny the host change, 0 to allow
1109 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1111 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1112 * return 1 to deny the name change, or 0 to allow it.
1113 * @param user The user whos GECOS will be changed
1114 * @param newhost The new GECOS
1115 * @return 1 to deny the GECOS change, 0 to allow
1117 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1119 /** Called whenever a topic is changed by a local user.
1120 * Return 1 to deny the topic change, or 0 to allow it.
1121 * @param user The user changing the topic
1122 * @param chan The channels who's topic is being changed
1123 * @param topic The actual topic text
1124 * @param 1 to block the topic change, 0 to allow
1126 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1128 /** Called whenever a local topic has been changed.
1129 * To block topic changes you must use OnLocalTopicChange instead.
1130 * @param user The user changing the topic
1131 * @param chan The channels who's topic is being changed
1132 * @param topic The actual topic text
1134 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1136 /** Called whenever an Event class is sent to all module by another module.
1137 * Please see the documentation of Event::Send() for further information. The Event sent can
1138 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1139 * before doing anything to the event data, and you should *not* change the event data in any way!
1140 * @param event The Event class being received
1142 virtual void OnEvent(Event* event);
1144 /** Called whenever a Request class is sent to your module by another module.
1145 * Please see the documentation of Request::Send() for further information. The Request sent
1146 * can always be assumed to be non-NULL, you should not change the request object or its data.
1147 * Your method may return arbitary data in the char* result which the requesting module
1148 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1149 * @param request The Request class being received
1151 virtual char* OnRequest(Request* request);
1153 /** Called whenever an oper password is to be compared to what a user has input.
1154 * The password field (from the config file) is in 'password' and is to be compared against
1155 * 'input'. This method allows for encryption of oper passwords and much more besides.
1156 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1158 * @param password The oper's password
1159 * @param input The password entered
1160 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1161 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1163 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1165 /** Called whenever a user is given usermode +o, anywhere on the network.
1166 * You cannot override this and prevent it from happening as it is already happened and
1167 * such a task must be performed by another server. You can however bounce modes by sending
1168 * servermodes out to reverse mode changes.
1169 * @param user The user who is opering
1171 virtual void OnGlobalOper(User* user);
1173 /** Called after a user has fully connected and all modules have executed OnUserConnect
1174 * This event is informational only. You should not change any user information in this
1175 * event. To do so, use the OnUserConnect method to change the state of local users.
1176 * This is called for both local and remote users.
1177 * @param user The user who is connecting
1179 virtual void OnPostConnect(User* user);
1181 /** Called whenever a ban is added to a channel's list.
1182 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1183 * @param source The user adding the ban
1184 * @param channel The channel the ban is being added to
1185 * @param banmask The ban mask being added
1186 * @return 1 to block the ban, 0 to continue as normal
1188 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1190 /** Called whenever a ban is removed from a channel's list.
1191 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1192 * @param source The user deleting the ban
1193 * @param channel The channel the ban is being deleted from
1194 * @param banmask The ban mask being deleted
1195 * @return 1 to block the unban, 0 to continue as normal
1197 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1199 /** Called immediately after any connection is accepted. This is intended for raw socket
1200 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1201 * no information relating to a user record as the connection has not been assigned yet.
1202 * There are no return values from this call as all modules get an opportunity if required to
1203 * process the connection.
1204 * @param fd The file descriptor returned from accept()
1205 * @param ip The IP address of the connecting user
1206 * @param localport The local port number the user connected to
1208 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1210 /** Called immediately before any write() operation on a user's socket in the core. Because
1211 * this event is a low level event no user information is associated with it. It is intended
1212 * for use by modules which may wrap connections within another API such as SSL for example.
1213 * return a non-zero result if you have handled the write operation, in which case the core
1214 * will not call write().
1215 * @param fd The file descriptor of the socket
1216 * @param buffer A char* buffer being written
1217 * @param Number of characters to write
1218 * @return Number of characters actually written or 0 if you didn't handle the operation
1220 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1222 /** Called immediately before any socket is closed. When this event is called, shutdown()
1223 * has not yet been called on the socket.
1224 * @param fd The file descriptor of the socket prior to close()
1226 virtual void OnRawSocketClose(int fd);
1228 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1230 * @param fd The file descriptor of the socket immediately after connect()
1232 virtual void OnRawSocketConnect(int fd);
1234 /** Called immediately before any read() operation on a client socket in the core.
1235 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1236 * when this event occurs.
1237 * Your event should return 1 if it has handled the reading itself, which prevents the core
1238 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1239 * the value of count. The value of readresult must be identical to an actual result that might
1240 * be returned from the read() system call, for example, number of bytes read upon success,
1241 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1242 * you MUST set readresult.
1243 * @param fd The file descriptor of the socket
1244 * @param buffer A char* buffer being read to
1245 * @param count The size of the buffer
1246 * @param readresult The amount of characters read, or 0
1247 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1249 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1251 /** Called whenever a user sets away.
1252 * This method has no parameter for the away message, as it is available in the
1253 * user record as User::awaymsg.
1254 * @param user The user setting away
1256 virtual void OnSetAway(User* user);
1258 /** Called when a user cancels their away state.
1259 * @param user The user returning from away
1261 virtual void OnCancelAway(User* user);
1263 /** Called whenever a NAMES list is requested.
1264 * You can produce the nameslist yourself, overriding the current list,
1265 * and if you do you must return 1. If you do not handle the names list,
1267 * @param The user requesting the NAMES list
1268 * @param Ptr The channel the NAMES list is requested for
1269 * @param userlist The user list for the channel (you may change this pointer.
1270 * If you want to change the values, take a copy first, and change the copy, then
1271 * point the pointer at your copy)
1272 * @return 1 to prevent the user list being sent to the client, 0 to allow it
1274 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1276 /** Called whenever a line of WHOIS output is sent to a user.
1277 * You may change the numeric and the text of the output by changing
1278 * the values numeric and text, but you cannot change the user the
1279 * numeric is sent to. You may however change the user's User values.
1280 * @param user The user the numeric is being sent to
1281 * @param dest The user being WHOISed
1282 * @param numeric The numeric of the line being sent
1283 * @param text The text of the numeric, including any parameters
1284 * @return nonzero to drop the line completely so that the user does not
1285 * receive it, or zero to allow the line to be sent.
1287 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1289 /** Called at intervals for modules to garbage-collect any hashes etc.
1290 * Certain data types such as hash_map 'leak' buckets, which must be
1291 * tidied up and freed by copying into a new item every so often. This
1292 * method is called when it is time to do that.
1294 virtual void OnGarbageCollect();
1296 /** Called whenever a user's write buffer has been completely sent.
1297 * This is called when the user's write buffer is completely empty, and
1298 * there are no more pending bytes to be written and no pending write events
1299 * in the socket engine's queue. This may be used to refill the buffer with
1300 * data which is being spooled in a controlled manner, e.g. LIST lines.
1301 * @param user The user who's buffer is now empty.
1303 virtual void OnBufferFlushed(User* user);
1307 #define CONF_NO_ERROR 0x000000
1308 #define CONF_NOT_A_NUMBER 0x000010
1309 #define CONF_INT_NEGATIVE 0x000080
1310 #define CONF_VALUE_NOT_FOUND 0x000100
1311 #define CONF_FILE_NOT_FOUND 0x000200
1314 /** Allows reading of values from configuration files
1315 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1316 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1317 * Constructing the class using one parameter allows you to specify a path to your own configuration
1318 * file, otherwise, inspircd.conf is read.
1320 class CoreExport ConfigReader : public classbase
1323 InspIRCd* ServerInstance;
1324 /** The contents of the configuration file
1325 * This protected member should never be accessed by a module (and cannot be accessed unless the
1326 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1327 * (such as comments) stripped from it.
1329 ConfigDataHash* data;
1330 /** Used to store errors
1332 std::ostringstream* errorlog;
1333 /** If we're using our own config data hash or not
1336 /** True if an error occured reading the config file
1344 /** Default constructor.
1345 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1346 * as specified when running ./configure.
1348 ConfigReader(InspIRCd* Instance);
1349 /** Overloaded constructor.
1350 * This constructor initialises the ConfigReader class to read a user-specified config file
1352 ConfigReader(InspIRCd* Instance, const std::string &filename);
1353 /** Default destructor.
1354 * This method destroys the ConfigReader class.
1358 /** Retrieves a value from the config file.
1359 * This method retrieves a value from the config file. Where multiple copies of the tag
1360 * exist in the config file, index indicates which of the values to retrieve.
1362 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1363 /** Retrieves a value from the config file.
1364 * This method retrieves a value from the config file. Where multiple copies of the tag
1365 * exist in the config file, index indicates which of the values to retrieve. If the
1366 * tag is not found the default value is returned instead.
1368 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1370 /** Retrieves a boolean value from the config file.
1371 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1372 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1373 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1375 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1376 /** Retrieves a boolean value from the config file.
1377 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1378 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1379 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1380 * If the tag is not found, the default value is used instead.
1382 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1384 /** Retrieves an integer value from the config file.
1385 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1386 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1387 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1388 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1389 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1390 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1391 * should cast the result to achieve that effect.
1393 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1394 /** Retrieves an integer value from the config file.
1395 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1396 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1397 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1398 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1399 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1400 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1402 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1404 /** Returns the last error to occur.
1405 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1406 * A call to GetError() resets the error flag back to 0.
1409 /** Counts the number of times a given tag appears in the config file.
1410 * This method counts the number of times a tag appears in a config file, for use where
1411 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1412 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1413 * multiple instance tag.
1415 int Enumerate(const std::string &tag);
1416 /** Returns true if a config file is valid.
1417 * This method is partially implemented and will only return false if the config
1418 * file does not exist or could not be opened.
1421 /** Dumps the list of errors in a config file to an output location. If bail is true,
1422 * then the program will abort. If bail is false and user points to a valid user
1423 * record, the error report will be spooled to the given user by means of NOTICE.
1424 * if bool is false AND user is false, the error report will be spooled to all opers
1425 * by means of a NOTICE to all opers.
1427 void DumpErrors(bool bail,User* user);
1429 /** Returns the number of items within a tag.
1430 * For example if the tag was <test tag="blah" data="foo"> then this
1431 * function would return 2. Spaces and newlines both qualify as valid seperators
1434 int EnumerateValues(const std::string &tag, int index);
1439 /** Caches a text file into memory and can be used to retrieve lines from it.
1440 * This class contains methods for read-only manipulation of a text file in memory.
1441 * Either use the constructor type with one parameter to load a file into memory
1442 * at construction, or use the LoadFile method to load a file.
1444 class CoreExport FileReader : public classbase
1446 InspIRCd* ServerInstance;
1447 /** The file contents
1451 /** Content size in bytes
1453 unsigned long contentsize;
1455 /** Calculate content size in bytes
1460 /** Default constructor.
1461 * This method does not load any file into memory, you must use the LoadFile method
1462 * after constructing the class this way.
1464 FileReader(InspIRCd* Instance);
1466 /** Secondary constructor.
1467 * This method initialises the class with a file loaded into it ready for GetLine and
1468 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1471 FileReader(InspIRCd* Instance, const std::string &filename);
1473 /** Default destructor.
1474 * This deletes the memory allocated to the file.
1478 /** Used to load a file.
1479 * This method loads a file into the class ready for GetLine and
1480 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1483 void LoadFile(const std::string &filename);
1485 /** Returns the whole content of the file as std::string
1487 std::string Contents();
1489 /** Returns the entire size of the file as std::string
1491 unsigned long ContentSize();
1493 /** Returns true if the file exists
1494 * This function will return false if the file could not be opened.
1498 /** Retrieve one line from the file.
1499 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1500 * the index was out of bounds, or the line had no data on it.
1502 std::string GetLine(int x);
1504 /** Returns the size of the file in lines.
1505 * This method returns the number of lines in the read file. If it is 0, no lines have been
1506 * read into memory, either because the file is empty or it does not exist, or cannot be
1507 * opened due to permission problems.
1512 /** A DLLFactory (designed to load shared objects) containing a
1513 * handle to a module's init_module() function. Unfortunately,
1514 * due to the design of shared object systems we must keep this
1515 * hanging around, as if we remove this handle, we remove the
1516 * shared object file from memory (!)
1518 typedef DLLFactory<Module> ircd_module;
1520 /** A list of modules
1522 typedef std::vector<Module*> IntModuleList;
1524 /** A list of event handlers
1526 typedef std::vector<IntModuleList> EventHandlerList;
1528 /** An event handler iterator
1530 typedef IntModuleList::iterator EventHandlerIter;
1532 /** Module priority states
1543 /** ModuleManager takes care of all things module-related
1546 class CoreExport ModuleManager : public classbase
1549 /** Holds a string describing the last module error to occur
1551 char MODERR[MAXBUF];
1553 /** The feature names published by various modules
1555 featurelist Features;
1557 /** The interface names published by various modules
1559 interfacelist Interfaces;
1561 /** Total number of modules loaded into the ircd, minus one
1565 /** Our pointer to the main insp instance
1569 /** List of loaded modules and shared object/dll handles
1570 * keyed by module name
1572 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1576 /** Event handler hooks.
1577 * This needs to be public to be used by FOREACH_MOD and friends.
1579 EventHandlerList EventHandlers;
1581 /** Simple, bog-standard, boring constructor.
1583 ModuleManager(InspIRCd* Ins);
1589 /** Change the priority of one event in a module.
1590 * Each module event has a list of modules which are attached to that event type.
1591 * If you wish to be called before or after other specific modules, you may use this
1592 * method (usually within void Module::Prioritize()) to set your events priority.
1593 * You may use this call in other methods too, however, this is not supported behaviour
1595 * @param mod The module to change the priority of
1596 * @param i The event to change the priority of
1597 * @param s The state you wish to use for this event. Use one of
1598 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1599 * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
1600 * to set it to be before or after one or more other modules.
1601 * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
1602 * then this contains a list of one or more modules your module must be
1603 * placed before or after. Your module will be placed before the highest
1604 * priority module in this list for PRIO_BEFORE, or after the lowest
1605 * priority module in this list for PRIO_AFTER.
1606 * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
1607 * Defaults to 1, as most of the time you will only want to prioritize your module
1608 * to be before or after one other module.
1610 bool SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules = NULL, size_t sz = 1);
1612 /** Change the priority of all events in a module.
1613 * @param mod The module to set the priority of
1614 * @param s The priority of all events in the module.
1615 * Note that with this method, it is not possible to effectively use
1616 * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
1617 * SetPriority method for this, where you may specify other modules to
1618 * be prioritized against.
1620 bool SetPriority(Module* mod, PriorityState s);
1622 /** Attach an event to a module.
1623 * You may later detatch the event with ModuleManager::Detach().
1624 * If your module is unloaded, all events are automatically detatched.
1625 * @param i Event type to attach
1626 * @param mod Module to attach event to
1627 * @return True if the event was attached
1629 bool Attach(Implementation i, Module* mod);
1631 /** Detatch an event from a module.
1632 * This is not required when your module unloads, as the core will
1633 * automatically detatch your module from all events it is attached to.
1634 * @param i Event type to detach
1635 * @param mod Module to detach event from
1636 * @param Detach true if the event was detached
1638 bool Detach(Implementation i, Module* mod);
1640 /** Attach an array of events to a module
1641 * @param i Event types (array) to attach
1642 * @param mod Module to attach events to
1644 void Attach(Implementation* i, Module* mod, size_t sz);
1646 /** Detach all events from a module (used on unload)
1647 * @param mod Module to detach from
1649 void DetachAll(Module* mod);
1651 /** Returns text describing the last module error
1652 * @return The last error message to occur
1654 const char* LastError();
1656 /** Load a given module file
1657 * @param filename The file to load
1658 * @return True if the module was found and loaded
1660 bool Load(const char* filename);
1662 /** Unload a given module file
1663 * @param filename The file to unload
1664 * @return True if the module was unloaded
1666 bool Unload(const char* filename);
1668 /** Called by the InspIRCd constructor to load all modules from the config file.
1672 /** Get the total number of currently loaded modules
1673 * @return The number of loaded modules
1677 return this->ModCount;
1680 /** Find a module by name, and return a Module* to it.
1681 * This is preferred over iterating the module lists yourself.
1682 * @param name The module name to look up
1683 * @return A pointer to the module, or NULL if the module cannot be found
1685 Module* Find(const std::string &name);
1687 /** Publish a 'feature'.
1688 * There are two ways for a module to find another module it depends on.
1689 * Either by name, using InspIRCd::FindModule, or by feature, using this
1690 * function. A feature is an arbitary string which identifies something this
1691 * module can do. For example, if your module provides SSL support, but other
1692 * modules provide SSL support too, all the modules supporting SSL should
1693 * publish an identical 'SSL' feature. This way, any module requiring use
1694 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1695 * then use the module pointer they are given.
1696 * @param FeatureName The case sensitive feature name to make available
1697 * @param Mod a pointer to your module class
1698 * @returns True on success, false if the feature is already published by
1701 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1703 /** Publish a module to an 'interface'.
1704 * Modules which implement the same interface (the same way of communicating
1705 * with other modules) can publish themselves to an interface, using this
1706 * method. When they do so, they become part of a list of related or
1707 * compatible modules, and a third module may then query for that list
1708 * and know that all modules within that list offer the same API.
1709 * A prime example of this is the hashing modules, which all accept the
1710 * same types of Request class. Consider this to be similar to PublishFeature,
1711 * except for that multiple modules may publish the same 'feature'.
1712 * @param InterfaceName The case sensitive interface name to make available
1713 * @param Mod a pointer to your module class
1714 * @returns True on success, false on failure (there are currently no failure
1717 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1719 /** Return a pair saying how many other modules are currently using the
1720 * interfaces provided by module m.
1721 * @param m The module to count usage for
1722 * @return A pair, where the first value is the number of uses of the interface,
1723 * and the second value is the interface name being used.
1725 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1727 /** Mark your module as using an interface.
1728 * If you mark your module as using an interface, then that interface
1729 * module may not unload until your module has unloaded first.
1730 * This can be used to prevent crashes by ensuring code you depend on
1731 * is always in memory while your module is active.
1732 * @param InterfaceName The interface to use
1734 void UseInterface(const std::string &InterfaceName);
1736 /** Mark your module as finished with an interface.
1737 * If you used UseInterface() above, you should use this method when
1738 * your module is finished with the interface (usually in its destructor)
1739 * to allow the modules which implement the given interface to be unloaded.
1740 * @param InterfaceName The interface you are finished with using.
1742 void DoneWithInterface(const std::string &InterfaceName);
1744 /** Unpublish a 'feature'.
1745 * When your module exits, it must call this method for every feature it
1746 * is providing so that the feature table is cleaned up.
1747 * @param FeatureName the feature to remove
1749 bool UnpublishFeature(const std::string &FeatureName);
1751 /** Unpublish your module from an interface
1752 * When your module exits, it must call this method for every interface
1753 * it is part of so that the interfaces table is cleaned up. Only when
1754 * the last item is deleted from an interface does the interface get
1756 * @param InterfaceName the interface to be removed from
1757 * @param Mod The module to remove from the interface list
1759 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1761 /** Find a 'feature'.
1762 * There are two ways for a module to find another module it depends on.
1763 * Either by name, using InspIRCd::FindModule, or by feature, using the
1764 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1765 * identifies something this module can do. For example, if your module
1766 * provides SSL support, but other modules provide SSL support too, all
1767 * the modules supporting SSL should publish an identical 'SSL' feature.
1768 * To find a module capable of providing the feature you want, simply
1769 * call this method with the feature name you are looking for.
1770 * @param FeatureName The feature name you wish to obtain the module for
1771 * @returns A pointer to a valid module class on success, NULL on failure.
1773 Module* FindFeature(const std::string &FeatureName);
1775 /** Find an 'interface'.
1776 * An interface is a list of modules which all implement the same API.
1777 * @param InterfaceName The Interface you wish to obtain the module
1779 * @return A pointer to a deque of Module*, or NULL if the interface
1782 modulelist* FindInterface(const std::string &InterfaceName);
1784 /** Given a pointer to a Module, return its filename
1785 * @param m The module pointer to identify
1786 * @return The module name or an empty string
1788 const std::string& GetModuleName(Module* m);
1790 /** Return a list of all modules matching the given filter
1791 * @param filter This int is a bitmask of flags set in Module::Flags,
1792 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1793 * all modules with no filtering, set this to 0.
1794 * @return The list of module names
1796 const std::vector<std::string> GetAllModuleNames(int filter);
1799 /** This definition is used as shorthand for the various classes
1800 * and functions needed to make a module loadable by the OS.
1801 * It defines the class factory and external init_module function.
1803 #define MODULE_INIT(y) \
1804 extern "C" DllExport Module * init_module(InspIRCd* Me) \