From d9dbcedeb6ca0cbbb10bf292d0dd0838faf6236a Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 15 Sep 2023 19:14:07 +0200 Subject: [PATCH] [feat] implementation of qwant lite for web search Related: https://github.com/searxng/searxng/issues/2719 Replace: https://github.com/searxng/searxng/pull/2748 Signed-off-by: Markus Heiser --- docs/dev/engines/online/qwant.rst | 13 +++ searx/engines/qwant.py | 132 +++++++++++++++++++++++------- searx/settings.yml | 2 +- 3 files changed, 115 insertions(+), 32 deletions(-) create mode 100644 docs/dev/engines/online/qwant.rst diff --git a/docs/dev/engines/online/qwant.rst b/docs/dev/engines/online/qwant.rst new file mode 100644 index 00000000000..66ad302d1f1 --- /dev/null +++ b/docs/dev/engines/online/qwant.rst @@ -0,0 +1,13 @@ +.. _qwant engine: + +===== +Qwant +===== + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +.. automodule:: searx.engines.qwant + :members: diff --git a/searx/engines/qwant.py b/searx/engines/qwant.py index 4a41676c579..276bd958c35 100644 --- a/searx/engines/qwant.py +++ b/searx/engines/qwant.py @@ -1,15 +1,29 @@ # SPDX-License-Identifier: AGPL-3.0-or-later # lint: pylint -"""Qwant (Web, News, Images, Videos) +"""This engine uses the Qwant API (https://api.qwant.com/v3) to implement Qwant +-Web, -News, -Images and -Videos. The API is undocumented but can be reverse +engineered by reading the network log of https://www.qwant.com/ queries. -This engine uses the Qwant API (https://api.qwant.com/v3). The API is -undocumented but can be reverse engineered by reading the network log of -https://www.qwant.com/ queries. +For Qwant's *web-search* two alternatives are implemented: -This implementation is used by different qwant engines in the settings.yml:: +- ``web``: uses the :py:obj:`api_url` which returns a JSON structure +- ``web-lite``: uses the :py:obj:`web_lite_url` which returns a HTML page + + +Configuration +============= + +The engine has the following additional settings: + +- :py:obj:`qwant_categ` + +This implementation is used by different qwant engines in the :ref:`settings.yml +`: + +.. code:: yaml - name: qwant - qwant_categ: web + qwant_categ: web-lite # alternatively use 'web' ... - name: qwant news qwant_categ: news @@ -21,6 +35,9 @@ qwant_categ: videos ... +Implementations +=============== + """ from datetime import ( @@ -31,11 +48,18 @@ from urllib.parse import urlencode from flask_babel import gettext import babel +import lxml from searx.exceptions import SearxEngineAPIException from searx.network import raise_for_httperror from searx.enginelib.traits import EngineTraits +from searx.utils import ( + eval_xpath, + eval_xpath_list, + extract_text, +) + traits: EngineTraits # about @@ -51,10 +75,11 @@ # engine dependent config categories = [] paging = True -qwant_categ = None # web|news|inages|videos +qwant_categ = None +"""One of ``web``, ``news``, ``images`` or ``videos``""" safesearch = True -safe_search_map = {0: '&safesearch=0', 1: '&safesearch=1', 2: '&safesearch=2'} +# safe_search_map = {0: '&safesearch=0', 1: '&safesearch=1', 2: '&safesearch=2'} # fmt: off qwant_news_locales = [ @@ -67,7 +92,12 @@ # fmt: on # search-url -url = 'https://api.qwant.com/v3/search/{keyword}?{query}&count={count}&offset={offset}' + +api_url = 'https://api.qwant.com/v3/search/' +"""URL of Qwant's API (JSON)""" + +web_lite_url = 'https://lite.qwant.com/' +"""URL of Qwant-Lite (HTML)""" def request(query, params): @@ -76,38 +106,78 @@ def request(query, params): if not query: return None - count = 10 # web: count must be equal to 10 + q_locale = traits.get_region(params["searxng_locale"], default='en_US') + + url = api_url + f'{qwant_categ}?' + args = {'q': query} + params['raise_for_httperror'] = False + + if qwant_categ == 'web-lite': + + # qwant-lite delivers only 5 pages maximum + if params['pageno'] > 5: + return None + + url = web_lite_url + '?' + args['locale'] = q_locale.lower() + args['l'] = q_locale.split('_')[0] + args['s'] = params['safesearch'] + args['p'] = params['pageno'] + + params['raise_for_httperror'] = True - if qwant_categ == 'images': - count = 50 - offset = (params['pageno'] - 1) * count + elif qwant_categ == 'images': + + args['locale'] = q_locale + args['safesearch'] = params['safesearch'] + + args['count'] = 50 + offset = (params['pageno'] - 1) * args['count'] # count + offset must be lower than 250 - offset = min(offset, 199) - else: - offset = (params['pageno'] - 1) * count - # count + offset must be lower than 50 - offset = min(offset, 40) + args['offset'] = min(offset, 199) - params['url'] = url.format( - keyword=qwant_categ, - query=urlencode({'q': query}), - offset=offset, - count=count, - ) + else: # web, news, videos - # add quant's locale - q_locale = traits.get_region(params["searxng_locale"], default='en_US') - params['url'] += '&locale=' + q_locale + args['locale'] = q_locale + args['safesearch'] = params['safesearch'] - # add safesearch option - params['url'] += safe_search_map.get(params['safesearch'], '') + args['count'] = 10 + offset = (params['pageno'] - 1) * args['count'] + # count + offset must be lower than 50 + args['offset'] = min(offset, 39) + + params['url'] = url + urlencode(args) - params['raise_for_httperror'] = False return params def response(resp): - """Get response from Qwant's search request""" + + if qwant_categ == 'web-lite': + return parse_web_lite(resp) + return parse_web_api + + +def parse_web_lite(resp): + """Parse results from Qwant-Lite""" + + results = [] + dom = lxml.html.fromstring(resp.text) + + for item in eval_xpath_list(dom, '//section/article'): + results.append( + { + 'url': extract_text(eval_xpath(item, './span')), + 'title': extract_text(eval_xpath(item, './h2/a')), + 'content': extract_text(eval_xpath(item, './p')), + } + ) + + return results + + +def parse_web_api(resp): + """Parse results from Qwant's API""" # pylint: disable=too-many-locals, too-many-branches, too-many-statements results = [] diff --git a/searx/settings.yml b/searx/settings.yml index 756e6cc403d..9ee256b28e2 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -1256,7 +1256,7 @@ engines: results: HTML - name: qwant - qwant_categ: web + qwant_categ: web-lite engine: qwant shortcut: qw categories: [general, web]