InspIRCd
2.0
|
#include <modules.h>
Public Member Functions | |
Module () | |
virtual void | init () |
virtual CullResult | cull () |
virtual | ~Module () |
virtual void | Prioritize () |
virtual Version | GetVersion ()=0 |
virtual void | OnUserConnect (LocalUser *user) |
virtual void | OnUserQuit (User *user, const std::string &message, const std::string &oper_message) |
virtual void | OnUserDisconnect (LocalUser *user) |
virtual ModResult | OnChannelPreDelete (Channel *chan) |
virtual void | OnChannelDelete (Channel *chan) |
virtual void | OnUserJoin (Membership *memb, bool sync, bool created, CUList &except_list) |
virtual void | OnPostJoin (Membership *memb) |
virtual void | OnUserPart (Membership *memb, std::string &partmessage, CUList &except_list) |
virtual void | OnPreRehash (User *user, const std::string ¶meter) |
virtual void | OnModuleRehash (User *user, const std::string ¶meter) |
virtual void | OnRehash (User *user) |
virtual ModResult | OnSendSnotice (char &snomask, std::string &type, const std::string &message) |
virtual ModResult | OnUserPreJoin (User *user, Channel *chan, const char *cname, std::string &privs, const std::string &keygiven) |
virtual ModResult | OnUserPreKick (User *source, Membership *memb, const std::string &reason) |
virtual void | OnUserKick (User *source, Membership *memb, const std::string &reason, CUList &except_list) |
virtual void | OnOper (User *user, const std::string &opertype) |
virtual void | OnPostOper (User *user, const std::string &opername, const std::string &opertype) |
virtual void | OnPostDeoper (User *user) |
virtual void | OnInfo (User *user) |
virtual void | OnWhois (User *source, User *dest) |
virtual ModResult | OnUserPreInvite (User *source, User *dest, Channel *channel, time_t timeout) |
virtual void | OnUserInvite (User *source, User *dest, Channel *channel, time_t timeout) |
virtual ModResult | OnUserPreMessage (User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list) |
virtual ModResult | OnUserPreNotice (User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list) |
virtual void | OnBuildNeighborList (User *source, UserChanList &include_c, std::map< User *, bool > &exceptions) |
virtual ModResult | OnUserPreNick (User *user, const std::string &newnick) |
virtual void | OnUserMessage (User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list) |
virtual void | OnUserNotice (User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list) |
virtual void | OnText (User *user, void *dest, int target_type, const std::string &text, char status, CUList &exempt_list) |
virtual void | OnMode (User *user, void *dest, int target_type, const std::vector< std::string > &text, const std::vector< TranslateType > &translate) |
virtual void | OnGetServerDescription (const std::string &servername, std::string &description) |
virtual void | OnSyncUser (User *user, Module *proto, void *opaque) |
virtual void | OnSyncChannel (Channel *chan, Module *proto, void *opaque) |
virtual void | OnSyncNetwork (Module *proto, void *opaque) |
virtual void | OnDecodeMetaData (Extensible *target, const std::string &extname, const std::string &extdata) |
virtual void | ProtoSendMode (void *opaque, TargetTypeFlags target_type, void *target, const std::vector< std::string > &modeline, const std::vector< TranslateType > &translate) |
virtual void | ProtoSendMetaData (void *opaque, Extensible *target, const std::string &extname, const std::string &extdata) |
virtual void | OnWallops (User *user, const std::string &text) |
virtual void | OnChangeHost (User *user, const std::string &newhost) |
virtual void | OnChangeName (User *user, const std::string &gecos) |
virtual void | OnChangeIdent (User *user, const std::string &ident) |
virtual void | OnAddLine (User *source, XLine *line) |
virtual void | OnDelLine (User *source, XLine *line) |
virtual void | OnExpireLine (XLine *line) |
virtual void | OnCleanup (int target_type, void *item) |
virtual void | OnUserPostNick (User *user, const std::string &oldnick) |
virtual ModResult | OnPreMode (User *source, User *dest, Channel *channel, const std::vector< std::string > ¶meters) |
virtual void | On005Numeric (std::string &output) |
virtual ModResult | OnKill (User *source, User *dest, const std::string &reason) |
virtual void | OnRemoteKill (User *source, User *dest, const std::string &reason, const std::string &operreason) |
virtual void | OnLoadModule (Module *mod) |
virtual void | OnUnloadModule (Module *mod) |
virtual void | OnBackgroundTimer (time_t curtime) |
virtual ModResult | OnPreCommand (std::string &command, std::vector< std::string > ¶meters, LocalUser *user, bool validated, const std::string &original_line) |
virtual void | OnPostCommand (const std::string &command, const std::vector< std::string > ¶meters, LocalUser *user, CmdResult result, const std::string &original_line) |
virtual void | OnUserInit (LocalUser *user) |
virtual ModResult | OnCheckReady (LocalUser *user) |
virtual ModResult | OnUserRegister (LocalUser *user) |
virtual ModResult | OnCheckInvite (User *user, Channel *chan) |
virtual ModResult | OnRawMode (User *user, Channel *chan, const char mode, const std::string ¶m, bool adding, int pcnt) |
virtual ModResult | OnCheckKey (User *user, Channel *chan, const std::string &keygiven) |
virtual ModResult | OnCheckLimit (User *user, Channel *chan) |
virtual ModResult | OnCheckChannelBan (User *user, Channel *chan) |
virtual ModResult | OnCheckBan (User *user, Channel *chan, const std::string &mask) |
virtual ModResult | OnExtBanCheck (User *user, Channel *chan, char type) |
virtual ModResult | OnStats (char symbol, User *user, string_list &results) |
virtual ModResult | OnChangeLocalUserHost (LocalUser *user, const std::string &newhost) |
virtual ModResult | OnChangeLocalUserGECOS (LocalUser *user, const std::string &newhost) |
virtual ModResult | OnPreTopicChange (User *user, Channel *chan, const std::string &topic) |
virtual void | OnPostTopicChange (User *user, Channel *chan, const std::string &topic) |
virtual void | OnEvent (Event &event) |
virtual void | OnRequest (Request &request) |
virtual ModResult | OnPassCompare (Extensible *ex, const std::string &password, const std::string &input, const std::string &hashtype) |
virtual void | OnGlobalOper (User *user) |
virtual void | OnPostConnect (User *user) |
virtual ModResult | OnAddBan (User *source, Channel *channel, const std::string &banmask) |
virtual ModResult | OnDelBan (User *source, Channel *channel, const std::string &banmask) |
virtual void | OnHookIO (StreamSocket *user, ListenSocket *via) |
virtual ModResult | OnAcceptConnection (int fd, ListenSocket *sock, irc::sockets::sockaddrs *client, irc::sockets::sockaddrs *server) |
virtual void | OnStreamSocketAccept (StreamSocket *sock, irc::sockets::sockaddrs *client, irc::sockets::sockaddrs *server) |
virtual int | OnStreamSocketWrite (StreamSocket *sock, std::string &sendq) |
virtual void | OnStreamSocketClose (StreamSocket *sock) |
virtual void | OnStreamSocketConnect (StreamSocket *sock) |
virtual int | OnStreamSocketRead (StreamSocket *sock, std::string &recvq) |
virtual ModResult | OnSetAway (User *user, const std::string &awaymsg) |
virtual ModResult | OnWhoisLine (User *user, User *dest, int &numeric, std::string &text) |
virtual void | OnGarbageCollect () |
virtual ModResult | OnSetConnectClass (LocalUser *user, ConnectClass *myclass) |
virtual void | OnRunTestSuite () |
virtual void | OnNamesListItem (User *issuer, Membership *item, std::string &prefixes, std::string &nick) |
virtual ModResult | OnNumeric (User *user, unsigned int numeric, const std::string &text) |
virtual void | OnSendWhoLine (User *source, const std::vector< std::string > ¶ms, User *user, std::string &line) |
virtual void | OnSetUserIP (LocalUser *user) |
![]() | |
unsigned int | GetUseCount () const |
void | refcount_inc () const |
bool | refcount_dec () const |
Public Attributes | |
std::string | ModuleSourceFile |
DLLManager * | ModuleDLLManager |
bool | dying |
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.
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().
|
virtual |
Default destructor. destroys a module class
|
virtual |
Clean up prior to destruction If you override, you must call this AFTER your module's cleanup
Reimplemented from classbase.
|
pure virtual |
Returns the version number of a Module. The method should return a Version object with its version information assigned via Version::Version
Implemented in CommandModule< Cmd >.
|
inlinevirtual |
Module setup
ModuleException | Throwing this class, or any class derived from ModuleException, causes loading of the module to abort. |
Reimplemented in CommandModule< Cmd >.
|
virtual |
Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.
output | The 005 string to be modified if neccessary. |
|
virtual |
Called when a port accepts a connection Return MOD_RES_ACCEPT if you have used the file descriptor.
fd | The file descriptor returned from accept() |
sock | The socket connection for the new user |
client | The client IP address and port |
server | The server IP address and port |
|
virtual |
Called whenever a ban is added to a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
source | The user adding the ban |
channel | The channel the ban is being added to |
banmask | The ban mask being added |
Called whenever an xline is added by a local user. This method is triggered after the line is added.
source | The sender of the line or NULL for local server |
line | The xline being added |
|
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.
curtime | The current timer derived from time(2) |
|
virtual |
Called when sending a message to all "neighbors" of a given user - that is, all users that share a common channel. This is used in commands such as NICK, QUIT, etc.
source | The source of the message |
include_c | Channels to scan for users to include |
exceptions | Map of user->bool that overrides the inclusion decision |
Set exceptions[user] = true to include, exceptions[user] = false to exclude
|
virtual |
Called whenever a user's hostname is changed. This event triggers after the host has been set.
user | The user whos host is being changed |
newhost | The new hostname being set |
|
virtual |
Called whenever a user's IDENT is changed. This event triggers after the name has been set.
user | The user who's IDENT is being changed |
ident | The new IDENT being set on the user |
Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.
user | The user whos GECOS will be changed |
newhost | The new GECOS |
Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.
user | The user whos host will be changed |
newhost | The new hostname |
|
virtual |
Called whenever a user's GECOS (realname) is changed. This event triggers after the name has been set.
user | The user who's GECOS is being changed |
gecos | The new GECOS being set on the user |
|
virtual |
Called whenever a channel is deleted, either by QUIT, KICK or PART.
chan | The channel being deleted |
Called whenever a channel is about to be deleted
chan | The channel being deleted |
Checks for a user's match of a single ban
user | The user to check for match |
chan | The channel on which the match is being checked |
mask | The mask being checked |
Checks for a user's ban from the channel
user | The user to check |
chan | The channel to check in |
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.
user | The user joining the channel |
chan | The channel being joined |
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.
user | The user joining the channel |
chan | The channel being joined |
keygiven | The key given on joining the channel. |
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.
user | The user joining the channel |
chan | The channel being joined |
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.
user | The user to check |
|
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*.
target_type | The type of item being cleaned |
item | A pointer to the item's class |
|
virtual |
Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module. Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
target | The Channel* or User* that data should be added to |
extname | The extension name which is being sent |
extdata | The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData |
|
virtual |
Called whenever a ban is removed from a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
source | The user deleting the ban |
channel | The channel the ban is being deleted from |
banmask | The ban mask being deleted |
Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry. This method is triggered after the line is deleted.
source | The user removing the line or NULL for local server |
line | the line being deleted |
|
virtual |
|
virtual |
Called whenever an xline expires. This method is triggered after the line is deleted.
line | The line being deleted. |
Checks for a match on a given extban type
|
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.
|
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.
servername | The servername being searched for |
description | Alterable server description for this server |
|
virtual |
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.
user | The user who is opering |
|
virtual |
Called to install an I/O hook on an event handler
user | The socket to possibly install the I/O hook on |
via | The port that the user connected on |
|
virtual |
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:
<nick> :information here
user | The user issuing /INFO |
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!
source | The user sending the KILL |
dest | The user being killed |
reason | The kill reason |
|
virtual |
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).
mod | A pointer to the new module |
|
virtual |
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".
user | The user sending the MODEs |
dest | The target of the modes (User* or Channel*) |
target_type | The type of target (TYPE_USER or TYPE_CHANNEL) |
text | The actual modes and their parameters if any |
translate | The translation types of the mode parameters |
|
virtual |
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.
user | The user performing the rehash. |
parameter | The parameter given to REHASH |
|
virtual |
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.
|
virtual |
Called whenever a user opers locally. The User will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.
user | The user who is opering up |
opertype | The opers type name |
|
virtual |
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.
ex | The object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>). |
password | The password from the configuration file (the password="" value). |
input | The password entered by the user or whoever. |
hashtype | The hash value from the config |
|
virtual |
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.
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 |
original_line | The entire original line as passed to the parser from the user |
|
virtual |
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.
user | The user who is connecting |
|
virtual |
Called after a user deopers locally.
user | The user who has deopered. |
|
virtual |
Called after a user joins a channel Identical to OnUserJoin, but called immediately afterwards, when any linking module has seen the join.
memb | The channel membership created |
|
virtual |
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.
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. |
opertype | The opers type name |
Called whenever a topic has been changed. To block topic changes you must use OnPreTopicChange instead.
user | The user changing the topic |
chan | The channels who's topic is being changed |
topic | The actual topic text |
|
virtual |
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!)
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). |
original_line | The entire original line as passed to the parser from the user |
|
virtual |
Called before any mode change, to allow a single access check for a full mode change (use OnRawMode to check individual modes)
Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by OnRawMode for each individual mode
source | the user making the mode change |
dest | the user destination of the umode change (NULL if a channel mode) |
channel | the channel destination of the mode change |
parameters | raw mode parameters; parameters[0] is the user/channel being changed |
|
virtual |
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.
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. |
|
virtual |
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.
user | The user changing the topic |
chan | The channels who's topic is being changed |
topic | The actual topic text |
|
virtual |
Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely.
user | The user who is sending the mode |
chan | The channel the mode is being sent to (or NULL if a usermode) |
mode | The mode character being set |
param | The parameter for the mode or an empty string |
adding | true of the mode is being added, false if it is being removed |
pcnt | The parameter count for the mode (0 or 1) |
|
virtual |
Called on rehash. This method is called after a rehash has completed. You should use it to reload any module configuration from the main configuration file.
user | The user that performed the rehash, if it was initiated by a user and that user is still connected. |
|
virtual |
Called when an oper wants to disconnect a remote user via KILL
source | The user sending the KILL |
dest | The user being killed |
reason | The kill reason |
operreason | The oper kill reason |
|
virtual |
Called whenever a Request class is sent to your module by another module. The value of Request::id should be used to determine the type of request.
request | The Request class being received |
|
virtual |
Add test suite hooks here. These are used for testing functionality of a module via the –testsuite debugging parameter.
|
virtual |
Called whenever a snotice is about to be sent to a snomask. snomask and type may both be modified; the message may not.
snomask | The snomask the message is going to (e.g. 'A') |
type | The textual description the snomask will go to (e.g. 'OPER') |
message | The text message to be sent via snotice |
|
virtual |
Called whenever a result from /WHO is about to be returned
source | The user running the /WHO query |
params | The parameters to the /WHO query |
user | The user that this line of the query is about |
line | The raw line to send; modifiable, if empty no line will be returned. |
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.
user | The user setting away |
awaymsg | The away message of the user, or empty if returning from away |
|
virtual |
Called when a user's connect class is being matched
|
virtual |
Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to a module like m_cgiirc changing it.
user | The user whose IP is being set |
Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
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. |
|
virtual |
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.
sock | The socket in question |
client | The client IP address and port |
server | The server IP address and port |
|
virtual |
Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.
sock | The socket in question |
|
virtual |
Called immediately upon connection of an outbound BufferedSocket which has been hooked by a module.
sock | The socket in question |
|
virtual |
Called when the stream socket has data to read
sock | The socket that is ready |
recvq | The receive queue that new data should be appended to |
|
virtual |
Called when a hooked stream has data to write, or when the socket engine returns it as writable
sock | The socket in question |
sendq | Data to send to the socket |
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
chan | The channel being syncronized |
proto | A pointer to the module handling network protocol |
opaque | An opaque pointer set by the protocol module, should not be modified! |
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!
user | The user being syncronized |
proto | A pointer to the module handling network protocol |
opaque | An opaque pointer set by the protocol module, should not be modified! |
|
virtual |
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.
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. |
|
virtual |
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).
mod | Pointer to the module being unloaded (still valid) |
|
virtual |
Called when a user connects. The details of the connecting user are available to you in the parameter User *user
user | The user who is connecting |
|
virtual |
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.
user | The user who is disconnecting |
|
virtual |
Called when a user is first connecting, prior to starting DNS lookups, checking initial connect class, or accepting any commands.
Called after a user has been successfully invited to a channel. You cannot prevent the invite from occuring using this function, to do that, use OnUserPreInvite instead.
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) |
|
virtual |
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
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. |
created | This is true if the join created the channel |
except_list | A list of users not to send to. |
|
virtual |
Called whenever a user is kicked. If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use Module::OnUserPreKick instead of this method.
source | The user issuing the kick |
memb | The channel membership of the user who was kicked. |
reason | The kick reason |
except_list | A list of users to not send to. |
|
virtual |
Called after any PRIVMSG 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.
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. PRIVMSG #chan has status== '@', 0 to send to everyone. |
exempt_list | A list of users to not send to. |
|
virtual |
Called after any NOTICE 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.
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 to not send to. |
|
virtual |
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
memb | The channel membership being destroyed |
partmessage | The part message, or an empty string (may be modified) |
except_list | A list of users to not send to. |
|
virtual |
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.
user | The user changing their nick |
oldnick | The old nickname of the user before the nickchange |
|
virtual |
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.
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) |
|
virtual |
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.
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 |
|
virtual |
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.
source | The user issuing the kick |
memb | The channel membership of the user who is being kicked. |
reason | The kick reason |
|
virtual |
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.
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.
user | The username changing their nick |
newnick | Their new nickname |
|
virtual |
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.
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. |
|
virtual |
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.
user | The user who is quitting |
message | The user's quit message (as seen by non-opers) |
oper_message | The user's quit message (as seen by opers) |
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.
user | The user registering |
|
virtual |
Called after every WALLOPS command.
user | The user sending the WALLOPS |
text | The content of the WALLOPS message |
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.
source | The user issuing the WHOIS command |
dest | The user who is being WHOISed |
|
virtual |
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.
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 |
|
virtual |
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.
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 |
|
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.
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 |
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
DLLManager* Module::ModuleDLLManager |
Reference to the dlopen() value
std::string Module::ModuleSourceFile |
File that this module was loaded from