X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodule-doc%2Fclassuserrec.html;h=0e698ae749dc5e3bba739f7e3a3fc8a1a7e4af70;hb=5a2675d174e661c55843b3795afe2d688e7197f9;hp=274b7f424c9cb4f42591929046679ef705dde348;hpb=1ea860b5708d065f9ed51234fc031969215fd806;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 274b7f424..0e698ae74 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -1,81 +1,110 @@ -userrec class Reference - +InspIRCd: userrec class Reference + - -
-Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

userrec Class Reference

Holds all information about a user This class stores all information about a user connected to the irc server. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

userrec Class Reference

Holds all information about a user This class stores all information about a user connected to the irc server. More...

#include <users.h>

-Inheritance diagram for userrec:

Inheritance graph
- - - - -
[legend]
Collaboration diagram for userrec:

Collaboration graph
- - - - -
[legend]
List of all members. +Inherits connection. +

+List of all members.

- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + +

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.

 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.


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 [32]
 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.

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.


Private Attributes

InvitedList invites
 A list of channels the user has a pending invite to.

InvitedList invites
 A list of channels the user has a pending invite to.

Detailed Description

-Holds all information about a user This class stores all information about a user connected to the irc server. +Holds all information about a user This class stores all information about a user connected to the irc server.

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 58 of file users.h.

Constructor & Destructor Documentation

+Definition at line 93 of file users.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -93,45 +122,49 @@ Definition at line 58 of fi

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

-References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, and connection::signon. -

-

00012 {
-00013         // the PROPER way to do it, AVOID bzero at *ALL* costs
-00014         strcpy(nick,"");
-00015         ip = 0;
-00016         strcpy(ident,"");
-00017         strcpy(host,"");
-00018         strcpy(dhost,"");
-00019         strcpy(fullname,"");
-00020         strcpy(modes,"");
-00021         strcpy(inbuf,"");
-00022         strcpy(server,"");
-00023         strcpy(awaymsg,"");
-00024         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00025         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00026         haspassed = false;
-00027         strcpy(result,"");
-00028         for (int i = 0; i < MAXCHANS; i++)
-00029         {
-00030                 chans[i].channel = NULL;
-00031         }
-00032         invites.clear();
-00033 }
+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 }
userrec::userrec (   )   ) 

- +
-
+ - + - - + + @@ -149,23 +182,23 @@ References connection::byt

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

-

00110 {  }
+
00178 {  }
virtual userrec::~userrec virtual userrec::~userrec (   )   )  [inline, virtual]

Member Function Documentation

- +
-
+ - - + + @@ -181,31 +214,31 @@ Definition at line 110 of f
char * userrec::GetFullHost (   )   )  [virtual]

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

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

-

00037 {
-00038         sprintf(result,"%s!%s@%s",nick,ident,dhost);
-00039         return result;
-00040 }
+
00059 {
+00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00061         return result;
+00062 }

- +
-
+ - - + + @@ -221,32 +254,118 @@ References result. + +
char * userrec::GetFullRealHost (   )   )  [virtual]

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

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

-References result. +

00066 {
+00067         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00068         return result;
+00069 }
+
+

+ + + + +
+ + + + + + + + + + +
bool userrec::HasPermission ( char *  command  ) 
+
+ + + +
+   + +

-

00044 {
-00045         sprintf(result,"%s!%s@%s",nick,ident,host);
-00046         return result;
-00047 }
+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 114 of file users.cpp.
+

+References config_f, and DEBUG.
+

+
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 }

- +
-
+ - - + + @@ -262,33 +381,33 @@ References result.
void userrec::InviteTo (  char *   channel )  channel  )  [virtual]

-Adds a channel to a users invite list (invites them to a channel). +Adds a channel to a users invite list (invites them to a channel).

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

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

-

00064 {
-00065         Invited i;
-00066         strcpy(i.channel,channel);
-00067         invites.push_back(i);
-00068 }
+
00086 {
+00087         Invited i;
+00088         strlcpy(i.channel,channel,CHANMAX);
+00089         invites.push_back(i);
+00090 }

- +
-
+ - - + + @@ -304,40 +423,40 @@ References Invited::channel
bool userrec::IsInvited (  char *   channel )  channel  )  [virtual]

-Returns true if a user is invited to a channel. +Returns true if a user is invited to a channel.

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

-References invites. +References invites.

-

00050 {
-00051         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00052         {
-00053                 if (i->channel) {
-00054                         if (!strcasecmp(i->channel,channel))
-00055                         {
-00056                                 return true;
-00057                         }
-00058                 }
-00059         }
-00060         return false;
-00061 }
+
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 }

- +
-
+ - - + + @@ -353,37 +472,45 @@ References invites.
void userrec::RemoveInvite (  char *   channel )  channel  )  [virtual]

-Removes a channel from a users invite list. +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 70 of file users.cpp. -

-References invites. -

-

00071 {
-00072         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00073         {
-00074                 if (i->channel) {
-00075                         if (!strcasecmp(i->channel,channel))
-00076                         {
-00077                                 invites.erase(i);
-00078                                 return;
-00079                         }
-00080                 }
-00081         }
-00082 }
+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 }

Member Data Documentation

-

- +

+

- @@ -396,20 +523,22 @@ References invites. +Definition at line 136 of file users.h. +

+Referenced by userrec().

+ -
char userrec::awaymsg[512] + char userrec::awaymsg[512]

-The user's away message. +The user's away message.

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

-Definition at line 101 of file users.h.

-

- +

+

- @@ -424,18 +553,46 @@ Definition at line 101 of f

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

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

+ -
ucrec userrec::chans[MAXCHANS] + ucrec userrec::chans[MAXCHANS]
+

+ + + + +
+ + +
char userrec::dhost[256] +
+
+ + + + +This usually matches the value of userrec::host. +

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

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

+   + + +

+The host displayed to non-opers (used for cloaking etc).

-Referenced by userrec().

-

- +

+

- @@ -448,20 +605,22 @@ Referenced by userrec(). +Referenced by userrec().
+ -
char userrec::dhost[256] + bool userrec::dns_done

-The host displayed to non-opers (used for cloaking etc). +True when DNS lookups are completed. +

+

-This usually matches the value of userrec::host. +Definition at line 164 of file users.h.

-Definition at line 80 of file users.h.

-

- +

+

- @@ -474,20 +633,22 @@ Definition at line 80 of fi +Definition at line 147 of file users.h. +

+Referenced by userrec().

+ -
char userrec::fullname[128] + int userrec::flood

-The users full name. +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 84 of file users.h.

-

- +

+

- @@ -500,20 +661,22 @@ Definition at line 84 of fi +Definition at line 119 of file users.h. +

+Referenced by userrec().

+ -
char userrec::ident[64] + char userrec::fullname[128]

-The users ident reply. +The users full name.

-Definition at line 75 of file users.h.

-

- +

+

- @@ -526,22 +689,22 @@ Definition at line 75 of fi +Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().
+ -
InvitedList userrec::invites [private] + char userrec::ident[64]

-A list of channels the user has a pending invite to. +The users ident reply.

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

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

-

- +

+

- @@ -554,20 +717,50 @@ Referenced by InviteTo(), + +
+ -
char userrec::modes[32] + InvitedList userrec::invites [private]

-The user's mode string. +A list of channels the user has a pending invite to. +

+ +

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

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

+

+ + + + +
+ + +
char userrec::modes[MAXBUF] +
+
+ + + + +Definition at line 125 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 90 of file users.h.

-

- +

+

- @@ -580,20 +773,50 @@ Definition at line 90 of fi +Definition at line 106 of file users.h. +

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

+
+ -
char userrec::nick[NICKMAX] + char userrec::nick[NICKMAX]

-The users nickname. +The users nickname.

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

-Definition at line 71 of file users.h.

+

+ + + + +
+ + +
char userrec::oper[NICKMAX] +
+
+ + + +
+   + + +

+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 160 of file users.h. +

+Referenced by userrec().

-

- +

+

- @@ -606,22 +829,74 @@ Definition at line 71 of fi + +
+ -
char userrec::result[256] + char userrec::password[MAXBUF]

-Stores the result of the last GetFullHost or GetRealHost call. +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.

+

+ + + + +
+ + +
char userrec::result[256] +
+
+ + + + +Referenced by GetFullHost(), GetFullRealHost(), and 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 106 of file users.h. +Definition at line 141 of file users.h.

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

-

- +

+

- @@ -634,18 +909,48 @@ Referenced by GetFullHost()

-The server the user is connected to. +The server the user is connected to.

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

+Referenced by userrec(). + +

+ -
char userrec::server[256] + char userrec::server[256]
+

+ + + + +
+ + +
unsigned long userrec::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. +

+ +

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

+Referenced by userrec().

The documentation for this class was generated from the following files: -
Generated on Fri Apr 2 14:46:21 2004 for InspIRCd by +
Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3