Allow forms to be overriden (closes #511)

Author: pennersr

ChangeLog

@@ -1,3 +1,8 @@
+2014-07-22  Raymond Penners  <raymond.penners@intenct.nl>
+
+	* All forms are now pluggable via a new setting:
+	`(SOCIAL)ACCOUNT_FORMS`.
+
 2014-07-05  Raymond Penners  <raymond.penners@intenct.nl>
 
 	* James Thompson contributed Windows Live support, thanks!

allauth/account/app_settings.py

@@ -222,6 +222,10 @@ def SESSION_REMEMBER(self):
         """
         return self._setting('SESSION_REMEMBER', None)
 
+    @property
+    def FORMS(self):
+        return self._setting('FORMS', {})
+
 
 # Ugly? Guido recommends this himself ...
 # http://mail.python.org/pipermail/python-ideas/2012-May/014969.html

allauth/account/views.py

@@ -13,7 +13,7 @@
 from django.shortcuts import redirect
 
 from ..exceptions import ImmediateHttpResponse
-from ..utils import get_user_model
+from ..utils import get_user_model, get_form_class
 
 from .utils import (get_next_redirect_url, complete_signup,
                     get_login_redirect_url, perform_login,
@@ -89,6 +89,9 @@ class LoginView(RedirectAuthenticatedUserMixin,
     success_url = None
     redirect_field_name = "next"
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS, 'login', self.form_class)
+
     def form_valid(self, form):
         success_url = self.get_success_url()
         return form.login(self.request, redirect_url=success_url)
@@ -150,6 +153,9 @@ class SignupView(RedirectAuthenticatedUserMixin, CloseableSignupMixin,
     redirect_field_name = "next"
     success_url = None
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS, 'signup', self.form_class)
+
     def get_success_url(self):
         # Explicitly passed ?next= URL takes precedence
         ret = (get_next_redirect_url(self.request,
@@ -281,6 +287,9 @@ class EmailView(FormView):
     form_class = AddEmailForm
     success_url = reverse_lazy('account_email')
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS, 'add_email', self.form_class)
+
     def dispatch(self, request, *args, **kwargs):
         sync_user_email_addresses(request.user)
         return super(EmailView, self).dispatch(request, *args, **kwargs)
@@ -420,6 +429,11 @@ class PasswordChangeView(FormView):
     form_class = ChangePasswordForm
     success_url = reverse_lazy("account_change_password")
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'change_password',
+                              self.form_class)
+
     def dispatch(self, request, *args, **kwargs):
         if not request.user.has_usable_password():
             return HttpResponseRedirect(reverse('account_set_password'))
@@ -456,6 +470,11 @@ class PasswordSetView(FormView):
     form_class = SetPasswordForm
     success_url = reverse_lazy("account_set_password")
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'set_password',
+                              self.form_class)
+
     def dispatch(self, request, *args, **kwargs):
         if request.user.has_usable_password():
             return HttpResponseRedirect(reverse('account_change_password'))
@@ -490,6 +509,11 @@ class PasswordResetView(FormView):
     form_class = ResetPasswordForm
     success_url = reverse_lazy("account_reset_password_done")
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'reset_password',
+                              self.form_class)
+
     def form_valid(self, form):
         form.save()
         return super(PasswordResetView, self).form_valid(form)
@@ -516,6 +540,11 @@ class PasswordResetFromKeyView(FormView):
     token_generator = default_token_generator
     success_url = reverse_lazy("account_reset_password_from_key_done")
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'reset_password_from_key',
+                              self.form_class)
+
     def _get_user(self, uidb36):
         # pull out user
         try:

allauth/socialaccount/app_settings.py

@@ -59,6 +59,11 @@ def ADAPTER(self):
                              'allauth.socialaccount.adapter'
                              '.DefaultSocialAccountAdapter')
 
+    @property
+    def FORMS(self):
+        return self._setting('FORMS', {})
+
+
 # Ugly? Guido recommends this himself ...
 # http://mail.python.org/pipermail/python-ideas/2012-May/014969.html
 import sys

allauth/socialaccount/views.py

@@ -9,17 +9,25 @@
 from ..account.views import (CloseableSignupMixin,
                              RedirectAuthenticatedUserMixin)
 from ..account.adapter import get_adapter as get_account_adapter
+from ..utils import get_form_class
+
 from .adapter import get_adapter
 from .models import SocialLogin
 from .forms import DisconnectForm, SignupForm
 from . import helpers
+from . import app_settings
 
 
 class SignupView(RedirectAuthenticatedUserMixin, CloseableSignupMixin,
                  FormView):
     form_class = SignupForm
     template_name = 'socialaccount/signup.html'
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'signup',
+                              self.form_class)
+
     def dispatch(self, request, *args, **kwargs):
         self.sociallogin = None
         data = request.session.get('socialaccount_sociallogin')
@@ -73,6 +81,11 @@ class ConnectionsView(FormView):
     form_class = DisconnectForm
     success_url = reverse_lazy("socialaccount_connections")
 
+    def get_form_class(self):
+        return get_form_class(app_settings.FORMS,
+                              'disconnect',
+                              self.form_class)
+
     def get_form_kwargs(self):
         kwargs = super(ConnectionsView, self).get_form_kwargs()
         kwargs["request"] = self.request

allauth/utils.py

@@ -188,3 +188,10 @@ def build_absolute_uri(request, location, protocol=None):
     if protocol:
         uri = protocol + ':' + uri.partition(':')[2]
     return uri
+
+
+def get_form_class(forms, form_id, default_form):
+    form_class = forms.get(form_id, default_form)
+    if isinstance(form_class, six.string_types):
+        form_class = import_attribute(form_class)
+    return form_class

docs/configuration.rst

@@ -48,6 +48,10 @@ ACCOUNT_DEFAULT_HTTP_PROTOCOL = (="http")
   password forgotten procedure. Note that this is a default only --
   see the section on HTTPS for more information.
 
+ACCOUNT_FORMS (={})
+  Used to override forms, for example:
+  `{'login': 'myapp.forms.LoginForm'}`
+
 ACCOUNT_LOGOUT_ON_GET (=False)
   Determines whether or not the user is automatically logged out by a
   mere GET request. See documentation for the `LogoutView` for
@@ -136,5 +140,9 @@ SOCIALACCOUNT_EMAIL_REQUIRED (=ACCOUNT_EMAIL_REQUIRED)
 SOCIALACCOUNT_EMAIL_VERIFICATION (=ACCOUNT_EMAIL_VERIFICATION)
   As `ACCOUNT_EMAIL_VERIFICATION`, but for social accounts.
 
+SOCIALACCOUNT_FORMS (={})
+  Used to override forms, for example:
+  `{'signup': 'myapp.forms.SignupForm'}`
+
 SOCIALACCOUNT_PROVIDERS (= dict)
   Dictionary containing provider specific settings.