9#include <QtCore/QFileInfo>
19 _ackOrNakTimeoutTimer.setSingleShot(
true);
21 _ackOrNakTimeoutTimer.setInterval(
QGC::runningUnitTests() ? kTestAckTimeoutMs : _ackOrNakTimeoutMsecs);
22 connect(&_ackOrNakTimeoutTimer, &QTimer::timeout,
this, &FTPManager::_ackOrNakTimeout);
25 Q_ASSERT(
sizeof(MavlinkFTP::RequestHeader) == 12);
30bool FTPManager::download(uint8_t fromCompId,
const QString& fromURI,
const QString& toDir,
const QString& fileName,
bool checksize)
32 qCDebug(FTPManagerLog) <<
"Download fromCompId:" << fromCompId
33 <<
"fromURI:" << fromURI
35 <<
"fileName:" << fileName;
37 if (!_rgStateMachine.isEmpty()) {
38 qCDebug(FTPManagerLog) <<
"Cannot download. Already in another operation";
42 static const StateFunctions_t rgDownloadStateMachine[] = {
43 { &FTPManager::_openFileROBegin, &FTPManager::_openFileROAckOrNak, &FTPManager::_openFileROTimeout },
44 { &FTPManager::_burstReadFileBegin, &FTPManager::_burstReadFileAckOrNak, &FTPManager::_burstReadFileTimeout },
45 { &FTPManager::_fillMissingBlocksBegin, &FTPManager::_fillMissingBlocksAckOrNak, &FTPManager::_fillMissingBlocksTimeout },
46 { &FTPManager::_resetSessionsBegin, &FTPManager::_resetSessionsAckOrNak, &FTPManager::_resetSessionsTimeout },
47 { &FTPManager::_downloadCompleteNoError,
nullptr,
nullptr },
49 for (
size_t i=0; i<
sizeof(rgDownloadStateMachine)/
sizeof(rgDownloadStateMachine[0]); i++) {
50 _rgStateMachine.append(rgDownloadStateMachine[i]);
53 _downloadState.reset();
54 _downloadState.toDir.setPath(toDir);
55 _downloadState.checksize = checksize;
57 if (!_parseURI(fromCompId, fromURI, _downloadState.fullPathOnVehicle, _ftpCompId)) {
58 qCWarning(FTPManagerLog) <<
"_parseURI failed";
64 int lastDirSlashIndex;
65 for (lastDirSlashIndex=_downloadState.fullPathOnVehicle.size()-1; lastDirSlashIndex>=0; lastDirSlashIndex--) {
66 if (_downloadState.fullPathOnVehicle[lastDirSlashIndex] ==
'/') {
72 if (fileName.isEmpty()) {
73 _downloadState.fileName = _downloadState.fullPathOnVehicle.right(_downloadState.fullPathOnVehicle.size() - lastDirSlashIndex);
75 _downloadState.fileName = fileName;
78 qCDebug(FTPManagerLog) <<
"_downloadState.fullPathOnVehicle:_downloadState.fileName" << _downloadState.fullPathOnVehicle << _downloadState.fileName;
87 qCDebug(FTPManagerLog) <<
"upload fromFile:" << fromFile <<
"toURI:" << toURI <<
"toCompId:" << toCompId;
89 if (!_rgStateMachine.isEmpty()) {
90 qCDebug(FTPManagerLog) <<
"Cannot upload. Already in another operation";
94 QFileInfo sourceInfo(fromFile);
95 if (!sourceInfo.exists() || !sourceInfo.isFile()) {
96 qCWarning(FTPManagerLog) <<
"Cannot upload. Source file missing" << fromFile;
100 if (sourceInfo.size() > std::numeric_limits<uint32_t>::max()) {
101 qCWarning(FTPManagerLog) <<
"Cannot upload. File too large" << fromFile << sourceInfo.size();
105 _uploadState.reset();
106 _uploadState.localFilePath = fromFile;
107 _uploadState.file.setFileName(fromFile);
108 if (!_uploadState.file.open(QFile::ReadOnly)) {
109 qCWarning(FTPManagerLog) <<
"Cannot upload. Failed to open file" << fromFile << _uploadState.file.errorString();
110 _uploadState.reset();
114 _uploadState.fileSize =
static_cast<uint32_t
>(sourceInfo.size());
115 _uploadState.totalBytesSent = 0;
116 _uploadState.lastChunkSize = 0;
117 _uploadState.retryCount = 0;
118 _uploadState.sessionId = 0;
119 _uploadState.cancelled =
false;
121 if (!_parseURI(toCompId, toURI, _uploadState.fullPathOnVehicle, _ftpCompId)) {
122 qCWarning(FTPManagerLog) <<
"_parseURI failed";
123 _uploadState.reset();
127 static const StateFunctions_t rgUploadStateMachine[] = {
128 { &FTPManager::_createFileBegin, &FTPManager::_createFileAckOrNak, &FTPManager::_createFileTimeout },
129 { &FTPManager::_writeFileBegin, &FTPManager::_writeFileAckOrNak, &FTPManager::_writeFileTimeout },
130 { &FTPManager::_resetSessionsBegin, &FTPManager::_resetSessionsAckOrNak, &FTPManager::_resetSessionsTimeout },
131 { &FTPManager::_uploadFinalize,
nullptr,
nullptr },
133 for (
size_t i=0; i<
sizeof(rgUploadStateMachine)/
sizeof(rgUploadStateMachine[0]); i++) {
134 _rgStateMachine.append(rgUploadStateMachine[i]);
137 _startStateMachine();
144 qCDebug(FTPManagerLog) <<
"list directory fromURI:" << fromURI <<
"fromCompId:" << fromCompId;
146 if (!_rgStateMachine.isEmpty()) {
147 qCDebug(FTPManagerLog) <<
"Cannot list directory. Already in another operation";
151 static const StateFunctions_t rgStateMachine[] = {
152 { &FTPManager::_listDirectoryBegin, &FTPManager::_listDirectoryAckOrNak, &FTPManager::_listDirectoryTimeout },
153 { &FTPManager::_listDirectoryCompleteNoError,
nullptr,
nullptr },
155 for (
size_t i=0; i<
sizeof(rgStateMachine)/
sizeof(rgStateMachine[0]); i++) {
156 _rgStateMachine.append(rgStateMachine[i]);
159 _listDirectoryState.reset();
162 _listDirectoryState.opCode = (_listDirWithTimeSupport == WithTimeSupport_t::Unsupported)
166 if (!_parseURI(fromCompId, fromURI, _listDirectoryState.fullPathOnVehicle, _ftpCompId)) {
167 qCWarning(FTPManagerLog) <<
"_parseURI failed";
171 qCDebug(FTPManagerLog) <<
"_listDirectoryState.fullPathOnVehicle" << _listDirectoryState.fullPathOnVehicle;
173 _startStateMachine();
180 qCDebug(FTPManagerLog) <<
"delete file fromURI:" << fromURI <<
"fromCompId:" << fromCompId;
182 if (!_rgStateMachine.isEmpty()) {
183 qCDebug(FTPManagerLog) <<
"Cannot delete file. Already in another operation";
187 static const StateFunctions_t rgStateMachine[] = {
188 { &FTPManager::_deleteFileBegin, &FTPManager::_deleteFileAckOrNak, &FTPManager::_deleteFileTimeout },
189 { &FTPManager::_deleteCompleteNoError,
nullptr,
nullptr },
191 for (
size_t i=0; i<
sizeof(rgStateMachine)/
sizeof(rgStateMachine[0]); i++) {
192 _rgStateMachine.append(rgStateMachine[i]);
195 _deleteState.reset();
197 if (!_parseURI(fromCompId, fromURI, _deleteState.fullPathOnVehicle, _ftpCompId)) {
198 qCWarning(FTPManagerLog) <<
"_parseURI failed";
199 _rgStateMachine.clear();
203 qCDebug(FTPManagerLog) <<
"_deleteState.fullPathOnVehicle" << _deleteState.fullPathOnVehicle;
205 _startStateMachine();
212 if (!_downloadState.inProgress()) {
216 _ackOrNakTimeoutTimer.stop();
217 _rgStateMachine.clear();
218 static const StateFunctions_t rgTerminateStateMachine[] = {
219 { &FTPManager::_terminateSessionBegin, &FTPManager::_terminateSessionAckOrNak, &FTPManager::_terminateSessionTimeout },
220 { &FTPManager::_terminateComplete,
nullptr,
nullptr },
222 for (
size_t i=0; i<
sizeof(rgTerminateStateMachine)/
sizeof(rgTerminateStateMachine[0]); i++) {
223 _rgStateMachine.append(rgTerminateStateMachine[i]);
225 _downloadState.retryCount = 0;
226 _startStateMachine();
231 if (!_listDirectoryState.inProgress()) {
235 if (_rgStateMachine.isEmpty()) {
239 _listDirectoryComplete(tr(
"Aborted"));
244 if (!_uploadState.inProgress()) {
248 _uploadState.cancelled =
true;
249 _ackOrNakTimeoutTimer.stop();
250 _rgStateMachine.clear();
252 if (_uploadState.sessionId != 0) {
253 static const StateFunctions_t rgTerminateStateMachine[] = {
254 { &FTPManager::_terminateUploadSessionBegin, &FTPManager::_terminateUploadSessionAckOrNak, &FTPManager::_terminateUploadSessionTimeout },
255 { &FTPManager::_uploadFinalize,
nullptr,
nullptr },
257 for (
size_t i=0; i<
sizeof(rgTerminateStateMachine)/
sizeof(rgTerminateStateMachine[0]); i++) {
258 _rgStateMachine.append(rgTerminateStateMachine[i]);
260 _uploadState.retryCount = 0;
261 _startStateMachine();
263 _uploadComplete(tr(
"Aborted"));
269 if (!_deleteState.inProgress()) {
273 _deleteComplete(tr(
"Aborted"));
276void FTPManager::_terminateSessionBegin(
void)
278 MavlinkFTP::Request request{};
279 request.hdr.session = _downloadState.sessionId;
281 _sendRequestExpectAck(&request);
284void FTPManager::_terminateSessionAckOrNak(
const MavlinkFTP::Request *ackOrNak)
288 qCDebug(FTPManagerLog) <<
"_terminateSessionAckOrNak: Ack disregarding ack for incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
291 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
292 qCDebug(FTPManagerLog) <<
"_terminateSessionAckOrNak: Ack disregarding ack for incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
296 _ackOrNakTimeoutTimer.stop();
297 _advanceStateMachine();
300void FTPManager::_terminateSessionTimeout(
void)
302 if (++_downloadState.retryCount > _maxRetry) {
303 qCDebug(FTPManagerLog) << QString(
"_terminateSessionTimeout retries exceeded");
304 _downloadComplete(tr(
"Download failed"));
307 qCDebug(FTPManagerLog) << QString(
"_terminateSessionTimeout: retrying - retryCount(%1)").arg(_downloadState.retryCount);
308 _terminateSessionBegin();
313void FTPManager::_terminateComplete(
void)
315 _downloadComplete(
"Aborted");
320void FTPManager::_downloadComplete(
const QString& errorMsg)
322 qCDebug(FTPManagerLog) << QString(
"_downloadComplete: errorMsg(%1)").arg(errorMsg);
324 QString downloadFilePath = _downloadState.toDir.absoluteFilePath(_downloadState.fileName);
325 QString
error = errorMsg;
327 _ackOrNakTimeoutTimer.stop();
328 _rgStateMachine.clear();
329 _currentStateMachineIndex = -1;
330 if (_downloadState.file.isOpen()) {
331 _downloadState.file.close();
332 if (!errorMsg.isEmpty()) {
333 _downloadState.file.remove();
342void FTPManager::_listDirectoryComplete(
const QString& errorMsg)
344 qCDebug(FTPManagerLog) << QString(
"_listDirectoryComplete: errorMsg(%1)").arg(errorMsg);
346 _ackOrNakTimeoutTimer.stop();
347 _rgStateMachine.clear();
348 _currentStateMachineIndex = -1;
350 QStringList rgDirectoryList = _listDirectoryState.rgDirectoryList;
351 if (!errorMsg.isEmpty()) {
352 rgDirectoryList.clear();
355 _listDirectoryState.reset();
360void FTPManager::_deleteFileBegin(
void)
362 qCDebug(FTPManagerLog) <<
"file" << _deleteState.fullPathOnVehicle;
364 MavlinkFTP::Request request{};
365 request.hdr.session = 0;
367 request.hdr.offset = 0;
368 request.hdr.size = 0;
369 _fillRequestDataWithString(&request, _deleteState.fullPathOnVehicle);
370 _sendRequestExpectAck(&request);
373void FTPManager::_deleteFileAckOrNak(
const MavlinkFTP::Request* ackOrNak)
377 qCDebug(FTPManagerLog) <<
"_deleteFileAckOrNak: Ack disregarding ack for incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
380 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
381 qCDebug(FTPManagerLog) <<
"_deleteFileAckOrNak: Ack disregarding ack for incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
385 _ackOrNakTimeoutTimer.stop();
388 _advanceStateMachine();
390 qCDebug(FTPManagerLog) <<
"_deleteFileAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
391 _deleteComplete(tr(
"Delete failed") +
": " + _errorMsgFromNak(ackOrNak));
395void FTPManager::_deleteFileTimeout(
void)
397 if (++_deleteState.retryCount > _maxRetry) {
398 qCDebug(FTPManagerLog) << QString(
"_deleteFileTimeout retries exceeded");
399 _deleteComplete(tr(
"Delete failed"));
401 qCDebug(FTPManagerLog) << QString(
"_deleteFileTimeout: retrying - retryCount(%1)").arg(_deleteState.retryCount);
406void FTPManager::_deleteComplete(
const QString& errorMsg)
408 qCDebug(FTPManagerLog) << QString(
"_deleteComplete: errorMsg(%1)").arg(errorMsg);
410 const QString deletedPath = _deleteState.fullPathOnVehicle;
412 _ackOrNakTimeoutTimer.stop();
413 _rgStateMachine.clear();
414 _currentStateMachineIndex = -1;
416 _deleteState.reset();
421void FTPManager::_createFileBegin(
void)
423 qCDebug(FTPManagerLog) <<
"file" << _uploadState.fullPathOnVehicle;
425 MavlinkFTP::Request request{};
426 request.hdr.session = 0;
428 request.hdr.offset = 0;
429 request.hdr.size = 0;
430 _fillRequestDataWithString(&request, _uploadState.fullPathOnVehicle);
431 _sendRequestExpectAck(&request);
434void FTPManager::_createFileAckOrNak(
const MavlinkFTP::Request* ackOrNak)
438 qCDebug(FTPManagerLog) <<
"_createFileAckOrNak: Ack disregarding ack for incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
441 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
442 qCDebug(FTPManagerLog) <<
"_createFileAckOrNak: Ack disregarding ack for incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
446 _ackOrNakTimeoutTimer.stop();
449 qCDebug(FTPManagerLog) <<
"_createFileAckOrNak: Ack - sessionId" << ackOrNak->hdr.session;
451 _uploadState.sessionId = ackOrNak->hdr.session;
452 _advanceStateMachine();
454 qCDebug(FTPManagerLog) <<
"_createFileAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
455 _uploadComplete(tr(
"Upload failed for: %1 - error: %2").arg(_uploadState.fullPathOnVehicle).arg(_errorMsgFromNak(ackOrNak)));
459void FTPManager::_createFileTimeout(
void)
461 qCDebug(FTPManagerLog) <<
"_createFileTimeout";
462 _uploadComplete(tr(
"Upload failed for: %1 - no response from vehicle").arg(_uploadState.fullPathOnVehicle));
465void FTPManager::_writeFileBegin(
void)
467 _writeFileWorker(
true );
470void FTPManager::_writeFileWorker(
bool firstRequest)
472 if (!_uploadState.file.isOpen()) {
473 _uploadComplete(tr(
"Upload failed for: %1 - file not open").arg(_uploadState.fullPathOnVehicle));
477 if (_uploadState.totalBytesSent >= _uploadState.fileSize) {
478 _advanceStateMachine();
482 qCDebug(FTPManagerLog) <<
"_writeFileWorker: offset:firstRequest:retryCount" << _uploadState.totalBytesSent << firstRequest << _uploadState.retryCount;
484 MavlinkFTP::Request request{};
485 request.hdr.session = _uploadState.sessionId;
487 request.hdr.offset = _uploadState.totalBytesSent;
490 _uploadState.retryCount = 0;
492 _expectedIncomingSeqNumber -= 2;
495 qint64 bytesRemaining =
static_cast<qint64
>(_uploadState.fileSize) -
static_cast<qint64
>(_uploadState.totalBytesSent);
496 qint64 bytesToSend = bytesRemaining;
497 if (bytesToSend >
static_cast<qint64
>(
sizeof(request.data))) {
498 bytesToSend =
sizeof(request.data);
501 if (!_uploadState.file.seek(_uploadState.totalBytesSent)) {
502 qCDebug(FTPManagerLog) <<
"_writeFileWorker: seek failed" << _uploadState.file.errorString();
503 _uploadComplete(tr(
"Upload failed for: %1 - error reading file").arg(_uploadState.fullPathOnVehicle));
507 qint64 bytesRead = _uploadState.file.read(
reinterpret_cast<char*
>(request.data), bytesToSend);
508 if (bytesRead != bytesToSend) {
509 qCDebug(FTPManagerLog) <<
"_writeFileWorker: read failed" << _uploadState.file.errorString();
510 _uploadComplete(tr(
"Upload failed for: %1 - error reading file").arg(_uploadState.fullPathOnVehicle));
514 request.hdr.size =
static_cast<uint8_t
>(bytesRead);
515 _uploadState.lastChunkSize =
static_cast<uint32_t
>(bytesRead);
517 _sendRequestExpectAck(&request);
520void FTPManager::_writeFileAckOrNak(
const MavlinkFTP::Request* ackOrNak)
525 qCDebug(FTPManagerLog) <<
"_writeFileAckOrNak: Disregarding due to incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
528 if (ackOrNak->hdr.session != _uploadState.sessionId) {
529 qCDebug(FTPManagerLog) <<
"_writeFileAckOrNak: Disregarding due to incorrect session id actual:expected" << ackOrNak->hdr.session << _uploadState.sessionId;
533 _ackOrNakTimeoutTimer.stop();
536 if (ackOrNak->hdr.seqNumber < _expectedIncomingSeqNumber) {
537 qCDebug(FTPManagerLog) <<
"_writeFileAckOrNak: Disregarding Ack due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
541 if (ackOrNak->hdr.size != 0) {
542 qCDebug(FTPManagerLog) <<
"_writeFileAckOrNak: unexpected ack size expected:actual 0" << ackOrNak->hdr.size;
545 _uploadState.totalBytesSent += _uploadState.lastChunkSize;
546 _uploadState.lastChunkSize = 0;
547 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber;
549 if (_uploadState.fileSize != 0) {
550 emit
commandProgress(
static_cast<float>(_uploadState.totalBytesSent) /
static_cast<float>(_uploadState.fileSize));
553 if (_uploadState.totalBytesSent >= _uploadState.fileSize) {
554 _advanceStateMachine();
556 _writeFileWorker(
true );
559 qCDebug(FTPManagerLog) <<
"_writeFileAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
560 _uploadComplete(tr(
"Upload failed for: %1 - error: %2").arg(_uploadState.fullPathOnVehicle).arg(_errorMsgFromNak(ackOrNak)));
564void FTPManager::_writeFileTimeout(
void)
566 if (++_uploadState.retryCount > _maxRetry) {
567 qCDebug(FTPManagerLog) << QString(
"_writeFileTimeout retries exceeded");
568 _uploadComplete(tr(
"Upload failed for: %1 - no response from vehicle").arg(_uploadState.fullPathOnVehicle));
570 qCDebug(FTPManagerLog) << QString(
"_writeFileTimeout: retrying - retryCount(%1) offset(%2)").arg(_uploadState.retryCount).arg(_uploadState.totalBytesSent);
571 _writeFileWorker(
false );
575void FTPManager::_terminateUploadSessionBegin(
void)
577 if (_uploadState.sessionId == 0) {
578 qCWarning(FTPManagerLog) <<
"_terminateUploadSessionBegin: No session to terminate";
579 _advanceStateMachine();
583 MavlinkFTP::Request request{};
584 request.hdr.session = _uploadState.sessionId;
586 _sendRequestExpectAck(&request);
589void FTPManager::_terminateUploadSessionAckOrNak(
const MavlinkFTP::Request* ackOrNak)
593 qCDebug(FTPManagerLog) <<
"_terminateUploadSessionAckOrNak: Ack disregarding ack for incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
596 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
597 qCDebug(FTPManagerLog) <<
"_terminateUploadSessionAckOrNak: Ack disregarding ack for incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
601 _ackOrNakTimeoutTimer.stop();
604 qCDebug(FTPManagerLog) <<
"_terminateUploadSessionAckOrNak: Ack";
605 _advanceStateMachine();
607 qCDebug(FTPManagerLog) <<
"_terminateUploadSessionAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
608 _uploadComplete(tr(
"Upload failed for: %1 - error: %2").arg(_uploadState.fullPathOnVehicle).arg(_errorMsgFromNak(ackOrNak)));
612void FTPManager::_terminateUploadSessionTimeout(
void)
614 if (++_uploadState.retryCount > _maxRetry) {
615 qCDebug(FTPManagerLog) << QString(
"_terminateUploadSessionTimeout retries exceeded");
616 _uploadComplete(tr(
"Upload failed for: %1 - no response from vehicle").arg(_uploadState.fullPathOnVehicle));
618 qCDebug(FTPManagerLog) << QString(
"_terminateUploadSessionTimeout: retrying - retryCount(%1)").arg(_uploadState.retryCount);
619 _terminateUploadSessionBegin();
623void FTPManager::_uploadFinalize(
void)
625 QString
error = _uploadState.cancelled ? tr(
"Aborted for: %1").arg(_uploadState.fullPathOnVehicle) : QString();
626 _uploadComplete(
error);
629void FTPManager::_uploadComplete(
const QString& errorMsg)
631 qCDebug(FTPManagerLog) << QString(
"_uploadComplete: errorMsg(%1)").arg(errorMsg)
632 <<
"local" << _uploadState.localFilePath
633 <<
"remote" << _uploadState.fullPathOnVehicle;
635 QString remotePath = _uploadState.fullPathOnVehicle;
637 _ackOrNakTimeoutTimer.stop();
638 _rgStateMachine.clear();
639 _currentStateMachineIndex = -1;
641 if (_uploadState.file.isOpen()) {
642 _uploadState.file.close();
645 _uploadState.reset();
652 if (message.msgid != MAVLINK_MSG_ID_FILE_TRANSFER_PROTOCOL ||
653 message.sysid != _vehicle->
id() || message.compid != _ftpCompId) {
657 if (_currentStateMachineIndex == -1) {
661 mavlink_file_transfer_protocol_t data;
662 mavlink_msg_file_transfer_protocol_decode(&message, &data);
666 if (data.target_system != qgcId) {
670 MavlinkFTP::Request* request = (MavlinkFTP::Request*)&data.payload[0];
673 if (request->hdr.size >
sizeof(request->data)) {
674 qCWarning(FTPManagerLog) <<
"_mavlinkMessageReceived: hdr.size exceeds data array, discarding." << request->hdr.size;
679 uint16_t actualIncomingSeqNumber = request->hdr.seqNumber;
680 if ((uint16_t)((_expectedIncomingSeqNumber - 1) - actualIncomingSeqNumber) < (std::numeric_limits<uint16_t>::max()/2)) {
681 qCDebug(FTPManagerLog) <<
"_mavlinkMessageReceived: Received old packet seqNum expected:actual" << _expectedIncomingSeqNumber << actualIncomingSeqNumber
687 qCDebug(FTPManagerLog) <<
"_mavlinkMessageReceived: hdr.opcode:hdr.req_opcode:seqNumber"
689 << request->hdr.seqNumber;
691 (this->*_rgStateMachine[_currentStateMachineIndex].ackNakFn)(request);
694void FTPManager::_startStateMachine(
void)
696 _currentStateMachineIndex = -1;
697 _advanceStateMachine();
700void FTPManager::_advanceStateMachine(
void)
702 _currentStateMachineIndex++;
703 (this->*_rgStateMachine[_currentStateMachineIndex].beginFn)();
706void FTPManager::_ackOrNakTimeout(
void)
708 (this->*_rgStateMachine[_currentStateMachineIndex].timeoutFn)();
711void FTPManager::_fillRequestDataWithString(MavlinkFTP::Request* request,
const QString& str)
713 strncpy((
char *)&request->data[0], str.toStdString().c_str(),
sizeof(request->data));
714 request->hdr.size =
static_cast<uint8_t
>(strnlen((
const char *)&request->data[0],
sizeof(request->data)));
717QString FTPManager::_errorMsgFromNak(
const MavlinkFTP::Request* nak)
724 errorMsg = tr(
"Invalid Nak format");
726 errorMsg = tr(
"errno %1").arg(nak->data[1]);
734void FTPManager::_openFileROBegin(
void)
736 MavlinkFTP::Request request{};
737 request.hdr.session = 0;
739 request.hdr.offset = 0;
740 request.hdr.size = 0;
741 _fillRequestDataWithString(&request, _downloadState.fullPathOnVehicle);
742 _sendRequestExpectAck(&request);
745void FTPManager::_openFileROTimeout(
void)
747 qCDebug(FTPManagerLog) <<
"_openFileROTimeout";
748 _downloadComplete(tr(
"Download failed"));
751void FTPManager::_openFileROAckOrNak(
const MavlinkFTP::Request* ackOrNak)
755 qCDebug(FTPManagerLog) <<
"_openFileROAckOrNak: Ack disregarding ack for incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
758 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
759 qCDebug(FTPManagerLog) <<
"_openFileROAckOrNak: Ack disregarding ack for incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
763 _ackOrNakTimeoutTimer.stop();
766 qCDebug(FTPManagerLog) <<
"_openFileROAckOrNak: Ack - sessionId:openFileLength" << ackOrNak->hdr.session << ackOrNak->openFileLength;
768 if (ackOrNak->hdr.size !=
sizeof(uint32_t)) {
769 qCDebug(FTPManagerLog) <<
"_openFileROAckOrNak: Ack ack->hdr.size != sizeof(uint32_t)" << ackOrNak->hdr.size <<
sizeof(uint32_t);
770 _downloadComplete(tr(
"Download failed"));
774 _downloadState.sessionId = ackOrNak->hdr.session;
775 _downloadState.fileSize = ackOrNak->openFileLength;
776 _downloadState.expectedOffset = 0;
778 _downloadState.file.setFileName(_downloadState.toDir.filePath(_downloadState.fileName));
779 if (_downloadState.file.open(QFile::WriteOnly | QFile::Truncate)) {
780 _advanceStateMachine();
782 qCDebug(FTPManagerLog) <<
"_openFileROAckOrNak: Ack _downloadState.file open failed" << _downloadState.file.errorString();
783 _downloadComplete(tr(
"Download failed"));
786 qCDebug(FTPManagerLog) <<
"_handlOpenFileROAck: Nak -" << _errorMsgFromNak(ackOrNak);
787 _downloadComplete(tr(
"Download failed") +
": " + _errorMsgFromNak(ackOrNak));
791void FTPManager::_burstReadFileWorker(
bool firstRequest)
793 qCDebug(FTPManagerLog) <<
"_burstReadFileWorker: starting burst at offset:firstRequest:retryCount" << _downloadState.expectedOffset << firstRequest << _downloadState.retryCount;
795 MavlinkFTP::Request request{};
796 request.hdr.session = _downloadState.sessionId;
798 request.hdr.offset = _downloadState.expectedOffset;
799 request.hdr.size =
sizeof(request.data);
802 _downloadState.retryCount = 0;
805 _expectedIncomingSeqNumber -= 2;
808 _sendRequestExpectAck(&request);
811void FTPManager::_burstReadFileBegin(
void)
813 _burstReadFileWorker(
true );
816void FTPManager::_burstReadFileAckOrNak(
const MavlinkFTP::Request* ackOrNak)
821 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak: Disregarding due to incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
824 if (ackOrNak->hdr.session != _downloadState.sessionId) {
825 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak: Disregarding due to incorrect session id actual:expected" << ackOrNak->hdr.session << _downloadState.sessionId;
829 _ackOrNakTimeoutTimer.stop();
832 if (ackOrNak->hdr.seqNumber < _expectedIncomingSeqNumber) {
833 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak: Disregarding Ack due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
837 qCDebug(FTPManagerLog) << QString(
"_burstReadFileAckOrNak: Ack offset(%1) size(%2) burstComplete(%3)").arg(ackOrNak->hdr.offset).arg(ackOrNak->hdr.size).arg(ackOrNak->hdr.burstComplete);
839 if (ackOrNak->hdr.offset != _downloadState.expectedOffset) {
840 if (ackOrNak->hdr.offset > _downloadState.expectedOffset) {
842 MissingData_t missingData;
843 missingData.offset = _downloadState.expectedOffset;
844 missingData.cBytesMissing = ackOrNak->hdr.offset - _downloadState.expectedOffset;
845 _downloadState.rgMissingData.append(missingData);
846 qCDebug(FTPManagerLog) <<
"_handleBurstReadFileAck: adding missing data offset:cBytesMissing" << missingData.offset << missingData.cBytesMissing;
849 _ackOrNakTimeoutTimer.start();
850 qCDebug(FTPManagerLog) <<
"_handleBurstReadFileAck: received offset less than expected offset received:expected" << ackOrNak->hdr.offset << _downloadState.expectedOffset;
855 _downloadState.file.seek(ackOrNak->hdr.offset);
856 int bytesWritten = _downloadState.file.write((
const char*)ackOrNak->data, ackOrNak->hdr.size);
857 if (bytesWritten != ackOrNak->hdr.size) {
858 _downloadComplete(tr(
"Download failed: Error saving file"));
861 _downloadState.bytesWritten += ackOrNak->hdr.size;
862 _downloadState.expectedOffset = ackOrNak->hdr.offset + ackOrNak->hdr.size;
864 if (ackOrNak->hdr.burstComplete) {
866 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber;
867 _burstReadFileWorker(
true );
870 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber + 1;
871 _ackOrNakTimeoutTimer.start();
875 if (_downloadState.fileSize != 0) {
876 emit
commandProgress((
float)(_downloadState.bytesWritten) / (
float)_downloadState.fileSize);
883 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
884 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak: EOF Nak"
885 "with incorrect sequence nr actual:expected"
886 << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
888 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber;
889 _burstReadFileWorker(
true);
891 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak EOF";
892 _advanceStateMachine();
895 qCDebug(FTPManagerLog) <<
"_burstReadFileAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
896 _downloadComplete(tr(
"Download failed"));
901void FTPManager::_burstReadFileTimeout(
void)
903 if (++_downloadState.retryCount > _maxRetry) {
904 qCDebug(FTPManagerLog) << QString(
"_burstReadFileTimeout retries exceeded");
905 _downloadComplete(tr(
"Download failed"));
908 qCDebug(FTPManagerLog) << QString(
"_burstReadFileTimeout: retrying - retryCount(%1) offset(%2)").arg(_downloadState.retryCount).arg(_downloadState.expectedOffset);
909 _burstReadFileWorker(
false );
913void FTPManager::_listDirectoryWorker(
bool firstRequest)
915 qCDebug(FTPManagerLog) <<
"_listDirectoryWorker: offset:firstRequest:retryCount" << _listDirectoryState.expectedOffset << firstRequest << _listDirectoryState.retryCount;
917 MavlinkFTP::Request request{};
918 request.hdr.session = _downloadState.sessionId;
919 request.hdr.opcode = _listDirectoryState.opCode;
920 request.hdr.offset = _listDirectoryState.expectedOffset;
921 request.hdr.size =
sizeof(request.data);
922 _fillRequestDataWithString(&request, _listDirectoryState.fullPathOnVehicle);
925 _listDirectoryState.retryCount = 0;
928 _expectedIncomingSeqNumber -= 2;
931 _sendRequestExpectAck(&request);
934void FTPManager::_listDirectoryBegin(
void)
936 _listDirectoryWorker(
true );
939void FTPManager::_listDirectoryAckOrNak(
const MavlinkFTP::Request* ackOrNak)
943 if (requestOpCode != _listDirectoryState.opCode) {
944 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak: Disregarding due to incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
948 _ackOrNakTimeoutTimer.stop();
951 if (ackOrNak->hdr.seqNumber < _expectedIncomingSeqNumber) {
952 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak: Disregarding Ack due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
957 _listDirWithTimeSupport = WithTimeSupport_t::Supported;
960 qCDebug(FTPManagerLog) << QString(
"_listDirectoryAckOrNak: Ack size(%1)").arg(ackOrNak->hdr.size);
963 const char* curDataPtr = (
const char*)ackOrNak->data;
964 while (curDataPtr < (
const char*)ackOrNak->data + ackOrNak->hdr.size) {
965 QString dirEntry = curDataPtr;
966 curDataPtr += dirEntry.size() + 1;
967 _listDirectoryState.rgDirectoryList.append(dirEntry);
968 _listDirectoryState.expectedOffset++;
972 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber;
973 _listDirectoryWorker(
true );
979 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
980 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak: Disregarding Nak due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
981 _ackOrNakTimeoutTimer.start();
984 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak EOF";
986 _listDirWithTimeSupport = WithTimeSupport_t::Supported;
988 _advanceStateMachine();
995 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak: kCmdListDirectoryWithTime unsupported, falling back to kCmdListDirectory";
996 _listDirWithTimeSupport = WithTimeSupport_t::Unsupported;
998 _listDirectoryState.expectedOffset = 0;
999 _listDirectoryState.rgDirectoryList.clear();
1000 _expectedIncomingSeqNumber = ackOrNak->hdr.seqNumber;
1001 _listDirectoryWorker(
true );
1003 qCDebug(FTPManagerLog) <<
"_listDirectoryAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
1004 _listDirectoryComplete(tr(
"List directory failed"));
1009void FTPManager::_listDirectoryTimeout(
void)
1011 if (++_listDirectoryState.retryCount > _maxRetry) {
1012 qCDebug(FTPManagerLog) << QString(
"_listDirectoryTimeout retries exceeded");
1013 _listDirectoryComplete(tr(
"List directory failed"));
1016 qCDebug(FTPManagerLog) << QString(
"_listDirectoryTimeout: retrying - retryCount(%1) offset(%2)").arg(_listDirectoryState.retryCount).arg(_listDirectoryState.expectedOffset);
1017 _listDirectoryWorker(
false );
1021void FTPManager::_fillMissingBlocksWorker(
bool firstRequest)
1023 if (_downloadState.rgMissingData.count()) {
1024 MavlinkFTP::Request request{};
1025 MissingData_t& missingData = _downloadState.rgMissingData.first();
1027 uint32_t cBytesToRead = qMin((uint32_t)
sizeof(request.data), missingData.cBytesMissing);
1029 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksBegin: offset:cBytesToRead" << missingData.offset << cBytesToRead;
1031 request.hdr.session = _downloadState.sessionId;
1033 request.hdr.offset = missingData.offset;
1034 request.hdr.size = cBytesToRead;
1037 _downloadState.retryCount = 0;
1040 _expectedIncomingSeqNumber -= 2;
1042 _downloadState.expectedOffset = request.hdr.offset;
1044 _sendRequestExpectAck(&request);
1047 if (_downloadState.checksize ==
false || _downloadState.bytesWritten == _downloadState.fileSize) {
1048 _advanceStateMachine();
1050 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksWorker: no missing blocks but file still incomplete - bytesWritten:fileSize" << _downloadState.bytesWritten << _downloadState.fileSize;
1051 _downloadComplete(tr(
"Download failed"));
1056void FTPManager::_fillMissingBlocksBegin(
void)
1058 _fillMissingBlocksWorker(
true );
1061void FTPManager::_fillMissingBlocksAckOrNak(
const MavlinkFTP::Request* ackOrNak)
1066 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Disregarding due to incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
1069 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
1070 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Disregarding due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
1073 if (ackOrNak->hdr.session != _downloadState.sessionId) {
1074 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Disregarding due to incorrect session id actual:expected" << ackOrNak->hdr.session << _downloadState.sessionId;
1078 _ackOrNakTimeoutTimer.stop();
1081 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Ack offset:size" << ackOrNak->hdr.offset << ackOrNak->hdr.size;
1083 if (ackOrNak->hdr.offset != _downloadState.expectedOffset) {
1084 if (++_downloadState.retryCount > _maxRetry) {
1085 qCDebug(FTPManagerLog) << QString(
"_fillMissingBlocksAckOrNak: offset mismatch, retries exceeded");
1086 _downloadComplete(tr(
"Download failed"));
1091 qCDebug(FTPManagerLog) << QString(
"_fillMissingBlocksAckOrNak: Ack offset mismatch retry, retryCount(%1) offset(%2)").arg(_downloadState.retryCount).arg(_downloadState.expectedOffset);
1092 _fillMissingBlocksWorker(
false );
1096 _downloadState.file.seek(ackOrNak->hdr.offset);
1097 int bytesWritten = _downloadState.file.write((
const char*)ackOrNak->data, ackOrNak->hdr.size);
1098 if (bytesWritten != ackOrNak->hdr.size) {
1099 _downloadComplete(tr(
"Download failed: Error saving file"));
1102 _downloadState.bytesWritten += ackOrNak->hdr.size;
1104 MissingData_t& missingData = _downloadState.rgMissingData.first();
1105 missingData.offset += ackOrNak->hdr.size;
1106 missingData.cBytesMissing -= ackOrNak->hdr.size;
1107 if (missingData.cBytesMissing == 0) {
1109 _downloadState.rgMissingData.takeFirst();
1113 _fillMissingBlocksWorker(
true );
1116 if (_downloadState.fileSize != 0) {
1117 emit
commandProgress((
float)(_downloadState.bytesWritten) / (
float)_downloadState.fileSize);
1123 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak EOF";
1124 if (_downloadState.checksize ==
false || _downloadState.bytesWritten == _downloadState.fileSize) {
1126 _advanceStateMachine();
1131 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
1132 _downloadComplete(tr(
"Download failed"));
1136void FTPManager::_fillMissingBlocksTimeout(
void)
1138 if (++_downloadState.retryCount > _maxRetry) {
1139 qCDebug(FTPManagerLog) << QString(
"_fillMissingBlocksTimeout retries exceeded");
1140 _downloadComplete(tr(
"Download failed"));
1143 qCDebug(FTPManagerLog) << QString(
"_fillMissingBlocksTimeout: retrying - retryCount(%1) offset(%2)").arg(_downloadState.retryCount).arg(_downloadState.expectedOffset);
1144 _fillMissingBlocksWorker(
false );
1148void FTPManager::_resetSessionsBegin(
void)
1150 MavlinkFTP::Request request{};
1152 request.hdr.size = 0;
1153 _sendRequestExpectAck(&request);
1156void FTPManager::_resetSessionsAckOrNak(
const MavlinkFTP::Request* ackOrNak)
1161 qCDebug(FTPManagerLog) <<
"_fillMissingBlocksAckOrNak: Disregarding due to incorrect requestOpCode" <<
MavlinkFTP::opCodeToString(requestOpCode);
1164 if (ackOrNak->hdr.seqNumber != _expectedIncomingSeqNumber) {
1165 qCDebug(FTPManagerLog) <<
"_resetSessionsAckOrNak: Disregarding due to incorrect sequence actual:expected" << ackOrNak->hdr.seqNumber << _expectedIncomingSeqNumber;
1169 _ackOrNakTimeoutTimer.stop();
1172 qCDebug(FTPManagerLog) <<
"_resetSessionsAckOrNak: Ack";
1173 _advanceStateMachine();
1175 qCDebug(FTPManagerLog) <<
"_resetSessionsAckOrNak: Nak -" << _errorMsgFromNak(ackOrNak);
1176 _downloadComplete(QString());
1180void FTPManager::_resetSessionsTimeout(
void)
1182 qCDebug(FTPManagerLog) <<
"_resetSessionsTimeout";
1183 _downloadComplete(QString());
1186void FTPManager::_sendRequestExpectAck(MavlinkFTP::Request* request)
1188 _ackOrNakTimeoutTimer.start();
1192 request->hdr.seqNumber = _expectedIncomingSeqNumber + 1;
1193 _expectedIncomingSeqNumber += 2;
1200 sharedLink->mavlinkChannel(),
1208 qCDebug(FTPManagerLog) <<
"_sendRequestExpectAck No primary link. Allowing timeout to fail sequence.";
1212bool FTPManager::_parseURI(uint8_t fromCompId,
const QString& uri, QString& parsedURI, uint8_t& compId)
1215 compId = (fromCompId == MAV_COMP_ID_ALL) ? (uint8_t)MAV_COMP_ID_AUTOPILOT1 : fromCompId;
1219 if (parsedURI.startsWith(ftpPrefix, Qt::CaseInsensitive)) {
1220 parsedURI = parsedURI.right(parsedURI.length() - ftpPrefix.length() + 1);
1222 if (parsedURI.contains(
"://")) {
1223 qCWarning(FTPManagerLog) <<
"Incorrect uri scheme or format" << uri;
1228 QRegularExpression regEx(
"^/??\\[\\;comp\\=(\\d+)\\]");
1229 QRegularExpressionMatch match = regEx.match(parsedURI);
1230 if (match.hasMatch()) {
1232 compId = match.captured(1).toUInt(&ok);
1234 qCWarning(FTPManagerLog) <<
"Incorrect format for component id" << uri;
1238 qCDebug(FTPManagerLog) <<
"Found compId in MAVLink FTP URI: " << compId;
1239 parsedURI.replace(QRegularExpression(
"\\[\\;comp\\=\\d+\\]"),
"");
std::shared_ptr< LinkInterface > SharedLinkInterfacePtr
struct __mavlink_message mavlink_message_t
#define QGC_LOGGING_CATEGORY(name, categoryStr)
bool listDirectory(uint8_t fromCompId, const QString &fromURI)
bool deleteFile(uint8_t fromCompId, const QString &fromURI)
bool upload(uint8_t toCompId, const QString &toURI, const QString &fromFile)
static constexpr const char * mavlinkFTPScheme
void uploadComplete(const QString &file, const QString &errorMsg)
void commandProgress(float value)
void downloadComplete(const QString &file, const QString &errorMsg)
void cancelListDirectory()
void deleteComplete(const QString &file, const QString &errorMsg)
bool download(uint8_t fromCompId, const QString &fromURI, const QString &toDir, const QString &fileName="", bool checksize=true)
void listDirectoryComplete(const QStringList &dirList, const QString &errorMsg)
static int getComponentId()
static MAVLinkProtocol * instance()
ErrorCode_t
Error codes returned in Nak response PayloadHeader.data[0].
@ kErrEOF
Offset past end of file for List and Read commands.
@ kErrUnknownCommand
Unknown command opcode.
@ kErrFailErrno
errno sent back in PayloadHeader.data[1]
static QString errorCodeToString(ErrorCode_t errorCode)
@ kCmdRemoveFile
Remove file at <path>
@ kCmdWriteFile
Writes <size> bytes to <offset> in <session>
@ kCmdCreateFile
Creates file at <path> for writing, returns <session>
@ kCmdOpenFileRO
Opens file at <path> for reading, returns <session>
@ kCmdListDirectoryWithTime
List directory as kCmdListDirectory, each entry additionally carrying trailing \t<modification time>
@ kCmdReadFile
Reads <size> bytes from <offset> in <session>
@ kCmdResetSessions
Terminates all open Read sessions.
@ kCmdBurstReadFile
Burst download session file.
@ kCmdTerminateSession
Terminates open Read session.
@ kCmdListDirectory
List files in <path> from <offset>
static QString opCodeToString(OpCode_t opCode)
WeakLinkInterfacePtr primaryLink() const
VehicleLinkManager * vehicleLinkManager()
bool sendMessageOnLinkThreadSafe(LinkInterface *link, mavlink_message_t message)