mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2026-02-11 01:26:22 +01:00
Add option to notify approvers about new group requests
This commit is contained in:
Erik Kalkoken
Ariel Rin
@@ -1,16 +1,26 @@
|
||||
from typing import Set
|
||||
|
||||
from django.conf import settings
|
||||
from django.contrib.auth.models import Group
|
||||
from django.contrib.auth.models import User
|
||||
from django.db import models
|
||||
from django.db.models.signals import post_save
|
||||
from django.dispatch import receiver
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
||||
from allianceauth.authentication.models import State
|
||||
from allianceauth.notifications import notify
|
||||
|
||||
|
||||
class GroupRequest(models.Model):
|
||||
"""Request from a user for joining or leaving a group."""
|
||||
leave_request = models.BooleanField(default=0)
|
||||
user = models.ForeignKey(User, on_delete=models.CASCADE)
|
||||
group = models.ForeignKey(Group, on_delete=models.CASCADE)
|
||||
|
||||
def __str__(self):
|
||||
return self.user.username + ":" + self.group.name
|
||||
|
||||
@property
|
||||
def main_char(self):
|
||||
"""
|
||||
@@ -19,11 +29,22 @@ class GroupRequest(models.Model):
|
||||
"""
|
||||
return self.user.profile.main_character
|
||||
|
||||
def __str__(self):
|
||||
return self.user.username + ":" + self.group.name
|
||||
def notify_leaders(self) -> None:
|
||||
"""Send notification to all group leaders about this request.
|
||||
|
||||
Note: No translations, because language for each leader is unknown
|
||||
"""
|
||||
if not getattr(settings, 'GROUPMANAGEMENT_REQUESTS_NOTIFICATION', False):
|
||||
return
|
||||
keyword = "leave" if self.leave_request else "join"
|
||||
title = f"Group Management: {keyword.title()} request for {self.group.name}"
|
||||
message = f"{self.user} want's to {keyword} {self.group.name}."
|
||||
for appover in self.group.authgroup.group_request_approvers():
|
||||
notify(user=appover, title=title, message=message, level="info")
|
||||
|
||||
|
||||
class RequestLog(models.Model):
|
||||
"""Log entry about who joined and left a group and who approved it."""
|
||||
request_type = models.BooleanField(null=True)
|
||||
group = models.ForeignKey(Group, on_delete=models.CASCADE)
|
||||
request_info = models.CharField(max_length=254)
|
||||
@@ -61,11 +82,12 @@ class AuthGroup(models.Model):
|
||||
e.g. group.authgroup.internal
|
||||
|
||||
Logic:
|
||||
Internal - not requestable by users, at all. Covers Corp_, Alliance_, Members etc groups.
|
||||
Groups are internal by default
|
||||
Internal - not requestable by users, at all. Covers Corp_, Alliance_,
|
||||
Members etc groups. Groups are internal by default
|
||||
|
||||
Public - Other options are respected, but any user will be able to become and remain a member, even if they
|
||||
have no API etc entered. Auth will not manage these groups automatically so user removal is up to
|
||||
Public - Other options are respected, but any user will be able to become
|
||||
and remain a member, even if they have no API etc entered.
|
||||
Auth will not manage these groups automatically so user removal is up to
|
||||
group managers/leaders.
|
||||
|
||||
Not Internal and:
|
||||
@@ -75,46 +97,88 @@ class AuthGroup(models.Model):
|
||||
Not Open - Users requests must be approved before they are added to the group
|
||||
"""
|
||||
group = models.OneToOneField(Group, on_delete=models.CASCADE, primary_key=True)
|
||||
internal = models.BooleanField(
|
||||
default=True,
|
||||
help_text=_(
|
||||
"Internal group, users cannot see, join or request to join this group.<br>"
|
||||
"Used for groups such as Members, Corp_*, Alliance_* etc.<br>"
|
||||
"<b>Overrides Hidden and Open options when selected.</b>"
|
||||
)
|
||||
)
|
||||
hidden = models.BooleanField(
|
||||
default=True,
|
||||
help_text=_(
|
||||
"Group is hidden from users but can still join with the correct link."
|
||||
)
|
||||
)
|
||||
open = models.BooleanField(
|
||||
default=False,
|
||||
help_text=_(
|
||||
"Group is open and users will be automatically added upon request.<br>"
|
||||
"If the group is not open users will need their request manually approved."
|
||||
)
|
||||
)
|
||||
public = models.BooleanField(
|
||||
default=False,
|
||||
help_text=_(
|
||||
"Group is public. Any registered user is able to join this group, with "
|
||||
"visibility based on the other options set for this group.<br>"
|
||||
"Auth will not remove users from this group automatically when they "
|
||||
"are no longer authenticated."
|
||||
)
|
||||
)
|
||||
group_leaders = models.ManyToManyField(
|
||||
User,
|
||||
related_name='leads_groups',
|
||||
blank=True,
|
||||
help_text=_(
|
||||
"Group leaders can process requests for this group. "
|
||||
"Use the <code>auth.group_management</code> permission to allow "
|
||||
"a user to manage all groups.<br>"
|
||||
)
|
||||
)
|
||||
group_leader_groups = models.ManyToManyField(
|
||||
Group,
|
||||
related_name='leads_group_groups',
|
||||
blank=True,
|
||||
help_text=_(
|
||||
"Members of leader groups can process requests for this group. "
|
||||
"Use the <code>auth.group_management</code> permission "
|
||||
"to allow a user to manage all groups.<br>")
|
||||
)
|
||||
states = models.ManyToManyField(
|
||||
State,
|
||||
related_name='valid_states',
|
||||
blank=True,
|
||||
help_text=_(
|
||||
"States listed here will have the ability to join this group provided "
|
||||
"they have the proper permissions.<br>"
|
||||
)
|
||||
)
|
||||
description = models.TextField(
|
||||
max_length=512,
|
||||
blank=True,
|
||||
help_text=_(
|
||||
"Short description <i>(max. 512 characters)</i> "
|
||||
"of the group shown to users."
|
||||
)
|
||||
)
|
||||
|
||||
internal = models.BooleanField(default=True,
|
||||
help_text="Internal group, users cannot see, join or request to join this group.<br>"
|
||||
"Used for groups such as Members, Corp_*, Alliance_* etc.<br>"
|
||||
"<b>Overrides Hidden and Open options when selected.</b>")
|
||||
hidden = models.BooleanField(default=True, help_text="Group is hidden from users but can still join with the correct link.")
|
||||
open = models.BooleanField(default=False,
|
||||
help_text="Group is open and users will be automatically added upon request. <br>"
|
||||
"If the group is not open users will need their request manually approved.")
|
||||
public = models.BooleanField(default=False,
|
||||
help_text="Group is public. Any registered user is able to join this group, with "
|
||||
"visibility based on the other options set for this group.<br> Auth will "
|
||||
"not remove users from this group automatically when they are no longer "
|
||||
"authenticated.")
|
||||
# Group leaders have management access to this group
|
||||
group_leaders = models.ManyToManyField(User, related_name='leads_groups', blank=True,
|
||||
help_text="Group leaders can process group requests for this group "
|
||||
"specifically. Use the auth.group_management permission to allow "
|
||||
"a user to manage all groups.")
|
||||
# allow groups to be *group leads*
|
||||
group_leader_groups = models.ManyToManyField(Group, related_name='leads_group_groups', blank=True,
|
||||
help_text="Group leaders can process group requests for this group "
|
||||
"specifically. Use the auth.group_management permission to allow "
|
||||
"a user to manage all groups.")
|
||||
|
||||
states = models.ManyToManyField(State, related_name='valid_states', blank=True,
|
||||
help_text="States listed here will have the ability to join this group provided "
|
||||
"they have the proper permissions.")
|
||||
|
||||
description = models.TextField(max_length=512, blank=True, help_text="Short description <i>(max. 512 characters)"
|
||||
"</i> of the group shown to users.")
|
||||
class Meta:
|
||||
permissions = (
|
||||
("request_groups", _("Can request non-public groups")),
|
||||
)
|
||||
default_permissions = tuple()
|
||||
|
||||
def __str__(self):
|
||||
return self.group.name
|
||||
|
||||
class Meta:
|
||||
permissions = (
|
||||
("request_groups", "Can request non-public groups"),
|
||||
def group_request_approvers(self) -> Set[User]:
|
||||
"""Return all users who can approve a group request."""
|
||||
return set(
|
||||
self.group_leaders.all()
|
||||
| User.objects.filter(groups__in=list(self.group_leader_groups.all()))
|
||||
)
|
||||
default_permissions = tuple()
|
||||
|
||||
|
||||
@receiver(post_save, sender=Group)
|
||||
|
||||
Reference in New Issue
Block a user