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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522 | /* -*- 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 "filterfactory.hxx"
#include "constant.hxx"
#include <com/sun/star/lang/XInitialization.hpp>
#include <comphelper/processfactory.hxx>
#include <comphelper/enumhelper.hxx>
#include <comphelper/sequence.hxx>
#include <officecfg/Setup.hxx>
#include <officecfg/TypeDetection/UISort.hxx>
namespace filter::config{
/** @short define all possible parts of a filter query.
@descr syntax: "<query>[:<param>[=<value>]]"
e.g.: "_query_writer:default_first:use_order:sort_prop=uiname"
argument description default
-----------------------------------------------------------------------------------------------
iflags=<mask> include filters by given mask 0
eflags=<mask> exclude filters by given mask 0
sort_prop=<[name,uiname]> sort by internal name or uiname name
descending sort descending false
use_order use order flag of filters for sorting false
default_first set default filter on top of return list false
case_sensitive compare "sort_prop" case sensitive false
*/
FilterFactory::FilterFactory(const css::uno::Reference< css::uno::XComponentContext >& rxContext)
: m_xContext(rxContext)
{
BaseContainer::init(rxContext ,
FilterFactory::impl_getImplementationName() ,
FilterFactory::impl_getSupportedServiceNames(),
FilterCache::E_FILTER );
}
FilterFactory::~FilterFactory()
{
}
css::uno::Reference< css::uno::XInterface > SAL_CALL FilterFactory::createInstance(const OUString& sFilter)
{
return createInstanceWithArguments(sFilter, css::uno::Sequence< css::uno::Any >());
}
css::uno::Reference< css::uno::XInterface > SAL_CALL FilterFactory::createInstanceWithArguments(const OUString& sFilter ,
const css::uno::Sequence< css::uno::Any >& lArguments)
{
// SAFE ->
osl::MutexGuard aLock(m_aLock);
auto & cache = TheFilterCache::get();
// search filter on cache
CacheItem aFilter = cache.getItem(FilterCache::E_FILTER, sFilter);
OUString sFilterService;
aFilter[PROPNAME_FILTERSERVICE] >>= sFilterService;
// create service instance
css::uno::Reference< css::uno::XInterface > xFilter;
if (!sFilterService.isEmpty())
xFilter = m_xContext->getServiceManager()->createInstanceWithContext(sFilterService, m_xContext);
// initialize filter
css::uno::Reference< css::lang::XInitialization > xInit(xFilter, css::uno::UNO_QUERY);
if (xInit.is())
{
// format: lInitData[0] = seq<PropertyValue>, which contains all configuration properties of this filter
// lInitData[1] = lArguments[0]
// ...
// lInitData[n] = lArguments[n-1]
css::uno::Sequence< css::beans::PropertyValue > lConfig;
aFilter >> lConfig;
::std::vector< css::uno::Any > stlArguments(comphelper::sequenceToContainer< ::std::vector< css::uno::Any > >(lArguments));
stlArguments.insert(stlArguments.begin(), css::uno::makeAny(lConfig));
xInit->initialize(comphelper::containerToSequence(stlArguments));
}
return xFilter;
// <- SAFE
}
css::uno::Sequence< OUString > SAL_CALL FilterFactory::getAvailableServiceNames()
{
/* Attention: Instead of getElementNames() this method have to return only filter names,
which can be created as UNO Services really. That's why we search for filters,
which don't have a valid value for the property "FilterService".
Of course we can't check for corrupted service names here. We can check
for empty strings only...
*/
CacheItem lIProps;
CacheItem lEProps;
lEProps[PROPNAME_FILTERSERVICE] <<= OUString();
std::vector<OUString> lUNOFilters;
try
{
lUNOFilters = TheFilterCache::get().getMatchingItemsByProps(FilterCache::E_FILTER, lIProps, lEProps);
}
catch(const css::uno::RuntimeException&)
{ throw; }
catch(const css::uno::Exception&)
{ lUNOFilters.clear(); }
return comphelper::containerToSequence(lUNOFilters);
}
css::uno::Reference< css::container::XEnumeration > SAL_CALL FilterFactory::createSubSetEnumerationByQuery(const OUString& sQuery)
{
// reject old deprecated queries ...
if (sQuery.startsWith("_filterquery_"))
throw css::uno::RuntimeException(
"Use of deprecated and now unsupported query!",
static_cast< css::container::XContainerQuery* >(this));
// convert "_query_xxx:..." to "getByDocService=xxx:..."
OUString sNewQuery(sQuery);
sal_Int32 pos = sNewQuery.indexOf("_query_");
if (pos != -1)
{
OSL_FAIL("DEPRECATED!\nPlease use new query format: 'matchByDocumentService=...'");
OUString sPatchedQuery("matchByDocumentService=" + sNewQuery.copy(7));
sNewQuery = sPatchedQuery;
}
// analyze query and split it into its tokens
QueryTokenizer lTokens(sNewQuery);
std::vector<OUString> lEnumSet;
// start query
// (see attention comment below!)
if (lTokens.valid())
{
// SAFE -> ----------------------
{
osl::MutexGuard aLock(m_aLock);
// May be not all filters was loaded ...
// But we need it now!
impl_loadOnDemand();
}
// <- SAFE ----------------------
if (lTokens.find(QUERY_IDENTIFIER_GETPREFERREDFILTERFORTYPE) != lTokens.end())
OSL_FAIL("DEPRECATED!\nPlease use prop search at the TypeDetection container!");
else
if (lTokens.find(QUERY_IDENTIFIER_MATCHBYDOCUMENTSERVICE) != lTokens.end())
lEnumSet = impl_queryMatchByDocumentService(lTokens);
else
if (lTokens.find(QUERY_IDENTIFIER_GET_SORTED_FILTERLIST) != lTokens.end())
lEnumSet = impl_getSortedFilterList(lTokens);
}
// pack list of item names as an enum list
// Attention: Do not return empty reference for empty list!
// The outside check "hasMoreElements()" should be enough, to detect this state :-)
css::uno::Sequence< OUString > lSet = comphelper::containerToSequence(lEnumSet);
::comphelper::OEnumerationByName* pEnum = new ::comphelper::OEnumerationByName(this, lSet);
return css::uno::Reference< css::container::XEnumeration >(static_cast< css::container::XEnumeration* >(pEnum), css::uno::UNO_QUERY);
}
std::vector<OUString> FilterFactory::impl_queryMatchByDocumentService(const QueryTokenizer& lTokens) const
{
// analyze query
QueryTokenizer::const_iterator pIt;
OUString sDocumentService;
sal_Int32 nIFlags = 0;
sal_Int32 nEFlags = 0;
pIt = lTokens.find(QUERY_IDENTIFIER_MATCHBYDOCUMENTSERVICE);
if (pIt != lTokens.end())
sDocumentService = pIt->second;
#define COMP_HACK
#ifdef COMP_HACK
if ( sDocumentService == "writer" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.text.TextDocument";
}
else if ( sDocumentService == "web" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.text.WebDocument";
}
else if ( sDocumentService == "global" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.text.GlobalDocument";
}
else if ( sDocumentService == "calc" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.sheet.SpreadsheetDocument";
}
else if ( sDocumentService == "draw" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.drawing.DrawingDocument";
}
else if ( sDocumentService == "impress" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.presentation.PresentationDocument";
}
else if ( sDocumentService == "math" )
{
OSL_FAIL("DEPRECATED!\nPlease use right document service for filter query!");
sDocumentService = "com.sun.star.formula.FormulaProperties";
}
#endif
pIt = lTokens.find(QUERY_PARAM_IFLAGS);
if (pIt != lTokens.end())
nIFlags = pIt->second.toInt32();
pIt = lTokens.find(QUERY_PARAM_EFLAGS);
if (pIt != lTokens.end())
nEFlags = pIt->second.toInt32();
// SAFE -> ----------------------
osl::ClearableMutexGuard aLock(m_aLock);
// search suitable filters
FilterCache* pCache = impl_getWorkingCache();
std::vector<OUString> lFilterNames = pCache->getItemNames(FilterCache::E_FILTER);
std::vector<OUString> lResult ;
for (auto const& filterName : lFilterNames)
{
try
{
const CacheItem aFilter = pCache->getItem(FilterCache::E_FILTER, filterName);
// "matchByDocumentService=" => any filter will be addressed here
// "matchByDocumentService=all" => any filter will be addressed here
// "matchByDocumentService=com.sun.star..." => only filter matching this document service will be addressed
OUString sCheckValue = aFilter.getUnpackedValueOrDefault(PROPNAME_DOCUMENTSERVICE, OUString());
if (
(!sDocumentService.isEmpty() ) &&
(sDocumentService != QUERY_CONSTVALUE_ALL ) &&
(sCheckValue != sDocumentService )
)
{
continue; // ignore filter -> try next one!
}
// "iflags=" => not allowed
// "iflags=-1" => not allowed
// "iflags=0" => not useful
// "iflags=283648" => only filter, which has set these flag field will be addressed
sal_Int32 nCheckValue = aFilter.getUnpackedValueOrDefault(PROPNAME_FLAGS, sal_Int32(0));
if (
(nIFlags > 0 ) &&
((nCheckValue & nIFlags) != nIFlags)
)
{
continue; // ignore filter -> try next one!
}
// "eflags=" => not allowed
// "eflags=-1" => not allowed
// "eflags=0" => not useful
// "eflags=283648" => only filter, which has not set these flag field will be addressed
if (
(nEFlags > 0 ) &&
((nCheckValue & nEFlags) == nEFlags)
)
{
continue; // ignore filter -> try next one!
}
// OK - this filter passed all checks.
// It match the query ...
lResult.push_back(filterName);
}
catch(const css::uno::RuntimeException&)
{ throw; }
catch(const css::uno::Exception&)
{ continue; }
}
aLock.clear();
// <- SAFE ----------------------
return lResult;
}
namespace {
class stlcomp_removeIfMatchFlags
{
private:
FilterCache* m_pCache ;
sal_Int32 m_nFlags ;
bool m_bIFlags;
public:
stlcomp_removeIfMatchFlags(FilterCache* pCache ,
sal_Int32 nFlags ,
bool bIFlags)
: m_pCache (pCache )
, m_nFlags (nFlags )
, m_bIFlags(bIFlags)
{}
bool operator() (const OUString& sFilter) const
{
try
{
const CacheItem aFilter = m_pCache->getItem(FilterCache::E_FILTER, sFilter);
sal_Int32 nFlags = aFilter.getUnpackedValueOrDefault(PROPNAME_FLAGS, (sal_Int32(0)));
bool bMatch = false;
if (m_bIFlags)
// IFlags are interpreted as ALL_FLAGS_MUST_MATCH !
bMatch = ((nFlags & m_nFlags) == m_nFlags);
else
// EFlags are interpreted as AT_LEAST_ONE_FLAG_MUST_MATCH !
bMatch = !(nFlags & m_nFlags);
// We are asked for bRemove ! And bMatch = !bRemove => so bRemove = !bMatch .-)
return !bMatch;
}
catch(const css::container::NoSuchElementException &)
{
return true;
}
}
};
}
std::vector<OUString> FilterFactory::impl_getSortedFilterList(const QueryTokenizer& lTokens) const
{
// analyze the given query parameter
QueryTokenizer::const_iterator pIt1;
OUString sModule;
sal_Int32 nIFlags = -1;
sal_Int32 nEFlags = -1;
pIt1 = lTokens.find(QUERY_PARAM_MODULE);
if (pIt1 != lTokens.end())
sModule = pIt1->second;
pIt1 = lTokens.find(QUERY_PARAM_IFLAGS);
if (pIt1 != lTokens.end())
nIFlags = pIt1->second.toInt32();
pIt1 = lTokens.find(QUERY_PARAM_EFLAGS);
if (pIt1 != lTokens.end())
nEFlags = pIt1->second.toInt32();
// simple search for filters of one specific module.
std::vector<OUString> lFilterList;
if (!sModule.isEmpty())
lFilterList = impl_getSortedFilterListForModule(sModule, nIFlags, nEFlags);
else
{
// more complex search for all filters
// We check first, which office modules are installed...
std::vector<OUString> lModules = impl_getListOfInstalledModules();
for (auto const& module : lModules)
{
std::vector<OUString> lFilters4Module = impl_getSortedFilterListForModule(module, nIFlags, nEFlags);
for (auto const& filter4Module : lFilters4Module)
{
lFilterList.push_back(filter4Module);<--- Consider using std::copy algorithm instead of a raw loop.
}
}
}
return lFilterList;
}
std::vector<OUString> FilterFactory::impl_getListOfInstalledModules() const
{
// SAFE -> ----------------------
osl::ClearableMutexGuard aLock(m_aLock);
css::uno::Reference< css::uno::XComponentContext > xContext = m_xContext;
aLock.clear();
// <- SAFE ----------------------
css::uno::Reference< css::container::XNameAccess > xModuleConfig = officecfg::Setup::Office::Factories::get(xContext);
std::vector<OUString> lModules(comphelper::sequenceToContainer< std::vector<OUString> >(xModuleConfig->getElementNames()));
return lModules;
}
std::vector<OUString> FilterFactory::impl_getSortedFilterListForModule(const OUString& sModule,
sal_Int32 nIFlags,
sal_Int32 nEFlags) const
{
std::vector<OUString> lSortedFilters = impl_readSortedFilterListFromConfig(sModule);
// get all filters for the requested module
CacheItem lIProps;
lIProps[PROPNAME_DOCUMENTSERVICE] <<= sModule;
// SAFE -> ----------------------
osl::ClearableMutexGuard aLock(m_aLock);
FilterCache* pCache = impl_getWorkingCache();
std::vector<OUString> lOtherFilters = pCache->getMatchingItemsByProps(FilterCache::E_FILTER, lIProps);
aLock.clear();
// <- SAFE ----------------------
// bring "other" filters in an alphabetical order
// It's needed below.
::std::sort(lOtherFilters.begin(), lOtherFilters.end());
// merge both lists together
std::vector<OUString> lMergedFilters = lSortedFilters;
const auto itlSortedFiltersEnd = lSortedFilters.cend();
for (auto const& otherFilter : lOtherFilters)
{
if (::std::find(lSortedFilters.cbegin(), lSortedFilters.cend(), otherFilter) == itlSortedFiltersEnd)
lMergedFilters.push_back(otherFilter);
}
// remove all filters from this merged list, which does not fit the flag specification
if (nIFlags != -1)
{
auto pItToErase = ::std::remove_if(lMergedFilters.begin(), lMergedFilters.end(), stlcomp_removeIfMatchFlags(pCache, nIFlags, true));
lMergedFilters.erase(pItToErase, lMergedFilters.end());
}
if (nEFlags != -1)
{
auto pItToErase = ::std::remove_if(lMergedFilters.begin(), lMergedFilters.end(), stlcomp_removeIfMatchFlags(pCache, nEFlags, false));
lMergedFilters.erase(pItToErase, lMergedFilters.end());
}
// sort the default filter to the front of this list
// TODO
return lMergedFilters;
}
std::vector<OUString> FilterFactory::impl_readSortedFilterListFromConfig(const OUString& sModule) const
{
// SAFE -> ----------------------
osl::ClearableMutexGuard aLock(m_aLock);
css::uno::Reference< css::uno::XComponentContext > xContext = m_xContext;
aLock.clear();
// <- SAFE ----------------------
try
{
css::uno::Reference< css::container::XNameAccess > xUISortConfig = officecfg::TypeDetection::UISort::ModuleDependendFilterOrder::get(xContext);
// don't check the module name here. If it does not exists, an exception is thrown and caught below.
// We return an empty list as result then.
css::uno::Reference< css::container::XNameAccess > xModule;
xUISortConfig->getByName(sModule) >>= xModule;
if (xModule.is()) // only to be on the safe side of life if the exception was not thrown .-)
{
// Note: conversion of the returned Any to std::vector<OUString> throws
// an IllegalArgumentException if the type does not match ...
// but it resets the std::vector<OUString> to a length of 0 if the Any is empty!
std::vector<OUString> lSortedFilters(
comphelper::sequenceToContainer< std::vector<OUString> >(xModule->getByName(PROPNAME_SORTEDFILTERLIST).get<css::uno::Sequence<OUString> >()));
return lSortedFilters;
}
}
catch(const css::uno::RuntimeException&)
{ throw; }
catch(const css::uno::Exception&)
{}
return std::vector<OUString>();
}
OUString FilterFactory::impl_getImplementationName()
{
return "com.sun.star.comp.filter.config.FilterFactory";
}
css::uno::Sequence< OUString > FilterFactory::impl_getSupportedServiceNames()
{
return { "com.sun.star.document.FilterFactory" };
}
css::uno::Reference< css::uno::XInterface > FilterFactory::impl_createInstance(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR)
{
FilterFactory* pNew = new FilterFactory( comphelper::getComponentContext(xSMGR) );
return css::uno::Reference< css::uno::XInterface >(static_cast< css::lang::XMultiServiceFactory* >(pNew), css::uno::UNO_QUERY);
}
} // namespace filter
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|