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>

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.

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


Private Attributes

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.

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

Constructor & Destructor Documentation

userrec::userrec (   ) 
 

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 }

virtual userrec::~userrec (   )  [inline, virtual]
 

Definition at line 172 of file users.h. 

00172 {  }

Member Function Documentation

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.

Definition at line 58 of file users.cpp.

References dhost, ident, nick, and result. 

00059 {
00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
00061         return result;
00062 }

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.

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 65 of file users.cpp.

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

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

bool userrec::HasPermission (  char *  command  ) 
 

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

void userrec::InviteTo (  char *  channel  )  [virtual]
 

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

Definition at line 85 of file users.cpp.

References Invited::channel, and invites. 

00086 {
00087         Invited i;
00088         strlcpy(i.channel,channel,CHANMAX);
00089         invites.push_back(i);
00090 }

bool userrec::IsInvited (  char *  channel  )  [virtual]
 

Returns true if a user is invited to a channel.

Definition at line 71 of file users.cpp.

References invites. 

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 }

void userrec::RemoveInvite (  char *  channel  )  [virtual]
 

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

char userrec::awaymsg[512]
 

The user's away message.

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

Definition at line 136 of file users.h.

Referenced by userrec().

ucrec userrec::chans[MAXCHANS]
 

Definition at line 127 of file users.h.

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

char userrec::dhost[256]
 

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

This usually matches the value of userrec::host.

Definition at line 115 of file users.h.

Referenced by GetFullHost(), and userrec().

bool userrec::dns_done
 

True when DNS lookups are completed.

Definition at line 164 of file users.h.

Referenced by userrec().

int userrec::flood
 

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

Referenced by userrec().

char userrec::fullname[128]
 

The users full name.

Definition at line 119 of file users.h.

Referenced by userrec().

char userrec::ident[64]
 

The users ident reply.

Definition at line 110 of file users.h.

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

InvitedList userrec::invites [private]
 

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]
 

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

Referenced by userrec().

char userrec::nick[NICKMAX]
 

The users nickname.

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

Definition at line 106 of file users.h.

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

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().

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]
 

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

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

char userrec::server[256]
 

The server the user is connected to.

Definition at line 131 of file users.h.

Referenced by userrec().

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 15 19:30:27 2005 for InspIRCd by doxygen 1.3.3