Files
searxng/_modules/searx/engines/duckduckgo.html
2026-04-07 13:50:33 +00:00

740 lines
72 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.duckduckgo &#8212; SearXNG Documentation (2026.4.7+08ef7a63d)</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=4261a3fe"></script>
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2026.4.7+08ef7a63d" 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 (2026.4.7+08ef7a63d)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">searx.engines.duckduckgo</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.engines.duckduckgo</h1><div class="highlight"><pre>
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">DuckDuckGo WEB</span>
<span class="sd">~~~~~~~~~~~~~~</span>
<span class="sd">DDG&#39;s WEB search:</span>
<span class="sd">- DuckDuckGo WEB : ``https://links.duckduckgo.com/d.js?q=..`` (HTTP GET)</span>
<span class="sd">- DuckDuckGo WEB no-AI: ``https://noai.duckduckgo.com/`` (HTTP GET)</span>
<span class="sd">- DuckDuckGo WEB html : ``https://html.duckduckgo.com/html`` (HTTP POST no-JS / form data)</span>
<span class="sd">- DuckDuckGo WEB lite : ``https://lite.duckduckgo.com/lite`` (HTTP POST no-JS / form data)</span>
<span class="sd">DDG&#39;s content search / see engine ``duckduckgo_extra.py``</span>
<span class="sd">- DuckDuckGo Images : ``https://duckduckgo.com/i.js??q=...&amp;vqd=...``</span>
<span class="sd">- DuckDuckGo Videos : ``https://duckduckgo.com/v.js??q=...&amp;vqd=...``</span>
<span class="sd">- DuckDuckGo News : ``https://duckduckgo.com/news.js??q=...&amp;vqd=...``</span>
<span class="sd">.. hint::</span>
<span class="sd"> For WEB searches and to determine the ``vqd`` value, DDG-html (no-JS) is</span>
<span class="sd"> used.</span>
<span class="sd">Special features of the no-JS services (DDG-lite &amp; DDG-html):</span>
<span class="sd">- The no-JS clients receive a form that contains all the controlling parameters.</span>
<span class="sd">- When the form data is submitted, a real WEB browser sets the HTTP *Sec-Fetch*</span>
<span class="sd"> headers.</span>
<span class="sd">HTML ``&lt;form&gt;``, HTTP-Headers &amp; DDG&#39;s bot Blocker:</span>
<span class="sd"> The HTTP User-Agent_ (see below) is generated by the WEB-client and are</span>
<span class="sd"> checked by DDG&#39;s bot blocker.</span>
<span class="sd">To simulate the behavior of a real browser session, it might be necessary to</span>
<span class="sd">evaluate additional headers. For example, in the response from DDG, the</span>
<span class="sd">Referrer-Policy_ is always set to ``origin``. A real browser would then include</span>
<span class="sd">the following header in the next request::</span>
<span class="sd"> Referer: https://html.duckduckgo.com/</span>
<span class="sd">The fields of the html-form are reverse-engineered from DDG-html and may be</span>
<span class="sd">subject to additional bot detection mechanisms and breaking changes in the</span>
<span class="sd">future.</span>
<span class="sd">Query field:</span>
<span class="sd">Intro page: https://html.duckduckgo.com/html/</span>
<span class="sd">- ``q`` (str): Search query string</span>
<span class="sd">- ``b`` (str): Beginning parameter - empty string for first page requests. If a</span>
<span class="sd"> second page is requested, this field is not set!</span>
<span class="sd">Search options:</span>
<span class="sd">- ``kl`` (str): Keyboard language/region code (e.g. &#39;en-us&#39; default: &#39;wt-wt&#39;)</span>
<span class="sd">- ``df`` (str): Time filter, maps to values like &#39;d&#39; (day), &#39;w&#39; (week), &#39;m&#39; (month), &#39;y&#39; (year)</span>
<span class="sd">The key/value pairs ``df`` and ``kl`` are additional saved in the cookies,</span>
<span class="sd">example::</span>
<span class="sd"> Cookie: kl=en-us; df=m</span>
<span class="sd">*next page* form fields:</span>
<span class="sd">- ``nextParams`` (str): Continuation parameters from previous page response,</span>
<span class="sd"> typically empty string. Opposite of ``b``; this field is not set when</span>
<span class="sd"> requesting the first result page.</span>
<span class="sd">- ``api`` (str): API endpoint identifier, typically &#39;d.js&#39;</span>
<span class="sd">- ``o`` (str): Output format, typically ``json``</span>
<span class="sd">- ``v`` (str): Typically ``l`` for subsequent pages</span>
<span class="sd">- ``dc`` (int): Display count - value equal to offset (s) + 1</span>
<span class="sd">- ``s`` (int): Search offset for pagination</span>
<span class="sd">- ``vqd`` (str): Validation query digest</span>
<span class="sd">General assumptions regarding DDG&#39;s bot blocker:</span>
<span class="sd">- Except ``Cookie: kl=..; df=..`` DDG does not use cookies in any of its</span>
<span class="sd"> services.</span>
<span class="sd">- DDG does not accept queries with more than 499 chars</span>
<span class="sd">- The ``vqd`` value (&quot;Validation query digest&quot;) is needed to pass DDG&#39;s bot</span>
<span class="sd"> protection and is used by all request to DDG.</span>
<span class="sd">- The ``vqd`` value is generally not needed for the first query (intro); it is</span>
<span class="sd"> only required when additional pages are accessed (or when new content needs to</span>
<span class="sd"> be loaded for the query while scrolling).</span>
<span class="sd">- The second page (additional content) for a query cannot be requested without</span>
<span class="sd"> ``vqd``, as this would lead to an immediate blocking, since such a use-case</span>
<span class="sd"> does not exist in the process flows provided by DDG (and is a clear indication</span>
<span class="sd"> of a bot).</span>
<span class="sd">The following HTTP headers are being evaluated (and may possibly be responsible</span>
<span class="sd">for issues):</span>
<span class="sd">User-Agent_:</span>
<span class="sd"> The HTTP User-Agent is also involved in the formation of the vqd value, read</span>
<span class="sd"> `DuckDuckGo Bot Detection Research &amp; Solution`_. However, it is not checked</span>
<span class="sd"> whether the UA is a known header. However, it is possible that certain UA</span>
<span class="sd"> headers (such as curl) are filtered.</span>
<span class="sd">Sec-Fetch-Mode_:</span>
<span class="sd"> In the past, Sec-Fetch-Mode had to be set to &#39;navigate&#39;, otherwise there were</span>
<span class="sd"> problems with the bot blocker.. I don&#39;t know if DDG still evaluates this</span>
<span class="sd"> header today</span>
<span class="sd">Accept-Language_:</span>
<span class="sd"> DDG-Lite and DDG-HTML TRY to guess user&#39;s preferred language from the HTTP</span>
<span class="sd"> ``Accept-Language``. Optional the user can select a region filter (but not a</span>
<span class="sd"> language).</span>
<span class="sd">In DDG&#39;s bot blocker, the IP will be blocked (DDG does not have a client session!)</span>
<span class="sd">- As far as is known, it is possible to remove a un-blocked an IP by executing a</span>
<span class="sd"> DDG query in a real web browser over the blocked IP (at least that&#39;s my</span>
<span class="sd"> assumption).</span>
<span class="sd"> How exactly the blocking mechanism currently works is not fully known, and</span>
<span class="sd"> there were also changes to the bot blocker in the period of Q3/Q4 2025: in the</span>
<span class="sd"> past, the IP blocking was implemented as a &#39;sliding window&#39; (unblock after</span>
<span class="sd"> about 1 hour without requests from this IP)</span>
<span class="sd">Terms / phrases that you keep coming across:</span>
<span class="sd">- ``d.js``, ``i.js``, ``v.js``, ``news.js`` are the endpoints of the DDG&#39;s web</span>
<span class="sd"> API through which additional content for a query can be requested (vqd</span>
<span class="sd"> required)</span>
<span class="sd"> The ``*.js`` endpoints return a JSON response and can therefore only be</span>
<span class="sd"> executed on a JS-capable client.</span>
<span class="sd"> The service at https://lite.duckduckgo.com/lite offers general WEB searches</span>
<span class="sd"> (no news, videos etc). DDG-lite and DDG-html can be used by clients that do</span>
<span class="sd"> not support JS, aka *no-JS*.</span>
<span class="sd"> DDG-lite works a bit differently: here, ``d.js`` is not an endpoint but a</span>
<span class="sd"> field (``api=d.js``) in a form that is sent to DDG-lite.</span>
<span class="sd">- The request argument ``origin=funnel_home_website`` is often seen in the DDG</span>
<span class="sd"> services when the category is changed (e.g., from web search to news, images,</span>
<span class="sd"> or to the video category)</span>
<span class="sd">.. _DuckDuckGo Bot Detection Research &amp; Solution:</span>
<span class="sd"> https://github.com/ggfevans/searxng/blob/mod-sidecar-harvester/docs/ddg-bot-detection-research.md</span>
<span class="sd">.. _Sec-Fetch-Mode:</span>
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Sec-Fetch-Mode&gt;</span>
<span class="sd">.. _Referrer-Policy:</span>
<span class="sd"> https://developer.mozilla.org/docs/Web/HTTP/Reference/Headers/Referrer-Policy#directives</span>
<span class="sd">.. _Referer:</span>
<span class="sd"> https://developer.mozilla.org/de/docs/Web/HTTP/Reference/Headers/Referer</span>
<span class="sd">.. _User-Agent:</span>
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent</span>
<span class="sd">.. _Accept-Language:</span>
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pylint: disable=global-statement</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">lxml.html</span>
<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">locales</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineCache</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.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearxEngineCaptchaException</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.external_bang</span><span class="w"> </span><span class="kn">import</span> <span class="n">EXTERNAL_BANGS</span><span class="p">,</span> <span class="n">get_node</span> <span class="c1"># type: ignore</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="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
<span class="n">ElementType</span><span class="p">,</span>
<span class="n">eval_xpath</span><span class="p">,</span>
<span class="n">eval_xpath_getindex</span><span class="p">,</span>
<span class="n">extr</span><span class="p">,</span>
<span class="n">extract_text</span><span class="p">,</span>
<span class="n">gen_useragent</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Response</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.processors</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineParams</span>
<span class="n">about</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="o">|</span> <span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s2">&quot;https://lite.duckduckgo.com/lite/&quot;</span><span class="p">,</span>
<span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s2">&quot;Q12805&quot;</span><span class="p">,</span>
<span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s2">&quot;HTML&quot;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">categories</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</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>
<span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">time_range_support</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">safesearch</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="sd">&quot;&quot;&quot;DDG-lite: user can&#39;t select but the results are filtered.&quot;&quot;&quot;</span>
<span class="n">ddg_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;https://html.duckduckgo.com/html/&quot;</span>
<span class="sd">&quot;&quot;&quot;The process flow for determining the ``vqd`` values was implemented for the</span>
<span class="sd">no-JS variant (DDG-html)&quot;&quot;&quot;</span>
<span class="n">time_range_dict</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><span class="s2">&quot;day&quot;</span><span class="p">:</span> <span class="s2">&quot;d&quot;</span><span class="p">,</span> <span class="s2">&quot;week&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span> <span class="s2">&quot;month&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span> <span class="s2">&quot;year&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">}</span>
<span class="n">_CACHE</span><span class="p">:</span> <span class="n">EngineCache</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
<span class="sd">&quot;&quot;&quot;Persistent (SQLite) key/value cache that deletes its values after ``expire``</span>
<span class="sd">seconds.&quot;&quot;&quot;</span>
<span class="n">_HTTP_User_Agent</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">gen_useragent</span><span class="p">()</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_cache</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">EngineCache</span><span class="p">:</span>
<span class="k">global</span> <span class="n">_CACHE</span>
<span class="k">if</span> <span class="n">_CACHE</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># pyright: ignore[reportUnnecessaryComparison]</span>
<span class="n">_CACHE</span> <span class="o">=</span> <span class="n">EngineCache</span><span class="p">(</span><span class="s2">&quot;duckduckgo&quot;</span><span class="p">)</span> <span class="c1"># pyright: ignore[reportUnreachable]</span>
<span class="k">return</span> <span class="n">_CACHE</span>
<span class="k">def</span><span class="w"> </span><span class="nf">set_vqd</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">,</span> <span class="n">value</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="s2">&quot;OnlineParams&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cache</span> <span class="o">=</span> <span class="n">get_cache</span><span class="p">()</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">secret_hash</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">query</span><span class="si">}</span><span class="s2">//</span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;User-Agent&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">cache</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span> <span class="n">expire</span><span class="o">=</span><span class="mi">3600</span><span class="p">)</span>
<div class="viewcode-block" id="get_vqd">
<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.get_vqd">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_vqd</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="s2">&quot;OnlineParams&quot;</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the ``vqd`` value that fits to the *query* (and HTTP User-Agent_</span>
<span class="sd"> header).</span>
<span class="sd"> :param query: the query term</span>
<span class="sd"> :param params: request parameters</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">cache</span> <span class="o">=</span> <span class="n">get_cache</span><span class="p">()</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">secret_hash</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">query</span><span class="si">}</span><span class="s2">//</span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;User-Agent&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">value</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;get_vqd: re-use cached value: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="n">value</span></div>
<div class="viewcode-block" id="get_ddg_lang">
<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.get_ddg_lang">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_ddg_lang</span><span class="p">(</span>
<span class="n">eng_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">,</span>
<span class="n">sxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">default</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;en_US&quot;</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get DuckDuckGo&#39;s language identifier from SearXNG&#39;s locale.</span>
<span class="sd"> .. hint::</span>
<span class="sd"> `DDG-lite &lt;https://lite.duckduckgo.com/lite&gt;`__ and the *no Javascript*</span>
<span class="sd"> page https://html.duckduckgo.com/html do not offer a language selection</span>
<span class="sd"> to the user.</span>
<span class="sd"> DDG defines its languages by a region code (:py:obj:`fetch_traits`). To</span>
<span class="sd"> get region and language of a DDG service use:</span>
<span class="sd"> .. code: python</span>
<span class="sd"> eng_region = traits.get_region(params[&quot;searxng_locale&quot;], traits.all_locale)</span>
<span class="sd"> eng_lang = get_ddg_lang(traits, params[&quot;searxng_locale&quot;])</span>
<span class="sd"> It might confuse, but the ``l`` value of the cookie is what SearXNG calls</span>
<span class="sd"> the *region*:</span>
<span class="sd"> .. code:: python</span>
<span class="sd"> # !ddi paris :es-AR --&gt; {&#39;ad&#39;: &#39;es_AR&#39;, &#39;ah&#39;: &#39;ar-es&#39;, &#39;l&#39;: &#39;ar-es&#39;}</span>
<span class="sd"> params[&#39;cookies&#39;][&#39;ad&#39;] = eng_lang</span>
<span class="sd"> params[&#39;cookies&#39;][&#39;ah&#39;] = eng_region</span>
<span class="sd"> params[&#39;cookies&#39;][&#39;l&#39;] = eng_region</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">lang</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
<span class="k">return</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;lang_region&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">lang</span><span class="p">)</span> <span class="ow">or</span> <span class="kc">None</span></div>
<span class="n">ddg_reg_map</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>
<span class="s2">&quot;tw-tzh&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_TW&quot;</span><span class="p">,</span>
<span class="s2">&quot;hk-tzh&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_HK&quot;</span><span class="p">,</span>
<span class="s2">&quot;ct-ca&quot;</span><span class="p">:</span> <span class="s2">&quot;skip&quot;</span><span class="p">,</span> <span class="c1"># ct-ca and es-ca both map to ca_ES</span>
<span class="s2">&quot;es-ca&quot;</span><span class="p">:</span> <span class="s2">&quot;ca_ES&quot;</span><span class="p">,</span>
<span class="s2">&quot;id-en&quot;</span><span class="p">:</span> <span class="s2">&quot;id_ID&quot;</span><span class="p">,</span>
<span class="s2">&quot;no-no&quot;</span><span class="p">:</span> <span class="s2">&quot;nb_NO&quot;</span><span class="p">,</span>
<span class="s2">&quot;jp-jp&quot;</span><span class="p">:</span> <span class="s2">&quot;ja_JP&quot;</span><span class="p">,</span>
<span class="s2">&quot;kr-kr&quot;</span><span class="p">:</span> <span class="s2">&quot;ko_KR&quot;</span><span class="p">,</span>
<span class="s2">&quot;xa-ar&quot;</span><span class="p">:</span> <span class="s2">&quot;ar_SA&quot;</span><span class="p">,</span>
<span class="s2">&quot;sl-sl&quot;</span><span class="p">:</span> <span class="s2">&quot;sl_SI&quot;</span><span class="p">,</span>
<span class="s2">&quot;th-en&quot;</span><span class="p">:</span> <span class="s2">&quot;th_TH&quot;</span><span class="p">,</span>
<span class="s2">&quot;vn-en&quot;</span><span class="p">:</span> <span class="s2">&quot;vi_VN&quot;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">ddg_lang_map</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>
<span class="c1"># use ar --&gt; ar_EG (Egypt&#39;s arabic)</span>
<span class="s2">&quot;ar_DZ&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;ar_JO&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;ar_SA&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use bn --&gt; bn_BD</span>
<span class="s2">&quot;bn_IN&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use de --&gt; de_DE</span>
<span class="s2">&quot;de_CH&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use en --&gt; en_US,</span>
<span class="s2">&quot;en_AU&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;en_CA&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;en_GB&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># Esperanto</span>
<span class="s2">&quot;eo_XX&quot;</span><span class="p">:</span> <span class="s2">&quot;eo&quot;</span><span class="p">,</span>
<span class="c1"># use es --&gt; es_ES,</span>
<span class="s2">&quot;es_AR&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_CL&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_CO&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_CR&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_EC&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_MX&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_PE&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_UY&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;es_VE&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use fr --&gt; rf_FR</span>
<span class="s2">&quot;fr_CA&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;fr_CH&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="s2">&quot;fr_BE&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use nl --&gt; nl_NL</span>
<span class="s2">&quot;nl_BE&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># use pt --&gt; pt_PT</span>
<span class="s2">&quot;pt_BR&quot;</span><span class="p">:</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">,</span>
<span class="c1"># skip these languages</span>
<span class="s2">&quot;od_IN&quot;</span><span class="p">:</span> <span class="s2">&quot;skip&quot;</span><span class="p">,</span>
<span class="s2">&quot;io_XX&quot;</span><span class="p">:</span> <span class="s2">&quot;skip&quot;</span><span class="p">,</span>
<span class="s2">&quot;tokipona_XX&quot;</span><span class="p">:</span> <span class="s2">&quot;skip&quot;</span><span class="p">,</span>
<span class="p">}</span>
<div class="viewcode-block" id="quote_ddg_bangs">
<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.quote_ddg_bangs">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">quote_ddg_bangs</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="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;To avoid a redirect, the !bang directives in the query string are</span>
<span class="sd"> quoted.&quot;&quot;&quot;</span>
<span class="n">_q</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;(\s+)&quot;</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">val</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">val</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;!&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">get_node</span><span class="p">(</span><span class="n">EXTERNAL_BANGS</span><span class="p">,</span> <span class="n">val</span><span class="p">[</span><span class="mi">1</span><span class="p">:]):</span>
<span class="n">val</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">val</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
<span class="n">_q</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_q</span><span class="p">)</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="s2">&quot;OnlineParams&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">500</span><span class="p">:</span>
<span class="c1"># DDG does not accept queries with more than 499 chars</span>
<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="kc">None</span>
<span class="k">return</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">quote_ddg_bangs</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="n">eng_region</span><span class="p">:</span> <span class="nb">str</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="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="p">)</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
<span class="c1"># HTTP headers</span>
<span class="c1"># ============</span>
<span class="n">headers</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">]</span>
<span class="c1"># The vqd value is generated from the query and the UA header. To be able to</span>
<span class="c1"># reuse the vqd value, the UA header must be static.</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;User-Agent&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_HTTP_User_Agent</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Sec-Fetch-Dest&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;document&quot;</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Sec-Fetch-Mode&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;navigate&quot;</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Sec-Fetch-Site&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;same-origin&quot;</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Sec-Fetch-User&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;?1&quot;</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Referer&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;https://html.duckduckgo.com/&quot;</span>
<span class="n">ui_lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;Accept-Language&quot;</span><span class="p">):</span>
<span class="n">headers</span><span class="p">[</span><span class="s2">&quot;Accept-Language&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">ui_lang</span><span class="si">}</span><span class="s2">,</span><span class="si">{</span><span class="n">ui_lang</span><span class="si">}</span><span class="s2">-</span><span class="si">{</span><span class="n">ui_lang</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="si">}</span><span class="s2">;q=0.7&quot;</span>
<span class="c1"># DDG search form (POST data)</span>
<span class="c1"># ===========================</span>
<span class="c1"># form_data: dict[str,str] = {&quot;v&quot;: &quot;l&quot;, &quot;api&quot;: &quot;d.js&quot;, &quot;o&quot;: &quot;json&quot;}</span>
<span class="c1"># &quot;&quot;&quot;The WEB-API &quot;endpoint&quot; is ``api``.&quot;&quot;&quot;</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">]</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;q&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
<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="n">ddg_url</span>
<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;POST&quot;</span>
<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">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;b&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># vqd is required to request other pages after the first one</span>
<span class="n">vqd</span> <span class="o">=</span> <span class="n">get_vqd</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
<span class="k">if</span> <span class="n">vqd</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;vqd&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">vqd</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Don&quot;t try to call follow up pages without a vqd value.</span>
<span class="c1"># DDG recognizes this as a request from a bot. This lowers the</span>
<span class="c1"># reputation of the SearXNG IP and DDG starts to activate CAPTCHAs.</span>
<span class="c1"># set suspend time to zero is OK --&gt; ddg does not block the IP</span>
<span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">(</span>
<span class="n">suspended_time</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;VQD missed (page: </span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">, locale: </span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">)&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;zh&quot;</span><span class="p">):</span>
<span class="c1"># Some locales (at least China) do not have a &quot;next page&quot; button and DDG</span>
<span class="c1"># will return a HTTP/2 403 Forbidden for a request of such a page.</span>
<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="kc">None</span>
<span class="k">return</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;nextParams&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;api&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;d.js&quot;</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;o&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;json&quot;</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;v&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;l&quot;</span>
<span class="n">offset</span> <span class="o">=</span> <span class="mi">10</span> <span class="o">+</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">15</span> <span class="c1"># Page 2 = 10, Page 2+n = 10 + n*15</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;dc&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span> <span class="o">+</span> <span class="mi">1</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;s&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span>
<span class="k">if</span> <span class="n">eng_region</span> <span class="o">==</span> <span class="s2">&quot;wt-wt&quot;</span><span class="p">:</span>
<span class="c1"># Put empty kl in form data if language/region set to all</span>
<span class="c1"># data[&quot;kl&quot;] = &quot;&quot;</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;kl&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;wt-wt&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;kl&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;cookies&quot;</span><span class="p">][</span><span class="s2">&quot;kl&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
<span class="n">t_range</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="o">.</span><span class="n">get</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="s2">&quot;time_range&quot;</span><span class="p">]),</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">t_range</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;df&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">t_range</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;cookies&quot;</span><span class="p">][</span><span class="s2">&quot;df&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">t_range</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">][</span><span class="s2">&quot;Content-Type&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;application/x-www-form-urlencoded&quot;</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">][</span><span class="s2">&quot;Referer&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ddg_url</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;param headers: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">])</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;param data: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">])</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;param cookies: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;cookies&quot;</span><span class="p">])</span>
<div class="viewcode-block" id="is_ddg_captcha">
<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.is_ddg_captcha">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">is_ddg_captcha</span><span class="p">(</span><span class="n">dom</span><span class="p">:</span> <span class="n">ElementType</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;In case of CAPTCHA ddg response its own *not a Robot* dialog and is not</span>
<span class="sd"> redirected to a CAPTCHA page.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form[@id=&#39;challenge-form&#39;]&quot;</span><span class="p">))</span></div>
<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="s2">&quot;SXNG_Response&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
<span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">303</span><span class="p">:</span>
<span class="k">return</span> <span class="n">res</span>
<span class="n">doc</span> <span class="o">=</span> <span class="n">lxml</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="n">params</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">search_params</span>
<span class="k">if</span> <span class="n">is_ddg_captcha</span><span class="p">(</span><span class="n">doc</span><span class="p">):</span>
<span class="c1"># set suspend time to zero is OK --&gt; ddg does not block the IP</span>
<span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">(</span><span class="n">suspended_time</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;CAPTCHA (</span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;kl&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">)&quot;</span><span class="p">)</span>
<span class="n">form</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//input[@name=&quot;vqd&quot;]/..&#39;</span><span class="p">)</span>
<span class="c1"># Some locales (at least China) do not have a &quot;next page&quot; button and DDG</span>
<span class="c1"># will return a HTTP/2 403 Forbidden for a request of such a page.</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">form</span><span class="p">):</span>
<span class="n">form</span> <span class="o">=</span> <span class="n">form</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">form_vqd</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">form</span><span class="p">,</span> <span class="s1">&#39;//input[@name=&quot;vqd&quot;]/@value&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">q</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;data&quot;</span><span class="p">][</span><span class="s2">&quot;q&quot;</span><span class="p">])</span>
<span class="n">set_vqd</span><span class="p">(</span>
<span class="n">query</span><span class="o">=</span><span class="n">q</span><span class="p">,</span>
<span class="n">value</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">form_vqd</span><span class="p">),</span>
<span class="n">params</span><span class="o">=</span><span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># just select &quot;web-result&quot; and ignore results of class &quot;result--ad result--ad--small&quot;</span>
<span class="k">for</span> <span class="n">div_result</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;links&quot;]/div[contains(@class, &quot;web-result&quot;)]&#39;</span><span class="p">):</span>
<span class="n">_title</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s2">&quot;.//h2/a&quot;</span><span class="p">)</span>
<span class="n">_content</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s1">&#39;.//a[contains(@class, &quot;result__snippet&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[])</span>
<span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">MainResult</span><span class="p">(</span>
<span class="n">title</span><span class="o">=</span><span class="n">extract_text</span><span class="p">(</span><span class="n">_title</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s2">&quot;.//h2/a/@href&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
<span class="n">content</span><span class="o">=</span><span class="n">extract_text</span><span class="p">(</span><span class="n">_content</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="n">zero_click_info_xpath</span> <span class="o">=</span> <span class="s1">&#39;//div[@id=&quot;zero_click_abstract&quot;]&#39;</span>
<span class="n">zero_click</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="n">zero_click_info_xpath</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="c1"># type: ignore</span>
<span class="k">if</span> <span class="n">zero_click</span> <span class="ow">and</span> <span class="p">(</span>
<span class="s2">&quot;Your IP address is&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
<span class="ow">and</span> <span class="s2">&quot;Your user agent:&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
<span class="ow">and</span> <span class="s2">&quot;URL Decoded:&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
<span class="p">):</span>
<span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
<span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span>
<span class="n">answer</span><span class="o">=</span><span class="n">zero_click</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;zero_click_abstract&quot;]/a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">res</span>
<div class="viewcode-block" id="fetch_traits">
<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.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="w"> </span><span class="sd">&quot;&quot;&quot;Fetch languages &amp; regions from DuckDuckGo.</span>
<span class="sd"> SearXNG&#39;s ``all`` locale maps DuckDuckGo&#39;s &quot;All regions&quot; (``wt-wt``).</span>
<span class="sd"> DuckDuckGo&#39;s language &quot;Browsers preferred language&quot; (``wt_WT``) makes no</span>
<span class="sd"> sense in a SearXNG request since SearXNG&#39;s ``all`` will not add a</span>
<span class="sd"> ``Accept-Language`` HTTP header. The value in ``engine_traits.all_locale``</span>
<span class="sd"> is ``wt-wt`` (the region).</span>
<span class="sd"> Beside regions DuckDuckGo also defines its languages by region codes. By</span>
<span class="sd"> example these are the english languages in DuckDuckGo:</span>
<span class="sd"> - en_US</span>
<span class="sd"> - en_AU</span>
<span class="sd"> - en_CA</span>
<span class="sd"> - en_GB</span>
<span class="sd"> The function :py:obj:`get_ddg_lang` evaluates DuckDuckGo&#39;s language from</span>
<span class="sd"> SearXNG&#39;s locale.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># pylint: disable=too-many-branches, too-many-statements, disable=import-outside-toplevel</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="c1"># see https://github.com/searxng/searxng/issues/762</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">js_obj_str_to_python</span>
<span class="c1"># fetch regions</span>
<span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s2">&quot;wt-wt&quot;</span>
<span class="c1"># updated from u661.js to u.7669f071a13a7daa57cb / should be updated automatically?</span>
<span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s2">&quot;https://duckduckgo.com/dist/util/u.7669f071a13a7daa57cb.js&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">)</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="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Response from DuckDuckGo regions is not OK.&quot;</span><span class="p">)</span>
<span class="n">js_code</span> <span class="o">=</span> <span class="n">extr</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="s2">&quot;regions:&quot;</span><span class="p">,</span> <span class="s2">&quot;,snippetLengths&quot;</span><span class="p">)</span>
<span class="n">regions</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">js_code</span><span class="p">)</span>
<span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">regions</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">eng_tag</span> <span class="o">==</span> <span class="s2">&quot;wt-wt&quot;</span><span class="p">:</span>
<span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s2">&quot;wt-wt&quot;</span>
<span class="k">continue</span>
<span class="n">region</span> <span class="o">=</span> <span class="n">ddg_reg_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">)</span>
<span class="k">if</span> <span class="n">region</span> <span class="o">==</span> <span class="s2">&quot;skip&quot;</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">region</span><span class="p">:</span>
<span class="n">eng_territory</span><span class="p">,</span> <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">eng_tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)</span>
<span class="n">region</span> <span class="o">=</span> <span class="n">eng_lang</span> <span class="o">+</span> <span class="s2">&quot;_&quot;</span> <span class="o">+</span> <span class="n">eng_territory</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">region_tag</span><span class="p">(</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">region</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="s2">&quot;ERROR: </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) -&gt; </span><span class="si">%s</span><span class="s2"> is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">region</span><span class="p">))</span>
<span class="k">continue</span>
<span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
<span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
<span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
<span class="k">continue</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">eng_tag</span>
<span class="c1"># fetch languages</span>
<span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;lang_region&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">js_code</span> <span class="o">=</span> <span class="n">extr</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="s2">&quot;languages:&quot;</span><span class="p">,</span> <span class="s2">&quot;,regions&quot;</span><span class="p">)</span>
<span class="n">languages</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="n">js_obj_str_to_python</span><span class="p">(</span><span class="n">js_code</span><span class="p">)</span>
<span class="k">for</span> <span class="n">eng_lang</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">languages</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="n">eng_lang</span> <span class="o">==</span> <span class="s2">&quot;wt_WT&quot;</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">babel_tag</span> <span class="o">=</span> <span class="n">ddg_lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">)</span>
<span class="k">if</span> <span class="n">babel_tag</span> <span class="o">==</span> <span class="s2">&quot;skip&quot;</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">babel_tag</span> <span class="o">==</span> <span class="s2">&quot;lang_region&quot;</span><span class="p">:</span>
<span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">region_tag</span><span class="p">(</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">eng_lang</span><span class="p">))</span>
<span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;lang_region&quot;</span><span class="p">][</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
<span class="k">continue</span>
<span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">language_tag</span><span class="p">(</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">babel_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="s2">&quot;ERROR: language </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
<span class="k">continue</span>
<span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
<span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
<span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_lang</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
<span class="k">continue</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">eng_lang</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">
&#169; Copyright SearXNG team.
</div>
</body>
</html>