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

ModuleBlockAmsg Class Reference

Inheritance diagram for ModuleBlockAmsg:

Inheritance graph
[legend]
Collaboration diagram for ModuleBlockAmsg:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleBlockAmsg (InspIRCd *Me)
virtual ~ModuleBlockAmsg ()
virtual Version GetVersion ()
 Returns the version number of a Module.
virtual void OnRehash (User *user, const std::string &parameter)
 Called on rehash.
virtual int OnPreCommand (std::string &command, std::vector< std::string > &parameters, User *user, bool validated, const std::string &original_line)
 Called whenever any command is about to be executed.
void OnCleanup (int target_type, void *item)
 Called before your module is unloaded to clean up Extensibles.

Private Attributes

int ForgetDelay
BlockAction action

Detailed Description

Definition at line 41 of file m_blockamsg.cpp.

Constructor & Destructor Documentation

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

Definition at line 47 of file m_blockamsg.cpp.

References ModuleManager::Attach(), I_OnCleanup, I_OnPreCommand, I_OnRehash, InspIRCd::Modules, OnRehash(), and Module::ServerInstance.

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

Definition at line 55 of file m_blockamsg.cpp.

Member Function Documentation

virtual Version ModuleBlockAmsg::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 59 of file m_blockamsg.cpp.

References API_VERSION, and VF_VENDOR.

void ModuleBlockAmsg::OnCleanup (  int  target_type,
void *  item
)  [inline, 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_type The type of item being cleaned
item A pointer to the item's class

Reimplemented from Module.

Definition at line 166 of file m_blockamsg.cpp.

References Extensible::GetExt(), Extensible::Shrink(), and TYPE_USER.

virtual int ModuleBlockAmsg::OnPreCommand (  std::string &  command,
std::vector< std::string > &  parameters,
User *  user,
bool  validated,
const std::string &  original_line
)  [inline, 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:
command The command being executed
parameters An array of array of characters containing the parameters for the command
pcnt The nuimber of parameters passed to 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
Returns:
1 to block the command, 0 to allow

Reimplemented from Module.

Definition at line 87 of file m_blockamsg.cpp.

References action, User::chans, Extensible::Extend(), ForgetDelay, Extensible::GetExt(), IBLOCK_KILL, IBLOCK_KILLOPERS, IBLOCK_NOTICE, IBLOCK_NOTICEOPERS, IS_LOCAL, BlockedMessage::message, User::nick, UserManager::QuitUser(), REG_ALL, User::registered, BlockedMessage::sent, Module::ServerInstance, InspIRCd::SNO, BlockedMessage::target, InspIRCd::Time(), InspIRCd::Users, User::WriteServ(), and SnomaskManager::WriteToSnoMask().

virtual void ModuleBlockAmsg::OnRehash (  User *  user,
const std::string &  parameter
)  [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 64 of file m_blockamsg.cpp.

References action, Conf, CONF_VALUE_NOT_FOUND, ForgetDelay, ConfigReader::GetError(), IBLOCK_KILL, IBLOCK_KILLOPERS, IBLOCK_NOTICE, IBLOCK_NOTICEOPERS, IBLOCK_SILENT, ConfigReader::ReadInteger(), ConfigReader::ReadValue(), and Module::ServerInstance.

Referenced by ModuleBlockAmsg().

Member Data Documentation

BlockAction ModuleBlockAmsg::action [private]
 

Definition at line 44 of file m_blockamsg.cpp.

Referenced by OnPreCommand(), and OnRehash().

int ModuleBlockAmsg::ForgetDelay [private]
 

Definition at line 43 of file m_blockamsg.cpp.

Referenced by OnPreCommand(), and OnRehash().

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