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