QGCUASFileManager.cc 16 KB
Newer Older
1
/*=====================================================================
2

3
 QGroundControl Open Source Ground Control Station
4

5
 (c) 2009 - 2014 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
6

7
 This file is part of the QGROUNDCONTROL project
8

9 10 11 12
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
13

14 15 16 17
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
18

19 20
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
21

22 23
 ======================================================================*/

24 25
#include "QGCUASFileManager.h"
#include "QGC.h"
Lorenz Meier's avatar
Lorenz Meier committed
26
#include "MAVLinkProtocol.h"
27
#include "MainWindow.h"
Lorenz Meier's avatar
Lorenz Meier committed
28 29 30

#include <QFile>
#include <QDir>
none's avatar
none committed
31
#include <string>
Lorenz Meier's avatar
Lorenz Meier committed
32

33

34
QGCUASFileManager::QGCUASFileManager(QObject* parent, UASInterface* uas, uint8_t unitTestSystemIdQGC) :
35
    QObject(parent),
36
    _currentOperation(kCOIdle),
Lorenz Meier's avatar
Lorenz Meier committed
37
    _mav(uas),
38
    _lastOutgoingSeqNumber(0),
39 40
    _activeSession(0),
    _systemIdQGC(unitTestSystemIdQGC)
Lorenz Meier's avatar
Lorenz Meier committed
41
{
42 43 44
    connect(&_ackTimer, &QTimer::timeout, this, &QGCUASFileManager::_ackTimeout);
    
    _systemIdServer = _mav->getUASID();
45 46
    
    // Make sure we don't have bad structure packing
47
    Q_ASSERT(sizeof(RequestHeader) == 12);
Lorenz Meier's avatar
Lorenz Meier committed
48 49
}

50 51
/// @brief Respond to the Ack associated with the Open command with the next Read command.
void QGCUASFileManager::_openAckResponse(Request* openAck)
52 53 54
{
    _currentOperation = kCORead;
    _activeSession = openAck->hdr.session;
55 56 57
    
    // File length comes back in data
    Q_ASSERT(openAck->hdr.size == sizeof(uint32_t));
58 59 60
    emit downloadFileLength(openAck->openFileLength);
    
    // Start the sequence of read commands
61

62 63
    _readOffset = 0;                // Start reading at beginning of file
    _readFileAccumulator.clear();   // Start with an empty file
64

65 66
    Request request;
    request.hdr.session = _activeSession;
67
    request.hdr.opcode = kCmdReadFile;
68 69
    request.hdr.offset = _readOffset;
    request.hdr.size = sizeof(request.data);
70

71 72 73
    _sendRequest(&request);
}

74 75 76 77 78 79
/// @brief Closes out a read session by writing the file and doing cleanup.
///     @param success true: successful download completion, false: error during download
void QGCUASFileManager::_closeReadSession(bool success)
{
    if (success) {
        QString downloadFilePath = _readFileDownloadDir.absoluteFilePath(_readFileDownloadFilename);
80

81 82 83 84 85
        QFile file(downloadFilePath);
        if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
            _emitErrorMessage(tr("Unable to open local file for writing (%1)").arg(downloadFilePath));
            return;
        }
86

87 88 89 90 91 92 93
        qint64 bytesWritten = file.write((const char *)_readFileAccumulator, _readFileAccumulator.length());
        if (bytesWritten != _readFileAccumulator.length()) {
            file.close();
            _emitErrorMessage(tr("Unable to write data to local file (%1)").arg(downloadFilePath));
            return;
        }
        file.close();
94

95
        emit downloadFileComplete();
96
    }
97

98 99 100 101
    // Close the open session
    _sendTerminateCommand();
}

102
/// @brief Respond to the Ack associated with the Read command.
103
void QGCUASFileManager::_readAckResponse(Request* readAck)
104 105 106 107 108 109 110
{
    if (readAck->hdr.session != _activeSession) {
        _currentOperation = kCOIdle;
        _readFileAccumulator.clear();
        _emitErrorMessage(tr("Read: Incorrect session returned"));
        return;
    }
111

112 113 114 115 116 117 118 119
    if (readAck->hdr.offset != _readOffset) {
        _currentOperation = kCOIdle;
        _readFileAccumulator.clear();
        _emitErrorMessage(tr("Read: Offset returned (%1) differs from offset requested (%2)").arg(readAck->hdr.offset).arg(_readOffset));
        return;
    }

    _readFileAccumulator.append((const char*)readAck->data, readAck->hdr.size);
120
    emit downloadFileProgress(_readFileAccumulator.length());
121

122 123
    if (readAck->hdr.size == sizeof(readAck->data)) {
        // Possibly still more data to read, send next read request
124

125
        _currentOperation = kCORead;
126

127
        _readOffset += readAck->hdr.size;
128

129 130
        Request request;
        request.hdr.session = _activeSession;
131
        request.hdr.opcode = kCmdReadFile;
132
        request.hdr.offset = _readOffset;
133
        request.hdr.size = 0;
134

135 136
        _sendRequest(&request);
    } else {
137
        // We only receieved a partial buffer back. These means we are at EOF
138
        _currentOperation = kCOIdle;
139
        _closeReadSession(true /* success */);
140 141 142 143 144 145 146 147 148 149 150
    }
}

