Added admin sugar for julian models. Corrected minor typos and omissions. Filled...
[philo.git] / contrib / waldo / models.py
index e2d70ae..d35e22a 100644 (file)
@@ -7,7 +7,6 @@ from django.contrib.auth.models import User
 from django.contrib.auth.tokens import default_token_generator as password_token_generator
 from django.contrib.sites.models import Site
 from django.core.mail import EmailMultiAlternatives, send_mail
-from django.core.urlresolvers import reverse
 from django.db import models
 from django.http import Http404, HttpResponseRedirect
 from django.shortcuts import render_to_response, get_object_or_404
@@ -17,7 +16,7 @@ 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
-from philo.contrib.waldo.forms import LOGIN_FORM_KEY, LoginForm, RegistrationForm
+from philo.contrib.waldo.forms import LOGIN_FORM_KEY, LoginForm, RegistrationForm, UserAccountForm
 from philo.contrib.waldo.tokens import registration_token_generator, email_token_generator
 import urlparse
 
@@ -25,13 +24,6 @@ import urlparse
 ERROR_MESSAGE = ugettext_lazy("Please enter a correct username and password. Note that both fields are case-sensitive.")
 
 
-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):
        """
        Handles login, registration, and forgotten passwords. In other words, this
@@ -49,27 +41,31 @@ class LoginMultiView(MultiView):
        @property
        def urlpatterns(self):
                urlpatterns = patterns('',
-                       url(r'^login/$', self.login, name='login'),
-                       url(r'^logout/$', self.logout, name='logout'),
+                       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<uidb36>\w+)/(?P<token>[^/]+)/$', self.password_reset_confirm, name='password_reset_confirm'),
+                       url(r'^password/reset$', csrf_protect(self.password_reset), name='password_reset'),
+                       url(r'^password/reset/(?P<uidb36>\w+)/(?P<token>[^/]+)$', self.password_reset_confirm, name='password_reset_confirm'),
                        
-                       url(r'^register/$', csrf_protect(self.register), name='register'),
-                       url(r'^register/(?P<uidb36>\w+)/(?P<token>[^/]+)/$', self.register_confirm, name='register_confirm')
+                       url(r'^register$', csrf_protect(self.register), name='register'),
+                       url(r'^register/(?P<uidb36>\w+)/(?P<token>[^/]+)$', 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'),
+                               url(r'^password/change$', csrf_protect(self.login_required(self.password_change)), name='password_change'),
                        )
                
                return urlpatterns
        
-       def get_context(self, extra_dict=None):
-               context = {}
-               context.update(extra_dict or {})
-               return context
+       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()
@@ -97,11 +93,12 @@ class LoginMultiView(MultiView):
                        form = LoginForm(request.POST)
                else:
                        form = LoginForm()
-               context = self.get_context({
+               context = self.get_context()
+               context.update(extra_context or {})
+               context.update({
                        'message': message,
                        'form': form
                })
-               context.update(extra_context or {})
                return self.login_page.render_to_response(request, extra_context=context)
        
        def login(self, request, extra_context=None):
@@ -111,7 +108,8 @@ class LoginMultiView(MultiView):
                if request.user.is_authenticated():
                        return HttpResponseRedirect(request.node.get_absolute_url())
                
-               context = self.get_context(extra_context)
+               context = self.get_context()
+               context.update(extra_context or {})
                
                from django.contrib.auth.models import User
                
@@ -164,13 +162,12 @@ class LoginMultiView(MultiView):
        login = never_cache(login)
        
        def logout(self, request):
-               return auth_views.logout(request, request.META['HTTP_REFERER'])
+               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():
-                               login_url = reverse('login', urlconf=self).strip('/')
-                               return HttpResponseRedirect('%s%s/' % (request.node.get_absolute_url(), login_url))
+                               return HttpResponseRedirect(self.reverse('login', node=request.node))
                        return view(request, *args, **kwargs)
                
                return inner
@@ -195,10 +192,8 @@ class LoginMultiView(MultiView):
                        if form.is_valid():
                                current_site = Site.objects.get_current()
                                for user in form.users_cache:
-                                       token = token_generator.make_token(user)
-                                       link = 'http://%s/%s/%s/' % (current_site.domain, request.node.get_absolute_url().strip('/'), reverse('password_reset_confirm', urlconf=self, kwargs={'uidb36': int_to_base36(user.id), 'token': token}).strip('/'))
                                        context = {
-                                               'link': link,
+                                               'link': self.make_confirmation_link('password_reset_confirm', token_generator, user, request.node),
                                                'username': user.username
                                        }
                                        self.send_confirmation_email('Confirm password reset for account at %s' % current_site.domain, user.email, self.password_reset_confirmation_email, context)
@@ -207,8 +202,11 @@ class LoginMultiView(MultiView):
                else:
                        form = PasswordResetForm()
                
-               context = self.get_context({'form': form})
+               context = self.get_context()
                context.update(extra_context or {})
+               context.update({
+                       'form': form
+               })
                return self.password_reset_page.render_to_response(request, extra_context=context)
        
        def password_reset_confirm(self, request, extra_context=None, uidb36=None, token=None, token_generator=password_token_generator):
@@ -231,11 +229,15 @@ class LoginMultiView(MultiView):
                                if form.is_valid():
                                        form.save()
                                        messages.add_message(request, messages.SUCCESS, "Password reset successful.")
-                                       return HttpResponseRedirect('/%s/%s/' % (request.node.get_absolute_url().strip('/'), reverse('login', urlconf=self).strip('/')))
+                                       return HttpResponseRedirect(self.reverse('login', node=request.node))
                        else:
                                form = SetPasswordForm(user)
                        
-                       context = self.get_context({'form': form})
+                       context = self.get_context()
+                       context.update(extra_context or {})
+                       context.update({
+                               'form': form
+                       })
                        return self.password_set_page.render_to_response(request, extra_context=context)
                
                raise Http404
@@ -250,8 +252,11 @@ class LoginMultiView(MultiView):
                else:
                        form = PasswordChangeForm(request.user)
                
-               context = self.get_context({'form': form})
+               context = self.get_context()
                context.update(extra_context or {})
+               context.update({
+                       'form': form
+               })
                return self.password_change_page.render_to_response(request, extra_context=context)
        
        def register(self, request, extra_context=None, token_generator=registration_token_generator):
@@ -262,20 +267,21 @@ class LoginMultiView(MultiView):
                        form = RegistrationForm(request.POST)
                        if form.is_valid():
                                user = form.save()
-                               current_site = Site.objects.get_current()
-                               token = token_generator.make_token(user)
-                               link = 'http://%s/%s/%s/' % (current_site.domain, request.node.get_absolute_url().strip('/'), reverse('register_confirm', urlconf=self, kwargs={'uidb36': int_to_base36(user.id), 'token': token}).strip('/'))
                                context = {
-                                       'link': link
+                                       'link': self.make_confirmation_link('register_confirm', token_generator, user, request.node)
                                }
+                               current_site = Site.objects.get_current()
                                self.send_confirmation_email('Confirm account creation at %s' % current_site.name, user.email, self.register_confirmation_email, context)
                                messages.add_message(request, messages.SUCCESS, 'An email has been sent to %s with details on activating your account.' % user.email, fail_silently=True)
                                return HttpResponseRedirect(request.node.get_absolute_url())
                else:
                        form = RegistrationForm()
                
-               context = self.get_context({'form': form})
+               context = self.get_context()
                context.update(extra_context or {})
+               context.update({
+                       'form': form
+               })
                return self.register_page.render_to_response(request, extra_context=context)
        
        def register_confirm(self, request, extra_context=None, uidb36=None, token=None, token_generator=registration_token_generator):
@@ -294,10 +300,11 @@ class LoginMultiView(MultiView):
                if token_generator.check_token(user, token):
                        user.is_active = True
                        true_password = user.password
+                       temp_password = token_generator.make_token(user)
                        try:
-                               user.set_password('temp_password')
+                               user.set_password(temp_password)
                                user.save()
-                               authenticated_user = authenticate(username=user.username, password='temp_password')
+                               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.
@@ -316,106 +323,60 @@ class LoginMultiView(MultiView):
 
 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.
+       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')
-       user_fields = ['first_name', 'last_name', 'email']
-       required_user_fields = user_fields
-       account_profile = None
-       account_profile_fields = None
+       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<uidb36>\w+)/(?P<email>[\w.]+[+][\w.]+)/(?P<token>[^/]+)/$', self.email_change_confirm, name='email_change_confirm')
+                       url(r'^account$', self.login_required(self.account_view), name='account'),
+                       url(r'^account/email/(?P<uidb36>\w+)/(?P<email>[\w.]+[+][\w.]+)/(?P<token>[^/]+)$', self.email_change_confirm, name='email_change_confirm')
                )
                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, extra_context=None, token_generator=email_token_generator, *args, **kwargs):
                if request.method == 'POST':
-                       form_instances = self.get_account_form_instances(request.user, request.POST)
-                       current_email = request.user.email
+                       form = self.account_form(request.user, request.POST, request.FILES)
                        
-                       for form in form_instances:
-                               if not form.is_valid():
-                                       break
-                       else:
-                               # When the user_form is validated, it changes the model instance, i.e. request.user, in place.
-                               email = request.user.email
-                               if current_email != email:
-                                       
-                                       request.user.email = current_email
+                       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.
+                                       request.user.email = form.initial['email']
                                        
-                                       for form in form_instances:
-                                               form.cleaned_data.pop('email', None)
+                                       email = form.cleaned_data.pop('email')
                                        
-                                       current_site = Site.objects.get_current()
-                                       token = token_generator.make_token(request.user, email)
-                                       link = 'http://%s/%s/%s/' % (current_site.domain, request.node.get_absolute_url().strip('/'), reverse('email_change_confirm', urlconf=self, kwargs={'uidb36': int_to_base36(request.user.id), 'email': email.replace('@', '+'), 'token': token}).strip('/'))
                                        context = {
-                                               'link': link
+                                               'link': self.make_confirmation_link('email_change_confirm', token_generator, request.user, request.node, token_args=[email], reverse_kwargs={'email': email.replace('@', '+')})
                                        }
+                                       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)
-                                       
-                               for form in form_instances:
-                                       form.save()
+                               
+                               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)
+                       form = self.account_form(request.user)
                
-               context = self.get_context({
-                       'forms': form_instances
-               })
+               context = self.get_context()
                context.update(extra_context or {})
+               context.update({
+                       'form': form
+               })
                return self.manage_account_page.render_to_response(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
+               form = self.account_form(user, {})
+               form.data = form.initial
+               return form.is_valid()
        
        def account_required(self, view):
                def inner(request, *args, **kwargs):
@@ -430,7 +391,7 @@ class AccountMultiView(LoginMultiView):
        
        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('/%s/%s/' % (request.node.get_absolute_url().strip('/'), reverse('account', urlconf=self).strip('/')))
+               return HttpResponseRedirect(self.reverse('account', node=request.node))
        
        def email_change_confirm(self, request, extra_context=None, uidb36=None, token=None, email=None, token_generator=email_token_generator):
                """
@@ -455,7 +416,7 @@ class AccountMultiView(LoginMultiView):
                        user.email = email
                        user.save()
                        messages.add_message(request, messages.SUCCESS, 'Email changed successfully.')
-                       return HttpResponseRedirect('/%s/%s/' % (request.node.get_absolute_url().strip('/'), reverse('account', urlconf=self).strip('/')))
+                       return HttpResponseRedirect(self.reverse('account', node=request.node))
                
                raise Http404