src/plugins/coreplugin/ssh/sftpincomingpacket_p.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef SFTPINCOMINGPACKET_P_H
  35 #define SFTPINCOMINGPACKET_P_H
  36
  37 #include "sftppacket_p.h"
  38
  39 namespace Core {
  40 namespace Internal {
  41
  42 struct SftpHandleResponse {
  43     quint32 requestId;
  44     QByteArray handle;
  45 };
  46
  47 struct SftpStatusResponse {
  48     quint32 requestId;
  49     SftpStatusCode status;
  50     QString errorString;
  51     QByteArray language;
  52 };
  53
  54 struct SftpFileAttributes {
  55     bool sizePresent;
  56     bool timesPresent;
  57     bool uidAndGidPresent;
  58     bool permissionsPresent;
  59     quint64 size;
  60     quint32 uid;
  61     quint32 gid;
  62     quint32 permissions;
  63     quint32 atime;
  64     quint32 mtime;
  65 };
  66
  67 struct SftpFile {
  68     QString fileName;
  69     QString longName; // Not present in later RFCs, so we don't expose this to the user.
  70     SftpFileAttributes attributes;
  71 };
  72
  73 struct SftpNameResponse {
  74     quint32 requestId;
  75     QList<SftpFile> files;
  76 };
  77
  78 struct SftpDataResponse {
  79     quint32 requestId;
  80     QByteArray data;
  81 };
  82
  83 struct SftpAttrsResponse {
  84     quint32 requestId;
  85     SftpFileAttributes attrs;
  86 };
  87
  88 class SftpIncomingPacket : public AbstractSftpPacket
  89 {
  90 public:
  91     SftpIncomingPacket();
  92
  93     void consumeData(QByteArray &data);
  94     void clear();
  95     bool isComplete() const;
  96     quint32 extractServerVersion() const;
  97     SftpHandleResponse asHandleResponse() const;
  98     SftpStatusResponse asStatusResponse() const;
  99     SftpNameResponse asNameResponse() const;
 100     SftpDataResponse asDataResponse() const;
 101     SftpAttrsResponse asAttrsResponse() const;
 102
 103 private:
 104     void moveFirstBytes(QByteArray &target, QByteArray &source, int n);
 105
 106     SftpFileAttributes asFileAttributes(quint32 &offset) const;
 107     SftpFile asFile(quint32 &offset) const;
 108
 109     quint32 m_length;
 110 };
 111
 112 } // namespace Internal
 113 } // namespace Core
 114
 115 #endif // SFTPINCOMINGPACKET_P_H