/// @brief Respond to the Ack associated with the List command.
void QGCUASFileManager::_listAckResponse(Request* listAck)
{
    if (listAck->hdr.offset != _listOffset) {
        _currentOperation = kCOIdle;
        _emitErrorMessage(tr("List: Offset returned (%1) differs from offset requested (%2)").arg(listAck->hdr.offset).arg(_listOffset));
        return;
    }
151

152 153 154
    uint8_t offset = 0;
    uint8_t cListEntries = 0;
    uint8_t cBytes = listAck->hdr.size;
155

156 157 158
    // parse filenames out of the buffer
    while (offset < cBytes) {
        const char * ptr = ((const char *)listAck->data) + offset;
159

160 161
        // get the length of the name
        uint8_t cBytesLeft = cBytes - offset;
Don Gagne's avatar
Don Gagne committed
162
        uint8_t nlen = static_cast<uint8_t>(strnlen(ptr, cBytesLeft));
163
        if ((*ptr == 'S' && nlen > 1) || (*ptr != 'S' && nlen < 2)) {
164 165 166 167 168 169 170 171
            _currentOperation = kCOIdle;
            _emitErrorMessage(tr("Incorrectly formed list entry: '%1'").arg(ptr));
            return;
        } else if (nlen == cBytesLeft) {
            _currentOperation = kCOIdle;
            _emitErrorMessage(tr("Missing NULL termination in list entry"));
            return;
        }
172

173
        // Returned names are prepended with D for directory, F for file, S for skip
174 175
        if (*ptr == 'F' || *ptr == 'D') {
            // put it in the view
176
            _emitListEntry(ptr);
177 178
        } else if (*ptr == 'S') {
            // do nothing
179 180
        } else {
            qDebug() << "unknown entry" << ptr;
181
        }
182

183 184
        // account for the name + NUL
        offset += nlen + 1;
185

186 187 188
        cListEntries++;
    }

189 190 191 192
    if (listAck->hdr.size == 0) {
        // Directory is empty, we're done
        Q_ASSERT(listAck->hdr.opcode == kRspAck);
        _currentOperation = kCOIdle;
Don Gagne's avatar
Don Gagne committed
193
        emit listComplete();
194 195
    } else {
        // Possibly more entries to come, need to keep trying till we get EOF
196 197 198
        _currentOperation = kCOList;
        _listOffset += cListEntries;
        _sendListCommand();
199 200 201
    }
}

