/* +------------------------------------+ * | 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 "base.h" #include #include #include #include #include #include #include #include #include #include #include #include #ifndef __CONNECTION_H__ #define __CONNECTION_H__ #define STATE_DISCONNECTED 0 #define STATE_CONNECTED 1 #define STATE_SYNC 2 #define STATE_NOAUTH_INBOUND 3 #define STATE_NOAUTH_OUTBOUND 4 #define STATE_SERVICES 5 #define STATE_COOKIE_OUTBOUND 6 std::string CreateSum(); /** Each connection has one or more of these * each represents ONE outbound connection to another ircd * so each inbound has multiple outbounds. A listening socket * that accepts server type connections is represented by one * class serverrec. Class serverrec will instantiate several * objects of type ircd_connector to represent each established * connection, inbound or outbound. So, to determine all linked * servers you must walk through all the serverrecs that the * core defines, and in each one iterate through until you find * connection(s) relating to the server you want information on. * The core and module API provide functions for this. */ class ircd_connector : public Extensible { private: /** Sockaddr of the outbound ip and port */ sockaddr_in addr; /** File descriptor of the connection */ int fd; /** Server name */ std::string servername; /** Server 'GECOS' */ std::string description; /** State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND * STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED */ char state; /** PRIVATE function to set the host address and port to connect to */ bool SetHostAddress(char* host, int port); /** This string holds the ircd's version response */ std::string version; /** SendQ of the outbound connector, does not have a limit */ std::string sendq; /** Write error of connection */ std::string WriteError; /** Time this connection was last pinged */ time_t nextping; /** Did this connection reply to its last ping? */ bool replied; public: /** IRCD Buffer for input characters, holds as many lines as are * pending - Note that the final line may not be complete and should * only be read when there is a \n seperator. */ std::string ircdbuffer; /** When MakeOutboundConnection is called, these public members are * filled with the details passed to the function, for future * reference */ char host[MAXBUF]; /** When MakeOutboundConnection is called, these public members are * filled with the details passed to the function, for future * reference */ int port; /** Server names of servers that this server is linked to * So for A->B->C, if this was the record for B it would contain A and C * whilever both servers are connected to B. */ std::vector routes; /** Constructor clears the sendq and initialises the fd to -1 */ ircd_connector(); /** Create an outbound connection to a listening socket */ bool MakeOutboundConnection(char* newhost, int newport); /** Return the servername on this established connection */ std::string GetServerName(); /** Set the server name of this connection * @param serv The server name to set */ void SetServerName(std::string serv); /** Get the file descriptor associated with this connection * @return The file descriptor associated with this connection */ int GetDescriptor(); /** Set the file descriptor for this connection * @param fd The file descriptor to associate with the connection */ void SetDescriptor(int fd); /** Get the state flags for this connection * @return The state flags associated with this connection */ int GetState(); /** Set the state flags for this connection * @param state The state flags to set for this connection */ void SetState(int state); /** Get the ip address (not servername) associated with this connection * @return The connections IP address in dotted decimal form */ char* GetServerIP(); /** Get the server description of this connection * @return The description (GECOS) of this connection */ std::string GetDescription(); /** Set the server description of this connection * @param desc The description (GECOS) of this connection to be set */ void SetDescription(std::string desc); /** Get the port number being used for this connection * If the connection is outbound this will be the remote port * otherwise it will be the local port, so it can always be * gautanteed as open at the address given in GetServerIP(). * * @return The port number of this connection */ int GetServerPort(); /** Set the port used by this connection * @param p The port number to set for this connection */ void SetServerPort(int p); /** Set both the host and the port in one operation for this connection * @param newhost The hostname to set for this connection * @param newport The port number to set for this connection * @return True on success, false on failure */ bool SetHostAndPort(char* newhost, int newport); /** Close the connection by calling close() on its file descriptor * This function call updates no other data. */ void CloseConnection(); /** This method adds text to the ircd connection's buffer * @param a The text to add to the buffer up to a maximum size of 1MB * * This buffer's maximum size is one megabyte, the method returning false * if the buffer is full. * * @return True on success, false if the buffer is full or the connection is down */ bool AddBuffer(std::string a); /** This method returns true if the buffer contains at least one * carriage return character, e.g. one line can be read from the * buffer successfully. * * @return True if there is at least one complete line waiting to be processed */ bool BufferIsComplete(); /** This method clears the server's buffer by setting it to an empty string. */ void ClearBuffer(); /** This method retrieves the first string from the tail end of the * buffer and advances the tail end of the buffer past the returned * string, in a similar manner to strtok(). * * @return The first line of the buffer up to a carriage return */ std::string GetBuffer(); /** This method sets the version string of the remote server * @param newversion The version string to set */ void SetVersionString(std::string newversion); /** This method returns the version string of the remote server. * If the server has no version string an empty string is returned. * * @return The version text of this connection */ std::string GetVersionString(); /** Adds data to the connection's sendQ to be flushed later. * @param data The data to add to the write buffer * * Fails if there is an error pending on the connection. * * @return True on success, false if the connection is down or the buffer is full */ bool AddWriteBuf(std::string data); /** Flushes as much of the data from the buffer as possible, * and advances the queue pointer to what is left. * * @return True if the flush succeeded, false if the connection is down */ bool FlushWriteBuf(); /** Sets the error string for this connection * @param error The error string to set */ void SetWriteError(std::string error); /** Gets the error string for this connection * @return The last error to occur or an empty string */ std::string GetWriteError(); /** Returns true if there is data to be written that hasn't been sent yet * @return True if the buffer is not empty */ bool HasBufferedOutput(); /** Checks if the connection replied to its last ping, and if it did * sends another and returns true, if not, returns false. * @return True if the server is still replying to pings */ bool CheckPing(); /** Resets the ping counter */ void ResetPing(); }; /** Please note: classes serverrec and userrec both inherit from class connection. */ class connection : public Extensible { public: /** File descriptor of the connection */ int fd; /** Hostname of connection. Not used if this is a serverrec */ char host[160]; /** IP of connection. */ char ip[16]; /** Stats counter for bytes inbound */ int bytes_in; /** Stats counter for bytes outbound */ int bytes_out; /** Stats counter for commands inbound */ int cmds_in; /** Stats counter for commands outbound */ int cmds_out; /** True if server/user has authenticated, false if otherwise */ bool haspassed; /** Port number * For a userrec, this is the port they connected to the network on. * For a serverrec this is the current listening port of the serverrec object. */ int port; /** Used by userrec to indicate the registration status of the connection */ char registered; /** Time the connection was last pinged */ time_t lastping; /** Time the connection was created, set in the constructor */ time_t signon; /** Time that the connection last sent data, used to calculate idle time */ time_t idle_lastmsg; /** Used by PING checks with clients */ time_t nping; /** Default constructor */ connection(); }; #endif