mullvad_leta.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  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.engines.mullvad_leta &#8212; SearXNG Documentation (2025.5.2+590b21165)</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=8c00f3b4"></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.5.2+590b21165" 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.5.2+590b21165)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
  29. <li class="nav-item nav-item-this"><a href="">searx.engines.mullvad_leta</a></li>
  30. </ul>
  31. </div>
  32. <div class="document">
  33. <div class="documentwrapper">
  34. <div class="bodywrapper">
  35. <div class="body" role="main">
  36. <h1>Source code for searx.engines.mullvad_leta</h1><div class="highlight"><pre>
  37. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  38. <span class="sd">&quot;&quot;&quot;Mullvad Leta is a search engine proxy. Currently Leta only offers text</span>
  39. <span class="sd">search results not image, news or any other types of search result. Leta acts</span>
  40. <span class="sd">as a proxy to Google and Brave search results. You can select which backend</span>
  41. <span class="sd">search engine you wish to use, see (:py:obj:`leta_engine`).</span>
  42. <span class="sd">.. hint::</span>
  43. <span class="sd"> Leta caches each search for up to 30 days. For example, if you use search</span>
  44. <span class="sd"> terms like ``news``, contrary to your intention you&#39;ll get very old results!</span>
  45. <span class="sd">Configuration</span>
  46. <span class="sd">=============</span>
  47. <span class="sd">The engine has the following additional settings:</span>
  48. <span class="sd">- :py:obj:`leta_engine` (:py:obj:`LetaEnginesType`)</span>
  49. <span class="sd">You can configure one Leta engine for Google and one for Brave:</span>
  50. <span class="sd">.. code:: yaml</span>
  51. <span class="sd"> - name: mullvadleta</span>
  52. <span class="sd"> engine: mullvad_leta</span>
  53. <span class="sd"> leta_engine: google</span>
  54. <span class="sd"> shortcut: ml</span>
  55. <span class="sd"> - name: mullvadleta brave</span>
  56. <span class="sd"> engine: mullvad_leta</span>
  57. <span class="sd"> network: mullvadleta # use network from engine &quot;mullvadleta&quot; configured above</span>
  58. <span class="sd"> leta_engine: brave</span>
  59. <span class="sd"> shortcut: mlb</span>
  60. <span class="sd">Implementations</span>
  61. <span class="sd">===============</span>
  62. <span class="sd">&quot;&quot;&quot;</span>
  63. <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>
  64. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
  65. <span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
  66. <span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
  67. <span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">Response</span>
  68. <span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
  69. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
  70. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_official_locales</span><span class="p">,</span> <span class="n">language_tag</span><span class="p">,</span> <span class="n">region_tag</span>
  71. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">eval_xpath_list</span>
  72. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span><span class="p">,</span> <span class="n">MainResult</span>
  73. <span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
  74. <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
  75. <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
  76. <span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
  77. <span class="n">search_url</span> <span class="o">=</span> <span class="s2">&quot;https://leta.mullvad.net&quot;</span>
  78. <span class="c1"># about</span>
  79. <span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
  80. <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="n">search_url</span><span class="p">,</span>
  81. <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q47008412&#39;</span><span class="p">,</span> <span class="c1"># the Mullvad id - not leta, but related</span>
  82. <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://leta.mullvad.net/faq&#39;</span><span class="p">,</span>
  83. <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
  84. <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
  85. <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
  86. <span class="p">}</span>
  87. <span class="c1"># engine dependent config</span>
  88. <span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;general&quot;</span><span class="p">,</span> <span class="s2">&quot;web&quot;</span><span class="p">]</span>
  89. <span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
  90. <span class="n">max_page</span> <span class="o">=</span> <span class="mi">10</span>
  91. <span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
  92. <span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span>
  93. <span class="s2">&quot;day&quot;</span><span class="p">:</span> <span class="s2">&quot;d&quot;</span><span class="p">,</span>
  94. <span class="s2">&quot;week&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span>
  95. <span class="s2">&quot;month&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
  96. <span class="s2">&quot;year&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">,</span>
  97. <span class="p">}</span>
  98. <span class="n">LetaEnginesType</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;google&quot;</span><span class="p">,</span> <span class="s2">&quot;brave&quot;</span><span class="p">]</span>
  99. <span class="sd">&quot;&quot;&quot;Engine types supported by mullvadleta.&quot;&quot;&quot;</span>
  100. <span class="n">leta_engine</span><span class="p">:</span> <span class="n">LetaEnginesType</span> <span class="o">=</span> <span class="s2">&quot;google&quot;</span>
  101. <span class="sd">&quot;&quot;&quot;Select Leta&#39;s engine type from :py:obj:`LetaEnginesType`.&quot;&quot;&quot;</span>
  102. <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">_</span><span class="p">):</span>
  103. <span class="n">l</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">LetaEnginesType</span><span class="p">)</span>
  104. <span class="k">if</span> <span class="n">leta_engine</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">l</span><span class="p">:</span>
  105. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;leta_engine &#39;</span><span class="si">{</span><span class="n">leta_engine</span><span class="si">}</span><span class="s2">&#39; is invalid, use one of </span><span class="si">{</span><span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">l</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  106. <div class="viewcode-block" id="DataNodeQueryMetaDataIndices">
  107. <a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeQueryMetaDataIndices">[docs]</a>
  108. <span class="k">class</span><span class="w"> </span><span class="nc">DataNodeQueryMetaDataIndices</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
  109. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Indices into query metadata.&quot;&quot;&quot;</span>
  110. <span class="n">success</span><span class="p">:</span> <span class="nb">int</span>
  111. <span class="n">q</span><span class="p">:</span> <span class="nb">int</span> <span class="c1"># pylint: disable=invalid-name</span>
  112. <span class="n">country</span><span class="p">:</span> <span class="nb">int</span>
  113. <span class="n">language</span><span class="p">:</span> <span class="nb">int</span>
  114. <span class="n">lastUpdated</span><span class="p">:</span> <span class="nb">int</span>
  115. <span class="n">engine</span><span class="p">:</span> <span class="nb">int</span>
  116. <span class="n">items</span><span class="p">:</span> <span class="nb">int</span>
  117. <span class="n">infobox</span><span class="p">:</span> <span class="nb">int</span>
  118. <span class="n">news</span><span class="p">:</span> <span class="nb">int</span>
  119. <span class="n">timestamp</span><span class="p">:</span> <span class="nb">int</span>
  120. <span class="n">altered</span><span class="p">:</span> <span class="nb">int</span>
  121. <span class="n">page</span><span class="p">:</span> <span class="nb">int</span>
  122. <span class="nb">next</span><span class="p">:</span> <span class="nb">int</span> <span class="c1"># if -1, there no more results are available</span>
  123. <span class="n">previous</span><span class="p">:</span> <span class="nb">int</span></div>
  124. <div class="viewcode-block" id="DataNodeResultIndices">
  125. <a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeResultIndices">[docs]</a>
  126. <span class="k">class</span><span class="w"> </span><span class="nc">DataNodeResultIndices</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
  127. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Indices into query resultsdata.&quot;&quot;&quot;</span>
  128. <span class="n">link</span><span class="p">:</span> <span class="nb">int</span>
  129. <span class="n">snippet</span><span class="p">:</span> <span class="nb">int</span>
  130. <span class="n">title</span><span class="p">:</span> <span class="nb">int</span>
  131. <span class="n">favicon</span><span class="p">:</span> <span class="nb">int</span></div>
  132. <span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
  133. <span class="n">params</span><span class="p">[</span><span class="s2">&quot;method&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;GET&quot;</span>
  134. <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
  135. <span class="s2">&quot;q&quot;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
  136. <span class="s2">&quot;engine&quot;</span><span class="p">:</span> <span class="n">leta_engine</span><span class="p">,</span>
  137. <span class="s2">&quot;x-sveltekit-invalidated&quot;</span><span class="p">:</span> <span class="s2">&quot;001&quot;</span><span class="p">,</span> <span class="c1"># hardcoded from all requests seen</span>
  138. <span class="p">}</span>
  139. <span class="n">country</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">),</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span> <span class="c1"># type: ignore</span>
  140. <span class="k">if</span> <span class="n">country</span><span class="p">:</span>
  141. <span class="n">args</span><span class="p">[</span><span class="s2">&quot;country&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">country</span>
  142. <span class="n">language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">),</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span> <span class="c1"># type: ignore</span>
  143. <span class="k">if</span> <span class="n">language</span><span class="p">:</span>
  144. <span class="n">args</span><span class="p">[</span><span class="s2">&quot;language&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">language</span>
  145. <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
  146. <span class="n">args</span><span class="p">[</span><span class="s2">&quot;lastUpdated&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">]]</span>
  147. <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
  148. <span class="n">args</span><span class="p">[</span><span class="s2">&quot;page&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span>
  149. <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">search_url</span><span class="si">}</span><span class="s2">/search/__data.json?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
  150. <span class="k">return</span> <span class="n">params</span>
  151. <span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
  152. <span class="n">json_response</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
  153. <span class="n">nodes</span> <span class="o">=</span> <span class="n">json_response</span><span class="p">[</span><span class="s2">&quot;nodes&quot;</span><span class="p">]</span>
  154. <span class="c1"># 0: is None</span>
  155. <span class="c1"># 1: has &quot;connected=True&quot;, not useful</span>
  156. <span class="c1"># 2: query results within &quot;data&quot;</span>
  157. <span class="n">data_nodes</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">2</span><span class="p">][</span><span class="s2">&quot;data&quot;</span><span class="p">]</span>
  158. <span class="c1"># Instead of nested object structure, all objects are flattened into a</span>
  159. <span class="c1"># list. Rather, the first object in data_node provides indices into the</span>
  160. <span class="c1"># &quot;data_nodes&quot; to access each searchresult (which is an object of more</span>
  161. <span class="c1"># indices)</span>
  162. <span class="c1">#</span>
  163. <span class="c1"># Read the relative TypedDict definitions for details</span>
  164. <span class="n">query_meta_data</span><span class="p">:</span> <span class="n">DataNodeQueryMetaDataIndices</span> <span class="o">=</span> <span class="n">data_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  165. <span class="n">query_items_indices</span> <span class="o">=</span> <span class="n">query_meta_data</span><span class="p">[</span><span class="s2">&quot;items&quot;</span><span class="p">]</span>
  166. <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
  167. <span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="n">data_nodes</span><span class="p">[</span><span class="n">query_items_indices</span><span class="p">]:</span>
  168. <span class="n">query_item_indices</span><span class="p">:</span> <span class="n">DataNodeResultIndices</span> <span class="o">=</span> <span class="n">data_nodes</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span>
  169. <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
  170. <span class="n">MainResult</span><span class="p">(</span>
  171. <span class="n">url</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;link&quot;</span><span class="p">]],</span>
  172. <span class="n">title</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;title&quot;</span><span class="p">]],</span>
  173. <span class="n">content</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;snippet&quot;</span><span class="p">]],</span>
  174. <span class="p">)</span>
  175. <span class="p">)</span>
  176. <span class="k">return</span> <span class="n">results</span>
  177. <div class="viewcode-block" id="fetch_traits">
  178. <a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.fetch_traits">[docs]</a>
  179. <span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  180. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Fetch languages and regions from Mullvad-Leta&quot;&quot;&quot;</span>
  181. <span class="k">def</span><span class="w"> </span><span class="nf">extract_table_data</span><span class="p">(</span><span class="n">table</span><span class="p">):</span>
  182. <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;.//tr&quot;</span><span class="p">)[</span><span class="mi">2</span><span class="p">:]:</span>
  183. <span class="n">cells</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;.//td | .//th&quot;</span><span class="p">)</span> <span class="c1"># includes headers and data</span>
  184. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cells</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># ensure the column exists</span>
  185. <span class="n">cell0</span> <span class="o">=</span> <span class="n">cells</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
  186. <span class="n">cell1</span> <span class="o">=</span> <span class="n">cells</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
  187. <span class="k">yield</span> <span class="p">[</span><span class="n">cell0</span><span class="p">,</span> <span class="n">cell1</span><span class="p">]</span>
  188. <span class="c1"># pylint: disable=import-outside-toplevel</span>
  189. <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
  190. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span> <span class="k">as</span> <span class="n">http_get</span>
  191. <span class="c1"># pylint: enable=import-outside-toplevel</span>
  192. <span class="n">resp</span> <span class="o">=</span> <span class="n">http_get</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">search_url</span><span class="si">}</span><span class="s2">/documentation&quot;</span><span class="p">)</span>
  193. <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">resp</span><span class="p">,</span> <span class="n">Response</span><span class="p">):</span>
  194. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: failed to get response from mullvad-leta. Are you connected to the VPN?&quot;</span><span class="p">)</span>
  195. <span class="k">return</span>
  196. <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
  197. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from mullvad-leta is not OK. Are you connected to the VPN?&quot;</span><span class="p">)</span>
  198. <span class="k">return</span>
  199. <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
  200. <span class="c1"># There are 4 HTML tables on the documentation page for extracting information:</span>
  201. <span class="c1"># 0. Keyboard Shortcuts</span>
  202. <span class="c1"># 1. Query Parameters (shoutout to Mullvad for accessible docs for integration)</span>
  203. <span class="c1"># 2. Country Codes [Country, Code]</span>
  204. <span class="c1"># 3. Language Codes [Language, Code]</span>
  205. <span class="n">tables</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="s2">&quot;//table&quot;</span><span class="p">)</span>
  206. <span class="k">if</span> <span class="n">tables</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">tables</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
  207. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: could not find any tables. Was the page updated?&quot;</span><span class="p">)</span>
  208. <span class="n">language_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
  209. <span class="n">lang_map</span> <span class="o">=</span> <span class="p">{</span>
  210. <span class="s2">&quot;zh-hant&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_Hans&quot;</span><span class="p">,</span>
  211. <span class="s2">&quot;zh-hans&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_Hant&quot;</span><span class="p">,</span>
  212. <span class="s2">&quot;jp&quot;</span><span class="p">:</span> <span class="s2">&quot;ja&quot;</span><span class="p">,</span>
  213. <span class="p">}</span>
  214. <span class="k">for</span> <span class="n">language</span><span class="p">,</span> <span class="n">code</span> <span class="ow">in</span> <span class="n">extract_table_data</span><span class="p">(</span><span class="n">language_table</span><span class="p">):</span>
  215. <span class="n">locale_tag</span> <span class="o">=</span> <span class="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">code</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span> <span class="c1"># type: ignore</span>
  216. <span class="k">try</span><span class="p">:</span>
  217. <span class="n">locale</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">locale_tag</span><span class="p">)</span>
  218. <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
  219. <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: Mullvad-Leta language </span><span class="si">{</span><span class="n">language</span><span class="si">}</span><span class="s2"> (</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">) is unknown by babel&quot;</span><span class="p">)</span>
  220. <span class="k">continue</span>
  221. <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
  222. <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">code</span>
  223. <span class="n">country_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
  224. <span class="n">country_map</span> <span class="o">=</span> <span class="p">{</span>
  225. <span class="s2">&quot;cn&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-CN&quot;</span><span class="p">,</span>
  226. <span class="s2">&quot;hk&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-HK&quot;</span><span class="p">,</span>
  227. <span class="s2">&quot;jp&quot;</span><span class="p">:</span> <span class="s2">&quot;ja-JP&quot;</span><span class="p">,</span>
  228. <span class="s2">&quot;my&quot;</span><span class="p">:</span> <span class="s2">&quot;ms-MY&quot;</span><span class="p">,</span>
  229. <span class="s2">&quot;tw&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-TW&quot;</span><span class="p">,</span>
  230. <span class="s2">&quot;uk&quot;</span><span class="p">:</span> <span class="s2">&quot;en-GB&quot;</span><span class="p">,</span>
  231. <span class="s2">&quot;us&quot;</span><span class="p">:</span> <span class="s2">&quot;en-US&quot;</span><span class="p">,</span>
  232. <span class="p">}</span>
  233. <span class="k">for</span> <span class="n">country</span><span class="p">,</span> <span class="n">code</span> <span class="ow">in</span> <span class="n">extract_table_data</span><span class="p">(</span><span class="n">country_table</span><span class="p">):</span>
  234. <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">country_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">code</span><span class="p">)</span>
  235. <span class="k">if</span> <span class="n">sxng_tag</span><span class="p">:</span>
  236. <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">code</span>
  237. <span class="k">continue</span>
  238. <span class="k">try</span><span class="p">:</span>
  239. <span class="n">locale</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">code</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">code</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  240. <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
  241. <span class="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
  242. <span class="k">if</span> <span class="n">locale</span><span class="p">:</span>
  243. <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">code</span>
  244. <span class="k">continue</span>
  245. <span class="n">official_locales</span> <span class="o">=</span> <span class="n">get_official_locales</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="n">regional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
  246. <span class="k">if</span> <span class="ow">not</span> <span class="n">official_locales</span><span class="p">:</span>
  247. <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: Mullvad-Leta country &#39;</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">&#39; (</span><span class="si">{</span><span class="n">country</span><span class="si">}</span><span class="s2">) could not be mapped as expected.&quot;</span><span class="p">)</span>
  248. <span class="k">continue</span>
  249. <span class="k">for</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">official_locales</span><span class="p">:</span>
  250. <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">code</span></div>
  251. </pre></div>
  252. <div class="clearer"></div>
  253. </div>
  254. </div>
  255. </div>
  256. <span id="sidebar-top"></span>
  257. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  258. <div class="sphinxsidebarwrapper">
  259. <p class="logo"><a href="../../../index.html">
  260. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  261. </a></p>
  262. <h3><a href="../../../index.html">Table of Contents</a></h3>
  263. <ul>
  264. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  265. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  266. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  267. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  268. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  269. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  270. </ul>
  271. <h3>Project Links</h3>
  272. <ul>
  273. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  274. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  275. <li><a href="https://searx.space">Public instances</a>
  276. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  277. </ul><h3>Navigation</h3>
  278. <ul>
  279. <li><a href="../../../index.html">Overview</a>
  280. <ul>
  281. <li><a href="../../index.html">Module code</a>
  282. <ul>
  283. <li><a href="../engines.html">searx.engines</a>
  284. </ul>
  285. </li></ul>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. <search id="searchbox" style="display: none" role="search">
  291. <h3 id="searchlabel">Quick search</h3>
  292. <div class="searchformwrapper">
  293. <form class="search" action="../../../search.html" method="get">
  294. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  295. <input type="submit" value="Go" />
  296. </form>
  297. </div>
  298. </search>
  299. <script>document.getElementById('searchbox').style.display = "block"</script>
  300. </div>
  301. </div>
  302. <div class="clearer"></div>
  303. </div>
  304. <div class="footer" role="contentinfo">
  305. &#169; Copyright SearXNG team.
  306. </div>
  307. </body>
  308. </html>