refactor User create view to use the generic wagtail CreateView class

- remove subclassing PermissionRequiredMixin
- relates to #8622

CHANGELOG.txt

@@ -32,6 +32,7 @@ Changelog
  * Render `help_text` when set on `FieldPanel`, `MultiFieldPanel`, `FieldRowPanel`, and other panel APIs where it previously worked without official support (Matt Westcott)
  * Consolidate usage of Excel libraries to a single library `openpyxl`, removing usage of `XlsxWriter`, `tablib`, `xlrd` and `xlwt` (Jaap Roes)
  * Adopt `wagtail.admin.views.generic.IndexView` for the Users index listing and search results (Mehrdad Moradizadeh)
+ * Adopt `wagtail.admin.views.generic.CreateView` for the User creation (Mehrdad Moradizadeh)
  * Fix: Prevent `PageQuerySet.not_public` from returning all pages when no page restrictions exist (Mehrdad Moradizadeh)
  * Fix: Ensure that duplicate block ids are unique when duplicating stream blocks in the page editor (Joshua Munn)
  * Fix: Revise colour usage so that privacy & locked indicators can be seen in Windows High Contrast mode (LB (Ben Johnston))

docs/releases/4.1.md

@@ -49,7 +49,7 @@ Snippet models that inherit from `DraftStateMixin` can now be assigned go-live a
  * Use `search` type input in documentation search (LB (Ben) Johnston)
  * Render `help_text` when set on `FieldPanel`, `MultiFieldPanel`, `FieldRowPanel`, and other panel APIs where it previously worked without official support (Matt Westcott)
  * Consolidate usage of Excel libraries to a single library `openpyxl`, removing usage of `XlsxWriter`, `tablib`, `xlrd` and `xlwt` (Jaap Roes)
- * Adopt `wagtail.admin.views.generic.IndexView` for the Users index listing and search results (Mehrdad Moradizadeh)
+ * Adopt generic class based views for the create User view and Users index listing / search results (Mehrdad Moradizadeh)
 
 ### Bug fixes
 

wagtail/users/templates/wagtailusers/users/create.html

@@ -1,7 +1,6 @@
-{% extends "wagtailadmin/base.html" %}
+{% extends "wagtailadmin/generic/base.html" %}
 {% load wagtailimages_tags %}
 {% load i18n %}
-{% block titletag %}{% trans "Add user" %}{% endblock %}
 {% block content %}
 
     {% trans "Add user" as add_user_str %}

wagtail/users/urls/users.py

@@ -5,7 +5,7 @@ from wagtail.users.views import users
 app_name = "wagtailusers_users"
 urlpatterns = [
     path("", users.Index.as_view(), name="index"),
-    path("add/", users.create, name="add"),
+    path("add/", users.Create.as_view(), name="add"),
     path("<str:user_id>/", users.edit, name="edit"),
     path("<str:user_id>/delete/", users.delete, name="delete"),
 ]

wagtail/users/views/users.py

@@ -13,7 +13,7 @@ from django.utils.translation import gettext_lazy
 from wagtail import hooks
 from wagtail.admin import messages
 from wagtail.admin.auth import permission_required
-from wagtail.admin.views.generic import IndexView
+from wagtail.admin.views.generic import CreateView, IndexView
 from wagtail.compat import AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME
 from wagtail.log_actions import log
 from wagtail.permission_policies import ModelPermissionPolicy
@@ -140,44 +140,43 @@ class Index(IndexView):
         return context_data
 
 
-@permission_required(add_user_perm)
-def create(request):
-    for fn in hooks.get_hooks("before_create_user"):
-        result = fn(request)
-        if hasattr(result, "status_code"):
-            return result
-    if request.method == "POST":
-        form = get_user_creation_form()(request.POST, request.FILES)
-        if form.is_valid():
-            with transaction.atomic():
-                user = form.save()
-                log(user, "wagtail.create")
-            messages.success(
-                request,
-                _("User '{0}' created.").format(user),
-                buttons=[
-                    messages.button(
-                        reverse("wagtailusers_users:edit", args=(user.pk,)), _("Edit")
-                    )
-                ],
-            )
-            for fn in hooks.get_hooks("after_create_user"):
-                result = fn(request, user)
-                if hasattr(result, "status_code"):
-                    return result
-            return redirect("wagtailusers_users:index")
-        else:
-            messages.error(request, _("The user could not be created due to errors."))
-    else:
-        form = get_user_creation_form()()
+class Create(CreateView):
+    """
+    Provide the ability to create a user within the admin.
+    """
 
-    return TemplateResponse(
-        request,
-        "wagtailusers/users/create.html",
-        {
-            "form": form,
-        },
-    )
+    permission_policy = ModelPermissionPolicy(User)
+    permission_required = "add"
+    form_class = get_user_creation_form()
+    template_name = "wagtailusers/users/create.html"
+    add_url_name = "wagtailusers_users:add"
+    index_url_name = "wagtailusers_users:index"
+    edit_url_name = "wagtailusers_users:edit"
+    success_message = "User '{0}' created."
+    page_title = gettext_lazy("Add user")
+
+    def run_before_hook(self):
+        return self.run_hook(
+            "before_create_user",
+            self.request,
+        )
+
+    def run_after_hook(self):
+        return self.run_hook(
+            "after_create_user",
+            self.request,
+            self.object,
+        )
+
+    def get_add_url(self):
+        return None
+
+    def get_success_buttons(self):
+        return [
+            messages.button(
+                reverse(self.edit_url_name, args=(self.object.pk,)), _("Edit")
+            )
+        ]
 
 
 @permission_required(change_user_perm)