Save temporary files under temp/ManiVault/<session_id>/

Create temporary /temp/ManiVault/<session_id>/ directory at application startup
Create ManiVault TemporaryDir class which refers to the correct application session based temorary directory
Remove comments from serializable class

HDPS/cmake/CMakeMvSourcesPublic.cmake

@@ -453,6 +453,7 @@ set(PUBLIC_UTIL_HEADERS
     src/util/Version.h
     src/util/DockWidgetPermission.h
     src/util/NumericalRange.h
+    src/util/TemporaryDir.h
 )
 
 if(APPLE)
@@ -494,6 +495,7 @@ set(PUBLIC_UTIL_SOURCES
     src/util/Version.cpp
     src/util/DockWidgetPermission.cpp
     src/util/NumericalRange.cpp
+    src/util/TemporaryDir.cpp
 )
 
 if(APPLE)

HDPS/src/AbstractProjectManager.h

@@ -12,9 +12,10 @@
 #include "actions/RecentFilesAction.h"
 #include "actions/ToggleAction.h"
 
+#include "util/TemporaryDir.h"
+
 #include <QObject>
 #include <QMenu>
-#include <QTemporaryDir>
 
 namespace mv {
 
@@ -160,7 +161,7 @@ class AbstractProjectManager : public AbstractManager
      * @param filePath Relative file path of the file that needs to be extracted
      * @return File path of the extracted file, empty string if extraction failed
      */
-    virtual QString extractFileFromManiVaultProject(const QString& maniVaultFilePath, QTemporaryDir& temporaryDir, const QString& filePath) = 0;
+    virtual QString extractFileFromManiVaultProject(const QString& maniVaultFilePath, mv::util::TemporaryDir& temporaryDir, const QString& filePath) = 0;
 
     /**
      * Get preview image of the project workspace

HDPS/src/Application.cpp

@@ -19,6 +19,8 @@
 #include <QDebug>
 #include <QMessageBox>
 #include <QMainWindow>
+#include <QUuid>
+#include <QDir>
 
 using namespace mv::gui;
 using namespace mv::util;
@@ -27,6 +29,7 @@ namespace mv {
 
 Application::Application(int& argc, char** argv) :
     QApplication(argc, argv),
+    _id(QUuid::createUuid().toString(QUuid::WithoutBraces)),
     _core(nullptr),
     _version({ 0, 9 }),
     _iconFonts(),
@@ -38,6 +41,12 @@ Application::Application(int& argc, char** argv) :
     _startupProjectMetaAction(nullptr),
     _startupTask(nullptr)
 {
+    const auto tempDirectory = QDir::cleanPath(QDir::tempPath() + QDir::separator() + "ManiVault" + QDir::separator() + _id);
+
+    QDir dir(tempDirectory);
+
+    dir.mkdir(tempDirectory);
+
     _iconFonts.add(QSharedPointer<IconFont>(new FontAwesome(5, 14, {
             //":/IconFonts/FontAwesomeBrandsRegular-5.14.otf",
             //":/IconFonts/FontAwesomeRegular-5.14.otf",
@@ -205,4 +214,9 @@ ApplicationStartupTask& Application::getStartupTask()
     return *_startupTask;
 }
 
+QString Application::getId() const
+{
+    return _id;
+}
+
 }

HDPS/src/Application.h

@@ -42,6 +42,9 @@ class Application final : public QApplication
 
 public: // Miscellaneous
 
+    /** Get the globally unique identifier of the application instance */
+    QString getId() const;
+
     /** Returns a pointer to the current HDPS application (if the current application derives from mv::Application) */
     static Application* current();
 
@@ -200,6 +203,7 @@ class Application final : public QApplication
     void mainWindowInitialized();
 
 protected:
+    QString                 _id;                                /** Globally unique identifier of the application instance */
     CoreInterface*          _core;                              /** Pointer to HDPS core */
     const util::Version     _version;                           /** Application version */
     IconFonts               _iconFonts;                         /** Icon fonts resource */

HDPS/src/Main.cpp

@@ -6,6 +6,8 @@
 #include "private/Archiver.h"
 #include "private/Core.h"
 
+#include "util/TemporaryDir.h"
+
 #include <Application.h>
 #include <ProjectMetaAction.h>
 
@@ -17,7 +19,6 @@
 #include <QProxyStyle>
 #include <QQuickWindow>
 #include <QCommandLineParser>
-#include <QTemporaryDir>
 
 using namespace mv;
 using namespace mv::util;
@@ -40,7 +41,7 @@ class NoFocusProxyStyle : public QProxyStyle {
 ProjectMetaAction* getStartupProjectMetaAction(const QString& startupProjectFilePath)
 {
     try {
-        QTemporaryDir temporaryDir;
+        TemporaryDir temporaryDir;
 
         const QString metaJsonFilePath("meta.json");
 

HDPS/src/Project.cpp

@@ -8,8 +8,7 @@
 #include "Set.h"
 
 #include "util/Serialization.h"
-
-#include <QTemporaryDir>
+#include "util/TemporaryDir.h"
 
 using namespace mv::gui;
 using namespace mv::util;
@@ -187,7 +186,7 @@ ProjectMetaAction& Project::getProjectMetaAction()
 
 QSharedPointer<ProjectMetaAction> Project::getProjectMetaActionFromProjectFilePath(const QString& projectFilePath)
 {
-    QTemporaryDir temporaryDir;
+    TemporaryDir temporaryDir;
 
     const auto projectMetaJsonFilePath = projects().extractFileFromManiVaultProject(projectFilePath, temporaryDir, "meta.json");
 

HDPS/src/private/ProjectManager.cpp

@@ -23,7 +23,6 @@
 #include <QStandardPaths>
 #include <QGridLayout>
 #include <QEventLoop>
-#include <QTemporaryDir>
 
 #include <exception>
 
@@ -338,7 +337,7 @@ void ProjectManager::openProject(QString filePath /*= ""*/, bool importDataOnly
             if (QFileInfo(filePath).isDir())
                 throw std::runtime_error("Project file path may not be a directory");
 
-            QTemporaryDir temporaryDirectory;
+            TemporaryDir temporaryDirectory;
 
             const auto temporaryDirectoryPath = temporaryDirectory.path();
 
@@ -547,7 +546,7 @@ void ProjectManager::saveProject(QString filePath /*= ""*/, const QString& passw
             if (QFileInfo(filePath).isDir())
                 throw std::runtime_error("Project file path may not be a directory");
 
-            QTemporaryDir temporaryDirectory;
+            TemporaryDir temporaryDirectory;
 
             const auto temporaryDirectoryPath = temporaryDirectory.path();
 
@@ -742,7 +741,7 @@ void ProjectManager::publishProject(QString filePath /*= ""*/)
             if (QFileInfo(filePath).isDir())
                 throw std::runtime_error("Project file path may not be a directory");
 
-            QTemporaryDir temporaryDirectory;
+            TemporaryDir temporaryDirectory;
 
             const auto temporaryDirectoryPath = temporaryDirectory.path();
 
@@ -899,7 +898,7 @@ mv::Project* ProjectManager::getCurrentProject()
     return _project.get();
 }
 
-QString ProjectManager::extractFileFromManiVaultProject(const QString& maniVaultFilePath, QTemporaryDir& temporaryDir, const QString& filePath)
+QString ProjectManager::extractFileFromManiVaultProject(const QString& maniVaultFilePath, TemporaryDir& temporaryDir, const QString& filePath)
 {
     const auto temporaryDirectoryPath = temporaryDir.path();
 
@@ -933,7 +932,7 @@ QImage ProjectManager::getWorkspacePreview(const QString& projectFilePath, const
 {
     try
     {
-        QTemporaryDir temporaryDir;
+        TemporaryDir temporaryDir;
 
         const auto workspacePreviewFilePath = projects().extractFileFromManiVaultProject(projectFilePath, temporaryDir, "workspace.jpg");
 

HDPS/src/private/ProjectManager.h

@@ -8,7 +8,6 @@
 
 #include <QObject>
 #include <QPointer>
-#include <QTemporaryDir>
 
 /**
  * Project manager class
@@ -106,7 +105,7 @@ class ProjectManager final : public mv::AbstractProjectManager
      * @param filePath Relative file path of the file that needs to be extracted
      * @return File path of the extracted file, empty string if extraction failed
      */
-    QString extractFileFromManiVaultProject(const QString& maniVaultFilePath, QTemporaryDir& temporaryDir, const QString& filePath) override;
+    QString extractFileFromManiVaultProject(const QString& maniVaultFilePath, mv::util::TemporaryDir& temporaryDir, const QString& filePath) override;
 
     /**
      * Get preview image of the project workspace

HDPS/src/private/WorkspaceManager.cpp

@@ -10,20 +10,19 @@
 #include "Archiver.h"
 #include "WorkspaceSettingsDialog.h"
 
-#include <Application.h>
-#include <CoreInterface.h>
+#include "Application.h"
+#include "CoreInterface.h"
 
-#include <actions/StringsAction.h>
+#include "actions/StringsAction.h"
 
-#include <util/Serialization.h>
-#include <util/Icon.h>
+#include "util/Serialization.h"
+#include "util/Icon.h"
 
 #include <QMainWindow>
 #include <QToolButton>
 #include <QPainter>
 #include <QFileDialog>
 #include <QStandardPaths>
-#include <QTemporaryDir>
 #include <QBuffer>
 #include <QOpenGLWidget>
 #include <QEventLoop>
@@ -344,7 +343,7 @@ void WorkspaceManager::loadWorkspace(QString filePath /*= ""*/, bool addToRecent
 
 void WorkspaceManager::importWorkspaceFromProjectFile(QString projectFilePath /*= ""*/, bool addToRecentWorkspaces /*= true*/)
 {
-    QTemporaryDir temporaryDirectory;
+    TemporaryDir temporaryDirectory;
 
     const auto temporaryDirectoryPath = temporaryDirectory.path();
 

HDPS/src/util/Serializable.h

@@ -118,32 +118,6 @@ class Serializable
      */
     static QString createId();
 
-//public: // State
-//
-//    /**
-//     * Get the state of the serializable object (the state is not automatically set)
-//     * @return State of the serializable object
-//     */
-//    virtual State getState() const final;
-//
-//    /**
-//     * Set the state of the serializable object to \p state
-//     * @param state State of the serializable object
-//     */
-//    virtual void setState(const State& state) final;
-//
-//    /**
-//     * Get whether the serializable object is currently being read
-//     * @return Whether the serializable object is currently being read
-//     */
-//    virtual bool isReading() const final;
-//
-//    /**
-//     * Get whether the serializable object is currently being written
-//     * @return Whether the serializable object is currently being written
-//     */
-//    virtual bool isWriting() const final;
-
 protected: // Serialization
 
     /**
@@ -204,7 +178,6 @@ class Serializable
 private:
     QString     _id;                    /** Globally unique identifier of the serializable object */
     QString     _serializationName;     /** Serialization name */
-//    State       _state;                 /** Determines the state of the serializable object (the state is not automatically set) */
 };
 
 }

HDPS/src/util/TemporaryDir.cpp

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later 
+// A corresponding LICENSE file is located in the root directory of this source tree 
+// Copyright (C) 2023 BioVault (Biomedical Visual Analytics Unit LUMC - TU Delft) 
+
+#include "TemporaryDir.h"
+#include "Application.h"
+
+#include <QDir>
+
+namespace mv::util {
+
+TemporaryDir::TemporaryDir() :
+    QTemporaryDir(QDir::cleanPath(QDir::tempPath() + QDir::separator() + "ManiVault" + QDir::separator() + Application::current()->getId()))
+{
+    qDebug() << QDir::cleanPath(QDir::tempPath() + QDir::separator() + "ManiVault" + QDir::separator() + Application::current()->getId());
+}
+
+}

HDPS/src/util/TemporaryDir.h

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later 
+// A corresponding LICENSE file is located in the root directory of this source tree 
+// Copyright (C) 2023 BioVault (Biomedical Visual Analytics Unit LUMC - TU Delft) 
+
+#pragma once
+
+#include <QTemporaryDir>
+
+namespace mv::util {
+
+/**
+ * Temporary directory class
+ *
+ * Wrapper around QTemporaryDir to ensure that all ManiVault temporary data will reside somewhere in /temp/ManiVault
+ *
+ * @author Thomas Kroes
+ */
+class TemporaryDir final : public QTemporaryDir
+{
+public:
+
+    /**
+     * Construct temporary dir
+     * Constructs the QTemporaryDir with a temp/ManiVault template path
+     */
+    TemporaryDir();
+
+    /** Do not allow users of the temporary dir to construct a temporary dir with their own template path */
+    TemporaryDir(const QString& templatePath) = delete;
+};
+
+}