Skip to content

Payment

hypha.apply.projects.views.payment

InvoiceAccessMixin

Bases: UserPassesTestMixin

model class-attribute instance-attribute 

model = Invoice

get_object 

get_object()
Source code in hypha/apply/projects/views/payment.py 
74
75
76
def get_object(self):
    project = get_object_or_404(Project, pk=self.kwargs["pk"])
    return get_object_or_404(project.invoices.all(), pk=self.kwargs["invoice_pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/payment.py 
78
79
80
81
82
83
84
85
86
87
88
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

    return False

ChangeInvoiceStatusView

Bases: DelegatedViewMixin, InvoiceAccessMixin, UpdateView

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/includes/update_invoice_form.html'

get_object 

get_object()
Source code in hypha/apply/utils/views.py 
154
155
156
157
158
159
160
161
162
163
164
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()

test_func 

test_func()
Source code in hypha/apply/projects/views/payment.py 
78
79
80
81
82
83
84
85
86
87
88
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

    return False

setup 

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

Source code in hypha/apply/utils/views.py 
148
149
150
151
152
def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_template_names 

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

get_form_name 

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

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
172
173
174
175
176
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 
178
179
180
181
182
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 
184
185
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 
187
188
189
190
def get_form(self, *args, **kwargs):
    form = super().get_form(*args, **kwargs)
    form.name = self.get_form_name()
    return form

is_model_form classmethod 

is_model_form()
Source code in hypha/apply/utils/views.py 
199
200
201
@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 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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 
219
220
221
222
223
def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
 98
 99
100
def dispatch(self, request, *args, **kwargs):
    self.object: Invoice = get_object_or_404(Invoice, id=kwargs.get("invoice_pk"))
    return super().dispatch(request, *args, **kwargs)

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/payment.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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}

form_valid 

form_valid(form)
Source code in hypha/apply/projects/views/payment.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def form_valid(self, form):
    old_status = self.object.status
    response = super().form_valid(form)
    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

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

    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,
    )

    handle_tasks_on_invoice_update(old_status=old_status, invoice=self.object)

    return response

get 

get(*args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
163
164
165
166
167
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/payment.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
def post(self, *args, **kwargs):
    # Don't process the post request if the user can't change the 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():
        self.form_valid(form)
        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
    )

DeleteInvoiceView

Bases: DeleteView

model class-attribute instance-attribute 

model = Invoice

get_object 

get_object()
Source code in hypha/apply/projects/views/payment.py 
196
197
198
def get_object(self):
    project = get_object_or_404(Project, pk=self.kwargs["pk"])
    return get_object_or_404(project.invoices.all(), pk=self.kwargs["invoice_pk"])

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
200
201
202
203
204
205
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/payment.py 
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
@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/payment.py 
224
225
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 
82
83
84
85
86
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_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

model class-attribute instance-attribute 

model = Invoice

form_views class-attribute instance-attribute 

form_views = [ChangeInvoiceStatusView]

template_name_suffix class-attribute instance-attribute 

template_name_suffix = '_admin_detail'

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
119
120
121
122
123
def get_form_kwargs(self):
    return {
        "user": self.request.user,
        "instance": self.object,
    }

post 

post(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
125
126
127
128
129
130
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/payment.py 
74
75
76
def get_object(self):
    project = get_object_or_404(Project, pk=self.kwargs["pk"])
    return get_object_or_404(project.invoices.all(), pk=self.kwargs["invoice_pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/payment.py 
78
79
80
81
82
83
84
85
86
87
88
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

    return False

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/payment.py 
232
233
234
235
236
def get_context_data(self, **kwargs):
    invoice = self.get_object()
    project = invoice.project
    deliverables = project.deliverables.all()
    return super().get_context_data(**kwargs, deliverables=deliverables)

InvoiceApplicantView 

InvoiceApplicantView(*args, **kwargs)

Bases: InvoiceAccessMixin, DelegateableView, DetailView

Source code in hypha/apply/utils/views.py 
82
83
84
85
86
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_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

model class-attribute instance-attribute 

model = Invoice

form_views class-attribute instance-attribute 

form_views = []

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
119
120
121
122
123
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 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
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 
125
126
127
128
129
130
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/payment.py 
74
75
76
def get_object(self):
    project = get_object_or_404(Project, pk=self.kwargs["pk"])
    return get_object_or_404(project.invoices.all(), pk=self.kwargs["invoice_pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/payment.py 
78
79
80
81
82
83
84
85
86
87
88
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

    return False

InvoiceView

Bases: ViewDispatcher

reviewer_view class-attribute instance-attribute 

reviewer_view = None

partner_view class-attribute instance-attribute 

partner_view = None

community_view class-attribute instance-attribute 

community_view = None

contracting_view class-attribute instance-attribute 

contracting_view = None

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

admin_check 

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

reviewer_check 

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

partner_check 

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

community_check 

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

finance_check 

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

contracting_check 

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

applicant_check 

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

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/utils/views.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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.partner_check(request):
        view = self.partner_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: CreateView

model class-attribute instance-attribute 

model = Invoice

form_class class-attribute instance-attribute 

form_class = CreateInvoiceForm

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
253
254
255
256
257
def dispatch(self, request, *args, **kwargs):
    self.project = Project.objects.get(pk=kwargs["pk"])
    if not request.user.is_apply_staff and not self.project.user == request.user:
        return redirect(self.project)
    return super().dispatch(request, *args, **kwargs)

buttons 

buttons()
Source code in hypha/apply/projects/views/payment.py 
259
260
def buttons(self):
    yield ("submit", "primary", _("Save"))

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/projects/views/payment.py 
262
263
264
265
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/payment.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
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 len(self.project.invoices.all()) == 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,
    )

    messages.success(
        self.request, _("Invoice added"), extra_tags=PROJECT_ACTION_MESSAGE_TAG
    )

    # 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

model class-attribute instance-attribute 

model = Invoice

form_class class-attribute instance-attribute 

form_class = EditInvoiceForm

get_object 

get_object()
Source code in hypha/apply/projects/views/payment.py 
74
75
76
def get_object(self):
    project = get_object_or_404(Project, pk=self.kwargs["pk"])
    return get_object_or_404(project.invoices.all(), pk=self.kwargs["invoice_pk"])

test_func 

test_func()
Source code in hypha/apply/projects/views/payment.py 
78
79
80
81
82
83
84
85
86
87
88
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

    return False

dispatch 

dispatch(request, *args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
326
327
328
329
330
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/payment.py 
332
333
334
335
def buttons(self):
    yield ("submit", "primary", _("Save"))
    if self.object.can_user_delete(self.request.user):
        yield ("delete", "warning", _("Delete"))

get_initial 

get_initial()
Source code in hypha/apply/projects/views/payment.py 
337
338
339
340
341
342
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/payment.py 
344
345
346
347
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/payment.py 
349
350
351
352
353
354
355
356
357
358
359
360
361
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.project.id,
            invoice_pk=self.object.id,
        )
    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/payment.py 
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
def form_valid(self, form):
    old_status = self.object.status
    response = super().form_valid(form)

    if form.cleaned_data:
        if self.object.status in INVOICE_TRANISTION_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

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

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

    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

InvoicePrivateMedia

Bases: UserPassesTestMixin, PrivateMediaView

storage class-attribute instance-attribute 

storage = PrivateStorage()

raise_exception class-attribute instance-attribute 

raise_exception = True

get 

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

dispatch 

dispatch(*args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
439
440
441
442
443
444
445
def dispatch(self, *args, **kwargs):
    invoice_pk = self.kwargs["invoice_pk"]
    project_pk = self.kwargs["pk"]
    self.project = get_object_or_404(Project, pk=project_pk)
    self.invoice = get_object_or_404(self.project.invoices.all(), pk=invoice_pk)

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

get_media 

get_media(*args, **kwargs)
Source code in hypha/apply/projects/views/payment.py 
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
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 == APPROVED_BY_STAFF
        and self.invoice.document.file.name.endswith(".pdf")
    ):
        if activities := Activity.actions.filter(
            related_content_type__model="invoice",
            related_object_id=self.invoice.id,
            message__icontains="Approved by",
        ).visible_to(self.request.user):
            approval_pdf_page = html_to_pdf(
                render_to_string(
                    "application_projects/pdf_invoce_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/payment.py 
478
479
480
481
482
483
484
485
486
487
488
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

    return False

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'

setup 

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

Source code in hypha/apply/utils/views.py 
148
149
150
151
152
def setup(self, request, *args, **kwargs):
    """Initialize attributes shared by all view methods."""
    self.request = request
    self.args = args
    self.kwargs = kwargs

get_object 

get_object()
Source code in hypha/apply/utils/views.py 
154
155
156
157
158
159
160
161
162
163
164
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 
166
167
def get_template_names(self):
    return self.kwargs["template_names"]

get_form_name 

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

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
172
173
174
175
176
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 
178
179
180
181
182
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 
184
185
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 
187
188
189
190
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 
192
193
194
195
196
197
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 
199
200
201
@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 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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 
219
220
221
222
223
def get_success_url(self):
    query = self.request.GET.urlencode()
    if query:
        query = "?" + query
    return self.request.path + query

form_valid 

form_valid(form)
Source code in hypha/apply/projects/views/payment.py 
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
def form_valid(self, form):
    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 super().form_valid(form)

form_invalid 

form_invalid(form)
Source code in hypha/apply/projects/views/payment.py 
523
524
525
526
527
528
def form_invalid(self, form):
    messages.error(
        self.request,
        mark_safe(_("Sorry something went wrong") + form.errors.as_ul()),
    )
    return super().form_invalid(form)

InvoiceListView 

InvoiceListView(*args, **kwargs)

Bases: SingleTableMixin, FilterView, DelegateableListView

Source code in hypha/apply/utils/views.py 
82
83
84
85
86
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_prefix class-attribute instance-attribute 

form_prefix = 'form-submitted-'

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'

get_form_kwargs 

get_form_kwargs()
Source code in hypha/apply/utils/views.py 
134
135
136
137
def get_form_kwargs(self):
    return {
        "user": self.request.user,
    }

get_context_data 

get_context_data(**kwargs)
Source code in hypha/apply/utils/views.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
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 
139
140
141
def post(self, request, *args, **kwargs):
    self.object_list = self.get_queryset()
    return super().post(request, *args, **kwargs)

get_table_class 

get_table_class()
Source code in hypha/apply/projects/views/payment.py 
541
542
543
544
def get_table_class(self):
    if self.request.user.is_finance:
        return FinanceInvoiceTable
    return super().get_table_class()