zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-11-22 21:53:03 +03:00
Code Issues Projects Releases Wiki Activity

fix(browser): fix regressions in external link handling

Browse Source 
Fixes #1238.
This commit is contained in:
Oleg Shparber 2020-06-14 18:01:09 -04:00
parent 4ebc2ebed6
commit 373606a1ed
6 changed files with 28 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/libs/browser/CMakeLists.txt
View File

@ -1,7 +1,6 @@
add_library(Browser STATIC
searchtoolbar.cpp
settings.cpp
urlrequestinterceptor.cpp
webbridge.cpp
webcontrol.cpp
webpage.cpp

9
src/libs/browser/settings.cpp
View File

@ -22,8 +22,6 @@
#include "settings.h"
#include "urlrequestinterceptor.h"
#include <core/settings.h>
#include <QFileInfo>
@ -51,13 +49,6 @@ Settings::Settings(Core::Settings *appSettings, QObject *parent)
// Create a new off-the-record profile.
m_webProfile = new QWebEngineProfile(this);
// Setup URL interceptor.
#if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
m_webProfile->setUrlRequestInterceptor(new UrlRequestInterceptor(this));
#else
m_webProfile->setRequestInterceptor(new UrlRequestInterceptor(this));
#endif
// Listen to settings changes.
connect(m_appSettings, &Core::Settings::updated, this, &Settings::applySettings);
applySettings();

86
src/libs/browser/urlrequestinterceptor.cpp
View File

@ -1,86 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2020 Oleg Shparber
** Copyright (C) 2019 Kay Gawlik
** Contact: https://go.zealdocs.org/l/contact
**
** This file is part of Zeal.
**
** Zeal is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** Zeal is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with Zeal. If not, see <http://www.gnu.org/licenses/>.
**
****************************************************************************/
#include "urlrequestinterceptor.h"
#include <core/application.h>
#include <core/networkaccessmanager.h>
#include <core/settings.h>
#include <QLoggingCategory>
using namespace Zeal::Browser;
static Q_LOGGING_CATEGORY(log, "zeal.browser.urlrequestinterceptor")
UrlRequestInterceptor::UrlRequestInterceptor(QObject *parent)
: QWebEngineUrlRequestInterceptor(parent)
{
}
void UrlRequestInterceptor::interceptRequest(QWebEngineUrlRequestInfo &info)
{
const QUrl requestUrl = info.requestUrl();
const QUrl firstPartyUrl = info.firstPartyUrl();
if (!firstPartyUrl.isValid()) {
return;
}
bool firstPartyUrlLocal = Core::NetworkAccessManager::isLocalUrl(firstPartyUrl);
bool requestUrlLocal = Core::NetworkAccessManager::isLocalUrl(requestUrl);
if (firstPartyUrlLocal && requestUrlLocal) {
return;
}
if (firstPartyUrlLocal != requestUrlLocal) {
blockRequest(info);
return;
}
// TODO: [C++20] using enum Core::Settings::ExternalLinkPolicy;
typedef Core::Settings::ExternalLinkPolicy ExternalLinkPolicy;
ExternalLinkPolicy linkPolicy = Core::Application::instance()->settings()->externalLinkPolicy;
switch (info.resourceType()) {
case QWebEngineUrlRequestInfo::ResourceTypeMainFrame:
if (linkPolicy != ExternalLinkPolicy::Open && linkPolicy != ExternalLinkPolicy::Ask) {
blockRequest(info);
}
break;
case QWebEngineUrlRequestInfo::ResourceTypeSubFrame:
if (linkPolicy != ExternalLinkPolicy::Open) {
blockRequest(info);
}
break;
default:
break;
}
}
void UrlRequestInterceptor::blockRequest(QWebEngineUrlRequestInfo &info)
{
qCDebug(log, "Blocked request: %s '%s'.", info.requestMethod().data(), qPrintable(info.requestUrl().toString()));
info.block(true);
}

47
src/libs/browser/urlrequestinterceptor.h
View File

@ -1,47 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2020 Oleg Shparber
** Copyright (C) 2019 Kay Gawlik
** Contact: https://go.zealdocs.org/l/contact
**
** This file is part of Zeal.
**
** Zeal is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** Zeal is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with Zeal. If not, see <http://www.gnu.org/licenses/>.
**
****************************************************************************/
#ifndef ZEAL_BROWSER_URLREQUESTINTERCEPTOR_H
#define ZEAL_BROWSER_URLREQUESTINTERCEPTOR_H
#include <QWebEngineUrlRequestInterceptor>
namespace Zeal {
namespace Browser {
class UrlRequestInterceptor final : public QWebEngineUrlRequestInterceptor
{
Q_OBJECT
Q_DISABLE_COPY(UrlRequestInterceptor)
public:
UrlRequestInterceptor(QObject *parent = nullptr);
void interceptRequest(QWebEngineUrlRequestInfo &info) override;
private:
void blockRequest(QWebEngineUrlRequestInfo &info);
};
} // namespace Browser
} // namespace Zeal
#endif // ZEAL_BROWSER_URLREQUESTINTERCEPTOR_H

35
src/libs/browser/webpage.cpp
View File

@ -32,38 +32,53 @@
#include <QCheckBox>
#include <QDesktopServices>
#include <QFileInfo>
#include <QLoggingCategory>
#include <QMessageBox>
#include <QPushButton>
using namespace Zeal::Browser;
static Q_LOGGING_CATEGORY(log, "zeal.browser.webpage")
WebPage::WebPage(QObject *parent)
: QWebEnginePage(Settings::defaultProfile(), parent)
{
}
bool WebPage::acceptNavigationRequest(const QUrl &url, QWebEnginePage::NavigationType type, bool isMainFrame)
bool WebPage::acceptNavigationRequest(const QUrl &requestUrl, QWebEnginePage::NavigationType type, bool isMainFrame)
{
Q_UNUSED(type)
Q_UNUSED(isMainFrame)
if (Core::NetworkAccessManager::isLocalUrl(url)) {
// Local elements are always allowed.
if (Core::NetworkAccessManager::isLocalUrl(requestUrl)) {
return true;
}
// Allow external resources if already on an external page.
const QUrl pageUrl = url();
if (pageUrl.isValid() && !Core::NetworkAccessManager::isLocalUrl(pageUrl)) {
return true;
}
// Block external elements on local pages.
if (!isMainFrame) {
qCDebug(log, "Blocked request to '%s'.", qPrintable(requestUrl.toString()));
return false;
}
auto appSettings = Core::Application::instance()->settings();
// TODO: [C++20] using enum Core::Settings::ExternalLinkPolicy;
typedef Core::Settings::ExternalLinkPolicy ExternalLinkPolicy;
switch (appSettings->externalLinkPolicy) {
case ExternalLinkPolicy::Open:
break;
return true;
case ExternalLinkPolicy::Ask: {
QMessageBox mb;
mb.setIcon(QMessageBox::Question);
mb.setText(tr("How do you want to open the external link?<br>URL: <b>%1</b>")
.arg(url.toString()));
.arg(requestUrl.toString()));
QCheckBox *checkBox = new QCheckBox("Do &not ask again");
mb.setCheckBox(checkBox);
@ -75,6 +90,7 @@ bool WebPage::acceptNavigationRequest(const QUrl &url, QWebEnginePage::Navigatio
mb.setDefaultButton(openInBrowserButton);
if (mb.exec() == QMessageBox::Cancel) {
qCDebug(log, "Blocked request to '%s'.", qPrintable(requestUrl.toString()));
return false;
}
@ -93,17 +109,20 @@ bool WebPage::acceptNavigationRequest(const QUrl &url, QWebEnginePage::Navigatio
appSettings->save();
}
QDesktopServices::openUrl(url);
QDesktopServices::openUrl(requestUrl);
return false;
}
break;
}
case ExternalLinkPolicy::OpenInSystemBrowser:
QDesktopServices::openUrl(url);
QDesktopServices::openUrl(requestUrl);
return false;
}
// This code should not be reachable so log a warning.
qCWarning(log, "Blocked request to '%s'.", qPrintable(requestUrl.toString()));
return false;
}

2
src/libs/browser/webpage.h
View File

@ -37,7 +37,7 @@ public:
explicit WebPage(QObject *parent = nullptr);
protected:
bool acceptNavigationRequest(const QUrl &url, NavigationType type, bool isMainFrame) override;
bool acceptNavigationRequest(const QUrl &requestUrl, NavigationType type, bool isMainFrame) override;
void javaScriptConsoleMessage(QWebEnginePage::JavaScriptConsoleMessageLevel level, const QString &message, int lineNumber, const QString &sourceId) override;
};