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.
234 /** Base class for all InspIRCd modules
235 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
236 * its methods will be called when irc server events occur. class inherited from module must be
237 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
239 class Module : public classbase
243 /** Default constructor
244 * Creates a module class.
245 * @param Me An instance of the Server class which can be saved for future use
249 /** Default destructor
250 * destroys a module class
254 /** Returns the version number of a Module.
255 * The method should return a Version object with its version information assigned via
258 virtual Version GetVersion();
260 /** Called when a user connects.
261 * The details of the connecting user are available to you in the parameter userrec *user
262 * @param user The user who is connecting
264 virtual void OnUserConnect(userrec* user);
266 /** Called when a user quits.
267 * The details of the exiting user are available to you in the parameter userrec *user
268 * This event is only called when the user is fully registered when they quit. To catch
269 * raw disconnections, use the OnUserDisconnect method.
270 * @param user The user who is quitting
271 * @param message The user's quit message
273 virtual void OnUserQuit(userrec* user, std::string message);
275 /** Called whenever a user's socket is closed.
276 * The details of the exiting user are available to you in the parameter userrec *user
277 * This event is called for all users, registered or not, as a cleanup method for modules
278 * which might assign resources to user, such as dns lookups, objects and sockets.
279 * @param user The user who is disconnecting
281 virtual void OnUserDisconnect(userrec* user);
283 /** Called when a user joins a channel.
284 * The details of the joining user are available to you in the parameter userrec *user,
285 * and the details of the channel they have joined is available in the variable chanrec *channel
286 * @param user The user who is joining
287 * @param channel The channel being joined
289 virtual void OnUserJoin(userrec* user, chanrec* channel);
291 /** Called when a user parts a channel.
292 * The details of the leaving user are available to you in the parameter userrec *user,
293 * and the details of the channel they have left is available in the variable chanrec *channel
294 * @param user The user who is parting
295 * @param channel The channel being parted
297 virtual void OnUserPart(userrec* user, chanrec* channel);
299 /** Called on rehash.
300 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
301 * system. You should use it to reload any files so that your module keeps in step with the
302 * rest of the application. If a parameter is given, the core has done nothing. The module
303 * receiving the event can decide if this parameter has any relevence to it.
304 * @param parameter The (optional) parameter given to REHASH from the user.
306 virtual void OnRehash(std::string parameter);
308 /** Called when a raw command is transmitted or received.
309 * This method is the lowest level of handler available to a module. It will be called with raw
310 * data which is passing through a connected socket. If you wish, you may munge this data by changing
311 * the string parameter "raw". If you do this, after your function exits it will immediately be
312 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
313 * inbound is set to true) the value of user will be the userrec of the connection sending the
314 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
315 * @param raw The raw string in RFC1459 format
316 * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
317 * @param user The user record sending the text, when inbound == true.
319 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
321 /** Called whenever an extended mode is to be processed.
322 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
323 * changed. mode_on is set when the mode is being set, in which case params contains a list of
324 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
325 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
326 * was set up with Server::AddExtendedMode
327 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
328 * You must cast this value yourself to make use of it.
329 * @param user The user issuing the mode
330 * @param target The user or channel having the mode set on them
331 * @param modechar The mode character being set
332 * @param type The type of mode (user or channel) being set
333 * @param mode_on True if the mode is being set, false if it is being unset
334 * @param params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)
336 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
338 /** Called whenever a user is about to join a channel, before any processing is done.
339 * Returning a value of 1 from this function stops the process immediately, causing no
340 * output to be sent to the user by the core. If you do this you must produce your own numerics,
341 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
342 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
346 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
347 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
348 * processing on the actual channel record at this point, however the channel NAME will still be passed in
349 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
350 * @param user The user joining the channel
351 * @param cname The channel name being joined
352 * @return 1 To prevent the join, 0 to allow it.
354 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
356 /** Called whenever a user is about to be kicked.
357 * Returning a value of 1 from this function stops the process immediately, causing no
358 * output to be sent to the user by the core. If you do this you must produce your own numerics,
360 * @param source The user issuing the kick
361 * @param user The user being kicked
362 * @param chan The channel the user is being kicked from
363 * @param reason The kick reason
364 * @return 1 to prevent the kick, 0 to allow it
366 virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
368 /** Called whenever a user is kicked.
369 * If this method is called, the kick is already underway and cannot be prevented, so
370 * to prevent a kick, please use Module::OnUserPreKick instead of this method.
371 * @param source The user issuing the kick
372 * @param user The user being kicked
373 * @param chan The channel the user is being kicked from
374 * @param reason The kick reason
376 virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
378 /** Called whenever a user opers locally.
379 * The userrec will contain the oper mode 'o' as this function is called after any modifications
380 * are made to the user's structure by the core.
381 * @param user The user who is opering up
382 * @param opertype The opers type name
384 virtual void OnOper(userrec* user, std::string opertype);
386 /** Called whenever a user types /INFO.
387 * The userrec will contain the information of the user who typed the command. Modules may use this
388 * method to output their own credits in /INFO (which is the ircd's version of an about box).
389 * It is purposefully not possible to modify any info that has already been output, or halt the list.
390 * You must write a 371 numeric to the user, containing your info in the following format:
392 * <nick> :information here
394 * @param user The user issuing /INFO
396 virtual void OnInfo(userrec* user);
398 /** Called whenever a /WHOIS is performed on a local user.
399 * The source parameter contains the details of the user who issued the WHOIS command, and
400 * the dest parameter contains the information of the user they are whoising.
401 * @param source The user issuing the WHOIS command
402 * @param dest The user who is being WHOISed
404 virtual void OnWhois(userrec* source, userrec* dest);
406 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
407 * Returning 1 from this function stops the process immediately, causing no
408 * output to be sent to the user by the core. If you do this you must produce your own numerics,
409 * notices etc. This is useful for modules which may want to filter invites to channels.
410 * @param source The user who is issuing the INVITE
411 * @param dest The user being invited
412 * @param channel The channel the user is being invited to
413 * @return 1 to deny the invite, 0 to allow
415 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
417 /** Called after a user has been successfully invited to a channel.
418 * You cannot prevent the invite from occuring using this function, to do that,
419 * use OnUserPreInvite instead.
420 * @param source The user who is issuing the INVITE
421 * @param dest The user being invited
422 * @param channel The channel the user is being invited to
424 virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
426 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
427 * Returning any nonzero value from this function stops the process immediately, causing no
428 * output to be sent to the user by the core. If you do this you must produce your own numerics,
429 * notices etc. This is useful for modules which may want to filter or redirect messages.
430 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
431 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
432 * of where the message is destined to be sent.
433 * @param user The user sending the message
434 * @param dest The target of the message (chanrec* or userrec*)
435 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
436 * @param text Changeable text being sent by the user
437 * @return 1 to deny the NOTICE, 0 to allow it
439 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
441 /** Called whenever a user is about to NOTICE 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 * You may alter the message text as you wish before relinquishing control to the next module
449 * in the chain, and if no other modules block the text this altered form of the text will be sent out
450 * to the user and possibly to other servers.
451 * @param user The user sending the message
452 * @param dest The target of the message (chanrec* or userrec*)
453 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
454 * @param text Changeable text being sent by the user
455 * @return 1 to deny the NOTICE, 0 to allow it
457 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
459 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
460 * Please note that although you can see remote nickchanges through this function, you should
461 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
462 * check user->server before taking any action (including returning nonzero from the method).
463 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
464 * module to generate some meaninful output.
465 * @param user The username changing their nick
466 * @param newnick Their new nickname
467 * @return 1 to deny the change, 0 to allow
469 virtual int OnUserPreNick(userrec* user, std::string newnick);
471 /** Called after any PRIVMSG sent from a user.
472 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
473 * if target_type is TYPE_CHANNEL.
474 * @param user The user sending the message
475 * @param dest The target of the message
476 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
477 * @param text the text being sent by the user
479 virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
481 /** Called after any NOTICE sent from a user.
482 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
483 * if target_type is TYPE_CHANNEL.
484 * @param user The user sending the message
485 * @param dest The target of the message
486 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
487 * @param text the text being sent by the user
489 virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
491 /** Called after every MODE command sent from a user
492 * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
493 * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
494 * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
495 * @param user The user sending the MODEs
496 * @param dest The target of the modes (userrec* or chanrec*)
497 * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
498 * @param text The actual modes and their parameters if any
500 virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
502 /** Allows modules to alter or create server descriptions
503 * Whenever a module requires a server description, for example for display in
504 * WHOIS, this function is called in all modules. You may change or define the
505 * description given in std::string &description. If you do, this description
506 * will be shown in the WHOIS fields.
507 * @param servername The servername being searched for
508 * @param description Alterable server description for this server
510 virtual void OnGetServerDescription(std::string servername,std::string &description);
512 /** Allows modules to synchronize data which relates to users during a netburst.
513 * When this function is called, it will be called from the module which implements
514 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
515 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
516 * (see below). This function will be called for every user visible on your side
517 * of the burst, allowing you to for example set modes, etc. Do not use this call to
518 * synchronize data which you have stored using class Extensible -- There is a specialist
519 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
520 * @param user The user being syncronized
521 * @param proto A pointer to the module handling network protocol
522 * @param opaque An opaque pointer set by the protocol module, should not be modified!
524 virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
526 /** Allows modules to synchronize data which relates to channels during a netburst.
527 * When this function is called, it will be called from the module which implements
528 * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
529 * is given in Module* proto, so that you may call its methods such as ProtoSendMode
530 * (see below). This function will be called for every user visible on your side
531 * of the burst, allowing you to for example set modes, etc. Do not use this call to
532 * synchronize data which you have stored using class Extensible -- There is a specialist
533 * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
535 * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
537 * @param chan The channel being syncronized
538 * @param proto A pointer to the module handling network protocol
539 * @param opaque An opaque pointer set by the protocol module, should not be modified!
541 virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
543 /* Allows modules to syncronize metadata related to channels over the network during a netburst.
544 * Whenever the linking module wants to send out data, but doesnt know what the data
545 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
546 * this method is called.You should use the ProtoSendMetaData function after you've
547 * correctly decided how the data should be represented, to send the metadata on its way if it belongs
548 * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
549 * @param chan The channel whos metadata is being syncronized
550 * @param proto A pointer to the module handling network protocol
551 * @param opaque An opaque pointer set by the protocol module, should not be modified!
552 * @param extname The extensions name which is being searched for
554 virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
556 /* Allows modules to syncronize metadata related to users over the network during a netburst.
557 * Whenever the linking module wants to send out data, but doesnt know what the data
558 * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
559 * this method is called. You should use the ProtoSendMetaData function after you've
560 * correctly decided how the data should be represented, to send the metadata on its way if
561 * if it belongs to your module.
562 * @param user The user whos metadata is being syncronized
563 * @param proto A pointer to the module handling network protocol
564 * @param opaque An opaque pointer set by the protocol module, should not be modified!
565 * @param extname The extensions name which is being searched for
567 virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
569 /** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
570 * Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
571 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
572 * @param target The chanrec* or userrec* that data should be added to
573 * @param extname The extension name which is being sent
574 * @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
576 virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
578 /** Implemented by modules which provide the ability to link servers.
579 * These modules will implement this method, which allows transparent sending of servermodes
580 * down the network link as a broadcast, without a module calling it having to know the format
581 * of the MODE command before the actual mode string.
583 * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
584 * of how to use this function.
586 * @param opaque An opaque pointer set by the protocol module, should not be modified!
587 * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
588 * @param target The chanrec* or userrec* that modes should be sent for
589 * @param modeline The modes and parameters to be sent
591 virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
593 /** Implemented by modules which provide the ability to link servers.
594 * These modules will implement this method, which allows metadata (extra data added to
595 * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
596 * to other servers on a netburst and decoded at the other end by the same module on a
599 * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
600 * 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 metadata should be sent for
604 * @param extname The extension name to send metadata for
605 * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
607 virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
609 /** Called after every WALLOPS command.
610 * @param user The user sending the WALLOPS
611 * @param text The content of the WALLOPS message
613 virtual void OnWallops(userrec* user, std::string text);
615 /** Called whenever a user's hostname is changed.
616 * This event triggers after the host has been set.
617 * @param user The user whos host is being changed
618 * @param newhost The new hostname being set
620 virtual void OnChangeHost(userrec* user, std::string newhost);
622 /** Called whenever a user's GECOS (realname) is changed.
623 * This event triggers after the name has been set.
624 * @param user The user who's GECOS is being changed
625 * @param gecos The new GECOS being set on the user
627 virtual void OnChangeName(userrec* user, std::string gecos);
629 /** Called whenever a gline is added by a local user.
630 * This method is triggered after the line is added.
631 * @param duration The duration of the line in seconds
632 * @param source The sender of the line
633 * @param reason The reason text to be displayed
634 * @param hostmask The hostmask to add
636 virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
638 /** Called whenever a zline is added by a local user.
639 * This method is triggered after the line is added.
640 * @param duration The duration of the line in seconds
641 * @param source The sender of the line
642 * @param reason The reason text to be displayed
643 * @param ipmask The hostmask to add
645 virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
647 /** Called whenever a kline is added by a local user.
648 * This method is triggered after the line is added.
649 * @param duration The duration of the line in seconds
650 * @param source The sender of the line
651 * @param reason The reason text to be displayed
652 * @param hostmask The hostmask to add
654 virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
656 /** Called whenever a qline is added by a local user.
657 * This method is triggered after the line is added.
658 * @param duration The duration of the line in seconds
659 * @param source The sender of the line
660 * @param reason The reason text to be displayed
661 * @param nickmask The hostmask to add
663 virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
665 /** Called whenever a eline is added by a local user.
666 * This method is triggered after the line is added.
667 * @param duration The duration of the line in seconds
668 * @param source The sender of the line
669 * @param reason The reason text to be displayed
670 * @param hostmask The hostmask to add
672 virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
674 /** Called whenever a gline is deleted.
675 * This method is triggered after the line is deleted.
676 * @param source The user removing the line
677 * @param hostmask The hostmask to delete
679 virtual void OnDelGLine(userrec* source, std::string hostmask);
681 /** Called whenever a zline is deleted.
682 * This method is triggered after the line is deleted.
683 * @param source The user removing the line
684 * @param hostmask The hostmask to delete
686 virtual void OnDelZLine(userrec* source, std::string ipmask);
688 /** Called whenever a kline is deleted.
689 * This method is triggered after the line is deleted.
690 * @param source The user removing the line
691 * @param hostmask The hostmask to delete
693 virtual void OnDelKLine(userrec* source, std::string hostmask);
695 /** Called whenever a qline is deleted.
696 * This method is triggered after the line is deleted.
697 * @param source The user removing the line
698 * @param hostmask The hostmask to delete
700 virtual void OnDelQLine(userrec* source, std::string nickmask);
702 /** Called whenever a eline is deleted.
703 * This method is triggered after the line is deleted.
704 * @param source The user removing the line
705 * @param hostmask The hostmask to delete
707 virtual void OnDelELine(userrec* source, std::string hostmask);
709 /** Called before your module is unloaded to clean up Extensibles.
710 * This method is called once for every user and channel on the network,
711 * so that when your module unloads it may clear up any remaining data
712 * in the form of Extensibles added using Extensible::Extend().
713 * If the target_type variable is TYPE_USER, then void* item refers to
714 * a userrec*, otherwise it refers to a chanrec*.
715 * @param target_type The type of item being cleaned
716 * @param item A pointer to the item's class
718 virtual void OnCleanup(int target_type, void* item);
720 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
721 * have been applied. Please note that although you can see remote nickchanges through this function, you should
722 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
723 * check user->server before taking any action (including returning nonzero from the method).
724 * Because this method is called after the nickchange is taken place, no return values are possible
725 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
726 * @param user The user changing their nick
727 * @param oldnick The old nickname of the user before the nickchange
729 virtual void OnUserPostNick(userrec* user, std::string oldnick);
731 /** Called before an action which requires a channel privilage check.
732 * This function is called before many functions which check a users status on a channel, for example
733 * before opping a user, deopping a user, kicking a user, etc.
734 * There are several values for access_type which indicate for what reason access is being checked.
736 * AC_KICK (0) - A user is being kicked<br>
737 * AC_DEOP (1) - a user is being deopped<br>
738 * AC_OP (2) - a user is being opped<br>
739 * AC_VOICE (3) - a user is being voiced<br>
740 * AC_DEVOICE (4) - a user is being devoiced<br>
741 * AC_HALFOP (5) - a user is being halfopped<br>
742 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
743 * AC_INVITE (7) - a user is being invited<br>
744 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
745 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
746 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
747 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
748 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
749 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
750 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
751 * @param source The source of the access check
752 * @param dest The destination of the access check
753 * @param channel The channel which is being checked
754 * @param access_type See above
756 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
758 /** Called when a 005 numeric is about to be output.
759 * The module should modify the 005 numeric if needed to indicate its features.
760 * @param output The 005 string to be modified if neccessary.
762 virtual void On005Numeric(std::string &output);
764 /** Called when a client is disconnected by KILL.
765 * If a client is killed by a server, e.g. a nickname collision or protocol error,
767 * Return 1 from this function to prevent the kill, and 0 from this function to allow
768 * it as normal. If you prevent the kill no output will be sent to the client, it is
769 * down to your module to generate this information.
770 * NOTE: It is NOT advisable to stop kills which originate from servers or remote users.
771 * If you do so youre risking race conditions, desyncs and worse!
772 * @param source The user sending the KILL
773 * @param dest The user being killed
774 * @param reason The kill reason
775 * @return 1 to prevent the kill, 0 to allow
777 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
779 /** Called when an oper wants to disconnect a remote user via KILL
780 * @param source The user sending the KILL
781 * @param dest The user being killed
782 * @param reason The kill reason
784 virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
786 /** Called whenever a module is loaded.
787 * mod will contain a pointer to the module, and string will contain its name,
788 * for example m_widgets.so. This function is primary for dependency checking,
789 * your module may decide to enable some extra features if it sees that you have
790 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
791 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
792 * but instead operate under reduced functionality, unless the dependency is
793 * absolutely neccessary (e.g. a module that extends the features of another
795 * @param mod A pointer to the new module
796 * @param name The new module's filename
798 virtual void OnLoadModule(Module* mod,std::string name);
800 /** Called whenever a module is unloaded.
801 * mod will contain a pointer to the module, and string will contain its name,
802 * for example m_widgets.so. This function is primary for dependency checking,
803 * your module may decide to enable some extra features if it sees that you have
804 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
805 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
806 * but instead operate under reduced functionality, unless the dependency is
807 * absolutely neccessary (e.g. a module that extends the features of another
809 * @param mod Pointer to the module being unloaded (still valid)
810 * @param name The filename of the module being unloaded
812 virtual void OnUnloadModule(Module* mod,std::string name);
814 /** Called once every five seconds for background processing.
815 * This timer can be used to control timed features. Its period is not accurate
816 * enough to be used as a clock, but it is gauranteed to be called at least once in
817 * any five second period, directly from the main loop of the server.
818 * @param curtime The current timer derived from time(2)
820 virtual void OnBackgroundTimer(time_t curtime);
822 /** Called whenever a list is needed for a listmode.
823 * For example, when a /MODE #channel +b (without any other parameters) is called,
824 * if a module was handling +b this function would be called. The function can then
825 * output any lists it wishes to. Please note that all modules will see all mode
826 * characters to provide the ability to extend each other, so please only output
827 * a list if the mode character given matches the one(s) you want to handle.
828 * @param user The user requesting the list
829 * @param channel The channel the list is for
830 * @param mode The listmode which a list is being requested on
832 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
834 /** Called whenever any command is about to be executed.
835 * This event occurs for all registered commands, wether they are registered in the core,
836 * or another module, but it will not occur for invalid commands (e.g. ones which do not
837 * exist within the command table). By returning 1 from this method you may prevent the
838 * command being executed. If you do this, no output is created by the core, and it is
839 * down to your module to produce any output neccessary.
840 * Note that unless you return 1, you should not destroy any structures (e.g. by using
841 * Server::QuitUser) otherwise when the command's handler function executes after your
842 * method returns, it will be passed an invalid pointer to the user object and crash!)
843 * @param command The command being executed
844 * @param parameters An array of array of characters containing the parameters for the command
845 * @param pcnt The nuimber of parameters passed to the command
846 * @param user the user issuing the command
847 * @return 1 to block the command, 0 to allow
849 virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
851 /** Called to check if a user who is connecting can now be allowed to register
852 * If any modules return false for this function, the user is held in the waiting
853 * state until all modules return true. For example a module which implements ident
854 * lookups will continue to return false for a user until their ident lookup is completed.
855 * Note that the registration timeout for a user overrides these checks, if the registration
856 * timeout is reached, the user is disconnected even if modules report that the user is
857 * not ready to connect.
858 * @param user The user to check
859 * @return true to indicate readiness, false if otherwise
861 virtual bool OnCheckReady(userrec* user);
863 /** Called whenever a user is about to register their connection (e.g. before the user
864 * is sent the MOTD etc). Modules can use this method if they are performing a function
865 * which must be done before the actual connection is completed (e.g. ident lookups,
866 * dnsbl lookups, etc).
867 * Note that you should NOT delete the user record here by causing a disconnection!
868 * Use OnUserConnect for that instead.
869 * @param user The user registering
871 virtual void OnUserRegister(userrec* user);
873 /** Called whenever a mode character is processed.
874 * Return 1 from this function to block the mode character from being processed entirely,
875 * so that you may perform your own code instead. Note that this method allows you to override
876 * modes defined by other modes, but this is NOT RECOMMENDED!
877 * @param user The user who is sending the mode
878 * @param chan The channel the mode is being sent to
879 * @param mode The mode character being set
880 * @param param The parameter for the mode or an empty string
881 * @param adding true of the mode is being added, false if it is being removed
882 * @param pcnt The parameter count for the mode (0 or 1)
883 * @return 1 to deny the mode, 0 to allow
885 virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
887 /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
888 * This method will always be called for each join, wether or not the channel is actually +i, and
889 * determines the outcome of an if statement around the whole section of invite checking code.
890 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
891 * @param user The user joining the channel
892 * @param chan The channel being joined
893 * @return 1 to explicitly allow the join, 0 to proceed as normal
895 virtual int OnCheckInvite(userrec* user, chanrec* chan);
897 /** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
898 * This method will always be called for each join, wether or not the channel is actually +k, and
899 * determines the outcome of an if statement around the whole section of key checking code.
900 * if the user specified no key, the keygiven string will be a valid but empty value.
901 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
902 * @param user The user joining the channel
903 * @param chan The channel being joined
904 * @return 1 to explicitly allow the join, 0 to proceed as normal
906 virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
908 /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
909 * This method will always be called for each join, wether or not the channel is actually +l, and
910 * determines the outcome of an if statement around the whole section of channel limit checking code.
911 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
912 * @param user The user joining the channel
913 * @param chan The channel being joined
914 * @return 1 to explicitly allow the join, 0 to proceed as normal
916 virtual int OnCheckLimit(userrec* user, chanrec* chan);
918 /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
919 * This method will always be called for each join, wether or not the user actually matches a channel ban, and
920 * determines the outcome of an if statement around the whole section of ban checking code.
921 * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
922 * @param user The user joining the channel
923 * @param chan The channel being joined
924 * @return 1 to explicitly allow the join, 0 to proceed as normal
926 virtual int OnCheckBan(userrec* user, chanrec* chan);
928 /** Called on all /STATS commands
929 * This method is triggered for all /STATS use, including stats symbols handled by the core.
930 * @param symbol the symbol provided to /STATS
932 virtual void OnStats(char symbol);
934 /** Called whenever a change of a local users displayed host is attempted.
935 * Return 1 to deny the host change, or 0 to allow it.
936 * @param user The user whos host will be changed
937 * @param newhost The new hostname
938 * @return 1 to deny the host change, 0 to allow
940 virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
942 /** Called whenever a change of a local users GECOS (fullname field) is attempted.
943 * return 1 to deny the name change, or 0 to allow it.
944 * @param user The user whos GECOS will be changed
945 * @param newhost The new GECOS
946 * @return 1 to deny the GECOS change, 0 to allow
948 virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost);
950 /** Called whenever a topic is changed by a local user.
951 * Return 1 to deny the topic change, or 0 to allow it.
952 * @param user The user changing the topic
953 * @param chan The channels who's topic is being changed
954 * @param topic The actual topic text
955 * @param 1 to block the topic change, 0 to allow
957 virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
959 /** Called whenever a local topic has been changed.
960 * To block topic changes you must use OnLocalTopicChange instead.
961 * @param user The user changing the topic
962 * @param chan The channels who's topic is being changed
963 * @param topic The actual topic text
965 virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
967 /** Called whenever an Event class is sent to all module by another module.
968 * Please see the documentation of Event::Send() for further information. The Event sent can
969 * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
970 * before doing anything to the event data, and you should *not* change the event data in any way!
971 * @param event The Event class being received
973 virtual void OnEvent(Event* event);
975 /** Called whenever a Request class is sent to your module by another module.
976 * Please see the documentation of Request::Send() for further information. The Request sent
977 * can always be assumed to be non-NULL, you should not change the request object or its data.
978 * Your method may return arbitary data in the char* result which the requesting module
979 * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
980 * @param request The Request class being received
982 virtual char* OnRequest(Request* request);
984 /** Called whenever an oper password is to be compared to what a user has input.
985 * The password field (from the config file) is in 'password' and is to be compared against
986 * 'input'. This method allows for encryption of oper passwords and much more besides.
987 * You should return a nonzero value if you want to allow the comparison or zero if you wish
989 * @param password The oper's password
990 * @param input The password entered
991 * @return 1 to match the passwords, 0 to do nothing
993 virtual int OnOperCompare(std::string password, std::string input);
995 /** Called whenever a user is given usermode +o, anywhere on the network.
996 * You cannot override this and prevent it from happening as it is already happened and
997 * such a task must be performed by another server. You can however bounce modes by sending
998 * servermodes out to reverse mode changes.
999 * @param user The user who is opering
1001 virtual void OnGlobalOper(userrec* user);
1003 /** Called whenever a user connects, anywhere on the network.
1004 * This event is informational only. You should not change any user information in this
1005 * event. To do so, use the OnUserConnect method to change the state of local users.
1006 * @param user The user who is connecting
1008 virtual void OnGlobalConnect(userrec* user);
1010 /** Called whenever a ban is added to a channel's list.
1011 * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
1012 * @param source The user adding the ban
1013 * @param channel The channel the ban is being added to
1014 * @param banmask The ban mask being added
1015 * @return 1 to block the ban, 0 to continue as normal
1017 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
1019 /** Called whenever a ban is removed from a channel's list.
1020 * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
1021 * @param source The user deleting the ban
1022 * @param channel The channel the ban is being deleted from
1023 * @param banmask The ban mask being deleted
1024 * @return 1 to block the unban, 0 to continue as normal
1026 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
1028 /** Called immediately after any connection is accepted. This is intended for raw socket
1029 * processing (e.g. modules which wrap the tcp connection within another library) and provides
1030 * no information relating to a user record as the connection has not been assigned yet.
1031 * There are no return values from this call as all modules get an opportunity if required to
1032 * process the connection.
1033 * @param fd The file descriptor returned from accept()
1034 * @param ip The IP address of the connecting user
1035 * @param localport The local port number the user connected to
1037 virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
1039 /** Called immediately before any write() operation on a user's socket in the core. Because
1040 * this event is a low level event no user information is associated with it. It is intended
1041 * for use by modules which may wrap connections within another API such as SSL for example.
1042 * return a non-zero result if you have handled the write operation, in which case the core
1043 * will not call write().
1044 * @param fd The file descriptor of the socket
1045 * @param buffer A char* buffer being written
1046 * @param Number of characters to write
1047 * @return Number of characters actually written or 0 if you didn't handle the operation
1049 virtual int OnRawSocketWrite(int fd, char* buffer, int count);
1051 /** Called immediately before any socket is closed. When this event is called, shutdown()
1052 * has not yet been called on the socket.
1053 * @param fd The file descriptor of the socket prior to close()
1055 virtual void OnRawSocketClose(int fd);
1057 /** Called immediately before any read() operation on a client socket in the core.
1058 * This occurs AFTER the select() or poll() so there is always data waiting to be read
1059 * when this event occurs.
1060 * Your event should return 1 if it has handled the reading itself, which prevents the core
1061 * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
1062 * the value of count. The value of readresult must be identical to an actual result that might
1063 * be returned from the read() system call, for example, number of bytes read upon success,
1064 * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
1065 * you MUST set readresult.
1066 * @param fd The file descriptor of the socket
1067 * @param buffer A char* buffer being read to
1068 * @param count The size of the buffer
1069 * @param readresult The amount of characters read, or 0
1070 * @return nonzero if the event was handled, in which case readresult must be valid on exit
1072 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
1076 /** Allows server output and query functions
1077 * This class contains methods which allow a module to query the state of the irc server, and produce
1078 * output to users and other servers. All modules should instantiate at least one copy of this class,
1079 * and use its member functions to perform their tasks.
1081 class Server : public classbase
1084 /** Default constructor.
1085 * Creates a Server object.
1088 /** Default destructor.
1089 * Destroys a Server object.
1093 /** Sends text to all opers.
1094 * This method sends a server notice to all opers with the usermode +s.
1096 virtual void SendOpers(std::string s);
1097 /** Writes a log string.
1098 * This method writes a line of text to the log. If the level given is lower than the
1099 * level given in the configuration, this command has no effect.
1101 virtual void Log(int level, std::string s);
1102 /** Sends a line of text down a TCP/IP socket.
1103 * This method writes a line of text to an established socket, cutting it to 510 characters
1104 * plus a carriage return and linefeed if required.
1106 virtual void Send(int Socket, std::string s);
1107 /** Sends text from the server to a socket.
1108 * This method writes a line of text to an established socket, with the servername prepended
1109 * as used by numerics (see RFC 1459)
1111 virtual void SendServ(int Socket, std::string s);
1112 /** Writes text to a channel, but from a server, including all.
1113 * This can be used to send server notices to a group of users.
1115 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
1116 /** Sends text from a user to a socket.
1117 * This method writes a line of text to an established socket, with the given user's nick/ident
1118 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
1120 virtual void SendFrom(int Socket, userrec* User, std::string s);
1121 /** Sends text from a user to another user.
1122 * This method writes a line of text to a user, with a user's nick/ident
1123 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
1124 * If you specify NULL as the source, then the data will originate from the
1125 * local server, e.g. instead of:
1127 * :user!ident@host TEXT
1129 * The format will become:
1133 * Which is useful for numerics and server notices to single users, etc.
1135 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
1136 /** Sends text from a user to a channel (mulicast).
1137 * This method writes a line of text to a channel, with the given user's nick/ident
1138 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
1139 * IncludeSender flag is set, then the text is also sent back to the user from which
1140 * it originated, as seen in MODE (see RFC 1459).
1142 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
1143 /** Returns true if two users share a common channel.
1144 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
1147 virtual bool CommonChannels(userrec* u1, userrec* u2);
1148 /** Sends text from a user to one or more channels (mulicast).
1149 * This method writes a line of text to all users which share a common channel with a given
1150 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
1151 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
1152 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
1153 * is only sent to the other recipients, as seen in QUIT.
1155 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
1156 /** Sends a WALLOPS message.
1157 * This method writes a WALLOPS message to all users with the +w flag, originating from the
1160 virtual void SendWallops(userrec* User, std::string text);
1162 /** Returns true if a nick is valid.
1163 * Nicks for unregistered connections will return false.
1165 virtual bool IsNick(std::string nick);
1166 /** Returns a count of the number of users on a channel.
1167 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
1169 virtual int CountUsers(chanrec* c);
1170 /** Attempts to look up a nick and return a pointer to it.
1171 * This function will return NULL if the nick does not exist.
1173 virtual userrec* FindNick(std::string nick);
1174 /** Attempts to look up a nick using the file descriptor associated with that nick.
1175 * This function will return NULL if the file descriptor is not associated with a valid user.
1177 virtual userrec* FindDescriptor(int socket);
1178 /** Attempts to look up a channel and return a pointer to it.
1179 * This function will return NULL if the channel does not exist.
1181 virtual chanrec* FindChannel(std::string channel);
1182 /** Attempts to look up a user's privilages on a channel.
1183 * This function will return a string containing either @, %, +, or an empty string,
1184 * representing the user's privilages upon the channel you specify.
1186 virtual std::string ChanMode(userrec* User, chanrec* Chan);
1187 /** Checks if a user is on a channel.
1188 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1190 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
1191 /** Returns the server name of the server where the module is loaded.
1193 virtual std::string GetServerName();
1194 /** Returns the network name, global to all linked servers.
1196 virtual std::string GetNetworkName();
1197 /** Returns the server description string of the local server
1199 virtual std::string GetServerDescription();
1200 /** Returns the information of the server as returned by the /ADMIN command.
1201 * See the Admin class for further information of the return value. The members
1202 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
1203 * server where the module is loaded.
1205 virtual Admin GetAdmin();
1206 /** Adds an extended mode letter which is parsed by a module.
1207 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
1208 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
1209 * indicate wether the mode is a channel mode, a client mode, or a server mode.
1210 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
1211 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
1212 * params_when_on is the number of modes to expect when the mode is turned on
1213 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
1214 * the params_when_off value has a similar value to params_when_on, except it indicates
1215 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
1216 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
1217 * use this parameter. The function returns false if the mode is unavailable, and will not
1218 * attempt to allocate another character, as this will confuse users. This also means that
1219 * as only one module can claim a specific mode character, the core does not need to keep track
1220 * of which modules own which modes, which speeds up operation of the server. In this version,
1221 * a mode can have at most one parameter, attempting to use more parameters will have undefined
1224 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
1226 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
1227 * This call is used to implement modes like +q and +a. The characteristics of these modes are
1230 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
1232 * (2) They always take exactly one parameter when being added or removed
1234 * (3) They can be set multiple times, usually on users in channels
1236 * (4) The mode and its parameter are NOT stored in the channels modes structure
1238 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
1239 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
1240 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
1241 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
1242 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
1243 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
1244 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
1245 * so the above example would become '+aa one three' after processing.
1247 virtual bool AddExtendedListMode(char modechar);
1249 /** Adds a command to the command table.
1250 * This allows modules to add extra commands into the command table. You must place a function within your
1251 * module which is is of type handlerfunc:
1253 * typedef void (handlerfunc) (char**, int, userrec*);
1255 * void handle_kill(char **parameters, int pcnt, userrec *user)
1257 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
1258 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
1259 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
1260 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
1261 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
1262 * The source parameter is used for resource tracking, and should contain the name of your module (with file
1263 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
1266 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
1268 /** Sends a servermode.
1269 * you must format the parameters array with the target, modes and parameters for those modes.
1275 * modes[0] = ChannelName;
1279 * modes[2] = user->nick;
1281 * Srv->SendMode(modes,3,user);
1283 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
1284 * will be sent to the user you provide as the third parameter.
1285 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
1286 * your server in an unstable state!
1289 virtual void SendMode(char **parameters, int pcnt, userrec *user);
1291 /** Sends to all users matching a mode mask
1292 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
1293 * or module provided modes, including ones provided by your own module.
1294 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
1295 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
1296 * for example, if you were to use:
1298 * Serv->SendToModeMask("xi", WM_OR, "m00");
1300 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
1301 * user must have both modes set to receive the message.
1303 virtual void SendToModeMask(std::string modes, int flags, std::string text);
1305 /** Forces a user to join a channel.
1306 * This is similar to svsjoin and can be used to implement redirection, etc.
1307 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
1308 * On failure, the result is NULL.
1310 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
1312 /** Forces a user to part a channel.
1313 * This is similar to svspart and can be used to implement redirection, etc.
1314 * Although the return value of this function is a pointer to a channel record, the returned data is
1315 * undefined and should not be read or written to. This behaviour may be changed in a future version.
1317 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
1319 /** Forces a user nickchange.
1320 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
1321 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
1322 * the error numeric for it.
1324 virtual void ChangeUserNick(userrec* user, std::string nickname);
1326 /** Forces a user to quit with the specified reason.
1327 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
1328 * may bypass the quit prefix specified in the config file.
1332 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
1333 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
1334 * action after calling this method is to immediately bail from your handler.
1336 virtual void QuitUser(userrec* user, std::string reason);
1338 /** Matches text against a glob pattern.
1339 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
1340 * Returns true if the literal successfully matches the pattern, false if otherwise.
1342 virtual bool MatchText(std::string sliteral, std::string spattern);
1344 /** Calls the handler for a command, either implemented by the core or by another module.
1345 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
1346 * KICK etc, or even as a method of callback. By defining command names that are untypeable
1347 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
1348 * The first parameter to this method is the name of the command handler you wish to call, e.g.
1349 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
1350 * The second parameter is an array of parameters, and the third parameter is a count of parameters
1351 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
1352 * functiom will silently ignore it. The final parameter is the user executing the command handler,
1353 * used for privilage checks, etc.
1355 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
1357 virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
1359 /** Change displayed hostname of a user.
1360 * You should always call this method to change a user's host rather than writing directly to the
1361 * dhost member of userrec, as any change applied via this method will be propogated to any
1364 virtual void ChangeHost(userrec* user, std::string host);
1366 /** Change GECOS (fullname) of a user.
1367 * You should always call this method to change a user's GECOS rather than writing directly to the
1368 * fullname member of userrec, as any change applied via this method will be propogated to any
1371 virtual void ChangeGECOS(userrec* user, std::string gecos);
1373 /** Returns true if the servername you give is ulined.
1374 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
1375 * change modes of clients which are on remote servers and set modes of channels where there are
1376 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
1377 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
1378 * case of normal servers, as many ulined server types (such as services) do not support meshed
1379 * links and must operate in this manner.
1381 virtual bool IsUlined(std::string server);
1383 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
1384 * chanrec due to include constraints.
1386 virtual chanuserlist GetUsers(chanrec* chan);
1388 /** Remove a user's connection to the irc server, but leave their client in existence in the
1389 * user hash. When you call this function, the user's file descriptor will be replaced with the
1390 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
1391 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
1392 * After this call, the pointer to user will be invalid.
1394 virtual bool UserToPseudo(userrec* user,std::string message);
1396 /** This user takes one user, and switches their file descriptor with another user, so that one user
1397 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
1398 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
1399 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
1400 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
1402 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
1405 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1406 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1407 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1408 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1411 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
1414 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1415 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1416 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1417 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1420 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
1423 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
1424 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1425 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1426 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1429 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
1432 * The K-line is enforced as soon as it is added.
1433 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1434 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1435 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1438 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
1441 * The E-line is enforced as soon as it is added.
1442 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
1443 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
1444 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
1447 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
1449 /** Deletes a G-Line from all servers on the mesh
1451 virtual bool DelGLine(std::string hostmask);
1453 /** Deletes a Q-Line from all servers on the mesh
1455 virtual bool DelQLine(std::string nickname);
1457 /** Deletes a Z-Line from all servers on the mesh
1459 virtual bool DelZLine(std::string ipaddr);
1461 /** Deletes a local K-Line
1463 virtual bool DelKLine(std::string hostmask);
1465 /** Deletes a local E-Line
1467 virtual bool DelELine(std::string hostmask);
1469 /** Calculates a duration
1470 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
1471 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
1474 virtual long CalcDuration(std::string duration);
1476 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
1478 virtual bool IsValidMask(std::string mask);
1480 /** This function finds a module by name.
1481 * You must provide the filename of the module. If the module cannot be found (is not loaded)
1482 * the function will return NULL.
1484 virtual Module* FindModule(std::string name);
1486 /** Adds a class derived from InspSocket to the server's socket engine.
1488 virtual void AddSocket(InspSocket* sock);
1490 /** Deletes a class derived from InspSocket from the server's socket engine.
1492 virtual void DelSocket(InspSocket* sock);
1494 virtual void RehashServer();
1498 #define CONF_NOT_A_NUMBER 0x000010
1499 #define CONF_NOT_UNSIGNED 0x000080
1500 #define CONF_VALUE_NOT_FOUND 0x000100
1501 #define CONF_FILE_NOT_FOUND 0x000200
1504 /** Allows reading of values from configuration files
1505 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
1506 * a module-specified configuration file. It may either be instantiated with one parameter or none.
1507 * Constructing the class using one parameter allows you to specify a path to your own configuration
1508 * file, otherwise, inspircd.conf is read.
1510 class ConfigReader : public classbase
1513 /** The contents of the configuration file
1514 * This protected member should never be accessed by a module (and cannot be accessed unless the
1515 * core is changed). It will contain a pointer to the configuration file data with unneeded data
1516 * (such as comments) stripped from it.
1518 std::stringstream *cache;
1519 std::stringstream *errorlog;
1520 /** Used to store errors
1526 /** Default constructor.
1527 * This constructor initialises the ConfigReader class to read the inspircd.conf file
1528 * as specified when running ./configure.
1530 ConfigReader(); // default constructor reads ircd.conf
1531 /** Overloaded constructor.
1532 * This constructor initialises the ConfigReader class to read a user-specified config file
1534 ConfigReader(std::string filename); // read a module-specific config
1535 /** Default destructor.
1536 * This method destroys the ConfigReader class.
1539 /** Retrieves a value from the config file.
1540 * This method retrieves a value from the config file. Where multiple copies of the tag
1541 * exist in the config file, index indicates which of the values to retrieve.
1543 std::string ReadValue(std::string tag, std::string name, int index);
1544 /** Retrieves a boolean value from the config file.
1545 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
1546 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
1547 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
1549 bool ReadFlag(std::string tag, std::string name, int index);
1550 /** Retrieves an integer value from the config file.
1551 * This method retrieves an integer value from the config file. Where multiple copies of the tag
1552 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
1553 * values in the tag will cause the objects error value to be set, and any call to GetError() will
1554 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
1555 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
1556 * will return CONF_NOT_UNSIGNED
1558 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
1559 /** Returns the last error to occur.
1560 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
1561 * A call to GetError() resets the error flag back to 0.
1564 /** Counts the number of times a given tag appears in the config file.
1565 * This method counts the number of times a tag appears in a config file, for use where
1566 * there are several tags of the same kind, e.g. with opers and connect types. It can be
1567 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
1568 * multiple instance tag.
1570 int Enumerate(std::string tag);
1571 /** Returns true if a config file is valid.
1572 * This method is partially implemented and will only return false if the config
1573 * file does not exist or could not be opened.
1576 /** Dumps the list of errors in a config file to an output location. If bail is true,
1577 * then the program will abort. If bail is false and user points to a valid user
1578 * record, the error report will be spooled to the given user by means of NOTICE.
1579 * if bool is false AND user is false, the error report will be spooled to all opers
1580 * by means of a NOTICE to all opers.
1582 void DumpErrors(bool bail,userrec* user);
1584 /** Returns the number of items within a tag.
1585 * For example if the tag was <test tag="blah" data="foo"> then this
1586 * function would return 2. Spaces and newlines both qualify as valid seperators
1589 int EnumerateValues(std::string tag, int index);
1594 /** Caches a text file into memory and can be used to retrieve lines from it.
1595 * This class contains methods for read-only manipulation of a text file in memory.
1596 * Either use the constructor type with one parameter to load a file into memory
1597 * at construction, or use the LoadFile method to load a file.
1599 class FileReader : public classbase
1603 /** Default constructor.
1604 * This method does not load any file into memory, you must use the LoadFile method
1605 * after constructing the class this way.
1609 /** Secondary constructor.
1610 * This method initialises the class with a file loaded into it ready for GetLine and
1611 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1614 FileReader(std::string filename);
1616 /** Default destructor.
1617 * This deletes the memory allocated to the file.
1621 /** Used to load a file.
1622 * This method loads a file into the class ready for GetLine and
1623 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
1626 void LoadFile(std::string filename);
1628 /** Returns true if the file exists
1629 * This function will return false if the file could not be opened.
1633 /** Retrieve one line from the file.
1634 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
1635 * the index was out of bounds, or the line had no data on it.
1637 std::string GetLine(int x);
1639 /** Returns the size of the file in lines.
1640 * This method returns the number of lines in the read file. If it is 0, no lines have been
1641 * read into memory, either because the file is empty or it does not exist, or cannot be
1642 * opened due to permission problems.
1648 /** Instantiates classes inherited from Module
1649 * This class creates a class inherited from type Module, using new. This is to allow for modules
1650 * to create many different variants of Module, dependent on architecture, configuration, etc.
1651 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
1654 class ModuleFactory : public classbase
1658 virtual ~ModuleFactory() { }
1659 /** Creates a new module.
1660 * Your inherited class of ModuleFactory must return a pointer to your Module class
1661 * using this method.
1663 virtual Module * CreateModule(Server* Me) = 0;
1667 typedef DLLFactory<ModuleFactory> ircd_module;