Activity tags

hypha.apply.activity.templatetags.activity_tags

register module-attribute

register = Library()

display_author

display_author(activity, user)

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

Parameters:

• activity –

  An Activity object

• user –

  The User that is viewing the given activity

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/activity/templatetags/activity_tags.py

@register.filter
def display_author(activity, user) -> str:
    """Creates a formatted author string based on the activity and viewer role.

    Args:
        activity:
            An [`Activity`][hypha.apply.activity.models.Activity] object
        user:
            The [`User`][hypha.apply.users.models.User] that is viewing the
            given activity

    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).
    """
    if (user.is_applicant or user.is_partner) and (
        activity.user.is_apply_staff
        or activity.user.is_finance
        or activity.user.is_contracting
    ):
        return settings.ORG_LONG_NAME
    if isinstance(activity.related_object, Review) and activity.source.user == user:
        return "Reviewer"
    return activity.user.get_full_name_with_group()

user_can_see_related

user_can_see_related(activity, user)

Source code in hypha/apply/activity/templatetags/activity_tags.py

@register.filter
def user_can_see_related(activity, user):
    if not activity.related_object:
        return False

    if user.is_apply_staff:
        return True

    if isinstance(activity.related_object, (Determination, Contract)):
        return True

    return False

display_for

display_for(activity, user)

Source code in hypha/apply/activity/templatetags/activity_tags.py

@register.filter
def display_for(activity, user):
    try:
        message_data = json.loads(activity.message)
    except json.JSONDecodeError:
        return activity.message
    else:
        # A message with only numbers (int) is valid json so check we have "real" json.
        if not isinstance(message_data, (dict, list)):
            return activity.message

    visible_for_user = activity.visibility_for(user)

    if set(visible_for_user) & {TEAM, REVIEWER}:
        return message_data[TEAM]

    return message_data[ALL]

visibility_options

visibility_options(activity, user)

Gets all visibility choices for the specified user

Parameters:

• activity –

  An Activity object

• user –

  A User object

Returns:

• str –

  A JSON string of visibility options

Source code in hypha/apply/activity/templatetags/activity_tags.py

@register.filter
def visibility_options(activity, user) -> str:
    """Gets all visibility choices for the specified user

    Args:
        activity:
            An [`Activity`][hypha.apply.activity.models.Activity] object
        user:
            A [`User`][hypha.apply.users.models.User] object

    Returns:
        A JSON string of visibility options
    """
    submission_partner_list = activity.source.partners.all()
    choices = activity.visibility_choices_for(user, submission_partner_list)
    return json.dumps(choices)

visibility_display

visibility_display(visibility, user)

Creates a formatted visibility string with visibility string and user.

Parameters:

• visibility (str) –

  A visibility string (likely a constant from activity models)

• user –

  User to be shown the formatted string

Returns:

• str –

  A formatted visibility string (ie. "ACME team" if visibility is "team"

• str –

  and user is applicant or "all" if visibility is "all").

Source code in hypha/apply/activity/templatetags/activity_tags.py

@register.filter
def visibility_display(visibility: str, user) -> str:
    """Creates a formatted visibility string with visibility string and user.

    Args:
        visibility:
            A visibility string (likely a constant from [activity models][hypha.apply.activity.models])
        user:
            [`User`][hypha.apply.users.models.User] to be shown the formatted string

    Returns:
        A formatted visibility string (ie. "ACME team" if visibility is "team"
        and user is applicant or "all" if visibility is "all").
    """
    if not user.is_apply_staff and not user.is_finance and not user.is_contracting:
        team_string = f"{settings.ORG_SHORT_NAME} {TEAM}"
    else:
        team_string = TEAM

    if visibility == APPLICANT_PARTNERS:
        visibility = " + ".join(visibility.split())

    if visibility == TEAM:
        return team_string

    if visibility not in (TEAM, ALL):
        return f"{visibility} + {team_string}"

    return visibility

source_type

source_type(value)

Formats source type

For a given source type containing "submission", this will be converted to "Submission" (ie. "application submission" -> "Submission").

Parameters:

• value –

  the source type to be formatted

Returns:

• str –

  A source type string with a capitalized first letter

Source code in hypha/apply/activity/templatetags/activity_tags.py

@register.filter
def source_type(value) -> str:
    """Formats source type

    For a given source type containing "submission", this will be converted
    to "Submission" (ie. "application submission" -> "Submission").

    Args:
        value: the source type to be formatted

    Returns:
        A source type string with a capitalized first letter
    """
    if value and "submission" in value:
        return "Submission"
    return str(value).capitalize()