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

#include "RiaLogging.h"
#include "RiaStdStringTools.h"

#include "opm/io/eclipse/ESmry.hpp"
#include "opm/io/eclipse/ExtESmry.hpp"

#ifdef USE_OPENMP
#include <omp.h>
#endif

#include <QFileInfo>

size_t RifOpmCommonEclipseSummary::sm_createdEsmryFileCount = 0;

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifOpmCommonEclipseSummary::RifOpmCommonEclipseSummary()
    : m_useEsmryFiles( false )
    , m_createEsmryFiles( false )
{
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifOpmCommonEclipseSummary::~RifOpmCommonEclipseSummary() = default;

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifOpmCommonEclipseSummary::useEnhancedSummaryFiles( bool enable )
{
    m_useEsmryFiles = enable;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifOpmCommonEclipseSummary::createEnhancedSummaryFiles( bool enable )
{
    m_createEsmryFiles = enable;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifOpmCommonEclipseSummary::resetEnhancedSummaryFileCount()
{
    sm_createdEsmryFileCount = 0;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
size_t RifOpmCommonEclipseSummary::numberOfEnhancedSummaryFileCreated()
{
    return sm_createdEsmryFileCount;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RifOpmCommonEclipseSummary::open( const QString&       headerFileName,
                                       bool                 includeRestartFiles,
                                       RiaThreadSafeLogger* threadSafeLogger )
{
    if ( m_createEsmryFiles )
    {
        auto candidateFileName = enhancedSummaryFilename( headerFileName );
        if ( !QFileInfo::exists( candidateFileName ) )
        {
            try
            {
                auto temporarySummaryFile =
                    std::make_unique<Opm::EclIO::ESmry>( headerFileName.toStdString(), includeRestartFiles );

                temporarySummaryFile->make_esmry_file();

                RifOpmCommonEclipseSummary::increaseEsmryFileCount();
            }
            catch ( std::exception& e )
            {
                QString txt = QString( "Failed to create optimized summary file. Error text : %1" ).arg( e.what() );

                if ( threadSafeLogger ) threadSafeLogger->error( txt );

                return false;
            }
        }
    }

    if ( !openFileReader( headerFileName, includeRestartFiles, threadSafeLogger ) ) return false;

    if ( !m_standardReader && !m_enhancedReader ) return false;

    buildMetaData();

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
const std::vector<time_t>& RifOpmCommonEclipseSummary::timeSteps( const RifEclipseSummaryAddress& resultAddress ) const
{
    return m_timeSteps;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RifOpmCommonEclipseSummary::values( const RifEclipseSummaryAddress& resultAddress, std::vector<double>* values ) const
{
    auto it = m_summaryAddressToKeywordMap.find( resultAddress );
    if ( it != m_summaryAddressToKeywordMap.end() )
    {
        auto keyword = it->second;
        if ( m_enhancedReader )
        {
            auto fileValues = m_enhancedReader->get( keyword );
            values->insert( values->begin(), fileValues.begin(), fileValues.end() );
        }
        else if ( m_standardReader )
        {
            auto fileValues = m_standardReader->get( keyword );
            values->insert( values->begin(), fileValues.begin(), fileValues.end() );
        }
        return true;
    }

    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::string RifOpmCommonEclipseSummary::unitName( const RifEclipseSummaryAddress& resultAddress ) const
{
    std::string nameString;
    auto        it = m_summaryAddressToKeywordMap.find( resultAddress );
    if ( it != m_summaryAddressToKeywordMap.end() )
    {
        auto keyword = it->second;
        if ( m_enhancedReader )
        {
            nameString = m_enhancedReader->get_unit( keyword );
        }
        else if ( m_standardReader )
        {
            nameString = m_standardReader->get_unit( keyword );
        }
    }

    return RiaStdStringTools::trimString( nameString );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::EclipseUnitSystem RifOpmCommonEclipseSummary::unitSystem() const
{
    // TODO: Not implemented
    return RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifOpmCommonEclipseSummary::buildMetaData()
{
    std::vector<Opm::time_point> dates;
    std::vector<std::string>     keywords;

    if ( m_enhancedReader )
    {
        dates    = m_enhancedReader->dates();
        keywords = m_enhancedReader->keywordList();
    }
    else if ( m_standardReader )
    {
        dates    = m_standardReader->dates();
        keywords = m_standardReader->keywordList();
    }

    for ( const auto& d : dates )
    {
        auto timeAsTimeT = std::chrono::system_clock::to_time_t( d );
        m_timeSteps.push_back( timeAsTimeT );
    }

    auto [addresses, addressMap] = RifOpmCommonSummaryTools::buildMetaDataKeyword( keywords );

    m_allResultAddresses         = addresses;
    m_summaryAddressToKeywordMap = addressMap;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RifOpmCommonEclipseSummary::openFileReader( const QString&       headerFileName,
                                                 bool                 includeRestartFiles,
                                                 RiaThreadSafeLogger* threadSafeLogger )
{
    if ( m_useEsmryFiles )
    {
        try
        {
            auto candidateFileName = enhancedSummaryFilename( headerFileName );
            m_enhancedReader =
                std::make_unique<Opm::EclIO::ExtESmry>( candidateFileName.toStdString(), includeRestartFiles );

            return true;
        }
        catch ( ... )
        {
            // Do not do anything here, try to open the file using standard esmy reader
        }
    }

    try
    {
        m_standardReader = std::make_unique<Opm::EclIO::ESmry>( headerFileName.toStdString(), includeRestartFiles );
    }
    catch ( std::exception& e )
    {
        QString txt = QString( "Optimized Summary Reader error : %1" ).arg( e.what() );

        if ( threadSafeLogger ) threadSafeLogger->error( txt );

        return false;
    }

    return true;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RifOpmCommonEclipseSummary::increaseEsmryFileCount()
{
    // This function can be called from a parallel loop, make it thread safe
#pragma omp critical
    sm_createdEsmryFileCount++;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RifOpmCommonEclipseSummary::enhancedSummaryFilename( const QString& headerFileName )
{
    QString s( headerFileName );
    return s.replace( ".SMSPEC", ".ESMRY" );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifEclipseSummaryAddress RifOpmCommonSummaryTools::createAddressFromSummaryNode( const Opm::EclIO::SummaryNode& summaryNode,
                                                                                 const Opm::EclIO::ESmry* summaryFile )
{
    int i = -1;
    int j = -1;
    int k = -1;

    switch ( summaryNode.category )
    {
        case Opm::EclIO::SummaryNode::Category::Aquifer:
            return RifEclipseSummaryAddress::aquiferAddress( summaryNode.keyword, summaryNode.number );
            break;
        case Opm::EclIO::SummaryNode::Category::Well:
            return RifEclipseSummaryAddress::wellAddress( summaryNode.keyword, summaryNode.wgname );
            break;
        case Opm::EclIO::SummaryNode::Category::Group:
            return RifEclipseSummaryAddress::groupAddress( summaryNode.keyword, summaryNode.wgname );
            break;
        case Opm::EclIO::SummaryNode::Category::Field:
            return RifEclipseSummaryAddress::fieldAddress( summaryNode.keyword );
            break;
        case Opm::EclIO::SummaryNode::Category::Region:
        {
            if ( summaryNode.isRegionToRegion() )
            {
                auto [r1, r2] = summaryNode.regionToRegionNumbers();
                return RifEclipseSummaryAddress::regionToRegionAddress( summaryNode.keyword, r1, r2 );
            }

            return RifEclipseSummaryAddress::regionAddress( summaryNode.keyword, summaryNode.number );
        }
        break;
        case Opm::EclIO::SummaryNode::Category::Block:
            summaryFile->ijk_from_global_index( summaryNode.number, i, j, k );
            return RifEclipseSummaryAddress::blockAddress( summaryNode.keyword, i, j, k );
            break;
        case Opm::EclIO::SummaryNode::Category::Connection:
            summaryFile->ijk_from_global_index( summaryNode.number, i, j, k );
            return RifEclipseSummaryAddress::wellCompletionAddress( summaryNode.keyword, summaryNode.wgname, i, j, k );
            break;
        case Opm::EclIO::SummaryNode::Category::Segment:
            return RifEclipseSummaryAddress::wellSegmentAddress( summaryNode.keyword, summaryNode.wgname, summaryNode.number );
            break;
        case Opm::EclIO::SummaryNode::Category::Miscellaneous:
            return RifEclipseSummaryAddress::miscAddress( summaryNode.keyword );
            break;
        default:
            break;
        case Opm::EclIO::SummaryNode::Category::Node:
            // The vector "GPR" is defined as Node
            // The behavior in libecl is to use the category Group
            // https://github.com/OPM/ResInsight/issues/7838
            return RifEclipseSummaryAddress::groupAddress( summaryNode.keyword, summaryNode.wgname );
            break;
        case Opm::EclIO::SummaryNode::Category::Network:
            return RifEclipseSummaryAddress::networkAddress( summaryNode.keyword );
            break;
        case Opm::EclIO::SummaryNode::Category::Well_Lgr:
            return RifEclipseSummaryAddress::wellLgrAddress( summaryNode.keyword, summaryNode.lgrname, summaryNode.wgname );
            break;
        case Opm::EclIO::SummaryNode::Category::Block_Lgr:
            return RifEclipseSummaryAddress::blockLgrAddress( summaryNode.keyword,
                                                              summaryNode.lgrname,
                                                              summaryNode.lgri,
                                                              summaryNode.lgrj,
                                                              summaryNode.lgrk );
            break;
        case Opm::EclIO::SummaryNode::Category::Connection_Lgr:
            return RifEclipseSummaryAddress::wellCompletionLgrAddress( summaryNode.keyword,
                                                                       summaryNode.lgrname,
                                                                       summaryNode.wgname,
                                                                       summaryNode.lgri,
                                                                       summaryNode.lgrj,
                                                                       summaryNode.lgrk );
            break;
    }

    return RifEclipseSummaryAddress();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, size_t>>
    RifOpmCommonSummaryTools::buildMetaData( const Opm::EclIO::ESmry* summaryFile )
{
    std::set<RifEclipseSummaryAddress>         addresses;
    std::map<RifEclipseSummaryAddress, size_t> addressToNodeIndexMap;

    if ( summaryFile )
    {
        auto nodes = summaryFile->summaryNodeList();
        for ( size_t i = 0; i < nodes.size(); i++ )
        {
            auto summaryNode = nodes[i];
            auto eclAdr      = createAddressFromSummaryNode( summaryNode, summaryFile );

            if ( eclAdr.isValid() )
            {
                addresses.insert( eclAdr );
                addressToNodeIndexMap[eclAdr] = i;
            }
        }
    }

    return { addresses, addressToNodeIndexMap };
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::pair<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, std::string>>
    RifOpmCommonSummaryTools::buildMetaDataKeyword( const std::vector<std::string>& keywords )
{
    std::set<RifEclipseSummaryAddress>              addresses;
    std::map<RifEclipseSummaryAddress, std::string> addressToNodeIndexMap;

    std::vector<std::string> invalidKeywords;

    for ( const auto& keyword : keywords )
    {
        auto eclAdr = RifEclipseSummaryAddress::fromEclipseTextAddress( keyword );
        if ( !eclAdr.isValid() )
        {
            invalidKeywords.push_back( keyword );

            // If a category is not found, use the MISC category
            eclAdr = RifEclipseSummaryAddress::miscAddress( keyword );
        }

        if ( eclAdr.isValid() )
        {
            addresses.insert( eclAdr );
            addressToNodeIndexMap[eclAdr] = keyword;
        }
    }

    // DEBUG code
    // Used to print keywords not being categorized correctly
    /*
        for ( const auto& kw : invalidKeywords )
        {
            RiaLogging::warning( QString::fromStdString( kw ) );
        }
    */

    return { addresses, addressToNodeIndexMap };
}