Classes
class	CSVWriter
class	JSONEncoder

Functions
	get_translated_errors ("Iterable[UnresponsiveEngine]" unresponsive_engines)
None	write_csv_response (CSVWriter csv, "ResultContainer" rc)
str	get_json_response ("SearchQuery" sq, "ResultContainer" rc)
	get_themes (templates_path)
list[str]	get_static_file_list ()
	get_result_templates (templates_path)
	new_hmac (secret_key, url)
	is_hmac_of (secret_key, value, hmac_to_check)
	prettify_url (url, max_length=74)
bool	contains_cjko (str s)
str	regex_highlight_cjk (str word)
	highlight_content (content, query)
str	searxng_l10n_timespan (datetime dt)
List[Tuple[str, "Iterable[Engine]"]]	group_engines_in_tab ("Iterable[Engine]" engines)

Variables
	VALID_LANGUAGE_CODE = re.compile(r'^[a-z]{2,3}(-[a-zA-Z]{2})?$')
	logger = logger.getChild('webutils')
	timeout_text = gettext('timeout')
	parsing_error_text = gettext('parsing error')
	http_protocol_error_text = gettext('HTTP protocol error')
	network_error_text = gettext('network error')
	ssl_cert_error_text = gettext("SSL error: certificate validation has failed")
dict	exception_classname_to_text
str	NO_SUBGROUPING = 'without further subgrouping'

Function Documentation

◆ contains_cjko()

bool searx.webutils.contains_cjko ( str s )

This function check whether or not a string contains Chinese, Japanese,
or Korean characters. It employs regex and uses the u escape sequence to
match any character in a set of Unicode ranges.

Args:
    s (str): string to be checked.

Returns:
    bool: True if the input s contains the characters and False otherwise.

Definition at line 225 of file webutils.py.

def contains_cjko(s: str) -> bool:
    """This function check whether or not a string contains Chinese, Japanese,
    or Korean characters. It employs regex and uses the u escape sequence to
    match any character in a set of Unicode ranges.
 
    Args:
        s (str): string to be checked.
 
    Returns:
        bool: True if the input s contains the characters and False otherwise.
    """
    unicode_ranges = (
        '\u4e00-\u9fff'  # Chinese characters
        '\u3040-\u309f'  # Japanese hiragana
        '\u30a0-\u30ff'  # Japanese katakana
        '\u4e00-\u9faf'  # Japanese kanji
        '\uac00-\ud7af'  # Korean hangul syllables
        '\u1100-\u11ff'  # Korean hangul jamo
    )
    return bool(re.search(fr'[{unicode_ranges}]', s))
 
 

Referenced by regex_highlight_cjk().

Here is the caller graph for this function:

◆ get_json_response()

str searx.webutils.get_json_response	(	"SearchQuery"	sq,
		"ResultContainer"	rc )

Returns the JSON string of the results to a query (``application/json``)

Definition at line 159 of file webutils.py.

def get_json_response(sq: "SearchQuery", rc: "ResultContainer") -> str:
    """Returns the JSON string of the results to a query (``application/json``)"""
    data = {
        'query': sq.query,
        'number_of_results': rc.number_of_results,
        'results': [_.as_dict() for _ in rc.get_ordered_results()],
        'answers': [_.as_dict() for _ in rc.answers],
        'corrections': list(rc.corrections),
        'infoboxes': rc.infoboxes,
        'suggestions': list(rc.suggestions),
        'unresponsive_engines': get_translated_errors(rc.unresponsive_engines),
    }
    response = json.dumps(data, cls=JSONEncoder)
    return response
 
 

References get_translated_errors().

Here is the call graph for this function:

◆ get_result_templates()

searx.webutils.get_result_templates ( templates_path )

Definition at line 198 of file webutils.py.

def get_result_templates(templates_path):
    result_templates = set()
    templates_path_length = len(templates_path) + 1
    for directory, _, files in os.walk(templates_path):
        if directory.endswith('result_templates'):
            for filename in files:
                f = os.path.join(directory[templates_path_length:], filename)
                result_templates.add(f)
    return result_templates
 
 

◆ get_static_file_list()

list[str] searx.webutils.get_static_file_list ( )

Definition at line 180 of file webutils.py.

