TCPTransfer.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: TCPTransfer.h,v 1.26.16.1 2007/03/25 21:25:37 oliver Exp $
//

#ifndef BALL_SYSTEM_TCPTRANSFER
#define BALL_SYSTEM_TCPTRANSFER

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#include <fstream>

#define BUFFER_SIZE 1024

namespace BALL
{
  class BALL_EXPORT TCPTransfer
  {
    public:

      typedef int Socket;
      
      static const int TIMEOUT;

      enum Status
      {
        OK                      = 0,
        GETHOSTBYNAME__ERROR    ,
        SOCKET__ERROR           ,
        CONNECT__ERROR          ,
        RECV__ERROR             ,
        OUTOFMEMORY__ERROR      ,
        BODY__ERROR             ,
        UNKNOWN__ERROR          ,
        ADDRESS__ERROR          ,
        UNINITIALIZED__ERROR    ,
        TRANSFER__ERROR         ,
        SEND__ERROR             ,
        PORT__ERROR             ,
        UNKNOWN_PROTOCOL__ERROR ,
        LOGON__ERROR            ,
        PROXY__ERROR            , 
        FILENOTFOUND__ERROR     = 404
      };

      enum Protocol
      {
        UNKNOWN_PROTOCOL  = 0,
        
        HTTP_PROTOCOL     = 1,
        
        FTP_PROTOCOL      = 2
      };
      
      class BALL_EXPORT TransferFailed 
        : public Exception::GeneralException
      {
         public:

          TransferFailed(const char* file, int line, Index error_code);
        };
      
      TCPTransfer();
        
      TCPTransfer(std::ostream& file, const String& address)
        throw(TransferFailed);
      
      virtual ~TCPTransfer();
    
      void clear();
    
      bool set(::std::ostream& file, const String& address);
      
      
      void set(::std::ostream& file, 
               Protocol protocol, 
               const String& host_address, 
               const String& file_address,
               const String& login,
               const String& password,
               Position      port = 80);

      const String& getHostAddress() const
      {
        return host_address_;
      }

      const String& getFileAddress() const
      {
        return file_address_;
      }

      Position getPort() const
      {
        return port_;
      }

      Status getStatusCode() const
      {
        return status_;
      }

      String getErrorCode() const;
        
      Position getReceivedBytes() const
      {
        return received_bytes_;
      }
      
      Protocol getProtocol() const
      {
        return protocol_;
      }
      
      const String& getLogin() const
      {
        return login_;
      }

      const String& getPassword() const
      {
        return password_;
      }

      const ::std::ostream* getStream() const
      {
        return fstream_;
      }
          
      const char* getBuffer() const
      {
        return &(buffer_[0]);
      }

      Status transfer();

      void setProxy(const String proxy_address, Position port);

      bool usingProxy() const;

      void abort() { abort_ = true;}
      
      void dump(std::ostream& s = std::cout, Size depth = 0) const;

      protected:
        
        String      host_address_;
        String      file_address_;
        Position    port_;
        String      login_;
        String      password_;
        Status      status_;
        int         received_bytes_;
        Protocol    protocol_;
        char        buffer_[BUFFER_SIZE + 1];
        Socket      socket_;
        std::ostream*  fstream_;
        String      proxy_address_;
        Position    proxy_port_;
        bool        abort_;
        
        /*_ Send data through the socket.
         */
        Status sendData_(const String& query, Socket socket);
        
        /*_ Logon to a server.
         *  @param query string to send to the server as first contact
         */
        Status  logon_(const String& query);
        
        //_ Specified method for transfering per FTP-protocol
        Status  getFTP_();
        
        //_ Specified method for transfering per HTTP-protocol
        Status  getHTTP_();

        /*_ Read a complete status message form a FTP server
            Return false if timeout of 20 seconds is exceeded or an other than the given message
            is received.
        */            
        bool getFTPMessage_(Index status);
        
        //_ Compute the status of a ftp server from its response
        Status  getFTPStatus_();

        //_ Compute the status of a http server from its response
        Status  getHTTPStatus_();

        //_ Set a socket to blocking or nonblocking mode.
        Status  setBlock_(Socket socket, bool block = true);

        //_ Wait a given time for output from the Socket.
        bool    waitForOutput_(const String& key, Size seconds);
        
        //_
        int getReceivedBytes_(Socket& socket);
        
        int readInputFromSocket_(Socket& socket);

      private:
        
        void operator = (TCPTransfer);
  };
  
}

#endif // BALL_SYSTEM_TCPTRANSFER_H