Project tags

hypha.apply.projects.templatetags.project_tags

register module-attribute

register = Library()

project_can_have_report

project_can_have_report(project)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def project_can_have_report(project):
    if project.status in [COMPLETE, CLOSING, INVOICING_AND_REPORTING]:
        return True
    return False

user_next_step_on_project

user_next_step_on_project(project, user, request=None)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_next_step_on_project(project, user, request=None):
    from hypha.apply.projects.models.project import PAFReviewersRole, ProjectSettings

    if project.status == DRAFT:
        if user.is_apply_staff:
            if not project.user_has_updated_details:
                return {
                    "heading": _("To do"),
                    "text": _("Fill in the Approval Form(PAF)"),
                }
            if project.paf_approvals.exists():
                return {
                    "heading": _("To do"),
                    "text": _("Resubmit project documents for approval"),
                }
            return {
                "heading": _("To do"),
                "text": _("Submit project documents for approval"),
            }
        elif user.is_applicant:
            return {
                "heading": _("Waiting for"),
                "text": _(
                    "Awaiting project documents to be created and approved by {org_short_name} internally. "
                    "Please check back when the project has moved to contracting stage."
                ).format(org_short_name=settings.ORG_SHORT_NAME),
            }
        if project.paf_approvals.exists():
            return {
                "heading": _("Waiting for"),
                "text": _("Changes requested. Awaiting documents to be resubmitted."),
            }
        return {
            "heading": _("Waiting for"),
            "text": _("Awaiting approval form to be created."),
        }
    elif project.status == INTERNAL_APPROVAL:
        if user.is_applicant:
            return {
                "heading": _("Waiting for"),
                "text": _(
                    "Awaiting project documents to be created and approved by {org_short_name} internally. "
                    "Please check back when the project has moved to contracting stage."
                ).format(org_short_name=settings.ORG_SHORT_NAME),
            }

        if request:
            project_settings = ProjectSettings.for_request(request=request)
            if project_settings.paf_approval_sequential:
                latest_unapproved_approval = project.paf_approvals.filter(
                    approved=False
                ).first()
                if latest_unapproved_approval:
                    if latest_unapproved_approval.user:
                        return {
                            "heading": _("Waiting for"),
                            "text": _(
                                "Awaiting approval. Assigned to {approver}"
                            ).format(approver=latest_unapproved_approval.user),
                        }
                    return {
                        "heading": _("Waiting for"),
                        "text": _(
                            "Awaiting {reviewer_role} to assign an approver"
                        ).format(
                            reviewer_role=latest_unapproved_approval.paf_reviewer_role.label
                        ),
                    }
            else:
                matched_roles = PAFReviewersRole.objects.annotate(
                    roles_count=Count("user_roles")
                ).filter(roles_count=len(user.groups.all()))
                for group in user.groups.all():
                    matched_roles = matched_roles.filter(user_roles__id=group.id)
                if not matched_roles:
                    return {
                        "heading": _("Waiting for"),
                        "text": _("Awaiting PAF approval form to be approved"),
                    }
                else:
                    matched_unapproved_approval = project.paf_approvals.filter(
                        approved=False, paf_reviewer_role__in=matched_roles
                    )
                    if not matched_unapproved_approval.exists():
                        return {
                            "heading": _("Waiting for"),
                            "text": _("Awaiting approval from other approvers teams"),
                        }
                    else:
                        if matched_unapproved_approval.first().user:
                            return {
                                "heading": _("Waiting for"),
                                "text": _(
                                    "Awaiting approval. Assigned to {approver}"
                                ).format(
                                    approver=matched_unapproved_approval.first().user
                                ),
                            }
                        return {
                            "heading": _("Waiting for"),
                            "text": _(
                                "Awaiting {reviewer_role} to assign an approver"
                            ).format(
                                reviewer_role=matched_unapproved_approval.first().paf_reviewer_role.label
                            ),
                        }

        return {
            "heading": _("Waiting for"),
            "text": _("Awaiting project approval from assigned approvers"),
        }
    elif project.status == CONTRACTING:
        if not project.contracts.exists():
            if user.is_applicant:
                return {
                    "heading": _("Waiting for"),
                    "text": _("Awaiting signed contract from {org_short_name}").format(
                        org_short_name=settings.ORG_SHORT_NAME
                    ),
                }
            if settings.STAFF_UPLOAD_CONTRACT:
                return {
                    "heading": _("Waiting for"),
                    "text": _("Awaiting signed contract from Staff/Contracting team"),
                }
            return {
                "heading": _("Waiting for"),
                "text": _("Awaiting signed contract from Contracting team"),
            }
        else:
            contract = project.contracts.order_by("-created_at").first()
            if not contract.signed_by_applicant:
                if user.is_applicant:
                    return {
                        "heading": _("To do"),
                        "text": _(
                            "Awaiting contract documents to be submitted by you."
                        ),
                    }
                return {
                    "heading": _("Waiting for"),
                    "text": _("Awaiting countersigned contract from Vendor"),
                }
            elif not project.submitted_contract_documents:
                if user.is_applicant:
                    return {
                        "heading": _("To do"),
                        "text": _("Awaiting contract documents submission by you"),
                    }
                return {
                    "heading": _("Waiting for"),
                    "text": _("Awaiting contract documents submission from Vendor"),
                }
            else:
                if user.is_apply_staff:
                    return {
                        "heading": _("To do"),
                        "text": _(
                            "Review the contract for all relevant details and approve."
                        ),
                    }
                if user.is_applicant:
                    return {
                        "heading": _("Waiting for"),
                        "text": _(
                            "Awaiting contract approval from {org_short_name}"
                        ).format(org_short_name=settings.ORG_SHORT_NAME),
                    }
                return {
                    "heading": _("Waiting for"),
                    "text": _("Awaiting contract approval from Staff"),
                }
    elif project.status == INVOICING_AND_REPORTING:
        if user.is_applicant and not project.invoices.exists():
            return {
                "heading": _("To do"),
                "text": _("Add invoices"),
            }
        elif user.is_apply_staff or user.is_finance:
            return {
                "heading": _("To do"),
                "text": _("Review invoice and take action"),
            }
    return False

