1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#ifndef SFTCHANNEL_H
#define SFTCHANNEL_H
#include "sftpdefs.h"
#include "sftpincomingpacket_p.h"
#include <coreplugin/core_global.h>
#include <QtCore/QByteArray>
#include <QtCore/QObject>
#include <QtCore/QSharedPointer>
#include <QtCore/QString>
namespace Core {
namespace Internal {
class SftpChannelPrivate;
class SshChannelManager;
class SshSendFacility;
} // namespace Internal
/*
* This class provides SFTP operations.
* Objects are created via SshConnection::createSftpChannel().
* The channel needs to be initialized with
* a call to initialize() and is closed via closeChannel(). After closing
* a channel, no more operations are possible. It cannot be re-opened
* using initialize(); use SshConnection::createSftpChannel() if you need
* a new one.
* After the initialized() signal has been emitted, operations can be started.
* All SFTP operations are asynchronous (non-blocking) and can be in-flight
* simultaneously (though callers must ensure that concurrently running jobs
* are independent of each other, e.g. they must not write to the same file).
* Operations are identified by their job id, which is returned by
* the respective member function. If the function can right away detect that
* the operation cannot succeed, it returns SftpInvalidJob. If an error occurs
* later, the finishedWithError() signal is emitted for the respective job.
* Note that directory names must not have a trailing slash.
*/
class CORE_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 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 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(Core::SftpJobId job, const QString &error = QString());
/*
* This signal is only emitted by the "List Directory" operation,
* one file at a time.
*/
void dataAvailable(SftpJobId job, const QString &data);
private:
SftpChannel(quint32 channelId, Internal::SshSendFacility &sendFacility);
Internal::SftpChannelPrivate *d;
};
} // namespace Core
#endif // SFTPCHANNEL_H
|
