Functions
	_load_regular_expressions (settings_key)

	_matches_parsed_url (result, pattern)

	on_result (_request, _search, result)

Variables
	name = gettext('Hostnames plugin')

	description = gettext('Rewrite hostnames, remove results or prioritize them based on the hostname')

bool	default_on = False

str	preference_section = 'general'

str	plugin_id = 'hostnames'

	logger = logger.getChild(plugin_id)

str	parsed = 'parsed_url'

list	_url_fields = ['iframe_src', 'audio_src']

	replacements = _load_regular_expressions('replace')

	removables = _load_regular_expressions('remove')

	high_priority = _load_regular_expressions('high_priority')

	low_priority = _load_regular_expressions('low_priority')

Detailed Description

.. attention::

    The **"Hostname replace"** plugin has been replace by **"Hostnames
    plugin"**, see :pull:`3463` & :pull:`3552`.

The **Hostnames plugin** can be enabled by adding it to the
``enabled_plugins`` **list** in the ``setting.yml`` like so.

  .. code:: yaml

     enabled_plugins:
       - 'Hostnames plugin'
       ...

- ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be
  replaced by other hostnames.

  .. code:: yaml

     hostnames:
       replace:
         '(.*\\.)?youtube\\.com$': 'invidious.example.com'
         '(.*\\.)?youtu\\.be$': 'invidious.example.com'
         ...

- ``hostnames.remove``: A **list** of regular expressions of the hostnames whose
  results should be taken from the results list.

  .. code:: yaml

     hostnames:
       remove:
         - '(.*\\.)?facebook.com$'
         - ...

- ``hostnames.high_priority``: A **list** of regular expressions for hostnames
  whose result should be given higher priority. The results from these hosts are
  arranged higher in the results list.

  .. code:: yaml

     hostnames:
       high_priority:
         - '(.*\\.)?wikipedia.org$'
         - ...

- ``hostnames.lower_priority``: A **list** of regular expressions for hostnames
  whose result should be given lower priority. The results from these hosts are
  arranged lower in the results list.

  .. code:: yaml

     hostnames:
       low_priority:
         - '(.*\\.)?google(\\..*)?$'
         - ...

If the URL matches the pattern of ``high_priority`` AND ``low_priority``, the
higher priority wins over the lower priority.

Alternatively, you can also specify a file name for the **mappings** or
**lists** to load these from an external file:

.. code:: yaml

   hostnames:
     replace: 'rewrite-hosts.yml'
     remove:
       - '(.*\\.)?facebook.com$'
       - ...
     low_priority:
       - '(.*\\.)?google(\\..*)?$'
       - ...
     high_priority:
       - '(.*\\.)?wikipedia.org$'
       - ...

The ``rewrite-hosts.yml`` from the example above must be in the folder in which
the ``settings.yml`` file is already located (``/etc/searxng``). The file then
only contains the lists or the mapping tables without further information on the
namespaces.  In the example above, this would be a mapping table that looks
something like this:

.. code:: yaml

   '(.*\\.)?youtube\\.com$': 'invidious.example.com'
   '(.*\\.)?youtu\\.be$': 'invidious.example.com'

Function Documentation

◆ _load_regular_expressions()

searx.plugins.hostnames._load_regular_expressions ( settings_key )

protected

Definition at line 115 of file hostnames.py.

def _load_regular_expressions(settings_key):
    setting_value = settings.get(plugin_id, {}).get(settings_key)
 
    if not setting_value:
        return {}
 
    # load external file with configuration
    if isinstance(setting_value, str):
        setting_value = get_yaml_cfg(setting_value)
 
    if isinstance(setting_value, list):
        return {re.compile(r) for r in setting_value}
 
    if isinstance(setting_value, dict):
        return {re.compile(p): r for (p, r) in setting_value.items()}
 
    return {}
 
 

◆ _matches_parsed_url()

searx.plugins.hostnames._matches_parsed_url	(		result,
			pattern )

protected

Definition at line 140 of file hostnames.py.

def _matches_parsed_url(result, pattern):
    return parsed in result and pattern.search(result[parsed].netloc)

Referenced by searx.plugins.hostnames.on_result().

Here is the caller graph for this function:

◆ on_result()

searx.plugins.hostnames.on_result	(	_request,
		_search,
		result )

Definition at line 144 of file hostnames.py.

def on_result(_request, _search, result):
    for pattern, replacement in replacements.items():
        if _matches_parsed_url(result, pattern):
            # logger.debug(result['url'])
            result[parsed] = result[parsed]._replace(netloc=pattern.sub(replacement, result[parsed].netloc))
            result['url'] = urlunparse(result[parsed])
            # logger.debug(result['url'])
 
        for url_field in _url_fields:
            if not result.get(url_field):
                continue
 
            url_src = urlparse(result[url_field])
            if pattern.search(url_src.netloc):
                url_src = url_src._replace(netloc=pattern.sub(replacement, url_src.netloc))
                result[url_field] = urlunparse(url_src)
 
    for pattern in removables:
        if _matches_parsed_url(result, pattern):
            return False
 
        for url_field in _url_fields:
            if not result.get(url_field):
                continue
 
            url_src = urlparse(result[url_field])
            if pattern.search(url_src.netloc):
                del result[url_field]
 
    for pattern in low_priority:
        if _matches_parsed_url(result, pattern):
            result['priority'] = 'low'
 
    for pattern in high_priority:
        if _matches_parsed_url(result, pattern):
            result['priority'] = 'high'
 
    return True

References searx.plugins.hostnames._matches_parsed_url().

Here is the call graph for this function:

Variable Documentation

◆ _url_fields

list searx.plugins.hostnames._url_fields = ['iframe_src', 'audio_src']

protected

Definition at line 112 of file hostnames.py.

◆ default_on

bool searx.plugins.hostnames.default_on = False

Definition at line 105 of file hostnames.py.

◆ description

searx.plugins.hostnames.description = gettext('Rewrite hostnames, remove results or prioritize them based on the hostname')

Definition at line 104 of file hostnames.py.

◆ high_priority

searx.plugins.hostnames.high_priority = _load_regular_expressions('high_priority')

Definition at line 136 of file hostnames.py.

◆ logger

searx.plugins.hostnames.logger = logger.getChild(plugin_id)

Definition at line 110 of file hostnames.py.

◆ low_priority

searx.plugins.hostnames.low_priority = _load_regular_expressions('low_priority')

Definition at line 137 of file hostnames.py.

◆ name

searx.plugins.hostnames.name = gettext('Hostnames plugin')

Definition at line 103 of file hostnames.py.

◆ parsed

str searx.plugins.hostnames.parsed = 'parsed_url'

Definition at line 111 of file hostnames.py.

◆ plugin_id

str searx.plugins.hostnames.plugin_id = 'hostnames'

Definition at line 108 of file hostnames.py.

◆ preference_section

str searx.plugins.hostnames.preference_section = 'general'

Definition at line 106 of file hostnames.py.

◆ removables

searx.plugins.hostnames.removables = _load_regular_expressions('remove')

Definition at line 135 of file hostnames.py.

◆ replacements

searx.plugins.hostnames.replacements = _load_regular_expressions('replace')

Definition at line 134 of file hostnames.py.

Functions

Variables

Detailed Description

Function Documentation

◆ _load_regular_expressions()

◆ _matches_parsed_url()

◆ on_result()

Variable Documentation

◆ _url_fields

◆ default_on

◆ description

◆ high_priority

◆ logger

◆ low_priority

◆ name

◆ parsed

◆ plugin_id

◆ preference_section

◆ removables

◆ replacements