390 lines
36 KiB
HTML
390 lines
36 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="../../../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>searx.engines.mullvad_leta — SearXNG Documentation (2025.5.15+cd64fb966)</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
|
|
<script src="../../../_static/documentation_options.js?v=44c31d63"></script>
|
|
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script data-project="searxng" data-version="2025.5.15+cd64fb966" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.15+cd64fb966)</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">searx.engines.mullvad_leta</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for searx.engines.mullvad_leta</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
|
<span class="sd">"""Mullvad Leta is a search engine proxy. Currently Leta only offers text</span>
|
|
<span class="sd">search results not image, news or any other types of search result. Leta acts</span>
|
|
<span class="sd">as a proxy to Google and Brave search results. You can select which backend</span>
|
|
<span class="sd">search engine you wish to use, see (:py:obj:`leta_engine`).</span>
|
|
|
|
<span class="sd">.. hint::</span>
|
|
|
|
<span class="sd"> Leta caches each search for up to 30 days. For example, if you use search</span>
|
|
<span class="sd"> terms like ``news``, contrary to your intention you'll get very old results!</span>
|
|
|
|
|
|
<span class="sd">Configuration</span>
|
|
<span class="sd">=============</span>
|
|
|
|
<span class="sd">The engine has the following additional settings:</span>
|
|
|
|
<span class="sd">- :py:obj:`leta_engine` (:py:obj:`LetaEnginesType`)</span>
|
|
|
|
<span class="sd">You can configure one Leta engine for Google and one for Brave:</span>
|
|
|
|
<span class="sd">.. code:: yaml</span>
|
|
|
|
<span class="sd"> - name: mullvadleta</span>
|
|
<span class="sd"> engine: mullvad_leta</span>
|
|
<span class="sd"> leta_engine: google</span>
|
|
<span class="sd"> shortcut: ml</span>
|
|
|
|
<span class="sd"> - name: mullvadleta brave</span>
|
|
<span class="sd"> engine: mullvad_leta</span>
|
|
<span class="sd"> network: mullvadleta # use network from engine "mullvadleta" configured above</span>
|
|
<span class="sd"> leta_engine: brave</span>
|
|
<span class="sd"> shortcut: mlb</span>
|
|
|
|
<span class="sd">Implementations</span>
|
|
<span class="sd">===============</span>
|
|
|
|
<span class="sd">"""</span>
|
|
|
|
<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>
|
|
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
|
|
<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>
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
|
|
<span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
|
|
|
|
<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>
|
|
|
|
<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
|
|
|
|
<span class="n">search_url</span> <span class="o">=</span> <span class="s2">"https://leta.mullvad.net"</span>
|
|
|
|
<span class="c1"># about</span>
|
|
<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"website"</span><span class="p">:</span> <span class="n">search_url</span><span class="p">,</span>
|
|
<span class="s2">"wikidata_id"</span><span class="p">:</span> <span class="s1">'Q47008412'</span><span class="p">,</span> <span class="c1"># the Mullvad id - not leta, but related</span>
|
|
<span class="s2">"official_api_documentation"</span><span class="p">:</span> <span class="s1">'https://leta.mullvad.net/faq'</span><span class="p">,</span>
|
|
<span class="s2">"use_official_api"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="s2">"require_api_key"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="s2">"results"</span><span class="p">:</span> <span class="s1">'HTML'</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1"># engine dependent config</span>
|
|
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"general"</span><span class="p">,</span> <span class="s2">"web"</span><span class="p">]</span>
|
|
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="n">max_page</span> <span class="o">=</span> <span class="mi">10</span>
|
|
<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"day"</span><span class="p">:</span> <span class="s2">"d"</span><span class="p">,</span>
|
|
<span class="s2">"week"</span><span class="p">:</span> <span class="s2">"w"</span><span class="p">,</span>
|
|
<span class="s2">"month"</span><span class="p">:</span> <span class="s2">"m"</span><span class="p">,</span>
|
|
<span class="s2">"year"</span><span class="p">:</span> <span class="s2">"y"</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<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">"google"</span><span class="p">,</span> <span class="s2">"brave"</span><span class="p">]</span>
|
|
<span class="sd">"""Engine types supported by mullvadleta."""</span>
|
|
|
|
<span class="n">leta_engine</span><span class="p">:</span> <span class="n">LetaEnginesType</span> <span class="o">=</span> <span class="s2">"google"</span>
|
|
<span class="sd">"""Select Leta's engine type from :py:obj:`LetaEnginesType`."""</span>
|
|
|
|
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"leta_engine '</span><span class="si">{</span><span class="n">leta_engine</span><span class="si">}</span><span class="s2">' is invalid, use one of </span><span class="si">{</span><span class="s1">', '</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">"</span><span class="p">)</span>
|
|
|
|
|
|
<div class="viewcode-block" id="DataNodeQueryMetaDataIndices">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeQueryMetaDataIndices">[docs]</a>
|
|
<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>
|
|
<span class="w"> </span><span class="sd">"""Indices into query metadata."""</span>
|
|
|
|
<span class="n">success</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">q</span><span class="p">:</span> <span class="nb">int</span> <span class="c1"># pylint: disable=invalid-name</span>
|
|
<span class="n">country</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">language</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">lastUpdated</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">engine</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">items</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">infobox</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">news</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">timestamp</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">altered</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">page</span><span class="p">:</span> <span class="nb">int</span>
|
|
<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>
|
|
<span class="n">previous</span><span class="p">:</span> <span class="nb">int</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="DataNodeResultIndices">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeResultIndices">[docs]</a>
|
|
<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>
|
|
<span class="w"> </span><span class="sd">"""Indices into query resultsdata."""</span>
|
|
|
|
<span class="n">link</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">snippet</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">title</span><span class="p">:</span> <span class="nb">int</span>
|
|
<span class="n">favicon</span><span class="p">:</span> <span class="nb">int</span></div>
|
|
|
|
|
|
|
|
<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>
|
|
<span class="n">params</span><span class="p">[</span><span class="s2">"method"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"GET"</span>
|
|
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"q"</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
|
|
<span class="s2">"engine"</span><span class="p">:</span> <span class="n">leta_engine</span><span class="p">,</span>
|
|
<span class="s2">"x-sveltekit-invalidated"</span><span class="p">:</span> <span class="s2">"001"</span><span class="p">,</span> <span class="c1"># hardcoded from all requests seen</span>
|
|
<span class="p">}</span>
|
|
|
|
<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">"searxng_locale"</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>
|
|
<span class="k">if</span> <span class="n">country</span><span class="p">:</span>
|
|
<span class="n">args</span><span class="p">[</span><span class="s2">"country"</span><span class="p">]</span> <span class="o">=</span> <span class="n">country</span>
|
|
|
|
<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">"searxng_locale"</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>
|
|
<span class="k">if</span> <span class="n">language</span><span class="p">:</span>
|
|
<span class="n">args</span><span class="p">[</span><span class="s2">"language"</span><span class="p">]</span> <span class="o">=</span> <span class="n">language</span>
|
|
|
|
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"time_range"</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
|
|
<span class="n">args</span><span class="p">[</span><span class="s2">"lastUpdated"</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">"time_range"</span><span class="p">]]</span>
|
|
|
|
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"pageno"</span><span class="p">]</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
|
|
<span class="n">args</span><span class="p">[</span><span class="s2">"page"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"pageno"</span><span class="p">]</span>
|
|
|
|
<span class="n">params</span><span class="p">[</span><span class="s2">"url"</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</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">"</span>
|
|
|
|
<span class="k">return</span> <span class="n">params</span>
|
|
|
|
|
|
<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">-></span> <span class="n">EngineResults</span><span class="p">:</span>
|
|
<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>
|
|
|
|
<span class="n">nodes</span> <span class="o">=</span> <span class="n">json_response</span><span class="p">[</span><span class="s2">"nodes"</span><span class="p">]</span>
|
|
<span class="c1"># 0: is None</span>
|
|
<span class="c1"># 1: has "connected=True", not useful</span>
|
|
<span class="c1"># 2: query results within "data"</span>
|
|
|
|
<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">"data"</span><span class="p">]</span>
|
|
<span class="c1"># Instead of nested object structure, all objects are flattened into a</span>
|
|
<span class="c1"># list. Rather, the first object in data_node provides indices into the</span>
|
|
<span class="c1"># "data_nodes" to access each searchresult (which is an object of more</span>
|
|
<span class="c1"># indices)</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Read the relative TypedDict definitions for details</span>
|
|
|
|
<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>
|
|
|
|
<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">"items"</span><span class="p">]</span>
|
|
|
|
<span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
|
|
<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>
|
|
<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>
|
|
<span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
|
|
<span class="n">MainResult</span><span class="p">(</span>
|
|
<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">"link"</span><span class="p">]],</span>
|
|
<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">"title"</span><span class="p">]],</span>
|
|
<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">"snippet"</span><span class="p">]],</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">results</span>
|
|
|
|
|
|
<div class="viewcode-block" id="fetch_traits">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.fetch_traits">[docs]</a>
|
|
<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">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Fetch languages and regions from Mullvad-Leta"""</span>
|
|
|
|
<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>
|
|
<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">".//tr"</span><span class="p">)[</span><span class="mi">2</span><span class="p">:]:</span>
|
|
<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">".//td | .//th"</span><span class="p">)</span> <span class="c1"># includes headers and data</span>
|
|
<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">></span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># ensure the column exists</span>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
|
|
<span class="c1"># pylint: disable=import-outside-toplevel</span>
|
|
<span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
|
|
<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>
|
|
|
|
<span class="c1"># pylint: enable=import-outside-toplevel</span>
|
|
|
|
<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">"</span><span class="si">{</span><span class="n">search_url</span><span class="si">}</span><span class="s2">/documentation"</span><span class="p">)</span>
|
|
<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>
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"ERROR: failed to get response from mullvad-leta. Are you connected to the VPN?"</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<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>
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"ERROR: response from mullvad-leta is not OK. Are you connected to the VPN?"</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
|
|
<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>
|
|
|
|
<span class="c1"># There are 4 HTML tables on the documentation page for extracting information:</span>
|
|
<span class="c1"># 0. Keyboard Shortcuts</span>
|
|
<span class="c1"># 1. Query Parameters (shoutout to Mullvad for accessible docs for integration)</span>
|
|
<span class="c1"># 2. Country Codes [Country, Code]</span>
|
|
<span class="c1"># 3. Language Codes [Language, Code]</span>
|
|
<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">"//table"</span><span class="p">)</span>
|
|
<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"><=</span> <span class="mi">0</span><span class="p">:</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"ERROR: could not find any tables. Was the page updated?"</span><span class="p">)</span>
|
|
|
|
<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>
|
|
<span class="n">lang_map</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"zh-hant"</span><span class="p">:</span> <span class="s2">"zh_Hans"</span><span class="p">,</span>
|
|
<span class="s2">"zh-hans"</span><span class="p">:</span> <span class="s2">"zh_Hant"</span><span class="p">,</span>
|
|
<span class="s2">"jp"</span><span class="p">:</span> <span class="s2">"ja"</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<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>
|
|
|
|
<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">"-"</span><span class="p">,</span> <span class="s2">"_"</span><span class="p">)</span> <span class="c1"># type: ignore</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<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>
|
|
<span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"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"</span><span class="p">)</span>
|
|
<span class="k">continue</span>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<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>
|
|
<span class="n">country_map</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"cn"</span><span class="p">:</span> <span class="s2">"zh-CN"</span><span class="p">,</span>
|
|
<span class="s2">"hk"</span><span class="p">:</span> <span class="s2">"zh-HK"</span><span class="p">,</span>
|
|
<span class="s2">"jp"</span><span class="p">:</span> <span class="s2">"ja-JP"</span><span class="p">,</span>
|
|
<span class="s2">"my"</span><span class="p">:</span> <span class="s2">"ms-MY"</span><span class="p">,</span>
|
|
<span class="s2">"tw"</span><span class="p">:</span> <span class="s2">"zh-TW"</span><span class="p">,</span>
|
|
<span class="s2">"uk"</span><span class="p">:</span> <span class="s2">"en-GB"</span><span class="p">,</span>
|
|
<span class="s2">"us"</span><span class="p">:</span> <span class="s2">"en-US"</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
<span class="k">if</span> <span class="n">sxng_tag</span><span class="p">:</span>
|
|
<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>
|
|
<span class="k">continue</span>
|
|
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<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">"</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">"</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
|
|
<span class="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="k">if</span> <span class="n">locale</span><span class="p">:</span>
|
|
<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>
|
|
<span class="k">continue</span>
|
|
|
|
<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>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">official_locales</span><span class="p">:</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"ERROR: Mullvad-Leta country '</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">' (</span><span class="si">{</span><span class="n">country</span><span class="si">}</span><span class="s2">) could not be mapped as expected."</span><span class="p">)</span>
|
|
<span class="k">continue</span>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
</pre></div>
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<span id="sidebar-top"></span>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
<p class="logo"><a href="../../../index.html">
|
|
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
|
</a></p>
|
|
|
|
|
|
<h3><a href="../../../index.html">Table of Contents</a></h3>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
|
|
</ul>
|
|
|
|
<h3>Project Links</h3>
|
|
<ul>
|
|
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
|
|
|
|
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
|
|
|
|
<li><a href="https://searx.space">Public instances</a>
|
|
|
|
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
|
|
</ul><h3>Navigation</h3>
|
|
<ul>
|
|
<li><a href="../../../index.html">Overview</a>
|
|
<ul>
|
|
<li><a href="../../index.html">Module code</a>
|
|
<ul>
|
|
<li><a href="../engines.html">searx.engines</a>
|
|
|
|
|
|
</ul>
|
|
</li></ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<search id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright SearXNG team.
|
|
</div>
|
|
</body>
|
|
</html> |