/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2009-02-25 02:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4053.
  • Revision ID: jelmer@samba.org-20090225020535-qw7udfz9ploqzosn
Add tests for InterBranch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
 
    fetch as _mod_fetch,
 
27
    errors,
30
28
    fifo_cache,
31
29
    generate_ids,
32
30
    gpg,
33
31
    graph,
34
 
    inventory,
35
 
    inventory_delta,
36
32
    lazy_regex,
37
33
    lockable_files,
38
34
    lockdir,
39
35
    lru_cache,
40
36
    osutils,
 
37
    remote,
41
38
    revision as _mod_revision,
42
 
    static_tuple,
43
39
    symbol_versioning,
44
 
    trace,
45
40
    tsort,
46
41
    ui,
47
42
    versionedfile,
52
47
from bzrlib.testament import Testament
53
48
""")
54
49
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib import registry
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
52
from bzrlib.inter import InterObject
61
 
from bzrlib.inventory import (
62
 
    Inventory,
63
 
    InventoryDirectory,
64
 
    ROOT_ID,
65
 
    entry_factory,
66
 
    )
67
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
53
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
54
from bzrlib.symbol_versioning import (
 
55
        deprecated_method,
 
56
        one_one,
 
57
        one_two,
 
58
        one_six,
 
59
        )
68
60
from bzrlib.trace import (
69
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
70
62
 
73
65
_deprecation_warning_done = False
74
66
 
75
67
 
76
 
class IsInWriteGroupError(errors.InternalBzrError):
77
 
 
78
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
79
 
 
80
 
    def __init__(self, repo):
81
 
        errors.InternalBzrError.__init__(self, repo=repo)
82
 
 
83
 
 
84
68
class CommitBuilder(object):
85
69
    """Provides an interface to build up a commit.
86
70
 
142
126
        # valid. Callers that will call record_delete() should call
143
127
        # .will_record_deletes() to indicate that.
144
128
        self._recording_deletes = False
145
 
        # memo'd check for no-op commits.
146
 
        self._any_changes = False
147
 
 
148
 
    def any_changes(self):
149
 
        """Return True if any entries were changed.
150
 
        
151
 
        This includes merge-only changes. It is the core for the --unchanged
152
 
        detection in commit.
153
 
 
154
 
        :return: True if any changes have occured.
155
 
        """
156
 
        return self._any_changes
157
129
 
158
130
    def _validate_unicode_text(self, text, context):
159
131
        """Verify things like commit messages don't have bogus characters."""
204
176
        deserializing the inventory, while we already have a copy in
205
177
        memory.
206
178
        """
207
 
        if self.new_inventory is None:
208
 
            self.new_inventory = self.repository.get_inventory(
209
 
                self._new_revision_id)
210
179
        return RevisionTree(self.repository, self.new_inventory,
211
 
            self._new_revision_id)
 
180
                            self._new_revision_id)
212
181
 
213
182
    def finish_inventory(self):
214
 
        """Tell the builder that the inventory is finished.
215
 
 
216
 
        :return: The inventory id in the repository, which can be used with
217
 
            repository.get_inventory.
218
 
        """
219
 
        if self.new_inventory is None:
220
 
            # an inventory delta was accumulated without creating a new
221
 
            # inventory.
222
 
            basis_id = self.basis_delta_revision
223
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
224
 
            # because self.new_inventory is used to hint to the rest of the
225
 
            # system what code path was taken
226
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
227
 
                basis_id, self._basis_delta, self._new_revision_id,
228
 
                self.parents)
229
 
        else:
230
 
            if self.new_inventory.root is None:
231
 
                raise AssertionError('Root entry should be supplied to'
232
 
                    ' record_entry_contents, as of bzr 0.10.')
233
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
234
 
            self.new_inventory.revision_id = self._new_revision_id
235
 
            self.inv_sha1 = self.repository.add_inventory(
236
 
                self._new_revision_id,
237
 
                self.new_inventory,
238
 
                self.parents
239
 
                )
240
 
        return self._new_revision_id
 
183
        """Tell the builder that the inventory is finished."""
 
184
        if self.new_inventory.root is None:
 
185
            raise AssertionError('Root entry should be supplied to'
 
186
                ' record_entry_contents, as of bzr 0.10.')
 
187
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
188
        self.new_inventory.revision_id = self._new_revision_id
 
189
        self.inv_sha1 = self.repository.add_inventory(
 
190
            self._new_revision_id,
 
191
            self.new_inventory,
 
192
            self.parents
 
193
            )
241
194
 
242
195
    def _gen_revision_id(self):
243
196
        """Return new revision-id."""
280
233
        # _new_revision_id
281
234
        ie.revision = self._new_revision_id
282
235
 
283
 
    def _require_root_change(self, tree):
284
 
        """Enforce an appropriate root object change.
285
 
 
286
 
        This is called once when record_iter_changes is called, if and only if
287
 
        the root was not in the delta calculated by record_iter_changes.
288
 
 
289
 
        :param tree: The tree which is being committed.
290
 
        """
291
 
        # NB: if there are no parents then this method is not called, so no
292
 
        # need to guard on parents having length.
293
 
        entry = entry_factory['directory'](tree.path2id(''), '',
294
 
            None)
295
 
        entry.revision = self._new_revision_id
296
 
        self._basis_delta.append(('', '', entry.file_id, entry))
297
 
 
298
236
    def _get_delta(self, ie, basis_inv, path):
299
237
        """Get a delta against the basis inventory for ie."""
300
238
        if ie.file_id not in basis_inv:
342
280
            raise AssertionError("recording deletes not activated.")
343
281
        delta = (path, None, file_id, None)
344
282
        self._basis_delta.append(delta)
345
 
        self._any_changes = True
346
283
        return delta
347
284
 
348
285
    def will_record_deletes(self):
353
290
        builder.record_delete().
354
291
        """
355
292
        self._recording_deletes = True
356
 
        try:
357
 
            basis_id = self.parents[0]
358
 
        except IndexError:
359
 
            basis_id = _mod_revision.NULL_REVISION
360
 
        self.basis_delta_revision = basis_id
361
293
 
362
294
    def record_entry_contents(self, ie, parent_invs, path, tree,
363
295
        content_summary):
483
415
            if content_summary[2] is None:
484
416
                raise ValueError("Files must not have executable = None")
485
417
            if not store:
486
 
                # We can't trust a check of the file length because of content
487
 
                # filtering...
488
 
                if (# if the exec bit has changed we have to store:
 
418
                if (# if the file length changed we have to store:
 
419
                    parent_entry.text_size != content_summary[1] or
 
420
                    # if the exec bit has changed we have to store:
489
421
                    parent_entry.executable != content_summary[2]):
490
422
                    store = True
491
423
                elif parent_entry.text_sha1 == content_summary[3]:
510
442
            ie.executable = content_summary[2]
511
443
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
512
444
            try:
513
 
                text = file_obj.read()
 
445
                lines = file_obj.readlines()
514
446
            finally:
515
447
                file_obj.close()
516
448
            try:
517
449
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
518
 
                    ie.file_id, text, heads, nostore_sha)
 
450
                    ie.file_id, lines, heads, nostore_sha)
519
451
                # Let the caller know we generated a stat fingerprint.
520
452
                fingerprint = (ie.text_sha1, stat_value)
521
453
            except errors.ExistingContent:
533
465
                # carry over:
534
466
                ie.revision = parent_entry.revision
535
467
                return self._get_delta(ie, basis_inv, path), False, None
536
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
468
            lines = []
 
469
            self._add_text_to_weave(ie.file_id, lines, heads, None)
537
470
        elif kind == 'symlink':
538
471
            current_link_target = content_summary[3]
539
472
            if not store:
547
480
                ie.symlink_target = parent_entry.symlink_target
548
481
                return self._get_delta(ie, basis_inv, path), False, None
549
482
            ie.symlink_target = current_link_target
550
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
483
            lines = []
 
484
            self._add_text_to_weave(ie.file_id, lines, heads, None)
551
485
        elif kind == 'tree-reference':
552
486
            if not store:
553
487
                if content_summary[3] != parent_entry.reference_revision:
558
492
                ie.revision = parent_entry.revision
559
493
                return self._get_delta(ie, basis_inv, path), False, None
560
494
            ie.reference_revision = content_summary[3]
561
 
            if ie.reference_revision is None:
562
 
                raise AssertionError("invalid content_summary for nested tree: %r"
563
 
                    % (content_summary,))
564
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
495
            lines = []
 
496
            self._add_text_to_weave(ie.file_id, lines, heads, None)
565
497
        else:
566
498
            raise NotImplementedError('unknown kind')
567
499
        ie.revision = self._new_revision_id
568
 
        self._any_changes = True
569
500
        return self._get_delta(ie, basis_inv, path), True, fingerprint
570
501
 
571
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
572
 
        _entry_factory=entry_factory):
573
 
        """Record a new tree via iter_changes.
574
 
 
575
 
        :param tree: The tree to obtain text contents from for changed objects.
576
 
        :param basis_revision_id: The revision id of the tree the iter_changes
577
 
            has been generated against. Currently assumed to be the same
578
 
            as self.parents[0] - if it is not, errors may occur.
579
 
        :param iter_changes: An iter_changes iterator with the changes to apply
580
 
            to basis_revision_id. The iterator must not include any items with
581
 
            a current kind of None - missing items must be either filtered out
582
 
            or errored-on beefore record_iter_changes sees the item.
583
 
        :param _entry_factory: Private method to bind entry_factory locally for
584
 
            performance.
585
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
586
 
            tree._observed_sha1.
587
 
        """
588
 
        # Create an inventory delta based on deltas between all the parents and
589
 
        # deltas between all the parent inventories. We use inventory delta's 
590
 
        # between the inventory objects because iter_changes masks
591
 
        # last-changed-field only changes.
592
 
        # Working data:
593
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
594
 
        # parents, names, kinds, executables
595
 
        merged_ids = {}
596
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
597
 
        # trees that are not parents[0]
598
 
        parent_entries = {}
599
 
        ghost_basis = False
600
 
        try:
601
 
            revtrees = list(self.repository.revision_trees(self.parents))
602
 
        except errors.NoSuchRevision:
603
 
            # one or more ghosts, slow path.
604
 
            revtrees = []
605
 
            for revision_id in self.parents:
606
 
                try:
607
 
                    revtrees.append(self.repository.revision_tree(revision_id))
608
 
                except errors.NoSuchRevision:
609
 
                    if not revtrees:
610
 
                        basis_revision_id = _mod_revision.NULL_REVISION
611
 
                        ghost_basis = True
612
 
                    revtrees.append(self.repository.revision_tree(
613
 
                        _mod_revision.NULL_REVISION))
614
 
        # The basis inventory from a repository 
615
 
        if revtrees:
616
 
            basis_inv = revtrees[0].inventory
617
 
        else:
618
 
            basis_inv = self.repository.revision_tree(
619
 
                _mod_revision.NULL_REVISION).inventory
620
 
        if len(self.parents) > 0:
621
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
622
 
                raise Exception(
623
 
                    "arbitrary basis parents not yet supported with merges")
624
 
            for revtree in revtrees[1:]:
625
 
                for change in revtree.inventory._make_delta(basis_inv):
626
 
                    if change[1] is None:
627
 
                        # Not present in this parent.
628
 
                        continue
629
 
                    if change[2] not in merged_ids:
630
 
                        if change[0] is not None:
631
 
                            basis_entry = basis_inv[change[2]]
632
 
                            merged_ids[change[2]] = [
633
 
                                # basis revid
634
 
                                basis_entry.revision,
635
 
                                # new tree revid
636
 
                                change[3].revision]
637
 
                            parent_entries[change[2]] = {
638
 
                                # basis parent
639
 
                                basis_entry.revision:basis_entry,
640
 
                                # this parent 
641
 
                                change[3].revision:change[3],
642
 
                                }
643
 
                        else:
644
 
                            merged_ids[change[2]] = [change[3].revision]
645
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
646
 
                    else:
647
 
                        merged_ids[change[2]].append(change[3].revision)
648
 
                        parent_entries[change[2]][change[3].revision] = change[3]
649
 
        else:
650
 
            merged_ids = {}
651
 
        # Setup the changes from the tree:
652
 
        # changes maps file_id -> (change, [parent revision_ids])
653
 
        changes= {}
654
 
        for change in iter_changes:
655
 
            # This probably looks up in basis_inv way to much.
656
 
            if change[1][0] is not None:
657
 
                head_candidate = [basis_inv[change[0]].revision]
658
 
            else:
659
 
                head_candidate = []
660
 
            changes[change[0]] = change, merged_ids.get(change[0],
661
 
                head_candidate)
662
 
        unchanged_merged = set(merged_ids) - set(changes)
663
 
        # Extend the changes dict with synthetic changes to record merges of
664
 
        # texts.
665
 
        for file_id in unchanged_merged:
666
 
            # Record a merged version of these items that did not change vs the
667
 
            # basis. This can be either identical parallel changes, or a revert
668
 
            # of a specific file after a merge. The recorded content will be
669
 
            # that of the current tree (which is the same as the basis), but
670
 
            # the per-file graph will reflect a merge.
671
 
            # NB:XXX: We are reconstructing path information we had, this
672
 
            # should be preserved instead.
673
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
674
 
            #   changed_content, versioned, parent, name, kind,
675
 
            #   executable)
676
 
            try:
677
 
                basis_entry = basis_inv[file_id]
678
 
            except errors.NoSuchId:
679
 
                # a change from basis->some_parents but file_id isn't in basis
680
 
                # so was new in the merge, which means it must have changed
681
 
                # from basis -> current, and as it hasn't the add was reverted
682
 
                # by the user. So we discard this change.
683
 
                pass
684
 
            else:
685
 
                change = (file_id,
686
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
687
 
                    False, (True, True),
688
 
                    (basis_entry.parent_id, basis_entry.parent_id),
689
 
                    (basis_entry.name, basis_entry.name),
690
 
                    (basis_entry.kind, basis_entry.kind),
691
 
                    (basis_entry.executable, basis_entry.executable))
692
 
                changes[file_id] = (change, merged_ids[file_id])
693
 
        # changes contains tuples with the change and a set of inventory
694
 
        # candidates for the file.
695
 
        # inv delta is:
696
 
        # old_path, new_path, file_id, new_inventory_entry
697
 
        seen_root = False # Is the root in the basis delta?
698
 
        inv_delta = self._basis_delta
699
 
        modified_rev = self._new_revision_id
700
 
        for change, head_candidates in changes.values():
701
 
            if change[3][1]: # versioned in target.
702
 
                # Several things may be happening here:
703
 
                # We may have a fork in the per-file graph
704
 
                #  - record a change with the content from tree
705
 
                # We may have a change against < all trees  
706
 
                #  - carry over the tree that hasn't changed
707
 
                # We may have a change against all trees
708
 
                #  - record the change with the content from tree
709
 
                kind = change[6][1]
710
 
                file_id = change[0]
711
 
                entry = _entry_factory[kind](file_id, change[5][1],
712
 
                    change[4][1])
713
 
                head_set = self._heads(change[0], set(head_candidates))
714
 
                heads = []
715
 
                # Preserve ordering.
716
 
                for head_candidate in head_candidates:
717
 
                    if head_candidate in head_set:
718
 
                        heads.append(head_candidate)
719
 
                        head_set.remove(head_candidate)
720
 
                carried_over = False
721
 
                if len(heads) == 1:
722
 
                    # Could be a carry-over situation:
723
 
                    parent_entry_revs = parent_entries.get(file_id, None)
724
 
                    if parent_entry_revs:
725
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
726
 
                    else:
727
 
                        parent_entry = None
728
 
                    if parent_entry is None:
729
 
                        # The parent iter_changes was called against is the one
730
 
                        # that is the per-file head, so any change is relevant
731
 
                        # iter_changes is valid.
732
 
                        carry_over_possible = False
733
 
                    else:
734
 
                        # could be a carry over situation
735
 
                        # A change against the basis may just indicate a merge,
736
 
                        # we need to check the content against the source of the
737
 
                        # merge to determine if it was changed after the merge
738
 
                        # or carried over.
739
 
                        if (parent_entry.kind != entry.kind or
740
 
                            parent_entry.parent_id != entry.parent_id or
741
 
                            parent_entry.name != entry.name):
742
 
                            # Metadata common to all entries has changed
743
 
                            # against per-file parent
744
 
                            carry_over_possible = False
745
 
                        else:
746
 
                            carry_over_possible = True
747
 
                        # per-type checks for changes against the parent_entry
748
 
                        # are done below.
749
 
                else:
750
 
                    # Cannot be a carry-over situation
751
 
                    carry_over_possible = False
752
 
                # Populate the entry in the delta
753
 
                if kind == 'file':
754
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
755
 
                    # after iter_changes examines and decides it has changed,
756
 
                    # we will unconditionally record a new version even if some
757
 
                    # other process reverts it while commit is running (with
758
 
                    # the revert happening after iter_changes did it's
759
 
                    # examination).
760
 
                    if change[7][1]:
761
 
                        entry.executable = True
762
 
                    else:
763
 
                        entry.executable = False
764
 
                    if (carry_over_possible and
765
 
                        parent_entry.executable == entry.executable):
766
 
                            # Check the file length, content hash after reading
767
 
                            # the file.
768
 
                            nostore_sha = parent_entry.text_sha1
769
 
                    else:
770
 
                        nostore_sha = None
771
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
772
 
                    try:
773
 
                        text = file_obj.read()
774
 
                    finally:
775
 
                        file_obj.close()
776
 
                    try:
777
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
778
 
                            file_id, text, heads, nostore_sha)
779
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
780
 
                    except errors.ExistingContent:
781
 
                        # No content change against a carry_over parent
782
 
                        # Perhaps this should also yield a fs hash update?
783
 
                        carried_over = True
784
 
                        entry.text_size = parent_entry.text_size
785
 
                        entry.text_sha1 = parent_entry.text_sha1
786
 
                elif kind == 'symlink':
787
 
                    # Wants a path hint?
788
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
789
 
                    if (carry_over_possible and
790
 
                        parent_entry.symlink_target == entry.symlink_target):
791
 
                        carried_over = True
792
 
                    else:
793
 
                        self._add_text_to_weave(change[0], '', heads, None)
794
 
                elif kind == 'directory':
795
 
                    if carry_over_possible:
796
 
                        carried_over = True
797
 
                    else:
798
 
                        # Nothing to set on the entry.
799
 
                        # XXX: split into the Root and nonRoot versions.
800
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
801
 
                            self._add_text_to_weave(change[0], '', heads, None)
802
 
                elif kind == 'tree-reference':
803
 
                    if not self.repository._format.supports_tree_reference:
804
 
                        # This isn't quite sane as an error, but we shouldn't
805
 
                        # ever see this code path in practice: tree's don't
806
 
                        # permit references when the repo doesn't support tree
807
 
                        # references.
808
 
                        raise errors.UnsupportedOperation(tree.add_reference,
809
 
                            self.repository)
810
 
                    reference_revision = tree.get_reference_revision(change[0])
811
 
                    entry.reference_revision = reference_revision
812
 
                    if (carry_over_possible and
813
 
                        parent_entry.reference_revision == reference_revision):
814
 
                        carried_over = True
815
 
                    else:
816
 
                        self._add_text_to_weave(change[0], '', heads, None)
817
 
                else:
818
 
                    raise AssertionError('unknown kind %r' % kind)
819
 
                if not carried_over:
820
 
                    entry.revision = modified_rev
821
 
                else:
822
 
                    entry.revision = parent_entry.revision
