.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
Functions | Variables
searx.engines.duckduckgo Namespace Reference

Functions

 _cache_key (str query, str region)
 
 cache_vqd (str query, str region, str value)
 
 get_vqd (str query, str region, bool force_request=False)
 
 get_ddg_lang (EngineTraits eng_traits, sxng_locale, default='en_US')
 

Variables

logging logger .Logger
 
dict about
 
bool send_accept_language_header = True
 
list categories = ['general', 'web']
 
bool paging = True
 
bool time_range_support = True
 
bool safesearch = True
 
str url = "https://html.duckduckgo.com/html"
 
dict time_range_dict = {'day': 'd', 'week': 'w', 'month': 'm', 'year': 'y'}
 
dict form_data = {'v': 'l', 'api': 'd.js', 'o': 'json'}
 
list __CACHE = []
 
dict ddg_reg_map
 

Detailed Description

DuckDuckGo WEB
~~~~~~~~~~~~~~

Function Documentation

◆ _cache_key()

searx.engines.duckduckgo._cache_key ( str query,
str region )
protected

Definition at line 65 of file duckduckgo.py.

65def _cache_key(query: str, region: str):
66 return 'SearXNG_ddg_web_vqd' + redislib.secret_hash(f"{query}//{region}")
67
68

Referenced by searx.engines.duckduckgo.cache_vqd(), and searx.engines.duckduckgo.get_vqd().

+ Here is the caller graph for this function:

◆ cache_vqd()

searx.engines.duckduckgo.cache_vqd ( str query,
str region,
str value ) 
Caches a ``vqd`` value from a query.

Definition at line 69 of file duckduckgo.py.

69def cache_vqd(query: str, region: str, value: str):
70 """Caches a ``vqd`` value from a query."""
71 c = redisdb.client()
72 if c:
73 logger.debug("VALKEY cache vqd value: %s (%s)", value, region)
74 c.set(_cache_key(query, region), value, ex=600)
75
76 else:
77 logger.debug("MEM cache vqd value: %s (%s)", value, region)
78 if len(__CACHE) > 100: # cache vqd from last 100 queries
79 __CACHE.pop(0)
80 __CACHE.append((_cache_key(query, region), value))
81
82

References searx.engines.duckduckgo._cache_key().

Referenced by searx.engines.duckduckgo.get_vqd().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get_ddg_lang()

searx.engines.duckduckgo.get_ddg_lang ( EngineTraits eng_traits,
sxng_locale,
default = 'en_US' ) 
Get DuckDuckGo's language identifier from SearXNG's locale.

DuckDuckGo defines its languages by region codes (see
:py:obj:`fetch_traits`).

To get region and language of a DDG service use:

.. code: python

   eng_region = traits.get_region(params['searxng_locale'], traits.all_locale)
   eng_lang = get_ddg_lang(traits, params['searxng_locale'])

It might confuse, but the ``l`` value of the cookie is what SearXNG calls
the *region*:

.. code:: python

    # !ddi paris :es-AR --> {'ad': 'es_AR', 'ah': 'ar-es', 'l': 'ar-es'}
    params['cookies']['ad'] = eng_lang
    params['cookies']['ah'] = eng_region
    params['cookies']['l'] = eng_region

.. hint::

   `DDG-lite <https://lite.duckduckgo.com/lite>`__ and the *no Javascript*
   page https://html.duckduckgo.com/html do not offer a language selection
   to the user, only a region can be selected by the user (``eng_region``
   from the example above).  DDG-lite and *no Javascript* store the selected
   region in a cookie::

     params['cookies']['kl'] = eng_region  # 'ar-es'

Definition at line 142 of file duckduckgo.py.

