From: Stephen Burrows Date: Wed, 16 Feb 2011 19:44:14 +0000 (-0500) Subject: Switched user authentication in waldo from the login view to an AuthenticationForm... X-Git-Tag: philo-0.9~19^2~1 X-Git-Url: http://git.ithinksw.org/philo.git/commitdiff_plain/eec2d70e2fac187e43d611fc13de01a7f4bdddf9 Switched user authentication in waldo from the login view to an AuthenticationForm for clearer organization of code. Split LoginMultiView into three layered views: LoginMultiView, PasswordMultiView, and RegistrationMultiView, where each layer adds additional (optional) functionality. This structure then naturally includes AccountMultiView as well. Improved redirection for login_required and account_required views. --- diff --git a/contrib/waldo/forms.py b/contrib/waldo/forms.py index 615d302..de3349a 100644 --- a/contrib/waldo/forms.py +++ b/contrib/waldo/forms.py @@ -1,6 +1,7 @@ from datetime import date from django import forms from django.conf import settings +from django.contrib.auth import authenticate from django.contrib.auth.forms import AuthenticationForm, UserCreationForm from django.contrib.auth.models import User from django.core.exceptions import ValidationError @@ -8,12 +9,6 @@ from django.utils.translation import ugettext_lazy as _ from philo.contrib.waldo.tokens import REGISTRATION_TIMEOUT_DAYS -LOGIN_FORM_KEY = 'this_is_the_login_form' -LoginForm = type('LoginForm', (AuthenticationForm,), { - LOGIN_FORM_KEY: forms.BooleanField(widget=forms.HiddenInput, initial=True) -}) - - class EmailInput(forms.TextInput): input_type = 'email' @@ -70,4 +65,38 @@ class UserAccountForm(forms.ModelForm): class Meta: model = User - fields = ('first_name', 'last_name', 'email') \ No newline at end of file + fields = ('first_name', 'last_name', 'email') + + +class WaldoAuthenticationForm(AuthenticationForm): + ERROR_MESSAGE = _("Please enter a correct username and password. Note that both fields are case-sensitive.") + + def clean(self): + username = self.cleaned_data['username'] + password = self.cleaned_data['password'] + message = self.ERROR_MESSAGE + + if username and password: + self.user_cache = authenticate(username=username, password=password) + if self.user_cache is None: + if u'@' in username: + # Maybe they entered their email? Look it up, but still raise a ValidationError. + try: + user = User.objects.get(email=username) + except (User.DoesNotExist, User.MultipleObjectsReturned): + pass + else: + if user.check_password(password): + message = _("Your e-mail address is not your username. Try '%s' instead.") % user.username + raise ValidationError(message) + elif not self.user_cache.is_active: + raise ValidationError(message) + self.check_for_test_cookie() + return self.cleaned_data + + def check_for_test_cookie(self): + # This method duplicates the Django 1.3 AuthenticationForm method. + if self.request and not self.request.session.test_cookie_worked(): + raise forms.ValidationError( + _("Your Web browser doesn't appear to have cookies enabled. " + "Cookies are required for logging in.")) \ No newline at end of file diff --git a/contrib/waldo/models.py b/contrib/waldo/models.py index d35e22a..f47dbd6 100644 --- a/contrib/waldo/models.py +++ b/contrib/waldo/models.py @@ -12,18 +12,15 @@ from django.http import Http404, HttpResponseRedirect from django.shortcuts import render_to_response, get_object_or_404 from django.template.defaultfilters import striptags from django.utils.http import int_to_base36, base36_to_int -from django.utils.translation import ugettext_lazy, ugettext as _ +from django.utils.translation import ugettext as _ from django.views.decorators.cache import never_cache from django.views.decorators.csrf import csrf_protect from philo.models import MultiView, Page -from philo.contrib.waldo.forms import LOGIN_FORM_KEY, LoginForm, RegistrationForm, UserAccountForm +from philo.contrib.waldo.forms import WaldoAuthenticationForm, RegistrationForm, UserAccountForm from philo.contrib.waldo.tokens import registration_token_generator, email_token_generator import urlparse -ERROR_MESSAGE = ugettext_lazy("Please enter a correct username and password. Note that both fields are case-sensitive.") - - class LoginMultiView(MultiView): """ Handles login, registration, and forgotten passwords. In other words, this @@ -31,147 +28,137 @@ class LoginMultiView(MultiView): passwords. """ login_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_login_related') - password_reset_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_reset_related') - password_reset_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_reset_confirmation_email_related') - password_set_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_set_related') - password_change_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_change_related', blank=True, null=True) - register_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_register_related') - register_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_register_confirmation_email_related') + login_form = WaldoAuthenticationForm @property def urlpatterns(self): - urlpatterns = patterns('', + return patterns('', url(r'^login$', self.login, name='login'), url(r'^logout$', self.logout, name='logout'), - - url(r'^password/reset$', csrf_protect(self.password_reset), name='password_reset'), - url(r'^password/reset/(?P\w+)/(?P[^/]+)$', self.password_reset_confirm, name='password_reset_confirm'), - - url(r'^register$', csrf_protect(self.register), name='register'), - url(r'^register/(?P\w+)/(?P[^/]+)$', self.register_confirm, name='register_confirm') ) - - if self.password_change_page: - urlpatterns += patterns('', - url(r'^password/change$', csrf_protect(self.login_required(self.password_change)), name='password_change'), - ) - - return urlpatterns - def make_confirmation_link(self, confirmation_view, token_generator, user, node, token_args=None, reverse_kwargs=None): - token = token_generator.make_token(user, *(token_args or [])) - kwargs = { - 'uidb36': int_to_base36(user.id), - 'token': token - } - kwargs.update(reverse_kwargs or {}) - return node.construct_url(subpath=self.reverse(confirmation_view, kwargs=kwargs), with_domain=True) - - def display_login_page(self, request, message, extra_context=None): - request.session.set_test_cookie() - - referrer = request.META.get('HTTP_REFERER', None) - - if referrer is not None: - referrer = urlparse.urlparse(referrer) - host = referrer[1] - if host != request.get_host(): - referrer = None - else: - redirect = '%s?%s' % (referrer[2], referrer[4]) + def set_requirement_redirect(self, request, redirect=None): + "Figure out where someone should end up after landing on a `requirement` page like the login page." + if redirect is not None: + pass + elif 'requirement_redirect' in request.session: + return + else: + referrer = request.META.get('HTTP_REFERER', None) - if referrer is None: - redirect = request.node.get_absolute_url() + if referrer is not None: + referrer = urlparse.urlparse(referrer) + host = referrer[1] + if host != request.get_host(): + referrer = None + else: + redirect = '%s?%s' % (referrer[2], referrer[4]) - path = request.get_full_path() - if redirect != path: - if redirect is None: - redirect = '/'.join(path.split('/')[:-2]) - request.session['redirect'] = redirect + path = request.get_full_path() + if referrer is None or redirect == path: + # Default to the index page if we can't find a referrer or + # if we'd otherwise redirect to where we already are. + redirect = request.node.get_absolute_url() - if request.POST: - form = LoginForm(request.POST) + request.session['requirement_redirect'] = redirect + + def get_requirement_redirect(self, request, default=None): + redirect = request.session.pop('requirement_redirect', None) + # Security checks a la django.contrib.auth.views.login + if not redirect or ' ' in redirect: + redirect = default else: - form = LoginForm() - context = self.get_context() - context.update(extra_context or {}) - context.update({ - 'message': message, - 'form': form - }) - return self.login_page.render_to_response(request, extra_context=context) + netloc = urlparse.urlparse(redirect)[1] + if netloc and netloc != request.get_host(): + redirect = default + if redirect is None: + redirect = request.node.get_absolute_url() + return redirect + @never_cache def login(self, request, extra_context=None): """ Displays the login form for the given HttpRequest. """ - if request.user.is_authenticated(): - return HttpResponseRedirect(request.node.get_absolute_url()) - - context = self.get_context() - context.update(extra_context or {}) + self.set_requirement_redirect(request) - from django.contrib.auth.models import User + # Redirect already-authenticated users to the index page. + if request.user.is_authenticated(): + messages.add_message(request, messages.INFO, "You are already authenticated. Please log out if you wish to log in as a different user.") + return HttpResponseRedirect(self.get_requirement_redirect(request)) - # If this isn't already the login page, display it. - if not request.POST.has_key(LOGIN_FORM_KEY): - if request.POST: - message = _("Please log in again, because your session has expired.") - else: - message = "" - return self.display_login_page(request, message, context) - - # Check that the user accepts cookies. - if not request.session.test_cookie_worked(): - message = _("Looks like your browser isn't configured to accept cookies. Please enable cookies, reload this page, and try again.") - return self.display_login_page(request, message, context) + if request.method == 'POST': + form = self.login_form(request=request, data=request.POST) + if form.is_valid(): + redirect = self.get_requirement_redirect(request) + login(request, form.get_user()) + + if request.session.test_cookie_worked(): + request.session.delete_test_cookie() + + return HttpResponseRedirect(redirect) else: - request.session.delete_test_cookie() + form = self.login_form() - # Check the password. - username = request.POST.get('username', None) - password = request.POST.get('password', None) - user = authenticate(username=username, password=password) - if user is None: - message = ERROR_MESSAGE - if username is not None and u'@' in username: - # Mistakenly entered e-mail address instead of username? Look it up. - try: - user = User.objects.get(email=username) - except (User.DoesNotExist, User.MultipleObjectsReturned): - message = _("Usernames cannot contain the '@' character.") - else: - if user.check_password(password): - message = _("Your e-mail address is not your username." - " Try '%s' instead.") % user.username - else: - message = _("Usernames cannot contain the '@' character.") - return self.display_login_page(request, message, context) - - # The user data is correct; log in the user in and continue. - else: - if user.is_active: - login(request, user) - try: - redirect = request.session.pop('redirect') - except KeyError: - redirect = request.node.get_absolute_url() - return HttpResponseRedirect(redirect) - else: - return self.display_login_page(request, ERROR_MESSAGE, context) - login = never_cache(login) + request.session.set_test_cookie() + + context = self.get_context() + context.update(extra_context or {}) + context.update({ + 'form': form + }) + return self.login_page.render_to_response(request, extra_context=context) - def logout(self, request): + @never_cache + def logout(self, request, extra_context=None): return auth_views.logout(request, request.META.get('HTTP_REFERER', request.node.get_absolute_url())) def login_required(self, view): def inner(request, *args, **kwargs): if not request.user.is_authenticated(): + self.set_requirement_redirect(request, redirect=request.path) + if request.POST: + messages.add_message(request, messages.ERROR, "Please log in again, because your session has expired.") return HttpResponseRedirect(self.reverse('login', node=request.node)) return view(request, *args, **kwargs) return inner + class Meta: + abstract = True + + +class PasswordMultiView(LoginMultiView): + password_reset_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_reset_related', blank=True, null=True) + password_reset_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_reset_confirmation_email_related', blank=True, null=True) + password_set_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_set_related', blank=True, null=True) + password_change_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_password_change_related', blank=True, null=True) + + @property + def urlpatterns(self): + urlpatterns = super(PasswordMultiView, self).urlpatterns + + if self.password_reset_page and self.password_reset_confirmation_email and self.password_set_page: + urlpatterns += patterns('', + url(r'^password/reset$', csrf_protect(self.password_reset), name='password_reset'), + url(r'^password/reset/(?P\w+)/(?P[^/]+)$', self.password_reset_confirm, name='password_reset_confirm'), + ) + + if self.password_change_page: + urlpatterns += patterns('', + url(r'^password/change$', csrf_protect(self.login_required(self.password_change)), name='password_change'), + ) + return urlpatterns + + def make_confirmation_link(self, confirmation_view, token_generator, user, node, token_args=None, reverse_kwargs=None): + token = token_generator.make_token(user, *(token_args or [])) + kwargs = { + 'uidb36': int_to_base36(user.id), + 'token': token + } + kwargs.update(reverse_kwargs or {}) + return node.construct_url(subpath=self.reverse(confirmation_view, kwargs=kwargs), with_domain=True) + def send_confirmation_email(self, subject, email, page, extra_context): text_content = page.render_to_string(extra_context=extra_context) from_email = 'noreply@%s' % Site.objects.get_current().domain @@ -259,6 +246,24 @@ class LoginMultiView(MultiView): }) return self.password_change_page.render_to_response(request, extra_context=context) + class Meta: + abstract = True + + +class RegistrationMultiView(PasswordMultiView): + register_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_register_related', blank=True, null=True) + register_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_register_confirmation_email_related', blank=True, null=True) + + @property + def urlpatterns(self): + urlpatterns = super(RegistrationMultiView, self).urlpatterns + if self.register_page and self.register_confirmation_email: + urlpatterns += patterns('', + url(r'^register$', csrf_protect(self.register), name='register'), + url(r'^register/(?P\w+)/(?P[^/]+)$', self.register_confirm, name='register_confirm') + ) + return urlpatterns + def register(self, request, extra_context=None, token_generator=registration_token_generator): if request.user.is_authenticated(): return HttpResponseRedirect(request.node.get_absolute_url()) @@ -307,7 +312,7 @@ class LoginMultiView(MultiView): authenticated_user = authenticate(username=user.username, password=temp_password) login(request, authenticated_user) finally: - # if anything goes wrong, ABSOLUTELY make sure that the true password is restored. + # if anything goes wrong, do our best make sure that the true password is restored. user.password = true_password user.save() return self.post_register_confirm_redirect(request) @@ -321,23 +326,28 @@ class LoginMultiView(MultiView): abstract = True -class AccountMultiView(LoginMultiView): +class AccountMultiView(RegistrationMultiView): """ By default, the `account` consists of the first_name, last_name, and email fields of the User model. Using a different account model is as simple as writing a form that accepts a User instance as the first argument. """ - manage_account_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_manage_account_related') - email_change_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_email_change_confirmation_email_related') + manage_account_page = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_manage_account_related', blank=True, null=True) + email_change_confirmation_email = models.ForeignKey(Page, related_name='%(app_label)s_%(class)s_email_change_confirmation_email_related', blank=True, null=True, help_text="If this is left blank, email changes will be performed without confirmation.") + account_form = UserAccountForm @property def urlpatterns(self): urlpatterns = super(AccountMultiView, self).urlpatterns - urlpatterns += patterns('', - url(r'^account$', self.login_required(self.account_view), name='account'), - url(r'^account/email/(?P\w+)/(?P[\w.]+[+][\w.]+)/(?P[^/]+)$', self.email_change_confirm, name='email_change_confirm') - ) + if self.manage_account_page: + urlpatterns += patterns('', + url(r'^account$', self.login_required(self.account_view), name='account'), + ) + if self.email_change_confirmation_email: + urlpatterns += patterns('', + url(r'^account/email/(?P\w+)/(?P[\w.]+[+][\w.]+)/(?P[^/]+)$', self.email_change_confirm, name='email_change_confirm') + ) return urlpatterns def account_view(self, request, extra_context=None, token_generator=email_token_generator, *args, **kwargs): @@ -345,10 +355,14 @@ class AccountMultiView(LoginMultiView): form = self.account_form(request.user, request.POST, request.FILES) if form.is_valid(): - if 'email' in form.changed_data: - # ModelForms modify their instances in-place during validation, - # so reset the instance's email to its previous value here, - # then remove the new value from cleaned_data. + message = "Account information saved." + redirect = self.get_requirement_redirect(request, default='') + if 'email' in form.changed_data and self.email_change_confirmation_email: + # ModelForms modify their instances in-place during + # validation, so reset the instance's email to its + # previous value here, then remove the new value + # from cleaned_data. We only do this if an email + # change confirmation email is available. request.user.email = form.initial['email'] email = form.cleaned_data.pop('email') @@ -358,11 +372,19 @@ class AccountMultiView(LoginMultiView): } current_site = Site.objects.get_current() self.send_confirmation_email('Confirm account email change at %s' % current_site.domain, email, self.email_change_confirmation_email, context) - messages.add_message(request, messages.SUCCESS, "An email has be sent to %s to confirm the email change." % email) + + message = "An email has be sent to %s to confirm the email%s." % (email, bool(request.user.email) and " change" or "") + if not request.user.email: + message += " You will need to confirm the email before accessing pages that require a valid account." + redirect = '' form.save() - messages.add_message(request, messages.SUCCESS, "Account information saved.", fail_silently=True) - return HttpResponseRedirect('') + + if redirect != '': + message += " Here you go!" + + messages.add_message(request, messages.SUCCESS, message, fail_silently=True) + return HttpResponseRedirect(redirect) else: form = self.account_form(request.user) @@ -381,17 +403,23 @@ class AccountMultiView(LoginMultiView): def account_required(self, view): def inner(request, *args, **kwargs): if not self.has_valid_account(request.user): - if not request.method == "POST": - messages.add_message(request, messages.ERROR, "You need to add some account information before you can access this page.", fail_silently=True) - return self.account_view(request, *args, **kwargs) + messages.add_message(request, messages.ERROR, "You need to add some account information before you can access that page.", fail_silently=True) + if self.manage_account_page: + self.set_requirement_redirect(request, redirect=request.path) + redirect = self.reverse('account', node=request.node) + else: + redirect = node.get_absolute_url() + return HttpResponseRedirect(redirect) return view(request, *args, **kwargs) inner = self.login_required(inner) return inner def post_register_confirm_redirect(self, request): - messages.add_message(request, messages.INFO, 'Welcome! Please fill in some more information.', fail_silently=True) - return HttpResponseRedirect(self.reverse('account', node=request.node)) + if self.manage_account_page: + messages.add_message(request, messages.INFO, 'Welcome! Please fill in some more information.', fail_silently=True) + return HttpResponseRedirect(self.reverse('account', node=request.node)) + return super(AccountMultiView, self).post_register_confirm_redirect(request) def email_change_confirm(self, request, extra_context=None, uidb36=None, token=None, email=None, token_generator=email_token_generator): """ @@ -416,7 +444,11 @@ class AccountMultiView(LoginMultiView): user.email = email user.save() messages.add_message(request, messages.SUCCESS, 'Email changed successfully.') - return HttpResponseRedirect(self.reverse('account', node=request.node)) + if self.manage_account_page: + redirect = self.reverse('account', node=request.node) + else: + redirect = request.node.get_absolute_url() + return HttpResponseRedirect(redirect) raise Http404