ResInsight/ApplicationLibCode/Commands/EclipseCommands/RicImportEclipseCaseFeature.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2015-     Statoil ASA
//  Copyright (C) 2015-     Ceetron Solutions AS
//
//  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 "RicImportEclipseCaseFeature.h"

#include "RiaApplication.h"
#include "RiaPreferencesGrid.h"

#include "RifReaderSettings.h"

#include "RimEclipseCase.h"
#include "RimEclipseCaseCollection.h"
#include "RimEclipseView.h"
#include "RimProject.h"
#include "RimSurface.h"
#include "RimSurfaceCollection.h"
#include "RimSurfaceInView.h"
#include "RimSurfaceInViewCollection.h"
#include "RimTools.h"

#include "Riu3DMainWindowTools.h"
#include "RiuFileDialogTools.h"

#include <QAction>
#include <QDir>
#include <QFileInfo>
#include <QSet>

CAF_CMD_SOURCE_INIT( RicImportEclipseCaseFeature, "RicImportEclipseCaseFeature" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEclipseCaseFeature::onActionTriggered( bool isChecked )
{
    RiaApplication* app = RiaApplication::instance();

    QString     defaultDir = app->lastUsedDialogDirectory( "BINARY_GRID" );
    QStringList fileNames  = RiuFileDialogTools::getOpenFileNames( Riu3DMainWindowTools::mainWindowWidget(),
                                                                  "Import Eclipse File",
                                                                  defaultDir,
                                                                  "Eclipse Grid Files (*.GRID *.EGRID)" );

    if ( fileNames.isEmpty() ) return;

    defaultDir = QFileInfo( fileNames.last() ).absolutePath();
    app->setLastUsedDialogDirectory( "BINARY_GRID", defaultDir );

    bool              createDefaultView = true;
    std::vector<int>  caseIds;
    RifReaderSettings readerSettings = RiaPreferencesGrid::current()->readerSettings();

    // Track existing views before import
    RimProject*                  project        = RimProject::current();
    std::vector<RimEclipseView*> allViewsBefore = allEclipseViews( project );

    openEclipseCaseFromFileNames( fileNames, createDefaultView, caseIds, readerSettings );

    for ( const auto& f : fileNames )
    {
        RiaApplication::instance()->addToRecentFiles( f );
    }

    // Auto-import matching PVD surface files
    importPvdSurfacesForGridFiles( fileNames, allViewsBefore );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEclipseCaseFeature::importPvdSurfacesForGridFiles( const QStringList&                  gridFileNames,
                                                                 const std::vector<RimEclipseView*>& viewsBeforeImport )
{
    if ( RimSurfaceCollection* surfColl = RimTools::surfaceCollection() )
    {
        QStringList pvdFilesToImport = findPvdFilesToImport( gridFileNames );

        if ( !pvdFilesToImport.isEmpty() )
        {
            // Get count of existing surfaces before import
            auto allSurfacesBefore = surfColl->descendantsIncludingThisOfType<RimSurface>();

            // Failed files are logged by importSurfacesFromFiles
            if ( !surfColl->importSurfacesFromFiles( pvdFilesToImport ) ) return;

            // Get newly imported surfaces
            auto                     allSurfacesAfter = surfColl->descendantsIncludingThisOfType<RimSurface>();
            std::vector<RimSurface*> newlyImportedSurfaces;
            for ( auto* surf : allSurfacesAfter )
            {
                if ( std::find( allSurfacesBefore.begin(), allSurfacesBefore.end(), surf ) == allSurfacesBefore.end() )
                {
                    newlyImportedSurfaces.push_back( surf );
                }
            }

            // Enable newly imported surfaces in new views, disable them in old views
            RimProject* project = RimProject::current();
            if ( project && !newlyImportedSurfaces.empty() )
            {
                // Process all views (both old and new)
                for ( auto* eclipseCase : project->eclipseCases() )
                {
                    for ( RimEclipseView* view : eclipseCase->reservoirViews() )
                    {
                        if ( RimSurfaceInViewCollection* surfInViewColl = view->surfaceInViewCollection() )
                        {
                            // Check if this is a new view or an existing view
                            bool isNewView = std::find( viewsBeforeImport.begin(), viewsBeforeImport.end(), view ) == viewsBeforeImport.end();

                            // Get all surface-in-view objects
                            auto allSurfacesInView = surfInViewColl->descendantsIncludingThisOfType<RimSurfaceInView>();

                            for ( RimSurfaceInView* surfInView : allSurfacesInView )
                            {
                                if ( RimSurface* surf = surfInView->surface() )
                                {
                                    bool isNewlyImported = std::find( newlyImportedSurfaces.begin(), newlyImportedSurfaces.end(), surf ) !=
                                                           newlyImportedSurfaces.end();

                                    if ( isNewlyImported )
                                    {
                                        // Enable newly imported surfaces only in new views
                                        // Disable them in old views
                                        surfInView->setActive( isNewView );
                                    }
                                    else if ( isNewView )
                                    {
                                        // Disable old surfaces in new views
                                        surfInView->setActive( false );
                                    }
                                    // Leave old surfaces in old views unchanged
                                }
                            }

                            surfInViewColl->updateConnectedEditors();
                        }
                    }
                }
            }
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RimEclipseView*> RicImportEclipseCaseFeature::allEclipseViews( RimProject* project )
{
    std::vector<RimEclipseView*> allViewsBefore;
    if ( project )
    {
        auto allCases = project->eclipseCases();
        for ( auto* eclipseCase : allCases )
        {
            auto views = eclipseCase->reservoirViews();
            allViewsBefore.insert( allViewsBefore.end(), views.begin(), views.end() );
        }
    }
    return allViewsBefore;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QStringList RicImportEclipseCaseFeature::findPvdFilesToImport( const QStringList& fileNames )
{
    QStringList   pvdFilesToImport;
    QSet<QString> seenPvdFiles;

    // Eclipse companion files used to discover base names that should be excluded from PVD import.
    const QStringList eclipseSuffixes = { ".DATA", ".EGRID", ".SMSPEC", ".UNSMRY", ".RSSPEC", ".UNRST" };

    for ( const auto& gridFile : fileNames )
    {
        QFileInfo gridFileInfo( gridFile );
        QString   baseName = gridFileInfo.completeBaseName(); // e.g., "CASE" from "CASE.EGRID"
        QString   dirPath  = gridFileInfo.absolutePath();
        QDir      dir( dirPath );

        // Collect other Eclipse cases starting with baseName present in the same folder.
        // Any PVD file matching one of those bases will be filtered out.
        QSet<QString> otherBases;
        const auto    filesInDir = dir.entryInfoList( QDir::Files );
        for ( const auto& fileInfo : filesInDir )
        {
            const QString fileName = fileInfo.fileName();
            for ( const auto& suffix : eclipseSuffixes )
            {
                if ( fileName.endsWith( suffix, Qt::CaseInsensitive ) )
                {
                    const QString otherBase = fileInfo.completeBaseName();
                    if ( otherBase.startsWith( baseName, Qt::CaseInsensitive ) && otherBase.compare( baseName, Qt::CaseInsensitive ) != 0 )
                    {
                        otherBases.insert( otherBase );
                    }
                    break;
                }
            }
        }

        // Include all PVD files matching "<baseName>*.pvd", but exclude the generic "<baseName>.pvd" file.
        QStringList   matchingPvdFiles = dir.entryList( QStringList() << baseName + "*.pvd", QDir::Files );
        const QString basePvdName      = baseName + ".pvd";

        for ( const QString& pvdFile : matchingPvdFiles )
        {
            if ( pvdFile.compare( basePvdName, Qt::CaseInsensitive ) == 0 ) continue;

            // Remove PVD files that actually belong to a different Eclipse base in this directory.
            bool matchesOtherBase = false;
            for ( const auto& otherBase : otherBases )
            {
                if ( pvdFile.startsWith( otherBase, Qt::CaseInsensitive ) )
                {
                    matchesOtherBase = true;
                    break;
                }
            }

            if ( matchesOtherBase ) continue;

            QString fullPath = dir.absoluteFilePath( pvdFile );
            if ( !seenPvdFiles.contains( fullPath ) )
            {
                seenPvdFiles.insert( fullPath );
                pvdFilesToImport << fullPath;
            }
        }
    }
    return pvdFilesToImport;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEclipseCaseFeature::setupActionLook( QAction* actionToSetup )
{
    actionToSetup->setIcon( QIcon( ":/Case.svg" ) );
    actionToSetup->setText( "Import Simulation Grid" );
}