Files
libreoffice/sc/source/ui/docshell/arealink.cxx
Stephan Bergmann 3e1d3c25e0 loplugin:includeform: sc
Change-Id: I2ed763e0584a188032c80fde60890de3c6985cbd
2017-10-23 22:45:57 +02:00

495 lines
18 KiB
C++

/* -*- 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 <comphelper/string.hxx>
#include <sfx2/app.hxx>
#include <sfx2/docfile.hxx>
#include <sfx2/fcontnr.hxx>
#include <sfx2/linkmgr.hxx>
#include <svl/stritem.hxx>
#include <vcl/msgbox.hxx>
#include <arealink.hxx>
#include <tablink.hxx>
#include <document.hxx>
#include <docsh.hxx>
#include <rangenam.hxx>
#include <dbdata.hxx>
#include <undoblk.hxx>
#include <globstr.hrc>
#include <markdata.hxx>
#include <hints.hxx>
#include <filter.hxx>
#include <attrib.hxx>
#include <patattr.hxx>
#include <docpool.hxx>
#include <sc.hrc>
#include <scabstdlg.hxx>
#include <clipparam.hxx>
struct AreaLink_Impl
{
ScDocShell* m_pDocSh;
VclPtr<AbstractScLinkedAreaDlg> m_pDialog;
AreaLink_Impl() : m_pDocSh( nullptr ), m_pDialog() {}
};
ScAreaLink::ScAreaLink( SfxObjectShell* pShell, const OUString& rFile,
const OUString& rFilter, const OUString& rOpt,
const OUString& rArea, const ScRange& rDest,
sal_uLong nRefresh ) :
::sfx2::SvBaseLink(SfxLinkUpdateMode::ONCALL,SotClipboardFormatId::SIMPLE_FILE),
ScRefreshTimer ( nRefresh ),
pImpl ( new AreaLink_Impl() ),
aFileName (rFile),
aFilterName (rFilter),
aOptions (rOpt),
aSourceArea (rArea),
aDestArea (rDest),
bAddUndo (true),
bInCreate (false),
bDoInsert (true)
{
OSL_ENSURE(dynamic_cast< const ScDocShell *>( pShell ) != nullptr, "ScAreaLink with wrong ObjectShell");
pImpl->m_pDocSh = static_cast< ScDocShell* >( pShell );
SetRefreshHandler( LINK( this, ScAreaLink, RefreshHdl ) );
SetRefreshControl( &pImpl->m_pDocSh->GetDocument().GetRefreshTimerControlAddress() );
}
ScAreaLink::~ScAreaLink()
{
StopRefreshTimer();
}
void ScAreaLink::Edit(vcl::Window* pParent, const Link<SvBaseLink&,void>& /* rEndEditHdl */ )
{
// use own dialog instead of SvBaseLink::Edit...
ScAbstractDialogFactory* pFact = ScAbstractDialogFactory::Create();
OSL_ENSURE(pFact, "ScAbstractFactory create fail!");
VclPtr<AbstractScLinkedAreaDlg> pDlg = pFact->CreateScLinkedAreaDlg(pParent);
OSL_ENSURE(pDlg, "Dialog create fail!");
pDlg->InitFromOldLink( aFileName, aFilterName, aOptions, aSourceArea, GetRefreshDelay() );
pImpl->m_pDialog = pDlg;
if ( pDlg->Execute() == RET_OK )
{
aOptions = pImpl->m_pDialog->GetOptions();
Refresh( pImpl->m_pDialog->GetURL(), pImpl->m_pDialog->GetFilter(),
pImpl->m_pDialog->GetSource(), pImpl->m_pDialog->GetRefresh() );
// copy source data from members (set in Refresh) into link name for dialog
OUString aNewLinkName;
sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
SetName( aNewLinkName );
}
pImpl->m_pDialog.clear(); // dialog is deleted with parent
}
::sfx2::SvBaseLink::UpdateResult ScAreaLink::DataChanged(
const OUString&, const css::uno::Any& )
{
// Do not do anything at bInCreate so that update can be called to set
// the status in the LinkManager without changing the data in the document
if (bInCreate)
return SUCCESS;
sfx2::LinkManager* pLinkManager=pImpl->m_pDocSh->GetDocument().GetLinkManager();
if (pLinkManager!=nullptr)
{
OUString aFile, aArea, aFilter;
sfx2::LinkManager::GetDisplayNames(this, nullptr, &aFile, &aArea, &aFilter);
// the file dialog returns the filter name with the application prefix
// -> remove prefix
ScDocumentLoader::RemoveAppPrefix( aFilter );
// dialog doesn't set area, so keep old one
if (aArea.isEmpty())
{
aArea = aSourceArea;
// adjust in dialog:
OUString aNewLinkName;
OUString aTmp = aFilter;
sfx2::MakeLnkName(aNewLinkName, nullptr, aFile, aArea, &aTmp);
aFilter = aTmp;
SetName( aNewLinkName );
}
tools::SvRef<sfx2::SvBaseLink> const xThis(this); // keep yourself alive
Refresh( aFile, aFilter, aArea, GetRefreshDelay() );
}
return SUCCESS;
}
void ScAreaLink::Closed()
{
// delete link: Undo
ScDocument& rDoc = pImpl->m_pDocSh->GetDocument();
bool bUndo (rDoc.IsUndoEnabled());
if (bAddUndo && bUndo)
{
pImpl->m_pDocSh->GetUndoManager()->AddUndoAction( new ScUndoRemoveAreaLink( pImpl->m_pDocSh,
aFileName, aFilterName, aOptions,
aSourceArea, aDestArea, GetRefreshDelay() ) );
bAddUndo = false; // only once
}
SCTAB nDestTab = aDestArea.aStart.Tab();
rDoc.SetStreamValid(nDestTab, false);
SvBaseLink::Closed();
}
void ScAreaLink::SetDestArea(const ScRange& rNew)
{
aDestArea = rNew; // for Undo
}
void ScAreaLink::SetSource(const OUString& rDoc, const OUString& rFlt, const OUString& rOpt,
const OUString& rArea)
{
aFileName = rDoc;
aFilterName = rFlt;
aOptions = rOpt;
aSourceArea = rArea;
// also update link name for dialog
OUString aNewLinkName;
sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
SetName( aNewLinkName );
}
bool ScAreaLink::IsEqual( const OUString& rFile, const OUString& rFilter, const OUString& rOpt,
const OUString& rSource, const ScRange& rDest ) const
{
return aFileName == rFile && aFilterName == rFilter && aOptions == rOpt &&
aSourceArea == rSource && aDestArea.aStart == rDest.aStart;
}
// find a range with name >rAreaName< in >pSrcDoc<, return it in >rRange<
bool ScAreaLink::FindExtRange( ScRange& rRange, const ScDocument* pSrcDoc, const OUString& rAreaName )
{
bool bFound = false;
OUString aUpperName = ScGlobal::pCharClass->uppercase(rAreaName);
ScRangeName* pNames = pSrcDoc->GetRangeName();
if (pNames) // named ranges
{
const ScRangeData* p = pNames->findByUpperName(aUpperName);
if (p && p->IsValidReference(rRange))
bFound = true;
}
if (!bFound) // database ranges
{
ScDBCollection* pDBColl = pSrcDoc->GetDBCollection();
if (pDBColl)
{
const ScDBData* pDB = pDBColl->getNamedDBs().findByUpperName(aUpperName);
if (pDB)
{
SCTAB nTab;
SCCOL nCol1, nCol2;
SCROW nRow1, nRow2;
pDB->GetArea(nTab,nCol1,nRow1,nCol2,nRow2);
rRange = ScRange( nCol1,nRow1,nTab, nCol2,nRow2,nTab );
bFound = true;
}
}
}
if (!bFound) // direct reference (range or cell)
{
ScAddress::Details aDetails(pSrcDoc->GetAddressConvention(), 0, 0);
if ( rRange.ParseAny( rAreaName, pSrcDoc, aDetails ) & ScRefFlags::VALID )
bFound = true;
}
return bFound;
}
// execute:
bool ScAreaLink::Refresh( const OUString& rNewFile, const OUString& rNewFilter,
const OUString& rNewArea, sal_uLong nNewRefresh )
{
// load document - like TabLink
if (rNewFile.isEmpty() || rNewFilter.isEmpty())
return false;
OUString aNewUrl( ScGlobal::GetAbsDocName( rNewFile, pImpl->m_pDocSh ) );
bool bNewUrlName = (aNewUrl != aFileName);
std::shared_ptr<const SfxFilter> pFilter = pImpl->m_pDocSh->GetFactory().GetFilterContainer()->GetFilter4FilterName(rNewFilter);
if (!pFilter)
return false;
ScDocument& rDoc = pImpl->m_pDocSh->GetDocument();
bool bUndo (rDoc.IsUndoEnabled());
rDoc.SetInLinkUpdate( true );
// if new filter was selected, forget options
if ( rNewFilter != aFilterName )
aOptions.clear();
SfxMedium* pMed = ScDocumentLoader::CreateMedium( aNewUrl, pFilter, aOptions);
// aRef->DoClose() will be closed explicitly, but it is still more safe to use SfxObjectShellLock here
ScDocShell* pSrcShell = new ScDocShell(SfxModelFlags::EMBEDDED_OBJECT | SfxModelFlags::DISABLE_EMBEDDED_SCRIPTS);
SfxObjectShellLock aRef = pSrcShell;
pSrcShell->DoLoad(pMed);
ScDocument& rSrcDoc = pSrcShell->GetDocument();
// options could have been set
OUString aNewOpt = ScDocumentLoader::GetOptions(*pMed);
if (aNewOpt.isEmpty())
aNewOpt = aOptions;
// correct source range name list for web query import
OUString aTempArea;
if( rNewFilter == ScDocShell::GetWebQueryFilterName() )
aTempArea = ScFormatFilter::Get().GetHTMLRangeNameList( &rSrcDoc, rNewArea );
else
aTempArea = rNewArea;
// find total size of source area
SCCOL nWidth = 0;
SCROW nHeight = 0;
sal_Int32 nTokenCnt = comphelper::string::getTokenCount(aTempArea, ';');
sal_Int32 nStringIx = 0;
sal_Int32 nToken;
for( nToken = 0; nToken < nTokenCnt; nToken++ )
{
OUString aToken( aTempArea.getToken( 0, ';', nStringIx ) );
ScRange aTokenRange;
if( FindExtRange( aTokenRange, &rSrcDoc, aToken ) )
{
// columns: find maximum
nWidth = std::max( nWidth, (SCCOL)(aTokenRange.aEnd.Col() - aTokenRange.aStart.Col() + 1) );
// rows: add row range + 1 empty row
nHeight += aTokenRange.aEnd.Row() - aTokenRange.aStart.Row() + 2;
}
}
// remove the last empty row
if( nHeight > 0 )
nHeight--;
// delete old data / copy new
ScAddress aDestPos = aDestArea.aStart;
SCTAB nDestTab = aDestPos.Tab();
ScRange aOldRange = aDestArea;
ScRange aNewRange = aDestArea; // old range, if file not found or similar
if (nWidth > 0 && nHeight > 0)
{
aNewRange.aEnd.SetCol( aNewRange.aStart.Col() + nWidth - 1 );
aNewRange.aEnd.SetRow( aNewRange.aStart.Row() + nHeight - 1 );
}
//! check CanFitBlock only if bDoInsert is set?
bool bCanDo = ValidColRow( aNewRange.aEnd.Col(), aNewRange.aEnd.Row() ) &&
rDoc.CanFitBlock( aOldRange, aNewRange );
if (bCanDo)
{
ScDocShellModificator aModificator( *pImpl->m_pDocSh );
SCCOL nOldEndX = aOldRange.aEnd.Col();
SCROW nOldEndY = aOldRange.aEnd.Row();
SCCOL nNewEndX = aNewRange.aEnd.Col();
SCROW nNewEndY = aNewRange.aEnd.Row();
ScRange aMaxRange( aDestPos,
ScAddress(std::max(nOldEndX,nNewEndX), std::max(nOldEndY,nNewEndY), nDestTab) );
// initialise Undo
ScDocument* pUndoDoc = nullptr;
if ( bAddUndo && bUndo )
{
pUndoDoc = new ScDocument( SCDOCMODE_UNDO );
if ( bDoInsert )
{
if ( nNewEndX != nOldEndX || nNewEndY != nOldEndY ) // range changed?
{
pUndoDoc->InitUndo( &rDoc, 0, rDoc.GetTableCount()-1 );
rDoc.CopyToDocument(0, 0, 0, MAXCOL, MAXROW, MAXTAB,
InsertDeleteFlags::FORMULA, false, *pUndoDoc); // all formulas
}
else
pUndoDoc->InitUndo( &rDoc, nDestTab, nDestTab ); // only destination table
rDoc.CopyToDocument(aOldRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
}
else // without insertion
{
pUndoDoc->InitUndo( &rDoc, nDestTab, nDestTab ); // only destination table
rDoc.CopyToDocument(aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
}
}
// insert / delete cells
// DeleteAreaTab also deletes MERGE_FLAG attributes
if (bDoInsert)
rDoc.FitBlock( aOldRange, aNewRange ); // incl. deletion
else
rDoc.DeleteAreaTab( aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE );
// copy data
if (nWidth > 0 && nHeight > 0)
{
ScDocument aClipDoc( SCDOCMODE_CLIP );
ScRange aNewTokenRange( aNewRange.aStart );
nStringIx = 0;
for( nToken = 0; nToken < nTokenCnt; nToken++ )
{
OUString aToken( aTempArea.getToken( 0, ';', nStringIx ) );
ScRange aTokenRange;
if( FindExtRange( aTokenRange, &rSrcDoc, aToken ) )
{
SCTAB nSrcTab = aTokenRange.aStart.Tab();
ScMarkData aSourceMark;
aSourceMark.SelectOneTable( nSrcTab ); // selecting for CopyToClip
aSourceMark.SetMarkArea( aTokenRange );
ScClipParam aClipParam(aTokenRange, false);
rSrcDoc.CopyToClip(aClipParam, &aClipDoc, &aSourceMark, false, false);
if ( aClipDoc.HasAttrib( 0,0,nSrcTab, MAXCOL,MAXROW,nSrcTab,
HasAttrFlags::Merged | HasAttrFlags::Overlapped ) )
{
//! ResetAttrib at document !!!
ScPatternAttr aPattern( rSrcDoc.GetPool() );
aPattern.GetItemSet().Put( ScMergeAttr() ); // Defaults
aPattern.GetItemSet().Put( ScMergeFlagAttr() );
aClipDoc.ApplyPatternAreaTab( 0,0, MAXCOL,MAXROW, nSrcTab, aPattern );
}
aNewTokenRange.aEnd.SetCol( aNewTokenRange.aStart.Col() + (aTokenRange.aEnd.Col() - aTokenRange.aStart.Col()) );
aNewTokenRange.aEnd.SetRow( aNewTokenRange.aStart.Row() + (aTokenRange.aEnd.Row() - aTokenRange.aStart.Row()) );
ScMarkData aDestMark;
aDestMark.SelectOneTable( nDestTab );
aDestMark.SetMarkArea( aNewTokenRange );
rDoc.CopyFromClip( aNewTokenRange, aDestMark, InsertDeleteFlags::ALL, nullptr, &aClipDoc, false );
aNewTokenRange.aStart.SetRow( aNewTokenRange.aEnd.Row() + 2 );
}
}
}
else
{
OUString aErr = ScGlobal::GetRscString(STR_LINKERROR);
rDoc.SetString( aDestPos.Col(), aDestPos.Row(), aDestPos.Tab(), aErr );
}
// enter Undo
if ( bAddUndo && bUndo)
{
ScDocument* pRedoDoc = new ScDocument( SCDOCMODE_UNDO );
pRedoDoc->InitUndo( &rDoc, nDestTab, nDestTab );
rDoc.CopyToDocument(aNewRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pRedoDoc);
pImpl->m_pDocSh->GetUndoManager()->AddUndoAction(
new ScUndoUpdateAreaLink( pImpl->m_pDocSh,
aFileName, aFilterName, aOptions,
aSourceArea, aOldRange, GetRefreshDelay(),
aNewUrl, rNewFilter, aNewOpt,
rNewArea, aNewRange, nNewRefresh,
pUndoDoc, pRedoDoc, bDoInsert ) );
}
// remember new settings
if ( bNewUrlName )
aFileName = aNewUrl;
if ( rNewFilter != aFilterName )
aFilterName = rNewFilter;
if ( rNewArea != aSourceArea )
aSourceArea = rNewArea;
if ( aNewOpt != aOptions )
aOptions = aNewOpt;
if ( aNewRange != aDestArea )
aDestArea = aNewRange;
if ( nNewRefresh != GetRefreshDelay() )
SetRefreshDelay( nNewRefresh );
SCCOL nPaintEndX = std::max( aOldRange.aEnd.Col(), aNewRange.aEnd.Col() );
SCROW nPaintEndY = std::max( aOldRange.aEnd.Row(), aNewRange.aEnd.Row() );
if ( aOldRange.aEnd.Col() != aNewRange.aEnd.Col() )
nPaintEndX = MAXCOL;
if ( aOldRange.aEnd.Row() != aNewRange.aEnd.Row() )
nPaintEndY = MAXROW;
if ( !pImpl->m_pDocSh->AdjustRowHeight( aDestPos.Row(), nPaintEndY, nDestTab ) )
pImpl->m_pDocSh->PostPaint(
ScRange(aDestPos.Col(), aDestPos.Row(), nDestTab, nPaintEndX, nPaintEndY, nDestTab),
PaintPartFlags::Grid);
aModificator.SetDocumentModified();
}
else
{
// CanFitBlock sal_False -> Problems with summarized cells or table boundary reached!
//! cell protection ???
//! Link dialog must set default parent
// "cannot insert rows"
ScopedVclPtrInstance<InfoBox> aBox( Application::GetDefDialogParent(),
ScGlobal::GetRscString( STR_MSSG_DOSUBTOTALS_2 ) );
aBox->Execute();
}
// clean up
aRef->DoClose();
rDoc.SetInLinkUpdate( false );
if (bCanDo)
{
// notify Uno objects (for XRefreshListener)
//! also notify Uno objects if file name was changed!
ScLinkRefreshedHint aHint;
aHint.SetAreaLink( aDestPos );
rDoc.BroadcastUno( aHint );
}
return bCanDo;
}
IMPL_LINK_NOARG(ScAreaLink, RefreshHdl, Timer *, void)
{
Refresh( aFileName, aFilterName, aSourceArea, GetRefreshDelay() );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */