← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# 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
16
16
 
17
17
"""XML externalization support."""
18
18
 
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
25
 
from bzrlib import registry
26
 
from bzrlib.trace import mutter, warning
 
25
import re
 
26
 
 
27
from bzrlib.serializer import Serializer
 
28
from bzrlib.trace import mutter
27
29
 
28
30
try:
29
31
    try:
31
33
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
32
34
            XMLTreeBuilder, fromstring, tostring)
33
35
        import xml.etree as elementtree
 
36
        # Also import ElementTree module so monkey-patching below always works
 
37
        import xml.etree.ElementTree
34
38
    except ImportError:
35
39
        from cElementTree import (ElementTree, SubElement, Element,
36
40
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree
 
41
        import elementtree.ElementTree
38
42
    ParseError = SyntaxError
39
43
except ImportError:
40
44
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
49
53
from bzrlib import errors
50
54
 
51
55
 
52
 
class Serializer(object):
53
 
    """Abstract object serialize/deserialize"""
54
 
 
55
 
    def write_inventory(self, inv, f):
56
 
        """Write inventory to a file"""
57
 
        raise NotImplementedError(self.write_inventory)
58
 
 
59
 
    def write_inventory_to_string(self, inv):
60
 
        raise NotImplementedError(self.write_inventory_to_string)
61
 
 
62
 
    def read_inventory_from_string(self, xml_string, revision_id=None):
 
56
class XMLSerializer(Serializer):
 
57
    """Abstract XML object serialize/deserialize"""
 
58
 
 
59
    squashes_xml_invalid_characters = True
 
60
 
 
61
    def read_inventory_from_string(self, xml_string, revision_id=None,
 
62
                                   entry_cache=None, return_from_cache=False):
63
63
        """Read xml_string into an inventory object.
64
64
 
65
65
        :param xml_string: The xml to read.
66
66
        :param revision_id: If not-None, the expected revision id of the
67
67
            inventory. Some serialisers use this to set the results' root
68
 
            revision.
 
68
            revision. This should be supplied for deserialising all
 
69
            from-repository inventories so that xml5 inventories that were
 
70
            serialised without a revision identifier can be given the right
 
71
            revision id (but not for working tree inventories where users can
 
72
            edit the data without triggering checksum errors or anything).
 
73
        :param entry_cache: An optional cache of InventoryEntry objects. If
 
74
            supplied we will look up entries via (file_id, revision_id) which
 
75
            should map to a valid InventoryEntry (File/Directory/etc) object.
 
76
        :param return_from_cache: Return entries directly from the cache,
 
77
            rather than copying them first. This is only safe if the caller
 
78
            promises not to mutate the returned inventory entries, but it can
 
79
            make some operations significantly faster.
69
80
        """
70
81
        try:
71
 
            return self._unpack_inventory(fromstring(xml_string), revision_id)
 
82
            return self._unpack_inventory(fromstring(xml_string), revision_id,
 
83
                                          entry_cache=entry_cache,
 
84
                                          return_from_cache=return_from_cache)
72
85
        except ParseError, e:
73
86
            raise errors.UnexpectedInventoryFormat(e)
74
87
 
75
88
    def read_inventory(self, f, revision_id=None):
76
89
        try:
77
 
            return self._unpack_inventory(self._read_element(f),
78
 
                revision_id=None)
 
90
            try:
 
91
                return self._unpack_inventory(self._read_element(f),
 
92
                    revision_id=None)
 
93
            finally:
 
94
                f.close()
79
95
        except ParseError, e:
80
96
            raise errors.UnexpectedInventoryFormat(e)
81
97
 
99
115
        return ElementTree().parse(f)
100
116
 
101
117
 
102
 
# performance tuning for elementree's serialiser. This should be
103
 
# sent upstream - RBC 20060523.
104
 
# the functions here are patched into elementtree at runtime.
105
 
import re
106
 
escape_re = re.compile("[&'\"<>]")
107
 
escape_map = {
108
 
    "&":'&amp;',
109
 
    "'":"&apos;", # FIXME: overkill
110
 
    "\"":"&quot;",
111
 
    "<":"&lt;",
112
 
    ">":"&gt;",
113
 
    }
114
 
def _escape_replace(match, map=escape_map):
115
 
    return map[match.group()]
116
 
 
117
 
def _escape_attrib(text, encoding=None, replace=None):
118
 
    # escape attribute value
119
 
    try:
120
 
        if encoding:
121
 
            try:
122
 
                text = elementtree.ElementTree._encode(text, encoding)
123
 
            except UnicodeError:
124
 
                return elementtree.ElementTree._encode_entity(text)
125
 
        if replace is None:
126
 
            return escape_re.sub(_escape_replace, text)
127
 
        else:
128
 
            text = replace(text, "&", "&amp;")
129
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
130
 
            text = replace(text, "\"", "&quot;")
131
 
            text = replace(text, "<", "&lt;")
132
 
            text = replace(text, ">", "&gt;")
133
 
            return text
134
 
    except (TypeError, AttributeError):
135
 
        elementtree.ElementTree._raise_serialization_error(text)
136
 
 
137
 
elementtree.ElementTree._escape_attrib = _escape_attrib
138
 
 
139
 
escape_cdata_re = re.compile("[&<>]")
140
 
escape_cdata_map = {
141
 
    "&":'&amp;',
142
 
    "<":"&lt;",
143
 
    ">":"&gt;",
144
 
    }
145
 
def _escape_cdata_replace(match, map=escape_cdata_map):
146
 
    return map[match.group()]
147
 
 
148
 
def _escape_cdata(text, encoding=None, replace=None):
149
 
    # escape character data
150
 
    try:
151
 
        if encoding:
152
 
            try:
153
 
                text = elementtree.ElementTree._encode(text, encoding)
154
 
            except UnicodeError:
155
 
                return elementtree.ElementTree._encode_entity(text)
156
 
        if replace is None:
157
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
158
 
        else:
159
 
            text = replace(text, "&", "&amp;")
160
 
            text = replace(text, "<", "&lt;")
161
 
            text = replace(text, ">", "&gt;")
162
 
            return text
163
 
    except (TypeError, AttributeError):
164
 
        elementtree.ElementTree._raise_serialization_error(text)
165
 
 
166
 
elementtree.ElementTree._escape_cdata = _escape_cdata
167
 
 
168
 
 
169
 
class SerializerRegistry(registry.Registry):
170
 
    """Registry for serializer objects"""
171
 
 
172
 
 
173
 
format_registry = SerializerRegistry()
174
 
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
175
 
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
176
 
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
177
 
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
 
118
def escape_invalid_chars(message):
 
119
    """Escape the XML-invalid characters in a commit message.
 
120
 
 
121
    :param message: Commit message to escape
 
122
    :return: tuple with escaped message and number of characters escaped
 
123
    """
 
124
    if message is None:
 
125
        return None, 0
 
126
    # Python strings can include characters that can't be
 
127
    # represented in well-formed XML; escape characters that
 
128
    # aren't listed in the XML specification
 
129
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
130
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
131
            lambda match: match.group(0).encode('unicode_escape'),
 
132
            message)