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