Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class 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 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.
virtual ~userrec ()

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.
std::vector< ucrec > chans
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 111 of file users.h.

Constructor & Destructor Documentation

userrec::userrec (   ) 
 

Definition at line 36 of file users.cpp.

References awaymsg, connection::bytes_in, connection::bytes_out, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, FindServerNamePtr(), 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, ServerConfig::ServerName, connection::signon, TIME, and timeout.

00037 {
00038         // the PROPER way to do it, AVOID bzero at *ALL* costs
00039         strcpy(nick,"");
00040         strcpy(ip,"127.0.0.1");
00041         timeout = 0;
00042         strcpy(ident,"");
00043         strcpy(host,"");
00044         strcpy(dhost,"");
00045         strcpy(fullname,"");
00046         strcpy(modes,"");
00047         server = (char*)FindServerNamePtr(Config->ServerName);
00048         strcpy(awaymsg,"");
00049         strcpy(oper,"");
00050         reset_due = TIME;
00051         lines_in = 0;
00052         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
00053         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
00054         haspassed = false;
00055         dns_done = false;
00056         recvq = "";
00057         sendq = "";
00058         chans.clear();
00059         invites.clear();
00060 }

userrec::~userrec (   )  [virtual]
 

Definition at line 62 of file users.cpp.

00063 {
00064 }

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

References recvq, recvqmax, SetWriteError(), and WriteOpers().

00199 {
00200         std::string b = "";
00201         for (unsigned int i = 0; i < a.length(); i++)
00202                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
00203                         b = b + a[i];
00204         std::stringstream stream(recvq);
00205         stream << b;
00206         recvq = stream.str();
00207         unsigned int i = 0;
00208         // count the size of the first line in the buffer.
00209         while (i < recvq.length())
00210         {
00211                 if (recvq[i++] == '\n')
00212                         break;
00213         }
00214         if (recvq.length() > (unsigned)this->recvqmax)
00215         {
00216                 this->SetWriteError("RecvQ exceeded");
00217                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
00218         }
00219         // return false if we've had more than 600 characters WITHOUT
00220         // a carriage return (this is BAD, drop the socket)
00221         return (i < 600);
00222 }

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

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

00255 {
00256         if (this->GetWriteError() != "")
00257                 return;
00258         if (sendq.length() + data.length() > (unsigned)this->sendqmax)
00259         {
00260                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
00261                 this->SetWriteError("SendQ exceeded");
00262                 return;
00263         }
00264         std::stringstream stream;
00265         stream << sendq << data;
00266         sendq = stream.str();
00267 }

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

References recvq.

00225 {
00226         for (unsigned int i = 0; i < recvq.length(); i++)
00227                 if (recvq[i] == '\n')
00228                         return true;
00229         return false;
00230 }

void userrec::ClearBuffer (   ) 
 

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

Definition at line 232 of file users.cpp.

References recvq.

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

00233 {
00234         recvq = "";
00235 }

void userrec::CloseSocket (   ) 
 

Shuts down and closes the user's socket.

Definition at line 66 of file users.cpp.

00067 {
00068         shutdown(this->fd,2);
00069         close(this->fd);
00070 }

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

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

00271 {
00272         if (sendq.length())
00273         {
00274                 char* tb = (char*)this->sendq.c_str();
00275                 int n_sent = write(this->fd,tb,this->sendq.length());
00276                 if (n_sent == -1)
00277                 {
00278                         this->SetWriteError(strerror(errno));
00279                 }
00280                 else
00281                 {
00282                         // advance the queue
00283                         tb += n_sent;
00284                         this->sendq = tb;
00285                         // update the user's stats counters
00286                         this->bytes_out += n_sent;
00287                         this->cmds_out++;
00288                 }
00289         }
00290 }

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

References recvq.

00238 {
00239         if (recvq == "")
00240                 return "";
00241         char* line = (char*)recvq.c_str();
00242         std::string ret = "";
00243         while ((*line != '\n') && (strlen(line)))
00244         {
00245                 ret = ret + *line;
00246                 line++;
00247         }
00248         if ((*line == '\n') || (*line == '\r'))
00249                 line++;
00250         recvq = line;
00251         return ret;
00252 }

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

References dhost, ident, and nick.

Referenced by add_channel().

00073 {
00074         static char result[MAXBUF];
00075         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
00076         return result;
00077 }

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

References connection::host, ident, and nick.

00090 {
00091         static char fresult[MAXBUF];
00092         snprintf(fresult,MAXBUF,"%s!%s@%s",nick,ident,host);
00093         return fresult;
00094 }

InvitedList * userrec::GetInviteList (   ) 
 

Returns the list of channels this user has been invited to but has not yet joined.

Definition at line 110 of file users.cpp.

References invites.

00111 {
00112         return &invites;
00113 }

std::string userrec::GetWriteError (   ) 
 

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

Definition at line 300 of file users.cpp.

References WriteError.

00301 {
00302         return this->WriteError;
00303 }

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

References ServerConfig::config_f, ServerConfig::ConfValue(), and is_uline().

