~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.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:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
 
19
import cStringIO
21
20
import re
22
21
import time
23
22
 
24
23
from bzrlib import (
25
24
    bzrdir,
26
25
    check,
 
26
    chk_map,
 
27
    config,
27
28
    debug,
28
29
    errors,
 
30
    fetch as _mod_fetch,
 
31
    fifo_cache,
29
32
    generate_ids,
30
33
    gpg,
31
34
    graph,
 
35
    inventory,
 
36
    inventory_delta,
32
37
    lazy_regex,
33
38
    lockable_files,
34
39
    lockdir,
35
40
    lru_cache,
36
41
    osutils,
37
 
    registry,
38
 
    remote,
39
42
    revision as _mod_revision,
40
43
    symbol_versioning,
41
 
    transactions,
 
44
    trace,
42
45
    tsort,
43
46
    ui,
 
47
    versionedfile,
44
48
    )
45
49
from bzrlib.bundle import serializer
46
50
from bzrlib.revisiontree import RevisionTree
47
51
from bzrlib.store.versioned import VersionedFileStore
48
 
from bzrlib.store.text import TextStore
49
52
from bzrlib.testament import Testament
50
 
from bzrlib.util import bencode
51
53
""")
52
54
 
53
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
55
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
54
56
from bzrlib.inter import InterObject
55
 
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
56
 
from bzrlib.symbol_versioning import (
57
 
        deprecated_method,
58
 
        one_one,
59
 
        one_two,
60
 
        one_three,
61
 
        one_six,
62
 
        )
63
 
from bzrlib.trace import mutter, mutter_callsite, note, warning
 
57
from bzrlib.inventory import (
 
58
    Inventory,
 
59
    InventoryDirectory,
 
60
    ROOT_ID,
 
61
    entry_factory,
 
62
    )
 
63
from bzrlib.lock import _RelockDebugMixin
 
64
from bzrlib import registry
 
65
from bzrlib.trace import (
 
66
    log_exception_quietly, note, mutter, mutter_callsite, warning)
64
67
 
65
68
 
66
69
# Old formats display a warning, but only once
70
73
class CommitBuilder(object):
71
74
    """Provides an interface to build up a commit.
72
75
 
73
 
    This allows describing a tree to be committed without needing to 
 
76
    This allows describing a tree to be committed without needing to
74
77
    know the internals of the format of the repository.
75
78
    """
76
 
    
 
79
 
77
80
    # all clients should supply tree roots.
78
81
    record_root_entry = True
79
82
    # the default CommitBuilder does not manage trees whose root is versioned.
107
110
 
108
111
        self._revprops = {}
109
112
        if revprops is not None:
 
113
            self._validate_revprops(revprops)
110
114
            self._revprops.update(revprops)
111
115
 
112
116
        if timestamp is None:
121
125
 
122
126
        self._generate_revision_if_needed()
123
127
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
128
        self._basis_delta = []
 
129
        # API compatibility, older code that used CommitBuilder did not call
 
130
        # .record_delete(), which means the delta that is computed would not be
 
131
        # valid. Callers that will call record_delete() should call
 
132
        # .will_record_deletes() to indicate that.
 
133
        self._recording_deletes = False
 
134
        # memo'd check for no-op commits.
 
135
        self._any_changes = False
 
136
 
 
137
    def any_changes(self):
 
138
        """Return True if any entries were changed.
 
139
        
 
140
        This includes merge-only changes. It is the core for the --unchanged
 
141
        detection in commit.
 
142
 
 
143
        :return: True if any changes have occured.
 
144
        """
 
145
        return self._any_changes
 
146
 
 
147
    def _validate_unicode_text(self, text, context):
 
148
        """Verify things like commit messages don't have bogus characters."""
 
149
        if '\r' in text:
 
150
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
151
 
 
152
    def _validate_revprops(self, revprops):
 
153
        for key, value in revprops.iteritems():
 
154
            # We know that the XML serializers do not round trip '\r'
 
155
            # correctly, so refuse to accept them
 
156
            if not isinstance(value, basestring):
 
157
                raise ValueError('revision property (%s) is not a valid'
 
158
                                 ' (unicode) string: %r' % (key, value))
 
159
            self._validate_unicode_text(value,
 
160
                                        'revision property (%s)' % (key,))
124
161
 
125
162
    def commit(self, message):
126
163
        """Make the actual commit.
127
164
 
128
165
        :return: The revision id of the recorded revision.
129
166
        """
 
167
        self._validate_unicode_text(message, 'commit message')
130
168
        rev = _mod_revision.Revision(
131
169
                       timestamp=self._timestamp,
132
170
                       timezone=self._timezone,
155
193
        deserializing the inventory, while we already have a copy in
156
194
        memory.
157
195
        """
 
196
        if self.new_inventory is None:
 
197
            self.new_inventory = self.repository.get_inventory(
 
198
                self._new_revision_id)
158
199
        return RevisionTree(self.repository, self.new_inventory,
159
 
                            self._new_revision_id)
 
200
            self._new_revision_id)
160
201
 
161
202
    def finish_inventory(self):
162
 
        """Tell the builder that the inventory is finished."""
163
 
        if self.new_inventory.root is None:
164
 
            raise AssertionError('Root entry should be supplied to'
165
 
                ' record_entry_contents, as of bzr 0.10.')
166
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
167
 
        self.new_inventory.revision_id = self._new_revision_id
168
 
        self.inv_sha1 = self.repository.add_inventory(
169
 
            self._new_revision_id,
170
 
            self.new_inventory,
171
 
            self.parents
172
 
            )
 
203
        """Tell the builder that the inventory is finished.
 
204
 
 
205
        :return: The inventory id in the repository, which can be used with
 
206
            repository.get_inventory.
 
207
        """
 
208
        if self.new_inventory is None:
 
209
            # an inventory delta was accumulated without creating a new
 
210
            # inventory.
 
211
            basis_id = self.basis_delta_revision
 
212
            # We ignore the 'inventory' returned by add_inventory_by_delta
 
213
            # because self.new_inventory is used to hint to the rest of the
 
214
            # system what code path was taken
 
215
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
216
                basis_id, self._basis_delta, self._new_revision_id,
 
217
                self.parents)
 
218
        else:
 
219
            if self.new_inventory.root is None:
 
220
                raise AssertionError('Root entry should be supplied to'
 
221
                    ' record_entry_contents, as of bzr 0.10.')
 
222
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
223
            self.new_inventory.revision_id = self._new_revision_id
 
224
            self.inv_sha1 = self.repository.add_inventory(
 
225
                self._new_revision_id,
 
226
                self.new_inventory,
 
227
                self.parents
 
228
                )
 
229
        return self._new_revision_id
173
230
 
174
231
    def _gen_revision_id(self):
175
232
        """Return new revision-id."""
178
235
 
179
236
    def _generate_revision_if_needed(self):
180
237
        """Create a revision id if None was supplied.
181
 
        
 
238
 
182
239
        If the repository can not support user-specified revision ids
183
240
        they should override this function and raise CannotSetRevisionId
184
241
        if _new_revision_id is not None.
212
269
        # _new_revision_id
213
270
        ie.revision = self._new_revision_id
214
271
 
 
272
    def _require_root_change(self, tree):
 
273
        """Enforce an appropriate root object change.
 
274
 
 
275
        This is called once when record_iter_changes is called, if and only if
 
276
        the root was not in the delta calculated by record_iter_changes.
 
277
 
 
278
        :param tree: The tree which is being committed.
 
279
        """
 
280
        # NB: if there are no parents then this method is not called, so no
 
281
        # need to guard on parents having length.
 
282
        entry = entry_factory['directory'](tree.path2id(''), '',
 
283
            None)
 
284
        entry.revision = self._new_revision_id
 
285
        self._basis_delta.append(('', '', entry.file_id, entry))
 
286
 
215
287
    def _get_delta(self, ie, basis_inv, path):
216
288
        """Get a delta against the basis inventory for ie."""
217
289
        if ie.file_id not in basis_inv:
218
290
            # add
219
 
            return (None, path, ie.file_id, ie)
 
291
            result = (None, path, ie.file_id, ie)
 
292
            self._basis_delta.append(result)
 
293
            return result
220
294
        elif ie != basis_inv[ie.file_id]:
221
295
            # common but altered
222
296
            # TODO: avoid tis id2path call.
223
 
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
297
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
298
            self._basis_delta.append(result)
 
299
            return result
224
300
        else:
225
301
            # common, unaltered
226
302
            return None
227
303
 
 
304
    def get_basis_delta(self):
 
305
        """Return the complete inventory delta versus the basis inventory.
 
306
 
 
307
        This has been built up with the calls to record_delete and
 
308
        record_entry_contents. The client must have already called
 
309
        will_record_deletes() to indicate that they will be generating a
 
310
        complete delta.
 
311
 
 
312
        :return: An inventory delta, suitable for use with apply_delta, or
 
313
            Repository.add_inventory_by_delta, etc.
 
314
        """
 
315
        if not self._recording_deletes:
 
316
            raise AssertionError("recording deletes not activated.")
 
317
        return self._basis_delta
 
318
 
 
319
    def record_delete(self, path, file_id):
 
320
        """Record that a delete occured against a basis tree.
 
321
 
 
322
        This is an optional API - when used it adds items to the basis_delta
 
323
        being accumulated by the commit builder. It cannot be called unless the
 
324
        method will_record_deletes() has been called to inform the builder that
 
325
        a delta is being supplied.
 
326
 
 
327
        :param path: The path of the thing deleted.
 
328
        :param file_id: The file id that was deleted.
 
329
        """
 
330
        if not self._recording_deletes:
 
331
            raise AssertionError("recording deletes not activated.")
 
332
        delta = (path, None, file_id, None)
 
333
        self._basis_delta.append(delta)
 
334
        self._any_changes = True
 
335
        return delta
 
336
 
 
337
    def will_record_deletes(self):
 
338
        """Tell the commit builder that deletes are being notified.
 
339
 
 
340
        This enables the accumulation of an inventory delta; for the resulting
 
341
        commit to be valid, deletes against the basis MUST be recorded via
 
342
        builder.record_delete().
 
343
        """
 
344
        self._recording_deletes = True
 
345
        try:
 
346
            basis_id = self.parents[0]
 
347
        except IndexError:
 
348
            basis_id = _mod_revision.NULL_REVISION
 
349
        self.basis_delta_revision = basis_id
 
350
 
228
351
    def record_entry_contents(self, ie, parent_invs, path, tree,
229
352
        content_summary):
230
353
        """Record the content of ie from tree into the commit if needed.
235
358
        :param parent_invs: The inventories of the parent revisions of the
236
359
            commit.
237
360
        :param path: The path the entry is at in the tree.
238
 
        :param tree: The tree which contains this entry and should be used to 
 
361
        :param tree: The tree which contains this entry and should be used to
239
362
            obtain content.
240
363
        :param content_summary: Summary data from the tree about the paths
241
364
            content - stat, length, exec, sha/link target. This is only
242
365
            accessed when the entry has a revision of None - that is when it is
243
366
            a candidate to commit.
244
 
        :return: A tuple (change_delta, version_recorded). change_delta is 
245
 
            an inventory_delta change for this entry against the basis tree of
246
 
            the commit, or None if no change occured against the basis tree.
 
367
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
368
            change_delta is an inventory_delta change for this entry against
 
369
            the basis tree of the commit, or None if no change occured against
 
370
            the basis tree.
247
371
            version_recorded is True if a new version of the entry has been
248
372
            recorded. For instance, committing a merge where a file was only
249
373
            changed on the other side will return (delta, False).
 
374
            fs_hash is either None, or the hash details for the path (currently
 
375
            a tuple of the contents sha1 and the statvalue returned by
 
376
            tree.get_file_with_stat()).
250
377
        """
251
378
        if self.new_inventory.root is None:
252
379
            if ie.parent_id is not None:
278
405
        if ie.revision is not None:
279
406
            if not self._versioned_root and path == '':
280
407
                # repositories that do not version the root set the root's
281
 
                # revision to the new commit even when no change occurs, and
282
 
                # this masks when a change may have occurred against the basis,
283
 
                # so calculate if one happened.
 
408
                # revision to the new commit even when no change occurs (more
 
409
                # specifically, they do not record a revision on the root; and
 
410
                # the rev id is assigned to the root during deserialisation -
 
411
                # this masks when a change may have occurred against the basis.
 
412
                # To match this we always issue a delta, because the revision
 
413
                # of the root will always be changing.
284
414
                if ie.file_id in basis_inv:
285
415
                    delta = (basis_inv.id2path(ie.file_id), path,
286
416
                        ie.file_id, ie)
287
417
                else:
288
418
                    # add
289
419
                    delta = (None, path, ie.file_id, ie)
290
 
                return delta, False
 
420
                self._basis_delta.append(delta)
 
421
                return delta, False, None
291
422
            else:
292
423
                # we don't need to commit this, because the caller already
293
424
                # determined that an existing revision of this file is
298
429
                    raise AssertionError("Impossible situation, a skipped "
299
430
                        "inventory entry (%r) claims to be modified in this "
300
431
                        "commit (%r).", (ie, self._new_revision_id))
301
 
                return None, False
 
432
                return None, False, None
302
433
        # XXX: Friction: parent_candidates should return a list not a dict
303
434
        #      so that we don't have to walk the inventories again.
304
435
        parent_candiate_entries = ie.parent_candidates(parent_invs)
334
465
            # if the kind changed the content obviously has
335
466
            if kind != parent_entry.kind:
336
467
                store = True
 
468
        # Stat cache fingerprint feedback for the caller - None as we usually
 
469
        # don't generate one.
 
470
        fingerprint = None
337
471
        if kind == 'file':
338
472
            if content_summary[2] is None:
339
473
                raise ValueError("Files must not have executable = None")
340
474
            if not store:
341
 
                if (# if the file length changed we have to store:
342
 
                    parent_entry.text_size != content_summary[1] or
343
 
                    # if the exec bit has changed we have to store:
 
475
                # We can't trust a check of the file length because of content
 
476
                # filtering...
 
477
                if (# if the exec bit has changed we have to store:
344
478
                    parent_entry.executable != content_summary[2]):
345
479
                    store = True
346
480
                elif parent_entry.text_sha1 == content_summary[3]:
350
484
                    ie.text_size = parent_entry.text_size
351
485
                    ie.text_sha1 = parent_entry.text_sha1
352
486
                    ie.executable = parent_entry.executable
353
 
                    return self._get_delta(ie, basis_inv, path), False
 
487
                    return self._get_delta(ie, basis_inv, path), False, None
354
488
                else:
355
489
                    # Either there is only a hash change(no hash cache entry,
356
490
                    # or same size content change), or there is no change on
363
497
                # absence of a content change in the file.
364
498
                nostore_sha = None
365
499
            ie.executable = content_summary[2]
366
 
            lines = tree.get_file(ie.file_id, path).readlines()
 
500
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
501
            try:
 
502
                text = file_obj.read()
 
503
            finally:
 
504
                file_obj.close()
367
505
            try:
368
506
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
369
 
                    ie.file_id, lines, heads, nostore_sha)
 
507
                    ie.file_id, text, heads, nostore_sha)
 
508
                # Let the caller know we generated a stat fingerprint.
 
509
                fingerprint = (ie.text_sha1, stat_value)
370
510
            except errors.ExistingContent:
371
511
                # Turns out that the file content was unchanged, and we were
372
512
                # only going to store a new node if it was changed. Carry over
375
515
                ie.text_size = parent_entry.text_size
376
516
                ie.text_sha1 = parent_entry.text_sha1
377
517
                ie.executable = parent_entry.executable
378
 
                return self._get_delta(ie, basis_inv, path), False
 
518
                return self._get_delta(ie, basis_inv, path), False, None
379
519
        elif kind == 'directory':
380
520
            if not store:
381
521
                # all data is meta here, nothing specific to directory, so
382
522
                # carry over:
383
523
                ie.revision = parent_entry.revision
384
 
                return self._get_delta(ie, basis_inv, path), False
385
 
            lines = []
386
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
524
                return self._get_delta(ie, basis_inv, path), False, None
 
525
            self._add_text_to_weave(ie.file_id, '', heads, None)
387
526
        elif kind == 'symlink':
388
527
            current_link_target = content_summary[3]
389
528
            if not store:
395
534
                # unchanged, carry over.
396
535
                ie.revision = parent_entry.revision
397
536
                ie.symlink_target = parent_entry.symlink_target
398
 
                return self._get_delta(ie, basis_inv, path), False
 
537
                return self._get_delta(ie, basis_inv, path), False, None
399
538
            ie.symlink_target = current_link_target
400
 
            lines = []
401
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
539
            self._add_text_to_weave(ie.file_id, '', heads, None)
402
540
        elif kind == 'tree-reference':
403
541
            if not store:
404
542
                if content_summary[3] != parent_entry.reference_revision:
407
545
                # unchanged, carry over.
408
546
                ie.reference_revision = parent_entry.reference_revision
409
547
                ie.revision = parent_entry.revision
410
 
                return self._get_delta(ie, basis_inv, path), False
 
548
                return self._get_delta(ie, basis_inv, path), False, None
411
549
            ie.reference_revision = content_summary[3]
412
 
            lines = []
413
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
550
            if ie.reference_revision is None:
 
551
                raise AssertionError("invalid content_summary for nested tree: %r"
 
552
                    % (content_summary,))
 
553
            self._add_text_to_weave(ie.file_id, '', heads, None)
414
554
        else:
415
555
            raise NotImplementedError('unknown kind')
416
556
        ie.revision = self._new_revision_id
417
 
        return self._get_delta(ie, basis_inv, path), True
418
 
 
419
 
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
420
 
        # Note: as we read the content directly from the tree, we know its not
421
 
        # been turned into unicode or badly split - but a broken tree
422
 
        # implementation could give us bad output from readlines() so this is
423
 
        # not a guarantee of safety. What would be better is always checking
424
 
        # the content during test suite execution. RBC 20070912
425
 
        parent_keys = tuple((file_id, parent) for parent in parents)
426
 
        return self.repository.texts.add_lines(
427
 
            (file_id, self._new_revision_id), parent_keys, new_lines,
428
 
            nostore_sha=nostore_sha, random_id=self.random_revid,
429
 
            check_content=False)[0:2]
 
557
        self._any_changes = True
 
558
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
559
 
 
560
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
 
561
        _entry_factory=entry_factory):
 
562
        """Record a new tree via iter_changes.
 
563
 
 
564
        :param tree: The tree to obtain text contents from for changed objects.
 
565
        :param basis_revision_id: The revision id of the tree the iter_changes
 
566
            has been generated against. Currently assumed to be the same
 
567
            as self.parents[0] - if it is not, errors may occur.
 
568
        :param iter_changes: An iter_changes iterator with the changes to apply
 
569
            to basis_revision_id. The iterator must not include any items with
 
570
            a current kind of None - missing items must be either filtered out
 
571
            or errored-on beefore record_iter_changes sees the item.
 
572
        :param _entry_factory: Private method to bind entry_factory locally for
 
573
            performance.
 
574
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
 
575
            tree._observed_sha1.
 
576
        """
 
577
        # Create an inventory delta based on deltas between all the parents and
 
578
        # deltas between all the parent inventories. We use inventory delta's 
 
579
        # between the inventory objects because iter_changes masks
 
580
        # last-changed-field only changes.
 
581
        # Working data:
 
582
        # file_id -> change map, change is fileid, paths, changed, versioneds,
 
583
        # parents, names, kinds, executables
 
584
        merged_ids = {}
 
585
        # {file_id -> revision_id -> inventory entry, for entries in parent
 
586
        # trees that are not parents[0]
 
587
        parent_entries = {}
 
588
        ghost_basis = False
 
589
        try:
 
590
            revtrees = list(self.repository.revision_trees(self.parents))
 
591
        except errors.NoSuchRevision:
 
592
            # one or more ghosts, slow path.
 
593
            revtrees = []
 
594
            for revision_id in self.parents:
 
595
                try:
 
596
                    revtrees.append(self.repository.revision_tree(revision_id))
 
597
                except errors.NoSuchRevision:
 
598
                    if not revtrees:
 
599
                        basis_revision_id = _mod_revision.NULL_REVISION
 
600
                        ghost_basis = True
 
601
                    revtrees.append(self.repository.revision_tree(
 
602
                        _mod_revision.NULL_REVISION))
 
603
        # The basis inventory from a repository 
 
604
        if revtrees:
 
605
            basis_inv = revtrees[0].inventory
 
606
        else:
 
607
            basis_inv = self.repository.revision_tree(
 
608
                _mod_revision.NULL_REVISION).inventory
 
609
        if len(self.parents) > 0:
 
610
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
611
                raise Exception(
 
612
                    "arbitrary basis parents not yet supported with merges")
 
613
            for revtree in revtrees[1:]:
 
614
                for change in revtree.inventory._make_delta(basis_inv):
 
615
                    if change[1] is None:
 
616
                        # Not present in this parent.
 
617
                        continue
 
618
                    if change[2] not in merged_ids:
 
619
                        if change[0] is not None:
 
620
                            basis_entry = basis_inv[change[2]]
 
621
                            merged_ids[change[2]] = [
 
622
                                # basis revid
 
623
                                basis_entry.revision,
 
624
                                # new tree revid
 
625
                                change[3].revision]
 
626
                            parent_entries[change[2]] = {
 
627
                                # basis parent
 
628
                                basis_entry.revision:basis_entry,
 
629
                                # this parent 
 
630
                                change[3].revision:change[3],
 
631
                                }
 
632
                        else:
 
633
                            merged_ids[change[2]] = [change[3].revision]
 
634
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
635
                    else:
 
636
                        merged_ids[change[2]].append(change[3].revision)
 
637
                        parent_entries[change[2]][change[3].revision] = change[3]
 
638
        else:
 
639
            merged_ids = {}
 
640
        # Setup the changes from the tree:
 
641
        # changes maps file_id -> (change, [parent revision_ids])
 
642
        changes= {}
 
643
        for change in iter_changes:
 
644
            # This probably looks up in basis_inv way to much.
 
645
            if change[1][0] is not None:
 
646
                head_candidate = [basis_inv[change[0]].revision]
 
647
            else:
 
648
                head_candidate = []
 
649
            changes[change[0]] = change, merged_ids.get(change[0],
 
650
                head_candidate)
 
651
        unchanged_merged = set(merged_ids) - set(changes)
 
652
        # Extend the changes dict with synthetic changes to record merges of
 
653
        # texts.
 
654
        for file_id in unchanged_merged:
 
655
            # Record a merged version of these items that did not change vs the
 
656
            # basis. This can be either identical parallel changes, or a revert
 
657
            # of a specific file after a merge. The recorded content will be
 
658
            # that of the current tree (which is the same as the basis), but
 
659
            # the per-file graph will reflect a merge.
 
660
            # NB:XXX: We are reconstructing path information we had, this
 
661
            # should be preserved instead.
 
662
            # inv delta  change: (file_id, (path_in_source, path_in_target),
 
663
            #   changed_content, versioned, parent, name, kind,
 
664
            #   executable)
 
665
            try:
 
666
                basis_entry = basis_inv[file_id]
 
667
            except errors.NoSuchId:
 
668
                # a change from basis->some_parents but file_id isn't in basis
 
