configmgr/source/backend/updatedispatch.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: updatedispatch.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 "treefragment.hxx"
  35 #include "updatedispatch.hxx"
  36 #include "configpath.hxx"
  37 #include "node.hxx"
  38 #include "matchlocale.hxx"
  39
  40 #include <com/sun/star/configuration/backend/XUpdateHandler.hpp>
  41 #include <com/sun/star/configuration/backend/NodeAttribute.hpp>
  42
  43 namespace configmgr
  44 {
  45 // -----------------------------------------------------------------------------
  46     namespace backend
  47     {
  48 // -----------------------------------------------------------------------------
  49
  50 UpdateDispatcher::UpdateDispatcher(uno::Reference< backenduno::XUpdateHandler > const & _xUpdateHandler, rtl::OUString const & _aLocale)
  51 : m_pContextPath(NULL)
  52 , m_xUpdateHandler(_xUpdateHandler)
  53 , m_aLocale(_aLocale)
  54 , m_aElementName()
  55 , m_bInValueSet(false)
  56 , m_bInLocalizedValues(false)
  57 {
  58 }
  59 // -----------------------------------------------------------------------------
  60
  61 UpdateDispatcher::~UpdateDispatcher()
  62 {
  63 }
  64 // -----------------------------------------------------------------------------
  65
  66 void UpdateDispatcher::dispatchUpdate(configuration::AbsolutePath const & _aRootPath, SubtreeChange const& _anUpdate)
  67 {
  68     if (!m_xUpdateHandler.is())
  69     {
  70         rtl::OUString sMsg( RTL_CONSTASCII_USTRINGPARAM("ERROR: Cannot dispatch update - no handler found") );
  71         throw uno::RuntimeException(sMsg,NULL);
  72     }
  73
  74     OSL_PRECOND( !_aRootPath.isRoot(), "Cannot apply update, where root is outside a component" );
  75
  76     OSL_PRECOND( m_pContextPath == NULL, "Update Dispatcher already has a context path" );
  77     if (!_aRootPath.getParentPath().isRoot())
  78     {
  79         OSL_ENSURE(false,"Obsolete functionality used: starting update with non-empty context");
  80         m_pContextPath = &_aRootPath;
  81     }
  82
  83     this->startUpdate();
  84     this->applyToChange(_anUpdate);
  85     this->endUpdate();
  86
  87     m_pContextPath = NULL;
  88 }
  89 // -----------------------------------------------------------------------------
  90
  91 void UpdateDispatcher::startUpdate()
  92 {
  93     m_xUpdateHandler->startUpdate();
  94     m_bInValueSet = false;
  95     m_bInLocalizedValues = false;
  96     m_aElementName = rtl::OUString();
  97
  98     if (m_pContextPath)
  99     {
 100         std::vector<configuration::Path::Component>::const_reverse_iterator   it = m_pContextPath->begin();
 101         std::vector<configuration::Path::Component>::const_reverse_iterator   stop = m_pContextPath->end();
 102
 103         OSL_ASSERT(it != stop);
 104         --stop;
 105
 106         for ( ; it != stop; ++it)
 107         {
 108             m_xUpdateHandler->modifyNode(it->getName(),0,0,false);
 109         }
 110     }
 111 }
 112 // -----------------------------------------------------------------------------
 113
 114 void UpdateDispatcher::endUpdate()
 115 {
 116     if (m_pContextPath)
 117     {
 118         std::vector<configuration::Path::Component>::const_reverse_iterator   it = m_pContextPath->begin();
 119         std::vector<configuration::Path::Component>::const_reverse_iterator   stop = m_pContextPath->end();
 120
 121         OSL_ASSERT(it != stop);
 122         --stop;
 123
 124         for ( ; it != stop; ++it)
 125         {
 126             m_xUpdateHandler->endNode();
 127         }
 128     }
 129     m_xUpdateHandler->endUpdate();
 130 }
 131 // -----------------------------------------------------------------------------
 132
 133 void UpdateDispatcher::handle(ValueChange const& aValueNode)
 134 {
 135     // special case: doing members of a localized property (as set)
 136     if (m_bInLocalizedValues)
 137     {
 138         rtl::OUString aLocale = aValueNode.getNodeName();
 139
 140         if (aLocale.getLength())
 141         {
 142             if ( aValueNode.isToDefault() )
 143                 m_xUpdateHandler->resetPropertyValueForLocale( aLocale );
 144              else
 145                 m_xUpdateHandler->setPropertyValueForLocale( aValueNode.getNewValue(), aLocale );
 146         }
 147         else
 148         {
 149             if ( aValueNode.isToDefault() )
 150                 m_xUpdateHandler->resetPropertyValue( );
 151              else
 152                 m_xUpdateHandler->setPropertyValue( aValueNode.getNewValue() );
 153         }
 154         return;
 155     }
 156
 157     // normal case: updating a single property
 158     switch (aValueNode.getMode())
 159     {
 160     case ValueChange::wasDefault:
 161         if (aValueNode.isReplacedValue())
 162         {
 163
 164             OSL_ENSURE(m_bInValueSet, "UpdateDispatcher: Cannot add/replace a value in a nonextensible node");
 165             OSL_ENSURE(!aValueNode.isLocalizedValue(), "UpdateDispatcher: Cannot add a localized value in a layer");
 166
 167             sal_Int16 nAttr = getUpdateAttributes(aValueNode.getAttributes(),true);
 168
 169             if (aValueNode.getNewValue().hasValue())
 170             {
 171                 m_xUpdateHandler->addOrReplacePropertyWithValue( aValueNode.getNodeName(),
 172                                                                  nAttr,
 173                                                                  aValueNode.getNewValue());
 174             }
 175             else
 176             {
 177                 m_xUpdateHandler->addOrReplaceProperty( aValueNode.getNodeName(),
 178                                                         nAttr,
 179                                                         aValueNode.getValueType());
 180             }
 181
 182             break;
 183         }
 184         // else fall thru to changeValue case
 185
 186     case ValueChange::changeValue:
 187         {
 188             sal_Int16 nAttr     = getUpdateAttributes(aValueNode.getAttributes(),false);
 189             sal_Int16 nAttrMask = getUpdateAttributeMask(aValueNode.getAttributes());
 190
 191             m_xUpdateHandler->modifyProperty( aValueNode.getNodeName(),
 192                                                 nAttr, nAttrMask,
 193                                               aValueNode.getValueType() );
 194
 195             if (aValueNode.isLocalizedValue() && m_aLocale.getLength())
 196             {
 197                 m_xUpdateHandler->setPropertyValueForLocale( aValueNode.getNewValue(), m_aLocale );
 198             }
 199             else
 200             {
 201                 m_xUpdateHandler->setPropertyValue( aValueNode.getNewValue() );
 202             }
 203
 204             m_xUpdateHandler->endProperty();
 205         }
 206         break;
 207
 208     case ValueChange::setToDefault:
 209         m_xUpdateHandler->resetProperty( aValueNode.getNodeName() );
 210         break;
 211
 212     case ValueChange::changeDefault:
 213         OSL_ENSURE(false, "Illegal mode in ValueChange");
 214         break;
 215
 216     default:
 217         OSL_ENSURE(false, "Illegal mode in ValueChange");
 218         break;
 219     };
 220 }
 221 // -----------------------------------------------------------------------------
 222
 223 void UpdateDispatcher::handle(AddNode const& aAddNode)
 224 {
 225     rtl::Reference< data::TreeSegment > aAddedTree = aAddNode.getNewTree();
 226
 227     OSL_ENSURE(aAddedTree.is(), "AddNode has no new data -> cannot add anything");
 228
 229     OSL_ENSURE( ((m_bInValueSet||m_bInLocalizedValues) == aAddedTree->fragment->nodes[0].isValue()),
 230                 "Found added subtree in value set (extensible group)\n" );
 231
 232     this->visitTree(aAddedTree->fragment);
 233 }
 234 // -----------------------------------------------------------------------------
 235
 236 void UpdateDispatcher::handle(RemoveNode const& aRemoveNode)
 237 {
 238     OSL_ENSURE( !m_bInLocalizedValues, "UpdateDispatcher: Removing values for a specific locale is currently not supported");
 239
 240     rtl::Reference< data::TreeSegment > aRemovedTree = aRemoveNode.getRemovedTree();
 241
 242     OSL_ENSURE( !aRemovedTree.is() ||
 243                 ((m_bInValueSet||m_bInLocalizedValues) == aRemovedTree->fragment->nodes[0].isValue()),
 244                 "Found removed subtree in value set (extensible group)\n" );
 245
 246     if (m_bInLocalizedValues)
 247         OSL_TRACE("configmgr: UpdateDispatcher - Removing value for locale ignored");
 248
 249     else if (m_bInValueSet)
 250         m_xUpdateHandler->removeProperty( aRemoveNode.getNodeName() );
 251
 252     else
 253         m_xUpdateHandler->removeNode( aRemoveNode.getNodeName() );
 254 }
 255 // -----------------------------------------------------------------------------
 256
 257 void UpdateDispatcher::handle(SubtreeChange const& aSubtree)
 258 {
 259     OSL_ENSURE( !m_bInLocalizedValues, "UpdateDispatcher: A localized value cannot be a complete subtree");
 260     OSL_ENSURE( !m_bInValueSet, "UpdateDispatcher: A dynamic property cannot be a complete subtree");
 261
 262     sal_Int16 nAttr     = getUpdateAttributes(aSubtree.getAttributes(),false);
 263     sal_Int16 nAttrMask = getUpdateAttributeMask(aSubtree.getAttributes());
 264
 265     if (isLocalizedValueSet(aSubtree))
 266     {
 267         m_xUpdateHandler->modifyProperty( aSubtree.getNodeName(),
 268                                             nAttr, nAttrMask,
 269                                             uno::Type() );
 270
 271         m_bInLocalizedValues = true;
 272         this->applyToChildren(aSubtree);
 273         m_bInLocalizedValues = false;
 274
 275         m_xUpdateHandler->endProperty();
 276     }
 277
 278     else
 279     {
 280         m_xUpdateHandler->modifyNode( aSubtree.getNodeName(),
 281                                        nAttr, nAttrMask,
 282                                       aSubtree.isToDefault() );
 283
 284         m_bInValueSet = isValueSet(aSubtree);
 285         this->applyToChildren(aSubtree);
 286         m_bInValueSet = false;
 287
 288         m_xUpdateHandler->endNode();
 289     }
 290 }
 291 // -----------------------------------------------------------------------------
 292
 293 bool UpdateDispatcher::handle(sharable::ValueNode * node)
 294 {
 295     rtl::OUString aName;
 296
 297     // special case: doing members of a localized property (as set)
 298     if (m_bInLocalizedValues)
 299     {
 300         // the node name is the locale
 301         rtl::OUString aLocale;
 302         OSL_VERIFY(testReplacedAndGetName(sharable::node(node), aLocale)); // "Adding a localized subvalue but not as root of element tree"
 303
 304         if (aLocale.getLength() && ! localehelper::isDefaultLanguage(aLocale))
 305         {
 306             m_xUpdateHandler->setPropertyValueForLocale(node->getValue(), aLocale);
 307         }
 308         else
 309         {
 310             m_xUpdateHandler->setPropertyValue(node->getValue());
 311         }
 312     }
 313     else if (testReplacedAndGetName(sharable::node(node), aName) && sharable::node(node)->getAttributes().isRemovable()) // we must be inside a set of values
 314     {
 315
 316         OSL_ENSURE(!node->info.isLocalized(), "UpdateDispatcher: Cannot add a localized value in a layer .");
 317
 318         sal_Int16 nAttr = getUpdateAttributes(sharable::node(node)->getAttributes(),true);
 319
 320         if (!node->isNull())
 321         {
 322             m_xUpdateHandler->addOrReplacePropertyWithValue( aName,
 323                                                              nAttr,
 324                                                              node->getValue());
 325         }
 326         else
 327         {
 328             m_xUpdateHandler->addOrReplaceProperty( aName,
 329                                                     nAttr,
 330                                                     node->getValueType());
 331         }
 332     }
 333     else // normal case: updating a single property //Inserting set
 334     {
 335          sal_Int16 nAttr     = getUpdateAttributes(sharable::node(node)->getAttributes(),false);
 336         sal_Int16 nAttrMask = getUpdateAttributeMask(sharable::node(node)->getAttributes());
 337
 338         m_xUpdateHandler->modifyProperty( aName, nAttr, nAttrMask, node->getValueType() );
 339
 340         if (node->info.isLocalized() && m_aLocale.getLength())
 341         {
 342             m_xUpdateHandler->setPropertyValueForLocale(node->getValue(), m_aLocale);
 343         }
 344         else
 345         {
 346             m_xUpdateHandler->setPropertyValue(node->getValue());
 347         }
 348
 349         m_xUpdateHandler->endProperty();
 350     }
 351     return false;
 352 }
 353 // -----------------------------------------------------------------------------
 354
 355 bool UpdateDispatcher::handle(sharable::GroupNode * node)
 356 {
 357     OSL_ENSURE( !m_bInLocalizedValues, "UpdateDispatcher: A localized value cannot be a complete group");
 358
 359     rtl::OUString aName;
 360
 361     if ( testReplacedAndGetName(sharable::node(node), aName) )
 362     {
 363         sal_Int16 nAttr = getUpdateAttributes(sharable::node(node)->getAttributes(),true);
 364
 365         m_xUpdateHandler->addOrReplaceNode( aName, nAttr );
 366
 367         this->visitChildren(node);
 368
 369         m_xUpdateHandler->endNode();
 370     }
 371     else
 372     {
 373         sal_Int16 nAttr     = getUpdateAttributes(sharable::node(node)->getAttributes(),false);
 374         sal_Int16 nAttrMask = getUpdateAttributeMask(sharable::node(node)->getAttributes());
 375
 376         m_xUpdateHandler->modifyNode( aName, nAttr, nAttrMask, false );
 377
 378         this->visitChildren(node);
 379
 380         m_xUpdateHandler->endNode();
 381     }
 382     return false;
 383 }
 384 // -----------------------------------------------------------------------------
 385
 386 bool UpdateDispatcher::handle(sharable::SetNode * node)
 387 {
 388     OSL_ENSURE( !m_bInLocalizedValues, "UpdateDispatcher: A localized value cannot be a complete set");
 389
 390     rtl::OUString aName;
 391
 392     if ( testReplacedAndGetName(sharable::node(node), aName) )
 393     {
 394         OSL_ENSURE( !node->info.isLocalized(), "UpdateDispatcher: Cannot add a localized value in a layer." );
 395
 396         sal_Int16 nAttr     = getUpdateAttributes(sharable::node(node)->getAttributes(),true);
 397
 398         m_xUpdateHandler->addOrReplaceNode( aName, nAttr );
 399
 400         this->visitElements(node);
 401
 402         m_xUpdateHandler->endNode();
 403     }
 404     else
 405     {
 406         sal_Int16 nAttr     = getUpdateAttributes(sharable::node(node)->getAttributes(),false);
 407         sal_Int16 nAttrMask = getUpdateAttributeMask(sharable::node(node)->getAttributes());
 408
 409         if (node->info.isLocalized())
 410         {
 411             m_xUpdateHandler->modifyProperty( aName, nAttr, nAttrMask, uno::Type() );
 412
 413             m_bInLocalizedValues = true;
 414             this->visitElements(node);
 415             m_bInLocalizedValues = false;
 416
 417             m_xUpdateHandler->endProperty();
 418         }
 419
 420         else
 421         {
 422             m_xUpdateHandler->modifyNode( aName, nAttr, nAttrMask, false );
 423
 424             this->visitElements(node);
 425
 426             m_xUpdateHandler->endNode();
 427         }
 428     }
 429     return false;
 430 }
 431 // -----------------------------------------------------------------------------
 432
 433 bool UpdateDispatcher::testReplacedAndGetName(sharable::Node * node, rtl::OUString & _aName)
 434 {
 435     if (m_aElementName.getLength())
 436     {
 437         OSL_ENSURE( node->isFragmentRoot(), "ERROR - UpdateDispatcher: Found orphaned 'element' name for inner node");
 438         _aName = m_aElementName;
 439         m_aElementName = rtl::OUString();
 440         return true;
 441     }
 442     else
 443     {
 444         OSL_ENSURE(!node->isFragmentRoot(), "ERROR - UpdateDispatcher: Found no 'element' name for fragment root node");
 445         _aName = node->getName();
 446         return false;
 447     }
 448 }
 449 // -----------------------------------------------------------------------------
 450
 451 bool UpdateDispatcher::handle(sharable::TreeFragment * tree)
 452 {
 453     m_aElementName = tree->getName();
 454     bool done = SetVisitor::handle(tree); // dispatch to root node
 455     m_aElementName = rtl::OUString(); // clear - just to be safe
 456     return done;
 457 }
 458 // -----------------------------------------------------------------------------
 459
 460 sal_Int16 UpdateDispatcher::getUpdateAttributes(node::Attributes const & _aAttributes, bool bAdded)
 461 {
 462     namespace NodeAttribute = backenduno::NodeAttribute;
 463
 464     // no support for post-creation attribute changes yet
 465     if (!bAdded)
 466     {
 467         OSL_ENSURE( getUpdateAttributeMask(_aAttributes) == 0,
 468                     "Incomplete support for attribute changes" );
 469         return 0;
 470     }
 471
 472     sal_Int16 nResult = 0;
 473
 474     if (_aAttributes.isReadonly())
 475         nResult = NodeAttribute::READONLY;
 476
 477     if (_aAttributes.isFinalized())
 478         nResult |= NodeAttribute::FINALIZED;
 479
 480     if (!_aAttributes.isNullable())
 481         nResult |= NodeAttribute::MANDATORY;
 482
 483     return nResult;
 484 }
 485 // -----------------------------------------------------------------------------
 486
 487 sal_Int16 UpdateDispatcher::getUpdateAttributeMask(node::Attributes const & /*_aAttributes*/)
 488 {
 489     // no support for post-creation attribute changes yet
 490     return 0;
 491 }
 492 // -----------------------------------------------------------------------------
 493
 494 // -----------------------------------------------------------------------------
 495 // -----------------------------------------------------------------------------
 496     } // namespace backend
 497
 498 // -------------------------------------------------------------------------
 499 } // namespace configmgr