ResInsight/ApplicationLibCode/Commands/CompletionExportCommands/RicWellPathExportCompletionsFileTools.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2018 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 "RicWellPathExportCompletionsFileTools.h"

#include "RiaFilePathTools.h"
#include "RiaLogging.h"
#include "RiaPreferences.h"
#include "RiaRegressionTestRunner.h"

#include "RimProject.h"
#include "RimWellPath.h"
#include "RimWellPathCompletions.h"

#include "cafUtils.h"

#include <QDateTime>
#include <QDir>
#include <QTextStream>

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::shared_ptr<QFile> RicWellPathExportCompletionsFileTools::openFile( const QString& folderName, const QString& fileName, const QString& suffix )
{
    QString validFileName = caf::Utils::makeValidFileBasename( fileName );

    QDir exportFolder = QDir( folderName );
    if ( !exportFolder.exists() )
    {
        bool createdPath = exportFolder.mkpath( "." );
        if ( createdPath )
            RiaLogging::info( "Created export folder " + folderName );
        else
        {
            auto errorMessage = QString( "Selected output folder does not exist, and could not be created." );
            RiaLogging::error( errorMessage );
            return nullptr;
        }
    }

    QString filePath = exportFolder.filePath( validFileName );
    if ( !suffix.isEmpty() ) filePath += "." + suffix;
    std::shared_ptr<QFile> exportFile( new QFile( filePath ) );
    if ( !exportFile->open( QIODevice::WriteOnly | QIODevice::Text ) )
    {
        auto errorMessage = QString( "Export Completions Data: Could not open the file: %1" ).arg( filePath );
        RiaLogging::error( errorMessage );
        return nullptr;
    }
    return exportFile;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
const RimWellPath* RicWellPathExportCompletionsFileTools::findWellPathFromExportName( const QString& wellNameForExport )
{
    auto allWellPaths = RimProject::current()->allWellPaths();

    for ( const auto wellPath : allWellPaths )
    {
        if ( wellPath->completionSettings()->wellNameForExport() == wellNameForExport ) return wellPath;
    }
    return nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::shared_ptr<QFile> RicWellPathExportCompletionsFileTools::openFileForExport( const QString& folderName,
                                                                                 const QString& fileName,
                                                                                 const QString& suffix,
                                                                                 bool           writeInfoHeader )
{
    auto file = openFile( folderName, fileName, suffix );

    // Do not write header when running regression tests to make sure the text content is stable
    if ( file && writeInfoHeader && !RiaRegressionTestRunner::instance()->isRunningRegressionTests() )
    {
        QString header = createProjectFileHeader();
        if ( !header.isEmpty() )
        {
            QTextStream stream( file.get() );

            stream << header;
        }
    }

    return file;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RicWellPathExportCompletionsFileTools::createProjectFileHeader()
{
    QString txt = QString( "-- Exported from ResInsight " );

    auto dateTimeFormatString = RiaPreferences::current()->dateTimeFormat();
    if ( !dateTimeFormatString.isEmpty() )
    {
        auto currentDateTime = QDateTime::currentDateTime();
        auto dateStampString = currentDateTime.toString( dateTimeFormatString );
        txt += dateStampString;
    }

    txt += "\n";

    auto proj = RimProject::current();
    if ( proj && !proj->fileName().isEmpty() )
    {
        QString fileName = proj->fileName();
        if ( !fileName.isEmpty() )
        {
            txt += "-- " + fileName + "\n";
        }

        txt += "\n";
    }

    return txt;
}