Skip to content

Permissions

hypha.apply.funds.permissions

permissions_map module-attribute 

permissions_map = {'submission_view': is_user_has_access_to_view_submission, 'submission_edit': can_edit_submission, 'submission_action': can_take_submission_actions, 'can_view_submission_screening': can_view_submission_screening, 'archive_alter': can_alter_archived_submissions, 'co_applicant_invite': can_invite_co_applicants, 'co_applicants_view': can_view_co_applicants, 'co_applicants_update': can_update_co_applicant}

has_permission 

has_permission(action, user, object=None, raise_exception=True)
Source code in hypha/apply/funds/permissions.py 
11
12
13
14
15
16
17
18
def has_permission(action, user, object=None, raise_exception=True):
    value, reason = permissions_map[action](user, object)

    # :todo: cache the permissions based on key action:user_id:object:id
    if raise_exception and not value:
        raise PermissionDenied(reason)

    return value, reason

can_take_submission_actions 

can_take_submission_actions(user, submission)
Source code in hypha/apply/funds/permissions.py 
21
22
23
24
25
26
27
28
def can_take_submission_actions(user, submission):
    if not user.is_authenticated:
        return False, "Login Required"

    if submission.is_archive:
        return False, "Archived Submission"

    return True, ""

can_edit_submission 

can_edit_submission(user, submission)
Source code in hypha/apply/funds/permissions.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def can_edit_submission(user, submission):
    if not user.is_authenticated:
        return False, "Login Required"

    if submission.is_archive:
        return False, "Archived Submission"

    if submission.phase.permissions.can_edit(user):
        co_applicant = submission.co_applicants.filter(user=user).first()
        if co_applicant:
            if co_applicant.role not in [CoApplicantRole.VIEW, CoApplicantRole.COMMENT]:
                return (
                    True,
                    "Co-applicant with read/view only or comment access can't edit submission",
                )
            return False, ""
        return True, "User can edit in current phase"
    return False, ""

view_comments 

view_comments(role, user, submission)
Source code in hypha/apply/funds/permissions.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@register_object_checker()
def view_comments(role, user, submission) -> bool:
    from hypha.apply.projects.permissions import can_access_project

    if role == StaffAdmin:
        return True

    if is_user_has_access_to_view_submission(user, submission):
        return True

    if submission.project and can_access_project(user, submission.project):
        return True

    return False

delete_submission 

delete_submission(role, user, submission)

Determines if a user has permission to delete a submission.

Permissions are granted if: - User is a Superuser, or StaffAdmin - User has explicit delete_applicationsubmission permission - User is the applicant of the submission and it is in draft state

Source code in hypha/apply/funds/permissions.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
@register_object_checker()
def delete_submission(role, user, submission) -> bool:
    """
    Determines if a user has permission to delete a submission.

    Permissions are granted if:
    - User is a Superuser, or StaffAdmin
    - User has explicit delete_applicationsubmission permission
    - User is the applicant of the submission and it is in draft state
    """
    if role == StaffAdmin:
        return True

    if user.has_perm("funds.delete_applicationsubmission"):
        return True

    # Allow the user to delete their own draft submissions
    if user == submission.user and submission.status == DRAFT_STATE:
        return True

    return False

can_bulk_delete_submissions 

can_bulk_delete_submissions(user)
Source code in hypha/apply/funds/permissions.py 
90
91
92
93
def can_bulk_delete_submissions(user) -> bool:
    if user.is_apply_staff:
        return True
    return False

can_bulk_update_submissions 

can_bulk_update_submissions(user)
Source code in hypha/apply/funds/permissions.py 
96
97
98
99
def can_bulk_update_submissions(user) -> bool:
    if user.is_apply_staff:
        return True
    return False

get_archive_view_groups 

get_archive_view_groups()

Returns a list of groups that can view archived submissions

Source code in hypha/apply/funds/permissions.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
def get_archive_view_groups() -> list:
    """
    Returns a list of groups that can view archived submissions
    """

    archive_access_view_groups = [SUPERADMIN]

    if settings.SUBMISSIONS_ARCHIVED_VIEW_ACCESS_STAFF:
        archive_access_view_groups.append(STAFF_GROUP_NAME)
    if settings.SUBMISSIONS_ARCHIVED_VIEW_ACCESS_STAFF_ADMIN:
        archive_access_view_groups.append(TEAMADMIN_GROUP_NAME)

    return archive_access_view_groups

can_view_archived_submissions 

can_view_archived_submissions(user)

Return a boolean based on if a user can view archived submissions

Source code in hypha/apply/funds/permissions.py 
117
118
119
120
121
122
123
124
125
126
127
def can_view_archived_submissions(user) -> bool:
    """
    Return a boolean based on if a user can view archived submissions
    """
    archive_view_groups = get_archive_view_groups()

    if user.is_apply_staff and STAFF_GROUP_NAME in archive_view_groups:
        return True
    if user.is_apply_staff_admin and TEAMADMIN_GROUP_NAME in archive_view_groups:
        return True
    return False

get_archive_alter_groups 

get_archive_alter_groups()

Returns a list of groups that can archive & unarchive submissions

Source code in hypha/apply/funds/permissions.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
def get_archive_alter_groups() -> list:
    """
    Returns a list of groups that can archive & unarchive submissions
    """

    archive_access_groups = [SUPERADMIN]

    if settings.SUBMISSIONS_ARCHIVED_ACCESS_STAFF:
        archive_access_groups.append(STAFF_GROUP_NAME)
    if settings.SUBMISSIONS_ARCHIVED_ACCESS_STAFF_ADMIN:
        archive_access_groups.append(TEAMADMIN_GROUP_NAME)

    return archive_access_groups

can_alter_archived_submissions 

can_alter_archived_submissions(user, submission=None)

Return a boolean based on if a user can alter archived submissions

Source code in hypha/apply/funds/permissions.py 
145
146
147
148
149
150
151
152
153
154
155
def can_alter_archived_submissions(user, submission=None) -> (bool, str):
    """
    Return a boolean based on if a user can alter archived submissions
    """
    archive_access_groups = get_archive_alter_groups()

    if user.is_apply_staff and STAFF_GROUP_NAME in archive_access_groups:
        return True, "Staff is set to alter archive"
    if user.is_apply_staff_admin and TEAMADMIN_GROUP_NAME in archive_access_groups:
        return True, "Staff Admin is set to alter archive"
    return False, "Forbidden Error"

can_bulk_archive_submissions 

can_bulk_archive_submissions(user)
Source code in hypha/apply/funds/permissions.py 
158
159
160
161
162
def can_bulk_archive_submissions(user) -> bool:
    if can_alter_archived_submissions(user) and can_bulk_delete_submissions(user):
        return True

    return False

can_change_external_reviewers 

can_change_external_reviewers(user, submission)

External reviewers of a submission can be changed by lead and staff.

Staff can only change external reviewers if the GIVE_STAFF_LEAD_PERMS setting is enabled. Superusers can always change external reviewers.

Source code in hypha/apply/funds/permissions.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def can_change_external_reviewers(user, submission) -> bool:
    """
    External reviewers of a submission can be changed by lead and staff.

    Staff can only change external reviewers if the `GIVE_STAFF_LEAD_PERMS`
    setting is enabled. Superusers can always change external reviewers.
    """
    # check if all submissions have external review enabled
    if not submission.stage.has_external_review:
        return False

    if user.is_superuser:
        return True

    if settings.GIVE_STAFF_LEAD_PERMS and user.is_apply_staff:
        return True

    # only leads can change external reviewers
    if submission.lead.id == user.id:
        return True

    return False

can_access_drafts 

