Hello, captcha world
%(hidden_field)s%(text_field)s" - ) - r = self.client.get(reverse(urlname)) - self.assertEqual(r.status_code, 200) - self.assertTrue("Hello, captcha world
" in str(r.content)) - - def test_invalid_output_format(self): - for urlname in ("captcha-test", "captcha-test-model-form"): - settings.CAPTCHA_OUTPUT_FORMAT = "%(image)s" - try: - with warnings.catch_warnings(record=True) as w: - self.client.get(reverse(urlname)) - assert len(w) == 1 - self.assertTrue("CAPTCHA_OUTPUT_FORMAT" in str(w[-1].message)) - self.fail() - - except ImproperlyConfigured as e: - self.assertTrue("CAPTCHA_OUTPUT_FORMAT" in str(e)) - - def test_per_form_format(self): - settings.CAPTCHA_OUTPUT_FORMAT = ( - "%(image)s testCustomFormatString %(hidden_field)s %(text_field)s" - ) - r = self.client.get(reverse("captcha-test")) - self.assertTrue("testCustomFormatString" in str(r.content)) - r = self.client.get(reverse("test_per_form_format")) - self.assertTrue("testPerFieldCustomFormatString" in str(r.content)) - def test_custom_generator(self): r = self.client.get(reverse("test_custom_generator")) hash_, response = self.__extract_hash_and_response(r) self.assertEqual(response, "111111") - def test_issue31_proper_abel(self): - settings.CAPTCHA_OUTPUT_FORMAT = "%(image)s %(hidden_field)s %(text_field)s" - r = self.client.get(reverse("captcha-test")) - self.assertTrue('' ) + if django.VERSION >= (5, 0): + captcha_input = ( + '' + ) self.assertContains(r, captcha_input, html=True) def test_issue201_autocomplete_off_on_hiddeninput(self): @@ -436,12 +394,24 @@ def test_issue201_autocomplete_off_on_hiddeninput(self): key = r.context["form"]["captcha"].field.widget._key # Assety that autocomplete=off is set on the hidden captcha field. - self.assertInHTML( - ''.format( - key - ), - str(r.content), - ) + if django.VERSION >= (5, 0): + self.assertInHTML( + ( + f'' + ), + str(r.content), + ) + + else: + self.assertInHTML( + ( + f'' + ), + str(r.content), + ) def test_transparent_background(self): __current_test_mode_setting = settings.CAPTCHA_BACKGROUND_COLOR @@ -513,19 +483,6 @@ def test_multiple_fonts(self): settings.CAPTCHA_FONT_PATH = __current_test_mode_setting - def test_template_overrides(self): - __current_test_mode_setting = settings.CAPTCHA_IMAGE_TEMPLATE - __current_field_template = settings.CAPTCHA_FIELD_TEMPLATE - settings.CAPTCHA_IMAGE_TEMPLATE = "captcha_test/image.html" - settings.CAPTCHA_FIELD_TEMPLATE = "captcha/field.html" - - for urlname in ("captcha-test", "captcha-test-model-form"): - settings.CAPTCHA_CHALLENGE_FUNCT = "captcha.tests.trivial_challenge" - r = self.client.get(reverse(urlname)) - self.assertTrue("captcha-template-test" in str(r.content)) - settings.CAPTCHA_IMAGE_TEMPLATE = __current_test_mode_setting - settings.CAPTCHA_FIELD_TEMPLATE = __current_field_template - def test_math_challenge(self): __current_test_mode_setting = settings.CAPTCHA_MATH_CHALLENGE_OPERATOR settings.CAPTCHA_MATH_CHALLENGE_OPERATOR = "~" diff --git a/docs/advanced.rst b/docs/advanced.rst index a7d9fdcf..8af41ede 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -148,21 +148,6 @@ Defaults to: 99 Note: it's perfectly safe to specify e.g. ``CAPTCHA_DICTIONARY_MIN_LENGTH = CAPTCHA_DICTIONARY_MAX_LENGTH = 6`` but it's considered an error to define ``CAPTCHA_DICTIONARY_MAX_LENGTH`` to be smaller than ``CAPTCHA_DICTIONARY_MIN_LENGTH``. -.. _output_format_ref: - -CAPTCHA_OUTPUT_FORMAT ------------------------- - -New in version 0.1.6 - -Specify your own output format for the generated markup, when e.g. you want to position the captcha image relative to the text field in your form. - -Defaults to: ``None`` - -(Used to default to: ``u'%(image)s %(hidden_field)s %(text_field)s'``) - -.. warning:: This setting is deprecated in favor of template-based widget rendering (see the Rendering section below). - CAPTCHA_TEST_MODE ------------------------ @@ -239,38 +224,12 @@ And then have a ``custom_field.html`` template:: .. note:: For this to work, you MUST add ``django.forms`` to your ``INSTALLED_APPS`` and - set ``FORM_RENDERER = 'django.forms.renderers.TemplatesSetting'`` to your settings.py. + set ``FORM_RENDERER = 'django.forms.renderers.TemplatesSetting'`` in your settings.py. (See here_ for an explanation) .. _here: https://docs.djangoproject.com/en/2.0/ref/forms/renderers/#django.forms.renderers.TemplatesSetting -.. warning:: To provide backwards compatibility, the old style rendering has priority over the widget templates. - If the ``CAPTCHA_FIELD_TEMPLATE`` or ``CAPTCHA_OUTPUT_FORMAT`` settings or ``field_templates`` or ``output_format`` parameter are set, the direct rendering gets higher priority. - If widget templates are ignored, make sure you're using Django >= 1.11 and disable these settings and parameters. - - - -Old style rendering -------------------- - -.. warning:: This rendering method is deprecated. Use Django >= 1.11 and widgets templates instead. - -A CAPTCHA field is made up of three components: - -* The actual image that the end user has to copy from -* A text field, that the user has to fill with the content of the image -* A hidden field, containing the database reference of the CAPTCHA (for verification). - -These three elements are rendered individually, then assembled into a single bit of HTML. - -As of version 0.4.7 you can control how the individual components are rendered, as well as how all components are assembled, by overriding four templates: - -* ``captcha/image.html`` controls the rendering of the image (and optionally audio) element -* ``captcha/text_field.html`` controls the rendering of the text field -* ``captcha/hidden_field.html`` controls the rendering of the hidden input -* ``captcha/field.html`` controls the assembling of the previous three elements -These templates can be overridden in your own ``templates`` folder, or you can change the actual template names by settings ``CAPTCHA_IMAGE_TEMPLATE``, ``CAPTCHA_TEXT_FIELD_TEMPLATE``, ``CAPTCHA_HIDDEN_FIELD_TEMPLATE`` and ``CAPTCHA_FIELD_TEMPLATE``, respectively. Context ~~~~~~~ diff --git a/docs/conf.py b/docs/conf.py index 9f7cba67..bb690f58 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,14 +42,14 @@ # General information about the project. project = "Django Simple Captcha" -copyright = "2011-2021 Marco Bonetti and contributors" +copyright = "2011-2023 Marco Bonetti and contributors" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = "0.5.18" +version = "0.6.0" # The full version, including alpha/beta/rc tags. release = version diff --git a/testproject/forms.py b/testproject/forms.py index 1a471753..248f2a5c 100644 --- a/testproject/forms.py +++ b/testproject/forms.py @@ -1,7 +1,15 @@ from django import forms -from captcha.fields import CaptchaField +from captcha.fields import CaptchaField, CaptchaTextInput + + +class CustomCaptchaTextInput(CaptchaTextInput): + template_name = "captcha_test/custom_captcha_field.html" class CaptchaForm(forms.Form): captcha = CaptchaField() + + +class CustomCaptchaForm(forms.Form): + captcha = CaptchaField(widget=CustomCaptchaTextInput) diff --git a/testproject/settings.py b/testproject/settings.py index 4de2a3c6..a743f9a0 100644 --- a/testproject/settings.py +++ b/testproject/settings.py @@ -27,9 +27,11 @@ "django.contrib.contenttypes", "django.contrib.sessions", "django.contrib.sites", + "django.forms", "django.contrib.messages", "captcha", ] +FORM_RENDERER = "django.forms.renderers.TemplatesSetting" LANGUAGE_CODE = "en" @@ -78,4 +80,3 @@ CAPTCHA_SOX_PATH = os.environ.get("CAPTCHA_SOX_PATH", None) CAPTCHA_BACKGROUND_COLOR = "transparent" # CAPTCHA_BACKGROUND_COLOR = '#ffffffff' -CAPTCHA_IMAGE_TEMPLATE = "captcha_test/image_html5_audio.html" diff --git a/testproject/templates/captcha_test/custom_captcha_field.html b/testproject/templates/captcha_test/custom_captcha_field.html new file mode 100644 index 00000000..87b01c9f --- /dev/null +++ b/testproject/templates/captcha_test/custom_captcha_field.html @@ -0,0 +1,17 @@ +{% load i18n %} +{% spaceless %} +