/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. * E-mail: * * * * Written by Craig Edwards, Craig McLure, and others. * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #include "inspircd_config.h" #include "channels.h" #include "connection.h" #include "inspstring.h" #include #ifndef __USERS_H__ #define __USERS_H__ #define STATUS_OP 4 #define STATUS_HOP 2 #define STATUS_VOICE 1 #define STATUS_NORMAL 0 #define CC_ALLOW 0 #define CC_DENY 1 /** Holds a channel name to which a user has been invited. */ class Invited : public classbase { public: char channel[CHANMAX]; }; /** Holds information relevent to <connect allow> and <connect deny> tags in the config file. */ class ConnectClass : public classbase { public: /** Type of line, either CC_ALLOW or CC_DENY */ int type; /** Max time to register the connection in seconds */ int registration_timeout; /** Number of lines in buffer before excess flood is triggered */ int flood; /** Host mask for this line */ char host[MAXBUF]; /** Number of seconds between pings for this line */ int pingtime; /** (Optional) Password for this line */ char pass[MAXBUF]; /** Threshold value for flood disconnect */ long threshold; ConnectClass() { registration_timeout = 0; flood = 0; pingtime = 0; threshold = 0; strlcpy(host,"",MAXBUF); strlcpy(pass,"",MAXBUF); } }; /** Holds a complete list of all channels to which a user has been invited and has not yet joined. */ typedef std::vector InvitedList; /** Holds a complete list of all allow and deny tags from the configuration file (connection classes) */ typedef std::vector ClassVector; /** Holds all information about a user * This class stores all information about a user connected to the irc server. Everything about a * connection is stored here primarily, from the user's socket ID (file descriptor) through to the * user's nickname and hostname. Use the Find method of the server class to locate a specific user * by nickname. */ class userrec : public connection { private: /** A list of channels the user has a pending invite to. */ InvitedList invites; public: /** The users nickname. * An invalid nickname indicates an unregistered connection prior to the NICK command. */ char nick[NICKMAX]; /** The users ident reply. */ char ident[64]; /** The host displayed to non-opers (used for cloaking etc). * This usually matches the value of userrec::host. */ char dhost[256]; /** The users full name. */ char fullname[128]; /** The user's mode string. * This may contain any of the following RFC characters: o, w, s, i * Your module may define other mode characters as it sees fit. */ char modes[MAXBUF]; ucrec chans[MAXCHANS]; /** The server the user is connected to. */ char server[256]; /** The user's away message. * If this string is empty, the user is not marked as away. */ char awaymsg[512]; /** Stores the result of the last GetFullHost or GetRealHost call. * You may use this to increase the speed of use of this class. */ char result[256]; /** Number of lines the user can place into the buffer * (up to the global NetBufferSize bytes) before they * are disconnected for excess flood */ int flood; /** Number of seconds this user is given to send USER/NICK * If they do not send their details in this time limit they * will be disconnected */ unsigned long timeout; /** 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. */ char oper[NICKMAX]; /** True when DNS lookups are completed. */ bool dns_done; /** Number of seconds between PINGs for this user (set from <connect:allow> tag */ unsigned long pingmax; /** Password specified by the user when they registered. * This is stored even if the block doesnt need a password, so that * modules may check it. */ char password[MAXBUF]; /** User's receive queue. * Lines from the IRCd awaiting processing are stored here. * Upgraded april 2005, old system a bit hairy. */ std::string recvq; /** User's send queue. * Lines waiting to be sent are stored here until their buffer is flushed. */ std::string sendq; /** Flood counters */ long lines_in; time_t reset_due; long threshold; /* Write error string */ std::string WriteError; userrec(); virtual ~userrec() { } /** 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!ident&at;host form. */ virtual char* GetFullHost(); /** 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!ident&at;host 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. */ virtual char* GetFullRealHost(); /** Returns true if a user is invited to a channel. */ virtual bool IsInvited(char* channel); /** Adds a channel to a users invite list (invites them to a channel) */ virtual void InviteTo(char* channel); /** 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. */ virtual void RemoveInvite(char* channel); /** 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. */ bool HasPermission(char* command); /** This method adds data to the 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. */ bool AddBuffer(std::string a); /** This method returns true if the buffer contains at least one carriage return * character (e.g. one complete line may be read) */ bool BufferIsReady(); /** This function clears the entire buffer by setting it to an empty string. */ void ClearBuffer(); /** 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(). */ std::string GetBuffer(); /** 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. */ void SetWriteError(std::string error); /** Returns the write error which last occured on this connection or an empty string * if none occured. */ std::string GetWriteError(); void AddWriteBuf(std::string data); void FlushWriteBuf(); }; #endif