-/*
-
-*/
+/* +------------------------------------+
+ * | 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.
+ * 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/socket.h>
#include <sys/types.h>
+#include <sys/socket.h>
#include <netdb.h>
#include <netinet/in.h>
#include <unistd.h>
#include <time.h>
#include <vector>
#include <deque>
+#include <sstream>
#ifndef __CONNECTION_H__
#define __CONNECTION_H__
#define STATE_SYNC 2
#define STATE_NOAUTH_INBOUND 3
#define STATE_NOAUTH_OUTBOUND 4
+#define STATE_SERVICES 5
+
+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.
+ * 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 classbase
+class ircd_connector : public Extensible
{
private:
/** Sockaddr of the outbound ip and port
*/
std::string description;
- /** 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<std::string> routes;
-
/** State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND
* STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED
*/
- int state;
+ 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;
-
- bool MakeOutboundConnection(char* host, 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<std::string> routes;
+
+
+ /** 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();
- bool SetHostAndPort(char* host, int port);
-};
+
+ /** 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);
-class packet : public classbase
-{
- public:
- long key;
- int id;
- short int type;
- char data[MAXBUF];
+ /** 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();
- packet();
- ~packet();
+ /** 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();
};
-class connection : public classbase
+/** Please note: classes serverrec and userrec both inherit from class connection.
+ */
+class connection : public Extensible
{
public:
- long key;
- int fd; // file descriptor
- char host[256]; // hostname
- long ip; // ipv4 address
- char inbuf[MAXBUF]; // recvQ
+ /** 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;
+
+ /** Stats counter for bytes outbound
+ */
long bytes_out;
+
+ /** Stats counter for commands inbound
+ */
long cmds_in;
+
+ /** Stats counter for commands outbound
+ */
long 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;
- int registered;
- short int state;
+
+ /** 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;
- char internal_addr[1024];
- int internal_port;
+
+ /** With a serverrec, this is a list of all established server connections.
+ * With a userrec this is unused.
+ */
std::vector<ircd_connector> connectors;
+ /** Default constructor
+ */
connection();
+
+ /** Create a listening socket on 'host' using port number 'p'
+ */
bool CreateListener(char* host, int p);
- bool BeginLink(char* targethost, int port, char* password, char* servername);
- bool MeshCookie(char* targethost, int port, long cookie, char* servername);
+
+ /** 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);
- bool RecvPacket(std::deque<std::string> &messages, 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);
- long GenKey();
+
};
#endif
-
projects / user / henk / code / inspircd.git / blobdiff