669
                # so was new in the merge, which means it must have changed
 
670
                # from basis -> current, and as it hasn't the add was reverted
 
671
                # by the user. So we discard this change.
 
672
                pass
 
673
            else:
 
674
                change = (file_id,
 
675
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
676
                    False, (True, True),
 
677
                    (basis_entry.parent_id, basis_entry.parent_id),
 
678
                    (basis_entry.name, basis_entry.name),
 
679
                    (basis_entry.kind, basis_entry.kind),
 
680
                    (basis_entry.executable, basis_entry.executable))
 
681
                changes[file_id] = (change, merged_ids[file_id])
 
682
        # changes contains tuples with the change and a set of inventory
 
683
        # candidates for the file.
 
684
        # inv delta is:
 
685
        # old_path, new_path, file_id, new_inventory_entry
 
686
        seen_root = False # Is the root in the basis delta?
 
687
        inv_delta = self._basis_delta
 
688
        modified_rev = self._new_revision_id
 
689
        for change, head_candidates in changes.values():
 
690
            if change[3][1]: # versioned in target.
 
691
                # Several things may be happening here:
 
692
                # We may have a fork in the per-file graph
 
693
                #  - record a change with the content from tree
 
694
                # We may have a change against < all trees  
 
695
                #  - carry over the tree that hasn't changed
 
696
                # We may have a change against all trees
 
697
                #  - record the change with the content from tree
 
698
                kind = change[6][1]
 
699
                file_id = change[0]
 
700
                entry = _entry_factory[kind](file_id, change[5][1],
 
701
                    change[4][1])
 
702
                head_set = self._heads(change[0], set(head_candidates))
 
703
                heads = []
 
704
                # Preserve ordering.
 
705
                for head_candidate in head_candidates:
 
706
                    if head_candidate in head_set:
 
707
                        heads.append(head_candidate)
 
708
                        head_set.remove(head_candidate)
 
709
                carried_over = False
 
710
                if len(heads) == 1:
 
711
                    # Could be a carry-over situation:
 
712
                    parent_entry_revs = parent_entries.get(file_id, None)
 
713
                    if parent_entry_revs:
 
714
                        parent_entry = parent_entry_revs.get(heads[0], None)
 
715
                    else:
 
716
                        parent_entry = None
 
717
                    if parent_entry is None:
 
718
                        # The parent iter_changes was called against is the one
 
719
                        # that is the per-file head, so any change is relevant
 
720
                        # iter_changes is valid.
 
721
                        carry_over_possible = False
 
722
                    else:
 
723
                        # could be a carry over situation
 
724
                        # A change against the basis may just indicate a merge,
 
725
                        # we need to check the content against the source of the
 
726
                        # merge to determine if it was changed after the merge
 
727
                        # or carried over.
 
728
                        if (parent_entry.kind != entry.kind or
 
729
                            parent_entry.parent_id != entry.parent_id or
 
730
                            parent_entry.name != entry.name):
 
731
                            # Metadata common to all entries has changed
 
732
                            # against per-file parent
 
733
                            carry_over_possible = False
 
734
                        else:
 
735
                            carry_over_possible = True
 
736
                        # per-type checks for changes against the parent_entry
 
737
                        # are done below.
 
738
                else:
 
739
                    # Cannot be a carry-over situation
 
740
                    carry_over_possible = False
 
741
                # Populate the entry in the delta
 
742
                if kind == 'file':
 
743
                    # XXX: There is still a small race here: If someone reverts the content of a file
 
744
                    # after iter_changes examines and decides it has changed,
 
745
                    # we will unconditionally record a new version even if some
 
746
                    # other process reverts it while commit is running (with
 
747
                    # the revert happening after iter_changes did it's
 
748
                    # examination).
 
749
                    if change[7][1]:
 
750
                        entry.executable = True
 
751
                    else:
 
752
                        entry.executable = False
 
753
                    if (carry_over_possible and
 
754
                        parent_entry.executable == entry.executable):
 
755
                            # Check the file length, content hash after reading
 
756
                            # the file.
 
757
                            nostore_sha = parent_entry.text_sha1
 
758
                    else:
 
759
                        nostore_sha = None
 
760
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
 
761
                    try:
 
762
                        text = file_obj.read()
 
763
                    finally:
 
764
                        file_obj.close()
 
765
                    try:
 
766
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
 
767
                            file_id, text, heads, nostore_sha)
 
768
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
769
                    except errors.ExistingContent:
 
770
                        # No content change against a carry_over parent
 
771
                        # Perhaps this should also yield a fs hash update?
 
772
                        carried_over = True
 
773
                        entry.text_size = parent_entry.text_size
 
774
                        entry.text_sha1 = parent_entry.text_sha1
 
775
                elif kind == 'symlink':
 
776
                    # Wants a path hint?
 
777
                    entry.symlink_target = tree.get_symlink_target(file_id)
 
778
                    if (carry_over_possible and
 
779
                        parent_entry.symlink_target == entry.symlink_target):
 
780
                        carried_over = True
 
781
                    else:
 
782
                        self._add_text_to_weave(change[0], '', heads, None)
 
783
                elif kind == 'directory':
 
784
                    if carry_over_possible:
 
785
                        carried_over = True
 
786
                    else:
 
787
                        # Nothing to set on the entry.
 
788
                        # XXX: split into the Root and nonRoot versions.
 
789
                        if change[1][1] != '' or self.repository.supports_rich_root():
 
790
                            self._add_text_to_weave(change[0], '', heads, None)
 
791
                elif kind == 'tree-reference':
 
792
                    if not self.repository._format.supports_tree_reference:
 
793
                        # This isn't quite sane as an error, but we shouldn't
 
794
                        # ever see this code path in practice: tree's don't
 
795
                        # permit references when the repo doesn't support tree
 
796
                        # references.
 
797
                        raise errors.UnsupportedOperation(tree.add_reference,
 
798
                            self.repository)
 
799
                    reference_revision = tree.get_reference_revision(change[0])
 
800
                    entry.reference_revision = reference_revision
 
801
                    if (carry_over_possible and
 
802
                        parent_entry.reference_revision == reference_revision):
 
803
                        carried_over = True
 
804
                    else:
 
805
                        self._add_text_to_weave(change[0], '', heads, None)
 
806
                else:
 
807
                    raise AssertionError('unknown kind %r' % kind)
 
808
                if not carried_over:
 
809
                    entry.revision = modified_rev
 
810
                else:
 
811
                    entry.revision = parent_entry.revision
 
812
            else:
 
813
                entry = None
 
814
            new_path = change[1][1]
 
815
            inv_delta.append((change[1][0], new_path, change[0], entry))
 
816
            if new_path == '':
 
817
                seen_root = True
 
818
        self.new_inventory = None
 
819
        if len(inv_delta):
 
820
            # This should perhaps be guarded by a check that the basis we
 
821
            # commit against is the basis for the commit and if not do a delta
 
822
            # against the basis.
 
823
            self._any_changes = True
 
824
        if not seen_root:
 
825
            # housekeeping root entry changes do not affect no-change commits.
 
826
            self._require_root_change(tree)
 
827
        self.basis_delta_revision = basis_revision_id
 
828
 
 
829
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
830
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
831
        return self.repository.texts._add_text(
 
832
            (file_id, self._new_revision_id), parent_keys, new_text,
 
833
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
430
834
 
431
835
 
432
836
class RootCommitBuilder(CommitBuilder):
433
837
    """This commitbuilder actually records the root id"""
434
 
    
 
838
 
435
839
    # the root entry gets versioned properly by this builder.
436
840
    _versioned_root = True
437
841
 
444
848
        :param tree: The tree that is being committed.
445
849
        """
446
850
 
 
851
    def _require_root_change(self, tree):
 
852
        """Enforce an appropriate root object change.
 
853
 
 
854
        This is called once when record_iter_changes is called, if and only if
 
855
        the root was not in the delta calculated by record_iter_changes.
 
856
 
 
857
        :param tree: The tree which is being committed.
 
858
        """
 
859
        # versioned roots do not change unless the tree found a change.
 
860
 
447
861
 
448
862
######################################################################
449
863
# Repositories
450
864
 
451
 
class Repository(object):
 
865
 
 
866
class Repository(_RelockDebugMixin):
452
867
    """Repository holding history for one or more branches.
453
868
 
454
869
    The repository holds and retrieves historical information including
456
871
    which views a particular line of development through that history.
457
872
 
458
873
    The Repository builds on top of some byte storage facilies (the revisions,
459
 
    signatures, inventories and texts attributes) and a Transport, which
460
 
    respectively provide byte storage and a means to access the (possibly
 
874
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
875
    which respectively provide byte storage and a means to access the (possibly
461
876
    remote) disk.
462
877
 
463
878
    The byte storage facilities are addressed via tuples, which we refer to
464
879
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
465
880
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
466
 
    (file_id, revision_id). We use this interface because it allows low
467
 
    friction with the underlying code that implements disk indices, network
468
 
    encoding and other parts of bzrlib.
 
881
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
 
882
    byte string made up of a hash identifier and a hash value.
 
883
    We use this interface because it allows low friction with the underlying
 
884
    code that implements disk indices, network encoding and other parts of
 
885
    bzrlib.
469
886
 
470
887
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
471
888
        the serialised revisions for the repository. This can be used to obtain
490
907
        The result of trying to insert data into the repository via this store
491
908
        is undefined: it should be considered read-only except for implementors
492
909
        of repositories.
 
910
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
 
911
        any data the repository chooses to store or have indexed by its hash.
 
912
        The result of trying to insert data into the repository via this store
 
913
        is undefined: it should be considered read-only except for implementors
 
914
        of repositories.
493
915
    :ivar _transport: Transport for file access to repository, typically
494
916
        pointing to .bzr/repository.
495
917
    """
505
927
        r'.* revision="(?P<revision_id>[^"]+)"'
506
928
        )
507
929
 
508
 
    def abort_write_group(self):
 
930
    def abort_write_group(self, suppress_errors=False):
509
931
        """Commit the contents accrued within the current write group.
510
932
 
 
933
        :param suppress_errors: if true, abort_write_group will catch and log
 
934
            unexpected errors that happen during the abort, rather than
 
935
            allowing them to propagate.  Defaults to False.
 
936
 
511
937
        :seealso: start_write_group.
512
938
        """
513
939
        if self._write_group is not self.get_transaction():
514
940
            # has an unlock or relock occured ?
515
 
            raise errors.BzrError('mismatched lock context and write group.')
516
 
        self._abort_write_group()
 
941
            if suppress_errors:
 
942
                mutter(
 
943
                '(suppressed) mismatched lock context and write group. %r, %r',
 
944
                self._write_group, self.get_transaction())
 
945
                return
 
946
            raise errors.BzrError(
 
947
                'mismatched lock context and write group. %r, %r' %
 
948
                (self._write_group, self.get_transaction()))
 
949
        try:
 
950
            self._abort_write_group()
 
951
        except Exception, exc:
 
952
            self._write_group = None
 
953
            if not suppress_errors:
 
954
                raise
 
955
            mutter('abort_write_group failed')
 
956
            log_exception_quietly()
 
957
            note('bzr: ERROR (ignored): %s', exc)
517
958
        self._write_group = None
518
959
 
519
960
    def _abort_write_group(self):
520
961
        """Template method for per-repository write group cleanup.
521
 
        
522
 
        This is called during abort before the write group is considered to be 
 
962
 
 
963
        This is called during abort before the write group is considered to be
523
964
        finished and should cleanup any internal state accrued during the write
524
965
        group. There is no requirement that data handed to the repository be
525
966
        *not* made available - this is not a rollback - but neither should any
531
972
 
532
973
    def add_fallback_repository(self, repository):
533
974
        """Add a repository to use for looking up data not held locally.
534
 
        
 
975
 
535
976
        :param repository: A repository.
536
977
        """
537
978
        if not self._format.supports_external_lookups:
538
979
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
980
        if self.is_locked():
 
981
            # This repository will call fallback.unlock() when we transition to
 
982
            # the unlocked state, so we make sure to increment the lock count
 
983
            repository.lock_read()
539
984
        self._check_fallback_repository(repository)
540
985
        self._fallback_repositories.append(repository)
541
986
        self.texts.add_fallback_versioned_files(repository.texts)
542
987
        self.inventories.add_fallback_versioned_files(repository.inventories)
543
988
        self.revisions.add_fallback_versioned_files(repository.revisions)
544
989
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
990
        if self.chk_bytes is not None:
 
991
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
545
992
 
546
993
    def _check_fallback_repository(self, repository):
547
994
        """Check that this repository can fallback to repository safely.
548
995
 
549
996
        Raise an error if not.
550
 
        
 
997
 
551
998
        :param repository: A repository to fallback to.
552
999
        """
553
1000
        return InterRepository._assert_same_model(self, repository)
554
1001
 
555
1002
    def add_inventory(self, revision_id, inv, parents):
556
1003
        """Add the inventory inv to the repository as revision_id.
557
 
        
 
1004
 
558
1005
        :param parents: The revision ids of the parents that revision_id
559
1006
                        is known to have and are in the repository already.
560
1007
 
571
1018
                % (inv.revision_id, revision_id))
572
1019
        if inv.root is None:
573
1020
            raise AssertionError()
574
 
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1021
        return self._add_inventory_checked(revision_id, inv, parents)
 
1022
 
 
1023
    def _add_inventory_checked(self, revision_id, inv, parents):
 
1024
        """Add inv to the repository after checking the inputs.
 
1025
 
 
1026
        This function can be overridden to allow different inventory styles.
 
1027
 
 
1028
        :seealso: add_inventory, for the contract.
 
1029
        """
 
1030
        inv_lines = self._serializer.write_inventory_to_lines(inv)
575
1031
        return self._inventory_add_lines(revision_id, parents,
576
1032
            inv_lines, check_content=False)
577
1033
 
 
1034
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1035
                               parents, basis_inv=None, propagate_caches=False):
 
1036
        """Add a new inventory expressed as a delta against another revision.
 
1037
 
 
1038
        See the inventory developers documentation for the theory behind
 
1039
        inventory deltas.
 
1040
 
 
1041
        :param basis_revision_id: The inventory id the delta was created
 
1042
            against. (This does not have to be a direct parent.)
 
1043
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1044
            details).
 
1045
        :param new_revision_id: The revision id that the inventory is being
 
1046
            added for.
 
1047
        :param parents: The revision ids of the parents that revision_id is
 
1048
            known to have and are in the repository already. These are supplied
 
1049
            for repositories that depend on the inventory graph for revision
 
1050
            graph access, as well as for those that pun ancestry with delta
 
1051
            compression.
 
1052
        :param basis_inv: The basis inventory if it is already known,
 
1053
            otherwise None.
 
1054
        :param propagate_caches: If True, the caches for this inventory are
 
1055
          copied to and updated for the result if possible.
 
1056
 
 
1057
        :returns: (validator, new_inv)
 
1058
            The validator(which is a sha1 digest, though what is sha'd is
 
1059
            repository format specific) of the serialized inventory, and the
 
1060
            resulting inventory.
 
1061
        """
 
1062
        if not self.is_in_write_group():
 
1063
            raise AssertionError("%r not in write group" % (self,))
 
1064
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1065
        basis_tree = self.revision_tree(basis_revision_id)
 
1066
        basis_tree.lock_read()
 
1067
        try:
 
1068
            # Note that this mutates the inventory of basis_tree, which not all
 
1069
            # inventory implementations may support: A better idiom would be to
 
1070
            # return a new inventory, but as there is no revision tree cache in
 
1071
            # repository this is safe for now - RBC 20081013
 
1072
            if basis_inv is None:
 
1073
                basis_inv = basis_tree.inventory
 
1074
            basis_inv.apply_delta(delta)
 
1075
            basis_inv.revision_id = new_revision_id
 
1076
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1077
                    basis_inv)
 
1078
        finally:
 
1079
            basis_tree.unlock()
 
1080
 
578
1081
    def _inventory_add_lines(self, revision_id, parents, lines,
579
1082
        check_content=True):
580
1083
        """Store lines in inv_vf and return the sha1 of the inventory."""
581
1084
        parents = [(parent,) for parent in parents]
582
 
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1085
        result = self.inventories.add_lines((revision_id,), parents, lines,
583
1086
            check_content=check_content)[0]
 
1087
        self.inventories._access.flush()
 
1088
        return result
584
1089
 
585
1090
    def add_revision(self, revision_id, rev, inv=None, config=None):
586
1091
        """Add rev to the revision store as revision_id.
623
1128
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
624
1129
 
625
1130
    def all_revision_ids(self):
626
 
        """Returns a list of all the revision ids in the repository. 
 
1131
        """Returns a list of all the revision ids in the repository.
627
1132
 
628
1133
        This is conceptually deprecated because code should generally work on
629
1134
        the graph reachable from a particular revision, and ignore any other
635
1140
        return self._all_revision_ids()
636
1141
 
637
1142
    def _all_revision_ids(self):
638
 
        """Returns a list of all the revision ids in the repository. 
 
1143
        """Returns a list of all the revision ids in the repository.
639
1144
 
640
 
        These are in as much topological order as the underlying store can 
 
1145
        These are in as much topological order as the underlying store can
641
1146
        present.
642
1147
        """
643
1148
        raise NotImplementedError(self._all_revision_ids)
662
1167
        # The old API returned a list, should this actually be a set?
663
1168
        return parent_map.keys()
664
1169
 
 
1170
    def _check_inventories(self, checker):
 
1171
        """Check the inventories found from the revision scan.
 
1172
        
 
1173
        This is responsible for verifying the sha1 of inventories and
 
1174
        creating a pending_keys set that covers data referenced by inventories.
 
1175
        """
 
1176
        bar = ui.ui_factory.nested_progress_bar()
 
1177
        try:
 
1178
            self._do_check_inventories(checker, bar)
 
1179
        finally:
 
1180
            bar.finished()
 
1181
 
 
1182
    def _do_check_inventories(self, checker, bar):
 
1183
        """Helper for _check_inventories."""
 
1184
        revno = 0
 
1185
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1186
        kinds = ['chk_bytes', 'texts']
 
1187
        count = len(checker.pending_keys)
 
1188
        bar.update("inventories", 0, 2)
 
1189
        current_keys = checker.pending_keys
 
1190
        checker.pending_keys = {}
 
1191
        # Accumulate current checks.
 
1192
        for key in current_keys:
 
1193
            if key[0] != 'inventories' and key[0] not in kinds:
 
1194
                checker._report_items.append('unknown key type %r' % (key,))
 
1195
            keys[key[0]].add(key[1:])
 
1196
        if keys['inventories']:
 
1197
            # NB: output order *should* be roughly sorted - topo or
 
1198
            # inverse topo depending on repository - either way decent
 
1199
            # to just delta against. However, pre-CHK formats didn't
 
1200
            # try to optimise inventory layout on disk. As such the
 
1201
            # pre-CHK code path does not use inventory deltas.
 
1202
            last_object = None
 
1203
            for record in self.inventories.check(keys=keys['inventories']):
 
1204
                if record.storage_kind == 'absent':
 
1205
                    checker._report_items.append(
 
1206
                        'Missing inventory {%s}' % (record.key,))
 
1207
                else:
 
1208
                    last_object = self._check_record('inventories', record,
 
1209
                        checker, last_object,
 
1210
                        current_keys[('inventories',) + record.key])
 
1211
            del keys['inventories']
 
1212
        else:
 
1213
            return
 
1214
        bar.update("texts", 1)
 
1215
        while (checker.pending_keys or keys['chk_bytes']
 
1216
            or keys['texts']):
 
1217
            # Something to check.
 
1218
            current_keys = checker.pending_keys
 
1219
            checker.pending_keys = {}
 
1220
            # Accumulate current checks.
 
1221
            for key in current_keys:
 
1222
                if key[0] not in kinds:
 
1223
                    checker._report_items.append('unknown key type %r' % (key,))
 
1224
                keys[key[0]].add(key[1:])
 
1225
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1226
            for kind in kinds:
 
1227
                if keys[kind]:
 
1228
                    last_object = None
 
1229
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1230
                        if record.storage_kind == 'absent':
 
1231
                            checker._report_items.append(
 
1232
                                'Missing %s {%s}' % (kind, record.key,))
 
1233
                        else:
 
1234
                            last_object = self._check_record(kind, record,
 
1235
                                checker, last_object, current_keys[(kind,) + record.key])
 
1236
                    keys[kind] = set()
 
1237
                    break
 
1238
 
 
1239
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1240
        """Check a single text from this repository."""
 
1241
        if kind == 'inventories':
 
1242
            rev_id = record.key[0]
 
1243
            inv = self._deserialise_inventory(rev_id,
 
1244
                record.get_bytes_as('fulltext'))
 
1245
            if last_object is not None:
 
1246
                delta = inv._make_delta(last_object)
 
1247
                for old_path, path, file_id, ie in delta:
 
1248
                    if ie is None:
 
1249
                        continue
 
1250
                    ie.check(checker, rev_id, inv)
 
1251
            else:
 
1252
                for path, ie in inv.iter_entries():
 
1253
                    ie.check(checker, rev_id, inv)
 
1254
            if self._format.fast_deltas:
 
1255
                return inv
 
1256
        elif kind == 'chk_bytes':
 
1257
            # No code written to check chk_bytes for this repo format.
 
1258
            checker._report_items.append(
 
1259
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1260
        elif kind == 'texts':
 
1261
            self._check_text(record, checker, item_data)
 
1262
        else:
 
1263
            checker._report_items.append(
 
1264
                'unknown key type %s for %s' % (kind, record.key))
 
1265
 
 
1266
    def _check_text(self, record, checker, item_data):
 
1267
        """Check a single text."""
 
1268
        # Check it is extractable.
 
1269
        # TODO: check length.
 
1270
        if record.storage_kind == 'chunked':
 
1271
            chunks = record.get_bytes_as(record.storage_kind)
 
1272
            sha1 = osutils.sha_strings(chunks)
 
1273
            length = sum(map(len, chunks))
 
1274
        else:
 
1275
            content = record.get_bytes_as('fulltext')
 
1276
            sha1 = osutils.sha_string(content)
 
1277
            length = len(content)
 
1278
        if item_data and sha1 != item_data[1]:
 
1279
            checker._report_items.append(
 
1280
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1281
                (record.key, sha1, item_data[1], item_data[2]))
 
1282
 
665
1283
    @staticmethod
666
1284
    def create(a_bzrdir):
667
1285
        """Construct the current default format repository in a_bzrdir."""
688
1306
        self._reconcile_does_inventory_gc = True
689
1307
        self._reconcile_fixes_text_parents = False
690
1308
        self._reconcile_backsup_inventory = True
691
 
        # not right yet - should be more semantically clear ? 
692
 
        # 
693
 
        # TODO: make sure to construct the right store classes, etc, depending
694
 
        # on whether escaping is required.
695
 
        self._warn_if_deprecated()
696
1309
        self._write_group = None
697
1310
        # Additional places to query for data.
698
1311
        self._fallback_repositories = []
699
 
        # What order should fetch operations request streams in?
700
 
        # The default is unordered as that is the cheapest for an origin to
701
 
        # provide.
702
 
        self._fetch_order = 'unordered'
703
 
        # Does this repository use deltas that can be fetched as-deltas ?
704
 
        # (E.g. knits, where the knit deltas can be transplanted intact.
705
 
        # We default to False, which will ensure that enough data to get
706
 
        # a full text out of any fetch stream will be grabbed.
707
 
        self._fetch_uses_deltas = False
708
 
        # Should fetch trigger a reconcile after the fetch? Only needed for
709
 
        # some repository formats that can suffer internal inconsistencies.
710
 
        self._fetch_reconcile = False
 
1312
        # An InventoryEntry cache, used during deserialization
 
1313
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
1314
        # Is it safe to return inventory entries directly from the entry cache,
 
1315
        # rather copying them?
 
1316
        self._safe_to_return_from_cache = False
711
1317
 
712
1318
    def __repr__(self):
713
 
        return '%s(%r)' % (self.__class__.__name__,
714
 
                           self.base)
 
1319
        if self._fallback_repositories:
 
1320
            return '%s(%r, fallback_repositories=%r)' % (
 
1321
                self.__class__.__name__,
 
1322
                self.base,
 
1323
                self._fallback_repositories)
 
1324
        else:
 
1325
            return '%s(%r)' % (self.__class__.__name__,
 
1326
                               self.base)
 
1327
 
 
1328
    def _has_same_fallbacks(self, other_repo):
 
1329
        """Returns true if the repositories have the same fallbacks."""
 
1330
        my_fb = self._fallback_repositories
 
1331
        other_fb = other_repo._fallback_repositories
 
1332
        if len(my_fb) != len(other_fb):
 
1333
            return False
 
1334
        for f, g in zip(my_fb, other_fb):
 
1335
            if not f.has_same_location(g):
 
1336
                return False
 
1337
        return True
715
1338
 
716
1339
    def has_same_location(self, other):
717
1340
        """Returns a boolean indicating if this repository is at the same
744
1367
        This causes caching within the repository obejct to start accumlating
745
1368
        data during reads, and allows a 'write_group' to be obtained. Write
746
1369
        groups must be used for actual data insertion.
747
 
        
 
1370
 
748
1371
        :param token: if this is already locked, then lock_write will fail
749
1372
            unless the token matches the existing lock.
750
1373
        :returns: a token if this instance supports tokens, otherwise None.
760
1383
 
761
1384
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
762
1385
        """
 
1386
        locked = self.is_locked()
763
1387
        result = self.control_files.lock_write(token=token)
764
 
        for repo in self._fallback_repositories:
765
 
            # Writes don't affect fallback repos
766
 
            repo.lock_read()
767
 
        self._refresh_data()
 
1388
        if not locked:
 
1389
            self._warn_if_deprecated()
 
1390
            self._note_lock('w')
 
1391
            for repo in self._fallback_repositories:
 
1392
                # Writes don't affect fallback repos
 
1393
                repo.lock_read()
 
1394
            self._refresh_data()
768
1395
        return result
769
1396
 
770
1397
    def lock_read(self):
 
1398
        locked = self.is_locked()
771
1399
        self.control_files.lock_read()
772
 
        for repo in self._fallback_repositories:
773
 
            repo.lock_read()
774
 
        self._refresh_data()
 
1400
        if not locked:
 
1401
            self._warn_if_deprecated()
 
1402
            self._note_lock('r')
 
1403
            for repo in self._fallback_repositories:
 
1404
                repo.lock_read()
 
1405
            self._refresh_data()
775
1406
 
776
1407
    def get_physical_lock_status(self):
777
1408
        return self.control_files.get_physical_lock_status()
779
1410
    def leave_lock_in_place(self):
780
1411
        """Tell this repository not to release the physical lock when this
781
1412
        object is unlocked.
782
 
        
 
1413
 
783
1414
        If lock_write doesn't return a token, then this method is not supported.
784
1415
        """
785
1416
        self.control_files.leave_in_place()
853
1484
        :param using: If True, list only branches using this repository.
854
1485
        """
855
1486
        if using and not self.is_shared():
856
 
            try:
857
 
                return [self.bzrdir.open_branch()]
858
 
            except errors.NotBranchError:
859
 
                return []
 
1487
            return self.bzrdir.list_branches()
860
1488
        class Evaluator(object):
861
1489
 
862
1490
            def __init__(self):
871
1499
                    except errors.NoRepositoryPresent:
872
1500
                        pass
873
1501
                    else:
874
 
                        return False, (None, repository)
 
1502
                        return False, ([], repository)
875
1503
                self.first_call = False
876
 
                try:
877
 
                    value = (bzrdir.open_branch(), None)
878
 
                except errors.NotBranchError:
879
 
                    value = (None, None)
 
1504
                value = (bzrdir.list_branches(), None)
880
1505
                return True, value
881
1506
 
882
 
        branches = []
883
 
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1507
        ret = []
 
1508
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
884
1509
                self.bzrdir.root_transport, evaluate=Evaluator()):
885
 
            if branch is not None:
886
 
                branches.append(branch)
 
1510
            if branches is not None:
 
1511
                ret.extend(branches)
887
1512
            if not using and repository is not None:
888
 
                branches.extend(repository.find_branches())
889
 
        return branches
 
1513
                ret.extend(repository.find_branches())
 
1514
        return ret
890
1515
 
891
1516
    @needs_read_lock
892
1517
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
893
1518
        """Return the revision ids that other has that this does not.
894
 
        
 
1519
 
895
1520
        These are returned in topological order.
896
1521
 
897
1522
        revision_id: only return revision ids included by revision_id.
899
1524
        return InterRepository.get(other, self).search_missing_revision_ids(
900
1525
            revision_id, find_ghosts)
901
1526
 
902
 
    @deprecated_method(one_two)
903
 
    @needs_read_lock
904
 
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
905
 
        """Return the revision ids that other has that this does not.
906
 
        
907
 
        These are returned in topological order.
908
 
 
909
 
        revision_id: only return revision ids included by revision_id.
910
 
        """
911
 
        keys =  self.search_missing_revision_ids(
912
 
            other, revision_id, find_ghosts).get_keys()
913
 
        other.lock_read()
914
 
        try:
915
 
            parents = other.get_graph().get_parent_map(keys)
916
 
        finally:
917
 
            other.unlock()
918
 
        return tsort.topo_sort(parents)
919
 
 
920
1527
    @staticmethod
921
1528
    def open(base):
922
1529
        """Open the repository rooted at base.
929
1536
 
930
1537
    def copy_content_into(self, destination, revision_id=None):
931
1538
        """Make a complete copy of the content in self into destination.
932
 
        
933
 
        This is a destructive operation! Do not use it on existing 
 
1539
 
 
1540
        This is a destructive operation! Do not use it on existing
934
1541
        repositories.
935
1542
        """
936
1543
        return InterRepository.get(self, destination).copy_content(revision_id)
939
1546
        """Commit the contents accrued within the current write group.
940
1547
 
941
1548
        :seealso: start_write_group.
 
1549
        
 
1550
        :return: it may return an opaque hint that can be passed to 'pack'.
942
1551
        """
943
1552
        if self._write_group is not self.get_transaction():
944
1553
            # has an unlock or relock occured ?
945
1554
            raise errors.BzrError('mismatched lock context %r and '
946
1555
                'write group %r.' %
947
1556
                (self.get_transaction(), self._write_group))
948
 
        self._commit_write_group()
 
1557
        result = self._commit_write_group()
949
1558
        self._write_group = None
 
1559
        return result
950
1560
 
951
1561
    def _commit_write_group(self):
952
1562
        """Template method for per-repository write group cleanup.
953
 
        
954
 
        This is called before the write group is considered to be 
 
1563
 
 
1564
        This is called before the write group is considered to be
955
1565
        finished and should ensure that all data handed to the repository
956
 
        for writing during the write group is safely committed (to the 
 
1566
        for writing during the write group is safely committed (to the
957
1567
        extent possible considering file system caching etc).
958
1568
        """
959
1569
 
960
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
1570
    def suspend_write_group(self):
 
1571
        raise errors.UnsuspendableWriteGroup(self)
 
1572
 
 
1573
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1574
        """Return the keys of missing inventory parents for revisions added in
 
1575
        this write group.
 
1576
 
 
1577
        A revision is not complete if the inventory delta for that revision
 
1578
        cannot be calculated.  Therefore if the parent inventories of a
 
1579
        revision are not present, the revision is incomplete, and e.g. cannot
 
1580
        be streamed by a smart server.  This method finds missing inventory
 
1581
        parents for revisions added in this write group.
 
1582
        """
 
1583
        if not self._format.supports_external_lookups:
 
1584
            # This is only an issue for stacked repositories
 
1585
            return set()
 
1586
        if not self.is_in_write_group():
 
1587
            raise AssertionError('not in a write group')
 
1588
 
 
1589
        # XXX: We assume that every added revision already has its
 
1590
        # corresponding inventory, so we only check for parent inventories that
 
1591
        # might be missing, rather than all inventories.
 
1592
        parents = set(self.revisions._index.get_missing_parents())
 
1593
        parents.discard(_mod_revision.NULL_REVISION)
 
1594
        unstacked_inventories = self.inventories._index
 
1595
        present_inventories = unstacked_inventories.get_parent_map(
 
1596
            key[-1:] for key in parents)
 
1597
        parents.difference_update(present_inventories)
 
1598
        if len(parents) == 0:
 
1599
            # No missing parent inventories.
 
1600
            return set()
 
1601
        if not check_for_missing_texts:
 
1602
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1603
        # Ok, now we have a list of missing inventories.  But these only matter
 
1604
        # if the inventories that reference them are missing some texts they
 
1605
        # appear to introduce.
 
1606
        # XXX: Texts referenced by all added inventories need to be present,
 
1607
        # but at the moment we're only checking for texts referenced by
 
1608
        # inventories at the graph's edge.
 
1609
        key_deps = self.revisions._index._key_dependencies
 
1610
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1611
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1612
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1613
        missing_texts = set()
 
1614
        for file_id, version_ids in file_ids.iteritems():
 
1615
            missing_texts.update(
 
1616
                (file_id, version_id) for version_id in version_ids)
 
1617
        present_texts = self.texts.get_parent_map(missing_texts)
 
1618
        missing_texts.difference_update(present_texts)
 
1619
        if not missing_texts:
 
1620
            # No texts are missing, so all revisions and their deltas are
 
1621
            # reconstructable.
 
1622
            return set()
 
1623
        # Alternatively the text versions could be returned as the missing
 
1624
        # keys, but this is likely to be less data.
 
1625
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1626
        return missing_keys
 
1627
 
 
1628
    def refresh_data(self):
 
1629
        """Re-read any data needed to to synchronise with disk.
 
1630
 
 
1631
        This method is intended to be called after another repository instance
 
1632
        (such as one used by a smart server) has inserted data into the
 
1633
        repository. It may not be called during a write group, but may be
 
1634
        called at any other time.
 
1635
        """
 
1636
        if self.is_in_write_group():
 
1637
            raise errors.InternalBzrError(
 
1638
                "May not refresh_data while in a write group.")
 
1639
        self._refresh_data()
 
1640
 
 
1641
    def resume_write_group(self, tokens):
 
1642
        if not self.is_write_locked():
 
1643
            raise errors.NotWriteLocked(self)
 
1644
        if self._write_group:
 
1645
            raise errors.BzrError('already in a write group')
 
1646
        self._resume_write_group(tokens)
 
1647
        # so we can detect unlock/relock - the write group is now entered.
 
1648
        self._write_group = self.get_transaction()
 
1649
 
 
1650
    def _resume_write_group(self, tokens):
 
1651
        raise errors.UnsuspendableWriteGroup(self)
 
1652
 
 
1653
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1654
            fetch_spec=None):
961
1655
        """Fetch the content required to construct revision_id from source.
962
1656
 
963
 
        If revision_id is None all content is copied.
 
1657
        If revision_id is None and fetch_spec is None, then all content is
 
1658
        copied.
 
1659
 
 
1660
        fetch() may not be used when the repository is in a write group -
 
1661
        either finish the current write group before using fetch, or use
 
1662
        fetch before starting the write group.
 
1663
 
964
1664
        :param find_ghosts: Find and copy revisions in the source that are
965
1665
            ghosts in the target (and not reachable directly by walking out to
966
1666
            the first-present revision in target from revision_id).
 
1667
        :param revision_id: If specified, all the content needed for this
 
1668
            revision ID will be copied to the target.  Fetch will determine for
 
1669
            itself which content needs to be copied.
 
1670
        :param fetch_spec: If specified, a SearchResult or
 
1671
            PendingAncestryResult that describes which revisions to copy.  This
 
1672
            allows copying multiple heads at once.  Mutually exclusive with
 
1673
            revision_id.
967
1674
        """
 
1675
        if fetch_spec is not None and revision_id is not None:
 
1676
            raise AssertionError(
 
1677
                "fetch_spec and revision_id are mutually exclusive.")
 
1678
        if self.is_in_write_group():
 
1679
            raise errors.InternalBzrError(
 
1680
                "May not fetch while in a write group.")
968
1681
        # fast path same-url fetch operations
969
 
        if self.has_same_location(source):
 
1682
        # TODO: lift out to somewhere common with RemoteRepository
 
1683
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1684
        if (self.has_same_location(source)
 
1685
            and fetch_spec is None
 
1686
            and self._has_same_fallbacks(source)):
970
1687
            # check that last_revision is in 'from' and then return a
971
1688
            # no-operation.
972
1689
            if (revision_id is not None and
978
1695
        # IncompatibleRepositories when asked to fetch.
979
1696
        inter = InterRepository.get(source, self)
980
1697
        return inter.fetch(revision_id=revision_id, pb=pb,
981
 
            find_ghosts=find_ghosts)
 
1698
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
982
1699
 
983
1700
    def create_bundle(self, target, base, fileobj, format=None):
984
1701
        return serializer.write_bundle(self, target, base, fileobj, format)
987
1704
                           timezone=None, committer=None, revprops=None,
988
1705
                           revision_id=None):
989
1706
        """Obtain a CommitBuilder for this repository.
990
 
        
 
1707
 
991
1708
        :param branch: Branch to commit to.
992
1709
        :param parents: Revision ids of the parents of the new revision.
993
1710
        :param config: Configuration to use.
997
1714
        :param revprops: Optional dictionary of revision properties.
998
1715
        :param revision_id: Optional revision id.
999
1716
        """
 
1717
        if self._fallback_repositories:
 
1718
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1719
                "to a stacked branch. See "
 
1720
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1000
1721
        result = self._commit_builder_class(self, parents, config,
1001
1722
            timestamp, timezone, committer, revprops, revision_id)
1002
1723
        self.start_write_group()
1003
1724
        return result
1004
1725
 
 
1726
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1005
1727
    def unlock(self):
1006
1728
        if (self.control_files._lock_count == 1 and
1007
1729
            self.control_files._lock_mode == 'w'):
1011
1733
                raise errors.BzrError(
1012
1734
                    'Must end write groups before releasing write locks.')
1013
1735
        self.control_files.unlock()
1014
 
        for repo in self._fallback_repositories:
1015
 
            repo.unlock()
 
1736
        if self.control_files._lock_count == 0:
 
1737
            self._inventory_entry_cache.clear()
 
1738
            for repo in self._fallback_repositories:
 
1739
                repo.unlock()
1016
1740
 
1017
1741
    @needs_read_lock
1018
1742
    def clone(self, a_bzrdir, revision_id=None):
1053
1777
 
1054
1778
    def _start_write_group(self):
1055
1779
        """Template method for per-repository write group startup.
1056
 
        
1057
 
        This is called before the write group is considered to be 
 
1780
 
 
1781
        This is called before the write group is considered to be
1058
1782
        entered.
1059
1783
        """
1060
1784
 
1081
1805
                dest_repo = a_bzrdir.open_repository()
1082
1806
        return dest_repo
1083
1807
 
 
1808
    def _get_sink(self):
 
1809
        """Return a sink for streaming into this repository."""
 
1810
        return StreamSink(self)
 
1811
 
 
1812
    def _get_source(self, to_format):
 
1813
        """Return a source for streaming from this repository."""
 
1814
        return StreamSource(self, to_format)
 
1815
 
1084
1816
    @needs_read_lock
1085
1817
    def has_revision(self, revision_id):
1086
1818
        """True if this repository has a copy of the revision."""
1109
1841
    @needs_read_lock
1110
1842
    def get_revision_reconcile(self, revision_id):
1111
1843
        """'reconcile' helper routine that allows access to a revision always.
1112
 
        
 
1844
 
1113
1845
        This variant of get_revision does not cross check the weave graph
1114
1846
        against the revision one as get_revision does: but it should only
1115
1847
        be used by reconcile, or reconcile-alike commands that are correcting
1119
1851
 
1120
1852
    @needs_read_lock
1121
1853
    def get_revisions(self, revision_ids):
1122
 
        """Get many revisions at once."""
 
1854
        """Get many revisions at once.
 
1855
        
 
1856
        Repositories that need to check data on every revision read should 
 
1857
        subclass this method.
 
1858
        """
1123
1859
        return self._get_revisions(revision_ids)
1124
1860
 
1125
1861
    @needs_read_lock
1126
1862
    def _get_revisions(self, revision_ids):
1127
1863
        """Core work logic to get many revisions without sanity checks."""
1128
 
        for rev_id in revision_ids:
1129
 
            if not rev_id or not isinstance(rev_id, basestring):
1130
 
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1864
        revs = {}
 
1865
        for revid, rev in self._iter_revisions(revision_ids):
 
1866
            if rev is None:
 
1867
                raise errors.NoSuchRevision(self, revid)
 
1868
            revs[revid] = rev
 
1869
        return [revs[revid] for revid in revision_ids]
 
1870
 
 
1871
    def _iter_revisions(self, revision_ids):
 
1872
        """Iterate over revision objects.
 
1873
 
 
1874
        :param revision_ids: An iterable of revisions to examine. None may be
 
1875
            passed to request all revisions known to the repository. Note that
 
1876
            not all repositories can find unreferenced revisions; for those
 
1877
            repositories only referenced ones will be returned.
 
1878
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1879
            those asked for but not available) are returned as (revid, None).
 
1880
        """
 
1881
        if revision_ids is None:
 
1882
            revision_ids = self.all_revision_ids()
 
1883
        else:
 
1884
            for rev_id in revision_ids:
 
1885
                if not rev_id or not isinstance(rev_id, basestring):
 
1886
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1131
1887
        keys = [(key,) for key in revision_ids]
1132
1888
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1133
 
        revs = {}
1134
1889
        for record in stream:
 
1890
            revid = record.key[0]
1135
1891
            if record.storage_kind == 'absent':
1136
 
                raise errors.NoSuchRevision(self, record.key[0])
1137
 
            text = record.get_bytes_as('fulltext')
1138
 
            rev = self._serializer.read_revision_from_string(text)
1139
 
            revs[record.key[0]] = rev
1140
 
        return [revs[revid] for revid in revision_ids]
1141
 
 
1142
 
    @needs_read_lock
1143
 
    def get_revision_xml(self, revision_id):
1144
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1145
 
        #       would have already do it.
1146
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1147
 
        rev = self.get_revision(revision_id)
1148
 
        rev_tmp = StringIO()
1149
 
        # the current serializer..
1150
 
        self._serializer.write_revision(rev, rev_tmp)
1151
 
        rev_tmp.seek(0)
1152
 
        return rev_tmp.getvalue()
1153
 
 
1154
 
    def get_deltas_for_revisions(self, revisions):
 
1892
                yield (revid, None)
 
1893
            else:
 
1894
                text = record.get_bytes_as('fulltext')
 
1895
                rev = self._serializer.read_revision_from_string(text)
 
1896
                yield (revid, rev)
 
1897
 
 
1898
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1155
1899
        """Produce a generator of revision deltas.
1156
 
        
 
1900
 
1157
1901
        Note that the input is a sequence of REVISIONS, not revision_ids.
1158
1902
        Trees will be held in memory until the generator exits.
1159
1903
        Each delta is relative to the revision's lefthand predecessor.
 
1904
 
 
1905
        :param specific_fileids: if not None, the result is filtered
 
1906
          so that only those file-ids, their parents and their
 
1907
          children are included.
1160
1908
        """
 
1909
        # Get the revision-ids of interest
1161
1910
        required_trees = set()
1162
1911
        for revision in revisions:
1163
1912
            required_trees.add(revision.revision_id)
1164
1913
            required_trees.update(revision.parent_ids[:1])
1165
 
        trees = dict((t.get_revision_id(), t) for 
1166
 
                     t in self.revision_trees(required_trees))
 
1914
 
 
1915
        # Get the matching filtered trees. Note that it's more
 
1916
        # efficient to pass filtered trees to changes_from() rather
 
1917
        # than doing the filtering afterwards. changes_from() could
 
1918
        # arguably do the filtering itself but it's path-based, not
 
1919
        # file-id based, so filtering before or afterwards is
 
1920
        # currently easier.
 
1921
        if specific_fileids is None:
 
1922
            trees = dict((t.get_revision_id(), t) for
 
1923
                t in self.revision_trees(required_trees))
 
1924
        else:
 
1925
            trees = dict((t.get_revision_id(), t) for
 
1926
                t in self._filtered_revision_trees(required_trees,
 
1927
                specific_fileids))
 
1928
 
 
1929
        # Calculate the deltas
1167
1930
        for revision in revisions:
1168
1931
            if not revision.parent_ids:
1169
 
                old_tree = self.revision_tree(None)
 
1932
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1170
1933
            else:
1171
1934
                old_tree = trees[revision.parent_ids[0]]
1172
1935
            yield trees[revision.revision_id].changes_from(old_tree)
1173
1936
 
1174
1937
    @needs_read_lock
1175
 
    def get_revision_delta(self, revision_id):
 
1938
    def get_revision_delta(self, revision_id, specific_fileids=None):
1176
1939
        """Return the delta for one revision.
1177
1940
 
1178
1941
        The delta is relative to the left-hand predecessor of the
1179
1942
        revision.
 
1943
 
 
1944
        :param specific_fileids: if not None, the result is filtered
 
1945
          so that only those file-ids, their parents and their
 
1946
          children are included.
1180
1947
        """
1181
1948
        r = self.get_revision(revision_id)
1182
 
        return list(self.get_deltas_for_revisions([r]))[0]
 
1949
        return list(self.get_deltas_for_revisions([r],
 
1950
            specific_fileids=specific_fileids))[0]
1183
1951
 
1184
1952
    @needs_write_lock
1185
1953
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1194
1962
    def find_text_key_references(self):
1195
1963
        """Find the text key references within the repository.
1196
1964
 
1197
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
1198
 
        revision_ids. Each altered file-ids has the exact revision_ids that
1199
 
        altered it listed explicitly.
1200
1965
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1201
1966
            to whether they were referred to by the inventory of the
1202
1967
            revision_id that they contain. The inventory texts from all present
1233
1998
 
1234
1999
        # this code needs to read every new line in every inventory for the
1235
2000
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
1236
 
        # not present in one of those inventories is unnecessary but not 
 
2001
        # not present in one of those inventories is unnecessary but not
1237
2002
        # harmful because we are filtering by the revision id marker in the
1238
 
        # inventory lines : we only select file ids altered in one of those  
 
2003
        # inventory lines : we only select file ids altered in one of those
