source: pvrrd/src/pvrrd/xmlSupport.py @ 619

#!/usr/bin/env python

'''
 read XML configuration files into a common data structure
'''

########### SVN repository information ###################
# $Date: 2011-08-21 13:24:14 +0000 (Sun, 21 Aug 2011) $
# $Author: jemian $
# $Revision: 619 $
# $HeadURL$
# $Id: xmlSupport.py 619 2011-08-21 13:24:14Z jemian $
########### SVN repository information ###################

import sys
try:
    # this is the normal Python path
    from xml.etree import ElementTree
    #from xml.etree import ElementPath
except:
    # this works on ipnspool3.xor.aps.anl.gov
    from elementtree import ElementTree
import os.path

PVLIST_XML = 'pvlist.xml'
PROPERTIES_XML = 'properties.xml'

#**************************************************************************

def readPropertiesXML(xmlFile):
    tree = ElementTree.parse(xmlFile)
    root = tree.getroot()
    props = {}

    #-------- simple things
    for key in ('title', 'www_plot_dir', 'rrd_logs_base_dir'):
        props[key] = root.find(key).text.strip()

    #-------- time-spans for the RRD file design
    arr = {}
    arr['names'] = []
    spans = root.find("spans")
    for element in root.findall('spans//span'):
        dct = {}
        for attribute in element.keys():
            dct[attribute] = element.get(attribute).strip()
        name = dct['name']
        dct['value'] = element.text.strip()
        arr[name] = dct
        arr['names'].append(name)
    for attribute in spans.keys():
        arr[attribute] = spans.get(attribute).strip()
    props['spans'] = arr

    #-------- various subdirectories
    arr = {}
    for element in root.findall('subdirs//subdir'):
        name =  element.get('name').strip()
        arr[name] = element.text.strip()
    props['subdirs'] = arr

    #-------- definitions for constructing the RRD files
    arr = {}
    for element in root.findall('rrd/*'):
        arr[element.tag] = element.text.strip()
    props['rrd'] = arr
    return(props)

#**************************************************************************

def readPvlistXML(xmlFile):
    tree = ElementTree.parse(xmlFile)
    root = tree.getroot()
    db = []
    for element in root.findall('EPICS_PV'):
        pv = element.get('pv').strip()
        arr = {}
        arr['desc'] = element.text.strip()
        for attribute in element.keys():
            arr[attribute] = element.get(attribute).strip()
        # make PV names into file names, replace ":" with "-"
        arr['fileRoot'] = pv.replace  (':', '-')
        db.append(arr)
    return(db)

#**************************************************************************

def readConfigurationXML(baseDir):
    config = {}

    propertiesFile = os.path.join(baseDir, PROPERTIES_XML)
    config['properties'] = readPropertiesXML(propertiesFile)

    pvListFile = os.path.join(baseDir, PVLIST_XML)
    config['pvList'] = readPvlistXML(pvListFile)

    return(config)

#**************************************************************************

def __someTest__(xmlFile):
    tree = ElementTree.parse(xmlFile)
    for key in tree.findall("/*"):
        ElementTree.dump(key)


#**************************************************************************

if __name__ == "__main__":
    if (len(sys.argv) == 2):
        pwd = sys.argv[1]
    else:
        pwd = '.'
    config = readConfigurationXML(pwd)
    #print(config['properties']['rrd'])
    print(config['properties']['spans'])
    #__someTest__(PROPERTIES_XML)