configmgr/source/misc/configunoreg.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: configunoreg.cxx,v $
  10  * $Revision: 1.33 $
  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 #include <stdio.h>
  34
  35 #include "confapifactory.hxx"
  36 #include "serviceinfohelper.hxx"
  37 #include <cppuhelper/factory.hxx>
  38 #include <rtl/ustrbuf.hxx>
  39
  40 // ***************************************************************************************
  41 //
  42 // Die vorgeschriebene C-Api muss erfuellt werden!
  43 // Sie besteht aus drei Funktionen, die von dem Modul exportiert werden muessen.
  44 //
  45
  46 //---------------------------------------------------------------------------------------
  47 void RegisterService(
  48         const configmgr::ServiceRegistrationInfo* pInfo,
  49         const com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey > & xKey)
  50 {
  51     if (pInfo == 0 || pInfo->registeredServiceNames==0 || pInfo->implementationName==0)
  52         return;
  53
  54     rtl::OUStringBuffer aMainKeyName;
  55     aMainKeyName.appendAscii("/");
  56     aMainKeyName.appendAscii(pInfo->implementationName);
  57     aMainKeyName.appendAscii("/UNO/SERVICES");
  58
  59     com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey >  xNewKey( xKey->createKey(aMainKeyName.makeStringAndClear()) );
  60     OSL_ENSURE(xNewKey.is(), "CONFMGR::component_writeInfo : could not create a registry key !");
  61
  62     for(sal_Char const * const* p = pInfo->registeredServiceNames ; *p; ++p)
  63     {
  64         xNewKey->createKey(rtl::OUString::createFromAscii(*p));
  65     }
  66 }
  67
  68 //---------------------------------------------------------------------------------------
  69
  70 void RegisterSingleton(
  71         const configmgr::SingletonRegistrationInfo* pInfo,
  72         const com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey > & xKey)
  73 {
  74     if (pInfo == 0 ||   pInfo->singletonName            ==0 ||
  75                         pInfo->implementationName       ==0 ||
  76                         pInfo->instantiatedServiceName  ==0 )
  77         return;
  78
  79     rtl::OUStringBuffer aSingletonKeyName;
  80     aSingletonKeyName.appendAscii("/");
  81     aSingletonKeyName.appendAscii(pInfo->implementationName);
  82     aSingletonKeyName.appendAscii("/UNO/SINGLETONS/");
  83     aSingletonKeyName.appendAscii(pInfo->singletonName);
  84
  85     com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey >  xNewKey( xKey->createKey(aSingletonKeyName.makeStringAndClear()) );
  86     OSL_ENSURE(xNewKey.is(), "CONFMGR::component_writeInfo : could not create a registry key !");
  87
  88     xNewKey->setStringValue(rtl::OUString::createFromAscii(pInfo->instantiatedServiceName));
  89
  90     if (pInfo->mappedImplementation != 0)
  91         RegisterService(pInfo->mappedImplementation,xKey);
  92 }
  93
  94
  95 //-----------------------------------------------------------------------------
  96 struct ServiceImplementationRequest
  97 {
  98     com::sun::star::uno::Reference< com::sun::star::uno::XInterface > xRet;
  99     com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > const m_xServiceManager;
 100     rtl::OUString const sImplementationName;
 101
 102     //-------------------------------------------------------------------------
 103     ServiceImplementationRequest(
 104         void* pServiceManager,
 105         sal_Char const* pImplementationName
 106     )
 107     : m_xServiceManager(reinterpret_cast<com::sun::star::lang::XMultiServiceFactory*>(pServiceManager))
 108     , sImplementationName(rtl::OUString::createFromAscii(pImplementationName))
 109     {
 110     }
 111     //-------------------------------------------------------------------------
 112     inline
 113     sal_Bool shouldCreate(const configmgr::ServiceRegistrationInfo* pInfo) const
 114     {
 115         OSL_ENSURE(!xRet.is(), "CreateProvider : invalid creation request: we already have a return value !");
 116         return !xRet.is()       &&
 117                 pInfo != 0      &&
 118                 0 == sImplementationName.compareToAscii(pInfo->implementationName);
 119     }
 120
 121     //-------------------------------------------------------------------------
 122
 123     sal_Bool CreateProviderFactory(
 124                 const configmgr::ServiceRegistrationInfo* pInfo,
 125                 bool bAdmin
 126             )
 127     {
 128         if (this->shouldCreate(pInfo))
 129         try
 130         {
 131             configmgr::ServiceRegistrationHelper aInfo(pInfo);
 132
 133             const com::sun::star::uno::Sequence< rtl::OUString > Services=  aInfo.getRegisteredServiceNames();
 134
 135             xRet = configmgr::createProviderFactory( aInfo.getImplementationName(), bAdmin);
 136
 137             OSL_ENSURE(xRet.is(), "CreateProvider : WHERE IS THE return value !");
 138         }
 139         catch(com::sun::star::uno::Exception&)
 140         {
 141         }
 142         return xRet.is();
 143     }
 144
 145     //-------------------------------------------------------------------------
 146
 147     sal_Bool CreateServiceFactory(
 148                 const configmgr::ServiceRegistrationInfo* pInfo,
 149                 ::cppu::ComponentFactoryFunc Factory
 150             )
 151     {
 152         if (this->shouldCreate(pInfo))
 153         try
 154         {
 155             configmgr::ServiceRegistrationHelper aInfo(pInfo);
 156
 157             const com::sun::star::uno::Sequence< rtl::OUString > Services=  aInfo.getRegisteredServiceNames();
 158
 159             xRet = cppu::createSingleComponentFactory( Factory, aInfo.getImplementationName(), Services, 0);
 160
 161             OSL_ENSURE(xRet.is(), "CreateProvider : WHERE IS THE return value !");
 162         }
 163         catch(com::sun::star::uno::Exception&)
 164         {
 165         }
 166         return xRet.is();
 167     }
 168
 169     //-------------------------------------------------------------------------
 170
 171     sal_Bool CreateSingletonMapperFactory(
 172                 const configmgr::SingletonRegistrationInfo* pInfo,
 173                 ::cppu::ComponentFactoryFunc Mapper
 174             )
 175     {
 176         OSL_ENSURE(pInfo && pInfo->mappedImplementation, "CreateProvider : Cannot map unmapped singleton !");
 177
 178         return pInfo && pInfo->mappedImplementation &&
 179                 CreateServiceFactory(pInfo->mappedImplementation,Mapper);
 180     }
 181
 182     //-------------------------------------------------------------------------
 183     void* getService() const
 184     {
 185         // we want to transport the interface pointer as flat C void pointer, so this prevents deletion
 186         if (xRet.is())
 187             xRet->acquire();
 188
 189         return xRet.get();
 190     }
 191 };
 192
 193 //---------------------------------------------------------------------------------------
 194
 195 extern "C" SAL_DLLPUBLIC_EXPORT
 196 void SAL_CALL component_getImplementationEnvironment(
 197                 const sal_Char  **ppEnvTypeName,
 198                 uno_Environment ** /* ppEnv */
 199             )
 200 {
 201     *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
 202 }
 203
 204 //---------------------------------------------------------------------------------------
 205 extern "C" SAL_DLLPUBLIC_EXPORT sal_Bool SAL_CALL component_writeInfo(
 206                             void* /* pServiceManager */,
 207                             void* pRegistryKey
 208             )
 209 {
 210     if (pRegistryKey)
 211     try
 212     {
 213         com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey > xKey(reinterpret_cast<com::sun::star::registry::XRegistryKey*>(pRegistryKey));
 214
 215         // configuration access entry points: configuration provider
 216         RegisterSingleton(configmgr::getDefaultProviderSingletonInfo(), xKey) ;
 217
 218         RegisterService(configmgr::getConfigurationProviderServiceInfo(), xKey);
 219         RegisterService(configmgr::getDefaultProviderServiceInfo(), xKey);
 220         RegisterService(configmgr::getAdminProviderServiceInfo(), xKey);
 221
 222         // registry wrapper (deprecated)
 223         RegisterService(configmgr::getConfigurationRegistryServiceInfo(), xKey);
 224
 225         // updating
 226         RegisterService(configmgr::backend::getUpdateMergerServiceInfo(), xKey);
 227
 228         // xml handling
 229         RegisterService(configmgr::xml::getSchemaParserServiceInfo(), xKey);
 230         RegisterService(configmgr::xml::getLayerParserServiceInfo(), xKey);
 231         RegisterService(configmgr::xml::getLayerWriterServiceInfo(), xKey);
 232
 233         // bootstrap handling
 234         RegisterSingleton(configmgr::getBootstrapContextSingletonInfo(), xKey) ;
 235         RegisterService(configmgr::getBootstrapContextServiceInfo(), xKey) ;
 236
 237         // backend singletons
 238         RegisterSingleton(configmgr::backend::getDefaultBackendSingletonInfo(), xKey) ;
 239
 240         // backends
 241         RegisterService(configmgr::backend::getDefaultBackendServiceInfo(), xKey) ;
 242         RegisterService(configmgr::backend::getSingleBackendAdapterServiceInfo(), xKey) ;
 243         RegisterService(configmgr::backend::getMultiStratumBackendServiceInfo(), xKey) ;
 244         RegisterService(configmgr::localbe::getLocalBackendServiceInfo(), xKey) ;
 245         RegisterService(configmgr::localbe::getLocalDataImportServiceInfo(), xKey) ;
 246         RegisterService(configmgr::localbe::getLocalHierarchyBrowserServiceInfo(), xKey) ;
 247         RegisterService(configmgr::localbe::getLocalSchemaSupplierServiceInfo(), xKey) ;
 248         RegisterService(configmgr::localbe::getLocalLegacyStratumServiceInfo(), xKey) ;
 249         RegisterService(configmgr::localbe::getLocalDataStratumServiceInfo(), xKey) ;
 250         RegisterService(configmgr::localbe::getLocalReadonlyStratumServiceInfo(), xKey) ;
 251         RegisterService(configmgr::localbe::getLocalResourceStratumServiceInfo(), xKey) ;
 252         RegisterService(configmgr::localbe::getLocalMultiStratumServiceInfo(), xKey) ;
 253
 254         // im/export
 255         RegisterService(configmgr::backend::getMergeImportServiceInfo(), xKey);
 256         RegisterService(configmgr::backend::getCopyImportServiceInfo(), xKey);
 257
 258         return sal_True;
 259     }
 260     catch (::com::sun::star::registry::InvalidRegistryException& )
 261     {
 262         OSL_ENSURE(sal_False, "configmgr: component_writeInfo : could not create a registry key ! ## InvalidRegistryException !");
 263     }
 264
 265     return sal_False;
 266 }
 267
 268 //---------------------------------------------------------------------------------------
 269 extern "C" SAL_DLLPUBLIC_EXPORT void* SAL_CALL component_getFactory(
 270                     const sal_Char* pImplementationName,
 271                     void* pServiceManager,
 272                     void* /*pRegistryKey*/)
 273 {
 274     void* pRet = 0;
 275     if (pServiceManager)
 276     {
 277         ServiceImplementationRequest aReq(pServiceManager,pImplementationName);
 278
 279         // configuration access entry points: configuration provider
 280         aReq.CreateProviderFactory(
 281             configmgr::getConfigurationProviderServiceInfo(),
 282             false)
 283         ||
 284         aReq.CreateProviderFactory(
 285             configmgr::getAdminProviderServiceInfo(),
 286             true)
 287         ||
 288         aReq.CreateServiceFactory(
 289             configmgr::getDefaultProviderServiceInfo(),
 290             &configmgr::instantiateDefaultProvider)
 291         ||
 292         // registry wrapper (deprecated)
 293         aReq.CreateServiceFactory(
 294             configmgr::getConfigurationRegistryServiceInfo(),
 295             &configmgr::instantiateConfigRegistry)
 296         ||
 297         // updating
 298         aReq.CreateServiceFactory(
 299             configmgr::backend::getUpdateMergerServiceInfo(),
 300             &configmgr::backend::instantiateUpdateMerger)
 301         ||
 302         // xml handling
 303         aReq.CreateServiceFactory(
 304             configmgr::xml::getSchemaParserServiceInfo(),
 305             &configmgr::xml::instantiateSchemaParser)
 306         ||
 307         aReq.CreateServiceFactory(
 308             configmgr::xml::getLayerParserServiceInfo(),
 309             &configmgr::xml::instantiateLayerParser)
 310         ||
 311         aReq.CreateServiceFactory(
 312             configmgr::xml::getLayerWriterServiceInfo(),
 313             &configmgr::xml::instantiateLayerWriter)
 314         ||
 315         // bootstrap handling
 316         aReq.CreateServiceFactory(
 317             configmgr::getBootstrapContextServiceInfo(),
 318             &configmgr::instantiateBootstrapContext)
 319         ||
 320         // backend singletons
 321         aReq.CreateSingletonMapperFactory(
 322                 configmgr::backend::getDefaultBackendSingletonInfo(),
 323                 configmgr::backend::getDefaultBackendSingleton)
 324         ||
 325         // backends
 326         aReq.CreateServiceFactory(
 327                 configmgr::backend::getDefaultBackendServiceInfo(),
 328                 configmgr::backend::instantiateDefaultBackend)
 329         ||
 330         aReq.CreateServiceFactory(
 331                 configmgr::backend::getSingleBackendAdapterServiceInfo(),
 332                 configmgr::backend::instantiateSingleBackendAdapter)
 333         ||
 334         aReq.CreateServiceFactory(
 335                 configmgr::backend::getMultiStratumBackendServiceInfo(),
 336                 configmgr::backend::instantiateMultiStratumBackend)
 337         ||
 338         aReq.CreateServiceFactory(
 339                 configmgr::localbe::getLocalBackendServiceInfo(),
 340                 configmgr::localbe::instantiateLocalBackend)
 341         ||
 342         aReq.CreateServiceFactory(
 343                 configmgr::localbe::getLocalDataImportServiceInfo(),
 344                 configmgr::localbe::instantiateLocalDataImporter)
 345         ||
 346         aReq.CreateServiceFactory(
 347                 configmgr::localbe::getLocalHierarchyBrowserServiceInfo(),
 348                 configmgr::localbe::instantiateLocalHierarchyBrowser)
 349         ||
 350          aReq.CreateServiceFactory(
 351                 configmgr::localbe::getLocalSchemaSupplierServiceInfo(),
 352                 configmgr::localbe::instantiateLocalSchemaSupplier)
 353         ||
 354          aReq.CreateServiceFactory(
 355                 configmgr::localbe::getLocalLegacyStratumServiceInfo(),
 356                 configmgr::localbe::instantiateLocalLegacyStratum)
 357         ||
 358          aReq.CreateServiceFactory(
 359                 configmgr::localbe::getLocalDataStratumServiceInfo(),
 360                 configmgr::localbe::instantiateLocalDataStratum)
 361         ||
 362          aReq.CreateServiceFactory(
 363                 configmgr::localbe::getLocalReadonlyStratumServiceInfo(),
 364                 configmgr::localbe::instantiateLocalReadonlyStratum)
 365         ||
 366          aReq.CreateServiceFactory(
 367                 configmgr::localbe::getLocalResourceStratumServiceInfo(),
 368                 configmgr::localbe::instantiateLocalResourceStratum)
 369         ||
 370          aReq.CreateServiceFactory(
 371                 configmgr::localbe::getLocalMultiStratumServiceInfo(),
 372                 configmgr::localbe::instantiateLocalMultiStratum)
 373         ||
 374         // im/export
 375         aReq.CreateServiceFactory(
 376             configmgr::backend::getMergeImportServiceInfo(),
 377             &configmgr::backend::instantiateMergeImporter)
 378         ||
 379         aReq.CreateServiceFactory(
 380             configmgr::backend::getCopyImportServiceInfo(),
 381             &configmgr::backend::instantiateCopyImporter);
 382
 383         pRet = aReq.getService();
 384     }
 385
 386     return pRet;
 387 }
 388 //---------------------------------------------------------------------------------------
 389