From f326e475e311bf0fa211ccd052ba38d8235efa12 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 1 Apr 2005 17:07:42 +0000 Subject: Updated documentation (html) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@937 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 295 +++++++++++++++++++------------------- 1 file changed, 149 insertions(+), 146 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 7f5755497..1ca6025f2 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -113,34 +113,35 @@ Definition at line 89 of fi

-Definition at line 25 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, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. -

-

00026 {
-00027         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00028         strcpy(nick,"");
-00029         strcpy(ip,"127.0.0.1");
-00030         timeout = 0;
-00031         strcpy(ident,"");
-00032         strcpy(host,"");
-00033         strcpy(dhost,"");
-00034         strcpy(fullname,"");
-00035         strcpy(modes,"");
-00036         strcpy(inbuf,"");
-00037         strcpy(server,"");
-00038         strcpy(awaymsg,"");
-00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00040         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00041         haspassed = false;
-00042         strcpy(result,"");
-00043         for (int i = 0; i < MAXCHANS; i++)
-00044         {
-00045                 this->chans[i].channel = NULL;
-00046                 this->chans[i].uc_modes = 0;
-00047         }
-00048         invites.clear();
-00049 }
+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 }
 
    
   
 
@@ -207,14 +208,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

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

 References dhost, ident, nick, and result.
 

-
00054 {
-00055         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00056         return result;
-00057 }
+
00056 {
+00057         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00058         return result;
+00059 }
 
    
   
 
@@ -247,14 +248,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 60 of file users.cpp.
+Definition at line 62 of file users.cpp.
 

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

-
00061 {
-00062         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00063         return result;
-00064 }
+
00063 {
+00064         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00065         return result;
+00066 }
 
    
   
 
@@ -288,60 +289,60 @@ 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 109 of file users.cpp.
-

-References config_f, and DEBUG.
-

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

 
 

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

 References Invited::channel, and invites.
 

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

 
 

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

 References invites.
 

-
00067 {
-00068         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00069         {
-00070                 if (i->channel) {
-00071                         if (!strcasecmp(i->channel,channel))
-00072                         {
-00073                                 return true;
-00074                         }
-00075                 }
-00076         }
-00077         return false;
-00078 }
+
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 }
 
    
   
 
@@ -466,30 +467,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 87 of file users.cpp.
+Definition at line 89 of file users.cpp.
 

 References DEBUG, and invites.
 

-
00088 {
-00089         log(DEBUG,"Removing invites");
-00090         if (channel)
-00091         {
-00092                 if (invites.size())
-00093                 {
-00094                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00095                         {
-00096                                 if (i->channel)
-00097                                 {
-00098                                         if (!strcasecmp(i->channel,channel))
-00099                                         {
-00100                                                 invites.erase(i);
-00101                                                 return;
-00102                                         }
-00103                                 }
-00104                         }
-00105                 }
-00106         }
-00107 }
+
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 }
 
    
   
 
@@ -519,7 +520,7 @@ If this string is empty, the user is not marked as away.
 

 Definition at line 132 of file users.h.
 

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

@@ -545,7 +546,7 @@ Referenced by userrec().
 

 Definition at line 123 of file users.h.
 

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

@@ -573,7 +574,7 @@ This usually matches the value of u
 

 Definition at line 111 of file users.h.
 

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

@@ -601,7 +602,7 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi
 

 Definition at line 143 of file users.h.
 

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

@@ -629,7 +630,7 @@ The users full name.
 

 Definition at line 115 of file users.h.
 

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

@@ -657,7 +658,7 @@ The users ident reply.
 

 Definition at line 106 of file users.h.
 

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

@@ -685,7 +686,7 @@ A list of channels the user has a pending invite to.
 

 Definition at line 95 of file users.h.
 

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

@@ -713,7 +714,7 @@ This may contain any of the following RFC characters: o, w, s, i Your module may
 

 Definition at line 121 of file users.h.
 

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

@@ -741,7 +742,7 @@ An invalid nickname indicates an unregistered connection prior to the NICK comma
 

 Definition at line 102 of file users.h.
 

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

@@ -767,7 +768,9 @@ 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 156 of file users.h.
+

+Referenced by userrec().    
   
 
 

@@ -795,7 +798,7 @@ You may use this to increase the speed of use of this class.
 

 Definition at line 137 of file users.h.
 

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

@@ -823,7 +826,7 @@ The server the user is connected to.
 

 Definition at line 127 of file users.h.
 

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

@@ -851,12 +854,12 @@ 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.
 

-Referenced by userrec().    
+Referenced by userrec().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Fri Mar 25 03:49:34 2005 for InspIRCd by
+
Generated on Mon Mar 28 21:09:38 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3