feat: added support for altcha translations #23

Signed-off-by: Lukáš Bačovský <l.bacovsky@gmail.com>
Co-authored-by: tdruez <tdruez@aboutcode.org>

Author: xgimp

README.md

@@ -132,8 +132,20 @@ class MyForm(forms.Form):
 
 ### ALTCHA_JS_URL
 
-URL location of the Altcha JavaScript file.
-Default to the django-altcha embedded file.
+URL of the Altcha JavaScript file.
+Defaults to the bundled django-altcha file.
+
+### ALTCHA_INCLUDE_TRANSLATIONS
+
+Whether to include [Altcha translations](https://altcha.org/docs/v2/widget-integration/#internationalization-i18n).
+Defaults to `False`.
+
+### ALTCHA_JS_TRANSLATIONS_URL
+
+URL of the Altcha translations JavaScript file.
+Defaults to the bundled django-altcha file.
+
+Only loaded when `ALTCHA_INCLUDE_TRANSLATIONS` is `True`.
 
 ### ALTCHA_VERIFICATION_ENABLED
 

django_altcha/__init__.py

@@ -46,6 +46,10 @@
     ALTCHA_HMAC_KEY = secrets.token_hex(32)
 
 ALTCHA_JS_URL = getattr(settings, "ALTCHA_JS_URL", "/static/altcha/altcha.min.js")
+ALTCHA_JS_TRANSLATIONS_URL = getattr(
+    settings, "ALTCHA_JS_TRANSLATIONS_URL", "/static/altcha/dist_i18n/all.min.js"
+)
+ALTCHA_INCLUDE_TRANSLATIONS = getattr(settings, "ALTCHA_INCLUDE_TRANSLATIONS", False)
 
 # Challenge expiration duration in milliseconds.
 # Default to 20 minutes as per Altcha security recommendations.
@@ -122,7 +126,9 @@ def __init__(self, options, *args, **kwargs):
     def get_context(self, name, value, attrs):
         """Generate the widget context, including ALTCHA JS URL and challenge."""
         context = super().get_context(name, value, attrs)
-        context["js_src_url"] = ALTCHA_JS_URL
+        context["js_altcha_url"] = ALTCHA_JS_URL
+        context["js_translations_url"] = ALTCHA_JS_TRANSLATIONS_URL
+        context["include_translations"] = ALTCHA_INCLUDE_TRANSLATIONS
 
         # If a `challengeurl` is provided, the challenge will be fetched from this URL.
         # This can be a local Django view or an external API endpoint.

django_altcha/static/altcha/dist_i18n/all.min.js

@@ -1,4 +1,5 @@
-<script async defer src="{{ js_src_url }}" type="module"></script>
+<script async defer src="{{ js_altcha_url }}" type="module"></script>
+{% if include_translations %}<script async defer src="{{ js_translations_url }}" type="module"></script>{% endif %}
 {% include "django/forms/widgets/input.html" %}
 <altcha-widget name="{{ widget.name }}"
     {% for key, value in widget.altcha_options.items %}

django_altcha/templates/altcha_widget.html

@@ -81,8 +81,22 @@ This key is used to HMAC-sign ALTCHA challenges and **must be kept secret**.
 ALTCHA_JS_URL
 ~~~~~~~~~~~~~
 
-URL location of the Altcha JavaScript file.
-Default to the django-altcha embedded file.
+URL of the Altcha JavaScript file.
+Defaults to the bundled django-altcha file.
+
+ALTCHA_INCLUDE_TRANSLATIONS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Whether to include `Altcha translations <https://altcha.org/docs/v2/widget-integration/#internationalization-i18n>`_.
+Defaults to ``False``.
+
+ALTCHA_JS_TRANSLATIONS_URL
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+URL of the Altcha translations JavaScript file.
+Defaults to the bundled django-altcha file.
+
+Only loaded when ``ALTCHA_INCLUDE_TRANSLATIONS`` is ``True``.
 
 ALTCHA_VERIFICATION_ENABLED
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/installation.rst

@@ -30,7 +30,7 @@ classifiers = [
 requires-python = ">=3.9"
 dependencies = [
     "Django>=4.2",
-    "altcha>=0.2.0",
+    "altcha==0.2.0",
 ]
 keywords = ["captcha", "django", "widget", "form", "altcha"]
 

pyproject.toml

@@ -1,6 +1,5 @@
-INSTALLED_APPS = [
-    "django_altcha",
-]
+INSTALLED_APPS = ["django_altcha"]
 DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}}
 ROOT_URLCONF = "tests.urls"
 ALTCHA_HMAC_KEY = "altcha-insecure-hmac-0123456789abcdef"
+ALTCHA_JS_TRANSLATIONS_URL = "/static/altcha/dist_i18n/all.min.js"

tests/settings.py

@@ -6,6 +6,7 @@
 #
 
 import json
+from unittest import mock
 
 from django.test import TestCase
 
@@ -53,3 +54,15 @@ def test_widget_rendering_with_complex_options(self):
             '"verified": "Verified"}"'
         )
         self.assertIn(expected, rendered_widget_html)
+
+    @mock.patch("django_altcha.ALTCHA_INCLUDE_TRANSLATIONS", True)
+    def test_js_translation_included_if_enabled(self):
+        widget = AltchaWidget(options=None)
+        rendered_widget_html = widget.render("name", "value")
+        self.assertIn("/static/altcha/dist_i18n/all.min.js", rendered_widget_html)
+
+    @mock.patch("django_altcha.ALTCHA_INCLUDE_TRANSLATIONS", False)
+    def test_js_translation_not_included_if_disabled(self):
+        widget = AltchaWidget(options=None)
+        rendered_widget_html = widget.render("name", "value")
+        self.assertNotIn("/static/altcha/dist_i18n/all.min.js", rendered_widget_html)