sfx2/source/view/frmload.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 <sfx2/app.hxx>
  22 #include <sfx2/bindings.hxx>
  23 #include <sfx2/docfac.hxx>
  24 #include <sfx2/docfilt.hxx>
  25 #include <sfx2/doctempl.hxx>
  26 #include <sfx2/fcontnr.hxx>
  27 #include <sfx2/frame.hxx>
  28 #include <sfx2/objsh.hxx>
  29 #include <sfx2/request.hxx>
  30 #include <sfx2/sfxsids.hrc>
  31 #include <sfx2/viewfac.hxx>
  32
  33 #include <com/sun/star/container/XContainerQuery.hpp>
  34 #include <com/sun/star/document/XTypeDetection.hpp>
  35 #include <com/sun/star/frame/XFrame.hpp>
  36 #include <com/sun/star/frame/XLoadable.hpp>
  37 #include <com/sun/star/task/XInteractionHandler.hpp>
  38 #include <com/sun/star/task/XInteractionHandler2.hpp>
  39 #include <com/sun/star/document/XViewDataSupplier.hpp>
  40 #include <com/sun/star/container/XIndexAccess.hpp>
  41 #include <com/sun/star/frame/XSynchronousFrameLoader.hpp>
  42 #include <com/sun/star/frame/XController2.hpp>
  43 #include <com/sun/star/frame/XModel2.hpp>
  44 #include <com/sun/star/lang/XServiceInfo.hpp>
  45 #include <com/sun/star/lang/XInitialization.hpp>
  46 #include <com/sun/star/uno/XComponentContext.hpp>
  47 #include <com/sun/star/util/XCloseable.hpp>
  48
  49 #include <comphelper/interaction.hxx>
  50 #include <comphelper/namedvaluecollection.hxx>
  51 #include <cppuhelper/exc_hlp.hxx>
  52 #include <cppuhelper/implbase.hxx>
  53 #include <cppuhelper/supportsservice.hxx>
  54 #include <framework/interaction.hxx>
  55 #include <rtl/ref.hxx>
  56 #include <sal/log.hxx>
  57 #include <svl/eitem.hxx>
  58 #include <unotools/moduleoptions.hxx>
  59 #include <tools/diagnose_ex.h>
  60 #include <vcl/svapp.hxx>
  61
  62 using namespace com::sun::star;
  63 using ::com::sun::star::beans::PropertyValue;
  64 using ::com::sun::star::container::XContainerQuery;
  65 using ::com::sun::star::container::XEnumeration;
  66 using ::com::sun::star::document::XTypeDetection;
  67 using ::com::sun::star::frame::XFrame;
  68 using ::com::sun::star::frame::XLoadable;
  69 using ::com::sun::star::task::XInteractionHandler;
  70 using ::com::sun::star::task::XInteractionHandler2;
  71 using ::com::sun::star::uno::Any;
  72 using ::com::sun::star::uno::Exception;
  73 using ::com::sun::star::uno::Reference;
  74 using ::com::sun::star::uno::RuntimeException;
  75 using ::com::sun::star::uno::Sequence;
  76 using ::com::sun::star::uno::UNO_QUERY;
  77 using ::com::sun::star::uno::UNO_QUERY_THROW;
  78 using ::com::sun::star::uno::UNO_SET_THROW;
  79 using ::com::sun::star::util::XCloseable;
  80 using ::com::sun::star::document::XViewDataSupplier;
  81 using ::com::sun::star::container::XIndexAccess;
  82 using ::com::sun::star::frame::XController2;
  83 using ::com::sun::star::frame::XModel2;
  84
  85 namespace {
  86
  87 class SfxFrameLoader_Impl : public ::cppu::WeakImplHelper< css::frame::XSynchronousFrameLoader, css::lang::XServiceInfo >
  88 {
  89     css::uno::Reference < css::uno::XComponentContext >  m_aContext;
  90
  91 public:
  92     explicit SfxFrameLoader_Impl( const css::uno::Reference < css::uno::XComponentContext >& _rxContext );
  93
  94     virtual OUString SAL_CALL getImplementationName() override;
  95
  96     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
  97
  98     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
  99
 100
 101     // XSynchronousFrameLoader
 102
 103     virtual sal_Bool SAL_CALL load( const css::uno::Sequence< css::beans::PropertyValue >& _rArgs, const css::uno::Reference< css::frame::XFrame >& _rxFrame ) override;
 104     virtual void SAL_CALL cancel() override;
 105
 106 protected:
 107     virtual                 ~SfxFrameLoader_Impl() override;
 108
 109 private:
 110     std::shared_ptr<const SfxFilter>    impl_getFilterFromServiceName_nothrow(
 111                             const OUString& i_rServiceName
 112                         ) const;
 113
 114     static OUString     impl_askForFilter_nothrow(
 115                             const css::uno::Reference< css::task::XInteractionHandler >& i_rxHandler,
 116                             const OUString& i_rDocumentURL
 117                         );
 118
 119     std::shared_ptr<const SfxFilter>    impl_detectFilterForURL(
 120                             const OUString& _rURL,
 121                             const ::comphelper::NamedValueCollection& i_rDescriptor,
 122                             const SfxFilterMatcher& rMatcher
 123                         ) const;
 124
 125     static bool         impl_createNewDocWithSlotParam(
 126                             const sal_uInt16 _nSlotID,
 127                             const css::uno::Reference< css::frame::XFrame >& i_rxFrame,
 128                             const bool i_bHidden
 129                         );
 130
 131     void                impl_determineFilter(
 132                                   ::comphelper::NamedValueCollection& io_rDescriptor
 133                         ) const;
 134
 135     bool                impl_determineTemplateDocument(
 136                             ::comphelper::NamedValueCollection& io_rDescriptor
 137                         ) const;
 138
 139     static sal_uInt16   impl_findSlotParam(
 140                             const OUString& i_rFactoryURL
 141                         );
 142
 143     static SfxObjectShellRef   impl_findObjectShell(
 144                             const css::uno::Reference< css::frame::XModel2 >& i_rxDocument
 145                         );
 146
 147     static void         impl_handleCaughtError_nothrow(
 148                             const css::uno::Any& i_rCaughtError,
 149                             const ::comphelper::NamedValueCollection& i_rDescriptor
 150                         );
 151
 152     static void         impl_removeLoaderArguments(
 153                             ::comphelper::NamedValueCollection& io_rDescriptor
 154                         );
 155
 156     static SfxInterfaceId impl_determineEffectiveViewId_nothrow(
 157                             const SfxObjectShell& i_rDocument,
 158                             const ::comphelper::NamedValueCollection& i_rDescriptor
 159                         );
 160
 161     static ::comphelper::NamedValueCollection
 162                         impl_extractViewCreationArgs(
 163                                   ::comphelper::NamedValueCollection& io_rDescriptor
 164                         );
 165
 166     static css::uno::Reference< css::frame::XController2 >
 167                         impl_createDocumentView(
 168                             const css::uno::Reference< css::frame::XModel2 >& i_rModel,
 169                             const css::uno::Reference< css::frame::XFrame >& i_rFrame,
 170                             const ::comphelper::NamedValueCollection& i_rViewFactoryArgs,
 171                             const OUString& i_rViewName
 172                         );
 173 };
 174
 175 SfxFrameLoader_Impl::SfxFrameLoader_Impl( const Reference< css::uno::XComponentContext >& _rxContext )
 176     :m_aContext( _rxContext )
 177 {
 178 }
 179
 180 SfxFrameLoader_Impl::~SfxFrameLoader_Impl()
 181 {
 182 }
 183
 184
 185 std::shared_ptr<const SfxFilter> SfxFrameLoader_Impl::impl_detectFilterForURL( const OUString& sURL,
 186         const ::comphelper::NamedValueCollection& i_rDescriptor, const SfxFilterMatcher& rMatcher ) const
 187 {
 188     OUString sFilter;
 189     try
 190     {
 191         if ( sURL.isEmpty() )
 192             return nullptr;
 193
 194         Reference< XTypeDetection > xDetect(
 195             m_aContext->getServiceManager()->createInstanceWithContext("com.sun.star.document.TypeDetection", m_aContext),
 196             UNO_QUERY_THROW);
 197
 198         ::comphelper::NamedValueCollection aNewArgs;
 199         aNewArgs.put( "URL", sURL );
 200
 201         if ( i_rDescriptor.has( "InteractionHandler" ) )
 202             aNewArgs.put( "InteractionHandler", i_rDescriptor.get( "InteractionHandler" ) );
 203         if ( i_rDescriptor.has( "StatusIndicator" ) )
 204             aNewArgs.put( "StatusIndicator", i_rDescriptor.get( "StatusIndicator" ) );
 205
 206         Sequence< PropertyValue > aQueryArgs( aNewArgs.getPropertyValues() );
 207         OUString sType = xDetect->queryTypeByDescriptor( aQueryArgs, true );
 208         if ( !sType.isEmpty() )
 209         {
 210             std::shared_ptr<const SfxFilter> pFilter = rMatcher.GetFilter4EA( sType );
 211             if ( pFilter )
 212                 sFilter = pFilter->GetName();
 213         }
 214     }
 215     catch ( const RuntimeException& )
 216     {
 217         throw;
 218     }
 219     catch( const Exception& )
 220     {
 221         DBG_UNHANDLED_EXCEPTION("sfx.view");
 222         sFilter.clear();
 223     }
 224
 225     std::shared_ptr<const SfxFilter> pFilter;
 226     if (!sFilter.isEmpty())
 227         pFilter = rMatcher.GetFilter4FilterName(sFilter);
 228     return pFilter;
 229 }
 230
 231
 232 std::shared_ptr<const SfxFilter> SfxFrameLoader_Impl::impl_getFilterFromServiceName_nothrow( const OUString& i_rServiceName ) const
 233 {
 234     try
 235     {
 236         ::comphelper::NamedValueCollection aQuery;
 237         aQuery.put( "DocumentService", i_rServiceName );
 238
 239         const Reference< XContainerQuery > xQuery(
 240             m_aContext->getServiceManager()->createInstanceWithContext("com.sun.star.document.FilterFactory", m_aContext),
 241             UNO_QUERY_THROW );
 242
 243         const SfxFilterMatcher& rMatcher = SfxGetpApp()->GetFilterMatcher();
 244         const SfxFilterFlags nMust = SfxFilterFlags::IMPORT;
 245         const SfxFilterFlags nDont = SFX_FILTER_NOTINSTALLED;
 246
 247         Reference < XEnumeration > xEnum( xQuery->createSubSetEnumerationByProperties(
 248             aQuery.getNamedValues() ), UNO_SET_THROW );
 249         while ( xEnum->hasMoreElements() )
 250         {
 251             ::comphelper::NamedValueCollection aType( xEnum->nextElement() );
 252             OUString sFilterName = aType.getOrDefault( "Name", OUString() );
 253             if ( sFilterName.isEmpty() )
 254                 continue;
 255
 256             std::shared_ptr<const SfxFilter> pFilter = rMatcher.GetFilter4FilterName( sFilterName );
 257             if ( !pFilter )
 258                 continue;
 259
 260             SfxFilterFlags nFlags = pFilter->GetFilterFlags();
 261             if  (   ( ( nFlags & nMust ) == nMust )
 262                 &&  ( ( nFlags & nDont ) == SfxFilterFlags::NONE )
 263                 )
 264             {
 265                 return pFilter;
 266             }
 267         }
 268     }
 269     catch( const Exception& )
 270     {
 271         DBG_UNHANDLED_EXCEPTION("sfx.view");
 272     }
 273     return nullptr;
 274 }
 275
 276
 277 OUString SfxFrameLoader_Impl::impl_askForFilter_nothrow( const Reference< XInteractionHandler >& i_rxHandler,
 278                                                                  const OUString& i_rDocumentURL )
 279 {
 280     ENSURE_OR_THROW( i_rxHandler.is(), "invalid interaction handler" );
 281
 282     OUString sFilterName;
 283     try
 284     {
 285         ::framework::RequestFilterSelect aRequest( i_rDocumentURL );
 286         i_rxHandler->handle( aRequest.GetRequest() );
 287         if( !aRequest.isAbort() )
 288             sFilterName = aRequest.getFilter();
 289     }
 290     catch( const Exception& )
 291     {
 292         DBG_UNHANDLED_EXCEPTION("sfx.view");
 293     }
 294
 295     return sFilterName;
 296 }
 297
 298 bool lcl_getDispatchResult( const SfxPoolItem* _pResult )
 299 {
 300     if ( !_pResult )
 301         return false;
 302
 303     // default must be set to true, because some return values
 304     // can't be checked, but nonetheless indicate "success"!
 305     bool bSuccess = true;
 306
 307     // On the other side some special slots return a boolean state,
 308     // which can be set to FALSE.
 309     const SfxBoolItem *pItem = dynamic_cast<const SfxBoolItem*>( _pResult  );
 310     if ( pItem )
 311         bSuccess = pItem->GetValue();
 312
 313     return bSuccess;
 314 }
 315
 316 bool SfxFrameLoader_Impl::impl_createNewDocWithSlotParam( const sal_uInt16 _nSlotID, const Reference< XFrame >& i_rxFrame,
 317                                                               const bool i_bHidden )
 318 {
 319     SfxRequest aRequest( _nSlotID, SfxCallMode::SYNCHRON, SfxGetpApp()->GetPool() );
 320     aRequest.AppendItem( SfxUnoFrameItem( SID_FILLFRAME, i_rxFrame ) );
 321     if ( i_bHidden )
 322         aRequest.AppendItem( SfxBoolItem( SID_HIDDEN, true ) );
 323     return lcl_getDispatchResult( SfxGetpApp()->ExecuteSlot( aRequest ) );
 324 }
 325
 326
 327 void SfxFrameLoader_Impl::impl_determineFilter( ::comphelper::NamedValueCollection& io_rDescriptor ) const
 328 {
 329     const OUString     sURL         = io_rDescriptor.getOrDefault( "URL",                OUString() );
 330     const OUString     sTypeName    = io_rDescriptor.getOrDefault( "TypeName",           OUString() );
 331     const OUString     sFilterName  = io_rDescriptor.getOrDefault( "FilterName",         OUString() );
 332     const OUString     sServiceName = io_rDescriptor.getOrDefault( "DocumentService",    OUString() );
 333     const Reference< XInteractionHandler >
 334                               xInteraction = io_rDescriptor.getOrDefault( "InteractionHandler", Reference< XInteractionHandler >() );
 335
 336     const SfxFilterMatcher& rMatcher = SfxGetpApp()->GetFilterMatcher();
 337     std::shared_ptr<const SfxFilter> pFilter;
 338
 339     // get filter by its name directly ...
 340     if ( !sFilterName.isEmpty() )
 341         pFilter = rMatcher.GetFilter4FilterName( sFilterName );
 342
 343     // or search the preferred filter for the detected type ...
 344     if ( !pFilter && !sTypeName.isEmpty() )
 345         pFilter = rMatcher.GetFilter4EA( sTypeName );
 346
 347     // or use given document service for detection, too
 348     if ( !pFilter && !sServiceName.isEmpty() )
 349         pFilter = impl_getFilterFromServiceName_nothrow( sServiceName );
 350
 351     // or use interaction to ask user for right filter.
 352     if ( !pFilter && xInteraction.is() && !sURL.isEmpty() )
 353     {
 354         OUString sSelectedFilter = impl_askForFilter_nothrow( xInteraction, sURL );
 355         if ( !sSelectedFilter.isEmpty() )
 356             pFilter = rMatcher.GetFilter4FilterName( sSelectedFilter );
 357     }
 358
 359     if ( !pFilter )
 360         return;
 361
 362     io_rDescriptor.put( "FilterName", pFilter->GetFilterName() );
 363
 364     // If detected filter indicates using of an own template format
 365     // add property "AsTemplate" to descriptor. But suppress this step
 366     // if such property already exists.
 367     if ( pFilter->IsOwnTemplateFormat() && !io_rDescriptor.has( "AsTemplate" ) )
 368         io_rDescriptor.put( "AsTemplate", true );
 369
 370     // The DocumentService property will finally be used to determine the document type to create, so
 371     // override it with the service name as indicated by the found filter.
 372     io_rDescriptor.put( "DocumentService", pFilter->GetServiceName() );
 373 }
 374
 375
 376 SfxObjectShellRef SfxFrameLoader_Impl::impl_findObjectShell( const Reference< XModel2 >& i_rxDocument )
 377 {
 378     for ( SfxObjectShell* pDoc = SfxObjectShell::GetFirst( nullptr, false ); pDoc;
 379                                     pDoc = SfxObjectShell::GetNext( *pDoc, nullptr, false ) )
 380     {
 381         if ( i_rxDocument == pDoc->GetModel() )
 382         {
 383             return pDoc;
 384         }
 385     }
 386
 387     SAL_WARN( "sfx.view", "SfxFrameLoader_Impl::impl_findObjectShell: model is not based on SfxObjectShell - wrong frame loader usage!" );
 388     return nullptr;
 389 }
 390
 391
 392 bool SfxFrameLoader_Impl::impl_determineTemplateDocument( ::comphelper::NamedValueCollection& io_rDescriptor ) const
 393 {
 394     try
 395     {
 396         const OUString sTemplateRegioName = io_rDescriptor.getOrDefault( "TemplateRegionName", OUString() );
 397         const OUString sTemplateName      = io_rDescriptor.getOrDefault( "TemplateName",       OUString() );
 398         const OUString sServiceName       = io_rDescriptor.getOrDefault( "DocumentService",    OUString() );
 399         const OUString sURL               = io_rDescriptor.getOrDefault( "URL",                OUString() );
 400
 401         // determine the full URL of the template to use, if any
 402         OUString sTemplateURL;
 403         if ( !sTemplateRegioName.isEmpty() && !sTemplateName.isEmpty() )
 404         {
 405             SfxDocumentTemplates aTmpFac;
 406             aTmpFac.GetFull( sTemplateRegioName, sTemplateName, sTemplateURL );
 407         }
 408         else
 409         {
 410             if ( !sServiceName.isEmpty() )
 411                 sTemplateURL = SfxObjectFactory::GetStandardTemplate( sServiceName );
 412             else
 413                 sTemplateURL = SfxObjectFactory::GetStandardTemplate( SfxObjectShell::GetServiceNameFromFactory( sURL ) );
 414         }
 415
 416         if ( !sTemplateURL.isEmpty() )
 417         {
 418             // detect the filter for the template. Might still be NULL (if the template is broken, or does not
 419             // exist, or some such), but this is handled by our caller the same way as if no template/URL was present.
 420             std::shared_ptr<const SfxFilter> pTemplateFilter = impl_detectFilterForURL( sTemplateURL, io_rDescriptor, SfxGetpApp()->GetFilterMatcher() );
 421             if ( pTemplateFilter )
 422             {
 423                 // load the template document, but, well, "as template"
 424                 io_rDescriptor.put( "FilterName", pTemplateFilter->GetName() );
 425                 io_rDescriptor.put( "FileName", sTemplateURL );
 426                 io_rDescriptor.put( "AsTemplate", true );
 427
 428                 // #i21583#
 429                 // the DocumentService property will finally be used to create the document. Thus, override any possibly
 430                 // present value with the document service of the template.
 431                 io_rDescriptor.put( "DocumentService", pTemplateFilter->GetServiceName() );
 432                 return true;
 433             }
 434         }
 435     }
 436     catch (...)
 437     {
 438     }
 439     return false;
 440 }
 441
 442
 443 sal_uInt16 SfxFrameLoader_Impl::impl_findSlotParam( const OUString& i_rFactoryURL )
 444 {
 445     OUString sSlotParam;
 446     const sal_Int32 nParamPos = i_rFactoryURL.indexOf( '?' );
 447     if ( nParamPos >= 0 )
 448     {
 449         // currently only the "slot" parameter is supported
 450         const sal_Int32 nSlotPos = i_rFactoryURL.indexOf( "slot=", nParamPos );
 451         if ( nSlotPos > 0 )
 452             sSlotParam = i_rFactoryURL.copy( nSlotPos + 5 );
 453     }
 454
 455     if ( !sSlotParam.isEmpty() )
 456         return sal_uInt16( sSlotParam.toInt32() );
 457
 458     return 0;
 459 }
 460
 461
 462 void SfxFrameLoader_Impl::impl_handleCaughtError_nothrow( const Any& i_rCaughtError, const ::comphelper::NamedValueCollection& i_rDescriptor )
 463 {
 464     try
 465     {
 466         const Reference< XInteractionHandler > xInteraction =
 467             i_rDescriptor.getOrDefault( "InteractionHandler", Reference< XInteractionHandler >() );
 468         if ( !xInteraction.is() )
 469             return;
 470         ::rtl::Reference< ::comphelper::OInteractionRequest > pRequest( new ::comphelper::OInteractionRequest( i_rCaughtError ) );
 471         ::rtl::Reference< ::comphelper::OInteractionApprove > pApprove( new ::comphelper::OInteractionApprove );
 472         pRequest->addContinuation( pApprove );
 473
 474         const Reference< XInteractionHandler2 > xHandler( xInteraction, UNO_QUERY );
 475     #if OSL_DEBUG_LEVEL > 0
 476         const bool bHandled =
 477     #endif
 478         xHandler.is() && xHandler->handleInteractionRequest( pRequest );
 479
 480     #if OSL_DEBUG_LEVEL > 0
 481         if ( !bHandled )
 482             // the interaction handler couldn't deal with this error
 483             // => report it as assertion, at least (done in the DBG_UNHANDLED_EXCEPTION below)
 484             ::cppu::throwException( i_rCaughtError );
 485     #endif
 486     }
 487     catch( const Exception& )
 488     {
 489         DBG_UNHANDLED_EXCEPTION("sfx.view");
 490     }
 491 }
 492
 493
 494 void SfxFrameLoader_Impl::impl_removeLoaderArguments( ::comphelper::NamedValueCollection& io_rDescriptor )
 495 {
 496     // remove the arguments which are for the loader only, and not for a call to attachResource
 497     io_rDescriptor.remove( "StatusIndicator" );
 498     io_rDescriptor.remove( "Model" );
 499 }
 500
 501
 502 ::comphelper::NamedValueCollection SfxFrameLoader_Impl::impl_extractViewCreationArgs( ::comphelper::NamedValueCollection& io_rDescriptor )
 503 {
 504     static const std::u16string_view sKnownViewArgs[] = { u"JumpMark", u"PickListEntry" };
 505
 506     ::comphelper::NamedValueCollection aViewArgs;
 507     for (const auto& rKnownViewArg : sKnownViewArgs)
 508     {
 509         const OUString sKnownViewArg(rKnownViewArg);
 510         if ( io_rDescriptor.has( sKnownViewArg ) )
 511         {
 512             aViewArgs.put( sKnownViewArg, io_rDescriptor.get( sKnownViewArg ) );
 513             io_rDescriptor.remove( sKnownViewArg );
 514         }
 515     }
 516     return aViewArgs;
 517 }
 518
 519
 520 SfxInterfaceId SfxFrameLoader_Impl::impl_determineEffectiveViewId_nothrow( const SfxObjectShell& i_rDocument, const ::comphelper::NamedValueCollection& i_rDescriptor )
 521 {
 522     SfxInterfaceId nViewId(i_rDescriptor.getOrDefault( "ViewId", sal_Int16( 0 ) ));
 523     try
 524     {
 525         if ( nViewId == SFX_INTERFACE_NONE )
 526             do
 527             {
 528                 Reference< XViewDataSupplier > xViewDataSupplier( i_rDocument.GetModel(), UNO_QUERY );
 529                 Reference< XIndexAccess > xViewData;
 530                 if ( xViewDataSupplier.is() )
 531                     xViewData.set( xViewDataSupplier->getViewData() );
 532
 533                 if ( !xViewData.is() || ( xViewData->getCount() == 0 ) )
 534                     // no view data stored together with the model
 535                     break;
 536
 537                 // obtain the ViewID from the view data
 538                 Sequence< PropertyValue > aViewData;
 539                 if ( !( xViewData->getByIndex( 0 ) >>= aViewData ) )
 540                     break;
 541
 542                 ::comphelper::NamedValueCollection aNamedViewData( aViewData );
 543                 OUString sViewId = aNamedViewData.getOrDefault( "ViewId", OUString() );
 544                 if ( sViewId.isEmpty() )
 545                     break;
 546
 547                 // somewhat weird convention here ... in the view data, the ViewId is a string, effectively describing
 548                 // a view name. In the document load descriptor, the ViewId is in fact the numeric ID.
 549
 550                 SfxViewFactory* pViewFactory = i_rDocument.GetFactory().GetViewFactoryByViewName( sViewId );
 551                 if ( pViewFactory )
 552                     nViewId = pViewFactory->GetOrdinal();
 553             }
 554             while ( false );
 555     }
 556     catch( const Exception& )
 557     {
 558         DBG_UNHANDLED_EXCEPTION("sfx.view");
 559     }
 560
 561     if ( nViewId == SFX_INTERFACE_NONE )
 562         nViewId = i_rDocument.GetFactory().GetViewFactory().GetOrdinal();
 563     return nViewId;
 564 }
 565
 566
 567 Reference< XController2 > SfxFrameLoader_Impl::impl_createDocumentView( const Reference< XModel2 >& i_rModel,
 568         const Reference< XFrame >& i_rFrame, const ::comphelper::NamedValueCollection& i_rViewFactoryArgs,
 569         const OUString& i_rViewName )
 570 {
 571     // let the model create a new controller
 572     const Reference< XController2 > xController( i_rModel->createViewController(
 573         i_rViewName,
 574         i_rViewFactoryArgs.getPropertyValues(),
 575         i_rFrame
 576     ), UNO_SET_THROW );
 577
 578     // introduce model/view/controller to each other
 579     xController->attachModel( i_rModel );
 580     i_rModel->connectController( xController );
 581     i_rFrame->setComponent( xController->getComponentWindow(), xController );
 582     xController->attachFrame( i_rFrame );
 583     i_rModel->setCurrentController( xController );
 584
 585     return xController;
 586 }
 587
 588
 589 sal_Bool SAL_CALL SfxFrameLoader_Impl::load( const Sequence< PropertyValue >& rArgs,
 590                                              const Reference< XFrame >& _rTargetFrame )
 591 {
 592     ENSURE_OR_THROW( _rTargetFrame.is(), "illegal NULL frame" );
 593
 594     SolarMutexGuard aGuard;
 595
 596     SAL_INFO( "sfx.view", "SfxFrameLoader::load" );
 597
 598     ::comphelper::NamedValueCollection aDescriptor( rArgs );
 599
 600     // ensure the descriptor contains a referrer
 601     if ( !aDescriptor.has( "Referer" ) )
 602         aDescriptor.put( "Referer", OUString() );
 603
 604     // did the caller already pass a model?
 605     Reference< XModel2 > xModel = aDescriptor.getOrDefault( "Model", Reference< XModel2 >() );
 606     const bool bExternalModel = xModel.is();
 607
 608     // check for factory URLs to create a new doc, instead of loading one
 609     const OUString sURL = aDescriptor.getOrDefault( "URL", OUString() );
 610     const bool bIsFactoryURL = sURL.startsWith( "private:factory/" );
 611     bool bInitNewModel = bIsFactoryURL;
 612     const bool bIsDefault = bIsFactoryURL && !bExternalModel;
 613     if (!aDescriptor.has("Replaceable"))
 614         aDescriptor.put("Replaceable", bIsDefault);
 615     if (bIsDefault)
 616     {
 617         const OUString sFactory = sURL.copy( sizeof( "private:factory/" ) -1 );
 618         // special handling for some weird factory URLs a la private:factory/swriter?slot=21053
 619         const sal_uInt16 nSlotParam = impl_findSlotParam( sFactory );
 620         if ( nSlotParam != 0 )
 621         {
 622             return impl_createNewDocWithSlotParam( nSlotParam, _rTargetFrame, aDescriptor.getOrDefault( "Hidden", false ) );
 623         }
 624
 625         const bool bDescribesValidTemplate = impl_determineTemplateDocument( aDescriptor );
 626         if ( bDescribesValidTemplate )
 627         {
 628             // if the media descriptor allowed us to determine a template document to create the new document
 629             // from, then do not init a new document model from scratch (below), but instead load the
 630             // template document
 631             bInitNewModel = false;
 632         }
 633         else
 634         {
 635             const OUString sServiceName = SfxObjectShell::GetServiceNameFromFactory( sFactory );
 636             aDescriptor.put( "DocumentService", sServiceName );
 637         }
 638     }
 639     else
 640     {
 641         // compatibility
 642         aDescriptor.put( "FileName", aDescriptor.get( "URL" ) );
 643     }
 644
 645     bool bLoadSuccess = false;
 646     try
 647     {
 648         // extract view relevant arguments from the loader args
 649         ::comphelper::NamedValueCollection aViewCreationArgs( impl_extractViewCreationArgs( aDescriptor ) );
 650
 651         // no model passed from outside? => create one from scratch
 652         if ( !bExternalModel )
 653         {
 654             bool bInternalFilter = aDescriptor.getOrDefault<OUString>("FilterProvider", OUString()).isEmpty();
 655
 656             if (bInternalFilter && !bInitNewModel)
 657             {
 658                 // Ensure that the current SfxFilter instance is loaded before
 659                 // going further.  We don't need to do this for external
 660                 // filter providers.
 661                 impl_determineFilter(aDescriptor);
 662             }
 663
 664             // create the new doc
 665             const OUString sServiceName = aDescriptor.getOrDefault( "DocumentService", OUString() );
 666             xModel.set( m_aContext->getServiceManager()->createInstanceWithContext(sServiceName, m_aContext), UNO_QUERY_THROW );
 667
 668             // load resp. init it
 669             const Reference< XLoadable > xLoadable( xModel, UNO_QUERY_THROW );
 670             if ( bInitNewModel )
 671             {
 672                 xLoadable->initNew();
 673
 674                 impl_removeLoaderArguments( aDescriptor );
 675                 xModel->attachResource( OUString(), aDescriptor.getPropertyValues() );
 676             }
 677             else
 678             {
 679                 xLoadable->load( aDescriptor.getPropertyValues() );
 680             }
 681         }
 682         else
 683         {
 684             // tell the doc its (current) load args.
 685             impl_removeLoaderArguments( aDescriptor );
 686             xModel->attachResource( xModel->getURL(), aDescriptor.getPropertyValues() );
 687         }
 688
 689         // get the SfxObjectShell (still needed at the moment)
 690         // SfxObjectShellRef is used here ( instead of ...Lock ) since the model is closed below if necessary
 691         // SfxObjectShellLock would be even dangerous here, since the lifetime control should be done outside in case of success
 692         const SfxObjectShellRef xDoc = impl_findObjectShell( xModel );
 693         ENSURE_OR_THROW( xDoc.is(), "no SfxObjectShell for the given model" );
 694
 695         // ensure the ID of the to-be-created view is in the descriptor, if possible
 696         const SfxInterfaceId nViewId = impl_determineEffectiveViewId_nothrow( *xDoc, aDescriptor );
 697         const sal_Int16 nViewNo = xDoc->GetFactory().GetViewNo_Impl( nViewId, 0 );
 698         const OUString sViewName( xDoc->GetFactory().GetViewFactory( nViewNo ).GetAPIViewName() );
 699
 700         // plug the document into the frame
 701         Reference<XController2> xController =
 702             impl_createDocumentView( xModel, _rTargetFrame, aViewCreationArgs, sViewName );
 703
 704         Reference<lang::XInitialization> xInit(xController, UNO_QUERY);
 705         if (xInit.is())
 706         {
 707             uno::Sequence<uno::Any> aArgs; // empty for now.
 708             xInit->initialize(aArgs);
 709         }
 710
 711         bLoadSuccess = true;
 712     }
 713     catch ( Exception& )
 714     {
 715         const Any aError( ::cppu::getCaughtException() );
 716         if ( !aDescriptor.getOrDefault( "Silent", false ) )
 717             impl_handleCaughtError_nothrow( aError, aDescriptor );
 718     }
 719
 720     // if loading was not successful, close the document
 721     if ( !bLoadSuccess && !bExternalModel )
 722     {
 723         try
 724         {
 725             const Reference< XCloseable > xCloseable( xModel, UNO_QUERY_THROW );
 726             xCloseable->close( true );
 727         }
 728         catch ( Exception& )
 729         {
 730             DBG_UNHANDLED_EXCEPTION("sfx.view");
 731         }
 732     }
 733
 734     return bLoadSuccess;
 735 }
 736
 737 void SfxFrameLoader_Impl::cancel()
 738 {
 739 }
 740
 741 /* XServiceInfo */
 742 OUString SAL_CALL SfxFrameLoader_Impl::getImplementationName()
 743 {
 744     return "com.sun.star.comp.office.FrameLoader";
 745 }
 746
 747 /* XServiceInfo */
 748 sal_Bool SAL_CALL SfxFrameLoader_Impl::supportsService( const OUString& sServiceName )
 749 {
 750     return cppu::supportsService(this, sServiceName);
 751 }
 752
 753 /* XServiceInfo */
 754 Sequence< OUString > SAL_CALL SfxFrameLoader_Impl::getSupportedServiceNames()
 755 {
 756     return { "com.sun.star.frame.SynchronousFrameLoader", "com.sun.star.frame.OfficeFrameLoader" };
 757 }
 758
 759 }
 760
 761 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 762 com_sun_star_comp_office_FrameLoader_get_implementation(
 763     css::uno::XComponentContext *context,
 764     css::uno::Sequence<css::uno::Any> const &)
 765 {
 766     return cppu::acquire(new SfxFrameLoader_Impl(context));
 767 }
 768
 769 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */