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

---

Constructor & Destructor Documentation

userrec::userrec (   )

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. { // the PROPER way to do it, AVOID bzero at *ALL* costs strcpy(nick,""); strcpy(ip,"127.0.0.1"); timeout = 0; strcpy(ident,""); strcpy(host,""); strcpy(dhost,""); strcpy(fullname,""); strcpy(modes,""); strcpy(inbuf,""); strcpy(server,""); strcpy(awaymsg,""); strcpy(oper,""); fd = lastping = signon = idle_lastmsg = nping = registered = 0; flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; haspassed = false; strcpy(result,""); for (int i = 0; i < MAXCHANS; i++) { this->chans[i].channel = NULL; this->chans[i].uc_modes = 0; } invites.clear(); }

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

Definition at line 160 of file users.h. { }

---

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 55 of file users.cpp. References dhost, ident, nick, and result. { snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); return 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. 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. References connection::host, ident, nick, and result. { snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host); return result; }

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 111 of file users.cpp. References config_f, and DEBUG. { char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; char* myclass; char* mycmd; char* savept; char* savept2; // are they even an oper at all? if (strchr(this->modes,'o')) { log(DEBUG,"*** HasPermission: %s is an oper",this->nick); for (int j =0; j < ConfValueEnum("type",&config_f); j++) { ConfValue("type","name",j,TypeName,&config_f); if (!strcmp(TypeName,this->oper)) { log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); ConfValue("type","classes",j,Classes,&config_f); char* myclass = strtok_r(Classes," ",&savept); while (myclass) { log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); for (int k =0; k < ConfValueEnum("class",&config_f); k++) { ConfValue("class","name",k,ClassName,&config_f); if (!strcmp(ClassName,myclass)) { ConfValue("class","commands",k,CommandList,&config_f); log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); mycmd = strtok_r(CommandList," ",&savept2); while (mycmd) { if (!strcasecmp(mycmd,command)) { log(DEBUG,"*** Command %s found, returning true",command); return true; } mycmd = strtok_r(NULL," ",&savept2); } } } myclass = strtok_r(NULL," ",&savept); } } } } return false; }

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

Adds a channel to a users invite list (invites them to a channel). Definition at line 82 of file users.cpp. References Invited::channel, and invites. { Invited i; strlcpy(i.channel,channel,CHANMAX); invites.push_back(i); }

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

Returns true if a user is invited to a channel. Definition at line 68 of file users.cpp. References invites. { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (i->channel) { if (!strcasecmp(i->channel,channel)) { return true; } } } return false; }

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 89 of file users.cpp. References DEBUG, and invites. { log(DEBUG,"Removing invites"); if (channel) { if (invites.size()) { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (i->channel) { if (!strcasecmp(i->channel,channel)) { invites.erase(i); return; } } } } } }

---

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

ucrec userrec::chans[MAXCHANS]

Definition at line 123 of file users.h. Referenced by 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 111 of file users.h. Referenced by GetFullHost(), and 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 143 of file users.h. Referenced by userrec().

char userrec::fullname[128]

The users full name. Definition at line 115 of file users.h. Referenced by userrec().

char userrec::ident[64]

The users ident reply. Definition at line 106 of file users.h. Referenced by GetFullHost(), GetFullRealHost(), and userrec().

InvitedList userrec::invites [private]

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

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 121 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 102 of file users.h. Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), 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 156 of file users.h. Referenced by userrec().

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 137 of file users.h. Referenced by GetFullHost(), GetFullRealHost(), and userrec().

char userrec::server[256]

The server the user is connected to. Definition at line 127 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 149 of file users.h. Referenced by userrec().

---

The documentation for this class was generated from the following files:

• users.h
• users.cpp

---