#169 Admin on teams

* adds admin column on team index view
* refactors Team model, so multiple members can become admins
* adds team migration for switch from fkey->m2m structure
* renames 'Group' to 'Permission' on user index view to avoid confusion between 'Groups' and Teams
* adds new autocomplete route for team-admin selection based on already selected members of the TeamForm
This commit is contained in:
2022-05-30 14:35:31 +02:00
parent eb3b9eb5c1
commit 8aa3fbd97a
16 changed files with 258 additions and 138 deletions

View File

@@ -68,22 +68,16 @@ class TeamAdmin(admin.ModelAdmin):
list_display = [
"name",
"description",
"admin",
]
search_fields = [
"name",
"description",
]
filter_horizontal = [
"users"
"users",
"admins",
]
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "admin":
team_id = request.resolver_match.kwargs.get("object_id", None)
kwargs["queryset"] = User.objects.filter(teams__id__in=[team_id])
return super().formfield_for_foreignkey(db_field, request, **kwargs)
admin.site.register(User, UserAdmin)
admin.site.register(Team, TeamAdmin)

View File

@@ -230,7 +230,7 @@ class NewTeamModalForm(BaseModalForm):
team = Team.objects.create(
name=self.cleaned_data.get("name", None),
description=self.cleaned_data.get("description", None),
admin=self.user,
admins__in=[self.user],
)
members = self.cleaned_data.get("members", User.objects.none())
if self.user.id not in members:
@@ -244,23 +244,40 @@ class NewTeamModalForm(BaseModalForm):
class EditTeamModalForm(NewTeamModalForm):
admin = forms.ModelChoiceField(
admins = forms.ModelMultipleChoiceField(
label=_("Admins"),
label_suffix="",
label=_("Admin"),
help_text=_("Administrators manage team details and members"),
queryset=User.objects.none(),
empty_label=None,
required=True,
queryset=User.objects.all(),
widget=autocomplete.ModelSelect2Multiple(
url="team-admin-autocomplete",
forward=[
"members",
"admins",
],
attrs={
"data-placeholder": _("Click for selection"),
},
),
)
def __is_admin_valid(self):
admin = self.cleaned_data.get("admin", None)
members = self.cleaned_data.get("members", None)
_is_valid = admin in members
def __is_admins_valid(self):
admins = set(self.cleaned_data.get("admins", {}))
members = set(self.cleaned_data.get("members", {}))
_is_valid = admins.issubset(members)
if not _is_valid:
self.add_error(
"members",
_("Selected admin ({}) needs to be a member of this team.").format(admin.username)
"admins",
_("Selected admins need to be members of this team.")
)
_is_admin_length_valid = len(admins) > 0
if not _is_admin_length_valid:
self.add_error(
"admins",
_("There must be at least one admin on this team.")
)
return _is_valid
@@ -283,7 +300,7 @@ class EditTeamModalForm(NewTeamModalForm):
def is_valid(self):
super_valid = super().is_valid()
admin_valid = self.__is_admin_valid()
admin_valid = self.__is_admins_valid()
return super_valid and admin_valid
def __init__(self, *args, **kwargs):
@@ -293,13 +310,13 @@ class EditTeamModalForm(NewTeamModalForm):
self.cancel_redirect = reverse("user:team-index")
members = self.instance.users.all()
self.fields["admin"].queryset = members
#self.fields["admins"].queryset = members
form_data = {
"members": members,
"name": self.instance.name,
"description": self.instance.description,
"admin": self.instance.admin,
"admins": self.instance.admins.all(),
}
self.load_initial_data(form_data)
@@ -307,14 +324,16 @@ class EditTeamModalForm(NewTeamModalForm):
with transaction.atomic():
self.instance.name = self.cleaned_data.get("name", None)
self.instance.description = self.cleaned_data.get("description", None)
self.instance.admin = self.cleaned_data.get("admin", None)
self.instance.save()
self.instance.users.set(self.cleaned_data.get("members", []))
self.instance.admins.set(self.cleaned_data.get("admins", []))
return self.instance
class RemoveTeamModalForm(RemoveModalForm):
pass
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.form_caption = _("ATTENTION!\n\nRemoving the team means all members will lose their access to data, based on this team! \n\nAre you sure to remove this team?")
class LeaveTeamModalForm(RemoveModalForm):

View File

@@ -0,0 +1,35 @@
# Generated by Django 3.1.3 on 2022-05-30 09:05
from django.conf import settings
from django.db import migrations, models
def migrate_fkey_admin_to_m2m(apps, schema_editor):
Team = apps.get_model('user', 'Team')
all_teams = Team.objects.all()
for team in all_teams:
admin = team.admin
if admin is None:
continue
team.admins.add(admin)
team.save()
class Migration(migrations.Migration):
dependencies = [
('user', '0003_team'),
]
operations = [
migrations.AddField(
model_name='team',
name='admins',
field=models.ManyToManyField(blank=True, related_name='_team_admins_+', to=settings.AUTH_USER_MODEL),
),
migrations.RunPython(migrate_fkey_admin_to_m2m),
migrations.RemoveField(
model_name='team',
name='admin',
),
]

View File

@@ -11,7 +11,7 @@ class Team(UuidModel):
name = models.CharField(max_length=500, null=True, blank=True)
description = models.TextField(null=True, blank=True)
users = models.ManyToManyField("user.User", blank=True, related_name="teams")
admin = models.ForeignKey("user.User", blank=True, null=True, related_name="+", on_delete=models.SET_NULL)
admins = models.ManyToManyField("user.User", blank=True, related_name="+")
def __str__(self):
return self.name
@@ -104,6 +104,19 @@ class Team(UuidModel):
"""
self.users.remove(user)
if self.admin == user:
self.admin = self.users.first()
self.save()
self.admins.remove(user)
self.save()
def is_user_admin(self, user) -> bool:
""" Returns whether a given user is an admin of the team
Args:
user (User): The user
Returns:
user_is_admin (bool): Whether the user is an admin or not
"""
user_is_admin = self.admins.filter(
id=user.id
).exists()
return user_is_admin

View File

@@ -18,7 +18,7 @@
<td>{{user.email}}</td>
</tr>
<tr>
<th scope="row">{% trans 'Groups' %}</th>
<th scope="row">{% trans 'Permissions' %}</th>
<td>
{% for group in user.groups.all %}
<span class="badge badge-pill rlp-r">{% trans group.name %}</span>

View File

@@ -28,6 +28,7 @@
<th scope="col" class="align-middle">{% trans 'Name' %}</th>
<th scope="col" class="align-middle w-20">{% trans 'Description' %}</th>
<th scope="col" class="align-middle">{% trans 'Members' %}</th>
<th scope="col" class="align-middle">{% trans 'Administrator' %}</th>
<th scope="col" class="align-middle">{% trans 'Action' %}</th>
</tr>
</thead>
@@ -45,11 +46,16 @@
<span class="badge badge-pill rlp-r">{{member.username}}</span>
{% endfor %}
</td>
<td>
{% for admin in team.admins.all %}
<span class="badge badge-pill rlp-r">{{admin.username}}</span>
{% endfor %}
</td>
<td>
<button class="btn rlp-r btn-modal" data-form-url="{% url 'user:team-leave' team.id %}" title="{% trans 'Leave team' %}">
{% fa5_icon 'sign-out-alt' %}
</button>
{% if team.admin == user %}
{% if user in team.admins.all %}
<button class="btn rlp-r btn-modal" data-form-url="{% url 'user:team-edit' team.id %}" title="{% trans 'Edit team' %}">
{% fa5_icon 'edit' %}
</button>

View File

@@ -183,7 +183,8 @@ def new_team_view(request: HttpRequest):
@login_required
def edit_team_view(request: HttpRequest, id: str):
team = get_object_or_404(Team, id=id)
if request.user != team.admin:
user_is_admin = team.is_user_admin(request.user)
if not user_is_admin:
raise Http404()
form = EditTeamModalForm(request.POST or None, instance=team, request=request)
return form.process_request(
@@ -196,7 +197,8 @@ def edit_team_view(request: HttpRequest, id: str):
@login_required
def remove_team_view(request: HttpRequest, id: str):
team = get_object_or_404(Team, id=id)
if request.user != team.admin:
user_is_admin = team.is_user_admin(request.user)
if not user_is_admin:
raise Http404()
form = RemoveTeamModalForm(request.POST or None, instance=team, request=request)
return form.process_request(