Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

chanrec Class Reference

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

#include <channels.h>

Inheritance diagram for chanrec:

Inheritance graph
[legend]
Collaboration diagram for chanrec:

Collaboration graph
[legend]
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 83 of file channels.h.

Constructor & Destructor Documentation

chanrec::chanrec (    ) 
 

Creates a channel record and initialises it with default values.

Definition at line 12 of file channels.cpp.

References c_private, created, inviteonly, limit, moderated, noexternal, secret, topiclock, and topicset. 

00013 {
00014         strcpy(name,"");
00015         strcpy(custom_modes,"");
00016         strcpy(topic,"");
00017         strcpy(setby,"");
00018         strcpy(key,"");
00019         created = topicset = limit = 0;
00020         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
00021 }

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

Definition at line 174 of file channels.h. 

00174 { /* 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 87 of file channels.cpp.

References custom_mode_params. 

00088 {
00089         if (custom_mode_params.size())
00090         {
00091                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
00092                 {
00093                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
00094                         {
00095                                 return std::string(i->parameter);
00096                         }
00097                 }
00098         }
00099         return std::string("");
00100 }

bool chanrec::IsCustomModeSet (  char    mode ) 
 

Returns true if a custom mode is set on a channel.

Definition at line 81 of file channels.cpp. 

00082 {
00083         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
00084         return (strchr(this->custom_modes,mode) != 0);
00085 }

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

Sets or unsets a custom mode in the channels info.

Definition at line 23 of file channels.cpp.

References custom_modes, and SetCustomModeParam(). 

00024 {
00025         if (mode_on) {
00026                 char m[3];
00027                 m[0] = mode;
00028                 m[1] = '\0';
00029                 if (!strchr(this->custom_modes,mode))
00030                 {
00031                         strncat(custom_modes,m,MAXMODES);
00032                 }
00033                 log(DEBUG,"Custom mode %c set",mode);
00034         }
00035         else {
00036                 char temp[MAXBUF];
00037                 int count = 0;
00038                 for (int q = 0; q < strlen(custom_modes); q++) {
00039                         if (custom_modes[q] != mode) {
00040                                 temp[count++] = mode;
00041                         }
00042                 }
00043                 temp[count] = '\0';
00044                 strncpy(custom_modes,temp,MAXMODES);
00045                 log(DEBUG,"Custom mode %c removed",mode);
00046                 this->SetCustomModeParam(mode,"",false);
00047         }
00048 }

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 50 of file channels.cpp.

References ModeParameter::channel, custom_mode_params, ModeParameter::mode, and ModeParameter::parameter.

Referenced by SetCustomMode(). 

00051 {
00052 
00053         log(DEBUG,"SetCustomModeParam called");
00054         ModeParameter M;
00055         M.mode = mode;
00056         strcpy(M.channel,this->name);
00057         strcpy(M.parameter,parameter);
00058         if (mode_on)
00059         {
00060                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
00061                 custom_mode_params.push_back(M);
00062         }
00063         else
00064         {
00065                 if (custom_mode_params.size())
00066                 {
00067                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
00068                         {
00069                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
00070                                 {
00071                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
00072                                         custom_mode_params.erase(i);
00073                                         return;
00074                                 }
00075                         }
00076                 }
00077                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
00078         }
00079 }

Member Data Documentation

BanList chanrec::bans
 

The list of all bans set on the channel.

Definition at line 148 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 144 of file channels.h.

Referenced by chanrec().

time_t chanrec::created
 

Creation time.

Definition at line 100 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 92 of file channels.h.

Referenced by SetCustomMode().

short int chanrec::inviteonly
 

Nonzero if the mode +i is set.

Definition at line 130 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 118 of file channels.h.

long chanrec::limit
 

Contains the channel user limit.

If this value is zero, there is no limit in place.

Definition at line 113 of file channels.h.

Referenced by chanrec().

short int chanrec::moderated
 

Nonzero if the mode +m is set.

Definition at line 134 of file channels.h.

Referenced by chanrec().

char chanrec::name[CHANMAX]
 

The channels name.

Definition at line 88 of file channels.h.

short int chanrec::noexternal
 

Nonzero if the mode +n is set.

Definition at line 126 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 139 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 108 of file channels.h.

char chanrec::topic[MAXBUF]
 

Channel topic.

If this is an empty string, no channel topic is set.

Definition at line 97 of file channels.h.

short int chanrec::topiclock
 

Nonzero if the mode +t is set.

Definition at line 122 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 104 of file channels.h.

Referenced by chanrec().

The documentation for this class was generated from the following files:
Generated on Fri Apr 30 13:23:26 2004 for InspIRCd by doxygen1.3-rc3