Skip to content

Views

hypha.apply.dashboard.views

MySubmissionContextMixin

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def get_context_data(self, **kwargs):
    submissions = ApplicationSubmission.objects.all().for_table(self.request.user)
    my_submissions = (
        submissions.filter(user=self.request.user)
        .active()
        .current()
        .select_related("draft_revision")
    )
    my_submissions = [submission.from_draft() for submission in my_submissions]

    my_inactive_submissions = (
        submissions.filter(user=self.request.user).inactive().current()
    )
    my_inactive_submissions_table = ReviewerSubmissionsTable(
        my_inactive_submissions, prefix="my-submissions-"
    )

    return super().get_context_data(
        my_submissions=my_submissions,
        my_inactive_submissions=my_inactive_submissions_table,
        **kwargs,
    )

MyFlaggedMixin

my_flagged 

my_flagged(submissions)
Source code in hypha/apply/dashboard/views.py 
63
64
65
66
67
68
69
70
71
72
73
def my_flagged(self, submissions):
    submissions = submissions.flagged_by(self.request.user).order_by("-submit_time")

    limit = 5
    return {
        "table": UserFlaggedSubmissionsTable(
            submissions[:limit],
            prefix="my-flagged-",
        ),
        "display_more": submissions.count() > limit,
    }

AdminDashboardView

Bases: MyFlaggedMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/dashboard.html'

my_flagged 

