ModuleSilence Class Reference

Inheritance diagram for ModuleSilence:

[legend]Collaboration diagram for ModuleSilence:

[legend]List of all members.


Public Member Functions
	ModuleSilence (InspIRCd *Me)
virtual void	OnRehash (User *user, const std::string &parameter)
	Called on rehash.
virtual void	OnUserQuit (User *user, const std::string &reason, const std::string &oper_message)
	Called when a user quits.
virtual void	On005Numeric (std::string &output)
	Called when a 005 numeric is about to be output.
virtual void	OnBuildExemptList (MessageType message_type, Channel chan, User sender, char status, CUList &exempt_list, const std::string &text)
	Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
virtual int	PreText (User user, void dest, int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
virtual int	OnUserPreMessage (User user, void dest, int target_type, std::string &text, char status, CUList &exempt_list)
	Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
virtual int	OnUserPreNotice (User user, void dest, int target_type, std::string &text, char status, CUList &exempt_list)
	Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
virtual int	OnUserPreInvite (User source, User dest, Channel *channel, time_t timeout)
	Called whenever a user is about to invite another user into a channel, before any processing is done.
int	MatchPattern (User dest, User source, int pattern)
virtual	~ModuleSilence ()
virtual Version	GetVersion ()
	Returns the version number of a Module.
Private Attributes
CommandSilence *	cmdsilence
CommandSVSSilence *	cmdsvssilence
unsigned int	maxsilence

Detailed Description

Definition at line 267 of file m_silence.cpp.

Constructor & Destructor Documentation

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

Definition at line 274 of file m_silence.cpp.
References InspIRCd::AddCommand(), ModuleManager::Attach(), cmdsilence, cmdsvssilence, I_On005Numeric, I_OnBuildExemptList, I_OnRehash, I_OnUserPreInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserQuit, maxsilence, InspIRCd::Modules, OnRehash(), and Module::ServerInstance.

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

Definition at line 400 of file m_silence.cpp.

Member Function Documentation

virtual Version ModuleSilence::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 404 of file m_silence.cpp.
References API_VERSION, VF_COMMON, and VF_VENDOR.

int ModuleSilence::MatchPattern ( User * dest,

User * source,

int pattern

) [inline]

Definition at line 381 of file m_silence.cpp.
References Extensible::GetExt(), User::GetFullHost(), InspIRCd::Match(), SILENCE_ALL, and SILENCE_EXCLUDE.
Referenced by OnBuildExemptList(), OnUserPreInvite(), and PreText().

virtual void ModuleSilence::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 308 of file m_silence.cpp.
References ConvToStr(), and maxsilence.

virtual void ModuleSilence::OnBuildExemptList ( MessageType message_type,

Channel * chan,

User * sender,

char status,

CUList & exempt_list,

const std::string & text

) [inline, virtual]

Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
Parameters:

message_type The message type, either MSG_PRIVMSG or MSG_NOTICE

chan The channel to build the exempt list of

sender The original sender of the PRIVMSG or NOTICE

status The status char to be used for the channel list

exempt_list The exempt list to be populated

text The original message text causing the exempt list to be built

Reimplemented from Module.
Definition at line 314 of file m_silence.cpp.
References Channel::GetHalfoppedUsers(), Channel::GetOppedUsers(), Channel::GetUsers(), Channel::GetVoicedUsers(), IS_LOCAL, MatchPattern(), MSG_PRIVMSG, SILENCE_CHANNEL, and SILENCE_CNOTICE.
Referenced by PreText().

virtual void ModuleSilence::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 287 of file m_silence.cpp.
References Conf, maxsilence, ConfigReader::ReadInteger(), and Module::ServerInstance.
Referenced by ModuleSilence().

virtual int ModuleSilence::OnUserPreInvite ( User * source,

User * dest,

Channel * channel,

time_t timeout

) [inline, virtual]

Called whenever a user is about to invite another user into a channel, before any processing is done.
Returning 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 filter invites to channels.
Parameters:

source The user who is issuing the INVITE

dest The user being invited

channel The channel the user is being invited to

timeout The time the invite will expire (0 == never)

Returns:
1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite

Reimplemented from Module.
Definition at line 376 of file m_silence.cpp.
References MatchPattern(), and SILENCE_INVITE.

virtual int ModuleSilence::OnUserPreMessage ( User * user,

void * dest,

int target_type,

std::string & text,

char status,

CUList & exempt_list

) [inline, virtual]

Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
Returning any nonzero value 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 filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details of where the message is destined to be sent.
Parameters:

user The user sending the message

dest The target of the message (Channel* or User*)

target_type The type of target (TYPE_USER or TYPE_CHANNEL)

text Changeable text being sent by the user

status The status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.

exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender. It will be ignored for private messages.

Returns:
1 to deny the NOTICE, 0 to allow it

Reimplemented from Module.
Definition at line 366 of file m_silence.cpp.
References PreText(), and SILENCE_PRIVATE.

virtual int ModuleSilence::OnUserPreNotice ( User * user,

void * dest,

int target_type,

std::string & text,

char status,

CUList & exempt_list

) [inline, virtual]

Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
Returning any nonzero value 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 filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.
Parameters:

user The user sending the message

dest The target of the message (Channel* or User*)

target_type The type of target (TYPE_USER or TYPE_CHANNEL)

text Changeable text being sent by the user

status The status being used, e.g. PRIVMSG #chan has status== '@', 0 to send to everyone.

exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender. It will be ignored for private notices.

Returns:
1 to deny the NOTICE, 0 to allow it

Reimplemented from Module.
Definition at line 371 of file m_silence.cpp.
References PreText(), and SILENCE_NOTICE.

virtual void ModuleSilence::OnUserQuit ( User * user,

const std::string & reason,

const std::string & oper_message

) [inline, virtual]

Called when a user quits.
The details of the exiting user are available to you in the parameter User *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.
Parameters:

user The user who is quitting

message The user's quit message (as seen by non-opers)

oper_message The user's quit message (as seen by opers)

Reimplemented from Module.
Definition at line 296 of file m_silence.cpp.
References Extensible::GetExt(), and Extensible::Shrink().

virtual int ModuleSilence::PreText ( User * user,

void * dest,

int target_type,

std::string & text,

char status,

CUList & exempt_list,

int silence_type

) [inline, virtual]

Definition at line 346 of file m_silence.cpp.
References IS_LOCAL, MatchPattern(), MSG_NOTICE, MSG_PRIVMSG, OnBuildExemptList(), SILENCE_PRIVATE, TYPE_CHANNEL, and TYPE_USER.
Referenced by OnUserPreMessage(), and OnUserPreNotice().

Member Data Documentation

CommandSilence* ModuleSilence::cmdsilence [private]

Definition at line 269 of file m_silence.cpp.
Referenced by ModuleSilence().

CommandSVSSilence* ModuleSilence::cmdsvssilence [private]

Definition at line 270 of file m_silence.cpp.
Referenced by ModuleSilence().

unsigned int ModuleSilence::maxsilence [private]

Definition at line 271 of file m_silence.cpp.
Referenced by ModuleSilence(), On005Numeric(), and OnRehash().

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

m_silence.cpp

ModuleSilence Class Reference

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation