office-gobmx/configmgr/source/configurationregistry.cxx
Noel Grandin be9a394884 clang-tidy modernize-pass-by-value in configmgr
Change-Id: If2e69c04e4d72ec6911fb435092275dbfffbf991
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/134752
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2022-05-23 10:52:11 +02:00

641 lines
20 KiB
C++

/* -*- 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 <sal/config.h>
#include <cassert>
#include <com/sun/star/beans/NamedValue.hpp>
#include <com/sun/star/container/NoSuchElementException.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/WrappedTargetRuntimeException.hpp>
#include <com/sun/star/registry/InvalidRegistryException.hpp>
#include <com/sun/star/registry/InvalidValueException.hpp>
#include <com/sun/star/registry/RegistryKeyType.hpp>
#include <com/sun/star/registry/RegistryValueType.hpp>
#include <com/sun/star/registry/XRegistryKey.hpp>
#include <com/sun/star/registry/XSimpleRegistry.hpp>
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/DeploymentException.hpp>
#include <com/sun/star/uno/Exception.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Type.hxx>
#include <com/sun/star/uno/TypeClass.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/uno/XInterface.hpp>
#include <com/sun/star/util/XFlushable.hpp>
#include <cppu/unotype.hxx>
#include <cppuhelper/exc_hlp.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <cppuhelper/weak.hxx>
#include <mutex>
#include <rtl/ustring.hxx>
#include <utility>
#include <sal/types.h>
namespace com::sun::star::util {
class XFlushListener;
}
namespace configmgr::configuration_registry {
namespace {
class Service:
public cppu::WeakImplHelper<
css::lang::XServiceInfo, css::registry::XSimpleRegistry,
css::util::XFlushable >
{
public:
explicit Service(css::uno::Reference< css::uno::XComponentContext > const & context);
private:
Service(const Service&) = delete;
Service& operator=(const Service&) = delete;
virtual ~Service() override {}
virtual OUString SAL_CALL getImplementationName() override
{ return "com.sun.star.comp.configuration.ConfigurationRegistry"; }
virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
{ return cppu::supportsService(this, ServiceName); }
virtual css::uno::Sequence< OUString > SAL_CALL
getSupportedServiceNames() override
{ return { "com.sun.star.configuration.ConfigurationRegistry" }; }
virtual OUString SAL_CALL getURL() override;
virtual void SAL_CALL open(
OUString const & rURL, sal_Bool bReadOnly, sal_Bool) override;
virtual sal_Bool SAL_CALL isValid() override;
virtual void SAL_CALL close() override;
virtual void SAL_CALL destroy() override;
virtual css::uno::Reference< css::registry::XRegistryKey > SAL_CALL
getRootKey() override;
virtual sal_Bool SAL_CALL isReadOnly() override;
virtual void SAL_CALL mergeKey(OUString const &, OUString const &) override;
virtual void SAL_CALL flush() override;
virtual void SAL_CALL addFlushListener(
css::uno::Reference< css::util::XFlushListener > const &) override;
virtual void SAL_CALL removeFlushListener(
css::uno::Reference< css::util::XFlushListener > const &) override;
void checkValid();
void checkValid_RuntimeException();
void doClose();
css::uno::Reference< css::lang::XMultiServiceFactory > provider_;
std::mutex mutex_;
css::uno::Reference< css::uno::XInterface > access_;
OUString url_;
bool readOnly_;
friend class RegistryKey;
};
class RegistryKey:
public cppu::WeakImplHelper< css::registry::XRegistryKey >
{
public:
RegistryKey(Service & service, css::uno::Any value):
service_(service), value_(std::move(value)) {}
private:
RegistryKey(const RegistryKey&) = delete;
RegistryKey& operator=(const RegistryKey&) = delete;
virtual ~RegistryKey() override {}
virtual OUString SAL_CALL getKeyName() override;
virtual sal_Bool SAL_CALL isReadOnly() override;
virtual sal_Bool SAL_CALL isValid() override;
virtual css::registry::RegistryKeyType SAL_CALL getKeyType(
OUString const &) override;
virtual css::registry::RegistryValueType SAL_CALL getValueType() override;
virtual sal_Int32 SAL_CALL getLongValue() override;
virtual void SAL_CALL setLongValue(sal_Int32) override;
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getLongListValue() override;
virtual void SAL_CALL setLongListValue(
css::uno::Sequence< sal_Int32 > const &) override;
virtual OUString SAL_CALL getAsciiValue() override;
virtual void SAL_CALL setAsciiValue(OUString const &) override;
virtual css::uno::Sequence< OUString > SAL_CALL getAsciiListValue() override;
virtual void SAL_CALL setAsciiListValue(
css::uno::Sequence< OUString > const &) override;
virtual OUString SAL_CALL getStringValue() override;
virtual void SAL_CALL setStringValue(OUString const &) override;
virtual css::uno::Sequence< OUString > SAL_CALL getStringListValue() override;
virtual void SAL_CALL setStringListValue(
css::uno::Sequence< OUString > const &) override;
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getBinaryValue() override;
virtual void SAL_CALL setBinaryValue(css::uno::Sequence< sal_Int8 > const &) override;
virtual css::uno::Reference< css::registry::XRegistryKey > SAL_CALL openKey(
OUString const & aKeyName) override;
virtual css::uno::Reference< css::registry::XRegistryKey > SAL_CALL
createKey(OUString const &) override;
virtual void SAL_CALL closeKey() override;
virtual void SAL_CALL deleteKey(OUString const &) override;
virtual
css::uno::Sequence< css::uno::Reference< css::registry::XRegistryKey > >
SAL_CALL openKeys() override;
virtual css::uno::Sequence< OUString > SAL_CALL getKeyNames() override;
virtual sal_Bool SAL_CALL createLink(
OUString const &, OUString const &) override;
virtual void SAL_CALL deleteLink(OUString const &) override;
virtual OUString SAL_CALL getLinkTarget(OUString const &) override;
virtual OUString SAL_CALL getResolvedName(
OUString const & aKeyName) override;
Service & service_;
css::uno::Any value_;
};
Service::Service(
css::uno::Reference< css::uno::XComponentContext > const & context)
: readOnly_(false)
{
assert(context.is());
try {
provider_.set(
context->getServiceManager()->createInstanceWithContext(
"com.sun.star.configuration.DefaultProvider", context),
css::uno::UNO_QUERY_THROW);
} catch (css::uno::RuntimeException &) {
throw;
} catch (css::uno::Exception & e) {
throw css::uno::DeploymentException(
("component context fails to supply service"
" com.sun.star.configuration.DefaultProvider of type"
" com.sun.star.lang.XMultiServiceFactory: " + e.Message),
context);
}
}
OUString Service::getURL() {
std::unique_lock g(mutex_);
checkValid_RuntimeException();
return url_;
}
void Service::open(OUString const & rURL, sal_Bool bReadOnly, sal_Bool)
{
//TODO: bCreate
std::unique_lock g(mutex_);
if (access_.is()) {
doClose();
}
css::uno::Sequence< css::uno::Any > args{ css::uno::Any(
css::beans::NamedValue("nodepath", css::uno::Any(rURL))) };
try {
access_ = provider_->createInstanceWithArguments(
(bReadOnly
? OUString("com.sun.star.configuration.ConfigurationAccess")
: OUString(
"com.sun.star.configuration.ConfigurationUpdateAccess")),
args);
} catch (css::uno::RuntimeException &) {
throw;
} catch (css::uno::Exception & e) {
css::uno::Any anyEx = cppu::getCaughtException();
throw css::lang::WrappedTargetRuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: open failed: " +
e.Message,
static_cast< cppu::OWeakObject * >(this), anyEx );
}
url_ = rURL;
readOnly_ = bReadOnly;
}
sal_Bool Service::isValid() {
std::unique_lock g(mutex_);
return access_.is();
}
void Service::close()
{
std::unique_lock g(mutex_);
checkValid();
doClose();
}
void Service::destroy()
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Reference< css::registry::XRegistryKey > Service::getRootKey()
{
std::unique_lock g(mutex_);
checkValid();
return new RegistryKey(*this, css::uno::Any(access_));
}
sal_Bool Service::isReadOnly() {
std::unique_lock g(mutex_);
checkValid_RuntimeException();
return readOnly_;
}
void Service::mergeKey(OUString const &, OUString const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
void Service::flush()
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
void Service::addFlushListener(
css::uno::Reference< css::util::XFlushListener > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
void Service::removeFlushListener(
css::uno::Reference< css::util::XFlushListener > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
void Service::checkValid() {
if (!access_.is()) {
throw css::registry::InvalidRegistryException(
"com.sun.star.configuration.ConfigurationRegistry: not valid",
static_cast< cppu::OWeakObject * >(this));
}
}
void Service::checkValid_RuntimeException() {
if (!access_.is()) {
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not valid",
static_cast< cppu::OWeakObject * >(this));
}
}
void Service::doClose() {
access_.clear();
}
OUString RegistryKey::getKeyName() {
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
css::uno::Reference< css::container::XNamed > named;
if (value_ >>= named) {
return named->getName();
}
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
sal_Bool RegistryKey::isReadOnly()
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
return service_.readOnly_; //TODO: read-only sub-nodes in update access?
}
sal_Bool RegistryKey::isValid() {
return service_.isValid();
}
css::registry::RegistryKeyType RegistryKey::getKeyType(OUString const &)
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
return css::registry::RegistryKeyType_KEY;
}
css::registry::RegistryValueType RegistryKey::getValueType()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
css::uno::Type t(value_.getValueType());
switch (t.getTypeClass()) {
case css::uno::TypeClass_LONG:
return css::registry::RegistryValueType_LONG;
case css::uno::TypeClass_STRING:
return css::registry::RegistryValueType_STRING;
case css::uno::TypeClass_SEQUENCE:
if (t == cppu::UnoType< css::uno::Sequence< sal_Int8 > >::get()) {
return css::registry::RegistryValueType_BINARY;
} else if (t == cppu::UnoType< css::uno::Sequence< sal_Int32 > >::get())
{
return css::registry::RegistryValueType_LONGLIST;
} else if (t ==
cppu::UnoType< css::uno::Sequence< OUString > >::get())
{
return css::registry::RegistryValueType_STRINGLIST;
}
[[fallthrough]];
default:
return css::registry::RegistryValueType_NOT_DEFINED;
}
}
sal_Int32 RegistryKey::getLongValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
sal_Int32 v = 0;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setLongValue(sal_Int32)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< sal_Int32 > RegistryKey::getLongListValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
css::uno::Sequence< sal_Int32 > v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setLongListValue(css::uno::Sequence< sal_Int32 > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
OUString RegistryKey::getAsciiValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
OUString v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setAsciiValue(OUString const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< OUString > RegistryKey::getAsciiListValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
css::uno::Sequence< OUString > v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setAsciiListValue(css::uno::Sequence< OUString > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
OUString RegistryKey::getStringValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
OUString v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setStringValue(OUString const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< OUString > RegistryKey::getStringListValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
css::uno::Sequence< OUString > v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setStringListValue(
css::uno::Sequence< OUString > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< sal_Int8 > RegistryKey::getBinaryValue()
{
std::unique_lock g(service_.mutex_);
service_.checkValid();
css::uno::Sequence< sal_Int8 > v;
if (value_ >>= v) {
return v;
}
throw css::registry::InvalidValueException(
"com.sun.star.configuration.ConfigurationRegistry",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::setBinaryValue(css::uno::Sequence< sal_Int8 > const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Reference< css::registry::XRegistryKey > RegistryKey::openKey(
OUString const & aKeyName)
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
css::uno::Reference< css::container::XHierarchicalNameAccess > access;
if (value_ >>= access) {
try {
return new RegistryKey(
service_, access->getByHierarchicalName(aKeyName));
} catch (css::container::NoSuchElementException &) {}
}
return css::uno::Reference< css::registry::XRegistryKey >();
}
css::uno::Reference< css::registry::XRegistryKey > RegistryKey::createKey(
OUString const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
void RegistryKey::closeKey()
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
}
void RegistryKey::deleteKey(OUString const &)
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< css::uno::Reference< css::registry::XRegistryKey > >
RegistryKey::openKeys()
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
css::uno::Sequence< OUString > RegistryKey::getKeyNames()
{
throw css::uno::RuntimeException(
"com.sun.star.configuration.ConfigurationRegistry: not implemented",
static_cast< cppu::OWeakObject * >(this));
}
sal_Bool RegistryKey::createLink(OUString const &, OUString const &)
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
return false;
}
void RegistryKey::deleteLink(OUString const &)
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
}
OUString RegistryKey::getLinkTarget(OUString const &)
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
return OUString();
}
OUString RegistryKey::getResolvedName(OUString const & aKeyName)
{
std::unique_lock g(service_.mutex_);
service_.checkValid_RuntimeException();
return aKeyName;
}
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
com_sun_star_comp_configuration_ConfigurationRegistry_get_implementation(
css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const&)
{
return cppu::acquire(new Service(context));
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */