← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
16
 
18
17
"""XML externalization support."""
19
18
 
20
19
# "XML is like violence: if it doesn't solve your problem, you aren't
21
20
# using enough of it." -- various
22
21
 
23
 
# importing this module is fairly slow because it has to load several ElementTree bits
 
22
# importing this module is fairly slow because it has to load several
 
23
# ElementTree bits
 
24
 
 
25
from bzrlib.serializer import Serializer
 
26
from bzrlib.trace import mutter
 
27
 
24
28
try:
25
 
    from cElementTree import ElementTree, SubElement, Element
 
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.ElementTree
 
38
    ParseError = SyntaxError
26
39
except ImportError:
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.
 
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 XMLSerializer(Serializer):
 
53
    """Abstract XML object serialize/deserialize"""
 
54
 
 
55
    squashes_xml_invalid_characters = True
 
56
 
 
57
    def read_inventory_from_string(self, xml_string, revision_id=None,
 
58
                                   entry_cache=None, return_from_cache=False):
 
59
        """Read xml_string into an inventory object.
 
60
 
 
61
        :param xml_string: The xml to read.
 
62
        :param revision_id: If not-None, the expected revision id of the
 
63
            inventory. Some serialisers use this to set the results' root
 
64
            revision. This should be supplied for deserialising all
 
65
            from-repository inventories so that xml5 inventories that were
 
66
            serialised without a revision identifier can be given the right
 
67
            revision id (but not for working tree inventories where users can
 
68
            edit the data without triggering checksum errors or anything).
 
69
        :param entry_cache: An optional cache of InventoryEntry objects. If
 
70
            supplied we will look up entries via (file_id, revision_id) which
 
71
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
72
        :param return_from_cache: Return entries directly from the cache,
 
73
            rather than copying them first. This is only safe if the caller
 
74
            promises not to mutate the returned inventory entries, but it can
 
75
            make some operations significantly faster.
 
76
        """
 
77
        try:
 
78
            return self._unpack_inventory(fromstring(xml_string), revision_id,
 
79
                                          entry_cache=entry_cache,
 
80
                                          return_from_cache=return_from_cache)
 
81
        except ParseError, e:
 
82
            raise errors.UnexpectedInventoryFormat(e)
 
83
 
 
84
    def read_inventory(self, f, revision_id=None):
 
85
        try:
 
86
            try:
 
87
                return self._unpack_inventory(self._read_element(f),
 
88
                    revision_id=None)
 
89
            finally:
 
90
                f.close()
 
91
        except ParseError, e:
 
92
            raise errors.UnexpectedInventoryFormat(e)
 
93
 
 
94
    def write_revision(self, rev, f):
 
95
        self._write_element(self._pack_revision(rev), f)
 
96
 
 
97
    def write_revision_to_string(self, rev):
 
98
        return tostring(self._pack_revision(rev)) + '\n'
 
99
 
 
100
    def read_revision(self, f):
 
101
        return self._unpack_revision(self._read_element(f))
 
102
 
 
103
    def read_revision_from_string(self, xml_string):
 
104
        return self._unpack_revision(fromstring(xml_string))
 
105
 
 
106
    def _write_element(self, elt, f):
 
107
        ElementTree(elt).write(f, 'utf-8')
 
108
        f.write('\n')
 
109
 
 
110
    def _read_element(self, f):
 
111
        return ElementTree().parse(f)
 
112
 
 
113
 
 
114
# performance tuning for elementree's serialiser. This should be
 
115
# sent upstream - RBC 20060523.
 
116
# the functions here are patched into elementtree at runtime.
 
117
import re
 
118
escape_re = re.compile("[&'\"<>]")
 
119
escape_map = {
 
120
    "&":'&amp;',
 
121
    "'":"&apos;", # FIXME: overkill
 
122
    "\"":"&quot;",
 
123
    "<":"&lt;",
 
124
    ">":"&gt;",
 
125
    }
 
126
def _escape_replace(match, map=escape_map):
 
127
    return map[match.group()]
 
128
 
 
129
def _escape_attrib(text, encoding=None, replace=None):
 
130
    # escape attribute value
 
131
    try:
 
132
        if encoding:
 
133
            try:
 
134
                text = elementtree.ElementTree._encode(text, encoding)
 
135
            except UnicodeError:
 
136
                return elementtree.ElementTree._encode_entity(text)
 
137
        if replace is None:
 
138
            return escape_re.sub(_escape_replace, text)
 
139
        else:
 
140
            text = replace(text, "&", "&amp;")
 
141
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
142
            text = replace(text, "\"", "&quot;")
 
143
            text = replace(text, "<", "&lt;")
 
144
            text = replace(text, ">", "&gt;")
 
145
            return text
 
146
    except (TypeError, AttributeError):
 
147
        elementtree.ElementTree._raise_serialization_error(text)
 
148
 
 
149
elementtree.ElementTree._escape_attrib = _escape_attrib
 
150
 
 
151
escape_cdata_re = re.compile("[&<>]")
 
152
escape_cdata_map = {
 
153
    "&":'&amp;',
 
154
    "<":"&lt;",
 
155
    ">":"&gt;",
 
156
    }
 
157
def _escape_cdata_replace(match, map=escape_cdata_map):
 
158
    return map[match.group()]
 
159
 
 
160
def _escape_cdata(text, encoding=None, replace=None):
 
161
    # escape character data
 
162
    try:
 
163
        if encoding:
 
164
            try:
 
165
                text = elementtree.ElementTree._encode(text, encoding)
 
166
            except UnicodeError:
 
167
                return elementtree.ElementTree._encode_entity(text)
 
168
        if replace is None:
 
169
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
170
        else:
 
171
            text = replace(text, "&", "&amp;")
 
172
            text = replace(text, "<", "&lt;")
 
173
            text = replace(text, ">", "&gt;")
 
174
            return text
 
175
    except (TypeError, AttributeError):
 
176
        elementtree.ElementTree._raise_serialization_error(text)
 
177
 
 
178
elementtree.ElementTree._escape_cdata = _escape_cdata
 
179
 
 
180
 
 
181
def escape_invalid_chars(message):
 
182
    """Escape the XML-invalid characters in a commit message.
 
183
 
 
184
    :param message: Commit message to escape
 
185
    :return: tuple with escaped message and number of characters escaped
34
186
    """
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))
 
187
    if message is None:
 
188
        return None, 0
 
189
    # Python strings can include characters that can't be
 
190
    # represented in well-formed XML; escape characters that
 
191
    # aren't listed in the XML specification
 
192
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
193
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
194
            lambda match: match.group(0).encode('unicode_escape'),
 
195
            message)