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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
/* -*- 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 .
*/
#ifndef _DATABASES_HXX_
#define _DATABASES_HXX_
#include <set>
#include <vector>
#ifndef HAVE_CXX0X
#define BOOST_NO_0X_HDR_TYPEINDEX
#endif
#include <boost/unordered_map.hpp>
#include <boost/unordered_set.hpp>
#include <osl/mutex.hxx>
#include <rtl/ustring.hxx>
#include <rtl/string.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/ucb/XContent.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/lang/XMultiComponentFactory.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/i18n/XCollator.hpp>
#include <com/sun/star/deployment/XPackage.hpp>
#include "com/sun/star/ucb/XSimpleFileAccess3.hpp"
// Forward declaration
namespace helpdatafileproxy {
class Hdf;
}
namespace chelp {
class Databases;
class URLParameter;
class StaticModuleInformation
{
private:
rtl::OUString m_aStartId;
rtl::OUString m_aProgramSwitch;
rtl::OUString m_aTitle;
rtl::OUString m_aHeading;
rtl::OUString m_aFulltext;
int m_nOrder;
public:
StaticModuleInformation( rtl::OUString aTitle,
rtl::OUString aStartId,
rtl::OUString aProgramSwitch,
rtl::OUString aHeading,
rtl::OUString aFulltext,
rtl::OUString aOrder )
: m_aStartId( aStartId ),
m_aProgramSwitch( aProgramSwitch ),
m_aTitle( aTitle ),
m_aHeading( aHeading ),
m_aFulltext( aFulltext ),
m_nOrder( aOrder.toInt32() )
{
}
~StaticModuleInformation() { }
rtl::OUString get_title() const { return m_aTitle; }
rtl::OUString get_id() const { return m_aStartId; }
rtl::OUString get_program() const { return m_aProgramSwitch; }
rtl::OUString get_heading() const { return m_aHeading; }
rtl::OUString get_fulltext() const { return m_aFulltext; }
int get_order() const { return m_nOrder; }
}; // end class StaticModuleInformation
class KeywordInfo
{
public:
class KeywordElement
{
friend struct KeywordElementComparator;
friend class KeywordInfo;
public:
KeywordElement( Databases* pDatabases,
helpdatafileproxy::Hdf* pHdf,
rtl::OUString& key,
rtl::OUString& ids );
private:
rtl::OUString key;
com::sun::star::uno::Sequence< rtl::OUString > listId;
com::sun::star::uno::Sequence< rtl::OUString > listAnchor;
com::sun::star::uno::Sequence< rtl::OUString > listTitle;
void init( Databases *pDatabases,helpdatafileproxy::Hdf* pHdf,const rtl::OUString& ids );
};
KeywordInfo( const std::vector< KeywordElement >& aVector );
~KeywordInfo() { };
com::sun::star::uno::Sequence< rtl::OUString >&
getKeywordList() { return listKey; }
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< rtl::OUString > >&
getIdList() { return listId; }
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< rtl::OUString > >&
getAnchorList() { return listAnchor; }
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< rtl::OUString > >&
getTitleList() { return listTitle; }
private:
com::sun::star::uno::Sequence< rtl::OUString > listKey;
com::sun::star::uno::Sequence< com::sun::star::uno::Sequence< rtl::OUString > > listId,listAnchor,listTitle;
}; // end class KeywordInfo
class Databases
{
public:
struct eq
{
bool operator()( const rtl::OUString& rKey1, const rtl::OUString& rKey2 ) const
{
return rKey1.compareTo( rKey2 ) == 0;
}
};
struct ha
{
size_t operator()( const rtl::OUString& rName ) const
{
return rName.hashCode();
}
};
/**
* Input is the installdirectory in system dependent notation
*/
Databases( sal_Bool showBasic,
const rtl::OUString& instPath,
const com::sun::star::uno::Sequence< rtl::OUString >& imagesZipPaths,
const rtl::OUString& productName,
const rtl::OUString& productVersion,
const rtl::OUString& styleSheet,
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext );
~Databases();
rtl::OString getImagesZipFileURL();
rtl::OUString getInstallPathAsURL();
const std::vector< rtl::OUString >& getModuleList( const rtl::OUString& Language );
StaticModuleInformation* getStaticInformationForModule( const rtl::OUString& Module,
const rtl::OUString& Language );
bool checkModuleMatchForExtension( const rtl::OUString& Database, const rtl::OUString& doclist );
KeywordInfo* getKeyword( const rtl::OUString& Module,
const rtl::OUString& Language );
helpdatafileproxy::Hdf* getHelpDataFile( const rtl::OUString& Module,
const rtl::OUString& Language, bool helpText = false,
const rtl::OUString* pExtensionPath = NULL );
/**
* The following method returns the Collator for the given language-country combination
*/
com::sun::star::uno::Reference< com::sun::star::i18n::XCollator >
getCollator( const rtl::OUString& Language,
const rtl::OUString& System ); // System not used by current implementation
// // of XCollator
/**
* Returns a copy of the popupfile
*/
void popupDocument( URLParameter* urlPar,char **buffer,int *byteCount );
/**
* Returns the cascading stlye sheet used to format the HTML-output.
* First try is language directory, second try is main installation directory.
*/
void cascadingStylesheet( const rtl::OUString& Language,
char** buffer,
int* byteCount );
/**
* Changes the stylesheet for further reads.
*/
void changeCSS(const rtl::OUString& newStyleSheet);
/**
* Returns the active help text for the given module, language and id.
*/
void setActiveText( const rtl::OUString& Module,
const rtl::OUString& Language,
const rtl::OUString& Id,
char** buffer,
int* byteCount );
/**
* Has the purpose of forcing the jarfile to stay open
*/
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
jarFile( const rtl::OUString& jar,
const rtl::OUString& Language );
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
findJarFileForPath( const rtl::OUString& jar, const rtl::OUString& Language,
const rtl::OUString& path, rtl::OUString* o_pExtensionPath = NULL,
rtl::OUString* o_pExtensionRegistryPath = NULL );
/**
* Maps a given language-locale combination to language.
*/
rtl::OUString processLang( const rtl::OUString& Language );
/**
* Maps a given language-locale combination to locale.
* The returned string maybe empty
*/
rtl::OUString country( const rtl::OUString& Language );
void replaceName( rtl::OUString& oustring ) const;
rtl::OUString getProductName() const { return m_vReplacement[0]; }
rtl::OUString getProductVersion() const { return m_vReplacement[1]; }
rtl::OUString expandURL( const rtl::OUString& aURL );
static rtl::OUString expandURL( const rtl::OUString& aURL,
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext );
private:
osl::Mutex m_aMutex;
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > m_xContext;
com::sun::star::uno::Reference< com::sun::star::lang::XMultiComponentFactory > m_xSMgr;
com::sun::star::uno::Reference< com::sun::star::ucb::XSimpleFileAccess3 > m_xSFA;
bool m_bShowBasic;
char* m_pErrorDoc;
int m_nCustomCSSDocLength;
char* m_pCustomCSSDoc;
rtl::OUString m_aCSS;
enum {
PRODUCTNAME = 0,
PRODUCTVERSION,
VENDORNAME,
VENDORVERSION,
VENDORSHORT,
NEWPRODUCTNAME,
NEWPRODUCTVERSION
};
int m_vAdd[7];
rtl::OUString m_vReplacement[7];
rtl::OUString newProdName,newProdVersion,
prodName,prodVersion,vendName,vendVersion,vendShort;
rtl::OUString m_aInstallDirectory; // Installation directory
com::sun::star::uno::Sequence< rtl::OUString > m_aImagesZipPaths;
rtl::OString m_aImagesZipFileURL;
sal_Int16 m_nSymbolsStyle;
std::vector< rtl::OUString > m_avModules;
typedef boost::unordered_map< rtl::OUString,helpdatafileproxy::Hdf*,ha,eq > DatabasesTable;
DatabasesTable m_aDatabases; // Language and module dependent databases
typedef boost::unordered_map< rtl::OUString,rtl::OUString,ha,eq > LangSetTable;
LangSetTable m_aLangSet; // Mapping to of lang-country to lang
typedef boost::unordered_map< rtl::OUString,StaticModuleInformation*,ha,eq > ModInfoTable;
ModInfoTable m_aModInfo; // Module information
typedef boost::unordered_map< rtl::OUString,KeywordInfo*,ha,eq > KeywordInfoTable;
KeywordInfoTable m_aKeywordInfo; // Module information
typedef
boost::unordered_map<
rtl::OUString,
::com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >,
ha,
eq > ZipFileTable;
ZipFileTable m_aZipFileTable; // No closing of an once opened jarfile
typedef
boost::unordered_map<
rtl::OUString,
::com::sun::star::uno::Reference< com::sun::star::i18n::XCollator >,
ha,
eq > CollatorTable;
CollatorTable m_aCollatorTable;
struct ostring_eq
{
bool operator()( const rtl::OString& rKey1, const rtl::OString& rKey2 ) const
{
return rKey1.compareTo( rKey2 ) == 0;
}
};
struct ostring_ha
{
size_t operator()( const rtl::OString& rName ) const
{
return rName.hashCode();
}
};
typedef
boost::unordered_set<
rtl::OString,
ostring_ha,
ostring_eq > EmptyActiveTextSet;
EmptyActiveTextSet m_aEmptyActiveTextSet;
// methods
void setInstallPath( const rtl::OUString& aInstallDirectory );
}; // end class Databases
//===================================================================
enum IteratorState
{
INITIAL_MODULE,
//SHARED_MODULE, // Later, avoids redundancies in help compiling
USER_EXTENSIONS,
SHARED_EXTENSIONS,
BUNDLED_EXTENSIONS,
END_REACHED
};
// Hashtable to cache extension help status
typedef boost::unordered_map
<
::rtl::OUString,
bool,
Databases::ha,
Databases::eq
>
ExtensionHelpExistanceMap;
class ExtensionIteratorBase
{
static ExtensionHelpExistanceMap aHelpExistanceMap;
public:
ExtensionIteratorBase( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
Databases& rDatabases, const rtl::OUString& aInitialModule, const rtl::OUString& aLanguage );
ExtensionIteratorBase( Databases& rDatabases, const rtl::OUString& aInitialModule,
const rtl::OUString& aLanguage );
void init( void );
private:
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetHelpPackageFromPackage
( const com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
protected:
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextUserHelpPackage
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextSharedHelpPackage
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > implGetNextBundledHelpPackage
( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle );
rtl::OUString implGetFileFromPackage( const rtl::OUString& rFileExtension,
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
void implGetLanguageVectorFromPackage( ::std::vector< ::rtl::OUString > &rv,
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > m_xContext;
com::sun::star::uno::Reference< com::sun::star::ucb::XSimpleFileAccess3 > m_xSFA;
Databases& m_rDatabases;
IteratorState m_eState;
rtl::OUString m_aExtensionPath;
rtl::OUString m_aInitialModule;
rtl::OUString m_aLanguage;
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
< com::sun::star::deployment::XPackage > > m_aUserPackagesSeq;
bool m_bUserPackagesLoaded;
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
< com::sun::star::deployment::XPackage > > m_aSharedPackagesSeq;
bool m_bSharedPackagesLoaded;
com::sun::star::uno::Sequence< com::sun::star::uno::Reference
< com::sun::star::deployment::XPackage > > m_aBundledPackagesSeq;
bool m_bBundledPackagesLoaded;
int m_iUserPackage;
int m_iSharedPackage;
int m_iBundledPackage;
}; // end class ExtensionIteratorBase
//===================================================================
class DataBaseIterator : public ExtensionIteratorBase
{
public:
DataBaseIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
Databases& rDatabases, const rtl::OUString& aInitialModule, const rtl::OUString& aLanguage, bool bHelpText )
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
, m_bHelpText( bHelpText )
{}
DataBaseIterator( Databases& rDatabases, const rtl::OUString& aInitialModule,
const rtl::OUString& aLanguage, bool bHelpText )
: ExtensionIteratorBase( rDatabases, aInitialModule, aLanguage )
, m_bHelpText( bHelpText )
{}
helpdatafileproxy::Hdf* nextHdf( rtl::OUString* o_pExtensionPath = NULL, rtl::OUString* o_pExtensionRegistryPath = NULL );
private:
helpdatafileproxy::Hdf* implGetHdfFromPackage(
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
rtl::OUString* o_pExtensionPath, rtl::OUString* o_pExtensionRegistryPath );
bool m_bHelpText;
}; // end class DataBaseIterator
//===================================================================
class KeyDataBaseFileIterator : public ExtensionIteratorBase
{
public:
KeyDataBaseFileIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
Databases& rDatabases, const rtl::OUString& aInitialModule, const rtl::OUString& aLanguage )
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
{}
//Returns a file URL
rtl::OUString nextDbFile( bool& o_rbExtension );
private:
rtl::OUString implGetDbFileFromPackage(
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
}; // end class KeyDataBaseFileIterator
//===================================================================
class JarFileIterator : public ExtensionIteratorBase
{
public:
JarFileIterator( com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > xContext,
Databases& rDatabases, const rtl::OUString& aInitialModule, const rtl::OUString& aLanguage )
: ExtensionIteratorBase( xContext, rDatabases, aInitialModule, aLanguage )
{}
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
nextJarFile( com::sun::star::uno::Reference< com::sun::star::deployment::XPackage >& o_xParentPackageBundle,
rtl::OUString* o_pExtensionPath = NULL, rtl::OUString* o_pExtensionRegistryPath = NULL );
private:
com::sun::star::uno::Reference< com::sun::star::container::XHierarchicalNameAccess >
implGetJarFromPackage(com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage,
rtl::OUString* o_pExtensionPath = NULL, rtl::OUString* o_pExtensionRegistryPath = NULL );
}; // end class JarFileIterator
//===================================================================
class IndexFolderIterator : public ExtensionIteratorBase
{
public:
IndexFolderIterator( Databases& rDatabases, const rtl::OUString& aInitialModule, const rtl::OUString& aLanguage )
: ExtensionIteratorBase( rDatabases, aInitialModule, aLanguage )
{}
rtl::OUString nextIndexFolder( bool& o_rbExtension, bool& o_rbTemporary );
void deleteTempIndexFolder( const rtl::OUString& aIndexFolder );
private:
rtl::OUString implGetIndexFolderFromPackage( bool& o_rbTemporary,
com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage );
}; // end class KeyDataBaseFileIterator
//===================================================================
} // end namespace chelp
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
