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

ModuleDenyChannels Class Reference

Inheritance diagram for ModuleDenyChannels:

Inheritance graph
[legend]
Collaboration diagram for ModuleDenyChannels:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleDenyChannels (InspIRCd *Me)
virtual void OnRehash (User *user, const std::string &param)
 Called on rehash.
virtual ~ModuleDenyChannels ()
virtual Version GetVersion ()
 Returns the version number of a Module.
virtual int OnUserPreJoin (User *user, Channel *chan, const char *cname, std::string &privs, const std::string &keygiven)
 Called whenever a user is about to join a channel, before any processing is done.

Private Attributes

ConfigReader * Conf

Detailed Description

Definition at line 18 of file m_denychans.cpp.

Constructor & Destructor Documentation

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

Definition at line 26 of file m_denychans.cpp.

References ModuleManager::Attach(), Conf, I_OnRehash, I_OnUserPreJoin, InspIRCd::Modules, and Module::ServerInstance.

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

Definition at line 78 of file m_denychans.cpp.

References Conf.

Member Function Documentation

virtual Version ModuleDenyChannels::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 83 of file m_denychans.cpp.

References API_VERSION, and VF_VENDOR.

virtual void ModuleDenyChannels::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 34 of file m_denychans.cpp.

References ServerLimits::ChanMax, Conf, InspIRCd::Config, InspIRCd::IsChannel, ServerConfig::Limits, InspIRCd::Match(), User::nick, ConfigReader::ReadValue(), Module::ServerInstance, and User::WriteServ().

virtual int ModuleDenyChannels::OnUserPreJoin (  User *  user,
Channel *  chan,
const char *  cname,
std::string &  privs,
const std::string &  keygiven
)  [inline, virtual]
 

Called whenever a user is about to join a channel, before any processing is done.

Returning a value of 1 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 mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.

IMPORTANT NOTE!

If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.

Parameters:
user The user joining the channel
chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
cname The channel name being joined. For new channels this is valid where chan is not.
privs A string containing the users privilages when joining the channel. For new channels this will contain "@". You may alter this string to alter the user's modes on the channel.
keygiven The key given to join the channel, or an empty string if none was provided
Returns:
1 To prevent the join, 0 to allow it.

Reimplemented from Module.

Definition at line 89 of file m_denychans.cpp.

References ServerLimits::ChanMax, Conf, InspIRCd::Config, InspIRCd::FindChan(), IS_OPER, InspIRCd::IsChannel, Channel::IsModeSet(), Channel::JoinUser(), ServerConfig::Limits, InspIRCd::Match(), ConfigReader::ReadFlag(), ConfigReader::ReadValue(), Module::ServerInstance, and InspIRCd::Time().

Member Data Documentation

ConfigReader* ModuleDenyChannels::Conf [private]
 

Definition at line 23 of file m_denychans.cpp.

Referenced by ModuleDenyChannels(), OnRehash(), OnUserPreJoin(), and ~ModuleDenyChannels().

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