From dcf95644c6ba7308f521ca14dbed79127404af7f Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 7 Jun 2024 15:38:09 +0200 Subject: [PATCH] [breaking change] drop deprecated hostname_replace plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The successor is “hostname plugin” from PR: - https://github.com/searxng/searxng/pull/3463 --- Revert "[refactor] hostnames plugin: add fallback for old hostname_replace plugin" This reverts commit f5eb56b63f250c7804e5e1cf4426e550bc933906. Signed-off-by: Markus Heiser --- searx/plugins/hostname_replace.py | 35 ------------------------------- searx/plugins/hostnames.py | 35 ++----------------------------- 2 files changed, 2 insertions(+), 68 deletions(-) delete mode 100644 searx/plugins/hostname_replace.py diff --git a/searx/plugins/hostname_replace.py b/searx/plugins/hostname_replace.py deleted file mode 100644 index 48900a3f9..000000000 --- a/searx/plugins/hostname_replace.py +++ /dev/null @@ -1,35 +0,0 @@ -# SPDX-License-Identifier: AGPL-3.0-or-later -# pylint: disable=missing-module-docstring - -from flask_babel import gettext -from searx.plugins import logger - -name = gettext('Hostname replace') -description = "Deprecated / contact system admin to configure 'Hostnames plugin'!!" -default_on = False -preference_section = 'general' - -plugin_id = 'hostname_replace' -logger = logger.getChild(plugin_id) - -REPORTED = False - - -def deprecated_msg(): - global REPORTED # pylint: disable=global-statement - if REPORTED: - return - logger.error( - "'Hostname replace' plugin is deprecated and will be dropped soon!" - " Configure 'Hostnames plugin':" - " https://docs.searxng.org/src/searx.plugins.hostnames.html" - ) - REPORTED = True - - -def on_result(_request, _search, result): - # pylint: disable=import-outside-toplevel, cyclic-import - from searx.plugins.hostnames import on_result as hostnames_on_result - - deprecated_msg() - return hostnames_on_result(_request, _search, result) diff --git a/searx/plugins/hostnames.py b/searx/plugins/hostnames.py index 2783f23eb..770b00e15 100644 --- a/searx/plugins/hostnames.py +++ b/searx/plugins/hostnames.py @@ -3,16 +3,6 @@ """In addition to rewriting/replace reslut URLs, the *hoostnames* plugin offers other features. -.. attention:: - - The 'Hostnames plugin' from `PR-3463 - `_ is a rewrite of the - 'Hostname replace' plugin. Backwards compatibility is guaranteed for a - transitional period, but this will end soon. - - **To maintainers of SearXNG instances, please modify your old plugin config - to the new.** - - ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be replaced by other hostnames. @@ -129,29 +119,8 @@ def _load_regular_expressions(settings_key): return {} -# compatibility fallback for old hostname replace plugin -# TODO: remove in the future once most/all instance maintainers finished migrating # pylint: disable=fixme -def _load_regular_expressions_with_fallback(settings_key): - expressions = _load_regular_expressions(settings_key) - if expressions: - return expressions - - # fallback to the old `hostname_replace` settings format - # pylint: disable=import-outside-toplevel, cyclic-import - hostname_replace_config = settings.get('hostname_replace', {}) - if hostname_replace_config: - from searx.plugins.hostname_replace import deprecated_msg - - deprecated_msg() - - if settings_key == 'replace': - return {re.compile(p): r for (p, r) in hostname_replace_config.items() if r} - - return {re.compile(p) for (p, r) in hostname_replace_config.items() if not r} - - -replacements = _load_regular_expressions_with_fallback('replace') -removables = _load_regular_expressions_with_fallback('remove') +replacements = _load_regular_expressions('replace') +removables = _load_regular_expressions('remove') high_priority = _load_regular_expressions('high_priority') low_priority = _load_regular_expressions('low_priority')