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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
/* -*- 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 "basecontainer.hxx"
#include <com/sun/star/lang/WrappedTargetRuntimeException.hpp>
#include <com/sun/star/document/FilterConfigRefresh.hpp>
#include <com/sun/star/uno/Type.h>
#include <comphelper/enumhelper.hxx>
#include <comphelper/sequence.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <osl/diagnose.h>
#define LOAD_IMPLICIT
namespace filter::config{
BaseContainer::BaseContainer()
: m_eType()
, m_lListener (m_aMutex)
{
GetTheFilterCache().load(FilterCache::E_CONTAINS_STANDARD);
}
BaseContainer::~BaseContainer()
{
}
void BaseContainer::init(const css::uno::Reference< css::uno::XComponentContext >& rxContext ,
const OUString& sImplementationName,
const css::uno::Sequence< OUString >& lServiceNames ,
FilterCache::EItemType eType )
{
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
m_sImplementationName = sImplementationName;
m_lServiceNames = lServiceNames ;
m_eType = eType ;
m_xRefreshBroadcaster = css::document::FilterConfigRefresh::create(rxContext);
// <- SAFE
}
void BaseContainer::impl_loadOnDemand()
{
#ifdef LOAD_IMPLICIT
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
// A generic container needs all items of a set of our cache!
// Of course it can block for a while, till the cache is really filled.
// Note: don't load all sets supported by the cache here!
FilterCache::EFillState eRequiredState = FilterCache::E_CONTAINS_NOTHING;
switch(m_eType)
{
case FilterCache::E_TYPE :
eRequiredState = FilterCache::E_CONTAINS_TYPES;
break;
case FilterCache::E_FILTER :
eRequiredState = FilterCache::E_CONTAINS_FILTERS;
break;
case FilterCache::E_FRAMELOADER :
eRequiredState = FilterCache::E_CONTAINS_FRAMELOADERS;
break;
case FilterCache::E_CONTENTHANDLER :
eRequiredState = FilterCache::E_CONTAINS_CONTENTHANDLERS;
break;
}
GetTheFilterCache().load(eRequiredState);
// <- SAFE
#endif
}
void BaseContainer::impl_initFlushMode()
{
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
if (!m_pFlushCache)
m_pFlushCache = GetTheFilterCache().clone();
if (!m_pFlushCache)
throw css::uno::RuntimeException( "Can not create write copy of internal used cache on demand.",
static_cast< OWeakObject* >(this));
// <- SAFE
}
FilterCache* BaseContainer::impl_getWorkingCache() const
{
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
if (m_pFlushCache)
return m_pFlushCache.get();
else
return &GetTheFilterCache();
// <- SAFE
}
OUString SAL_CALL BaseContainer::getImplementationName()
{
return m_sImplementationName;
}
sal_Bool SAL_CALL BaseContainer::supportsService(const OUString& sServiceName)
{
return cppu::supportsService(this, sServiceName);
}
css::uno::Sequence< OUString > SAL_CALL BaseContainer::getSupportedServiceNames()
{
return m_lServiceNames;
}
void SAL_CALL BaseContainer::insertByName(const OUString& sItem ,
const css::uno::Any& aValue)
{
if (sItem.isEmpty())
throw css::lang::IllegalArgumentException("empty value not allowed as item name.",
static_cast< css::container::XNameContainer* >(this),
1);
CacheItem aItem;
try
{
aItem << aValue;
}
catch(const css::uno::Exception& ex)
{
throw css::lang::IllegalArgumentException(ex.Message, static_cast< css::container::XNameContainer* >(this), 2);
}
impl_loadOnDemand();
// SAFE -> ----------------------------------
osl::MutexGuard aLock(m_aMutex);
// create write copy of used cache on demand ...
impl_initFlushMode();
FilterCache* pCache = impl_getWorkingCache();
if (pCache->hasItem(m_eType, sItem))
throw css::container::ElementExistException(OUString(), static_cast< css::container::XNameContainer* >(this));
pCache->setItem(m_eType, sItem, aItem);
// <- SAFE ----------------------------------
}
void SAL_CALL BaseContainer::removeByName(const OUString& sItem)
{
impl_loadOnDemand();
// SAFE -> ----------------------------------
osl::MutexGuard aLock(m_aMutex);
// create write copy of used cache on demand ...
impl_initFlushMode();
FilterCache* pCache = impl_getWorkingCache();
pCache->removeItem(m_eType, sItem); // throw exceptions automatically
// <- SAFE ----------------------------------
}
void SAL_CALL BaseContainer::replaceByName(const OUString& sItem ,
const css::uno::Any& aValue)
{
if (sItem.isEmpty())
throw css::lang::IllegalArgumentException("empty value not allowed as item name.",
static_cast< css::container::XNameContainer* >(this),
1);
CacheItem aItem;
try
{
aItem << aValue;
}
catch(const css::uno::Exception& ex)
{
throw css::lang::IllegalArgumentException(ex.Message, static_cast< css::container::XNameContainer* >(this), 2);
}
impl_loadOnDemand();
// SAFE -> ----------------------------------
osl::MutexGuard aLock(m_aMutex);
// create write copy of used cache on demand ...
impl_initFlushMode();
FilterCache* pCache = impl_getWorkingCache();
if (!pCache->hasItem(m_eType, sItem))
throw css::container::NoSuchElementException(OUString(), static_cast< css::container::XNameContainer* >(this));
pCache->setItem(m_eType, sItem, aItem);
// <- SAFE ----------------------------------
}
css::uno::Any SAL_CALL BaseContainer::getByName(const OUString& sItem)
{
if (sItem.isEmpty())
throw css::container::NoSuchElementException( "An empty item can't be part of this cache!",
static_cast< css::container::XNameAccess* >(this));
css::uno::Any aValue;
impl_loadOnDemand();
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
CacheItem aItem;
try
{
FilterCache* pCache = impl_getWorkingCache();
aItem = pCache->getItem(m_eType, sItem);
pCache->addStatePropsToItem(m_eType, sItem, aItem); // add implicit props "Finalized"/"Mandatory"
}
catch(const css::container::NoSuchElementException&)
{
throw;
}
catch(const css::uno::Exception&)
{
// TODO invalid cache!? How should it be handled right?
aItem.clear();
}
aValue <<= aItem.getAsPackedPropertyValueList();
// <- SAFE
return aValue;
}
css::uno::Sequence< OUString > SAL_CALL BaseContainer::getElementNames()
{
css::uno::Sequence< OUString > lNames;
impl_loadOnDemand();
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
try
{
FilterCache* pCache = impl_getWorkingCache();
std::vector<OUString> lKeys = pCache->getItemNames(m_eType);
lNames = comphelper::containerToSequence(lKeys);
}
catch(const css::uno::Exception&)
{
// invalid cache!?
lNames.realloc(0);
}
// <- SAFE
return lNames;
}
sal_Bool SAL_CALL BaseContainer::hasByName(const OUString& sItem)
{
bool bHasOne = false;
impl_loadOnDemand();
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
try
{
FilterCache* pCache = impl_getWorkingCache();
bHasOne = pCache->hasItem(m_eType, sItem);
}
catch(const css::uno::Exception&)
{
// invalid cache!?
bHasOne = false;
}
// <- SAFE
return bHasOne;
}
css::uno::Type SAL_CALL BaseContainer::getElementType()
{
// no lock necessary - because the type of our items
// is fix! no internal call or member needed ...
return cppu::UnoType<css::uno::Sequence< css::beans::PropertyValue >>::get();
}
sal_Bool SAL_CALL BaseContainer::hasElements()
{
bool bHasSome = false;
impl_loadOnDemand();
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
try
{
FilterCache* pCache = impl_getWorkingCache();
bHasSome = pCache->hasItems(m_eType);
}
catch(const css::uno::Exception&)
{
// invalid cache?!
bHasSome = false;
}
// <- SAFE
return bHasSome;
}
css::uno::Reference< css::container::XEnumeration > SAL_CALL BaseContainer::createSubSetEnumerationByQuery(const OUString& /* sQuery */ )
{
OSL_FAIL("not pure virtual ... but not really implemented .-)");
return new ::comphelper::OEnumerationByName(this, css::uno::Sequence< OUString >());
}
css::uno::Reference< css::container::XEnumeration > SAL_CALL BaseContainer::createSubSetEnumerationByProperties(const css::uno::Sequence< css::beans::NamedValue >& lProperties)
{
std::vector<OUString> lKeys;
impl_loadOnDemand();
// SAFE ->
osl::MutexGuard aLock(m_aMutex);
try
{
// convert the given properties first to our internal representation
CacheItem lProps;
lProps << lProperties;
// search the key names of all items, where its properties match
// the given ones in its minimum
FilterCache* pCache = impl_getWorkingCache();
lKeys = pCache->getMatchingItemsByProps(m_eType, lProps);
}
catch(const css::uno::Exception&)
{
// invalid cache, internal failure, wrong conversion ...!?
// doesn't matter
lKeys.clear();
}
// <- SAFE
// create a specialized enumeration helper, which
// provides the collected information outside.
// It hold a reference to us ... and call our container interface directly.
// be aware of some direct callbacks if it will be created :-)
/* Note: It's not allowed to return NULL. Because an empty enumeration
transport the same information but make no trouble outside.
Further its easier to work directly with the return value
instead of checking of NULL returns! */
css::uno::Sequence< OUString > lSubSet = comphelper::containerToSequence(lKeys);
return new ::comphelper::OEnumerationByName(this, lSubSet);
}
void SAL_CALL BaseContainer::flush()
{
// SAFE ->
osl::ClearableMutexGuard aLock(m_aMutex);
if (!m_pFlushCache)
throw css::lang::WrappedTargetRuntimeException(
"Can not guarantee cache consistency. Special flush container does not exists!",
static_cast< OWeakObject* >(this),
css::uno::Any());
try
{
m_pFlushCache->flush();
// Take over all changes into the global cache and
// forget the clone.
/* TODO
-think about me
If the global cache gets this information via listener,
we should remove this method!
*/
GetTheFilterCache().takeOver(*m_pFlushCache);
}
catch(const css::uno::Exception& ex)
{
// Don't remove the clone. May be the outside
// user wish to repair it now and calls flush()
// later again ...
throw css::lang::WrappedTargetRuntimeException( "Flush rejected by internal container.",
static_cast< OWeakObject* >(this),
css::uno::Any(ex));
}
m_pFlushCache.reset();
css::uno::Reference< css::util::XRefreshable > xRefreshBroadcaster = m_xRefreshBroadcaster;
aLock.clear();
// <- SAFE
if (xRefreshBroadcaster.is())
xRefreshBroadcaster->refresh();
// notify listener outside the lock!
// The used listener helper lives if we live
// and is threadsafe by itself.
// Further it's not a good idea to hold the own lock
// if an outside object is called :-)
css::lang::EventObject aSource (static_cast< css::util::XFlushable* >(this));
comphelper::OInterfaceContainerHelper2* pContainer = m_lListener.getContainer(cppu::UnoType<css::util::XFlushListener>::get());
if (!pContainer)
return;
comphelper::OInterfaceIteratorHelper2 pIterator(*pContainer);
while (pIterator.hasMoreElements())
{
try
{
// ... this pointer can be interesting to find out, where will be called as listener
// Don't optimize it to a direct iterator cast :-)
css::util::XFlushListener* pListener = static_cast<css::util::XFlushListener*>(pIterator.next());
pListener->flushed(aSource);
}
catch(const css::uno::Exception&)
{
// ignore any "damaged" flush listener!
// May its remote reference is broken ...
pIterator.remove();
}
}
}
void SAL_CALL BaseContainer::addFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener)
{
// no locks necessary
// used helper lives if we live and is threadsafe by itself ...
m_lListener.addInterface(cppu::UnoType<css::util::XFlushListener>::get(), xListener);
}
void SAL_CALL BaseContainer::removeFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener)
{
// no locks necessary
// used helper lives if we live and is threadsafe by itself ...
m_lListener.removeInterface(cppu::UnoType<css::util::XFlushListener>::get(), xListener);
}
} // namespace filter::config
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|