Compare commits

...

4 Commits

Author SHA1 Message Date
Grant Lanham Jr 6021c8a9a7
Merge 6ed37fc9eb into abd9b271bc 2024-11-14 10:53:51 +01:00
Nicolas Dato abd9b271bc [fix] engine: duckduckgo - only uses first word of the search terms
during the revision in PR #3955 the query string was accidentally converted into
a list of words, further the query must be quoted before POSTed in the ``data``
field, see ``urllib.parse.quote_plus`` [1]

[1] https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote_plus

Closed: #4009
Co-Authored-by: @return42
2024-11-14 09:33:54 +01:00
Grant Lanham 6ed37fc9eb [test] add additional tests for preferences 2024-10-27 21:09:28 -04:00
Grant Lanham 6ee5d46c6c [fix] remove unknown_params from preferences 2024-10-19 18:37:29 -04:00
3 changed files with 58 additions and 22 deletions

View File

@ -6,7 +6,7 @@ DuckDuckGo Lite
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
import re import re
from urllib.parse import urlencode from urllib.parse import urlencode, quote_plus
import json import json
import babel import babel
import lxml.html import lxml.html
@ -245,10 +245,12 @@ def request(query, params):
# Advanced search syntax ends in CAPTCHA # Advanced search syntax ends in CAPTCHA
# https://duckduckgo.com/duckduckgo-help-pages/results/syntax/ # https://duckduckgo.com/duckduckgo-help-pages/results/syntax/
query = [ query = " ".join(
[
x.removeprefix("site:").removeprefix("intitle:").removeprefix("inurl:").removeprefix("filetype:") x.removeprefix("site:").removeprefix("intitle:").removeprefix("inurl:").removeprefix("filetype:")
for x in query.split() for x in query.split()
] ]
)
eng_region = traits.get_region(params['searxng_locale'], traits.all_locale) eng_region = traits.get_region(params['searxng_locale'], traits.all_locale)
if eng_region == "wt-wt": if eng_region == "wt-wt":
# https://html.duckduckgo.com/html sets an empty value for "all". # https://html.duckduckgo.com/html sets an empty value for "all".
@ -261,7 +263,7 @@ def request(query, params):
params['url'] = url params['url'] = url
params['method'] = 'POST' params['method'] = 'POST'
params['data']['q'] = query params['data']['q'] = quote_plus(query)
# The API is not documented, so we do some reverse engineering and emulate # The API is not documented, so we do some reverse engineering and emulate
# what https://html.duckduckgo.com/html does when you press "next Page" link # what https://html.duckduckgo.com/html does when you press "next Page" link

View File

@ -479,7 +479,6 @@ class Preferences:
self.plugins = PluginsSetting('plugins', plugins=plugins) self.plugins = PluginsSetting('plugins', plugins=plugins)
self.tokens = SetSetting('tokens') self.tokens = SetSetting('tokens')
self.client = client or ClientPref() self.client = client or ClientPref()
self.unknown_params: Dict[str, str] = {}
def get_as_url_params(self): def get_as_url_params(self):
"""Return preferences as URL parameters""" """Return preferences as URL parameters"""
@ -523,10 +522,6 @@ class Preferences:
self.plugins.parse_cookie(input_data.get('disabled_plugins', ''), input_data.get('enabled_plugins', '')) self.plugins.parse_cookie(input_data.get('disabled_plugins', ''), input_data.get('enabled_plugins', ''))
elif user_setting_name == 'tokens': elif user_setting_name == 'tokens':
self.tokens.parse(user_setting) self.tokens.parse(user_setting)
elif not any(
user_setting_name.startswith(x) for x in ['enabled_', 'disabled_', 'engine_', 'category_', 'plugin_']
):
self.unknown_params[user_setting_name] = user_setting
def parse_form(self, input_data: Dict[str, str]): def parse_form(self, input_data: Dict[str, str]):
"""Parse formular (``<input>``) data from a ``flask.request.form``""" """Parse formular (``<input>``) data from a ``flask.request.form``"""
@ -551,8 +546,7 @@ class Preferences:
disabled_plugins.append(user_setting_name) disabled_plugins.append(user_setting_name)
elif user_setting_name == 'tokens': elif user_setting_name == 'tokens':
self.tokens.parse_form(user_setting) self.tokens.parse_form(user_setting)
else:
self.unknown_params[user_setting_name] = user_setting
self.key_value_settings['categories'].parse_form(enabled_categories) self.key_value_settings['categories'].parse_form(enabled_categories)
self.engines.parse_form(disabled_engines) self.engines.parse_form(disabled_engines)
self.plugins.parse_form(disabled_plugins) self.plugins.parse_form(disabled_plugins)
@ -563,8 +557,6 @@ class Preferences:
ret_val = None ret_val = None
if user_setting_name in self.key_value_settings: if user_setting_name in self.key_value_settings:
ret_val = self.key_value_settings[user_setting_name].get_value() ret_val = self.key_value_settings[user_setting_name].get_value()
if user_setting_name in self.unknown_params:
ret_val = self.unknown_params[user_setting_name]
return ret_val return ret_val
def save(self, resp: flask.Response): def save(self, resp: flask.Response):
@ -577,8 +569,6 @@ class Preferences:
self.engines.save(resp) self.engines.save(resp)
self.plugins.save(resp) self.plugins.save(resp)
self.tokens.save('tokens', resp) self.tokens.save('tokens', resp)
for k, v in self.unknown_params.items():
resp.set_cookie(k, v, max_age=COOKIE_MAX_AGE)
return resp return resp
def validate_token(self, engine): def validate_token(self, engine):

