/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#include <sfx2/linkmgr.hxx>

#include <areasave.hxx>

#include <arealink.hxx>

#include <document.hxx>

#include <documentlinkmgr.hxx>

#include <docsh.hxx>

ScAreaLinkSaver::ScAreaLinkSaver( const ScAreaLink& rSource ) :

    aFileName   ( rSource.GetFile() ),

    aFilterName ( rSource.GetFilter() ),

    aOptions    ( rSource.GetOptions() ),

    aSourceArea ( rSource.GetSource() ),

    aDestArea   ( rSource.GetDestArea() ),

    nRefreshDelaySeconds ( rSource.GetRefreshDelaySeconds() )       // seconds

{

}

bool ScAreaLinkSaver::IsEqualSource( const ScAreaLink& rCompare ) const

{

    return ( aFileName == rCompare.GetFile() &&

             aFilterName == rCompare.GetFilter() &&

             aOptions == rCompare.GetOptions() &&

             aSourceArea == rCompare.GetSource() &&

             nRefreshDelaySeconds == rCompare.GetRefreshDelaySeconds() );

}

bool ScAreaLinkSaver::IsEqual( const ScAreaLink& rCompare ) const

{

    return ( IsEqualSource( rCompare ) &&

             aDestArea == rCompare.GetDestArea() );

}

void ScAreaLinkSaver::WriteToLink( ScAreaLink& rLink ) const

{

    rLink.SetDestArea( aDestArea );

}

void ScAreaLinkSaver::InsertNewLink( ScDocument& rDoc )

{

    // (see ScUndoRemoveAreaLink::Undo)

    sfx2::LinkManager* pLinkManager = rDoc.GetLinkManager();

    ScDocShell* pObjSh = rDoc.GetDocumentShell();

    if ( pLinkManager && pObjSh )

    {

        ScAreaLink* pLink = new ScAreaLink( *pObjSh, aFileName, aFilterName, aOptions,

                                            aSourceArea, ScRange(aDestArea.aStart), nRefreshDelaySeconds );

        pLink->SetInCreate( true );

        pLink->SetDestArea( aDestArea );

        OUString aTmp1(aFilterName), aTmp2(aSourceArea);

        pLinkManager->InsertFileLink( *pLink, sfx2::SvBaseLinkObjectType::ClientFile, aFileName, &aTmp1, &aTmp2 );

        pLink->Update();

        pLink->SetInCreate( false );

    }

}

ScAreaLinkSaveCollection::ScAreaLinkSaveCollection() {}

ScAreaLinkSaveCollection::~ScAreaLinkSaveCollection() {}

bool ScAreaLinkSaveCollection::IsEqual( ScDocument& rDoc ) const

{

    // IsEqual can be checked in sequence.

    // Neither ref-update nor removing links will change the order.

    const sfx2::LinkManager* pLinkManager = rDoc.GetLinkManager();

    if (pLinkManager)

    {

        size_t nPos = 0;

        const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();

        sal_uInt16 nLinkCount = rLinks.size();

        for (sal_uInt16 i=0; i<nLinkCount; i++)

        {

            ::sfx2::SvBaseLink* pBase = rLinks[i].get();

            if (auto pAreaLink = dynamic_cast<ScAreaLink*>( pBase))

            {

                if ( nPos >= size() || !(*this)[nPos].IsEqual( *pAreaLink ) )

                    return false;

                ++nPos;

            }

        }

        if ( nPos < size() )

            return false;           // fewer links in the document than in the save collection

    }

    return true;

}

static ScAreaLink* lcl_FindLink( const ::sfx2::SvBaseLinks& rLinks, const ScAreaLinkSaver& rSaver )

{

    sal_uInt16 nLinkCount = rLinks.size();

    for (sal_uInt16 i=0; i<nLinkCount; i++)

    {

        ::sfx2::SvBaseLink* pBase = rLinks[i].get();

        if ( auto pAreaLink = dynamic_cast<ScAreaLink*>( pBase) )

            if ( rSaver.IsEqualSource( *pAreaLink ) )

                return pAreaLink;     // found

    }

    return nullptr;    // not found

}

void ScAreaLinkSaveCollection::Restore( ScDocument& rDoc )

{

    // The save collection may contain additional entries that are not in the document.

    // They must be inserted again.

    // Entries from the save collection must be searched via source data, as the order

    // of links changes if deleted entries are re-added to the link manager (always at the end).

    sfx2::LinkManager* pLinkManager = rDoc.GetDocLinkManager().getLinkManager(false);

    if (!pLinkManager)

        return;

    const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();

    size_t nSaveCount = size();

    for (size_t nPos=0; nPos<nSaveCount; ++nPos)

    {

        ScAreaLinkSaver& rSaver = (*this)[nPos];

        ScAreaLink* pLink = lcl_FindLink( rLinks, rSaver );

        if ( pLink )

            rSaver.WriteToLink( *pLink );          // restore output position

        else

            rSaver.InsertNewLink( rDoc );          // re-insert deleted link

    }

}

std::unique_ptr<ScAreaLinkSaveCollection> ScAreaLinkSaveCollection::CreateFromDoc( ScDocument& rDoc )

{

    std::unique_ptr<ScAreaLinkSaveCollection> pColl;

    sfx2::LinkManager* pLinkManager = rDoc.GetLinkManager();

    if (pLinkManager)

    {

        const ::sfx2::SvBaseLinks& rLinks = pLinkManager->GetLinks();

        sal_uInt16 nLinkCount = rLinks.size();

        for (sal_uInt16 i=0; i<nLinkCount; i++)

        {

            ::sfx2::SvBaseLink* pBase = rLinks[i].get();

            if (auto pAreaLink = dynamic_cast<ScAreaLink*>( pBase))

            {

                if (!pColl)

                    pColl.reset(new ScAreaLinkSaveCollection);

                pColl->push_back( ScAreaLinkSaver( *pAreaLink ) );

            }

        }

    }

    return pColl;

}

ScAreaLinkSaver& ScAreaLinkSaveCollection::operator [](size_t nIndex)

{

    return maData[nIndex];

}

const ScAreaLinkSaver& ScAreaLinkSaveCollection::operator [](size_t nIndex) const

{

    return maData[nIndex];

}

size_t ScAreaLinkSaveCollection::size() const

{

    return maData.size();

}

void ScAreaLinkSaveCollection::push_back(const ScAreaLinkSaver& p)

{

    maData.push_back(p);

}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */