/////////////////////////////////////////////////////////////////////////////////
//
//  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 "RimSummaryCurveAutoName.h"

#include "RifEclipseSummaryAddress.h"

#include "RimEnsembleCurveSet.h"
#include "RimProject.h"
#include "RimSummaryCalculation.h"
#include "RimSummaryCalculationCollection.h"
#include "RimSummaryCase.h"
#include "RimSummaryCaseCollection.h"
#include "RimSummaryCurve.h"
#include "RimSummaryNameHelper.h"

#include "SummaryPlotCommands/RicSummaryPlotEditorUi.h"

#include "RiuSummaryQuantityNameInfoProvider.h"

#include "cafPdmUiPushButtonEditor.h"

CAF_PDM_SOURCE_INIT( RimSummaryCurveAutoName, "SummaryCurveAutoName" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimSummaryCurveAutoName::RimSummaryCurveAutoName()
{
    CAF_PDM_InitObject( "RimSummaryCurveAutoName" );

    CAF_PDM_InitField( &m_longVectorName, "LongVectorName", true, "Long Vector Name" );
    CAF_PDM_InitField( &m_vectorName, "VectorName", false, "Vector Name" );
    CAF_PDM_InitField( &m_unit, "Unit", false, "Unit" );
    CAF_PDM_InitField( &m_regionNumber, "RegionNumber", true, "Region Number" );
    CAF_PDM_InitField( &m_groupName, "WellGroupName", true, "Group Name" );
    CAF_PDM_InitField( &m_wellName, "WellName", true, "Well Name" );
    CAF_PDM_InitField( &m_wellSegmentNumber, "WellSegmentNumber", true, "Well Segment Number" );
    CAF_PDM_InitField( &m_lgrName, "LgrName", true, "Lgr Name" );
    CAF_PDM_InitField( &m_completion, "Completion", true, "I, J, K" );
    CAF_PDM_InitField( &m_aquiferNumber, "Aquifer", true, "Aquifer Number" );

    CAF_PDM_InitField( &m_caseName, "CaseName", true, "Case/Ensemble Name" );

    if ( RimProject::current() && RimProject::current()->isProjectFileVersionEqualOrOlderThan( "2023.1.0" ) )
    {
        // Make sure that behavior in older projects behave as before
        m_longVectorName = false;
        m_vectorName     = true;
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimSummaryCurveAutoName::curveNameY( const RifEclipseSummaryAddress& summaryAddress,
                                             const RimSummaryNameHelper*     currentNameHelper,
                                             const RimSummaryNameHelper*     plotNameHelper ) const
{
    auto summaryCurve = firstAncestorOrThisOfType<RimSummaryCurve>();

    std::string unitNameY;
    if ( summaryCurve )
    {
        unitNameY = summaryCurve->unitNameY();
    }

    std::string caseNameY;
    if ( caseNameY.empty() && summaryCurve && summaryCurve->summaryCaseY() )
    {
        caseNameY = summaryCurve->summaryCaseY()->displayCaseName().toStdString();
    }

    {
        auto ensembleCurveSet = firstAncestorOrThisOfType<RimEnsembleCurveSet>();
        if ( ensembleCurveSet && ensembleCurveSet->summaryCaseCollection() )
        {
            caseNameY = ensembleCurveSet->summaryCaseCollection()->name().toStdString();
        }
    }

    QString curveName = buildCurveName( summaryAddress, currentNameHelper, plotNameHelper, unitNameY, caseNameY );

    return curveName;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimSummaryCurveAutoName::curveNameX( const RifEclipseSummaryAddress& summaryAddress,
                                             const RimSummaryNameHelper*     currentNameHelper,
                                             const RimSummaryNameHelper*     plotNameHelper ) const
{
    auto summaryCurve = firstAncestorOrThisOfType<RimSummaryCurve>();

    std::string unitNameX;
    if ( summaryCurve )
    {
        unitNameX = summaryCurve->unitNameX();
    }

    std::string caseNameX;
    if ( caseNameX.empty() && summaryCurve && summaryCurve->summaryCaseX() )
    {
        caseNameX = summaryCurve->summaryCaseX()->displayCaseName().toStdString();
    }

    {
        auto ensembleCurveSet = firstAncestorOrThisOfType<RimEnsembleCurveSet>();
        if ( ensembleCurveSet && ensembleCurveSet->summaryCaseCollection() )
        {
            caseNameX = ensembleCurveSet->summaryCaseCollection()->name().toStdString();
        }
    }

    QString curveName = buildCurveName( summaryAddress, currentNameHelper, plotNameHelper, unitNameX, caseNameX );

    return curveName;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::applySettings( const RimSummaryCurveAutoName& other )
{
    m_caseName          = other.m_caseName;
    m_vectorName        = other.m_vectorName;
    m_longVectorName    = other.m_longVectorName;
    m_unit              = other.m_unit;
    m_regionNumber      = other.m_regionNumber;
    m_groupName         = other.m_groupName;
    m_wellName          = other.m_wellName;
    m_wellSegmentNumber = other.m_wellSegmentNumber;
    m_lgrName           = other.m_lgrName;
    m_completion        = other.m_completion;
    m_aquiferNumber     = other.m_aquiferNumber;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::appendWellName( std::string&                    text,
                                              const RifEclipseSummaryAddress& summaryAddress,
                                              const RimSummaryNameHelper*     nameHelper ) const
{
    bool skipSubString = nameHelper && nameHelper->isWellNameInTitle();
    if ( skipSubString ) return;

    if ( m_wellName )
    {
        if ( !text.empty() ) text += ":";
        text += summaryAddress.wellName();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::appendLgrName( std::string& text, const RifEclipseSummaryAddress& summaryAddress ) const
{
    if ( m_lgrName )
    {
        if ( !text.empty() ) text += ":";
        text += ":" + summaryAddress.lgrName();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimSummaryCurveAutoName::buildCurveName( const RifEclipseSummaryAddress& summaryAddress,
                                                 const RimSummaryNameHelper*     currentNameHelper,
                                                 const RimSummaryNameHelper*     plotNameHelper,
                                                 const std::string&              unitText,
                                                 const std::string&              caseName ) const
{
    std::string text; // Using std::string locally to avoid a lot of conversion when building the curve name

    if ( m_vectorName || m_longVectorName )
    {
        bool skipSubString = currentNameHelper && currentNameHelper->vectorNames().size() == 1;
        if ( !skipSubString )
        {
            if ( m_longVectorName() )
            {
                auto quantityName = summaryAddress.vectorName();
                if ( summaryAddress.isHistoryVector() ) quantityName = quantityName.substr( 0, quantityName.size() - 1 );

                text = RiuSummaryQuantityNameInfoProvider::instance()->longNameFromVectorName( quantityName );

                if ( m_vectorName ) text += " (" + summaryAddress.vectorName() + ")";

                // Handle cases where longNameFromVectorName fails to produce a long name.
                // This can happen for non-standard vector names.
                if ( text.empty() && !summaryAddress.vectorName().empty() ) text = summaryAddress.vectorName();
            }
            else
            {
                text = summaryAddress.vectorName();
            }
        }

        if ( summaryAddress.category() == RifEclipseSummaryAddress::SUMMARY_ENSEMBLE_STATISTICS )
        {
            text = summaryAddress.vectorName();
        }
        else if ( summaryAddress.isCalculated() )
        {
            // Need to add case name for calculated summary
            RimProject*                      proj     = RimProject::current();
            RimSummaryCalculationCollection* calcColl = proj->calculationCollection();

            RimUserDefinedCalculation* calculation = calcColl->findCalculationById( summaryAddress.id() );
            if ( calculation )
            {
                text = calculation->shortName().toStdString();
            }
        }

        if ( m_unit && !unitText.empty() )
        {
            text += "[" + unitText + "]";
        }
    }

    appendAddressDetails( text, summaryAddress, plotNameHelper );

    if ( !caseName.empty() && !summaryAddress.isCalculated() )
    {
        bool skipSubString = plotNameHelper && plotNameHelper->isCaseInTitle();

        if ( m_caseName && !skipSubString )
        {
            if ( !text.empty() ) text += ", ";
            text += caseName;
        }
    }

    if ( text.empty() ) text = summaryAddress.vectorName();

    return QString::fromStdString( text );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::appendAddressDetails( std::string&                    text,
                                                    const RifEclipseSummaryAddress& summaryAddress,
                                                    const RimSummaryNameHelper*     nameHelper ) const
{
    switch ( summaryAddress.category() )
    {
        case RifEclipseSummaryAddress::SUMMARY_AQUIFER:
        {
            if ( m_aquiferNumber )
            {
                if ( !text.empty() ) text += ":";
                text += std::to_string( summaryAddress.aquiferNumber() );
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_REGION:
        {
            if ( m_regionNumber )
            {
                bool skipSubString = nameHelper && nameHelper->isRegionInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.regionNumber() );
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_REGION_2_REGION:
        {
            if ( m_regionNumber )
            {
                if ( !text.empty() ) text += ":";
                text += std::to_string( summaryAddress.regionNumber() );
                text += "-" + std::to_string( summaryAddress.regionNumber2() );
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_GROUP:
        {
            if ( m_groupName )
            {
                bool skipSubString = nameHelper && nameHelper->isGroupNameInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += summaryAddress.groupName();
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_WELL:
        {
            appendWellName( text, summaryAddress, nameHelper );
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_WELL_COMPLETION:
        {
            appendWellName( text, summaryAddress, nameHelper );

            if ( m_completion )
            {
                bool skipSubString = nameHelper && nameHelper->isCompletionInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.cellI() ) + ", " + std::to_string( summaryAddress.cellJ() ) + ", " +
                            std::to_string( summaryAddress.cellK() );
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_WELL_LGR:
        {
            appendLgrName( text, summaryAddress );
            appendWellName( text, summaryAddress, nameHelper );
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_WELL_COMPLETION_LGR:
        {
            appendLgrName( text, summaryAddress );
            appendWellName( text, summaryAddress, nameHelper );

            if ( m_completion )
            {
                bool skipSubString = nameHelper && nameHelper->isCompletionInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.cellI() ) + ", " + std::to_string( summaryAddress.cellJ() ) + ", " +
                            std::to_string( summaryAddress.cellK() );
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_WELL_SEGMENT:
        {
            appendWellName( text, summaryAddress, nameHelper );

            if ( m_wellSegmentNumber )
            {
                bool skipSubString = nameHelper && nameHelper->isSegmentInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.wellSegmentNumber() );
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_BLOCK:
        {
            if ( m_completion )
            {
                bool skipSubString = nameHelper && nameHelper->isBlockInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.cellI() ) + ", " + std::to_string( summaryAddress.cellJ() ) + ", " +
                            std::to_string( summaryAddress.cellK() );
                }
            }
        }
        break;
        case RifEclipseSummaryAddress::SUMMARY_BLOCK_LGR:
        {
            appendLgrName( text, summaryAddress );

            if ( m_completion )
            {
                bool skipSubString = nameHelper && nameHelper->isBlockInTitle();
                if ( !skipSubString )
                {
                    if ( !text.empty() ) text += ":";
                    text += std::to_string( summaryAddress.cellI() ) + ", " + std::to_string( summaryAddress.cellJ() ) + ", " +
                            std::to_string( summaryAddress.cellK() );
                }
            }
        }
        break;
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue )
{
    // NOTE: The curve filter is parent object of a summary curve, and the update is supposed to update
    // the first parent, not the grandparent. This is the reason for not using firstAncestorOrThisOfType()

    RimSummaryCurve* summaryCurve = dynamic_cast<RimSummaryCurve*>( this->parentField()->ownerObject() );
    if ( summaryCurve )
    {
        summaryCurve->updateCurveNameAndUpdatePlotLegendAndTitle();
        summaryCurve->updateConnectedEditors();

        return;
    }

    RicSummaryPlotEditorUi* curveCreator = dynamic_cast<RicSummaryPlotEditorUi*>( this->parentField()->ownerObject() );
    if ( curveCreator )
    {
        curveCreator->updateCurveNames();
        curveCreator->updateConnectedEditors();

        return;
    }

    {
        auto ensembleCurveSet = dynamic_cast<RimEnsembleCurveSet*>( this->parentField()->ownerObject() );
        if ( ensembleCurveSet )
        {
            ensembleCurveSet->updateAllTextInPlot();
            ensembleCurveSet->updateConnectedEditors();

            return;
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimSummaryCurveAutoName::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
    uiOrdering.add( &m_caseName );
    uiOrdering.add( &m_vectorName );
    uiOrdering.add( &m_longVectorName );
    uiOrdering.add( &m_groupName );
    uiOrdering.add( &m_wellName );

    caf::PdmUiGroup& advanced = *( uiOrdering.addNewGroup( "Advanced" ) );
    advanced.setCollapsedByDefault();
    advanced.add( &m_regionNumber );
    advanced.add( &m_lgrName );
    advanced.add( &m_completion );
    advanced.add( &m_wellSegmentNumber );
    advanced.add( &m_aquiferNumber );
    advanced.add( &m_unit );

    uiOrdering.skipRemainingFields();
}