]> gitweb.stoutner.com Git - PrivacyBrowserPC.git/blob - src/widgets/TabWidget.cpp
Add a settings option to control spatial navigation. https://redmine.stoutner.com...
[PrivacyBrowserPC.git] / src / widgets / TabWidget.cpp
1 /*
2  * Copyright 2022-2023 Soren Stoutner <soren@stoutner.com>.
3  *
4  * This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 // Application headers.
21 #include "TabWidget.h"
22 #include "Settings.h"
23 #include "ui_AddTabWidget.h"
24 #include "ui_TabWidget.h"
25 #include "databases/CookiesDatabase.h"
26 #include "dialogs/SaveDialog.h"
27 #include "filters/MouseEventFilter.h"
28 #include "helpers/SearchEngineHelper.h"
29 #include "windows/BrowserWindow.h"
30
31 // KDE Framework headers.
32 #include <KIO/FileCopyJob>
33 #include <KIO/JobUiDelegate>
34 #include <KNotification>
35
36 // Qt toolkit headers.
37 #include <QAction>
38 #include <QFileDialog>
39 #include <QGraphicsScene>
40 #include <QGraphicsView>
41 #include <QMessageBox>
42 #include <QPrintDialog>
43 #include <QPrintPreviewDialog>
44 #include <QPrinter>
45
46 // Initialize the public static variables.
47 QString TabWidget::webEngineDefaultUserAgent = QLatin1String("");
48
49 // Construct the class.
50 TabWidget::TabWidget(QWidget *windowPointer) : QWidget(windowPointer)
51 {
52     // Create a QProcess to check if KDE is running.
53     QProcess *checkIfRunningKdeQProcessPointer = new QProcess();
54
55     // Create an argument string list that contains `ksmserver` (KDE Session Manager).
56     QStringList argument = QStringList(QLatin1String("ksmserver"));
57
58     // Run `pidof` to check for the presence of `ksmserver`.
59     checkIfRunningKdeQProcessPointer->start(QLatin1String("pidof"), argument);
60
61     // Monitor any standard output.
62     connect(checkIfRunningKdeQProcessPointer, &QProcess::readyReadStandardOutput, [this]
63     {
64         // If there is any standard output, `ksmserver` is running.
65         isRunningKde = true;
66     });
67
68     // Instantiate the user agent helper.
69     userAgentHelperPointer = new UserAgentHelper();
70
71     // Instantiate the UIs.
72     Ui::TabWidget tabWidgetUi;
73     Ui::AddTabWidget addTabWidgetUi;
74
75     // Setup the main UI.
76     tabWidgetUi.setupUi(this);
77
78     // Get a handle for the tab widget.
79     qTabWidgetPointer = tabWidgetUi.tabWidget;
80
81     // Setup the add tab UI.
82     addTabWidgetUi.setupUi(qTabWidgetPointer);
83
84     // Get handles for the add tab widgets.
85     QWidget *addTabWidgetPointer = addTabWidgetUi.addTabQWidget;
86     QPushButton *addTabButtonPointer = addTabWidgetUi.addTabButton;
87
88     // Display the add tab widget.
89     qTabWidgetPointer->setCornerWidget(addTabWidgetPointer);
90
91     // Create the loading favorite icon movie.
92     loadingFavoriteIconMoviePointer = new QMovie();
93
94     // Set the loading favorite icon movie file name.
95     loadingFavoriteIconMoviePointer->setFileName(QStringLiteral(":/icons/loading.gif"));
96
97     // Stop the loading favorite icon movie if the window is destroyed.  Otherwise, the app will crash if there is more than one window open and a window is closed while at tab is loading.
98     connect(windowPointer, SIGNAL(destroyed()), this, SLOT(stopLoadingFavoriteIconMovie()));
99
100     // Add the first tab.
101     addFirstTab();
102
103     // Process tab events.
104     connect(qTabWidgetPointer, SIGNAL(currentChanged(int)), this, SLOT(updateUiWithTabSettings()));
105     connect(addTabButtonPointer, SIGNAL(clicked()), this, SLOT(addTab()));
106     connect(qTabWidgetPointer, SIGNAL(tabCloseRequested(int)), this, SLOT(deleteTab(int)));
107
108     // Store a copy of the WebEngine default user agent.
109     webEngineDefaultUserAgent = currentWebEngineProfilePointer->httpUserAgent();
110
111     // Instantiate the mouse event filter pointer.
112     MouseEventFilter *mouseEventFilterPointer = new MouseEventFilter();
113
114     // Install the mouse event filter.
115     qApp->installEventFilter(mouseEventFilterPointer);
116
117     // Process mouse forward and back commands.
118     connect(mouseEventFilterPointer, SIGNAL(mouseBack()), this, SLOT(mouseBack()));
119     connect(mouseEventFilterPointer, SIGNAL(mouseForward()), this, SLOT(mouseForward()));
120 }
121
122 TabWidget::~TabWidget()
123 {
124     // Get the number of tabs.
125     int numberOfTabs = qTabWidgetPointer->count();
126
127     // Manually delete each WebEngine page.
128     for (int i = 0; i < numberOfTabs; ++i)
129     {
130         // Get the privacy WebEngine view.
131         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
132
133         // Deletion the WebEngine page to prevent the following error:  `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
134         delete privacyWebEngineViewPointer->page();
135     }
136 }
137
138 // 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.
139 void TabWidget::addCookieToStore(QNetworkCookie cookie, QWebEngineCookieStore *webEngineCookieStorePointer) const
140 {
141     // Create a URL.
142     QUrl url;
143
144     // 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>
145     if (!cookie.domain().startsWith(QLatin1String(".")))
146     {
147         // Populate the URL.
148         url.setHost(cookie.domain());
149         url.setScheme(QLatin1String("https"));
150
151         // Clear the domain from the cookie.
152         cookie.setDomain(QLatin1String(""));
153     }
154
155     // Add the cookie to the store.
156     if (webEngineCookieStorePointer == nullptr)
157         currentWebEngineCookieStorePointer->setCookie(cookie, url);
158     else
159         webEngineCookieStorePointer->setCookie(cookie, url);
160 }
161
162 void TabWidget::addFirstTab()
163 {
164     // Create the first tab.
165     addTab();
166
167     // Update the UI with the tab settings.
168     updateUiWithTabSettings();
169
170     // 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.
171     qTabWidgetPointer->currentWidget()->setFocus();
172 }
173
174 PrivacyWebEngineView* TabWidget::addTab(const bool removeUrlLineEditFocus, const bool backgroundTab)
175 {
176     // Create a privacy WebEngine view.
177     PrivacyWebEngineView *privacyWebEngineViewPointer = new PrivacyWebEngineView();
178
179     // Add a new tab.
180     int newTabIndex = qTabWidgetPointer->addTab(privacyWebEngineViewPointer, i18nc("New tab label.", "New Tab"));
181
182     // Set the default tab icon.
183     qTabWidgetPointer->setTabIcon(newTabIndex, defaultFavoriteIcon);
184
185     // Get handles for the WebEngine page and profile.
186     QWebEnginePage *webEnginePagePointer = privacyWebEngineViewPointer->page();
187     QWebEngineProfile *webEngineProfilePointer = webEnginePagePointer->profile();
188
189     // Get handles for the web engine elements.
190     QWebEngineCookieStore *webEngineCookieStorePointer = webEngineProfilePointer->cookieStore();
191     QWebEngineSettings *webEngineSettingsPointer = webEnginePagePointer->settings();
192
193     // Update the URL line edit when the URL changes.
194     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::urlChanged, [this, privacyWebEngineViewPointer] (const QUrl &newUrl)
195     {
196         // Only update the UI if this is the current tab.
197         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
198         {
199             // Update the URL line edit.
200             emit updateUrlLineEdit(newUrl);
201
202             // Update the status of the forward and back buttons.
203             emit updateBackAction(currentWebEngineHistoryPointer->canGoBack());
204             emit updateForwardAction(currentWebEngineHistoryPointer->canGoForward());
205         }
206     });
207
208     // Update the title when it changes.
209     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::titleChanged, [this, privacyWebEngineViewPointer] (const QString &title)
210     {
211         // Get the index for this tab.
212         int tabIndex = qTabWidgetPointer->indexOf(privacyWebEngineViewPointer);
213
214         // Update the title for this tab.
215         qTabWidgetPointer->setTabText(tabIndex, title);
216
217         // Update the window title if this is the current tab.
218         if (tabIndex == qTabWidgetPointer->currentIndex())
219             emit updateWindowTitle(title);
220     });
221
222     // Connect the loading favorite icon movie to the tab icon.
223     connect(loadingFavoriteIconMoviePointer, &QMovie::frameChanged, [this, privacyWebEngineViewPointer]
224     {
225         // Get the index for this tab.
226         int tabIndex = qTabWidgetPointer->indexOf(privacyWebEngineViewPointer);
227
228         // Display the loading favorite icon if this tab is loading.
229         if (privacyWebEngineViewPointer->isLoading)
230             qTabWidgetPointer->setTabIcon(tabIndex, loadingFavoriteIconMoviePointer->currentPixmap());
231     });
232
233     // Update the icon when it changes.
234     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::iconChanged, [this, privacyWebEngineViewPointer] (const QIcon &newFavoriteIcon)
235     {
236         // Store the favorite icon in the privacy web engine view.
237         if (newFavoriteIcon.isNull())
238             privacyWebEngineViewPointer->favoriteIcon = defaultFavoriteIcon;
239         else
240             privacyWebEngineViewPointer->favoriteIcon = newFavoriteIcon;
241
242         // Get the index for this tab.
243         int tabIndex = qTabWidgetPointer->indexOf(privacyWebEngineViewPointer);
244
245         // Update the icon for this tab.
246         if (newFavoriteIcon.isNull())
247             qTabWidgetPointer->setTabIcon(tabIndex, defaultFavoriteIcon);
248         else
249             qTabWidgetPointer->setTabIcon(tabIndex, newFavoriteIcon);
250     });
251
252     // Update the progress bar and the favorite icon when a load is started.
253     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadStarted, [this, privacyWebEngineViewPointer] ()
254     {
255         // Set the privacy web engine view to be loading.
256         privacyWebEngineViewPointer->isLoading = true;
257
258         // Store the load progress.
259         privacyWebEngineViewPointer->loadProgressInt = 0;
260
261         // Show the progress bar if this is the current tab.
262         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
263             emit showProgressBar(0);
264
265         // Start the loading favorite icon movie.
266         loadingFavoriteIconMoviePointer->start();
267     });
268
269     // Update the progress bar when a load progresses.
270     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadProgress, [this, privacyWebEngineViewPointer] (const int progress)
271     {
272         // Store the load progress.
273         privacyWebEngineViewPointer->loadProgressInt = progress;
274
275         // Update the progress bar if this is the current tab.
276         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
277             emit showProgressBar(progress);
278     });
279
280     // Update the progress bar when a load finishes.
281     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::loadFinished, [this, privacyWebEngineViewPointer] ()
282     {
283         // Set the privacy web engine view to be not loading.
284         privacyWebEngineViewPointer->isLoading = false;
285
286         // Store the load progress.
287         privacyWebEngineViewPointer->loadProgressInt = -1;
288
289         // Hide the progress bar if this is the current tab.
290         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
291             emit hideProgressBar();
292
293         // Get the index for this tab.
294         int tabIndex = qTabWidgetPointer->indexOf(privacyWebEngineViewPointer);
295
296         // Display the current favorite icon
297         qTabWidgetPointer->setTabIcon(tabIndex, privacyWebEngineViewPointer->favoriteIcon);
298
299         // Create a no tabs loading variable.
300         bool noTabsLoading = true;
301
302         // Get the number of tabs.
303         int numberOfTabs = qTabWidgetPointer->count();
304
305         // Check to see if any other tabs are loading.
306         for (int i = 0; i < numberOfTabs; i++)
307         {
308             // Get the privacy WebEngine view for the tab.
309             PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView*>(qTabWidgetPointer->widget(i));
310
311             // Check to see if it is currently loading.  If at least one tab is loading, this flag will end up being marked `false` when the for loop has finished.
312             if (privacyWebEngineViewPointer->isLoading)
313                 noTabsLoading = false;
314         }
315
316         // Stop the loading favorite icon movie if there are no loading tabs.
317         if (noTabsLoading)
318             loadingFavoriteIconMoviePointer->stop();
319     });
320
321     // Display HTTP Ping blocked dialogs.
322     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::displayHttpPingBlockedDialog, [this, privacyWebEngineViewPointer] (const QString &httpPingUrl)
323     {
324         // Only display the HTTP Ping blocked dialog if this is the current tab.
325         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
326         {
327             // Instantiate an HTTP ping blocked message box.
328             QMessageBox httpPingBlockedMessageBox;
329
330             // Set the icon.
331             httpPingBlockedMessageBox.setIcon(QMessageBox::Information);
332
333             // Set the window title.
334             httpPingBlockedMessageBox.setWindowTitle(i18nc("HTTP Ping blocked dialog title", "HTTP Ping Blocked"));
335
336             // Set the text.
337             httpPingBlockedMessageBox.setText(i18nc("HTTP Ping blocked dialog text", "This request has been blocked because it sends a naughty HTTP ping to %1.", httpPingUrl));
338
339             // Set the standard button.
340             httpPingBlockedMessageBox.setStandardButtons(QMessageBox::Ok);
341
342             // Display the message box.
343             httpPingBlockedMessageBox.exec();
344         }
345     });
346
347     // Update the zoom factor when changed by CTRL-Scrolling.  This can be modified when <https://redmine.stoutner.com/issues/845> is fixed.
348     connect(webEnginePagePointer, &QWebEnginePage::contentsSizeChanged, [webEnginePagePointer, this] ()
349     {
350         // Only update the zoom factor action text if this is the current tab.
351         if (webEnginePagePointer == currentWebEnginePagePointer)
352             emit updateZoomFactorAction(webEnginePagePointer->zoomFactor());
353     });
354
355     // Display find text results.
356     connect(webEnginePagePointer, SIGNAL(findTextFinished(const QWebEngineFindTextResult &)), this, SLOT(findTextFinished(const QWebEngineFindTextResult &)));
357
358     // Handle full screen requests.
359     connect(webEnginePagePointer, SIGNAL(fullScreenRequested(QWebEngineFullScreenRequest)), this, SLOT(fullScreenRequested(QWebEngineFullScreenRequest)));
360
361     // Listen for hovered link URLs.
362     connect(webEnginePagePointer, SIGNAL(linkHovered(const QString)), this, SLOT(pageLinkHovered(const QString)));
363
364     // Handle file downloads.
365     connect(webEngineProfilePointer, SIGNAL(downloadRequested(QWebEngineDownloadItem *)), this, SLOT(showSaveDialog(QWebEngineDownloadItem *)));
366
367     // Set the local storage filter.
368     webEngineCookieStorePointer->setCookieFilter([privacyWebEngineViewPointer](const QWebEngineCookieStore::FilterRequest &filterRequest)
369     {
370         // Block all third party local storage requests, including the sneaky ones that don't register a first party URL.
371         if (filterRequest.thirdParty || (filterRequest.firstPartyUrl == QStringLiteral("")))
372         {
373             //qDebug().noquote().nospace() << "Third-party request blocked:  " << filterRequest.origin;
374
375             // Return false.
376             return false;
377         }
378
379         // Allow the request if local storage is enabled.
380         if (privacyWebEngineViewPointer->localStorageEnabled)
381         {
382             //qDebug().noquote().nospace() << "Request allowed by local storage:  " << filterRequest.origin;
383
384             // Return true.
385             return true;
386         }
387
388         //qDebug().noquote().nospace() << "Request blocked by default:  " << filterRequest.origin;
389
390         // Block any remaining local storage requests.
391         return false;
392     });
393
394     // Disable JavaScript by default (this prevents JavaScript from being enabled on a new tab before domain settings are loaded).
395     webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, false);
396
397     // Don't allow JavaScript to open windows.
398     webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, false);
399
400     // Allow keyboard navigation between links and input fields.
401     webEngineSettingsPointer->setAttribute(QWebEngineSettings::SpatialNavigationEnabled, Settings::spatialNavigation());
402
403     // Enable full screen support.
404     webEngineSettingsPointer->setAttribute(QWebEngineSettings::FullScreenSupportEnabled, true);
405
406     // Require user interaction to play media.
407     webEngineSettingsPointer->setAttribute(QWebEngineSettings::PlaybackRequiresUserGesture, true);
408
409     // Limit WebRTC to public IP addresses.
410     webEngineSettingsPointer->setAttribute(QWebEngineSettings::WebRTCPublicInterfacesOnly, true);
411
412     // Enable the PDF viewer (it should be enabled by default, but it is nice to be explicit in case the defaults change).
413     webEngineSettingsPointer->setAttribute(QWebEngineSettings::PdfViewerEnabled, true);
414
415     // Plugins must be enabled for the PDF viewer to work.  <https://doc.qt.io/qt-5/qtwebengine-features.html#pdf-file-viewing>
416     webEngineSettingsPointer->setAttribute(QWebEngineSettings::PluginsEnabled, true);
417
418     // Update the cookies action.
419     connect(privacyWebEngineViewPointer, &PrivacyWebEngineView::updateCookiesAction, [this, privacyWebEngineViewPointer] (const int numberOfCookies)
420     {
421         // Update the cookie action if the specified privacy WebEngine view is the current privacy WebEngine view.
422         if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
423             emit updateCookiesAction(numberOfCookies);
424     });
425
426     // Process cookie changes.
427     connect(webEngineCookieStorePointer, SIGNAL(cookieAdded(QNetworkCookie)), privacyWebEngineViewPointer, SLOT(addCookieToList(QNetworkCookie)));
428     connect(webEngineCookieStorePointer, SIGNAL(cookieRemoved(QNetworkCookie)), privacyWebEngineViewPointer, SLOT(removeCookieFromList(QNetworkCookie)));
429
430     // Get a list of durable cookies.
431     QList<QNetworkCookie*> *durableCookiesListPointer = CookiesDatabase::getCookies();
432
433     // Add the durable cookies to the store.
434     for (QNetworkCookie *cookiePointer : *durableCookiesListPointer)
435         addCookieToStore(*cookiePointer, webEngineCookieStorePointer);
436
437     // Enable spell checking.
438     webEngineProfilePointer->setSpellCheckEnabled(true);
439
440     // Set the spell check language.
441     webEngineProfilePointer->setSpellCheckLanguages(Settings::spellCheckLanguages());
442
443     // Populate the zoom factor.  This is necessary if a URL is being loaded, like a local URL, that does not trigger `applyDomainSettings()`.
444     privacyWebEngineViewPointer->setZoomFactor(Settings::zoomFactor());
445
446     // Update the UI when domain settings are applied.
447     connect(privacyWebEngineViewPointer, SIGNAL(updateUi(const PrivacyWebEngineView*)), this, SLOT(updateUiFromWebEngineView(const PrivacyWebEngineView*)));
448
449     // Move to the new tab if it is not a background tab.
450     if (!backgroundTab)
451         qTabWidgetPointer->setCurrentIndex(newTabIndex);
452
453     // Clear the URL line edit focus so that it populates correctly when opening a new tab from the context menu.
454     if (removeUrlLineEditFocus)
455         emit clearUrlLineEditFocus();
456
457     // Return the privacy WebEngine view pointer.
458     return privacyWebEngineViewPointer;
459 }
460
461 void TabWidget::applyApplicationSettings()
462 {
463     // Set the tab position.
464     if (Settings::tabsOnTop())
465         qTabWidgetPointer->setTabPosition(QTabWidget::North);
466     else
467         qTabWidgetPointer->setTabPosition(QTabWidget::South);
468
469     // Get the number of tabs.
470     int numberOfTabs = qTabWidgetPointer->count();
471
472     // Apply the spatial navigation settings to each WebEngine.
473     for (int i = 0; i < numberOfTabs; ++i) {
474         // Get the WebEngine view pointer.
475         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
476
477         // Apply the spatial navigation settings to each page.
478         privacyWebEngineViewPointer->page()->settings()->setAttribute(QWebEngineSettings::SpatialNavigationEnabled, Settings::spatialNavigation());
479     }
480
481     // Set the search engine URL.
482     searchEngineUrl = SearchEngineHelper::getSearchUrl(Settings::searchEngine());
483
484     // Emit the update search engine actions signal.
485     emit updateSearchEngineActions(Settings::searchEngine(), true);
486 }
487
488 void TabWidget::applyDomainSettingsAndReload()
489 {
490     // Apply the domain settings.  `true` reloads the website.
491     currentPrivacyWebEngineViewPointer->applyDomainSettings(currentPrivacyWebEngineViewPointer->url().host(), true);
492 }
493
494 void TabWidget::applyOnTheFlySearchEngine(QAction *searchEngineActionPointer)
495 {
496     // Store the search engine name.
497     QString searchEngineName = searchEngineActionPointer->text();
498
499     // Strip out any `&` characters.
500     searchEngineName.remove('&');
501
502     // Store the search engine string.
503     searchEngineUrl = SearchEngineHelper::getSearchUrl(searchEngineName);
504
505     // Update the search engine actions.
506     emit updateSearchEngineActions(searchEngineName, false);
507 }
508
509 void TabWidget::applyOnTheFlyUserAgent(QAction *userAgentActionPointer) const
510 {
511     // Get the user agent name.
512     QString userAgentName = userAgentActionPointer->text();
513
514     // Strip out any `&` characters.
515     userAgentName.remove('&');
516
517     // Apply the user agent.
518     currentWebEngineProfilePointer->setHttpUserAgent(userAgentHelperPointer->getUserAgentFromTranslatedName(userAgentName));
519
520     // Update the user agent actions.
521     emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), false);
522
523     // Reload the website.
524     currentPrivacyWebEngineViewPointer->reload();
525 }
526
527 void TabWidget::applyOnTheFlyZoomFactor(const double &zoomFactor) const
528 {
529     // Set the zoom factor.
530     currentPrivacyWebEngineViewPointer->setZoomFactor(zoomFactor);
531 }
532
533 void TabWidget::applySpellCheckLanguages() const
534 {
535     // Get the number of tab.
536     int numberOfTabs = qTabWidgetPointer->count();
537
538     // Set the spell check languages for each tab.
539     for (int i = 0; i < numberOfTabs; ++i)
540     {
541         // Get the WebEngine view pointer.
542         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
543
544         // Get the WebEngine page pointer.
545         QWebEnginePage *webEnginePagePointer = privacyWebEngineViewPointer->page();
546
547         // Get the WebEngine profile pointer.
548         QWebEngineProfile *webEngineProfilePointer = webEnginePagePointer->profile();
549
550         // Set the spell check languages.
551         webEngineProfilePointer->setSpellCheckLanguages(Settings::spellCheckLanguages());
552     }
553 }
554
555 void TabWidget::back() const
556 {
557     // Go back.
558     currentPrivacyWebEngineViewPointer->back();
559 }
560
561 void TabWidget::deleteAllCookies() const
562 {
563     // Delete all the cookies.
564     currentWebEngineCookieStorePointer->deleteAllCookies();
565 }
566
567 void TabWidget::deleteCookieFromStore(const QNetworkCookie &cookie) const
568 {
569     // Delete the cookie.
570     currentWebEngineCookieStorePointer->deleteCookie(cookie);
571 }
572
573 void TabWidget::deleteTab(const int tabIndex)
574 {
575     // Get the privacy WebEngine view.
576     PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(tabIndex));
577
578     // Process the tab delete according to the number of tabs.
579     if (qTabWidgetPointer->count() > 1)  // There is more than one tab.
580     {
581         // Delete the tab.
582         qTabWidgetPointer->removeTab(tabIndex);
583
584         // Delete the WebEngine page to prevent the following error:  `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
585         delete privacyWebEngineViewPointer->page();
586
587         // Delete the privacy WebEngine view.
588         delete privacyWebEngineViewPointer;
589     }
590     else  // There is only one tab.
591     {
592         // Close Privacy Browser.
593         window()->close();
594     }
595 }
596
597 void TabWidget::findPrevious(const QString &text) const
598 {
599     // Store the current text.
600     currentPrivacyWebEngineViewPointer->findString = text;
601
602     // Find the previous text in the current privacy WebEngine.
603     if (currentPrivacyWebEngineViewPointer->findCaseSensitive)
604         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindCaseSensitively|QWebEnginePage::FindBackward);
605     else
606         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindBackward);
607 }
608
609 void TabWidget::findText(const QString &text) const
610 {
611     // Store the current text.
612     currentPrivacyWebEngineViewPointer->findString = text;
613
614     // Find the text in the current privacy WebEngine.
615     if (currentPrivacyWebEngineViewPointer->findCaseSensitive)
616         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindCaseSensitively);
617     else
618         currentPrivacyWebEngineViewPointer->findText(text);
619
620     // Clear the currently selected text in the WebEngine page if the find text is empty.
621     if (text.isEmpty())
622         currentWebEnginePagePointer->action(QWebEnginePage::Unselect)->activate(QAction::Trigger);
623 }
624
625 void TabWidget::findTextFinished(const QWebEngineFindTextResult &findTextResult)
626 {
627     // Update the find text UI if it wasn't simply wiping the current find text selection.  Otherwise the UI temporarily flashes `0/0`.
628     if (wipingCurrentFindTextSelection)  // The current selection is being wiped.
629     {
630         // Reset the flag.
631         wipingCurrentFindTextSelection = false;
632     }
633     else  // A new search has been performed.
634     {
635         // Store the result.
636         currentPrivacyWebEngineViewPointer->findTextResult = findTextResult;
637
638         // Update the UI.
639         emit updateFindTextResults(findTextResult);
640     }
641 }
642
643 void TabWidget::forward() const
644 {
645     // Go forward.
646     currentPrivacyWebEngineViewPointer->forward();
647 }
648
649 void TabWidget::fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest) const
650 {
651     // Make it so.
652     emit fullScreenRequested(fullScreenRequest.toggleOn());
653
654     // Accept the request.
655     fullScreenRequest.accept();
656 }
657
658 std::list<QNetworkCookie>* TabWidget::getCookieList() const
659 {
660     // Return the current cookie list.
661     return currentPrivacyWebEngineViewPointer->cookieListPointer;
662 }
663
664 QString& TabWidget::getDomainSettingsName() const
665 {
666     // Return the domain settings name.
667     return currentPrivacyWebEngineViewPointer->domainSettingsName;
668 }
669
670 void TabWidget::home() const
671 {
672     // Load the homepage.
673     currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(Settings::homepage()));
674 }
675
676 PrivacyWebEngineView* TabWidget::loadBlankInitialWebsite()
677 {
678     // Apply the application settings.
679     applyApplicationSettings();
680
681     // Return the current privacy WebEngine view pointer.
682     return currentPrivacyWebEngineViewPointer;
683 }
684
685 void TabWidget::loadInitialWebsite()
686 {
687     // Apply the application settings.
688     applyApplicationSettings();
689
690     // Get the arguments.
691     QStringList argumentsStringList = qApp->arguments();
692
693     // Check to see if the arguments lists contains a URL.
694     if (argumentsStringList.size() > 1)
695     {
696         // Load the URL from the arguments list.
697         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(argumentsStringList.at(1)));
698     }
699     else
700     {
701         // Load the homepage.
702         home();
703     }
704 }
705
706 void TabWidget::loadUrlFromLineEdit(QString url) const
707 {
708     // Decide if the text is more likely to be a URL or a search.
709     if (url.startsWith("file://"))  // The text is likely a file URL.
710     {
711         // Load the URL.
712         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
713     }
714     else if (url.contains("."))  // The text is likely a URL.
715     {
716         // Check if the URL does not start with a valid protocol.
717         if (!url.startsWith("http"))
718         {
719             // Add `https://` to the beginning of the URL.
720             url = "https://" + url;
721         }
722
723         // Load the URL.
724         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
725     }
726     else  // The text is likely a search.
727     {
728         // Load the search.
729         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(searchEngineUrl + url));
730     }
731 }
732
733 void TabWidget::mouseBack() const
734 {
735     // Go back if possible.
736     if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoBack())
737     {
738         // Clear the URL line edit focus.
739         emit clearUrlLineEditFocus();
740
741         // Go back.
742         currentPrivacyWebEngineViewPointer->back();
743     }
744 }
745
746 void TabWidget::mouseForward() const
747 {
748     // Go forward if possible.
749     if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoForward())
750     {
751         // Clear the URL line edit focus.
752         emit clearUrlLineEditFocus();
753
754         // Go forward.
755         currentPrivacyWebEngineViewPointer->forward();
756     }
757 }
758
759 void TabWidget::pageLinkHovered(const QString &linkUrl) const
760 {
761     // Emit a signal so that the browser window can update the status bar.
762     emit linkHovered(linkUrl);
763 }
764
765 void TabWidget::stopLoadingFavoriteIconMovie() const
766 {
767     // Stop the loading favorite icon movie.  Otherwise, the browser will crash if a second window is closed while a tab in it is loading.  <https://redmine.stoutner.com/issues/1010>
768     loadingFavoriteIconMoviePointer->stop();
769 }
770
771 void TabWidget::print() const
772 {
773     // Create a printer.
774     QPrinter printer;
775
776     // Set the resolution to be 300 dpi.
777     printer.setResolution(300);
778
779     // Create a printer dialog.
780     QPrintDialog printDialog(&printer, currentPrivacyWebEngineViewPointer);
781
782     // Display the dialog and print the page if instructed.
783     if (printDialog.exec() == QDialog::Accepted)
784         printWebpage(&printer);
785 }
786
787 void TabWidget::printPreview() const
788 {
789     // Create a printer.
790     QPrinter printer;
791
792     // Set the resolution to be 300 dpi.
793     printer.setResolution(300);
794
795     // Create a print preview dialog.
796     QPrintPreviewDialog printPreviewDialog(&printer, currentPrivacyWebEngineViewPointer);
797
798     // Generate the print preview.
799     connect(&printPreviewDialog, SIGNAL(paintRequested(QPrinter *)), this, SLOT(printWebpage(QPrinter *)));
800
801     // Display the dialog.
802     printPreviewDialog.exec();
803 }
804
805 void TabWidget::printWebpage(QPrinter *printerPointer) const
806 {
807     // Create an event loop.  For some reason, the print preview doesn't produce any output unless it is run inside an event loop.
808     QEventLoop eventLoop;
809
810     // Print the webpage, converting the callback above into a `QWebEngineCallback<bool>`.
811     // Printing requires that the printer be a pointer, not a reference, or it will crash with much cursing.
812     currentWebEnginePagePointer->print(printerPointer, [&eventLoop](bool printSuccess)
813     {
814         // Instruct the compiler to ignore the unused parameter.
815         (void) printSuccess;
816
817         // Quit the loop.
818         eventLoop.quit();
819     });
820
821     // Execute the loop.
822     eventLoop.exec();
823 }
824
825 void TabWidget::refresh() const
826 {
827     // Reload the website.
828     currentPrivacyWebEngineViewPointer->reload();
829 }
830
831 void TabWidget::setTabBarVisible(const bool visible) const
832 {
833     // Set the tab bar visibility.
834     qTabWidgetPointer->tabBar()->setVisible(visible);
835 }
836
837 void TabWidget::showSaveDialog(QWebEngineDownloadItem *webEngineDownloadItemPointer)
838 {
839     // Get the download attributes.
840     QUrl downloadUrl = webEngineDownloadItemPointer->url();
841     QString mimeTypeString = webEngineDownloadItemPointer->mimeType();
842     QString suggestedFileName = webEngineDownloadItemPointer->suggestedFileName();
843     int totalBytes = webEngineDownloadItemPointer->totalBytes();
844
845     // Check to see if Privacy Browser is not running KDE or if local storage (cookies) is enabled.
846     if (!isRunningKde || currentPrivacyWebEngineViewPointer->localStorageEnabled)  // KDE is not running or local storage (cookies) is enabled.  Use WebEngine's downloader.
847     {
848         // Instantiate the save dialog.
849         SaveDialog *saveDialogPointer = new SaveDialog(downloadUrl, mimeTypeString, totalBytes);
850
851         // Display the save dialog.
852         int saveDialogResult = saveDialogPointer->exec();
853
854         // Process the save dialog results.
855         if (saveDialogResult == QDialog::Accepted)  // Save was selected.
856         {
857             // Get the download directory.
858             QString downloadDirectory = Settings::downloadLocation();
859
860             // Resolve the system download directory if specified.
861             if (downloadDirectory == QLatin1String("System Download Directory"))
862                 downloadDirectory = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
863
864             // Get a file path from the file picker.
865             QString saveFilePath = QFileDialog::getSaveFileName(this, i18nc("Save file dialog caption", "Save File"), downloadDirectory + QLatin1Char('/') + suggestedFileName);
866
867             // Process the save file path.
868             if (!saveFilePath.isEmpty())  // The file save path is populated.
869             {
870                 // Create a save file path file info.
871                 QFileInfo saveFilePathFileInfo = QFileInfo(saveFilePath);
872
873                 // Get the canonical save path and file name.
874                 QString absoluteSavePath = saveFilePathFileInfo.absolutePath();
875                 QString saveFileName = saveFilePathFileInfo.fileName();
876
877                 // Set the download directory and file name.
878                 webEngineDownloadItemPointer->setDownloadDirectory(absoluteSavePath);
879                 webEngineDownloadItemPointer->setDownloadFileName(saveFileName);
880
881                 // Create a file download notification.
882                 KNotification *fileDownloadNotificationPointer = new KNotification(QLatin1String("FileDownload"));
883
884                 // Set the notification title.
885                 fileDownloadNotificationPointer->setTitle(i18nc("Download notification title", "Download"));
886
887                 // Set the notification text.
888                 fileDownloadNotificationPointer->setText(i18nc("Downloading notification text", "Downloading %1", saveFileName));
889
890                 // Set the notification icon.
891                 fileDownloadNotificationPointer->setIconName(QLatin1String("download"));
892
893                 // Set the action list cancel button.
894                 fileDownloadNotificationPointer->setActions(QStringList({i18nc("Download notification action","Cancel")}));
895
896                 // Set the notification to display indefinitely.
897                 fileDownloadNotificationPointer->setFlags(KNotification::Persistent);
898
899                 // Prevent the notification from being autodeleted if it is closed.  Otherwise, the updates to the notification below cause a crash.
900                 fileDownloadNotificationPointer->setAutoDelete(false);
901
902                 // Display the notification.
903                 fileDownloadNotificationPointer->sendEvent();
904
905                 // Handle clicks on the cancel button.
906                 connect(fileDownloadNotificationPointer, &KNotification::action1Activated, [webEngineDownloadItemPointer, saveFileName] ()
907                 {
908                     // Cancel the download.
909                     webEngineDownloadItemPointer->cancel();
910
911                     // Create a file download notification.
912                     KNotification *canceledDownloadNotificationPointer = new KNotification(QLatin1String("FileDownload"));
913
914                     // Set the notification title.
915                     canceledDownloadNotificationPointer->setTitle(i18nc("Download notification title", "Download"));
916
917                     // Set the new text.
918                     canceledDownloadNotificationPointer->setText(i18nc("Download canceled notification", "%1 download canceled", saveFileName));
919
920                     // Set the notification icon.
921                     canceledDownloadNotificationPointer->setIconName(QLatin1String("download"));
922
923                     // Display the notification.
924                     canceledDownloadNotificationPointer->sendEvent();
925                 });
926
927                 // Update the notification when the download progresses.
928                 connect(webEngineDownloadItemPointer, &QWebEngineDownloadItem::downloadProgress, [fileDownloadNotificationPointer, saveFileName] (qint64 bytesReceived, qint64 totalBytes)
929                 {
930                     // Set the new text.  Total bytes will be 0 if the download size is unknown.
931                     if (totalBytes > 0)
932                     {
933                         // Calculate the download percentage.
934                         int downloadPercentage = 100 * bytesReceived / totalBytes;
935
936                         // Set the file download notification text.
937                         fileDownloadNotificationPointer->setText(i18nc("Download progress notification text", "%1\% of %2 downloaded (%3 of %4 bytes)", downloadPercentage, saveFileName,
938                                                                     bytesReceived, totalBytes));
939                     }
940                     else
941                     {
942                         // Set the file download notification text.
943                         fileDownloadNotificationPointer->setText(i18nc("Download progress notification text", "%1:  %2 bytes downloaded", saveFileName, bytesReceived));
944                     }
945
946                     // Display the updated notification.
947                     fileDownloadNotificationPointer->update();
948                 });
949
950                 // Update the notification when the download finishes.  The save file name must be copied into the lambda or a crash occurs.
951                 connect(webEngineDownloadItemPointer, &QWebEngineDownloadItem::finished, [fileDownloadNotificationPointer, saveFileName, saveFilePath] ()
952                 {
953                     // Set the new text.
954                     fileDownloadNotificationPointer->setText(i18nc("Download finished notification text", "%1 download finished", saveFileName));
955
956                     // Set the URL so the file options will be displayed.
957                     fileDownloadNotificationPointer->setUrls(QList<QUrl> {QUrl(saveFilePath)});
958
959                     // Remove the actions from the notification.
960                     fileDownloadNotificationPointer->setActions(QStringList());
961
962                     // Set the notification to disappear after a timeout.
963                     fileDownloadNotificationPointer->setFlags(KNotification::CloseOnTimeout);
964
965                     // Display the updated notification.
966                     fileDownloadNotificationPointer->update();
967                 });
968
969                 // Start the download.
970                 webEngineDownloadItemPointer->accept();
971             }
972             else  // The file save path is not populated.
973             {
974                 // Cancel the download.
975                 webEngineDownloadItemPointer->cancel();
976             }
977         }
978         else  // Cancel was selected.
979         {
980             // Cancel the download.
981             webEngineDownloadItemPointer->cancel();
982         }
983     }
984     else  // KDE is running and local storage (cookies) is disabled.  Use KDE's native downloader.
985           // This must use the show command to launch a separate dialog which cancels WebEngine's automatic background download of the file to a temporary location.
986     {
987         // Instantiate the save dialog.  `true` instructs it to use the native downloader
988         SaveDialog *saveDialogPointer = new SaveDialog(downloadUrl, mimeTypeString, totalBytes, suggestedFileName, true);
989
990         // Connect the save button.
991         connect(saveDialogPointer, SIGNAL(useNativeKdeDownloader(QUrl &, QString &)), this, SLOT(useNativeKdeDownloader(QUrl &, QString &)));
992
993         // Show the dialog.
994         saveDialogPointer->show();
995     }
996 }
997
998 void TabWidget::toggleDomStorage() const
999 {
1000     // Toggle DOM storage.
1001     currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1002
1003     // Update the DOM storage action.
1004     emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1005
1006     // Reload the website.
1007     currentPrivacyWebEngineViewPointer->reload();
1008 }
1009
1010 void TabWidget::toggleFindCaseSensitive(const QString &text)
1011 {
1012     // Toggle find case sensitive.
1013     currentPrivacyWebEngineViewPointer->findCaseSensitive = !currentPrivacyWebEngineViewPointer->findCaseSensitive;
1014
1015     // Set the wiping current find text selection flag.
1016     wipingCurrentFindTextSelection = true;
1017
1018     // Wipe the previous search.  Otherwise currently highlighted words will remain highlighted.
1019     findText(QLatin1String(""));
1020
1021     // Update the find text.
1022     findText(text);
1023 }
1024
1025 void TabWidget::toggleJavaScript() const
1026 {
1027     // Toggle JavaScript.
1028     currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1029
1030     // Update the JavaScript action.
1031     emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1032
1033     // Reload the website.
1034     currentPrivacyWebEngineViewPointer->reload();
1035 }
1036
1037 void TabWidget::toggleLocalStorage()
1038 {
1039     // Toggle local storage.
1040     currentPrivacyWebEngineViewPointer->localStorageEnabled = !currentPrivacyWebEngineViewPointer->localStorageEnabled;
1041
1042     // Update the local storage action.
1043     emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1044
1045     // Reload the website.
1046     currentPrivacyWebEngineViewPointer->reload();
1047 }
1048
1049 void TabWidget::updateUiFromWebEngineView(const PrivacyWebEngineView *privacyWebEngineViewPointer) const
1050 {
1051     // Only update the UI if the signal was emitted from the current privacy WebEngine.
1052     if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
1053     {
1054         // Update the UI.
1055         emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QLatin1String(""));
1056         emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1057         emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1058         emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1059         emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
1060         emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
1061     }
1062 }
1063
1064 void TabWidget::updateUiWithTabSettings()
1065 {
1066     // Update the current WebEngine pointers.
1067     currentPrivacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->currentWidget());
1068     currentWebEngineSettingsPointer = currentPrivacyWebEngineViewPointer->settings();
1069     currentWebEnginePagePointer = currentPrivacyWebEngineViewPointer->page();
1070     currentWebEngineProfilePointer = currentWebEnginePagePointer->profile();
1071     currentWebEngineHistoryPointer = currentWebEnginePagePointer->history();
1072     currentWebEngineCookieStorePointer = currentWebEngineProfilePointer->cookieStore();
1073
1074     // Clear the URL line edit focus.
1075     emit clearUrlLineEditFocus();
1076
1077     // Update the actions.
1078     emit updateBackAction(currentWebEngineHistoryPointer->canGoBack());
1079     emit updateCookiesAction(currentPrivacyWebEngineViewPointer->cookieListPointer->size());
1080     emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1081     emit updateForwardAction(currentWebEngineHistoryPointer->canGoForward());
1082     emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1083     emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1084     emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
1085     emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
1086
1087     // Update the URL.
1088     emit updateWindowTitle(currentPrivacyWebEngineViewPointer->title());
1089     emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QLatin1String(""));
1090     emit updateUrlLineEdit(currentPrivacyWebEngineViewPointer->url());
1091
1092     // Update the find text.
1093     emit updateFindText(currentPrivacyWebEngineViewPointer->findString, currentPrivacyWebEngineViewPointer->findCaseSensitive);
1094     emit updateFindTextResults(currentPrivacyWebEngineViewPointer->findTextResult);
1095
1096     // Update the progress bar.
1097     if (currentPrivacyWebEngineViewPointer->loadProgressInt >= 0)
1098         emit showProgressBar(currentPrivacyWebEngineViewPointer->loadProgressInt);
1099     else
1100         emit hideProgressBar();
1101 }
1102
1103 void TabWidget::useNativeKdeDownloader(QUrl &downloadUrl, QString &suggestedFileName)
1104 {
1105     // Get the download directory.
1106     QString downloadDirectory = Settings::downloadLocation();
1107
1108     // Resolve the system download directory if specified.
1109     if (downloadDirectory == QLatin1String("System Download Directory"))
1110         downloadDirectory = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
1111
1112     // Create a save file dialog.
1113     QFileDialog *saveFileDialogPointer = new QFileDialog(this, i18nc("Save file dialog caption", "Save File"), downloadDirectory);
1114
1115     // Tell the dialog to use a save button.
1116     saveFileDialogPointer->setAcceptMode(QFileDialog::AcceptSave);
1117
1118     // Populate the file name from the download item pointer.
1119     saveFileDialogPointer->selectFile(suggestedFileName);
1120
1121     // Prevent interaction with the parent window while the dialog is open.
1122     saveFileDialogPointer->setWindowModality(Qt::WindowModal);
1123
1124     // Process the saving of the file.  The save file dialog pointer must be captured directly instead of by reference or nasty crashes occur.
1125     auto saveFile = [saveFileDialogPointer, downloadUrl] ()
1126     {
1127         // Get the save location.  The dialog box should only allow the selecting of one file location.
1128         QUrl saveLocation = saveFileDialogPointer->selectedUrls().value(0);
1129
1130         // Create a file copy job.  `-1` creates the file with default permissions.
1131         KIO::FileCopyJob *fileCopyJobPointer = KIO::file_copy(downloadUrl, saveLocation, -1, KIO::Overwrite);
1132
1133         // Set the download job to display any warning and error messages.
1134         fileCopyJobPointer->uiDelegate()->setAutoWarningHandlingEnabled(true);
1135         fileCopyJobPointer->uiDelegate()->setAutoErrorHandlingEnabled(true);
1136
1137         // Start the download.
1138         fileCopyJobPointer->start();
1139     };
1140
1141     // Handle clicks on the save button.
1142     connect(saveFileDialogPointer, &QDialog::accepted, this, saveFile);
1143
1144     // Show the dialog.
1145     saveFileDialogPointer->show();
1146 }