From f1e8afa314584cadc4c5128f12e904e2b66e00dc Mon Sep 17 00:00:00 2001
From: Oliver Walters <oliver.henry.walters@gmail.com>
Date: Sun, 25 Oct 2020 09:36:58 +1100
Subject: [PATCH] Add boolean validator

---
 InvenTree/InvenTree/helpers.py | 13 +++++++
 InvenTree/common/models.py     | 63 ++++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+)

diff --git a/InvenTree/InvenTree/helpers.py b/InvenTree/InvenTree/helpers.py
index da96c7ee79..921a45c112 100644
--- a/InvenTree/InvenTree/helpers.py
+++ b/InvenTree/InvenTree/helpers.py
@@ -120,6 +120,19 @@ def str2bool(text, test=True):
         return str(text).lower() in ['0', 'n', 'no', 'none', 'f', 'false', 'off', ]
 
 
+def is_bool(text):
+    """
+    Determine if a string value 'looks' like a boolean.
+    """
+
+    if str2bool(text, True):
+        return True
+    elif str2bool(text, False):
+        return True
+    else:
+        return False
+
+
 def isNull(text):
     """
     Test if a string 'looks' like a null value.
diff --git a/InvenTree/common/models.py b/InvenTree/common/models.py
index 76320edd98..65d8aa7c2e 100644
--- a/InvenTree/common/models.py
+++ b/InvenTree/common/models.py
@@ -15,6 +15,7 @@ from django.utils.translation import ugettext as _
 from django.core.validators import MinValueValidator, MaxValueValidator
 from django.core.exceptions import ValidationError
 
+import InvenTree.helpers
 import InvenTree.fields
 
 
@@ -66,18 +67,21 @@ class InvenTreeSetting(models.Model):
             'name': _('Copy Part BOM Data'),
             'description': _('Copy BOM data by default when duplicating a part'),
             'default': True,
+            'validator': bool,
         },
 
         'PART_COPY_PARAMETERS': {
             'name': _('Copy Part Parameter Data'),
             'description': _('Copy parameter data by default when duplicating a part'),
             'default': True,
+            'validator': bool,
         },
 
         'PART_COPY_TESTS': {
             'name': _('Copy Part Test Data'),
             'description': _('Copy test data by default when duplicating a part'),
             'default': True,
+            'validator': bool
         },
 
         'BUILDORDER_REFERENCE_PREFIX': {
@@ -154,6 +158,22 @@ class InvenTreeSetting(models.Model):
         else:
             return ''
 
+    @classmethod
+    def get_setting_validator(cls, key):
+        """
+        Return the validator for a particular setting.
+
+        If it does not exist, return None
+        """
+
+        key = str(key).strip().upper()
+
+        if key in cls.GLOBAL_SETTINGS:
+            setting = cls.GLOBAL_SETTINGS[key]
+            return setting.get('validator', None)
+        else:
+            return None
+
     @classmethod
     def get_default_value(cls, key):
         """
@@ -239,6 +259,49 @@ class InvenTreeSetting(models.Model):
 
     value = models.CharField(max_length=200, blank=True, unique=False, help_text=_('Settings value'))
 
+    def clean(self):
+        """
+        If a validator (or multiple validators) are defined for a particular setting key,
+        run them against the 'value' field.
+        """
+
+        super().clean()
+
+        validator = InvenTreeSetting.get_setting_validator(self.key)
+
+        if validator is not None:
+            self.run_validator(validator)
+
+    def run_validator(self, validator):
+        """
+        Run a validator against the 'value' field for this InvenTreeSetting object.
+        """
+
+        if validator is None:
+            return
+
+        # If a list of validators is supplied, iterate through each one
+        if type(validator) in [list, tuple]:
+            for v in validator:
+                self.run_validator(v)
+            
+            return
+
+        print("Running validator:", validator, self.key, self.value)
+
+        # Check if a 'type' has been specified for this value
+        if type(validator) == type:
+            if validator == bool:
+                if InvenTree.helpers.is_bool(self.value):
+                    # Coerce into either "True" or "False"
+                    self.value = str(InvenTree.helpers.str2bool(self.value))
+                else:
+                    raise ValidationError({
+                        'value': _('Value must be a boolean value')
+                    })
+
+
+
     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'