Implemented SFTP API, tests and sample app. JIRA CXX-13855

git-svn-id: https://anonsvn.ncbi.nlm.nih.gov/repos/v1/trunk/c++@104380 78c7ea69-d796-4a43-9a09-de51944f1b03

Author: sadyrov

include/common/ncbi_export.h

@@ -1530,6 +1530,14 @@
 #  define NCBI_XXCONNECT2_EXPORT NCBI_DLL_IMPORT
 #endif
 
+/* Export specifier for library xconnsftp
+ */
+#ifdef NCBI_XCONNSFTP_EXPORTS
+#  define NCBI_XCONNSFTP_EXPORT NCBI_DLL_EXPORT
+#else
+#  define NCBI_XCONNSFTP_EXPORT NCBI_DLL_IMPORT
+#endif
+
 /* Export specifier for library jaeger_tracer
  */
 #ifdef NCBI_JAEGER_TRACER_EXPORTS

include/connect/ncbi_sftp.hpp

@@ -0,0 +1,103 @@
+#ifndef CONNECT__NCBI_SFTP__HPP
+#define CONNECT__NCBI_SFTP__HPP
+
+/*  $Id$
+ * ===========================================================================
+ *
+ *                            PUBLIC DOMAIN NOTICE
+ *               National Center for Biotechnology Information
+ *
+ *  This software/database is a "United States Government Work" under the
+ *  terms of the United States Copyright Act.  It was written as part of
+ *  the author's official duties as a United States Government employee and
+ *  thus cannot be copyrighted.  This software/database is freely available
+ *  to the public for use. The National Library of Medicine and the U.S.
+ *  Government have not placed any restriction on its use or reproduction.
+ *
+ *  Although all reasonable efforts have been taken to ensure the accuracy
+ *  and reliability of the software and data, the NLM and the U.S.
+ *  Government do not and cannot warrant the performance or results that
+ *  may be obtained by using this software or data. The NLM and the U.S.
+ *  Government disclaim all warranties, express or implied, including
+ *  warranties of performance, merchantability or fitness for any particular
+ *  purpose.
+ *
+ *  Please cite the author in any work or product based on this material.
+ *
+ * ===========================================================================
+ *
+ * Authors: Rafael Sadyrov
+ *
+ */
+
+#include <corelib/ncbistl.hpp>
+#include <corelib/ncbiexpt.hpp>
+#include <corelib/rwstream.hpp>
+
+#include <memory>
+
+#if defined(NCBI_THREADS) && defined(HAVE_LIBSSH)
+#   define HAVE_SFTP 1
+#endif
+
+#ifdef HAVE_SFTP
+
+BEGIN_NCBI_SCOPE
+
+
+class NCBI_XCONNSFTP_EXPORT CSFTP_Exception : public CException
+{
+public:
+    enum EErrCode {
+        eInternalError,
+        eInvalidArg,
+        eAuthenticationError,
+    };
+
+    virtual const char* GetErrCodeString() const override;
+
+    NCBI_EXCEPTION_DEFAULT(CSFTP_Exception, CException);
+};
+
+
+/// An SFTP client session.
+/// Required for SFTP client streams.
+///
+/// @sa CSFTP_Stream
+///
+class NCBI_XCONNSFTP_EXPORT CSFTP_Session
+{
+public:
+    CSFTP_Session(const string& host,
+                  const string& password = {});
+
+    CSFTP_Session(const string& host,
+                  const string& user,
+                  const string& password = {});
+
+private:
+    shared_ptr<void> m_Impl;
+
+    friend class CSFTP_Stream;
+};
+
+
+/// An SFTP client stream.
+/// Supports most features of CConn_FtpStream,
+/// see <connect/ncbi_ftp_connector.h> for detailed explanations
+/// of supported features of the latter.
+///
+/// @sa CConn_FtpStream, FTP_CreateConnector
+///
+class NCBI_XCONNSFTP_EXPORT CSFTP_Stream : public CRWStream
+{
+public:
+    CSFTP_Stream(CSFTP_Session session,
+                 string_view path = {});
+};
+
+
+END_NCBI_SCOPE
+
+#endif
+#endif

src/connect/CMakeLists.txt

@@ -56,5 +56,5 @@ set(SRC_CXX
     )
 
 NCBI_disable_pch()
-NCBI_add_library(connssl connect xxconnect xxconnect2 xconnect xthrserv)
+NCBI_add_library(connssl connect xxconnect xxconnect2 xconnect xthrserv xconnsftp)
 NCBI_add_subdirectory(services ext test)

src/connect/CMakeLists.xconnsftp.lib.txt

@@ -0,0 +1,10 @@
+# $Id$
+
+NCBI_begin_lib(xconnsftp SHARED)
+  NCBI_sources(ncbi_sftp)
+  NCBI_add_definitions(NCBI_XCONNSFTP_EXPORTS)
+  NCBI_uses_toolkit_libraries(xncbi)
+  NCBI_requires(SSH)
+  NCBI_project_watchers(sadyrovr)
+NCBI_end_lib()
+

src/connect/Makefile.in

@@ -9,7 +9,7 @@
 #  - tests:      "test/*.*"
 #################################
 
-LIB_PROJ = connssl connect xxconnect xconnect xxconnect2 xthrserv 
+LIB_PROJ = connssl connect xxconnect xconnect xxconnect2 xthrserv xconnsftp
 SUB_PROJ = services ext test
 
 WATCHERS = lavr

src/connect/Makefile.xconnsftp.lib

@@ -0,0 +1,17 @@
+# $Id$
+
+SRC = ncbi_sftp
+
+LIB = xconnsftp
+
+REQUIRES = LIBSSH
+
+LIB_OR_DLL = both
+
+CPPFLAGS = $(LIBSSH_INCLUDE) $(ORIG_CPPFLAGS)
+
+LIBS = $(XCONNSFTP_LIBS) $(ORIG_LIBS)
+
+WATCHERS = sadyrovr
+
+USES_LIBRARIES = xncbi

src/connect/Makefile.xconnsftp.mk

@@ -0,0 +1,4 @@
+# $Id$
+
+XCONNSFTP_LIBS = $(LIBSSH_LIBS)
+XCONNSFTP_STATIC_LIBS = $(LIBSSH_STATIC_LIBS)