config.py 4.65 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
"""
    Copyright (c) 2015 Ad Schellevis
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    --------------------------------------------------------------------------------------
27

28
    package : configd
29 30 31 32 33 34 35 36 37 38 39 40
    function: config handler
"""
__author__ = 'Ad Schellevis'

import os
import stat
import collections
import copy
import xml.etree.cElementTree as ElementTree


class Config(object):
Ad Schellevis's avatar
Ad Schellevis committed
41
    def __init__(self, filename):
42
        self._config_data = {}
43
        self._filename = filename
44 45 46 47 48
        self._file_mod = 0

        self._load()

    def _load(self):
49
        """ load config ( if timestamp is changed ), stores all found uuids into an item __uuid__ at the config root
50 51 52 53 54 55 56

        :return:
        """
        mod_time = os.stat(self._filename)[stat.ST_MTIME]
        if self._file_mod != mod_time:
            xml_node = ElementTree.parse(self._filename)
            root = xml_node.getroot()
57 58 59
            # initialize uuid containers, holds references to all uuid tagged items and names in the xml
            self.__uuid_data = {}
            self.__uuid_tags = {}
60
            self._config_data = self._traverse(root)
61 62
            self._config_data['__uuid__'] = self.__uuid_data
            self._config_data['__uuid_tags__'] = self.__uuid_tags
63 64
            self._file_mod = mod_time

Ad Schellevis's avatar
Ad Schellevis committed
65
    def _traverse(self, xmlNode):
66 67 68 69 70
        """ traverse xml node and return ordered dictionary structure
        :param xmlNode: ElementTree node
        :return: collections.OrderedDict
        """
        this_item = collections.OrderedDict()
Ad Schellevis's avatar
Ad Schellevis committed
71
        if len(list(xmlNode)) > 0:
72 73
            for item in list(xmlNode):
                item_content = self._traverse(item)
74 75 76
                if 'uuid' in item.attrib:
                    self.__uuid_data[item.attrib['uuid']] = item_content
                    self.__uuid_tags[item.attrib['uuid']] = item.tag
Ad Schellevis's avatar
Ad Schellevis committed
77
                if item.tag in this_item:
78 79 80 81 82
                    if type(this_item[item.tag]) != list:
                        tmp_item = copy.deepcopy(this_item[item.tag])
                        this_item[item.tag] = []
                        this_item[item.tag].append(tmp_item)

Ad Schellevis's avatar
Ad Schellevis committed
83
                    if item_content is not None:
84 85
                        # skip empty fields
                        this_item[item.tag].append(item_content)
Ad Schellevis's avatar
Ad Schellevis committed
86
                elif item_content is not None:
87 88 89 90 91 92 93 94
                    # create a new named item
                    this_item[item.tag] = self._traverse(item)
        else:
            # last node, return text
            return xmlNode.text

        return this_item

Ad Schellevis's avatar
Ad Schellevis committed
95
    def indent(self, elem, level=0):
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
        """ indent cElementTree (prettyprint fix)
            used from : http://infix.se/2007/02/06/gentlemen-indent-your-xml
            @param elem: cElementTree
            @param level: Currentlevel
        """
        i = "\n" + level*"  "
        if len(elem):
            if not elem.text or not elem.text.strip():
                elem.text = i + "  "
            for e in elem:
                self.indent(e, level+1)
                if not e.tail or not e.tail.strip():
                    e.tail = i + "  "
            if not e.tail or not e.tail.strip():
                e.tail = i
        else:
            if level and (not elem.tail or not elem.tail.strip()):
                elem.tail = i

    def get(self):
        """ get active config data, load from disc if file in memory is different

        :return: dictionary
        """
        # refresh config if source xml is changed
        self._load()

123
        return self._config_data