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

ModuleJoinFlood Class Reference

Inheritance diagram for ModuleJoinFlood:

Inheritance graph
[legend]
Collaboration diagram for ModuleJoinFlood:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleJoinFlood (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 void OnUserJoin (User *user, Channel *channel, bool sync, bool &silent)
 Called when a user joins a channel.
void OnChannelDelete (Channel *chan)
 Called whenever a channel is deleted, either by QUIT, KICK or PART.
virtual ~ModuleJoinFlood ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

JoinFlood * jf

Detailed Description

Definition at line 207 of file m_joinflood.cpp.

Constructor & Destructor Documentation

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

Definition at line 214 of file m_joinflood.cpp.

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

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

Definition at line 274 of file m_joinflood.cpp.

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

Member Function Documentation

virtual Version ModuleJoinFlood::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 280 of file m_joinflood.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

void ModuleJoinFlood::OnChannelDelete (  Channel *  chan  )  [inline, virtual]
 

Called whenever a channel is deleted, either by QUIT, KICK or PART.

Parameters:
chan The channel being deleted

Reimplemented from Module.

Definition at line 263 of file m_joinflood.cpp.

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

virtual void ModuleJoinFlood::OnUserJoin (  User *  user,
Channel *  channel,
bool  sync,
bool &  silent
)  [inline, virtual]
 

Called when a user joins a channel.

The details of the joining user are available to you in the parameter User *user, and the details of the channel they have joined is available in the variable Channel *channel

Parameters:
user The user who is joining
channel The channel being joined
silent Change this to true if you want to conceal the JOIN command from the other users of the channel (useful for modules such as auditorium)
sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced to a channel due to the network sync.

Reimplemented from Module.

Definition at line 242 of file m_joinflood.cpp.

References joinfloodsettings::addjoin(), joinfloodsettings::clear(), InspIRCd::Config, Extensible::GetExt(), joinfloodsettings::joins, joinfloodsettings::lock(), Channel::name, joinfloodsettings::secs, Module::ServerInstance, ServerConfig::ServerName, joinfloodsettings::shouldlock(), and Channel::WriteChannelWithServ().

virtual int ModuleJoinFlood::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 225 of file m_joinflood.cpp.

References Extensible::GetExt(), joinfloodsettings::islocked(), Channel::name, User::nick, and User::WriteNumeric().

Member Data Documentation

JoinFlood* ModuleJoinFlood::jf [private]
 

Definition at line 210 of file m_joinflood.cpp.

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

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