1239
2004
        # revisions. We don't need to see all lines in the inventory because
1240
2005
        # only those added in an inventory in rev X can contain a revision=X
1241
2006
        # line.
1291
2056
                result[key] = True
1292
2057
        return result
1293
2058
 
 
2059
    def _inventory_xml_lines_for_keys(self, keys):
 
2060
        """Get a line iterator of the sort needed for findind references.
 
2061
 
 
2062
        Not relevant for non-xml inventory repositories.
 
2063
 
 
2064
        Ghosts in revision_keys are ignored.
 
2065
 
 
2066
        :param revision_keys: The revision keys for the inventories to inspect.
 
2067
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
2068
            all of the xml inventories specified by revision_keys.
 
2069
        """
 
2070
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2071
        for record in stream:
 
2072
            if record.storage_kind != 'absent':
 
2073
                chunks = record.get_bytes_as('chunked')
 
2074
                revid = record.key[-1]
 
2075
                lines = osutils.chunks_to_lines(chunks)
 
2076
                for line in lines:
 
2077
                    yield line, revid
 
2078
 
1294
2079
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1295
 
        revision_ids):
 
2080
        revision_keys):
1296
2081
        """Helper routine for fileids_altered_by_revision_ids.
1297
2082
 
1298
2083
        This performs the translation of xml lines to revision ids.
1299
2084
 
1300
2085
        :param line_iterator: An iterator of lines, origin_version_id
1301
 
        :param revision_ids: The revision ids to filter for. This should be a
 
2086
        :param revision_keys: The revision ids to filter for. This should be a
1302
2087
            set or other type which supports efficient __contains__ lookups, as
1303
 
            the revision id from each parsed line will be looked up in the
1304
 
            revision_ids filter.
 
2088
            the revision key from each parsed line will be looked up in the
 
2089
            revision_keys filter.
1305
2090
        :return: a dictionary mapping altered file-ids to an iterable of
1306
2091
        revision_ids. Each altered file-ids has the exact revision_ids that
1307
2092
        altered it listed explicitly.
1308
2093
        """
 
2094
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2095
                line_iterator).iterkeys())
 
2096
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
2097
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2098
            self._inventory_xml_lines_for_keys(parent_keys)))
 
2099
        new_keys = seen - parent_seen
1309
2100
        result = {}
1310
2101
        setdefault = result.setdefault
1311
 
        for key in \
1312
 
            self._find_text_key_references_from_xml_inventory_lines(
1313
 
                line_iterator).iterkeys():
1314
 
            # once data is all ensured-consistent; then this is
1315
 
            # if revision_id == version_id
1316
 
            if key[-1:] in revision_ids:
1317
 
                setdefault(key[0], set()).add(key[-1])
 
2102
        for key in new_keys:
 
2103
            setdefault(key[0], set()).add(key[-1])
1318
2104
        return result
1319
2105
 
 
2106
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2107
        """Find all parent ids that are mentioned in the revision graph.
 
2108
 
 
2109
        :return: set of revisions that are parents of revision_ids which are
 
2110
            not part of revision_ids themselves
 
2111
        """
 
2112
        parent_map = self.get_parent_map(revision_ids)
 
2113
        parent_ids = set()
 
2114
        map(parent_ids.update, parent_map.itervalues())
 
2115
        parent_ids.difference_update(revision_ids)
 
2116
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2117
        return parent_ids
 
2118
 
 
2119
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2120
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2121
 
 
2122
        :param revision_keys: An iterable of revision_keys.
 
2123
        :return: The parents of all revision_keys that are not already in
 
2124
            revision_keys
 
2125
        """
 
2126
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2127
        parent_keys = set()
 
2128
        map(parent_keys.update, parent_map.itervalues())
 
2129
        parent_keys.difference_update(revision_keys)
 
2130
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2131
        return parent_keys
 
2132
 
1320
2133
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1321
2134
        """Find the file ids and versions affected by revisions.
1322
2135
 
1329
2142
        """
1330
2143
        selected_keys = set((revid,) for revid in revision_ids)
1331
2144
        w = _inv_weave or self.inventories
1332
 
        pb = ui.ui_factory.nested_progress_bar()
1333
 
        try:
1334
 
            return self._find_file_ids_from_xml_inventory_lines(
1335
 
                w.iter_lines_added_or_present_in_keys(
1336
 
                    selected_keys, pb=pb),
1337
 
                selected_keys)
1338
 
        finally:
1339
 
            pb.finished()
 
2145
        return self._find_file_ids_from_xml_inventory_lines(
 
2146
            w.iter_lines_added_or_present_in_keys(
 
2147
                selected_keys, pb=None),
 
2148
            selected_keys)
1340
2149
 
1341
2150
    def iter_files_bytes(self, desired_files):
1342
2151
        """Iterate through file versions.
1357
2166
        :param desired_files: a list of (file_id, revision_id, identifier)
1358
2167
            triples
1359
2168
        """
1360
 
        transaction = self.get_transaction()
1361
2169
        text_keys = {}
1362
2170
        for file_id, revision_id, callable_data in desired_files:
1363
2171
            text_keys[(file_id, revision_id)] = callable_data
1364
2172
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
1365
2173
            if record.storage_kind == 'absent':
1366
2174
                raise errors.RevisionNotPresent(record.key, self)
1367
 
            yield text_keys[record.key], record.get_bytes_as('fulltext')
 
2175
            yield text_keys[record.key], record.get_bytes_as('chunked')
1368
2176
 
1369
2177
    def _generate_text_key_index(self, text_key_references=None,
1370
2178
        ancestors=None):
1419
2227
        batch_size = 10 # should be ~150MB on a 55K path tree
1420
2228
        batch_count = len(revision_order) / batch_size + 1
1421
2229
        processed_texts = 0
1422
 
        pb.update("Calculating text parents.", processed_texts, text_count)
 
2230
        pb.update("Calculating text parents", processed_texts, text_count)
1423
2231
        for offset in xrange(batch_count):
1424
2232
            to_query = revision_order[offset * batch_size:(offset + 1) *
1425
2233
                batch_size]
1426
2234
            if not to_query:
1427
2235
                break
1428
 
            for rev_tree in self.revision_trees(to_query):
1429
 
                revision_id = rev_tree.get_revision_id()
 
2236
            for revision_id in to_query:
1430
2237
                parent_ids = ancestors[revision_id]
1431
2238
                for text_key in revision_keys[revision_id]:
1432
 
                    pb.update("Calculating text parents.", processed_texts)
 
2239
                    pb.update("Calculating text parents", processed_texts)
1433
2240
                    processed_texts += 1
1434
2241
                    candidate_parents = []
1435
2242
                    for parent_id in parent_ids:
1451
2258
                            except KeyError:
1452
2259
                                inv = self.revision_tree(parent_id).inventory
1453
2260
                                inventory_cache[parent_id] = inv
1454
 
                            parent_entry = inv._byid.get(text_key[0], None)
 
2261
                            try:
 
2262
                                parent_entry = inv[text_key[0]]
 
2263
                            except (KeyError, errors.NoSuchId):
 
2264
                                parent_entry = None
1455
2265
                            if parent_entry is not None:
1456
2266
                                parent_text_key = (
1457
2267
                                    text_key[0], parent_entry.revision)
1482
2292
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
1483
2293
            'revisions'.  file-id is None unless knit-kind is 'file'.
1484
2294
        """
 
2295
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2296
            yield result
 
2297
        del _files_pb
 
2298
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2299
            yield result
 
2300
 
 
2301
    def _find_file_keys_to_fetch(self, revision_ids, pb):
1485
2302
        # XXX: it's a bit weird to control the inventory weave caching in this
1486
2303
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
1487
2304
        # maybe this generator should explicitly have the contract that it
1494
2311
        count = 0
1495
2312
        num_file_ids = len(file_ids)
1496
2313
        for file_id, altered_versions in file_ids.iteritems():
1497
 
            if _files_pb is not None:
1498
 
                _files_pb.update("fetch texts", count, num_file_ids)
 
2314
            if pb is not None:
 
2315
                pb.update("Fetch texts", count, num_file_ids)
1499
2316
            count += 1
1500
2317
            yield ("file", file_id, altered_versions)
1501
 
        # We're done with the files_pb.  Note that it finished by the caller,
1502
 
        # just as it was created by the caller.
1503
 
        del _files_pb
1504
2318
 
 
2319
    def _find_non_file_keys_to_fetch(self, revision_ids):
1505
2320
        # inventory
1506
2321
        yield ("inventory", None, revision_ids)
1507
2322
 
1508
2323
        # signatures
1509
 
        revisions_with_signatures = set()
1510
 
        for rev_id in revision_ids:
1511
 
            try:
1512
 
                self.get_signature_text(rev_id)
1513
 
            except errors.NoSuchRevision:
1514
 
                # not signed.
1515
 
                pass
1516
 
            else:
1517
 
                revisions_with_signatures.add(rev_id)
 
2324
        # XXX: Note ATM no callers actually pay attention to this return
 
2325
        #      instead they just use the list of revision ids and ignore
 
2326
        #      missing sigs. Consider removing this work entirely
 
2327
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2328
            [(r,) for r in revision_ids]))
 
2329
        revisions_with_signatures = set(
 
2330
            [r for (r,) in revisions_with_signatures])
 
2331
        revisions_with_signatures.intersection_update(revision_ids)
1518
2332
        yield ("signatures", None, revisions_with_signatures)
1519
2333
 
1520
2334
        # revisions
1525
2339
        """Get Inventory object by revision id."""
1526
2340
        return self.iter_inventories([revision_id]).next()
1527
2341
 
1528
 
    def iter_inventories(self, revision_ids):
 
2342
    def iter_inventories(self, revision_ids, ordering=None):
1529
2343
        """Get many inventories by revision_ids.
1530
2344
 
1531
2345
        This will buffer some or all of the texts used in constructing the
1532
2346
        inventories in memory, but will only parse a single inventory at a
1533
2347
        time.
1534
2348
 
 
2349
        :param revision_ids: The expected revision ids of the inventories.
 
2350
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2351
            specified, the order of revision_ids will be preserved (by
 
2352
            buffering if necessary).
1535
2353
        :return: An iterator of inventories.
1536
2354
        """
1537
2355
        if ((None in revision_ids)
1538
2356
            or (_mod_revision.NULL_REVISION in revision_ids)):
1539
2357
            raise ValueError('cannot get null revision inventory')
1540
 
        return self._iter_inventories(revision_ids)
 
2358
        return self._iter_inventories(revision_ids, ordering)
1541
2359
 
1542
 
    def _iter_inventories(self, revision_ids):
 
2360
    def _iter_inventories(self, revision_ids, ordering):
1543
2361
        """single-document based inventory iteration."""
1544
 
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
1545
 
            yield self.deserialise_inventory(revision_id, text)
 
2362
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2363
        for text, revision_id in inv_xmls:
 
2364
            yield self._deserialise_inventory(revision_id, text)
1546
2365
 
1547
 
    def _iter_inventory_xmls(self, revision_ids):
 
2366
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2367
        if ordering is None:
 
2368
            order_as_requested = True
 
2369
            ordering = 'unordered'
 
2370
        else:
 
2371
            order_as_requested = False
1548
2372
        keys = [(revision_id,) for revision_id in revision_ids]
1549
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
1550
 
        texts = {}
 
2373
        if not keys:
 
2374
            return
 
2375
        if order_as_requested:
 
2376
            key_iter = iter(keys)
 
2377
            next_key = key_iter.next()
 
2378
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2379
        text_chunks = {}
1551
2380
        for record in stream:
1552
2381
            if record.storage_kind != 'absent':
1553
 
                texts[record.key] = record.get_bytes_as('fulltext')
 
2382
                chunks = record.get_bytes_as('chunked')
 
2383
                if order_as_requested:
 
2384
                    text_chunks[record.key] = chunks
 
2385
                else:
 
2386
                    yield ''.join(chunks), record.key[-1]
1554
2387
            else:
1555
2388
                raise errors.NoSuchRevision(self, record.key)
1556
 
        for key in keys:
1557
 
            yield texts[key], key[-1]
 
2389
            if order_as_requested:
 
2390
                # Yield as many results as we can while preserving order.
 
2391
                while next_key in text_chunks:
 
2392
                    chunks = text_chunks.pop(next_key)
 
2393
                    yield ''.join(chunks), next_key[-1]
 
2394
                    try:
 
2395
                        next_key = key_iter.next()
 
2396
                    except StopIteration:
 
2397
                        # We still want to fully consume the get_record_stream,
 
2398
                        # just in case it is not actually finished at this point
 
2399
                        next_key = None
 
2400
                        break
1558
2401
 
1559
 
    def deserialise_inventory(self, revision_id, xml):
1560
 
        """Transform the xml into an inventory object. 
 
2402
    def _deserialise_inventory(self, revision_id, xml):
 
2403
        """Transform the xml into an inventory object.
1561
2404
 
1562
2405
        :param revision_id: The expected revision id of the inventory.
1563
2406
        :param xml: A serialised inventory.
1564
2407
        """
1565
 
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
2408
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2409
                    entry_cache=self._inventory_entry_cache,
 
2410
                    return_from_cache=self._safe_to_return_from_cache)
1566
2411
        if result.revision_id != revision_id:
1567
2412
            raise AssertionError('revision id mismatch %s != %s' % (
1568
2413
                result.revision_id, revision_id))
1569
2414
        return result
1570
2415
 
1571
 
    def serialise_inventory(self, inv):
1572
 
        return self._serializer.write_inventory_to_string(inv)
1573
 
 
1574
 
    def _serialise_inventory_to_lines(self, inv):
1575
 
        return self._serializer.write_inventory_to_lines(inv)
1576
 
 
1577
2416
    def get_serializer_format(self):
1578
2417
        return self._serializer.format_num
1579
2418
 
1580
2419
    @needs_read_lock
1581
 
    def get_inventory_xml(self, revision_id):
1582
 
        """Get inventory XML as a file object."""
1583
 
        texts = self._iter_inventory_xmls([revision_id])
 
2420
    def _get_inventory_xml(self, revision_id):
 
2421
        """Get serialized inventory as a string."""
 
2422
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
1584
2423
        try:
1585
2424
            text, revision_id = texts.next()
1586
2425
        except StopIteration:
1587
2426
            raise errors.HistoryMissing(self, 'inventory', revision_id)
1588
2427
        return text
1589
2428
 
1590
 
    @needs_read_lock
1591
 
    def get_inventory_sha1(self, revision_id):
1592
 
        """Return the sha1 hash of the inventory entry
 
2429
    def get_rev_id_for_revno(self, revno, known_pair):
 
2430
        """Return the revision id of a revno, given a later (revno, revid)
 
2431
        pair in the same history.
 
2432
 
 
2433
        :return: if found (True, revid).  If the available history ran out
 
2434
            before reaching the revno, then this returns
 
2435
            (False, (closest_revno, closest_revid)).
1593
2436
        """
1594
 
        return self.get_revision(revision_id).inventory_sha1
 
2437
        known_revno, known_revid = known_pair
 
2438
        partial_history = [known_revid]
 
2439
        distance_from_known = known_revno - revno
 
2440
        if distance_from_known < 0:
 
2441
            raise ValueError(
 
2442
                'requested revno (%d) is later than given known revno (%d)'
 
2443
                % (revno, known_revno))
 
2444
        try:
 
2445
            _iter_for_revno(
 
2446
                self, partial_history, stop_index=distance_from_known)
 
2447
        except errors.RevisionNotPresent, err:
 
2448
            if err.revision_id == known_revid:
 
2449
                # The start revision (known_revid) wasn't found.
 
2450
                raise
 
2451
            # This is a stacked repository with no fallbacks, or a there's a
 
2452
            # left-hand ghost.  Either way, even though the revision named in
 
2453
            # the error isn't in this repo, we know it's the next step in this
 
2454
            # left-hand history.
 
2455
            partial_history.append(err.revision_id)
 
2456
        if len(partial_history) <= distance_from_known:
 
2457
            # Didn't find enough history to get a revid for the revno.
 
2458
            earliest_revno = known_revno - len(partial_history) + 1
 
2459
            return (False, (earliest_revno, partial_history[-1]))
 
2460
        if len(partial_history) - 1 > distance_from_known:
 
2461
            raise AssertionError('_iter_for_revno returned too much history')
 
2462
        return (True, partial_history[-1])
1595
2463
 
1596
2464
    def iter_reverse_revision_history(self, revision_id):
1597
2465
        """Iterate backwards through revision ids in the lefthand history
1604
2472
        while True:
1605
2473
            if next_id in (None, _mod_revision.NULL_REVISION):
1606
2474
                return
 
2475
            try:
 
2476
                parents = graph.get_parent_map([next_id])[next_id]
 
2477
            except KeyError:
 
2478
                raise errors.RevisionNotPresent(next_id, self)
1607
2479
            yield next_id
1608
 
            # Note: The following line may raise KeyError in the event of
1609
 
            # truncated history. We decided not to have a try:except:raise
1610
 
            # RevisionNotPresent here until we see a use for it, because of the
1611
 
            # cost in an inner loop that is by its very nature O(history).
1612
 
            # Robert Collins 20080326
1613
 
            parents = graph.get_parent_map([next_id])[next_id]
1614
2480
            if len(parents) == 0:
1615
2481
                return
1616
2482
            else:
1617
2483
                next_id = parents[0]
1618
2484
 
1619
 
    @needs_read_lock
1620
 
    def get_revision_inventory(self, revision_id):
1621
 
        """Return inventory of a past revision."""
1622
 
        # TODO: Unify this with get_inventory()
1623
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
1624
 
        # must be the same as its revision, so this is trivial.
1625
 
        if revision_id is None:
1626
 
            # This does not make sense: if there is no revision,
1627
 
            # then it is the current tree inventory surely ?!
1628
 
            # and thus get_root_id() is something that looks at the last
1629
 
            # commit on the branch, and the get_root_id is an inventory check.
1630
 
            raise NotImplementedError
1631
 
            # return Inventory(self.get_root_id())
1632
 
        else:
1633
 
            return self.get_inventory(revision_id)
1634
 
 
1635
2485
    def is_shared(self):
1636
2486
        """Return True if this repository is flagged as a shared repository."""
1637
2487
        raise NotImplementedError(self.is_shared)
1651
2501
        for repositories to maintain loaded indices across multiple locks
1652
2502
        by checking inside their implementation of this method to see
1653
2503
        whether their indices are still valid. This depends of course on
1654
 
        the disk format being validatable in this manner.
 
2504
        the disk format being validatable in this manner. This method is
 
2505
        also called by the refresh_data() public interface to cause a refresh
 
2506
        to occur while in a write lock so that data inserted by a smart server
 
2507
        push operation is visible on the client's instance of the physical
 
2508
        repository.
1655
2509
        """
1656
2510
 
1657
2511
    @needs_read_lock
1658
2512
    def revision_tree(self, revision_id):
1659
2513
        """Return Tree for a revision on this branch.
1660
2514
 
1661
 
        `revision_id` may be None for the empty tree revision.
 
2515
        `revision_id` may be NULL_REVISION for the empty tree revision.
1662
2516
        """
 
2517
        revision_id = _mod_revision.ensure_null(revision_id)
1663
2518
        # TODO: refactor this to use an existing revision object
1664
2519
        # so we don't need to read it in twice.
