Add sync task

2026-04-23 12:39:24 -05:00 · 2017-12-15 13:28:24 +01:00
parent 75cf6dcf71
commit 603078af53
3 changed files with 212 additions and 0 deletions
@@ -0,0 +1,138 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2017                                                               *
+ *                                                                                       *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
+ * software and associated documentation files (the "Software"), to deal in the Software *
+ * without restriction, including without limitation the rights to use, copy, modify,    *
+ * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
+ * permit persons to whom the Software is furnished to do so, subject to the following   *
+ * conditions:                                                                           *
+ *                                                                                       *
+ * The above copyright notice and this permission notice shall be included in all copies *
+ * or substantial portions of the Software.                                              *
+ *                                                                                       *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
+ ****************************************************************************************/
+
+#include <modules/sync/tasks/syncassettask.h>
+
+#include <openspace/openspace.h>
+#include <openspace/documentation/verifier.h>
+#include <openspace/util/synchronizationwatcher.h>
+#include <openspace/scripting/scriptengine.h>
+
+
+#include <ghoul/filesystem/filesystem.h>
+#include <ghoul/logging/logmanager.h>
+
+#include <string>
+#include <fstream>
+#include <chrono>
+
+
+namespace {
+    const char* KeyAsset = "Asset";
+    const std::string _loggerCat = "SyncAssetTask";
+    std::chrono::milliseconds ProgressPollInterval(200);
+} // namespace
+
+namespace openspace {
+
+SyncAssetTask::SyncAssetTask(const ghoul::Dictionary& dictionary)
+{
+    openspace::documentation::testSpecificationAndThrow(
+        documentation(),
+        dictionary,
+        "SyncAssetTask"
+    );
+
+    _asset = dictionary.value<std::string>(KeyAsset);
+}
+
+std::string SyncAssetTask::description() {
+    return "Synchronize asset " + _asset;
+}
+
+void SyncAssetTask::perform(const Task::ProgressCallback & progressCallback) {
+    SynchronizationWatcher watcher;
+
+    scripting::ScriptEngine scriptEngine;
+    scriptEngine.initialize();
+
+    ghoul::lua::LuaState luaState;
+    scriptEngine.initializeLuaState(luaState);
+
+    AssetLoader loader(luaState, &watcher, "${ASSETS}");
+
+    RequestListener listener;
+    loader.addAssetListener(&listener);
+
+    loader.add(_asset);
+    loader.rootAsset()->startSynchronizations();
+
+    std::vector<std::shared_ptr<Asset>> allAssets = loader.rootAsset()->subTreeAssets();
+
+    while (true) {      
+        bool inProgress = false;
+        for (const std::shared_ptr<Asset>& asset : allAssets) {
+            Asset::State state = asset->state();
+            if (state == Asset::State::Unloaded || 
+                state == Asset::State::Loaded ||
+                state == Asset::State::Synchronizing) {
+                inProgress = true;
+            }
+        }
+        progressCallback(loader.rootAsset()->requestedSynchronizationProgress());
+        std::this_thread::sleep_for(ProgressPollInterval);
+        watcher.notify();
+        if (!inProgress) {
+            return;
+        }
+    }
+    progressCallback(1.f);
+}
+
+documentation::Documentation SyncAssetTask::documentation() {
+    using namespace documentation;
+    return {
+        "SyncAssetTask",
+        "sync_asset_task",
+        {
+            {
+                "Type",
+                new StringEqualVerifier("SyncAssetTask"),
+                Optional::No,
+                "The type of this task"
+            },
+            {
+                KeyAsset,
+                new StringAnnotationVerifier("A file path to an asset"),
+                Optional::No,
+                "The asset file to sync"
+            }
+        }
+    };
+}
+
+
+void SyncAssetTask::RequestListener::assetStateChanged(std::shared_ptr<Asset> asset,
+    Asset::State state)
+{
+    if (state == Asset::State::LoadingFailed) {
+        LERROR("Failed to load asset " << asset->id());
+    }
+    if (state == Asset::State::SyncRejected) {
+        LERROR("Failed to sync asset " << asset->id());
+    }
+}
+
+
+} // namespace openspace
@@ -0,0 +1,66 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2017                                                               *
+ *                                                                                       *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
+ * software and associated documentation files (the "Software"), to deal in the Software *
+ * without restriction, including without limitation the rights to use, copy, modify,    *
+ * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
+ * permit persons to whom the Software is furnished to do so, subject to the following   *
+ * conditions:                                                                           *
+ *                                                                                       *
+ * The above copyright notice and this permission notice shall be included in all copies *
+ * or substantial portions of the Software.                                              *
+ *                                                                                       *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
+ ****************************************************************************************/
+
+#ifndef __OPENSPACE_MODULE_SYNC___SYNCASSETTASK___H__
+#define __OPENSPACE_MODULE_SYNC___SYNCASSETTASK___H__
+
+#include <openspace/util/task.h>
+
+#include <string>
+#include <memory>
+#include <unordered_set>
+
+#include <openspace/scene/asset.h>
+#include <openspace/scene/assetloader.h>
+
+namespace openspace {
+
+
+class SyncAssetTask : public Task {
+public:
+    class RequestListener : public AssetListener {
+    public:
+
+        void assetStateChanged(std::shared_ptr<Asset> asset,
+                               Asset::State state) override;
+
+        void assetRequested(std::shared_ptr<Asset> parent,
+                            std::shared_ptr<Asset> child) {};
+
+        void assetUnrequested(std::shared_ptr<Asset> parent,
+                              std::shared_ptr<Asset> child) {};
+    };
+
+    SyncAssetTask(const ghoul::Dictionary& dictionary);
+    std::string description() override;
+    void perform(const Task::ProgressCallback& progressCallback) override;
+    static documentation::Documentation documentation();
+
+private:
+    std::string _asset;
+};
+
+} // namespace openspace
+
+#endif // __OPENSPACE_MODULE_SYNC___SYNCASSETTASK___H__