From 64899b00071ae58add7ae31e45b0d9e2dce7770e Mon Sep 17 00:00:00 2001 From: Radek Czajka Date: Wed, 2 Sep 2026 15:38:22 +0200 Subject: [PATCH 1/1] Onboarding --- Dockerfile | 1 + src/accounts/admin.py | 80 ++++++++++++++ src/accounts/forms.py | 18 ++++ src/accounts/locale/pl/LC_MESSAGES/django.mo | Bin 3448 -> 5643 bytes src/accounts/locale/pl/LC_MESSAGES/django.po | 101 ++++++++++++++++++ .../migrations/0004_onboarding_email.py | 27 +++++ src/accounts/models.py | 14 +++ src/accounts/templates/account/base.html | 4 +- .../templates/account/onboarding.html | 74 +++++++++++++ .../admin/accounts/user/change_form.html | 11 ++ .../accounts/user/send_onboarding_email.html | 25 +++++ src/accounts/urls.py | 1 + src/accounts/views.py | 62 ++++++++++- 13 files changed, 414 insertions(+), 4 deletions(-) create mode 100644 src/accounts/admin.py create mode 100644 src/accounts/migrations/0004_onboarding_email.py create mode 100644 src/accounts/templates/account/onboarding.html create mode 100644 src/accounts/templates/admin/accounts/user/change_form.html create mode 100644 src/accounts/templates/admin/accounts/user/send_onboarding_email.html diff --git a/Dockerfile b/Dockerfile index 06bcb83..39b00f1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,6 +10,7 @@ WORKDIR /app/src FROM base AS dev +RUN apk add --no-cache gettext RUN pip install --no-cache-dir coverage diff --git a/src/accounts/admin.py b/src/accounts/admin.py new file mode 100644 index 0000000..83d3c66 --- /dev/null +++ b/src/accounts/admin.py @@ -0,0 +1,80 @@ +from django.contrib import admin, messages +from django.contrib.auth.admin import UserAdmin as BaseUserAdmin +from django.contrib.auth.models import User +from django.core.mail import send_mail +from django.http import HttpResponseRedirect +from django.template.response import TemplateResponse +from django.urls import path, reverse +from django.utils.translation import gettext_lazy as _ +from .models import OnboardingEmail + + +@admin.register(OnboardingEmail) +class OnboardingEmailAdmin(admin.ModelAdmin): + list_display = ('subject',) + + +admin.site.unregister(User) + + +@admin.register(User) +class UserAdmin(BaseUserAdmin): + change_form_template = 'admin/accounts/user/change_form.html' + + def get_urls(self): + urls = super().get_urls() + custom_urls = [ + path( + '/send-onboarding-email/', + self.admin_site.admin_view(self.send_onboarding_email_view), + name='accounts_user_send_onboarding_email', + ), + ] + return custom_urls + urls + + def send_onboarding_email_view(self, request, id): + user = self.get_object(request, id) + if user is None: + return self._get_obj_does_not_exist_redirect(request, User._meta, id) + + if request.method == 'POST': + template = OnboardingEmail.objects.first() + if not template: + messages.error(request, _("No onboarding email template configured.")) + else: + # Generate new password + password = User.objects.make_random_password(length=12) + user.set_password(password) + user.save() + + body = template.body.format( + username=user.username, + password=password, + first_name=user.first_name, + last_name=user.last_name, + ) + send_mail( + template.subject, + body, + None, + [user.email], + ) + messages.success( + request, + _("Onboarding email sent to %(email)s. Password has been reset.") % {'email': user.email} + ) + return HttpResponseRedirect( + reverse('admin:auth_user_change', args=[user.pk]) + ) + + context = { + **self.admin_site.each_context(request), + 'opts': self.model._meta, + 'user_obj': user, + 'title': _("Send onboarding email"), + } + return TemplateResponse( + request, + 'admin/accounts/user/send_onboarding_email.html', + context, + ) diff --git a/src/accounts/forms.py b/src/accounts/forms.py index 0c8cb66..5a1b62e 100644 --- a/src/accounts/forms.py +++ b/src/accounts/forms.py @@ -1,5 +1,6 @@ from django import forms from django.contrib.auth.models import User +from django.utils.translation import gettext_lazy as _ class UserBasicForm(forms.ModelForm): @@ -8,3 +9,20 @@ class UserBasicForm(forms.ModelForm): model = User fields = ('first_name', 'last_name', 'email',) + +class OnboardingForm(forms.Form): + first_name = forms.CharField(label=_("First name"), max_length=150) + last_name = forms.CharField(label=_("Last name"), max_length=150) + email = forms.EmailField(label=_("External email")) + username = forms.CharField( + label=_("Username"), + max_length=150, + help_text=_("Auto-generated from first and last name") + ) + + def clean_username(self): + username = self.cleaned_data['username'] + if User.objects.filter(username=username).exists(): + raise forms.ValidationError(_("User with this username already exists.")) + return username + diff --git a/src/accounts/locale/pl/LC_MESSAGES/django.mo b/src/accounts/locale/pl/LC_MESSAGES/django.mo index f75b1fdee377ebb23cf847cc9cf5d27cf3d30413..a7ed699adf4f498fc5e2ca8c6cbe6b69f4038e86 100644 GIT binary patch literal 5643 zcmb`KUyLMG6~?a$ii0SEC@SC;SY}qHduLWiHZ8C$v%Bm7%T9J@UBwu^U3I6YrmO2V zRn=2lO*Fc}EPtLPF>$le#22G4YJ^0iBpR4bj1Rt;_+l{eLBoTD2ctY0{heFYJw3y& zO0?3|Uw755d(Zj4bIv{WhwHBRhT^!J^Cr%%w<+}?7{7xrj;F3r>MHPQ@V(%3;A!wX zpa$OnXTck)>_Z_dt36=it@guR$62yZZVo;0*u&0>fK87Hpu|S3sHn2iGXY zN4>z;=fIc1Tfkc&zX9G09tOLh@c1K8bovP>I{gNe=l=+P0DK*kaaZ7!@NzXM>)Z@l z@HUW-dYZ2iya0;7*I!%NcTER1>OUu;0P3*4-gC*JPXRW3!vEZT~OBjC3rLVD^PgB_^2j`uf3!F%* z_HfD}wu%0t+4KSJo*%;6`?((!p7(N!UT^0_Y9Aw?1Q$7*oY4HH;}cww+9L5IxhQcc zF(rp+=J`Jq1a6SznK~5qq9n@l)Z~#%)S=Ys(hYPrsDBhD$#w2@W|L5xM7yNzOd3W> zN86r>V!1cSY^rbFGbfmsp52?>s^|91`TKjby$98yLB4L2JPQ0GOcQFkV9kjyYAx9rddlrF<$yh^ZJRt$+E(w zq5Srfd_kU-e=Y`b>wU={>K$D>ZrHhn|;)!9hc`e5pL7ToCo!hgh#526`LjuQ=4VFZDUu= zd+!T78`pE{C_$+~AW~&|&85ha=c0wti7gPvHq|i)QOj#y#?U3RxlV0hqfNX_D%0j+ z&zj8Yp6S|&)U%90B%2}ta_O-t5)P^D5F`Fp5#{TZVZpi$x|Q)+-yoP*qp2R5$n}Wp zV6p<-AXksNOGJrPf=o8zBysq0r_{ zHMtRZmDNh+b>LDMVHTXUX$p&;ZN^{bel5pjfM=<4Tv#86h|Y^BfKR6j{DJIEn?`G; z7a}kF&>H2?fvbM~xV+Saa5$N8zLq!`q)}eZW;#Q!ihIeYO0EB=9UUj>EWDs40Vt8x zHX`1@GE=9dn(QtmTunD&FjK2o zFkYb&Q^!%#)dd1a$)<^;kQjDZ7PaFN^#Viw3%e2lCMGpQxeP^I51U%o%BJ@5ft8}- zvt{QBO;(LET|^|?xDxFiC^Yy&$Wk>?Qg~2iNA@<=X{m_Q1#yZVUpSzyBP~61()OXYaXjlpVdH^8Cu^)aF0Y(uoV1&f3~C&v zM7Q+*h5d_-g#(TKi+XXfb@#%Z3;P!qW~AIVR#TH?6mplg^hp!iu3j3Njjqx6q$YIS zDVl-5a6i~8l$JvyOM5#V4O!_g_e@>}Lm4*I zQ7^JQ!vl#K77?_n!!FCWF7y*_%gqFm-g=jGC>g|q4fPl^jGh#~cXUbhQ5O;tg69c6x1n`^CQ4F12IAvL{+p1*#ih+aSwLA&gS@U12+}sZQmo!=29P z+{@1wiBS*P(Zv|{Se$Up4SJ3)?rU(hp5DysfruWlHnwT3z?yJ+VBsGMB2?dLSfsOl zYKn05v${vpL)rwKw7sT!v=R*J48;So&y*EDkeaT}x^-V9x?{P{hP1yf8TeQ;JA%zS zc4E7CI{xNptRfZ0@qMa;I_AaG!^(4~htO(szhqM+H4LwWP%BPcsfEZ$hW6;(*4NnW zcipi5#)XiAeTHZ#jCfC5J_!{a7K3i;awwnIVO*!w=wc9gZhc&*t{qJ&5mTE}^y)@$ zo)pd46sjon)3xoeA6Y8R=*cWEkPq>xRFV>iTuf||h?qS0Kbf?W4(*1xNzUgIqY`7p z0%2K{?NowtYO!(WG-ka@Q;IE&ogCATr8Vyl#{+!PbWj9{#OlT+s*Q9|WPhn1k#0#! z&vxWj^XPUtIwxT+Dn=nGTa>gCr4%nGF^v+r#F_lA<3Vpw!EmAL$So$sLVa8Y`-Fr@ z65_mey6a-Qfx|v{YP-p_J_SD8q;h z$y=1P`$^)<9{YtWvYs9dFh?Rqp!_W2{Y6~si#ER)_Gd{ zOFr*6MluecRtworFqoHnKU%8AurNF1YpFbim#y=vuELit!sEN8za8zU(Pgl%=+#ZG F{snz(?rH!4 delta 758 zcmXxi%S#(k6u{v#t%9s->H31rgV-T!>oeqQ5gvF5G-~PG;_$bMEZ*JhT-r;}r+O=m_RN z>|$P6{4kcDh*aS+MsXdRaR=l0BZzw#=K2gX_!~drz|+V0Vc-eIh@avMk)o7XBnaH# zBsNrtY~cqS#A|HDt`Ps>Fls_mfzz1hI)!_9j*GZJHbYp#HjGw^M6erQ;sEwqMUhz+ zJR@J&wGItxg+Ea%JPzW2P%Avg1-!yFoTwII3pow^g}P4(pW`KJ0r&V88)`)M@gw%} ze)-EnZ|JUleBl@pl6R;ZCvg{T+{Rm6!2;zB;|(UTpSNm-Q>gpRpq`>8Lv#HuXq>$L z`#_3%?oGO4kf47y?f#WWBXW#>5-q6h*AA3NeR+Y}K^@w;XH4xJC+B}N{a;q{@H=nf~do{O`%-ODEzJ>eSBQk24qv)&hBb~9d`4(G`O(!#MI=?9I*L*#%e%~^4apS#i+_e4!fB|2Q diff --git a/src/accounts/locale/pl/LC_MESSAGES/django.po b/src/accounts/locale/pl/LC_MESSAGES/django.po index a5fdb8e..828ce47 100644 --- a/src/accounts/locale/pl/LC_MESSAGES/django.po +++ b/src/accounts/locale/pl/LC_MESSAGES/django.po @@ -155,3 +155,104 @@ msgstr "Resetowanie hasła" #: accounts/views.py:18 msgid "Profile has been changed." msgstr "Profil został zmieniony." + +#: accounts/models.py +msgid "subject" +msgstr "temat" + +#: accounts/models.py +msgid "body" +msgstr "treść" + +#: accounts/models.py +msgid "Available placeholders: {username}, {password}, {first_name}, {last_name}" +msgstr "Dostępne zmienne: {username}, {password}, {first_name}, {last_name}" + +#: accounts/models.py +msgid "onboarding email template" +msgstr "szablon maila onboardingowego" + +#: accounts/models.py +msgid "onboarding email templates" +msgstr "szablony maili onboardingowych" + +#: accounts/forms.py +msgid "First name" +msgstr "Imię" + +#: accounts/forms.py +msgid "Last name" +msgstr "Nazwisko" + +#: accounts/forms.py +msgid "External email" +msgstr "Zewnętrzny email" + +#: accounts/forms.py +msgid "Username" +msgstr "Login" + +#: accounts/forms.py +msgid "Auto-generated from first and last name" +msgstr "Generowany automatycznie z imienia i nazwiska" + +#: accounts/forms.py +msgid "User with this username already exists." +msgstr "Użytkownik o tym loginie już istnieje." + +#: accounts/views.py +msgid "User %(username)s has been created and email sent to %(email)s." +msgstr "Użytkownik %(username)s został utworzony i wysłano email na %(email)s." + +#: accounts/views.py +msgid "User %(username)s has been created, but no email template is configured." +msgstr "Użytkownik %(username)s został utworzony, ale brak skonfigurowanego szablonu maila." + +#: accounts/templates/account/onboarding.html +msgid "User onboarding" +msgstr "Onboarding użytkownika" + +#: accounts/templates/account/onboarding.html +msgid "Create user" +msgstr "Utwórz użytkownika" + +#: accounts/templates/account/base.html +msgid "Onboarding" +msgstr "Onboarding" + +#: accounts/admin.py +msgid "No onboarding email template configured." +msgstr "Brak skonfigurowanego szablonu maila onboardingowego." + +#: accounts/admin.py +msgid "Onboarding email sent to %(email)s. Password has been reset." +msgstr "Mail onboardingowy wysłany na %(email)s. Hasło zostało zresetowane." + +#: accounts/admin.py +msgid "Send onboarding email" +msgstr "Wyślij mail onboardingowy" + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +msgid "Home" +msgstr "Strona główna" + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +msgid "Authentication and Authorization" +msgstr "Uwierzytelnianie i autoryzacja" + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +msgid "Users" +msgstr "Użytkownicy" + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +#, python-format +msgid "Are you sure you want to send an onboarding email to user \"%(username)s\" (%(email)s)?" +msgstr "Czy na pewno chcesz wysłać mail onboardingowy do użytkownika \"%(username)s\" (%(email)s)?" + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +msgid "This will generate a new password and send it to the user's email address." +msgstr "Spowoduje to wygenerowanie nowego hasła i wysłanie go na adres email użytkownika." + +#: accounts/templates/admin/accounts/user/send_onboarding_email.html +msgid "Cancel" +msgstr "Anuluj" diff --git a/src/accounts/migrations/0004_onboarding_email.py b/src/accounts/migrations/0004_onboarding_email.py new file mode 100644 index 0000000..3cfb039 --- /dev/null +++ b/src/accounts/migrations/0004_onboarding_email.py @@ -0,0 +1,27 @@ +# Generated by Django 4.2.16 on 2026-09-02 13:16 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ('accounts', '0003_auto_20190330_1311'), + ] + + operations = [ + migrations.CreateModel( + name='OnboardingEmail', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('subject', models.CharField(max_length=255, verbose_name='subject')), + ('body', models.TextField(help_text='Available placeholders: {username}, {password}, {first_name}, {last_name}', verbose_name='body')), + ], + options={ + 'verbose_name': 'onboarding email template', + 'verbose_name_plural': 'onboarding email templates', + }, + ), + ] diff --git a/src/accounts/models.py b/src/accounts/models.py index b0be8d4..0197eba 100644 --- a/src/accounts/models.py +++ b/src/accounts/models.py @@ -1,6 +1,20 @@ +from django.db import models +from django.utils.translation import gettext_lazy as _ from cas_provider.signals import cas_collect_custom_attributes +class OnboardingEmail(models.Model): + subject = models.CharField(_("subject"), max_length=255) + body = models.TextField( + _("body"), + help_text=_("Available placeholders: {username}, {password}, {first_name}, {last_name}") + ) + + class Meta: + verbose_name = _("onboarding email template") + verbose_name_plural = _("onboarding email templates") + + def user_attributes(sender, user, **kwargs): return { 'firstname': user.first_name, diff --git a/src/accounts/templates/account/base.html b/src/accounts/templates/account/base.html index 8e9245e..a8b7ad5 100644 --- a/src/accounts/templates/account/base.html +++ b/src/accounts/templates/account/base.html @@ -20,8 +20,10 @@ {% if use_ssh %}

