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 {
63 #include "inspsocket.h"
74 // Forward-delacare module for ModuleMessage etc
77 /** Low level definition of a FileReader classes file cache area
79 typedef std::deque<std::string> file_cache;
80 typedef file_cache string_list;
82 /** Holds a list of 'published features' for modules.
84 typedef std::map<std::string,Module*> featurelist;
87 * This #define allows us to call a method in all
88 * loaded modules in a readable simple way, e.g.:
89 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
91 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
92 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
93 if (ServerInstance->Config->implement_lists[_i][y]) \
96 ServerInstance->modules[_i]->x ; \
98 catch (ModuleException& modexcept) \
100 ServerInstance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
105 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
106 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
107 if (z->Config->implement_lists[_i][y]) \
110 z->modules[_i]->x ; \
112 catch (ModuleException& modexcept) \
114 z->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
119 * This define is similar to the one above but returns a result in MOD_RESULT.
120 * The first module to return a nonzero result is the value to be accepted,
121 * and any modules after are ignored.
123 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
125 for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
126 if (ServerInstance->Config->implement_lists[_i][y]) { \
129 int res = ServerInstance->modules[_i]->x ; \
135 catch (ModuleException& modexcept) \
137 ServerInstance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
144 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
146 for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
147 if (z->Config->implement_lists[_i][y]) { \
150 int res = z->modules[_i]->x ; \
156 catch (ModuleException& modexcept) \
158 z->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
165 #define FD_MAGIC_NUMBER -42
169 #define IS_LOCAL(x) ((x->fd > -1) && (x->fd <= MAX_DESCRIPTORS))
170 #define IS_REMOTE(x) (x->fd < 0)
171 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
173 /** Holds a module's Version information
174 * The four members (set by the constructor only) indicate details as to the version number
175 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
177 class Version : public classbase
180 const int Major, Minor, Revision, Build, Flags;
181 Version(int major, int minor, int revision, int build, int flags);
184 /** The ModuleMessage class is the base class of Request and Event
185 * This class is used to represent a basic data structure which is passed
186 * between modules for safe inter-module communications.
188 class ModuleMessage : public classbase
191 virtual ~ModuleMessage() {};
194 /** The Request class is a unicast message directed at a given module.
195 * When this class is properly instantiated it may be sent to a module
196 * using the Send() method, which will call the given module's OnRequest
197 * method with this class as its parameter.
199 class Request : public ModuleMessage
202 /** This member holds a pointer to arbitary data set by the emitter of the message
205 /** This should be a null-terminated string identifying the type of request,
206 * all modules should define this and use it to determine the nature of the
207 * request before they attempt to cast the Request in any way.
210 /** This is a pointer to the sender of the message, which can be used to
211 * directly trigger events, or to create a reply.
214 /** The single destination of the Request
218 /** Create a new Request
219 * This is for the 'old' way of casting whatever the data is
220 * to char* and hoping you get the right thing at the other end.
221 * This is slowly being depreciated in favor of the 'new' way.
223 Request(char* anydata, Module* src, Module* dst);
224 /** Create a new Request
225 * This is for the 'new' way of defining a subclass
226 * of Request and defining it in a common header,
227 * passing an object of your Request subclass through
228 * as a Request* and using the ID string to determine
229 * what to cast it back to and the other end. This is
230 * much safer as there are no casts not confirmed by
231 * the ID string, and all casts are child->parent and
232 * can be checked at runtime with dynamic_cast<>()
234 Request(Module* src, Module* dst, const char* idstr);
235 /** Fetch the Request data
238 /** Fetch the ID string
241 /** Fetch the request source
244 /** Fetch the request destination (should be 'this' in the receiving module)
247 /** Send the Request.
248 * Upon returning the result will be arbitary data returned by the module you
249 * sent the request to. It is up to your module to know what this data is and
250 * how to deal with it.
256 /** The Event class is a unicast message directed at all modules.
257 * When the class is properly instantiated it may be sent to all modules
258 * using the Send() method, which will trigger the OnEvent method in
259 * all modules passing the object as its parameter.
261 class Event : public ModuleMessage
264 /** This member holds a pointer to arbitary data set by the emitter of the message
267 /** This is a pointer to the sender of the message, which can be used to
268 * directly trigger events, or to create a reply.
271 /** The event identifier.
272 * This is arbitary text which should be used to distinguish
273 * one type of event from another.
277 /** Create a new Event
279 Event(char* anydata, Module* src, const std::string &eventid);
280 /** Get the Event data
283 /** Get the event Source
286 /** Get the event ID.
287 * Use this to determine the event type for safe casting of the data
289 std::string GetEventID();
291 * The return result of an Event::Send() will always be NULL as
292 * no replies are expected.
294 char* Send(InspIRCd* ServerInstance);
297 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
298 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
299 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
300 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
301 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
303 class ModuleException : public classbase
306 /** Holds the error message to be displayed
310 /** Default constructor, just uses the error mesage 'Module threw an exception'.
312 ModuleException() : err("Module threw an exception") {}
313 /** This constructor can be used to specify an error message before throwing.
315 ModuleException(std::string message) : err(message) {}
316 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
317 * Actually no, it does nothing. Never mind.
319 virtual ~ModuleException() {};
320 /** Returns the reason for the exception.
321 * The module should probably put something informative here as the user will see this upon failure.
323 virtual const char* GetReason()
329 /** Priority types which can be returned from Module::Prioritize()
331 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
333 /** Implementation-specific flags which may be set in Module::Implements()
335 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
336 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
337 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
338 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
339 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
340 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
341 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
342 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
343 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
344 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
345 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
346 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
348 /** Base class for all InspIRCd modules
349 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
350 * its methods will be called when irc server events occur. class inherited from module must be
351 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
353 class Module : public Extensible
356 InspIRCd* ServerInstance;
359 /** Default constructor
360 * Creates a module class.
361 * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
362 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
364 Module(InspIRCd* Me);
366 /** Default destructor
367 * destroys a module class
371 /** Returns the version number of a Module.
372 * The method should return a Version object with its version information assigned via
375 virtual Version GetVersion();
377 /** The Implements function specifies which methods a module should receive events for.
378 * The char* parameter passed to this function contains a set of true or false values
379 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
380 * enum (documented elsewhere on this page) to mark functions as active. For example, to
381 * receive events for OnUserJoin():
383 * Implements[I_OnUserJoin] = 1;
385 * @param The implement list
387 virtual void Implements(char* Implements);
389 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
390 * Some modules prefer to be called before other modules, due to their design. For example, a
391 * module which is expected to operate on complete information would expect to be placed last, so
392 * that any other modules which wish to adjust that information would execute before it, to be sure
393 * its information is correct. You can change your module's priority by returning one of:
395 * PRIORITY_FIRST - To place your module first in the list
397 * PRIORITY_LAST - To place your module last in the list
399 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
401 * The result of InspIRCd::PriorityBefore() - To move your module before another named module
403 * The result of InspIRCd::PriorityLast() - To move your module after another named module
405 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
406 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
407 * your module has a real need to reorder its priority, it should not implement this function,
408 * as many modules changing their priorities can make the system redundant.
410 virtual Priority Prioritize();
412 /** Called when a user connects.
413 * The details of the connecting user are available to you in the parameter userrec *user
414 * @param user The user who is connecting
416 virtual void OnUserConnect(userrec* user);
418 /** Called when a user quits.
419 * The details of the exiting user are available to you in the parameter userrec *user
420 * This event is only called when the user is fully registered when they quit. To catch
421 * raw disconnections, use the OnUserDisconnect method.
422 * @param user The user who is quitting
423 * @param message The user's quit message
425 virtual void OnUserQuit(userrec* user, const std::string &message);
427 /** Called whenever a user's socket is closed.
428 * The details of the exiting user are available to you in the parameter userrec *user
429 * This event is called for all users, registered or not, as a cleanup method for modules
430 * which might assign resources to user, such as dns lookups, objects and sockets.
431 * @param user The user who is disconnecting
433 virtual void OnUserDisconnect(userrec* user);
435 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
436 * @param chan The channel being deleted
438 virtual void OnChannelDelete(chanrec* chan);
440 /** Called when a user joins a channel.
441 * The details of the joining user are available to you in the parameter userrec *user,
442 * and the details of the channel they have joined is available in the variable chanrec *channel
443 * @param user The user who is joining
444 * @param channel The channel being joined
446 virtual void OnUserJoin(userrec* user, chanrec* channel);
448 /** Called when a user parts a channel.
449 * The details of the leaving user are available to you in the parameter userrec *user,
450 * and the details of the channel they have left is available in the variable chanrec *channel
451 * @param user The user who is parting
452 * @param channel The channel being parted
453 * @param partmessage The part message, or an empty string
455 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
457 /** Called on rehash.
458 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
459 * system. You should use it to reload any files so that your module keeps in step with the
460 * rest of the application. If a parameter is given, the core has done nothing. The module
461 * receiving the event can decide if this parameter has any relevence to it.
462 * @param parameter The (optional) parameter given to REHASH from the user.
464 virtual void OnRehash(const std::string ¶meter);
466 /** Called when a raw command is transmitted or received.
467 * This method is the lowest level of handler available to a module. It will be called with raw
468 * data which is passing through a connected socket. If you wish, you may munge this data by changing
469 * the string parameter "raw". If you do this, after your function exits it will immediately be
470 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
471 * inbound is set to true) the value of user will be the userrec of the connection sending the
472 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
473 * @param raw The raw string in RFC1459 format
474 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
475 * @param user The user record sending the text, when inbound == true.
477 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
479 /** Called whenever a user is about to join a channel, before any processing is done.
480 * Returning a value of 1 from this function stops the process immediately, causing no
481 * output to be sent to the user by the core. If you do this you must produce your own numerics,
482 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
483 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
487 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
488 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
489 * processing on the actual channel record at this point, however the channel NAME will still be passed in
490 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
491 * @param user The user joining the channel
492 * @param cname The channel name being joined
493 * @return 1 To prevent the join, 0 to allow it.
495 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
497 /** Called whenever a user is about to be kicked.
498 * Returning a value of 1 from this function stops the process immediately, causing no
499 * output to be sent to the user by the core. If you do this you must produce your own numerics,
501 * @param source The user issuing the kick
502 * @param user The user being kicked
503 * @param chan The channel the user is being kicked from
504 * @param reason The kick reason
505 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
507 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
509 /** Called whenever a user is kicked.
510 * If this method is called, the kick is already underway and cannot be prevented, so
511 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
512 * @param source The user issuing the kick
513 * @param user The user being kicked
514 * @param chan The channel the user is being kicked from
515 * @param reason The kick reason
517 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
519 /** Called whenever a user opers locally.
520 * The userrec will contain the oper mode 'o' as this function is called after any modifications
521 * are made to the user's structure by the core.
522 * @param user The user who is opering up
523 * @param opertype The opers type name
525 virtual void OnOper(userrec* user, const std::string &opertype);
527 /** Called after a user opers locally.
528 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
529 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
530 * out the OPERTYPE, etc.
531 * @param user The user who is opering up
532 * @param opertype The opers type name
534 virtual void OnPostOper(userrec* user, const std::string &opertype);
536 /** Called whenever a user types /INFO.
537 * The userrec will contain the information of the user who typed the command. Modules may use this
538 * method to output their own credits in /INFO (which is the ircd's version of an about box).
539 * It is purposefully not possible to modify any info that has already been output, or halt the list.
540 * You must write a 371 numeric to the user, containing your info in the following format:
542 * <nick> :information here
544 * @param user The user issuing /INFO
546 virtual void OnInfo(userrec* user);
548 /** Called whenever a /WHOIS is performed on a local user.
549 * The source parameter contains the details of the user who issued the WHOIS command, and
550 * the dest parameter contains the information of the user they are whoising.
551 * @param source The user issuing the WHOIS command
552 * @param dest The user who is being WHOISed
554 virtual void OnWhois(userrec* source, userrec* dest);
556 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
557 * Returning 1 from this function stops the process immediately, causing no
558 * output to be sent to the user by the core. If you do this you must produce your own numerics,
559 * notices etc. This is useful for modules which may want to filter invites to channels.
560 * @param source The user who is issuing the INVITE
561 * @param dest The user being invited
562 * @param channel The channel the user is being invited to
563 * @return 1 to deny the invite, 0 to allow
565 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
567 /** Called after a user has been successfully invited to a channel.
568 * You cannot prevent the invite from occuring using this function, to do that,
569 * use OnUserPreInvite instead.
570 * @param source The user who is issuing the INVITE
571 * @param dest The user being invited
572 * @param channel The channel the user is being invited to
574 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
576 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
577 * Returning any nonzero value from this function stops the process immediately, causing no
578 * output to be sent to the user by the core. If you do this you must produce your own numerics,
579 * notices etc. This is useful for modules which may want to filter or redirect messages.
580 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
581 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
582 * of where the message is destined to be sent.
583 * @param user The user sending the message
584 * @param dest The target of the message (chanrec* or userrec*)
585 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
586 * @param text Changeable text being sent by the user
587 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
588 * @return 1 to deny the NOTICE, 0 to allow it
590 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
592 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
593 * Returning any nonzero value from this function stops the process immediately, causing no
594 * output to be sent to the user by the core. If you do this you must produce your own numerics,
595 * notices etc. This is useful for modules which may want to filter or redirect messages.
596 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
597 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
598 * of where the message is destined to be sent.
599 * You may alter the message text as you wish before relinquishing control to the next module
600 * in the chain, and if no other modules block the text this altered form of the text will be sent out
601 * to the user and possibly to other servers.
602 * @param user The user sending the message
603 * @param dest The target of the message (chanrec* or userrec*)
604 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
605 * @param text Changeable text being sent by the user
606 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
607 * @return 1 to deny the NOTICE, 0 to allow it
609 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
611 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
612 * Please note that although you can see remote nickchanges through this function, you should
613 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
614 * check user->server before taking any action (including returning nonzero from the method).
615 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
616 * module to generate some meaninful output.
617 * @param user The username changing their nick
618 * @param newnick Their new nickname
619 * @return 1 to deny the change, 0 to allow
621 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
623 /** Called after any PRIVMSG sent from a user.
624 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
625 * if target_type is TYPE_CHANNEL.
626 * @param user The user sending the message
627 * @param dest The target of the message
628 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
629 * @param text the text being sent by the user
630 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
632 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
634 /** Called after any NOTICE sent from a user.
635 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
636 * if target_type is TYPE_CHANNEL.
637 * @param user The user sending the message
638 * @param dest The target of the message
639 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
640 * @param text the text being sent by the user
641 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
643 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
645 /** Called after every MODE command sent from a user
646 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
647 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
648 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
649 * @param user The user sending the MODEs
650 * @param dest The target of the modes (userrec* or chanrec*)
651 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
652 * @param text The actual modes and their parameters if any
654 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
656 /** Allows modules to alter or create server descriptions
657 * Whenever a module requires a server description, for example for display in
658 * WHOIS, this function is called in all modules. You may change or define the
659 * description given in std::string &description. If you do, this description
660 * will be shown in the WHOIS fields.
661 * @param servername The servername being searched for
662 * @param description Alterable server description for this server
664 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
666 /** Allows modules to synchronize data which relates to users during a netburst.
667 * When this function is called, it will be called from the module which implements
668 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
669 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
670 * (see below). This function will be called for every user visible on your side
671 * of the burst, allowing you to for example set modes, etc. Do not use this call to
672 * synchronize data which you have stored using class Extensible -- There is a specialist
673 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
674 * @param user The user being syncronized
675 * @param proto A pointer to the module handling network protocol
676 * @param opaque An opaque pointer set by the protocol module, should not be modified!
678 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
680 /** Allows modules to synchronize data which relates to channels during a netburst.
681 * When this function is called, it will be called from the module which implements
682 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
683 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
684 * (see below). This function will be called for every user visible on your side
685 * of the burst, allowing you to for example set modes, etc. Do not use this call to
686 * synchronize data which you have stored using class Extensible -- There is a specialist
687 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
689 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
691 * @param chan The channel being syncronized
692 * @param proto A pointer to the module handling network protocol
693 * @param opaque An opaque pointer set by the protocol module, should not be modified!
695 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
697 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
698 * Whenever the linking module wants to send out data, but doesnt know what the data
699 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
700 * this method is called.You should use the ProtoSendMetaData function after you've
701 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
702 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
703 * @param chan The channel whos metadata is being syncronized
704 * @param proto A pointer to the module handling network protocol
705 * @param opaque An opaque pointer set by the protocol module, should not be modified!
706 * @param extname The extensions name which is being searched for
708 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
710 /* Allows modules to syncronize metadata related to users over the network during a netburst.
711 * Whenever the linking module wants to send out data, but doesnt know what the data
712 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
713 * this method is called. You should use the ProtoSendMetaData function after you've
714 * correctly decided how the data should be represented, to send the metadata on its way if
715 * if it belongs to your module.
716 * @param user The user whos metadata is being syncronized
717 * @param proto A pointer to the module handling network protocol
718 * @param opaque An opaque pointer set by the protocol module, should not be modified!
719 * @param extname The extensions name which is being searched for
721 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
723 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
724 * Whenever the linking module wants to send out data, but doesnt know what the data
725 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
726 * this method is called. You should use the ProtoSendMetaData function after you've
727 * correctly decided how the data should be represented, to send the metadata on its way if
728 * if it belongs to your module.
729 * @param proto A pointer to the module handling network protocol
730 * @param opaque An opaque pointer set by the protocol module, should not be modified!
732 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
734 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
735 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
736 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
737 * @param target The chanrec* or userrec* that data should be added to
738 * @param extname The extension name which is being sent
739 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
741 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
743 /** Implemented by modules which provide the ability to link servers.
744 * These modules will implement this method, which allows transparent sending of servermodes
745 * down the network link as a broadcast, without a module calling it having to know the format
746 * of the MODE command before the actual mode string.
748 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
749 * of how to use this function.
751 * @param opaque An opaque pointer set by the protocol module, should not be modified!
752 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
753 * @param target The chanrec* or userrec* that modes should be sent for
754 * @param modeline The modes and parameters to be sent
756 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
758 /** Implemented by modules which provide the ability to link servers.
759 * These modules will implement this method, which allows metadata (extra data added to
760 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
761 * to other servers on a netburst and decoded at the other end by the same module on a
764 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
765 * how to use this function.
766 * @param opaque An opaque pointer set by the protocol module, should not be modified!
767 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
768 * @param target The chanrec* or userrec* that metadata should be sent for
769 * @param extname The extension name to send metadata for
770 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
772 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
774 /** Called after every WALLOPS command.
775 * @param user The user sending the WALLOPS
776 * @param text The content of the WALLOPS message
778 virtual void OnWallops(userrec* user, const std::string &text);
780 /** Called whenever a user's hostname is changed.
781 * This event triggers after the host has been set.
782 * @param user The user whos host is being changed
783 * @param newhost The new hostname being set
785 virtual void OnChangeHost(userrec* user, const std::string &newhost);
787 /** Called whenever a user's GECOS (realname) is changed.
788 * This event triggers after the name has been set.
789 * @param user The user who's GECOS is being changed
790 * @param gecos The new GECOS being set on the user
792 virtual void OnChangeName(userrec* user, const std::string &gecos);
794 /** Called whenever a gline is added by a local user.
795 * This method is triggered after the line is added.
796 * @param duration The duration of the line in seconds
797 * @param source The sender of the line
798 * @param reason The reason text to be displayed
799 * @param hostmask The hostmask to add
801 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
803 /** Called whenever a zline is added by a local user.
804 * This method is triggered after the line is added.
805 * @param duration The duration of the line in seconds
806 * @param source The sender of the line
807 * @param reason The reason text to be displayed
808 * @param ipmask The hostmask to add
810 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
812 /** Called whenever a kline is added by a local user.
813 * This method is triggered after the line is added.
814 * @param duration The duration of the line in seconds
815 * @param source The sender of the line
816 * @param reason The reason text to be displayed
817 * @param hostmask The hostmask to add
819 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
821 /** Called whenever a qline is added by a local user.
822 * This method is triggered after the line is added.
823 * @param duration The duration of the line in seconds
824 * @param source The sender of the line
825 * @param reason The reason text to be displayed
826 * @param nickmask The hostmask to add
828 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
830 /** Called whenever a eline is added by a local user.
831 * This method is triggered after the line is added.
832 * @param duration The duration of the line in seconds
833 * @param source The sender of the line
834 * @param reason The reason text to be displayed
835 * @param hostmask The hostmask to add
837 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
839 /** Called whenever a gline is deleted.
840 * This method is triggered after the line is deleted.
841 * @param source The user removing the line
842 * @param hostmask The hostmask to delete
844 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
846 /** Called whenever a zline is deleted.
847 * This method is triggered after the line is deleted.
848 * @param source The user removing the line
849 * @param hostmask The hostmask to delete
851 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
853 /** Called whenever a kline is deleted.
854 * This method is triggered after the line is deleted.
855 * @param source The user removing the line
856 * @param hostmask The hostmask to delete
858 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
860 /** Called whenever a qline is deleted.
861 * This method is triggered after the line is deleted.
862 * @param source The user removing the line
863 * @param hostmask The hostmask to delete
865 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
867 /** Called whenever a eline is deleted.
868 * This method is triggered after the line is deleted.
869 * @param source The user removing the line
870 * @param hostmask The hostmask to delete
872 virtual void OnDelELine(userrec* source, const std::string &hostmask);
874 /** Called before your module is unloaded to clean up Extensibles.
875 * This method is called once for every user and channel on the network,
876 * so that when your module unloads it may clear up any remaining data
877 * in the form of Extensibles added using Extensible::Extend().
878 * If the target_type variable is TYPE_USER, then void* item refers to
879 * a userrec*, otherwise it refers to a chanrec*.
880 * @param target_type The type of item being cleaned
881 * @param item A pointer to the item's class
883 virtual void OnCleanup(int target_type, void* item);
885 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
886 * have been applied. Please note that although you can see remote nickchanges through this function, you should
887 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
888 * check user->server before taking any action (including returning nonzero from the method).
889 * Because this method is called after the nickchange is taken place, no return values are possible
890 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
891 * @param user The user changing their nick
892 * @param oldnick The old nickname of the user before the nickchange
894 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
896 /** Called before an action which requires a channel privilage check.
897 * This function is called before many functions which check a users status on a channel, for example
898 * before opping a user, deopping a user, kicking a user, etc.
899 * There are several values for access_type which indicate for what reason access is being checked.
901 * AC_KICK (0) - A user is being kicked<br>
902 * AC_DEOP (1) - a user is being deopped<br>
903 * AC_OP (2) - a user is being opped<br>
904 * AC_VOICE (3) - a user is being voiced<br>
905 * AC_DEVOICE (4) - a user is being devoiced<br>
906 * AC_HALFOP (5) - a user is being halfopped<br>
907 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
908 * AC_INVITE () - a user is being invited<br>
909 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
910 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
911 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
912 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
913 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
914 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
915 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
916 * @param source The source of the access check
917 * @param dest The destination of the access check
918 * @param channel The channel which is being checked
919 * @param access_type See above
921 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
923 /** Called when a 005 numeric is about to be output.
924 * The module should modify the 005 numeric if needed to indicate its features.
925 * @param output The 005 string to be modified if neccessary.
927 virtual void On005Numeric(std::string &output);
929 /** Called when a client is disconnected by KILL.
930 * If a client is killed by a server, e.g. a nickname collision or protocol error,
932 * Return 1 from this function to prevent the kill, and 0 from this function to allow
933 * it as normal. If you prevent the kill no output will be sent to the client, it is
934 * down to your module to generate this information.
935 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
936 * If you do so youre risking race conditions, desyncs and worse!
937 * @param source The user sending the KILL
938 * @param dest The user being killed
939 * @param reason The kill reason
940 * @return 1 to prevent the kill, 0 to allow
942 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
944 /** Called when an oper wants to disconnect a remote user via KILL
945 * @param source The user sending the KILL
946 * @param dest The user being killed
947 * @param reason The kill reason
949 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
951 /** Called whenever a module is loaded.
952 * mod will contain a pointer to the module, and string will contain its name,
953 * for example m_widgets.so. This function is primary for dependency checking,
954 * your module may decide to enable some extra features if it sees that you have
955 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
956 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
957 * but instead operate under reduced functionality, unless the dependency is
958 * absolutely neccessary (e.g. a module that extends the features of another
960 * @param mod A pointer to the new module
961 * @param name The new module's filename
963 virtual void OnLoadModule(Module* mod,const std::string &name);
965 /** Called whenever a module is unloaded.
966 * mod will contain a pointer to the module, and string will contain its name,
967 * for example m_widgets.so. This function is primary for dependency checking,
968 * your module may decide to enable some extra features if it sees that you have
969 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
970 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
971 * but instead operate under reduced functionality, unless the dependency is
972 * absolutely neccessary (e.g. a module that extends the features of another
974 * @param mod Pointer to the module being unloaded (still valid)
975 * @param name The filename of the module being unloaded
977 virtual void OnUnloadModule(Module* mod,const std::string &name);
979 /** Called once every five seconds for background processing.
980 * This timer can be used to control timed features. Its period is not accurate
981 * enough to be used as a clock, but it is gauranteed to be called at least once in
982 * any five second period, directly from the main loop of the server.
983 * @param curtime The current timer derived from time(2)
985 virtual void OnBackgroundTimer(time_t curtime);
987 /** Called whenever any command is about to be executed.
988 * This event occurs for all registered commands, wether they are registered in the core,
989 * or another module, but it will not occur for invalid commands (e.g. ones which do not
990 * exist within the command table). By returning 1 from this method you may prevent the
991 * command being executed. If you do this, no output is created by the core, and it is
992 * down to your module to produce any output neccessary.
993 * Note that unless you return 1, you should not destroy any structures (e.g. by using
994 * InspIRCd::QuitUser) otherwise when the command's handler function executes after your
995 * method returns, it will be passed an invalid pointer to the user object and crash!)
996 * @param command The command being executed
997 * @param parameters An array of array of characters containing the parameters for the command
998 * @param pcnt The nuimber of parameters passed to the command
999 * @param user the user issuing the command
1000 * @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.
1001 * @return 1 to block the command, 0 to allow
1003 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
1005 /** Called to check if a user who is connecting can now be allowed to register
1006 * If any modules return false for this function, the user is held in the waiting
1007 * state until all modules return true. For example a module which implements ident
1008 * lookups will continue to return false for a user until their ident lookup is completed.
1009 * Note that the registration timeout for a user overrides these checks, if the registration
1010 * timeout is reached, the user is disconnected even if modules report that the user is
1011 * not ready to connect.
1012 * @param user The user to check
1013 * @return true to indicate readiness, false if otherwise
1015 virtual bool OnCheckReady(userrec* user);
1017 /** Called whenever a user is about to register their connection (e.g. before the user
1018 * is sent the MOTD etc). Modules can use this method if they are performing a function
1019 * which must be done before the actual connection is completed (e.g. ident lookups,
1020 * dnsbl lookups, etc).
1021 * Note that you should NOT delete the user record here by causing a disconnection!
1022 * Use OnUserConnect for that instead.
1023 * @param user The user registering
1025 virtual void OnUserRegister(userrec* user);
1027 /** Called whenever a mode character is processed.
1028 * Return 1 from this function to block the mode character from being processed entirely,
1029 * so that you may perform your own code instead. Note that this method allows you to override
1030 * modes defined by other modes, but this is NOT RECOMMENDED!
1031 * @param user The user who is sending the mode
1032 * @param chan The channel the mode is being sent to
1033 * @param mode The mode character being set
1034 * @param param The parameter for the mode or an empty string
1035 * @param adding true of the mode is being added, false if it is being removed
1036 * @param pcnt The parameter count for the mode (0 or 1)
1037 * @return 1 to deny the mode, 0 to allow
1039 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1041 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1042 * This method will always be called for each join, wether or not the channel is actually +i, and
1043 * determines the outcome of an if statement around the whole section of invite checking code.
1044 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1045 * @param user The user joining the channel
1046 * @param chan The channel being joined
1047 * @return 1 to explicitly allow the join, 0 to proceed as normal
1049 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1051 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1052 * This method will always be called for each join, wether or not the channel is actually +k, and
1053 * determines the outcome of an if statement around the whole section of key checking code.
1054 * if the user specified no key, the keygiven string will be a valid but empty value.
1055 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1056 * @param user The user joining the channel
1057 * @param chan The channel being joined
1058 * @return 1 to explicitly allow the join, 0 to proceed as normal
1060 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1062 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1063 * This method will always be called for each join, wether or not the channel is actually +l, and
1064 * determines the outcome of an if statement around the whole section of channel limit checking code.
1065 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1066 * @param user The user joining the channel
1067 * @param chan The channel being joined
1068 * @return 1 to explicitly allow the join, 0 to proceed as normal
1070 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1072 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1073 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1074 * determines the outcome of an if statement around the whole section of ban checking code.
1075 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1076 * @param user The user joining the channel
1077 * @param chan The channel being joined
1078 * @return 1 to explicitly allow the join, 0 to proceed as normal
1080 virtual int OnCheckBan(userrec* user, chanrec* chan);
1082 /** Called on all /STATS commands
1083 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1084 * @param symbol the symbol provided to /STATS
1085 * @param user the user issuing the /STATS command
1086 * @param results A string_list to append results into. You should put all your results
1087 * into this string_list, rather than displaying them directly, so that your handler will
1088 * work when remote STATS queries are received.
1089 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1091 virtual int OnStats(char symbol, userrec* user, string_list &results);
1093 /** Called whenever a change of a local users displayed host is attempted.
1094 * Return 1 to deny the host change, or 0 to allow it.
1095 * @param user The user whos host will be changed
1096 * @param newhost The new hostname
1097 * @return 1 to deny the host change, 0 to allow
1099 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1101 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1102 * return 1 to deny the name change, or 0 to allow it.
1103 * @param user The user whos GECOS will be changed
1104 * @param newhost The new GECOS
1105 * @return 1 to deny the GECOS change, 0 to allow
1107 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1109 /** Called whenever a topic is changed by a local user.
1110 * Return 1 to deny the topic change, or 0 to allow it.
1111 * @param user The user changing the topic
1112 * @param chan The channels who's topic is being changed
1113 * @param topic The actual topic text
1114 * @param 1 to block the topic change, 0 to allow
1116 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1118 /** Called whenever a local topic has been changed.
1119 * To block topic changes you must use OnLocalTopicChange instead.
1120 * @param user The user changing the topic
1121 * @param chan The channels who's topic is being changed
1122 * @param topic The actual topic text
1124 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1126 /** Called whenever an Event class is sent to all module by another module.
1127 * Please see the documentation of Event::Send() for further information. The Event sent can
1128 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1129 * before doing anything to the event data, and you should *not* change the event data in any way!
1130 * @param event The Event class being received
1132 virtual void OnEvent(Event* event);
1134 /** Called whenever a Request class is sent to your module by another module.
1135 * Please see the documentation of Request::Send() for further information. The Request sent
1136 * can always be assumed to be non-NULL, you should not change the request object or its data.
1137 * Your method may return arbitary data in the char* result which the requesting module
1138 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1139 * @param request The Request class being received
1141 virtual char* OnRequest(Request* request);
1143 /** Called whenever an oper password is to be compared to what a user has input.
1144 * The password field (from the config file) is in 'password' and is to be compared against
1145 * 'input'. This method allows for encryption of oper passwords and much more besides.
1146 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1148 * @param password The oper's password
1149 * @param input The password entered
1150 * @return 1 to match the passwords, 0 to do nothing
1152 virtual int OnOperCompare(const std::string &password, const std::string &input);
1154 /** Called whenever a user is given usermode +o, anywhere on the network.
1155 * You cannot override this and prevent it from happening as it is already happened and
1156 * such a task must be performed by another server. You can however bounce modes by sending
1157 * servermodes out to reverse mode changes.
1158 * @param user The user who is opering
1160 virtual void OnGlobalOper(userrec* user);
1162 /** Called whenever a user connects, anywhere on the network.
1163 * This event is informational only. You should not change any user information in this
1164 * event. To do so, use the OnUserConnect method to change the state of local users.
1165 * @param user The user who is connecting
1167 virtual void OnGlobalConnect(userrec* user);
1169 /** Called whenever a ban is added to a channel's list.
1170 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1171 * @param source The user adding the ban
1172 * @param channel The channel the ban is being added to
1173 * @param banmask The ban mask being added
1174 * @return 1 to block the ban, 0 to continue as normal
1176 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1178 /** Called whenever a ban is removed from a channel's list.
1179 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1180 * @param source The user deleting the ban
1181 * @param channel The channel the ban is being deleted from
1182 * @param banmask The ban mask being deleted
1183 * @return 1 to block the unban, 0 to continue as normal
1185 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1187 /** Called immediately after any connection is accepted. This is intended for raw socket
1188 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1189 * no information relating to a user record as the connection has not been assigned yet.
1190 * There are no return values from this call as all modules get an opportunity if required to
1191 * process the connection.
1192 * @param fd The file descriptor returned from accept()
1193 * @param ip The IP address of the connecting user
1194 * @param localport The local port number the user connected to
1196 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1198 /** Called immediately before any write() operation on a user's socket in the core. Because
1199 * this event is a low level event no user information is associated with it. It is intended
1200 * for use by modules which may wrap connections within another API such as SSL for example.
1201 * return a non-zero result if you have handled the write operation, in which case the core
1202 * will not call write().
1203 * @param fd The file descriptor of the socket
1204 * @param buffer A char* buffer being written
1205 * @param Number of characters to write
1206 * @return Number of characters actually written or 0 if you didn't handle the operation
1208 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1210 /** Called immediately before any socket is closed. When this event is called, shutdown()
1211 * has not yet been called on the socket.
1212 * @param fd The file descriptor of the socket prior to close()
1214 virtual void OnRawSocketClose(int fd);
1216 /** Called immediately before any read() operation on a client socket in the core.
1217 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1218 * when this event occurs.
1219 * Your event should return 1 if it has handled the reading itself, which prevents the core
1220 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1221 * the value of count. The value of readresult must be identical to an actual result that might
1222 * be returned from the read() system call, for example, number of bytes read upon success,
1223 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1224 * you MUST set readresult.
1225 * @param fd The file descriptor of the socket
1226 * @param buffer A char* buffer being read to
1227 * @param count The size of the buffer
1228 * @param readresult The amount of characters read, or 0
1229 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1231 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1233 /** Called whenever a user sets away.
1234 * This method has no parameter for the away message, as it is available in the
1235 * user record as userrec::awaymsg.
1237 virtual void OnSetAway(userrec* user);
1239 /** Called when a user cancels their away state.
1241 virtual void OnCancelAway(userrec* user);
1245 #define CONF_NOT_A_NUMBER 0x000010
1246 #define CONF_NOT_UNSIGNED 0x000080
1247 #define CONF_VALUE_NOT_FOUND 0x000100
1248 #define CONF_FILE_NOT_FOUND 0x000200
1251 /** Allows reading of values from configuration files
1252 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1253 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1254 * Constructing the class using one parameter allows you to specify a path to your own configuration
1255 * file, otherwise, inspircd.conf is read.
1257 class ConfigReader : public classbase
1260 InspIRCd* ServerInstance;
1261 /** The contents of the configuration file
1262 * This protected member should never be accessed by a module (and cannot be accessed unless the
1263 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1264 * (such as comments) stripped from it.
1266 ConfigDataHash* data;
1267 std::ostringstream* errorlog;;
1268 /** Used to store errors
1270 bool privatehash; // If we're using our own config data hash or not.
1275 /** Default constructor.
1276 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1277 * as specified when running ./configure.
1279 ConfigReader(InspIRCd* Instance);
1280 /** Overloaded constructor.
1281 * This constructor initialises the ConfigReader class to read a user-specified config file
1283 ConfigReader(InspIRCd* Instance, const std::string &filename);
1284 /** Default destructor.
1285 * This method destroys the ConfigReader class.
1288 /** Retrieves a value from the config file.
1289 * This method retrieves a value from the config file. Where multiple copies of the tag
1290 * exist in the config file, index indicates which of the values to retrieve.
1292 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1293 /** Retrieves a boolean value from the config file.
1294 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1295 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1296 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1298 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1299 /** Retrieves an integer value from the config file.
1300 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1301 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1302 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1303 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1304 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1305 * will return CONF_NOT_UNSIGNED
1307 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1308 /** Returns the last error to occur.
1309 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1310 * A call to GetError() resets the error flag back to 0.
1313 /** Counts the number of times a given tag appears in the config file.
1314 * This method counts the number of times a tag appears in a config file, for use where
1315 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1316 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1317 * multiple instance tag.
1319 int Enumerate(const std::string &tag);
1320 /** Returns true if a config file is valid.
1321 * This method is partially implemented and will only return false if the config
1322 * file does not exist or could not be opened.
1325 /** Dumps the list of errors in a config file to an output location. If bail is true,
1326 * then the program will abort. If bail is false and user points to a valid user
1327 * record, the error report will be spooled to the given user by means of NOTICE.
1328 * if bool is false AND user is false, the error report will be spooled to all opers
1329 * by means of a NOTICE to all opers.
1331 void DumpErrors(bool bail,userrec* user);
1333 /** Returns the number of items within a tag.
1334 * For example if the tag was <test tag="blah" data="foo"> then this
1335 * function would return 2. Spaces and newlines both qualify as valid seperators
1338 int EnumerateValues(const std::string &tag, int index);
1343 /** Caches a text file into memory and can be used to retrieve lines from it.
1344 * This class contains methods for read-only manipulation of a text file in memory.
1345 * Either use the constructor type with one parameter to load a file into memory
1346 * at construction, or use the LoadFile method to load a file.
1348 class FileReader : public classbase
1350 InspIRCd* ServerInstance;
1351 /** The file contents
1355 unsigned long contentsize;
1360 /** Default constructor.
1361 * This method does not load any file into memory, you must use the LoadFile method
1362 * after constructing the class this way.
1364 FileReader(InspIRCd* Instance);
1366 /** Secondary constructor.
1367 * This method initialises the class with a file loaded into it ready for GetLine and
1368 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1371 FileReader(InspIRCd* Instance, const std::string &filename);
1373 /** Default destructor.
1374 * This deletes the memory allocated to the file.
1378 /** Used to load a file.
1379 * This method loads a file into the class ready for GetLine and
1380 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1383 void LoadFile(const std::string &filename);
1385 /** Returns the whole content of the file as std::string
1387 std::string Contents();
1389 /** Returns the entire size of the file as std::string
1391 unsigned long ContentSize();
1393 /** Returns true if the file exists
1394 * This function will return false if the file could not be opened.
1398 /** Retrieve one line from the file.
1399 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1400 * the index was out of bounds, or the line had no data on it.
1402 std::string GetLine(int x);
1404 /** Returns the size of the file in lines.
1405 * This method returns the number of lines in the read file. If it is 0, no lines have been
1406 * read into memory, either because the file is empty or it does not exist, or cannot be
1407 * opened due to permission problems.
1413 /** Instantiates classes inherited from Module.
1414 * This class creates a class inherited from type Module, using new. This is to allow for modules
1415 * to create many different variants of Module, dependent on architecture, configuration, etc.
1416 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1419 class ModuleFactory : public classbase
1422 /** The default constructor does nothing.
1425 /** The default destructor does nothing
1427 virtual ~ModuleFactory() { }
1428 /** Creates a new module.
1429 * Your inherited class of ModuleFactory must return a pointer to your Module class
1430 * using this method.
1432 virtual Module * CreateModule(InspIRCd* Me) = 0;
1435 /** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
1437 typedef DLLFactory<ModuleFactory> ircd_module;
1439 /** A list of loaded Modules
1441 typedef std::vector<Module*> ModuleList;
1443 /** A list of loaded ModuleFactories
1445 typedef std::vector<ircd_module*> FactoryList;