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

ModuleSecureList Class Reference

Inheritance diagram for ModuleSecureList:

Inheritance graph
[legend]
Collaboration diagram for ModuleSecureList:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleSecureList (InspIRCd *Me)
virtual ~ModuleSecureList ()
virtual Version GetVersion ()
 Returns the version number of a Module.
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.
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.
void Prioritize ()

Private Attributes

std::vector< std::string > allowlist
time_t WaitTime

Detailed Description

Definition at line 18 of file m_securelist.cpp.

Constructor & Destructor Documentation

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

Definition at line 24 of file m_securelist.cpp.

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

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

Definition at line 31 of file m_securelist.cpp.

Member Function Documentation

virtual Version ModuleSecureList::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 35 of file m_securelist.cpp.

References API_VERSION, and VF_VENDOR.

virtual void ModuleSecureList::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 82 of file m_securelist.cpp.

virtual int ModuleSecureList::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 57 of file m_securelist.cpp.

References allowlist, IS_OPER, User::MakeHost(), InspIRCd::Match(), User::nick, Module::ServerInstance, User::signon, InspIRCd::Time(), WaitTime, User::WriteNumeric(), and User::WriteServ().

void ModuleSecureList::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 40 of file m_securelist.cpp.

References allowlist, ConfigReader::ReadInteger(), ConfigReader::ReadValue(), Module::ServerInstance, and WaitTime.

Referenced by ModuleSecureList().

void ModuleSecureList::Prioritize (   )  [inline, virtual]
 

Reimplemented from Module.

Definition at line 87 of file m_securelist.cpp.

References ModuleManager::Find(), I_OnPreCommand, InspIRCd::Modules, PRIO_BEFORE, Module::ServerInstance, and ModuleManager::SetPriority().

Member Data Documentation

std::vector<std::string> ModuleSecureList::allowlist [private]
 

Definition at line 21 of file m_securelist.cpp.

Referenced by OnPreCommand(), and OnRehash().

time_t ModuleSecureList::WaitTime [private]
 

Definition at line 22 of file m_securelist.cpp.

Referenced by OnPreCommand(), and OnRehash().

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