searx.favicons.proxy Namespace Reference

Classes
class	FaviconProxyConfig

Functions
	init (FaviconProxyConfig cfg)
	_initial_resolver_map ()
	favicon_proxy ()
tuple[None|bytes, None|str]	search_favicon (str resolver, str authority)
str	favicon_url (str authority)

Variables
dict	DEFAULT_FAVICON_URL = {}
FaviconProxyConfig	CFG = None

Detailed Description

Implementations for a favicon proxy

Function Documentation

_initial_resolver_map()

searx.favicons.proxy._initial_resolver_map ( )

protected

Definition at line 35 of file proxy.py.

def _initial_resolver_map():
    d = {}
    name: str = get_setting("search.favicon_resolver", None)  # type: ignore
    if name:
        func = DEFAULT_RESOLVER_MAP.get(name)
        if func:
            d = {name: f"searx.favicons.resolvers.{func.__name__}"}
    return d
 
 

References searx.get_setting().

Here is the call graph for this function:

favicon_proxy()

searx.favicons.proxy.favicon_proxy

(

)

REST API of SearXNG's favicon proxy service

::

    /favicon_proxy?authority=<...>&h=<...>

``authority``:
  Domain name :rfc:`3986` / see :py:obj:`favicon_url`

``h``:
  HMAC :rfc:`2104`, build up from the :ref:`server.secret_key <settings
  server>` setting.

Definition at line 113 of file proxy.py.

def favicon_proxy():
    """REST API of SearXNG's favicon proxy service
 
    ::
 
        /favicon_proxy?authority=<...>&h=<...>
 
    ``authority``:
      Domain name :rfc:`3986` / see :py:obj:`favicon_url`
 
    ``h``:
      HMAC :rfc:`2104`, build up from the :ref:`server.secret_key <settings
      server>` setting.
 
    """
    authority = sxng_request.args.get('authority')
 
    # malformed request or RFC 3986 authority
    if not authority or "/" in authority:
        return '', 400
 
    # malformed request / does not have authorisation
    if not is_hmac_of(
        CFG.secret_key,
        authority.encode(),
        sxng_request.args.get('h', ''),
    ):
        return '', 400
 
    resolver = sxng_request.preferences.get_value('favicon_resolver')  # type: ignore
    # if resolver is empty or not valid, just return HTTP 400.
    if not resolver or resolver not in CFG.resolver_map.keys():
        return "", 400
 
    data, mime = search_favicon(resolver, authority)
 
    if data is not None and mime is not None:
        resp = flask.Response(data, mimetype=mime)  # type: ignore
        resp.headers['Cache-Control'] = f"max-age={CFG.max_age}"
        return resp
 
    # return default favicon from static path
    theme = sxng_request.preferences.get_value("theme")  # type: ignore
    fav, mimetype = CFG.favicon(theme=theme)
    return flask.send_from_directory(fav.parent, fav.name, mimetype=mimetype)
 
 

References search_favicon().

Here is the call graph for this function:

favicon_url()

str searx.favicons.proxy.favicon_url

(

str

authority

)

Function to generate the image URL used for favicons in SearXNG's result
lists.  The ``authority`` argument (aka netloc / :rfc:`3986`) is usually a
(sub-) domain name.  This function is used in the HTML (jinja) templates.

.. code:: html

   <div class="favicon">
      <img src="{{ favicon_url(result.parsed_url.netloc) }}">
   </div>

The returned URL is a route to :py:obj:`favicon_proxy` REST API.

If the favicon is already in the cache, the returned URL is a `data URL`_
(something like ``data:image/png;base64,...``).  By generating a data url from
the :py:obj:`.cache.FaviconCache`, additional HTTP roundtripps via the
:py:obj:`favicon_proxy` are saved.  However, it must also be borne in mind
that data urls are not cached in the client (web browser).

.. _data URL: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs

Definition at line 196 of file proxy.py.

