You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
searxng/_modules/searx/engines/google.html

494 lines
49 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<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.google &#8212; SearXNG Documentation (2023.1.23+522ba9a1)</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/tabs.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/tabs.js"></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 navigation">
<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 (2023.1.23+522ba9a1)</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.google</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.engines.google</h1><div class="highlight"><pre>
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
<span class="c1"># lint: pylint</span>
<span class="sd">&quot;&quot;&quot;This is the implementation of the google WEB engine. Some of this</span>
<span class="sd">implementations are shared by other engines:</span>
<span class="sd">- :ref:`google images engine`</span>
<span class="sd">- :ref:`google news engine`</span>
<span class="sd">- :ref:`google videos engine`</span>
<span class="sd">The google WEB engine itself has a special setup option:</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> - name: google</span>
<span class="sd"> ...</span>
<span class="sd"> use_mobile_ui: false</span>
<span class="sd">``use_mobile_ui``: (default: ``false``)</span>
<span class="sd"> Enables to use *mobile endpoint* to bypass the google blocking (see</span>
<span class="sd"> :issue:`159`). On the mobile UI of Google Search, the button :guilabel:`More</span>
<span class="sd"> results` is not affected by Google rate limiting and we can still do requests</span>
<span class="sd"> while actively blocked by the original Google search. By activate</span>
<span class="sd"> ``use_mobile_ui`` this behavior is simulated by adding the parameter</span>
<span class="sd"> ``async=use_ac:true,_fmt:pc`` to the :py:func:`request`.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="kn">import</span> <span class="n">urlencode</span>
<span class="kn">from</span> <span class="nn">lxml</span> <span class="kn">import</span> <span class="n">html</span>
<span class="kn">from</span> <span class="nn">searx.utils</span> <span class="kn">import</span> <span class="n">match_language</span><span class="p">,</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span>
<span class="kn">from</span> <span class="nn">searx.exceptions</span> <span class="kn">import</span> <span class="n">SearxEngineCaptchaException</span>
<span class="c1"># about</span>
<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.google.com&#39;</span><span class="p">,</span>
<span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q9366&#39;</span><span class="p">,</span>
<span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search/&#39;</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="s1">&#39;HTML&#39;</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="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">use_mobile_ui</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">supported_languages_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.google.com/preferences?#languages&#39;</span>
<span class="c1"># based on https://en.wikipedia.org/wiki/List_of_Google_domains and tests</span>
<span class="n">google_domains</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;BG&#39;</span><span class="p">:</span> <span class="s1">&#39;google.bg&#39;</span><span class="p">,</span> <span class="c1"># Bulgaria</span>
<span class="s1">&#39;CZ&#39;</span><span class="p">:</span> <span class="s1">&#39;google.cz&#39;</span><span class="p">,</span> <span class="c1"># Czech Republic</span>
<span class="s1">&#39;DE&#39;</span><span class="p">:</span> <span class="s1">&#39;google.de&#39;</span><span class="p">,</span> <span class="c1"># Germany</span>
<span class="s1">&#39;DK&#39;</span><span class="p">:</span> <span class="s1">&#39;google.dk&#39;</span><span class="p">,</span> <span class="c1"># Denmark</span>
<span class="s1">&#39;AT&#39;</span><span class="p">:</span> <span class="s1">&#39;google.at&#39;</span><span class="p">,</span> <span class="c1"># Austria</span>
<span class="s1">&#39;CH&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ch&#39;</span><span class="p">,</span> <span class="c1"># Switzerland</span>
<span class="s1">&#39;GR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.gr&#39;</span><span class="p">,</span> <span class="c1"># Greece</span>
<span class="s1">&#39;AU&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.au&#39;</span><span class="p">,</span> <span class="c1"># Australia</span>
<span class="s1">&#39;CA&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ca&#39;</span><span class="p">,</span> <span class="c1"># Canada</span>
<span class="s1">&#39;GB&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.uk&#39;</span><span class="p">,</span> <span class="c1"># United Kingdom</span>
<span class="s1">&#39;ID&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.id&#39;</span><span class="p">,</span> <span class="c1"># Indonesia</span>
<span class="s1">&#39;IE&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ie&#39;</span><span class="p">,</span> <span class="c1"># Ireland</span>
<span class="s1">&#39;IN&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.in&#39;</span><span class="p">,</span> <span class="c1"># India</span>
<span class="s1">&#39;MY&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.my&#39;</span><span class="p">,</span> <span class="c1"># Malaysia</span>
<span class="s1">&#39;NZ&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.nz&#39;</span><span class="p">,</span> <span class="c1"># New Zealand</span>
<span class="s1">&#39;PH&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.ph&#39;</span><span class="p">,</span> <span class="c1"># Philippines</span>
<span class="s1">&#39;SG&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.sg&#39;</span><span class="p">,</span> <span class="c1"># Singapore</span>
<span class="s1">&#39;US&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com&#39;</span><span class="p">,</span> <span class="c1"># United States (google.us) redirects to .com</span>
<span class="s1">&#39;ZA&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.za&#39;</span><span class="p">,</span> <span class="c1"># South Africa</span>
<span class="s1">&#39;AR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.ar&#39;</span><span class="p">,</span> <span class="c1"># Argentina</span>
<span class="s1">&#39;CL&#39;</span><span class="p">:</span> <span class="s1">&#39;google.cl&#39;</span><span class="p">,</span> <span class="c1"># Chile</span>
<span class="s1">&#39;ES&#39;</span><span class="p">:</span> <span class="s1">&#39;google.es&#39;</span><span class="p">,</span> <span class="c1"># Spain</span>
<span class="s1">&#39;MX&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.mx&#39;</span><span class="p">,</span> <span class="c1"># Mexico</span>
<span class="s1">&#39;EE&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ee&#39;</span><span class="p">,</span> <span class="c1"># Estonia</span>
<span class="s1">&#39;FI&#39;</span><span class="p">:</span> <span class="s1">&#39;google.fi&#39;</span><span class="p">,</span> <span class="c1"># Finland</span>
<span class="s1">&#39;BE&#39;</span><span class="p">:</span> <span class="s1">&#39;google.be&#39;</span><span class="p">,</span> <span class="c1"># Belgium</span>
<span class="s1">&#39;FR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.fr&#39;</span><span class="p">,</span> <span class="c1"># France</span>
<span class="s1">&#39;IL&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.il&#39;</span><span class="p">,</span> <span class="c1"># Israel</span>
<span class="s1">&#39;HR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.hr&#39;</span><span class="p">,</span> <span class="c1"># Croatia</span>
<span class="s1">&#39;HU&#39;</span><span class="p">:</span> <span class="s1">&#39;google.hu&#39;</span><span class="p">,</span> <span class="c1"># Hungary</span>
<span class="s1">&#39;IT&#39;</span><span class="p">:</span> <span class="s1">&#39;google.it&#39;</span><span class="p">,</span> <span class="c1"># Italy</span>
<span class="s1">&#39;JP&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.jp&#39;</span><span class="p">,</span> <span class="c1"># Japan</span>
<span class="s1">&#39;KR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.kr&#39;</span><span class="p">,</span> <span class="c1"># South Korea</span>
<span class="s1">&#39;LT&#39;</span><span class="p">:</span> <span class="s1">&#39;google.lt&#39;</span><span class="p">,</span> <span class="c1"># Lithuania</span>
<span class="s1">&#39;LV&#39;</span><span class="p">:</span> <span class="s1">&#39;google.lv&#39;</span><span class="p">,</span> <span class="c1"># Latvia</span>
<span class="s1">&#39;NO&#39;</span><span class="p">:</span> <span class="s1">&#39;google.no&#39;</span><span class="p">,</span> <span class="c1"># Norway</span>
<span class="s1">&#39;NL&#39;</span><span class="p">:</span> <span class="s1">&#39;google.nl&#39;</span><span class="p">,</span> <span class="c1"># Netherlands</span>
<span class="s1">&#39;PL&#39;</span><span class="p">:</span> <span class="s1">&#39;google.pl&#39;</span><span class="p">,</span> <span class="c1"># Poland</span>
<span class="s1">&#39;BR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.br&#39;</span><span class="p">,</span> <span class="c1"># Brazil</span>
<span class="s1">&#39;PT&#39;</span><span class="p">:</span> <span class="s1">&#39;google.pt&#39;</span><span class="p">,</span> <span class="c1"># Portugal</span>
<span class="s1">&#39;RO&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ro&#39;</span><span class="p">,</span> <span class="c1"># Romania</span>
<span class="s1">&#39;RU&#39;</span><span class="p">:</span> <span class="s1">&#39;google.ru&#39;</span><span class="p">,</span> <span class="c1"># Russia</span>
<span class="s1">&#39;SK&#39;</span><span class="p">:</span> <span class="s1">&#39;google.sk&#39;</span><span class="p">,</span> <span class="c1"># Slovakia</span>
<span class="s1">&#39;SI&#39;</span><span class="p">:</span> <span class="s1">&#39;google.si&#39;</span><span class="p">,</span> <span class="c1"># Slovenia</span>
<span class="s1">&#39;SE&#39;</span><span class="p">:</span> <span class="s1">&#39;google.se&#39;</span><span class="p">,</span> <span class="c1"># Sweden</span>
<span class="s1">&#39;TH&#39;</span><span class="p">:</span> <span class="s1">&#39;google.co.th&#39;</span><span class="p">,</span> <span class="c1"># Thailand</span>
<span class="s1">&#39;TR&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.tr&#39;</span><span class="p">,</span> <span class="c1"># Turkey</span>
<span class="s1">&#39;UA&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.ua&#39;</span><span class="p">,</span> <span class="c1"># Ukraine</span>
<span class="s1">&#39;CN&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.hk&#39;</span><span class="p">,</span> <span class="c1"># There is no google.cn, we use .com.hk for zh-CN</span>
<span class="s1">&#39;HK&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.hk&#39;</span><span class="p">,</span> <span class="c1"># Hong Kong</span>
<span class="s1">&#39;TW&#39;</span><span class="p">:</span> <span class="s1">&#39;google.com.tw&#39;</span><span class="p">,</span> <span class="c1"># Taiwan</span>
<span class="p">}</span>
<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;d&#39;</span><span class="p">,</span> <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;m&#39;</span><span class="p">,</span> <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="s1">&#39;y&#39;</span><span class="p">}</span>
<span class="c1"># Filter results. 0: None, 1: Moderate, 2: Strict</span>
<span class="n">filter_mapping</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;off&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;medium&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;high&#39;</span><span class="p">}</span>
<span class="c1"># specific xpath variables</span>
<span class="c1"># ------------------------</span>
<span class="n">results_xpath</span> <span class="o">=</span> <span class="s1">&#39;.//div[@data-sokoban-container]&#39;</span>
<span class="n">title_xpath</span> <span class="o">=</span> <span class="s1">&#39;.//a/h3[1]&#39;</span>
<span class="n">href_xpath</span> <span class="o">=</span> <span class="s1">&#39;.//a[h3]/@href&#39;</span>
<span class="n">content_xpath</span> <span class="o">=</span> <span class="s1">&#39;.//div[@data-content-feature=1]&#39;</span>
<span class="c1"># google *sections* are no usual *results*, we ignore them</span>
<span class="n">g_section_with_header</span> <span class="o">=</span> <span class="s1">&#39;./g-section-with-header&#39;</span>
<span class="c1"># Suggestions are links placed in a *card-section*, we extract only the text</span>
<span class="c1"># from the links not the links itself.</span>
<span class="n">suggestion_xpath</span> <span class="o">=</span> <span class="s1">&#39;//div[contains(@class, &quot;EIaa9b&quot;)]//a&#39;</span>
<div class="viewcode-block" id="get_lang_info"><a class="viewcode-back" href="../../../src/searx.engines.google.html#searx.engines.google.get_lang_info">[docs]</a><span class="k">def</span> <span class="nf">get_lang_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">lang_list</span><span class="p">,</span> <span class="n">custom_aliases</span><span class="p">,</span> <span class="n">supported_any_language</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Composing various language properties for the google engines.</span>
<span class="sd"> This function is called by the various google engines (:ref:`google web</span>
<span class="sd"> engine`, :ref:`google images engine`, :ref:`google news engine` and</span>
<span class="sd"> :ref:`google videos engine`).</span>
<span class="sd"> :param dict param: request parameters of the engine</span>
<span class="sd"> :param list lang_list: list of supported languages of the engine</span>
<span class="sd"> :py:obj:`ENGINES_LANGUAGES[engine-name] &lt;searx.data.ENGINES_LANGUAGES&gt;`</span>
<span class="sd"> :param dict lang_list: custom aliases for non standard language codes</span>
<span class="sd"> (used when calling :py:func:`searx.utils.match_language`)</span>
<span class="sd"> :param bool supported_any_language: When a language is not specified, the</span>
<span class="sd"> language interpretation is left up to Google to decide how the search</span>
<span class="sd"> results should be delivered. This argument is ``True`` for the google</span>
<span class="sd"> engine and ``False`` for the other engines (google-images, -news,</span>
<span class="sd"> -scholar, -videos).</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> :returns:</span>
<span class="sd"> Py-Dictionary with the key/value pairs:</span>
<span class="sd"> language:</span>
<span class="sd"> Return value from :py:func:`searx.utils.match_language`</span>
<span class="sd"> country:</span>
<span class="sd"> The country code (e.g. US, AT, CA, FR, DE ..)</span>
<span class="sd"> subdomain:</span>
<span class="sd"> Google subdomain :py:obj:`google_domains` that fits to the country</span>
<span class="sd"> code.</span>
<span class="sd"> params:</span>
<span class="sd"> Py-Dictionary with additional request arguments (can be passed to</span>
<span class="sd"> :py:func:`urllib.parse.urlencode`).</span>
<span class="sd"> headers:</span>
<span class="sd"> Py-Dictionary with additional HTTP headers (can be passed to</span>
<span class="sd"> request&#39;s headers)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ret_val</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;language&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">&#39;country&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">&#39;subdomain&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">&#39;params&#39;</span><span class="p">:</span> <span class="p">{},</span>
<span class="s1">&#39;headers&#39;</span><span class="p">:</span> <span class="p">{},</span>
<span class="p">}</span>
<span class="c1"># language ...</span>
<span class="n">_lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span>
<span class="n">_any_language</span> <span class="o">=</span> <span class="n">_lang</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span>
<span class="k">if</span> <span class="n">_any_language</span><span class="p">:</span>
<span class="n">_lang</span> <span class="o">=</span> <span class="s1">&#39;en-US&#39;</span>
<span class="n">language</span> <span class="o">=</span> <span class="n">match_language</span><span class="p">(</span><span class="n">_lang</span><span class="p">,</span> <span class="n">lang_list</span><span class="p">,</span> <span class="n">custom_aliases</span><span class="p">)</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">language</span>
<span class="c1"># country ...</span>
<span class="n">_l</span> <span class="o">=</span> <span class="n">_lang</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">_l</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">country</span> <span class="o">=</span> <span class="n">_l</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">country</span> <span class="o">=</span> <span class="n">_l</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">if</span> <span class="n">country</span> <span class="o">==</span> <span class="s1">&#39;EN&#39;</span><span class="p">:</span>
<span class="n">country</span> <span class="o">=</span> <span class="s1">&#39;US&#39;</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;country&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">country</span>
<span class="c1"># subdomain ...</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;www.&#39;</span> <span class="o">+</span> <span class="n">google_domains</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">country</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="s1">&#39;google.com&#39;</span><span class="p">)</span>
<span class="c1"># params &amp; headers</span>
<span class="n">lang_country</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">-</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">language</span><span class="p">,</span> <span class="n">country</span><span class="p">)</span> <span class="c1"># (en-US, en-EN, de-DE, de-AU, fr-FR ..)</span>
<span class="c1"># hl parameter:</span>
<span class="c1"># https://developers.google.com/custom-search/docs/xml_results#hlsp The</span>
<span class="c1"># Interface Language:</span>
<span class="c1"># https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang_list</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">lang_country</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
<span class="c1"># lr parameter:</span>
<span class="c1"># The lr (language restrict) parameter restricts search results to</span>
<span class="c1"># documents written in a particular language.</span>
<span class="c1"># https://developers.google.com/custom-search/docs/xml_results#lrsp</span>
<span class="c1"># Language Collection Values:</span>
<span class="c1"># https://developers.google.com/custom-search/docs/xml_results_appendices#languageCollections</span>
<span class="k">if</span> <span class="n">_any_language</span> <span class="ow">and</span> <span class="n">supported_any_language</span><span class="p">:</span>
<span class="c1"># interpretation is left up to Google (based on whoogle)</span>
<span class="c1">#</span>
<span class="c1"># - add parameter ``source=lnt``</span>
<span class="c1"># - don&#39;t use parameter ``lr``</span>
<span class="c1"># - don&#39;t add a ``Accept-Language`` HTTP header.</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;source&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;lnt&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># restricts search results to documents written in a particular</span>
<span class="c1"># language.</span>
<span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;lr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;lang_&quot;</span> <span class="o">+</span> <span class="n">lang_list</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">lang_country</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret_val</span></div>
<span class="k">def</span> <span class="nf">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="o">.</span><span class="n">host</span> <span class="o">==</span> <span class="s1">&#39;sorry.google.com&#39;</span> <span class="ow">or</span> <span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/sorry&#39;</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">()</span>
<div class="viewcode-block" id="request"><a class="viewcode-back" href="../../../src/searx.engines.google.html#searx.engines.google.request">[docs]</a><span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Google search request&quot;&quot;&quot;</span>
<span class="n">offset</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span>
<span class="n">lang_info</span> <span class="o">=</span> <span class="n">get_lang_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">supported_languages</span><span class="p">,</span> <span class="n">language_aliases</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="n">additional_parameters</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">use_mobile_ui</span><span class="p">:</span>
<span class="n">additional_parameters</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;asearch&#39;</span><span class="p">:</span> <span class="s1">&#39;arc&#39;</span><span class="p">,</span>
<span class="s1">&#39;async&#39;</span><span class="p">:</span> <span class="s1">&#39;use_ac:true,_fmt:prog&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="c1"># https://www.google.de/search?q=corona&amp;hl=de&amp;lr=lang_de&amp;start=0&amp;tbs=qdr%3Ad&amp;safe=medium</span>
<span class="n">query_url</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;https://&#39;</span>
<span class="o">+</span> <span class="n">lang_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span>
<span class="o">+</span> <span class="s1">&#39;/search&#39;</span>
<span class="o">+</span> <span class="s2">&quot;?&quot;</span>
<span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
<span class="p">{</span>
<span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
<span class="o">**</span><span class="n">lang_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span>
<span class="s1">&#39;ie&#39;</span><span class="p">:</span> <span class="s2">&quot;utf8&quot;</span><span class="p">,</span>
<span class="s1">&#39;oe&#39;</span><span class="p">:</span> <span class="s2">&quot;utf8&quot;</span><span class="p">,</span>
<span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span>
<span class="s1">&#39;filter&#39;</span><span class="p">:</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
<span class="o">**</span><span class="n">additional_parameters</span><span class="p">,</span>
<span class="p">}</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="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
<span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;tbs&#39;</span><span class="p">:</span> <span class="s1">&#39;qdr:&#39;</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="s1">&#39;time_range&#39;</span><span class="p">]]})</span>
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
<span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;safe&#39;</span><span class="p">:</span> <span class="n">filter_mapping</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]})</span>
<span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_url</span>
<span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;CONSENT&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;YES+&quot;</span>
<span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">lang_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">use_mobile_ui</span><span class="p">:</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;Accept&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;*/*&#39;</span>
<span class="k">else</span><span class="p">:</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;Accept&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8&#39;</span>
<span class="k">return</span> <span class="n">params</span></div>
<div class="viewcode-block" id="response"><a class="viewcode-back" href="../../../src/searx.engines.google.html#searx.engines.google.response">[docs]</a><span class="k">def</span> <span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get response from google&#39;s search request&quot;&quot;&quot;</span>
<span class="n">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># convert the text to dom</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"># results --&gt; answer</span>
<span class="n">answer_list</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;LGOjhe&quot;)]&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">answer_list</span><span class="p">:</span>
<span class="n">answer_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">_</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;normalize-space()&quot;</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">answer_list</span><span class="p">]</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;answer&#39;</span><span class="p">:</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">answer_list</span><span class="p">)})</span>
<span class="k">else</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;did not find &#39;answer&#39;&quot;</span><span class="p">)</span>
<span class="c1"># results --&gt; number_of_results</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">use_mobile_ui</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_txt</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;result-stats&quot;]//text()&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">_digit</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">n</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">_txt</span> <span class="k">if</span> <span class="n">n</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()])</span>
<span class="n">number_of_results</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">_digit</span><span class="p">)</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;number_of_results&#39;</span><span class="p">:</span> <span class="n">number_of_results</span><span class="p">})</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;did not &#39;number_of_results&#39;&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># parse results</span>
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">results_xpath</span><span class="p">):</span>
<span class="c1"># google *sections*</span>
<span class="k">if</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">g_section_with_header</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;ignoring &lt;g-section-with-header&gt;&quot;</span><span class="p">)</span>
<span class="k">continue</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">title_tag</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">title_tag</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># this not one of the common google results *section*</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;ignoring item from the result_xpath list: missing title&#39;</span><span class="p">)</span>
<span class="k">continue</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">title_tag</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">result</span><span class="p">,</span> <span class="n">href_xpath</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">url</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">),</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="n">content</span> <span class="ow">is</span> <span class="kc">None</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="s1">&#39;ignoring item from the result_xpath list: missing content of title &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
<span class="k">continue</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;add link to results: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">})</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">continue</span>
<span class="c1"># parse suggestion</span>
<span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">suggestion_xpath</span><span class="p">):</span>
<span class="c1"># append suggestion</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
<span class="c1"># return results</span>
<span class="k">return</span> <span class="n">results</span></div>
<span class="c1"># get supported languages from their site</span>
<span class="k">def</span> <span class="nf">_fetch_supported_languages</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="n">ret_val</span> <span class="o">=</span> <span class="p">{}</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="n">radio_buttons</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//*[@id=&quot;langSec&quot;]//input[@name=&quot;lr&quot;]&#39;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">radio_buttons</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;data-name&quot;</span><span class="p">)</span>
<span class="n">code</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">ret_val</span><span class="p">[</span><span class="n">code</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="n">name</span><span class="p">}</span>
<span class="k">return</span> <span class="n">ret_val</span>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo"/>
</a></p>
<h3><a href="../../../index.html">Table of Contents</a></h3>
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../donate.html">Donate to searxng.org</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>
<div 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>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2021 SearXNG team, 2015-2021 Adam Tauber, Noémi Ványi.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
<script src="../../../_static/version_warning_offset.js"></script>
</body>
</html>