← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml8.py

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml8.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
import cStringIO
18
18
import re
21
21
    cache_utf8,
22
22
    errors,
23
23
    inventory,
24
 
    )
25
 
from bzrlib.xml_serializer import SubElement, Element, Serializer
 
24
    revision as _mod_revision,
 
25
    trace,
 
26
    )
 
27
from bzrlib.xml_serializer import (
 
28
    Element,
 
29
    SubElement,
 
30
    XMLSerializer,
 
31
    escape_invalid_chars,
 
32
    )
26
33
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
27
34
from bzrlib.revision import Revision
28
35
from bzrlib.errors import BzrError
90
97
    # to check if None, rather than try/KeyError
91
98
    text = _map.get(unicode_or_utf8_str)
92
99
    if text is None:
93
 
        if unicode_or_utf8_str.__class__ == unicode:
 
100
        if unicode_or_utf8_str.__class__ is unicode:
94
101
            # The alternative policy is to do a regular UTF8 encoding
95
102
            # and then escape only XML meta characters.
96
103
            # Performance is equivalent once you use cache_utf8. *However*
126
133
    # This is fairly optimized because we know what cElementTree does, this is
127
134
    # not meant as a generic function for all cases. Because it is possible for
128
135
    # an 8-bit string to not be ascii or valid utf8.
129
 
    if a_str.__class__ == unicode:
 
136
    if a_str.__class__ is unicode:
130
137
        return _encode_utf8(a_str)
131
138
    else:
132
 
        return _get_cached_ascii(a_str)
 
139
        return intern(a_str)
133
140
 
134
141
 
135
142
def _clear_cache():
137
144
    _to_escaped_map.clear()
138
145
 
139
146
 
140
 
class Serializer_v5(Serializer):
141
 
    """Version 5 serializer
 
147
class Serializer_v8(XMLSerializer):
 
148
    """This serialiser adds rich roots.
142
149
 
143
 
    Packs objects into XML and vice versa.
 
150
    Its revision format number matches its inventory number.
144
151
    """
145
 
    
 
152
 
146
153
    __slots__ = []
147
154
 
 
155
    root_id = None
148
156
    support_altered_by_hack = True
149
157
    # This format supports the altered-by hack that reads file ids directly out
150
158
    # of the versionedfile, without doing XML parsing.
151
159
 
152
160
    supported_kinds = set(['file', 'directory', 'symlink'])
153
 
 
154
 
    def write_inventory_to_string(self, inv):
155
 
        """Just call write_inventory with a StringIO and return the value"""
 
161
    format_num = '8'
 
162
    revision_format_num = None
 
163
 
 
164
    def _check_revisions(self, inv):
 
165
        """Extension point for subclasses to check during serialisation.
 
166
 
 
167
        :param inv: An inventory about to be serialised, to be checked.
 
168
        :raises: AssertionError if an error has occurred.
 
169
        """
 
170
        if inv.revision_id is None:
 
171
            raise AssertionError("inv.revision_id is None")
 
172
        if inv.root.revision is None:
 
173
            raise AssertionError("inv.root.revision is None")
 
174
 
 
175
    def _check_cache_size(self, inv_size, entry_cache):
 
176
        """Check that the entry_cache is large enough.
 
177
 
 
178
        We want the cache to be ~2x the size of an inventory. The reason is
 
179
        because we use a FIFO cache, and how Inventory records are likely to
 
180
        change. In general, you have a small number of records which change
 
181
        often, and a lot of records which do not change at all. So when the
 
182
        cache gets full, you actually flush out a lot of the records you are
 
183
        interested in, which means you need to recreate all of those records.
 
184
        An LRU Cache would be better, but the overhead negates the cache
 
185
        coherency benefit.
 
186
 
 
187
        One way to look at it, only the size of the cache > len(inv) is your
 
188
        'working' set. And in general, it shouldn't be a problem to hold 2
 
189
        inventories in memory anyway.
 
190
 
 
191
        :param inv_size: The number of entries in an inventory.
 
