Skip to content

Invoice

hypha.apply.projects.views.invoice

InvoiceAccessMixin

Bases: UserPassesTestMixin

model class-attribute instance-attribute 

model = Invoice

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

ChangeInvoiceStatusView

Bases: InvoiceAccessMixin, View

form_class class-attribute instance-attribute 

form_class = ChangeInvoiceStatusForm

context_name class-attribute instance-attribute 

context_name = 'change_invoice_status'

model class-attribute instance-attribute 

model = Invoice

template class-attribute instance-attribute 

template = 'application_projects/modals/invoice_status_update.html'

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
131
132
133
def dispatch(self, request, *args, **kwargs):
    self.object: Invoice = self.get_object()
    return super().dispatch(request, *args, **kwargs)

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/invoice.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
def get_context_data(self, **kwargs):
    if not (form := kwargs.get("form")):
        form = self.form_class(instance=self.object, user=self.request.user)

    form.name = self.context_name

    extras = {
        "form": form,
        "form_id": f"{form.name}-{self.object.id}",
        "invoice_status": display_invoice_status_for_user(
            self.request.user, self.object
        ),
        "value": _("Update status"),
        "object": self.object,
    }

    return {**kwargs, **extras}

get 

get(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
153
154
155
156
157
def get(self, *args, **kwargs):
    form_instance = self.form_class(instance=self.object, user=self.request.user)
    form_instance.name = self.context_name

    return render(self.request, self.template, self.get_context_data())

post 

post(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
def post(self, *args, **kwargs):
    # Don't process the post request if the user can't change the status
    old_status = self.object.status
    if not self.object.can_user_change_status(self.request.user):
        return render(
            self.request, self.template, self.get_context_data(), status=403
        )

    form = self.form_class(
        self.request.POST, instance=self.object, user=self.request.user
    )
    if form.is_valid():
        form.save()
        message_kwargs = {}
        if form.cleaned_data["comment"]:
            invoice_status_change = _(
                "<p>Invoice status updated to: {status}.</p>"
            ).format(status=self.object.get_status_display())
            comment = f'<p>"{self.object.comment}"</p>'

            message = invoice_status_change + comment

            comment_activity = Activity.objects.create(
                user=self.request.user,
                type=COMMENT,
                source=self.object.project,
                timestamp=timezone.now(),
                message=message,
                visibility=APPLICANT,
                related_object=self.object,
            )

            message_kwargs["comment_url"] = comment_activity.get_absolute_url()

        if (
            self.request.user.is_apply_staff
            and self.object.status == APPROVED_BY_STAFF
        ):
            self.object.save()
            messenger(
                MESSAGES.APPROVE_INVOICE,
                request=self.request,
                user=self.request.user,
                source=self.object.project,
                related=self.object,
            )

        messenger(
            MESSAGES.UPDATE_INVOICE_STATUS,
            request=self.request,
            user=self.request.user,
            source=self.object.project,
            related=self.object,
            **message_kwargs,
        )

        handle_tasks_on_invoice_update(old_status=old_status, invoice=self.object)
        htmx_headers = {
            "invoicesUpdated": None,
            "showMessage": _("Invoice updated."),
        }
        if self.object.status == DECLINED:
            htmx_headers.update({"rejectedInvoicesUpdated": None})
        return HttpResponse(
            status=204, headers={"HX-Trigger": json.dumps(htmx_headers)}
        )

    return render(
        self.request, self.template, self.get_context_data(form=form), status=400
    )

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

DeleteInvoiceView

Bases: DeleteView

model class-attribute instance-attribute 

model = Invoice

template_name class-attribute instance-attribute 

template_name = 'application_projects/modals/invoice_confirm_delete.html'

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
235
236
237
238
239
240
def dispatch(self, request, *args, **kwargs):
    self.object = self.get_object()
    if not self.object.can_user_delete(request.user):
        raise PermissionDenied

    return super().dispatch(request, *args, **kwargs)

form_valid 

form_valid(form)
Source code in hypha/apply/projects/views/invoice.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
@transaction.atomic()
def form_valid(self, form):
    # remove all tasks related to this invoice irrespective of code and users/user_group
    remove_tasks_of_related_obj(related_obj=self.object)

    response = super().form_valid(form)

    messenger(
        MESSAGES.DELETE_INVOICE,
        request=self.request,
        user=self.request.user,
        source=self.object.project,
        related=self.object.project,
    )

    return response

get_success_url 

get_success_url()
Source code in hypha/apply/projects/views/invoice.py 
259
260
def get_success_url(self):
    return self.object.project.get_absolute_url()

InvoiceAdminView 

InvoiceAdminView(*args, **kwargs)

Bases: InvoiceAccessMixin, DelegateableView, DetailView

Source code in hypha/apply/utils/views.py 
76
77
78
79
80
def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_views class-attribute instance-attribute 

form_views = []

form_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

model class-attribute instance-attribute 

model = Invoice

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
113
114
115
116
117
def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/utils/views.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
def get_context_data(self, **kwargs):
    forms = {}
    for form_view in self._form_views.values():
        view = form_view()
        view.setup(self.request, self.args, self.kwargs)
        context_key, form = view.contribute_form(self)
        forms[context_key] = form

    return super().get_context_data(
        form_prefix=self.form_prefix,
        **forms,
        **kwargs,
    )

post 

post(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
119
120
121
122
123
124
def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

InvoiceApplicantView 

InvoiceApplicantView(*args, **kwargs)

Bases: InvoiceAccessMixin, DelegateableView, DetailView

Source code in hypha/apply/utils/views.py 
76
77
78
79
80
def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_views class-attribute instance-attribute 

form_views = []

form_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

model class-attribute instance-attribute 

model = Invoice

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
113
114
115
116
117
def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/utils/views.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
def get_context_data(self, **kwargs):
    forms = {}
    for form_view in self._form_views.values():
        view = form_view()
        view.setup(self.request, self.args, self.kwargs)
        context_key, form = view.contribute_form(self)
        forms[context_key] = form

    return super().get_context_data(
        form_prefix=self.form_prefix,
        **forms,
        **kwargs,
    )

post 

post(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
119
120
121
122
123
124
def post(self, request, *args, **kwargs):
    self.object = self.get_object()

    kwargs["object"] = self.object

    return super().post(request, *args, **kwargs)

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

InvoiceView

Bases: ViewDispatcher

admin_view class-attribute instance-attribute 

admin_view = InvoiceAdminView

finance_view class-attribute instance-attribute 

finance_view = InvoiceAdminView

applicant_view class-attribute instance-attribute 

applicant_view = InvoiceApplicantView

reviewer_view class-attribute instance-attribute 

reviewer_view = None

community_view class-attribute instance-attribute 

community_view = None

contracting_view class-attribute instance-attribute 

contracting_view = None

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

community_check 

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

finance_check 

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

contracting_check 

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

applicant_check 

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

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def dispatch(self, request, *args, **kwargs):
    view = None

    if self.admin_check(request):
        view = self.admin_view
    elif self.reviewer_check(request):
        view = self.reviewer_view
    elif self.community_check(request):
        view = self.community_view
    elif settings.PROJECTS_ENABLED and self.finance_check(request):
        view = self.finance_view
    elif settings.PROJECTS_ENABLED and self.contracting_check(request):
        view = self.contracting_view
    elif self.applicant_check(request):
        view = self.applicant_view

    if view:
        return view.as_view()(request, *args, **kwargs)
    return HttpResponseForbidden()

CreateInvoiceView

Bases: SuccessMessageMixin, CreateView

model class-attribute instance-attribute 

model = Invoice

form_class class-attribute instance-attribute 

form_class = CreateInvoiceForm

success_message class-attribute instance-attribute 

success_message = _('Invoice added')

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
282
283
284
285
286
287
def dispatch(self, request, *args, **kwargs):
    self.project = get_object_or_404(Project, pk=kwargs["pk"])
    permission = has_object_permission("add_invoice", request.user, self.project)
    if not permission:
        return redirect(self.project)
    return super().dispatch(request, *args, **kwargs)

buttons 

buttons()
Source code in hypha/apply/projects/views/invoice.py 
289
290
def buttons(self):
    yield ("submit", "btn-primary", _("Save"))

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/invoice.py 
292
293
294
295
def get_context_data(self, **kwargs):
    return super().get_context_data(
        project=self.project, buttons=self.buttons(), **kwargs
    )

form_valid 

form_valid(form)
Source code in hypha/apply/projects/views/invoice.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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
def form_valid(self, form):
    form.instance.project = self.project
    form.instance.by = self.request.user

    response = super().form_valid(form)

    if form.cleaned_data["message_for_pm"]:
        invoice_status_change = _("<p>Invoice added.</p>")

        message_for_pm = f'<p>"{form.cleaned_data["message_for_pm"]}"</p>'

        message = invoice_status_change + message_for_pm

        Activity.objects.create(
            user=self.request.user,
            type=COMMENT,
            source=self.project,
            timestamp=timezone.now(),
            message=message,
            visibility=APPLICANT,
            related_object=self.object,
        )

    messenger(
        MESSAGES.CREATE_INVOICE,
        request=self.request,
        user=self.request.user,
        source=self.project,
        related=self.object,
    )

    if self.project.invoices.count() == 1:
        # remove Project waiting invoices task for applicant on first invoice
        remove_tasks_for_user(
            code=PROJECT_WAITING_INVOICE,
            user=self.project.user,
            related_obj=self.project,
        )

    # add Invoice waiting approval task for Staff group
    add_task_to_user(
        code=INVOICE_WAITING_APPROVAL,
        user=self.object.project.lead,
        related_obj=self.object,
    )

    # Required for django-file-form: delete temporary files for the new files
    # that are uploaded.
    form.delete_temporary_files()
    return response

EditInvoiceView

Bases: InvoiceAccessMixin, UpdateView

form_class class-attribute instance-attribute 

form_class = EditInvoiceForm

model class-attribute instance-attribute 

model = Invoice

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
352
353
354
355
356
def dispatch(self, request, *args, **kwargs):
    invoice = self.get_object()
    if not invoice.can_user_edit(request.user):
        return redirect(invoice)
    return super().dispatch(request, *args, **kwargs)

buttons 

buttons()
Source code in hypha/apply/projects/views/invoice.py 
358
359
360
361
def buttons(self):
    yield ("submit", "btn-primary", _("Update"))
    if self.object.can_user_delete(self.request.user):
        yield ("delete", "btn-error", _("Delete"))

get_initial 

get_initial()
Source code in hypha/apply/projects/views/invoice.py 
363
364
365
366
367
368
def get_initial(self):
    initial = super().get_initial()
    initial["supporting_documents"] = [
        document.document for document in self.object.supporting_documents.all()
    ]
    return initial

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/invoice.py 
370
371
372
373
def get_context_data(self, **kwargs):
    return super().get_context_data(
        project=self.object.project, buttons=self.buttons(), **kwargs
    )

post 

post(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
375
376
377
378
379
380
381
382
383
def post(self, request, *args, **kwargs):
    self.object = self.get_object()
    form = self.get_form()
    if "delete" in form.data:
        return redirect("apply:projects:invoice-delete", pk=self.object.pk)
    if form.is_valid():
        return self.form_valid(form)
    else:
        return self.form_invalid(form)

form_valid 

form_valid(form)
Source code in hypha/apply/projects/views/invoice.py 
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
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
def form_valid(self, form):
    old_status = self.object.status
    response = super().form_valid(form)
    message_kwargs = {}

    if form.cleaned_data:
        if self.object.status in INVOICE_TRANSITION_TO_RESUBMITTED:
            self.object.transition_invoice_to_resubmitted()
            self.object.save()

        if form.cleaned_data["message_for_pm"]:
            invoice_status_change = _(
                "<p>Invoice status updated to: {status}.</p>"
            ).format(status=self.object.get_status_display())
            message_for_pm = f'<p>"{form.cleaned_data["message_for_pm"]}"</p>'
            message = invoice_status_change + message_for_pm

            comment_activity = Activity.objects.create(
                user=self.request.user,
                type=COMMENT,
                source=self.object.project,
                timestamp=timezone.now(),
                message=message,
                visibility=APPLICANT,
                related_object=self.object,
            )

            message_kwargs["comment_url"] = comment_activity.get_absolute_url()

    messenger(
        MESSAGES.UPDATE_INVOICE_STATUS,
        request=self.request,
        user=self.request.user,
        source=self.object.project,
        related=self.object,
        **message_kwargs,
    )

    if self.request.user.is_applicant and old_status == CHANGES_REQUESTED_BY_STAFF:
        # remove invoice required changes task for applicant
        remove_tasks_for_user(
            code=INVOICE_REQUIRED_CHANGES,
            user=self.object.project.user,
            related_obj=self.object,
        )

        # add invoice waiting approval task for staff group
        add_task_to_user(
            code=INVOICE_WAITING_APPROVAL,
            user=self.object.project.lead,
            related_obj=self.object,
        )

    if (
        self.request.user.is_apply_staff
        and old_status == CHANGES_REQUESTED_BY_FINANCE
    ):
        # remove invoice required changes task for staff group
        remove_tasks_for_user(
            code=INVOICE_REQUIRED_CHANGES,
            user=self.object.project.lead,
            related_obj=self.object,
        )
        # add invoice waiting approval task for staff group
        add_task_to_user(
            code=INVOICE_WAITING_APPROVAL,
            user=self.object.project.lead,
            related_obj=self.object,
        )

    # Required for django-file-form: delete temporary files for the new files
    # that are uploaded.
    form.delete_temporary_files()
    return response

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

InvoicePrivateMedia

Bases: UserPassesTestMixin, PrivateMediaView

raise_exception class-attribute instance-attribute 

raise_exception = True

storage class-attribute instance-attribute 

storage = PrivateStorage()

dispatch 

dispatch(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
465
466
467
468
def dispatch(self, *args, **kwargs):
    self.invoice = get_object_or_404(Invoice, pk=self.kwargs["pk"])

    return super().dispatch(*args, **kwargs)

get_media 

get_media(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
def get_media(self, *args, **kwargs):
    # check if the request is for a supporting document
    if file_pk := kwargs.get("file_pk"):
        document = get_object_or_404(self.invoice.supporting_documents, pk=file_pk)
        return document.document

    # if not, then it's for invoice document
    if self.invoice.status in [
        APPROVED_BY_STAFF,
        APPROVED_BY_FINANCE,
        PAID,
        PAYMENT_FAILED,
    ] and self.invoice.document.file.name.endswith(".pdf"):
        if activities := Activity.actions.filter(
            Q(message__contains=APPROVED_BY_STAFF)
            | Q(message__contains=APPROVED_BY_FINANCE),
            related_content_type__model="invoice",
            related_object_id=self.invoice.id,
        ).visible_to(self.request.user):
            approval_pdf_page = html_to_pdf(
                render_to_string(
                    "application_projects/pdf_invoice_approved_page.html",
                    context={
                        "invoice": self.invoice,
                        "generated_at": timezone.now(),
                        "activities": activities,
                    },
                    request=self.request,
                )
            )
            return merge_pdf(self.invoice.document.file, approval_pdf_page)

    return self.invoice.document

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.invoice.project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = self.invoice.project.submission.co_applicants.filter(
            user=self.request.user
        ).first()
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

get 

get(*args, **kwargs)
Source code in hypha/apply/utils/storage.py 
35
36
37
def get(self, *args, **kwargs):
    file_to_serve = self.get_media(*args, **kwargs)
    return FileResponse(file_to_serve)

BatchUpdateInvoiceStatusView

Bases: DelegatedViewMixin, FormView

form_class class-attribute instance-attribute 

form_class = BatchUpdateInvoiceStatusForm

context_name class-attribute instance-attribute 

context_name = 'batch_invoice_status_form'

template_name class-attribute instance-attribute 

template_name = 'application_projects/modals/batch_invoice_status_update.html'

get 

get(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
534
535
536
537
538
539
540
541
542
def get(self, *args, **kwargs):
    selected_ids = self.request.GET.getlist("selected_ids", "")
    invoices = Invoice.objects.filter(id__in=selected_ids)
    form = self.form_class(user=self.request.user)
    return render(
        self.request,
        self.template_name,
        context={"form": form, "invoices": invoices},
    )

post 

post(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
def post(self, *args, **kwargs):
    form = self.form_class(self.request.POST, user=self.request.user)
    if form.is_valid():
        new_status = form.cleaned_data["invoice_action"]
        invoices = form.cleaned_data["invoices"]
        invoices_old_statuses = {invoice: invoice.status for invoice in invoices}
        batch_update_invoices_status(
            invoices=invoices,
            user=self.request.user,
            status=new_status,
        )

        # add activity feed for batch update invoice status
        projects = Project.objects.filter(
            id__in=[invoice.project.id for invoice in invoices]
        )
        messenger(
            MESSAGES.BATCH_UPDATE_INVOICE_STATUS,
            request=self.request,
            user=self.request.user,
            sources=projects,
            related=invoices,
        )

        # update tasks for selected invoices
        for invoice, old_status in invoices_old_statuses.items():
            handle_tasks_on_invoice_update(old_status, invoice)
        return HttpResponseClientRefresh()
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return HttpResponseClientRefresh()

get_object 

get_object()
Source code in hypha/apply/utils/views.py 
141
142
143
144
145
146
147
148
149
150
151
def get_object(self):
    # Make sure the form instance, bound at the parent class level,  is the same as the
    # value we work with on the class.
    # If we don't have self.object, bind the parent instance to it. This value will then
    # be used by the form. Any further calls to get_object will get a new instance of the object
    if not hasattr(self, "object"):
        parent_object = self.get_parent_object()
        if isinstance(parent_object, self.model):
            return parent_object

    return super().get_object()

get_template_names 

get_template_names()
Source code in hypha/apply/utils/views.py 
153
154
def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name 

get_form_name()
Source code in hypha/apply/utils/views.py 
156
157
def get_form_name(self):
    return self.context_name

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
159
160
161
162
163
def get_form_kwargs(self):
    form_kwargs = super().get_form_kwargs()
    form_kwargs["user"] = self.request.user
    form_kwargs.update(**self.get_parent_kwargs())
    return form_kwargs

get_parent_kwargs 

get_parent_kwargs()
Source code in hypha/apply/utils/views.py 
165
166
167
168
169
def get_parent_kwargs(self):
    try:
        return self.parent.get_form_kwargs()
    except AttributeError:
        return self.kwargs["parent"].get_form_kwargs()

get_parent_object 

get_parent_object()
Source code in hypha/apply/utils/views.py 
171
172
def get_parent_object(self):
    return self.get_parent_kwargs()["instance"]

get_form 

get_form(*args, **kwargs)
Source code in hypha/apply/utils/views.py 
174
175
176
177
def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/utils/views.py 
179
180
181
182
183
184
def get_context_data(self, **kwargs):
    # Use the previous context but override the validated form
    form = kwargs.pop("form")
    kwargs.update(self.kwargs["context"])
    kwargs.update(**{self.context_name: form})
    return super().get_context_data(**kwargs)

is_model_form classmethod 

is_model_form()
Source code in hypha/apply/utils/views.py 
186
187
188
@classmethod
def is_model_form(cls):
    return issubclass(cls.form_class, ModelForm)

contribute_form 

contribute_form(parent)
Source code in hypha/apply/utils/views.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def contribute_form(self, parent):
    self.parent = parent

    # We do not want to bind any forms generated this way
    # pretend we are doing a get request to avoid passing data to forms
    old_method = None
    if self.request.method in ("POST", "PUT"):
        old_method = self.request.method
        self.request.method = "GET"

    form = self.get_form()

    if old_method:
        self.request.method = old_method
    return self.context_name, form

get_success_url 

get_success_url()
Source code in hypha/apply/utils/views.py 
206
207
208
209
210
def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

InvoiceListView 

InvoiceListView(*args, **kwargs)

Bases: SingleTableMixin, FilterView, DelegateableListView

Source code in hypha/apply/utils/views.py 
76
77
78
79
80
def __init__(self, *args, **kwargs):
    self._form_views = {
        self.form_prefix + form_view.context_name: form_view
        for form_view in self.form_views
    }

form_views class-attribute instance-attribute 

form_views = [BatchUpdateInvoiceStatusView]

filterset_class class-attribute instance-attribute 

filterset_class = InvoiceListFilter

model class-attribute instance-attribute 

model = Invoice

table_class class-attribute instance-attribute 

table_class = AdminInvoiceListTable

template_name class-attribute instance-attribute 

template_name = 'application_projects/invoice_list.html'

form_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

get_queryset 

get_queryset()
Source code in hypha/apply/projects/views/invoice.py 
640
641
642
643
644
645
646
def get_queryset(self):
    return (
        super()
        .get_queryset()
        .select_related("project", "project__user")
        .prefetch_related("tags")
    )

get_table_class 

get_table_class()
Source code in hypha/apply/projects/views/invoice.py 
648
649
650
651
def get_table_class(self):
    if self.request.user.is_finance:
        return FinanceInvoiceTable
    return super().get_table_class()

get 

get(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
def get(self, request, *args, **kwargs):
    if request.GET.get("format") == "csv":
        from hypha.apply.projects.tasks import generate_invoice_csv

        filterset = self.filterset_class(request.GET, queryset=self.get_queryset())
        qs_ids = list(filterset.qs.values_list("id", flat=True))
        generate_invoice_csv.delay(qs_ids, request.user.id)

        if not settings.CELERY_TASK_ALWAYS_EAGER:
            response = render(
                request,
                "application_projects/partials/export-invoice-button.html",
                {
                    "generating": True,
                    "poll_time": get_export_polling_time(len(qs_ids)),
                },
            )
            response["HX-Trigger"] = json.dumps(
                {"showMessage": _("Started CSV generation.")}
            )
            return response
        else:
            return invoice_export_download(request)

    return super().get(request, *args, **kwargs)

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/invoice.py 
679
680
681
682
def get_context_data(self, **kwargs):
    ctx = super().get_context_data(**kwargs)
    ctx["can_export_invoices"] = True
    return ctx

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
128
129
130
131
def get_form_kwargs(self):
    return {
        "user": self.request.user,
    }

post 

post(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
133
134
135
def post(self, request, *args, **kwargs):
    self.object_list = self.get_queryset()
    return super().post(request, *args, **kwargs)

TagInvoiceView

Bases: InvoiceAccessMixin, View

form_class class-attribute instance-attribute 

form_class = InvoiceTagsForm

template_name class-attribute instance-attribute 

template_name = 'application_projects/modals/invoice_tag.html'

model class-attribute instance-attribute 

model = Invoice

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
690
691
692
def dispatch(self, request, *args, **kwargs):
    self.object = self.get_object()
    return super().dispatch(request, *args, **kwargs)

get 

get(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
694
695
696
697
698
699
700
def get(self, *args, **kwargs):
    form = self.form_class(instance=self.object)
    return render(
        self.request,
        self.template_name,
        {"form": form, "object": self.object},
    )

post 

post(*args, **kwargs)
Source code in hypha/apply/projects/views/invoice.py 
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
def post(self, *args, **kwargs):
    form = self.form_class(self.request.POST, instance=self.object)
    if form.is_valid():
        form.save()
        return HttpResponse(
            status=204,
            headers={
                "HX-Trigger": json.dumps(
                    {
                        "invoicesUpdated": None,
                        "showMessage": _("Invoice tags updated."),
                    }
                )
            },
        )
    return render(
        self.request,
        self.template_name,
        {"form": form, "object": self.object},
        status=400,
    )

get_object 

get_object()
Source code in hypha/apply/projects/views/invoice.py 
95
96
def get_object(self):
    return get_object_or_404(Invoice, pk=self.kwargs["pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/invoice.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def test_func(self):
    if self.request.user.is_apply_staff:
        return True

    if self.request.user.is_finance:
        return True

    if self.request.user == self.get_object().project.user:
        return True

    if self.request.user.is_applicant:
        co_applicant = (
            self.get_object()
            .project.submission.co_applicants.filter(user=self.request.user)
            .first()
        )
        if (
            co_applicant
            and CoApplicantProjectPermission.INVOICES
            in co_applicant.project_permission
        ):
            return True

    return False

invoice_export_status 

invoice_export_status(request)

Partial view returning the current state of the invoice CSV export button.

Source code in hypha/apply/projects/views/invoice.py 
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
@login_required
def invoice_export_status(request: HttpResponse) -> HttpResponse:
    """Partial view returning the current state of the invoice CSV export button."""
    ctx = {}
    status = None

    if not settings.CELERY_TASK_ALWAYS_EAGER:
        if export_manager := InvoiceExportManager.objects.filter(
            user=request.user
        ).first():
            status = export_manager.status
            if status == EXPORT_STATUS_GENERATING:
                ctx["poll_time"] = get_export_polling_time(export_manager.total_export)
    else:
        ctx["not_async"] = True

    if status is None or status == EXPORT_STATUS_ERROR:
        all_url = urlparse(request.headers.get("Hx-Current-Url"))
        url_list = list(all_url)
        url_list[4] = urlencode(
            {**parse_qs(all_url.query), "format": "csv"},
            doseq=True,
        )
        ctx["start_export_url"] = urlunparse(url_list)

    ctx["generating"] = status == EXPORT_STATUS_GENERATING
    ctx["failed"] = status == EXPORT_STATUS_ERROR
    ctx["success"] = status == EXPORT_STATUS_SUCCESS

    return render(
        request, "application_projects/partials/export-invoice-button.html", ctx
    )

invoice_export_download 

invoice_export_download(request)
Source code in hypha/apply/projects/views/invoice.py 
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
@login_required
def invoice_export_download(request: HttpResponse) -> HttpResponse:
    export_manager = get_object_or_404(InvoiceExportManager, user=request.user)
    if export_manager.status == EXPORT_STATUS_SUCCESS:
        response = HttpResponse(export_manager.export_data, content_type="text/csv")
        response["Content-Disposition"] = "attachment; filename=invoices.csv"

        remove_tasks_of_related_obj_for_specific_code(
            code=DOWNLOAD_INVOICES_EXPORT, related_obj=export_manager
        )
        export_manager.delete()

        return response

    raise Http404()