ModuleInvisible Class Reference

Inheritance diagram for ModuleInvisible:

[legend]Collaboration diagram for ModuleInvisible:

[legend]List of all members.


Public Member Functions
	ModuleInvisible (InspIRCd *Me)
virtual	~ModuleInvisible ()
virtual Version	GetVersion ()
	Returns the version number of a Module.
virtual void	OnUserJoin (User user, Channel channel, bool sync, bool &silent)
	Called when a user joins a channel.
virtual void	OnRehash (User *user, const std::string &parameter)
	Called on rehash.
void	OnUserPart (User user, Channel channel, std::string &partmessage, bool &silent)
	Called when a user parts a channel.
void	OnUserQuit (User *user, const std::string &reason, const std::string &oper_message)
	Called when a user quits.
bool	OnHostCycle (User *user)
	Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host' message should be sent, if enabled.
virtual int	OnUserPreNotice (User user, void dest, int target_type, std::string &text, char status, CUList &exempt_list)
	Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
virtual int	OnUserPreMessage (User user, void dest, int target_type, std::string &text, char status, CUList &exempt_list)
	Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
void	WriteCommonFrom (User user, Channel channel, const char *text,...) CUSTOM_PRINTF(4
Private Attributes
InvisibleMode *	qm
InvisibleDeOper *	ido

Detailed Description

Definition at line 150 of file m_invisible.cpp.

Constructor & Destructor Documentation

ModuleInvisible::ModuleInvisible ( InspIRCd * Me ) [inline]

Definition at line 156 of file m_invisible.cpp.
References ModeParser::AddMode(), ModeParser::AddModeWatcher(), ModuleManager::Attach(), I_OnHostCycle, I_OnRehash, I_OnUserJoin, I_OnUserPart, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserQuit, ido, InspIRCd::Modes, InspIRCd::Modules, qm, Module::ServerInstance, UserManager::ServerNoticeAll(), and InspIRCd::Users.

virtual ModuleInvisible::~ModuleInvisible ( ) [inline, virtual]

Definition at line 173 of file m_invisible.cpp.
References ModeParser::DelMode(), ModeParser::DelModeWatcher(), ido, InspIRCd::Modes, qm, and Module::ServerInstance.

Member Function Documentation

Version ModuleInvisible::GetVersion ( ) [virtual]

Returns the version number of a Module.
The method should return a Version object with its version information assigned via Version::Version
Reimplemented from Module.
Definition at line 195 of file m_invisible.cpp.
References API_VERSION, VF_COMMON, and VF_VENDOR.

bool ModuleInvisible::OnHostCycle ( User * user ) [virtual]

Called for every time the user's host or ident changes, to indicate wether or not the 'Changing host' message should be sent, if enabled.
Certain modules such as auditorium may opt to hide this message even if it is enabled.
Reimplemented from Module.
Definition at line 251 of file m_invisible.cpp.
References User::IsModeSet().

void ModuleInvisible::OnRehash ( 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. You should use it to reload any files so that your module keeps in step with the rest of the application. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it.
Parameters:

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

parameter The (optional) parameter given to REHASH from the user.

Reimplemented from Module.
Definition at line 211 of file m_invisible.cpp.
References Module::ServerInstance.

void ModuleInvisible::OnUserJoin ( User * user,

Channel * channel,

bool sync,

bool & silent

) [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:

user The user who is joining

channel The channel being joined

silent Change this to true if you want to conceal the JOIN command from the other users of the channel (useful for modules such as auditorium)

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.

Reimplemented from Module.
Definition at line 200 of file m_invisible.cpp.
References User::GetFullHost(), User::IsModeSet(), Channel::name, Module::ServerInstance, InspIRCd::SNO, WriteCommonFrom(), and SnomaskManager::WriteToSnoMask().

void ModuleInvisible::OnUserPart ( User * user,

Channel * channel,

std::string & partmessage,

bool & silent

) [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:

user The user who is parting

channel The channel being parted

partmessage The part message, or an empty string (may be modified)

silent Change this to true if you want to conceal the PART command from the other users of the channel (useful for modules such as auditorium)

Reimplemented from Module.
Definition at line 217 of file m_invisible.cpp.
References User::IsModeSet(), Channel::name, and WriteCommonFrom().

int ModuleInvisible::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:

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.

Returns:
1 to deny the NOTICE, 0 to allow it

Reimplemented from Module.
Definition at line 271 of file m_invisible.cpp.
References OnUserPreNotice().

int ModuleInvisible::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:

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.

Returns:
1 to deny the NOTICE, 0 to allow it

Reimplemented from Module.
Definition at line 257 of file m_invisible.cpp.
References IS_LOCAL, IS_OPER, User::IsModeSet(), User::nick, TYPE_USER, and User::WriteNumeric().
Referenced by OnUserPreMessage().

void ModuleInvisible::OnUserQuit ( User * user,

const std::string & reason,

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:

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)

Reimplemented from Module.
Definition at line 229 of file m_invisible.cpp.
References User::chans, CommandParser::GetHandler(), Command::Handle(), User::IsModeSet(), InspIRCd::Parser, and Module::ServerInstance.

void ModuleInvisible::WriteCommonFrom ( User * user,

Channel * channel,

const char * text,

...

)

Definition at line 277 of file m_invisible.cpp.
References User::GetFullHost(), Channel::GetUsers(), IS_LOCAL, IS_OPER, and MAXBUF.
Referenced by OnUserJoin(), and OnUserPart().

Member Data Documentation

InvisibleDeOper* ModuleInvisible::ido [private]

Definition at line 154 of file m_invisible.cpp.
Referenced by ModuleInvisible(), and ~ModuleInvisible().

InvisibleMode* ModuleInvisible::qm [private]

Definition at line 153 of file m_invisible.cpp.
Referenced by ModuleInvisible(), and ~ModuleInvisible().

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

m_invisible.cpp

ModuleInvisible Class Reference

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation