WebBrowser/FeaturePermissions/FeaturePermissionManager.py

branch
QtWebEngine
changeset 4742
f9d1090f6ab9
parent 4631
5c1a96925da4
child 4788
7076adec8ddd
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/WebBrowser/FeaturePermissions/FeaturePermissionManager.py	Sun Feb 14 19:34:05 2016 +0100
@@ -0,0 +1,188 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2015 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing the feature permission manager object.
+"""
+
+from __future__ import unicode_literals
+
+from PyQt5.QtCore import QObject
+from PyQt5.QtWidgets import QDialog
+from PyQt5.QtWebEngineWidgets import QWebEnginePage
+
+import Globals
+import Preferences
+
+
+class FeaturePermissionManager(QObject):
+    """
+    Class implementing the feature permission manager object.
+    """
+    SettingsKeyFormat = "WebBrowser/FeaturePermissions/{0}"
+    
+    def __init__(self, parent=None):
+        """
+        Constructor
+        
+        @param parent reference to the parent object
+        @type QObject
+        """
+        super(FeaturePermissionManager, self).__init__(parent)
+        
+        self.__featurePermissions = {
+            # TODO: Qt 5.6
+##            QWebEnginePage.Notifications: {
+##                QWebEnginePage.PermissionGrantedByUser: [],
+##                QWebEnginePage.PermissionDeniedByUser: [],
+##            },
+            QWebEnginePage.Geolocation: {
+                QWebEnginePage.PermissionGrantedByUser: [],
+                QWebEnginePage.PermissionDeniedByUser: [],
+            },
+            QWebEnginePage.MediaAudioCapture: {
+                QWebEnginePage.PermissionGrantedByUser: [],
+                QWebEnginePage.PermissionDeniedByUser: [],
+            },
+            QWebEnginePage.MediaVideoCapture: {
+                QWebEnginePage.PermissionGrantedByUser: [],
+                QWebEnginePage.PermissionDeniedByUser: [],
+            },
+            QWebEnginePage.MediaAudioVideoCapture: {
+                QWebEnginePage.PermissionGrantedByUser: [],
+                QWebEnginePage.PermissionDeniedByUser: [],
+            },
+        }
+        self.__featurePermissionsKeys = {
+            # TODO: Qt 5.6
+##            (QWebEnginePage.Notifications,
+##             QWebEnginePage.PermissionGrantedByUser):
+##            "NotificationsGranted",
+##            (QWebEnginePage.Notifications,
+##             QWebEnginePage.PermissionDeniedByUser):
+##            "NotificationsDenied",
+            (QWebEnginePage.Geolocation,
+             QWebEnginePage.PermissionGrantedByUser):
+            "GeolocationGranted",
+            (QWebEnginePage.Geolocation,
+             QWebEnginePage.PermissionDeniedByUser):
+            "GeolocationDenied",
+            (QWebEnginePage.MediaAudioCapture,
+             QWebEnginePage.PermissionGrantedByUser):
+            "MediaAudioCaptureGranted",
+            (QWebEnginePage.MediaAudioCapture,
+             QWebEnginePage.PermissionDeniedByUser):
+            "MediaAudioCaptureDenied",
+            (QWebEnginePage.MediaVideoCapture,
+             QWebEnginePage.PermissionGrantedByUser):
+            "MediaVideoCaptureGranted",
+            (QWebEnginePage.MediaVideoCapture,
+             QWebEnginePage.PermissionDeniedByUser):
+            "MediaVideoCaptureDenied",
+            (QWebEnginePage.MediaAudioVideoCapture,
+             QWebEnginePage.PermissionGrantedByUser):
+            "MediaAudioVideoCaptureGranted",
+            (QWebEnginePage.MediaAudioVideoCapture,
+             QWebEnginePage.PermissionDeniedByUser):
+            "MediaAudioVideoCaptureDenied",
+        }
+        
+        self.__loaded = False
+
+    def requestFeaturePermission(self, page, origin, feature):
+        """
+        Public method to request a feature permission.
+        
+        @param page reference to the requesting web page
+        @type QWebEnginePage
+        @param origin security origin requesting the feature
+        @type QUrl
+        @param feature requested feature
+        @type QWebEnginePage.Feature
+        """
+        if origin is None or origin.isEmpty():
+            return
+        
+        if not self.__loaded:
+            self.__loadSettings()
+        
+        host = origin.host()
+        
+        if feature in self.__featurePermissions:
+            for permission in self.__featurePermissions[feature]:
+                if host in self.__featurePermissions[feature][permission]:
+                    page.setFeaturePermission(origin, feature, permission)
+                    return
+        
+        from .FeaturePermissionBar import FeaturePermissionBar
+        bar = FeaturePermissionBar(page, origin, feature, self)
+        bar.show()
+    
+    def rememberFeaturePermission(self, host, feature, permission):
+        """
+        Public method to remember a user decision for a feature permission.
+        
+        @param host host name to remember the decision for
+        @type str
+        @param feature feature to be remembered
+        @type QWebEnginePage.Feature
+        @param permission feature permission to be remembered
+        @type QWebEnginePage.PermissionPolicy
+        """
+        if feature in self.__featurePermissions:
+            if host not in self.__featurePermissions[feature][permission]:
+                self.__featurePermissions[feature][permission].append(host)
+                self.__saveSettings()
+    
+    def __loadSettings(self):
+        """
+        Private method to load the remembered feature permissions.
+        """
+        if self.__loaded:
+            # no reloading allowed
+            return
+        
+        for (feature, permission), key in \
+                self.__featurePermissionsKeys.items():
+            self.__featurePermissions[feature][permission] = \
+                Globals.toList(Preferences.Prefs.settings.value(
+                    FeaturePermissionManager.SettingsKeyFormat.format(key),
+                    []
+                ))
+        
+        self.__loaded = True
+    
+    def __saveSettings(self):
+        """
+        Private method to save the remembered feature permissions.
+        """
+        if not self.__loaded:
+            return
+        
+        import WebBrowser.WebBrowserWindow
+        if WebBrowser.WebBrowserWindow.WebBrowserWindow\
+                .mainWindow().getWindow().isPrivate():
+            return
+        
+        for (feature, permission), key in \
+                self.__featurePermissionsKeys.items():
+            Preferences.Prefs.settings.setValue(
+                FeaturePermissionManager.SettingsKeyFormat.format(key),
+                self.__featurePermissions[feature][permission])
+    
+    def showFeaturePermissionsDialog(self):
+        """
+        Public method to show a dialog to manage the remembered feature
+        permissions.
+        """
+        if not self.__loaded:
+            self.__loadSettings()
+        
+        from .FeaturePermissionsDialog import FeaturePermissionsDialog
+        dlg = FeaturePermissionsDialog(self.__featurePermissions)
+        if dlg.exec_() == QDialog.Accepted:
+            newFeaturePermissions = dlg.getData()
+            self.__featurePermissions = newFeaturePermissions
+            self.__saveSettings()

eric ide

mercurial