comphelper/source/officeinstdir/officeinstallationdirectories.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 <config_folders.h>
  21
  22 #include "comphelper_module.hxx"
  23 #include "comphelper_services.hxx"
  24 #include <cppuhelper/supportsservice.hxx>
  25
  26 /**************************************************************************
  27                                 TODO
  28  **************************************************************************
  29
  30  *************************************************************************/
  31
  32 #include <osl/file.hxx>
  33 #include <com/sun/star/beans/XPropertySet.hpp>
  34 #include <com/sun/star/util/theMacroExpander.hpp>
  35
  36 #include "officeinstallationdirectories.hxx"
  37
  38 using namespace com::sun::star;
  39
  40 using namespace comphelper;
  41
  42
  43 // helpers
  44
  45
  46
  47 static bool makeCanonicalFileURL( OUString & rURL )
  48 {
  49     OSL_ENSURE( rURL.matchAsciiL( "file:", sizeof( "file:" ) - 1 , 0 ) ,
  50                 "File URL expected!" );
  51
  52     OUString aNormalizedURL;
  53     if ( osl::FileBase::getAbsoluteFileURL( OUString(),
  54                                             rURL,
  55                                             aNormalizedURL )
  56             == osl::DirectoryItem::E_None )
  57     {
  58         osl::DirectoryItem aDirItem;
  59         if ( osl::DirectoryItem::get( aNormalizedURL, aDirItem )
  60                 == osl::DirectoryItem::E_None )
  61         {
  62             osl::FileStatus aFileStatus( osl_FileStatus_Mask_FileURL );
  63
  64             if ( aDirItem.getFileStatus( aFileStatus )
  65                     == osl::DirectoryItem::E_None )
  66             {
  67                 aNormalizedURL = aFileStatus.getFileURL();
  68
  69                 if ( !aNormalizedURL.isEmpty() )
  70                 {
  71                     if ( !aNormalizedURL.endsWith("/") )
  72                         rURL = aNormalizedURL;
  73                     else
  74                         rURL = aNormalizedURL
  75                                 .copy( 0, aNormalizedURL.getLength() - 1 );
  76
  77                     return true;
  78                 }
  79             }
  80         }
  81     }
  82     return false;
  83 }
  84
  85
  86
  87
  88 // OfficeInstallationDirectories Implementation.
  89
  90
  91
  92
  93 OfficeInstallationDirectories::OfficeInstallationDirectories(
  94         const uno::Reference< uno::XComponentContext > & xCtx )
  95 : m_aOfficeBrandDirMacro( "$(brandbaseurl)" ),
  96   m_aOfficeBaseDirMacro( "$(baseinsturl)" ),
  97   m_aUserDirMacro( "$(userdataurl)" ),
  98   m_xCtx( xCtx ),
  99   m_pOfficeBrandDir( 0 ),
 100   m_pUserDir( 0 )
 101 {
 102 }
 103
 104
 105 // virtual
 106 OfficeInstallationDirectories::~OfficeInstallationDirectories()
 107 {
 108     delete m_pOfficeBrandDir;
 109     delete m_pUserDir;
 110 }
 111
 112
 113 // util::XOfficeInstallationDirectories
 114
 115
 116 // virtual
 117 OUString SAL_CALL
 118 OfficeInstallationDirectories::getOfficeInstallationDirectoryURL()
 119     throw ( uno::RuntimeException, std::exception )
 120 {
 121     initDirs();
 122     return OUString( *m_pOfficeBrandDir );
 123 }
 124
 125
 126 // virtual
 127 OUString SAL_CALL
 128 OfficeInstallationDirectories::getOfficeUserDataDirectoryURL()
 129     throw ( uno::RuntimeException, std::exception )
 130 {
 131     initDirs();
 132     return OUString( *m_pUserDir );
 133 }
 134
 135
 136
 137 // virtual
 138 OUString SAL_CALL
 139 OfficeInstallationDirectories::makeRelocatableURL( const OUString& URL )
 140     throw ( uno::RuntimeException, std::exception )
 141 {
 142     if ( !URL.isEmpty() )
 143     {
 144         initDirs();
 145
 146         OUString aCanonicalURL( URL );
 147         makeCanonicalFileURL( aCanonicalURL );
 148
 149         sal_Int32 nIndex = aCanonicalURL.indexOf( *m_pOfficeBrandDir );
 150         if ( nIndex  != -1 )
 151         {
 152             return OUString(
 153                 aCanonicalURL.replaceAt( nIndex,
 154                                          m_pOfficeBrandDir->getLength(),
 155                                          m_aOfficeBrandDirMacro ) );
 156         }
 157         else
 158         {
 159             nIndex = aCanonicalURL.indexOf( *m_pUserDir );
 160             if ( nIndex  != -1 )
 161             {
 162                 return OUString(
 163                     aCanonicalURL.replaceAt( nIndex,
 164                                              m_pUserDir->getLength(),
 165                                              m_aUserDirMacro ) );
 166             }
 167         }
 168     }
 169     return OUString( URL );
 170 }
 171
 172
 173 // virtual
 174 OUString SAL_CALL
 175 OfficeInstallationDirectories::makeAbsoluteURL( const OUString& URL )
 176     throw ( uno::RuntimeException, std::exception )
 177 {
 178     if ( !URL.isEmpty() )
 179     {
 180         sal_Int32 nIndex = URL.indexOf( m_aOfficeBrandDirMacro );
 181         if ( nIndex != -1 )
 182         {
 183             initDirs();
 184
 185             return OUString(
 186                 URL.replaceAt( nIndex,
 187                                m_aOfficeBrandDirMacro.getLength(),
 188                                *m_pOfficeBrandDir ) );
 189         }
 190         else
 191         {
 192             nIndex = URL.indexOf( m_aUserDirMacro );
 193             if ( nIndex != -1 )
 194             {
 195                 initDirs();
 196
 197                 return OUString(
 198                     URL.replaceAt( nIndex,
 199                                    m_aUserDirMacro.getLength(),
 200                                    *m_pUserDir ) );
 201             }
 202         }
 203     }
 204     return OUString( URL );
 205 }
 206
 207
 208 // lang::XServiceInfo
 209
 210
 211 // virtual
 212 OUString SAL_CALL
 213 OfficeInstallationDirectories::getImplementationName()
 214     throw ( uno::RuntimeException, std::exception )
 215 {
 216     return getImplementationName_static();
 217 }
 218
 219 // virtual
 220 sal_Bool SAL_CALL
 221 OfficeInstallationDirectories::supportsService( const OUString& ServiceName )
 222     throw ( uno::RuntimeException, std::exception )
 223 {
 224     return cppu::supportsService(this, ServiceName);
 225 }
 226
 227 // virtual
 228 uno::Sequence< OUString > SAL_CALL
 229 OfficeInstallationDirectories::getSupportedServiceNames()
 230     throw ( uno::RuntimeException, std::exception )
 231 {
 232     return getSupportedServiceNames_static();
 233 }
 234
 235
 236 // static
 237 OUString SAL_CALL
 238 OfficeInstallationDirectories::getImplementationName_static()
 239 {
 240     return OUString("com.sun.star.comp.util.OfficeInstallationDirectories");
 241 }
 242
 243
 244 // static
 245 uno::Sequence< OUString > SAL_CALL
 246 OfficeInstallationDirectories::getSupportedServiceNames_static()
 247 {
 248     const OUString aServiceName("com.sun.star.util.OfficeInstallationDirectories");
 249     return uno::Sequence< OUString >( &aServiceName, 1 );
 250 }
 251
 252
 253 // static
 254 OUString SAL_CALL OfficeInstallationDirectories::getSingletonName_static()
 255 {
 256     return OUString("com.sun.star.util.theOfficeInstallationDirectories");
 257 }
 258
 259
 260 // static
 261 uno::Reference< uno::XInterface > SAL_CALL
 262 OfficeInstallationDirectories::Create(
 263         const uno::Reference< uno::XComponentContext > & rxContext )
 264 {
 265     return static_cast< cppu::OWeakObject * >(
 266         new OfficeInstallationDirectories( rxContext ) );
 267 }
 268
 269
 270 // non-UNO
 271
 272
 273 void OfficeInstallationDirectories::initDirs()
 274 {
 275     if ( m_pOfficeBrandDir == 0 )
 276     {
 277         osl::MutexGuard aGuard( m_aMutex );
 278         if ( m_pOfficeBrandDir == 0 )
 279         {
 280             m_pOfficeBrandDir = new OUString;
 281             m_pUserDir        = new OUString;
 282
 283             uno::Reference< util::XMacroExpander > xExpander = util::theMacroExpander::get(m_xCtx);
 284
 285             *m_pOfficeBrandDir =
 286                 xExpander->expandMacros(
 287                      OUString( "$BRAND_BASE_DIR" ) );
 288
 289             OSL_ENSURE( !m_pOfficeBrandDir->isEmpty(),
 290                         "Unable to obtain office brand installation directory!" );
 291
 292             makeCanonicalFileURL( *m_pOfficeBrandDir );
 293
 294             *m_pUserDir =
 295                 xExpander->expandMacros(
 296                     OUString("${$BRAND_BASE_DIR/" LIBO_ETC_FOLDER "/" SAL_CONFIGFILE( "bootstrap" ) ":UserInstallation}" ) );
 297
 298             OSL_ENSURE( !m_pUserDir->isEmpty(),
 299                         "Unable to obtain office user data directory!" );
 300
 301             makeCanonicalFileURL( *m_pUserDir );
 302         }
 303     }
 304 }
 305
 306 void createRegistryInfo_OfficeInstallationDirectories()
 307 {
 308     static ::comphelper::module::OSingletonRegistration< OfficeInstallationDirectories > aAutoRegistration;
 309 }
 310
 311 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */