sfa/util/xml.py

   1 #!/usr/bin/python
   2 from types import StringTypes
   3 from lxml import etree
   4 from StringIO import StringIO
   5 from sfa.util.faults import InvalidXML
   6
   7 class XpathFilter:
   8     @staticmethod
   9
  10     def filter_value(key, value):
  11         xpath = ""
  12         if isinstance(value, str):
  13             if '*' in value:
  14                 value = value.replace('*', '')
  15                 xpath = 'contains(%s, "%s")' % (key, value)
  16             else:
  17                 xpath = '%s="%s"' % (key, value)
  18         return xpath
  19
  20     @staticmethod
  21     def xpath(filter={}):
  22         xpath = ""
  23         if filter:
  24             filter_list = []
  25             for (key, value) in filter.items():
  26                 if key == 'text':
  27                     key = 'text()'
  28                 else:
  29                     key = '@'+key
  30                 if isinstance(value, str):
  31                     filter_list.append(XpathFilter.filter_value(key, value))
  32                 elif isinstance(value, list):
  33                     stmt = ' or '.join([XpathFilter.filter_value(key, str(val)) for val in value])
  34                     filter_list.append(stmt)
  35             if filter_list:
  36                 xpath = ' and '.join(filter_list)
  37                 xpath = '[' + xpath + ']'
  38         return xpath
  39
  40 class XmlNode:
  41     def __init__(self, node, namespaces):
  42         self.node = node
  43         self.text = node.text
  44         self.namespaces = namespaces
  45         self.attrib = node.attrib
  46
  47
  48     def xpath(self, xpath, namespaces=None):
  49         if not namespaces:
  50             namespaces = self.namespaces
  51         elems = self.node.xpath(xpath, namespaces=namespaces)
  52         return [XmlNode(elem, namespaces) for elem in elems]
  53
  54     def add_element(self, name, **kwds):
  55         element = etree.SubElement(self.node, name, **kwds)
  56         return XmlNode(element, self.namespaces)
  57
  58     def append(self, elem):
  59         if isinstance(elem, XmlNode):
  60             self.node.append(elem.node)
  61         else:
  62             self.node.append(elem)
  63
  64     def remove_elements(name):
  65         """
  66         Removes all occurences of an element from the tree. Start at
  67         specified root_node if specified, otherwise start at tree's root.
  68         """
  69
  70         if not element_name.startswith('//'):
  71             element_name = '//' + element_name
  72         elements = self.node.xpath('%s ' % name, namespaces=self.namespaces)
  73         for element in elements:
  74             parent = element.getparent()
  75             parent.remove(element)
  76
  77     def remove(element):
  78         self.node.remove(element)
  79
  80     def set(self, key, value):
  81         self.node.set(key, value)
  82
  83     def set_text(self, text):
  84         self.node.text = text
  85
  86     def unset(self, key):
  87         del self.node.attrib[key]
  88
  89     def iterchildren(self):
  90         return self.node.iterchildren()
  91
  92     def toxml(self):
  93         return etree.tostring(self.node, encoding='UTF-8', pretty_print=True)
  94
  95     def __str__(self):
  96         return self.toxml()
  97
  98 class XML:
  99
 100     def __init__(self, xml=None, namespaces=None):
 101         self.root = None
 102         self.namespaces = namespaces
 103         self.default_namespace = None
 104         self.schema = None
 105         if isinstance(xml, basestring):
 106             self.parse_xml(xml)
 107         if isinstance(xml, XmlNode):
 108             self.root = xml
 109             self.namespaces = xml.namespaces
 110         elif isinstance(xml, etree._ElementTree) or isinstance(xml, etree._Element):
 111             self.parse_xml(etree.tostring(xml))
 112
 113     def parse_xml(self, xml):
 114         """
 115         parse rspec into etree
 116         """
 117         parser = etree.XMLParser(remove_blank_text=True)
 118         try:
 119             tree = etree.parse(xml, parser)
 120         except IOError:
 121             # 'rspec' file doesnt exist. 'rspec' is proably an xml string
 122             try:
 123                 tree = etree.parse(StringIO(xml), parser)
 124             except Exception, e:
 125                 raise InvalidXML(str(e))
 126         root = tree.getroot()
 127         self.namespaces = dict(root.nsmap)
 128         # set namespaces map
 129         if 'default' not in self.namespaces and None in self.namespaces:
 130             # If the 'None' exist, then it's pointing to the default namespace. This makes
 131             # it hard for us to write xpath queries for the default naemspace because lxml
 132             # wont understand a None prefix. We will just associate the default namespeace
 133             # with a key named 'default'.
 134             self.namespaces['default'] = self.namespaces.pop(None)
 135
 136         else:
 137             self.namespaces['default'] = 'default'
 138
 139         self.root = XmlNode(root, self.namespaces)
 140         # set schema
 141         for key in self.root.attrib.keys():
 142             if key.endswith('schemaLocation'):
 143                 # schema location should be at the end of the list
 144                 schema_parts  = self.root.attrib[key].split(' ')
 145                 self.schema = schema_parts[1]
 146                 namespace, schema  = schema_parts[0], schema_parts[1]
 147                 break
 148
 149     def parse_dict(self, d, root_tag_name='xml', element = None):
 150         if element is None:
 151             if self.root is None:
 152                 self.parse_xml('<%s/>' % root_tag_name)
 153             element = self.root
 154
 155         if 'text' in d:
 156             text = d.pop('text')
 157             element.text = text
 158
 159         # handle repeating fields
 160         for (key, value) in d.items():
 161             if isinstance(value, list):
 162                 value = d.pop(key)
 163                 for val in value:
 164                     if isinstance(val, dict):
 165                         child_element = etree.SubElement(element, key)
 166                         self.parse_dict(val, key, child_element)
 167                     elif isinstance(val, basestring):
 168                         child_element = etree.SubElement(element, key).text = val
 169
 170             elif isinstance(value, int):
 171                 d[key] = unicode(d[key])
 172             elif value is None:
 173                 d.pop(key)
 174
 175         # element.attrib.update will explode if DateTimes are in the
 176         # dcitionary.
 177         d=d.copy()
 178         # looks like iteritems won't stand side-effects
 179         for k in d.keys():
 180             if not isinstance(d[k],StringTypes):
 181                 del d[k]
 182
 183         element.attrib.update(d)
 184
 185     def validate(self, schema):
 186         """
 187         Validate against rng schema
 188         """
 189         relaxng_doc = etree.parse(schema)
 190         relaxng = etree.RelaxNG(relaxng_doc)
 191         if not relaxng(self.root):
 192             error = relaxng.error_log.last_error
 193             message = "%s (line %s)" % (error.message, error.line)
 194             raise InvalidXML(message)
 195         return True
 196
 197     def xpath(self, xpath, namespaces=None):
 198         if not namespaces:
 199             namespaces = self.namespaces
 200         return self.root.xpath(xpath, namespaces=namespaces)
 201
 202     def set(self, key, value, node=None):
 203         if not node:
 204             node = self.root
 205         return node.set(key, value)
 206
 207     def remove_attribute(self, name, node=None):
 208         if not node:
 209             node = self.root
 210         node.remove_attribute(name)
 211
 212
 213     def add_element(self, name, **kwds):
 214         """
 215         Wrapper around etree.SubElement(). Adds an element to
 216         specified parent node. Adds element to root node is parent is
 217         not specified.
 218         """
 219         parent = self.root
 220         xmlnode = parent.add_element(name, *kwds)
 221         return xmlnode
 222
 223     def remove_elements(self, name, node = None):
 224         """
 225         Removes all occurences of an element from the tree. Start at
 226         specified root_node if specified, otherwise start at tree's root.
 227         """
 228         if not node:
 229             node = self.root
 230
 231         node.remove_elements(name)
 232
 233     def attributes_list(self, elem):
 234         # convert a list of attribute tags into list of tuples
 235         # (tagnme, text_value)
 236         opts = []
 237         if elem is not None:
 238             for e in elem:
 239                 opts.append((e.tag, str(e.text).strip()))
 240         return opts
 241
 242     def get_element_attributes(self, elem=None, depth=0):
 243         if elem == None:
 244             elem = self.root_node
 245         if not hasattr(elem, 'attrib'):
 246             # this is probably not an element node with attribute. could be just and an
 247             # attribute, return it
 248             return elem
 249         attrs = dict(elem.attrib)
 250         attrs['text'] = str(elem.text).strip()
 251         attrs['parent'] = elem.getparent()
 252         if isinstance(depth, int) and depth > 0:
 253             for child_elem in list(elem):
 254                 key = str(child_elem.tag)
 255                 if key not in attrs:
 256                     attrs[key] = [self.get_element_attributes(child_elem, depth-1)]
 257                 else:
 258                     attrs[key].append(self.get_element_attributes(child_elem, depth-1))
 259         else:
 260             attrs['child_nodes'] = list(elem)
 261         return attrs
 262
 263     def merge(self, in_xml):
 264         pass
 265
 266     def __str__(self):
 267         return self.toxml()
 268
 269     def toxml(self):
 270         return etree.tostring(self.root.node, encoding='UTF-8', pretty_print=True)
 271
 272     # XXX smbaker, for record.load_from_string
 273     def todict(self, elem=None):
 274         if elem is None:
 275             elem = self.root
 276         d = {}
 277         d.update(elem.attrib)
 278         d['text'] = elem.text
 279         for child in elem.iterchildren():
 280             if child.tag not in d:
 281                 d[child.tag] = []
 282             d[child.tag].append(self.todict(child))
 283
 284         if len(d)==1 and ("text" in d):
 285             d = d["text"]
 286
 287         return d
 288
 289     def save(self, filename):
 290         f = open(filename, 'w')
 291         f.write(self.toxml())
 292         f.close()
 293
 294 # no RSpec in scope
 295 #if __name__ == '__main__':
 296 #    rspec = RSpec('/tmp/resources.rspec')
 297 #    print rspec
 298