configmgr/source/api2/committer.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: committer.cxx,v $
  10  * $Revision: 1.18 $
  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 #include "committer.hxx"
  35 #include "apitreeimplobj.hxx"
  36 #include "providerimpl.hxx"
  37 #include "roottree.hxx"
  38 #include "treechangelist.hxx"
  39
  40 namespace configmgr
  41 {
  42 //-----------------------------------------------------------------------------
  43     namespace configapi
  44     {
  45 //-----------------------------------------------------------------------------
  46 namespace
  47 {
  48     //-------------------------------------------------------------------------
  49     struct NotifyDisabler
  50     {
  51         ApiRootTreeImpl& m_rTree;
  52         bool m_bOldState;
  53
  54         NotifyDisabler(ApiRootTreeImpl& rTree)
  55         : m_rTree(rTree)
  56         , m_bOldState(rTree .enableNotification(false) )
  57         {
  58         }
  59
  60         ~NotifyDisabler()
  61         {
  62             m_rTree.enableNotification(m_bOldState);
  63         }
  64     };
  65     //-------------------------------------------------------------------------
  66 }
  67
  68 //-----------------------------------------------------------------------------
  69 // class Committer
  70 //-----------------------------------------------------------------------------
  71
  72 Committer::Committer(ApiRootTreeImpl& rTree)
  73 : m_rTree(rTree)
  74 {}
  75 //-----------------------------------------------------------------------------
  76
  77 OProviderImpl * Committer::getUpdateProvider()
  78 {
  79     return &m_rTree.getApiTree().getProvider().getProviderImpl();
  80 }
  81
  82 //-----------------------------------------------------------------------------
  83 void Committer::commit()
  84 {
  85     ApiTreeImpl& rApiTree = m_rTree.getApiTree();
  86
  87     OSL_PRECOND(!m_rTree.getLocation().isRoot(),"INTERNAL ERROR: Empty location used.");
  88     OSL_PRECOND(m_rTree.getOptions().isValid(),"INTERNAL ERROR: Invalid Options used.");
  89
  90     if (!m_rTree.getOptions().isValid()) return;
  91
  92     RequestOptions aOptions = m_rTree.getOptions()->getRequestOptions();
  93
  94     OProviderImpl * pUpdateProvider = getUpdateProvider();
  95     OSL_ASSERT(pUpdateProvider);
  96
  97     rtl::Reference< configuration::Tree > aTree( rApiTree.getTree());
  98     if (!aTree->hasChanges()) return;
  99
 100     TreeChangeList      aChangeList(aOptions,
 101                     aTree->getRootPath(),
 102                     aTree->getAttributes(aTree->getRootNode()));
 103
 104     // now do the commit
 105     configuration::CommitHelper aHelper(rApiTree.getTree());
 106     if (aHelper.prepareCommit(aChangeList))
 107     try
 108     {
 109         pUpdateProvider->updateTree(aChangeList);
 110
 111         aHelper.finishCommit(aChangeList);
 112
 113         NotifyDisabler  aDisableNotify(m_rTree);        // do not notify self
 114         pUpdateProvider->saveAndNotifyUpdate(aChangeList);
 115     }
 116     catch(...)
 117     {
 118         // should be a special clean-up routine, but for now we just need a consistent state
 119         try
 120         {
 121             aHelper.failedCommit(aChangeList);
 122         }
 123         catch(configuration::Exception&)
 124         {
 125             OSL_ENSURE(false, "Cleanup really should not throw");
 126         }
 127         throw;
 128     }
 129 }
 130 //-----------------------------------------------------------------------------
 131     }
 132 }
 133