Wagtail 使用一对一模型自定义用户帐户设置表单

Question

我的应用中有一个名为“portal”的模型，位于portal/models.py：

from django.db import models
from django.contrib.auth.models import User
from django.dispatch import receiver
from django.db.models.signals import post_save

from wagtail.snippets.models import register_snippet
from wagtail.admin.edit_handlers import FieldPanel

@register_snippet
class StaffRoles(models.Model):
    role = models.CharField(max_length=154, unique=True, help_text="Create new staff roles here, these roles an be assigned to 'staff' users.")
    panels = [
        FieldPanel('role'),
    ]

    def __str__(self):
        return self.role

    class Meta:
        verbose_name = "Staff Role"
        verbose_name_plural = "Staff Roles"

@register_snippet
class Staff(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    bio = models.TextField(max_length=1024, blank=True)
    roles = models.ManyToManyField(StaffRoles, blank=True)
    
    def __str__(self):
        return str(self.user.first_name) + " " + str(self.user.last_name)

    class Meta:
        verbose_name = "Staff"
        verbose_name_plural = "Staff"


@receiver(post_save, sender=User)
def create_user_profile(sender, instance, created, **kwargs):
    if created and instance.is_superuser:
        Staff.objects.create(user=instance)

任何新的超级用户都会自动获得Staff 模型。任何现有（非超级用户）用户也可以添加为Staff。

我希望员工能够设置bio 和role。角色可以通过 Wagtail 管理员的 Snippets 页面添加。

现在，Staff 已注册为 sn-p，这意味着任何员工都可以编辑其他员工的员工属性。

我想通过向每个用户各自的员工属性添加一个表单来自定义 Wagtail 用户帐户设置。这样，我可以锁定 Staff sn-p，这样每个拥有链接到其User 模型的Staff 对象的用户都只能更改他们自己的Staff 字段/属性。

根据 here 的 Wagtail 文档，我首先创建了文件 portal/forms.py，其内容为：

from django import forms
from django.contrib.auth import get_user_model
from django.contrib.auth.models import User

from wagtail.users.models import UserProfile

from .models import Staff

class CustomStaffSettingsForm(forms.ModelForm):

    class Meta:
        model = Staff
        exclude = []

还有另一个文件portal/wagtail_hooks.py 的内容：

from wagtail.admin.views.account import BaseSettingsPanel
from wagtail.core import hooks

from .forms import CustomStaffSettingsForm

@hooks.register('register_account_settings_panel')
class CustomStaffSettingsPanel(BaseSettingsPanel):
    name = 'custom_staff'
    title = "Staff settings"
    order = 500
    form_class = CustomStaffSettingsForm
    form_object = 'profile'

这不能按预期工作。访问“帐户设置”并向下滚动到“员工设置”时，我可以按预期看到CustomStaffSettingsForm。虽然在User 字段中预先选择了正确的用户，但我仍然可以选择其他用户。此外，不会检索 bio 和 roles 的存储值，也不会保存新值。

下面是在sn-ps页面注册的Staff Roles：

下面是 sn-ps 页面中用户“sid”的Staff 模型：

下面是“帐户设置”中Staff settings 部分的外观。

如您所见，虽然User 下拉菜单选择了正确的用户，但我仍然可以单击并选择另一个用户。 bio 和 roles 字段未填充来自 sn-ps 页面的正确值，并且未在图片中显示，填充和保存值不起作用。

我希望我的问题尽可能详细，我该如何解决这个问题？

Answer 1

经过几个小时的挖掘，我设法回答了自己的问题。

1. 需要将带有profile 值的related_name 添加到Staff.user。这可以防止'User' object has no attribute 'profile' 错误消息

class Staff(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE, related_name='profile')
    ...

1. 我们需要从CustomStaffSettingsForm 中排除user 字段。这是为了防止用户选择其他用户并更改其他用户的Staff 字段。

class CustomStaffSettingsForm(forms.ModelForm):
    class Meta:
        model = Staff
        exclude = ["user"]

1. 棘手的部分（至少对我而言）是呈现表单的正确实例，换句话说，如果名为“sid”的用户正在访问此表单，他们需要能够看到自己的Staff存储的字段，也可以更改存储的值。为了实现这一点，我不得不重写CustomStaffSettingsPanel 继承自Django 的BaseSettingsPanel 的get_form 方法。我更容易将整个wagtail_hooks.py 内容粘贴到下面。

from wagtail.admin.views.account import BaseSettingsPanel
from wagtail.core import hooks

from .forms import CustomStaffSettingsForm

@hooks.register('register_account_settings_panel')
class CustomStaffSettingsPanel(BaseSettingsPanel):
    name = 'custom_staff'
    title = "Staff settings"
    order = 300
    form_class = CustomStaffSettingsForm
    form_object = 'profile'

    def get_form(self):
        """
        Returns an initialised form.
        """
        kwargs = {
            'instance': self.request.user.profile,
            'prefix': self.name
        }

        if self.request.method == 'POST':
            return self.form_class(self.request.POST, **kwargs)
        else:
            return self.form_class(**kwargs)

上面代码的关键部分是'instance': self.request.user.profile。将此参数传递到 self.form_class 会导致正确检索和存储正确用户存储的 Staff 字段和值。

这个解决方案让我可以确保注册为Staff 的超级用户可以编辑他们自己的Staff 字段并可以访问其他人，这是使用片段无法轻松实现的功能。

由于Staff 不再注册为片段，我们无法更改其他用户的Staff 字段。这可以通过在portal/admin.py 中添加以下内容来解决：

admin.site.register(Staff)

只有通过python manage.py createsuperuser 创建或将staff_status 设置为true 的超级用户才能访问http://localhost:8000/django-admin 的Django 管理界面。与 Snippets 不同，这种方式可用于仅允许 Django 超级用户人员访问和修改人员字段。

注册为Staff 的非超级用户呢？非超级用户无法访问 Wagtail 管理员，因此他们无法访问“帐户设置”页面。在大多数情况下，这应该不是问题，因为理想的用例是只有超级用户可以设置为员工。如果您想将非超级用户设置为 Staff，您可能必须创建自己的视图和表单，以便用户可以在 Wagtail 管理员之外更改其 Staff 字段。