← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-07-23 13:59:30 UTC
  • Revision ID: mbp@sourcefrog.net-20050723135930-d81530c82c925cb0
- less dodgy is_inside function

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20
# "XML is like violence: if it doesn't solve your problem, you aren't
20
21
# using enough of it." -- various
21
22
 
22
 
# importing this module is fairly slow because it has to load several
23
 
# ElementTree bits
24
 
 
25
 
from bzrlib import registry
26
 
from bzrlib.trace import mutter, warning
27
 
 
 
23
# importing this module is fairly slow because it has to load several ElementTree bits
28
24
try:
29
 
    try:
30
 
        # it's in this package in python2.5
31
 
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
32
 
            XMLTreeBuilder, fromstring, tostring)
33
 
        import xml.etree as elementtree
34
 
    except ImportError:
35
 
        from cElementTree import (ElementTree, SubElement, Element,
36
 
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree
38
 
    ParseError = SyntaxError
 
25
    from cElementTree import ElementTree, SubElement, Element
39
26
except ImportError:
40
 
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
41
 
           " and make sure it's on your PYTHONPATH")
42
 
    # this copy is shipped with bzr
43
 
    from util.elementtree.ElementTree import (ElementTree, SubElement,
44
 
                                              Element, XMLTreeBuilder,
45
 
                                              fromstring, tostring)
46
 
    import util.elementtree as elementtree
47
 
    from xml.parsers.expat import ExpatError as ParseError
48
 
 
49
 
from bzrlib import errors
50
 
 
51
 
 
52
 
class Serializer(object):
53
 
    """Abstract object serialize/deserialize"""
54
 
    def write_inventory(self, inv, f):
55
 
        """Write inventory to a file"""
56
 
        elt = self._pack_inventory(inv)
57
 
        self._write_element(elt, f)
58
 
 
59
 
    def write_inventory_to_string(self, inv):
60
 
        return tostring(self._pack_inventory(inv)) + '\n'
61
 
 
62
 
    def read_inventory_from_string(self, xml_string):
63
 
        try:
64
 
            return self._unpack_inventory(fromstring(xml_string))
65
 
        except ParseError, e:
66
 
            raise errors.UnexpectedInventoryFormat(e)
67
 
 
68
 
    def read_inventory(self, f):
69
 
        try:
70
 
            return self._unpack_inventory(self._read_element(f))
71
 
        except ParseError, e:
72
 
            raise errors.UnexpectedInventoryFormat(e)
73
 
 
74
 
    def write_revision(self, rev, f):
75
 
        self._write_element(self._pack_revision(rev), f)
76
 
 
77
 
    def write_revision_to_string(self, rev):
78
 
        return tostring(self._pack_revision(rev)) + '\n'
79
 
 
80
 
    def read_revision(self, f):
81
 
        return self._unpack_revision(self._read_element(f))
82
 
 
83
 
    def read_revision_from_string(self, xml_string):
84
 
        return self._unpack_revision(fromstring(xml_string))
85
 
 
86
 
    def _write_element(self, elt, f):
87
 
        ElementTree(elt).write(f, 'utf-8')
88
 
        f.write('\n')
89
 
 
90
 
    def _read_element(self, f):
91
 
        return ElementTree().parse(f)
92
 
 
93
 
 
94
 
# performance tuning for elementree's serialiser. This should be
95
 
# sent upstream - RBC 20060523.
96
 
# the functions here are patched into elementtree at runtime.
97
 
import re
98
 
escape_re = re.compile("[&'\"<>]")
99
 
escape_map = {
100
 
    "&":'&amp;',
101
 
    "'":"&apos;", # FIXME: overkill
102
 
    "\"":"&quot;",
103
 
    "<":"&lt;",
104
 
    ">":"&gt;",
105
 
    }
106
 
def _escape_replace(match, map=escape_map):
107
 
    return map[match.group()]
108
 
 
109
 
def _escape_attrib(text, encoding=None, replace=None):
110
 
    # escape attribute value
111
 
    try:
112
 
        if encoding:
113
 
            try:
114
 
                text = elementtree.ElementTree._encode(text, encoding)
115
 
            except UnicodeError:
116
 
                return elementtree.ElementTree._encode_entity(text)
117
 
        if replace is None:
118
 
            return escape_re.sub(_escape_replace, text)
119
 
        else:
120
 
            text = replace(text, "&", "&amp;")
121
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
122
 
            text = replace(text, "\"", "&quot;")
123
 
            text = replace(text, "<", "&lt;")
124
 
            text = replace(text, ">", "&gt;")
125
 
            return text
126
 
    except (TypeError, AttributeError):
127
 
        elementtree.ElementTree._raise_serialization_error(text)
128
 
 
129
 
elementtree.ElementTree._escape_attrib = _escape_attrib
130
 
 
131
 
escape_cdata_re = re.compile("[&<>]")
132
 
escape_cdata_map = {
133
 
    "&":'&amp;',
134
 
    "<":"&lt;",
135
 
    ">":"&gt;",
136
 
    }
137
 
def _escape_cdata_replace(match, map=escape_cdata_map):
138
 
    return map[match.group()]
139
 
 
140
 
def _escape_cdata(text, encoding=None, replace=None):
141
 
    # escape character data
142
 
    try:
143
 
        if encoding:
144
 
            try:
145
 
                text = elementtree.ElementTree._encode(text, encoding)
146
 
            except UnicodeError:
147
 
                return elementtree.ElementTree._encode_entity(text)
148
 
        if replace is None:
149
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
150
 
        else:
151
 
            text = replace(text, "&", "&amp;")
152
 
            text = replace(text, "<", "&lt;")
153
 
            text = replace(text, ">", "&gt;")
154
 
            return text
155
 
    except (TypeError, AttributeError):
156
 
        elementtree.ElementTree._raise_serialization_error(text)
157
 
 
158
 
elementtree.ElementTree._escape_cdata = _escape_cdata
159
 
 
160
 
 
161
 
class SerializerRegistry(registry.Registry):
162
 
    """Registry for serializer objects"""
163
 
 
164
 
 
165
 
format_registry = SerializerRegistry()
166
 
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
167
 
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
168
 
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
169
 
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
27
    from elementtree.ElementTree import ElementTree, SubElement, Element
 
28
 
 
29
 
 
30
def pack_xml(o, f):
 
31
    """Write object o to file f as XML.
 
32
 
 
33
    o must provide a to_element method.
 
34
    """
 
35
    ElementTree(o.to_element()).write(f, 'utf-8')
 
36
    f.write('\n')
 
37
 
 
38
 
 
39
def unpack_xml(cls, f):
 
40
    return cls.from_element(ElementTree().parse(f))