← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml5.py

Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml5.py
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
5
 
 
 
7
#
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
11
# GNU General Public License for more details.
10
 
 
 
12
#
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
16
 
 
17
import cStringIO
 
18
import re
15
19
 
16
 
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
 
20
from bzrlib import (
 
21
    cache_utf8,
 
22
    errors,
 
23
    inventory,
 
24
    revision as _mod_revision,
 
25
    )
 
26
from bzrlib.xml_serializer import SubElement, Element, Serializer
17
27
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
18
 
import bzrlib.inventory as inventory
19
 
from bzrlib.revision import Revision        
 
28
from bzrlib.revision import Revision
20
29
from bzrlib.errors import BzrError
21
30
 
22
31
 
 
32
_utf8_re = None
 
33
_unicode_re = None
 
34
_xml_escape_map = {
 
35
    "&":'&',
 
36
    "'":"'", # FIXME: overkill
 
37
    "\"":""",
 
38
    "<":"&lt;",
 
39
    ">":"&gt;",
 
40
    }
 
41
 
 
42
 
 
43
def _ensure_utf8_re():
 
44
    """Make sure the _utf8_re and _unicode_re regexes have been compiled."""
 
45
    global _utf8_re, _unicode_re
 
46
    if _utf8_re is None:
 
47
        _utf8_re = re.compile('[&<>\'\"]|[\x80-\xff]+')
 
48
    if _unicode_re is None:
 
49
        _unicode_re = re.compile(u'[&<>\'\"\u0080-\uffff]')
 
50
 
 
51
 
 
52
def _unicode_escape_replace(match, _map=_xml_escape_map):
 
53
    """Replace a string of non-ascii, non XML safe characters with their escape
 
54
 
 
55
    This will escape both Standard XML escapes, like <>"', etc.
 
56
    As well as escaping non ascii characters, because ElementTree did.
 
57
    This helps us remain compatible to older versions of bzr. We may change
 
58
    our policy in the future, though.
 
59
    """
 
60
    # jam 20060816 Benchmarks show that try/KeyError is faster if you
 
61
    # expect the entity to rarely miss. There is about a 10% difference
 
62
    # in overall time. But if you miss frequently, then if None is much
 
63
    # faster. For our use case, we *rarely* have a revision id, file id
 
64
    # or path name that is unicode. So use try/KeyError.
 
65
    try:
 
66
        return _map[match.group()]
 
67
    except KeyError:
 
68
        return "&#%d;" % ord(match.group())
 
69
 
 
70
 
 
71
def _utf8_escape_replace(match, _map=_xml_escape_map):
 
72
    """Escape utf8 characters into XML safe ones.
 
73
 
 
74
    This uses 2 tricks. It is either escaping "standard" characters, like "&<>,
 
75
    or it is handling characters with the high-bit set. For ascii characters,
 
76
    we just lookup the replacement in the dictionary. For everything else, we
 
77
    decode back into Unicode, and then use the XML escape code.
 
78
    """
 
79
    try:
 
80
        return _map[match.group()]
 
81
    except KeyError:
 
82
        return ''.join('&#%d;' % ord(uni_chr)
 
83
                       for uni_chr in match.group().decode('utf8'))
 
84
 
 
85
 
 
86
_to_escaped_map = {}
 
87
 
 
88
def _encode_and_escape(unicode_or_utf8_str, _map=_to_escaped_map):
 
89
    """Encode the string into utf8, and escape invalid XML characters"""
 
90
    # We frequently get entities we have not seen before, so it is better
 
91
    # to check if None, rather than try/KeyError
 
92
    text = _map.get(unicode_or_utf8_str)
 
93
    if text is None:
 
94
        if unicode_or_utf8_str.__class__ == unicode:
 
95
            # The alternative policy is to do a regular UTF8 encoding
 
96
            # and then escape only XML meta characters.
 
97
            # Performance is equivalent once you use cache_utf8. *However*
 
98
            # this makes the serialized texts incompatible with old versions
 
99
            # of bzr. So no net gain. (Perhaps the read code would handle utf8
 
100
            # better than entity escapes, but cElementTree seems to do just fine
 
101
            # either way)
 
102
            text = str(_unicode_re.sub(_unicode_escape_replace,
 
103
                                       unicode_or_utf8_str)) + '"'
 
104
        else:
 
105
            # Plain strings are considered to already be in utf-8 so we do a
 
106
            # slightly different method for escaping.
 
107
            text = _utf8_re.sub(_utf8_escape_replace,
 
108
                                unicode_or_utf8_str) + '"'
 
109
        _map[unicode_or_utf8_str] = text
 
110
    return text
 
111
 
 
112
 
 
113
def _get_utf8_or_ascii(a_str,
 
114
                       _encode_utf8=cache_utf8.encode,
 
115
                       _get_cached_ascii=cache_utf8.get_cached_ascii):
 
116
    """Return a cached version of the string.
 
117
 
 
118
    cElementTree will return a plain string if the XML is plain ascii. It only
 
119
    returns Unicode when it needs to. We want to work in utf-8 strings. So if
 
120
    cElementTree returns a plain string, we can just return the cached version.
 
121
    If it is Unicode, then we need to encode it.
 
122
 
 
123
    :param a_str: An 8-bit string or Unicode as returned by
 
124
                  cElementTree.Element.get()
 
125
    :return: A utf-8 encoded 8-bit string.
 
126
    """
 
127
    # This is fairly optimized because we know what cElementTree does, this is
 
128
    # not meant as a generic function for all cases. Because it is possible for
 
129
    # an 8-bit string to not be ascii or valid utf8.
 
130
    if a_str.__class__ == unicode:
 
131
        return _encode_utf8(a_str)
 
132
    else:
 
133
        return _get_cached_ascii(a_str)
 
134
 
 
135
 
 
136
def _clear_cache():
 
137
    """Clean out the unicode => escaped map"""
 
138
    _to_escaped_map.clear()
 
139
 
 
140
 
23
141
class Serializer_v5(Serializer):
24
142
    """Version 5 serializer
25
143
 
27
145
    """
28
146
    
29
147
    __slots__ = []
30
 
    
31
 
    def _pack_inventory(self, inv):
32
 
        """Convert to XML Element"""
33
 
        e = Element('inventory',
34
 
                    format='5')
35
 
        e.text = '\n'
 
148
 
 
149
    root_id = ROOT_ID
 
150
    support_altered_by_hack = True
 
151
    # This format supports the altered-by hack that reads file ids directly out
 
152
    # of the versionedfile, without doing XML parsing.
 
153
 
 
154
    supported_kinds = set(['file', 'directory', 'symlink'])
 
155
    format_num = '5'
 
156
 
 
157
    def write_inventory_to_lines(self, inv):
 
158
        """Return a list of lines with the encoded inventory."""
 
159
        return self.write_inventory(inv, None)
 
160
 
 
161
    def write_inventory_to_string(self, inv, working=False):
 
162
        """Just call write_inventory with a StringIO and return the value.
 
163
 
 
164
        :param working: If True skip history data - text_sha1, text_size,
 
165
            reference_revision, symlink_target.
 
166
        """
 
167
        sio = cStringIO.StringIO()
 
168
        self.write_inventory(inv, sio, working)
 
169
        return sio.getvalue()
 
170
 
 
171
    def write_inventory(self, inv, f, working=False):
 
172
        """Write inventory to a file.
 
173
        
 
174
        :param inv: the inventory to write.
 
175
        :param f: the file to write. (May be None if the lines are the desired
 
176
            output).
 
177
        :param working: If True skip history data - text_sha1, text_size,
 
178
            reference_revision, symlink_target.
 
179
        :return: The inventory as a list of lines.
 
180
        """
 
181
        _ensure_utf8_re()
 
182
        output = []
 
183
        append = output.append
 
184
        self._append_inventory_root(append, inv)
 
185
        entries = inv.iter_entries()
 
186
        # Skip the root
 
187
        root_path, root_ie = entries.next()
 
188
        for path, ie in entries:
 
189
            if ie.parent_id != self.root_id:
 
190
                parent_str = ' parent_id="'
 
191
                parent_id  = _encode_and_escape(ie.parent_id)
 
192
            else:
 
193
                parent_str = ''
 
194
                parent_id  = ''
 
195
            if ie.kind == 'file':
 
196
                if ie.executable:
 
197
                    executable = ' executable="yes"'
 
198
                else:
 
199
                    executable = ''
 
200
                if not working:
 
201
                    append('<file%s file_id="%s name="%s%s%s revision="%s '
 
202
                        'text_sha1="%s" text_size="%d" />\n' % (
 
203
                        executable, _encode_and_escape(ie.file_id),
 
204
                        _encode_and_escape(ie.name), parent_str, parent_id,
 
205
                        _encode_and_escape(ie.revision), ie.text_sha1,
 
206
                        ie.text_size))
 
207
                else:
 
208
                    append('<file%s file_id="%s name="%s%s%s />\n' % (
 
209
                        executable, _encode_and_escape(ie.file_id),
 
210
                        _encode_and_escape(ie.name), parent_str, parent_id))
 
211
            elif ie.kind == 'directory':
 
212
                if not working:
 
213
                    append('<directory file_id="%s name="%s%s%s revision="%s '
 
214
                        '/>\n' % (
 
215
                        _encode_and_escape(ie.file_id),
 
216
                        _encode_and_escape(ie.name),
 
217
                        parent_str, parent_id,
 
218
                        _encode_and_escape(ie.revision)))
 
219
                else:
 
220
                    append('<directory file_id="%s name="%s%s%s />\n' % (
 
221
                        _encode_and_escape(ie.file_id),
 
222
                        _encode_and_escape(ie.name),
 
223
                        parent_str, parent_id))
 
224
            elif ie.kind == 'symlink':
 
225
                if not working:
 
226
                    append('<symlink file_id="%s name="%s%s%s revision="%s '
 
227
                        'symlink_target="%s />\n' % (
 
228
                        _encode_and_escape(ie.file_id),
 
229
                        _encode_and_escape(ie.name),
 
230
                        parent_str, parent_id,
 
231
                        _encode_and_escape(ie.revision),
 
232
                        _encode_and_escape(ie.symlink_target)))
 
233
                else:
 
234
                    append('<symlink file_id="%s name="%s%s%s />\n' % (
 
235
                        _encode_and_escape(ie.file_id),
 
236
                        _encode_and_escape(ie.name),
 
237
                        parent_str, parent_id))
 
238
            elif ie.kind == 'tree-reference':
 
239
                if ie.kind not in self.supported_kinds:
 
240
                    raise errors.UnsupportedInventoryKind(ie.kind)
 
241
                if not working:
 
242
                    append('<tree-reference file_id="%s name="%s%s%s '
 
243
                        'revision="%s reference_revision="%s />\n' % (
 
244
                        _encode_and_escape(ie.file_id),
 
245
                        _encode_and_escape(ie.name),
 
246
                        parent_str, parent_id,
 
247
                        _encode_and_escape(ie.revision),
 
248
                        _encode_and_escape(ie.reference_revision)))
 
249
                else:
 
250
                    append('<tree-reference file_id="%s name="%s%s%s />\n' % (
 
251
                        _encode_and_escape(ie.file_id),
 
252
                        _encode_and_escape(ie.name),
 
253
                        parent_str, parent_id))
 
254
            else:
 
255
                raise errors.UnsupportedInventoryKind(ie.kind)
 
256
        append('</inventory>\n')
 
257
        if f is not None:
 
258
            f.writelines(output)
 
259
        # Just to keep the cache from growing without bounds
 
260
        # but we may actually not want to do clear the cache
 
261
        #_clear_cache()
 
262
        return output
 
263
 
 
264
    def _append_inventory_root(self, append, inv):
 
265
        """Append the inventory root to output."""
36
266
        if inv.root.file_id not in (None, ROOT_ID):
37
 
            e.set('file_id', inv.root.file_id)
38
 
        for path, ie in inv.iter_entries():
39
 
            e.append(self._pack_entry(ie))
40
 
        return e
41
 
 
42
 
 
43
 
    def _pack_entry(self, ie):
44
 
        """Convert InventoryEntry to XML element"""
45
 
        if not InventoryEntry.versionable_kind(ie.kind):
46
 
            raise AssertionError('unsupported entry kind %s' % ie.kind)
47
 
        e = Element(ie.kind)
48
 
        e.set('name', ie.name)
49
 
        e.set('file_id', ie.file_id)
50
 
 
51
 
        if ie.text_size != None:
52
 
            e.set('text_size', '%d' % ie.text_size)
53
 
 
54
 
        for f in ['text_sha1', 'revision', 'symlink_target']:
55
 
            v = getattr(ie, f)
56
 
            if v != None:
57
 
                e.set(f, v)
58
 
 
59
 
        if ie.executable:
60
 
            e.set('executable', 'yes')
61
 
 
62
 
        # to be conservative, we don't externalize the root pointers
63
 
        # for now, leaving them as null in the xml form.  in a future
64
 
        # version it will be implied by nested elements.
65
 
        if ie.parent_id != ROOT_ID:
66
 
            assert isinstance(ie.parent_id, basestring)
67
 
            e.set('parent_id', ie.parent_id)
68
 
 
69
 
        e.tail = '\n'
70
 
 
71
 
        return e
72
 
 
73
 
 
 
267
            fileid1 = ' file_id="'
 
268
            fileid2 = _encode_and_escape(inv.root.file_id)
 
269
        else:
 
270
            fileid1 = ""
 
271
            fileid2 = ""
 
272
        if inv.revision_id is not None:
 
273
            revid1 = ' revision_id="'
 
274
            revid2 = _encode_and_escape(inv.revision_id)
 
275
        else:
 
276
            revid1 = ""
 
277
            revid2 = ""
 
278
        append('<inventory%s%s format="5"%s%s>\n' % (
 
279
            fileid1, fileid2, revid1, revid2))
 
280
        
74
281
    def _pack_revision(self, rev):
75
282
        """Revision object -> xml tree"""
 
283
        # For the XML format, we need to write them as Unicode rather than as
 
284
        # utf-8 strings. So that cElementTree can handle properly escaping
 
285
        # them.
 
286
        decode_utf8 = cache_utf8.decode
 
287
        revision_id = rev.revision_id
 
288
        if isinstance(revision_id, str):
 
289
            revision_id = decode_utf8(revision_id)
76
290
        root = Element('revision',
77
291
                       committer = rev.committer,
78
 
                       timestamp = '%.9f' % rev.timestamp,
79
 
                       revision_id = rev.revision_id,
 
292
                       timestamp = '%.3f' % rev.timestamp,
 
293
                       revision_id = revision_id,
80
294
                       inventory_sha1 = rev.inventory_sha1,
81
295
                       format='5',
82
296
                       )
83
 
        if rev.timezone:
 
297
        if rev.timezone is not None:
84
298
            root.set('timezone', str(rev.timezone))
85
299
        root.text = '\n'
86
300
        msg = SubElement(root, 'message')
91
305
            pelts.tail = pelts.text = '\n'
92
306
            for parent_id in rev.parent_ids:
93
307
                assert isinstance(parent_id, basestring)
 
308
                _mod_revision.check_not_reserved_id(parent_id)
94
309
                p = SubElement(pelts, 'revision_ref')
95
310
                p.tail = '\n'
 
311
                if isinstance(parent_id, str):
 
312
                    parent_id = decode_utf8(parent_id)
96
313
                p.set('revision_id', parent_id)
97
314
        if rev.properties:
98
315
            self._pack_revision_properties(rev, root)
99
316
        return root
100
317
 
101
 
 
102
318
    def _pack_revision_properties(self, rev, under_element):
103
319
        top_elt = SubElement(under_element, 'properties')
104
320
        for prop_name, prop_value in sorted(rev.properties.items()):
110
326
            prop_elt.tail = '\n'
111
327
        top_elt.tail = '\n'
112
328
 
113
 
 
114
329
    def _unpack_inventory(self, elt):
115
330
        """Construct from XML Element
116
331
        """
117
332
        assert elt.tag == 'inventory'
118
333
        root_id = elt.get('file_id') or ROOT_ID
 
334
        root_id = _get_utf8_or_ascii(root_id)
 
335
 
119
336
        format = elt.get('format')
120
337
        if format is not None:
121
338
            if format != '5':
122
339
                raise BzrError("invalid format version %r on inventory"
123
340
                                % format)
124
 
        inv = Inventory(root_id)
 
341
        revision_id = elt.get('revision_id')
 
342
        if revision_id is not None:
 
343
            revision_id = cache_utf8.encode(revision_id)
 
344
        inv = Inventory(root_id, revision_id=revision_id)
125
345
        for e in elt:
126
346
            ie = self._unpack_entry(e)
127
 
            if ie.parent_id == ROOT_ID:
 
347
            if ie.parent_id is None:
128
348
                ie.parent_id = root_id
129
349
            inv.add(ie)
130
350
        return inv
131
351
 
132
 
 
133
352
    def _unpack_entry(self, elt):
134
353
        kind = elt.tag
135
354
        if not InventoryEntry.versionable_kind(kind):
136
355
            raise AssertionError('unsupported entry kind %s' % kind)
137
356
 
 
357
        get_cached = _get_utf8_or_ascii
 
358
 
138
359
        parent_id = elt.get('parent_id')
139
 
        if parent_id == None:
140
 
            parent_id = ROOT_ID
 
360
        if parent_id is not None:
 
361
            parent_id = get_cached(parent_id)
 
362
        file_id = get_cached(elt.get('file_id'))
141
363
 
142
364
        if kind == 'directory':
143
 
            ie = inventory.InventoryDirectory(elt.get('file_id'),
 
365
            ie = inventory.InventoryDirectory(file_id,
144
366
                                              elt.get('name'),
145
367
                                              parent_id)
146
368
        elif kind == 'file':
147
 
            ie = inventory.InventoryFile(elt.get('file_id'),
 
369
            ie = inventory.InventoryFile(file_id,
148
370
                                         elt.get('name'),
149
371
                                         parent_id)
150
372
            ie.text_sha1 = elt.get('text_sha1')
153
375
            v = elt.get('text_size')
154
376
            ie.text_size = v and int(v)
155
377
        elif kind == 'symlink':
156
 
            ie = inventory.InventoryLink(elt.get('file_id'),
 
378
            ie = inventory.InventoryLink(file_id,
157
379
                                         elt.get('name'),
158
380
                                         parent_id)
159
381
            ie.symlink_target = elt.get('symlink_target')
160
382
        else:
161
 
            raise BzrError("unknown kind %r" % kind)
162
 
        ie.revision = elt.get('revision')
 
383
            raise errors.UnsupportedInventoryKind(kind)
 
384
        revision = elt.get('revision')
 
385
        if revision is not None:
 
386
            revision = get_cached(revision)
 
387
        ie.revision = revision
163
388
 
164
389
        return ie
165
390
 
166
 
 
167
391
    def _unpack_revision(self, elt):
168
392
        """XML Element -> Revision object"""
169
393
        assert elt.tag == 'revision'
172
396
            if format != '5':
173
397
                raise BzrError("invalid format version %r on inventory"
174
398
                                % format)
 
399
        get_cached = _get_utf8_or_ascii
175
400
        rev = Revision(committer = elt.get('committer'),
176
401
                       timestamp = float(elt.get('timestamp')),
177
 
                       revision_id = elt.get('revision_id'),
 
402
                       revision_id = get_cached(elt.get('revision_id')),
178
403
                       inventory_sha1 = elt.get('inventory_sha1')
179
404
                       )
180
405
        parents = elt.find('parents') or []
181
406
        for p in parents:
182
407
            assert p.tag == 'revision_ref', \
183
408
                   "bad parent node tag %r" % p.tag
184
 
            rev.parent_ids.append(p.get('revision_id'))
 
409
            rev.parent_ids.append(get_cached(p.get('revision_id')))
185
410
        self._unpack_revision_properties(elt, rev)
186
411
        v = elt.get('timezone')
187
 
        rev.timezone = v and int(v)
 
412
        if v is None:
 
413
            rev.timezone = 0
 
414
        else:
 
415
            rev.timezone = int(v)
188
416
        rev.message = elt.findtext('message') # text of <message>
189
417
        return rev
190
418
 
191
 
 
192
419
    def _unpack_revision_properties(self, elt, rev):
193
420
        """Unpack properties onto a revision."""
194
421
        props_elt = elt.find('properties')
197
424
            return
198
425
        for prop_elt in props_elt:
199
426
            assert prop_elt.tag == 'property', \
200
 
                "bad tag under properties list: %r" % p.tag
 
427
                "bad tag under properties list: %r" % prop_elt.tag
201
428
            name = prop_elt.get('name')
202
429
            value = prop_elt.text
 
430
            # If a property had an empty value ('') cElementTree reads
 
431
            # that back as None, convert it back to '', so that all
 
432
            # properties have string values
 
433
            if value is None:
 
434
                value = ''
203
435
            assert name not in rev.properties, \
204
 
                "repeated property %r" % p.name
 
436
                "repeated property %r" % name
205
437
            rev.properties[name] = value
206
438
 
207
439