ResInsight/ApplicationLibCode/Commands/RicImportEnsembleFeature.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2016-     Statoil 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 "RicImportEnsembleFeature.h"

#include "RiaApplication.h"
#include "RiaEnsembleNameTools.h"
#include "RiaFilePathTools.h"
#include "RiaPreferences.h"
#include "RiaSummaryTools.h"
#include "RiaTextStringTools.h"

#include "RicCreateSummaryCaseCollectionFeature.h"
#include "RicImportSummaryCasesFeature.h"

#include "RifSummaryCaseRestartSelector.h"

#include "RimEnsembleCurveSet.h"
#include "RimGridSummaryCase.h"
#include "RimMainPlotCollection.h"
#include "RimOilField.h"
#include "RimProject.h"
#include "RimSummaryCase.h"
#include "RimSummaryCaseCollection.h"
#include "RimSummaryCaseMainCollection.h"
#include "RimSummaryPlot.h"

#include "RiuMainWindow.h"
#include "RiuPlotMainWindow.h"

#include "PlotBuilderCommands/RicSummaryPlotBuilder.h"
#include "SummaryPlotCommands/RicNewSummaryEnsembleCurveSetFeature.h"

#include <QAction>
#include <QDebug>
#include <QFileInfo>
#include <QInputDialog>
#include <QRegularExpression>
#include <QStringList>

#include <set>

CAF_CMD_SOURCE_INIT( RicImportEnsembleFeature, "RicImportEnsembleFeature" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RicImportEnsembleFeature::isCommandEnabled()
{
    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEnsembleFeature::onActionTriggered( bool isChecked )
{
    QString pathCacheName = "ENSEMBLE_FILES";
    auto [fileNames, ensembleGroupingMode] =
        RicImportSummaryCasesFeature::runRecursiveSummaryCaseFileSearchDialogWithGrouping( "Import Ensemble",
                                                                                           pathCacheName );

    if ( fileNames.isEmpty() ) return;

    if ( ensembleGroupingMode == RiaEnsembleNameTools::EnsembleGroupingMode::NONE )
    {
        bool useEnsembleNameDialog = true;
        importSingleEnsemble( fileNames, useEnsembleNameDialog, ensembleGroupingMode );
    }
    else
    {
        std::vector<QStringList> groupedByEnsemble =
            RiaEnsembleNameTools::groupFilesByEnsemble( fileNames, ensembleGroupingMode );
        for ( const QStringList& groupedFileNames : groupedByEnsemble )
        {
            bool useEnsembleNameDialog = false;
            importSingleEnsemble( groupedFileNames, useEnsembleNameDialog, ensembleGroupingMode );
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEnsembleFeature::importSingleEnsemble( const QStringList&                         fileNames,
                                                     bool                                       useEnsembleNameDialog,
                                                     RiaEnsembleNameTools::EnsembleGroupingMode groupingMode )
{
    QString ensembleName = RiaEnsembleNameTools::findSuitableEnsembleName( fileNames, groupingMode );

    if ( useEnsembleNameDialog ) ensembleName = askForEnsembleName( ensembleName );

    if ( ensembleName.isEmpty() ) return;

    std::vector<RimSummaryCase*> cases;
    RicImportSummaryCasesFeature::createSummaryCasesFromFiles( fileNames, &cases, true );

    if ( cases.empty() ) return;

    RimSummaryCaseCollection* ensemble =
        RicCreateSummaryCaseCollectionFeature::groupSummaryCases( cases, ensembleName, true );

    if ( ensemble )
    {
        for ( auto summaryCase : ensemble->allSummaryCases() )
        {
            summaryCase->updateAutoShortName();
        }

        RicSummaryPlotBuilder::createAndAppendDefaultSummaryMultiPlot( {}, { ensemble } );
    }

    std::vector<RimCase*> allCases;
    RiaApplication::instance()->project()->allCases( allCases );

    if ( allCases.size() == 0 )
    {
        RiuMainWindow::closeIfOpen();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RicImportEnsembleFeature::setupActionLook( QAction* actionToSetup )
{
    actionToSetup->setIcon( QIcon( ":/SummaryEnsemble.svg" ) );
    actionToSetup->setText( "Import Ensemble" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicImportEnsembleFeature::askForEnsembleName( const QString& suggestion )
{
    RimProject*                            project = RimProject::current();
    std::vector<RimSummaryCaseCollection*> groups  = project->summaryGroups();
    int                                    ensemblesStartingWithRoot =
        std::count_if( groups.begin(), groups.end(), [suggestion]( RimSummaryCaseCollection* group ) {
            return group->isEnsemble() && group->name().startsWith( suggestion );
        } );

    QInputDialog dialog;
    dialog.setInputMode( QInputDialog::TextInput );
    dialog.setWindowTitle( "Ensemble Name" );
    dialog.setLabelText( "Ensemble Name" );
    if ( ensemblesStartingWithRoot > 0 )
    {
        dialog.setTextValue( QString( "%1 %2" ).arg( suggestion ).arg( ensemblesStartingWithRoot + 1 ) );
    }
    else
    {
        dialog.setTextValue( suggestion );
    }

    dialog.resize( 300, 50 );
    dialog.exec();
    return dialog.result() == QDialog::Accepted ? dialog.textValue() : QString( "" );
}