Merge 6ed37fc9eb into cd384a8a60

Bumps [selenium](https://github.com/SeleniumHQ/Selenium) from 4.25.0 to 4.26.1.
- [Release notes](https://github.com/SeleniumHQ/Selenium/releases)
- [Commits](https://github.com/SeleniumHQ/Selenium/commits)

---
updated-dependencies:
- dependency-name: selenium
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/workflows/checker.yml

@@ -1,5 +1,5 @@
 name: "Checker"
-on:
+on:  # yamllint disable-line rule:truthy
   schedule:
     - cron: "0 4 * * 5"
   workflow_dispatch:

.github/workflows/data-update.yml

@@ -1,5 +1,5 @@
 name: "Update searx.data"
-on:
+on:  # yamllint disable-line rule:truthy
   schedule:
     - cron: "59 23 28 * *"
   workflow_dispatch:

.github/workflows/integration.yml

@@ -1,6 +1,6 @@
 name: Integration
 
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches: ["master"]
   pull_request:
@@ -16,62 +16,62 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-20.04]
-        python-version:  ["3.9", "3.10", "3.11", "3.12",]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v4
+        uses: actions/checkout@v4
-    - name: Install Ubuntu packages
+      - name: Install Ubuntu packages
-      run: |
+        run: |
-        sudo ./utils/searxng.sh install packages
+          sudo ./utils/searxng.sh install packages
-        sudo apt install firefox
+          sudo apt install firefox
-    - name: Set up Python
+      - name: Set up Python
-      uses: actions/setup-python@v5
+        uses: actions/setup-python@v5
-      with:
+        with:
-        python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version }}
-        architecture: 'x64'
+          architecture: 'x64'
-    - name: Cache Python dependencies
+      - name: Cache Python dependencies
-      id: cache-python
+        id: cache-python
-      uses: actions/cache@v3
+        uses: actions/cache@v3
-      with:
+        with:
-        path: |
+          path: |
-          ./local
+            ./local
-          ./.nvm
+            ./.nvm
-          ./node_modules
+            ./node_modules
-        key: python-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('requirements*.txt', 'setup.py') }}
+          key: python-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('requirements*.txt', 'setup.py') }}
-    - name: Install Python dependencies
+      - name: Install Python dependencies
-      if: steps.cache-python.outputs.cache-hit != 'true'
+        if: steps.cache-python.outputs.cache-hit != 'true'
-      run: |
+        run: |
-        make V=1 install
+          make V=1 install
-        make V=1 gecko.driver
+          make V=1 gecko.driver
-    - name: Run tests
+      - name: Run tests
-      run: make V=1 ci.test
+        run: make V=1 ci.test
 
   themes:
     name: Themes
     runs-on: ubuntu-20.04
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v4
+        uses: actions/checkout@v4
-    - name: Install Ubuntu packages
+      - name: Install Ubuntu packages
-      run: sudo ./utils/searxng.sh install buildhost
+        run: sudo ./utils/searxng.sh install buildhost
-    - name: Set up Python
+      - name: Set up Python
-      uses: actions/setup-python@v5
+        uses: actions/setup-python@v5
-      with:
+        with:
-        python-version: '3.12'
+          python-version: '3.12'
-        architecture: 'x64'
+          architecture: 'x64'
-    - name: Cache Python dependencies
+      - name: Cache Python dependencies
-      id: cache-python
+        id: cache-python
-      uses: actions/cache@v3
+        uses: actions/cache@v3
-      with:
+        with:
-        path: |
+          path: |
-          ./local
+            ./local
-          ./.nvm
+            ./.nvm
-          ./node_modules
+            ./node_modules
-        key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
+          key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-    - name: Install node dependencies
+      - name: Install node dependencies
-      run: make V=1 node.env
+        run: make V=1 node.env
-    - name: Build themes
+      - name: Build themes
-      run: make V=1 themes.all
+        run: make V=1 themes.all
 
   documentation:
     name: Documentation
@@ -79,40 +79,40 @@ jobs:
     permissions:
       contents: write  # for JamesIves/github-pages-deploy-action to push changes in repo
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v4
+        uses: actions/checkout@v4
-      with:
+        with:
-        fetch-depth: '0'
+          fetch-depth: '0'
-        persist-credentials: false
+          persist-credentials: false
-    - name: Install Ubuntu packages
+      - name: Install Ubuntu packages
-      run: sudo ./utils/searxng.sh install buildhost
+        run: sudo ./utils/searxng.sh install buildhost
-    - name: Set up Python
+      - name: Set up Python
-      uses: actions/setup-python@v5
+        uses: actions/setup-python@v5
-      with:
+        with:
-        python-version: '3.12'
+          python-version: '3.12'
-        architecture: 'x64'
+          architecture: 'x64'
-    - name: Cache Python dependencies
+      - name: Cache Python dependencies
-      id: cache-python
+        id: cache-python
-      uses: actions/cache@v3
+        uses: actions/cache@v3
-      with:
+        with:
-        path: |
+          path: |
-          ./local
+            ./local
-          ./.nvm
+            ./.nvm
-          ./node_modules
+            ./node_modules
-        key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
+          key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-    - name: Build documentation
+      - name: Build documentation
-      run: |
+        run: |
-        make V=1 docs.clean docs.html
+          make V=1 docs.clean docs.html
-    - name: Deploy
+      - name: Deploy
-      if:  github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/master'
-      uses: JamesIves/github-pages-deploy-action@3.7.1
+        uses: JamesIves/github-pages-deploy-action@3.7.1
-      with:
+        with:
-        GITHUB_TOKEN: ${{ github.token }}
+          GITHUB_TOKEN: ${{ github.token }}
-        BRANCH: gh-pages
+          BRANCH: gh-pages
-        FOLDER: dist/docs
+          FOLDER: dist/docs
-        CLEAN: true # Automatically remove deleted files from the deploy branch
+          CLEAN: true  # Automatically remove deleted files from the deploy branch
-        SINGLE_COMMIT: True
+          SINGLE_COMMIT: true
-        COMMIT_MESSAGE: '[doc] build from commit ${{ github.sha }}'
+          COMMIT_MESSAGE: '[doc] build from commit ${{ github.sha }}'
 
   babel:
     name: Update translations branch
@@ -125,37 +125,37 @@ jobs:
     permissions:
       contents: write  # for make V=1 weblate.push.translations
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v4
+        uses: actions/checkout@v4
-      with:
+        with:
-        fetch-depth: '0'
+          fetch-depth: '0'
-        token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
+          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-    - name: Set up Python
+      - name: Set up Python
-      uses: actions/setup-python@v5
+        uses: actions/setup-python@v5
-      with:
+        with:
-        python-version: '3.12'
+          python-version: '3.12'
-        architecture: 'x64'
+          architecture: 'x64'
-    - name: Cache Python dependencies
+      - name: Cache Python dependencies
-      id: cache-python
+        id: cache-python
-      uses: actions/cache@v3
+        uses: actions/cache@v3
-      with:
+        with:
-        path: |
+          path: |
-          ./local
+            ./local
-          ./.nvm
+            ./.nvm
-          ./node_modules
+            ./node_modules
-        key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
+          key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-    - name: weblate & git setup
+      - name: weblate & git setup
-      env:
+        env:
-        WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
+          WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
-      run: |
+        run: |
-        mkdir -p ~/.config
+          mkdir -p ~/.config
-        echo "${WEBLATE_CONFIG}" > ~/.config/weblate
+          echo "${WEBLATE_CONFIG}" > ~/.config/weblate
-        git config --global user.email "searxng-bot@users.noreply.github.com"
+          git config --global user.email "searxng-bot@users.noreply.github.com"
-        git config --global user.name "searxng-bot"
+          git config --global user.name "searxng-bot"
-    - name: Update transations
+      - name: Update transations
-      id: update
+        id: update
-      run: |
+        run: |
-        make V=1 weblate.push.translations
+          make V=1 weblate.push.translations
 
   dockers:
     name: Docker

.github/workflows/security.yml

@@ -1,5 +1,5 @@
 name: "Security checks"
-on:
+on:  # yamllint disable-line rule:truthy
   schedule:
     - cron: "42 05 * * *"
   workflow_dispatch:

.github/workflows/translations-update.yml

@@ -1,5 +1,5 @@
 name: "Update translations"
-on:
+on:  # yamllint disable-line rule:truthy
   schedule:
     - cron: "05 07 * * 5"
   workflow_dispatch:
@@ -10,50 +10,50 @@ jobs:
     runs-on: ubuntu-20.04
     if: ${{ github.repository_owner == 'searxng' && github.ref == 'refs/heads/master' }}
     steps:
-    - name: Checkout
+      - name: Checkout
-      uses: actions/checkout@v4
+        uses: actions/checkout@v4
-      with:
+        with:
-        fetch-depth: '0'
+          fetch-depth: '0'
-        token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
+          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-    - name: Set up Python
+      - name: Set up Python
-      uses: actions/setup-python@v5
+        uses: actions/setup-python@v5
-      with:
+        with:
-        python-version: '3.12'
+          python-version: '3.12'
-        architecture: 'x64'
+          architecture: 'x64'
-    - name: Cache Python dependencies
+      - name: Cache Python dependencies
-      id: cache-python
+        id: cache-python
-      uses: actions/cache@v3
+        uses: actions/cache@v3
-      with:
+        with:
-        path: |
+          path: |
-          ./local
+            ./local
-          ./.nvm
+            ./.nvm
-          ./node_modules
+            ./node_modules
-        key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
+          key: python-ubuntu-20.04-3.12-${{ hashFiles('requirements*.txt', 'setup.py','.nvmrc', 'package.json') }}
-    - name: weblate & git setup
+      - name: weblate & git setup
-      env:
+        env:
-        WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
+          WEBLATE_CONFIG: ${{ secrets.WEBLATE_CONFIG }}
-      run: |
+        run: |
-        mkdir -p ~/.config
+          mkdir -p ~/.config
-        echo "${WEBLATE_CONFIG}" > ~/.config/weblate
+          echo "${WEBLATE_CONFIG}" > ~/.config/weblate
-        git config --global user.email "searxng-bot@users.noreply.github.com"
+          git config --global user.email "searxng-bot@users.noreply.github.com"
-        git config --global user.name "searxng-bot"
+          git config --global user.name "searxng-bot"
-    - name: Merge and push transation updates
+      - name: Merge and push transation updates
-      run: |
+        run: |
-        make V=1 weblate.translations.commit
+          make V=1 weblate.translations.commit
-    - name: Create Pull Request
+      - name: Create Pull Request
-      id: cpr
+        id: cpr
-      uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v3
-      with:
+        with:
-        token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
+          token: ${{ secrets.WEBLATE_GITHUB_TOKEN }}
-        commit-message: '[l10n] update translations from Weblate'
+          commit-message: '[l10n] update translations from Weblate'
-        committer: searxng-bot <searxng-bot@users.noreply.github.com>
+          committer: searxng-bot <searxng-bot@users.noreply.github.com>
-        author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
-        signoff: false
+          signoff: false
-        branch: translations_update
+          branch: translations_update
-        delete-branch: true
+          delete-branch: true
-        draft: false
+          draft: false
-        title: '[l10n] update translations from Weblate'
+          title: '[l10n] update translations from Weblate'
-        body: |
+          body: |
-          update translations from Weblate
+            update translations from Weblate
-        labels: |
+          labels: |
-          translation
+            translation

manage

@@ -57,7 +57,7 @@ while IFS= read -r line; do
     if [ "$line" != "tests/unit/settings/syntaxerror_settings.yml" ]; then
         YAMLLINT_FILES+=("$line")
     fi
-done <<< "$(git ls-files './tests/*.yml' './searx/*.yml' './utils/templates/etc/searxng/*.yml')"
+done <<< "$(git ls-files './tests/*.yml' './searx/*.yml' './utils/templates/etc/searxng/*.yml' '.github/*.yml' '.github/*/*.yml')"
 
 RST_FILES=(
     'README.rst'

requirements-dev.txt

@@ -4,7 +4,7 @@ cov-core==1.15.0
 black==24.3.0
 pylint==3.3.1
 splinter==0.21.0
-selenium==4.25.0
+selenium==4.26.1
 Pallets-Sphinx-Themes==2.3.0
 Sphinx==7.4.7
 sphinx-issues==5.0.0

searx/preferences.py

@@ -479,7 +479,6 @@ class Preferences:
         self.plugins = PluginsSetting('plugins', plugins=plugins)
         self.tokens = SetSetting('tokens')
         self.client = client or ClientPref()
-        self.unknown_params: Dict[str, str] = {}
 
     def get_as_url_params(self):
         """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', ''))
             elif user_setting_name == 'tokens':
                 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]):
         """Parse formular (``<input>``) data from a ``flask.request.form``"""
@@ -551,8 +546,7 @@ class Preferences:
                 disabled_plugins.append(user_setting_name)
             elif user_setting_name == 'tokens':
                 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.engines.parse_form(disabled_engines)
         self.plugins.parse_form(disabled_plugins)
@@ -563,8 +557,6 @@ class Preferences:
         ret_val = None
         if user_setting_name in self.key_value_settings:
             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
 
     def save(self, resp: flask.Response):
@@ -577,8 +569,6 @@ class Preferences:
         self.engines.save(resp)
         self.plugins.save(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
 
     def validate_token(self, engine):

tests/unit/test_preferences.py

@@ -1,10 +1,13 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 # pylint: disable=missing-module-docstring, invalid-name
 
+import flask
+from mock import Mock
 from tests import SearxTestCase
 from searx import favicons
 from searx.locales import locales_initialize
 from searx.preferences import (
+    Setting,
     EnumStringSetting,
     MapSetting,
     SearchLanguageSetting,
@@ -13,6 +16,7 @@ from searx.preferences import (
     ValidationException,
 )
 from searx.plugins import Plugin
+from searx.preferences import Preferences
 
 locales_initialize()
 favicons.init()
@@ -125,10 +129,10 @@ class TestSettings(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 = (
             'eJx1Vk1z4zYM_TXxRZNMd7eddg8-pe21nWnvGoiEJEQkofDDtvzrC1qSRdnbQxQTBA'
             'Hw8eGRCiJ27AnDsUOHHszBgOsSdHjU-Pr7HwfDCkweHCBFVmxHgxGPB7LiU4-eL9Px'
@@ -155,8 +159,48 @@ class TestPreferences(SearxTestCase):  # pylint: disable=missing-class-docstring
             'd-DZy7PtaVp2WgvPBpzCXUL_J1OGex48RVmOXzBU8_N3kqekkefRDzxNK2_Klp9mBJ'
             'wsUnXyRqq1mScHuYalUY7_AZTCR4s=&q='
         )
-        pref.parse_encoded_data(url_params)
+        self.preferences.parse_encoded_data(url_params)
         self.assertEqual(
-            vars(pref.key_value_settings['categories']),
+            vars(self.preferences.key_value_settings['categories']),
             {'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)