← 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-09-16 08:23:10 UTC
  • Revision ID: mbp@sourcefrog.net-20050916082310-ecb5a25c40253839
- wrap wide strings when showing exceptions

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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.serializer import Serializer
26
 
from bzrlib.trace import mutter
 
25
from bzrlib.trace import mutter, warning
27
26
 
28
27
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.ElementTree
38
 
    ParseError = SyntaxError
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
39
30
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
 
31
    from warnings import warn
 
32
    warn('using slower ElementTree; consider installing cElementTree')
43
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
44
34
                                              Element, XMLTreeBuilder,
45
35
                                              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
 
            return self._unpack_inventory(self._read_element(f),
87
 
                revision_id=None)
88
 
        except ParseError, e:
89
 
            raise errors.UnexpectedInventoryFormat(e)
 
36
 
 
37
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
38
from bzrlib.revision import Revision, RevisionReference        
 
39
from bzrlib.errors import BzrError
 
40
 
 
41
 
 
42
class Serializer(object):
 
43
    """Abstract object serialize/deserialize"""
 
44
    def write_inventory(self, inv, f):
 
45
        """Write inventory to a file"""
 
46
        elt = self._pack_inventory(inv)
 
47
        self._write_element(elt, f)
 
48
 
 
49
    def write_inventory_to_string(self, inv):
 
50
        return tostring(self._pack_inventory(inv))
 
51
 
 
52
    def read_inventory_from_string(self, xml_string):
 
53
        return self._unpack_inventory(fromstring(xml_string))
 
54
 
 
55
    def read_inventory(self, f):
 
56
        return self._unpack_inventory(self._read_element(f))
90
57
 
91
58
    def write_revision(self, rev, f):
92
59
        self._write_element(self._pack_revision(rev), f)
93
60
 
94
61
    def write_revision_to_string(self, rev):
95
 
        return tostring(self._pack_revision(rev)) + '\n'
 
62
        return tostring(self._pack_revision(rev), f)
96
63
 
97
64
    def read_revision(self, f):
98
65
        return self._unpack_revision(self._read_element(f))
108
75
        return ElementTree().parse(f)
109
76
 
110
77
 
111
 
# performance tuning for elementree's serialiser. This should be
112
 
# sent upstream - RBC 20060523.
113
 
# the functions here are patched into elementtree at runtime.
114
 
import re
115
 
escape_re = re.compile("[&'\"<>]")
116
 
escape_map = {
117
 
    "&":'&amp;',
118
 
    "'":"&apos;", # FIXME: overkill
119
 
    "\"":"&quot;",
120
 
    "<":"&lt;",
121
 
    ">":"&gt;",
122
 
    }
123
 
def _escape_replace(match, map=escape_map):
124
 
    return map[match.group()]
125
 
 
126
 
def _escape_attrib(text, encoding=None, replace=None):
127
 
    # escape attribute value
128
 
    try:
129
 
        if encoding:
130
 
            try:
131
 
                text = elementtree.ElementTree._encode(text, encoding)
132
 
            except UnicodeError:
133
 
                return elementtree.ElementTree._encode_entity(text)
134
 
        if replace is None:
135
 
            return escape_re.sub(_escape_replace, text)
136
 
        else:
137
 
            text = replace(text, "&", "&amp;")
138
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
139
 
            text = replace(text, "\"", "&quot;")
140
 
            text = replace(text, "<", "&lt;")
141
 
            text = replace(text, ">", "&gt;")
142
 
            return text
143
 
    except (TypeError, AttributeError):
144
 
        elementtree.ElementTree._raise_serialization_error(text)
145
 
 
146
 
elementtree.ElementTree._escape_attrib = _escape_attrib
147
 
 
148
 
escape_cdata_re = re.compile("[&<>]")
149
 
escape_cdata_map = {
150
 
    "&":'&amp;',
151
 
    "<":"&lt;",
152
 
    ">":"&gt;",
153
 
    }
154
 
def _escape_cdata_replace(match, map=escape_cdata_map):
155
 
    return map[match.group()]
156
 
 
157
 
def _escape_cdata(text, encoding=None, replace=None):
158
 
    # escape character data
159
 
    try:
160
 
        if encoding:
161
 
            try:
162
 
                text = elementtree.ElementTree._encode(text, encoding)
163
 
            except UnicodeError:
164
 
                return elementtree.ElementTree._encode_entity(text)
165
 
        if replace is None:
166
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
167
 
        else:
168
 
            text = replace(text, "&", "&amp;")
169
 
            text = replace(text, "<", "&lt;")
170
 
            text = replace(text, ">", "&gt;")
171
 
            return text
172
 
    except (TypeError, AttributeError):
173
 
        elementtree.ElementTree._raise_serialization_error(text)
174
 
 
175
 
elementtree.ElementTree._escape_cdata = _escape_cdata
176
 
 
177
 
 
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)
 
78
class _Serializer_v4(Serializer):
 
79
    """Version 0.0.4 serializer
 
80
 
 
81
    You should use the serialzer_v4 singleton."""
 
82
    
 
83
    __slots__ = []
 
84
    
 
85
    def _pack_inventory(self, inv):
 
86
        """Convert to XML Element"""
 
87
        e = Element('inventory')
 
88
        e.text = '\n'
 
89
        if inv.root.file_id not in (None, ROOT_ID):
 
90
            e.set('file_id', inv.root.file_id)
 
91
        for path, ie in inv.iter_entries():
 
92
            e.append(self._pack_entry(ie))
 
93
        return e
 
94
 
 
95
 
 
96
    def _pack_entry(self, ie):
 
97
        """Convert InventoryEntry to XML element"""
 
98
        e = Element('entry')
 
99
        e.set('name', ie.name)
 
100
        e.set('file_id', ie.file_id)
 
101
        e.set('kind', ie.kind)
 
102
 
 
103
        if ie.text_size != None:
 
104
            e.set('text_size', '%d' % ie.text_size)
 
105
 
 
106
        for f in ['text_id', 'text_sha1']:
 
107
            v = getattr(ie, f)
 
108
            if v != None:
 
109
                e.set(f, v)
 
110
 
 
111
        # to be conservative, we don't externalize the root pointers
 
112
        # for now, leaving them as null in the xml form.  in a future
 
113
        # version it will be implied by nested elements.
 
114
        if ie.parent_id != ROOT_ID:
 
115
            assert isinstance(ie.parent_id, basestring)
 
116
            e.set('parent_id', ie.parent_id)
 
117
 
 
118
        e.tail = '\n'
 
119
 
 
120
        return e
 
121
 
 
122
 
 
123
    def _unpack_inventory(self, elt):
 
124
        """Construct from XML Element
 
125
        """
 
126
        assert elt.tag == 'inventory'
 
127
        root_id = elt.get('file_id') or ROOT_ID
 
128
        inv = Inventory(root_id)
 
129
        for e in elt:
 
130
            ie = self._unpack_entry(e)
 
131
            if ie.parent_id == ROOT_ID:
 
132
                ie.parent_id = root_id
 
133
            inv.add(ie)
 
134
        return inv
 
135
 
 
136
 
 
137
    def _unpack_entry(self, elt):
 
138
        assert elt.tag == 'entry'
 
139
 
 
140
        ## original format inventories don't have a parent_id for
 
141
        ## nodes in the root directory, but it's cleaner to use one
 
142
        ## internally.
 
143
        parent_id = elt.get('parent_id')
 
144
        if parent_id == None:
 
145
            parent_id = ROOT_ID
 
146
 
 
147
        ie = InventoryEntry(elt.get('file_id'),
 
148
                            elt.get('name'),
 
149
                            elt.get('kind'),
 
150
                            parent_id)
 
151
        ie.text_id = elt.get('text_id')
 
152
        ie.text_sha1 = elt.get('text_sha1')
 
153
 
 
154
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
155
 
 
156
        v = elt.get('text_size')
 
157
        ie.text_size = v and int(v)
 
158
 
 
159
        return ie
 
160
 
 
161
 
 
162
    def _pack_revision(self, rev):
 
163
        """Revision object -> xml tree"""
 
164
        root = Element('revision',
 
165
                       committer = rev.committer,
 
166
                       timestamp = '%.9f' % rev.timestamp,
 
167
                       revision_id = rev.revision_id,
 
168
                       inventory_id = rev.inventory_id,
 
169
                       inventory_sha1 = rev.inventory_sha1,
 
170
                       )
 
171
        if rev.timezone:
 
172
            root.set('timezone', str(rev.timezone))
 
173
        root.text = '\n'
 
174
 
 
175
        msg = SubElement(root, 'message')
 
176
        msg.text = rev.message
 
177
        msg.tail = '\n'
 
178
 
 
179
        if rev.parents:
 
180
            pelts = SubElement(root, 'parents')
 
181
            pelts.tail = pelts.text = '\n'
 
182
            for rr in rev.parents:
 
183
                assert isinstance(rr, RevisionReference)
 
184
                p = SubElement(pelts, 'revision_ref')
 
185
                p.tail = '\n'
 
186
                assert rr.revision_id
 
187
                p.set('revision_id', rr.revision_id)
 
188
                if rr.revision_sha1:
 
189
                    p.set('revision_sha1', rr.revision_sha1)
 
190
 
 
191
        return root
 
192
 
 
193
    
 
194
    def _unpack_revision(self, elt):
 
195
        """XML Element -> Revision object"""
 
196
        
 
197
        # <changeset> is deprecated...
 
198
        if elt.tag not in ('revision', 'changeset'):
 
199
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
200
 
 
201
        rev = Revision(committer = elt.get('committer'),
 
202
                       timestamp = float(elt.get('timestamp')),
 
203
                       revision_id = elt.get('revision_id'),
 
204
                       inventory_id = elt.get('inventory_id'),
 
205
                       inventory_sha1 = elt.get('inventory_sha1')
 
206
                       )
 
207
 
 
208
        precursor = elt.get('precursor')
 
209
        precursor_sha1 = elt.get('precursor_sha1')
 
210
 
 
211
        pelts = elt.find('parents')
 
212
 
 
213
        if pelts:
 
214
            for p in pelts:
 
215
                assert p.tag == 'revision_ref', \
 
216
                       "bad parent node tag %r" % p.tag
 
217
                rev_ref = RevisionReference(p.get('revision_id'),
 
218
                                            p.get('revision_sha1'))
 
219
                rev.parents.append(rev_ref)
 
220
 
 
221
            if precursor:
 
222
                # must be consistent
 
223
                prec_parent = rev.parents[0].revision_id
 
224
                assert prec_parent == precursor
 
225
        elif precursor:
 
226
            # revisions written prior to 0.0.5 have a single precursor
 
227
            # give as an attribute
 
228
            rev_ref = RevisionReference(precursor, precursor_sha1)
 
229
            rev.parents.append(rev_ref)
 
230
 
 
231
        v = elt.get('timezone')
 
232
        rev.timezone = v and int(v)
 
233
 
 
234
        rev.message = elt.findtext('message') # text of <message>
 
235
        return rev
 
236
 
 
237
 
 
238
 
 
239
 
 
240
"""singleton instance"""
 
241
serializer_v4 = _Serializer_v4()
 
242