823
 
            else:
824
 
                entry = None
825
 
            new_path = change[1][1]
826
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
827
 
            if new_path == '':
828
 
                seen_root = True
829
 
        self.new_inventory = None
830
 
        if len(inv_delta):
831
 
            # This should perhaps be guarded by a check that the basis we
832
 
            # commit against is the basis for the commit and if not do a delta
833
 
            # against the basis.
834
 
            self._any_changes = True
835
 
        if not seen_root:
836
 
            # housekeeping root entry changes do not affect no-change commits.
837
 
            self._require_root_change(tree)
838
 
        self.basis_delta_revision = basis_revision_id
839
 
 
840
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
841
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
842
 
        return self.repository.texts._add_text(
843
 
            (file_id, self._new_revision_id), parent_keys, new_text,
844
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
502
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
503
        # Note: as we read the content directly from the tree, we know its not
 
504
        # been turned into unicode or badly split - but a broken tree
 
505
        # implementation could give us bad output from readlines() so this is
 
506
        # not a guarantee of safety. What would be better is always checking
 
507
        # the content during test suite execution. RBC 20070912
 
508
        parent_keys = tuple((file_id, parent) for parent in parents)
 
509
        return self.repository.texts.add_lines(
 
510
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
511
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
512
            check_content=False)[0:2]
845
513
 
846
514
 
847
515
class RootCommitBuilder(CommitBuilder):
859
527
        :param tree: The tree that is being committed.
860
528
        """
861
529
 
862
 
    def _require_root_change(self, tree):
863
 
        """Enforce an appropriate root object change.
864
 
 
865
 
        This is called once when record_iter_changes is called, if and only if
866
 
        the root was not in the delta calculated by record_iter_changes.
867
 
 
868
 
        :param tree: The tree which is being committed.
869
 
        """
870
 
        # versioned roots do not change unless the tree found a change.
871
 
 
872
 
 
873
 
class RepositoryWriteLockResult(LogicalLockResult):
874
 
    """The result of write locking a repository.
875
 
 
876
 
    :ivar repository_token: The token obtained from the underlying lock, or
877
 
        None.
878
 
    :ivar unlock: A callable which will unlock the lock.
879
 
    """
880
 
 
881
 
    def __init__(self, unlock, repository_token):
882
 
        LogicalLockResult.__init__(self, unlock)
883
 
        self.repository_token = repository_token
884
 
 
885
 
    def __repr__(self):
886
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
887
 
            self.unlock)
888
 
 
889
530
 
890
531
######################################################################
891
532
# Repositories
892
533
 
893
 
 
894
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
534
class Repository(object):
895
535
    """Repository holding history for one or more branches.
896
536
 
897
537
    The repository holds and retrieves historical information including
899
539
    which views a particular line of development through that history.
900
540
 
901
541
    The Repository builds on top of some byte storage facilies (the revisions,
902
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
903
 
    which respectively provide byte storage and a means to access the (possibly
 
542
    signatures, inventories and texts attributes) and a Transport, which
 
543
    respectively provide byte storage and a means to access the (possibly
904
544
    remote) disk.
905
545
 
906
546
    The byte storage facilities are addressed via tuples, which we refer to
907
547
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
908
548
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
909
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
910
 
    byte string made up of a hash identifier and a hash value.
911
 
    We use this interface because it allows low friction with the underlying
912
 
    code that implements disk indices, network encoding and other parts of
913
 
    bzrlib.
 
549
    (file_id, revision_id). We use this interface because it allows low
 
550
    friction with the underlying code that implements disk indices, network
 
551
    encoding and other parts of bzrlib.
914
552
 
915
553
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
916
554
        the serialised revisions for the repository. This can be used to obtain
935
573
        The result of trying to insert data into the repository via this store
936
574
        is undefined: it should be considered read-only except for implementors
937
575
        of repositories.
938
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
939
 
        any data the repository chooses to store or have indexed by its hash.
940
 
        The result of trying to insert data into the repository via this store
941
 
        is undefined: it should be considered read-only except for implementors
942
 
        of repositories.
943
576
    :ivar _transport: Transport for file access to repository, typically
944
577
        pointing to .bzr/repository.
945
578
    """
966
599
        """
967
600
        if self._write_group is not self.get_transaction():
968
601
            # has an unlock or relock occured ?
969
 
            if suppress_errors:
970
 
                mutter(
971
 
                '(suppressed) mismatched lock context and write group. %r, %r',
972
 
                self._write_group, self.get_transaction())
973
 
                return
974
 
            raise errors.BzrError(
975
 
                'mismatched lock context and write group. %r, %r' %
976
 
                (self._write_group, self.get_transaction()))
 
602
            raise errors.BzrError('mismatched lock context and write group.')
977
603
        try:
978
604
            self._abort_write_group()
979
605
        except Exception, exc:
1005
631
        """
1006
632
        if not self._format.supports_external_lookups:
1007
633
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1008
 
        if self.is_locked():
1009
 
            # This repository will call fallback.unlock() when we transition to
1010
 
            # the unlocked state, so we make sure to increment the lock count
1011
 
            repository.lock_read()
1012
634
        self._check_fallback_repository(repository)
1013
635
        self._fallback_repositories.append(repository)
1014
636
        self.texts.add_fallback_versioned_files(repository.texts)
1015
637
        self.inventories.add_fallback_versioned_files(repository.inventories)
1016
638
        self.revisions.add_fallback_versioned_files(repository.revisions)
1017
639
        self.signatures.add_fallback_versioned_files(repository.signatures)
1018
 
        if self.chk_bytes is not None:
1019
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
 
640
        self._fetch_order = 'topological'
1020
641
 
1021
642
    def _check_fallback_repository(self, repository):
1022
643
        """Check that this repository can fallback to repository safely.
1046
667
                % (inv.revision_id, revision_id))
1047
668
        if inv.root is None:
1048
669
            raise AssertionError()
1049
 
        return self._add_inventory_checked(revision_id, inv, parents)
1050
 
 
1051
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1052
 
        """Add inv to the repository after checking the inputs.
1053
 
 
1054
 
        This function can be overridden to allow different inventory styles.
1055
 
 
1056
 
        :seealso: add_inventory, for the contract.
1057
 
        """
1058
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
670
        inv_lines = self._serialise_inventory_to_lines(inv)
1059
671
        return self._inventory_add_lines(revision_id, parents,
1060
672
            inv_lines, check_content=False)
1061
673
 
1062
674
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1063
 
                               parents, basis_inv=None, propagate_caches=False):
 
675
                               parents):
1064
676
        """Add a new inventory expressed as a delta against another revision.
1065
677
 
1066
 
        See the inventory developers documentation for the theory behind
1067
 
        inventory deltas.
1068
 
 
1069
678
        :param basis_revision_id: The inventory id the delta was created
1070
679
            against. (This does not have to be a direct parent.)
1071
680
        :param delta: The inventory delta (see Inventory.apply_delta for
1077
686
            for repositories that depend on the inventory graph for revision
1078
687
            graph access, as well as for those that pun ancestry with delta
1079
688
            compression.
1080
 
        :param basis_inv: The basis inventory if it is already known,
1081
 
            otherwise None.
1082
 
        :param propagate_caches: If True, the caches for this inventory are
1083
 
          copied to and updated for the result if possible.
1084
689
 
1085
690
        :returns: (validator, new_inv)
1086
691
            The validator(which is a sha1 digest, though what is sha'd is
1097
702
            # inventory implementations may support: A better idiom would be to
1098
703
            # return a new inventory, but as there is no revision tree cache in
1099
704
            # repository this is safe for now - RBC 20081013
1100
 
            if basis_inv is None:
1101
 
                basis_inv = basis_tree.inventory
 
705
            basis_inv = basis_tree.inventory
1102
706
            basis_inv.apply_delta(delta)
1103
707
            basis_inv.revision_id = new_revision_id
1104
708
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1110
714
        check_content=True):
1111
715
        """Store lines in inv_vf and return the sha1 of the inventory."""
1112
716
        parents = [(parent,) for parent in parents]
1113
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
717
        return self.inventories.add_lines((revision_id,), parents, lines,
1114
718
            check_content=check_content)[0]
1115
 
        self.inventories._access.flush()
1116
 
        return result
1117
719
 
1118
720
    def add_revision(self, revision_id, rev, inv=None, config=None):
1119
721
        """Add rev to the revision store as revision_id.
1195
797
        # The old API returned a list, should this actually be a set?
1196
798
        return parent_map.keys()
1197
799
 
1198
 
    def _check_inventories(self, checker):
1199
 
        """Check the inventories found from the revision scan.
1200
 
        
1201
 
        This is responsible for verifying the sha1 of inventories and
1202
 
        creating a pending_keys set that covers data referenced by inventories.
1203
 
        """
1204
 
        bar = ui.ui_factory.nested_progress_bar()
1205
 
        try:
1206
 
            self._do_check_inventories(checker, bar)
1207
 
        finally:
1208
 
            bar.finished()
1209
 
 
1210
 
    def _do_check_inventories(self, checker, bar):
1211
 
        """Helper for _check_inventories."""
1212
 
        revno = 0
1213
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1214
 
        kinds = ['chk_bytes', 'texts']
1215
 
        count = len(checker.pending_keys)
1216
 
        bar.update("inventories", 0, 2)
1217
 
        current_keys = checker.pending_keys
1218
 
        checker.pending_keys = {}
1219
 
        # Accumulate current checks.
1220
 
        for key in current_keys:
1221
 
            if key[0] != 'inventories' and key[0] not in kinds:
1222
 
                checker._report_items.append('unknown key type %r' % (key,))
1223
 
            keys[key[0]].add(key[1:])
1224
 
        if keys['inventories']:
1225
 
            # NB: output order *should* be roughly sorted - topo or
1226
 
            # inverse topo depending on repository - either way decent
1227
 
            # to just delta against. However, pre-CHK formats didn't
1228
 
            # try to optimise inventory layout on disk. As such the
1229
 
            # pre-CHK code path does not use inventory deltas.
1230
 
            last_object = None
1231
 
            for record in self.inventories.check(keys=keys['inventories']):
1232
 
                if record.storage_kind == 'absent':
1233
 
                    checker._report_items.append(
1234
 
                        'Missing inventory {%s}' % (record.key,))
1235
 
                else:
1236
 
                    last_object = self._check_record('inventories', record,
1237
 
                        checker, last_object,
1238
 
                        current_keys[('inventories',) + record.key])
1239
 
            del keys['inventories']
1240
 
        else:
1241
 
            return
1242
 
        bar.update("texts", 1)
1243
 
        while (checker.pending_keys or keys['chk_bytes']
1244
 
            or keys['texts']):
1245
 
            # Something to check.
1246
 
            current_keys = checker.pending_keys
1247
 
            checker.pending_keys = {}
1248
 
            # Accumulate current checks.
1249
 
            for key in current_keys:
1250
 
                if key[0] not in kinds:
1251
 
                    checker._report_items.append('unknown key type %r' % (key,))
1252
 
                keys[key[0]].add(key[1:])
1253
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1254
 
            for kind in kinds:
1255
 
                if keys[kind]:
1256
 
                    last_object = None
1257
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1258
 
                        if record.storage_kind == 'absent':
1259
 
                            checker._report_items.append(
1260
 
                                'Missing %s {%s}' % (kind, record.key,))
1261
 
                        else:
1262
 
                            last_object = self._check_record(kind, record,
1263
 
                                checker, last_object, current_keys[(kind,) + record.key])
1264
 
                    keys[kind] = set()
1265
 
                    break
1266
 
 
1267
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1268
 
        """Check a single text from this repository."""
1269
 
        if kind == 'inventories':
1270
 
            rev_id = record.key[0]
1271
 
            inv = self._deserialise_inventory(rev_id,
1272
 
                record.get_bytes_as('fulltext'))
1273
 
            if last_object is not None:
1274
 
                delta = inv._make_delta(last_object)
1275
 
                for old_path, path, file_id, ie in delta:
1276
 
                    if ie is None:
1277
 
                        continue
1278
 
                    ie.check(checker, rev_id, inv)
1279
 
            else:
1280
 
                for path, ie in inv.iter_entries():
1281
 
                    ie.check(checker, rev_id, inv)
1282
 
            if self._format.fast_deltas:
1283
 
                return inv
1284
 
        elif kind == 'chk_bytes':
1285
 
            # No code written to check chk_bytes for this repo format.
1286
 
            checker._report_items.append(
1287
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1288
 
        elif kind == 'texts':
1289
 
            self._check_text(record, checker, item_data)
1290
 
        else:
1291
 
            checker._report_items.append(
1292
 
                'unknown key type %s for %s' % (kind, record.key))
1293
 
 
1294
 
    def _check_text(self, record, checker, item_data):
1295
 
        """Check a single text."""
1296
 
        # Check it is extractable.
1297
 
        # TODO: check length.
1298
 
        if record.storage_kind == 'chunked':
1299
 
            chunks = record.get_bytes_as(record.storage_kind)
1300
 
            sha1 = osutils.sha_strings(chunks)
1301
 
            length = sum(map(len, chunks))
1302
 
        else:
1303
 
            content = record.get_bytes_as('fulltext')
1304
 
            sha1 = osutils.sha_string(content)
1305
 
            length = len(content)
1306
 
        if item_data and sha1 != item_data[1]:
1307
 
            checker._report_items.append(
1308
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1309
 
                (record.key, sha1, item_data[1], item_data[2]))
1310
 
 
1311
800
    @staticmethod
1312
801
    def create(a_bzrdir):
1313
802
        """Construct the current default format repository in a_bzrdir."""
1318
807
 
1319
808
        :param _format: The format of the repository on disk.
1320
809
        :param a_bzrdir: The BzrDir of the repository.
 
810
 
 
811
        In the future we will have a single api for all stores for
 
812
        getting file texts, inventories and revisions, then
 
813
        this construct will accept instances of those things.
1321
814
        """
1322
 
        # In the future we will have a single api for all stores for
1323
 
        # getting file texts, inventories and revisions, then
1324
 
        # this construct will accept instances of those things.
1325
815
        super(Repository, self).__init__()
1326
816
        self._format = _format
1327
817
        # the following are part of the public API for Repository:
1333
823
        self._reconcile_does_inventory_gc = True
1334
824
        self._reconcile_fixes_text_parents = False
1335
825
        self._reconcile_backsup_inventory = True
 
826
        # not right yet - should be more semantically clear ?
 
827
        #
 
828
        # TODO: make sure to construct the right store classes, etc, depending
 
829
        # on whether escaping is required.
 
830
        self._warn_if_deprecated()
1336
831
        self._write_group = None
1337
832
        # Additional places to query for data.
1338
833
        self._fallback_repositories = []
 
834
        # What order should fetch operations request streams in?
 
835
        # The default is unordered as that is the cheapest for an origin to
 
836
        # provide.
 
837
        self._fetch_order = 'unordered'
 
838
        # Does this repository use deltas that can be fetched as-deltas ?
 
839
        # (E.g. knits, where the knit deltas can be transplanted intact.
 
840
        # We default to False, which will ensure that enough data to get
 
841
        # a full text out of any fetch stream will be grabbed.
 
842
        self._fetch_uses_deltas = False
 
843
        # Should fetch trigger a reconcile after the fetch? Only needed for
 
844
        # some repository formats that can suffer internal inconsistencies.
 
845
        self._fetch_reconcile = False
1339
846
        # An InventoryEntry cache, used during deserialization
1340
847
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1341
 
        # Is it safe to return inventory entries directly from the entry cache,
1342
 
        # rather copying them?
1343
 
        self._safe_to_return_from_cache = False
1344
 
 
1345
 
    @property
1346
 
    def user_transport(self):
1347
 
        return self.bzrdir.user_transport
1348
 
 
1349
 
    @property
1350
 
    def control_transport(self):
1351
 
        return self._transport
1352
848
 
1353
849
    def __repr__(self):
1354
 
        if self._fallback_repositories:
1355
 
            return '%s(%r, fallback_repositories=%r)' % (
1356
 
                self.__class__.__name__,
1357
 
                self.base,
1358
 
                self._fallback_repositories)
1359
 
        else:
1360
 
            return '%s(%r)' % (self.__class__.__name__,
1361
 
                               self.base)
1362
 
 
1363
 
    def _has_same_fallbacks(self, other_repo):
1364
 
        """Returns true if the repositories have the same fallbacks."""
1365
 
        my_fb = self._fallback_repositories
1366
 
        other_fb = other_repo._fallback_repositories
1367
 
        if len(my_fb) != len(other_fb):
1368
 
            return False
1369
 
        for f, g in zip(my_fb, other_fb):
1370
 
            if not f.has_same_location(g):
1371
 
                return False
1372
 
        return True
 
850
        return '%s(%r)' % (self.__class__.__name__,
 
851
                           self.base)
1373
852
 
1374
853
    def has_same_location(self, other):
1375
854
        """Returns a boolean indicating if this repository is at the same
1403
882
        data during reads, and allows a 'write_group' to be obtained. Write
1404
883
        groups must be used for actual data insertion.
1405
884
 
1406
 
        A token should be passed in if you know that you have locked the object
1407
 
        some other way, and need to synchronise this object's state with that
1408
 
        fact.
1409
 
 
1410
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
 
 
1412
885
        :param token: if this is already locked, then lock_write will fail
1413
886
            unless the token matches the existing lock.
1414
887
        :returns: a token if this instance supports tokens, otherwise None.
1417
890
        :raises MismatchedToken: if the specified token doesn't match the token
1418
891
            of the existing lock.
1419
892
        :seealso: start_write_group.
1420
 
        :return: A RepositoryWriteLockResult.
 
893
 
 
894
        A token should be passed in if you know that you have locked the object
 
895
        some other way, and need to synchronise this object's state with that
 
896
        fact.
 
897
 
 
898
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1421
899
        """
1422
 
        locked = self.is_locked()
1423
 
        token = self.control_files.lock_write(token=token)
1424
 
        if not locked:
1425
 
            self._warn_if_deprecated()
1426
 
            self._note_lock('w')
1427
 
            for repo in self._fallback_repositories:
1428
 
                # Writes don't affect fallback repos
1429
 
                repo.lock_read()
1430
 
            self._refresh_data()
1431
 
        return RepositoryWriteLockResult(self.unlock, token)
 
900
        result = self.control_files.lock_write(token=token)
 
901
        for repo in self._fallback_repositories:
 
902
            # Writes don't affect fallback repos
 
903
            repo.lock_read()
 
904
        self._refresh_data()
 
905
        return result
1432
906
 
1433
907
    def lock_read(self):
1434
 
        """Lock the repository for read operations.
1435
 
 
1436
 
        :return: An object with an unlock method which will release the lock
1437
 
            obtained.
1438
 
        """
1439
 
        locked = self.is_locked()
1440
908
        self.control_files.lock_read()
1441
 
        if not locked:
1442
 
            self._warn_if_deprecated()
1443
 
            self._note_lock('r')
1444
 
            for repo in self._fallback_repositories:
1445
 
                repo.lock_read()
1446
 
            self._refresh_data()
1447
 
        return LogicalLockResult(self.unlock)
 
909
        for repo in self._fallback_repositories:
 
910
            repo.lock_read()
 
911
        self._refresh_data()
1448
912
 
1449
913
    def get_physical_lock_status(self):
1450
914
        return self.control_files.get_physical_lock_status()
1510
974
 
1511
975
        # now gather global repository information
1512
976
        # XXX: This is available for many repos regardless of listability.
1513
 
        if self.user_transport.listable():
 
977
        if self.bzrdir.root_transport.listable():
1514
978
            # XXX: do we want to __define len__() ?
1515
979
            # Maybe the versionedfiles object should provide a different
1516
980
            # method to get the number of keys.
1526
990
        :param using: If True, list only branches using this repository.
1527
991
        """
1528
992
        if using and not self.is_shared():
1529
 
            return self.bzrdir.list_branches()
 
993
            try:
 
994
                return [self.bzrdir.open_branch()]
 
995
            except errors.NotBranchError:
 
996
                return []
1530
997
        class Evaluator(object):
1531
998
 
1532
999
            def __init__(self):
1541
1008
                    except errors.NoRepositoryPresent:
1542
1009
                        pass
1543
1010
                    else:
1544
 
                        return False, ([], repository)
 
1011
                        return False, (None, repository)
1545
1012
                self.first_call = False
1546
 
                value = (bzrdir.list_branches(), None)
 
1013
                try:
 
1014
                    value = (bzrdir.open_branch(), None)
 
1015
                except errors.NotBranchError:
 
1016
                    value = (None, None)
1547
1017
                return True, value
1548
1018
 
1549
 
        ret = []
1550
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1551
 
                self.user_transport, evaluate=Evaluator()):
