include/connection.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #include "inspircd_config.h"
  18 #include "base.h"
  19 #include <string>
  20 #include <map>
  21 #include <sys/types.h>
  22 #include <sys/socket.h>
  23 #include <netdb.h>
  24 #include <netinet/in.h>
  25 #include <unistd.h>
  26 #include <errno.h>
  27 #include <time.h>
  28 #include <vector>
  29 #include <deque>
  30 #include <sstream>
  31
  32 #ifndef __CONNECTION_H__
  33 #define __CONNECTION_H__
  34
  35 #define STATE_DISCONNECTED      0
  36 #define STATE_CONNECTED         1
  37 #define STATE_SYNC              2
  38 #define STATE_NOAUTH_INBOUND    3
  39 #define STATE_NOAUTH_OUTBOUND   4
  40 #define STATE_SERVICES          5
  41
  42 /** Each connection has one or more of these
  43  * each represents ONE outbound connection to another ircd
  44  * so each inbound has multiple outbounds. A listening socket
  45  * that accepts server type connections is represented by one
  46  * class serverrec. Class serverrec will instantiate several
  47  * objects of type ircd_connector to represent each established
  48  * connection, inbound or outbound. So, to determine all linked
  49  * servers you must walk through all the serverrecs that the
  50  * core defines, and in each one iterate through until you find
  51  * connection(s) relating to the server you want information on.
  52  * The core and module API provide functions for this.
  53  */
  54 class ircd_connector : public Extensible
  55 {
  56  private:
  57         /** Sockaddr of the outbound ip and port
  58          */
  59         sockaddr_in addr;
  60
  61         /** File descriptor of the connection
  62          */
  63         int fd;
  64
  65         /** Server name
  66          */
  67         std::string servername;
  68
  69         /** Server 'GECOS'
  70          */
  71         std::string description;
  72
  73         /** State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND
  74          * STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED
  75          */
  76         int state;
  77
  78         /** PRIVATE function to set the host address and port to connect to
  79          */
  80         bool SetHostAddress(char* host, int port);
  81
  82         /** This string holds the ircd's version response
  83          */
  84         std::string version;
  85
  86  public:
  87
  88         /** IRCD Buffer for input characters, holds as many lines as are
  89          * pending - Note that the final line may not be complete and should
  90          * only be read when there is a \n seperator.
  91          */
  92         std::string ircdbuffer;
  93
  94
  95         /** When MakeOutboundConnection is called, these public members are
  96          * filled with the details passed to the function, for future
  97          * reference
  98          */
  99         char host[MAXBUF];
 100
 101         /** When MakeOutboundConnection is called, these public members are
 102          * filled with the details passed to the function, for future
 103          * reference
 104          */
 105         int port;
 106
 107         /** Server names of servers that this server is linked to
 108          * So for A->B->C, if this was the record for B it would contain A and C
 109          * whilever both servers are connected to B.
 110          */
 111         std::vector<std::string> routes;
 112
 113
 114         /** Create an outbound connection to a listening socket
 115          */
 116         bool MakeOutboundConnection(char* newhost, int newport);
 117
 118         /** Return the servername on this established connection
 119          */
 120         std::string GetServerName();
 121
 122         /** Set the server name of this connection
 123          */
 124         void SetServerName(std::string serv);
 125
 126         /** Get the file descriptor associated with this connection
 127          */
 128         int GetDescriptor();
 129
 130         /** Set the file descriptor for this connection
 131          */
 132         void SetDescriptor(int fd);
 133
 134         /** Get the state flags for this connection
 135          */
 136         int GetState();
 137
 138         /** Set the state flags for this connection
 139          */
 140         void SetState(int state);
 141
 142         /** Get the ip address (not servername) associated with this connection
 143          */
 144         char* GetServerIP();
 145
 146         /** Get the server description of this connection
 147          */
 148         std::string GetDescription();
 149
 150         /** Set the server description of this connection
 151          */
 152         void SetDescription(std::string desc);
 153
 154         /** Get the port number being used for this connection
 155          * If the connection is outbound this will be the remote port
 156          * otherwise it will be the local port, so it can always be
 157          * gautanteed as open at the address given in GetServerIP().
 158          */
 159         int GetServerPort();
 160
 161         /** Set the port used by this connection
 162          */
 163         void SetServerPort(int p);
 164
 165         /** Set both the host and the port in one operation for this connection
 166          */
 167         bool SetHostAndPort(char* newhost, int newport);
 168
 169         /** Close the connection by calling close() on its file descriptor
 170          * This function call updates no other data.
 171          */
 172         void CloseConnection();
 173
 174         /** This method adds text to the ircd connection's buffer
 175          * There is no limitation on how much text of what line width may
 176          * be added to this buffer. It is the sending server's responsibility
 177          * to ensure sent data is kept within reasonable quanities.
 178          */
 179         void AddBuffer(std::string a);
 180
 181         /** This method returns true if the buffer contains at least one
 182          * carriage return character, e.g. one line can be read from the
 183          * buffer successfully.
 184          */
 185         bool BufferIsComplete();
 186
 187         /** This method clears the server's buffer by setting it to an empty string.
 188          */
 189         void ClearBuffer();
 190
 191         /** This method retrieves the first string from the tail end of the
 192          * buffer and advances the tail end of the buffer past the returned
 193          * string, in a similar manner to strtok().
 194          */
 195         std::string GetBuffer();
 196
 197         /** This method sets the version string of the remote server
 198          */
 199         void SetVersionString(std::string newversion);
 200
 201         /** This method returns the version string of the remote server.
 202          * If the server has no version string an empty string is returned.
 203          */
 204         std::string GetVersionString();
 205 };
 206
 207
 208 /** Please note: classes serverrec and userrec both inherit from class connection.
 209  */
 210 class connection : public Extensible
 211 {
 212  public:
 213         /** File descriptor of the connection
 214          */
 215         int fd;
 216
 217         /** Hostname of connection. Not used if this is a serverrec
 218          */
 219         char host[160];
 220
 221         /** IP of connection.
 222          */
 223         char ip[16];
 224
 225         /** Stats counter for bytes inbound
 226          */
 227         long bytes_in;
 228
 229         /** Stats counter for bytes outbound
 230          */
 231         long bytes_out;
 232
 233         /** Stats counter for commands inbound
 234          */
 235         long cmds_in;
 236
 237         /** Stats counter for commands outbound
 238          */
 239         long cmds_out;
 240
 241         /** True if server/user has authenticated, false if otherwise
 242          */
 243         bool haspassed;
 244
 245         /** Port number
 246          * For a userrec, this is the port they connected to the network on.
 247          * For a serverrec this is the current listening port of the serverrec object.
 248          */
 249         int port;
 250
 251         /** Used by userrec to indicate the registration status of the connection
 252          */
 253         short int registered;
 254
 255         /** Time the connection was last pinged
 256          */
 257         time_t lastping;
 258
 259         /** Time the connection was created, set in the constructor
 260          */
 261         time_t signon;
 262
 263         /** Time that the connection last sent data, used to calculate idle time
 264          */
 265         time_t idle_lastmsg;
 266
 267         /** Used by PING checks with clients
 268          */
 269         time_t nping;
 270
 271         //char internal_addr[MAXBUF];
 272
 273         //int internal_port;
 274
 275         /** With a serverrec, this is a list of all established server connections.
 276          * With a userrec this is unused.
 277          */
 278         std::vector<ircd_connector> connectors;
 279
 280         /** Default constructor
 281          */
 282         connection();
 283
 284         /** Create a listening socket on 'host' using port number 'p'
 285          */
 286         bool CreateListener(char* host, int p);
 287
 288         /** Begin an outbound link to another ircd at targethost.
 289          */
 290         bool BeginLink(char* targethost, int port, char* password, char* servername, int myport);
 291
 292         /** Begin an outbound mesh link to another ircd on a network you are already an authenticated member of
 293          */
 294         bool MeshCookie(char* targethost, int port, unsigned long cookie, char* servername);
 295
 296         /** Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.
 297          */
 298         void TerminateLink(char* targethost);
 299
 300         /** Send a message to a server by name, if the server is unavailable directly route the packet via another server
 301          * If the server still cannot be reached after attempting to route the message remotely, returns false.
 302          */
 303         bool SendPacket(char *message, const char* host);
 304
 305         /** Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'.
 306          * If no data is available this function returns false.
 307          * This function will automatically close broken links and reroute pathways, generating split messages on the network.
 308          */
 309         bool RecvPacket(std::deque<std::string> &messages, char* host);
 310
 311         /** Find the ircd_connector oject related to a certain servername given in 'host'
 312          */
 313         ircd_connector* FindHost(std::string host);
 314
 315         /** Add an incoming connection to the connection pool.
 316          * (reserved for core use)
 317          */
 318         bool AddIncoming(int fd,char* targethost, int sourceport);
 319
 320 };
 321
 322
 323 #endif