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
  83  public:
  84
  85         /** IRCD Buffer for input characters, holds one line
  86          */
  87         std::string ircdbuffer;
  88
  89
  90         /** When MakeOutboundConnection is called, these public members are
  91          * filled with the details passed to the function, for future
  92          * reference
  93          */
  94         char host[MAXBUF];
  95
  96         /** When MakeOutboundConnection is called, these public members are
  97          * filled with the details passed to the function, for future
  98          * reference
  99          */
 100         int port;
 101
 102         /** Server names of servers that this server is linked to
 103          * So for A->B->C, if this was the record for B it would contain A and C
 104          * whilever both servers are connected to B.
 105          */
 106         std::vector<std::string> routes;
 107
 108
 109         /** Create an outbound connection to a listening socket
 110          */
 111         bool MakeOutboundConnection(char* newhost, int newport);
 112
 113         /** Return the servername on this established connection
 114          */
 115         std::string GetServerName();
 116
 117         /** Set the server name of this connection
 118          */
 119         void SetServerName(std::string serv);
 120
 121         /** Get the file descriptor associated with this connection
 122          */
 123         int GetDescriptor();
 124
 125         /** Set the file descriptor for this connection
 126          */
 127         void SetDescriptor(int fd);
 128
 129         /** Get the state flags for this connection
 130          */
 131         int GetState();
 132
 133         /** Set the state flags for this connection
 134          */
 135         void SetState(int state);
 136
 137         /** Get the ip address (not servername) associated with this connection
 138          */
 139         char* GetServerIP();
 140
 141         /** Get the server description of this connection
 142          */
 143         std::string GetDescription();
 144
 145         /** Set the server description of this connection
 146          */
 147         void SetDescription(std::string desc);
 148
 149         /** Get the port number being used for this connection
 150          * If the connection is outbound this will be the remote port
 151          * otherwise it will be the local port, so it can always be
 152          * gautanteed as open at the address given in GetServerIP().
 153          */
 154         int GetServerPort();
 155
 156         /** Set the port used by this connection
 157          */
 158         void SetServerPort(int p);
 159
 160         /** Set both the host and the port in one operation for this connection
 161          */
 162         bool SetHostAndPort(char* newhost, int newport);
 163
 164         /** Close the connection by calling close() on its file descriptor
 165          * This function call updates no other data.
 166          */
 167         void CloseConnection();
 168
 169         void AddBuffer(std::string a);
 170         bool BufferIsComplete();
 171         void ClearBuffer();
 172         std::string GetBuffer();
 173 };
 174
 175
 176 /** Please note: classes serverrec and userrec both inherit from class connection.
 177  */
 178 class connection : public Extensible
 179 {
 180  public:
 181         /** File descriptor of the connection
 182          */
 183         int fd;
 184
 185         /** Hostname of connection. Not used if this is a serverrec
 186          */
 187         char host[256];
 188
 189         /** IP of connection. Reserved for future use.
 190          */
 191         char ip[32];
 192
 193         /** Inbuf of connection. Only used for userrec
 194          */
 195         char inbuf[MAXBUF];
 196
 197         /** Stats counter for bytes inbound
 198          */
 199         long bytes_in;
 200
 201         /** Stats counter for bytes outbound
 202          */
 203         long bytes_out;
 204
 205         /** Stats counter for commands inbound
 206          */
 207         long cmds_in;
 208
 209         /** Stats counter for commands outbound
 210          */
 211         long cmds_out;
 212
 213         /** True if server/user has authenticated, false if otherwise
 214          */
 215         bool haspassed;
 216
 217         /** Port number
 218          * For a userrec, this is the port they connected to the network on.
 219          * For a serverrec this is the current listening port of the serverrec object.
 220          */
 221         int port;
 222
 223         /** Used by userrec to indicate the registration status of the connection
 224          */
 225         int registered;
 226
 227         /** Reserved for future use
 228          */
 229         short int state;
 230
 231         /** Time the connection was last pinged
 232          */
 233         time_t lastping;
 234
 235         /** Time the connection was created, set in the constructor
 236          */
 237         time_t signon;
 238
 239         /** Time that the connection last sent data, used to calculate idle time
 240          */
 241         time_t idle_lastmsg;
 242
 243         /** Used by PING checks with clients
 244          */
 245         time_t nping;
 246
 247         /** Unused, will be removed in a future alpha/beta
 248          */
 249         char internal_addr[MAXBUF];
 250
 251         /** Unused, will be removed in a future alpha/beta
 252          */
 253         int internal_port;
 254
 255         /** With a serverrec, this is a list of all established server connections.
 256          * With a userrec this is unused.
 257          */
 258         std::vector<ircd_connector> connectors;
 259
 260         /** Default constructor
 261          */
 262         connection();
 263
 264         /** Create a listening socket on 'host' using port number 'p'
 265          */
 266         bool CreateListener(char* host, int p);
 267
 268         /** Begin an outbound link to another ircd at targethost.
 269          */
 270         bool BeginLink(char* targethost, int port, char* password, char* servername, int myport);
 271
 272         /** Begin an outbound mesh link to another ircd on a network you are already an authenticated member of
 273          */
 274         bool MeshCookie(char* targethost, int port, unsigned long cookie, char* servername);
 275
 276         /** Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.
 277          */
 278         void TerminateLink(char* targethost);
 279
 280         /** Send a message to a server by name, if the server is unavailable directly route the packet via another server
 281          * If the server still cannot be reached after attempting to route the message remotely, returns false.
 282          */
 283         bool SendPacket(char *message, const char* host);
 284
 285         /** Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'.
 286          * If no data is available this function returns false.
 287          * This function will automatically close broken links and reroute pathways, generating split messages on the network.
 288          */
 289         bool RecvPacket(std::deque<std::string> &messages, char* host);
 290
 291         /** Find the ircd_connector oject related to a certain servername given in 'host'
 292          */
 293         ircd_connector* FindHost(std::string host);
 294
 295         /** Add an incoming connection to the connection pool.
 296          * (reserved for core use)
 297          */
 298         bool AddIncoming(int fd,char* targethost, int sourceport);
 299
 300         /** This function is deprecated and may be removed in a later alpha/beta
 301          */
 302         long GenKey();
 303 };
 304
 305
 306 #endif
 307