Merge pull request #338 from bruecksen/175-genussrechtler

Add option to automatically add a user to a group on signup

Author: bruecksen

.gitignore

@@ -150,6 +150,7 @@ typings/
 
 
 ### VisualStudioCode template
+.vscode/
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json

bakeup/shop/urls.py

@@ -24,6 +24,7 @@
    path(_("order-templates/"), view=CustomerOrderTemplateListView.as_view(), name="order-template-list"),
    path("profile/", view=shop_user_update_view, name="user-profile"),
    path(_("login/"), view=LoginView.as_view(), name="login"),
+   path(_("signup/<slug:token>/"), view=SignupView.as_view(), name="signup"),
    path(_("signup/"), view=SignupView.as_view(), name="signup"),
    path(_("account/closure/"), view=UserProfileDeleteView.as_view(), name="account-closure"),
    path("api/production-day-abo-products/<int:pk>/", view=production_day_abo_products, name="production-day-abo-products")

bakeup/static/js/project.min.js

@@ -7,19 +7,23 @@
 {% block page_content %}
 <div class="container h-100">
   <div class="row h-100 justify-content-center align-items-center">
-    <div class="col-12 col-md-6">
+    <div class="col-12 col-md-7">
       <div class="card">
         <div class="card-body tab-content min-height-500">
           <div class="d-flex justify-content-center">
             {% if settings.pages.BrandSettings.logo %}
             {% include "includes/logo.html" with logo_size='large' client_logo=settings.pages.BrandSettings.logo %}
             {% endif %}
           </div>
-          <h2 class="my-3 fw-bold">{% trans "Sign Up" %}</h2>
+          <h2 class="my-3 fw-bold">{% trans "Sign Up" %}
+            {% if group %}
+            {% trans "as" %} {{ group }}
+            {% endif %}
+          </h2>
           {% url 'shop:login' as login_url %}
           <p>{% blocktrans %}Already have an account? Then please <a href="{{ login_url }}">sign in</a>.{% endblocktrans %}</p>
 
-          <form class="signup" id="signup_form" method="post" action="{% url 'account_signup' %}">
+          <form class="signup" id="signup_form" method="post">
             {% csrf_token %}
             {% crispy form %}
             {% if redirect_field_value %}

bakeup/templates/account/signup.html

@@ -9,7 +9,7 @@
 from crispy_forms.layout import Layout, Submit, Row, Column, HTML
 
 from allauth.utils import set_form_field_order
-from allauth.account.forms import SignupForm as _SignupForm
+from allauth.account.forms import SignupForm as _SignupForm, LoginForm as _LoginForm
 
 from bakeup.shop.models import PointOfSale
 
@@ -105,9 +105,22 @@ def save(self, request):
 
 
 class SignupForm(UserFormMixin, _SignupForm):
-    pass
+    email = forms.EmailField(
+        widget=forms.TextInput(
+            attrs={
+                "type": "email",
+                "placeholder": _("E-mail address"),
+                "autocomplete": "email",
+                "autofocus": True
+            }
+        )
+    )
 
 
 class UserProfileForm(UserFormMixin, forms.Form):
     pass
 
