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 OnExtendedMode() method of modules
27 enum ModeTargetType { MT_CHANNEL, MT_CLIENT, MT_SERVER };
29 /** Used with OnAccessCheck() method of modules
31 enum AccessControlType {
32 ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
33 ACR_DENY, // deny the action
34 ACR_ALLOW, // allow the action
35 AC_KICK, // a user is being kicked
36 AC_DEOP, // a user is being deopped
37 AC_OP, // a user is being opped
38 AC_VOICE, // a user is being voiced
39 AC_DEVOICE, // a user is being devoiced
40 AC_HALFOP, // a user is being halfopped
41 AC_DEHALFOP, // a user is being dehalfopped
42 AC_INVITE, // a user is being invited
43 AC_GENERAL_MODE // a channel mode is being changed
46 /** Used to define a set of behavior bits for a module
49 VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
50 VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
51 VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
52 VF_COMMON = 8 // module needs to be common on all servers in a network to link
60 enum TargetTypeFlags {
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 users in a channel
85 typedef std::deque<userrec*> chanuserlist;
88 // This #define allows us to call a method in all
89 // loaded modules in a readable simple way, e.g.:
90 // 'FOREACH_MOD OnConnect(user);'
92 #define FOREACH_MOD(y,x) if (Config->global_implementation[y] > 0) { \
93 for (int _i = 0; _i <= MODCOUNT; _i++) { \
94 if (Config->implement_lists[_i][y]) \
99 // This define is similar to the one above but returns a result in MOD_RESULT.
100 // The first module to return a nonzero result is the value to be accepted,
101 // and any modules after are ignored.
103 // *********************************************************************************************
105 #define FOREACH_RESULT(y,x) { if (Config->global_implementation[y] > 0) { \
107 for (int _i = 0; _i <= MODCOUNT; _i++) { \
108 if (Config->implement_lists[_i][y]) {\
109 int res = modules[_i]->x ; \
119 // *********************************************************************************************
121 #define FD_MAGIC_NUMBER -42
125 #define IS_LOCAL(x) (x->fd > -1)
126 #define IS_REMOTE(x) (x->fd < 0)
127 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
129 /*extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
130 extern void server_mode(char **parameters, int pcnt, userrec *user);*/
132 // class Version holds the version information of a Module, returned
133 // by Module::GetVersion (thanks RD)
135 /** Holds a module's Version information
136 * The four members (set by the constructor only) indicate details as to the version number
137 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
139 class Version : public classbase
142 const int Major, Minor, Revision, Build, Flags;
143 Version(int major, int minor, int revision, int build, int flags);
146 /** Holds /ADMIN data
147 * This class contains the admin details of the local server. It is constructed by class Server,
148 * and has three read-only values, Name, Email and Nick that contain the specified values for the
149 * server where the module is running.
151 class Admin : public classbase
154 const std::string Name, Email, Nick;
155 Admin(std::string name, std::string email, std::string nick);
159 // Forward-delacare module for ModuleMessage etc
162 // Thanks to Rob (from anope) for the idea of this message passing API
163 // (its been done before, but this seemed a very neat and tidy way...
165 /** The ModuleMessage class is the base class of Request and Event
166 * This class is used to represent a basic data structure which is passed
167 * between modules for safe inter-module communications.
169 class ModuleMessage : public classbase
172 /** This class is pure virtual and must be inherited.
174 virtual char* Send() = 0;
175 virtual ~ModuleMessage() {};
178 /** The Request class is a unicast message directed at a given module.
179 * When this class is properly instantiated it may be sent to a module
180 * using the Send() method, which will call the given module's OnRequest
181 * method with this class as its parameter.
183 class Request : public ModuleMessage
186 /** This member holds a pointer to arbitary data set by the emitter of the message
189 /** This is a pointer to the sender of the message, which can be used to
190 * directly trigger events, or to create a reply.
193 /** The single destination of the Request
197 /** Create a new Request
199 Request(char* anydata, Module* src, Module* dst);
200 /** Fetch the Request data
203 /** Fetch the request source
206 /** Fetch the request destination (should be 'this' in the receiving module)
209 /** Send the Request.
210 * Upon returning the result will be arbitary data returned by the module you
211 * sent the request to. It is up to your module to know what this data is and
212 * how to deal with it.
218 /** The Event class is a unicast message directed at all modules.
219 * When the class is properly instantiated it may be sent to all modules
220 * using the Send() method, which will trigger the OnEvent method in
221 * all modules passing the object as its parameter.
223 class Event : public ModuleMessage
226 /** This member holds a pointer to arbitary data set by the emitter of the message
229 /** This is a pointer to the sender of the message, which can be used to
230 * directly trigger events, or to create a reply.
233 /** The event identifier.
234 * This is arbitary text which should be used to distinguish
235 * one type of event from another.
239 /** Create a new Event
241 Event(char* anydata, Module* src, std::string eventid);
242 /** Get the Event data
245 /** Get the event Source
248 /** Get the event ID.
249 * Use this to determine the event type for safe casting of the data
251 std::string GetEventID();
253 * The return result of an Event::Send() will always be NULL as
254 * no replies are expected.
259 /** Holds an extended mode's details.
260 * Used internally by modules.cpp
262 class ExtMode : public classbase
271 ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
275 enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
277 enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
278 I_OnExtendedMode, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
279 I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
280 I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
281 I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
282 I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
283 I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
284 I_OnBackgroundTimer, I_OnSendList, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnRawMode, I_OnCheckInvite,
285 I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
286 I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnGlobalConnect, I_OnAddBan, I_OnDelBan,
287 I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
288 I_OnOperCompare, I_OnChannelDelete };
290 /** Base class for all InspIRCd modules
291 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
292 * its methods will be called when irc server events occur. class inherited from module must be
293 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
295 class Module : public classbase
299 /** Default constructor
300 * Creates a module class.
301 * @param Me An instance of the Server class which can be saved for future use
305 /** Default destructor
306 * destroys a module class
310 /** Returns the version number of a Module.
311 * The method should return a Version object with its version information assigned via
314 virtual Version GetVersion();
316 virtual void Implements(char* Implements);
318 virtual Priority Prioritize();
320 /** Called when a user connects.
321 * The details of the connecting user are available to you in the parameter userrec *user
322 * @param user The user who is connecting
324 virtual void OnUserConnect(userrec* user);
326 /** Called when a user quits.
327 * The details of the exiting user are available to you in the parameter userrec *user
328 * This event is only called when the user is fully registered when they quit. To catch
329 * raw disconnections, use the OnUserDisconnect method.
330 * @param user The user who is quitting
331 * @param message The user's quit message
333 virtual void OnUserQuit(userrec* user, std::string message);
335 /** Called whenever a user's socket is closed.
336 * The details of the exiting user are available to you in the parameter userrec *user
337 * This event is called for all users, registered or not, as a cleanup method for modules
338 * which might assign resources to user, such as dns lookups, objects and sockets.
339 * @param user The user who is disconnecting
341 virtual void OnUserDisconnect(userrec* user);
343 /** Called whenever a channel is deleted, either by QUIT, KICK or PART.
344 * @param chan The channel being deleted
346 virtual void OnChannelDelete(chanrec* chan);
348 /** Called when a user joins a channel.
349 * The details of the joining user are available to you in the parameter userrec *user,
350 * and the details of the channel they have joined is available in the variable chanrec *channel
351 * @param user The user who is joining
352 * @param channel The channel being joined
354 virtual void OnUserJoin(userrec* user, chanrec* channel);
356 /** Called when a user parts a channel.
357 * The details of the leaving user are available to you in the parameter userrec *user,
358 * and the details of the channel they have left is available in the variable chanrec *channel
359 * @param user The user who is parting
360 * @param channel The channel being parted
361 * @param partmessage The part message, or an empty string
363 virtual void OnUserPart(userrec* user, chanrec* channel, std::string partmessage);
365 /** Called on rehash.
366 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
367 * system. You should use it to reload any files so that your module keeps in step with the
368 * rest of the application. If a parameter is given, the core has done nothing. The module
369 * receiving the event can decide if this parameter has any relevence to it.
370 * @param parameter The (optional) parameter given to REHASH from the user.
372 virtual void OnRehash(std::string parameter);
374 /** Called when a raw command is transmitted or received.
375 * This method is the lowest level of handler available to a module. It will be called with raw
376 * data which is passing through a connected socket. If you wish, you may munge this data by changing
377 * the string parameter "raw". If you do this, after your function exits it will immediately be
378 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
379 * inbound is set to true) the value of user will be the userrec of the connection sending the
380 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
381 * @param raw The raw string in RFC1459 format
382 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
383 * @param user The user record sending the text, when inbound == true.
385 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
387 /** Called whenever an extended mode is to be processed.
388 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
389 * changed. mode_on is set when the mode is being set, in which case params contains a list of
390 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
391 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
392 * was set up with Server::AddExtendedMode
393 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
394 * You must cast this value yourself to make use of it.
395 * @param user The user issuing the mode
396 * @param target The user or channel having the mode set on them
397 * @param modechar The mode character being set
398 * @param type The type of mode (user or channel) being set
399 * @param mode_on True if the mode is being set, false if it is being unset
400 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
402 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
404 /** Called whenever a user is about to join a channel, before any processing is done.
405 * Returning a value of 1 from this function stops the process immediately, causing no
406 * output to be sent to the user by the core. If you do this you must produce your own numerics,
407 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
408 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
412 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
413 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
414 * processing on the actual channel record at this point, however the channel NAME will still be passed in
415 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
416 * @param user The user joining the channel
417 * @param cname The channel name being joined
418 * @return 1 To prevent the join, 0 to allow it.
420 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
422 /** Called whenever a user is about to be kicked.
423 * Returning a value of 1 from this function stops the process immediately, causing no
424 * output to be sent to the user by the core. If you do this you must produce your own numerics,
426 * @param source The user issuing the kick
427 * @param user The user being kicked
428 * @param chan The channel the user is being kicked from
429 * @param reason The kick reason
430 * @return 1 to prevent the kick, 0 to allow it
432 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
434 /** Called whenever a user is kicked.
435 * If this method is called, the kick is already underway and cannot be prevented, so
436 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
437 * @param source The user issuing the kick
438 * @param user The user being kicked
439 * @param chan The channel the user is being kicked from
440 * @param reason The kick reason
442 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
444 /** Called whenever a user opers locally.
445 * The userrec will contain the oper mode 'o' as this function is called after any modifications
446 * are made to the user's structure by the core.
447 * @param user The user who is opering up
448 * @param opertype The opers type name
450 virtual void OnOper(userrec* user, std::string opertype);
452 /** Called whenever a user types /INFO.
453 * The userrec will contain the information of the user who typed the command. Modules may use this
454 * method to output their own credits in /INFO (which is the ircd's version of an about box).
455 * It is purposefully not possible to modify any info that has already been output, or halt the list.
456 * You must write a 371 numeric to the user, containing your info in the following format:
458 * <nick> :information here
460 * @param user The user issuing /INFO
462 virtual void OnInfo(userrec* user);
464 /** Called whenever a /WHOIS is performed on a local user.
465 * The source parameter contains the details of the user who issued the WHOIS command, and
466 * the dest parameter contains the information of the user they are whoising.
467 * @param source The user issuing the WHOIS command
468 * @param dest The user who is being WHOISed
470 virtual void OnWhois(userrec* source, userrec* dest);
472 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
473 * Returning 1 from this function stops the process immediately, causing no
474 * output to be sent to the user by the core. If you do this you must produce your own numerics,
475 * notices etc. This is useful for modules which may want to filter invites to channels.
476 * @param source The user who is issuing the INVITE
477 * @param dest The user being invited
478 * @param channel The channel the user is being invited to
479 * @return 1 to deny the invite, 0 to allow
481 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
483 /** Called after a user has been successfully invited to a channel.
484 * You cannot prevent the invite from occuring using this function, to do that,
485 * use OnUserPreInvite instead.
486 * @param source The user who is issuing the INVITE
487 * @param dest The user being invited
488 * @param channel The channel the user is being invited to
490 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
492 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
493 * Returning any nonzero value from this function stops the process immediately, causing no
494 * output to be sent to the user by the core. If you do this you must produce your own numerics,
495 * notices etc. This is useful for modules which may want to filter or redirect messages.
496 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
497 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
498 * of where the message is destined to be sent.
499 * @param user The user sending the message
500 * @param dest The target of the message (chanrec* or userrec*)
501 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
502 * @param text Changeable text being sent by the user
503 * @return 1 to deny the NOTICE, 0 to allow it
505 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
507 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
508 * Returning any nonzero value from this function stops the process immediately, causing no
509 * output to be sent to the user by the core. If you do this you must produce your own numerics,
510 * notices etc. This is useful for modules which may want to filter or redirect messages.
511 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
512 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
513 * of where the message is destined to be sent.
514 * You may alter the message text as you wish before relinquishing control to the next module
515 * in the chain, and if no other modules block the text this altered form of the text will be sent out
516 * to the user and possibly to other servers.
517 * @param user The user sending the message
518 * @param dest The target of the message (chanrec* or userrec*)
519 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
520 * @param text Changeable text being sent by the user
521 * @return 1 to deny the NOTICE, 0 to allow it
523 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
525 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
526 * Please note that although you can see remote nickchanges through this function, you should
527 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
528 * check user->server before taking any action (including returning nonzero from the method).
529 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
530 * module to generate some meaninful output.
531 * @param user The username changing their nick
532 * @param newnick Their new nickname
533 * @return 1 to deny the change, 0 to allow
535 virtual int OnUserPreNick(userrec* user, std::string newnick);
537 /** Called after any PRIVMSG sent from a user.
538 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
539 * if target_type is TYPE_CHANNEL.
540 * @param user The user sending the message
541 * @param dest The target of the message
542 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
543 * @param text the text being sent by the user
545 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
547 /** Called after any NOTICE sent from a user.
548 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
549 * if target_type is TYPE_CHANNEL.
550 * @param user The user sending the message
551 * @param dest The target of the message
552 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
553 * @param text the text being sent by the user
555 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
557 /** Called after every MODE command sent from a user
558 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
559 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
560 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
561 * @param user The user sending the MODEs
562 * @param dest The target of the modes (userrec* or chanrec*)
563 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
564 * @param text The actual modes and their parameters if any
566 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
568 /** Allows modules to alter or create server descriptions
569 * Whenever a module requires a server description, for example for display in
570 * WHOIS, this function is called in all modules. You may change or define the
571 * description given in std::string &description. If you do, this description
572 * will be shown in the WHOIS fields.
573 * @param servername The servername being searched for
574 * @param description Alterable server description for this server
576 virtual void OnGetServerDescription(std::string servername,std::string &description);
578 /** Allows modules to synchronize data which relates to users during a netburst.
579 * When this function is called, it will be called from the module which implements
580 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
581 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
582 * (see below). This function will be called for every user visible on your side
583 * of the burst, allowing you to for example set modes, etc. Do not use this call to
584 * synchronize data which you have stored using class Extensible -- There is a specialist
585 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
586 * @param user The user being syncronized
587 * @param proto A pointer to the module handling network protocol
588 * @param opaque An opaque pointer set by the protocol module, should not be modified!
590 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
592 /** Allows modules to synchronize data which relates to channels during a netburst.
593 * When this function is called, it will be called from the module which implements
594 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
595 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
596 * (see below). This function will be called for every user visible on your side
597 * of the burst, allowing you to for example set modes, etc. Do not use this call to
598 * synchronize data which you have stored using class Extensible -- There is a specialist
599 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
601 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
603 * @param chan The channel being syncronized
604 * @param proto A pointer to the module handling network protocol
605 * @param opaque An opaque pointer set by the protocol module, should not be modified!
607 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
609 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
610 * Whenever the linking module wants to send out data, but doesnt know what the data
611 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
612 * this method is called.You should use the ProtoSendMetaData function after you've
613 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
614 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
615 * @param chan The channel whos metadata is being syncronized
616 * @param proto A pointer to the module handling network protocol
617 * @param opaque An opaque pointer set by the protocol module, should not be modified!
618 * @param extname The extensions name which is being searched for
620 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
622 /* Allows modules to syncronize metadata related to users over the network during a netburst.
623 * Whenever the linking module wants to send out data, but doesnt know what the data
624 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
625 * this method is called. You should use the ProtoSendMetaData function after you've
626 * correctly decided how the data should be represented, to send the metadata on its way if
627 * if it belongs to your module.
628 * @param user The user whos metadata is being syncronized
629 * @param proto A pointer to the module handling network protocol
630 * @param opaque An opaque pointer set by the protocol module, should not be modified!
631 * @param extname The extensions name which is being searched for
633 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
635 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
636 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
637 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
638 * @param target The chanrec* or userrec* that data should be added to
639 * @param extname The extension name which is being sent
640 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
642 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
644 /** Implemented by modules which provide the ability to link servers.
645 * These modules will implement this method, which allows transparent sending of servermodes
646 * down the network link as a broadcast, without a module calling it having to know the format
647 * of the MODE command before the actual mode string.
649 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
650 * of how to use this function.
652 * @param opaque An opaque pointer set by the protocol module, should not be modified!
653 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
654 * @param target The chanrec* or userrec* that modes should be sent for
655 * @param modeline The modes and parameters to be sent
657 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
659 /** Implemented by modules which provide the ability to link servers.
660 * These modules will implement this method, which allows metadata (extra data added to
661 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
662 * to other servers on a netburst and decoded at the other end by the same module on a
665 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
666 * how to use this function.
667 * @param opaque An opaque pointer set by the protocol module, should not be modified!
668 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
669 * @param target The chanrec* or userrec* that metadata should be sent for
670 * @param extname The extension name to send metadata for
671 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
673 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
675 /** Called after every WALLOPS command.
676 * @param user The user sending the WALLOPS
677 * @param text The content of the WALLOPS message
679 virtual void OnWallops(userrec* user, std::string text);
681 /** Called whenever a user's hostname is changed.
682 * This event triggers after the host has been set.
683 * @param user The user whos host is being changed
684 * @param newhost The new hostname being set
686 virtual void OnChangeHost(userrec* user, std::string newhost);
688 /** Called whenever a user's GECOS (realname) is changed.
689 * This event triggers after the name has been set.
690 * @param user The user who's GECOS is being changed
691 * @param gecos The new GECOS being set on the user
693 virtual void OnChangeName(userrec* user, std::string gecos);
695 /** Called whenever a gline is added by a local user.
696 * This method is triggered after the line is added.
697 * @param duration The duration of the line in seconds
698 * @param source The sender of the line
699 * @param reason The reason text to be displayed
700 * @param hostmask The hostmask to add
702 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
704 /** Called whenever a zline is added by a local user.
705 * This method is triggered after the line is added.
706 * @param duration The duration of the line in seconds
707 * @param source The sender of the line
708 * @param reason The reason text to be displayed
709 * @param ipmask The hostmask to add
711 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
713 /** Called whenever a kline is added by a local user.
714 * This method is triggered after the line is added.
715 * @param duration The duration of the line in seconds
716 * @param source The sender of the line
717 * @param reason The reason text to be displayed
718 * @param hostmask The hostmask to add
720 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
722 /** Called whenever a qline is added by a local user.
723 * This method is triggered after the line is added.
724 * @param duration The duration of the line in seconds
725 * @param source The sender of the line
726 * @param reason The reason text to be displayed
727 * @param nickmask The hostmask to add
729 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
731 /** Called whenever a eline is added by a local user.
732 * This method is triggered after the line is added.
733 * @param duration The duration of the line in seconds
734 * @param source The sender of the line
735 * @param reason The reason text to be displayed
736 * @param hostmask The hostmask to add
738 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
740 /** Called whenever a gline is deleted.
741 * This method is triggered after the line is deleted.
742 * @param source The user removing the line
743 * @param hostmask The hostmask to delete
745 virtual void OnDelGLine(userrec* source, std::string hostmask);
747 /** Called whenever a zline is deleted.
748 * This method is triggered after the line is deleted.
749 * @param source The user removing the line
750 * @param hostmask The hostmask to delete
752 virtual void OnDelZLine(userrec* source, std::string ipmask);
754 /** Called whenever a kline is deleted.
755 * This method is triggered after the line is deleted.
756 * @param source The user removing the line
757 * @param hostmask The hostmask to delete
759 virtual void OnDelKLine(userrec* source, std::string hostmask);
761 /** Called whenever a qline is deleted.
762 * This method is triggered after the line is deleted.
763 * @param source The user removing the line
764 * @param hostmask The hostmask to delete
766 virtual void OnDelQLine(userrec* source, std::string nickmask);
768 /** Called whenever a eline is deleted.
769 * This method is triggered after the line is deleted.
770 * @param source The user removing the line
771 * @param hostmask The hostmask to delete
773 virtual void OnDelELine(userrec* source, std::string hostmask);
775 /** Called before your module is unloaded to clean up Extensibles.
776 * This method is called once for every user and channel on the network,
777 * so that when your module unloads it may clear up any remaining data
778 * in the form of Extensibles added using Extensible::Extend().
779 * If the target_type variable is TYPE_USER, then void* item refers to
780 * a userrec*, otherwise it refers to a chanrec*.
781 * @param target_type The type of item being cleaned
782 * @param item A pointer to the item's class
784 virtual void OnCleanup(int target_type, void* item);
786 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
787 * have been applied. Please note that although you can see remote nickchanges through this function, you should
788 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
789 * check user->server before taking any action (including returning nonzero from the method).
790 * Because this method is called after the nickchange is taken place, no return values are possible
791 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
792 * @param user The user changing their nick
793 * @param oldnick The old nickname of the user before the nickchange
795 virtual void OnUserPostNick(userrec* user, std::string oldnick);
797 /** Called before an action which requires a channel privilage check.
798 * This function is called before many functions which check a users status on a channel, for example
799 * before opping a user, deopping a user, kicking a user, etc.
800 * There are several values for access_type which indicate for what reason access is being checked.
802 * AC_KICK (0) - A user is being kicked<br>
803 * AC_DEOP (1) - a user is being deopped<br>
804 * AC_OP (2) - a user is being opped<br>
805 * AC_VOICE (3) - a user is being voiced<br>
806 * AC_DEVOICE (4) - a user is being devoiced<br>
807 * AC_HALFOP (5) - a user is being halfopped<br>
808 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
809 * AC_INVITE (7) - a user is being invited<br>
810 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
811 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
812 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
813 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
814 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
815 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
816 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
817 * @param source The source of the access check
818 * @param dest The destination of the access check
819 * @param channel The channel which is being checked
820 * @param access_type See above
822 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
824 /** Called when a 005 numeric is about to be output.
825 * The module should modify the 005 numeric if needed to indicate its features.
826 * @param output The 005 string to be modified if neccessary.
828 virtual void On005Numeric(std::string &output);
830 /** Called when a client is disconnected by KILL.
831 * If a client is killed by a server, e.g. a nickname collision or protocol error,
833 * Return 1 from this function to prevent the kill, and 0 from this function to allow
834 * it as normal. If you prevent the kill no output will be sent to the client, it is
835 * down to your module to generate this information.
836 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
837 * If you do so youre risking race conditions, desyncs and worse!
838 * @param source The user sending the KILL
839 * @param dest The user being killed
840 * @param reason The kill reason
841 * @return 1 to prevent the kill, 0 to allow
843 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
845 /** Called when an oper wants to disconnect a remote user via KILL
846 * @param source The user sending the KILL
847 * @param dest The user being killed
848 * @param reason The kill reason
850 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
852 /** Called whenever a module is loaded.
853 * mod will contain a pointer to the module, and string will contain its name,
854 * for example m_widgets.so. This function is primary for dependency checking,
855 * your module may decide to enable some extra features if it sees that you have
856 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
857 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
858 * but instead operate under reduced functionality, unless the dependency is
859 * absolutely neccessary (e.g. a module that extends the features of another
861 * @param mod A pointer to the new module
862 * @param name The new module's filename
864 virtual void OnLoadModule(Module* mod,std::string name);
866 /** Called whenever a module is unloaded.
867 * mod will contain a pointer to the module, and string will contain its name,
868 * for example m_widgets.so. This function is primary for dependency checking,
869 * your module may decide to enable some extra features if it sees that you have
870 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
871 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
872 * but instead operate under reduced functionality, unless the dependency is
873 * absolutely neccessary (e.g. a module that extends the features of another
875 * @param mod Pointer to the module being unloaded (still valid)
876 * @param name The filename of the module being unloaded
878 virtual void OnUnloadModule(Module* mod,std::string name);
880 /** Called once every five seconds for background processing.
881 * This timer can be used to control timed features. Its period is not accurate
882 * enough to be used as a clock, but it is gauranteed to be called at least once in
883 * any five second period, directly from the main loop of the server.
884 * @param curtime The current timer derived from time(2)
886 virtual void OnBackgroundTimer(time_t curtime);
888 /** Called whenever a list is needed for a listmode.
889 * For example, when a /MODE #channel +b (without any other parameters) is called,
890 * if a module was handling +b this function would be called. The function can then
891 * output any lists it wishes to. Please note that all modules will see all mode
892 * characters to provide the ability to extend each other, so please only output
893 * a list if the mode character given matches the one(s) you want to handle.
894 * @param user The user requesting the list
895 * @param channel The channel the list is for
896 * @param mode The listmode which a list is being requested on
898 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
900 /** Called whenever any command is about to be executed.
901 * This event occurs for all registered commands, wether they are registered in the core,
902 * or another module, but it will not occur for invalid commands (e.g. ones which do not
903 * exist within the command table). By returning 1 from this method you may prevent the
904 * command being executed. If you do this, no output is created by the core, and it is
905 * down to your module to produce any output neccessary.
906 * Note that unless you return 1, you should not destroy any structures (e.g. by using
907 * Server::QuitUser) otherwise when the command's handler function executes after your
908 * method returns, it will be passed an invalid pointer to the user object and crash!)
909 * @param command The command being executed
910 * @param parameters An array of array of characters containing the parameters for the command
911 * @param pcnt The nuimber of parameters passed to the command
912 * @param user the user issuing the command
913 * @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.
914 * @return 1 to block the command, 0 to allow
916 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user, bool validated);
918 /** Called to check if a user who is connecting can now be allowed to register
919 * If any modules return false for this function, the user is held in the waiting
920 * state until all modules return true. For example a module which implements ident
921 * lookups will continue to return false for a user until their ident lookup is completed.
922 * Note that the registration timeout for a user overrides these checks, if the registration
923 * timeout is reached, the user is disconnected even if modules report that the user is
924 * not ready to connect.
925 * @param user The user to check
926 * @return true to indicate readiness, false if otherwise
928 virtual bool OnCheckReady(userrec* user);
930 /** Called whenever a user is about to register their connection (e.g. before the user
931 * is sent the MOTD etc). Modules can use this method if they are performing a function
932 * which must be done before the actual connection is completed (e.g. ident lookups,
933 * dnsbl lookups, etc).
934 * Note that you should NOT delete the user record here by causing a disconnection!
935 * Use OnUserConnect for that instead.
936 * @param user The user registering
938 virtual void OnUserRegister(userrec* user);
940 /** Called whenever a mode character is processed.
941 * Return 1 from this function to block the mode character from being processed entirely,
942 * so that you may perform your own code instead. Note that this method allows you to override
943 * modes defined by other modes, but this is NOT RECOMMENDED!
944 * @param user The user who is sending the mode
945 * @param chan The channel the mode is being sent to
946 * @param mode The mode character being set
947 * @param param The parameter for the mode or an empty string
948 * @param adding true of the mode is being added, false if it is being removed
949 * @param pcnt The parameter count for the mode (0 or 1)
950 * @return 1 to deny the mode, 0 to allow
952 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
954 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
955 * This method will always be called for each join, wether or not the channel is actually +i, and
956 * determines the outcome of an if statement around the whole section of invite checking code.
957 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
958 * @param user The user joining the channel
959 * @param chan The channel being joined
960 * @return 1 to explicitly allow the join, 0 to proceed as normal
962 virtual int OnCheckInvite(userrec* user, chanrec* chan);
964 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
965 * This method will always be called for each join, wether or not the channel is actually +k, and
966 * determines the outcome of an if statement around the whole section of key checking code.
967 * if the user specified no key, the keygiven string will be a valid but empty value.
968 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
969 * @param user The user joining the channel
970 * @param chan The channel being joined
971 * @return 1 to explicitly allow the join, 0 to proceed as normal
973 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
975 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
976 * This method will always be called for each join, wether or not the channel is actually +l, and
977 * determines the outcome of an if statement around the whole section of channel limit checking code.
978 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
979 * @param user The user joining the channel
980 * @param chan The channel being joined
981 * @return 1 to explicitly allow the join, 0 to proceed as normal
983 virtual int OnCheckLimit(userrec* user, chanrec* chan);
985 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
986 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
987 * determines the outcome of an if statement around the whole section of ban checking code.
988 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
989 * @param user The user joining the channel
990 * @param chan The channel being joined
991 * @return 1 to explicitly allow the join, 0 to proceed as normal
993 virtual int OnCheckBan(userrec* user, chanrec* chan);
995 /** Called on all /STATS commands
996 * This method is triggered for all /STATS use, including stats symbols handled by the core.
997 * @param symbol the symbol provided to /STATS
998 * @user the user issuing the /STATS command
999 * @return 1 to block the /STATS from being processed by the core, 0 to allow it
1001 virtual int OnStats(char symbol, userrec* user);
1003 /** Called whenever a change of a local users displayed host is attempted.
1004 * Return 1 to deny the host change, or 0 to allow it.
1005 * @param user The user whos host will be changed
1006 * @param newhost The new hostname
1007 * @return 1 to deny the host change, 0 to allow
1009 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
1011 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
1012 * return 1 to deny the name change, or 0 to allow it.
1013 * @param user The user whos GECOS will be changed
1014 * @param newhost The new GECOS
1015 * @return 1 to deny the GECOS change, 0 to allow
1017 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
1019 /** Called whenever a topic is changed by a local user.
1020 * Return 1 to deny the topic change, or 0 to allow it.
1021 * @param user The user changing the topic
1022 * @param chan The channels who's topic is being changed
1023 * @param topic The actual topic text
1024 * @param 1 to block the topic change, 0 to allow
1026 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1028 /** Called whenever a local topic has been changed.
1029 * To block topic changes you must use OnLocalTopicChange instead.
1030 * @param user The user changing the topic
1031 * @param chan The channels who's topic is being changed
1032 * @param topic The actual topic text
1034 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1036 /** Called whenever an Event class is sent to all module by another module.
1037 * Please see the documentation of Event::Send() for further information. The Event sent can
1038 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1039 * before doing anything to the event data, and you should *not* change the event data in any way!
1040 * @param event The Event class being received
1042 virtual void OnEvent(Event* event);
1044 /** Called whenever a Request class is sent to your module by another module.
1045 * Please see the documentation of Request::Send() for further information. The Request sent
1046 * can always be assumed to be non-NULL, you should not change the request object or its data.
1047 * Your method may return arbitary data in the char* result which the requesting module
1048 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1049 * @param request The Request class being received
1051 virtual char* OnRequest(Request* request);
1053 /** Called whenever an oper password is to be compared to what a user has input.
1054 * The password field (from the config file) is in 'password' and is to be compared against
1055 * 'input'. This method allows for encryption of oper passwords and much more besides.
1056 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1058 * @param password The oper's password
1059 * @param input The password entered
1060 * @return 1 to match the passwords, 0 to do nothing
1062 virtual int OnOperCompare(std::string password, std::string input);
1064 /** Called whenever a user is given usermode +o, anywhere on the network.
1065 * You cannot override this and prevent it from happening as it is already happened and
1066 * such a task must be performed by another server. You can however bounce modes by sending
1067 * servermodes out to reverse mode changes.
1068 * @param user The user who is opering
1070 virtual void OnGlobalOper(userrec* user);
1072 /** Called whenever a user connects, anywhere on the network.
1073 * This event is informational only. You should not change any user information in this
1074 * event. To do so, use the OnUserConnect method to change the state of local users.
1075 * @param user The user who is connecting
1077 virtual void OnGlobalConnect(userrec* user);
1079 /** Called whenever a ban is added to a channel's list.
1080 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1081 * @param source The user adding the ban
1082 * @param channel The channel the ban is being added to
1083 * @param banmask The ban mask being added
1084 * @return 1 to block the ban, 0 to continue as normal
1086 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1088 /** Called whenever a ban is removed from a channel's list.
1089 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1090 * @param source The user deleting the ban
1091 * @param channel The channel the ban is being deleted from
1092 * @param banmask The ban mask being deleted
1093 * @return 1 to block the unban, 0 to continue as normal
1095 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1097 /** Called immediately after any connection is accepted. This is intended for raw socket
1098 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1099 * no information relating to a user record as the connection has not been assigned yet.
1100 * There are no return values from this call as all modules get an opportunity if required to
1101 * process the connection.
1102 * @param fd The file descriptor returned from accept()
1103 * @param ip The IP address of the connecting user
1104 * @param localport The local port number the user connected to
1106 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1108 /** Called immediately before any write() operation on a user's socket in the core. Because
1109 * this event is a low level event no user information is associated with it. It is intended
1110 * for use by modules which may wrap connections within another API such as SSL for example.
1111 * return a non-zero result if you have handled the write operation, in which case the core
1112 * will not call write().
1113 * @param fd The file descriptor of the socket
1114 * @param buffer A char* buffer being written
1115 * @param Number of characters to write
1116 * @return Number of characters actually written or 0 if you didn't handle the operation
1118 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1120 /** Called immediately before any socket is closed. When this event is called, shutdown()
1121 * has not yet been called on the socket.
1122 * @param fd The file descriptor of the socket prior to close()
1124 virtual void OnRawSocketClose(int fd);
1126 /** Called immediately before any read() operation on a client socket in the core.
1127 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1128 * when this event occurs.
1129 * Your event should return 1 if it has handled the reading itself, which prevents the core
1130 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1131 * the value of count. The value of readresult must be identical to an actual result that might
1132 * be returned from the read() system call, for example, number of bytes read upon success,
1133 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1134 * you MUST set readresult.
1135 * @param fd The file descriptor of the socket
1136 * @param buffer A char* buffer being read to
1137 * @param count The size of the buffer
1138 * @param readresult The amount of characters read, or 0
1139 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1141 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1145 /** Allows server output and query functions
1146 * This class contains methods which allow a module to query the state of the irc server, and produce
1147 * output to users and other servers. All modules should instantiate at least one copy of this class,
1148 * and use its member functions to perform their tasks.
1150 class Server : public classbase
1153 /** Default constructor.
1154 * Creates a Server object.
1157 /** Default destructor.
1158 * Destroys a Server object.
1161 /** Obtains a pointer to the server's ServerConfig object.
1162 * The ServerConfig object contains most of the configuration data
1163 * of the IRC server, as read from the config file by the core.
1165 ServerConfig* GetConfig();
1167 /** For use with Module::Prioritize().
1168 * When the return value of this function is returned from
1169 * Module::Prioritize(), this specifies that the module wishes
1170 * to be ordered exactly BEFORE 'modulename'.
1171 * @param modulename The module your module wants to be before in the call list
1172 * @returns a priority ID which the core uses to relocate the module in the list
1174 long PriorityBefore(std::string modulename);
1176 /** For use with Module::Prioritize().
1177 * When the return value of this function is returned from
1178 * Module::Prioritize(), this specifies that the module wishes
1179 * to be ordered exactly AFTER 'modulename'.
1180 * @param modulename The module your module wants to be after in the call list
1181 * @returns a priority ID which the core uses to relocate the module in the list
1183 long PriorityAfter(std::string modulename);
1185 /** Sends text to all opers.
1186 * This method sends a server notice to all opers with the usermode +s.
1188 virtual void SendOpers(std::string s);
1189 /** Returns the version string of this server
1191 std::string GetVersion();
1192 /** Writes a log string.
1193 * This method writes a line of text to the log. If the level given is lower than the
1194 * level given in the configuration, this command has no effect.
1196 virtual void Log(int level, std::string s);
1197 /** Sends a line of text down a TCP/IP socket.
1198 * This method writes a line of text to an established socket, cutting it to 510 characters
1199 * plus a carriage return and linefeed if required.
1201 virtual void Send(int Socket, std::string s);
1202 /** Sends text from the server to a socket.
1203 * This method writes a line of text to an established socket, with the servername prepended
1204 * as used by numerics (see RFC 1459)
1206 virtual void SendServ(int Socket, std::string s);
1207 /** Writes text to a channel, but from a server, including all.
1208 * This can be used to send server notices to a group of users.
1210 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1211 /** Sends text from a user to a socket.
1212 * This method writes a line of text to an established socket, with the given user's nick/ident
1213 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1215 virtual void SendFrom(int Socket, userrec* User, std::string s);
1216 /** Sends text from a user to another user.
1217 * This method writes a line of text to a user, with a user's nick/ident
1218 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1219 * If you specify NULL as the source, then the data will originate from the
1220 * local server, e.g. instead of:
1222 * :user!ident@host TEXT
1224 * The format will become:
1228 * Which is useful for numerics and server notices to single users, etc.
1230 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1231 /** Sends text from a user to a channel (mulicast).
1232 * This method writes a line of text to a channel, with the given user's nick/ident
1233 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1234 * IncludeSender flag is set, then the text is also sent back to the user from which
1235 * it originated, as seen in MODE (see RFC 1459).
1237 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1238 /** Returns true if two users share a common channel.
1239 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1242 virtual bool CommonChannels(userrec* u1, userrec* u2);
1243 /** Sends text from a user to one or more channels (mulicast).
1244 * This method writes a line of text to all users which share a common channel with a given
1245 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1246 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1247 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1248 * is only sent to the other recipients, as seen in QUIT.
1250 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1251 /** Sends a WALLOPS message.
1252 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1255 virtual void SendWallops(userrec* User, std::string text);
1257 /** Returns true if a nick is valid.
1258 * Nicks for unregistered connections will return false.
1260 virtual bool IsNick(std::string nick);
1261 /** Returns a count of the number of users on a channel.
1262 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1264 virtual int CountUsers(chanrec* c);
1265 /** Attempts to look up a nick and return a pointer to it.
1266 * This function will return NULL if the nick does not exist.
1268 virtual userrec* FindNick(std::string nick);
1269 /** Attempts to look up a nick using the file descriptor associated with that nick.
1270 * This function will return NULL if the file descriptor is not associated with a valid user.
1272 virtual userrec* FindDescriptor(int socket);
1273 /** Attempts to look up a channel and return a pointer to it.
1274 * This function will return NULL if the channel does not exist.
1276 virtual chanrec* FindChannel(std::string channel);
1277 /** Attempts to look up a user's privilages on a channel.
1278 * This function will return a string containing either @, %, +, or an empty string,
1279 * representing the user's privilages upon the channel you specify.
1281 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1282 /** Checks if a user is on a channel.
1283 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1285 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1286 /** Returns the server name of the server where the module is loaded.
1288 virtual std::string GetServerName();
1289 /** Returns the network name, global to all linked servers.
1291 virtual std::string GetNetworkName();
1292 /** Returns the server description string of the local server
1294 virtual std::string GetServerDescription();
1295 /** Returns the information of the server as returned by the /ADMIN command.
1296 * See the Admin class for further information of the return value. The members
1297 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1298 * server where the module is loaded.
1300 virtual Admin GetAdmin();
1301 /** Adds an extended mode letter which is parsed by a module.
1302 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1303 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1304 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1305 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1306 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1307 * params_when_on is the number of modes to expect when the mode is turned on
1308 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1309 * the params_when_off value has a similar value to params_when_on, except it indicates
1310 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1311 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1312 * use this parameter. The function returns false if the mode is unavailable, and will not
1313 * attempt to allocate another character, as this will confuse users. This also means that
1314 * as only one module can claim a specific mode character, the core does not need to keep track
1315 * of which modules own which modes, which speeds up operation of the server. In this version,
1316 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1319 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1321 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1322 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1325 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1327 * (2) They always take exactly one parameter when being added or removed
1329 * (3) They can be set multiple times, usually on users in channels
1331 * (4) The mode and its parameter are NOT stored in the channels modes structure
1333 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1334 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1335 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1336 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1337 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1338 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1339 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1340 * so the above example would become '+aa one three' after processing.
1342 virtual bool AddExtendedListMode(char modechar);
1344 /** Adds a command to the command table.
1345 * This allows modules to add extra commands into the command table. You must place a function within your
1346 * module which is is of type handlerfunc:
1348 * typedef void (handlerfunc) (char**, int, userrec*);
1350 * void handle_kill(char **parameters, int pcnt, userrec *user)
1352 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1353 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1354 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1355 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1356 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1357 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1358 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1361 virtual void AddCommand(command_t *f);
1363 /** Sends a servermode.
1364 * you must format the parameters array with the target, modes and parameters for those modes.
1370 * modes[0] = ChannelName;
1374 * modes[2] = user->nick;
1376 * Srv->SendMode(modes,3,user);
1378 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1379 * will be sent to the user you provide as the third parameter.
1380 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1381 * your server in an unstable state!
1384 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1386 /** Sends to all users matching a mode mask
1387 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1388 * or module provided modes, including ones provided by your own module.
1389 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1390 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1391 * for example, if you were to use:
1393 * Serv->SendToModeMask("xi", WM_OR, "m00");
1395 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1396 * user must have both modes set to receive the message.
1398 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1400 /** Forces a user to join a channel.
1401 * This is similar to svsjoin and can be used to implement redirection, etc.
1402 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1403 * On failure, the result is NULL.
1405 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1407 /** Forces a user to part a channel.
1408 * This is similar to svspart and can be used to implement redirection, etc.
1409 * Although the return value of this function is a pointer to a channel record, the returned data is
1410 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1412 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1414 /** Forces a user nickchange.
1415 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1416 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1417 * the error numeric for it.
1419 virtual void ChangeUserNick(userrec* user, std::string nickname);
1421 /** Forces a user to quit with the specified reason.
1422 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1423 * may bypass the quit prefix specified in the config file.
1427 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1428 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1429 * action after calling this method is to immediately bail from your handler.
1431 virtual void QuitUser(userrec* user, std::string reason);
1433 virtual void KickUser(userrec* source, userrec* target, chanrec* chan, std::string reason);
1435 /** Matches text against a glob pattern.
1436 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1437 * Returns true if the literal successfully matches the pattern, false if otherwise.
1439 virtual bool MatchText(std::string sliteral, std::string spattern);
1441 /** Calls the handler for a command, either implemented by the core or by another module.
1442 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1443 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1444 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1445 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1446 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1447 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1448 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1449 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1450 * used for privilage checks, etc.
1452 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1454 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1456 /** Change displayed hostname of a user.
1457 * You should always call this method to change a user's host rather than writing directly to the
1458 * dhost member of userrec, as any change applied via this method will be propogated to any
1461 virtual void ChangeHost(userrec* user, std::string host);
1463 /** Change GECOS (fullname) of a user.
1464 * You should always call this method to change a user's GECOS rather than writing directly to the
1465 * fullname member of userrec, as any change applied via this method will be propogated to any
1468 virtual void ChangeGECOS(userrec* user, std::string gecos);
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. Ulined server
1474 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
1475 * case of normal servers, as many ulined server types (such as services) do not support meshed
1476 * links and must operate in this manner.
1478 virtual bool IsUlined(std::string server);
1480 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1481 * chanrec due to include constraints.
1483 virtual chanuserlist GetUsers(chanrec* chan);
1485 /** Remove a user's connection to the irc server, but leave their client in existence in the
1486 * user hash. When you call this function, the user's file descriptor will be replaced with the
1487 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1488 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1489 * After this call, the pointer to user will be invalid.
1491 virtual bool UserToPseudo(userrec* user,std::string message);
1493 /** This user takes one user, and switches their file descriptor with another user, so that one user
1494 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1495 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1496 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1497 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1499 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1502 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1503 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1504 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1505 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1508 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1511 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1512 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1513 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1514 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1517 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1520 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1521 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1522 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1523 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1526 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1529 * The K-line is enforced as soon as it is added.
1530 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1531 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1532 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1535 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1538 * The E-line is enforced as soon as it is added.
1539 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1540 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1541 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1544 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1546 /** Deletes a G-Line from all servers on the mesh
1548 virtual bool DelGLine(std::string hostmask);
1550 /** Deletes a Q-Line from all servers on the mesh
1552 virtual bool DelQLine(std::string nickname);
1554 /** Deletes a Z-Line from all servers on the mesh
1556 virtual bool DelZLine(std::string ipaddr);
1558 /** Deletes a local K-Line
1560 virtual bool DelKLine(std::string hostmask);
1562 /** Deletes a local E-Line
1564 virtual bool DelELine(std::string hostmask);
1566 /** Calculates a duration
1567 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1568 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1571 virtual long CalcDuration(std::string duration);
1573 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1575 virtual bool IsValidMask(std::string mask);
1577 /** This function finds a module by name.
1578 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1579 * the function will return NULL.
1581 virtual Module* FindModule(std::string name);
1583 /** Adds a class derived from InspSocket to the server's socket engine.
1585 virtual void AddSocket(InspSocket* sock);
1587 /** Forcibly removes a class derived from InspSocket from the servers socket engine.
1589 virtual void RemoveSocket(InspSocket* sock);
1591 /** Deletes a class derived from InspSocket from the server's socket engine.
1593 virtual void DelSocket(InspSocket* sock);
1595 virtual void RehashServer();
1599 #define CONF_NOT_A_NUMBER 0x000010
1600 #define CONF_NOT_UNSIGNED 0x000080
1601 #define CONF_VALUE_NOT_FOUND 0x000100
1602 #define CONF_FILE_NOT_FOUND 0x000200
1605 /** Allows reading of values from configuration files
1606 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1607 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1608 * Constructing the class using one parameter allows you to specify a path to your own configuration
1609 * file, otherwise, inspircd.conf is read.
1611 class ConfigReader : public classbase
1614 /** The contents of the configuration file
1615 * This protected member should never be accessed by a module (and cannot be accessed unless the
1616 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1617 * (such as comments) stripped from it.
1619 std::stringstream *cache;
1620 std::stringstream *errorlog;
1621 /** Used to store errors
1627 /** Default constructor.
1628 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1629 * as specified when running ./configure.
1631 ConfigReader(); // default constructor reads ircd.conf
1632 /** Overloaded constructor.
1633 * This constructor initialises the ConfigReader class to read a user-specified config file
1635 ConfigReader(std::string filename); // read a module-specific config
1636 /** Default destructor.
1637 * This method destroys the ConfigReader class.
1640 /** Retrieves a value from the config file.
1641 * This method retrieves a value from the config file. Where multiple copies of the tag
1642 * exist in the config file, index indicates which of the values to retrieve.
1644 std::string ReadValue(std::string tag, std::string name, int index);
1645 /** Retrieves a boolean value from the config file.
1646 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1647 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1648 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1650 bool ReadFlag(std::string tag, std::string name, int index);
1651 /** Retrieves an integer value from the config file.
1652 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1653 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1654 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1655 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1656 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1657 * will return CONF_NOT_UNSIGNED
1659 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1660 /** Returns the last error to occur.
1661 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1662 * A call to GetError() resets the error flag back to 0.
1665 /** Counts the number of times a given tag appears in the config file.
1666 * This method counts the number of times a tag appears in a config file, for use where
1667 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1668 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1669 * multiple instance tag.
1671 int Enumerate(std::string tag);
1672 /** Returns true if a config file is valid.
1673 * This method is partially implemented and will only return false if the config
1674 * file does not exist or could not be opened.
1677 /** Dumps the list of errors in a config file to an output location. If bail is true,
1678 * then the program will abort. If bail is false and user points to a valid user
1679 * record, the error report will be spooled to the given user by means of NOTICE.
1680 * if bool is false AND user is false, the error report will be spooled to all opers
1681 * by means of a NOTICE to all opers.
1683 void DumpErrors(bool bail,userrec* user);
1685 /** Returns the number of items within a tag.
1686 * For example if the tag was <test tag="blah" data="foo"> then this
1687 * function would return 2. Spaces and newlines both qualify as valid seperators
1690 int EnumerateValues(std::string tag, int index);
1695 /** Caches a text file into memory and can be used to retrieve lines from it.
1696 * This class contains methods for read-only manipulation of a text file in memory.
1697 * Either use the constructor type with one parameter to load a file into memory
1698 * at construction, or use the LoadFile method to load a file.
1700 class FileReader : public classbase
1704 /** Default constructor.
1705 * This method does not load any file into memory, you must use the LoadFile method
1706 * after constructing the class this way.
1710 /** Secondary constructor.
1711 * This method initialises the class with a file loaded into it ready for GetLine and
1712 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1715 FileReader(std::string filename);
1717 /** Default destructor.
1718 * This deletes the memory allocated to the file.
1722 /** Used to load a file.
1723 * This method loads a file into the class ready for GetLine and
1724 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1727 void LoadFile(std::string filename);
1729 /** Returns true if the file exists
1730 * This function will return false if the file could not be opened.
1734 /** Retrieve one line from the file.
1735 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1736 * the index was out of bounds, or the line had no data on it.
1738 std::string GetLine(int x);
1740 /** Returns the size of the file in lines.
1741 * This method returns the number of lines in the read file. If it is 0, no lines have been
1742 * read into memory, either because the file is empty or it does not exist, or cannot be
1743 * opened due to permission problems.
1749 /** Instantiates classes inherited from Module
1750 * This class creates a class inherited from type Module, using new. This is to allow for modules
1751 * to create many different variants of Module, dependent on architecture, configuration, etc.
1752 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1755 class ModuleFactory : public classbase
1759 virtual ~ModuleFactory() { }
1760 /** Creates a new module.
1761 * Your inherited class of ModuleFactory must return a pointer to your Module class
1762 * using this method.
1764 virtual Module * CreateModule(Server* Me) = 0;
1768 typedef DLLFactory<ModuleFactory> ircd_module;
1770 bool ModeDefined(char c, int i);
1771 bool ModeDefinedOper(char c, int i);
1772 int ModeDefinedOn(char c, int i);
1773 int ModeDefinedOff(char c, int i);
1774 void ModeMakeList(char modechar);
1775 bool ModeIsListMode(char modechar, int type);