def favicon_url(authority: str) -> str:
    """Function to generate the image URL used for favicons in SearXNG's result
    lists.  The ``authority`` argument (aka netloc / :rfc:`3986`) is usually a
    (sub-) domain name.  This function is used in the HTML (jinja) templates.
 
    .. code:: html
 
       <div class="favicon">
          <img src="{{ favicon_url(result.parsed_url.netloc) }}">
       </div>
 
    The returned URL is a route to :py:obj:`favicon_proxy` REST API.
 
    If the favicon is already in the cache, the returned URL is a `data URL`_
    (something like ``data:image/png;base64,...``).  By generating a data url from
    the :py:obj:`.cache.FaviconCache`, additional HTTP roundtripps via the
    :py:obj:`favicon_proxy` are saved.  However, it must also be borne in mind
    that data urls are not cached in the client (web browser).
 
    .. _data URL: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
 
    """
 
    resolver = sxng_request.preferences.get_value('favicon_resolver')  # type: ignore
    # if resolver is empty or not valid, just return nothing.
    if not resolver or resolver not in CFG.resolver_map.keys():
        return ""
 
    data_mime = cache.CACHE(resolver, authority)
 
    if data_mime == (None, None):
        # we have already checked, the resolver does not have a favicon
        theme = sxng_request.preferences.get_value("theme")  # type: ignore
        return CFG.favicon_data_url(theme=theme)
 
    if data_mime is not None:
        data, mime = data_mime
        return f"data:{mime};base64,{str(base64.b64encode(data), 'utf-8')}"  # type: ignore
 
    h = new_hmac(CFG.secret_key, authority.encode())
    proxy_url = flask.url_for('favicon_proxy')
    query = urllib.parse.urlencode({"authority": authority, "h": h})
    return f"{proxy_url}?{query}"

init()

searx.favicons.proxy.init

(

FaviconProxyConfig

cfg

)

Definition at line 30 of file proxy.py.

def init(cfg: FaviconProxyConfig):
    global CFG  # pylint: disable=global-statement
    CFG = cfg
 
 

search_favicon()

tuple[None | bytes, None | str] searx.favicons.proxy.search_favicon	(	str	resolver,
		str	authority )

Sends the request to the favicon resolver and returns a tuple for the
favicon.  The tuple consists of ``(data, mime)``, if the resolver has not
determined a favicon, both values are ``None``.

``data``:
  Binary data of the favicon.

``mime``:
  Mime type of the favicon.

Definition at line 160 of file proxy.py.

def search_favicon(resolver: str, authority: str) -> tuple[None | bytes, None | str]:
    """Sends the request to the favicon resolver and returns a tuple for the
    favicon.  The tuple consists of ``(data, mime)``, if the resolver has not
    determined a favicon, both values are ``None``.
 
    ``data``:
      Binary data of the favicon.
 
    ``mime``:
      Mime type of the favicon.
 
    """
 
    data, mime = (None, None)
 
    func = CFG.get_resolver(resolver)
    if func is None:
        return data, mime
 
    # to avoid superfluous requests to the resolver, first look in the cache
    data_mime = cache.CACHE(resolver, authority)
    if data_mime is not None:
        return data_mime
 
    try:
        data, mime = func(authority, timeout=CFG.resolver_timeout)
        if data is None or mime is None:
            data, mime = (None, None)
 
    except (HTTPError, SearxEngineResponseException):
        pass
 
    cache.CACHE.set(resolver, authority, mime, data)
    return data, mime
 
 

Referenced by favicon_proxy().

Here is the caller graph for this function:

Variable Documentation

CFG

FaviconProxyConfig searx.favicons.proxy.CFG = None

Definition at line 27 of file proxy.py.

DEFAULT_FAVICON_URL

dict searx.favicons.proxy.DEFAULT_FAVICON_URL = {}

Definition at line 26 of file proxy.py.