Merge pull request #177 from cipherboy/file-handling

Better UX around opened content

Author: matejak

include/MainWindow.h

@@ -29,6 +29,7 @@
 #include <QThread>
 #include <QMenu>
 #include <QMessageBox>
+#include <QFileSystemWatcher>
 
 extern "C"
 {
@@ -65,7 +66,7 @@ class MainWindow : public QMainWindow
         /**
          * @brief Opens a specific file
          */
-        void openFile(const QString& path);
+        void openFile(const QString& path, bool reload = false);
 
         void openSSGDialog(const QString& customDismissLabel = "");
 
@@ -95,6 +96,15 @@ class MainWindow : public QMainWindow
          */
         void closeMainWindowAsync();
 
+        /**
+         * @bried Reloads the opened content
+         *
+         *
+         * If a content file is opened, it might have changed on disk. This
+         * allows the user to update reload it in case it has changed.
+         */
+        void reloadContent();
+
         /**
          * @brief Checks whether a file is currently opened
          */
@@ -236,6 +246,10 @@ class MainWindow : public QMainWindow
         /// If true, the profile combobox change signal is ignored, this avoids unnecessary profile refreshes
         bool mIgnoreProfileComboBox;
 
+        /// Implement watching of original XCCDF/DS
+        QFileSystemWatcher* mFSWatch;
+        QString mFSLastSeen;
+
     signals:
         /**
          * @brief We signal this to show the dialog
@@ -382,6 +396,11 @@ class MainWindow : public QMainWindow
         void markLoadedTailoringFile(const QString& filePath);
         bool unsavedTailoringChanges() const;
 
+        /**
+         * @brief Slot handler for notifying user that opened files changed
+         */
+        void fileChanged(const QString& path);
+
     public:
         QString getDefaultSaveDirectory();
         void notifySaveActionConfirmed(const QString& path, bool isDir);

include/ScanningSession.h

@@ -24,6 +24,7 @@
 
 #include "ForwardDecls.h"
 
+#include <QTemporaryDir>
 #include <QTemporaryFile>
 #include <QSet>
 #include <QDir>
@@ -61,7 +62,7 @@ class ScanningSession
          * Passed file may be an XCCDF file (any openscap supported version)
          * or source datastream (SDS) file (any openscap supported version)
          */
-        void openFile(const QString& path);
+        void openFile(const QString& path, bool reload = false);
 
         /**
          * @brief Closes currently opened file (if any)
@@ -75,6 +76,16 @@ class ScanningSession
          */
         QString getOpenedFilePath() const;
 
+        /**
+         * @brief Retrieves full absolute path of the opened file
+         */
+        QString getOriginalFilePath() const;
+
+        /**
+         * @brief Retrives the closure set of the original file
+         */
+        QSet<QString> getOriginalClosure() const;
+
         /**
          * @brief A helper method that gets the longest common ancestor dir from a set of paths
          */
@@ -280,6 +291,15 @@ class ScanningSession
         /// Our own tailoring that may or may not initially be loaded from a file
         mutable struct xccdf_tailoring* mTailoring;
 
+        /// Temporary copy of opened DS or XCCDF file
+        QTemporaryDir* mTempOpenDir;
+        /// Path to temporary DS or XCCDF file
+        QString mTempOpenPath;
+        /// Path to original DS or XCCDF file
+        QString mOriginalOpenPath;
+        /// Closure of original DS or XCCDF file
+        QSet<QString> mClosureOfOriginalFile;
+
         /// Temporary file provides auto deletion and a valid temp file path
         QTemporaryFile mTailoringFile;
         /// Temporary file provides auto deletion and a valid temp file path
@@ -297,6 +317,16 @@ class ScanningSession
 
         QString mUserTailoringFile;
         QString mUserTailoringCID;
+
+        /// Gets the dependency closure of the specified file.
+        void updateDependencyClosureOfFile(const QString& filePath, QSet<QString>& targetSet) const;
+
+        /// Clones openFile(path) to a Temporary File
+        void cloneToTemporaryFile(const QString& path);
+        /// Closes mOpenFile if it is open
+        void cleanTmpDir();
+        /// Copies all files from the path into the temporary location
+        void copyTempFiles(QString path, QString baseDirectory, const QFileInfo pathInfo);
 };
 
 #endif

src/MainWindow.cpp

@@ -37,8 +37,10 @@
 #include "RemediationRoleSaver.h"
 
 #include <QFileDialog>
+#include <QPushButton>
 #include <QAbstractEventDispatcher>
 #include <QCloseEvent>
+#include <QFileSystemWatcher>
 #include <QDesktopWidget>
 #include <QMenu>
 
@@ -85,6 +87,9 @@ MainWindow::MainWindow(QWidget* parent):
 
     mIgnoreProfileComboBox(false),
 
+    mFSWatch(new QFileSystemWatcher()),
+    mFSLastSeen(""),
+
     mRuleResultsExpanded(false)
 {
     mUI.setupUi(this);
@@ -125,6 +130,10 @@ MainWindow::MainWindow(QWidget* parent):
         mUI.actionOpenCustomizationFile, SIGNAL(triggered()),
         this, SLOT(openCustomizationFile())
     );
+    QObject::connect(
+        mUI.actionReloadContent, SIGNAL(triggered()),
+        this, SLOT(reloadContent())
+    );
     QObject::connect(
         mUI.checklistComboBox, SIGNAL(currentIndexChanged(int)),
         this, SLOT(checklistComboboxChanged(int))
@@ -272,6 +281,11 @@ MainWindow::MainWindow(QWidget* parent):
     remediationButtonMenu->addAction(genAnsibleRemediation);
     remediationButtonMenu->addAction(genPuppetRemediation);
     mUI.genRemediationButton->setMenu(remediationButtonMenu);
+
+    QObject::connect(
+        mFSWatch, SIGNAL(fileChanged(const QString&)),
+        this, SLOT(fileChanged(const QString&))
+    );
 }
 
 MainWindow::~MainWindow()
@@ -288,6 +302,9 @@ MainWindow::~MainWindow()
 
     delete mQSettings;
     mQSettings = 0;
+
+    delete mFSWatch;
+    mFSWatch = NULL;
 }
 
 void MainWindow::setSkipValid(bool skipValid)
@@ -333,7 +350,7 @@ void MainWindow::clearResults()
     mUI.actionOpen->setEnabled(true);
 }
 
-void MainWindow::openFile(const QString& path)
+void MainWindow::openFile(const QString& path, bool reload)
 {
     try
     {
@@ -348,7 +365,7 @@ void MainWindow::openFile(const QString& path)
         }
 
         mScanningSession->setSkipValid(mSkipValid);
-        mScanningSession->openFile(inputPath);
+        mScanningSession->openFile(inputPath, reload);
 
         // In case openscap autonegotiated opening a tailoring file directly
         if (tailoringPath.isEmpty() && mScanningSession->hasTailoring())
@@ -375,6 +392,14 @@ void MainWindow::openFile(const QString& path)
 
         centralWidget()->setEnabled(true);
 
+        // Refill mFSWatch after opening file
+        mFSWatch->removePaths(mFSWatch->files());
+        for (const QString path : mScanningSession->getOriginalClosure())
+        {
+            mFSWatch->addPath(path);
+        }
+        mFSLastSeen = "";
+
         mDiagnosticsDialog->infoMessage(QObject::tr("Opened file '%1'.").arg(path));
     }
     catch (const std::exception& e)
@@ -423,7 +448,7 @@ void MainWindow::openFileDialog()
 
         if (fileOpened())
         {
-            if (openNewFileQuestionDialog(mScanningSession->getOpenedFilePath()) == QMessageBox::Yes)
+            if (openNewFileQuestionDialog(mScanningSession->getOriginalFilePath()) == QMessageBox::Yes)
                 closeFile();
             else
                 // user cancelled closing current file, we have to abort
@@ -489,7 +514,7 @@ void MainWindow::openSSGDialog(const QString& customDismissLabel)
 
             if (fileOpened())
             {
-                if (openNewFileQuestionDialog(mScanningSession->getOpenedFilePath()) == QMessageBox::Yes)
+                if (openNewFileQuestionDialog(mScanningSession->getOriginalFilePath()) == QMessageBox::Yes)
                 {
                     closeFile();
                 }
@@ -524,6 +549,24 @@ void MainWindow::openTailoringFile(const QString& path)
     refreshTailoringProfiles();
 }
 
+void MainWindow::reloadContent()
+{
+    const QString currentFile = mScanningSession->getOriginalFilePath();
+    openFile(currentFile, true);
+
+    if (!fileOpened())
+    {
+        // Error occurred, keep pumping events and don't move on until user
+        // dismisses diagnostics dialog.
+        mDiagnosticsDialog->waitUntilHidden();
+
+        if (!close())
+        {
+            throw MainWindowException("Failed to close main window!");
+        }
+    }
+}
+
 void MainWindow::closeMainWindowAsync()
 {
     emit closeMainWindow();
@@ -581,6 +624,7 @@ void MainWindow::scanAsync(ScannerMode scannerMode)
 
     mUI.menuSave->setEnabled(false);
     mUI.actionOpen->setEnabled(false);
+    mUI.actionReloadContent->setEnabled(false);
 
     mUI.ruleResultsTree->prepareForScanning();
 
@@ -599,6 +643,7 @@ void MainWindow::scanAsync(ScannerMode scannerMode)
 
         mUI.menuSave->setEnabled(true);
         mUI.actionOpen->setEnabled(true);
+        mUI.actionReloadContent->setEnabled(true);
 
         return;
     }
@@ -1275,6 +1320,7 @@ void MainWindow::scanEnded(bool canceled)
 
     mUI.menuSave->setEnabled(true);
     mUI.actionOpen->setEnabled(true);
+    mUI.actionReloadContent->setEnabled(true);
 
     cleanupScanThread();
 }
@@ -1507,6 +1553,29 @@ bool MainWindow::unsavedTailoringChanges() const
     return mUI.tailoringFileComboBox->currentIndex() == idx;
 }
 
+void MainWindow::fileChanged(const QString& path)
+{
+    if (path == mFSLastSeen)
+        return;
+    mFSLastSeen = path;
+
+    QMessageBox question;
+    question.setText(QObject::tr("The following file was modified after opening: %1").arg(path));
+    question.setInformativeText(QObject::tr("Do you wish to reload it, losing any unsaved tailoring changes?"));
+
+    QPushButton *reload = question.addButton(QObject::tr("Reload"), QMessageBox::AcceptRole);
+    QPushButton *ignore = question.addButton(QObject::tr("Ignore"), QMessageBox::RejectRole);
+    question.setDefaultButton(ignore);
+    question.setIcon(QMessageBox::Question);
+
+    question.exec();
+
+    if (question.clickedButton() == reload)
+    {
+        reloadContent();
+    }
+}
+
 QString MainWindow::getDefaultSaveDirectory()
 {
     return mQSettings->value("last_save_directory", "").toString();