#include <users.h>
Inherits connection.
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 [64] |
The users ident reply. | |
char | dhost [256] |
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 long | 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 long | 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. | |
long | 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. |
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.
|
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, connection::inbuf, 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(inbuf,""); 00040 strcpy(server,""); 00041 strcpy(awaymsg,""); 00042 strcpy(oper,""); 00043 reset_due = TIME; 00044 lines_in = 0; 00045 fd = lastping = signon = idle_lastmsg = nping = registered = 0; 00046 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; 00047 haspassed = false; 00048 dns_done = false; 00049 recvq = ""; 00050 sendq = ""; 00051 strcpy(result,""); 00052 for (int i = 0; i < MAXCHANS; i++) 00053 { 00054 this->chans[i].channel = NULL; 00055 this->chans[i].uc_modes = 0; 00056 } 00057 invites.clear(); 00058 } |
|
Definition at line 222 of file users.h.
00222 { } |
|
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 170 of file users.cpp. References recvq, recvqmax, and SetWriteError().
00171 { 00172 std::string b = ""; 00173 for (int i = 0; i < a.length(); i++) 00174 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) 00175 b = b + a[i]; 00176 std::stringstream stream(recvq); 00177 stream << b; 00178 recvq = stream.str(); 00179 int i = 0; 00180 // count the size of the first line in the buffer. 00181 while (i < recvq.length()) 00182 { 00183 if (recvq[i++] == '\n') 00184 break; 00185 } 00186 if (recvq.length() > this->recvqmax) 00187 { 00188 this->SetWriteError("RecvQ exceeded"); 00189 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax); 00190 } 00191 // return false if we've had more than 600 characters WITHOUT 00192 // a carriage return (this is BAD, drop the socket) 00193 return (i < 600); 00194 } |
|
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 226 of file users.cpp. References GetWriteError(), sendq, sendqmax, and SetWriteError().
00227 { 00228 if (this->GetWriteError() != "") 00229 return; 00230 if (sendq.length() + data.length() > this->sendqmax) 00231 { 00232 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax); 00233 this->SetWriteError("SendQ exceeded"); 00234 return; 00235 } 00236 std::stringstream stream; 00237 stream << sendq << data; 00238 sendq = stream.str(); 00239 } |
|
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 196 of file users.cpp. References recvq.
|
|
This function clears the entire buffer by setting it to an empty string.
Definition at line 204 of file users.cpp. References recvq. Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
00205 { 00206 recvq = ""; 00207 } |
|
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 242 of file users.cpp. References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError().
00243 { 00244 if (sendq.length()) 00245 { 00246 char* tb = (char*)this->sendq.c_str(); 00247 int n_sent = write(this->fd,tb,this->sendq.length()); 00248 if (n_sent == -1) 00249 { 00250 this->SetWriteError(strerror(errno)); 00251 } 00252 else 00253 { 00254 // advance the queue 00255 tb += n_sent; 00256 this->sendq = tb; 00257 // update the user's stats counters 00258 this->bytes_out += n_sent; 00259 this->cmds_out++; 00260 } 00261 } 00262 } |
|
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 209 of file users.cpp. References recvq.
00210 { 00211 if (recvq == "") 00212 return ""; 00213 char* line = (char*)recvq.c_str(); 00214 std::string ret = ""; 00215 while ((*line != '\n') && (strlen(line))) 00216 { 00217 ret = ret + *line; 00218 line++; 00219 } 00220 if ((*line == '\n') || (*line == '\r')) 00221 line++; 00222 recvq = line; 00223 return ret; 00224 } |
|
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 62 of file users.cpp. References dhost, ident, nick, and result.
00063 { 00064 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); 00065 return result; 00066 } |
|
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 69 of file users.cpp. References connection::host, ident, nick, and result.
00070 { 00071 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host); 00072 return result; 00073 } |
|
Returns the write error which last occured on this connection or an empty string if none occured.
Definition at line 272 of file users.cpp. References WriteError. Referenced by AddWriteBuf().
00273 { 00274 return this->WriteError; 00275 } |
|
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 118 of file users.cpp. References config_f, and DEBUG.
00119 { 00120 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; 00121 char* mycmd; 00122 char* savept; 00123 char* savept2; 00124 00125 // are they even an oper at all? 00126 if (strchr(this->modes,'o')) 00127 { 00128 log(DEBUG,"*** HasPermission: %s is an oper",this->nick); 00129 for (int j =0; j < ConfValueEnum("type",&config_f); j++) 00130 { 00131 ConfValue("type","name",j,TypeName,&config_f); 00132 if (!strcmp(TypeName,this->oper)) 00133 { 00134 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); 00135 ConfValue("type","classes",j,Classes,&config_f); 00136 char* myclass = strtok_r(Classes," ",&savept); 00137 while (myclass) 00138 { 00139 log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); 00140 for (int k =0; k < ConfValueEnum("class",&config_f); k++) 00141 { 00142 ConfValue("class","name",k,ClassName,&config_f); 00143 if (!strcmp(ClassName,myclass)) 00144 { 00145 ConfValue("class","commands",k,CommandList,&config_f); 00146 log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); 00147 00148 00149 mycmd = strtok_r(CommandList," ",&savept2); 00150 while (mycmd) 00151 { 00152 if (!strcasecmp(mycmd,command)) 00153 { 00154 log(DEBUG,"*** Command %s found, returning true",command); 00155 return true; 00156 } 00157 mycmd = strtok_r(NULL," ",&savept2); 00158 } 00159 } 00160 } 00161 myclass = strtok_r(NULL," ",&savept); 00162 } 00163 } 00164 } 00165 } 00166 return false; 00167 } |
|
Adds a channel to a users invite list (invites them to a channel).
Definition at line 89 of file users.cpp. References Invited::channel, and invites.
|
|
Returns true if a user is invited to a channel.
Definition at line 75 of file users.cpp. References invites.
|
|
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 96 of file users.cpp. References DEBUG, and invites.
00097 { 00098 log(DEBUG,"Removing invites"); 00099 if (channel) 00100 { 00101 if (invites.size()) 00102 { 00103 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) 00104 { 00105 if (i->channel) 00106 { 00107 if (!strcasecmp(i->channel,channel)) 00108 { 00109 invites.erase(i); 00110 return; 00111 } 00112 } 00113 } 00114 } 00115 } 00116 } |
|
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 264 of file users.cpp. References DEBUG, and WriteError. Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf().
00265 { 00266 log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str()); 00267 // don't try to set the error twice, its already set take the first string. 00268 if (this->WriteError == "") 00269 this->WriteError = error; 00270 } |
|
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(). |
|
Definition at line 142 of file users.h. Referenced by Server::PseudoToUser(), and userrec(). |
|
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(). |
|
True when DNS lookups are completed.
Definition at line 179 of file users.h. Referenced by userrec(). |
|
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(). |
|
The users full name.
Definition at line 134 of file users.h. Referenced by userrec(). |
|
The users ident reply.
Definition at line 125 of file users.h. Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo(). |
|
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(). |
|
Flood counters.
Definition at line 204 of file users.h. Referenced by userrec(). |
|
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(). |
|
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(). |
|
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(). |
|
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. |
|
Number of seconds between PINGs for this user (set from <connect:allow> tag.
|
|
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(). |
|
Maximum size this user's recvq can become.
Definition at line 218 of file users.h. Referenced by AddBuffer(). |
|
Definition at line 205 of file users.h. Referenced by userrec(). |
|
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(). |
|
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(). |
|
Maximum size this user's sendq can become.
Definition at line 214 of file users.h. Referenced by AddWriteBuf(). |
|
The server the user is connected to.
Definition at line 146 of file users.h. Referenced by userrec(). |
|
|
|
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(). |
|
Definition at line 210 of file users.h. Referenced by GetWriteError(), and SetWriteError(). |