36a1ef1239
In [1] and [2] we discussed the need of a Result.results property and how we can
avoid unclear code. This patch implements a class for the reslut-lists of
engines::
searx.result_types.EngineResults
A simple example for the usage in engine development::
from searx.result_types import EngineResults
...
def response(resp) -> EngineResults:
res = EngineResults()
...
res.add( res.types.Answer(answer="lorem ipsum ..", url="https://example.org") )
...
return res
[1] https://github.com/searxng/searxng/pull/4183#pullrequestreview-257400034
[2] https://github.com/searxng/searxng/pull/4183#issuecomment-2614301580
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# pylint: disable=missing-module-docstring, missing-class-docstring
|
|
from __future__ import annotations
|
|
import typing
|
|
|
|
import re
|
|
import hashlib
|
|
|
|
from flask_babel import gettext
|
|
|
|
from searx.plugins import Plugin, PluginInfo
|
|
from searx.result_types import EngineResults
|
|
|
|
if typing.TYPE_CHECKING:
|
|
from searx.search import SearchWithPlugins
|
|
from searx.extended_types import SXNG_Request
|
|
|
|
|
|
class SXNGPlugin(Plugin):
|
|
"""Plugin converts strings to different hash digests. The results are
|
|
displayed in area for the "answers".
|
|
"""
|
|
|
|
id = "hash_plugin"
|
|
default_on = True
|
|
keywords = ["md5", "sha1", "sha224", "sha256", "sha384", "sha512"]
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
self.parser_re = re.compile(f"({'|'.join(self.keywords)}) (.*)", re.I)
|
|
self.info = PluginInfo(
|
|
id=self.id,
|
|
name=gettext("Hash plugin"),
|
|
description=gettext("Converts strings to different hash digests."),
|
|
examples=["sha512 The quick brown fox jumps over the lazy dog"],
|
|
preference_section="query",
|
|
)
|
|
|
|
def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
|
|
"""Returns a result list only for the first page."""
|
|
results = EngineResults()
|
|
|
|
if search.search_query.pageno > 1:
|
|
return results
|
|
|
|
m = self.parser_re.match(search.search_query.query)
|
|
if not m:
|
|
# wrong query
|
|
return results
|
|
|
|
function, string = m.groups()
|
|
if not string.strip():
|
|
# end if the string is empty
|
|
return results
|
|
|
|
# select hash function
|
|
f = hashlib.new(function.lower())
|
|
|
|
# make digest from the given string
|
|
f.update(string.encode("utf-8").strip())
|
|
answer = function + " " + gettext("hash digest") + ": " + f.hexdigest()
|
|
|
|
results.add(results.types.Answer(answer=answer))
|
|
|
|
return results
|