userrec Class Reference

Holds all information about a user This class stores all information about a user connected to the irc server. More...

#include <users.h>

Inheritance diagram for userrec:

[legend]Collaboration diagram for userrec:

[legend]List of all members.

Public Member Functions
	userrec ()
virtual	~userrec ()
virtual char *	GetFullHost ()
	Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
virtual char *	GetFullRealHost ()
	Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
virtual bool	IsInvited (char *channel)
	Returns true if a user is invited to a channel.
virtual void	InviteTo (char *channel)
	Adds a channel to a users invite list (invites them to a channel).
virtual void	RemoveInvite (char *channel)
	Removes a channel from a users invite list.
bool	HasPermission (char *command)
	Returns true or false for if a user can execute a privilaged oper command.
int	ReadData (void *buffer, size_t size)
	Calls read() to read some data for this user using their fd.
bool	AddBuffer (std::string a)
	This method adds data to the buffer of the user.
bool	BufferIsReady ()
	This method returns true if the buffer contains at least one carriage return character (e.g.
void	ClearBuffer ()
	This function clears the entire buffer by setting it to an empty string.
std::string	GetBuffer ()
	This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string.
void	SetWriteError (std::string error)
	Sets the write error for a connection.
std::string	GetWriteError ()
	Returns the write error which last occured on this connection or an empty string if none occured.
void	AddWriteBuf (std::string data)
	Adds to the user's write buffer.
void	FlushWriteBuf ()
	Flushes as much of the user's buffer to the file descriptor as possible.
InvitedList *	GetInviteList ()
	Returns the list of channels this user has been invited to but has not yet joined.
void	CloseSocket ()
	Shuts down and closes the user's socket.
Public Attributes
char	nick [NICKMAX]
	The users nickname.
char	ident [IDENTMAX+2]
	The users ident reply.
char	dhost [160]
	The host displayed to non-opers (used for cloaking etc).
char	fullname [MAXGECOS+1]
	The users full name.
char	modes [54]
	The user's mode string.
ucrec	chans [MAXCHANS]
char *	server
	The server the user is connected to.
char	awaymsg [MAXAWAY+1]
	The user's away message.
int	flood
	Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
unsigned int	timeout
	Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.
char	oper [NICKMAX]
	The oper type they logged in as, if they are an oper.
bool	dns_done
	True when DNS lookups are completed.
unsigned int	pingmax
	Number of seconds between PINGs for this user (set from <connect:allow> tag.
char	password [MAXBUF]
	Password specified by the user when they registered.
std::string	recvq
	User's receive queue.
std::string	sendq
	User's send queue.
int	lines_in
	Flood counters.
time_t	reset_due
long	threshold
std::string	WriteError
long	sendqmax
	Maximum size this user's sendq can become.
long	recvqmax
	Maximum size this user's recvq can become.
Private Attributes
InvitedList	invites
	A list of channels the user has a pending invite to.

---

Detailed Description

Holds all information about a user This class stores all information about a user connected to the irc server.

Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname.

Definition at line 108 of file users.h.

---

Constructor & Destructor Documentation

userrec::userrec (   )

Definition at line 32 of file users.cpp. References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, sendq, server, ServerName, connection::signon, TIME, timeout, and ucrec::uc_modes. { // the PROPER way to do it, AVOID bzero at *ALL* costs strcpy(nick,""); strcpy(ip,"127.0.0.1"); timeout = 0; strcpy(ident,""); strcpy(host,""); strcpy(dhost,""); strcpy(fullname,""); strcpy(modes,""); server = (char*)FindServerNamePtr(ServerName); strcpy(awaymsg,""); strcpy(oper,""); reset_due = TIME; lines_in = 0; fd = lastping = signon = idle_lastmsg = nping = registered = 0; flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; haspassed = false; dns_done = false; recvq = ""; sendq = ""; for (int i = 0; i < MAXCHANS; i++) { this->chans[i].channel = NULL; this->chans[i].uc_modes = 0; } invites.clear(); }

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

Definition at line 221 of file users.h. { }

---

Member Function Documentation

bool userrec::AddBuffer (  std::string  a  )

This method adds data to the buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted. Definition at line 192 of file users.cpp. References recvq, recvqmax, and SetWriteError(). { std::string b = ""; for (int i = 0; i < a.length(); i++) if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) b = b + a[i]; std::stringstream stream(recvq); stream << b; recvq = stream.str(); int i = 0; // count the size of the first line in the buffer. while (i < recvq.length()) { if (recvq[i++] == '\n') break; } if (recvq.length() > this->recvqmax) { this->SetWriteError("RecvQ exceeded"); WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax); } // return false if we've had more than 600 characters WITHOUT // a carriage return (this is BAD, drop the socket) return (i < 600); }

void userrec::AddWriteBuf (  std::string  data  )

Adds to the user's write buffer. You may add any amount of text up to this users sendq value, if you exceed the sendq value, SetWriteError() will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped. Definition at line 248 of file users.cpp. References GetWriteError(), sendq, sendqmax, and SetWriteError(). { if (this->GetWriteError() != "") return; if (sendq.length() + data.length() > this->sendqmax) { WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax); this->SetWriteError("SendQ exceeded"); return; } std::stringstream stream; stream << sendq << data; sendq = stream.str(); }

bool userrec::BufferIsReady (   )

This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read) Definition at line 218 of file users.cpp. References recvq. { for (int i = 0; i < recvq.length(); i++) if (recvq[i] == '\n') return true; return false; }

void userrec::ClearBuffer (   )

This function clears the entire buffer by setting it to an empty string. Definition at line 226 of file users.cpp. References recvq. Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). { recvq = ""; }

void userrec::CloseSocket (   )

Shuts down and closes the user's socket. Definition at line 62 of file users.cpp. { shutdown(this->fd,2); close(this->fd); }

void userrec::FlushWriteBuf (   )

Flushes as much of the user's buffer to the file descriptor as possible. This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method. Definition at line 264 of file users.cpp. References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). { if (sendq.length()) { char* tb = (char*)this->sendq.c_str(); int n_sent = write(this->fd,tb,this->sendq.length()); if (n_sent == -1) { this->SetWriteError(strerror(errno)); } else { // advance the queue tb += n_sent; this->sendq = tb; // update the user's stats counters this->bytes_out += n_sent; this->cmds_out++; } } }

