InspIRCd  2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations
Public Member Functions | Public Attributes | List of all members
Module Class Referenceabstract

#include <modules.h>

Inheritance diagram for Module:
classbase usecountbase CommandModule< Cmd >

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 &parameter)
 
virtual void OnModuleRehash (User *user, const std::string &parameter)
 
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 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 > &parameters)
 
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 > &parameters, LocalUser *user, bool validated, const std::string &original_line)
 
virtual void OnPostCommand (const std::string &command, const std::vector< std::string > &parameters, 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 &param, 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 > &params, User *user, std::string &line)
 
virtual void OnSetUserIP (LocalUser *user)
 
- Public Member Functions inherited from usecountbase
unsigned int GetUseCount () const
 
void refcount_inc () const
 
bool refcount_dec () const
 

Public Attributes

std::string ModuleSourceFile
 
DLLManagerModuleDLLManager
 
bool dying
 

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().

Module::~Module ( )
virtual

Default destructor. destroys a module class

Member Function Documentation

CullResult Module::cull ( )
virtual

Clean up prior to destruction If you override, you must call this AFTER your module's cleanup

Reimplemented from classbase.

virtual Version Module::GetVersion ( )
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 >.

virtual void Module::init ( )
inlinevirtual

Module setup

Exceptions
ModuleExceptionThrowing this class, or any class derived from ModuleException, causes loading of the module to abort.

Reimplemented in CommandModule< Cmd >.

void Module::On005Numeric ( std::string &  output)
virtual

Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.

Parameters
outputThe 005 string to be modified if neccessary.
ModResult Module::OnAcceptConnection ( int  fd,
ListenSocket sock,
irc::sockets::sockaddrs client,
irc::sockets::sockaddrs server 
)
virtual

Called when a port accepts a connection Return MOD_RES_ACCEPT if you have used the file descriptor.

Parameters
fdThe file descriptor returned from accept()
sockThe socket connection for the new user
clientThe client IP address and port
serverThe server IP address and port
ModResult Module::OnAddBan ( User source,
Channel channel,
const std::string &  banmask 
)
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.

Parameters
sourceThe user adding the ban
channelThe channel the ban is being added to
banmaskThe ban mask being added
Returns
1 to block the ban, 0 to continue as normal
void Module::OnAddLine ( User source,
XLine line 
)
virtual

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

Parameters
sourceThe sender of the line or NULL for local server
lineThe 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.

Parameters
curtimeThe current timer derived from time(2)
void Module::OnBuildNeighborList ( User source,
UserChanList &  include_c,
std::map< User *, bool > &  exceptions 
)
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.

Parameters
sourceThe source of the message
include_cChannels to scan for users to include
exceptionsMap of user->bool that overrides the inclusion decision

Set exceptions[user] = true to include, exceptions[user] = false to exclude

void Module::OnChangeHost ( User user,
const std::string &  newhost 
)
virtual

Called whenever a user's hostname is changed. This event triggers after the host has been set.

Parameters
userThe user whos host is being changed
newhostThe new hostname being set
void Module::OnChangeIdent ( User user,
const std::string &  ident 
)
virtual

Called whenever a user's IDENT is changed. This event triggers after the name has been set.

Parameters
userThe user who's IDENT is being changed
identThe new IDENT being set on the user
ModResult Module::OnChangeLocalUserGECOS ( LocalUser user,
const std::string &  newhost 
)
virtual

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.

Parameters
userThe user whos GECOS will be changed
newhostThe new GECOS
Returns
1 to deny the GECOS change, 0 to allow
ModResult Module::OnChangeLocalUserHost ( LocalUser user,
const std::string &  newhost 
)
virtual

Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.

Parameters
userThe user whos host will be changed
newhostThe new hostname
Returns
1 to deny the host change, 0 to allow
void Module::OnChangeName ( User user,
const std::string &  gecos 
)
virtual

Called whenever a user's GECOS (realname) is changed. This event triggers after the name has been set.

Parameters
userThe user who's GECOS is being changed
gecosThe new GECOS being set on the user
void Module::OnChannelDelete ( Channel chan)
virtual

Called whenever a channel is deleted, either by QUIT, KICK or PART.

Parameters
chanThe channel being deleted
ModResult Module::OnChannelPreDelete ( Channel chan)
virtual

Called whenever a channel is about to be deleted

Parameters
chanThe channel being deleted
Returns
An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
ModResult Module::OnCheckBan ( User user,
Channel chan,
const std::string &  mask 
)
virtual

Checks for a user's match of a single ban

