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 "TabWidget.h"
23 #include "ui_AddTabWidget.h"
24 #include "ui_TabWidget.h"
25 #include "databases/CookiesDatabase.h"
26 #include "databases/DomainsDatabase.h"
27 #include "dialogs/SaveDialog.h"
28 #include "filters/MouseEventFilter.h"
29 #include "helpers/SearchEngineHelper.h"
30 #include "helpers/UserAgentHelper.h"
31 #include "interceptors/UrlRequestInterceptor.h"
32 #include "windows/BrowserWindow.h"
34 // KDE Framework headers.
35 #include <KIO/FileCopyJob>
36 #include <KIO/JobUiDelegate>
38 // Qt toolkit headers.
40 #include <QFileDialog>
41 #include <QGraphicsScene>
42 #include <QGraphicsView>
43 #include <QPrintDialog>
44 #include <QPrintPreviewDialog>
47 // Initialize the public static variables.
48 QString TabWidget::webEngineDefaultUserAgent = QStringLiteral("");
50 // Construct the class.
51 TabWidget::TabWidget(QWidget *parent) : QWidget(parent)
53 // Instantiate the UIs.
54 Ui::TabWidget tabWidgetUi;
55 Ui::AddTabWidget addTabWidgetUi;
58 tabWidgetUi.setupUi(this);
60 // Get a handle for the tab widget.
61 tabWidgetPointer = tabWidgetUi.tabWidget;
63 // Setup the add tab UI.
64 addTabWidgetUi.setupUi(tabWidgetPointer);
66 // Get handles for the add tab widgets.
67 QWidget *addTabWidgetPointer = addTabWidgetUi.addTabQWidget;
68 QPushButton *addTabButtonPointer = addTabWidgetUi.addTabButton;
70 // Display the add tab widget.
71 tabWidgetPointer->setCornerWidget(addTabWidgetPointer);
76 // Process tab events.
77 connect(tabWidgetPointer, SIGNAL(currentChanged(int)), this, SLOT(updateUiWithTabSettings()));
78 connect(addTabButtonPointer, SIGNAL(clicked()), this, SLOT(addTab()));
79 connect(tabWidgetPointer, SIGNAL(tabCloseRequested(int)), this, SLOT(deleteTab(int)));
81 // Store a copy of the WebEngine default user agent.
82 webEngineDefaultUserAgent = currentWebEngineProfilePointer->httpUserAgent();
84 // Instantiate the mouse event filter pointer.
85 MouseEventFilter *mouseEventFilterPointer = new MouseEventFilter();
87 // Install the mouse event filter.
88 qApp->installEventFilter(mouseEventFilterPointer);
90 // Process mouse forward and back commands.
91 connect(mouseEventFilterPointer, SIGNAL(mouseBack()), this, SLOT(mouseBack()));
92 connect(mouseEventFilterPointer, SIGNAL(mouseForward()), this, SLOT(mouseForward()));
95 TabWidget::~TabWidget()
97 // Manually delete each WebEngine page.
98 for (int i = 0; i < tabWidgetPointer->count(); ++i)
100 // Get the privacy WebEngine view.
101 PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(tabWidgetPointer->widget(i));
103 // Deletion the WebEngine page to prevent the following error: `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
104 delete privacyWebEngineViewPointer->page();
108 // The cookie is copied instead of referenced so that changes made to the cookie do not create a race condition with the display of the cookie in the dialog.
109 void TabWidget::addCookieToStore(QNetworkCookie cookie, QWebEngineCookieStore *webEngineCookieStorePointer) const
114 // Check to see if the domain does not start with a `.` because Qt makes this harder than it should be. <https://doc.qt.io/qt-5/qwebenginecookiestore.html#setCookie>
115 if (!cookie.domain().startsWith(QStringLiteral(".")))
118 url.setHost(cookie.domain());
119 url.setScheme(QStringLiteral("https"));
121 // Clear the domain from the cookie.
122 cookie.setDomain(QStringLiteral(""));
125 // Add the cookie to the store.
126 if (webEngineCookieStorePointer == nullptr)
127 currentWebEngineCookieStorePointer->setCookie(cookie, url);
129 webEngineCookieStorePointer->setCookie(cookie, url);
132 void TabWidget::addFirstTab()
134 // Create the first tab.
137 // Update the UI with the tab settings.
138 updateUiWithTabSettings();
140 // Set the focus on the current tab widget. This prevents the tab bar from showing a blue bar under the label of the first tab.
141 tabWidgetPointer->currentWidget()->setFocus();
144 PrivacyWebEngineView* TabWidget::addTab(const bool focusNewWebEngineView)
146 // Create a privacy WebEngine view.
147 PrivacyWebEngineView *privacyWebEngineViewPointer = new PrivacyWebEngineView();
150 int newTabIndex = tabWidgetPointer->addTab(privacyWebEngineViewPointer, i18nc("New tab label.", "New Tab"));
152 // Set the default tab icon.
153 tabWidgetPointer->setTabIcon(newTabIndex, defaultTabIcon);
155 // Create an off-the-record profile (the default when no profile name is specified).
156 QWebEngineProfile *webEngineProfilePointer = new QWebEngineProfile(QStringLiteral(""));
158 // Create a WebEngine page.
159 QWebEnginePage *webEnginePagePointer = new QWebEnginePage(webEngineProfilePointer);
161 // Set the WebEngine page.
162 privacyWebEngineViewPointer->setPage(webEnginePagePointer);
164 // Get handles for the web engine elements.
165 QWebEngineCookieStore *webEngineCookieStorePointer = webEngineProfilePointer->cookieStore();
166 QWebEngineSettings *webEngineSettingsPointer = webEnginePagePointer->settings();
168 // Update the URL line edit when the URL changes.
169 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::urlChanged, [privacyWebEngineViewPointer, this] (const QUrl &newUrl)
171 // Only update the UI if this is the current tab.
172 if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
174 // Update the URL line edit.
175 emit updateUrlLineEdit(newUrl);
177 // Update the status of the forward and back buttons.
178 emit updateBackAction(currentWebEngineHistoryPointer->canGoBack());
179 emit updateForwardAction(currentWebEngineHistoryPointer->canGoForward());
182 // Reapply the zoom factor. This is a bug in QWebEngineView that resets the zoom with every load. It can be removed once <https://redmine.stoutner.com/issues/799> is fixed.
183 privacyWebEngineViewPointer->setZoomFactor(currentZoomFactor);
186 // Update the progress bar when a load is started.
187 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadStarted, [privacyWebEngineViewPointer, this] ()
189 // Store the load progress.
190 privacyWebEngineViewPointer->loadProgressInt = 0;
192 // Show the progress bar if this is the current tab.
193 if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
194 emit showProgressBar(0);
197 // Update the progress bar when a load progresses.
198 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadProgress, [privacyWebEngineViewPointer, this] (const int progress)
200 // Store the load progress.
201 privacyWebEngineViewPointer->loadProgressInt = progress;
203 // Update the progress bar if this is the current tab.
204 if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
205 emit showProgressBar(progress);
208 // Update the progress bar when a load finishes.
209 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadFinished, [privacyWebEngineViewPointer, this] ()
211 // Store the load progress.
212 privacyWebEngineViewPointer->loadProgressInt = -1;
214 // Hide the progress bar if this is the current tab.
215 if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
216 emit hideProgressBar();
219 // Handle full screen requests.
220 connect(webEnginePagePointer, SIGNAL(fullScreenRequested(QWebEngineFullScreenRequest)), this, SLOT(fullScreenRequested(QWebEngineFullScreenRequest)));
222 // Listen for hovered link URLs.
223 connect(webEnginePagePointer, SIGNAL(linkHovered(const QString)), this, SLOT(pageLinkHovered(const QString)));
225 // Handle file downloads.
226 connect(webEngineProfilePointer, SIGNAL(downloadRequested(QWebEngineDownloadItem *)), this, SLOT(showSaveDialog(QWebEngineDownloadItem *)));
228 // Instantiate the URL request interceptor.
229 UrlRequestInterceptor *urlRequestInterceptorPointer = new UrlRequestInterceptor();
231 // Set the URL request interceptor.
232 webEngineProfilePointer->setUrlRequestInterceptor(urlRequestInterceptorPointer);
234 // Reapply the domain settings when the host changes.
235 connect(urlRequestInterceptorPointer, SIGNAL(applyDomainSettings(QString)), this, SLOT(applyDomainSettingsWithoutReloading(QString)));
237 // Set the local storage filter.
238 webEngineCookieStorePointer->setCookieFilter([privacyWebEngineViewPointer](const QWebEngineCookieStore::FilterRequest &filterRequest)
240 // Block all third party local storage requests, including the sneaky ones that don't register a first party URL.
241 if (filterRequest.thirdParty || (filterRequest.firstPartyUrl == QStringLiteral("")))
243 //qDebug().noquote().nospace() << "Third-party request blocked: " << filterRequest.origin;
249 // Allow the request if local storage is enabled.
250 if (privacyWebEngineViewPointer->localStorageEnabled)
252 //qDebug().noquote().nospace() << "Request allowed by local storage: " << filterRequest.origin;
258 //qDebug().noquote().nospace() << "Request blocked by default: " << filterRequest.origin;
260 // Block any remaining local storage requests.
264 // Disable JavaScript by default (this prevetns JavaScript from being enabled on a new tab before domain settings are loaded).
265 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, false);
267 // Don't allow JavaScript to open windows.
268 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, false);
270 // Allow keyboard navigation.
271 webEngineSettingsPointer->setAttribute(QWebEngineSettings::SpatialNavigationEnabled, true);
273 // Enable full screen support.
274 webEngineSettingsPointer->setAttribute(QWebEngineSettings::FullScreenSupportEnabled, true);
276 // Require user interaction to play media.
277 webEngineSettingsPointer->setAttribute(QWebEngineSettings::PlaybackRequiresUserGesture, true);
279 // Limit WebRTC to public IP addresses.
280 webEngineSettingsPointer->setAttribute(QWebEngineSettings::WebRTCPublicInterfacesOnly, true);
282 // Update the cookies action.
283 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::updateCookiesAction, [privacyWebEngineViewPointer, this] (const int numberOfCookies)
285 // Update the cookie action if the specified privacy WebEngine view is the current privacy WebEngine view.
286 if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
287 emit updateCookiesAction(numberOfCookies);
290 // Process cookie changes.
291 connect(webEngineCookieStorePointer, SIGNAL(cookieAdded(QNetworkCookie)), privacyWebEngineViewPointer, SLOT(addCookieToList(QNetworkCookie)));
292 connect(webEngineCookieStorePointer, SIGNAL(cookieRemoved(QNetworkCookie)), privacyWebEngineViewPointer, SLOT(removeCookieFromList(QNetworkCookie)));
294 // Get a list of durable cookies.
295 QList<QNetworkCookie*> *durableCookiesListPointer = CookiesDatabase::getCookies();
297 // Add the durable cookies to the store.
298 for (QNetworkCookie *cookiePointer : *durableCookiesListPointer)
299 addCookieToStore(*cookiePointer, webEngineCookieStorePointer);
301 // Update the title when it changes.
302 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::titleChanged, [this, privacyWebEngineViewPointer] (const QString &title)
304 // Get the index for this tab.
305 int tabIndex = tabWidgetPointer->indexOf(privacyWebEngineViewPointer);
307 // Update the title for this tab.
308 tabWidgetPointer->setTabText(tabIndex, title);
310 // Update the window title if this is the current tab.
311 if (tabIndex == tabWidgetPointer->currentIndex())
312 emit updateWindowTitle(title);
315 // Update the icon when it changes.
316 connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::iconChanged, [privacyWebEngineViewPointer, this] (const QIcon &icon)
318 // Get the index for this tab.
319 int tabIndex = tabWidgetPointer->indexOf(privacyWebEngineViewPointer);
321 // Update the icon for this tab.
323 tabWidgetPointer->setTabIcon(tabIndex, defaultTabIcon);
325 tabWidgetPointer->setTabIcon(tabIndex, icon);
328 // Enable spell checking.
329 webEngineProfilePointer->setSpellCheckEnabled(true);
331 // Set the spell check language.
332 webEngineProfilePointer->setSpellCheckLanguages({QStringLiteral("en_US")});
334 // Move to the new tab.
335 tabWidgetPointer->setCurrentIndex(newTabIndex);
337 // Clear the URL line edit focus so that it populates correctly when opening a new tab from the context menu.
338 if (focusNewWebEngineView)
339 emit clearUrlLineEditFocus();
341 // Return the privacy WebEngine view pointer.
342 return privacyWebEngineViewPointer;
345 void TabWidget::applyApplicationSettings()
347 // Set the tab position.
348 if (Settings::tabsOnTop())
349 tabWidgetPointer->setTabPosition(QTabWidget::North);
351 tabWidgetPointer->setTabPosition(QTabWidget::South);
353 // Set the search engine URL.
354 searchEngineUrl = SearchEngineHelper::getSearchUrl(Settings::searchEngine());
356 // Emit the update search engine actions signal.
357 emit updateSearchEngineActions(Settings::searchEngine(), true);
360 // 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.
361 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
362 void TabWidget::applyDomainSettingsAndReload()
364 // Apply the domain settings. `true` reloads the website.
365 applyDomainSettings(currentPrivacyWebEngineViewPointer->url().host(), true);
368 // 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.
369 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
370 void TabWidget::applyDomainSettingsWithoutReloading(const QString &hostname)
372 // Apply the domain settings `false` does not reload the website.
373 applyDomainSettings(hostname, false);
376 // Once <https://redmine.stoutner.com/issues/799> has been resolved this can be `const`.
377 void TabWidget::applyDomainSettings(const QString &hostname, const bool reloadWebsite)
379 // Get the record for the hostname.
380 QSqlQuery domainQuery = DomainsDatabase::getDomainQuery(hostname);
382 // Check if the hostname has domain settings.
383 if (domainQuery.isValid()) // The hostname has domain settings.
385 // Get the domain record.
386 QSqlRecord domainRecord = domainQuery.record();
388 // Store the domain settings name.
389 currentPrivacyWebEngineViewPointer->domainSettingsName = domainRecord.field(DomainsDatabase::DOMAIN_NAME).value().toString();
391 // Set the JavaScript status.
392 switch (domainRecord.field(DomainsDatabase::JAVASCRIPT).value().toInt())
394 // Set the default JavaScript status.
395 case (DomainsDatabase::SYSTEM_DEFAULT):
397 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScriptEnabled());
402 // Disable JavaScript.
403 case (DomainsDatabase::DISABLED):
405 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, false);
410 // Enable JavaScript.
411 case (DomainsDatabase::ENABLED):
413 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, true);
419 // Set the local storage status.
420 switch (domainRecord.field(DomainsDatabase::LOCAL_STORAGE).value().toInt())
422 // Set the default local storage status.
423 case (DomainsDatabase::SYSTEM_DEFAULT):
425 currentPrivacyWebEngineViewPointer->localStorageEnabled = Settings::localStorageEnabled();
430 // Disable local storage.
431 case (DomainsDatabase::DISABLED):
433 currentPrivacyWebEngineViewPointer->localStorageEnabled = false;
438 // Enable local storage.
439 case (DomainsDatabase::ENABLED):
441 currentPrivacyWebEngineViewPointer->localStorageEnabled = true;
447 // Set the DOM storage status.
448 switch (domainRecord.field(DomainsDatabase::DOM_STORAGE).value().toInt())
450 // Set the default DOM storage status.
451 case (DomainsDatabase::SYSTEM_DEFAULT):
453 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::domStorageEnabled());
458 // Disable DOM storage.
459 case (DomainsDatabase::DISABLED):
461 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, false);
466 // Enable DOM storage.
467 case (DomainsDatabase::ENABLED):
469 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, true);
475 // Set the user agent.
476 currentWebEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getResultingDomainSettingsUserAgent(domainRecord.field(DomainsDatabase::USER_AGENT).value().toString()));
478 // Check if a custom zoom factor is set.
479 if (domainRecord.field(DomainsDatabase::ZOOM_FACTOR).value().toInt())
481 // Store the current zoom factor.
482 currentZoomFactor = domainRecord.field(DomainsDatabase::CUSTOM_ZOOM_FACTOR).value().toDouble();
486 // Reset the current zoom factor.
487 currentZoomFactor = Settings::zoomFactor();
490 // Set the zoom factor. The use of `currentZoomFactor` can be removed once <https://redmine.stoutner.com/issues/799> has been resolved.
491 currentPrivacyWebEngineViewPointer->setZoomFactor(currentZoomFactor);
493 else // The hostname does not have domain settings.
495 // Reset the domain settings name.
496 currentPrivacyWebEngineViewPointer->domainSettingsName = QStringLiteral("");
498 // Set the JavaScript status.
499 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScriptEnabled());
501 // Set the local storage status.
502 currentPrivacyWebEngineViewPointer->localStorageEnabled = Settings::localStorageEnabled();
504 // Set DOM storage. In QWebEngineSettings it is called Local Storage.
505 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::domStorageEnabled());
507 // Set the user agent.
508 currentWebEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getUserAgentFromDatabaseName(Settings::userAgent()));
510 // Store the current zoom factor. This can be removed once <https://redmine.stoutner.com/issues/799> has been resolved.
511 currentZoomFactor = Settings::zoomFactor();
513 // Set the zoom factor.
514 currentPrivacyWebEngineViewPointer->setZoomFactor(Settings::zoomFactor());
518 emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QStringLiteral(""));
519 emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
520 emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
521 emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
522 emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
523 emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
525 // Reload the website if requested.
527 currentPrivacyWebEngineViewPointer->reload();
530 void TabWidget::applyOnTheFlySearchEngine(QAction *searchEngineActionPointer)
532 // Store the search engine name.
533 QString searchEngineName = searchEngineActionPointer->text();
535 // Strip out any `&` characters.
536 searchEngineName.remove('&');
538 // Store the search engine string.
539 searchEngineUrl = SearchEngineHelper::getSearchUrl(searchEngineName);
541 // Update the search engine actionas.
542 emit updateSearchEngineActions(searchEngineName, false);
545 void TabWidget::applyOnTheFlyUserAgent(QAction *userAgentActionPointer) const
547 // Get the user agent name.
548 QString userAgentName = userAgentActionPointer->text();
550 // Strip out any `&` characters.
551 userAgentName.remove('&');
553 // Apply the user agent.
554 currentWebEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getUserAgentFromTranslatedName(userAgentName));
556 // Update the user agent actions.
557 emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), false);
559 // Reload the website.
560 currentPrivacyWebEngineViewPointer->reload();
563 // This can be const once <https://redmine.stoutner.com/issues/799> has been resolved.
564 void TabWidget::applyOnTheFlyZoomFactor(const double &zoomFactor)
566 // Update the current zoom factor. This can be removed once <https://redmine.stoutner.com/issues/799> has been resolved.
567 currentZoomFactor = zoomFactor;
569 // Set the zoom factor.
570 currentPrivacyWebEngineViewPointer->setZoomFactor(zoomFactor);
573 void TabWidget::back() const
576 currentPrivacyWebEngineViewPointer->back();
579 void TabWidget::deleteAllCookies() const
581 // Delete all the cookies.
582 currentWebEngineCookieStorePointer->deleteAllCookies();
585 void TabWidget::deleteCookieFromStore(const QNetworkCookie &cookie) const
587 // Delete the cookie.
588 currentWebEngineCookieStorePointer->deleteCookie(cookie);
591 void TabWidget::deleteTab(const int tabIndex)
593 // Get the privacy WebEngine view.
594 PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(tabWidgetPointer->widget(tabIndex));
596 // Proccess the tab delete according to the number of tabs.
597 if (tabWidgetPointer->count() > 1) // There is more than one tab.
600 tabWidgetPointer->removeTab(tabIndex);
602 // Delete the WebEngine page to prevent the following error: `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
603 delete privacyWebEngineViewPointer->page();
605 // Delete the privacy WebEngine view.
606 delete privacyWebEngineViewPointer;
608 else // There is only one tab.
610 // Close Privacy Browser.
615 void TabWidget::forward() const
618 currentPrivacyWebEngineViewPointer->forward();
621 void TabWidget::fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest) const
624 emit fullScreenRequested(fullScreenRequest.toggleOn());
626 // Accept the request.
627 fullScreenRequest.accept();
630 std::list<QNetworkCookie>* TabWidget::getCookieList() const
632 // Return the current cookie list.
633 return currentPrivacyWebEngineViewPointer->cookieListPointer;
636 QString& TabWidget::getDomainSettingsName() const
638 // Return the domain settings name.
639 return currentPrivacyWebEngineViewPointer->domainSettingsName;
642 void TabWidget::home() const
644 // Load the homepage.
645 currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(Settings::homepage()));
648 PrivacyWebEngineView* TabWidget::loadBlankInitialWebsite()
650 // Apply the application settings.
651 applyApplicationSettings();
653 // Return the current privacy WebEngine view pointer.
654 return currentPrivacyWebEngineViewPointer;
657 void TabWidget::loadInitialWebsite()
659 // Apply the application settings.
660 applyApplicationSettings();
662 // Get the arguments.
663 QStringList argumentsStringList = qApp->arguments();
665 // Check to see if the arguments lists contains a URL.
666 if (argumentsStringList.size() > 1)
668 // Load the URL from the arguments list.
669 currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(argumentsStringList.at(1)));
673 // Load the homepage.
678 void TabWidget::loadUrlFromLineEdit(QString url) const
680 // Decide if the text is more likely to be a URL or a search.
681 if (url.startsWith("file://")) // The text is likely a file URL.
684 currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
686 else if (url.contains(".")) // The text is likely a URL.
688 // Check if the URL does not start with a valid protocol.
689 if (!url.startsWith("http"))
691 // Add `https://` to the beginning of the URL.
692 url = "https://" + url;
696 currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
698 else // The text is likely a search.
701 currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(searchEngineUrl + url));
705 void TabWidget::mouseBack() const
707 // Go back if possible.
708 if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoBack())
710 // Clear the URL line edit focus.
711 emit clearUrlLineEditFocus();
714 currentPrivacyWebEngineViewPointer->back();
718 void TabWidget::mouseForward() const
720 // Go forward if possible.
721 if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoForward())
723 // Clear the URL line edit focus.
724 emit clearUrlLineEditFocus();
727 currentPrivacyWebEngineViewPointer->forward();
731 void TabWidget::pageLinkHovered(const QString &linkUrl) const
733 // Emit a signal so that the browser window can update the status bar.
734 emit linkHovered(linkUrl);
737 void TabWidget::print() const
742 // Set the resolution to be 300 dpi.
743 printer.setResolution(300);
745 // Create a printer dialog.
746 QPrintDialog printDialog(&printer, currentPrivacyWebEngineViewPointer);
748 // Display the dialog and print the page if instructed.
749 if (printDialog.exec() == QDialog::Accepted)
750 printWebpage(&printer);
753 void TabWidget::printPreview() const
758 // Set the resolution to be 300 dpi.
759 printer.setResolution(300);
761 // Create a print preview dialog.
762 QPrintPreviewDialog printPreviewDialog(&printer, currentPrivacyWebEngineViewPointer);
764 // Generate the print preview.
765 connect(&printPreviewDialog, SIGNAL(paintRequested(QPrinter *)), this, SLOT(printWebpage(QPrinter *)));
767 // Display the dialog.
768 printPreviewDialog.exec();
771 void TabWidget::printWebpage(QPrinter *printerPointer) const
773 // Create an event loop. For some reason, the print preview doesn't produce any output unless it is run inside an event loop.
774 QEventLoop eventLoop;
776 // Print the webpage, converting the callback above into a `QWebEngineCallback<bool>`.
777 // Printing requires that the printer be a pointer, not a reference, or it will crash with much cursing.
778 currentWebEnginePagePointer->print(printerPointer, [&eventLoop](bool printSuccess)
780 // Instruct the compiler to ignore the unused parameter.
791 void TabWidget::refresh() const
793 // Reload the website.
794 currentPrivacyWebEngineViewPointer->reload();
797 void TabWidget::setTabBarVisible(const bool visible) const
799 // Set the tab bar visibility.
800 tabWidgetPointer->tabBar()->setVisible(visible);
803 void TabWidget::showSaveDialog(QWebEngineDownloadItem *downloadItemPointer) const
805 // Instantiate the save dialog.
806 SaveDialog *saveDialogPointer = new SaveDialog(downloadItemPointer);
808 // Connect the save button.
809 connect(saveDialogPointer, SIGNAL(showSaveFilePickerDialog(QUrl &, QString &)), this, SLOT(showSaveFilePickerDialog(QUrl &, QString &)));
812 saveDialogPointer->show();
815 void TabWidget::showSaveFilePickerDialog(QUrl &downloadUrl, QString &suggestedFileName)
817 // Get the download location.
818 QString downloadDirectory = Settings::downloadLocation();
820 // Resolve the system download directory if specified.
821 if (downloadDirectory == QStringLiteral("System Download Directory"))
822 downloadDirectory = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
824 // Create a save file dialog.
825 QFileDialog *saveFileDialogPointer = new QFileDialog(this, i18nc("Save file dialog caption", "Save File"), downloadDirectory);
827 // Tell the dialog to use a save button.
828 saveFileDialogPointer->setAcceptMode(QFileDialog::AcceptSave);
830 // Populate the file name from the download item pointer.
831 saveFileDialogPointer->selectFile(suggestedFileName);
833 // Prevent interaction with the parent window while the dialog is open.
834 saveFileDialogPointer->setWindowModality(Qt::WindowModal);
836 // Process the saving of the file. The save file dialog pointer must be captured directly instead of by reference or nasty crashes occur.
837 auto saveFile = [saveFileDialogPointer, &downloadUrl] () {
838 // Get the save location. The dialog box should only allow the selecting of one file location.
839 QUrl saveLocation = saveFileDialogPointer->selectedUrls().value(0);
841 // Create a file copy job. `-1` creates the file with default permissions.
842 KIO::FileCopyJob *fileCopyJobPointer = KIO::file_copy(downloadUrl, saveLocation, -1, KIO::Overwrite);
844 // Set the download job to display any error messages.
845 fileCopyJobPointer->uiDelegate()->setAutoErrorHandlingEnabled(true);
847 // Start the download.
848 fileCopyJobPointer->start();
851 // Handle clicks on the save button.
852 connect(saveFileDialogPointer, &QDialog::accepted, this, saveFile);
855 saveFileDialogPointer->show();
858 void TabWidget::toggleDomStorage() const
860 // Toggle DOM storage.
861 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
863 // Update the DOM storage action.
864 emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
866 // Reload the website.
867 currentPrivacyWebEngineViewPointer->reload();
870 void TabWidget::toggleJavaScript() const
872 // Toggle JavaScript.
873 currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
875 // Update the JavaScript action.
876 emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
878 // Reload the website.
879 currentPrivacyWebEngineViewPointer->reload();
882 void TabWidget::toggleLocalStorage()
884 // Toggle local storeage.
885 currentPrivacyWebEngineViewPointer->localStorageEnabled = !currentPrivacyWebEngineViewPointer->localStorageEnabled;
887 // Update the local storage action.
888 emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
890 // Reload the website.
891 currentPrivacyWebEngineViewPointer->reload();
894 void TabWidget::updateUiWithTabSettings()
896 // Update the current WebEngine pointers.
897 currentPrivacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(tabWidgetPointer->currentWidget());
898 currentWebEngineSettingsPointer = currentPrivacyWebEngineViewPointer->settings();
899 currentWebEnginePagePointer = currentPrivacyWebEngineViewPointer->page();
900 currentWebEngineProfilePointer = currentWebEnginePagePointer->profile();
901 currentWebEngineHistoryPointer = currentWebEnginePagePointer->history();
902 currentWebEngineCookieStorePointer = currentWebEngineProfilePointer->cookieStore();
904 // Clear the URL line edit focus.
905 emit clearUrlLineEditFocus();
908 emit updateBackAction(currentWebEngineHistoryPointer->canGoBack());
909 emit updateCookiesAction(currentPrivacyWebEngineViewPointer->cookieListPointer->size());
910 emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QStringLiteral(""));
911 emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
912 emit updateForwardAction(currentWebEngineHistoryPointer->canGoForward());
913 emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
914 emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
915 emit updateWindowTitle(currentPrivacyWebEngineViewPointer->title());
916 emit updateUrlLineEdit(currentPrivacyWebEngineViewPointer->url());
917 emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
918 emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
920 // Update the progress bar.
921 if (currentPrivacyWebEngineViewPointer->loadProgressInt >= 0)
922 emit showProgressBar(currentPrivacyWebEngineViewPointer->loadProgressInt);
924 emit hideProgressBar();