std::string userrec::GetBuffer (   )

This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use BufferIsReady() to check if it is ok to read the buffer before calling GetBuffer(). Definition at line 231 of file users.cpp. References recvq. { if (recvq == "") return ""; char* line = (char*)recvq.c_str(); std::string ret = ""; while ((*line != '\n') && (strlen(line))) { ret = ret + *line; line++; } if ((*line == '\n') || (*line == '\r')) line++; recvq = line; return ret; }

char * userrec::GetFullHost (   )  [virtual]

Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 68 of file users.cpp. References dhost, ident, and nick. { static char result[MAXBUF]; snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); return result; }

char * userrec::GetFullRealHost (   )  [virtual]

Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname. Definition at line 85 of file users.cpp. References connection::host, ident, and nick. { static char fresult[MAXBUF]; snprintf(fresult,MAXBUF,"%s!%s@%s",nick,ident,host); return fresult; }

InvitedList * userrec::GetInviteList (   )

Returns the list of channels this user has been invited to but has not yet joined. Definition at line 106 of file users.cpp. References InvitedList, and invites. { return &invites; }

std::string userrec::GetWriteError (   )

Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 294 of file users.cpp. References WriteError. Referenced by AddWriteBuf(). { return this->WriteError; }

bool userrec::HasPermission (  char *  command  )

Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from userrec::oper, then referencing this to their oper classes and checking the commands they can execute. Definition at line 140 of file users.cpp. References config_f, and DEBUG. { char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; char* mycmd; char* savept; char* savept2; // are they even an oper at all? if (strchr(this->modes,'o')) { log(DEBUG,"*** HasPermission: %s is an oper",this->nick); for (int j =0; j < ConfValueEnum("type",&config_f); j++) { ConfValue("type","name",j,TypeName,&config_f); if (!strcmp(TypeName,this->oper)) { log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); ConfValue("type","classes",j,Classes,&config_f); char* myclass = strtok_r(Classes," ",&savept); while (myclass) { log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); for (int k =0; k < ConfValueEnum("class",&config_f); k++) { ConfValue("class","name",k,ClassName,&config_f); if (!strcmp(ClassName,myclass)) { ConfValue("class","commands",k,CommandList,&config_f); log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); mycmd = strtok_r(CommandList," ",&savept2); while (mycmd) { if (!strcasecmp(mycmd,command)) { log(DEBUG,"*** Command %s found, returning true",command); return true; } mycmd = strtok_r(NULL," ",&savept2); } } } myclass = strtok_r(NULL," ",&savept); } } } } return false; }

void userrec::InviteTo (  char *  channel  )  [virtual]

Adds a channel to a users invite list (invites them to a channel). Definition at line 111 of file users.cpp. References Invited::channel, and invites. { Invited i; strlcpy(i.channel,channel,CHANMAX); invites.push_back(i); }

bool userrec::IsInvited (  char *  channel  )  [virtual]

Returns true if a user is invited to a channel. Definition at line 92 of file users.cpp. References invites. { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (i->channel) { if (!strcasecmp(i->channel,channel)) { return true; } } } return false; }

