sfx2/source/doc/docfac.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 <com/sun/star/container/XNameAccess.hpp>
  21 #include <com/sun/star/ucb/SimpleFileAccess.hpp>
  22 #include <com/sun/star/document/XTypeDetection.hpp>
  23 #include <com/sun/star/frame/ModuleManager.hpp>
  24 #include <com/sun/star/frame/XLoadable.hpp>
  25 #include <com/sun/star/frame/XStorable.hpp>
  26 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  27 #include <comphelper/processfactory.hxx>
  28 #include <unotools/moduleoptions.hxx>
  29 #include <comphelper/sequenceashashmap.hxx>
  30 #include <comphelper/configurationhelper.hxx>
  31
  32 #include <sfx2/docfilt.hxx>
  33 #include <sfx2/docfac.hxx>
  34 #include <sfx2/viewfac.hxx>
  35 #include <sfx2/fcontnr.hxx>
  36 #include <sfx2/module.hxx>
  37 #include "syspath.hxx"
  38 #include <osl/file.hxx>
  39 #include <osl/security.hxx>
  40
  41 #include <sal/log.hxx>
  42 #include <tools/debug.hxx>
  43 #include <tools/globname.hxx>
  44
  45 #include <memory>
  46
  47 using namespace ::com::sun::star;
  48
  49
  50 struct SfxObjectFactory_Impl
  51 {
  52     std::vector<SfxViewFactory*> aViewFactoryArr;// List of <SfxViewFactory>s
  53     OUString                     aServiceName;
  54     SfxFilterContainer*          pFilterContainer;
  55     SfxModule*                   pModule;
  56     SvGlobalName                 aClassName;
  57
  58     SfxObjectFactory_Impl() :
  59         pFilterContainer    ( nullptr ),
  60         pModule             ( nullptr )
  61         {}
  62 };
  63
  64 SfxFilterContainer* SfxObjectFactory::GetFilterContainer() const
  65 {
  66     return pImpl->pFilterContainer;
  67 }
  68
  69 SfxObjectFactory::SfxObjectFactory
  70 (
  71     const SvGlobalName&     rName,
  72     const OUString&         sName
  73 ) :    m_sFactoryName( sName ),
  74        pImpl( new SfxObjectFactory_Impl )
  75 {
  76     pImpl->pFilterContainer = new SfxFilterContainer( m_sFactoryName );
  77     pImpl->aClassName = rName;
  78 }
  79
  80 SfxObjectFactory::~SfxObjectFactory()
  81 {
  82     delete pImpl->pFilterContainer;
  83 }
  84
  85
  86 void SfxObjectFactory::RegisterViewFactory
  87 (
  88     SfxViewFactory &rFactory
  89 )
  90 {
  91 #if OSL_DEBUG_LEVEL > 0
  92     {
  93         const OUString sViewName( rFactory.GetAPIViewName() );
  94         for (auto const& viewFactory : pImpl->aViewFactoryArr)
  95         {
  96             if ( viewFactory->GetAPIViewName() != sViewName )
  97                 continue;
  98             SAL_WARN( "sfx", "SfxObjectFactory::RegisterViewFactory: duplicate view name: " << sViewName );
  99             break;
 100         }
 101     }
 102 #endif
 103     auto it = std::find_if(pImpl->aViewFactoryArr.begin(), pImpl->aViewFactoryArr.end(),
 104         [&rFactory](SfxViewFactory* pFactory) { return pFactory->GetOrdinal() > rFactory.GetOrdinal(); });
 105     pImpl->aViewFactoryArr.insert(it, &rFactory);
 106 }
 107
 108
 109 sal_uInt16 SfxObjectFactory::GetViewFactoryCount() const
 110 {
 111     return pImpl->aViewFactoryArr.size();
 112 }
 113
 114
 115 SfxViewFactory& SfxObjectFactory::GetViewFactory(sal_uInt16 i) const
 116 {
 117     return *pImpl->aViewFactoryArr[i];
 118 }
 119
 120
 121 SfxModule* SfxObjectFactory::GetModule() const
 122 {
 123     return pImpl->pModule;
 124 }
 125
 126 void SfxObjectFactory::SetModule_Impl( SfxModule *pMod )
 127 {
 128     pImpl->pModule = pMod;
 129 }
 130
 131 void SfxObjectFactory::SetSystemTemplate( const OUString& rServiceName, const OUString& rTemplateName )
 132 {
 133     static const int nMaxPathSize = 16000;
 134
 135     const OUString sConfPath = "Office/Factories/" + rServiceName;
 136     static const char PROP_DEF_TEMPL_CHANGED[] = "ooSetupFactorySystemDefaultTemplateChanged";
 137
 138     static const char DEF_TPL_STR[] = "/soffice.";
 139
 140     OUString sUserTemplateURL;
 141     OUString sPath;
 142     sal_Unicode aPathBuffer[nMaxPathSize];
 143     if ( SystemPath::GetUserTemplateLocation( aPathBuffer, nMaxPathSize ))
 144         sPath = OUString( aPathBuffer );
 145     osl::FileBase::getFileURLFromSystemPath( sPath, sUserTemplateURL );
 146
 147     if ( sUserTemplateURL.isEmpty())
 148         return;
 149
 150     try
 151     {
 152         uno::Reference< lang::XMultiServiceFactory > xFactory = ::comphelper::getProcessServiceFactory();
 153         uno::Reference< uno::XInterface > xConfig = ::comphelper::ConfigurationHelper::openConfig(
 154             ::comphelper::getProcessComponentContext(), "/org.openoffice.Setup", ::comphelper::EConfigurationModes::Standard );
 155
 156         OUString aActualFilter;
 157         ::comphelper::ConfigurationHelper::readRelativeKey( xConfig, sConfPath, "ooSetupFactoryActualFilter" ) >>= aActualFilter;
 158         bool bChanged(false);
 159         ::comphelper::ConfigurationHelper::readRelativeKey( xConfig, sConfPath, PROP_DEF_TEMPL_CHANGED ) >>= bChanged;
 160
 161         uno::Reference< container::XNameAccess > xFilterFactory(
 162             xFactory->createInstance( "com.sun.star.document.FilterFactory" ), uno::UNO_QUERY_THROW );
 163         uno::Reference< container::XNameAccess > xTypeDetection(
 164             xFactory->createInstance( "com.sun.star.document.TypeDetection" ), uno::UNO_QUERY_THROW );
 165
 166         OUString aActualFilterTypeName;
 167         uno::Sequence< beans::PropertyValue > aActuralFilterData;
 168         xFilterFactory->getByName( aActualFilter ) >>= aActuralFilterData;
 169         for ( const auto& rProp : std::as_const(aActuralFilterData) )
 170             if ( rProp.Name == "Type" )
 171                 rProp.Value >>= aActualFilterTypeName;
 172         ::comphelper::SequenceAsHashMap aProps1( xTypeDetection->getByName( aActualFilterTypeName ) );
 173         uno::Sequence< OUString > aAllExt =
 174             aProps1.getUnpackedValueOrDefault("Extensions", uno::Sequence< OUString >() );
 175         //To-do: check if aAllExt is empty first
 176         const OUString aExt = DEF_TPL_STR + aAllExt[0];
 177
 178         sUserTemplateURL += aExt;
 179
 180         uno::Reference<ucb::XSimpleFileAccess3> xSimpleFileAccess(
 181             ucb::SimpleFileAccess::create( ::comphelper::getComponentContext(xFactory) ) );
 182
 183         OUString aBackupURL;
 184         ::osl::Security().getConfigDir(aBackupURL);
 185         aBackupURL += "/temp";
 186
 187         if ( !xSimpleFileAccess->exists( aBackupURL ) )
 188             xSimpleFileAccess->createFolder( aBackupURL );
 189
 190         aBackupURL += aExt;
 191
 192         if ( !rTemplateName.isEmpty() )
 193         {
 194             if ( xSimpleFileAccess->exists( sUserTemplateURL ) && !bChanged )
 195                 xSimpleFileAccess->copy( sUserTemplateURL, aBackupURL );
 196
 197             uno::Reference< document::XTypeDetection > xTypeDetector( xTypeDetection, uno::UNO_QUERY );
 198             ::comphelper::SequenceAsHashMap aProps2( xTypeDetection->getByName( xTypeDetector->queryTypeByURL( rTemplateName ) ) );
 199             OUString aFilterName =
 200                 aProps2.getUnpackedValueOrDefault("PreferredFilter", OUString() );
 201
 202             uno::Sequence< beans::PropertyValue > aArgs( 3 );
 203             aArgs[0].Name = "FilterName";
 204             aArgs[0].Value <<= aFilterName;
 205             aArgs[1].Name = "AsTemplate";
 206             aArgs[1].Value <<= true;
 207             aArgs[2].Name = "URL";
 208             aArgs[2].Value <<= rTemplateName;
 209
 210             uno::Reference< frame::XLoadable > xLoadable( xFactory->createInstance( rServiceName ), uno::UNO_QUERY );
 211             xLoadable->load( aArgs );
 212
 213             aArgs.realloc( 2 );
 214             aArgs[1].Name = "Overwrite";
 215             aArgs[1].Value <<= true;
 216
 217             uno::Reference< frame::XStorable > xStorable( xLoadable, uno::UNO_QUERY );
 218             xStorable->storeToURL( sUserTemplateURL, aArgs );
 219             ::comphelper::ConfigurationHelper::writeRelativeKey( xConfig, sConfPath, PROP_DEF_TEMPL_CHANGED, uno::makeAny( true ));
 220             ::comphelper::ConfigurationHelper::flush( xConfig );
 221         }
 222         else
 223         {
 224             DBG_ASSERT( bChanged, "invalid ooSetupFactorySystemDefaultTemplateChanged value!" );
 225
 226             xSimpleFileAccess->copy( aBackupURL, sUserTemplateURL );
 227             xSimpleFileAccess->kill( aBackupURL );
 228             ::comphelper::ConfigurationHelper::writeRelativeKey( xConfig, sConfPath, PROP_DEF_TEMPL_CHANGED, uno::makeAny( false ));
 229             ::comphelper::ConfigurationHelper::flush( xConfig );
 230         }
 231     }
 232     catch(const uno::Exception&)
 233     {
 234     }
 235 }
 236
 237 void SfxObjectFactory::SetStandardTemplate( const OUString& rServiceName, const OUString& rTemplate )
 238 {
 239     SvtModuleOptions::EFactory eFac = SvtModuleOptions::ClassifyFactoryByServiceName(rServiceName);
 240     if (eFac == SvtModuleOptions::EFactory::UNKNOWN_FACTORY)
 241         eFac = SvtModuleOptions::ClassifyFactoryByShortName(rServiceName);
 242     if (eFac != SvtModuleOptions::EFactory::UNKNOWN_FACTORY)
 243     {
 244         SetSystemTemplate( rServiceName, rTemplate );
 245         SvtModuleOptions().SetFactoryStandardTemplate(eFac, rTemplate);
 246     }
 247 }
 248
 249 OUString SfxObjectFactory::GetStandardTemplate( const OUString& rServiceName )
 250 {
 251     SvtModuleOptions::EFactory eFac = SvtModuleOptions::ClassifyFactoryByServiceName(rServiceName);
 252     if (eFac == SvtModuleOptions::EFactory::UNKNOWN_FACTORY)
 253         eFac = SvtModuleOptions::ClassifyFactoryByShortName(rServiceName);
 254
 255     if (eFac != SvtModuleOptions::EFactory::UNKNOWN_FACTORY)
 256         return SvtModuleOptions().GetFactoryStandardTemplate(eFac);
 257
 258     return OUString();
 259 }
 260
 261 std::shared_ptr<const SfxFilter> SfxObjectFactory::GetTemplateFilter() const
 262 {
 263     sal_uInt16 nVersion=0;
 264     SfxFilterMatcher aMatcher ( m_sFactoryName );
 265     SfxFilterMatcherIter aIter( aMatcher );
 266     std::shared_ptr<const SfxFilter> pFilter;
 267     std::shared_ptr<const SfxFilter> pTemp = aIter.First();
 268     while ( pTemp )
 269     {
 270         if( pTemp->IsOwnFormat() && pTemp->IsOwnTemplateFormat() && ( pTemp->GetVersion() > nVersion ) )
 271         {
 272             pFilter = pTemp;
 273             nVersion = static_cast<sal_uInt16>(pTemp->GetVersion());
 274         }
 275
 276         pTemp = aIter.Next();
 277     }
 278
 279     return pFilter;
 280 }
 281
 282 void SfxObjectFactory::SetDocumentServiceName( const OUString& rServiceName )
 283 {
 284     pImpl->aServiceName = rServiceName;
 285 }
 286
 287 const OUString& SfxObjectFactory::GetDocumentServiceName() const
 288 {
 289     return pImpl->aServiceName;
 290 }
 291
 292 const SvGlobalName& SfxObjectFactory::GetClassId() const
 293 {
 294     return pImpl->aClassName;
 295 }
 296
 297 OUString SfxObjectFactory::GetFactoryURL() const
 298 {
 299     return "private:factory/" + m_sFactoryName;
 300 }
 301
 302 OUString SfxObjectFactory::GetModuleName() const
 303 {
 304     try
 305     {
 306         css::uno::Reference< css::uno::XComponentContext > xContext = ::comphelper::getProcessComponentContext();
 307
 308         css::uno::Reference< css::frame::XModuleManager2 > xModuleManager(
 309             css::frame::ModuleManager::create(xContext));
 310
 311         ::comphelper::SequenceAsHashMap aPropSet( xModuleManager->getByName(GetDocumentServiceName()) );
 312         return aPropSet.getUnpackedValueOrDefault("ooSetupFactoryUIName", OUString());
 313     }
 314     catch(const css::uno::RuntimeException&)
 315     {
 316         throw;
 317     }
 318     catch(const css::uno::Exception&)
 319     {
 320     }
 321
 322     return OUString();
 323 }
 324
 325
 326 sal_uInt16 SfxObjectFactory::GetViewNo_Impl( const SfxInterfaceId i_nViewId, const sal_uInt16 i_nFallback ) const
 327 {
 328     for ( sal_uInt16 curViewNo = 0; curViewNo < GetViewFactoryCount(); ++curViewNo )
 329     {
 330         const SfxInterfaceId curViewId = GetViewFactory( curViewNo ).GetOrdinal();
 331         if ( i_nViewId == curViewId )
 332            return curViewNo;
 333     }
 334     return i_nFallback;
 335 }
 336
 337 SfxViewFactory* SfxObjectFactory::GetViewFactoryByViewName( const OUString& i_rViewName ) const
 338 {
 339     for (   sal_uInt16 nViewNo = 0;
 340             nViewNo < GetViewFactoryCount();
 341             ++nViewNo
 342         )
 343     {
 344         SfxViewFactory& rViewFac( GetViewFactory( nViewNo ) );
 345         if  (   ( rViewFac.GetAPIViewName() == i_rViewName )
 346             ||  ( rViewFac.GetLegacyViewName() == i_rViewName )
 347             )
 348             return &rViewFac;
 349     }
 350     return nullptr;
 351 }
 352
 353 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */