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 /** The ModuleMessage class is the base class of Request and Event
186 * This class is used to represent a basic data structure which is passed
187 * between modules for safe inter-module communications.
189 class ModuleMessage : public classbase
192 /** This class is pure virtual and must be inherited.
194 virtual char* Send() = 0;
195 virtual ~ModuleMessage() {};
198 /** The Request class is a unicast message directed at a given module.
199 * When this class is properly instantiated it may be sent to a module
200 * using the Send() method, which will call the given module's OnRequest
201 * method with this class as its parameter.
203 class Request : public ModuleMessage
206 /** This member holds a pointer to arbitary data set by the emitter of the message
209 /** This should be a null-terminated string identifying the type of request,
210 * all modules should define this and use it to determine the nature of the
211 * request before they attempt to cast the Request in any way.
214 /** This is a pointer to the sender of the message, which can be used to
215 * directly trigger events, or to create a reply.
218 /** The single destination of the Request
222 /** Create a new Request
223 * This is for the 'old' way of casting whatever the data is
224 * to char* and hoping you get the right thing at the other end.
225 * This is slowly being depreciated in favor of the 'new' way.
227 Request(char* anydata, Module* src, Module* dst);
228 /** Create a new Request
229 * This is for the 'new' way of defining a subclass
230 * of Request and defining it in a common header,
231 * passing an object of your Request subclass through
232 * as a Request* and using the ID string to determine
233 * what to cast it back to and the other end. This is
234 * much safer as there are no casts not confirmed by
235 * the ID string, and all casts are child->parent and
236 * can be checked at runtime with dynamic_cast<>()
238 Request(Module* src, Module* dst, const char* idstr);
239 /** Fetch the Request data
242 /** Fetch the ID string
245 /** Fetch the request source
248 /** Fetch the request destination (should be 'this' in the receiving module)
251 /** Send the Request.
252 * Upon returning the result will be arbitary data returned by the module you
253 * sent the request to. It is up to your module to know what this data is and
254 * how to deal with it.
260 /** The Event class is a unicast message directed at all modules.
261 * When the class is properly instantiated it may be sent to all modules
262 * using the Send() method, which will trigger the OnEvent method in
263 * all modules passing the object as its parameter.
265 class Event : public ModuleMessage
268 /** This member holds a pointer to arbitary data set by the emitter of the message
271 /** This is a pointer to the sender of the message, which can be used to
272 * directly trigger events, or to create a reply.
275 /** The event identifier.
276 * This is arbitary text which should be used to distinguish
277 * one type of event from another.
281 /** Create a new Event
283 Event(char* anydata, Module* src, const std::string &eventid);
284 /** Get the Event data
287 /** Get the event Source
290 /** Get the event ID.
291 * Use this to determine the event type for safe casting of the data
293 std::string GetEventID();
295 * The return result of an Event::Send() will always be NULL as
296 * no replies are expected.
301 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
302 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
303 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
304 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
305 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
307 class ModuleException : public classbase
310 /** Holds the error message to be displayed
314 /** Default constructor, just uses the error mesage 'Module threw an exception'.
316 ModuleException() : err("Module threw an exception") {}
317 /** This constructor can be used to specify an error message before throwing.
319 ModuleException(std::string message) : err(message) {}
320 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
321 * Actually no, it does nothing. Never mind.
323 virtual ~ModuleException() {};
324 /** Returns the reason for the exception.
325 * The module should probably put something informative here as the user will see this upon failure.
327 virtual const char* GetReason()
333 /** Priority types which can be returned from Module::Prioritize()
335 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
337 /** Implementation-specific flags which may be set in Module::Implements()
339 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
340 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
341 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
342 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
343 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
344 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
345 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
346 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
347 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
348 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
349 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
350 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
352 /** Base class for all InspIRCd modules
353 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
354 * its methods will be called when irc server events occur. class inherited from module must be
355 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
357 class Module : public Extensible
361 /** Default constructor
362 * Creates a module class.
363 * @param Me An instance of the Server class which can be saved for future use
364 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
368 /** Default destructor
369 * destroys a module class
373 /** Returns the version number of a Module.
374 * The method should return a Version object with its version information assigned via
377 virtual Version GetVersion();
379 /** The Implements function specifies which methods a module should receive events for.
380 * The char* parameter passed to this function contains a set of true or false values
381 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
382 * enum (documented elsewhere on this page) to mark functions as active. For example, to
383 * receive events for OnUserJoin():
385 * Implements[I_OnUserJoin] = 1;
387 * @param The implement list
389 virtual void Implements(char* Implements);
391 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
392 * Some modules prefer to be called before other modules, due to their design. For example, a
393 * module which is expected to operate on complete information would expect to be placed last, so
394 * that any other modules which wish to adjust that information would execute before it, to be sure
395 * its information is correct. You can change your module's priority by returning one of:
397 * PRIORITY_FIRST - To place your module first in the list
399 * PRIORITY_LAST - To place your module last in the list
401 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
403 * The result of Server::PriorityBefore() - To move your module before another named module
405 * The result of Server::PriorityLast() - To move your module after another named module
407 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
408 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
409 * your module has a real need to reorder its priority, it should not implement this function,
410 * as many modules changing their priorities can make the system redundant.
412 virtual Priority Prioritize();
414 /** Called when a user connects.
415 * The details of the connecting user are available to you in the parameter userrec *user
416 * @param user The user who is connecting
418 virtual void OnUserConnect(userrec* user);
420 /** Called when a user quits.
421 * The details of the exiting user are available to you in the parameter userrec *user
422 * This event is only called when the user is fully registered when they quit. To catch
423 * raw disconnections, use the OnUserDisconnect method.
424 * @param user The user who is quitting
425 * @param message The user's quit message
427 virtual void OnUserQuit(userrec* user, const std::string &message);
429 /** Called whenever a user's socket is closed.
430 * The details of the exiting user are available to you in the parameter userrec *user
431 * This event is called for all users, registered or not, as a cleanup method for modules
432 * which might assign resources to user, such as dns lookups, objects and sockets.
433 * @param user The user who is disconnecting
435 virtual void OnUserDisconnect(userrec* user);
437 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
438 * @param chan The channel being deleted
440 virtual void OnChannelDelete(chanrec* chan);
442 /** Called when a user joins a channel.
443 * The details of the joining user are available to you in the parameter userrec *user,
444 * and the details of the channel they have joined is available in the variable chanrec *channel
445 * @param user The user who is joining
446 * @param channel The channel being joined
448 virtual void OnUserJoin(userrec* user, chanrec* channel);
450 /** Called when a user parts a channel.
451 * The details of the leaving user are available to you in the parameter userrec *user,
452 * and the details of the channel they have left is available in the variable chanrec *channel
453 * @param user The user who is parting
454 * @param channel The channel being parted
455 * @param partmessage The part message, or an empty string
457 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
459 /** Called on rehash.
460 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
461 * system. You should use it to reload any files so that your module keeps in step with the
462 * rest of the application. If a parameter is given, the core has done nothing. The module
463 * receiving the event can decide if this parameter has any relevence to it.
464 * @param parameter The (optional) parameter given to REHASH from the user.
466 virtual void OnRehash(const std::string ¶meter);
468 /** Called when a raw command is transmitted or received.
469 * This method is the lowest level of handler available to a module. It will be called with raw
470 * data which is passing through a connected socket. If you wish, you may munge this data by changing
471 * the string parameter "raw". If you do this, after your function exits it will immediately be
472 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
473 * inbound is set to true) the value of user will be the userrec of the connection sending the
474 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
475 * @param raw The raw string in RFC1459 format
476 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
477 * @param user The user record sending the text, when inbound == true.
479 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
481 /** Called whenever a user is about to join a channel, before any processing is done.
482 * Returning a value of 1 from this function stops the process immediately, causing no
483 * output to be sent to the user by the core. If you do this you must produce your own numerics,
484 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
485 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
489 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
490 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
491 * processing on the actual channel record at this point, however the channel NAME will still be passed in
492 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
493 * @param user The user joining the channel
494 * @param cname The channel name being joined
495 * @return 1 To prevent the join, 0 to allow it.
497 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
499 /** Called whenever a user is about to be kicked.
500 * Returning a value of 1 from this function stops the process immediately, causing no
501 * output to be sent to the user by the core. If you do this you must produce your own numerics,
503 * @param source The user issuing the kick
504 * @param user The user being kicked
505 * @param chan The channel the user is being kicked from
506 * @param reason The kick reason
507 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
509 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
511 /** Called whenever a user is kicked.
512 * If this method is called, the kick is already underway and cannot be prevented, so
513 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
514 * @param source The user issuing the kick
515 * @param user The user being kicked
516 * @param chan The channel the user is being kicked from
517 * @param reason The kick reason
519 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
521 /** Called whenever a user opers locally.
522 * The userrec will contain the oper mode 'o' as this function is called after any modifications
523 * are made to the user's structure by the core.
524 * @param user The user who is opering up
525 * @param opertype The opers type name
527 virtual void OnOper(userrec* user, const std::string &opertype);
529 /** Called after a user opers locally.
530 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
531 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
532 * out the OPERTYPE, etc.
533 * @param user The user who is opering up
534 * @param opertype The opers type name
536 virtual void OnPostOper(userrec* user, const std::string &opertype);
538 /** Called whenever a user types /INFO.
539 * The userrec will contain the information of the user who typed the command. Modules may use this
540 * method to output their own credits in /INFO (which is the ircd's version of an about box).
541 * It is purposefully not possible to modify any info that has already been output, or halt the list.
542 * You must write a 371 numeric to the user, containing your info in the following format:
544 * <nick> :information here
546 * @param user The user issuing /INFO
548 virtual void OnInfo(userrec* user);
550 /** Called whenever a /WHOIS is performed on a local user.
551 * The source parameter contains the details of the user who issued the WHOIS command, and
552 * the dest parameter contains the information of the user they are whoising.
553 * @param source The user issuing the WHOIS command
554 * @param dest The user who is being WHOISed
556 virtual void OnWhois(userrec* source, userrec* dest);
558 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
559 * Returning 1 from this function stops the process immediately, causing no
560 * output to be sent to the user by the core. If you do this you must produce your own numerics,
561 * notices etc. This is useful for modules which may want to filter invites to channels.
562 * @param source The user who is issuing the INVITE
563 * @param dest The user being invited
564 * @param channel The channel the user is being invited to
565 * @return 1 to deny the invite, 0 to allow
567 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
569 /** Called after a user has been successfully invited to a channel.
570 * You cannot prevent the invite from occuring using this function, to do that,
571 * use OnUserPreInvite instead.
572 * @param source The user who is issuing the INVITE
573 * @param dest The user being invited
574 * @param channel The channel the user is being invited to
576 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
578 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
579 * Returning any nonzero value from this function stops the process immediately, causing no
580 * output to be sent to the user by the core. If you do this you must produce your own numerics,
581 * notices etc. This is useful for modules which may want to filter or redirect messages.
582 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
583 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
584 * of where the message is destined to be sent.
585 * @param user The user sending the message
586 * @param dest The target of the message (chanrec* or userrec*)
587 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
588 * @param text Changeable text being sent by the user
589 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
590 * @return 1 to deny the NOTICE, 0 to allow it
592 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
594 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
595 * Returning any nonzero value from this function stops the process immediately, causing no
596 * output to be sent to the user by the core. If you do this you must produce your own numerics,
597 * notices etc. This is useful for modules which may want to filter or redirect messages.
598 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
599 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
600 * of where the message is destined to be sent.
601 * You may alter the message text as you wish before relinquishing control to the next module
602 * in the chain, and if no other modules block the text this altered form of the text will be sent out
603 * to the user and possibly to other servers.
604 * @param user The user sending the message
605 * @param dest The target of the message (chanrec* or userrec*)
606 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
607 * @param text Changeable text being sent by the user
608 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
609 * @return 1 to deny the NOTICE, 0 to allow it
611 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
613 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
614 * Please note that although you can see remote nickchanges through this function, you should
615 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
616 * check user->server before taking any action (including returning nonzero from the method).
617 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
618 * module to generate some meaninful output.
619 * @param user The username changing their nick
620 * @param newnick Their new nickname
621 * @return 1 to deny the change, 0 to allow
623 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
625 /** Called after any PRIVMSG sent from a user.
626 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
627 * if target_type is TYPE_CHANNEL.
628 * @param user The user sending the message
629 * @param dest The target of the message
630 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
631 * @param text the text being sent by the user
632 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
634 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
636 /** Called after any NOTICE sent from a user.
637 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
638 * if target_type is TYPE_CHANNEL.
639 * @param user The user sending the message
640 * @param dest The target of the message
641 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
642 * @param text the text being sent by the user
643 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
645 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
647 /** Called after every MODE command sent from a user
648 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
649 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
650 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
651 * @param user The user sending the MODEs
652 * @param dest The target of the modes (userrec* or chanrec*)
653 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
654 * @param text The actual modes and their parameters if any
656 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
658 /** Allows modules to alter or create server descriptions
659 * Whenever a module requires a server description, for example for display in
660 * WHOIS, this function is called in all modules. You may change or define the
661 * description given in std::string &description. If you do, this description
662 * will be shown in the WHOIS fields.
663 * @param servername The servername being searched for
664 * @param description Alterable server description for this server
666 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
668 /** Allows modules to synchronize data which relates to users during a netburst.
669 * When this function is called, it will be called from the module which implements
670 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
671 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
672 * (see below). This function will be called for every user visible on your side
673 * of the burst, allowing you to for example set modes, etc. Do not use this call to
674 * synchronize data which you have stored using class Extensible -- There is a specialist
675 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
676 * @param user The user being syncronized
677 * @param proto A pointer to the module handling network protocol
678 * @param opaque An opaque pointer set by the protocol module, should not be modified!
680 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
682 /** Allows modules to synchronize data which relates to channels during a netburst.
683 * When this function is called, it will be called from the module which implements
684 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
685 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
686 * (see below). This function will be called for every user visible on your side
687 * of the burst, allowing you to for example set modes, etc. Do not use this call to
688 * synchronize data which you have stored using class Extensible -- There is a specialist
689 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
691 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
693 * @param chan The channel being syncronized
694 * @param proto A pointer to the module handling network protocol
695 * @param opaque An opaque pointer set by the protocol module, should not be modified!
697 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
699 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
700 * Whenever the linking module wants to send out data, but doesnt know what the data
701 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
702 * this method is called.You should use the ProtoSendMetaData function after you've
703 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
704 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
705 * @param chan The channel whos metadata is 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!
708 * @param extname The extensions name which is being searched for
710 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
712 /* Allows modules to syncronize metadata related to users over the network during a netburst.
713 * Whenever the linking module wants to send out data, but doesnt know what the data
714 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
715 * this method is called. You should use the ProtoSendMetaData function after you've
716 * correctly decided how the data should be represented, to send the metadata on its way if
717 * if it belongs to your module.
718 * @param user The user whos metadata is being syncronized
719 * @param proto A pointer to the module handling network protocol
720 * @param opaque An opaque pointer set by the protocol module, should not be modified!
721 * @param extname The extensions name which is being searched for
723 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
725 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
726 * Whenever the linking module wants to send out data, but doesnt know what the data
727 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
728 * this method is called. You should use the ProtoSendMetaData function after you've
729 * correctly decided how the data should be represented, to send the metadata on its way if
730 * if it belongs to your module.
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!
734 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
736 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
737 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
738 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
739 * @param target The chanrec* or userrec* that data should be added to
740 * @param extname The extension name which is being sent
741 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
743 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
745 /** Implemented by modules which provide the ability to link servers.
746 * These modules will implement this method, which allows transparent sending of servermodes
747 * down the network link as a broadcast, without a module calling it having to know the format
748 * of the MODE command before the actual mode string.
750 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
751 * of how to use this function.
753 * @param opaque An opaque pointer set by the protocol module, should not be modified!
754 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
755 * @param target The chanrec* or userrec* that modes should be sent for
756 * @param modeline The modes and parameters to be sent
758 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
760 /** Implemented by modules which provide the ability to link servers.
761 * These modules will implement this method, which allows metadata (extra data added to
762 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
763 * to other servers on a netburst and decoded at the other end by the same module on a
766 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
767 * how to use this function.
768 * @param opaque An opaque pointer set by the protocol module, should not be modified!
769 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
770 * @param target The chanrec* or userrec* that metadata should be sent for
771 * @param extname The extension name to send metadata for
772 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
774 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
776 /** Called after every WALLOPS command.
777 * @param user The user sending the WALLOPS
778 * @param text The content of the WALLOPS message
780 virtual void OnWallops(userrec* user, const std::string &text);
782 /** Called whenever a user's hostname is changed.
783 * This event triggers after the host has been set.
784 * @param user The user whos host is being changed
785 * @param newhost The new hostname being set
787 virtual void OnChangeHost(userrec* user, const std::string &newhost);
789 /** Called whenever a user's GECOS (realname) is changed.
790 * This event triggers after the name has been set.
791 * @param user The user who's GECOS is being changed
792 * @param gecos The new GECOS being set on the user
794 virtual void OnChangeName(userrec* user, const std::string &gecos);
796 /** Called whenever a gline is added by a local user.
797 * This method is triggered after the line is added.
798 * @param duration The duration of the line in seconds
799 * @param source The sender of the line
800 * @param reason The reason text to be displayed
801 * @param hostmask The hostmask to add
803 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
805 /** Called whenever a zline is added by a local user.
806 * This method is triggered after the line is added.
807 * @param duration The duration of the line in seconds
808 * @param source The sender of the line
809 * @param reason The reason text to be displayed
810 * @param ipmask The hostmask to add
812 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
814 /** Called whenever a kline is added by a local user.
815 * This method is triggered after the line is added.
816 * @param duration The duration of the line in seconds
817 * @param source The sender of the line
818 * @param reason The reason text to be displayed
819 * @param hostmask The hostmask to add
821 virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
823 /** Called whenever a qline is added by a local user.
824 * This method is triggered after the line is added.
825 * @param duration The duration of the line in seconds
826 * @param source The sender of the line
827 * @param reason The reason text to be displayed
828 * @param nickmask The hostmask to add
830 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
832 /** Called whenever a eline is added by a local user.
833 * This method is triggered after the line is added.
834 * @param duration The duration of the line in seconds
835 * @param source The sender of the line
836 * @param reason The reason text to be displayed
837 * @param hostmask The hostmask to add
839 virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
841 /** Called whenever a gline is deleted.
842 * This method is triggered after the line is deleted.
843 * @param source The user removing the line
844 * @param hostmask The hostmask to delete
846 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
848 /** Called whenever a zline is deleted.
849 * This method is triggered after the line is deleted.
850 * @param source The user removing the line
851 * @param hostmask The hostmask to delete
853 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
855 /** Called whenever a kline is deleted.
856 * This method is triggered after the line is deleted.
857 * @param source The user removing the line
858 * @param hostmask The hostmask to delete
860 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
862 /** Called whenever a qline is deleted.
863 * This method is triggered after the line is deleted.
864 * @param source The user removing the line
865 * @param hostmask The hostmask to delete
867 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
869 /** Called whenever a eline is deleted.
870 * This method is triggered after the line is deleted.
871 * @param source The user removing the line
872 * @param hostmask The hostmask to delete
874 virtual void OnDelELine(userrec* source, const std::string &hostmask);
876 /** Called before your module is unloaded to clean up Extensibles.
877 * This method is called once for every user and channel on the network,
878 * so that when your module unloads it may clear up any remaining data
879 * in the form of Extensibles added using Extensible::Extend().
880 * If the target_type variable is TYPE_USER, then void* item refers to
881 * a userrec*, otherwise it refers to a chanrec*.
882 * @param target_type The type of item being cleaned
883 * @param item A pointer to the item's class
885 virtual void OnCleanup(int target_type, void* item);
887 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
888 * have been applied. Please note that although you can see remote nickchanges through this function, you should
889 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
890 * check user->server before taking any action (including returning nonzero from the method).
891 * Because this method is called after the nickchange is taken place, no return values are possible
892 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
893 * @param user The user changing their nick
894 * @param oldnick The old nickname of the user before the nickchange
896 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
898 /** Called before an action which requires a channel privilage check.
899 * This function is called before many functions which check a users status on a channel, for example
900 * before opping a user, deopping a user, kicking a user, etc.
901 * There are several values for access_type which indicate for what reason access is being checked.
903 * AC_KICK (0) - A user is being kicked<br>
904 * AC_DEOP (1) - a user is being deopped<br>
905 * AC_OP (2) - a user is being opped<br>
906 * AC_VOICE (3) - a user is being voiced<br>
907 * AC_DEVOICE (4) - a user is being devoiced<br>
908 * AC_HALFOP (5) - a user is being halfopped<br>
909 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
910 * AC_INVITE () - a user is being invited<br>
911 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
912 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
913 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
914 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
915 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
916 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
917 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
918 * @param source The source of the access check
919 * @param dest The destination of the access check
920 * @param channel The channel which is being checked
921 * @param access_type See above
923 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
925 /** Called when a 005 numeric is about to be output.
926 * The module should modify the 005 numeric if needed to indicate its features.
927 * @param output The 005 string to be modified if neccessary.
929 virtual void On005Numeric(std::string &output);
931 /** Called when a client is disconnected by KILL.
932 * If a client is killed by a server, e.g. a nickname collision or protocol error,
934 * Return 1 from this function to prevent the kill, and 0 from this function to allow
935 * it as normal. If you prevent the kill no output will be sent to the client, it is
936 * down to your module to generate this information.
937 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
938 * If you do so youre risking race conditions, desyncs and worse!
939 * @param source The user sending the KILL
940 * @param dest The user being killed
941 * @param reason The kill reason
942 * @return 1 to prevent the kill, 0 to allow
944 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
946 /** Called when an oper wants to disconnect a remote user via KILL
947 * @param source The user sending the KILL
948 * @param dest The user being killed
949 * @param reason The kill reason
951 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
953 /** Called whenever a module is loaded.
954 * mod will contain a pointer to the module, and string will contain its name,
955 * for example m_widgets.so. This function is primary for dependency checking,
956 * your module may decide to enable some extra features if it sees that you have
957 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
958 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
959 * but instead operate under reduced functionality, unless the dependency is
960 * absolutely neccessary (e.g. a module that extends the features of another
962 * @param mod A pointer to the new module
963 * @param name The new module's filename
965 virtual void OnLoadModule(Module* mod,const std::string &name);
967 /** Called whenever a module is unloaded.
968 * mod will contain a pointer to the module, and string will contain its name,
969 * for example m_widgets.so. This function is primary for dependency checking,
970 * your module may decide to enable some extra features if it sees that you have
971 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
972 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
973 * but instead operate under reduced functionality, unless the dependency is
974 * absolutely neccessary (e.g. a module that extends the features of another
976 * @param mod Pointer to the module being unloaded (still valid)
977 * @param name The filename of the module being unloaded
979 virtual void OnUnloadModule(Module* mod,const std::string &name);
981 /** Called once every five seconds for background processing.
982 * This timer can be used to control timed features. Its period is not accurate
983 * enough to be used as a clock, but it is gauranteed to be called at least once in
984 * any five second period, directly from the main loop of the server.
985 * @param curtime The current timer derived from time(2)
987 virtual void OnBackgroundTimer(time_t curtime);
989 /** Called whenever any command is about to be executed.
990 * This event occurs for all registered commands, wether they are registered in the core,
991 * or another module, but it will not occur for invalid commands (e.g. ones which do not
992 * exist within the command table). By returning 1 from this method you may prevent the
993 * command being executed. If you do this, no output is created by the core, and it is
994 * down to your module to produce any output neccessary.
995 * Note that unless you return 1, you should not destroy any structures (e.g. by using
996 * Server::QuitUser) otherwise when the command's handler function executes after your
997 * method returns, it will be passed an invalid pointer to the user object and crash!)
998 * @param command The command being executed
999 * @param parameters An array of array of characters containing the parameters for the command
1000 * @param pcnt The nuimber of parameters passed to the command
1001 * @param user the user issuing the command
1002 * @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.
1003 * @return 1 to block the command, 0 to allow
1005 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
1007 /** Called to check if a user who is connecting can now be allowed to register
1008 * If any modules return false for this function, the user is held in the waiting
1009 * state until all modules return true. For example a module which implements ident
1010 * lookups will continue to return false for a user until their ident lookup is completed.
1011 * Note that the registration timeout for a user overrides these checks, if the registration
1012 * timeout is reached, the user is disconnected even if modules report that the user is
1013 * not ready to connect.
1014 * @param user The user to check
1015 * @return true to indicate readiness, false if otherwise
1017 virtual bool OnCheckReady(userrec* user);
1019 /** Called whenever a user is about to register their connection (e.g. before the user
1020 * is sent the MOTD etc). Modules can use this method if they are performing a function
1021 * which must be done before the actual connection is completed (e.g. ident lookups,
1022 * dnsbl lookups, etc).
1023 * Note that you should NOT delete the user record here by causing a disconnection!
1024 * Use OnUserConnect for that instead.
1025 * @param user The user registering
1027 virtual void OnUserRegister(userrec* user);
1029 /** Called whenever a mode character is processed.
1030 * Return 1 from this function to block the mode character from being processed entirely,
1031 * so that you may perform your own code instead. Note that this method allows you to override
1032 * modes defined by other modes, but this is NOT RECOMMENDED!
1033 * @param user The user who is sending the mode
1034 * @param chan The channel the mode is being sent to
1035 * @param mode The mode character being set
1036 * @param param The parameter for the mode or an empty string
1037 * @param adding true of the mode is being added, false if it is being removed
1038 * @param pcnt The parameter count for the mode (0 or 1)
1039 * @return 1 to deny the mode, 0 to allow
1041 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1043 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1044 * This method will always be called for each join, wether or not the channel is actually +i, and
1045 * determines the outcome of an if statement around the whole section of invite checking code.
1046 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1047 * @param user The user joining the channel
1048 * @param chan The channel being joined
1049 * @return 1 to explicitly allow the join, 0 to proceed as normal
1051 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1053 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1054 * This method will always be called for each join, wether or not the channel is actually +k, and
1055 * determines the outcome of an if statement around the whole section of key checking code.
1056 * if the user specified no key, the keygiven string will be a valid but empty value.
1057 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1058 * @param user The user joining the channel
1059 * @param chan The channel being joined
1060 * @return 1 to explicitly allow the join, 0 to proceed as normal
1062 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1064 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1065 * This method will always be called for each join, wether or not the channel is actually +l, and
1066 * determines the outcome of an if statement around the whole section of channel limit checking code.
1067 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1068 * @param user The user joining the channel
1069 * @param chan The channel being joined
1070 * @return 1 to explicitly allow the join, 0 to proceed as normal
1072 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1074 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1075 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1076 * determines the outcome of an if statement around the whole section of ban checking code.
1077 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1078 * @param user The user joining the channel
1079 * @param chan The channel being joined
1080 * @return 1 to explicitly allow the join, 0 to proceed as normal
1082 virtual int OnCheckBan(userrec* user, chanrec* chan);
1084 /** Called on all /STATS commands
1085 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1086 * @param symbol the symbol provided to /STATS
1087 * @param user the user issuing the /STATS command
1088 * @param results A string_list to append results into
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 /** Allows server output and query functions
1246 * This class contains methods which allow a module to query the state of the irc server, and produce
1247 * output to users and other servers. All modules should instantiate at least one copy of this class,
1248 * and use its member functions to perform their tasks.
1250 class Server : public Extensible
1253 /** Returns true if a nick is valid.
1254 * Nicks for unregistered connections will return false.
1256 bool IsNick(const std::string &nick);
1258 /** Attempts to look up a nick using the file descriptor associated with that nick.
1259 * This function will return NULL if the file descriptor is not associated with a valid user.
1261 userrec* FindDescriptor(int socket);
1263 bool AddMode(ModeHandler* mh, const unsigned char modechar);
1265 bool AddModeWatcher(ModeWatcher* mw);
1267 bool DelModeWatcher(ModeWatcher* mw);
1269 bool AddResolver(Resolver* r);
1271 /** Adds a command to the command table.
1272 * This allows modules to add extra commands into the command table. You must place a function within your
1273 * module which is is of type handlerfunc:
1275 * typedef void (handlerfunc) (char**, int, userrec*);
1277 * void handle_kill(char **parameters, int pcnt, userrec *user)
1279 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1280 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1281 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1282 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1283 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1284 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1285 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1288 void AddCommand(command_t *f);
1290 /** Sends a servermode.
1291 * you must format the parameters array with the target, modes and parameters for those modes.
1297 * modes[0] = ChannelName;
1301 * modes[2] = user->nick;
1303 * Srv->SendMode(modes,3,user);
1305 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1306 * will be sent to the user you provide as the third parameter.
1307 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1308 * your server in an unstable state!
1310 void SendMode(const char **parameters, int pcnt, userrec *user);
1312 /** Matches text against a glob pattern.
1313 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1314 * Returns true if the literal successfully matches the pattern, false if otherwise.
1316 bool MatchText(const std::string &sliteral, const std::string &spattern);
1318 /** Calls the handler for a command, either implemented by the core or by another module.
1319 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1320 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1321 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1322 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1323 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1324 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1325 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1326 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1327 * used for privilage checks, etc.
1328 * @return True if the command exists
1330 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1332 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1333 * of paramters the command requires, the user specified is allowed to execute the command, AND
1334 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1335 * within network protocols (see src/modules/m_spanningtree.cpp)
1337 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1339 /** Returns true if the servername you give is ulined.
1340 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1341 * change modes of clients which are on remote servers and set modes of channels where there are
1342 * no channel operators for that channel on the ulined server, amongst other things.
1344 bool IsUlined(const std::string &server);
1347 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1348 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1349 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1350 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1353 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1356 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1357 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1358 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1359 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1362 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1365 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1366 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1367 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1368 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1371 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1374 * The K-line is enforced as soon as it is added.
1375 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1376 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1377 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1380 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1383 * The E-line is enforced as soon as it is added.
1384 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1385 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1386 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1389 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1391 /** Deletes a G-Line from all servers
1393 bool DelGLine(const std::string &hostmask);
1395 /** Deletes a Q-Line from all servers
1397 bool DelQLine(const std::string &nickname);
1399 /** Deletes a Z-Line from all servers
1401 bool DelZLine(const std::string &ipaddr);
1403 /** Deletes a local K-Line
1405 bool DelKLine(const std::string &hostmask);
1407 /** Deletes a local E-Line
1409 bool DelELine(const std::string &hostmask);
1411 /** Calculates a duration
1412 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1413 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1416 long CalcDuration(const std::string &duration);
1418 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1420 bool IsValidMask(const std::string &mask);
1422 /** This function finds a module by name.
1423 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1424 * the function will return NULL.
1426 Module* FindModule(const std::string &name);
1428 /** Adds a class derived from InspSocket to the server's socket engine.
1430 void AddSocket(InspSocket* sock);
1432 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1434 void RemoveSocket(InspSocket* sock);
1436 /** Deletes a class derived from InspSocket from the server's socket engine.
1438 void DelSocket(InspSocket* sock);
1440 /** Causes the local server to rehash immediately.
1441 * WARNING: Do not call this method from within your rehash method, for
1444 void RehashServer();
1446 /** This method returns the total number of channels on the network.
1448 long GetChannelCount();
1450 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1451 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1452 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1455 chanrec* GetChannelIndex(long index);
1457 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1458 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1461 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1465 #define CONF_NOT_A_NUMBER 0x000010
1466 #define CONF_NOT_UNSIGNED 0x000080
1467 #define CONF_VALUE_NOT_FOUND 0x000100
1468 #define CONF_FILE_NOT_FOUND 0x000200
1471 /** Allows reading of values from configuration files
1472 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1473 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1474 * Constructing the class using one parameter allows you to specify a path to your own configuration
1475 * file, otherwise, inspircd.conf is read.
1477 class ConfigReader : public classbase
1480 /** The contents of the configuration file
1481 * This protected member should never be accessed by a module (and cannot be accessed unless the
1482 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1483 * (such as comments) stripped from it.
1485 ConfigDataHash* data;
1486 std::ostringstream* errorlog;;
1487 /** Used to store errors
1489 bool privatehash; // If we're using our own config data hash or not.
1494 /** Default constructor.
1495 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1496 * as specified when running ./configure.
1498 ConfigReader(); // default constructor reads ircd.conf
1499 /** Overloaded constructor.
1500 * This constructor initialises the ConfigReader class to read a user-specified config file
1502 ConfigReader(const std::string &filename); // read a module-specific config
1503 /** Default destructor.
1504 * This method destroys the ConfigReader class.
1507 /** Retrieves a value from the config file.
1508 * This method retrieves a value from the config file. Where multiple copies of the tag
1509 * exist in the config file, index indicates which of the values to retrieve.
1511 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1512 /** Retrieves a boolean value from the config file.
1513 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1514 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1515 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1517 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1518 /** Retrieves an integer value from the config file.
1519 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1520 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1521 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1522 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1523 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1524 * will return CONF_NOT_UNSIGNED
1526 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1527 /** Returns the last error to occur.
1528 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1529 * A call to GetError() resets the error flag back to 0.
1532 /** Counts the number of times a given tag appears in the config file.
1533 * This method counts the number of times a tag appears in a config file, for use where
1534 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1535 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1536 * multiple instance tag.
1538 int Enumerate(const std::string &tag);
1539 /** Returns true if a config file is valid.
1540 * This method is partially implemented and will only return false if the config
1541 * file does not exist or could not be opened.
1544 /** Dumps the list of errors in a config file to an output location. If bail is true,
1545 * then the program will abort. If bail is false and user points to a valid user
1546 * record, the error report will be spooled to the given user by means of NOTICE.
1547 * if bool is false AND user is false, the error report will be spooled to all opers
1548 * by means of a NOTICE to all opers.
1550 void DumpErrors(bool bail,userrec* user);
1552 /** Returns the number of items within a tag.
1553 * For example if the tag was <test tag="blah" data="foo"> then this
1554 * function would return 2. Spaces and newlines both qualify as valid seperators
1557 int EnumerateValues(const std::string &tag, int index);
1562 /** Caches a text file into memory and can be used to retrieve lines from it.
1563 * This class contains methods for read-only manipulation of a text file in memory.
1564 * Either use the constructor type with one parameter to load a file into memory
1565 * at construction, or use the LoadFile method to load a file.
1567 class FileReader : public classbase
1569 /** The file contents
1573 unsigned long contentsize;
1578 /** Default constructor.
1579 * This method does not load any file into memory, you must use the LoadFile method
1580 * after constructing the class this way.
1584 /** Secondary constructor.
1585 * This method initialises the class with a file loaded into it ready for GetLine and
1586 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1589 FileReader(const std::string &filename);
1591 /** Default destructor.
1592 * This deletes the memory allocated to the file.
1596 /** Used to load a file.
1597 * This method loads a file into the class ready for GetLine and
1598 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1601 void LoadFile(const std::string &filename);
1603 /** Returns the whole content of the file as std::string
1605 std::string Contents();
1607 /** Returns the entire size of the file as std::string
1609 unsigned long ContentSize();
1611 /** Returns true if the file exists
1612 * This function will return false if the file could not be opened.
1616 /** Retrieve one line from the file.
1617 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1618 * the index was out of bounds, or the line had no data on it.
1620 std::string GetLine(int x);
1622 /** Returns the size of the file in lines.
1623 * This method returns the number of lines in the read file. If it is 0, no lines have been
1624 * read into memory, either because the file is empty or it does not exist, or cannot be
1625 * opened due to permission problems.
1631 /** Instantiates classes inherited from Module
1632 * This class creates a class inherited from type Module, using new. This is to allow for modules
1633 * to create many different variants of Module, dependent on architecture, configuration, etc.
1634 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1637 class ModuleFactory : public classbase
1641 virtual ~ModuleFactory() { }
1642 /** Creates a new module.
1643 * Your inherited class of ModuleFactory must return a pointer to your Module class
1644 * using this method.
1646 virtual Module * CreateModule(Server* Me) = 0;
1650 typedef DLLFactory<ModuleFactory> ircd_module;
1651 typedef std::vector<Module*> ModuleList;
1652 typedef std::vector<ircd_module*> FactoryList;