int userrec::ReadData (  void *  buffer, size_t  size )

Calls read() to read some data for this user using their fd. Definition at line 75 of file users.cpp. References connection::fd. { if (this->fd > -1) { return read(this->fd, buffer, size); } else return 0; }

void userrec::RemoveInvite (  char *  channel  )  [virtual]

Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation. Definition at line 118 of file users.cpp. References DEBUG, and invites. { log(DEBUG,"Removing invites"); if (channel) { if (invites.size()) { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (i->channel) { if (!strcasecmp(i->channel,channel)) { invites.erase(i); return; } } } } } }

void userrec::SetWriteError (  std::string  error  )

Sets the write error for a connection. This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged. Definition at line 286 of file users.cpp. References DEBUG, and WriteError. Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). { log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str()); // don't try to set the error twice, its already set take the first string. if (this->WriteError == "") this->WriteError = error; }

---

Member Data Documentation

char userrec::awaymsg[MAXAWAY+1]

The user's away message. If this string is empty, the user is not marked as away. Definition at line 155 of file users.h. Referenced by userrec().

ucrec userrec::chans[MAXCHANS]

Definition at line 146 of file users.h. Referenced by Server::PseudoToUser(), and userrec().

char userrec::dhost[160]

The host displayed to non-opers (used for cloaking etc). This usually matches the value of userrec::host. Definition at line 131 of file users.h. Referenced by GetFullHost(), and userrec().

bool userrec::dns_done

True when DNS lookups are completed. Definition at line 178 of file users.h. Referenced by userrec().

int userrec::flood

Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 161 of file users.h. Referenced by userrec().

char userrec::fullname[MAXGECOS+1]

The users full name. Definition at line 135 of file users.h. Referenced by userrec().

char userrec::ident[IDENTMAX+2]

The users ident reply. Two characters are added to the user-defined limit to compensate for the tilde etc. Definition at line 126 of file users.h. Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().

InvitedList userrec::invites [private]

A list of channels the user has a pending invite to. Definition at line 114 of file users.h. Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec().

int userrec::lines_in

Flood counters. Definition at line 203 of file users.h. Referenced by userrec().

char userrec::modes[54]

The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. it is limited to length 54, as there can only be a maximum of 52 user modes (26 upper, 26 lower case) a null terminating char, and an optional + character. Definition at line 144 of file users.h. Referenced by userrec().

char userrec::nick[NICKMAX]

The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command. Definition at line 121 of file users.h. Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().

char userrec::oper[NICKMAX]

The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag. Definition at line 174 of file users.h. Referenced by userrec().

char userrec::password[MAXBUF]

Password specified by the user when they registered. This is stored even if the block doesnt need a password, so that modules may check it. Definition at line 188 of file users.h.

unsigned int userrec::pingmax

Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 182 of file users.h.

std::string userrec::recvq

User's receive queue. Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy. Definition at line 194 of file users.h. Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec().

long userrec::recvqmax

Maximum size this user's recvq can become. Definition at line 217 of file users.h. Referenced by AddBuffer().

time_t userrec::reset_due

Definition at line 204 of file users.h. Referenced by userrec().

std::string userrec::sendq

User's send queue. Lines waiting to be sent are stored here until their buffer is flushed. Definition at line 199 of file users.h. Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().

long userrec::sendqmax

Maximum size this user's sendq can become. Definition at line 213 of file users.h. Referenced by AddWriteBuf().

char* userrec::server

The server the user is connected to. Definition at line 150 of file users.h. Referenced by userrec().

long userrec::threshold

Definition at line 205 of file users.h.

unsigned int userrec::timeout

Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 167 of file users.h. Referenced by userrec().

std::string userrec::WriteError

Definition at line 209 of file users.h. Referenced by GetWriteError(), and SetWriteError().

---

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

• users.h
• users.cpp

---