Skip to content

Permissions

hypha.apply.projects.reports.permissions

update_project_reports 

update_project_reports(role, user, project)

Determines if a user can update project reports.

Parameters:

  • role –

    The role of the user.

  • user –

    The user attempting to update project reports.

  • project –

    The project whose reports are being updated.

Returns:

  • bool ( bool ) –

    True if the user can update project reports, False otherwise.

Conditions
  • User must be authenticated
  • Project status must be INVOICING_AND_REPORTING
  • User must be a StaffAdmin or the project owner
Source code in hypha/apply/projects/reports/permissions.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@register_object_checker()
def update_project_reports(role, user, project) -> bool:
    """
    Determines if a user can update project reports.

    Args:
        role: The role of the user.
        user: The user attempting to update project reports.
        project: The project whose reports are being updated.

    Returns:
        bool: True if the user can update project reports, False otherwise.

    Conditions:
        - User must be authenticated
        - Project status must be INVOICING_AND_REPORTING
        - User must be a StaffAdmin or the project owner
    """
    if not user.is_authenticated:
        return False
    if project.status != INVOICING_AND_REPORTING:
        return False
    if role == StaffAdmin or user == project.user:
        return True
    return False

update_report_config 

update_report_config(role, user, project)

Determines if a user can update the report configuration for a project.

Parameters:

  • role –

    The role of the user.

  • user –

    The user attempting to update the report configuration.

  • project –

    The project whose report configuration is being updated.

Returns:

  • bool ( bool ) –

    True if the user can update the report configuration, False otherwise.

Conditions
  • User must be authenticated
  • Project status must be INVOICING_AND_REPORTING
  • Disallow if only one time reporting is allowed and is up to date
  • User must have apply staff permissions
Source code in hypha/apply/projects/reports/permissions.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@register_object_checker()
def update_report_config(role, user, project) -> bool:
    """
    Determines if a user can update the report configuration for a project.

    Args:
        role: The role of the user.
        user: The user attempting to update the report configuration.
        project: The project whose report configuration is being updated.

    Returns:
        bool: True if the user can update the report configuration, False otherwise.

    Conditions:
        - User must be authenticated
        - Project status must be INVOICING_AND_REPORTING
        - Disallow if only one time reporting is allowed and is up to date
        - User must have apply staff permissions
    """
    if not user.is_authenticated:
        return False
    if project.status != INVOICING_AND_REPORTING:
        return False

    if project.report_config.does_not_repeat and project.report_config.is_up_to_date():
        return False

    if user.is_apply_staff:
        return True
    return False

view_report 

view_report(role, user, report)

Determines if a user can view a report.

Parameters:

  • role –

    The role of the user.

  • user –

    The user attempting to view the report.

  • report –

    The report being accessed.

Returns:

  • bool ( bool ) –

    True if the user can view the report, False otherwise.

Conditions
  • User must be authenticated
  • Project status must be in COMPLETE, CLOSING, or INVOICING_AND_REPORTING
  • Report must be current and not skipped
  • User must be apply staff or the project owner
Source code in hypha/apply/projects/reports/permissions.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@register_object_checker()
def view_report(role, user, report) -> bool:
    """
    Determines if a user can view a report.

    Args:
        role: The role of the user.
        user: The user attempting to view the report.
        report: The report being accessed.

    Returns:
        bool: True if the user can view the report, False otherwise.

    Conditions:
        - User must be authenticated
        - Project status must be in COMPLETE, CLOSING, or INVOICING_AND_REPORTING
        - Report must be current and not skipped
        - User must be apply staff or the project owner
    """
    if not user.is_authenticated:
        return False
    if report.project.status not in [COMPLETE, CLOSING, INVOICING_AND_REPORTING]:
        return False
    if not report.current:
        return False
    if report.skipped:
        return False
    if user.is_apply_staff or user.is_finance or user == report.project.user:
        return True
    return False

update_report 

update_report(role, user, report)

Determines if a user can update a report.

Parameters:

  • role –

    The role of the user.

  • user –

    The user attempting to update the report.

  • report –

    The report being updated.

Returns:

  • bool ( bool ) –

    True if the user can update the report, False otherwise.

Conditions
  • User must be authenticated
  • Project status must be INVOICING_AND_REPORTING
  • Report must not be skipped
  • Report must be in a state that can be submitted
  • User must be apply staff or the project owner (and report not current)
Source code in hypha/apply/projects/reports/permissions.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
@register_object_checker()
def update_report(role, user, report) -> bool:
    """
    Determines if a user can update a report.

    Args:
        role: The role of the user.
        user: The user attempting to update the report.
        report: The report being updated.

    Returns:
        bool: True if the user can update the report, False otherwise.

    Conditions:
        - User must be authenticated
        - Project status must be INVOICING_AND_REPORTING
        - Report must not be skipped
        - Report must be in a state that can be submitted
        - User must be apply staff or the project owner (and report not current)
    """
    if not user.is_authenticated:
        return False
    if report.project.status != INVOICING_AND_REPORTING:
        return False
    if report.skipped:
        return False
    if not report.can_submit:
        return False

    if user.is_apply_staff or (user == report.project.user and not report.current):
        return True

    return False