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

#include "RiaTextStringTools.h"
#include "RiaWellNameComparer.h"
#include "RigWellPath.h"

#include "RimModeledWellPath.h"
#include "RimWellPathCompletionSettings.h"
#include "RimWellPathCompletions.h"
#include "RimWellPathValve.h"

#include "cafPdmObject.h"
#include "cafPdmUiTreeOrdering.h"

#include <QStringList>

CAF_PDM_SOURCE_INIT( RimWellPathGroup, "WellPathGroup" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellPathGroup::RimWellPathGroup()
{
    CAF_PDM_InitObject( "Well Path Group", ":/WellPathGroup.svg" );
    CAF_PDM_InitFieldNoDefault( &m_childWellPaths, "ChildWellPaths", "Child Well Paths" );
    CAF_PDM_InitFieldNoDefault( &m_groupName, "GroupName", "Group Name" );

    CAF_PDM_InitField( &m_addValveAtConnection,
                       "AddValveAtConnection",
                       false,
                       "Add Outlet Valve for Branches",
                       "",
                       "Should an outlet valve be added to branches for MSW export?",
                       "" );
    CAF_PDM_InitFieldNoDefault( &m_valve, "Valve", "Branch Outlet Valve" );
    m_valve = new RimWellPathValve;

    m_groupName.registerGetMethod( this, &RimWellPathGroup::createGroupName );
    m_groupName.uiCapability()->setUiReadOnly( true );

    setWellPathGeometry( new RigWellPath );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimWellPathGroup::name() const
{
    return m_groupName();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::addChildWellPath( RimWellPath* wellPath )
{
    if ( m_childWellPaths.empty() && isTopLevelWellPath() && wellPath->completions()->hasCompletions() )
    {
        RimWellPath::copyCompletionSettings( wellPath, this );
    }

    if ( !wellPathGeometry()->wellPathPoints().empty() )
    {
        m_childWellPaths.push_back( wellPath );
        createWellPathGeometry();

        makeMoreLevelsIfNecessary();
    }
    else
    {
        cvf::ref<RigWellPath> geometryCopy( new RigWellPath( *( wellPath->wellPathGeometry() ) ) );
        setWellPathGeometry( geometryCopy.p() );
        m_childWellPaths.push_back( wellPath );
    }

    wellPath->nameChanged.connect( this, &RimWellPathGroup::onChildNameChanged );

    updateAllRequiredEditors();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RimWellPath*> RimWellPathGroup::childWellPaths() const
{
    return m_childWellPaths.childrenByType();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
size_t RimWellPathGroup::childWellpathCount() const
{
    return m_childWellPaths.size();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWellPathGroup::hasChildWellPath( RimWellPath* wellPath )
{
    return m_childWellPaths.count( wellPath ) != 0u;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::removeChildWellPath( RimWellPath* wellPath )
{
    m_childWellPaths.removeChild( wellPath );
    RimWellPath::copyCompletionSettings( this, wellPath );

    if ( auto geometry = wellPath->wellPathGeometry(); geometry )
    {
        geometry->setUniqueStartAndEndIndex( 0u, std::numeric_limits<size_t>::max() );
    }
    createWellPathGeometry();

    if ( isTopLevelWellPath() )
    {
        completionSettings()->setWellNameForExport( m_groupName() );
    }

    updateAllRequiredEditors();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::removeAllChildWellPaths()
{
    auto childWellPaths = m_childWellPaths.childrenByType();
    for ( auto wellPath : childWellPaths )
    {
        removeChildWellPath( wellPath );
    }
    setWellPathGeometry( cvf::ref<RigWellPath>( new RigWellPath ).p() );
    updateAllRequiredEditors();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::createWellPathGeometry()
{
    for ( auto wellPath : m_childWellPaths )
    {
        if ( auto group = dynamic_cast<RimWellPathGroup*>( wellPath.p() ); group )
        {
            group->createWellPathGeometry();
        }
    }
    if ( wellPathGeometries().empty() ) return;

    auto   commonGeometry  = RigWellPath::commonGeometry( wellPathGeometries() );
    size_t childStartIndex = 0u;
    size_t commonSize      = commonGeometry->wellPathPoints().size();
    if ( commonSize > 0u ) childStartIndex = commonSize - 1u;

    setWellPathGeometry( commonGeometry.p() );
    wellPathGeometry()->setUniqueStartAndEndIndex( wellPathGeometry()->uniqueStartIndex(), childStartIndex );

    for ( auto wellPath : m_childWellPaths )
    {
        if ( auto lateral = dynamic_cast<RimModeledWellPath*>( wellPath.p() ); lateral )
        {
            lateral->createWellPathGeometry();
        }
        wellPath->wellPathGeometry()->setUniqueStartAndEndIndex( childStartIndex, std::numeric_limits<size_t>::max() );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName )
{
    RimWellPath::defineUiTreeOrdering( uiTreeOrdering, uiConfigName );

    for ( auto child : m_childWellPaths() )
    {
        if ( child )
        {
            uiTreeOrdering.add( child );
        }
    }

    uiTreeOrdering.skipRemainingChildren( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimWellPathGroup::userDescriptionField()
{
    return &m_groupName;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::initAfterRead()
{
    if ( isTopLevelWellPath() )
    {
        completionSettings()->setWellNameForExport( createGroupName() );
    }

    for ( auto wellPath : m_childWellPaths )
    {
        wellPath->nameChanged.connect( this, &RimWellPathGroup::onChildNameChanged );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
{
    uiOrdering.add( &m_groupName );
    if ( !isTopLevelWellPath() )
    {
        auto valveGroup = uiOrdering.addNewGroup( "Valve Settings" );
        valveGroup->add( &m_addValveAtConnection );
        if ( m_addValveAtConnection )
        {
            m_valve->uiOrdering( "TemplateOnly", *valveGroup );
        }
    }
    uiOrdering.skipRemainingFields( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<const RigWellPath*> RimWellPathGroup::wellPathGeometries() const
{
    std::vector<const RigWellPath*> allGeometries;
    for ( const auto& child : m_childWellPaths() )
    {
        if ( child->wellPathGeometry() )
        {
            allGeometries.push_back( child->wellPathGeometry() );
        }
    }
    return allGeometries;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimWellPathGroup::createGroupName() const
{
    QStringList               allNames;
    std::vector<RimWellPath*> descendantWellPaths = descendantsOfType<RimWellPath>();
    for ( auto wellPath : descendantWellPaths )
    {
        if ( wellPath )
        {
            bool groupOrLateral = dynamic_cast<RimWellPathGroup*>( wellPath ) || dynamic_cast<RimModeledWellPath*>( wellPath );
            if ( !groupOrLateral )
            {
                allNames.push_back( wellPath->name() );
            }
        }
    }

    // if no imported well path is present, use all modeled well paths
    if ( allNames.empty() )
    {
        std::vector<RimModeledWellPath*> descendantWellPaths = descendantsOfType<RimModeledWellPath>();
        for ( auto wellPath : descendantWellPaths )
        {
            if ( wellPath )
            {
                allNames.push_back( wellPath->name() );
            }
        }
    }

    QString commonRoot        = RiaTextStringTools::commonRoot( allNames );
    QString trimmedCommonRoot = RiaTextStringTools::trimNonAlphaNumericCharacters( commonRoot );

    for ( auto& name : allNames )
    {
        name.remove( commonRoot );
    }

    QString commonSuffix        = RiaTextStringTools::commonSuffix( allNames );
    QString trimmedCommonSuffix = RiaTextStringTools::trimNonAlphaNumericCharacters( commonSuffix );

    QStringList branchNames;
    for ( auto& name : allNames )
    {
        name.remove( commonSuffix );
        name = RiaTextStringTools::trimNonAlphaNumericCharacters( name );
        name = name.simplified();
        if ( !name.isEmpty() )
        {
            branchNames.push_back( name );
        }
    }
    QString fullName = trimmedCommonRoot;
    if ( !branchNames.isEmpty() )
    {
        fullName += QString( "%1" ).arg( branchNames.join( "" ) );
    }
    fullName += trimmedCommonSuffix;

    QString nameWithoutSpaces = RiaWellNameComparer::removeSpacesFromName( fullName );
    if ( nameWithoutSpaces.length() > 8 ) fullName = trimmedCommonRoot + trimmedCommonSuffix;

    if ( fullName.isEmpty() ) fullName = "Well 1";

    return fullName;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
const RimWellPathValve* RimWellPathGroup::outletValve() const
{
    return m_addValveAtConnection() && m_valve() && m_valve->valveTemplate() ? m_valve() : nullptr;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::onChildNameChanged( const caf::SignalEmitter* emitter )
{
    updateConnectedEditors();

    if ( isTopLevelWellPath() )
    {
        completionSettings()->setWellNameForExport( createGroupName() );
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellPathGroup::makeMoreLevelsIfNecessary()
{
    if ( m_childWellPaths.size() <= 1u ) return;

    auto wellPathPoints = wellPathGeometry()->wellPathPoints();

    auto comp = []( const cvf::Vec3d& lhs, const cvf::Vec3d& rhs )
    {
        auto diff = rhs - lhs;
        if ( diff.length() < 1.0e-8 ) return false;

        if ( diff.z() == 0.0 )
        {
            if ( diff.y() == 0.0 )
            {
                return diff.x() > 0.0;
            }
            return diff.y() > 0.0;
        }
        return diff.z() > 0.0;
    };

    auto branches = std::map<cvf::Vec3d, std::vector<RimWellPath*>, decltype( comp )>( comp );

    for ( auto wellPath : m_childWellPaths )
    {
        auto childWellPathPoints = wellPath->wellPathGeometry()->wellPathPoints();
        if ( childWellPathPoints.size() > wellPathPoints.size() )
        {
            cvf::Vec3d firstDeviation = childWellPathPoints[wellPathPoints.size()];
            branches[firstDeviation].push_back( wellPath );
        }
    }

    if ( branches.size() <= 1u ) return;

    bool anyNonTrivialBranches = false;
    for ( const auto& firstDeviationAndWellPaths : branches )
    {
        const auto& wellPaths = firstDeviationAndWellPaths.second;
        if ( wellPaths.size() > 1u )
        {
            anyNonTrivialBranches = true;
            break;
        }
    }
    if ( anyNonTrivialBranches )
    {
        size_t childStartIndex = 0u;
        size_t commonSize      = wellPathGeometry()->wellPathPoints().size();
        if ( commonSize > 0u ) childStartIndex = commonSize - 1u;

        for ( const auto& firstDeviationAndWellPaths : branches )
        {
            const auto& wellPaths = firstDeviationAndWellPaths.second;
            if ( wellPaths.size() > 1u )
            {
                RimWellPathGroup* newGroup = new RimWellPathGroup;
                for ( auto wellPath : wellPaths )
                {
                    m_childWellPaths().removeChild( wellPath );
                    newGroup->addChildWellPath( wellPath );
                    newGroup->wellPathGeometry()->setUniqueStartAndEndIndex( childStartIndex, std::numeric_limits<size_t>::max() );
                }
                m_childWellPaths().push_back( newGroup );
            }
        }
    }
}