{% trans "SSH keys" %}

{% endif %} + {% if perms.auth.add_user %} +

{% trans "Onboarding" %}

+ {% endif %} {% endblock %} - {% if request.user.is_staff %}

{% trans "Administration" %}

{% endif %} diff --git a/src/accounts/templates/account/onboarding.html b/src/accounts/templates/account/onboarding.html new file mode 100644 index 0000000..7370785 --- /dev/null +++ b/src/accounts/templates/account/onboarding.html @@ -0,0 +1,74 @@ +{% extends "account/base.html" %} +{% load i18n %} + + +{% block title %}{% trans "User onboarding" %}{% endblock %} + + +{% block menu %} + {% with menu="onboarding" %} + {{ block.super }} + {% endwith %} +{% endblock %} + + +{% block accounts-content %} +

{% trans "User onboarding" %}

+
+ {% csrf_token %} + {% if form.non_field_errors %} +
+ {{ form.non_field_errors }} +
+ {% endif %} +

+ + {{ form.first_name }} + {% if form.first_name.errors %}{{ form.first_name.errors }}{% endif %} +

+

+ + {{ form.last_name }} + {% if form.last_name.errors %}{{ form.last_name.errors }}{% endif %} +

+

+ + {{ form.email }} + {% if form.email.errors %}{{ form.email.errors }}{% endif %} +

