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"
75 // Forward-delacare module for ModuleMessage etc
78 /** Low level definition of a FileReader classes file cache area
80 typedef std::deque<std::string> file_cache;
81 typedef file_cache string_list;
83 /** Holds a list of 'published features' for modules.
85 typedef std::map<std::string,Module*> featurelist;
88 * This #define allows us to call a method in all
89 * loaded modules in a readable simple way, e.g.:
90 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
92 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
93 for (int _i = 0; _i <= MODCOUNT; _i++) { \
94 if (ServerInstance->Config->implement_lists[_i][y]) \
99 catch (ModuleException& modexcept) \
101 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
106 #define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
107 for (int _i = 0; _i <= MODCOUNT; _i++) { \
108 if (z->Config->implement_lists[_i][y]) \
113 catch (ModuleException& modexcept) \
115 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
120 * This define is similar to the one above but returns a result in MOD_RESULT.
121 * The first module to return a nonzero result is the value to be accepted,
122 * and any modules after are ignored.
124 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
126 for (int _i = 0; _i <= MODCOUNT; _i++) { \
127 if (ServerInstance->Config->implement_lists[_i][y]) { \
130 int res = modules[_i]->x ; \
136 catch (ModuleException& modexcept) \
138 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
145 #define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
147 for (int _i = 0; _i <= MODCOUNT; _i++) { \
148 if (z->Config->implement_lists[_i][y]) { \
151 int res = modules[_i]->x ; \
157 catch (ModuleException& modexcept) \
159 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
166 #define FD_MAGIC_NUMBER -42
170 #define IS_LOCAL(x) ((x->fd > -1) && (x->fd <= MAX_DESCRIPTORS))
171 #define IS_REMOTE(x) (x->fd < 0)
172 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
174 /** Holds a module's Version information
175 * The four members (set by the constructor only) indicate details as to the version number
176 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
178 class Version : public classbase
181 const int Major, Minor, Revision, Build, Flags;
182 Version(int major, int minor, int revision, int build, int flags);
185 /** Holds /ADMIN data
186 * This class contains the admin details of the local server. It is constructed by class Server,
187 * and has three read-only values, Name, Email and Nick that contain the specified values for the
188 * server where the module is running.
190 class Admin : public classbase
193 const std::string Name, Email, Nick;
194 Admin(std::string name, std::string email, std::string nick);
197 /** The ModuleMessage class is the base class of Request and Event
198 * This class is used to represent a basic data structure which is passed
199 * between modules for safe inter-module communications.
201 class ModuleMessage : public classbase
204 /** This class is pure virtual and must be inherited.
206 virtual char* Send() = 0;
207 virtual ~ModuleMessage() {};
210 /** The Request class is a unicast message directed at a given module.
211 * When this class is properly instantiated it may be sent to a module
212 * using the Send() method, which will call the given module's OnRequest
213 * method with this class as its parameter.
215 class Request : public ModuleMessage
218 /** This member holds a pointer to arbitary data set by the emitter of the message
221 /** This should be a null-terminated string identifying the type of request,
222 * all modules should define this and use it to determine the nature of the
223 * request before they attempt to cast the Request in any way.
226 /** This is a pointer to the sender of the message, which can be used to
227 * directly trigger events, or to create a reply.
230 /** The single destination of the Request
234 /** Create a new Request
235 * This is for the 'old' way of casting whatever the data is
236 * to char* and hoping you get the right thing at the other end.
237 * This is slowly being depreciated in favor of the 'new' way.
239 Request(char* anydata, Module* src, Module* dst);
240 /** Create a new Request
241 * This is for the 'new' way of defining a subclass
242 * of Request and defining it in a common header,
243 * passing an object of your Request subclass through
244 * as a Request* and using the ID string to determine
245 * what to cast it back to and the other end. This is
246 * much safer as there are no casts not confirmed by
247 * the ID string, and all casts are child->parent and
248 * can be checked at runtime with dynamic_cast<>()
250 Request(Module* src, Module* dst, const char* idstr);
251 /** Fetch the Request data
254 /** Fetch the ID string
257 /** Fetch the request source
260 /** Fetch the request destination (should be 'this' in the receiving module)
263 /** Send the Request.
264 * Upon returning the result will be arbitary data returned by the module you
265 * sent the request to. It is up to your module to know what this data is and
266 * how to deal with it.
272 /** The Event class is a unicast message directed at all modules.
273 * When the class is properly instantiated it may be sent to all modules
274 * using the Send() method, which will trigger the OnEvent method in
275 * all modules passing the object as its parameter.
277 class Event : public ModuleMessage
280 /** This member holds a pointer to arbitary data set by the emitter of the message
283 /** This is a pointer to the sender of the message, which can be used to
284 * directly trigger events, or to create a reply.
287 /** The event identifier.
288 * This is arbitary text which should be used to distinguish
289 * one type of event from another.
293 /** Create a new Event
295 Event(char* anydata, Module* src, const std::string &eventid);
296 /** Get the Event data
299 /** Get the event Source
302 /** Get the event ID.
303 * Use this to determine the event type for safe casting of the data
305 std::string GetEventID();
307 * The return result of an Event::Send() will always be NULL as
308 * no replies are expected.
313 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
314 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
315 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
316 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
317 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
319 class ModuleException : public classbase
322 /** Holds the error message to be displayed
326 /** Default constructor, just uses the error mesage 'Module threw an exception'.
328 ModuleException() : err("Module threw an exception") {}
329 /** This constructor can be used to specify an error message before throwing.
331 ModuleException(std::string message) : err(message) {}
332 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
333 * Actually no, it does nothing. Never mind.
335 virtual ~ModuleException() {};
336 /** Returns the reason for the exception.
337 * The module should probably put something informative here as the user will see this upon failure.
339 virtual const char* GetReason()
345 /** Priority types which can be returned from Module::Prioritize()
347 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
349 /** Implementation-specific flags which may be set in Module::Implements()
351 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
352 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
353 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
354 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
355 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
356 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
357 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
358 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
359 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
360 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
361 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
362 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
364 /** Base class for all InspIRCd modules
365 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
366 * its methods will be called when irc server events occur. class inherited from module must be
367 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
369 class Module : public Extensible
373 /** Default constructor
374 * Creates a module class.
375 * @param Me An instance of the Server class which can be saved for future use
376 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
380 /** Default destructor
381 * destroys a module class
385 /** Returns the version number of a Module.
386 * The method should return a Version object with its version information assigned via
389 virtual Version GetVersion();
391 /** The Implements function specifies which methods a module should receive events for.
392 * The char* parameter passed to this function contains a set of true or false values
393 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
394 * enum (documented elsewhere on this page) to mark functions as active. For example, to
395 * receive events for OnUserJoin():
397 * Implements[I_OnUserJoin] = 1;
399 * @param The implement list
401 virtual void Implements(char* Implements);
403 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
404 * Some modules prefer to be called before other modules, due to their design. For example, a
405 * module which is expected to operate on complete information would expect to be placed last, so
406 * that any other modules which wish to adjust that information would execute before it, to be sure
407 * its information is correct. You can change your module's priority by returning one of:
409 * PRIORITY_FIRST - To place your module first in the list
411 * PRIORITY_LAST - To place your module last in the list
413 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
415 * The result of Server::PriorityBefore() - To move your module before another named module
417 * The result of Server::PriorityLast() - To move your module after another named module
419 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
420 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
421 * your module has a real need to reorder its priority, it should not implement this function,
422 * as many modules changing their priorities can make the system redundant.
424 virtual Priority Prioritize();
426 /** Called when a user connects.
427 * The details of the connecting user are available to you in the parameter userrec *user
428 * @param user The user who is connecting
430 virtual void OnUserConnect(userrec* user);
432 /** Called when a user quits.
433 * The details of the exiting user are available to you in the parameter userrec *user
434 * This event is only called when the user is fully registered when they quit. To catch
435 * raw disconnections, use the OnUserDisconnect method.
436 * @param user The user who is quitting
437 * @param message The user's quit message
439 virtual void OnUserQuit(userrec* user, const std::string &message);
441 /** Called whenever a user's socket is closed.
442 * The details of the exiting user are available to you in the parameter userrec *user
443 * This event is called for all users, registered or not, as a cleanup method for modules
444 * which might assign resources to user, such as dns lookups, objects and sockets.
445 * @param user The user who is disconnecting
447 virtual void OnUserDisconnect(userrec* user);
449 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
450 * @param chan The channel being deleted
452 virtual void OnChannelDelete(chanrec* chan);
454 /** Called when a user joins a channel.
455 * The details of the joining user are available to you in the parameter userrec *user,
456 * and the details of the channel they have joined is available in the variable chanrec *channel
457 * @param user The user who is joining
458 * @param channel The channel being joined
460 virtual void OnUserJoin(userrec* user, chanrec* channel);
462 /** Called when a user parts a channel.
463 * The details of the leaving user are available to you in the parameter userrec *user,
464 * and the details of the channel they have left is available in the variable chanrec *channel
465 * @param user The user who is parting
466 * @param channel The channel being parted
467 * @param partmessage The part message, or an empty string
469 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
471 /** Called on rehash.
472 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
473 * system. You should use it to reload any files so that your module keeps in step with the
474 * rest of the application. If a parameter is given, the core has done nothing. The module
475 * receiving the event can decide if this parameter has any relevence to it.
476 * @param parameter The (optional) parameter given to REHASH from the user.
478 virtual void OnRehash(const std::string ¶meter);
480 /** Called when a raw command is transmitted or received.
481 * This method is the lowest level of handler available to a module. It will be called with raw
482 * data which is passing through a connected socket. If you wish, you may munge this data by changing
483 * the string parameter "raw". If you do this, after your function exits it will immediately be
484 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
485 * inbound is set to true) the value of user will be the userrec of the connection sending the
486 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
487 * @param raw The raw string in RFC1459 format
488 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
489 * @param user The user record sending the text, when inbound == true.
491 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
493 /** Called whenever a user is about to join a channel, before any processing is done.
494 * Returning a value of 1 from this function stops the process immediately, causing no
495 * output to be sent to the user by the core. If you do this you must produce your own numerics,
496 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
497 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
501 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
502 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
503 * processing on the actual channel record at this point, however the channel NAME will still be passed in
504 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
505 * @param user The user joining the channel
506 * @param cname The channel name being joined
507 * @return 1 To prevent the join, 0 to allow it.
509 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
511 /** Called whenever a user is about to be kicked.
512 * Returning a value of 1 from this function stops the process immediately, causing no
513 * output to be sent to the user by the core. If you do this you must produce your own numerics,
515 * @param source The user issuing the kick
516 * @param user The user being kicked
517 * @param chan The channel the user is being kicked from
518 * @param reason The kick reason
519 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
521 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
523 /** Called whenever a user is kicked.
524 * If this method is called, the kick is already underway and cannot be prevented, so
525 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
526 * @param source The user issuing the kick
527 * @param user The user being kicked
528 * @param chan The channel the user is being kicked from
529 * @param reason The kick reason
531 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
533 /** Called whenever a user opers locally.
534 * The userrec will contain the oper mode 'o' as this function is called after any modifications
535 * are made to the user's structure by the core.
536 * @param user The user who is opering up
537 * @param opertype The opers type name
539 virtual void OnOper(userrec* user, const std::string &opertype);
541 /** Called after a user opers locally.
542 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
543 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
544 * out the OPERTYPE, etc.
545 * @param user The user who is opering up
546 * @param opertype The opers type name
548 virtual void OnPostOper(userrec* user, const std::string &opertype);
550 /** Called whenever a user types /INFO.
551 * The userrec will contain the information of the user who typed the command. Modules may use this
552 * method to output their own credits in /INFO (which is the ircd's version of an about box).
553 * It is purposefully not possible to modify any info that has already been output, or halt the list.
554 * You must write a 371 numeric to the user, containing your info in the following format:
556 * <nick> :information here
558 * @param user The user issuing /INFO
560 virtual void OnInfo(userrec* user);
562 /** Called whenever a /WHOIS is performed on a local user.
563 * The source parameter contains the details of the user who issued the WHOIS command, and
564 * the dest parameter contains the information of the user they are whoising.
565 * @param source The user issuing the WHOIS command
566 * @param dest The user who is being WHOISed
568 virtual void OnWhois(userrec* source, userrec* dest);
570 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
571 * Returning 1 from this function stops the process immediately, causing no
572 * output to be sent to the user by the core. If you do this you must produce your own numerics,
573 * notices etc. This is useful for modules which may want to filter invites to channels.
574 * @param source The user who is issuing the INVITE
575 * @param dest The user being invited
576 * @param channel The channel the user is being invited to
577 * @return 1 to deny the invite, 0 to allow
579 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
581 /** Called after a user has been successfully invited to a channel.
582 * You cannot prevent the invite from occuring using this function, to do that,
583 * use OnUserPreInvite instead.
584 * @param source The user who is issuing the INVITE
585 * @param dest The user being invited
586 * @param channel The channel the user is being invited to
588 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
590 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
591 * Returning any nonzero value from this function stops the process immediately, causing no
592 * output to be sent to the user by the core. If you do this you must produce your own numerics,
593 * notices etc. This is useful for modules which may want to filter or redirect messages.
594 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
595 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
596 * of where the message is destined to be sent.
597 * @param user The user sending the message
598 * @param dest The target of the message (chanrec* or userrec*)
599 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
600 * @param text Changeable text being sent by the user
601 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
602 * @return 1 to deny the NOTICE, 0 to allow it
604 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
606 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
607 * Returning any nonzero value from this function stops the process immediately, causing no
608 * output to be sent to the user by the core. If you do this you must produce your own numerics,
609 * notices etc. This is useful for modules which may want to filter or redirect messages.
610 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
611 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
612 * of where the message is destined to be sent.
613 * You may alter the message text as you wish before relinquishing control to the next module
614 * in the chain, and if no other modules block the text this altered form of the text will be sent out
615 * to the user and possibly to other servers.
616 * @param user The user sending the message
617 * @param dest The target of the message (chanrec* or userrec*)
618 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
619 * @param text Changeable text being sent by the user
620 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
621 * @return 1 to deny the NOTICE, 0 to allow it
623 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
625 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
626 * Please note that although you can see remote nickchanges through this function, you should
627 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
628 * check user->server before taking any action (including returning nonzero from the method).
629 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
630 * module to generate some meaninful output.
631 * @param user The username changing their nick
632 * @param newnick Their new nickname
633 * @return 1 to deny the change, 0 to allow
635 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
637 /** Called after any PRIVMSG sent from a user.
638 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
639 * if target_type is TYPE_CHANNEL.
640 * @param user The user sending the message
641 * @param dest The target of the message
642 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
643 * @param text the text being sent by the user
644 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
646 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
648 /** Called after any NOTICE sent from a user.
649 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
650 * if target_type is TYPE_CHANNEL.
651 * @param user The user sending the message
652 * @param dest The target of the message
653 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
654 * @param text the text being sent by the user
655 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
657 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
659 /** Called after every MODE command sent from a user
660 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
661 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
662 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
663 * @param user The user sending the MODEs
664 * @param dest The target of the modes (userrec* or chanrec*)
665 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
666 * @param text The actual modes and their parameters if any
668 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
670 /** Allows modules to alter or create server descriptions
671 * Whenever a module requires a server description, for example for display in
672 * WHOIS, this function is called in all modules. You may change or define the
673 * description given in std::string &description. If you do, this description
674 * will be shown in the WHOIS fields.
675 * @param servername The servername being searched for
676 * @param description Alterable server description for this server
678 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
680 /** Allows modules to synchronize data which relates to users 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!
688 * @param user The user being syncronized
689 * @param proto A pointer to the module handling network protocol
690 * @param opaque An opaque pointer set by the protocol module, should not be modified!
692 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
694 /** Allows modules to synchronize data which relates to channels during a netburst.
695 * When this function is called, it will be called from the module which implements
696 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
697 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
698 * (see below). This function will be called for every user visible on your side
699 * of the burst, allowing you to for example set modes, etc. Do not use this call to
700 * synchronize data which you have stored using class Extensible -- There is a specialist
701 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
703 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
705 * @param chan The channel being syncronized
706 * @param proto A pointer to the module handling network protocol
707 * @param opaque An opaque pointer set by the protocol module, should not be modified!
709 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
711 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
712 * Whenever the linking module wants to send out data, but doesnt know what the data
713 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
714 * this method is called.You should use the ProtoSendMetaData function after you've
715 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
716 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
717 * @param chan The channel whos metadata is being syncronized
718 * @param proto A pointer to the module handling network protocol
719 * @param opaque An opaque pointer set by the protocol module, should not be modified!
720 * @param extname The extensions name which is being searched for
722 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
724 /* Allows modules to syncronize metadata related to users over the network during a netburst.
725 * Whenever the linking module wants to send out data, but doesnt know what the data
726 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
727 * this method is called. You should use the ProtoSendMetaData function after you've
728 * correctly decided how the data should be represented, to send the metadata on its way if
729 * if it belongs to your module.
730 * @param user The user whos metadata is being syncronized
731 * @param proto A pointer to the module handling network protocol
732 * @param opaque An opaque pointer set by the protocol module, should not be modified!
733 * @param extname The extensions name which is being searched for
735 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
737 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
738 * Whenever the linking module wants to send out data, but doesnt know what the data
739 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
740 * this method is called. You should use the ProtoSendMetaData function after you've
741 * correctly decided how the data should be represented, to send the metadata on its way if
742 * if it belongs to your module.
743 * @param proto A pointer to the module handling network protocol
744 * @param opaque An opaque pointer set by the protocol module, should not be modified!
746 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
748 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
749 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
750 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
751 * @param target The chanrec* or userrec* that data should be added to
752 * @param extname The extension name which is being sent
753 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
755 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
757 /** Implemented by modules which provide the ability to link servers.
758 * These modules will implement this method, which allows transparent sending of servermodes
759 * down the network link as a broadcast, without a module calling it having to know the format
760 * of the MODE command before the actual mode string.
762 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
763 * of how to use this function.
765 * @param opaque An opaque pointer set by the protocol module, should not be modified!
766 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
767 * @param target The chanrec* or userrec* that modes should be sent for
768 * @param modeline The modes and parameters to be sent
770 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
772 /** Implemented by modules which provide the ability to link servers.
773 * These modules will implement this method, which allows metadata (extra data added to
774 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
775 * to other servers on a netburst and decoded at the other end by the same module on a
778 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
779 * how to use this function.
780 * @param opaque An opaque pointer set by the protocol module, should not be modified!
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 metadata should be sent for
783 * @param extname The extension name to send metadata for
784 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
786 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
788 /** Called after every WALLOPS command.
789 * @param user The user sending the WALLOPS
790 * @param text The content of the WALLOPS message
792 virtual void OnWallops(userrec* user, const std::string &text);
794 /** Called whenever a user's hostname is changed.
795 * This event triggers after the host has been set.
796 * @param user The user whos host is being changed
797 * @param newhost The new hostname being set
799 virtual void OnChangeHost(userrec* user, const std::string &newhost);
801 /** Called whenever a user's GECOS (realname) is changed.
802 * This event triggers after the name has been set.
803 * @param user The user who's GECOS is being changed
804 * @param gecos The new GECOS being set on the user
806 virtual void OnChangeName(userrec* user, const std::string &gecos);
808 /** Called whenever a gline is added by a local user.
809 * This method is triggered after the line is added.
810 * @param duration The duration of the line in seconds
811 * @param source The sender of the line
812 * @param reason The reason text to be displayed
813 * @param hostmask The hostmask to add
815 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
817 /** Called whenever a zline is added by a local user.
818 * This method is triggered after the line is added.
819 * @param duration The duration of the line in seconds
820 * @param source The sender of the line
821 * @param reason The reason text to be displayed
822 * @param ipmask The hostmask to add
824 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
826 /** Called whenever a kline is added by a local user.
827 * This method is triggered after the line is added.
828 * @param duration The duration of the line in seconds
829 * @param source The sender of the line
830 * @param reason The reason text to be displayed
831 * @param hostmask The hostmask to add
833 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
835 /** Called whenever a qline is added by a local user.
836 * This method is triggered after the line is added.
837 * @param duration The duration of the line in seconds
838 * @param source The sender of the line
839 * @param reason The reason text to be displayed
840 * @param nickmask The hostmask to add
842 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
844 /** Called whenever a eline is added by a local user.
845 * This method is triggered after the line is added.
846 * @param duration The duration of the line in seconds
847 * @param source The sender of the line
848 * @param reason The reason text to be displayed
849 * @param hostmask The hostmask to add
851 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
853 /** Called whenever a gline 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 OnDelGLine(userrec* source, const std::string &hostmask);
860 /** Called whenever a zline 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 OnDelZLine(userrec* source, const std::string &ipmask);
867 /** Called whenever a kline 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 OnDelKLine(userrec* source, const std::string &hostmask);
874 /** Called whenever a qline is deleted.
875 * This method is triggered after the line is deleted.
876 * @param source The user removing the line
877 * @param hostmask The hostmask to delete
879 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
881 /** Called whenever a eline is deleted.
882 * This method is triggered after the line is deleted.
883 * @param source The user removing the line
884 * @param hostmask The hostmask to delete
886 virtual void OnDelELine(userrec* source, const std::string &hostmask);
888 /** Called before your module is unloaded to clean up Extensibles.
889 * This method is called once for every user and channel on the network,
890 * so that when your module unloads it may clear up any remaining data
891 * in the form of Extensibles added using Extensible::Extend().
892 * If the target_type variable is TYPE_USER, then void* item refers to
893 * a userrec*, otherwise it refers to a chanrec*.
894 * @param target_type The type of item being cleaned
895 * @param item A pointer to the item's class
897 virtual void OnCleanup(int target_type, void* item);
899 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
900 * have been applied. Please note that although you can see remote nickchanges through this function, you should
901 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
902 * check user->server before taking any action (including returning nonzero from the method).
903 * Because this method is called after the nickchange is taken place, no return values are possible
904 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
905 * @param user The user changing their nick
906 * @param oldnick The old nickname of the user before the nickchange
908 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
910 /** Called before an action which requires a channel privilage check.
911 * This function is called before many functions which check a users status on a channel, for example
912 * before opping a user, deopping a user, kicking a user, etc.
913 * There are several values for access_type which indicate for what reason access is being checked.
915 * AC_KICK (0) - A user is being kicked<br>
916 * AC_DEOP (1) - a user is being deopped<br>
917 * AC_OP (2) - a user is being opped<br>
918 * AC_VOICE (3) - a user is being voiced<br>
919 * AC_DEVOICE (4) - a user is being devoiced<br>
920 * AC_HALFOP (5) - a user is being halfopped<br>
921 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
922 * AC_INVITE () - a user is being invited<br>
923 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
924 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
925 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
926 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
927 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
928 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
929 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
930 * @param source The source of the access check
931 * @param dest The destination of the access check
932 * @param channel The channel which is being checked
933 * @param access_type See above
935 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
937 /** Called when a 005 numeric is about to be output.
938 * The module should modify the 005 numeric if needed to indicate its features.
939 * @param output The 005 string to be modified if neccessary.
941 virtual void On005Numeric(std::string &output);
943 /** Called when a client is disconnected by KILL.
944 * If a client is killed by a server, e.g. a nickname collision or protocol error,
946 * Return 1 from this function to prevent the kill, and 0 from this function to allow
947 * it as normal. If you prevent the kill no output will be sent to the client, it is
948 * down to your module to generate this information.
949 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
950 * If you do so youre risking race conditions, desyncs and worse!
951 * @param source The user sending the KILL
952 * @param dest The user being killed
953 * @param reason The kill reason
954 * @return 1 to prevent the kill, 0 to allow
956 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
958 /** Called when an oper wants to disconnect a remote user via KILL
959 * @param source The user sending the KILL
960 * @param dest The user being killed
961 * @param reason The kill reason
963 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
965 /** Called whenever a module is loaded.
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 A pointer to the new module
975 * @param name The new module's filename
977 virtual void OnLoadModule(Module* mod,const std::string &name);
979 /** Called whenever a module is unloaded.
980 * mod will contain a pointer to the module, and string will contain its name,
981 * for example m_widgets.so. This function is primary for dependency checking,
982 * your module may decide to enable some extra features if it sees that you have
983 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
984 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
985 * but instead operate under reduced functionality, unless the dependency is
986 * absolutely neccessary (e.g. a module that extends the features of another
988 * @param mod Pointer to the module being unloaded (still valid)
989 * @param name The filename of the module being unloaded
991 virtual void OnUnloadModule(Module* mod,const std::string &name);
993 /** Called once every five seconds for background processing.
994 * This timer can be used to control timed features. Its period is not accurate
995 * enough to be used as a clock, but it is gauranteed to be called at least once in
996 * any five second period, directly from the main loop of the server.
997 * @param curtime The current timer derived from time(2)
999 virtual void OnBackgroundTimer(time_t curtime);
1001 /** Called whenever any command is about to be executed.
1002 * This event occurs for all registered commands, wether they are registered in the core,
1003 * or another module, but it will not occur for invalid commands (e.g. ones which do not
1004 * exist within the command table). By returning 1 from this method you may prevent the
1005 * command being executed. If you do this, no output is created by the core, and it is
1006 * down to your module to produce any output neccessary.
1007 * Note that unless you return 1, you should not destroy any structures (e.g. by using
1008 * Server::QuitUser) otherwise when the command's handler function executes after your
1009 * method returns, it will be passed an invalid pointer to the user object and crash!)
1010 * @param command The command being executed
1011 * @param parameters An array of array of characters containing the parameters for the command
1012 * @param pcnt The nuimber of parameters passed to the command
1013 * @param user the user issuing the command
1014 * @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.
1015 * @return 1 to block the command, 0 to allow
1017 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
1019 /** Called to check if a user who is connecting can now be allowed to register
1020 * If any modules return false for this function, the user is held in the waiting
1021 * state until all modules return true. For example a module which implements ident
1022 * lookups will continue to return false for a user until their ident lookup is completed.
1023 * Note that the registration timeout for a user overrides these checks, if the registration
1024 * timeout is reached, the user is disconnected even if modules report that the user is
1025 * not ready to connect.
1026 * @param user The user to check
1027 * @return true to indicate readiness, false if otherwise
1029 virtual bool OnCheckReady(userrec* user);
1031 /** Called whenever a user is about to register their connection (e.g. before the user
1032 * is sent the MOTD etc). Modules can use this method if they are performing a function
1033 * which must be done before the actual connection is completed (e.g. ident lookups,
1034 * dnsbl lookups, etc).
1035 * Note that you should NOT delete the user record here by causing a disconnection!
1036 * Use OnUserConnect for that instead.
1037 * @param user The user registering
1039 virtual void OnUserRegister(userrec* user);
1041 /** Called whenever a mode character is processed.
1042 * Return 1 from this function to block the mode character from being processed entirely,
1043 * so that you may perform your own code instead. Note that this method allows you to override
1044 * modes defined by other modes, but this is NOT RECOMMENDED!
1045 * @param user The user who is sending the mode
1046 * @param chan The channel the mode is being sent to
1047 * @param mode The mode character being set
1048 * @param param The parameter for the mode or an empty string
1049 * @param adding true of the mode is being added, false if it is being removed
1050 * @param pcnt The parameter count for the mode (0 or 1)
1051 * @return 1 to deny the mode, 0 to allow
1053 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1055 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1056 * This method will always be called for each join, wether or not the channel is actually +i, and
1057 * determines the outcome of an if statement around the whole section of invite checking code.
1058 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1059 * @param user The user joining the channel
1060 * @param chan The channel being joined
1061 * @return 1 to explicitly allow the join, 0 to proceed as normal
1063 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1065 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1066 * This method will always be called for each join, wether or not the channel is actually +k, and
1067 * determines the outcome of an if statement around the whole section of key checking code.
1068 * if the user specified no key, the keygiven string will be a valid but empty value.
1069 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1070 * @param user The user joining the channel
1071 * @param chan The channel being joined
1072 * @return 1 to explicitly allow the join, 0 to proceed as normal
1074 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1076 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1077 * This method will always be called for each join, wether or not the channel is actually +l, and
1078 * determines the outcome of an if statement around the whole section of channel limit checking code.
1079 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1080 * @param user The user joining the channel
1081 * @param chan The channel being joined
1082 * @return 1 to explicitly allow the join, 0 to proceed as normal
1084 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1086 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1087 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1088 * determines the outcome of an if statement around the whole section of ban checking code.
1089 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1090 * @param user The user joining the channel
1091 * @param chan The channel being joined
1092 * @return 1 to explicitly allow the join, 0 to proceed as normal
1094 virtual int OnCheckBan(userrec* user, chanrec* chan);
1096 /** Called on all /STATS commands
1097 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1098 * @param symbol the symbol provided to /STATS
1099 * @param user the user issuing the /STATS command
1100 * @param results A string_list to append results into
1101 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1103 virtual int OnStats(char symbol, userrec* user, string_list &results);
1105 /** Called whenever a change of a local users displayed host is attempted.
1106 * Return 1 to deny the host change, or 0 to allow it.
1107 * @param user The user whos host will be changed
1108 * @param newhost The new hostname
1109 * @return 1 to deny the host change, 0 to allow
1111 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1113 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1114 * return 1 to deny the name change, or 0 to allow it.
1115 * @param user The user whos GECOS will be changed
1116 * @param newhost The new GECOS
1117 * @return 1 to deny the GECOS change, 0 to allow
1119 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1121 /** Called whenever a topic is changed by a local user.
1122 * Return 1 to deny the topic change, or 0 to allow it.
1123 * @param user The user changing the topic
1124 * @param chan The channels who's topic is being changed
1125 * @param topic The actual topic text
1126 * @param 1 to block the topic change, 0 to allow
1128 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1130 /** Called whenever a local topic has been changed.
1131 * To block topic changes you must use OnLocalTopicChange instead.
1132 * @param user The user changing the topic
1133 * @param chan The channels who's topic is being changed
1134 * @param topic The actual topic text
1136 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1138 /** Called whenever an Event class is sent to all module by another module.
1139 * Please see the documentation of Event::Send() for further information. The Event sent can
1140 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1141 * before doing anything to the event data, and you should *not* change the event data in any way!
1142 * @param event The Event class being received
1144 virtual void OnEvent(Event* event);
1146 /** Called whenever a Request class is sent to your module by another module.
1147 * Please see the documentation of Request::Send() for further information. The Request sent
1148 * can always be assumed to be non-NULL, you should not change the request object or its data.
1149 * Your method may return arbitary data in the char* result which the requesting module
1150 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1151 * @param request The Request class being received
1153 virtual char* OnRequest(Request* request);
1155 /** Called whenever an oper password is to be compared to what a user has input.
1156 * The password field (from the config file) is in 'password' and is to be compared against
1157 * 'input'. This method allows for encryption of oper passwords and much more besides.
1158 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1160 * @param password The oper's password
1161 * @param input The password entered
1162 * @return 1 to match the passwords, 0 to do nothing
1164 virtual int OnOperCompare(const std::string &password, const std::string &input);
1166 /** Called whenever a user is given usermode +o, anywhere on the network.
1167 * You cannot override this and prevent it from happening as it is already happened and
1168 * such a task must be performed by another server. You can however bounce modes by sending
1169 * servermodes out to reverse mode changes.
1170 * @param user The user who is opering
1172 virtual void OnGlobalOper(userrec* user);
1174 /** Called whenever a user connects, anywhere on the network.
1175 * This event is informational only. You should not change any user information in this
1176 * event. To do so, use the OnUserConnect method to change the state of local users.
1177 * @param user The user who is connecting
1179 virtual void OnGlobalConnect(userrec* user);
1181 /** Called whenever a ban is added to a channel's list.
1182 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1183 * @param source The user adding the ban
1184 * @param channel The channel the ban is being added to
1185 * @param banmask The ban mask being added
1186 * @return 1 to block the ban, 0 to continue as normal
1188 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1190 /** Called whenever a ban is removed from a channel's list.
1191 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1192 * @param source The user deleting the ban
1193 * @param channel The channel the ban is being deleted from
1194 * @param banmask The ban mask being deleted
1195 * @return 1 to block the unban, 0 to continue as normal
1197 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1199 /** Called immediately after any connection is accepted. This is intended for raw socket
1200 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1201 * no information relating to a user record as the connection has not been assigned yet.
1202 * There are no return values from this call as all modules get an opportunity if required to
1203 * process the connection.
1204 * @param fd The file descriptor returned from accept()
1205 * @param ip The IP address of the connecting user
1206 * @param localport The local port number the user connected to
1208 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1210 /** Called immediately before any write() operation on a user's socket in the core. Because
1211 * this event is a low level event no user information is associated with it. It is intended
1212 * for use by modules which may wrap connections within another API such as SSL for example.
1213 * return a non-zero result if you have handled the write operation, in which case the core
1214 * will not call write().
1215 * @param fd The file descriptor of the socket
1216 * @param buffer A char* buffer being written
1217 * @param Number of characters to write
1218 * @return Number of characters actually written or 0 if you didn't handle the operation
1220 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1222 /** Called immediately before any socket is closed. When this event is called, shutdown()
1223 * has not yet been called on the socket.
1224 * @param fd The file descriptor of the socket prior to close()
1226 virtual void OnRawSocketClose(int fd);
1228 /** Called immediately before any read() operation on a client socket in the core.
1229 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1230 * when this event occurs.
1231 * Your event should return 1 if it has handled the reading itself, which prevents the core
1232 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1233 * the value of count. The value of readresult must be identical to an actual result that might
1234 * be returned from the read() system call, for example, number of bytes read upon success,
1235 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1236 * you MUST set readresult.
1237 * @param fd The file descriptor of the socket
1238 * @param buffer A char* buffer being read to
1239 * @param count The size of the buffer
1240 * @param readresult The amount of characters read, or 0
1241 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1243 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1245 /** Called whenever a user sets away.
1246 * This method has no parameter for the away message, as it is available in the
1247 * user record as userrec::awaymsg.
1249 virtual void OnSetAway(userrec* user);
1251 /** Called when a user cancels their away state.
1253 virtual void OnCancelAway(userrec* user);
1257 /** Allows server output and query functions
1258 * This class contains methods which allow a module to query the state of the irc server, and produce
1259 * output to users and other servers. All modules should instantiate at least one copy of this class,
1260 * and use its member functions to perform their tasks.
1262 class Server : public Extensible
1265 /** Default constructor.
1266 * Creates a Server object.
1270 /** Default destructor.
1271 * Destroys a Server object.
1275 /** Obtains a pointer to the server's ServerConfig object.
1276 * The ServerConfig object contains most of the configuration data
1277 * of the IRC server, as read from the config file by the core.
1279 ServerConfig* GetConfig();
1281 /** For use with Module::Prioritize().
1282 * When the return value of this function is returned from
1283 * Module::Prioritize(), this specifies that the module wishes
1284 * to be ordered exactly BEFORE 'modulename'. For more information
1285 * please see Module::Prioritize().
1286 * @param modulename The module your module wants to be before in the call list
1287 * @returns a priority ID which the core uses to relocate the module in the list
1289 long PriorityBefore(const std::string &modulename);
1291 /** For use with Module::Prioritize().
1292 * When the return value of this function is returned from
1293 * Module::Prioritize(), this specifies that the module wishes
1294 * to be ordered exactly AFTER 'modulename'. For more information please
1295 * see Module::Prioritize().
1296 * @param modulename The module your module wants to be after in the call list
1297 * @returns a priority ID which the core uses to relocate the module in the list
1299 long PriorityAfter(const std::string &modulename);
1301 /** Returns the version string of this server
1303 std::string GetVersion();
1305 /** Publish a 'feature'.
1306 * There are two ways for a module to find another module it depends on.
1307 * Either by name, using Server::FindModule, or by feature, using this
1308 * function. A feature is an arbitary string which identifies something this
1309 * module can do. For example, if your module provides SSL support, but other
1310 * modules provide SSL support too, all the modules supporting SSL should
1311 * publish an identical 'SSL' feature. This way, any module requiring use
1312 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1313 * then use the module pointer they are given.
1314 * @param FeatureName The case sensitive feature name to make available
1315 * @param Mod a pointer to your module class
1316 * @returns True on success, false if the feature is already published by
1319 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1321 /** Unpublish a 'feature'.
1322 * When your module exits, it must call this method for every feature it
1323 * is providing so that the feature table is cleaned up.
1324 * @param FeatureName the feature to remove
1326 bool UnpublishFeature(const std::string &FeatureName);
1328 /** Find a 'feature'.
1329 * There are two ways for a module to find another module it depends on.
1330 * Either by name, using Server::FindModule, or by feature, using the
1331 * Server::PublishFeature method. A feature is an arbitary string which
1332 * identifies something this module can do. For example, if your module
1333 * provides SSL support, but other modules provide SSL support too, all
1334 * the modules supporting SSL should publish an identical 'SSL' feature.
1335 * To find a module capable of providing the feature you want, simply
1336 * call this method with the feature name you are looking for.
1337 * @param FeatureName The feature name you wish to obtain the module for
1338 * @returns A pointer to a valid module class on success, NULL on failure.
1340 Module* FindFeature(const std::string &FeatureName);
1342 const std::string& GetModuleName(Module* m);
1344 /** Writes a log string.
1345 * This method writes a line of text to the log. If the level given is lower than the
1346 * level given in the configuration, this command has no effect.
1348 virtual void Log(int level, const std::string &s);
1350 /** Returns true if a nick is valid.
1351 * Nicks for unregistered connections will return false.
1353 virtual bool IsNick(const std::string &nick);
1355 /** Attempts to look up a nick using the file descriptor associated with that nick.
1356 * This function will return NULL if the file descriptor is not associated with a valid user.
1358 virtual userrec* FindDescriptor(int socket);
1360 /** Attempts to look up a user's privilages on a channel.
1361 * This function will return a string containing either @, %, +, or an empty string,
1362 * representing the user's privilages upon the channel you specify.
1364 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1366 /** Returns the server name of the server where the module is loaded.
1368 virtual std::string GetServerName();
1370 /** Returns the network name, global to all linked servers.
1372 virtual std::string GetNetworkName();
1374 /** Returns the server description string of the local server
1376 virtual std::string GetServerDescription();
1378 /** Returns the information of the server as returned by the /ADMIN command.
1379 * See the Admin class for further information of the return value. The members
1380 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1381 * server where the module is loaded.
1383 virtual Admin GetAdmin();
1385 virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
1387 virtual bool AddModeWatcher(ModeWatcher* mw);
1389 virtual bool DelModeWatcher(ModeWatcher* mw);
1391 virtual bool AddResolver(Resolver* r);
1393 /** Adds a command to the command table.
1394 * This allows modules to add extra commands into the command table. You must place a function within your
1395 * module which is is of type handlerfunc:
1397 * typedef void (handlerfunc) (char**, int, userrec*);
1399 * void handle_kill(char **parameters, int pcnt, userrec *user)
1401 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1402 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1403 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1404 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1405 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1406 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1407 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1410 virtual void AddCommand(command_t *f);
1412 /** Sends a servermode.
1413 * you must format the parameters array with the target, modes and parameters for those modes.
1419 * modes[0] = ChannelName;
1423 * modes[2] = user->nick;
1425 * Srv->SendMode(modes,3,user);
1427 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1428 * will be sent to the user you provide as the third parameter.
1429 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1430 * your server in an unstable state!
1433 virtual void SendMode(const char **parameters, int pcnt, userrec *user);
1435 /** Matches text against a glob pattern.
1436 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1437 * Returns true if the literal successfully matches the pattern, false if otherwise.
1439 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1441 /** Calls the handler for a command, either implemented by the core or by another module.
1442 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1443 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1444 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1445 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1446 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1447 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1448 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1449 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1450 * used for privilage checks, etc.
1451 * @return True if the command exists
1453 virtual bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1455 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1456 * of paramters the command requires, the user specified is allowed to execute the command, AND
1457 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1458 * within network protocols (see src/modules/m_spanningtree.cpp)
1460 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1462 /** Returns true if the servername you give is ulined.
1463 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1464 * change modes of clients which are on remote servers and set modes of channels where there are
1465 * no channel operators for that channel on the ulined server, amongst other things.
1467 virtual bool IsUlined(const std::string &server);
1470 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1471 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1472 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1473 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1476 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1479 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1480 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1481 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1482 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1485 virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1488 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1489 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1490 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1491 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1494 virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1497 * The K-line is enforced as soon as it is added.
1498 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1499 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1500 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1503 virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1506 * The E-line is enforced as soon as it is added.
1507 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1508 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1509 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1512 virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1514 /** Deletes a G-Line from all servers
1516 virtual bool DelGLine(const std::string &hostmask);
1518 /** Deletes a Q-Line from all servers
1520 virtual bool DelQLine(const std::string &nickname);
1522 /** Deletes a Z-Line from all servers
1524 virtual bool DelZLine(const std::string &ipaddr);
1526 /** Deletes a local K-Line
1528 virtual bool DelKLine(const std::string &hostmask);
1530 /** Deletes a local E-Line
1532 virtual bool DelELine(const std::string &hostmask);
1534 /** Calculates a duration
1535 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1536 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1539 virtual long CalcDuration(const std::string &duration);
1541 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1543 virtual bool IsValidMask(const std::string &mask);
1545 /** This function finds a module by name.
1546 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1547 * the function will return NULL.
1549 virtual Module* FindModule(const std::string &name);
1551 /** Adds a class derived from InspSocket to the server's socket engine.
1553 virtual void AddSocket(InspSocket* sock);
1555 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1557 virtual void RemoveSocket(InspSocket* sock);
1559 /** Deletes a class derived from InspSocket from the server's socket engine.
1561 virtual void DelSocket(InspSocket* sock);
1563 /** Causes the local server to rehash immediately.
1564 * WARNING: Do not call this method from within your rehash method, for
1567 virtual void RehashServer();
1569 /** This method returns the total number of channels on the network.
1571 virtual long GetChannelCount();
1573 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1574 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1575 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1578 virtual chanrec* GetChannelIndex(long index);
1580 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1581 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1584 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1588 #define CONF_NOT_A_NUMBER 0x000010
1589 #define CONF_NOT_UNSIGNED 0x000080
1590 #define CONF_VALUE_NOT_FOUND 0x000100
1591 #define CONF_FILE_NOT_FOUND 0x000200
1594 /** Allows reading of values from configuration files
1595 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1596 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1597 * Constructing the class using one parameter allows you to specify a path to your own configuration
1598 * file, otherwise, inspircd.conf is read.
1600 class ConfigReader : public classbase
1603 /** The contents of the configuration file
1604 * This protected member should never be accessed by a module (and cannot be accessed unless the
1605 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1606 * (such as comments) stripped from it.
1608 ConfigDataHash* data;
1609 std::ostringstream* errorlog;;
1610 /** Used to store errors
1612 bool privatehash; // If we're using our own config data hash or not.
1617 /** Default constructor.
1618 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1619 * as specified when running ./configure.
1621 ConfigReader(); // default constructor reads ircd.conf
1622 /** Overloaded constructor.
1623 * This constructor initialises the ConfigReader class to read a user-specified config file
1625 ConfigReader(const std::string &filename); // read a module-specific config
1626 /** Default destructor.
1627 * This method destroys the ConfigReader class.
1630 /** Retrieves a value from the config file.
1631 * This method retrieves a value from the config file. Where multiple copies of the tag
1632 * exist in the config file, index indicates which of the values to retrieve.
1634 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1635 /** Retrieves a boolean value from the config file.
1636 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1637 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1638 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1640 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1641 /** Retrieves an integer value from the config file.
1642 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1643 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1644 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1645 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1646 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1647 * will return CONF_NOT_UNSIGNED
1649 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1650 /** Returns the last error to occur.
1651 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1652 * A call to GetError() resets the error flag back to 0.
1655 /** Counts the number of times a given tag appears in the config file.
1656 * This method counts the number of times a tag appears in a config file, for use where
1657 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1658 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1659 * multiple instance tag.
1661 int Enumerate(const std::string &tag);
1662 /** Returns true if a config file is valid.
1663 * This method is partially implemented and will only return false if the config
1664 * file does not exist or could not be opened.
1667 /** Dumps the list of errors in a config file to an output location. If bail is true,
1668 * then the program will abort. If bail is false and user points to a valid user
1669 * record, the error report will be spooled to the given user by means of NOTICE.
1670 * if bool is false AND user is false, the error report will be spooled to all opers
1671 * by means of a NOTICE to all opers.
1673 void DumpErrors(bool bail,userrec* user);
1675 /** Returns the number of items within a tag.
1676 * For example if the tag was <test tag="blah" data="foo"> then this
1677 * function would return 2. Spaces and newlines both qualify as valid seperators
1680 int EnumerateValues(const std::string &tag, int index);
1685 /** Caches a text file into memory and can be used to retrieve lines from it.
1686 * This class contains methods for read-only manipulation of a text file in memory.
1687 * Either use the constructor type with one parameter to load a file into memory
1688 * at construction, or use the LoadFile method to load a file.
1690 class FileReader : public classbase
1692 /** The file contents
1696 unsigned long contentsize;
1701 /** Default constructor.
1702 * This method does not load any file into memory, you must use the LoadFile method
1703 * after constructing the class this way.
1707 /** Secondary constructor.
1708 * This method initialises the class with a file loaded into it ready for GetLine and
1709 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1712 FileReader(const std::string &filename);
1714 /** Default destructor.
1715 * This deletes the memory allocated to the file.
1719 /** Used to load a file.
1720 * This method loads a file into the class ready for GetLine and
1721 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1724 void LoadFile(const std::string &filename);
1726 /** Returns the whole content of the file as std::string
1728 std::string Contents();
1730 /** Returns the entire size of the file as std::string
1732 unsigned long ContentSize();
1734 /** Returns true if the file exists
1735 * This function will return false if the file could not be opened.
1739 /** Retrieve one line from the file.
1740 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1741 * the index was out of bounds, or the line had no data on it.
1743 std::string GetLine(int x);
1745 /** Returns the size of the file in lines.
1746 * This method returns the number of lines in the read file. If it is 0, no lines have been
1747 * read into memory, either because the file is empty or it does not exist, or cannot be
1748 * opened due to permission problems.
1754 /** Instantiates classes inherited from Module
1755 * This class creates a class inherited from type Module, using new. This is to allow for modules
1756 * to create many different variants of Module, dependent on architecture, configuration, etc.
1757 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1760 class ModuleFactory : public classbase
1764 virtual ~ModuleFactory() { }
1765 /** Creates a new module.
1766 * Your inherited class of ModuleFactory must return a pointer to your Module class
1767 * using this method.
1769 virtual Module * CreateModule(Server* Me) = 0;
1773 typedef DLLFactory<ModuleFactory> ircd_module;
1774 typedef std::vector<Module*> ModuleList;
1775 typedef std::vector<ircd_module*> FactoryList;