1552
 
            if branches is not None:
1553
 
                ret.extend(branches)
 
1019
        branches = []
 
1020
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1021
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1022
            if branch is not None:
 
1023
                branches.append(branch)
1554
1024
            if not using and repository is not None:
1555
 
                ret.extend(repository.find_branches())
1556
 
        return ret
 
1025
                branches.extend(repository.find_branches())
 
1026
        return branches
1557
1027
 
1558
1028
    @needs_read_lock
1559
1029
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1566
1036
        return InterRepository.get(other, self).search_missing_revision_ids(
1567
1037
            revision_id, find_ghosts)
1568
1038
 
 
1039
    @deprecated_method(one_two)
 
1040
    @needs_read_lock
 
1041
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1042
        """Return the revision ids that other has that this does not.
 
1043
 
 
1044
        These are returned in topological order.
 
1045
 
 
1046
        revision_id: only return revision ids included by revision_id.
 
1047
        """
 
1048
        keys =  self.search_missing_revision_ids(
 
1049
            other, revision_id, find_ghosts).get_keys()
 
1050
        other.lock_read()
 
1051
        try:
 
1052
            parents = other.get_graph().get_parent_map(keys)
 
1053
        finally:
 
1054
            other.unlock()
 
1055
        return tsort.topo_sort(parents)
 
1056
 
1569
1057
    @staticmethod
1570
1058
    def open(base):
1571
1059
        """Open the repository rooted at base.
1588
1076
        """Commit the contents accrued within the current write group.
1589
1077
 
1590
1078
        :seealso: start_write_group.
1591
 
        
1592
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1593
1079
        """
1594
1080
        if self._write_group is not self.get_transaction():
1595
1081
            # has an unlock or relock occured ?
1596
1082
            raise errors.BzrError('mismatched lock context %r and '
1597
1083
                'write group %r.' %
1598
1084
                (self.get_transaction(), self._write_group))
1599
 
        result = self._commit_write_group()
 
1085
        self._commit_write_group()
1600
1086
        self._write_group = None
1601
 
        return result
1602
1087
 
1603
1088
    def _commit_write_group(self):
1604
1089
        """Template method for per-repository write group cleanup.
1612
1097
    def suspend_write_group(self):
1613
1098
        raise errors.UnsuspendableWriteGroup(self)
1614
1099
 
1615
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1616
 
        """Return the keys of missing inventory parents for revisions added in
1617
 
        this write group.
1618
 
 
1619
 
        A revision is not complete if the inventory delta for that revision
1620
 
        cannot be calculated.  Therefore if the parent inventories of a
1621
 
        revision are not present, the revision is incomplete, and e.g. cannot
1622
 
        be streamed by a smart server.  This method finds missing inventory
1623
 
        parents for revisions added in this write group.
1624
 
        """
1625
 
        if not self._format.supports_external_lookups:
1626
 
            # This is only an issue for stacked repositories
1627
 
            return set()
1628
 
        if not self.is_in_write_group():
1629
 
            raise AssertionError('not in a write group')
1630
 
 
1631
 
        # XXX: We assume that every added revision already has its
1632
 
        # corresponding inventory, so we only check for parent inventories that
1633
 
        # might be missing, rather than all inventories.
1634
 
        parents = set(self.revisions._index.get_missing_parents())
1635
 
        parents.discard(_mod_revision.NULL_REVISION)
1636
 
        unstacked_inventories = self.inventories._index
1637
 
        present_inventories = unstacked_inventories.get_parent_map(
1638
 
            key[-1:] for key in parents)
1639
 
        parents.difference_update(present_inventories)
1640
 
        if len(parents) == 0:
1641
 
            # No missing parent inventories.
1642
 
            return set()
1643
 
        if not check_for_missing_texts:
1644
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1645
 
        # Ok, now we have a list of missing inventories.  But these only matter
1646
 
        # if the inventories that reference them are missing some texts they
1647
 
        # appear to introduce.
1648
 
        # XXX: Texts referenced by all added inventories need to be present,
1649
 
        # but at the moment we're only checking for texts referenced by
1650
 
        # inventories at the graph's edge.
1651
 
        key_deps = self.revisions._index._key_dependencies
1652
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1653
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1654
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1655
 
        missing_texts = set()
1656
 
        for file_id, version_ids in file_ids.iteritems():
1657
 
            missing_texts.update(
1658
 
                (file_id, version_id) for version_id in version_ids)
1659
 
        present_texts = self.texts.get_parent_map(missing_texts)
1660
 
        missing_texts.difference_update(present_texts)
1661
 
        if not missing_texts:
1662
 
            # No texts are missing, so all revisions and their deltas are
1663
 
            # reconstructable.
1664
 
            return set()
1665
 
        # Alternatively the text versions could be returned as the missing
1666
 
        # keys, but this is likely to be less data.
1667
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1668
 
        return missing_keys
1669
 
 
1670
 
    def refresh_data(self):
1671
 
        """Re-read any data needed to synchronise with disk.
1672
 
 
1673
 
        This method is intended to be called after another repository instance
1674
 
        (such as one used by a smart server) has inserted data into the
1675
 
        repository. On all repositories this will work outside of write groups.
1676
 
        Some repository formats (pack and newer for bzrlib native formats)
1677
 
        support refresh_data inside write groups. If called inside a write
1678
 
        group on a repository that does not support refreshing in a write group
1679
 
        IsInWriteGroupError will be raised.
1680
 
        """
1681
 
        self._refresh_data()
1682
 
 
1683
1100
    def resume_write_group(self, tokens):
1684
1101
        if not self.is_write_locked():
1685
1102
            raise errors.NotWriteLocked(self)
1692
1109
    def _resume_write_group(self, tokens):
1693
1110
        raise errors.UnsuspendableWriteGroup(self)
1694
1111
 
1695
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1696
 
            fetch_spec=None):
 
1112
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1697
1113
        """Fetch the content required to construct revision_id from source.
1698
1114
 
1699
 
        If revision_id is None and fetch_spec is None, then all content is
1700
 
        copied.
1701
 
 
1702
 
        fetch() may not be used when the repository is in a write group -
1703
 
        either finish the current write group before using fetch, or use
1704
 
        fetch before starting the write group.
1705
 
 
 
1115
        If revision_id is None all content is copied.
1706
1116
        :param find_ghosts: Find and copy revisions in the source that are
1707
1117
            ghosts in the target (and not reachable directly by walking out to
1708
1118
            the first-present revision in target from revision_id).
1709
 
        :param revision_id: If specified, all the content needed for this
1710
 
            revision ID will be copied to the target.  Fetch will determine for
1711
 
            itself which content needs to be copied.
1712
 
        :param fetch_spec: If specified, a SearchResult or
1713
 
            PendingAncestryResult that describes which revisions to copy.  This
1714
 
            allows copying multiple heads at once.  Mutually exclusive with
1715
 
            revision_id.
1716
1119
        """
1717
 
        if fetch_spec is not None and revision_id is not None:
1718
 
            raise AssertionError(
1719
 
                "fetch_spec and revision_id are mutually exclusive.")
1720
 
        if self.is_in_write_group():
1721
 
            raise errors.InternalBzrError(
1722
 
                "May not fetch while in a write group.")
1723
1120
        # fast path same-url fetch operations
1724
 
        # TODO: lift out to somewhere common with RemoteRepository
1725
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1726
 
        if (self.has_same_location(source)
1727
 
            and fetch_spec is None
1728
 
            and self._has_same_fallbacks(source)):
 
1121
        if self.has_same_location(source):
1729
1122
            # check that last_revision is in 'from' and then return a
1730
1123
            # no-operation.
1731
1124
            if (revision_id is not None and
1737
1130
        # IncompatibleRepositories when asked to fetch.
1738
1131
        inter = InterRepository.get(source, self)
1739
1132
        return inter.fetch(revision_id=revision_id, pb=pb,
1740
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1133
            find_ghosts=find_ghosts)
1741
1134
 
1742
1135
    def create_bundle(self, target, base, fileobj, format=None):
1743
1136
        return serializer.write_bundle(self, target, base, fileobj, format)
1756
1149
        :param revprops: Optional dictionary of revision properties.
1757
1150
        :param revision_id: Optional revision id.
1758
1151
        """
1759
 
        if self._fallback_repositories:
1760
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1761
 
                "to a stacked branch. See "
1762
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1763
1152
        result = self._commit_builder_class(self, parents, config,
1764
1153
            timestamp, timezone, committer, revprops, revision_id)
1765
1154
        self.start_write_group()
1766
1155
        return result
1767
1156
 
1768
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1769
1157
    def unlock(self):
1770
1158
        if (self.control_files._lock_count == 1 and
1771
1159
            self.control_files._lock_mode == 'w'):
1777
1165
        self.control_files.unlock()
1778
1166
        if self.control_files._lock_count == 0:
1779
1167
            self._inventory_entry_cache.clear()
1780
 
            for repo in self._fallback_repositories:
1781
 
                repo.unlock()
 
1168
        for repo in self._fallback_repositories:
 
1169
            repo.unlock()
1782
1170
 
1783
1171
    @needs_read_lock
1784
1172
    def clone(self, a_bzrdir, revision_id=None):
1851
1239
        """Return a sink for streaming into this repository."""
1852
1240
        return StreamSink(self)
1853
1241
 
1854
 
    def _get_source(self, to_format):
1855
 
        """Return a source for streaming from this repository."""
1856
 
        return StreamSource(self, to_format)
1857
 
 
1858
1242
    @needs_read_lock
1859
1243
    def has_revision(self, revision_id):
1860
1244
        """True if this repository has a copy of the revision."""
1893
1277
 
1894
1278
    @needs_read_lock
1895
1279
    def get_revisions(self, revision_ids):
1896
 
        """Get many revisions at once.
1897
 
        
1898
 
        Repositories that need to check data on every revision read should 
1899
 
        subclass this method.
1900
 
        """
 
1280
        """Get many revisions at once."""
1901
1281
        return self._get_revisions(revision_ids)
1902
1282
 
1903
1283
    @needs_read_lock
1904
1284
    def _get_revisions(self, revision_ids):
1905
1285
        """Core work logic to get many revisions without sanity checks."""
 
1286
        for rev_id in revision_ids:
 
1287
            if not rev_id or not isinstance(rev_id, basestring):
 
1288
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1289
        keys = [(key,) for key in revision_ids]
 
1290
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1906
1291
        revs = {}
1907
 
        for revid, rev in self._iter_revisions(revision_ids):
1908
 
            if rev is None:
1909
 
                raise errors.NoSuchRevision(self, revid)
1910
 
            revs[revid] = rev
 
1292
        for record in stream:
 
1293
            if record.storage_kind == 'absent':
 
1294
                raise errors.NoSuchRevision(self, record.key[0])
 
1295
            text = record.get_bytes_as('fulltext')
 
1296
            rev = self._serializer.read_revision_from_string(text)
 
1297
            revs[record.key[0]] = rev
1911
1298
        return [revs[revid] for revid in revision_ids]
1912
1299
 
1913
 
    def _iter_revisions(self, revision_ids):
1914
 
        """Iterate over revision objects.
1915
 
 
1916
 
        :param revision_ids: An iterable of revisions to examine. None may be
1917
 
            passed to request all revisions known to the repository. Note that
1918
 
            not all repositories can find unreferenced revisions; for those
1919
 
            repositories only referenced ones will be returned.
1920
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1921
 
            those asked for but not available) are returned as (revid, None).
1922
 
        """
1923
 
        if revision_ids is None:
1924
 
            revision_ids = self.all_revision_ids()
1925
 
        else:
1926
 
            for rev_id in revision_ids:
1927
 
                if not rev_id or not isinstance(rev_id, basestring):
1928
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1929
 
        keys = [(key,) for key in revision_ids]
1930
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1931
 
        for record in stream:
1932
 
            revid = record.key[0]
1933
 
            if record.storage_kind == 'absent':
1934
 
                yield (revid, None)
1935
 
            else:
1936
 
                text = record.get_bytes_as('fulltext')
1937
 
                rev = self._serializer.read_revision_from_string(text)
1938
 
                yield (revid, rev)
1939
 
 
1940
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1300
    @needs_read_lock
 
1301
    def get_revision_xml(self, revision_id):
 
1302
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1303
        #       would have already do it.
 
1304
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1305
        rev = self.get_revision(revision_id)
 
1306
        rev_tmp = cStringIO.StringIO()
 
1307
        # the current serializer..
 
1308
        self._serializer.write_revision(rev, rev_tmp)
 
1309
        rev_tmp.seek(0)
 
1310
        return rev_tmp.getvalue()
 
1311
 
 
1312
    def get_deltas_for_revisions(self, revisions):
1941
1313
        """Produce a generator of revision deltas.
1942
1314
 
1943
1315
        Note that the input is a sequence of REVISIONS, not revision_ids.
1944
1316
        Trees will be held in memory until the generator exits.
1945
1317
        Each delta is relative to the revision's lefthand predecessor.
1946
 
 
1947
 
        :param specific_fileids: if not None, the result is filtered
1948
 
          so that only those file-ids, their parents and their
1949
 
          children are included.
1950
1318
        """
1951
 
        # Get the revision-ids of interest
1952
1319
        required_trees = set()
1953
1320
        for revision in revisions:
1954
1321
            required_trees.add(revision.revision_id)
1955
1322
            required_trees.update(revision.parent_ids[:1])
1956
 
 
1957
 
        # Get the matching filtered trees. Note that it's more
1958
 
        # efficient to pass filtered trees to changes_from() rather
1959
 
        # than doing the filtering afterwards. changes_from() could
1960
 
        # arguably do the filtering itself but it's path-based, not
1961
 
        # file-id based, so filtering before or afterwards is
1962
 
        # currently easier.
1963
 
        if specific_fileids is None:
1964
 
            trees = dict((t.get_revision_id(), t) for
1965
 
                t in self.revision_trees(required_trees))
1966
 
        else:
1967
 
            trees = dict((t.get_revision_id(), t) for
1968
 
                t in self._filtered_revision_trees(required_trees,
1969
 
                specific_fileids))
1970
 
 
1971
 
        # Calculate the deltas
 
1323
        trees = dict((t.get_revision_id(), t) for
 
1324
                     t in self.revision_trees(required_trees))
1972
1325
        for revision in revisions:
1973
1326
            if not revision.parent_ids:
1974
1327
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1977
1330
            yield trees[revision.revision_id].changes_from(old_tree)
1978
1331
 
1979
1332
    @needs_read_lock
1980
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1333
    def get_revision_delta(self, revision_id):
1981
1334
        """Return the delta for one revision.
1982
1335
 
1983
1336
        The delta is relative to the left-hand predecessor of the
1984
1337
        revision.
1985
 
 
1986
 
        :param specific_fileids: if not None, the result is filtered
1987
 
          so that only those file-ids, their parents and their
1988
 
          children are included.
1989
1338
        """
1990
1339
        r = self.get_revision(revision_id)
1991
 
        return list(self.get_deltas_for_revisions([r],
1992
 
            specific_fileids=specific_fileids))[0]
 
1340
        return list(self.get_deltas_for_revisions([r]))[0]
1993
1341
 
1994
1342
    @needs_write_lock
1995
1343
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2004
1352
    def find_text_key_references(self):
2005
1353
        """Find the text key references within the repository.
2006
1354
 
 
1355
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1356
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1357
        altered it listed explicitly.
2007
1358
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
2008
1359
            to whether they were referred to by the inventory of the
2009
1360
            revision_id that they contain. The inventory texts from all present
2098
1449
                result[key] = True
2099
1450
        return result
2100
1451
 
2101
 
    def _inventory_xml_lines_for_keys(self, keys):
2102
 
        """Get a line iterator of the sort needed for findind references.
2103
 
 
2104
 
        Not relevant for non-xml inventory repositories.
2105
 
 
2106
 
        Ghosts in revision_keys are ignored.
2107
 
 
2108
 
        :param revision_keys: The revision keys for the inventories to inspect.
2109
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2110
 
            all of the xml inventories specified by revision_keys.
2111
 
        """
2112
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2113
 
        for record in stream:
2114
 
            if record.storage_kind != 'absent':
2115
 
                chunks = record.get_bytes_as('chunked')
2116
 
                revid = record.key[-1]
2117
 
                lines = osutils.chunks_to_lines(chunks)
2118
 
                for line in lines:
2119
 
                    yield line, revid
2120
 
 
2121
1452
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2122
 
        revision_keys):
 
1453
        revision_ids):
2123
1454
        """Helper routine for fileids_altered_by_revision_ids.
2124
1455
 
2125
1456
        This performs the translation of xml lines to revision ids.
2126
1457
 
2127
1458
        :param line_iterator: An iterator of lines, origin_version_id
2128
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1459
        :param revision_ids: The revision ids to filter for. This should be a
2129
1460
            set or other type which supports efficient __contains__ lookups, as
2130
 
            the revision key from each parsed line will be looked up in the
2131
 
            revision_keys filter.
 
1461
            the revision id from each parsed line will be looked up in the
 
1462
            revision_ids filter.
2132
1463
        :return: a dictionary mapping altered file-ids to an iterable of
2133
1464
        revision_ids. Each altered file-ids has the exact revision_ids that
2134
1465
        altered it listed explicitly.
2135
1466
        """
2136
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2137
 
                line_iterator).iterkeys())
2138
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2139
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2140
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2141
 
        new_keys = seen - parent_seen
2142
1467
        result = {}
2143
1468
        setdefault = result.setdefault
2144
 
        for key in new_keys:
2145
 
            setdefault(key[0], set()).add(key[-1])
 
1469
        for key in \
 
1470
            self._find_text_key_references_from_xml_inventory_lines(
 
1471
                line_iterator).iterkeys():
 
1472
            # once data is all ensured-consistent; then this is
 
1473
            # if revision_id == version_id
 
1474
            if key[-1:] in revision_ids:
 
1475
                setdefault(key[0], set()).add(key[-1])
2146
1476
        return result
2147
1477
 
2148
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2149
 
        """Find all parent ids that are mentioned in the revision graph.
2150
 
 
2151
 
        :return: set of revisions that are parents of revision_ids which are
2152
 
            not part of revision_ids themselves
2153
 
        """
2154
 
        parent_map = self.get_parent_map(revision_ids)
2155
 
        parent_ids = set()
