50f92779bd
This patch brings two major changes:
- ``Result.filter_urls(..)`` to pass a filter function for URL fields
- The ``enabled_plugins:`` section in SearXNG's settings do no longer exists.
To understand plugin development compile documentation:
$ make docs.clean docs.live
and read http://0.0.0.0:8000/dev/plugins/development.html
There is no longer a distinction between built-in and external plugin, all
plugins are registered via the settings in the ``plugins:`` section.
In SearXNG, plugins can be registered via a fully qualified class name. A
configuration (`PluginCfg`) can be transferred to the plugin, e.g. to activate
it by default / *opt-in* or *opt-out* from user's point of view.
built-in plugins
================
The built-in plugins are all located in the namespace `searx.plugins`.
.. code:: yaml
plugins:
searx.plugins.calculator.SXNGPlugin:
active: true
searx.plugins.hash_plugin.SXNGPlugin:
active: true
searx.plugins.self_info.SXNGPlugin:
active: true
searx.plugins.tracker_url_remover.SXNGPlugin:
active: true
searx.plugins.unit_converter.SXNGPlugin:
active: true
searx.plugins.ahmia_filter.SXNGPlugin:
active: true
searx.plugins.hostnames.SXNGPlugin:
active: true
searx.plugins.oa_doi_rewrite.SXNGPlugin:
active: false
searx.plugins.tor_check.SXNGPlugin:
active: false
external plugins
================
SearXNG supports *external plugins* / there is no need to install one, SearXNG
runs out of the box.
- Only show green hosted results: https://github.com/return42/tgwf-searx-plugins/
To get a developer installation in a SearXNG developer environment:
.. code:: sh
$ git clone git@github.com:return42/tgwf-searx-plugins.git
$ ./manage pyenv.cmd python -m \
pip install -e tgwf-searx-plugins
To register the plugin in SearXNG add ``only_show_green_results.SXNGPlugin`` to
the ``plugins:``:
.. code:: yaml
plugins:
# ...
only_show_green_results.SXNGPlugin:
active: false
Result.filter_urls(..)
======================
The ``Result.filter_urls(..)`` can be used to filter and/or modify URL fields.
In the following example, the filter function ``my_url_filter``:
.. code:: python
def my_url_filter(result, field_name, url_src) -> bool | str:
if "google" in url_src:
return False # remove URL field from result
if "facebook" in url_src:
new_url = url_src.replace("facebook", "fb-dummy")
return new_url # return modified URL
return True # leave URL in field unchanged
is applied to all URL fields in the :py:obj:`Plugin.on_result` hook:
.. code:: python
class MyUrlFilter(Plugin):
...
def on_result(self, request, search, result) -> bool:
result.filter_urls(my_url_filter)
return True
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
108 lines
2.9 KiB
Python
108 lines
2.9 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
|
|
|
|
import babel
|
|
from mock import Mock
|
|
|
|
import searx
|
|
import searx.plugins
|
|
import searx.preferences
|
|
import searx.results
|
|
|
|
from searx.result_types import Result
|
|
from searx.extended_types import sxng_request
|
|
|
|
from tests import SearxTestCase
|
|
|
|
plg_store = searx.plugins.PluginStorage()
|
|
plg_store.load_settings(searx.get_setting("plugins"))
|
|
|
|
|
|
def get_search_mock(query, **kwargs):
|
|
|
|
lang = kwargs.get("lang", "en-US")
|
|
kwargs["pageno"] = kwargs.get("pageno", 1)
|
|
kwargs["locale"] = babel.Locale.parse(lang, sep="-")
|
|
user_plugins = kwargs.pop("user_plugins", [x.id for x in plg_store])
|
|
|
|
return Mock(
|
|
search_query=Mock(query=query, **kwargs),
|
|
user_plugins=user_plugins,
|
|
result_container=searx.results.ResultContainer(),
|
|
)
|
|
|
|
|
|
def do_pre_search(query, storage, **kwargs) -> bool:
|
|
|
|
search = get_search_mock(query, **kwargs)
|
|
ret = storage.pre_search(sxng_request, search)
|
|
return ret
|
|
|
|
|
|
def do_post_search(query, storage, **kwargs) -> Mock:
|
|
|
|
search = get_search_mock(query, **kwargs)
|
|
storage.post_search(sxng_request, search)
|
|
return search
|
|
|
|
|
|
class PluginMock(searx.plugins.Plugin):
|
|
|
|
def __init__(self, _id: str, name: str, active: bool):
|
|
plg_cfg = searx.plugins.PluginCfg(active=active)
|
|
self.id = _id
|
|
self._name = name
|
|
super().__init__(plg_cfg)
|
|
|
|
# pylint: disable= unused-argument
|
|
def pre_search(self, request, search) -> bool:
|
|
return True
|
|
|
|
def post_search(self, request, search) -> None:
|
|
return None
|
|
|
|
def on_result(self, request, search, result) -> bool:
|
|
return False
|
|
|
|
def info(self):
|
|
return searx.plugins.PluginInfo(
|
|
id=self.id,
|
|
name=self._name,
|
|
description=f"Dummy plugin: {self.id}",
|
|
preference_section="general",
|
|
)
|
|
|
|
|
|
class PluginStorage(SearxTestCase):
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
engines = {}
|
|
|
|
self.storage = searx.plugins.PluginStorage()
|
|
self.storage.register(PluginMock("plg001", "first plugin", True))
|
|
self.storage.register(PluginMock("plg002", "second plugin", True))
|
|
self.storage.init(self.app)
|
|
self.pref = searx.preferences.Preferences(["simple"], ["general"], engines, self.storage)
|
|
self.pref.parse_dict({"locale": "en"})
|
|
|
|
def test_init(self):
|
|
|
|
self.assertEqual(2, len(self.storage))
|
|
|
|
def test_hooks(self):
|
|
|
|
with self.app.test_request_context():
|
|
sxng_request.preferences = self.pref
|
|
query = ""
|
|
|
|
ret = do_pre_search(query, self.storage, pageno=1)
|
|
self.assertTrue(ret is True)
|
|
|
|
ret = self.storage.on_result(
|
|
sxng_request,
|
|
get_search_mock("lorem ipsum", user_plugins=["plg001", "plg002"]),
|
|
Result(),
|
|
)
|
|
self.assertFalse(ret)
|