Lorenz Meier's avatar
Lorenz Meier committed
202 203
void QGCUASFileManager::receiveMessage(LinkInterface* link, mavlink_message_t message)
{
204
    Q_UNUSED(link);
205

206 207
    // receiveMessage is signalled will all mavlink messages so we need to filter everything else out but ours.
    if (message.msgid != MAVLINK_MSG_ID_FILE_TRANSFER_PROTOCOL) {
208 209
        return;
    }
210
    
211 212 213 214 215 216
    mavlink_file_transfer_protocol_t data;
    mavlink_msg_file_transfer_protocol_decode(&message, &data);
    
    // Make sure we are the target system
    if (data.target_system != _systemIdQGC) {
        qDebug() << "Received MAVLINK_MSG_ID_FILE_TRANSFER_PROTOCOL with possibly incorrect system id" << _systemIdQGC;
217 218
        return;
    }
219 220 221
    
    Request* request = (Request*)&data.payload[0];
    
222 223
    _clearAckTimeout();
    
224
    uint16_t incomingSeqNumber = request->hdr.seqNumber;
225 226 227 228 229 230 231 232 233 234 235
    
    // Make sure we have a good sequence number
    uint16_t expectedSeqNumber = _lastOutgoingSeqNumber + 1;
    if (incomingSeqNumber != expectedSeqNumber) {
        _currentOperation = kCOIdle;
        _emitErrorMessage(tr("Bad sequence number on received message: expected(%1) received(%2)").arg(expectedSeqNumber).arg(incomingSeqNumber));
        return;
    }
    
    // Move past the incoming sequence number for next request
    _lastOutgoingSeqNumber = incomingSeqNumber;
236

237
    if (request->hdr.opcode == kRspAck) {
238

239 240 241 242 243
        switch (_currentOperation) {
            case kCOIdle:
                // we should not be seeing anything here.. shut the other guy up
                _sendCmdReset();
                break;
244

245 246 247 248
            case kCOAck:
                // We are expecting an ack back
                _currentOperation = kCOIdle;
                break;
249

250
            case kCOList:
251
                _listAckResponse(request);
252
                break;
253

254
            case kCOOpen:
255
                _openAckResponse(request);
256
                break;
257

258
            case kCORead:
259
                _readAckResponse(request);
260 261
                break;

262
            default:
Don Gagne's avatar
Don Gagne committed
263
                _emitErrorMessage(tr("Ack received in unexpected state"));
264 265 266
                break;
        }
    } else if (request->hdr.opcode == kRspNak) {
267

268 269
        OperationState previousOperation = _currentOperation;
        uint8_t errorCode = request->data[0];
270

271 272 273
        // Nak's normally have 1 byte of data for error code, except for kErrFailErrno which has additional byte for errno
        Q_ASSERT((errorCode == kErrFailErrno && request->hdr.size == 2) || request->hdr.size == 1);
        
274
        _currentOperation = kCOIdle;
275

276 277
        if (previousOperation == kCOList && errorCode == kErrEOF) {
            // This is not an error, just the end of the read loop
Don Gagne's avatar
Don Gagne committed
278
            emit listComplete();
279 280 281 282 283 284 285 286 287 288 289 290 291
            return;
        } else if (previousOperation == kCORead && errorCode == kErrEOF) {
            // This is not an error, just the end of the read loop
            _closeReadSession(true /* success */);
            return;
        } else {
            // Generic Nak handling
            if (previousOperation == kCORead) {
                // Nak error during read loop, download failed
                _closeReadSession(false /* failure */);
            }
            _emitErrorMessage(tr("Nak received, error: %1").arg(errorString(request->data[0])));
        }
292 293 294
    } else {
        // Note that we don't change our operation state. If something goes wrong beyond this, the operation
        // will time out.
295
        _emitErrorMessage(tr("Unknown opcode returned from server: %1").arg(request->hdr.opcode));
Lorenz Meier's avatar
Lorenz Meier committed
296 297 298
    }
}

299
void QGCUASFileManager::listDirectory(const QString& dirPath)
Lorenz Meier's avatar
Lorenz Meier committed
300
{
301 302 303
    if (_currentOperation != kCOIdle) {
        _emitErrorMessage(tr("Command not sent. Waiting for previous command to complete."));
        return;
none's avatar
none committed
304 305 306
    }

    // initialise the lister
307
    _listPath = dirPath;
308 309
    _listOffset = 0;
    _currentOperation = kCOList;
none's avatar
none committed
310 311

    // and send the initial request
312
    _sendListCommand();
none's avatar
none committed
313 314
}

315 316 317
void QGCUASFileManager::_fillRequestWithString(Request* request, const QString& str)
{
    strncpy((char *)&request->data[0], str.toStdString().c_str(), sizeof(request->data));
Don Gagne's avatar
Don Gagne committed
318
    request->hdr.size = static_cast<uint8_t>(strnlen((const char *)&request->data[0], sizeof(request->data)));
319 320
}

321
void QGCUASFileManager::_sendListCommand(void)
none's avatar
none committed
322
{
323
    Request request;
none's avatar
none committed
324

325
    request.hdr.session = 0;
326
    request.hdr.opcode = kCmdListDirectory;
327
    request.hdr.offset = _listOffset;
328
    request.hdr.size = 0;
329

330
    _fillRequestWithString(&request, _listPath);
331

332
    _sendRequest(&request);
Lorenz Meier's avatar
Lorenz Meier committed
333 334
}

335 336 337 338
/// @brief Downloads the specified file.
///     @param from File to download from UAS, fully qualified path
///     @param downloadDir Local directory to download file to
void QGCUASFileManager::downloadPath(const QString& from, const QDir& downloadDir)
Lorenz Meier's avatar
Lorenz Meier committed
339
{
340 341 342
    if (from.isEmpty()) {
        return;
    }
343

344
    _readFileDownloadDir.setPath(downloadDir.absolutePath());
345

346 347 348 349 350 351 352 353 354 355
    // We need to strip off the file name from the fully qualified path. We can't use the usual QDir
    // routines because this path does not exist locally.
    int i;
    for (i=from.size()-1; i>=0; i--) {
        if (from[i] == '/') {
            break;
        }
    }
    i++; // move past slash
    _readFileDownloadFilename = from.right(from.size() - i);
356

357
    _currentOperation = kCOOpen;
Lorenz Meier's avatar
Lorenz Meier committed
358

359 360
    Request request;
    request.hdr.session = 0;
361
    request.hdr.opcode = kCmdOpenFile;
362
    request.hdr.offset = 0;
363
    request.hdr.size = 0;
364 365
    _fillRequestWithString(&request, from);
    _sendRequest(&request);
366
}
none's avatar
none committed
367 368 369 370

