Add socket api call for hydration

Author: TheOneRing

src/gui/socketapi/socketapi.cpp

@@ -662,7 +662,33 @@ void SocketApi::command_V2_LIST_ACCOUNTS(const QSharedPointer<SocketApiJobV2> &j
         out << QJsonObject(
             {{QStringLiteral("name"), acc->account()->displayNameWithHost()}, {QStringLiteral("uuid"), acc->account()->uuid().toString(QUuid::WithoutBraces)}});
     }
-    job->success({ { QStringLiteral("accounts"), out } });
+    job->success({{QStringLiteral("accounts"), out}});
+}
+
+void SocketApi::command_V2_HYDRATE_FILE(const QSharedPointer<SocketApiJobV2> &job) const
+{
+    const auto &arguments = job->arguments();
+
+    const QString file = arguments[QStringLiteral("file")].toString();
+    const QByteArray fileId = arguments[QStringLiteral("fileId")].toString().toUtf8();
+
+    auto fileData = FileData::get(file);
+
+    if (fileData.folder) {
+        auto watcher = new QFutureWatcher<Result<void, QString>>();
+        connect(watcher, &QFutureWatcher<Result<void, QString>>::finished, this, [job, watcher] {
+            const auto resut = watcher->result<Result<void, QString>>();
+            watcher->deleteLater();
+            if (!resut) {
+                job->success({{QStringLiteral("status"), QStringLiteral("ERROR")}, {QStringLiteral("error"), resut.error()}});
+            } else {
+                job->success({{QStringLiteral("status"), QStringLiteral("OK")}});
+            }
+        });
+        watcher->setFuture(fileData.folder->vfs().hydrateFile(fileId));
+    } else {
+        job->failure(QStringLiteral("cannot hydrate unknown file"));
+    }
 }
 
 void SocketApi::command_V2_GET_CLIENT_ICON(const QSharedPointer<SocketApiJobV2> &job) const

src/gui/socketapi/socketapi.h

@@ -118,6 +118,8 @@ private Q_SLOTS:
     // External sync
     Q_INVOKABLE void command_V2_LIST_ACCOUNTS(const QSharedPointer<SocketApiJobV2> &job) const;
 
+    Q_INVOKABLE void command_V2_HYDRATE_FILE(const QSharedPointer<SocketApiJobV2> &job) const;
+
     // Sends the id and the client icon as PNG image (base64 encoded) in Json key "png"
     // e.g. { "id" : "1", "arguments" : { "png" : "hswehs343dj8..." } } or an error message in key "error"
     //

src/libsync/vfs/vfs.cpp

@@ -144,6 +144,12 @@ void Vfs::wipeDehydratedVirtualFiles()
     // But hydrated placeholders may still be around.
 }
 
+QFuture<Result<void, QString>> Vfs::hydrateFile(const QByteArray &fileId)
+{
+    // nothing to do
+    return QtFuture::makeReadyValueFuture(Result<void, QString>{});
+}
+
 Q_LOGGING_CATEGORY(lcPlugin, "sync.plugins", QtInfoMsg)
 
 OCC::VfsPluginManager *OCC::VfsPluginManager::_instance = nullptr;

src/libsync/vfs/vfs.h

@@ -27,6 +27,7 @@
 #include <QUrl>
 #include <QVersionNumber>
 
+#include <QFuture>
 #include <filesystem>
 #include <memory>
 
@@ -202,6 +203,15 @@ class OPENCLOUD_SYNC_EXPORT Vfs : public QObject
      */
     void wipeDehydratedVirtualFiles();
 
+
+    /** Start a hydration (download of remote contents) of a file.
+     *
+     * The fileId is the SyncFileItem::id() value of the file to hydrate.
+     *
+     * Returns a QFuture<Result> void if successful and QFuture<Result> QString if an error occurs.
+     */
+    [[nodiscard]] virtual QFuture<Result<void, QString>> hydrateFile(const QByteArray &fileId);
+
 public Q_SLOTS:
     /** Update in-sync state based on SyncFileStatusTracker signal.
      *