diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingCache.html
--- a/src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingCache.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingCache.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,62 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingCache</h1>
-
<p>
Module implementing a cache for Google Safe Browsing.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#SafeBrowsingCache">SafeBrowsingCache</a></td>
<td>Class implementing a cache for Google Safe Browsing.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="SafeBrowsingCache" ID="SafeBrowsingCache"></a>
<h2>SafeBrowsingCache</h2>
-
<p>
Class implementing a cache for Google Safe Browsing.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>create_full_hash_cue_idx</td></tr>
+<tr><td>create_full_hash_expires_idx</td></tr>
+<tr><td>create_full_hash_value_idx</td></tr>
+<tr><td>create_full_hashes_stmt</td></tr>
+<tr><td>create_hash_prefix_stmt</td></tr>
+<tr><td>create_threat_list_stmt</td></tr>
+<tr><td>drop_full_hash_cue_idx</td></tr>
+<tr><td>drop_full_hash_expires_idx</td></tr>
+<tr><td>drop_full_hash_value_idx</td></tr>
+<tr><td>drop_full_hashes_stmt</td></tr>
+<tr><td>drop_hash_prefix_stmt</td></tr>
+<tr><td>drop_threat_list_stmt</td></tr>
+<tr><td>maxProcessEventsTime</td></tr>
+</table>
-<table>
-<tr><td>create_full_hash_cue_idx</td></tr><tr><td>create_full_hash_expires_idx</td></tr><tr><td>create_full_hash_value_idx</td></tr><tr><td>create_full_hashes_stmt</td></tr><tr><td>create_hash_prefix_stmt</td></tr><tr><td>create_threat_list_stmt</td></tr><tr><td>drop_full_hash_cue_idx</td></tr><tr><td>drop_full_hash_expires_idx</td></tr><tr><td>drop_full_hash_value_idx</td></tr><tr><td>drop_full_hashes_stmt</td></tr><tr><td>drop_hash_prefix_stmt</td></tr><tr><td>drop_threat_list_stmt</td></tr><tr><td>maxProcessEventsTime</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#SafeBrowsingCache.__init__">SafeBrowsingCache</a></td>
<td>Constructor</td>
@@ -127,19 +136,20 @@
<td>Public method to update the client state of a threat list.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="SafeBrowsingCache.__init__" ID="SafeBrowsingCache.__init__"></a>
<h4>SafeBrowsingCache (Constructor)</h4>
<b>SafeBrowsingCache</b>(<i>dbPath, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dbPath</i> (str)</dt>
@@ -154,10 +164,10 @@
<a NAME="SafeBrowsingCache.__openCacheDb" ID="SafeBrowsingCache.__openCacheDb"></a>
<h4>SafeBrowsingCache.__openCacheDb</h4>
<b>__openCacheDb</b>(<i></i>)
-
<p>
Private method to open the cache database.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -173,10 +183,10 @@
<a NAME="SafeBrowsingCache.addThreatList" ID="SafeBrowsingCache.addThreatList"></a>
<h4>SafeBrowsingCache.addThreatList</h4>
<b>addThreatList</b>(<i>threatList</i>)
-
<p>
Public method to add a threat list to the cache.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -187,11 +197,11 @@
<a NAME="SafeBrowsingCache.cleanupFullHashes" ID="SafeBrowsingCache.cleanupFullHashes"></a>
<h4>SafeBrowsingCache.cleanupFullHashes</h4>
<b>cleanupFullHashes</b>(<i>keepExpiredFor=43200</i>)
-
<p>
Public method to clean up full hash entries expired more than the
given time.
</p>
+
<dl>
<dt><i>keepExpiredFor</i> (int or float)</dt>
@@ -202,17 +212,17 @@
<a NAME="SafeBrowsingCache.close" ID="SafeBrowsingCache.close"></a>
<h4>SafeBrowsingCache.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method to close the database.
</p>
+
<a NAME="SafeBrowsingCache.deleteHashPrefixList" ID="SafeBrowsingCache.deleteHashPrefixList"></a>
<h4>SafeBrowsingCache.deleteHashPrefixList</h4>
<b>deleteHashPrefixList</b>(<i>threatList</i>)
-
<p>
Public method to delete hash prefixes for a given threat list.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -223,10 +233,10 @@
<a NAME="SafeBrowsingCache.deleteThreatList" ID="SafeBrowsingCache.deleteThreatList"></a>
<h4>SafeBrowsingCache.deleteThreatList</h4>
<b>deleteThreatList</b>(<i>threatList</i>)
-
<p>
Public method to delete a threat list from the cache.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -237,11 +247,11 @@
<a NAME="SafeBrowsingCache.getHashPrefixValuesToRemove" ID="SafeBrowsingCache.getHashPrefixValuesToRemove"></a>
<h4>SafeBrowsingCache.getHashPrefixValuesToRemove</h4>
<b>getHashPrefixValuesToRemove</b>(<i>threatList, indexes</i>)
-
<p>
Public method to get the hash prefix values to be removed from the
cache.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -268,10 +278,10 @@
<a NAME="SafeBrowsingCache.getThreatLists" ID="SafeBrowsingCache.getThreatLists"></a>
<h4>SafeBrowsingCache.getThreatLists</h4>
<b>getThreatLists</b>(<i></i>)
-
<p>
Public method to get the available threat lists.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -287,11 +297,11 @@
<a NAME="SafeBrowsingCache.hashPrefixListChecksum" ID="SafeBrowsingCache.hashPrefixListChecksum"></a>
<h4>SafeBrowsingCache.hashPrefixListChecksum</h4>
<b>hashPrefixListChecksum</b>(<i>threatList</i>)
-
<p>
Public method to calculate the SHA256 checksum for an alphabetically
sorted concatenated list of hash prefixes.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -314,11 +324,11 @@
<a NAME="SafeBrowsingCache.lookupFullHashes" ID="SafeBrowsingCache.lookupFullHashes"></a>
<h4>SafeBrowsingCache.lookupFullHashes</h4>
<b>lookupFullHashes</b>(<i>hashValues</i>)
-
<p>
Public method to get a list of threat lists and expiration flag
for the given hashes if a hash is blacklisted.
</p>
+
<dl>
<dt><i>hashValues</i> (list of bytes)</dt>
@@ -342,10 +352,10 @@
<a NAME="SafeBrowsingCache.lookupHashPrefix" ID="SafeBrowsingCache.lookupHashPrefix"></a>
<h4>SafeBrowsingCache.lookupHashPrefix</h4>
<b>lookupHashPrefix</b>(<i>prefixes</i>)
-
<p>
Public method to look up hash prefixes in the local cache.
</p>
+
<dl>
<dt><i>prefixes</i> (list of bytes)</dt>
@@ -369,10 +379,10 @@
<a NAME="SafeBrowsingCache.populateHashPrefixList" ID="SafeBrowsingCache.populateHashPrefixList"></a>
<h4>SafeBrowsingCache.populateHashPrefixList</h4>
<b>populateHashPrefixList</b>(<i>threatList, prefixes</i>)
-
<p>
Public method to populate the hash prefixes for a threat list.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -387,17 +397,17 @@
<a NAME="SafeBrowsingCache.prepareCacheDb" ID="SafeBrowsingCache.prepareCacheDb"></a>
<h4>SafeBrowsingCache.prepareCacheDb</h4>
<b>prepareCacheDb</b>(<i></i>)
-
<p>
Public method to prepare the cache database.
</p>
+
<a NAME="SafeBrowsingCache.removeHashPrefixIndices" ID="SafeBrowsingCache.removeHashPrefixIndices"></a>
<h4>SafeBrowsingCache.removeHashPrefixIndices</h4>
<b>removeHashPrefixIndices</b>(<i>threatList, indexes</i>)
-
<p>
Public method to remove hash prefixes from the cache.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -412,10 +422,10 @@
<a NAME="SafeBrowsingCache.storeFullHash" ID="SafeBrowsingCache.storeFullHash"></a>
<h4>SafeBrowsingCache.storeFullHash</h4>
<b>storeFullHash</b>(<i>threatList, hashValue, cacheDuration, malwareThreatType</i>)
-
<p>
Public method to store full hash data in the cache database.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -438,10 +448,10 @@
<a NAME="SafeBrowsingCache.updateHashPrefixExpiration" ID="SafeBrowsingCache.updateHashPrefixExpiration"></a>
<h4>SafeBrowsingCache.updateHashPrefixExpiration</h4>
<b>updateHashPrefixExpiration</b>(<i>threatList, hashPrefix, negativeCacheDuration</i>)
-
<p>
Public method to update the hash prefix expiration time.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -461,10 +471,10 @@
<a NAME="SafeBrowsingCache.updateThreatListClientState" ID="SafeBrowsingCache.updateThreatListClientState"></a>
<h4>SafeBrowsingCache.updateThreatListClientState</h4>
<b>updateThreatListClientState</b>(<i>threatList, clientState</i>)
-
<p>
Public method to update the client state of a threat list.
</p>
+
<dl>
<dt><i>threatList</i> (ThreatList)</dt>
@@ -478,4 +488,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
