chanrec Class Reference

Holds all relevent information for a channel. More...

#include <channels.h>

Inherits Extensible.

List of all members.

Public Member Functions
void	SetCustomMode (char mode, bool mode_on)
	Sets or unsets a custom mode in the channels info.
void	SetCustomModeParam (char mode, char *parameter, bool mode_on)
	Sets or unsets the parameters for a custom mode in a channels info.
bool	IsCustomModeSet (char mode)
	Returns true if a custom mode is set on a channel.
std::string	GetModeParameter (char mode)
	Returns the parameter for a custom mode on a channel.
	chanrec ()
	Creates a channel record and initialises it with default values.
virtual	~chanrec ()
Public Attributes
char	name [CHANMAX]
	The channels name.
char	custom_modes [MAXMODES]
	Custom modes for the channel.
char	topic [MAXBUF]
	Channel topic.
time_t	created
	Creation time.
time_t	topicset
	Time topic was set.
char	setby [NICKMAX]
	The last user to set the topic.
long	limit
	Contains the channel user limit.
char	key [32]
	Contains the channel key.
short int	topiclock
	Nonzero if the mode +t is set.
short int	noexternal
	Nonzero if the mode +n is set.
short int	inviteonly
	Nonzero if the mode +i is set.
short int	moderated
	Nonzero if the mode +m is set.
short int	secret
	Nonzero if the mode +s is set.
short int	c_private
	Nonzero if the mode +p is set.
BanList	bans
	The list of all bans set on the channel.

---

Detailed Description

Holds all relevent information for a channel.

This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.

Definition at line 94 of file channels.h.

---

Constructor & Destructor Documentation

chanrec::chanrec (   )

Creates a channel record and initialises it with default values. Definition at line 111 of file channels.cpp. References c_private, created, custom_modes, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, and topicset. { strcpy(name,""); strcpy(custom_modes,""); strcpy(topic,""); strcpy(setby,""); strcpy(key,""); created = topicset = limit = 0; topiclock = noexternal = inviteonly = moderated = secret = c_private = false; }

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

Definition at line 185 of file channels.h. { /* stub */ }

---

Member Function Documentation

std::string chanrec::GetModeParameter (  char  mode  )

Returns the parameter for a custom mode on a channel. For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string. Definition at line 184 of file channels.cpp. References custom_mode_params. { if (custom_mode_params.size()) { for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) { if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) { return std::string(i->parameter); } } } return std::string(""); }

bool chanrec::IsCustomModeSet (  char  mode  )

Returns true if a custom mode is set on a channel. Definition at line 178 of file channels.cpp. References DEBUG. { log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes); return (strchr(this->custom_modes,mode) != 0); }

void chanrec::SetCustomMode (  char  mode, bool  mode_on )

Sets or unsets a custom mode in the channels info. Definition at line 122 of file channels.cpp. References custom_modes, DEBUG, and SetCustomModeParam(). { if (mode_on) { char m[3]; m[0] = mode; m[1] = '\0'; if (!strchr(this->custom_modes,mode)) { strlcat(custom_modes,m,MAXMODES); } log(DEBUG,"Custom mode %c set",mode); } else { std::string a = this->custom_modes; int pos = a.find(mode); a.erase(pos,1); strncpy(this->custom_modes,a.c_str(),MAXMODES); log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes); this->SetCustomModeParam(mode,"",false); } }

void chanrec::SetCustomModeParam (  char  mode, char *  parameter, bool  mode_on )

Sets or unsets the parameters for a custom mode in a channels info. Definition at line 147 of file channels.cpp. References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. Referenced by SetCustomMode(). { log(DEBUG,"SetCustomModeParam called"); ModeParameter M; M.mode = mode; strlcpy(M.channel,this->name,CHANMAX); strlcpy(M.parameter,parameter,MAXBUF); if (mode_on) { log(DEBUG,"Custom mode parameter %c %s added",mode,parameter); custom_mode_params.push_back(M); } else { if (custom_mode_params.size()) { for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) { if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) { log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter); custom_mode_params.erase(i); return; } } } log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!"); } }

---

Member Data Documentation

BanList chanrec::bans

The list of all bans set on the channel. Definition at line 159 of file channels.h.

short int chanrec::c_private

Nonzero if the mode +p is set. This value cannot be set at the same time as chanrec::secret Definition at line 155 of file channels.h. Referenced by chanrec().

time_t chanrec::created

Creation time. Definition at line 111 of file channels.h. Referenced by chanrec().

char chanrec::custom_modes[MAXMODES]

Custom modes for the channel. Plugins may use this field in any way they see fit. Definition at line 103 of file channels.h. Referenced by chanrec(), and SetCustomMode().

short int chanrec::inviteonly

Nonzero if the mode +i is set. Definition at line 141 of file channels.h. Referenced by chanrec().

char chanrec::key[32]

Contains the channel key. If this value is an empty string, there is no channel key in place. Definition at line 129 of file channels.h. Referenced by chanrec().

long chanrec::limit

Contains the channel user limit. If this value is zero, there is no limit in place. Definition at line 124 of file channels.h. Referenced by chanrec().

short int chanrec::moderated

Nonzero if the mode +m is set. Definition at line 145 of file channels.h. Referenced by chanrec().

char chanrec::name[CHANMAX]

The channels name. Definition at line 99 of file channels.h. Referenced by chanrec().

short int chanrec::noexternal

Nonzero if the mode +n is set. Definition at line 137 of file channels.h. Referenced by chanrec().

short int chanrec::secret

Nonzero if the mode +s is set. This value cannot be set at the same time as chanrec::c_private Definition at line 150 of file channels.h. Referenced by chanrec().

char chanrec::setby[NICKMAX]

The last user to set the topic. If this member is an empty string, no topic was ever set. Definition at line 119 of file channels.h. Referenced by chanrec().

char chanrec::topic[MAXBUF]

Channel topic. If this is an empty string, no channel topic is set. Definition at line 108 of file channels.h. Referenced by chanrec().

short int chanrec::topiclock

Nonzero if the mode +t is set. Definition at line 133 of file channels.h. Referenced by chanrec().

time_t chanrec::topicset

Time topic was set. If no topic was ever set, this will be equal to chanrec::created Definition at line 115 of file channels.h. Referenced by chanrec().

---

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

• channels.h
• channels.cpp

---