View File

@ -1,10 +1,13 @@
# SPDX-License-Identifier: AGPL-3.0-or-later # SPDX-License-Identifier: AGPL-3.0-or-later
# pylint: disable=missing-module-docstring, invalid-name # pylint: disable=missing-module-docstring, invalid-name
import flask
from mock import Mock
from tests import SearxTestCase from tests import SearxTestCase
from searx import favicons from searx import favicons
from searx.locales import locales_initialize from searx.locales import locales_initialize
from searx.preferences import ( from searx.preferences import (
Setting,
EnumStringSetting, EnumStringSetting,
MapSetting, MapSetting,
SearchLanguageSetting, SearchLanguageSetting,
@ -13,6 +16,7 @@ from searx.preferences import (
ValidationException, ValidationException,
) )
from searx.plugins import Plugin from searx.plugins import Plugin
from searx.preferences import Preferences
locales_initialize() locales_initialize()
favicons.init() favicons.init()
@ -125,10 +129,10 @@ class TestSettings(SearxTestCase): # pylint: disable=missing-class-docstring
class TestPreferences(SearxTestCase): # pylint: disable=missing-class-docstring class TestPreferences(SearxTestCase): # pylint: disable=missing-class-docstring
def test_encode(self): def setUp(self):
from searx.preferences import Preferences # pylint: disable=import-outside-toplevel self.preferences = Preferences(['simple'], ['general'], {}, [])
pref = Preferences(['simple'], ['general'], {}, []) def test_encode(self):
url_params = ( url_params = (
'eJx1Vk1z4zYM_TXxRZNMd7eddg8-pe21nWnvGoiEJEQkofDDtvzrC1qSRdnbQxQTBA' 'eJx1Vk1z4zYM_TXxRZNMd7eddg8-pe21nWnvGoiEJEQkofDDtvzrC1qSRdnbQxQTBA'
'Hw8eGRCiJ27AnDsUOHHszBgOsSdHjU-Pr7HwfDCkweHCBFVmxHgxGPB7LiU4-eL9Px' 'Hw8eGRCiJ27AnDsUOHHszBgOsSdHjU-Pr7HwfDCkweHCBFVmxHgxGPB7LiU4-eL9Px'
@ -155,8 +159,48 @@ class TestPreferences(SearxTestCase): # pylint: disable=missing-class-docstring
'd-DZy7PtaVp2WgvPBpzCXUL_J1OGex48RVmOXzBU8_N3kqekkefRDzxNK2_Klp9mBJ' 'd-DZy7PtaVp2WgvPBpzCXUL_J1OGex48RVmOXzBU8_N3kqekkefRDzxNK2_Klp9mBJ'
'wsUnXyRqq1mScHuYalUY7_AZTCR4s=&q=' 'wsUnXyRqq1mScHuYalUY7_AZTCR4s=&q='
) )
pref.parse_encoded_data(url_params) self.preferences.parse_encoded_data(url_params)
self.assertEqual( self.assertEqual(
vars(pref.key_value_settings['categories']), vars(self.preferences.key_value_settings['categories']),
{'value': ['general'], 'locked': False, 'choices': ['general', 'none']}, {'value': ['general'], 'locked': False, 'choices': ['general', 'none']},
) )
def test_save_key_value_setting(self):
setting_key = 'foo'
setting_value = 'bar'
cookie_callback = {}
def set_cookie_callback(name, value, max_age): # pylint: disable=unused-argument
cookie_callback[name] = value
response_mock = Mock(flask.Response)
response_mock.set_cookie = set_cookie_callback
self.preferences.key_value_settings = {
setting_key: Setting(
setting_value,
locked=False,
),
}
self.preferences.save(response_mock)
self.assertIn(setting_key, cookie_callback)
self.assertEqual(cookie_callback[setting_key], setting_value)
def test_false_key_value_setting(self):
setting_key = 'foo'
cookie_callback = {}
def set_cookie_callback(name, value, max_age): # pylint: disable=unused-argument
cookie_callback[name] = value
response_mock = Mock(flask.Response)
response_mock.set_cookie = set_cookie_callback
self.preferences.key_value_settings = {
setting_key: Setting(
'',
locked=True,
),
}
self.preferences.save(response_mock)
self.assertNotIn(setting_key, cookie_callback)