configmgr/source/localbe/localschemasupplier.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: localschemasupplier.cxx,v $
  10  * $Revision: 1.7 $
  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 "localschemasupplier.hxx"
  35 #include "localfilehelper.hxx"
  36 #include "oslstream.hxx"
  37
  38 #ifndef CONFIGMGR_API_FACTORY_HXX_
  39 #include "confapifactory.hxx"
  40 #endif // CONFIGMGR_API_FACTORY_HXX_
  41 #include "serviceinfohelper.hxx"
  42 #include "bootstrap.hxx"
  43 #include "filehelper.hxx"
  44 #include <rtl/ustrbuf.hxx>
  45 #include <com/sun/star/uno/XComponentContext.hpp>
  46 #include <com/sun/star/configuration/backend/InsufficientAccessRightsException.hpp>
  47 #include <osl/file.hxx>
  48 #include <osl/process.h>
  49 #include <memory>
  50
  51 namespace configmgr { namespace localbe {
  52
  53 //==============================================================================
  54
  55 //------------------------------------------------------------------------------
  56
  57 LocalSchemaSupplier::LocalSchemaSupplier(
  58         const uno::Reference<uno::XComponentContext>& xContext)
  59         : cppu::WeakComponentImplHelper3<backend::XVersionedSchemaSupplier, lang::XInitialization, lang::XServiceInfo>(mMutex), mFactory(xContext->getServiceManager(),uno::UNO_QUERY) {
  60 }
  61 //------------------------------------------------------------------------------
  62
  63 LocalSchemaSupplier::~LocalSchemaSupplier(void) {}
  64 //------------------------------------------------------------------------------
  65 static const rtl::OUString kSchemaDataUrl(
  66         RTL_CONSTASCII_USTRINGPARAM(CONTEXT_ITEM_PREFIX_"SchemaDataUrl")) ;
  67
  68 static const rtl::OUString kSchemaVersion(
  69         RTL_CONSTASCII_USTRINGPARAM(CONTEXT_ITEM_PREFIX_"SchemaVersion")) ;
  70
  71 void SAL_CALL LocalSchemaSupplier::initialize(
  72         const uno::Sequence<uno::Any>& aParameters)
  73     throw (uno::RuntimeException, uno::Exception,
  74            css::configuration::InvalidBootstrapFileException,
  75            backend::CannotConnectException,
  76            backend::BackendSetupException)
  77 {
  78     if (aParameters.getLength() == 0) {
  79         throw lang::IllegalArgumentException(
  80                 rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(
  81                         "No parameters provided to LocalSchemaSupplier")),
  82                 *this, 0) ;
  83     }
  84     uno::Reference<uno::XComponentContext> context ;
  85
  86     for (sal_Int32 i = 0 ; i < aParameters.getLength() ; ++ i) {
  87         if (aParameters [i] >>= context) { break ; }
  88     }
  89
  90     // Setting: schema version
  91     // TODO: Add support for repository-specific versions
  92     uno::Any const aSchemaVersionSetting = context->getValueByName(kSchemaVersion);
  93     aSchemaVersionSetting >>= mSchemaVersion;
  94
  95     // Setting: schema diretory(ies)
  96     uno::Any const aSchemaDataSetting = context->getValueByName(kSchemaDataUrl);
  97     uno::Sequence< rtl::OUString > aSchemas;
  98     rtl::OUString schemas;
  99
 100     if (aSchemaDataSetting >>= schemas)
 101     {
 102         fillFromBlankSeparated(schemas, aSchemas) ;
 103     }
 104     else
 105     {
 106         aSchemaDataSetting >>=  aSchemas;
 107     }
 108     //validate SchemaDataUrls
 109     mSchemaDataUrls.realloc(aSchemas.getLength());
 110
 111     sal_Int32 nSchemaLocations =0;
 112     sal_Int32 nExistingSchemaLocations = 0;
 113     for (sal_Int32 j = 0; j < aSchemas.getLength(); ++j)
 114     {
 115         bool bOptional = checkOptionalArg(aSchemas[j]);
 116
 117         if(!bOptional)
 118             validateFileURL(aSchemas[j],*this);
 119         else if (!isValidFileURL(aSchemas[j]))
 120             continue;
 121
 122         OSL_ASSERT(isValidFileURL(aSchemas[j]));
 123
 124         //NormalizeURL
 125         implEnsureAbsoluteURL(aSchemas[j]);
 126         if(!normalizeURL(aSchemas[j],*this,bOptional))
 127             continue;
 128
 129         //now we have a correct file URL, which we will use
 130         mSchemaDataUrls[nSchemaLocations++]= aSchemas[j];
 131         if (!bOptional)
 132             checkFileExists(aSchemas[j],*this);
 133
 134         else if(!FileHelper::fileExists(aSchemas[j]))
 135             continue; // skip the directory check
 136
 137         checkIfDirectory(aSchemas[j],*this);
 138         ++nExistingSchemaLocations;
 139     }
 140     if (0 == nExistingSchemaLocations)
 141     {
 142         rtl::OUString sMsg = rtl::OUString::createFromAscii("LocalBackend: No schema directories found");
 143         throw backend::BackendSetupException(sMsg,*this, uno::Any()) ;
 144     }
 145     mSchemaDataUrls.realloc(nSchemaLocations);
 146 }
 147 //------------------------------------------------------------------------------
 148
 149 rtl::OUString SAL_CALL
 150     LocalSchemaSupplier::getSchemaVersion(const rtl::OUString& /*aComponent*/)
 151         throw (backend::BackendAccessException, lang::IllegalArgumentException,
 152                 uno::RuntimeException)
 153 {
 154     // TODO: Add support for repository-specific versions
 155     return mSchemaVersion;
 156 }
 157 //------------------------------------------------------------------------------
 158 static const rtl::OUString kSchemaSuffix(RTL_CONSTASCII_USTRINGPARAM(".xcs")) ;
 159 static const rtl::OUString kXMLSchemaParser(RTL_CONSTASCII_USTRINGPARAM(
 160             "com.sun.star.configuration.backend.xml.SchemaParser")) ;
 161
 162 uno::Reference<backend::XSchema> SAL_CALL
 163     LocalSchemaSupplier::getComponentSchema(const rtl::OUString& aComponent)
 164         throw (backend::BackendAccessException, lang::IllegalArgumentException,
 165                 uno::RuntimeException)
 166 {
 167     rtl::OUString subPath = componentToPath(aComponent) ;
 168
 169     osl::File * schemaFile = NULL;
 170     rtl::OUString errorMessage;
 171     bool bInsufficientAccess = false;
 172     for (sal_Int32 ix = 0; ix < mSchemaDataUrls.getLength(); ++ix)
 173     {
 174         rtl::OUStringBuffer schemaUrl(mSchemaDataUrls[ix]) ;
 175
 176         schemaUrl.append(subPath).append(kSchemaSuffix) ;
 177
 178         rtl::OUString const aFileUrl = schemaUrl.makeStringAndClear();
 179
 180         std::auto_ptr<osl::File> checkFile( new osl::File(aFileUrl) );
 181         osl::File::RC rc = checkFile->open(OpenFlag_Read) ;
 182
 183         if (rc == osl::File::E_None)
 184         {
 185             schemaFile = checkFile.release();
 186             break;
 187         }
 188         else if (rc != osl::File::E_NOENT)
 189         {
 190             if (rc == osl::File::E_ACCES)
 191                 bInsufficientAccess =true;
 192
 193             // accumulate error messages
 194             rtl::OUStringBuffer sMsg(errorMessage);
 195             if (errorMessage.getLength())
 196                 sMsg.appendAscii("LocalFile SchemaSupplier - Error accessing schema: ");
 197
 198             sMsg.appendAscii("\n- Cannot open input file \"");
 199             sMsg.append(aFileUrl);
 200             sMsg.appendAscii("\" : ");
 201             sMsg.append(FileHelper::createOSLErrorString(rc));
 202
 203             errorMessage = sMsg.makeStringAndClear();
 204         }
 205     }
 206
 207     if (NULL == schemaFile)
 208     {
 209         if (errorMessage.getLength() != 0)
 210         {
 211             // a real error occured
 212             io::IOException ioe(errorMessage,*this);
 213
 214             rtl::OUStringBuffer sMsg;
 215             sMsg.appendAscii("LocalFileLayer - Cannot readData: ").append(errorMessage);
 216
 217             if (bInsufficientAccess)
 218                 throw backend::InsufficientAccessRightsException(sMsg.makeStringAndClear(),*this,uno::makeAny(ioe));
 219             else
 220                 throw backend::BackendAccessException(sMsg.makeStringAndClear(),*this,uno::makeAny(ioe));
 221         }
 222         // simply not found
 223         return NULL;
 224     }
 225
 226     uno::Sequence<uno::Any> arguments(1) ;
 227     uno::Reference<io::XInputStream> stream( new OSLInputStreamWrapper(schemaFile, true) );
 228
 229     arguments [0] <<= stream ;
 230     uno::Reference<backend::XSchema> schema(
 231             mFactory->createInstanceWithArguments(kXMLSchemaParser, arguments),
 232             uno::UNO_QUERY) ;
 233
 234     if (!schema.is())
 235     {
 236         throw uno::RuntimeException(
 237                 rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(
 238                         "Cannot instantiate Schema Parser for ")) + aComponent,
 239                 *this) ;
 240     }
 241     return schema ;
 242 }
 243 //------------------------------------------------------------------------------
 244
 245
 246 //------------------------------------------------------------------------------
 247
 248 static const sal_Char * const kImplementation =
 249                 "com.sun.star.comp.configuration.backend.LocalSchemaSupplier" ;
 250 static const sal_Char * const kSchemaService =
 251                 "com.sun.star.configuration.backend.SchemaSupplier" ;
 252 static const sal_Char * const kLocalService =
 253                 "com.sun.star.configuration.backend.LocalSchemaSupplier" ;
 254
 255 static sal_Char const * kServiceNames [] = {kLocalService, 0, kSchemaService, 0 } ;
 256 static const ServiceImplementationInfo kServiceInfo = { kImplementation, kServiceNames,kServiceNames+2 } ;
 257
 258 const ServiceRegistrationInfo *getLocalSchemaSupplierServiceInfo()
 259 { return getRegistrationInfo(&kServiceInfo) ; }
 260
 261 uno::Reference<uno::XInterface> SAL_CALL
 262 instantiateLocalSchemaSupplier(const uno::Reference< uno::XComponentContext >& xContext) {
 263     return *new LocalSchemaSupplier(xContext) ;
 264 }
 265 //------------------------------------------------------------------------------
 266
 267 rtl::OUString SAL_CALL LocalSchemaSupplier::getImplementationName(void)
 268     throw (uno::RuntimeException)
 269 {
 270     return ServiceInfoHelper(&kServiceInfo).getImplementationName() ;
 271 }
 272 //------------------------------------------------------------------------------
 273
 274 sal_Bool SAL_CALL LocalSchemaSupplier::supportsService(
 275                                         const rtl::OUString& aServiceName)
 276     throw (uno::RuntimeException)
 277 {
 278     return  ServiceInfoHelper(&kServiceInfo).supportsService(aServiceName);
 279 }
 280 //------------------------------------------------------------------------------
 281
 282 uno::Sequence<rtl::OUString>
 283 SAL_CALL LocalSchemaSupplier::getSupportedServiceNames(void)
 284     throw (uno::RuntimeException)
 285 {
 286     return ServiceInfoHelper(&kServiceInfo).getSupportedServiceNames() ;
 287 }
 288
 289 // ---------------------------------------------------------------------------------------
 290
 291 } } // configmgr.localbe