sfa/rspecs/rspec.py

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