def get_static_file_list() -> list[str]:
    file_list = []
    static_path = pathlib.Path(str(get_setting("ui.static_path")))
 
    def _walk(path: pathlib.Path):
        for f in path.iterdir():
            if f.name.startswith('.'):
                # ignore hidden file
                continue
            if f.is_file():
                file_list.append(str(f.relative_to(static_path)))
            if f.is_dir():
                _walk(f)
 
    _walk(static_path)
    return file_list
 
 

References searx.get_setting().

Here is the call graph for this function:

◆ get_themes()

searx.webutils.get_themes ( templates_path )

Returns available themes list.

Definition at line 175 of file webutils.py.

def get_themes(templates_path):
    """Returns available themes list."""
    return os.listdir(templates_path)
 
 

◆ get_translated_errors()

searx.webutils.get_translated_errors ( "Iterable[UnresponsiveEngine]" unresponsive_engines )

Definition at line 69 of file webutils.py.

def get_translated_errors(unresponsive_engines: "Iterable[UnresponsiveEngine]"):
    translated_errors = []
 
    for unresponsive_engine in unresponsive_engines:
        error_user_text = exception_classname_to_text.get(unresponsive_engine.error_type)
        if not error_user_text:
            error_user_text = exception_classname_to_text[None]
        error_msg = gettext(error_user_text)
        if unresponsive_engine.suspended:
            error_msg = gettext('Suspended') + ': ' + error_msg
        translated_errors.append((unresponsive_engine.engine, error_msg))
 
    return sorted(translated_errors, key=lambda e: e[0])
 
 

Referenced by get_json_response().

Here is the caller graph for this function:

◆ group_engines_in_tab()

List[Tuple[str, "Iterable[Engine]"]] searx.webutils.group_engines_in_tab ( "Iterable[Engine]" engines )

Groups an Iterable of engines by their first non tab category (first subgroup)

Definition at line 313 of file webutils.py.

def group_engines_in_tab(engines: "Iterable[Engine]") -> List[Tuple[str, "Iterable[Engine]"]]:
    """Groups an Iterable of engines by their first non tab category (first subgroup)"""
 
    def get_subgroup(eng):
        non_tab_categories = [c for c in eng.categories if c not in tabs + [DEFAULT_CATEGORY]]
        return non_tab_categories[0] if len(non_tab_categories) > 0 else NO_SUBGROUPING
 
    def group_sort_key(group):
        return (group[0] == NO_SUBGROUPING, group[0].lower())
 
    def engine_sort_key(engine):
        return (engine.about.get('language', ''), engine.name)
 
    tabs = list(get_setting('categories_as_tabs').keys())
    subgroups = itertools.groupby(sorted(engines, key=get_subgroup), get_subgroup)
    sorted_groups = sorted(((name, list(engines)) for name, engines in subgroups), key=group_sort_key)
 
    ret_val = []
    for groupname, _engines in sorted_groups:
        group_bang = '!' + groupname.replace(' ', '_') if groupname != NO_SUBGROUPING else ''
        ret_val.append((groupname, group_bang, sorted(_engines, key=engine_sort_key)))
 
    return ret_val

References searx.get_setting().

Here is the call graph for this function:

◆ highlight_content()

searx.webutils.highlight_content	(		content,
			query )

Definition at line 267 of file webutils.py.

def highlight_content(content, query):
 
    if not content:
        return None
 
    # ignoring html contents
    if content.find('<') != -1:
        return content
 
    querysplit = query.split()
    queries = []
    for qs in querysplit:
        qs = qs.replace("'", "").replace('"', '').replace(" ", "")
        if len(qs) > 0:
            queries.extend(re.findall(regex_highlight_cjk(qs), content, flags=re.I | re.U))
    if len(queries) > 0:
        regex = re.compile("|".join(map(regex_highlight_cjk, queries)))
        return regex.sub(lambda match: f'<span class="highlight">{match.group(0)}</span>'.replace('\\', r'\\'), content)
    return content
 
 

References regex_highlight_cjk().

Here is the call graph for this function:

◆ is_hmac_of()

searx.webutils.is_hmac_of	(	secret_key,
		value,
		hmac_to_check )

Definition at line 213 of file webutils.py.

def is_hmac_of(secret_key, value, hmac_to_check):
    hmac_of_value = new_hmac(secret_key, value)
    return len(hmac_of_value) == len(hmac_to_check) and hmac.compare_digest(hmac_of_value, hmac_to_check)
 
 

