searxng/searx/engines/xpath.py

134 lines
4.1 KiB
Python
Raw Normal View History

2013-10-26 00:22:20 +00:00
from lxml import html
from lxml.etree import _ElementStringResult, _ElementUnicodeResult
from searx.utils import html_to_text, eval_xpath
2016-11-30 17:43:03 +00:00
from searx.url_utils import unquote, urlencode, urljoin, urlparse
2013-10-26 00:22:20 +00:00
2014-01-20 01:31:20 +00:00
search_url = None
url_xpath = None
2013-10-26 00:22:20 +00:00
content_xpath = None
2014-01-20 01:31:20 +00:00
title_xpath = None
thumbnail_xpath = False
2016-11-30 17:43:03 +00:00
paging = False
suggestion_xpath = ''
results_xpath = ''
2013-10-26 00:22:20 +00:00
# parameters for engines with paging support
#
# number of results on each page
# (only needed if the site requires not a page number, but an offset)
page_size = 1
# number of the first page (usually 0 or 1)
first_page_num = 1
2014-01-20 01:31:20 +00:00
'''
if xpath_results is list, extract the text from each result and concat the list
2014-01-20 01:31:20 +00:00
if xpath_results is a xml element, extract all the text node from it
( text_content() method from lxml )
if xpath_results is a string element, then it's already done
'''
2014-01-20 01:31:20 +00:00
def extract_text(xpath_results):
2013-10-26 00:22:20 +00:00
if type(xpath_results) == list:
# it's list of result : concat everything using recursive call
result = ''
for e in xpath_results:
result = result + extract_text(e)
2015-01-25 19:04:44 +00:00
return result.strip()
elif type(xpath_results) in [_ElementStringResult, _ElementUnicodeResult]:
# it's a string
return ''.join(xpath_results)
2013-10-26 00:22:20 +00:00
else:
# it's a element
text = html.tostring(
xpath_results, encoding='unicode', method='text', with_tail=False
)
text = text.strip().replace('\n', ' ')
return ' '.join(text.split())
2014-01-30 01:36:05 +00:00
def extract_url(xpath_results, search_url):
2017-01-17 11:14:33 +00:00
if xpath_results == []:
raise Exception('Empty url resultset')
url = extract_text(xpath_results)
if url.startswith('//'):
# add http or https to this kind of url //example.com/
parsed_search_url = urlparse(search_url)
url = u'{0}:{1}'.format(parsed_search_url.scheme or 'http', url)
elif url.startswith('/'):
# fix relative url to the search engine
url = urljoin(search_url, url)
# normalize url
url = normalize_url(url)
return url
def normalize_url(url):
2013-10-26 00:22:20 +00:00
parsed_url = urlparse(url)
# add a / at this end of the url if there is no path
2013-10-26 00:22:20 +00:00
if not parsed_url.netloc:
raise Exception('Cannot parse url')
2013-10-27 11:01:03 +00:00
if not parsed_url.path:
url += '/'
# FIXME : hack for yahoo
2014-01-20 01:31:20 +00:00
if parsed_url.hostname == 'search.yahoo.com'\
and parsed_url.path.startswith('/r'):
p = parsed_url.path
mark = p.find('/**')
if mark != -1:
2016-01-18 11:47:31 +00:00
return unquote(p[mark + 3:]).decode('utf-8')
2013-10-26 00:22:20 +00:00
return url
2013-10-26 00:22:20 +00:00
def request(query, params):
query = urlencode({'q': query})[2:]
fp = {'query': query}
if paging and search_url.find('{pageno}') >= 0:
fp['pageno'] = (params['pageno'] - 1) * page_size + first_page_num
params['url'] = search_url.format(**fp)
2013-10-26 00:22:20 +00:00
params['query'] = query
2013-10-26 00:22:20 +00:00
return params
def response(resp):
results = []
dom = html.fromstring(resp.text)
if results_xpath:
for result in eval_xpath(dom, results_xpath):
url = extract_url(eval_xpath(result, url_xpath), search_url)
title = extract_text(eval_xpath(result, title_xpath))
content = extract_text(eval_xpath(result, content_xpath))
tmp_result = {'url': url, 'title': title, 'content': content}
# add thumbnail if available
if thumbnail_xpath:
thumbnail_xpath_result = eval_xpath(result, thumbnail_xpath)
if len(thumbnail_xpath_result) > 0:
tmp_result['img_src'] = extract_url(thumbnail_xpath_result, search_url)
results.append(tmp_result)
else:
2014-01-12 17:48:38 +00:00
for url, title, content in zip(
2014-01-30 02:10:20 +00:00
(extract_url(x, search_url) for
x in eval_xpath(dom, url_xpath)),
map(extract_text, eval_xpath(dom, title_xpath)),
map(extract_text, eval_xpath(dom, content_xpath))
2014-01-20 01:31:20 +00:00
):
results.append({'url': url, 'title': title, 'content': content})
if not suggestion_xpath:
return results
for suggestion in eval_xpath(dom, suggestion_xpath):
results.append({'suggestion': extract_text(suggestion)})
2013-10-26 00:22:20 +00:00
return results