mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-29 20:16:44 +00:00
153 lines
5.1 KiB
Python
153 lines
5.1 KiB
Python
"""
|
|
Common database model definitions.
|
|
These models are 'generic' and do not fit a particular business logic object.
|
|
"""
|
|
|
|
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
from django.db import models
|
|
from django.utils.translation import ugettext as _
|
|
from django.core.validators import MinValueValidator, MaxValueValidator
|
|
from django.core.exceptions import ValidationError
|
|
|
|
|
|
class InvenTreeSetting(models.Model):
|
|
"""
|
|
An InvenTreeSetting object is a key:value pair used for storing
|
|
single values (e.g. one-off settings values).
|
|
|
|
The class provides a way of retrieving the value for a particular key,
|
|
even if that key does not exist.
|
|
"""
|
|
|
|
@classmethod
|
|
def get_setting(cls, key, backup_value=None):
|
|
"""
|
|
Get the value of a particular setting.
|
|
If it does not exist, return the backup value (default = None)
|
|
"""
|
|
|
|
try:
|
|
setting = InvenTreeSetting.objects.get(key__iexact=key)
|
|
return setting.value
|
|
except InvenTreeSetting.DoesNotExist:
|
|
return backup_value
|
|
|
|
@classmethod
|
|
def set_setting(cls, key, value, user, create=True):
|
|
"""
|
|
Set the value of a particular setting.
|
|
If it does not exist, option to create it.
|
|
|
|
Args:
|
|
key: settings key
|
|
value: New value
|
|
user: User object (must be staff member to update a core setting)
|
|
create: If True, create a new setting if the specified key does not exist.
|
|
"""
|
|
|
|
if not user.is_staff:
|
|
return
|
|
|
|
try:
|
|
setting = InvenTreeSetting.objects.get(key__iexact=key)
|
|
except InvenTreeSetting.DoesNotExist:
|
|
|
|
if create:
|
|
setting = InvenTreeSetting(key=key)
|
|
else:
|
|
return
|
|
|
|
setting.value = value
|
|
setting.save()
|
|
|
|
key = models.CharField(max_length=50, blank=False, unique=True, help_text=_('Settings key (must be unique - case insensitive'))
|
|
|
|
value = models.CharField(max_length=200, blank=True, unique=False, help_text=_('Settings value'))
|
|
|
|
description = models.CharField(max_length=200, blank=True, unique=False, help_text=_('Settings description'))
|
|
|
|
def validate_unique(self, exclude=None):
|
|
""" Ensure that the key:value pair is unique.
|
|
In addition to the base validators, this ensures that the 'key'
|
|
is unique, using a case-insensitive comparison.
|
|
"""
|
|
|
|
super().validate_unique(exclude)
|
|
|
|
try:
|
|
setting = InvenTreeSetting.objects.exclude(id=self.id).filter(key__iexact=self.key)
|
|
if setting.exists():
|
|
raise ValidationError({'key': _('Key string must be unique')})
|
|
except InvenTreeSetting.DoesNotExist:
|
|
pass
|
|
|
|
|
|
class Currency(models.Model):
|
|
"""
|
|
A Currency object represents a particular unit of currency.
|
|
Each Currency has a scaling factor which relates it to the base currency.
|
|
There must be one (and only one) currency which is selected as the base currency,
|
|
and each other currency is calculated relative to it.
|
|
|
|
Attributes:
|
|
symbol: Currency symbol e.g. $
|
|
suffix: Currency suffix e.g. AUD
|
|
description: Long-form description e.g. "Australian Dollars"
|
|
value: The value of this currency compared to the base currency.
|
|
base: True if this currency is the base currency
|
|
|
|
"""
|
|
|
|
symbol = models.CharField(max_length=10, blank=False, unique=False, help_text=_('Currency Symbol e.g. $'))
|
|
|
|
suffix = models.CharField(max_length=10, blank=False, unique=True, help_text=_('Currency Suffix e.g. AUD'))
|
|
|
|
description = models.CharField(max_length=100, blank=False, help_text=_('Currency Description'))
|
|
|
|
value = models.DecimalField(default=1.0, max_digits=10, decimal_places=5, validators=[MinValueValidator(0.00001), MaxValueValidator(100000)], help_text=_('Currency Value'))
|
|
|
|
base = models.BooleanField(default=False, help_text=_('Use this currency as the base currency'))
|
|
|
|
class Meta:
|
|
verbose_name_plural = 'Currencies'
|
|
|
|
def __str__(self):
|
|
""" Format string for currency representation """
|
|
s = "{sym} {suf} - {desc}".format(
|
|
sym=self.symbol,
|
|
suf=self.suffix,
|
|
desc=self.description
|
|
)
|
|
|
|
if self.base:
|
|
s += " (Base)"
|
|
|
|
else:
|
|
s += " = {v}".format(v=self.value)
|
|
|
|
return s
|
|
|
|
def save(self, *args, **kwargs):
|
|
""" Validate the model before saving
|
|
|
|
- Ensure that there is only one base currency!
|
|
"""
|
|
|
|
# If this currency is set as the base currency, ensure no others are
|
|
if self.base:
|
|
for cur in Currency.objects.filter(base=True).exclude(pk=self.pk):
|
|
cur.base = False
|
|
cur.save()
|
|
|
|
# If there are no currencies set as the base currency, set this as base
|
|
if not Currency.objects.exclude(pk=self.pk).filter(base=True).exists():
|
|
self.base = True
|
|
|
|
# If this is the base currency, ensure value is set to unity
|
|
if self.base:
|
|
self.value = 1.0
|
|
|
|
super().save(*args, **kwargs)
|