sfa/rspecs/rspec.py

   1 #!/usr/bin/python
   2 from lxml import etree
   3 from StringIO import StringIO
   4 from datetime import datetime, timedelta
   5 from sfa.util.xrn import *
   6 from sfa.util.plxrn import hostname_to_urn
   7 from sfa.util.config import Config
   8 from sfa.util.faults import SfaNotImplemented, InvalidRSpec
   9
  10 class RSpec:
  11     header = '<?xml version="1.0"?>\n'
  12     template = """<RSpec></RSpec>"""
  13     config = Config()
  14     xml = None
  15     type = None
  16     version = None
  17     namespaces = None
  18     user_options = {}
  19
  20     def __init__(self, rspec="", namespaces={}, type=None, user_options={}:
  21         self.type = type
  22         self.user_options = user_options
  23         if rspec:
  24             self.parse_rspec(rspec, namespaces)
  25         else:
  26             self.create()
  27
  28     def __get_template(self):
  29         return self.template
  30
  31     def create(self):
  32         """
  33         Create root element
  34         """
  35         # eg. 2011-03-23T19:53:28Z
  36         date_format = '%Y-%m-%dT%H:%M:%SZ'
  37         now = datetime.utcnow()
  38         generated_ts = now.strftime(date_format)
  39         expires_ts = (now + timedelta(hours=1)).strftime(date_format)
  40         self.parse_rspec(self.__get_template, self.namespaces)
  41         self.xml.set('valid_until', expires_ts)
  42         self.xml.set('generated', generated_ts)
  43
  44     def parse_rspec(self, rspec, namespaces={}):
  45         """
  46         parse rspec into etree
  47         """
  48         parser = etree.XMLParser(remove_blank_text=True)
  49         try:
  50             tree = etree.parse(rspec, parser)
  51         except IOError:
  52             # 'rspec' file doesnt exist. 'rspec' is proably an xml string
  53             try:
  54                 tree = etree.parse(StringIO(rspec), parser)
  55             except:
  56                 raise InvalidRSpec('Must specify a xml file or xml string. Received: ' + rspec )
  57
  58         self.xml = tree.getroot()
  59         if namespaces:
  60            self.namespaces = namespaces
  61
  62     def add_attribute(self, elem, name, value):
  63         """
  64         Add attribute to specified etree element
  65         """
  66         opt = etree.SubElement(elem, name)
  67         opt.text = value
  68
  69     def add_element(self, name, attrs={}, parent=None, text=""):
  70         """
  71         Generic wrapper around etree.SubElement(). Adds an element to
  72         specified parent node. Adds element to root node is parent is
  73         not specified.
  74         """
  75         if parent == None:
  76             parent = self.xml
  77         element = etree.SubElement(parent, name)
  78         if text:
  79             element.text = text
  80         if isinstance(attrs, dict):
  81             for attr in attrs:
  82                 element.set(attr, attrs[attr])
  83         return element
  84
  85     def remove_attribute(self, elem, name, value):
  86         """
  87         Removes an attribute from an element
  88         """
  89         if elem is not None:
  90             opts = elem.iterfind(name)
  91             if opts is not None:
  92                 for opt in opts:
  93                     if opt.text == value:
  94                         elem.remove(opt)
  95
  96     def merge(self, in_rspec):
  97         pass
  98
  99     def validate(self, schema):
 100         """
 101         Validate against rng schema
 102         """
 103
 104         relaxng_doc = etree.parse(schema)
 105         relaxng = etree.RelaxNG(relaxng_doc)
 106         if not relaxng(self.xml):
 107             error = relaxng.error_log.last_error
 108             message = "%s (line %s)" % (error.message, error.line)
 109             raise InvalidRSpec(message)
 110         return True
 111
 112
 113     def __str__(self):
 114         return self.toxml()
 115
 116     def toxml(self):
 117         return self.header + etree.tostring(self.xml, pretty_print=True)
 118
 119     def save(self, filename):
 120         f = open(filename, 'w')
 121         f.write(self.toxml())
 122         f.close()
 123
 124 if __name__ == '__main__':
 125     rspec = RSpec()
 126     print rspec