X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodule-doc%2Fclassuserrec.html;h=0e698ae749dc5e3bba739f7e3a3fc8a1a7e4af70;hb=5a2675d174e661c55843b3795afe2d688e7197f9;hp=1ca6025f21a0e393d83695593d51e5ca9042daeb;hpb=f326e475e311bf0fa211ccd052ba38d8235efa12;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 1ca6025f2..0e698ae74 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -73,6 +73,15 @@ Inherits connection. 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.



Private Attributes

InvitedList invites @@ -85,7 +94,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 89 of file users.h.


Constructor & Destructor Documentation

+Definition at line 93 of file users.h.

Constructor & Destructor Documentation

@@ -113,35 +122,36 @@ Definition at line 89 of fi

-Definition at line 26 of file users.cpp. -

-References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. -

-

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

-Definition at line 160 of file users.h. +Definition at line 178 of file users.h.

-

00160 {  }
+
00178 {  }
 
@@ -208,14 +218,14 @@ Returns the full displayed host of the user This member function returns the hos

-Definition at line 55 of file users.cpp. +Definition at line 58 of file users.cpp.

-References dhost, ident, nick, and result. +References dhost, ident, nick, and result.

-

00056 {
-00057         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00058         return result;
-00059 }
+
00059 {
+00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00061         return result;
+00062 }
 
@@ -248,14 +258,14 @@ Returns the full real host of the user This member function returns the hostname

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 62 of file users.cpp. +Definition at line 65 of file users.cpp.

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

-

00063 {
-00064         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00065         return result;
-00066 }
+
00066 {
+00067         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00068         return result;
+00069 }
 
@@ -289,60 +299,59 @@ 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 111 of file users.cpp. +Definition at line 114 of file users.cpp.

References config_f, and DEBUG.

-

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

-Definition at line 82 of file users.cpp. +Definition at line 85 of file users.cpp.

-References Invited::channel, and invites. +References Invited::channel, and invites.

-

00083 {
-00084         Invited i;
-00085         strlcpy(i.channel,channel,CHANMAX);
-00086         invites.push_back(i);
-00087 }
+
00086 {
+00087         Invited i;
+00088         strlcpy(i.channel,channel,CHANMAX);
+00089         invites.push_back(i);
+00090 }
 
@@ -418,22 +427,22 @@ Returns true if a user is invited to a channel.

-Definition at line 68 of file users.cpp. +Definition at line 71 of file users.cpp.

-References invites. +References invites.

-

00069 {
-00070         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00071         {
-00072                 if (i->channel) {
-00073                         if (!strcasecmp(i->channel,channel))
-00074                         {
-00075                                 return true;
-00076                         }
-00077                 }
-00078         }
-00079         return false;
-00080 }
+
00072 {
+00073         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00074         {
+00075                 if (i->channel) {
+00076                         if (!strcasecmp(i->channel,channel))
+00077                         {
+00078                                 return true;
+00079                         }
+00080                 }
+00081         }
+00082         return false;
+00083 }
 
@@ -467,30 +476,30 @@ 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 89 of file users.cpp. -

-References DEBUG, and invites. -

-

00090 {
-00091         log(DEBUG,"Removing invites");
-00092         if (channel)
-00093         {
-00094                 if (invites.size())
-00095                 {
-00096                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00097                         {
-00098                                 if (i->channel)
-00099                                 {
-00100                                         if (!strcasecmp(i->channel,channel))
-00101                                         {
-00102                                                 invites.erase(i);
-00103                                                 return;
-00104                                         }
-00105                                 }
-00106                         }
-00107                 }
-00108         }
-00109 }
+Definition at line 92 of file users.cpp.
+

+References DEBUG, and invites. +

+

00093 {
+00094         log(DEBUG,"Removing invites");
+00095         if (channel)
+00096         {
+00097                 if (invites.size())
+00098                 {
+00099                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00100                         {
+00101                                 if (i->channel)
+00102                                 {
+00103                                         if (!strcasecmp(i->channel,channel))
+00104                                         {
+00105                                                 invites.erase(i);
+00106                                                 return;
+00107                                         }
+00108                                 }
+00109                         }
+00110                 }
+00111         }
+00112 }
 
@@ -518,9 +527,9 @@ The user's away message.

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

-Definition at line 132 of file users.h. +Definition at line 136 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

@@ -544,9 +553,9 @@ Referenced by userrec().

-Definition at line 123 of file users.h. +Definition at line 127 of file users.h.

-Referenced by userrec(). +Referenced by Server::PseudoToUser(), and userrec().

@@ -572,9 +581,37 @@ The host displayed to non-opers (used for cloaking etc).

This usually matches the value of userrec::host.

-Definition at line 111 of file users.h. +Definition at line 115 of file users.h. +

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

+ + + + +
+ + +
bool userrec::dns_done +
+
+ + + + +Referenced by userrec().
+   + + +

+True when DNS lookups are completed. +

+ +

+Definition at line 164 of file users.h.

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

@@ -600,9 +637,9 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi

-Definition at line 143 of file users.h. +Definition at line 147 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

@@ -628,9 +665,9 @@ The users full name.

-Definition at line 115 of file users.h. +Definition at line 119 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

@@ -656,9 +693,9 @@ The users ident reply.

-Definition at line 106 of file users.h. +Definition at line 110 of file users.h.

-Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().

@@ -684,9 +721,9 @@ A list of channels the user has a pending invite to.

-Definition at line 95 of file users.h. +Definition at line 99 of file users.h.

-Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().

@@ -712,9 +749,9 @@ 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 121 of file users.h. +Definition at line 125 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

@@ -740,9 +777,9 @@ The users nickname.

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

-Definition at line 102 of file users.h. +Definition at line 106 of file users.h.

-Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec(). +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), Server::QuitUser(), and userrec().

@@ -768,9 +805,61 @@ 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 156 of file users.h. +Definition at line 160 of file users.h.

-Referenced by userrec(). +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 174 of file users.h.

+

+ + + + +
+ + +
unsigned long userrec::pingmax +
+
+ + + +
+   + + +

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

+ +

+Definition at line 168 of file users.h.

@@ -796,9 +885,9 @@ 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 137 of file users.h. +Definition at line 141 of file users.h.

-Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +Referenced by GetFullHost(), GetFullRealHost(), and userrec().

@@ -824,9 +913,9 @@ The server the user is connected to.

-Definition at line 127 of file users.h. +Definition at line 131 of file users.h.

-Referenced by userrec(). +Referenced by userrec().

@@ -852,14 +941,14 @@ Number of seconds this user is given to send USER/NICK If they do not send their

-Definition at line 149 of file users.h. +Definition at line 153 of file users.h.

-Referenced by userrec(). +Referenced by userrec().


The documentation for this class was generated from the following files: -
Generated on Mon Mar 28 21:09:38 2005 for InspIRCd by +
Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by doxygen 1.3.3