Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class 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:

[legend]Collaboration diagram for userrec:

[legend]List of all members.

Public Member Functions
void	StartDNSLookup ()
	Starts a DNS lookup of the user's IP.
void	SetSockAddr (int protocol_family, const char *ip, int port)
	Initialize the clients sockaddr.
int	GetPort ()
	Get port number from sockaddr.
int	GetProtocolFamily ()
	Get protocol family from sockaddr.
const char *	GetIPString ()
	Get IP string from sockaddr, using static internal buffer.
const char *	GetIPString (char *buf)
	Get IP string from sockaddr, using caller-specified buffer.
	userrec (InspIRCd *Instance)
	Default constructor.
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.
void	InvalidateCache ()
	This clears any cached results that are used for GetFullRealHost() etc.
const char *	FormatNoticeMasks ()
	Create a displayable mode string for this users snomasks.
std::string	ProcessNoticeMasks (const char *sm)
	Process a snomask modifier string, e.g.
bool	IsNoticeMaskSet (unsigned char sm)
	Returns true if a notice mask is set.
void	SetNoticeMask (unsigned char sm, bool value)
	Changed a specific notice mask value.
const char *	FormatModes ()
	Create a displayable mode string for this users umodes.
bool	IsModeSet (unsigned char m)
	Returns true if a specific mode is set.
void	SetMode (unsigned char m, bool value)
	Set a specific usermode to on or off.
virtual bool	IsInvited (const irc::string &channel)
	Returns true if a user is invited to a channel.
virtual void	InviteTo (const irc::string &channel)
	Adds a channel to a users invite list (invites them to a channel).
virtual void	RemoveInvite (const irc::string &channel)
	Removes a channel from a users invite list.
bool	HasPermission (const std::string &command)
	Returns true or false for if a user can execute a privilaged oper command.
int	ReadData (void *buffer, size_t size)
	Calls read() to read some data for this user using their fd.
bool	AddBuffer (std::string a)
	This method adds data to the read buffer of the user.