2156
 
        map(parent_ids.update, parent_map.itervalues())
2157
 
        parent_ids.difference_update(revision_ids)
2158
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2159
 
        return parent_ids
2160
 
 
2161
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2162
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2163
 
 
2164
 
        :param revision_keys: An iterable of revision_keys.
2165
 
        :return: The parents of all revision_keys that are not already in
2166
 
            revision_keys
2167
 
        """
2168
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2169
 
        parent_keys = set()
2170
 
        map(parent_keys.update, parent_map.itervalues())
2171
 
        parent_keys.difference_update(revision_keys)
2172
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2173
 
        return parent_keys
2174
 
 
2175
1478
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2176
1479
        """Find the file ids and versions affected by revisions.
2177
1480
 
2184
1487
        """
2185
1488
        selected_keys = set((revid,) for revid in revision_ids)
2186
1489
        w = _inv_weave or self.inventories
2187
 
        return self._find_file_ids_from_xml_inventory_lines(
2188
 
            w.iter_lines_added_or_present_in_keys(
2189
 
                selected_keys, pb=None),
2190
 
            selected_keys)
 
1490
        pb = ui.ui_factory.nested_progress_bar()
 
1491
        try:
 
1492
            return self._find_file_ids_from_xml_inventory_lines(
 
1493
                w.iter_lines_added_or_present_in_keys(
 
1494
                    selected_keys, pb=pb),
 
1495
                selected_keys)
 
1496
        finally:
 
1497
            pb.finished()
2191
1498
 
2192
1499
    def iter_files_bytes(self, desired_files):
2193
1500
        """Iterate through file versions.
2214
1521
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2215
1522
            if record.storage_kind == 'absent':
2216
1523
                raise errors.RevisionNotPresent(record.key, self)
2217
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1524
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2218
1525
 
2219
1526
    def _generate_text_key_index(self, text_key_references=None,
2220
1527
        ancestors=None):
2269
1576
        batch_size = 10 # should be ~150MB on a 55K path tree
2270
1577
        batch_count = len(revision_order) / batch_size + 1
2271
1578
        processed_texts = 0
2272
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1579
        pb.update("Calculating text parents.", processed_texts, text_count)
2273
1580
        for offset in xrange(batch_count):
2274
1581
            to_query = revision_order[offset * batch_size:(offset + 1) *
2275
1582
                batch_size]
2276
1583
            if not to_query:
2277
1584
                break
2278
 
            for revision_id in to_query:
 
1585
            for rev_tree in self.revision_trees(to_query):
 
1586
                revision_id = rev_tree.get_revision_id()
2279
1587
                parent_ids = ancestors[revision_id]
2280
1588
                for text_key in revision_keys[revision_id]:
2281
 
                    pb.update("Calculating text parents", processed_texts)
 
1589
                    pb.update("Calculating text parents.", processed_texts)
2282
1590
                    processed_texts += 1
2283
1591
                    candidate_parents = []
2284
1592
                    for parent_id in parent_ids:
2300
1608
                            except KeyError:
2301
1609
                                inv = self.revision_tree(parent_id).inventory
2302
1610
                                inventory_cache[parent_id] = inv
2303
 
                            try:
2304
 
                                parent_entry = inv[text_key[0]]
2305
 
                            except (KeyError, errors.NoSuchId):
2306
 
                                parent_entry = None
 
1611
                            parent_entry = inv._byid.get(text_key[0], None)
2307
1612
                            if parent_entry is not None:
2308
1613
                                parent_text_key = (
2309
1614
                                    text_key[0], parent_entry.revision)
2334
1639
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2335
1640
            'revisions'.  file-id is None unless knit-kind is 'file'.
2336
1641
        """
2337
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2338
 
            yield result
2339
 
        del _files_pb
2340
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2341
 
            yield result
2342
 
 
2343
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2344
1642
        # XXX: it's a bit weird to control the inventory weave caching in this
2345
1643
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2346
1644
        # maybe this generator should explicitly have the contract that it
2353
1651
        count = 0
2354
1652
        num_file_ids = len(file_ids)
2355
1653
        for file_id, altered_versions in file_ids.iteritems():
2356
 
            if pb is not None:
2357
 
                pb.update("Fetch texts", count, num_file_ids)
 
1654
            if _files_pb is not None:
 
1655
                _files_pb.update("fetch texts", count, num_file_ids)
2358
1656
            count += 1
2359
1657
            yield ("file", file_id, altered_versions)
 
1658
        # We're done with the files_pb.  Note that it finished by the caller,
 
1659
        # just as it was created by the caller.
 
1660
        del _files_pb
2360
1661
 
2361
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2362
1662
        # inventory
2363
1663
        yield ("inventory", None, revision_ids)
2364
1664
 
2381
1681
        """Get Inventory object by revision id."""
2382
1682
        return self.iter_inventories([revision_id]).next()
2383
1683
 
2384
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1684
    def iter_inventories(self, revision_ids):
2385
1685
        """Get many inventories by revision_ids.
2386
1686
 
2387
1687
        This will buffer some or all of the texts used in constructing the
2388
1688
        inventories in memory, but will only parse a single inventory at a
2389
1689
        time.
2390
1690
 
2391
 
        :param revision_ids: The expected revision ids of the inventories.
2392
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2393
 
            specified, the order of revision_ids will be preserved (by
2394
 
            buffering if necessary).
2395
1691
        :return: An iterator of inventories.
2396
1692
        """
2397
1693
        if ((None in revision_ids)
2398
1694
            or (_mod_revision.NULL_REVISION in revision_ids)):
2399
1695
            raise ValueError('cannot get null revision inventory')
2400
 
        return self._iter_inventories(revision_ids, ordering)
 
1696
        return self._iter_inventories(revision_ids)
2401
1697
 
2402
 
    def _iter_inventories(self, revision_ids, ordering):
 
1698
    def _iter_inventories(self, revision_ids):
2403
1699
        """single-document based inventory iteration."""
2404
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2405
 
        for text, revision_id in inv_xmls:
2406
 
            yield self._deserialise_inventory(revision_id, text)
 
1700
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1701
            yield self.deserialise_inventory(revision_id, text)
2407
1702
 
2408
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2409
 
        if ordering is None:
2410
 
            order_as_requested = True
2411
 
            ordering = 'unordered'
2412
 
        else:
2413
 
            order_as_requested = False
 
1703
    def _iter_inventory_xmls(self, revision_ids):
2414
1704
        keys = [(revision_id,) for revision_id in revision_ids]
2415
 
        if not keys:
2416
 
            return
2417
 
        if order_as_requested:
2418
 
            key_iter = iter(keys)
2419
 
            next_key = key_iter.next()
2420
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
1705
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2421
1706
        text_chunks = {}
2422
1707
        for record in stream:
2423
1708
            if record.storage_kind != 'absent':
2424
 
                chunks = record.get_bytes_as('chunked')
2425
 
                if order_as_requested:
2426
 
                    text_chunks[record.key] = chunks
2427
 
                else:
2428
 
                    yield ''.join(chunks), record.key[-1]
 
1709
                text_chunks[record.key] = record.get_bytes_as('chunked')
2429
1710
            else:
2430
1711
                raise errors.NoSuchRevision(self, record.key)
2431
 
            if order_as_requested:
2432
 
                # Yield as many results as we can while preserving order.
2433
 
                while next_key in text_chunks:
2434
 
                    chunks = text_chunks.pop(next_key)
2435
 
                    yield ''.join(chunks), next_key[-1]
2436
 
                    try:
2437
 
                        next_key = key_iter.next()
2438
 
                    except StopIteration:
2439
 
                        # We still want to fully consume the get_record_stream,
2440
 
                        # just in case it is not actually finished at this point
2441
 
                        next_key = None
2442
 
                        break
 
1712
        for key in keys:
 
1713
            chunks = text_chunks.pop(key)
 
1714
            yield ''.join(chunks), key[-1]
2443
1715
 
2444
 
    def _deserialise_inventory(self, revision_id, xml):
 
1716
    def deserialise_inventory(self, revision_id, xml):
2445
1717
        """Transform the xml into an inventory object.
2446
1718
 
2447
1719
        :param revision_id: The expected revision id of the inventory.
2448
1720
        :param xml: A serialised inventory.
2449
1721
        """
2450
1722
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2451
 
                    entry_cache=self._inventory_entry_cache,
2452
 
                    return_from_cache=self._safe_to_return_from_cache)
 
1723
                    entry_cache=self._inventory_entry_cache)
2453
1724
        if result.revision_id != revision_id:
2454
1725
            raise AssertionError('revision id mismatch %s != %s' % (
2455
1726
                result.revision_id, revision_id))
2456
1727
        return result
2457
1728
 
 
1729
    def serialise_inventory(self, inv):
 
1730
        return self._serializer.write_inventory_to_string(inv)
 
1731
 
 
1732
    def _serialise_inventory_to_lines(self, inv):
 
1733
        return self._serializer.write_inventory_to_lines(inv)
 
1734
 
2458
1735
    def get_serializer_format(self):
2459
1736
        return self._serializer.format_num
2460
1737
 
2461
1738
    @needs_read_lock
2462
 
    def _get_inventory_xml(self, revision_id):
2463
 
        """Get serialized inventory as a string."""
2464
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1739
    def get_inventory_xml(self, revision_id):
 
1740
        """Get inventory XML as a file object."""
 
1741
        texts = self._iter_inventory_xmls([revision_id])
2465
1742
        try:
2466
1743
            text, revision_id = texts.next()
2467
1744
        except StopIteration:
2468
1745
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2469
1746
        return text
2470
1747
 
2471
 
    def get_rev_id_for_revno(self, revno, known_pair):
2472
 
        """Return the revision id of a revno, given a later (revno, revid)
2473
 
        pair in the same history.
2474
 
 
2475
 
        :return: if found (True, revid).  If the available history ran out
2476
 
            before reaching the revno, then this returns
2477
 
            (False, (closest_revno, closest_revid)).
 
1748
    @needs_read_lock
 
1749
    def get_inventory_sha1(self, revision_id):
 
1750
        """Return the sha1 hash of the inventory entry
2478
1751
        """
2479
 
        known_revno, known_revid = known_pair
2480
 
        partial_history = [known_revid]
2481
 
        distance_from_known = known_revno - revno
2482
 
        if distance_from_known < 0:
2483
 
            raise ValueError(
2484
 
                'requested revno (%d) is later than given known revno (%d)'
2485
 
                % (revno, known_revno))
2486
 
        try:
2487
 
            _iter_for_revno(
2488
 
                self, partial_history, stop_index=distance_from_known)
2489
 
        except errors.RevisionNotPresent, err:
2490
 
            if err.revision_id == known_revid:
2491
 
                # The start revision (known_revid) wasn't found.
2492
 
                raise
2493
 
            # This is a stacked repository with no fallbacks, or a there's a
2494
 
            # left-hand ghost.  Either way, even though the revision named in
2495
 
            # the error isn't in this repo, we know it's the next step in this
2496
 
            # left-hand history.
2497
 
            partial_history.append(err.revision_id)
2498
 
        if len(partial_history) <= distance_from_known:
2499
 
            # Didn't find enough history to get a revid for the revno.
2500
 
            earliest_revno = known_revno - len(partial_history) + 1
2501
 
            return (False, (earliest_revno, partial_history[-1]))
2502
 
        if len(partial_history) - 1 > distance_from_known:
2503
 
            raise AssertionError('_iter_for_revno returned too much history')
2504
 
        return (True, partial_history[-1])
 
1752
        return self.get_revision(revision_id).inventory_sha1
2505
1753
 
2506
1754
    def iter_reverse_revision_history(self, revision_id):
2507
1755
        """Iterate backwards through revision ids in the lefthand history
2514
1762
        while True:
2515
1763
            if next_id in (None, _mod_revision.NULL_REVISION):
2516
1764
                return
2517
 
            try:
2518
 
                parents = graph.get_parent_map([next_id])[next_id]
2519
 
            except KeyError:
2520
 
                raise errors.RevisionNotPresent(next_id, self)
2521
1765
            yield next_id
 
1766
            # Note: The following line may raise KeyError in the event of
 
1767
            # truncated history. We decided not to have a try:except:raise
 
1768
            # RevisionNotPresent here until we see a use for it, because of the
 
1769
            # cost in an inner loop that is by its very nature O(history).
 
1770
            # Robert Collins 20080326
 
1771
            parents = graph.get_parent_map([next_id])[next_id]
2522
1772
            if len(parents) == 0:
2523
1773
                return
2524
1774
            else:
2525
1775
                next_id = parents[0]
2526
1776
 
 
1777
    @needs_read_lock
 
1778
    def get_revision_inventory(self, revision_id):
 
1779
        """Return inventory of a past revision."""
 
1780
        # TODO: Unify this with get_inventory()
 
1781
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1782
        # must be the same as its revision, so this is trivial.
 
1783
        if revision_id is None:
 
1784
            # This does not make sense: if there is no revision,
 
1785
            # then it is the current tree inventory surely ?!
 
1786
            # and thus get_root_id() is something that looks at the last
 
1787
            # commit on the branch, and the get_root_id is an inventory check.
 
1788
            raise NotImplementedError
 
1789
            # return Inventory(self.get_root_id())
 
1790
        else:
 
1791
            return self.get_inventory(revision_id)
 
1792
 
2527
1793
    def is_shared(self):
2528
1794
        """Return True if this repository is flagged as a shared repository."""
2529
1795
        raise NotImplementedError(self.is_shared)
2543
1809
        for repositories to maintain loaded indices across multiple locks
2544
1810
        by checking inside their implementation of this method to see
2545
1811
        whether their indices are still valid. This depends of course on
2546
 
        the disk format being validatable in this manner. This method is
2547
 
        also called by the refresh_data() public interface to cause a refresh
2548
 
        to occur while in a write lock so that data inserted by a smart server
2549
 
        push operation is visible on the client's instance of the physical
2550
 
        repository.
 
1812
        the disk format being validatable in this manner.
2551
1813
        """
2552
1814
 
2553
1815
    @needs_read_lock
2563
1825
            return RevisionTree(self, Inventory(root_id=None),
2564
1826
                                _mod_revision.NULL_REVISION)
2565
1827
        else:
2566
 
            inv = self.get_inventory(revision_id)
 
1828
            inv = self.get_revision_inventory(revision_id)
2567
1829
            return RevisionTree(self, inv, revision_id)
2568
1830
 
2569
1831
    def revision_trees(self, revision_ids):
2570
 
        """Return Trees for revisions in this repository.
 
1832
        """Return Tree for a revision on this branch.
2571
1833
 
2572
 
        :param revision_ids: a sequence of revision-ids;
2573
 
          a revision-id may not be None or 'null:'
2574
 
        """
 
1834
        `revision_id` may not be None or 'null:'"""
2575
1835
        inventories = self.iter_inventories(revision_ids)
2576
1836
        for inv in inventories:
2577
1837
            yield RevisionTree(self, inv, inv.revision_id)
2578
1838
 
2579
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2580
 
        """Return Tree for a revision on this branch with only some files.
2581
 
 
2582
 
        :param revision_ids: a sequence of revision-ids;
2583
 
          a revision-id may not be None or 'null:'
2584
 
        :param file_ids: if not None, the result is filtered
2585
 
          so that only those file-ids, their parents and their
2586
 
          children are included.
2587
 
        """
2588
 
        inventories = self.iter_inventories(revision_ids)
2589
 
        for inv in inventories:
2590
 
            # Should we introduce a FilteredRevisionTree class rather
2591
 
            # than pre-filter the inventory here?
2592
 
            filtered_inv = inv.filter(file_ids)
2593
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2594
 
 
2595
1839
    @needs_read_lock
2596
1840
    def get_ancestry(self, revision_id, topo_sorted=True):
2597
1841
        """Return a list of revision-ids integrated by a revision.
2622
1866
            keys = tsort.topo_sort(parent_map)
2623
1867
        return [None] + list(keys)
2624
1868
 
2625
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1869
    def pack(self):
2626
1870
        """Compress the data within the repository.
2627
1871
 
2628
1872
        This operation only makes sense for some repository types. For other
2631
1875
        This stub method does not require a lock, but subclasses should use
2632
1876
        @needs_write_lock as this is a long running call its reasonable to
2633
1877
        implicitly lock for the user.
2634
 
 
2635
 
        :param hint: If not supplied, the whole repository is packed.
2636
 
            If supplied, the repository may use the hint parameter as a
2637
 
            hint for the parts of the repository to pack. A hint can be
2638
 
            obtained from the result of commit_write_group(). Out of
2639
 
            date hints are simply ignored, because concurrent operations
2640
 
            can obsolete them rapidly.
2641
 
 
2642
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2643
 
            the pack operation.
2644
 
        """
 
1878
        """
 
1879
 
 
1880
    @needs_read_lock
 
1881
    @deprecated_method(one_six)
 
1882
    def print_file(self, file, revision_id):
 
1883
        """Print `file` to stdout.
 
1884
 
 
1885
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1886
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1887
        by creating a new more flexible convenience function.
 
1888
        """
 
1889
        tree = self.revision_tree(revision_id)
 
1890
        # use inventory as it was in that revision
 
1891
        file_id = tree.inventory.path2id(file)
 
1892
        if not file_id:
 
1893
            # TODO: jam 20060427 Write a test for this code path
 
1894
            #       it had a bug in it, and was raising the wrong
 
1895
            #       exception.
 
1896
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1897
        tree.print_file(file_id)
2645
1898
 
2646
1899
    def get_transaction(self):
2647
1900
        return self.control_files.get_transaction()
2648
1901
 
 
1902
    @deprecated_method(one_one)
 
1903
    def get_parents(self, revision_ids):
 
1904
        """See StackedParentsProvider.get_parents"""
 
1905
        parent_map = self.get_parent_map(revision_ids)
 
1906
        return [parent_map.get(r, None) for r in revision_ids]
 
1907
 
2649
1908
    def get_parent_map(self, revision_ids):
2650
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1909
        """See graph._StackedParentsProvider.get_parent_map"""
2651
1910
        # revisions index works in keys; this just works in revisions
2652
1911
        # therefore wrap and unwrap
2653
1912
        query_keys = []
2662
1921
        for ((revision_id,), parent_keys) in \
2663
1922
                self.revisions.get_parent_map(query_keys).iteritems():
2664
1923
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
1924
                result[revision_id] = tuple(parent_revid
 
1925
                    for (parent_revid,) in parent_keys)
2667
1926
            else:
2668
1927
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
1928
        return result
2671
1930
    def _make_parents_provider(self):
2672
1931
        return self
2673
1932
 
2674
 
    @needs_read_lock
2675
 
    def get_known_graph_ancestry(self, revision_ids):
2676
 
        """Return the known graph for a set of revision ids and their ancestors.
2677
 
        """
2678
 
        st = static_tuple.StaticTuple
2679
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2680
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2681
 
        return graph.GraphThunkIdsToKeys(known_graph)
2682
 
 
2683
1933
    def get_graph(self, other_repository=None):
2684
1934
        """Return the graph walker for this repository format"""
2685
1935
        parents_provider = self._make_parents_provider()
2686
1936
        if (other_repository is not None and
2687
1937
            not self.has_same_location(other_repository)):
