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