~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Andrew Bennetts
  • Date: 2009-03-04 07:10:07 UTC
  • mto: (4086.1.2 hpss-integration)
  • mto: This revision was merged to the branch mainline in revision 4087.
  • Revision ID: andrew.bennetts@canonical.com-20090304071007-8iqoi1m44ypmzg2a
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.

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