10from urllib.parse
import quote_plus
32 "website":
'https://lite.duckduckgo.com/lite/',
33 "wikidata_id":
'Q12805',
34 "use_official_api":
False,
35 "require_api_key":
False,
39send_accept_language_header =
True
40"""DuckDuckGo-Lite tries to guess user's preferred language from the HTTP
41``Accept-Language``. Optional the user can select a region filter (but not a
46categories = [
'general',
'web']
48time_range_support =
True
51url =
"https://html.duckduckgo.com/html/"
53time_range_dict = {
'day':
'd',
'week':
'w',
'month':
'm',
'year':
'y'}
54form_data = {
'v':
'l',
'api':
'd.js',
'o':
'json'}
56_CACHE: EngineCache =
None
57"""Persistent (SQLite) key/value cache that deletes its values after ``expire``
68def get_vqd(query: str, region: str, force_request: bool =
False) -> str:
69 """Returns the ``vqd`` that fits to the *query*.
71 :param query: The query term
72 :param region: DDG's region code
73 :param force_request: force a request to get a vqd value from DDG
75 TL;DR; the ``vqd`` value is needed to pass DDG's bot protection and is used
76 by all request to DDG:
78 - DuckDuckGo Lite: ``https://lite.duckduckgo.com/lite`` (POST form data)
79 - DuckDuckGo Web: ``https://links.duckduckgo.com/d.js?q=...&vqd=...``
80 - DuckDuckGo Images: ``https://duckduckgo.com/i.js??q=...&vqd=...``
81 - DuckDuckGo Videos: ``https://duckduckgo.com/v.js??q=...&vqd=...``
82 - DuckDuckGo News: ``https://duckduckgo.com/news.js??q=...&vqd=...``
84 DDG's bot detection is sensitive to the ``vqd`` value. For some search terms
85 (such as extremely long search terms that are often sent by bots), no ``vqd``
86 value can be determined.
88 If SearXNG cannot determine a ``vqd`` value, then no request should go out
93 A request with a wrong ``vqd`` value leads to DDG temporarily putting
94 SearXNG's IP on a block list.
96 Requests from IPs in this block list run into timeouts. Not sure, but it
97 seems the block list is a sliding window: to get my IP rid from the bot list
98 I had to cool down my IP for 1h (send no requests from that IP to DDG).
101 key = cache.secret_hash(f
"{query}//{region}")
102 value = cache.get(key=key)
103 if value
is not None and not force_request:
104 logger.debug(
"vqd: re-use cached value: %s", value)
107 logger.debug(
"vqd: request value from from duckduckgo.com")
108 resp = get(f
'https://duckduckgo.com/?q={quote_plus(query)}')
109 if resp.status_code == 200:
110 value = extr(resp.text,
'vqd="',
'"')
112 logger.debug(
"vqd value from duckduckgo.com request: '%s'", value)
114 logger.error(
"vqd: can't parse value from ddg response (return empty string)")
117 logger.error(
"vqd: got HTTP %s from duckduckgo.com", resp.status_code)
120 cache.set(key=key, value=value)
122 logger.error(
"none vqd value from duckduckgo.com: HTTP %s", resp.status_code)
126def set_vqd(query: str, region: str, value: str):
128 key = cache.secret_hash(f
"{query}//{region}")
129 cache.set(key=key, value=value, expire=3600)
132def get_ddg_lang(eng_traits: EngineTraits, sxng_locale, default=
'en_US'):
133 """Get DuckDuckGo's language identifier from SearXNG's locale.
135 DuckDuckGo defines its languages by region codes (see
136 :py:obj:`fetch_traits`).
138 To get region and language of a DDG service use:
142 eng_region = traits.get_region(params['searxng_locale'], traits.all_locale)
143 eng_lang = get_ddg_lang(traits, params['searxng_locale'])
145 It might confuse, but the ``l`` value of the cookie is what SearXNG calls
150 # !ddi paris :es-AR --> {'ad': 'es_AR', 'ah': 'ar-es', 'l': 'ar-es'}
151 params['cookies']['ad'] = eng_lang
152 params['cookies']['ah'] = eng_region
153 params['cookies']['l'] = eng_region
157 `DDG-lite <https://lite.duckduckgo.com/lite>`__ and the *no Javascript*
158 page https://html.duckduckgo.com/html do not offer a language selection
159 to the user, only a region can be selected by the user (``eng_region``
160 from the example above). DDG-lite and *no Javascript* store the selected
163 params['cookies']['kl'] = eng_region # 'ar-es'
166 return eng_traits.custom[
'lang_region'].get(
167 sxng_locale, eng_traits.get_language(sxng_locale, default)
188 "ar_DZ":
'lang_region',
189 "ar_JO":
'lang_region',
190 "ar_SA":
'lang_region',
192 'bn_IN':
'lang_region',
194 'de_CH':
'lang_region',
196 'en_AU':
'lang_region',
197 'en_CA':
'lang_region',
198 'en_GB':
'lang_region',
202 'es_AR':
'lang_region',
203 'es_CL':
'lang_region',
204 'es_CO':
'lang_region',
205 'es_CR':
'lang_region',
206 'es_EC':
'lang_region',
207 'es_MX':
'lang_region',
208 'es_PE':
'lang_region',
209 'es_UY':
'lang_region',
210 'es_VE':
'lang_region',
212 'fr_CA':
'lang_region',
213 'fr_CH':
'lang_region',
214 'fr_BE':
'lang_region',
216 'nl_BE':
'lang_region',
218 'pt_BR':
'lang_region',
222 'tokipona_XX':
'skip',
226def quote_ddg_bangs(query):
231 for val
in re.split(
r'(\s+)', query):
234 if val.startswith(
'!')
and external_bang.get_node(external_bang.EXTERNAL_BANGS, val[1:]):
236 query_parts.append(val)
237 return ' '.join(query_parts)
240def request(query, params):
241 query = quote_ddg_bangs(query)
243 if len(query) >= 500:
248 eng_region: str = traits.get_region(params[
'searxng_locale'], traits.all_locale)
267 params[
'data'][
'q'] = query
269 if params[
'pageno'] == 1:
270 params[
'data'][
'b'] =
""
271 elif params[
'pageno'] >= 2:
272 offset = 10 + (params[
'pageno'] - 2) * 15
273 params[
'data'][
's'] = offset
274 params[
'data'][
'nextParams'] = form_data.get(
'nextParams',
'')
275 params[
'data'][
'v'] = form_data.get(
'v',
'l')
276 params[
'data'][
'o'] = form_data.get(
'o',
'json')
277 params[
'data'][
'dc'] = offset + 1
278 params[
'data'][
'api'] = form_data.get(
'api',
'd.js')
281 vqd =
get_vqd(query, eng_region, force_request=
False)
283 params[
'data'][
'vqd'] = vqd
291 if params[
'searxng_locale'].startswith(
"zh"):
298 if eng_region ==
"wt-wt":
299 params[
'data'][
'kl'] =
""
301 params[
'data'][
'kl'] = eng_region
303 params[
'data'][
'df'] =
''
304 if params[
'time_range']
in time_range_dict:
305 params[
'data'][
'df'] = time_range_dict[params[
'time_range']]
306 params[
'cookies'][
'df'] = time_range_dict[params[
'time_range']]
308 params[
'cookies'][
'kl'] = eng_region
311 params[
'method'] =
'POST'
313 params[
'headers'][
'Content-Type'] =
'application/x-www-form-urlencoded'
314 params[
'headers'][
'Referer'] = url
315 params[
'headers'][
'Sec-Fetch-Dest'] =
"document"
316 params[
'headers'][
'Sec-Fetch-Mode'] =
"navigate"
317 params[
'headers'][
'Sec-Fetch-Site'] =
"same-origin"
318 params[
'headers'][
'Sec-Fetch-User'] =
"?1"
320 logger.debug(
"param headers: %s", params[
'headers'])
321 logger.debug(
"param data: %s", params[
'data'])
322 logger.debug(
"param cookies: %s", params[
'cookies'])
325def is_ddg_captcha(dom):
326 """In case of CAPTCHA ddg response its own *not a Robot* dialog and is not
327 redirected to a CAPTCHA page."""
329 return bool(eval_xpath(dom,
"//form[@id='challenge-form']"))
332def response(resp) -> EngineResults:
335 if resp.status_code == 303:
338 doc = lxml.html.fromstring(resp.text)
340 if is_ddg_captcha(doc):
344 form = eval_xpath(doc,
'//input[@name="vqd"]/..')
348 form_vqd = eval_xpath(form,
'//input[@name="vqd"]/@value')[0]
350 query=resp.search_params[
'data'][
'q'],
351 region=resp.search_params[
'data'][
'kl'],
356 for div_result
in eval_xpath(doc,
'//div[@id="links"]/div[contains(@class, "web-result")]'):
359 title = eval_xpath(div_result,
'.//h2/a')
363 item[
"title"] = extract_text(title)
364 item[
"url"] = eval_xpath(div_result,
'.//h2/a/@href')[0]
365 item[
"content"] = extract_text(
366 eval_xpath_getindex(div_result,
'.//a[contains(@class, "result__snippet")]', 0, [])
370 zero_click_info_xpath =
'//div[@id="zero_click_abstract"]'
371 zero_click = extract_text(eval_xpath(doc, zero_click_info_xpath)).strip()
374 "Your IP address is" not in zero_click
375 and "Your user agent:" not in zero_click
376 and "URL Decoded:" not in zero_click
379 results.types.Answer(
381 url=eval_xpath_getindex(doc,
'//div[@id="zero_click_abstract"]/a/@href', 0),
388def fetch_traits(engine_traits: EngineTraits):
389 """Fetch languages & regions from DuckDuckGo.
391 SearXNG's ``all`` locale maps DuckDuckGo's "Alle regions" (``wt-wt``).
392 DuckDuckGo's language "Browsers preferred language" (``wt_WT``) makes no
393 sense in a SearXNG request since SearXNG's ``all`` will not add a
394 ``Accept-Language`` HTTP header. The value in ``engine_traits.all_locale``
395 is ``wt-wt`` (the region).
397 Beside regions DuckDuckGo also defines its languages by region codes. By
398 example these are the english languages in DuckDuckGo:
405 The function :py:obj:`get_ddg_lang` evaluates DuckDuckGo's language from
414 engine_traits.all_locale =
'wt-wt'
417 resp = get(
'https://duckduckgo.com/dist/util/u.7669f071a13a7daa57cb.js')
420 print(
"ERROR: response from DuckDuckGo is not OK.")
422 js_code = extr(resp.text,
'regions:',
',snippetLengths')
424 regions = json.loads(js_code)
425 for eng_tag, name
in regions.items():
427 if eng_tag ==
'wt-wt':
428 engine_traits.all_locale =
'wt-wt'
431 region = ddg_reg_map.get(eng_tag)
436 eng_territory, eng_lang = eng_tag.split(
'-')
437 region = eng_lang +
'_' + eng_territory.upper()
440 sxng_tag = locales.region_tag(babel.Locale.parse(region))
441 except babel.UnknownLocaleError:
442 print(
"ERROR: %s (%s) -> %s is unknown by babel" % (name, eng_tag, region))
445 conflict = engine_traits.regions.get(sxng_tag)
447 if conflict != eng_tag:
448 print(
"CONFLICT: babel %s --> %s, %s" % (sxng_tag, conflict, eng_tag))
450 engine_traits.regions[sxng_tag] = eng_tag
454 engine_traits.custom[
'lang_region'] = {}
456 js_code = extr(resp.text,
'languages:',
',regions')
458 languages = js_variable_to_python(js_code)
459 for eng_lang, name
in languages.items():
461 if eng_lang ==
'wt_WT':
464 babel_tag = ddg_lang_map.get(eng_lang, eng_lang)
465 if babel_tag ==
'skip':
470 if babel_tag ==
'lang_region':
471 sxng_tag = locales.region_tag(babel.Locale.parse(eng_lang))
472 engine_traits.custom[
'lang_region'][sxng_tag] = eng_lang
475 sxng_tag = locales.language_tag(babel.Locale.parse(babel_tag))
477 except babel.UnknownLocaleError:
478 print(
"ERROR: language %s (%s) is unknown by babel" % (name, eng_lang))
481 conflict = engine_traits.languages.get(sxng_tag)
483 if conflict != eng_lang:
484 print(
"CONFLICT: babel %s --> %s, %s" % (sxng_tag, conflict, eng_lang))
486 engine_traits.languages[sxng_tag] = eng_lang
str get_vqd(str query, str region, bool force_request=False)
set_vqd(str query, str region, str value)
get_ddg_lang(EngineTraits eng_traits, sxng_locale, default='en_US')