]> gitweb.stoutner.com Git - PrivacyBrowserPC.git/blobdiff - src/views/BrowserView.cpp
Add local storage domain settings.
[PrivacyBrowserPC.git] / src / views / BrowserView.cpp
index edcd26c0f42276cd77ceb88efc1b65adcdc131b4..440c694ab02a7ca130bfc58dbeb85ba9fa2a1b8b 100644 (file)
@@ -19,9 +19,9 @@
 
 // Application headers.
 #include "BrowserView.h"
-#include "MouseEventFilter.h"
 #include "Settings.h"
 #include "ui_BrowserView.h"
+#include "filters/MouseEventFilter.h"
 #include "helpers/DomainsDatabaseHelper.h"
 #include "helpers/SearchEngineHelper.h"
 #include "helpers/UserAgentHelper.h"
 
 // Qt framework headers.
 #include <QAction>
-#include <QWebEngineProfile>
 
+// Initialize the public static variables.
+QString BrowserView::webEngineDefaultUserAgent = QStringLiteral("");
+
+// Construct the class.
 BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
 {
+    // Initialize the variables.
+    privacyWebEngineListPointer = new QList<PrivacyWebEngine*>;
+
     // Instantiate the browser view UI.
     Ui::BrowserView browserViewUi;
 
@@ -43,11 +49,53 @@ BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
     // Get handles for the views.
     webEngineViewPointer = browserViewUi.webEngineView;
 
+    // Create an off-the-record profile (the default when no profile name is specified).
+    webEngineProfilePointer = new QWebEngineProfile(QStringLiteral(""));
+
+    // Create a WebEngine page.
+    webEnginePagePointer = new QWebEnginePage(webEngineProfilePointer);
+
+    // Set the WebEngine page.
+    webEngineViewPointer->setPage(webEnginePagePointer);
+
     // Get handles for the aspects of the WebEngine.
-    QWebEnginePage *webEnginePagePointer = webEngineViewPointer->page();
     webEngineHistoryPointer = webEnginePagePointer->history();
-    webEngineProfilePointer = webEnginePagePointer->profile();
     webEngineSettingsPointer = webEngineViewPointer->settings();
+    webEngineCookieStorePointer = webEngineProfilePointer->cookieStore();
+
+    // Initialize the current privacy web engine pointer.
+    currentPrivacyWebEnginePointer = new PrivacyWebEngine(webEngineViewPointer);
+
+    // Populate the privacy web engine list.
+    privacyWebEngineListPointer->append(currentPrivacyWebEnginePointer);
+
+    // Set the local storage filter.
+    webEngineCookieStorePointer->setCookieFilter([this](const QWebEngineCookieStore::FilterRequest &filterRequest)
+    {
+        // qDebug() << "Page URL:  " << filterRequest.firstPartyUrl << ", Local storage URL:  " << filterRequest.origin << ",  Is third-party:  " << filterRequest.thirdParty;
+
+        // Block all third party local storage requests, including the sneaky ones that don't register a first party URL.
+        if (filterRequest.thirdParty || (filterRequest.firstPartyUrl == QStringLiteral("")))
+            return false;
+
+        // Check each tab to see if this local storage request should be allowed.
+        for (PrivacyWebEngine *privacyWebEnginePointer : *privacyWebEngineListPointer)
+        {
+            // Allow this local storage request if it comes from a tab with local storage enabled.
+            if (privacyWebEnginePointer->localStorageEnabled && (webEngineViewPointer->url().host() == filterRequest.firstPartyUrl.host()))
+                return true;
+        }
+
+        // Block any remaining local storage requests.
+        return false;
+    });
+
+    // Process cookie changes.
+    connect(webEngineCookieStorePointer, SIGNAL(cookieAdded(QNetworkCookie)), this, SLOT(cookieAdded(QNetworkCookie)));
+    connect(webEngineCookieStorePointer, SIGNAL(cookieRemoved(QNetworkCookie)), this, SLOT(cookieRemoved(QNetworkCookie)));
+
+    // Store a copy of the WebEngine default user agent.
+    webEngineDefaultUserAgent = webEngineProfilePointer->httpUserAgent();
 
     // Update the URL line edit when the URL changes.
     connect(webEngineViewPointer, SIGNAL(urlChanged(const QUrl)), this, SLOT(updateUrl(const QUrl)));
@@ -58,11 +106,15 @@ BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
     connect(webEngineViewPointer, SIGNAL(loadFinished(const bool)), this, SLOT(loadFinished()));
 
     // Instantiate the mouse event filter pointer.
-    MouseEventFilter *mouseEventFilterPointer = new MouseEventFilter(webEngineViewPointer);
+    MouseEventFilter *mouseEventFilterPointer = new MouseEventFilter();
 
     // Install the mouse event filter.
     qApp->installEventFilter(mouseEventFilterPointer);
 
+    // Process mouse forward and back commands.
+    connect(mouseEventFilterPointer, SIGNAL(mouseBack()), this, SLOT(mouseBack()));
+    connect(mouseEventFilterPointer, SIGNAL(mouseForward()), this, SLOT(mouseForward()));
+
     // Listen for hovered link URLs.
     connect(webEnginePagePointer, SIGNAL(linkHovered(const QString)), this, SLOT(pageLinkHovered(const QString)));
 
@@ -75,9 +127,6 @@ BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
     // Reapply the domain settings when the host changes.
     connect(urlRequestInterceptorPointer, SIGNAL(applyDomainSettings(QString)), this, SLOT(applyDomainSettingsWithoutReloading(QString)));
 
-    // Disable the cache.
-    webEngineProfilePointer->setHttpCacheType(QWebEngineProfile::NoCache);
-
     // Don't allow JavaScript to open windows.
     webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptCanOpenWindows, false);
 
@@ -97,6 +146,32 @@ BrowserView::BrowserView(QWidget *parent) : QWidget(parent)
     webEngineViewPointer->setFocus();
 }
 
+BrowserView::~BrowserView()
+{
+    // Delay the deletion of the WebEngine page to prevent the following error:  `Release of profile requested but WebEnginePage still not deleted. Expect troubles !`
+    webEnginePagePointer->deleteLater();
+}
+
+void BrowserView::addCookieToStore(QNetworkCookie &cookie) const
+{
+    // Create a url.
+    QUrl url;
+
+    // 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>
+    if (!cookie.domain().startsWith(QStringLiteral(".")))
+    {
+        // Populate the URL.
+        url.setHost(cookie.domain());
+        url.setScheme(QStringLiteral("https"));
+
+        // Clear the domain from the cookie.
+        cookie.setDomain(QStringLiteral(""));
+    }
+
+    // Add the cookie to the store.
+    webEngineCookieStorePointer->setCookie(cookie, url);
+}
+
 void BrowserView::applyApplicationSettings()
 {
     // Set the search engine URL.
@@ -137,53 +212,81 @@ void BrowserView::applyDomainSettings(const QString &hostname, const bool reload
         // Set the JavaScript status.
         switch (domainRecord.field(DomainsDatabaseHelper::JAVASCRIPT).value().toInt())
         {
+            // Set the default JavaScript status.
             case (DomainsDatabaseHelper::SYSTEM_DEFAULT):
             {
-                // Set the default JavaScript status.
-                webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScript());
+                webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScriptEnabled());
 
                 break;
             }
 
+            // Disable JavaScript.
             case (DomainsDatabaseHelper::DISABLED):
             {
-                // Disable JavaScript.
                 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, false);
 
                 break;
             }
 
+            // Enable JavaScript.
             case (DomainsDatabaseHelper::ENABLED):
             {
-                // Enable JavaScript.
                 webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, true);
 
                 break;
             }
         }
 
-        // Set local storage.
+        // Set the local storage status.
         switch (domainRecord.field(DomainsDatabaseHelper::LOCAL_STORAGE).value().toInt())
         {
+            // Set the default local storage status.
             case (DomainsDatabaseHelper::SYSTEM_DEFAULT):
             {
-                // Set the default local storage status.
-                webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::localStorage());
+                currentPrivacyWebEnginePointer->localStorageEnabled = Settings::localStorageEnabled();
 
                 break;
             }
 
+            // Disable local storage.
+            case (DomainsDatabaseHelper::DISABLED):
+            {
+                currentPrivacyWebEnginePointer->localStorageEnabled = false;
+
+                break;
+            }
+
+            // Enable local storage.
+            case (DomainsDatabaseHelper::ENABLED):
+            {
+                currentPrivacyWebEnginePointer->localStorageEnabled = true;
+
+                break;
+            }
+        }
+
+        // Set the DOM storage status.
+        switch (domainRecord.field(DomainsDatabaseHelper::DOM_STORAGE).value().toInt())
+        {
+            // Set the default DOM storage status.
+            case (DomainsDatabaseHelper::SYSTEM_DEFAULT):
+            {
+                webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::domStorageEnabled());
+
+                break;
+            }
+
+            // Disable DOM storage.
             case (DomainsDatabaseHelper::DISABLED):
             {
-                // Disable local storage.
                 webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, false);
 
                 break;
             }
 
+            // Enable DOM storage.
             case (DomainsDatabaseHelper::ENABLED):
             {
-                // Enable local storage.
                 webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, true);
 
                 break;
@@ -214,10 +317,13 @@ void BrowserView::applyDomainSettings(const QString &hostname, const bool reload
     else  // The hostname does not have domain settings.
     {
         // Set the JavaScript status.
-        webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScript());
+        webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, Settings::javaScriptEnabled());
+
+        // Set the local storage status.
+        currentPrivacyWebEnginePointer->localStorageEnabled = Settings::localStorageEnabled();
 
-        // Set local storage.
-        webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::localStorage());
+        // Set DOM storage.
+        webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, Settings::domStorageEnabled());
 
         // Set the user agent.
         webEngineProfilePointer->setHttpUserAgent(UserAgentHelper::getUserAgentFromDatabaseName(Settings::userAgent()));
@@ -234,7 +340,8 @@ void BrowserView::applyDomainSettings(const QString &hostname, const bool reload
 
     // Emit the update actions signals.
     emit updateJavaScriptAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
-    emit updateLocalStorageAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
+    emit updateLocalStorageAction(currentPrivacyWebEnginePointer->localStorageEnabled);
+    emit updateDomStorageAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
     emit updateUserAgentActions(webEngineProfilePointer->httpUserAgent());
     emit updateZoomFactorAction(webEngineViewPointer->zoomFactor());
 
@@ -288,6 +395,30 @@ void BrowserView::back() const
     webEngineViewPointer->back();
 }
 
+void BrowserView::cookieAdded(const QNetworkCookie &cookie) const
+{
+    // Add the cookie to the cookie list.
+    emit addCookie(cookie);
+}
+
+void BrowserView::cookieRemoved(const QNetworkCookie &cookie) const
+{
+    // Remove the cookie from the cookie list.
+    emit removeCookie(cookie);
+}
+
+void BrowserView::deleteAllCookies() const
+{
+    // Delete all the cookies.
+    webEngineCookieStorePointer->deleteAllCookies();
+}
+
+void BrowserView::deleteCookieFromStore(const QNetworkCookie &cookie) const
+{
+    // Delete the cookie.
+    webEngineCookieStorePointer->deleteCookie(cookie);
+}
+
 void BrowserView::forward() const
 {
     // Go forward.
@@ -366,6 +497,32 @@ void BrowserView::loadUrlFromLineEdit(QString url) const
     }
 }
 
+void BrowserView::mouseBack() const
+{
+    // Go back if possible.
+    if (webEngineHistoryPointer->canGoBack())
+    {
+        // Clear the URL line edit focus.
+        emit clearUrlLineEditFocus();
+
+        // Go back.
+        webEngineViewPointer->back();
+    }
+}
+
+void BrowserView::mouseForward() const
+{
+    // Go forward if possible.
+    if (webEngineHistoryPointer->canGoForward())
+    {
+        // Clear the URL line edit focus.
+        emit clearUrlLineEditFocus();
+
+        // Go forward.
+        webEngineViewPointer->forward();
+    }
+}
+
 void BrowserView::pageLinkHovered(const QString &linkUrl) const
 {
     // Emit a signal so that the browser window can update the status bar.
@@ -378,25 +535,37 @@ void BrowserView::refresh() const
     webEngineViewPointer->reload();
 }
 
+void BrowserView::toggleDomStorage() const
+{
+    // Toggle DOM storage.
+    webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, !webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
+
+    // Update the DOM storage action.
+    emit updateDomStorageAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
+
+    // Reload the website.
+    webEngineViewPointer->reload();
+}
+
 void BrowserView::toggleJavaScript() const
 {
     // Toggle JavaScript.
     webEngineSettingsPointer->setAttribute(QWebEngineSettings::JavascriptEnabled, !webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
 
-    // Update the JavaScript icon.
+    // Update the JavaScript action.
     emit updateJavaScriptAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::JavascriptEnabled));
 
     // Reload the website.
     webEngineViewPointer->reload();
 }
 
-void BrowserView::toggleLocalStorage() const
+void BrowserView::toggleLocalStorage()
 {
-    // Toggle local storage.
-    webEngineSettingsPointer->setAttribute(QWebEngineSettings::LocalStorageEnabled, !webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
+    // Toggle local storeage.
+    currentPrivacyWebEnginePointer->localStorageEnabled = !currentPrivacyWebEnginePointer->localStorageEnabled;
 
-    // Update the local storage icon.
-    emit updateLocalStorageAction(webEngineSettingsPointer->testAttribute(QWebEngineSettings::LocalStorageEnabled));
+    // Update the local storage action.
+    emit updateLocalStorageAction(currentPrivacyWebEnginePointer->localStorageEnabled);
 
     // Reload the website.
     webEngineViewPointer->reload();