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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qhelpenginecore.h"
#include "qhelpengine_p.h"
#include "qhelpdbreader_p.h"
#include "qhelpcollectionhandler_p.h"
#include <QtCore/QDir>
#include <QtCore/QFile>
#include <QtCore/QLibrary>
#include <QtCore/QPluginLoader>
#include <QtCore/QFileInfo>
#include <QtCore/QThread>
#include <QtGui/QApplication>
#include <QtSql/QSqlQuery>
QT_BEGIN_NAMESPACE
QHelpEngineCorePrivate::QHelpEngineCorePrivate()
{
QHelpGlobal::uniquifyConnectionName(QString(), this);
autoSaveFilter = true;
}
void QHelpEngineCorePrivate::init(const QString &collectionFile,
QHelpEngineCore *helpEngineCore)
{
q = helpEngineCore;
collectionHandler = new QHelpCollectionHandler(collectionFile, helpEngineCore);
connect(collectionHandler, SIGNAL(error(QString)),
this, SLOT(errorReceived(QString)));
needsSetup = true;
}
QHelpEngineCorePrivate::~QHelpEngineCorePrivate()
{
delete collectionHandler;
clearMaps();
}
void QHelpEngineCorePrivate::clearMaps()
{
QMap<QString, QHelpDBReader*>::iterator it = readerMap.begin();
while (it != readerMap.end()) {
delete it.value();
++it;
}
readerMap.clear();
fileNameReaderMap.clear();
virtualFolderMap.clear();
orderedFileNameList.clear();
}
bool QHelpEngineCorePrivate::setup()
{
error.clear();
if (!needsSetup)
return true;
needsSetup = false;
emit q->setupStarted();
clearMaps();
if (!collectionHandler->openCollectionFile()) {
emit q->setupFinished();
return false;
}
const QHelpCollectionHandler::DocInfoList docList =
collectionHandler->registeredDocumentations();
QFileInfo fi(collectionHandler->collectionFile());
QString absFileName;
foreach(const QHelpCollectionHandler::DocInfo &info, docList) {
if (QDir::isAbsolutePath(info.fileName)) {
absFileName = info.fileName;
} else {
absFileName = QFileInfo(fi.absolutePath() + QDir::separator() + info.fileName)
.absoluteFilePath();
}
QHelpDBReader *reader = new QHelpDBReader(absFileName,
QHelpGlobal::uniquifyConnectionName(info.fileName, this), this);
if (!reader->init()) {
emit q->warning(QHelpEngineCore::tr("Cannot open documentation file %1: %2!")
.arg(absFileName, reader->errorMessage()));
continue;
}
readerMap.insert(info.namespaceName, reader);
fileNameReaderMap.insert(absFileName, reader);
virtualFolderMap.insert(info.folderName, reader);
orderedFileNameList.append(absFileName);
}
q->currentFilter();
emit q->setupFinished();
return true;
}
void QHelpEngineCorePrivate::errorReceived(const QString &msg)
{
error = msg;
}
/*!
\class QHelpEngineCore
\since 4.4
\inmodule QtHelp
\brief The QHelpEngineCore class provides the core functionality
of the help system.
Before the help engine can be used, it must be initialized by
calling setupData(). At the beginning of the setup process the
signal setupStarted() is emitted. From this point on until
the signal setupFinished() is emitted, is the help data in an
undefined meaning unusable state.
The core help engine can be used to perform different tasks.
By calling linksForIdentifier() the engine returns
urls specifying the file locations inside the help system. The
actual file data can then be retrived by calling fileData(). In
contrast to all other functions in this class, linksForIdentifier()
depends on the currently set custom filter. Depending on the filter,
the function may return different hits.
Every help engine can contain any number of custom filters. A custom
filter is defined by a name and set of filter attributes and can be
added to the help engine by calling addCustomFilter(). Analogous,
it is removed by calling removeCustomFilter(). customFilters() returns
all defined filters.
The help engine also offers the possibility to set and read values
in a persistant way comparable to ini files or Windows registry
entries. For more information see setValue() or value().
This class does not offer any GUI components or functionality for
indices or contents. If you need one of those use QHelpEngine
instead.
When creating a custom help viewer the viewer can be
configured by writing a custom collection file which could contain various
keywords to be used to configure the help engine. These keywords and values
and their meaning can be found in the help information for
\l{assistant-custom-help-viewer.html#creating-a-custom-help-collection-file}
{creating a custom help collection file} for Assistant.
*/
/*!
\fn void QHelpEngineCore::setupStarted()
This signal is emitted when setup is started.
*/
/*!
\fn void QHelpEngineCore::setupFinished()
This signal is emitted when the setup is complete.
*/
/*!
\fn void QHelpEngineCore::currentFilterChanged(const QString &newFilter)
This signal is emitted when the current filter is changed to
\a newFilter.
*/
/*!
\fn void QHelpEngineCore::warning(const QString &msg)
This signal is emitted when a non critical error occurs.
The warning message is stored in \a msg.
*/
/*!
Constructs a new core help engine with a \a parent. The help engine
uses the information stored in the \a collectionFile to provide help.
If the collection file does not exist yet, it'll be created.
*/
QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent)
: QObject(parent)
{
d = new QHelpEngineCorePrivate();
d->init(collectionFile, this);
}
/*!
\internal
*/
QHelpEngineCore::QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate,
QObject *parent)
: QObject(parent)
{
d = helpEngineCorePrivate;
}
/*!
Destructs the help engine.
*/
QHelpEngineCore::~QHelpEngineCore()
{
delete d;
}
/*!
\property QHelpEngineCore::collectionFile
\brief the absolute file name of the collection file currently used.
\since 4.5
Setting this property leaves the help engine in an invalid state. It is
important to invoke setupData() or any getter function in order to setup
the help engine again.
*/
QString QHelpEngineCore::collectionFile() const
{
return d->collectionHandler->collectionFile();
}
void QHelpEngineCore::setCollectionFile(const QString &fileName)
{
if (fileName == collectionFile())
return;
if (d->collectionHandler) {
delete d->collectionHandler;
d->collectionHandler = 0;
d->clearMaps();
}
d->init(fileName, this);
d->needsSetup = true;
}
/*!
Sets up the help engine by processing the information found
in the collection file and returns true if successful; otherwise
returns false.
By calling the function, the help
engine is forced to initialize itself immediately. Most of
the times, this function does not have to be called
explicitly because getter functions which depend on a correctly
set up help engine do that themselves.
\note \c{qsqlite4.dll} needs to be deployed with the application as the
help system uses the sqlite driver when loading help collections.
*/
bool QHelpEngineCore::setupData()
{
d->needsSetup = true;
return d->setup();
}
/*!
Creates the file \a fileName and copies all contents from
the current collection file into the newly created file,
and returns true if successful; otherwise returns false.
The copying process makes sure that file references to Qt
Collection files (\c{.qch}) files are updated accordingly.
*/
bool QHelpEngineCore::copyCollectionFile(const QString &fileName)
{
if (!d->setup())
return false;
return d->collectionHandler->copyCollectionFile(fileName);
}
/*!
Returns the namespace name defined for the Qt compressed help file (.qch)
specified by its \a documentationFileName. If the file is not valid, an
empty string is returned.
\sa documentationFileName()
*/
QString QHelpEngineCore::namespaceName(const QString &documentationFileName)
{
QHelpDBReader reader(documentationFileName,
QHelpGlobal::uniquifyConnectionName(QLatin1String("GetNamespaceName"),
QThread::currentThread()), 0);
if (reader.init())
return reader.namespaceName();
return QString();
}
/*!
Registers the Qt compressed help file (.qch) contained in the file
\a documentationFileName. One compressed help file, uniquely
identified by its namespace can only be registered once.
True is returned if the registration was successful, otherwise
false.
\sa unregisterDocumentation(), error()
*/
bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)
{
d->error.clear();
d->needsSetup = true;
return d->collectionHandler->registerDocumentation(documentationFileName);
}
/*!
Unregisters the Qt compressed help file (.qch) identified by its
\a namespaceName from the help collection. Returns true
on success, otherwise false.
\sa registerDocumentation(), error()
*/
bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)
{
d->error.clear();
d->needsSetup = true;
return d->collectionHandler->unregisterDocumentation(namespaceName);
}
/*!
Returns the absolute file name of the Qt compressed help file (.qch)
identified by the \a namespaceName. If there is no Qt compressed help file
with the specified namespace registered, an empty string is returned.
\sa namespaceName()
*/
QString QHelpEngineCore::documentationFileName(const QString &namespaceName)
{
if (d->setup()) {
const QHelpCollectionHandler::DocInfoList docList =
d->collectionHandler->registeredDocumentations();
foreach(const QHelpCollectionHandler::DocInfo &info, docList) {
if (info.namespaceName == namespaceName) {
if (QDir::isAbsolutePath(info.fileName))
return QDir::cleanPath(info.fileName);
QFileInfo fi(d->collectionHandler->collectionFile());
fi.setFile(fi.absolutePath() + QDir::separator() + info.fileName);
return QDir::cleanPath(fi.absoluteFilePath());
}
}
}
return QString();
}
/*!
Returns a list of all registered Qt compressed help files of the current collection file.
The returned names are the namespaces of the registered Qt compressed help files (.qch).
*/
QStringList QHelpEngineCore::registeredDocumentations() const
{
QStringList list;
if (!d->setup())
return list;
const QHelpCollectionHandler::DocInfoList docList = d->collectionHandler->registeredDocumentations();
foreach(const QHelpCollectionHandler::DocInfo &info, docList) {
list.append(info.namespaceName);
}
return list;
}
/*!
Returns a list of custom filters.
\sa addCustomFilter(), removeCustomFilter()
*/
QStringList QHelpEngineCore::customFilters() const
{
if (!d->setup())
return QStringList();
return d->collectionHandler->customFilters();
}
/*!
Adds the new custom filter \a filterName. The filter attributes
are specified by \a attributes. If the filter already exists,
its attribute set is replaced. The function returns true if
the operation succeeded, otherwise it returns false.
\sa customFilters(), removeCustomFilter()
*/
bool QHelpEngineCore::addCustomFilter(const QString &filterName,
const QStringList &attributes)
{
d->error.clear();
d->needsSetup = true;
return d->collectionHandler->addCustomFilter(filterName,
attributes);
}
/*!
Returns true if the filter \a filterName was removed successfully,
otherwise false.
\sa addCustomFilter(), customFilters()
*/
bool QHelpEngineCore::removeCustomFilter(const QString &filterName)
{
d->error.clear();
d->needsSetup = true;
return d->collectionHandler->removeCustomFilter(filterName);
}
/*!
Returns a list of all defined filter attributes.
*/
QStringList QHelpEngineCore::filterAttributes() const
{
if (!d->setup())
return QStringList();
return d->collectionHandler->filterAttributes();
}
/*!
Returns a list of filter attributes used by the custom
filter \a filterName.
*/
QStringList QHelpEngineCore::filterAttributes(const QString &filterName) const
{
if (!d->setup())
return QStringList();
return d->collectionHandler->filterAttributes(filterName);
}
/*!
\property QHelpEngineCore::currentFilter
\brief the name of the custom filter currently applied.
\since 4.5
Setting this property will save the new custom filter permanently in the
help collection file. To set a custom filter without saving it
permanently, disable the auto save filter mode.
\sa autoSaveFilter()
*/
QString QHelpEngineCore::currentFilter() const
{
if (!d->setup())
return QString();
if (d->currentFilter.isEmpty()) {
QString filter =
d->collectionHandler->customValue(QLatin1String("CurrentFilter"),
QString()).toString();
if (!filter.isEmpty()
&& d->collectionHandler->customFilters().contains(filter))
d->currentFilter = filter;
}
return d->currentFilter;
}
void QHelpEngineCore::setCurrentFilter(const QString &filterName)
{
if (!d->setup() || filterName == d->currentFilter)
return;
d->currentFilter = filterName;
if (d->autoSaveFilter) {
d->collectionHandler->setCustomValue(QLatin1String("CurrentFilter"),
d->currentFilter);
}
emit currentFilterChanged(d->currentFilter);
}
/*!
Returns a list of filter attributes for the different filter sections
defined in the Qt compressed help file with the given namespace
\a namespaceName.
*/
QList<QStringList> QHelpEngineCore::filterAttributeSets(const QString &namespaceName) const
{
if (d->setup()) {
QHelpDBReader *reader = d->readerMap.value(namespaceName);
if (reader)
return reader->filterAttributeSets();
}
return QList<QStringList>();
}
/*!
Returns a list of files contained in the Qt compressed help file \a
namespaceName. The files can be filtered by \a filterAttributes as
well as by their extension \a extensionFilter (e.g. 'html').
*/
QList<QUrl> QHelpEngineCore::files(const QString namespaceName,
const QStringList &filterAttributes,
const QString &extensionFilter)
{
QList<QUrl> res;
if (!d->setup())
return res;
QHelpDBReader *reader = d->readerMap.value(namespaceName);
if (!reader) {
d->error = tr("The specified namespace does not exist!");
return res;
}
QUrl url;
url.setScheme(QLatin1String("qthelp"));
url.setAuthority(namespaceName);
const QStringList files = reader->files(filterAttributes, extensionFilter);
foreach (const QString &file, files) {
url.setPath(QLatin1String("/") + file);
res.append(url);
}
return res;
}
/*!
Returns an invalid URL if the file \a url cannot be found.
If the file exists, either the same url is returned or a
different url if the file is located in a different namespace
which is merged via a common virtual folder.
*/
QUrl QHelpEngineCore::findFile(const QUrl &url) const
{
QUrl res;
if (!d->setup() || !url.isValid() || url.toString().count(QLatin1Char('/')) < 4
|| url.scheme() != QLatin1String("qthelp"))
return res;
QString ns = url.authority();
QString filePath = QDir::cleanPath(url.path());
if (filePath.startsWith(QLatin1Char('/')))
filePath = filePath.mid(1);
QString virtualFolder = filePath.mid(0, filePath.indexOf(QLatin1Char('/'), 1));
filePath = filePath.mid(virtualFolder.length()+1);
QHelpDBReader *defaultReader = 0;
if (d->readerMap.contains(ns)) {
defaultReader = d->readerMap.value(ns);
if (defaultReader->fileExists(virtualFolder, filePath))
return url;
}
QStringList filterAtts = filterAttributes(currentFilter());
foreach (QHelpDBReader *reader, d->virtualFolderMap.values(virtualFolder)) {
if (reader == defaultReader)
continue;
if (reader->fileExists(virtualFolder, filePath, filterAtts)) {
res = url;
res.setAuthority(reader->namespaceName());
return res;
}
}
foreach (QHelpDBReader *reader, d->virtualFolderMap.values(virtualFolder)) {
if (reader == defaultReader)
continue;
if (reader->fileExists(virtualFolder, filePath)) {
res = url;
res.setAuthority(reader->namespaceName());
break;
}
}
return res;
}
/*!
Returns the data of the file specified by \a url. If the
file does not exist, an empty QByteArray is returned.
\sa findFile()
*/
QByteArray QHelpEngineCore::fileData(const QUrl &url) const
{
if (!d->setup() || !url.isValid() || url.toString().count(QLatin1Char('/')) < 4
|| url.scheme() != QLatin1String("qthelp"))
return QByteArray();
QString ns = url.authority();
QString filePath = QDir::cleanPath(url.path());
if (filePath.startsWith(QLatin1Char('/')))
filePath = filePath.mid(1);
QString virtualFolder = filePath.mid(0, filePath.indexOf(QLatin1Char('/'), 1));
filePath = filePath.mid(virtualFolder.length()+1);
QByteArray ba;
QHelpDBReader *defaultReader = 0;
if (d->readerMap.contains(ns)) {
defaultReader = d->readerMap.value(ns);
ba = defaultReader->fileData(virtualFolder, filePath);
}
if (ba.isEmpty()) {
foreach (QHelpDBReader *reader, d->virtualFolderMap.values(virtualFolder)) {
if (reader == defaultReader)
continue;
ba = reader->fileData(virtualFolder, filePath);
if (!ba.isEmpty())
return ba;
}
}
return ba;
}
/*!
Returns a map of hits found for the \a id. A hit contains the
title of the document and the url where the keyword is located.
The result depends on the current filter, meaning only the keywords
registered for the current filter will be returned.
*/
QMap<QString, QUrl> QHelpEngineCore::linksForIdentifier(const QString &id) const
{
QMap<QString, QUrl> linkMap;
if (!d->setup())
return linkMap;
QStringList atts = filterAttributes(d->currentFilter);
foreach (QHelpDBReader *reader, d->readerMap)
reader->linksForIdentifier(id, atts, linkMap);
return linkMap;
}
/*!
Removes the \a key from the settings section in the
collection file. Returns true if the value was removed
successfully, otherwise false.
\sa customValue(), setCustomValue()
*/
bool QHelpEngineCore::removeCustomValue(const QString &key)
{
d->error.clear();
return d->collectionHandler->removeCustomValue(key);
}
/*!
Returns the value assigned to the \a key. If the requested
key does not exist, the specified \a defaultValue is
returned.
\sa setCustomValue(), removeCustomValue()
*/
QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue) const
{
if (!d->setup())
return QVariant();
return d->collectionHandler->customValue(key, defaultValue);
}
/*!
Save the \a value under the \a key. If the key already exist,
the value will be overwritten. Returns true if the value was
saved successfully, otherwise false.
\sa customValue(), removeCustomValue()
*/
bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)
{
d->error.clear();
return d->collectionHandler->setCustomValue(key, value);
}
/*!
Returns the meta data for the Qt compressed help file \a
documentationFileName. If there is no data available for
\a name, an invalid QVariant() is returned. The meta
data is defined when creating the Qt compressed help file and
cannot be modified later. Common meta data includes e.g.
the author of the documentation.
*/
QVariant QHelpEngineCore::metaData(const QString &documentationFileName,
const QString &name)
{
QHelpDBReader reader(documentationFileName, QLatin1String("GetMetaData"), 0);
if (reader.init())
return reader.metaData(name);
return QVariant();
}
/*!
Returns a description of the last error that occurred.
*/
QString QHelpEngineCore::error() const
{
return d->error;
}
/*!
\property QHelpEngineCore::autoSaveFilter
\brief whether QHelpEngineCore is in auto save filter mode or not.
\since 4.5
If QHelpEngineCore is in auto save filter mode, the current filter is
automatically saved when it is changed by the setCurrentFilter()
function. The filter is saved persistently in the help collection file.
By default, this mode is on.
*/
void QHelpEngineCore::setAutoSaveFilter(bool save)
{
d->autoSaveFilter = save;
}
bool QHelpEngineCore::autoSaveFilter() const
{
return d->autoSaveFilter;
}
QT_END_NAMESPACE
|