← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

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
 
25
from bzrlib.serializer import Serializer
26
26
from bzrlib.trace import mutter, warning
27
27
 
28
28
try:
49
49
from bzrlib import errors
50
50
 
51
51
 
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):
 
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):
63
59
        """Read xml_string into an inventory object.
64
60
 
65
61
        :param xml_string: The xml to read.
70
66
            serialised without a revision identifier can be given the right
71
67
            revision id (but not for working tree inventories where users can
72
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.
73
76
        """
74
77
        try:
75
 
            return self._unpack_inventory(fromstring(xml_string), revision_id)
 
78
            return self._unpack_inventory(fromstring(xml_string), revision_id,
 
79
                                          entry_cache=entry_cache,
 
80
                                          return_from_cache=return_from_cache)
76
81
        except ParseError, e:
77
82
            raise errors.UnexpectedInventoryFormat(e)
78
83
 
117
122
    }
118
123
def _escape_replace(match, map=escape_map):
119
124
    return map[match.group()]
120
 
 
 
125
 
121
126
def _escape_attrib(text, encoding=None, replace=None):
122
127
    # escape attribute value
123
128
    try:
148
153
    }
149
154
def _escape_cdata_replace(match, map=escape_cdata_map):
150
155
    return map[match.group()]
151
 
 
 
156
 
152
157
def _escape_cdata(text, encoding=None, replace=None):
153
158
    # escape character data
154
159
    try:
170
175
elementtree.ElementTree._escape_cdata = _escape_cdata
171
176
 
172
177
 
173
 
class SerializerRegistry(registry.Registry):
174
 
    """Registry for serializer objects"""
175
 
 
176
 
 
177
 
format_registry = SerializerRegistry()
178
 
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
179
 
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
180
 
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
181
 
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
182
 
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
 
178
def escape_invalid_chars(message):
 
179
    """Escape the XML-invalid characters in a commit message.
 
180
 
 
181
    :param message: Commit message to escape
 
182
    :return: tuple with escaped message and number of characters escaped
 
183
    """
 
184
    if message is None:
 
185
        return None, 0
 
186
    # Python strings can include characters that can't be
 
187
    # represented in well-formed XML; escape characters that
 
188
    # aren't listed in the XML specification
 
189
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
190
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
191
            lambda match: match.group(0).encode('unicode_escape'),
 
192
            message)