1665
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
1666
 
            return RevisionTree(self, Inventory(root_id=None), 
 
2520
        if revision_id == _mod_revision.NULL_REVISION:
 
2521
            return RevisionTree(self, Inventory(root_id=None),
1667
2522
                                _mod_revision.NULL_REVISION)
1668
2523
        else:
1669
 
            inv = self.get_revision_inventory(revision_id)
 
2524
            inv = self.get_inventory(revision_id)
1670
2525
            return RevisionTree(self, inv, revision_id)
1671
2526
 
1672
2527
    def revision_trees(self, revision_ids):
1673
 
        """Return Tree for a revision on this branch.
 
2528
        """Return Trees for revisions in this repository.
1674
2529
 
1675
 
        `revision_id` may not be None or 'null:'"""
 
2530
        :param revision_ids: a sequence of revision-ids;
 
2531
          a revision-id may not be None or 'null:'
 
2532
        """
1676
2533
        inventories = self.iter_inventories(revision_ids)
1677
2534
        for inv in inventories:
1678
2535
            yield RevisionTree(self, inv, inv.revision_id)
1679
2536
 
 
2537
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2538
        """Return Tree for a revision on this branch with only some files.
 
2539
 
 
2540
        :param revision_ids: a sequence of revision-ids;
 
2541
          a revision-id may not be None or 'null:'
 
2542
        :param file_ids: if not None, the result is filtered
 
2543
          so that only those file-ids, their parents and their
 
2544
          children are included.
 
2545
        """
 
2546
        inventories = self.iter_inventories(revision_ids)
 
2547
        for inv in inventories:
 
2548
            # Should we introduce a FilteredRevisionTree class rather
 
2549
            # than pre-filter the inventory here?
 
2550
            filtered_inv = inv.filter(file_ids)
 
2551
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
2552
 
1680
2553
    @needs_read_lock
1681
2554
    def get_ancestry(self, revision_id, topo_sorted=True):
1682
2555
        """Return a list of revision-ids integrated by a revision.
1683
2556
 
1684
 
        The first element of the list is always None, indicating the origin 
1685
 
        revision.  This might change when we have history horizons, or 
 
2557
        The first element of the list is always None, indicating the origin
 
2558
        revision.  This might change when we have history horizons, or
1686
2559
        perhaps we should have a new API.
1687
 
        
 
2560
 
1688
2561
        This is topologically sorted.
1689
2562
        """
1690
2563
        if _mod_revision.is_null(revision_id):
1707
2580
            keys = tsort.topo_sort(parent_map)
1708
2581
        return [None] + list(keys)
1709
2582
 
1710
 
    def pack(self):
 
2583
    def pack(self, hint=None):
1711
2584
        """Compress the data within the repository.
1712
2585
 
1713
2586
        This operation only makes sense for some repository types. For other
1714
2587
        types it should be a no-op that just returns.
1715
2588
 
1716
2589
        This stub method does not require a lock, but subclasses should use
1717
 
        @needs_write_lock as this is a long running call its reasonable to 
 
2590
        @needs_write_lock as this is a long running call its reasonable to
1718
2591
        implicitly lock for the user.
1719
 
        """
1720
2592
 
1721
 
    @needs_read_lock
1722
 
    @deprecated_method(one_six)
1723
 
    def print_file(self, file, revision_id):
1724
 
        """Print `file` to stdout.
1725
 
        
1726
 
        FIXME RBC 20060125 as John Meinel points out this is a bad api
1727
 
        - it writes to stdout, it assumes that that is valid etc. Fix
1728
 
        by creating a new more flexible convenience function.
 
2593
        :param hint: If not supplied, the whole repository is packed.
 
2594
            If supplied, the repository may use the hint parameter as a
 
2595
            hint for the parts of the repository to pack. A hint can be
 
2596
            obtained from the result of commit_write_group(). Out of
 
2597
            date hints are simply ignored, because concurrent operations
 
2598
            can obsolete them rapidly.
1729
2599
        """
1730
 
        tree = self.revision_tree(revision_id)
1731
 
        # use inventory as it was in that revision
1732
 
        file_id = tree.inventory.path2id(file)
1733
 
        if not file_id:
1734
 
            # TODO: jam 20060427 Write a test for this code path
1735
 
            #       it had a bug in it, and was raising the wrong
1736
 
            #       exception.
1737
 
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
1738
 
        tree.print_file(file_id)
1739
2600
 
1740
2601
    def get_transaction(self):
1741
2602
        return self.control_files.get_transaction()
1742
2603
 
1743
 
    @deprecated_method(one_one)
1744
 
    def get_parents(self, revision_ids):
1745
 
        """See StackedParentsProvider.get_parents"""
1746
 
        parent_map = self.get_parent_map(revision_ids)
1747
 
        return [parent_map.get(r, None) for r in revision_ids]
1748
 
 
1749
2604
    def get_parent_map(self, revision_ids):
1750
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
2605
        """See graph.StackedParentsProvider.get_parent_map"""
1751
2606
        # revisions index works in keys; this just works in revisions
1752
2607
        # therefore wrap and unwrap
1753
2608
        query_keys = []
1762
2617
        for ((revision_id,), parent_keys) in \
1763
2618
                self.revisions.get_parent_map(query_keys).iteritems():
1764
2619
            if parent_keys:
1765
 
                result[revision_id] = tuple(parent_revid
1766
 
                    for (parent_revid,) in parent_keys)
 
2620
                result[revision_id] = tuple([parent_revid
 
2621
                    for (parent_revid,) in parent_keys])
1767
2622
            else:
1768
2623
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1769
2624
        return result
1776
2631
        parents_provider = self._make_parents_provider()
1777
2632
        if (other_repository is not None and
1778
2633
            not self.has_same_location(other_repository)):
1779
 
            parents_provider = graph._StackedParentsProvider(
 
2634
            parents_provider = graph.StackedParentsProvider(
1780
2635
                [parents_provider, other_repository._make_parents_provider()])
1781
2636
        return graph.Graph(parents_provider)
1782
2637
 
1783
 
    def _get_versioned_file_checker(self):
1784
 
        """Return an object suitable for checking versioned files."""
1785
 
        return _VersionedFileChecker(self)
 
2638
    def _get_versioned_file_checker(self, text_key_references=None,
 
2639
        ancestors=None):
 
2640
        """Return an object suitable for checking versioned files.
 
2641
        
 
2642
        :param text_key_references: if non-None, an already built
 
2643
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2644
            to whether they were referred to by the inventory of the
 
2645
            revision_id that they contain. If None, this will be
 
2646
            calculated.
 
2647
        :param ancestors: Optional result from
 
2648
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2649
            available.
 
2650
        """
 
2651
        return _VersionedFileChecker(self,
 
2652
            text_key_references=text_key_references, ancestors=ancestors)
1786
2653
 
1787
2654
    def revision_ids_to_search_result(self, result_set):
1788
2655
        """Convert a set of revision ids to a graph SearchResult."""
1808
2675
                          working trees.
1809
2676
        """
1810
2677
        raise NotImplementedError(self.set_make_working_trees)
1811
 
    
 
2678
 
1812
2679
    def make_working_trees(self):
1813
2680
        """Returns the policy for making working trees on new branches."""
1814
2681
        raise NotImplementedError(self.make_working_trees)
1838
2705
        return record.get_bytes_as('fulltext')
1839
2706
 
1840
2707
    @needs_read_lock
1841
 
    def check(self, revision_ids=None):
 
2708
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1842
2709
        """Check consistency of all history of given revision_ids.
1843
2710
 
1844
2711
        Different repository implementations should override _check().
1845
2712
 
1846
2713
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1847
2714
             will be checked.  Typically the last revision_id of a branch.
 
2715
        :param callback_refs: A dict of check-refs to resolve and callback
 
2716
            the check/_check method on the items listed as wanting the ref.
 
2717
            see bzrlib.check.
 
2718
        :param check_repo: If False do not check the repository contents, just 
 
2719
            calculate the data callback_refs requires and call them back.
1848
2720
        """
1849
 
        return self._check(revision_ids)
 
2721
        return self._check(revision_ids, callback_refs=callback_refs,
 
2722
            check_repo=check_repo)
1850
2723
 
1851
 
    def _check(self, revision_ids):
1852
 
        result = check.Check(self)
1853
 
        result.check()
 
2724
    def _check(self, revision_ids, callback_refs, check_repo):
 
2725
        result = check.Check(self, check_repo=check_repo)
 
2726
        result.check(callback_refs)
1854
2727
        return result
1855
2728
 
1856
 
    def _warn_if_deprecated(self):
 
2729
    def _warn_if_deprecated(self, branch=None):
1857
2730
        global _deprecation_warning_done
1858
2731
        if _deprecation_warning_done:
1859
2732
            return
1860
 
        _deprecation_warning_done = True
1861
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
1862
 
                % (self._format, self.bzrdir.transport.base))
 
2733
        try:
 
2734
            if branch is None:
 
2735
                conf = config.GlobalConfig()
 
2736
            else:
 
2737
                conf = branch.get_config()
 
2738
            if conf.suppress_warning('format_deprecation'):
 
2739
                return
 
2740
            warning("Format %s for %s is deprecated -"
 
2741
                    " please use 'bzr upgrade' to get better performance"
 
2742
                    % (self._format, self.bzrdir.transport.base))
 
2743
        finally:
 
2744
            _deprecation_warning_done = True
1863
2745
 
1864
2746
    def supports_rich_root(self):
1865
2747
        return self._format.rich_root_data
1879
2761
                    revision_id.decode('ascii')
1880
2762
                except UnicodeDecodeError:
1881
2763
                    raise errors.NonAsciiRevisionId(method, self)
1882
 
    
 
2764
 
1883
2765
    def revision_graph_can_have_wrong_parents(self):
1884
2766
        """Is it possible for this repository to have a revision graph with
1885
2767
        incorrect parents?
1939
2821
    """
1940
2822
    repository.start_write_group()
1941
2823
    try:
 
2824
        inventory_cache = lru_cache.LRUCache(10)
1942
2825
        for n, (revision, revision_tree, signature) in enumerate(iterable):
1943
 
            _install_revision(repository, revision, revision_tree, signature)
 
2826
            _install_revision(repository, revision, revision_tree, signature,
 
2827
                inventory_cache)
1944
2828
            if pb is not None:
1945
2829
                pb.update('Transferring revisions', n + 1, num_revisions)
1946
2830
    except:
1950
2834
        repository.commit_write_group()
1951
2835
 
1952
2836
 
1953
 
def _install_revision(repository, rev, revision_tree, signature):
 
2837
def _install_revision(repository, rev, revision_tree, signature,
 
2838
    inventory_cache):
1954
2839
    """Install all revision data into a repository."""
1955
2840
    present_parents = []
1956
2841
    parent_trees = {}
1959
2844
            present_parents.append(p_id)
1960
2845
            parent_trees[p_id] = repository.revision_tree(p_id)
1961
2846
        else:
1962
 
            parent_trees[p_id] = repository.revision_tree(None)
 
2847
            parent_trees[p_id] = repository.revision_tree(
 
2848
                                     _mod_revision.NULL_REVISION)
1963
2849
 
1964
2850
    inv = revision_tree.inventory
1965
2851
    entries = inv.iter_entries()
1992
2878
        repository.texts.add_lines(text_key, text_parents, lines)
1993
2879
    try:
1994
2880
        # install the inventory
1995
 
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
2881
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2882
            # Cache this inventory
 
2883
            inventory_cache[rev.revision_id] = inv
 
2884
            try:
 
2885
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2886
            except KeyError:
 
2887
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2888
            else:
 
2889
                delta = inv._make_delta(basis_inv)
 
2890
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2891
                    rev.revision_id, present_parents)
 
2892
        else:
 
2893
            repository.add_inventory(rev.revision_id, inv, present_parents)
1996
2894
    except errors.RevisionAlreadyPresent:
1997
2895
        pass
1998
2896
    if signature is not None:
2002
2900
 
2003
2901
class MetaDirRepository(Repository):
2004
2902
    """Repositories in the new meta-dir layout.
2005
 
    
 
2903
 
2006
2904
    :ivar _transport: Transport for access to repository control files,
2007
2905
        typically pointing to .bzr/repository.
2008
2906
    """
2033
2931
        else:
2034
2932
            self._transport.put_bytes('no-working-trees', '',
2035
2933
                mode=self.bzrdir._get_file_mode())
2036
 
    
 
2934
 
2037
2935
    def make_working_trees(self):
2038
2936
        """Returns the policy for making working trees on new branches."""
2039
2937
        return not self._transport.has('no-working-trees')
2047
2945
            control_files)
2048
2946
 
2049
2947
 
2050
 
class RepositoryFormatRegistry(registry.Registry):
2051
 
    """Registry of RepositoryFormats."""
2052
 
 
2053
 
    def get(self, format_string):
2054
 
        r = registry.Registry.get(self, format_string)
2055
 
        if callable(r):
2056
 
            r = r()
2057
 
        return r
2058
 
    
2059
 
 
2060
 
format_registry = RepositoryFormatRegistry()
2061
 
"""Registry of formats, indexed by their identifying format string.
 
2948
network_format_registry = registry.FormatRegistry()
 
2949
"""Registry of formats indexed by their network name.
 
2950
 
 
2951
The network name for a repository format is an identifier that can be used when
 
2952
referring to formats with smart server operations. See
 
2953
RepositoryFormat.network_name() for more detail.
 
2954
"""
 
2955
 
 
2956
 
 
2957
format_registry = registry.FormatRegistry(network_format_registry)
 
2958
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2062
2959
 
2063
2960
This can contain either format instances themselves, or classes/factories that
2064
2961
can be called to obtain one.
2071
2968
class RepositoryFormat(object):
2072
2969
    """A repository format.
2073
2970
 
2074
 
    Formats provide three things:
 
2971
    Formats provide four things:
2075
2972
     * An initialization routine to construct repository data on disk.
2076
 
     * a format string which is used when the BzrDir supports versioned
2077
 
       children.
 
2973
     * a optional format string which is used when the BzrDir supports
 
2974
       versioned children.
2078
2975
     * an open routine which returns a Repository instance.
 
2976
     * A network name for referring to the format in smart server RPC
 
2977
       methods.
2079
2978
 
2080
2979
    There is one and only one Format subclass for each on-disk format. But
2081
2980
    there can be one Repository subclass that is used for several different
2082
2981
    formats. The _format attribute on a Repository instance can be used to
2083
2982
    determine the disk format.
2084
2983
 
2085
 
    Formats are placed in an dict by their format string for reference 
2086
 
    during opening. These should be subclasses of RepositoryFormat
2087
 
    for consistency.
 
2984
    Formats are placed in a registry by their format string for reference
 
2985
    during opening. These should be subclasses of RepositoryFormat for
 
2986
    consistency.
2088
2987
 
2089
2988
    Once a format is deprecated, just deprecate the initialize and open
2090
 
    methods on the format class. Do not deprecate the object, as the 
2091
 
    object will be created every system load.
 
2989
    methods on the format class. Do not deprecate the object, as the
 
2990
    object may be created even when a repository instance hasn't been
 
2991
    created.
2092
2992
 
2093
2993
    Common instance attributes:
2094
2994
    _matchingbzrdir - the bzrdir format that the repository format was
2103
3003
    # Can this repository be given external locations to lookup additional
2104
3004
    # data. Set to True or False in derived classes.
2105
3005
    supports_external_lookups = None
 
3006
    # Does this format support CHK bytestring lookups. Set to True or False in
 
3007
    # derived classes.
 
3008
    supports_chks = None
 
3009
    # Should commit add an inventory, or an inventory delta to the repository.
 
3010
    _commit_inv_deltas = True
 
3011
    # What order should fetch operations request streams in?
 
3012
    # The default is unordered as that is the cheapest for an origin to
 
3013
    # provide.
 
3014
    _fetch_order = 'unordered'
 
3015
    # Does this repository format use deltas that can be fetched as-deltas ?
 
3016
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
3017
    # We default to False, which will ensure that enough data to get
 
3018
    # a full text out of any fetch stream will be grabbed.
 
3019
    _fetch_uses_deltas = False
 
3020
    # Should fetch trigger a reconcile after the fetch? Only needed for
 
3021
    # some repository formats that can suffer internal inconsistencies.
 
3022
    _fetch_reconcile = False
 
3023
    # Does this format have < O(tree_size) delta generation. Used to hint what
 
3024
    # code path for commit, amongst other things.
 
3025
    fast_deltas = None
 
3026
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3027
    # (so if there is one pack, the operation can still proceed because it may
 
3028
    # help), and for fetching when data won't have come from the same
 
3029
    # compressor.
 
3030
    pack_compresses = False
 
3031
    # Does the repository inventory storage understand references to trees?
 
3032
    supports_tree_reference = None
 
3033
    # Is the format experimental ?
 
3034
    experimental = False
2106
3035
 
2107
3036
    def __str__(self):
2108
3037
        return "<%s>" % self.__class__.__name__
2117
3046
    @classmethod
2118
3047
    def find_format(klass, a_bzrdir):
2119
3048
        """Return the format for the repository object in a_bzrdir.
2120
 
        
 
3049
 
2121
3050
        This is used by bzr native formats that have a "format" file in
2122
 
        the repository.  Other methods may be used by different types of 
 
3051
        the repository.  Other methods may be used by different types of
2123
3052
        control directory.
2124
3053
        """
2125
3054
        try:
2126
3055
            transport = a_bzrdir.get_repository_transport(None)
2127
 
            format_string = transport.get("format").read()
 
3056
            format_string = transport.get_bytes("format")
2128
3057
            return format_registry.get(format_string)
2129
3058
        except errors.NoSuchFile:
2130
3059
            raise errors.NoRepositoryPresent(a_bzrdir)
2139
3068
    @classmethod
2140
3069
    def unregister_format(klass, format):
2141
3070
        format_registry.remove(format.get_format_string())
2142
 
    
 
3071
 
2143
3072
    @classmethod
2144
3073
    def get_default_format(klass):
2145
3074
        """Return the current default format."""
2148
3077
 
2149
3078
    def get_format_string(self):
2150
3079
        """Return the ASCII format string that identifies this format.
2151
 
        
2152
 
        Note that in pre format ?? repositories the format string is 
 
3080
 
 
3081
        Note that in pre format ?? repositories the format string is
2153
3082
        not permitted nor written to disk.
2154
3083
        """
2155
3084
        raise NotImplementedError(self.get_format_string)
2186
3115
        :param a_bzrdir: The bzrdir to put the new repository in it.
2187
3116
        :param shared: The repository should be initialized as a sharable one.
2188
3117
        :returns: The new repository object.
2189
 
        
 
3118
 
2190
3119
        This may raise UninitializableFormat if shared repository are not
2191
3120
        compatible the a_bzrdir.
2192
3121
        """
2196
3125
        """Is this format supported?
2197
3126
 
2198
3127
        Supported formats must be initializable and openable.
2199
 
        Unsupported formats may not support initialization or committing or 
 
3128
        Unsupported formats may not support initialization or committing or
2200
3129
        some other features depending on the reason for not being supported.
2201
3130
        """
2202
3131
        return True
2203
3132
 
 
3133
    def network_name(self):
 
3134
        """A simple byte string uniquely identifying this format for RPC calls.
 
3135
 
 
3136
        MetaDir repository formats use their disk format string to identify the
 
3137
        repository over the wire. All in one formats such as bzr < 0.8, and
 
3138
        foreign formats like svn/git and hg should use some marker which is
 
3139
        unique and immutable.
 
3140
        """
 
3141
        raise NotImplementedError(self.network_name)
 
3142
 
2204
3143
    def check_conversion_target(self, target_format):
2205
 
        raise NotImplementedError(self.check_conversion_target)
 
3144
        if self.rich_root_data and not target_format.rich_root_data:
 
3145
            raise errors.BadConversionTarget(
 
3146
                'Does not support rich root data.', target_format,
 
3147
                from_format=self)
 
3148
        if (self.supports_tree_reference and 
 
3149
            not getattr(target_format, 'supports_tree_reference', False)):
 
3150
            raise errors.BadConversionTarget(
 
3151
                'Does not support nested trees', target_format,
 
3152
                from_format=self)
2206
3153
 
2207
3154
    def open(self, a_bzrdir, _found=False):
2208
3155
        """Return an instance of this format for the bzrdir a_bzrdir.
2209
 
        
 
3156
 
2210
3157
        _found is a private parameter, do not use it.
2211
3158
        """
2212
3159
        raise NotImplementedError(self.open)
2218
3165
    rich_root_data = False
2219
3166
    supports_tree_reference = False
2220
3167
    supports_external_lookups = False
2221
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
3168
 
 
3169
    @property
 
3170
    def _matchingbzrdir(self):
 
3171
        matching = bzrdir.BzrDirMetaFormat1()
 
3172
        matching.repository_format = self
 
3173
        return matching
2222
3174
 
2223
3175
    def __init__(self):
2224
3176
        super(MetaDirRepositoryFormat, self).__init__()
2251
3203
        finally:
2252
3204
            control_files.unlock()
2253
3205
 
2254
 
 
2255
 
# formats which have no format string are not discoverable
2256
 
# and not independently creatable, so are not registered.  They're 
 
3206
    def network_name(self):
 
3207
        """Metadir formats have matching disk and network format strings."""
 
3208
        return self.get_format_string()
 
3209
 
 
3210
 
 
3211
# Pre-0.8 formats that don't have a disk format string (because they are
 
3212
# versioned by the matching control directory). We use the control directories
 
3213
# disk format string as a key for the network_name because they meet the
 
3214
# constraints (simple string, unique, immutable).
 
3215
network_format_registry.register_lazy(
 
3216
    "Bazaar-NG branch, format 5\n",
 
3217
    'bzrlib.repofmt.weaverepo',
 
3218
    'RepositoryFormat5',
 
3219
)
 
3220
network_format_registry.register_lazy(
 
3221
    "Bazaar-NG branch, format 6\n",
 
3222
    'bzrlib.repofmt.weaverepo',
 
3223
    'RepositoryFormat6',
 
3224
)
 
3225
 
 
3226
# formats which have no format string are not discoverable or independently
 
3227
# creatable on disk, so are not registered in format_registry.  They're
2257
3228
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
2258
3229
# needed, it's constructed directly by the BzrDir.  Non-native formats where
2259
3230
# the repository is not separately opened are similar.
2315
3286
    'bzrlib.repofmt.pack_repo',
2316
3287
    'RepositoryFormatKnitPack5RichRootBroken',
2317
3288
    )
2318
 
 
2319
 
# Development formats. 
2320
 
# 1.5->1.6
2321
 
format_registry.register_lazy(
2322
 
    "Bazaar development format 1 (needs bzr.dev from before 1.6)\n",
2323
 
    'bzrlib.repofmt.pack_repo',
2324
 
    'RepositoryFormatPackDevelopment1',
2325
 
    )
2326
 
format_registry.register_lazy(
2327
 
    ("Bazaar development format 1 with subtree support "
2328
 
        "(needs bzr.dev from before 1.6)\n"),
2329
 
    'bzrlib.repofmt.pack_repo',
2330
 
    'RepositoryFormatPackDevelopment1Subtree',
2331
 
    )
2332
 
# 1.6->1.7 go below here
 
3289
format_registry.register_lazy(
 
3290
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
3291
    'bzrlib.repofmt.pack_repo',
 
3292
    'RepositoryFormatKnitPack6',
 
3293
    )
 
3294
format_registry.register_lazy(
 
3295
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
3296
    'bzrlib.repofmt.pack_repo',
 
3297
    'RepositoryFormatKnitPack6RichRoot',
 
3298
    )
 
3299
 
 
3300
# Development formats.
 
3301
# Obsolete but kept pending a CHK based subtree format.
 
3302
format_registry.register_lazy(
 
3303
    ("Bazaar development format 2 with subtree support "
 
3304
        "(needs bzr.dev from before 1.8)\n"),
 
3305
    'bzrlib.repofmt.pack_repo',
 
3306
    'RepositoryFormatPackDevelopment2Subtree',
 
3307
    )
 
3308
 
 
3309
# 1.14->1.16 go below here
 
3310
format_registry.register_lazy(
 
3311
    'Bazaar development format - group compression and chk inventory'
 
3312
        ' (needs bzr.dev from 1.14)\n',
 
3313
    'bzrlib.repofmt.groupcompress_repo',
 
3314
    'RepositoryFormatCHK1',
 
3315
    )
 
3316
 
 
3317
format_registry.register_lazy(
 
3318
    'Bazaar development format - chk repository with bencode revision '
 
3319
        'serialization (needs bzr.dev from 1.16)\n',
 
3320
    'bzrlib.repofmt.groupcompress_repo',
 
3321
    'RepositoryFormatCHK2',
 
3322
    )
 
3323
format_registry.register_lazy(
 
3324
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3325
    'bzrlib.repofmt.groupcompress_repo',
 
3326
    'RepositoryFormat2a',
 
3327
    )
2333
3328
 
2334
3329
 
2335
3330
class InterRepository(InterObject):
2336
3331
    """This class represents operations taking place between two repositories.
2337
3332
 
2338
3333
    Its instances have methods like copy_content and fetch, and contain
2339
 
    references to the source and target repositories these operations can be 
 
3334
    references to the source and target repositories these operations can be
2340
3335
    carried out on.
2341
3336
 
2342
3337
    Often we will provide convenience methods on 'repository' which carry out
2344
3339
    InterRepository.get(other).method_name(parameters).
2345
3340
    """
2346
3341
 
 
3342
    _walk_to_common_revisions_batch_size = 50
2347
3343
    _optimisers = []
2348
3344
    """The available optimised InterRepository types."""
2349
3345
 
 
3346
    @needs_write_lock
2350
3347
    def copy_content(self, revision_id=None):
2351
 
        raise NotImplementedError(self.copy_content)
2352
 
 
2353
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3348
        """Make a complete copy of the content in self into destination.
 
3349
 
 
3350
        This is a destructive operation! Do not use it on existing
 
3351
        repositories.
 
3352
 
 
3353
        :param revision_id: Only copy the content needed to construct
 
3354
                            revision_id and its parents.
 
3355
        """
 
3356
        try:
 
3357
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3358
        except NotImplementedError:
 
3359
            pass
 
3360
        self.target.fetch(self.source, revision_id=revision_id)
 
3361
 
 
3362
    @needs_write_lock
 
3363
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3364
            fetch_spec=None):
2354
3365
        """Fetch the content required to construct revision_id.
2355
3366
 
2356
3367
        The content is copied from self.source to self.target.
2357
3368
 
2358
3369
        :param revision_id: if None all content is copied, if NULL_REVISION no
2359
3370
                            content is copied.
2360
 
        :param pb: optional progress bar to use for progress reports. If not
2361
 
                   provided a default one will be created.
2362
 
 
2363
 
        :returns: (copied_revision_count, failures).
 
3371
        :param pb: ignored.
 
3372
        :return: None.
2364
3373
        """
2365
 
        # Normally we should find a specific InterRepository subclass to do
2366
 
        # the fetch; if nothing else then at least InterSameDataRepository.
2367
 
        # If none of them is suitable it looks like fetching is not possible;
2368
 
        # we try to give a good message why.  _assert_same_model will probably
2369
 
        # give a helpful message; otherwise a generic one.
2370
 
        self._assert_same_model(self.source, self.target)
2371
 
        raise errors.IncompatibleRepositories(self.source, self.target,
2372
 
            "no suitableInterRepository found")
 
3374
        ui.ui_factory.warn_experimental_format_fetch(self)
 
3375
        f = _mod_fetch.RepoFetcher(to_repository=self.target,
 
3376
                               from_repository=self.source,
 
3377
                               last_revision=revision_id,
 
3378
                               fetch_spec=fetch_spec,
 
3379
                               find_ghosts=find_ghosts)
2373
3380
 
2374
3381
    def _walk_to_common_revisions(self, revision_ids):
2375
3382
        """Walk out from revision_ids in source to revisions target has.
2379
3386
        """
2380
3387
        target_graph = self.target.get_graph()
2381
3388
        revision_ids = frozenset(revision_ids)
2382
 
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
2383
 
            return graph.SearchResult(revision_ids, set(), 0, set())
2384
3389
        missing_revs = set()
2385
3390
        source_graph = self.source.get_graph()
2386
3391
        # ensure we don't pay silly lookup costs.
2387
3392
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
2388
3393
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3394
        searcher_exhausted = False
2389
3395
        while True:
2390
 
            try:
2391
 
                next_revs, ghosts = searcher.next_with_ghosts()
2392
 
            except StopIteration:
2393
 
                break
2394
 
            if revision_ids.intersection(ghosts):
2395
 
                absent_ids = set(revision_ids.intersection(ghosts))
2396
 
                # If all absent_ids are present in target, no error is needed.
2397
 
                absent_ids.difference_update(
2398
 
                    set(target_graph.get_parent_map(absent_ids)))
2399
 
                if absent_ids:
2400
 
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
2401
 
            # we don't care about other ghosts as we can't fetch them and
 
3396
            next_revs = set()
 
3397
            ghosts = set()
 
3398
            # Iterate the searcher until we have enough next_revs
 
3399
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3400
                try:
 
3401
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3402
                    next_revs.update(next_revs_part)
 
3403
                    ghosts.update(ghosts_part)
 
3404
                except StopIteration:
 
3405
                    searcher_exhausted = True
 
3406
                    break
 
3407
            # If there are ghosts in the source graph, and the caller asked for
 
3408
            # them, make sure that they are present in the target.
 
3409
            # We don't care about other ghosts as we can't fetch them and
2402
3410
            # haven't been asked to.
2403
 
            next_revs = set(next_revs)
2404
 
            # we always have NULL_REVISION present.
2405
 
            have_revs = set(target_graph.get_parent_map(next_revs)).union(null_set)
2406
 
            missing_revs.update(next_revs - have_revs)
2407
 
            searcher.stop_searching_any(have_revs)
 
3411
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3412
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3413
            if revs_to_get:
 
3414
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3415
                # we always have NULL_REVISION present.
 
3416
                have_revs = have_revs.union(null_set)
 
3417
                # Check if the target is missing any ghosts we need.
 
3418
                ghosts_to_check.difference_update(have_revs)
 
3419
                if ghosts_to_check:
 
3420
                    # One of the caller's revision_ids is a ghost in both the
 
3421
                    # source and the target.
 
3422
                    raise errors.NoSuchRevision(
 
3423
                        self.source, ghosts_to_check.pop())
 
3424
                missing_revs.update(next_revs - have_revs)
 
3425
                # Because we may have walked past the original stop point, make
 
3426
                # sure everything is stopped
 
3427
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3428
                searcher.stop_searching_any(stop_revs)
 
3429
            if searcher_exhausted:
 
3430
                break
2408
3431
        return searcher.get_result()
2409
 
   
2410
 
    @deprecated_method(one_two)
2411
 
    @needs_read_lock
2412
 
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
2413
 
        """Return the revision ids that source has that target does not.
2414
 
        
2415
 
        These are returned in topological order.
2416
 
 
2417
 
        :param revision_id: only return revision ids included by this
2418
 
                            revision_id.
2419
 
        :param find_ghosts: If True find missing revisions in deep history
2420
 
            rather than just finding the surface difference.
2421
 
        """
2422
 
        return list(self.search_missing_revision_ids(
2423
 
            revision_id, find_ghosts).get_keys())
2424
3432
 
2425
3433
    @needs_read_lock
2426
3434
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2427
3435
        """Return the revision ids that source has that target does not.
2428
 
        
 
3436
 
2429
3437
        :param revision_id: only return revision ids included by this
2430
3438
                            revision_id.
2431
3439
        :param find_ghosts: If True find missing revisions in deep history
2450
3458
    @staticmethod
2451
3459
    def _same_model(source, target):
2452
3460
        """True if source and target have the same data representation.
2453
 
        
 
3461
 
2454
3462
        Note: this is always called on the base class; overriding it in a
2455
3463
        subclass will have no effect.
2456
3464
        """
2474
3482
 
2475
3483
class InterSameDataRepository(InterRepository):
2476
3484
    """Code for converting between repositories that represent the same data.
2477
 
    
 
3485
 
2478
3486
    Data format and model must match for this to work.
2479
3487
    """
2480
3488
 
2481
3489
    @classmethod
2482
3490
    def _get_repo_format_to_test(self):
2483
3491
        """Repository format for testing with.
2484
 
        
 
3492
 
2485
3493
        InterSameData can pull from subtree to subtree and from non-subtree to
2486
3494
        non-subtree, so we test this with the richest repository format.
2487
3495
        """
2492
3500
    def is_compatible(source, target):
2493
3501
        return InterRepository._same_model(source, target)
2494
3502
 
2495
 
    @needs_write_lock
2496
 
    def copy_content(self, revision_id=None):
2497
 
        """Make a complete copy of the content in self into destination.
2498
 
 
2499
 
        This copies both the repository's revision data, and configuration information
2500
 
        such as the make_working_trees setting.
2501
 
        
2502
 
        This is a destructive operation! Do not use it on existing 
2503
 
        repositories.
2504
 
 
2505
 
        :param revision_id: Only copy the content needed to construct
2506
 
                            revision_id and its parents.
2507
 
        """
2508
 
        try:
2509
 
            self.target.set_make_working_trees(self.source.make_working_trees())
2510
 
        except NotImplementedError:
2511
 
            pass
2512
 
        # but don't bother fetching if we have the needed data now.
2513
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
2514
 
            self.target.has_revision(revision_id)):
2515
 
            return
2516
 
        self.target.fetch(self.source, revision_id=revision_id)
2517
 
 
2518
 
    @needs_write_lock
2519
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2520
 
        """See InterRepository.fetch()."""
2521
 
        from bzrlib.fetch import RepoFetcher
2522
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2523
 
               self.source, self.source._format, self.target,
2524
 
               self.target._format)
2525
 
        f = RepoFetcher(to_repository=self.target,
2526
 
                               from_repository=self.source,
2527
 
                               last_revision=revision_id,
2528
 
                               pb=pb, find_ghosts=find_ghosts)
2529
 
        return f.count_copied, f.failed_revisions
2530
 
 
2531
3503
 
2532
3504
class InterWeaveRepo(InterSameDataRepository):
2533
3505
    """Optimised code paths between Weave based repositories.
2534
 
    
 
3506
 
2535
3507
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
2536
3508
    implemented lazy inter-object optimisation.
2537
3509
    """
2544
3516
    @staticmethod
2545
3517
    def is_compatible(source, target):
2546
3518
        """Be compatible with known Weave formats.
2547
 
        
 
3519
 
2548
3520
        We don't test for the stores being of specific types because that
2549
 
        could lead to confusing results, and there is no need to be 
 
3521
        could lead to confusing results, and there is no need to be
2550
3522
        overly general.
2551
3523
        """
2552
3524
        from bzrlib.repofmt.weaverepo import (
2563
3535
                                                RepositoryFormat7)))
2564
3536
        except AttributeError:
2565
3537
            return False
2566
 
    
 
3538
 
2567
3539
    @needs_write_lock
2568
3540
    def copy_content(self, revision_id=None):
2569
3541
        """See InterRepository.copy_content()."""
2579
3551
                self.target.texts.insert_record_stream(
2580
3552
                    self.source.texts.get_record_stream(
2581
3553
                        self.source.texts.keys(), 'topological', False))
2582
 
                pb.update('copying inventory', 0, 1)
 
3554
                pb.update('Copying inventory', 0, 1)
2583
3555
                self.target.inventories.insert_record_stream(
2584
3556
                    self.source.inventories.get_record_stream(
2585
3557
                        self.source.inventories.keys(), 'topological', False))
2596
3568
        else:
2597
3569
            self.target.fetch(self.source, revision_id=revision_id)
2598
3570
 
2599
 
    @needs_write_lock
2600
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2601
 
        """See InterRepository.fetch()."""
2602
 
        from bzrlib.fetch import RepoFetcher
2603
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2604
 
               self.source, self.source._format, self.target, self.target._format)
2605
 
        f = RepoFetcher(to_repository=self.target,
2606
 
                               from_repository=self.source,
2607
 
                               last_revision=revision_id,
2608
 
                               pb=pb, find_ghosts=find_ghosts)
2609
 
        return f.count_copied, f.failed_revisions
2610
 
 
2611
3571
    @needs_read_lock
2612
3572
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2613
3573
        """See InterRepository.missing_revision_ids()."""
2614
3574
        # we want all revisions to satisfy revision_id in source.
2615
3575
        # but we don't want to stat every file here and there.
2616
 
        # we want then, all revisions other needs to satisfy revision_id 
 
3576
        # we want then, all revisions other needs to satisfy revision_id
2617
3577
        # checked, but not those that we have locally.
2618
 
        # so the first thing is to get a subset of the revisions to 
 
3578
        # so the first thing is to get a subset of the revisions to
2619
3579
        # satisfy revision_id in source, and then eliminate those that
2620
 
        # we do already have. 
2621
 
        # this is slow on high latency connection to self, but as as this
2622
 
        # disk format scales terribly for push anyway due to rewriting 
 
3580
        # we do already have.
 
3581
        # this is slow on high latency connection to self, but as this
 
3582
        # disk format scales terribly for push anyway due to rewriting
2623
3583
        # inventory.weave, this is considered acceptable.
2624
3584
        # - RBC 20060209
2625
3585
        if revision_id is not None:
2645
3605
            # and the tip revision was validated by get_ancestry.
2646
3606
            result_set = required_revisions
2647
3607
        else:
2648
 
            # if we just grabbed the possibly available ids, then 
 
3608
            # if we just grabbed the possibly available ids, then
2649
3609
            # we only have an estimate of whats available and need to validate
2650
3610
            # that against the revision records.
2651
3611
            result_set = set(
2664
3624
    @staticmethod
2665
3625
    def is_compatible(source, target):
2666
3626
        """Be compatible with known Knit formats.
2667
 
        
 
3627
 
2668
3628
        We don't test for the stores being of specific types because that
2669
 
        could lead to confusing results, and there is no need to be 
 
3629
        could lead to confusing results, and there is no need to be
2670
3630
        overly general.
2671
3631
        """
2672
3632
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
2677
3637
            return False
2678
3638
        return are_knits and InterRepository._same_model(source, target)
2679
3639
 
2680
 
    @needs_write_lock
2681
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2682
 
        """See InterRepository.fetch()."""
2683
 
        from bzrlib.fetch import RepoFetcher
2684
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2685
 
               self.source, self.source._format, self.target, self.target._format)
2686
 
        f = RepoFetcher(to_repository=self.target,
2687
 
                            from_repository=self.source,
2688
 
                            last_revision=revision_id,
2689
 
                            pb=pb, find_ghosts=find_ghosts)
2690
 
        return f.count_copied, f.failed_revisions
2691
 
 
2692
3640
    @needs_read_lock
2693
3641
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2694
3642
        """See InterRepository.missing_revision_ids()."""
2715
3663
            # and the tip revision was validated by get_ancestry.
2716
3664
            result_set = required_revisions
2717
3665
        else:
2718
 
            # if we just grabbed the possibly available ids, then 
 
3666
            # if we just grabbed the possibly available ids, then
2719
3667
            # we only have an estimate of whats available and need to validate
2720
3668
            # that against the revision records.
2721
3669
            result_set = set(
2723
3671
        return self.source.revision_ids_to_search_result(result_set)
2724
3672
 
2725
3673
 
2726
 
class InterPackRepo(InterSameDataRepository):
2727
 
    """Optimised code paths between Pack based repositories."""
2728
 
 
2729
 
    @classmethod
2730
 
    def _get_repo_format_to_test(self):
2731
 
        from bzrlib.repofmt import pack_repo
2732
 
        return pack_repo.RepositoryFormatKnitPack1()
2733
 
 
2734
 
    @staticmethod
2735
 
    def is_compatible(source, target):
2736
 
        """Be compatible with known Pack formats.
2737
 
        
2738
 
        We don't test for the stores being of specific types because that
2739
 
        could lead to confusing results, and there is no need to be 
2740
 
        overly general.
2741
 
        """
2742
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
2743
 
        try:
2744
 
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
2745
 
                isinstance(target._format, RepositoryFormatPack))
2746
 
        except AttributeError:
2747
 
            return False
2748
 
        return are_packs and InterRepository._same_model(source, target)
2749
 
 
2750
 
    @needs_write_lock
2751
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2752
 
        """See InterRepository.fetch()."""
2753
 
        if (len(self.source._fallback_repositories) > 0 or
2754
 
            len(self.target._fallback_repositories) > 0):
2755
 
            # The pack layer is not aware of fallback repositories, so when
2756
 
            # fetching from a stacked repository or into a stacked repository
2757
 
            # we use the generic fetch logic which uses the VersionedFiles
2758
 
            # attributes on repository.
2759
 
            from bzrlib.fetch import RepoFetcher
2760
 
            fetcher = RepoFetcher(self.target, self.source, revision_id,
2761
 
                                  pb, find_ghosts)
2762
 
            return fetcher.count_copied, fetcher.failed_revisions
2763
 
        from bzrlib.repofmt.pack_repo import Packer
2764
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2765
 
               self.source, self.source._format, self.target, self.target._format)
2766
 
        self.count_copied = 0
2767
 
        if revision_id is None:
2768
 
            # TODO:
2769
 
            # everything to do - use pack logic
2770
 
            # to fetch from all packs to one without
2771
 
            # inventory parsing etc, IFF nothing to be copied is in the target.
2772
 
            # till then:
2773
 
            source_revision_ids = frozenset(self.source.all_revision_ids())
2774
 
            revision_ids = source_revision_ids - \
2775
 
                frozenset(self.target.get_parent_map(source_revision_ids))
2776
 
            revision_keys = [(revid,) for revid in revision_ids]
2777
 
            index = self.target._pack_collection.revision_index.combined_index
2778
 
            present_revision_ids = set(item[1][0] for item in
2779
 
                index.iter_entries(revision_keys))
2780
 
            revision_ids = set(revision_ids) - present_revision_ids
2781
 
            # implementing the TODO will involve:
2782
 
            # - detecting when all of a pack is selected
2783
 
            # - avoiding as much as possible pre-selection, so the
2784
 
            # more-core routines such as create_pack_from_packs can filter in
2785
 
            # a just-in-time fashion. (though having a HEADS list on a
2786
 
            # repository might make this a lot easier, because we could
2787
 
            # sensibly detect 'new revisions' without doing a full index scan.
2788
 
        elif _mod_revision.is_null(revision_id):
2789
 
            # nothing to do:
2790
 
            return (0, [])
2791
 
        else:
2792
 
            try:
2793
 
                revision_ids = self.search_missing_revision_ids(revision_id,
2794
 
                    find_ghosts=find_ghosts).get_keys()
2795
 
            except errors.NoSuchRevision:
2796
 
                raise errors.InstallFailed([revision_id])
2797
 
            if len(revision_ids) == 0:
2798
 
                return (0, [])
2799
 
        packs = self.source._pack_collection.all_packs()
2800
 
        pack = Packer(self.target._pack_collection, packs, '.fetch',
2801
 
            revision_ids).pack()
2802
 
        if pack is not None:
2803
 
            self.target._pack_collection._save_pack_names()
2804
 
            # Trigger an autopack. This may duplicate effort as we've just done
2805
 
            # a pack creation, but for now it is simpler to think about as
2806
 
            # 'upload data, then repack if needed'.
2807
 
            self.target._pack_collection.autopack()
2808
 
            return (pack.get_revision_count(), [])
2809
 
        else:
2810
 
            return (0, [])
2811
 
 
2812
 
    @needs_read_lock
2813
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2814
 
        """See InterRepository.missing_revision_ids().
2815
 
        
2816
 
        :param find_ghosts: Find ghosts throughout the ancestry of
2817
 
            revision_id.
2818
 
        """
2819
 
        if not find_ghosts and revision_id is not None:
2820
 
            return self._walk_to_common_revisions([revision_id])
2821
 
        elif revision_id is not None:
2822
 
            # Find ghosts: search for revisions pointing from one repository to
2823
 
            # the other, and vice versa, anywhere in the history of revision_id.
2824
 
            graph = self.target.get_graph(other_repository=self.source)
2825
 
            searcher = graph._make_breadth_first_searcher([revision_id])
2826
 
            found_ids = set()
2827
 
            while True:
2828
 
                try:
2829
 
                    next_revs, ghosts = searcher.next_with_ghosts()
2830
 
                except StopIteration:
2831
 
                    break
2832
 
                if revision_id in ghosts:
2833
 
                    raise errors.NoSuchRevision(self.source, revision_id)
2834
 
                found_ids.update(next_revs)
2835
 
                found_ids.update(ghosts)
2836
 
            found_ids = frozenset(found_ids)
2837
 
            # Double query here: should be able to avoid this by changing the
2838
 
            # graph api further.
2839
 
            result_set = found_ids - frozenset(
2840
 
                self.target.get_parent_map(found_ids))
2841
 
        else:
2842
 
            source_ids = self.source.all_revision_ids()
2843
 
            # source_ids is the worst possible case we may need to pull.
2844
 
            # now we want to filter source_ids against what we actually
2845
 
            # have in target, but don't try to check for existence where we know
2846
 
            # we do not have a revision as that would be pointless.
2847
 
            target_ids = set(self.target.all_revision_ids())
2848
 
            result_set = set(source_ids).difference(target_ids)
2849
 
        return self.source.revision_ids_to_search_result(result_set)
2850
 
 
2851
 
 
2852
 
class InterModel1and2(InterRepository):
2853
 
 
2854
 
    @classmethod
2855
 
    def _get_repo_format_to_test(self):
2856
 
        return None
2857
 
 
2858
 
    @staticmethod
2859
 
    def is_compatible(source, target):
2860
 
        if not source.supports_rich_root() and target.supports_rich_root():
2861
 
            return True
2862
 
        else:
2863
 
            return False
2864
 
 
2865
 
    @needs_write_lock
2866
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2867
 
        """See InterRepository.fetch()."""
2868
 
        from bzrlib.fetch import Model1toKnit2Fetcher
2869
 
        f = Model1toKnit2Fetcher(to_repository=self.target,
2870
 
                                 from_repository=self.source,
2871
 
                                 last_revision=revision_id,
2872
 
                                 pb=pb, find_ghosts=find_ghosts)
2873
 
        return f.count_copied, f.failed_revisions
2874
 
 
2875
 
    @needs_write_lock
2876
 
    def copy_content(self, revision_id=None):
2877
 
        """Make a complete copy of the content in self into destination.
2878
 
        
2879
 
        This is a destructive operation! Do not use it on existing 
2880
 
        repositories.
2881
 
 
2882
 
        :param revision_id: Only copy the content needed to construct
2883
 
                            revision_id and its parents.
2884
 
        """
2885
 
        try:
2886
 
            self.target.set_make_working_trees(self.source.make_working_trees())
2887
 
        except NotImplementedError:
2888
 
            pass
2889
 
        # but don't bother fetching if we have the needed data now.
2890
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
2891
 
            self.target.has_revision(revision_id)):
2892
 
            return
2893
 
        self.target.fetch(self.source, revision_id=revision_id)
2894
 
 
2895
 
 
2896
 
class InterKnit1and2(InterKnitRepo):
2897
 
 
2898
 
    @classmethod
2899
 
    def _get_repo_format_to_test(self):
2900
 
        return None
2901
 
 
2902
 
    @staticmethod
2903
 
    def is_compatible(source, target):
2904
 
        """Be compatible with Knit1 source and Knit3 target"""
2905
 
        try:
2906
 
            from bzrlib.repofmt.knitrepo import (
2907
 
                RepositoryFormatKnit1,
2908
 
                RepositoryFormatKnit3,
2909
 
                )
2910
 
            from bzrlib.repofmt.pack_repo import (
2911
 
                RepositoryFormatKnitPack1,
2912
 
                RepositoryFormatKnitPack3,
2913
 
                RepositoryFormatKnitPack4,
2914
 
                RepositoryFormatKnitPack5,
2915
 
                RepositoryFormatKnitPack5RichRoot,
2916
 
                RepositoryFormatPackDevelopment1,
2917
 
                RepositoryFormatPackDevelopment1Subtree,
2918
 
                )
2919
 
            norichroot = (
2920
 
                RepositoryFormatKnit1,            # no rr, no subtree
2921
 
                RepositoryFormatKnitPack1,        # no rr, no subtree
2922
 
                RepositoryFormatPackDevelopment1, # no rr, no subtree
2923
 
                RepositoryFormatKnitPack5,        # no rr, no subtree
2924
 
                )
2925
 
            richroot = (
2926
 
                RepositoryFormatKnit3,            # rr, subtree
2927
 
                RepositoryFormatKnitPack3,        # rr, subtree
2928
 
                RepositoryFormatKnitPack4,        # rr, no subtree
2929
 
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
2930
 
                RepositoryFormatPackDevelopment1Subtree, # rr, subtree
2931
 
                )
2932
 
            for format in norichroot:
2933
 
                if format.rich_root_data:
2934
 
                    raise AssertionError('Format %s is a rich-root format'
2935
 
                        ' but is included in the non-rich-root list'
2936
 
                        % (format,))
2937
 
            for format in richroot:
2938
 
                if not format.rich_root_data:
2939
 
                    raise AssertionError('Format %s is not a rich-root format'
2940
 
                        ' but is included in the rich-root list'
2941
 
                        % (format,))
2942
 
            # TODO: One alternative is to just check format.rich_root_data,
2943
 
            #       instead of keeping membership lists. However, the formats
2944
 
            #       *also* have to use the same 'Knit' style of storage
2945
 
            #       (line-deltas, fulltexts, etc.)
2946
 
            return (isinstance(source._format, norichroot) and
2947
 
                    isinstance(target._format, richroot))
2948
 
        except AttributeError:
2949
 
            return False
2950
 
 
2951
 
    @needs_write_lock
2952
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2953
 
        """See InterRepository.fetch()."""
2954
 
        from bzrlib.fetch import Knit1to2Fetcher
2955
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2956
 
               self.source, self.source._format, self.target, 
2957
 
               self.target._format)
2958
 
        f = Knit1to2Fetcher(to_repository=self.target,
2959
 
                            from_repository=self.source,
2960
 
                            last_revision=revision_id,
2961
 
                            pb=pb, find_ghosts=find_ghosts)
2962
 
        return f.count_copied, f.failed_revisions
2963
 
 
2964
 
 
2965
 
class InterDifferingSerializer(InterKnitRepo):
 
3674
class InterDifferingSerializer(InterRepository):
2966
3675
 
2967
3676
    @classmethod
2968
3677
    def _get_repo_format_to_test(self):
2971
3680
    @staticmethod
2972
3681
    def is_compatible(source, target):
2973
3682
        """Be compatible with Knit2 source and Knit3 target"""
2974
 
        if source.supports_rich_root() != target.supports_rich_root():
2975
 
            return False
2976
 
        # Ideally, we'd support fetching if the source had no tree references
2977
 
        # even if it supported them...
2978
 
        if (getattr(source, '_format.supports_tree_reference', False) and
2979
 
            not getattr(target, '_format.supports_tree_reference', False)):
 
3683
        # This is redundant with format.check_conversion_target(), however that
 
3684
        # raises an exception, and we just want to say "False" as in we won't
 
3685
        # support converting between these formats.
 
3686
        if 'IDS_never' in debug.debug_flags:
 
3687
            return False
 
3688
        if source.supports_rich_root() and not target.supports_rich_root():
 
3689
            return False
 
3690
        if (source._format.supports_tree_reference
 
3691
            and not target._format.supports_tree_reference):
 
3692
            return False
 
3693
        if target._fallback_repositories and target._format.supports_chks:
 
3694
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3695
            # adds to stacked repos.
 
3696
            return False
 
3697
        if 'IDS_always' in debug.debug_flags:
 
3698
            return True
 
3699
        # Only use this code path for local source and target.  IDS does far
 
3700
        # too much IO (both bandwidth and roundtrips) over a network.
 
3701
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3702
            return False
 
3703
        if not target.bzrdir.transport.base.startswith('file:///'):
2980
3704
            return False
2981
3705
        return True
2982
3706
 
 
3707
    def _get_trees(self, revision_ids, cache):
 
3708
        possible_trees = []
 
3709
        for rev_id in revision_ids:
 
3710
            if rev_id in cache:
 
3711
                possible_trees.append((rev_id, cache[rev_id]))
 
3712
            else:
 
3713
                # Not cached, but inventory might be present anyway.
 
3714
                try:
 
3715
                    tree = self.source.revision_tree(rev_id)
 
3716
                except errors.NoSuchRevision:
 
3717
                    # Nope, parent is ghost.
 
3718
                    pass
 
3719
                else:
 
3720
                    cache[rev_id] = tree
 
3721
                    possible_trees.append((rev_id, tree))
 
3722
        return possible_trees
 
3723
 
 
3724
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3725
        """Get the best delta and base for this revision.
 
