FileManager.h 10.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

Don Gagne's avatar
Don Gagne committed
10

11
12
#ifndef FILEMANAGER_H
#define FILEMANAGER_H
13
14

#include <QObject>
15
#include <QDir>
16
#include <QTimer>
17
#include <QQueue>
Don Gagne's avatar
Don Gagne committed
18

19
#include "UASInterface.h"
20
#include "QGCLoggingCategory.h"
21

22
23
24
25
26
27
28
#ifdef __GNUC__
  #define PACKED_STRUCT( __Declaration__ ) __Declaration__ __attribute__((packed))
#else
  #define PACKED_STRUCT( __Declaration__ ) __pragma( pack(push, 1) ) __Declaration__ __pragma( pack(pop) )
#endif


29
30
Q_DECLARE_LOGGING_CATEGORY(FileManagerLog)

31
32
class Vehicle;

33
class FileManager : public QObject
34
35
{
    Q_OBJECT
Don Gagne's avatar
Don Gagne committed
36
    
37
public:
38
    FileManager(QObject* parent, Vehicle* vehicle);
Don Gagne's avatar
Don Gagne committed
39
40
41
42
    
    /// These methods are only used for testing purposes.
    bool _sendCmdTestAck(void) { return _sendOpcodeOnlyCmd(kCmdNone, kCOAck); };
    bool _sendCmdTestNoAck(void) { return _sendOpcodeOnlyCmd(kCmdTestNoAck, kCOAck); };
43
    
44
    /// Timeout in msecs to wait for an Ack time come back. This is public so we can write unit tests which wait long enough
45
    /// for the FileManager to timeout.
Beat Küng's avatar
Beat Küng committed
46
47
48
    static const int ackTimerTimeoutMsecs = 50;

    static const int ackTimerMaxRetries = 6;
49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
	/// Downloads the specified file.
	///     @param from File to download from UAS, fully qualified path
	///     @param downloadDir Local directory to download file to
	void downloadPath(const QString& from, const QDir& downloadDir);
	
	/// Stream downloads the specified file.
	///     @param from File to download from UAS, fully qualified path
	///     @param downloadDir Local directory to download file to
	void streamPath(const QString& from, const QDir& downloadDir);
	
	/// Lists the specified directory. Emits listEntry signal for each entry, followed by listComplete signal.
	///		@param dirPath Fully qualified path to list
	void listDirectory(const QString& dirPath);
	
64
65
66
    /// Upload the specified file to the specified location
    void uploadPath(const QString& toPath, const QFileInfo& uploadFile);
    
67
68
69
    /// Create a remote directory
    void createDirectory(const QString& directory);

70
signals:
71
72
    // Signals associated with the listDirectory method
    
Don Gagne's avatar
Don Gagne committed
73
    /// Signalled to indicate a new directory entry was received.
74
75
    void listEntry(const QString& entry);
    
Don Gagne's avatar
Don Gagne committed
76
    // Signals associated with all commands
77
    
Don Gagne's avatar
Don Gagne committed
78
79
    /// Signalled after a command has completed
    void commandComplete(void);
80
    
Don Gagne's avatar
Don Gagne committed
81
82
83
    /// Signalled when an error occurs during a command. In this case a commandComplete signal will
    /// not be sent.
    void commandError(const QString& msg);
84
    
Don Gagne's avatar
Don Gagne committed
85
86
87
    /// Signalled during a lengthy command to show progress
    ///     @param value Amount of progress: 0.0 = none, 1.0 = complete
    void commandProgress(int value);
88

89
public slots:
90
    void receiveMessage(mavlink_message_t message);
91
92
93
	
private slots:
	void _ackTimeout(void);
94

95
private:
96
97
98
99
100
    /// @brief This is the fixed length portion of the protocol data.
    /// This needs to be packed, because it's typecasted from mavlink_file_transfer_protocol_t.payload, which starts
    /// at a 3 byte offset, causing an unaligned access to seq_number and offset
    PACKED_STRUCT(
    typedef struct _RequestHeader
Lorenz Meier's avatar
Lorenz Meier committed
101
        {
102
103
104
105
106
107
108
109
            uint16_t    seqNumber;      ///< sequence number for message
            uint8_t     session;        ///< Session id for read and write commands
            uint8_t     opcode;         ///< Command opcode
            uint8_t     size;           ///< Size of data
            uint8_t     req_opcode;     ///< Request opcode returned in kRspAck, kRspNak message
            uint8_t     burstComplete;  ///< Only used if req_opcode=kCmdBurstReadFile - 1: set of burst packets complete, 0: More burst packets coming.
            uint8_t     padding;        ///< 32 bit aligment padding
            uint32_t    offset;         ///< Offsets for List and Read commands
110
        }) RequestHeader;
Lorenz Meier's avatar
Lorenz Meier committed
111

112
113
    PACKED_STRUCT(
    typedef struct _Request
Don Gagne's avatar
Don Gagne committed
114
    {
115
        RequestHeader hdr;
116

117
        // We use a union here instead of just casting (uint32_t)&payload[0] to not break strict aliasing rules
118
        union {
119
            // The entire Request must fit into the payload member of the mavlink_file_transfer_protocol_t structure. We use as many leftover bytes
120
            // after we use up space for the RequestHeader for the data portion of the Request.
121
            uint8_t data[sizeof(((mavlink_file_transfer_protocol_t*)0)->payload) - sizeof(RequestHeader)];
122
			
123
124
            // File length returned by Open command
            uint32_t openFileLength;
125
126
127

            // Length of file chunk written by write command
            uint32_t writeFileLength;
128
        };
129
    }) Request;
Don Gagne's avatar
Don Gagne committed
130

none's avatar
none committed
131
    enum Opcode
132
	{
133
		kCmdNone,				///< ignored, always acked
134
		kCmdTerminateSession,	///< Terminates open Read session
135
136
137
138
139
140
141
		kCmdResetSessions,		///< Terminates all open Read sessions
		kCmdListDirectory,		///< List files in <path> from <offset>
		kCmdOpenFileRO,			///< Opens file at <path> for reading, returns <session>
		kCmdReadFile,			///< Reads <size> bytes from <offset> in <session>
		kCmdCreateFile,			///< Creates file at <path> for writing, returns <session>
		kCmdWriteFile,			///< Writes <size> bytes to <offset> in <session>
		kCmdRemoveFile,			///< Remove file at <path>
142
143
		kCmdCreateDirectory,	///< Creates directory at <path>
		kCmdRemoveDirectory,	///< Removes Directory at <path>, must be empty
144
145
146
147
148
		kCmdOpenFileWO,			///< Opens file at <path> for writing, returns <session>
		kCmdTruncateFile,		///< Truncate file at <path> to <offset> length
		kCmdRename,				///< Rename <path1> to <path2>
		kCmdCalcFileCRC32,		///< Calculate CRC32 for file at <path>
		kCmdBurstReadFile,      ///< Burst download session file
149
		
150
		kRspAck = 128,          ///< Ack response
151
		kRspNak,                ///< Nak response
none's avatar
none committed
152

153
154
155
156
157
158
159
160
161
162
163
164
165
166
        // Used for testing only, not part of protocol
        kCmdTestNoAck,          ///< ignored, ack not sent back, should timeout waiting for ack
	};
	
	/// @brief Error codes returned in Nak response PayloadHeader.data[0].
	enum ErrorCode
    {
		kErrNone,
		kErrFail,                   ///< Unknown failure
		kErrFailErrno,              ///< errno sent back in PayloadHeader.data[1]
		kErrInvalidDataSize,		///< PayloadHeader.size is invalid
		kErrInvalidSession,         ///< Session is not currently open
		kErrNoSessionsAvailable,	///< All available Sessions in use
		kErrEOF,                    ///< Offset past end of file for List and Read commands
167
168
169
        kErrUnknownCommand,          ///< Unknown command opcode
        kErrFailFileExists,         ///< File exists already
        kErrFailFileProtected       ///< File is write protected
170
    };
none's avatar
none committed
171
172
173

    enum OperationState
        {
174
175
176
177
            kCOIdle,		// not doing anything
            kCOAck,			// waiting for an Ack
            kCOList,		// waiting for List response
            kCOOpenRead,    // waiting for Open response followed by Read download
Don Gagne's avatar
Don Gagne committed
178
			kCOOpenBurst,   // waiting for Open response, followed by Burst download
179
180
181
            kCORead,		// waiting for Read response
			kCOBurst,		// waiting for Burst response
            kCOWrite,       // waiting for Write response
182
            kCOCreate,      // waiting for Create response
183
            kCOCreateDir,   // waiting for Create Directory response
none's avatar
none committed
184
        };
Don Gagne's avatar
Don Gagne committed
185
186
187
188
189
    
    bool _sendOpcodeOnlyCmd(uint8_t opcode, OperationState newOpState);
    void _setupAckTimeout(void);
    void _clearAckTimeout(void);
    void _emitErrorMessage(const QString& msg);
190
    void _emitListEntry(const QString& entry);
Don Gagne's avatar
Don Gagne committed
191
    void _sendRequest(Request* request);
Beat Küng's avatar
Beat Küng committed
192
    void _sendRequestNoAck(Request* request);
193
    void _fillRequestWithString(Request* request, const QString& str);
194
    void _openAckResponse(Request* openAck);
195
    void _downloadAckResponse(Request* readAck, bool readFile);
196
    void _listAckResponse(Request* listAck);
197
198
199
    void _createAckResponse(Request* createAck);
    void _writeAckResponse(Request* writeAck);
    void _writeFileDatablock(void);
200
    void _sendListCommand(void);
Don Gagne's avatar
Don Gagne committed
201
    void _sendResetCommand(void);
202
    void _closeDownloadSession(bool success);
Don Gagne's avatar
Don Gagne committed
203
    void _closeUploadSession(bool success);
204
205
    void _downloadWorker(const QString& from, const QDir& downloadDir, bool readFile);
    void _requestMissingData();
206
    
none's avatar
none committed
207
    static QString errorString(uint8_t errorCode);
208

209
210
    OperationState  _currentOperation;              ///< Current operation of state machine
    QTimer          _ackTimer;                      ///< Used to signal a timeout waiting for an ack
Beat Küng's avatar
Beat Küng committed
211
    int             _ackNumTries;                   ///< current number of tries
Don Gagne's avatar
Don Gagne committed
212
    
213
214
    Vehicle*        _vehicle;
    LinkInterface*  _dedicatedLink; ///< Link to use for communication
Don Gagne's avatar
Don Gagne committed
215
    
Beat Küng's avatar
Beat Küng committed
216
    Request  _lastOutgoingRequest; ///< contains the last outgoing packet
Don Gagne's avatar
Don Gagne committed
217

218
219
220
221
    unsigned    _listOffset;    ///< offset for the current List operation
    QString     _listPath;      ///< path for the current List operation
    
    uint8_t     _activeSession;             ///< currently active session, 0 for none
Don Gagne's avatar
Don Gagne committed
222
    
223
    uint32_t    _readOffset;                ///< current read offset
Don Gagne's avatar
Don Gagne committed
224
    
225
226
    uint32_t    _writeOffset;               ///< current write offset
    uint32_t    _writeSize;                 ///< current write data size
Don Gagne's avatar
Don Gagne committed
227
228
229
    uint32_t    _writeFileSize;             ///< Size of file being uploaded
    QByteArray  _writeFileAccumulator;      ///< Holds file being uploaded
    
230
231
232
233
    struct MissingData {
        uint32_t offset;
        uint32_t size;
    };
234
    uint32_t    _downloadOffset;            ///< current download offset
235
236
237
    uint32_t    _missingDownloadedBytes;    ///< number of missing bytes for burst download
    QQueue<MissingData> _missingData;       ///< missing chunks of downloaded file (for burst downloads)
    bool        _downloadingMissingParts;   ///< true if we are currently downloading missing parts
238
239
240
    QByteArray  _readFileAccumulator;       ///< Holds file being downloaded
    QDir        _readFileDownloadDir;       ///< Directory to download file to
    QString     _readFileDownloadFilename;  ///< Filename (no path) for download file
Don Gagne's avatar
Don Gagne committed
241
    uint32_t    _downloadFileSize;          ///< Size of file being downloaded
242

243
244
    uint8_t     _systemIdQGC;               ///< System ID for QGC
    uint8_t     _systemIdServer;            ///< System ID for server
Don Gagne's avatar
Don Gagne committed
245
    
Don Gagne's avatar
Don Gagne committed
246
    // We give MockLinkFileServer friend access so that it can use the data structures and opcodes
Don Gagne's avatar
Don Gagne committed
247
    // to build a mock mavlink file server for testing.
Don Gagne's avatar
Don Gagne committed
248
    friend class MockLinkFileServer;
249
250
};

251
#endif // FileManager_H