searx.plugins.hash_plugin.SXNGPlugin Class Reference

Inheritance diagram for searx.plugins.hash_plugin.SXNGPlugin:

Collaboration diagram for searx.plugins.hash_plugin.SXNGPlugin:

Public Member Functions
None	__init__ (self, "PluginCfg" plg_cfg)
EngineResults	post_search (self, "SXNG_Request" request, "SearchWithPlugins" search)
Public Member Functions inherited from searx.plugins._core.Plugin
None	__init__ (self, "PluginCfg" plg_cfg)
int	__hash__ (self)
	__eq__ (self, typing.Any other)
bool	init (self, "flask.Flask" app)
bool	pre_search (self, SXNG_Request request, "SearchWithPlugins" search)
bool	on_result (self, SXNG_Request request, "SearchWithPlugins" search, Result result)

Public Attributes
	parser_re = re.compile(f"({'|'.join(self.keywords)}) (.*)", re.I)
	info

Additional Inherited Members
Static Public Attributes inherited from searx.plugins._core.Plugin
str	id = ""
typing	active .ClassVar[bool]
list	keywords = []
logging	log .Logger
str	fqn = ""

Detailed Description

Plugin converts strings to different hash digests.  The results are
displayed in area for the "answers".

Definition at line 19 of file hash_plugin.py.

Constructor & Destructor Documentation

__init__()

None searx.plugins.hash_plugin.SXNGPlugin.__init__	(		self,
		"PluginCfg"	plg_cfg )

Definition at line 27 of file hash_plugin.py.

    def __init__(self, plg_cfg: "PluginCfg") -> None:
        super().__init__(plg_cfg)
 
        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. Available functions: md5, sha1, sha224, sha256, sha384, sha512."  # pylint:disable=line-too-long
            ),
            examples=["sha512 The quick brown fox jumps over the lazy dog"],
            preference_section="query",
        )
 

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

post_search()

EngineResults searx.plugins.hash_plugin.SXNGPlugin.post_search	(		self,
		"SXNG_Request"	request,
		"SearchWithPlugins"	search )

Returns a result list only for the first page.

Reimplemented from searx.plugins._core.Plugin.

Definition at line 41 of file hash_plugin.py.

    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

References parser_re.

Member Data Documentation

info

searx.plugins.hash_plugin.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Hash plugin"),
            description=gettext(
                "Converts strings to different hash digests. Available functions: md5, sha1, sha224, sha256, sha384, sha512."  # pylint:disable=line-too-long
            ),
            examples=["sha512 The quick brown fox jumps over the lazy dog"],
            preference_section="query",
        )

Definition at line 31 of file hash_plugin.py.

parser_re

searx.plugins.hash_plugin.SXNGPlugin.parser_re = re.compile(f"({'|'.join(self.keywords)}) (.*)", re.I)

Definition at line 30 of file hash_plugin.py.

Referenced by post_search().

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/plugins/hash_plugin.py