1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
21 #include "inspsocket.h"
31 /** Used with OnAccessCheck() method of modules
33 enum AccessControlType {
34 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
35 ACR_DENY, // deny the action
36 ACR_ALLOW, // allow the action
37 AC_KICK, // a user is being kicked
38 AC_DEOP, // a user is being deopped
39 AC_OP, // a user is being opped
40 AC_VOICE, // a user is being voiced
41 AC_DEVOICE, // a user is being devoiced
42 AC_HALFOP, // a user is being halfopped
43 AC_DEHALFOP, // a user is being dehalfopped
44 AC_INVITE, // a user is being invited
45 AC_GENERAL_MODE // a channel mode is being changed
48 /** Used to define a set of behavior bits for a module
51 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
52 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
53 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
54 VF_COMMON = 8 // module needs to be common on all servers in a network to link
57 /** Used with SendToMode()
64 /** Used to represent an event type, for user, channel or server
66 enum TargetTypeFlags {
73 /** Used to represent wether a message was PRIVMSG or NOTICE
80 /** If you change the module API, change this value.
81 * If you have enabled ipv6, the sizes of structs is
82 * different, and modules will be incompatible with
83 * ipv4 servers, so this value will be ten times as
84 * high on ipv6 servers.
86 #define NATIVE_API_VERSION 12000
88 #define API_VERSION (NATIVE_API_VERSION * 10)
90 #define API_VERSION (NATIVE_API_VERSION * 1)
95 /* Forward-delacare module for ModuleMessage etc
100 /** Low level definition of a FileReader classes file cache area -
101 * a text file seperated into lines.
103 typedef std::deque<std::string> file_cache;
105 /** A set of strings.
107 typedef file_cache string_list;
109 /** Holds a list of 'published features' for modules.
111 typedef std::map<std::string,Module*> featurelist;
113 /** Holds a list of modules which implement an interface
115 typedef std::deque<Module*> modulelist;
117 /** Holds a list of all modules which implement interfaces, by interface name
119 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
122 * This #define allows us to call a method in all
123 * loaded modules in a readable simple way, e.g.:
124 * 'FOREACH_MOD(I_OnConnect,OnConnect(user));'
126 #define FOREACH_MOD(y,x) do { \
127 EventHandlerIter safei; \
128 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
136 catch (CoreException& modexcept) \
138 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
145 * This #define allows us to call a method in all
146 * loaded modules in a readable simple way and pass
147 * an instance pointer to the macro. e.g.:
148 * 'FOREACH_MOD_I(Instance, OnConnect, OnConnect(user));'
150 #define FOREACH_MOD_I(z,y,x) do { \
151 EventHandlerIter safei; \
152 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
160 catch (CoreException& modexcept) \
162 z->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
169 * This define is similar to the one above but returns a result in MOD_RESULT.
170 * The first module to return a nonzero result is the value to be accepted,
171 * and any modules after are ignored.
173 #define FOREACH_RESULT(y,x) \
175 EventHandlerIter safei; \
177 for (EventHandlerIter _i = ServerInstance->Modules->EventHandlers[y].begin(); _i != ServerInstance->Modules->EventHandlers[y].end(); ) \
183 int res = (*_i)->x ; \
189 catch (CoreException& modexcept) \
191 ServerInstance->Log(DEFAULT,"Exception caught: %s",modexcept.GetReason()); \
199 * This define is similar to the one above but returns a result in MOD_RESULT.
200 * The first module to return a nonzero result is the value to be accepted,
201 * and any modules after are ignored.
203 #define FOREACH_RESULT_I(z,y,x) \
205 EventHandlerIter safei; \
207 for (EventHandlerIter _i = z->Modules->EventHandlers[y].begin(); _i != z->Modules->EventHandlers[y].end(); ) \
213 int res = (*_i)->x ; \
219 catch (CoreException& modexcept) \
221 z->Log(DEBUG,"Exception caught: %s",modexcept.GetReason()); \
227 /** Represents a non-local user.
228 * (in fact, any FD less than -1 does)
230 #define FD_MAGIC_NUMBER -42
234 /** Is a local user */
235 #define IS_LOCAL(x) ((x->GetFd() > -1))
237 /** Is a local user */
238 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
240 /** Is a remote user */
241 #define IS_REMOTE(x) (x->GetFd() < 0)
242 /** Is a module created user */
243 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
245 #define IS_OPER(x) (*x->oper)
247 #define IS_AWAY(x) (*x->awaymsg)
249 /** Holds a module's Version information.
250 * The four members (set by the constructor only) indicate details as to the version number
251 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
252 * The flags and API values represent the module flags and API version of the module.
253 * The API version of a module must match the API version of the core exactly for the module to
256 class CoreExport Version : public classbase
259 /** Version numbers, build number, flags and API version
261 const int Major, Minor, Revision, Build, Flags, API;
263 /** Initialize version class
265 Version(int major, int minor, int revision, int build, int flags, int api_ver);
268 /** The ModuleMessage class is the base class of Request and Event
269 * This class is used to represent a basic data structure which is passed
270 * between modules for safe inter-module communications.
272 class CoreExport ModuleMessage : public Extensible
277 virtual ~ModuleMessage() {};
280 /** The Request class is a unicast message directed at a given module.
281 * When this class is properly instantiated it may be sent to a module
282 * using the Send() method, which will call the given module's OnRequest
283 * method with this class as its parameter.
285 class CoreExport Request : public ModuleMessage
288 /** This member holds a pointer to arbitary data set by the emitter of the message
291 /** This should be a null-terminated string identifying the type of request,
292 * all modules should define this and use it to determine the nature of the
293 * request before they attempt to cast the Request in any way.
296 /** This is a pointer to the sender of the message, which can be used to
297 * directly trigger events, or to create a reply.
300 /** The single destination of the Request
304 /** Create a new Request
305 * This is for the 'old' way of casting whatever the data is
306 * to char* and hoping you get the right thing at the other end.
307 * This is slowly being depreciated in favor of the 'new' way.
309 Request(char* anydata, Module* src, Module* dst);
310 /** Create a new Request
311 * This is for the 'new' way of defining a subclass
312 * of Request and defining it in a common header,
313 * passing an object of your Request subclass through
314 * as a Request* and using the ID string to determine
315 * what to cast it back to and the other end. This is
316 * much safer as there are no casts not confirmed by
317 * the ID string, and all casts are child->parent and
318 * can be checked at runtime with dynamic_cast<>()
320 Request(Module* src, Module* dst, const char* idstr);
321 /** Fetch the Request data
324 /** Fetch the ID string
327 /** Fetch the request source
330 /** Fetch the request destination (should be 'this' in the receiving module)
333 /** Send the Request.
334 * Upon returning the result will be arbitary data returned by the module you
335 * sent the request to. It is up to your module to know what this data is and
336 * how to deal with it.
342 /** The Event class is a unicast message directed at all modules.
343 * When the class is properly instantiated it may be sent to all modules
344 * using the Send() method, which will trigger the OnEvent method in
345 * all modules passing the object as its parameter.
347 class CoreExport Event : public ModuleMessage
350 /** This member holds a pointer to arbitary data set by the emitter of the message
353 /** This is a pointer to the sender of the message, which can be used to
354 * directly trigger events, or to create a reply.
357 /** The event identifier.
358 * This is arbitary text which should be used to distinguish
359 * one type of event from another.
363 /** Create a new Event
365 Event(char* anydata, Module* src, const std::string &eventid);
366 /** Get the Event data
369 /** Get the event Source
372 /** Get the event ID.
373 * Use this to determine the event type for safe casting of the data
375 std::string GetEventID();
377 * The return result of an Event::Send() will always be NULL as
378 * no replies are expected.
380 char* Send(InspIRCd* ServerInstance);
383 /** Priority types which can be returned from Module::Prioritize()
385 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
387 /** Implementation-specific flags which may be set in Module::Implements()
392 I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
393 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
394 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
395 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
396 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddLine,
397 I_OnDelLine, I_OnExpireLine, I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
398 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite, I_OnRawMode,
399 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
400 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
401 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
402 I_OnOperCompare, I_OnChannelPreDelete, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
403 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed,
404 I_OnText, I_OnReadConfig, I_OnDownloadFile,
410 /** Base class for all InspIRCd modules
411 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
412 * its methods will be called when irc server events occur. class inherited from module must be
413 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
415 class CoreExport Module : public Extensible
418 /** Creator/owner pointer
420 InspIRCd* ServerInstance;
423 /** Default constructor.
424 * Creates a module class.
425 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
426 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
428 Module(InspIRCd* Me);
430 /** Default destructor.
431 * destroys a module class
435 virtual void Prioritize()
439 virtual void OnReadConfig(ServerConfig* config, ConfigReader* coreconf);
441 virtual int OnDownloadFile(const std::string &filename, std::istream* &filedata);
443 /** Returns the version number of a Module.
444 * The method should return a Version object with its version information assigned via
447 virtual Version GetVersion();
449 /** Called when a user connects.
450 * The details of the connecting user are available to you in the parameter User *user
451 * @param user The user who is connecting
453 virtual void OnUserConnect(User* user);
455 /** Called when a user quits.
456 * The details of the exiting user are available to you in the parameter User *user
457 * This event is only called when the user is fully registered when they quit. To catch
458 * raw disconnections, use the OnUserDisconnect method.
459 * @param user The user who is quitting
460 * @param message The user's quit message (as seen by non-opers)
461 * @param oper_message The user's quit message (as seen by opers)
463 virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
465 /** Called whenever a user's socket is closed.
466 * The details of the exiting user are available to you in the parameter User *user
467 * This event is called for all users, registered or not, as a cleanup method for modules
468 * which might assign resources to user, such as dns lookups, objects and sockets.
469 * @param user The user who is disconnecting
471 virtual void OnUserDisconnect(User* user);
473 /** Called whenever a channel is about to be deleted
474 * @param chan The channel being deleted
475 * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
477 virtual int OnChannelPreDelete(Channel *chan);
479 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
480 * @param chan The channel being deleted
482 virtual void OnChannelDelete(Channel* chan);
484 /** Called when a user joins a channel.
485 * The details of the joining user are available to you in the parameter User *user,
486 * and the details of the channel they have joined is available in the variable Channel *channel
487 * @param user The user who is joining
488 * @param channel The channel being joined
489 * @param silent Change this to true if you want to conceal the JOIN command from the other users
490 * of the channel (useful for modules such as auditorium)
491 * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
492 * to a channel due to the network sync.
494 virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
496 /** Called after a user joins a channel
497 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
499 * @param user The user who is joining
500 * @param channel The channel being joined
502 virtual void OnPostJoin(User* user, Channel* channel);
504 /** Called when a user parts a channel.
505 * The details of the leaving user are available to you in the parameter User *user,
506 * and the details of the channel they have left is available in the variable Channel *channel
507 * @param user The user who is parting
508 * @param channel The channel being parted
509 * @param partmessage The part message, or an empty string
510 * @param silent Change this to true if you want to conceal the PART command from the other users
511 * of the channel (useful for modules such as auditorium)
513 virtual void OnUserPart(User* user, Channel* channel, const std::string &partmessage, bool &silent);
515 /** Called on rehash.
516 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
517 * system. You should use it to reload any files so that your module keeps in step with the
518 * rest of the application. If a parameter is given, the core has done nothing. The module
519 * receiving the event can decide if this parameter has any relevence to it.
520 * @param user The user performing the rehash, if any -- if this is server initiated, the
521 * value of this variable will be NULL.
522 * @param parameter The (optional) parameter given to REHASH from the user.
524 virtual void OnRehash(User* user, const std::string ¶meter);
526 /** Called when a raw command is transmitted or received.
527 * This method is the lowest level of handler available to a module. It will be called with raw
528 * data which is passing through a connected socket. If you wish, you may munge this data by changing
529 * the string parameter "raw". If you do this, after your function exits it will immediately be
530 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
531 * inbound is set to true) the value of user will be the User of the connection sending the
532 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
533 * @param raw The raw string in RFC1459 format
534 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
535 * @param user The user record sending the text, when inbound == true.
537 virtual void OnServerRaw(std::string &raw, bool inbound, User* user);
539 /** Called whenever a user is about to join a channel, before any processing is done.
540 * Returning a value of 1 from this function stops the process immediately, causing no
541 * output to be sent to the user by the core. If you do this you must produce your own numerics,
542 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
543 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
547 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
548 * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
549 * processing on the actual channel record at this point, however the channel NAME will still be passed in
550 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
551 * @param user The user joining the channel
552 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
553 * @param cname The channel name being joined. For new channels this is valid where chan is not.
554 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
555 * You may alter this string to alter the user's modes on the channel.
556 * @return 1 To prevent the join, 0 to allow it.
558 virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs);
560 /** Called whenever a user is about to be kicked.
561 * Returning a value of 1 from this function stops the process immediately, causing no
562 * output to be sent to the user by the core. If you do this you must produce your own numerics,
564 * @param source The user issuing the kick
565 * @param user The user being kicked
566 * @param chan The channel the user is being kicked from
567 * @param reason The kick reason
568 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
570 virtual int OnUserPreKick(User* source, User* user, Channel* chan, const std::string &reason);
572 /** Called whenever a user is kicked.
573 * If this method is called, the kick is already underway and cannot be prevented, so
574 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
575 * @param source The user issuing the kick
576 * @param user The user being kicked
577 * @param chan The channel the user is being kicked from
578 * @param reason The kick reason
579 * @param silent Change this to true if you want to conceal the PART command from the other users
580 * of the channel (useful for modules such as auditorium)
582 virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
584 /** Called whenever a user opers locally.
585 * The User will contain the oper mode 'o' as this function is called after any modifications
586 * are made to the user's structure by the core.
587 * @param user The user who is opering up
588 * @param opertype The opers type name
590 virtual void OnOper(User* user, const std::string &opertype);
592 /** Called after a user opers locally.
593 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
594 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
595 * out the OPERTYPE, etc.
596 * @param user The user who is opering up
597 * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
598 * @param opertype The opers type name
600 virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
602 /** Called whenever a user types /INFO.
603 * The User will contain the information of the user who typed the command. Modules may use this
604 * method to output their own credits in /INFO (which is the ircd's version of an about box).
605 * It is purposefully not possible to modify any info that has already been output, or halt the list.
606 * You must write a 371 numeric to the user, containing your info in the following format:
608 * <nick> :information here
610 * @param user The user issuing /INFO
612 virtual void OnInfo(User* user);
614 /** Called whenever a /WHOIS is performed on a local user.
615 * The source parameter contains the details of the user who issued the WHOIS command, and
616 * the dest parameter contains the information of the user they are whoising.
617 * @param source The user issuing the WHOIS command
618 * @param dest The user who is being WHOISed
620 virtual void OnWhois(User* source, User* dest);
622 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
623 * Returning 1 from this function stops the process immediately, causing no
624 * output to be sent to the user by the core. If you do this you must produce your own numerics,
625 * notices etc. This is useful for modules which may want to filter invites to channels.
626 * @param source The user who is issuing the INVITE
627 * @param dest The user being invited
628 * @param channel The channel the user is being invited to
629 * @return 1 to deny the invite, 0 to allow
631 virtual int OnUserPreInvite(User* source,User* dest,Channel* channel);
633 /** Called after a user has been successfully invited to a channel.
634 * You cannot prevent the invite from occuring using this function, to do that,
635 * use OnUserPreInvite instead.
636 * @param source The user who is issuing the INVITE
637 * @param dest The user being invited
638 * @param channel The channel the user is being invited to
640 virtual void OnUserInvite(User* source,User* dest,Channel* channel);
642 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
643 * Returning any nonzero value from this function stops the process immediately, causing no
644 * output to be sent to the user by the core. If you do this you must produce your own numerics,
645 * notices etc. This is useful for modules which may want to filter or redirect messages.
646 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
647 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
648 * of where the message is destined to be sent.
649 * @param user The user sending the message
650 * @param dest The target of the message (Channel* or User*)
651 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
652 * @param text Changeable text being sent by the user
653 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
654 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
655 * It will be ignored for private messages.
656 * @return 1 to deny the NOTICE, 0 to allow it
658 virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
660 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
661 * Returning any nonzero value from this function stops the process immediately, causing no
662 * output to be sent to the user by the core. If you do this you must produce your own numerics,
663 * notices etc. This is useful for modules which may want to filter or redirect messages.
664 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
665 * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
666 * of where the message is destined to be sent.
667 * You may alter the message text as you wish before relinquishing control to the next module
668 * in the chain, and if no other modules block the text this altered form of the text will be sent out
669 * to the user and possibly to other servers.
670 * @param user The user sending the message
671 * @param dest The target of the message (Channel* or User*)
672 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
673 * @param text Changeable text being sent by the user
674 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
675 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
676 * It will be ignored for private notices.
677 * @return 1 to deny the NOTICE, 0 to allow it
679 virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
681 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
682 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
683 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
684 * @param chan The channel to build the exempt list of
685 * @param sender The original sender of the PRIVMSG or NOTICE
686 * @param status The status char to be used for the channel list
687 * @param exempt_list The exempt list to be populated
688 * @param text The original message text causing the exempt list to be built
690 virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text);
692 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
693 * Please note that although you can see remote nickchanges through this function, you should
694 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
695 * check user->server before taking any action (including returning nonzero from the method).
696 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
697 * module to generate some meaninful output.
698 * @param user The username changing their nick
699 * @param newnick Their new nickname
700 * @return 1 to deny the change, 0 to allow
702 virtual int OnUserPreNick(User* user, const std::string &newnick);
704 /** Called after any PRIVMSG sent from a user.
705 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
706 * if target_type is TYPE_CHANNEL.
707 * @param user The user sending the message
708 * @param dest The target of the message
709 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
710 * @param text the text being sent by the user
711 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
713 virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
715 /** Called after any NOTICE sent from a user.
716 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
717 * if target_type is TYPE_CHANNEL.
718 * @param user The user sending the message
719 * @param dest The target of the message
720 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
721 * @param text the text being sent by the user
722 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
724 virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
726 /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
727 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
728 * if target_type is TYPE_CHANNEL.
729 * The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed,
730 * the message has already been vetted. In the case of the other two methods, a later module may stop your
731 * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
732 * @param user The user sending the message
733 * @param dest The target of the message
734 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
735 * @param text the text being sent by the user
736 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
738 virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
740 /** Called after every MODE command sent from a user
741 * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
742 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
743 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
744 * @param user The user sending the MODEs
745 * @param dest The target of the modes (User* or Channel*)
746 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
747 * @param text The actual modes and their parameters if any
749 virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
751 /** Allows modules to alter or create server descriptions
752 * Whenever a module requires a server description, for example for display in
753 * WHOIS, this function is called in all modules. You may change or define the
754 * description given in std::string &description. If you do, this description
755 * will be shown in the WHOIS fields.
756 * @param servername The servername being searched for
757 * @param description Alterable server description for this server
759 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
761 /** Allows modules to synchronize data which relates to users during a netburst.
762 * When this function is called, it will be called from the module which implements
763 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
764 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
765 * (see below). This function will be called for every user visible on your side
766 * of the burst, allowing you to for example set modes, etc. Do not use this call to
767 * synchronize data which you have stored using class Extensible -- There is a specialist
768 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
769 * @param user The user being syncronized
770 * @param proto A pointer to the module handling network protocol
771 * @param opaque An opaque pointer set by the protocol module, should not be modified!
773 virtual void OnSyncUser(User* user, Module* proto, void* opaque);
775 /** Allows modules to synchronize data which relates to channels during a netburst.
776 * When this function is called, it will be called from the module which implements
777 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
778 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
779 * (see below). This function will be called for every user visible on your side
780 * of the burst, allowing you to for example set modes, etc. Do not use this call to
781 * synchronize data which you have stored using class Extensible -- There is a specialist
782 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
784 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
786 * @param chan The channel being syncronized
787 * @param proto A pointer to the module handling network protocol
788 * @param opaque An opaque pointer set by the protocol module, should not be modified!
790 virtual void OnSyncChannel(Channel* chan, Module* proto, void* opaque);
792 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
793 * Whenever the linking module wants to send out data, but doesnt know what the data
794 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
795 * this method is called.You should use the ProtoSendMetaData function after you've
796 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
797 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
798 * @param chan The channel whos metadata is being syncronized
799 * @param proto A pointer to the module handling network protocol
800 * @param opaque An opaque pointer set by the protocol module, should not be modified!
801 * @param extname The extensions name which is being searched for
802 * @param displayable If this value is true, the data is going to be displayed to a user,
803 * and not sent across the network. Use this to determine wether or not to show sensitive data.
805 virtual void OnSyncChannelMetaData(Channel* chan, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
807 /* Allows modules to syncronize metadata related to users over the network during a netburst.
808 * Whenever the linking module wants to send out data, but doesnt know what the data
809 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
810 * this method is called. You should use the ProtoSendMetaData function after you've
811 * correctly decided how the data should be represented, to send the metadata on its way if
812 * if it belongs to your module.
813 * @param user The user whos metadata is being syncronized
814 * @param proto A pointer to the module handling network protocol
815 * @param opaque An opaque pointer set by the protocol module, should not be modified!
816 * @param extname The extensions name which is being searched for
817 * @param displayable If this value is true, the data is going to be displayed to a user,
818 * and not sent across the network. Use this to determine wether or not to show sensitive data.
820 virtual void OnSyncUserMetaData(User* user, Module* proto,void* opaque, const std::string &extname, bool displayable = false);
822 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
823 * Whenever the linking module wants to send out data, but doesnt know what the data
824 * represents (e.g. it is Extensible metadata, added to a User or Channel by a module) then
825 * this method is called. You should use the ProtoSendMetaData function after you've
826 * correctly decided how the data should be represented, to send the metadata on its way if
827 * if it belongs to your module.
828 * @param proto A pointer to the module handling network protocol
829 * @param opaque An opaque pointer set by the protocol module, should not be modified!
830 * @param displayable If this value is true, the data is going to be displayed to a user,
831 * and not sent across the network. Use this to determine wether or not to show sensitive data.
833 virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
835 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
836 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
837 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
838 * @param target The Channel* or User* that data should be added to
839 * @param extname The extension name which is being sent
840 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
842 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
844 /** Implemented by modules which provide the ability to link servers.
845 * These modules will implement this method, which allows transparent sending of servermodes
846 * down the network link as a broadcast, without a module calling it having to know the format
847 * of the MODE command before the actual mode string.
849 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
850 * of how to use this function.
852 * @param opaque An opaque pointer set by the protocol module, should not be modified!
853 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
854 * @param target The Channel* or User* that modes should be sent for
855 * @param modeline The modes and parameters to be sent
857 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
859 /** Implemented by modules which provide the ability to link servers.
860 * These modules will implement this method, which allows metadata (extra data added to
861 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
862 * to other servers on a netburst and decoded at the other end by the same module on a
865 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
866 * how to use this function.
867 * @param opaque An opaque pointer set by the protocol module, should not be modified!
868 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
869 * @param target The Channel* or User* that metadata should be sent for
870 * @param extname The extension name to send metadata for
871 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
873 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
875 /** Called after every WALLOPS command.
876 * @param user The user sending the WALLOPS
877 * @param text The content of the WALLOPS message
879 virtual void OnWallops(User* user, const std::string &text);
881 /** Called whenever a user's hostname is changed.
882 * This event triggers after the host has been set.
883 * @param user The user whos host is being changed
884 * @param newhost The new hostname being set
886 virtual void OnChangeHost(User* user, const std::string &newhost);
888 /** Called whenever a user's GECOS (realname) is changed.
889 * This event triggers after the name has been set.
890 * @param user The user who's GECOS is being changed
891 * @param gecos The new GECOS being set on the user
893 virtual void OnChangeName(User* user, const std::string &gecos);
895 /** Called whenever an xline is added by a local user.
896 * This method is triggered after the line is added.
897 * @param source The sender of the line or NULL for local server
898 * @param line The xline being added
900 virtual void OnAddLine(User* source, XLine* line);
902 /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
903 * This method is triggered after the line is deleted.
904 * @param source The user removing the line or NULL for local server
905 * @param line the line being deleted
907 virtual void OnDelLine(User* source, XLine* line);
909 /** Called whenever an xline expires.
910 * This method is triggered after the line is deleted.
911 * @param line The line being deleted.
913 virtual void OnExpireLine(XLine *line);
915 /** Called before your module is unloaded to clean up Extensibles.
916 * This method is called once for every user and channel on the network,
917 * so that when your module unloads it may clear up any remaining data
918 * in the form of Extensibles added using Extensible::Extend().
919 * If the target_type variable is TYPE_USER, then void* item refers to
920 * a User*, otherwise it refers to a Channel*.
921 * @param target_type The type of item being cleaned
922 * @param item A pointer to the item's class
924 virtual void OnCleanup(int target_type, void* item);
926 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
927 * have been applied. Please note that although you can see remote nickchanges through this function, you should
928 * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
929 * check user->server before taking any action (including returning nonzero from the method).
930 * Because this method is called after the nickchange is taken place, no return values are possible
931 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
932 * @param user The user changing their nick
933 * @param oldnick The old nickname of the user before the nickchange
935 virtual void OnUserPostNick(User* user, const std::string &oldnick);
937 /** Called before an action which requires a channel privilage check.
938 * This function is called before many functions which check a users status on a channel, for example
939 * before opping a user, deopping a user, kicking a user, etc.
940 * There are several values for access_type which indicate for what reason access is being checked.
942 * AC_KICK (0) - A user is being kicked<br>
943 * AC_DEOP (1) - a user is being deopped<br>
944 * AC_OP (2) - a user is being opped<br>
945 * AC_VOICE (3) - a user is being voiced<br>
946 * AC_DEVOICE (4) - a user is being devoiced<br>
947 * AC_HALFOP (5) - a user is being halfopped<br>
948 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
949 * AC_INVITE () - a user is being invited<br>
950 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
951 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
952 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
953 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
954 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
955 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
956 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
957 * @param source The source of the access check
958 * @param dest The destination of the access check
959 * @param channel The channel which is being checked
960 * @param access_type See above
962 virtual int OnAccessCheck(User* source,User* dest,Channel* channel,int access_type);
964 /** Called when a 005 numeric is about to be output.
965 * The module should modify the 005 numeric if needed to indicate its features.
966 * @param output The 005 string to be modified if neccessary.
968 virtual void On005Numeric(std::string &output);
970 /** Called when a client is disconnected by KILL.
971 * If a client is killed by a server, e.g. a nickname collision or protocol error,
973 * Return 1 from this function to prevent the kill, and 0 from this function to allow
974 * it as normal. If you prevent the kill no output will be sent to the client, it is
975 * down to your module to generate this information.
976 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
977 * If you do so youre risking race conditions, desyncs and worse!
978 * @param source The user sending the KILL
979 * @param dest The user being killed
980 * @param reason The kill reason
981 * @return 1 to prevent the kill, 0 to allow
983 virtual int OnKill(User* source, User* dest, const std::string &reason);
985 /** Called when an oper wants to disconnect a remote user via KILL
986 * @param source The user sending the KILL
987 * @param dest The user being killed
988 * @param reason The kill reason
990 virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
992 /** Called whenever a module is loaded.
993 * mod will contain a pointer to the module, and string will contain its name,
994 * for example m_widgets.so. This function is primary for dependency checking,
995 * your module may decide to enable some extra features if it sees that you have
996 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
997 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
998 * but instead operate under reduced functionality, unless the dependency is
999 * absolutely neccessary (e.g. a module that extends the features of another
1001 * @param mod A pointer to the new module
1002 * @param name The new module's filename
1004 virtual void OnLoadModule(Module* mod,const std::string &name);
1006 /** Called whenever a module is unloaded.
1007 * mod will contain a pointer to the module, and string will contain its name,
1008 * for example m_widgets.so. This function is primary for dependency checking,
1009 * your module may decide to enable some extra features if it sees that you have
1010 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1011 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1012 * but instead operate under reduced functionality, unless the dependency is
1013 * absolutely neccessary (e.g. a module that extends the features of another
1015 * @param mod Pointer to the module being unloaded (still valid)
1016 * @param name The filename of the module being unloaded
1018 virtual void OnUnloadModule(Module* mod,const std::string &name);
1020 /** Called once every five seconds for background processing.
1021 * This timer can be used to control timed features. Its period is not accurate
1022 * enough to be used as a clock, but it is gauranteed to be called at least once in
1023 * any five second period, directly from the main loop of the server.
1024 * @param curtime The current timer derived from time(2)
1026 virtual void OnBackgroundTimer(time_t curtime);
1028 /** Called whenever any command is about to be executed.
1029 * This event occurs for all registered commands, wether they are registered in the core,
1030 * or another module, and for invalid commands. Invalid commands may only be sent to this
1031 * function when the value of validated is false. By returning 1 from this method you may prevent the
1032 * command being executed. If you do this, no output is created by the core, and it is
1033 * down to your module to produce any output neccessary.
1034 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1035 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1036 * method returns, it will be passed an invalid pointer to the user object and crash!)
1037 * @param command The command being executed
1038 * @param parameters An array of array of characters containing the parameters for the command
1039 * @param pcnt The nuimber of parameters passed to the command
1040 * @param user the user issuing the command
1041 * @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.
1042 * @param original_line The entire original line as passed to the parser from the user
1043 * @return 1 to block the command, 0 to allow
1045 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, User *user, bool validated, const std::string &original_line);
1047 /** Called after any command has been executed.
1048 * This event occurs for all registered commands, wether they are registered in the core,
1049 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1050 * exist within the command table). The result code returned by the command handler is
1052 * @param command The command being executed
1053 * @param parameters An array of array of characters containing the parameters for the command
1054 * @param pcnt The nuimber of parameters passed to the command
1055 * @param user the user issuing the command
1056 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1057 * @param original_line The entire original line as passed to the parser from the user
1059 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, User *user, CmdResult result, const std::string &original_line);
1061 /** Called to check if a user who is connecting can now be allowed to register
1062 * If any modules return false for this function, the user is held in the waiting
1063 * state until all modules return true. For example a module which implements ident
1064 * lookups will continue to return false for a user until their ident lookup is completed.
1065 * Note that the registration timeout for a user overrides these checks, if the registration
1066 * timeout is reached, the user is disconnected even if modules report that the user is
1067 * not ready to connect.
1068 * @param user The user to check
1069 * @return true to indicate readiness, false if otherwise
1071 virtual bool OnCheckReady(User* user);
1073 /** Called whenever a user is about to register their connection (e.g. before the user
1074 * is sent the MOTD etc). Modules can use this method if they are performing a function
1075 * which must be done before the actual connection is completed (e.g. ident lookups,
1076 * dnsbl lookups, etc).
1077 * Note that you should NOT delete the user record here by causing a disconnection!
1078 * Use OnUserConnect for that instead.
1079 * @param user The user registering
1080 * @return 1 to indicate user quit, 0 to continue
1082 virtual int OnUserRegister(User* user);
1084 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1085 * This method will always be called for each join, wether or not the channel is actually +i, and
1086 * determines the outcome of an if statement around the whole section of invite checking code.
1087 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1088 * @param user The user joining the channel
1089 * @param chan The channel being joined
1090 * @return 1 to explicitly allow the join, 0 to proceed as normal
1092 virtual int OnCheckInvite(User* user, Channel* chan);
1094 /** Called whenever a mode character is processed.
1095 * Return 1 from this function to block the mode character from being processed entirely.
1096 * @param user The user who is sending the mode
1097 * @param chan The channel the mode is being sent to (or NULL if a usermode)
1098 * @param mode The mode character being set
1099 * @param param The parameter for the mode or an empty string
1100 * @param adding true of the mode is being added, false if it is being removed
1101 * @param pcnt The parameter count for the mode (0 or 1)
1102 * @return 1 to deny the mode, 0 to allow
1104 virtual int OnRawMode(User* user, Channel* chan, const char mode, const std::string ¶m, bool adding, int pcnt);
1106 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1107 * This method will always be called for each join, wether or not the channel is actually +k, and
1108 * determines the outcome of an if statement around the whole section of key checking code.
1109 * if the user specified no key, the keygiven string will be a valid but empty value.
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 OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
1117 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1118 * This method will always be called for each join, wether or not the channel is actually +l, and
1119 * determines the outcome of an if statement around the whole section of channel limit 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 OnCheckLimit(User* user, Channel* chan);
1127 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1128 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1129 * determines the outcome of an if statement around the whole section of ban checking code.
1130 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1131 * @param user The user joining the channel
1132 * @param chan The channel being joined
1133 * @return 1 to explicitly allow the join, 0 to proceed as normal
1135 virtual int OnCheckBan(User* user, Channel* chan);
1137 /** Called on all /STATS commands
1138 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1139 * @param symbol the symbol provided to /STATS
1140 * @param user the user issuing the /STATS command
1141 * @param results A string_list to append results into. You should put all your results
1142 * into this string_list, rather than displaying them directly, so that your handler will
1143 * work when remote STATS queries are received.
1144 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1146 virtual int OnStats(char symbol, User* user, string_list &results);
1148 /** Called whenever a change of a local users displayed host is attempted.
1149 * Return 1 to deny the host change, or 0 to allow it.
1150 * @param user The user whos host will be changed
1151 * @param newhost The new hostname
1152 * @return 1 to deny the host change, 0 to allow
1154 virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
1156 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1157 * return 1 to deny the name change, or 0 to allow it.
1158 * @param user The user whos GECOS will be changed
1159 * @param newhost The new GECOS
1160 * @return 1 to deny the GECOS change, 0 to allow
1162 virtual int OnChangeLocalUserGECOS(User* user, const std::string &newhost);
1164 /** Called whenever a topic is changed by a local user.
1165 * Return 1 to deny the topic change, or 0 to allow it.
1166 * @param user The user changing the topic
1167 * @param chan The channels who's topic is being changed
1168 * @param topic The actual topic text
1169 * @param 1 to block the topic change, 0 to allow
1171 virtual int OnLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1173 /** Called whenever a local topic has been changed.
1174 * To block topic changes you must use OnLocalTopicChange instead.
1175 * @param user The user changing the topic
1176 * @param chan The channels who's topic is being changed
1177 * @param topic The actual topic text
1179 virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
1181 /** Called whenever an Event class is sent to all module by another module.
1182 * Please see the documentation of Event::Send() for further information. The Event sent can
1183 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1184 * before doing anything to the event data, and you should *not* change the event data in any way!
1185 * @param event The Event class being received
1187 virtual void OnEvent(Event* event);
1189 /** Called whenever a Request class is sent to your module by another module.
1190 * Please see the documentation of Request::Send() for further information. The Request sent
1191 * can always be assumed to be non-NULL, you should not change the request object or its data.
1192 * Your method may return arbitary data in the char* result which the requesting module
1193 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1194 * @param request The Request class being received
1196 virtual char* OnRequest(Request* request);
1198 /** Called whenever an oper password is to be compared to what a user has input.
1199 * The password field (from the config file) is in 'password' and is to be compared against
1200 * 'input'. This method allows for encryption of oper passwords and much more besides.
1201 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1203 * @param password The oper's password
1204 * @param input The password entered
1205 * @param tagnumber The tag number (from the configuration file) of this oper's tag
1206 * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
1208 virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
1210 /** Called whenever a user is given usermode +o, anywhere on the network.
1211 * You cannot override this and prevent it from happening as it is already happened and
1212 * such a task must be performed by another server. You can however bounce modes by sending
1213 * servermodes out to reverse mode changes.
1214 * @param user The user who is opering
1216 virtual void OnGlobalOper(User* user);
1218 /** Called after a user has fully connected and all modules have executed OnUserConnect
1219 * This event is informational only. You should not change any user information in this
1220 * event. To do so, use the OnUserConnect method to change the state of local users.
1221 * This is called for both local and remote users.
1222 * @param user The user who is connecting
1224 virtual void OnPostConnect(User* user);
1226 /** Called whenever a ban is added to a channel's list.
1227 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1228 * @param source The user adding the ban
1229 * @param channel The channel the ban is being added to
1230 * @param banmask The ban mask being added
1231 * @return 1 to block the ban, 0 to continue as normal
1233 virtual int OnAddBan(User* source, Channel* channel,const std::string &banmask);
1235 /** Called whenever a ban is removed from a channel's list.
1236 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1237 * @param source The user deleting the ban
1238 * @param channel The channel the ban is being deleted from
1239 * @param banmask The ban mask being deleted
1240 * @return 1 to block the unban, 0 to continue as normal
1242 virtual int OnDelBan(User* source, Channel* channel,const std::string &banmask);
1244 /** Called immediately after any connection is accepted. This is intended for raw socket
1245 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1246 * no information relating to a user record as the connection has not been assigned yet.
1247 * There are no return values from this call as all modules get an opportunity if required to
1248 * process the connection.
1249 * @param fd The file descriptor returned from accept()
1250 * @param ip The IP address of the connecting user
1251 * @param localport The local port number the user connected to
1253 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1255 /** Called immediately before any write() operation on a user's socket in the core. Because
1256 * this event is a low level event no user information is associated with it. It is intended
1257 * for use by modules which may wrap connections within another API such as SSL for example.
1258 * return a non-zero result if you have handled the write operation, in which case the core
1259 * will not call write().
1260 * @param fd The file descriptor of the socket
1261 * @param buffer A char* buffer being written
1262 * @param Number of characters to write
1263 * @return Number of characters actually written or 0 if you didn't handle the operation
1265 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1267 /** Called immediately before any socket is closed. When this event is called, shutdown()
1268 * has not yet been called on the socket.
1269 * @param fd The file descriptor of the socket prior to close()
1271 virtual void OnRawSocketClose(int fd);
1273 /** Called immediately upon connection of an outbound BufferedSocket which has been hooked
1275 * @param fd The file descriptor of the socket immediately after connect()
1277 virtual void OnRawSocketConnect(int fd);
1279 /** Called immediately before any read() operation on a client socket in the core.
1280 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1281 * when this event occurs.
1282 * Your event should return 1 if it has handled the reading itself, which prevents the core
1283 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1284 * the value of count. The value of readresult must be identical to an actual result that might
1285 * be returned from the read() system call, for example, number of bytes read upon success,
1286 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1287 * you MUST set readresult.
1288 * @param fd The file descriptor of the socket
1289 * @param buffer A char* buffer being read to
1290 * @param count The size of the buffer
1291 * @param readresult The amount of characters read, or 0
1292 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1294 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1296 /** Called whenever a user sets away.
1297 * This method has no parameter for the away message, as it is available in the
1298 * user record as User::awaymsg.
1299 * @param user The user setting away
1301 virtual void OnSetAway(User* user);
1303 /** Called when a user cancels their away state.
1304 * @param user The user returning from away
1306 virtual void OnCancelAway(User* user);
1308 /** Called whenever a NAMES list is requested.
1309 * You can produce the nameslist yourself, overriding the current list,
1310 * and if you do you must return 1. If you do not handle the names list,
1312 * @param The user requesting the NAMES list
1313 * @param Ptr The channel the NAMES list is requested for
1314 * @param userlist The user list for the channel (you may change this pointer.
1315 * If you want to change the values, take a copy first, and change the copy, then
1316 * point the pointer at your copy)
1317 * @return 1 to prevent the user list being sent to the client, 0 to allow it.
1318 * Returning -1 allows the names list, but bypasses any checks which check for
1319 * channel membership before sending the names list.
1321 virtual int OnUserList(User* user, Channel* Ptr, CUList* &userlist);
1323 /** Called whenever a line of WHOIS output is sent to a user.
1324 * You may change the numeric and the text of the output by changing
1325 * the values numeric and text, but you cannot change the user the
1326 * numeric is sent to. You may however change the user's User values.
1327 * @param user The user the numeric is being sent to
1328 * @param dest The user being WHOISed
1329 * @param numeric The numeric of the line being sent
1330 * @param text The text of the numeric, including any parameters
1331 * @return nonzero to drop the line completely so that the user does not
1332 * receive it, or zero to allow the line to be sent.
1334 virtual int OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
1336 /** Called at intervals for modules to garbage-collect any hashes etc.
1337 * Certain data types such as hash_map 'leak' buckets, which must be
1338 * tidied up and freed by copying into a new item every so often. This
1339 * method is called when it is time to do that.
1341 virtual void OnGarbageCollect();
1343 /** Called whenever a user's write buffer has been completely sent.
1344 * This is called when the user's write buffer is completely empty, and
1345 * there are no more pending bytes to be written and no pending write events
1346 * in the socket engine's queue. This may be used to refill the buffer with
1347 * data which is being spooled in a controlled manner, e.g. LIST lines.
1348 * @param user The user who's buffer is now empty.
1350 virtual void OnBufferFlushed(User* user);
1354 #define CONF_NO_ERROR 0x000000
1355 #define CONF_NOT_A_NUMBER 0x000010
1356 #define CONF_INT_NEGATIVE 0x000080
1357 #define CONF_VALUE_NOT_FOUND 0x000100
1358 #define CONF_FILE_NOT_FOUND 0x000200
1361 /** Allows reading of values from configuration files
1362 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1363 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1364 * Constructing the class using one parameter allows you to specify a path to your own configuration
1365 * file, otherwise, inspircd.conf is read.
1367 class CoreExport ConfigReader : public classbase
1370 InspIRCd* ServerInstance;
1371 /** The contents of the configuration file
1372 * This protected member should never be accessed by a module (and cannot be accessed unless the
1373 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1374 * (such as comments) stripped from it.
1376 ConfigDataHash* data;
1377 /** Used to store errors
1379 std::ostringstream* errorlog;
1380 /** If we're using our own config data hash or not
1383 /** True if an error occured reading the config file
1391 /** Default constructor.
1392 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1393 * as specified when running ./configure.
1395 ConfigReader(InspIRCd* Instance);
1396 /** Overloaded constructor.
1397 * This constructor initialises the ConfigReader class to read a user-specified config file
1399 ConfigReader(InspIRCd* Instance, const std::string &filename);
1400 /** Default destructor.
1401 * This method destroys the ConfigReader class.
1405 /** Retrieves a value from the config file.
1406 * This method retrieves a 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.
1409 std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
1410 /** Retrieves a value from the config file.
1411 * This method retrieves a value from the config file. Where multiple copies of the tag
1412 * exist in the config file, index indicates which of the values to retrieve. If the
1413 * tag is not found the default value is returned instead.
1415 std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
1417 /** Retrieves a boolean value from the config file.
1418 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1419 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1420 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1422 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1423 /** Retrieves a boolean value from the config file.
1424 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1425 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1426 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1427 * If the tag is not found, the default value is used instead.
1429 bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
1431 /** Retrieves an integer value from the config file.
1432 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1433 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1434 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1435 * return CONF_INVALID_NUMBER to be returned. need_positive is set if the number must be non-negative.
1436 * If a negative number is placed into a tag which is specified positive, 0 will be returned and GetError()
1437 * will return CONF_INT_NEGATIVE. Note that need_positive is not suitable to get an unsigned int - you
1438 * should cast the result to achieve that effect.
1440 int ReadInteger(const std::string &tag, const std::string &name, int index, bool need_positive);
1441 /** Retrieves an integer value from the config file.
1442 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1443 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1444 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1445 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1446 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1447 * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
1449 int ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool need_positive);
1451 /** Returns the last error to occur.
1452 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1453 * A call to GetError() resets the error flag back to 0.
1456 /** Counts the number of times a given tag appears in the config file.
1457 * This method counts the number of times a tag appears in a config file, for use where
1458 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1459 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1460 * multiple instance tag.
1462 int Enumerate(const std::string &tag);
1463 /** Returns true if a config file is valid.
1464 * This method is partially implemented and will only return false if the config
1465 * file does not exist or could not be opened.
1468 /** Dumps the list of errors in a config file to an output location. If bail is true,
1469 * then the program will abort. If bail is false and user points to a valid user
1470 * record, the error report will be spooled to the given user by means of NOTICE.
1471 * if bool is false AND user is false, the error report will be spooled to all opers
1472 * by means of a NOTICE to all opers.
1474 void DumpErrors(bool bail,User* user);
1476 /** Returns the number of items within a tag.
1477 * For example if the tag was <test tag="blah" data="foo"> then this
1478 * function would return 2. Spaces and newlines both qualify as valid seperators
1481 int EnumerateValues(const std::string &tag, int index);
1486 /** Caches a text file into memory and can be used to retrieve lines from it.
1487 * This class contains methods for read-only manipulation of a text file in memory.
1488 * Either use the constructor type with one parameter to load a file into memory
1489 * at construction, or use the LoadFile method to load a file.
1491 class CoreExport FileReader : public classbase
1493 InspIRCd* ServerInstance;
1494 /** The file contents
1498 /** Content size in bytes
1500 unsigned long contentsize;
1502 /** Calculate content size in bytes
1507 /** Default constructor.
1508 * This method does not load any file into memory, you must use the LoadFile method
1509 * after constructing the class this way.
1511 FileReader(InspIRCd* Instance);
1513 /** Secondary constructor.
1514 * This method initialises the class with a file loaded into it ready for GetLine and
1515 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1518 FileReader(InspIRCd* Instance, const std::string &filename);
1520 /** Default destructor.
1521 * This deletes the memory allocated to the file.
1525 /** Used to load a file.
1526 * This method loads a file into the class ready for GetLine and
1527 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1530 void LoadFile(const std::string &filename);
1532 /** Returns the whole content of the file as std::string
1534 std::string Contents();
1536 /** Returns the entire size of the file as std::string
1538 unsigned long ContentSize();
1540 /** Returns true if the file exists
1541 * This function will return false if the file could not be opened.
1545 /** Retrieve one line from the file.
1546 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1547 * the index was out of bounds, or the line had no data on it.
1549 std::string GetLine(int x);
1551 /** Returns the size of the file in lines.
1552 * This method returns the number of lines in the read file. If it is 0, no lines have been
1553 * read into memory, either because the file is empty or it does not exist, or cannot be
1554 * opened due to permission problems.
1559 /** A DLLFactory (designed to load shared objects) containing a
1560 * handle to a module's init_module() function. Unfortunately,
1561 * due to the design of shared object systems we must keep this
1562 * hanging around, as if we remove this handle, we remove the
1563 * shared object file from memory (!)
1565 typedef DLLFactory<Module> ircd_module;
1567 /** A list of modules
1569 typedef std::vector<Module*> IntModuleList;
1571 /** An event handler iterator
1573 typedef IntModuleList::iterator EventHandlerIter;
1575 /** Module priority states
1586 /** ModuleManager takes care of all things module-related
1589 class CoreExport ModuleManager : public classbase
1592 /** Holds a string describing the last module error to occur
1594 std::string LastModuleError;
1596 /** The feature names published by various modules
1598 featurelist Features;
1600 /** The interface names published by various modules
1602 interfacelist Interfaces;
1604 /** Total number of modules loaded into the ircd
1608 /** Our pointer to the main insp instance
1612 /** List of loaded modules and shared object/dll handles
1613 * keyed by module name
1615 std::map<std::string, std::pair<ircd_module*, Module*> > Modules;
1619 /** Event handler hooks.
1620 * This needs to be public to be used by FOREACH_MOD and friends.
1622 IntModuleList EventHandlers[I_END];
1624 /** Simple, bog-standard, boring constructor.
1626 ModuleManager(InspIRCd* Ins);
1632 /** Change the priority of one event in a module.
1633 * Each module event has a list of modules which are attached to that event type.
1634 * If you wish to be called before or after other specific modules, you may use this
1635 * method (usually within void Module::Prioritize()) to set your events priority.
1636 * You may use this call in other methods too, however, this is not supported behaviour
1638 * @param mod The module to change the priority of
1639 * @param i The event to change the priority of
1640 * @param s The state you wish to use for this event. Use one of
1641 * PRIO_FIRST to set the event to be first called, PRIO_LAST to
1642 * set it to be the last called, or PRIO_BEFORE and PRIO_AFTER
1643 * to set it to be before or after one or more other modules.
1644 * @param modules If PRIO_BEFORE or PRIO_AFTER is set in parameter 's',
1645 * then this contains a list of one or more modules your module must be
1646 * placed before or after. Your module will be placed before the highest
1647 * priority module in this list for PRIO_BEFORE, or after the lowest
1648 * priority module in this list for PRIO_AFTER.
1649 * @param sz The number of modules being passed for PRIO_BEFORE and PRIO_AFTER.
1650 * Defaults to 1, as most of the time you will only want to prioritize your module
1651 * to be before or after one other module.
1653 bool SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules = NULL, size_t sz = 1);
1655 /** Change the priority of all events in a module.
1656 * @param mod The module to set the priority of
1657 * @param s The priority of all events in the module.
1658 * Note that with this method, it is not possible to effectively use
1659 * PRIO_BEFORE or PRIO_AFTER, you should use the more fine tuned
1660 * SetPriority method for this, where you may specify other modules to
1661 * be prioritized against.
1663 bool SetPriority(Module* mod, PriorityState s);
1665 /** Attach an event to a module.
1666 * You may later detatch the event with ModuleManager::Detach().
1667 * If your module is unloaded, all events are automatically detatched.
1668 * @param i Event type to attach
1669 * @param mod Module to attach event to
1670 * @return True if the event was attached
1672 bool Attach(Implementation i, Module* mod);
1674 /** Detatch an event from a module.
1675 * This is not required when your module unloads, as the core will
1676 * automatically detatch your module from all events it is attached to.
1677 * @param i Event type to detach
1678 * @param mod Module to detach event from
1679 * @param Detach true if the event was detached
1681 bool Detach(Implementation i, Module* mod);
1683 /** Attach an array of events to a module
1684 * @param i Event types (array) to attach
1685 * @param mod Module to attach events to
1687 void Attach(Implementation* i, Module* mod, size_t sz);
1689 /** Detach all events from a module (used on unload)
1690 * @param mod Module to detach from
1692 void DetachAll(Module* mod);
1694 /** Returns text describing the last module error
1695 * @return The last error message to occur
1697 std::string& LastError();
1699 /** Load a given module file
1700 * @param filename The file to load
1701 * @return True if the module was found and loaded
1703 bool Load(const char* filename);
1705 /** Unload a given module file
1706 * @param filename The file to unload
1707 * @return True if the module was unloaded
1709 bool Unload(const char* filename);
1711 /** Called by the InspIRCd constructor to load all modules from the config file.
1715 /** Get the total number of currently loaded modules
1716 * @return The number of loaded modules
1720 return this->ModCount;
1723 /** Find a module by name, and return a Module* to it.
1724 * This is preferred over iterating the module lists yourself.
1725 * @param name The module name to look up
1726 * @return A pointer to the module, or NULL if the module cannot be found
1728 Module* Find(const std::string &name);
1730 /** Publish a 'feature'.
1731 * There are two ways for a module to find another module it depends on.
1732 * Either by name, using InspIRCd::FindModule, or by feature, using this
1733 * function. A feature is an arbitary string which identifies something this
1734 * module can do. For example, if your module provides SSL support, but other
1735 * modules provide SSL support too, all the modules supporting SSL should
1736 * publish an identical 'SSL' feature. This way, any module requiring use
1737 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1738 * then use the module pointer they are given.
1739 * @param FeatureName The case sensitive feature name to make available
1740 * @param Mod a pointer to your module class
1741 * @returns True on success, false if the feature is already published by
1744 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1746 /** Publish a module to an 'interface'.
1747 * Modules which implement the same interface (the same way of communicating
1748 * with other modules) can publish themselves to an interface, using this
1749 * method. When they do so, they become part of a list of related or
1750 * compatible modules, and a third module may then query for that list
1751 * and know that all modules within that list offer the same API.
1752 * A prime example of this is the hashing modules, which all accept the
1753 * same types of Request class. Consider this to be similar to PublishFeature,
1754 * except for that multiple modules may publish the same 'feature'.
1755 * @param InterfaceName The case sensitive interface name to make available
1756 * @param Mod a pointer to your module class
1757 * @returns True on success, false on failure (there are currently no failure
1760 bool PublishInterface(const std::string &InterfaceName, Module* Mod);
1762 /** Return a pair saying how many other modules are currently using the
1763 * interfaces provided by module m.
1764 * @param m The module to count usage for
1765 * @return A pair, where the first value is the number of uses of the interface,
1766 * and the second value is the interface name being used.
1768 std::pair<int,std::string> GetInterfaceInstanceCount(Module* m);
1770 /** Mark your module as using an interface.
1771 * If you mark your module as using an interface, then that interface
1772 * module may not unload until your module has unloaded first.
1773 * This can be used to prevent crashes by ensuring code you depend on
1774 * is always in memory while your module is active.
1775 * @param InterfaceName The interface to use
1777 void UseInterface(const std::string &InterfaceName);
1779 /** Mark your module as finished with an interface.
1780 * If you used UseInterface() above, you should use this method when
1781 * your module is finished with the interface (usually in its destructor)
1782 * to allow the modules which implement the given interface to be unloaded.
1783 * @param InterfaceName The interface you are finished with using.
1785 void DoneWithInterface(const std::string &InterfaceName);
1787 /** Unpublish a 'feature'.
1788 * When your module exits, it must call this method for every feature it
1789 * is providing so that the feature table is cleaned up.
1790 * @param FeatureName the feature to remove
1792 bool UnpublishFeature(const std::string &FeatureName);
1794 /** Unpublish your module from an interface
1795 * When your module exits, it must call this method for every interface
1796 * it is part of so that the interfaces table is cleaned up. Only when
1797 * the last item is deleted from an interface does the interface get
1799 * @param InterfaceName the interface to be removed from
1800 * @param Mod The module to remove from the interface list
1802 bool UnpublishInterface(const std::string &InterfaceName, Module* Mod);
1804 /** Find a 'feature'.
1805 * There are two ways for a module to find another module it depends on.
1806 * Either by name, using InspIRCd::FindModule, or by feature, using the
1807 * InspIRCd::PublishFeature method. A feature is an arbitary string which
1808 * identifies something this module can do. For example, if your module
1809 * provides SSL support, but other modules provide SSL support too, all
1810 * the modules supporting SSL should publish an identical 'SSL' feature.
1811 * To find a module capable of providing the feature you want, simply
1812 * call this method with the feature name you are looking for.
1813 * @param FeatureName The feature name you wish to obtain the module for
1814 * @returns A pointer to a valid module class on success, NULL on failure.
1816 Module* FindFeature(const std::string &FeatureName);
1818 /** Find an 'interface'.
1819 * An interface is a list of modules which all implement the same API.
1820 * @param InterfaceName The Interface you wish to obtain the module
1822 * @return A pointer to a deque of Module*, or NULL if the interface
1825 modulelist* FindInterface(const std::string &InterfaceName);
1827 /** Given a pointer to a Module, return its filename
1828 * @param m The module pointer to identify
1829 * @return The module name or an empty string
1831 const std::string& GetModuleName(Module* m);
1833 /** Return a list of all modules matching the given filter
1834 * @param filter This int is a bitmask of flags set in Module::Flags,
1835 * such as VF_VENDOR or VF_STATIC. If you wish to receive a list of
1836 * all modules with no filtering, set this to 0.
1837 * @return The list of module names
1839 const std::vector<std::string> GetAllModuleNames(int filter);
1842 /** This definition is used as shorthand for the various classes
1843 * and functions needed to make a module loadable by the OS.
1844 * It defines the class factory and external init_module function.
1846 #define MODULE_INIT(y) \
1847 extern "C" DllExport Module * init_module(InspIRCd* Me) \