From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classuserrec.html | 286 +++++++++++++++++++------------------- 1 file changed, 143 insertions(+), 143 deletions(-) (limited to 'docs/module-doc/classuserrec.html') diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index e37a6dc18..849d914eb 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -116,36 +116,36 @@ Definition at line 89 of fi

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

-

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         dns_done = false;
-00045         strcpy(result,"");
-00046         for (int i = 0; i < MAXCHANS; i++)
-00047         {
-00048                 this->chans[i].channel = NULL;
-00049                 this->chans[i].uc_modes = 0;
-00050         }
-00051         invites.clear();
-00052 }
+
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 }
 
    
   
 
@@ -212,14 +212,14 @@ Returns the full displayed host of the user This member function returns the hos
 

 
 

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

 References dhost, ident, nick, and result.
 

-
00057 {
-00058         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00059         return result;
-00060 }
+
00059 {
+00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00061         return result;
+00062 }
 
    
   
 
@@ -252,14 +252,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 63 of file users.cpp.
+Definition at line 65 of file users.cpp.
 

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

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

 References config_f, and DEBUG.
 

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

 
 

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

 References Invited::channel, and invites.
 

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

 
 

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

 References invites.
 

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

 References DEBUG, and invites.
 

-
00091 {
-00092         log(DEBUG,"Removing invites");
-00093         if (channel)
-00094         {
-00095                 if (invites.size())
-00096                 {
-00097                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00098                         {
-00099                                 if (i->channel)
-00100                                 {
-00101                                         if (!strcasecmp(i->channel,channel))
-00102                                         {
-00103                                                 invites.erase(i);
-00104                                                 return;
-00105                                         }
-00106                                 }
-00107                         }
-00108                 }
-00109         }
-00110 }
+
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 }
 
    
   
 
@@ -524,7 +524,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().    
   
 
 

@@ -550,7 +550,7 @@ Referenced by userrec().
 

 Definition at line 123 of file users.h.
 

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

@@ -578,7 +578,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().    
   
 
 

@@ -606,7 +606,7 @@ True when DNS lookups are completed.
 

 Definition at line 160 of file users.h.
 

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

@@ -634,7 +634,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().    
   
 
 

@@ -662,7 +662,7 @@ The users full name.
 

 Definition at line 115 of file users.h.
 

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

@@ -690,7 +690,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().    
   
 
 

@@ -718,7 +718,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().    
   
 
 

@@ -746,7 +746,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().    
   
 
 

@@ -774,7 +774,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().    
   
 
 

@@ -802,7 +802,7 @@ This is used to check permissions in operclasses, so that we can say 'yay' or 'n
 

 Definition at line 156 of file users.h.
 

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

@@ -830,7 +830,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().    
   
 
 

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

 Definition at line 127 of file users.h.
 

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

@@ -886,12 +886,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 Mon Apr 4 18:12:54 2005 for InspIRCd by
+
Generated on Thu Apr 7 20:14:27 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3