References new_hmac().

Here is the call graph for this function:

◆ new_hmac()

searx.webutils.new_hmac	(		secret_key,
			url )

Definition at line 209 of file webutils.py.

def new_hmac(secret_key, url):
    return hmac.new(secret_key.encode(), url, hashlib.sha256).hexdigest()

Referenced by is_hmac_of().

Here is the caller graph for this function:

◆ prettify_url()

searx.webutils.prettify_url	(		url,
			max_length = 74 )

Definition at line 218 of file webutils.py.

def prettify_url(url, max_length=74):
    if len(url) > max_length:
        chunk_len = int(max_length / 2 + 1)
        return '{0}[...]{1}'.format(url[:chunk_len], url[-chunk_len:])
    return url
 
 

◆ regex_highlight_cjk()

str searx.webutils.regex_highlight_cjk ( str word )

Generate the regex pattern to match for a given word according
to whether or not the word contains CJK characters or not.
If the word is and/or contains CJK character, the regex pattern
will match standalone word by taking into account the presence
of whitespace before and after it; if not, it will match any presence
of the word throughout the text, ignoring the whitespace.

Args:
    word (str): the word to be matched with regex pattern.

Returns:
    str: the regex pattern for the word.

Definition at line 247 of file webutils.py.

def regex_highlight_cjk(word: str) -> str:
    """Generate the regex pattern to match for a given word according
    to whether or not the word contains CJK characters or not.
    If the word is and/or contains CJK character, the regex pattern
    will match standalone word by taking into account the presence
    of whitespace before and after it; if not, it will match any presence
    of the word throughout the text, ignoring the whitespace.
 
    Args:
        word (str): the word to be matched with regex pattern.
 
    Returns:
        str: the regex pattern for the word.
    """
    rword = re.escape(word)
    if contains_cjko(rword):
        return fr'({rword})'
    return fr'\b({rword})(?!\w)'
 
 

References contains_cjko().

Referenced by highlight_content().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ searxng_l10n_timespan()

str searx.webutils.searxng_l10n_timespan ( datetime dt )

Returns a human-readable and translated string indicating how long ago
a date was in the past / the time span of the date to the present.

On January 1st, midnight, the returned string only indicates how many years
ago the date was.

Definition at line 288 of file webutils.py.

def searxng_l10n_timespan(dt: datetime) -> str:  # pylint: disable=invalid-name
    """Returns a human-readable and translated string indicating how long ago
    a date was in the past / the time span of the date to the present.
 
    On January 1st, midnight, the returned string only indicates how many years
    ago the date was.
    """
    # TODO, check if timezone is calculated right  # pylint: disable=fixme
    d = dt.date()
    t = dt.time()
    if d.month == 1 and d.day == 1 and t.hour == 0 and t.minute == 0 and t.second == 0:
        return str(d.year)
    if dt.replace(tzinfo=None) >= datetime.now() - timedelta(days=1):
        timedifference = datetime.now() - dt.replace(tzinfo=None)
        minutes = int((timedifference.seconds / 60) % 60)
        hours = int(timedifference.seconds / 60 / 60)
        if hours == 0:
            return gettext('{minutes} minute(s) ago').format(minutes=minutes)
        return gettext('{hours} hour(s), {minutes} minute(s) ago').format(hours=hours, minutes=minutes)
    return format_date(dt)
 
 

◆ write_csv_response()

None searx.webutils.write_csv_response	(	CSVWriter	csv,
		"ResultContainer"	rc )

Write rows of the results to a query (``application/csv``) into a CSV
table (:py:obj:`CSVWriter`).  First line in the table contain the column
names.  The column "type" specifies the type, the following types are
included in the table:

- result
- answer
- suggestion
- correction

Definition at line 112 of file webutils.py.

