forked from owncloud/client
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement the TUS resumebale upload protocol
The prodocol is doccumented at: https://tus.io/protocols/resumable-upload.html Issue: owncloud/product#19
- Loading branch information
1 parent
dea019e
commit 2763c78
Showing
7 changed files
with
371 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Change: Add support for the TUS resumeable upload protocol | ||
|
|
||
| With the support of the TUS protocol we are now able to easily and reliably | ||
| upload files to ocis. | ||
|
|
||
|
|
||
| https://github.com/owncloud/product/issues/19 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,259 @@ | ||
| /* | ||
| * Copyright (C) by Hannah von Reth <[email protected]> | ||
| * | ||
| * This program 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 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program 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. | ||
| */ | ||
|
|
||
| #include "account.h" | ||
| #include "common/asserts.h" | ||
| #include "common/checksums.h" | ||
| #include "common/syncjournaldb.h" | ||
| #include "common/syncjournalfilerecord.h" | ||
| #include "common/utility.h" | ||
| #include "filesystem.h" | ||
| #include "httplogger.h" | ||
| #include "networkjobs.h" | ||
| #include "owncloudpropagator_p.h" | ||
| #include "propagateremotedelete.h" | ||
| #include "propagateupload.h" | ||
| #include "propagateuploadtus.h" | ||
| #include "propagatorjobs.h" | ||
| #include "syncengine.h" | ||
|
|
||
| #include <QNetworkAccessManager> | ||
| #include <QFileInfo> | ||
| #include <QDir> | ||
| #include <cmath> | ||
| #include <cstring> | ||
| #include <memory> | ||
|
|
||
| namespace { | ||
| QUrl uploadURL(const OCC::AccountPtr &account) | ||
| { | ||
| return OCC::Utility::concatUrlPath(account->url(), QStringLiteral("remote.php/dav/files/%1/").arg(account->davUser())); | ||
| } | ||
|
|
||
| QByteArray uploadOffset() | ||
| { | ||
| return QByteArrayLiteral("Upload-Offset"); | ||
| } | ||
|
|
||
| void setTusVersionHeader(QNetworkRequest &req){ | ||
| req.setRawHeader(QByteArrayLiteral("Tus-Resumable"), QByteArrayLiteral("1.0.0")); | ||
| } | ||
| } | ||
|
|
||
| namespace OCC { | ||
| // be very verbose for now | ||
| Q_LOGGING_CATEGORY(lcPropagateUploadTUS, "sync.propagator.upload.tus", QtDebugMsg) | ||
|
|
||
|
|
||
| UploadDevice *PropagateUploadFileTUS::prepareDevice(const quint64 &chunkSize) | ||
| { | ||
| const QString localFileName = propagator()->getFilePath(_item->_file); | ||
| auto device = new UploadDevice(localFileName, _currentOffset, chunkSize, &propagator()->_bandwidthManager); | ||
| if (!device->open(QIODevice::ReadOnly)) { | ||
| qCWarning(lcPropagateUploadTUS) << "Could not prepare upload device: " << device->errorString(); | ||
|
|
||
| // If the file is currently locked, we want to retry the sync | ||
| // when it becomes available again. | ||
| if (FileSystem::isFileLocked(localFileName)) { | ||
| emit propagator()->seenLockedFile(localFileName); | ||
| } | ||
| // Soft error because this is likely caused by the user modifying his files while syncing | ||
| abortWithError(SyncFileItem::SoftError, device->errorString()); | ||
| return nullptr; | ||
| } | ||
| return device; | ||
| } | ||
|
|
||
|
|
||
| SimpleNetworkJob *PropagateUploadFileTUS::makeCreationWithUploadJob(QNetworkRequest *request, UploadDevice *device) | ||
| { | ||
| Q_ASSERT(propagator()->account()->capabilities().tusSupport().extensions.contains(QStringLiteral("creation-with-upload"))); | ||
| // in difference to the old protocol the algrithm and the value are space seperated | ||
| const auto checkSum = _transmissionChecksumHeader.replace(':', ' ').toBase64(); | ||
| request->setRawHeader(QByteArrayLiteral("Upload-Metadata"), "filename " + _item->_file.toUtf8().toBase64() + ",checksum " + checkSum); | ||
| request->setRawHeader(QByteArrayLiteral("Upload-Length"), QByteArray::number(_item->_size)); | ||
| return propagator()->account()->sendRequest("POST", uploadURL(propagator()->account()), *request, device); | ||
| } | ||
|
|
||
| QNetworkRequest PropagateUploadFileTUS::prepareRequest(const quint64 &chunkSize) | ||
| { | ||
| QNetworkRequest request; | ||
| const auto headers = PropagateUploadFileCommon::headers(); | ||
| for (auto it = headers.cbegin(); it != headers.cend(); ++it) { | ||
| request.setRawHeader(it.key(), it.value()); | ||
| } | ||
|
|
||
| request.setHeader(QNetworkRequest::ContentTypeHeader, QByteArrayLiteral("application/offset+octet-stream")); | ||
| request.setHeader(QNetworkRequest::ContentLengthHeader, QByteArray::number(chunkSize)); | ||
| request.setRawHeader(uploadOffset(), QByteArray::number(_currentOffset)); | ||
| setTusVersionHeader(request); | ||
| return request; | ||
| } | ||
|
|
||
| PropagateUploadFileTUS::PropagateUploadFileTUS(OwncloudPropagator *propagator, const SyncFileItemPtr &item) | ||
| : PropagateUploadFileCommon(propagator, item) | ||
| { | ||
| } | ||
|
|
||
| void PropagateUploadFileTUS::doStartUpload() | ||
| { | ||
| const SyncJournalDb::UploadInfo progressInfo = propagator()->_journal->getUploadInfo(_item->_file); | ||
| propagator()->reportProgress(*_item, 0); | ||
| startNextChunk(); | ||
| propagator()->_activeJobList.append(this); | ||
| } | ||
|
|
||
| void PropagateUploadFileTUS::startNextChunk() | ||
| { | ||
| if (propagator()->_abortRequested) | ||
| return; | ||
| const quint64 chunkSize = [&] { | ||
| auto chunkSize = _item->_size - _currentOffset; | ||
| if (propagator()->account()->capabilities().tusSupport().max_chunk_size) { | ||
| chunkSize = qMin(chunkSize - _currentOffset, propagator()->account()->capabilities().tusSupport().max_chunk_size); | ||
| } | ||
| return chunkSize; | ||
| }(); | ||
|
|
||
| QNetworkRequest req = prepareRequest(chunkSize); | ||
| auto device = prepareDevice(chunkSize); | ||
| if (!device) { | ||
| return; | ||
| } | ||
|
|
||
| SimpleNetworkJob *job; | ||
| if (_currentOffset != 0) { | ||
| job = propagator()->account()->sendRequest("PATCH", _location, req, device); | ||
| } else { | ||
| job = makeCreationWithUploadJob(&req, device); | ||
| } | ||
|
|
||
| _jobs.append(job); | ||
| connect(job, &SimpleNetworkJob::finishedSignal, this, &PropagateUploadFileTUS::slotChunkFinished); | ||
| connect(job, &QObject::destroyed, this, &PropagateUploadFileCommon::slotJobDestroyed); | ||
| job->start(); | ||
| } | ||
|
|
||
| void PropagateUploadFileTUS::slotChunkFinished() | ||
| { | ||
| SimpleNetworkJob *job = qobject_cast<SimpleNetworkJob *>(sender()); | ||
| slotJobDestroyed(job); // remove it from the _jobs list | ||
| ASSERT(job); | ||
|
|
||
| _item->_httpErrorCode = job->reply()->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt(); | ||
| _item->_responseTimeStamp = job->responseTimestamp(); | ||
| _item->_requestId = job->requestId(); | ||
|
|
||
| QNetworkReply::NetworkError err = job->reply()->error(); | ||
| if (err != QNetworkReply::NoError) { | ||
| // try to get the offset if possible, only try once | ||
| if (err == QNetworkReply::TimeoutError && !_location.isEmpty() && HttpLogger::requestVerb(*job->reply()) != "HEAD") | ||
| { | ||
| QNetworkRequest req; | ||
| setTusVersionHeader(req); | ||
| auto updateJob = propagator()->account()->sendRequest("HEAD", _location, req); | ||
| _jobs.append(updateJob); | ||
| connect(updateJob, &SimpleNetworkJob::finishedSignal, this, &PropagateUploadFileTUS::slotChunkFinished); | ||
| connect(updateJob, &QObject::destroyed, this, &PropagateUploadFileCommon::slotJobDestroyed); | ||
| updateJob->start(); | ||
| return; | ||
|
|
||
| } | ||
| commonErrorHandling(job); | ||
| return; | ||
| } | ||
|
|
||
| const int offset = job->reply()->rawHeader(uploadOffset()).toInt(); | ||
| propagator()->reportProgress(*_item, offset); | ||
| _currentOffset = offset; | ||
| // first response after a POST request | ||
| if (_location.isEmpty()) { | ||
| _location = job->reply()->header(QNetworkRequest::LocationHeader).toUrl(); | ||
| } | ||
|
|
||
|
|
||
| _finished = offset == _item->_size; | ||
|
|
||
| // Check if the file still exists | ||
| const QString fullFilePath(propagator()->getFilePath(_item->_file)); | ||
| if (!FileSystem::fileExists(fullFilePath)) { | ||
| if (!_finished) { | ||
| abortWithError(SyncFileItem::SoftError, tr("The local file was removed during sync.")); | ||
| return; | ||
| } else { | ||
| propagator()->_anotherSyncNeeded = true; | ||
| } | ||
| } | ||
|
|
||
| // Check whether the file changed since discovery. | ||
| if (!FileSystem::verifyFileUnchanged(fullFilePath, _item->_size, _item->_modtime)) { | ||
| propagator()->_anotherSyncNeeded = true; | ||
| if (!_finished) { | ||
| abortWithError(SyncFileItem::SoftError, tr("Local file changed during sync.")); | ||
| // FIXME: the legacy code was retrying for a few seconds. | ||
| // and also checking that after the last chunk, and removed the file in case of INSTRUCTION_NEW | ||
| return; | ||
| } | ||
| } | ||
| if (!_finished) { | ||
| qCDebug(lcPropagateUploadTUS) << "we need to patch"; | ||
| startNextChunk(); | ||
| return; | ||
| } | ||
| const QByteArray etag = getEtagFromReply(job->reply()); | ||
|
|
||
| _finished = !etag.isEmpty(); | ||
| if (!_finished) { | ||
| auto check = new PropfindJob(propagator()->account(), _item->_file); | ||
| _jobs.append(check); | ||
| check->setProperties({ "http://owncloud.org/ns:fileid", "getetag" }); | ||
| connect(check, &PropfindJob::result, this, [this, check](const QVariantMap &map) { | ||
| _finished = true; | ||
| finalize(Utility::normalizeEtag(map.value("getetag").toByteArray()), map.value("fileid").toByteArray()); | ||
| slotJobDestroyed(check); | ||
| }); | ||
| connect(check, &QObject::destroyed, this, &PropagateUploadFileCommon::slotJobDestroyed); | ||
| check->start(); | ||
| return; | ||
| } | ||
| // the file id should only be empty for new files up- or downloaded | ||
| finalize(etag, job->reply()->rawHeader("OC-FileID")); | ||
| } | ||
|
|
||
| void PropagateUploadFileTUS::finalize(const QByteArray &etag, const QByteArray &fileId) | ||
| { | ||
| ASSERT(_finished); | ||
| qCDebug(lcPropagateUploadTUS) << _item->_etag << etag << fileId; | ||
| _item->_etag = etag; | ||
| if (!fileId.isEmpty()) { | ||
| if (!_item->_fileId.isEmpty() && _item->_fileId != fileId) { | ||
| qCWarning(lcPropagateUploadTUS) << "File ID changed!" << _item->_fileId << fileId; | ||
| } | ||
| _item->_fileId = fileId; | ||
| } | ||
| propagator()->_activeJobList.removeOne(this); | ||
| PropagateUploadFileCommon::finalize(); | ||
| } | ||
|
|
||
| void PropagateUploadFileTUS::abort(PropagatorJob::AbortType abortType) | ||
| { | ||
| abortNetworkJobs( | ||
| abortType, | ||
| [](AbstractNetworkJob *) { | ||
| // TODO | ||
| return true; | ||
| }); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.