]> gitweb.stoutner.com Git - PrivacyBrowserPC.git/blob - src/widgets/TabWidget.cpp
Add view page source controls. https://redmine.stoutner.com/issues/1022
[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, const QString urlString)
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     if (urlString != nullptr)
458         privacyWebEngineViewPointer->load(QUrl::fromUserInput(urlString));
459
460     // Return the privacy WebEngine view pointer.
461     return privacyWebEngineViewPointer;
462 }
463
464 void TabWidget::applyApplicationSettings()
465 {
466     // Set the tab position.
467     if (Settings::tabsOnTop())
468         qTabWidgetPointer->setTabPosition(QTabWidget::North);
469     else
470         qTabWidgetPointer->setTabPosition(QTabWidget::South);
471
472     // Get the number of tabs.
473     int numberOfTabs = qTabWidgetPointer->count();
474
475     // Apply the spatial navigation settings to each WebEngine.
476     for (int i = 0; i < numberOfTabs; ++i) {
477         // Get the WebEngine view pointer.
478         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
479
480         // Apply the spatial navigation settings to each page.
481         privacyWebEngineViewPointer->page()->settings()->setAttribute(QWebEngineSettings::SpatialNavigationEnabled, Settings::spatialNavigation());
482     }
483
484     // Set the search engine URL.
485     searchEngineUrl = SearchEngineHelper::getSearchUrl(Settings::searchEngine());
486
487     // Emit the update search engine actions signal.
488     emit updateSearchEngineActions(Settings::searchEngine(), true);
489 }
490
491 void TabWidget::applyDomainSettingsAndReload()
492 {
493     // Get the number of tabs.
494     int numberOfTabs = qTabWidgetPointer->count();
495
496     // Apply the domain settings to each WebEngine.
497     for (int i = 0; i < numberOfTabs; ++i) {
498         // Get the WebEngine view pointer.
499         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
500
501         // Apply the spatial navigation settings to each page.
502         privacyWebEngineViewPointer->applyDomainSettings(privacyWebEngineViewPointer->url().host(), true);
503     }
504 }
505
506 void TabWidget::applyOnTheFlySearchEngine(QAction *searchEngineActionPointer)
507 {
508     // Store the search engine name.
509     QString searchEngineName = searchEngineActionPointer->text();
510
511     // Strip out any `&` characters.
512     searchEngineName.remove('&');
513
514     // Store the search engine string.
515     searchEngineUrl = SearchEngineHelper::getSearchUrl(searchEngineName);
516
517     // Update the search engine actions.
518     emit updateSearchEngineActions(searchEngineName, false);
519 }
520
521 void TabWidget::applyOnTheFlyUserAgent(QAction *userAgentActionPointer) const
522 {
523     // Get the user agent name.
524     QString userAgentName = userAgentActionPointer->text();
525
526     // Strip out any `&` characters.
527     userAgentName.remove('&');
528
529     // Apply the user agent.
530     currentWebEngineProfilePointer->setHttpUserAgent(userAgentHelperPointer->getUserAgentFromTranslatedName(userAgentName));
531
532     // Update the user agent actions.
533     emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), false);
534
535     // Reload the website.
536     currentPrivacyWebEngineViewPointer->reload();
537 }
538
539 void TabWidget::applyOnTheFlyZoomFactor(const double &zoomFactor) const
540 {
541     // Set the zoom factor.
542     currentPrivacyWebEngineViewPointer->setZoomFactor(zoomFactor);
543 }
544
545 void TabWidget::applySpellCheckLanguages() const
546 {
547     // Get the number of tab.
548     int numberOfTabs = qTabWidgetPointer->count();
549
550     // Set the spell check languages for each tab.
551     for (int i = 0; i < numberOfTabs; ++i)
552     {
553         // Get the WebEngine view pointer.
554         PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(i));
555
556         // Get the WebEngine page pointer.
557         QWebEnginePage *webEnginePagePointer = privacyWebEngineViewPointer->page();
558
559         // Get the WebEngine profile pointer.
560         QWebEngineProfile *webEngineProfilePointer = webEnginePagePointer->profile();
561
562         // Set the spell check languages.
563         webEngineProfilePointer->setSpellCheckLanguages(Settings::spellCheckLanguages());
564     }
565 }
566
567 void TabWidget::back() const
568 {
569     // Go back.
570     currentPrivacyWebEngineViewPointer->back();
571 }
572
573 void TabWidget::deleteAllCookies() const
574 {
575     // Delete all the cookies.
576     currentWebEngineCookieStorePointer->deleteAllCookies();
577 }
578
579 void TabWidget::deleteCookieFromStore(const QNetworkCookie &cookie) const
580 {
581     // Delete the cookie.
582     currentWebEngineCookieStorePointer->deleteCookie(cookie);
583 }
584
585 void TabWidget::deleteTab(const int tabIndex)
586 {
587     // Get the privacy WebEngine view.
588     PrivacyWebEngineView *privacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->widget(tabIndex));
589
590     // Process the tab delete according to the number of tabs.
591     if (qTabWidgetPointer->count() > 1)  // There is more than one tab.
592     {
593         // Delete the tab.
594         qTabWidgetPointer->removeTab(tabIndex);
595
596         // Delete the WebEngine page to prevent the following error:  `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
597         delete privacyWebEngineViewPointer->page();
598
599         // Delete the privacy WebEngine view.
600         delete privacyWebEngineViewPointer;
601     }
602     else  // There is only one tab.
603     {
604         // Close Privacy Browser.
605         window()->close();
606     }
607 }
608
609 void TabWidget::findPrevious(const QString &text) const
610 {
611     // Store the current text.
612     currentPrivacyWebEngineViewPointer->findString = text;
613
614     // Find the previous text in the current privacy WebEngine.
615     if (currentPrivacyWebEngineViewPointer->findCaseSensitive)
616         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindCaseSensitively|QWebEnginePage::FindBackward);
617     else
618         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindBackward);
619 }
620
621 void TabWidget::findText(const QString &text) const
622 {
623     // Store the current text.
624     currentPrivacyWebEngineViewPointer->findString = text;
625
626     // Find the text in the current privacy WebEngine.
627     if (currentPrivacyWebEngineViewPointer->findCaseSensitive)
628         currentPrivacyWebEngineViewPointer->findText(text, QWebEnginePage::FindCaseSensitively);
629     else
630         currentPrivacyWebEngineViewPointer->findText(text);
631
632     // Clear the currently selected text in the WebEngine page if the find text is empty.
633     if (text.isEmpty())
634         currentWebEnginePagePointer->action(QWebEnginePage::Unselect)->activate(QAction::Trigger);
635 }
636
637 void TabWidget::findTextFinished(const QWebEngineFindTextResult &findTextResult)
638 {
639     // Update the find text UI if it wasn't simply wiping the current find text selection.  Otherwise the UI temporarily flashes `0/0`.
640     if (wipingCurrentFindTextSelection)  // The current selection is being wiped.
641     {
642         // Reset the flag.
643         wipingCurrentFindTextSelection = false;
644     }
645     else  // A new search has been performed.
646     {
647         // Store the result.
648         currentPrivacyWebEngineViewPointer->findTextResult = findTextResult;
649
650         // Update the UI.
651         emit updateFindTextResults(findTextResult);
652     }
653 }
654
655 void TabWidget::forward() const
656 {
657     // Go forward.
658     currentPrivacyWebEngineViewPointer->forward();
659 }
660
661 void TabWidget::fullScreenRequested(QWebEngineFullScreenRequest fullScreenRequest) const
662 {
663     // Make it so.
664     emit fullScreenRequested(fullScreenRequest.toggleOn());
665
666     // Accept the request.
667     fullScreenRequest.accept();
668 }
669
670 std::list<QNetworkCookie>* TabWidget::getCookieList() const
671 {
672     // Return the current cookie list.
673     return currentPrivacyWebEngineViewPointer->cookieListPointer;
674 }
675
676 QString& TabWidget::getDomainSettingsName() const
677 {
678     // Return the domain settings name.
679     return currentPrivacyWebEngineViewPointer->domainSettingsName;
680 }
681
682 void TabWidget::home() const
683 {
684     // Load the homepage.
685     currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(Settings::homepage()));
686 }
687
688 PrivacyWebEngineView* TabWidget::loadBlankInitialWebsite()
689 {
690     // Apply the application settings.
691     applyApplicationSettings();
692
693     // Return the current privacy WebEngine view pointer.
694     return currentPrivacyWebEngineViewPointer;
695 }
696
697 void TabWidget::loadInitialWebsite()
698 {
699     // Apply the application settings.
700     applyApplicationSettings();
701
702     // Get the arguments.
703     QStringList argumentsStringList = qApp->arguments();
704
705     // Check to see if the arguments lists contains a URL.
706     if (argumentsStringList.size() > 1)
707     {
708         // Load the URL from the arguments list.
709         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(argumentsStringList.at(1)));
710     }
711     else
712     {
713         // Load the homepage.
714         home();
715     }
716 }
717
718 void TabWidget::loadUrlFromLineEdit(QString url) const
719 {
720     // Decide if the text is more likely to be a URL or a search.
721     if (url.startsWith("file://") || url.startsWith("view-source:"))  // The text is likely a file or view source URL.
722     {
723         // Load the URL.
724         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
725     }
726     else if (url.contains("."))  // The text is likely a URL.
727     {
728         // Check if the URL does not start with a valid protocol.
729         if (!url.startsWith("http"))
730         {
731             // Add `https://` to the beginning of the URL.
732             url = "https://" + url;
733         }
734
735         // Load the URL.
736         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(url));
737     }
738     else  // The text is likely a search.
739     {
740         // Load the search.
741         currentPrivacyWebEngineViewPointer->load(QUrl::fromUserInput(searchEngineUrl + url));
742     }
743 }
744
745 void TabWidget::mouseBack() const
746 {
747     // Go back if possible.
748     if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoBack())
749     {
750         // Clear the URL line edit focus.
751         emit clearUrlLineEditFocus();
752
753         // Go back.
754         currentPrivacyWebEngineViewPointer->back();
755     }
756 }
757
758 void TabWidget::mouseForward() const
759 {
760     // Go forward if possible.
761     if (currentPrivacyWebEngineViewPointer->isActiveWindow() && currentWebEngineHistoryPointer->canGoForward())
762     {
763         // Clear the URL line edit focus.
764         emit clearUrlLineEditFocus();
765
766         // Go forward.
767         currentPrivacyWebEngineViewPointer->forward();
768     }
769 }
770
771 void TabWidget::pageLinkHovered(const QString &linkUrl) const
772 {
773     // Emit a signal so that the browser window can update the status bar.
774     emit linkHovered(linkUrl);
775 }
776
777 void TabWidget::stopLoadingFavoriteIconMovie() const
778 {
779     // 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>
780     loadingFavoriteIconMoviePointer->stop();
781 }
782
783 void TabWidget::print() const
784 {
785     // Create a printer.
786     QPrinter printer;
787
788     // Set the resolution to be 300 dpi.
789     printer.setResolution(300);
790
791     // Create a printer dialog.
792     QPrintDialog printDialog(&printer, currentPrivacyWebEngineViewPointer);
793
794     // Display the dialog and print the page if instructed.
795     if (printDialog.exec() == QDialog::Accepted)
796         printWebpage(&printer);
797 }
798
799 void TabWidget::printPreview() const
800 {
801     // Create a printer.
802     QPrinter printer;
803
804     // Set the resolution to be 300 dpi.
805     printer.setResolution(300);
806
807     // Create a print preview dialog.
808     QPrintPreviewDialog printPreviewDialog(&printer, currentPrivacyWebEngineViewPointer);
809
810     // Generate the print preview.
811     connect(&printPreviewDialog, SIGNAL(paintRequested(QPrinter *)), this, SLOT(printWebpage(QPrinter *)));
812
813     // Display the dialog.
814     printPreviewDialog.exec();
815 }
816
817 void TabWidget::printWebpage(QPrinter *printerPointer) const
818 {
819     // Create an event loop.  For some reason, the print preview doesn't produce any output unless it is run inside an event loop.
820     QEventLoop eventLoop;
821
822     // Print the webpage, converting the callback above into a `QWebEngineCallback<bool>`.
823     // Printing requires that the printer be a pointer, not a reference, or it will crash with much cursing.
824     currentWebEnginePagePointer->print(printerPointer, [&eventLoop](bool printSuccess)
825     {
826         // Instruct the compiler to ignore the unused parameter.
827         (void) printSuccess;
828
829         // Quit the loop.
830         eventLoop.quit();
831     });
832
833     // Execute the loop.
834     eventLoop.exec();
835 }
836
837 void TabWidget::refresh() const
838 {
839     // Reload the website.
840     currentPrivacyWebEngineViewPointer->reload();
841 }
842
843 void TabWidget::reloadAndBypassCache() const
844 {
845     // Reload the website, bypassing the cache.
846     currentWebEnginePagePointer->triggerAction(QWebEnginePage::ReloadAndBypassCache);
847 }
848
849
850 void TabWidget::setTabBarVisible(const bool visible) const
851 {
852     // Set the tab bar visibility.
853     qTabWidgetPointer->tabBar()->setVisible(visible);
854 }
855
856 void TabWidget::showSaveDialog(QWebEngineDownloadItem *webEngineDownloadItemPointer)
857 {
858     // Get the download attributes.
859     QUrl downloadUrl = webEngineDownloadItemPointer->url();
860     QString mimeTypeString = webEngineDownloadItemPointer->mimeType();
861     QString suggestedFileName = webEngineDownloadItemPointer->suggestedFileName();
862     int totalBytes = webEngineDownloadItemPointer->totalBytes();
863
864     // Check to see if Privacy Browser is not running KDE or if local storage (cookies) is enabled.
865     if (!isRunningKde || currentPrivacyWebEngineViewPointer->localStorageEnabled)  // KDE is not running or local storage (cookies) is enabled.  Use WebEngine's downloader.
866     {
867         // Instantiate the save dialog.
868         SaveDialog *saveDialogPointer = new SaveDialog(downloadUrl, mimeTypeString, totalBytes);
869
870         // Display the save dialog.
871         int saveDialogResult = saveDialogPointer->exec();
872
873         // Process the save dialog results.
874         if (saveDialogResult == QDialog::Accepted)  // Save was selected.
875         {
876             // Get the download directory.
877             QString downloadDirectory = Settings::downloadLocation();
878
879             // Resolve the system download directory if specified.
880             if (downloadDirectory == QLatin1String("System Download Directory"))
881                 downloadDirectory = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
882
883             // Get a file path from the file picker.
884             QString saveFilePath = QFileDialog::getSaveFileName(this, i18nc("Save file dialog caption", "Save File"), downloadDirectory + QLatin1Char('/') + suggestedFileName);
885
886             // Process the save file path.
887             if (!saveFilePath.isEmpty())  // The file save path is populated.
888             {
889                 // Create a save file path file info.
890                 QFileInfo saveFilePathFileInfo = QFileInfo(saveFilePath);
891
892                 // Get the canonical save path and file name.
893                 QString absoluteSavePath = saveFilePathFileInfo.absolutePath();
894                 QString saveFileName = saveFilePathFileInfo.fileName();
895
896                 // Set the download directory and file name.
897                 webEngineDownloadItemPointer->setDownloadDirectory(absoluteSavePath);
898                 webEngineDownloadItemPointer->setDownloadFileName(saveFileName);
899
900                 // Create a file download notification.
901                 KNotification *fileDownloadNotificationPointer = new KNotification(QLatin1String("FileDownload"));
902
903                 // Set the notification title.
904                 fileDownloadNotificationPointer->setTitle(i18nc("Download notification title", "Download"));
905
906                 // Set the notification text.
907                 fileDownloadNotificationPointer->setText(i18nc("Downloading notification text", "Downloading %1", saveFileName));
908
909                 // Get the download icon from the theme.
910                 QIcon downloadIcon = QIcon::fromTheme(QLatin1String("download"), QIcon::fromTheme(QLatin1String("document-save")));
911
912                 // Set the notification icon.
913                 fileDownloadNotificationPointer->setIconName(downloadIcon.name());
914
915                 // Set the action list cancel button.
916                 fileDownloadNotificationPointer->setActions(QStringList({i18nc("Download notification action","Cancel")}));
917
918                 // Prevent the notification from being autodeleted if it is closed.  Otherwise, the updates to the notification below cause a crash.
919                 fileDownloadNotificationPointer->setAutoDelete(false);
920
921                 // Display the notification.
922                 fileDownloadNotificationPointer->sendEvent();
923
924                 // Handle clicks on the cancel button.
925                 connect(fileDownloadNotificationPointer, &KNotification::action1Activated, [webEngineDownloadItemPointer, saveFileName] ()
926                 {
927                     // Cancel the download.
928                     webEngineDownloadItemPointer->cancel();
929
930                     // Create a file download notification.
931                     KNotification *canceledDownloadNotificationPointer = new KNotification(QLatin1String("FileDownload"));
932
933                     // Set the notification title.
934                     canceledDownloadNotificationPointer->setTitle(i18nc("Download notification title", "Download"));
935
936                     // Set the new text.
937                     canceledDownloadNotificationPointer->setText(i18nc("Download canceled notification", "%1 download canceled", saveFileName));
938
939                     // Set the notification icon.
940                     canceledDownloadNotificationPointer->setIconName(QLatin1String("download"));
941
942                     // Display the notification.
943                     canceledDownloadNotificationPointer->sendEvent();
944                 });
945
946                 // Update the notification when the download progresses.
947                 connect(webEngineDownloadItemPointer, &QWebEngineDownloadItem::downloadProgress, [fileDownloadNotificationPointer, saveFileName] (qint64 bytesReceived, qint64 totalBytes)
948                 {
949                     // Set the new text.  Total bytes will be 0 if the download size is unknown.
950                     if (totalBytes > 0)
951                     {
952                         // Calculate the download percentage.
953                         int downloadPercentage = 100 * bytesReceived / totalBytes;
954
955                         // Set the file download notification text.
956                         fileDownloadNotificationPointer->setText(i18nc("Download progress notification text", "%1\% of %2 downloaded (%3 of %4 bytes)", downloadPercentage, saveFileName,
957                                                                     bytesReceived, totalBytes));
958                     }
959                     else
960                     {
961                         // Set the file download notification text.
962                         fileDownloadNotificationPointer->setText(i18nc("Download progress notification text", "%1:  %2 bytes downloaded", saveFileName, bytesReceived));
963                     }
964
965                     // Display the updated notification.
966                     fileDownloadNotificationPointer->update();
967                 });
968
969                 // Update the notification when the download finishes.  The save file name must be copied into the lambda or a crash occurs.
970                 connect(webEngineDownloadItemPointer, &QWebEngineDownloadItem::finished, [fileDownloadNotificationPointer, saveFileName, saveFilePath] ()
971                 {
972                     // Set the new text.
973                     fileDownloadNotificationPointer->setText(i18nc("Download finished notification text", "%1 download finished", saveFileName));
974
975                     // Set the URL so the file options will be displayed.
976                     fileDownloadNotificationPointer->setUrls(QList<QUrl> {QUrl(saveFilePath)});
977
978                     // Remove the actions from the notification.
979                     fileDownloadNotificationPointer->setActions(QStringList());
980
981                     // Set the notification to disappear after a timeout.
982                     fileDownloadNotificationPointer->setFlags(KNotification::CloseOnTimeout);
983
984                     // Display the updated notification.
985                     fileDownloadNotificationPointer->update();
986                 });
987
988                 // Start the download.
989                 webEngineDownloadItemPointer->accept();
990             }
991             else  // The file save path is not populated.
992             {
993                 // Cancel the download.
994                 webEngineDownloadItemPointer->cancel();
995             }
996         }
997         else  // Cancel was selected.
998         {
999             // Cancel the download.
1000             webEngineDownloadItemPointer->cancel();
1001         }
1002     }
1003     else  // KDE is running and local storage (cookies) is disabled.  Use KDE's native downloader.
1004           // 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.
1005     {
1006         // Instantiate the save dialog.  `true` instructs it to use the native downloader
1007         SaveDialog *saveDialogPointer = new SaveDialog(downloadUrl, mimeTypeString, totalBytes, suggestedFileName, true);
1008
1009         // Connect the save button.
1010         connect(saveDialogPointer, SIGNAL(useNativeKdeDownloader(QUrl &, QString &)), this, SLOT(useNativeKdeDownloader(QUrl &, QString &)));
1011
1012         // Show the dialog.
1013         saveDialogPointer->show();
1014     }
1015 }
1016
1017 void TabWidget::toggleDomStorage() const
1018 {
1019     // Toggle DOM storage.
1020     currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1021
1022     // Update the DOM storage action.
1023     emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1024
1025     // Reload the website.
1026     currentPrivacyWebEngineViewPointer->reload();
1027 }
1028
1029 void TabWidget::toggleFindCaseSensitive(const QString &text)
1030 {
1031     // Toggle find case sensitive.
1032     currentPrivacyWebEngineViewPointer->findCaseSensitive = !currentPrivacyWebEngineViewPointer->findCaseSensitive;
1033
1034     // Set the wiping current find text selection flag.
1035     wipingCurrentFindTextSelection = true;
1036
1037     // Wipe the previous search.  Otherwise currently highlighted words will remain highlighted.
1038     findText(QLatin1String(""));
1039
1040     // Update the find text.
1041     findText(text);
1042 }
1043
1044 void TabWidget::toggleJavaScript() const
1045 {
1046     // Toggle JavaScript.
1047     currentWebEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, !currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1048
1049     // Update the JavaScript action.
1050     emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1051
1052     // Reload the website.
1053     currentPrivacyWebEngineViewPointer->reload();
1054 }
1055
1056 void TabWidget::toggleLocalStorage()
1057 {
1058     // Toggle local storage.
1059     currentPrivacyWebEngineViewPointer->localStorageEnabled = !currentPrivacyWebEngineViewPointer->localStorageEnabled;
1060
1061     // Update the local storage action.
1062     emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1063
1064     // Reload the website.
1065     currentPrivacyWebEngineViewPointer->reload();
1066 }
1067
1068 void TabWidget::updateUiFromWebEngineView(const PrivacyWebEngineView *privacyWebEngineViewPointer) const
1069 {
1070     // Only update the UI if the signal was emitted from the current privacy WebEngine.
1071     if (privacyWebEngineViewPointer == currentPrivacyWebEngineViewPointer)
1072     {
1073         // Update the UI.
1074         emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QLatin1String(""));
1075         emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1076         emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1077         emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1078         emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
1079         emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
1080     }
1081 }
1082
1083 void TabWidget::updateUiWithTabSettings()
1084 {
1085     // Update the current WebEngine pointers.
1086     currentPrivacyWebEngineViewPointer = qobject_cast<PrivacyWebEngineView *>(qTabWidgetPointer->currentWidget());
1087     currentWebEngineSettingsPointer = currentPrivacyWebEngineViewPointer->settings();
1088     currentWebEnginePagePointer = currentPrivacyWebEngineViewPointer->page();
1089     currentWebEngineProfilePointer = currentWebEnginePagePointer->profile();
1090     currentWebEngineHistoryPointer = currentWebEnginePagePointer->history();
1091     currentWebEngineCookieStorePointer = currentWebEngineProfilePointer->cookieStore();
1092
1093     // Clear the URL line edit focus.
1094     emit clearUrlLineEditFocus();
1095
1096     // Update the actions.
1097     emit updateBackAction(currentWebEngineHistoryPointer->canGoBack());
1098     emit updateCookiesAction(currentPrivacyWebEngineViewPointer->cookieListPointer->size());
1099     emit updateDomStorageAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
1100     emit updateForwardAction(currentWebEngineHistoryPointer->canGoForward());
1101     emit updateJavaScriptAction(currentWebEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
1102     emit updateLocalStorageAction(currentPrivacyWebEngineViewPointer->localStorageEnabled);
1103     emit updateUserAgentActions(currentWebEngineProfilePointer->httpUserAgent(), true);
1104     emit updateZoomFactorAction(currentPrivacyWebEngineViewPointer->zoomFactor());
1105
1106     // Update the URL.
1107     emit updateWindowTitle(currentPrivacyWebEngineViewPointer->title());
1108     emit updateDomainSettingsIndicator(currentPrivacyWebEngineViewPointer->domainSettingsName != QLatin1String(""));
1109     emit updateUrlLineEdit(currentPrivacyWebEngineViewPointer->url());
1110
1111     // Update the find text.
1112     emit updateFindText(currentPrivacyWebEngineViewPointer->findString, currentPrivacyWebEngineViewPointer->findCaseSensitive);
1113     emit updateFindTextResults(currentPrivacyWebEngineViewPointer->findTextResult);
1114
1115     // Update the progress bar.
1116     if (currentPrivacyWebEngineViewPointer->loadProgressInt >= 0)
1117         emit showProgressBar(currentPrivacyWebEngineViewPointer->loadProgressInt);
1118     else
1119         emit hideProgressBar();
1120 }
1121
1122 void TabWidget::useNativeKdeDownloader(QUrl &downloadUrl, QString &suggestedFileName)
1123 {
1124     // Get the download directory.
1125     QString downloadDirectory = Settings::downloadLocation();
1126
1127     // Resolve the system download directory if specified.
1128     if (downloadDirectory == QLatin1String("System Download Directory"))
1129         downloadDirectory = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
1130
1131     // Create a save file dialog.
1132     QFileDialog *saveFileDialogPointer = new QFileDialog(this, i18nc("Save file dialog caption", "Save File"), downloadDirectory);
1133
1134     // Tell the dialog to use a save button.
1135     saveFileDialogPointer->setAcceptMode(QFileDialog::AcceptSave);
1136
1137     // Populate the file name from the download item pointer.
1138     saveFileDialogPointer->selectFile(suggestedFileName);
1139
1140     // Prevent interaction with the parent window while the dialog is open.
1141     saveFileDialogPointer->setWindowModality(Qt::WindowModal);
1142
1143     // Process the saving of the file.  The save file dialog pointer must be captured directly instead of by reference or nasty crashes occur.
1144     auto saveFile = [saveFileDialogPointer, downloadUrl] ()
1145     {
1146         // Get the save location.  The dialog box should only allow the selecting of one file location.
1147         QUrl saveLocation = saveFileDialogPointer->selectedUrls().value(0);
1148
1149         // Create a file copy job.  `-1` creates the file with default permissions.
1150         KIO::FileCopyJob *fileCopyJobPointer = KIO::file_copy(downloadUrl, saveLocation, -1, KIO::Overwrite);
1151
1152         // Set the download job to display any warning and error messages.
1153         fileCopyJobPointer->uiDelegate()->setAutoWarningHandlingEnabled(true);
1154         fileCopyJobPointer->uiDelegate()->setAutoErrorHandlingEnabled(true);
1155
1156         // Start the download.
1157         fileCopyJobPointer->start();
1158     };
1159
1160     // Handle clicks on the save button.
1161     connect(saveFileDialogPointer, &QDialog::accepted, this, saveFile);
1162
1163     // Show the dialog.
1164     saveFileDialogPointer->show();
1165 }