|
@@ -29,7 +29,11 @@ logger = logger.getChild('XPath engine')
|
|
|
|
|
|
search_url = None
|
|
search_url = None
|
|
"""
|
|
"""
|
|
-Search URL of the engine, replacements are:
|
|
|
|
|
|
+Search URL of the engine. Example::
|
|
|
|
+
|
|
|
|
+ https://example.org/?search={query}&page={pageno}{time_range}{safe_search}
|
|
|
|
+
|
|
|
|
+Replacements are:
|
|
|
|
|
|
``{query}``:
|
|
``{query}``:
|
|
Search terms from user.
|
|
Search terms from user.
|
|
@@ -45,6 +49,15 @@ Search URL of the engine, replacements are:
|
|
range <time_range_support>`. The value for the parameter is taken from
|
|
range <time_range_support>`. The value for the parameter is taken from
|
|
:py:obj:`time_range_map`.
|
|
:py:obj:`time_range_map`.
|
|
|
|
|
|
|
|
+``{safe_search}``:
|
|
|
|
+ Safe-search :py:obj:`URL parameter <safe_search_map>` if engine
|
|
|
|
+ :py:obj:`supports safe-search <safe_search_support>`. The ``{safe_search}``
|
|
|
|
+ replacement is taken from the :py:obj:`safes_search_map`. Filter results::
|
|
|
|
+
|
|
|
|
+ 0: none, 1: moderate, 2:strict
|
|
|
|
+
|
|
|
|
+ If not supported, the URL paramter is an empty string.
|
|
|
|
+
|
|
"""
|
|
"""
|
|
|
|
|
|
lang_all='en'
|
|
lang_all='en'
|
|
@@ -117,6 +130,26 @@ time_range_map = {
|
|
year: 365
|
|
year: 365
|
|
'''
|
|
'''
|
|
|
|
|
|
|
|
+safe_search_support = False
|
|
|
|
+'''Engine supports safe-search.'''
|
|
|
|
+
|
|
|
|
+safe_search_map = {
|
|
|
|
+ 0: '&filter=none',
|
|
|
|
+ 1: '&filter=moderate',
|
|
|
|
+ 2: '&filter=strict'
|
|
|
|
+}
|
|
|
|
+'''Maps safe-search value to ``{safe_search}`` in :py:obj:`search_url`.
|
|
|
|
+
|
|
|
|
+.. code:: yaml
|
|
|
|
+
|
|
|
|
+ safesearch: true
|
|
|
|
+ safes_search_map:
|
|
|
|
+ 0: '&filter=none'
|
|
|
|
+ 1: '&filter=moderate'
|
|
|
|
+ 2: '&filter=strict'
|
|
|
|
+
|
|
|
|
+'''
|
|
|
|
+
|
|
def request(query, params):
|
|
def request(query, params):
|
|
'''Build request parameters (see :ref:`engine request`).
|
|
'''Build request parameters (see :ref:`engine request`).
|
|
|
|
|
|
@@ -130,11 +163,16 @@ def request(query, params):
|
|
time_range_val = time_range_map.get(params.get('time_range'))
|
|
time_range_val = time_range_map.get(params.get('time_range'))
|
|
time_range = time_range_url.format(time_range_val=time_range_val)
|
|
time_range = time_range_url.format(time_range_val=time_range_val)
|
|
|
|
|
|
|
|
+ safe_search = ''
|
|
|
|
+ if params['safesearch']:
|
|
|
|
+ safe_search = safe_search_map[params['safesearch']]
|
|
|
|
+
|
|
fargs = {
|
|
fargs = {
|
|
'query': urlencode({'q': query})[2:],
|
|
'query': urlencode({'q': query})[2:],
|
|
'lang': lang,
|
|
'lang': lang,
|
|
'pageno': (params['pageno'] - 1) * page_size + first_page_num,
|
|
'pageno': (params['pageno'] - 1) * page_size + first_page_num,
|
|
'time_range' : time_range,
|
|
'time_range' : time_range,
|
|
|
|
+ 'safe_search' : safe_search,
|
|
}
|
|
}
|
|
|
|
|
|
params['url'] = search_url.format(**fargs)
|
|
params['url'] = search_url.format(**fargs)
|