Parameters
userThe user to check for match
chanThe channel on which the match is being checked
maskThe mask being checked
Returns
MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the ban check, or MOD_RES_PASSTHRU to check bans normally
ModResult Module::OnCheckChannelBan ( User user,
Channel chan 
)
virtual

Checks for a user's ban from the channel

Parameters
userThe user to check
chanThe channel to check in
Returns
MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the ban check, or MOD_RES_PASSTHRU to check bans normally
ModResult Module::OnCheckInvite ( User user,
Channel chan 
)
virtual

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.

Parameters
userThe user joining the channel
chanThe channel being joined
Returns
1 to explicitly allow the join, 0 to proceed as normal
ModResult Module::OnCheckKey ( User user,
Channel chan,
const std::string &  keygiven 
)
virtual

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.

Parameters
userThe user joining the channel
chanThe channel being joined
keygivenThe key given on joining the channel.
Returns
1 to explicitly allow the join, 0 to proceed as normal
ModResult Module::OnCheckLimit ( User user,
Channel chan 
)
virtual

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.

Parameters
userThe user joining the channel
chanThe channel being joined
Returns
1 to explicitly allow the join, 0 to proceed as normal
ModResult Module::OnCheckReady ( LocalUser user)
virtual

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
userThe 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*.

Parameters
target_typeThe type of item being cleaned
itemA pointer to the item's class
void Module::OnDecodeMetaData ( Extensible target,
const std::string &  extname,
const std::string &  extdata 
)
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.

Parameters
targetThe Channel* or User* that data should be added to
extnameThe extension name which is being sent
extdataThe extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
ModResult Module::OnDelBan ( User source,
Channel channel,
const std::string &  banmask 
)
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.

Parameters
sourceThe user deleting the ban
channelThe channel the ban is being deleted from
banmaskThe ban mask being deleted
Returns
1 to block the unban, 0 to continue as normal
void Module::OnDelLine ( User source,
XLine line 
)
virtual

Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry. This method is triggered after the line is deleted.

Parameters
sourceThe user removing the line or NULL for local server
linethe line being deleted
void Module::OnEvent ( Event event)
virtual

Called whenever an Event class is sent to all modules by another module. You should always check the value of Event::id to determine the event type.

Parameters
eventThe Event class being received
void Module::OnExpireLine ( XLine line)
virtual

Called whenever an xline expires. This method is triggered after the line is deleted.

Parameters
lineThe line being deleted.
ModResult Module::OnExtBanCheck ( User user,
Channel chan,
char  type 
)
virtual

Checks for a match on a given extban type

Returns
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.

Parameters
servernameThe servername being searched for
descriptionAlterable server description for this server
void Module::OnGlobalOper ( User user)
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.

Parameters
userThe user who is opering
void Module::OnHookIO ( StreamSocket user,
ListenSocket via 
)
virtual

Called to install an I/O hook on an event handler

Parameters
userThe socket to possibly install the I/O hook on
viaThe port that the user connected on
void Module::OnInfo ( User user)
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

Parameters
userThe user issuing /INFO
ModResult Module::OnKill ( User source,
User dest,
const std::string &  reason 
)
virtual

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!

Parameters
sourceThe user sending the KILL
destThe user being killed
reasonThe kill reason
Returns
1 to prevent the kill, 0 to allow
void Module::OnLoadModule ( Module mod)
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).

Parameters
modA pointer to the new module
void Module::OnMode ( User user,
void *  dest,
int  target_type,
const std::vector< std::string > &  text,
const std::vector< TranslateType > &  translate 
)
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".

Parameters
userThe user sending the MODEs
destThe target of the modes (User* or Channel*)
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textThe actual modes and their parameters if any
translateThe translation types of the mode parameters
void Module::OnModuleRehash ( User user,
const std::string &  parameter 
)
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.

Parameters
userThe user performing the rehash.
parameterThe parameter given to REHASH
void Module::OnNamesListItem ( User issuer,
Membership item,
std::string &  prefixes,
std::string &  nick 
)
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.

void Module::OnOper ( User user,
const std::string &  opertype 
)
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.

Parameters
userThe user who is opering up
opertypeThe opers type name
ModResult Module::OnPassCompare ( Extensible ex,
const std::string &  password,
const std::string &  input,
const std::string &  hashtype 
)
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.

Parameters
exThe object that's causing the authentication (User* for <oper> <connect:allow> etc, Server* for <link>).
passwordThe password from the configuration file (the password="" value).
inputThe password entered by the user or whoever.
hashtypeThe hash value from the config
Returns
0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
void Module::OnPostCommand ( const std::string &  command,
const std::vector< std::string > &  parameters,
LocalUser user,
CmdResult  result,
const std::string &  original_line 
)
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.

Parameters
commandThe command being executed
parametersAn array of array of characters containing the parameters for the command
userthe user issuing the command
resultThe return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
original_lineThe entire original line as passed to the parser from the user
void Module::OnPostConnect ( User 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.

Parameters
userThe user who is connecting
void Module::OnPostJoin ( Membership memb)
virtual

Called after a user joins a channel Identical to OnUserJoin, but called immediately afterwards, when any linking module has seen the join.

Parameters
membThe channel membership created
void Module::OnPostOper ( User user,
const std::string &  opername,
const std::string &  opertype 
)
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.

Parameters
userThe user who is opering up
opernameThe name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
opertypeThe opers type name
void Module::OnPostTopicChange ( User user,
Channel chan,
const std::string &  topic 
)
virtual

Called whenever a topic has been changed. To block topic changes you must use OnPreTopicChange instead.

Parameters
userThe user changing the topic
chanThe channels who's topic is being changed
topicThe actual topic text
ModResult Module::OnPreCommand ( std::string &  command,
std::vector< std::string > &  parameters,
LocalUser user,
bool  validated,
const std::string &  original_line 
)
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!)

Parameters
commandThe command being executed
parametersAn array of array of characters containing the parameters for the command
userthe user issuing the command
validatedTrue 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_lineThe entire original line as passed to the parser from the user
Returns
1 to block the command, 0 to allow
ModResult Module::OnPreMode ( User source,
User dest,
Channel channel,
const std::vector< std::string > &  parameters 
)
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

Parameters
sourcethe user making the mode change
destthe user destination of the umode change (NULL if a channel mode)
channelthe channel destination of the mode change
parametersraw mode parameters; parameters[0] is the user/channel being changed
void Module::OnPreRehash ( User user,
const std::string &  parameter 
)
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.

Parameters
userThe user performing the rehash, if any. If this is server initiated, the value of this variable will be NULL.
parameterThe (optional) parameter given to REHASH from the user. Empty when server initiated.
ModResult Module::OnPreTopicChange ( User user,
Channel chan,
const std::string &  topic 
)
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.

Parameters
userThe user changing the topic
chanThe channels who's topic is being changed
topicThe actual topic text
Returns
1 to block the topic change, 0 to allow
ModResult Module::OnRawMode ( User user,
Channel chan,
const char  mode,
const std::string &  param,
bool  adding,
int  pcnt 
)
virtual

Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely.

Parameters
userThe user who is sending the mode
chanThe channel the mode is being sent to (or NULL if a usermode)
modeThe mode character being set
paramThe parameter for the mode or an empty string
addingtrue of the mode is being added, false if it is being removed
pcntThe parameter count for the mode (0 or 1)
Returns
ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW to skip all permission checking. Please note that for remote mode changes, your return value will be ignored!
void Module::OnRehash ( User user)
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.

Parameters
userThe user that performed the rehash, if it was initiated by a user and that user is still connected.
void Module::OnRemoteKill ( User source,
User dest,
const std::string &  reason,
const std::string &  operreason 
)
virtual

Called when an oper wants to disconnect a remote user via KILL

Parameters
sourceThe user sending the KILL
destThe user being killed
reasonThe kill reason
operreasonThe oper kill reason
void Module::OnRequest ( Request request)
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.

Parameters
requestThe Request class being received
void Module::OnRunTestSuite ( )
virtual

Add test suite hooks here. These are used for testing functionality of a module via the –testsuite debugging parameter.

ModResult Module::OnSendSnotice ( char &  snomask,
std::string &  type,
const std::string &  message 
)
virtual

Called whenever a snotice is about to be sent to a snomask. snomask and type may both be modified; the message may not.

Parameters
snomaskThe snomask the message is going to (e.g. 'A')
typeThe textual description the snomask will go to (e.g. 'OPER')
messageThe text message to be sent via snotice
Returns
1 to block the snotice from being sent entirely, 0 else.
void Module::OnSendWhoLine ( User source,
const std::vector< std::string > &  params,
User user,
std::string &  line 
)
virtual

Called whenever a result from /WHO is about to be returned

Parameters
sourceThe user running the /WHO query
paramsThe parameters to the /WHO query
userThe user that this line of the query is about
lineThe raw line to send; modifiable, if empty no line will be returned.
ModResult Module::OnSetAway ( User user,
const std::string &  awaymsg 
)
virtual

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
userThe user setting away
awaymsgThe 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)
ModResult Module::OnSetConnectClass ( LocalUser user,
ConnectClass myclass 
)
virtual

