Inheritance diagram for searx.plugins.self_info.SXNGPlugin:

Collaboration diagram for searx.plugins.self_info.SXNGPlugin:

Public Member Functions
	__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
	ip_regex = re.compile(r"^ip", re.IGNORECASE)
	ua_regex = re.compile(r"^user-agent", re.IGNORECASE)
	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

Simple plugin that displays information about user's request, including
the IP or HTTP User-Agent.  The information is displayed in area for the
"answers".

Definition at line 20 of file self_info.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 29 of file self_info.py.

    def __init__(self, plg_cfg: "PluginCfg"):
        super().__init__(plg_cfg)
 
        self.ip_regex = re.compile(r"^ip", re.IGNORECASE)
        self.ua_regex = re.compile(r"^user-agent", re.IGNORECASE)
 
        self.info = PluginInfo(
            id=self.id,
            name=gettext("Self Information"),
            description=gettext(
                """Displays your IP if the query is "ip" and your user agent if the query is "user-agent"."""
            ),
            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.self_info.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 44 of file self_info.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
 
        if self.ip_regex.search(search.search_query.query) and request.remote_addr:
            results.add(
                results.types.Answer(answer=gettext("Your IP is: ") + ip_address(request.remote_addr).compressed)
            )
 
        if self.ua_regex.match(search.search_query.query):
            results.add(results.types.Answer(answer=gettext("Your user-agent is: ") + str(request.user_agent)))
 
        return results

References ip_regex, and ua_regex.

Member Data Documentation

◆ info

searx.plugins.self_info.SXNGPlugin.info

Initial value:

=  PluginInfo(
            id=self.id,
            name=gettext("Self Information"),
            description=gettext(
                
            ),
            preference_section="query",
        )

Definition at line 35 of file self_info.py.

◆ ip_regex

searx.plugins.self_info.SXNGPlugin.ip_regex = re.compile(r"^ip", re.IGNORECASE)

Definition at line 32 of file self_info.py.

Referenced by post_search().

◆ ua_regex

searx.plugins.self_info.SXNGPlugin.ua_regex = re.compile(r"^user-agent", re.IGNORECASE)

Definition at line 33 of file self_info.py.

Referenced by post_search().

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

/home/andrew/Documents/code/public/searxng/searx/plugins/self_info.py

Public Member Functions

Public Attributes

Additional Inherited Members