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 * ---------------------------------------------------
23 enum DebugLevels { DEBUG, VERBOSE, DEFAULT, SPARSE, NONE };
25 /** Used with OnAccessCheck() method of modules
27 enum AccessControlType {
28 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
29 ACR_DENY, // deny the action
30 ACR_ALLOW, // allow the action
31 AC_KICK, // a user is being kicked
32 AC_DEOP, // a user is being deopped
33 AC_OP, // a user is being opped
34 AC_VOICE, // a user is being voiced
35 AC_DEVOICE, // a user is being devoiced
36 AC_HALFOP, // a user is being halfopped
37 AC_DEHALFOP, // a user is being dehalfopped
38 AC_INVITE, // a user is being invited
39 AC_GENERAL_MODE // a channel mode is being changed
42 /** Used to define a set of behavior bits for a module
45 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
46 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
47 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
48 VF_COMMON = 8 // module needs to be common on all servers in a network to link
56 enum TargetTypeFlags {
67 #include "inspsocket.h"
79 // Forward-delacare module for ModuleMessage etc
82 /** Low level definition of a FileReader classes file cache area
84 typedef std::deque<std::string> file_cache;
85 typedef file_cache string_list;
87 /** Holds a list of 'published features' for modules.
89 typedef std::map<std::string,Module*> featurelist;
92 * This #define allows us to call a method in all
93 * loaded modules in a readable simple way, e.g.:
94 * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
96 #define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
97 for (int _i = 0; _i <= MODCOUNT; _i++) { \
98 if (ServerInstance->Config->implement_lists[_i][y]) \
103 catch (ModuleException& modexcept) \
105 log(DEBUG,"Module exception caught: %s",modexcept.GetReason()); \
111 * This define is similar to the one above but returns a result in MOD_RESULT.
112 * The first module to return a nonzero result is the value to be accepted,
113 * and any modules after are ignored.
115 #define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
117 for (int _i = 0; _i <= MODCOUNT; _i++) { \
118 if (ServerInstance->Config->implement_lists[_i][y]) {\
121 int res = modules[_i]->x ; \
127 catch (ModuleException& modexcept) \
129 log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
136 #define FD_MAGIC_NUMBER -42
140 #define IS_LOCAL(x) ((x->fd > -1) && (x->fd <= MAX_DESCRIPTORS))
141 #define IS_REMOTE(x) (x->fd < 0)
142 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
144 /** Holds a module's Version information
145 * The four members (set by the constructor only) indicate details as to the version number
146 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
148 class Version : public classbase
151 const int Major, Minor, Revision, Build, Flags;
152 Version(int major, int minor, int revision, int build, int flags);
155 /** Holds /ADMIN data
156 * This class contains the admin details of the local server. It is constructed by class Server,
157 * and has three read-only values, Name, Email and Nick that contain the specified values for the
158 * server where the module is running.
160 class Admin : public classbase
163 const std::string Name, Email, Nick;
164 Admin(std::string name, std::string email, std::string nick);
167 /** The ModuleMessage class is the base class of Request and Event
168 * This class is used to represent a basic data structure which is passed
169 * between modules for safe inter-module communications.
171 class ModuleMessage : public classbase
174 /** This class is pure virtual and must be inherited.
176 virtual char* Send() = 0;
177 virtual ~ModuleMessage() {};
180 /** The Request class is a unicast message directed at a given module.
181 * When this class is properly instantiated it may be sent to a module
182 * using the Send() method, which will call the given module's OnRequest
183 * method with this class as its parameter.
185 class Request : public ModuleMessage
188 /** This member holds a pointer to arbitary data set by the emitter of the message
191 /** This should be a null-terminated string identifying the type of request,
192 * all modules should define this and use it to determine the nature of the
193 * request before they attempt to cast the Request in any way.
196 /** This is a pointer to the sender of the message, which can be used to
197 * directly trigger events, or to create a reply.
200 /** The single destination of the Request
204 /** Create a new Request
205 * This is for the 'old' way of casting whatever the data is
206 * to char* and hoping you get the right thing at the other end.
207 * This is slowly being depreciated in favor of the 'new' way.
209 Request(char* anydata, Module* src, Module* dst);
210 /** Create a new Request
211 * This is for the 'new' way of defining a subclass
212 * of Request and defining it in a common header,
213 * passing an object of your Request subclass through
214 * as a Request* and using the ID string to determine
215 * what to cast it back to and the other end. This is
216 * much safer as there are no casts not confirmed by
217 * the ID string, and all casts are child->parent and
218 * can be checked at runtime with dynamic_cast<>()
220 Request(Module* src, Module* dst, const char* idstr);
221 /** Fetch the Request data
224 /** Fetch the ID string
227 /** Fetch the request source
230 /** Fetch the request destination (should be 'this' in the receiving module)
233 /** Send the Request.
234 * Upon returning the result will be arbitary data returned by the module you
235 * sent the request to. It is up to your module to know what this data is and
236 * how to deal with it.
242 /** The Event class is a unicast message directed at all modules.
243 * When the class is properly instantiated it may be sent to all modules
244 * using the Send() method, which will trigger the OnEvent method in
245 * all modules passing the object as its parameter.
247 class Event : public ModuleMessage
250 /** This member holds a pointer to arbitary data set by the emitter of the message
253 /** This is a pointer to the sender of the message, which can be used to
254 * directly trigger events, or to create a reply.
257 /** The event identifier.
258 * This is arbitary text which should be used to distinguish
259 * one type of event from another.
263 /** Create a new Event
265 Event(char* anydata, Module* src, const std::string &eventid);
266 /** Get the Event data
269 /** Get the event Source
272 /** Get the event ID.
273 * Use this to determine the event type for safe casting of the data
275 std::string GetEventID();
277 * The return result of an Event::Send() will always be NULL as
278 * no replies are expected.
283 /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
284 * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
285 * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
286 * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
287 * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
289 class ModuleException : public classbase
292 /** Holds the error message to be displayed
296 /** Default constructor, just uses the error mesage 'Module threw an exception'.
298 ModuleException() : err("Module threw an exception") {}
299 /** This constructor can be used to specify an error message before throwing.
301 ModuleException(std::string message) : err(message) {}
302 /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
303 * Actually no, it does nothing. Never mind.
305 virtual ~ModuleException() {};
306 /** Returns the reason for the exception.
307 * The module should probably put something informative here as the user will see this upon failure.
309 virtual const char* GetReason()
315 /** Priority types which can be returned from Module::Prioritize()
317 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
319 /** Implementation-specific flags which may be set in Module::Implements()
321 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
322 I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
323 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
324 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
325 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
326 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
327 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
328 I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
329 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
330 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
331 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
332 I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway };
334 /** Base class for all InspIRCd modules
335 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
336 * its methods will be called when irc server events occur. class inherited from module must be
337 * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
339 class Module : public Extensible
343 /** Default constructor
344 * Creates a module class.
345 * @param Me An instance of the Server class which can be saved for future use
346 * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
350 /** Default destructor
351 * destroys a module class
355 /** Returns the version number of a Module.
356 * The method should return a Version object with its version information assigned via
359 virtual Version GetVersion();
361 /** The Implements function specifies which methods a module should receive events for.
362 * The char* parameter passed to this function contains a set of true or false values
363 * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
364 * enum (documented elsewhere on this page) to mark functions as active. For example, to
365 * receive events for OnUserJoin():
367 * Implements[I_OnUserJoin] = 1;
369 * @param The implement list
371 virtual void Implements(char* Implements);
373 /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
374 * Some modules prefer to be called before other modules, due to their design. For example, a
375 * module which is expected to operate on complete information would expect to be placed last, so
376 * that any other modules which wish to adjust that information would execute before it, to be sure
377 * its information is correct. You can change your module's priority by returning one of:
379 * PRIORITY_FIRST - To place your module first in the list
381 * PRIORITY_LAST - To place your module last in the list
383 * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
385 * The result of Server::PriorityBefore() - To move your module before another named module
387 * The result of Server::PriorityLast() - To move your module after another named module
389 * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
390 * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
391 * your module has a real need to reorder its priority, it should not implement this function,
392 * as many modules changing their priorities can make the system redundant.
394 virtual Priority Prioritize();
396 /** Called when a user connects.
397 * The details of the connecting user are available to you in the parameter userrec *user
398 * @param user The user who is connecting
400 virtual void OnUserConnect(userrec* user);
402 /** Called when a user quits.
403 * The details of the exiting user are available to you in the parameter userrec *user
404 * This event is only called when the user is fully registered when they quit. To catch
405 * raw disconnections, use the OnUserDisconnect method.
406 * @param user The user who is quitting
407 * @param message The user's quit message
409 virtual void OnUserQuit(userrec* user, const std::string &message);
411 /** Called whenever a user's socket is closed.
412 * The details of the exiting user are available to you in the parameter userrec *user
413 * This event is called for all users, registered or not, as a cleanup method for modules
414 * which might assign resources to user, such as dns lookups, objects and sockets.
415 * @param user The user who is disconnecting
417 virtual void OnUserDisconnect(userrec* user);
419 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
420 * @param chan The channel being deleted
422 virtual void OnChannelDelete(chanrec* chan);
424 /** Called when a user joins a channel.
425 * The details of the joining user are available to you in the parameter userrec *user,
426 * and the details of the channel they have joined is available in the variable chanrec *channel
427 * @param user The user who is joining
428 * @param channel The channel being joined
430 virtual void OnUserJoin(userrec* user, chanrec* channel);
432 /** Called when a user parts a channel.
433 * The details of the leaving user are available to you in the parameter userrec *user,
434 * and the details of the channel they have left is available in the variable chanrec *channel
435 * @param user The user who is parting
436 * @param channel The channel being parted
437 * @param partmessage The part message, or an empty string
439 virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
441 /** Called on rehash.
442 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
443 * system. You should use it to reload any files so that your module keeps in step with the
444 * rest of the application. If a parameter is given, the core has done nothing. The module
445 * receiving the event can decide if this parameter has any relevence to it.
446 * @param parameter The (optional) parameter given to REHASH from the user.
448 virtual void OnRehash(const std::string ¶meter);
450 /** Called when a raw command is transmitted or received.
451 * This method is the lowest level of handler available to a module. It will be called with raw
452 * data which is passing through a connected socket. If you wish, you may munge this data by changing
453 * the string parameter "raw". If you do this, after your function exits it will immediately be
454 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
455 * inbound is set to true) the value of user will be the userrec of the connection sending the
456 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
457 * @param raw The raw string in RFC1459 format
458 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
459 * @param user The user record sending the text, when inbound == true.
461 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
463 /** Called whenever a user is about to join a channel, before any processing is done.
464 * Returning a value of 1 from this function stops the process immediately, causing no
465 * output to be sent to the user by the core. If you do this you must produce your own numerics,
466 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
467 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
471 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
472 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
473 * processing on the actual channel record at this point, however the channel NAME will still be passed in
474 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
475 * @param user The user joining the channel
476 * @param cname The channel name being joined
477 * @return 1 To prevent the join, 0 to allow it.
479 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
481 /** Called whenever a user is about to be kicked.
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,
485 * @param source The user issuing the kick
486 * @param user The user being kicked
487 * @param chan The channel the user is being kicked from
488 * @param reason The kick reason
489 * @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
491 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
493 /** Called whenever a user is kicked.
494 * If this method is called, the kick is already underway and cannot be prevented, so
495 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
496 * @param source The user issuing the kick
497 * @param user The user being kicked
498 * @param chan The channel the user is being kicked from
499 * @param reason The kick reason
501 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
503 /** Called whenever a user opers locally.
504 * The userrec will contain the oper mode 'o' as this function is called after any modifications
505 * are made to the user's structure by the core.
506 * @param user The user who is opering up
507 * @param opertype The opers type name
509 virtual void OnOper(userrec* user, const std::string &opertype);
511 /** Called after a user opers locally.
512 * This is identical to Module::OnOper(), except it is called after OnOper so that other modules
513 * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
514 * out the OPERTYPE, etc.
515 * @param user The user who is opering up
516 * @param opertype The opers type name
518 virtual void OnPostOper(userrec* user, const std::string &opertype);
520 /** Called whenever a user types /INFO.
521 * The userrec will contain the information of the user who typed the command. Modules may use this
522 * method to output their own credits in /INFO (which is the ircd's version of an about box).
523 * It is purposefully not possible to modify any info that has already been output, or halt the list.
524 * You must write a 371 numeric to the user, containing your info in the following format:
526 * <nick> :information here
528 * @param user The user issuing /INFO
530 virtual void OnInfo(userrec* user);
532 /** Called whenever a /WHOIS is performed on a local user.
533 * The source parameter contains the details of the user who issued the WHOIS command, and
534 * the dest parameter contains the information of the user they are whoising.
535 * @param source The user issuing the WHOIS command
536 * @param dest The user who is being WHOISed
538 virtual void OnWhois(userrec* source, userrec* dest);
540 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
541 * Returning 1 from this function stops the process immediately, causing no
542 * output to be sent to the user by the core. If you do this you must produce your own numerics,
543 * notices etc. This is useful for modules which may want to filter invites to channels.
544 * @param source The user who is issuing the INVITE
545 * @param dest The user being invited
546 * @param channel The channel the user is being invited to
547 * @return 1 to deny the invite, 0 to allow
549 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
551 /** Called after a user has been successfully invited to a channel.
552 * You cannot prevent the invite from occuring using this function, to do that,
553 * use OnUserPreInvite instead.
554 * @param source The user who is issuing the INVITE
555 * @param dest The user being invited
556 * @param channel The channel the user is being invited to
558 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
560 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
561 * Returning any nonzero value from this function stops the process immediately, causing no
562 * output to be sent to the user by the core. If you do this you must produce your own numerics,
563 * notices etc. This is useful for modules which may want to filter or redirect messages.
564 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
565 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
566 * of where the message is destined to be sent.
567 * @param user The user sending the message
568 * @param dest The target of the message (chanrec* or userrec*)
569 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
570 * @param text Changeable text being sent by the user
571 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
572 * @return 1 to deny the NOTICE, 0 to allow it
574 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status);
576 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
577 * Returning any nonzero value from this function stops the process immediately, causing no
578 * output to be sent to the user by the core. If you do this you must produce your own numerics,
579 * notices etc. This is useful for modules which may want to filter or redirect messages.
580 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
581 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
582 * of where the message is destined to be sent.
583 * You may alter the message text as you wish before relinquishing control to the next module
584 * in the chain, and if no other modules block the text this altered form of the text will be sent out
585 * to the user and possibly to other servers.
586 * @param user The user sending the message
587 * @param dest The target of the message (chanrec* or userrec*)
588 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
589 * @param text Changeable text being sent by the user
590 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
591 * @return 1 to deny the NOTICE, 0 to allow it
593 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status);
595 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
596 * Please note that although you can see remote nickchanges through this function, you should
597 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
598 * check user->server before taking any action (including returning nonzero from the method).
599 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
600 * module to generate some meaninful output.
601 * @param user The username changing their nick
602 * @param newnick Their new nickname
603 * @return 1 to deny the change, 0 to allow
605 virtual int OnUserPreNick(userrec* user, const std::string &newnick);
607 /** Called after any PRIVMSG sent from a user.
608 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
609 * if target_type is TYPE_CHANNEL.
610 * @param user The user sending the message
611 * @param dest The target of the message
612 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
613 * @param text the text being sent by the user
614 * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
616 virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status);
618 /** Called after any NOTICE sent from a user.
619 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
620 * if target_type is TYPE_CHANNEL.
621 * @param user The user sending the message
622 * @param dest The target of the message
623 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
624 * @param text the text being sent by the user
625 * @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
627 virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status);
629 /** Called after every MODE command sent from a user
630 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
631 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
632 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
633 * @param user The user sending the MODEs
634 * @param dest The target of the modes (userrec* or chanrec*)
635 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
636 * @param text The actual modes and their parameters if any
638 virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
640 /** Allows modules to alter or create server descriptions
641 * Whenever a module requires a server description, for example for display in
642 * WHOIS, this function is called in all modules. You may change or define the
643 * description given in std::string &description. If you do, this description
644 * will be shown in the WHOIS fields.
645 * @param servername The servername being searched for
646 * @param description Alterable server description for this server
648 virtual void OnGetServerDescription(const std::string &servername,std::string &description);
650 /** Allows modules to synchronize data which relates to users during a netburst.
651 * When this function is called, it will be called from the module which implements
652 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
653 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
654 * (see below). This function will be called for every user visible on your side
655 * of the burst, allowing you to for example set modes, etc. Do not use this call to
656 * synchronize data which you have stored using class Extensible -- There is a specialist
657 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
658 * @param user The user being syncronized
659 * @param proto A pointer to the module handling network protocol
660 * @param opaque An opaque pointer set by the protocol module, should not be modified!
662 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
664 /** Allows modules to synchronize data which relates to channels during a netburst.
665 * When this function is called, it will be called from the module which implements
666 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
667 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
668 * (see below). This function will be called for every user visible on your side
669 * of the burst, allowing you to for example set modes, etc. Do not use this call to
670 * synchronize data which you have stored using class Extensible -- There is a specialist
671 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
673 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
675 * @param chan The channel being syncronized
676 * @param proto A pointer to the module handling network protocol
677 * @param opaque An opaque pointer set by the protocol module, should not be modified!
679 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
681 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
682 * Whenever the linking module wants to send out data, but doesnt know what the data
683 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
684 * this method is called.You should use the ProtoSendMetaData function after you've
685 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
686 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
687 * @param chan The channel whos metadata is being syncronized
688 * @param proto A pointer to the module handling network protocol
689 * @param opaque An opaque pointer set by the protocol module, should not be modified!
690 * @param extname The extensions name which is being searched for
692 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
694 /* Allows modules to syncronize metadata related to users over the network during a netburst.
695 * Whenever the linking module wants to send out data, but doesnt know what the data
696 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
697 * this method is called. You should use the ProtoSendMetaData function after you've
698 * correctly decided how the data should be represented, to send the metadata on its way if
699 * if it belongs to your module.
700 * @param user The user whos metadata is being syncronized
701 * @param proto A pointer to the module handling network protocol
702 * @param opaque An opaque pointer set by the protocol module, should not be modified!
703 * @param extname The extensions name which is being searched for
705 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
707 /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
708 * Whenever the linking module wants to send out data, but doesnt know what the data
709 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
710 * this method is called. You should use the ProtoSendMetaData function after you've
711 * correctly decided how the data should be represented, to send the metadata on its way if
712 * if it belongs to your module.
713 * @param proto A pointer to the module handling network protocol
714 * @param opaque An opaque pointer set by the protocol module, should not be modified!
716 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
718 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
719 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
720 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
721 * @param target The chanrec* or userrec* that data should be added to
722 * @param extname The extension name which is being sent
723 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
725 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
727 /** Implemented by modules which provide the ability to link servers.
728 * These modules will implement this method, which allows transparent sending of servermodes
729 * down the network link as a broadcast, without a module calling it having to know the format
730 * of the MODE command before the actual mode string.
732 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
733 * of how to use this function.
735 * @param opaque An opaque pointer set by the protocol module, should not be modified!
736 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
737 * @param target The chanrec* or userrec* that modes should be sent for
738 * @param modeline The modes and parameters to be sent
740 virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
742 /** Implemented by modules which provide the ability to link servers.
743 * These modules will implement this method, which allows metadata (extra data added to
744 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
745 * to other servers on a netburst and decoded at the other end by the same module on a
748 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
749 * how to use this function.
750 * @param opaque An opaque pointer set by the protocol module, should not be modified!
751 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
752 * @param target The chanrec* or userrec* that metadata should be sent for
753 * @param extname The extension name to send metadata for
754 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
756 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
758 /** Called after every WALLOPS command.
759 * @param user The user sending the WALLOPS
760 * @param text The content of the WALLOPS message
762 virtual void OnWallops(userrec* user, const std::string &text);
764 /** Called whenever a user's hostname is changed.
765 * This event triggers after the host has been set.
766 * @param user The user whos host is being changed
767 * @param newhost The new hostname being set
769 virtual void OnChangeHost(userrec* user, const std::string &newhost);
771 /** Called whenever a user's GECOS (realname) is changed.
772 * This event triggers after the name has been set.
773 * @param user The user who's GECOS is being changed
774 * @param gecos The new GECOS being set on the user
776 virtual void OnChangeName(userrec* user, const std::string &gecos);
778 /** Called whenever a gline is added by a local user.
779 * This method is triggered after the line is added.
780 * @param duration The duration of the line in seconds
781 * @param source The sender of the line
782 * @param reason The reason text to be displayed
783 * @param hostmask The hostmask to add
785 virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
787 /** Called whenever a zline is added by a local user.
788 * This method is triggered after the line is added.
789 * @param duration The duration of the line in seconds
790 * @param source The sender of the line
791 * @param reason The reason text to be displayed
792 * @param ipmask The hostmask to add
794 virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
796 /** Called whenever a kline 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 OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
805 /** Called whenever a qline 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 nickmask The hostmask to add
812 virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
814 /** Called whenever a eline 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 OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
823 /** Called whenever a gline is deleted.
824 * This method is triggered after the line is deleted.
825 * @param source The user removing the line
826 * @param hostmask The hostmask to delete
828 virtual void OnDelGLine(userrec* source, const std::string &hostmask);
830 /** Called whenever a zline is deleted.
831 * This method is triggered after the line is deleted.
832 * @param source The user removing the line
833 * @param hostmask The hostmask to delete
835 virtual void OnDelZLine(userrec* source, const std::string &ipmask);
837 /** Called whenever a kline is deleted.
838 * This method is triggered after the line is deleted.
839 * @param source The user removing the line
840 * @param hostmask The hostmask to delete
842 virtual void OnDelKLine(userrec* source, const std::string &hostmask);
844 /** Called whenever a qline is deleted.
845 * This method is triggered after the line is deleted.
846 * @param source The user removing the line
847 * @param hostmask The hostmask to delete
849 virtual void OnDelQLine(userrec* source, const std::string &nickmask);
851 /** Called whenever a eline is deleted.
852 * This method is triggered after the line is deleted.
853 * @param source The user removing the line
854 * @param hostmask The hostmask to delete
856 virtual void OnDelELine(userrec* source, const std::string &hostmask);
858 /** Called before your module is unloaded to clean up Extensibles.
859 * This method is called once for every user and channel on the network,
860 * so that when your module unloads it may clear up any remaining data
861 * in the form of Extensibles added using Extensible::Extend().
862 * If the target_type variable is TYPE_USER, then void* item refers to
863 * a userrec*, otherwise it refers to a chanrec*.
864 * @param target_type The type of item being cleaned
865 * @param item A pointer to the item's class
867 virtual void OnCleanup(int target_type, void* item);
869 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
870 * have been applied. Please note that although you can see remote nickchanges through this function, you should
871 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
872 * check user->server before taking any action (including returning nonzero from the method).
873 * Because this method is called after the nickchange is taken place, no return values are possible
874 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
875 * @param user The user changing their nick
876 * @param oldnick The old nickname of the user before the nickchange
878 virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
880 /** Called before an action which requires a channel privilage check.
881 * This function is called before many functions which check a users status on a channel, for example
882 * before opping a user, deopping a user, kicking a user, etc.
883 * There are several values for access_type which indicate for what reason access is being checked.
885 * AC_KICK (0) - A user is being kicked<br>
886 * AC_DEOP (1) - a user is being deopped<br>
887 * AC_OP (2) - a user is being opped<br>
888 * AC_VOICE (3) - a user is being voiced<br>
889 * AC_DEVOICE (4) - a user is being devoiced<br>
890 * AC_HALFOP (5) - a user is being halfopped<br>
891 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
892 * AC_INVITE () - a user is being invited<br>
893 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
894 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
895 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
896 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
897 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
898 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
899 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
900 * @param source The source of the access check
901 * @param dest The destination of the access check
902 * @param channel The channel which is being checked
903 * @param access_type See above
905 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
907 /** Called when a 005 numeric is about to be output.
908 * The module should modify the 005 numeric if needed to indicate its features.
909 * @param output The 005 string to be modified if neccessary.
911 virtual void On005Numeric(std::string &output);
913 /** Called when a client is disconnected by KILL.
914 * If a client is killed by a server, e.g. a nickname collision or protocol error,
916 * Return 1 from this function to prevent the kill, and 0 from this function to allow
917 * it as normal. If you prevent the kill no output will be sent to the client, it is
918 * down to your module to generate this information.
919 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
920 * If you do so youre risking race conditions, desyncs and worse!
921 * @param source The user sending the KILL
922 * @param dest The user being killed
923 * @param reason The kill reason
924 * @return 1 to prevent the kill, 0 to allow
926 virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
928 /** Called when an oper wants to disconnect a remote user via KILL
929 * @param source The user sending the KILL
930 * @param dest The user being killed
931 * @param reason The kill reason
933 virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
935 /** Called whenever a module is loaded.
936 * mod will contain a pointer to the module, and string will contain its name,
937 * for example m_widgets.so. This function is primary for dependency checking,
938 * your module may decide to enable some extra features if it sees that you have
939 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
940 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
941 * but instead operate under reduced functionality, unless the dependency is
942 * absolutely neccessary (e.g. a module that extends the features of another
944 * @param mod A pointer to the new module
945 * @param name The new module's filename
947 virtual void OnLoadModule(Module* mod,const std::string &name);
949 /** Called whenever a module is unloaded.
950 * mod will contain a pointer to the module, and string will contain its name,
951 * for example m_widgets.so. This function is primary for dependency checking,
952 * your module may decide to enable some extra features if it sees that you have
953 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
954 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
955 * but instead operate under reduced functionality, unless the dependency is
956 * absolutely neccessary (e.g. a module that extends the features of another
958 * @param mod Pointer to the module being unloaded (still valid)
959 * @param name The filename of the module being unloaded
961 virtual void OnUnloadModule(Module* mod,const std::string &name);
963 /** Called once every five seconds for background processing.
964 * This timer can be used to control timed features. Its period is not accurate
965 * enough to be used as a clock, but it is gauranteed to be called at least once in
966 * any five second period, directly from the main loop of the server.
967 * @param curtime The current timer derived from time(2)
969 virtual void OnBackgroundTimer(time_t curtime);
971 /** Called whenever any command is about to be executed.
972 * This event occurs for all registered commands, wether they are registered in the core,
973 * or another module, but it will not occur for invalid commands (e.g. ones which do not
974 * exist within the command table). By returning 1 from this method you may prevent the
975 * command being executed. If you do this, no output is created by the core, and it is
976 * down to your module to produce any output neccessary.
977 * Note that unless you return 1, you should not destroy any structures (e.g. by using
978 * Server::QuitUser) otherwise when the command's handler function executes after your
979 * method returns, it will be passed an invalid pointer to the user object and crash!)
980 * @param command The command being executed
981 * @param parameters An array of array of characters containing the parameters for the command
982 * @param pcnt The nuimber of parameters passed to the command
983 * @param user the user issuing the command
984 * @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.
985 * @return 1 to block the command, 0 to allow
987 virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated);
989 /** Called to check if a user who is connecting can now be allowed to register
990 * If any modules return false for this function, the user is held in the waiting
991 * state until all modules return true. For example a module which implements ident
992 * lookups will continue to return false for a user until their ident lookup is completed.
993 * Note that the registration timeout for a user overrides these checks, if the registration
994 * timeout is reached, the user is disconnected even if modules report that the user is
995 * not ready to connect.
996 * @param user The user to check
997 * @return true to indicate readiness, false if otherwise
999 virtual bool OnCheckReady(userrec* user);
1001 /** Called whenever a user is about to register their connection (e.g. before the user
1002 * is sent the MOTD etc). Modules can use this method if they are performing a function
1003 * which must be done before the actual connection is completed (e.g. ident lookups,
1004 * dnsbl lookups, etc).
1005 * Note that you should NOT delete the user record here by causing a disconnection!
1006 * Use OnUserConnect for that instead.
1007 * @param user The user registering
1009 virtual void OnUserRegister(userrec* user);
1011 /** Called whenever a mode character is processed.
1012 * Return 1 from this function to block the mode character from being processed entirely,
1013 * so that you may perform your own code instead. Note that this method allows you to override
1014 * modes defined by other modes, but this is NOT RECOMMENDED!
1015 * @param user The user who is sending the mode
1016 * @param chan The channel the mode is being sent to
1017 * @param mode The mode character being set
1018 * @param param The parameter for the mode or an empty string
1019 * @param adding true of the mode is being added, false if it is being removed
1020 * @param pcnt The parameter count for the mode (0 or 1)
1021 * @return 1 to deny the mode, 0 to allow
1023 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, const std::string ¶m, bool adding, int pcnt);
1025 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
1026 * This method will always be called for each join, wether or not the channel is actually +i, and
1027 * determines the outcome of an if statement around the whole section of invite checking code.
1028 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1029 * @param user The user joining the channel
1030 * @param chan The channel being joined
1031 * @return 1 to explicitly allow the join, 0 to proceed as normal
1033 virtual int OnCheckInvite(userrec* user, chanrec* chan);
1035 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
1036 * This method will always be called for each join, wether or not the channel is actually +k, and
1037 * determines the outcome of an if statement around the whole section of key checking code.
1038 * if the user specified no key, the keygiven string will be a valid but empty value.
1039 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1040 * @param user The user joining the channel
1041 * @param chan The channel being joined
1042 * @return 1 to explicitly allow the join, 0 to proceed as normal
1044 virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
1046 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
1047 * This method will always be called for each join, wether or not the channel is actually +l, and
1048 * determines the outcome of an if statement around the whole section of channel limit checking code.
1049 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1050 * @param user The user joining the channel
1051 * @param chan The channel being joined
1052 * @return 1 to explicitly allow the join, 0 to proceed as normal
1054 virtual int OnCheckLimit(userrec* user, chanrec* chan);
1056 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
1057 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
1058 * determines the outcome of an if statement around the whole section of ban checking code.
1059 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
1060 * @param user The user joining the channel
1061 * @param chan The channel being joined
1062 * @return 1 to explicitly allow the join, 0 to proceed as normal
1064 virtual int OnCheckBan(userrec* user, chanrec* chan);
1066 /** Called on all /STATS commands
1067 * This method is triggered for all /STATS use, including stats symbols handled by the core.
1068 * @param symbol the symbol provided to /STATS
1069 * @param user the user issuing the /STATS command
1070 * @param results A string_list to append results into
1071 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1073 virtual int OnStats(char symbol, userrec* user, string_list &results);
1075 /** Called whenever a change of a local users displayed host is attempted.
1076 * Return 1 to deny the host change, or 0 to allow it.
1077 * @param user The user whos host will be changed
1078 * @param newhost The new hostname
1079 * @return 1 to deny the host change, 0 to allow
1081 virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
1083 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1084 * return 1 to deny the name change, or 0 to allow it.
1085 * @param user The user whos GECOS will be changed
1086 * @param newhost The new GECOS
1087 * @return 1 to deny the GECOS change, 0 to allow
1089 virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
1091 /** Called whenever a topic is changed by a local user.
1092 * Return 1 to deny the topic change, or 0 to allow it.
1093 * @param user The user changing the topic
1094 * @param chan The channels who's topic is being changed
1095 * @param topic The actual topic text
1096 * @param 1 to block the topic change, 0 to allow
1098 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1100 /** Called whenever a local topic has been changed.
1101 * To block topic changes you must use OnLocalTopicChange instead.
1102 * @param user The user changing the topic
1103 * @param chan The channels who's topic is being changed
1104 * @param topic The actual topic text
1106 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
1108 /** Called whenever an Event class is sent to all module by another module.
1109 * Please see the documentation of Event::Send() for further information. The Event sent can
1110 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1111 * before doing anything to the event data, and you should *not* change the event data in any way!
1112 * @param event The Event class being received
1114 virtual void OnEvent(Event* event);
1116 /** Called whenever a Request class is sent to your module by another module.
1117 * Please see the documentation of Request::Send() for further information. The Request sent
1118 * can always be assumed to be non-NULL, you should not change the request object or its data.
1119 * Your method may return arbitary data in the char* result which the requesting module
1120 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1121 * @param request The Request class being received
1123 virtual char* OnRequest(Request* request);
1125 /** Called whenever an oper password is to be compared to what a user has input.
1126 * The password field (from the config file) is in 'password' and is to be compared against
1127 * 'input'. This method allows for encryption of oper passwords and much more besides.
1128 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1130 * @param password The oper's password
1131 * @param input The password entered
1132 * @return 1 to match the passwords, 0 to do nothing
1134 virtual int OnOperCompare(const std::string &password, const std::string &input);
1136 /** Called whenever a user is given usermode +o, anywhere on the network.
1137 * You cannot override this and prevent it from happening as it is already happened and
1138 * such a task must be performed by another server. You can however bounce modes by sending
1139 * servermodes out to reverse mode changes.
1140 * @param user The user who is opering
1142 virtual void OnGlobalOper(userrec* user);
1144 /** Called whenever a user connects, anywhere on the network.
1145 * This event is informational only. You should not change any user information in this
1146 * event. To do so, use the OnUserConnect method to change the state of local users.
1147 * @param user The user who is connecting
1149 virtual void OnGlobalConnect(userrec* user);
1151 /** Called whenever a ban is added to a channel's list.
1152 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1153 * @param source The user adding the ban
1154 * @param channel The channel the ban is being added to
1155 * @param banmask The ban mask being added
1156 * @return 1 to block the ban, 0 to continue as normal
1158 virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
1160 /** Called whenever a ban is removed from a channel's list.
1161 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1162 * @param source The user deleting the ban
1163 * @param channel The channel the ban is being deleted from
1164 * @param banmask The ban mask being deleted
1165 * @return 1 to block the unban, 0 to continue as normal
1167 virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
1169 /** Called immediately after any connection is accepted. This is intended for raw socket
1170 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1171 * no information relating to a user record as the connection has not been assigned yet.
1172 * There are no return values from this call as all modules get an opportunity if required to
1173 * process the connection.
1174 * @param fd The file descriptor returned from accept()
1175 * @param ip The IP address of the connecting user
1176 * @param localport The local port number the user connected to
1178 virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
1180 /** Called immediately before any write() operation on a user's socket in the core. Because
1181 * this event is a low level event no user information is associated with it. It is intended
1182 * for use by modules which may wrap connections within another API such as SSL for example.
1183 * return a non-zero result if you have handled the write operation, in which case the core
1184 * will not call write().
1185 * @param fd The file descriptor of the socket
1186 * @param buffer A char* buffer being written
1187 * @param Number of characters to write
1188 * @return Number of characters actually written or 0 if you didn't handle the operation
1190 virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
1192 /** Called immediately before any socket is closed. When this event is called, shutdown()
1193 * has not yet been called on the socket.
1194 * @param fd The file descriptor of the socket prior to close()
1196 virtual void OnRawSocketClose(int fd);
1198 /** Called immediately before any read() operation on a client socket in the core.
1199 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1200 * when this event occurs.
1201 * Your event should return 1 if it has handled the reading itself, which prevents the core
1202 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1203 * the value of count. The value of readresult must be identical to an actual result that might
1204 * be returned from the read() system call, for example, number of bytes read upon success,
1205 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1206 * you MUST set readresult.
1207 * @param fd The file descriptor of the socket
1208 * @param buffer A char* buffer being read to
1209 * @param count The size of the buffer
1210 * @param readresult The amount of characters read, or 0
1211 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1213 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1215 /** Called whenever a user sets away.
1216 * This method has no parameter for the away message, as it is available in the
1217 * user record as userrec::awaymsg.
1219 virtual void OnSetAway(userrec* user);
1221 /** Called when a user cancels their away state.
1223 virtual void OnCancelAway(userrec* user);
1227 /** Allows server output and query functions
1228 * This class contains methods which allow a module to query the state of the irc server, and produce
1229 * output to users and other servers. All modules should instantiate at least one copy of this class,
1230 * and use its member functions to perform their tasks.
1232 class Server : public Extensible
1235 /** Default constructor.
1236 * Creates a Server object.
1240 /** Default destructor.
1241 * Destroys a Server object.
1245 /** Obtains a pointer to the server's ServerConfig object.
1246 * The ServerConfig object contains most of the configuration data
1247 * of the IRC server, as read from the config file by the core.
1249 ServerConfig* GetConfig();
1251 /** For use with Module::Prioritize().
1252 * When the return value of this function is returned from
1253 * Module::Prioritize(), this specifies that the module wishes
1254 * to be ordered exactly BEFORE 'modulename'. For more information
1255 * please see Module::Prioritize().
1256 * @param modulename The module your module wants to be before in the call list
1257 * @returns a priority ID which the core uses to relocate the module in the list
1259 long PriorityBefore(const std::string &modulename);
1261 /** For use with Module::Prioritize().
1262 * When the return value of this function is returned from
1263 * Module::Prioritize(), this specifies that the module wishes
1264 * to be ordered exactly AFTER 'modulename'. For more information please
1265 * see Module::Prioritize().
1266 * @param modulename The module your module wants to be after in the call list
1267 * @returns a priority ID which the core uses to relocate the module in the list
1269 long PriorityAfter(const std::string &modulename);
1271 /** Sends text to all opers.
1272 * This method sends a server notice to all opers with the usermode +s.
1274 virtual void SendOpers(const std::string &s);
1276 /** Returns the version string of this server
1278 std::string GetVersion();
1280 /** Publish a 'feature'.
1281 * There are two ways for a module to find another module it depends on.
1282 * Either by name, using Server::FindModule, or by feature, using this
1283 * function. A feature is an arbitary string which identifies something this
1284 * module can do. For example, if your module provides SSL support, but other
1285 * modules provide SSL support too, all the modules supporting SSL should
1286 * publish an identical 'SSL' feature. This way, any module requiring use
1287 * of SSL functions can just look up the 'SSL' feature using FindFeature,
1288 * then use the module pointer they are given.
1289 * @param FeatureName The case sensitive feature name to make available
1290 * @param Mod a pointer to your module class
1291 * @returns True on success, false if the feature is already published by
1294 bool PublishFeature(const std::string &FeatureName, Module* Mod);
1296 /** Unpublish a 'feature'.
1297 * When your module exits, it must call this method for every feature it
1298 * is providing so that the feature table is cleaned up.
1299 * @param FeatureName the feature to remove
1301 bool UnpublishFeature(const std::string &FeatureName);
1303 /** Find a 'feature'.
1304 * There are two ways for a module to find another module it depends on.
1305 * Either by name, using Server::FindModule, or by feature, using the
1306 * Server::PublishFeature method. A feature is an arbitary string which
1307 * identifies something this module can do. For example, if your module
1308 * provides SSL support, but other modules provide SSL support too, all
1309 * the modules supporting SSL should publish an identical 'SSL' feature.
1310 * To find a module capable of providing the feature you want, simply
1311 * call this method with the feature name you are looking for.
1312 * @param FeatureName The feature name you wish to obtain the module for
1313 * @returns A pointer to a valid module class on success, NULL on failure.
1315 Module* FindFeature(const std::string &FeatureName);
1317 const std::string& GetModuleName(Module* m);
1319 /** Writes a log string.
1320 * This method writes a line of text to the log. If the level given is lower than the
1321 * level given in the configuration, this command has no effect.
1323 virtual void Log(int level, const std::string &s);
1325 /** Returns true if a nick is valid.
1326 * Nicks for unregistered connections will return false.
1328 virtual bool IsNick(const std::string &nick);
1330 /** Returns a count of the number of users on a channel.
1331 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1333 virtual int CountUsers(chanrec* c);
1335 /** Adds an InspTimer which will trigger at a future time
1337 virtual void AddTimer(InspTimer* T);
1339 /** Attempts to look up a nick and return a pointer to it.
1340 * This function will return NULL if the nick does not exist.
1342 virtual userrec* FindNick(const std::string &nick);
1344 /** Attempts to look up a nick using the file descriptor associated with that nick.
1345 * This function will return NULL if the file descriptor is not associated with a valid user.
1347 virtual userrec* FindDescriptor(int socket);
1349 /** Attempts to look up a channel and return a pointer to it.
1350 * This function will return NULL if the channel does not exist.
1352 virtual chanrec* FindChannel(const std::string &channel);
1354 /** Attempts to look up a user's privilages on a channel.
1355 * This function will return a string containing either @, %, +, or an empty string,
1356 * representing the user's privilages upon the channel you specify.
1358 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1360 /** Returns the server name of the server where the module is loaded.
1362 virtual std::string GetServerName();
1364 /** Returns the network name, global to all linked servers.
1366 virtual std::string GetNetworkName();
1368 /** Returns the server description string of the local server
1370 virtual std::string GetServerDescription();
1372 /** Returns the information of the server as returned by the /ADMIN command.
1373 * See the Admin class for further information of the return value. The members
1374 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1375 * server where the module is loaded.
1377 virtual Admin GetAdmin();
1379 virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
1381 virtual bool AddModeWatcher(ModeWatcher* mw);
1383 virtual bool DelModeWatcher(ModeWatcher* mw);
1385 virtual bool AddResolver(Resolver* r);
1387 /** Adds a command to the command table.
1388 * This allows modules to add extra commands into the command table. You must place a function within your
1389 * module which is is of type handlerfunc:
1391 * typedef void (handlerfunc) (char**, int, userrec*);
1393 * void handle_kill(char **parameters, int pcnt, userrec *user)
1395 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1396 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1397 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1398 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1399 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1400 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1401 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1404 virtual void AddCommand(command_t *f);
1406 /** Sends a servermode.
1407 * you must format the parameters array with the target, modes and parameters for those modes.
1413 * modes[0] = ChannelName;
1417 * modes[2] = user->nick;
1419 * Srv->SendMode(modes,3,user);
1421 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1422 * will be sent to the user you provide as the third parameter.
1423 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1424 * your server in an unstable state!
1427 virtual void SendMode(const char **parameters, int pcnt, userrec *user);
1429 /** Sends to all users matching a mode mask
1430 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1431 * or module provided modes, including ones provided by your own module.
1432 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1433 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1434 * for example, if you were to use:
1436 * Serv->SendToModeMask("xi", WM_OR, "m00");
1438 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1439 * user must have both modes set to receive the message.
1441 virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
1443 /** Matches text against a glob pattern.
1444 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1445 * Returns true if the literal successfully matches the pattern, false if otherwise.
1447 virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
1449 /** Calls the handler for a command, either implemented by the core or by another module.
1450 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1451 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1452 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1453 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1454 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1455 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1456 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1457 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1458 * used for privilage checks, etc.
1459 * @return True if the command exists
1461 virtual bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
1463 /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
1464 * of paramters the command requires, the user specified is allowed to execute the command, AND
1465 * if the command is implemented by a module (not the core). This has a few specific uses, usually
1466 * within network protocols (see src/modules/m_spanningtree.cpp)
1468 virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
1470 /** Returns true if the servername you give is ulined.
1471 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1472 * change modes of clients which are on remote servers and set modes of channels where there are
1473 * no channel operators for that channel on the ulined server, amongst other things.
1475 virtual bool IsUlined(const std::string &server);
1477 /** Remove a user's connection to the irc server, but leave their client in existence in the
1478 * user hash. When you call this function, the user's file descriptor will be replaced with the
1479 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1480 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1481 * After this call, the pointer to user will be invalid.
1483 virtual bool UserToPseudo(userrec* user, const std::string &message);
1485 /** This user takes one user, and switches their file descriptor with another user, so that one user
1486 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1487 * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
1488 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1489 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1491 virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
1494 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1495 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1496 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1497 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1500 virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1503 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1504 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1505 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1506 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1509 virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
1512 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1513 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1514 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1515 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1518 virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
1521 * The K-line is enforced as soon as it is added.
1522 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1523 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1524 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1527 virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1530 * The E-line is enforced as soon as it is added.
1531 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1532 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1533 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1536 virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
1538 /** Deletes a G-Line from all servers
1540 virtual bool DelGLine(const std::string &hostmask);
1542 /** Deletes a Q-Line from all servers
1544 virtual bool DelQLine(const std::string &nickname);
1546 /** Deletes a Z-Line from all servers
1548 virtual bool DelZLine(const std::string &ipaddr);
1550 /** Deletes a local K-Line
1552 virtual bool DelKLine(const std::string &hostmask);
1554 /** Deletes a local E-Line
1556 virtual bool DelELine(const std::string &hostmask);
1558 /** Calculates a duration
1559 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1560 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1563 virtual long CalcDuration(const std::string &duration);
1565 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1567 virtual bool IsValidMask(const std::string &mask);
1569 /** This function finds a module by name.
1570 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1571 * the function will return NULL.
1573 virtual Module* FindModule(const std::string &name);
1575 /** Adds a class derived from InspSocket to the server's socket engine.
1577 virtual void AddSocket(InspSocket* sock);
1579 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1581 virtual void RemoveSocket(InspSocket* sock);
1583 /** Deletes a class derived from InspSocket from the server's socket engine.
1585 virtual void DelSocket(InspSocket* sock);
1587 /** Causes the local server to rehash immediately.
1588 * WARNING: Do not call this method from within your rehash method, for
1591 virtual void RehashServer();
1593 /** This method returns the total number of channels on the network.
1595 virtual long GetChannelCount();
1597 /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
1598 * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
1599 * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
1602 virtual chanrec* GetChannelIndex(long index);
1604 /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
1605 * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
1608 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
1612 #define CONF_NOT_A_NUMBER 0x000010
1613 #define CONF_NOT_UNSIGNED 0x000080
1614 #define CONF_VALUE_NOT_FOUND 0x000100
1615 #define CONF_FILE_NOT_FOUND 0x000200
1618 /** Allows reading of values from configuration files
1619 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1620 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1621 * Constructing the class using one parameter allows you to specify a path to your own configuration
1622 * file, otherwise, inspircd.conf is read.
1624 class ConfigReader : public classbase
1627 /** The contents of the configuration file
1628 * This protected member should never be accessed by a module (and cannot be accessed unless the
1629 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1630 * (such as comments) stripped from it.
1632 ConfigDataHash* data;
1633 std::ostringstream* errorlog;;
1634 /** Used to store errors
1636 bool privatehash; // If we're using our own config data hash or not.
1641 /** Default constructor.
1642 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1643 * as specified when running ./configure.
1645 ConfigReader(); // default constructor reads ircd.conf
1646 /** Overloaded constructor.
1647 * This constructor initialises the ConfigReader class to read a user-specified config file
1649 ConfigReader(const std::string &filename); // read a module-specific config
1650 /** Default destructor.
1651 * This method destroys the ConfigReader class.
1654 /** Retrieves a value from the config file.
1655 * This method retrieves a value from the config file. Where multiple copies of the tag
1656 * exist in the config file, index indicates which of the values to retrieve.
1658 std::string ReadValue(const std::string &tag, const std::string &name, int index);
1659 /** Retrieves a boolean value from the config file.
1660 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1661 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1662 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1664 bool ReadFlag(const std::string &tag, const std::string &name, int index);
1665 /** Retrieves an integer value from the config file.
1666 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1667 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1668 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1669 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1670 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1671 * will return CONF_NOT_UNSIGNED
1673 long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
1674 /** Returns the last error to occur.
1675 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1676 * A call to GetError() resets the error flag back to 0.
1679 /** Counts the number of times a given tag appears in the config file.
1680 * This method counts the number of times a tag appears in a config file, for use where
1681 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1682 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1683 * multiple instance tag.
1685 int Enumerate(const std::string &tag);
1686 /** Returns true if a config file is valid.
1687 * This method is partially implemented and will only return false if the config
1688 * file does not exist or could not be opened.
1691 /** Dumps the list of errors in a config file to an output location. If bail is true,
1692 * then the program will abort. If bail is false and user points to a valid user
1693 * record, the error report will be spooled to the given user by means of NOTICE.
1694 * if bool is false AND user is false, the error report will be spooled to all opers
1695 * by means of a NOTICE to all opers.
1697 void DumpErrors(bool bail,userrec* user);
1699 /** Returns the number of items within a tag.
1700 * For example if the tag was <test tag="blah" data="foo"> then this
1701 * function would return 2. Spaces and newlines both qualify as valid seperators
1704 int EnumerateValues(const std::string &tag, int index);
1709 /** Caches a text file into memory and can be used to retrieve lines from it.
1710 * This class contains methods for read-only manipulation of a text file in memory.
1711 * Either use the constructor type with one parameter to load a file into memory
1712 * at construction, or use the LoadFile method to load a file.
1714 class FileReader : public classbase
1716 /** The file contents
1720 unsigned long contentsize;
1725 /** Default constructor.
1726 * This method does not load any file into memory, you must use the LoadFile method
1727 * after constructing the class this way.
1731 /** Secondary constructor.
1732 * This method initialises the class with a file loaded into it ready for GetLine and
1733 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1736 FileReader(const std::string &filename);
1738 /** Default destructor.
1739 * This deletes the memory allocated to the file.
1743 /** Used to load a file.
1744 * This method loads a file into the class ready for GetLine and
1745 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1748 void LoadFile(const std::string &filename);
1750 /** Returns the whole content of the file as std::string
1752 std::string Contents();
1754 /** Returns the entire size of the file as std::string
1756 unsigned long ContentSize();
1758 /** Returns true if the file exists
1759 * This function will return false if the file could not be opened.
1763 /** Retrieve one line from the file.
1764 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1765 * the index was out of bounds, or the line had no data on it.
1767 std::string GetLine(int x);
1769 /** Returns the size of the file in lines.
1770 * This method returns the number of lines in the read file. If it is 0, no lines have been
1771 * read into memory, either because the file is empty or it does not exist, or cannot be
1772 * opened due to permission problems.
1778 /** Instantiates classes inherited from Module
1779 * This class creates a class inherited from type Module, using new. This is to allow for modules
1780 * to create many different variants of Module, dependent on architecture, configuration, etc.
1781 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1784 class ModuleFactory : public classbase
1788 virtual ~ModuleFactory() { }
1789 /** Creates a new module.
1790 * Your inherited class of ModuleFactory must return a pointer to your Module class
1791 * using this method.
1793 virtual Module * CreateModule(Server* Me) = 0;
1797 typedef DLLFactory<ModuleFactory> ircd_module;
1798 typedef std::vector<Module*> ModuleList;
1799 typedef std::vector<ircd_module*> FactoryList;