configmgr/source/treemgr/roottree.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: roottree.cxx,v $
  10  * $Revision: 1.21 $
  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 "roottree.hxx"
  36 #include "roottreeimpl.hxx"
  37 #include "viewaccess.hxx"
  38 #include "viewfactory.hxx"
  39 #include "noderef.hxx"
  40 #include "nodechangeinfo.hxx"
  41 #include "treechangelist.hxx"
  42
  43 namespace configmgr
  44 {
  45     namespace configuration
  46     {
  47 //-----------------------------------------------------------------------------
  48 // factory methods
  49 //-----------------------------------------------------------------------------
  50
  51 rtl::Reference< Tree > createReadOnlyTree(      AbsolutePath const& aRootPath,
  52                                             sharable::Node * cacheNode,
  53                                 unsigned int nDepth,
  54                 TemplateProvider const& aTemplateProvider)
  55 {
  56     return new RootTree(view::createReadOnlyStrategy(),
  57                       aRootPath, cacheNode, nDepth,
  58                       aTemplateProvider
  59                       );
  60 }
  61 //-----------------------------------------------------------------------------
  62
  63 rtl::Reference< Tree > createUpdatableTree(     AbsolutePath const& aRootPath,
  64                                             sharable::Node * cacheNode,
  65                                 unsigned int nDepth,
  66                                 TemplateProvider const& aTemplateProvider)
  67 {
  68     return new RootTree(view::createDeferredChangeStrategy(),
  69                       aRootPath, cacheNode, nDepth,
  70                       aTemplateProvider
  71                       );
  72 }
  73
  74 //-----------------------------------------------------------------------------
  75 // update on notify method
  76 //-----------------------------------------------------------------------------
  77 bool adjustToChanges(   NodeChangesInformation& rLocalChanges,
  78                         rtl::Reference< Tree > const& aBaseTree, NodeRef const& aBaseNode,
  79                         SubtreeChange const& aExternalChange)
  80 {
  81     OSL_PRECOND( !isEmpty(aBaseTree.get()), "ERROR: Configuration: Tree operation requires a valid Tree");
  82     OSL_PRECOND( aBaseNode.isValid() && aBaseTree->isValidNode(aBaseNode.getOffset()), "ERROR: Configuration: NodeRef does not match Tree");
  83
  84     if (!isEmpty(aBaseTree.get()))
  85     {
  86         OSL_ENSURE(rLocalChanges.empty(), "Should pass empty container to adjustToChanges(...)");
  87
  88         view::ViewTreeAccess(aBaseTree.get()).adjustToChanges(rLocalChanges, aBaseNode, aExternalChange);
  89
  90         return !rLocalChanges.empty();
  91     }
  92     else
  93         return false;
  94 }
  95 //-----------------------------------------------------------------------------
  96
  97 //-----------------------------------------------------------------------------
  98 // class CommitHelper
  99 //-----------------------------------------------------------------------------
 100 struct CommitHelper::Data
 101 {
 102     std::vector< rtl::Reference<ElementTree> > m_aRemovedElements; // filled to keep the elements alive 'till after notification
 103 };
 104
 105 //-----------------------------------------------------------------------------
 106 CommitHelper::CommitHelper(rtl::Reference< Tree > const& aTree)
 107 : m_pData(  )
 108 , m_pTree( aTree.get() )
 109 {
 110     OSL_ENSURE(m_pTree, "INTERNAL ERROR: Unexpected NULL tree in commit helper");
 111 }
 112 //-----------------------------------------------------------------------------
 113 CommitHelper::~CommitHelper()
 114 {
 115 }
 116
 117 //-----------------------------------------------------------------------------
 118 bool CommitHelper::prepareCommit(TreeChangeList& rChangeList)
 119 {
 120     OSL_ENSURE(m_pTree,"ERROR: CommitHelper: Cannot commit without a tree");
 121     if (m_pTree == NULL)
 122         return false;
 123
 124     OSL_ENSURE(m_pData.get() == NULL,"ERROR: CommitHelper: Need to reset before reusing");
 125     m_pData.reset( new Data() );
 126
 127     // get and check the changes
 128     std::auto_ptr<SubtreeChange> pTreeChange(view::ViewTreeAccess(m_pTree).preCommitChanges(m_pData->m_aRemovedElements));
 129     if (pTreeChange.get() == NULL)
 130         return false;
 131
 132     // find the name and path of the change
 133     OSL_ENSURE(m_pTree->getSimpleRootName() == pTreeChange->getNodeName(), "ERROR in Commit: Change name mismatch");
 134
 135     // now fill the TreeChangeList
 136     rChangeList.setRootPath( m_pTree->getRootPath() );
 137     rChangeList.root.swap( *pTreeChange );
 138
 139     return true;
 140 }
 141 //-----------------------------------------------------------------------------
 142
 143 void CommitHelper::finishCommit(TreeChangeList& rChangeList)
 144 {
 145     OSL_ENSURE(m_pTree,"INTERNAL ERROR: Nothing to finish without a tree");
 146
 147     // find the name and path of the change
 148     AbsolutePath aPath = m_pTree->getRootPath();
 149
 150     OSL_ENSURE( rChangeList.getRootNodePath().toString() == aPath.toString(), "ERROR: FinishCommit cannot handle rebased changes trees");
 151     if ( !matches(rChangeList.getRootNodePath(), aPath) )
 152         throw configuration::Exception("INTERNAL ERROR: FinishCommit cannot handle rebased changes trees");
 153
 154     view::ViewTreeAccess(m_pTree).finishCommit(rChangeList.root);
 155 }
 156 //-----------------------------------------------------------------------------
 157
 158 void CommitHelper::failedCommit(TreeChangeList& rChangeList)
 159 {
 160     OSL_ENSURE(m_pTree,"INTERNAL ERROR: Nothing to finish without a tree");
 161
 162     AbsolutePath aPath = m_pTree->getRootPath();
 163
 164     OSL_ENSURE( rChangeList.getRootNodePath().toString() == aPath.toString(), "ERROR: FinishCommit cannot handle rebased changes trees");
 165     if ( !matches(rChangeList.getRootNodePath(), aPath) )
 166         throw configuration::Exception("INTERNAL ERROR: FinishCommit cannot handle rebased changes trees");
 167
 168     view::ViewTreeAccess(m_pTree).recoverFailedCommit(rChangeList.root);
 169 }
 170 //-----------------------------------------------------------------------------
 171
 172     }
 173 }
 174