[mod] searx/webadapter.py: add get_selected_categories share common code with get_search_query_from_webapp

Update searx/webapp.py to use get_selected_categories
Close #2142
This commit is contained in:
Alexandre Flament 2020-09-22 18:03:42 +02:00
parent d5b5e48f04
commit 678699beaf
2 changed files with 99 additions and 88 deletions

View File

@ -100,6 +100,93 @@ def parse_timeout(raw_text_query, form):
raise SearxParameterException('timeout_limit', raw_time_limit) raise SearxParameterException('timeout_limit', raw_time_limit)
def parse_specific(raw_text_query: RawTextQuery):
query_engineref_list = raw_text_query.enginerefs
additional_categories = set()
for engineref in raw_text_query.enginerefs:
if engineref.from_bang:
additional_categories.add('none')
else:
additional_categories.add(engineref.category)
query_categories = list(additional_categories)
return query_engineref_list, query_categories
def parse_category_form(query_categories, name, value):
if name == 'categories':
query_categories.extend(categ for categ in map(str.strip, value.split(',')) if categ in categories)
elif name.startswith('category_'):
category = name[9:]
# if category is not found in list, skip
if category not in categories:
return
if value != 'off':
# add category to list
query_categories.append(category)
elif category in query_categories:
# remove category from list if property is set to 'off'
query_categories.remove(category)
def get_selected_categories(form, preferences):
selected_categories = []
if form is not None:
for name, value in form.items():
parse_category_form(selected_categories, name, value)
# if no category is specified for this search,
# using user-defined default-configuration which
# (is stored in cookie)
if not selected_categories:
cookie_categories = preferences.get_value('categories')
for ccateg in cookie_categories:
selected_categories.append(ccateg)
# if still no category is specified, using general
# as default-category
if not selected_categories:
selected_categories = ['general']
return selected_categories
def parse_generic(form, preferences, disabled_engines):
query_engineref_list = []
query_categories = []
# set categories/engines
load_default_categories = True
for pd_name, pd in form.items():
if pd_name == 'engines':
pd_engines = [EngineRef(engine_name, engines[engine_name].categories[0])
for engine_name in map(str.strip, pd.split(',')) if engine_name in engines]
if pd_engines:
query_engineref_list.extend(pd_engines)
load_default_categories = False
else:
parse_category_form(query_categories, pd_name, pd)
if not load_default_categories:
if not query_categories:
query_categories = list(set(engine['category']
for engine in query_engineref_list))
else:
if not query_categories:
query_categories = get_selected_categories(None, preferences)
# using all engines for that search, which are
# declared under the specific categories
for categ in query_categories:
query_engineref_list.extend(EngineRef(engine.name, categ)
for engine in categories[categ]
if (engine.name, categ) not in disabled_engines)
return query_engineref_list, query_categories
def get_search_query_from_webapp(preferences, form): def get_search_query_from_webapp(preferences, form):
# no text for the query ? # no text for the query ?
if not form.get('q'): if not form.get('q'):
@ -121,79 +208,18 @@ def get_search_query_from_webapp(preferences, form):
query_timeout = parse_timeout(raw_text_query, form) query_timeout = parse_timeout(raw_text_query, form)
external_bang = raw_text_query.external_bang external_bang = raw_text_query.external_bang
# query_categories if raw_text_query.enginerefs and raw_text_query.specific:
query_engineref_list = raw_text_query.enginerefs
query_categories = []
# if engines are calculated from query, # if engines are calculated from query,
# set categories by using that informations # set categories by using that informations
if query_engineref_list and raw_text_query.specific: query_engineref_list, query_categories = parse_specific(raw_text_query)
additional_categories = set()
for engineref in query_engineref_list:
if engineref.from_bang:
additional_categories.add('none')
else: else:
additional_categories.add(engineref.category)
query_categories = list(additional_categories)
# otherwise, using defined categories to # otherwise, using defined categories to
# calculate which engines should be used # calculate which engines should be used
else: query_engineref_list, query_categories = parse_generic(form, preferences, disabled_engines)
# set categories/engines
load_default_categories = True
for pd_name, pd in form.items():
if pd_name == 'categories':
query_categories.extend(categ for categ in map(str.strip, pd.split(',')) if categ in categories)
elif pd_name == 'engines':
pd_engines = [EngineRef(engineref, engines[engineref].categories[0])
for engine in map(str.strip, pd.split(',')) if engine in engines]
if pd_engines:
query_engineref_list.extend(pd_engines)
load_default_categories = False
elif pd_name.startswith('category_'):
category = pd_name[9:]
# if category is not found in list, skip
if category not in categories:
continue
if pd != 'off':
# add category to list
query_categories.append(category)
elif category in query_categories:
# remove category from list if property is set to 'off'
query_categories.remove(category)
if not load_default_categories:
if not query_categories:
query_categories = list(set(engine['category']
for engine in query_engineref_list))
else:
# if no category is specified for this search,
# using user-defined default-configuration which
# (is stored in cookie)
if not query_categories:
cookie_categories = preferences.get_value('categories')
for ccateg in cookie_categories:
if ccateg in categories:
query_categories.append(ccateg)
# if still no category is specified, using general
# as default-category
if not query_categories:
query_categories = ['general']
# using all engines for that search, which are
# declared under the specific categories
for categ in query_categories:
query_engineref_list.extend(EngineRef(engine.name, categ)
for engine in categories[categ]
if (engine.name, categ) not in disabled_engines)
query_engineref_list = deduplicate_engineref_list(query_engineref_list) query_engineref_list = deduplicate_engineref_list(query_engineref_list)
query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\ query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\
validate_engineref_list(query_engineref_list, preferences) validate_engineref_list(query_engineref_list, preferences)
external_bang = raw_text_query.external_bang
return (SearchQuery(query, query_engineref_list, query_categories, return (SearchQuery(query, query_engineref_list, query_categories,
query_lang, query_safesearch, query_pageno, query_lang, query_safesearch, query_pageno,

View File

@ -67,7 +67,7 @@ from searx.webutils import (
get_static_files, get_result_templates, get_themes, get_static_files, get_result_templates, get_themes,
prettify_url, new_hmac prettify_url, new_hmac
) )
from searx.webadapter import get_search_query_from_webapp from searx.webadapter import get_search_query_from_webapp, get_selected_categories
from searx.utils import html_to_text, gen_useragent, dict_subset, match_language from searx.utils import html_to_text, gen_useragent, dict_subset, match_language
from searx.version import VERSION_STRING from searx.version import VERSION_STRING
from searx.languages import language_codes as languages from searx.languages import language_codes as languages
@ -355,25 +355,6 @@ def render(template_name, override_theme=None, **kwargs):
_get_ordered_categories() _get_ordered_categories()
if x in enabled_categories] if x in enabled_categories]
if 'all_categories' not in kwargs:
kwargs['all_categories'] = _get_ordered_categories()
if 'selected_categories' not in kwargs:
kwargs['selected_categories'] = []
for arg in request.args:
if arg.startswith('category_'):
c = arg.split('_', 1)[1]
if c in categories:
kwargs['selected_categories'].append(c)
if not kwargs['selected_categories']:
cookie_categories = request.preferences.get_value('categories')
for ccateg in cookie_categories:
kwargs['selected_categories'].append(ccateg)
if not kwargs['selected_categories']:
kwargs['selected_categories'] = ['general']
if 'autocomplete' not in kwargs: if 'autocomplete' not in kwargs:
kwargs['autocomplete'] = request.preferences.get_value('autocomplete') kwargs['autocomplete'] = request.preferences.get_value('autocomplete')
@ -532,6 +513,7 @@ def index_error(output_format, error_message):
request.errors.append(gettext('search error')) request.errors.append(gettext('search error'))
return render( return render(
'index.html', 'index.html',
selected_categories=get_selected_categories(request.form, request.preferences),
) )
@ -553,6 +535,7 @@ def index():
if output_format == 'html': if output_format == 'html':
return render( return render(
'index.html', 'index.html',
selected_categories=get_selected_categories(request.form, request.preferences),
) )
else: else:
return index_error(output_format, 'No query'), 400 return index_error(output_format, 'No query'), 400
@ -833,6 +816,8 @@ def preferences():
# end of stats # end of stats
return render('preferences.html', return render('preferences.html',
selected_categories=get_selected_categories(request.form, request.preferences),
all_categories=_get_ordered_categories(),
locales=settings['locales'], locales=settings['locales'],
current_locale=request.preferences.get_value("locale"), current_locale=request.preferences.get_value("locale"),
image_proxy=image_proxy, image_proxy=image_proxy,