NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Tree: 9b01b2448a
Branches Tags
searxng
/
_modules
/
searx
/
favicons
/
cache.html

cache.html 71 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html lang="en" data-content_root="../../../">
    4. 

  4.   <head>
    5. 

  5.     <meta charset="utf-8" />
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <meta name="viewport" content="width=device-width, initial-scale=1">
    8. 

  8.     <title>searx.favicons.cache &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
    11. 

  11.     <script src="../../../_static/documentation_options.js?v=b12b0e12"></script>
    12. 

  12.     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
    13. 

  13.     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    14. 

  14.     <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
    15. 

  15.     <link rel="index" title="Index" href="../../../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../../../search.html" /> 
    17. 

  17.   </head><body>
    18. 

  18.     <div class="related" role="navigation" aria-label="Related">
    19. 

  19.       <h3>Navigation</h3>
    20. 

  20.       <ul>
    21. 

  21.         <li class="right" style="margin-right: 10px">
    22. 

  22.           <a href="../../../genindex.html" title="General Index"
    23. 

  23.              accesskey="I">index</a></li>
    24. 

  24.         <li class="right" >
    25. 

  25.           <a href="../../../py-modindex.html" title="Python Module Index"
    26. 

  26.              >modules</a> |</li>
    27. 

  27.         <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
    28. 

  28.           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
    29. 

  29.         <li class="nav-item nav-item-this"><a href="">searx.favicons.cache</a></li> 
    30. 

  30.       </ul>
    31. 

  31.     </div>  
    32. 

  32. 

  33.     <div class="document">
    34. 

  34.       <div class="documentwrapper">
    35. 

  35.         <div class="bodywrapper">
    36. 

  36.           <div class="body" role="main">
    37. 

  37.             
    38. 

  38.   <h1>Source code for searx.favicons.cache</h1><div class="highlight"><pre>
    39. 

  39. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
    40. 

  40. <span class="sd">&quot;&quot;&quot;Implementations for caching favicons.</span>
    41. 

  41. 

  42. <span class="sd">:py:obj:`FaviconCacheConfig`:</span>
    43. 

  43. <span class="sd">  Configuration of the favicon cache</span>
    44. 

  44. 

  45. <span class="sd">:py:obj:`FaviconCache`:</span>
    46. 

  46. <span class="sd">  Abstract base class for the implementation of a favicon cache.</span>
    47. 

  47. 

  48. <span class="sd">:py:obj:`FaviconCacheSQLite`:</span>
    49. 

  49. <span class="sd">  Favicon cache that manages the favicon BLOBs in a SQLite DB.</span>
    50. 

  50. 

  51. <span class="sd">:py:obj:`FaviconCacheNull`:</span>
    52. 

  52. <span class="sd">  Fallback solution if the configured cache cannot be used for system reasons.</span>
    53. 

  53. 

  54. <span class="sd">----</span>
    55. 

  55. 

  56. <span class="sd">&quot;&quot;&quot;</span>
    57. 

  57. 

  58. <span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
    59. 

  59. <span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Literal</span>
    60. 

  60. 

  61. <span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
    62. 

  62. <span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
    63. 

  63. <span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
    64. 

  64. <span class="kn">import</span><span class="w"> </span><span class="nn">hashlib</span>
    65. 

  65. <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
    66. 

  66. <span class="kn">import</span><span class="w"> </span><span class="nn">sqlite3</span>
    67. 

  67. <span class="kn">import</span><span class="w"> </span><span class="nn">tempfile</span>
    68. 

  68. <span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
    69. 

  69. <span class="kn">import</span><span class="w"> </span><span class="nn">typer</span>
    70. 

  70. 

  71. <span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</span>
    72. 

  72. 

  73. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">sqlitedb</span>
    74. 

  74. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
    75. 

  75. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">humanize_bytes</span><span class="p">,</span> <span class="n">humanize_number</span>
    76. 

  76. 

  77. <span class="n">CACHE</span><span class="p">:</span> <span class="s2">&quot;FaviconCache&quot;</span>
    78. 

  78. <span class="n">FALLBACK_ICON</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">&quot;FALLBACK_ICON&quot;</span>
    79. 

  79. 

  80. <span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">&#39;favicons.cache&#39;</span><span class="p">)</span>
    81. 

  81. <span class="n">app</span> <span class="o">=</span> <span class="n">typer</span><span class="o">.</span><span class="n">Typer</span><span class="p">()</span>
    82. 

  82. 

  83. 

  84. <div class="viewcode-block" id="state">
    85. 

  85. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.state">[docs]</a>
    86. 

  86. <span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
    87. 

  87. <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">():</span>
    88. 

  88. <span class="w">    </span><span class="sd">&quot;&quot;&quot;show state of the cache&quot;&quot;&quot;</span>
    89. 

  89.     <span class="nb">print</span><span class="p">(</span><span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span><span class="o">.</span><span class="n">report</span><span class="p">())</span></div>
    90. 

  90. 

  91. 

  92. 

  93. <div class="viewcode-block" id="maintenance">
    94. 

  94. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.maintenance">[docs]</a>
    95. 

  95. <span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
    96. 

  96. <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="n">force</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">debug</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
    97. 

  97. <span class="w">    </span><span class="sd">&quot;&quot;&quot;perform maintenance of the cache&quot;&quot;&quot;</span>
    98. 

  98.     <span class="n">root_log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
    99. 

  99.     <span class="k">if</span> <span class="n">debug</span><span class="p">:</span>
    100. 

  100.         <span class="n">root_log</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
    101. 

  101.     <span class="k">else</span><span class="p">:</span>
    102. 

  102.         <span class="n">root_log</span><span class="o">.</span><span class="n">handlers</span> <span class="o">=</span> <span class="p">[]</span>
    103. 

  103.         <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
    104. 

  104.         <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%(message)s</span><span class="s2">&quot;</span><span class="p">))</span>
    105. 

  105.         <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
    106. 

  106.         <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
    107. 

  107. 

  108.     <span class="n">state_t0</span> <span class="o">=</span> <span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span>
    109. 

  109.     <span class="n">CACHE</span><span class="o">.</span><span class="n">maintenance</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="n">force</span><span class="p">)</span>
    110. 

  110.     <span class="n">state_t1</span> <span class="o">=</span> <span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span>
    111. 

  111.     <span class="n">state_delta</span> <span class="o">=</span> <span class="n">state_t0</span> <span class="o">-</span> <span class="n">state_t1</span>
    112. 

  112.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;The cache has been reduced by:&quot;</span><span class="p">)</span>
    113. 

  113.     <span class="nb">print</span><span class="p">(</span><span class="n">state_delta</span><span class="o">.</span><span class="n">report</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">- </span><span class="si">{descr}</span><span class="s2">: </span><span class="si">{val}</span><span class="s2">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">))</span></div>
    114. 

  114. 

  115. 

  116. 

  117. <div class="viewcode-block" id="init">
    118. 

  118. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.init">[docs]</a>
    119. 

  119. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="s2">&quot;FaviconCacheConfig&quot;</span><span class="p">):</span>
    120. 

  120. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialization of a global ``CACHE``&quot;&quot;&quot;</span>
    121. 

  121. 

  122.     <span class="k">global</span> <span class="n">CACHE</span>  <span class="c1"># pylint: disable=global-statement</span>
    123. 

  123.     <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span> <span class="o">==</span> <span class="s2">&quot;sqlite&quot;</span><span class="p">:</span>
    124. 

  124.         <span class="k">if</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version_info</span> <span class="o">&lt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">35</span><span class="p">):</span>
    125. 

  125.             <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    126. 

  126.                 <span class="s2">&quot;Disable favicon caching completely: SQLite library (</span><span class="si">%s</span><span class="s2">) is too old! (require &gt;= 3.35)&quot;</span><span class="p">,</span>
    127. 

  127.                 <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version</span><span class="p">,</span>
    128. 

  128.             <span class="p">)</span>
    129. 

  129.             <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheNull</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
    130. 

  130.         <span class="k">else</span><span class="p">:</span>
    131. 

  131.             <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheSQLite</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
    132. 

  132.     <span class="k">elif</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span> <span class="o">==</span> <span class="s2">&quot;mem&quot;</span><span class="p">:</span>
    133. 

  133.         <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">&quot;Favicons are cached in memory, don&#39;t use this in production!&quot;</span><span class="p">)</span>
    134. 

  134.         <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheMEM</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
    135. 

  135.     <span class="k">else</span><span class="p">:</span>
    136. 

  136.         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;favicons db_type &#39;</span><span class="si">{</span><span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span><span class="si">}</span><span class="s2">&#39; is unknown&quot;</span><span class="p">)</span></div>
    137. 

  137. 

  138. 

  139. 

  140. <div class="viewcode-block" id="FaviconCacheConfig">
    141. 

  141. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheConfig">[docs]</a>
    142. 

  142. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
    143. 

  143. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration of the favicon cache.&quot;&quot;&quot;</span>
    144. 

  144. 

  145.     <span class="n">db_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;sqlite&quot;</span><span class="p">,</span> <span class="s2">&quot;mem&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;sqlite&quot;</span>
    146. 

  146. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of the database:</span>
    147. 

  147. 

  148. <span class="sd">    ``sqlite``:</span>
    149. 

  149. <span class="sd">      :py:obj:`.cache.FaviconCacheSQLite`</span>
    150. 

  150. 

  151. <span class="sd">    ``mem``:</span>
    152. 

  152. <span class="sd">      :py:obj:`.cache.FaviconCacheMEM` (not recommended)</span>
    153. 

  153. <span class="sd">    &quot;&quot;&quot;</span>
    154. 

  154. 

  155.     <span class="n">db_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">gettempdir</span><span class="p">()</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="s2">&quot;faviconcache.db&quot;</span>
    156. 

  156. <span class="w">    </span><span class="sd">&quot;&quot;&quot;URL of the SQLite DB, the path to the database file.&quot;&quot;&quot;</span>
    157. 

  157. 

  158.     <span class="n">HOLD_TIME</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span>  <span class="c1"># 30 days</span>
    159. 

  159. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Hold time (default in sec.), after which a BLOB is removed from the cache.&quot;&quot;&quot;</span>
    160. 

  160. 

  161.     <span class="n">LIMIT_TOTAL_BYTES</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">50</span>  <span class="c1"># 50 MB</span>
    162. 

  162. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Maximum of bytes (default) stored in the cache of all blobs.  Note: The</span>
    163. 

  163. <span class="sd">    limit is only reached at each maintenance interval after which the oldest</span>
    164. 

  164. <span class="sd">    BLOBs are deleted; the limit is exceeded during the maintenance period. If</span>
    165. 

  165. <span class="sd">    the maintenance period is *too long* or maintenance is switched off</span>
    166. 

  166. <span class="sd">    completely, the cache grows uncontrollably.&quot;&quot;&quot;</span>
    167. 

  167. 

  168.     <span class="n">BLOB_MAX_BYTES</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">20</span>  <span class="c1"># 20 KB</span>
    169. 

  169. <span class="w">    </span><span class="sd">&quot;&quot;&quot;The maximum BLOB size in bytes that a favicon may have so that it can be</span>
    170. 

  170. <span class="sd">    saved in the cache.  If the favicon is larger, it is not saved in the cache</span>
    171. 

  171. <span class="sd">    and must be requested by the client via the proxy.&quot;&quot;&quot;</span>
    172. 

  172. 

  173.     <span class="n">MAINTENANCE_PERIOD</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span>
    174. 

  174. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Maintenance period in seconds / when :py:obj:`MAINTENANCE_MODE` is set to</span>
    175. 

  175. <span class="sd">    ``auto``.&quot;&quot;&quot;</span>
    176. 

  176. 

  177.     <span class="n">MAINTENANCE_MODE</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;auto&quot;</span><span class="p">,</span> <span class="s2">&quot;off&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;auto&quot;</span>
    178. 

  178. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of maintenance mode</span>
    179. 

  179. 

  180. <span class="sd">    ``auto``:</span>
    181. 

  181. <span class="sd">      Maintenance is carried out automatically as part of the maintenance</span>
    182. 

  182. <span class="sd">      intervals (:py:obj:`MAINTENANCE_PERIOD`); no external process is required.</span>
    183. 

  183. 

  184. <span class="sd">    ``off``:</span>
    185. 

  185. <span class="sd">      Maintenance is switched off and must be carried out by an external process</span>
    186. 

  186. <span class="sd">      if required.</span>
    187. 

  187. <span class="sd">    &quot;&quot;&quot;</span></div>
    188. 

  188. 

  189. 

  190. 

  191. <div class="viewcode-block" id="FaviconCacheStats">
    192. 

  192. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheStats">[docs]</a>
    193. 

  193. <span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
    194. 

  194. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheStats</span><span class="p">:</span>
    195. 

  195. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Dataclass wich provides information on the status of the cache.&quot;&quot;&quot;</span>
    196. 

  196. 

  197.     <span class="n">favicons</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    198. 

  198.     <span class="nb">bytes</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    199. 

  199.     <span class="n">domains</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    200. 

  200.     <span class="n">resolvers</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    201. 

  201. 

  202.     <span class="n">field_descr</span> <span class="o">=</span> <span class="p">(</span>
    203. 

  203.         <span class="p">(</span><span class="s2">&quot;favicons&quot;</span><span class="p">,</span> <span class="s2">&quot;number of favicons in cache&quot;</span><span class="p">,</span> <span class="n">humanize_number</span><span class="p">),</span>
    204. 

  204.         <span class="p">(</span><span class="s2">&quot;bytes&quot;</span><span class="p">,</span> <span class="s2">&quot;total size (approx. bytes) of cache&quot;</span><span class="p">,</span> <span class="n">humanize_bytes</span><span class="p">),</span>
    205. 

  205.         <span class="p">(</span><span class="s2">&quot;domains&quot;</span><span class="p">,</span> <span class="s2">&quot;total number of domains in cache&quot;</span><span class="p">,</span> <span class="n">humanize_number</span><span class="p">),</span>
    206. 

  206.         <span class="p">(</span><span class="s2">&quot;resolvers&quot;</span><span class="p">,</span> <span class="s2">&quot;number of resolvers&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
    207. 

  207.     <span class="p">)</span>
    208. 

  208. 

  209.     <span class="k">def</span><span class="w"> </span><span class="fm">__sub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
    210. 

  210.         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">):</span>
    211. 

  211.             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;unsupported operand type(s) for +: &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="si">}</span><span class="s2">&#39; and &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
    212. 

  212.         <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
    213. 

  213.         <span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">field_descr</span><span class="p">:</span>
    214. 

  214.             <span class="n">self_val</span><span class="p">,</span> <span class="n">other_val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">),</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span>
    215. 

  215.             <span class="k">if</span> <span class="kc">None</span> <span class="ow">in</span> <span class="p">(</span><span class="n">self_val</span><span class="p">,</span> <span class="n">other_val</span><span class="p">):</span>
    216. 

  216.                 <span class="k">continue</span>
    217. 

  217.             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">self_val</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
    218. 

  218.                 <span class="n">kwargs</span><span class="p">[</span><span class="n">field</span><span class="p">]</span> <span class="o">=</span> <span class="n">self_val</span> <span class="o">-</span> <span class="n">other_val</span>
    219. 

  219.             <span class="k">else</span><span class="p">:</span>
    220. 

  220.                 <span class="n">kwargs</span><span class="p">[</span><span class="n">field</span><span class="p">]</span> <span class="o">=</span> <span class="n">self_val</span>
    221. 

  221.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    222. 

  222. 

  223.     <span class="k">def</span><span class="w"> </span><span class="nf">report</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fmt</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{descr}</span><span class="s2">: </span><span class="si">{val}</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">):</span>
    224. 

  224.         <span class="n">s</span> <span class="o">=</span> <span class="p">[]</span>
    225. 

  225.         <span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="n">cast</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">field_descr</span><span class="p">:</span>
    226. 

  226.             <span class="n">val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span>
    227. 

  227.             <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    228. 

  228.                 <span class="n">val</span> <span class="o">=</span> <span class="s2">&quot;--&quot;</span>
    229. 

  229.             <span class="k">else</span><span class="p">:</span>
    230. 

  230.                 <span class="n">val</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
    231. 

  231.             <span class="n">s</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fmt</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">descr</span><span class="o">=</span><span class="n">descr</span><span class="p">,</span> <span class="n">val</span><span class="o">=</span><span class="n">val</span><span class="p">))</span>
    232. 

  232.         <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
    233. 

  233. 

  234. 

  235. 

  236. <div class="viewcode-block" id="FaviconCache">
    237. 

  237. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache">[docs]</a>
    238. 

  238. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCache</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
    239. 

  239. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class for the implementation of a favicon cache.&quot;&quot;&quot;</span>
    240. 

  240. 

  241.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    242. 

  242.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
    243. 

  243. <span class="w">        </span><span class="sd">&quot;&quot;&quot;An instance of the favicon cache is build up from the configuration.&quot;&quot;&quot;</span>
    244. 

  244. 

  245.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    246. 

  246.     <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
    247. 

  247. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns ``None`` or the tuple of ``(data, mime)`` that has been</span>
    248. 

  248. <span class="sd">        registered in the cache.  The ``None`` indicates that there was no entry</span>
    249. 

  249. <span class="sd">        in the cache.&quot;&quot;&quot;</span>
    250. 

  250. 

  251. <div class="viewcode-block" id="FaviconCache.set">
    252. 

  252. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.set">[docs]</a>
    253. 

  253.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    254. 

  254.     <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    255. 

  255. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set data and mime-type in the cache.  If data is None, the</span>
    256. 

  256. <span class="sd">        :py:obj:`FALLBACK_ICON` is registered. in the cache.&quot;&quot;&quot;</span></div>
    257. 

  257. 

  258. 

  259. <div class="viewcode-block" id="FaviconCache.state">
    260. 

  260. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.state">[docs]</a>
    261. 

  261.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    262. 

  262.     <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
    263. 

  263. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a :py:obj:`FaviconCacheStats` (key/values) with information</span>
    264. 

  264. <span class="sd">        on the state of the cache.&quot;&quot;&quot;</span></div>
    265. 

  265. 

  266. 

  267. <div class="viewcode-block" id="FaviconCache.maintenance">
    268. 

  268. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.maintenance">[docs]</a>
    269. 

  269.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    270. 

  270.     <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    271. 

  271. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Performs maintenance on the cache&quot;&quot;&quot;</span></div>
    272. 

  272. </div>
    273. 

  273. 

  274. 

  275. 

  276. <div class="viewcode-block" id="FaviconCacheNull">
    277. 

  277. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull">[docs]</a>
    278. 

  278. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheNull</span><span class="p">(</span><span class="n">FaviconCache</span><span class="p">):</span>
    279. 

  279. <span class="w">    </span><span class="sd">&quot;&quot;&quot;A dummy favicon cache that caches nothing / a fallback solution. The</span>
    280. 

  280. <span class="sd">    NullCache is used when more efficient caches such as the</span>
    281. 

  281. <span class="sd">    :py:obj:`FaviconCacheSQLite` cannot be used because, for example, the SQLite</span>
    282. 

  282. <span class="sd">    library is only available in an old version and does not meet the</span>
    283. 

  283. <span class="sd">    requirements.&quot;&quot;&quot;</span>
    284. 

  284. 

  285.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
    286. 

  286.         <span class="k">return</span> <span class="kc">None</span>
    287. 

  287. 

  288.     <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
    289. 

  289.         <span class="k">return</span> <span class="kc">None</span>
    290. 

  290. 

  291. <div class="viewcode-block" id="FaviconCacheNull.set">
    292. 

  292. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.set">[docs]</a>
    293. 

  293.     <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    294. 

  294.         <span class="k">return</span> <span class="kc">False</span></div>
    295. 

  295. 

  296. 

  297. <div class="viewcode-block" id="FaviconCacheNull.state">
    298. 

  298. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.state">[docs]</a>
    299. 

  299.     <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    300. 

  300.         <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span><span class="n">favicons</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></div>
    301. 

  301. 

  302. 

  303. <div class="viewcode-block" id="FaviconCacheNull.maintenance">
    304. 

  304. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.maintenance">[docs]</a>
    305. 

  305.     <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    306. 

  306.         <span class="k">pass</span></div>
    307. 

  307. </div>
    308. 

  308. 

  309. 

  310. 

  311. <div class="viewcode-block" id="FaviconCacheSQLite">
    312. 

  312. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite">[docs]</a>
    313. 

  313. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheSQLite</span><span class="p">(</span><span class="n">sqlitedb</span><span class="o">.</span><span class="n">SQLiteAppl</span><span class="p">,</span> <span class="n">FaviconCache</span><span class="p">):</span>
    314. 

  314. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon cache that manages the favicon BLOBs in a SQLite DB.  The DB</span>
    315. 

  315. <span class="sd">    model in the SQLite DB is implemented using the abstract class</span>
    316. 

  316. <span class="sd">    :py:obj:`sqlitedb.SQLiteAppl`.</span>
    317. 

  317. 

  318. <span class="sd">    The following configurations are required / supported:</span>
    319. 

  319. 

  320. <span class="sd">    - :py:obj:`FaviconCacheConfig.db_url`</span>
    321. 

  321. <span class="sd">    - :py:obj:`FaviconCacheConfig.HOLD_TIME`</span>
    322. 

  322. <span class="sd">    - :py:obj:`FaviconCacheConfig.LIMIT_TOTAL_BYTES`</span>
    323. 

  323. <span class="sd">    - :py:obj:`FaviconCacheConfig.BLOB_MAX_BYTES`</span>
    324. 

  324. <span class="sd">    - :py:obj:`MAINTENANCE_PERIOD`</span>
    325. 

  325. <span class="sd">    - :py:obj:`MAINTENANCE_MODE`</span>
    326. 

  326. <span class="sd">    &quot;&quot;&quot;</span>
    327. 

  327. 

  328.     <span class="n">DB_SCHEMA</span> <span class="o">=</span> <span class="mi">1</span>
    329. 

  329. 

  330.     <span class="n">DDL_BLOBS</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
    331. 

  331. <span class="s2">CREATE TABLE IF NOT EXISTS blobs (</span>
    332. 

  332. <span class="s2">  sha256     TEXT,</span>
    333. 

  333. <span class="s2">  bytes_c    INTEGER,</span>
    334. 

  334. <span class="s2">  mime       TEXT NOT NULL,</span>
    335. 

  335. <span class="s2">  data       BLOB NOT NULL,</span>
    336. 

  336. <span class="s2">  PRIMARY KEY (sha256))&quot;&quot;&quot;</span>
    337. 

  337. 

  338. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to store BLOB objects by their sha256 hash values.&quot;&quot;&quot;</span>
    339. 

  339. 

  340.     <span class="n">DDL_BLOB_MAP</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
    341. 

  341. <span class="s2">CREATE TABLE IF NOT EXISTS blob_map (</span>
    342. 

  342. <span class="s2">    m_time     INTEGER DEFAULT (strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)),  -- last modified (unix epoch) time in sec.</span>
    343. 

  343. <span class="s2">    sha256     TEXT,</span>
    344. 

  344. <span class="s2">    resolver   TEXT,</span>
    345. 

  345. <span class="s2">    authority  TEXT,</span>
    346. 

  346. <span class="s2">    PRIMARY KEY (resolver, authority))&quot;&quot;&quot;</span>
    347. 

  347. 

  348. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to map from (resolver, authority) to sha256 hash values.&quot;&quot;&quot;</span>
    349. 

  349. 

  350.     <span class="n">DDL_CREATE_TABLES</span> <span class="o">=</span> <span class="p">{</span>
    351. 

  351.         <span class="s2">&quot;blobs&quot;</span><span class="p">:</span> <span class="n">DDL_BLOBS</span><span class="p">,</span>
    352. 

  352.         <span class="s2">&quot;blob_map&quot;</span><span class="p">:</span> <span class="n">DDL_BLOB_MAP</span><span class="p">,</span>
    353. 

  353.     <span class="p">}</span>
    354. 

  354. 

  355.     <span class="n">SQL_DROP_LEFTOVER_BLOBS</span> <span class="o">=</span> <span class="p">(</span>
    356. 

  356.         <span class="s2">&quot;DELETE FROM blobs WHERE sha256 IN (&quot;</span>
    357. 

  357.         <span class="s2">&quot; SELECT b.sha256&quot;</span>
    358. 

  358.         <span class="s2">&quot;   FROM blobs b&quot;</span>
    359. 

  359.         <span class="s2">&quot;   LEFT JOIN blob_map bm&quot;</span>
    360. 

  360.         <span class="s2">&quot;     ON b.sha256 = bm.sha256&quot;</span>
    361. 

  361.         <span class="s2">&quot;  WHERE bm.sha256 IS NULL)&quot;</span>
    362. 

  362.     <span class="p">)</span>
    363. 

  363. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Delete blobs.sha256 (BLOBs) no longer in blob_map.sha256.&quot;&quot;&quot;</span>
    364. 

  364. 

  365.     <span class="n">SQL_ITER_BLOBS_SHA256_BYTES_C</span> <span class="o">=</span> <span class="p">(</span>
    366. 

  366.         <span class="s2">&quot;SELECT b.sha256, b.bytes_c FROM blobs b&quot;</span>
    367. 

  367.         <span class="s2">&quot;  JOIN blob_map bm &quot;</span>
    368. 

  368.         <span class="s2">&quot;    ON b.sha256 = bm.sha256&quot;</span>
    369. 

  369.         <span class="s2">&quot; ORDER BY bm.m_time ASC&quot;</span>
    370. 

  370.     <span class="p">)</span>
    371. 

  371. 

  372.     <span class="n">SQL_INSERT_BLOBS</span> <span class="o">=</span> <span class="p">(</span>
    373. 

  373.         <span class="s2">&quot;INSERT INTO blobs (sha256, bytes_c, mime, data) VALUES (?, ?, ?, ?)&quot;</span>
    374. 

  374.         <span class="s2">&quot;    ON CONFLICT (sha256) DO NOTHING&quot;</span>
    375. 

  375.     <span class="p">)</span>  <span class="c1"># fmt: skip</span>
    376. 

  376. 

  377.     <span class="n">SQL_INSERT_BLOB_MAP</span> <span class="o">=</span> <span class="p">(</span>
    378. 

  378.         <span class="s2">&quot;INSERT INTO blob_map (sha256, resolver, authority) VALUES (?, ?, ?)&quot;</span>
    379. 

  379.         <span class="s2">&quot;    ON CONFLICT DO UPDATE &quot;</span>
    380. 

  380.         <span class="s2">&quot;   SET sha256=excluded.sha256, m_time=strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)&quot;</span>
    381. 

  381.     <span class="p">)</span>
    382. 

  382. 

  383.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
    384. 

  384. <span class="w">        </span><span class="sd">&quot;&quot;&quot;An instance of the favicon cache is build up from the configuration.&quot;&quot;&quot;</span>  <span class="c1">#</span>
    385. 

  385. 

  386.         <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_url</span> <span class="o">==</span> <span class="s2">&quot;:memory:&quot;</span><span class="p">:</span>
    387. 

  387.             <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s2">&quot;don&#39;t use SQLite DB in :memory: in production!!&quot;</span><span class="p">)</span>
    388. 

  388.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
    389. 

  389.         <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
    390. 

  390. 

  391.     <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
    392. 

  392. 

  393.         <span class="n">sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT sha256 FROM blob_map WHERE resolver = ? AND authority = ?&quot;</span>
    394. 

  394.         <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    395. 

  395.         <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    396. 

  396.             <span class="k">return</span> <span class="kc">None</span>
    397. 

  397. 

  398.         <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    399. 

  399.         <span class="n">sha256</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    400. 

  400.         <span class="k">if</span> <span class="n">sha256</span> <span class="o">==</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
    401. 

  401.             <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
    402. 

  402. 

  403.         <span class="n">sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT data, mime FROM blobs WHERE sha256 = ?&quot;</span>
    404. 

  404.         <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    405. 

  405.         <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    406. 

  406.             <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">res</span>
    407. 

  407.         <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
    408. 

  408. 

  409. <div class="viewcode-block" id="FaviconCacheSQLite.set">
    410. 

  410. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.set">[docs]</a>
    411. 

  411.     <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    412. 

  412. 

  413.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">MAINTENANCE_MODE</span> <span class="o">==</span> <span class="s2">&quot;auto&quot;</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">next_maintenance_time</span><span class="p">:</span>
    414. 

  414.             <span class="c1"># Should automatic maintenance be moved to a new thread?</span>
    415. 

  415.             <span class="bp">self</span><span class="o">.</span><span class="n">maintenance</span><span class="p">()</span>
    416. 

  416. 

  417.         <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    418. 

  418.             <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
    419. 

  419.                 <span class="s2">&quot;favicon resolver </span><span class="si">%s</span><span class="s2"> tries to cache mime-type None for authority </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span>
    420. 

  420.                 <span class="n">resolver</span><span class="p">,</span>
    421. 

  421.                 <span class="n">authority</span><span class="p">,</span>
    422. 

  422.             <span class="p">)</span>
    423. 

  423.             <span class="k">return</span> <span class="kc">False</span>
    424. 

  424. 

  425.         <span class="n">bytes_c</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span> <span class="ow">or</span> <span class="sa">b</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
    426. 

  426.         <span class="k">if</span> <span class="n">bytes_c</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">BLOB_MAX_BYTES</span><span class="p">:</span>
    427. 

  427.             <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
    428. 

  428.                 <span class="s2">&quot;favicon of resolver: </span><span class="si">%s</span><span class="s2"> / authority: </span><span class="si">%s</span><span class="s2"> to big to cache (bytes: </span><span class="si">%s</span><span class="s2">) &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">,</span> <span class="n">bytes_c</span><span class="p">)</span>
    429. 

  429.             <span class="p">)</span>
    430. 

  430.             <span class="k">return</span> <span class="kc">False</span>
    431. 

  431. 

  432.         <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    433. 

  433.             <span class="n">sha256</span> <span class="o">=</span> <span class="n">FALLBACK_ICON</span>
    434. 

  434.         <span class="k">else</span><span class="p">:</span>
    435. 

  435.             <span class="n">sha256</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
    436. 

  436. 

  437.         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
    438. 

  438.             <span class="k">if</span> <span class="n">sha256</span> <span class="o">!=</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
    439. 

  439.                 <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_INSERT_BLOBS</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,</span> <span class="n">bytes_c</span><span class="p">,</span> <span class="n">mime</span><span class="p">,</span> <span class="n">data</span><span class="p">))</span>
    440. 

  440.             <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_INSERT_BLOB_MAP</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,</span> <span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">))</span>
    441. 

  441. 

  442.         <span class="k">return</span> <span class="kc">True</span></div>
    443. 

  443. 

  444. 

  445.     <span class="nd">@property</span>
    446. 

  446.     <span class="k">def</span><span class="w"> </span><span class="nf">next_maintenance_time</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
    447. 

  447. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns (unix epoch) time of the next maintenance.&quot;&quot;&quot;</span>
    448. 

  448. 

  449.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">MAINTENANCE_PERIOD</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">m_time</span><span class="p">(</span><span class="s2">&quot;LAST_MAINTENANCE&quot;</span><span class="p">)</span>
    450. 

  450. 

  451. <div class="viewcode-block" id="FaviconCacheSQLite.maintenance">
    452. 

  452. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.maintenance">[docs]</a>
    453. 

  453.     <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    454. 

  454. 

  455.         <span class="c1"># Prevent parallel DB maintenance cycles from other DB connections</span>
    456. 

  456.         <span class="c1"># (e.g. in multi thread or process environments).</span>
    457. 

  457. 

  458.         <span class="k">if</span> <span class="ow">not</span> <span class="n">force</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">next_maintenance_time</span><span class="p">:</span>
    459. 

  459.             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;no maintenance required yet, next maintenance interval is in the future&quot;</span><span class="p">)</span>
    460. 

  460.             <span class="k">return</span>
    461. 

  461.         <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;LAST_MAINTENANCE&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>  <span class="c1"># hint: this (also) sets the m_time of the property!</span>
    462. 

  462. 

  463.         <span class="c1"># do maintenance tasks</span>
    464. 

  464. 

  465.         <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
    466. 

  466. 

  467.             <span class="c1"># drop items not in HOLD time</span>
    468. 

  468.             <span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
    469. 

  469.                 <span class="sa">f</span><span class="s2">&quot;DELETE FROM blob_map&quot;</span>
    470. 

  470.                 <span class="sa">f</span><span class="s2">&quot; WHERE cast(m_time as integer) &lt; cast(strftime(&#39;%s&#39;, &#39;now&#39;) as integer) - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">HOLD_TIME</span><span class="si">}</span><span class="s2">&quot;</span>
    471. 

  471.             <span class="p">)</span>
    472. 

  472.             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> obsolete blob_map items from db&quot;</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">rowcount</span><span class="p">)</span>
    473. 

  473.             <span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_DROP_LEFTOVER_BLOBS</span><span class="p">)</span>
    474. 

  474.             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> obsolete BLOBS from db&quot;</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">rowcount</span><span class="p">)</span>
    475. 

  475. 

  476.             <span class="c1"># drop old items to be in LIMIT_TOTAL_BYTES</span>
    477. 

  477.             <span class="n">total_bytes</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;SELECT SUM(bytes_c) FROM blobs&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="mi">0</span>
    478. 

  478.             <span class="k">if</span> <span class="n">total_bytes</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">LIMIT_TOTAL_BYTES</span><span class="p">:</span>
    479. 

  479. 

  480.                 <span class="n">x</span> <span class="o">=</span> <span class="n">total_bytes</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">LIMIT_TOTAL_BYTES</span>
    481. 

  481.                 <span class="n">c</span> <span class="o">=</span> <span class="mi">0</span>
    482. 

  482.                 <span class="n">sha_list</span> <span class="o">=</span> <span class="p">[]</span>
    483. 

  483.                 <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_ITER_BLOBS_SHA256_BYTES_C</span><span class="p">):</span>
    484. 

  484.                     <span class="n">sha256</span><span class="p">,</span> <span class="n">bytes_c</span> <span class="o">=</span> <span class="n">row</span>
    485. 

  485.                     <span class="n">sha_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sha256</span><span class="p">)</span>
    486. 

  486.                     <span class="n">c</span> <span class="o">+=</span> <span class="n">bytes_c</span>
    487. 

  487.                     <span class="k">if</span> <span class="n">c</span> <span class="o">&gt;</span> <span class="n">x</span><span class="p">:</span>
    488. 

  488.                         <span class="k">break</span>
    489. 

  489.                 <span class="k">if</span> <span class="n">sha_list</span><span class="p">:</span>
    490. 

  490.                     <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;DELETE FROM blobs WHERE sha256 IN (&#39;</span><span class="si">%s</span><span class="s2">&#39;)&quot;</span> <span class="o">%</span> <span class="s2">&quot;&#39;,&#39;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sha_list</span><span class="p">))</span>
    491. 

  491.                     <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;DELETE FROM blob_map WHERE sha256 IN (&#39;</span><span class="si">%s</span><span class="s2">&#39;)&quot;</span> <span class="o">%</span> <span class="s2">&quot;&#39;,&#39;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sha_list</span><span class="p">))</span>
    492. 

  492.                     <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> blobs with total size of </span><span class="si">%s</span><span class="s2"> bytes&quot;</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">sha_list</span><span class="p">),</span> <span class="n">c</span><span class="p">)</span></div>
    493. 

  493. 

  494. 

  495.     <span class="k">def</span><span class="w"> </span><span class="nf">_query_val</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    496. 

  496.         <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    497. 

  497.         <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    498. 

  498.             <span class="n">val</span> <span class="o">=</span> <span class="n">val</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    499. 

  499.         <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    500. 

  500.             <span class="n">val</span> <span class="o">=</span> <span class="n">default</span>
    501. 

  501.         <span class="k">return</span> <span class="n">val</span>
    502. 

  502. 

  503. <div class="viewcode-block" id="FaviconCacheSQLite.state">
    504. 

  504. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.state">[docs]</a>
    505. 

  505.     <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
    506. 

  506.         <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span>
    507. 

  507.             <span class="n">favicons</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM blobs&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
    508. 

  508.             <span class="nb">bytes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT SUM(bytes_c) FROM blobs&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
    509. 

  509.             <span class="n">domains</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM (SELECT authority FROM blob_map GROUP BY authority)&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
    510. 

  510.             <span class="n">resolvers</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM (SELECT resolver FROM blob_map GROUP BY resolver)&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
    511. 

  511.         <span class="p">)</span></div>
    512. 

  512. </div>
    513. 

  513. 

  514. 

  515. 

  516. <div class="viewcode-block" id="FaviconCacheMEM">
    517. 

  517. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM">[docs]</a>
    518. 

  518. <span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheMEM</span><span class="p">(</span><span class="n">FaviconCache</span><span class="p">):</span>
    519. 

  519. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon cache in process&#39; memory.  Its just a POC that stores the</span>
    520. 

  520. <span class="sd">    favicons in the memory of the process.</span>
    521. 

  521. 

  522. <span class="sd">    .. attention::</span>
    523. 

  523. 

  524. <span class="sd">       Don&#39;t use it in production, it will blow up your memory!!</span>
    525. 

  525. 

  526. <span class="sd">    &quot;&quot;&quot;</span>
    527. 

  527. 

  528.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">):</span>
    529. 

  529. 

  530.         <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
    531. 

  531.         <span class="bp">self</span><span class="o">.</span><span class="n">_data</span> <span class="o">=</span> <span class="p">{}</span>
    532. 

  532.         <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span> <span class="o">=</span> <span class="p">{}</span>
    533. 

  533. 

  534.     <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]:</span>
    535. 

  535. 

  536.         <span class="n">sha</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">resolver</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">authority</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
    537. 

  537.         <span class="k">if</span> <span class="n">sha</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    538. 

  538.             <span class="k">return</span> <span class="kc">None</span>
    539. 

  539.         <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sha</span><span class="p">)</span>
    540. 

  540.         <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
    541. 

  541.             <span class="n">data</span> <span class="o">=</span> <span class="kc">None</span>
    542. 

  542.         <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
    543. 

  543. 

  544. <div class="viewcode-block" id="FaviconCacheMEM.set">
    545. 

  545. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.set">[docs]</a>
    546. 

  546.     <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    547. 

  547. 

  548.         <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    549. 

  549.             <span class="n">data</span> <span class="o">=</span> <span class="n">FALLBACK_ICON</span>
    550. 

  550.             <span class="n">mime</span> <span class="o">=</span> <span class="kc">None</span>
    551. 

  551. 

  552.         <span class="k">elif</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    553. 

  553.             <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
    554. 

  554.                 <span class="s2">&quot;favicon resolver </span><span class="si">%s</span><span class="s2"> tries to cache mime-type None for authority </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span>
    555. 

  555.                 <span class="n">resolver</span><span class="p">,</span>
    556. 

  556.                 <span class="n">authority</span><span class="p">,</span>
    557. 

  557.             <span class="p">)</span>
    558. 

  558.             <span class="k">return</span> <span class="kc">False</span>
    559. 

  559. 

  560.         <span class="n">digest</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
    561. 

  561.         <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="n">digest</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span>
    562. 

  562.         <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">resolver</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">authority</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">digest</span><span class="p">,</span> <span class="n">mime</span><span class="p">)</span>
    563. 

  563.         <span class="k">return</span> <span class="kc">True</span></div>
    564. 

  564. 

  565. 

  566. <div class="viewcode-block" id="FaviconCacheMEM.state">
    567. 

  567. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.state">[docs]</a>
    568. 

  568.     <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    569. 

  569.         <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span><span class="n">favicons</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span></div>
    570. 

  570. 

  571. 

  572. <div class="viewcode-block" id="FaviconCacheMEM.maintenance">
    573. 

  573. <a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.maintenance">[docs]</a>
    574. 

  574.     <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
    575. 

  575.         <span class="k">pass</span></div>
    576. 

  576. </div>
    577. 

  577. 

  578. </pre></div>
    579. 

  579. 

  580.             <div class="clearer"></div>
    581. 

  581.           </div>
    582. 

  582.         </div>
    583. 

  583.       </div>
    584. 

  584.   <span id="sidebar-top"></span>
    585. 

  585.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    586. 

  586.         <div class="sphinxsidebarwrapper">
    587. 

  587.   
    588. 

  588.     
    589. 

  589.             <p class="logo"><a href="../../../index.html">
    590. 

  590.               <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
    591. 

  591.             </a></p>
    592. 

  592.   
    593. 

  593. 

  594. <h3><a href="../../../index.html">Table of Contents</a></h3>
    595. 

  595. <ul>
    596. 

  596. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
    597. 

  597. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
    598. 

  598. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
    599. 

  599. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
    600. 

  600. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
    601. 

  601. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
    602. 

  602. </ul>
    603. 

  603. 

  604.   <h3>Project Links</h3>
    605. 

  605.   <ul>
    606. 

  606.     <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
    607. 

  607.   
    608. 

  608.     <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
    609. 

  609.   
    610. 

  610.     <li><a href="https://searx.space">Public instances</a>
    611. 

  611.   
    612. 

  612.     <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
    613. 

  613.   </ul><h3>Navigation</h3>
    614. 

  614. <ul>
    615. 

  615.   <li><a href="../../../index.html">Overview</a>
    616. 

  616.     <ul>
    617. 

  617.       <li><a href="../../index.html">Module code</a>
    618. 

  618.         
    619. 

  619.           
    620. 

  620.           </ul>
    621. 

  621.       </li>
    622. 

  622.     </ul>
    623. 

  623.   </li>
    624. 

  624. </ul>
    625. 

  625. <search id="searchbox" style="display: none" role="search">
    626. 

  626.   <h3 id="searchlabel">Quick search</h3>
    627. 

  627.     <div class="searchformwrapper">
    628. 

  628.     <form class="search" action="../../../search.html" method="get">
    629. 

  629.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    630. 

  630.       <input type="submit" value="Go" />
    631. 

  631.     </form>
    632. 

  632.     </div>
    633. 

  633. </search>
    634. 

  634. <script>document.getElementById('searchbox').style.display = "block"</script>
    635. 

  635.         </div>
    636. 

  636.       </div>
    637. 

  637.       <div class="clearer"></div>
    638. 

  638.     </div>
    639. 

  639.     <div class="footer" role="contentinfo">
    640. 

  640.     &#169; Copyright SearXNG team.
    641. 

  641.     </div>
    642. 

  642.   </body>
    643. 

  643. </html>
    644.
© 2025 NTab仓库
Page: 185ms Template: 1ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website