Add config utilities to represent data types

This will be used to properly format data in configuration UIs, and
to properly import/export data from/to th database for internal use.

Signed-off-by: Simo Sorce <simo@redhat.com>
Reviewed-by: Patrick Uiterwijk <puiterwijk@redhat.com>

1 files changed, 297 insertions, 0 deletions

diff --git a/ipsilon/util/config.py b/ipsilon/util/config.py
new file mode 100755
index 0000000..304c630
--- /dev/null
+++ b/ipsilon/util/config.py
@@ -0,0 +1,297 @@
+#!/usr/bin/python
+#
+# Copyright (C) 2014  Ipsilon project Contributors, for licensee see COPYING
+
+from ipsilon.util.log import Log
+
+
+class Config(Log):
+
+    def __init__(self, name, *args):
+        self.name = name
+        self._list = list()
+        self._dict = dict()
+        for item in args:
+            if not isinstance(item, Option):
+                raise ValueError('Invalid option type for %s' % repr(item))
+            self._list.append(item.name)
+            self._dict[item.name] = item
+        self.debug('Config(%s) %s' % (self.name, self._dict))
+
+    def __repr__(self):
+        return '%s: %s' % (self.__class__, ', '.join(self._list))
+
+    def __str__(self):
+        return str(self._list)
+
+    def __len__(self):
+        return len(self._list)
+
+    def __getitem__(self, key):
+        return self._dict[key]
+
+    def __setitem__(self, key, value):
+        if not isinstance(value, Option):
+            raise ValueError('Invalid type for %s' % value)
+        if key != value.name:
+            raise NameError('Name mismatch, key=%s but value.name=%s' % (
+                key, value.name))
+        if key not in self._list:
+            self._list.append(key)
+        self._dict[key] = value
+
+    def __delitem__(self, key):
+        self._list.remove(key)
+        del self._dict[key]
+
+    def __iter__(self):
+        i = 0
+        while i < len(self._list):
+            yield self._list[i]
+            i += 1
+
+    def __reversed__(self):
+        i = len(self._list)
+        while i > 0:
+            yield self._list[i - 1]
+            i -= 1
+
+    def __contains__(self, item):
+        return (item in self._dict)
+
+    def iteritems(self):
+        i = 0
+        while i < len(self._list):
+            yield (self._list[i], self._dict[self._list[i]])
+            i += 1
+
+    def items(self):
+        return [(k, self._dict[k]) for k in self._list]
+
+
+class Option(Log):
+
+    def __init__(self, name, description):
+        self.name = name
+        self.description = description
+        self._default_value = None
+        self._assigned_value = None
+
+    def __repr__(self):
+        return "%s: %s {%s}, value = %s [def: %s]" % (self.__class__,
+                                                      self.name,
+                                                      self.description,
+                                                      self._assigned_value,
+                                                      self._default_value)
+
+    def __str__(self):
+        return '%s=%s' % (self.name, self.get_value())
+
+    def get_value(self, default=True):
+        if self._assigned_value is not None:
+            return self._assigned_value
+        elif default is True:
+            return self._default_value
+        else:
+            return None
+
+    def set_value(self, value):
+        self._assigned_value = value
+
+    def export_value(self):
+        raise NotImplementedError
+
+    def import_value(self, value):
+        raise NotImplementedError
+
+    def _str_export_value(self):
+        if self._assigned_value:
+            return str(self._assigned_value)
+        return None
+
+    def _str_import_value(self, value):
+        if type(value) is not str:
+            raise ValueError('Value must be string')
+        self._assigned_value = value
+
+
+class String(Option):
+
+    def __init__(self, name, description, default_value=None):
+        super(String, self).__init__(name, description)
+        self._default_value = str(default_value)
+
+    def set_value(self, value):
+        self._assigned_value = str(value)
+
+    def export_value(self):
+        return self._str_export_value()
+
+    def import_value(self, value):
+        self._str_import_value(value)
+
+
+class Template(Option):
+
+    def __init__(self, name, description, default_template=None):
+        super(Template, self).__init__(name, description)
+        self._default_value = str(default_template)
+
+    def set_value(self, value):
+        self._assigned_value = str(value)
+
+    def templatize(self, args):
+        if not args:
+            raise ValueError('Templatized called w/o arguments')
+
+        return self.get_value() % args
+
+    def export_value(self):
+        return self._str_export_value()
+
+    def import_value(self, value):
+        self._str_import_value(value)
+
+
+class List(Option):
+
+    def __init__(self, name, description, default_list=None):
+        super(List, self).__init__(name, description)
+        if default_list:
+            self._default_value = list(default_list)
+
+    def set_value(self, value):
+        self._assigned_value = list(value)
+
+    def export_value(self):
+        if self._assigned_value:
+            return ', '.join(self._assigned_value)
+        return None
+
+    def import_value(self, value):
+        if type(value) is not str:
+            raise ValueError('Value (type: %s) must be string' % type(value))
+        self._assigned_value = [x.strip() for x in value.split(',')]
+
+
+class Choice(Option):
+
+    def __init__(self, name, description, allowed=None, default=None):
+        super(Choice, self).__init__(name, description)
+        if allowed:
+            self._allowed_values = list(allowed)
+        else:
+            self._allowed_values = list()
+        self._default_value = list()
+        if default is None:
+            default = []
+        for name in default:
+            if name not in self._allowed_values:
+                raise ValueError(
+                    'item [%s] is not in allowed [%s]' % (name, allowed))
+            self._default_value.append(name)
+
+    def __repr__(self):
+        return "%s: %s {%s}, values = %s d:%s ok:%s" % (self.__class__,
+                                                        self.name,
+                                                        self.description,
+                                                        self._assigned_value,
+                                                        self._default_value,
+                                                        self._allowed_values)
+
+    def __str__(self):
+        return '%s=%s' % (self.name, self.get_value())
+
+    def set_value(self, value):
+        if type(value) is not list:
+            value = [value]
+        for val in value:
+            if type(val) is not tuple:
+                val = (val, True)
+            if val[0] not in self._allowed_values:
+                raise ValueError(
+                    'Value "%s" not allowed [%s]' % (val[0],
+                                                     self._allowed_values))
+            if val[1] is True:
+                if val[0] not in self._assigned_value:
+                    self._assigned_value.append(val[0])
+            else:
+                if val[0] in self._assigned_value:
+                    self._assigned_value.remove(val[0])
+
+    def unset_value(self, value):
+        if type(value) is str:
+            value = [value]
+        unset = list()
+        for val in value:
+            unset.append((val, False))
+        self.set_value(unset)
+
+    def get_allowed(self):
+        return self._allowed_values
+
+    def export_value(self):
+        enabled = self.get_value()
+        return ', '.join(enabled)
+
+    def import_value(self, value):
+        enabled = [x.strip() for x in value.split(',')]
+        for val in enabled:
+            if val not in self._allowed_values:
+                # We silently ignore invalid options on import for now
+                continue
+            self._assigned_value[val] = True
+
+
+class Pick(Option):
+
+    def __init__(self, name, description, allowed, default_value):
+        super(Pick, self).__init__(name, description)
+        self._allowed_values = list(allowed)
+        if default_value not in self._allowed_values:
+            raise ValueError('The default value is not in the allowed list')
+        self._default_value = default_value
+
+    def set_value(self, value):
+        if value not in self._allowed_values:
+            raise ValueError(
+                'Value "%s" not allowed [%s]' % (value, self._allowed_values))
+        self._assigned_value = value
+
+    def get_allowed(self):
+        return self._allowed_values
+
+    def export_value(self):
+        return self._str_export_value()
+
+    def import_value(self, value):
+        self._str_import_value(value)
+
+
+class Condition(Option):
+
+    def __init__(self, name, description, default_value=False):
+        super(Condition, self).__init__(name, description)
+        self._default_value = default_value
+
+    def set_value(self, value):
+        if value is True:
+            self._assigned_value = True
+        elif value is False:
+            self._assigned_value = False
+        else:
+            raise ValueError('Value must be True or False, got %s' % value)
+
+    def export_value(self):
+        if self._assigned_value is True:
+            return '1'
+        elif self._assigned_value is False:
+            return '0'
+        else:
+            return None
+
+    def import_value(self, value):
+        if value in ['1', 'YES']:
+            self._assigned_value = True
+        else:
+            self._assigned_value = False