searx.botdetection._helpers Namespace Reference

Functions
	dump_request (flask.Request request)
werkzeug.Response|None	too_many_requests (IPv4Network|IPv6Network network, str log_msg)
IPv4Network|IPv6Network	get_network (IPv4Address|IPv6Address real_ip, config.Config cfg)
	log_error_only_once (str err_msg)

Variables
list	__all__ = ["log_error_only_once", "dump_request", "get_network", "logger", "too_many_requests"]
	logger = logger.getChild('botdetection')
list	_logged_errors = []

Function Documentation

dump_request()

searx.botdetection._helpers.dump_request

(

flask.Request

request

)

Definition at line 26 of file _helpers.py.

def dump_request(request: flask.Request):
    return (
        request.path
        + " || X-Forwarded-For: %s" % request.headers.get('X-Forwarded-For')
        + " || X-Real-IP: %s" % request.headers.get('X-Real-IP')
        + " || form: %s" % request.form
        + " || Accept: %s" % request.headers.get('Accept')
        + " || Accept-Language: %s" % request.headers.get('Accept-Language')
        + " || Accept-Encoding: %s" % request.headers.get('Accept-Encoding')
        + " || Content-Type: %s" % request.headers.get('Content-Type')
        + " || Content-Length: %s" % request.headers.get('Content-Length')
        + " || Connection: %s" % request.headers.get('Connection')
        + " || User-Agent: %s" % request.headers.get('User-Agent')
        + " || Sec-Fetch-Site: %s" % request.headers.get('Sec-Fetch-Site')
        + " || Sec-Fetch-Mode: %s" % request.headers.get('Sec-Fetch-Mode')
        + " || Sec-Fetch-Dest: %s" % request.headers.get('Sec-Fetch-Dest')
    )
 
 

get_network()

IPv4Network | IPv6Network searx.botdetection._helpers.get_network	(	IPv4Address | IPv6Address	real_ip,
		config.Config	cfg )

Returns the (client) network of whether the ``real_ip`` is part of.

The ``ipv4_prefix`` and ``ipv6_prefix`` define the number of leading bits in
an address that are compared to determine whether or not an address is part
of a (client) network.

.. code:: toml

   [botdetection]

   ipv4_prefix = 32
   ipv6_prefix = 48

Definition at line 56 of file _helpers.py.

def get_network(real_ip: IPv4Address | IPv6Address, cfg: config.Config) -> IPv4Network | IPv6Network:
    """Returns the (client) network of whether the ``real_ip`` is part of.
 
    The ``ipv4_prefix`` and ``ipv6_prefix`` define the number of leading bits in
    an address that are compared to determine whether or not an address is part
    of a (client) network.
 
    .. code:: toml
 
       [botdetection]
 
       ipv4_prefix = 32
       ipv6_prefix = 48
 
    """
 
    prefix: int = cfg["botdetection.ipv4_prefix"]
    if real_ip.version == 6:
        prefix: int = cfg["botdetection.ipv6_prefix"]
    network = ip_network(f"{real_ip}/{prefix}", strict=False)
    # logger.debug("get_network(): %s", network.compressed)
    return network
 
 

log_error_only_once()

searx.botdetection._helpers.log_error_only_once

(

str

err_msg

)

Definition at line 83 of file _helpers.py.

def log_error_only_once(err_msg: str):
    if err_msg not in _logged_errors:
        logger.error(err_msg)
        _logged_errors.append(err_msg)

too_many_requests()

werkzeug.Response | None searx.botdetection._helpers.too_many_requests	(	IPv4Network | IPv6Network	network,
		str	log_msg )

Returns a HTTP 429 response object and writes a ERROR message to the
'botdetection' logger.  This function is used in part by the filter methods
to return the default ``Too Many Requests`` response.

Definition at line 45 of file _helpers.py.

def too_many_requests(network: IPv4Network | IPv6Network, log_msg: str) -> werkzeug.Response | None:
    """Returns a HTTP 429 response object and writes a ERROR message to the
    'botdetection' logger.  This function is used in part by the filter methods
    to return the default ``Too Many Requests`` response.
 
    """
 
    logger.debug("BLOCK %s: %s", network.compressed, log_msg)
    return flask.make_response(('Too Many Requests', 429))
 
 

Variable Documentation

__all__

list searx.botdetection._helpers.__all__ = ["log_error_only_once", "dump_request", "get_network", "logger", "too_many_requests"]

private

Definition at line 6 of file _helpers.py.

_logged_errors

list searx.botdetection._helpers._logged_errors = []

protected

Definition at line 80 of file _helpers.py.

logger

searx.botdetection._helpers.logger = logger.getChild('botdetection')

Definition at line 23 of file _helpers.py.