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 std::string CreateSum();
  43
  44 /** Each connection has one or more of these
  45  * each represents ONE outbound connection to another ircd
  46  * so each inbound has multiple outbounds. A listening socket
  47  * that accepts server type connections is represented by one
  48  * class serverrec. Class serverrec will instantiate several
  49  * objects of type ircd_connector to represent each established
  50  * connection, inbound or outbound. So, to determine all linked
  51  * servers you must walk through all the serverrecs that the
  52  * core defines, and in each one iterate through until you find
  53  * connection(s) relating to the server you want information on.
  54  * The core and module API provide functions for this.
  55  */
  56 class ircd_connector : public Extensible
  57 {
  58  private:
  59         /** Sockaddr of the outbound ip and port
  60          */
  61         sockaddr_in addr;
  62
  63         /** File descriptor of the connection
  64          */
  65         int fd;
  66
  67         /** Server name
  68          */
  69         std::string servername;
  70
  71         /** Server 'GECOS'
  72          */
  73         std::string description;
  74
  75         /** State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND
  76          * STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED
  77          */
  78         char state;
  79
  80         /** PRIVATE function to set the host address and port to connect to
  81          */
  82         bool SetHostAddress(char* host, int port);
  83
  84         /** This string holds the ircd's version response
  85          */
  86         std::string version;
  87
  88         /** SendQ of the outbound connector, does not have a limit
  89          */
  90         std::string sendq;
  91
  92         /** Write error of connection
  93          */
  94         std::string WriteError;
  95
  96         /** Time this connection was last pinged
  97          */
  98         time_t nextping;
  99
 100         /** Did this connection reply to its last ping?
 101          */
 102         bool replied;
 103
 104  public:
 105
 106         /** IRCD Buffer for input characters, holds as many lines as are
 107          * pending - Note that the final line may not be complete and should
 108          * only be read when there is a \n seperator.
 109          */
 110         std::string ircdbuffer;
 111
 112
 113         /** When MakeOutboundConnection is called, these public members are
 114          * filled with the details passed to the function, for future
 115          * reference
 116          */
 117         char host[MAXBUF];
 118
 119         /** When MakeOutboundConnection is called, these public members are
 120          * filled with the details passed to the function, for future
 121          * reference
 122          */
 123         int port;
 124
 125         /** Server names of servers that this server is linked to
 126          * So for A->B->C, if this was the record for B it would contain A and C
 127          * whilever both servers are connected to B.
 128          */
 129         std::vector<std::string> routes;
 130
 131         /** Constructor clears the sendq and initialises the fd to -1
 132          */
 133         ircd_connector();
 134
 135         /** Create an outbound connection to a listening socket
 136          */
 137         bool MakeOutboundConnection(char* newhost, int newport);
 138
 139         /** Return the servername on this established connection
 140          */
 141         std::string GetServerName();
 142
 143         /** Set the server name of this connection
 144          */
 145         void SetServerName(std::string serv);
 146
 147         /** Get the file descriptor associated with this connection
 148          */
 149         int GetDescriptor();
 150
 151         /** Set the file descriptor for this connection
 152          */
 153         void SetDescriptor(int fd);
 154
 155         /** Get the state flags for this connection
 156          */
 157         int GetState();
 158
 159         /** Set the state flags for this connection
 160          */
 161         void SetState(int state);
 162
 163         /** Get the ip address (not servername) associated with this connection
 164          */
 165         char* GetServerIP();
 166
 167         /** Get the server description of this connection
 168          */
 169         std::string GetDescription();
 170
 171         /** Set the server description of this connection
 172          */
 173         void SetDescription(std::string desc);
 174
 175         /** Get the port number being used for this connection
 176          * If the connection is outbound this will be the remote port
 177          * otherwise it will be the local port, so it can always be
 178          * gautanteed as open at the address given in GetServerIP().
 179          */
 180         int GetServerPort();
 181
 182         /** Set the port used by this connection
 183          */
 184         void SetServerPort(int p);
 185
 186         /** Set both the host and the port in one operation for this connection
 187          */
 188         bool SetHostAndPort(char* newhost, int newport);
 189
 190         /** Close the connection by calling close() on its file descriptor
 191          * This function call updates no other data.
 192          */
 193         void CloseConnection();
 194
 195         /** This method adds text to the ircd connection's buffer
 196          * This buffer's maximum size is one megabyte, the method returning false
 197          * if the buffer is full.
 198          */
 199         bool AddBuffer(std::string a);
 200
 201         /** This method returns true if the buffer contains at least one
 202          * carriage return character, e.g. one line can be read from the
 203          * buffer successfully.
 204          */
 205         bool BufferIsComplete();
 206
 207         /** This method clears the server's buffer by setting it to an empty string.
 208          */
 209         void ClearBuffer();
 210
 211         /** This method retrieves the first string from the tail end of the
 212          * buffer and advances the tail end of the buffer past the returned
 213          * string, in a similar manner to strtok().
 214          */
 215         std::string GetBuffer();
 216
 217         /** This method sets the version string of the remote server
 218          */
 219         void SetVersionString(std::string newversion);
 220
 221         /** This method returns the version string of the remote server.
 222          * If the server has no version string an empty string is returned.
 223          */
 224         std::string GetVersionString();
 225
 226         /** Adds data to the connection's sendQ to be flushed later
 227          * Fails if there is an error pending on the connection.
 228          */
 229         bool AddWriteBuf(std::string data);
 230
 231         /** Flushes as much of the data from the buffer as possible,
 232          * and advances the queue pointer to what is left.
 233          */
 234         bool FlushWriteBuf();
 235
 236         /** Sets the error string for this connection
 237          */
 238         void SetWriteError(std::string error);
 239
 240         /** Gets the error string for this connection
 241          */
 242         std::string GetWriteError();
 243
 244         /** Returns true if there is data to be written that hasn't been sent yet
 245          */
 246         bool HasBufferedOutput();
 247
 248         /** Checks if the connection replied to its last ping, and if it did
 249          * sends another and returns true, if not, returns false.
 250          */
 251         bool CheckPing();
 252
 253         /** Resets the ping counter
 254          */
 255         void ResetPing();
 256 };
 257
 258
 259 /** Please note: classes serverrec and userrec both inherit from class connection.
 260  */
 261 class connection : public Extensible
 262 {
 263  public:
 264         /** File descriptor of the connection
 265          */
 266         int fd;
 267
 268         /** Hostname of connection. Not used if this is a serverrec
 269          */
 270         char host[160];
 271
 272         /** IP of connection.
 273          */
 274         char ip[16];
 275
 276         /** Stats counter for bytes inbound
 277          */
 278         int bytes_in;
 279
 280         /** Stats counter for bytes outbound
 281          */
 282         int bytes_out;
 283
 284         /** Stats counter for commands inbound
 285          */
 286         int cmds_in;
 287
 288         /** Stats counter for commands outbound
 289          */
 290         int cmds_out;
 291
 292         /** True if server/user has authenticated, false if otherwise
 293          */
 294         bool haspassed;
 295
 296         /** Port number
 297          * For a userrec, this is the port they connected to the network on.
 298          * For a serverrec this is the current listening port of the serverrec object.
 299          */
 300         int port;
 301
 302         /** Used by userrec to indicate the registration status of the connection
 303          */
 304         char registered;
 305
 306         /** Time the connection was last pinged
 307          */
 308         time_t lastping;
 309
 310         /** Time the connection was created, set in the constructor
 311          */
 312         time_t signon;
 313
 314         /** Time that the connection last sent data, used to calculate idle time
 315          */
 316         time_t idle_lastmsg;
 317
 318         /** Used by PING checks with clients
 319          */
 320         time_t nping;
 321
 322         /** Default constructor
 323          */
 324         connection();
 325 };
 326
 327
 328 #endif