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>
70 lines
2.5 KiB
Python
70 lines
2.5 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
|
|
|
|
from parameterized.parameterized import parameterized
|
|
|
|
import searx.plugins
|
|
import searx.preferences
|
|
|
|
from searx.extended_types import sxng_request
|
|
from searx.result_types import Answer
|
|
|
|
from tests import SearxTestCase
|
|
from .test_plugins import do_post_search
|
|
|
|
query_res = [
|
|
("md5 test", "md5 hash digest: 098f6bcd4621d373cade4e832627b4f6"),
|
|
("sha1 test", "sha1 hash digest: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"),
|
|
("sha224 test", "sha224 hash digest: 90a3ed9e32b2aaf4c61c410eb925426119e1a9dc53d4286ade99a809"),
|
|
("sha256 test", "sha256 hash digest: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"),
|
|
(
|
|
"sha384 test",
|
|
"sha384 hash digest: 768412320f7b0aa5812fce428dc4706b3c"
|
|
"ae50e02a64caa16a782249bfe8efc4b7ef1ccb126255d196047dfedf1"
|
|
"7a0a9",
|
|
),
|
|
(
|
|
"sha512 test",
|
|
"sha512 hash digest: ee26b0dd4af7e749aa1a8ee3c10ae9923f6"
|
|
"18980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5"
|
|
"fa9ad8e6f57f50028a8ff",
|
|
),
|
|
]
|
|
|
|
|
|
class PluginHashTest(SearxTestCase):
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
engines = {}
|
|
|
|
self.storage = searx.plugins.PluginStorage()
|
|
self.storage.load_settings({"searx.plugins.hash_plugin.SXNGPlugin": {"active": True}})
|
|
self.storage.init(self.app)
|
|
self.pref = searx.preferences.Preferences(["simple"], ["general"], engines, self.storage)
|
|
self.pref.parse_dict({"locale": "en"})
|
|
|
|
def test_plugin_store_init(self):
|
|
self.assertEqual(1, len(self.storage))
|
|
|
|
@parameterized.expand(query_res)
|
|
def test_hash_digest_new(self, query: str, res: str):
|
|
with self.app.test_request_context():
|
|
sxng_request.preferences = self.pref
|
|
answer = Answer(answer=res)
|
|
|
|
search = do_post_search(query, self.storage)
|
|
self.assertIn(answer, search.result_container.answers)
|
|
|
|
def test_pageno_1_2(self):
|
|
with self.app.test_request_context():
|
|
sxng_request.preferences = self.pref
|
|
query, res = query_res[0]
|
|
answer = Answer(answer=res)
|
|
|
|
search = do_post_search(query, self.storage, pageno=1)
|
|
self.assertIn(answer, search.result_container.answers)
|
|
|
|
search = do_post_search(query, self.storage, pageno=2)
|
|
self.assertEqual(list(search.result_container.answers), [])
|