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

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:

Inheritance graph
[legend]
Collaboration diagram for userrec:

Collaboration graph
[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.

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.


Public Attributes

char nick [NICKMAX]
 The users nickname.

char ident [16]
 The users ident reply.

char dhost [160]
 The host displayed to non-opers (used for cloaking etc).

char fullname [128]
 The users full name.

char modes [MAXBUF]
 The user's mode string.

ucrec chans [MAXCHANS]
char server [256]
 The server the user is connected to.

char awaymsg [512]
 The user's away message.

char result [256]
 Stores the result of the last GetFullHost or GetRealHost call.

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 28 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, result, sendq, server, connection::signon, TIME, timeout, and ucrec::uc_modes. 

00029 {
00030         // the PROPER way to do it, AVOID bzero at *ALL* costs
00031         strcpy(nick,"");
00032         strcpy(ip,"127.0.0.1");
00033         timeout = 0;
00034         strcpy(ident,"");
00035         strcpy(host,"");
00036         strcpy(dhost,"");
00037         strcpy(fullname,"");
00038         strcpy(modes,"");
00039         strcpy(server,"");
00040         strcpy(awaymsg,"");
00041         strcpy(oper,"");
00042         reset_due = TIME;
00043         lines_in = 0;
00044         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
00045         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
00046         haspassed = false;
00047         dns_done = false;
00048         recvq = "";
00049         sendq = "";
00050         strcpy(result,"");
00051         for (int i = 0; i < MAXCHANS; i++)
00052         {
00053                 this->chans[i].channel = NULL;
00054                 this->chans[i].uc_modes = 0;
00055         }
00056         invites.clear();
00057 }

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

Definition at line 222 of file users.h. 

00222 {  }

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 169 of file users.cpp.

References recvq, recvqmax, and SetWriteError(). 

00170 {
00171         std::string b = "";
00172         for (int i = 0; i < a.length(); i++)
00173                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
00174                         b = b + a[i];
00175         std::stringstream stream(recvq);
00176         stream << b;
00177         recvq = stream.str();
00178         int i = 0;
00179         // count the size of the first line in the buffer.
00180         while (i < recvq.length())
00181         {
00182                 if (recvq[i++] == '\n')
00183                         break;
00184         }
00185         if (recvq.length() > this->recvqmax)
00186         {
00187                 this->SetWriteError("RecvQ exceeded");
00188                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
00189         }
00190         // return false if we've had more than 600 characters WITHOUT
00191         // a carriage return (this is BAD, drop the socket)
00192         return (i < 600);
00193 }

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 225 of file users.cpp.

References GetWriteError(), sendq, sendqmax, and SetWriteError(). 

00226 {
00227         if (this->GetWriteError() != "")
00228                 return;
00229         if (sendq.length() + data.length() > this->sendqmax)
00230         {
00231                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
00232                 this->SetWriteError("SendQ exceeded");
00233                 return;
00234         }
00235         std::stringstream stream;
00236         stream << sendq << data;
00237         sendq = stream.str();
00238 }

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 195 of file users.cpp.

References recvq. 

00196 {
00197         for (int i = 0; i < recvq.length(); i++)
00198                 if (recvq[i] == '\n')
00199                         return true;
00200         return false;
00201 }

void userrec::ClearBuffer (   ) 
 

This function clears the entire buffer by setting it to an empty string.

Definition at line 203 of file users.cpp.

References recvq.

Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). 

00204 {
00205         recvq = "";
00206 }

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 241 of file users.cpp.

References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). 

00242 {
00243         if (sendq.length())
00244         {
00245                 char* tb = (char*)this->sendq.c_str();
00246                 int n_sent = write(this->fd,tb,this->sendq.length());
00247                 if (n_sent == -1)
00248                 {
00249                         this->SetWriteError(strerror(errno));
00250                 }
00251                 else
00252                 {
00253                         // advance the queue
00254                         tb += n_sent;
00255                         this->sendq = tb;
00256                         // update the user's stats counters
00257                         this->bytes_out += n_sent;
00258                         this->cmds_out++;
00259                 }
00260         }
00261 }

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 208 of file users.cpp.

References recvq. 

00209 {
00210         if (recvq == "")
00211                 return "";
00212         char* line = (char*)recvq.c_str();
00213         std::string ret = "";
00214         while ((*line != '\n') && (strlen(line)))
00215         {
00216                 ret = ret + *line;
00217                 line++;
00218         }
00219         if ((*line == '\n') || (*line == '\r'))
00220                 line++;
00221         recvq = line;
00222         return ret;
00223 }

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 61 of file users.cpp.

References dhost, ident, nick, and result. 

00062 {
00063         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
00064         return result;
00065 }

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 68 of file users.cpp.

References connection::host, ident, nick, and result. 

00069 {
00070         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
00071         return result;
00072 }

std::string userrec::GetWriteError (   ) 
 

Returns the write error which last occured on this connection or an empty string if none occured.

Definition at line 271 of file users.cpp.

References WriteError.

Referenced by AddWriteBuf(). 

00272 {
00273         return this->WriteError;
00274 }

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 117 of file users.cpp.

