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