Move SSH support into a dedicated library.

It does not belong into libUtils, which is a collection of small
unrelated utility classes.

Task-number: QTCREATORBUG-7218
Change-Id: Id92b9f28678afec93e6f07166adfde6550f38072
Reviewed-by: Eike Ziller <[email protected]>

1 files changed, 113 insertions, 0 deletions

diff --git a/src/libs/ssh/sftpchannel.h b/src/libs/ssh/sftpchannel.h
new file mode 100644
index 00000000000..e1a5605023a
--- /dev/null
+++ b/src/libs/ssh/sftpchannel.h
@@ -0,0 +1,113 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation ([email protected])
+**
+**
+** GNU Lesser General Public License Usage
+**
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this file.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at [email protected].
+**
+**************************************************************************/
+
+#ifndef SFTCHANNEL_H
+#define SFTCHANNEL_H
+
+#include "sftpdefs.h"
+#include "sftpincomingpacket_p.h"
+
+#include "ssh_global.h"
+
+#include <QByteArray>
+#include <QObject>
+#include <QSharedPointer>
+#include <QString>
+
+namespace QSsh {
+
+namespace Internal {
+class SftpChannelPrivate;
+class SshChannelManager;
+class SshSendFacility;
+} // namespace Internal
+
+class QSSH_EXPORT SftpChannel : public QObject
+{
+    Q_OBJECT
+
+    friend class Internal::SftpChannelPrivate;
+    friend class Internal::SshChannelManager;
+public:
+    typedef QSharedPointer<SftpChannel> Ptr;
+
+    enum State { Uninitialized, Initializing, Initialized, Closing, Closed };
+    State state() const;
+
+    void initialize();
+    void closeChannel();
+
+    SftpJobId statFile(const QString &path);
+    SftpJobId listDirectory(const QString &dirPath);
+    SftpJobId createDirectory(const QString &dirPath);
+    SftpJobId removeDirectory(const QString &dirPath);
+    SftpJobId removeFile(const QString &filePath);
+    SftpJobId renameFileOrDirectory(const QString &oldPath,
+        const QString &newPath);
+    SftpJobId createFile(const QString &filePath, SftpOverwriteMode mode);
+    SftpJobId createLink(const QString &filePath, const QString &target);
+    SftpJobId uploadFile(const QString &localFilePath,
+        const QString &remoteFilePath, SftpOverwriteMode mode);
+    SftpJobId downloadFile(const QString &remoteFilePath,
+        const QString &localFilePath, SftpOverwriteMode mode);
+    SftpJobId uploadDir(const QString &localDirPath,
+        const QString &remoteParentDirPath);
+
+    ~SftpChannel();
+
+signals:
+    void initialized();
+    void initializationFailed(const QString &reason);
+    void closed();
+
+    // error.isEmpty <=> finished successfully
+    void finished(QSsh::SftpJobId job, const QString &error = QString());
+
+     // TODO: Also emit for each file copied by uploadDir().
+    void dataAvailable(QSsh::SftpJobId job, const QString &data);
+
+    /*
+     * This signal is emitted as a result of:
+     *     - statFile() (with the list having exactly one element)
+     *     - listDirectory() (potentially more than once)
+     */
+    void fileInfoAvailable(QSsh::SftpJobId job, const QList<QSsh::SftpFileInfo> &fileInfoList);
+
+private:
+    SftpChannel(quint32 channelId, Internal::SshSendFacility &sendFacility);
+
+    Internal::SftpChannelPrivate *d;
+};
+
+} // namespace QSsh
+
+#endif // SFTPCHANNEL_H