* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-#include "inspircd_config.h"
-#include "base.h"
-#include <string>
-#include <map>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netdb.h>
-#include <netinet/in.h>
-#include <unistd.h>
-#include <errno.h>
-#include <time.h>
-#include <vector>
-#include <deque>
-#include <sstream>
-
#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
-
-std::string CreateSum();
+#include <time.h>
+#include "inspircd_config.h"
+#include "base.h"
+#include "socketengine.h"
-/** 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.
+/** connection is the base class of userrec, and holds basic user properties.
+ * This can be extended for holding other user-like objects in the future.
*/
-class ircd_connector : public Extensible
+class CoreExport connection : public EventHandler
{
- 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;
-
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.
+ /** Hostname of connection.
+ * This should be valid as per RFC1035.
*/
- std::vector<std::string, __single_client_alloc> routes;
-
+ char host[65];
- /** 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
- */
- void SetServerName(std::string serv);
-
- /** Get the file descriptor associated with this connection
- */
- int GetDescriptor();
-
- /** Set the file descriptor for this connection
- */
- void SetDescriptor(int fd);
-
- /** Get the state flags for this connection
- */
- int GetState();
-
- /** Set the state flags for this connection
- */
- void SetState(int state);
-
- /** Get the ip address (not servername) associated with this connection
- */
- char* GetServerIP();
-
- /** Get the server description of this connection
- */
- std::string GetDescription();
-
- /** Set the server description of this connection
- */
- 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().
- */
- int GetServerPort();
-
- /** Set the port used by this connection
- */
- void SetServerPort(int p);
-
- /** Set both the host and the port in one operation for this connection
- */
- 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
- * There is no limitation on how much text of what line width may
- * be added to this buffer. It is the sending server's responsibility
- * to ensure sent data is kept within reasonable quanities.
- */
- void 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.
- */
- 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().
- */
- std::string GetBuffer();
-
- /** This method sets the version string of the remote server
- */
- 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.
- */
- std::string GetVersionString();
-};
-
-
-/** 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
*/
- long bytes_in;
+ int bytes_in;
/** Stats counter for bytes outbound
*/
- long bytes_out;
+ int bytes_out;
/** Stats counter for commands inbound
*/
- long cmds_in;
+ int cmds_in;
/** Stats counter for commands outbound
*/
- long cmds_out;
+ int cmds_out;
- /** True if server/user has authenticated, false if otherwise
+ /** True if 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
+ * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
+ * the connection state.
*/
char registered;
*/
time_t lastping;
- /** Time the connection was created, set in the constructor
+ /** Time the connection was created, set in the constructor. This
+ * may be different from the time the user's classbase object was
+ * created.
*/
time_t signon;
- /** Time that the connection last sent data, used to calculate idle time
+ /** Time that the connection last sent a message, used to calculate idle time
*/
time_t idle_lastmsg;
- /** Used by PING checks with clients
+ /** Used by PING checking code
*/
time_t nping;
-
- /** With a serverrec, this is a list of all established server connections.
- * With a userrec this is unused.
- */
- std::vector<ircd_connector, __single_client_alloc> connectors;
-
- /** Default constructor
- */
- connection();
-
- /** Create a listening socket on 'host' using port number 'p'
- */
- bool CreateListener(char* host, int p);
-
- /** Begin an outbound link to another ircd at targethost.
- */
- bool BeginLink(char* targethost, int port, char* password, char* servername, int myport);
-
- /** Begin an outbound mesh link to another ircd on a network you are already an authenticated member of
- */
- bool MeshCookie(char* targethost, int port, unsigned long cookie, char* servername);
-
- /** Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.
- */
- void TerminateLink(char* targethost);
-
- /** Send a message to a server by name, if the server is unavailable directly route the packet via another server
- * If the server still cannot be reached after attempting to route the message remotely, returns false.
- */
- bool SendPacket(char *message, const char* host);
-
- /** Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'.
- * If no data is available this function returns false.
- * This function will automatically close broken links and reroute pathways, generating split messages on the network.
- */
- bool RecvPacket(std::deque<std::string> &messages, char* host, std::deque<std::string> &sums);
-
- /** Find the ircd_connector oject related to a certain servername given in 'host'
- */
- ircd_connector* FindHost(std::string host);
-
- /** Add an incoming connection to the connection pool.
- * (reserved for core use)
- */
- bool AddIncoming(int fd,char* targethost, int sourceport);
-
};