1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
21 /** Used with OnAccessCheck() method of modules
23 enum AccessControlType {
24 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
25 ACR_DENY, // deny the action
26 ACR_ALLOW, // allow the action
27 AC_KICK, // a user is being kicked
28 AC_DEOP, // a user is being deopped
29 AC_OP, // a user is being opped
30 AC_VOICE, // a user is being voiced
31 AC_DEVOICE, // a user is being devoiced
32 AC_HALFOP, // a user is being halfopped
33 AC_DEHALFOP, // a user is being dehalfopped
34 AC_INVITE, // a user is being invited
35 AC_GENERAL_MODE // a channel mode is being changed
38 /** Used to define a set of behavior bits for a module
41 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
42 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
43 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
44 VF_COMMON = 8 // module needs to be common on all servers in a network to link
52 enum TargetTypeFlags {
68 #include "inspsocket.h"
76 /** If you change the module API, change this value.
77 * If you have enabled ipv6, the sizes of structs is
78 * different, and modules will be incompatible with
79 * ipv4 servers, so this value will be ten times as
80 * high on ipv6 servers.
82 #define NATIVE_API_VERSION 11007
84 #define API_VERSION (NATIVE_API_VERSION * 10)
86 #define API_VERSION (NATIVE_API_VERSION * 1)
91 /* Forward-delacare module for ModuleMessage etc
95 /** Low level definition of a FileReader classes file cache area
97 typedef std::deque<std::string> file_cache;
98 typedef file_cache string_list;
100 /** Holds a list of 'published features' for modules.
102 typedef std::map<std::string,Module*> featurelist;
104 /** Holds a list of modules which implement an interface
106 typedef std::deque<Module*> modulelist;
108 /** Holds a list of all modules which implement interfaces, by interface name
110 typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
113 * This #define allows us to call a method in all
114 * loaded modules in a readable simple way, e.g.:
115 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
117 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
118 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
119 if (ServerInstance->Config->implement_lists[_i][y]) \
122 ServerInstance->modules[_i]->x ; \
124 catch (ModuleException& modexcept) \
126 ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
131 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
132 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
133 if (z->Config->implement_lists[_i][y]) \
136 z->modules[_i]->x ; \
138 catch (ModuleException& modexcept) \
140 z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
145 * This define is similar to the one above but returns a result in MOD_RESULT.
146 * The first module to return a nonzero result is the value to be accepted,
147 * and any modules after are ignored.
149 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
151 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
152 if (ServerInstance->Config->implement_lists[_i][y]) { \
155 int res = ServerInstance->modules[_i]->x ; \
161 catch (ModuleException& modexcept) \
163 ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
170 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
172 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
173 if (z->Config->implement_lists[_i][y]) { \
176 int res = z->modules[_i]->x ; \
182 catch (ModuleException& modexcept) \
184 z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
191 #define FD_MAGIC_NUMBER -42
195 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
196 #define IS_REMOTE(x) (x->GetFd() < 0)
197 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
199 /** Holds a module's Version information
200 * The four members (set by the constructor only) indicate details as to the version number
201 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
203 class Version : public classbase
206 const int Major, Minor, Revision, Build, Flags, API;
207 Version(int major, int minor, int revision, int build, int flags, int api_ver);
210 /** The ModuleMessage class is the base class of Request and Event
211 * This class is used to represent a basic data structure which is passed
212 * between modules for safe inter-module communications.
214 class ModuleMessage : public Extensible
217 virtual ~ModuleMessage() {};
220 /** The Request class is a unicast message directed at a given module.
221 * When this class is properly instantiated it may be sent to a module
222 * using the Send() method, which will call the given module's OnRequest
223 * method with this class as its parameter.
225 class Request : public ModuleMessage
228 /** This member holds a pointer to arbitary data set by the emitter of the message
231 /** This should be a null-terminated string identifying the type of request,
232 * all modules should define this and use it to determine the nature of the
233 * request before they attempt to cast the Request in any way.
236 /** This is a pointer to the sender of the message, which can be used to
237 * directly trigger events, or to create a reply.
240 /** The single destination of the Request
244 /** Create a new Request
245 * This is for the 'old' way of casting whatever the data is
246 * to char* and hoping you get the right thing at the other end.
247 * This is slowly being depreciated in favor of the 'new' way.
249 Request(char* anydata, Module* src, Module* dst);
250 /** Create a new Request
251 * This is for the 'new' way of defining a subclass
252 * of Request and defining it in a common header,
253 * passing an object of your Request subclass through
254 * as a Request* and using the ID string to determine
255 * what to cast it back to and the other end. This is
256 * much safer as there are no casts not confirmed by
257 * the ID string, and all casts are child->parent and
258 * can be checked at runtime with dynamic_cast<>()
260 Request(Module* src, Module* dst, const char* idstr);
261 /** Fetch the Request data
264 /** Fetch the ID string
267 /** Fetch the request source
270 /** Fetch the request destination (should be 'this' in the receiving module)
273 /** Send the Request.
274 * Upon returning the result will be arbitary data returned by the module you
275 * sent the request to. It is up to your module to know what this data is and
276 * how to deal with it.
282 /** The Event class is a unicast message directed at all modules.
283 * When the class is properly instantiated it may be sent to all modules
284 * using the Send() method, which will trigger the OnEvent method in
285 * all modules passing the object as its parameter.
287 class Event : public ModuleMessage
290 /** This member holds a pointer to arbitary data set by the emitter of the message
293 /** This is a pointer to the sender of the message, which can be used to
294 * directly trigger events, or to create a reply.
297 /** The event identifier.
298 * This is arbitary text which should be used to distinguish
299 * one type of event from another.
303 /** Create a new Event
305 Event(char* anydata, Module* src, const std::string &eventid);
306 /** Get the Event data
309 /** Get the event Source
312 /** Get the event ID.
313 * Use this to determine the event type for safe casting of the data
315 std::string GetEventID();
317 * The return result of an Event::Send() will always be NULL as
318 * no replies are expected.
320 char* Send(InspIRCd* ServerInstance);
323 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
324 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
325 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
326 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
327 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
329 class ModuleException : public std::exception
332 /** Holds the error message to be displayed
336 /** Default constructor, just uses the error mesage 'Module threw an exception'.
338 ModuleException() : err("Module threw an exception") {}
339 /** This constructor can be used to specify an error message before throwing.
341 ModuleException(std::string message) : err(message) {}
342 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
343 * Actually no, it does nothing. Never mind.
346 virtual ~ModuleException() throw() {};
347 /** Returns the reason for the exception.
348 * The module should probably put something informative here as the user will see this upon failure.
350 virtual const char* GetReason()
356 /** Priority types which can be returned from Module::Prioritize()
358 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
360 /** Implementation-specific flags which may be set in Module::Implements()
362 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
363 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
364 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
365 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
366 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
367 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
368 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
369 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
370 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
371 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
372 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
373 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
374 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect };
376 /** Base class for all InspIRCd modules
377 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
378 * its methods will be called when irc server events occur. class inherited from module must be
379 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
381 class Module : public Extensible
384 InspIRCd* ServerInstance;
387 /** Default constructor
388 * Creates a module class.
389 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
390 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
392 Module(InspIRCd* Me);
394 /** Default destructor
395 * destroys a module class
399 /** Returns the version number of a Module.
400 * The method should return a Version object with its version information assigned via
403 virtual Version GetVersion();
405 /** The Implements function specifies which methods a module should receive events for.
406 * The char* parameter passed to this function contains a set of true or false values
407 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
408 * enum (documented elsewhere on this page) to mark functions as active. For example, to
409 * receive events for OnUserJoin():
411 * Implements[I_OnUserJoin] = 1;
413 * @param The implement list
415 virtual void Implements(char* Implements);
417 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
418 * Some modules prefer to be called before other modules, due to their design. For example, a
419 * module which is expected to operate on complete information would expect to be placed last, so
420 * that any other modules which wish to adjust that information would execute before it, to be sure
421 * its information is correct. You can change your module's priority by returning one of:
423 * PRIORITY_FIRST - To place your module first in the list
425 * PRIORITY_LAST - To place your module last in the list
427 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
429 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
431 * The result of InspIRCd::PriorityLast() - To move your module after another named module
433 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
434 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
435 * your module has a real need to reorder its priority, it should not implement this function,
436 * as many modules changing their priorities can make the system redundant.
438 virtual Priority Prioritize();
440 /** Called when a user connects.
441 * The details of the connecting user are available to you in the parameter userrec *user
442 * @param user The user who is connecting
444 virtual void OnUserConnect(userrec* user);
446 /** Called when a user quits.
447 * The details of the exiting user are available to you in the parameter userrec *user
448 * This event is only called when the user is fully registered when they quit. To catch
449 * raw disconnections, use the OnUserDisconnect method.
450 * @param user The user who is quitting
451 * @param message The user's quit message
453 virtual void OnUserQuit(userrec* user, const std::string &message);
455 /** Called whenever a user's socket is closed.
456 * The details of the exiting user are available to you in the parameter userrec *user
457 * This event is called for all users, registered or not, as a cleanup method for modules
458 * which might assign resources to user, such as dns lookups, objects and sockets.
459 * @param user The user who is disconnecting
461 virtual void OnUserDisconnect(userrec* user);
463 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
464 * @param chan The channel being deleted
466 virtual void OnChannelDelete(chanrec* chan);
468 /** Called when a user joins a channel.
469 * The details of the joining user are available to you in the parameter userrec *user,
470 * and the details of the channel they have joined is available in the variable chanrec *channel
471 * @param user The user who is joining
472 * @param channel The channel being joined
474 virtual void OnUserJoin(userrec* user, chanrec* channel);
476 /** Called after a user joins a channel
477 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
479 * @param user The user who is joining
480 * @param channel The channel being joined
482 virtual void OnPostJoin(userrec* user, chanrec* channel);
484 /** Called when a user parts a channel.
485 * The details of the leaving user are available to you in the parameter userrec *user,
486 * and the details of the channel they have left is available in the variable chanrec *channel
487 * @param user The user who is parting
488 * @param channel The channel being parted
489 * @param partmessage The part message, or an empty string
491 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
493 /** Called on rehash.
494 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
495 * system. You should use it to reload any files so that your module keeps in step with the
496 * rest of the application. If a parameter is given, the core has done nothing. The module
497 * receiving the event can decide if this parameter has any relevence to it.
498 * @param parameter The (optional) parameter given to REHASH from the user.
500 virtual void OnRehash(const std::string ¶meter);
502 /** Called when a raw command is transmitted or received.
503 * This method is the lowest level of handler available to a module. It will be called with raw
504 * data which is passing through a connected socket. If you wish, you may munge this data by changing
505 * the string parameter "raw". If you do this, after your function exits it will immediately be
506 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
507 * inbound is set to true) the value of user will be the userrec of the connection sending the
508 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
509 * @param raw The raw string in RFC1459 format
510 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
511 * @param user The user record sending the text, when inbound == true.
513 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
515 /** Called whenever a user is about to join a channel, before any processing is done.
516 * Returning a value of 1 from this function stops the process immediately, causing no
517 * output to be sent to the user by the core. If you do this you must produce your own numerics,
518 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
519 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
523 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
524 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
525 * processing on the actual channel record at this point, however the channel NAME will still be passed in
526 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
527 * @param user The user joining the channel
528 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
529 * @param cname The channel name being joined. For new channels this is valid where chan is not.
530 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
531 * You may alter this string to alter the user's modes on the channel.
532 * @return 1 To prevent the join, 0 to allow it.
534 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
536 /** Called whenever a user is about to be kicked.
537 * Returning a value of 1 from this function stops the process immediately, causing no
538 * output to be sent to the user by the core. If you do this you must produce your own numerics,
540 * @param source The user issuing the kick
541 * @param user The user being kicked
542 * @param chan The channel the user is being kicked from
543 * @param reason The kick reason
544 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
546 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
548 /** Called whenever a user is kicked.
549 * If this method is called, the kick is already underway and cannot be prevented, so
550 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
551 * @param source The user issuing the kick
552 * @param user The user being kicked
553 * @param chan The channel the user is being kicked from
554 * @param reason The kick reason
556 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
558 /** Called whenever a user opers locally.
559 * The userrec will contain the oper mode 'o' as this function is called after any modifications
560 * are made to the user's structure by the core.
561 * @param user The user who is opering up
562 * @param opertype The opers type name
564 virtual void OnOper(userrec* user, const std::string &opertype);
566 /** Called after a user opers locally.
567 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
568 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
569 * out the OPERTYPE, etc.
570 * @param user The user who is opering up
571 * @param opertype The opers type name
573 virtual void OnPostOper(userrec* user, const std::string &opertype);
575 /** Called whenever a user types /INFO.
576 * The userrec will contain the information of the user who typed the command. Modules may use this
577 * method to output their own credits in /INFO (which is the ircd's version of an about box).
578 * It is purposefully not possible to modify any info that has already been output, or halt the list.
579 * You must write a 371 numeric to the user, containing your info in the following format:
581 * <nick> :information here
583 * @param user The user issuing /INFO
585 virtual void OnInfo(userrec* user);
587 /** Called whenever a /WHOIS is performed on a local user.
588 * The source parameter contains the details of the user who issued the WHOIS command, and
589 * the dest parameter contains the information of the user they are whoising.
590 * @param source The user issuing the WHOIS command
591 * @param dest The user who is being WHOISed
593 virtual void OnWhois(userrec* source, userrec* dest);
595 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
596 * Returning 1 from this function stops the process immediately, causing no
597 * output to be sent to the user by the core. If you do this you must produce your own numerics,
598 * notices etc. This is useful for modules which may want to filter invites to channels.
599 * @param source The user who is issuing the INVITE
600 * @param dest The user being invited
601 * @param channel The channel the user is being invited to
602 * @return 1 to deny the invite, 0 to allow
604 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
606 /** Called after a user has been successfully invited to a channel.
607 * You cannot prevent the invite from occuring using this function, to do that,
608 * use OnUserPreInvite instead.
609 * @param source The user who is issuing the INVITE
610 * @param dest The user being invited
611 * @param channel The channel the user is being invited to
613 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
615 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
616 * Returning any nonzero value from this function stops the process immediately, causing no
617 * output to be sent to the user by the core. If you do this you must produce your own numerics,
618 * notices etc. This is useful for modules which may want to filter or redirect messages.
619 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
620 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
621 * of where the message is destined to be sent.
622 * @param user The user sending the message
623 * @param dest The target of the message (chanrec* or userrec*)
624 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
625 * @param text Changeable text being sent by the user
626 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
627 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
628 * It will be ignored for private messages.
629 * @return 1 to deny the NOTICE, 0 to allow it
631 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
633 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
634 * Returning any nonzero value from this function stops the process immediately, causing no
635 * output to be sent to the user by the core. If you do this you must produce your own numerics,
636 * notices etc. This is useful for modules which may want to filter or redirect messages.
637 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
638 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
639 * of where the message is destined to be sent.
640 * You may alter the message text as you wish before relinquishing control to the next module
641 * in the chain, and if no other modules block the text this altered form of the text will be sent out
642 * to the user and possibly to other servers.
643 * @param user The user sending the message
644 * @param dest The target of the message (chanrec* or userrec*)
645 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
646 * @param text Changeable text being sent by the user
647 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
648 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
649 * It will be ignored for private notices.
650 * @return 1 to deny the NOTICE, 0 to allow it
652 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
654 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
655 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
656 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
657 * @param chan The channel to build the exempt list of
658 * @param sender The original sender of the PRIVMSG or NOTICE
659 * @param status The status char to be used for the channel list
660 * @param exempt_list The exempt list to be populated
662 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
664 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
665 * Please note that although you can see remote nickchanges through this function, you should
666 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
667 * check user->server before taking any action (including returning nonzero from the method).
668 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
669 * module to generate some meaninful output.
670 * @param user The username changing their nick
671 * @param newnick Their new nickname
672 * @return 1 to deny the change, 0 to allow
674 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
676 /** Called after any PRIVMSG sent from a user.
677 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
678 * if target_type is TYPE_CHANNEL.
679 * @param user The user sending the message
680 * @param dest The target of the message
681 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
682 * @param text the text being sent by the user
683 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
685 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
687 /** Called after any NOTICE sent from a user.
688 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
689 * if target_type is TYPE_CHANNEL.
690 * @param user The user sending the message
691 * @param dest The target of the message
692 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
693 * @param text the text being sent by the user
694 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
696 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
698 /** Called after every MODE command sent from a user
699 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
700 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
701 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
702 * @param user The user sending the MODEs
703 * @param dest The target of the modes (userrec* or chanrec*)
704 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
705 * @param text The actual modes and their parameters if any
707 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
709 /** Allows modules to alter or create server descriptions
710 * Whenever a module requires a server description, for example for display in
711 * WHOIS, this function is called in all modules. You may change or define the
712 * description given in std::string &description. If you do, this description
713 * will be shown in the WHOIS fields.
714 * @param servername The servername being searched for
715 * @param description Alterable server description for this server
717 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
719 /** Allows modules to synchronize data which relates to users during a netburst.
720 * When this function is called, it will be called from the module which implements
721 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
722 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
723 * (see below). This function will be called for every user visible on your side
724 * of the burst, allowing you to for example set modes, etc. Do not use this call to
725 * synchronize data which you have stored using class Extensible -- There is a specialist
726 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
727 * @param user The user being syncronized
728 * @param proto A pointer to the module handling network protocol
729 * @param opaque An opaque pointer set by the protocol module, should not be modified!
731 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
733 /** Allows modules to synchronize data which relates to channels during a netburst.
734 * When this function is called, it will be called from the module which implements
735 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
736 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
737 * (see below). This function will be called for every user visible on your side
738 * of the burst, allowing you to for example set modes, etc. Do not use this call to
739 * synchronize data which you have stored using class Extensible -- There is a specialist
740 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
742 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
744 * @param chan The channel being syncronized
745 * @param proto A pointer to the module handling network protocol
746 * @param opaque An opaque pointer set by the protocol module, should not be modified!
748 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
750 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
751 * Whenever the linking module wants to send out data, but doesnt know what the data
752 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
753 * this method is called.You should use the ProtoSendMetaData function after you've
754 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
755 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
756 * @param chan The channel whos metadata is being syncronized
757 * @param proto A pointer to the module handling network protocol
758 * @param opaque An opaque pointer set by the protocol module, should not be modified!
759 * @param extname The extensions name which is being searched for
761 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
763 /* Allows modules to syncronize metadata related to users over the network during a netburst.
764 * Whenever the linking module wants to send out data, but doesnt know what the data
765 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
766 * this method is called. You should use the ProtoSendMetaData function after you've
767 * correctly decided how the data should be represented, to send the metadata on its way if
768 * if it belongs to your module.
769 * @param user The user whos metadata is 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!
772 * @param extname The extensions name which is being searched for
774 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
776 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
777 * Whenever the linking module wants to send out data, but doesnt know what the data
778 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
779 * this method is called. You should use the ProtoSendMetaData function after you've
780 * correctly decided how the data should be represented, to send the metadata on its way if
781 * if it belongs to your module.
782 * @param proto A pointer to the module handling network protocol
783 * @param opaque An opaque pointer set by the protocol module, should not be modified!
785 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
787 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
788 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
789 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
790 * @param target The chanrec* or userrec* that data should be added to
791 * @param extname The extension name which is being sent
792 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
794 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
796 /** Implemented by modules which provide the ability to link servers.
797 * These modules will implement this method, which allows transparent sending of servermodes
798 * down the network link as a broadcast, without a module calling it having to know the format
799 * of the MODE command before the actual mode string.
801 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
802 * of how to use this function.
804 * @param opaque An opaque pointer set by the protocol module, should not be modified!
805 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
806 * @param target The chanrec* or userrec* that modes should be sent for
807 * @param modeline The modes and parameters to be sent
809 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
811 /** Implemented by modules which provide the ability to link servers.
812 * These modules will implement this method, which allows metadata (extra data added to
813 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
814 * to other servers on a netburst and decoded at the other end by the same module on a
817 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
818 * 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 chanrec* or userrec* that metadata should be sent for
822 * @param extname The extension name to send metadata for
823 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
825 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
827 /** Called after every WALLOPS command.
828 * @param user The user sending the WALLOPS
829 * @param text The content of the WALLOPS message
831 virtual void OnWallops(userrec* user, const std::string &text);
833 /** Called whenever a user's hostname is changed.
834 * This event triggers after the host has been set.
835 * @param user The user whos host is being changed
836 * @param newhost The new hostname being set
838 virtual void OnChangeHost(userrec* user, const std::string &newhost);
840 /** Called whenever a user's GECOS (realname) is changed.
841 * This event triggers after the name has been set.
842 * @param user The user who's GECOS is being changed
843 * @param gecos The new GECOS being set on the user
845 virtual void OnChangeName(userrec* user, const std::string &gecos);
847 /** Called whenever a gline is added by a local user.
848 * This method is triggered after the line is added.
849 * @param duration The duration of the line in seconds
850 * @param source The sender of the line
851 * @param reason The reason text to be displayed
852 * @param hostmask The hostmask to add
854 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
856 /** Called whenever a zline is added by a local user.
857 * This method is triggered after the line is added.
858 * @param duration The duration of the line in seconds
859 * @param source The sender of the line
860 * @param reason The reason text to be displayed
861 * @param ipmask The hostmask to add
863 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
865 /** Called whenever a kline is added by a local user.
866 * This method is triggered after the line is added.
867 * @param duration The duration of the line in seconds
868 * @param source The sender of the line
869 * @param reason The reason text to be displayed
870 * @param hostmask The hostmask to add
872 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
874 /** Called whenever a qline is added by a local user.
875 * This method is triggered after the line is added.
876 * @param duration The duration of the line in seconds
877 * @param source The sender of the line
878 * @param reason The reason text to be displayed
879 * @param nickmask The hostmask to add
881 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
883 /** Called whenever a eline is added by a local user.
884 * This method is triggered after the line is added.
885 * @param duration The duration of the line in seconds
886 * @param source The sender of the line
887 * @param reason The reason text to be displayed
888 * @param hostmask The hostmask to add
890 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
892 /** Called whenever a gline is deleted.
893 * This method is triggered after the line is deleted.
894 * @param source The user removing the line
895 * @param hostmask The hostmask to delete
897 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
899 /** Called whenever a zline is deleted.
900 * This method is triggered after the line is deleted.
901 * @param source The user removing the line
902 * @param hostmask The hostmask to delete
904 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
906 /** Called whenever a kline is deleted.
907 * This method is triggered after the line is deleted.
908 * @param source The user removing the line
909 * @param hostmask The hostmask to delete
911 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
913 /** Called whenever a qline is deleted.
914 * This method is triggered after the line is deleted.
915 * @param source The user removing the line
916 * @param hostmask The hostmask to delete
918 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
920 /** Called whenever a eline is deleted.
921 * This method is triggered after the line is deleted.
922 * @param source The user removing the line
923 * @param hostmask The hostmask to delete
925 virtual void OnDelELine(userrec* source, const std::string &hostmask);
927 /** Called before your module is unloaded to clean up Extensibles.
928 * This method is called once for every user and channel on the network,
929 * so that when your module unloads it may clear up any remaining data
930 * in the form of Extensibles added using Extensible::Extend().
931 * If the target_type variable is TYPE_USER, then void* item refers to
932 * a userrec*, otherwise it refers to a chanrec*.
933 * @param target_type The type of item being cleaned
934 * @param item A pointer to the item's class
936 virtual void OnCleanup(int target_type, void* item);
938 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
939 * have been applied. Please note that although you can see remote nickchanges through this function, you should
940 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
941 * check user->server before taking any action (including returning nonzero from the method).
942 * Because this method is called after the nickchange is taken place, no return values are possible
943 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
944 * @param user The user changing their nick
945 * @param oldnick The old nickname of the user before the nickchange
947 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
949 /** Called before an action which requires a channel privilage check.
950 * This function is called before many functions which check a users status on a channel, for example
951 * before opping a user, deopping a user, kicking a user, etc.
952 * There are several values for access_type which indicate for what reason access is being checked.
954 * AC_KICK (0) - A user is being kicked<br>
955 * AC_DEOP (1) - a user is being deopped<br>
956 * AC_OP (2) - a user is being opped<br>
957 * AC_VOICE (3) - a user is being voiced<br>
958 * AC_DEVOICE (4) - a user is being devoiced<br>
959 * AC_HALFOP (5) - a user is being halfopped<br>
960 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
961 * AC_INVITE () - a user is being invited<br>
962 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
963 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
964 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
965 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
966 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
967 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
968 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
969 * @param source The source of the access check
970 * @param dest The destination of the access check
971 * @param channel The channel which is being checked
972 * @param access_type See above
974 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
976 /** Called when a 005 numeric is about to be output.
977 * The module should modify the 005 numeric if needed to indicate its features.
978 * @param output The 005 string to be modified if neccessary.
980 virtual void On005Numeric(std::string &output);
982 /** Called when a client is disconnected by KILL.
983 * If a client is killed by a server, e.g. a nickname collision or protocol error,
985 * Return 1 from this function to prevent the kill, and 0 from this function to allow
986 * it as normal. If you prevent the kill no output will be sent to the client, it is
987 * down to your module to generate this information.
988 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
989 * If you do so youre risking race conditions, desyncs and worse!
990 * @param source The user sending the KILL
991 * @param dest The user being killed
992 * @param reason The kill reason
993 * @return 1 to prevent the kill, 0 to allow
995 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
997 /** Called when an oper wants to disconnect a remote user via KILL
998 * @param source The user sending the KILL
999 * @param dest The user being killed
1000 * @param reason The kill reason
1002 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
1004 /** Called whenever a module is loaded.
1005 * mod will contain a pointer to the module, and string will contain its name,
1006 * for example m_widgets.so. This function is primary for dependency checking,
1007 * your module may decide to enable some extra features if it sees that you have
1008 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1009 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1010 * but instead operate under reduced functionality, unless the dependency is
1011 * absolutely neccessary (e.g. a module that extends the features of another
1013 * @param mod A pointer to the new module
1014 * @param name The new module's filename
1016 virtual void OnLoadModule(Module* mod,const std::string &name);
1018 /** Called whenever a module is unloaded.
1019 * mod will contain a pointer to the module, and string will contain its name,
1020 * for example m_widgets.so. This function is primary for dependency checking,
1021 * your module may decide to enable some extra features if it sees that you have
1022 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1023 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1024 * but instead operate under reduced functionality, unless the dependency is
1025 * absolutely neccessary (e.g. a module that extends the features of another
1027 * @param mod Pointer to the module being unloaded (still valid)
1028 * @param name The filename of the module being unloaded
1030 virtual void OnUnloadModule(Module* mod,const std::string &name);
1032 /** Called once every five seconds for background processing.
1033 * This timer can be used to control timed features. Its period is not accurate
1034 * enough to be used as a clock, but it is gauranteed to be called at least once in
1035 * any five second period, directly from the main loop of the server.
1036 * @param curtime The current timer derived from time(2)
1038 virtual void OnBackgroundTimer(time_t curtime);
1040 /** Called whenever any command is about to be executed.
1041 * This event occurs for all registered commands, wether they are registered in the core,
1042 * or another module, and for invalid commands. Invalid commands may only be sent to this
1043 * function when the value of validated is false. By returning 1 from this method you may prevent the
1044 * command being executed. If you do this, no output is created by the core, and it is
1045 * down to your module to produce any output neccessary.
1046 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1047 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1048 * method returns, it will be passed an invalid pointer to the user object and crash!)
1049 * @param command The command being executed
1050 * @param parameters An array of array of characters containing the parameters for the command
1051 * @param pcnt The nuimber of parameters passed to the command
1052 * @param user the user issuing the command
1053 * @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.
1054 * @param original_line The entire original line as passed to the parser from the user
1055 * @return 1 to block the command, 0 to allow
1057 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1059 /** Called after any command has been executed.
1060 * This event occurs for all registered commands, wether they are registered in the core,
1061 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1062 * exist within the command table). The result code returned by the command handler is
1064 * @param command The command being executed
1065 * @param parameters An array of array of characters containing the parameters for the command
1066 * @param pcnt The nuimber of parameters passed to the command
1067 * @param user the user issuing the command
1068 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1069 * @param original_line The entire original line as passed to the parser from the user
1071 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1073 /** Called to check if a user who is connecting can now be allowed to register
1074 * If any modules return false for this function, the user is held in the waiting
1075 * state until all modules return true. For example a module which implements ident
1076 * lookups will continue to return false for a user until their ident lookup is completed.
1077 * Note that the registration timeout for a user overrides these checks, if the registration
1078 * timeout is reached, the user is disconnected even if modules report that the user is
1079 * not ready to connect.
1080 * @param user The user to check
1081 * @return true to indicate readiness, false if otherwise
1083 virtual bool OnCheckReady(userrec* user);
1085 /** Called whenever a user is about to register their connection (e.g. before the user
1086 * is sent the MOTD etc). Modules can use this method if they are performing a function
1087 * which must be done before the actual connection is completed (e.g. ident lookups,
1088 * dnsbl lookups, etc).
1089 * Note that you should NOT delete the user record here by causing a disconnection!
1090 * Use OnUserConnect for that instead.
1091 * @param user The user registering
1092 * @return 1 to indicate user quit, 0 to continue
1094 virtual int OnUserRegister(userrec* user);
1096 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1097 * This method will always be called for each join, wether or not the channel is actually +i, and
1098 * determines the outcome of an if statement around the whole section of invite checking code.
1099 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1100 * @param user The user joining the channel
1101 * @param chan The channel being joined
1102 * @return 1 to explicitly allow the join, 0 to proceed as normal
1104 virtual int OnCheckInvite(userrec* user, chanrec* chan);
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(userrec* user, chanrec* 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(userrec* user, chanrec* 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(userrec* user, chanrec* 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, userrec* 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(userrec* 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(userrec* 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(userrec* user, chanrec* 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(userrec* user, chanrec* 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(userrec* 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(userrec* 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(userrec* source, chanrec* 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(userrec* source, chanrec* 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 virtual void OnRawSocketConnect(int fd);
1275 /** Called immediately before any read() operation on a client socket in the core.
1276 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1277 * when this event occurs.
1278 * Your event should return 1 if it has handled the reading itself, which prevents the core
1279 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1280 * the value of count. The value of readresult must be identical to an actual result that might
1281 * be returned from the read() system call, for example, number of bytes read upon success,
1282 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1283 * you MUST set readresult.
1284 * @param fd The file descriptor of the socket
1285 * @param buffer A char* buffer being read to
1286 * @param count The size of the buffer
1287 * @param readresult The amount of characters read, or 0
1288 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1290 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1292 /** Called whenever a user sets away.
1293 * This method has no parameter for the away message, as it is available in the
1294 * user record as userrec::awaymsg.
1296 virtual void OnSetAway(userrec* user);
1298 /** Called when a user cancels their away state.
1300 virtual void OnCancelAway(userrec* user);
1302 /** Called whenever a NAMES list is requested.
1303 * You can produce the nameslist yourself, overriding the current list,
1304 * and if you do you must return 1. If you do not handle the names list,
1307 virtual int OnUserList(userrec* user, chanrec* Ptr);
1309 /** Called whenever a line of WHOIS output is sent to a user.
1310 * You may change the numeric and the text of the output by changing
1311 * the values numeric and text, but you cannot change the user the
1312 * numeric is sent to. You may however change the user's userrec values.
1313 * @param user The user the numeric is being sent to
1314 * @param dest The user being WHOISed
1315 * @param numeric The numeric of the line being sent
1316 * @param text The text of the numeric, including any parameters
1317 * @return nonzero to drop the line completely so that the user does not
1318 * receive it, or zero to allow the line to be sent.
1320 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1324 #define CONF_NOT_A_NUMBER 0x000010
1325 #define CONF_NOT_UNSIGNED 0x000080
1326 #define CONF_VALUE_NOT_FOUND 0x000100
1327 #define CONF_FILE_NOT_FOUND 0x000200
1330 /** Allows reading of values from configuration files
1331 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1332 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1333 * Constructing the class using one parameter allows you to specify a path to your own configuration
1334 * file, otherwise, inspircd.conf is read.
1336 class ConfigReader : public classbase
1339 InspIRCd* ServerInstance;
1340 /** The contents of the configuration file
1341 * This protected member should never be accessed by a module (and cannot be accessed unless the
1342 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1343 * (such as comments) stripped from it.
1345 ConfigDataHash* data;
1346 std::ostringstream* errorlog;;
1347 /** Used to store errors
1349 bool privatehash; // If we're using our own config data hash or not.
1354 /** Default constructor.
1355 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1356 * as specified when running ./configure.
1358 ConfigReader(InspIRCd* Instance);
1359 /** Overloaded constructor.
1360 * This constructor initialises the ConfigReader class to read a user-specified config file
1362 ConfigReader(InspIRCd* Instance, const std::string &filename);
1363 /** Default destructor.
1364 * This method destroys the ConfigReader class.
1367 /** Retrieves a value from the config file.
1368 * This method retrieves a value from the config file. Where multiple copies of the tag
1369 * exist in the config file, index indicates which of the values to retrieve.
1371 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1372 /** Retrieves a boolean value from the config file.
1373 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1374 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1375 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1377 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1378 /** Retrieves an integer value from the config file.
1379 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1380 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1381 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1382 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1383 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1384 * will return CONF_NOT_UNSIGNED
1386 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1387 /** Returns the last error to occur.
1388 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1389 * A call to GetError() resets the error flag back to 0.
1392 /** Counts the number of times a given tag appears in the config file.
1393 * This method counts the number of times a tag appears in a config file, for use where
1394 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1395 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1396 * multiple instance tag.
1398 int Enumerate(const std::string &tag);
1399 /** Returns true if a config file is valid.
1400 * This method is partially implemented and will only return false if the config
1401 * file does not exist or could not be opened.
1404 /** Dumps the list of errors in a config file to an output location. If bail is true,
1405 * then the program will abort. If bail is false and user points to a valid user
1406 * record, the error report will be spooled to the given user by means of NOTICE.
1407 * if bool is false AND user is false, the error report will be spooled to all opers
1408 * by means of a NOTICE to all opers.
1410 void DumpErrors(bool bail,userrec* user);
1412 /** Returns the number of items within a tag.
1413 * For example if the tag was <test tag="blah" data="foo"> then this
1414 * function would return 2. Spaces and newlines both qualify as valid seperators
1417 int EnumerateValues(const std::string &tag, int index);
1422 /** Caches a text file into memory and can be used to retrieve lines from it.
1423 * This class contains methods for read-only manipulation of a text file in memory.
1424 * Either use the constructor type with one parameter to load a file into memory
1425 * at construction, or use the LoadFile method to load a file.
1427 class FileReader : public classbase
1429 InspIRCd* ServerInstance;
1430 /** The file contents
1434 unsigned long contentsize;
1439 /** Default constructor.
1440 * This method does not load any file into memory, you must use the LoadFile method
1441 * after constructing the class this way.
1443 FileReader(InspIRCd* Instance);
1445 /** Secondary constructor.
1446 * This method initialises the class with a file loaded into it ready for GetLine and
1447 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1450 FileReader(InspIRCd* Instance, const std::string &filename);
1452 /** Default destructor.
1453 * This deletes the memory allocated to the file.
1457 /** Used to load a file.
1458 * This method loads a file into the class ready for GetLine and
1459 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1462 void LoadFile(const std::string &filename);
1464 /** Returns the whole content of the file as std::string
1466 std::string Contents();
1468 /** Returns the entire size of the file as std::string
1470 unsigned long ContentSize();
1472 /** Returns true if the file exists
1473 * This function will return false if the file could not be opened.
1477 /** Retrieve one line from the file.
1478 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1479 * the index was out of bounds, or the line had no data on it.
1481 std::string GetLine(int x);
1483 /** Returns the size of the file in lines.
1484 * This method returns the number of lines in the read file. If it is 0, no lines have been
1485 * read into memory, either because the file is empty or it does not exist, or cannot be
1486 * opened due to permission problems.
1492 /** Instantiates classes inherited from Module.
1493 * This class creates a class inherited from type Module, using new. This is to allow for modules
1494 * to create many different variants of Module, dependent on architecture, configuration, etc.
1495 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1498 class ModuleFactory : public classbase
1501 /** The default constructor does nothing.
1504 /** The default destructor does nothing
1506 virtual ~ModuleFactory() { }
1507 /** Creates a new module.
1508 * Your inherited class of ModuleFactory must return a pointer to your Module class
1509 * using this method.
1511 virtual Module * CreateModule(InspIRCd* Me) = 0;
1514 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1516 typedef DLLFactory<ModuleFactory> ircd_module;
1518 /** A list of loaded Modules
1520 typedef std::vector<Module*> ModuleList;
1522 /** A list of loaded ModuleFactories
1524 typedef std::vector<ircd_module*> FactoryList;