my_flagged(submissions)
Source code in hypha/apply/dashboard/views.py 
63
64
65
66
67
68
69
70
71
72
73
def my_flagged(self, submissions):
    submissions = submissions.flagged_by(self.request.user).order_by("-submit_time")

    limit = 5
    return {
        "table": UserFlaggedSubmissionsTable(
            submissions[:limit],
            prefix="my-flagged-",
        ),
        "display_more": submissions.count() > limit,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    submissions = ApplicationSubmission.objects.all().for_table(self.request.user)

    context.update(
        {
            "active_invoices": self.active_invoices(),
            "awaiting_reviews": self.awaiting_reviews(submissions),
            "can_export": can_export_submissions(self.request.user),
            "my_reviewed": self.my_reviewed(submissions),
            "projects": self.projects(),
            "rounds": self.rounds(),
            "my_flagged": self.my_flagged(submissions),
            "paf_for_review": self.paf_for_review(),
            "my_tasks": self.my_tasks(),
        }
    )

    return context

paf_for_review 

paf_for_review()
Source code in hypha/apply/dashboard/views.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def paf_for_review(self):
    if not self.request.user.is_apply_staff:
        return {"count": None, "table": None}
    project_settings = ProjectSettings.for_request(self.request)

    paf_approvals = get_paf_for_review(
        user=self.request.user,
        is_paf_approval_sequential=project_settings.paf_approval_sequential,
    )
    paf_table = PAFForReviewDashboardTable(
        paf_approvals, prefix="paf-review-", order_by="-date_requested"
    )
    RequestConfig(self.request, paginate=False).configure(paf_table)

    return {
        "count": paf_approvals.count(),
        "table": paf_table,
    }

my_tasks 

my_tasks()
Source code in hypha/apply/dashboard/views.py 
118
119
120
121
122
123
def my_tasks(self):
    tasks = render_task_templates_for_user(self.request, self.request.user)
    return {
        "count": len(tasks),
        "data": tasks,
    }

awaiting_reviews 

awaiting_reviews(submissions)
Source code in hypha/apply/dashboard/views.py 
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def awaiting_reviews(self, submissions):
    submissions = submissions.in_review_for(self.request.user).order_by(
        "-submit_time"
    )
    count = submissions.count()

    limit = 5
    return {
        "active_statuses_filter": "".join(
            f"&status={status}"
            for status in review_filter_for_user(self.request.user)
        ),
        "count": count,
        "display_more": count > limit,
        "table": SummarySubmissionsTableWithRole(
            submissions[:limit], prefix="my-review-"
        ),
    }

active_invoices 

active_invoices()
Source code in hypha/apply/dashboard/views.py 
144
145
146
147
148
149
150
151
152
def active_invoices(self):
    invoices = Invoice.objects.filter(
        project__lead=self.request.user,
    ).in_progress()

    return {
        "count": invoices.count(),
        "table": InvoiceDashboardTable(invoices),
    }

projects 

projects()
Source code in hypha/apply/dashboard/views.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def projects(self):
    projects = Project.objects.filter(lead=self.request.user).for_table()

    filterset = ProjectListFilter(
        data=self.request.GET or None, request=self.request, queryset=projects
    )

    limit = 10

    return {
        "count": projects.count(),
        "filterset": filterset,
        "table": ProjectsDashboardTable(data=projects[:limit], prefix="project-"),
        "display_more": projects.count() > limit,
        "url": reverse("apply:projects:all"),
    }

my_reviewed 

my_reviewed(submissions)

Staff reviewer's reviewed submissions for 'Previous reviews' block

Source code in hypha/apply/dashboard/views.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def my_reviewed(self, submissions):
    """Staff reviewer's reviewed submissions for 'Previous reviews' block"""
    submissions = submissions.reviewed_by(self.request.user).order_by(
        "-submit_time"
    )

    limit = 5
    return {
        "filterset": SubmissionFilterAndSearch(
            data=self.request.GET or None,
            request=self.request,
            queryset=submissions,
        ),
        "table": SummarySubmissionsTableWithRole(
            submissions[:limit], prefix="my-review-"
        ),
        "display_more": submissions.count() > limit,
        "url": reverse("funds:submissions:list"),
    }

rounds 

rounds()
Source code in hypha/apply/dashboard/views.py 
191
192
193
194
195
196
197
198
199
200
201
202
def rounds(self):
    limit = 6
    rounds = (
        RoundsAndLabs.objects.with_progress()
        .active()
        .order_by("-end_date")
        .by_lead(self.request.user)
    )
    return {
        "closed": rounds.closed()[:limit],
        "open": rounds.open()[:limit],
    }

FinanceDashboardView

Bases: MyFlaggedMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/finance_dashboard.html'

my_flagged 

my_flagged(submissions)
Source code in hypha/apply/dashboard/views.py 
63
64
65
66
67
68
69
70
71
72
73
def my_flagged(self, submissions):
    submissions = submissions.flagged_by(self.request.user).order_by("-submit_time")

    limit = 5
    return {
        "table": UserFlaggedSubmissionsTable(
            submissions[:limit],
            prefix="my-flagged-",
        ),
        "display_more": submissions.count() > limit,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)

    context.update(
        {
            "active_invoices": self.active_invoices(),
            "invoices_for_approval": self.invoices_for_approval(),
            "invoices_to_convert": self.invoices_to_convert(),
            "paf_for_review": self.paf_for_review(),
            "my_tasks": self.my_tasks(),
        }
    )

    return context

paf_for_review 

paf_for_review()
Source code in hypha/apply/dashboard/views.py 
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
def paf_for_review(self):
    if not self.request.user.is_finance:
        return {"count": None, "table": None}
    project_settings = ProjectSettings.for_request(self.request)

    paf_approvals = get_paf_for_review(
        user=self.request.user,
        is_paf_approval_sequential=project_settings.paf_approval_sequential,
    )
    paf_table = PAFForReviewDashboardTable(
        paf_approvals, prefix="paf-review-", order_by="-date_requested"
    )
    RequestConfig(self.request, paginate=False).configure(paf_table)

    return {
        "count": paf_approvals.count(),
        "table": paf_table,
    }

my_tasks 

my_tasks()
Source code in hypha/apply/dashboard/views.py 
242
243
244
245
246
247
def my_tasks(self):
    tasks = render_task_templates_for_user(self.request, self.request.user)
    return {
        "count": len(tasks),
        "data": tasks,
    }

active_invoices 

active_invoices()
Source code in hypha/apply/dashboard/views.py 
249
250
251
252
253
254
255
256
257
258
def active_invoices(self):
    if self.request.user.is_finance_level_2:
        invoices = Invoice.objects.for_finance_2()
    else:
        invoices = Invoice.objects.for_finance_1()

    return {
        "count": invoices.count(),
        "table": InvoiceDashboardTable(invoices),
    }

invoices_for_approval 

invoices_for_approval()
Source code in hypha/apply/dashboard/views.py 
260
261
262
263
264
265
266
def invoices_for_approval(self):
    if self.request.user.is_finance_level_2:
        invoices = Invoice.objects.approved_by_finance_1()
    else:
        invoices = Invoice.objects.approved_by_staff()

    return {"count": invoices.count(), "table": InvoiceDashboardTable(invoices)}

invoices_to_convert 

invoices_to_convert()
Source code in hypha/apply/dashboard/views.py 
268
269
270
271
272
273
274
275
276
277
278
def invoices_to_convert(self):
    if settings.INVOICE_EXTENDED_WORKFLOW and self.request.user.is_finance_level_1:
        return {
            "count": None,
            "table": None,
        }
    invoices = Invoice.objects.waiting_to_convert()
    return {
        "count": invoices.count(),
        "table": InvoiceDashboardTable(invoices),
    }

ReviewerDashboardView

Bases: MyFlaggedMixin, MySubmissionContextMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/reviewer_dashboard.html'

my_flagged 

my_flagged(submissions)
Source code in hypha/apply/dashboard/views.py 
63
64
65
66
67
68
69
70
71
72
73
def my_flagged(self, submissions):
    submissions = submissions.flagged_by(self.request.user).order_by("-submit_time")

    limit = 5
    return {
        "table": UserFlaggedSubmissionsTable(
            submissions[:limit],
            prefix="my-flagged-",
        ),
        "display_more": submissions.count() > limit,
    }

get 

get(request, *args, **kwargs)
Source code in hypha/apply/dashboard/views.py 
284
285
286
287
288
289
290
291
292
293
294
295
def get(self, request, *args, **kwargs):
    # redirect to submissions list when we use the filter to search for something
    if len(request.GET):
        query_str = "?"
        for key, value in request.GET.items():
            query_str += key + "=" + value + "&"
        return HttpResponseRedirect(
            reverse_lazy("funds:submissions:list") + query_str
        )

    context = self.get_context_data(**kwargs)
    return render(request, self.template_name, context)

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    """
    If use_settings variable is set for ReviewerSettings use settings
    parameters to filter submissions or return all as it
    was by default.
    """
    reviewer_settings = ReviewerSettings.for_request(self.request)
    if reviewer_settings.use_settings:
        submissions = ApplicationSubmission.objects.for_reviewer_settings(
            self.request.user, reviewer_settings
        ).for_table(self.request.user)
    else:
        submissions = ApplicationSubmission.objects.all().for_table(
            self.request.user
        )

    context.update(
        {
            "awaiting_reviews": self.awaiting_reviews(submissions),
            "my_reviewed": self.my_reviewed(submissions),
            "my_flagged": self.my_flagged(submissions),
        }
    )

    return context

awaiting_reviews 

awaiting_reviews(submissions)
Source code in hypha/apply/dashboard/views.py 
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
def awaiting_reviews(self, submissions):
    submissions = submissions.in_review_for(self.request.user).order_by(
        "-submit_time"
    )
    count = submissions.count()

    limit = 5
    return {
        "active_statuses_filter": "".join(
            f"&status={status}"
            for status in review_filter_for_user(self.request.user)
        ),
        "count": count,
        "display_more": count > limit,
        "table": ReviewerSubmissionsTable(submissions[:limit], prefix="my-review-"),
    }

my_reviewed 

my_reviewed(submissions)

Staff reviewer's reviewed submissions for 'Previous reviews' block

Source code in hypha/apply/dashboard/views.py 
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
def my_reviewed(self, submissions):
    """Staff reviewer's reviewed submissions for 'Previous reviews' block"""
    submissions = submissions.reviewed_by(self.request.user).order_by(
        "-submit_time"
    )

    limit = 5
    return {
        "filterset": SubmissionReviewerFilterAndSearch(
            data=self.request.GET or None,
            request=self.request,
            queryset=submissions,
        ),
        "table": ReviewerSubmissionsTable(submissions[:limit], prefix="my-review-"),
        "display_more": submissions.count() > limit,
        "url": reverse("funds:submissions:list"),
    }

PartnerDashboardView

Bases: MySubmissionContextMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/partner_dashboard.html'

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    submissions = ApplicationSubmission.objects.all().for_table(self.request.user)

    # Submissions in which user added as partner
    partner_submissions, partner_submissions_table = self.partner_submissions(
        self.request.user, submissions
    )

    context.update(
        {
            "partner_submissions": partner_submissions_table,
            "partner_submissions_count": partner_submissions.count(),
        }
    )

    return context

partner_submissions 

partner_submissions(user, submissions)
Source code in hypha/apply/dashboard/views.py 
381
382
383
384
385
386
387
def partner_submissions(self, user, submissions):
    partner_submissions = submissions.partner_for(user).order_by("-submit_time")
    partner_submissions_table = SubmissionsTable(
        partner_submissions, prefix="my-partnered-"
    )

    return partner_submissions, partner_submissions_table

ContractingDashboardView

Bases: MyFlaggedMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/contracting_dashboard.html'

my_flagged 

my_flagged(submissions)
Source code in hypha/apply/dashboard/views.py 
63
64
65
66
67
68
69
70
71
72
73
def my_flagged(self, submissions):
    submissions = submissions.flagged_by(self.request.user).order_by("-submit_time")

    limit = 5
    return {
        "table": UserFlaggedSubmissionsTable(
            submissions[:limit],
            prefix="my-flagged-",
        ),
        "display_more": submissions.count() > limit,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
393
394
395
396
397
398
399
400
401
402
403
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    context.update(
        {
            "projects_in_contracting": self.projects_in_contracting(),
            "paf_for_review": self.paf_for_review(),
            "my_tasks": self.my_tasks(),
        }
    )

    return context

paf_for_review 

paf_for_review()
Source code in hypha/apply/dashboard/views.py 
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
def paf_for_review(self):
    if not self.request.user.is_contracting:
        return {"count": None, "table": None}
    project_settings = ProjectSettings.for_request(self.request)

    paf_approvals = get_paf_for_review(
        user=self.request.user,
        is_paf_approval_sequential=project_settings.paf_approval_sequential,
    )
    paf_table = PAFForReviewDashboardTable(
        paf_approvals, prefix="paf-review-", order_by="-date_requested"
    )
    RequestConfig(self.request, paginate=False).configure(paf_table)

    return {
        "count": paf_approvals.count(),
        "table": paf_table,
    }

my_tasks 

my_tasks()
Source code in hypha/apply/dashboard/views.py 
424
425
426
427
428
429
def my_tasks(self):
    tasks = render_task_templates_for_user(self.request, self.request.user)
    return {
        "count": len(tasks),
        "data": tasks,
    }

projects_in_contracting 

projects_in_contracting()
Source code in hypha/apply/dashboard/views.py 
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
def projects_in_contracting(self):
    if not self.request.user.is_contracting:
        return {
            "count": None,
            "waiting_for_contract": {
                "count": None,
                "table": None,
            },
            "waiting_for_contract_approval": {
                "count": None,
                "table": None,
            },
        }
    projects_in_contracting = Project.objects.in_contracting()
    waiting_for_contract = projects_in_contracting.filter(
        contracts__isnull=True
    ).for_table()
    waiting_for_contract_approval = projects_in_contracting.filter(
        contracts__isnull=False
    ).for_table()
    return {
        "count": projects_in_contracting.count(),
        "waiting_for_contract": {
            "count": waiting_for_contract.count(),
            "table": ProjectsDashboardTable(
                data=waiting_for_contract, prefix="project-waiting-contract-"
            ),
        },
        "waiting_for_contract_approval": {
            "count": waiting_for_contract_approval.count(),
            "table": ProjectsDashboardTable(
                data=waiting_for_contract_approval,
                prefix="project-waiting-approval-",
            ),
        },
    }

CommunityDashboardView

Bases: MySubmissionContextMixin, TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/community_dashboard.html'

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    submissions = ApplicationSubmission.objects.all().for_table(self.request.user)

    # Submissions in community review phase
    my_community_review, my_community_review = self.my_community_review(
        self.request.user, submissions
    )

    # Partner's reviewed submissions
    my_reviewed = self.my_reviewed(self.request, submissions)

    context.update(
        {
            "my_community_review": my_community_review,
            "my_community_review_count": my_community_review.count(),
            "my_reviewed": my_reviewed,
        }
    )

    return context

my_community_review 

my_community_review(user, submissions)
Source code in hypha/apply/dashboard/views.py 
494
495
496
497
498
499
500
501
502
def my_community_review(self, user, submissions):
    my_community_review = submissions.in_community_review(user).order_by(
        "-submit_time"
    )
    my_community_review_table = ReviewerSubmissionsTable(
        my_community_review, prefix="my-community-review-"
    )

    return my_community_review, my_community_review_table

my_reviewed 

my_reviewed(request, submissions)
Source code in hypha/apply/dashboard/views.py 
504
505
506
507
508
def my_reviewed(self, request, submissions):
    return ReviewerSubmissionsTable(
        submissions.reviewed_by(request.user).order_by("-submit_time"),
        prefix="my-reviewed-",
    )

ApplicantDashboardView

Bases: TemplateView

template_name class-attribute instance-attribute 

template_name = 'dashboard/applicant_dashboard.html'

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/dashboard/views.py 
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    context["my_submissions_exists"] = ApplicationSubmission.objects.filter(
        user=self.request.user
    ).exists()

    # Number of items to show in skeleton in each section of lazy loading
    context["per_section_items"] = range(3)

    context["my_projects_exists"] = Project.objects.filter(
        user=self.request.user
    ).exists()
    context["active_invoices"] = self.active_invoices()
    context["historical_projects"] = self.historical_project_data()
    context["historical_submissions"] = self.historical_submission_data()
    context["my_tasks"] = self.my_tasks()
    return context

my_tasks 

my_tasks()
Source code in hypha/apply/dashboard/views.py 
532
533
534
535
536
537
def my_tasks(self):
    tasks = render_task_templates_for_user(self.request, self.request.user)
    return {
        "count": len(tasks),
        "data": tasks,
    }

active_invoices 

active_invoices()
Source code in hypha/apply/dashboard/views.py 
539
540
541
542
543
544
545
def active_invoices(self):
    active_invoices = (
        Invoice.objects.filter(project__user=self.request.user)
        .exclude(status__in=[PAID, DECLINED])
        .order_by("-requested_at")
    )
    return {"count": active_invoices.count(), "data": active_invoices}

historical_project_data 

historical_project_data()
Source code in hypha/apply/dashboard/views.py 
547
548
549
550
551
552
553
554
555
556
def historical_project_data(self):
    historical_projects = (
        Project.objects.filter(user=self.request.user).complete().for_table()
    )
    return {
        "count": historical_projects.count(),
        "table": ProjectsDashboardTable(
            data=historical_projects, prefix="past-project-"
        ),
    }

historical_submission_data 

historical_submission_data()
Source code in hypha/apply/dashboard/views.py 
558
559
560
561
562
563
564
565
566
567
568
569
570
def historical_submission_data(self):
    historical_submissions = (
        ApplicationSubmission.objects.filter(
            user=self.request.user,
        )
        .inactive()
        .current()
        .for_table(self.request.user)
    )
    return {
        "count": historical_submissions.count(),
        "table": SubmissionsTable(data=historical_submissions),
    }

DashboardView

Bases: ViewDispatcher

admin_view class-attribute instance-attribute 

admin_view = AdminDashboardView

reviewer_view class-attribute instance-attribute 

reviewer_view = ReviewerDashboardView

partner_view class-attribute instance-attribute 

partner_view = PartnerDashboardView

community_view class-attribute instance-attribute 

community_view = CommunityDashboardView

applicant_view class-attribute instance-attribute 

applicant_view = ApplicantDashboardView

finance_view class-attribute instance-attribute 

finance_view = FinanceDashboardView

contracting_view class-attribute instance-attribute 

contracting_view = ContractingDashboardView

admin_check 

admin_check(request)
Source code in hypha/apply/utils/views.py 
28
29
def admin_check(self, request):
    return request.user.is_apply_staff

reviewer_check 

reviewer_check(request)
Source code in hypha/apply/utils/views.py 
31
32
def reviewer_check(self, request):
    return request.user.is_reviewer

partner_check 

partner_check(request)
Source code in hypha/apply/utils/views.py 
34
35
def partner_check(self, request):
    return request.user.is_partner

community_check 

community_check(request)
Source code in hypha/apply/utils/views.py 
37
38
def community_check(self, request):
    return request.user.is_community_reviewer

finance_check 

finance_check(request)
Source code in hypha/apply/utils/views.py 
40
41
def finance_check(self, request):
    return request.user.is_finance

contracting_check 

contracting_check(request)
Source code in hypha/apply/utils/views.py 
43
44
def contracting_check(self, request):
    return request.user.is_contracting

applicant_check 

applicant_check(request)
Source code in hypha/apply/utils/views.py 
46
47
def applicant_check(self, request):
    return request.user.is_applicant

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/dashboard/views.py 
582
583
584
585
586
587
588
589
590
591
def dispatch(self, request, *args, **kwargs):
    response = super().dispatch(request, *args, **kwargs)

    # Handle the case when there is no dashboard for the user
    # and redirect them to the home page of apply site.
    # Suggestion: create a dedicated dashboard for user without any role.
    if isinstance(response, HttpResponseForbidden):
        return HttpResponseRedirect("/")

    return response