nk20/apps/treasury/forms.py

181 lines
5.7 KiB
Python
Raw Normal View History

# Copyright (C) 2018-2021 by BDE ENS Paris-Saclay
2020-03-21 15:49:18 +00:00
# SPDX-License-Identifier: GPL-3.0-or-later
from crispy_forms.helper import FormHelper
2020-03-22 17:27:22 +00:00
from crispy_forms.layout import Submit
2020-03-21 15:49:18 +00:00
from django import forms
from django.contrib.auth.models import User
2020-09-11 20:52:16 +00:00
from django.db import transaction
2020-03-22 17:27:22 +00:00
from django.utils.translation import gettext_lazy as _
from note_kfet.inputs import AmountInput, Autocomplete
2020-03-21 15:49:18 +00:00
from .models import Invoice, Product, Remittance, SpecialTransactionProxy, SogeCredit
2020-03-21 15:49:18 +00:00
2020-03-22 00:22:27 +00:00
class InvoiceForm(forms.ModelForm):
2020-03-24 19:22:15 +00:00
"""
Create and generate invoices.
"""
2020-08-07 09:04:54 +00:00
def clean(self):
2020-09-04 13:53:00 +00:00
# If the invoice is locked, it can't be updated.
2020-08-07 09:04:54 +00:00
if self.instance and self.instance.locked:
for field_name in self.fields:
self.cleaned_data[field_name] = getattr(self.instance, field_name)
self.errors.clear()
2020-09-04 13:53:00 +00:00
self.add_error(None, _('This invoice is locked and can no longer be edited.'))
2020-08-07 09:04:54 +00:00
return self.cleaned_data
return super().clean()
2020-03-21 15:49:18 +00:00
class Meta:
2020-03-22 00:22:27 +00:00
model = Invoice
2020-08-07 09:04:54 +00:00
exclude = ('bde', 'date', 'tex', )
2020-03-21 15:49:18 +00:00
class ProductForm(forms.ModelForm):
class Meta:
model = Product
fields = '__all__'
widgets = {
2020-08-05 16:04:01 +00:00
"amount": AmountInput(
attrs={
"negative": True,
}
)
}
2020-03-24 19:22:15 +00:00
# Add a subform per product in the invoice form, and manage correctly the link between the invoice and
# its products. The FormSet will search automatically the ForeignKey in the Product model.
2020-03-21 15:49:18 +00:00
ProductFormSet = forms.inlineformset_factory(
2020-03-22 00:22:27 +00:00
Invoice,
2020-03-21 15:49:18 +00:00
Product,
form=ProductForm,
2020-03-21 15:49:18 +00:00
extra=1,
)
2020-03-21 16:29:39 +00:00
2020-03-21 15:49:18 +00:00
class ProductFormSetHelper(FormHelper):
2020-03-24 19:22:15 +00:00
"""
Specify some template information for the product form.
2020-03-24 19:22:15 +00:00
"""
2020-03-21 15:49:18 +00:00
def __init__(self, form=None):
super().__init__(form)
self.form_tag = False
self.form_method = 'POST'
self.form_class = 'form-inline'
2020-03-21 16:29:39 +00:00
self.template = 'bootstrap4/table_inline_formset.html'
2020-03-22 17:27:22 +00:00
class RemittanceForm(forms.ModelForm):
2020-03-24 19:22:15 +00:00
"""
Create remittances.
"""
2020-03-22 17:27:22 +00:00
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
2020-03-23 23:50:55 +00:00
2020-03-22 17:27:22 +00:00
self.helper = FormHelper()
2020-03-23 23:50:55 +00:00
2020-03-24 19:22:15 +00:00
# We can't update the type of the remittance once created.
2020-03-23 23:50:55 +00:00
if self.instance.pk:
2020-03-24 16:06:50 +00:00
self.fields["remittance_type"].disabled = True
self.fields["remittance_type"].required = False
2020-03-23 23:50:55 +00:00
2020-03-24 19:22:15 +00:00
# We display the submit button iff the remittance is open,
# the close button iff it is open and has a linked transaction
2020-03-23 23:50:55 +00:00
if not self.instance.closed:
self.helper.add_input(Submit('submit', _("Submit"), attr={'class': 'btn btn-block btn-primary'}))
if self.instance.transactions:
self.helper.add_input(Submit("close", _("Close"), css_class='btn btn-success'))
else:
2020-03-24 19:22:15 +00:00
# If the remittance is closed, we can't change anything
2020-03-23 23:50:55 +00:00
self.fields["comment"].disabled = True
self.fields["comment"].required = False
def clean(self):
2020-03-24 19:22:15 +00:00
# We can't update anything if the remittance is already closed.
2020-03-23 23:50:55 +00:00
if self.instance.closed:
self.add_error("comment", _("Remittance is already closed."))
cleaned_data = super().clean()
2020-03-24 16:06:50 +00:00
if self.instance.pk and cleaned_data.get("remittance_type") != self.instance.remittance_type:
self.add_error("remittance_type", _("You can't change the type of the remittance."))
2020-03-23 23:50:55 +00:00
2020-03-24 19:22:15 +00:00
# The close button is manually handled
2020-03-23 23:50:55 +00:00
if "close" in self.data:
self.instance.closed = True
self.cleaned_data["closed"] = True
return cleaned_data
2020-03-22 17:27:22 +00:00
class Meta:
model = Remittance
2020-03-24 16:06:50 +00:00
fields = ('remittance_type', 'comment',)
2020-03-23 22:42:37 +00:00
class LinkTransactionToRemittanceForm(forms.ModelForm):
2020-03-24 19:22:15 +00:00
"""
Attach a special transaction to a remittance.
"""
2020-08-05 16:04:01 +00:00
remittance = forms.ModelChoiceField(
queryset=Remittance.objects.none(),
label=_("Remittance"),
empty_label=_("No attached remittance"),
required=False,
)
2020-03-24 19:22:15 +00:00
# Since we use a proxy model for special transactions, we add manually the fields related to the transaction
2020-03-23 22:42:37 +00:00
last_name = forms.CharField(label=_("Last name"))
first_name = forms.Field(label=_("First name"))
bank = forms.Field(label=_("Bank"))
2020-08-05 16:04:01 +00:00
amount = forms.IntegerField(label=_("Amount"), min_value=0, widget=AmountInput(), disabled=True, required=False)
2020-03-23 22:42:37 +00:00
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.helper = FormHelper()
2020-03-24 19:22:15 +00:00
# Add submit button
2020-03-23 22:42:37 +00:00
self.helper.add_input(Submit('submit', _("Submit"), attr={'class': 'btn btn-block btn-primary'}))
2020-07-25 15:25:57 +00:00
self.fields["remittance"].queryset = Remittance.objects.filter(closed=False)
2020-08-05 16:04:01 +00:00
def clean(self):
cleaned_data = super().clean()
self.instance.transaction.last_name = cleaned_data["last_name"]
self.instance.transaction.first_name = cleaned_data["first_name"]
self.instance.transaction.bank = cleaned_data["bank"]
return cleaned_data
2020-03-23 22:42:37 +00:00
2020-09-11 20:52:16 +00:00
@transaction.atomic
2020-08-05 16:04:01 +00:00
def save(self, commit=True):
2020-03-24 19:22:15 +00:00
"""
2020-08-05 16:04:01 +00:00
Save the transaction and the remittance.
2020-03-24 19:22:15 +00:00
"""
2020-08-05 16:04:01 +00:00
self.instance.transaction.save()
return super().save(commit)
2020-03-23 22:42:37 +00:00
class Meta:
model = SpecialTransactionProxy
fields = ('remittance', )
class SogeCreditForm(forms.ModelForm):
class Meta:
model = SogeCredit
fields = ('user', )
widgets = {
"user": Autocomplete(
User,
attrs={
'api_url': '/api/user/',
'name_field': 'username',
'placeholder': 'Nom…',
},
),
}