WebBrowser/FeaturePermissions/FeaturePermissionManager.py

branch
QtWebEngine
changeset 4742
f9d1090f6ab9
parent 4631
5c1a96925da4
child 4788
7076adec8ddd
equal deleted inserted replaced
4741:f9e1adc69076 4742:f9d1090f6ab9
1 # -*- coding: utf-8 -*-
2
3 # Copyright (c) 2015 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
4 #
5
6 """
7 Module implementing the feature permission manager object.
8 """
9
10 from __future__ import unicode_literals
11
12 from PyQt5.QtCore import QObject
13 from PyQt5.QtWidgets import QDialog
14 from PyQt5.QtWebEngineWidgets import QWebEnginePage
15
16 import Globals
17 import Preferences
18
19
20 class FeaturePermissionManager(QObject):
21 """
22 Class implementing the feature permission manager object.
23 """
24 SettingsKeyFormat = "WebBrowser/FeaturePermissions/{0}"
25
26 def __init__(self, parent=None):
27 """
28 Constructor
29
30 @param parent reference to the parent object
31 @type QObject
32 """
33 super(FeaturePermissionManager, self).__init__(parent)
34
35 self.__featurePermissions = {
36 # TODO: Qt 5.6
37 ## QWebEnginePage.Notifications: {
38 ## QWebEnginePage.PermissionGrantedByUser: [],
39 ## QWebEnginePage.PermissionDeniedByUser: [],
40 ## },
41 QWebEnginePage.Geolocation: {
42 QWebEnginePage.PermissionGrantedByUser: [],
43 QWebEnginePage.PermissionDeniedByUser: [],
44 },
45 QWebEnginePage.MediaAudioCapture: {
46 QWebEnginePage.PermissionGrantedByUser: [],
47 QWebEnginePage.PermissionDeniedByUser: [],
48 },
49 QWebEnginePage.MediaVideoCapture: {
50 QWebEnginePage.PermissionGrantedByUser: [],
51 QWebEnginePage.PermissionDeniedByUser: [],
52 },
53 QWebEnginePage.MediaAudioVideoCapture: {
54 QWebEnginePage.PermissionGrantedByUser: [],
55 QWebEnginePage.PermissionDeniedByUser: [],
56 },
57 }
58 self.__featurePermissionsKeys = {
59 # TODO: Qt 5.6
60 ## (QWebEnginePage.Notifications,
61 ## QWebEnginePage.PermissionGrantedByUser):
62 ## "NotificationsGranted",
63 ## (QWebEnginePage.Notifications,
64 ## QWebEnginePage.PermissionDeniedByUser):
65 ## "NotificationsDenied",
66 (QWebEnginePage.Geolocation,
67 QWebEnginePage.PermissionGrantedByUser):
68 "GeolocationGranted",
69 (QWebEnginePage.Geolocation,
70 QWebEnginePage.PermissionDeniedByUser):
71 "GeolocationDenied",
72 (QWebEnginePage.MediaAudioCapture,
73 QWebEnginePage.PermissionGrantedByUser):
74 "MediaAudioCaptureGranted",
75 (QWebEnginePage.MediaAudioCapture,
76 QWebEnginePage.PermissionDeniedByUser):
77 "MediaAudioCaptureDenied",
78 (QWebEnginePage.MediaVideoCapture,
79 QWebEnginePage.PermissionGrantedByUser):
80 "MediaVideoCaptureGranted",
81 (QWebEnginePage.MediaVideoCapture,
82 QWebEnginePage.PermissionDeniedByUser):
83 "MediaVideoCaptureDenied",
84 (QWebEnginePage.MediaAudioVideoCapture,
85 QWebEnginePage.PermissionGrantedByUser):
86 "MediaAudioVideoCaptureGranted",
87 (QWebEnginePage.MediaAudioVideoCapture,
88 QWebEnginePage.PermissionDeniedByUser):
89 "MediaAudioVideoCaptureDenied",
90 }
91
92 self.__loaded = False
93
94 def requestFeaturePermission(self, page, origin, feature):
95 """
96 Public method to request a feature permission.
97
98 @param page reference to the requesting web page
99 @type QWebEnginePage
100 @param origin security origin requesting the feature
101 @type QUrl
102 @param feature requested feature
103 @type QWebEnginePage.Feature
104 """
105 if origin is None or origin.isEmpty():
106 return
107
108 if not self.__loaded:
109 self.__loadSettings()
110
111 host = origin.host()
112
113 if feature in self.__featurePermissions:
114 for permission in self.__featurePermissions[feature]:
115 if host in self.__featurePermissions[feature][permission]:
116 page.setFeaturePermission(origin, feature, permission)
117 return
118
119 from .FeaturePermissionBar import FeaturePermissionBar
120 bar = FeaturePermissionBar(page, origin, feature, self)
121 bar.show()
122
123 def rememberFeaturePermission(self, host, feature, permission):
124 """
125 Public method to remember a user decision for a feature permission.
126
127 @param host host name to remember the decision for
128 @type str
129 @param feature feature to be remembered
130 @type QWebEnginePage.Feature
131 @param permission feature permission to be remembered
132 @type QWebEnginePage.PermissionPolicy
133 """
134 if feature in self.__featurePermissions:
135 if host not in self.__featurePermissions[feature][permission]:
136 self.__featurePermissions[feature][permission].append(host)
137 self.__saveSettings()
138
139 def __loadSettings(self):
140 """
141 Private method to load the remembered feature permissions.
142 """
143 if self.__loaded:
144 # no reloading allowed
145 return
146
147 for (feature, permission), key in \
148 self.__featurePermissionsKeys.items():
149 self.__featurePermissions[feature][permission] = \
150 Globals.toList(Preferences.Prefs.settings.value(
151 FeaturePermissionManager.SettingsKeyFormat.format(key),
152 []
153 ))
154
155 self.__loaded = True
156
157 def __saveSettings(self):
158 """
159 Private method to save the remembered feature permissions.
160 """
161 if not self.__loaded:
162 return
163
164 import WebBrowser.WebBrowserWindow
165 if WebBrowser.WebBrowserWindow.WebBrowserWindow\
166 .mainWindow().getWindow().isPrivate():
167 return
168
169 for (feature, permission), key in \
170 self.__featurePermissionsKeys.items():
171 Preferences.Prefs.settings.setValue(
172 FeaturePermissionManager.SettingsKeyFormat.format(key),
173 self.__featurePermissions[feature][permission])
174
175 def showFeaturePermissionsDialog(self):
176 """
177 Public method to show a dialog to manage the remembered feature
178 permissions.
179 """
180 if not self.__loaded:
181 self.__loadSettings()
182
183 from .FeaturePermissionsDialog import FeaturePermissionsDialog
184 dlg = FeaturePermissionsDialog(self.__featurePermissions)
185 if dlg.exec_() == QDialog.Accepted:
186 newFeaturePermissions = dlg.getData()
187 self.__featurePermissions = newFeaturePermissions
188 self.__saveSettings()

eric ide

mercurial