3726
 
 
3727
        :return: (basis_id, delta)
 
3728
        """
 
3729
        deltas = []
 
3730
        # Generate deltas against each tree, to find the shortest.
 
3731
        texts_possibly_new_in_tree = set()
 
3732
        for basis_id, basis_tree in possible_trees:
 
3733
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3734
            for old_path, new_path, file_id, new_entry in delta:
 
3735
                if new_path is None:
 
3736
                    # This file_id isn't present in the new rev, so we don't
 
3737
                    # care about it.
 
3738
                    continue
 
3739
                if not new_path:
 
3740
                    # Rich roots are handled elsewhere...
 
3741
                    continue
 
3742
                kind = new_entry.kind
 
3743
                if kind != 'directory' and kind != 'file':
 
3744
                    # No text record associated with this inventory entry.
 
3745
                    continue
 
3746
                # This is a directory or file that has changed somehow.
 
3747
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
 
3748
            deltas.append((len(delta), basis_id, delta))
 
3749
        deltas.sort()
 
3750
        return deltas[0][1:]
 
3751
 
 
3752
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3753
        """Find all parent revisions that are absent, but for which the
 
3754
        inventory is present, and copy those inventories.
 
3755
 
 
3756
        This is necessary to preserve correctness when the source is stacked
 
3757
        without fallbacks configured.  (Note that in cases like upgrade the
 
3758
        source may be not have _fallback_repositories even though it is
 
3759
        stacked.)
 
3760
        """
 
3761
        parent_revs = set()
 
3762
        for parents in parent_map.values():
 
3763
            parent_revs.update(parents)
 
3764
        present_parents = self.source.get_parent_map(parent_revs)
 
3765
        absent_parents = set(parent_revs).difference(present_parents)
 
3766
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3767
            (rev_id,) for rev_id in absent_parents)
 
3768
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3769
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3770
            current_revision_id = parent_tree.get_revision_id()
 
3771
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3772
                (current_revision_id,)]
 
3773
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3774
            basis_id = _mod_revision.NULL_REVISION
 
3775
            basis_tree = self.source.revision_tree(basis_id)
 
3776
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3777
            self.target.add_inventory_by_delta(
 
3778
                basis_id, delta, current_revision_id, parents_parents)
 
3779
            cache[current_revision_id] = parent_tree
 
3780
 
 
3781
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3782
        """Fetch across a few revisions.
 
3783
 
 
3784
        :param revision_ids: The revisions to copy
 
3785
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3786
            as a basis for delta when no other base is available
 
3787
        :param cache: A cache of RevisionTrees that we can use.
 
3788
        :param a_graph: A Graph object to determine the heads() of the
 
3789
            rich-root data stream.
 
3790
        :return: The revision_id of the last converted tree. The RevisionTree
 
3791
            for it will be in cache
 
3792
        """
 
3793
        # Walk though all revisions; get inventory deltas, copy referenced
 
3794
        # texts that delta references, insert the delta, revision and
 
3795
        # signature.
 
3796
        root_keys_to_create = set()
 
3797
        text_keys = set()
 
3798
        pending_deltas = []
 
3799
        pending_revisions = []
 
3800
        parent_map = self.source.get_parent_map(revision_ids)
 
3801
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3802
        self.source._safe_to_return_from_cache = True
 
3803
        for tree in self.source.revision_trees(revision_ids):
 
3804
            # Find a inventory delta for this revision.
 
3805
            # Find text entries that need to be copied, too.
 
3806
            current_revision_id = tree.get_revision_id()
 
3807
            parent_ids = parent_map.get(current_revision_id, ())
 
3808
            parent_trees = self._get_trees(parent_ids, cache)
 
3809
            possible_trees = list(parent_trees)
 
3810
            if len(possible_trees) == 0:
 
3811
                # There either aren't any parents, or the parents are ghosts,
 
3812
                # so just use the last converted tree.
 
3813
                possible_trees.append((basis_id, cache[basis_id]))
 
3814
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3815
                                                           possible_trees)
 
3816
            revision = self.source.get_revision(current_revision_id)
 
3817
            pending_deltas.append((basis_id, delta,
 
3818
                current_revision_id, revision.parent_ids))
 
3819
            if self._converting_to_rich_root:
 
3820
                self._revision_id_to_root_id[current_revision_id] = \
 
3821
                    tree.get_root_id()
 
3822
            # Determine which texts are in present in this revision but not in
 
3823
            # any of the available parents.
 
3824
            texts_possibly_new_in_tree = set()
 
3825
            for old_path, new_path, file_id, entry in delta:
 
3826
                if new_path is None:
 
3827
                    # This file_id isn't present in the new rev
 
3828
                    continue
 
3829
                if not new_path:
 
3830
                    # This is the root
 
3831
                    if not self.target.supports_rich_root():
 
3832
                        # The target doesn't support rich root, so we don't
 
3833
                        # copy
 
3834
                        continue
 
3835
                    if self._converting_to_rich_root:
 
3836
                        # This can't be copied normally, we have to insert
 
3837
                        # it specially
 
3838
                        root_keys_to_create.add((file_id, entry.revision))
 
3839
                        continue
 
3840
                kind = entry.kind
 
3841
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3842
            for basis_id, basis_tree in possible_trees:
 
3843
                basis_inv = basis_tree.inventory
 
3844
                for file_key in list(texts_possibly_new_in_tree):
 
3845
                    file_id, file_revision = file_key
 
3846
                    try:
 
3847
                        entry = basis_inv[file_id]
 
3848
                    except errors.NoSuchId:
 
3849
                        continue
 
3850
                    if entry.revision == file_revision:
 
3851
                        texts_possibly_new_in_tree.remove(file_key)
 
3852
            text_keys.update(texts_possibly_new_in_tree)
 
3853
            pending_revisions.append(revision)
 
3854
            cache[current_revision_id] = tree
 
3855
            basis_id = current_revision_id
 
3856
        self.source._safe_to_return_from_cache = False
 
3857
        # Copy file texts
 
3858
        from_texts = self.source.texts
 
3859
        to_texts = self.target.texts
 
3860
        if root_keys_to_create:
 
3861
            root_stream = _mod_fetch._new_root_data_stream(
 
3862
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3863
                self.source, graph=a_graph)
 
3864
            to_texts.insert_record_stream(root_stream)
 
3865
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3866
            text_keys, self.target._format._fetch_order,
 
3867
            not self.target._format._fetch_uses_deltas))
 
3868
        # insert inventory deltas
 
3869
        for delta in pending_deltas:
 
3870
            self.target.add_inventory_by_delta(*delta)
 
3871
        if self.target._fallback_repositories:
 
3872
            # Make sure this stacked repository has all the parent inventories
 
3873
            # for the new revisions that we are about to insert.  We do this
 
3874
            # before adding the revisions so that no revision is added until
 
3875
            # all the inventories it may depend on are added.
 
3876
            # Note that this is overzealous, as we may have fetched these in an
 
3877
            # earlier batch.
 
3878
            parent_ids = set()
 
3879
            revision_ids = set()
 
3880
            for revision in pending_revisions:
 
3881
                revision_ids.add(revision.revision_id)
 
3882
                parent_ids.update(revision.parent_ids)
 
3883
            parent_ids.difference_update(revision_ids)
 
3884
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3885
            parent_map = self.source.get_parent_map(parent_ids)
 
3886
            # we iterate over parent_map and not parent_ids because we don't
 
3887
            # want to try copying any revision which is a ghost
 
3888
            for parent_tree in self.source.revision_trees(parent_map):
 
3889
                current_revision_id = parent_tree.get_revision_id()
 
3890
                parents_parents = parent_map[current_revision_id]
 
3891
                possible_trees = self._get_trees(parents_parents, cache)
 
3892
                if len(possible_trees) == 0:
 
3893
                    # There either aren't any parents, or the parents are
 
3894
                    # ghosts, so just use the last converted tree.
 
3895
                    possible_trees.append((basis_id, cache[basis_id]))
 
3896
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3897
                    parents_parents, possible_trees)
 
3898
                self.target.add_inventory_by_delta(
 
3899
                    basis_id, delta, current_revision_id, parents_parents)
 
3900
        # insert signatures and revisions
 
3901
        for revision in pending_revisions:
 
3902
            try:
 
3903
                signature = self.source.get_signature_text(
 
3904
                    revision.revision_id)
 
3905
                self.target.add_signature_text(revision.revision_id,
 
3906
                    signature)
 
3907
            except errors.NoSuchRevision:
 
3908
                pass
 
3909
            self.target.add_revision(revision.revision_id, revision)
 
3910
        return basis_id
 
3911
 
 
3912
    def _fetch_all_revisions(self, revision_ids, pb):
 
3913
        """Fetch everything for the list of revisions.
 
3914
 
 
3915
        :param revision_ids: The list of revisions to fetch. Must be in
 
3916
            topological order.
 
3917
        :param pb: A ProgressTask
 
3918
        :return: None
 
3919
        """
 
3920
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3921
        batch_size = 100
 
3922
        cache = lru_cache.LRUCache(100)
 
3923
        cache[basis_id] = basis_tree
 
3924
        del basis_tree # We don't want to hang on to it here
 
3925
        hints = []
 
3926
        if self._converting_to_rich_root and len(revision_ids) > 100:
 
3927
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
 
3928
                                                            revision_ids)
 
3929
        else:
 
3930
            a_graph = None
 
3931
 
 
3932
        for offset in range(0, len(revision_ids), batch_size):
 
3933
            self.target.start_write_group()
 
3934
            try:
 
3935
                pb.update('Transferring revisions', offset,
 
3936
                          len(revision_ids))
 
3937
                batch = revision_ids[offset:offset+batch_size]
 
3938
                basis_id = self._fetch_batch(batch, basis_id, cache,
 
3939
                                             a_graph=a_graph)
 
3940
            except:
 
3941
                self.source._safe_to_return_from_cache = False
 
3942
                self.target.abort_write_group()
 
3943
                raise
 
3944
            else:
 
3945
                hint = self.target.commit_write_group()
 
3946
                if hint:
 
3947
                    hints.extend(hint)
 
3948
        if hints and self.target._format.pack_compresses:
 
3949
            self.target.pack(hint=hints)
 
3950
        pb.update('Transferring revisions', len(revision_ids),
 
3951
                  len(revision_ids))
 
3952
 
2983
3953
    @needs_write_lock
2984
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3954
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3955
            fetch_spec=None):
2985
3956
        """See InterRepository.fetch()."""
 
3957
        if fetch_spec is not None:
 
3958
            raise AssertionError("Not implemented yet...")
 
3959
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3960
        #
 
3961
        # nb this is only active for local-local fetches; other things using
 
3962
        # streaming.
 
3963
        ui.ui_factory.warn_cross_format_fetch(self.source._format,
 
3964
            self.target._format)
 
3965
        ui.ui_factory.warn_experimental_format_fetch(self)
 
3966
        if (not self.source.supports_rich_root()
 
3967
            and self.target.supports_rich_root()):
 
3968
            self._converting_to_rich_root = True
 
3969
            self._revision_id_to_root_id = {}
 
3970
        else:
 
3971
            self._converting_to_rich_root = False
2986
3972
        revision_ids = self.target.search_missing_revision_ids(self.source,
2987
3973
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3974
        if not revision_ids:
 
3975
            return 0, 0
2988
3976
        revision_ids = tsort.topo_sort(
2989
3977
            self.source.get_graph().get_parent_map(revision_ids))
2990
 
        def revisions_iterator():
2991
 
            for current_revision_id in revision_ids:
2992
 
                revision = self.source.get_revision(current_revision_id)
2993
 
                tree = self.source.revision_tree(current_revision_id)
2994
 
                try:
2995
 
                    signature = self.source.get_signature_text(
2996
 
                        current_revision_id)
2997
 
                except errors.NoSuchRevision:
2998
 
                    signature = None
2999
 
                yield revision, tree, signature
 
3978
        if not revision_ids:
 
3979
            return 0, 0
 
3980
        # Walk though all revisions; get inventory deltas, copy referenced
 
3981
        # texts that delta references, insert the delta, revision and
 
3982
        # signature.
3000
3983
        if pb is None:
3001
3984
            my_pb = ui.ui_factory.nested_progress_bar()
3002
3985
            pb = my_pb
3003
3986
        else:
 
3987
            symbol_versioning.warn(
 
3988
                symbol_versioning.deprecated_in((1, 14, 0))
 
3989
                % "pb parameter to fetch()")
3004
3990
            my_pb = None
3005
3991
        try:
3006
 
            install_revisions(self.target, revisions_iterator(),
3007
 
                              len(revision_ids), pb)
 
3992
            self._fetch_all_revisions(revision_ids, pb)
3008
3993
        finally:
3009
3994
            if my_pb is not None:
3010
3995
                my_pb.finished()
3011
3996
        return len(revision_ids), 0
3012
3997
 
3013
 
 
3014
 
class InterOtherToRemote(InterRepository):
3015
 
 
3016
 
    def __init__(self, source, target):
3017
 
        InterRepository.__init__(self, source, target)
3018
 
        self._real_inter = None
3019
 
 
3020
 
    @staticmethod
3021
 
    def is_compatible(source, target):
3022
 
        if isinstance(target, remote.RemoteRepository):
3023
 
            return True
3024
 
        return False
3025
 
 
3026
 
    def _ensure_real_inter(self):
3027
 
        if self._real_inter is None:
3028
 
            self.target._ensure_real()
3029
 
            real_target = self.target._real_repository
3030
 
            self._real_inter = InterRepository.get(self.source, real_target)
3031
 
    
3032
 
    def copy_content(self, revision_id=None):
3033
 
        self._ensure_real_inter()
3034
 
        self._real_inter.copy_content(revision_id=revision_id)
3035
 
 
3036
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3037
 
        self._ensure_real_inter()
3038
 
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
3039
 
            find_ghosts=find_ghosts)
3040
 
 
3041
 
    @classmethod
3042
 
    def _get_repo_format_to_test(self):
3043
 
        return None
3044
 
 
3045
 
 
3046
 
class InterRemoteToOther(InterRepository):
3047
 
 
3048
 
    def __init__(self, source, target):
3049
 
        InterRepository.__init__(self, source, target)
3050
 
        self._real_inter = None
3051
 
 
3052
 
    @staticmethod
3053
 
    def is_compatible(source, target):
3054
 
        if not isinstance(source, remote.RemoteRepository):
3055
 
            return False
3056
 
        # Is source's model compatible with target's model?
3057
 
        source._ensure_real()
3058
 
        real_source = source._real_repository
3059
 
        if isinstance(real_source, remote.RemoteRepository):
3060
 
            raise NotImplementedError(
3061
 
                "We don't support remote repos backed by remote repos yet.")
3062
 
        return InterRepository._same_model(real_source, target)
3063
 
 
3064
 
    def _ensure_real_inter(self):
3065
 
        if self._real_inter is None:
3066
 
            self.source._ensure_real()
3067
 
            real_source = self.source._real_repository
3068
 
            self._real_inter = InterRepository.get(real_source, self.target)
3069
 
    
3070
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3071
 
        self._ensure_real_inter()
3072
 
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
3073
 
            find_ghosts=find_ghosts)
3074
 
 
3075
 
    def copy_content(self, revision_id=None):
3076
 
        self._ensure_real_inter()
3077
 
        self._real_inter.copy_content(revision_id=revision_id)
3078
 
 
3079
 
    @classmethod
3080
 
    def _get_repo_format_to_test(self):
3081
 
        return None
3082
 
 
 
3998
    def _get_basis(self, first_revision_id):
 
3999
        """Get a revision and tree which exists in the target.
 
4000
 
 
4001
        This assumes that first_revision_id is selected for transmission
 
4002
        because all other ancestors are already present. If we can't find an
 
4003
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
4004
 
 
4005
        :return: (basis_id, basis_tree)
 
4006
        """
 
4007
        first_rev = self.source.get_revision(first_revision_id)
 
4008
        try:
 
4009
            basis_id = first_rev.parent_ids[0]
 
4010
            # only valid as a basis if the target has it
 
4011
            self.target.get_revision(basis_id)
 
4012
            # Try to get a basis tree - if its a ghost it will hit the
 
4013
            # NoSuchRevision case.
 
4014
            basis_tree = self.source.revision_tree(basis_id)
 
4015
        except (IndexError, errors.NoSuchRevision):
 
4016
            basis_id = _mod_revision.NULL_REVISION
 
4017
            basis_tree = self.source.revision_tree(basis_id)
 
4018
        return basis_id, basis_tree
3083
4019
 
3084
4020
 
3085
4021
InterRepository.register_optimiser(InterDifferingSerializer)
3086
4022
InterRepository.register_optimiser(InterSameDataRepository)
3087
4023
InterRepository.register_optimiser(InterWeaveRepo)
3088
4024
InterRepository.register_optimiser(InterKnitRepo)
3089
 
InterRepository.register_optimiser(InterModel1and2)
3090
 
InterRepository.register_optimiser(InterKnit1and2)
3091
 
InterRepository.register_optimiser(InterPackRepo)
3092
 
InterRepository.register_optimiser(InterOtherToRemote)
3093
 
InterRepository.register_optimiser(InterRemoteToOther)
3094
4025
 
3095
4026
 
3096
4027
class CopyConverter(object):
3097
4028
    """A repository conversion tool which just performs a copy of the content.
3098
 
    
 
4029
 
3099
4030
    This is slow but quite reliable.
3100
4031
    """
3101
4032
 
3105
4036
        :param target_format: The format the resulting repository should be.
3106
4037
        """
3107
4038
        self.target_format = target_format
3108
 
        
 
4039
 
3109
4040
    def convert(self, repo, pb):
3110
4041
        """Perform the conversion of to_convert, giving feedback via pb.
3111
4042
 
3112
4043
        :param to_convert: The disk object to convert.
3113
4044
        :param pb: a progress bar to use for progress information.
3114
4045
        """
3115
 
        self.pb = pb
 
4046
        pb = ui.ui_factory.nested_progress_bar()
3116
4047
        self.count = 0
3117
4048
        self.total = 4
3118
4049
        # this is only useful with metadir layouts - separated repo content.
3119
4050
        # trigger an assertion if not such
3120
4051
        repo._format.get_format_string()
3121
4052
        self.repo_dir = repo.bzrdir
3122
 
        self.step('Moving repository to repository.backup')
 
4053
        pb.update('Moving repository to repository.backup')
3123
4054
        self.repo_dir.transport.move('repository', 'repository.backup')
3124
4055
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3125
4056
        repo._format.check_conversion_target(self.target_format)
3126
4057
        self.source_repo = repo._format.open(self.repo_dir,
3127
4058
            _found=True,
3128
4059
            _override_transport=backup_transport)
3129
 
        self.step('Creating new repository')
 
4060
        pb.update('Creating new repository')
3130
4061
        converted = self.target_format.initialize(self.repo_dir,
3131
4062
                                                  self.source_repo.is_shared())
3132
4063
        converted.lock_write()
3133
4064
        try:
3134
 
            self.step('Copying content into repository.')
 
4065
            pb.update('Copying content')
3135
4066
            self.source_repo.copy_content_into(converted)
3136
4067
        finally:
3137
4068
            converted.unlock()
3138
 
        self.step('Deleting old repository content.')
 
4069
        pb.update('Deleting old repository content')
3139
4070
        self.repo_dir.transport.delete_tree('repository.backup')
3140
 
        self.pb.note('repository converted')
3141
 
 
3142
 
    def step(self, message):
3143
 
        """Update the pb by a step."""
3144
 
        self.count +=1
3145
 
        self.pb.update(message, self.count, self.total)
 
4071
        ui.ui_factory.note('repository converted')
 
4072
        pb.finished()
3146
4073
 
3147
4074
 
