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