Files
ResInsight/ApplicationLibCode/Commands/ApplicationCommands/RicRestoreProjectVersionsUi.cpp
T
Magne Sjaastad 56ff80c8e2 #13360: Integrate project version restore tool into GUI
Add a GUI feature for restoring previous versions of a project file from
its backup database, replacing the need for the external standalone tool.

- RiaProjectBackupTools: add extractVersionsToFolder() to read all stored
  revisions from a project's .rspdb backup database and write each one to
  a timestamped .rsp file in a destination folder.
- RicRestoreProjectVersionsUi: dialog for selecting the project file and
  export folder, defaulting to the currently open project. Adds a Recent
  Project Files dropdown (backed by RiuRecentFileActionProvider) that
  quickly populates the project file and export folder fields.
- RicRestoreProjectVersionsFeature: new command feature wired into the
  File menu as 'Restore Previous Project Versions...', using the
  OpenFolder icon and placed after a separator below Save Project / Save
  Project As.
- RiuRecentFileActionProvider: add recentProjectFiles() to expose the
  list of recently used project files.
- Added '...' suffix to Save Project As, consistent with other
  dialog-launching actions.
2026-10-21 22:23:38 +02:00

141 lines
6.3 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2026- Equinor ASA
//
// ResInsight is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
// for more details.
//
/////////////////////////////////////////////////////////////////////////////////
#include "RicRestoreProjectVersionsUi.h"
#include "RiuRecentFileActionProvider.h"
#include "cafPdmUiComboBoxEditor.h"
#include "cafPdmUiFilePathEditor.h"
#include "cafPdmUiOrdering.h"
#include <QFileInfo>
CAF_PDM_SOURCE_INIT( RicRestoreProjectVersionsUi, "RicRestoreProjectVersionsUi" );
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RicRestoreProjectVersionsUi::RicRestoreProjectVersionsUi()
{
CAF_PDM_InitObject( "Restore Project Versions" );
CAF_PDM_InitFieldNoDefault( &m_recentProjectFiles, "RecentProjectFiles", "Recent Project Files" );
m_recentProjectFiles.uiCapability()->setUiEditorTypeName( caf::PdmUiComboBoxEditor::uiEditorTypeName() );
CAF_PDM_InitFieldNoDefault( &m_projectFile, "ProjectFile", "Project File" );
m_projectFile.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
m_projectFile.uiCapability()->setAttribute( caf::PdmUiFilePathEditor::Keys::FILE_SELECTION_FILTER,
QString( "ResInsight project (*.rsp *.rip);;All files (*.*)" ) );
CAF_PDM_InitFieldNoDefault( &m_exportFolder, "ExportFolder", "Export Folder" );
m_exportFolder.uiCapability()->setUiEditorTypeName( caf::PdmUiFilePathEditor::uiEditorTypeName() );
m_exportFolder.uiCapability()->setAttribute( caf::PdmUiFilePathEditor::Keys::SELECT_DIRECTORY, true );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicRestoreProjectVersionsUi::projectFile() const
{
return m_projectFile().path();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicRestoreProjectVersionsUi::exportFolder() const
{
return m_exportFolder().path();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicRestoreProjectVersionsUi::setProjectFile( const QString& filePath )
{
m_projectFile = caf::FilePath( filePath );
// Keep the recent files combo box in sync so it reflects the currently selected project file
// instead of appearing empty when a default/current project file is set programmatically.
QStringList recentFiles = RiuRecentFileActionProvider::recentProjectFiles();
m_recentProjectFiles = recentFiles.contains( filePath ) ? filePath : QString();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicRestoreProjectVersionsUi::setExportFolder( const QString& folderPath )
{
m_exportFolder = caf::FilePath( folderPath );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QList<caf::PdmOptionItemInfo> RicRestoreProjectVersionsUi::calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions )
{
QList<caf::PdmOptionItemInfo> options;
if ( fieldNeedingOptions == &m_recentProjectFiles )
{
for ( const QString& recentFile : RiuRecentFileActionProvider::recentProjectFiles() )
{
QString uiText = QFileInfo( recentFile ).fileName() + " (" + recentFile + ")";
options.push_back( caf::PdmOptionItemInfo( uiText, recentFile ) );
}
}
return options;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicRestoreProjectVersionsUi::fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue )
{
if ( changedField == &m_recentProjectFiles )
{
QString selectedFile = m_recentProjectFiles();
if ( !selectedFile.isEmpty() )
{
setProjectFile( selectedFile );
setExportFolder( QFileInfo( selectedFile ).absolutePath() );
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicRestoreProjectVersionsUi::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
bool hasRecentFiles = !RiuRecentFileActionProvider::recentProjectFiles().isEmpty();
m_recentProjectFiles.uiCapability()->setUiHidden( !hasRecentFiles );
auto infoGroup = uiOrdering.addNewGroup( "Information" );
infoGroup->addNewLabel( "Restores previous revisions of a ResInsight project from its backup history. Select the "
"project file to restore from and an export folder, and each stored revision will be "
"written as a separate project file." );
auto selectionGroup = uiOrdering.addNewGroup( "Project Selection" );
selectionGroup->add( &m_recentProjectFiles );
selectionGroup->add( &m_projectFile );
selectionGroup->add( &m_exportFolder );
}