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 create(self):
  29         """
  30         Create root element
  31         """
  32         # eg. 2011-03-23T19:53:28Z
  33         date_format = '%Y-%m-%dT%H:%M:%SZ'
  34         now = datetime.utcnow()
  35         generated_ts = now.strftime(date_format)
  36         expires_ts = (now + timedelta(hours=1)).strftime(date_format)
  37         self.parse_rspec(self.template, self.namespaces)
  38         self.xml.set('expires', expires_ts)
  39         self.xml.set('generated', generated_ts)
  40
  41     def parse_rspec(self, rspec, namespaces={}):
  42         """
  43         parse rspec into etree
  44         """
  45         parser = etree.XMLParser(remove_blank_text=True)
  46         try:
  47             tree = etree.parse(rspec, parser)
  48         except IOError:
  49             # 'rspec' file doesnt exist. 'rspec' is proably an xml string
  50             try:
  51                 tree = etree.parse(StringIO(rspec), parser)
  52             except:
  53                 raise InvalidRSpec('Must specify a xml file or xml string. Received: ' + rspec )
  54         self.xml = tree.getroot()
  55         if namespaces:
  56            self.namespaces = namespaces
  57
  58     def xpath(self, xpath):
  59         return this.xml.xpath(xpath, namespaces=self.namespaces)
  60
  61     def add_attribute(self, elem, name, value):
  62         """
  63         Add attribute to specified etree element
  64         """
  65         opt = etree.SubElement(elem, name)
  66         opt.text = value
  67
  68     def add_element(self, name, attrs={}, parent=None, text=""):
  69         """
  70         Generic wrapper around etree.SubElement(). Adds an element to
  71         specified parent node. Adds element to root node is parent is
  72         not specified.
  73         """
  74         if parent == None:
  75             parent = self.xml
  76         element = etree.SubElement(parent, name)
  77         if text:
  78             element.text = text
  79         if isinstance(attrs, dict):
  80             for attr in attrs:
  81                 element.set(attr, attrs[attr])
  82         return element
  83
  84     def remove_attribute(self, elem, name, value):
  85         """
  86         Removes an attribute from an element
  87         """
  88         if elem is not None:
  89             opts = elem.iterfind(name)
  90             if opts is not None:
  91                 for opt in opts:
  92                     if opt.text == value:
  93                         elem.remove(opt)
  94
  95     def remove_element(self, element_name, root_node = None):
  96         """
  97         Removes all occurences of an element from the tree. Start at
  98         specified root_node if specified, otherwise start at tree's root.
  99         """
 100         if not root_node:
 101             root_node = self.xml
 102
 103         if not element_name.startswith('//'):
 104             element_name = '//' + element_name
 105
 106         elements = root_node.xpath('%s ' % element_name, namespaces=self.namespaces)
 107         for element in elements:
 108             parent = element.getparent()
 109             parent.remove(element)
 110
 111
 112     def merge(self, in_rspec):
 113         pass
 114
 115     def validate(self, schema):
 116         """
 117         Validate against rng schema
 118         """
 119
 120         relaxng_doc = etree.parse(schema)
 121         relaxng = etree.RelaxNG(relaxng_doc)
 122         if not relaxng(self.xml):
 123             error = relaxng.error_log.last_error
 124             message = "%s (line %s)" % (error.message, error.line)
 125             raise InvalidRSpec(message)
 126         return True
 127
 128
 129     def cleanup(self):
 130         """
 131         Optional method which inheriting classes can choose to implent.
 132         """
 133         pass
 134
 135     def __str__(self):
 136         return self.toxml()
 137
 138     def toxml(self, cleanup=False):
 139         if cleanup:
 140             self.cleanup()
 141         return self.header + etree.tostring(self.xml, pretty_print=True)
 142
 143     def save(self, filename):
 144         f = open(filename, 'w')
 145         f.write(self.toxml())
 146         f.close()
 147
 148 if __name__ == '__main__':
 149     rspec = RSpec()
 150     print rspec