00145 {
00146         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
00147         char* mycmd;
00148         char* savept;
00149         char* savept2;
00150         
00151         // users on u-lined servers can completely bypass
00152         // all permissions based checks.
00153         //
00154         // of course, if this is sent to a remote server and this
00155         // server is not ulined there, then that other server
00156         // silently drops the command.
00157         if (is_uline(this->server))
00158                 return true;
00159         
00160         // are they even an oper at all?
00161         if (strchr(this->modes,'o'))
00162         {
00163                 for (int j =0; j < Config->ConfValueEnum("type",&Config->config_f); j++)
00164                 {
00165                         Config->ConfValue("type","name",j,TypeName,&Config->config_f);
00166                         if (!strcmp(TypeName,this->oper))
00167                         {
00168                                 Config->ConfValue("type","classes",j,Classes,&Config->config_f);
00169                                 char* myclass = strtok_r(Classes," ",&savept);
00170                                 while (myclass)
00171                                 {
00172                                         for (int k =0; k < Config->ConfValueEnum("class",&Config->config_f); k++)
00173                                         {
00174                                                 Config->ConfValue("class","name",k,ClassName,&Config->config_f);
00175                                                 if (!strcmp(ClassName,myclass))
00176                                                 {
00177                                                         Config->ConfValue("class","commands",k,CommandList,&Config->config_f);
00178                                                         mycmd = strtok_r(CommandList," ",&savept2);
00179                                                         while (mycmd)
00180                                                         {
00181                                                                 if ((!strcasecmp(mycmd,command)) || (*mycmd == '*'))
00182                                                                 {
00183                                                                         return true;
00184                                                                 }
00185                                                                 mycmd = strtok_r(NULL," ",&savept2);
00186                                                         }
00187                                                 }
00188                                         }
00189                                         myclass = strtok_r(NULL," ",&savept);
00190                                 }
00191                         }
00192                 }
00193         }
00194         return false;
00195 }

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

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

Definition at line 115 of file users.cpp.

References Invited::channel, and invites.

00116 {
00117         Invited i;
00118         strlcpy(i.channel,channel,CHANMAX);
00119         invites.push_back(i);
00120 }

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

Returns true if a user is invited to a channel.

Definition at line 96 of file users.cpp.

References invites.

Referenced by add_channel().

00097 {
00098         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00099         {
00100                 if (i->channel) {
00101                         if (!strcasecmp(i->channel,channel))
00102                         {
00103                                 return true;
00104                         }
00105                 }
00106         }
00107         return false;
00108 }

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

Calls read() to read some data for this user using their fd.

Definition at line 79 of file users.cpp.

00080 {
00081         if (this->fd > -1)
00082         {
00083                 return read(this->fd, buffer, size);
00084         }
00085         else return 0;
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 122 of file users.cpp.

References DEBUG, invites, and log().

Referenced by add_channel().

00123 {
00124         log(DEBUG,"Removing invites");
00125         if (channel)
00126         {
00127                 if (invites.size())
00128                 {
00129                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00130                         {
00131                                 if (i->channel)
00132                                 {
00133                                         if (!strcasecmp(i->channel,channel))
00134                                         {
00135                                                 invites.erase(i);
00136                                                 return;
00137                                         }
00138                                 }
00139                         }
00140                 }
00141         }
00142 }

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

References DEBUG, log(), and WriteError.

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

00293 {
00294         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
00295         // don't try to set the error twice, its already set take the first string.
00296         if (this->WriteError == "")
00297                 this->WriteError = error;
00298 }

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 158 of file users.h.

Referenced by userrec().

std::vector<ucrec> userrec::chans
 

Definition at line 149 of file users.h.

Referenced by add_channel(), del_channel(), kick_channel(), 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 134 of file users.h.

Referenced by GetFullHost(), and userrec().

bool userrec::dns_done
 

True when DNS lookups are completed.

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

Referenced by userrec().

char userrec::fullname[MAXGECOS+1]
 

The users full name.

Definition at line 138 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 129 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 117 of file users.h.

Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec().

int userrec::lines_in
 

Flood counters.

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

Referenced by add_channel(), and userrec().

char userrec::nick[NICKMAX]
 

The users nickname.

An invalid nickname indicates an unregistered connection prior to the NICK command.

Definition at line 124 of file users.h.

Referenced by add_channel(), del_channel(), ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), kick_channel(), 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 177 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 <connect> block doesnt need a password, so that modules may check it.

Definition at line 191 of file users.h.

unsigned int userrec::pingmax
 

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

Definition at line 185 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 197 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 220 of file users.h.

Referenced by AddBuffer().

time_t userrec::reset_due
 

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

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

long userrec::sendqmax
 

Maximum size this user's sendq can become.

Definition at line 216 of file users.h.

Referenced by AddWriteBuf().

char* userrec::server
 

The server the user is connected to.

Definition at line 153 of file users.h.

Referenced by kick_channel(), and userrec().

long userrec::threshold
 

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

Referenced by userrec().

std::string userrec::WriteError
 

Definition at line 212 of file users.h.

Referenced by GetWriteError(), and SetWriteError().

The documentation for this class was generated from the following files:
Generated on Wed Dec 14 19:16:28 2005 for InspIRCd by  doxygen 1.4.4-20050815