+

+ + {{ form.username }} + {{ form.username.help_text }} + {% if form.username.errors %}{{ form.username.errors }}{% endif %} +

+

+
+ + +{% endblock %} diff --git a/src/accounts/templates/admin/accounts/user/change_form.html b/src/accounts/templates/admin/accounts/user/change_form.html new file mode 100644 index 0000000..ffeffee --- /dev/null +++ b/src/accounts/templates/admin/accounts/user/change_form.html @@ -0,0 +1,11 @@ +{% extends "admin/change_form.html" %} +{% load i18n admin_urls %} + +{% block object-tools-items %} +{{ block.super }} +{% if original %} +
  • + {% trans "Send onboarding email" %} +
  • +{% endif %} +{% endblock %} diff --git a/src/accounts/templates/admin/accounts/user/send_onboarding_email.html b/src/accounts/templates/admin/accounts/user/send_onboarding_email.html new file mode 100644 index 0000000..b903901 --- /dev/null +++ b/src/accounts/templates/admin/accounts/user/send_onboarding_email.html @@ -0,0 +1,25 @@ +{% extends "admin/base_site.html" %} +{% load i18n admin_urls %} + +{% block breadcrumbs %} + +{% endblock %} + +{% block content %} +

    {% blocktrans with username=user_obj.username email=user_obj.email %}Are you sure you want to send an onboarding email to user "{{ username }}" ({{ email }})?{% endblocktrans %}

    +

    {% trans "This will generate a new password and send it to the user's email address." %}

    + +
    +{% csrf_token %} + +
    +{% endblock %} diff --git a/src/accounts/urls.py b/src/accounts/urls.py index 51f344e..dbea95e 100644 --- a/src/accounts/urls.py +++ b/src/accounts/urls.py @@ -4,4 +4,5 @@ from . import views urlpatterns = [ path('', views.ProfileView.as_view(), name='accounts_profile'), + path('onboarding/', views.OnboardingView.as_view(), name='onboarding'), ] diff --git a/src/accounts/views.py b/src/accounts/views.py index 1b4a705..a8ebfca 100644 --- a/src/accounts/views.py +++ b/src/accounts/views.py @@ -1,8 +1,12 @@ -from django.contrib.auth.mixins import LoginRequiredMixin +from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin +from django.contrib.auth.models import User from django.contrib import messages +from django.core.mail import send_mail +from django.urls import reverse_lazy from django.utils.translation import gettext as _ -from django.views.generic.edit import UpdateView -from accounts.forms import UserBasicForm +from django.views.generic.edit import UpdateView, FormView +from accounts.forms import UserBasicForm, OnboardingForm +from accounts.models import OnboardingEmail class ProfileView(LoginRequiredMixin, UpdateView): @@ -17,3 +21,55 @@ class ProfileView(LoginRequiredMixin, UpdateView): retval = super().form_valid(form) messages.add_message(self.request, messages.INFO, _("Profile has been changed.")) return retval + + +class OnboardingView(PermissionRequiredMixin, FormView): + permission_required = 'auth.add_user' + form_class = OnboardingForm + template_name = "account/onboarding.html" + success_url = reverse_lazy('onboarding') + + def form_valid(self, form): + # Generate random password + password = User.objects.make_random_password(length=12) + + # Create user + user = User.objects.create_user( + username=form.cleaned_data['username'], + email=form.cleaned_data['email'], + password=password, + first_name=form.cleaned_data['first_name'], + last_name=form.cleaned_data['last_name'], + ) + + # Send onboarding email + template = OnboardingEmail.objects.first() + if template: + body = template.body.format( + username=user.username, + password=password, + first_name=user.first_name, + last_name=user.last_name, + ) + send_mail( + template.subject, + body, + None, # Use DEFAULT_FROM_EMAIL + [form.cleaned_data['email']], + ) + messages.success( + self.request, + _("User %(username)s has been created and email sent to %(email)s.") % { + 'username': user.username, + 'email': form.cleaned_data['email'], + } + ) + else: + messages.warning( + self.request, + _("User %(username)s has been created, but no email template is configured.") % { + 'username': user.username, + } + ) + + return super().form_valid(form) -- 2.20.1