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