blob: 92f93920a2d9d9edd1e7d78fc5b9e66451eabc79 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_unotools.hxx"
#include <unotools/confignode.hxx>
#include <unotools/configpathes.hxx>
#include <tools/diagnose_ex.h>
#include <osl/diagnose.h>
#include <com/sun/star/container/XHierarchicalName.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/util/XStringEscape.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <comphelper/extract.hxx>
#include <comphelper/componentcontext.hxx>
#include <comphelper/namedvaluecollection.hxx>
#include <rtl/string.hxx>
#if OSL_DEBUG_LEVEL > 0
#include <rtl/strbuf.hxx>
#endif
//........................................................................
namespace utl
{
//........................................................................
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::container;
//========================================================================
//= OConfigurationNode
//========================================================================
//------------------------------------------------------------------------
OConfigurationNode::OConfigurationNode(const Reference< XInterface >& _rxNode )
:m_bEscapeNames(sal_False)
{
OSL_ENSURE(_rxNode.is(), "OConfigurationNode::OConfigurationNode: invalid node interface!");
if (_rxNode.is())
{
// collect all interfaces necessary
m_xHierarchyAccess = Reference< XHierarchicalNameAccess >(_rxNode, UNO_QUERY);
m_xDirectAccess = Reference< XNameAccess >(_rxNode, UNO_QUERY);
// reset _all_ interfaces if _one_ of them is not supported
if (!m_xHierarchyAccess.is() || !m_xDirectAccess.is())
{
m_xHierarchyAccess = NULL;
m_xDirectAccess = NULL;
}
// now for the non-critical interfaces
m_xReplaceAccess = Reference< XNameReplace >(_rxNode, UNO_QUERY);
m_xContainerAccess = Reference< XNameContainer >(_rxNode, UNO_QUERY);
}
Reference< XComponent > xConfigNodeComp(m_xDirectAccess, UNO_QUERY);
if (xConfigNodeComp.is())
startComponentListening(xConfigNodeComp);
if (isValid())
setEscape(isSetNode());
}
//------------------------------------------------------------------------
OConfigurationNode::OConfigurationNode(const OConfigurationNode& _rSource)
:OEventListenerAdapter()
,m_xHierarchyAccess(_rSource.m_xHierarchyAccess)
,m_xDirectAccess(_rSource.m_xDirectAccess)
,m_xReplaceAccess(_rSource.m_xReplaceAccess)
,m_xContainerAccess(_rSource.m_xContainerAccess)
,m_bEscapeNames(_rSource.m_bEscapeNames)
,m_sCompletePath(_rSource.m_sCompletePath)
{
Reference< XComponent > xConfigNodeComp(m_xDirectAccess, UNO_QUERY);
if (xConfigNodeComp.is())
startComponentListening(xConfigNodeComp);
}
//------------------------------------------------------------------------
const OConfigurationNode& OConfigurationNode::operator=(const OConfigurationNode& _rSource)
{
stopAllComponentListening();
m_xHierarchyAccess = _rSource.m_xHierarchyAccess;
m_xDirectAccess = _rSource.m_xDirectAccess;
m_xContainerAccess = _rSource.m_xContainerAccess;
m_xReplaceAccess = _rSource.m_xReplaceAccess;
m_bEscapeNames = _rSource.m_bEscapeNames;
m_sCompletePath = _rSource.m_sCompletePath;
Reference< XComponent > xConfigNodeComp(m_xDirectAccess, UNO_QUERY);
if (xConfigNodeComp.is())
startComponentListening(xConfigNodeComp);
return *this;
}
//------------------------------------------------------------------------
void OConfigurationNode::_disposing( const EventObject& _rSource )
{
Reference< XComponent > xDisposingSource(_rSource.Source, UNO_QUERY);
Reference< XComponent > xConfigNodeComp(m_xDirectAccess, UNO_QUERY);
if (xDisposingSource.get() == xConfigNodeComp.get())
clear();
}
//------------------------------------------------------------------------
::rtl::OUString OConfigurationNode::getLocalName() const
{
::rtl::OUString sLocalName;
try
{
Reference< XNamed > xNamed( m_xDirectAccess, UNO_QUERY_THROW );
sLocalName = xNamed->getName();
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return sLocalName;
}
//------------------------------------------------------------------------
::rtl::OUString OConfigurationNode::getNodePath() const
{
::rtl::OUString sNodePath;
try
{
Reference< XHierarchicalName > xNamed( m_xDirectAccess, UNO_QUERY_THROW );
sNodePath = xNamed->getHierarchicalName();
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return sNodePath;
}
//------------------------------------------------------------------------
::rtl::OUString OConfigurationNode::normalizeName(const ::rtl::OUString& _rName, NAMEORIGIN _eOrigin) const
{
::rtl::OUString sName(_rName);
if (getEscape())
{
Reference< XStringEscape > xEscaper(m_xDirectAccess, UNO_QUERY);
if (xEscaper.is() && sName.getLength())
{
try
{
if (NO_CALLER == _eOrigin)
sName = xEscaper->escapeString(sName);
else
sName = xEscaper->unescapeString(sName);
}
catch(Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
}
}
return sName;
}
//------------------------------------------------------------------------
Sequence< ::rtl::OUString > OConfigurationNode::getNodeNames() const throw()
{
OSL_ENSURE(m_xDirectAccess.is(), "OConfigurationNode::getNodeNames: object is invalid!");
Sequence< ::rtl::OUString > aReturn;
if (m_xDirectAccess.is())
{
try
{
aReturn = m_xDirectAccess->getElementNames();
// normalize the names
::rtl::OUString* pNames = aReturn.getArray();
for (sal_Int32 i=0; i<aReturn.getLength(); ++i, ++pNames)
*pNames = normalizeName(*pNames, NO_CONFIGURATION);
}
catch(Exception&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::getNodeNames: caught a generic exception!");
}
}
return aReturn;
}
//------------------------------------------------------------------------
sal_Bool OConfigurationNode::removeNode(const ::rtl::OUString& _rName) const throw()
{
OSL_ENSURE(m_xContainerAccess.is(), "OConfigurationNode::removeNode: object is invalid!");
if (m_xContainerAccess.is())
{
try
{
::rtl::OUString sName = normalizeName(_rName, NO_CALLER);
m_xContainerAccess->removeByName(sName);
return sal_True;
}
catch (NoSuchElementException&)
{
#if OSL_DEBUG_LEVEL > 0
rtl::OStringBuffer aBuf( 256 );
aBuf.append("OConfigurationNode::removeNode: there is no element named!");
aBuf.append( rtl::OUStringToOString( _rName, RTL_TEXTENCODING_ASCII_US ) );
aBuf.append( "!" );
OSL_ENSURE(sal_False, aBuf.getStr());
#endif
}
catch (WrappedTargetException&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::removeNode: caught a WrappedTargetException!");
}
catch(Exception&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::removeNode: caught a generic exception!");
}
}
return sal_False;
}
//------------------------------------------------------------------------
OConfigurationNode OConfigurationNode::insertNode(const ::rtl::OUString& _rName,const Reference< XInterface >& _xNode) const throw()
{
if(_xNode.is())
{
try
{
::rtl::OUString sName = normalizeName(_rName, NO_CALLER);
m_xContainerAccess->insertByName(sName, makeAny(_xNode));
// if we're here, all was ok ...
return OConfigurationNode( _xNode );
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
// dispose the child if it has already been created, but could not be inserted
Reference< XComponent > xChildComp(_xNode, UNO_QUERY);
if (xChildComp.is())
try { xChildComp->dispose(); } catch(Exception&) { }
}
return OConfigurationNode();
}
//------------------------------------------------------------------------
OConfigurationNode OConfigurationNode::createNode(const ::rtl::OUString& _rName) const throw()
{
Reference< XSingleServiceFactory > xChildFactory(m_xContainerAccess, UNO_QUERY);
OSL_ENSURE(xChildFactory.is(), "OConfigurationNode::createNode: object is invalid or read-only!");
if (xChildFactory.is()) // implies m_xContainerAccess.is()
{
Reference< XInterface > xNewChild;
try
{
xNewChild = xChildFactory->createInstance();
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
return insertNode(_rName,xNewChild);
}
return OConfigurationNode();
}
//------------------------------------------------------------------------
OConfigurationNode OConfigurationNode::appendNode(const ::rtl::OUString& _rName,const OConfigurationNode& _aNewNode) const throw()
{
return insertNode(_rName,_aNewNode.m_xDirectAccess);
}
//------------------------------------------------------------------------
OConfigurationNode OConfigurationNode::openNode(const ::rtl::OUString& _rPath) const throw()
{
OSL_ENSURE(m_xDirectAccess.is(), "OConfigurationNode::openNode: object is invalid!");
OSL_ENSURE(m_xHierarchyAccess.is(), "OConfigurationNode::openNode: object is invalid!");
try
{
::rtl::OUString sNormalized = normalizeName(_rPath, NO_CALLER);
Reference< XInterface > xNode;
if (m_xDirectAccess.is() && m_xDirectAccess->hasByName(sNormalized))
{
if (!::cppu::extractInterface(xNode, m_xDirectAccess->getByName(sNormalized)))
OSL_ENSURE(sal_False, "OConfigurationNode::openNode: could not open the node!");
}
else if (m_xHierarchyAccess.is())
{
if (!::cppu::extractInterface(xNode, m_xHierarchyAccess->getByHierarchicalName(_rPath)))
OSL_ENSURE(sal_False, "OConfigurationNode::openNode: could not open the node!");
}
if (xNode.is())
return OConfigurationNode( xNode );
}
catch(NoSuchElementException& e)
{
(void)e;
#if OSL_DEBUG_LEVEL > 0
rtl::OStringBuffer aBuf( 256 );
aBuf.append("OConfigurationNode::openNode: there is no element named ");
aBuf.append( rtl::OUStringToOString( _rPath, RTL_TEXTENCODING_ASCII_US ) );
aBuf.append("!");
OSL_ENSURE(sal_False, aBuf.getStr());
#endif
}
catch(Exception&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::openNode: caught an exception while retrieving the node!");
}
return OConfigurationNode();
}
//------------------------------------------------------------------------
void OConfigurationNode::setEscape(sal_Bool _bEnable)
{
m_bEscapeNames = _bEnable && Reference< XStringEscape >::query(m_xDirectAccess).is();
}
//------------------------------------------------------------------------
sal_Bool OConfigurationNode::isSetNode() const
{
sal_Bool bIsSet = sal_False;
Reference< XServiceInfo > xSI(m_xHierarchyAccess, UNO_QUERY);
if (xSI.is())
{
try { bIsSet = xSI->supportsService(::rtl::OUString::createFromAscii("com.sun.star.configuration.SetAccess")); }
catch(Exception&) { }
}
return bIsSet;
}
//---------------------------------------------------------------------
//--- 20.08.01 19:03:20 -----------------------------------------------
sal_Bool OConfigurationNode::hasByHierarchicalName( const ::rtl::OUString& _rName ) const throw()
{
OSL_ENSURE( m_xHierarchyAccess.is(), "OConfigurationNode::hasByHierarchicalName: no hierarchy access!" );
try
{
if ( m_xHierarchyAccess.is() )
{
::rtl::OUString sName = normalizeName( _rName, NO_CALLER );
return m_xHierarchyAccess->hasByHierarchicalName( sName );
}
}
catch(Exception&)
{
}
return sal_False;
}
//------------------------------------------------------------------------
sal_Bool OConfigurationNode::hasByName(const ::rtl::OUString& _rName) const throw()
{
OSL_ENSURE(m_xDirectAccess.is(), "OConfigurationNode::hasByName: object is invalid!");
try
{
::rtl::OUString sName = normalizeName(_rName, NO_CALLER);
if (m_xDirectAccess.is())
return m_xDirectAccess->hasByName(sName);
}
catch(Exception&)
{
}
return sal_False;
}
//------------------------------------------------------------------------
sal_Bool OConfigurationNode::setNodeValue(const ::rtl::OUString& _rPath, const Any& _rValue) const throw()
{
sal_Bool bResult = false;
OSL_ENSURE(m_xReplaceAccess.is(), "OConfigurationNode::setNodeValue: object is invalid!");
if (m_xReplaceAccess.is())
{
try
{
// check if _rPath is a level-1 path
::rtl::OUString sNormalizedName = normalizeName(_rPath, NO_CALLER);
if (m_xReplaceAccess->hasByName(sNormalizedName))
{
m_xReplaceAccess->replaceByName(sNormalizedName, _rValue);
bResult = true;
}
// check if the name refers to a indirect descendant
else if (m_xHierarchyAccess.is() && m_xHierarchyAccess->hasByHierarchicalName(_rPath))
{
OSL_ASSERT(_rPath.getLength());
::rtl::OUString sParentPath, sLocalName;
if ( splitLastFromConfigurationPath(_rPath, sParentPath, sLocalName) )
{
OConfigurationNode aParentAccess = openNode(sParentPath);
if (aParentAccess.isValid())
bResult = aParentAccess.setNodeValue(sLocalName, _rValue);
}
else
{
m_xReplaceAccess->replaceByName(sLocalName, _rValue);
bResult = true;
}
}
}
catch(IllegalArgumentException&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::setNodeValue: could not replace the value: caught an IllegalArgumentException!");
}
catch(NoSuchElementException&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::setNodeValue: could not replace the value: caught a NoSuchElementException!");
}
catch(WrappedTargetException&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::setNodeValue: could not replace the value: caught a WrappedTargetException!");
}
catch(Exception&)
{
OSL_ENSURE(sal_False, "OConfigurationNode::setNodeValue: could not replace the value: caught a generic Exception!");
}
}
return bResult;
}
//------------------------------------------------------------------------
Any OConfigurationNode::getNodeValue(const ::rtl::OUString& _rPath) const throw()
{
OSL_ENSURE(m_xDirectAccess.is(), "OConfigurationNode::hasByName: object is invalid!");
OSL_ENSURE(m_xHierarchyAccess.is(), "OConfigurationNode::hasByName: object is invalid!");
Any aReturn;
try
{
::rtl::OUString sNormalizedPath = normalizeName(_rPath, NO_CALLER);
if (m_xDirectAccess.is() && m_xDirectAccess->hasByName(sNormalizedPath) )
{
aReturn = m_xDirectAccess->getByName(sNormalizedPath);
}
else if (m_xHierarchyAccess.is())
{
aReturn = m_xHierarchyAccess->getByHierarchicalName(_rPath);
}
}
catch(const NoSuchElementException&)
{
DBG_UNHANDLED_EXCEPTION();
}
return aReturn;
}
//------------------------------------------------------------------------
void OConfigurationNode::clear() throw()
{
m_xHierarchyAccess.clear();
m_xDirectAccess.clear();
m_xReplaceAccess.clear();
m_xContainerAccess.clear();
}
//========================================================================
//= helper
//========================================================================
namespace
{
//--------------------------------------------------------------------
static const ::rtl::OUString& lcl_getProviderServiceName( )
{
static ::rtl::OUString s_sProviderServiceName( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.configuration.ConfigurationProvider" ) );
return s_sProviderServiceName;
}
//--------------------------------------------------------------------
Reference< XMultiServiceFactory > lcl_getConfigProvider( const ::comphelper::ComponentContext& i_rContext )
{
try
{
Reference< XMultiServiceFactory > xProvider( i_rContext.createComponent( lcl_getProviderServiceName() ), UNO_QUERY_THROW );
return xProvider;
}
catch ( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return NULL;
}
//--------------------------------------------------------------------
Reference< XInterface > lcl_createConfigurationRoot( const Reference< XMultiServiceFactory >& i_rxConfigProvider,
const ::rtl::OUString& i_rNodePath, const bool i_bUpdatable, const sal_Int32 i_nDepth, const bool i_bLazyWrite )
{
ENSURE_OR_RETURN( i_rxConfigProvider.is(), "invalid provider", NULL );
try
{
::comphelper::NamedValueCollection aArgs;
aArgs.put( "nodepath", i_rNodePath );
aArgs.put( "lazywrite", i_bLazyWrite );
aArgs.put( "depth", i_nDepth );
::rtl::OUString sAccessService = ::rtl::OUString::createFromAscii(
i_bUpdatable
? "com.sun.star.configuration.ConfigurationUpdateAccess"
: "com.sun.star.configuration.ConfigurationAccess" );
Reference< XInterface > xRoot(
i_rxConfigProvider->createInstanceWithArguments( sAccessService, aArgs.getWrappedPropertyValues() ),
UNO_SET_THROW
);
return xRoot;
}
catch ( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return NULL;
}
}
//========================================================================
//= OConfigurationTreeRoot
//========================================================================
//------------------------------------------------------------------------
OConfigurationTreeRoot::OConfigurationTreeRoot( const Reference< XChangesBatch >& _rxRootNode )
:OConfigurationNode( _rxRootNode.get() )
,m_xCommitter(_rxRootNode)
{
}
//------------------------------------------------------------------------
OConfigurationTreeRoot::OConfigurationTreeRoot( const Reference< XInterface >& _rxRootNode )
:OConfigurationNode( _rxRootNode )
,m_xCommitter( _rxRootNode, UNO_QUERY )
{
}
//------------------------------------------------------------------------
OConfigurationTreeRoot::OConfigurationTreeRoot( const ::comphelper::ComponentContext& i_rContext, const sal_Char* i_pAsciiNodePath, const bool i_bUpdatable )
:OConfigurationNode( lcl_createConfigurationRoot( lcl_getConfigProvider( i_rContext.getLegacyServiceFactory() ),
::rtl::OUString::createFromAscii( i_pAsciiNodePath ), i_bUpdatable, -1, false ).get() )
,m_xCommitter()
{
if ( i_bUpdatable )
{
m_xCommitter.set( getUNONode(), UNO_QUERY );
OSL_ENSURE( m_xCommitter.is(), "OConfigurationTreeRoot::OConfigurationTreeRoot: could not create an updatable node!" );
}
}
//------------------------------------------------------------------------
OConfigurationTreeRoot::OConfigurationTreeRoot( const ::comphelper::ComponentContext& i_rContext, const ::rtl::OUString& i_rNodePath, const bool i_bUpdatable )
:OConfigurationNode( lcl_createConfigurationRoot( lcl_getConfigProvider( i_rContext.getLegacyServiceFactory() ),
i_rNodePath, i_bUpdatable, -1, false ).get() )
,m_xCommitter()
{
if ( i_bUpdatable )
{
m_xCommitter.set( getUNONode(), UNO_QUERY );
OSL_ENSURE( m_xCommitter.is(), "OConfigurationTreeRoot::OConfigurationTreeRoot: could not create an updatable node!" );
}
}
//------------------------------------------------------------------------
void OConfigurationTreeRoot::clear() throw()
{
OConfigurationNode::clear();
m_xCommitter.clear();
}
//------------------------------------------------------------------------
sal_Bool OConfigurationTreeRoot::commit() const throw()
{
OSL_ENSURE(isValid(), "OConfigurationTreeRoot::commit: object is invalid!");
if (!isValid())
return sal_False;
OSL_ENSURE(m_xCommitter.is(), "OConfigurationTreeRoot::commit: I'm a readonly node!");
if (!m_xCommitter.is())
return sal_False;
try
{
m_xCommitter->commitChanges();
return sal_True;
}
catch(const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
return sal_False;
}
//------------------------------------------------------------------------
OConfigurationTreeRoot OConfigurationTreeRoot::createWithProvider(const Reference< XMultiServiceFactory >& _rxConfProvider, const ::rtl::OUString& _rPath, sal_Int32 _nDepth, CREATION_MODE _eMode, sal_Bool _bLazyWrite)
{
Reference< XInterface > xRoot( lcl_createConfigurationRoot(
_rxConfProvider, _rPath, _eMode != CM_READONLY, _nDepth, _bLazyWrite ) );
if ( xRoot.is() )
return OConfigurationTreeRoot( xRoot );
return OConfigurationTreeRoot();
}
//------------------------------------------------------------------------
OConfigurationTreeRoot OConfigurationTreeRoot::createWithServiceFactory( const Reference< XMultiServiceFactory >& _rxORB, const ::rtl::OUString& _rPath, sal_Int32 _nDepth, CREATION_MODE _eMode, sal_Bool _bLazyWrite )
{
return createWithProvider( lcl_getConfigProvider( _rxORB ), _rPath, _nDepth, _eMode, _bLazyWrite );
}
//------------------------------------------------------------------------
OConfigurationTreeRoot OConfigurationTreeRoot::tryCreateWithServiceFactory( const Reference< XMultiServiceFactory >& _rxORB,
const ::rtl::OUString& _rPath, sal_Int32 _nDepth , CREATION_MODE _eMode , sal_Bool _bLazyWrite )
{
OSL_ENSURE( _rxORB.is(), "OConfigurationTreeRoot::tryCreateWithServiceFactory: invalid service factory!" );
if ( _rxORB.is() )
{
try
{
Reference< XMultiServiceFactory > xConfigFactory( _rxORB->createInstance( lcl_getProviderServiceName( ) ), UNO_QUERY );
if ( xConfigFactory.is() )
return createWithProvider( xConfigFactory, _rPath, _nDepth, _eMode, _bLazyWrite );
}
catch(const Exception&)
{
// silence this, 'cause the contract of this method states "no assertions"
}
}
return OConfigurationTreeRoot();
}
//........................................................................
} // namespace utl
//........................................................................