on master help sign in
[mod] various engines: use eval_xpath* functions and searx.exceptions.*

Engine list: ahmia, duckduckgo_images, elasticsearch, google, google_images, google_videos, youtube_api

commit64cccae99e625f3ebd879f94797decd0d824608d authorAlexandre Flament <alex@al-f.net> dateThu 26 Nov 2020, 17:22 (6 years ago) parentad72803
7 files changed+44−52
searx/engines/ahmia.py+7−7 searx/engines/duckduckgo_images.py+3−5 searx/engines/elasticsearch.py+2−1 searx/engines/google.py+22−30 searx/engines/google_images.py+3−3 searx/engines/google_videos.py+5−5 searx/engines/youtube_api.py+2−1
searx/engines/ahmia.py+7−7
@@ -12,7 +12,7 @@
1212
1313from urllib.parse import urlencode, urlparse, parse_qs
1414from lxml.html import fromstring
15−from searx.engines.xpath import extract_url, extract_text
15+from searx.engines.xpath import extract_url, extract_text, eval_xpath_list, eval_xpath
1616
1717# engine config
1818categories = ['onions']
@@ -50,17 +50,17 @@ def response(resp):
5050
5151 # trim results so there's not way too many at once
5252 first_result_index = page_size * (resp.search_params.get('pageno', 1) - 1)
53− all_results = dom.xpath(results_xpath)
53+ all_results = eval_xpath_list(dom, results_xpath)
5454 trimmed_results = all_results[first_result_index:first_result_index + page_size]
5555
5656 # get results
5757 for result in trimmed_results:
5858 # remove ahmia url and extract the actual url for the result
59− raw_url = extract_url(result.xpath(url_xpath), search_url)
59+ raw_url = extract_url(eval_xpath_list(result, url_xpath, min_len=1), search_url)
6060 cleaned_url = parse_qs(urlparse(raw_url).query).get('redirect_url', [''])[0]
6161
62− title = extract_text(result.xpath(title_xpath))
63− content = extract_text(result.xpath(content_xpath))
62+ title = extract_text(eval_xpath(result, title_xpath))
63+ content = extract_text(eval_xpath(result, content_xpath))
6464
6565 results.append({'url': cleaned_url,
6666 'title': title,
@@ -68,11 +68,11 @@ def response(resp):
6868 'is_onion': True})
6969
7070 # get spelling corrections
71− for correction in dom.xpath(correction_xpath):
71+ for correction in eval_xpath_list(dom, correction_xpath):
7272 results.append({'correction': extract_text(correction)})
7373
7474 # get number of results
75− number_of_results = dom.xpath(number_of_results_xpath)
75+ number_of_results = eval_xpath(dom, number_of_results_xpath)
7676 if number_of_results:
7777 try:
7878 results.append({'number_of_results': int(extract_text(number_of_results))})
searx/engines/duckduckgo_images.py+3−5
@@ -15,6 +15,7 @@
1515
1616from json import loads
1717from urllib.parse import urlencode
18+from searx.exceptions import SearxEngineAPIException
1819from searx.engines.duckduckgo import get_region_code
1920from searx.engines.duckduckgo import _fetch_supported_languages, supported_languages_url # NOQA # pylint: disable=unused-import
2021from searx.poolrequests import get
@@ -37,7 +38,7 @@ def get_vqd(query, headers):
3738 res = get(query_url, headers=headers)
3839 content = res.text
3940 if content.find('vqd=\'') == -1:
40− raise Exception('Request failed')
41+ raise SearxEngineAPIException('Request failed')
4142 vqd = content[content.find('vqd=\'') + 5:]
4243 vqd = vqd[:vqd.find('\'')]
4344 return vqd
@@ -71,10 +72,7 @@ def response(resp):
7172 results = []
7273
7374 content = resp.text
74− try:
75− res_json = loads(content)
76− except:
77− raise Exception('Cannot parse results')
75+ res_json = loads(content)
7876
7977 # parse results
8078 for result in res_json['results']:
searx/engines/elasticsearch.py+2−1
@@ -1,5 +1,6 @@
11from json import loads, dumps
22from requests.auth import HTTPBasicAuth
3+from searx.exceptions import SearxEngineAPIException
34
45
56base_url = 'http://localhost:9200'
@@ -107,7 +108,7 @@ def response(resp):
107108
108109 resp_json = loads(resp.text)
109110 if 'error' in resp_json:
110− raise Exception(resp_json['error'])
111+ raise SearxEngineAPIException(resp_json['error'])
111112
112113 for result in resp_json['hits']['hits']:
113114 r = {key: str(value) if not key.startswith('_') else value for key, value in result['_source'].items()}
searx/engines/google.py+22−30
@@ -20,9 +20,10 @@ Definitions`_.
2020
2121from urllib.parse import urlencode, urlparse
2222from lxml import html
23−from flask_babel import gettext
2423from searx import logger
25−from searx.utils import match_language, extract_text, eval_xpath
24+from searx.utils import match_language, extract_text, eval_xpath, eval_xpath_list, eval_xpath_getindex
25+from searx.exceptions import SearxEngineCaptchaException
26+
2627
2728logger = logger.getChild('google engine')
2829
@@ -131,14 +132,6 @@ suggestion_xpath = '//div[contains(@class, "card-section")]//a'
131132spelling_suggestion_xpath = '//div[@class="med"]/p/a'
132133
133134
134−def extract_text_from_dom(result, xpath):
135− """returns extract_text on the first result selected by the xpath or None"""
136− r = eval_xpath(result, xpath)
137− if len(r) > 0:
138− return extract_text(r[0])
139− return None
140−
141−
142135def get_lang_country(params, lang_list, custom_aliases):
143136 """Returns a tuple with *langauage* on its first and *country* on its second
144137 position."""
@@ -210,10 +203,10 @@ def response(resp):
210203 # detect google sorry
211204 resp_url = urlparse(resp.url)
212205 if resp_url.netloc == 'sorry.google.com' or resp_url.path == '/sorry/IndexRedirect':
213− raise RuntimeWarning('sorry.google.com')
206+ raise SearxEngineCaptchaException()
214207
215208 if resp_url.path.startswith('/sorry'):
216− raise RuntimeWarning(gettext('CAPTCHA required'))
209+ raise SearxEngineCaptchaException()
217210
218211 # which subdomain ?
219212 # subdomain = resp.search_params.get('google_subdomain')
@@ -229,18 +222,17 @@ def response(resp):
229222 logger.debug("did not found 'answer'")
230223
231224 # results --> number_of_results
232− try:
233− _txt = eval_xpath(dom, '//div[@id="result-stats"]//text()')[0]
234− _digit = ''.join([n for n in _txt if n.isdigit()])
235− number_of_results = int(_digit)
236− results.append({'number_of_results': number_of_results})
237−
238− except Exception as e: # pylint: disable=broad-except
239− logger.debug("did not 'number_of_results'")
240− logger.error(e, exc_info=True)
225+ try:
226+ _txt = eval_xpath_getindex(dom, '//div[@id="result-stats"]//text()', 0)
227+ _digit = ''.join([n for n in _txt if n.isdigit()])
228+ number_of_results = int(_digit)
229+ results.append({'number_of_results': number_of_results})
230+ except Exception as e: # pylint: disable=broad-except
231+ logger.debug("did not 'number_of_results'")
232+ logger.error(e, exc_info=True)
241233
242234 # parse results
243− for result in eval_xpath(dom, results_xpath):
235+ for result in eval_xpath_list(dom, results_xpath):
244236
245237 # google *sections*
246238 if extract_text(eval_xpath(result, g_section_with_header)):
@@ -248,14 +240,14 @@ def response(resp):
248240 continue
249241
250242 try:
251− title_tag = eval_xpath(result, title_xpath)
252− if not title_tag:
243+ title_tag = eval_xpath_getindex(result, title_xpath, 0, default=None)
244+ if title_tag is None:
253245 # this not one of the common google results *section*
254246 logger.debug('ingoring <div class="g" ../> section: missing title')
255247 continue
256− title = extract_text(title_tag[0])
257− url = eval_xpath(result, href_xpath)[0]
258− content = extract_text_from_dom(result, content_xpath)
248+ title = extract_text(title_tag)
249+ url = eval_xpath_getindex(result, href_xpath, 0)
250+ content = extract_text(eval_xpath_getindex(result, content_xpath, 0, default=None), allow_none=True)
259251 results.append({
260252 'url': url,
261253 'title': title,
@@ -270,11 +262,11 @@ def response(resp):
270262 continue
271263
272264 # parse suggestion
273− for suggestion in eval_xpath(dom, suggestion_xpath):
265+ for suggestion in eval_xpath_list(dom, suggestion_xpath):
274266 # append suggestion
275267 results.append({'suggestion': extract_text(suggestion)})
276268
277− for correction in eval_xpath(dom, spelling_suggestion_xpath):
269+ for correction in eval_xpath_list(dom, spelling_suggestion_xpath):
278270 results.append({'correction': extract_text(correction)})
279271
280272 # return results
@@ -286,7 +278,7 @@ def _fetch_supported_languages(resp):
286278 ret_val = {}
287279 dom = html.fromstring(resp.text)
288280
289− radio_buttons = eval_xpath(dom, '//*[@id="langSec"]//input[@name="lr"]')
281+ radio_buttons = eval_xpath_list(dom, '//*[@id="langSec"]//input[@name="lr"]')
290282
291283 for x in radio_buttons:
292284 name = x.get("data-name")
searx/engines/google_images.py+3−3
@@ -26,8 +26,8 @@ Definitions`_.
2626
2727from urllib.parse import urlencode, urlparse, unquote
2828from lxml import html
29−from flask_babel import gettext
3029from searx import logger
30+from searx.exceptions import SearxEngineCaptchaException
3131from searx.utils import extract_text, eval_xpath
3232from searx.engines.google import _fetch_supported_languages, supported_languages_url # NOQA # pylint: disable=unused-import
3333
@@ -128,10 +128,10 @@ def response(resp):
128128 # detect google sorry
129129 resp_url = urlparse(resp.url)
130130 if resp_url.netloc == 'sorry.google.com' or resp_url.path == '/sorry/IndexRedirect':
131− raise RuntimeWarning('sorry.google.com')
131+ raise SearxEngineCaptchaException()
132132
133133 if resp_url.path.startswith('/sorry'):
134− raise RuntimeWarning(gettext('CAPTCHA required'))
134+ raise SearxEngineCaptchaException()
135135
136136 # which subdomain ?
137137 # subdomain = resp.search_params.get('google_subdomain')
searx/engines/google_videos.py+5−5
@@ -13,7 +13,7 @@
1313from datetime import date, timedelta
1414from urllib.parse import urlencode
1515from lxml import html
16−from searx.utils import extract_text
16+from searx.utils import extract_text, eval_xpath, eval_xpath_list, eval_xpath_getindex
1717import re
1818
1919# engine dependent config
@@ -66,11 +66,11 @@ def response(resp):
6666 dom = html.fromstring(resp.text)
6767
6868 # parse results
69− for result in dom.xpath('//div[@class="g"]'):
69+ for result in eval_xpath_list(dom, '//div[@class="g"]'):
7070
71− title = extract_text(result.xpath('.//h3'))
72− url = result.xpath('.//div[@class="r"]/a/@href')[0]
73− content = extract_text(result.xpath('.//span[@class="st"]'))
71+ title = extract_text(eval_xpath(result, './/h3'))
72+ url = eval_xpath_getindex(result, './/div[@class="r"]/a/@href', 0)
73+ content = extract_text(eval_xpath(result, './/span[@class="st"]'))
7474
7575 # get thumbnails
7676 script = str(dom.xpath('//script[contains(., "_setImagesSrc")]')[0].text)
searx/engines/youtube_api.py+2−1
@@ -11,6 +11,7 @@
1111from json import loads
1212from dateutil import parser
1313from urllib.parse import urlencode
14+from searx.exceptions import SearxEngineAPIException
1415
1516# engine dependent config
1617categories = ['videos', 'music']
@@ -48,7 +49,7 @@ def response(resp):
4849 search_results = loads(resp.text)
4950
5051 if 'error' in search_results and 'message' in search_results['error']:
51− raise Exception(search_results['error']['message'])
52+ raise SearxEngineAPIException(search_results['error']['message'])
5253
5354 # return empty array if there are no results
5455 if 'items' not in search_results: