Skip to content

Workflow tags

hypha.apply.funds.templatetags.workflow_tags

register module-attribute 

register = Library()

check_permission 

check_permission(user, perm, submission)
Source code in hypha/apply/funds/templatetags/workflow_tags.py 
11
12
13
14
15
def check_permission(user, perm, submission):
    if submission.is_archive:
        return False
    perm_method = getattr(submission.phase.permissions, f"can_{perm}", lambda x: False)
    return perm_method(user)

has_edit_perm 

has_edit_perm(user, submission)
Source code in hypha/apply/funds/templatetags/workflow_tags.py 
18
19
20
@register.filter
def has_edit_perm(user, submission):
    return check_permission(user, "edit", submission)

has_review_perm 

has_review_perm(user, submission)
Source code in hypha/apply/funds/templatetags/workflow_tags.py 
23
24
25
@register.filter
def has_review_perm(user, submission):
    return check_permission(user, "review", submission)

show_applicant_identity 

show_applicant_identity(submission, user)

Determine whether or not to display the applicant's identity.

Parameters:

  • submission (ApplicationSubmission) –

    the submission submitted by applicant

  • user (User) –

    the user viewing the submission

Returns:

  • bool ( bool ) –

    True = show the applicant's identity

Source code in hypha/apply/funds/templatetags/workflow_tags.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@register.filter
def show_applicant_identity(submission: ApplicationSubmission, user: User) -> bool:
    """Determine whether or not to display the applicant's identity.

    Args:
        submission: the submission submitted by applicant
        user: the user viewing the submission

    Returns:
        bool: True = show the applicant's identity
    """
    if (
        settings.HIDE_IDENTITY_FROM_REVIEWERS
        and not user.is_org_faculty
        and user in submission.reviewers.all()
    ):
        return False

    return True

display_submission_author 

display_submission_author(context, revision_author=False)

Creates a formatted author string based on the submission and viewer role.

Parameters:

  • context (dict) –

    dict of template context

  • revision_author (bool, default: False ) –

    if True, gets revision author. False (default) gets submission author

Returns:

  • str –

    A string with the formatted author depending on the user role (ie. a

  • str –

    comment from staff viewed by an applicant will return the org name).

Source code in hypha/apply/funds/templatetags/workflow_tags.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@register.simple_tag(takes_context=True)
def display_submission_author(context: dict, revision_author: bool = False) -> str:
    """Creates a formatted author string based on the submission and viewer role.

    Args:
        context: dict of template context
        revision_author: if True, gets revision author. False (default) gets submission author

    Returns:
        A string with the formatted author depending on the user role (ie. a
        comment from staff viewed by an applicant will return the org name).
    """
    submission: ApplicationSubmission = context["object"]
    request = context["request"]

    author = submission.user if not revision_author else submission.live_revision.author
    if (
        not revision_author or author == submission.user
    ) and not show_applicant_identity(submission, request.user):
        return _("Applicant")
    elif (
        settings.HIDE_STAFF_IDENTITY
        and author.is_org_faculty
        and not request.user.is_org_faculty
    ):
        return settings.ORG_LONG_NAME  # Likely an edge case but covering bases

    return str(author)