// Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 #include "localhelpmanager.h" #include "bookmarkmanager.h" #include "helpconstants.h" #include "helpmanager.h" #include "helptr.h" #include "helpviewer.h" #include "textbrowserhelpviewer.h" #ifdef QTC_WEBENGINE_HELPVIEWER #include "webenginehelpviewer.h" #include #endif #ifdef QTC_LITEHTML_HELPVIEWER #include "litehtmlhelpviewer.h" #endif #ifdef QTC_MAC_NATIVE_HELPVIEWER #include "macwebkithelpviewer.h" #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace Help::Internal; static LocalHelpManager *m_instance = nullptr; bool LocalHelpManager::m_guiNeedsSetup = true; bool LocalHelpManager::m_needsCollectionFile = true; QMutex LocalHelpManager::m_guiMutex; QHelpEngine* LocalHelpManager::m_guiEngine = nullptr; QMutex LocalHelpManager::m_bkmarkMutex; BookmarkManager* LocalHelpManager::m_bookmarkManager = nullptr; QList LocalHelpManager::m_onlineHelpHandlerList; const char kHelpHomePageKey[] = "Help/HomePage"; const char kFontFamilyKey[] = "Help/FallbackFontFamily"; const char kFontStyleNameKey[] = "Help/FallbackFontStyleName"; const char kFontSizeKey[] = "Help/FallbackFontSize"; const char kFontZoomKey[] = "Help/FontZoom"; const char kAntialiasKey[] = "Help/FontAntialias"; const char kStartOptionKey[] = "Help/StartOption"; const char kContextHelpOptionKey[] = "Help/ContextHelpOption"; const char kReturnOnCloseKey[] = "Help/ReturnOnClose"; const char kUseScrollWheelZooming[] = "Help/UseScrollWheelZooming"; const char kLastShownPagesKey[] = "Help/LastShownPages"; const char kLastSelectedTabKey[] = "Help/LastSelectedTab"; const char kViewerBackend[] = "Help/ViewerBackend"; const int kDefaultFallbackFontSize = 14; const int kDefaultFontZoom = 100; const bool kDefaultAntialias = true; const int kDefaultStartOption = LocalHelpManager::ShowLastPages; const int kDefaultContextHelpOption = Core::HelpManager::SideBySideIfPossible; const bool kDefaultReturnOnClose = false; const bool kDefaultUseScrollWheelZooming = true; static QString defaultFallbackFontFamily() { if (Utils::HostOsInfo::isMacHost()) return QString("Helvetica"); if (Utils::HostOsInfo::isAnyUnixHost()) return QString("Sans Serif"); return QString("Arial"); } static QString defaultFallbackFontStyleName(const QString &fontFamily) { const QStringList styles = QFontDatabase::styles(fontFamily); QTC_ASSERT(!styles.isEmpty(), return QString("Regular")); return styles.first(); } LocalHelpManager::LocalHelpManager(QObject *parent) : QObject(parent) { m_instance = this; qRegisterMetaType("Help::Internal::LocalHelpManager::HelpData"); addOnlineHelpHandler({LocalHelpManager::isQtUrl, LocalHelpManager::openQtUrl}); } LocalHelpManager::~LocalHelpManager() { if (m_bookmarkManager) { m_bookmarkManager->saveBookmarks(); delete m_bookmarkManager; m_bookmarkManager = nullptr; } delete m_guiEngine; m_guiEngine = nullptr; } LocalHelpManager *LocalHelpManager::instance() { return m_instance; } QString LocalHelpManager::defaultHomePage() { const auto version = QVersionNumber::fromString(QCoreApplication::applicationVersion()); static const QString url = QString::fromLatin1("qthelp://org.qt-project.qtcreator." "%1%2%3/doc/index.html") .arg(version.majorVersion()) .arg(version.minorVersion()) .arg(version.microVersion()); return url; } QString LocalHelpManager::homePage() { return Core::ICore::settings()->value(kHelpHomePageKey, defaultHomePage()).toString(); } void LocalHelpManager::setHomePage(const QString &page) { Core::ICore::settings()->setValueWithDefault(kHelpHomePageKey, page, defaultHomePage()); } QFont LocalHelpManager::fallbackFont() { Utils::QtcSettings *settings = Core::ICore::settings(); const QString family = settings->value(kFontFamilyKey, defaultFallbackFontFamily()).toString(); const int size = settings->value(kFontSizeKey, kDefaultFallbackFontSize).toInt(); QFont font(family, size); const QString styleName = settings->value(kFontStyleNameKey, defaultFallbackFontStyleName(font.family())).toString(); font.setStyleName(styleName); return font; } void LocalHelpManager::setFallbackFont(const QFont &font) { Core::ICore::settings()->setValueWithDefault(kFontFamilyKey, font.family(), defaultFallbackFontFamily()); Core::ICore::settings()->setValueWithDefault(kFontStyleNameKey, font.styleName(), defaultFallbackFontStyleName(font.family())); Core::ICore::settings()->setValueWithDefault(kFontSizeKey, font.pointSize(), kDefaultFallbackFontSize); emit m_instance->fallbackFontChanged(font); } int LocalHelpManager::fontZoom() { return Core::ICore::settings()->value(kFontZoomKey, kDefaultFontZoom).toInt(); } int LocalHelpManager::setFontZoom(int percentage) { const int newZoom = qBound(10, percentage, 3000); if (newZoom == fontZoom()) return newZoom; Core::ICore::settings()->setValueWithDefault(kFontZoomKey, newZoom, kDefaultFontZoom); emit m_instance->fontZoomChanged(newZoom); return newZoom; } bool LocalHelpManager::antialias() { return Core::ICore::settings()->value(kAntialiasKey, kDefaultAntialias).toBool(); } void LocalHelpManager::setAntialias(bool on) { if (on != antialias()) { Core::ICore::settings()->setValueWithDefault(kAntialiasKey, on, kDefaultAntialias); emit m_instance->antialiasChanged(on); } } LocalHelpManager::StartOption LocalHelpManager::startOption() { const QVariant value = Core::ICore::settings()->value(kStartOptionKey, kDefaultStartOption); bool ok; int optionValue = value.toInt(&ok); if (!ok) optionValue = ShowLastPages; switch (optionValue) { case ShowHomePage: return ShowHomePage; case ShowBlankPage: return ShowBlankPage; case ShowLastPages: return ShowLastPages; default: break; } return ShowLastPages; } void LocalHelpManager::setStartOption(LocalHelpManager::StartOption option) { Core::ICore::settings()->setValueWithDefault(kStartOptionKey, int(option), kDefaultStartOption); } Core::HelpManager::HelpViewerLocation LocalHelpManager::contextHelpOption() { const QVariant value = Core::ICore::settings()->value(kContextHelpOptionKey, kDefaultContextHelpOption); bool ok; int optionValue = value.toInt(&ok); if (!ok) optionValue = Core::HelpManager::SideBySideIfPossible; switch (optionValue) { case Core::HelpManager::SideBySideIfPossible: return Core::HelpManager::SideBySideIfPossible; case Core::HelpManager::SideBySideAlways: return Core::HelpManager::SideBySideAlways; case Core::HelpManager::HelpModeAlways: return Core::HelpManager::HelpModeAlways; case Core::HelpManager::ExternalHelpAlways: return Core::HelpManager::ExternalHelpAlways; default: break; } return Core::HelpManager::SideBySideIfPossible; } void LocalHelpManager::setContextHelpOption(Core::HelpManager::HelpViewerLocation location) { if (location == contextHelpOption()) return; Core::ICore::settings()->setValueWithDefault(kContextHelpOptionKey, int(location), kDefaultContextHelpOption); emit m_instance->contextHelpOptionChanged(location); } bool LocalHelpManager::returnOnClose() { const QVariant value = Core::ICore::settings()->value(kReturnOnCloseKey, kDefaultReturnOnClose); return value.toBool(); } void LocalHelpManager::setReturnOnClose(bool returnOnClose) { Core::ICore::settings()->setValueWithDefault(kReturnOnCloseKey, returnOnClose, kDefaultReturnOnClose); emit m_instance->returnOnCloseChanged(); } bool LocalHelpManager::isScrollWheelZoomingEnabled() { return Core::ICore::settings() ->value(kUseScrollWheelZooming, kDefaultUseScrollWheelZooming) .toBool(); } void LocalHelpManager::setScrollWheelZoomingEnabled(bool enabled) { Core::ICore::settings()->setValueWithDefault(kUseScrollWheelZooming, enabled, kDefaultUseScrollWheelZooming); emit m_instance->scrollWheelZoomingEnabledChanged(enabled); } QStringList LocalHelpManager::lastShownPages() { const QVariant value = Core::ICore::settings()->value(kLastShownPagesKey, QVariant()); return value.toString().split(Constants::ListSeparator, Qt::SkipEmptyParts); } void LocalHelpManager::setLastShownPages(const QStringList &pages) { Core::ICore::settings()->setValueWithDefault(kLastShownPagesKey, pages.join(Constants::ListSeparator)); } int LocalHelpManager::lastSelectedTab() { const QVariant value = Core::ICore::settings()->value(kLastSelectedTabKey, 0); return value.toInt(); } void LocalHelpManager::setLastSelectedTab(int index) { Core::ICore::settings()->setValueWithDefault(kLastSelectedTabKey, index, -1); } static std::optional backendForId(const QByteArray &id) { const QVector factories = LocalHelpManager::viewerBackends(); const auto backend = std::find_if(std::begin(factories), std::end(factories), Utils::equal(&HelpViewerFactory::id, id)); if (backend != std::end(factories)) return *backend; return {}; } HelpViewerFactory LocalHelpManager::defaultViewerBackend() { const QString backend = Utils::qtcEnvironmentVariable("QTC_HELPVIEWER_BACKEND"); if (!backend.isEmpty()) { const std::optional factory = backendForId(backend.toLatin1()); if (factory) return *factory; } if (!backend.isEmpty()) qWarning("Help viewer backend \"%s\" not found, using default.", qPrintable(backend)); const QVector backends = viewerBackends(); return backends.isEmpty() ? HelpViewerFactory() : backends.first(); } QVector LocalHelpManager::viewerBackends() { QVector result; #ifdef QTC_LITEHTML_HELPVIEWER result.append({"litehtml", Tr::tr("litehtml"), []() { return new LiteHtmlHelpViewer; }}); #endif #ifdef QTC_WEBENGINE_HELPVIEWER static bool schemeRegistered = false; if (!schemeRegistered) { schemeRegistered = true; QWebEngineUrlScheme scheme("qthelp"); scheme.setFlags(QWebEngineUrlScheme::LocalScheme | QWebEngineUrlScheme::LocalAccessAllowed); QWebEngineUrlScheme::registerScheme(scheme); } result.append({"qtwebengine", Tr::tr("QtWebEngine"), []() { return new WebEngineHelpViewer; }}); #endif result.append( {"textbrowser", Tr::tr("QTextBrowser"), []() { return new TextBrowserHelpViewer; }}); #ifdef QTC_MAC_NATIVE_HELPVIEWER result.append({"native", Tr::tr("WebKit"), []() { return new MacWebKitHelpViewer; }}); #endif #ifdef QTC_DEFAULT_HELPVIEWER_BACKEND const int index = Utils::indexOf(result, [](const HelpViewerFactory &f) { return f.id == QByteArray(QTC_DEFAULT_HELPVIEWER_BACKEND); }); if (QTC_GUARD(index >= 0)) { const HelpViewerFactory defaultBackend = result.takeAt(index); result.prepend(defaultBackend); } #endif return result; } HelpViewerFactory LocalHelpManager::viewerBackend() { const QByteArray id = Core::ICore::settings()->value(kViewerBackend).toByteArray(); if (!id.isEmpty()) return backendForId(id).value_or(defaultViewerBackend()); return defaultViewerBackend(); } void LocalHelpManager::setViewerBackendId(const QByteArray &id) { Core::ICore::settings()->setValueWithDefault(kViewerBackend, id, {}); } QByteArray LocalHelpManager::viewerBackendId() { return Core::ICore::settings()->value(kViewerBackend).toByteArray(); } void LocalHelpManager::setupGuiHelpEngine() { if (m_needsCollectionFile) { m_needsCollectionFile = false; helpEngine().setCollectionFile(HelpManager::collectionFilePath()); m_guiNeedsSetup = true; } if (m_guiNeedsSetup) { m_guiNeedsSetup = false; helpEngine().setupData(); } } void LocalHelpManager::setEngineNeedsUpdate() { m_guiNeedsSetup = true; } QHelpEngine &LocalHelpManager::helpEngine() { if (!m_guiEngine) { QMutexLocker _(&m_guiMutex); if (!m_guiEngine) { m_guiEngine = new QHelpEngine(QString()); m_guiEngine->setReadOnly(false); m_guiEngine->setUsesFilterEngine(true); } } return *m_guiEngine; } BookmarkManager& LocalHelpManager::bookmarkManager() { if (!m_bookmarkManager) { QMutexLocker _(&m_bkmarkMutex); if (!m_bookmarkManager) m_bookmarkManager = new BookmarkManager; } return *m_bookmarkManager; } QByteArray LocalHelpManager::loadErrorMessage(const QUrl &url, const QString &errorString) { const char g_htmlPage[] = "" "" "" "%1" "" "" "" "
" "" "

%2

" "

%3

" "%4" "
" "" ""; // some of the values we will replace %1...6 inside the former html const QString g_percent1 = Tr::tr("Error loading page"); // percent2 will be the error details // percent3 will be the url of the page we got the error from const QString g_percent4 = Tr::tr("

Check that you have the corresponding " "documentation set installed.

"); return QString::fromLatin1(g_htmlPage) .arg(g_percent1, errorString, Tr::tr("Error loading: %1").arg(url.toString()), g_percent4) .toUtf8(); } LocalHelpManager::HelpData LocalHelpManager::helpData(const QUrl &url) { HelpData data; const QHelpEngineCore &engine = helpEngine(); data.resolvedUrl = engine.findFile(url); if (data.resolvedUrl.isValid()) { data.data = engine.fileData(data.resolvedUrl); data.mimeType = HelpViewer::mimeFromUrl(data.resolvedUrl); if (data.mimeType.isEmpty()) data.mimeType = Utils::Constants::OCTET_STREAM_MIMETYPE; } else { data.data = loadErrorMessage(url, Tr::tr("The page could not be found")); data.mimeType = "text/html"; } return data; } QHelpFilterEngine *LocalHelpManager::filterEngine() { return helpEngine().filterEngine(); } bool LocalHelpManager::canOpenOnlineHelp(const QUrl &url) { return Utils::anyOf( m_onlineHelpHandlerList, [url](const Core::HelpManager::OnlineHelpHandler &handler) { return handler.handlesUrl(url); }); } bool LocalHelpManager::isQtUrl(const QUrl &url) { const QString address = url.toString(); return address.startsWith("qthelp://org.qt-project.") || address.startsWith("qthelp://com.nokia.") || address.startsWith("qthelp://com.trolltech."); } void LocalHelpManager::openQtUrl(const QUrl &url) { static const QString unversionedLocalDomainName = QString("org.qt-project.%1").arg(Utils::appInfo().id); QString urlPrefix = "http://doc.qt.io/"; if (url.authority().startsWith(unversionedLocalDomainName)) { urlPrefix.append(Utils::appInfo().id); } else { const auto host = url.host(); const auto dot = host.lastIndexOf('.'); if (dot < 0) { urlPrefix.append("qt-5"); } else { const auto version = host.mid(dot + 1); if (version.startsWith('6')) { urlPrefix.append("qt-6"); } else { urlPrefix.append("qt-5"); } } } const QString address = url.toString(); QDesktopServices::openUrl(QUrl(urlPrefix + address.mid(address.lastIndexOf(QLatin1Char('/'))))); } bool LocalHelpManager::openOnlineHelp(const QUrl &url) { return Utils::anyOf( m_onlineHelpHandlerList, [url](const Core::HelpManager::OnlineHelpHandler &handler) { if (handler.handlesUrl(url)) { handler.openUrl(url); return true; } return false; }); } QMultiMap LocalHelpManager::linksForKeyword(const QString &keyword) { return HelpManager::linksForKeyword(&LocalHelpManager::helpEngine(), keyword, std::nullopt); } void LocalHelpManager::addOnlineHelpHandler(const Core::HelpManager::OnlineHelpHandler &handler) { LocalHelpManager::m_onlineHelpHandlerList.push_back(handler); }