{help_text}
" diff --git a/hypha/apply/users/forms.py b/hypha/apply/users/forms.py index a72c953a1a..e52415b732 100644 --- a/hypha/apply/users/forms.py +++ b/hypha/apply/users/forms.py @@ -5,9 +5,10 @@ from django.template.defaultfilters import mark_safe from django.utils.translation import gettext_lazy as _ from django_select2.forms import Select2Widget +from rolepermissions import roles from wagtail.users.forms import UserCreationForm, UserEditForm -from .models import AuthSettings, GroupDesc +from .models import AuthSettings from .utils import strip_html_and_nerf_urls User = get_user_model() @@ -125,7 +126,9 @@ def label_from_instance(self, group_obj): """ Overwriting ModelMultipleChoiceField's label from instance to provide help_text (if it exists) """ - help_text = GroupDesc.get_from_group(group_obj) + help_text = getattr( + roles.registered_roles.get(group_obj.name, {}), "help_text", "" + ) if help_text: return mark_safe( f'{group_obj.name}{help_text}
' diff --git a/hypha/apply/users/groups.py b/hypha/apply/users/groups.py deleted file mode 100644 index 882f02f819..0000000000 --- a/hypha/apply/users/groups.py +++ /dev/null @@ -1,93 +0,0 @@ -from django.utils.translation import gettext_lazy as _ - -SUPERADMIN = _("Administrator") -APPLICANT_GROUP_NAME = _("Applicant") -STAFF_GROUP_NAME = _("Staff") -REVIEWER_GROUP_NAME = _("Reviewer") -TEAMADMIN_GROUP_NAME = _("Staff Admin") -PARTNER_GROUP_NAME = _("Partner") -COMMUNITY_REVIEWER_GROUP_NAME = _("Community reviewer") -APPROVER_GROUP_NAME = _("Approver") -FINANCE_GROUP_NAME = _("Finance") -CONTRACTING_GROUP_NAME = _("Contracting") - -APPLICANT_HELP_TEXT = _( - "Can access their own application and communicate via the communication tab." -) -STAFF_HELP_TEXT = _( - "View and edit all submissions, submit reviews, send determinations, and set up applications." -) -REVIEWER_HELP_TEXT = _( - "Has a dashboard and can submit reviews. Advisory Council Members are typically assigned this role." -) - -TEAMADMIN_HELP_TEXT = _( - "Can view application message log. Must also be in group Staff." -) - -PARTNER_HELP_TEXT = _( - "Can view, edit, and comment on a specific application they are assigned to." -) - -COMMUNITY_REVIEWER_HELP_TEXT = _( - "An applicant with access to other applications utilizing the community/peer review workflow." -) - -APPROVER_HELP_TEXT = _( - "Can review/approve PAF, and access compliance documents. Must also be in group: Staff, Contracting, or Finance." -) -FINANCE_HELP_TEXT = _( - "Can review/approve the PAF, access documents associated with contracting, and access invoices approved by Staff." -) -CONTRACTING_HELP_TEXT = _( - "Can review/approve the PAF and access documents associated with contracting." -) - - -GROUPS = [ - { - "name": APPLICANT_GROUP_NAME, - "permissions": [], - "help_text": APPLICANT_HELP_TEXT, - }, - { - "name": STAFF_GROUP_NAME, - "permissions": [], - "help_text": STAFF_HELP_TEXT, - }, - { - "name": REVIEWER_GROUP_NAME, - "permissions": [], - "help_text": REVIEWER_HELP_TEXT, - }, - { - "name": TEAMADMIN_GROUP_NAME, - "permissions": [], - "help_text": TEAMADMIN_HELP_TEXT, - }, - { - "name": PARTNER_GROUP_NAME, - "permissions": [], - "help_text": PARTNER_HELP_TEXT, - }, - { - "name": COMMUNITY_REVIEWER_GROUP_NAME, - "permissions": [], - "help_text": COMMUNITY_REVIEWER_HELP_TEXT, - }, - { - "name": APPROVER_GROUP_NAME, - "permissions": [], - "help_text": APPROVER_HELP_TEXT, - }, - { - "name": FINANCE_GROUP_NAME, - "permissions": [], - "help_text": FINANCE_HELP_TEXT, - }, - { - "name": CONTRACTING_GROUP_NAME, - "permissions": [], - "help_text": CONTRACTING_HELP_TEXT, - }, -] diff --git a/hypha/apply/users/management/commands/migrate_users.py b/hypha/apply/users/management/commands/migrate_users.py index 2e65c20b0a..59d91389e2 100644 --- a/hypha/apply/users/management/commands/migrate_users.py +++ b/hypha/apply/users/management/commands/migrate_users.py @@ -7,7 +7,7 @@ from django.core.management.base import BaseCommand from django.db import transaction -from hypha.apply.users.groups import STAFF_GROUP_NAME +from hypha.apply.users.roles import STAFF_GROUP_NAME class Command(BaseCommand): diff --git a/hypha/apply/users/migrations/0002_initial_data.py b/hypha/apply/users/migrations/0002_initial_data.py index 1621f68c92..de52563a2e 100644 --- a/hypha/apply/users/migrations/0002_initial_data.py +++ b/hypha/apply/users/migrations/0002_initial_data.py @@ -2,35 +2,15 @@ # Generated by Django 1.11.7 on 2017-12-15 13:15 from __future__ import unicode_literals -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import GROUPS - def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for permission in group_data["permissions"]: - try: - group.permissions.add(Permission.objects.get(codename=permission)) - except ObjectDoesNotExist: - print("Could not find the '%s' permission" % permission) + pass def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - - groups = [group_data["name"] for group_data in GROUPS] - Group.objects.filter(name__in=groups).delete() + pass class Migration(migrations.Migration): diff --git a/hypha/apply/users/migrations/0008_add_staff_permissions.py b/hypha/apply/users/migrations/0008_add_staff_permissions.py index d6be98faac..8f91ec2ebe 100644 --- a/hypha/apply/users/migrations/0008_add_staff_permissions.py +++ b/hypha/apply/users/migrations/0008_add_staff_permissions.py @@ -1,19 +1,11 @@ # Generated by Django 2.0.9 on 2019-01-10 09:28 -from django.contrib.auth.models import Group, Permission from django.db import migrations -from hypha.apply.users.groups import STAFF_GROUP_NAME - class Migration(migrations.Migration): - def add_permissions(apps, schema_editor): - staff_group = Group.objects.get(name=STAFF_GROUP_NAME) - staff_add_perm = Permission.objects.get(name="Can change event") - staff_group.permissions.add(staff_add_perm) - dependencies = [ ("users", "0007_user_slack"), ] - operations = [migrations.RunPython(add_permissions)] + operations = [] diff --git a/hypha/apply/users/migrations/0009_add_partner_group.py b/hypha/apply/users/migrations/0009_add_partner_group.py index a471d8d8f8..eca6859675 100644 --- a/hypha/apply/users/migrations/0009_add_partner_group.py +++ b/hypha/apply/users/migrations/0009_add_partner_group.py @@ -1,38 +1,12 @@ # Generated by Django 2.0.9 on 2018-12-19 13:21 from __future__ import unicode_literals -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import GROUPS, TEAMADMIN_GROUP_NAME, PARTNER_GROUP_NAME - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for permission in group_data["permissions"]: - try: - group.permissions.add(Permission.objects.get(codename=permission)) - except ObjectDoesNotExist: - print("Could not find the '%s' permission" % permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name__in=[TEAMADMIN_GROUP_NAME, PARTNER_GROUP_NAME]).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0008_add_staff_permissions"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0010_add_community_reviewer_group.py b/hypha/apply/users/migrations/0010_add_community_reviewer_group.py index 4829cbaf5c..be39afe9c4 100644 --- a/hypha/apply/users/migrations/0010_add_community_reviewer_group.py +++ b/hypha/apply/users/migrations/0010_add_community_reviewer_group.py @@ -1,38 +1,12 @@ # Generated by Django 2.0.9 on 2018-12-19 13:21 from __future__ import unicode_literals -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import GROUPS, COMMUNITY_REVIEWER_GROUP_NAME - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for permission in group_data["permissions"]: - try: - group.permissions.add(Permission.objects.get(codename=permission)) - except ObjectDoesNotExist: - print("Could not find the '%s' permission" % permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name__in=[COMMUNITY_REVIEWER_GROUP_NAME]).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0009_add_partner_group"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0011_add_applicant_group.py b/hypha/apply/users/migrations/0011_add_applicant_group.py index e55ee34e7d..05a8304744 100644 --- a/hypha/apply/users/migrations/0011_add_applicant_group.py +++ b/hypha/apply/users/migrations/0011_add_applicant_group.py @@ -1,38 +1,12 @@ # Generated by Django 2.0.9 on 2018-12-19 13:21 from __future__ import unicode_literals -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import GROUPS, APPLICANT_GROUP_NAME - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for permission in group_data["permissions"]: - try: - group.permissions.add(Permission.objects.get(codename=permission)) - except ObjectDoesNotExist: - print("Could not find the '%s' permission" % permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name__in=[APPLICANT_GROUP_NAME]).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0010_add_community_reviewer_group"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0012_set_applicant_group.py b/hypha/apply/users/migrations/0012_set_applicant_group.py index 0358424960..38e88013db 100644 --- a/hypha/apply/users/migrations/0012_set_applicant_group.py +++ b/hypha/apply/users/migrations/0012_set_applicant_group.py @@ -1,35 +1,12 @@ # Generated by Django 2.0.9 on 2018-12-19 13:21 from __future__ import unicode_literals -from django.contrib.auth import get_user_model -from django.contrib.auth.models import Group from django.db import migrations -from hypha.apply.users.groups import APPLICANT_GROUP_NAME - - -def set_group(apps, schema_editor): - User = get_user_model() - applicant_group = Group.objects.get(name=APPLICANT_GROUP_NAME) - applicants = User.objects.exclude(applicationsubmission=None) - for user in applicants: - if not user.is_apply_staff: - user.groups.add(applicant_group) - user.save() - - -def unset_group(apps, schema_editor): - User = get_user_model() - applicant_group = Group.objects.get(name=APPLICANT_GROUP_NAME) - applicants = User.objects.filter(groups__name=APPLICANT_GROUP_NAME).all() - for user in applicants: - user.groups.remove(applicant_group) - user.save() - class Migration(migrations.Migration): dependencies = [ ("users", "0011_add_applicant_group"), ] - operations = [migrations.RunPython(set_group, unset_group)] + operations = [] diff --git a/hypha/apply/users/migrations/0013_add_approver_group.py b/hypha/apply/users/migrations/0013_add_approver_group.py index 3638944b2c..5662ab86d4 100644 --- a/hypha/apply/users/migrations/0013_add_approver_group.py +++ b/hypha/apply/users/migrations/0013_add_approver_group.py @@ -1,40 +1,11 @@ # Generated by Django 2.0.13 on 2019-08-05 13:12 -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import APPROVER_GROUP_NAME, GROUPS - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for codename in group_data["permissions"]: - try: - permission = Permission.objects.get(codename=codename) - except ObjectDoesNotExist: - print(f"Could not find the '{permission}' permission") - continue - - group.permissions.add(permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name=APPROVER_GROUP_NAME).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0012_set_applicant_group"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0016_add_finance_group.py b/hypha/apply/users/migrations/0016_add_finance_group.py index 88525ad545..c170781980 100644 --- a/hypha/apply/users/migrations/0016_add_finance_group.py +++ b/hypha/apply/users/migrations/0016_add_finance_group.py @@ -1,40 +1,11 @@ # Generated by Django 2.0.13 on 2019-08-05 13:12 -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import FINANCE_GROUP_NAME, GROUPS - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for codename in group_data["permissions"]: - try: - permission = Permission.objects.get(codename=codename) - except ObjectDoesNotExist: - print(f"Could not find the '{permission}' permission") - continue - - group.permissions.add(permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name=FINANCE_GROUP_NAME).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0015_login_extra_text"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0017_rename_staff_admin.py b/hypha/apply/users/migrations/0017_rename_staff_admin.py index 11ae3ad0a0..ac2c859ff7 100644 --- a/hypha/apply/users/migrations/0017_rename_staff_admin.py +++ b/hypha/apply/users/migrations/0017_rename_staff_admin.py @@ -1,35 +1,12 @@ # Generated by Django 2.0.9 on 2018-12-19 13:21 from __future__ import unicode_literals -from django.contrib.auth.models import Group from django.db import migrations -from hypha.apply.users.groups import TEAMADMIN_GROUP_NAME - - -def rename_group(apps, schema_editor): - try: - team_admin_group = Group.objects.get(name="Team Admin") - except Group.DoesNotExist: - pass - else: - team_admin_group.name = TEAMADMIN_GROUP_NAME - team_admin_group.save() - - -def unrename_group(apps, schema_editor): - try: - team_admin_group = Group.objects.get(name=TEAMADMIN_GROUP_NAME) - except Group.DoesNotExist: - pass - else: - team_admin_group.name = "Team Admin" - team_admin_group.save() - class Migration(migrations.Migration): dependencies = [ ("users", "0016_add_finance_group"), ] - operations = [migrations.RunPython(rename_group, unrename_group)] + operations = [] diff --git a/hypha/apply/users/migrations/0018_add_contracting_group.py b/hypha/apply/users/migrations/0018_add_contracting_group.py index ac220bd2c4..1965ae478e 100644 --- a/hypha/apply/users/migrations/0018_add_contracting_group.py +++ b/hypha/apply/users/migrations/0018_add_contracting_group.py @@ -1,40 +1,11 @@ # Generated by Django 2.0.13 on 2019-08-05 13:12 -from django.core.exceptions import ObjectDoesNotExist -from django.core.management.sql import emit_post_migrate_signal from django.db import migrations -from hypha.apply.users.groups import CONTRACTING_GROUP_NAME, GROUPS - - -def add_groups(apps, schema_editor): - # Workaround for https://code.djangoproject.com/ticket/23422 - db_alias = schema_editor.connection.alias - emit_post_migrate_signal(2, False, db_alias) - - Group = apps.get_model("auth.Group") - Permission = apps.get_model("auth.Permission") - - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - for codename in group_data["permissions"]: - try: - permission = Permission.objects.get(codename=codename) - except ObjectDoesNotExist: - print(f"Could not find the '{permission}' permission") - continue - - group.permissions.add(permission) - - -def remove_groups(apps, schema_editor): - Group = apps.get_model("auth.Group") - Group.objects.filter(name=CONTRACTING_GROUP_NAME).delete() - class Migration(migrations.Migration): dependencies = [ ("users", "0017_rename_staff_admin"), ] - operations = [migrations.RunPython(add_groups, remove_groups)] + operations = [] diff --git a/hypha/apply/users/migrations/0021_groupdesc.py b/hypha/apply/users/migrations/0021_groupdesc.py index 44116250b4..be849fd53b 100644 --- a/hypha/apply/users/migrations/0021_groupdesc.py +++ b/hypha/apply/users/migrations/0021_groupdesc.py @@ -1,19 +1,8 @@ # Generated by Django 3.2.22 on 2023-10-31 17:26 from django.db import migrations, models -from django.contrib.auth.models import Group import django.db.models.deletion -from hypha.apply.users.groups import GROUPS -from hypha.apply.users.models import GroupDesc - - -def add_desc_groups(apps, schema_editor): - for group_data in GROUPS: - group, created = Group.objects.get_or_create(name=group_data["name"]) - if group_data.get("help_text") is not None: - GroupDesc.objects.create(group=group, help_text=group_data["help_text"]) - class Migration(migrations.Migration): dependencies = [ @@ -40,5 +29,4 @@ class Migration(migrations.Migration): ), ], ), - migrations.RunPython(add_desc_groups), ] diff --git a/hypha/apply/users/migrations/0024_update_is_staff.py b/hypha/apply/users/migrations/0024_update_is_staff.py index 09501e7a6b..1bc008cbb7 100644 --- a/hypha/apply/users/migrations/0024_update_is_staff.py +++ b/hypha/apply/users/migrations/0024_update_is_staff.py @@ -3,12 +3,14 @@ from django.db import migrations from django.contrib.auth.models import Group -from hypha.apply.users.groups import TEAMADMIN_GROUP_NAME +from hypha.apply.users.roles import TEAMADMIN_GROUP_NAME from hypha.apply.users.utils import update_is_staff def migrate_is_staff(apps, schema_editor): - group = Group.objects.get(name=TEAMADMIN_GROUP_NAME) + group = Group.objects.filter(name=TEAMADMIN_GROUP_NAME).first() + if group is None: + return users = group.user_set.all() [update_is_staff(None, user) for user in users] diff --git a/hypha/apply/users/migrations/0026_delete_groupdesc.py b/hypha/apply/users/migrations/0026_delete_groupdesc.py new file mode 100644 index 0000000000..73b8de620f --- /dev/null +++ b/hypha/apply/users/migrations/0026_delete_groupdesc.py @@ -0,0 +1,15 @@ +# Generated by Django 4.2.16 on 2024-09-27 05:00 + +from django.db import migrations + + +class Migration(migrations.Migration): + dependencies = [ + ("users", "0025_remove_authsettings_register_extra_text"), + ] + + operations = [ + migrations.DeleteModel( + name="GroupDesc", + ), + ] diff --git a/hypha/apply/users/models.py b/hypha/apply/users/models.py index 17d08f29a1..03dfb257f3 100644 --- a/hypha/apply/users/models.py +++ b/hypha/apply/users/models.py @@ -1,6 +1,6 @@ from django.conf import settings from django.contrib.auth.hashers import make_password -from django.contrib.auth.models import AbstractUser, BaseUserManager, Group +from django.contrib.auth.models import AbstractUser, BaseUserManager from django.core import exceptions from django.db import IntegrityError, models from django.db.models.constants import LOOKUP_SEP @@ -13,7 +13,7 @@ from wagtail.contrib.settings.models import BaseGenericSetting, register_setting from wagtail.fields import RichTextField -from .groups import ( +from .roles import ( APPLICANT_GROUP_NAME, APPROVER_GROUP_NAME, COMMUNITY_REVIEWER_GROUP_NAME, @@ -381,27 +381,6 @@ class Meta: ] -class GroupDesc(models.Model): - group = models.OneToOneField(Group, on_delete=models.CASCADE, primary_key=True) - help_text = models.CharField(verbose_name="Help Text", max_length=255) - - @staticmethod - def get_from_group(group_obj: Group) -> str | None: - """ - Get the group description/help text string from a Group object. Returns None if group doesn't have a help text entry. - - Args: - group_obj (Group): The group to retrieve the description of. - """ - try: - return GroupDesc.objects.get(group_id=group_obj.id).help_text - except (exceptions.ObjectDoesNotExist, exceptions.FieldError): - return None - - def __str__(self): - return self.help_text - - class PendingSignup(models.Model): """This model tracks pending passwordless self-signups, and is used to generate a one-time use URLfor each signup. diff --git a/hypha/apply/users/roles.py b/hypha/apply/users/roles.py new file mode 100644 index 0000000000..d8760b0b6d --- /dev/null +++ b/hypha/apply/users/roles.py @@ -0,0 +1,98 @@ +from django.utils.translation import gettext_lazy as _ +from rolepermissions.roles import AbstractUserRole + +SUPERADMIN = _("Administrator") +APPLICANT_GROUP_NAME = _("Applicant") +STAFF_GROUP_NAME = _("Staff") +REVIEWER_GROUP_NAME = _("Reviewer") +TEAMADMIN_GROUP_NAME = _("Staff Admin") +PARTNER_GROUP_NAME = _("Partner") +COMMUNITY_REVIEWER_GROUP_NAME = _("Community reviewer") +APPROVER_GROUP_NAME = _("Approver") +FINANCE_GROUP_NAME = _("Finance") +CONTRACTING_GROUP_NAME = _("Contracting") + + +# roles for the application +# https://django-role-permissions.readthedocs.io/en/stable/roles.html +class Applicant(AbstractUserRole): + role_name = APPLICANT_GROUP_NAME + help_text = _( + "Can access their own application and communicate via " "the communication tab." + ) + + available_permissions = {} + + +class Staff(AbstractUserRole): + role_name = STAFF_GROUP_NAME + help_text = _( + "View and edit all submissions, submit reviews, send determinations, " + "and set up applications." + ) + + available_permissions = {} + + +class Reviewer(AbstractUserRole): + role_name = REVIEWER_GROUP_NAME + help_text = _( + "Has a dashboard and can submit reviews. " + "Advisory Council Members are typically assigned this role." + ) + + available_permissions = {} + + +class StaffAdmin(AbstractUserRole): + role_name = TEAMADMIN_GROUP_NAME + help_text = _("Can view application message log. Must also be in group Staff.") + + available_permissions = {} + + +class Partner(AbstractUserRole): + role_name = PARTNER_GROUP_NAME + help_text = _( + "Can view, edit, and comment on a specific application they are assigned to." + ) + + available_permissions = {} + + +class CommunityReviewer(AbstractUserRole): + role_name = COMMUNITY_REVIEWER_GROUP_NAME + help_text = _( + "An applicant with access to other applications utilizing the community/peer review workflow." + ) + + available_permissions = {} + + +class Approver(AbstractUserRole): + role_name = APPROVER_GROUP_NAME + help_text = _( + "Can review/approve PAF, and access compliance documents. " + "Must also be in group: Staff, Contracting, or Finance." + ) + + available_permissions = {} + + +class Finance(AbstractUserRole): + role_name = FINANCE_GROUP_NAME + help_text = _( + "Can review/approve the PAF, access documents associated with " + "contracting, and access invoices approved by Staff." + ) + + available_permissions = {} + + +class Contracting(AbstractUserRole): + role_name = CONTRACTING_GROUP_NAME + help_text = _( + "Can review/approve the PAF and access documents associated with contracting." + ) + + available_permissions = {} diff --git a/hypha/apply/users/tests/factories.py b/hypha/apply/users/tests/factories.py index 2068b91c25..ca17b3d84e 100644 --- a/hypha/apply/users/tests/factories.py +++ b/hypha/apply/users/tests/factories.py @@ -5,7 +5,7 @@ from django.contrib.auth.models import Group, Permission from django.utils.text import slugify -from ..groups import ( +from ..roles import ( APPLICANT_GROUP_NAME, APPROVER_GROUP_NAME, COMMUNITY_REVIEWER_GROUP_NAME, diff --git a/hypha/home/wagtail_hooks.py b/hypha/home/wagtail_hooks.py index 2987a90540..f4c7fe6771 100644 --- a/hypha/home/wagtail_hooks.py +++ b/hypha/home/wagtail_hooks.py @@ -1,6 +1,6 @@ from wagtail import hooks -from hypha.apply.users.groups import STAFF_GROUP_NAME +from hypha.apply.users.roles import STAFF_GROUP_NAME from .models import ApplyHomePage diff --git a/hypha/settings/django.py b/hypha/settings/django.py index 8682287c4d..c0703929ac 100644 --- a/hypha/settings/django.py +++ b/hypha/settings/django.py @@ -70,6 +70,7 @@ "rest_framework", "rest_framework_api_key", "django_file_form", + "rolepermissions", "hijack", "elevate", # https://django-elevate.readthedocs.io/ "pagedown", @@ -222,6 +223,9 @@ CUSTOM_AUTH_BACKEND, ) +# django-rolepermissions +ROLEPERMISSIONS_MODULE = "hypha.apply.users.roles" + # Default Auto field configuration DEFAULT_AUTO_FIELD = "django.db.models.AutoField" diff --git a/requirements.txt b/requirements.txt index b0df8fddcb..eff51290e9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -24,6 +24,7 @@ django-htmx==1.17.3 django-pagedown==2.2.1 django-ratelimit==4.1.0 django-referrer-policy==1.0 +django-role-permissions==3.2.0 django-select2==8.1.2 django-slack==5.19.0 django-storages==1.14.2