src/eric7/Preferences/ConfigurationPages/WebBrowserPage.py

# -*- coding: utf-8 -*-

# Copyright (c) 2016 - 2024 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing the  Web Browser configuration page.
"""

from PyQt6.QtCore import QLocale, pyqtSlot

from eric7 import Preferences
from eric7.EricGui import EricPixmapCache
from eric7.SystemUtilities.QtUtilities import qVersionTuple

from .ConfigurationPageBase import ConfigurationPageBase
from .Ui_WebBrowserPage import Ui_WebBrowserPage


class WebBrowserPage(ConfigurationPageBase, Ui_WebBrowserPage):
    """
    Class implementing the  Web Browser configuration page.
    """

    def __init__(self, configDialog):
        """
        Constructor

        @param configDialog reference to the configuration dialog
        @type ConfigurationDialog
        """
        super().__init__()
        self.setupUi(self)
        self.setObjectName("WebBrowserPage")

        self.__configDlg = configDialog
        mw = configDialog.parent().parent()
        if hasattr(mw, "helpWindow") and mw.helpWindow is not None:
            # IDE
            self.__browserWindow = mw.helpWindow
        elif hasattr(mw, "currentBrowser"):
            # Web Browser
            self.__browserWindow = mw
        else:
            self.__browserWindow = None
        self.setCurrentPageButton.setEnabled(self.__browserWindow is not None)
        self.imageSearchGroup.setEnabled(self.__browserWindow is not None)

        defaultSchemes = ["file://", "http://", "https://"]
        self.defaultSchemeCombo.addItems(defaultSchemes)

        # set initial values
        self.singleHelpWindowCheckBox.setChecked(
            Preferences.getWebBrowser("SingleWebBrowserWindow")
        )
        self.saveGeometryCheckBox.setChecked(Preferences.getWebBrowser("SaveGeometry"))
        self.webSuggestionsCheckBox.setChecked(
            Preferences.getWebBrowser("WebSearchSuggestions")
        )
        self.showTabPreviews.setChecked(Preferences.getWebBrowser("ShowPreview"))
        self.errorPageCheckBox.setChecked(Preferences.getWebBrowser("ErrorPageEnabled"))
        self.scrollingCheckBox.setChecked(
            Preferences.getWebBrowser("ScrollAnimatorEnabled")
        )
        self.fullscreenCheckBox.setChecked(
            Preferences.getWebBrowser("FullScreenSupportEnabled")
        )
        self.screenCaptureCheckBox.setChecked(
            Preferences.getWebBrowser("ScreenCaptureEnabled")
        )
        self.webGLCheckBox.setChecked(Preferences.getWebBrowser("WebGLEnabled"))
        self.accelerated2dCanvasCheckBox.setChecked(
            Preferences.getWebBrowser("Accelerated2dCanvasEnabled")
        )
        self.autoloadIconsCheckBox.setChecked(
            Preferences.getWebBrowser("AutoLoadIconsForPage")
        )
        self.autoplayMediaCheckBox.setChecked(
            Preferences.getWebBrowser("PlaybackRequiresUserGesture")
        )
        self.webRtcPublicOnlyCheckBox.setChecked(
            Preferences.getWebBrowser("WebRTCPublicInterfacesOnly")
        )
        self.dnsPrefetchCheckBox.setChecked(
            Preferences.getWebBrowser("DnsPrefetchEnabled")
        )

        self.javaScriptGroup.setChecked(Preferences.getWebBrowser("JavaScriptEnabled"))
        self.jsOpenWindowsCheckBox.setChecked(
            Preferences.getWebBrowser("JavaScriptCanOpenWindows")
        )
        self.jsActivateWindowsCheckBox.setChecked(
            Preferences.getWebBrowser("AllowWindowActivationFromJavaScript")
        )
        self.jsClipboardCheckBox.setChecked(
            Preferences.getWebBrowser("JavaScriptCanAccessClipboard")
        )
        self.jsPasteCheckBox.setChecked(Preferences.getWebBrowser("JavaScriptCanPaste"))
        self.doNotTrackCheckBox.setChecked(Preferences.getWebBrowser("DoNotTrack"))
        self.refererSendComboBox.setCurrentIndex(
            Preferences.getWebBrowser("RefererSendReferer")
        )
        self.refererDefaultPolicyCcomboBox.setCurrentIndex(
            Preferences.getWebBrowser("RefererDefaultPolicy")
        )
        self.refererTrimmingPolicyComboBox.setCurrentIndex(
            Preferences.getWebBrowser("RefererTrimmingPolicy")
        )

        self.pluginsGroup.setChecked(Preferences.getWebBrowser("PluginsEnabled"))
        self.pdfViewerCheckBox.setChecked(Preferences.getWebBrowser("PdfViewerEnabled"))

        self.diskCacheCheckBox.setChecked(Preferences.getWebBrowser("DiskCacheEnabled"))
        self.cacheSizeSpinBox.setValue(Preferences.getWebBrowser("DiskCacheSize"))

        self.startupCombo.setCurrentIndex(Preferences.getWebBrowser("StartupBehavior"))
        self.newTabCombo.setCurrentIndex(Preferences.getWebBrowser("NewTabBehavior"))
        self.homePageEdit.setText(Preferences.getWebBrowser("HomePage"))
        self.loadTabOnActivationCheckBox.setChecked(
            Preferences.getWebBrowser("LoadTabOnActivation")
        )

        self.saveSessionCheckBox.setChecked(
            Preferences.getWebBrowser("SessionAutoSave")
        )
        self.sessionTimerSpinBox.setValue(
            Preferences.getWebBrowser("SessionAutoSaveInterval")
        )

        self.defaultSchemeCombo.setCurrentIndex(
            self.defaultSchemeCombo.findText(Preferences.getWebBrowser("DefaultScheme"))
        )

        historyLimit = Preferences.getWebBrowser("HistoryLimit")
        idx = 0
        if historyLimit == 1:
            idx = 0
        elif historyLimit == 7:
            idx = 1
        elif historyLimit == 14:
            idx = 2
        elif historyLimit == 30:
            idx = 3
        elif historyLimit == 365:
            idx = 4
        elif historyLimit == -1:
            idx = 5
        elif historyLimit == -2:
            idx = 6
        else:
            idx = 5
        self.expireHistory.setCurrentIndex(idx)

        for language in QLocale.Language:
            if language == QLocale.Language.C:
                continue

            countries = [
                loc.country()
                for loc in QLocale.matchingLocales(
                    language, QLocale.Script.AnyScript, QLocale.Country.AnyCountry
                )
            ]
            if len(countries) > 0:
                self.languageCombo.addItem(QLocale.languageToString(language), language)
        self.languageCombo.model().sort(0)
        self.languageCombo.insertSeparator(0)
        self.languageCombo.insertItem(
            0, QLocale.languageToString(QLocale.Language.AnyLanguage), 0
        )
        index = self.languageCombo.findData(Preferences.getWebBrowser("SearchLanguage"))
        if index > -1:
            self.languageCombo.setCurrentIndex(index)

        if self.__browserWindow:
            for (
                engineName
            ) in self.__browserWindow.imageSearchEngine().searchEngineNames():
                self.imageSearchComboBox.addItem(
                    EricPixmapCache.getIcon("{0}".format(engineName.lower())),
                    engineName,
                )
            index = self.imageSearchComboBox.findText(
                Preferences.getWebBrowser("ImageSearchEngine")
            )
            if index > -1:
                self.imageSearchComboBox.setCurrentIndex(index)

        self.spatialCheckBox.setChecked(
            Preferences.getWebBrowser("SpatialNavigationEnabled")
        )
        self.linksInFocusChainCheckBox.setChecked(
            Preferences.getWebBrowser("LinksIncludedInFocusChain")
        )
        self.focusOnNavigationCheckBox.setChecked(
            Preferences.getWebBrowser("FocusOnNavigationEnabled")
        )

        self.xssAuditingCheckBox.setChecked(
            Preferences.getWebBrowser("XSSAuditingEnabled")
        )
        self.insecureContentsCheckBox.setChecked(
            Preferences.getWebBrowser("AllowRunningInsecureContent")
        )
        self.insecureGeolocationCheckBox.setChecked(
            Preferences.getWebBrowser("AllowGeolocationOnInsecureOrigins")
        )

        self.printBackgroundCheckBox.setChecked(
            Preferences.getWebBrowser("PrintElementBackgrounds")
        )

        self.autoScrollGroupBox.setChecked(
            Preferences.getWebBrowser("AutoScrollEnabled")
        )
        self.autoScrollDividerSpinBox.setValue(
            Preferences.getWebBrowser("AutoScrollDivider")
        )

        self.protocolHandlerComboBox.setCurrentIndex(
            Preferences.getWebBrowser("AcceptProtocolHandlerRequest")
        )
        self.requestQuotaComboBox.setCurrentIndex(
            Preferences.getWebBrowser("AcceptQuotaRequest")
        )
        self.fileSystemAccessComboBox.setCurrentIndex(
            Preferences.getWebBrowser("AcceptFileSystemAccessRequest")
        )

        if qVersionTuple() >= (6, 4, 0):
            self.navigateOnDropCheckBox.setChecked(
                Preferences.getWebBrowser("NavigateOnDropEnabled")
            )
        else:
            self.navigateOnDropCheckBox.setEnabled(False)

        if qVersionTuple() >= (6, 5, 0):
            self.pushServiceCheckBox.setChecked(
                Preferences.getWebBrowser("PushServiceEnabled")
            )
        else:
            self.pushServiceCheckBox.setEnabled(False)

        if qVersionTuple() >= (6, 6, 0):
            self.readingFromCanvasCheckBox.setChecked(
                Preferences.getWebBrowser("ReadingFromCanvasEnabled")
            )
        else:
            self.readingFromCanvasCheckBox.setEnabled(False)

        if qVersionTuple() >= (6, 7, 0):
            self.forceDarkModeCheckBox.setChecked(
                Preferences.getWebBrowser("ForceDarkMode")
            )
        else:
            self.forceDarkModeCheckBox.setEnabled(False)

    def save(self):
        """
        Public slot to save the Help Viewers configuration.
        """
        Preferences.setWebBrowser(
            "SingleWebBrowserWindow", self.singleHelpWindowCheckBox.isChecked()
        )
        Preferences.setWebBrowser("SaveGeometry", self.saveGeometryCheckBox.isChecked())
        Preferences.setWebBrowser(
            "WebSearchSuggestions", self.webSuggestionsCheckBox.isChecked()
        )
        Preferences.setWebBrowser("ShowPreview", self.showTabPreviews.isChecked())
        Preferences.setWebBrowser(
            "ErrorPageEnabled", self.errorPageCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "ScrollAnimatorEnabled", self.scrollingCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "FullScreenSupportEnabled", self.fullscreenCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "ScreenCaptureEnabled", self.screenCaptureCheckBox.isChecked()
        )
        Preferences.setWebBrowser("WebGLEnabled", self.webGLCheckBox.isChecked())
        Preferences.setWebBrowser(
            "Accelerated2dCanvasEnabled", self.accelerated2dCanvasCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "AutoLoadIconsForPage", self.autoloadIconsCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "PlaybackRequiresUserGesture", self.autoplayMediaCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "WebRTCPublicInterfacesOnly", self.webRtcPublicOnlyCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "DnsPrefetchEnabled", self.dnsPrefetchCheckBox.isChecked()
        )

        Preferences.setWebBrowser("JavaScriptEnabled", self.javaScriptGroup.isChecked())
        Preferences.setWebBrowser(
            "JavaScriptCanOpenWindows", self.jsOpenWindowsCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "AllowWindowActivationFromJavaScript",
            self.jsActivateWindowsCheckBox.isChecked(),
        )
        Preferences.setWebBrowser(
            "JavaScriptCanAccessClipboard", self.jsClipboardCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "JavaScriptCanPaste", self.jsPasteCheckBox.isChecked()
        )

        Preferences.setWebBrowser("PluginsEnabled", self.pluginsGroup.isChecked())
        if self.pdfViewerCheckBox.isEnabled():
            Preferences.setWebBrowser(
                "PdfViewerEnabled", self.pdfViewerCheckBox.isChecked()
            )

        Preferences.setWebBrowser("DoNotTrack", self.doNotTrackCheckBox.isChecked())
        Preferences.setWebBrowser(
            "RefererSendReferer", self.refererSendComboBox.currentIndex()
        )
        Preferences.setWebBrowser(
            "RefererDefaultPolicy", self.refererDefaultPolicyCcomboBox.currentIndex()
        )
        Preferences.setWebBrowser(
            "RefererTrimmingPolicy", self.refererTrimmingPolicyComboBox.currentIndex()
        )

        Preferences.setWebBrowser(
            "DiskCacheEnabled", self.diskCacheCheckBox.isChecked()
        )
        Preferences.setWebBrowser("DiskCacheSize", self.cacheSizeSpinBox.value())

        Preferences.setWebBrowser("StartupBehavior", self.startupCombo.currentIndex())
        Preferences.setWebBrowser("NewTabBehavior", self.newTabCombo.currentIndex())
        Preferences.setWebBrowser("HomePage", self.homePageEdit.text())
        Preferences.setWebBrowser(
            "LoadTabOnActivation", self.loadTabOnActivationCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "SessionAutoSave", self.saveSessionCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "SessionAutoSaveInterval", self.sessionTimerSpinBox.value()
        )

        Preferences.setWebBrowser(
            "DefaultScheme", self.defaultSchemeCombo.currentText()
        )

        idx = self.expireHistory.currentIndex()
        if idx == 0:
            historyLimit = 1
        elif idx == 1:
            historyLimit = 7
        elif idx == 2:
            historyLimit = 14
        elif idx == 3:
            historyLimit = 30
        elif idx == 4:
            historyLimit = 365
        elif idx == 5:
            historyLimit = -1
        elif idx == 6:
            historyLimit = -2
        Preferences.setWebBrowser("HistoryLimit", historyLimit)

        languageIndex = self.languageCombo.currentIndex()
        language = (
            self.languageCombo.itemData(languageIndex)
            if languageIndex > -1
            else
            # fall back to system default
            QLocale.system().language()
        )
        Preferences.setWebBrowser("SearchLanguage", language)

        Preferences.setWebBrowser(
            "ImageSearchEngine", self.imageSearchComboBox.currentText()
        )

        Preferences.setWebBrowser(
            "SpatialNavigationEnabled", self.spatialCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "LinksIncludedInFocusChain", self.linksInFocusChainCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "FocusOnNavigationEnabled", self.focusOnNavigationCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "XSSAuditingEnabled", self.xssAuditingCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "AllowRunningInsecureContent", self.insecureContentsCheckBox.isChecked()
        )
        Preferences.setWebBrowser(
            "AllowGeolocationOnInsecureOrigins",
            self.insecureGeolocationCheckBox.isChecked(),
        )

        Preferences.setWebBrowser(
            "PrintElementBackgrounds", self.printBackgroundCheckBox.isChecked()
        )

        Preferences.setWebBrowser(
            "AutoScrollEnabled", self.autoScrollGroupBox.isChecked()
        )
        Preferences.setWebBrowser(
            "AutoScrollDivider", self.autoScrollDividerSpinBox.value()
        )

        Preferences.setWebBrowser(
            "AcceptProtocolHandlerRequest", self.protocolHandlerComboBox.currentIndex()
        )
        Preferences.setWebBrowser(
            "AcceptQuotaRequest", self.requestQuotaComboBox.currentIndex()
        )
        Preferences.setWebBrowser(
            "AcceptFileSystemAccessRequest",
            self.fileSystemAccessComboBox.currentIndex(),
        )

        if self.navigateOnDropCheckBox.isEnabled():
            Preferences.setWebBrowser(
                "NavigateOnDropEnabled", self.navigateOnDropCheckBox.isChecked()
            )

        if self.pushServiceCheckBox.isEnabled():
            Preferences.setWebBrowser(
                "PushServiceEnabled", self.pushServiceCheckBox.isChecked()
            )

        if self.readingFromCanvasCheckBox.isEnabled():
            Preferences.setWebBrowser(
                "ReadingFromCanvasEnabled", self.readingFromCanvasCheckBox.isChecked()
            )

        if self.forceDarkModeCheckBox.isEnabled():
            Preferences.setWebBrowser(
                "ForceDarkMode", self.forceDarkModeCheckBox.isChecked()
            )

    @pyqtSlot()
    def on_setCurrentPageButton_clicked(self):
        """
        Private slot to set the current page as the home page.
        """
        url = self.__browserWindow.currentBrowser().url()
        self.homePageEdit.setText(bytes(url.toEncoded()).decode())

    @pyqtSlot()
    def on_defaultHomeButton_clicked(self):
        """
        Private slot to set the default home page.
        """
        self.homePageEdit.setText(Preferences.Prefs.helpDefaults["HomePage"])

    @pyqtSlot()
    def on_setSpeedDialPageButton_clicked(self):
        """
        Private slot documentation goes here.
        """
        self.homePageEdit.setText("eric:speeddial")

    @pyqtSlot(int)
    def on_startupCombo_currentIndexChanged(self, index):
        """
        Private slot to enable elements depending on the selected startup
        entry.

        @param index index of the selected entry
        @type int
        """
        # set state of the session related items
        self.loadTabOnActivationCheckBox.setEnabled(index in [3, 4])

    @pyqtSlot()
    def on_refererWhitelistButton_clicked(self):
        """
        Private slot to edit the referer whitelist.
        """
        from eric7.WebBrowser.Network.SendRefererWhitelistDialog import (
            SendRefererWhitelistDialog,
        )

        SendRefererWhitelistDialog(parent=self).exec()


def create(dlg):
    """
    Module function to create the configuration page.

    @param dlg reference to the configuration dialog
    @type ConfigurationDialog
    @return reference to the instantiated page
    @rtype ConfigurationPageBase
    """
    page = WebBrowserPage(dlg)
    return page