Public Attributes

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.

Constructor & Destructor Documentation

Module::Module

(

)

Default constructor. Creates a module class. Don't do any type of hook registration or checks for other modules here; do that in init().

Called whenever an xline is added by a local user. This method is triggered after the line is added.

Parameters

source

The sender of the line or NULL for local server

line

The xline being added

void Module::OnBackgroundTimer

(

time_t

curtime

)

virtual

Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.

Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.

Parameters

user

The user to check

Returns

true to indicate readiness, false if otherwise

void Module::OnCleanup

(

int

target_type,

void *

item

)

virtual

Called before your module is unloaded to clean up Extensibles. This method is called once for every user and channel on the network, so that when your module unloads it may clear up any remaining data in the form of Extensibles added using Extensible::Extend(). If the target_type variable is TYPE_USER, then void* item refers to a User*, otherwise it refers to a Channel*.

MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the ban check, or MOD_RES_PASSTHRU to check bans normally

void Module::OnGarbageCollect

(

)

virtual

Called at intervals for modules to garbage-collect any hashes etc. Certain data types such as hash_map 'leak' buckets, which must be tidied up and freed by copying into a new item every so often. This method is called when it is time to do that.

void Module::OnGetServerDescription

(

const std::string &

servername,

std::string &

description

)

virtual

Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules. You may change or define the description given in std::string &description. If you do, this description will be shown in the WHOIS fields.

Called whenever a user is given usermode +o, anywhere on the network. You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.

Called whenever a user types /INFO. The User will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:

Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers or remote users. If you do so youre risking race conditions, desyncs and worse!

Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do NOT bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).

Called after every MODE command sent from a user The dest variable contains a User* if target_type is TYPE_USER and a Channel* if target_type is TYPE_CHANNEL. The text variable contains the remainder of the mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".

Called on rehash. This method is called when a user initiates a module-specific rehash. This can be used to do expensive operations (such as reloading SSL certificates) that are not executed on a normal rehash for efficiency. A rehash of this type does not reload the core configuration.

Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit. For example NAMESX, channel mode +u and +I, and UHNAMES. If the nick is set to an empty string by any module, then this will cause the nickname not to be displayed at all.

Called whenever a password check is to be made. Replaces the old OldOperCompare API. The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc). You should return a nonzero value to override the normal comparison, or zero to pass it on.

Called after any command has been executed. This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). The result code returned by the command handler is provided.

Parameters

command

The command being executed

parameters

An array of array of characters containing the parameters for the command

user

the user issuing the command

result

The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE

Called after a user has fully connected and all modules have executed OnUserConnect This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users. This is called for both local and remote users.

Called after a user opers locally. This is identical to Module::OnOper(), except it is called after OnOper so that other modules can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent out the OPERTYPE, etc.

Parameters

user

The user who is opering up

opername

The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.

Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, and for invalid commands. Invalid commands may only be sent to this function when the value of validated is false. By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using InspIRCd::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)

Parameters

command

The command being executed

parameters

An array of array of characters containing the parameters for the command

user

the user issuing the command

validated

True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc. You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).

Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. This is called in all cases – including when this server will not execute the rehash because it is directed at a remote server.

Parameters

user

The user performing the rehash, if any. If this is server initiated, the value of this variable will be NULL.

parameter

The (optional) parameter given to REHASH from the user. Empty when server initiated.

Called before a topic is changed. Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks As with other 'pre' events, you should only ever block a local event.

Called whenever a user sets away or returns from being away. The away message is available as a parameter, but should not be modified. At this stage, it has already been copied into the user record. If awaymsg is empty, the user is returning from away.

Parameters

user

The user setting away

awaymsg

The away message of the user, or empty if returning from away

Returns

nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)

Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.

Parameters

symbol

the symbol provided to /STATS

user

the user issuing the /STATS command

results

A string_list to append results into. You should put all your results into this string_list, rather than displaying them directly, so that your handler will work when remote STATS queries are received.

Called immediately after any connection is accepted. This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.

Allows modules to synchronize data which relates to channels during a netburst. When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc.

For a good example of how to use this function, please see src/modules/m_chanprotect.cpp

Allows modules to synchronize data which relates to users during a netburst. When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class Extensible – There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this!

Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote. The dest variable contains a User* if target_type is TYPE_USER and a Channel* if target_type is TYPE_CHANNEL. The difference between this event and OnUserPreNotice/OnUserPreMessage is that delivery is gauranteed, the message has already been vetted. In the case of the other two methods, a later module may stop your message. This also differs from OnUserMessage which occurs AFTER the message has been sent.

