aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/ssh/sftpsession.h
blob: 89d0eec145de1f41f9f9cf7474b0220b94af5f0c (plain)
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
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "sftpdefs.h"
#include "ssh_global.h"

#include <QObject>

namespace QSsh {
class SshConnection;

class QSSH_EXPORT SftpSession : public QObject
{
    friend class SshConnection;
    Q_OBJECT
public:
    ~SftpSession() override;
    void start();
    void quit();

    SftpJobId ls(const QString &path);
    SftpJobId createDirectory(const QString &path);
    SftpJobId removeDirectory(const QString &path);
    SftpJobId removeFile(const QString &path);
    SftpJobId rename(const QString &oldPath, const QString &newPath);
    SftpJobId createSoftLink(const QString &filePath, const QString &target);
    SftpJobId uploadFile(const QString &localFilePath, const QString &remoteFilePath);
    SftpJobId downloadFile(const QString &remoteFilePath, const QString &localFilePath);

    enum class State { Inactive, Starting, Running, Closing };
    State state() const;

signals:
    void started();
    void done(const QString &error);
    void commandFinished(SftpJobId job, const QString &error);
    void fileInfoAvailable(SftpJobId job, const QList<SftpFileInfo> &fileInfoList);

private:
    SftpSession(const QStringList &connectionArgs);
    void doStart();
    void handleStdout();
    void handleLsOutput(SftpJobId jobId, const QByteArray &output);

    struct SftpSessionPrivate;
    SftpSessionPrivate * const d;
};

} // namespace QSsh