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 (irc::string &channel)
 Returns true if a user is invited to a channel.
virtual void InviteTo (irc::string &channel)
 Adds a channel to a users invite list (invites them to a channel).
virtual void RemoveInvite (irc::string &channel)
 Removes a channel from a users invite list.
bool HasPermission (std::string &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 115 of file users.h.

Constructor & Destructor Documentation

userrec::userrec (   ) 
 

Definition at line 63 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.

00064 {
00065         // the PROPER way to do it, AVOID bzero at *ALL* costs
00066         strcpy(nick,"");
00067         strcpy(ip,"127.0.0.1");
00068         timeout = 0;
00069         strcpy(ident,"");
00070         strcpy(host,"");
00071         strcpy(dhost,"");
00072         strcpy(fullname,"");
00073         strcpy(modes,"");
00074         server = (char*)FindServerNamePtr(Config->ServerName);
00075         strcpy(awaymsg,"");
00076         strcpy(oper,"");
00077         reset_due = TIME;
00078         lines_in = 0;
00079         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
00080         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
00081         haspassed = false;
00082         dns_done = false;
00083         recvq = "";
00084         sendq = "";
00085         chans.clear();
00086         invites.clear();
00087 }

userrec::~userrec (   )  [virtual]
 

Definition at line 89 of file users.cpp.

00090 {
00091 }

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

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

00220 {
00221         std::string b = "";
00222         for (unsigned int i = 0; i < a.length(); i++)
00223                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
00224                         b = b + a[i];
00225         std::stringstream stream(recvq);
00226         stream << b;
00227         recvq = stream.str();
00228         unsigned int i = 0;
00229         // count the size of the first line in the buffer.
00230         while (i < recvq.length())
00231         {
00232                 if (recvq[i++] == '\n')
00233                         break;
00234         }
00235         if (recvq.length() > (unsigned)this->recvqmax)
00236         {
00237                 this->SetWriteError("RecvQ exceeded");
00238                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
00239         }
00240         // return false if we've had more than 600 characters WITHOUT
00241         // a carriage return (this is BAD, drop the socket)
00242         return (i < 600);
00243 }

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

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

00276 {
00277         if (this->GetWriteError() != "")
00278                 return;
00279         if (sendq.length() + data.length() > (unsigned)this->sendqmax)
00280         {
00281                 /* Fix by brain - Set the error text BEFORE calling writeopers, because
00282                  * if we dont it'll recursively  call here over and over again trying
00283                  * to repeatedly add the text to the sendq!
00284                  */
00285                 this->SetWriteError("SendQ exceeded");
00286                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
00287                 return;
00288         }
00289         std::stringstream stream;
00290         stream << sendq << data;
00291         sendq = stream.str();
00292 }

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

References recvq.

00246 {
00247         for (unsigned int i = 0; i < recvq.length(); i++)
00248                 if (recvq[i] == '\n')
00249                         return true;
00250         return false;
00251 }

void userrec::ClearBuffer (   ) 
 

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

Definition at line 253 of file users.cpp.

References recvq.

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

00254 {
00255         recvq = "";
00256 }

void userrec::CloseSocket (   ) 
 

Shuts down and closes the user's socket.

Definition at line 93 of file users.cpp.

Referenced by kill_link(), and kill_link_silent().

00094 {
00095         shutdown(this->fd,2);
00096         close(this->fd);
00097 }

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

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

Referenced by kill_link(), and kill_link_silent().

00296 {
00297         if (sendq.length())
00298         {
00299                 char* tb = (char*)this->sendq.c_str();
00300                 int n_sent = write(this->fd,tb,this->sendq.length());
00301                 if (n_sent == -1)
00302                 {
00303                         this->SetWriteError(strerror(errno));
00304                 }
00305                 else
00306                 {
00307                         // advance the queue
00308                         tb += n_sent;
00309                         this->sendq = tb;
00310                         // update the user's stats counters
00311                         this->bytes_out += n_sent;
00312                         this->cmds_out++;
00313                 }
00314         }
00315 }

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

References recvq.

00259 {
00260         if (recvq == "")
00261                 return "";
00262         char* line = (char*)recvq.c_str();
00263         std::string ret = "";
00264         while ((*line != '\n') && (strlen(line)))
00265         {
00266                 ret = ret + *line;
00267                 line++;
00268         }
00269         if ((*line == '\n') || (*line == '\r'))
00270                 line++;
00271         recvq = line;
00272         return ret;
00273 }

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

References dhost, ident, and nick.

Referenced by add_channel().

00100 {
00101         static char result[MAXBUF];
00102         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
00103         return result;
00104 }

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

References connection::host, ident, and nick.

00117 {
00118         static char fresult[MAXBUF];
00119         snprintf(fresult,MAXBUF,"%s!%s@%s",nick,ident,host);
00120         return fresult;
00121 }

InvitedList * userrec::GetInviteList (   ) 
 

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

Definition at line 136 of file users.cpp.

References invites.

00137 {
00138         return &invites;
00139 }

std::string userrec::GetWriteError (   ) 
 

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

Definition at line 325 of file users.cpp.

References WriteError.

00326 {
00327         return this->WriteError;
00328 }

bool userrec::HasPermission (  std::string &  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 165 of file users.cpp.

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

00166 {
00167         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
00168         char* mycmd;
00169         char* savept;
00170         char* savept2;
00171         
00172         // users on u-lined servers can completely bypass
00173         // all permissions based checks.
00174         //
00175         // of course, if this is sent to a remote server and this
00176         // server is not ulined there, then that other server
00177         // silently drops the command.
00178         if (is_uline(this->server))
00179                 return true;
00180         
00181         // are they even an oper at all?
00182         if (strchr(this->modes,'o'))
00183         {
00184                 for (int j =0; j < Config->ConfValueEnum("type",&Config->config_f); j++)
00185                 {
00186                         Config->ConfValue("type","name",j,TypeName,&Config->config_f);
00187                         if (!strcmp(TypeName,this->oper))
00188                         {
00189                                 Config->ConfValue("type","classes",j,Classes,&Config->config_f);
00190                                 char* myclass = strtok_r(Classes," ",&savept);
00191                                 while (myclass)
00192                                 {
00193                                         for (int k =0; k < Config->ConfValueEnum("class",&Config->config_f); k++)
00194                                         {
00195                                                 Config->ConfValue("class","name",k,ClassName,&Config->config_f);
00196                                                 if (!strcmp(ClassName,myclass))
00197                                                 {
00198                                                         Config->ConfValue("class","commands",k,CommandList,&Config->config_f);
00199                                                         mycmd = strtok_r(CommandList," ",&savept2);
00200                                                         while (mycmd)
00201                                                         {
00202                                                                 if ((!strcasecmp(mycmd,command.c_str())) || (*mycmd == '*'))
00203                                                                 {
00204                                                                         return true;
00205                                                                 }
00206                                                                 mycmd = strtok_r(NULL," ",&savept2);
00207                                                         }
00208                                                 }
00209                                         }
00210                                         myclass = strtok_r(NULL," ",&savept);
00211                                 }
00212                         }
00213                 }
00214         }
00215         return false;
00216 }

void userrec::InviteTo (  irc::string &  channel  )  [virtual]
 

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

Definition at line 141 of file users.cpp.

References Invited::channel, and invites.

00142 {
00143         Invited i;
00144         i.channel = channel;
00145         invites.push_back(i);
00146 }

bool userrec::IsInvited (  irc::string &  channel  )  [virtual]
 

Returns true if a user is invited to a channel.

Definition at line 123 of file users.cpp.

References invites.

Referenced by add_channel().

00124 {
00125         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00126         {
00127                 irc::string compare = i->channel;
00128                 if (compare == channel)
00129                 {
00130                         return true;
00131                 }
00132         }
00133         return false;
00134 }

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

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

Definition at line 106 of file users.cpp.

00107 {
00108         if (this->fd > -1)
00109         {
00110                 return read(this->fd, buffer, size);
00111         }
00112         else return 0;
00113 }

void userrec::RemoveInvite (  irc::string &  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 148 of file users.cpp.

References DEBUG, invites, and log().

Referenced by add_channel().

00149 {
00150         log(DEBUG,"Removing invites");
00151         if (invites.size())
00152         {
00153                 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00154                 {
00155                         irc::string compare = i->channel;
00156                         if (compare == channel)
00157                         {
00158                                 invites.erase(i);
00159                                 return;
00160                         }
00161                 }
00162         }
00163 }

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

References DEBUG, log(), and WriteError.

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

00318 {
00319         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
00320         // don't try to set the error twice, its already set take the first string.
00321         if (this->WriteError == "")
00322                 this->WriteError = error;
00323 }

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

Referenced by userrec().

std::vector<ucrec> userrec::chans
 

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

Referenced by AddWhoWas(), GetFullHost(), and userrec().

bool userrec::dns_done
 

True when DNS lookups are completed.

Definition at line 185 of file users.h.

Referenced by ConnectUser(), and 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 168 of file users.h.

Referenced by userrec().

char userrec::fullname[MAXGECOS+1]
 

The users full name.

Definition at line 142 of file users.h.

Referenced by AddWhoWas(), and 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 133 of file users.h.

Referenced by AddWhoWas(), FullConnectUser(), GetFullHost(), GetFullRealHost(), kill_link(), kill_link_silent(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().

InvitedList userrec::invites [private]
 

A list of channels the user has a pending invite to.

Definition at line 121 of file users.h.

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

int userrec::lines_in
 

Flood counters.

Definition at line 210 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 151 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 128 of file users.h.

Referenced by add_channel(), AddWhoWas(), del_channel(), ConfigReader::DumpErrors(), FullConnectUser(), GetFullHost(), GetFullRealHost(), kick_channel(), kill_link(), kill_link_silent(), 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 181 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 195 of file users.h.

unsigned int userrec::pingmax
 

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

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

Referenced by AddBuffer().

time_t userrec::reset_due
 

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

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

long userrec::sendqmax
 

Maximum size this user's sendq can become.

Definition at line 220 of file users.h.

Referenced by AddWriteBuf().

char* userrec::server
 

The server the user is connected to.

Definition at line 157 of file users.h.

Referenced by AddWhoWas(), kick_channel(), and userrec().

long userrec::threshold
 

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

Referenced by userrec().

std::string userrec::WriteError
 

Definition at line 216 of file users.h.

Referenced by GetWriteError(), and SetWriteError().

The documentation for this class was generated from the following files:
Generated on Mon Dec 19 18:05:24 2005 for InspIRCd by  doxygen 1.4.4-20050815