142def get_ddg_lang(eng_traits: EngineTraits, sxng_locale, default='en_US'):
143 """Get DuckDuckGo's language identifier from SearXNG's locale.
144
145 DuckDuckGo defines its languages by region codes (see
146 :py:obj:`fetch_traits`).
147
148 To get region and language of a DDG service use:
149
150 .. code: python
151
152 eng_region = traits.get_region(params['searxng_locale'], traits.all_locale)
153 eng_lang = get_ddg_lang(traits, params['searxng_locale'])
154
155 It might confuse, but the ``l`` value of the cookie is what SearXNG calls
156 the *region*:
157
158 .. code:: python
159
160 # !ddi paris :es-AR --> {'ad': 'es_AR', 'ah': 'ar-es', 'l': 'ar-es'}
161 params['cookies']['ad'] = eng_lang
162 params['cookies']['ah'] = eng_region
163 params['cookies']['l'] = eng_region
164
165 .. hint::
166
167 `DDG-lite <https://lite.duckduckgo.com/lite>`__ and the *no Javascript*
168 page https://html.duckduckgo.com/html do not offer a language selection
169 to the user, only a region can be selected by the user (``eng_region``
170 from the example above). DDG-lite and *no Javascript* store the selected
171 region in a cookie::
172
173 params['cookies']['kl'] = eng_region # 'ar-es'
174
175 """
176 return eng_traits.custom['lang_region'].get( # type: ignore
177 sxng_locale, eng_traits.get_language(sxng_locale, default)
178 )
179
180

◆ get_vqd()

searx.engines.duckduckgo.get_vqd ( str query,
str region,
bool force_request = False ) 
Returns the ``vqd`` that fits to the *query*.

:param query: The query term
:param region: DDG's region code
:param force_request: force a request to get a vqd value from DDG

TL;DR; the ``vqd`` value is needed to pass DDG's bot protection and is used
by all request to DDG:

- DuckDuckGo Lite: ``https://lite.duckduckgo.com/lite`` (POST form data)
- DuckDuckGo Web: ``https://links.duckduckgo.com/d.js?q=...&vqd=...``
- DuckDuckGo Images: ``https://duckduckgo.com/i.js??q=...&vqd=...``
- DuckDuckGo Videos: ``https://duckduckgo.com/v.js??q=...&vqd=...``
- DuckDuckGo News: ``https://duckduckgo.com/news.js??q=...&vqd=...``

DDG's bot detection is sensitive to the ``vqd`` value.  For some search terms
(such as extremely long search terms that are often sent by bots), no ``vqd``
value can be determined.

If SearXNG cannot determine a ``vqd`` value, then no request should go out
to DDG.

.. attention::

   A request with a wrong ``vqd`` value leads to DDG temporarily putting
   SearXNG's IP on a block list.

Requests from IPs in this block list run into timeouts.  Not sure, but it
seems the block list is a sliding window: to get my IP rid from the bot list
I had to cool down my IP for 1h (send no requests from that IP to DDG).

Definition at line 83 of file duckduckgo.py.

83def get_vqd(query: str, region: str, force_request: bool = False):
84 """Returns the ``vqd`` that fits to the *query*.
85
86 :param query: The query term
87 :param region: DDG's region code
88 :param force_request: force a request to get a vqd value from DDG
89
90 TL;DR; the ``vqd`` value is needed to pass DDG's bot protection and is used
91 by all request to DDG:
92
93 - DuckDuckGo Lite: ``https://lite.duckduckgo.com/lite`` (POST form data)
94 - DuckDuckGo Web: ``https://links.duckduckgo.com/d.js?q=...&vqd=...``
95 - DuckDuckGo Images: ``https://duckduckgo.com/i.js??q=...&vqd=...``
96 - DuckDuckGo Videos: ``https://duckduckgo.com/v.js??q=...&vqd=...``
97 - DuckDuckGo News: ``https://duckduckgo.com/news.js??q=...&vqd=...``
98
99 DDG's bot detection is sensitive to the ``vqd`` value. For some search terms
100 (such as extremely long search terms that are often sent by bots), no ``vqd``
101 value can be determined.
102
103 If SearXNG cannot determine a ``vqd`` value, then no request should go out
104 to DDG.
105
106 .. attention::
107
108 A request with a wrong ``vqd`` value leads to DDG temporarily putting
109 SearXNG's IP on a block list.
110
111 Requests from IPs in this block list run into timeouts. Not sure, but it
112 seems the block list is a sliding window: to get my IP rid from the bot list
113 I had to cool down my IP for 1h (send no requests from that IP to DDG).
114 """
115 key = _cache_key(query, region)
116
117 c = redisdb.client()
118 if c:
119 value = c.get(key)
120 if value or value == b'':
121 value = value.decode('utf-8') # type: ignore
122 logger.debug("re-use CACHED vqd value: %s", value)
123 return value
124
125 for k, value in __CACHE:
126 if k == key:
127 logger.debug("MEM re-use CACHED vqd value: %s", value)
128 return value
129
130 if force_request:
131 resp = get(f'https://duckduckgo.com/?q={quote_plus(query)}')
132 if resp.status_code == 200: # type: ignore
133 value = extr(resp.text, 'vqd="', '"') # type: ignore
134 if value:
135 logger.debug("vqd value from DDG request: %s", value)
136 cache_vqd(query, region, value)
137 return value
138
139 return None
140
141

References searx.engines.duckduckgo._cache_key(), and searx.engines.duckduckgo.cache_vqd().

+ Here is the call graph for this function:

Variable Documentation

◆ __CACHE

list searx.engines.duckduckgo.__CACHE = []
private

Definition at line 62 of file duckduckgo.py.

◆ about

dict searx.engines.duckduckgo.about
Initial value:
1= {
2 "website": 'https://lite.duckduckgo.com/lite/',
3 "wikidata_id": 'Q12805',
4 "use_official_api": False,
5 "require_api_key": False,
6 "results": 'HTML',
7}

Definition at line 38 of file duckduckgo.py.

◆ categories

list searx.engines.duckduckgo.categories = ['general', 'web']

Definition at line 53 of file duckduckgo.py.

◆ ddg_reg_map

dict searx.engines.duckduckgo.ddg_reg_map
Initial value:
1= {
2 'tw-tzh': 'zh_TW',
3 'hk-tzh': 'zh_HK',
4 'ct-ca': 'skip', # ct-ca and es-ca both map to ca_ES
5 'es-ca': 'ca_ES',
6 'id-en': 'id_ID',
7 'no-no': 'nb_NO',
8 'jp-jp': 'ja_JP',
9 'kr-kr': 'ko_KR',
10 'xa-ar': 'ar_SA',
11 'sl-sl': 'sl_SI',
12 'th-en': 'th_TH',
13 'vn-en': 'vi_VN',
14}

Definition at line 181 of file duckduckgo.py.

◆ form_data

dict searx.engines.duckduckgo.form_data = {'v': 'l', 'api': 'd.js', 'o': 'json'}

Definition at line 61 of file duckduckgo.py.

◆ logger

logging searx.engines.duckduckgo.logger .Logger

Definition at line 34 of file duckduckgo.py.

◆ paging

bool searx.engines.duckduckgo.paging = True

Definition at line 54 of file duckduckgo.py.

◆ safesearch

bool searx.engines.duckduckgo.safesearch = True

Definition at line 56 of file duckduckgo.py.

◆ send_accept_language_header

bool searx.engines.duckduckgo.send_accept_language_header = True

Definition at line 46 of file duckduckgo.py.

◆ time_range_dict

dict searx.engines.duckduckgo.time_range_dict = {'day': 'd', 'week': 'w', 'month': 'm', 'year': 'y'}

Definition at line 60 of file duckduckgo.py.

◆ time_range_support

bool searx.engines.duckduckgo.time_range_support = True

Definition at line 55 of file duckduckgo.py.

◆ url

str searx.engines.duckduckgo.url = "https://html.duckduckgo.com/html"

Definition at line 58 of file duckduckgo.py.