can_access_drafts(user)
Source code in hypha/apply/funds/permissions.py 
189
190
191
192
193
194
def can_access_drafts(user) -> bool:
    if user.is_apply_staff and settings.SUBMISSIONS_DRAFT_ACCESS_STAFF:
        return True
    if user.is_apply_staff_admin and settings.SUBMISSIONS_DRAFT_ACCESS_STAFF_ADMIN:
        return True
    return False

can_export_submissions 

can_export_submissions(user)
Source code in hypha/apply/funds/permissions.py 
197
198
199
200
201
202
def can_export_submissions(user) -> bool:
    if user.is_apply_staff and settings.SUBMISSIONS_EXPORT_ACCESS_STAFF:
        return True
    if user.is_apply_staff_admin and settings.SUBMISSIONS_EXPORT_ACCESS_STAFF_ADMIN:
        return True
    return False

is_user_has_access_to_view_submission 

is_user_has_access_to_view_submission(user, submission)
Source code in hypha/apply/funds/permissions.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
def is_user_has_access_to_view_submission(user, submission):
    if not user.is_authenticated:
        return False, "Login Required"

    if submission.is_archive and not can_view_archived_submissions(user):
        return False, "Archived Submission"

    if (
        user.is_apply_staff
        or submission.user == user
        or user.is_reviewer
        or submission.co_applicants.filter(user=user).exists()
    ):
        return True, ""

    if user.is_partner and submission.partners.filter(pk=user.pk).exists():
        return True, ""

    if user.is_community_reviewer and submission.community_review:
        return True, ""

    return False, ""

can_view_submission_screening 

can_view_submission_screening(user, submission)
Source code in hypha/apply/funds/permissions.py 
229
230
231
232
233
234
235
def can_view_submission_screening(user, submission):
    submission_view, _ = is_user_has_access_to_view_submission(user, submission)
    if not submission_view:
        return False, "No access to view submission"
    if submission.user == user:
        return False, "Applicant cannot view submission screening"
    return True, ""

can_invite_co_applicants 

can_invite_co_applicants(user, submission)
Source code in hypha/apply/funds/permissions.py 
238
239
240
241
242
243
244
245
246
247
248
def can_invite_co_applicants(user, submission):
    if (
        submission.co_applicant_invites.all().count()
        >= settings.SUBMISSIONS_COAPPLICANT_INVITES_LIMIT
    ):
        return False, "Limit reached for this submission"
    if user.is_applicant and user == submission.user:
        return True, "Applicants can invite co-applicants to their application"
    if user.is_apply_staff:
        return True, "Staff can invite co-applicant on behalf of applicant"
    return False, "Forbidden Error"

can_view_co_applicants 

can_view_co_applicants(user, submission)
Source code in hypha/apply/funds/permissions.py 
251
252
253
254
255
256
def can_view_co_applicants(user, submission):
    if user.is_applicant and user == submission.user:
        return True, "Submission user can access their submission's co-applicants"
    if user.is_apply_staff:
        return True, "Staff can access each submissions' co-applicants"
    return False, "Forbidden Error"

can_update_co_applicant 

can_update_co_applicant(user, invite)
Source code in hypha/apply/funds/permissions.py 
259
260
261
262
263
264
265
266
def can_update_co_applicant(user, invite):
    if invite.invited_by == user:
        return True, "Same user who invited can delete the co-applicant"
    if invite.submission.user == user:
        return True, "Submission owner can delete the co-applicant"
    if user.is_apply_staff:
        return True, "Staff can delete any co-applicant of any submission"
    return False, "Forbidden Error"

user_can_view_post_comment_form 

user_can_view_post_comment_form(user, submission)
Source code in hypha/apply/funds/permissions.py 
269
270
271
272
273
def user_can_view_post_comment_form(user, submission):
    co_applicant = CoApplicant.objects.filter(user=user, submission=submission).first()
    if co_applicant and co_applicant.role == CoApplicantRole.VIEW:
        return False
    return True