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
68 /** Low level definition of a FileReader classes file cache area
70 typedef std::deque<std::string> file_cache;
71 typedef file_cache string_list;
73 /** Holds a list of users in a channel
75 typedef std::deque<userrec*> chanuserlist;
78 // This #define allows us to call a method in all
79 // loaded modules in a readable simple way, e.g.:
80 // 'FOREACH_MOD OnConnect(user);'
82 #define FOREACH_MOD for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]->
84 // This define is similar to the one above but returns a result in MOD_RESULT.
85 // The first module to return a nonzero result is the value to be accepted,
86 // and any modules after are ignored.
88 // *********************************************************************************************
90 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
91 for (int _i = 0; _i <= MODCOUNT; _i++) { \
92 int res = modules[_i]->x ; \
100 // *********************************************************************************************
102 #define FD_MAGIC_NUMBER -42
106 #define IS_LOCAL(x) (x->fd > -1)
107 #define IS_REMOTE(x) (x->fd < 0)
108 #define IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
110 // flags for use with WriteMode
115 // flags for use with OnUserPreMessage and OnUserPreNotice
118 #define TYPE_CHANNEL 2
119 #define TYPE_SERVER 3
121 /*extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
122 extern void server_mode(char **parameters, int pcnt, userrec *user);*/
124 // class Version holds the version information of a Module, returned
125 // by Module::GetVersion (thanks RD)
127 /** Holds a module's Version information
128 * The four members (set by the constructor only) indicate details as to the version number
129 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
131 class Version : public classbase
134 const int Major, Minor, Revision, Build, Flags;
135 Version(int major, int minor, int revision, int build, int flags);
138 /** Holds /ADMIN data
139 * This class contains the admin details of the local server. It is constructed by class Server,
140 * and has three read-only values, Name, Email and Nick that contain the specified values for the
141 * server where the module is running.
143 class Admin : public classbase
146 const std::string Name, Email, Nick;
147 Admin(std::string name, std::string email, std::string nick);
151 // Forward-delacare module for ModuleMessage etc
154 // Thanks to Rob (from anope) for the idea of this message passing API
155 // (its been done before, but this seemed a very neat and tidy way...
157 /** The ModuleMessage class is the base class of Request and Event
158 * This class is used to represent a basic data structure which is passed
159 * between modules for safe inter-module communications.
161 class ModuleMessage : public classbase
164 /** This class is pure virtual and must be inherited.
166 virtual char* Send() = 0;
167 virtual ~ModuleMessage() {};
170 /** The Request class is a unicast message directed at a given module.
171 * When this class is properly instantiated it may be sent to a module
172 * using the Send() method, which will call the given module's OnRequest
173 * method with this class as its parameter.
175 class Request : public ModuleMessage
178 /** This member holds a pointer to arbitary data set by the emitter of the message
181 /** This is a pointer to the sender of the message, which can be used to
182 * directly trigger events, or to create a reply.
185 /** The single destination of the Request
189 /** Create a new Request
191 Request(char* anydata, Module* src, Module* dst);
192 /** Fetch the Request data
195 /** Fetch the request source
198 /** Fetch the request destination (should be 'this' in the receiving module)
201 /** Send the Request.
202 * Upon returning the result will be arbitary data returned by the module you
203 * sent the request to. It is up to your module to know what this data is and
204 * how to deal with it.
210 /** The Event class is a unicast message directed at all modules.
211 * When the class is properly instantiated it may be sent to all modules
212 * using the Send() method, which will trigger the OnEvent method in
213 * all modules passing the object as its parameter.
215 class Event : public ModuleMessage
218 /** This member holds a pointer to arbitary data set by the emitter of the message
221 /** This is a pointer to the sender of the message, which can be used to
222 * directly trigger events, or to create a reply.
225 /** The event identifier.
226 * This is arbitary text which should be used to distinguish
227 * one type of event from another.
231 /** Create a new Event
233 Event(char* anydata, Module* src, std::string eventid);
234 /** Get the Event data
237 /** Get the event Source
240 /** Get the event ID.
241 * Use this to determine the event type for safe casting of the data
243 std::string GetEventID();
245 * The return result of an Event::Send() will always be NULL as
246 * no replies are expected.
251 /** Holds an extended mode's details.
252 * Used internally by modules.cpp
254 class ExtMode : public classbase
263 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) { };
267 /** Base class for all InspIRCd modules
268 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
269 * its methods will be called when irc server events occur. class inherited from module must be
270 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
272 class Module : public classbase
276 /** Default constructor
277 * Creates a module class.
278 * @param Me An instance of the Server class which can be saved for future use
282 /** Default destructor
283 * destroys a module class
287 /** Returns the version number of a Module.
288 * The method should return a Version object with its version information assigned via
291 virtual Version GetVersion();
293 /** Called when a user connects.
294 * The details of the connecting user are available to you in the parameter userrec *user
295 * @param user The user who is connecting
297 virtual void OnUserConnect(userrec* user);
299 /** Called when a user quits.
300 * The details of the exiting user are available to you in the parameter userrec *user
301 * This event is only called when the user is fully registered when they quit. To catch
302 * raw disconnections, use the OnUserDisconnect method.
303 * @param user The user who is quitting
304 * @param message The user's quit message
306 virtual void OnUserQuit(userrec* user, std::string message);
308 /** Called whenever a user's socket is closed.
309 * The details of the exiting user are available to you in the parameter userrec *user
310 * This event is called for all users, registered or not, as a cleanup method for modules
311 * which might assign resources to user, such as dns lookups, objects and sockets.
312 * @param user The user who is disconnecting
314 virtual void OnUserDisconnect(userrec* user);
316 /** Called when a user joins a channel.
317 * The details of the joining user are available to you in the parameter userrec *user,
318 * and the details of the channel they have joined is available in the variable chanrec *channel
319 * @param user The user who is joining
320 * @param channel The channel being joined
322 virtual void OnUserJoin(userrec* user, chanrec* channel);
324 /** Called when a user parts a channel.
325 * The details of the leaving user are available to you in the parameter userrec *user,
326 * and the details of the channel they have left is available in the variable chanrec *channel
327 * @param user The user who is parting
328 * @param channel The channel being parted
330 virtual void OnUserPart(userrec* user, chanrec* channel);
332 /** Called on rehash.
333 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
334 * system. You should use it to reload any files so that your module keeps in step with the
335 * rest of the application. If a parameter is given, the core has done nothing. The module
336 * receiving the event can decide if this parameter has any relevence to it.
337 * @param parameter The (optional) parameter given to REHASH from the user.
339 virtual void OnRehash(std::string parameter);
341 /** Called when a raw command is transmitted or received.
342 * This method is the lowest level of handler available to a module. It will be called with raw
343 * data which is passing through a connected socket. If you wish, you may munge this data by changing
344 * the string parameter "raw". If you do this, after your function exits it will immediately be
345 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
346 * inbound is set to true) the value of user will be the userrec of the connection sending the
347 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
348 * @param raw The raw string in RFC1459 format
349 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
350 * @param user The user record sending the text, when inbound == true.
352 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
354 /** Called whenever an extended mode is to be processed.
355 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
356 * changed. mode_on is set when the mode is being set, in which case params contains a list of
357 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
358 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
359 * was set up with Server::AddExtendedMode
360 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
361 * You must cast this value yourself to make use of it.
362 * @param user The user issuing the mode
363 * @param target The user or channel having the mode set on them
364 * @param modechar The mode character being set
365 * @param type The type of mode (user or channel) being set
366 * @param mode_on True if the mode is being set, false if it is being unset
367 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
369 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
371 /** Called whenever a user is about to join a channel, before any processing is done.
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,
374 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
375 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
379 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
380 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
381 * processing on the actual channel record at this point, however the channel NAME will still be passed in
382 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
383 * @param user The user joining the channel
384 * @param cname The channel name being joined
385 * @return 1 To prevent the join, 0 to allow it.
387 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
389 /** Called whenever a user is about to be kicked.
390 * Returning a value of 1 from this function stops the process immediately, causing no
391 * output to be sent to the user by the core. If you do this you must produce your own numerics,
393 * @param source The user issuing the kick
394 * @param user The user being kicked
395 * @param chan The channel the user is being kicked from
396 * @param reason The kick reason
397 * @return 1 to prevent the kick, 0 to allow it
399 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
401 /** Called whenever a user is kicked.
402 * If this method is called, the kick is already underway and cannot be prevented, so
403 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
404 * @param source The user issuing the kick
405 * @param user The user being kicked
406 * @param chan The channel the user is being kicked from
407 * @param reason The kick reason
409 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
411 /** Called whenever a user opers locally.
412 * The userrec will contain the oper mode 'o' as this function is called after any modifications
413 * are made to the user's structure by the core.
414 * @param user The user who is opering up
415 * @param opertype The opers type name
417 virtual void OnOper(userrec* user, std::string opertype);
419 /** Called whenever a user types /INFO.
420 * The userrec will contain the information of the user who typed the command. Modules may use this
421 * method to output their own credits in /INFO (which is the ircd's version of an about box).
422 * It is purposefully not possible to modify any info that has already been output, or halt the list.
423 * You must write a 371 numeric to the user, containing your info in the following format:
425 * <nick> :information here
427 * @param user The user issuing /INFO
429 virtual void OnInfo(userrec* user);
431 /** Called whenever a /WHOIS is performed on a local user.
432 * The source parameter contains the details of the user who issued the WHOIS command, and
433 * the dest parameter contains the information of the user they are whoising.
434 * @param source The user issuing the WHOIS command
435 * @param dest The user who is being WHOISed
437 virtual void OnWhois(userrec* source, userrec* dest);
439 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
440 * Returning 1 from this function stops the process immediately, causing no
441 * output to be sent to the user by the core. If you do this you must produce your own numerics,
442 * notices etc. This is useful for modules which may want to filter invites to channels.
443 * @param source The user who is issuing the INVITE
444 * @param dest The user being invited
445 * @param channel The channel the user is being invited to
446 * @return 1 to deny the invite, 0 to allow
448 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
450 /** Called after a user has been successfully invited to a channel.
451 * You cannot prevent the invite from occuring using this function, to do that,
452 * use OnUserPreInvite instead.
453 * @param source The user who is issuing the INVITE
454 * @param dest The user being invited
455 * @param channel The channel the user is being invited to
457 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
459 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
460 * Returning any nonzero value from this function stops the process immediately, causing no
461 * output to be sent to the user by the core. If you do this you must produce your own numerics,
462 * notices etc. This is useful for modules which may want to filter or redirect messages.
463 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
464 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
465 * of where the message is destined to be sent.
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 OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
474 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
475 * Returning any nonzero value from this function stops the process immediately, causing no
476 * output to be sent to the user by the core. If you do this you must produce your own numerics,
477 * notices etc. This is useful for modules which may want to filter or redirect messages.
478 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
479 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
480 * of where the message is destined to be sent.
481 * You may alter the message text as you wish before relinquishing control to the next module
482 * in the chain, and if no other modules block the text this altered form of the text will be sent out
483 * to the user and possibly to other servers.
484 * @param user The user sending the message
485 * @param dest The target of the message (chanrec* or userrec*)
486 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
487 * @param text Changeable text being sent by the user
488 * @return 1 to deny the NOTICE, 0 to allow it
490 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
492 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
493 * Please note that although you can see remote nickchanges through this function, you should
494 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
495 * check user->server before taking any action (including returning nonzero from the method).
496 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
497 * module to generate some meaninful output.
498 * @param user The username changing their nick
499 * @param newnick Their new nickname
500 * @return 1 to deny the change, 0 to allow
502 virtual int OnUserPreNick(userrec* user, std::string newnick);
504 /** Called after any PRIVMSG sent from a user.
505 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
506 * if target_type is TYPE_CHANNEL.
507 * @param user The user sending the message
508 * @param dest The target of the message
509 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
510 * @param text the text being sent by the user
512 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
514 /** Called after any NOTICE sent from a user.
515 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
516 * if target_type is TYPE_CHANNEL.
517 * @param user The user sending the message
518 * @param dest The target of the message
519 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
520 * @param text the text being sent by the user
522 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
524 /** Called after every MODE command sent from a user
525 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
526 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
527 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
528 * @param user The user sending the MODEs
529 * @param dest The target of the modes (userrec* or chanrec*)
530 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
531 * @param text The actual modes and their parameters if any
533 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
535 /** Allows modules to alter or create server descriptions
536 * Whenever a module requires a server description, for example for display in
537 * WHOIS, this function is called in all modules. You may change or define the
538 * description given in std::string &description. If you do, this description
539 * will be shown in the WHOIS fields.
540 * @param servername The servername being searched for
541 * @param description Alterable server description for this server
543 virtual void OnGetServerDescription(std::string servername,std::string &description);
545 /** Allows modules to synchronize data which relates to users during a netburst.
546 * When this function is called, it will be called from the module which implements
547 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
548 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
549 * (see below). This function will be called for every user visible on your side
550 * of the burst, allowing you to for example set modes, etc. Do not use this call to
551 * synchronize data which you have stored using class Extensible -- There is a specialist
552 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
553 * @param user The user being syncronized
554 * @param proto A pointer to the module handling network protocol
555 * @param opaque An opaque pointer set by the protocol module, should not be modified!
557 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
559 /** Allows modules to synchronize data which relates to channels during a netburst.
560 * When this function is called, it will be called from the module which implements
561 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
562 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
563 * (see below). This function will be called for every user visible on your side
564 * of the burst, allowing you to for example set modes, etc. Do not use this call to
565 * synchronize data which you have stored using class Extensible -- There is a specialist
566 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
568 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
570 * @param chan The channel being syncronized
571 * @param proto A pointer to the module handling network protocol
572 * @param opaque An opaque pointer set by the protocol module, should not be modified!
574 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
576 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
577 * Whenever the linking module wants to send out data, but doesnt know what the data
578 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
579 * this method is called.You should use the ProtoSendMetaData function after you've
580 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
581 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
582 * @param chan The channel whos metadata is being syncronized
583 * @param proto A pointer to the module handling network protocol
584 * @param opaque An opaque pointer set by the protocol module, should not be modified!
585 * @param extname The extensions name which is being searched for
587 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
589 /* Allows modules to syncronize metadata related to users over the network during a netburst.
590 * Whenever the linking module wants to send out data, but doesnt know what the data
591 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
592 * this method is called. You should use the ProtoSendMetaData function after you've
593 * correctly decided how the data should be represented, to send the metadata on its way if
594 * if it belongs to your module.
595 * @param user The user whos metadata is being syncronized
596 * @param proto A pointer to the module handling network protocol
597 * @param opaque An opaque pointer set by the protocol module, should not be modified!
598 * @param extname The extensions name which is being searched for
600 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
602 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
603 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
604 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
605 * @param target The chanrec* or userrec* that data should be added to
606 * @param extname The extension name which is being sent
607 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
609 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
611 /** Implemented by modules which provide the ability to link servers.
612 * These modules will implement this method, which allows transparent sending of servermodes
613 * down the network link as a broadcast, without a module calling it having to know the format
614 * of the MODE command before the actual mode string.
616 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
617 * of how to use this function.
619 * @param opaque An opaque pointer set by the protocol module, should not be modified!
620 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
621 * @param target The chanrec* or userrec* that modes should be sent for
622 * @param modeline The modes and parameters to be sent
624 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
626 /** Implemented by modules which provide the ability to link servers.
627 * These modules will implement this method, which allows metadata (extra data added to
628 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
629 * to other servers on a netburst and decoded at the other end by the same module on a
632 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
633 * how to use this function.
634 * @param opaque An opaque pointer set by the protocol module, should not be modified!
635 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
636 * @param target The chanrec* or userrec* that metadata should be sent for
637 * @param extname The extension name to send metadata for
638 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
640 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
642 /** Called after every WALLOPS command.
643 * @param user The user sending the WALLOPS
644 * @param text The content of the WALLOPS message
646 virtual void OnWallops(userrec* user, std::string text);
648 /** Called whenever a user's hostname is changed.
649 * This event triggers after the host has been set.
650 * @param user The user whos host is being changed
651 * @param newhost The new hostname being set
653 virtual void OnChangeHost(userrec* user, std::string newhost);
655 /** Called whenever a user's GECOS (realname) is changed.
656 * This event triggers after the name has been set.
657 * @param user The user who's GECOS is being changed
658 * @param gecos The new GECOS being set on the user
660 virtual void OnChangeName(userrec* user, std::string gecos);
662 /** Called whenever a gline 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 OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
671 /** Called whenever a zline 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 ipmask The hostmask to add
678 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
680 /** Called whenever a kline 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 OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
689 /** Called whenever a qline is added by a local user.
690 * This method is triggered after the line is added.
691 * @param duration The duration of the line in seconds
692 * @param source The sender of the line
693 * @param reason The reason text to be displayed
694 * @param nickmask The hostmask to add
696 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
698 /** Called whenever a eline is added by a local user.
699 * This method is triggered after the line is added.
700 * @param duration The duration of the line in seconds
701 * @param source The sender of the line
702 * @param reason The reason text to be displayed
703 * @param hostmask The hostmask to add
705 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
707 /** Called whenever a gline is deleted.
708 * This method is triggered after the line is deleted.
709 * @param source The user removing the line
710 * @param hostmask The hostmask to delete
712 virtual void OnDelGLine(userrec* source, std::string hostmask);
714 /** Called whenever a zline is deleted.
715 * This method is triggered after the line is deleted.
716 * @param source The user removing the line
717 * @param hostmask The hostmask to delete
719 virtual void OnDelZLine(userrec* source, std::string ipmask);
721 /** Called whenever a kline is deleted.
722 * This method is triggered after the line is deleted.
723 * @param source The user removing the line
724 * @param hostmask The hostmask to delete
726 virtual void OnDelKLine(userrec* source, std::string hostmask);
728 /** Called whenever a qline is deleted.
729 * This method is triggered after the line is deleted.
730 * @param source The user removing the line
731 * @param hostmask The hostmask to delete
733 virtual void OnDelQLine(userrec* source, std::string nickmask);
735 /** Called whenever a eline is deleted.
736 * This method is triggered after the line is deleted.
737 * @param source The user removing the line
738 * @param hostmask The hostmask to delete
740 virtual void OnDelELine(userrec* source, std::string hostmask);
742 /** Called before your module is unloaded to clean up Extensibles.
743 * This method is called once for every user and channel on the network,
744 * so that when your module unloads it may clear up any remaining data
745 * in the form of Extensibles added using Extensible::Extend().
746 * If the target_type variable is TYPE_USER, then void* item refers to
747 * a userrec*, otherwise it refers to a chanrec*.
748 * @param target_type The type of item being cleaned
749 * @param item A pointer to the item's class
751 virtual void OnCleanup(int target_type, void* item);
753 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
754 * have been applied. Please note that although you can see remote nickchanges through this function, you should
755 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
756 * check user->server before taking any action (including returning nonzero from the method).
757 * Because this method is called after the nickchange is taken place, no return values are possible
758 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
759 * @param user The user changing their nick
760 * @param oldnick The old nickname of the user before the nickchange
762 virtual void OnUserPostNick(userrec* user, std::string oldnick);
764 /** Called before an action which requires a channel privilage check.
765 * This function is called before many functions which check a users status on a channel, for example
766 * before opping a user, deopping a user, kicking a user, etc.
767 * There are several values for access_type which indicate for what reason access is being checked.
769 * AC_KICK (0) - A user is being kicked<br>
770 * AC_DEOP (1) - a user is being deopped<br>
771 * AC_OP (2) - a user is being opped<br>
772 * AC_VOICE (3) - a user is being voiced<br>
773 * AC_DEVOICE (4) - a user is being devoiced<br>
774 * AC_HALFOP (5) - a user is being halfopped<br>
775 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
776 * AC_INVITE (7) - a user is being invited<br>
777 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
778 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
779 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
780 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
781 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
782 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
783 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
784 * @param source The source of the access check
785 * @param dest The destination of the access check
786 * @param channel The channel which is being checked
787 * @param access_type See above
789 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
791 /** Called when a 005 numeric is about to be output.
792 * The module should modify the 005 numeric if needed to indicate its features.
793 * @param output The 005 string to be modified if neccessary.
795 virtual void On005Numeric(std::string &output);
797 /** Called when a client is disconnected by KILL.
798 * If a client is killed by a server, e.g. a nickname collision or protocol error,
800 * Return 1 from this function to prevent the kill, and 0 from this function to allow
801 * it as normal. If you prevent the kill no output will be sent to the client, it is
802 * down to your module to generate this information.
803 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
804 * If you do so youre risking race conditions, desyncs and worse!
805 * @param source The user sending the KILL
806 * @param dest The user being killed
807 * @param reason The kill reason
808 * @return 1 to prevent the kill, 0 to allow
810 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
812 /** Called when an oper wants to disconnect a remote user via KILL
813 * @param source The user sending the KILL
814 * @param dest The user being killed
815 * @param reason The kill reason
817 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
819 /** Called whenever a module is loaded.
820 * mod will contain a pointer to the module, and string will contain its name,
821 * for example m_widgets.so. This function is primary for dependency checking,
822 * your module may decide to enable some extra features if it sees that you have
823 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
824 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
825 * but instead operate under reduced functionality, unless the dependency is
826 * absolutely neccessary (e.g. a module that extends the features of another
828 * @param mod A pointer to the new module
829 * @param name The new module's filename
831 virtual void OnLoadModule(Module* mod,std::string name);
833 /** Called whenever a module is unloaded.
834 * mod will contain a pointer to the module, and string will contain its name,
835 * for example m_widgets.so. This function is primary for dependency checking,
836 * your module may decide to enable some extra features if it sees that you have
837 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
838 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
839 * but instead operate under reduced functionality, unless the dependency is
840 * absolutely neccessary (e.g. a module that extends the features of another
842 * @param mod Pointer to the module being unloaded (still valid)
843 * @param name The filename of the module being unloaded
845 virtual void OnUnloadModule(Module* mod,std::string name);
847 /** Called once every five seconds for background processing.
848 * This timer can be used to control timed features. Its period is not accurate
849 * enough to be used as a clock, but it is gauranteed to be called at least once in
850 * any five second period, directly from the main loop of the server.
851 * @param curtime The current timer derived from time(2)
853 virtual void OnBackgroundTimer(time_t curtime);
855 /** Called whenever a list is needed for a listmode.
856 * For example, when a /MODE #channel +b (without any other parameters) is called,
857 * if a module was handling +b this function would be called. The function can then
858 * output any lists it wishes to. Please note that all modules will see all mode
859 * characters to provide the ability to extend each other, so please only output
860 * a list if the mode character given matches the one(s) you want to handle.
861 * @param user The user requesting the list
862 * @param channel The channel the list is for
863 * @param mode The listmode which a list is being requested on
865 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
867 /** Called whenever any command is about to be executed.
868 * This event occurs for all registered commands, wether they are registered in the core,
869 * or another module, but it will not occur for invalid commands (e.g. ones which do not
870 * exist within the command table). By returning 1 from this method you may prevent the
871 * command being executed. If you do this, no output is created by the core, and it is
872 * down to your module to produce any output neccessary.
873 * Note that unless you return 1, you should not destroy any structures (e.g. by using
874 * Server::QuitUser) otherwise when the command's handler function executes after your
875 * method returns, it will be passed an invalid pointer to the user object and crash!)
876 * @param command The command being executed
877 * @param parameters An array of array of characters containing the parameters for the command
878 * @param pcnt The nuimber of parameters passed to the command
879 * @param user the user issuing the command
880 * @return 1 to block the command, 0 to allow
882 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
884 /** Called to check if a user who is connecting can now be allowed to register
885 * If any modules return false for this function, the user is held in the waiting
886 * state until all modules return true. For example a module which implements ident
887 * lookups will continue to return false for a user until their ident lookup is completed.
888 * Note that the registration timeout for a user overrides these checks, if the registration
889 * timeout is reached, the user is disconnected even if modules report that the user is
890 * not ready to connect.
891 * @param user The user to check
892 * @return true to indicate readiness, false if otherwise
894 virtual bool OnCheckReady(userrec* user);
896 /** Called whenever a user is about to register their connection (e.g. before the user
897 * is sent the MOTD etc). Modules can use this method if they are performing a function
898 * which must be done before the actual connection is completed (e.g. ident lookups,
899 * dnsbl lookups, etc).
900 * Note that you should NOT delete the user record here by causing a disconnection!
901 * Use OnUserConnect for that instead.
902 * @param user The user registering
904 virtual void OnUserRegister(userrec* user);
906 /** Called whenever a mode character is processed.
907 * Return 1 from this function to block the mode character from being processed entirely,
908 * so that you may perform your own code instead. Note that this method allows you to override
909 * modes defined by other modes, but this is NOT RECOMMENDED!
910 * @param user The user who is sending the mode
911 * @param chan The channel the mode is being sent to
912 * @param mode The mode character being set
913 * @param param The parameter for the mode or an empty string
914 * @param adding true of the mode is being added, false if it is being removed
915 * @param pcnt The parameter count for the mode (0 or 1)
916 * @return 1 to deny the mode, 0 to allow
918 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
920 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
921 * This method will always be called for each join, wether or not the channel is actually +i, and
922 * determines the outcome of an if statement around the whole section of invite checking code.
923 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
924 * @param user The user joining the channel
925 * @param chan The channel being joined
926 * @return 1 to explicitly allow the join, 0 to proceed as normal
928 virtual int OnCheckInvite(userrec* user, chanrec* chan);
930 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
931 * This method will always be called for each join, wether or not the channel is actually +k, and
932 * determines the outcome of an if statement around the whole section of key checking code.
933 * if the user specified no key, the keygiven string will be a valid but empty value.
934 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
935 * @param user The user joining the channel
936 * @param chan The channel being joined
937 * @return 1 to explicitly allow the join, 0 to proceed as normal
939 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
941 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
942 * This method will always be called for each join, wether or not the channel is actually +l, and
943 * determines the outcome of an if statement around the whole section of channel limit checking code.
944 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
945 * @param user The user joining the channel
946 * @param chan The channel being joined
947 * @return 1 to explicitly allow the join, 0 to proceed as normal
949 virtual int OnCheckLimit(userrec* user, chanrec* chan);
951 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
952 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
953 * determines the outcome of an if statement around the whole section of ban checking code.
954 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
955 * @param user The user joining the channel
956 * @param chan The channel being joined
957 * @return 1 to explicitly allow the join, 0 to proceed as normal
959 virtual int OnCheckBan(userrec* user, chanrec* chan);
961 /** Called on all /STATS commands
962 * This method is triggered for all /STATS use, including stats symbols handled by the core.
963 * @param symbol the symbol provided to /STATS
965 virtual void OnStats(char symbol);
967 /** Called whenever a change of a local users displayed host is attempted.
968 * Return 1 to deny the host change, or 0 to allow it.
969 * @param user The user whos host will be changed
970 * @param newhost The new hostname
971 * @return 1 to deny the host change, 0 to allow
973 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
975 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
976 * return 1 to deny the name change, or 0 to allow it.
977 * @param user The user whos GECOS will be changed
978 * @param newhost The new GECOS
979 * @return 1 to deny the GECOS change, 0 to allow
981 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
983 /** Called whenever a topic is changed by a local user.
984 * Return 1 to deny the topic change, or 0 to allow it.
985 * @param user The user changing the topic
986 * @param chan The channels who's topic is being changed
987 * @param topic The actual topic text
988 * @param 1 to block the topic change, 0 to allow
990 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
992 /** Called whenever a local topic has been changed.
993 * To block topic changes you must use OnLocalTopicChange instead.
994 * @param user The user changing the topic
995 * @param chan The channels who's topic is being changed
996 * @param topic The actual topic text
998 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
1000 /** Called whenever an Event class is sent to all module by another module.
1001 * Please see the documentation of Event::Send() for further information. The Event sent can
1002 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
1003 * before doing anything to the event data, and you should *not* change the event data in any way!
1004 * @param event The Event class being received
1006 virtual void OnEvent(Event* event);
1008 /** Called whenever a Request class is sent to your module by another module.
1009 * Please see the documentation of Request::Send() for further information. The Request sent
1010 * can always be assumed to be non-NULL, you should not change the request object or its data.
1011 * Your method may return arbitary data in the char* result which the requesting module
1012 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
1013 * @param request The Request class being received
1015 virtual char* OnRequest(Request* request);
1017 /** Called whenever an oper password is to be compared to what a user has input.
1018 * The password field (from the config file) is in 'password' and is to be compared against
1019 * 'input'. This method allows for encryption of oper passwords and much more besides.
1020 * You should return a nonzero value if you want to allow the comparison or zero if you wish
1022 * @param password The oper's password
1023 * @param input The password entered
1024 * @return 1 to match the passwords, 0 to do nothing
1026 virtual int OnOperCompare(std::string password, std::string input);
1028 /** Called whenever a user is given usermode +o, anywhere on the network.
1029 * You cannot override this and prevent it from happening as it is already happened and
1030 * such a task must be performed by another server. You can however bounce modes by sending
1031 * servermodes out to reverse mode changes.
1032 * @param user The user who is opering
1034 virtual void OnGlobalOper(userrec* user);
1036 /** Called whenever a user connects, anywhere on the network.
1037 * This event is informational only. You should not change any user information in this
1038 * event. To do so, use the OnUserConnect method to change the state of local users.
1039 * @param user The user who is connecting
1041 virtual void OnGlobalConnect(userrec* user);
1043 /** Called whenever a ban is added to a channel's list.
1044 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1045 * @param source The user adding the ban
1046 * @param channel The channel the ban is being added to
1047 * @param banmask The ban mask being added
1048 * @return 1 to block the ban, 0 to continue as normal
1050 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1052 /** Called whenever a ban is removed from a channel's list.
1053 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1054 * @param source The user deleting the ban
1055 * @param channel The channel the ban is being deleted from
1056 * @param banmask The ban mask being deleted
1057 * @return 1 to block the unban, 0 to continue as normal
1059 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1061 /** Called immediately after any connection is accepted. This is intended for raw socket
1062 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1063 * no information relating to a user record as the connection has not been assigned yet.
1064 * There are no return values from this call as all modules get an opportunity if required to
1065 * process the connection.
1066 * @param fd The file descriptor returned from accept()
1067 * @param ip The IP address of the connecting user
1068 * @param localport The local port number the user connected to
1070 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1072 /** Called immediately before any write() operation on a user's socket in the core. Because
1073 * this event is a low level event no user information is associated with it. It is intended
1074 * for use by modules which may wrap connections within another API such as SSL for example.
1075 * return a non-zero result if you have handled the write operation, in which case the core
1076 * will not call write().
1077 * @param fd The file descriptor of the socket
1078 * @param buffer A char* buffer being written
1079 * @param Number of characters to write
1080 * @return Number of characters actually written or 0 if you didn't handle the operation
1082 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1084 /** Called immediately before any socket is closed. When this event is called, shutdown()
1085 * has not yet been called on the socket.
1086 * @param fd The file descriptor of the socket prior to close()
1088 virtual void OnRawSocketClose(int fd);
1090 /** Called immediately before any read() operation on a client socket in the core.
1091 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1092 * when this event occurs.
1093 * Your event should return 1 if it has handled the reading itself, which prevents the core
1094 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1095 * the value of count. The value of readresult must be identical to an actual result that might
1096 * be returned from the read() system call, for example, number of bytes read upon success,
1097 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1098 * you MUST set readresult.
1099 * @param fd The file descriptor of the socket
1100 * @param buffer A char* buffer being read to
1101 * @param count The size of the buffer
1102 * @param readresult The amount of characters read, or 0
1103 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1105 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1109 /** Allows server output and query functions
1110 * This class contains methods which allow a module to query the state of the irc server, and produce
1111 * output to users and other servers. All modules should instantiate at least one copy of this class,
1112 * and use its member functions to perform their tasks.
1114 class Server : public classbase
1117 /** Default constructor.
1118 * Creates a Server object.
1121 /** Default destructor.
1122 * Destroys a Server object.
1125 /** Obtains a pointer to the server's ServerConfig object.
1126 * The ServerConfig object contains most of the configuration data
1127 * of the IRC server, as read from the config file by the core.
1129 ServerConfig* GetConfig();
1130 /** Sends text to all opers.
1131 * This method sends a server notice to all opers with the usermode +s.
1133 virtual void SendOpers(std::string s);
1134 /** Returns the version string of this server
1136 std::string GetVersion();
1137 /** Writes a log string.
1138 * This method writes a line of text to the log. If the level given is lower than the
1139 * level given in the configuration, this command has no effect.
1141 virtual void Log(int level, std::string s);
1142 /** Sends a line of text down a TCP/IP socket.
1143 * This method writes a line of text to an established socket, cutting it to 510 characters
1144 * plus a carriage return and linefeed if required.
1146 virtual void Send(int Socket, std::string s);
1147 /** Sends text from the server to a socket.
1148 * This method writes a line of text to an established socket, with the servername prepended
1149 * as used by numerics (see RFC 1459)
1151 virtual void SendServ(int Socket, std::string s);
1152 /** Writes text to a channel, but from a server, including all.
1153 * This can be used to send server notices to a group of users.
1155 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1156 /** Sends text from a user to a socket.
1157 * This method writes a line of text to an established socket, with the given user's nick/ident
1158 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1160 virtual void SendFrom(int Socket, userrec* User, std::string s);
1161 /** Sends text from a user to another user.
1162 * This method writes a line of text to a user, with a user's nick/ident
1163 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1164 * If you specify NULL as the source, then the data will originate from the
1165 * local server, e.g. instead of:
1167 * :user!ident@host TEXT
1169 * The format will become:
1173 * Which is useful for numerics and server notices to single users, etc.
1175 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1176 /** Sends text from a user to a channel (mulicast).
1177 * This method writes a line of text to a channel, with the given user's nick/ident
1178 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1179 * IncludeSender flag is set, then the text is also sent back to the user from which
1180 * it originated, as seen in MODE (see RFC 1459).
1182 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1183 /** Returns true if two users share a common channel.
1184 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1187 virtual bool CommonChannels(userrec* u1, userrec* u2);
1188 /** Sends text from a user to one or more channels (mulicast).
1189 * This method writes a line of text to all users which share a common channel with a given
1190 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1191 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1192 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1193 * is only sent to the other recipients, as seen in QUIT.
1195 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1196 /** Sends a WALLOPS message.
1197 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1200 virtual void SendWallops(userrec* User, std::string text);
1202 /** Returns true if a nick is valid.
1203 * Nicks for unregistered connections will return false.
1205 virtual bool IsNick(std::string nick);
1206 /** Returns a count of the number of users on a channel.
1207 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1209 virtual int CountUsers(chanrec* c);
1210 /** Attempts to look up a nick and return a pointer to it.
1211 * This function will return NULL if the nick does not exist.
1213 virtual userrec* FindNick(std::string nick);
1214 /** Attempts to look up a nick using the file descriptor associated with that nick.
1215 * This function will return NULL if the file descriptor is not associated with a valid user.
1217 virtual userrec* FindDescriptor(int socket);
1218 /** Attempts to look up a channel and return a pointer to it.
1219 * This function will return NULL if the channel does not exist.
1221 virtual chanrec* FindChannel(std::string channel);
1222 /** Attempts to look up a user's privilages on a channel.
1223 * This function will return a string containing either @, %, +, or an empty string,
1224 * representing the user's privilages upon the channel you specify.
1226 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1227 /** Checks if a user is on a channel.
1228 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1230 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1231 /** Returns the server name of the server where the module is loaded.
1233 virtual std::string GetServerName();
1234 /** Returns the network name, global to all linked servers.
1236 virtual std::string GetNetworkName();
1237 /** Returns the server description string of the local server
1239 virtual std::string GetServerDescription();
1240 /** Returns the information of the server as returned by the /ADMIN command.
1241 * See the Admin class for further information of the return value. The members
1242 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1243 * server where the module is loaded.
1245 virtual Admin GetAdmin();
1246 /** Adds an extended mode letter which is parsed by a module.
1247 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1248 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1249 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1250 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1251 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1252 * params_when_on is the number of modes to expect when the mode is turned on
1253 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1254 * the params_when_off value has a similar value to params_when_on, except it indicates
1255 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1256 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1257 * use this parameter. The function returns false if the mode is unavailable, and will not
1258 * attempt to allocate another character, as this will confuse users. This also means that
1259 * as only one module can claim a specific mode character, the core does not need to keep track
1260 * of which modules own which modes, which speeds up operation of the server. In this version,
1261 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1264 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1266 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1267 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1270 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1272 * (2) They always take exactly one parameter when being added or removed
1274 * (3) They can be set multiple times, usually on users in channels
1276 * (4) The mode and its parameter are NOT stored in the channels modes structure
1278 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1279 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1280 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1281 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1282 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1283 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1284 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1285 * so the above example would become '+aa one three' after processing.
1287 virtual bool AddExtendedListMode(char modechar);
1289 /** Adds a command to the command table.
1290 * This allows modules to add extra commands into the command table. You must place a function within your
1291 * module which is is of type handlerfunc:
1293 * typedef void (handlerfunc) (char**, int, userrec*);
1295 * void handle_kill(char **parameters, int pcnt, userrec *user)
1297 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1298 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1299 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1300 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1301 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1302 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1303 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1306 virtual void AddCommand(command_t *f);
1308 /** Sends a servermode.
1309 * you must format the parameters array with the target, modes and parameters for those modes.
1315 * modes[0] = ChannelName;
1319 * modes[2] = user->nick;
1321 * Srv->SendMode(modes,3,user);
1323 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1324 * will be sent to the user you provide as the third parameter.
1325 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1326 * your server in an unstable state!
1329 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1331 /** Sends to all users matching a mode mask
1332 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1333 * or module provided modes, including ones provided by your own module.
1334 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1335 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1336 * for example, if you were to use:
1338 * Serv->SendToModeMask("xi", WM_OR, "m00");
1340 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1341 * user must have both modes set to receive the message.
1343 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1345 /** Forces a user to join a channel.
1346 * This is similar to svsjoin and can be used to implement redirection, etc.
1347 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1348 * On failure, the result is NULL.
1350 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1352 /** Forces a user to part a channel.
1353 * This is similar to svspart and can be used to implement redirection, etc.
1354 * Although the return value of this function is a pointer to a channel record, the returned data is
1355 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1357 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1359 /** Forces a user nickchange.
1360 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1361 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1362 * the error numeric for it.
1364 virtual void ChangeUserNick(userrec* user, std::string nickname);
1366 /** Forces a user to quit with the specified reason.
1367 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1368 * may bypass the quit prefix specified in the config file.
1372 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1373 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1374 * action after calling this method is to immediately bail from your handler.
1376 virtual void QuitUser(userrec* user, std::string reason);
1378 /** Matches text against a glob pattern.
1379 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1380 * Returns true if the literal successfully matches the pattern, false if otherwise.
1382 virtual bool MatchText(std::string sliteral, std::string spattern);
1384 /** Calls the handler for a command, either implemented by the core or by another module.
1385 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1386 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1387 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1388 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1389 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1390 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1391 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1392 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1393 * used for privilage checks, etc.
1395 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1397 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1399 /** Change displayed hostname of a user.
1400 * You should always call this method to change a user's host rather than writing directly to the
1401 * dhost member of userrec, as any change applied via this method will be propogated to any
1404 virtual void ChangeHost(userrec* user, std::string host);
1406 /** Change GECOS (fullname) of a user.
1407 * You should always call this method to change a user's GECOS rather than writing directly to the
1408 * fullname member of userrec, as any change applied via this method will be propogated to any
1411 virtual void ChangeGECOS(userrec* user, std::string gecos);
1413 /** Returns true if the servername you give is ulined.
1414 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1415 * change modes of clients which are on remote servers and set modes of channels where there are
1416 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
1417 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
1418 * case of normal servers, as many ulined server types (such as services) do not support meshed
1419 * links and must operate in this manner.
1421 virtual bool IsUlined(std::string server);
1423 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1424 * chanrec due to include constraints.
1426 virtual chanuserlist GetUsers(chanrec* chan);
1428 /** Remove a user's connection to the irc server, but leave their client in existence in the
1429 * user hash. When you call this function, the user's file descriptor will be replaced with the
1430 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1431 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1432 * After this call, the pointer to user will be invalid.
1434 virtual bool UserToPseudo(userrec* user,std::string message);
1436 /** This user takes one user, and switches their file descriptor with another user, so that one user
1437 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1438 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1439 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1440 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1442 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1445 * The G-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 AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1454 * The Q-line is propogated to all of the servers in the mesh and 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 AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1463 * The Z-line is propogated to all of the servers in the mesh and 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 AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1472 * The K-line is enforced as soon as it is added.
1473 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1474 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1475 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1478 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1481 * The E-line is enforced as soon as it is added.
1482 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1483 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1484 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1487 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1489 /** Deletes a G-Line from all servers on the mesh
1491 virtual bool DelGLine(std::string hostmask);
1493 /** Deletes a Q-Line from all servers on the mesh
1495 virtual bool DelQLine(std::string nickname);
1497 /** Deletes a Z-Line from all servers on the mesh
1499 virtual bool DelZLine(std::string ipaddr);
1501 /** Deletes a local K-Line
1503 virtual bool DelKLine(std::string hostmask);
1505 /** Deletes a local E-Line
1507 virtual bool DelELine(std::string hostmask);
1509 /** Calculates a duration
1510 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1511 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1514 virtual long CalcDuration(std::string duration);
1516 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1518 virtual bool IsValidMask(std::string mask);
1520 /** This function finds a module by name.
1521 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1522 * the function will return NULL.
1524 virtual Module* FindModule(std::string name);
1526 /** Adds a class derived from InspSocket to the server's socket engine.
1528 virtual void AddSocket(InspSocket* sock);
1530 /** Deletes a class derived from InspSocket from the server's socket engine.
1532 virtual void DelSocket(InspSocket* sock);
1534 virtual void RehashServer();
1538 #define CONF_NOT_A_NUMBER 0x000010
1539 #define CONF_NOT_UNSIGNED 0x000080
1540 #define CONF_VALUE_NOT_FOUND 0x000100
1541 #define CONF_FILE_NOT_FOUND 0x000200
1544 /** Allows reading of values from configuration files
1545 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1546 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1547 * Constructing the class using one parameter allows you to specify a path to your own configuration
1548 * file, otherwise, inspircd.conf is read.
1550 class ConfigReader : public classbase
1553 /** The contents of the configuration file
1554 * This protected member should never be accessed by a module (and cannot be accessed unless the
1555 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1556 * (such as comments) stripped from it.
1558 std::stringstream *cache;
1559 std::stringstream *errorlog;
1560 /** Used to store errors
1566 /** Default constructor.
1567 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1568 * as specified when running ./configure.
1570 ConfigReader(); // default constructor reads ircd.conf
1571 /** Overloaded constructor.
1572 * This constructor initialises the ConfigReader class to read a user-specified config file
1574 ConfigReader(std::string filename); // read a module-specific config
1575 /** Default destructor.
1576 * This method destroys the ConfigReader class.
1579 /** Retrieves a value from the config file.
1580 * This method retrieves a value from the config file. Where multiple copies of the tag
1581 * exist in the config file, index indicates which of the values to retrieve.
1583 std::string ReadValue(std::string tag, std::string name, int index);
1584 /** Retrieves a boolean value from the config file.
1585 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1586 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1587 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1589 bool ReadFlag(std::string tag, std::string name, int index);
1590 /** Retrieves an integer value from the config file.
1591 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1592 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1593 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1594 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1595 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1596 * will return CONF_NOT_UNSIGNED
1598 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1599 /** Returns the last error to occur.
1600 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1601 * A call to GetError() resets the error flag back to 0.
1604 /** Counts the number of times a given tag appears in the config file.
1605 * This method counts the number of times a tag appears in a config file, for use where
1606 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1607 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1608 * multiple instance tag.
1610 int Enumerate(std::string tag);
1611 /** Returns true if a config file is valid.
1612 * This method is partially implemented and will only return false if the config
1613 * file does not exist or could not be opened.
1616 /** Dumps the list of errors in a config file to an output location. If bail is true,
1617 * then the program will abort. If bail is false and user points to a valid user
1618 * record, the error report will be spooled to the given user by means of NOTICE.
1619 * if bool is false AND user is false, the error report will be spooled to all opers
1620 * by means of a NOTICE to all opers.
1622 void DumpErrors(bool bail,userrec* user);
1624 /** Returns the number of items within a tag.
1625 * For example if the tag was <test tag="blah" data="foo"> then this
1626 * function would return 2. Spaces and newlines both qualify as valid seperators
1629 int EnumerateValues(std::string tag, int index);
1634 /** Caches a text file into memory and can be used to retrieve lines from it.
1635 * This class contains methods for read-only manipulation of a text file in memory.
1636 * Either use the constructor type with one parameter to load a file into memory
1637 * at construction, or use the LoadFile method to load a file.
1639 class FileReader : public classbase
1643 /** Default constructor.
1644 * This method does not load any file into memory, you must use the LoadFile method
1645 * after constructing the class this way.
1649 /** Secondary constructor.
1650 * This method initialises the class with a file loaded into it ready for GetLine and
1651 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1654 FileReader(std::string filename);
1656 /** Default destructor.
1657 * This deletes the memory allocated to the file.
1661 /** Used to load a file.
1662 * This method loads a file into the class ready for GetLine and
1663 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1666 void LoadFile(std::string filename);
1668 /** Returns true if the file exists
1669 * This function will return false if the file could not be opened.
1673 /** Retrieve one line from the file.
1674 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1675 * the index was out of bounds, or the line had no data on it.
1677 std::string GetLine(int x);
1679 /** Returns the size of the file in lines.
1680 * This method returns the number of lines in the read file. If it is 0, no lines have been
1681 * read into memory, either because the file is empty or it does not exist, or cannot be
1682 * opened due to permission problems.
1688 /** Instantiates classes inherited from Module
1689 * This class creates a class inherited from type Module, using new. This is to allow for modules
1690 * to create many different variants of Module, dependent on architecture, configuration, etc.
1691 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1694 class ModuleFactory : public classbase
1698 virtual ~ModuleFactory() { }
1699 /** Creates a new module.
1700 * Your inherited class of ModuleFactory must return a pointer to your Module class
1701 * using this method.
1703 virtual Module * CreateModule(Server* Me) = 0;
1707 typedef DLLFactory<ModuleFactory> ircd_module;
1709 bool ModeDefined(char c, int i);
1710 bool ModeDefinedOper(char c, int i);
1711 int ModeDefinedOn(char c, int i);
1712 int ModeDefinedOff(char c, int i);
1713 void ModeMakeList(char modechar);
1714 bool ModeIsListMode(char modechar, int type);