diff options
Diffstat (limited to 'docs/man/man3/userrec.3')
| -rw-r--r-- | docs/man/man3/userrec.3 | 475 |
1 files changed, 245 insertions, 230 deletions
diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 3afc6d02c..61e70f590 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -77,6 +77,10 @@ Inherits \fBconnection\fP. .RI "void \fBFlushWriteBuf\fP ()" .br .RI "\fIFlushes as much of the user's buffer to the file descriptor as possible. \fP" +.ti -1c +.RI "\fBInvitedList\fP * \fBGetInviteList\fP ()" +.br +.RI "\fIReturns the list of channels this user has been invited to but has not yet joined. \fP" .in -1c .SS "Public Attributes" @@ -189,40 +193,40 @@ Definition at line 108 of file users.h. .PP .SS "userrec::userrec ()" .PP -Definition at line 28 of file users.cpp. +Definition at line 29 of file users.cpp. .PP 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. .PP .nf -29 { -30 // the PROPER way to do it, AVOID bzero at *ALL* costs -31 strcpy(nick,''); -32 strcpy(ip,'127.0.0.1'); -33 timeout = 0; -34 strcpy(ident,''); -35 strcpy(host,''); -36 strcpy(dhost,''); -37 strcpy(fullname,''); -38 strcpy(modes,''); -39 strcpy(server,''); -40 strcpy(awaymsg,''); -41 strcpy(oper,''); -42 reset_due = TIME; -43 lines_in = 0; -44 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -45 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -46 haspassed = false; -47 dns_done = false; -48 recvq = ''; -49 sendq = ''; -50 strcpy(result,''); -51 for (int i = 0; i < MAXCHANS; i++) -52 { -53 this->chans[i].channel = NULL; -54 this->chans[i].uc_modes = 0; -55 } -56 invites.clear(); -57 } +30 { +31 // the PROPER way to do it, AVOID bzero at *ALL* costs +32 strcpy(nick,''); +33 strcpy(ip,'127.0.0.1'); +34 timeout = 0; +35 strcpy(ident,''); +36 strcpy(host,''); +37 strcpy(dhost,''); +38 strcpy(fullname,''); +39 strcpy(modes,''); +40 strcpy(server,''); +41 strcpy(awaymsg,''); +42 strcpy(oper,''); +43 reset_due = TIME; +44 lines_in = 0; +45 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +46 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +47 haspassed = false; +48 dns_done = false; +49 recvq = ''; +50 sendq = ''; +51 strcpy(result,''); +52 for (int i = 0; i < MAXCHANS; i++) +53 { +54 this->chans[i].channel = NULL; +55 this->chans[i].uc_modes = 0; +56 } +57 invites.clear(); +58 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP @@ -235,305 +239,316 @@ Definition at line 222 of file users.h. .PP .SS "bool userrec::AddBuffer (std::string a)" .PP -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. +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 175 of file users.cpp. .PP References recvq, recvqmax, and SetWriteError(). .PP .nf -170 { -171 std::string b = ''; -172 for (int i = 0; i < a.length(); i++) -173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) -174 b = b + a[i]; -175 std::stringstream stream(recvq); -176 stream << b; -177 recvq = stream.str(); -178 int i = 0; -179 // count the size of the first line in the buffer. -180 while (i < recvq.length()) -181 { -182 if (recvq[i++] == '\n') -183 break; -184 } -185 if (recvq.length() > this->recvqmax) -186 { -187 this->SetWriteError('RecvQ exceeded'); -188 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); -189 } -190 // return false if we've had more than 600 characters WITHOUT -191 // a carriage return (this is BAD, drop the socket) -192 return (i < 600); -193 } +176 { +177 std::string b = ''; +178 for (int i = 0; i < a.length(); i++) +179 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +180 b = b + a[i]; +181 std::stringstream stream(recvq); +182 stream << b; +183 recvq = stream.str(); +184 int i = 0; +185 // count the size of the first line in the buffer. +186 while (i < recvq.length()) +187 { +188 if (recvq[i++] == '\n') +189 break; +190 } +191 if (recvq.length() > this->recvqmax) +192 { +193 this->SetWriteError('RecvQ exceeded'); +194 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); +195 } +196 // return false if we've had more than 600 characters WITHOUT +197 // a carriage return (this is BAD, drop the socket) +198 return (i < 600); +199 } .fi .SS "void userrec::AddWriteBuf (std::string data)" .PP -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, \fBSetWriteError()\fP 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. +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, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.Definition at line 231 of file users.cpp. .PP References GetWriteError(), sendq, sendqmax, and SetWriteError(). .PP .nf -226 { -227 if (this->GetWriteError() != '') -228 return; -229 if (sendq.length() + data.length() > this->sendqmax) -230 { -231 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); -232 this->SetWriteError('SendQ exceeded'); -233 return; -234 } -235 std::stringstream stream; -236 stream << sendq << data; -237 sendq = stream.str(); -238 } +232 { +233 if (this->GetWriteError() != '') +234 return; +235 if (sendq.length() + data.length() > this->sendqmax) +236 { +237 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); +238 this->SetWriteError('SendQ exceeded'); +239 return; +240 } +241 std::stringstream stream; +242 stream << sendq << data; +243 sendq = stream.str(); +244 } .fi .SS "bool userrec::BufferIsReady ()" .PP -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. +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 201 of file users.cpp. .PP References recvq. .PP .nf -196 { -197 for (int i = 0; i < recvq.length(); i++) -198 if (recvq[i] == '\n') -199 return true; -200 return false; -201 } +202 { +203 for (int i = 0; i < recvq.length(); i++) +204 if (recvq[i] == '\n') +205 return true; +206 return false; +207 } .fi .SS "void userrec::ClearBuffer ()" .PP -This function clears the entire buffer by setting it to an empty string. Definition at line 203 of file users.cpp. +This function clears the entire buffer by setting it to an empty string. Definition at line 209 of file users.cpp. .PP References recvq. .PP Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .PP .nf -204 { -205 recvq = ''; -206 } +210 { +211 recvq = ''; +212 } .fi .SS "void userrec::FlushWriteBuf ()" .PP -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. +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 247 of file users.cpp. .PP References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). .PP .nf -242 { -243 if (sendq.length()) -244 { -245 char* tb = (char*)this->sendq.c_str(); -246 int n_sent = write(this->fd,tb,this->sendq.length()); -247 if (n_sent == -1) -248 { -249 this->SetWriteError(strerror(errno)); -250 } -251 else -252 { -253 // advance the queue -254 tb += n_sent; -255 this->sendq = tb; -256 // update the user's stats counters -257 this->bytes_out += n_sent; -258 this->cmds_out++; -259 } -260 } -261 } +248 { +249 if (sendq.length()) +250 { +251 char* tb = (char*)this->sendq.c_str(); +252 int n_sent = write(this->fd,tb,this->sendq.length()); +253 if (n_sent == -1) +254 { +255 this->SetWriteError(strerror(errno)); +256 } +257 else +258 { +259 // advance the queue +260 tb += n_sent; +261 this->sendq = tb; +262 // update the user's stats counters +263 this->bytes_out += n_sent; +264 this->cmds_out++; +265 } +266 } +267 } .fi .SS "std::string userrec::GetBuffer ()" .PP -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 \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 208 of file users.cpp. +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 \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 214 of file users.cpp. .PP References recvq. .PP .nf -209 { -210 if (recvq == '') -211 return ''; -212 char* line = (char*)recvq.c_str(); -213 std::string ret = ''; -214 while ((*line != '\n') && (strlen(line))) -215 { -216 ret = ret + *line; -217 line++; -218 } -219 if ((*line == '\n') || (*line == '\r')) -220 line++; -221 recvq = line; -222 return ret; -223 } +215 { +216 if (recvq == '') +217 return ''; +218 char* line = (char*)recvq.c_str(); +219 std::string ret = ''; +220 while ((*line != '\n') && (strlen(line))) +221 { +222 ret = ret + *line; +223 line++; +224 } +225 if ((*line == '\n') || (*line == '\r')) +226 line++; +227 recvq = line; +228 return ret; +229 } .fi .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -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. +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. .PP References dhost, ident, nick, and result. .PP .nf -62 { -63 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -64 return result; -65 } +63 { +64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +65 return result; +66 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -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. +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. .PP References connection::host, ident, nick, and result. .PP .nf -69 { -70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -71 return result; -72 } +70 { +71 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +72 return result; +73 } +.fi +.SS "\fBInvitedList\fP * userrec::GetInviteList ()" +.PP +Returns the list of channels this user has been invited to but has not yet joined. Definition at line 89 of file users.cpp. +.PP +References InvitedList, and invites. +.PP +.nf +90 { +91 return &invites; +92 } .fi .SS "std::string userrec::GetWriteError ()" .PP -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. +Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 277 of file users.cpp. .PP References WriteError. .PP Referenced by AddWriteBuf(). .PP .nf -272 { -273 return this->WriteError; -274 } +278 { +279 return this->WriteError; +280 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 117 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 123 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -118 { -119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -120 char* mycmd; -121 char* savept; -122 char* savept2; -123 -124 // are they even an oper at all? -125 if (strchr(this->modes,'o')) -126 { -127 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -128 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -129 { -130 ConfValue('type','name',j,TypeName,&config_f); -131 if (!strcmp(TypeName,this->oper)) -132 { -133 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -134 ConfValue('type','classes',j,Classes,&config_f); -135 char* myclass = strtok_r(Classes,' ',&savept); -136 while (myclass) -137 { -138 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -139 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -140 { -141 ConfValue('class','name',k,ClassName,&config_f); -142 if (!strcmp(ClassName,myclass)) -143 { -144 ConfValue('class','commands',k,CommandList,&config_f); -145 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -146 -147 -148 mycmd = strtok_r(CommandList,' ',&savept2); -149 while (mycmd) -150 { -151 if (!strcasecmp(mycmd,command)) -152 { -153 log(DEBUG,'*** Command %s found, returning true',command); -154 return true; -155 } -156 mycmd = strtok_r(NULL,' ',&savept2); -157 } -158 } -159 } -160 myclass = strtok_r(NULL,' ',&savept); -161 } -162 } -163 } -164 } -165 return false; -166 } +124 { +125 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +126 char* mycmd; +127 char* savept; +128 char* savept2; +129 +130 // are they even an oper at all? +131 if (strchr(this->modes,'o')) +132 { +133 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +134 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +135 { +136 ConfValue('type','name',j,TypeName,&config_f); +137 if (!strcmp(TypeName,this->oper)) +138 { +139 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +140 ConfValue('type','classes',j,Classes,&config_f); +141 char* myclass = strtok_r(Classes,' ',&savept); +142 while (myclass) +143 { +144 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +145 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +146 { +147 ConfValue('class','name',k,ClassName,&config_f); +148 if (!strcmp(ClassName,myclass)) +149 { +150 ConfValue('class','commands',k,CommandList,&config_f); +151 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +152 +153 +154 mycmd = strtok_r(CommandList,' ',&savept2); +155 while (mycmd) +156 { +157 if (!strcasecmp(mycmd,command)) +158 { +159 log(DEBUG,'*** Command %s found, returning true',command); +160 return true; +161 } +162 mycmd = strtok_r(NULL,' ',&savept2); +163 } +164 } +165 } +166 myclass = strtok_r(NULL,' ',&savept); +167 } +168 } +169 } +170 } +171 return false; +172 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 94 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -89 { -90 Invited i; -91 strlcpy(i.channel,channel,CHANMAX); -92 invites.push_back(i); -93 } +95 { +96 Invited i; +97 strlcpy(i.channel,channel,CHANMAX); +98 invites.push_back(i); +99 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 75 of file users.cpp. .PP References invites. .PP .nf -75 { -76 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -77 { -78 if (i->channel) { -79 if (!strcasecmp(i->channel,channel)) -80 { -81 return true; -82 } -83 } -84 } -85 return false; -86 } +76 { +77 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +78 { +79 if (i->channel) { +80 if (!strcasecmp(i->channel,channel)) +81 { +82 return true; +83 } +84 } +85 } +86 return false; +87 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -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. +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 101 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -96 { -97 log(DEBUG,'Removing invites'); -98 if (channel) -99 { -100 if (invites.size()) -101 { -102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -103 { -104 if (i->channel) -105 { -106 if (!strcasecmp(i->channel,channel)) -107 { -108 invites.erase(i); -109 return; -110 } -111 } -112 } -113 } -114 } -115 } +102 { +103 log(DEBUG,'Removing invites'); +104 if (channel) +105 { +106 if (invites.size()) +107 { +108 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +109 { +110 if (i->channel) +111 { +112 if (!strcasecmp(i->channel,channel)) +113 { +114 invites.erase(i); +115 return; +116 } +117 } +118 } +119 } +120 } +121 } .fi .SS "void userrec::SetWriteError (std::string error)" .PP -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. +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 269 of file users.cpp. .PP References DEBUG, and WriteError. .PP Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). .PP .nf -264 { -265 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); -266 // don't try to set the error twice, its already set take the first string. -267 if (this->WriteError == '') -268 this->WriteError = error; -269 } +270 { +271 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); +272 // don't try to set the error twice, its already set take the first string. +273 if (this->WriteError == '') +274 this->WriteError = error; +275 } .fi .SH "Member Data Documentation" .PP @@ -576,7 +591,7 @@ Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec( .PP A list of channels the user has a pending invite to. Definition at line 114 of file users.h. .PP -Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec(). .SS "int \fBuserrec::lines_in\fP" .PP Flood counters. Definition at line 204 of file users.h. |