user_next_step_instructions

user_next_step_instructions(project, user)

To provide instructions incase next step is not enough like 'contracting documents submitted by an applicant'

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_next_step_instructions(project, user):
    """
    To provide instructions incase next step is not enough like 'contracting documents submitted by an applicant'
    """
    if (
        project.status == CONTRACTING
        and user == project.user
        and project.contracts.exists()
    ):
        contract = project.contracts.order_by("-created_at").first()
        if contract and not contract.signed_by_applicant:
            return [
                _(
                    "Please download the signed contract uploaded by {org_short_name}"
                ).format(org_short_name=settings.ORG_SHORT_NAME),
                _("Countersign"),
                _("Upload it back"),
                _(
                    "Please also make sure to upload other required contracting documents"
                ),
            ]
    return False

user_can_update_project_reports

user_can_update_project_reports(project, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_update_project_reports(project, user):
    permission, _ = has_permission(
        "project_reports_update", user, object=project, raise_exception=False
    )
    return permission

user_can_update_report_config

user_can_update_report_config(project, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_update_report_config(project, user):
    permission, _ = has_permission(
        "report_config_update", user, object=project, raise_exception=False
    )
    return permission

user_can_update_report

user_can_update_report(report, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_update_report(report, user):
    permission, _ = has_permission(
        "report_update", user, object=report, raise_exception=False
    )
    return permission

user_can_view_report

user_can_view_report(report, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_view_report(report, user):
    permission, _ = has_permission(
        "report_view", user, object=report, raise_exception=False
    )
    return permission

project_can_have_contracting_section

project_can_have_contracting_section(project)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def project_can_have_contracting_section(project):
    if project.status in [DRAFT, INTERNAL_APPROVAL]:
        return False
    return True

can_access_supporting_documents_section

can_access_supporting_documents_section(project)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def can_access_supporting_documents_section(project):
    if project.status not in [INVOICING_AND_REPORTING, CLOSING, COMPLETE]:
        return True
    return False

show_closing_banner

show_closing_banner(project)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def show_closing_banner(project):
    if project.status in [COMPLETE, CLOSING]:
        return True
    return False

user_can_update_project_status

user_can_update_project_status(project, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_update_project_status(project, user):
    can_update_status, _ = has_permission(
        "project_status_update", user, object=project, raise_exception=False
    )
    return can_update_status

project_settings_url

project_settings_url(instance)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def project_settings_url(instance):
    return reverse(
        "wagtailsettings:edit",
        args=[
            instance._meta.app_label,
            instance._meta.model_name,
            instance.site_id,
        ],
    )

allow_collapsible_header

allow_collapsible_header(project, header_type)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def allow_collapsible_header(project, header_type):
    if header_type == "project_documents" and project.status not in [
        DRAFT,
        INTERNAL_APPROVAL,
    ]:
        return True
    if header_type == "contracting_documents" and project.status not in [
        DRAFT,
        INTERNAL_APPROVAL,
        CONTRACTING,
    ]:
        return True
    return False

user_can_remove_supporting_documents

user_can_remove_supporting_documents(project, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_remove_supporting_documents(project, user):
    if user.is_apply_staff and project.status == DRAFT:
        return True
    return False

user_can_take_actions

user_can_take_actions(project, user)

Checking permissions for 'Action to take' section on paf approval details page.

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def user_can_take_actions(project, user):
    """
    Checking permissions for 'Action to take' section on paf approval details page.
    """
    if user.is_apply_staff or user.is_contracting:
        return True
    if user.id in project.paf_approvals.values_list("user", flat=True):
        return True
    return False

category_latest_file

category_latest_file(project, category)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def category_latest_file(project, category):
    return category.packet_files.filter(project=project).first()

contract_category_latest_file

contract_category_latest_file(project, category)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def contract_category_latest_file(project, category):
    return category.contract_packet_files.filter(project=project).first()

display_project_status

display_project_status(project, user)

Source code in hypha/apply/projects/templatetags/project_tags.py

@register.simple_tag
def display_project_status(project, user):
    if user.is_apply_staff or user.is_contracting or user.is_finance:
        return project.status_display
    return get_project_public_status(project_status=project.status)