Add file integrity check confirm

Author: CrSjimo

src/plugins/coreplugin/project/document/ProjectDocumentContext.cpp

@@ -57,11 +57,21 @@ namespace Core {
         Q_EMIT q->saved();
     }
 
-    QByteArray ProjectDocumentContextPrivate::serializeDocument() const {
+    QByteArray ProjectDocumentContextPrivate::serializeDocument(bool *hasError) const {
         QDspx::SerializationErrorList errors;
         auto model = document->model()->toQDspx();
         writeEditorInfo(model);
-        return QDspx::Serializer::serialize(model, errors, QDspx::Serializer::CheckError);
+        auto data = QDspx::Serializer::serialize(model, errors, QDspx::Serializer::CheckError);
+        if (errors.containsError()) {
+            if (hasError) {
+                *hasError = true;
+            }
+        } else {
+            if (hasError) {
+                *hasError = false;
+            }
+        }
+        return data;
     }
 
     bool ProjectDocumentContextPrivate::initializeDocument(const QDspx::Model &model, bool doCheck) {
@@ -204,7 +214,14 @@ namespace Core {
         Q_D(ProjectDocumentContext);
         if (!d->fileLocker || d->fileLocker->path().isEmpty())
             return false;
-        auto data = d->serializeDocument();
+        bool hasError;
+        auto data = d->serializeDocument(&hasError);
+        if (hasError) {
+            qCWarning(lcProjectDocumentContext) << "Failed to serialize document.";
+            if (!d->openSaveProjectFileScenario->confirmSaveFileIntegrity()) {
+                return false;
+            }
+        }
         bool isSuccess = d->fileLocker->save(data);
         if (!isSuccess) {
             qCCritical(lcProjectDocumentContext) << "Failed to save file:" << d->fileLocker->path();
@@ -219,7 +236,14 @@ namespace Core {
         Q_D(ProjectDocumentContext);
         if (!d->fileLocker)
             return false;
-        auto data = d->serializeDocument();
+        bool hasError;
+        auto data = d->serializeDocument(&hasError);
+        if (hasError) {
+            qCWarning(lcProjectDocumentContext) << "Failed to serialize document.";
+            if (!d->openSaveProjectFileScenario->confirmSaveFileIntegrity()) {
+                return false;
+            }
+        }
         bool isSuccess = d->fileLocker->saveAs(filePath, data);
         if (!isSuccess) {
             qCCritical(lcProjectDocumentContext) << "Failed to save file as:" << d->fileLocker->path();
@@ -233,7 +257,14 @@ namespace Core {
     bool ProjectDocumentContext::saveCopy(const QString &filePath) {
         Q_D(ProjectDocumentContext);
         FileLocker copyFileLocker;
-        auto data = d->serializeDocument();
+        bool hasError;
+        auto data = d->serializeDocument(&hasError);
+        if (hasError) {
+            qCWarning(lcProjectDocumentContext) << "Failed to serialize document.";
+            if (!d->openSaveProjectFileScenario->confirmSaveFileIntegrity()) {
+                return false;
+            }
+        }
         bool isSuccess = copyFileLocker.saveAs(filePath, data);
         if (!isSuccess) {
             qCCritical(lcProjectDocumentContext) << "Failed to save copy file:" << d->fileLocker->path();

src/plugins/coreplugin/project/document/ProjectDocumentContext_p.h

@@ -17,7 +17,7 @@ namespace Core {
         OpenSaveProjectFileScenario *openSaveProjectFileScenario;
 
         void markSaved();
-        QByteArray serializeDocument() const;
+        QByteArray serializeDocument(bool *hasError = nullptr) const;
 
         bool deserializeAndInitializeDocument(const QByteArray &data);
         bool initializeDocument(const QDspx::Model &model, bool doCheck);

src/plugins/coreplugin/project/scenarios/OpenSaveProjectFileScenario.cpp

@@ -161,4 +161,15 @@ namespace Core {
         ) == SVS::SVSCraft::Yes;
     }
 
+    bool OpenSaveProjectFileScenario::confirmSaveFileIntegrity() const {
+        Q_D(const OpenSaveProjectFileScenario);
+        return SVS::MessageBox::warning(
+           RuntimeInterface::qmlEngine(),
+           d->window,
+           tr("Potential document integrity issue"),
+           tr("The document integrity check failed while saving the file. The file can still be saved, but it may not be parsed correctly when opened again.\n\nUnder normal circumstances, this problem should not occur. It may be caused by defects in %1 or some plugins.\n\nIf you are currently using Save or overwriting an existing file, it is recommended that you cancel the current operation. Instead, use Save Copy to save the document in another file, and then inspect the file using DSPX Inspector.\n\nDo you want to continue?").arg(QApplication::applicationDisplayName()),
+           SVS::SVSCraft::Yes | SVS::SVSCraft::No
+       ) == SVS::SVSCraft::Yes;
+    }
+
 }

src/plugins/coreplugin/project/scenarios/OpenSaveProjectFileScenario.h

@@ -33,6 +33,7 @@ namespace Core {
         Q_INVOKABLE bool confirmFileCreatedByAnotherApplication(const QString &name) const;
         Q_INVOKABLE bool confirmFileCreatedByIncompatibleVersion(const QString &version) const;
         Q_INVOKABLE bool confirmCustomCheckWarning(const QString &message) const;
+        Q_INVOKABLE bool confirmSaveFileIntegrity() const;
 
     Q_SIGNALS:
         void windowChanged();