The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModulePrivacyMode Class Reference

Inheritance diagram for ModulePrivacyMode:

Inheritance graph
[legend]
Collaboration diagram for ModulePrivacyMode:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModulePrivacyMode (InspIRCd *Me)
virtual ~ModulePrivacyMode ()
virtual Version GetVersion ()
 Returns the version number of a Module.
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.
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.

Private Attributes

PrivacyMode * pm

Detailed Description

Definition at line 48 of file m_commonchans.cpp.

Constructor & Destructor Documentation

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

Definition at line 52 of file m_commonchans.cpp.

References ModeParser::AddMode(), ModuleManager::Attach(), I_OnUserPreMessage, I_OnUserPreNotice, InspIRCd::Modes, InspIRCd::Modules, pm, and Module::ServerInstance.

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

Definition at line 62 of file m_commonchans.cpp.

References ModeParser::DelMode(), InspIRCd::Modes, pm, and Module::ServerInstance.

Member Function Documentation

virtual Version ModulePrivacyMode::GetVersion (   )  [inline, 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 68 of file m_commonchans.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual int ModulePrivacyMode::OnUserPreMessage (  User *  user,
void *  dest,
int  target_type,
std::string &  text,
char  status,
CUList &  exempt_list
)  [inline, 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 73 of file m_commonchans.cpp.

References ERR_CANTSENDTOUSER, IS_OPER, User::IsModeSet(), User::nick, User::server, Module::ServerInstance, User::SharesChannelWith(), TYPE_USER, InspIRCd::ULine(), and User::WriteNumeric().

Referenced by OnUserPreNotice().

virtual int ModulePrivacyMode::OnUserPreNotice (  User *  user,
void *  dest,
int  target_type,
std::string &  text,
char  status,
CUList &  exempt_list
)  [inline, 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 87 of file m_commonchans.cpp.

References OnUserPreMessage().

Member Data Documentation

PrivacyMode* ModulePrivacyMode::pm [private]
 

Definition at line 50 of file m_commonchans.cpp.

Referenced by ModulePrivacyMode(), and ~ModulePrivacyMode().

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