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

ModuleSSLModes Class Reference

Inheritance diagram for ModuleSSLModes:

Inheritance graph
[legend]
Collaboration diagram for ModuleSSLModes:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Private Attributes

SSLMode * sslm

Detailed Description

Definition at line 66 of file m_sslmodes.cpp.

Constructor & Destructor Documentation

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

Definition at line 72 of file m_sslmodes.cpp.

References ModeParser::AddMode(), ModuleManager::Attach(), I_OnUserPreJoin, InspIRCd::Modes, InspIRCd::Modules, Module::ServerInstance, and sslm.

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

Definition at line 105 of file m_sslmodes.cpp.

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

Member Function Documentation

virtual Version ModuleSSLModes::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 111 of file m_sslmodes.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual int ModuleSSLModes::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 85 of file m_sslmodes.cpp.

References dummy, Extensible::GetExt(), Channel::IsModeSet(), User::nick, and User::WriteServ().

Member Data Documentation

SSLMode* ModuleSSLModes::sslm [private]
 

Definition at line 69 of file m_sslmodes.cpp.

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

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