+class LoginForm(_LoginForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields['login'].widget.attrs["autofocus"] = True

bakeup/users/forms.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.12 on 2023-09-20 08:23
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+        ('users', '0004_alter_token_ttl'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GroupToken',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('token', models.CharField(max_length=64, unique=True)),
+                ('ttl', models.IntegerField(default=30, help_text='Days till token expires')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('group', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='token', to='auth.group')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

bakeup/users/migrations/0005_grouptoken.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.12 on 2022-10-21 08:53
+import random
+import string
+
+from django.conf import settings
+from django.db import migrations
+
+def generate_token():
+        alphabet = string.ascii_lowercase + string.digits
+        return ''.join(random.choices(alphabet, k=8))
+
+def make_tokens(apps, schema_editor):
+    Group = apps.get_model('auth', 'Group')
+    GroupToken = apps.get_model('users', 'GroupToken')
+    tokens = [GroupToken(group=group, token=generate_token(), ttl=30) for group in Group.objects.filter(token__isnull=True)]
+    GroupToken.objects.bulk_create(tokens)
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0005_grouptoken'),
+    ]
+
+    operations = [
+        migrations.RunPython(make_tokens),
+    ]

bakeup/users/migrations/0006_generate_group_tokens.py

@@ -42,23 +42,17 @@ def short_name(self):
             return self.first_name
 
 
-
-class Token(models.Model):
+class AbstractToken(models.Model):
     """Authentication token for user model"""
 
     # Secret string
     token = models.CharField(max_length=64, unique=True)
     # Time to live - number of days until token expiration
     ttl = models.IntegerField(default=30, help_text="Days till token expires")
-    user = models.OneToOneField(
-        User,
-        related_name='token',
-        on_delete=models.CASCADE
-    )
     created_at = models.DateTimeField(auto_now_add=True)
 
-    def __str__(self):
-        return "Token: {}".format(self.user)
+    class Meta:
+        abstract = True
 
     @classmethod
     def generate_token(cls):
@@ -89,4 +83,35 @@ def generate_qr_code(self, request):
         stream = BytesIO()
         img.save(stream)
         html = "<div style='background-color: white;display: inline-block;'>{}</div>".format(stream.getvalue().decode())
-        return html
+        return html
+
+
+
+class Token(AbstractToken):
+    """Authentication token for user model"""
+    user = models.OneToOneField(
+        User,
+        related_name='token',
+        on_delete=models.CASCADE
+    )
+
+    def __str__(self):
+        return "Token: {}".format(self.user)
+    
+    def get_full_url(self, request):
+        return request.tenant.reverse(request, 'users:login-token', token=self.token)
+
+
+class GroupToken(AbstractToken):
+    """Authentication token for user model"""
+    group = models.OneToOneField(
+        'auth.Group',
+        related_name='token',
+        on_delete=models.CASCADE
+    )
+
+    def __str__(self):
+        return "Token: {}".format(self.group)
+    
+    def get_full_url(self, request):
+        return request.tenant.reverse(request, 'shop:signup', token=self.token)

bakeup/users/models.py

@@ -1,11 +1,12 @@
 from django.db.models.signals import post_save
 from django.dispatch import receiver
+from django.contrib.auth.models import Group
 
 from allauth.account.models import EmailAddress
 from allauth.account.signals import email_confirmed
 
 from bakeup.shop.models import Customer, PointOfSale
-from bakeup.users.models import User, Token
+from bakeup.users.models import User, Token, GroupToken
 
 
 @receiver(post_save, sender=User)
@@ -17,6 +18,15 @@ def create_user_token(sender, instance, created, **kwargs):
         )
 
 
+@receiver(post_save, sender=Group)
+def create_group_token(sender, instance, created, **kwargs):
+    if not hasattr(instance, 'token'):
+        GroupToken.objects.create(
+            group=instance,
+            token=GroupToken.generate_token(),
+        )
+
+
 @receiver(post_save, sender=User)
 def create_user_customer(sender, instance, created, **kwargs):
     if not hasattr(instance, 'customer'):

bakeup/users/signals.py

@@ -1,7 +1,10 @@
+from typing import Any
+from django import http
 from django.core.mail import send_mail
 from django.contrib.auth import logout
 from django.contrib import messages
 from django.contrib.auth import get_user_model, login
+from django.contrib.auth.models import Group
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.contrib.messages.views import SuccessMessageMixin
 from django.urls import reverse, resolve
@@ -69,12 +72,33 @@ def form_valid(self, form):
 
 
 class SignupView(_SignupView):
+    group = None
+
+    def setup(self, request, *args, **kwargs):
+        token = kwargs.get('token', None)
+        if token and Group.objects.filter(token__token=token).exists():
+            self.group = Group.objects.get(token__token=token)
+        return super().setup(request, *args, **kwargs)
+
     def get_form_kwargs(self):
         kwargs = super().get_form_kwargs()
         kwargs.update({
-            'request': self.request
+            'request': self.request,
         })
         return kwargs
+    
+    def get_context_data(self, **kwargs):
+        context_data = super().get_context_data(**kwargs)
+        context_data['group'] = self.group
+        return context_data
+    
+    def form_valid(self, form):
+        response =  super().form_valid(form)
+        if self.group and self.user:
+            # add user to group if group available
+            self.user.groups.add(self.group)
+        return response
+    
 
 
 

bakeup/users/views.py

@@ -107,12 +107,13 @@ class Meta:
 
 
 class GroupTable(tables.Table):
+    token = tables.TemplateColumn('{% load workshop_tags %}{% token_url record.token %}', verbose_name=_('Signup url'))
     user_count = tables.Column(empty_values=(), verbose_name=_('Users'))
     actions = tables.TemplateColumn(template_name='tables/group_actions_column.html', verbose_name='')
 
     class Meta:
         model = Group
-        fields = ("name",)
+        fields = ("name", "token")
 
     def render_user_count(self, value, record):
         return record.user_set.count()

bakeup/workshop/tables.py

@@ -28,4 +28,10 @@ def ordered_quantity(order, product):
     position = order.positions.filter(
         Q(product=product) | Q(product__product_template=product),
     ).first()
-    return position and position.quantity or 0
+    return position and position.quantity or 0
+
+
+@register.simple_tag(takes_context=True)
+def token_url(context, token):
+    if token:
+        return token.token_url(context.get('request'))

bakeup/workshop/templatetags/workshop_tags.py

@@ -326,7 +326,10 @@
 ACCOUNT_UNIQUE_EMAIL = True
 
 ACCOUNT_ADAPTER = 'bakeup.users.allauth.AccountAdapter'
-ACCOUNT_FORMS = {'signup': 'bakeup.users.forms.SignupForm'}
+ACCOUNT_FORMS = {
+    'signup': 'bakeup.users.forms.SignupForm',
+    'login': 'bakeup.users.forms.LoginForm',
+}
 ACCOUNT_AUTHENTICATION_METHOD = "username_email"
 # ACCOUNT_EMAIL_VERIFICATION = "mandatory"
 ACCOUNT_LOGIN_ON_EMAIL_CONFIRMATION = True