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

ModuleBlockCAPS Class Reference

Inheritance diagram for ModuleBlockCAPS:

Inheritance graph
[legend]
Collaboration diagram for ModuleBlockCAPS:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleBlockCAPS (InspIRCd *Me)
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.
virtual void OnRehash (User *user, const std::string &param)
 Called on rehash.
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.
void ReadConf ()
virtual ~ModuleBlockCAPS ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

BlockCaps * bc
int percent
unsigned int minlen
char capsmap [256]

Detailed Description

Definition at line 27 of file m_blockcaps.cpp.

Constructor & Destructor Documentation

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

Definition at line 35 of file m_blockcaps.cpp.

References ModeParser::AddMode(), ModuleManager::Attach(), bc, I_On005Numeric, I_OnRehash, I_OnUserPreMessage, I_OnUserPreNotice, InspIRCd::Modes, InspIRCd::Modules, OnRehash(), and Module::ServerInstance.

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

Definition at line 129 of file m_blockcaps.cpp.

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

Member Function Documentation

virtual Version ModuleBlockCAPS::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 135 of file m_blockcaps.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual void ModuleBlockCAPS::On005Numeric (  std::string &  output  )  [inline, 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:
output The 005 string to be modified if neccessary.

Reimplemented from Module.

Definition at line 48 of file m_blockcaps.cpp.

References InspIRCd::AddExtBanChar(), and Module::ServerInstance.

virtual void ModuleBlockCAPS::OnRehash (  User *  user,
const std::string &  param
)  [inline, 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 53 of file m_blockcaps.cpp.

References ReadConf().

Referenced by ModuleBlockCAPS().

virtual int ModuleBlockCAPS::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 58 of file m_blockcaps.cpp.

References capsmap, CHANOPS_EXEMPT, ERR_CANNOTSENDTOCHAN, Channel::GetStatus(), IS_LOCAL, Channel::IsExtBanned(), Channel::IsModeSet(), minlen, Channel::name, User::nick, percent, Module::ServerInstance, STATUS_OP, TYPE_CHANNEL, and User::WriteNumeric().

Referenced by OnUserPreNotice().

virtual int ModuleBlockCAPS::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 101 of file m_blockcaps.cpp.

References OnUserPreMessage().

void ModuleBlockCAPS::ReadConf (   )  [inline]
 

Definition at line 106 of file m_blockcaps.cpp.

References capsmap, Conf, DEFAULT, LogManager::Log(), InspIRCd::Logs, MAXBUF, minlen, percent, ConfigReader::ReadInteger(), ConfigReader::ReadValue(), and Module::ServerInstance.

Referenced by OnRehash().

Member Data Documentation

BlockCaps* ModuleBlockCAPS::bc [private]
 

Definition at line 29 of file m_blockcaps.cpp.

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

char ModuleBlockCAPS::capsmap[256] [private]
 

Definition at line 32 of file m_blockcaps.cpp.

Referenced by OnUserPreMessage(), and ReadConf().

unsigned int ModuleBlockCAPS::minlen [private]
 

Definition at line 31 of file m_blockcaps.cpp.

Referenced by OnUserPreMessage(), and ReadConf().

int ModuleBlockCAPS::percent [private]
 

Definition at line 30 of file m_blockcaps.cpp.

Referenced by OnUserPreMessage(), and ReadConf().

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