3148
4075
_unescape_map = {
3177
4104
 
3178
4105
class _VersionedFileChecker(object):
3179
4106
 
3180
 
    def __init__(self, repository):
 
4107
    def __init__(self, repository, text_key_references=None, ancestors=None):
3181
4108
        self.repository = repository
3182
 
        self.text_index = self.repository._generate_text_key_index()
3183
 
    
 
4109
        self.text_index = self.repository._generate_text_key_index(
 
4110
            text_key_references=text_key_references, ancestors=ancestors)
 
4111
 
3184
4112
    def calculate_file_version_parents(self, text_key):
3185
4113
        """Calculate the correct parents for a file version according to
3186
4114
        the inventories.
3203
4131
            revision_id) tuples for versions that are present in this versioned
3204
4132
            file, but not used by the corresponding inventory.
3205
4133
        """
 
4134
        local_progress = None
 
4135
        if progress_bar is None:
 
4136
            local_progress = ui.ui_factory.nested_progress_bar()
 
4137
            progress_bar = local_progress
 
4138
        try:
 
4139
            return self._check_file_version_parents(texts, progress_bar)
 
4140
        finally:
 
4141
            if local_progress:
 
4142
                local_progress.finished()
 
4143
 
 
4144
    def _check_file_version_parents(self, texts, progress_bar):
 
4145
        """See check_file_version_parents."""
3206
4146
        wrong_parents = {}
3207
4147
        self.file_ids = set([file_id for file_id, _ in
3208
4148
            self.text_index.iterkeys()])
3209
4149
        # text keys is now grouped by file_id
3210
 
        n_weaves = len(self.file_ids)
3211
 
        files_in_revisions = {}
3212
 
        revisions_of_files = {}
3213
4150
        n_versions = len(self.text_index)
3214
4151
        progress_bar.update('loading text store', 0, n_versions)
3215
4152
        parent_map = self.repository.texts.get_parent_map(self.text_index)
3217
4154
        text_keys = self.repository.texts.keys()
3218
4155
        unused_keys = frozenset(text_keys) - set(self.text_index)
3219
4156
        for num, key in enumerate(self.text_index.iterkeys()):
3220
 
            if progress_bar is not None:
3221
 
                progress_bar.update('checking text graph', num, n_versions)
 
4157
            progress_bar.update('checking text graph', num, n_versions)
3222
4158
            correct_parents = self.calculate_file_version_parents(key)
3223
4159
            try:
3224
4160
                knit_parents = parent_map[key]
3247
4183
        revision_graph[key] = tuple(parent for parent in parents if parent
3248
4184
            in revision_graph)
3249
4185
    return revision_graph
 
4186
 
 
4187
 
 
4188
class StreamSink(object):
 
4189
    """An object that can insert a stream into a repository.
 
4190
 
 
4191
    This interface handles the complexity of reserialising inventories and
 
4192
    revisions from different formats, and allows unidirectional insertion into
 
4193
    stacked repositories without looking for the missing basis parents
 
4194
    beforehand.
 
4195
    """
 
4196
 
 
4197
    def __init__(self, target_repo):
 
4198
        self.target_repo = target_repo
 
4199
 
 
4200
    def insert_stream(self, stream, src_format, resume_tokens):
 
4201
        """Insert a stream's content into the target repository.
 
4202
 
 
4203
        :param src_format: a bzr repository format.
 
4204
 
 
4205
        :return: a list of resume tokens and an  iterable of keys additional
 
4206
            items required before the insertion can be completed.
 
4207
        """
 
4208
        self.target_repo.lock_write()
 
4209
        try:
 
4210
            if resume_tokens:
 
4211
                self.target_repo.resume_write_group(resume_tokens)
 
4212
                is_resume = True
 
4213
            else:
 
4214
                self.target_repo.start_write_group()
 
4215
                is_resume = False
 
4216
            try:
 
4217
                # locked_insert_stream performs a commit|suspend.
 
4218
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4219
            except:
 
4220
                self.target_repo.abort_write_group(suppress_errors=True)
 
4221
                raise
 
4222
        finally:
 
4223
            self.target_repo.unlock()
 
4224
 
 
4225
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4226
        to_serializer = self.target_repo._format._serializer
 
4227
        src_serializer = src_format._serializer
 
4228
        new_pack = None
 
4229
        if to_serializer == src_serializer:
 
4230
            # If serializers match and the target is a pack repository, set the
 
4231
            # write cache size on the new pack.  This avoids poor performance
 
4232
            # on transports where append is unbuffered (such as
 
4233
            # RemoteTransport).  This is safe to do because nothing should read
 
4234
            # back from the target repository while a stream with matching
 
4235
            # serialization is being inserted.
 
4236
            # The exception is that a delta record from the source that should
 
4237
            # be a fulltext may need to be expanded by the target (see
 
4238
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
4239
            # explicitly flush any buffered writes first in that rare case.
 
4240
            try:
 
4241
                new_pack = self.target_repo._pack_collection._new_pack
 
4242
            except AttributeError:
 
4243
                # Not a pack repository
 
4244
                pass
 
4245
            else:
 
4246
                new_pack.set_write_cache_size(1024*1024)
 
4247
        for substream_type, substream in stream:
 
4248
            if 'stream' in debug.debug_flags:
 
4249
                mutter('inserting substream: %s', substream_type)
 
4250
            if substream_type == 'texts':
 
4251
                self.target_repo.texts.insert_record_stream(substream)
 
4252
            elif substream_type == 'inventories':
 
4253
                if src_serializer == to_serializer:
 
4254
                    self.target_repo.inventories.insert_record_stream(
 
4255
                        substream)
 
4256
                else:
 
4257
                    self._extract_and_insert_inventories(
 
4258
                        substream, src_serializer)
 
4259
            elif substream_type == 'inventory-deltas':
 
4260
                ui.ui_factory.warn_cross_format_fetch(src_format,
 
4261
                    self.target_repo._format)
 
4262
                self._extract_and_insert_inventory_deltas(
 
4263
                    substream, src_serializer)
 
4264
            elif substream_type == 'chk_bytes':
 
4265
                # XXX: This doesn't support conversions, as it assumes the
 
4266
                #      conversion was done in the fetch code.
 
4267
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4268
            elif substream_type == 'revisions':
 
4269
                # This may fallback to extract-and-insert more often than
 
4270
                # required if the serializers are different only in terms of
 
4271
                # the inventory.
 
4272
                if src_serializer == to_serializer:
 
4273
                    self.target_repo.revisions.insert_record_stream(
 
4274
                        substream)
 
4275
                else:
 
4276
                    self._extract_and_insert_revisions(substream,
 
4277
                        src_serializer)
 
4278
            elif substream_type == 'signatures':
 
4279
                self.target_repo.signatures.insert_record_stream(substream)
 
4280
            else:
 
4281
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4282
        # Done inserting data, and the missing_keys calculations will try to
 
4283
        # read back from the inserted data, so flush the writes to the new pack
 
4284
        # (if this is pack format).
 
4285
        if new_pack is not None:
 
4286
            new_pack._write_data('', flush=True)
 
4287
        # Find all the new revisions (including ones from resume_tokens)
 
4288
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4289
            check_for_missing_texts=is_resume)
 
4290
        try:
 
4291
            for prefix, versioned_file in (
 
4292
                ('texts', self.target_repo.texts),
 
4293
                ('inventories', self.target_repo.inventories),
 
4294
                ('revisions', self.target_repo.revisions),
 
4295
                ('signatures', self.target_repo.signatures),
 
4296
                ('chk_bytes', self.target_repo.chk_bytes),
 
4297
                ):
 
4298
                if versioned_file is None:
 
4299
                    continue
 
4300
                # TODO: key is often going to be a StaticTuple object
 
4301
                #       I don't believe we can define a method by which
 
4302
                #       (prefix,) + StaticTuple will work, though we could
 
4303
                #       define a StaticTuple.sq_concat that would allow you to
 
4304
                #       pass in either a tuple or a StaticTuple as the second
 
4305
                #       object, so instead we could have:
 
4306
                #       StaticTuple(prefix) + key here...
 
4307
                missing_keys.update((prefix,) + key for key in
 
4308
                    versioned_file.get_missing_compression_parent_keys())
 
4309
        except NotImplementedError:
 
4310
            # cannot even attempt suspending, and missing would have failed
 
4311
            # during stream insertion.
 
4312
            missing_keys = set()
 
4313
        else:
 
4314
            if missing_keys:
 
4315
                # suspend the write group and tell the caller what we is
 
4316
                # missing. We know we can suspend or else we would not have
 
4317
                # entered this code path. (All repositories that can handle
 
4318
                # missing keys can handle suspending a write group).
 
4319
                write_group_tokens = self.target_repo.suspend_write_group()
 
4320
                return write_group_tokens, missing_keys
 
4321
        hint = self.target_repo.commit_write_group()
 
4322
        if (to_serializer != src_serializer and
 
4323
            self.target_repo._format.pack_compresses):
 
4324
            self.target_repo.pack(hint=hint)
 
4325
        return [], set()
 
4326
 
 
4327
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4328
        target_rich_root = self.target_repo._format.rich_root_data
 
4329
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4330
        for record in substream:
 
4331
            # Insert the delta directly
 
4332
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4333
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4334
            try:
 
4335
                parse_result = deserialiser.parse_text_bytes(
 
4336
                    inventory_delta_bytes)
 
4337
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4338
                trace.mutter("Incompatible delta: %s", err.msg)
 
4339
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4340
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4341
            revision_id = new_id
 
4342
            parents = [key[0] for key in record.parents]
 
4343
            self.target_repo.add_inventory_by_delta(
 
4344
                basis_id, inv_delta, revision_id, parents)
 
4345
 
 
4346
    def _extract_and_insert_inventories(self, substream, serializer,
 
4347
            parse_delta=None):
 
4348
        """Generate a new inventory versionedfile in target, converting data.
 
4349
 
 
4350
        The inventory is retrieved from the source, (deserializing it), and
 
4351
        stored in the target (reserializing it in a different format).
 
4352
        """
 
4353
        target_rich_root = self.target_repo._format.rich_root_data
 
4354
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4355
        for record in substream:
 
4356
            # It's not a delta, so it must be a fulltext in the source
 
4357
            # serializer's format.
 
4358
            bytes = record.get_bytes_as('fulltext')
 
4359
            revision_id = record.key[0]
 
4360
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4361
            parents = [key[0] for key in record.parents]
 
4362
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4363
            # No need to keep holding this full inv in memory when the rest of
 
4364
            # the substream is likely to be all deltas.
 
4365
            del inv
 
4366
 
 
4367
    def _extract_and_insert_revisions(self, substream, serializer):
 
4368
        for record in substream:
 
4369
            bytes = record.get_bytes_as('fulltext')
 
4370
            revision_id = record.key[0]
 
4371
            rev = serializer.read_revision_from_string(bytes)
 
4372
            if rev.revision_id != revision_id:
 
4373
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4374
            self.target_repo.add_revision(revision_id, rev)
 
4375
 
 
4376
    def finished(self):
 
4377
        if self.target_repo._format._fetch_reconcile:
 
4378
            self.target_repo.reconcile()
 
4379
 
 
4380
 
 
4381
class StreamSource(object):
 
4382
    """A source of a stream for fetching between repositories."""
 
4383
 
 
4384
    def __init__(self, from_repository, to_format):
 
4385
        """Create a StreamSource streaming from from_repository."""
 
4386
        self.from_repository = from_repository
 
4387
        self.to_format = to_format
 
4388
 
 
4389
    def delta_on_metadata(self):
 
4390
        """Return True if delta's are permitted on metadata streams.
 
4391
 
 
4392
        That is on revisions and signatures.
 
4393
        """
 
4394
        src_serializer = self.from_repository._format._serializer
 
4395
        target_serializer = self.to_format._serializer
 
4396
        return (self.to_format._fetch_uses_deltas and
 
4397
            src_serializer == target_serializer)
 
4398
 
 
4399
    def _fetch_revision_texts(self, revs):
 
4400
        # fetch signatures first and then the revision texts
 
4401
        # may need to be a InterRevisionStore call here.
 
4402
        from_sf = self.from_repository.signatures
 
4403
        # A missing signature is just skipped.
 
4404
        keys = [(rev_id,) for rev_id in revs]
 
4405
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4406
            keys,
 
4407
            self.to_format._fetch_order,
 
4408
            not self.to_format._fetch_uses_deltas))
 
4409
        # If a revision has a delta, this is actually expanded inside the
 
4410
        # insert_record_stream code now, which is an alternate fix for
 
4411
        # bug #261339
 
4412
        from_rf = self.from_repository.revisions
 
4413
        revisions = from_rf.get_record_stream(
 
4414
            keys,
 
4415
            self.to_format._fetch_order,
 
4416
            not self.delta_on_metadata())
 
4417
        return [('signatures', signatures), ('revisions', revisions)]
 
4418
 
 
4419
    def _generate_root_texts(self, revs):
 
4420
        """This will be called by get_stream between fetching weave texts and
 
4421
        fetching the inventory weave.
 
4422
        """
 
4423
        if self._rich_root_upgrade():
 
4424
            return _mod_fetch.Inter1and2Helper(
 
4425
                self.from_repository).generate_root_texts(revs)
 
4426
        else:
 
4427
            return []
 
4428
 
 
4429
    def get_stream(self, search):
 
4430
        phase = 'file'
 
4431
        revs = search.get_keys()
 
4432
        graph = self.from_repository.get_graph()
 
4433
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4434
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4435
        text_keys = []
 
4436
        for knit_kind, file_id, revisions in data_to_fetch:
 
4437
            if knit_kind != phase:
 
4438
                phase = knit_kind
 
4439
                # Make a new progress bar for this phase
 
4440
            if knit_kind == "file":
 
4441
                # Accumulate file texts
 
4442
                text_keys.extend([(file_id, revision) for revision in
 
4443
                    revisions])
 
4444
            elif knit_kind == "inventory":
 
4445
                # Now copy the file texts.
 
4446
                from_texts = self.from_repository.texts
 
4447
                yield ('texts', from_texts.get_record_stream(
 
4448
                    text_keys, self.to_format._fetch_order,
 
4449
                    not self.to_format._fetch_uses_deltas))
 
4450
                # Cause an error if a text occurs after we have done the
 
4451
                # copy.
 
4452
                text_keys = None
 
4453
                # Before we process the inventory we generate the root
 
4454
                # texts (if necessary) so that the inventories references
 
4455
                # will be valid.
 
4456
                for _ in self._generate_root_texts(revs):
 
4457
                    yield _
 
4458
                # we fetch only the referenced inventories because we do not
 
4459
                # know for unselected inventories whether all their required
 
4460
                # texts are present in the other repository - it could be
 
4461
                # corrupt.
 
4462
                for info in self._get_inventory_stream(revs):
 
4463
                    yield info
 
4464
            elif knit_kind == "signatures":
 
4465
                # Nothing to do here; this will be taken care of when
 
4466
                # _fetch_revision_texts happens.
 
4467
                pass
 
4468
            elif knit_kind == "revisions":
 
4469
                for record in self._fetch_revision_texts(revs):
 
4470
                    yield record
 
4471
            else:
 
4472
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4473
 
 
4474
    def get_stream_for_missing_keys(self, missing_keys):
 
4475
        # missing keys can only occur when we are byte copying and not
 
4476
        # translating (because translation means we don't send
 
4477
        # unreconstructable deltas ever).
 
4478
        keys = {}
 
4479
        keys['texts'] = set()
 
4480
        keys['revisions'] = set()
 
4481
        keys['inventories'] = set()
 
4482
        keys['chk_bytes'] = set()
 
4483
        keys['signatures'] = set()
 
4484
        for key in missing_keys:
 
4485
            keys[key[0]].add(key[1:])
 
4486
        if len(keys['revisions']):
 
4487
            # If we allowed copying revisions at this point, we could end up
 
4488
            # copying a revision without copying its required texts: a
 
4489
            # violation of the requirements for repository integrity.
 
4490
            raise AssertionError(
 
4491
                'cannot copy revisions to fill in missing deltas %s' % (
 
4492
                    keys['revisions'],))
 
4493
        for substream_kind, keys in keys.iteritems():
 
4494
            vf = getattr(self.from_repository, substream_kind)
 
4495
            if vf is None and keys:
 
4496
                    raise AssertionError(
 
4497
                        "cannot fill in keys for a versioned file we don't"
 
4498
                        " have: %s needs %s" % (substream_kind, keys))
 
4499
            if not keys:
 
4500
                # No need to stream something we don't have
 
4501
                continue
 
4502
            if substream_kind == 'inventories':
 
4503
                # Some missing keys are genuinely ghosts, filter those out.
 
4504
                present = self.from_repository.inventories.get_parent_map(keys)
 
4505
                revs = [key[0] for key in present]
 
4506
                # Get the inventory stream more-or-less as we do for the
 
4507
                # original stream; there's no reason to assume that records
 
4508
                # direct from the source will be suitable for the sink.  (Think
 
4509
                # e.g. 2a -> 1.9-rich-root).
 
4510
                for info in self._get_inventory_stream(revs, missing=True):
 
4511
                    yield info
 
4512
                continue
 
4513
 
 
4514
            # Ask for full texts always so that we don't need more round trips
 
4515
            # after this stream.
 
4516
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4517
            # records. The Sink is responsible for doing another check to
 
4518
            # ensure that ghosts don't introduce missing data for future
 
4519
            # fetches.
 
4520
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4521
                self.to_format._fetch_order, True))
 
4522
            yield substream_kind, stream
 
4523
 
 
4524
    def inventory_fetch_order(self):
 
4525
        if self._rich_root_upgrade():
 
4526
            return 'topological'
 
4527
        else:
 
4528
            return self.to_format._fetch_order
 
4529
 
 
4530
    def _rich_root_upgrade(self):
 
4531
        return (not self.from_repository._format.rich_root_data and
 
4532
            self.to_format.rich_root_data)
 
4533
 
 
4534
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4535
        from_format = self.from_repository._format
 
4536
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4537
            from_format.network_name() == self.to_format.network_name()):
 
4538
            raise AssertionError(
 
4539
                "this case should be handled by GroupCHKStreamSource")
 
4540
        elif 'forceinvdeltas' in debug.debug_flags:
 
4541
            return self._get_convertable_inventory_stream(revision_ids,
 
4542
                    delta_versus_null=missing)
 
4543
        elif from_format.network_name() == self.to_format.network_name():
 
4544
            # Same format.
 
4545
            return self._get_simple_inventory_stream(revision_ids,
 
4546
                    missing=missing)
 
4547
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4548
                and from_format._serializer == self.to_format._serializer):
 
4549
            # Essentially the same format.
 
4550
            return self._get_simple_inventory_stream(revision_ids,
 
4551
                    missing=missing)
 
4552
        else:
 
4553
            # Any time we switch serializations, we want to use an
 
4554
            # inventory-delta based approach.
 
4555
            return self._get_convertable_inventory_stream(revision_ids,
 
4556
                    delta_versus_null=missing)
 
4557
 
 
4558
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4559
        # NB: This currently reopens the inventory weave in source;
 
4560
        # using a single stream interface instead would avoid this.
 
4561
        from_weave = self.from_repository.inventories
 
4562
        if missing:
 
4563
            delta_closure = True
 
4564
        else:
 
4565
            delta_closure = not self.delta_on_metadata()
 
4566
        yield ('inventories', from_weave.get_record_stream(
 
4567
            [(rev_id,) for rev_id in revision_ids],
 
4568
            self.inventory_fetch_order(), delta_closure))
 
4569
 
 
4570
    def _get_convertable_inventory_stream(self, revision_ids,
 
4571
                                          delta_versus_null=False):
 
4572
        # The two formats are sufficiently different that there is no fast
 
4573
        # path, so we need to send just inventorydeltas, which any
 
4574
        # sufficiently modern client can insert into any repository.
 
4575
        # The StreamSink code expects to be able to
 
4576
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4577
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4578
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4579
        yield ('inventory-deltas',
 
4580
           self._stream_invs_as_deltas(revision_ids,
 
4581
                                       delta_versus_null=delta_versus_null))
 
4582
 
 
4583
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4584
        """Return a stream of inventory-deltas for the given rev ids.
 
4585
 
 
4586
        :param revision_ids: The list of inventories to transmit
 
4587
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4588
            entry, instead compute the delta versus the NULL_REVISION. This
 
4589
            effectively streams a complete inventory. Used for stuff like
 
4590
            filling in missing parents, etc.
 
4591
        """
 
4592
        from_repo = self.from_repository
 
4593
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4594
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4595
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4596
        # method...
 
4597
        inventories = self.from_repository.iter_inventories(
 
4598
            revision_ids, 'topological')
 
4599
        format = from_repo._format
 
4600
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4601
        inventory_cache = lru_cache.LRUCache(50)
 
4602
        null_inventory = from_repo.revision_tree(
 
4603
            _mod_revision.NULL_REVISION).inventory
 
4604
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4605
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4606
        # repo back into a non-rich-root repo ought to be allowed)
 
4607
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4608
            versioned_root=format.rich_root_data,
 
4609
            tree_references=format.supports_tree_reference)
 
4610
        for inv in inventories:
 
4611
            key = (inv.revision_id,)
 
4612
            parent_keys = parent_map.get(key, ())
 
4613
            delta = None
 
4614
            if not delta_versus_null and parent_keys:
 
4615
                # The caller did not ask for complete inventories and we have
 
4616
                # some parents that we can delta against.  Make a delta against
 
4617
                # each parent so that we can find the smallest.
 
4618
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4619
                for parent_id in parent_ids:
 
4620
                    if parent_id not in invs_sent_so_far:
 
4621
                        # We don't know that the remote side has this basis, so
 
4622
                        # we can't use it.
 
4623
                        continue
 
4624
                    if parent_id == _mod_revision.NULL_REVISION:
 
4625
                        parent_inv = null_inventory
 
4626
                    else:
 
4627
                        parent_inv = inventory_cache.get(parent_id, None)
 
4628
                        if parent_inv is None:
 
4629
                            parent_inv = from_repo.get_inventory(parent_id)
 
4630
                    candidate_delta = inv._make_delta(parent_inv)
 
4631
                    if (delta is None or
 
4632
                        len(delta) > len(candidate_delta)):
 
4633
                        delta = candidate_delta
 
4634
                        basis_id = parent_id
 
4635
            if delta is None:
 
4636
                # Either none of the parents ended up being suitable, or we
 
4637
                # were asked to delta against NULL
 
4638
                basis_id = _mod_revision.NULL_REVISION
 
4639
                delta = inv._make_delta(null_inventory)
 
4640
            invs_sent_so_far.add(inv.revision_id)
 
4641
            inventory_cache[inv.revision_id] = inv
 
4642
            delta_serialized = ''.join(
 
4643
                serializer.delta_to_lines(basis_id, key[-1], delta))
 
4644
            yield versionedfile.FulltextContentFactory(
 
4645
                key, parent_keys, None, delta_serialized)
 
4646
 
 
4647
 
 
4648
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4649
                    stop_revision=None):
 
4650
    """Extend the partial history to include a given index
 
4651
 
 
4652
    If a stop_index is supplied, stop when that index has been reached.
 
4653
    If a stop_revision is supplied, stop when that revision is
 
4654
    encountered.  Otherwise, stop when the beginning of history is
 
4655
    reached.
 
4656
 
 
4657
    :param stop_index: The index which should be present.  When it is
 
4658
        present, history extension will stop.
 
4659
    :param stop_revision: The revision id which should be present.  When
 
4660
        it is encountered, history extension will stop.
 
4661
    """
 
4662
    start_revision = partial_history_cache[-1]
 
4663
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4664
    try:
 
4665
        #skip the last revision in the list
 
4666
        iterator.next()
 
4667
        while True:
 
4668
            if (stop_index is not None and
 
4669
                len(partial_history_cache) > stop_index):
 
4670
                break
 
4671
            if partial_history_cache[-1] == stop_revision:
 
4672
                break
 
4673
            revision_id = iterator.next()
 
4674
            partial_history_cache.append(revision_id)
 
4675
    except StopIteration:
 
4676
        # No more history
 
4677
        return
 
4678