From d551c23cbb6af406607306fb2ce5572f2cca0d2a Mon Sep 17 00:00:00 2001 From: Stephen Burrows Date: Mon, 9 Aug 2010 17:42:19 -0400 Subject: [PATCH] Initial waldo commit. Implements abstract LoginMultiView and AccountMultiView to generically handle login situations for philo. --- contrib/waldo/__init__.py | 0 contrib/waldo/models.py | 230 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 contrib/waldo/__init__.py create mode 100644 contrib/waldo/models.py diff --git a/contrib/waldo/__init__.py b/contrib/waldo/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/contrib/waldo/models.py b/contrib/waldo/models.py new file mode 100644 index 0000000..d0669ff --- /dev/null +++ b/contrib/waldo/models.py @@ -0,0 +1,230 @@ +from django import forms +from django.conf.urls.defaults import url, patterns, include +from django.contrib import messages +from django.contrib.auth import authenticate, login, views as auth_views +from django.contrib.auth.forms import AuthenticationForm +from django.contrib.auth.models import User +from django.db import models +from django.http import Http404, HttpResponseRedirect +from django.shortcuts import render_to_response +from django.utils.translation import ugettext_lazy, ugettext as _ +from django.views.decorators.cache import never_cache +from django.views.decorators.csrf import csrf_protect +from philo.models import MultiView, Page + + +ERROR_MESSAGE = ugettext_lazy("Please enter a correct username and password. Note that both fields are case-sensitive.") +LOGIN_FORM_KEY = 'this_is_the_login_form' +LoginForm = type('LoginForm', (AuthenticationForm,), { + LOGIN_FORM_KEY: forms.BooleanField(widget=forms.HiddenInput, initial=True) +}) + + +def get_field_data(obj, fields): + if fields == None: + fields = [field.name for field in obj._meta.fields if field.editable] + + return dict([(field.name, field.value_from_object(obj)) for field in obj._meta.fields if field.name in fields]) + + +class LoginMultiView(MultiView): + login_page = models.ForeignKey(Page, related_name='login_related') + + @property + def urlpatterns(self): + urlpatterns = patterns('', + url(r'^login/$', self.login, name='login'), + url(r'^logout/$', self.logout, name='logout') + ) + return urlpatterns + + def get_context(self, extra_dict=None): + context = {} + context.update(extra_dict or {}) + return context + + def display_login_page(self, request, message, node=None, extra_context=None): + request.session.set_test_cookie() + + redirect = request.META.get('HTTP_REFERER', None) + path = request.get_full_path() + if redirect != path: + if redirect is None: + redirect = '/'.join(path.split('/')[:-2]) + request.session['redirect'] = redirect + + if request.POST: + form = LoginForm(request.POST) + else: + form = LoginForm() + context = self.get_context({ + 'message': message, + 'form': form + }) + context.update(extra_context or {}) + return self.login_page.render_to_response(node, request, extra_context=context) + + def login(self, request, node=None, extra_context=None): + """ + Displays the login form for the given HttpRequest. + """ + context = self.get_context(extra_context) + + from django.contrib.auth.models import User + + # 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, node, 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, node, context) + else: + request.session.delete_test_cookie() + + # 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, node, context) + + # The user data is correct; log in the user in and continue. + else: + if user.is_active: + login(request, user) + redirect = request.session.pop('redirect') + return HttpResponseRedirect(redirect) + else: + return self.display_login_page(request, ERROR_MESSAGE, node, context) + login = never_cache(login) + + def logout(self, request): + return auth_views.logout(request, request.META['HTTP_REFERER']) + + def login_required(self, view): + def inner(request, node=None, *args, **kwargs): + if not request.user.is_authenticated(): + root_url = node.get_path(Site.objects.get_current().root_node).strip('/') + login_url = reverse('login', urlconf=self).strip('/') + return HttpResponseRedirect('/%s/%s/' % (root_url, login_url)) + return view(request, node=node, *args, **kwargs) + + return inner + + class Meta: + abstract = True + + +class AccountMultiView(LoginMultiView): + """ + Subclasses may define an account_profile model, fields from the User model + to include in the account, and fields from the account profile to use in + the account. + """ + manage_account_page = models.ForeignKey(Page, related_name='classifieds_manage_account_page') + user_fields = ['first_name', 'last_name', 'email'] + required_user_fields = user_fields + account_profile = None + account_profile_fields = None + + @property + def urlpatterns(self): + urlpatterns = super(AccountMultiView, self).urlpatterns + urlpatterns += patterns('', + url(r'^account/$', self.login_required(self.account_view), name='account') + ) + return urlpatterns + + def get_account_forms(self): + user_form = forms.models.modelform_factory(User, fields=self.user_fields) + + if self.account_profile is None: + profile_form = None + else: + profile_form = forms.models.modelform_factory(self.account_profile, fields=self.account_profile_fields or [field.name for field in self.account_profile._meta.fields if field.editable and field.name != 'user']) + + for field_name, field in user_form.base_fields.items(): + if field_name in self.required_user_fields: + field.required = True + return user_form, profile_form + + def get_account_form_instances(self, user, data=None): + form_instances = [] + user_form, profile_form = self.get_account_forms() + if data is None: + form_instances.append(user_form(instance=user)) + if profile_form: + form_instances.append(profile_form(instance=self.account_profile._default_manager.get_or_create(user=user)[0])) + else: + form_instances.append(user_form(data, instance=user)) + if profile_form: + form_instances.append(profile_form(data, instance=self.account_profile._default_manager.get_or_create(user=user)[0])) + + return form_instances + + def account_view(self, request, node=None, extra_context=None): + if request.method == 'POST': + form_instances = self.get_account_form_instances(request.user, request.POST) + + for form in form_instances: + if not form.is_valid(): + break + else: + for form in form_instances: + form.save() + messages.add_message(request, messages.SUCCESS, "Account information saved.", fail_silently=True) + return HttpResponseRedirect('') + else: + form_instances = self.get_account_form_instances(request.user) + + context = self.get_context({ + 'forms': form_instances + }) + context.update(extra_context or {}) + return self.manage_account_page.render_to_response(node, request, extra_context=context) + + def has_valid_account(self, user): + user_form, profile_form = self.get_account_forms() + forms = [] + forms.append(user_form(data=get_field_data(user, self.user_fields))) + + if profile_form is not None: + profile = self.account_profile._default_manager.get_or_create(user=user)[0] + forms.append(profile_form(data=get_field_data(profile, self.account_profile_fields))) + + for form in forms: + if not form.is_valid(): + return False + return True + + def account_required(self, view): + def inner(request, *args, **kwargs): + if not self.has_valid_account(request.user): + messages.add_message(request, messages.ERROR, "You need to add some account information before you can post listings.") + return self.account_view(request, *args, **kwargs) + return view(request, *args, **kwargs) + + inner = self.login_required(inner) + return inner + + class Meta: + abstract = True \ No newline at end of file -- 2.20.1