def write_csv_response(csv: CSVWriter, rc: "ResultContainer") -> None:  # pylint: disable=redefined-outer-name
    """Write rows of the results to a query (``application/csv``) into a CSV
    table (:py:obj:`CSVWriter`).  First line in the table contain the column
    names.  The column "type" specifies the type, the following types are
    included in the table:
 
    - result
    - answer
    - suggestion
    - correction
 
    """
 
    keys = ('title', 'url', 'content', 'host', 'engine', 'score', 'type')
    csv.writerow(keys)
 
    for res in rc.get_ordered_results():
        row = res.as_dict()
        row['host'] = row['parsed_url'].netloc
        row['type'] = 'result'
        csv.writerow([row.get(key, '') for key in keys])
 
    for a in rc.answers:
        row = a.as_dict()
        row['host'] = row['parsed_url'].netloc
        csv.writerow([row.get(key, '') for key in keys])
 
    for a in rc.suggestions:
        row = {'title': a, 'type': 'suggestion'}
        csv.writerow([row.get(key, '') for key in keys])
 
    for a in rc.corrections:
        row = {'title': a, 'type': 'correction'}
        csv.writerow([row.get(key, '') for key in keys])
 
 

Variable Documentation

◆ exception_classname_to_text

dict searx.webutils.exception_classname_to_text

Initial value:

=  {
    None: gettext('unexpected crash'),
    'timeout': timeout_text,
    'asyncio.TimeoutError': timeout_text,
    'httpx.TimeoutException': timeout_text,
    'httpx.ConnectTimeout': timeout_text,
    'httpx.ReadTimeout': timeout_text,
    'httpx.WriteTimeout': timeout_text,
    'httpx.HTTPStatusError': gettext('HTTP error'),
    'httpx.ConnectError': gettext("HTTP connection error"),
    'httpx.RemoteProtocolError': http_protocol_error_text,
    'httpx.LocalProtocolError': http_protocol_error_text,
    'httpx.ProtocolError': http_protocol_error_text,
    'httpx.ReadError': network_error_text,
    'httpx.WriteError': network_error_text,
    'httpx.ProxyError': gettext("proxy error"),
    'searx.exceptions.SearxEngineCaptchaException': gettext("CAPTCHA"),
    'searx.exceptions.SearxEngineTooManyRequestsException': gettext("too many requests"),
    'searx.exceptions.SearxEngineAccessDeniedException': gettext("access denied"),
    'searx.exceptions.SearxEngineAPIException': gettext("server API error"),
    'searx.exceptions.SearxEngineXPathException': parsing_error_text,
    'KeyError': parsing_error_text,
    'json.decoder.JSONDecodeError': parsing_error_text,
    'lxml.etree.ParserError': parsing_error_text,
    'ssl.SSLCertVerificationError': ssl_cert_error_text,  # for Python > 3.7
    'ssl.CertificateError': ssl_cert_error_text,  # for Python 3.7
}

Definition at line 40 of file webutils.py.

◆ http_protocol_error_text

searx.webutils.http_protocol_error_text = gettext('HTTP protocol error')

Definition at line 37 of file webutils.py.

◆ logger

searx.webutils.logger = logger.getChild('webutils')

Definition at line 33 of file webutils.py.

◆ network_error_text

searx.webutils.network_error_text = gettext('network error')

Definition at line 38 of file webutils.py.

◆ NO_SUBGROUPING

str searx.webutils.NO_SUBGROUPING = 'without further subgrouping'

Definition at line 310 of file webutils.py.

◆ parsing_error_text

searx.webutils.parsing_error_text = gettext('parsing error')

Definition at line 36 of file webutils.py.

◆ ssl_cert_error_text

searx.webutils.ssl_cert_error_text = gettext("SSL error: certificate validation has failed")

Definition at line 39 of file webutils.py.

◆ timeout_text

searx.webutils.timeout_text = gettext('timeout')

Definition at line 35 of file webutils.py.

◆ VALID_LANGUAGE_CODE

searx.webutils.VALID_LANGUAGE_CODE = re.compile(r'^[a-z]{2,3}(-[a-zA-Z]{2})?$')

Definition at line 31 of file webutils.py.

Classes

Functions

Variables

Function Documentation

◆ contains_cjko()

◆ get_json_response()

◆ get_result_templates()

◆ get_static_file_list()

◆ get_themes()

◆ get_translated_errors()

◆ group_engines_in_tab()

◆ highlight_content()

◆ is_hmac_of()

◆ new_hmac()

◆ prettify_url()

◆ regex_highlight_cjk()

◆ searxng_l10n_timespan()

◆ write_csv_response()

Variable Documentation

◆ exception_classname_to_text

◆ http_protocol_error_text

◆ logger

◆ network_error_text

◆ NO_SUBGROUPING

◆ parsing_error_text

◆ ssl_cert_error_text

◆ timeout_text

◆ VALID_LANGUAGE_CODE