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
/
sqlitedb.html

sqlitedb.html 57 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566 
  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.sqlitedb &#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.sqlitedb</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.sqlitedb</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 to make access to SQLite databases a little more convenient.</span>
    41. 

  41. 

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

  43. <span class="sd">  Abstract class with which DB applications can be implemented.</span>
    44. 

  44. 

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

  46. <span class="sd">  Class to manage properties stored in a database.</span>
    47. 

  47. 

  48. <span class="sd">Examplarical implementations based on :py:obj:`SQLiteAppl`:</span>
    49. 

  49. 

  50. <span class="sd">:py:obj:`searx.cache.ExpireCacheSQLite` :</span>
    51. 

  51. <span class="sd">  Cache that manages key/value pairs in a SQLite DB, in which the key/value</span>
    52. 

  52. <span class="sd">  pairs are deleted after an &quot;expire&quot; time.  This type of cache is used, for</span>
    53. 

  53. <span class="sd">  example, for the engines, see :py:obj:`searx.enginelib.EngineCache`.</span>
    54. 

  54. 

  55. <span class="sd">:py:obj:`searx.favicons.cache.FaviconCacheSQLite` :</span>
    56. 

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

  57. 

  58. <span class="sd">----</span>
    59. 

  59. <span class="sd">&quot;&quot;&quot;</span>
    60. 

  60. <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>
    61. 

  61. 

  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">datetime</span>
    64. 

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

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

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

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

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

  69. 

  70. <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>
    71. 

  71. 

  72. <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="s2">&quot;sqlitedb&quot;</span><span class="p">)</span>
    73. 

  73. 

  74. <span class="n">THREAD_LOCAL</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">local</span><span class="p">()</span>
    75. 

  75. 

  76. 

  77. <div class="viewcode-block" id="DBSession">
    78. 

  78. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.DBSession">[docs]</a>
    79. 

  79. <span class="k">class</span><span class="w"> </span><span class="nc">DBSession</span><span class="p">:</span>
    80. 

  80. <span class="w">    </span><span class="sd">&quot;&quot;&quot;A *thead-local* DB session&quot;&quot;&quot;</span>
    81. 

  81. 

  82. <div class="viewcode-block" id="DBSession.get_connect">
    83. 

  83. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.DBSession.get_connect">[docs]</a>
    84. 

  84.     <span class="nd">@classmethod</span>
    85. 

  85.     <span class="k">def</span><span class="w"> </span><span class="nf">get_connect</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="n">SQLiteAppl</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
    86. 

  86. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a thread local DB connection.  The connection is only</span>
    87. 

  87. <span class="sd">        established once per thread.</span>
    88. 

  88. <span class="sd">        &quot;&quot;&quot;</span>
    89. 

  89.         <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">THREAD_LOCAL</span><span class="p">,</span> <span class="s2">&quot;DBSession_map&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    90. 

  90.             <span class="n">THREAD_LOCAL</span><span class="o">.</span><span class="n">DBSession_map</span> <span class="o">=</span> <span class="p">{}</span>
    91. 

  91. 

  92.         <span class="n">session</span> <span class="o">=</span> <span class="n">THREAD_LOCAL</span><span class="o">.</span><span class="n">DBSession_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
    93. 

  93.         <span class="k">if</span> <span class="n">session</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    94. 

  94.             <span class="n">session</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    95. 

  95.         <span class="k">return</span> <span class="n">session</span><span class="o">.</span><span class="n">conn</span></div>
    96. 

  96. 

  97. 

  98.     <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">app</span><span class="p">:</span> <span class="n">SQLiteAppl</span><span class="p">):</span>
    99. 

  99.         <span class="bp">self</span><span class="o">.</span><span class="n">uuid</span> <span class="o">=</span> <span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span>
    100. 

  100.         <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
    101. 

  101.         <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="kc">None</span>
    102. 

  102.         <span class="c1"># self.__del__ will be called, when thread ends</span>
    103. 

  103.         <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">THREAD_LOCAL</span><span class="p">,</span> <span class="s2">&quot;DBSession_map&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    104. 

  104.             <span class="n">THREAD_LOCAL</span><span class="o">.</span><span class="n">DBSession_map</span> <span class="o">=</span> <span class="p">{}</span>
    105. 

  105.         <span class="n">THREAD_LOCAL</span><span class="o">.</span><span class="n">DBSession_map</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">db_url</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span>
    106. 

  106. 

  107.     <span class="nd">@property</span>
    108. 

  108.     <span class="k">def</span><span class="w"> </span><span class="nf">conn</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
    109. 

  109.         <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">threading</span><span class="o">.</span><span class="n">current_thread</span><span class="p">()</span><span class="o">.</span><span class="n">ident</span><span class="si">}</span><span class="s2">] DBSession: &quot;</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">app</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">(</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">db_url</span><span class="si">}</span><span class="s2">)&quot;</span>
    110. 

  110.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    111. 

  111.             <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
    112. 

  112.             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> --&gt; created new connection&quot;</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
    113. 

  113.         <span class="c1"># else:</span>
    114. 

  114.         <span class="c1">#     logger.debug(&quot;%s --&gt; already connected&quot;, msg)</span>
    115. 

  115. 

  116.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span>
    117. 

  117. 

  118.     <span class="k">def</span><span class="w"> </span><span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    119. 

  119.         <span class="k">try</span><span class="p">:</span>
    120. 

  120.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    121. 

  121.                 <span class="c1"># HINT: Don&#39;t use Python&#39;s logging facility in a destructor, it</span>
    122. 

  122.                 <span class="c1"># will produce error reports when python aborts the process or</span>
    123. 

  123.                 <span class="c1"># thread, because at this point objects that the logging module</span>
    124. 

  124.                 <span class="c1"># needs, do not exist anymore.</span>
    125. 

  125.                 <span class="c1"># msg = f&quot;DBSession: close [{self.uuid}] {self.app.__class__.__name__}({self.app.db_url})&quot;</span>
    126. 

  126.                 <span class="c1"># logger.debug(msg)</span>
    127. 

  127.                 <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
    128. 

  128.         <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>  <span class="c1"># pylint: disable=broad-exception-caught</span>
    129. 

  129.             <span class="k">pass</span></div>
    130. 

  130. 

  131. 

  132. 

  133. <div class="viewcode-block" id="SQLiteAppl">
    134. 

  134. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl">[docs]</a>
    135. 

  135. <span class="k">class</span><span class="w"> </span><span class="nc">SQLiteAppl</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
    136. 

  136. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class for implementing convenient DB access in SQLite</span>
    137. 

  137. <span class="sd">    applications.  In the constructor, a :py:obj:`SQLiteProperties` instance is</span>
    138. 

  138. <span class="sd">    already aggregated under ``self.properties``.&quot;&quot;&quot;</span>
    139. 

  139. 

  140.     <span class="n">DDL_CREATE_TABLES</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">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
    141. 

  141. 

  142.     <span class="n">DB_SCHEMA</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span>
    143. 

  143. <span class="w">    </span><span class="sd">&quot;&quot;&quot;As soon as changes are made to the DB schema, the version number must be</span>
    144. 

  144. <span class="sd">    increased.  Changes to the version number require the DB to be recreated (or</span>
    145. 

  145. <span class="sd">    migrated / if an migration path exists and is implemented).&quot;&quot;&quot;</span>
    146. 

  146. 

  147.     <span class="n">SQLITE_THREADING_MODE</span> <span class="o">=</span> <span class="p">{</span>
    148. 

  148.         <span class="mi">0</span><span class="p">:</span> <span class="s2">&quot;single-thread&quot;</span><span class="p">,</span>
    149. 

  149.         <span class="mi">1</span><span class="p">:</span> <span class="s2">&quot;multi-thread&quot;</span><span class="p">,</span>
    150. 

  150.         <span class="mi">3</span><span class="p">:</span> <span class="s2">&quot;serialized&quot;</span><span class="p">}[</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">threadsafety</span><span class="p">]</span>  <span class="c1"># fmt:skip</span>
    151. 

  151. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Threading mode of the SQLite library.  Depends on the options used at</span>
    152. 

  152. <span class="sd">    compile time and is different for different distributions and architectures.</span>
    153. 

  153. 

  154. <span class="sd">    Possible values are 0:``single-thread``, 1:``multi-thread``,</span>
    155. 

  155. <span class="sd">    3:``serialized`` (see :py:obj:`sqlite3.threadsafety`).  Pre- Python 3.11</span>
    156. 

  156. <span class="sd">    this value was hard coded to 1.</span>
    157. 

  157. 

  158. <span class="sd">    Depending on this value, optimizations are made, e.g. in “serialized” mode</span>
    159. 

  159. <span class="sd">    it is not necessary to create a separate DB connector for each thread.</span>
    160. 

  160. <span class="sd">    &quot;&quot;&quot;</span>
    161. 

  161. 

  162.     <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
    163. 

  163. <span class="w">    </span><span class="sd">&quot;&quot;&quot;``SQLiteAppl`` applications are optimzed for WAL_ mode, its not recommend</span>
    164. 

  164. <span class="sd">    to change the journal mode (see :py:obj:`SQLiteAppl.tear_down`).</span>
    165. 

  165. 

  166. <span class="sd">    .. _WAL: https://sqlite.org/wal.html</span>
    167. 

  167. <span class="sd">    &quot;&quot;&quot;</span>
    168. 

  168.     <span class="n">SQLITE_CONNECT_ARGS</span> <span class="o">=</span> <span class="p">{</span>
    169. 

  169.         <span class="c1"># &quot;timeout&quot;: 5.0,</span>
    170. 

  170.         <span class="c1"># &quot;detect_types&quot;: 0,</span>
    171. 

  171.         <span class="s2">&quot;check_same_thread&quot;</span><span class="p">:</span> <span class="nb">bool</span><span class="p">(</span><span class="n">SQLITE_THREADING_MODE</span> <span class="o">!=</span> <span class="s2">&quot;serialized&quot;</span><span class="p">),</span>
    172. 

  172.         <span class="s2">&quot;cached_statements&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>  <span class="c1"># https://github.com/python/cpython/issues/118172</span>
    173. 

  173.         <span class="c1"># &quot;uri&quot;: False,</span>
    174. 

  174.         <span class="s2">&quot;isolation_level&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
    175. 

  175.     <span class="p">}</span>  <span class="c1"># fmt:skip</span>
    176. 

  176. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Connection arguments (:py:obj:`sqlite3.connect`)</span>
    177. 

  177. 

  178. <span class="sd">    ``check_same_thread``:</span>
    179. 

  179. <span class="sd">      Is disabled by default when :py:obj:`SQLITE_THREADING_MODE` is</span>
    180. 

  180. <span class="sd">      ``serialized``.  The check is more of a hindrance in this case because it</span>
    181. 

  181. <span class="sd">      would prevent a DB connector from being used in multiple threads.</span>
    182. 

  182. 

  183. <span class="sd">    ``cached_statements``:</span>
    184. 

  184. <span class="sd">      Is set to ``0`` by default.  Note: Python 3.12+ fetch result are not</span>
    185. 

  185. <span class="sd">      consistent in multi-threading application and causing an API misuse error.</span>
    186. 

  186. 

  187. <span class="sd">      The multithreading use in SQLiteAppl is intended and supported if</span>
    188. 

  188. <span class="sd">      threadsafety is set to 3 (aka &quot;serialized&quot;). CPython supports “serialized”</span>
    189. 

  189. <span class="sd">      from version 3.12 on, but unfortunately only with errors:</span>
    190. 

  190. 

  191. <span class="sd">      - https://github.com/python/cpython/issues/118172</span>
    192. 

  192. <span class="sd">      - https://github.com/python/cpython/issues/123873</span>
    193. 

  193. 

  194. <span class="sd">      The workaround for SQLite3 multithreading cache inconsistency ist to set</span>
    195. 

  195. <span class="sd">      option ``cached_statements`` to ``0`` by default.</span>
    196. 

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

  197. 

  198.     <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">db_url</span><span class="p">):</span>
    199. 

  199. 

  200.         <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span> <span class="o">=</span> <span class="n">db_url</span>
    201. 

  201.         <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="n">SQLiteProperties</span><span class="p">(</span><span class="n">db_url</span><span class="p">)</span>
    202. 

  202.         <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
    203. 

  203.         <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
    204. 

  204.         <span class="c1"># atexit.register(self.tear_down)</span>
    205. 

  205. 

  206.     <span class="c1"># def tear_down(self):</span>
    207. 

  207.     <span class="c1">#     &quot;&quot;&quot;:ref:`Vacuuming the WALs` upon normal interpreter termination</span>
    208. 

  208.     <span class="c1">#     (:py:obj:`atexit.register`).</span>
    209. 

  209. 

  210.     <span class="c1">#     .. _SQLite: Vacuuming the WALs: https://www.theunterminatedstring.com/sqlite-vacuuming/</span>
    211. 

  211.     <span class="c1">#     &quot;&quot;&quot;</span>
    212. 

  212.     <span class="c1">#     self.DB.execute(&quot;PRAGMA wal_checkpoint(TRUNCATE)&quot;)</span>
    213. 

  213. 

  214.     <span class="k">def</span><span class="w"> </span><span class="nf">_compatibility</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    215. 

  215. 

  216.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_THREADING_MODE</span> <span class="o">==</span> <span class="s2">&quot;serialized&quot;</span><span class="p">:</span>
    217. 

  217.             <span class="bp">self</span><span class="o">.</span><span class="n">_DB</span> <span class="o">=</span> <span class="kc">None</span>
    218. 

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

  219.             <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
    220. 

  220.                 <span class="sa">f</span><span class="s2">&quot;SQLite library is compiled with </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_THREADING_MODE</span><span class="si">}</span><span class="s2"> mode,&quot;</span>
    221. 

  221.                 <span class="s2">&quot; read https://docs.python.org/3/library/sqlite3.html#sqlite3.threadsafety&quot;</span>
    222. 

  222.             <span class="p">)</span>
    223. 

  223.             <span class="k">if</span> <span class="n">threading</span><span class="o">.</span><span class="n">active_count</span><span class="p">()</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
    224. 

  224.                 <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    225. 

  225.             <span class="k">else</span><span class="p">:</span>
    226. 

  226.                 <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    227. 

  227. 

  228.         <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>
    229. 

  229.             <span class="c1"># See &quot;Generalize UPSERT:&quot; in https://sqlite.org/releaselog/3_35_0.html</span>
    230. 

  230.             <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    231. 

  231.                 <span class="s2">&quot;SQLite runtime library version </span><span class="si">%s</span><span class="s2"> is not supported (require &gt;= 3.35)&quot;</span><span class="p">,</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version</span>
    232. 

  232.             <span class="p">)</span>
    233. 

  233. 

  234.     <span class="k">def</span><span class="w"> </span><span class="nf">_connect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
    235. 

  235.         <span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
    236. 

  236.         <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;PRAGMA journal_mode=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_JOURNAL_MODE</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    237. 

  237.         <span class="bp">self</span><span class="o">.</span><span class="n">register_functions</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    238. 

  238.         <span class="k">return</span> <span class="n">conn</span>
    239. 

  239. 

  240. <div class="viewcode-block" id="SQLiteAppl.connect">
    241. 

  241. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.connect">[docs]</a>
    242. 

  242.     <span class="k">def</span><span class="w"> </span><span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
    243. 

  243. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Creates a new DB connection (:py:obj:`SQLITE_CONNECT_ARGS`).  If not</span>
    244. 

  244. <span class="sd">        already done, the DB schema is set up.  The caller must take care of</span>
    245. 

  245. <span class="sd">        closing the resource.  Alternatively, :py:obj:`SQLiteAppl.DB` can also</span>
    246. 

  246. <span class="sd">        be used (the resource behind `self.DB` is automatically closed when the</span>
    247. 

  247. <span class="sd">        process or thread is terminated).</span>
    248. 

  248. <span class="sd">        &quot;&quot;&quot;</span>
    249. 

  249.         <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">12</span><span class="p">):</span>
    250. 

  250.             <span class="c1"># Prior Python 3.12 there is no &quot;autocommit&quot; option</span>
    251. 

  251.             <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;autocommit&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    252. 

  252. 

  253.         <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
    254. 

  254.             <span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">threading</span><span class="o">.</span><span class="n">current_thread</span><span class="p">()</span><span class="o">.</span><span class="n">ident</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">(</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="si">}</span><span class="s2">)&quot;</span>
    255. 

  255.             <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">SQLITE_CONNECT_ARGS</span><span class="si">}</span><span class="s2"> // </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_JOURNAL_MODE</span><span class="si">}</span><span class="s2">&quot;</span>
    256. 

  256.         <span class="p">)</span>
    257. 

  257.         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    258. 

  258. 

  259.         <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>
    260. 

  260.             <span class="bp">self</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    261. 

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

  262. 

  263. 

  264. <div class="viewcode-block" id="SQLiteAppl.register_functions">
    265. 

  265. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.register_functions">[docs]</a>
    266. 

  266.     <span class="k">def</span><span class="w"> </span><span class="nf">register_functions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
    267. 

  267. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Create user-defined_ SQL functions.</span>
    268. 

  268. 

  269. <span class="sd">        ``REGEXP(&lt;pattern&gt;, &lt;field&gt;)`` : 0 | 1</span>
    270. 

  270. <span class="sd">           `re.search`_ returns (int) 1 for a match and 0 for none match of</span>
    271. 

  271. <span class="sd">           ``&lt;pattern&gt;`` in ``&lt;field&gt;``.</span>
    272. 

  272. 

  273. <span class="sd">           .. code:: sql</span>
    274. 

  274. 

  275. <span class="sd">              SELECT &#39;12&#39; AS field WHERE REGEXP(&#39;^[0-9][0-9]$&#39;, field)</span>
    276. 

  276. <span class="sd">              -- 12</span>
    277. 

  277. 

  278. <span class="sd">              SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X12Y&#39;)</span>
    279. 

  279. <span class="sd">              -- 1</span>
    280. 

  280. <span class="sd">              SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X1Y&#39;)</span>
    281. 

  281. <span class="sd">              -- 0</span>
    282. 

  282. 

  283. <span class="sd">        .. _user-defined: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_function</span>
    284. 

  284. <span class="sd">        .. _deterministic: https://sqlite.org/deterministic.html</span>
    285. 

  285. <span class="sd">        .. _re.search: https://docs.python.org/3/library/re.html#re.search</span>
    286. 

  286. <span class="sd">        &quot;&quot;&quot;</span>
    287. 

  287. 

  288.         <span class="n">conn</span><span class="o">.</span><span class="n">create_function</span><span class="p">(</span><span class="s2">&quot;regexp&quot;</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span> <span class="n">deterministic</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
    289. 

  289. 

  290. 

  291.     <span class="nd">@property</span>
    292. 

  292.     <span class="k">def</span><span class="w"> </span><span class="nf">DB</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
    293. 

  293. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Provides a DB connection.  The connection is a *singleton* and</span>
    294. 

  294. <span class="sd">        therefore well suited for read access.  If</span>
    295. 

  295. <span class="sd">        :py:obj:`SQLITE_THREADING_MODE` is ``serialized`` only one DB connection</span>
    296. 

  296. <span class="sd">        is created for all threads.</span>
    297. 

  297. 

  298. <span class="sd">        .. note::</span>
    299. 

  299. 

  300. <span class="sd">           For dedicated `transaction control`_, it is recommended to create a</span>
    301. 

  301. <span class="sd">           new connection (:py:obj:`SQLiteAppl.connect`).</span>
    302. 

  302. 

  303. <span class="sd">        .. _transaction control:</span>
    304. 

  304. <span class="sd">            https://docs.python.org/3/library/sqlite3.html#sqlite3-controlling-transactions</span>
    305. 

  305. <span class="sd">        &quot;&quot;&quot;</span>
    306. 

  306. 

  307.         <span class="n">conn</span> <span class="o">=</span> <span class="kc">None</span>
    308. 

  308. 

  309.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_THREADING_MODE</span> <span class="o">==</span> <span class="s2">&quot;serialized&quot;</span><span class="p">:</span>
    310. 

  310.             <span class="c1"># Theoretically it is possible to reuse the DB cursor across threads</span>
    311. 

  311.             <span class="c1"># as of Python 3.12, in practice the threading of the cursor seems</span>
    312. 

  312.             <span class="c1"># to me a little faulty that I prefer to establish one connection</span>
    313. 

  313.             <span class="c1"># per thread.</span>
    314. 

  314.             <span class="c1">#</span>
    315. 

  315.             <span class="c1"># may we can activate this code one day ..</span>
    316. 

  316.             <span class="c1"># if self._DB is None:</span>
    317. 

  317.             <span class="c1">#     self._DB = self.connect()</span>
    318. 

  318.             <span class="c1"># conn = self._DB</span>
    319. 

  319.             <span class="n">conn</span> <span class="o">=</span> <span class="n">DBSession</span><span class="o">.</span><span class="n">get_connect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
    320. 

  320.         <span class="k">else</span><span class="p">:</span>
    321. 

  321.             <span class="n">conn</span> <span class="o">=</span> <span class="n">DBSession</span><span class="o">.</span><span class="n">get_connect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
    322. 

  322. 

  323.         <span class="c1"># Since more than one instance of SQLiteAppl share the same DB</span>
    324. 

  324.         <span class="c1"># connection, we need to make sure that each SQLiteAppl instance has run</span>
    325. 

  325.         <span class="c1"># its init method at least once.</span>
    326. 

  326.         <span class="bp">self</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    327. 

  327. 

  328.         <span class="k">return</span> <span class="n">conn</span>
    329. 

  329. 

  330. <div class="viewcode-block" id="SQLiteAppl.init">
    331. 

  331. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.init">[docs]</a>
    332. 

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

  333. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Initializes the DB schema and properties, is only executed once even</span>
    334. 

  334. <span class="sd">        if called several times.</span>
    335. 

  335. 

  336. <span class="sd">        If the initialization has not yet taken place, it is carried out and a</span>
    337. 

  337. <span class="sd">        `True` is returned to the caller at the end.  If the initialization has</span>
    338. 

  338. <span class="sd">        already been carried out in the past, `False` is returned.</span>
    339. 

  339. <span class="sd">        &quot;&quot;&quot;</span>
    340. 

  340. 

  341.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
    342. 

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

  343.         <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
    344. 

  344. 

  345.         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;init DB: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
    346. 

  346.         <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    347. 

  347. 

  348.         <span class="n">ver</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="s2">&quot;DB_SCHEMA&quot;</span><span class="p">)</span>
    349. 

  349.         <span class="k">if</span> <span class="n">ver</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    350. 

  350.             <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
    351. 

  351.                 <span class="bp">self</span><span class="o">.</span><span class="n">create_schema</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    352. 

  352.         <span class="k">else</span><span class="p">:</span>
    353. 

  353.             <span class="n">ver</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">ver</span><span class="p">)</span>
    354. 

  354.             <span class="k">if</span> <span class="n">ver</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">:</span>
    355. 

  355.                 <span class="k">raise</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">DatabaseError</span><span class="p">(</span><span class="s2">&quot;Expected DB schema v</span><span class="si">%s</span><span class="s2">, DB schema is v</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">,</span> <span class="n">ver</span><span class="p">))</span>
    356. 

  356.             <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;DB_SCHEMA = </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">ver</span><span class="p">)</span>
    357. 

  357. 

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

  359. 

  360. 

  361.     <span class="k">def</span><span class="w"> </span><span class="nf">create_schema</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>
    362. 

  362. 

  363.         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;create schema ..&quot;</span><span class="p">)</span>
    364. 

  364.         <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;DB_SCHEMA&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">)</span>
    365. 

  365.         <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>
    366. 

  366.         <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
    367. 

  367.             <span class="k">for</span> <span class="n">table_name</span><span class="p">,</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">DDL_CREATE_TABLES</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    368. 

  368.                 <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>
    369. 

  369.                 <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;Table </span><span class="si">{</span><span class="n">table_name</span><span class="si">}</span><span class="s2"> created&quot;</span><span class="p">,</span> <span class="n">table_name</span><span class="p">)</span></div>
    370. 

  370. 

  371. 

  372. 

  373. <div class="viewcode-block" id="SQLiteProperties">
    374. 

  374. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties">[docs]</a>
    375. 

  375. <span class="k">class</span><span class="w"> </span><span class="nc">SQLiteProperties</span><span class="p">(</span><span class="n">SQLiteAppl</span><span class="p">):</span>
    376. 

  376. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Simple class to manage properties of a DB application in the DB.  The</span>
    377. 

  377. <span class="sd">    object has its own DB connection and transaction area.</span>
    378. 

  378. 

  379. <span class="sd">    .. code:: sql</span>
    380. 

  380. 

  381. <span class="sd">       CREATE TABLE IF NOT EXISTS properties (</span>
    382. 

  382. <span class="sd">         name       TEXT,</span>
    383. 

  383. <span class="sd">         value      TEXT,</span>
    384. 

  384. <span class="sd">         m_time     INTEGER DEFAULT (strftime(&#39;%s&#39;, &#39;now&#39;)),</span>
    385. 

  385. <span class="sd">         PRIMARY KEY (name))</span>
    386. 

  386. 

  387. <span class="sd">    &quot;&quot;&quot;</span>
    388. 

  388. 

  389.     <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
    390. 

  390. 

  391.     <span class="n">DDL_PROPERTIES</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
    392. 

  392. <span class="s2">CREATE TABLE IF NOT EXISTS properties (</span>
    393. 

  393. <span class="s2">  name       TEXT,</span>
    394. 

  394. <span class="s2">  value      TEXT,</span>
    395. 

  395. <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>
    396. 

  396. <span class="s2">  PRIMARY KEY (name))&quot;&quot;&quot;</span>
    397. 

  397. 

  398. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to store properties of the DB application&quot;&quot;&quot;</span>
    399. 

  399. 

  400.     <span class="n">SQL_GET</span> <span class="o">=</span> <span class="s2">&quot;SELECT value FROM properties WHERE name = ?&quot;</span>
    401. 

  401.     <span class="n">SQL_M_TIME</span> <span class="o">=</span> <span class="s2">&quot;SELECT m_time FROM properties WHERE name = ?&quot;</span>
    402. 

  402.     <span class="n">SQL_SET</span> <span class="o">=</span> <span class="p">(</span>
    403. 

  403.         <span class="s2">&quot;INSERT INTO properties (name, value) VALUES (?, ?)&quot;</span>
    404. 

  404.         <span class="s2">&quot;    ON CONFLICT(name) DO UPDATE&quot;</span>
    405. 

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

  406.     <span class="p">)</span>
    407. 

  407.     <span class="n">SQL_DELETE</span> <span class="o">=</span> <span class="s2">&quot;DELETE FROM properties WHERE name = ?&quot;</span>
    408. 

  408.     <span class="n">SQL_TABLE_EXISTS</span> <span class="o">=</span> <span class="p">(</span>
    409. 

  409.         <span class="s2">&quot;SELECT name FROM sqlite_master&quot;</span>
    410. 

  410.         <span class="s2">&quot; WHERE type=&#39;table&#39; AND name=&#39;properties&#39;&quot;</span>
    411. 

  411.     <span class="p">)</span>  <span class="c1"># fmt:skip</span>
    412. 

  412.     <span class="n">SQLITE_CONNECT_ARGS</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">SQLiteAppl</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>
    413. 

  413. 

  414.     <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">db_url</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>  <span class="c1"># pylint: disable=super-init-not-called</span>
    415. 

  415. 

  416.         <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span> <span class="o">=</span> <span class="n">db_url</span>
    417. 

  417.         <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
    418. 

  418.         <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
    419. 

  419. 

  420. <div class="viewcode-block" id="SQLiteProperties.init">
    421. 

  421. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.init">[docs]</a>
    422. 

  422.     <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>
    423. 

  423. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Initializes DB schema of the properties in the DB.&quot;&quot;&quot;</span>
    424. 

  424. 

  425.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
    426. 

  426.             <span class="k">return</span> <span class="kc">False</span>
    427. 

  427.         <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
    428. 

  428.         <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;init properties of DB: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
    429. 

  429.         <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_TABLE_EXISTS</span><span class="p">)</span>
    430. 

  430.         <span class="k">if</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>  <span class="c1"># DB schema needs to be be created</span>
    431. 

  431.             <span class="bp">self</span><span class="o">.</span><span class="n">create_schema</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
    432. 

  432.         <span class="k">return</span> <span class="kc">True</span></div>
    433. 

  433. 

  434. 

  435.     <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">name</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>
    436. 

  436. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the value of the property ``name`` or ``default`` if property</span>
    437. 

  437. <span class="sd">        not exists in DB.&quot;&quot;&quot;</span>
    438. 

  438. 

  439.         <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="bp">self</span><span class="o">.</span><span class="n">SQL_GET</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    440. 

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

  441.             <span class="k">return</span> <span class="n">default</span>
    442. 

  442.         <span class="k">return</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
    443. 

  443. 

  444. <div class="viewcode-block" id="SQLiteProperties.set">
    445. 

  445. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.set">[docs]</a>
    446. 

  446.     <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">name</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="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">):</span>
    447. 

  447. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set ``value`` of property ``name`` in DB.  If property already</span>
    448. 

  448. <span class="sd">        exists, update the ``m_time`` (and the value).&quot;&quot;&quot;</span>
    449. 

  449. 

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

  451.             <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="bp">self</span><span class="o">.</span><span class="n">SQL_SET</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
    452. 

  452. 

  453. 

  454. <div class="viewcode-block" id="SQLiteProperties.delete">
    455. 

  455. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.delete">[docs]</a>
    456. 

  456.     <span class="k">def</span><span class="w"> </span><span class="nf">delete</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="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
    457. 

  457. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Delete of property ``name`` from DB.&quot;&quot;&quot;</span>
    458. 

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

  459.             <span class="n">cur</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="bp">self</span><span class="o">.</span><span class="n">SQL_DELETE</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span>
    460. 

  460.         <span class="k">return</span> <span class="n">cur</span><span class="o">.</span><span class="n">rowcount</span></div>
    461. 

  461. 

  462. 

  463. <div class="viewcode-block" id="SQLiteProperties.row">
    464. 

  464. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.row">[docs]</a>
    465. 

  465.     <span class="k">def</span><span class="w"> </span><span class="nf">row</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="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    466. 

  466. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the DB row of property ``name`` or ``default`` if property</span>
    467. 

  467. <span class="sd">        not exists in DB.&quot;&quot;&quot;</span>
    468. 

  468. 

  469.         <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="s2">&quot;SELECT * FROM properties WHERE name = ?&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span>
    470. 

  470.         <span class="n">row</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    471. 

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

  472.             <span class="k">return</span> <span class="n">default</span>
    473. 

  473. 

  474.         <span class="n">col_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">column</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">row</span><span class="o">.</span><span class="n">description</span><span class="p">]</span>
    475. 

  475.         <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">col_names</span><span class="p">,</span> <span class="n">row</span><span class="p">))</span></div>
    476. 

  476. 

  477. 

  478. <div class="viewcode-block" id="SQLiteProperties.m_time">
    479. 

  479. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.m_time">[docs]</a>
    480. 

  480.     <span class="k">def</span><span class="w"> </span><span class="nf">m_time</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="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
    481. 

  481. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Last modification time of this property.&quot;&quot;&quot;</span>
    482. 

  482.         <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="bp">self</span><span class="o">.</span><span class="n">SQL_M_TIME</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span>
    483. 

  483.         <span class="n">row</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
    484. 

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

  485.             <span class="k">return</span> <span class="n">default</span>
    486. 

  486.         <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span></div>
    487. 

  487. 

  488. 

  489.     <span class="k">def</span><span class="w"> </span><span class="nf">create_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
    490. 

  490.         <span class="k">with</span> <span class="n">conn</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="bp">self</span><span class="o">.</span><span class="n">DDL_PROPERTIES</span><span class="p">)</span>
    492. 

  492. 

  493.     <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    494. 

  494.         <span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span>
    495. 

  495.         <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="s2">&quot;SELECT name, value, m_time FROM properties&quot;</span><span class="p">):</span>
    496. 

  496.             <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">m_time</span> <span class="o">=</span> <span class="n">row</span>
    497. 

  497.             <span class="n">m_time</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">m_time</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>
    498. 

  498.             <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;[last modified: </span><span class="si">{</span><span class="n">m_time</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="n">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">value</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    499. 

  499.         <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>
    500. 

  500. 

  501. </pre></div>
    502. 

  502. 

  503.             <div class="clearer"></div>
    504. 

  504.           </div>
    505. 

  505.         </div>
    506. 

  506.       </div>
    507. 

  507.   <span id="sidebar-top"></span>
    508. 

  508.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    509. 

  509.         <div class="sphinxsidebarwrapper">
    510. 

  510.   
    511. 

  511.     
    512. 

  512.             <p class="logo"><a href="../../index.html">
    513. 

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

  514.             </a></p>
    515. 

  515.   
    516. 

  516. 

  517. <h3><a href="../../index.html">Table of Contents</a></h3>
    518. 

  518. <ul>
    519. 

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

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

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

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

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

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

  525. </ul>
    526. 

  526. 

  527.   <h3>Project Links</h3>
    528. 

  528.   <ul>
    529. 

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

  530.   
    531. 

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

  532.   
    533. 

  533.     <li><a href="https://searx.space">Public instances</a>
    534. 

  534.   
    535. 

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

  536.   </ul><h3>Navigation</h3>
    537. 

  537. <ul>
    538. 

  538.   <li><a href="../../index.html">Overview</a>
    539. 

  539.     <ul>
    540. 

  540.       <li><a href="../index.html">Module code</a>
    541. 

  541.         
    542. 

  542.           
    543. 

  543.           </ul>
    544. 

  544.       </li>
    545. 

  545.     </ul>
    546. 

  546.   </li>
    547. 

  547. </ul>
    548. 

  548. <search id="searchbox" style="display: none" role="search">
    549. 

  549.   <h3 id="searchlabel">Quick search</h3>
    550. 

  550.     <div class="searchformwrapper">
    551. 

  551.     <form class="search" action="../../search.html" method="get">
    552. 

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

  553.       <input type="submit" value="Go" />
    554. 

  554.     </form>
    555. 

  555.     </div>
    556. 

  556. </search>
    557. 

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

  558.         </div>
    559. 

  559.       </div>
    560. 

  560.       <div class="clearer"></div>
    561. 

  561.     </div>
    562. 

  562.     <div class="footer" role="contentinfo">
    563. 

  563.     &#169; Copyright SearXNG team.
    564. 

  564.     </div>
    565. 

  565.   </body>
    566. 

  566. </html>
    567.
© 2025 NTab仓库
Page: 42ms Template: 0ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website