sfa/rspecs/rspec.py

   1 #!/usr/bin/python
   2
   3 from __future__ import print_function
   4
   5 from datetime import datetime, timedelta
   6
   7 from sfa.util.xml import XML, XpathFilter
   8 from sfa.util.faults import InvalidRSpecElement, InvalidRSpec
   9 from sfa.util.sfatime import SFATIME_FORMAT
  10
  11 from sfa.rspecs.rspec_elements import RSpecElement, RSpecElements
  12 from sfa.rspecs.version_manager import VersionManager
  13
  14 class RSpec:
  15
  16     def __init__(self, rspec="", version=None, user_options=None, ttl=None, expires=None):
  17         if user_options is None: user_options={}
  18         self.header = '<?xml version="1.0"?>\n'
  19         self.template = """<RSpec></RSpec>"""
  20         self.version = None
  21         self.xml = XML()
  22         self.version_manager = VersionManager()
  23         self.user_options = user_options
  24         self.ttl = ttl
  25         self.expires = expires
  26         self.elements = {}
  27         if rspec:
  28             if version:
  29                 self.version = self.version_manager.get_version(version)
  30                 self.parse_xml(rspec, version)
  31             else:
  32                 self.parse_xml(rspec)
  33         elif version:
  34             self.create(version, ttl, expires)
  35         else:
  36             raise InvalidRSpec("No RSpec or version specified. Must specify a valid rspec string or a valid version")
  37
  38     def create(self, version=None, ttl=None, expires=None):
  39         """
  40         Create root element
  41         ttl: time to live in minutes, this will determine the expires tag of the RSpec
  42         """
  43         self.version = self.version_manager.get_version(version)
  44         self.namespaces = self.version.namespaces
  45         self.parse_xml(self.version.template, self.version)
  46         now = datetime.utcnow()
  47         generated_ts = now.strftime(SFATIME_FORMAT)
  48         if ttl is None:
  49             ttl = 60
  50         if expires is None:
  51             expires_ts = (now + timedelta(minutes=ttl)).strftime(SFATIME_FORMAT)
  52         else:
  53             if isinstance(expires,int):
  54                 expires_date = datetime.fromtimestamp(expires)
  55             else:
  56                 expires_date = expires
  57             expires_ts = expires_date.strftime(SFATIME_FORMAT)
  58         self.xml.set('expires', expires_ts)
  59         self.xml.set('generated', generated_ts)
  60
  61     def parse_xml(self, xml, version=None):
  62         self.xml.parse_xml(xml)
  63         if not version:
  64             if self.xml.schema:
  65                 self.version = self.version_manager.get_version_by_schema(self.xml.schema)
  66             else:
  67                 #raise InvalidRSpec('unknown rspec schema: {}'.format(schema))
  68                 # TODO: Should start raising an exception once SFA defines a schema.
  69                 # for now we just  default to sfa
  70                 self.version = self.version_manager.get_version({'type':'sfa','version': '1'})
  71         self.version.xml = self.xml
  72         self.namespaces = self.xml.namespaces
  73
  74     def load_rspec_elements(self, rspec_elements):
  75         self.elements = {}
  76         for rspec_element in rspec_elements:
  77             if isinstance(rspec_element, RSpecElement):
  78                 self.elements[rspec_element.type] = rspec_element
  79
  80     def register_rspec_element(self, element_type, element_name, element_path):
  81         if element_type not in RSpecElements:
  82             raise InvalidRSpecElement(element_type,
  83                                       extra="no such element type: {}. Must specify a valid RSpecElement".format(element_type))
  84         self.elements[element_type] = RSpecElement(element_type, element_name, element_path)
  85
  86     def get_rspec_element(self, element_type):
  87         if element_type not in self.elements:
  88             msg = "ElementType {} not registered for this rspec".format(element_type)
  89             raise InvalidRSpecElement(element_type, extra=msg)
  90         return self.elements[element_type]
  91
  92     def get(self, element_type, filter=None, depth=0):
  93         if filter is None: filter={}
  94         elements = self.get_elements(element_type, filter)
  95         elements = [self.xml.get_element_attributes(elem, depth=depth) for elem in elements]
  96         return elements
  97
  98     def get_elements(self, element_type, filter=None):
  99         """
 100         search for a registered element
 101         """
 102         if filter is None: filter={}
 103         if element_type not in self.elements:
 104             msg = "Unable to search for element {} in rspec, expath expression not found."\
 105                   .format(element_type)
 106             raise InvalidRSpecElement(element_type, extra=msg)
 107         rspec_element = self.get_rspec_element(element_type)
 108         xpath = rspec_element.path + XpathFilter.xpath(filter)
 109         return self.xml.xpath(xpath)
 110
 111     def merge(self, in_rspec):
 112         self.version.merge(in_rspec)
 113
 114     def filter(self, filter):
 115         if 'component_manager_id' in filter:
 116             nodes = self.version.get_nodes()
 117             for node in nodes:
 118                 if 'component_manager_id' not in node.attrib or \
 119                   node.attrib['component_manager_id'] != filter['component_manager_id']:
 120                     parent = node.getparent()
 121                     parent.remove(node.element)
 122
 123
 124     def toxml(self, header=True):
 125         if header:
 126             return self.header + self.xml.toxml()
 127         else:
 128             return self.xml.toxml()
 129
 130
 131     def save(self, filename):
 132         return self.xml.save(filename)
 133
 134 if __name__ == '__main__':
 135     import sys
 136     input = sys.argv[1]
 137     with open(input) as f:
 138         rspec = RSpec(f.read())
 139     print(rspec)
 140 #    rspec.register_rspec_element(RSpecElements.NETWORK, 'network', '//network')
 141 #    rspec.register_rspec_element(RSpecElements.NODE, 'node', '//node')
 142 #    print rspec.get(RSpecElements.NODE)[0]
 143 #    print rspec.get(RSpecElements.NODE, depth=1)[0]
 144