/* -*- 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 .
*/
#pragma once
#include <sal/config.h>
#include <string_view>
#include <accelerators/storageholder.hxx>
#include <com/sun/star/embed/XStorage.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <i18nlangtag/languagetag.hxx>
namespace framework
{
/**
TODO document me
<layer>/global/<resourcetype>/<preset>.xml
<layer>/modules/<moduleid>/<resourcetype>/<preset>.xml
RESOURCETYPE PRESET TARGET
(share) (user)
"accelerator" "default" "current"
"word"
"excel"
"menubar" "default" "menubar"
*/
class PresetHandler
{
public:
/** @short this handler can provide different
types of configuration.
@descr Means: a global or a module dependent
or ... configuration.
*/
enum EConfigType
{
E_GLOBAL,
E_MODULES,
E_DOCUMENT
};
private:
/** @short can be used to create on needed uno resources. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
/** @short knows the type of provided configuration.
@descr e.g. global, modules, ...
*/
EConfigType m_eConfigType;
/** @short if we run in document mode, we can't use the global root storages!
We have to use a special document storage explicitly. */
StorageHolder m_lDocumentStorages;
/** @short holds the folder storage of the share layer alive,
where the current configuration set exists.
@descr Note: If this preset handler works in document mode
this member is meant relative to the document root...
not to the share layer root!
Further is defined, that m_xWorkingStorageUser
is equals to m_xWorkingStorageShare then!
*/
css::uno::Reference< css::embed::XStorage > m_xWorkingStorageShare;
/** @short global language-independent storage
*/
css::uno::Reference< css::embed::XStorage > m_xWorkingStorageNoLang;
/** @short holds the folder storage of the user layer alive,
where the current configuration set exists.
@descr Note: If this preset handler works in document mode
this member is meant relative to the document root...
not to the user layer root!
Further is defined, that m_xWorkingStorageUser
is equals to m_xWorkingStorageShare then!
*/
css::uno::Reference< css::embed::XStorage > m_xWorkingStorageUser;
/** @short knows the relative path from the root. */
OUString m_sRelPathShare;
OUString m_sRelPathUser;
/** @short in document mode, we open the storage as readonly at first,
then reopen it as readwrite the first time we store. */
bool m_bShouldReopenRWOnStore;
// native interface
public:
/** @short does nothing real.
@param xContext
points to a uno service manager, which is used internally
to create own needed uno resources.
*/
PresetHandler(css::uno::Reference< css::uno::XComponentContext > xContext);
/** @short copy ctor */
PresetHandler(
const PresetHandler& rCopy);
/** @short closes all open storages ... if user forgot that .-) */
~PresetHandler();
/** @short free all currently cache(!) storages. */
void forgetCachedStorages();
/** @short return access to the internally used and cached root storage.
@descr These root storages are the base of all further opened
presets and targets. They are provided here only, to support
older implementations, which base on them ...
getOrCreate...() - What does it mean?
Such root storage will be created one times only and
cached then internally till the last instance of such PresetHandler
dies.
@return css::embed::XStorage
which represent a root storage.
*/
css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageShare();
css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageUser();
/** @short provides access to the current working storages.
@descr Working storages are the "lowest" storages, where the
preset and target files exists.
@return css::embed::XStorage
which the current working storage.
*/
css::uno::Reference< css::embed::XStorage > getWorkingStorageUser()
const;
/** @short check if there is a parent storage well known for
the specified child storage and return it.
@param xChild
the child storage where a paranet storage should be searched for.
@return css::embed::XStorage
A valid storage if a paranet exists. NULL otherwise.
*/
css::uno::Reference< css::embed::XStorage > getParentStorageShare();
css::uno::Reference< css::embed::XStorage > getParentStorageUser ();
/** @short free all internal structures and let this handler
work on a new type of configuration sets.
@param eConfigType
differ between global or module dependent configuration.
@param sResourceType
differ between menubar/toolbar/accelerator/... configuration.
@param sModule
if sResourceType is set to a module dependent configuration,
it address the current application module.
@param xDocumentRoot
if sResourceType is set to E_DOCUMENT, this value points to the
root storage inside the document, where we can save our
configuration files. Note: that's not the real root of the document...
its only a sub storage. But we interpret it as our root storage.
@param rLanguageTag
in case this configuration supports localized entries,
the current locale must be set.
Localization will be represented as directory structure
of provided presets. Means: you call us with a preset name "default";
and we use e.g. "/en-US/default.xml" internally.
If no localization exists for this preset set, this class
will work in default mode - means "no locale" - automatically.
e.g. "/default.xml"
@throw css::uno::RuntimeException(!)
if the specified resource couldn't be located.
*/
void connectToResource( EConfigType eConfigType ,
std::u16string_view sResourceType ,
std::u16string_view sModule ,
const css::uno::Reference< css::embed::XStorage >& xDocumentRoot ,
const LanguageTag& rLanguageTag = LanguageTag(LANGUAGE_USER_PRIV_NOTRANSLATE));
/** @short try to copy the specified preset from the share
layer to the user layer and establish it as the
specified target.
@descr Means: copy share/.../<preset>.xml user/.../<target>.xml
Note: The target will be overwritten completely or
created as new by this operation!
@param sPreset
the ALIAS name of an existing preset.
@param sTarget
the ALIAS name of the target.
@throw css::container::NoSuchElementException
if the specified preset does not exists.
@throw css::io::IOException
if copying failed.
*/
void copyPresetToTarget(std::u16string_view sPreset,
std::u16string_view sTarget);
/** @short open the specified preset as stream object
and return it.
@descr Note: Because presets resist inside the share
layer, they will be opened readonly every time.
@param sPreset
the ALIAS name of an existing preset.
Accesses the global language-independent storage instead of the preset storage
@return The opened preset stream ... or NULL if the preset does not exists.
*/
css::uno::Reference< css::io::XStream > openPreset(std::u16string_view sPreset);
/** @short open the specified target as stream object
and return it.
@descr Note: Targets resist inside the user
layer. Normally they are opened in read/write mode.
But it will be opened readonly automatically if that isn't possible
(may be the file is write protected on the system ...).
@param sTarget
the ALIAS name of the target.
@return The opened target stream ... or NULL if the target does not exists
or couldn't be created as new one.
*/
css::uno::Reference< css::io::XStream > openTarget(
std::u16string_view sTarget, sal_Int32 nMode);
/** @short do anything which is necessary to flush all changes
back to disk.
@descr We have to call commit on all cached sub storages on the
path from the root storage upside down to the working storage
(which are not really used, but required to be holded alive!).
*/
void commitUserChanges();
/** TODO */
void addStorageListener(XMLBasedAcceleratorConfiguration* pListener);
void removeStorageListener(XMLBasedAcceleratorConfiguration* pListener);
/** @short check if the connected working user storage is readonly
@descr In document mode, we check whether the document root is readonly.
The document root is the parent of the working user storage.
We always initially open the working user storage as readonly in
document mode, but we may re-open it as readwrite later if we
need to. In other modes, we just directly check whether the working
user storage is readonly.
@return true if the connected working user storage is readonly, false if not
*/
bool isReadOnly();
// helper
private:
/** @short maybe reopen the working user storage as readwrite in document mode
@descr In document mode, we always initially open the working user storage
as readonly, and we remember whether we want to reopen it as readwrite
on the first store. This reopens the working user storage as readwrite
if we are in document mode, we want to, and we haven't yet.
*/
void maybeReopenStorageAsReadWrite();
/** @short open a config path ignoring errors (catching exceptions).
@descr We catch only normal exceptions here - no runtime exceptions.
@param sPath
the configuration path, which should be opened.
@param eMode
the open mode (READ/READWRITE)
@param bShare
force using of the share layer instead of the user layer.
@return An opened storage in case method was successful - null otherwise.
*/
static css::uno::Reference< css::embed::XStorage > impl_openPathIgnoringErrors(
const OU
String& sPath ,
sal_Int32 eMode ,
bool bShare);
/** @short try to find the specified locale inside list of possible ones.
@descr The list of possible locale values was e.g. retrieved from the system
(configuration, directory listing etcpp). The locale normally represent
the current office locale. This method search for a suitable item by using
different algorithm.
a) exact search
b) search with using fallbacks
@param lLocalizedValues
list of BCP47 language tags / locale codes
@param rLanguageTag
[IN ] the current office locale, which should be searched inside lLocalizedValues.
[OUT] in case fallbacks was allowed, it contains afterwards the fallback locale.
@param bAllowFallbacks
enable/disable using of fallbacks
@return An iterator, which points directly into lLocalizedValue list.
As a negative result the special iterator lLocalizedValues.end() will be returned.
*/
static ::std::vector< OUString >::const_iterator impl_findMatchingLocalizedValue(const ::std::vector< OUString >& lLocalizedValues,
OUString& rLanguageTag ,
bool bAllowFallbacks );
/** @short open a config path ignoring errors (catching exceptions).
@descr We catch only normal exceptions here - no runtime exceptions.
Further the path itself is tries in different versions (using locale
specific attributes).
e.g. "path/e-US" => "path/en" => "path/de"
@param sPath
the configuration path, which should be opened.
It's further used as out parameter too, so we can return the localized
path!
@param eMode
the open mode (READ/READWRITE)
@param bShare
force using of the share layer instead of the user layer.
@param rLanguageTag
[IN ] contains the start locale for searching localized sub dirs.
[OUT] contains the locale of a found localized sub dir
@param bAllowFallback
enable/disable fallback handling for locales
@return An opened storage in case method was successful - null otherwise.
*/
static css::uno::Reference< css::embed::XStorage > impl_openLocalizedPathIgnoringErrors(OUString& sPath ,
sal_Int32 eMode ,
bool bShare ,
OUString& rLanguageTag ,
bool bAllowFallback);
/** @short returns the names of all sub storages of specified storage.
@param xFolder
the base storage for this operation.
@return [vector< string >]
a list of folder names.
*/
static ::std::vector< OUString > impl_getSubFolderNames(const css::uno::Reference< css::embed::XStorage >& xFolder);
};
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
