src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkUrlInterceptor.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Network.NetworkUrlInterceptor</h1> 9 <h1>eric7.WebBrowser.Network.NetworkUrlInterceptor</h1>
10
11 <p> 10 <p>
12 Module implementing a class to handle URL requests before they get processed 11 Module implementing a class to handle URL requests before they get processed
13 by QtWebEngine. 12 by QtWebEngine.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16 16 <table>
17 <table> 17 <tr><td>None</td></tr>
18 <tr><td>None</td></tr> 18 </table>
19 </table> 19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#NetworkUrlInterceptor">NetworkUrlInterceptor</a></td> 23 <td><a href="#NetworkUrlInterceptor">NetworkUrlInterceptor</a></td>
26 <td>Class implementing an URL request handler.</td> 24 <td>Class implementing an URL request handler.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30 29 <table>
31 <table> 30 <tr><td>None</td></tr>
32 <tr><td>None</td></tr> 31 </table>
33 </table> 32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="NetworkUrlInterceptor" ID="NetworkUrlInterceptor"></a> 35 <a NAME="NetworkUrlInterceptor" ID="NetworkUrlInterceptor"></a>
37 <h2>NetworkUrlInterceptor</h2> 36 <h2>NetworkUrlInterceptor</h2>
38
39 <p> 37 <p>
40 Class implementing an URL request handler. 38 Class implementing an URL request handler.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QWebEngineUrlRequestInterceptor 42 QWebEngineUrlRequestInterceptor
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#NetworkUrlInterceptor.__init__">NetworkUrlInterceptor</a></td> 56 <td><a href="#NetworkUrlInterceptor.__init__">NetworkUrlInterceptor</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
98 <tr> 95 <tr>
99 <td><a href="#NetworkUrlInterceptor.removeUrlInterceptor">removeUrlInterceptor</a></td> 96 <td><a href="#NetworkUrlInterceptor.removeUrlInterceptor">removeUrlInterceptor</a></td>
100 <td>Public method to remove an URL interceptor.</td> 97 <td>Public method to remove an URL interceptor.</td>
101 </tr> 98 </tr>
102 </table> 99 </table>
100
103 <h3>Static Methods</h3> 101 <h3>Static Methods</h3>
104 102 <table>
105 <table> 103 <tr><td>None</td></tr>
106 <tr><td>None</td></tr> 104 </table>
107 </table> 105
108 106
109 <a NAME="NetworkUrlInterceptor.__init__" ID="NetworkUrlInterceptor.__init__"></a> 107 <a NAME="NetworkUrlInterceptor.__init__" ID="NetworkUrlInterceptor.__init__"></a>
110 <h4>NetworkUrlInterceptor (Constructor)</h4> 108 <h4>NetworkUrlInterceptor (Constructor)</h4>
111 <b>NetworkUrlInterceptor</b>(<i>parent=None</i>) 109 <b>NetworkUrlInterceptor</b>(<i>parent=None</i>)
112
113 <p> 110 <p>
114 Constructor 111 Constructor
115 </p> 112 </p>
113
116 <dl> 114 <dl>
117 115
118 <dt><i>parent</i> (QObject)</dt> 116 <dt><i>parent</i> (QObject)</dt>
119 <dd> 117 <dd>
120 reference to the parent object 118 reference to the parent object
121 </dd> 119 </dd>
122 </dl> 120 </dl>
123 <a NAME="NetworkUrlInterceptor.__loadSettings" ID="NetworkUrlInterceptor.__loadSettings"></a> 121 <a NAME="NetworkUrlInterceptor.__loadSettings" ID="NetworkUrlInterceptor.__loadSettings"></a>
124 <h4>NetworkUrlInterceptor.__loadSettings</h4> 122 <h4>NetworkUrlInterceptor.__loadSettings</h4>
125 <b>__loadSettings</b>(<i></i>) 123 <b>__loadSettings</b>(<i></i>)
126
127 <p> 124 <p>
128 Private method to load the Network Manager settings. 125 Private method to load the Network Manager settings.
129 </p> 126 </p>
127
130 <a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a> 128 <a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a>
131 <h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4> 129 <h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4>
132 <b>__potentiallyTrustworthy</b>(<i>url</i>) 130 <b>__potentiallyTrustworthy</b>(<i>url</i>)
133
134 <p> 131 <p>
135 Private method to check, if the given URL is potentially trustworthy. 132 Private method to check, if the given URL is potentially trustworthy.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>url</i> (QUrl)</dt> 137 <dt><i>url</i> (QUrl)</dt>
140 <dd> 138 <dd>
141 URL to be checked 139 URL to be checked
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a> 154 <a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a>
157 <h4>NetworkUrlInterceptor.__refererOrigin</h4> 155 <h4>NetworkUrlInterceptor.__refererOrigin</h4>
158 <b>__refererOrigin</b>(<i>url</i>) 156 <b>__refererOrigin</b>(<i>url</i>)
159
160 <p> 157 <p>
161 Private method to generate an origin referer header URL. 158 Private method to generate an origin referer header URL.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 162
165 <dt><i>url</i> (QUrl)</dt> 163 <dt><i>url</i> (QUrl)</dt>
166 <dd> 164 <dd>
167 URL to generate the header from 165 URL to generate the header from
180 </dd> 178 </dd>
181 </dl> 179 </dl>
182 <a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a> 180 <a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a>
183 <h4>NetworkUrlInterceptor.__sameOrigin</h4> 181 <h4>NetworkUrlInterceptor.__sameOrigin</h4>
184 <b>__sameOrigin</b>(<i>url1, url2</i>) 182 <b>__sameOrigin</b>(<i>url1, url2</i>)
185
186 <p> 183 <p>
187 Private method to test the "same origin" policy. 184 Private method to test the "same origin" policy.
188 </p> 185 </p>
186
189 <dl> 187 <dl>
190 188
191 <dt><i>url1</i> (QUrl)</dt> 189 <dt><i>url1</i> (QUrl)</dt>
192 <dd> 190 <dd>
193 first URL for the test 191 first URL for the test
210 </dd> 208 </dd>
211 </dl> 209 </dl>
212 <a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a> 210 <a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a>
213 <h4>NetworkUrlInterceptor.__setRefererHeader</h4> 211 <h4>NetworkUrlInterceptor.__setRefererHeader</h4>
214 <b>__setRefererHeader</b>(<i>info</i>) 212 <b>__setRefererHeader</b>(<i>info</i>)
215
216 <p> 213 <p>
217 Private method to set the 'Referer' header depending on the configured 214 Private method to set the 'Referer' header depending on the configured
218 rule set. 215 rule set.
219 </p> 216 </p>
217
220 <dl> 218 <dl>
221 219
222 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> 220 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
223 <dd> 221 <dd>
224 URL request information 222 URL request information
236 </dd> 234 </dd>
237 </dl> 235 </dl>
238 <a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a> 236 <a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a>
239 <h4>NetworkUrlInterceptor.__trimmedReferer</h4> 237 <h4>NetworkUrlInterceptor.__trimmedReferer</h4>
240 <b>__trimmedReferer</b>(<i>url</i>) 238 <b>__trimmedReferer</b>(<i>url</i>)
241
242 <p> 239 <p>
243 Private method to generate the trimmed referer header URL. 240 Private method to generate the trimmed referer header URL.
244 </p> 241 </p>
242
245 <dl> 243 <dl>
246 244
247 <dt><i>url</i> (QUrl)</dt> 245 <dt><i>url</i> (QUrl)</dt>
248 <dd> 246 <dd>
249 URL to be trimmed as a referer header 247 URL to be trimmed as a referer header
262 </dd> 260 </dd>
263 </dl> 261 </dl>
264 <a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a> 262 <a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a>
265 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4> 263 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4>
266 <b>installUrlInterceptor</b>(<i>interceptor</i>) 264 <b>installUrlInterceptor</b>(<i>interceptor</i>)
267
268 <p> 265 <p>
269 Public method to install an URL interceptor. 266 Public method to install an URL interceptor.
270 </p> 267 </p>
268
271 <dl> 269 <dl>
272 270
273 <dt><i>interceptor</i> (UrlInterceptor)</dt> 271 <dt><i>interceptor</i> (UrlInterceptor)</dt>
274 <dd> 272 <dd>
275 URL interceptor to be installed 273 URL interceptor to be installed
276 </dd> 274 </dd>
277 </dl> 275 </dl>
278 <a NAME="NetworkUrlInterceptor.interceptRequest" ID="NetworkUrlInterceptor.interceptRequest"></a> 276 <a NAME="NetworkUrlInterceptor.interceptRequest" ID="NetworkUrlInterceptor.interceptRequest"></a>
279 <h4>NetworkUrlInterceptor.interceptRequest</h4> 277 <h4>NetworkUrlInterceptor.interceptRequest</h4>
280 <b>interceptRequest</b>(<i>info</i>) 278 <b>interceptRequest</b>(<i>info</i>)
281
282 <p> 279 <p>
283 Public method handling an URL request. 280 Public method handling an URL request.
284 </p> 281 </p>
282
285 <dl> 283 <dl>
286 284
287 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> 285 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
288 <dd> 286 <dd>
289 URL request information 287 URL request information
290 </dd> 288 </dd>
291 </dl> 289 </dl>
292 <a NAME="NetworkUrlInterceptor.preferencesChanged" ID="NetworkUrlInterceptor.preferencesChanged"></a> 290 <a NAME="NetworkUrlInterceptor.preferencesChanged" ID="NetworkUrlInterceptor.preferencesChanged"></a>
293 <h4>NetworkUrlInterceptor.preferencesChanged</h4> 291 <h4>NetworkUrlInterceptor.preferencesChanged</h4>
294 <b>preferencesChanged</b>(<i></i>) 292 <b>preferencesChanged</b>(<i></i>)
295
296 <p> 293 <p>
297 Public slot to handle a change of preferences. 294 Public slot to handle a change of preferences.
298 </p> 295 </p>
296
299 <a NAME="NetworkUrlInterceptor.removeUrlInterceptor" ID="NetworkUrlInterceptor.removeUrlInterceptor"></a> 297 <a NAME="NetworkUrlInterceptor.removeUrlInterceptor" ID="NetworkUrlInterceptor.removeUrlInterceptor"></a>
300 <h4>NetworkUrlInterceptor.removeUrlInterceptor</h4> 298 <h4>NetworkUrlInterceptor.removeUrlInterceptor</h4>
301 <b>removeUrlInterceptor</b>(<i>interceptor</i>) 299 <b>removeUrlInterceptor</b>(<i>interceptor</i>)
302
303 <p> 300 <p>
304 Public method to remove an URL interceptor. 301 Public method to remove an URL interceptor.
305 </p> 302 </p>
303
306 <dl> 304 <dl>
307 305
308 <dt><i>interceptor</i> (UrlInterceptor)</dt> 306 <dt><i>interceptor</i> (UrlInterceptor)</dt>
309 <dd> 307 <dd>
310 URL interceptor to be removed 308 URL interceptor to be removed

eric ide

mercurial