1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 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 * ---------------------------------------------------
29 /** Used with OnExtendedMode() method of modules
35 /** Used with OnAccessCheck() method of modules
37 #define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded)
38 #define ACR_DENY 1 // deny the action
39 #define ACR_ALLOW 2 // allow the action
40 #define AC_KICK 0 // a user is being kicked
41 #define AC_DEOP 1 // a user is being deopped
42 #define AC_OP 2 // a user is being opped
43 #define AC_VOICE 3 // a user is being voiced
44 #define AC_DEVOICE 4 // a user is being devoiced
45 #define AC_HALFOP 5 // a user is being halfopped
46 #define AC_DEHALFOP 6 // a user is being dehalfopped
47 #define AC_INVITE 7 // a user is being invited
48 #define AC_GENERAL_MODE 8 // a user channel mode is being changed
50 /** Used to define a set of behavior bits for a module
52 #define VF_STATIC 1 // module is static, cannot be /unloadmodule'd
53 #define VF_VENDOR 2 // module is a vendor module (came in the original tarball, not 3rd party)
54 #define VF_SERVICEPROVIDER 4 // module provides a service to other modules (can be a dependency)
55 #define VF_COMMON 8 // module needs to be common on all servers in a mesh to link
67 /** Low level definition of a FileReader classes file cache area
69 typedef std::deque<std::string> file_cache;
70 typedef file_cache string_list;
72 /** Holds a list of users in a channel
74 typedef std::deque<userrec*> chanuserlist;
77 // This #define allows us to call a method in all
78 // loaded modules in a readable simple way, e.g.:
79 // 'FOREACH_MOD OnConnect(user);'
81 #define FOREACH_MOD for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]->
83 // This define is similar to the one above but returns a result in MOD_RESULT.
84 // The first module to return a nonzero result is the value to be accepted,
85 // and any modules after are ignored.
87 // *********************************************************************************************
89 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
90 for (int _i = 0; _i <= MODCOUNT; _i++) { \
91 int res = modules[_i]->x ; \
99 // *********************************************************************************************
101 #define FD_MAGIC_NUMBER -42
103 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
104 extern void server_mode(char **parameters, int pcnt, userrec *user);
106 // class Version holds the version information of a Module, returned
107 // by Module::GetVersion (thanks RD)
109 /** Holds a module's Version information
110 * The four members (set by the constructor only) indicate details as to the version number
111 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
113 class Version : public classbase
116 const int Major, Minor, Revision, Build, Flags;
117 Version(int major, int minor, int revision, int build, int flags);
120 /** Holds /ADMIN data
121 * This class contains the admin details of the local server. It is constructed by class Server,
122 * and has three read-only values, Name, Email and Nick that contain the specified values for the
123 * server where the module is running.
125 class Admin : public classbase
128 const std::string Name, Email, Nick;
129 Admin(std::string name, std::string email, std::string nick);
133 // Forward-delacare module for ModuleMessage etc
136 // Thanks to Rob (from anope) for the idea of this message passing API
137 // (its been done before, but this seemed a very neat and tidy way...
139 /** The ModuleMessage class is the base class of Request and Event
140 * This class is used to represent a basic data structure which is passed
141 * between modules for safe inter-module communications.
143 class ModuleMessage : public classbase
146 /** This class is pure virtual and must be inherited.
148 virtual char* Send() = 0;
149 virtual ~ModuleMessage() {};
152 /** The Request class is a unicast message directed at a given module.
153 * When this class is properly instantiated it may be sent to a module
154 * using the Send() method, which will call the given module's OnRequest
155 * method with this class as its parameter.
157 class Request : public ModuleMessage
160 /** This member holds a pointer to arbitary data set by the emitter of the message
163 /** This is a pointer to the sender of the message, which can be used to
164 * directly trigger events, or to create a reply.
167 /** The single destination of the Request
171 /** Create a new Request
173 Request(char* anydata, Module* src, Module* dst);
174 /** Fetch the Request data
177 /** Fetch the request source
180 /** Fetch the request destination (should be 'this' in the receiving module)
183 /** Send the Request.
184 * Upon returning the result will be arbitary data returned by the module you
185 * sent the request to. It is up to your module to know what this data is and
186 * how to deal with it.
192 /** The Event class is a unicast message directed at all modules.
193 * When the class is properly instantiated it may be sent to all modules
194 * using the Send() method, which will trigger the OnEvent method in
195 * all modules passing the object as its parameter.
197 class Event : public ModuleMessage
200 /** This member holds a pointer to arbitary data set by the emitter of the message
203 /** This is a pointer to the sender of the message, which can be used to
204 * directly trigger events, or to create a reply.
207 /** The event identifier.
208 * This is arbitary text which should be used to distinguish
209 * one type of event from another.
213 /** Create a new Event
215 Event(char* anydata, Module* src, std::string eventid);
216 /** Get the Event data
219 /** Get the event Source
222 /** Get the event ID.
223 * Use this to determine the event type for safe casting of the data
225 std::string GetEventID();
227 * The return result of an Event::Send() will always be NULL as
228 * no replies are expected.
233 /** Holds an extended mode's details.
234 * Used internally by modules.cpp
236 class ExtMode : public classbase
245 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) { };
249 /** Base class for all InspIRCd modules
250 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
251 * its methods will be called when irc server events occur. class inherited from module must be
252 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
254 class Module : public classbase
258 /** Default constructor
259 * Creates a module class.
260 * @param Me An instance of the Server class which can be saved for future use
264 /** Default destructor
265 * destroys a module class
269 /** Returns the version number of a Module.
270 * The method should return a Version object with its version information assigned via
273 virtual Version GetVersion();
275 /** Called when a user connects.
276 * The details of the connecting user are available to you in the parameter userrec *user
277 * @param user The user who is connecting
279 virtual void OnUserConnect(userrec* user);
281 /** Called when a user quits.
282 * The details of the exiting user are available to you in the parameter userrec *user
283 * This event is only called when the user is fully registered when they quit. To catch
284 * raw disconnections, use the OnUserDisconnect method.
285 * @param user The user who is quitting
286 * @param message The user's quit message
288 virtual void OnUserQuit(userrec* user, std::string message);
290 /** Called whenever a user's socket is closed.
291 * The details of the exiting user are available to you in the parameter userrec *user
292 * This event is called for all users, registered or not, as a cleanup method for modules
293 * which might assign resources to user, such as dns lookups, objects and sockets.
294 * @param user The user who is disconnecting
296 virtual void OnUserDisconnect(userrec* user);
298 /** Called when a user joins a channel.
299 * The details of the joining user are available to you in the parameter userrec *user,
300 * and the details of the channel they have joined is available in the variable chanrec *channel
301 * @param user The user who is joining
302 * @param channel The channel being joined
304 virtual void OnUserJoin(userrec* user, chanrec* channel);
306 /** Called when a user parts a channel.
307 * The details of the leaving user are available to you in the parameter userrec *user,
308 * and the details of the channel they have left is available in the variable chanrec *channel
309 * @param user The user who is parting
310 * @param channel The channel being parted
312 virtual void OnUserPart(userrec* user, chanrec* channel);
314 /** Called on rehash.
315 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
316 * system. You should use it to reload any files so that your module keeps in step with the
317 * rest of the application. If a parameter is given, the core has done nothing. The module
318 * receiving the event can decide if this parameter has any relevence to it.
319 * @param parameter The (optional) parameter given to REHASH from the user.
321 virtual void OnRehash(std::string parameter);
323 /** Called when a raw command is transmitted or received.
324 * This method is the lowest level of handler available to a module. It will be called with raw
325 * data which is passing through a connected socket. If you wish, you may munge this data by changing
326 * the string parameter "raw". If you do this, after your function exits it will immediately be
327 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
328 * inbound is set to true) the value of user will be the userrec of the connection sending the
329 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
330 * @param raw The raw string in RFC1459 format
331 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
332 * @param user The user record sending the text, when inbound == true.
334 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
336 /** Called whenever an extended mode is to be processed.
337 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
338 * changed. mode_on is set when the mode is being set, in which case params contains a list of
339 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
340 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
341 * was set up with Server::AddExtendedMode
342 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
343 * You must cast this value yourself to make use of it.
344 * @param user The user issuing the mode
345 * @param target The user or channel having the mode set on them
346 * @param modechar The mode character being set
347 * @param type The type of mode (user or channel) being set
348 * @param mode_on True if the mode is being set, false if it is being unset
349 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
351 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
353 /** Called whenever a user is about to join a channel, before any processing is done.
354 * Returning a value of 1 from this function stops the process immediately, causing no
355 * output to be sent to the user by the core. If you do this you must produce your own numerics,
356 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
357 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
361 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
362 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
363 * processing on the actual channel record at this point, however the channel NAME will still be passed in
364 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
365 * @param user The user joining the channel
366 * @param cname The channel name being joined
367 * @return 1 To prevent the join, 0 to allow it.
369 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
371 /** Called whenever a user is about to be kicked.
372 * Returning a value of 1 from this function stops the process immediately, causing no
373 * output to be sent to the user by the core. If you do this you must produce your own numerics,
375 * @param source The user issuing the kick
376 * @param user The user being kicked
377 * @param chan The channel the user is being kicked from
378 * @param reason The kick reason
379 * @return 1 to prevent the kick, 0 to allow it
381 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
383 /** Called whenever a user is kicked.
384 * If this method is called, the kick is already underway and cannot be prevented, so
385 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
386 * @param source The user issuing the kick
387 * @param user The user being kicked
388 * @param chan The channel the user is being kicked from
389 * @param reason The kick reason
391 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
393 /** Called whenever a user opers locally.
394 * The userrec will contain the oper mode 'o' as this function is called after any modifications
395 * are made to the user's structure by the core.
396 * @param user The user who is opering up
397 * @param opertype The opers type name
399 virtual void OnOper(userrec* user, std::string opertype);
401 /** Called whenever a user types /INFO.
402 * The userrec will contain the information of the user who typed the command. Modules may use this
403 * method to output their own credits in /INFO (which is the ircd's version of an about box).
404 * It is purposefully not possible to modify any info that has already been output, or halt the list.
405 * You must write a 371 numeric to the user, containing your info in the following format:
407 * <nick> :information here
409 * @param user The user issuing /INFO
411 virtual void OnInfo(userrec* user);
413 /** Called whenever a /WHOIS is performed on a local user.
414 * The source parameter contains the details of the user who issued the WHOIS command, and
415 * the dest parameter contains the information of the user they are whoising.
416 * @param source The user issuing the WHOIS command
417 * @param dest The user who is being WHOISed
419 virtual void OnWhois(userrec* source, userrec* dest);
421 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
422 * Returning 1 from this function stops the process immediately, causing no
423 * output to be sent to the user by the core. If you do this you must produce your own numerics,
424 * notices etc. This is useful for modules which may want to filter invites to channels.
425 * @param source The user who is issuing the INVITE
426 * @param dest The user being invited
427 * @param channel The channel the user is being invited to
428 * @return 1 to deny the invite, 0 to allow
430 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
432 /** Called after a user has been successfully invited to a channel.
433 * You cannot prevent the invite from occuring using this function, to do that,
434 * use OnUserPreInvite instead.
435 * @param source The user who is issuing the INVITE
436 * @param dest The user being invited
437 * @param channel The channel the user is being invited to
439 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
441 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
442 * Returning any nonzero value from this function stops the process immediately, causing no
443 * output to be sent to the user by the core. If you do this you must produce your own numerics,
444 * notices etc. This is useful for modules which may want to filter or redirect messages.
445 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
446 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
447 * of where the message is destined to be sent.
448 * @param user The user sending the message
449 * @param dest The target of the message (chanrec* or userrec*)
450 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
451 * @param text Changeable text being sent by the user
452 * @return 1 to deny the NOTICE, 0 to allow it
454 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
456 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
457 * Returning any nonzero value from this function stops the process immediately, causing no
458 * output to be sent to the user by the core. If you do this you must produce your own numerics,
459 * notices etc. This is useful for modules which may want to filter or redirect messages.
460 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
461 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
462 * of where the message is destined to be sent.
463 * You may alter the message text as you wish before relinquishing control to the next module
464 * in the chain, and if no other modules block the text this altered form of the text will be sent out
465 * to the user and possibly to other servers.
466 * @param user The user sending the message
467 * @param dest The target of the message (chanrec* or userrec*)
468 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
469 * @param text Changeable text being sent by the user
470 * @return 1 to deny the NOTICE, 0 to allow it
472 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
474 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
475 * Please note that although you can see remote nickchanges through this function, you should
476 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
477 * check user->server before taking any action (including returning nonzero from the method).
478 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
479 * module to generate some meaninful output.
480 * @param user The username changing their nick
481 * @param newnick Their new nickname
482 * @return 1 to deny the change, 0 to allow
484 virtual int OnUserPreNick(userrec* user, std::string newnick);
486 /** Called after any PRIVMSG sent from a user.
487 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
488 * if target_type is TYPE_CHANNEL.
489 * @param user The user sending the message
490 * @param dest The target of the message
491 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
492 * @param text the text being sent by the user
494 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
496 /** Called after any NOTICE sent from a user.
497 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
498 * if target_type is TYPE_CHANNEL.
499 * @param user The user sending the message
500 * @param dest The target of the message
501 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
502 * @param text the text being sent by the user
504 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
506 /** Called after every MODE command sent from a user
507 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
508 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
509 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
510 * @param user The user sending the MODEs
511 * @param dest The target of the modes (userrec* or chanrec*)
512 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
513 * @param text The actual modes and their parameters if any
515 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
517 /** Allows modules to alter or create server descriptions
518 * Whenever a module requires a server description, for example for display in
519 * WHOIS, this function is called in all modules. You may change or define the
520 * description given in std::string &description. If you do, this description
521 * will be shown in the WHOIS fields.
522 * @param servername The servername being searched for
523 * @param description Alterable server description for this server
525 virtual void OnGetServerDescription(std::string servername,std::string &description);
527 /** Allows modules to synchronize data which relates to users during a netburst.
528 * When this function is called, it will be called from the module which implements
529 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
530 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
531 * (see below). This function will be called for every user visible on your side
532 * of the burst, allowing you to for example set modes, etc. Do not use this call to
533 * synchronize data which you have stored using class Extensible -- There is a specialist
534 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
535 * @param user The user being syncronized
536 * @param proto A pointer to the module handling network protocol
537 * @param opaque An opaque pointer set by the protocol module, should not be modified!
539 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
541 /** Allows modules to synchronize data which relates to channels during a netburst.
542 * When this function is called, it will be called from the module which implements
543 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
544 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
545 * (see below). This function will be called for every user visible on your side
546 * of the burst, allowing you to for example set modes, etc. Do not use this call to
547 * synchronize data which you have stored using class Extensible -- There is a specialist
548 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
550 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
552 * @param chan The channel being syncronized
553 * @param proto A pointer to the module handling network protocol
554 * @param opaque An opaque pointer set by the protocol module, should not be modified!
556 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
558 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
559 * Whenever the linking module wants to send out data, but doesnt know what the data
560 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
561 * this method is called.You should use the ProtoSendMetaData function after you've
562 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
563 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
564 * @param chan The channel whos metadata is being syncronized
565 * @param proto A pointer to the module handling network protocol
566 * @param opaque An opaque pointer set by the protocol module, should not be modified!
567 * @param extname The extensions name which is being searched for
569 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
571 /* Allows modules to syncronize metadata related to users over the network during a netburst.
572 * Whenever the linking module wants to send out data, but doesnt know what the data
573 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
574 * this method is called. You should use the ProtoSendMetaData function after you've
575 * correctly decided how the data should be represented, to send the metadata on its way if
576 * if it belongs to your module.
577 * @param user The user whos metadata is being syncronized
578 * @param proto A pointer to the module handling network protocol
579 * @param opaque An opaque pointer set by the protocol module, should not be modified!
580 * @param extname The extensions name which is being searched for
582 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
584 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
585 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
586 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
587 * @param target The chanrec* or userrec* that data should be added to
588 * @param extname The extension name which is being sent
589 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
591 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
593 /** Implemented by modules which provide the ability to link servers.
594 * These modules will implement this method, which allows transparent sending of servermodes
595 * down the network link as a broadcast, without a module calling it having to know the format
596 * of the MODE command before the actual mode string.
598 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
599 * of how to use this function.
601 * @param opaque An opaque pointer set by the protocol module, should not be modified!
602 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
603 * @param target The chanrec* or userrec* that modes should be sent for
604 * @param modeline The modes and parameters to be sent
606 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
608 /** Implemented by modules which provide the ability to link servers.
609 * These modules will implement this method, which allows metadata (extra data added to
610 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
611 * to other servers on a netburst and decoded at the other end by the same module on a
614 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
615 * how to use this function.
616 * @param opaque An opaque pointer set by the protocol module, should not be modified!
617 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
618 * @param target The chanrec* or userrec* that metadata should be sent for
619 * @param extname The extension name to send metadata for
620 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
622 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
624 /** Called after every WALLOPS command.
625 * @param user The user sending the WALLOPS
626 * @param text The content of the WALLOPS message
628 virtual void OnWallops(userrec* user, std::string text);
630 /** Called whenever a user's hostname is changed.
631 * This event triggers after the host has been set.
632 * @param user The user whos host is being changed
633 * @param newhost The new hostname being set
635 virtual void OnChangeHost(userrec* user, std::string newhost);
637 /** Called whenever a user's GECOS (realname) is changed.
638 * This event triggers after the name has been set.
639 * @param user The user who's GECOS is being changed
640 * @param gecos The new GECOS being set on the user
642 virtual void OnChangeName(userrec* user, std::string gecos);
644 /** Called whenever a gline is added by a local user.
645 * This method is triggered after the line is added.
646 * @param duration The duration of the line in seconds
647 * @param source The sender of the line
648 * @param reason The reason text to be displayed
649 * @param hostmask The hostmask to add
651 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
653 /** Called whenever a zline is added by a local user.
654 * This method is triggered after the line is added.
655 * @param duration The duration of the line in seconds
656 * @param source The sender of the line
657 * @param reason The reason text to be displayed
658 * @param ipmask The hostmask to add
660 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
662 /** Called whenever a kline is added by a local user.
663 * This method is triggered after the line is added.
664 * @param duration The duration of the line in seconds
665 * @param source The sender of the line
666 * @param reason The reason text to be displayed
667 * @param hostmask The hostmask to add
669 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
671 /** Called whenever a qline is added by a local user.
672 * This method is triggered after the line is added.
673 * @param duration The duration of the line in seconds
674 * @param source The sender of the line
675 * @param reason The reason text to be displayed
676 * @param nickmask The hostmask to add
678 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
680 /** Called whenever a eline is added by a local user.
681 * This method is triggered after the line is added.
682 * @param duration The duration of the line in seconds
683 * @param source The sender of the line
684 * @param reason The reason text to be displayed
685 * @param hostmask The hostmask to add
687 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
689 /** Called whenever a gline is deleted.
690 * This method is triggered after the line is deleted.
691 * @param source The user removing the line
692 * @param hostmask The hostmask to delete
694 virtual void OnDelGLine(userrec* source, std::string hostmask);
696 /** Called whenever a zline is deleted.
697 * This method is triggered after the line is deleted.
698 * @param source The user removing the line
699 * @param hostmask The hostmask to delete
701 virtual void OnDelZLine(userrec* source, std::string ipmask);
703 /** Called whenever a kline is deleted.
704 * This method is triggered after the line is deleted.
705 * @param source The user removing the line
706 * @param hostmask The hostmask to delete
708 virtual void OnDelKLine(userrec* source, std::string hostmask);
710 /** Called whenever a qline is deleted.
711 * This method is triggered after the line is deleted.
712 * @param source The user removing the line
713 * @param hostmask The hostmask to delete
715 virtual void OnDelQLine(userrec* source, std::string nickmask);
717 /** Called whenever a eline is deleted.
718 * This method is triggered after the line is deleted.
719 * @param source The user removing the line
720 * @param hostmask The hostmask to delete
722 virtual void OnDelELine(userrec* source, std::string hostmask);
724 /** Called before your module is unloaded to clean up Extensibles.
725 * This method is called once for every user and channel on the network,
726 * so that when your module unloads it may clear up any remaining data
727 * in the form of Extensibles added using Extensible::Extend().
728 * If the target_type variable is TYPE_USER, then void* item refers to
729 * a userrec*, otherwise it refers to a chanrec*.
730 * @param target_type The type of item being cleaned
731 * @param item A pointer to the item's class
733 virtual void OnCleanup(int target_type, void* item);
735 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
736 * have been applied. Please note that although you can see remote nickchanges through this function, you should
737 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
738 * check user->server before taking any action (including returning nonzero from the method).
739 * Because this method is called after the nickchange is taken place, no return values are possible
740 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
741 * @param user The user changing their nick
742 * @param oldnick The old nickname of the user before the nickchange
744 virtual void OnUserPostNick(userrec* user, std::string oldnick);
746 /** Called before an action which requires a channel privilage check.
747 * This function is called before many functions which check a users status on a channel, for example
748 * before opping a user, deopping a user, kicking a user, etc.
749 * There are several values for access_type which indicate for what reason access is being checked.
751 * AC_KICK (0) - A user is being kicked<br>
752 * AC_DEOP (1) - a user is being deopped<br>
753 * AC_OP (2) - a user is being opped<br>
754 * AC_VOICE (3) - a user is being voiced<br>
755 * AC_DEVOICE (4) - a user is being devoiced<br>
756 * AC_HALFOP (5) - a user is being halfopped<br>
757 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
758 * AC_INVITE (7) - a user is being invited<br>
759 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
760 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
761 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
762 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
763 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
764 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
765 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
766 * @param source The source of the access check
767 * @param dest The destination of the access check
768 * @param channel The channel which is being checked
769 * @param access_type See above
771 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
773 /** Called when a 005 numeric is about to be output.
774 * The module should modify the 005 numeric if needed to indicate its features.
775 * @param output The 005 string to be modified if neccessary.
777 virtual void On005Numeric(std::string &output);
779 /** Called when a client is disconnected by KILL.
780 * If a client is killed by a server, e.g. a nickname collision or protocol error,
782 * Return 1 from this function to prevent the kill, and 0 from this function to allow
783 * it as normal. If you prevent the kill no output will be sent to the client, it is
784 * down to your module to generate this information.
785 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
786 * If you do so youre risking race conditions, desyncs and worse!
787 * @param source The user sending the KILL
788 * @param dest The user being killed
789 * @param reason The kill reason
790 * @return 1 to prevent the kill, 0 to allow
792 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
794 /** Called when an oper wants to disconnect a remote user via KILL
795 * @param source The user sending the KILL
796 * @param dest The user being killed
797 * @param reason The kill reason
799 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
801 /** Called whenever a module is loaded.
802 * mod will contain a pointer to the module, and string will contain its name,
803 * for example m_widgets.so. This function is primary for dependency checking,
804 * your module may decide to enable some extra features if it sees that you have
805 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
806 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
807 * but instead operate under reduced functionality, unless the dependency is
808 * absolutely neccessary (e.g. a module that extends the features of another
810 * @param mod A pointer to the new module
811 * @param name The new module's filename
813 virtual void OnLoadModule(Module* mod,std::string name);
815 /** Called whenever a module is unloaded.
816 * mod will contain a pointer to the module, and string will contain its name,
817 * for example m_widgets.so. This function is primary for dependency checking,
818 * your module may decide to enable some extra features if it sees that you have
819 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
820 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
821 * but instead operate under reduced functionality, unless the dependency is
822 * absolutely neccessary (e.g. a module that extends the features of another
824 * @param mod Pointer to the module being unloaded (still valid)
825 * @param name The filename of the module being unloaded
827 virtual void OnUnloadModule(Module* mod,std::string name);
829 /** Called once every five seconds for background processing.
830 * This timer can be used to control timed features. Its period is not accurate
831 * enough to be used as a clock, but it is gauranteed to be called at least once in
832 * any five second period, directly from the main loop of the server.
833 * @param curtime The current timer derived from time(2)
835 virtual void OnBackgroundTimer(time_t curtime);
837 /** Called whenever a list is needed for a listmode.
838 * For example, when a /MODE #channel +b (without any other parameters) is called,
839 * if a module was handling +b this function would be called. The function can then
840 * output any lists it wishes to. Please note that all modules will see all mode
841 * characters to provide the ability to extend each other, so please only output
842 * a list if the mode character given matches the one(s) you want to handle.
843 * @param user The user requesting the list
844 * @param channel The channel the list is for
845 * @param mode The listmode which a list is being requested on
847 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
849 /** Called whenever any command is about to be executed.
850 * This event occurs for all registered commands, wether they are registered in the core,
851 * or another module, but it will not occur for invalid commands (e.g. ones which do not
852 * exist within the command table). By returning 1 from this method you may prevent the
853 * command being executed. If you do this, no output is created by the core, and it is
854 * down to your module to produce any output neccessary.
855 * Note that unless you return 1, you should not destroy any structures (e.g. by using
856 * Server::QuitUser) otherwise when the command's handler function executes after your
857 * method returns, it will be passed an invalid pointer to the user object and crash!)
858 * @param command The command being executed
859 * @param parameters An array of array of characters containing the parameters for the command
860 * @param pcnt The nuimber of parameters passed to the command
861 * @param user the user issuing the command
862 * @return 1 to block the command, 0 to allow
864 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
866 /** Called to check if a user who is connecting can now be allowed to register
867 * If any modules return false for this function, the user is held in the waiting
868 * state until all modules return true. For example a module which implements ident
869 * lookups will continue to return false for a user until their ident lookup is completed.
870 * Note that the registration timeout for a user overrides these checks, if the registration
871 * timeout is reached, the user is disconnected even if modules report that the user is
872 * not ready to connect.
873 * @param user The user to check
874 * @return true to indicate readiness, false if otherwise
876 virtual bool OnCheckReady(userrec* user);
878 /** Called whenever a user is about to register their connection (e.g. before the user
879 * is sent the MOTD etc). Modules can use this method if they are performing a function
880 * which must be done before the actual connection is completed (e.g. ident lookups,
881 * dnsbl lookups, etc).
882 * Note that you should NOT delete the user record here by causing a disconnection!
883 * Use OnUserConnect for that instead.
884 * @param user The user registering
886 virtual void OnUserRegister(userrec* user);
888 /** Called whenever a mode character is processed.
889 * Return 1 from this function to block the mode character from being processed entirely,
890 * so that you may perform your own code instead. Note that this method allows you to override
891 * modes defined by other modes, but this is NOT RECOMMENDED!
892 * @param user The user who is sending the mode
893 * @param chan The channel the mode is being sent to
894 * @param mode The mode character being set
895 * @param param The parameter for the mode or an empty string
896 * @param adding true of the mode is being added, false if it is being removed
897 * @param pcnt The parameter count for the mode (0 or 1)
898 * @return 1 to deny the mode, 0 to allow
900 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
902 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
903 * This method will always be called for each join, wether or not the channel is actually +i, and
904 * determines the outcome of an if statement around the whole section of invite checking code.
905 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
906 * @param user The user joining the channel
907 * @param chan The channel being joined
908 * @return 1 to explicitly allow the join, 0 to proceed as normal
910 virtual int OnCheckInvite(userrec* user, chanrec* chan);
912 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
913 * This method will always be called for each join, wether or not the channel is actually +k, and
914 * determines the outcome of an if statement around the whole section of key checking code.
915 * if the user specified no key, the keygiven string will be a valid but empty value.
916 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
917 * @param user The user joining the channel
918 * @param chan The channel being joined
919 * @return 1 to explicitly allow the join, 0 to proceed as normal
921 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
923 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
924 * This method will always be called for each join, wether or not the channel is actually +l, and
925 * determines the outcome of an if statement around the whole section of channel limit checking code.
926 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
927 * @param user The user joining the channel
928 * @param chan The channel being joined
929 * @return 1 to explicitly allow the join, 0 to proceed as normal
931 virtual int OnCheckLimit(userrec* user, chanrec* chan);
933 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
934 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
935 * determines the outcome of an if statement around the whole section of ban checking code.
936 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
937 * @param user The user joining the channel
938 * @param chan The channel being joined
939 * @return 1 to explicitly allow the join, 0 to proceed as normal
941 virtual int OnCheckBan(userrec* user, chanrec* chan);
943 /** Called on all /STATS commands
944 * This method is triggered for all /STATS use, including stats symbols handled by the core.
945 * @param symbol the symbol provided to /STATS
947 virtual void OnStats(char symbol);
949 /** Called whenever a change of a local users displayed host is attempted.
950 * Return 1 to deny the host change, or 0 to allow it.
951 * @param user The user whos host will be changed
952 * @param newhost The new hostname
953 * @return 1 to deny the host change, 0 to allow
955 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
957 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
958 * return 1 to deny the name change, or 0 to allow it.
959 * @param user The user whos GECOS will be changed
960 * @param newhost The new GECOS
961 * @return 1 to deny the GECOS change, 0 to allow
963 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
965 /** Called whenever a topic is changed by a local user.
966 * Return 1 to deny the topic change, or 0 to allow it.
967 * @param user The user changing the topic
968 * @param chan The channels who's topic is being changed
969 * @param topic The actual topic text
970 * @param 1 to block the topic change, 0 to allow
972 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
974 /** Called whenever a local topic has been changed.
975 * To block topic changes you must use OnLocalTopicChange instead.
976 * @param user The user changing the topic
977 * @param chan The channels who's topic is being changed
978 * @param topic The actual topic text
980 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
982 /** Called whenever an Event class is sent to all module by another module.
983 * Please see the documentation of Event::Send() for further information. The Event sent can
984 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
985 * before doing anything to the event data, and you should *not* change the event data in any way!
986 * @param event The Event class being received
988 virtual void OnEvent(Event* event);
990 /** Called whenever a Request class is sent to your module by another module.
991 * Please see the documentation of Request::Send() for further information. The Request sent
992 * can always be assumed to be non-NULL, you should not change the request object or its data.
993 * Your method may return arbitary data in the char* result which the requesting module
994 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
995 * @param request The Request class being received
997 virtual char* OnRequest(Request* request);
999 /** Called whenever an oper password is to be compared to what a user has input.
1000 * The password field (from the config file) is in 'password' and is to be compared against
1001 * 'input'. This method allows for encryption of oper passwords and much more besides.
1002 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1004 * @param password The oper's password
1005 * @param input The password entered
1006 * @return 1 to match the passwords, 0 to do nothing
1008 virtual int OnOperCompare(std::string password, std::string input);
1010 /** Called whenever a user is given usermode +o, anywhere on the network.
1011 * You cannot override this and prevent it from happening as it is already happened and
1012 * such a task must be performed by another server. You can however bounce modes by sending
1013 * servermodes out to reverse mode changes.
1014 * @param user The user who is opering
1016 virtual void OnGlobalOper(userrec* user);
1018 /** Called whenever a user connects, anywhere on the network.
1019 * This event is informational only. You should not change any user information in this
1020 * event. To do so, use the OnUserConnect method to change the state of local users.
1021 * @param user The user who is connecting
1023 virtual void OnGlobalConnect(userrec* user);
1025 /** Called whenever a ban is added to a channel's list.
1026 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1027 * @param source The user adding the ban
1028 * @param channel The channel the ban is being added to
1029 * @param banmask The ban mask being added
1030 * @return 1 to block the ban, 0 to continue as normal
1032 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1034 /** Called whenever a ban is removed from a channel's list.
1035 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1036 * @param source The user deleting the ban
1037 * @param channel The channel the ban is being deleted from
1038 * @param banmask The ban mask being deleted
1039 * @return 1 to block the unban, 0 to continue as normal
1041 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1043 /** Called immediately after any connection is accepted. This is intended for raw socket
1044 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1045 * no information relating to a user record as the connection has not been assigned yet.
1046 * There are no return values from this call as all modules get an opportunity if required to
1047 * process the connection.
1048 * @param fd The file descriptor returned from accept()
1049 * @param ip The IP address of the connecting user
1050 * @param localport The local port number the user connected to
1052 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1054 /** Called immediately before any write() operation on a user's socket in the core. Because
1055 * this event is a low level event no user information is associated with it. It is intended
1056 * for use by modules which may wrap connections within another API such as SSL for example.
1057 * return a non-zero result if you have handled the write operation, in which case the core
1058 * will not call write().
1059 * @param fd The file descriptor of the socket
1060 * @param buffer A char* buffer being written
1061 * @param Number of characters to write
1062 * @return Number of characters actually written or 0 if you didn't handle the operation
1064 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1066 /** Called immediately before any socket is closed. When this event is called, shutdown()
1067 * has not yet been called on the socket.
1068 * @param fd The file descriptor of the socket prior to close()
1070 virtual void OnRawSocketClose(int fd);
1072 /** Called immediately before any read() operation on a client socket in the core.
1073 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1074 * when this event occurs.
1075 * Your event should return 1 if it has handled the reading itself, which prevents the core
1076 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1077 * the value of count. The value of readresult must be identical to an actual result that might
1078 * be returned from the read() system call, for example, number of bytes read upon success,
1079 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1080 * you MUST set readresult.
1081 * @param fd The file descriptor of the socket
1082 * @param buffer A char* buffer being read to
1083 * @param count The size of the buffer
1084 * @param readresult The amount of characters read, or 0
1085 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1087 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1091 /** Allows server output and query functions
1092 * This class contains methods which allow a module to query the state of the irc server, and produce
1093 * output to users and other servers. All modules should instantiate at least one copy of this class,
1094 * and use its member functions to perform their tasks.
1096 class Server : public classbase
1099 /** Default constructor.
1100 * Creates a Server object.
1103 /** Default destructor.
1104 * Destroys a Server object.
1107 /** Obtains a pointer to the server's ServerConfig object.
1108 * The ServerConfig object contains most of the configuration data
1109 * of the IRC server, as read from the config file by the core.
1111 ServerConfig* GetConfig();
1112 /** Sends text to all opers.
1113 * This method sends a server notice to all opers with the usermode +s.
1115 virtual void SendOpers(std::string s);
1116 /** Returns the version string of this server
1118 std::string GetVersion();
1119 /** Writes a log string.
1120 * This method writes a line of text to the log. If the level given is lower than the
1121 * level given in the configuration, this command has no effect.
1123 virtual void Log(int level, std::string s);
1124 /** Sends a line of text down a TCP/IP socket.
1125 * This method writes a line of text to an established socket, cutting it to 510 characters
1126 * plus a carriage return and linefeed if required.
1128 virtual void Send(int Socket, std::string s);
1129 /** Sends text from the server to a socket.
1130 * This method writes a line of text to an established socket, with the servername prepended
1131 * as used by numerics (see RFC 1459)
1133 virtual void SendServ(int Socket, std::string s);
1134 /** Writes text to a channel, but from a server, including all.
1135 * This can be used to send server notices to a group of users.
1137 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1138 /** Sends text from a user to a socket.
1139 * This method writes a line of text to an established socket, with the given user's nick/ident
1140 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1142 virtual void SendFrom(int Socket, userrec* User, std::string s);
1143 /** Sends text from a user to another user.
1144 * This method writes a line of text to a user, with a user's nick/ident
1145 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1146 * If you specify NULL as the source, then the data will originate from the
1147 * local server, e.g. instead of:
1149 * :user!ident@host TEXT
1151 * The format will become:
1155 * Which is useful for numerics and server notices to single users, etc.
1157 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1158 /** Sends text from a user to a channel (mulicast).
1159 * This method writes a line of text to a channel, with the given user's nick/ident
1160 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1161 * IncludeSender flag is set, then the text is also sent back to the user from which
1162 * it originated, as seen in MODE (see RFC 1459).
1164 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1165 /** Returns true if two users share a common channel.
1166 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1169 virtual bool CommonChannels(userrec* u1, userrec* u2);
1170 /** Sends text from a user to one or more channels (mulicast).
1171 * This method writes a line of text to all users which share a common channel with a given
1172 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1173 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1174 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1175 * is only sent to the other recipients, as seen in QUIT.
1177 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1178 /** Sends a WALLOPS message.
1179 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1182 virtual void SendWallops(userrec* User, std::string text);
1184 /** Returns true if a nick is valid.
1185 * Nicks for unregistered connections will return false.
1187 virtual bool IsNick(std::string nick);
1188 /** Returns a count of the number of users on a channel.
1189 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1191 virtual int CountUsers(chanrec* c);
1192 /** Attempts to look up a nick and return a pointer to it.
1193 * This function will return NULL if the nick does not exist.
1195 virtual userrec* FindNick(std::string nick);
1196 /** Attempts to look up a nick using the file descriptor associated with that nick.
1197 * This function will return NULL if the file descriptor is not associated with a valid user.
1199 virtual userrec* FindDescriptor(int socket);
1200 /** Attempts to look up a channel and return a pointer to it.
1201 * This function will return NULL if the channel does not exist.
1203 virtual chanrec* FindChannel(std::string channel);
1204 /** Attempts to look up a user's privilages on a channel.
1205 * This function will return a string containing either @, %, +, or an empty string,
1206 * representing the user's privilages upon the channel you specify.
1208 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1209 /** Checks if a user is on a channel.
1210 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1212 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1213 /** Returns the server name of the server where the module is loaded.
1215 virtual std::string GetServerName();
1216 /** Returns the network name, global to all linked servers.
1218 virtual std::string GetNetworkName();
1219 /** Returns the server description string of the local server
1221 virtual std::string GetServerDescription();
1222 /** Returns the information of the server as returned by the /ADMIN command.
1223 * See the Admin class for further information of the return value. The members
1224 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1225 * server where the module is loaded.
1227 virtual Admin GetAdmin();
1228 /** Adds an extended mode letter which is parsed by a module.
1229 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1230 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1231 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1232 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1233 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1234 * params_when_on is the number of modes to expect when the mode is turned on
1235 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1236 * the params_when_off value has a similar value to params_when_on, except it indicates
1237 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1238 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1239 * use this parameter. The function returns false if the mode is unavailable, and will not
1240 * attempt to allocate another character, as this will confuse users. This also means that
1241 * as only one module can claim a specific mode character, the core does not need to keep track
1242 * of which modules own which modes, which speeds up operation of the server. In this version,
1243 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1246 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1248 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1249 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1252 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1254 * (2) They always take exactly one parameter when being added or removed
1256 * (3) They can be set multiple times, usually on users in channels
1258 * (4) The mode and its parameter are NOT stored in the channels modes structure
1260 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1261 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1262 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1263 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1264 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1265 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1266 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1267 * so the above example would become '+aa one three' after processing.
1269 virtual bool AddExtendedListMode(char modechar);
1271 /** Adds a command to the command table.
1272 * This allows modules to add extra commands into the command table. You must place a function within your
1273 * module which is is of type handlerfunc:
1275 * typedef void (handlerfunc) (char**, int, userrec*);
1277 * void handle_kill(char **parameters, int pcnt, userrec *user)
1279 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1280 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1281 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1282 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1283 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1284 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1285 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1288 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
1290 /** Sends a servermode.
1291 * you must format the parameters array with the target, modes and parameters for those modes.
1297 * modes[0] = ChannelName;
1301 * modes[2] = user->nick;
1303 * Srv->SendMode(modes,3,user);
1305 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1306 * will be sent to the user you provide as the third parameter.
1307 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1308 * your server in an unstable state!
1311 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1313 /** Sends to all users matching a mode mask
1314 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1315 * or module provided modes, including ones provided by your own module.
1316 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1317 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1318 * for example, if you were to use:
1320 * Serv->SendToModeMask("xi", WM_OR, "m00");
1322 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1323 * user must have both modes set to receive the message.
1325 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1327 /** Forces a user to join a channel.
1328 * This is similar to svsjoin and can be used to implement redirection, etc.
1329 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1330 * On failure, the result is NULL.
1332 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1334 /** Forces a user to part a channel.
1335 * This is similar to svspart and can be used to implement redirection, etc.
1336 * Although the return value of this function is a pointer to a channel record, the returned data is
1337 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1339 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1341 /** Forces a user nickchange.
1342 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1343 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1344 * the error numeric for it.
1346 virtual void ChangeUserNick(userrec* user, std::string nickname);
1348 /** Forces a user to quit with the specified reason.
1349 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1350 * may bypass the quit prefix specified in the config file.
1354 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1355 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1356 * action after calling this method is to immediately bail from your handler.
1358 virtual void QuitUser(userrec* user, std::string reason);
1360 /** Matches text against a glob pattern.
1361 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1362 * Returns true if the literal successfully matches the pattern, false if otherwise.
1364 virtual bool MatchText(std::string sliteral, std::string spattern);
1366 /** Calls the handler for a command, either implemented by the core or by another module.
1367 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1368 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1369 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1370 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1371 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1372 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1373 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1374 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1375 * used for privilage checks, etc.
1377 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1379 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1381 /** Change displayed hostname of a user.
1382 * You should always call this method to change a user's host rather than writing directly to the
1383 * dhost member of userrec, as any change applied via this method will be propogated to any
1386 virtual void ChangeHost(userrec* user, std::string host);
1388 /** Change GECOS (fullname) of a user.
1389 * You should always call this method to change a user's GECOS rather than writing directly to the
1390 * fullname member of userrec, as any change applied via this method will be propogated to any
1393 virtual void ChangeGECOS(userrec* user, std::string gecos);
1395 /** Returns true if the servername you give is ulined.
1396 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1397 * change modes of clients which are on remote servers and set modes of channels where there are
1398 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
1399 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
1400 * case of normal servers, as many ulined server types (such as services) do not support meshed
1401 * links and must operate in this manner.
1403 virtual bool IsUlined(std::string server);
1405 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1406 * chanrec due to include constraints.
1408 virtual chanuserlist GetUsers(chanrec* chan);
1410 /** Remove a user's connection to the irc server, but leave their client in existence in the
1411 * user hash. When you call this function, the user's file descriptor will be replaced with the
1412 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1413 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1414 * After this call, the pointer to user will be invalid.
1416 virtual bool UserToPseudo(userrec* user,std::string message);
1418 /** This user takes one user, and switches their file descriptor with another user, so that one user
1419 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1420 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1421 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1422 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1424 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1427 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1428 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1429 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1430 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1433 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1436 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1437 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1438 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1439 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1442 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1445 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1446 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1447 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1448 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1451 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1454 * The K-line is enforced as soon as it is added.
1455 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1456 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1457 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1460 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1463 * The E-line is enforced as soon as it is added.
1464 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1465 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1466 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1469 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1471 /** Deletes a G-Line from all servers on the mesh
1473 virtual bool DelGLine(std::string hostmask);
1475 /** Deletes a Q-Line from all servers on the mesh
1477 virtual bool DelQLine(std::string nickname);
1479 /** Deletes a Z-Line from all servers on the mesh
1481 virtual bool DelZLine(std::string ipaddr);
1483 /** Deletes a local K-Line
1485 virtual bool DelKLine(std::string hostmask);
1487 /** Deletes a local E-Line
1489 virtual bool DelELine(std::string hostmask);
1491 /** Calculates a duration
1492 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1493 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1496 virtual long CalcDuration(std::string duration);
1498 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1500 virtual bool IsValidMask(std::string mask);
1502 /** This function finds a module by name.
1503 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1504 * the function will return NULL.
1506 virtual Module* FindModule(std::string name);
1508 /** Adds a class derived from InspSocket to the server's socket engine.
1510 virtual void AddSocket(InspSocket* sock);
1512 /** Deletes a class derived from InspSocket from the server's socket engine.
1514 virtual void DelSocket(InspSocket* sock);
1516 virtual void RehashServer();
1520 #define CONF_NOT_A_NUMBER 0x000010
1521 #define CONF_NOT_UNSIGNED 0x000080
1522 #define CONF_VALUE_NOT_FOUND 0x000100
1523 #define CONF_FILE_NOT_FOUND 0x000200
1526 /** Allows reading of values from configuration files
1527 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1528 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1529 * Constructing the class using one parameter allows you to specify a path to your own configuration
1530 * file, otherwise, inspircd.conf is read.
1532 class ConfigReader : public classbase
1535 /** The contents of the configuration file
1536 * This protected member should never be accessed by a module (and cannot be accessed unless the
1537 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1538 * (such as comments) stripped from it.
1540 std::stringstream *cache;
1541 std::stringstream *errorlog;
1542 /** Used to store errors
1548 /** Default constructor.
1549 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1550 * as specified when running ./configure.
1552 ConfigReader(); // default constructor reads ircd.conf
1553 /** Overloaded constructor.
1554 * This constructor initialises the ConfigReader class to read a user-specified config file
1556 ConfigReader(std::string filename); // read a module-specific config
1557 /** Default destructor.
1558 * This method destroys the ConfigReader class.
1561 /** Retrieves a value from the config file.
1562 * This method retrieves a value from the config file. Where multiple copies of the tag
1563 * exist in the config file, index indicates which of the values to retrieve.
1565 std::string ReadValue(std::string tag, std::string name, int index);
1566 /** Retrieves a boolean value from the config file.
1567 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1568 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1569 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1571 bool ReadFlag(std::string tag, std::string name, int index);
1572 /** Retrieves an integer value from the config file.
1573 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1574 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1575 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1576 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1577 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1578 * will return CONF_NOT_UNSIGNED
1580 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1581 /** Returns the last error to occur.
1582 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1583 * A call to GetError() resets the error flag back to 0.
1586 /** Counts the number of times a given tag appears in the config file.
1587 * This method counts the number of times a tag appears in a config file, for use where
1588 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1589 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1590 * multiple instance tag.
1592 int Enumerate(std::string tag);
1593 /** Returns true if a config file is valid.
1594 * This method is partially implemented and will only return false if the config
1595 * file does not exist or could not be opened.
1598 /** Dumps the list of errors in a config file to an output location. If bail is true,
1599 * then the program will abort. If bail is false and user points to a valid user
1600 * record, the error report will be spooled to the given user by means of NOTICE.
1601 * if bool is false AND user is false, the error report will be spooled to all opers
1602 * by means of a NOTICE to all opers.
1604 void DumpErrors(bool bail,userrec* user);
1606 /** Returns the number of items within a tag.
1607 * For example if the tag was <test tag="blah" data="foo"> then this
1608 * function would return 2. Spaces and newlines both qualify as valid seperators
1611 int EnumerateValues(std::string tag, int index);
1616 /** Caches a text file into memory and can be used to retrieve lines from it.
1617 * This class contains methods for read-only manipulation of a text file in memory.
1618 * Either use the constructor type with one parameter to load a file into memory
1619 * at construction, or use the LoadFile method to load a file.
1621 class FileReader : public classbase
1625 /** Default constructor.
1626 * This method does not load any file into memory, you must use the LoadFile method
1627 * after constructing the class this way.
1631 /** Secondary constructor.
1632 * This method initialises the class with a file loaded into it ready for GetLine and
1633 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1636 FileReader(std::string filename);
1638 /** Default destructor.
1639 * This deletes the memory allocated to the file.
1643 /** Used to load a file.
1644 * This method loads a file into the class ready for GetLine and
1645 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1648 void LoadFile(std::string filename);
1650 /** Returns true if the file exists
1651 * This function will return false if the file could not be opened.
1655 /** Retrieve one line from the file.
1656 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1657 * the index was out of bounds, or the line had no data on it.
1659 std::string GetLine(int x);
1661 /** Returns the size of the file in lines.
1662 * This method returns the number of lines in the read file. If it is 0, no lines have been
1663 * read into memory, either because the file is empty or it does not exist, or cannot be
1664 * opened due to permission problems.
1670 /** Instantiates classes inherited from Module
1671 * This class creates a class inherited from type Module, using new. This is to allow for modules
1672 * to create many different variants of Module, dependent on architecture, configuration, etc.
1673 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1676 class ModuleFactory : public classbase
1680 virtual ~ModuleFactory() { }
1681 /** Creates a new module.
1682 * Your inherited class of ModuleFactory must return a pointer to your Module class
1683 * using this method.
1685 virtual Module * CreateModule(Server* Me) = 0;
1689 typedef DLLFactory<ModuleFactory> ircd_module;
1691 bool ModeDefined(char c, int i);
1692 bool ModeDefinedOper(char c, int i);
1693 int ModeDefinedOn(char c, int i);
1694 int ModeDefinedOff(char c, int i);
1695 void ModeMakeList(char modechar);
1696 bool ModeIsListMode(char modechar, int type);