Parameters

user

The user sending the message

dest

The target of the message

target_type

The type of target (TYPE_USER or TYPE_CHANNEL)

text

the text being sent by the user

status

The status being used, e.g. NOTICE #chan has status== '@', 0 to send to everyone.

exempt_list

A list of users not to send to. For channel messages, this will usually contain just the sender.

Called whenever a module is unloaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do NOT bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).

Called whenever a user's socket is closed. The details of the exiting user are available to you in the parameter User *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.

Called when a user joins a channel. The details of the joining user are available to you in the parameter User *user, and the details of the channel they have joined is available in the variable Channel *channel

Parameters

memb

The channel membership being created

sync

This is set to true if the JOIN is the result of a network sync and the remote user is being introduced to a channel due to the network sync.

Called when a user parts a channel. The details of the leaving user are available to you in the parameter User *user, and the details of the channel they have left is available in the variable Channel *channel

Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the User if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this.

Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.

Parameters

source

The user who is issuing the INVITE

dest

The user being invited

channel

The channel the user is being invited to

timeout

The time the invite will expire (0 == never)

Returns

1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite

Called whenever a user is about to join a channel, before any processing is done. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.

IMPORTANT NOTE!

If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.

Parameters

user

The user joining the channel

chan

If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined

cname

The channel name being joined. For new channels this is valid where chan is not.

privs

A string containing the users privilages when joining the channel. For new channels this will contain "o". You may alter this string to alter the user's modes on the channel.

keygiven

The key given to join the channel, or an empty string if none was provided

Called whenever a user is about to be kicked. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc.

Parameters

source

The user issuing the kick

memb

The channel membership of the user who is being kicked.

reason

The kick reason

Returns

1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation

Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details of where the message is destined to be sent.

Parameters

user

The user sending the message

dest

The target of the message (Channel* or User*)

target_type

The type of target (TYPE_USER or TYPE_CHANNEL)

text

Changeable text being sent by the user

status

The status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.

exempt_list

A list of users not to send to. For channel messages, this will usually contain just the sender. It will be ignored for private messages.

Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the User if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.

Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.

Parameters

user

The user sending the message

dest

The target of the message (Channel* or User*)

target_type

The type of target (TYPE_USER or TYPE_CHANNEL)

text

Changeable text being sent by the user

status

The status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.

exempt_list

A list of users not to send to. For channel notices, this will usually contain just the sender. It will be ignored for private notices.

Called when a user quits. The details of the exiting user are available to you in the parameter User *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.

Called whenever a user is about to register their connection (e.g. before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.

Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.

Called whenever a line of WHOIS output is sent to a user. You may change the numeric and the text of the output by changing the values numeric and text, but you cannot change the user the numeric is sent to. You may however change the user's User values.

Parameters

user

The user the numeric is being sent to

dest

The user being WHOISed

numeric

The numeric of the line being sent

text

The text of the numeric, including any parameters

Returns

nonzero to drop the line completely so that the user does not receive it, or zero to allow the line to be sent.

Implemented by modules which provide the ability to link servers. These modules will implement this method, which allows metadata (extra data added to user and channel records using class Extensible, Extensible::Extend, etc) to be sent to other servers on a netburst and decoded at the other end by the same module on a different server.

More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of how to use this function.

Parameters

opaque

An opaque pointer set by the protocol module, should not be modified!

target

The Channel* or User* that metadata should be sent for

extname

The extension name to send metadata for

extdata

Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData

void Module::ProtoSendMode

(

void *

opaque,

TargetTypeFlags

target_type,

void *

target,

const std::vector< std::string > &

modeline,

const std::vector< TranslateType > &

translate

)

virtual

Implemented by modules which provide the ability to link servers. These modules will implement this method, which allows transparent sending of servermodes down the network link as a broadcast, without a module calling it having to know the format of the MODE command before the actual mode string.

More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples of how to use this function.

Parameters

opaque

An opaque pointer set by the protocol module, should not be modified!

target_type

The type of item to decode data for, TYPE_USER or TYPE_CHANNEL

target

The Channel* or User* that modes should be sent for

modeline

The modes and parameters to be sent

translate

The translation types of the mode parameters

Member Data Documentation

bool Module::dying

If true, this module will be unloaded soon, further unload attempts will fail Value is used by the ModuleManager internally, you should not modify it