configmgr/source/registry/configregistry.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: configregistry.cxx,v $
  10  * $Revision: 1.13 $
  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
  35 #include "configregistry.hxx"
  36 #include "cfgregistrykey.hxx"
  37 #include "confapifactory.hxx"
  38 #include "datalock.hxx"
  39 #include "utility.hxx"
  40 #include <comphelper/sequence.hxx>
  41 #include <cppuhelper/typeprovider.hxx>
  42 #include <osl/diagnose.h>
  43 #include <com/sun/star/lang/ServiceNotRegisteredException.hpp>
  44 #include <com/sun/star/lang/DisposedException.hpp>
  45 #include <com/sun/star/lang/WrappedTargetRuntimeException.hpp>
  46 #include <com/sun/star/beans/PropertyValue.hpp>
  47 #include <com/sun/star/container/XNameAccess.hpp>
  48 #include <com/sun/star/uno/XComponentContext.hpp>
  49
  50 #define THISREF()               static_cast< ::cppu::OWeakObject* >(this)
  51 #define UNISTRING(c)    makeUniString(c)
  52
  53 //..........................................................................
  54 namespace configmgr
  55 {
  56 //..........................................................................
  57
  58 namespace beans = ::com::sun::star::beans;
  59
  60 //==========================================================================
  61 //= OConfigurationRegistry
  62 //==========================================================================
  63     inline
  64     static
  65     rtl::OUString makeUniString(char const* c)
  66     {
  67         return rtl::OUString::createFromAscii(c);
  68     }
  69
  70
  71     // #99130# Don't export SimpleRegistry service
  72     static sal_Char const * const aExportedConfigRegistryServices[] =
  73     {
  74         "com.sun.star.configuration.ConfigurationRegistry",
  75         NULL
  76     };
  77     static sal_Char const * const aAdditionalConfigRegistryServices[] =
  78     {
  79         "com.sun.star.registry.SimpleRegistry",
  80         NULL
  81     };
  82
  83     sal_Char const * const aConfigRegistryImplementationName = "com.sun.star.comp.configuration.OConfigurationRegistry";
  84
  85     const ServiceImplementationInfo OConfigurationRegistry::s_aServiceInfo =
  86     {
  87         aConfigRegistryImplementationName,
  88         aExportedConfigRegistryServices,
  89         aAdditionalConfigRegistryServices
  90     };
  91
  92     com::sun::star::uno::Reference< com::sun::star::uno::XInterface > SAL_CALL instantiateConfigRegistry(uno::Reference< uno::XComponentContext > const& xContext )
  93     {
  94         OSL_ASSERT( xContext.is() );
  95         com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > xServiceManager( xContext->getServiceManager(), com::sun::star::uno::UNO_QUERY );
  96         ::cppu::OWeakObject * pNewInstance = new OConfigurationRegistry(xServiceManager);
  97         return pNewInstance;
  98     }
  99
 100     const ServiceRegistrationInfo* getConfigurationRegistryServiceInfo()
 101     {
 102         return getRegistrationInfo(& OConfigurationRegistry::s_aServiceInfo);
 103     }
 104
 105 //--------------------------------------------------------------------------
 106 OConfigurationRegistry::OConfigurationRegistry(const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& _rORB) throw(com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException)
 107     :ServiceComponentImpl(&s_aServiceInfo)
 108     ,m_xORB(_rORB)
 109 {
 110     // create the configuration provider used for accessing the configuration
 111     OSL_ENSURE(m_xORB.is(), "OConfigurationRegistry::OConfigurationRegistry : invalid service factory !");
 112     if (m_xORB.is())
 113     {
 114         m_xConfigurationProvider =
 115             m_xConfigurationProvider.query(
 116                 m_xORB->createInstance(UNISTRING("com.sun.star.configuration.ConfigurationProvider"))
 117             );
 118     }
 119
 120     if (!m_xConfigurationProvider.is())
 121     {
 122         // it's heavily needed ...
 123         throw com::sun::star::lang::ServiceNotRegisteredException(UNISTRING("Failed to instantiate the mandatory service com.sun.star.configuration.ConfigurationProvider."),
 124             THISREF());
 125     }
 126 }
 127
 128 //--------------------------------------------------------------------------
 129 com::sun::star::uno::Any SAL_CALL OConfigurationRegistry::queryInterface( const com::sun::star::uno::Type& _rType ) throw(com::sun::star::uno::RuntimeException)
 130 {
 131     com::sun::star::uno::Any aReturn = ServiceComponentImpl::queryInterface(_rType);
 132     if (!aReturn.hasValue())
 133         aReturn = cppu::ImplHelper2< com::sun::star::registry::XSimpleRegistry, com::sun::star::util::XFlushable >::queryInterface(_rType);
 134     return aReturn;
 135 }
 136
 137 //--------------------------------------------------------------------------
 138 com::sun::star::uno::Sequence< com::sun::star::uno::Type > SAL_CALL OConfigurationRegistry::getTypes(  ) throw(com::sun::star::uno::RuntimeException)
 139 {
 140     return ::comphelper::concatSequences(
 141         ServiceComponentImpl::getTypes(),
 142         cppu::ImplHelper2< com::sun::star::registry::XSimpleRegistry,   com::sun::star::util::XFlushable >::getTypes());
 143 }
 144
 145 //--------------------------------------------------------------------------
 146 com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL OConfigurationRegistry::getImplementationId(  ) throw(com::sun::star::uno::RuntimeException)
 147 {
 148     static cppu::OImplementationId aId;
 149     return aId.getImplementationId();
 150 }
 151
 152 //--------------------------------------------------------------------------
 153 ::rtl::OUString OConfigurationRegistry::getNodePathFromURL(const ::rtl::OUString& _rURL)
 154 {
 155     // TODO
 156     return _rURL;
 157 }
 158
 159 //--------------------------------------------------------------------------
 160 ::rtl::OUString SAL_CALL OConfigurationRegistry::getURL() throw(com::sun::star::uno::RuntimeException)
 161 {
 162     UnoApiLock aLock;
 163     return m_sLocation;
 164 }
 165
 166 //--------------------------------------------------------------------------
 167
 168 // Not guarded !
 169 void OConfigurationRegistry::implCheckOpen() throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 170 {
 171     if (!implIsOpen())
 172         throw com::sun::star::registry::InvalidRegistryException(UNISTRING("The registry is not bound to a configuration node."), THISREF());
 173 }
 174
 175 //--------------------------------------------------------------------------
 176 void SAL_CALL OConfigurationRegistry::open( const ::rtl::OUString& _rURL, sal_Bool _bReadOnly, sal_Bool /*_bCreate*/ ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 177 {
 178     UnoApiLock aLock;
 179
 180     if (implIsOpen())
 181         close();
 182
 183     ::rtl::OUString sNodePath = getNodePathFromURL(_rURL);
 184
 185     if (!m_xConfigurationProvider.is())
 186         throw com::sun::star::lang::DisposedException(UNISTRING("invalid object. configuration provider is already disposed."), THISREF());
 187
 188     com::sun::star::uno::Reference< com::sun::star::uno::XInterface > xNodeAccess;
 189     try
 190     {
 191         char const * const sAccessType = _bReadOnly ?
 192             "com.sun.star.configuration.ConfigurationAccess" :
 193             "com.sun.star.configuration.ConfigurationUpdateAccess";
 194
 195         // prepare parameters for creating the config access : the node path
 196         beans::PropertyValue aArgValue;
 197         aArgValue.Handle = -1;
 198
 199         // currently theres is one parameter: the node path
 200         com::sun::star::uno::Sequence< com::sun::star::uno::Any > aArguments(1);
 201
 202         aArgValue.Name = UNISTRING("nodepath");
 203         aArgValue.Value <<= sNodePath;
 204
 205         aArguments[0] <<= aArgValue;
 206
 207
 208         xNodeAccess = m_xConfigurationProvider->createInstanceWithArguments(UNISTRING(sAccessType), aArguments);
 209     }
 210     catch (com::sun::star::uno::RuntimeException&)
 211     {   // allowed to leave this method
 212         throw;
 213     }
 214     catch (com::sun::star::uno::Exception& e)
 215     {   // not allowed to leave this method
 216         ::rtl::OUString sMessage = UNISTRING("The configuration provider does not supply a registry access for the requested Node.");
 217         sMessage += UNISTRING(" original error message of the provider : ");
 218         sMessage += e.Message;
 219         throw com::sun::star::registry::InvalidRegistryException(sMessage, THISREF());
 220     }
 221
 222     com::sun::star::uno::Reference< com::sun::star::container::XNameAccess > xReadRoot(xNodeAccess, com::sun::star::uno::UNO_QUERY);
 223     if (!_bReadOnly)
 224         m_xUpdateRoot = m_xUpdateRoot.query(xReadRoot);
 225
 226     if (!xReadRoot.is() || (!_bReadOnly && !m_xUpdateRoot.is()))
 227         throw com::sun::star::registry::InvalidRegistryException(UNISTRING("The object supplied the by configuration provider is invalid."), THISREF());
 228
 229     m_xRootKey = new OConfigurationRegistryKey(xReadRoot, !_bReadOnly, OConfigurationRegistryKey::SubtreeRoot());
 230     m_xSubtreeRoot = xNodeAccess;
 231 }
 232
 233 //--------------------------------------------------------------------------
 234 sal_Bool SAL_CALL OConfigurationRegistry::isValid(  ) throw(com::sun::star::uno::RuntimeException)
 235 {
 236     UnoApiLock aLock;
 237     return implIsOpen();
 238 }
 239
 240 //--------------------------------------------------------------------------
 241 sal_Bool OConfigurationRegistry::implIsOpen(  ) throw(com::sun::star::uno::RuntimeException)
 242 {
 243     return m_xRootKey.is();
 244 }
 245
 246 //--------------------------------------------------------------------------
 247 void SAL_CALL  OConfigurationRegistry::close(  ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 248 {
 249     UnoApiLock aLock;
 250
 251     com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey > xRootKey(m_xRootKey);
 252     m_xRootKey = NULL;
 253
 254     com::sun::star::uno::Reference< XComponent > xRootComponent(m_xSubtreeRoot, com::sun::star::uno::UNO_QUERY);
 255     m_xSubtreeRoot = NULL;
 256     m_xUpdateRoot = NULL;
 257
 258     m_sLocation = ::rtl::OUString();
 259
 260     if (xRootKey.is())
 261         xRootKey->closeKey();
 262
 263     if (xRootComponent.is())
 264         xRootComponent->dispose();
 265 }
 266
 267 //--------------------------------------------------------------------------
 268 void SAL_CALL OConfigurationRegistry::disposing()
 269 {
 270     close();
 271
 272     {
 273         UnoApiLock aLock;
 274
 275         m_xConfigurationProvider.clear();
 276         m_xORB.clear();
 277     }
 278
 279     ServiceComponentImpl::disposing();
 280 }
 281
 282 //--------------------------------------------------------------------------
 283 void SAL_CALL OConfigurationRegistry::destroy(  ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 284 {
 285     UnoApiLock aLock;
 286     implCheckOpen();
 287
 288     throw com::sun::star::registry::InvalidRegistryException(UNISTRING("This registry is a wrapper for a configuration access. It can not be destroyed."), THISREF());
 289 }
 290
 291 //--------------------------------------------------------------------------
 292 com::sun::star::uno::Reference< com::sun::star::registry::XRegistryKey > SAL_CALL OConfigurationRegistry::getRootKey(  ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 293 {
 294     UnoApiLock aLock;
 295     implCheckOpen();
 296
 297     return m_xRootKey;
 298 }
 299
 300 //--------------------------------------------------------------------------
 301 sal_Bool SAL_CALL OConfigurationRegistry::isReadOnly(  ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::uno::RuntimeException)
 302 {
 303     UnoApiLock aLock;
 304     implCheckOpen();
 305
 306     return !m_xUpdateRoot.is();
 307         // if we don't have the update root, we're readonly
 308 }
 309
 310 //--------------------------------------------------------------------------
 311 void SAL_CALL OConfigurationRegistry::mergeKey( const ::rtl::OUString& /*aKeyName*/, const ::rtl::OUString& /*aUrl*/ ) throw(com::sun::star::registry::InvalidRegistryException, com::sun::star::registry::MergeConflictException, com::sun::star::uno::RuntimeException)
 312 {
 313     UnoApiLock aLock;
 314     implCheckOpen();
 315
 316     // not supported. but we can't throw an NoSupportException here ...
 317     throw com::sun::star::registry::InvalidRegistryException(UNISTRING("You can't merge into this registry. It's just a wrapper for a configuration node, which has a fixed structure which can not be modified"), THISREF());
 318 }
 319
 320 //--------------------------------------------------------------------------
 321 void SAL_CALL OConfigurationRegistry::flush(  ) throw(com::sun::star::uno::RuntimeException)
 322 {
 323     {
 324         UnoApiLock aLock;
 325         if (m_xUpdateRoot.is())
 326         {
 327             try
 328             {
 329                 m_xUpdateRoot->commitChanges();
 330             }
 331             catch (com::sun::star::lang::WrappedTargetException& e)
 332             {   // not allowed to leave this method
 333
 334                 ::rtl::OUString sMessage;
 335                 sMessage = UNISTRING("The changes made could not be committed. Orginal exception message : ");
 336                 sMessage += e.Message;
 337
 338                 // TODO : the specification of XFlushable has to be changed !!!!!
 339                 OSL_ENSURE(sal_False, "OConfigurationRegistry::flush : caught an exception, could not flush the data !");
 340     //                  return;
 341
 342                 throw com::sun::star::lang::WrappedTargetRuntimeException(sMessage, THISREF(), e.TargetException);
 343             }
 344         }
 345     }
 346
 347     com::sun::star::uno::Reference< com::sun::star::util::XFlushListener > const * const pSelector = 0;
 348     if (cppu::OInterfaceContainerHelper* pContainer = this->rBHelper.getContainer(::getCppuType(pSelector)) )
 349     {
 350         ::cppu::OInterfaceIteratorHelper aIter( *pContainer );
 351
 352         com::sun::star::lang::EventObject aFlushed(THISREF());
 353         while (aIter.hasMoreElements())
 354         try
 355         {
 356             static_cast< com::sun::star::util::XFlushListener* >(aIter.next())->flushed(aFlushed);
 357         }
 358         catch (uno::Exception & )
 359         {}
 360     }
 361 }
 362
 363 //--------------------------------------------------------------------------
 364 void SAL_CALL OConfigurationRegistry::addFlushListener( const com::sun::star::uno::Reference< com::sun::star::util::XFlushListener >& _rxListener ) throw(com::sun::star::uno::RuntimeException)
 365 {
 366     this->rBHelper.addListener(::getCppuType(&_rxListener),_rxListener);
 367 }
 368
 369 //--------------------------------------------------------------------------
 370 void SAL_CALL OConfigurationRegistry::removeFlushListener( const com::sun::star::uno::Reference< com::sun::star::util::XFlushListener >& _rxListener ) throw(com::sun::star::uno::RuntimeException)
 371 {
 372     this->rBHelper.removeListener(::getCppuType(&_rxListener),_rxListener);
 373 }
 374
 375 //..........................................................................
 376 }       // namespace configmgr
 377 //..........................................................................
 378
 379