Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkUrlInterceptor.html
src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkUrlInterceptor.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Network.NetworkUrlInterceptor</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.Network.NetworkUrlInterceptor</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class to handle URL requests before they get processed | |
| 13 by QtWebEngine. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#NetworkUrlInterceptor">NetworkUrlInterceptor</a></td> | |
| 26 <td>Class implementing an URL request handler.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="NetworkUrlInterceptor" ID="NetworkUrlInterceptor"></a> | |
| 37 <h2>NetworkUrlInterceptor</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing an URL request handler. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 QWebEngineUrlRequestInterceptor | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>None</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#NetworkUrlInterceptor.__init__">NetworkUrlInterceptor</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#NetworkUrlInterceptor.__loadSettings">__loadSettings</a></td> | |
| 64 <td>Private method to load the Network Manager settings.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#NetworkUrlInterceptor.__potentiallyTrustworthy">__potentiallyTrustworthy</a></td> | |
| 68 <td>Private method to check, if the given URL is potentially trustworthy.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#NetworkUrlInterceptor.__refererOrigin">__refererOrigin</a></td> | |
| 72 <td>Private method to generate an origin referer header URL.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#NetworkUrlInterceptor.__sameOrigin">__sameOrigin</a></td> | |
| 76 <td>Private method to test the "same origin" policy.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#NetworkUrlInterceptor.__setRefererHeader">__setRefererHeader</a></td> | |
| 80 <td>Private method to set the 'Referer' header depending on the configured rule set.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#NetworkUrlInterceptor.__trimmedReferer">__trimmedReferer</a></td> | |
| 84 <td>Private method to generate the trimmed referer header URL.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#NetworkUrlInterceptor.installUrlInterceptor">installUrlInterceptor</a></td> | |
| 88 <td>Public method to install an URL interceptor.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#NetworkUrlInterceptor.interceptRequest">interceptRequest</a></td> | |
| 92 <td>Public method handling an URL request.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#NetworkUrlInterceptor.preferencesChanged">preferencesChanged</a></td> | |
| 96 <td>Public slot to handle a change of preferences.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#NetworkUrlInterceptor.removeUrlInterceptor">removeUrlInterceptor</a></td> | |
| 100 <td>Public method to remove an URL interceptor.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <h3>Static Methods</h3> | |
| 104 | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 <a NAME="NetworkUrlInterceptor.__init__" ID="NetworkUrlInterceptor.__init__"></a> | |
| 110 <h4>NetworkUrlInterceptor (Constructor)</h4> | |
| 111 <b>NetworkUrlInterceptor</b>(<i>parent=None</i>) | |
| 112 | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 <dl> | |
| 117 | |
| 118 <dt><i>parent</i> (QObject)</dt> | |
| 119 <dd> | |
| 120 reference to the parent object | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <a NAME="NetworkUrlInterceptor.__loadSettings" ID="NetworkUrlInterceptor.__loadSettings"></a> | |
| 124 <h4>NetworkUrlInterceptor.__loadSettings</h4> | |
| 125 <b>__loadSettings</b>(<i></i>) | |
| 126 | |
| 127 <p> | |
| 128 Private method to load the Network Manager settings. | |
| 129 </p> | |
| 130 <a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a> | |
| 131 <h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4> | |
| 132 <b>__potentiallyTrustworthy</b>(<i>url</i>) | |
| 133 | |
| 134 <p> | |
| 135 Private method to check, if the given URL is potentially trustworthy. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>url</i> (QUrl)</dt> | |
| 140 <dd> | |
| 141 URL to be checked | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <dl> | |
| 145 <dt>Return:</dt> | |
| 146 <dd> | |
| 147 flag indicating a potentially trustworthy URL | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return Type:</dt> | |
| 152 <dd> | |
| 153 bool | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a> | |
| 157 <h4>NetworkUrlInterceptor.__refererOrigin</h4> | |
| 158 <b>__refererOrigin</b>(<i>url</i>) | |
| 159 | |
| 160 <p> | |
| 161 Private method to generate an origin referer header URL. | |
| 162 </p> | |
| 163 <dl> | |
| 164 | |
| 165 <dt><i>url</i> (QUrl)</dt> | |
| 166 <dd> | |
| 167 URL to generate the header from | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <dl> | |
| 171 <dt>Return:</dt> | |
| 172 <dd> | |
| 173 origin referer header URL | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <dl> | |
| 177 <dt>Return Type:</dt> | |
| 178 <dd> | |
| 179 QByteArray or bytes | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a> | |
| 183 <h4>NetworkUrlInterceptor.__sameOrigin</h4> | |
| 184 <b>__sameOrigin</b>(<i>url1, url2</i>) | |
| 185 | |
| 186 <p> | |
| 187 Private method to test the "same origin" policy. | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>url1</i> (QUrl)</dt> | |
| 192 <dd> | |
| 193 first URL for the test | |
| 194 </dd> | |
| 195 <dt><i>url2</i> (QUrl)</dt> | |
| 196 <dd> | |
| 197 second URL for the test | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <dl> | |
| 201 <dt>Return:</dt> | |
| 202 <dd> | |
| 203 flag indicating that both URLs have the same origin | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <dl> | |
| 207 <dt>Return Type:</dt> | |
| 208 <dd> | |
| 209 bool | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a> | |
| 213 <h4>NetworkUrlInterceptor.__setRefererHeader</h4> | |
| 214 <b>__setRefererHeader</b>(<i>info</i>) | |
| 215 | |
| 216 <p> | |
| 217 Private method to set the 'Referer' header depending on the configured | |
| 218 rule set. | |
| 219 </p> | |
| 220 <dl> | |
| 221 | |
| 222 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> | |
| 223 <dd> | |
| 224 URL request information | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <dl> | |
| 228 <dt><b>See Also:</b></dt> | |
| 229 | |
| 230 <dd> | |
| 231 <a href="https://wiki.mozilla.org/Security/Referrer"> Mozilla Referrer</a> | |
| 232 </dd> | |
| 233 | |
| 234 <dd> | |
| 235 <a href="https://www.w3.org/TR/referrer-policy/"> W3C Referrer Policy</a> | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a> | |
| 239 <h4>NetworkUrlInterceptor.__trimmedReferer</h4> | |
| 240 <b>__trimmedReferer</b>(<i>url</i>) | |
| 241 | |
| 242 <p> | |
| 243 Private method to generate the trimmed referer header URL. | |
| 244 </p> | |
| 245 <dl> | |
| 246 | |
| 247 <dt><i>url</i> (QUrl)</dt> | |
| 248 <dd> | |
| 249 URL to be trimmed as a referer header | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <dl> | |
| 253 <dt>Return:</dt> | |
| 254 <dd> | |
| 255 trimmed referer header URL | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <dl> | |
| 259 <dt>Return Type:</dt> | |
| 260 <dd> | |
| 261 QByteArray or bytes | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a> | |
| 265 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4> | |
| 266 <b>installUrlInterceptor</b>(<i>interceptor</i>) | |
| 267 | |
| 268 <p> | |
| 269 Public method to install an URL interceptor. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>interceptor</i> (UrlInterceptor)</dt> | |
| 274 <dd> | |
| 275 URL interceptor to be installed | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <a NAME="NetworkUrlInterceptor.interceptRequest" ID="NetworkUrlInterceptor.interceptRequest"></a> | |
| 279 <h4>NetworkUrlInterceptor.interceptRequest</h4> | |
| 280 <b>interceptRequest</b>(<i>info</i>) | |
| 281 | |
| 282 <p> | |
| 283 Public method handling an URL request. | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> | |
| 288 <dd> | |
| 289 URL request information | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="NetworkUrlInterceptor.preferencesChanged" ID="NetworkUrlInterceptor.preferencesChanged"></a> | |
| 293 <h4>NetworkUrlInterceptor.preferencesChanged</h4> | |
| 294 <b>preferencesChanged</b>(<i></i>) | |
| 295 | |
| 296 <p> | |
| 297 Public slot to handle a change of preferences. | |
| 298 </p> | |
| 299 <a NAME="NetworkUrlInterceptor.removeUrlInterceptor" ID="NetworkUrlInterceptor.removeUrlInterceptor"></a> | |
| 300 <h4>NetworkUrlInterceptor.removeUrlInterceptor</h4> | |
| 301 <b>removeUrlInterceptor</b>(<i>interceptor</i>) | |
| 302 | |
| 303 <p> | |
| 304 Public method to remove an URL interceptor. | |
| 305 </p> | |
| 306 <dl> | |
| 307 | |
| 308 <dt><i>interceptor</i> (UrlInterceptor)</dt> | |
| 309 <dd> | |
| 310 URL interceptor to be removed | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <div align="right"><a href="#top">Up</a></div> | |
| 314 <hr /> | |
| 315 </body></html> |
