diff options
Diffstat (limited to 'searx/engines/google.py')
| -rw-r--r-- | searx/engines/google.py | 616 |
1 files changed, 285 insertions, 331 deletions
diff --git a/searx/engines/google.py b/searx/engines/google.py index eed3a04..1388550 100644 --- a/searx/engines/google.py +++ b/searx/engines/google.py @@ -1,391 +1,345 @@ -# Google (Web) -# -# @website https://www.google.com -# @provide-api yes (https://developers.google.com/custom-search/) -# -# @using-api no -# @results HTML -# @stable no (HTML can change) -# @parse url, title, content, suggestion - -import re -from flask_babel import gettext -from lxml import html, etree -from searx.engines.xpath import extract_text, extract_url +# SPDX-License-Identifier: AGPL-3.0-or-later +"""Google (Web) + +For detailed description of the *REST-full* API see: `Query Parameter +Definitions`_. + +.. _Query Parameter Definitions: + https://developers.google.com/custom-search/docs/xml_results#WebSearch_Query_Parameter_Definitions +""" + +# pylint: disable=invalid-name, missing-function-docstring, too-many-branches + +from urllib.parse import urlencode, urlparse +from random import random +from lxml import html from searx import logger -from searx.url_utils import urlencode, urlparse, parse_qsl -from searx.utils import match_language, eval_xpath +from searx.utils import match_language, extract_text, eval_xpath, eval_xpath_list, eval_xpath_getindex +from searx.exceptions import SearxEngineCaptchaException logger = logger.getChild('google engine') +# about +about = { + "website": 'https://www.google.com', + "wikidata_id": 'Q9366', + "official_api_documentation": 'https://developers.google.com/custom-search/', + "use_official_api": False, + "require_api_key": False, + "results": 'HTML', +} # engine dependent config categories = ['general'] paging = True -language_support = True -use_locale_domain = True time_range_support = True +safesearch = True +use_mobile_ui = False +supported_languages_url = 'https://www.google.com/preferences?#languages' # based on https://en.wikipedia.org/wiki/List_of_Google_domains and tests -default_hostname = 'www.google.com' - -country_to_hostname = { - 'BG': 'www.google.bg', # Bulgaria - 'CZ': 'www.google.cz', # Czech Republic - 'DE': 'www.google.de', # Germany - 'DK': 'www.google.dk', # Denmark - 'AT': 'www.google.at', # Austria - 'CH': 'www.google.ch', # Switzerland - 'GR': 'www.google.gr', # Greece - 'AU': 'www.google.com.au', # Australia - 'CA': 'www.google.ca', # Canada - 'GB': 'www.google.co.uk', # United Kingdom - 'ID': 'www.google.co.id', # Indonesia - 'IE': 'www.google.ie', # Ireland - 'IN': 'www.google.co.in', # India - 'MY': 'www.google.com.my', # Malaysia - 'NZ': 'www.google.co.nz', # New Zealand - 'PH': 'www.google.com.ph', # Philippines - 'SG': 'www.google.com.sg', # Singapore - # 'US': 'www.google.us', # United States, redirect to .com - 'ZA': 'www.google.co.za', # South Africa - 'AR': 'www.google.com.ar', # Argentina - 'CL': 'www.google.cl', # Chile - 'ES': 'www.google.es', # Spain - 'MX': 'www.google.com.mx', # Mexico - 'EE': 'www.google.ee', # Estonia - 'FI': 'www.google.fi', # Finland - 'BE': 'www.google.be', # Belgium - 'FR': 'www.google.fr', # France - 'IL': 'www.google.co.il', # Israel - 'HR': 'www.google.hr', # Croatia - 'HU': 'www.google.hu', # Hungary - 'IT': 'www.google.it', # Italy - 'JP': 'www.google.co.jp', # Japan - 'KR': 'www.google.co.kr', # South Korea - 'LT': 'www.google.lt', # Lithuania - 'LV': 'www.google.lv', # Latvia - 'NO': 'www.google.no', # Norway - 'NL': 'www.google.nl', # Netherlands - 'PL': 'www.google.pl', # Poland - 'BR': 'www.google.com.br', # Brazil - 'PT': 'www.google.pt', # Portugal - 'RO': 'www.google.ro', # Romania - 'RU': 'www.google.ru', # Russia - 'SK': 'www.google.sk', # Slovakia - 'SI': 'www.google.si', # Slovenia - 'SE': 'www.google.se', # Sweden - 'TH': 'www.google.co.th', # Thailand - 'TR': 'www.google.com.tr', # Turkey - 'UA': 'www.google.com.ua', # Ukraine - # 'CN': 'www.google.cn', # China, only from China ? - 'HK': 'www.google.com.hk', # Hong Kong - 'TW': 'www.google.com.tw' # Taiwan +google_domains = { + 'BG': 'google.bg', # Bulgaria + 'CZ': 'google.cz', # Czech Republic + 'DE': 'google.de', # Germany + 'DK': 'google.dk', # Denmark + 'AT': 'google.at', # Austria + 'CH': 'google.ch', # Switzerland + 'GR': 'google.gr', # Greece + 'AU': 'google.com.au', # Australia + 'CA': 'google.ca', # Canada + 'GB': 'google.co.uk', # United Kingdom + 'ID': 'google.co.id', # Indonesia + 'IE': 'google.ie', # Ireland + 'IN': 'google.co.in', # India + 'MY': 'google.com.my', # Malaysia + 'NZ': 'google.co.nz', # New Zealand + 'PH': 'google.com.ph', # Philippines + 'SG': 'google.com.sg', # Singapore + 'US': 'google.com', # United States (google.us) redirects to .com + 'ZA': 'google.co.za', # South Africa + 'AR': 'google.com.ar', # Argentina + 'CL': 'google.cl', # Chile + 'ES': 'google.es', # Spain + 'MX': 'google.com.mx', # Mexico + 'EE': 'google.ee', # Estonia + 'FI': 'google.fi', # Finland + 'BE': 'google.be', # Belgium + 'FR': 'google.fr', # France + 'IL': 'google.co.il', # Israel + 'HR': 'google.hr', # Croatia + 'HU': 'google.hu', # Hungary + 'IT': 'google.it', # Italy + 'JP': 'google.co.jp', # Japan + 'KR': 'google.co.kr', # South Korea + 'LT': 'google.lt', # Lithuania + 'LV': 'google.lv', # Latvia + 'NO': 'google.no', # Norway + 'NL': 'google.nl', # Netherlands + 'PL': 'google.pl', # Poland + 'BR': 'google.com.br', # Brazil + 'PT': 'google.pt', # Portugal + 'RO': 'google.ro', # Romania + 'RU': 'google.ru', # Russia + 'SK': 'google.sk', # Slovakia + 'SI': 'google.si', # Slovenia + 'SE': 'google.se', # Sweden + 'TH': 'google.co.th', # Thailand + 'TR': 'google.com.tr', # Turkey + 'UA': 'google.com.ua', # Ukraine + 'CN': 'google.com.hk', # There is no google.cn, we use .com.hk for zh-CN + 'HK': 'google.com.hk', # Hong Kong + 'TW': 'google.com.tw' # Taiwan } -# osm -url_map = 'https://www.openstreetmap.org/'\ - + '?lat={latitude}&lon={longitude}&zoom={zoom}&layers=M' - -# search-url -search_path = '/search' -search_url = ('https://{hostname}' + - search_path + - '?{query}&start={offset}&gws_rd=cr&gbv=1&lr={lang}&hl={lang_short}&ei=x') - -time_range_search = "&tbs=qdr:{range}" -time_range_dict = {'day': 'd', - 'week': 'w', - 'month': 'm', - 'year': 'y'} - -# other URLs -map_hostname_start = 'maps.google.' -maps_path = '/maps' -redirect_path = '/url' -images_path = '/images' -supported_languages_url = 'https://www.google.com/preferences?#languages' +time_range_dict = { + 'day': 'd', + 'week': 'w', + 'month': 'm', + 'year': 'y' +} + +# Filter results. 0: None, 1: Moderate, 2: Strict +filter_mapping = { + 0: 'off', + 1: 'medium', + 2: 'high' +} # specific xpath variables -results_xpath = '//div[contains(@class, "ZINbbc")]' -url_xpath = './/div[@class="kCrYT"][1]/a/@href' -title_xpath = './/div[@class="kCrYT"][1]/a/div[1]' -content_xpath = './/div[@class="kCrYT"][2]//div[contains(@class, "BNeawe")]//div[contains(@class, "BNeawe")]' -suggestion_xpath = '//div[contains(@class, "ZINbbc")][last()]//div[@class="rVLSBd"]/a//div[contains(@class, "BNeawe")]' -spelling_suggestion_xpath = '//div[@id="scc"]//a' - -# map : detail location -map_address_xpath = './/div[@class="s"]//table//td[2]/span/text()' -map_phone_xpath = './/div[@class="s"]//table//td[2]/span/span' -map_website_url_xpath = 'h3[2]/a/@href' -map_website_title_xpath = 'h3[2]' - -# map : near the location -map_near = 'table[@class="ts"]//tr' -map_near_title = './/h4' -map_near_url = './/h4/a/@href' -map_near_phone = './/span[@class="nobr"]' - -# images -images_xpath = './/div/a' -image_url_xpath = './@href' -image_img_src_xpath = './img/@src' - -# property names -# FIXME : no translation -property_address = "Address" -property_phone = "Phone number" - - -# remove google-specific tracking-url -def parse_url(url_string, google_hostname): - # sanity check - if url_string is None: - return url_string - - # normal case - parsed_url = urlparse(url_string) - if (parsed_url.netloc in [google_hostname, ''] - and parsed_url.path == redirect_path): - query = dict(parse_qsl(parsed_url.query)) - return query['q'] - else: - return url_string +# ------------------------ +# google results are grouped into <div class="jtfYYd ..." ../> +results_xpath = '//div[contains(@class, "jtfYYd")]' +results_xpath_mobile_ui = '//div[contains(@class, "g ")]' -# returns extract_text on the first result selected by the xpath or None -def extract_text_from_dom(result, xpath): - r = eval_xpath(result, xpath) - if len(r) > 0: - return extract_text(r[0]) - return None +# google *sections* are no usual *results*, we ignore them +g_section_with_header = './g-section-with-header' +# the title is a h3 tag relative to the result group +title_xpath = './/h3[1]' -# do search-request -def request(query, params): - offset = (params['pageno'] - 1) * 10 +# in the result group there is <div class="yuRUbf" ../> it's first child is a <a +# href=...> +href_xpath = './/div[@class="yuRUbf"]//a/@href' - if params['language'] == 'all' or params['language'] == 'en-US': - language = 'en-GB' - else: - language = match_language(params['language'], supported_languages, language_aliases) +# in the result group there is <div class="VwiC3b ..." ../> containing the *content* +content_xpath = './/div[contains(@class, "VwiC3b")]' - language_array = language.split('-') - if params['language'].find('-') > 0: - country = params['language'].split('-')[1] - elif len(language_array) == 2: - country = language_array[1] - else: - country = 'US' +# Suggestions are links placed in a *card-section*, we extract only the text +# from the links not the links itself. +suggestion_xpath = '//div[contains(@class, "card-section")]//a' - url_lang = 'lang_' + language +# Since google does *auto-correction* on the first query these are not really +# *spelling suggestions*, we use them anyway. +spelling_suggestion_xpath = '//div[@class="med"]/p/a' - if use_locale_domain: - google_hostname = country_to_hostname.get(country.upper(), default_hostname) - else: - google_hostname = default_hostname - - # original format: ID=3e2b6616cee08557:TM=5556667580:C=r:IP=4.1.12.5-:S=23ASdf0soFgF2d34dfgf-_22JJOmHdfgg - params['cookies']['GOOGLE_ABUSE_EXEMPTION'] = 'x' - params['url'] = search_url.format(offset=offset, - query=urlencode({'q': query}), - hostname=google_hostname, - lang=url_lang, - lang_short=language) - if params['time_range'] in time_range_dict: - params['url'] += time_range_search.format(range=time_range_dict[params['time_range']]) - params['headers']['Accept-Language'] = language + ',' + language + '-' + country - params['headers']['Accept'] = 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8' +def get_lang_info(params, lang_list, custom_aliases, supported_any_language): + ret_val = {} - params['google_hostname'] = google_hostname + _lang = params['language'] + _any_language = _lang.lower() == 'all' + if _any_language: + _lang = 'en-US' - return params + language = match_language(_lang, lang_list, custom_aliases) + ret_val['language'] = language + # the requested language from params (en, en-US, de, de-AT, fr, fr-CA, ...) + _l = _lang.split('-') -# get response from search-request -def response(resp): - results = [] + # the country code (US, AT, CA) + if len(_l) == 2: + country = _l[1] + else: + country = _l[0].upper() + if country == 'EN': + country = 'US' - # detect google sorry - resp_url = urlparse(resp.url) - if resp_url.netloc == 'sorry.google.com' or resp_url.path == '/sorry/IndexRedirect': - raise RuntimeWarning('sorry.google.com') + ret_val['country'] = country - if resp_url.path.startswith('/sorry'): - raise RuntimeWarning(gettext('CAPTCHA required')) + # the combination (en-US, en-EN, de-DE, de-AU, fr-FR, fr-FR) + lang_country = '%s-%s' % (language, country) - # which hostname ? - google_hostname = resp.search_params.get('google_hostname') - google_url = "https://" + google_hostname + # subdomain + ret_val['subdomain'] = 'www.' + google_domains.get(country.upper(), 'google.com') - # convert the text to dom - dom = html.fromstring(resp.text) + ret_val['params'] = {} + ret_val['headers'] = {} - instant_answer = eval_xpath(dom, '//div[@id="_vBb"]//text()') - if instant_answer: - results.append({'answer': u' '.join(instant_answer)}) - try: - results_num = int(eval_xpath(dom, '//div[@id="resultStats"]//text()')[0] - .split()[1].replace(',', '')) - results.append({'number_of_results': results_num}) - except: - pass + if _any_language and supported_any_language: + # based on whoogle + ret_val['params']['source'] = 'lnt' + else: + # Accept-Language: fr-CH, fr;q=0.8, en;q=0.6, *;q=0.5 + ret_val['headers']['Accept-Language'] = ','.join([ + lang_country, + language + ';q=0.8,', + 'en;q=0.6', + '*;q=0.5', + ]) + + # lr parameter: + # https://developers.google.com/custom-search/docs/xml_results#lrsp + # Language Collection Values: + # https://developers.google.com/custom-search/docs/xml_results_appendices#languageCollections + ret_val['params']['lr'] = "lang_" + lang_country if lang_country in lang_list else language + + ret_val['params']['hl'] = lang_country if lang_country in lang_list else language + + # hl parameter: + # https://developers.google.com/custom-search/docs/xml_results#hlsp The + # Interface Language: + # https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages + return ret_val + +def detect_google_sorry(resp): + resp_url = urlparse(resp.url) + if resp_url.netloc == 'sorry.google.com' or resp_url.path.startswith('/sorry'): + raise SearxEngineCaptchaException() - # parse results - for result in eval_xpath(dom, results_xpath): - try: - title = extract_text(eval_xpath(result, title_xpath)[0]) - url = parse_url(extract_url(eval_xpath(result, url_xpath), google_url), google_hostname) - parsed_url = urlparse(url, google_hostname) - # map result - if parsed_url.netloc == google_hostname: - # TODO fix inside links - continue - # if parsed_url.path.startswith(maps_path) or parsed_url.netloc.startswith(map_hostname_start): - # print "yooooo"*30 - # x = eval_xpath(result, map_near) - # if len(x) > 0: - # # map : near the location - # results = results + parse_map_near(parsed_url, x, google_hostname) - # else: - # # map : detail about a location - # results = results + parse_map_detail(parsed_url, result, google_hostname) - # # google news - # elif parsed_url.path == search_path: - # # skipping news results - # pass - - # # images result - # elif parsed_url.path == images_path: - # # only thumbnail image provided, - # # so skipping image results - # # results = results + parse_images(result, google_hostname) - # pass - - else: - # normal result - content = extract_text_from_dom(result, content_xpath) - if content is None: - continue - - # append result - results.append({'url': url, - 'title': title, - 'content': content - }) - except: - logger.debug('result parse error in:\n%s', etree.tostring(result, pretty_print=True)) - continue +def request(query, params): + """Google search request""" - # parse suggestion - for suggestion in eval_xpath(dom, suggestion_xpath): - # append suggestion - results.append({'suggestion': extract_text(suggestion)}) + offset = (params['pageno'] - 1) * 10 - for correction in eval_xpath(dom, spelling_suggestion_xpath): - results.append({'correction': extract_text(correction)}) + lang_info = get_lang_info( + # pylint: disable=undefined-variable + params, supported_languages, language_aliases, True + ) + + additional_parameters = {} + if use_mobile_ui: + additional_parameters = { + 'async': 'use_ac:true,_fmt:pc', + } + + # https://www.google.de/search?q=corona&hl=de&lr=lang_de&start=0&tbs=qdr%3Ad&safe=medium + query_url = 'https://' + lang_info['subdomain'] + '/search' + "?" + urlencode({ + 'q': query, + **lang_info['params'], + 'ie': "utf8", + 'oe': "utf8", + 'start': offset, + 'filter': '0', + 'ucbcb': 1, + **additional_parameters, + }) - # return results - return results + if params['time_range'] in time_range_dict: + query_url += '&' + urlencode({'tbs': 'qdr:' + time_range_dict[params['time_range']]}) + if params['safesearch']: + query_url += '&' + urlencode({'safe': filter_mapping[params['safesearch']]}) + + logger.debug("query_url --> %s", query_url) + params['url'] = query_url + + logger.debug("HTTP header Accept-Language --> %s", lang_info.get('Accept-Language')) + params['cookies']['CONSENT'] = "PENDING+" + str(random()*100) + params['headers'].update(lang_info['headers']) + if use_mobile_ui: + params['headers']['Accept'] = '*/*' + else: + params['headers']['Accept'] = ( + 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8' + ) + return params -def parse_images(result, google_hostname): - results = [] - for image in eval_xpath(result, images_xpath): - url = parse_url(extract_text(eval_xpath(image, image_url_xpath)[0]), google_hostname) - img_src = extract_text(eval_xpath(image, image_img_src_xpath)[0]) - - # append result - results.append({'url': url, - 'title': '', - 'content': '', - 'img_src': img_src, - 'template': 'images.html' - }) - return results +def response(resp): + """Get response from google's search request""" + detect_google_sorry(resp) -def parse_map_near(parsed_url, x, google_hostname): results = [] - for result in x: - title = extract_text_from_dom(result, map_near_title) - url = parse_url(extract_text_from_dom(result, map_near_url), google_hostname) - attributes = [] - phone = extract_text_from_dom(result, map_near_phone) - add_attributes(attributes, property_phone, phone, 'tel:' + phone) - results.append({'title': title, - 'url': url, - 'content': attributes_to_html(attributes) - }) + # convert the text to dom + dom = html.fromstring(resp.text) - return results + # results --> answer + answer_list = eval_xpath(dom, '//div[contains(@class, "LGOjhe")]') + if answer_list: + answer_list = [_.xpath("normalize-space()") for _ in answer_list] + results.append({'answer': ' '.join(answer_list)}) + else: + logger.debug("did not find 'answer'") + + # results --> number_of_results + if not use_mobile_ui: + try: + _txt = eval_xpath_getindex(dom, '//div[@id="result-stats"]//text()', 0) + _digit = ''.join([n for n in _txt if n.isdigit()]) + number_of_results = int(_digit) + results.append({'number_of_results': number_of_results}) + except Exception as e: # pylint: disable=broad-except + logger.debug("did not 'number_of_results'") + logger.error(e, exc_info=True) + # parse results -def parse_map_detail(parsed_url, result, google_hostname): - results = [] + _results_xpath = results_xpath + if use_mobile_ui: + _results_xpath = results_xpath_mobile_ui - # try to parse the geoloc - m = re.search(r'@([0-9\.]+),([0-9\.]+),([0-9]+)', parsed_url.path) - if m is None: - m = re.search(r'll\=([0-9\.]+),([0-9\.]+)\&z\=([0-9]+)', parsed_url.query) - - if m is not None: - # geoloc found (ignored) - lon = float(m.group(2)) # noqa - lat = float(m.group(1)) # noqa - zoom = int(m.group(3)) # noqa - - # attributes - attributes = [] - address = extract_text_from_dom(result, map_address_xpath) - phone = extract_text_from_dom(result, map_phone_xpath) - add_attributes(attributes, property_address, address, 'geo:' + str(lat) + ',' + str(lon)) - add_attributes(attributes, property_phone, phone, 'tel:' + phone) - - # title / content / url - website_title = extract_text_from_dom(result, map_website_title_xpath) - content = extract_text_from_dom(result, content_xpath) - website_url = parse_url(extract_text_from_dom(result, map_website_url_xpath), google_hostname) - - # add a result if there is a website - if website_url is not None: - results.append({'title': website_title, - 'content': (content + '<br />' if content is not None else '') - + attributes_to_html(attributes), - 'url': website_url - }) + for result in eval_xpath_list(dom, _results_xpath): - return results + # google *sections* + if extract_text(eval_xpath(result, g_section_with_header)): + logger.debug("ingoring <g-section-with-header>") + continue + try: + title_tag = eval_xpath_getindex(result, title_xpath, 0, default=None) + if title_tag is None: + # this not one of the common google results *section* + logger.debug('ingoring item from the result_xpath list: missing title') + continue + title = extract_text(title_tag) + url = eval_xpath_getindex(result, href_xpath, 0, None) + if url is None: + continue + content = extract_text(eval_xpath_getindex(result, content_xpath, 0, default=None), allow_none=True) + if content is None: + logger.debug('ingoring item from the result_xpath list: missing content of title "%s"', title) + continue -def add_attributes(attributes, name, value, url): - if value is not None and len(value) > 0: - attributes.append({'label': name, 'value': value, 'url': url}) + logger.debug('add link to results: %s', title) + results.append({ + 'url': url, + 'title': title, + 'content': content + }) -def attributes_to_html(attributes): - retval = '<table class="table table-striped">' - for a in attributes: - value = a.get('value') - if 'url' in a: - value = '<a href="' + a.get('url') + '">' + value + '</a>' - retval = retval + '<tr><th>' + a.get('label') + '</th><td>' + value + '</td></tr>' - retval = retval + '</table>' - return retval + except Exception as e: # pylint: disable=broad-except + logger.error(e, exc_info=True) + continue + + # parse suggestion + for suggestion in eval_xpath_list(dom, suggestion_xpath): + # append suggestion + results.append({'suggestion': extract_text(suggestion)}) + + for correction in eval_xpath_list(dom, spelling_suggestion_xpath): + results.append({'correction': extract_text(correction)}) + + # return results + return results # get supported languages from their site def _fetch_supported_languages(resp): - supported_languages = {} + ret_val = {} dom = html.fromstring(resp.text) - options = eval_xpath(dom, '//*[@id="langSec"]//input[@name="lr"]') - for option in options: - code = eval_xpath(option, './@value')[0].split('_')[-1] - name = eval_xpath(option, './@data-name')[0].title() - supported_languages[code] = {"name": name} - return supported_languages + radio_buttons = eval_xpath_list(dom, '//*[@id="langSec"]//input[@name="lr"]') + + for x in radio_buttons: + name = x.get("data-name") + code = x.get("value").split('_')[-1] + ret_val[code] = {"name": name} + + return ret_val |