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

cache.html 61 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560 
  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.cache &#8212; SearXNG Documentation (2025.5.5+0315988f5)</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=6bec52eb"></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.5.5+0315988f5" 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.5.5+0315988f5)</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.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.cache</h1><div class="highlight"><pre>
    39. 

  39. <span></span><span class="sd">&quot;&quot;&quot;Implementation of caching solutions.</span>
    40. 

  40. 

  41. <span class="sd">- :py:obj:`searx.cache.ExpireCache` and its :py:obj:`searx.cache.ExpireCacheCfg`</span>
    42. 

  42. 

  43. <span class="sd">----</span>
    44. 

  44. <span class="sd">&quot;&quot;&quot;</span>
    45. 

  45. 

  46. <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>
    47. 

  47. 

  48. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;ExpireCacheCfg&quot;</span><span class="p">,</span> <span class="s2">&quot;ExpireCacheStats&quot;</span><span class="p">,</span> <span class="s2">&quot;ExpireCache&quot;</span><span class="p">,</span> <span class="s2">&quot;ExpireCacheSQLite&quot;</span><span class="p">]</span>
    49. 

  49. 

  50. <span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
    51. 

  51. <span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
    52. 

  52. <span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
    53. 

  53. <span class="kn">import</span><span class="w"> </span><span class="nn">hashlib</span>
    54. 

  54. <span class="kn">import</span><span class="w"> </span><span class="nn">hmac</span>
    55. 

  55. <span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
    56. 

  56. <span class="kn">import</span><span class="w"> </span><span class="nn">pickle</span>
    57. 

  57. <span class="kn">import</span><span class="w"> </span><span class="nn">sqlite3</span>
    58. 

  58. <span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
    59. 

  59. <span class="kn">import</span><span class="w"> </span><span class="nn">tempfile</span>
    60. 

  60. <span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
    61. 

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

  62. 

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

  64. 

  65. <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>
    66. 

  66. <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>
    67. 

  67. <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">get_setting</span>
    68. 

  68. 

  69. <span class="n">log</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="s2">&quot;cache&quot;</span><span class="p">)</span>
    70. 

  70. 

  71. 

  72. <div class="viewcode-block" id="ExpireCacheCfg">
    73. 

  73. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheCfg">[docs]</a>
    74. 

  74. <span class="k">class</span><span class="w"> </span><span class="nc">ExpireCacheCfg</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>
    75. 

  75. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration of a :py:obj:`ExpireCache` cache.&quot;&quot;&quot;</span>
    76. 

  76. 

  77.     <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
    78. 

  78. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the cache.&quot;&quot;&quot;</span>
    79. 

  79. 

  80.     <span class="n">db_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
    81. 

  81. <span class="w">    </span><span class="sd">&quot;&quot;&quot;URL of the SQLite DB, the path to the database file.  If unset a default</span>
    82. 

  82. <span class="sd">    DB will be created in `/tmp/sxng_cache_{self.name}.db`&quot;&quot;&quot;</span>
    83. 

  83. 

  84.     <span class="n">MAX_VALUE_LEN</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">10</span>
    85. 

  85. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Max lenght of a *serialized* value.&quot;&quot;&quot;</span>
    86. 

  86. 

  87.     <span class="n">MAXHOLD_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">7</span>  <span class="c1"># 7 days</span>
    88. 

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

  89. 

  90.     <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>  <span class="c1"># 2h</span>
    91. 

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

  92. <span class="sd">    ``auto``.&quot;&quot;&quot;</span>
    93. 

  93. 

  94.     <span class="n">MAINTENANCE_MODE</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</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>
    95. 

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

  96. 

  97. <span class="sd">    ``auto``:</span>
    98. 

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

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

  100. 

  101. <span class="sd">    ``off``:</span>
    102. 

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

  103. <span class="sd">      if required.</span>
    104. 

  104. <span class="sd">    &quot;&quot;&quot;</span>
    105. 

  105. 

  106.     <span class="n">password</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;server.secret_key&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
    107. 

  107. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Password used by :py:obj:`ExpireCache.secret_hash`.</span>
    108. 

  108. 

  109. <span class="sd">    The default password is taken from :ref:`secret_key &lt;server.secret_key&gt;`.</span>
    110. 

  110. <span class="sd">    When the password is changed, the hashed keys in the cache can no longer be</span>
    111. 

  111. <span class="sd">    used, which is why all values in the cache are deleted when the password is</span>
    112. 

  112. <span class="sd">    changed.</span>
    113. 

  113. <span class="sd">    &quot;&quot;&quot;</span>
    114. 

  114. 

  115.     <span class="k">def</span><span class="w"> </span><span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    116. 

  116.         <span class="c1"># if db_url is unset, use a default DB in /tmp/sxng_cache_{name}.db</span>
    117. 

  117.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">:</span>
    118. 

  118.             <span class="bp">self</span><span class="o">.</span><span class="n">db_url</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="sa">f</span><span class="s2">&quot;sxng_cache_</span><span class="si">{</span><span class="n">ExpireCache</span><span class="o">.</span><span class="n">normalize_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="si">}</span><span class="s2">.db&quot;</span></div>
    119. 

  119. 

  120. 

  121. 

  122. <div class="viewcode-block" id="ExpireCacheStats">
    123. 

  123. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheStats">[docs]</a>
    124. 

  124. <span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
    125. 

  125. <span class="k">class</span><span class="w"> </span><span class="nc">ExpireCacheStats</span><span class="p">:</span>
    126. 

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

  127. 

  128.     <span class="n">cached_items</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="nb">int</span><span class="p">]]]</span>
    129. 

  129. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Values in the cache mapped by context name.</span>
    130. 

  130. 

  131. <span class="sd">    .. code: python</span>
    132. 

  132. 

  133. <span class="sd">       {</span>
    134. 

  134. <span class="sd">           &quot;context name&quot;: [</span>
    135. 

  135. <span class="sd">               (&quot;foo key&quot;: &quot;foo value&quot;, &lt;expire&gt;),</span>
    136. 

  136. <span class="sd">               (&quot;bar key&quot;: &quot;bar value&quot;, &lt;expire&gt;),</span>
    137. 

  137. <span class="sd">               # ...</span>
    138. 

  138. <span class="sd">           ],</span>
    139. 

  139. <span class="sd">           # ...</span>
    140. 

  140. <span class="sd">       }</span>
    141. 

  141. <span class="sd">    &quot;&quot;&quot;</span>
    142. 

  142. 

  143.     <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>
    144. 

  144.         <span class="n">c_ctx</span> <span class="o">=</span> <span class="mi">0</span>
    145. 

  145.         <span class="n">c_kv</span> <span class="o">=</span> <span class="mi">0</span>
    146. 

  146.         <span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span>
    147. 

  147. 

  148.         <span class="k">for</span> <span class="n">ctx_name</span><span class="p">,</span> <span class="n">kv_list</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cached_items</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    149. 

  149.             <span class="n">c_ctx</span> <span class="o">+=</span> <span class="mi">1</span>
    150. 

  150.             <span class="k">if</span> <span class="ow">not</span> <span class="n">kv_list</span><span class="p">:</span>
    151. 

  151.                 <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">ctx_name</span><span class="si">:</span><span class="s2">20s</span><span class="si">}</span><span class="s2">] empty&quot;</span><span class="p">)</span>
    152. 

  152.                 <span class="k">continue</span>
    153. 

  153. 

  154.             <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">expire</span> <span class="ow">in</span> <span class="n">kv_list</span><span class="p">:</span>
    155. 

  155.                 <span class="n">valid_until</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">expire</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S&quot;</span><span class="p">)</span>
    156. 

  156.                 <span class="n">c_kv</span> <span class="o">+=</span> <span class="mi">1</span>
    157. 

  157.                 <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">ctx_name</span><span class="si">:</span><span class="s2">20s</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="n">valid_until</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">key</span><span class="si">:</span><span class="s2">12</span><span class="si">}</span><span class="s2">&quot;</span> <span class="sa">f</span><span class="s2">&quot; --&gt; (</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">) </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2"> &quot;</span><span class="p">)</span>
    158. 

  158. 

  159.         <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Number of contexts: </span><span class="si">{</span><span class="n">c_ctx</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    160. 

  160.         <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;number of key/value pairs: </span><span class="si">{</span><span class="n">c_kv</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    161. 

  161.         <span class="k">return</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span></div>
    162. 

  162. 

  163. 

  164. 

  165. <div class="viewcode-block" id="ExpireCache">
    166. 

  166. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache">[docs]</a>
    167. 

  167. <span class="k">class</span><span class="w"> </span><span class="nc">ExpireCache</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
    168. 

  168. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class for the implementation of a key/value cache</span>
    169. 

  169. <span class="sd">    with expire date.&quot;&quot;&quot;</span>
    170. 

  170. 

  171.     <span class="n">cfg</span><span class="p">:</span> <span class="n">ExpireCacheCfg</span>
    172. 

  172. 

  173.     <span class="n">hash_token</span> <span class="o">=</span> <span class="s2">&quot;hash_token&quot;</span>
    174. 

  174. 

  175. <div class="viewcode-block" id="ExpireCache.set">
    176. 

  176. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.set">[docs]</a>
    177. 

  177.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    178. 

  178.     <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">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="n">expire</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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>
    179. 

  179. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set *key* to *value*.  To set a timeout on key use argument</span>
    180. 

  180. <span class="sd">        ``expire`` (in sec.).  If expire is unset the default is taken from</span>
    181. 

  181. <span class="sd">        :py:obj:`ExpireCacheCfg.MAXHOLD_TIME`.  After the timeout has expired,</span>
    182. 

  182. <span class="sd">        the key will automatically be deleted.</span>
    183. 

  183. 

  184. <span class="sd">        The ``ctx`` argument specifies the context of the ``key``.  A key is</span>
    185. 

  185. <span class="sd">        only unique in its context.</span>
    186. 

  186. 

  187. <span class="sd">        The concrete implementations of this abstraction determine how the</span>
    188. 

  188. <span class="sd">        context is mapped in the connected database.  In SQL databases, for</span>
    189. 

  189. <span class="sd">        example, the context is a DB table or in a Key/Value DB it could be</span>
    190. 

  190. <span class="sd">        a prefix for the key.</span>
    191. 

  191. 

  192. <span class="sd">        If the context is not specified (the default is ``None``) then a</span>
    193. 

  193. <span class="sd">        default context should be used, e.g. a default table for SQL databases</span>
    194. 

  194. <span class="sd">        or a default prefix in a Key/Value DB.</span>
    195. 

  195. <span class="sd">        &quot;&quot;&quot;</span></div>
    196. 

  196. 

  197. 

  198. <div class="viewcode-block" id="ExpireCache.get">
    199. 

  199. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.get">[docs]</a>
    200. 

  200.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    201. 

  201.     <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
    202. 

  202. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return *value* of *key*.  If key is unset, ``None`` is returned.&quot;&quot;&quot;</span></div>
    203. 

  203. 

  204. 

  205. <div class="viewcode-block" id="ExpireCache.maintenance">
    206. 

  206. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.maintenance">[docs]</a>
    207. 

  207.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    208. 

  208.     <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="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">truncate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    209. 

  209. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Performs maintenance on the cache.</span>
    210. 

  210. 

  211. <span class="sd">        ``force``:</span>
    212. 

  212. <span class="sd">          Maintenance should be carried out even if the maintenance interval has</span>
    213. 

  213. <span class="sd">          not yet been reached.</span>
    214. 

  214. 

  215. <span class="sd">        ``truncate``:</span>
    216. 

  216. <span class="sd">          Truncate the entire cache, which is necessary, for example, if the</span>
    217. 

  217. <span class="sd">          password has changed.</span>
    218. 

  218. <span class="sd">        &quot;&quot;&quot;</span></div>
    219. 

  219. 

  220. 

  221. <div class="viewcode-block" id="ExpireCache.state">
    222. 

  222. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.state">[docs]</a>
    223. 

  223.     <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
    224. 

  224.     <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">ExpireCacheStats</span><span class="p">:</span>
    225. 

  225. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a :py:obj:`ExpireCacheStats`, which provides information</span>
    226. 

  226. <span class="sd">        about the status of the cache.&quot;&quot;&quot;</span></div>
    227. 

  227. 

  228. 

  229. <div class="viewcode-block" id="ExpireCache.build_cache">
    230. 

  230. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.build_cache">[docs]</a>
    231. 

  231.     <span class="nd">@staticmethod</span>
    232. 

  232.     <span class="k">def</span><span class="w"> </span><span class="nf">build_cache</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="n">ExpireCacheCfg</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ExpireCache</span><span class="p">:</span>
    233. 

  233. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Factory to build a caching instance.</span>
    234. 

  234. 

  235. <span class="sd">        .. note::</span>
    236. 

  236. 

  237. <span class="sd">           Currently, only the SQLite adapter is available, but other database</span>
    238. 

  238. <span class="sd">           types could be implemented in the future, e.g. a Valkey (Redis)</span>
    239. 

  239. <span class="sd">           adapter.</span>
    240. 

  240. <span class="sd">        &quot;&quot;&quot;</span>
    241. 

  241.         <span class="k">return</span> <span class="n">ExpireCacheSQLite</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span></div>
    242. 

  242. 

  243. 

  244. <div class="viewcode-block" id="ExpireCache.normalize_name">
    245. 

  245. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.normalize_name">[docs]</a>
    246. 

  246.     <span class="nd">@staticmethod</span>
    247. 

  247.     <span class="k">def</span><span class="w"> </span><span class="nf">normalize_name</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    248. 

  248. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a normalized name that can be used as a file name or as a SQL</span>
    249. 

  249. <span class="sd">        table name (is used, for example, to normalize the context name).&quot;&quot;&quot;</span>
    250. 

  250. 

  251.         <span class="n">_valid</span> <span class="o">=</span> <span class="s2">&quot;-_.&quot;</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span>
    252. 

  252.         <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">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">name</span> <span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">_valid</span><span class="p">])</span></div>
    253. 

  253. 

  254. 

  255.     <span class="k">def</span><span class="w"> </span><span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
    256. 

  256.         <span class="n">dump</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    257. 

  257.         <span class="k">return</span> <span class="n">dump</span>
    258. 

  258. 

  259.     <span class="k">def</span><span class="w"> </span><span class="nf">deserialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
    260. 

  260.         <span class="n">obj</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
    261. 

  261.         <span class="k">return</span> <span class="n">obj</span>
    262. 

  262. 

  263. <div class="viewcode-block" id="ExpireCache.secret_hash">
    264. 

  264. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCache.secret_hash">[docs]</a>
    265. 

  265.     <span class="k">def</span><span class="w"> </span><span class="nf">secret_hash</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    266. 

  266. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Creates a hash of the argument ``name``.  The hash value is formed</span>
    267. 

  267. <span class="sd">        from the ``name`` combined with the :py:obj:`password</span>
    268. 

  268. <span class="sd">        &lt;ExpireCacheCfg.password&gt;`.  Can be used, for example, to make the</span>
    269. 

  269. <span class="sd">        ``key`` stored in the DB unreadable for third parties.&quot;&quot;&quot;</span>
    270. 

  270. 

  271.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
    272. 

  272.             <span class="n">name</span> <span class="o">=</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>
    273. 

  273.         <span class="n">m</span> <span class="o">=</span> <span class="n">hmac</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">name</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">password</span><span class="p">,</span> <span class="n">digestmod</span><span class="o">=</span><span class="s1">&#39;sha256&#39;</span><span class="p">)</span>
    274. 

  274.         <span class="k">return</span> <span class="n">m</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span></div>
    275. 

  275. </div>
    276. 

  276. 

  277. 

  278. 

  279. <div class="viewcode-block" id="ExpireCacheSQLite">
    280. 

  280. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite">[docs]</a>
    281. 

  281. <span class="k">class</span><span class="w"> </span><span class="nc">ExpireCacheSQLite</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">ExpireCache</span><span class="p">):</span>
    282. 

  282. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Cache that manages key/value pairs in a SQLite DB.  The DB model in the</span>
    283. 

  283. <span class="sd">    SQLite DB is implemented in abstract class :py:obj:`SQLiteAppl</span>
    284. 

  284. <span class="sd">    &lt;searx.sqlitedb.SQLiteAppl&gt;`.</span>
    285. 

  285. 

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

  287. 

  288. <span class="sd">    - :py:obj:`ExpireCacheCfg.db_url`</span>
    289. 

  289. <span class="sd">    - :py:obj:`ExpireCacheCfg.MAXHOLD_TIME`</span>
    290. 

  290. <span class="sd">    - :py:obj:`ExpireCacheCfg.MAINTENANCE_PERIOD`</span>
    291. 

  291. <span class="sd">    - :py:obj:`ExpireCacheCfg.MAINTENANCE_MODE`</span>
    292. 

  292. <span class="sd">    &quot;&quot;&quot;</span>
    293. 

  293. 

  294.     <span class="n">DB_SCHEMA</span> <span class="o">=</span> <span class="mi">1</span>
    295. 

  295. 

  296.     <span class="c1"># The key/value tables will be created on demand by self.create_table</span>
    297. 

  297.     <span class="n">DDL_CREATE_TABLES</span> <span class="o">=</span> <span class="p">{}</span>
    298. 

  298. 

  299.     <span class="n">CACHE_TABLE_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;CACHE-TABLE-&quot;</span>
    300. 

  300. 

  301.     <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">ExpireCacheCfg</span><span class="p">):</span>
    302. 

  302. <span class="w">        </span><span class="sd">&quot;&quot;&quot;An instance of the SQLite expire cache is build up from a</span>
    303. 

  303. <span class="sd">        :py:obj:`config &lt;ExpireCacheCfg&gt;`.&quot;&quot;&quot;</span>
    304. 

  304. 

  305.         <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
    306. 

  306.         <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>
    307. 

  307.             <span class="n">log</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>
    308. 

  308.         <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>
    309. 

  309. 

  310. <div class="viewcode-block" id="ExpireCacheSQLite.init">
    311. 

  311. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.init">[docs]</a>
    312. 

  312.     <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">:</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    313. 

  313.         <span class="n">ret_val</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    314. 

  314.         <span class="k">if</span> <span class="ow">not</span> <span class="n">ret_val</span><span class="p">:</span>
    315. 

  315.             <span class="k">return</span> <span class="kc">False</span>
    316. 

  316. 

  317.         <span class="n">new</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="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">password</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
    318. 

  318.         <span class="n">old</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hash_token</span><span class="p">)</span>
    319. 

  319.         <span class="k">if</span> <span class="n">old</span> <span class="o">!=</span> <span class="n">new</span><span class="p">:</span>
    320. 

  320.             <span class="k">if</span> <span class="n">old</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    321. 

  321.                 <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;[</span><span class="si">%s</span><span class="s2">] hash token changed: truncate all cache tables&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
    322. 

  322.             <span class="bp">self</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="kc">True</span><span class="p">,</span> <span class="n">truncate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    323. 

  323.             <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="bp">self</span><span class="o">.</span><span class="n">hash_token</span><span class="p">,</span> <span class="n">new</span><span class="p">)</span>
    324. 

  324. 

  325.         <span class="k">return</span> <span class="kc">True</span></div>
    326. 

  326. 

  327. 

  328. <div class="viewcode-block" id="ExpireCacheSQLite.maintenance">
    329. 

  329. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.maintenance">[docs]</a>
    330. 

  330.     <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="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">truncate</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    331. 

  331. 

  332.         <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>
    333. 

  333.             <span class="c1"># log.debug(&quot;no maintenance required yet, next maintenance interval is in the future&quot;)</span>
    334. 

  334.             <span class="k">return</span> <span class="kc">False</span>
    335. 

  335. 

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

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

  338.         <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>
    339. 

  339. 

  340.         <span class="k">if</span> <span class="n">truncate</span><span class="p">:</span>
    341. 

  341.             <span class="bp">self</span><span class="o">.</span><span class="n">truncate_tables</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">table_names</span><span class="p">)</span>
    342. 

  342.             <span class="k">return</span> <span class="kc">True</span>
    343. 

  343. 

  344.         <span class="c1"># drop items by expire time stamp ..</span>
    345. 

  345.         <span class="n">expire</span> <span class="o">=</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>
    346. 

  346. 

  347.         <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>
    348. 

  348.             <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table_names</span><span class="p">:</span>
    349. 

  349.                 <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="sa">f</span><span class="s2">&quot;DELETE FROM </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2"> WHERE expire &lt; ?&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">expire</span><span class="p">,))</span>
    350. 

  350.                 <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;deleted </span><span class="si">%s</span><span class="s2"> keys from table </span><span class="si">%s</span><span class="s2"> (expire date reached)&quot;</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">rowcount</span><span class="p">,</span> <span class="n">table</span><span class="p">)</span>
    351. 

  351. 

  352.         <span class="c1"># Vacuuming the WALs</span>
    353. 

  353.         <span class="c1"># https://www.theunterminatedstring.com/sqlite-vacuuming/</span>
    354. 

  354. 

  355.         <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;PRAGMA wal_checkpoint(TRUNCATE)&quot;</span><span class="p">)</span>
    356. 

  356.         <span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    357. 

  357. 

  358.         <span class="k">return</span> <span class="kc">True</span></div>
    359. 

  359. 

  360. 

  361. <div class="viewcode-block" id="ExpireCacheSQLite.create_table">
    362. 

  362. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.create_table">[docs]</a>
    363. 

  363.     <span class="k">def</span><span class="w"> </span><span class="nf">create_table</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    364. 

  364. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Create DB ``table`` if it has not yet been created, no recreates are</span>
    365. 

  365. <span class="sd">        initiated if the table already exists.</span>
    366. 

  366. <span class="sd">        &quot;&quot;&quot;</span>
    367. 

  367.         <span class="k">if</span> <span class="n">table</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table_names</span><span class="p">:</span>
    368. 

  368.             <span class="c1"># log.debug(&quot;key/value table %s exists in DB (no need to recreate)&quot;, table)</span>
    369. 

  369.             <span class="k">return</span> <span class="kc">False</span>
    370. 

  370. 

  371.         <span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;key/value table &#39;</span><span class="si">%s</span><span class="s2">&#39; NOT exists in DB -&gt; create DB table ..&quot;</span><span class="p">,</span> <span class="n">table</span><span class="p">)</span>
    372. 

  372.         <span class="n">sql_table</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
    373. 

  373.             <span class="p">[</span>
    374. 

  374.                 <span class="sa">f</span><span class="s2">&quot;CREATE TABLE IF NOT EXISTS </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2"> (&quot;</span><span class="p">,</span>
    375. 

  375.                 <span class="s2">&quot;  key        TEXT,&quot;</span><span class="p">,</span>
    376. 

  376.                 <span class="s2">&quot;  value      BLOB,&quot;</span><span class="p">,</span>
    377. 

  377.                 <span class="sa">f</span><span class="s2">&quot;  expire     INTEGER DEFAULT (strftime(&#39;%s&#39;, &#39;now&#39;) + </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">MAXHOLD_TIME</span><span class="si">}</span><span class="s2">),&quot;</span><span class="p">,</span>
    378. 

  378.                 <span class="s2">&quot;PRIMARY KEY (key))&quot;</span><span class="p">,</span>
    379. 

  379.             <span class="p">]</span>
    380. 

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

  381.         <span class="n">sql_index</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;CREATE INDEX IF NOT EXISTS index_expire_</span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2"> ON </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2">(expire);&quot;</span>
    382. 

  382.         <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>
    383. 

  383.             <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql_table</span><span class="p">)</span>
    384. 

  384.             <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql_index</span><span class="p">)</span>
    385. 

  385.         <span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    386. 

  386. 

  387.         <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="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">CACHE_TABLE_PREFIX</span><span class="si">}</span><span class="s2">-</span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">table</span><span class="p">)</span>
    388. 

  388.         <span class="k">return</span> <span class="kc">True</span></div>
    389. 

  389. 

  390. 

  391.     <span class="nd">@property</span>
    392. 

  392.     <span class="k">def</span><span class="w"> </span><span class="nf">table_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
    393. 

  393. <span class="w">        </span><span class="sd">&quot;&quot;&quot;List of key/value tables already created in the DB.&quot;&quot;&quot;</span>
    394. 

  394.         <span class="n">sql</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;SELECT value FROM properties WHERE name LIKE &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">CACHE_TABLE_PREFIX</span><span class="si">}</span><span class="s2">%%&#39;&quot;</span>
    395. 

  395.         <span class="n">rows</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">fetchall</span><span class="p">()</span> <span class="ow">or</span> <span class="p">[]</span>
    396. 

  396.         <span class="k">return</span> <span class="p">[</span><span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">]</span>
    397. 

  397. 

  398.     <span class="k">def</span><span class="w"> </span><span class="nf">truncate_tables</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table_names</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
    399. 

  399.         <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;truncate table: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">table_names</span><span class="p">))</span>
    400. 

  400.         <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>
    401. 

  401.             <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">table_names</span><span class="p">:</span>
    402. 

  402.                 <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;DELETE FROM </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    403. 

  403.         <span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    404. 

  404.         <span class="k">return</span> <span class="kc">True</span>
    405. 

  405. 

  406.     <span class="nd">@property</span>
    407. 

  407.     <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>
    408. 

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

  409. 

  410.         <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> <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>
    411. 

  411. 

  412.     <span class="c1"># implement ABC methods of ExpireCache</span>
    413. 

  413. 

  414. <div class="viewcode-block" id="ExpireCacheSQLite.set">
    415. 

  415. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.set">[docs]</a>
    416. 

  416.     <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">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">,</span> <span class="n">expire</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</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>
    417. 

  417. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set key/value in DB table given by argument ``ctx``.  If expire is</span>
    418. 

  418. <span class="sd">        unset the default is taken from :py:obj:`ExpireCacheCfg.MAXHOLD_TIME`.</span>
    419. 

  419. <span class="sd">        If ``ctx`` argument is ``None`` (the default), a table name is</span>
    420. 

  420. <span class="sd">        generated from the :py:obj:`ExpireCacheCfg.name`.  If DB table does not</span>
    421. 

  421. <span class="sd">        exists, it will be created (on demand) by :py:obj:`self.create_table</span>
    422. 

  422. <span class="sd">        &lt;ExpireCacheSQLite.create_table&gt;`.</span>
    423. 

  423. <span class="sd">        &quot;&quot;&quot;</span>
    424. 

  424.         <span class="n">table</span> <span class="o">=</span> <span class="n">ctx</span>
    425. 

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

  426. 

  427.         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
    428. 

  428.         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">)</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">MAX_VALUE_LEN</span><span class="p">:</span>
    429. 

  429.             <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;ExpireCache.set(): </span><span class="si">%s</span><span class="s2">.key=&#39;</span><span class="si">%s</span><span class="s2">&#39; - value too big to cache (len: </span><span class="si">%s</span><span class="s2">)  &quot;</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><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="ow">not</span> <span class="n">expire</span><span class="p">:</span>
    433. 

  433.             <span class="n">expire</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">MAXHOLD_TIME</span>
    434. 

  434.         <span class="n">expire</span> <span class="o">=</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">+</span> <span class="n">expire</span>
    435. 

  435. 

  436.         <span class="n">table_name</span> <span class="o">=</span> <span class="n">table</span>
    437. 

  437.         <span class="k">if</span> <span class="ow">not</span> <span class="n">table_name</span><span class="p">:</span>
    438. 

  438.             <span class="n">table_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">normalize_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
    439. 

  439.         <span class="bp">self</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span><span class="n">table_name</span><span class="p">)</span>
    440. 

  440. 

  441.         <span class="n">sql</span> <span class="o">=</span> <span class="p">(</span>
    442. 

  442.             <span class="sa">f</span><span class="s2">&quot;INSERT INTO </span><span class="si">{</span><span class="n">table_name</span><span class="si">}</span><span class="s2"> (key, value, expire) VALUES (?, ?, ?)&quot;</span>
    443. 

  443.             <span class="sa">f</span><span class="s2">&quot;    ON CONFLICT DO &quot;</span>
    444. 

  444.             <span class="sa">f</span><span class="s2">&quot;UPDATE SET value=?, expire=?&quot;</span>
    445. 

  445.         <span class="p">)</span>
    446. 

  446. 

  447.         <span class="k">if</span> <span class="n">table</span><span class="p">:</span>
    448. 

  448.             <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="p">:</span>
    449. 

  449.                 <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">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">expire</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">expire</span><span class="p">))</span>
    450. 

  450.         <span class="k">else</span><span class="p">:</span>
    451. 

  451.             <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>
    452. 

  452.                 <span class="n">conn</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">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">expire</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">expire</span><span class="p">))</span>
    453. 

  453.             <span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    454. 

  454. 

  455.         <span class="k">return</span> <span class="kc">True</span></div>
    456. 

  456. 

  457. 

  458. <div class="viewcode-block" id="ExpireCacheSQLite.get">
    459. 

  459. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.get">[docs]</a>
    460. 

  460.     <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
    461. 

  461. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Get value of ``key`` from table given by argument ``ctx``.  If</span>
    462. 

  462. <span class="sd">        ``ctx`` argument is ``None`` (the default), a table name is generated</span>
    463. 

  463. <span class="sd">        from the :py:obj:`ExpireCacheCfg.name`.  If ``key`` not exists (in</span>
    464. 

  464. <span class="sd">        table), the ``default`` value is returned.</span>
    465. 

  465. 

  466. <span class="sd">        &quot;&quot;&quot;</span>
    467. 

  467.         <span class="n">table</span> <span class="o">=</span> <span class="n">ctx</span>
    468. 

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

  469. 

  470.         <span class="k">if</span> <span class="ow">not</span> <span class="n">table</span><span class="p">:</span>
    471. 

  471.             <span class="n">table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">normalize_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
    472. 

  472. 

  473.         <span class="k">if</span> <span class="n">table</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table_names</span><span class="p">:</span>
    474. 

  474.             <span class="k">return</span> <span class="n">default</span>
    475. 

  475. 

  476.         <span class="n">sql</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;SELECT value FROM </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2"> WHERE key = ?&quot;</span>
    477. 

  477.         <span class="n">row</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">key</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    478. 

  478.         <span class="k">if</span> <span class="n">row</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    479. 

  479.             <span class="k">return</span> <span class="n">default</span>
    480. 

  480. 

  481.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">deserialize</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span></div>
    482. 

  482. 

  483. 

  484. <div class="viewcode-block" id="ExpireCacheSQLite.state">
    485. 

  485. <a class="viewcode-back" href="../../src/searx.cache.html#searx.cache.ExpireCacheSQLite.state">[docs]</a>
    486. 

  486.     <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">ExpireCacheStats</span><span class="p">:</span>
    487. 

  487.         <span class="n">cached_items</span> <span class="o">=</span> <span class="p">{}</span>
    488. 

  488.         <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">table_names</span><span class="p">:</span>
    489. 

  489.             <span class="n">cached_items</span><span class="p">[</span><span class="n">table</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
    490. 

  490.             <span class="k">for</span> <span class="n">row</span> <span class="ow">in</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="sa">f</span><span class="s2">&quot;SELECT key, value, expire FROM </span><span class="si">{</span><span class="n">table</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">):</span>
    491. 

  491.                 <span class="n">cached_items</span><span class="p">[</span><span class="n">table</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">deserialize</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="n">row</span><span class="p">[</span><span class="mi">2</span><span class="p">]))</span>
    492. 

  492.         <span class="k">return</span> <span class="n">ExpireCacheStats</span><span class="p">(</span><span class="n">cached_items</span><span class="o">=</span><span class="n">cached_items</span><span class="p">)</span></div>
    493. 

  493. </div>
    494. 

  494. 

  495. </pre></div>
    496. 

  496. 

  497.             <div class="clearer"></div>
    498. 

  498.           </div>
    499. 

  499.         </div>
    500. 

  500.       </div>
    501. 

  501.   <span id="sidebar-top"></span>
    502. 

  502.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    503. 

  503.         <div class="sphinxsidebarwrapper">
    504. 

  504.   
    505. 

  505.     
    506. 

  506.             <p class="logo"><a href="../../index.html">
    507. 

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

  508.             </a></p>
    509. 

  509.   
    510. 

  510. 

  511. <h3><a href="../../index.html">Table of Contents</a></h3>
    512. 

  512. <ul>
    513. 

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

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

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

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

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

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

  519. </ul>
    520. 

  520. 

  521.   <h3>Project Links</h3>
    522. 

  522.   <ul>
    523. 

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

  524.   
    525. 

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

  526.   
    527. 

  527.     <li><a href="https://searx.space">Public instances</a>
    528. 

  528.   
    529. 

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

  530.   </ul><h3>Navigation</h3>
    531. 

  531. <ul>
    532. 

  532.   <li><a href="../../index.html">Overview</a>
    533. 

  533.     <ul>
    534. 

  534.       <li><a href="../index.html">Module code</a>
    535. 

  535.         
    536. 

  536.           
    537. 

  537.           </ul>
    538. 

  538.       </li>
    539. 

  539.     </ul>
    540. 

  540.   </li>
    541. 

  541. </ul>
    542. 

  542. <search id="searchbox" style="display: none" role="search">
    543. 

  543.   <h3 id="searchlabel">Quick search</h3>
    544. 

  544.     <div class="searchformwrapper">
    545. 

  545.     <form class="search" action="../../search.html" method="get">
    546. 

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

  547.       <input type="submit" value="Go" />
    548. 

  548.     </form>
    549. 

  549.     </div>
    550. 

  550. </search>
    551. 

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

  552.         </div>
    553. 

  553.       </div>
    554. 

  554.       <div class="clearer"></div>
    555. 

  555.     </div>
    556. 

  556.     <div class="footer" role="contentinfo">
    557. 

  557.     &#169; Copyright SearXNG team.
    558. 

  558.     </div>
    559. 

  559.   </body>
    560. 

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