From 6ed4616da99b25703489e7431d84d8749a7a167c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 26 May 2021 19:43:27 +0200 Subject: [enh] add settings option to enable/disable search formats Access to formats can be denied by settings configuration:: search: formats: [html, csv, json, rss] Closes: https://github.com/searxng/searxng/issues/95 Signed-off-by: Markus Heiser --- searx/utils.py | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) (limited to 'searx/utils.py') diff --git a/searx/utils.py b/searx/utils.py index 55a386bd5..8c5b3a9b3 100644 --- a/searx/utils.py +++ b/searx/utils.py @@ -8,6 +8,7 @@ from os.path import splitext, join from random import choice from html.parser import HTMLParser from urllib.parse import urljoin, urlparse +from collections.abc import Mapping from lxml import html from lxml.etree import ElementBase, XPath, XPathError, XPathSyntaxError, _ElementStringResult, _ElementUnicodeResult @@ -500,6 +501,62 @@ def get_engine_from_settings(name): return {} +NOT_EXISTS = object() +"""Singleton used by :py:obj:`get_value` if a key does not exists.""" + + +def get_value(dictionary, keyword, *keys, default=NOT_EXISTS): + """Return the value from a *deep* mapping type (e.g. the ``settings`` object + from yaml). If the path to the *key* does not exists a :py:obj:`NOT_EXISTS` + is returned (non ``KeyError`` exception is raised). + + .. code: python + + >>> from searx.utils import get_value, NOT_EXISTS + >>> get_value(settings, 'checker', 'additional_tests', 'rosebud', 'result_container') + ['not_empty', ['one_title_contains', 'citizen kane']] + + >>> get_value(settings, 'search', 'xxx') is NOT_EXISTS + True + >>> get_value(settings, 'search', 'formats') + ['csv', 'json', 'rss'] + + The list returned from the ``search.format`` key is not a mapping type, you + can't traverse along non-mapping types. If you try it, you will get a + :py:ref:`NOT_EXISTS`: + + .. code: python + + >>> get_value(settings, 'search', 'format', 'csv') is NOT_EXISTS + True + >>> get_value(settings, 'search', 'formats')[0] + 'csv' + + For convenience you can replace :py:ref:`NOT_EXISTS` by a default value of + your choice: + + .. code: python + + if 'csv' in get_value(settings, 'search', 'formats', default=[]): + print("csv format is denied") + + """ + if not isinstance(dictionary, Mapping): + raise TypeError("expected mapping type, got %s" % type(dictionary)) + + ret_val = dictionary.get(keyword, default) + + if ret_val is default: + return ret_val + + if len(keys): + if not isinstance(ret_val, Mapping): + ret_val = default + else: + ret_val = get_value(ret_val, *keys, default=default) + return ret_val + + def get_xpath(xpath_spec): """Return cached compiled XPath -- cgit v1.2.3 From 96b223023acc1a1b0642a70246b71c2a3a05cd03 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 27 May 2021 20:15:33 +0200 Subject: [mod] utils.get_value() - avoidance of a recursion In a comment [1] dalf suggested to avoid a recursion of get_value() [1] https://github.com/searxng/searxng/pull/99#discussion_r640833716 Suggested-by: Alexandre Flament Signed-off-by: Markus Heiser --- searx/utils.py | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) (limited to 'searx/utils.py') diff --git a/searx/utils.py b/searx/utils.py index 8c5b3a9b3..ad69816ce 100644 --- a/searx/utils.py +++ b/searx/utils.py @@ -505,13 +505,14 @@ NOT_EXISTS = object() """Singleton used by :py:obj:`get_value` if a key does not exists.""" -def get_value(dictionary, keyword, *keys, default=NOT_EXISTS): +def get_value(dictionary, *keys, default=NOT_EXISTS): """Return the value from a *deep* mapping type (e.g. the ``settings`` object from yaml). If the path to the *key* does not exists a :py:obj:`NOT_EXISTS` is returned (non ``KeyError`` exception is raised). .. code: python + >>> from searx import settings >>> from searx.utils import get_value, NOT_EXISTS >>> get_value(settings, 'checker', 'additional_tests', 'rosebud', 'result_container') ['not_empty', ['one_title_contains', 'citizen kane']] @@ -519,7 +520,7 @@ def get_value(dictionary, keyword, *keys, default=NOT_EXISTS): >>> get_value(settings, 'search', 'xxx') is NOT_EXISTS True >>> get_value(settings, 'search', 'formats') - ['csv', 'json', 'rss'] + ['html', 'csv', 'json', 'rss'] The list returned from the ``search.format`` key is not a mapping type, you can't traverse along non-mapping types. If you try it, you will get a @@ -529,7 +530,7 @@ def get_value(dictionary, keyword, *keys, default=NOT_EXISTS): >>> get_value(settings, 'search', 'format', 'csv') is NOT_EXISTS True - >>> get_value(settings, 'search', 'formats')[0] + >>> get_value(settings, 'search', 'formats')[1] 'csv' For convenience you can replace :py:ref:`NOT_EXISTS` by a default value of @@ -541,20 +542,15 @@ def get_value(dictionary, keyword, *keys, default=NOT_EXISTS): print("csv format is denied") """ - if not isinstance(dictionary, Mapping): - raise TypeError("expected mapping type, got %s" % type(dictionary)) - ret_val = dictionary.get(keyword, default) - - if ret_val is default: - return ret_val - - if len(keys): - if not isinstance(ret_val, Mapping): - ret_val = default - else: - ret_val = get_value(ret_val, *keys, default=default) - return ret_val + obj = dictionary + for k in keys: + if not isinstance(obj, Mapping): + raise TypeError("expected mapping type, got %s" % type(obj)) + obj = obj.get(k, default) + if obj is default: + return obj + return obj def get_xpath(xpath_spec): -- cgit v1.2.3