← 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: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

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.trace import mutter, warning
 
25
import re
 
26
 
 
27
from bzrlib.serializer import Serializer
 
28
from bzrlib.trace import mutter
26
29
 
27
30
try:
28
31
    try:
30
33
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
31
34
            XMLTreeBuilder, fromstring, tostring)
32
35
        import xml.etree as elementtree
 
36
        # Also import ElementTree module so monkey-patching below always works
 
37
        import xml.etree.ElementTree
33
38
    except ImportError:
34
39
        from cElementTree import (ElementTree, SubElement, Element,
35
40
                                  XMLTreeBuilder, fromstring, tostring)
36
 
        import elementtree
 
41
        import elementtree.ElementTree
37
42
    ParseError = SyntaxError
38
43
except ImportError:
39
44
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
48
53
from bzrlib import errors
49
54
 
50
55
 
51
 
class Serializer(object):
52
 
    """Abstract object serialize/deserialize"""
53
 
    def write_inventory(self, inv, f):
54
 
        """Write inventory to a file"""
55
 
        elt = self._pack_inventory(inv)
56
 
        self._write_element(elt, f)
57
 
 
58
 
    def write_inventory_to_string(self, inv):
59
 
        return tostring(self._pack_inventory(inv)) + '\n'
60
 
 
61
 
    def read_inventory_from_string(self, xml_string):
 
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
        """Read xml_string into an inventory object.
 
64
 
 
65
        :param xml_string: The xml to read.
 
66
        :param revision_id: If not-None, the expected revision id of the
 
67
            inventory. Some serialisers use this to set the results' root
 
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.
 
80
        """
62
81
        try:
63
 
            return self._unpack_inventory(fromstring(xml_string))
 
82
            return self._unpack_inventory(fromstring(xml_string), revision_id,
 
83
                                          entry_cache=entry_cache,
 
84
                                          return_from_cache=return_from_cache)
64
85
        except ParseError, e:
65
86
            raise errors.UnexpectedInventoryFormat(e)
66
87
 
67
 
    def read_inventory(self, f):
 
88
    def read_inventory(self, f, revision_id=None):
68
89
        try:
69
 
            return self._unpack_inventory(self._read_element(f))
 
90
            try:
 
91
                return self._unpack_inventory(self._read_element(f),
 
92
                    revision_id=None)
 
93
            finally:
 
94
                f.close()
70
95
        except ParseError, e:
71
96
            raise errors.UnexpectedInventoryFormat(e)
72
97
 
90
115
        return ElementTree().parse(f)
91
116
 
92
117
 
93
 
# performance tuning for elementree's serialiser. This should be
94
 
# sent upstream - RBC 20060523.
95
 
# the functions here are patched into elementtree at runtime.
96
 
import re
97
 
escape_re = re.compile("[&'\"<>]")
98
 
escape_map = {
99
 
    "&":'&amp;',
100
 
    "'":"&apos;", # FIXME: overkill
101
 
    "\"":"&quot;",
102
 
    "<":"&lt;",
103
 
    ">":"&gt;",
104
 
    }
105
 
def _escape_replace(match, map=escape_map):
106
 
    return map[match.group()]
107
 
 
108
 
def _escape_attrib(text, encoding=None, replace=None):
109
 
    # escape attribute value
110
 
    try:
111
 
        if encoding:
112
 
            try:
113
 
                text = elementtree.ElementTree._encode(text, encoding)
114
 
            except UnicodeError:
115
 
                return elementtree.ElementTree._encode_entity(text)
116
 
        if replace is None:
117
 
            return escape_re.sub(_escape_replace, text)
118
 
        else:
119
 
            text = replace(text, "&", "&amp;")
120
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
121
 
            text = replace(text, "\"", "&quot;")
122
 
            text = replace(text, "<", "&lt;")
123
 
            text = replace(text, ">", "&gt;")
124
 
            return text
125
 
    except (TypeError, AttributeError):
126
 
        elementtree.ElementTree._raise_serialization_error(text)
127
 
 
128
 
elementtree.ElementTree._escape_attrib = _escape_attrib
129
 
 
130
 
escape_cdata_re = re.compile("[&<>]")
131
 
escape_cdata_map = {
132
 
    "&":'&amp;',
133
 
    "<":"&lt;",
134
 
    ">":"&gt;",
135
 
    }
136
 
def _escape_cdata_replace(match, map=escape_cdata_map):
137
 
    return map[match.group()]
138
 
 
139
 
def _escape_cdata(text, encoding=None, replace=None):
140
 
    # escape character data
141
 
    try:
142
 
        if encoding:
143
 
            try:
144
 
                text = elementtree.ElementTree._encode(text, encoding)
145
 
            except UnicodeError:
146
 
                return elementtree.ElementTree._encode_entity(text)
147
 
        if replace is None:
148
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
149
 
        else:
150
 
            text = replace(text, "&", "&amp;")
151
 
            text = replace(text, "<", "&lt;")
152
 
            text = replace(text, ">", "&gt;")
153
 
            return text
154
 
    except (TypeError, AttributeError):
155
 
        elementtree.ElementTree._raise_serialization_error(text)
156
 
 
157
 
elementtree.ElementTree._escape_cdata = _escape_cdata
 
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)