sc/source/ui/docshell/arealink.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sfx2/fcontnr.hxx>
  21 #include <sfx2/linkmgr.hxx>
  22 #include <utility>
  23 #include <vcl/svapp.hxx>
  24 #include <vcl/weld.hxx>
  25 #include <unotools/charclass.hxx>
  26 #include <osl/diagnose.h>
  27
  28 #include <arealink.hxx>
  29
  30 #include <tablink.hxx>
  31 #include <document.hxx>
  32 #include <docsh.hxx>
  33 #include <rangenam.hxx>
  34 #include <dbdata.hxx>
  35 #include <undoblk.hxx>
  36 #include <globstr.hrc>
  37 #include <scresid.hxx>
  38 #include <markdata.hxx>
  39 #include <hints.hxx>
  40 #include <filter.hxx>
  41
  42 #include <attrib.hxx>
  43 #include <patattr.hxx>
  44 #include <docpool.hxx>
  45
  46 #include <scabstdlg.hxx>
  47 #include <clipparam.hxx>
  48
  49
  50 ScAreaLink::ScAreaLink( ScDocShell* pShell, OUString aFile,
  51                         OUString aFilter, OUString aOpt,
  52                         OUString aArea, const ScRange& rDest,
  53                         sal_Int32 nRefreshDelaySeconds ) :
  54     ::sfx2::SvBaseLink(SfxLinkUpdateMode::ONCALL,SotClipboardFormatId::SIMPLE_FILE),
  55     ScRefreshTimer  ( nRefreshDelaySeconds ),
  56     m_pDocSh(pShell),
  57     aFileName       (std::move(aFile)),
  58     aFilterName     (std::move(aFilter)),
  59     aOptions        (std::move(aOpt)),
  60     aSourceArea     (std::move(aArea)),
  61     aDestArea       (rDest),
  62     bAddUndo        (true),
  63     bInCreate       (false),
  64     bDoInsert       (true)
  65 {
  66     SetRefreshHandler( LINK( this, ScAreaLink, RefreshHdl ) );
  67     SetRefreshControl( &m_pDocSh->GetDocument().GetRefreshTimerControlAddress() );
  68 }
  69
  70 ScAreaLink::~ScAreaLink()
  71 {
  72     StopRefreshTimer();
  73 }
  74
  75 void ScAreaLink::Edit(weld::Window* pParent, const Link<SvBaseLink&,void>& /* rEndEditHdl */ )
  76 {
  77     //  use own dialog instead of SvBaseLink::Edit...
  78     ScAbstractDialogFactory* pFact = ScAbstractDialogFactory::Create();
  79
  80     ScopedVclPtr<AbstractScLinkedAreaDlg> pDlg(pFact->CreateScLinkedAreaDlg(pParent));
  81     pDlg->InitFromOldLink( aFileName, aFilterName, aOptions, aSourceArea, GetRefreshDelaySeconds() );
  82     if ( pDlg->Execute() == RET_OK )
  83     {
  84         aOptions = pDlg->GetOptions();
  85         Refresh( pDlg->GetURL(), pDlg->GetFilter(),
  86                  pDlg->GetSource(), pDlg->GetRefreshDelaySeconds() );
  87
  88         //  copy source data from members (set in Refresh) into link name for dialog
  89         OUString aNewLinkName;
  90         sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
  91         SetName( aNewLinkName );
  92     }
  93 }
  94
  95 ::sfx2::SvBaseLink::UpdateResult ScAreaLink::DataChanged(
  96     const OUString&, const css::uno::Any& )
  97 {
  98     //  Do not do anything at bInCreate so that update can be called to set
  99     //  the status in the LinkManager without changing the data in the document
 100
 101     if (bInCreate)
 102         return SUCCESS;
 103
 104     sfx2::LinkManager* pLinkManager=m_pDocSh->GetDocument().GetLinkManager();
 105     if (pLinkManager!=nullptr)
 106     {
 107         OUString aFile, aArea, aFilter;
 108         sfx2::LinkManager::GetDisplayNames(this, nullptr, &aFile, &aArea, &aFilter);
 109
 110         //  the file dialog returns the filter name with the application prefix
 111         //  -> remove prefix
 112         ScDocumentLoader::RemoveAppPrefix( aFilter );
 113
 114         // dialog doesn't set area, so keep old one
 115         if (aArea.isEmpty())
 116         {
 117             aArea = aSourceArea;
 118
 119             // adjust in dialog:
 120             OUString aNewLinkName;
 121             OUString aTmp = aFilter;
 122             sfx2::MakeLnkName(aNewLinkName, nullptr, aFile, aArea, &aTmp);
 123             aFilter = aTmp;
 124             SetName( aNewLinkName );
 125         }
 126
 127         tools::SvRef<sfx2::SvBaseLink> const xThis(this); // keep yourself alive
 128         Refresh( aFile, aFilter, aArea, GetRefreshDelaySeconds() );
 129     }
 130
 131     return SUCCESS;
 132 }
 133
 134 void ScAreaLink::Closed()
 135 {
 136     // delete link: Undo
 137
 138     ScDocument& rDoc = m_pDocSh->GetDocument();
 139     bool bUndo (rDoc.IsUndoEnabled());
 140     if (bAddUndo && bUndo)
 141     {
 142         m_pDocSh->GetUndoManager()->AddUndoAction( std::make_unique<ScUndoRemoveAreaLink>( m_pDocSh,
 143                                                         aFileName, aFilterName, aOptions,
 144                                                         aSourceArea, aDestArea, GetRefreshDelaySeconds() ) );
 145
 146         bAddUndo = false;   // only once
 147     }
 148
 149     SCTAB nDestTab = aDestArea.aStart.Tab();
 150     rDoc.SetStreamValid(nDestTab, false);
 151
 152     SvBaseLink::Closed();
 153 }
 154
 155 void ScAreaLink::SetDestArea(const ScRange& rNew)
 156 {
 157     aDestArea = rNew;           // for Undo
 158 }
 159
 160 void ScAreaLink::SetSource(const OUString& rDoc, const OUString& rFlt, const OUString& rOpt,
 161                                 const OUString& rArea)
 162 {
 163     aFileName   = rDoc;
 164     aFilterName = rFlt;
 165     aOptions    = rOpt;
 166     aSourceArea = rArea;
 167
 168     //  also update link name for dialog
 169     OUString aNewLinkName;
 170     sfx2::MakeLnkName( aNewLinkName, nullptr, aFileName, aSourceArea, &aFilterName );
 171     SetName( aNewLinkName );
 172 }
 173
 174 bool ScAreaLink::IsEqual( std::u16string_view rFile, std::u16string_view rFilter, std::u16string_view rOpt,
 175                             std::u16string_view rSource, const ScRange& rDest ) const
 176 {
 177     return aFileName == rFile && aFilterName == rFilter && aOptions == rOpt &&
 178             aSourceArea == rSource && aDestArea.aStart == rDest.aStart;
 179 }
 180
 181 // find a range with name >rAreaName< in >rSrcDoc<, return it in >rRange<
 182 bool ScAreaLink::FindExtRange( ScRange& rRange, const ScDocument& rSrcDoc, const OUString& rAreaName )
 183 {
 184     bool bFound = false;
 185     OUString aUpperName = ScGlobal::getCharClass().uppercase(rAreaName);
 186     ScRangeName* pNames = rSrcDoc.GetRangeName();
 187     if (pNames)         // named ranges
 188     {
 189         const ScRangeData* p = pNames->findByUpperName(aUpperName);
 190         if (p && p->IsValidReference(rRange))
 191             bFound = true;
 192     }
 193     if (!bFound)        // database ranges
 194     {
 195         ScDBCollection* pDBColl = rSrcDoc.GetDBCollection();
 196         if (pDBColl)
 197         {
 198             const ScDBData* pDB = pDBColl->getNamedDBs().findByUpperName(aUpperName);
 199             if (pDB)
 200             {
 201                 SCTAB nTab;
 202                 SCCOL nCol1, nCol2;
 203                 SCROW nRow1, nRow2;
 204                 pDB->GetArea(nTab,nCol1,nRow1,nCol2,nRow2);
 205                 rRange = ScRange( nCol1,nRow1,nTab, nCol2,nRow2,nTab );
 206                 bFound = true;
 207             }
 208         }
 209     }
 210     if (!bFound)        // direct reference (range or cell)
 211     {
 212         ScAddress::Details aDetails(rSrcDoc.GetAddressConvention(), 0, 0);
 213         if ( rRange.ParseAny( rAreaName, rSrcDoc, aDetails ) & ScRefFlags::VALID )
 214             bFound = true;
 215     }
 216     return bFound;
 217 }
 218
 219 //  execute:
 220
 221 bool ScAreaLink::Refresh( const OUString& rNewFile, const OUString& rNewFilter,
 222                             const OUString& rNewArea, sal_Int32 nNewRefreshDelaySeconds )
 223 {
 224     //  load document - like TabLink
 225
 226     if (rNewFile.isEmpty() || rNewFilter.isEmpty())
 227         return false;
 228
 229     if (!m_pDocSh->GetEmbeddedObjectContainer().getUserAllowsLinkUpdate())
 230         return false;
 231
 232     OUString aNewUrl( ScGlobal::GetAbsDocName( rNewFile, m_pDocSh ) );
 233     bool bNewUrlName = (aNewUrl != aFileName);
 234
 235     std::shared_ptr<const SfxFilter> pFilter = m_pDocSh->GetFactory().GetFilterContainer()->GetFilter4FilterName(rNewFilter);
 236     if (!pFilter)
 237         return false;
 238
 239     ScDocument& rDoc = m_pDocSh->GetDocument();
 240
 241     bool bUndo (rDoc.IsUndoEnabled());
 242     rDoc.SetInLinkUpdate( true );
 243
 244     //  if new filter was selected, forget options
 245     if ( rNewFilter != aFilterName )
 246         aOptions.clear();
 247
 248     SfxMedium* pMed = ScDocumentLoader::CreateMedium( aNewUrl, pFilter, aOptions);
 249
 250     // aRef->DoClose() will be closed explicitly, but it is still more safe to use SfxObjectShellLock here
 251     rtl::Reference<ScDocShell> pSrcShell = new ScDocShell(SfxModelFlags::EMBEDDED_OBJECT | SfxModelFlags::DISABLE_EMBEDDED_SCRIPTS);
 252     pSrcShell->DoLoad(pMed);
 253
 254     ScDocument& rSrcDoc = pSrcShell->GetDocument();
 255
 256     // options could have been set
 257     OUString aNewOpt = ScDocumentLoader::GetOptions(*pMed);
 258     if (aNewOpt.isEmpty())
 259         aNewOpt = aOptions;
 260
 261     // correct source range name list for web query import
 262     OUString aTempArea;
 263
 264     if( rNewFilter == ScDocShell::GetWebQueryFilterName() )
 265         aTempArea = ScFormatFilter::Get().GetHTMLRangeNameList( rSrcDoc, rNewArea );
 266     else
 267         aTempArea = rNewArea;
 268
 269     // find total size of source area
 270     SCCOL nWidth = 0;
 271     SCROW nHeight = 0;
 272     ScRangeList aSourceRanges;
 273
 274     if (rNewFilter == SC_TEXT_CSV_FILTER_NAME && aTempArea == "CSV_all")
 275     {
 276         // The dummy All range. All data, including top/left empty
 277         // rows/columns.
 278         aTempArea.clear();
 279         SCCOL nEndCol = 0;
 280         SCROW nEndRow = 0;
 281         if (rSrcDoc.GetCellArea( 0, nEndCol, nEndRow))
 282         {
 283             aSourceRanges.push_back( ScRange( 0,0,0, nEndCol, nEndRow, 0));
 284             nWidth = nEndCol + 1;
 285             nHeight = nEndRow + 2;
 286         }
 287     }
 288
 289     if (!aTempArea.isEmpty())
 290     {
 291         sal_Int32 nIdx {0};
 292         do
 293         {
 294             ScRange aTokenRange;
 295             if( FindExtRange( aTokenRange, rSrcDoc, aTempArea.getToken( 0, ';', nIdx ) ) )
 296             {
 297                 aSourceRanges.push_back( aTokenRange);
 298                 // columns: find maximum
 299                 nWidth = std::max( nWidth, static_cast<SCCOL>(aTokenRange.aEnd.Col() - aTokenRange.aStart.Col() + 1) );
 300                 // rows: add row range + 1 empty row
 301                 nHeight += aTokenRange.aEnd.Row() - aTokenRange.aStart.Row() + 2;
 302             }
 303         }
 304         while (nIdx>0);
 305     }
 306     // remove the last empty row
 307     if( nHeight > 0 )
 308         nHeight--;
 309
 310     //  delete old data / copy new
 311
 312     ScAddress aDestPos = aDestArea.aStart;
 313     SCTAB nDestTab = aDestPos.Tab();
 314     ScRange aOldRange = aDestArea;
 315     ScRange aNewRange = aDestArea;          // old range, if file not found or similar
 316     if (nWidth > 0 && nHeight > 0)
 317     {
 318         aNewRange.aEnd.SetCol( aNewRange.aStart.Col() + nWidth - 1 );
 319         aNewRange.aEnd.SetRow( aNewRange.aStart.Row() + nHeight - 1 );
 320     }
 321
 322     //! check CanFitBlock only if bDoInsert is set?
 323     bool bCanDo = rDoc.ValidColRow( aNewRange.aEnd.Col(), aNewRange.aEnd.Row() ) &&
 324                   rDoc.CanFitBlock( aOldRange, aNewRange );
 325     if (bCanDo)
 326     {
 327         ScDocShellModificator aModificator( *m_pDocSh );
 328
 329         SCCOL nOldEndX = aOldRange.aEnd.Col();
 330         SCROW nOldEndY = aOldRange.aEnd.Row();
 331         SCCOL nNewEndX = aNewRange.aEnd.Col();
 332         SCROW nNewEndY = aNewRange.aEnd.Row();
 333         ScRange aMaxRange( aDestPos,
 334                     ScAddress(std::max(nOldEndX,nNewEndX), std::max(nOldEndY,nNewEndY), nDestTab) );
 335
 336         //  initialise Undo
 337
 338         ScDocumentUniquePtr pUndoDoc;
 339         if ( bAddUndo && bUndo )
 340         {
 341             pUndoDoc.reset(new ScDocument( SCDOCMODE_UNDO ));
 342             if ( bDoInsert )
 343             {
 344                 if ( nNewEndX != nOldEndX || nNewEndY != nOldEndY )             // range changed?
 345                 {
 346                     pUndoDoc->InitUndo( rDoc, 0, rDoc.GetTableCount()-1 );
 347                     rDoc.CopyToDocument(0, 0, 0, rDoc.MaxCol(), rDoc.MaxRow(), MAXTAB,
 348                                         InsertDeleteFlags::FORMULA, false, *pUndoDoc);     // all formulas
 349                 }
 350                 else
 351                     pUndoDoc->InitUndo( rDoc, nDestTab, nDestTab );             // only destination table
 352                 rDoc.CopyToDocument(aOldRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
 353             }
 354             else        // without insertion
 355             {
 356                 pUndoDoc->InitUndo( rDoc, nDestTab, nDestTab );             // only destination table
 357                 rDoc.CopyToDocument(aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pUndoDoc);
 358             }
 359         }
 360
 361         //  insert / delete cells
 362         //  DeleteAreaTab also deletes MERGE_FLAG attributes
 363
 364         if (bDoInsert)
 365             rDoc.FitBlock( aOldRange, aNewRange );         // incl. deletion
 366         else
 367             rDoc.DeleteAreaTab( aMaxRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE );
 368
 369         //  copy data
 370
 371         if (nWidth > 0 && nHeight > 0)
 372         {
 373             ScDocument aClipDoc( SCDOCMODE_CLIP );
 374             ScRange aNewTokenRange( aNewRange.aStart );
 375             for (size_t nRange = 0; nRange < aSourceRanges.size(); ++nRange)
 376             {
 377                 ScRange const & rTokenRange( aSourceRanges[nRange]);
 378                 SCTAB nSrcTab = rTokenRange.aStart.Tab();
 379                 ScMarkData aSourceMark(rSrcDoc.GetSheetLimits());
 380                 aSourceMark.SelectOneTable( nSrcTab );      // selecting for CopyToClip
 381                 aSourceMark.SetMarkArea( rTokenRange );
 382
 383                 ScClipParam aClipParam(rTokenRange, false);
 384                 rSrcDoc.CopyToClip(aClipParam, &aClipDoc, &aSourceMark, false, false);
 385
 386                 if ( aClipDoc.HasAttrib( 0,0,nSrcTab, rDoc.MaxCol(),rDoc.MaxRow(),nSrcTab,
 387                             HasAttrFlags::Merged | HasAttrFlags::Overlapped ) )
 388                 {
 389                     //! ResetAttrib at document !!!
 390
 391                     ScPatternAttr aPattern( rSrcDoc.getCellAttributeHelper() );
 392                     aPattern.GetItemSet().Put( ScMergeAttr() );             // Defaults
 393                     aPattern.GetItemSet().Put( ScMergeFlagAttr() );
 394                     aClipDoc.ApplyPatternAreaTab( 0,0, rDoc.MaxCol(),rDoc.MaxRow(), nSrcTab, aPattern );
 395                 }
 396
 397                 aNewTokenRange.aEnd.SetCol( aNewTokenRange.aStart.Col() + (rTokenRange.aEnd.Col() - rTokenRange.aStart.Col()) );
 398                 aNewTokenRange.aEnd.SetRow( aNewTokenRange.aStart.Row() + (rTokenRange.aEnd.Row() - rTokenRange.aStart.Row()) );
 399                 ScMarkData aDestMark(rDoc.GetSheetLimits());
 400                 aDestMark.SelectOneTable( nDestTab );
 401                 aDestMark.SetMarkArea( aNewTokenRange );
 402                 rDoc.CopyFromClip( aNewTokenRange, aDestMark, InsertDeleteFlags::ALL, nullptr, &aClipDoc, false );
 403                 aNewTokenRange.aStart.SetRow( aNewTokenRange.aEnd.Row() + 2 );
 404             }
 405         }
 406         else
 407         {
 408             OUString aErr = ScResId(STR_LINKERROR);
 409             rDoc.SetString( aDestPos.Col(), aDestPos.Row(), aDestPos.Tab(), aErr );
 410         }
 411
 412         //  enter Undo
 413
 414         if ( bAddUndo && bUndo)
 415         {
 416             ScDocumentUniquePtr pRedoDoc(new ScDocument( SCDOCMODE_UNDO ));
 417             pRedoDoc->InitUndo( rDoc, nDestTab, nDestTab );
 418             rDoc.CopyToDocument(aNewRange, InsertDeleteFlags::ALL & ~InsertDeleteFlags::NOTE, false, *pRedoDoc);
 419
 420             m_pDocSh->GetUndoManager()->AddUndoAction(
 421                 std::make_unique<ScUndoUpdateAreaLink>( m_pDocSh,
 422                                             aFileName, aFilterName, aOptions,
 423                                             aSourceArea, aOldRange, GetRefreshDelaySeconds(),
 424                                             aNewUrl, rNewFilter, aNewOpt,
 425                                             rNewArea, aNewRange, nNewRefreshDelaySeconds,
 426                                             std::move(pUndoDoc), std::move(pRedoDoc), bDoInsert ) );
 427         }
 428
 429         //  remember new settings
 430
 431         if ( bNewUrlName )
 432             aFileName = aNewUrl;
 433         if ( rNewFilter != aFilterName )
 434             aFilterName = rNewFilter;
 435         if ( rNewArea != aSourceArea )
 436             aSourceArea = rNewArea;
 437         if ( aNewOpt != aOptions )
 438             aOptions = aNewOpt;
 439
 440         if ( aNewRange != aDestArea )
 441             aDestArea = aNewRange;
 442
 443         if ( nNewRefreshDelaySeconds != GetRefreshDelaySeconds() )
 444             SetRefreshDelay( nNewRefreshDelaySeconds );
 445
 446         SCCOL nPaintEndX = std::max( aOldRange.aEnd.Col(), aNewRange.aEnd.Col() );
 447         SCROW nPaintEndY = std::max( aOldRange.aEnd.Row(), aNewRange.aEnd.Row() );
 448
 449         if ( aOldRange.aEnd.Col() != aNewRange.aEnd.Col() )
 450             nPaintEndX = rDoc.MaxCol();
 451         if ( aOldRange.aEnd.Row() != aNewRange.aEnd.Row() )
 452             nPaintEndY = rDoc.MaxRow();
 453
 454         if ( !m_pDocSh->AdjustRowHeight( aDestPos.Row(), nPaintEndY, nDestTab ) )
 455             m_pDocSh->PostPaint(
 456                 ScRange(aDestPos.Col(), aDestPos.Row(), nDestTab, nPaintEndX, nPaintEndY, nDestTab),
 457                 PaintPartFlags::Grid);
 458         aModificator.SetDocumentModified();
 459     }
 460     else
 461     {
 462         //  CanFitBlock sal_False -> Problems with summarized cells or table boundary reached!
 463         //! cell protection ???
 464
 465         //! Link dialog must set default parent
 466         //  "cannot insert rows"
 467         weld::Window* pWin = Application::GetFrameWeld(m_pDocSh->GetDialogParent());
 468         std::unique_ptr<weld::MessageDialog> xInfoBox(Application::CreateMessageDialog(pWin,
 469                                                       VclMessageType::Info, VclButtonsType::Ok,
 470                                                       ScResId(STR_MSSG_DOSUBTOTALS_2)));
 471         xInfoBox->run();
 472     }
 473
 474     //  clean up
 475
 476     pSrcShell->DoClose();
 477
 478     rDoc.SetInLinkUpdate( false );
 479
 480     if (bCanDo)
 481     {
 482         //  notify Uno objects (for XRefreshListener)
 483         //! also notify Uno objects if file name was changed!
 484         ScLinkRefreshedHint aHint;
 485         aHint.SetAreaLink( aDestPos );
 486         rDoc.BroadcastUno( aHint );
 487     }
 488
 489     return bCanDo;
 490 }
 491
 492 IMPL_LINK_NOARG(ScAreaLink, RefreshHdl, Timer *, void)
 493 {
 494     Refresh( aFileName, aFilterName, aSourceArea, GetRefreshDelaySeconds() );
 495 }
 496
 497 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */