1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378 | /* -*- 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 <com/sun/star/drawing/framework/XControllerManager.hpp>
#include <comphelper/scopeguard.hxx>
#include <tools/diagnose_ex.h>
#include <sal/log.hxx>
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 {
static const sal_Int32 snShortTimeout (100);
static const sal_Int32 snNormalTimeout (1000);
static const sal_Int32 snLongTimeout (10000);
static const sal_Int32 snShortTimeoutCountThreshold (1);
static 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 (
const std::shared_ptr<ConfigurationControllerBroadcaster>& rpBroadcaster,
const std::shared_ptr<ConfigurationControllerResourceManager>& rpResourceManager,
const Reference<XControllerManager>& rxControllerManager)
: mxControllerManager(),
mpBroadcaster(rpBroadcaster),
mxCurrentConfiguration(Reference<XConfiguration>(new Configuration(nullptr, false))),
mxRequestedConfiguration(),
mbUpdatePending(false),
mbUpdateBeingProcessed(false),
mnLockCount(0),
maUpdateTimer(),
mnFailedUpdateCount(0),
mpResourceManager(rpResourceManager)
{
// 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.SetDebugName("sd::ConfigurationUpdater maUpdateTimer");
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", OSL_THIS_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", OSL_THIS_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", OSL_THIS_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", OSL_THIS_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", OSL_THIS_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", OSL_THIS_FUNC << ": ConfigurationUpdater::UpdateConfiguration)");
SAL_INFO("sd.fwk", OSL_THIS_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", OSL_THIS_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));
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", OSL_THIS_FUNC << ": deactivating pure anchor " <<
FrameworkHelper::ResourceIdToString(xResourceId) <<
"because it has no children");
// Erase element from current configuration.
for (sal_Int32 nI=nIndex; nI<nCount-2; ++nI)
aResources[nI] = aResources[nI+1];
nCount -= 1;
rResourcesToDeactivate.push_back(xResourceId);
}
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)<--- syntax error
{
if ( ! mbUpdateBeingProcessed
&& mxCurrentConfiguration.is()
&& mxRequestedConfiguration.is())
{
if ( ! AreConfigurationsEquivalent(mxCurrentConfiguration, mxRequestedConfiguration))
{
RequestUpdate(mxRequestedConfiguration);
}
}
}
} // end of namespace sd::framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|