1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.FlashCookieManager.FlashCookieManager</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric6.WebBrowser.FlashCookieManager.FlashCookieManager</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the Flash cookie manager. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#FlashCookieManager">FlashCookieManager</a></td> |
|
39 <td>Class implementing the Flash cookie manager object.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="FlashCookieManager" ID="FlashCookieManager"></a> |
|
50 <h2>FlashCookieManager</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the Flash cookie manager object. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QObject |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>RefreshInterval</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#FlashCookieManager.__init__">FlashCookieManager</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#FlashCookieManager.__autoRefresh">__autoRefresh</a></td> |
|
77 <td>Private slot to refresh the list of cookies.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#FlashCookieManager.__extractOriginFrom">__extractOriginFrom</a></td> |
|
81 <td>Private method to extract the cookie origin given its file name.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#FlashCookieManager.__insertFlashCookie">__insertFlashCookie</a></td> |
|
85 <td>Private method to insert a Flash cookie into the cache.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#FlashCookieManager.__isBlacklisted">__isBlacklisted</a></td> |
|
89 <td>Private method to check for a blacklisted cookie.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#FlashCookieManager.__isWhitelisted">__isWhitelisted</a></td> |
|
93 <td>Private method to check for a whitelisted cookie.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#FlashCookieManager.__loadFlashCookies">__loadFlashCookies</a></td> |
|
97 <td>Private slot to load the Flash cookies to be cached.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#FlashCookieManager.__loadFlashCookiesFromPath">__loadFlashCookiesFromPath</a></td> |
|
101 <td>Private slot to load the Flash cookies from a path.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#FlashCookieManager.__removeAllButWhitelisted">__removeAllButWhitelisted</a></td> |
|
105 <td>Private method to remove all non-whitelisted cookies.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#FlashCookieManager.__sharedObjectDirName">__sharedObjectDirName</a></td> |
|
109 <td>Private slot to determine the path of the shared data objects.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#FlashCookieManager.__startStopTimer">__startStopTimer</a></td> |
|
113 <td>Private slot to start or stop the auto refresh timer.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#FlashCookieManager.clearCache">clearCache</a></td> |
|
117 <td>Public method to clear the list of cached Flash cookies.</td> |
|
118 </tr> |
|
119 <tr> |
|
120 <td><a href="#FlashCookieManager.clearNewOrigins">clearNewOrigins</a></td> |
|
121 <td>Public method to clear the list of newly detected Flash cookies.</td> |
|
122 </tr> |
|
123 <tr> |
|
124 <td><a href="#FlashCookieManager.flashCookies">flashCookies</a></td> |
|
125 <td>Public method to get the list of cached Flash cookies.</td> |
|
126 </tr> |
|
127 <tr> |
|
128 <td><a href="#FlashCookieManager.flashPlayerDataPath">flashPlayerDataPath</a></td> |
|
129 <td>Public method to get the Flash Player data path.</td> |
|
130 </tr> |
|
131 <tr> |
|
132 <td><a href="#FlashCookieManager.newCookiesList">newCookiesList</a></td> |
|
133 <td>Public method to get the list of newly detected Flash cookies.</td> |
|
134 </tr> |
|
135 <tr> |
|
136 <td><a href="#FlashCookieManager.preferencesChanged">preferencesChanged</a></td> |
|
137 <td>Public slot to handle a change of preferences.</td> |
|
138 </tr> |
|
139 <tr> |
|
140 <td><a href="#FlashCookieManager.removeAllCookies">removeAllCookies</a></td> |
|
141 <td>Public method to remove all flash cookies.</td> |
|
142 </tr> |
|
143 <tr> |
|
144 <td><a href="#FlashCookieManager.removeCookie">removeCookie</a></td> |
|
145 <td>Public method to remove a cookie of the list of cached cookies.</td> |
|
146 </tr> |
|
147 <tr> |
|
148 <td><a href="#FlashCookieManager.setFlashCookies">setFlashCookies</a></td> |
|
149 <td>Public method to set the list of cached Flash cookies.</td> |
|
150 </tr> |
|
151 <tr> |
|
152 <td><a href="#FlashCookieManager.showFlashCookieManagerDialog">showFlashCookieManagerDialog</a></td> |
|
153 <td>Public method to show the Flash cookies management dialog.</td> |
|
154 </tr> |
|
155 <tr> |
|
156 <td><a href="#FlashCookieManager.shutdown">shutdown</a></td> |
|
157 <td>Public method to perform shutdown actions.</td> |
|
158 </tr> |
|
159 </table> |
|
160 <h3>Static Methods</h3> |
|
161 |
|
162 <table> |
|
163 <tr><td>None</td></tr> |
|
164 </table> |
|
165 |
|
166 <a NAME="FlashCookieManager.__init__" ID="FlashCookieManager.__init__"></a> |
|
167 <h4>FlashCookieManager (Constructor)</h4> |
|
168 <b>FlashCookieManager</b>(<i>parent=None</i>) |
|
169 |
|
170 <p> |
|
171 Constructor |
|
172 </p> |
|
173 <dl> |
|
174 |
|
175 <dt><i>parent</i> (QObject)</dt> |
|
176 <dd> |
|
177 reference to the parent object |
|
178 </dd> |
|
179 </dl> |
|
180 <a NAME="FlashCookieManager.__autoRefresh" ID="FlashCookieManager.__autoRefresh"></a> |
|
181 <h4>FlashCookieManager.__autoRefresh</h4> |
|
182 <b>__autoRefresh</b>(<i></i>) |
|
183 |
|
184 <p> |
|
185 Private slot to refresh the list of cookies. |
|
186 </p> |
|
187 <a NAME="FlashCookieManager.__extractOriginFrom" ID="FlashCookieManager.__extractOriginFrom"></a> |
|
188 <h4>FlashCookieManager.__extractOriginFrom</h4> |
|
189 <b>__extractOriginFrom</b>(<i>path</i>) |
|
190 |
|
191 <p> |
|
192 Private method to extract the cookie origin given its file name. |
|
193 </p> |
|
194 <dl> |
|
195 |
|
196 <dt><i>path</i> (str)</dt> |
|
197 <dd> |
|
198 file name of the cookie file |
|
199 </dd> |
|
200 </dl> |
|
201 <dl> |
|
202 <dt>Return:</dt> |
|
203 <dd> |
|
204 cookie origin |
|
205 </dd> |
|
206 </dl> |
|
207 <dl> |
|
208 <dt>Return Type:</dt> |
|
209 <dd> |
|
210 str |
|
211 </dd> |
|
212 </dl> |
|
213 <a NAME="FlashCookieManager.__insertFlashCookie" ID="FlashCookieManager.__insertFlashCookie"></a> |
|
214 <h4>FlashCookieManager.__insertFlashCookie</h4> |
|
215 <b>__insertFlashCookie</b>(<i>path</i>) |
|
216 |
|
217 <p> |
|
218 Private method to insert a Flash cookie into the cache. |
|
219 </p> |
|
220 <dl> |
|
221 |
|
222 <dt><i>path</i> (str)</dt> |
|
223 <dd> |
|
224 Flash cookies path |
|
225 </dd> |
|
226 </dl> |
|
227 <a NAME="FlashCookieManager.__isBlacklisted" ID="FlashCookieManager.__isBlacklisted"></a> |
|
228 <h4>FlashCookieManager.__isBlacklisted</h4> |
|
229 <b>__isBlacklisted</b>(<i>cookie</i>) |
|
230 |
|
231 <p> |
|
232 Private method to check for a blacklisted cookie. |
|
233 </p> |
|
234 <dl> |
|
235 |
|
236 <dt><i>cookie</i> (FlashCookie)</dt> |
|
237 <dd> |
|
238 Flash cookie to be tested |
|
239 </dd> |
|
240 </dl> |
|
241 <dl> |
|
242 <dt>Return:</dt> |
|
243 <dd> |
|
244 flag indicating a blacklisted cookie |
|
245 </dd> |
|
246 </dl> |
|
247 <dl> |
|
248 <dt>Return Type:</dt> |
|
249 <dd> |
|
250 bool |
|
251 </dd> |
|
252 </dl> |
|
253 <a NAME="FlashCookieManager.__isWhitelisted" ID="FlashCookieManager.__isWhitelisted"></a> |
|
254 <h4>FlashCookieManager.__isWhitelisted</h4> |
|
255 <b>__isWhitelisted</b>(<i>cookie</i>) |
|
256 |
|
257 <p> |
|
258 Private method to check for a whitelisted cookie. |
|
259 </p> |
|
260 <dl> |
|
261 |
|
262 <dt><i>cookie</i> (FlashCookie)</dt> |
|
263 <dd> |
|
264 Flash cookie to be tested |
|
265 </dd> |
|
266 </dl> |
|
267 <dl> |
|
268 <dt>Return:</dt> |
|
269 <dd> |
|
270 flag indicating a whitelisted cookie |
|
271 </dd> |
|
272 </dl> |
|
273 <dl> |
|
274 <dt>Return Type:</dt> |
|
275 <dd> |
|
276 bool |
|
277 </dd> |
|
278 </dl> |
|
279 <a NAME="FlashCookieManager.__loadFlashCookies" ID="FlashCookieManager.__loadFlashCookies"></a> |
|
280 <h4>FlashCookieManager.__loadFlashCookies</h4> |
|
281 <b>__loadFlashCookies</b>(<i></i>) |
|
282 |
|
283 <p> |
|
284 Private slot to load the Flash cookies to be cached. |
|
285 </p> |
|
286 <a NAME="FlashCookieManager.__loadFlashCookiesFromPath" ID="FlashCookieManager.__loadFlashCookiesFromPath"></a> |
|
287 <h4>FlashCookieManager.__loadFlashCookiesFromPath</h4> |
|
288 <b>__loadFlashCookiesFromPath</b>(<i>path</i>) |
|
289 |
|
290 <p> |
|
291 Private slot to load the Flash cookies from a path. |
|
292 </p> |
|
293 <dl> |
|
294 |
|
295 <dt><i>path</i> (str)</dt> |
|
296 <dd> |
|
297 Flash cookies path |
|
298 </dd> |
|
299 </dl> |
|
300 <a NAME="FlashCookieManager.__removeAllButWhitelisted" ID="FlashCookieManager.__removeAllButWhitelisted"></a> |
|
301 <h4>FlashCookieManager.__removeAllButWhitelisted</h4> |
|
302 <b>__removeAllButWhitelisted</b>(<i></i>) |
|
303 |
|
304 <p> |
|
305 Private method to remove all non-whitelisted cookies. |
|
306 </p> |
|
307 <a NAME="FlashCookieManager.__sharedObjectDirName" ID="FlashCookieManager.__sharedObjectDirName"></a> |
|
308 <h4>FlashCookieManager.__sharedObjectDirName</h4> |
|
309 <b>__sharedObjectDirName</b>(<i></i>) |
|
310 |
|
311 <p> |
|
312 Private slot to determine the path of the shared data objects. |
|
313 </p> |
|
314 <dl> |
|
315 <dt>Return:</dt> |
|
316 <dd> |
|
317 path of the shared data objects |
|
318 </dd> |
|
319 </dl> |
|
320 <dl> |
|
321 <dt>Return Type:</dt> |
|
322 <dd> |
|
323 str |
|
324 </dd> |
|
325 </dl> |
|
326 <a NAME="FlashCookieManager.__startStopTimer" ID="FlashCookieManager.__startStopTimer"></a> |
|
327 <h4>FlashCookieManager.__startStopTimer</h4> |
|
328 <b>__startStopTimer</b>(<i></i>) |
|
329 |
|
330 <p> |
|
331 Private slot to start or stop the auto refresh timer. |
|
332 </p> |
|
333 <a NAME="FlashCookieManager.clearCache" ID="FlashCookieManager.clearCache"></a> |
|
334 <h4>FlashCookieManager.clearCache</h4> |
|
335 <b>clearCache</b>(<i></i>) |
|
336 |
|
337 <p> |
|
338 Public method to clear the list of cached Flash cookies. |
|
339 </p> |
|
340 <a NAME="FlashCookieManager.clearNewOrigins" ID="FlashCookieManager.clearNewOrigins"></a> |
|
341 <h4>FlashCookieManager.clearNewOrigins</h4> |
|
342 <b>clearNewOrigins</b>(<i></i>) |
|
343 |
|
344 <p> |
|
345 Public method to clear the list of newly detected Flash cookies. |
|
346 </p> |
|
347 <a NAME="FlashCookieManager.flashCookies" ID="FlashCookieManager.flashCookies"></a> |
|
348 <h4>FlashCookieManager.flashCookies</h4> |
|
349 <b>flashCookies</b>(<i></i>) |
|
350 |
|
351 <p> |
|
352 Public method to get the list of cached Flash cookies. |
|
353 </p> |
|
354 <dl> |
|
355 <dt>Return:</dt> |
|
356 <dd> |
|
357 list of Flash cookies |
|
358 </dd> |
|
359 </dl> |
|
360 <dl> |
|
361 <dt>Return Type:</dt> |
|
362 <dd> |
|
363 list of FlashCookie |
|
364 </dd> |
|
365 </dl> |
|
366 <a NAME="FlashCookieManager.flashPlayerDataPath" ID="FlashCookieManager.flashPlayerDataPath"></a> |
|
367 <h4>FlashCookieManager.flashPlayerDataPath</h4> |
|
368 <b>flashPlayerDataPath</b>(<i></i>) |
|
369 |
|
370 <p> |
|
371 Public method to get the Flash Player data path. |
|
372 </p> |
|
373 <dl> |
|
374 <dt>Return:</dt> |
|
375 <dd> |
|
376 Flash Player data path |
|
377 </dd> |
|
378 </dl> |
|
379 <dl> |
|
380 <dt>Return Type:</dt> |
|
381 <dd> |
|
382 str |
|
383 </dd> |
|
384 </dl> |
|
385 <a NAME="FlashCookieManager.newCookiesList" ID="FlashCookieManager.newCookiesList"></a> |
|
386 <h4>FlashCookieManager.newCookiesList</h4> |
|
387 <b>newCookiesList</b>(<i></i>) |
|
388 |
|
389 <p> |
|
390 Public method to get the list of newly detected Flash cookies. |
|
391 </p> |
|
392 <dl> |
|
393 <dt>Return:</dt> |
|
394 <dd> |
|
395 list of newly detected Flash cookies |
|
396 </dd> |
|
397 </dl> |
|
398 <dl> |
|
399 <dt>Return Type:</dt> |
|
400 <dd> |
|
401 list of str |
|
402 </dd> |
|
403 </dl> |
|
404 <a NAME="FlashCookieManager.preferencesChanged" ID="FlashCookieManager.preferencesChanged"></a> |
|
405 <h4>FlashCookieManager.preferencesChanged</h4> |
|
406 <b>preferencesChanged</b>(<i></i>) |
|
407 |
|
408 <p> |
|
409 Public slot to handle a change of preferences. |
|
410 </p> |
|
411 <a NAME="FlashCookieManager.removeAllCookies" ID="FlashCookieManager.removeAllCookies"></a> |
|
412 <h4>FlashCookieManager.removeAllCookies</h4> |
|
413 <b>removeAllCookies</b>(<i></i>) |
|
414 |
|
415 <p> |
|
416 Public method to remove all flash cookies. |
|
417 </p> |
|
418 <a NAME="FlashCookieManager.removeCookie" ID="FlashCookieManager.removeCookie"></a> |
|
419 <h4>FlashCookieManager.removeCookie</h4> |
|
420 <b>removeCookie</b>(<i>cookie</i>) |
|
421 |
|
422 <p> |
|
423 Public method to remove a cookie of the list of cached cookies. |
|
424 </p> |
|
425 <dl> |
|
426 |
|
427 <dt><i>cookie</i> (FlashCookie)</dt> |
|
428 <dd> |
|
429 Flash cookie to be removed |
|
430 </dd> |
|
431 </dl> |
|
432 <a NAME="FlashCookieManager.setFlashCookies" ID="FlashCookieManager.setFlashCookies"></a> |
|
433 <h4>FlashCookieManager.setFlashCookies</h4> |
|
434 <b>setFlashCookies</b>(<i>cookies</i>) |
|
435 |
|
436 <p> |
|
437 Public method to set the list of cached Flash cookies. |
|
438 </p> |
|
439 <dl> |
|
440 |
|
441 <dt><i>cookies</i> (list of FlashCookie)</dt> |
|
442 <dd> |
|
443 list of Flash cookies to store |
|
444 </dd> |
|
445 </dl> |
|
446 <a NAME="FlashCookieManager.showFlashCookieManagerDialog" ID="FlashCookieManager.showFlashCookieManagerDialog"></a> |
|
447 <h4>FlashCookieManager.showFlashCookieManagerDialog</h4> |
|
448 <b>showFlashCookieManagerDialog</b>(<i></i>) |
|
449 |
|
450 <p> |
|
451 Public method to show the Flash cookies management dialog. |
|
452 </p> |
|
453 <a NAME="FlashCookieManager.shutdown" ID="FlashCookieManager.shutdown"></a> |
|
454 <h4>FlashCookieManager.shutdown</h4> |
|
455 <b>shutdown</b>(<i></i>) |
|
456 |
|
457 <p> |
|
458 Public method to perform shutdown actions. |
|
459 </p> |
|
460 <div align="right"><a href="#top">Up</a></div> |
|
461 <hr /> |
|
462 </body></html> |
|