forked from qt-creator/qt-creator
b2a766a79a
Courtesy of readability-static-accessed-through-instance Change-Id: I71f54244f1e091315dac2943d9e1bfad6efa56a9 Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
498 lines
15 KiB
C++
498 lines
15 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "helpmanager.h"
|
|
|
|
#include <coreplugin/icore.h>
|
|
#include <coreplugin/progressmanager/progressmanager.h>
|
|
#include <utils/algorithm.h>
|
|
#include <utils/filesystemwatcher.h>
|
|
#include <utils/qtcassert.h>
|
|
#include <utils/runextensions.h>
|
|
|
|
#include <QDateTime>
|
|
#include <QDebug>
|
|
#include <QDir>
|
|
#include <QFileInfo>
|
|
#include <QStringList>
|
|
#include <QUrl>
|
|
|
|
#include <QHelpEngineCore>
|
|
|
|
#include <QMutexLocker>
|
|
|
|
#ifndef HELP_NEW_FILTER_ENGINE
|
|
#include <QSqlDatabase>
|
|
#include <QSqlDriver>
|
|
#include <QSqlError>
|
|
#include <QSqlQuery>
|
|
#else
|
|
#include <QtHelp/QHelpLink>
|
|
#endif
|
|
|
|
using namespace Core;
|
|
|
|
static const char kUserDocumentationKey[] = "Help/UserDocumentation";
|
|
static const char kUpdateDocumentationTask[] = "UpdateDocumentationTask";
|
|
|
|
namespace Help {
|
|
namespace Internal {
|
|
|
|
struct HelpManagerPrivate
|
|
{
|
|
HelpManagerPrivate() = default;
|
|
~HelpManagerPrivate();
|
|
|
|
const QStringList documentationFromInstaller();
|
|
void readSettings();
|
|
void writeSettings();
|
|
void cleanUpDocumentation();
|
|
|
|
bool m_needsSetup = true;
|
|
QHelpEngineCore *m_helpEngine = nullptr;
|
|
Utils::FileSystemWatcher *m_collectionWatcher = nullptr;
|
|
|
|
// data for delayed initialization
|
|
QSet<QString> m_filesToRegister;
|
|
QSet<QString> m_nameSpacesToUnregister;
|
|
QHash<QString, QVariant> m_customValues;
|
|
|
|
QSet<QString> m_userRegisteredFiles;
|
|
|
|
QMutex m_helpengineMutex;
|
|
QFuture<bool> m_registerFuture;
|
|
};
|
|
|
|
static HelpManager *m_instance = nullptr;
|
|
static HelpManagerPrivate *d = nullptr;
|
|
|
|
#ifndef HELP_NEW_FILTER_ENGINE
|
|
|
|
// -- DbCleaner
|
|
|
|
struct DbCleaner
|
|
{
|
|
DbCleaner(const QString &dbName) : name(dbName) {}
|
|
~DbCleaner() { QSqlDatabase::removeDatabase(name); }
|
|
QString name;
|
|
};
|
|
|
|
#endif
|
|
|
|
// -- HelpManager
|
|
|
|
HelpManager::HelpManager(QObject *parent) :
|
|
QObject(parent)
|
|
{
|
|
QTC_CHECK(!m_instance);
|
|
m_instance = this;
|
|
d = new HelpManagerPrivate;
|
|
}
|
|
|
|
HelpManager::~HelpManager()
|
|
{
|
|
delete d;
|
|
m_instance = nullptr;
|
|
}
|
|
|
|
HelpManager *HelpManager::instance()
|
|
{
|
|
Q_ASSERT(m_instance);
|
|
return m_instance;
|
|
}
|
|
|
|
QString HelpManager::collectionFilePath()
|
|
{
|
|
return QDir::cleanPath(ICore::userResourcePath()
|
|
+ QLatin1String("/helpcollection.qhc"));
|
|
}
|
|
|
|
void HelpManager::registerDocumentation(const QStringList &files)
|
|
{
|
|
if (d->m_needsSetup) {
|
|
for (const QString &filePath : files)
|
|
d->m_filesToRegister.insert(filePath);
|
|
return;
|
|
}
|
|
|
|
QFuture<bool> future = Utils::runAsync(&HelpManager::registerDocumentationNow, files);
|
|
Utils::onResultReady(future, this, [](bool docsChanged){
|
|
if (docsChanged) {
|
|
d->m_helpEngine->setupData();
|
|
emit Core::HelpManager::Signals::instance()->documentationChanged();
|
|
}
|
|
});
|
|
ProgressManager::addTask(future, tr("Update Documentation"), kUpdateDocumentationTask);
|
|
}
|
|
|
|
void HelpManager::unregisterDocumentation(const QStringList &fileNames)
|
|
{
|
|
if (fileNames.isEmpty())
|
|
return;
|
|
const auto getNamespaces = [](const QStringList &fileNames) {
|
|
QMutexLocker locker(&d->m_helpengineMutex);
|
|
return Utils::transform(fileNames, [](const QString &filePath) {
|
|
return QHelpEngineCore::namespaceName(filePath);
|
|
});
|
|
};
|
|
unregisterNamespaces(getNamespaces(fileNames));
|
|
}
|
|
|
|
void HelpManager::registerDocumentationNow(QFutureInterface<bool> &futureInterface,
|
|
const QStringList &files)
|
|
{
|
|
QMutexLocker locker(&d->m_helpengineMutex);
|
|
|
|
futureInterface.setProgressRange(0, files.count());
|
|
futureInterface.setProgressValue(0);
|
|
|
|
QHelpEngineCore helpEngine(collectionFilePath());
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
|
|
helpEngine.setReadOnly(false);
|
|
#endif
|
|
helpEngine.setupData();
|
|
bool docsChanged = false;
|
|
QStringList nameSpaces = helpEngine.registeredDocumentations();
|
|
for (const QString &file : files) {
|
|
if (futureInterface.isCanceled())
|
|
break;
|
|
futureInterface.setProgressValue(futureInterface.progressValue() + 1);
|
|
const QString &nameSpace = QHelpEngineCore::namespaceName(file);
|
|
if (nameSpace.isEmpty())
|
|
continue;
|
|
if (!nameSpaces.contains(nameSpace)) {
|
|
if (helpEngine.registerDocumentation(file)) {
|
|
nameSpaces.append(nameSpace);
|
|
docsChanged = true;
|
|
} else {
|
|
qWarning() << "Error registering namespace '" << nameSpace
|
|
<< "' from file '" << file << "':" << helpEngine.error();
|
|
}
|
|
}
|
|
}
|
|
futureInterface.reportResult(docsChanged);
|
|
}
|
|
|
|
void HelpManager::unregisterNamespaces(const QStringList &nameSpaces)
|
|
{
|
|
if (d->m_needsSetup) {
|
|
for (const QString &name : nameSpaces)
|
|
d->m_nameSpacesToUnregister.insert(name);
|
|
return;
|
|
}
|
|
|
|
QMutexLocker locker(&d->m_helpengineMutex);
|
|
bool docsChanged = false;
|
|
for (const QString &nameSpace : nameSpaces) {
|
|
const QString filePath = d->m_helpEngine->documentationFileName(nameSpace);
|
|
if (filePath.isEmpty()) // wasn't registered anyhow, ignore
|
|
continue;
|
|
if (d->m_helpEngine->unregisterDocumentation(nameSpace)) {
|
|
docsChanged = true;
|
|
d->m_userRegisteredFiles.remove(filePath);
|
|
} else {
|
|
qWarning() << "Error unregistering namespace '" << nameSpace
|
|
<< "' from file '" << filePath
|
|
<< "': " << d->m_helpEngine->error();
|
|
}
|
|
}
|
|
locker.unlock();
|
|
if (docsChanged)
|
|
emit Core::HelpManager::Signals::instance()->documentationChanged();
|
|
}
|
|
|
|
void HelpManager::registerUserDocumentation(const QStringList &filePaths)
|
|
{
|
|
for (const QString &filePath : filePaths)
|
|
d->m_userRegisteredFiles.insert(filePath);
|
|
m_instance->registerDocumentation(filePaths);
|
|
}
|
|
|
|
QSet<QString> HelpManager::userDocumentationPaths()
|
|
{
|
|
return d->m_userRegisteredFiles;
|
|
}
|
|
|
|
// This should go into Qt 4.8 once we start using it for Qt Creator
|
|
QMultiMap<QString, QUrl> HelpManager::linksForKeyword(const QString &key)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
if (key.isEmpty())
|
|
return {};
|
|
#ifndef HELP_NEW_FILTER_ENGINE
|
|
return d->m_helpEngine->linksForKeyword(key);
|
|
#else
|
|
QMultiMap<QString, QUrl> links;
|
|
const QList<QHelpLink> docs = d->m_helpEngine->documentsForKeyword(key, QString());
|
|
for (const auto &doc : docs)
|
|
links.insert(doc.title, doc.url);
|
|
return links;
|
|
#endif
|
|
}
|
|
|
|
QMultiMap<QString, QUrl> HelpManager::linksForIdentifier(const QString &id)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
if (id.isEmpty())
|
|
return {};
|
|
#ifndef HELP_NEW_FILTER_ENGINE
|
|
return d->m_helpEngine->linksForIdentifier(id);
|
|
#else
|
|
QMultiMap<QString, QUrl> links;
|
|
const QList<QHelpLink> docs = d->m_helpEngine->documentsForIdentifier(id, QString());
|
|
for (const auto &doc : docs)
|
|
links.insert(doc.title, doc.url);
|
|
return links;
|
|
#endif
|
|
}
|
|
|
|
QUrl HelpManager::findFile(const QUrl &url)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return d->m_helpEngine->findFile(url);
|
|
}
|
|
|
|
QByteArray HelpManager::fileData(const QUrl &url)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return d->m_helpEngine->fileData(url);
|
|
}
|
|
|
|
void HelpManager::showHelpUrl(const QUrl &url, Core::HelpManager::HelpViewerLocation location)
|
|
{
|
|
emit m_instance->helpRequested(url, location);
|
|
}
|
|
|
|
QStringList HelpManager::registeredNamespaces()
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return d->m_helpEngine->registeredDocumentations();
|
|
}
|
|
|
|
QString HelpManager::namespaceFromFile(const QString &file)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return QHelpEngineCore::namespaceName(file);
|
|
}
|
|
|
|
QString HelpManager::fileFromNamespace(const QString &nameSpace)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return d->m_helpEngine->documentationFileName(nameSpace);
|
|
}
|
|
|
|
void HelpManager::setCustomValue(const QString &key, const QVariant &value)
|
|
{
|
|
if (d->m_needsSetup) {
|
|
d->m_customValues.insert(key, value);
|
|
return;
|
|
}
|
|
if (d->m_helpEngine->setCustomValue(key, value))
|
|
emit m_instance->collectionFileChanged();
|
|
}
|
|
|
|
QVariant HelpManager::customValue(const QString &key, const QVariant &value)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
return d->m_helpEngine->customValue(key, value);
|
|
}
|
|
|
|
#ifndef HELP_NEW_FILTER_ENGINE
|
|
|
|
HelpManager::Filters HelpManager::filters()
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
|
|
Filters filters;
|
|
const QStringList &customFilters = d->m_helpEngine->customFilters();
|
|
for (const QString &filter : customFilters)
|
|
filters.insert(filter, d->m_helpEngine->filterAttributes(filter));
|
|
return filters;
|
|
}
|
|
|
|
HelpManager::Filters HelpManager::fixedFilters()
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
|
|
const QLatin1String sqlite("QSQLITE");
|
|
const QLatin1String name("HelpManager::fixedCustomFilters");
|
|
|
|
Filters fixedFilters;
|
|
DbCleaner cleaner(name);
|
|
QSqlDatabase db = QSqlDatabase::addDatabase(sqlite, name);
|
|
if (db.driver() && db.driver()->lastError().type() == QSqlError::NoError) {
|
|
const QStringList ®isteredDocs = d->m_helpEngine->registeredDocumentations();
|
|
for (const QString &nameSpace : registeredDocs) {
|
|
db.setDatabaseName(d->m_helpEngine->documentationFileName(nameSpace));
|
|
if (db.open()) {
|
|
QSqlQuery query = QSqlQuery(db);
|
|
query.setForwardOnly(true);
|
|
query.exec(QLatin1String("SELECT Name FROM FilterNameTable"));
|
|
while (query.next()) {
|
|
const QString &filter = query.value(0).toString();
|
|
fixedFilters.insert(filter, d->m_helpEngine->filterAttributes(filter));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return fixedFilters;
|
|
}
|
|
|
|
HelpManager::Filters HelpManager::userDefinedFilters()
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return {});
|
|
|
|
Filters all = filters();
|
|
const Filters &fixed = fixedFilters();
|
|
for (Filters::const_iterator it = fixed.constBegin(); it != fixed.constEnd(); ++it)
|
|
all.remove(it.key());
|
|
return all;
|
|
}
|
|
|
|
void HelpManager::removeUserDefinedFilter(const QString &filter)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return);
|
|
|
|
if (d->m_helpEngine->removeCustomFilter(filter))
|
|
emit m_instance->collectionFileChanged();
|
|
}
|
|
|
|
void HelpManager::addUserDefinedFilter(const QString &filter, const QStringList &attr)
|
|
{
|
|
QTC_ASSERT(!d->m_needsSetup, return);
|
|
|
|
if (d->m_helpEngine->addCustomFilter(filter, attr))
|
|
emit m_instance->collectionFileChanged();
|
|
}
|
|
|
|
#endif
|
|
|
|
void HelpManager::aboutToShutdown()
|
|
{
|
|
if (d && d->m_registerFuture.isRunning()) {
|
|
d->m_registerFuture.cancel();
|
|
d->m_registerFuture.waitForFinished();
|
|
}
|
|
}
|
|
|
|
// -- private
|
|
|
|
void HelpManager::setupHelpManager()
|
|
{
|
|
if (!d->m_needsSetup)
|
|
return;
|
|
d->m_needsSetup = false;
|
|
|
|
d->readSettings();
|
|
|
|
// create the help engine
|
|
d->m_helpEngine = new QHelpEngineCore(collectionFilePath(), m_instance);
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
|
|
d->m_helpEngine->setReadOnly(false);
|
|
#endif
|
|
#ifdef HELP_NEW_FILTER_ENGINE
|
|
d->m_helpEngine->setUsesFilterEngine(true);
|
|
#endif
|
|
d->m_helpEngine->setupData();
|
|
|
|
for (const QString &filePath : d->documentationFromInstaller())
|
|
d->m_filesToRegister.insert(filePath);
|
|
|
|
d->cleanUpDocumentation();
|
|
|
|
if (!d->m_nameSpacesToUnregister.isEmpty()) {
|
|
m_instance->unregisterNamespaces(Utils::toList(d->m_nameSpacesToUnregister));
|
|
d->m_nameSpacesToUnregister.clear();
|
|
}
|
|
|
|
if (!d->m_filesToRegister.isEmpty()) {
|
|
m_instance->registerDocumentation(Utils::toList(d->m_filesToRegister));
|
|
d->m_filesToRegister.clear();
|
|
}
|
|
|
|
QHash<QString, QVariant>::const_iterator it;
|
|
for (it = d->m_customValues.constBegin(); it != d->m_customValues.constEnd(); ++it)
|
|
setCustomValue(it.key(), it.value());
|
|
|
|
emit Core::HelpManager::Signals::instance()->setupFinished();
|
|
}
|
|
|
|
void HelpManagerPrivate::cleanUpDocumentation()
|
|
{
|
|
// mark documentation for removal for which there is no documentation file anymore
|
|
// mark documentation for removal that is neither user registered, nor marked for registration
|
|
const QStringList ®isteredDocs = m_helpEngine->registeredDocumentations();
|
|
for (const QString &nameSpace : registeredDocs) {
|
|
const QString filePath = m_helpEngine->documentationFileName(nameSpace);
|
|
if (!QFileInfo::exists(filePath)
|
|
|| (!m_filesToRegister.contains(filePath)
|
|
&& !m_userRegisteredFiles.contains(filePath))) {
|
|
m_nameSpacesToUnregister.insert(nameSpace);
|
|
}
|
|
}
|
|
}
|
|
|
|
HelpManagerPrivate::~HelpManagerPrivate()
|
|
{
|
|
writeSettings();
|
|
delete m_helpEngine;
|
|
m_helpEngine = nullptr;
|
|
}
|
|
|
|
const QStringList HelpManagerPrivate::documentationFromInstaller()
|
|
{
|
|
QSettings *installSettings = ICore::settings();
|
|
const QStringList documentationPaths = installSettings->value(QLatin1String("Help/InstalledDocumentation"))
|
|
.toStringList();
|
|
QStringList documentationFiles;
|
|
for (const QString &path : documentationPaths) {
|
|
QFileInfo pathInfo(path);
|
|
if (pathInfo.isFile() && pathInfo.isReadable()) {
|
|
documentationFiles << pathInfo.absoluteFilePath();
|
|
} else if (pathInfo.isDir()) {
|
|
const QFileInfoList files(QDir(path).entryInfoList(QStringList(QLatin1String("*.qch")),
|
|
QDir::Files | QDir::Readable));
|
|
for (const QFileInfo &fileInfo : files)
|
|
documentationFiles << fileInfo.absoluteFilePath();
|
|
}
|
|
}
|
|
return documentationFiles;
|
|
}
|
|
|
|
void HelpManagerPrivate::readSettings()
|
|
{
|
|
m_userRegisteredFiles = Utils::toSet(ICore::settings()->value(QLatin1String(kUserDocumentationKey))
|
|
.toStringList());
|
|
}
|
|
|
|
void HelpManagerPrivate::writeSettings()
|
|
{
|
|
const QStringList list = Utils::toList(m_userRegisteredFiles);
|
|
ICore::settings()->setValue(QLatin1String(kUserDocumentationKey), list);
|
|
}
|
|
|
|
} // Internal
|
|
} // Core
|