377 lines
13 KiB
C++
377 lines
13 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 "ConfigurationUpdater.hxx"
|
|
#include "ConfigurationTracer.hxx"
|
|
#include "ConfigurationClassifier.hxx"
|
|
#include "ConfigurationControllerBroadcaster.hxx"
|
|
#include "ConfigurationControllerResourceManager.hxx"
|
|
#include <framework/Configuration.hxx>
|
|
#include <framework/FrameworkHelper.hxx>
|
|
#include <DrawController.hxx>
|
|
|
|
#include <com/sun/star/drawing/framework/XControllerManager.hpp>
|
|
#include <comphelper/scopeguard.hxx>
|
|
#include <comphelper/diagnose_ex.hxx>
|
|
#include <sal/log.hxx>
|
|
#include <utility>
|
|
|
|
|
|
using namespace ::com::sun::star;
|
|
using namespace ::com::sun::star::uno;
|
|
using namespace ::com::sun::star::drawing::framework;
|
|
using ::sd::framework::FrameworkHelper;
|
|
using ::std::vector;
|
|
|
|
namespace {
|
|
const sal_Int32 snShortTimeout (100);
|
|
const sal_Int32 snNormalTimeout (1000);
|
|
const sal_Int32 snLongTimeout (10000);
|
|
const sal_Int32 snShortTimeoutCountThreshold (1);
|
|
const sal_Int32 snNormalTimeoutCountThreshold (5);
|
|
}
|
|
|
|
namespace sd::framework {
|
|
|
|
//===== ConfigurationUpdaterLock ==============================================
|
|
|
|
class ConfigurationUpdaterLock
|
|
{
|
|
public:
|
|
explicit ConfigurationUpdaterLock (ConfigurationUpdater& rUpdater)
|
|
: mrUpdater(rUpdater) { mrUpdater.LockUpdates(); }
|
|
~ConfigurationUpdaterLock() { mrUpdater.UnlockUpdates(); }
|
|
private:
|
|
ConfigurationUpdater& mrUpdater;
|
|
};
|
|
|
|
//===== ConfigurationUpdater ==================================================
|
|
|
|
ConfigurationUpdater::ConfigurationUpdater (
|
|
std::shared_ptr<ConfigurationControllerBroadcaster> pBroadcaster,
|
|
std::shared_ptr<ConfigurationControllerResourceManager> pResourceManager,
|
|
const rtl::Reference<::sd::DrawController>& rxControllerManager)
|
|
: mpBroadcaster(std::move(pBroadcaster)),
|
|
mxCurrentConfiguration(Reference<XConfiguration>(new Configuration(nullptr, false))),
|
|
mbUpdatePending(false),
|
|
mbUpdateBeingProcessed(false),
|
|
mnLockCount(0),
|
|
maUpdateTimer("sd::ConfigurationUpdater maUpdateTimer"),
|
|
mnFailedUpdateCount(0),
|
|
mpResourceManager(std::move(pResourceManager))
|
|
{
|
|
// Prepare the timer that is started when after an update the current
|
|
// and the requested configuration differ. With the timer we try
|
|
// updates until the two configurations are the same.
|
|
maUpdateTimer.SetTimeout(snNormalTimeout);
|
|
maUpdateTimer.SetInvokeHandler(LINK(this,ConfigurationUpdater,TimeoutHandler));
|
|
mxControllerManager = rxControllerManager;
|
|
}
|
|
|
|
ConfigurationUpdater::~ConfigurationUpdater()
|
|
{
|
|
maUpdateTimer.Stop();
|
|
}
|
|
|
|
void ConfigurationUpdater::RequestUpdate (
|
|
const Reference<XConfiguration>& rxRequestedConfiguration)
|
|
{
|
|
mxRequestedConfiguration = rxRequestedConfiguration;
|
|
|
|
// Find out whether we really can update the configuration.
|
|
if (IsUpdatePossible())
|
|
{
|
|
SAL_INFO("sd.fwk", __func__ << ": UpdateConfiguration start");
|
|
|
|
// Call UpdateConfiguration while that is possible and while someone
|
|
// set mbUpdatePending to true in the middle of it.
|
|
do
|
|
{
|
|
UpdateConfiguration();
|
|
}
|
|
while (mbUpdatePending && IsUpdatePossible());
|
|
}
|
|
else
|
|
{
|
|
mbUpdatePending = true;
|
|
SAL_INFO("sd.fwk", __func__ << ": scheduling update for later");
|
|
}
|
|
}
|
|
|
|
bool ConfigurationUpdater::IsUpdatePossible() const
|
|
{
|
|
return ! mbUpdateBeingProcessed
|
|
&& mxControllerManager.is()
|
|
&& mnLockCount==0
|
|
&& mxRequestedConfiguration.is()
|
|
&& mxCurrentConfiguration.is();
|
|
}
|
|
|
|
void ConfigurationUpdater::UpdateConfiguration()
|
|
{
|
|
SAL_INFO("sd.fwk", __func__ << ": UpdateConfiguration update");
|
|
SetUpdateBeingProcessed(true);
|
|
comphelper::ScopeGuard aScopeGuard (
|
|
[this] () { return this->SetUpdateBeingProcessed(false); });
|
|
|
|
try
|
|
{
|
|
mbUpdatePending = false;
|
|
|
|
CleanRequestedConfiguration();
|
|
ConfigurationClassifier aClassifier(mxRequestedConfiguration, mxCurrentConfiguration);
|
|
if (aClassifier.Partition())
|
|
{
|
|
#if DEBUG_SD_CONFIGURATION_TRACE
|
|
SAL_INFO("sd.fwk", __func__ << ": ConfigurationUpdater::UpdateConfiguration(");
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxRequestedConfiguration, "requested configuration");
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxCurrentConfiguration, "current configuration");
|
|
#endif
|
|
// Notify the beginning of the update.
|
|
ConfigurationChangeEvent aEvent;
|
|
aEvent.Type = FrameworkHelper::msConfigurationUpdateStartEvent;
|
|
aEvent.Configuration = mxRequestedConfiguration;
|
|
mpBroadcaster->NotifyListeners(aEvent);
|
|
|
|
// Do the actual update. All exceptions are caught and ignored,
|
|
// so that the end of the update is notified always.
|
|
try
|
|
{
|
|
if (mnLockCount == 0)
|
|
UpdateCore(aClassifier);
|
|
}
|
|
catch(const RuntimeException&)
|
|
{
|
|
}
|
|
|
|
// Notify the end of the update.
|
|
aEvent.Type = FrameworkHelper::msConfigurationUpdateEndEvent;
|
|
mpBroadcaster->NotifyListeners(aEvent);
|
|
|
|
CheckUpdateSuccess();
|
|
}
|
|
else
|
|
{
|
|
SAL_INFO("sd.fwk", __func__ << ": nothing to do");
|
|
#if DEBUG_SD_CONFIGURATION_TRACE
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxRequestedConfiguration, "requested configuration");
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxCurrentConfiguration, "current configuration");
|
|
#endif
|
|
}
|
|
}
|
|
catch(const RuntimeException &)
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION("sd");
|
|
}
|
|
|
|
SAL_INFO("sd.fwk", __func__ << ": ConfigurationUpdater::UpdateConfiguration)");
|
|
SAL_INFO("sd.fwk", __func__ << ": UpdateConfiguration end");
|
|
}
|
|
|
|
void ConfigurationUpdater::CleanRequestedConfiguration()
|
|
{
|
|
if (!mxControllerManager.is())
|
|
return;
|
|
|
|
// Request the deactivation of pure anchors that have no child.
|
|
vector<Reference<XResourceId> > aResourcesToDeactivate;
|
|
CheckPureAnchors(mxRequestedConfiguration, aResourcesToDeactivate);
|
|
if (!aResourcesToDeactivate.empty())
|
|
{
|
|
Reference<XConfigurationController> xCC (
|
|
mxControllerManager->getConfigurationController());
|
|
for (const auto& rxId : aResourcesToDeactivate)
|
|
if (rxId.is())
|
|
xCC->requestResourceDeactivation(rxId);
|
|
}
|
|
}
|
|
|
|
void ConfigurationUpdater::CheckUpdateSuccess()
|
|
{
|
|
// When the two configurations differ then start the timer to call
|
|
// another update later.
|
|
if ( ! AreConfigurationsEquivalent(mxCurrentConfiguration, mxRequestedConfiguration))
|
|
{
|
|
if (mnFailedUpdateCount <= snShortTimeoutCountThreshold)
|
|
maUpdateTimer.SetTimeout(snShortTimeout);
|
|
else if (mnFailedUpdateCount < snNormalTimeoutCountThreshold)
|
|
maUpdateTimer.SetTimeout(snNormalTimeout);
|
|
else
|
|
maUpdateTimer.SetTimeout(snLongTimeout);
|
|
++mnFailedUpdateCount;
|
|
maUpdateTimer.Start();
|
|
}
|
|
else
|
|
{
|
|
// Update was successful. Reset the failed update count.
|
|
mnFailedUpdateCount = 0;
|
|
}
|
|
}
|
|
|
|
void ConfigurationUpdater::UpdateCore (const ConfigurationClassifier& rClassifier)
|
|
{
|
|
try
|
|
{
|
|
#if DEBUG_SD_CONFIGURATION_TRACE
|
|
rClassifier.TraceResourceIdVector(
|
|
"requested but not current resources:", rClassifier.GetC1minusC2());
|
|
rClassifier.TraceResourceIdVector(
|
|
"current but not requested resources:", rClassifier.GetC2minusC1());
|
|
rClassifier.TraceResourceIdVector(
|
|
"requested and current resources:", rClassifier.GetC1andC2());
|
|
#endif
|
|
|
|
// Updating of the sub controllers is done in two steps. In the
|
|
// first the sub controllers typically shut down resources that are
|
|
// not requested anymore. In the second the sub controllers
|
|
// typically set up resources that have been newly requested.
|
|
mpResourceManager->DeactivateResources(rClassifier.GetC2minusC1(), mxCurrentConfiguration);
|
|
mpResourceManager->ActivateResources(rClassifier.GetC1minusC2(), mxCurrentConfiguration);
|
|
|
|
#if DEBUG_SD_CONFIGURATION_TRACE
|
|
SAL_INFO("sd.fwk", __func__ << ": ConfigurationController::UpdateConfiguration)");
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxRequestedConfiguration, "requested configuration");
|
|
ConfigurationTracer::TraceConfiguration(
|
|
mxCurrentConfiguration, "current configuration");
|
|
#endif
|
|
|
|
// Deactivate pure anchors that have no child.
|
|
vector<Reference<XResourceId> > aResourcesToDeactivate;
|
|
CheckPureAnchors(mxCurrentConfiguration, aResourcesToDeactivate);
|
|
if (!aResourcesToDeactivate.empty())
|
|
mpResourceManager->DeactivateResources(aResourcesToDeactivate, mxCurrentConfiguration);
|
|
}
|
|
catch(const RuntimeException&)
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION("sd");
|
|
}
|
|
}
|
|
|
|
void ConfigurationUpdater::CheckPureAnchors (
|
|
const Reference<XConfiguration>& rxConfiguration,
|
|
vector<Reference<XResourceId> >& rResourcesToDeactivate)
|
|
{
|
|
if ( ! rxConfiguration.is())
|
|
return;
|
|
|
|
// Get a list of all resources in the configuration.
|
|
Sequence<Reference<XResourceId> > aResources(
|
|
rxConfiguration->getResources(
|
|
nullptr, OUString(), AnchorBindingMode_INDIRECT));
|
|
auto aResourcesRange = asNonConstRange(aResources);
|
|
sal_Int32 nCount (aResources.getLength());
|
|
|
|
// Prepare the list of pure anchors that have to be deactivated.
|
|
rResourcesToDeactivate.clear();
|
|
|
|
// Iterate over the list in reverse order because when there is a chain
|
|
// of pure anchors with only the last one having no child then the whole
|
|
// list has to be deactivated.
|
|
sal_Int32 nIndex (nCount-1);
|
|
while (nIndex >= 0)
|
|
{
|
|
const Reference<XResourceId>& xResourceId (aResources[nIndex]);
|
|
const Reference<XResource> xResource (
|
|
mpResourceManager->GetResource(xResourceId).mxResource);
|
|
bool bDeactiveCurrentResource (false);
|
|
|
|
// Skip all resources that are no pure anchors.
|
|
if (xResource.is() && xResource->isAnchorOnly())
|
|
{
|
|
// When xResource is not an anchor of the next resource in
|
|
// the list then it is the anchor of no resource at all.
|
|
if (nIndex == nCount-1)
|
|
{
|
|
// No following anchors, deactivate this one, then remove it
|
|
// from the list.
|
|
bDeactiveCurrentResource = true;
|
|
}
|
|
else
|
|
{
|
|
const Reference<XResourceId>& xPrevResourceId (aResources[nIndex+1]);
|
|
if ( ! xPrevResourceId.is()
|
|
|| ! xPrevResourceId->isBoundTo(xResourceId, AnchorBindingMode_DIRECT))
|
|
{
|
|
// The previous resource (id) does not exist or is not bound to
|
|
// the current anchor.
|
|
bDeactiveCurrentResource = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (bDeactiveCurrentResource)
|
|
{
|
|
SAL_INFO("sd.fwk", __func__ << ": deactivating pure anchor " <<
|
|
FrameworkHelper::ResourceIdToString(xResourceId) <<
|
|
"because it has no children");
|
|
rResourcesToDeactivate.push_back(xResourceId);
|
|
// Erase element from current configuration.
|
|
for (sal_Int32 nI=nIndex; nI<nCount-2; ++nI)
|
|
aResourcesRange[nI] = aResources[nI+1];
|
|
nCount -= 1;
|
|
}
|
|
nIndex -= 1;
|
|
}
|
|
}
|
|
|
|
void ConfigurationUpdater::LockUpdates()
|
|
{
|
|
++mnLockCount;
|
|
}
|
|
|
|
void ConfigurationUpdater::UnlockUpdates()
|
|
{
|
|
--mnLockCount;
|
|
if (mnLockCount == 0 && mbUpdatePending)
|
|
{
|
|
RequestUpdate(mxRequestedConfiguration);
|
|
}
|
|
}
|
|
|
|
std::shared_ptr<ConfigurationUpdaterLock> ConfigurationUpdater::GetLock()
|
|
{
|
|
return std::make_shared<ConfigurationUpdaterLock>(*this);
|
|
}
|
|
|
|
void ConfigurationUpdater::SetUpdateBeingProcessed (bool bValue)
|
|
{
|
|
mbUpdateBeingProcessed = bValue;
|
|
}
|
|
|
|
IMPL_LINK_NOARG(ConfigurationUpdater, TimeoutHandler, Timer *, void)
|
|
{
|
|
if ( ! mbUpdateBeingProcessed
|
|
&& mxCurrentConfiguration.is()
|
|
&& mxRequestedConfiguration.is())
|
|
{
|
|
if ( ! AreConfigurationsEquivalent(mxCurrentConfiguration, mxRequestedConfiguration))
|
|
{
|
|
RequestUpdate(mxRequestedConfiguration);
|
|
}
|
|
}
|
|
}
|
|
|
|
} // end of namespace sd::framework
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|