first draft of a registration form + email
[myslice.git] / portal / views.py
index c84c20a..0a27fae 100644 (file)
 # this program; see the file COPYING.  If not, write to the Free Software
 # Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-from django.shortcuts import render
-from portal.forms     import UserRegisterForm, SliceRequestForm
+from django.conf                import settings
+from django.contrib.sites.models import RequestSite
+from django.contrib.sites.models import Site
 
-def user_register(request):
-    if request.method == 'POST':
-        form = UserRegisterForm(request.POST)
-        if form.is_valid():
-            first_name = form.cleaned_data['first_name']
-            last_name  = form.cleaned_data['last_name']
-            email      = form.cleaned_data['email']
-            password   = form.cleaned_data['password']
-            password2  = form.cleaned_data['password2']
-            keypair    = form.cleaned_data['keypair']
-            ## Ici nous pouvons traiter les données du formulaire
-            #sujet = form.cleaned_data['sujet']
-            #message = form.cleaned_data['message']
-            #envoyeur = form.cleaned_data['envoyeur']
-            #renvoi = form.cleaned_data['renvoi']
-            ## Nous pourrions ici envoyer l'e-mail grâce aux données que nous venons de récupérer
-            #envoi = True
-    else:
-        form = UserRegisterForm()
-    return render(request, 'user_register.html', locals())
+from django.shortcuts           import render
+from portal.forms               import UserRegisterForm, SliceRequestForm
+from portal.util                import RegistrationView, ActivationView
+from portal.models              import PendingUser, PendingSlice
+from portal                     import signals
 
-def user_validate(request):
-    pass
+class UserRegisterView(RegistrationView):
+    """
+    A registration backend which follows a simple workflow:
 
-def slice_request(request):
-    if request.method == 'POST':
-        form = SliceRequestForm(request.POST)
-        if form.is_valid():
-            slice_name = form.cleaned_data['slice_name']
-    else:
-        form = SliceRequestForm()
-    return render(request, 'slice_request.html', locals())
+    1. User signs up, inactive account is created.
+
+    2. Email is sent to user with activation link.
+
+    3. User clicks activation link, account is now active.
+
+    Using this backend requires that
+
+    * ``registration`` be listed in the ``INSTALLED_APPS`` setting
+      (since this backend makes use of models defined in this
+      application).
+
+    * The setting ``ACCOUNT_ACTIVATION_DAYS`` be supplied, specifying
+      (as an integer) the number of days from registration during
+      which a user may activate their account (after that period
+      expires, activation will be disallowed).
+
+    * The creation of the templates
+      ``registration/activation_email_subject.txt`` and
+      ``registration/activation_email.txt``, which will be used for
+      the activation email. See the notes for this backends
+      ``register`` method for details regarding these templates.
+
+    Additionally, registration can be temporarily closed by adding the
+    setting ``REGISTRATION_OPEN`` and setting it to
+    ``False``. Omitting this setting, or setting it to ``True``, will
+    be interpreted as meaning that registration is currently open and
+    permitted.
+
+    Internally, this is accomplished via storing an activation key in
+    an instance of ``registration.models.RegistrationProfile``. See
+    that model and its custom manager for full documentation of its
+    fields and supported operations.
+    
+    """
+    form_class = UserRegisterForm
+    
+    def register(self, request, **cleaned_data):
+        """
+        Given a username, email address and password, register a new
+        user account, which will initially be inactive.
+
+        Along with the new ``User`` object, a new
+        ``registration.models.RegistrationProfile`` will be created,
+        tied to that ``User``, containing the activation key which
+        will be used for this account.
+
+        An email will be sent to the supplied email address; this
+        email should contain an activation link. The email will be
+        rendered using two templates. See the documentation for
+        ``RegistrationProfile.send_activation_email()`` for
+        information about these templates and the contexts provided to
+        them.
+
+        After the ``User`` and ``RegistrationProfile`` are created and
+        the activation email is sent, the signal
+        ``registration.signals.user_registered`` will be sent, with
+        the new ``User`` as the keyword argument ``user`` and the
+        class of this backend as the sender.
+
+        """
+        first_name = cleaned_data['first_name']
+        last_name  = cleaned_data['last_name']
+        email      = cleaned_data['email']
+        password   = cleaned_data['password1']
+        #password2  = cleaned_data['password2']
+        keypair    = cleaned_data['keypair']
+
+        #if Site._meta.installed:
+        #    site = Site.objects.get_current()
+        #else:
+        #    site = RequestSite(request) 
+        site = None
+
+        new_user = PendingUser.objects.create_inactive_user(first_name, last_name, email, password, site)
+        signals.user_registered.send(sender=self.__class__,
+                                     user=new_user,
+                                     request=request)
+        return new_user
+
+    def registration_allowed(self, request):
+        """
+        Indicate whether account registration is currently permitted,
+        based on the value of the setting ``REGISTRATION_OPEN``. This
+        is determined as follows:
+
+        * If ``REGISTRATION_OPEN`` is not specified in settings, or is
+          set to ``True``, registration is permitted.
+
+        * If ``REGISTRATION_OPEN`` is both specified and set to
+          ``False``, registration is not permitted.
+        
+        """
+        return getattr(settings, 'REGISTRATION_OPEN', True)
+
+    def get_success_url(self, request, user):
+        """
+        Return the name of the URL to redirect to after successful
+        user registration.
+        
+        """
+        return ('registration_complete', (), {})
+
+
+class UserValidateView(ActivationView):
+    def activate(self, request, activation_key):
+        """
+        Given an an activation key, look up and activate the user
+        account corresponding to that key (if possible).
+
+        After successful activation, the signal
+        ``registration.signals.user_activated`` will be sent, with the
+        newly activated ``User`` as the keyword argument ``user`` and
+        the class of this backend as the sender.
+        
+        """
+        activated_user = RegistrationProfile.objects.activate_user(activation_key)
+        if activated_user:
+            signals.user_activated.send(sender=self.__class__,
+                                        user=activated_user,
+                                        request=request)
+        return activated_user
+
+    def get_success_url(self, request, user):
+        return ('registration_activation_complete', (), {})
 
-def slice_validate(request):
-    pass
 
 # DEPRECATED #from portal.portalpage  import PortalPage
 # DEPRECATED #from plugins.wizard     import Wizard