QString QGCUASFileManager::errorString(uint8_t errorCode)
{
    switch(errorCode) {
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
        case kErrNone:
            return QString("no error");
        case kErrFail:
            return QString("unknown error");
        case kErrEOF:
            return QString("read beyond end of file");
        case kErrUnknownCommand:
            return QString("unknown command");
        case kErrFailErrno:
            return QString("command failed");
        case kErrInvalidDataSize:
            return QString("invalid data size");
        case kErrInvalidSession:
            return QString("invalid session");
        case kErrNoSessionsAvailable:
            return QString("no sessions availble");
        default:
            return QString("unknown error code");
none's avatar
none committed
389 390
    }
}
391 392 393 394 395 396 397 398 399 400 401

/// @brief Sends a command which only requires an opcode and no additional data
///     @param opcode Opcode to send
///     @param newOpState State to put state machine into
/// @return TRUE: command sent, FALSE: command not sent, waiting for previous command to finish
bool QGCUASFileManager::_sendOpcodeOnlyCmd(uint8_t opcode, OperationState newOpState)
{
    if (_currentOperation != kCOIdle) {
        // Can't have multiple commands in play at the same time
        return false;
    }
402

403 404 405 406 407
    Request request;
    request.hdr.session = 0;
    request.hdr.opcode = opcode;
    request.hdr.offset = 0;
    request.hdr.size = 0;
408

409
    _currentOperation = newOpState;
410

411
    _sendRequest(&request);
412

413
    return true;
414 415 416 417 418 419
}

/// @brief Starts the ack timeout timer
void QGCUASFileManager::_setupAckTimeout(void)
{
    Q_ASSERT(!_ackTimer.isActive());
420

421
    _ackTimer.setSingleShot(true);
Don Gagne's avatar
Don Gagne committed
422
    _ackTimer.start(ackTimerTimeoutMsecs);
423 424 425 426 427 428 429 430 431 432 433
}

/// @brief Clears the ack timeout timer
void QGCUASFileManager::_clearAckTimeout(void)
{
    _ackTimer.stop();
}

/// @brief Called when ack timeout timer fires
void QGCUASFileManager::_ackTimeout(void)
{
Don Gagne's avatar
Don Gagne committed
434 435 436
    // Make sure to set _currentOperation state before emitting error message. Code may respond
    // to error message signal by sending another command, which will fail if state is not back
    // to idle. FileView UI works this way with the List command.
437 438 439 440

    switch (_currentOperation) {
        case kCORead:
            _currentOperation = kCOAck;
Don Gagne's avatar
Don Gagne committed
441
            _emitErrorMessage(tr("Timeout waiting for ack: Sending Terminate command"));
442 443 444 445
            _sendTerminateCommand();
            break;
        default:
            _currentOperation = kCOIdle;
Don Gagne's avatar
Don Gagne committed
446
            _emitErrorMessage(tr("Timeout waiting for ack"));
447 448 449 450 451 452 453 454
            break;
    }
}

void QGCUASFileManager::_sendTerminateCommand(void)
{
    Request request;
    request.hdr.session = _activeSession;
455
    request.hdr.opcode = kCmdTerminateSession;
456
    request.hdr.size = 0;
457
    _sendRequest(&request);
458 459 460 461
}

void QGCUASFileManager::_emitErrorMessage(const QString& msg)
{
462
    qDebug() << "QGCUASFileManager: Error" << msg;
463 464 465
    emit errorMessage(msg);
}

466
void QGCUASFileManager::_emitListEntry(const QString& entry)
467
{
468 469
    qDebug() << "QGCUASFileManager: list entry" << entry;
    emit listEntry(entry);
470 471
}

472 473 474 475
/// @brief Sends the specified Request out to the UAS.
void QGCUASFileManager::_sendRequest(Request* request)
{
    mavlink_message_t message;
476

477
    _setupAckTimeout();
478 479
    
    _lastOutgoingSeqNumber++;
480

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    request->hdr.seqNumber = _lastOutgoingSeqNumber;
    
    if (_systemIdQGC == 0) {
        _systemIdQGC = MainWindow::instance()->getMAVLink()->getSystemId();
    }
    
    Q_ASSERT(_mav);
    mavlink_msg_file_transfer_protocol_pack(_systemIdQGC,       // QGC System ID
                                            0,                  // QGC Component ID
                                            &message,           // Mavlink Message to pack into
                                            0,                  // Target network
                                            _systemIdServer,    // Target system
                                            0,                  // Target component
                                            (uint8_t*)request); // Payload
    
496
    _mav->sendMessage(message);
Lorenz Meier's avatar
Lorenz Meier committed
497
}