sfx2/source/appl/fileobj.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
  21 #include <vcl/wrkwin.hxx>
  22 #include <vcl/msgbox.hxx>
  23 #include <tools/urlobj.hxx>
  24 #include <tools/stream.hxx>
  25 #include <sot/formats.hxx>
  26 #include <vcl/graphicfilter.hxx>
  27 #include <sfx2/lnkbase.hxx>
  28 #include <sfx2/app.hxx>
  29 #include <sfx2/progress.hxx>
  30 #include <sfx2/docfilt.hxx>
  31 #include <sfx2/filedlghelper.hxx>
  32 #include <sot/exchange.hxx>
  33 #include <com/sun/star/uno/Any.hxx>
  34 #include <com/sun/star/uno/Sequence.hxx>
  35 #include <sfx2/docfac.hxx>
  36 #include <com/sun/star/document/XTypeDetection.hpp>
  37 #include <comphelper/mediadescriptor.hxx>
  38 #include <comphelper/processfactory.hxx>
  39 #include <sfx2/linkmgr.hxx>
  40 #include <sfx2/opengrf.hxx>
  41 #include "sfx2/sfxresid.hxx"
  42 #include "fileobj.hxx"
  43 #include "app.hrc"
  44
  45 #define FILETYPE_TEXT       1
  46 #define FILETYPE_GRF        2
  47 #define FILETYPE_OBJECT     3
  48
  49 struct Impl_DownLoadData
  50 {
  51     Graphic aGrf;
  52     Timer aTimer;
  53
  54     Impl_DownLoadData( const Link& rLink )
  55     {
  56         aTimer.SetTimeout( 100 );
  57         aTimer.SetTimeoutHdl( rLink  );
  58         aGrf.SetDefaultType();
  59     }
  60     ~Impl_DownLoadData()
  61     {
  62         aTimer.Stop();
  63     }
  64 };
  65
  66 // --------------------------------------------------------------------------
  67
  68
  69 SvFileObject::SvFileObject() :
  70     pDownLoadData( NULL ), pOldParent( NULL ), nType( FILETYPE_TEXT )
  71 {
  72     bLoadAgain = sal_True;
  73     bSynchron = bLoadError = bWaitForData = bDataReady = bNativFormat =
  74     bClearMedium = bStateChangeCalled = bInCallDownLoad = sal_False;
  75 }
  76
  77
  78 SvFileObject::~SvFileObject()
  79 {
  80     if ( xMed.Is() )
  81     {
  82         xMed->SetDoneLink( Link() );
  83         xMed.Clear();
  84     }
  85     delete pDownLoadData;
  86 }
  87
  88
  89 sal_Bool SvFileObject::GetData( ::com::sun::star::uno::Any & rData,
  90                                 const String & rMimeType,
  91                                 sal_Bool bGetSynchron )
  92 {
  93     sal_uIntPtr nFmt = SotExchange::GetFormatStringId( rMimeType );
  94     switch( nType )
  95     {
  96     case FILETYPE_TEXT:
  97         if( FORMAT_FILE == nFmt )
  98         {
  99             // The media in the application must be opened to lookup the
 100             // relative file links!! This is done through the link manager
 101             // of the Storage.
 102             rData <<= OUString( sFileNm );
 103         }
 104         break;
 105
 106     case FILETYPE_GRF:
 107         if( !bLoadError )
 108         {
 109             SfxMediumRef xTmpMed;
 110
 111             if( FORMAT_GDIMETAFILE == nFmt || FORMAT_BITMAP == nFmt ||
 112                 SOT_FORMATSTR_ID_SVXB == nFmt )
 113             {
 114                 Graphic aGrf;
 115
 116                 // If the native format is reqested, has to be reset at the
 117                 // end of the flag. Is solely in the sw/ndgrf.cxx used when
 118                 // the link is removed form GraphicNode.
 119                 sal_Bool bOldNativFormat = bNativFormat;
 120
 121                 // If about to print, waiting for the data to be available
 122                 if( bGetSynchron )
 123                 {
 124                     // call a LoadFile every second time to test the loading
 125                     if( !xMed.Is() )
 126                         LoadFile_Impl();
 127
 128                     if( !bInCallDownLoad )
 129                     {
 130                         xTmpMed = xMed;
 131                         while( bWaitForData )
 132                             Application::Reschedule();
 133
 134                         xMed = xTmpMed;
 135                         bClearMedium = sal_True;
 136                     }
 137                 }
 138
 139                 if( pDownLoadData ||
 140                     ( !bWaitForData && ( xMed.Is() ||  // was loaded as URL
 141                         ( bSynchron && LoadFile_Impl() && xMed.Is() ) )) )
 142                 {
 143                     // If it was loaded from the Internet, do not retry
 144                     if( !bGetSynchron )
 145                         bLoadAgain = !xMed->IsRemote();
 146                     bLoadError = !GetGraphic_Impl( aGrf, xMed->GetInStream() );
 147                 }
 148                 else if( !LoadFile_Impl() ||
 149                         !GetGraphic_Impl( aGrf, xMed.Is() ? xMed->GetInStream() : 0 ))
 150                 {
 151                     if( !xMed.Is() )
 152                         break;
 153                     aGrf.SetDefaultType();
 154                 }
 155
 156                 if( SOT_FORMATSTR_ID_SVXB != nFmt )
 157                     nFmt = (bLoadError || GRAPHIC_BITMAP == aGrf.GetType())
 158                                 ? FORMAT_BITMAP
 159                                 : FORMAT_GDIMETAFILE;
 160
 161                 SvMemoryStream aMemStm( 0, 65535 );
 162                 switch ( nFmt )
 163                 {
 164                 case SOT_FORMATSTR_ID_SVXB:
 165                     if( GRAPHIC_NONE != aGrf.GetType() )
 166                     {
 167                         aMemStm.SetVersion( SOFFICE_FILEFORMAT_50 );
 168                         aMemStm << aGrf;
 169                     }
 170                     break;
 171
 172                 case  FORMAT_BITMAP:
 173                     if( !aGrf.GetBitmap().IsEmpty())
 174                         aMemStm << aGrf.GetBitmap();
 175                     break;
 176
 177                 default:
 178                     if( aGrf.GetGDIMetaFile().GetActionSize() )
 179                     {
 180                         GDIMetaFile aMeta( aGrf.GetGDIMetaFile() );
 181                         aMeta.Write( aMemStm );
 182                     }
 183                 }
 184                 rData <<= css::uno::Sequence< sal_Int8 >( (sal_Int8*) aMemStm.GetData(),
 185                                         aMemStm.Seek( STREAM_SEEK_TO_END ) );
 186
 187                 bNativFormat = bOldNativFormat;
 188
 189                 // Everything ready?
 190                 if( xMed.Is() && !bSynchron && bClearMedium )
 191                 {
 192                     xMed.Clear();
 193                     bClearMedium = sal_False;
 194                 }
 195             }
 196         }
 197         break;
 198     case FILETYPE_OBJECT:
 199         // TODO/LATER: possibility to insert a new object
 200         rData <<= OUString( sFileNm );
 201         break;
 202     }
 203     return sal_True/*0 != aTypeList.Count()*/;
 204 }
 205
 206 sal_Bool SvFileObject::Connect( sfx2::SvBaseLink* pLink )
 207 {
 208     if( !pLink || !pLink->GetLinkManager() )
 209         return sal_False;
 210
 211     // Test if not another link of the same connection already exists
 212     pLink->GetLinkManager()->GetDisplayNames( pLink, 0, &sFileNm, 0, &sFilter );
 213
 214     if( OBJECT_CLIENT_GRF == pLink->GetObjType() )
 215     {
 216         SfxObjectShellRef pShell = pLink->GetLinkManager()->GetPersist();
 217         if( pShell.Is() )
 218         {
 219             if( pShell->IsAbortingImport() )
 220                 return sal_False;
 221
 222             if( pShell->GetMedium() )
 223                 sReferer = pShell->GetMedium()->GetName();
 224         }
 225     }
 226
 227     switch( pLink->GetObjType() )
 228     {
 229     case OBJECT_CLIENT_GRF:
 230         nType = FILETYPE_GRF;
 231         bSynchron = pLink->IsSynchron();
 232         break;
 233
 234     case OBJECT_CLIENT_FILE:
 235         nType = FILETYPE_TEXT;
 236         break;
 237
 238     case OBJECT_CLIENT_OLE:
 239         nType = FILETYPE_OBJECT;
 240         // TODO/LATER: introduce own type to be used for exchanging
 241         break;
 242
 243     default:
 244         return sal_False;
 245     }
 246
 247     SetUpdateTimeout( 0 );
 248
 249     // and now register by this or other found Pseudo-Object
 250     AddDataAdvise( pLink, SotExchange::GetFormatMimeType( pLink->GetContentType()), 0 );
 251     return sal_True;
 252 }
 253
 254 sal_Bool SvFileObject::LoadFile_Impl()
 255 {
 256     // We are still at Loading!!
 257     if( bWaitForData || !bLoadAgain || xMed.Is() || pDownLoadData )
 258         return sal_False;
 259
 260     // at the moment on the current DocShell
 261     xMed = new SfxMedium( sFileNm, STREAM_STD_READ );
 262     SvLinkSource::StreamToLoadFrom aStreamToLoadFrom =
 263         getStreamToLoadFrom();
 264     xMed->setStreamToLoadFrom(
 265         aStreamToLoadFrom.m_xInputStreamToLoadFrom,
 266         aStreamToLoadFrom.m_bIsReadOnly);
 267
 268     if( !bSynchron )
 269     {
 270         bLoadAgain = bDataReady = bInNewData = sal_False;
 271         bWaitForData = sal_True;
 272
 273         SfxMediumRef xTmpMed = xMed;
 274         bInCallDownLoad = sal_True;
 275         xMed->DownLoad( STATIC_LINK( this, SvFileObject, LoadGrfReady_Impl ) );
 276         bInCallDownLoad = sal_False;
 277
 278         bClearMedium = !xMed.Is();
 279         if( bClearMedium )
 280             xMed = xTmpMed;  // If already finished in DownLoad
 281         return bDataReady;
 282     }
 283
 284     bWaitForData = sal_True;
 285     bDataReady = bInNewData = sal_False;
 286     xMed->DownLoad();
 287     bLoadAgain = !xMed->IsRemote();
 288     bWaitForData = sal_False;
 289
 290     // Graphic is finished, also send DataChanged of the Status change:
 291     SendStateChg_Impl( xMed->GetInStream() && xMed->GetInStream()->GetError()
 292                         ? sfx2::LinkManager::STATE_LOAD_ERROR : sfx2::LinkManager::STATE_LOAD_OK );
 293     return sal_True;
 294 }
 295
 296
 297 sal_Bool SvFileObject::GetGraphic_Impl( Graphic& rGrf, SvStream* pStream )
 298 {
 299     GraphicFilter& rGF = GraphicFilter::GetGraphicFilter();
 300
 301     const sal_uInt16 nFilter = sFilter.Len() && rGF.GetImportFormatCount()
 302                             ? rGF.GetImportFormatNumber( sFilter )
 303                             : GRFILTER_FORMAT_DONTKNOW;
 304
 305     String aEmptyStr;
 306     int nRes;
 307
 308     // To avoid that a native link is created
 309     if( ( !pStream || !pDownLoadData ) && !rGrf.IsLink() &&
 310         !rGrf.GetContext() && !bNativFormat )
 311         rGrf.SetLink( GfxLink() );
 312
 313     if( !pStream )
 314         nRes = xMed.Is() ? GRFILTER_OPENERROR
 315                          : rGF.ImportGraphic( rGrf, INetURLObject(sFileNm),
 316                             nFilter );
 317     else if( !pDownLoadData )
 318     {
 319         pStream->Seek( STREAM_SEEK_TO_BEGIN );
 320         nRes = rGF.ImportGraphic( rGrf, aEmptyStr, *pStream, nFilter );
 321     }
 322     else
 323     {
 324         nRes = rGF.ImportGraphic( pDownLoadData->aGrf, aEmptyStr,
 325                                     *pStream, nFilter );
 326
 327         if( pDownLoadData )
 328         {
 329             rGrf = pDownLoadData->aGrf;
 330             if( GRAPHIC_NONE == rGrf.GetType() )
 331                 rGrf.SetDefaultType();
 332
 333
 334             if( !pDownLoadData->aGrf.GetContext() )
 335             {
 336                 delete pDownLoadData, pDownLoadData = 0;
 337                 bDataReady = sal_True;
 338                 bWaitForData = sal_False;
 339             }
 340         }
 341     }
 342
 343     if( pStream && ERRCODE_IO_PENDING == pStream->GetError() )
 344         pStream->ResetError();
 345
 346 #ifdef DBG_UTIL
 347     if( nRes )
 348     {
 349         if( xMed.Is() && !pStream )
 350         {
 351             DBG_WARNING3( "Graphic error [%d] - [%s] URL[%s]",
 352                             nRes,
 353                             xMed->GetPhysicalName().getStr(),
 354                             sFileNm.GetBuffer() );
 355         }
 356         else
 357         {
 358             DBG_WARNING2( "Graphic error [%d] - [%s]",
 359                             nRes, sFileNm.GetBuffer() );
 360         }
 361     }
 362 #endif
 363
 364     return GRFILTER_OK == nRes;
 365 }
 366
 367 /** detect the filter of the given file
 368
 369     @param _rURL
 370         specifies the URL of the file which filter is to detected.<br/>
 371         If the URL doesn't denote a valid (existent and accessible) file, the
 372         request is silently dropped.
 373 */
 374 String impl_getFilter( const String& _rURL )
 375 {
 376     String sFilter;
 377     if ( _rURL.Len() == 0 )
 378         return sFilter;
 379
 380     try
 381     {
 382         css::uno::Reference< ::com::sun::star::document::XTypeDetection > xTypeDetection(
 383             ::comphelper::getProcessServiceFactory()->createInstance(
 384                 OUString("com.sun.star.document.TypeDetection") ),
 385                 css::uno::UNO_QUERY );
 386         if ( xTypeDetection.is() )
 387         {
 388             ::comphelper::MediaDescriptor aDescr;
 389             aDescr[ ::comphelper::MediaDescriptor::PROP_URL() ] <<= OUString( _rURL );
 390             css::uno::Sequence< css::beans::PropertyValue > aDescrList =
 391                 aDescr.getAsConstPropertyValueList();
 392             OUString sType = xTypeDetection->queryTypeByDescriptor( aDescrList, sal_True );
 393             if ( !sType.isEmpty() )
 394             {
 395                 // Honor a selected/detected filter.
 396                 for (sal_Int32 i=0; i < aDescrList.getLength(); ++i)
 397                 {
 398                     if (aDescrList[i].Name == "FilterName")
 399                     {
 400                         OUString aFilterName;
 401                         if (aDescrList[i].Value >>= aFilterName)
 402                         {
 403                             sFilter = aFilterName;
 404                             break;
 405                         }
 406                     }
 407                 }
 408                 if (!sFilter.Len())
 409                 {
 410                     css::uno::Reference< css::container::XNameAccess > xTypeCont( xTypeDetection,
 411                             css::uno::UNO_QUERY );
 412                     if ( xTypeCont.is() )
 413                     {
 414                         /* XXX: for fdo#69948 scenario the sequence returned by
 415                          * getByName() contains an empty PreferredFilter
 416                          * property value (since? expected?) */
 417                         ::comphelper::SequenceAsHashMap lTypeProps( xTypeCont->getByName( sType ) );
 418                         sFilter = lTypeProps.getUnpackedValueOrDefault(
 419                                 OUString("PreferredFilter"), OUString() );
 420                     }
 421                 }
 422             }
 423         }
 424     }
 425     catch( const css::uno::Exception& )
 426     {
 427     }
 428
 429     return sFilter;
 430 }
 431
 432 void SvFileObject::Edit( Window* pParent, sfx2::SvBaseLink* pLink, const Link& rEndEditHdl )
 433 {
 434     aEndEditLink = rEndEditHdl;
 435     String sFile, sRange, sTmpFilter;
 436     if( pLink && pLink->GetLinkManager() )
 437     {
 438         pLink->GetLinkManager()->GetDisplayNames( pLink, 0, &sFile, &sRange, &sTmpFilter );
 439
 440         switch( pLink->GetObjType() )
 441         {
 442             case OBJECT_CLIENT_GRF:
 443             {
 444                 nType = FILETYPE_GRF;       // If not set already
 445
 446                 SvxOpenGraphicDialog aDlg(SfxResId(RID_SVXSTR_EDITGRFLINK).toString());
 447                 aDlg.EnableLink(sal_False);
 448                 aDlg.SetPath( sFile, sal_True );
 449                 aDlg.SetCurrentFilter( sTmpFilter );
 450
 451                 if( !aDlg.Execute() )
 452                 {
 453                     sFile = aDlg.GetPath();
 454                     sFile += ::sfx2::cTokenSeparator;
 455                     sFile += ::sfx2::cTokenSeparator;
 456                     sFile += aDlg.GetCurrentFilter();
 457
 458                     if ( aEndEditLink.IsSet() )
 459                         aEndEditLink.Call( &sFile );
 460                 }
 461                 else
 462                     sFile.Erase();
 463             }
 464             break;
 465
 466             case OBJECT_CLIENT_OLE:
 467             {
 468                 nType = FILETYPE_OBJECT; // if not set already
 469                 pOldParent = Application::GetDefDialogParent();
 470                 Application::SetDefDialogParent( pParent );
 471
 472                 ::sfx2::FileDialogHelper & rFileDlg =
 473                     pLink->GetInsertFileDialog( String() );
 474                 rFileDlg.StartExecuteModal(
 475                         LINK( this, SvFileObject, DialogClosedHdl ) );
 476             }
 477             break;
 478
 479             case OBJECT_CLIENT_FILE:
 480             {
 481                 nType = FILETYPE_TEXT; // if not set already
 482                 pOldParent = Application::GetDefDialogParent();
 483                 Application::SetDefDialogParent( pParent );
 484
 485                 String sFactory;
 486                 SfxObjectShell* pShell = pLink->GetLinkManager()->GetPersist();
 487                 if ( pShell )
 488                     sFactory = pShell->GetFactory().GetFactoryName();
 489
 490                 ::sfx2::FileDialogHelper & rFileDlg =
 491                     pLink->GetInsertFileDialog(sFactory);
 492                 rFileDlg.StartExecuteModal(
 493                         LINK( this, SvFileObject, DialogClosedHdl ) );
 494             }
 495             break;
 496
 497             default:
 498                 sFile.Erase();
 499         }
 500     }
 501 }
 502
 503 IMPL_STATIC_LINK( SvFileObject, LoadGrfReady_Impl, void*, EMPTYARG )
 504 {
 505     // When we come form here there it can not be an error no more.
 506     pThis->bLoadError = sal_False;
 507     pThis->bWaitForData = sal_False;
 508     pThis->bInCallDownLoad = sal_False;
 509
 510     if( !pThis->bInNewData && !pThis->bDataReady )
 511     {
 512         // Graphic is finished, also send DataChanged from Status change
 513         pThis->bDataReady = sal_True;
 514         pThis->SendStateChg_Impl( sfx2::LinkManager::STATE_LOAD_OK );
 515
 516         // and then send the data again
 517         pThis->NotifyDataChanged();
 518     }
 519
 520     if( pThis->bDataReady )
 521     {
 522         pThis->bLoadAgain = sal_True;
 523         if( pThis->xMed.Is() )
 524         {
 525             pThis->xMed->SetDoneLink( Link() );
 526
 527             Application::PostUserEvent(
 528                         STATIC_LINK( pThis, SvFileObject, DelMedium_Impl ),
 529                         new SfxMediumRef( pThis->xMed ));
 530             pThis->xMed.Clear();
 531         }
 532         if( pThis->pDownLoadData )
 533             delete pThis->pDownLoadData, pThis->pDownLoadData = 0;
 534     }
 535
 536     return 0;
 537 }
 538
 539 IMPL_STATIC_LINK( SvFileObject, DelMedium_Impl, SfxMediumRef*, pDelMed )
 540 {
 541     (void)pThis;
 542     delete pDelMed;
 543     return 0;
 544 }
 545
 546 IMPL_LINK( SvFileObject, DialogClosedHdl, sfx2::FileDialogHelper*, _pFileDlg )
 547 {
 548     String sFile;
 549     Application::SetDefDialogParent( pOldParent );
 550
 551     if ( FILETYPE_TEXT == nType || FILETYPE_OBJECT == nType )
 552     {
 553         if ( _pFileDlg && _pFileDlg->GetError() == ERRCODE_NONE )
 554         {
 555             String sURL( _pFileDlg->GetPath() );
 556             sFile = sURL;
 557             sFile += ::sfx2::cTokenSeparator;
 558             sFile += ::sfx2::cTokenSeparator;
 559             sFile += impl_getFilter( sURL );
 560         }
 561     }
 562     else
 563     {
 564         SAL_WARN( "sfx2.appl", "SvFileObject::DialogClosedHdl(): wrong file type" );
 565     }
 566
 567     if ( aEndEditLink.IsSet() )
 568         aEndEditLink.Call( &sFile );
 569     return 0;
 570 }
 571
 572 /*  [Description]
 573
 574     The method determines whether the data-object can be read from a DDE.
 575
 576     The following can be returned:
 577         ERRCODE_NONE                    if it has been completely read
 578         ERRCODE_SO_PENDING              if it has not been completely read
 579         ERRCODE_SO_FALSE                otherwise
 580 */
 581 sal_Bool SvFileObject::IsPending() const
 582 {
 583     return FILETYPE_GRF == nType && !bLoadError &&
 584             ( pDownLoadData || bWaitForData );
 585 }
 586 sal_Bool SvFileObject::IsDataComplete() const
 587 {
 588     sal_Bool bRet = sal_False;
 589     if( FILETYPE_GRF != nType )
 590         bRet = sal_True;
 591     else if( !bLoadError && ( !bWaitForData && !pDownLoadData ))
 592     {
 593         SvFileObject* pThis = (SvFileObject*)this;
 594         if( bDataReady ||
 595             ( bSynchron && pThis->LoadFile_Impl() && xMed.Is() ) )
 596             bRet = sal_True;
 597         else
 598         {
 599             INetURLObject aUrl( sFileNm );
 600             if( aUrl.HasError() ||
 601                 INET_PROT_NOT_VALID == aUrl.GetProtocol() )
 602                 bRet = sal_True;
 603         }
 604     }
 605     return bRet;
 606 }
 607
 608
 609
 610 void SvFileObject::CancelTransfers()
 611 {
 612     // unsubscribe from the cache if in the middle of loading
 613     if( !bDataReady )
 614     {
 615         // Do not set-up again
 616         bLoadAgain = sal_False;
 617         bDataReady = bLoadError = bWaitForData = sal_True;
 618         SendStateChg_Impl( sfx2::LinkManager::STATE_LOAD_ABORT );
 619     }
 620 }
 621
 622
 623 void SvFileObject::SendStateChg_Impl( sfx2::LinkManager::LinkState nState )
 624 {
 625     if( !bStateChangeCalled && HasDataLinks() )
 626     {
 627         css::uno::Any aAny;
 628         aAny <<= OUString::valueOf( (sal_Int32)nState );
 629         DataChanged( SotExchange::GetFormatName(
 630                         sfx2::LinkManager::RegisterStatusInfoId()), aAny );
 631         bStateChangeCalled = sal_True;
 632     }
 633 }
 634
 635
 636 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */