2 * Copyright © 2022 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
6 * Privacy Browser PC is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * Privacy Browser PC is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Privacy Browser PC. If not, see <http://www.gnu.org/licenses/>.
20 // Application headers.
21 #include "BrowserView.h"
22 #include "MouseEventFilter.h"
24 #include "ui_BrowserView.h"
25 #include "UrlRequestInterceptor.h"
26 #include "helpers/DomainsDatabaseHelper.h"
27 #include "helpers/SearchEngineHelper.h"
28 #include "helpers/UserAgentHelper.h"
29 #include "windows/BrowserWindow.h"
31 // Qt framework headers.
33 #include <QWebEngineProfile>
35 BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
37 // Instantiate the browser view UI.
38 Ui::BrowserView browserViewUi;
41 browserViewUi.setupUi(this);
43 // Get handles for the views.
44 webEngineViewPointer = browserViewUi.webEngineView;
46 // Get handles for the aspects of the WebEngine.
47 QWebEnginePage *webEnginePagePointer = webEngineViewPointer->page();
48 webEngineHistoryPointer = webEnginePagePointer->history();
49 webEngineProfilePointer = webEnginePagePointer->profile();
50 webEngineSettingsPointer = webEngineViewPointer->settings();
52 // Update the URL line edit from the webengine view.
53 connect(webEngineViewPointer, SIGNAL(loadStarted()), this, SLOT(updateInterface()));
54 connect(webEngineViewPointer, SIGNAL(loadProgress(const int)), this, SLOT(updateInterface()));
55 connect(webEngineViewPointer, SIGNAL(loadFinished(const bool)), this, SLOT(updateInterface()));
57 // Instantiate the mouse event filter pointer.
58 MouseEventFilter *mouseEventFilterPointer = new MouseEventFilter(webEngineViewPointer);
60 // Install the mouse event filter.
61 qApp->installEventFilter(mouseEventFilterPointer);
63 // Listen for hovered link URLs.
64 connect(webEnginePagePointer, SIGNAL(linkHovered(const QString)), this, SLOT(pageLinkHovered(const QString)));
66 // Instantiate the URL request interceptor.
67 UrlRequestInterceptor *urlRequestInterceptorPointer = new UrlRequestInterceptor();
69 // Set the URL request interceptor.
70 webEngineProfilePointer->setUrlRequestInterceptor(urlRequestInterceptorPointer);
72 // Reapply the domain settings when the host changes.
73 connect(urlRequestInterceptorPointer, SIGNAL(applyDomainSettings(QString)), this, SLOT(applyDomainSettingsWithoutReloading(QString)));
76 webEngineProfilePointer->setHttpCacheType(QWebEngineProfile::NoCache);
78 // Don't allow JavaScript to open windows.
79 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, false);
81 // Allow keyboard navigation.
82 webEngineSettingsPointer->setAttribute(QWebEngineSettings::SpatialNavigationEnabled, true);
84 // Enable full screen support.
85 webEngineSettingsPointer->setAttribute(QWebEngineSettings::FullScreenSupportEnabled, true);
87 // Require user interaction to play media.
88 webEngineSettingsPointer->setAttribute(QWebEngineSettings::PlaybackRequiresUserGesture, true);
90 // Limit WebRTC to public IP addresses.
91 webEngineSettingsPointer->setAttribute(QWebEngineSettings::WebRTCPublicInterfacesOnly, true);
93 // Set the focus on the WebEngine view.
94 webEngineViewPointer->setFocus();
97 void BrowserView::applyApplicationSettings()
99 // Set the search engine URL.
100 searchEngineUrl = SearchEngineHelper::getSearchUrl(Settings::searchEngine());
102 // Emit the search engine updated signal, which causes the on-the-fly menu to be updated.
103 emit searchEngineUpdated(Settings::searchEngine());
106 // This exists as a separate function from `applyDomainSettings()` so it can be listed as a slot and function without the need for a boolean argument.
107 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
108 void BrowserView::applyDomainSettingsAndReload()
110 // Apply the domain settings. `true` reloads the website.
111 applyDomainSettings(webEngineViewPointer->url().host(), true);
114 // This exists as a separate function from `applyDomainSettings()` so it can be listed as a slot and function without the need for a boolean argument.
115 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
116 void BrowserView::applyDomainSettingsWithoutReloading(const QString &hostname)
118 // Apply the domain settings `false` does not reload the website.
119 applyDomainSettings(hostname, false);
122 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
123 void BrowserView::applyDomainSettings(const QString &hostname, const bool reloadWebsite)
125 // Get the record for the hostname.
126 QSqlQuery domainQuery = DomainsDatabaseHelper::getDomainQuery(hostname);
128 // Check if the hostname has domain settings.
129 if (domainQuery.isValid()) // The hostname has domain settings.
131 // Get the domain record.
132 QSqlRecord domainRecord = domainQuery.record();
134 // Set the JavaScript status.
135 switch (domainRecord.field(DomainsDatabaseHelper::JAVASCRIPT).value().toInt())
137 case (DomainsDatabaseHelper::SYSTEM_DEFAULT):
139 // Set the default JavaScript status.
140 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScript());
145 case (DomainsDatabaseHelper::DISABLED):
147 // Disable JavaScript.
148 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, false);
153 case (DomainsDatabaseHelper::ENABLED):
155 // Enable JavaScript.
156 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, true);
162 // Set the user agent.
163 webEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getResultingDomainSettingsUserAgent(domainRecord.field(DomainsDatabaseHelper::USER_AGENT).value().toString()));
165 // Check if a custom zoom factor is set. This can be removed once <https://redmine.stoutner.com/issues/799> has been resolved.
166 if (domainRecord.field(DomainsDatabaseHelper::ZOOM_FACTOR).value().toInt())
168 // Store the current zoom factor.
169 currentZoomFactor = domainRecord.field(DomainsDatabaseHelper::CUSTOM_ZOOM_FACTOR).value().toDouble();
173 // Reset the current zoom factor.
174 currentZoomFactor = Settings::zoomFactor();
177 // Set the zoom factor.
178 webEngineViewPointer->setZoomFactor(currentZoomFactor);
180 // Apply the domain settings palette to the URL line edit.
181 emit updateDomainSettingsIndicator(true);
183 else // The hostname does not have domain settings.
185 // Set the JavaScript status.
186 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScript());
188 // Set the user agent.
189 webEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getUserAgentFromDatabaseName(Settings::userAgent()));
191 // Store the current zoom factor.
192 currentZoomFactor = Settings::zoomFactor();
194 // Set the zoom factor.
195 webEngineViewPointer->setZoomFactor(currentZoomFactor);
197 // Apply the no domain settings palette to the URL line edit.
198 emit updateDomainSettingsIndicator(false);
201 // Emit the on-the-fly menu update signals.
202 emit updateJavaScriptAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
203 emit userAgentUpdated(webEngineProfilePointer->httpUserAgent());
204 emit zoomFactorUpdated(Settings::zoomFactor());
206 // Reload the website if requested.
209 webEngineViewPointer->reload();
213 void BrowserView::applyOnTheFlySearchEngine(QAction *searchEngineActionPointer)
215 // Store the search engine name.
216 QString searchEngineName = searchEngineActionPointer->text();
218 // Strip out any `&` characters.
219 searchEngineName.remove('&');
221 // Store the search engine string.
222 searchEngineUrl = SearchEngineHelper::getSearchUrl(searchEngineName);
225 void BrowserView::applyOnTheFlyUserAgent(QAction *userAgentActionPointer) const
227 // Get the user agent name.
228 QString userAgentName = userAgentActionPointer->text();
230 // Strip out any `&` characters.
231 userAgentName.remove('&');
233 // Apply the user agent.
234 webEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getUserAgentFromTranslatedName(userAgentName));
236 // Reload the website.
237 webEngineViewPointer->reload();
240 void BrowserView::applyOnTheFlyZoomFactor(const double &zoomFactor) const
242 // Set the zoom factor.
243 webEngineViewPointer->setZoomFactor(zoomFactor);
246 void BrowserView::back() const
249 webEngineViewPointer->back();
252 void BrowserView::forward() const
255 webEngineViewPointer->forward();
258 void BrowserView::home() const
260 // Load the homepage.
261 webEngineViewPointer->load(QUrl::fromUserInput(Settings::homepage()));
264 void BrowserView::loadInitialWebsite()
266 // Apply the application settings.
267 applyApplicationSettings();
269 // Get the arguments.
270 QStringList argumentsStringList = qApp->arguments();
272 // Check to see if the arguments lists contains a URL.
273 if (argumentsStringList.size() > 1)
275 // Load the URL from the arguments list.
276 webEngineViewPointer->load(QUrl::fromUserInput(argumentsStringList.at(1)));
280 // Load the homepage.
285 void BrowserView::loadUrlFromLineEdit(QString url) const
287 // Decide if the text is more likely to be a URL or a search.
288 if (url.startsWith("file://")) // The text is likely a file URL.
291 webEngineViewPointer->load(QUrl::fromUserInput(url));
293 else if (url.contains(".")) // The text is likely a URL.
295 // Check if the URL does not start with a valid protocol.
296 if (!url.startsWith("http"))
298 // Add `https://` to the beginning of the URL.
299 url = "https://" + url;
303 webEngineViewPointer->load(QUrl::fromUserInput(url));
305 else // The text is likely a search.
308 webEngineViewPointer->load(QUrl::fromUserInput(searchEngineUrl + url));
312 void BrowserView::pageLinkHovered(const QString &linkUrl) const
314 // Emit a signal so that the browser window can update the status bar.
315 emit linkHovered(linkUrl);
318 void BrowserView::refresh() const
320 // Reload the website.
321 webEngineViewPointer->reload();
324 void BrowserView::toggleJavaScript() const
326 // Toggle JavaScript.
327 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, !webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
329 // Update the JavaScript icon.
330 emit updateJavaScriptAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
332 // Reload the website.
333 webEngineViewPointer->reload();
336 void BrowserView::updateInterface() const
338 // Update the URL line edit.
339 emit updateUrlLineEdit(webEngineViewPointer->url().toString());
341 // Update the status of the forward and back buttons.
342 emit updateBackAction(webEngineHistoryPointer->canGoBack());
343 emit updateForwardAction(webEngineHistoryPointer->canGoForward());
345 // Reapply the zoom factor. This is a bug in QWebEngineView that resets the zoom with every load. <https://redmine.stoutner.com/issues/799>
346 webEngineViewPointer->setZoomFactor(currentZoomFactor);