sqlitedb.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>searx.sqlitedb &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
  8. <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../_static/documentation_options.js?v=b12b0e12"></script>
  11. <script src="../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../genindex.html" />
  15. <link rel="search" title="Search" href="../../search.html" />
  16. </head><body>
  17. <div class="related" role="navigation" aria-label="Related">
  18. <h3>Navigation</h3>
  19. <ul>
  20. <li class="right" style="margin-right: 10px">
  21. <a href="../../genindex.html" title="General Index"
  22. accesskey="I">index</a></li>
  23. <li class="right" >
  24. <a href="../../py-modindex.html" title="Python Module Index"
  25. >modules</a> |</li>
  26. <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-this"><a href="">searx.sqlitedb</a></li>
  29. </ul>
  30. </div>
  31. <div class="document">
  32. <div class="documentwrapper">
  33. <div class="bodywrapper">
  34. <div class="body" role="main">
  35. <h1>Source code for searx.sqlitedb</h1><div class="highlight"><pre>
  36. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  37. <span class="sd">&quot;&quot;&quot;Implementations to make access to SQLite databases a little more convenient.</span>
  38. <span class="sd">:py:obj:`SQLiteAppl`</span>
  39. <span class="sd"> Abstract class with which DB applications can be implemented.</span>
  40. <span class="sd">:py:obj:`SQLiteProperties`:</span>
  41. <span class="sd"> Class to manage properties stored in a database.</span>
  42. <span class="sd">----</span>
  43. <span class="sd">&quot;&quot;&quot;</span>
  44. <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>
  45. <span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
  46. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
  47. <span class="kn">import</span><span class="w"> </span><span class="nn">sqlite3</span>
  48. <span class="kn">import</span><span class="w"> </span><span class="nn">threading</span>
  49. <span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
  50. <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>
  51. <span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">&#39;sqlitedb&#39;</span><span class="p">)</span>
  52. <div class="viewcode-block" id="SQLiteAppl">
  53. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl">[docs]</a>
  54. <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>
  55. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Abstract base class for implementing convenient DB access in SQLite</span>
  56. <span class="sd"> applications. In the constructor, a :py:obj:`SQLiteProperties` instance is</span>
  57. <span class="sd"> already aggregated under ``self.properties``.&quot;&quot;&quot;</span>
  58. <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>
  59. <span class="n">DB_SCHEMA</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span>
  60. <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>
  61. <span class="sd"> increased. Changes to the version number require the DB to be recreated (or</span>
  62. <span class="sd"> migrated / if an migration path exists and is implemented).&quot;&quot;&quot;</span>
  63. <span class="n">SQLITE_THREADING_MODE</span> <span class="o">=</span> <span class="p">{</span>
  64. <span class="mi">0</span><span class="p">:</span> <span class="s2">&quot;single-thread&quot;</span><span class="p">,</span>
  65. <span class="mi">1</span><span class="p">:</span> <span class="s2">&quot;multi-thread&quot;</span><span class="p">,</span>
  66. <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>
  67. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Threading mode of the SQLite library. Depends on the options used at</span>
  68. <span class="sd"> compile time and is different for different distributions and architectures.</span>
  69. <span class="sd"> Possible values are 0:``single-thread``, 1:``multi-thread``,</span>
  70. <span class="sd"> 3:``serialized`` (see :py:obj:`sqlite3.threadsafety`). Pre- Python 3.11</span>
  71. <span class="sd"> this value was hard coded to 1.</span>
  72. <span class="sd"> Depending on this value, optimizations are made, e.g. in “serialized” mode</span>
  73. <span class="sd"> it is not necessary to create a separate DB connector for each thread.</span>
  74. <span class="sd"> &quot;&quot;&quot;</span>
  75. <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
  76. <span class="n">SQLITE_CONNECT_ARGS</span> <span class="o">=</span> <span class="p">{</span>
  77. <span class="c1"># &quot;timeout&quot;: 5.0,</span>
  78. <span class="c1"># &quot;detect_types&quot;: 0,</span>
  79. <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>
  80. <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>
  81. <span class="c1"># &quot;uri&quot;: False,</span>
  82. <span class="s2">&quot;autocommit&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
  83. <span class="p">}</span> <span class="c1"># fmt:skip</span>
  84. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Connection arguments (:py:obj:`sqlite3.connect`)</span>
  85. <span class="sd"> ``check_same_thread``:</span>
  86. <span class="sd"> Is disabled by default when :py:obj:`SQLITE_THREADING_MODE` is</span>
  87. <span class="sd"> ``serialized``. The check is more of a hindrance in this case because it</span>
  88. <span class="sd"> would prevent a DB connector from being used in multiple threads.</span>
  89. <span class="sd"> ``autocommit``:</span>
  90. <span class="sd"> Is disabled by default. Note: autocommit option has been added in Python</span>
  91. <span class="sd"> 3.12.</span>
  92. <span class="sd"> ``cached_statements``:</span>
  93. <span class="sd"> Is set to ``0`` by default. Note: Python 3.12+ fetch result are not</span>
  94. <span class="sd"> consistent in multi-threading application and causing an API misuse error.</span>
  95. <span class="sd"> The multithreading use in SQLiteAppl is intended and supported if</span>
  96. <span class="sd"> threadsafety is set to 3 (aka &quot;serialized&quot;). CPython supports “serialized”</span>
  97. <span class="sd"> from version 3.12 on, but unfortunately only with errors:</span>
  98. <span class="sd"> - https://github.com/python/cpython/issues/118172</span>
  99. <span class="sd"> - https://github.com/python/cpython/issues/123873</span>
  100. <span class="sd"> The workaround for SQLite3 multithreading cache inconsistency ist to set</span>
  101. <span class="sd"> option ``cached_statements`` to ``0`` by default.</span>
  102. <span class="sd"> &quot;&quot;&quot;</span>
  103. <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>
  104. <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>
  105. <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>
  106. <span class="bp">self</span><span class="o">.</span><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>
  107. <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
  108. <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
  109. <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>
  110. <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>
  111. <span class="bp">self</span><span class="o">.</span><span class="n">_DB</span> <span class="o">=</span> <span class="kc">None</span>
  112. <span class="k">else</span><span class="p">:</span>
  113. <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
  114. <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>
  115. <span class="s2">&quot; read https://docs.python.org/3/library/sqlite3.html#sqlite3.threadsafety&quot;</span>
  116. <span class="p">)</span>
  117. <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>
  118. <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>
  119. <span class="k">else</span><span class="p">:</span>
  120. <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>
  121. <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>
  122. <span class="c1"># See &quot;Generalize UPSERT:&quot; in https://sqlite.org/releaselog/3_35_0.html</span>
  123. <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
  124. <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>
  125. <span class="p">)</span>
  126. <div class="viewcode-block" id="SQLiteAppl.connect">
  127. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.connect">[docs]</a>
  128. <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>
  129. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Creates a new DB connection (:py:obj:`SQLITE_CONNECT_ARGS`). If not</span>
  130. <span class="sd"> already done, the DB schema is set up</span>
  131. <span class="sd"> &quot;&quot;&quot;</span>
  132. <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>
  133. <span class="c1"># Prior Python 3.12 there is no &quot;autocommit&quot; option</span>
  134. <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>
  135. <span class="bp">self</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
  136. <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">: connect to DB: </span><span class="si">%s</span><span class="s2"> // </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="vm">__class__</span><span class="o">.</span><span class="vm">__name__</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="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>
  137. <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>
  138. <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>
  139. <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>
  140. <span class="k">return</span> <span class="n">conn</span></div>
  141. <div class="viewcode-block" id="SQLiteAppl.register_functions">
  142. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.register_functions">[docs]</a>
  143. <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>
  144. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Create user-defined_ SQL functions.</span>
  145. <span class="sd"> ``REGEXP(&lt;pattern&gt;, &lt;field&gt;)`` : 0 | 1</span>
  146. <span class="sd"> `re.search`_ returns (int) 1 for a match and 0 for none match of</span>
  147. <span class="sd"> ``&lt;pattern&gt;`` in ``&lt;field&gt;``.</span>
  148. <span class="sd"> .. code:: sql</span>
  149. <span class="sd"> SELECT &#39;12&#39; AS field WHERE REGEXP(&#39;^[0-9][0-9]$&#39;, field)</span>
  150. <span class="sd"> -- 12</span>
  151. <span class="sd"> SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X12Y&#39;)</span>
  152. <span class="sd"> -- 1</span>
  153. <span class="sd"> SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X1Y&#39;)</span>
  154. <span class="sd"> -- 0</span>
  155. <span class="sd"> .. _user-defined: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_function</span>
  156. <span class="sd"> .. _deterministic: https://sqlite.org/deterministic.html</span>
  157. <span class="sd"> .. _re.search: https://docs.python.org/3/library/re.html#re.search</span>
  158. <span class="sd"> &quot;&quot;&quot;</span>
  159. <span class="n">conn</span><span class="o">.</span><span class="n">create_function</span><span class="p">(</span><span class="s1">&#39;regexp&#39;</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>
  160. <span class="nd">@property</span>
  161. <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>
  162. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Provides a DB connection. The connection is a *singleton* and</span>
  163. <span class="sd"> therefore well suited for read access. If</span>
  164. <span class="sd"> :py:obj:`SQLITE_THREADING_MODE` is ``serialized`` only one DB connection</span>
  165. <span class="sd"> is created for all threads.</span>
  166. <span class="sd"> .. note::</span>
  167. <span class="sd"> For dedicated `transaction control`_, it is recommended to create a</span>
  168. <span class="sd"> new connection (:py:obj:`SQLiteAppl.connect`).</span>
  169. <span class="sd"> .. _transaction control:</span>
  170. <span class="sd"> https://docs.python.org/3/library/sqlite3.html#sqlite3-controlling-transactions</span>
  171. <span class="sd"> &quot;&quot;&quot;</span>
  172. <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="p">,</span> <span class="s1">&#39;DB&#39;</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>
  173. <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
  174. <span class="c1"># Theoretically it is possible to reuse the DB cursor across threads as</span>
  175. <span class="c1"># of Python 3.12, in practice the threading of the cursor seems to me to</span>
  176. <span class="c1"># be so faulty that I prefer to establish one connection per thread</span>
  177. <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
  178. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span>
  179. <span class="c1"># In &quot;serialized&quot; mode, SQLite can be safely used by multiple threads</span>
  180. <span class="c1"># with no restriction.</span>
  181. <span class="c1">#</span>
  182. <span class="c1"># if self.SQLITE_THREADING_MODE != &quot;serialized&quot;:</span>
  183. <span class="c1"># if getattr(self.thread_local, &#39;DB&#39;, None) is None:</span>
  184. <span class="c1"># self.thread_local.DB = self.connect()</span>
  185. <span class="c1"># return self.thread_local.DB</span>
  186. <span class="c1">#</span>
  187. <span class="c1"># if self._DB is None:</span>
  188. <span class="c1"># self._DB = self.connect() # pylint: disable=attribute-defined-outside-init</span>
  189. <span class="c1"># return self._DB</span>
  190. <div class="viewcode-block" id="SQLiteAppl.init">
  191. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.init">[docs]</a>
  192. <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>
  193. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Initializes the DB schema and properties, is only executed once even</span>
  194. <span class="sd"> if called several times.&quot;&quot;&quot;</span>
  195. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
  196. <span class="k">return</span>
  197. <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
  198. <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>
  199. <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>
  200. <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>
  201. <span class="k">if</span> <span class="n">ver</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  202. <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">DB</span><span class="p">:</span>
  203. <span class="bp">self</span><span class="o">.</span><span class="n">create_schema</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">DB</span><span class="p">)</span>
  204. <span class="k">else</span><span class="p">:</span>
  205. <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>
  206. <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>
  207. <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>
  208. <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></div>
  209. <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>
  210. <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>
  211. <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
  212. <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>
  213. <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>
  214. <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>
  215. <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>
  216. <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></div>
  217. <div class="viewcode-block" id="SQLiteProperties">
  218. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties">[docs]</a>
  219. <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>
  220. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Simple class to manage properties of a DB application in the DB. The</span>
  221. <span class="sd"> object has its own DB connection and transaction area.</span>
  222. <span class="sd"> .. code:: sql</span>
  223. <span class="sd"> CREATE TABLE IF NOT EXISTS properties (</span>
  224. <span class="sd"> name TEXT,</span>
  225. <span class="sd"> value TEXT,</span>
  226. <span class="sd"> m_time INTEGER DEFAULT (strftime(&#39;%s&#39;, &#39;now&#39;)),</span>
  227. <span class="sd"> PRIMARY KEY (name))</span>
  228. <span class="sd"> &quot;&quot;&quot;</span>
  229. <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
  230. <span class="n">DDL_PROPERTIES</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
  231. <span class="s2">CREATE TABLE IF NOT EXISTS properties (</span>
  232. <span class="s2"> name TEXT,</span>
  233. <span class="s2"> value TEXT,</span>
  234. <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>
  235. <span class="s2"> PRIMARY KEY (name))&quot;&quot;&quot;</span>
  236. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Table to store properties of the DB application&quot;&quot;&quot;</span>
  237. <span class="n">SQL_GET</span> <span class="o">=</span> <span class="s2">&quot;SELECT value FROM properties WHERE name = ?&quot;</span>
  238. <span class="n">SQL_M_TIME</span> <span class="o">=</span> <span class="s2">&quot;SELECT m_time FROM properties WHERE name = ?&quot;</span>
  239. <span class="n">SQL_SET</span> <span class="o">=</span> <span class="p">(</span>
  240. <span class="s2">&quot;INSERT INTO properties (name, value) VALUES (?, ?)&quot;</span>
  241. <span class="s2">&quot; ON CONFLICT(name) DO UPDATE&quot;</span>
  242. <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>
  243. <span class="p">)</span>
  244. <span class="n">SQL_TABLE_EXISTS</span> <span class="o">=</span> <span class="p">(</span>
  245. <span class="s2">&quot;SELECT name FROM sqlite_master&quot;</span>
  246. <span class="s2">&quot; WHERE type=&#39;table&#39; AND name=&#39;properties&#39;&quot;</span>
  247. <span class="p">)</span> <span class="c1"># fmt:skip</span>
  248. <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>
  249. <span class="n">SQLITE_CONNECT_ARGS</span><span class="p">[</span><span class="s2">&quot;autocommit&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span> <span class="c1"># This option has no effect before Python 3.12</span>
  250. <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>
  251. <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>
  252. <span class="bp">self</span><span class="o">.</span><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>
  253. <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
  254. <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
  255. <div class="viewcode-block" id="SQLiteProperties.init">
  256. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.init">[docs]</a>
  257. <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>
  258. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Initializes DB schema of the properties in the DB.&quot;&quot;&quot;</span>
  259. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
  260. <span class="k">return</span>
  261. <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
  262. <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>
  263. <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
  264. <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>
  265. <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>
  266. <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></div>
  267. <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="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  268. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the value of the property ``name`` or ``default`` if property</span>
  269. <span class="sd"> not exists in DB.&quot;&quot;&quot;</span>
  270. <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>
  271. <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  272. <span class="k">return</span> <span class="n">default</span>
  273. <span class="k">return</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  274. <div class="viewcode-block" id="SQLiteProperties.set">
  275. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.set">[docs]</a>
  276. <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="n">value</span><span class="p">):</span>
  277. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Set ``value`` of property ``name`` in DB. If property already</span>
  278. <span class="sd"> exists, update the ``m_time`` (and the value).&quot;&quot;&quot;</span>
  279. <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>
  280. <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>
  281. <span class="c1"># Prior Python 3.12 there is no &quot;autocommit&quot; option / lets commit</span>
  282. <span class="c1"># explicitely.</span>
  283. <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div>
  284. <div class="viewcode-block" id="SQLiteProperties.row">
  285. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.row">[docs]</a>
  286. <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="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  287. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the DB row of property ``name`` or ``default`` if property</span>
  288. <span class="sd"> not exists in DB.&quot;&quot;&quot;</span>
  289. <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">cursor</span><span class="p">()</span>
  290. <span class="n">cur</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>
  291. <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
  292. <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  293. <span class="k">return</span> <span class="n">default</span>
  294. <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">cur</span><span class="o">.</span><span class="n">description</span><span class="p">]</span>
  295. <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">res</span><span class="p">))</span></div>
  296. <div class="viewcode-block" id="SQLiteProperties.m_time">
  297. <a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.m_time">[docs]</a>
  298. <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="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>
  299. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Last modification time of this property.&quot;&quot;&quot;</span>
  300. <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><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
  301. <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  302. <span class="k">return</span> <span class="n">default</span>
  303. <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span></div>
  304. <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>
  305. <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
  306. <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></div>
  307. </pre></div>
  308. <div class="clearer"></div>
  309. </div>
  310. </div>
  311. </div>
  312. <span id="sidebar-top"></span>
  313. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  314. <div class="sphinxsidebarwrapper">
  315. <p class="logo"><a href="../../index.html">
  316. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  317. </a></p>
  318. <h3><a href="../../index.html">Table of Contents</a></h3>
  319. <ul>
  320. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  321. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  322. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
  323. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  324. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  325. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  326. </ul>
  327. <h3>Project Links</h3>
  328. <ul>
  329. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  330. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  331. <li><a href="https://searx.space">Public instances</a>
  332. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  333. </ul><h3>Navigation</h3>
  334. <ul>
  335. <li><a href="../../index.html">Overview</a>
  336. <ul>
  337. <li><a href="../index.html">Module code</a>
  338. </ul>
  339. </li>
  340. </ul>
  341. </li>
  342. </ul>
  343. <search id="searchbox" style="display: none" role="search">
  344. <h3 id="searchlabel">Quick search</h3>
  345. <div class="searchformwrapper">
  346. <form class="search" action="../../search.html" method="get">
  347. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  348. <input type="submit" value="Go" />
  349. </form>
  350. </div>
  351. </search>
  352. <script>document.getElementById('searchbox').style.display = "block"</script>
  353. </div>
  354. </div>
  355. <div class="clearer"></div>
  356. </div>
  357. <div class="footer" role="contentinfo">
  358. &#169; Copyright SearXNG team.
  359. </div>
  360. </body>
  361. </html>