192
        """
 
193
        if entry_cache is None:
 
194
            return
 
195
        # 1.5 times might also be reasonable.
 
196
        recommended_min_cache_size = inv_size * 1.5
 
197
        if entry_cache.cache_size() < recommended_min_cache_size:
 
198
            recommended_cache_size = inv_size * 2
 
199
            trace.mutter('Resizing the inventory entry cache from %d to %d',
 
200
                         entry_cache.cache_size(), recommended_cache_size)
 
201
            entry_cache.resize(recommended_cache_size)
 
202
 
 
203
    def write_inventory_to_lines(self, inv):
 
204
        """Return a list of lines with the encoded inventory."""
 
205
        return self.write_inventory(inv, None)
 
206
 
 
207
    def write_inventory_to_string(self, inv, working=False):
 
208
        """Just call write_inventory with a StringIO and return the value.
 
209
 
 
210
        :param working: If True skip history data - text_sha1, text_size,
 
211
            reference_revision, symlink_target.
 
212
        """
156
213
        sio = cStringIO.StringIO()
157
 
        self.write_inventory(inv, sio)
 
214
        self.write_inventory(inv, sio, working)
158
215
        return sio.getvalue()
159
216
 
160
 
    def write_inventory(self, inv, f):
 
217
    def write_inventory(self, inv, f, working=False):
161
218
        """Write inventory to a file.
162
 
        
 
219
 
163
220
        :param inv: the inventory to write.
164
 
        :param f: the file to write.
 
221
        :param f: the file to write. (May be None if the lines are the desired
 
222
            output).
 
223
        :param working: If True skip history data - text_sha1, text_size,
 
224
            reference_revision, symlink_target.
 
225
        :return: The inventory as a list of lines.
