Installing The Captcha

The captcha field I use is quite simple and effective. I originally got it from http://django.agami.at/media/captcha/, but the project seems to be unmaintained now. Along the road to Django 1.0, some changes were made to the way form fields work, and there is a minor change required in the base code for this captcha field if you want it to work. Alternatively, you can use a copy of the field that I'm currently using.

All you need to do is extract the captcha directory somewhere on your PYTHONPATH. The author recommends putting it in django.contrib, but I usually just place it straight on the PYTHONPATH so all I need to do is from captcha import CaptchaField instead of from django.contrib.captcha import CaptchaField. Minor details...

Adding The Captcha

The first thing you'll want to do after installing the captcha field is add the field itself to your comments form. Instead of subclassing the built-in django.contrib.comments.forms.CommentForm form, I simply decorated the constructor of the form as such:

1 2 3 4 5 6 7 8 9

from django.contrib.comments.forms import CommentForm from captcha import CaptchaField def add_captcha(func): def wrapped(self, *args, **kwargs): func(self, *args, **kwargs) self.fields['security_code'] = CaptchaField() return wrapped CommentForm.__init__ = add_captcha(CommentForm.__init__)

This adds a field called security_code to the CommentForm, and it works the same way as if you had done something like this:

1 2 3 4 5 6 7

from django import forms from captcha import CaptchaField class MyCommentForm(forms.Form): name = forms.CharField() ... security_code = CaptchaField()

You can put the decorating snippet from above anywhere you'd like so long as the module you put it in is loaded at some point in your project. I usually put this sort of magic in my main urls.py file so it's harder to forget about when I debug things.

Fixing the Form

The first problem with this little trick seems to be that the CaptchaField is rendered as unsafe HTML in the default form.html template in the built-in comments application. That just means that, instead of seeing the captcha, you will see the HTML necessary to render the CaptchaField directly on the page, like this:

<input type="hidden" name="security_code" value="captcha.caZ1SqQ" />
<img src="/static/captchas/caZ1SqQ/0656f09d3974850397dd4c4974f23a35.gif"
 alt="" /><br /><input type="text" name="security_code"
 id="id_security_code" />

To fix that, you can apply the safe filter to the field and make the template look something like this:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

{% load comments i18n %} <form action="{% comment_form_target %}" method="post"> <table> {% for field in form %} {% if field.is_hidden %} {{ field }} {% else %} <tr{% ifequal field.name "honeypot" %} style="display:none;"{% endifequal %}> <th>{{ field.label_tag }}:</th> <td {% if field.errors %} class="error"{% endif %}> {{ field|safe }} &nbsp; {% if field.errors %}{{ field.errors|join:"; " }}{% endif %} </td> </tr> {% endif %} {% endfor %} </table> <p class="submit"> <input type="submit" name="post" class="submit-post" value="{% trans "Post" %}" /> <input type="submit" name="preview" class="submit-preview" value="{% trans "Preview" %}" /> </p> </form>

Notice the {{ field|safe }} in there. Also note that I prefer the table layout for the comment form over the default mode. If you change your form template as I have done, you should put the updated copy in your own project's template directory. It belongs in templates/comments/form.html, assuming that your templates directory is called templates. You'll probably also want to check out the preview.html template for the django.contrib.comments application. I changed mine to look like this:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

{% extends "comments/base.html" %} {% load i18n %} {% block title %}{% trans "Preview your comment" %}{% endblock %} {% block content %} {% load comments %} {% if form.errors %} <h1>{% blocktrans count form.errors|length as counter %}Please correct the error below{% plural %}Please correct the errors below {% endblocktrans %}</h1> {% else %} <h1>{% trans "Preview your comment" %}</h1> <blockquote>{{ comment|linebreaks }}</blockquote> <p> {% trans "and" %} <input type="submit" name="submit" class="submit-post" value="{% trans "Post your comment" %}" id="submit" /> {% trans "or make changes" %}: </p> {% endif %} {% include 'comments/form.html' %} {% endblock %}

See how I just use the include tag to pull in the comments/form.html template I mentioned above? Saves a lot of typing and potential for problems... If you update the preview.html template, you should save your copy in templates/comments/preview.html, assuming your templates directory is called templates.

Testing It Out

At this point, you should be able to try out your newly installed captcha-fied comments. If it doesn't work, please comment on this article and perhaps we can figure out the problem!