From 9e548e0625a819052cd10d5c4bf129dde649a6a4 Mon Sep 17 00:00:00 2001
From: Alexey Rusakov <Kitsune-Ral@users.sf.net>
Date: Thu, 9 Sep 2021 19:27:57 +0200
Subject: Straighten up file transfer cancellation

There was a mess with fileTransferCancelled(); it was only emitted when
a download (but not an upload) was cancelled; besides, in case of
downloads a file transfer info structure was getting deleted whereas
uploads left a file transfer in Cancelled status. This all now converges
on:
- fileTransferFailed() for both failures and cancellations (to simplify
  slot connection, and also to follow the practice in, e.g., Qt Network).
- the file transfer info structure is kept around in Cancelled status,
  following the logic used for failures. There's no particular cleanup
  which may become a problem if one uploads and cancels many times
  (download file transfers are keyed to event ids, mitigating
  the problem); this will be fixed in another commit.

Closes #503. Closes #504.
---
 lib/room.cpp | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

(limited to 'lib/room.cpp')

diff --git a/lib/room.cpp b/lib/room.cpp
index 890da13d..c6cca2ea 100644
--- a/lib/room.cpp
+++ b/lib/room.cpp
@@ -1708,6 +1708,12 @@ QString Room::retryMessage(const QString& txnId)
     return d->doSendEvent(it->event());
 }
 
+// Lambda defers actual tr() invocation to the moment when translations are
+// initialised
+const auto FileTransferCancelledMsg = [] {
+    return Room::tr("File transfer cancelled");
+};
+
 void Room::discardMessage(const QString& txnId)
 {
     auto it = std::find_if(d->unsyncedEvents.begin(), d->unsyncedEvents.end(),
@@ -1722,7 +1728,7 @@ void Room::discardMessage(const QString& txnId)
         if (isJobPending(transferIt->job)) {
             transferIt->status = FileTransferInfo::Cancelled;
             transferIt->job->abandon();
-            emit fileTransferFailed(txnId, tr("File upload cancelled"));
+            emit fileTransferFailed(txnId, FileTransferCancelledMsg());
         } else if (transferIt->status == FileTransferInfo::Completed) {
             qCWarning(MAIN)
                 << "File for transaction" << txnId
@@ -1790,7 +1796,7 @@ QString Room::Private::doPostFile(RoomEventPtr&& msgEvent, const QUrl& localUrl)
                                        "cancelled";
                 }
             });
-    connect(q, &Room::fileTransferCancelled, transferJob,
+    connect(q, &Room::fileTransferFailed, transferJob,
             [this, txnId](const QString& tId) {
                 if (tId != txnId)
                     return;
@@ -2079,16 +2085,16 @@ void Room::downloadFile(const QString& eventId, const QUrl& localFilename)
 
 void Room::cancelFileTransfer(const QString& id)
 {
-    const auto it = d->fileTransfers.constFind(id);
-    if (it == d->fileTransfers.cend()) {
+    const auto it = d->fileTransfers.find(id);
+    if (it == d->fileTransfers.end()) {
         qCWarning(MAIN) << "No information on file transfer" << id << "in room"
                         << d->id;
         return;
     }
     if (isJobPending(it->job))
         it->job->abandon();
-    d->fileTransfers.remove(id);
-    emit fileTransferCancelled(id);
+    it->status = FileTransferInfo::Cancelled;
+    emit fileTransferFailed(id, FileTransferCancelledMsg());
 }
 
 void Room::Private::dropDuplicateEvents(RoomEvents& events) const
-- 
cgit v1.2.3