searx.plugins.tor_check.SXNGPlugin Class Reference

Inheritance diagram for searx.plugins.tor_check.SXNGPlugin:

Collaboration diagram for searx.plugins.tor_check.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
	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

Rewrite hostnames, remove results or prioritize them.

Definition at line 31 of file tor_check.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 37 of file tor_check.py.

    def __init__(self, plg_cfg: "PluginCfg") -> None:
        super().__init__(plg_cfg)
        self.info = PluginInfo(
            id=self.id,
            name=gettext("Tor check plugin"),
            description=gettext(
                "This plugin checks if the address of the request is a Tor exit-node, and"
                " informs the user if it is; like check.torproject.org, but from SearXNG."
            ),
            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.tor_check.SXNGPlugin.post_search	(		self,
		"SXNG_Request"	request,
		"SearchWithPlugins"	search )

Runs AFTER the search request.  Can return a list of
:py:obj:`Result <searx.result_types._base.Result>` objects to be added to the
final result list.

Reimplemented from searx.plugins._core.Plugin.

Definition at line 49 of file tor_check.py.

    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
        results = EngineResults()
 
        if search.search_query.pageno > 1:
            return results
 
        if search.search_query.query.lower() in self.keywords:
 
            # Request the list of tor exit nodes.
            try:
                resp = get(url_exit_list)
                node_list = re.findall(reg, resp.text)  # type: ignore
 
            except HTTPError:
                # No answer, return error
                msg = gettext("Could not download the list of Tor exit-nodes from")
                results.add(results.types.Answer(answer=f"{msg} {url_exit_list}"))
                return results
 
            real_ip = ip_address(address=str(request.remote_addr)).compressed
 
            if real_ip in node_list:
                msg = gettext("You are using Tor and it looks like you have the external IP address")
                results.add(results.types.Answer(answer=f"{msg} {real_ip}"))
 
            else:
                msg = gettext("You are not using Tor and you have the external IP address")
                results.add(results.types.Answer(answer=f"{msg} {real_ip}"))
 
        return results

References searx.answerers._core.Answerer.keywords, searx.answerers._core.AnswererInfo.keywords, searx.answerers._core.ModuleAnswerer.keywords, searx.answerers.random.SXNGAnswerer.keywords, searx.answerers.statistics.SXNGAnswerer.keywords, searx.plugins._core.Plugin.keywords, and searx.plugins._core.PluginInfo.keywords.

Member Data Documentation

info

searx.plugins.tor_check.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Tor check plugin"),
            description=gettext(
                "This plugin checks if the address of the request is a Tor exit-node, and"
                " informs the user if it is; like check.torproject.org, but from SearXNG."
            ),
            preference_section="query",
        )

Definition at line 39 of file tor_check.py.

---

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

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