configmgr/source/localbe/localstratumbase.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: localstratumbase.cxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33
  34 #include "localstratumbase.hxx"
  35 #include "localfilehelper.hxx"
  36 #include "localfilelayer.hxx"
  37 #include "oslstream.hxx"
  38 #include "serviceinfohelper.hxx"
  39 #include "bootstrap.hxx"
  40 #include "filehelper.hxx"
  41 #include <rtl/ustrbuf.hxx>
  42 #include <com/sun/star/uno/XComponentContext.hpp>
  43 #include <com/sun/star/lang/NoSupportException.hpp>
  44 #include <com/sun/star/configuration/backend/InsufficientAccessRightsException.hpp>
  45 #include <osl/file.hxx>
  46 #include <osl/process.h>
  47 #include <memory>
  48
  49 namespace configmgr { namespace localbe {
  50
  51 //==============================================================================
  52
  53 //------------------------------------------------------------------------------
  54
  55 LocalStratumBase::LocalStratumBase(const uno::Reference<uno::XComponentContext>& xContext)
  56 : cppu::WeakComponentImplHelper3<lang::XInitialization, backend::XBackendEntities, lang::XServiceInfo>(mMutex)
  57 , mFactory(xContext->getServiceManager(),uno::UNO_QUERY)
  58 {
  59 }
  60 //------------------------------------------------------------------------------
  61
  62 LocalStratumBase::~LocalStratumBase()
  63 {}
  64
  65 //------------------------------------------------------------------------------
  66 void SAL_CALL LocalStratumBase::initialize(const uno::Sequence<uno::Any>& aParameters)
  67     throw (uno::RuntimeException, uno::Exception,
  68            css::configuration::InvalidBootstrapFileException,
  69            backend::CannotConnectException,
  70            backend::BackendSetupException)
  71 {
  72
  73
  74
  75     if (aParameters.getLength() == 0)
  76     {
  77         throw lang::IllegalArgumentException(
  78                 rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(
  79                         "No parameters provided to local Stratum")),
  80                 *this, 0) ;
  81     }
  82
  83
  84     for (sal_Int32 i = 0 ; i < aParameters.getLength() ; ++ i)
  85     {
  86         if (aParameters [i] >>= mStrataDataUrl )
  87         { break ; }
  88
  89     }
  90
  91     // get modified base for special layer implementations (e.g. resources)
  92     this->adjustBaseURL(mStrataDataUrl);
  93
  94     validateFileURL(mStrataDataUrl, *this);
  95     implEnsureAbsoluteURL(mStrataDataUrl);
  96     normalizeURL(mStrataDataUrl,*this, true);
  97
  98     if(FileHelper::fileExists(mStrataDataUrl))
  99     {
 100         checkIfDirectory(mStrataDataUrl, *this);
 101     }
 102 }
 103
 104 //------------------------------------------------------------------------------
 105
 106 void LocalStratumBase::adjustBaseURL(rtl::OUString& )
 107 {
 108 }
 109 //------------------------------------------------------------------------------
 110
 111 sal_Bool LocalStratumBase::isMoreRecent(const rtl::OUString& aFileUrl,
 112                                               const rtl::OUString& aTimestamp) {
 113     rtl::OUString layerUrl ;
 114     rtl::OUString subLayerUrl ;
 115
 116     getLayerDirectories(layerUrl, subLayerUrl) ;
 117
 118     return layerUrl.getLength() == 0 ||
 119             !BasicLocalFileLayer::getTimestamp(layerUrl + aFileUrl).equals( aTimestamp);
 120 }
 121 //------------------------------------------------------------------------------
 122
 123 uno::Reference<backend::XLayer> SAL_CALL
 124     LocalStratumBase::getLayer( const rtl::OUString& aLayerId, const rtl::OUString& aTimestamp )
 125         throw (backend::BackendAccessException, lang::IllegalArgumentException,
 126                 uno::RuntimeException)
 127 {
 128
 129     if (aLayerId.getLength() == 0){
 130         throw lang::IllegalArgumentException(
 131                 rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(
 132                         "LocalStratum:getLayer - no LayerId specified")),
 133                 *this, 0) ;
 134     }
 135     rtl::OUString const componentSubPath = layeridToPath(aLayerId) + getDataSuffix();
 136     if (!isMoreRecent(componentSubPath, aTimestamp)) { return NULL ; }
 137
 138     return createReadonlyFileLayer(componentSubPath);
 139 }
 140 //------------------------------------------------------------------------------
 141 //------------------------------------------------------------------------------
 142
 143 rtl::OUString SAL_CALL LocalStratumBase::getOwnerEntity()
 144     throw (uno::RuntimeException)
 145 {
 146     return mStrataDataUrl ;
 147 }
 148 //------------------------------------------------------------------------------
 149
 150 rtl::OUString SAL_CALL LocalStratumBase::getAdminEntity()
 151     throw (uno::RuntimeException)
 152 {
 153     return rtl::OUString();
 154 }
 155 //------------------------------------------------------------------------------
 156
 157 sal_Bool SAL_CALL LocalStratumBase::supportsEntity( const rtl::OUString& aEntity )
 158     throw (backend::BackendAccessException, uno::RuntimeException)
 159 {
 160     if(mStrataDataUrl.getLength() == 0)
 161     {
 162         return false;
 163     }
 164     if (aEntity.getLength() == 0)
 165     {
 166         return false;
 167     }
 168     return isEqualEntity(mStrataDataUrl,aEntity);
 169 }
 170 //------------------------------------------------------------------------------
 171
 172 sal_Bool SAL_CALL LocalStratumBase::isEqualEntity(const rtl::OUString& aEntity, const rtl::OUString& aOtherEntity)
 173     throw (backend::BackendAccessException, lang::IllegalArgumentException, uno::RuntimeException)
 174 {
 175     if (aEntity.getLength() == 0)
 176     {
 177         rtl::OUString const sMsg(RTL_CONSTASCII_USTRINGPARAM(
 178                 "LocalSingleBackend - Invalid empty entity."));
 179
 180         throw lang::IllegalArgumentException(sMsg, *this, 1);
 181     }
 182     if (aOtherEntity.getLength() == 0)
 183     {
 184         rtl::OUString const sMsg(RTL_CONSTASCII_USTRINGPARAM(
 185                 "LocalSingleBackend - Invalid empty entity."));
 186
 187         throw lang::IllegalArgumentException(sMsg, *this, 2);
 188     }
 189     rtl::OUString aNormalizedEntity(aEntity);
 190     normalizeURL(aNormalizedEntity,*this);
 191
 192     rtl::OUString aNormalizedOther(aOtherEntity);
 193     normalizeURL(aNormalizedOther,*this);
 194
 195     return aNormalizedEntity == aNormalizedOther;
 196 }
 197 //------------------------------------------------------------------------------
 198 //------------------------------------------------------------------------------
 199 uno::Reference<backend::XLayer>
 200     LocalStratumBase::createReadonlyFileLayer(const rtl::OUString& aSubpath)
 201          throw (lang::IllegalArgumentException)
 202 {
 203     rtl::OUString layerPath ;
 204     rtl::OUString subLayerPath ;
 205
 206     getLayerDirectories(layerPath, subLayerPath) ;
 207     return createReadonlyLocalFileLayer(mFactory, layerPath, aSubpath, subLayerPath) ;
 208 }
 209 //------------------------------------------------------------------------------
 210 uno::Reference<backend::XUpdatableLayer>
 211     LocalStratumBase::createUpdatableFileLayer(const rtl::OUString& aSubpath)
 212          throw (lang::IllegalArgumentException)
 213 {
 214     rtl::OUString layerPath ;
 215     rtl::OUString subLayerPath ;
 216
 217     getLayerDirectories(layerPath, subLayerPath) ;
 218     return createUpdatableLocalFileLayer(mFactory, layerPath, aSubpath, subLayerPath) ;
 219 }
 220 //------------------------------------------------------------------------------
 221
 222 rtl::OUString SAL_CALL LocalStratumBase::getImplementationName()
 223     throw (uno::RuntimeException)
 224 {
 225     return ServiceInfoHelper(getServiceInfoData()).getImplementationName() ;
 226 }
 227 //------------------------------------------------------------------------------
 228
 229 sal_Bool SAL_CALL LocalStratumBase::supportsService(const rtl::OUString& aServiceName)
 230     throw (uno::RuntimeException)
 231 {
 232     return  ServiceInfoHelper(getServiceInfoData()).supportsService(aServiceName);
 233 }
 234 //------------------------------------------------------------------------------
 235
 236 uno::Sequence<rtl::OUString> SAL_CALL LocalStratumBase::getSupportedServiceNames()
 237     throw (uno::RuntimeException)
 238 {
 239     return ServiceInfoHelper(getServiceInfoData()).getSupportedServiceNames() ;
 240 }
 241
 242 // ---------------------------------------------------------------------------------------
 243
 244 void LocalStratumBase::failReadonly()
 245 {
 246     rtl::OUStringBuffer aMessage;
 247     aMessage.appendAscii("Configurations - ")
 248             .appendAscii("Cannot get update access to layer: ")
 249             .appendAscii("Local file-based stratum at ")
 250             .append(this->getBaseUrl())
 251             .appendAscii(" is readonly.");
 252     throw lang::NoSupportException(aMessage.makeStringAndClear(),*this);
 253 }
 254 //------------------------------------------------------------------------------
 255
 256 } } // configmgr.localsinglestratum