sfa/rspecs/rspec.py

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