2688
 
            parents_provider = graph.StackedParentsProvider(
 
1938
            parents_provider = graph._StackedParentsProvider(
2689
1939
                [parents_provider, other_repository._make_parents_provider()])
2690
1940
        return graph.Graph(parents_provider)
2691
1941
 
2692
 
    def _get_versioned_file_checker(self, text_key_references=None,
2693
 
        ancestors=None):
2694
 
        """Return an object suitable for checking versioned files.
2695
 
        
2696
 
        :param text_key_references: if non-None, an already built
2697
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2698
 
            to whether they were referred to by the inventory of the
2699
 
            revision_id that they contain. If None, this will be
2700
 
            calculated.
2701
 
        :param ancestors: Optional result from
2702
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2703
 
            available.
2704
 
        """
2705
 
        return _VersionedFileChecker(self,
2706
 
            text_key_references=text_key_references, ancestors=ancestors)
 
1942
    def _get_versioned_file_checker(self):
 
1943
        """Return an object suitable for checking versioned files."""
 
1944
        return _VersionedFileChecker(self)
2707
1945
 
2708
1946
    def revision_ids_to_search_result(self, result_set):
2709
1947
        """Convert a set of revision ids to a graph SearchResult."""
2759
1997
        return record.get_bytes_as('fulltext')
2760
1998
 
2761
1999
    @needs_read_lock
2762
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2000
    def check(self, revision_ids=None):
2763
2001
        """Check consistency of all history of given revision_ids.
2764
2002
 
2765
2003
        Different repository implementations should override _check().
2766
2004
 
2767
2005
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2768
2006
             will be checked.  Typically the last revision_id of a branch.
2769
 
        :param callback_refs: A dict of check-refs to resolve and callback
2770
 
            the check/_check method on the items listed as wanting the ref.
2771
 
            see bzrlib.check.
2772
 
        :param check_repo: If False do not check the repository contents, just 
2773
 
            calculate the data callback_refs requires and call them back.
2774
2007
        """
2775
 
        return self._check(revision_ids, callback_refs=callback_refs,
2776
 
            check_repo=check_repo)
 
2008
        return self._check(revision_ids)
2777
2009
 
2778
 
    def _check(self, revision_ids, callback_refs, check_repo):
2779
 
        result = check.Check(self, check_repo=check_repo)
2780
 
        result.check(callback_refs)
 
2010
    def _check(self, revision_ids):
 
2011
        result = check.Check(self)
 
2012
        result.check()
2781
2013
        return result
2782
2014
 
2783
 
    def _warn_if_deprecated(self, branch=None):
 
2015
    def _warn_if_deprecated(self):
2784
2016
        global _deprecation_warning_done
2785
2017
        if _deprecation_warning_done:
2786
2018
            return
2787
 
        try:
2788
 
            if branch is None:
2789
 
                conf = config.GlobalConfig()
2790
 
            else:
2791
 
                conf = branch.get_config()
2792
 
            if conf.suppress_warning('format_deprecation'):
2793
 
                return
2794
 
            warning("Format %s for %s is deprecated -"
2795
 
                    " please use 'bzr upgrade' to get better performance"
2796
 
                    % (self._format, self.bzrdir.transport.base))
2797
 
        finally:
2798
 
            _deprecation_warning_done = True
 
2019
        _deprecation_warning_done = True
 
2020
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2021
                % (self._format, self.bzrdir.transport.base))
2799
2022
 
2800
2023
    def supports_rich_root(self):
2801
2024
        return self._format.rich_root_data
2875
2098
    """
2876
2099
    repository.start_write_group()
2877
2100
    try:
2878
 
        inventory_cache = lru_cache.LRUCache(10)
2879
2101
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2880
 
            _install_revision(repository, revision, revision_tree, signature,
2881
 
                inventory_cache)
 
2102
            _install_revision(repository, revision, revision_tree, signature)
2882
2103
            if pb is not None:
2883
2104
                pb.update('Transferring revisions', n + 1, num_revisions)
2884
2105
    except:
2888
2109
        repository.commit_write_group()
2889
2110
 
2890
2111
 
2891
 
def _install_revision(repository, rev, revision_tree, signature,
2892
 
    inventory_cache):
 
2112
def _install_revision(repository, rev, revision_tree, signature):
2893
2113
    """Install all revision data into a repository."""
2894
2114
    present_parents = []
2895
2115
    parent_trees = {}
2932
2152
        repository.texts.add_lines(text_key, text_parents, lines)
2933
2153
    try:
2934
2154
        # install the inventory
2935
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2936
 
            # Cache this inventory
2937
 
            inventory_cache[rev.revision_id] = inv
2938
 
            try:
2939
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2940
 
            except KeyError:
2941
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2942
 
            else:
2943
 
                delta = inv._make_delta(basis_inv)
2944
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2945
 
                    rev.revision_id, present_parents)
2946
 
        else:
2947
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2155
        repository.add_inventory(rev.revision_id, inv, present_parents)
2948
2156
    except errors.RevisionAlreadyPresent:
2949
2157
        pass
2950
2158
    if signature is not None:
2999
2207
            control_files)
3000
2208
 
3001
2209
 
3002
 
network_format_registry = registry.FormatRegistry()
 
2210
class RepositoryFormatRegistry(registry.Registry):
 
2211
    """Registry of RepositoryFormats."""
 
2212
 
 
2213
    def __init__(self, other_registry=None):
 
2214
        registry.Registry.__init__(self)
 
2215
        self._other_registry = other_registry
 
2216
 
 
2217
    def register_lazy(self, key, module_name, member_name,
 
2218
                      help=None, info=None,
 
2219
                      override_existing=False):
 
2220
        # Overridden to allow capturing registrations to two seperate
 
2221
        # registries in a single call.
 
2222
        registry.Registry.register_lazy(self, key, module_name, member_name,
 
2223
                help=help, info=info, override_existing=override_existing)
 
2224
        if self._other_registry is not None:
 
2225
            self._other_registry.register_lazy(key, module_name, member_name,
 
2226
                help=help, info=info, override_existing=override_existing)
 
2227
 
 
2228
    def get(self, format_string):
 
2229
        r = registry.Registry.get(self, format_string)
 
2230
        if callable(r):
 
2231
            r = r()
 
2232
        return r
 
2233
 
 
2234
 
 
2235
network_format_registry = RepositoryFormatRegistry()
3003
2236
"""Registry of formats indexed by their network name.
3004
2237
 
3005
2238
The network name for a repository format is an identifier that can be used when
3008
2241
"""
3009
2242
 
3010
2243
 
3011
 
format_registry = registry.FormatRegistry(network_format_registry)
 
2244
format_registry = RepositoryFormatRegistry(network_format_registry)
3012
2245
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
3013
2246
 
3014
2247
This can contain either format instances themselves, or classes/factories that
3041
2274
 
3042
2275
    Once a format is deprecated, just deprecate the initialize and open
3043
2276
    methods on the format class. Do not deprecate the object, as the
3044
 
    object may be created even when a repository instance hasn't been
 
2277
    object may be created even when a repository instnace hasn't been
3045
2278
    created.
3046
2279
 
3047
2280
    Common instance attributes:
3057
2290
    # Can this repository be given external locations to lookup additional
3058
2291
    # data. Set to True or False in derived classes.
3059
2292
    supports_external_lookups = None
3060
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3061
 
    # derived classes.
3062
 
    supports_chks = None
3063
 
    # Should commit add an inventory, or an inventory delta to the repository.
3064
 
    _commit_inv_deltas = True
3065
 
    # What order should fetch operations request streams in?
3066
 
    # The default is unordered as that is the cheapest for an origin to
3067
 
    # provide.
3068
 
    _fetch_order = 'unordered'
3069
 
    # Does this repository format use deltas that can be fetched as-deltas ?
3070
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3071
 
    # We default to False, which will ensure that enough data to get
3072
 
    # a full text out of any fetch stream will be grabbed.
3073
 
    _fetch_uses_deltas = False
3074
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
3075
 
    # some repository formats that can suffer internal inconsistencies.
3076
 
    _fetch_reconcile = False
3077
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3078
 
    # code path for commit, amongst other things.
3079
 
    fast_deltas = None
3080
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3081
 
    # (so if there is one pack, the operation can still proceed because it may
3082
 
    # help), and for fetching when data won't have come from the same
3083
 
    # compressor.
3084
 
    pack_compresses = False
3085
 
    # Does the repository inventory storage understand references to trees?
3086
 
    supports_tree_reference = None
3087
 
    # Is the format experimental ?
3088
 
    experimental = False
3089
2293
 
3090
 
    def __repr__(self):
3091
 
        return "%s()" % self.__class__.__name__
 
2294
    def __str__(self):
 
2295
        return "<%s>" % self.__class__.__name__
3092
2296
 
3093
2297
    def __eq__(self, other):
3094
2298
        # format objects are generally stateless
3107
2311
        """
3108
2312
        try:
3109
2313
            transport = a_bzrdir.get_repository_transport(None)
3110
 
            format_string = transport.get_bytes("format")
 
2314
            format_string = transport.get("format").read()
3111
2315
            return format_registry.get(format_string)
3112
2316
        except errors.NoSuchFile:
3113
2317
            raise errors.NoRepositoryPresent(a_bzrdir)
3195
2399
        raise NotImplementedError(self.network_name)
3196
2400
 
3197
2401
    def check_conversion_target(self, target_format):
3198
 
        if self.rich_root_data and not target_format.rich_root_data:
3199
 
            raise errors.BadConversionTarget(
3200
 
                'Does not support rich root data.', target_format,
3201
 
                from_format=self)
3202
 
        if (self.supports_tree_reference and 
3203
 
            not getattr(target_format, 'supports_tree_reference', False)):
3204
 
            raise errors.BadConversionTarget(
3205
 
                'Does not support nested trees', target_format,
3206
 
                from_format=self)
 
2402
        raise NotImplementedError(self.check_conversion_target)
3207
2403
 
3208
2404
    def open(self, a_bzrdir, _found=False):
3209
2405
        """Return an instance of this format for the bzrdir a_bzrdir.
3212
2408
        """
3213
2409
        raise NotImplementedError(self.open)
3214
2410
 
3215
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3216
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3217
 
        hooks = BzrDir.hooks['post_repo_init']
3218
 
        if not hooks:
3219
 
            return
3220
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3221
 
        for hook in hooks:
3222
 
            hook(params)
3223
 
 
3224
2411
 
3225
2412
class MetaDirRepositoryFormat(RepositoryFormat):
3226
2413
    """Common base class for the new repositories using the metadir layout."""
3274
2461
# Pre-0.8 formats that don't have a disk format string (because they are
3275
2462
# versioned by the matching control directory). We use the control directories
3276
2463
# disk format string as a key for the network_name because they meet the
3277
 
# constraints (simple string, unique, immutable).
 
2464
# constraints (simple string, unique, immmutable).
3278
2465
network_format_registry.register_lazy(
3279
2466
    "Bazaar-NG branch, format 5\n",
3280
2467
    'bzrlib.repofmt.weaverepo',
3361
2548
    )
3362
2549
 
3363
2550
# Development formats.
3364
 
# Obsolete but kept pending a CHK based subtree format.
 
2551
# 1.7->1.8 go below here
 
2552
format_registry.register_lazy(
 
2553
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2554
    'bzrlib.repofmt.pack_repo',
 
2555
    'RepositoryFormatPackDevelopment2',
 
2556
    )
3365
2557
format_registry.register_lazy(
3366
2558
    ("Bazaar development format 2 with subtree support "
3367
2559
        "(needs bzr.dev from before 1.8)\n"),
3369
2561
    'RepositoryFormatPackDevelopment2Subtree',
3370
2562
    )
3371
2563
 
3372
 
# 1.14->1.16 go below here
3373
 
format_registry.register_lazy(
3374
 
    'Bazaar development format - group compression and chk inventory'
3375
 
        ' (needs bzr.dev from 1.14)\n',
3376
 
    'bzrlib.repofmt.groupcompress_repo',
3377
 
    'RepositoryFormatCHK1',
3378
 
    )
3379
 
 
3380
 
format_registry.register_lazy(
3381
 
    'Bazaar development format - chk repository with bencode revision '
3382
 
        'serialization (needs bzr.dev from 1.16)\n',
3383
 
    'bzrlib.repofmt.groupcompress_repo',
3384
 
    'RepositoryFormatCHK2',
3385
 
    )
3386
 
format_registry.register_lazy(
3387
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3388
 
    'bzrlib.repofmt.groupcompress_repo',
3389
 
    'RepositoryFormat2a',
3390
 
    )
3391
 
 
3392
2564
 
3393
2565
class InterRepository(InterObject):
3394
2566
    """This class represents operations taking place between two repositories.
3402
2574
    InterRepository.get(other).method_name(parameters).
3403
2575
    """
3404
2576
 
3405
 
    _walk_to_common_revisions_batch_size = 50
 
2577
    _walk_to_common_revisions_batch_size = 1
3406
2578
    _optimisers = []
3407
2579
    """The available optimised InterRepository types."""
3408
2580
 
3409
 
    @needs_write_lock
 
2581
    def __init__(self, source, target):
 
2582
        InterObject.__init__(self, source, target)
 
2583
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2584
        # provide a faster implementation.
 
2585
        self.target_get_graph = self.target.get_graph
 
2586
        self.target_get_parent_map = self.target.get_parent_map
 
2587
 
3410
2588
    def copy_content(self, revision_id=None):
3411
 
        """Make a complete copy of the content in self into destination.
3412
 
 
3413
 
        This is a destructive operation! Do not use it on existing
3414
 
        repositories.
3415
 
 
3416
 
        :param revision_id: Only copy the content needed to construct
3417
 
                            revision_id and its parents.
3418
 
        """
3419
 
        try:
3420
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3421
 
        except NotImplementedError:
3422
 
            pass
3423
 
        self.target.fetch(self.source, revision_id=revision_id)
3424
 
 
3425
 
    @needs_write_lock
3426
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3427
 
            fetch_spec=None):
 
2589
        raise NotImplementedError(self.copy_content)
 
2590
 
 
2591
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3428
2592
        """Fetch the content required to construct revision_id.
3429
2593
 
3430
2594
        The content is copied from self.source to self.target.
3431
2595
 
3432
2596
        :param revision_id: if None all content is copied, if NULL_REVISION no
3433
2597
                            content is copied.
3434
 
        :param pb: ignored.
3435
 
        :return: None.
 
2598
        :param pb: optional progress bar to use for progress reports. If not
 
2599
                   provided a default one will be created.
 
2600
 
 
2601
        :returns: (copied_revision_count, failures).
3436
2602
        """
3437
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3438
 
        from bzrlib.fetch import RepoFetcher
3439
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3440
 
        if self.source._format.network_name() != self.target._format.network_name():
3441
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3442
 
                from_format=self.source._format,
3443
 
                to_format=self.target._format)
3444
 
        f = RepoFetcher(to_repository=self.target,
3445
 
                               from_repository=self.source,
3446
 
                               last_revision=revision_id,
3447
 
                               fetch_spec=fetch_spec,
3448
 
                               find_ghosts=find_ghosts)
 
2603
        # Normally we should find a specific InterRepository subclass to do
 
2604
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2605
        # If none of them is suitable it looks like fetching is not possible;
 
2606
        # we try to give a good message why.  _assert_same_model will probably
 
2607
        # give a helpful message; otherwise a generic one.
 
2608
        self._assert_same_model(self.source, self.target)
 
2609
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2610
            "no suitableInterRepository found")
3449
2611
 
3450
2612
    def _walk_to_common_revisions(self, revision_ids):
3451
2613
        """Walk out from revision_ids in source to revisions target has.
3453
2615
        :param revision_ids: The start point for the search.
3454
2616
        :return: A set of revision ids.
3455
2617
        """
3456
 
        target_graph = self.target.get_graph()
 
2618
        target_graph = self.target_get_graph()
3457
2619
        revision_ids = frozenset(revision_ids)
 
2620
        # Fast path for the case where all the revisions are already in the
 
2621
        # target repo.
 
2622
        # (Although this does incur an extra round trip for the
 
2623
        # fairly common case where the target doesn't already have the revision
 
2624
        # we're pushing.)
 
2625
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2626
            return graph.SearchResult(revision_ids, set(), 0, set())
3458
2627
        missing_revs = set()
3459
2628
        source_graph = self.source.get_graph()
3460
2629
        # ensure we don't pay silly lookup costs.
3499
2668
                break
3500
2669
        return searcher.get_result()
3501
2670
 
 
2671
    @deprecated_method(one_two)
 
2672
    @needs_read_lock
 
2673
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2674
        """Return the revision ids that source has that target does not.
 
2675
 
 
2676
        These are returned in topological order.
 
2677
 
 
2678
        :param revision_id: only return revision ids included by this
 
2679
                            revision_id.
 
2680
        :param find_ghosts: If True find missing revisions in deep history
 
2681
            rather than just finding the surface difference.
 
2682
        """
 
2683
        return list(self.search_missing_revision_ids(
 
2684
            revision_id, find_ghosts).get_keys())
 
2685
 
3502
2686
    @needs_read_lock
3503
2687
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3504
2688
        """Return the revision ids that source has that target does not.
3569
2753
    def is_compatible(source, target):
3570
2754
        return InterRepository._same_model(source, target)
3571
2755
 
 
2756
    @needs_write_lock
 
2757
    def copy_content(self, revision_id=None):
 
2758
        """Make a complete copy of the content in self into destination.
 
2759
 
 
2760
        This copies both the repository's revision data, and configuration information
 
2761
        such as the make_working_trees setting.
 
2762
 
 
2763
        This is a destructive operation! Do not use it on existing
 
2764
        repositories.
 
2765
 
 
2766
        :param revision_id: Only copy the content needed to construct
 
2767
                            revision_id and its parents.
 
2768
        """
 
2769
        try:
 
2770
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2771
        except NotImplementedError:
 
2772
            pass
 
2773
        # but don't bother fetching if we have the needed data now.
 
2774
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and
 
2775
            self.target.has_revision(revision_id)):
 
2776
            return
 
2777
        self.target.fetch(self.source, revision_id=revision_id)
 
2778
 
 
2779
    @needs_write_lock
 
2780
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2781
        """See InterRepository.fetch()."""
 
2782
        from bzrlib.fetch import RepoFetcher
 
2783
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2784
               self.source, self.source._format, self.target,
 
2785
               self.target._format)
 
2786
        f = RepoFetcher(to_repository=self.target,
 
2787
                               from_repository=self.source,
 
2788
                               last_revision=revision_id,
 
2789
                               pb=pb, find_ghosts=find_ghosts)
 
2790
        return f.count_copied, f.failed_revisions
 
2791
 
3572
2792
 
3573
2793
class InterWeaveRepo(InterSameDataRepository):
3574
2794
    """Optimised code paths between Weave based repositories.
3620
2840
                self.target.texts.insert_record_stream(
3621
2841
                    self.source.texts.get_record_stream(
3622
2842
                        self.source.texts.keys(), 'topological', False))
3623
 
                pb.update('Copying inventory', 0, 1)
 
2843
                pb.update('copying inventory', 0, 1)
3624
2844
                self.target.inventories.insert_record_stream(
3625
2845
                    self.source.inventories.get_record_stream(
3626
2846
                        self.source.inventories.keys(), 'topological', False))
3637
2857
        else:
3638
2858
            self.target.fetch(self.source, revision_id=revision_id)
3639
2859
 
 
2860
    @needs_write_lock
 
2861
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2862
        """See InterRepository.fetch()."""
 
2863
        from bzrlib.fetch import RepoFetcher
 
2864
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2865
               self.source, self.source._format, self.target, self.target._format)
 
2866
        f = RepoFetcher(to_repository=self.target,
 
2867
                               from_repository=self.source,
 
2868
                               last_revision=revision_id,
 
2869
                               pb=pb, find_ghosts=find_ghosts)
 
2870
        return f.count_copied, f.failed_revisions
 
2871
 
3640
2872
    @needs_read_lock
3641
2873
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3642
2874
        """See InterRepository.missing_revision_ids()."""
3647
2879
        # so the first thing is to get a subset of the revisions to
3648
2880
        # satisfy revision_id in source, and then eliminate those that
3649
2881
        # we do already have.
3650
 
        # this is slow on high latency connection to self, but as this
 
2882
        # this is slow on high latency connection to self, but as as this
3651
2883
        # disk format scales terribly for push anyway due to rewriting
3652
2884
        # inventory.weave, this is considered acceptable.
3653
2885
        # - RBC 20060209
3706
2938
            return False
3707
2939
        return are_knits and InterRepository._same_model(source, target)
3708
2940
 
 
2941
    @needs_write_lock
 
2942
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2943
        """See InterRepository.fetch()."""
 
2944
        from bzrlib.fetch import RepoFetcher
 
2945
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2946
               self.source, self.source._format, self.target, self.target._format)
 
2947
        f = RepoFetcher(to_repository=self.target,
 
2948
                            from_repository=self.source,
 
2949
                            last_revision=revision_id,
 
2950
                            pb=pb, find_ghosts=find_ghosts)
 
2951
        return f.count_copied, f.failed_revisions
 
2952
 
3709
2953
    @needs_read_lock
3710
2954
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3711
2955
        """See InterRepository.missing_revision_ids()."""
3740
2984
        return self.source.revision_ids_to_search_result(result_set)
3741
2985
 
3742
2986
 
3743
 
class InterDifferingSerializer(InterRepository):
 
2987
class InterPackRepo(InterSameDataRepository):
 
2988
    """Optimised code paths between Pack based repositories."""
 
2989
 
 
2990
    @classmethod
 
2991
    def _get_repo_format_to_test(self):
 
2992
        from bzrlib.repofmt import pack_repo
 
2993
        return pack_repo.RepositoryFormatKnitPack1()
 
2994
 
 
2995
    @staticmethod
 
2996
    def is_compatible(source, target):
 
2997
        """Be compatible with known Pack formats.
 
2998
 
 
2999
        We don't test for the stores being of specific types because that
 
3000
        could lead to confusing results, and there is no need to be
 
3001
        overly general.
 
3002
        """
 
3003
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3004
        try:
 
3005
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3006
                isinstance(target._format, RepositoryFormatPack))
 
3007
        except AttributeError:
 
3008
            return False
 
3009
        return are_packs and InterRepository._same_model(source, target)
 
3010
 
 
3011
    @needs_write_lock
 
3012
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3013
        """See InterRepository.fetch()."""
 
3014
        if (len(self.source._fallback_repositories) > 0 or
 
3015
            len(self.target._fallback_repositories) > 0):
 
3016
            # The pack layer is not aware of fallback repositories, so when
 
3017
            # fetching from a stacked repository or into a stacked repository
 
3018
            # we use the generic fetch logic which uses the VersionedFiles
 
3019
            # attributes on repository.
 
3020
            from bzrlib.fetch import RepoFetcher
 
3021
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3022
                                  pb, find_ghosts)
 
3023
            return fetcher.count_copied, fetcher.failed_revisions
 
3024
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
3025
               self.source, self.source._format, self.target, self.target._format)
 
3026
        self.count_copied = 0
 
3027
        if revision_id is None:
 
3028
            # TODO:
 
3029
            # everything to do - use pack logic
 
3030
            # to fetch from all packs to one without
 
3031
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3032
            # till then:
 
3033
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3034
            revision_ids = source_revision_ids - \
 
3035
                frozenset(self.target_get_parent_map(source_revision_ids))
 
3036
            revision_keys = [(revid,) for revid in revision_ids]
 
3037
            target_pack_collection = self._get_target_pack_collection()
 
3038
            index = target_pack_collection.revision_index.combined_index
 
3039
            present_revision_ids = set(item[1][0] for item in
 
3040
                index.iter_entries(revision_keys))
 
3041
            revision_ids = set(revision_ids) - present_revision_ids
 
3042
            # implementing the TODO will involve:
 
3043
            # - detecting when all of a pack is selected
 
3044
            # - avoiding as much as possible pre-selection, so the
 
3045
            # more-core routines such as create_pack_from_packs can filter in
 
3046
            # a just-in-time fashion. (though having a HEADS list on a
 
3047
            # repository might make this a lot easier, because we could
 
3048
            # sensibly detect 'new revisions' without doing a full index scan.
 
3049
        elif _mod_revision.is_null(revision_id):
 
3050
            # nothing to do:
 
3051
            return (0, [])
 
3052
        else:
 
3053
            try:
 
3054
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3055
                    find_ghosts=find_ghosts).get_keys()
 
3056
            except errors.NoSuchRevision:
 
3057
                raise errors.InstallFailed([revision_id])
 
3058
            if len(revision_ids) == 0:
 
3059
                return (0, [])
 
3060
        return self._pack(self.source, self.target, revision_ids)
 
3061
 
 
3062
    def _pack(self, source, target, revision_ids):
 
3063
        from bzrlib.repofmt.pack_repo import Packer
 
3064
        target_pack_collection = self._get_target_pack_collection()
 
3065
        packs = source._pack_collection.all_packs()
 
3066
        pack = Packer(target_pack_collection, packs, '.fetch',
 
3067
            revision_ids).pack()
 
3068
        if pack is not None:
 
3069
            target_pack_collection._save_pack_names()
 
3070
            copied_revs = pack.get_revision_count()
 
3071
            # Trigger an autopack. This may duplicate effort as we've just done
 
3072
            # a pack creation, but for now it is simpler to think about as
 
3073
            # 'upload data, then repack if needed'.
 
3074
            self._autopack()
 
3075
            return (copied_revs, [])
 
3076
        else:
 
3077
            return (0, [])
 
3078
 
 
3079
    def _autopack(self):
 
3080
        self.target._pack_collection.autopack()
 
3081
 
 
3082
    def _get_target_pack_collection(self):
 
3083
        return self.target._pack_collection
 
3084
 
 
3085
    @needs_read_lock
 
3086
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3087
        """See InterRepository.missing_revision_ids().
 
3088
 
 
3089
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3090
            revision_id.
 
3091
        """
 
3092
        if not find_ghosts and revision_id is not None:
 
3093
            return self._walk_to_common_revisions([revision_id])
 
3094
        elif revision_id is not None:
 
3095
            # Find ghosts: search for revisions pointing from one repository to
 
3096
            # the other, and vice versa, anywhere in the history of revision_id.
 
3097
            graph = self.target_get_graph(other_repository=self.source)
 
3098
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3099
            found_ids = set()
 
3100
            while True:
 
3101
                try:
 
3102
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3103
                except StopIteration:
 
3104
                    break
 
3105
                if revision_id in ghosts:
 
3106
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3107
                found_ids.update(next_revs)
 
3108
                found_ids.update(ghosts)
 
3109
            found_ids = frozenset(found_ids)
 
3110
            # Double query here: should be able to avoid this by changing the
 
3111
            # graph api further.
 
3112
            result_set = found_ids - frozenset(
 
3113
                self.target_get_parent_map(found_ids))
 
3114
        else:
 
3115
            source_ids = self.source.all_revision_ids()
 
3116
            # source_ids is the worst possible case we may need to pull.
 
3117
            # now we want to filter source_ids against what we actually
 
3118
            # have in target, but don't try to check for existence where we know
 
3119
            # we do not have a revision as that would be pointless.
 
3120
            target_ids = set(self.target.all_revision_ids())
 
3121
            result_set = set(source_ids).difference(target_ids)
 
3122
        return self.source.revision_ids_to_search_result(result_set)
 
3123
 
 
3124
 
 
3125
class InterModel1and2(InterRepository):
 
3126
 
 
3127
    @classmethod
 
3128
    def _get_repo_format_to_test(self):
 
3129
        return None
 
3130
 
 
3131
    @staticmethod
 
3132
    def is_compatible(source, target):
 
3133
        if not source.supports_rich_root() and target.supports_rich_root():
 
3134
            return True
 
3135
        else:
 
3136
            return False
 
3137
 
 
3138
    @needs_write_lock
 
3139
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3140
        """See InterRepository.fetch()."""
 
3141
        from bzrlib.fetch import Model1toKnit2Fetcher
 
3142
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
3143
                                 from_repository=self.source,
 
3144
                                 last_revision=revision_id,
 
3145
                                 pb=pb, find_ghosts=find_ghosts)
 
3146
        return f.count_copied, f.failed_revisions
 
3147
 
 
3148
    @needs_write_lock
 
3149
    def copy_content(self, revision_id=None):
 
3150
        """Make a complete copy of the content in self into destination.
 
3151
 
 
3152
        This is a destructive operation! Do not use it on existing
 
3153
        repositories.
 
3154
 
 
3155
        :param revision_id: Only copy the content needed to construct
 
3156
                            revision_id and its parents.
 
3157
        """
 
3158
        try:
 
3159
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3160
        except NotImplementedError:
 
3161
            pass
 
3162
        # but don't bother fetching if we have the needed data now.
 
3163
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and
 
3164
            self.target.has_revision(revision_id)):
 
3165
            return
 
3166
        self.target.fetch(self.source, revision_id=revision_id)
 
3167
 
 
3168
 
 
3169
class InterKnit1and2(InterKnitRepo):
 
3170
 
 
3171
    @classmethod
 
3172
    def _get_repo_format_to_test(self):
 
3173
        return None
 
3174
 
 
3175
    @staticmethod
 
3176
    def is_compatible(source, target):
 
3177
        """Be compatible with Knit1 source and Knit3 target"""
 
3178
        try:
 
3179
            from bzrlib.repofmt.knitrepo import (
 
3180
                RepositoryFormatKnit1,
 
3181
                RepositoryFormatKnit3,
 
3182
                )
 
3183
            from bzrlib.repofmt.pack_repo import (
 
3184
                RepositoryFormatKnitPack1,
 
3185
                RepositoryFormatKnitPack3,
 
3186
                RepositoryFormatKnitPack4,
 
3187
                RepositoryFormatKnitPack5,
 
3188
                RepositoryFormatKnitPack5RichRoot,
 
3189
                RepositoryFormatKnitPack6,
 
3190
                RepositoryFormatKnitPack6RichRoot,
 
3191
                RepositoryFormatPackDevelopment2,
 
3192
                RepositoryFormatPackDevelopment2Subtree,
 
3193
                )
 
3194
            norichroot = (
 
3195
                RepositoryFormatKnit1,            # no rr, no subtree
 
3196
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
3197
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
3198
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
3199
                RepositoryFormatKnitPack6,        # no rr, no subtree
 
3200
                )
 
3201
            richroot = (
 
3202
                RepositoryFormatKnit3,            # rr, subtree
 
3203
                RepositoryFormatKnitPack3,        # rr, subtree
 
3204
                RepositoryFormatKnitPack4,        # rr, no subtree
 
3205
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
3206
                RepositoryFormatKnitPack6RichRoot,# rr, no subtree
 
3207
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
3208
                )
 
3209
            for format in norichroot:
 
3210
                if format.rich_root_data:
 
3211
                    raise AssertionError('Format %s is a rich-root format'
 
3212
                        ' but is included in the non-rich-root list'
 
3213
                        % (format,))
 
3214
            for format in richroot:
 
3215
                if not format.rich_root_data:
 
3216
                    raise AssertionError('Format %s is not a rich-root format'
 
3217
                        ' but is included in the rich-root list'
 
3218
                        % (format,))
 
3219
            # TODO: One alternative is to just check format.rich_root_data,
 
3220
            #       instead of keeping membership lists. However, the formats
 
3221
            #       *also* have to use the same 'Knit' style of storage
 
3222
            #       (line-deltas, fulltexts, etc.)
 
3223
            return (isinstance(source._format, norichroot) and
 
3224
                    isinstance(target._format, richroot))
 
3225
        except AttributeError:
 
3226
            return False
 
3227
 
 
3228
    @needs_write_lock
 
3229
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3230
        """See InterRepository.fetch()."""
 
3231
        from bzrlib.fetch import Knit1to2Fetcher
 
3232
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
3233
               self.source, self.source._format, self.target,
 
3234
               self.target._format)
 
3235
        f = Knit1to2Fetcher(to_repository=self.target,
 
3236
                            from_repository=self.source,
 
3237
                            last_revision=revision_id,
 
3238
                            pb=pb, find_ghosts=find_ghosts)
 
3239
        return f.count_copied, f.failed_revisions
 
3240
 
 
3241
 
 
3242
class InterDifferingSerializer(InterKnitRepo):
3744
3243
 
3745
3244
    @classmethod
3746
3245
    def _get_repo_format_to_test(self):
3749
3248
    @staticmethod
3750
3249
    def is_compatible(source, target):
3751
3250
        """Be compatible with Knit2 source and Knit3 target"""
3752
 
        # This is redundant with format.check_conversion_target(), however that
3753
 
        # raises an exception, and we just want to say "False" as in we won't
3754
 
        # support converting between these formats.
3755
 
        if 'IDS_never' in debug.debug_flags:
3756
 
            return False
3757
 
        if source.supports_rich_root() and not target.supports_rich_root():
3758
 
            return False
3759
 
        if (source._format.supports_tree_reference
3760
 
            and not target._format.supports_tree_reference):
3761
 
            return False
3762
 
        if target._fallback_repositories and target._format.supports_chks:
3763
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3764
 
            # adds to stacked repos.
3765
 
            return False
3766
 
        if 'IDS_always' in debug.debug_flags:
3767
 
            return True
3768
 
        # Only use this code path for local source and target.  IDS does far
3769
 
        # too much IO (both bandwidth and roundtrips) over a network.
3770
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3771
 
            return False
3772
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3251
        if source.supports_rich_root() != target.supports_rich_root():
 
3252
            return False
 
3253
        # Ideally, we'd support fetching if the source had no tree references
 
3254
        # even if it supported them...
 
3255
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3256
            not getattr(target, '_format.supports_tree_reference', False)):
3773
3257
            return False
3774
3258
        return True
3775
3259
 
3776
 
    def _get_trees(self, revision_ids, cache):
3777
 
        possible_trees = []
3778
 
        for rev_id in revision_ids:
3779
 
            if rev_id in cache:
3780
 
                possible_trees.append((rev_id, cache[rev_id]))
3781
 
            else:
3782
 
                # Not cached, but inventory might be present anyway.
3783
 
                try:
3784
 
                    tree = self.source.revision_tree(rev_id)
3785
 
                except errors.NoSuchRevision:
3786
 
                    # Nope, parent is ghost.
3787
 
                    pass
3788
 
                else:
3789
 
                    cache[rev_id] = tree
3790
 
                    possible_trees.append((rev_id, tree))
3791
 
        return possible_trees
3792
 
 
3793
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3794
 
        """Get the best delta and base for this revision.
3795
 
 
3796
 
        :return: (basis_id, delta)
3797
 
        """
3798
 
        deltas = []
3799
 
        # Generate deltas against each tree, to find the shortest.
3800
 
        texts_possibly_new_in_tree = set()
3801
 
        for basis_id, basis_tree in possible_trees:
3802
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3803
 
            for old_path, new_path, file_id, new_entry in delta:
3804
 
                if new_path is None:
3805
 
                    # This file_id isn't present in the new rev, so we don't
3806
 
                    # care about it.
3807
 
                    continue
3808
 
                if not new_path:
3809
 
                    # Rich roots are handled elsewhere...
3810
 
                    continue
3811
 
                kind = new_entry.kind
3812
 
                if kind != 'directory' and kind != 'file':
3813
 
                    # No text record associated with this inventory entry.
3814
 
                    continue
3815
 
                # This is a directory or file that has changed somehow.
3816
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3817
 
            deltas.append((len(delta), basis_id, delta))
3818
 
        deltas.sort()
3819
 
        return deltas[0][1:]
3820
 
 
3821
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3822
 
        """Find all parent revisions that are absent, but for which the
3823
 
        inventory is present, and copy those inventories.
3824
 
 
3825
 
        This is necessary to preserve correctness when the source is stacked
3826
 
        without fallbacks configured.  (Note that in cases like upgrade the
3827
 
        source may be not have _fallback_repositories even though it is
3828
 
        stacked.)
3829
 
        """
3830
 
        parent_revs = set()
3831
 
        for parents in parent_map.values():
3832
 
            parent_revs.update(parents)
3833
 
        present_parents = self.source.get_parent_map(parent_revs)
3834
 
        absent_parents = set(parent_revs).difference(present_parents)
3835
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3836
 
            (rev_id,) for rev_id in absent_parents)
3837
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3838
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3839
 
            current_revision_id = parent_tree.get_revision_id()
3840
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3841
 
                (current_revision_id,)]
3842
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3843
 
            basis_id = _mod_revision.NULL_REVISION
3844
 
            basis_tree = self.source.revision_tree(basis_id)
3845
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3846
 
            self.target.add_inventory_by_delta(
3847
 
                basis_id, delta, current_revision_id, parents_parents)
3848
 
            cache[current_revision_id] = parent_tree
3849
 
 
3850
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3260
    def _fetch_batch(self, revision_ids, basis_id, basis_tree):
3851
3261
        """Fetch across a few revisions.
3852
3262
 
3853
3263
        :param revision_ids: The revisions to copy
3854
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3855
 
            as a basis for delta when no other base is available
3856
 
        :param cache: A cache of RevisionTrees that we can use.
3857
 
        :param a_graph: A Graph object to determine the heads() of the
3858
 
            rich-root data stream.
3859
 
        :return: The revision_id of the last converted tree. The RevisionTree
3860
 
            for it will be in cache
 
3264
        :param basis_id: The revision_id of basis_tree
 
3265
        :param basis_tree: A tree that is not in revision_ids which should
 
3266
            already exist in the target.
 
3267
        :return: (basis_id, basis_tree) A new basis to use now that these trees
 
3268
            have been copied.
3861
3269
        """
3862
3270
        # Walk though all revisions; get inventory deltas, copy referenced
3863
3271
        # texts that delta references, insert the delta, revision and
3864
3272
        # signature.
3865
 
        root_keys_to_create = set()
3866
3273
        text_keys = set()
3867
3274
        pending_deltas = []
3868
3275
        pending_revisions = []
3869
 
        parent_map = self.source.get_parent_map(revision_ids)
3870
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3871
 
        self.source._safe_to_return_from_cache = True
3872
3276
        for tree in self.source.revision_trees(revision_ids):
3873
 
            # Find a inventory delta for this revision.
3874
 
            # Find text entries that need to be copied, too.
3875
3277
            current_revision_id = tree.get_revision_id()
3876
 
            parent_ids = parent_map.get(current_revision_id, ())
3877
 
            parent_trees = self._get_trees(parent_ids, cache)
3878
 
            possible_trees = list(parent_trees)
3879
 
            if len(possible_trees) == 0:
3880
 
                # There either aren't any parents, or the parents are ghosts,
3881
 
                # so just use the last converted tree.
3882
 
                possible_trees.append((basis_id, cache[basis_id]))
3883
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3884
 
                                                           possible_trees)
 
3278
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3279
            for old_path, new_path, file_id, entry in delta:
 
3280
                if new_path is not None:
 
3281
                    if not (new_path or self.target.supports_rich_root()):
 
3282
                        # We leave the inventory delta in, because that
 
3283
                        # will have the deserialised inventory root
 
3284
                        # pointer.
 
3285
                        continue
 
3286
                    # TODO: Do we need:
 
3287
                    #       "if entry.revision == current_revision_id" ?
 
3288
                    if entry.revision == current_revision_id:
 
3289
                        text_keys.add((file_id, entry.revision))
3885
3290
            revision = self.source.get_revision(current_revision_id)
3886
3291
            pending_deltas.append((basis_id, delta,
3887
3292
                current_revision_id, revision.parent_ids))
3888
 
            if self._converting_to_rich_root:
3889
 
                self._revision_id_to_root_id[current_revision_id] = \
3890
 
                    tree.get_root_id()
3891
 
            # Determine which texts are in present in this revision but not in
3892
 
            # any of the available parents.
3893
 
            texts_possibly_new_in_tree = set()
3894
 
            for old_path, new_path, file_id, entry in delta:
3895
 
                if new_path is None:
3896
 
                    # This file_id isn't present in the new rev
3897
 
                    continue
3898
 
                if not new_path:
3899
 
                    # This is the root
3900
 
                    if not self.target.supports_rich_root():
3901
 
                        # The target doesn't support rich root, so we don't
3902
 
                        # copy
3903
 
                        continue
3904
 
                    if self._converting_to_rich_root:
3905
 
                        # This can't be copied normally, we have to insert
3906
 
                        # it specially
3907
 
                        root_keys_to_create.add((file_id, entry.revision))
3908
 
                        continue
3909
 
                kind = entry.kind
3910
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3911
 
            for basis_id, basis_tree in possible_trees:
3912
 
                basis_inv = basis_tree.inventory
3913
 
                for file_key in list(texts_possibly_new_in_tree):
3914
 
                    file_id, file_revision = file_key
3915
 
                    try:
3916
 
                        entry = basis_inv[file_id]
3917
 
                    except errors.NoSuchId:
3918
 
                        continue
3919
 
                    if entry.revision == file_revision:
3920
 
                        texts_possibly_new_in_tree.remove(file_key)
3921
 
            text_keys.update(texts_possibly_new_in_tree)
3922
3293
            pending_revisions.append(revision)
3923
 
            cache[current_revision_id] = tree
3924
3294
            basis_id = current_revision_id
3925
 
        self.source._safe_to_return_from_cache = False
 
3295
            basis_tree = tree
3926
3296
        # Copy file texts
3927
3297
        from_texts = self.source.texts
3928
3298
        to_texts = self.target.texts
3929
 
        if root_keys_to_create:
3930
 
            root_stream = _mod_fetch._new_root_data_stream(
3931
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3932
 
                self.source, graph=a_graph)
3933
 
            to_texts.insert_record_stream(root_stream)
3934
3299
        to_texts.insert_record_stream(from_texts.get_record_stream(
3935
 
            text_keys, self.target._format._fetch_order,
3936
 
            not self.target._format._fetch_uses_deltas))
3937
 
        # insert inventory deltas
 
3300
            text_keys, self.target._fetch_order,
 
3301
            not self.target._fetch_uses_deltas))
 
3302
        # insert deltas
3938
3303
        for delta in pending_deltas:
3939
3304
            self.target.add_inventory_by_delta(*delta)
3940
 
        if self.target._fallback_repositories:
3941
 
            # Make sure this stacked repository has all the parent inventories
3942
 
            # for the new revisions that we are about to insert.  We do this
3943
 
            # before adding the revisions so that no revision is added until
3944
 
            # all the inventories it may depend on are added.
3945
 
            # Note that this is overzealous, as we may have fetched these in an
3946
 
            # earlier batch.
3947
 
            parent_ids = set()
3948
 
            revision_ids = set()
3949
 
            for revision in pending_revisions:
3950
 
                revision_ids.add(revision.revision_id)
3951
 
                parent_ids.update(revision.parent_ids)
3952
 
            parent_ids.difference_update(revision_ids)
3953
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3954
 
            parent_map = self.source.get_parent_map(parent_ids)
3955
 
            # we iterate over parent_map and not parent_ids because we don't
3956
 
            # want to try copying any revision which is a ghost
3957
 
            for parent_tree in self.source.revision_trees(parent_map):
3958
 
                current_revision_id = parent_tree.get_revision_id()
3959
 
                parents_parents = parent_map[current_revision_id]
3960
 
                possible_trees = self._get_trees(parents_parents, cache)
3961
 
                if len(possible_trees) == 0:
3962
 
                    # There either aren't any parents, or the parents are
3963
 
                    # ghosts, so just use the last converted tree.
3964
 
                    possible_trees.append((basis_id, cache[basis_id]))
3965
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3966
 
                    parents_parents, possible_trees)
3967
 
                self.target.add_inventory_by_delta(
3968
 
                    basis_id, delta, current_revision_id, parents_parents)
3969
3305
        # insert signatures and revisions
3970
3306
        for revision in pending_revisions:
3971
3307
            try:
3976
3312
            except errors.NoSuchRevision:
3977
3313
                pass
3978
3314
            self.target.add_revision(revision.revision_id, revision)
3979
 
        return basis_id
 
3315
        return basis_id, basis_tree
3980
3316
 
3981
3317
    def _fetch_all_revisions(self, revision_ids, pb):
3982
3318
        """Fetch everything for the list of revisions.
3983
3319
 
3984
3320
        :param revision_ids: The list of revisions to fetch. Must be in
3985
3321
            topological order.
3986
 
        :param pb: A ProgressTask
 
3322
        :param pb: A ProgressBar
3987
3323
        :return: None
3988
3324
        """
3989
3325
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3990
3326
        batch_size = 100
3991
 
        cache = lru_cache.LRUCache(100)
3992
 
        cache[basis_id] = basis_tree
3993
 
        del basis_tree # We don't want to hang on to it here
3994
 
        hints = []
3995
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3996
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3997
 
                                                            revision_ids)
3998
 
        else:
3999
 
            a_graph = None
4000
 
 
4001
3327
        for offset in range(0, len(revision_ids), batch_size):
4002
3328
            self.target.start_write_group()
4003
3329
            try:
4004
3330
                pb.update('Transferring revisions', offset,
4005
3331
                          len(revision_ids))
4006
3332
                batch = revision_ids[offset:offset+batch_size]
4007
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4008
 
                                             a_graph=a_graph)
 
3333
                basis_id, basis_tree = self._fetch_batch(batch,
 
3334
                    basis_id, basis_tree)
4009
3335
            except:
4010
 
                self.source._safe_to_return_from_cache = False
4011
3336
                self.target.abort_write_group()
4012
3337
                raise
4013
3338
            else:
4014
 
                hint = self.target.commit_write_group()
4015
 
                if hint:
4016
 
                    hints.extend(hint)
4017
 
        if hints and self.target._format.pack_compresses:
4018
 
            self.target.pack(hint=hints)
 
3339
                self.target.commit_write_group()
4019
3340
        pb.update('Transferring revisions', len(revision_ids),
4020
3341
                  len(revision_ids))
4021
3342
 
4022
3343
    @needs_write_lock
4023
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
4024
 
            fetch_spec=None):
 
3344
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
4025
3345
        """See InterRepository.fetch()."""
4026
 
        if fetch_spec is not None:
4027
 
            raise AssertionError("Not implemented yet...")
4028
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4029
 
        if (not self.source.supports_rich_root()
4030
 
            and self.target.supports_rich_root()):
4031
 
            self._converting_to_rich_root = True
4032
 
            self._revision_id_to_root_id = {}
4033
 
        else:
4034
 
            self._converting_to_rich_root = False
4035
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4036
 
        if self.source._format.network_name() != self.target._format.network_name():
4037
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4038
 
                from_format=self.source._format,
4039
 
                to_format=self.target._format)
4040
3346
        revision_ids = self.target.search_missing_revision_ids(self.source,
4041
3347
            revision_id, find_ghosts=find_ghosts).get_keys()
4042
3348
        if not revision_ids:
4043
3349
            return 0, 0
4044
3350
        revision_ids = tsort.topo_sort(
4045
3351
            self.source.get_graph().get_parent_map(revision_ids))
4046
 
        if not revision_ids:
4047
 
            return 0, 0
4048
 
        # Walk though all revisions; get inventory deltas, copy referenced
4049
 
        # texts that delta references, insert the delta, revision and
4050
 
        # signature.
4051
3352
        if pb is None:
4052
3353
            my_pb = ui.ui_factory.nested_progress_bar()
4053
3354
            pb = my_pb
4054
3355
        else:
4055
 
            symbol_versioning.warn(
4056
 
                symbol_versioning.deprecated_in((1, 14, 0))
4057
 
                % "pb parameter to fetch()")
4058
3356
            my_pb = None
4059
3357
        try:
4060
3358
            self._fetch_all_revisions(revision_ids, pb)
4086
3384
        return basis_id, basis_tree
4087
3385
 
4088
3386
 
 
3387
class InterOtherToRemote(InterRepository):
 
3388
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3389
    calculated for (source, target._real_repository).
 
3390
    """
 
3391
 
 
3392
    _walk_to_common_revisions_batch_size = 50
 
3393
 
 
3394
    def __init__(self, source, target):
 
3395
        InterRepository.__init__(self, source, target)
 
3396
        self._real_inter = None
 
3397
 
 
3398
    @staticmethod
 
3399
    def is_compatible(source, target):
 
3400
        if isinstance(target, remote.RemoteRepository):
 
3401
            return True
 
3402
        return False
 
3403
 
 
3404
    def _ensure_real_inter(self):
 
3405
        if self._real_inter is None:
 
3406
            self.target._ensure_real()
 
3407
            real_target = self.target._real_repository
 
3408
            self._real_inter = InterRepository.get(self.source, real_target)
 
3409
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3410
            self._real_inter.target_get_graph = self.target.get_graph
 
3411
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3412
 
 
3413
    def copy_content(self, revision_id=None):
 
3414
        self._ensure_real_inter()
 
3415
        self._real_inter.copy_content(revision_id=revision_id)
 
3416
 
 
3417
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3418
        self._ensure_real_inter()
 
3419
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3420
            find_ghosts=find_ghosts)
 
3421
 
 
3422
    @classmethod
 
3423
    def _get_repo_format_to_test(self):
 
3424
        return None
 
3425
 
 
3426
 
 
3427
class InterRemoteToOther(InterRepository):
 
3428
 
 
3429
    def __init__(self, source, target):
 
3430
        InterRepository.__init__(self, source, target)
 
3431
        self._real_inter = None
 
3432
 
 
3433
    @staticmethod
 
3434
    def is_compatible(source, target):
 
3435
        if not isinstance(source, remote.RemoteRepository):
 
3436
            return False
 
3437
        # Is source's model compatible with target's model?
 
3438
        source._ensure_real()
 
3439
        real_source = source._real_repository
 
3440
        if isinstance(real_source, remote.RemoteRepository):
 
3441
            raise NotImplementedError(
 
3442
                "We don't support remote repos backed by remote repos yet.")
 
3443
        return InterRepository._same_model(real_source, target)
 
3444
 
 
3445
    def _ensure_real_inter(self):
 
3446
        if self._real_inter is None:
 
3447
            self.source._ensure_real()
 
3448
            real_source = self.source._real_repository
 
3449
            self._real_inter = InterRepository.get(real_source, self.target)
 
3450
 
 
3451
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3452
        self._ensure_real_inter()
 
3453
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3454
            find_ghosts=find_ghosts)
 
3455
 
 
3456
    def copy_content(self, revision_id=None):
 
3457
        self._ensure_real_inter()
 
3458
        self._real_inter.copy_content(revision_id=revision_id)
 
3459
 
 
3460
    @classmethod
 
3461
    def _get_repo_format_to_test(self):
 
3462
        return None
 
3463
 
 
3464
 
 
3465
 
 
3466
class InterPackToRemotePack(InterPackRepo):
 
3467
    """A specialisation of InterPackRepo for a target that is a
 
3468
    RemoteRepository.
 
3469
 
 
3470
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3471
    uses an RPC for autopacking.
 
3472
    """
 
3473
 
 
3474
    _walk_to_common_revisions_batch_size = 50
 
3475
 
 
3476
    @staticmethod
 
3477
    def is_compatible(source, target):
 
3478
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3479
        if isinstance(source._format, RepositoryFormatPack):
 
3480
            if isinstance(target, remote.RemoteRepository):
 
3481
                target._ensure_real()
 
3482
                if isinstance(target._real_repository._format,
 
3483
                              RepositoryFormatPack):
 
3484
                    if InterRepository._same_model(source, target):
 
3485
                        return True
 
3486
        return False
 
3487
 
 
3488
    def _autopack(self):
 
3489
        self.target.autopack()
 
3490
 
 
3491
    @needs_write_lock
 
3492
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3493
        """See InterRepository.fetch()."""
 
3494
        # Always fetch using the generic streaming fetch code, to allow
 
3495
        # streaming fetching into remote servers.
 
3496
        from bzrlib.fetch import RepoFetcher
 
3497
        fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3498
                              pb, find_ghosts)
 
3499
        return fetcher.count_copied, fetcher.failed_revisions
 
3500
 
 
3501
    def _get_target_pack_collection(self):
 
3502
        return self.target._real_repository._pack_collection
 
3503
 
 
3504
    @classmethod
 
3505
    def _get_repo_format_to_test(self):
 
3506
        return None
 
3507
 
 
3508
 
4089
3509
InterRepository.register_optimiser(InterDifferingSerializer)
4090
3510
InterRepository.register_optimiser(InterSameDataRepository)
4091
3511
InterRepository.register_optimiser(InterWeaveRepo)
4092
3512
InterRepository.register_optimiser(InterKnitRepo)
 
3513
InterRepository.register_optimiser(InterModel1and2)
 
3514
InterRepository.register_optimiser(InterKnit1and2)
 
3515
InterRepository.register_optimiser(InterPackRepo)
 
3516
InterRepository.register_optimiser(InterOtherToRemote)
 
3517
InterRepository.register_optimiser(InterRemoteToOther)
 
3518
InterRepository.register_optimiser(InterPackToRemotePack)
4093
3519
 
4094
3520
 
4095
3521
class CopyConverter(object):
4111
3537
        :param to_convert: The disk object to convert.
4112
3538
        :param pb: a progress bar to use for progress information.
4113
3539
        """
4114
 
        pb = ui.ui_factory.nested_progress_bar()
 
3540
        self.pb = pb
4115
3541
        self.count = 0
4116
3542
        self.total = 4
4117
3543
        # this is only useful with metadir layouts - separated repo content.
4118
3544
        # trigger an assertion if not such
4119
3545
        repo._format.get_format_string()
4120
3546
        self.repo_dir = repo.bzrdir
4121
 
        pb.update('Moving repository to repository.backup')
 
3547
        self.step('Moving repository to repository.backup')
4122
3548
        self.repo_dir.transport.move('repository', 'repository.backup')
4123
3549
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4124
3550
        repo._format.check_conversion_target(self.target_format)
4125
3551
        self.source_repo = repo._format.open(self.repo_dir,
4126
3552
            _found=True,
4127
3553
            _override_transport=backup_transport)
4128
 
        pb.update('Creating new repository')
 
3554
        self.step('Creating new repository')
4129
3555
        converted = self.target_format.initialize(self.repo_dir,
4130
3556
                                                  self.source_repo.is_shared())
4131
3557
        converted.lock_write()
4132
3558
        try:
4133
 
            pb.update('Copying content')
 
3559
            self.step('Copying content into repository.')
4134
3560
            self.source_repo.copy_content_into(converted)
4135
3561
        finally:
4136
3562
            converted.unlock()
4137
 
        pb.update('Deleting old repository content')
 
3563
        self.step('Deleting old repository content.')
4138
3564
        self.repo_dir.transport.delete_tree('repository.backup')
4139
 
        ui.ui_factory.note('repository converted')
4140
 
        pb.finished()
 
3565
        self.pb.note('repository converted')
 
3566
 
 
3567
    def step(self, message):
 
3568
        """Update the pb by a step."""
 
3569
        self.count +=1
 
3570
        self.pb.update(message, self.count, self.total)
4141
3571
 
4142
3572
 
4143
3573
_unescape_map = {
4172
3602
 
4173
3603
class _VersionedFileChecker(object):
4174
3604
 
4175
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3605
    def __init__(self, repository):
4176
3606
        self.repository = repository
4177
 
        self.text_index = self.repository._generate_text_key_index(
4178
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3607
        self.text_index = self.repository._generate_text_key_index()
4179
3608
 
4180
3609
    def calculate_file_version_parents(self, text_key):
4181
3610
        """Calculate the correct parents for a file version according to
4199
3628
            revision_id) tuples for versions that are present in this versioned
4200
3629
            file, but not used by the corresponding inventory.
4201
3630
        """
4202
 
        local_progress = None
4203
 
        if progress_bar is None:
4204
 
            local_progress = ui.ui_factory.nested_progress_bar()
4205
 
            progress_bar = local_progress
4206
 
        try:
4207
 
            return self._check_file_version_parents(texts, progress_bar)
4208
 
        finally:
4209
 
            if local_progress:
4210
 
                local_progress.finished()
4211
 
 
4212
 
    def _check_file_version_parents(self, texts, progress_bar):
4213
 
        """See check_file_version_parents."""
4214
3631
        wrong_parents = {}
4215
3632
        self.file_ids = set([file_id for file_id, _ in
4216
3633
            self.text_index.iterkeys()])
4217
3634
        # text keys is now grouped by file_id
 
3635
        n_weaves = len(self.file_ids)
 
3636
        files_in_revisions = {}
 
3637
        revisions_of_files = {}
4218
3638
        n_versions = len(self.text_index)
4219
3639
        progress_bar.update('loading text store', 0, n_versions)
4220
3640
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4222
3642
        text_keys = self.repository.texts.keys()
4223
3643
        unused_keys = frozenset(text_keys) - set(self.text_index)
4224
3644
        for num, key in enumerate(self.text_index.iterkeys()):
4225
 
            progress_bar.update('checking text graph', num, n_versions)
 
3645
            if progress_bar is not None:
 
3646
                progress_bar.update('checking text graph', num, n_versions)
4226
3647
            correct_parents = self.calculate_file_version_parents(key)
4227
3648
            try:
4228
3649
                knit_parents = parent_map[key]
4265
3686
    def __init__(self, target_repo):
4266
3687
        self.target_repo = target_repo
4267
3688
 
4268
 
    def insert_stream(self, stream, src_format, resume_tokens):
 
3689
    def insert_stream(self, stream, src_format):
4269
3690
        """Insert a stream's content into the target repository.
4270
3691
 
4271
3692
        :param src_format: a bzr repository format.
4272
3693
 
4273
 
        :return: a list of resume tokens and an  iterable of keys additional
4274
 
            items required before the insertion can be completed.
 
3694
        :return: an iterable of keys additional items required before the
 
3695
        insertion can be completed.
4275
3696
        """
4276
 
        self.target_repo.lock_write()
4277
 
        try:
4278
 
            if resume_tokens:
4279
 
                self.target_repo.resume_write_group(resume_tokens)
4280
 
                is_resume = True
4281
 
            else:
4282
 
                self.target_repo.start_write_group()
4283
 
                is_resume = False
4284
 
            try:
4285
 
                # locked_insert_stream performs a commit|suspend.
4286
 
                return self._locked_insert_stream(stream, src_format, is_resume)
4287
 
            except:
4288
 
                self.target_repo.abort_write_group(suppress_errors=True)
4289
 
                raise
4290
 
        finally:
4291
 
            self.target_repo.unlock()
4292
 
 
4293
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3697
        result = []
4294
3698
        to_serializer = self.target_repo._format._serializer
4295
3699
        src_serializer = src_format._serializer
4296
 
        new_pack = None
4297
 
        if to_serializer == src_serializer:
4298
 
            # If serializers match and the target is a pack repository, set the
4299
 
            # write cache size on the new pack.  This avoids poor performance
4300
 
            # on transports where append is unbuffered (such as
4301
 
            # RemoteTransport).  This is safe to do because nothing should read
4302
 
            # back from the target repository while a stream with matching
4303
 
            # serialization is being inserted.
4304
 
            # The exception is that a delta record from the source that should
4305
 
            # be a fulltext may need to be expanded by the target (see
4306
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4307
 
            # explicitly flush any buffered writes first in that rare case.
4308
 
            try:
4309
 
                new_pack = self.target_repo._pack_collection._new_pack
4310
 
            except AttributeError:
4311
 
                # Not a pack repository
4312
 
                pass
4313
 
            else:
4314
 
                new_pack.set_write_cache_size(1024*1024)
4315
3700
        for substream_type, substream in stream:
4316
 
            if 'stream' in debug.debug_flags:
4317
 
                mutter('inserting substream: %s', substream_type)
4318
3701
            if substream_type == 'texts':
4319
3702
                self.target_repo.texts.insert_record_stream(substream)
4320
3703
            elif substream_type == 'inventories':
4324
3707
                else:
4325
3708
                    self._extract_and_insert_inventories(
4326
3709
                        substream, src_serializer)
4327
 
            elif substream_type == 'inventory-deltas':
4328
 
                self._extract_and_insert_inventory_deltas(
4329
 
                    substream, src_serializer)
4330
 
            elif substream_type == 'chk_bytes':
4331
 
                # XXX: This doesn't support conversions, as it assumes the
4332
 
                #      conversion was done in the fetch code.
4333
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4334
3710
            elif substream_type == 'revisions':
4335
3711
                # This may fallback to extract-and-insert more often than
4336
3712
                # required if the serializers are different only in terms of
4345
3721
                self.target_repo.signatures.insert_record_stream(substream)
4346
3722
            else:
4347
3723
                raise AssertionError('kaboom! %s' % (substream_type,))
4348
 
        # Done inserting data, and the missing_keys calculations will try to
4349
 
        # read back from the inserted data, so flush the writes to the new pack
4350
 
        # (if this is pack format).
4351
 
        if new_pack is not None:
4352
 
            new_pack._write_data('', flush=True)
4353
 
        # Find all the new revisions (including ones from resume_tokens)
4354
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4355
 
            check_for_missing_texts=is_resume)
4356
 
        try:
4357
 
            for prefix, versioned_file in (
4358
 
                ('texts', self.target_repo.texts),
4359
 
                ('inventories', self.target_repo.inventories),
4360
 
                ('revisions', self.target_repo.revisions),
4361
 
                ('signatures', self.target_repo.signatures),
4362
 
                ('chk_bytes', self.target_repo.chk_bytes),
4363
 
                ):
4364
 
                if versioned_file is None:
4365
 
                    continue
4366
 
                # TODO: key is often going to be a StaticTuple object
4367
 
                #       I don't believe we can define a method by which
4368
 
                #       (prefix,) + StaticTuple will work, though we could
4369
 
                #       define a StaticTuple.sq_concat that would allow you to
4370
 
                #       pass in either a tuple or a StaticTuple as the second
4371
 
                #       object, so instead we could have:
4372
 
                #       StaticTuple(prefix) + key here...
4373
 
                missing_keys.update((prefix,) + key for key in
4374
 
                    versioned_file.get_missing_compression_parent_keys())
4375
 
        except NotImplementedError:
4376
 
            # cannot even attempt suspending, and missing would have failed
4377
 
            # during stream insertion.
4378
 
            missing_keys = set()
4379
 
        else:
4380
 
            if missing_keys:
4381
 
                # suspend the write group and tell the caller what we is
4382
 
                # missing. We know we can suspend or else we would not have
4383
 
                # entered this code path. (All repositories that can handle
4384
 
                # missing keys can handle suspending a write group).
4385
 
                write_group_tokens = self.target_repo.suspend_write_group()
4386
 
                return write_group_tokens, missing_keys
4387
 
        hint = self.target_repo.commit_write_group()
4388
 
        if (to_serializer != src_serializer and
4389
 
            self.target_repo._format.pack_compresses):
4390
 
            self.target_repo.pack(hint=hint)
4391
 
        return [], set()
4392
 
 
4393
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4394
 
        target_rich_root = self.target_repo._format.rich_root_data
4395
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4396
 
        for record in substream:
4397
 
            # Insert the delta directly
4398
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4399
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4400
 
            try:
4401
 
                parse_result = deserialiser.parse_text_bytes(
4402
 
                    inventory_delta_bytes)
4403
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4404
 
                trace.mutter("Incompatible delta: %s", err.msg)
4405
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4406
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4407
 
            revision_id = new_id
4408
 
            parents = [key[0] for key in record.parents]
4409
 
            self.target_repo.add_inventory_by_delta(
4410
 
                basis_id, inv_delta, revision_id, parents)
4411
 
 
4412
 
    def _extract_and_insert_inventories(self, substream, serializer,
4413
 
            parse_delta=None):
 
3724
        return result
 
3725
 
 
3726
    def _extract_and_insert_inventories(self, substream, serializer):
4414
3727
        """Generate a new inventory versionedfile in target, converting data.
4415
3728
 
4416
3729
        The inventory is retrieved from the source, (deserializing it), and
4417
3730
        stored in the target (reserializing it in a different format).
4418
3731
        """
4419
 
        target_rich_root = self.target_repo._format.rich_root_data
4420
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4421
3732
        for record in substream:
4422
 
            # It's not a delta, so it must be a fulltext in the source
4423
 
            # serializer's format.
4424
3733
            bytes = record.get_bytes_as('fulltext')
4425
3734
            revision_id = record.key[0]
4426
3735
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4427
3736
            parents = [key[0] for key in record.parents]
4428
3737
            self.target_repo.add_inventory(revision_id, inv, parents)
4429
 
            # No need to keep holding this full inv in memory when the rest of
4430
 
            # the substream is likely to be all deltas.
4431
 
            del inv
4432
3738
 
4433
3739
    def _extract_and_insert_revisions(self, substream, serializer):
4434
3740
        for record in substream:
4440
3746
            self.target_repo.add_revision(revision_id, rev)
4441
3747
 
4442
3748
    def finished(self):
4443
 
        if self.target_repo._format._fetch_reconcile:
 
3749
        if self.target_repo._fetch_reconcile:
4444
3750
            self.target_repo.reconcile()
4445
3751
 
4446
 
 
4447
 
class StreamSource(object):
4448
 
    """A source of a stream for fetching between repositories."""
4449
 
 
4450
 
    def __init__(self, from_repository, to_format):
4451
 
        """Create a StreamSource streaming from from_repository."""
4452
 
        self.from_repository = from_repository
4453
 
        self.to_format = to_format
4454
 
 
4455
 
    def delta_on_metadata(self):
4456
 
        """Return True if delta's are permitted on metadata streams.
4457
 
 
4458
 
        That is on revisions and signatures.
4459
 
        """
4460
 
        src_serializer = self.from_repository._format._serializer
4461
 
        target_serializer = self.to_format._serializer
4462
 
        return (self.to_format._fetch_uses_deltas and
4463
 
            src_serializer == target_serializer)
4464
 
 
4465
 
    def _fetch_revision_texts(self, revs):
4466
 
        # fetch signatures first and then the revision texts
4467
 
        # may need to be a InterRevisionStore call here.
4468
 
        from_sf = self.from_repository.signatures
4469
 
        # A missing signature is just skipped.
4470
 
        keys = [(rev_id,) for rev_id in revs]
4471
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4472
 
            keys,
4473
 
            self.to_format._fetch_order,
4474
 
            not self.to_format._fetch_uses_deltas))
4475
 
        # If a revision has a delta, this is actually expanded inside the
4476
 
        # insert_record_stream code now, which is an alternate fix for
4477
 
        # bug #261339
4478
 
        from_rf = self.from_repository.revisions
4479
 
        revisions = from_rf.get_record_stream(
4480
 
            keys,
4481
 
            self.to_format._fetch_order,
4482
 
            not self.delta_on_metadata())
4483
 
        return [('signatures', signatures), ('revisions', revisions)]
4484
 
 
4485
 
    def _generate_root_texts(self, revs):
4486
 
        """This will be called by get_stream between fetching weave texts and
4487
 
        fetching the inventory weave.
4488
 
        """
4489
 
        if self._rich_root_upgrade():
4490
 
            return _mod_fetch.Inter1and2Helper(
4491
 
                self.from_repository).generate_root_texts(revs)
4492
 
        else:
4493
 
            return []
4494
 
 
4495
 
    def get_stream(self, search):
4496
 
        phase = 'file'
4497
 
        revs = search.get_keys()
4498
 
        graph = self.from_repository.get_graph()
4499
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4500
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4501
 
        text_keys = []
4502
 
        for knit_kind, file_id, revisions in data_to_fetch:
4503
 
            if knit_kind != phase:
4504
 
                phase = knit_kind
4505
 
                # Make a new progress bar for this phase
4506
 
            if knit_kind == "file":
4507
 
                # Accumulate file texts
4508
 
                text_keys.extend([(file_id, revision) for revision in
4509
 
                    revisions])
4510
 
            elif knit_kind == "inventory":
4511
 
                # Now copy the file texts.
4512
 
                from_texts = self.from_repository.texts
4513
 
                yield ('texts', from_texts.get_record_stream(
4514
 
                    text_keys, self.to_format._fetch_order,
4515
 
                    not self.to_format._fetch_uses_deltas))
4516
 
                # Cause an error if a text occurs after we have done the
4517
 
                # copy.
4518
 
                text_keys = None
4519
 
                # Before we process the inventory we generate the root
4520
 
                # texts (if necessary) so that the inventories references
4521
 
                # will be valid.
4522
 
                for _ in self._generate_root_texts(revs):
4523
 
                    yield _
4524
 
                # we fetch only the referenced inventories because we do not
4525
 
                # know for unselected inventories whether all their required
4526
 
                # texts are present in the other repository - it could be
4527
 
                # corrupt.
4528
 
                for info in self._get_inventory_stream(revs):
4529
 
                    yield info
4530
 
            elif knit_kind == "signatures":
4531
 
                # Nothing to do here; this will be taken care of when
4532
 
                # _fetch_revision_texts happens.
4533
 
                pass
4534
 
            elif knit_kind == "revisions":
4535
 
                for record in self._fetch_revision_texts(revs):
4536
 
                    yield record
4537
 
            else:
4538
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4539
 
 
4540
 
    def get_stream_for_missing_keys(self, missing_keys):
4541
 
        # missing keys can only occur when we are byte copying and not
4542
 
        # translating (because translation means we don't send
4543
 
        # unreconstructable deltas ever).
4544
 
        keys = {}
4545
 
        keys['texts'] = set()
4546
 
        keys['revisions'] = set()
4547
 
        keys['inventories'] = set()
4548
 
        keys['chk_bytes'] = set()
4549
 
        keys['signatures'] = set()
4550
 
        for key in missing_keys:
4551
 
            keys[key[0]].add(key[1:])
4552
 
        if len(keys['revisions']):
4553
 
            # If we allowed copying revisions at this point, we could end up
4554
 
            # copying a revision without copying its required texts: a
4555
 
            # violation of the requirements for repository integrity.
4556
 
            raise AssertionError(
4557
 
                'cannot copy revisions to fill in missing deltas %s' % (
4558
 
                    keys['revisions'],))
4559
 
        for substream_kind, keys in keys.iteritems():
4560
 
            vf = getattr(self.from_repository, substream_kind)
4561
 
            if vf is None and keys:
4562
 
                    raise AssertionError(
4563
 
                        "cannot fill in keys for a versioned file we don't"
4564
 
                        " have: %s needs %s" % (substream_kind, keys))
4565
 
            if not keys:
4566
 
                # No need to stream something we don't have
4567
 
                continue
4568
 
            if substream_kind == 'inventories':
4569
 
                # Some missing keys are genuinely ghosts, filter those out.
4570
 
                present = self.from_repository.inventories.get_parent_map(keys)
4571
 
                revs = [key[0] for key in present]
4572
 
                # Get the inventory stream more-or-less as we do for the
4573
 
                # original stream; there's no reason to assume that records
4574
 
                # direct from the source will be suitable for the sink.  (Think
4575
 
                # e.g. 2a -> 1.9-rich-root).
4576
 
                for info in self._get_inventory_stream(revs, missing=True):
4577
 
                    yield info
4578
 
                continue
4579
 
 
4580
 
            # Ask for full texts always so that we don't need more round trips
4581
 
            # after this stream.
4582
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4583
 
            # records. The Sink is responsible for doing another check to
4584
 
            # ensure that ghosts don't introduce missing data for future
4585
 
            # fetches.
4586
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4587
 
                self.to_format._fetch_order, True))
4588
 
            yield substream_kind, stream
4589
 
 
4590
 
    def inventory_fetch_order(self):
4591
 
        if self._rich_root_upgrade():
4592
 
            return 'topological'
4593
 
        else:
4594
 
            return self.to_format._fetch_order
4595
 
 
4596
 
    def _rich_root_upgrade(self):
4597
 
        return (not self.from_repository._format.rich_root_data and
4598
 
            self.to_format.rich_root_data)
4599
 
 
4600
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4601
 
        from_format = self.from_repository._format
4602
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4603
 
            from_format.network_name() == self.to_format.network_name()):
4604
 
            raise AssertionError(
4605
 
                "this case should be handled by GroupCHKStreamSource")
4606
 
        elif 'forceinvdeltas' in debug.debug_flags:
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
4609
 
        elif from_format.network_name() == self.to_format.network_name():
4610
 
            # Same format.
4611
 
            return self._get_simple_inventory_stream(revision_ids,
4612
 
                    missing=missing)
4613
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4614
 
                and from_format._serializer == self.to_format._serializer):
4615
 
            # Essentially the same format.
4616
 
            return self._get_simple_inventory_stream(revision_ids,
4617
 
                    missing=missing)
4618
 
        else:
4619
 
            # Any time we switch serializations, we want to use an
4620
 
            # inventory-delta based approach.
4621
 
            return self._get_convertable_inventory_stream(revision_ids,
4622
 
                    delta_versus_null=missing)
4623
 
 
4624
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4625
 
        # NB: This currently reopens the inventory weave in source;
4626
 
        # using a single stream interface instead would avoid this.
4627
 
        from_weave = self.from_repository.inventories
4628
 
        if missing:
4629
 
            delta_closure = True
4630
 
        else:
4631
 
            delta_closure = not self.delta_on_metadata()
4632
 
        yield ('inventories', from_weave.get_record_stream(
4633
 
            [(rev_id,) for rev_id in revision_ids],
4634
 
            self.inventory_fetch_order(), delta_closure))
4635
 
 
4636
 
    def _get_convertable_inventory_stream(self, revision_ids,
4637
 
                                          delta_versus_null=False):
4638
 
        # The two formats are sufficiently different that there is no fast
4639
 
        # path, so we need to send just inventorydeltas, which any
4640
 
        # sufficiently modern client can insert into any repository.
4641
 
        # The StreamSink code expects to be able to
4642
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4643
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4644
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4645
 
        yield ('inventory-deltas',
4646
 
           self._stream_invs_as_deltas(revision_ids,
4647
 
                                       delta_versus_null=delta_versus_null))
4648
 
 
4649
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4650
 
        """Return a stream of inventory-deltas for the given rev ids.
4651
 
 
4652
 
        :param revision_ids: The list of inventories to transmit
4653
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4654
 
            entry, instead compute the delta versus the NULL_REVISION. This
4655
 
            effectively streams a complete inventory. Used for stuff like
4656
 
            filling in missing parents, etc.
4657
 
        """
4658
 
        from_repo = self.from_repository
4659
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4660
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4661
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4662
 
        # method...
4663
 
        inventories = self.from_repository.iter_inventories(
4664
 
            revision_ids, 'topological')
4665
 
        format = from_repo._format
4666
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4667
 
        inventory_cache = lru_cache.LRUCache(50)
4668
 
        null_inventory = from_repo.revision_tree(
4669
 
            _mod_revision.NULL_REVISION).inventory
4670
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4671
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4672
 
        # repo back into a non-rich-root repo ought to be allowed)
4673
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4674
 
            versioned_root=format.rich_root_data,
4675
 
            tree_references=format.supports_tree_reference)
4676
 
        for inv in inventories:
4677
 
            key = (inv.revision_id,)
4678
 
            parent_keys = parent_map.get(key, ())
4679
 
            delta = None
4680
 
            if not delta_versus_null and parent_keys:
4681
 
                # The caller did not ask for complete inventories and we have
4682
 
                # some parents that we can delta against.  Make a delta against
4683
 
                # each parent so that we can find the smallest.
4684
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4685
 
                for parent_id in parent_ids:
4686
 
                    if parent_id not in invs_sent_so_far:
4687
 
                        # We don't know that the remote side has this basis, so
4688
 
                        # we can't use it.
4689
 
                        continue
4690
 
                    if parent_id == _mod_revision.NULL_REVISION:
4691
 
                        parent_inv = null_inventory
4692
 
                    else:
4693
 
                        parent_inv = inventory_cache.get(parent_id, None)
4694
 
                        if parent_inv is None:
4695
 
                            parent_inv = from_repo.get_inventory(parent_id)
4696
 
                    candidate_delta = inv._make_delta(parent_inv)
4697
 
                    if (delta is None or
4698
 
                        len(delta) > len(candidate_delta)):
4699
 
                        delta = candidate_delta
4700
 
                        basis_id = parent_id
4701
 
            if delta is None:
4702
 
                # Either none of the parents ended up being suitable, or we
4703
 
                # were asked to delta against NULL
4704
 
                basis_id = _mod_revision.NULL_REVISION
4705
 
                delta = inv._make_delta(null_inventory)
4706
 
            invs_sent_so_far.add(inv.revision_id)
4707
 
            inventory_cache[inv.revision_id] = inv
4708
 
            delta_serialized = ''.join(
4709
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4710
 
            yield versionedfile.FulltextContentFactory(
4711
 
                key, parent_keys, None, delta_serialized)
4712
 
 
4713
 
 
4714
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4715
 
                    stop_revision=None):
4716
 
    """Extend the partial history to include a given index
4717
 
 
4718
 
    If a stop_index is supplied, stop when that index has been reached.
4719
 
    If a stop_revision is supplied, stop when that revision is
4720
 
    encountered.  Otherwise, stop when the beginning of history is
4721
 
    reached.
4722
 
 
4723
 
    :param stop_index: The index which should be present.  When it is
4724
 
        present, history extension will stop.
4725
 
    :param stop_revision: The revision id which should be present.  When
4726
 
        it is encountered, history extension will stop.
4727
 
    """
4728
 
    start_revision = partial_history_cache[-1]
4729
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4730
 
    try:
4731
 
        #skip the last revision in the list
4732
 
        iterator.next()
4733
 
        while True:
4734
 
            if (stop_index is not None and
4735
 
                len(partial_history_cache) > stop_index):
4736
 
                break
4737
 
            if partial_history_cache[-1] == stop_revision:
4738
 
                break
4739
 
            revision_id = iterator.next()
4740
 
            partial_history_cache.append(revision_id)
4741
 
    except StopIteration:
4742
 
        # No more history
4743
 
        return
4744