Called when a user's connect class is being matched

Returns
MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or MOD_RES_PASSTHRU to allow normal matching (by host/port).
void Module::OnSetUserIP ( LocalUser user)
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.

Parameters
userThe user whose IP is being set
ModResult Module::OnStats ( char  symbol,
User user,
string_list &  results 
)
virtual

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

Parameters
symbolthe symbol provided to /STATS
userthe user issuing the /STATS command
resultsA 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.
Returns
1 to block the /STATS from being processed by the core, 0 to allow it
void Module::OnStreamSocketAccept ( StreamSocket sock,
irc::sockets::sockaddrs client,
irc::sockets::sockaddrs server 
)
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.

Parameters
sockThe socket in question
clientThe client IP address and port
serverThe server IP address and port
void Module::OnStreamSocketClose ( StreamSocket sock)
virtual

Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.

Parameters
sockThe socket in question
void Module::OnStreamSocketConnect ( StreamSocket sock)
virtual

Called immediately upon connection of an outbound BufferedSocket which has been hooked by a module.

Parameters
sockThe socket in question
int Module::OnStreamSocketRead ( StreamSocket sock,
std::string &  recvq 
)
virtual

Called when the stream socket has data to read

Parameters
sockThe socket that is ready
recvqThe receive queue that new data should be appended to
Returns
1 if new data has been read, 0 if no new data is ready (but the socket is still connected), -1 if there was an error or close
int Module::OnStreamSocketWrite ( StreamSocket sock,
std::string &  sendq 
)
virtual

Called when a hooked stream has data to write, or when the socket engine returns it as writable

Parameters
sockThe socket in question
sendqData to send to the socket
Returns
1 if the sendq has been completely emptied, 0 if there is still data to send, and -1 if there was an error
void Module::OnSyncChannel ( Channel chan,
Module proto,
void *  opaque 
)
virtual

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

Parameters
chanThe channel being syncronized
protoA pointer to the module handling network protocol
opaqueAn opaque pointer set by the protocol module, should not be modified!
void Module::OnSyncUser ( User user,
Module proto,
void *  opaque 
)
virtual

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!

Parameters
userThe user being syncronized
protoA pointer to the module handling network protocol
opaqueAn opaque pointer set by the protocol module, should not be modified!
void Module::OnText ( User user,
void *  dest,
int  target_type,
const std::string &  text,
char  status,
CUList &  exempt_list 
)
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.

Parameters
userThe user sending the message
destThe target of the message
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textthe text being sent by the user
statusThe status being used, e.g. NOTICE #chan has status== '@', 0 to send to everyone.
exempt_listA list of users not to send to. For channel messages, this will usually contain just the sender.
void Module::OnUnloadModule ( Module mod)
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).

Parameters
modPointer to the module being unloaded (still valid)
void Module::OnUserConnect ( LocalUser user)
virtual

Called when a user connects. The details of the connecting user are available to you in the parameter User *user

Parameters
userThe user who is connecting
void Module::OnUserDisconnect ( LocalUser user)
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.

Parameters
userThe user who is disconnecting
void Module::OnUserInit ( LocalUser user)
virtual

Called when a user is first connecting, prior to starting DNS lookups, checking initial connect class, or accepting any commands.

void Module::OnUserInvite ( User source,
User dest,
Channel channel,
time_t  timeout 
)
virtual

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.

Parameters
sourceThe user who is issuing the INVITE
destThe user being invited
channelThe channel the user is being invited to
timeoutThe time the invite will expire (0 == never)
void Module::OnUserJoin ( Membership memb,
bool  sync,
bool  created,
CUList &  except_list 
)
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

Parameters
membThe channel membership being created
syncThis 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.
createdThis is true if the join created the channel
except_listA list of users not to send to.
void Module::OnUserKick ( User source,
Membership memb,
const std::string &  reason,
CUList &  except_list 
)
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.

Parameters
sourceThe user issuing the kick
membThe channel membership of the user who was kicked.
reasonThe kick reason
except_listA list of users to not send to.
void Module::OnUserMessage ( User user,
void *  dest,
int  target_type,
const std::string &  text,
char  status,
const CUList &  exempt_list 
)
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.

Parameters
userThe user sending the message
destThe target of the message
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textthe text being sent by the user
statusThe status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.
exempt_listA list of users to not send to.
void Module::OnUserNotice ( User user,
void *  dest,
int  target_type,
const std::string &  text,
char  status,
const CUList &  exempt_list 
)
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.

