configmgr/source/backend/layerupdatehandler.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: layerupdatehandler.cxx,v $
  10  * $Revision: 1.12 $
  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 "layerupdatehandler.hxx"
  35 #include "layerupdatemerger.hxx"
  36
  37 #ifndef CONFIGMGR_API_FACTORY_HXX_
  38 #include "confapifactory.hxx"
  39 #endif
  40 #include <com/sun/star/configuration/backend/XLayerHandler.hpp>
  41 #include <com/sun/star/configuration/backend/XLayer.hpp>
  42 #include <com/sun/star/beans/PropertyExistException.hpp>
  43
  44 // -----------------------------------------------------------------------------
  45 #define OUSTR( str ) rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( str ) )
  46 // -----------------------------------------------------------------------------
  47 namespace configmgr
  48 {
  49 // -----------------------------------------------------------------------------
  50     namespace backend
  51     {
  52 // -----------------------------------------------------------------------------
  53         namespace uno       = ::com::sun::star::uno;
  54         namespace lang      = ::com::sun::star::lang;
  55         namespace backenduno = ::com::sun::star::configuration::backend;
  56 // -----------------------------------------------------------------------------
  57
  58 uno::Reference< uno::XInterface > SAL_CALL instantiateUpdateMerger
  59 ( uno::Reference< uno::XComponentContext > const& xContext )
  60 {
  61     return * new LayerUpdateHandler( xContext );
  62 }
  63
  64 // -----------------------------------------------------------------------------
  65
  66 LayerUpdateHandler::LayerUpdateHandler(uno::Reference< uno::XComponentContext > const & _xContext)
  67 : UpdateService(_xContext)
  68 , m_aBuilder()
  69 {
  70 }
  71 // -----------------------------------------------------------------------------
  72
  73 LayerUpdateHandler::~LayerUpdateHandler()
  74 {
  75 }
  76 // -----------------------------------------------------------------------------
  77 inline
  78 void LayerUpdateHandler::checkBuilder(bool _bForProperty)
  79 {
  80     if ( m_aBuilder.isEmpty() )
  81         raiseMalformedDataException("LayerUpdateHandler: Illegal operation - no update is in progress");
  82
  83     if ( !m_aBuilder.isActive() )
  84         raiseMalformedDataException("LayerUpdateHandler: Illegal operation - no context for update available");
  85
  86     if ( m_aBuilder.isPropertyActive() != _bForProperty )
  87         raiseMalformedDataException("LayerUpdateHandler: Illegal operation - a property is in progress");
  88 }
  89 // -----------------------------------------------------------------------------
  90
  91 void LayerUpdateHandler::raiseMalformedDataException(sal_Char const * pMsg)
  92 {
  93     rtl::OUString sMsg = rtl::OUString::createFromAscii(pMsg);
  94     throw backenduno::MalformedDataException(sMsg,*this,uno::Any());
  95 }
  96 // -----------------------------------------------------------------------------
  97
  98 void LayerUpdateHandler::raiseNodeChangedBeforeException(sal_Char const * pMsg)
  99 {
 100     rtl::OUString sMsg = rtl::OUString::createFromAscii(pMsg);
 101     throw backenduno::MalformedDataException(sMsg,*this,uno::Any());
 102 }
 103 // -----------------------------------------------------------------------------
 104
 105 void LayerUpdateHandler::raisePropChangedBeforeException(sal_Char const * pMsg)
 106 {
 107     rtl::OUString sMsg = rtl::OUString::createFromAscii(pMsg);
 108     throw backenduno::MalformedDataException(sMsg,*this,uno::Any());
 109 }
 110 // -----------------------------------------------------------------------------
 111
 112 void LayerUpdateHandler::raisePropExistsException(sal_Char const * pMsg)
 113 {
 114     rtl::OUString sMsg = rtl::OUString::createFromAscii(pMsg);
 115     com::sun::star::beans::PropertyExistException e(sMsg,*this);
 116
 117     throw backenduno::MalformedDataException(sMsg,*this, uno::makeAny(e));
 118 }
 119 // -----------------------------------------------------------------------------
 120
 121 // XUpdateHandler
 122 void SAL_CALL
 123     LayerUpdateHandler::startUpdate(  )
 124         throw ( backenduno::MalformedDataException, lang::IllegalAccessException,
 125                 lang::WrappedTargetException, uno::RuntimeException)
 126 {
 127     this->checkSourceLayer();
 128     if (!m_aBuilder.init())
 129         raiseMalformedDataException("LayerUpdateHandler: Cannot start update - update is already in progress");
 130 }
 131 // -----------------------------------------------------------------------------
 132
 133 void SAL_CALL
 134     LayerUpdateHandler::endUpdate(  )
 135         throw ( backenduno::MalformedDataException, lang::IllegalAccessException,
 136                 lang::WrappedTargetException, uno::RuntimeException)
 137 {
 138     checkBuilder();
 139
 140     if (!m_aBuilder.finish())
 141         raiseMalformedDataException("LayerUpdateHandler: Cannot finish update - a node is still open.");
 142
 143     uno::Reference< backenduno::XLayer > xMergedLayer( LayerUpdateMerger::getMergedLayer(this->getSourceLayer(), m_aBuilder.result()) );
 144
 145     m_aBuilder.clear();
 146
 147     this->writeUpdatedLayer(xMergedLayer);
 148 }
 149 // -----------------------------------------------------------------------------
 150
 151 void SAL_CALL
 152     LayerUpdateHandler::modifyNode( const rtl::OUString& aName, sal_Int16 aAttributes, sal_Int16 aAttributeMask, sal_Bool bReset )
 153         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 154 {
 155     checkBuilder();
 156
 157     if (!m_aBuilder.modifyNode(aName,aAttributes,aAttributeMask,bReset))
 158         raiseNodeChangedBeforeException("LayerUpdateHandler: Cannot start node modification - node has already been changed.");
 159 }
 160 // -----------------------------------------------------------------------------
 161
 162 void SAL_CALL
 163     LayerUpdateHandler::addOrReplaceNode( const rtl::OUString& aName, sal_Int16 aAttributes )
 164         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 165 {
 166     checkBuilder();
 167
 168     if (!m_aBuilder.replaceNode(aName,aAttributes,NULL))
 169         raiseNodeChangedBeforeException("LayerUpdateHandler: Cannot start added/replaced node - node has already been changed.");
 170 }
 171 // -----------------------------------------------------------------------------
 172
 173 void SAL_CALL
 174     LayerUpdateHandler::addOrReplaceNodeFromTemplate( const rtl::OUString& aName, sal_Int16 aAttributes, const backenduno::TemplateIdentifier& aTemplate )
 175         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 176 {
 177     checkBuilder();
 178
 179     if (!m_aBuilder.replaceNode(aName,aAttributes,&aTemplate))
 180         raiseNodeChangedBeforeException("LayerUpdateHandler: Cannot start added/replaced node - node has already been changed.");
 181 }
 182 // -----------------------------------------------------------------------------
 183
 184 void SAL_CALL
 185     LayerUpdateHandler::endNode(  )
 186         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 187 {
 188     checkBuilder();
 189
 190     if (!m_aBuilder.finishNode())
 191     {
 192         OSL_ENSURE(m_aBuilder.isPropertyActive() || !m_aBuilder.isActive(), "LayerUpdateHandler: Unexpected failure mode for finishNode");
 193         if (m_aBuilder.isPropertyActive())
 194             raiseMalformedDataException("LayerUpdateHandler: Cannot finish node update - open property has not been ended.");
 195         else
 196             raiseMalformedDataException("LayerUpdateHandler: Cannot finish node update - no node has been started.");
 197     }
 198 }
 199 // -----------------------------------------------------------------------------
 200
 201 void SAL_CALL
 202     LayerUpdateHandler::removeNode( const rtl::OUString& aName )
 203         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 204 {
 205     checkBuilder();
 206
 207     if (!m_aBuilder.removeNode(aName))
 208         raiseNodeChangedBeforeException("LayerUpdateHandler: Cannot remove node - node has already been changed.");
 209 }
 210 // -----------------------------------------------------------------------------
 211
 212 void SAL_CALL
 213     LayerUpdateHandler:: modifyProperty( const rtl::OUString& aName, sal_Int16 aAttributes, sal_Int16 aAttributeMask, const uno::Type & aType )
 214         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 215 {
 216     checkBuilder(false);
 217
 218     if (!m_aBuilder.modifyProperty(aName,aAttributes,aAttributeMask, aType))
 219         raisePropChangedBeforeException("LayerUpdateHandler: Cannot start property modification - property has already been changed.");
 220 }
 221 // -----------------------------------------------------------------------------
 222
 223 void SAL_CALL
 224     LayerUpdateHandler:: setPropertyValue( const uno::Any& aValue )
 225         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 226 {
 227     checkBuilder(true); // already checks for open property
 228
 229     OSL_VERIFY( m_aBuilder.setPropertyValue(aValue) );
 230 }
 231 // -----------------------------------------------------------------------------
 232
 233 void SAL_CALL
 234     LayerUpdateHandler:: setPropertyValueForLocale( const uno::Any& aValue, const rtl::OUString& aLocale )
 235         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 236 {
 237     checkBuilder(true); // already checks for open property
 238
 239     OSL_VERIFY( m_aBuilder.setPropertyValueForLocale(aValue,aLocale) );
 240 }
 241 // -----------------------------------------------------------------------------
 242
 243 void SAL_CALL
 244     LayerUpdateHandler::resetPropertyValue( )
 245         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 246 {
 247     checkBuilder(true); // already checks for open property
 248
 249     OSL_VERIFY( m_aBuilder.resetPropertyValue() );
 250 }
 251 // -----------------------------------------------------------------------------
 252
 253 void SAL_CALL
 254     LayerUpdateHandler::resetPropertyValueForLocale( const rtl::OUString& aLocale )
 255         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 256 {
 257     checkBuilder(true); // already checks for open property
 258
 259     OSL_VERIFY( m_aBuilder.resetPropertyValueForLocale(aLocale) );
 260 }
 261 // -----------------------------------------------------------------------------
 262
 263 void SAL_CALL
 264     LayerUpdateHandler::endProperty(  )
 265         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 266 {
 267     checkBuilder(true); // already checks for open property
 268
 269     OSL_VERIFY ( m_aBuilder.finishProperty() );
 270 }
 271 // -----------------------------------------------------------------------------
 272
 273 void SAL_CALL
 274     LayerUpdateHandler::resetProperty( const rtl::OUString& aName )
 275         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 276 {
 277     if (!m_aBuilder.resetProperty(aName))
 278         raisePropChangedBeforeException("LayerUpdateHandler: Cannot reset property - property has already been changed.");
 279 }
 280 // -----------------------------------------------------------------------------
 281
 282 void SAL_CALL
 283     LayerUpdateHandler::addOrReplaceProperty( const rtl::OUString& aName, sal_Int16 aAttributes, const uno::Type& aType )
 284         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 285 {
 286     if (!m_aBuilder.addNullProperty(aName,aAttributes,aType))
 287         raisePropExistsException("LayerUpdateHandler: Cannot add property - property exists (and has already been changed).");
 288 }
 289 // -----------------------------------------------------------------------------
 290
 291 void SAL_CALL
 292     LayerUpdateHandler::addOrReplacePropertyWithValue( const rtl::OUString& aName, sal_Int16 aAttributes, const uno::Any& aValue )
 293         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 294 {
 295     if (!m_aBuilder.addProperty(aName,aAttributes,aValue))
 296         raisePropExistsException("LayerUpdateHandler: Cannot add property - property exists (and has already been changed).");
 297 }
 298 // -----------------------------------------------------------------------------
 299
 300 void SAL_CALL
 301     LayerUpdateHandler::removeProperty( const rtl::OUString& aName )
 302         throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 303 {
 304     // treat 'remove' as 'reset'. (Note: does not verify that this actually amounts to dropping the property)
 305     if (!m_aBuilder.resetProperty(aName))
 306         raisePropChangedBeforeException("LayerUpdateHandler: Cannot remove property - property has already been changed.");
 307 }
 308 // -----------------------------------------------------------------------------
 309
 310 // -----------------------------------------------------------------------------
 311 // -----------------------------------------------------------------------------
 312     } // namespace
 313
 314 // -----------------------------------------------------------------------------
 315 } // namespace
 316