ReCaptcha w formularzach Django

1 February 2011 Comments

ReCaptcha to popularny system captcha do zabezpieczania formularzy przed aktywnością botów. Oferuje on API pozwalające na wykorzystywanie widżetów ReCaptcha na stronach www. W przypadku Pythona wykorzystamy recaptcha-client, który to wykorzystywany jest przez specjalny typ pola formularzy Django w tym fragmencie kodu. W artykule zaprezentuję gotowy przykład formularza oparty o tą bibliotekę i snippet.

Na początek wygeneruj darmowy zestaw kluczy dla domeny, w której chcesz używać widżetu

Mając klucz wstawiamy je do settings.py projektu Django:

RECAPTCHA_PUBLIC_KEY = '*Klucz tutaj*'
RECAPTCHA_PRIVATE_KEY = '*Klucz tutaj*'

Instalujemy recaptcha-client np. poprzez easy_install
Teraz musimy dodać definicję pola i widżetu dla formularzy Django. Można zrobić to tak - tworzymy w projekcie Django katalog "recaptchawidget" a w nim pliki fields.py, widgets.py, oraz __init__.py.

Kod widgets.py:

from django import forms
from django.utils.safestring import mark_safe
from django.conf import settings
from recaptcha.client import captcha
    
class ReCaptcha(forms.widgets.Widget):
        recaptcha_challenge_name = 'recaptcha_challenge_field'
        recaptcha_response_name = 'recaptcha_response_field'
    
        def render(self, name, value, attrs=None):
            return mark_safe(u'%s' % captcha.displayhtml(settings.RECAPTCHA_PUBLIC_KEY))
    
        def value_from_datadict(self, data, files, name):
            return [data.get(self.recaptcha_challenge_name, None), 
                data.get(self.recaptcha_response_name, None)]

Kod fields.py:

from django.conf import settings
from django import forms
from django.utils.encoding import smart_unicode
from django.utils.translation import ugettext_lazy as _

from recaptchawidget.widgets import ReCaptcha
from recaptcha.client import captcha
    
class ReCaptchaField(forms.CharField):
        default_error_messages = {
            'captcha_invalid': _(u'Invalid captcha')
        }
    
        def __init__(self, *args, **kwargs):
            self.widget = ReCaptcha
            self.required = True
            super(ReCaptchaField, self).__init__(*args, **kwargs)
    
        def clean(self, values):
            super(ReCaptchaField, self).clean(values[1])
            recaptcha_challenge_value = smart_unicode(values[0])
            recaptcha_response_value = smart_unicode(values[1])
            check_captcha = captcha.submit(recaptcha_challenge_value, 
                recaptcha_response_value, settings.RECAPTCHA_PRIVATE_KEY, {})
            if not check_captcha.is_valid:
                raise forms.util.ValidationError(self.error_messages['captcha_invalid'])
            return values[0]

Teraz możemy już wykorzystać ReCaptcha w formularzach. Oto przykładowa definicja formularza:

from django import forms

from recaptchawidget.fields import ReCaptchaField 

class RegisterProForm(forms.Form):
    """
    A form with recaptcha
    """
    login = forms.CharField(min_length=2, max_length=30)
    recaptcha = ReCaptchaField()

Oraz widok obsługujący formularz:

#!/usr/bin/python
# -*- coding: utf-8 -*-

from django.shortcuts import render_to_response
from django.http import HttpResponseRedirect
from django.template import RequestContext

from myform.forms import *

def show_form(request):
    """
    Recaptcha example
    """
    form = RegisterProForm()
    if request.POST:
        form = RegisterProForm(request.POST)
        if form.is_valid():
            print 'ok'
            return HttpResponseRedirect('/')
    
    return render_to_response('myform.html', {'form': form}, context_instance=RequestContext(request))

Oraz szablon:

<form action="./" method="post">{% csrf_token %}
    {{ form.login }}{% if form.login.errors %}<div class="errmsg">{{ form.login.errors|join:", " }}</div>{% endif %}<br />
    {{ form.recaptcha }}{% if form.recaptcha.errors %}<div class="errmsg">{{ form.recaptcha.errors|join:", " }}</div>{% endif %}<br />
    
    <input type="submit" value="Send Form" />
    </form>

Gotowe. Mamy formularz z widżetem ReCaptcha, który jest walidowany wraz z całym formularzem.

RkBlog

Django, 1 February 2011