Parameters
userThe user sending the message
destThe target of the message
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textthe text being sent by the user
statusThe status being used, e.g. NOTICE #chan has status== '@', 0 to send to everyone.
exempt_listA list of users to not send to.
void Module::OnUserPart ( Membership memb,
std::string &  partmessage,
CUList &  except_list 
)
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

Parameters
membThe channel membership being destroyed
partmessageThe part message, or an empty string (may be modified)
except_listA list of users to not send to.
void Module::OnUserPostNick ( User user,
const std::string &  oldnick 
)
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.

Parameters
userThe user changing their nick
oldnickThe old nickname of the user before the nickchange
ModResult Module::OnUserPreInvite ( User source,
User dest,
Channel channel,
time_t  timeout 
)
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.

Parameters
sourceThe user who is issuing the INVITE
destThe user being invited
channelThe channel the user is being invited to
timeoutThe 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
ModResult Module::OnUserPreJoin ( User user,
Channel chan,
const char *  cname,
std::string &  privs,
const std::string &  keygiven 
)
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.

Parameters
userThe user joining the channel
chanIf the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
cnameThe channel name being joined. For new channels this is valid where chan is not.
privsA 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.
keygivenThe key given to join the channel, or an empty string if none was provided
Returns
1 To prevent the join, 0 to allow it.
ModResult Module::OnUserPreKick ( User source,
Membership memb,
const std::string &  reason 
)
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.

Parameters
sourceThe user issuing the kick
membThe channel membership of the user who is being kicked.
reasonThe kick reason
Returns
1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
ModResult Module::OnUserPreMessage ( User user,
void *  dest,
int  target_type,
std::string &  text,
char  status,
CUList &  exempt_list 
)
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.

Parameters
userThe user sending the message
destThe target of the message (Channel* or User*)
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textChangeable text being sent by the user
statusThe status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.
exempt_listA list of users not to send to. For channel messages, this will usually contain just the sender. It will be ignored for private messages.
Returns
1 to deny the message, 0 to allow it
ModResult Module::OnUserPreNick ( User user,
const std::string &  newnick 
)
virtual

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.

Parameters
userThe username changing their nick
newnickTheir new nickname
Returns
1 to deny the change, 0 to allow
ModResult Module::OnUserPreNotice ( User user,
void *  dest,
int  target_type,
std::string &  text,
char  status,
CUList &  exempt_list 
)
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.

Parameters
userThe user sending the message
destThe target of the message (Channel* or User*)
target_typeThe type of target (TYPE_USER or TYPE_CHANNEL)
textChangeable text being sent by the user
statusThe status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.
exempt_listA list of users not to send to. For channel notices, this will usually contain just the sender. It will be ignored for private notices.
Returns
1 to deny the NOTICE, 0 to allow it
void Module::OnUserQuit ( User user,
const std::string &  message,
const std::string &  oper_message 
)
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.

Parameters
userThe user who is quitting
messageThe user's quit message (as seen by non-opers)
oper_messageThe user's quit message (as seen by opers)
ModResult Module::OnUserRegister ( LocalUser user)
virtual

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.

Parameters
userThe user registering
Returns
1 to indicate user quit, 0 to continue
void Module::OnWallops ( User user,
const std::string &  text 
)
virtual

Called after every WALLOPS command.

Parameters
userThe user sending the WALLOPS
textThe content of the WALLOPS message
void Module::OnWhois ( User source,
User dest 
)
virtual

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.

Parameters
sourceThe user issuing the WHOIS command
destThe user who is being WHOISed
ModResult Module::OnWhoisLine ( User user,
User dest,
int &  numeric,
std::string &  text 
)
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.

Parameters
userThe user the numeric is being sent to
destThe user being WHOISed
numericThe numeric of the line being sent
textThe 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.
void Module::ProtoSendMetaData ( void *  opaque,
Extensible target,
const std::string &  extname,
const std::string &  extdata 
)
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.

Parameters
opaqueAn opaque pointer set by the protocol module, should not be modified!
targetThe Channel* or User* that metadata should be sent for
extnameThe extension name to send metadata for
extdataEncoded 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
opaqueAn opaque pointer set by the protocol module, should not be modified!
target_typeThe type of item to decode data for, TYPE_USER or TYPE_CHANNEL
targetThe Channel* or User* that modes should be sent for
modelineThe modes and parameters to be sent
translateThe 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

DLLManager* Module::ModuleDLLManager

Reference to the dlopen() value

std::string Module::ModuleSourceFile

File that this module was loaded from


The documentation for this class was generated from the following files: