mirror of
https://github.com/searxng/searxng.git
synced 2026-09-11 16:56:05 +00:00
[mod] network: migrate to curl_cffi
This commit is contained in:
@@ -58,10 +58,9 @@ engine is shown. Most of the options have a default value or even are optional.
|
|||||||
|
|
||||||
# overwrite values from section 'outgoing:'
|
# overwrite values from section 'outgoing:'
|
||||||
enable_http2: false
|
enable_http2: false
|
||||||
|
enable_http3: false
|
||||||
retries: 1
|
retries: 1
|
||||||
max_connections: 100
|
max_connections: 100
|
||||||
max_keepalive_connections: 10
|
|
||||||
keepalive_expiry: 5.0
|
|
||||||
using_tor_proxy: false
|
using_tor_proxy: false
|
||||||
proxies:
|
proxies:
|
||||||
http:
|
http:
|
||||||
@@ -163,6 +162,16 @@ engine is shown. Most of the options have a default value or even are optional.
|
|||||||
``enable_http`` : optional
|
``enable_http`` : optional
|
||||||
Enable HTTP for this engine (by default only HTTPS is enabled).
|
Enable HTTP for this engine (by default only HTTPS is enabled).
|
||||||
|
|
||||||
|
``enable_http3`` : optional
|
||||||
|
Use HTTP/3 (falls back to HTTP/2). Default ``false``.
|
||||||
|
Ignored when a proxy is set.
|
||||||
|
|
||||||
|
.. hint::
|
||||||
|
|
||||||
|
HTTP/3 places demands on the IP infrastructure that are not met in every
|
||||||
|
environment. Enable this option only if you are aware of these requirements
|
||||||
|
and the extent to which they are met.
|
||||||
|
|
||||||
``retry_on_http_error`` : optional
|
``retry_on_http_error`` : optional
|
||||||
Retry request on some HTTP status code.
|
Retry request on some HTTP status code.
|
||||||
|
|
||||||
@@ -179,20 +188,12 @@ engine is shown. Most of the options have a default value or even are optional.
|
|||||||
Using tor proxy (``true``) or not (``false``) for this engine. The default is
|
Using tor proxy (``true``) or not (``false``) for this engine. The default is
|
||||||
taken from ``using_tor_proxy`` of the :ref:`settings outgoing`.
|
taken from ``using_tor_proxy`` of the :ref:`settings outgoing`.
|
||||||
|
|
||||||
.. _Pool limit configuration: https://www.python-httpx.org/advanced/#pool-limit-configuration
|
.. _Pool limit configuration: https://curl-cffi.readthedocs.io/en/latest/api.html#sessions
|
||||||
|
|
||||||
``max_keepalive_connection#s`` :
|
|
||||||
`Pool limit configuration`_, overwrites value ``pool_maxsize`` from
|
|
||||||
:ref:`settings outgoing` for this engine.
|
|
||||||
|
|
||||||
``max_connections`` :
|
``max_connections`` :
|
||||||
`Pool limit configuration`_, overwrites value ``pool_connections`` from
|
`Pool limit configuration`_, overwrites value ``pool_connections`` from
|
||||||
:ref:`settings outgoing` for this engine.
|
:ref:`settings outgoing` for this engine.
|
||||||
|
|
||||||
``keepalive_expiry`` :
|
|
||||||
`Pool limit configuration`_, overwrites value ``keepalive_expiry`` from
|
|
||||||
:ref:`settings outgoing` for this engine.
|
|
||||||
|
|
||||||
|
|
||||||
.. _private engines:
|
.. _private engines:
|
||||||
|
|
||||||
|
|||||||
@@ -12,20 +12,12 @@ Communication with search engines.
|
|||||||
request_timeout: 2.0 # default timeout in seconds, can be override by engine
|
request_timeout: 2.0 # default timeout in seconds, can be override by engine
|
||||||
max_request_timeout: 10.0 # the maximum timeout in seconds
|
max_request_timeout: 10.0 # the maximum timeout in seconds
|
||||||
useragent_suffix: "" # information like an email address to the administrator
|
useragent_suffix: "" # information like an email address to the administrator
|
||||||
pool_connections: 100 # Maximum number of allowable connections, or null
|
pool_connections: 100 # Maximum number of concurrent connections (default: 100)
|
||||||
# for no limits. The default is 100.
|
enable_http2: true # Enables the use of HTTP2
|
||||||
pool_maxsize: 10 # Number of allowable keep-alive connections, or null
|
|
||||||
# to always allow. The default is 10.
|
|
||||||
enable_http2: true # See https://www.python-httpx.org/http2/
|
|
||||||
# uncomment below section if you want to use a custom server certificate
|
# uncomment below section if you want to use a custom server certificate
|
||||||
# see https://www.python-httpx.org/advanced/#changing-the-verification-defaults
|
|
||||||
# and https://www.python-httpx.org/compatibility/#ssl-configuration
|
|
||||||
# verify: ~/.mitmproxy/mitmproxy-ca-cert.cer
|
# verify: ~/.mitmproxy/mitmproxy-ca-cert.cer
|
||||||
#
|
#
|
||||||
# uncomment below section if you want to use a proxyq see: SOCKS proxies
|
# uncomment below section if you want to use a proxy
|
||||||
# https://2.python-requests.org/en/latest/user/advanced/#proxies
|
|
||||||
# are also supported: see
|
|
||||||
# https://2.python-requests.org/en/latest/user/advanced/#socks
|
|
||||||
#
|
#
|
||||||
# proxies:
|
# proxies:
|
||||||
# all://:
|
# all://:
|
||||||
@@ -46,30 +38,26 @@ Communication with search engines.
|
|||||||
timeout to load). Can be override by ``timeout`` in the :ref:`settings engines`.
|
timeout to load). Can be override by ``timeout`` in the :ref:`settings engines`.
|
||||||
|
|
||||||
``useragent_suffix`` :
|
``useragent_suffix`` :
|
||||||
Suffix to the user-agent SearXNG uses to send requests to others engines. If an
|
Suffix to add when an engine's User-Agent is set via searxng_useragent().
|
||||||
engine wish to block you, a contact info here may be useful to avoid that.
|
Contact info here may be useful to avoid an engine blocking you.
|
||||||
|
|
||||||
.. _Pool limit configuration: https://www.python-httpx.org/advanced/#pool-limit-configuration
|
.. _Pool limit configuration: https://curl-cffi.readthedocs.io/en/latest/api.html#sessions
|
||||||
|
|
||||||
``pool_maxsize``:
|
|
||||||
Number of allowable keep-alive connections, or ``null`` to always allow. The
|
|
||||||
default is 10. See ``max_keepalive_connections`` `Pool limit configuration`_.
|
|
||||||
|
|
||||||
``pool_connections`` :
|
``pool_connections`` :
|
||||||
Maximum number of allowable connections, or ``null`` # for no limits. The
|
Maximum number of concurrent connections. The default is 100.
|
||||||
default is 100. See ``max_connections`` `Pool limit configuration`_.
|
See ``max_clients`` `Pool limit configuration`_.
|
||||||
|
|
||||||
``keepalive_expiry`` :
|
.. _curl_cffi proxies: https://curl-cffi.readthedocs.io/en/latest/quick_start.html
|
||||||
Number of seconds to keep a connection in the pool. By default 5.0 seconds.
|
|
||||||
See ``keepalive_expiry`` `Pool limit configuration`_.
|
|
||||||
|
|
||||||
.. _httpx proxies: https://www.python-httpx.org/advanced/#http-proxying
|
|
||||||
|
|
||||||
``proxies`` :
|
``proxies`` :
|
||||||
Define one or more proxies you wish to use, see `httpx proxies`_.
|
Define one or more proxies you wish to use, see `curl_cffi proxies`_.
|
||||||
If there are more than one proxy for one protocol (http, https),
|
If there are more than one proxy for one protocol (http, https),
|
||||||
requests to the engines are distributed in a round-robin fashion.
|
requests to the engines are distributed in a round-robin fashion.
|
||||||
|
|
||||||
|
HTTP, HTTPS, SOCKS4, SOCKS5 and SOCKS5h proxies are supported
|
||||||
|
(``http://``, ``https://``, ``socks4://``, ``socks5://``, ``socks5h://``). You should
|
||||||
|
use ``socks5h://`` when using Tor so hostnames are resolved by the proxy.
|
||||||
|
|
||||||
``source_ips`` :
|
``source_ips`` :
|
||||||
If you use multiple network interfaces, define from which IP the requests must
|
If you use multiple network interfaces, define from which IP the requests must
|
||||||
be made. Example:
|
be made. Example:
|
||||||
@@ -87,18 +75,15 @@ Communication with search engines.
|
|||||||
different proxy and source ip.
|
different proxy and source ip.
|
||||||
|
|
||||||
``enable_http2`` :
|
``enable_http2`` :
|
||||||
Enable by default. Set to ``false`` to disable HTTP/2.
|
Enable by default (HTTP/2). Set to ``false`` to force HTTP/1.1.
|
||||||
|
HTTP/3 is opt-in per engine (``enable_http3``).
|
||||||
.. _httpx verification defaults: https://www.python-httpx.org/advanced/#changing-the-verification-defaults
|
|
||||||
.. _httpx ssl configuration: https://www.python-httpx.org/compatibility/#ssl-configuration
|
|
||||||
|
|
||||||
``verify``: : ``$SSL_CERT_FILE``, ``$SSL_CERT_DIR``
|
``verify``: : ``$SSL_CERT_FILE``, ``$SSL_CERT_DIR``
|
||||||
Allow to specify a path to certificate.
|
HTTPS verification uses the OS's trust store by default.
|
||||||
see `httpx verification defaults`_.
|
Set a path to use a custom CA file.
|
||||||
|
|
||||||
In addition to ``verify``, SearXNG supports the ``$SSL_CERT_FILE`` (for a file) and
|
In addition to ``verify``, SearXNG supports the ``$SSL_CERT_FILE`` (for a file) and
|
||||||
``$SSL_CERT_DIR`` (for a directory) OpenSSL variables.
|
``$SSL_CERT_DIR`` (for a directory) OpenSSL variables.
|
||||||
see `httpx ssl configuration`_.
|
|
||||||
|
|
||||||
``max_redirects`` :
|
``max_redirects`` :
|
||||||
30 by default. Maximum redirect before it is an error.
|
30 by default. Maximum redirect before it is an error.
|
||||||
|
|||||||
@@ -143,7 +143,7 @@ parameters with default value can be redefined for special purposes.
|
|||||||
data dict ``{}``
|
data dict ``{}``
|
||||||
cookies dict ``{}``
|
cookies dict ``{}``
|
||||||
verify bool ``True``
|
verify bool ``True``
|
||||||
headers.User-Agent str a random User-Agent
|
headers.User-Agent str ``''``
|
||||||
category str current category, like ``'general'``
|
category str current category, like ``'general'``
|
||||||
safesearch int ``0``, between ``0`` and ``2`` (normal, moderate, strict)
|
safesearch int ``0``, between ``0`` and ``2`` (normal, moderate, strict)
|
||||||
time_range Optional[str] ``None``, can be ``day``, ``week``, ``month``, ``year``
|
time_range Optional[str] ``None``, can be ``day``, ``week``, ``month``, ``year``
|
||||||
@@ -229,6 +229,8 @@ following parameters can be used to specify a search request:
|
|||||||
max_redirects int maximum redirects, hard limit
|
max_redirects int maximum redirects, hard limit
|
||||||
soft_max_redirects int maximum redirects, soft limit. Record an error but don't stop the engine
|
soft_max_redirects int maximum redirects, soft limit. Record an error but don't stop the engine
|
||||||
raise_for_httperror bool True by default: raise an exception if the HTTP code of response is >= 300
|
raise_for_httperror bool True by default: raise an exception if the HTTP code of response is >= 300
|
||||||
|
impersonate str curl_cffi impersonate target (default: chrome, none to disable)
|
||||||
|
curl_options dict Any extra libcurl options for the request
|
||||||
=================== =========== ==========================================================================
|
=================== =========== ==========================================================================
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -286,7 +286,7 @@ content becomes smart.
|
|||||||
files & folders origin :origin:`docs/dev/reST.rst` ``:origin:`docs/dev/reST.rst```
|
files & folders origin :origin:`docs/dev/reST.rst` ``:origin:`docs/dev/reST.rst```
|
||||||
pull request :pull:`4` ``:pull:`4```
|
pull request :pull:`4` ``:pull:`4```
|
||||||
patch :patch:`af2cae6` ``:patch:`af2cae6```
|
patch :patch:`af2cae6` ``:patch:`af2cae6```
|
||||||
PyPi package :pypi:`httpx` ``:pypi:`httpx```
|
PyPi package :pypi:`curl_cffi` ``:pypi:`curl_cffi```
|
||||||
manual page man :man:`bash` ``:man:`bash```
|
manual page man :man:`bash` ``:man:`bash```
|
||||||
intersphinx_
|
intersphinx_
|
||||||
--------------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------------
|
||||||
|
|||||||
@@ -7,9 +7,7 @@ lxml==6.1.2
|
|||||||
pygments==2.21.0
|
pygments==2.21.0
|
||||||
python-dateutil==2.9.0.post0
|
python-dateutil==2.9.0.post0
|
||||||
pyyaml==6.0.3
|
pyyaml==6.0.3
|
||||||
httpx[http2]==0.28.1
|
curl_cffi==0.16.1
|
||||||
httpx-socks[asyncio]==0.13.1
|
|
||||||
sniffio==1.3.1
|
|
||||||
valkey==6.1.1
|
valkey==6.1.1
|
||||||
markdown-it-py==4.2.0
|
markdown-it-py==4.2.0
|
||||||
msgspec==0.21.1
|
msgspec==0.21.1
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ from urllib.parse import urlencode
|
|||||||
|
|
||||||
import lxml.etree
|
import lxml.etree
|
||||||
import lxml.html
|
import lxml.html
|
||||||
from httpx import HTTPError
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
|
|
||||||
from searx import settings
|
from searx import settings
|
||||||
from searx.engines import (
|
from searx.engines import (
|
||||||
@@ -63,7 +63,7 @@ def bing(query: str, _sxng_locale: str) -> list[str]:
|
|||||||
base_url = "https://www.bing.com/AS/Suggestions?"
|
base_url = "https://www.bing.com/AS/Suggestions?"
|
||||||
# cvid has to be a 32 character long string consisting of numbers and uppsercase characters
|
# cvid has to be a 32 character long string consisting of numbers and uppsercase characters
|
||||||
cvid = ''.join(random.choices(string.ascii_uppercase + string.digits, k=32))
|
cvid = ''.join(random.choices(string.ascii_uppercase + string.digits, k=32))
|
||||||
response = get(base_url + urlencode({'qry': query, 'csr': 1, 'cvid': cvid}))
|
response = get(base_url + urlencode({'qry': query, 'csr': 1, 'cvid': cvid}), enable_http3=True)
|
||||||
results: list[str] = []
|
results: list[str] = []
|
||||||
|
|
||||||
if response.ok:
|
if response.ok:
|
||||||
@@ -83,7 +83,7 @@ def brave(query: str, _sxng_locale: str) -> list[str]:
|
|||||||
url = 'https://search.brave.com/api/suggest?'
|
url = 'https://search.brave.com/api/suggest?'
|
||||||
url += urlencode({'q': query})
|
url += urlencode({'q': query})
|
||||||
country = 'all'
|
country = 'all'
|
||||||
kwargs = {'cookies': {'country': country}}
|
kwargs = {'cookies': {'country': country}, 'enable_http3': True}
|
||||||
resp = get(url, **kwargs)
|
resp = get(url, **kwargs)
|
||||||
results: list[str] = []
|
results: list[str] = []
|
||||||
|
|
||||||
@@ -147,7 +147,7 @@ def google_complete(query: str, sxng_locale: str) -> list[str]:
|
|||||||
)
|
)
|
||||||
results: list[str] = []
|
results: list[str] = []
|
||||||
|
|
||||||
resp = get('https://www.google.com/complete/search?' + args)
|
resp = get('https://www.google.com/complete/search?' + args, enable_http3=True)
|
||||||
if resp and resp.ok:
|
if resp and resp.ok:
|
||||||
json_txt = resp.text[resp.text.find('[') : resp.text.find(']', -3) + 1]
|
json_txt = resp.text[resp.text.find('[') : resp.text.find(']', -3) + 1]
|
||||||
data = json.loads(json_txt)
|
data = json.loads(json_txt)
|
||||||
@@ -418,5 +418,5 @@ def search_autocomplete(backend_name: str, query: str, sxng_locale: str) -> list
|
|||||||
return []
|
return []
|
||||||
try:
|
try:
|
||||||
return backend(query, sxng_locale)
|
return backend(query, sxng_locale)
|
||||||
except (HTTPError, SearxEngineResponseException):
|
except (RequestException, SearxEngineResponseException):
|
||||||
return []
|
return []
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import re
|
|||||||
from collections.abc import Iterator
|
from collections.abc import Iterator
|
||||||
from urllib.parse import urlparse, urlunparse, parse_qsl, urlencode
|
from urllib.parse import urlparse, urlunparse, parse_qsl, urlencode
|
||||||
|
|
||||||
from httpx import HTTPError
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
|
|
||||||
from searx.data.core import get_cache, log
|
from searx.data.core import get_cache, log
|
||||||
from searx.network import get as http_get
|
from searx.network import get as http_get
|
||||||
@@ -87,8 +87,8 @@ class TrackerPatternsDB:
|
|||||||
try:
|
try:
|
||||||
resp = http_get(url, timeout=3)
|
resp = http_get(url, timeout=3)
|
||||||
|
|
||||||
except HTTPError as exc:
|
except RequestException as exc:
|
||||||
log.warning("TRACKER_PATTERNS: HTTPError (%s) occured while fetching %s", url, exc)
|
log.warning("TRACKER_PATTERNS: RequestException while fetching %s: %s", url, exc)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if resp.status_code != 200:
|
if resp.status_code != 200:
|
||||||
|
|||||||
@@ -317,6 +317,9 @@ class Engine(abc.ABC): # pylint: disable=too-few-public-methods
|
|||||||
enable_http: bool
|
enable_http: bool
|
||||||
"""Enable HTTP (by default only HTTPS is enabled)."""
|
"""Enable HTTP (by default only HTTPS is enabled)."""
|
||||||
|
|
||||||
|
enable_http3: bool = False
|
||||||
|
"""Enables the use of HTTP/3 if available"""
|
||||||
|
|
||||||
shortcut: str
|
shortcut: str
|
||||||
"""Code used to execute bang requests (``!foo``)"""
|
"""Code used to execute bang requests (``!foo``)"""
|
||||||
|
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ categories: list[str]
|
|||||||
disabled: bool
|
disabled: bool
|
||||||
display_error_messages: bool
|
display_error_messages: bool
|
||||||
enable_http: bool
|
enable_http: bool
|
||||||
|
enable_http3: bool
|
||||||
engine_type: str
|
engine_type: str
|
||||||
inactive: bool
|
inactive: bool
|
||||||
max_page: int
|
max_page: int
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ about: dict[str, t.Any] = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ["general", "web"]
|
categories = ["general", "web"]
|
||||||
safesearch = True
|
safesearch = True
|
||||||
|
enable_http3 = True
|
||||||
_safesearch_map: dict[int, str] = {
|
_safesearch_map: dict[int, str] = {
|
||||||
0: "off",
|
0: "off",
|
||||||
1: "moderate",
|
1: "moderate",
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ["images", "web"]
|
categories = ["images", "web"]
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
safesearch = True
|
safesearch = True
|
||||||
time_range_support = True
|
time_range_support = True
|
||||||
time_map = {
|
time_map = {
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ categories = ["news"]
|
|||||||
paging = True
|
paging = True
|
||||||
"""If go through the pages and there are actually no new results for another
|
"""If go through the pages and there are actually no new results for another
|
||||||
page, then bing returns the results from the last page again."""
|
page, then bing returns the results from the last page again."""
|
||||||
|
enable_http3 = True
|
||||||
|
|
||||||
time_range_support = True
|
time_range_support = True
|
||||||
time_map = {
|
time_map = {
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ["videos", "web"]
|
categories = ["videos", "web"]
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
safesearch = True
|
safesearch = True
|
||||||
time_range_support = True
|
time_range_support = True
|
||||||
|
|
||||||
|
|||||||
@@ -151,6 +151,7 @@ about = {
|
|||||||
|
|
||||||
base_url = "https://search.brave.com/"
|
base_url = "https://search.brave.com/"
|
||||||
categories = []
|
categories = []
|
||||||
|
enable_http3 = True
|
||||||
brave_category: t.Literal["search", "videos", "images", "news", "goggles"] = "search"
|
brave_category: t.Literal["search", "videos", "images", "news", "goggles"] = "search"
|
||||||
"""Brave supports common web-search, videos, images, news, and goggles search.
|
"""Brave supports common web-search, videos, images, news, and goggles search.
|
||||||
|
|
||||||
|
|||||||
@@ -98,6 +98,7 @@ def request(query: str, params: "OnlineParams") -> None:
|
|||||||
# The vqd value is generated from the query and the UA header. To be able to
|
# The vqd value is generated from the query and the UA header. To be able to
|
||||||
# reuse the vqd value, the UA header must be static.
|
# reuse the vqd value, the UA header must be static.
|
||||||
headers["User-Agent"] = _HTTP_User_Agent
|
headers["User-Agent"] = _HTTP_User_Agent
|
||||||
|
params["impersonate"] = "none"
|
||||||
vqd = get_vqd(query=query, params=params) or fetch_vqd(query=query, params=params)
|
vqd = get_vqd(query=query, params=params) or fetch_vqd(query=query, params=params)
|
||||||
|
|
||||||
headers["Accept"] = "*/*"
|
headers["Accept"] = "*/*"
|
||||||
|
|||||||
@@ -327,6 +327,7 @@ def google_request(
|
|||||||
|
|
||||||
params["url"] = f"https://www.google.com/wml/search?{urlencode(args)}"
|
params["url"] = f"https://www.google.com/wml/search?{urlencode(args)}"
|
||||||
params["headers"]["User-Agent"] = random.choice(nokia_useragents)
|
params["headers"]["User-Agent"] = random.choice(nokia_useragents)
|
||||||
|
params["impersonate"] = "chrome99_android"
|
||||||
|
|
||||||
|
|
||||||
def request(query: str, params: "OnlineParams") -> None:
|
def request(query: str, params: "OnlineParams") -> None:
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ about = {
|
|||||||
|
|
||||||
categories = ["general", "web"]
|
categories = ["general", "web"]
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
max_page = 5
|
max_page = 5
|
||||||
page_size = 20
|
page_size = 20
|
||||||
time_range_support = True
|
time_range_support = True
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ["images", "web"]
|
categories = ["images", "web"]
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
max_page = 50
|
max_page = 50
|
||||||
"""Google supports up to 50 pages of results, see the `Google max_page discussion`_.
|
"""Google supports up to 50 pages of results, see the `Google max_page discussion`_.
|
||||||
|
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ about = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
play_categ = None # apps|movies
|
play_categ = None # apps|movies
|
||||||
|
enable_http3 = True
|
||||||
base_url = 'https://play.google.com'
|
base_url = 'https://play.google.com'
|
||||||
search_url = base_url + "/store/search?{query}&c={play_categ}"
|
search_url = base_url + "/store/search?{query}&c={play_categ}"
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ import typing as t
|
|||||||
from urllib.parse import urlencode
|
from urllib.parse import urlencode
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from lxml import html
|
from lxml import html
|
||||||
import httpx
|
from curl_cffi.requests.exceptions import TooManyRedirects
|
||||||
|
|
||||||
from searx.utils import (
|
from searx.utils import (
|
||||||
eval_xpath,
|
eval_xpath,
|
||||||
@@ -63,6 +63,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ["science", "scientific publications"]
|
categories = ["science", "scientific publications"]
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
max_page = 50
|
max_page = 50
|
||||||
"""`Google max 50 pages`_
|
"""`Google max 50 pages`_
|
||||||
|
|
||||||
@@ -102,7 +103,7 @@ def response(resp: "SXNG_Response") -> EngineResults: # pylint: disable=too-man
|
|||||||
raise SearxEngineAccessDeniedException(
|
raise SearxEngineAccessDeniedException(
|
||||||
message="google_scholar: unusual traffic detected",
|
message="google_scholar: unusual traffic detected",
|
||||||
)
|
)
|
||||||
raise httpx.TooManyRedirects(f"location {resp.headers['Location'].split('?')[0]}")
|
raise TooManyRedirects(f"location {resp.headers['Location'].split('?')[0]}")
|
||||||
|
|
||||||
res = EngineResults()
|
res = EngineResults()
|
||||||
dom = html.fromstring(resp.text)
|
dom = html.fromstring(resp.text)
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ from json import loads
|
|||||||
from urllib.parse import urlencode
|
from urllib.parse import urlencode
|
||||||
from dateutil import parser
|
from dateutil import parser
|
||||||
|
|
||||||
from httpx import DigestAuth
|
from curl_cffi import CurlOpt
|
||||||
|
|
||||||
from searx.utils import html_to_text
|
from searx.utils import html_to_text
|
||||||
|
|
||||||
@@ -141,7 +141,10 @@ def request(query, params):
|
|||||||
params["url"] = f"{_base_url()}/yacysearch.json?{urlencode(args)}"
|
params["url"] = f"{_base_url()}/yacysearch.json?{urlencode(args)}"
|
||||||
|
|
||||||
if http_digest_auth_user and http_digest_auth_pass:
|
if http_digest_auth_user and http_digest_auth_pass:
|
||||||
params['auth'] = DigestAuth(http_digest_auth_user, http_digest_auth_pass)
|
params['curl_options'] = {
|
||||||
|
CurlOpt.HTTPAUTH: 2, # CURLAUTH_DIGEST
|
||||||
|
CurlOpt.USERPWD: f"{http_digest_auth_user}:{http_digest_auth_pass}",
|
||||||
|
}
|
||||||
|
|
||||||
return params
|
return params
|
||||||
|
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ about = {
|
|||||||
# Engine configuration
|
# Engine configuration
|
||||||
categories = []
|
categories = []
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
search_type = ""
|
search_type = ""
|
||||||
|
|
||||||
# Search URL
|
# Search URL
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ['videos', 'music']
|
categories = ['videos', 'music']
|
||||||
paging = False
|
paging = False
|
||||||
|
enable_http3 = True
|
||||||
api_key = None
|
api_key = None
|
||||||
|
|
||||||
# search-url
|
# search-url
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ about = {
|
|||||||
# engine dependent config
|
# engine dependent config
|
||||||
categories = ['videos', 'music']
|
categories = ['videos', 'music']
|
||||||
paging = True
|
paging = True
|
||||||
|
enable_http3 = True
|
||||||
language_support = False
|
language_support = False
|
||||||
time_range_support = True
|
time_range_support = True
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
- :py:obj:`flask.request` is replaced by :py:obj:`sxng_request`
|
- :py:obj:`flask.request` is replaced by :py:obj:`sxng_request`
|
||||||
- :py:obj:`flask.Request` is replaced by :py:obj:`SXNG_Request`
|
- :py:obj:`flask.Request` is replaced by :py:obj:`SXNG_Request`
|
||||||
- :py:obj:`httpx.response` is replaced by :py:obj:`SXNG_Response`
|
- :py:obj:`curl_cffi.requests.Response` is replaced by :py:obj:`SXNG_Response`
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
@@ -24,8 +24,10 @@
|
|||||||
__all__ = ["SXNG_Request", "sxng_request", "SXNG_Response"]
|
__all__ = ["SXNG_Request", "sxng_request", "SXNG_Response"]
|
||||||
|
|
||||||
import typing
|
import typing
|
||||||
|
from urllib.parse import urlsplit
|
||||||
|
|
||||||
import flask
|
import flask
|
||||||
import httpx
|
from curl_cffi.requests import Response as CurlResponse
|
||||||
|
|
||||||
if typing.TYPE_CHECKING:
|
if typing.TYPE_CHECKING:
|
||||||
import searx.preferences
|
import searx.preferences
|
||||||
@@ -69,18 +71,37 @@ class SXNG_Request(flask.Request):
|
|||||||
sxng_request = typing.cast(SXNG_Request, flask.request)
|
sxng_request = typing.cast(SXNG_Request, flask.request)
|
||||||
|
|
||||||
|
|
||||||
class SXNG_Response(httpx.Response):
|
class SXNG_URL(str):
|
||||||
"""SearXNG extends the class :py:obj:`httpx.Response` with properties from
|
"""String URL"""
|
||||||
*this* class (type cast of :py:obj:`httpx.Response`).
|
|
||||||
|
@property
|
||||||
|
def host(self) -> str | None:
|
||||||
|
return urlsplit(self).hostname
|
||||||
|
|
||||||
|
@property
|
||||||
|
def path(self) -> str:
|
||||||
|
return urlsplit(self).path
|
||||||
|
|
||||||
|
|
||||||
|
class SXNG_Response(CurlResponse):
|
||||||
|
"""SearXNG extends :py:obj:`curl_cffi.requests.Response` with properties from
|
||||||
|
*this* class (type cast of the curl_cffi response).
|
||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
response = httpx.get("https://example.org")
|
|
||||||
response = typing.cast(SXNG_Response, response)
|
response = typing.cast(SXNG_Response, response)
|
||||||
if response.ok:
|
if response.ok:
|
||||||
...
|
...
|
||||||
query_was = search_params["query"]
|
query_was = search_params["query"]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
ok: bool
|
|
||||||
search_params: "OnlineParamTypes | OnlineDictParams | OnlineCurrenciesParams"
|
search_params: "OnlineParamTypes | OnlineDictParams | OnlineCurrenciesParams"
|
||||||
|
_url: str = ""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def url(self) -> SXNG_URL: # type: ignore[override]
|
||||||
|
return SXNG_URL(self._url)
|
||||||
|
|
||||||
|
@url.setter
|
||||||
|
def url(self, value: str) -> None:
|
||||||
|
self._url = str(value or "")
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import pathlib
|
|||||||
import urllib.parse
|
import urllib.parse
|
||||||
|
|
||||||
import flask
|
import flask
|
||||||
from httpx import HTTPError
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
import msgspec
|
import msgspec
|
||||||
|
|
||||||
from searx import get_setting
|
from searx import get_setting
|
||||||
@@ -185,7 +185,7 @@ def search_favicon(resolver: str, authority: str) -> tuple[None | bytes, None |
|
|||||||
if data is None or mime is None:
|
if data is None or mime is None:
|
||||||
data, mime = (None, None)
|
data, mime = (None, None)
|
||||||
|
|
||||||
except (HTTPError, SearxEngineResponseException):
|
except (RequestException, SearxEngineResponseException):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
cache.CACHE.set(resolver, authority, mime, data)
|
cache.CACHE.set(resolver, authority, mime, data)
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import typing as t
|
|||||||
import inspect
|
import inspect
|
||||||
from json import JSONDecodeError
|
from json import JSONDecodeError
|
||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
from httpx import HTTPError, HTTPStatusError
|
from curl_cffi.requests.exceptions import HTTPError, RequestException
|
||||||
from searx.exceptions import (
|
from searx.exceptions import (
|
||||||
SearxXPathSyntaxException,
|
SearxXPathSyntaxException,
|
||||||
SearxEngineXPathException,
|
SearxEngineXPathException,
|
||||||
@@ -100,32 +100,22 @@ def get_trace(traces):
|
|||||||
return traces[-1]
|
return traces[-1]
|
||||||
|
|
||||||
|
|
||||||
def get_hostname(exc: HTTPError) -> str | None:
|
def get_hostname(exc: RequestException) -> str | None:
|
||||||
url = exc.request.url
|
url = getattr(getattr(exc, "request", None), "url", None)
|
||||||
if url is None and exc.response is not None:
|
if url is None:
|
||||||
url = exc.response.url
|
url = getattr(getattr(exc, "response", None), "url", None)
|
||||||
return urlparse(url).netloc
|
return urlparse(str(url)).netloc if url else None
|
||||||
|
|
||||||
|
|
||||||
def get_request_exception_messages(
|
def get_request_exception_messages(
|
||||||
exc: HTTPError,
|
exc: RequestException,
|
||||||
) -> tuple[str | None, str | None, str | None]:
|
) -> tuple[str | None, str | None, str | None]:
|
||||||
url = None
|
response = getattr(exc, "response", None)
|
||||||
status_code = None
|
status_code = reason = None
|
||||||
reason = None
|
if isinstance(exc, HTTPError) and response is not None:
|
||||||
hostname = None
|
status_code = str(response.status_code)
|
||||||
if hasattr(exc, '_request') and exc._request is not None: # pylint: disable=protected-access
|
reason = response.reason
|
||||||
# exc.request is property that raise an RuntimeException
|
return (status_code, reason, get_hostname(exc))
|
||||||
# if exc._request is not defined.
|
|
||||||
url = exc.request.url
|
|
||||||
if url is None and hasattr(exc, 'response') and exc.response is not None:
|
|
||||||
url = exc.response.url
|
|
||||||
if url is not None:
|
|
||||||
hostname = url.host
|
|
||||||
if isinstance(exc, HTTPStatusError):
|
|
||||||
status_code = str(exc.response.status_code)
|
|
||||||
reason = exc.response.reason_phrase
|
|
||||||
return (status_code, reason, hostname)
|
|
||||||
|
|
||||||
|
|
||||||
def get_messages(exc, filename) -> tuple[str, ...]: # pylint: disable=too-many-return-statements
|
def get_messages(exc, filename) -> tuple[str, ...]: # pylint: disable=too-many-return-statements
|
||||||
@@ -135,7 +125,7 @@ def get_messages(exc, filename) -> tuple[str, ...]: # pylint: disable=too-many-
|
|||||||
return (str(exc),)
|
return (str(exc),)
|
||||||
if isinstance(exc, ValueError) and 'lxml' in filename:
|
if isinstance(exc, ValueError) and 'lxml' in filename:
|
||||||
return (str(exc),)
|
return (str(exc),)
|
||||||
if isinstance(exc, HTTPError):
|
if isinstance(exc, RequestException):
|
||||||
return get_request_exception_messages(exc)
|
return get_request_exception_messages(exc)
|
||||||
if isinstance(exc, SearxXPathSyntaxException):
|
if isinstance(exc, SearxXPathSyntaxException):
|
||||||
return (exc.xpath_str, exc.message)
|
return (exc.xpath_str, exc.message)
|
||||||
|
|||||||
@@ -14,8 +14,7 @@ from timeit import default_timer
|
|||||||
from collections.abc import Iterable
|
from collections.abc import Iterable
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
|
|
||||||
import httpx
|
from curl_cffi.requests.exceptions import StreamConsumedError, Timeout
|
||||||
import anyio
|
|
||||||
|
|
||||||
from searx.extended_types import SXNG_Response
|
from searx.extended_types import SXNG_Response
|
||||||
from .network import get_network, initialize, check_network_configuration # pylint:disable=cyclic-import
|
from .network import get_network, initialize, check_network_configuration # pylint:disable=cyclic-import
|
||||||
@@ -74,7 +73,6 @@ def _get_timeout(start_time: float, kwargs: t.Any) -> float:
|
|||||||
# pylint: disable=too-many-branches
|
# pylint: disable=too-many-branches
|
||||||
|
|
||||||
timeout: float | None
|
timeout: float | None
|
||||||
# timeout (httpx)
|
|
||||||
if 'timeout' in kwargs:
|
if 'timeout' in kwargs:
|
||||||
timeout = kwargs['timeout']
|
timeout = kwargs['timeout']
|
||||||
else:
|
else:
|
||||||
@@ -105,10 +103,10 @@ def request(method: str, url: str, **kwargs: t.Any) -> SXNG_Response:
|
|||||||
try:
|
try:
|
||||||
return future.result(timeout)
|
return future.result(timeout)
|
||||||
except concurrent.futures.TimeoutError as e:
|
except concurrent.futures.TimeoutError as e:
|
||||||
raise httpx.TimeoutException('Timeout', request=None) from e
|
raise Timeout('Timeout') from e
|
||||||
|
|
||||||
|
|
||||||
def multi_requests(request_list: list["Request"]) -> list[httpx.Response | Exception]:
|
def multi_requests(request_list: list["Request"]) -> list[SXNG_Response | Exception]:
|
||||||
"""send multiple HTTP requests in parallel. Wait for all requests to finish."""
|
"""send multiple HTTP requests in parallel. Wait for all requests to finish."""
|
||||||
with _record_http_time() as start_time:
|
with _record_http_time() as start_time:
|
||||||
# send the requests
|
# send the requests
|
||||||
@@ -128,7 +126,7 @@ def multi_requests(request_list: list["Request"]) -> list[httpx.Response | Excep
|
|||||||
try:
|
try:
|
||||||
responses.append(future.result(timeout))
|
responses.append(future.result(timeout))
|
||||||
except concurrent.futures.TimeoutError:
|
except concurrent.futures.TimeoutError:
|
||||||
responses.append(httpx.TimeoutException('Timeout', request=None))
|
responses.append(Timeout('Timeout'))
|
||||||
except Exception as e: # pylint: disable=broad-except
|
except Exception as e: # pylint: disable=broad-except
|
||||||
responses.append(e)
|
responses.append(e)
|
||||||
return responses
|
return responses
|
||||||
@@ -205,14 +203,12 @@ async def stream_chunk_to_queue(network, queue, method: str, url: str, **kwargs:
|
|||||||
try:
|
try:
|
||||||
async with await network.stream(method, url, **kwargs) as response:
|
async with await network.stream(method, url, **kwargs) as response:
|
||||||
queue.put(response)
|
queue.put(response)
|
||||||
# aiter_raw: access the raw bytes on the response without applying any HTTP content decoding
|
async for chunk in response.aiter_content():
|
||||||
# https://www.python-httpx.org/quickstart/#streaming-responses
|
|
||||||
async for chunk in response.aiter_raw(65536):
|
|
||||||
if len(chunk) > 0:
|
if len(chunk) > 0:
|
||||||
queue.put(chunk)
|
queue.put(chunk)
|
||||||
except (httpx.StreamClosed, anyio.ClosedResourceError):
|
except StreamConsumedError:
|
||||||
# the response was queued before the exception.
|
# the response was queued before the exception.
|
||||||
# the exception was raised on aiter_raw.
|
# the exception was raised on aiter_content.
|
||||||
# we do nothing here: in the finally block, None will be queued
|
# we do nothing here: in the finally block, None will be queued
|
||||||
# so stream(method, url, **kwargs) generator can stop
|
# so stream(method, url, **kwargs) generator can stop
|
||||||
pass
|
pass
|
||||||
@@ -246,22 +242,19 @@ def _close_response_method(self):
|
|||||||
asyncio.run_coroutine_threadsafe(self.aclose(), get_loop())
|
asyncio.run_coroutine_threadsafe(self.aclose(), get_loop())
|
||||||
# reach the end of _self.generator ( _stream_generator ) to an avoid memory leak.
|
# reach the end of _self.generator ( _stream_generator ) to an avoid memory leak.
|
||||||
# it makes sure that :
|
# it makes sure that :
|
||||||
# * the httpx response is closed (see the stream_chunk_to_queue function)
|
# * the curl_cffi response is closed (see the stream_chunk_to_queue function)
|
||||||
# * to call future.result() in _stream_generator
|
# * to call future.result() in _stream_generator
|
||||||
for _ in self._generator: # pylint: disable=protected-access
|
for _ in self._generator: # pylint: disable=protected-access
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
|
||||||
def stream(method: str, url: str, **kwargs: t.Any) -> tuple[SXNG_Response, Iterable[bytes]]:
|
def stream(method: str, url: str, **kwargs: t.Any) -> tuple[SXNG_Response, Iterable[bytes]]:
|
||||||
"""Replace httpx.stream.
|
"""Stream for the image proxy.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
response, stream = poolrequests.stream(...)
|
response, stream = searx.network.stream(...)
|
||||||
for chunk in stream:
|
for chunk in stream:
|
||||||
...
|
...
|
||||||
|
|
||||||
httpx.Client.stream requires to write the httpx.HTTPTransport version of the
|
|
||||||
the httpx.AsyncHTTPTransport declared above.
|
|
||||||
"""
|
"""
|
||||||
generator = _stream_generator(method, url, **kwargs)
|
generator = _stream_generator(method, url, **kwargs)
|
||||||
|
|
||||||
|
|||||||
@@ -2,207 +2,114 @@
|
|||||||
# pylint: disable=missing-module-docstring, global-statement
|
# pylint: disable=missing-module-docstring, global-statement
|
||||||
|
|
||||||
import typing as t
|
import typing as t
|
||||||
from types import TracebackType
|
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
import logging
|
import logging
|
||||||
import random
|
import os
|
||||||
from ssl import SSLContext
|
|
||||||
import threading
|
import threading
|
||||||
|
|
||||||
import httpx
|
from curl_cffi import AsyncSession, CurlHttpVersion, CurlOpt
|
||||||
from httpx_socks import AsyncProxyTransport
|
from curl_cffi.requests.exceptions import InvalidSchema, RequestException
|
||||||
from python_socks import parse_proxy_url, ProxyConnectionError, ProxyTimeoutError, ProxyError
|
|
||||||
|
|
||||||
from searx import logger
|
from searx.extended_types import SXNG_Response
|
||||||
|
|
||||||
CertTypes = str | tuple[str, str] | tuple[str, str, str]
|
|
||||||
SslContextKeyType = tuple[str | None, CertTypes | None, bool, bool]
|
|
||||||
|
|
||||||
logger = logger.getChild('searx.network.client')
|
|
||||||
LOOP: asyncio.AbstractEventLoop = None # pyright: ignore[reportAssignmentType]
|
LOOP: asyncio.AbstractEventLoop = None # pyright: ignore[reportAssignmentType]
|
||||||
|
|
||||||
SSLCONTEXTS: dict[SslContextKeyType, SSLContext] = {}
|
# chrome is used by default
|
||||||
|
DEFAULT_IMPERSONATE = "chrome"
|
||||||
|
NO_IMPERSONATE = "none"
|
||||||
|
|
||||||
|
|
||||||
def shuffle_ciphers(ssl_context: SSLContext):
|
class AsyncClient(AsyncSession):
|
||||||
"""Shuffle httpx's default ciphers of a SSL context randomly.
|
""":class:`curl_cffi.AsyncSession` with ``aclose`` / ``is_closed``."""
|
||||||
|
|
||||||
From `What Is TLS Fingerprint and How to Bypass It`_
|
def __init__(self, enable_http: bool, **kwargs: t.Any):
|
||||||
|
self.enable_http = enable_http
|
||||||
|
self._closed = False
|
||||||
|
super().__init__(**kwargs)
|
||||||
|
|
||||||
> When implementing TLS fingerprinting, servers can't operate based on a
|
@property
|
||||||
> locked-in whitelist database of fingerprints. New fingerprints appear
|
def is_closed(self) -> bool:
|
||||||
> when web clients or TLS libraries release new versions. So, they have to
|
return self._closed
|
||||||
> live off a blocklist database instead.
|
|
||||||
> ...
|
|
||||||
> It's safe to leave the first three as is but shuffle the remaining ciphers
|
|
||||||
> and you can bypass the TLS fingerprint check.
|
|
||||||
|
|
||||||
.. _What Is TLS Fingerprint and How to Bypass It:
|
def check_url(self, url: str) -> None:
|
||||||
https://www.zenrows.com/blog/what-is-tls-fingerprint#how-to-bypass-tls-fingerprinting
|
if not self.enable_http and str(url).startswith("http://"):
|
||||||
|
raise InvalidSchema("HTTP protocol is disabled")
|
||||||
"""
|
|
||||||
c_list = [cipher["name"] for cipher in ssl_context.get_ciphers()]
|
|
||||||
sc_list, c_list = c_list[:3], c_list[3:]
|
|
||||||
random.shuffle(c_list)
|
|
||||||
ssl_context.set_ciphers(":".join(sc_list + c_list))
|
|
||||||
|
|
||||||
|
|
||||||
def get_sslcontexts(
|
|
||||||
proxy_url: str | None = None, cert: CertTypes | None = None, verify: bool = True, trust_env: bool = True
|
|
||||||
) -> SSLContext:
|
|
||||||
key: SslContextKeyType = (proxy_url, cert, verify, trust_env)
|
|
||||||
if key not in SSLCONTEXTS:
|
|
||||||
SSLCONTEXTS[key] = httpx.create_ssl_context(verify, cert, trust_env)
|
|
||||||
shuffle_ciphers(SSLCONTEXTS[key])
|
|
||||||
return SSLCONTEXTS[key]
|
|
||||||
|
|
||||||
|
|
||||||
class AsyncHTTPTransportNoHttp(httpx.AsyncHTTPTransport):
|
|
||||||
"""Block HTTP request
|
|
||||||
|
|
||||||
The constructor is blank because httpx.AsyncHTTPTransport.__init__ creates an SSLContext unconditionally:
|
|
||||||
https://github.com/encode/httpx/blob/0f61aa58d66680c239ce43c8cdd453e7dc532bfc/httpx/_transports/default.py#L271
|
|
||||||
|
|
||||||
Each SSLContext consumes more than 500kb of memory, since there is about one network per engine.
|
|
||||||
|
|
||||||
In consequence, this class overrides all public methods
|
|
||||||
|
|
||||||
For reference: https://github.com/encode/httpx/issues/2298
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs): # type: ignore
|
|
||||||
# pylint: disable=super-init-not-called
|
|
||||||
# this on purpose if the base class is not called
|
|
||||||
pass
|
|
||||||
|
|
||||||
async def handle_async_request(self, request: httpx.Request):
|
|
||||||
raise httpx.UnsupportedProtocol('HTTP protocol is disabled')
|
|
||||||
|
|
||||||
async def aclose(self) -> None:
|
async def aclose(self) -> None:
|
||||||
pass
|
if self._closed:
|
||||||
|
return
|
||||||
async def __aenter__(self):
|
self._closed = True
|
||||||
return self
|
|
||||||
|
|
||||||
async def __aexit__(
|
|
||||||
self,
|
|
||||||
exc_type: type[BaseException] | None = None,
|
|
||||||
exc_value: BaseException | None = None,
|
|
||||||
traceback: TracebackType | None = None,
|
|
||||||
) -> None:
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class AsyncProxyTransportFixed(AsyncProxyTransport):
|
|
||||||
"""Fix httpx_socks.AsyncProxyTransport
|
|
||||||
|
|
||||||
Map python_socks exceptions to httpx.ProxyError exceptions
|
|
||||||
"""
|
|
||||||
|
|
||||||
async def handle_async_request(self, request: httpx.Request):
|
|
||||||
try:
|
try:
|
||||||
return await super().handle_async_request(request)
|
await self.close()
|
||||||
except ProxyConnectionError as e:
|
except RequestException:
|
||||||
raise httpx.ProxyError("ProxyConnectionError: " + str(e.strerror), request=request) from e
|
pass
|
||||||
except ProxyTimeoutError as e:
|
|
||||||
raise httpx.ProxyError("ProxyTimeoutError: " + str(e.args[0]), request=request) from e
|
|
||||||
except ProxyError as e:
|
|
||||||
raise httpx.ProxyError("ProxyError: " + str(e.args[0]), request=request) from e
|
|
||||||
|
|
||||||
|
|
||||||
def get_transport_for_socks_proxy(
|
def _proxy_kwargs(proxies: dict[str, str], enable_http: bool) -> dict[str, t.Any]:
|
||||||
verify: bool, http2: bool, local_address: str, proxy_url: str, limit: httpx.Limits, retries: int
|
"""Map settings.yml proxy keys (``all://``, ``https://``) to curl_cffi."""
|
||||||
):
|
mapped: dict[str, str] = {}
|
||||||
# support socks5h (requests compatibility):
|
all_proxy: str | None = None
|
||||||
# https://requests.readthedocs.io/en/master/user/advanced/#socks
|
for pattern, proxy_url in proxies.items():
|
||||||
# socks5:// hostname is resolved on client side
|
if not enable_http and pattern.startswith("http://"):
|
||||||
# socks5h:// hostname is resolved on proxy side
|
continue
|
||||||
rdns = False
|
if pattern.startswith("https"):
|
||||||
socks5h = 'socks5h://'
|
mapped["https"] = proxy_url
|
||||||
if proxy_url.startswith(socks5h):
|
elif pattern.startswith("http"):
|
||||||
proxy_url = 'socks5://' + proxy_url[len(socks5h) :]
|
mapped["http"] = proxy_url
|
||||||
rdns = True
|
else:
|
||||||
|
all_proxy = proxy_url
|
||||||
proxy_type, proxy_host, proxy_port, proxy_username, proxy_password = parse_proxy_url(proxy_url)
|
if all_proxy:
|
||||||
_verify = get_sslcontexts(proxy_url, None, verify, True) if verify is True else verify
|
return {"proxy": all_proxy}
|
||||||
return AsyncProxyTransportFixed(
|
if mapped:
|
||||||
proxy_type=proxy_type,
|
return {"proxies": mapped}
|
||||||
proxy_host=proxy_host,
|
return {}
|
||||||
proxy_port=proxy_port,
|
|
||||||
username=proxy_username,
|
|
||||||
password=proxy_password,
|
|
||||||
rdns=rdns,
|
|
||||||
verify=_verify, # pyright: ignore[reportArgumentType]
|
|
||||||
http2=http2,
|
|
||||||
local_address=local_address,
|
|
||||||
limits=limit,
|
|
||||||
retries=retries,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get_transport(
|
|
||||||
verify: bool, http2: bool, local_address: str, proxy_url: str | None, limit: httpx.Limits, retries: int
|
|
||||||
):
|
|
||||||
_verify = get_sslcontexts(None, None, verify, True) if verify is True else verify
|
|
||||||
return httpx.AsyncHTTPTransport(
|
|
||||||
# pylint: disable=protected-access
|
|
||||||
verify=_verify,
|
|
||||||
http2=http2,
|
|
||||||
limits=limit,
|
|
||||||
proxy=httpx._config.Proxy(proxy_url) if proxy_url else None, # pyright: ignore[reportPrivateUsage]
|
|
||||||
local_address=local_address,
|
|
||||||
retries=retries,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def new_client(
|
def new_client(
|
||||||
# pylint: disable=too-many-arguments
|
# pylint: disable=too-many-arguments
|
||||||
enable_http: bool,
|
enable_http: bool,
|
||||||
verify: bool,
|
verify: bool | str,
|
||||||
enable_http2: bool,
|
enable_http2: bool,
|
||||||
|
enable_http3: bool,
|
||||||
max_connections: int,
|
max_connections: int,
|
||||||
max_keepalive_connections: int,
|
|
||||||
keepalive_expiry: float,
|
|
||||||
proxies: dict[str, str],
|
proxies: dict[str, str],
|
||||||
local_address: str,
|
local_address: str | None,
|
||||||
retries: int,
|
|
||||||
max_redirects: int,
|
max_redirects: int,
|
||||||
hook_log_response: t.Callable[..., t.Any] | None,
|
impersonate: str = DEFAULT_IMPERSONATE,
|
||||||
) -> httpx.AsyncClient:
|
curl_options: dict[int, t.Any] | None = None,
|
||||||
limit = httpx.Limits(
|
) -> AsyncClient:
|
||||||
max_connections=max_connections,
|
extra_curl = dict(curl_options or {})
|
||||||
max_keepalive_connections=max_keepalive_connections,
|
cert_file = os.environ.get("SSL_CERT_FILE")
|
||||||
keepalive_expiry=keepalive_expiry,
|
if cert_file:
|
||||||
)
|
extra_curl.setdefault(CurlOpt.CAINFO, cert_file)
|
||||||
# See https://www.python-httpx.org/advanced/#routing
|
cert_dir = os.environ.get("SSL_CERT_DIR")
|
||||||
mounts = {}
|
if cert_dir:
|
||||||
mounts: None | (dict[str, t.Any | None]) = {}
|
extra_curl.setdefault(CurlOpt.CAPATH, cert_dir)
|
||||||
for pattern, proxy_url in proxies.items():
|
use_impersonate = impersonate not in ("", NO_IMPERSONATE)
|
||||||
if not enable_http and pattern.startswith('http://'):
|
kwargs: dict[str, t.Any] = {
|
||||||
continue
|
"enable_http": enable_http,
|
||||||
if proxy_url.startswith('socks4://') or proxy_url.startswith('socks5://') or proxy_url.startswith('socks5h://'):
|
"verify": verify,
|
||||||
mounts[pattern] = get_transport_for_socks_proxy(
|
"max_redirects": max_redirects,
|
||||||
verify, enable_http2, local_address, proxy_url, limit, retries
|
"max_clients": max_connections or 10,
|
||||||
)
|
"response_class": SXNG_Response,
|
||||||
|
"discard_cookies": True,
|
||||||
|
**_proxy_kwargs(proxies, enable_http),
|
||||||
|
}
|
||||||
|
if use_impersonate:
|
||||||
|
kwargs["impersonate"] = impersonate
|
||||||
|
kwargs["default_headers"] = True
|
||||||
|
if local_address:
|
||||||
|
kwargs["interface"] = local_address
|
||||||
|
if not enable_http2:
|
||||||
|
kwargs["http_version"] = CurlHttpVersion.V1_1
|
||||||
|
elif enable_http3 and not proxies:
|
||||||
|
kwargs["http_version"] = CurlHttpVersion.V3
|
||||||
else:
|
else:
|
||||||
mounts[pattern] = get_transport(verify, enable_http2, local_address, proxy_url, limit, retries)
|
kwargs["http_version"] = CurlHttpVersion.V2_0
|
||||||
|
if extra_curl:
|
||||||
if not enable_http:
|
kwargs["curl_options"] = extra_curl
|
||||||
mounts['http://'] = AsyncHTTPTransportNoHttp()
|
return AsyncClient(**kwargs)
|
||||||
|
|
||||||
transport = get_transport(verify, enable_http2, local_address, None, limit, retries)
|
|
||||||
|
|
||||||
event_hooks = None
|
|
||||||
if hook_log_response:
|
|
||||||
event_hooks = {'response': [hook_log_response]}
|
|
||||||
|
|
||||||
return httpx.AsyncClient(
|
|
||||||
transport=transport,
|
|
||||||
mounts=mounts,
|
|
||||||
max_redirects=max_redirects,
|
|
||||||
event_hooks=event_hooks,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get_loop() -> asyncio.AbstractEventLoop:
|
def get_loop() -> asyncio.AbstractEventLoop:
|
||||||
@@ -210,30 +117,18 @@ def get_loop() -> asyncio.AbstractEventLoop:
|
|||||||
|
|
||||||
|
|
||||||
def init():
|
def init():
|
||||||
# log
|
logging.getLogger("curl_cffi").setLevel(logging.WARNING)
|
||||||
for logger_name in (
|
|
||||||
'httpx',
|
ready = threading.Event()
|
||||||
'httpcore.proxy',
|
|
||||||
'httpcore.connection',
|
|
||||||
'httpcore.http11',
|
|
||||||
'httpcore.http2',
|
|
||||||
'hpack.hpack',
|
|
||||||
'hpack.table',
|
|
||||||
):
|
|
||||||
logging.getLogger(logger_name).setLevel(logging.WARNING)
|
|
||||||
|
|
||||||
# loop
|
|
||||||
def loop_thread():
|
def loop_thread():
|
||||||
global LOOP
|
global LOOP
|
||||||
LOOP = asyncio.new_event_loop()
|
LOOP = asyncio.new_event_loop()
|
||||||
|
ready.set()
|
||||||
LOOP.run_forever()
|
LOOP.run_forever()
|
||||||
|
|
||||||
thread = threading.Thread(
|
threading.Thread(target=loop_thread, name="asyncio_loop", daemon=True).start()
|
||||||
target=loop_thread,
|
ready.wait()
|
||||||
name='asyncio_loop',
|
|
||||||
daemon=True,
|
|
||||||
)
|
|
||||||
thread.start()
|
|
||||||
|
|
||||||
|
|
||||||
init()
|
init()
|
||||||
|
|||||||
@@ -13,11 +13,16 @@ import asyncio
|
|||||||
import ipaddress
|
import ipaddress
|
||||||
from itertools import cycle
|
from itertools import cycle
|
||||||
|
|
||||||
import httpx
|
from curl_cffi import CurlHttpVersion
|
||||||
|
from curl_cffi.requests.exceptions import (
|
||||||
|
ConnectionError as CurlConnectionError,
|
||||||
|
ProxyError,
|
||||||
|
RequestException,
|
||||||
|
)
|
||||||
|
|
||||||
from searx import logger, sxng_debug
|
from searx import logger, sxng_debug
|
||||||
from searx.extended_types import SXNG_Response
|
from searx.extended_types import SXNG_Response
|
||||||
from .client import new_client, get_loop, AsyncHTTPTransportNoHttp
|
from .client import DEFAULT_IMPERSONATE, AsyncClient, new_client, get_loop
|
||||||
from .raise_for_httperror import raise_for_httperror
|
from .raise_for_httperror import raise_for_httperror
|
||||||
|
|
||||||
|
|
||||||
@@ -48,9 +53,8 @@ class Network:
|
|||||||
'enable_http',
|
'enable_http',
|
||||||
'verify',
|
'verify',
|
||||||
'enable_http2',
|
'enable_http2',
|
||||||
|
'enable_http3',
|
||||||
'max_connections',
|
'max_connections',
|
||||||
'max_keepalive_connections',
|
|
||||||
'keepalive_expiry',
|
|
||||||
'local_addresses',
|
'local_addresses',
|
||||||
'proxies',
|
'proxies',
|
||||||
'using_tor_proxy',
|
'using_tor_proxy',
|
||||||
@@ -64,6 +68,7 @@ class Network:
|
|||||||
)
|
)
|
||||||
|
|
||||||
_TOR_CHECK_RESULT = {}
|
_TOR_CHECK_RESULT = {}
|
||||||
|
_CLIENT_KWARGS = ('verify', 'max_redirects', 'impersonate', 'curl_options', 'enable_http3')
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
# pylint: disable=too-many-arguments
|
# pylint: disable=too-many-arguments
|
||||||
@@ -71,9 +76,8 @@ class Network:
|
|||||||
enable_http: bool = True,
|
enable_http: bool = True,
|
||||||
verify: bool = True,
|
verify: bool = True,
|
||||||
enable_http2: bool = False,
|
enable_http2: bool = False,
|
||||||
|
enable_http3: bool = False,
|
||||||
max_connections: int = None, # pyright: ignore[reportArgumentType]
|
max_connections: int = None, # pyright: ignore[reportArgumentType]
|
||||||
max_keepalive_connections: int = None, # pyright: ignore[reportArgumentType]
|
|
||||||
keepalive_expiry: float = None, # pyright: ignore[reportArgumentType]
|
|
||||||
proxies: str | dict[str, str] | None = None,
|
proxies: str | dict[str, str] | None = None,
|
||||||
using_tor_proxy: bool = False,
|
using_tor_proxy: bool = False,
|
||||||
local_addresses: str | list[str] | None = None,
|
local_addresses: str | list[str] | None = None,
|
||||||
@@ -86,9 +90,8 @@ class Network:
|
|||||||
self.enable_http = enable_http
|
self.enable_http = enable_http
|
||||||
self.verify = verify
|
self.verify = verify
|
||||||
self.enable_http2 = enable_http2
|
self.enable_http2 = enable_http2
|
||||||
|
self.enable_http3 = enable_http3
|
||||||
self.max_connections = max_connections
|
self.max_connections = max_connections
|
||||||
self.max_keepalive_connections = max_keepalive_connections
|
|
||||||
self.keepalive_expiry = keepalive_expiry
|
|
||||||
self.proxies = proxies
|
self.proxies = proxies
|
||||||
self.using_tor_proxy = using_tor_proxy
|
self.using_tor_proxy = using_tor_proxy
|
||||||
self.local_addresses = local_addresses
|
self.local_addresses = local_addresses
|
||||||
@@ -137,7 +140,6 @@ class Network:
|
|||||||
def iter_proxies(self) -> Generator[tuple[str, list[str]]]:
|
def iter_proxies(self) -> Generator[tuple[str, list[str]]]:
|
||||||
if not self.proxies:
|
if not self.proxies:
|
||||||
return
|
return
|
||||||
# https://www.python-httpx.org/compatibility/#proxy-keys
|
|
||||||
if isinstance(self.proxies, str):
|
if isinstance(self.proxies, str):
|
||||||
yield 'all://', [self.proxies]
|
yield 'all://', [self.proxies]
|
||||||
else:
|
else:
|
||||||
@@ -155,62 +157,73 @@ class Network:
|
|||||||
# pylint: disable=stop-iteration-return
|
# pylint: disable=stop-iteration-return
|
||||||
yield tuple((pattern, next(proxy_url_cycle)) for pattern, proxy_url_cycle in proxy_settings.items())
|
yield tuple((pattern, next(proxy_url_cycle)) for pattern, proxy_url_cycle in proxy_settings.items())
|
||||||
|
|
||||||
async def log_response(self, response: httpx.Response):
|
_HTTP_VERSION = {
|
||||||
|
int(CurlHttpVersion.V1_0): "HTTP/1.0",
|
||||||
|
int(CurlHttpVersion.V1_1): "HTTP/1.1",
|
||||||
|
int(CurlHttpVersion.V2_0): "HTTP/2",
|
||||||
|
int(CurlHttpVersion.V2TLS): "HTTP/2",
|
||||||
|
int(CurlHttpVersion.V2_PRIOR_KNOWLEDGE): "HTTP/2",
|
||||||
|
int(CurlHttpVersion.V3): "HTTP/3",
|
||||||
|
int(CurlHttpVersion.V3ONLY): "HTTP/3",
|
||||||
|
}
|
||||||
|
|
||||||
|
async def log_response(self, response: SXNG_Response):
|
||||||
request = response.request
|
request = response.request
|
||||||
status = f"{response.status_code} {response.reason_phrase}"
|
http_version = self._HTTP_VERSION.get(response.http_version, str(response.http_version))
|
||||||
response_line = f"{response.http_version} {status}"
|
status = f"{response.status_code} {response.reason}"
|
||||||
|
response_line = f"{http_version} {status}"
|
||||||
content_type = response.headers.get("Content-Type")
|
content_type = response.headers.get("Content-Type")
|
||||||
content_type = f' ({content_type})' if content_type else ''
|
content_type = f' ({content_type})' if content_type else ''
|
||||||
self._logger.debug(f'HTTP Request: {request.method} {request.url} "{response_line}"{content_type}')
|
method = request.method if request else "?"
|
||||||
|
url = request.url if request else response.url
|
||||||
|
self._logger.debug(f'HTTP Request: {method} {url} "{response_line}"{content_type}')
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
async def check_tor_proxy(client: httpx.AsyncClient, proxies) -> bool:
|
async def check_tor_proxy(client: AsyncClient, proxies) -> bool:
|
||||||
if proxies in Network._TOR_CHECK_RESULT:
|
if proxies in Network._TOR_CHECK_RESULT:
|
||||||
return Network._TOR_CHECK_RESULT[proxies]
|
return Network._TOR_CHECK_RESULT[proxies]
|
||||||
|
|
||||||
result = True
|
if not proxies or not all(url.startswith('socks5h://') for _, url in proxies):
|
||||||
# ignore client._transport because it is not used with all://
|
Network._TOR_CHECK_RESULT[proxies] = False
|
||||||
for transport in client._mounts.values(): # pylint: disable=protected-access
|
|
||||||
if isinstance(transport, AsyncHTTPTransportNoHttp):
|
|
||||||
continue
|
|
||||||
if getattr(transport, "_pool") and getattr(
|
|
||||||
# pylint: disable=protected-access
|
|
||||||
transport._pool, # type: ignore
|
|
||||||
"_rdns",
|
|
||||||
False,
|
|
||||||
):
|
|
||||||
continue
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
response = await client.get("https://check.torproject.org/api/ip", timeout=60)
|
response = await client.get("https://check.torproject.org/api/ip", timeout=60)
|
||||||
if not response.json()["IsTor"]:
|
result = bool(response.json()["IsTor"])
|
||||||
result = False
|
|
||||||
Network._TOR_CHECK_RESULT[proxies] = result
|
Network._TOR_CHECK_RESULT[proxies] = result
|
||||||
return result
|
return result
|
||||||
|
|
||||||
async def get_client(self, verify: bool | None = None, max_redirects: int | None = None) -> httpx.AsyncClient:
|
async def get_client(
|
||||||
|
self,
|
||||||
|
verify: bool | None = None,
|
||||||
|
max_redirects: int | None = None,
|
||||||
|
impersonate: str | None = None,
|
||||||
|
curl_options: dict[int, t.Any] | None = None,
|
||||||
|
enable_http3: bool | None = None,
|
||||||
|
) -> AsyncClient:
|
||||||
verify = self.verify if verify is None else verify
|
verify = self.verify if verify is None else verify
|
||||||
max_redirects = self.max_redirects if max_redirects is None else max_redirects
|
max_redirects = self.max_redirects if max_redirects is None else max_redirects
|
||||||
|
impersonate = impersonate or DEFAULT_IMPERSONATE
|
||||||
|
enable_http3 = self.enable_http3 if enable_http3 is None else enable_http3
|
||||||
local_address = next(self._local_addresses_cycle)
|
local_address = next(self._local_addresses_cycle)
|
||||||
proxies = next(self._proxies_cycle) # is a tuple so it can be part of the key
|
proxies = next(self._proxies_cycle) # is a tuple so it can be part of the key
|
||||||
key = (verify, max_redirects, local_address, proxies)
|
curl_key = tuple(sorted((int(k), v) for k, v in (curl_options or {}).items()))
|
||||||
hook_log_response = self.log_response if sxng_debug else None
|
key = (verify, max_redirects, local_address, proxies, impersonate, curl_key, enable_http3)
|
||||||
if key not in self._clients or self._clients[key].is_closed:
|
if key not in self._clients or self._clients[key].is_closed:
|
||||||
client = new_client(
|
client = new_client(
|
||||||
self.enable_http,
|
self.enable_http,
|
||||||
verify,
|
verify,
|
||||||
self.enable_http2,
|
self.enable_http2,
|
||||||
|
enable_http3,
|
||||||
self.max_connections,
|
self.max_connections,
|
||||||
self.max_keepalive_connections,
|
|
||||||
self.keepalive_expiry,
|
|
||||||
dict(proxies),
|
dict(proxies),
|
||||||
local_address,
|
local_address,
|
||||||
0,
|
|
||||||
max_redirects,
|
max_redirects,
|
||||||
hook_log_response,
|
impersonate=impersonate,
|
||||||
|
curl_options=curl_options,
|
||||||
)
|
)
|
||||||
if self.using_tor_proxy and not await self.check_tor_proxy(client, proxies):
|
if self.using_tor_proxy and not await self.check_tor_proxy(client, proxies):
|
||||||
await client.aclose()
|
await client.aclose()
|
||||||
raise httpx.ProxyError('Network configuration problem: not using Tor')
|
raise ProxyError('Network configuration problem: not using Tor')
|
||||||
self._clients[key] = client
|
self._clients[key] = client
|
||||||
return self._clients[key]
|
return self._clients[key]
|
||||||
|
|
||||||
@@ -218,22 +231,14 @@ class Network:
|
|||||||
async def close_client(client):
|
async def close_client(client):
|
||||||
try:
|
try:
|
||||||
await client.aclose()
|
await client.aclose()
|
||||||
except httpx.HTTPError:
|
except RequestException:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
await asyncio.gather(*[close_client(client) for client in self._clients.values()], return_exceptions=False)
|
await asyncio.gather(*[close_client(client) for client in self._clients.values()], return_exceptions=False)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def extract_kwargs_clients(kwargs: dict[str, t.Any]) -> dict[str, t.Any]:
|
def extract_kwargs_clients(kwargs: dict[str, t.Any]) -> dict[str, t.Any]:
|
||||||
kwargs_clients: dict[str, t.Any] = {}
|
return {key: kwargs.pop(key) for key in Network._CLIENT_KWARGS if key in kwargs}
|
||||||
if 'verify' in kwargs:
|
|
||||||
kwargs_clients['verify'] = kwargs.pop('verify')
|
|
||||||
if 'max_redirects' in kwargs:
|
|
||||||
kwargs_clients['max_redirects'] = kwargs.pop('max_redirects')
|
|
||||||
if 'allow_redirects' in kwargs:
|
|
||||||
# see https://github.com/encode/httpx/pull/1808
|
|
||||||
kwargs['follow_redirects'] = kwargs.pop('allow_redirects')
|
|
||||||
return kwargs_clients
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def extract_do_raise_for_httperror(kwargs: dict[str, t.Any]):
|
def extract_do_raise_for_httperror(kwargs: dict[str, t.Any]):
|
||||||
@@ -243,23 +248,18 @@ class Network:
|
|||||||
del kwargs['raise_for_httperror']
|
del kwargs['raise_for_httperror']
|
||||||
return do_raise_for_httperror
|
return do_raise_for_httperror
|
||||||
|
|
||||||
def patch_response(self, response: httpx.Response, do_raise_for_httperror: bool) -> SXNG_Response:
|
def patch_response(self, response: SXNG_Response, do_raise_for_httperror: bool) -> SXNG_Response:
|
||||||
if isinstance(response, httpx.Response):
|
|
||||||
response = t.cast(SXNG_Response, response)
|
|
||||||
# requests compatibility (response is not streamed)
|
|
||||||
# see also https://www.python-httpx.org/compatibility/#checking-for-4xx5xx-responses
|
|
||||||
response.ok = not response.is_error
|
|
||||||
|
|
||||||
# raise an exception
|
|
||||||
if do_raise_for_httperror:
|
if do_raise_for_httperror:
|
||||||
try:
|
try:
|
||||||
raise_for_httperror(response)
|
raise_for_httperror(response)
|
||||||
except:
|
except:
|
||||||
self._logger.warning(f"HTTP Request failed: {response.request.method} {response.request.url}")
|
method = response.request.method if response.request else "?"
|
||||||
|
url = response.request.url if response.request else response.url
|
||||||
|
self._logger.warning(f"HTTP Request failed: {method} {url}")
|
||||||
raise
|
raise
|
||||||
return response
|
return response
|
||||||
|
|
||||||
def is_valid_response(self, response: httpx.Response):
|
def is_valid_response(self, response: SXNG_Response):
|
||||||
# pylint: disable=too-many-boolean-expressions
|
# pylint: disable=too-many-boolean-expressions
|
||||||
if (
|
if (
|
||||||
(self.retry_on_http_error is True and 400 <= response.status_code <= 599)
|
(self.retry_on_http_error is True and 400 <= response.status_code <= 599)
|
||||||
@@ -276,26 +276,29 @@ class Network:
|
|||||||
kwargs_clients = Network.extract_kwargs_clients(kwargs)
|
kwargs_clients = Network.extract_kwargs_clients(kwargs)
|
||||||
while retries >= 0: # pragma: no cover
|
while retries >= 0: # pragma: no cover
|
||||||
client = await self.get_client(**kwargs_clients)
|
client = await self.get_client(**kwargs_clients)
|
||||||
cookies = kwargs.pop("cookies", None)
|
|
||||||
client.cookies = httpx.Cookies(cookies)
|
|
||||||
try:
|
try:
|
||||||
|
method = method.upper()
|
||||||
|
client.check_url(url)
|
||||||
if stream:
|
if stream:
|
||||||
return client.stream(method, url, **kwargs)
|
return client.stream(method, url, **kwargs)
|
||||||
|
|
||||||
response = await client.request(method, url, **kwargs)
|
response = await client.request(method, url, **kwargs)
|
||||||
|
if sxng_debug:
|
||||||
|
await self.log_response(response)
|
||||||
if self.is_valid_response(response) or retries <= 0:
|
if self.is_valid_response(response) or retries <= 0:
|
||||||
return self.patch_response(response, do_raise_for_httperror)
|
return self.patch_response(response, do_raise_for_httperror)
|
||||||
except httpx.RemoteProtocolError as e:
|
await client.aclose()
|
||||||
|
except CurlConnectionError as e:
|
||||||
if not was_disconnected:
|
if not was_disconnected:
|
||||||
# the server has closed the connection:
|
# the server has closed the connection:
|
||||||
# try again without decreasing the retries variable & with a new HTTP client
|
# try again without decreasing the retries variable & with a new HTTP client
|
||||||
was_disconnected = True
|
was_disconnected = True
|
||||||
await client.aclose()
|
await client.aclose()
|
||||||
self._logger.warning('httpx.RemoteProtocolError: the server has disconnected, retrying')
|
self._logger.warning('ConnectionError: the server has disconnected, retrying')
|
||||||
continue
|
continue
|
||||||
if retries <= 0:
|
if retries <= 0:
|
||||||
raise e
|
raise e
|
||||||
except (httpx.RequestError, httpx.HTTPStatusError) as e:
|
except RequestException as e:
|
||||||
if retries <= 0:
|
if retries <= 0:
|
||||||
raise e
|
raise e
|
||||||
retries -= 1
|
retries -= 1
|
||||||
@@ -346,15 +349,12 @@ def initialize(
|
|||||||
settings_engines = settings_engines or settings['engines']
|
settings_engines = settings_engines or settings['engines']
|
||||||
settings_outgoing = settings_outgoing or settings['outgoing']
|
settings_outgoing = settings_outgoing or settings['outgoing']
|
||||||
|
|
||||||
# default parameters for AsyncHTTPTransport
|
|
||||||
# see https://github.com/encode/httpx/blob/e05a5372eb6172287458b37447c30f650047e1b8/httpx/_transports/default.py#L108-L121 # pylint: disable=line-too-long
|
|
||||||
default_params: dict[str, t.Any] = {
|
default_params: dict[str, t.Any] = {
|
||||||
'enable_http': False,
|
'enable_http': False,
|
||||||
'verify': settings_outgoing['verify'],
|
'verify': settings_outgoing['verify'],
|
||||||
'enable_http2': settings_outgoing['enable_http2'],
|
'enable_http2': settings_outgoing['enable_http2'],
|
||||||
|
'enable_http3': False,
|
||||||
'max_connections': settings_outgoing['pool_connections'],
|
'max_connections': settings_outgoing['pool_connections'],
|
||||||
'max_keepalive_connections': settings_outgoing['pool_maxsize'],
|
|
||||||
'keepalive_expiry': settings_outgoing['keepalive_expiry'],
|
|
||||||
'local_addresses': settings_outgoing['source_ips'],
|
'local_addresses': settings_outgoing['source_ips'],
|
||||||
'using_tor_proxy': settings_outgoing['using_tor_proxy'],
|
'using_tor_proxy': settings_outgoing['using_tor_proxy'],
|
||||||
'proxies': settings_outgoing['proxies'],
|
'proxies': settings_outgoing['proxies'],
|
||||||
@@ -424,9 +424,6 @@ def initialize(
|
|||||||
def done():
|
def done():
|
||||||
"""Close all HTTP client
|
"""Close all HTTP client
|
||||||
|
|
||||||
Avoid a warning at exit
|
|
||||||
See https://github.com/encode/httpx/pull/2026
|
|
||||||
|
|
||||||
Note: since Network.aclose has to be async, it is not possible to call this method on Network.__del__
|
Note: since Network.aclose has to be async, it is not possible to call this method on Network.__del__
|
||||||
So Network.aclose is called here using atexit.register
|
So Network.aclose is called here using atexit.register
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -59,13 +59,10 @@ def raise_for_captcha(resp: "SXNG_Response"):
|
|||||||
|
|
||||||
|
|
||||||
def raise_for_httperror(resp: "SXNG_Response") -> None:
|
def raise_for_httperror(resp: "SXNG_Response") -> None:
|
||||||
"""Raise exception for an HTTP response is an error.
|
"""Raise an exception if the HTTP response is an error.
|
||||||
|
|
||||||
Args:
|
|
||||||
resp (requests.Response): Response to check
|
|
||||||
|
|
||||||
Raises:
|
Raises:
|
||||||
requests.HTTPError: raise by resp.raise_for_status()
|
curl_cffi.requests.exceptions.HTTPError: raised by resp.raise_for_status()
|
||||||
searx.exceptions.SearxEngineAccessDeniedException: raise when the HTTP status code is 402 or 403.
|
searx.exceptions.SearxEngineAccessDeniedException: raise when the HTTP status code is 402 or 403.
|
||||||
searx.exceptions.SearxEngineTooManyRequestsException: raise when the HTTP status code is 429.
|
searx.exceptions.SearxEngineTooManyRequestsException: raise when the HTTP status code is 429.
|
||||||
searx.exceptions.SearxEngineCaptchaException: raise when if CATPCHA challenge is detected.
|
searx.exceptions.SearxEngineCaptchaException: raise when if CATPCHA challenge is detected.
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import typing
|
|||||||
|
|
||||||
import re
|
import re
|
||||||
from flask_babel import gettext
|
from flask_babel import gettext
|
||||||
from httpx import HTTPError
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
|
|
||||||
from searx.network import get
|
from searx.network import get
|
||||||
from searx.plugins import Plugin, PluginInfo
|
from searx.plugins import Plugin, PluginInfo
|
||||||
@@ -59,7 +59,7 @@ class SXNGPlugin(Plugin):
|
|||||||
resp = get(url_exit_list)
|
resp = get(url_exit_list)
|
||||||
node_list = re.findall(reg, resp.text) # type: ignore
|
node_list = re.findall(reg, resp.text) # type: ignore
|
||||||
|
|
||||||
except HTTPError:
|
except RequestException:
|
||||||
# No answer, return error
|
# No answer, return error
|
||||||
msg = gettext("Could not download the list of Tor exit-nodes from")
|
msg = gettext("Could not download the list of Tor exit-nodes from")
|
||||||
results.add(results.types.Answer(answer=f"{msg} {url_exit_list}"))
|
results.add(results.types.Answer(answer=f"{msg} {url_exit_list}"))
|
||||||
|
|||||||
@@ -8,10 +8,9 @@ import typing as t
|
|||||||
from timeit import default_timer
|
from timeit import default_timer
|
||||||
import asyncio
|
import asyncio
|
||||||
import ssl
|
import ssl
|
||||||
import httpx
|
from curl_cffi.requests.exceptions import RequestException, Timeout
|
||||||
|
|
||||||
import searx.network
|
import searx.network
|
||||||
from searx.utils import gen_useragent
|
|
||||||
from searx.exceptions import (
|
from searx.exceptions import (
|
||||||
SearxEngineAccessDeniedException,
|
SearxEngineAccessDeniedException,
|
||||||
SearxEngineCaptchaException,
|
SearxEngineCaptchaException,
|
||||||
@@ -39,21 +38,21 @@ class HTTPParams(t.TypedDict):
|
|||||||
"""Sending `form encoded data`_.
|
"""Sending `form encoded data`_.
|
||||||
|
|
||||||
.. _form encoded data:
|
.. _form encoded data:
|
||||||
https://www.python-httpx.org/quickstart/#sending-form-encoded-data
|
https://curl-cffi.readthedocs.io/en/latest/quick_start.html#form-submit
|
||||||
"""
|
"""
|
||||||
|
|
||||||
json: dict[str, t.Any]
|
json: dict[str, t.Any]
|
||||||
"""`Sending `JSON encoded data`_.
|
"""`Sending `JSON encoded data`_.
|
||||||
|
|
||||||
.. _JSON encoded data:
|
.. _JSON encoded data:
|
||||||
https://www.python-httpx.org/quickstart/#sending-json-encoded-data
|
https://curl-cffi.readthedocs.io/en/latest/quick_start.html#posting-json
|
||||||
"""
|
"""
|
||||||
|
|
||||||
content: bytes
|
content: bytes
|
||||||
"""`Sending `binary request data`_.
|
"""`Sending `binary request data`_.
|
||||||
|
|
||||||
.. _binary request data:
|
.. _binary request data:
|
||||||
https://www.python-httpx.org/quickstart/#sending-json-encoded-data
|
https://curl-cffi.readthedocs.io/en/latest/quick_start.html#binary-data
|
||||||
"""
|
"""
|
||||||
|
|
||||||
url: str | None
|
url: str | None
|
||||||
@@ -71,13 +70,13 @@ class HTTPParams(t.TypedDict):
|
|||||||
soft_max_redirects: int
|
soft_max_redirects: int
|
||||||
"""Maximum redirects, soft limit. Record an error but don't stop the engine."""
|
"""Maximum redirects, soft limit. Record an error but don't stop the engine."""
|
||||||
|
|
||||||
verify: None | t.Literal[False] | str # not sure str really works
|
verify: None | t.Literal[False] | str
|
||||||
"""If not ``None``, it overrides the verify value defined in the network. Use
|
"""If not ``None``, it overrides the verify value defined in the network. Use
|
||||||
``False`` to accept any server certificate and use a path to file to specify a
|
``False`` to accept any server certificate and use a path to file to specify a
|
||||||
server certificate"""
|
server certificate"""
|
||||||
|
|
||||||
auth: str | None
|
auth: tuple[str, str] | None
|
||||||
"""An authentication to use when sending requests."""
|
"""Basic auth credentials ``(username, password)``."""
|
||||||
|
|
||||||
raise_for_httperror: bool
|
raise_for_httperror: bool
|
||||||
"""Raise an exception if the `HTTP response status code`_ is ``>= 300``.
|
"""Raise an exception if the `HTTP response status code`_ is ``>= 300``.
|
||||||
@@ -86,6 +85,12 @@ class HTTPParams(t.TypedDict):
|
|||||||
https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status
|
https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
impersonate: t.NotRequired[str]
|
||||||
|
"""curl_cffi impersonate target. Default: ``chrome``."""
|
||||||
|
|
||||||
|
curl_options: t.NotRequired[dict[int, t.Any]]
|
||||||
|
"""Any extra libcurl options for the request."""
|
||||||
|
|
||||||
|
|
||||||
class OnlineParams(HTTPParams, RequestParams):
|
class OnlineParams(HTTPParams, RequestParams):
|
||||||
"""Request parameters of a ``online`` engine."""
|
"""Request parameters of a ``online`` engine."""
|
||||||
@@ -141,13 +146,6 @@ class OnlineProcessor(EngineProcessor):
|
|||||||
params: OnlineParams = {**default_request_params(), **base_params}
|
params: OnlineParams = {**default_request_params(), **base_params}
|
||||||
|
|
||||||
headers = params["headers"]
|
headers = params["headers"]
|
||||||
headers["Accept-Encoding"] = "gzip, deflate"
|
|
||||||
headers["Cache-Control"] = "no-cache"
|
|
||||||
headers["DNT"] = "1"
|
|
||||||
headers["Connection"] = "keep-alive"
|
|
||||||
|
|
||||||
# add an user agent
|
|
||||||
headers["User-Agent"] = gen_useragent()
|
|
||||||
|
|
||||||
# add Accept-Language header
|
# add Accept-Language header
|
||||||
# https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language
|
# https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language
|
||||||
@@ -171,6 +169,9 @@ class OnlineProcessor(EngineProcessor):
|
|||||||
"cookies": params["cookies"],
|
"cookies": params["cookies"],
|
||||||
"auth": params["auth"],
|
"auth": params["auth"],
|
||||||
}
|
}
|
||||||
|
for key in ("curl_options", "impersonate"):
|
||||||
|
if params.get(key):
|
||||||
|
request_args[key] = params[key]
|
||||||
|
|
||||||
verify = params.get("verify")
|
verify = params.get("verify")
|
||||||
if verify is not None:
|
if verify is not None:
|
||||||
@@ -211,7 +212,7 @@ class OnlineProcessor(EngineProcessor):
|
|||||||
# unexpected redirect : record an error
|
# unexpected redirect : record an error
|
||||||
# but the engine might still return valid results.
|
# but the engine might still return valid results.
|
||||||
status_code = str(response.status_code or "")
|
status_code = str(response.status_code or "")
|
||||||
reason = response.reason_phrase or ""
|
reason = response.reason or ""
|
||||||
hostname = response.url.host
|
hostname = response.url.host
|
||||||
count_error(
|
count_error(
|
||||||
self.engine.name,
|
self.engine.name,
|
||||||
@@ -256,7 +257,7 @@ class OnlineProcessor(EngineProcessor):
|
|||||||
# requests timeout (connect or read)
|
# requests timeout (connect or read)
|
||||||
self.handle_exception(result_container, e, suspend=True)
|
self.handle_exception(result_container, e, suspend=True)
|
||||||
self.logger.debug("SSLError {}, verify={}".format(e, searx.network.get_network(self.engine.name).verify))
|
self.logger.debug("SSLError {}, verify={}".format(e, searx.network.get_network(self.engine.name).verify))
|
||||||
except (httpx.TimeoutException, asyncio.TimeoutError) as e:
|
except (Timeout, asyncio.TimeoutError) as e:
|
||||||
# requests timeout (connect or read)
|
# requests timeout (connect or read)
|
||||||
self.handle_exception(result_container, e, suspend=True)
|
self.handle_exception(result_container, e, suspend=True)
|
||||||
self.logger.debug(
|
self.logger.debug(
|
||||||
@@ -264,7 +265,7 @@ class OnlineProcessor(EngineProcessor):
|
|||||||
default_timer() - start_time, timeout_limit, e.__class__.__name__
|
default_timer() - start_time, timeout_limit, e.__class__.__name__
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
except (httpx.HTTPError, httpx.StreamError) as e:
|
except RequestException as e:
|
||||||
# other requests exception
|
# other requests exception
|
||||||
self.handle_exception(result_container, e, suspend=True)
|
self.handle_exception(result_container, e, suspend=True)
|
||||||
self.logger.debug(
|
self.logger.debug(
|
||||||
|
|||||||
@@ -183,20 +183,13 @@ outgoing:
|
|||||||
useragent_suffix: ""
|
useragent_suffix: ""
|
||||||
# The maximum number of concurrent connections that may be established.
|
# The maximum number of concurrent connections that may be established.
|
||||||
pool_connections: 100
|
pool_connections: 100
|
||||||
# Allow the connection pool to maintain keep-alive connections below this
|
# Enables the use of HTTP2
|
||||||
# point.
|
|
||||||
pool_maxsize: 20
|
|
||||||
# See https://www.python-httpx.org/http2/
|
|
||||||
enable_http2: true
|
enable_http2: true
|
||||||
# uncomment below section if you want to use a custom server certificate
|
# uncomment below section if you want to use a custom server certificate
|
||||||
# see https://www.python-httpx.org/advanced/#changing-the-verification-defaults
|
# see https://curl-cffi.readthedocs.io/en/latest/quick_start.html
|
||||||
# and https://www.python-httpx.org/compatibility/#ssl-configuration
|
|
||||||
# verify: ~/.mitmproxy/mitmproxy-ca-cert.cer
|
# verify: ~/.mitmproxy/mitmproxy-ca-cert.cer
|
||||||
#
|
#
|
||||||
# uncomment below section if you want to use a proxyq see: SOCKS proxies
|
# uncomment below section if you want to use a proxy
|
||||||
# https://2.python-requests.org/en/latest/user/advanced/#proxies
|
|
||||||
# are also supported: see
|
|
||||||
# https://2.python-requests.org/en/latest/user/advanced/#socks
|
|
||||||
#
|
#
|
||||||
# proxies:
|
# proxies:
|
||||||
# all://:
|
# all://:
|
||||||
|
|||||||
@@ -253,8 +253,6 @@ SCHEMA: dict[str, t.Any] = {
|
|||||||
'verify': SettingsValue((bool, str), True),
|
'verify': SettingsValue((bool, str), True),
|
||||||
'max_request_timeout': SettingsValue((None, numbers.Real), None),
|
'max_request_timeout': SettingsValue((None, numbers.Real), None),
|
||||||
'pool_connections': SettingsValue(int, 100),
|
'pool_connections': SettingsValue(int, 100),
|
||||||
'pool_maxsize': SettingsValue(int, 10),
|
|
||||||
'keepalive_expiry': SettingsValue(numbers.Real, 5.0),
|
|
||||||
# default maximum redirect
|
# default maximum redirect
|
||||||
# from https://github.com/psf/requests/blob/8c211a96cdbe9fe320d63d9e1ae15c5c07e179f8/requests/models.py#L55
|
# from https://github.com/psf/requests/blob/8c211a96cdbe9fe320d63d9e1ae15c5c07e179f8/requests/models.py#L55
|
||||||
'max_redirects': SettingsValue(int, 30),
|
'max_redirects': SettingsValue(int, 30),
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ import urllib.parse
|
|||||||
from urllib.parse import urlencode, urlparse, unquote
|
from urllib.parse import urlencode, urlparse, unquote
|
||||||
|
|
||||||
import warnings
|
import warnings
|
||||||
import httpx
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
|
|
||||||
from pygments import highlight
|
from pygments import highlight
|
||||||
from pygments.lexers import get_lexer_by_name
|
from pygments.lexers import get_lexer_by_name
|
||||||
@@ -1027,7 +1027,7 @@ def image_proxy():
|
|||||||
return '', 400
|
return '', 400
|
||||||
|
|
||||||
forward_resp = True
|
forward_resp = True
|
||||||
except httpx.HTTPError:
|
except RequestException:
|
||||||
logger.exception('HTTP error')
|
logger.exception('HTTP error')
|
||||||
return '', 400
|
return '', 400
|
||||||
finally:
|
finally:
|
||||||
@@ -1036,7 +1036,7 @@ def image_proxy():
|
|||||||
# we make sure to close the response between searxng and the HTTP server
|
# we make sure to close the response between searxng and the HTTP server
|
||||||
try:
|
try:
|
||||||
resp.close()
|
resp.close()
|
||||||
except httpx.HTTPError:
|
except RequestException:
|
||||||
logger.exception('HTTP error on closing')
|
logger.exception('HTTP error on closing')
|
||||||
|
|
||||||
def close_stream():
|
def close_stream():
|
||||||
@@ -1046,7 +1046,7 @@ def image_proxy():
|
|||||||
resp.close()
|
resp.close()
|
||||||
del resp
|
del resp
|
||||||
del stream
|
del stream
|
||||||
except httpx.HTTPError as e:
|
except RequestException as e:
|
||||||
logger.debug('Exception while closing response', e)
|
logger.debug('Exception while closing response', e)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -1054,7 +1054,7 @@ def image_proxy():
|
|||||||
response = Response(stream, mimetype=resp.headers['Content-Type'], headers=headers, direct_passthrough=True)
|
response = Response(stream, mimetype=resp.headers['Content-Type'], headers=headers, direct_passthrough=True)
|
||||||
response.call_on_close(close_stream)
|
response.call_on_close(close_stream)
|
||||||
return response
|
return response
|
||||||
except httpx.HTTPError:
|
except RequestException:
|
||||||
close_stream()
|
close_stream()
|
||||||
return '', 400
|
return '', 400
|
||||||
|
|
||||||
|
|||||||
@@ -42,18 +42,17 @@ exception_classname_to_text = {
|
|||||||
None: gettext('unexpected crash'),
|
None: gettext('unexpected crash'),
|
||||||
'timeout': timeout_text,
|
'timeout': timeout_text,
|
||||||
'asyncio.TimeoutError': timeout_text,
|
'asyncio.TimeoutError': timeout_text,
|
||||||
'httpx.TimeoutException': timeout_text,
|
'curl_cffi.requests.exceptions.Timeout': timeout_text,
|
||||||
'httpx.ConnectTimeout': timeout_text,
|
'curl_cffi.requests.exceptions.ConnectTimeout': timeout_text,
|
||||||
'httpx.ReadTimeout': timeout_text,
|
'curl_cffi.requests.exceptions.ReadTimeout': timeout_text,
|
||||||
'httpx.WriteTimeout': timeout_text,
|
'curl_cffi.requests.exceptions.HTTPError': gettext('HTTP error'),
|
||||||
'httpx.HTTPStatusError': gettext('HTTP error'),
|
'curl_cffi.requests.exceptions.ConnectionError': gettext("HTTP connection error"),
|
||||||
'httpx.ConnectError': gettext("HTTP connection error"),
|
'curl_cffi.requests.exceptions.DNSError': gettext("HTTP connection error"),
|
||||||
'httpx.RemoteProtocolError': http_protocol_error_text,
|
'curl_cffi.requests.exceptions.IncompleteRead': http_protocol_error_text,
|
||||||
'httpx.LocalProtocolError': http_protocol_error_text,
|
'curl_cffi.requests.exceptions.SSLError': ssl_cert_error_text,
|
||||||
'httpx.ProtocolError': http_protocol_error_text,
|
'curl_cffi.requests.exceptions.CertificateVerifyError': ssl_cert_error_text,
|
||||||
'httpx.ReadError': network_error_text,
|
'curl_cffi.requests.exceptions.ProxyError': gettext("proxy error"),
|
||||||
'httpx.WriteError': network_error_text,
|
'curl_cffi.requests.exceptions.RequestException': network_error_text,
|
||||||
'httpx.ProxyError': gettext("proxy error"),
|
|
||||||
'searx.exceptions.SearxEngineCaptchaException': gettext("CAPTCHA"),
|
'searx.exceptions.SearxEngineCaptchaException': gettext("CAPTCHA"),
|
||||||
'searx.exceptions.SearxEngineTooManyRequestsException': gettext("too many requests"),
|
'searx.exceptions.SearxEngineTooManyRequestsException': gettext("too many requests"),
|
||||||
'searx.exceptions.SearxEngineAccessDeniedException': gettext("access denied"),
|
'searx.exceptions.SearxEngineAccessDeniedException': gettext("access denied"),
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
|
# pylint: disable=missing-module-docstring,disable=missing-class-docstring,invalid-name
|
||||||
|
|
||||||
import httpx
|
from curl_cffi.requests.exceptions import RequestException
|
||||||
from mock import patch
|
from mock import Mock, patch
|
||||||
|
|
||||||
|
from searx.network.client import AsyncClient
|
||||||
from searx.network.network import Network, NETWORKS
|
from searx.network.network import Network, NETWORKS
|
||||||
from tests import SearxTestCase
|
from tests import SearxTestCase
|
||||||
|
|
||||||
@@ -83,11 +84,16 @@ class TestNetwork(SearxTestCase):
|
|||||||
self.assertEqual(len(kwargs), 2)
|
self.assertEqual(len(kwargs), 2)
|
||||||
|
|
||||||
self.assertEqual(kwargs['timeout'], 2)
|
self.assertEqual(kwargs['timeout'], 2)
|
||||||
self.assertEqual(kwargs['follow_redirects'], True)
|
self.assertEqual(kwargs['allow_redirects'], True)
|
||||||
|
|
||||||
self.assertTrue(kwargs_client['verify'])
|
self.assertTrue(kwargs_client['verify'])
|
||||||
self.assertEqual(kwargs_client['max_redirects'], 5)
|
self.assertEqual(kwargs_client['max_redirects'], 5)
|
||||||
|
|
||||||
|
kwargs = {'impersonate': 'chrome99_android', 'curl_options': {1: 'x'}, 'timeout': 1}
|
||||||
|
kwargs_client = Network.extract_kwargs_clients(kwargs)
|
||||||
|
self.assertEqual(kwargs_client, {'impersonate': 'chrome99_android', 'curl_options': {1: 'x'}})
|
||||||
|
self.assertEqual(kwargs, {'timeout': 1})
|
||||||
|
|
||||||
async def test_get_client(self):
|
async def test_get_client(self):
|
||||||
network = Network(verify=True)
|
network = Network(verify=True)
|
||||||
client1 = await network.get_client()
|
client1 = await network.get_client()
|
||||||
@@ -103,6 +109,9 @@ class TestNetwork(SearxTestCase):
|
|||||||
self.assertNotEqual(client1, client5)
|
self.assertNotEqual(client1, client5)
|
||||||
self.assertEqual(client3, client6)
|
self.assertEqual(client3, client6)
|
||||||
|
|
||||||
|
client7 = await network.get_client(impersonate="chrome99_android", enable_http3=True)
|
||||||
|
self.assertNotEqual(client1, client7)
|
||||||
|
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
async def test_aclose(self):
|
async def test_aclose(self):
|
||||||
@@ -112,8 +121,8 @@ class TestNetwork(SearxTestCase):
|
|||||||
|
|
||||||
async def test_request(self):
|
async def test_request(self):
|
||||||
a_text = 'Lorem Ipsum'
|
a_text = 'Lorem Ipsum'
|
||||||
response = httpx.Response(status_code=200, text=a_text)
|
response = Mock(status_code=200, text=a_text)
|
||||||
with patch.object(httpx.AsyncClient, 'request', return_value=response):
|
with patch.object(AsyncClient, 'request', return_value=response):
|
||||||
network = Network(enable_http=True)
|
network = Network(enable_http=True)
|
||||||
response = await network.request('GET', 'https://example.com/')
|
response = await network.request('GET', 'https://example.com/')
|
||||||
self.assertEqual(response.text, a_text)
|
self.assertEqual(response.text, a_text)
|
||||||
@@ -135,34 +144,34 @@ class TestNetworkRequestRetries(SearxTestCase):
|
|||||||
nonlocal first
|
nonlocal first
|
||||||
if first:
|
if first:
|
||||||
first = False
|
first = False
|
||||||
return httpx.Response(status_code=403, text=TestNetworkRequestRetries.TEXT)
|
return Mock(status_code=403, text=TestNetworkRequestRetries.TEXT)
|
||||||
return httpx.Response(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
return Mock(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
||||||
|
|
||||||
return get_response
|
return get_response
|
||||||
|
|
||||||
async def test_retries_ok(self):
|
async def test_retries_ok(self):
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
with patch.object(AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
||||||
network = Network(enable_http=True, retries=1, retry_on_http_error=403)
|
network = Network(enable_http=True, retries=1, retry_on_http_error=403)
|
||||||
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.text, TestNetworkRequestRetries.TEXT)
|
self.assertEqual(response.text, TestNetworkRequestRetries.TEXT)
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
async def test_retries_fail_int(self):
|
async def test_retries_fail_int(self):
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
with patch.object(AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
||||||
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
||||||
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.status_code, 403)
|
self.assertEqual(response.status_code, 403)
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
async def test_retries_fail_list(self):
|
async def test_retries_fail_list(self):
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
with patch.object(AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
||||||
network = Network(enable_http=True, retries=0, retry_on_http_error=[403, 429])
|
network = Network(enable_http=True, retries=0, retry_on_http_error=[403, 429])
|
||||||
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.status_code, 403)
|
self.assertEqual(response.status_code, 403)
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
async def test_retries_fail_bool(self):
|
async def test_retries_fail_bool(self):
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
with patch.object(AsyncClient, 'request', new=TestNetworkRequestRetries.get_response_404_then_200()):
|
||||||
network = Network(enable_http=True, retries=0, retry_on_http_error=True)
|
network = Network(enable_http=True, retries=0, retry_on_http_error=True)
|
||||||
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.status_code, 403)
|
self.assertEqual(response.status_code, 403)
|
||||||
@@ -175,10 +184,10 @@ class TestNetworkRequestRetries(SearxTestCase):
|
|||||||
nonlocal request_count
|
nonlocal request_count
|
||||||
request_count += 1
|
request_count += 1
|
||||||
if request_count < 3:
|
if request_count < 3:
|
||||||
raise httpx.RequestError('fake exception', request=None)
|
raise RequestException('fake exception')
|
||||||
return httpx.Response(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
return Mock(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
||||||
|
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=get_response):
|
with patch.object(AsyncClient, 'request', new=get_response):
|
||||||
network = Network(enable_http=True, retries=2)
|
network = Network(enable_http=True, retries=2)
|
||||||
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
@@ -187,11 +196,11 @@ class TestNetworkRequestRetries(SearxTestCase):
|
|||||||
|
|
||||||
async def test_retries_exception(self):
|
async def test_retries_exception(self):
|
||||||
async def get_response(*args, **kwargs):
|
async def get_response(*args, **kwargs):
|
||||||
raise httpx.RequestError('fake exception', request=None)
|
raise RequestException('fake exception')
|
||||||
|
|
||||||
with patch.object(httpx.AsyncClient, 'request', new=get_response):
|
with patch.object(AsyncClient, 'request', new=get_response):
|
||||||
network = Network(enable_http=True, retries=0)
|
network = Network(enable_http=True, retries=0)
|
||||||
with self.assertRaises(httpx.RequestError):
|
with self.assertRaises(RequestException):
|
||||||
await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
await network.request('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
@@ -211,22 +220,22 @@ class TestNetworkStreamRetries(SearxTestCase):
|
|||||||
nonlocal first
|
nonlocal first
|
||||||
if first:
|
if first:
|
||||||
first = False
|
first = False
|
||||||
raise httpx.RequestError('fake exception', request=None)
|
raise RequestException('fake exception')
|
||||||
return httpx.Response(status_code=200, text=TestNetworkStreamRetries.TEXT)
|
return Mock(status_code=200, text=TestNetworkStreamRetries.TEXT)
|
||||||
|
|
||||||
return stream
|
return stream
|
||||||
|
|
||||||
async def test_retries_ok(self):
|
async def test_retries_ok(self):
|
||||||
with patch.object(httpx.AsyncClient, 'stream', new=TestNetworkStreamRetries.get_response_exception_then_200()):
|
with patch.object(AsyncClient, 'stream', new=TestNetworkStreamRetries.get_response_exception_then_200()):
|
||||||
network = Network(enable_http=True, retries=1, retry_on_http_error=403)
|
network = Network(enable_http=True, retries=1, retry_on_http_error=403)
|
||||||
response = await network.stream('GET', 'https://example.com/')
|
response = await network.stream('GET', 'https://example.com/')
|
||||||
self.assertEqual(response.text, TestNetworkStreamRetries.TEXT)
|
self.assertEqual(response.text, TestNetworkStreamRetries.TEXT)
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
async def test_retries_fail(self):
|
async def test_retries_fail(self):
|
||||||
with patch.object(httpx.AsyncClient, 'stream', new=TestNetworkStreamRetries.get_response_exception_then_200()):
|
with patch.object(AsyncClient, 'stream', new=TestNetworkStreamRetries.get_response_exception_then_200()):
|
||||||
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
||||||
with self.assertRaises(httpx.RequestError):
|
with self.assertRaises(RequestException):
|
||||||
await network.stream('GET', 'https://example.com/')
|
await network.stream('GET', 'https://example.com/')
|
||||||
await network.aclose()
|
await network.aclose()
|
||||||
|
|
||||||
@@ -237,10 +246,10 @@ class TestNetworkStreamRetries(SearxTestCase):
|
|||||||
nonlocal first
|
nonlocal first
|
||||||
if first:
|
if first:
|
||||||
first = False
|
first = False
|
||||||
return httpx.Response(status_code=403, text=TestNetworkRequestRetries.TEXT)
|
return Mock(status_code=403, text=TestNetworkRequestRetries.TEXT)
|
||||||
return httpx.Response(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
return Mock(status_code=200, text=TestNetworkRequestRetries.TEXT)
|
||||||
|
|
||||||
with patch.object(httpx.AsyncClient, 'stream', new=stream):
|
with patch.object(AsyncClient, 'stream', new=stream):
|
||||||
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
network = Network(enable_http=True, retries=0, retry_on_http_error=403)
|
||||||
response = await network.stream('GET', 'https://example.com/', raise_for_httperror=False)
|
response = await network.stream('GET', 'https://example.com/', raise_for_httperror=False)
|
||||||
self.assertEqual(response.status_code, 403)
|
self.assertEqual(response.status_code, 403)
|
||||||
|
|||||||
@@ -35,4 +35,4 @@ class TestOnlineProcessor(SearxTestCase):
|
|||||||
online_processor = online.OnlineProcessor(engine)
|
online_processor = online.OnlineProcessor(engine)
|
||||||
search_query = SearchQuery('test', [EngineRef(TEST_ENGINE_NAME, 'general')], 'all', 0, 1, None, None, None)
|
search_query = SearchQuery('test', [EngineRef(TEST_ENGINE_NAME, 'general')], 'all', 0, 1, None, None, None)
|
||||||
params = self._get_params(online_processor, search_query, 'general')
|
params = self._get_params(online_processor, search_query, 'general')
|
||||||
self.assertIn('User-Agent', params['headers'])
|
self.assertNotIn('User-Agent', params['headers'])
|
||||||
|
|||||||
Reference in New Issue
Block a user