165
226
        """
166
227
        _ensure_utf8_re()
 
228
        self._check_revisions(inv)
167
229
        output = []
168
230
        append = output.append
169
231
        self._append_inventory_root(append, inv)
171
233
        # Skip the root
172
234
        root_path, root_ie = entries.next()
173
235
        for path, ie in entries:
174
 
            self._append_entry(append, ie)
 
236
            if ie.parent_id != self.root_id:
 
237
                parent_str = ' parent_id="'
 
238
                parent_id  = _encode_and_escape(ie.parent_id)
 
239
            else:
 
240
                parent_str = ''
 
241
                parent_id  = ''
 
242
            if ie.kind == 'file':
 
243
                if ie.executable:
 
244
                    executable = ' executable="yes"'
 
245
                else:
 
246
                    executable = ''
 
247
                if not working:
 
248
                    append('<file%s file_id="%s name="%s%s%s revision="%s '
 
249
                        'text_sha1="%s" text_size="%d" />\n' % (
 
250
                        executable, _encode_and_escape(ie.file_id),
 
251
                        _encode_and_escape(ie.name), parent_str, parent_id,
 
252
                        _encode_and_escape(ie.revision), ie.text_sha1,
 
253
                        ie.text_size))
 
254
                else:
 
255
                    append('<file%s file_id="%s name="%s%s%s />\n' % (
 
256
                        executable, _encode_and_escape(ie.file_id),
 
257
                        _encode_and_escape(ie.name), parent_str, parent_id))
 
258
            elif ie.kind == 'directory':
 
259
                if not working:
 
260
                    append('<directory file_id="%s name="%s%s%s revision="%s '
 
261
                        '/>\n' % (
 
262
                        _encode_and_escape(ie.file_id),
 
263
                        _encode_and_escape(ie.name),
 
264
                        parent_str, parent_id,
 
265
                        _encode_and_escape(ie.revision)))
 
266
                else:
 
267
                    append('<directory file_id="%s name="%s%s%s />\n' % (
 
268
                        _encode_and_escape(ie.file_id),
 
269
                        _encode_and_escape(ie.name),
 
270
                        parent_str, parent_id))
 
271
            elif ie.kind == 'symlink':
 
272
                if not working:
 
273
                    append('<symlink file_id="%s name="%s%s%s revision="%s '
 
274
                        'symlink_target="%s />\n' % (
 
275
                        _encode_and_escape(ie.file_id),
 
276
                        _encode_and_escape(ie.name),
 
277
                        parent_str, parent_id,
 
278
                        _encode_and_escape(ie.revision),
 
279
                        _encode_and_escape(ie.symlink_target)))
 
280
                else:
 
281
                    append('<symlink file_id="%s name="%s%s%s />\n' % (
 
282
                        _encode_and_escape(ie.file_id),
 
283
                        _encode_and_escape(ie.name),
 
284
                        parent_str, parent_id))
 
285
            elif ie.kind == 'tree-reference':
 
286
                if ie.kind not in self.supported_kinds:
 
287
                    raise errors.UnsupportedInventoryKind(ie.kind)
 
288
                if not working:
 
289
                    append('<tree-reference file_id="%s name="%s%s%s '
 
290
                        'revision="%s reference_revision="%s />\n' % (
 
291
                        _encode_and_escape(ie.file_id),
 
292
                        _encode_and_escape(ie.name),
 
293
                        parent_str, parent_id,
 
294
                        _encode_and_escape(ie.revision),
 
295
                        _encode_and_escape(ie.reference_revision)))
 
296
                else:
 
297
                    append('<tree-reference file_id="%s name="%s%s%s />\n' % (
 
298
                        _encode_and_escape(ie.file_id),
 
299
                        _encode_and_escape(ie.name),
 
300
                        parent_str, parent_id))
 
301
            else:
 
302
                raise errors.UnsupportedInventoryKind(ie.kind)
175
303
        append('</inventory>\n')
176
 
        f.writelines(output)
 
304
        if f is not None:
 
305
            f.writelines(output)
177
306
        # Just to keep the cache from growing without bounds
178
307
        # but we may actually not want to do clear the cache
179
308
        #_clear_cache()
 
309
        return output
180
310
 
181
311
    def _append_inventory_root(self, append, inv):
182
312
        """Append the inventory root to output."""
183
 
        append('<inventory')
184
 
        if inv.root.file_id not in (None, ROOT_ID):
185
 
            append(' file_id="')
186
 
            append(_encode_and_escape(inv.root.file_id))
187
 
        append(' format="5"')
188
313
        if inv.revision_id is not None:
189
 
            append(' revision_id="')
190
 
            append(_encode_and_escape(inv.revision_id))
191
 
        append('>\n')
192
 
        
193
 
    def _append_entry(self, append, ie):
194
 
        """Convert InventoryEntry to XML element and append to output."""
195
 
        # TODO: should just be a plain assertion
196
 
        if ie.kind not in self.supported_kinds:
197
 
            raise errors.UnsupportedInventoryKind(ie.kind)
198
 
 
199
 
        append("<")
200
 
        append(ie.kind)
201
 
        if ie.executable:
202
 
            append(' executable="yes"')
203
 
        append(' file_id="')
204
 
        append(_encode_and_escape(ie.file_id))
205
 
        append(' name="')
206
 
        append(_encode_and_escape(ie.name))
207
 
        if self._parent_condition(ie):
208
 
            assert isinstance(ie.parent_id, basestring)
209
 
            append(' parent_id="')
210
 
            append(_encode_and_escape(ie.parent_id))
211
 
        if ie.revision is not None:
212
 
            append(' revision="')
213
 
            append(_encode_and_escape(ie.revision))
214
 
        if ie.symlink_target is not None:
215
 
            append(' symlink_target="')
216
 
            append(_encode_and_escape(ie.symlink_target))
217
 
        if ie.text_sha1 is not None:
218
 
            append(' text_sha1="')
219
 
            append(ie.text_sha1)
220
 
            append('"')
221
 
        if ie.text_size is not None:
222
 
            append(' text_size="%d"' % ie.text_size)
223
 
        if getattr(ie, 'reference_revision', None) is not None:
224
 
            append(' reference_revision="')
225
 
            append(_encode_and_escape(ie.reference_revision))
226
 
        append(" />\n")
227
 
        return
228
 
 
229
 
    def _parent_condition(self, ie):
230
 
        return ie.parent_id != ROOT_ID
 
314
            revid1 = ' revision_id="'
 
315
            revid2 = _encode_and_escape(inv.revision_id)
 
316
        else:
 
317
            revid1 = ""
 
318
            revid2 = ""
 
319
        append('<inventory format="%s"%s%s>\n' % (
 
320
            self.format_num, revid1, revid2))
 
321
        append('<directory file_id="%s name="%s revision="%s />\n' % (
 
322
            _encode_and_escape(inv.root.file_id),
 
323
            _encode_and_escape(inv.root.name),
 
324
            _encode_and_escape(inv.root.revision)))
231
325
 
232
326
    def _pack_revision(self, rev):
233
327
        """Revision object -> xml tree"""
238
332
        revision_id = rev.revision_id
239
333
        if isinstance(revision_id, str):
240
334
            revision_id = decode_utf8(revision_id)
 
335
        format_num = self.format_num
 
336
        if self.revision_format_num is not None:
 
337
            format_num = self.revision_format_num
241
338
        root = Element('revision',
242
339
                       committer = rev.committer,
243
340
                       timestamp = '%.3f' % rev.timestamp,
244
341
                       revision_id = revision_id,
245
342
                       inventory_sha1 = rev.inventory_sha1,
246
 
                       format='5',
 
343
                       format=format_num,
247
344
                       )
248
345
        if rev.timezone is not None:
249
346
            root.set('timezone', str(rev.timezone))
250
347
        root.text = '\n'
251
348
        msg = SubElement(root, 'message')
252
 
        msg.text = rev.message
 
349
        msg.text = escape_invalid_chars(rev.message)[0]
253
350
        msg.tail = '\n'
254
351
        if rev.parent_ids:
255
352
            pelts = SubElement(root, 'parents')
256
353
            pelts.tail = pelts.text = '\n'
257
354
            for parent_id in rev.parent_ids:
258
 
                assert isinstance(parent_id, basestring)
 
355
                _mod_revision.check_not_reserved_id(parent_id)
259
356
                p = SubElement(pelts, 'revision_ref')
260
357
                p.tail = '\n'
261
358
                if isinstance(parent_id, str):
268
365
    def _pack_revision_properties(self, rev, under_element):
269
366
        top_elt = SubElement(under_element, 'properties')
270
367
        for prop_name, prop_value in sorted(rev.properties.items()):
271
 
            assert isinstance(prop_name, basestring) 
272
 
            assert isinstance(prop_value, basestring) 
273
368
            prop_elt = SubElement(top_elt, 'property')
274
369
            prop_elt.set('name', prop_name)
275
370
            prop_elt.text = prop_value
276
371
            prop_elt.tail = '\n'
277
372
        top_elt.tail = '\n'
278
373
 
279
 
    def _unpack_inventory(self, elt):
280
 
        """Construct from XML Element
281
 
        """
282
 
        assert elt.tag == 'inventory'
283
 
        root_id = elt.get('file_id') or ROOT_ID
284
 
        root_id = _get_utf8_or_ascii(root_id)
285
 
 
 
374
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
 
375
                          return_from_cache=False):
 
376
        """Construct from XML Element"""
 
377
        if elt.tag != 'inventory':
 
378
            raise errors.UnexpectedInventoryFormat('Root tag is %r' % elt.tag)
286
379
        format = elt.get('format')
287
 
        if format is not None:
288
 
            if format != '5':
289
 
                raise BzrError("invalid format version %r on inventory"
290
 
                                % format)
 
380
        if format != self.format_num:
 
381
            raise errors.UnexpectedInventoryFormat('Invalid format version %r'
 
382
                                                   % format)
291
383
        revision_id = elt.get('revision_id')
292
384
        if revision_id is not None:
293
385
            revision_id = cache_utf8.encode(revision_id)
294
 
        inv = Inventory(root_id, revision_id=revision_id)
 
386
        inv = inventory.Inventory(root_id=None, revision_id=revision_id)
295
387
        for e in elt:
296
 
            ie = self._unpack_entry(e)
297
 
            if ie.parent_id is None:
298
 
                ie.parent_id = root_id
 
388
            ie = self._unpack_entry(e, entry_cache=entry_cache,
 
389
                                    return_from_cache=return_from_cache)
299
390
            inv.add(ie)
 
391
        self._check_cache_size(len(inv), entry_cache)
300
392
        return inv
301
393
 
302
 
    def _unpack_entry(self, elt):
 
394
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
 
395
        elt_get = elt.get
 
396
        file_id = elt_get('file_id')
 
397
        revision = elt_get('revision')
 
398
        # Check and see if we have already unpacked this exact entry
 
399
        # Some timings for "repo.revision_trees(last_100_revs)"
 
400
        #               bzr     mysql
 
401
        #   unmodified  4.1s    40.8s
 
402
        #   using lru   3.5s
 
403
        #   using fifo  2.83s   29.1s
 
404
        #   lru._cache  2.8s
 
405
        #   dict        2.75s   26.8s
 
406
        #   inv.add     2.5s    26.0s
 
407
        #   no_copy     2.00s   20.5s
 
408
        #   no_c,dict   1.95s   18.0s
 
409
        # Note that a cache of 10k nodes is more than sufficient to hold all of
 
410
        # the inventory for the last 100 revs for bzr, but not for mysql (20k
 
411
        # is enough for mysql, which saves the same 2s as using a dict)
 
412
 
 
413
        # Breakdown of mysql using time.clock()
 
414
        #   4.1s    2 calls to element.get for file_id, revision_id
 
415
        #   4.5s    cache_hit lookup
 
416
        #   7.1s    InventoryFile.copy()
 
417
        #   2.4s    InventoryDirectory.copy()
 
418
        #   0.4s    decoding unique entries
 
419
        #   1.6s    decoding entries after FIFO fills up
 
420
        #   0.8s    Adding nodes to FIFO (including flushes)
 
421
        #   0.1s    cache miss lookups
 
422
        # Using an LRU cache
 
423
        #   4.1s    2 calls to element.get for file_id, revision_id
 
424
        #   9.9s    cache_hit lookup
 
425
        #   10.8s   InventoryEntry.copy()
 
426
        #   0.3s    cache miss lookus
 
427
        #   1.2s    decoding entries
 
428
        #   1.0s    adding nodes to LRU
 
429
        if entry_cache is not None and revision is not None:
 
430
            key = (file_id, revision)
 
431
            try:
 
432
                # We copy it, because some operations may mutate it
 
433
                cached_ie = entry_cache[key]
 
434
            except KeyError:
 
435
                pass
 
436
            else:
 
437
                # Only copying directory entries drops us 2.85s => 2.35s
 
438
                if return_from_cache:
 
439
                    if cached_ie.kind == 'directory':
 
440
                        return cached_ie.copy()
 
441
                    return cached_ie
 
442
                return cached_ie.copy()
 
443
 
303
444
        kind = elt.tag
304
445
        if not InventoryEntry.versionable_kind(kind):
305
446
            raise AssertionError('unsupported entry kind %s' % kind)
306
447
 
307
448
        get_cached = _get_utf8_or_ascii
308
449
 
309
 
        parent_id = elt.get('parent_id')
 
450
        file_id = get_cached(file_id)
 
451
        if revision is not None:
 
452
            revision = get_cached(revision)
 
453
        parent_id = elt_get('parent_id')
310
454
        if parent_id is not None:
311
455
            parent_id = get_cached(parent_id)
312
 
        file_id = get_cached(elt.get('file_id'))
313
456
 
314
457
        if kind == 'directory':
315
458
            ie = inventory.InventoryDirectory(file_id,
316
 
                                              elt.get('name'),
 
459
                                              elt_get('name'),
317
460
                                              parent_id)
318
461
        elif kind == 'file':
319
462
            ie = inventory.InventoryFile(file_id,
320
 
                                         elt.get('name'),
 
463
                                         elt_get('name'),
321
464
                                         parent_id)
322
 
            ie.text_sha1 = elt.get('text_sha1')
323
 
            if elt.get('executable') == 'yes':
 
465
            ie.text_sha1 = elt_get('text_sha1')
 
466
            if elt_get('executable') == 'yes':
324
467
                ie.executable = True
325
 
            v = elt.get('text_size')
 
468
            v = elt_get('text_size')
326
469
            ie.text_size = v and int(v)
327
470
        elif kind == 'symlink':
328
471
            ie = inventory.InventoryLink(file_id,
329
 
                                         elt.get('name'),
 
472
                                         elt_get('name'),
330
473
                                         parent_id)
331
 
            ie.symlink_target = elt.get('symlink_target')
 
474
            ie.symlink_target = elt_get('symlink_target')
332
475
        else:
333
476
            raise errors.UnsupportedInventoryKind(kind)
334
 
        revision = elt.get('revision')
335
 
        if revision is not None:
336
 
            revision = get_cached(revision)
337
477
        ie.revision = revision
 
478
        if revision is not None and entry_cache is not None:
 
479
            # We cache a copy() because callers like to mutate objects, and
 
480
            # that would cause the item in cache to mutate as well.
 
481
            # This has a small effect on many-inventory performance, because
 
482
            # the majority fraction is spent in cache hits, not misses.
 
483
            entry_cache[key] = ie.copy()
338
484
 
339
485
        return ie
340
486
 
341
487
    def _unpack_revision(self, elt):
342
488
        """XML Element -> Revision object"""
343
 
        assert elt.tag == 'revision'
344
489
        format = elt.get('format')
 
490
        format_num = self.format_num
 
491
        if self.revision_format_num is not None:
 
492
            format_num = self.revision_format_num
345
493
        if format is not None:
346
 
            if format != '5':
347
 
                raise BzrError("invalid format version %r on inventory"
 
494
            if format != format_num:
 
495
                raise BzrError("invalid format version %r on revision"
348
496
                                % format)
349
497
        get_cached = _get_utf8_or_ascii
350
498
        rev = Revision(committer = elt.get('committer'),
354
502
                       )
355
503
        parents = elt.find('parents') or []
356
504
        for p in parents:
357
 
            assert p.tag == 'revision_ref', \
358
 
                   "bad parent node tag %r" % p.tag
359
505
            rev.parent_ids.append(get_cached(p.get('revision_id')))
360
506
        self._unpack_revision_properties(elt, rev)
361
507
        v = elt.get('timezone')
369
515
    def _unpack_revision_properties(self, elt, rev):
370
516
        """Unpack properties onto a revision."""
371
517
        props_elt = elt.find('properties')
372
 
        assert len(rev.properties) == 0
373
518
        if not props_elt:
374
519
            return
375
520
        for prop_elt in props_elt:
376
 
            assert prop_elt.tag == 'property', \
377
 
                "bad tag under properties list: %r" % prop_elt.tag
 
521
            if prop_elt.tag != 'property':
 
522
                raise AssertionError(
 
523
                    "bad tag under properties list: %r" % prop_elt.tag)
378
524
            name = prop_elt.get('name')
379
525
            value = prop_elt.text
380
526
            # If a property had an empty value ('') cElementTree reads
382
528
            # properties have string values
383
529
            if value is None:
384
530
                value = ''
385
 
            assert name not in rev.properties, \
386
 
                "repeated property %r" % name
 
531
            if name in rev.properties:
 
532
                raise AssertionError("repeated property %r" % name)
387
533
            rev.properties[name] = value
388
534
 
389
535
 
390
 
serializer_v5 = Serializer_v5()
 
536
serializer_v8 = Serializer_v8()