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 11006
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;
105 * This #define allows us to call a method in all
106 * loaded modules in a readable simple way, e.g.:
107 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
109 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
110 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
111 if (ServerInstance->Config->implement_lists[_i][y]) \
114 ServerInstance->modules[_i]->x ; \
116 catch (ModuleException& modexcept) \
118 ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
123 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
124 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
125 if (z->Config->implement_lists[_i][y]) \
128 z->modules[_i]->x ; \
130 catch (ModuleException& modexcept) \
132 z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
137 * This define is similar to the one above but returns a result in MOD_RESULT.
138 * The first module to return a nonzero result is the value to be accepted,
139 * and any modules after are ignored.
141 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
143 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
144 if (ServerInstance->Config->implement_lists[_i][y]) { \
147 int res = ServerInstance->modules[_i]->x ; \
153 catch (ModuleException& modexcept) \
155 ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
162 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
164 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
165 if (z->Config->implement_lists[_i][y]) { \
168 int res = z->modules[_i]->x ; \
174 catch (ModuleException& modexcept) \
176 z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
183 #define FD_MAGIC_NUMBER -42
187 #define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
188 #define IS_REMOTE(x) (x->GetFd() < 0)
189 #define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
191 /** Holds a module's Version information
192 * The four members (set by the constructor only) indicate details as to the version number
193 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
195 class Version : public classbase
198 const int Major, Minor, Revision, Build, Flags, API;
199 Version(int major, int minor, int revision, int build, int flags, int api_ver);
202 /** The ModuleMessage class is the base class of Request and Event
203 * This class is used to represent a basic data structure which is passed
204 * between modules for safe inter-module communications.
206 class ModuleMessage : public Extensible
209 virtual ~ModuleMessage() {};
212 /** The Request class is a unicast message directed at a given module.
213 * When this class is properly instantiated it may be sent to a module
214 * using the Send() method, which will call the given module's OnRequest
215 * method with this class as its parameter.
217 class Request : public ModuleMessage
220 /** This member holds a pointer to arbitary data set by the emitter of the message
223 /** This should be a null-terminated string identifying the type of request,
224 * all modules should define this and use it to determine the nature of the
225 * request before they attempt to cast the Request in any way.
228 /** This is a pointer to the sender of the message, which can be used to
229 * directly trigger events, or to create a reply.
232 /** The single destination of the Request
236 /** Create a new Request
237 * This is for the 'old' way of casting whatever the data is
238 * to char* and hoping you get the right thing at the other end.
239 * This is slowly being depreciated in favor of the 'new' way.
241 Request(char* anydata, Module* src, Module* dst);
242 /** Create a new Request
243 * This is for the 'new' way of defining a subclass
244 * of Request and defining it in a common header,
245 * passing an object of your Request subclass through
246 * as a Request* and using the ID string to determine
247 * what to cast it back to and the other end. This is
248 * much safer as there are no casts not confirmed by
249 * the ID string, and all casts are child->parent and
250 * can be checked at runtime with dynamic_cast<>()
252 Request(Module* src, Module* dst, const char* idstr);
253 /** Fetch the Request data
256 /** Fetch the ID string
259 /** Fetch the request source
262 /** Fetch the request destination (should be 'this' in the receiving module)
265 /** Send the Request.
266 * Upon returning the result will be arbitary data returned by the module you
267 * sent the request to. It is up to your module to know what this data is and
268 * how to deal with it.
274 /** The Event class is a unicast message directed at all modules.
275 * When the class is properly instantiated it may be sent to all modules
276 * using the Send() method, which will trigger the OnEvent method in
277 * all modules passing the object as its parameter.
279 class Event : public ModuleMessage
282 /** This member holds a pointer to arbitary data set by the emitter of the message
285 /** This is a pointer to the sender of the message, which can be used to
286 * directly trigger events, or to create a reply.
289 /** The event identifier.
290 * This is arbitary text which should be used to distinguish
291 * one type of event from another.
295 /** Create a new Event
297 Event(char* anydata, Module* src, const std::string &eventid);
298 /** Get the Event data
301 /** Get the event Source
304 /** Get the event ID.
305 * Use this to determine the event type for safe casting of the data
307 std::string GetEventID();
309 * The return result of an Event::Send() will always be NULL as
310 * no replies are expected.
312 char* Send(InspIRCd* ServerInstance);
315 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
316 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
317 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
318 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
319 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
321 class ModuleException : public std::exception
324 /** Holds the error message to be displayed
328 /** Default constructor, just uses the error mesage 'Module threw an exception'.
330 ModuleException() : err("Module threw an exception") {}
331 /** This constructor can be used to specify an error message before throwing.
333 ModuleException(std::string message) : err(message) {}
334 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
335 * Actually no, it does nothing. Never mind.
338 virtual ~ModuleException() throw() {};
339 /** Returns the reason for the exception.
340 * The module should probably put something informative here as the user will see this upon failure.
342 virtual const char* GetReason()
348 /** Priority types which can be returned from Module::Prioritize()
350 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
352 /** Implementation-specific flags which may be set in Module::Implements()
354 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
355 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
356 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
357 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
358 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
359 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
360 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
361 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
362 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
363 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
364 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
365 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
366 I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList };
368 /** Base class for all InspIRCd modules
369 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
370 * its methods will be called when irc server events occur. class inherited from module must be
371 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
373 class Module : public Extensible
376 InspIRCd* ServerInstance;
379 /** Default constructor
380 * Creates a module class.
381 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
382 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
384 Module(InspIRCd* Me);
386 /** Default destructor
387 * destroys a module class
391 /** Returns the version number of a Module.
392 * The method should return a Version object with its version information assigned via
395 virtual Version GetVersion();
397 /** The Implements function specifies which methods a module should receive events for.
398 * The char* parameter passed to this function contains a set of true or false values
399 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
400 * enum (documented elsewhere on this page) to mark functions as active. For example, to
401 * receive events for OnUserJoin():
403 * Implements[I_OnUserJoin] = 1;
405 * @param The implement list
407 virtual void Implements(char* Implements);
409 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
410 * Some modules prefer to be called before other modules, due to their design. For example, a
411 * module which is expected to operate on complete information would expect to be placed last, so
412 * that any other modules which wish to adjust that information would execute before it, to be sure
413 * its information is correct. You can change your module's priority by returning one of:
415 * PRIORITY_FIRST - To place your module first in the list
417 * PRIORITY_LAST - To place your module last in the list
419 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
421 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
423 * The result of InspIRCd::PriorityLast() - To move your module after another named module
425 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
426 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
427 * your module has a real need to reorder its priority, it should not implement this function,
428 * as many modules changing their priorities can make the system redundant.
430 virtual Priority Prioritize();
432 /** Called when a user connects.
433 * The details of the connecting user are available to you in the parameter userrec *user
434 * @param user The user who is connecting
436 virtual void OnUserConnect(userrec* user);
438 /** Called when a user quits.
439 * The details of the exiting user are available to you in the parameter userrec *user
440 * This event is only called when the user is fully registered when they quit. To catch
441 * raw disconnections, use the OnUserDisconnect method.
442 * @param user The user who is quitting
443 * @param message The user's quit message
445 virtual void OnUserQuit(userrec* user, const std::string &message);
447 /** Called whenever a user's socket is closed.
448 * The details of the exiting user are available to you in the parameter userrec *user
449 * This event is called for all users, registered or not, as a cleanup method for modules
450 * which might assign resources to user, such as dns lookups, objects and sockets.
451 * @param user The user who is disconnecting
453 virtual void OnUserDisconnect(userrec* user);
455 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
456 * @param chan The channel being deleted
458 virtual void OnChannelDelete(chanrec* chan);
460 /** Called when a user joins a channel.
461 * The details of the joining user are available to you in the parameter userrec *user,
462 * and the details of the channel they have joined is available in the variable chanrec *channel
463 * @param user The user who is joining
464 * @param channel The channel being joined
466 virtual void OnUserJoin(userrec* user, chanrec* channel);
468 /** Called after a user joins a channel
469 * Identical to OnUserJoin, but called immediately afterwards, when any linking module has
471 * @param user The user who is joining
472 * @param channel The channel being joined
474 virtual void OnPostJoin(userrec* user, chanrec* channel);
476 /** Called when a user parts a channel.
477 * The details of the leaving user are available to you in the parameter userrec *user,
478 * and the details of the channel they have left is available in the variable chanrec *channel
479 * @param user The user who is parting
480 * @param channel The channel being parted
481 * @param partmessage The part message, or an empty string
483 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
485 /** Called on rehash.
486 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
487 * system. You should use it to reload any files so that your module keeps in step with the
488 * rest of the application. If a parameter is given, the core has done nothing. The module
489 * receiving the event can decide if this parameter has any relevence to it.
490 * @param parameter The (optional) parameter given to REHASH from the user.
492 virtual void OnRehash(const std::string ¶meter);
494 /** Called when a raw command is transmitted or received.
495 * This method is the lowest level of handler available to a module. It will be called with raw
496 * data which is passing through a connected socket. If you wish, you may munge this data by changing
497 * the string parameter "raw". If you do this, after your function exits it will immediately be
498 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
499 * inbound is set to true) the value of user will be the userrec of the connection sending the
500 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
501 * @param raw The raw string in RFC1459 format
502 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
503 * @param user The user record sending the text, when inbound == true.
505 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
507 /** Called whenever a user is about to join a channel, before any processing is done.
508 * Returning a value of 1 from this function stops the process immediately, causing no
509 * output to be sent to the user by the core. If you do this you must produce your own numerics,
510 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
511 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
515 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
516 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
517 * processing on the actual channel record at this point, however the channel NAME will still be passed in
518 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
519 * @param user The user joining the channel
520 * @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
521 * @param cname The channel name being joined. For new channels this is valid where chan is not.
522 * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
523 * You may alter this string to alter the user's modes on the channel.
524 * @return 1 To prevent the join, 0 to allow it.
526 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
528 /** Called whenever a user is about to be kicked.
529 * Returning a value of 1 from this function stops the process immediately, causing no
530 * output to be sent to the user by the core. If you do this you must produce your own numerics,
532 * @param source The user issuing the kick
533 * @param user The user being kicked
534 * @param chan The channel the user is being kicked from
535 * @param reason The kick reason
536 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
538 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
540 /** Called whenever a user is kicked.
541 * If this method is called, the kick is already underway and cannot be prevented, so
542 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
543 * @param source The user issuing the kick
544 * @param user The user being kicked
545 * @param chan The channel the user is being kicked from
546 * @param reason The kick reason
548 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
550 /** Called whenever a user opers locally.
551 * The userrec will contain the oper mode 'o' as this function is called after any modifications
552 * are made to the user's structure by the core.
553 * @param user The user who is opering up
554 * @param opertype The opers type name
556 virtual void OnOper(userrec* user, const std::string &opertype);
558 /** Called after a user opers locally.
559 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
560 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
561 * out the OPERTYPE, etc.
562 * @param user The user who is opering up
563 * @param opertype The opers type name
565 virtual void OnPostOper(userrec* user, const std::string &opertype);
567 /** Called whenever a user types /INFO.
568 * The userrec will contain the information of the user who typed the command. Modules may use this
569 * method to output their own credits in /INFO (which is the ircd's version of an about box).
570 * It is purposefully not possible to modify any info that has already been output, or halt the list.
571 * You must write a 371 numeric to the user, containing your info in the following format:
573 * <nick> :information here
575 * @param user The user issuing /INFO
577 virtual void OnInfo(userrec* user);
579 /** Called whenever a /WHOIS is performed on a local user.
580 * The source parameter contains the details of the user who issued the WHOIS command, and
581 * the dest parameter contains the information of the user they are whoising.
582 * @param source The user issuing the WHOIS command
583 * @param dest The user who is being WHOISed
585 virtual void OnWhois(userrec* source, userrec* dest);
587 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
588 * Returning 1 from this function stops the process immediately, causing no
589 * output to be sent to the user by the core. If you do this you must produce your own numerics,
590 * notices etc. This is useful for modules which may want to filter invites to channels.
591 * @param source The user who is issuing the INVITE
592 * @param dest The user being invited
593 * @param channel The channel the user is being invited to
594 * @return 1 to deny the invite, 0 to allow
596 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
598 /** Called after a user has been successfully invited to a channel.
599 * You cannot prevent the invite from occuring using this function, to do that,
600 * use OnUserPreInvite instead.
601 * @param source The user who is issuing the INVITE
602 * @param dest The user being invited
603 * @param channel The channel the user is being invited to
605 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
607 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
608 * Returning any nonzero value from this function stops the process immediately, causing no
609 * output to be sent to the user by the core. If you do this you must produce your own numerics,
610 * notices etc. This is useful for modules which may want to filter or redirect messages.
611 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
612 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
613 * of where the message is destined to be sent.
614 * @param user The user sending the message
615 * @param dest The target of the message (chanrec* or userrec*)
616 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
617 * @param text Changeable text being sent by the user
618 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
619 * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
620 * It will be ignored for private messages.
621 * @return 1 to deny the NOTICE, 0 to allow it
623 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
625 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
626 * Returning any nonzero value from this function stops the process immediately, causing no
627 * output to be sent to the user by the core. If you do this you must produce your own numerics,
628 * notices etc. This is useful for modules which may want to filter or redirect messages.
629 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
630 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
631 * of where the message is destined to be sent.
632 * You may alter the message text as you wish before relinquishing control to the next module
633 * in the chain, and if no other modules block the text this altered form of the text will be sent out
634 * to the user and possibly to other servers.
635 * @param user The user sending the message
636 * @param dest The target of the message (chanrec* or userrec*)
637 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
638 * @param text Changeable text being sent by the user
639 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
640 * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
641 * It will be ignored for private notices.
642 * @return 1 to deny the NOTICE, 0 to allow it
644 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
646 /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
647 * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
648 * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
649 * @param chan The channel to build the exempt list of
650 * @param sender The original sender of the PRIVMSG or NOTICE
651 * @param status The status char to be used for the channel list
652 * @param exempt_list The exempt list to be populated
654 virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
656 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
657 * Please note that although you can see remote nickchanges through this function, you should
658 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
659 * check user->server before taking any action (including returning nonzero from the method).
660 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
661 * module to generate some meaninful output.
662 * @param user The username changing their nick
663 * @param newnick Their new nickname
664 * @return 1 to deny the change, 0 to allow
666 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
668 /** Called after any PRIVMSG sent from a user.
669 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
670 * if target_type is TYPE_CHANNEL.
671 * @param user The user sending the message
672 * @param dest The target of the message
673 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
674 * @param text the text being sent by the user
675 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
677 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
679 /** Called after any NOTICE sent from a user.
680 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
681 * if target_type is TYPE_CHANNEL.
682 * @param user The user sending the message
683 * @param dest The target of the message
684 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
685 * @param text the text being sent by the user
686 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
688 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
690 /** Called after every MODE command sent from a user
691 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
692 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
693 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
694 * @param user The user sending the MODEs
695 * @param dest The target of the modes (userrec* or chanrec*)
696 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
697 * @param text The actual modes and their parameters if any
699 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
701 /** Allows modules to alter or create server descriptions
702 * Whenever a module requires a server description, for example for display in
703 * WHOIS, this function is called in all modules. You may change or define the
704 * description given in std::string &description. If you do, this description
705 * will be shown in the WHOIS fields.
706 * @param servername The servername being searched for
707 * @param description Alterable server description for this server
709 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
711 /** Allows modules to synchronize data which relates to users during a netburst.
712 * When this function is called, it will be called from the module which implements
713 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
714 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
715 * (see below). This function will be called for every user visible on your side
716 * of the burst, allowing you to for example set modes, etc. Do not use this call to
717 * synchronize data which you have stored using class Extensible -- There is a specialist
718 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
719 * @param user The user being syncronized
720 * @param proto A pointer to the module handling network protocol
721 * @param opaque An opaque pointer set by the protocol module, should not be modified!
723 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
725 /** Allows modules to synchronize data which relates to channels during a netburst.
726 * When this function is called, it will be called from the module which implements
727 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
728 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
729 * (see below). This function will be called for every user visible on your side
730 * of the burst, allowing you to for example set modes, etc. Do not use this call to
731 * synchronize data which you have stored using class Extensible -- There is a specialist
732 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
734 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
736 * @param chan The channel being syncronized
737 * @param proto A pointer to the module handling network protocol
738 * @param opaque An opaque pointer set by the protocol module, should not be modified!
740 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
742 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
743 * Whenever the linking module wants to send out data, but doesnt know what the data
744 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
745 * this method is called.You should use the ProtoSendMetaData function after you've
746 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
747 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
748 * @param chan The channel whos metadata is being syncronized
749 * @param proto A pointer to the module handling network protocol
750 * @param opaque An opaque pointer set by the protocol module, should not be modified!
751 * @param extname The extensions name which is being searched for
753 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
755 /* Allows modules to syncronize metadata related to users over the network during a netburst.
756 * Whenever the linking module wants to send out data, but doesnt know what the data
757 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
758 * this method is called. You should use the ProtoSendMetaData function after you've
759 * correctly decided how the data should be represented, to send the metadata on its way if
760 * if it belongs to your module.
761 * @param user The user whos metadata is being syncronized
762 * @param proto A pointer to the module handling network protocol
763 * @param opaque An opaque pointer set by the protocol module, should not be modified!
764 * @param extname The extensions name which is being searched for
766 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
768 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
769 * Whenever the linking module wants to send out data, but doesnt know what the data
770 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
771 * this method is called. You should use the ProtoSendMetaData function after you've
772 * correctly decided how the data should be represented, to send the metadata on its way if
773 * if it belongs to your module.
774 * @param proto A pointer to the module handling network protocol
775 * @param opaque An opaque pointer set by the protocol module, should not be modified!
777 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
779 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
780 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
781 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
782 * @param target The chanrec* or userrec* that data should be added to
783 * @param extname The extension name which is being sent
784 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
786 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
788 /** Implemented by modules which provide the ability to link servers.
789 * These modules will implement this method, which allows transparent sending of servermodes
790 * down the network link as a broadcast, without a module calling it having to know the format
791 * of the MODE command before the actual mode string.
793 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
794 * of how to use this function.
796 * @param opaque An opaque pointer set by the protocol module, should not be modified!
797 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
798 * @param target The chanrec* or userrec* that modes should be sent for
799 * @param modeline The modes and parameters to be sent
801 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
803 /** Implemented by modules which provide the ability to link servers.
804 * These modules will implement this method, which allows metadata (extra data added to
805 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
806 * to other servers on a netburst and decoded at the other end by the same module on a
809 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
810 * how to use this function.
811 * @param opaque An opaque pointer set by the protocol module, should not be modified!
812 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
813 * @param target The chanrec* or userrec* that metadata should be sent for
814 * @param extname The extension name to send metadata for
815 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
817 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
819 /** Called after every WALLOPS command.
820 * @param user The user sending the WALLOPS
821 * @param text The content of the WALLOPS message
823 virtual void OnWallops(userrec* user, const std::string &text);
825 /** Called whenever a user's hostname is changed.
826 * This event triggers after the host has been set.
827 * @param user The user whos host is being changed
828 * @param newhost The new hostname being set
830 virtual void OnChangeHost(userrec* user, const std::string &newhost);
832 /** Called whenever a user's GECOS (realname) is changed.
833 * This event triggers after the name has been set.
834 * @param user The user who's GECOS is being changed
835 * @param gecos The new GECOS being set on the user
837 virtual void OnChangeName(userrec* user, const std::string &gecos);
839 /** Called whenever a gline is added by a local user.
840 * This method is triggered after the line is added.
841 * @param duration The duration of the line in seconds
842 * @param source The sender of the line
843 * @param reason The reason text to be displayed
844 * @param hostmask The hostmask to add
846 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
848 /** Called whenever a zline is added by a local user.
849 * This method is triggered after the line is added.
850 * @param duration The duration of the line in seconds
851 * @param source The sender of the line
852 * @param reason The reason text to be displayed
853 * @param ipmask The hostmask to add
855 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
857 /** Called whenever a kline is added by a local user.
858 * This method is triggered after the line is added.
859 * @param duration The duration of the line in seconds
860 * @param source The sender of the line
861 * @param reason The reason text to be displayed
862 * @param hostmask The hostmask to add
864 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
866 /** Called whenever a qline is added by a local user.
867 * This method is triggered after the line is added.
868 * @param duration The duration of the line in seconds
869 * @param source The sender of the line
870 * @param reason The reason text to be displayed
871 * @param nickmask The hostmask to add
873 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
875 /** Called whenever a eline is added by a local user.
876 * This method is triggered after the line is added.
877 * @param duration The duration of the line in seconds
878 * @param source The sender of the line
879 * @param reason The reason text to be displayed
880 * @param hostmask The hostmask to add
882 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
884 /** Called whenever a gline is deleted.
885 * This method is triggered after the line is deleted.
886 * @param source The user removing the line
887 * @param hostmask The hostmask to delete
889 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
891 /** Called whenever a zline is deleted.
892 * This method is triggered after the line is deleted.
893 * @param source The user removing the line
894 * @param hostmask The hostmask to delete
896 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
898 /** Called whenever a kline is deleted.
899 * This method is triggered after the line is deleted.
900 * @param source The user removing the line
901 * @param hostmask The hostmask to delete
903 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
905 /** Called whenever a qline is deleted.
906 * This method is triggered after the line is deleted.
907 * @param source The user removing the line
908 * @param hostmask The hostmask to delete
910 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
912 /** Called whenever a eline is deleted.
913 * This method is triggered after the line is deleted.
914 * @param source The user removing the line
915 * @param hostmask The hostmask to delete
917 virtual void OnDelELine(userrec* source, const std::string &hostmask);
919 /** Called before your module is unloaded to clean up Extensibles.
920 * This method is called once for every user and channel on the network,
921 * so that when your module unloads it may clear up any remaining data
922 * in the form of Extensibles added using Extensible::Extend().
923 * If the target_type variable is TYPE_USER, then void* item refers to
924 * a userrec*, otherwise it refers to a chanrec*.
925 * @param target_type The type of item being cleaned
926 * @param item A pointer to the item's class
928 virtual void OnCleanup(int target_type, void* item);
930 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
931 * have been applied. Please note that although you can see remote nickchanges through this function, you should
932 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
933 * check user->server before taking any action (including returning nonzero from the method).
934 * Because this method is called after the nickchange is taken place, no return values are possible
935 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
936 * @param user The user changing their nick
937 * @param oldnick The old nickname of the user before the nickchange
939 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
941 /** Called before an action which requires a channel privilage check.
942 * This function is called before many functions which check a users status on a channel, for example
943 * before opping a user, deopping a user, kicking a user, etc.
944 * There are several values for access_type which indicate for what reason access is being checked.
946 * AC_KICK (0) - A user is being kicked<br>
947 * AC_DEOP (1) - a user is being deopped<br>
948 * AC_OP (2) - a user is being opped<br>
949 * AC_VOICE (3) - a user is being voiced<br>
950 * AC_DEVOICE (4) - a user is being devoiced<br>
951 * AC_HALFOP (5) - a user is being halfopped<br>
952 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
953 * AC_INVITE () - a user is being invited<br>
954 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
955 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
956 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
957 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
958 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
959 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
960 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
961 * @param source The source of the access check
962 * @param dest The destination of the access check
963 * @param channel The channel which is being checked
964 * @param access_type See above
966 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
968 /** Called when a 005 numeric is about to be output.
969 * The module should modify the 005 numeric if needed to indicate its features.
970 * @param output The 005 string to be modified if neccessary.
972 virtual void On005Numeric(std::string &output);
974 /** Called when a client is disconnected by KILL.
975 * If a client is killed by a server, e.g. a nickname collision or protocol error,
977 * Return 1 from this function to prevent the kill, and 0 from this function to allow
978 * it as normal. If you prevent the kill no output will be sent to the client, it is
979 * down to your module to generate this information.
980 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
981 * If you do so youre risking race conditions, desyncs and worse!
982 * @param source The user sending the KILL
983 * @param dest The user being killed
984 * @param reason The kill reason
985 * @return 1 to prevent the kill, 0 to allow
987 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
989 /** Called when an oper wants to disconnect a remote user via KILL
990 * @param source The user sending the KILL
991 * @param dest The user being killed
992 * @param reason The kill reason
994 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
996 /** Called whenever a module is loaded.
997 * mod will contain a pointer to the module, and string will contain its name,
998 * for example m_widgets.so. This function is primary for dependency checking,
999 * your module may decide to enable some extra features if it sees that you have
1000 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1001 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1002 * but instead operate under reduced functionality, unless the dependency is
1003 * absolutely neccessary (e.g. a module that extends the features of another
1005 * @param mod A pointer to the new module
1006 * @param name The new module's filename
1008 virtual void OnLoadModule(Module* mod,const std::string &name);
1010 /** Called whenever a module is unloaded.
1011 * mod will contain a pointer to the module, and string will contain its name,
1012 * for example m_widgets.so. This function is primary for dependency checking,
1013 * your module may decide to enable some extra features if it sees that you have
1014 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
1015 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
1016 * but instead operate under reduced functionality, unless the dependency is
1017 * absolutely neccessary (e.g. a module that extends the features of another
1019 * @param mod Pointer to the module being unloaded (still valid)
1020 * @param name The filename of the module being unloaded
1022 virtual void OnUnloadModule(Module* mod,const std::string &name);
1024 /** Called once every five seconds for background processing.
1025 * This timer can be used to control timed features. Its period is not accurate
1026 * enough to be used as a clock, but it is gauranteed to be called at least once in
1027 * any five second period, directly from the main loop of the server.
1028 * @param curtime The current timer derived from time(2)
1030 virtual void OnBackgroundTimer(time_t curtime);
1032 /** Called whenever any command is about to be executed.
1033 * This event occurs for all registered commands, wether they are registered in the core,
1034 * or another module, and for invalid commands. Invalid commands may only be sent to this
1035 * function when the value of validated is false. By returning 1 from this method you may prevent the
1036 * command being executed. If you do this, no output is created by the core, and it is
1037 * down to your module to produce any output neccessary.
1038 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1039 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
1040 * method returns, it will be passed an invalid pointer to the user object and crash!)
1041 * @param command The command being executed
1042 * @param parameters An array of array of characters containing the parameters for the command
1043 * @param pcnt The nuimber of parameters passed to the command
1044 * @param user the user issuing the command
1045 * @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.
1046 * @param original_line The entire original line as passed to the parser from the user
1047 * @return 1 to block the command, 0 to allow
1049 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
1051 /** Called after any command has been executed.
1052 * This event occurs for all registered commands, wether they are registered in the core,
1053 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1054 * exist within the command table). The result code returned by the command handler is
1056 * @param command The command being executed
1057 * @param parameters An array of array of characters containing the parameters for the command
1058 * @param pcnt The nuimber of parameters passed to the command
1059 * @param user the user issuing the command
1060 * @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
1061 * @param original_line The entire original line as passed to the parser from the user
1063 virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
1065 /** Called to check if a user who is connecting can now be allowed to register
1066 * If any modules return false for this function, the user is held in the waiting
1067 * state until all modules return true. For example a module which implements ident
1068 * lookups will continue to return false for a user until their ident lookup is completed.
1069 * Note that the registration timeout for a user overrides these checks, if the registration
1070 * timeout is reached, the user is disconnected even if modules report that the user is
1071 * not ready to connect.
1072 * @param user The user to check
1073 * @return true to indicate readiness, false if otherwise
1075 virtual bool OnCheckReady(userrec* user);
1077 /** Called whenever a user is about to register their connection (e.g. before the user
1078 * is sent the MOTD etc). Modules can use this method if they are performing a function
1079 * which must be done before the actual connection is completed (e.g. ident lookups,
1080 * dnsbl lookups, etc).
1081 * Note that you should NOT delete the user record here by causing a disconnection!
1082 * Use OnUserConnect for that instead.
1083 * @param user The user registering
1084 * @return 1 to indicate user quit, 0 to continue
1086 virtual int OnUserRegister(userrec* user);
1088 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1089 * This method will always be called for each join, wether or not the channel is actually +i, and
1090 * determines the outcome of an if statement around the whole section of invite checking code.
1091 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1092 * @param user The user joining the channel
1093 * @param chan The channel being joined
1094 * @return 1 to explicitly allow the join, 0 to proceed as normal
1096 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1098 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1099 * This method will always be called for each join, wether or not the channel is actually +k, and
1100 * determines the outcome of an if statement around the whole section of key checking code.
1101 * if the user specified no key, the keygiven string will be a valid but empty value.
1102 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1103 * @param user The user joining the channel
1104 * @param chan The channel being joined
1105 * @return 1 to explicitly allow the join, 0 to proceed as normal
1107 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1109 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1110 * This method will always be called for each join, wether or not the channel is actually +l, and
1111 * determines the outcome of an if statement around the whole section of channel limit checking code.
1112 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1113 * @param user The user joining the channel
1114 * @param chan The channel being joined
1115 * @return 1 to explicitly allow the join, 0 to proceed as normal
1117 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1119 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1120 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1121 * determines the outcome of an if statement around the whole section of ban checking code.
1122 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1123 * @param user The user joining the channel
1124 * @param chan The channel being joined
1125 * @return 1 to explicitly allow the join, 0 to proceed as normal
1127 virtual int OnCheckBan(userrec* user, chanrec* chan);
1129 /** Called on all /STATS commands
1130 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1131 * @param symbol the symbol provided to /STATS
1132 * @param user the user issuing the /STATS command
1133 * @param results A string_list to append results into. You should put all your results
1134 * into this string_list, rather than displaying them directly, so that your handler will
1135 * work when remote STATS queries are received.
1136 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1138 virtual int OnStats(char symbol, userrec* user, string_list &results);
1140 /** Called whenever a change of a local users displayed host is attempted.
1141 * Return 1 to deny the host change, or 0 to allow it.
1142 * @param user The user whos host will be changed
1143 * @param newhost The new hostname
1144 * @return 1 to deny the host change, 0 to allow
1146 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1148 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1149 * return 1 to deny the name change, or 0 to allow it.
1150 * @param user The user whos GECOS will be changed
1151 * @param newhost The new GECOS
1152 * @return 1 to deny the GECOS change, 0 to allow
1154 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1156 /** Called whenever a topic is changed by a local user.
1157 * Return 1 to deny the topic change, or 0 to allow it.
1158 * @param user The user changing the topic
1159 * @param chan The channels who's topic is being changed
1160 * @param topic The actual topic text
1161 * @param 1 to block the topic change, 0 to allow
1163 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1165 /** Called whenever a local topic has been changed.
1166 * To block topic changes you must use OnLocalTopicChange instead.
1167 * @param user The user changing the topic
1168 * @param chan The channels who's topic is being changed
1169 * @param topic The actual topic text
1171 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1173 /** Called whenever an Event class is sent to all module by another module.
1174 * Please see the documentation of Event::Send() for further information. The Event sent can
1175 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1176 * before doing anything to the event data, and you should *not* change the event data in any way!
1177 * @param event The Event class being received
1179 virtual void OnEvent(Event* event);
1181 /** Called whenever a Request class is sent to your module by another module.
1182 * Please see the documentation of Request::Send() for further information. The Request sent
1183 * can always be assumed to be non-NULL, you should not change the request object or its data.
1184 * Your method may return arbitary data in the char* result which the requesting module
1185 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1186 * @param request The Request class being received
1188 virtual char* OnRequest(Request* request);
1190 /** Called whenever an oper password is to be compared to what a user has input.
1191 * The password field (from the config file) is in 'password' and is to be compared against
1192 * 'input'. This method allows for encryption of oper passwords and much more besides.
1193 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1195 * @param password The oper's password
1196 * @param input The password entered
1197 * @return 1 to match the passwords, 0 to do nothing
1199 virtual int OnOperCompare(const std::string &password, const std::string &input);
1201 /** Called whenever a user is given usermode +o, anywhere on the network.
1202 * You cannot override this and prevent it from happening as it is already happened and
1203 * such a task must be performed by another server. You can however bounce modes by sending
1204 * servermodes out to reverse mode changes.
1205 * @param user The user who is opering
1207 virtual void OnGlobalOper(userrec* user);
1209 /** Called after a user has fully connected and all modules have executed OnUserConnect
1210 * This event is informational only. You should not change any user information in this
1211 * event. To do so, use the OnUserConnect method to change the state of local users.
1212 * This is called for both local and remote users.
1213 * @param user The user who is connecting
1215 virtual void OnPostConnect(userrec* user);
1217 /** Called whenever a ban is added to a channel's list.
1218 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1219 * @param source The user adding the ban
1220 * @param channel The channel the ban is being added to
1221 * @param banmask The ban mask being added
1222 * @return 1 to block the ban, 0 to continue as normal
1224 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1226 /** Called whenever a ban is removed from a channel's list.
1227 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1228 * @param source The user deleting the ban
1229 * @param channel The channel the ban is being deleted from
1230 * @param banmask The ban mask being deleted
1231 * @return 1 to block the unban, 0 to continue as normal
1233 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1235 /** Called immediately after any connection is accepted. This is intended for raw socket
1236 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1237 * no information relating to a user record as the connection has not been assigned yet.
1238 * There are no return values from this call as all modules get an opportunity if required to
1239 * process the connection.
1240 * @param fd The file descriptor returned from accept()
1241 * @param ip The IP address of the connecting user
1242 * @param localport The local port number the user connected to
1244 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1246 /** Called immediately before any write() operation on a user's socket in the core. Because
1247 * this event is a low level event no user information is associated with it. It is intended
1248 * for use by modules which may wrap connections within another API such as SSL for example.
1249 * return a non-zero result if you have handled the write operation, in which case the core
1250 * will not call write().
1251 * @param fd The file descriptor of the socket
1252 * @param buffer A char* buffer being written
1253 * @param Number of characters to write
1254 * @return Number of characters actually written or 0 if you didn't handle the operation
1256 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1258 /** Called immediately before any socket is closed. When this event is called, shutdown()
1259 * has not yet been called on the socket.
1260 * @param fd The file descriptor of the socket prior to close()
1262 virtual void OnRawSocketClose(int fd);
1264 /** Called immediately before any read() operation on a client socket in the core.
1265 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1266 * when this event occurs.
1267 * Your event should return 1 if it has handled the reading itself, which prevents the core
1268 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1269 * the value of count. The value of readresult must be identical to an actual result that might
1270 * be returned from the read() system call, for example, number of bytes read upon success,
1271 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1272 * you MUST set readresult.
1273 * @param fd The file descriptor of the socket
1274 * @param buffer A char* buffer being read to
1275 * @param count The size of the buffer
1276 * @param readresult The amount of characters read, or 0
1277 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1279 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1281 /** Called whenever a user sets away.
1282 * This method has no parameter for the away message, as it is available in the
1283 * user record as userrec::awaymsg.
1285 virtual void OnSetAway(userrec* user);
1287 /** Called when a user cancels their away state.
1289 virtual void OnCancelAway(userrec* user);
1291 /** Called whenever a NAMES list is requested.
1292 * You can produce the nameslist yourself, overriding the current list,
1293 * and if you do you must return 1. If you do not handle the names list,
1296 virtual int OnUserList(userrec* user, chanrec* Ptr);
1298 /** Called whenever a line of WHOIS output is sent to a user.
1299 * You may change the numeric and the text of the output by changing
1300 * the values numeric and text, but you cannot change the user the
1301 * numeric is sent to. You may however change the user's userrec values.
1302 * @param user The user the numeric is being sent to
1303 * @param dest The user being WHOISed
1304 * @param numeric The numeric of the line being sent
1305 * @param text The text of the numeric, including any parameters
1306 * @return nonzero to drop the line completely so that the user does not
1307 * receive it, or zero to allow the line to be sent.
1309 virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
1313 #define CONF_NOT_A_NUMBER 0x000010
1314 #define CONF_NOT_UNSIGNED 0x000080
1315 #define CONF_VALUE_NOT_FOUND 0x000100
1316 #define CONF_FILE_NOT_FOUND 0x000200
1319 /** Allows reading of values from configuration files
1320 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1321 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1322 * Constructing the class using one parameter allows you to specify a path to your own configuration
1323 * file, otherwise, inspircd.conf is read.
1325 class ConfigReader : public classbase
1328 InspIRCd* ServerInstance;
1329 /** The contents of the configuration file
1330 * This protected member should never be accessed by a module (and cannot be accessed unless the
1331 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1332 * (such as comments) stripped from it.
1334 ConfigDataHash* data;
1335 std::ostringstream* errorlog;;
1336 /** Used to store errors
1338 bool privatehash; // If we're using our own config data hash or not.
1343 /** Default constructor.
1344 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1345 * as specified when running ./configure.
1347 ConfigReader(InspIRCd* Instance);
1348 /** Overloaded constructor.
1349 * This constructor initialises the ConfigReader class to read a user-specified config file
1351 ConfigReader(InspIRCd* Instance, const std::string &filename);
1352 /** Default destructor.
1353 * This method destroys the ConfigReader class.
1356 /** Retrieves a value from the config file.
1357 * This method retrieves a value from the config file. Where multiple copies of the tag
1358 * exist in the config file, index indicates which of the values to retrieve.
1360 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1361 /** Retrieves a boolean value from the config file.
1362 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1363 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1364 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1366 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1367 /** Retrieves an integer value from the config file.
1368 * This method retrieves an integer 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. Any invalid integer
1370 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1371 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1372 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1373 * will return CONF_NOT_UNSIGNED
1375 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1376 /** Returns the last error to occur.
1377 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1378 * A call to GetError() resets the error flag back to 0.
1381 /** Counts the number of times a given tag appears in the config file.
1382 * This method counts the number of times a tag appears in a config file, for use where
1383 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1384 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1385 * multiple instance tag.
1387 int Enumerate(const std::string &tag);
1388 /** Returns true if a config file is valid.
1389 * This method is partially implemented and will only return false if the config
1390 * file does not exist or could not be opened.
1393 /** Dumps the list of errors in a config file to an output location. If bail is true,
1394 * then the program will abort. If bail is false and user points to a valid user
1395 * record, the error report will be spooled to the given user by means of NOTICE.
1396 * if bool is false AND user is false, the error report will be spooled to all opers
1397 * by means of a NOTICE to all opers.
1399 void DumpErrors(bool bail,userrec* user);
1401 /** Returns the number of items within a tag.
1402 * For example if the tag was <test tag="blah" data="foo"> then this
1403 * function would return 2. Spaces and newlines both qualify as valid seperators
1406 int EnumerateValues(const std::string &tag, int index);
1411 /** Caches a text file into memory and can be used to retrieve lines from it.
1412 * This class contains methods for read-only manipulation of a text file in memory.
1413 * Either use the constructor type with one parameter to load a file into memory
1414 * at construction, or use the LoadFile method to load a file.
1416 class FileReader : public classbase
1418 InspIRCd* ServerInstance;
1419 /** The file contents
1423 unsigned long contentsize;
1428 /** Default constructor.
1429 * This method does not load any file into memory, you must use the LoadFile method
1430 * after constructing the class this way.
1432 FileReader(InspIRCd* Instance);
1434 /** Secondary constructor.
1435 * This method initialises the class with a file loaded into it ready for GetLine and
1436 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1439 FileReader(InspIRCd* Instance, const std::string &filename);
1441 /** Default destructor.
1442 * This deletes the memory allocated to the file.
1446 /** Used to load a file.
1447 * This method loads a file into the class ready for GetLine and
1448 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1451 void LoadFile(const std::string &filename);
1453 /** Returns the whole content of the file as std::string
1455 std::string Contents();
1457 /** Returns the entire size of the file as std::string
1459 unsigned long ContentSize();
1461 /** Returns true if the file exists
1462 * This function will return false if the file could not be opened.
1466 /** Retrieve one line from the file.
1467 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1468 * the index was out of bounds, or the line had no data on it.
1470 std::string GetLine(int x);
1472 /** Returns the size of the file in lines.
1473 * This method returns the number of lines in the read file. If it is 0, no lines have been
1474 * read into memory, either because the file is empty or it does not exist, or cannot be
1475 * opened due to permission problems.
1481 /** Instantiates classes inherited from Module.
1482 * This class creates a class inherited from type Module, using new. This is to allow for modules
1483 * to create many different variants of Module, dependent on architecture, configuration, etc.
1484 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1487 class ModuleFactory : public classbase
1490 /** The default constructor does nothing.
1493 /** The default destructor does nothing
1495 virtual ~ModuleFactory() { }
1496 /** Creates a new module.
1497 * Your inherited class of ModuleFactory must return a pointer to your Module class
1498 * using this method.
1500 virtual Module * CreateModule(InspIRCd* Me) = 0;
1503 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1505 typedef DLLFactory<ModuleFactory> ircd_module;
1507 /** A list of loaded Modules
1509 typedef std::vector<Module*> ModuleList;
1511 /** A list of loaded ModuleFactories
1513 typedef std::vector<ircd_module*> FactoryList;