.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
searx.favicons.resolvers Namespace Reference

Functions

 _req_args (**kwargs)
tuple[None|bytes, None|str] allesedv (str domain, int timeout)
tuple[None|bytes, None|str] duckduckgo (str domain, int timeout)
tuple[None|bytes, None|str] google (str domain, int timeout)
tuple[None|bytes, None|str] yandex (str domain, int timeout)

Variables

list __all__ = ["DEFAULT_RESOLVER_MAP", "allesedv", "duckduckgo", "google", "yandex"]
dict DEFAULT_RESOLVER_MAP [str, Callable]
 logger = logger.getChild('favicons.resolvers')

Detailed Description

Implementations of the favicon *resolvers* that are available in the favicon
proxy by default.  A *resolver* is a function that obtains the favicon from an
external source.  The *resolver* function receives two arguments (``domain,
timeout``) and returns a tuple ``(data, mime)``.

Function Documentation

◆ _req_args()

searx.favicons.resolvers._req_args ( ** kwargs)
protected

Definition at line 20 of file resolvers.py.

20def _req_args(**kwargs):
21 # add the request arguments from the searx.network
22 d = {"raise_for_httperror": False}
23 d.update(kwargs)
24 return d
25
26

Referenced by allesedv(), duckduckgo(), google(), and yandex().

Here is the caller graph for this function:

◆ allesedv()

tuple[None | bytes, None | str] searx.favicons.resolvers.allesedv ( str domain,
int timeout )
Favicon Resolver from allesedv.com / https://favicon.allesedv.com/

Definition at line 27 of file resolvers.py.

27def allesedv(domain: str, timeout: int) -> tuple[None | bytes, None | str]:
28 """Favicon Resolver from allesedv.com / https://favicon.allesedv.com/"""
29 data, mime = (None, None)
30 url = f"https://f1.allesedv.com/32/{domain}"
31 logger.debug("fetch favicon from: %s", url)
32
33 # will just return a 200 regardless of the favicon existing or not
34 # sometimes will be correct size, sometimes not
35 response = network.get(url, **_req_args(timeout=timeout))
36 if response and response.status_code == 200:
37 mime = response.headers['Content-Type']
38 if mime != 'image/gif':
39 data = response.content
40 return data, mime
41
42

References _req_args().

Here is the call graph for this function:

◆ duckduckgo()

tuple[None | bytes, None | str] searx.favicons.resolvers.duckduckgo ( str domain,
int timeout )
Favicon Resolver from duckduckgo.com / https://blog.jim-nielsen.com/2021/displaying-favicons-for-any-domain/

Definition at line 43 of file resolvers.py.

43def duckduckgo(domain: str, timeout: int) -> tuple[None | bytes, None | str]:
44 """Favicon Resolver from duckduckgo.com / https://blog.jim-nielsen.com/2021/displaying-favicons-for-any-domain/"""
45 data, mime = (None, None)
46 url = f"https://icons.duckduckgo.com/ip2/{domain}.ico"
47 logger.debug("fetch favicon from: %s", url)
48
49 # will return a 404 if the favicon does not exist and a 200 if it does,
50 response = network.get(url, **_req_args(timeout=timeout))
51 if response and response.status_code == 200:
52 # api will respond with a 32x32 png image
53 mime = response.headers['Content-Type']
54 data = response.content
55 return data, mime
56
57

References _req_args().

Here is the call graph for this function:

◆ google()

tuple[None | bytes, None | str] searx.favicons.resolvers.google ( str domain,
int timeout )
Favicon Resolver from google.com

Definition at line 58 of file resolvers.py.

58def google(domain: str, timeout: int) -> tuple[None | bytes, None | str]:
59 """Favicon Resolver from google.com"""
60 data, mime = (None, None)
61
62 # URL https://www.google.com/s2/favicons?sz=32&domain={domain}" will be
63 # redirected (HTTP 301 Moved Permanently) to t1.gstatic.com/faviconV2:
64 url = (
65 f"https://t1.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&fallback_opts=TYPE,SIZE,URL"
66 f"&url=https://{domain}&size=32"
67 )
68 logger.debug("fetch favicon from: %s", url)
69
70 # will return a 404 if the favicon does not exist and a 200 if it does,
71 response = network.get(url, **_req_args(timeout=timeout))
72 if response and response.status_code == 200:
73 # api will respond with a 32x32 png image
74 mime = response.headers['Content-Type']
75 data = response.content
76 return data, mime
77
78

References _req_args().

Here is the call graph for this function:

◆ yandex()

tuple[None | bytes, None | str] searx.favicons.resolvers.yandex ( str domain,
int timeout )
Favicon Resolver from yandex.com

Definition at line 79 of file resolvers.py.

79def yandex(domain: str, timeout: int) -> tuple[None | bytes, None | str]:
80 """Favicon Resolver from yandex.com"""
81 data, mime = (None, None)
82 url = f"https://favicon.yandex.net/favicon/{domain}"
83 logger.debug("fetch favicon from: %s", url)
84
85 # api will respond with a 16x16 png image, if it doesn't exist, it will be a
86 # 1x1 png image (70 bytes)
87 response = network.get(url, **_req_args(timeout=timeout))
88 if response and response.status_code == 200 and len(response.content) > 70:
89 mime = response.headers['Content-Type']
90 data = response.content
91 return data, mime
92
93

References _req_args().

Here is the call graph for this function:

Variable Documentation

◆ __all__

list searx.favicons.resolvers.__all__ = ["DEFAULT_RESOLVER_MAP", "allesedv", "duckduckgo", "google", "yandex"]
private

Definition at line 10 of file resolvers.py.

◆ DEFAULT_RESOLVER_MAP

dict searx.favicons.resolvers.DEFAULT_RESOLVER_MAP [str, Callable]

Definition at line 16 of file resolvers.py.

◆ logger

searx.favicons.resolvers.logger = logger.getChild('favicons.resolvers')

Definition at line 17 of file resolvers.py.