bool	BufferIsReady ()
	This method returns true if the buffer contains at least one carriage return character (e.g.
void	ClearBuffer ()
	This function clears the entire buffer by setting it to an empty string.
std::string	GetBuffer ()
	This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string.
void	SetWriteError (const std::string &error)
	Sets the write error for a connection.
const char *	GetWriteError ()
	Returns the write error which last occured on this connection or an empty string if none occured.
void	AddWriteBuf (const std::string &data)
	Adds to the user's write buffer.
void	FlushWriteBuf ()
	Flushes as much of the user's buffer to the file descriptor as possible.
InvitedList *	GetInviteList ()
	Returns the list of channels this user has been invited to but has not yet joined.
char *	MakeWildHost ()
	Creates a wildcard host.
char *	MakeHost ()
	Creates a usermask with real host.
char *	MakeHostIP ()
	Creates a usermask with real ip.
void	CloseSocket ()
	Shuts down and closes the user's socket This will not cause the user to be deleted.
void	AddToWhoWas ()
	Add the user to WHOWAS system.
void	Oper (const std::string &opertype)
	Oper up the user using the given opertype.
void	CheckClass (ConnectClass *a)
	Call this method to check a user against a connect class.
void	FullConnect ()
	Use this method to fully connect a user.
userrec *	UpdateNickHash (const char *New)
	Change this users hash key to a new string.
bool	ForceNickChange (const char *newnick)
	Force a nickname change.
void	UnOper ()
	Oper down.
unsigned long	GlobalCloneCount ()
	Return the number of global clones of this user.
unsigned long	LocalCloneCount ()
	Return the number of local clones of this user.
void	RemoveCloneCounts ()
	Remove all clone counts from the user, you should use this if you change the user's IP address in userrec::ip after they have registered.
void	Write (std::string text)
	Write text to this user, appending CR/LF.
void	Write (const char *text,...)
	Write text to this user, appending CR/LF.
void	WriteServ (const std::string &text)
	Write text to this user, appending CR/LF and prepending :server.name.
void	WriteServ (const char *text,...)
	Write text to this user, appending CR/LF and prepending :server.name.
void	WriteFrom (userrec *user, const std::string &text)
	Write text to this user, appending CR/LF and prepending :nick!user of the user provided in the first parameter.
void	WriteFrom (userrec *user, const char *text,...)
	Write text to this user, appending CR/LF and prepending :nick!user of the user provided in the first parameter.
void	WriteTo (userrec *dest, const std::string &data)
	Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user.
void	WriteTo (userrec *dest, const char *data,...)
	Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user.
void	WriteCommon (const std::string &text)
	Write to all users that can see this user (including this user in the list), appending CR/LF.
void	WriteCommon (const char *text,...)
	Write to all users that can see this user (including this user in the list), appending CR/LF.
void	WriteCommonExcept (const char *text,...)
	Write to all users that can see this user (not including this user in the list), appending CR/LF.
void	WriteCommonExcept (const std::string &text)
	Write to all users that can see this user (not including this user in the list), appending CR/LF.
void	WriteCommonQuit (const std::string &normal_text, const std::string &oper_text)
	Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific quit message for opers only.
void	WriteWallOps (const char *text,...)
	Write a WALLOPS message from this user to all local opers.
void	WriteWallOps (const std::string &text)
	Write a WALLOPS message from this user to all local opers.
bool	SharesChannelWith (userrec *other)
	Return true if the user shares at least one channel with another user.
bool	ChangeDisplayedHost (const char *host)
	Change the displayed host of a user.
bool	ChangeIdent (const char *newident)
	Change the ident (username) of a user.
bool	ChangeName (const char *gecos)
	Change a users realname field.
void	SendAll (const char *command, char *text,...)
	Send a command to all local users from this user The command given must be able to send text with the first parameter as a servermask (e.g.
std::string	ChannelList (userrec *source)
	Compile a channel list for this user, and send it to the user 'source' Used internally by WHOIS.
void	SplitChanList (userrec *dest, const std::string &cl)
	Split the channel list in cl which came from dest, and spool it to this user Used internally by WHOIS.
void	PurgeEmptyChannels ()
	Remove this user from all channels they are on, and delete any that are now empty.
ConnectClass *	GetClass ()
	Get the connect class which matches this user's host or IP address.
void	ShowMOTD ()
	Show the message of the day to this user.
void	ShowRULES ()
	Show the server RULES file to this user.
void	SetOperQuit (const std::string &oquit)
	Set oper-specific quit message shown to opers only when the user quits (overrides any sent by QuitUser).
const char *	GetOperQuit ()
	Get oper-specific quit message shown only to opers when the user quits.
void	HandleEvent (EventType et, int errornum=0)
	Handle socket event.
virtual	~userrec ()
	Default destructor.
Static Public Member Functions
static void	QuitUser (InspIRCd *Instance, userrec *user, const std::string &r, const char *oreason="")
	Disconnect a user gracefully.
static void	AddClient (InspIRCd *Instance, int socket, int port, bool iscached, int socketfamily, sockaddr *ip)
	Add a client to the system.
Public Attributes
UserResolver *	res_forward
	Resolvers for looking up this users IP address This will occur if and when res_reverse completes.
UserResolver *	res_reverse
	Resolvers for looking up this users hostname This is instantiated by userrec::StartDNSLookup(), and on success, instantiates userrec::res_reverse.
VisData *	Visibility
	User visibility state, see definition of VisData.
std::string	stored_host
	Stored reverse lookup from res_forward.
char	nick [NICKMAX]
	The users nickname.
char	ident [IDENTMAX+2]
	The users ident reply.
char	dhost [65]
	The host displayed to non-opers (used for cloaking etc).
char	fullname [MAXGECOS+1]
	The users full name (GECOS).
char	modes [64]
	The user's mode list.
char	snomasks [64]
	What snomasks are set on this user.
UserChanList	chans
	Channels this user is on, and the permissions they have there.
const char *	server
	The server the user is connected to.
char	awaymsg [MAXAWAY+1]
	The user's away message.
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.
time_t	timeout
	Timestamp of current time + connection class timeout.
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 int	pingmax
	Number of seconds between PINGs for this user (set from <connect:allow> tag.
char	password [64]
	Password specified by the user when they registered.
std::string	recvq
	User's receive queue.
std::string	sendq
	User's send queue.
int	lines_in
	Flood counters - lines received.
time_t	reset_due
	Flood counters - time lines_in is due to be reset.
long	threshold
	Flood counters - Highest value lines_in may reach before the user gets disconnected.
bool	quitting
	If this is set to true, then all read operations for the user are dropped into the bit-bucket.
bool	silentquit
std::string	quitmsg
	Quit message for this user.
std::string	operquitmsg
	Oper-only quit message for this user if non-null.
sockaddr *	ip
	IPV4 or IPV6 ip address.
std::string	WriteError
long	sendqmax
	Maximum size this user's sendq can become.
long	recvqmax
	Maximum size this user's recvq can become.
bool	exempt
	This is true if the user matched an exception when they connected to the ircd.
Private Member Functions
void	DecrementModes ()
	When we erase the user (in the destructor), we call this method to subtract one from all mode characters this user is making use of.
Private Attributes
InspIRCd *	ServerInstance
	Pointer to creator.
InvitedList	invites
	A list of channels the user has a pending invite to.
unsigned int	ChannelCount
	Number of channels this user is currently on.
char *	cached_fullhost
	Cached nick!ident value using the real hostname.
char *	cached_hostip
	Cached nick!ident value using the real IP address.
char *	cached_makehost
	Cached nick!ident value using the masked hostname.
char *	cached_fullrealhost
	Cached nick!ident value using the real hostname.

---

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 FindNick method of the InspIRCd class to locate a specific user by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their file descriptor value.

Definition at line 329 of file users.h.

---

Constructor & Destructor Documentation

userrec::userrec (  InspIRCd *  Instance  )

Default constructor. Exceptions: Nothing  at present Definition at line 323 of file users.cpp. References classbase::age, awaymsg, connection::bytes_in, connection::bytes_out, cached_fullhost, cached_fullrealhost, cached_hostip, cached_makehost, ChannelCount, chans, connection::cmds_in, connection::cmds_out, InspIRCd::Config, dhost, dns_done, exempt, EventHandler::fd, InspIRCd::FindServerNamePtr(), flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, invites, ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, password, quitting, recvq, connection::registered, res_forward, res_reverse, reset_due, sendq, server, ServerInstance, ServerConfig::ServerName, connection::signon, silentquit, snomasks, InspIRCd::Time(), timeout, Visibility, and WriteError. Referenced by AddClient(). : ServerInstance(Instance) { // the PROPER way to do it, AVOID bzero at *ALL* costs *password = *nick = *ident = *host = *dhost = *fullname = *awaymsg = *oper = 0; server = (char*)Instance->FindServerNamePtr(Instance->Config->ServerName); reset_due = ServerInstance->Time(); age = ServerInstance->Time(true); lines_in = lastping = signon = idle_lastmsg = nping = registered = 0; ChannelCount = timeout = flood = bytes_in = bytes_out = cmds_in = cmds_out = 0; silentquit = quitting = exempt = haspassed = dns_done = false; fd = -1; recvq.clear(); sendq.clear(); WriteError.clear(); res_forward = res_reverse = NULL; Visibility = NULL; ip = NULL; chans.clear(); invites.clear(); memset(modes,0,sizeof(modes)); memset(snomasks,0,sizeof(snomasks)); /* Invalidate cache */ cached_fullhost = cached_hostip = cached_makehost = cached_fullrealhost = NULL; }

userrec::~userrec (   )  [virtual]

Default destructor. Definition at line 371 of file users.cpp. References DecrementModes(), InvalidateCache(), ip, and RemoveCloneCounts(). { this->InvalidateCache(); this->DecrementModes(); if (ip) { this->RemoveCloneCounts(); if (this->GetProtocolFamily() == AF_INET) { delete (sockaddr_in*)ip; } #ifdef SUPPORT_IP6LINKS else { delete (sockaddr_in6*)ip; } #endif } }

---

Member Function Documentation

bool userrec::AddBuffer (  std::string  a  )

This method adds data to the read buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted. Parameters: a  The string to add to the users read buffer Returns: True if the string was successfully added to the read buffer Definition at line 611 of file users.cpp. References DEBUG, InspIRCd::Log(), recvq, recvqmax, ServerInstance, SetWriteError(), and InspIRCd::WriteOpers(). Referenced by InspIRCd::ProcessUser(). { try { std::string::size_type i = a.rfind('\r'); while (i != std::string::npos) { a.erase(i, 1); i = a.rfind('\r'); } if (a.length()) recvq.append(a); if (recvq.length() > (unsigned)this->recvqmax) { this->SetWriteError("RecvQ exceeded"); ServerInstance->WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax); return false; } return true; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::AddBuffer()"); return false; } }

void userrec::AddClient (  InspIRCd *  Instance, int  socket, int  port, bool  iscached, int  socketfamily, sockaddr *  ip )  [static]

Add a client to the system. This will create a new userrec, insert it into the user_hash, initialize it as not yet registered, and add it to the socket engine. Parameters: Instance  a pointer to the server instance socket  The socket id (file descriptor) this user is on port  The port number this user connected on iscached  This variable is reserved for future use ip  The IP address of the user Returns: This function has no return value, but a call to AddClient may remove the user. Definition at line 862 of file users.cpp. References SocketEngine::AddFd(), InspIRCd::AddGlobalClone(), InspIRCd::AddLocalClone(), CheckClass(), InspIRCd::clientlist, InspIRCd::Config, ConvToStr(), DELETE(), dhost, ServerConfig::dns_timeout, exempt, EventHandler::fd, InspIRCd::FindServerNamePtr(), GetClass(), GetIPString(), connection::host, ident, connection::lastping, InspIRCd::local_users, XLineManager::matches_exception(), XLineManager::matches_zline(), MAX_DESCRIPTORS, MAXBUF, MAXCLIENTS, ServerConfig::MoronBanner, nick, NICKMAX, QuitUser(), XLine::reason, REG_NONE, connection::registered, InspIRCd::SE, server, ServerConfig::ServerName, SetSockAddr(), connection::signon, ServerConfig::SoftLimit, strlcpy(), InspIRCd::Time(), InspIRCd::unregistered_count, userrec(), InspIRCd::WriteOpers(), WriteServ(), and InspIRCd::XLines. Referenced by ListenSocket::HandleEvent(). { std::string tempnick = ConvToStr(socket) + "-unknown"; user_hash::iterator iter = Instance->clientlist->find(tempnick); char ipaddr[MAXBUF]; #ifdef IPV6 if (socketfamily == AF_INET6) inet_ntop(AF_INET6, &((const sockaddr_in6*)ip)->sin6_addr, ipaddr, sizeof(ipaddr)); else #endif inet_ntop(AF_INET, &((const sockaddr_in*)ip)->sin_addr, ipaddr, sizeof(ipaddr)); userrec* New; int j = 0; Instance->unregistered_count++; /* * fix by brain. * as these nicknames are 'RFC impossible', we can be sure nobody is going to be * using one as a registered connection. As they are per fd, we can also safely assume * that we wont have collisions. Therefore, if the nick exists in the list, its only * used by a dead socket, erase the iterator so that the new client may reclaim it. * this was probably the cause of 'server ignores me when i hammer it with reconnects' * issue in earlier alphas/betas */ if (iter != Instance->clientlist->end()) { userrec* goner = iter->second; DELETE(goner); Instance->clientlist->erase(iter); } New = new userrec(Instance); (*(Instance->clientlist))[tempnick] = New; New->fd = socket; strlcpy(New->nick,tempnick.c_str(),NICKMAX-1); New->server = Instance->FindServerNamePtr(Instance->Config->ServerName); /* We don't need range checking here, we KNOW 'unknown\0' will fit into the ident field. */ strcpy(New->ident, "unknown"); New->registered = REG_NONE; New->signon = Instance->Time() + Instance->Config->dns_timeout; New->lastping = 1; New->SetSockAddr(socketfamily, ipaddr, port); /* Smarter than your average bear^H^H^H^Hset of strlcpys. */ for (const char* temp = New->GetIPString(); *temp && j < 64; temp++, j++) New->dhost[j] = New->host[j] = *temp; New->dhost[j] = New->host[j] = 0; Instance->AddLocalClone(New); Instance->AddGlobalClone(New); New->exempt = (Instance->XLines->matches_exception(New) != NULL); if (!New->exempt) { ZLine* r = Instance->XLines->matches_zline(ipaddr); if (r) { char reason[MAXBUF]; if (*Instance->Config->MoronBanner) New->WriteServ("NOTICE %s :*** %s", New->nick, Instance->Config->MoronBanner); snprintf(reason,MAXBUF,"Z-Lined: %s",r->reason); userrec::QuitUser(Instance, New, reason); return; } } /* * First class check. We do this again in FullConnect after DNS is done, and NICK/USER is recieved. * See my note down there for why this is required. DO NOT REMOVE. :) -- w00t */ ConnectClass* i = New->GetClass(); if (!i) { userrec::QuitUser(Instance, New, "Access denied by configuration"); return; } /* * Check connect class settings and initialise settings into userrec. * This will be done again after DNS resolution. -- w00t */ New->CheckClass(i); Instance->local_users.push_back(New); if ((Instance->local_users.size() > Instance->Config->SoftLimit) || (Instance->local_users.size() >= MAXCLIENTS)) { Instance->WriteOpers("*** Warning: softlimit value has been reached: %d clients", Instance->Config->SoftLimit); userrec::QuitUser(Instance, New,"No more connections allowed"); return; } /* * XXX - * this is done as a safety check to keep the file descriptors within range of fd_ref_table. * its a pretty big but for the moment valid assumption: * file descriptors are handed out starting at 0, and are recycled as theyre freed. * therefore if there is ever an fd over 65535, 65536 clients must be connected to the * irc server at once (or the irc server otherwise initiating this many connections, files etc) * which for the time being is a physical impossibility (even the largest networks dont have more * than about 10,000 users on ONE server!) */ #ifndef WINDOWS if ((unsigned int)socket >= MAX_DESCRIPTORS) { userrec::QuitUser(Instance, New, "Server is full"); return; } #endif if (socket > -1) { if (!Instance->SE->AddFd(New)) { userrec::QuitUser(Instance, New, "Internal error handling connection"); } } /* NOTE: even if dns lookups are *off*, we still need to display this. * BOPM and other stuff requires it. */ New->WriteServ("NOTICE Auth :*** Looking up your hostname..."); }

void userrec::AddToWhoWas (   )

Add the user to WHOWAS system. Definition at line 850 of file users.cpp. References CommandParser::GetHandler(), command_t::HandleInternal(), InspIRCd::Parser, ServerInstance, and WHOWAS_ADD. { command_t* whowas_command = ServerInstance->Parser->GetHandler("WHOWAS"); if (whowas_command) { std::deque<classbase*> params; params.push_back(this); whowas_command->HandleInternal(WHOWAS_ADD, params); } }

void userrec::AddWriteBuf (  const std::string &  data  )

Adds to the user's write buffer. You may add any amount of text up to this users sendq value, if you exceed the sendq value, SetWriteError() will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped. Parameters: data  The data to add to the write buffer Definition at line 693 of file users.cpp. References MAXBUF, sendq, sendqmax, ServerInstance, SetWriteError(), and InspIRCd::WriteOpers(). Referenced by ModuleXMLSocket::OnRawSocketWrite(), and Write(). { if (*this->GetWriteError()) return; if (sendq.length() + data.length() > (unsigned)this->sendqmax) { /* * Fix by brain - Set the error text BEFORE calling writeopers, because * if we dont it'll recursively call here over and over again trying * to repeatedly add the text to the sendq! */ this->SetWriteError("SendQ exceeded"); ServerInstance->WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax); return; } try { if (data.length() > MAXBUF - 2) /* MAXBUF has a value of 514, to account for line terminators */ sendq.append(data.substr(0,MAXBUF - 4)).append("\r\n"); /* MAXBUF-4 = 510 */ else sendq.append(data); } catch (...) { this->SetWriteError("SendQ exceeded"); ServerInstance->WriteOpers("*** User %s SendQ got an exception",this->nick); } }

bool userrec::BufferIsReady (   )

This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read) Returns: True if there is at least one complete line in the users buffer Definition at line 643 of file users.cpp. References recvq. Referenced by InspIRCd::ProcessUser(). { return (recvq.find('\n') != std::string::npos); }

bool userrec::ChangeDisplayedHost (  const char *  host  )

Change the displayed host of a user. ALWAYS use this function, rather than writing userrec::dhost directly, as this triggers module events allowing the change to be syncronized to remote servers. This will also emulate a QUIT and rejoin (where configured) before setting their host field. Parameters: host  The new hostname to set Returns: True if the change succeeded, false if it didn't Definition at line 1715 of file users.cpp. References chans, FOREACH_MOD, FOREACH_RESULT, I_OnChangeHost, I_OnChangeLocalUserHost, InvalidateCache(), IS_LOCAL, InspIRCd::Modes, ModeParser::ModeString(), ServerInstance, strlcpy(), WriteCommonExcept(), and WriteServ(). Referenced by TreeSocket::ChangeHost(), cmd_vhost::Handle(), cmd_sethost::Handle(), cmd_title::Handle(), cmd_chghost::Handle(), cmd_oper::Handle(), CloakUser::OnModeChange(), ModuleHostChange::OnUserConnect(), and ModuleSQLOper::OperUser(). { if (!strcmp(host, this->dhost)) return true; if (IS_LOCAL(this)) { int MOD_RESULT = 0; FOREACH_RESULT(I_OnChangeLocalUserHost,OnChangeLocalUserHost(this,host)); if (MOD_RESULT) return false; FOREACH_MOD(I_OnChangeHost,OnChangeHost(this,host)); } if (this->ServerInstance->Config->CycleHosts) this->WriteCommonExcept("QUIT :Changing hosts"); /* Fix by Om: userrec::dhost is 65 long, this was truncating some long hosts */ strlcpy(this->dhost,host,64); this->InvalidateCache(); if (this->ServerInstance->Config->CycleHosts) { for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++) { i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name); std::string n = this->ServerInstance->Modes->ModeString(this, i->first); if (n.length() > 0) i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str()); } } if (IS_LOCAL(this)) this->WriteServ("396 %s %s :is now your displayed host",this->nick,this->dhost); return true; }

bool userrec::ChangeIdent (  const char *  newident  )

Change the ident (username) of a user. ALWAYS use this function, rather than writing userrec::ident directly, as this correctly causes the user to seem to quit (where configured) before setting their ident field. Parameters: host  The new ident to set Returns: True if the change succeeded, false if it didn't Definition at line 1753 of file users.cpp. References chans, IDENTMAX, InvalidateCache(), InspIRCd::Modes, ModeParser::ModeString(), ServerInstance, strlcpy(), and WriteCommonExcept(). Referenced by cmd_setident::Handle(), and cmd_chgident::Handle(). { if (!strcmp(newident, this->ident)) return true; if (this->ServerInstance->Config->CycleHosts) this->WriteCommonExcept("%s","QUIT :Changing ident"); strlcpy(this->ident, newident, IDENTMAX+1); this->InvalidateCache(); if (this->ServerInstance->Config->CycleHosts) { for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++) { i->first->WriteAllExceptSender(this, false, 0, "JOIN %s", i->first->name); std::string n = this->ServerInstance->Modes->ModeString(this, i->first); if (n.length() > 0) i->first->WriteAllExceptSender(this, true, 0, "MODE %s +%s", i->first->name, n.c_str()); } } return true; }

bool userrec::ChangeName (  const char *  gecos  )

Change a users realname field. ALWAYS use this function, rather than writing userrec::fullname directly, as this triggers module events allowing the change to be syncronized to remote servers. Parameters: gecos  The user's new realname Returns: True if the change succeeded, false if otherwise Definition at line 1697 of file users.cpp. References FOREACH_MOD, FOREACH_RESULT, I_OnChangeLocalUserGECOS, I_OnChangeName, IS_LOCAL, MAXGECOS, and strlcpy(). Referenced by TreeSocket::ChangeName(), cmd_setname::Handle(), and cmd_chgname::Handle(). { if (!strcmp(gecos, this->fullname)) return true; if (IS_LOCAL(this)) { int MOD_RESULT = 0; FOREACH_RESULT(I_OnChangeLocalUserGECOS,OnChangeLocalUserGECOS(this,gecos)); if (MOD_RESULT) return false; FOREACH_MOD(I_OnChangeName,OnChangeName(this,gecos)); } strlcpy(this->fullname,gecos,MAXGECOS+1); return true; }

std::string userrec::ChannelList (  userrec *  source  )

Compile a channel list for this user, and send it to the user 'source' Used internally by WHOIS. Parameters: The  user to send the channel list to if it is not too long Returns: This user's channel list Definition at line 1799 of file users.cpp. References chans, InspIRCd::Config, DEBUG, IS_OPER, InspIRCd::Log(), ServerConfig::OperSpyWhois, and ServerInstance. Referenced by do_whois(), and cmd_check::Handle(). { try { std::string list; for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++) { /* If the target is the same as the sender, let them see all their channels. * If the channel is NOT private/secret OR the user shares a common channel * If the user is an oper, and the <options:operspywhois> option is set. */ if ((source == this) || (IS_OPER(source) && ServerInstance->Config->OperSpyWhois) || (((!i->first->IsModeSet('p')) && (!i->first->IsModeSet('s'))) || (i->first->HasUser(source)))) { list.append(i->first->GetPrefixChar(this)).append(i->first->name).append(" "); } } return list; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::ChannelList()"); return ""; } }

void userrec::CheckClass (  ConnectClass *  a  )

Call this method to check a user against a connect class. Parameters: a  The connect class to match them against. Definition at line 1013 of file users.cpp. References CC_DENY, InspIRCd::Config, ServerConfig::dns_timeout, flood, ConnectClass::GetFlood(), GetIPString(), ConnectClass::GetMaxGlobal(), ConnectClass::GetMaxLocal(), ConnectClass::GetPingTime(), ConnectClass::GetRecvqMax(), ConnectClass::GetRegTimeout(), ConnectClass::GetSendqMax(), ConnectClass::GetThreshold(), ConnectClass::GetType(), GlobalCloneCount(), LocalCloneCount(), connection::nping, pingmax, QuitUser(), recvqmax, sendqmax, ServerInstance, threshold, InspIRCd::Time(), timeout, and InspIRCd::WriteOpers(). Referenced by AddClient(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), FullConnect(), and ModuleCgiIRC::OnUserConnect(). { if ((!a) || (a->GetType() == CC_DENY)) { userrec::QuitUser(ServerInstance, this, "Unauthorised connection"); return; } else if ((a->GetMaxLocal()) && (this->LocalCloneCount() > a->GetMaxLocal())) { userrec::QuitUser(ServerInstance, this, "No more connections allowed from your host via this connect class (local)"); ServerInstance->WriteOpers("*** WARNING: maximum LOCAL connections (%ld) exceeded for IP %s", a->GetMaxLocal(), this->GetIPString()); return; } else if ((a->GetMaxGlobal()) && (this->GlobalCloneCount() > a->GetMaxGlobal())) { userrec::QuitUser(ServerInstance, this, "No more connections allowed from your host via this connect class (global)"); ServerInstance->WriteOpers("*** WARNING: maximum GLOBAL connections (%ld) exceeded for IP %s", a->GetMaxGlobal(), this->GetIPString()); return; } this->pingmax = a->GetPingTime(); this->nping = ServerInstance->Time() + a->GetPingTime() + ServerInstance->Config->dns_timeout; this->timeout = ServerInstance->Time() + a->GetRegTimeout(); this->flood = a->GetFlood(); this->threshold = a->GetThreshold(); this->sendqmax = a->GetSendqMax(); this->recvqmax = a->GetRecvqMax(); }

void userrec::ClearBuffer (   )

This function clears the entire buffer by setting it to an empty string. Definition at line 648 of file users.cpp. References recvq. { recvq.clear(); }

void userrec::CloseSocket (   )

Shuts down and closes the user's socket This will not cause the user to be deleted. Use InspIRCd::QuitUser for this, which will call CloseSocket() for you. Definition at line 433 of file users.cpp. Referenced by CullList::Apply(). { if (this->fd > -1) { shutdown(this->fd,2); close(this->fd); } }

void userrec::DecrementModes (   )  [private]

When we erase the user (in the destructor), we call this method to subtract one from all mode characters this user is making use of. Definition at line 310 of file users.cpp. References ModeHandler::ChangeCount(), ModeParser::FindMode(), InspIRCd::Modes, modes, MODETYPE_USER, and ServerInstance. Referenced by ~userrec(). { for (int n = 0; n < 64; n++) { if (modes[n]) { ModeHandler* mh = ServerInstance->Modes->FindMode(n+65, MODETYPE_USER); if (mh) mh->ChangeCount(-1); } } }

void userrec::FlushWriteBuf (   )

Flushes as much of the user's buffer to the file descriptor as possible. This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method. Definition at line 725 of file users.cpp. References connection::bytes_out, connection::cmds_out, DEBUG, EventHandler::fd, FD_MAGIC_NUMBER, FOREACH_MOD, I_OnBufferFlushed, InspIRCd::Log(), InspIRCd::SE, sendq, ServerInstance, SetWriteError(), and SocketEngine::WantWrite(). Referenced by CullList::Apply(), and HandleEvent(). { try { if ((this->fd == FD_MAGIC_NUMBER) || (*this->GetWriteError())) { sendq.clear(); } if ((sendq.length()) && (this->fd != FD_MAGIC_NUMBER)) { int old_sendq_length = sendq.length(); #ifndef WIN32 int n_sent = write(this->fd, this->sendq.data(), this->sendq.length()); #else int n_sent = send(this->fd, (const char*)this->sendq.data(), this->sendq.length(), 0); #endif if (n_sent == -1) { if (errno == EAGAIN) { /* The socket buffer is full. This isnt fatal, * try again later. */ this->ServerInstance->SE->WantWrite(this); } else { /* Fatal error, set write error and bail */ this->SetWriteError(errno ? strerror(errno) : "EOF from client"); return; } } else { /* advance the queue */ if (n_sent) this->sendq = this->sendq.substr(n_sent); /* update the user's stats counters */ this->bytes_out += n_sent; this->cmds_out++; if (n_sent != old_sendq_length) this->ServerInstance->SE->WantWrite(this); } } } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::FlushWriteBuf()"); } if (this->sendq.empty()) { FOREACH_MOD(I_OnBufferFlushed,OnBufferFlushed(this)); } }

bool userrec::ForceNickChange (  const char *  newnick  )

Force a nickname change. If the nickname change fails (for example, because the nick in question already exists) this function will return false, and you must then either output an error message, or quit the user for nickname collision. Parameters: newnick  The nickname to change to Returns: True if the nickchange was successful. Definition at line 1185 of file users.cpp. References CommandParser::CallHandler(), CMD_SUCCESS, DEBUG, FOREACH_RESULT, I_OnUserPreNick, InvalidateCache(), InspIRCd::Log(), XLineManager::matches_qline(), InspIRCd::Parser, REG_ALL, ServerInstance, InspIRCd::stats, serverstats::statsCollisions, and InspIRCd::XLines. Referenced by TreeSocket::ForceNick(), cmd_sanick::Handle(), and cmd_nicklock::Handle(). { try { int MOD_RESULT = 0; this->InvalidateCache(); FOREACH_RESULT(I_OnUserPreNick,OnUserPreNick(this, newnick)); if (MOD_RESULT) { ServerInstance->stats->statsCollisions++; return false; } if (ServerInstance->XLines->matches_qline(newnick)) { ServerInstance->stats->statsCollisions++; return false; } if (this->registered == REG_ALL) { return (ServerInstance->Parser->CallHandler("NICK", &newnick, 1, this) == CMD_SUCCESS); } return false; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::ForceNickChange()"); return false; } }

const char * userrec::FormatModes (   )

Create a displayable mode string for this users umodes. Parameters: The  mode string Definition at line 297 of file users.cpp. References MAXBUF, and modes. Referenced by ModeParser::DisplayCurrentModes(), cmd_check::Handle(), and ModuleSpanningTree::OnUserConnect(). { static char data[MAXBUF]; int offset = 0; for (int n = 0; n < 64; n++) { if (modes[n]) data[offset++] = n+65; } data[offset] = 0; return data; }

const char * userrec::FormatNoticeMasks (   )

Create a displayable mode string for this users snomasks. Returns: The notice mask character sequence Definition at line 270 of file users.cpp. References MAXBUF, and snomasks. Referenced by ModeParser::DisplayCurrentModes(), and cmd_check::Handle(). { static char data[MAXBUF]; int offset = 0; for (int n = 0; n < 64; n++) { if (snomasks[n]) data[offset++] = n+65; } data[offset] = 0; return data; }

void userrec::FullConnect (   )

Use this method to fully connect a user. This will send the message of the day, check G/K/E lines, etc. Definition at line 1042 of file users.cpp. References InspIRCd::CallCommandHandler(), ModeParser::ChannelModeList(), CheckClass(), InspIRCd::Config, exempt, FOREACH_MOD, FOREACH_RESULT, fullname, GetClass(), GetIPString(), connection::haspassed, connection::host, I_OnPostConnect, I_OnPreCommand, I_OnUserConnect, ident, connection::idle_lastmsg, XLineManager::matches_exception(), XLineManager::matches_gline(), XLineManager::matches_kline(), MAXBUF, InspIRCd::Modes, ServerConfig::MoronBanner, ServerConfig::Network, nick, ModeParser::ParaModeList(), QuitUser(), XLine::reason, REG_ALL, connection::registered, ServerConfig::Send005(), ServerInstance, ServerConfig::ServerName, ShowMOTD(), InspIRCd::SNO, InspIRCd::stats, serverstats::statsConnects, InspIRCd::Time(), InspIRCd::unregistered_count, ModeParser::UserModeList(), WriteServ(), SnomaskManager::WriteToSnoMask(), and InspIRCd::XLines. Referenced by InspIRCd::DoBackgroundUserStuff(). { ServerInstance->stats->statsConnects++; this->idle_lastmsg = ServerInstance->Time(); ConnectClass *a = this->GetClass(); if (!a) { /* * This can happen: * - user connects * - /rehash, removing <connect> tag they matched * - dns completes (putting us here) ...but they no longer have a connect tag * Catch it here. Thanks Szymek! * -- w00t */ userrec::QuitUser(ServerInstance, this, "Invalid password"); return; } /* * You may be thinking "wtf, we checked this in userrec::AddClient!" - and yes, we did, BUT. * At the time AddClient is called, we don't have a resolved host, by here we probably do - which * may put the user into a totally seperate class with different restrictions! so we *must* check again. * Don't remove this! -- w00t */ this->CheckClass(a); /* Check the password, if one is required by the user's connect class. * This CANNOT be in CheckClass(), because that is called prior to PASS as well! */ if ((!this->GetClass()->GetPass().empty()) && (!this->haspassed)) { userrec::QuitUser(ServerInstance, this, "Invalid password"); return; } this->exempt = (ServerInstance->XLines->matches_exception(this) != NULL); if (!this->exempt) { GLine* r = ServerInstance->XLines->matches_gline(this); if (r) { char reason[MAXBUF]; if (*ServerInstance->Config->MoronBanner) this->WriteServ("NOTICE %s :*** %s", this->nick, ServerInstance->Config->MoronBanner); snprintf(reason,MAXBUF,"G-Lined: %s",r->reason); userrec::QuitUser(ServerInstance, this, reason); return; } KLine* n = ServerInstance->XLines->matches_kline(this); if (n) { char reason[MAXBUF]; if (*ServerInstance->Config->MoronBanner) this->WriteServ("NOTICE %s :*** %s", this->nick, ServerInstance->Config->MoronBanner); snprintf(reason,MAXBUF,"K-Lined: %s",n->reason); userrec::QuitUser(ServerInstance, this, reason); return; } } this->WriteServ("NOTICE Auth :Welcome to \002%s\002!",ServerInstance->Config->Network); this->WriteServ("001 %s :Welcome to the %s IRC Network %s!%s@%s",this->nick, ServerInstance->Config->Network, this->nick, this->ident, this->host); this->WriteServ("002 %s :Your host is %s, running version InspIRCd-1.1",this->nick,ServerInstance->Config->ServerName); this->WriteServ("003 %s :This server was created %s %s", this->nick, __TIME__, __DATE__); this->WriteServ("004 %s %s InspIRCd-1.1 %s %s %s", this->nick, ServerInstance->Config->ServerName, ServerInstance->Modes->UserModeList().c_str(), ServerInstance->Modes->ChannelModeList().c_str(), ServerInstance->Modes->ParaModeList().c_str()); ServerInstance->Config->Send005(this); this->ShowMOTD(); /* Now registered */ if (ServerInstance->unregistered_count) ServerInstance->unregistered_count--; /* Trigger LUSERS output, give modules a chance too */ int MOD_RESULT = 0; FOREACH_RESULT(I_OnPreCommand, OnPreCommand("LUSERS", NULL, 0, this, true, "LUSERS")); if (!MOD_RESULT) ServerInstance->CallCommandHandler("LUSERS", NULL, 0, this); /* * fix 3 by brain, move registered = 7 below these so that spurious modes and host * changes dont go out onto the network and produce 'fake direction'. */ FOREACH_MOD(I_OnUserConnect,OnUserConnect(this)); this->registered = REG_ALL; FOREACH_MOD(I_OnPostConnect,OnPostConnect(this)); ServerInstance->SNO->WriteToSnoMask('c',"Client connecting on port %d: %s!%s@%s [%s] [%s]", this->GetPort(), this->nick, this->ident, this->host, this->GetIPString(), this->fullname); }

std::string userrec::GetBuffer (   )

This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use BufferIsReady() to check if it is ok to read the buffer before calling GetBuffer(). Returns: The string at the tail end of this users buffer Definition at line 653 of file users.cpp. References DEBUG, InspIRCd::Log(), recvq, and ServerInstance. Referenced by InspIRCd::ProcessUser(). { try { if (!recvq.length()) return ""; /* Strip any leading \r or \n off the string. * Usually there are only one or two of these, * so its is computationally cheap to do. */ std::string::iterator t = recvq.begin(); while (t != recvq.end() && (*t == '\r' || *t == '\n')) { recvq.erase(t); t = recvq.begin(); } for (std::string::iterator x = recvq.begin(); x != recvq.end(); x++) { /* Find the first complete line, return it as the * result, and leave the recvq as whats left */ if (*x == '\n') { std::string ret = std::string(recvq.begin(), x); recvq.erase(recvq.begin(), x + 1); return ret; } } return ""; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::GetBuffer()"); return ""; } }

ConnectClass * userrec::GetClass (   )

Get the connect class which matches this user's host or IP address. Returns: A reference to this user's connect class Definition at line 1875 of file users.cpp. References ServerConfig::Classes, InspIRCd::Config, match(), and ServerInstance. Referenced by AddClient(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), FullConnect(), cmd_pass::Handle(), and ModuleCgiIRC::OnUserConnect(). { for (ClassVector::iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++) { if (((match(this->GetIPString(),i->GetHost().c_str(),true)) || (match(this->host,i->GetHost().c_str())))) { if (i->GetPort()) { if (this->GetPort() == i->GetPort()) return &(*i); else continue; } else return &(*i); } } return NULL; }

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 masked host of the user Definition at line 442 of file users.cpp. References cached_fullhost, dhost, ident, MAXBUF, and nick. Referenced by cmd_check::Handle(), chanrec::IsBanned(), ModuleSilence::MatchPattern(), ModuleBanException::OnCheckBan(), ModuleInviteException::OnCheckInvite(), ModuleInviteException::OnRequest(), ModuleBanException::OnRequest(), ModuleInvisible::OnUserJoin(), ModuleBanRedirect::OnUserPreJoin(), ModuleSilence::OnUserPreNotice(), ModuleDCCAllow::OnUserPreNotice(), chanrec::WriteAllExcept(), chanrec::WriteChannel(), ModuleInvisible::WriteCommonFrom(), and WriteFrom(). { if (this->cached_fullhost) return this->cached_fullhost; char result[MAXBUF]; char* t = result; for(char* n = nick; *n; n++) *t++ = *n; *t++ = '!'; for(char* n = ident; *n; n++) *t++ = *n; *t++ = '@'; for(char* n = dhost; *n; n++) *t++ = *n; *t = 0; this->cached_fullhost = strdup(result); return this->cached_fullhost; }

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. Returns: The full real host of the user Definition at line 491 of file users.cpp. References cached_fullrealhost, connection::host, ident, MAXBUF, and nick. Referenced by cmd_rsquit::Handle(), cmd_check::Handle(), ModuleSpanningTree::HandleSquit(), chanrec::IsBanned(), ModuleBanException::OnCheckBan(), ModuleInviteException::OnCheckInvite(), DNSBLResolver::OnLookupComplete(), ModuleInviteException::OnRequest(), ModuleBanException::OnRequest(), and ModuleBanRedirect::OnUserPreJoin(). { if (this->cached_fullrealhost) return this->cached_fullrealhost; char fresult[MAXBUF]; char* t = fresult; for(char* n = nick; *n; n++) *t++ = *n; *t++ = '!'; for(char* n = ident; *n; n++) *t++ = *n; *t++ = '@'; for(char* n = host; *n; n++) *t++ = *n; *t = 0; this->cached_fullrealhost = strdup(fresult); return this->cached_fullrealhost; }

InvitedList * userrec::GetInviteList (   )

Returns the list of channels this user has been invited to but has not yet joined. Returns: A list of channels the user is invited to Definition at line 525 of file users.cpp. References invites. Referenced by cmd_invite::Handle(). { return &invites; }

const char * userrec::GetIPString (  char *  buf  )

Get IP string from sockaddr, using caller-specified buffer. Parameters: buf  A buffer to use Returns: The IP string Definition at line 1327 of file users.cpp. References ip, and strlcpy(). { if (this->ip == NULL) { *buf = 0; return buf; } switch (this->GetProtocolFamily()) { #ifdef SUPPORT_IP6LINKS case AF_INET6: { static char temp[1024]; sockaddr_in6* sin = (sockaddr_in6*)this->ip; inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf)); /* IP addresses starting with a : on irc are a Bad Thing (tm) */ if (*buf == ':') { strlcpy(&temp[1], buf, sizeof(temp) - 1); *temp = '0'; strlcpy(buf, temp, sizeof(temp)); } return buf; } break; #endif case AF_INET: { sockaddr_in* sin = (sockaddr_in*)this->ip; inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf)); return buf; } break; default: break; } return ""; }

const char * userrec::GetIPString (   )

Get IP string from sockaddr, using static internal buffer. Returns: The IP string Definition at line 1287 of file users.cpp. References ip, and strlcpy(). Referenced by AddClient(), InspIRCd::AddGlobalClone(), InspIRCd::AddLocalClone(), XLineManager::apply_lines(), CheckClass(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), do_whois(), InspIRCd::DoBackgroundUserStuff(), DoStats(), InspIRCd::FloodQuitUser(), FullConnect(), cmd_userip::Handle(), cmd_title::Handle(), cmd_webirc::Handle(), cmd_zline::Handle(), cmd_oper::Handle(), cmd_kline::Handle(), cmd_gline::Handle(), cmd_eline::Handle(), IdentRequestSocket::IdentRequestSocket(), TreeSocket::IntroduceClient(), chanrec::IsBanned(), MakeHostIP(), XLineManager::matches_exception(), XLineManager::matches_gline(), XLineManager::matches_kline(), ModuleBanException::OnCheckBan(), ModuleInviteException::OnCheckInvite(), UserResolver::OnError(), UserResolver::OnLookupComplete(), DNSBLResolver::OnLookupComplete(), CloakUser::OnModeChange(), ModuleOperSSLCert::OnPreCommand(), FilterBase::OnPreCommand(), ModuleInviteException::OnRequest(), ModuleBanException::OnRequest(), ModuleSpanningTree::OnUserConnect(), ModuleModesOnConnect::OnUserConnect(), ModuleDNSBL::OnUserRegister(), ModuleCgiIRC::OnUserRegister(), ModuleSQLOper::OperUser(), ModuleCgiIRC::Recheck(), and StartDNSLookup(). { static char buf[1024]; if (this->ip == NULL) return ""; switch (this->GetProtocolFamily()) { #ifdef SUPPORT_IP6LINKS case AF_INET6: { static char temp[1024]; sockaddr_in6* sin = (sockaddr_in6*)this->ip; inet_ntop(sin->sin6_family, &sin->sin6_addr, buf, sizeof(buf)); /* IP addresses starting with a : on irc are a Bad Thing (tm) */ if (*buf == ':') { strlcpy(&temp[1], buf, sizeof(temp) - 1); *temp = '0'; return temp; } return buf; } break; #endif case AF_INET: { sockaddr_in* sin = (sockaddr_in*)this->ip; inet_ntop(sin->sin_family, &sin->sin_addr, buf, sizeof(buf)); return buf; } break; default: break; } return ""; }

const char * userrec::GetOperQuit (   )

Get oper-specific quit message shown only to opers when the user quits. (overrides any sent by QuitUser) Definition at line 2006 of file users.cpp. References operquitmsg. { return operquitmsg.c_str(); }

int userrec::GetPort (   )

Get port number from sockaddr. Returns: The port number of this user. Definition at line 1251 of file users.cpp. References ip. Referenced by CullList::Apply(), ModuleCgiIRC::CheckIdent(), cmd_check::Handle(), ModuleSSLGnuTLS::OnCleanup(), CGIResolver::OnLookupComplete(), ModuleHostChange::OnUserConnect(), ModuleCgiIRC::OnUserConnect(), InspIRCd::ProcessUser(), and cmd_who::whomatch(). { if (this->ip == NULL) return 0; switch (this->GetProtocolFamily()) { #ifdef SUPPORT_IP6LINKS case AF_INET6: { sockaddr_in6* sin = (sockaddr_in6*)this->ip; return sin->sin6_port; } break; #endif case AF_INET: { sockaddr_in* sin = (sockaddr_in*)this->ip; return sin->sin_port; } break; default: break; } return 0; }

int userrec::GetProtocolFamily (   )

Get protocol family from sockaddr. Returns: The protocol family of this user, either AF_INET or AF_INET6 Definition at line 1278 of file users.cpp. References ip. Referenced by ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), CGIResolver::OnLookupComplete(), CloakUser::OnModeChange(), and ModuleCgiIRC::OnUserConnect(). { if (this->ip == NULL) return 0; sockaddr_in* sin = (sockaddr_in*)this->ip; return sin->sin_family; }

const char * userrec::GetWriteError (   )

Returns the write error which last occured on this connection or an empty string if none occured. Returns: The error string which has occured for this user Definition at line 798 of file users.cpp. References WriteError. Referenced by CullList::Apply(), and HandleEvent(). { return this->WriteError.c_str(); }

unsigned long userrec::GlobalCloneCount (   )

Return the number of global clones of this user. Returns: The global clone count of this user Definition at line 992 of file users.cpp. References InspIRCd::global_clones, and ServerInstance. Referenced by CheckClass(). { clonemap::iterator x = ServerInstance->global_clones.find(this->GetIPString()); if (x != ServerInstance->global_clones.end()) return x->second; else return 0; }

void userrec::HandleEvent (  EventType  et, int  errornum = 0 )  [virtual]

Handle socket event. From EventHandler class. Parameters: et  Event type errornum  Error number for EVENT_ERROR events Implements EventHandler. Definition at line 1963 of file users.cpp. References DEBUG, EVENT_ERROR, EVENT_READ, EVENT_WRITE, FlushWriteBuf(), EventHandler::GetFd(), SocketEngine::GetRef(), GetWriteError(), InspIRCd::Log(), InspIRCd::ProcessUser(), QuitUser(), InspIRCd::SE, ServerInstance, SetWriteError(), and WriteError. { /* WARNING: May delete this user! */ int thisfd = this->GetFd(); try { switch (et) { case EVENT_READ: if (this->quitting) return; // we just don't care anymore ServerInstance->ProcessUser(this); break; case EVENT_WRITE: this->FlushWriteBuf(); break; case EVENT_ERROR: this->SetWriteError(errornum ? strerror(errornum) : "EOF from client"); break; } } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::HandleEvent intercepted"); } /* If the user has raised an error whilst being processed, quit them now we're safe to */ if ((ServerInstance->SE->GetRef(thisfd) == this)) { if (!WriteError.empty()) { userrec::QuitUser(ServerInstance, this, GetWriteError()); } } }

bool userrec::HasPermission (  const std::string &  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. Parameters: command  A command (should be all CAPS) Returns: True if this user can execute the command Definition at line 554 of file users.cpp. References InspIRCd::Config, IS_LOCAL, IS_OPER, ServerConfig::operclass, ServerConfig::opertypes, and ServerInstance. Referenced by CommandParser::CallHandler(), CommandParser::IsValidCommand(), ModuleOperLog::OnPreCommand(), and CommandParser::ProcessCommand(). { char* mycmd; char* savept; char* savept2; /* * users on remote servers can completely bypass all permissions based checks. * This prevents desyncs when one server has different type/class tags to another. * That having been said, this does open things up to the possibility of source changes * allowing remote kills, etc - but if they have access to the src, they most likely have * access to the conf - so it's an end to a means either way. */ if (!IS_LOCAL(this)) return true; // are they even an oper at all? if (IS_OPER(this)) { opertype_t::iterator iter_opertype = ServerInstance->Config->opertypes.find(this->oper); if (iter_opertype != ServerInstance->Config->opertypes.end()) { char* Classes = strdup(iter_opertype->second); char* myclass = strtok_r(Classes," ",&savept); while (myclass) { operclass_t::iterator iter_operclass = ServerInstance->Config->operclass.find(myclass); if (iter_operclass != ServerInstance->Config->operclass.end()) { char* CommandList = strdup(iter_operclass->second); mycmd = strtok_r(CommandList," ",&savept2); while (mycmd) { if ((!strcasecmp(mycmd,command.c_str())) || (*mycmd == '*')) { free(Classes); free(CommandList); return true; } mycmd = strtok_r(NULL," ",&savept2); } free(CommandList); } myclass = strtok_r(NULL," ",&savept); } free(Classes); } } return false; }

void userrec::InvalidateCache (   )

This clears any cached results that are used for GetFullRealHost() etc. The results of these calls are cached as generating them can be generally expensive. Definition at line 1171 of file users.cpp. References cached_fullhost, cached_fullrealhost, cached_hostip, and cached_makehost. Referenced by ChangeDisplayedHost(), ChangeIdent(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), ForceNickChange(), cmd_nick::Handle(), UserResolver::OnLookupComplete(), CGIResolver::OnLookupComplete(), ModuleCgiIRC::OnUserConnect(), and ~userrec(). { /* Invalidate cache */ if (cached_fullhost) free(cached_fullhost); if (cached_hostip) free(cached_hostip); if (cached_makehost) free(cached_makehost); if (cached_fullrealhost) free(cached_fullrealhost); cached_fullhost = cached_hostip = cached_makehost = cached_fullrealhost = NULL; }

void userrec::InviteTo (  const irc::string &  channel  )  [virtual]

Adds a channel to a users invite list (invites them to a channel). Parameters: channel  A channel name to add Definition at line 530 of file users.cpp. References invites. Referenced by cmd_invite::Handle(). { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (channel == *i) { return; } } invites.push_back(channel); }

bool userrec::IsInvited (  const irc::string &  channel  )  [virtual]

Returns true if a user is invited to a channel. Parameters: channel  A channel name to look up Returns: True if the user is invited to the given channel Definition at line 513 of file users.cpp. References invites. Referenced by cmd_uninvite::Handle(), chanrec::JoinUser(), and ModuleOverride::OnUserPreJoin(). { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (channel == *i) { return true; } } return false; }

bool userrec::IsModeSet (  unsigned char  m  )

Returns true if a specific mode is set. Parameters: m  The user mode Returns: True if the mode is set Definition at line 287 of file users.cpp. References modes. Referenced by InvisibleDeOper::BeforeMode(), CommandParser::CallHandler(), cmd_who::Handle(), cmd_oper::Handle(), CommandParser::IsValidCommand(), ModeHandler::ModeSet(), UserStripColor::OnModeChange(), SeeWhois::OnModeChange(), AUser_R::OnModeChange(), User_R::OnModeChange(), User_r::OnModeChange(), InvisibleMode::OnModeChange(), HideOper::OnModeChange(), HideChans::OnModeChange(), Helpop::OnModeChange(), User_d::OnModeChange(), PrivacyMode::OnModeChange(), CloakUser::OnModeChange(), CensorUser::OnModeChange(), BotMode::OnModeChange(), ModuleInvisible::OnUserJoin(), ModuleInvisible::OnUserPart(), ModuleServices::OnUserPostNick(), ModuleServices::OnUserPreJoin(), ModuleRegOnlyCreate::OnUserPreJoin(), ModuleStripColor::OnUserPreMessage(), ModuleServices::OnUserPreMessage(), ModulePrivacyMode::OnUserPreMessage(), ModuleInvisible::OnUserPreNotice(), ModuleInvisible::OnUserQuit(), ModuleShowwhois::OnWhois(), ModuleServices::OnWhois(), ModuleHelpop::OnWhois(), ModuleBotMode::OnWhois(), ModuleHideOper::OnWhoisLine(), ModuleHideChans::OnWhoisLine(), CommandParser::ProcessCommand(), ModeHandler::RemoveMode(), cmd_who::whomatch(), InspIRCd::WriteMode(), InspIRCd::WriteOpers(), SnomaskManager::WriteToSnoMask(), and WriteWallOps(). { return (modes[m-65]); }

bool userrec::IsNoticeMaskSet (  unsigned char  sm  )

Returns true if a notice mask is set. Parameters: sm  A notice mask character to check Returns: True if the notice mask is set Definition at line 260 of file users.cpp. References snomasks. Referenced by ProcessNoticeMasks(), and SnomaskManager::WriteToSnoMask(). { return (snomasks[sm-65]); }

unsigned long userrec::LocalCloneCount (   )

Return the number of local clones of this user. Returns: The local clone count of this user Definition at line 1001 of file users.cpp. References InspIRCd::local_clones, and ServerInstance. Referenced by CheckClass(). { clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString()); if (x != ServerInstance->local_clones.end()) return x->second; else return 0; }

char * userrec::MakeHost (   )

Creates a usermask with real host. Takes a buffer to use and fills the given buffer with the hostmask in the format user Returns: the usermask in the format user Definition at line 393 of file users.cpp. References cached_makehost, connection::host, ident, and MAXBUF. Referenced by ModuleSecureList::OnPreCommand(), and ModuleHostChange::OnUserConnect(). { if (this->cached_makehost) return this->cached_makehost; char nhost[MAXBUF]; /* This is much faster than snprintf */ char* t = nhost; for(char* n = ident; *n; n++) *t++ = *n; *t++ = '@'; for(char* n = host; *n; n++) *t++ = *n; *t = 0; this->cached_makehost = strdup(nhost); return this->cached_makehost; }

char * userrec::MakeHostIP (   )

Creates a usermask with real ip. Takes a buffer to use and fills the given buffer with the ipmask in the format user Returns: the usermask in the format user Definition at line 413 of file users.cpp. References cached_hostip, GetIPString(), ident, and MAXBUF. Referenced by FilterBase::OnPreCommand(), ModuleAntiBear::OnPreCommand(), ModuleHostChange::OnUserConnect(), ModuleBanRedirect::OnUserPreJoin(), and FilterBase::OnUserPreNotice(). { if (this->cached_hostip) return this->cached_hostip; char ihost[MAXBUF]; /* This is much faster than snprintf */ char* t = ihost; for(char* n = ident; *n; n++) *t++ = *n; *t++ = '@'; for(const char* n = this->GetIPString(); *n; n++) *t++ = *n; *t = 0; this->cached_hostip = strdup(ihost); return this->cached_hostip; }

char * userrec::MakeWildHost (   )

Creates a wildcard host. Takes a buffer to use and fills the given buffer with the host in the format *!* Returns: The wildcarded hostname in *!* form Definition at line 464 of file users.cpp. References dhost, and MAXBUF. { static char nresult[MAXBUF]; char* t = nresult; *t++ = '*'; *t++ = '!'; *t++ = '*'; *t++ = '@'; for(char* n = dhost; *n; n++) *t++ = *n; *t = 0; return nresult; }

void userrec::Oper (  const std::string &  opertype  )

Oper up the user using the given opertype. This will also give the +o usermode. Parameters: opertype  The oper type to oper as Definition at line 803 of file users.cpp. References InspIRCd::all_opers, DEBUG, DEFAULT, FOREACH_MOD, I_OnOper, I_OnPostOper, InspIRCd::Log(), modes, NICKMAX, ServerInstance, strlcpy(), UM_OPERATOR, and WriteServ(). Referenced by cmd_oper::Handle(), and ModuleSQLOper::OperUser(). { try { this->modes[UM_OPERATOR] = 1; this->WriteServ("MODE %s :+o", this->nick); FOREACH_MOD(I_OnOper, OnOper(this, opertype)); ServerInstance->Log(DEFAULT,"OPER: %s!%s@%s opered as type: %s", this->nick, this->ident, this->host, opertype.c_str()); strlcpy(this->oper, opertype.c_str(), NICKMAX - 1); ServerInstance->all_opers.push_back(this); FOREACH_MOD(I_OnPostOper,OnPostOper(this, opertype)); } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::Oper()"); } }

std::string userrec::ProcessNoticeMasks (  const char *  sm  )

Process a snomask modifier string, e.g. +abc-de Parameters: sm  A sequence of notice mask characters Returns: The cleaned mode sequence which can be output, e.g. in the above example if masks c and e are not valid, this function will return +ab-d Definition at line 82 of file users.cpp. References SnomaskManager::IsEnabled(), IsNoticeMaskSet(), ServerInstance, SetNoticeMask(), and InspIRCd::SNO. { bool adding = true, oldadding = false; const char *c = sm; std::string output; while (c && *c) { switch (*c) { case '+': adding = true; break; case '-': adding = false; break; case '*': for (unsigned char d = 'A'; d <= 'z'; d++) { if (ServerInstance->SNO->IsEnabled(d)) { if ((!IsNoticeMaskSet(d) && adding) || (IsNoticeMaskSet(d) && !adding)) { if ((oldadding != adding) || (!output.length())) output += (adding ? '+' : '-'); this->SetNoticeMask(d, adding); output += d; } } oldadding = adding; } break; default: if ((*c >= 'A') && (*c <= 'z') && (ServerInstance->SNO->IsEnabled(*c))) { if ((!IsNoticeMaskSet(*c) && adding) || (IsNoticeMaskSet(*c) && !adding)) { if ((oldadding != adding) || (!output.length())) output += (adding ? '+' : '-'); this->SetNoticeMask(*c, adding); output += *c; } } oldadding = adding; break; } *c++; } return output; }

void userrec::PurgeEmptyChannels (   )

Remove this user from all channels they are on, and delete any that are now empty. This is used by QUIT, and will not send part messages! Definition at line 1895 of file users.cpp. References InspIRCd::chanlist, chans, DEBUG, DELETE(), FOREACH_MOD, I_OnChannelDelete, InspIRCd::Log(), chanrec::name, ServerInstance, and UnOper(). Referenced by CullList::Apply(). { std::vector<chanrec*> to_delete; // firstly decrement the count on each channel for (UCListIter f = this->chans.begin(); f != this->chans.end(); f++) { f->first->RemoveAllPrefixes(this); if (f->first->DelUser(this) == 0) { /* No users left in here, mark it for deletion */ try { to_delete.push_back(f->first); } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::PurgeEmptyChannels to_delete.push_back()"); } } } for (std::vector<chanrec*>::iterator n = to_delete.begin(); n != to_delete.end(); n++) { chanrec* thischan = *n; chan_hash::iterator i2 = ServerInstance->chanlist->find(thischan->name); if (i2 != ServerInstance->chanlist->end()) { FOREACH_MOD(I_OnChannelDelete,OnChannelDelete(i2->second)); DELETE(i2->second); ServerInstance->chanlist->erase(i2); this->chans.erase(*n); } } this->UnOper(); }

void userrec::QuitUser (  InspIRCd *  Instance, userrec *  user, const std::string &  r, const char *  oreason = "" )  [static]

Disconnect a user gracefully. Parameters: user  The user to remove r  The quit reason to show to normal users oreason  The quit reason to show to opers Returns: Although this function has no return type, on exit the user provided will no longer exist. Definition at line 843 of file users.cpp. References CullList::AddItem(), InspIRCd::GlobalCulls, connection::host, ident, and Write(). Referenced by AddClient(), XLineManager::apply_lines(), CheckClass(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), InspIRCd::DoBackgroundUserStuff(), TreeSocket::ForceNick(), FullConnect(), cmd_saquit::Handle(), cmd_nicklock::Handle(), cmd_jumpserver::Handle(), cmd_close::Handle(), cmd_quit::Handle(), cmd_kill::Handle(), HandleEvent(), TreeSocket::IntroduceClient(), ModuleSSLOpenSSL::OnCleanup(), ModuleSSLGnuTLS::OnCleanup(), DNSBLResolver::OnLookupComplete(), ModuleWaitPong::OnPreCommand(), ModuleBlockAmsg::OnPreCommand(), ModuleSQLAuth::OnRequest(), ModuleCgiIRC::OnUserConnect(), FilterBase::OnUserPreNotice(), ModuleSQLAuth::OnUserRegister(), ModuleLockserv::OnUserRegister(), ModuleLDAPAuth::OnUserRegister(), ModuleJumpServer::OnUserRegister(), ModuleConnFlood::OnUserRegister(), TreeSocket::ProcessLine(), TreeServer::QuitUsers(), ModuleCgiIRC::Recheck(), and TreeSocket::RemoteKill(). { user->Write("ERROR :Closing link (%s@%s) [%s]", user->ident, user->host, *operreason ? operreason : quitreason.c_str()); Instance->GlobalCulls.AddItem(user, quitreason.c_str(), operreason); }

int userrec::ReadData (  void *  buffer, size_t  size )

Calls read() to read some data for this user using their fd. Parameters: buffer  The buffer to read into size  The size of data to read Returns: The number of bytes read, or -1 if an error occured. Definition at line 476 of file users.cpp. References IS_LOCAL. Referenced by ModuleXMLSocket::OnRawSocketRead(), and InspIRCd::ProcessUser(). { if (IS_LOCAL(this)) { #ifndef WIN32 return read(this->fd, buffer, size); #else return recv(this->fd, (char*)buffer, size, 0); #endif } else return 0; }

void userrec::RemoveCloneCounts (   )

Remove all clone counts from the user, you should use this if you change the user's IP address in userrec::ip after they have registered. Definition at line 348 of file users.cpp. References InspIRCd::global_clones, InspIRCd::local_clones, and ServerInstance. Referenced by ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), ModuleCgiIRC::OnUserConnect(), and ~userrec(). { clonemap::iterator x = ServerInstance->local_clones.find(this->GetIPString()); if (x != ServerInstance->local_clones.end()) { x->second--; if (!x->second) { ServerInstance->local_clones.erase(x); } } clonemap::iterator y = ServerInstance->global_clones.find(this->GetIPString()); if (y != ServerInstance->global_clones.end()) { y->second--; if (!y->second) { ServerInstance->global_clones.erase(y); } } }

void userrec::RemoveInvite (  const irc::string &  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. Parameters: channel  The channel to remove the invite to Definition at line 542 of file users.cpp. References invites. Referenced by cmd_uninvite::Handle(), and chanrec::JoinUser(). { for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) { if (channel == *i) { invites.erase(i); return; } } }

void userrec::SendAll (  const char *  command, char *  text,   ... )

Send a command to all local users from this user The command given must be able to send text with the first parameter as a servermask (e.g. $*), so basically you should use PRIVMSG or NOTICE. Parameters: command  the command to send text  The text format string to send ...  Format arguments Definition at line 1779 of file users.cpp. References InspIRCd::local_users, MAXBUF, and ServerInstance. Referenced by cmd_privmsg::Handle(), and cmd_notice::Handle(). { char textbuffer[MAXBUF]; char formatbuffer[MAXBUF]; va_list argsPtr; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); snprintf(formatbuffer,MAXBUF,":%s %s $* :%s", this->GetFullHost(), command, textbuffer); std::string fmt = formatbuffer; for (std::vector<userrec*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++) { (*i)->Write(fmt); } }

void userrec::SetMode (  unsigned char  m, bool  value )

Set a specific usermode to on or off. Parameters: m  The user mode value  On or off setting of the mode Definition at line 292 of file users.cpp. References modes. Referenced by UserStripColor::OnModeChange(), SeeWhois::OnModeChange(), AUser_R::OnModeChange(), User_R::OnModeChange(), User_r::OnModeChange(), InvisibleMode::OnModeChange(), HideOper::OnModeChange(), HideChans::OnModeChange(), Helpop::OnModeChange(), User_d::OnModeChange(), PrivacyMode::OnModeChange(), CloakUser::OnModeChange(), CensorUser::OnModeChange(), and BotMode::OnModeChange(). { modes[m-65] = value; }

void userrec::SetNoticeMask (  unsigned char  sm, bool  value )

Changed a specific notice mask value. Parameters: sm  The server notice mask to change value  An on/off value for this mask Definition at line 265 of file users.cpp. References snomasks. Referenced by ProcessNoticeMasks(). { snomasks[sm-65] = value; }

void userrec::SetOperQuit (  const std::string &  oquit  )

Set oper-specific quit message shown to opers only when the user quits (overrides any sent by QuitUser). Definition at line 2001 of file users.cpp. References operquitmsg. Referenced by ModuleSpanningTree::OnRemoteKill(), and TreeSocket::OperQuit(). { operquitmsg = oquit; }

void userrec::SetSockAddr (  int  protocol_family, const char *  ip, int  port )

Initialize the clients sockaddr. Parameters: protocol_family  The protocol family of the IP address, AF_INET or AF_INET6 ip  A human-readable IP address for this user matching the protcol_family port  The port number of this user or zero for a remote user Definition at line 1221 of file users.cpp. References DEBUG, InspIRCd::Log(), and ServerInstance. Referenced by AddClient(), ModuleCgiIRC::CheckIdent(), TreeSocket::IntroduceClient(), CGIResolver::OnLookupComplete(), and ModuleCgiIRC::OnUserConnect(). { switch (protocol_family) { #ifdef SUPPORT_IP6LINKS case AF_INET6: { sockaddr_in6* sin = new sockaddr_in6; sin->sin6_family = AF_INET6; sin->sin6_port = port; inet_pton(AF_INET6, ip, &sin->sin6_addr); this->ip = (sockaddr*)sin; } break; #endif case AF_INET: { sockaddr_in* sin = new sockaddr_in; sin->sin_family = AF_INET; sin->sin_port = port; inet_pton(AF_INET, ip, &sin->sin_addr); this->ip = (sockaddr*)sin; } break; default: ServerInstance->Log(DEBUG,"Ut oh, I dont know protocol %d to be set on '%s'!", protocol_family, this->nick); break; } }

void userrec::SetWriteError (  const std::string &  error  )

Sets the write error for a connection. This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged. Parameters: error  The error string to set. Definition at line 783 of file users.cpp. References DEBUG, InspIRCd::Log(), ServerInstance, and WriteError. Referenced by AddBuffer(), AddWriteBuf(), InspIRCd::FloodQuitUser(), FlushWriteBuf(), HandleEvent(), FilterBase::OnPreCommand(), and InspIRCd::ProcessUser(). { try { // don't try to set the error twice, its already set take the first string. if (this->WriteError.empty()) this->WriteError = error; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::SetWriteError()"); } }

bool userrec::SharesChannelWith (  userrec *  other  )

Return true if the user shares at least one channel with another user. Parameters: other  The other user to compare the channel list against Returns: True if the given user shares at least one channel with this user Definition at line 1680 of file users.cpp. References chans, REG_ALL, and connection::registered. Referenced by cmd_who::Handle(), and ModulePrivacyMode::OnUserPreMessage(). { if ((!other) || (this->registered != REG_ALL) || (other->registered != REG_ALL)) return false; /* Outer loop */ for (UCListIter i = this->chans.begin(); i != this->chans.end(); i++) { /* Eliminate the inner loop (which used to be ~equal in size to the outer loop) * by replacing it with a map::find which *should* be more efficient */ if (i->first->HasUser(other)) return true; } return false; }

void userrec::ShowMOTD (   )

Show the message of the day to this user. Definition at line 1933 of file users.cpp. References InspIRCd::Config, ServerConfig::MOTD, ServerInstance, ServerConfig::ServerName, and WriteServ(). Referenced by FullConnect(), and cmd_motd::Handle(). { if (!ServerInstance->Config->MOTD.size()) { this->WriteServ("422 %s :Message of the day file is missing.",this->nick); return; } this->WriteServ("375 %s :%s message of the day", this->nick, ServerInstance->Config->ServerName); for (file_cache::iterator i = ServerInstance->Config->MOTD.begin(); i != ServerInstance->Config->MOTD.end(); i++) this->WriteServ("372 %s :- %s",this->nick,i->c_str()); this->WriteServ("376 %s :End of message of the day.", this->nick); }

void userrec::ShowRULES (   )

Show the server RULES file to this user. Definition at line 1948 of file users.cpp. References InspIRCd::Config, ServerConfig::RULES, ServerInstance, ServerConfig::ServerName, and WriteServ(). Referenced by cmd_rules::Handle(). { if (!ServerInstance->Config->RULES.size()) { this->WriteServ("NOTICE %s :Rules file is missing.",this->nick); return; } this->WriteServ("NOTICE %s :%s rules",this->nick,ServerInstance->Config->ServerName); for (file_cache::iterator i = ServerInstance->Config->RULES.begin(); i != ServerInstance->Config->RULES.end(); i++) this->WriteServ("NOTICE %s :%s",this->nick,i->c_str()); this->WriteServ("NOTICE %s :End of %s rules.",this->nick,ServerInstance->Config->ServerName); }

void userrec::SplitChanList (  userrec *  dest, const std::string &  cl )

Split the channel list in cl which came from dest, and spool it to this user Used internally by WHOIS. Parameters: dest  The user the original channel list came from cl  The channel list as a string obtained from userrec::ChannelList() Definition at line 1824 of file users.cpp. References InspIRCd::Config, DEBUG, InspIRCd::Log(), nick, prefix, InspIRCd::SendWhoisLine(), ServerInstance, and ServerConfig::ServerName. { std::string line; std::ostringstream prefix; std::string::size_type start, pos, length; try { prefix << this->nick << " " << dest->nick << " :"; line = prefix.str(); int namelen = strlen(ServerInstance->Config->ServerName) + 6; for (start = 0; (pos = cl.find(' ', start)) != std::string::npos; start = pos+1) { length = (pos == std::string::npos) ? cl.length() : pos; if (line.length() + namelen + length - start > 510) { ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str()); line = prefix.str(); } if(pos == std::string::npos) { line.append(cl.substr(start, length - start)); break; } else { line.append(cl.substr(start, length - start + 1)); } } if (line.length()) { ServerInstance->SendWhoisLine(this, dest, 319, "%s", line.c_str()); } } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::SplitChanList()"); } }

void userrec::StartDNSLookup (   )

Starts a DNS lookup of the user's IP. This will cause two UserResolver classes to be instantiated. When complete, these objects set userrec::dns_done to true. Definition at line 139 of file users.cpp. References InspIRCd::AddResolver(), DEBUG, DNS_QUERY_PTR4, DNS_QUERY_PTR6, GetIPString(), CoreException::GetReason(), ip, InspIRCd::Log(), res_reverse, and ServerInstance. { try { bool cached; const char* ip = this->GetIPString(); /* Special case for 4in6 (Have i mentioned i HATE 4in6?) */ if (!strncmp(ip, "0::ffff:", 8)) res_reverse = new UserResolver(this->ServerInstance, this, ip + 8, DNS_QUERY_PTR4, cached); else res_reverse = new UserResolver(this->ServerInstance, this, ip, this->GetProtocolFamily() == AF_INET ? DNS_QUERY_PTR4 : DNS_QUERY_PTR6, cached); this->ServerInstance->AddResolver(res_reverse, cached); } catch (CoreException& e) { ServerInstance->Log(DEBUG,"Error in resolver: %s",e.GetReason()); } }

void userrec::UnOper (   )

Oper down. This will clear the +o usermode and unset the user's oper type Definition at line 822 of file users.cpp. References InspIRCd::all_opers, DEBUG, IS_OPER, InspIRCd::Log(), modes, oper, ServerInstance, and UM_OPERATOR. Referenced by PurgeEmptyChannels(). { try { if (IS_OPER(this)) { // unset their oper type (what IS_OPER checks), and remove +o *this->oper = 0; this->modes[UM_OPERATOR] = 0; // remove the user from the oper list. Will remove multiple entries as a safeguard against bug #404 ServerInstance->all_opers.remove(this); } } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::UnOper()"); } }

userrec * userrec::UpdateNickHash (  const char *  New  )

Change this users hash key to a new string. You should not call this function directly. It is used by the core to update the users hash entry on a nickchange. Parameters: New  new user_hash key Returns: Pointer to userrec in hash (usually 'this') Definition at line 1145 of file users.cpp. References InspIRCd::clientlist, DEBUG, InspIRCd::Log(), and ServerInstance. Referenced by cmd_nick::Handle(). { try { //user_hash::iterator newnick; user_hash::iterator oldnick = ServerInstance->clientlist->find(this->nick); if (!strcasecmp(this->nick,New)) return oldnick->second; if (oldnick == ServerInstance->clientlist->end()) return NULL; /* doesnt exist */ userrec* olduser = oldnick->second; (*(ServerInstance->clientlist))[New] = olduser; ServerInstance->clientlist->erase(oldnick); return olduser; } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::UpdateNickHash()"); return NULL; } }

void userrec::Write (  const char *  text,   ... )

Write text to this user, appending CR/LF. Parameters: text  The format string for text to send to the user ...  POD-type format arguments Definition at line 1423 of file users.cpp. References MAXBUF, and Write(). { va_list argsPtr; char textbuffer[MAXBUF]; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->Write(std::string(textbuffer)); }

void userrec::Write (  std::string  text  )

Write text to this user, appending CR/LF. Parameters: text  A std::string to send to the user Definition at line 1375 of file users.cpp. References AddWriteBuf(), InspIRCd::Config, DEBUG, ServerConfig::GetIOHook(), CoreException::GetReason(), CoreException::GetSource(), InspIRCd::Log(), MAX_DESCRIPTORS, Module::OnRawSocketWrite(), InspIRCd::SE, ServerInstance, InspIRCd::stats, serverstats::statsSent, and SocketEngine::WantWrite(). Referenced by InspIRCd::DoBackgroundUserStuff(), cmd_alltime::Handle(), cmd_stats::Handle(), cmd_kill::Handle(), ModuleWaitPong::OnUserRegister(), TreeSocket::Push(), QuitUser(), TreeSocket::RemoteKill(), Write(), WriteCommon(), WriteFrom(), and WriteServ(). { #ifdef WINDOWS if ((this->fd < 0) || (this->m_internalFd > MAX_DESCRIPTORS)) #else if ((this->fd < 0) || (this->fd > MAX_DESCRIPTORS)) #endif return; try { /* ServerInstance->Log(DEBUG,"C[%d] <- %s", this->GetFd(), text.c_str()); * WARNING: The above debug line is VERY loud, do NOT * enable it till we have a good way of filtering it * out of the logs (e.g. 1.2 would be good). */ text.append("\r\n"); } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::Write() std::string::append"); return; } if (ServerInstance->Config->GetIOHook(this->GetPort())) { try { /* XXX: The lack of buffering here is NOT a bug, modules implementing this interface have to * implement their own buffering mechanisms */ ServerInstance->Config->GetIOHook(this->GetPort())->OnRawSocketWrite(this->fd, text.data(), text.length()); } catch (CoreException& modexcept) { ServerInstance->Log(DEBUG, "%s threw an exception: %s", modexcept.GetSource(), modexcept.GetReason()); } } else { this->AddWriteBuf(text); } ServerInstance->stats->statsSent += text.length(); this->ServerInstance->SE->WantWrite(this); }

void userrec::WriteCommon (  const char *  text,   ... )

Write to all users that can see this user (including this user in the list), appending CR/LF. Parameters: text  The format string for text to send to the users ...  POD-type format arguments Definition at line 1504 of file users.cpp. References MAXBUF, REG_ALL, and WriteCommon(). { char textbuffer[MAXBUF]; va_list argsPtr; if (this->registered != REG_ALL) return; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->WriteCommon(std::string(textbuffer)); }

void userrec::WriteCommon (  const std::string &  text  )

Write to all users that can see this user (including this user in the list), appending CR/LF. Parameters: text  A std::string to send to the users Definition at line 1519 of file users.cpp. References already_sent, chans, DEBUG, IS_LOCAL, InspIRCd::Log(), MAXBUF, REG_ALL, ServerInstance, uniq_id, and Write(). Referenced by cmd_nick::Handle(), and WriteCommon(). { try { bool sent_to_at_least_one = false; char tb[MAXBUF]; if (this->registered != REG_ALL) return; uniq_id++; /* We dont want to be doing this n times, just once */ snprintf(tb,MAXBUF,":%s %s",this->GetFullHost(),text.c_str()); std::string out = tb; for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++) { CUList* ulist = v->first->GetUsers(); for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++) { if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id)) { already_sent[i->first->fd] = uniq_id; i->first->Write(out); sent_to_at_least_one = true; } } } /* * if the user was not in any channels, no users will receive the text. Make sure the user * receives their OWN message for WriteCommon */ if (!sent_to_at_least_one) { this->Write(std::string(tb)); } } catch (...) { ServerInstance->Log(DEBUG,"Exception in userrec::WriteCommon()"); } }

void userrec::WriteCommonExcept (  const std::string &  text  )

Write to all users that can see this user (not including this user in the list), appending CR/LF. Parameters: text  A std::string to send to the users Definition at line 1613 of file users.cpp. References already_sent, chans, IS_LOCAL, MAXBUF, REG_ALL, and uniq_id. { char tb1[MAXBUF]; std::string out1; if (this->registered != REG_ALL) return; uniq_id++; snprintf(tb1,MAXBUF,":%s %s",this->GetFullHost(),text.c_str()); out1 = tb1; for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++) { CUList *ulist = v->first->GetUsers(); for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++) { if (this != i->first) { if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id)) { already_sent[i->first->fd] = uniq_id; i->first->Write(out1); } } } } }

void userrec::WriteCommonExcept (  const char *  text,   ... )

Write to all users that can see this user (not including this user in the list), appending CR/LF. Parameters: text  The format string for text to send to the users ...  POD-type format arguments Definition at line 1570 of file users.cpp. References MAXBUF. Referenced by ChangeDisplayedHost(), and ChangeIdent(). { char textbuffer[MAXBUF]; va_list argsPtr; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->WriteCommonExcept(std::string(textbuffer)); }

void userrec::WriteCommonQuit (  const std::string &  normal_text, const std::string &  oper_text )

Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific quit message for opers only. Parameters: normal_text  Normal user quit message oper_text  Oper only quit message Definition at line 1582 of file users.cpp. References already_sent, chans, IS_LOCAL, IS_OPER, MAXBUF, REG_ALL, and uniq_id. Referenced by CullList::Apply(). { char tb1[MAXBUF]; char tb2[MAXBUF]; if (this->registered != REG_ALL) return; uniq_id++; snprintf(tb1,MAXBUF,":%s QUIT :%s",this->GetFullHost(),normal_text.c_str()); snprintf(tb2,MAXBUF,":%s QUIT :%s",this->GetFullHost(),oper_text.c_str()); std::string out1 = tb1; std::string out2 = tb2; for (UCListIter v = this->chans.begin(); v != this->chans.end(); v++) { CUList *ulist = v->first->GetUsers(); for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++) { if (this != i->first) { if ((IS_LOCAL(i->first)) && (already_sent[i->first->fd] != uniq_id)) { already_sent[i->first->fd] = uniq_id; i->first->Write(IS_OPER(i->first) ? out2 : out1); } } } } }

void userrec::WriteFrom (  userrec *  user, const char *  text,   ... )

Write text to this user, appending CR/LF and prepending :nick!user of the user provided in the first parameter. Parameters: user  The user to prepend the :nick!user of text  The format string for text to send to the user ...  POD-type format arguments Definition at line 1471 of file users.cpp. References MAXBUF, and WriteFrom(). { va_list argsPtr; char textbuffer[MAXBUF]; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->WriteFrom(user, std::string(textbuffer)); }

void userrec::WriteFrom (  userrec *  user, const std::string &  text )

Write text to this user, appending CR/LF and prepending :nick!user of the user provided in the first parameter. Parameters: user  The user to prepend the :nick!user of text  A std::string to send to the user Definition at line 1459 of file users.cpp. References GetFullHost(), MAXBUF, and Write(). Referenced by cmd_invite::Handle(), ModuleAuditorium::OnUserJoin(), ModuleAuditorium::OnUserKick(), ModuleAuditorium::OnUserPart(), WriteFrom(), and WriteTo(). { char tb[MAXBUF]; snprintf(tb,MAXBUF,":%s %s",user->GetFullHost(),text.c_str()); this->Write(std::string(tb)); }

void userrec::WriteServ (  const char *  text,   ... )

Write text to this user, appending CR/LF and prepending :server.name. Parameters: text  The format string for text to send to the user ...  POD-type format arguments Definition at line 1446 of file users.cpp. References MAXBUF, and WriteServ(). { va_list argsPtr; char textbuffer[MAXBUF]; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->WriteServ(std::string(textbuffer)); }

void userrec::WriteServ (  const std::string &  text  )

Write text to this user, appending CR/LF and prepending :server.name. Parameters: text  A std::string to send to the user Definition at line 1435 of file users.cpp. References InspIRCd::Config, MAXBUF, ServerInstance, ServerConfig::ServerName, and Write(). Referenced by cmd_watch::add_watch(), AddClient(), XLineManager::apply_lines(), BanRedirect::BeforeMode(), ChangeDisplayedHost(), ModeParser::DisplayCurrentModes(), cmd_dccallow::DisplayDCCAllowList(), ListModeBase::DisplayEmptyList(), cmd_dccallow::DisplayHelp(), ListModeBase::DisplayList(), FounderProtectBase::DisplayList(), InspIRCd::DoBackgroundUserStuff(), InspIRCd::DumpText(), ModuleDCCAllow::Expire(), FullConnect(), cmd_rsquit::Handle(), cmd_rconnect::Handle(), cmd_watch::Handle(), cmd_vhost::Handle(), cmd_userip::Handle(), cmd_uninvite::Handle(), cmd_tline::Handle(), cmd_tban::Handle(), cmd_dalinfo::Handle(), cmd_taxonomy::Handle(), cmd_swhois::Handle(), cmd_svshold::Handle(), cmd_sslinfo::Handle(), cmd_fingerprint::Handle(), cmd_spynames::Handle(), cmd_spylist::Handle(), cmd_silence::Handle(), cmd_setname::Handle(), cmd_setidle::Handle(), cmd_setident::Handle(), cmd_sethost::Handle(), cmd_saquit::Handle(), cmd_sapart::Handle(), cmd_sanick::Handle(), cmd_samode::Handle(), cmd_sajoin::Handle(), RemoveBase::Handle(), cmd_randquote::Handle(), cmd_nickunlock::Handle(), cmd_nicklock::Handle(), cmd_unlockserv::Handle(), cmd_lockserv::Handle(), cmd_knock::Handle(), cmd_jumpserver::Handle(), cmd_helpop::Handle(), cmd_greloadmodule::Handle(), cmd_gunloadmodule::Handle(), cmd_gloadmodule::Handle(), cmd_filter::Handle(), cmd_dccallow::Handle(), cmd_cycle::Handle(), cmd_title::Handle(), cmd_close::Handle(), cmd_clones::Handle(), cmd_chgname::Handle(), cmd_chgident::Handle(), cmd_chghost::Handle(), cmd_check::Handle(), cmd_cban::Handle(), cmd_reload::Handle(), cmd_zline::Handle(), cmd_whowas::Handle(), cmd_whois::Handle(), cmd_who::Handle(), cmd_version::Handle(), cmd_users::Handle(), cmd_userhost::Handle(), cmd_user::Handle(), cmd_unloadmodule::Handle(), cmd_trace::Handle(), cmd_topic::Handle(), cmd_time::Handle(), cmd_summon::Handle(), cmd_squit::Handle(), cmd_server::Handle(), cmd_reloadmodule::Handle(), cmd_rehash::Handle(), cmd_qline::Handle(), cmd_privmsg::Handle(), cmd_ping::Handle(), cmd_pass::Handle(), cmd_part::Handle(), cmd_oper::Handle(), cmd_notice::Handle(), cmd_nick::Handle(), cmd_names::Handle(), cmd_modules::Handle(), cmd_map::Handle(), cmd_lusers::Handle(), cmd_loadmodule::Handle(), cmd_list::Handle(), cmd_links::Handle(), cmd_kline::Handle(), cmd_kill::Handle(), cmd_kick::Handle(), cmd_join::Handle(), cmd_ison::Handle(), cmd_invite::Handle(), cmd_info::Handle(), cmd_gline::Handle(), cmd_eline::Handle(), cmd_connect::Handle(), cmd_commands::Handle(), cmd_clearcache::Handle(), cmd_away::Handle(), cmd_admin::Handle(), ModuleSpanningTree::HandleAdmin(), ModuleSpanningTree::HandleLinks(), ModuleSafeList::HandleList(), ModuleSpanningTree::HandleLusers(), ModuleSpanningTree::HandleMap(), ModuleSpanningTree::HandleModules(), ModuleSpanningTree::HandleMotd(), ModuleSpanningTree::HandleRemoteWhois(), ModuleSpanningTree::HandleSquit(), ModuleSpanningTree::HandleStats(), ModuleSpanningTree::HandleTime(), ModuleSpanningTree::HandleVersion(), chanrec::JoinUser(), chanrec::KickUser(), TreeSocket::LocalPong(), cmd_mkpasswd::MakeHash(), cmd_rsquit::NoticeUser(), ModuleNoKicks::OnAccessCheck(), ModuleChanProtect::OnAccessCheck(), ModuleSafeList::OnBufferFlushed(), ModuleIdent::OnCheckReady(), UserResolver::OnError(), ModuleOperLevels::OnKill(), UserResolver::OnLookupComplete(), ListModeBase::OnModeChange(), SSLMode::OnModeChange(), User_r::OnModeChange(), Channel_r::OnModeChange(), Redirect::OnModeChange(), NickFlood::OnModeChange(), MsgFlood::OnModeChange(), JoinFlood::OnModeChange(), InvisibleMode::OnModeChange(), User_d::OnModeChange(), AuditoriumMode::OnModeChange(), ModuleChanProtect::OnPostJoin(), ModuleOperSSLCert::OnPreCommand(), ModuleSecureList::OnPreCommand(), FilterBase::OnPreCommand(), ModuleBlockAmsg::OnPreCommand(), ModuleAlias::OnPreCommand(), ModuleHostChange::OnUserConnect(), ModuleAuditorium::OnUserList(), ModuleNoInvite::OnUserPreInvite(), ModuleSSLModes::OnUserPreJoin(), ModuleServicesAccount::OnUserPreJoin(), ModuleServices::OnUserPreJoin(), ModuleRestrictChans::OnUserPreJoin(), ModuleRegOnlyCreate::OnUserPreJoin(), ModuleRedirect::OnUserPreJoin(), ModuleOperChans::OnUserPreJoin(), ModuleKickNoRejoin::OnUserPreJoin(), ModuleJoinFlood::OnUserPreJoin(), ModuleCBan::OnUserPreJoin(), ModuleBanRedirect::OnUserPreJoin(), ModuleServicesAccount::OnUserPreMessage(), ModuleServices::OnUserPreMessage(), ModuleRestrictMsg::OnUserPreMessage(), ModulePrivacyMode::OnUserPreMessage(), ModuleCensor::OnUserPreMessage(), ModuleBlockColour::OnUserPreMessage(), ModuleBlockCAPS::OnUserPreMessage(), ModuleSVSHold::OnUserPreNick(), ModuleNoNickChange::OnUserPreNick(), ModuleNickLock::OnUserPreNick(), ModuleNickFlood::OnUserPreNick(), ModuleNoNotice::OnUserPreNotice(), ModuleNoCTCP::OnUserPreNotice(), ModuleInvisible::OnUserPreNotice(), FilterBase::OnUserPreNotice(), ModuleDCCAllow::OnUserPreNotice(), ModuleJumpServer::OnUserRegister(), ModuleIdent::OnUserRegister(), ModuleWaitPong::OnUserRegister(), ModuleAntiBear::OnUserRegister(), ModuleShowwhois::OnWhois(), Oper(), ModuleSQLOper::OperUser(), ModeParser::Process(), CommandParser::ProcessCommand(), ModuleChanFilter::ProcessMessages(), InspIRCd::ProcessUser(), ModuleTaxonomy::ProtoSendMetaData(), ServerConfig::Read(), ModuleCgiIRC::Recheck(), ModuleSpanningTree::RemoteMessage(), cmd_watch::remove_watch(), ModuleDCCAllow::RemoveNick(), ServerConfig::ReportConfigError(), ModeParser::SanityChecks(), ServerConfig::Send005(), InspIRCd::SendWhoisLine(), InspIRCd::ServerNoticeAll(), InspIRCd::ServerPrivmsgAll(), ModuleSpanningTree::ShowLinks(), ShowMOTD(), ShowOperMOTD(), ShowRULES(), spy_userlist(), ChanFilter::TellAlreadyOnList(), ChanFilter::TellListTooLong(), ChanFilter::TellNotSet(), TreeSocket::Time(), cmd_filter::TooFewParams(), chanrec::UserList(), ChanFilter::ValidateParam(), InspIRCd::WriteMode(), InspIRCd::WriteOpers(), WriteServ(), and SnomaskManager::WriteToSnoMask(). { char textbuffer[MAXBUF]; snprintf(textbuffer,MAXBUF,":%s %s",ServerInstance->Config->ServerName,text.c_str()); this->Write(std::string(textbuffer)); }

void userrec::WriteTo (  userrec *  dest, const char *  data,   ... )

Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user. Parameters: dest  The user to route the message to text  The format string for text to send to the user ...  POD-type format arguments Definition at line 1486 of file users.cpp. References MAXBUF, and WriteTo(). { char textbuffer[MAXBUF]; va_list argsPtr; va_start(argsPtr, data); vsnprintf(textbuffer, MAXBUF, data, argsPtr); va_end(argsPtr); this->WriteTo(dest, std::string(textbuffer)); }

void userrec::WriteTo (  userrec *  dest, const std::string &  data )

Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user. Parameters: dest  The user to route the message to text  A std::string to send to the user Definition at line 1498 of file users.cpp. References WriteFrom(). Referenced by cmd_privmsg::Handle(), cmd_notice::Handle(), cmd_nick::Handle(), ModeParser::Process(), WriteTo(), and WriteWallOps(). { dest->WriteFrom(this, data); }

void userrec::WriteWallOps (  const std::string &  text  )

Write a WALLOPS message from this user to all local opers. If this user is not opered, the function will return without doing anything. Parameters: text  The text to send in the WALLOPS message Definition at line 1643 of file users.cpp. References IsModeSet(), InspIRCd::local_users, ServerInstance, and WriteTo(). { std::string wallop("WALLOPS :"); wallop.append(text); for (std::vector<userrec*>::const_iterator i = ServerInstance->local_users.begin(); i != ServerInstance->local_users.end(); i++) { userrec* t = *i; if (t->IsModeSet('w')) this->WriteTo(t,wallop); } }

void userrec::WriteWallOps (  const char *  text,   ... )

Write a WALLOPS message from this user to all local opers. If this user is not opered, the function will return without doing anything. Parameters: text  The format string to send in the WALLOPS message ...  Format arguments Definition at line 1656 of file users.cpp. References MAXBUF. Referenced by cmd_wallops::Handle(). { char textbuffer[MAXBUF]; va_list argsPtr; va_start(argsPtr, text); vsnprintf(textbuffer, MAXBUF, text, argsPtr); va_end(argsPtr); this->WriteWallOps(std::string(textbuffer)); }

---

Member Data Documentation

char userrec::awaymsg[MAXAWAY+1]

The user's away message. If this string is empty, the user is not marked as away. Definition at line 445 of file users.h. Referenced by do_whois(), cmd_check::Handle(), cmd_privmsg::Handle(), cmd_away::Handle(), ModuleSpanningTree::OnSetAway(), userrec(), and cmd_who::whomatch().

char* userrec::cached_fullhost [private]

Cached nick!ident value using the real hostname. Definition at line 350 of file users.h. Referenced by GetFullHost(), InvalidateCache(), and userrec().

char* userrec::cached_fullrealhost [private]

Cached nick!ident value using the real hostname. Definition at line 362 of file users.h. Referenced by GetFullRealHost(), InvalidateCache(), and userrec().

char* userrec::cached_hostip [private]

Cached nick!ident value using the real IP address. Definition at line 354 of file users.h. Referenced by InvalidateCache(), MakeHostIP(), and userrec().

char* userrec::cached_makehost [private]

Cached nick!ident value using the masked hostname. Definition at line 358 of file users.h. Referenced by InvalidateCache(), MakeHost(), and userrec().

unsigned int userrec::ChannelCount [private]

Number of channels this user is currently on. Definition at line 346 of file users.h. Referenced by userrec().

UserChanList userrec::chans

Channels this user is on, and the permissions they have there. Definition at line 436 of file users.h. Referenced by ChangeDisplayedHost(), ChangeIdent(), ChannelList(), chanrec::ForceChan(), getlastchanname(), chanrec::GetStatus(), chanrec::GetStatusFlags(), ModeParser::Grant(), chanrec::JoinUser(), chanrec::KickUser(), ModuleBlockAmsg::OnPreCommand(), ModuleRestrictBanned::OnUserPreNick(), ModuleNoNickChange::OnUserPreNick(), ModuleNickFlood::OnUserPreNick(), ModuleInvisible::OnUserQuit(), ModuleHttpStats::OnUserQuit(), ModuleAuditorium::OnUserQuit(), chanrec::PartUser(), PurgeEmptyChannels(), ModeParser::Revoke(), chanrec::ServerKickUser(), SharesChannelWith(), userrec(), WriteCommon(), WriteCommonExcept(), and WriteCommonQuit().

char userrec::dhost[65]

The host displayed to non-opers (used for cloaking etc). This usually matches the value of userrec::host. Definition at line 412 of file users.h. Referenced by cmd_watch::add_watch(), AddClient(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), do_whois(), ModuleAlias::DoCommand(), DoStats(), GetFullHost(), cmd_sethost::Handle(), cmd_dccallow::Handle(), cmd_chghost::Handle(), cmd_userhost::Handle(), cmd_die::Handle(), TreeSocket::IntroduceClient(), MakeWildHost(), CGIResolver::OnLookupComplete(), Modulewatch::OnPostConnect(), ModuleSpanningTree::OnUserConnect(), ModuleCgiIRC::OnUserConnect(), Modulewatch::OnUserPostNick(), ModuleDCCAllow::OnUserPreNotice(), Modulewatch::OnUserQuit(), cmd_who::SendWhoLine(), userrec(), cmd_who::whomatch(), and WhoWasGroup::WhoWasGroup().

bool userrec::dns_done

True when DNS lookups are completed. The UserResolver classes res_forward and res_reverse will set this value once they complete. Definition at line 470 of file users.h. Referenced by InspIRCd::DoBackgroundUserStuff(), UserResolver::OnError(), UserResolver::OnLookupComplete(), and userrec().

bool userrec::exempt

This is true if the user matched an exception when they connected to the ircd. It isnt valid after this point, and you should not attempt to do anything with it after this point, because the eline might be removed at a later time, and/or no longer be applicable to this user. It is only used to save doing the eline lookup twice (instead we do it once and set this value). Definition at line 577 of file users.h. Referenced by AddClient(), FullConnect(), ModuleCgiIRC::Recheck(), 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 451 of file users.h. Referenced by CheckClass(), InspIRCd::ProcessUser(), and userrec().

char userrec::fullname[MAXGECOS+1]

The users full name (GECOS). Definition at line 416 of file users.h. Referenced by do_whois(), FullConnect(), cmd_chgname::Handle(), cmd_check::Handle(), cmd_user::Handle(), TreeSocket::IntroduceClient(), ModuleSpanningTree::OnUserConnect(), userrec(), cmd_who::whomatch(), and WhoWasGroup::WhoWasGroup().

char userrec::ident[IDENTMAX+2]

The users ident reply. Two characters are added to the user-defined limit to compensate for the tilde etc. Definition at line 407 of file users.h. Referenced by cmd_watch::add_watch(), AddClient(), ModuleSQLAuth::CheckCredentials(), ModuleLDAPAuth::CheckCredentials(), ModuleCgiIRC::CheckIdent(), do_whois(), ModuleAlias::DoCommand(), DoStats(), InspIRCd::FloodQuitUser(), FullConnect(), GetFullHost(), GetFullRealHost(), cmd_userip::Handle(), cmd_setident::Handle(), cmd_dccallow::Handle(), cmd_title::Handle(), cmd_chgident::Handle(), cmd_userhost::Handle(), cmd_user::Handle(), cmd_restart::Handle(), cmd_oper::Handle(), cmd_nick::Handle(), cmd_kill::Handle(), cmd_die::Handle(), TreeSocket::IntroduceClient(), chanrec::IsBanned(), MakeHost(), MakeHostIP(), XLineManager::matches_exception(), XLineManager::matches_gline(), XLineManager::matches_kline(), ModuleBanException::OnCheckBan(), ModuleInviteException::OnCheckInvite(), ModuleIdent::OnCheckReady(), CGIResolver::OnLookupComplete(), Modulewatch::OnPostConnect(), ModuleOperSSLCert::OnPreCommand(), ModuleOperLog::OnPreCommand(), ModuleSQLAuth::OnRequest(), ModuleInviteException::OnRequest(), ModuleBanException::OnRequest(), ModuleSpanningTree::OnStats(), ModuleSpanningTree::OnUserConnect(), ModuleChanCreate::OnUserJoin(), Modulewatch::OnUserPostNick(), ModuleDCCAllow::OnUserPreNotice(), Modulewatch::OnUserQuit(), ModuleIdent::OnUserRegister(), ModuleShowwhois::OnWhois(), ModuleSQLOper::OperUser(), QuitUser(), cmd_who::SendWhoLine(), userrec(), cmd_who::whomatch(), and WhoWasGroup::WhoWasGroup().

InvitedList userrec::invites [private]

A list of channels the user has a pending invite to. Upon INVITE channels are added, and upon JOIN, the channels are removed from this list. Definition at line 342 of file users.h. Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec().

sockaddr* userrec::ip

IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/ GetIPString/GetPort to obtain its values. Definition at line 527 of file users.h. Referenced by ModuleCgiIRC::CheckPass(), GetIPString(), GetPort(), GetProtocolFamily(), StartDNSLookup(), userrec(), and ~userrec().

int userrec::lines_in

Flood counters - lines received. Definition at line 495 of file users.h. Referenced by InspIRCd::ProcessUser(), and userrec().

char userrec::modes[64]

The user's mode list. This is NOT a null terminated string! In the 1.1 version of InspIRCd this is an array of values in a similar way to channel modes. A value of 1 in field (modeletter-65) indicates that the mode is set, for example, to work out if mode +s is set, we check the field userrec::modes['s'-65] != 0. The following RFC characters o, w, s, i have constants defined via an enum, such as UM_SERVERNOTICE and UM_OPETATOR. Definition at line 427 of file users.h. Referenced by DecrementModes(), FormatModes(), IsModeSet(), ModuleCBan::OnUserPreJoin(), ModuleServicesAccount::OnUserPreMessage(), Oper(), ModuleSQLOper::OperUser(), SetMode(), UnOper(), and userrec().

char userrec::nick[NICKMAX]

The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command. Use InspIRCd::IsNick() to validate nicknames. Definition at line 402 of file users.h. Referenced by cmd_watch::add_watch(), AddClient(), chanrec::AddHalfoppedUser(), chanrec::AddOppedUser(), cmd_whowas::AddToWhoWas(), chanrec::AddUser(), chanrec::AddVoicedUser(), TreeSocket::Admin(), CullList::Apply(), XLineManager::apply_lines(), InvisibleDeOper::BeforeMode(), BanRedirect::BeforeMode(), ModuleSQLAuth::CheckCredentials(), ModuleLDAPAuth::CheckCredentials(), ModuleCgiIRC::CheckIdent(), ModuleCgiIRC::CheckPass(), ModeParser::DisplayCurrentModes(), cmd_dccallow::DisplayDCCAllowList(), ListModeBase::DisplayEmptyList(), cmd_dccallow::DisplayHelp(), ListModeBase::DisplayList(), FounderProtectBase::DisplayList(), do_whois(), ModuleAlias::DoCommand(), DoStats(), ModuleDCCAllow::Expire(), InspIRCd::FloodQuitUser(), chanrec::ForceChan(), TreeSocket::ForceJoin(), FullConnect(), GetFullHost(), GetFullRealHost(), ModeParser::Grant(), cmd_rsquit::Handle(), cmd_rconnect::Handle(), cmd_watch::Handle(), cmd_vhost::Handle(), cmd_userip::Handle(), cmd_uninvite::Handle(), cmd_tline::Handle(), cmd_tban::Handle(), cmd_dalinfo::Handle(), cmd_taxonomy::Handle(), cmd_swhois::Handle(), cmd_svshold::Handle(), cmd_sslinfo::Handle(), cmd_fingerprint::Handle(), cmd_spynames::Handle(), cmd_spylist::Handle(), cmd_silence::Handle(), cmd_setname::Handle(), cmd_setidle::Handle(), cmd_setident::Handle(), cmd_sethost::Handle(), cmd_saquit::Handle(), cmd_sapart::Handle(), cmd_sanick::Handle(), cmd_samode::Handle(), cmd_sajoin::Handle(), RemoveBase::Handle(), cmd_randquote::Handle(), cmd_nickunlock::Handle(), cmd_nicklock::Handle(), cmd_unlockserv::Handle(), cmd_lockserv::Handle(), cmd_knock::Handle(), cmd_jumpserver::Handle(), cmd_helpop::Handle(), cmd_globops::Handle(), cmd_greloadmodule::Handle(), cmd_gunloadmodule::Handle(), cmd_gloadmodule::Handle(), cmd_filter::Handle(), cmd_devoice::Handle(), cmd_dccallow::Handle(), cmd_cycle::Handle(), cmd_title::Handle(), cmd_close::Handle(), cmd_clones::Handle(), cmd_chgname::Handle(), cmd_chgident::Handle(), cmd_chghost::Handle(), cmd_check::Handle(), cmd_webirc::Handle(), cmd_cban::Handle(), cmd_alltime::Handle(), cmd_reload::Handle(), cmd_zline::Handle(), cmd_whowas::Handle(), cmd_whois::Handle(), cmd_who::Handle(), cmd_version::Handle(), cmd_users::Handle(), cmd_userhost::Handle(), cmd_user::Handle(), cmd_unloadmodule::Handle(), cmd_trace::Handle(), cmd_topic::Handle(), cmd_time::Handle(), cmd_summon::Handle(), cmd_squit::Handle(), cmd_server::Handle(), cmd_restart::Handle(), cmd_reloadmodule::Handle(), cmd_rehash::Handle(), cmd_qline::Handle(), cmd_privmsg::Handle(), cmd_pass::Handle(), cmd_part::Handle(), cmd_oper::Handle(), cmd_notice::Handle(), cmd_nick::Handle(), cmd_names::Handle(), cmd_modules::Handle(), cmd_map::Handle(), cmd_lusers::Handle(), cmd_loadmodule::Handle(), cmd_list::Handle(), cmd_links::Handle(), cmd_kline::Handle(), cmd_kill::Handle(), cmd_kick::Handle(), cmd_join::Handle(), cmd_ison::Handle(), cmd_invite::Handle(), cmd_info::Handle(), cmd_gline::Handle(), cmd_eline::Handle(), cmd_die::Handle(), cmd_connect::Handle(), cmd_commands::Handle(), cmd_clearcache::Handle(), cmd_away::Handle(), cmd_admin::Handle(), ModuleSpanningTree::HandleAdmin(), FounderProtectBase::HandleChange(), ModuleSpanningTree::HandleLinks(), ModuleSafeList::HandleList(), ModuleSpanningTree::HandleLusers(), ModuleSpanningTree::HandleMap(), ModuleSpanningTree::HandleModules(), ModuleSpanningTree::HandleMotd(), ModuleSpanningTree::HandleRemoteWhois(), ModuleSpanningTree::HandleSquit(), ModuleSpanningTree::HandleStats(), ModuleSpanningTree::HandleTime(), ModuleSpanningTree::HandleVersion(), InspIRCd::HostMatchesEveryone(), TreeSocket::IntroduceClient(), InspIRCd::IPMatchesEveryone(), chanrec::IsBanned(), chanrec::JoinUser(), chanrec::KickUser(), cmd_mkpasswd::MakeHash(), FounderProtectBase::ModeSet(), ModeParser::ModeString(), TreeSocket::Modules(), TreeSocket::Motd(), InspIRCd::NickMatchesEveryone(), cmd_rsquit::NoticeUser(), ModuleNoKicks::OnAccessCheck(), ModuleChanProtect::OnAccessCheck(), ModuleSafeList::OnBufferFlushed(), ModuleSpanningTree::OnCancelAway(), ModuleSpanningTree::OnChangeHost(), ModuleSpanningTree::OnChangeName(), ModuleBanException::OnCheckBan(), ModuleInviteException::OnCheckInvite(), ModuleIdent::OnCheckReady(), CGIResolver::OnError(), ModuleSQLLog::OnGlobalOper(), ModuleSQLLog::OnKill(), ModuleOperLevels::OnKill(), ModuleSpanningTree::OnLine(), CGIResolver::OnLookupComplete(), ModuleSpanningTree::OnMode(), ListModeBase::OnModeChange(), SSLMode::OnModeChange(), User_r::OnModeChange(), Channel_r::OnModeChange(), Redirect::OnModeChange(), NickFlood::OnModeChange(), MsgFlood::OnModeChange(), JoinFlood::OnModeChange(), InvisibleMode::OnModeChange(), User_d::OnModeChange(), AuditoriumMode::OnModeChange(), ModuleSpanningTree::OnOper(), ModuleSQLLog::OnOper(), ModuleSpanningTree::OnPostCommand(), ModuleSWhois::OnPostCommand(), ModuleOverride::OnPostCommand(), Modulewatch::OnPostConnect(), ModuleChanProtect::OnPostJoin(), ModuleSpanningTree::OnPostLocalTopicChange(), ModuleModesOnOper::OnPostOper(), ModuleOperSSLCert::OnPreCommand(), ModuleSQLLog::OnPreCommand(), ModuleSecureList::OnPreCommand(), ModuleOperLog::OnPreCommand(), FilterBase::OnPreCommand(), ModuleBlockAmsg::OnPreCommand(), ModuleAlias::OnPreCommand(), ModuleSpanningTree::OnRehash(), ModuleSpanningTree::OnRemoteKill(), ModuleSQLAuth::OnRequest(), ModuleInviteException::OnRequest(), ModuleBanException::OnRequest(), ModuleSpanningTree::OnSetAway(), ModuleSpanningTree::OnStats(), ModuleZLib::OnStats(), ModuleSVSHold::OnStats(), ModuleFilterPCRE::OnStats(), ModuleFilter::OnStats(), ModuleDNSBL::OnStats(), ModuleCBan::OnStats(), ModuleSpanningTree::OnUserConnect(), ModuleSQLLog::OnUserConnect(), ModuleHostChange::OnUserConnect(), ModuleFoobar::OnUserConnect(), ModuleModesOnConnect::OnUserConnect(), ModuleSQLutils::OnUserDisconnect(), ModuleIdent::OnUserDisconnect(), ModuleSpanningTree::OnUserInvite(), ModuleSpanningTree::OnUserJoin(), ModuleFoobar::OnUserJoin(), ModuleChanCreate::OnUserJoin(), ModuleSpanningTree::OnUserKick(), ModuleAuditorium::OnUserKick(), ModuleAuditorium::OnUserList(), ModuleSpanningTree::OnUserMessage(), ModuleSpanningTree::OnUserNotice(), ModuleSpanningTree::OnUserPart(), ModuleFoobar::OnUserPart(), ModuleSpanningTree::OnUserPostNick(), Modulewatch::OnUserPostNick(), ModuleServices::OnUserPostNick(), ModuleSeeNicks::OnUserPostNick(), ModuleNoInvite::OnUserPreInvite(), ModuleSSLModes::OnUserPreJoin(), ModuleServicesAccount::OnUserPreJoin(), ModuleServices::OnUserPreJoin(), ModuleRestrictChans::OnUserPreJoin(), ModuleRegOnlyCreate::OnUserPreJoin(), ModuleRedirect::OnUserPreJoin(), ModuleOverride::OnUserPreJoin(), ModuleOperChans::OnUserPreJoin(), ModuleKickNoRejoin::OnUserPreJoin(), ModuleJoinFlood::OnUserPreJoin(), ModuleCBan::OnUserPreJoin(), ModuleBanRedirect::OnUserPreJoin(), ModuleServicesAccount::OnUserPreMessage(), ModuleServices::OnUserPreMessage(), ModuleRestrictMsg::OnUserPreMessage(), ModulePrivacyMode::OnUserPreMessage(), ModuleCensor::OnUserPreMessage(), ModuleBlockColour::OnUserPreMessage(), ModuleBlockCAPS::OnUserPreMessage(), ModuleSVSHold::OnUserPreNick(), ModuleNoNickChange::OnUserPreNick(), ModuleNickLock::OnUserPreNick(), ModuleNickFlood::OnUserPreNick(), ModuleNoNotice::OnUserPreNotice(), ModuleNoCTCP::OnUserPreNotice(), ModuleInvisible::OnUserPreNotice(), FilterBase::OnUserPreNotice(), ModuleDCCAllow::OnUserPreNotice(), ModuleSpanningTree::OnUserQuit(), Modulewatch::OnUserQuit(), ModuleSQLLog::OnUserQuit(), ModuleFoobar::OnUserQuit(), ModuleSQLAuth::OnUserRegister(), ModuleLDAPAuth::OnUserRegister(), ModuleJumpServer::OnUserRegister(), ModuleWaitPong::OnUserRegister(), ModuleAntiBear::OnUserRegister(), ModuleSpanningTree::OnWallops(), ModuleSSLOpenSSL::OnWhois(), ModuleSSLGnuTLS::OnWhois(), ModuleSSLDummy::OnWhois(), ModuleShowwhois::OnWhois(), ModuleServicesAccount::OnWhois(), ModuleServices::OnWhois(), ModuleHelpop::OnWhois(), ModuleBotMode::OnWhois(), ModuleSWhois::OnWhoisLine(), ModuleCustomTitle::OnWhoisLine(), ModuleSQLOper::OperUser(), ModeParser::Process(), CommandParser::ProcessBuffer(), CommandParser::ProcessCommand(), TreeSocket::ProcessLine(), ModuleChanFilter::ProcessMessages(), InspIRCd::ProcessUser(), ModuleSpanningTree::ProtoSendMetaData(), ModuleTaxonomy::ProtoSendMetaData(), ModuleSpanningTree::ProtoSendMode(), ServerConfig::Read(), ModuleCgiIRC::Recheck(), TreeSocket::RemoteKill(), ModuleSpanningTree::RemoteMessage(), cmd_watch::remove_watch(), ModeHandler::RemoveMode(), ModuleDCCAllow::RemoveNick(), ServerConfig::ReportConfigError(), ModeParser::Revoke(), ModeParser::SanityChecks(), ServerConfig::Send005(), cmd_who::SendWhoLine(), chanrec::ServerKickUser(), ModuleSpanningTree::ShowLinks(), ShowOperMOTD(), SplitChanList(), spy_userlist(), XLineManager::stats_e(), XLineManager::stats_g(), XLineManager::stats_k(), XLineManager::stats_q(), XLineManager::stats_z(), ChanFilter::TellAlreadyOnList(), ChanFilter::TellListTooLong(), ChanFilter::TellNotSet(), TreeSocket::Time(), cmd_filter::TooFewParams(), chanrec::UserList(), userrec(), ChanFilter::ValidateParam(), cmd_who::whomatch(), chanrec::WriteAllExceptSender(), InspIRCd::WriteMode(), InspIRCd::WriteOpers(), and SnomaskManager::WriteToSnoMask().

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 464 of file users.h. Referenced by ModuleOverride::CanOverride(), do_whois(), cmd_check::Handle(), ModuleSpanningTree::HandleLusers(), TreeSocket::Modules(), ModuleOperLevels::OnKill(), InvisibleMode::OnModeChange(), ModuleSWhois::OnPostCommand(), ModuleModesOnOper::OnPostOper(), ModuleInvisible::OnUserPreNotice(), CommandParser::ProcessCommand(), ModuleSpanningTree::ShowLinks(), ModuleSpanningTree::ShowMap(), UnOper(), and userrec().

std::string userrec::operquitmsg

Oper-only quit message for this user if non-null. Definition at line 522 of file users.h. Referenced by CullList::AddItem(), CullList::Apply(), GetOperQuit(), and SetOperQuit().

char userrec::password[64]

Password specified by the user when they registered. This is stored even if the <connect> block doesnt need a password, so that modules may check it. Definition at line 480 of file users.h. Referenced by ModuleSQLAuth::CheckCredentials(), ModuleLDAPAuth::CheckCredentials(), ModuleCgiIRC::CheckPass(), cmd_pass::Handle(), and userrec().

unsigned int userrec::pingmax

Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 474 of file users.h. Referenced by CheckClass(), InspIRCd::DoBackgroundUserStuff(), and CommandParser::ProcessCommand().

std::string userrec::quitmsg

Quit message for this user. Definition at line 518 of file users.h. Referenced by CullList::AddItem(), and CullList::Apply().

bool userrec::quitting

If this is set to true, then all read operations for the user are dropped into the bit-bucket. This is used by the global CullList, but please note that setting this value alone will NOT cause the user to quit. This means it can be used seperately, for example by shun modules etc. Definition at line 511 of file users.h. Referenced by CullList::AddItem(), and userrec().

std::string userrec::recvq

User's receive queue. Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy. Definition at line 486 of file users.h. Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), InspIRCd::ProcessUser(), and userrec().

long userrec::recvqmax

Maximum size this user's recvq can become. Copied from the connect class on connect. Definition at line 569 of file users.h. Referenced by AddBuffer(), and CheckClass().

UserResolver* userrec::res_forward

Resolvers for looking up this users IP address This will occur if and when res_reverse completes. When this class completes its lookup, userrec::dns_done will be set from false to true. Definition at line 376 of file users.h. Referenced by UserResolver::OnLookupComplete(), and userrec().

UserResolver* userrec::res_reverse

Resolvers for looking up this users hostname This is instantiated by userrec::StartDNSLookup(), and on success, instantiates userrec::res_reverse. Definition at line 382 of file users.h. Referenced by StartDNSLookup(), and userrec().

time_t userrec::reset_d