References config_f, and DEBUG. 

00118 {
00119         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
00120         char* mycmd;
00121         char* savept;
00122         char* savept2;
00123         
00124         // are they even an oper at all?
00125         if (strchr(this->modes,'o'))
00126         {
00127                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
00128                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
00129                 {
00130                         ConfValue("type","name",j,TypeName,&config_f);
00131                         if (!strcmp(TypeName,this->oper))
00132                         {
00133                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
00134                                 ConfValue("type","classes",j,Classes,&config_f);
00135                                 char* myclass = strtok_r(Classes," ",&savept);
00136                                 while (myclass)
00137                                 {
00138                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
00139                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
00140                                         {
00141                                                 ConfValue("class","name",k,ClassName,&config_f);
00142                                                 if (!strcmp(ClassName,myclass))
00143                                                 {
00144                                                         ConfValue("class","commands",k,CommandList,&config_f);
00145                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
00146                                                         
00147                                                         
00148                                                         mycmd = strtok_r(CommandList," ",&savept2);
00149                                                         while (mycmd)
00150                                                         {
00151                                                                 if (!strcasecmp(mycmd,command))
00152                                                                 {
00153                                                                         log(DEBUG,"*** Command %s found, returning true",command);
00154                                                                         return true;
00155                                                                 }
00156                                                                 mycmd = strtok_r(NULL," ",&savept2);
00157                                                         }
00158                                                 }
00159                                         }
00160                                         myclass = strtok_r(NULL," ",&savept);
00161                                 }
00162                         }
00163                 }
00164         }
00165         return false;
00166 }

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

Adds a channel to a users invite list (invites them to a channel).

Definition at line 88 of file users.cpp.

References Invited::channel, and invites. 

00089 {
00090         Invited i;
00091         strlcpy(i.channel,channel,CHANMAX);
00092         invites.push_back(i);
00093 }

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

Returns true if a user is invited to a channel.

Definition at line 74 of file users.cpp.

References invites. 

00075 {
00076         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00077         {
00078                 if (i->channel) {
00079                         if (!strcasecmp(i->channel,channel))
00080                         {
00081                                 return true;
00082                         }
00083                 }
00084         }
00085         return false;
00086 }

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 95 of file users.cpp.

References DEBUG, and invites. 

00096 {
00097         log(DEBUG,"Removing invites");
00098         if (channel)
00099         {
00100                 if (invites.size())
00101                 {
00102                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00103                         {
00104                                 if (i->channel)
00105                                 {
00106                                         if (!strcasecmp(i->channel,channel))
00107                                         {
00108                                                 invites.erase(i);
00109                                                 return;
00110                                         }
00111                                 }
00112                         }
00113                 }
00114         }
00115 }

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 263 of file users.cpp.

References DEBUG, and WriteError.

Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). 

00264 {
00265         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
00266         // don't try to set the error twice, its already set take the first string.
00267         if (this->WriteError == "")
00268                 this->WriteError = error;
00269 }

Member Data Documentation

char userrec::awaymsg[512]
 

The user's away message.

If this string is empty, the user is not marked as away.

Definition at line 151 of file users.h.

Referenced by userrec().

ucrec userrec::chans[MAXCHANS]
 

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

Referenced by GetFullHost(), and userrec().

bool userrec::dns_done
 

True when DNS lookups are completed.

Definition at line 179 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 162 of file users.h.

Referenced by userrec().

char userrec::fullname[128]
 

The users full name.

Definition at line 134 of file users.h.

Referenced by userrec().

char userrec::ident[16]
 

The users ident reply.

Definition at line 125 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 InviteTo(), IsInvited(), RemoveInvite(), and userrec().

int userrec::lines_in
 

Flood counters.

Definition at line 204 of file users.h.

Referenced by userrec().

char userrec::modes[MAXBUF]
 

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.

Definition at line 140 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 175 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 189 of file users.h.

unsigned int userrec::pingmax
 

Number of seconds between PINGs for this user (set from <connect:allow> tag.

Definition at line 183 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 195 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 218 of file users.h.

Referenced by AddBuffer().

time_t userrec::reset_due
 

Definition at line 205 of file users.h.

Referenced by userrec().

char userrec::result[256]
 

Stores the result of the last GetFullHost or GetRealHost call.

You may use this to increase the speed of use of this class.

Definition at line 156 of file users.h.

Referenced by GetFullHost(), GetFullRealHost(), and 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 200 of file users.h.

Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().

long userrec::sendqmax
 

Maximum size this user's sendq can become.

Definition at line 214 of file users.h.

Referenced by AddWriteBuf().

char userrec::server[256]
 

The server the user is connected to.

Definition at line 146 of file users.h.

Referenced by userrec().

long userrec::threshold
 

Definition at line 206 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 168 of file users.h.

Referenced by userrec().

std::string userrec::WriteError
 

Definition at line 210 of file users.h.

Referenced by GetWriteError(), and SetWriteError().

The documentation for this class was generated from the following files:
Generated on Fri May 13 15:50:05 2005 for InspIRCd by doxygen 1.3.3