configaccess.cxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
 
#include <jobs/configaccess.hxx>
#include <services.h>
 
#include <com/sun/star/configuration/theDefaultProvider.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/util/XChangesBatch.hpp>
#include <utility>
 
#include <comphelper/diagnose_ex.hxx>
 
namespace framework{
 
ConfigAccess::ConfigAccess( /*IN*/ css::uno::Reference< css::uno::XComponentContext > xContext,
                            /*IN*/ OUString                                     sRoot )
    : m_xContext    (std::move( xContext))
    , m_sRoot       (std::move( sRoot    ))
    , m_eMode       ( E_CLOSED )
{
}
 
ConfigAccess::~ConfigAccess()
{
    close();
}
 
ConfigAccess::EOpenMode ConfigAccess::getMode() const
{
    std::unique_lock g(m_mutex);
    return m_eMode;
}
 
void ConfigAccess::open( /*IN*/ EOpenMode eMode )
{
    std::unique_lock g(m_mutex);
 
    // check if configuration is already open in the right mode.
    // By the way: Don't allow closing by using this method!
    if ( eMode == E_CLOSED || m_eMode == eMode )
        return;
 
    // We have to close the old access point without any question here.
    // It will be open again using the new mode.
    // can be called without checks! It does the checks by itself ...
    // e.g. for already closed or not opened configuration.
    // Flushing of all made changes will be done here too.
    closeImpl();
 
    // create the configuration provider, which provides sub access points
    css::uno::Reference< css::lang::XMultiServiceFactory > xConfigProvider = css::configuration::theDefaultProvider::get(m_xContext);
    css::beans::PropertyValue aParam;
    aParam.Name    = "nodepath";
    aParam.Value <<= m_sRoot;
 
    css::uno::Sequence< css::uno::Any > lParams{ css::uno::Any(aParam) };
 
    // open it
    try
    {
        if (eMode==E_READONLY)
            m_xConfig = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGREADACCESS  , lParams);
        else
        if (eMode==E_READWRITE)
            m_xConfig = xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGUPDATEACCESS, lParams);
    }
    catch(const css::uno::Exception&)
    {
        TOOLS_INFO_EXCEPTION("fwk", "open config");
    }
 
    m_eMode = E_CLOSED;
    if (m_xConfig.is())
        m_eMode = eMode;
}
 
void ConfigAccess::close()
{
    std::unique_lock g(m_mutex);
    closeImpl();
}
 
void ConfigAccess::closeImpl()
{
    // check already closed configuration
    if (m_xConfig.is())
    {
        css::uno::Reference< css::util::XChangesBatch > xFlush(m_xConfig, css::uno::UNO_QUERY);
        if (xFlush.is())
            xFlush->commitChanges();
        m_xConfig.clear();
        m_eMode   = E_CLOSED;
    }
}
 
const css::uno::Reference< css::uno::XInterface >& ConfigAccess::cfg()
{
    // must be synchronized from outside!
    // => no lock here ...
    return m_xConfig;
}
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */