/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: Ian Clatworthy
  • Date: 2009-03-17 06:18:30 UTC
  • mto: (4157.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4158.
  • Revision ID: ian.clatworthy@canonical.com-20090317061830-9glppr51ggivnrgl
Show usage on --usage, not -h

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