~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2008-12-10 23:05:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3912.
  • Revision ID: john@arbash-meinel.com-20081210230521-t1t4d6yfh8kt6ft8
We don't need to inline get_cached until we've had the miss.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
26
    debug,
28
27
    errors,
29
 
    fifo_cache,
30
28
    generate_ids,
31
29
    gpg,
32
30
    graph,
33
 
    inventory,
34
 
    inventory_delta,
35
31
    lazy_regex,
36
32
    lockable_files,
37
33
    lockdir,
38
34
    lru_cache,
39
35
    osutils,
 
36
    remote,
40
37
    revision as _mod_revision,
41
38
    symbol_versioning,
42
39
    tsort,
49
46
from bzrlib.testament import Testament
50
47
""")
51
48
 
 
49
from bzrlib import registry
52
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
53
51
from bzrlib.inter import InterObject
54
 
from bzrlib.inventory import (
55
 
    Inventory,
56
 
    InventoryDirectory,
57
 
    ROOT_ID,
58
 
    entry_factory,
59
 
    )
60
 
from bzrlib import registry
 
52
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
53
from bzrlib.symbol_versioning import (
 
54
        deprecated_method,
 
55
        one_one,
 
56
        one_two,
 
57
        one_six,
 
58
        )
61
59
from bzrlib.trace import (
62
60
    log_exception_quietly, note, mutter, mutter_callsite, warning)
63
61
 
127
125
        # valid. Callers that will call record_delete() should call
128
126
        # .will_record_deletes() to indicate that.
129
127
        self._recording_deletes = False
130
 
        # memo'd check for no-op commits.
131
 
        self._any_changes = False
132
 
 
133
 
    def any_changes(self):
134
 
        """Return True if any entries were changed.
135
 
        
136
 
        This includes merge-only changes. It is the core for the --unchanged
137
 
        detection in commit.
138
 
 
139
 
        :return: True if any changes have occured.
140
 
        """
141
 
        return self._any_changes
142
128
 
143
129
    def _validate_unicode_text(self, text, context):
144
130
        """Verify things like commit messages don't have bogus characters."""
189
175
        deserializing the inventory, while we already have a copy in
190
176
        memory.
191
177
        """
192
 
        if self.new_inventory is None:
193
 
            self.new_inventory = self.repository.get_inventory(
194
 
                self._new_revision_id)
195
178
        return RevisionTree(self.repository, self.new_inventory,
196
 
            self._new_revision_id)
 
179
                            self._new_revision_id)
197
180
 
198
181
    def finish_inventory(self):
199
 
        """Tell the builder that the inventory is finished.
200
 
 
201
 
        :return: The inventory id in the repository, which can be used with
202
 
            repository.get_inventory.
203
 
        """
204
 
        if self.new_inventory is None:
205
 
            # an inventory delta was accumulated without creating a new
206
 
            # inventory.
207
 
            basis_id = self.basis_delta_revision
208
 
            self.inv_sha1 = self.repository.add_inventory_by_delta(
209
 
                basis_id, self._basis_delta, self._new_revision_id,
210
 
                self.parents)
211
 
        else:
212
 
            if self.new_inventory.root is None:
213
 
                raise AssertionError('Root entry should be supplied to'
214
 
                    ' record_entry_contents, as of bzr 0.10.')
215
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
216
 
            self.new_inventory.revision_id = self._new_revision_id
217
 
            self.inv_sha1 = self.repository.add_inventory(
218
 
                self._new_revision_id,
219
 
                self.new_inventory,
220
 
                self.parents
221
 
                )
222
 
        return self._new_revision_id
 
182
        """Tell the builder that the inventory is finished."""
 
183
        if self.new_inventory.root is None:
 
184
            raise AssertionError('Root entry should be supplied to'
 
185
                ' record_entry_contents, as of bzr 0.10.')
 
186
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
187
        self.new_inventory.revision_id = self._new_revision_id
 
188
        self.inv_sha1 = self.repository.add_inventory(
 
189
            self._new_revision_id,
 
190
            self.new_inventory,
 
191
            self.parents
 
192
            )
223
193
 
224
194
    def _gen_revision_id(self):
225
195
        """Return new revision-id."""
228
198
 
229
199
    def _generate_revision_if_needed(self):
230
200
        """Create a revision id if None was supplied.
231
 
 
 
201
        
232
202
        If the repository can not support user-specified revision ids
233
203
        they should override this function and raise CannotSetRevisionId
234
204
        if _new_revision_id is not None.
262
232
        # _new_revision_id
263
233
        ie.revision = self._new_revision_id
264
234
 
265
 
    def _require_root_change(self, tree):
266
 
        """Enforce an appropriate root object change.
267
 
 
268
 
        This is called once when record_iter_changes is called, if and only if
269
 
        the root was not in the delta calculated by record_iter_changes.
270
 
 
271
 
        :param tree: The tree which is being committed.
272
 
        """
273
 
        # NB: if there are no parents then this method is not called, so no
274
 
        # need to guard on parents having length.
275
 
        entry = entry_factory['directory'](tree.path2id(''), '',
276
 
            None)
277
 
        entry.revision = self._new_revision_id
278
 
        self._basis_delta.append(('', '', entry.file_id, entry))
279
 
 
280
235
    def _get_delta(self, ie, basis_inv, path):
281
236
        """Get a delta against the basis inventory for ie."""
282
237
        if ie.file_id not in basis_inv:
324
279
            raise AssertionError("recording deletes not activated.")
325
280
        delta = (path, None, file_id, None)
326
281
        self._basis_delta.append(delta)
327
 
        self._any_changes = True
328
282
        return delta
329
283
 
330
284
    def will_record_deletes(self):
335
289
        builder.record_delete().
336
290
        """
337
291
        self._recording_deletes = True
338
 
        try:
339
 
            basis_id = self.parents[0]
340
 
        except IndexError:
341
 
            basis_id = _mod_revision.NULL_REVISION
342
 
        self.basis_delta_revision = basis_id
343
292
 
344
293
    def record_entry_contents(self, ie, parent_invs, path, tree,
345
294
        content_summary):
351
300
        :param parent_invs: The inventories of the parent revisions of the
352
301
            commit.
353
302
        :param path: The path the entry is at in the tree.
354
 
        :param tree: The tree which contains this entry and should be used to
 
303
        :param tree: The tree which contains this entry and should be used to 
355
304
            obtain content.
356
305
        :param content_summary: Summary data from the tree about the paths
357
306
            content - stat, length, exec, sha/link target. This is only
465
414
            if content_summary[2] is None:
466
415
                raise ValueError("Files must not have executable = None")
467
416
            if not store:
468
 
                # We can't trust a check of the file length because of content
469
 
                # filtering...
470
 
                if (# if the exec bit has changed we have to store:
 
417
                if (# if the file length changed we have to store:
 
418
                    parent_entry.text_size != content_summary[1] or
 
419
                    # if the exec bit has changed we have to store:
471
420
                    parent_entry.executable != content_summary[2]):
472
421
                    store = True
473
422
                elif parent_entry.text_sha1 == content_summary[3]:
492
441
            ie.executable = content_summary[2]
493
442
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
494
443
            try:
495
 
                text = file_obj.read()
 
444
                lines = file_obj.readlines()
496
445
            finally:
497
446
                file_obj.close()
498
447
            try:
499
448
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
500
 
                    ie.file_id, text, heads, nostore_sha)
 
449
                    ie.file_id, lines, heads, nostore_sha)
501
450
                # Let the caller know we generated a stat fingerprint.
502
451
                fingerprint = (ie.text_sha1, stat_value)
503
452
            except errors.ExistingContent:
515
464
                # carry over:
516
465
                ie.revision = parent_entry.revision
517
466
                return self._get_delta(ie, basis_inv, path), False, None
518
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
467
            lines = []
 
468
            self._add_text_to_weave(ie.file_id, lines, heads, None)
519
469
        elif kind == 'symlink':
520
470
            current_link_target = content_summary[3]
521
471
            if not store:
529
479
                ie.symlink_target = parent_entry.symlink_target
530
480
                return self._get_delta(ie, basis_inv, path), False, None
531
481
            ie.symlink_target = current_link_target
532
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
482
            lines = []
 
483
            self._add_text_to_weave(ie.file_id, lines, heads, None)
533
484
        elif kind == 'tree-reference':
534
485
            if not store:
535
486
                if content_summary[3] != parent_entry.reference_revision:
540
491
                ie.revision = parent_entry.revision
541
492
                return self._get_delta(ie, basis_inv, path), False, None
542
493
            ie.reference_revision = content_summary[3]
543
 
            if ie.reference_revision is None:
544
 
                raise AssertionError("invalid content_summary for nested tree: %r"
545
 
                    % (content_summary,))
546
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
494
            lines = []
 
495
            self._add_text_to_weave(ie.file_id, lines, heads, None)
547
496
        else:
548
497
            raise NotImplementedError('unknown kind')
549
498
        ie.revision = self._new_revision_id
550
 
        self._any_changes = True
551
499
        return self._get_delta(ie, basis_inv, path), True, fingerprint
552
500
 
553
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
554
 
        _entry_factory=entry_factory):
555
 
        """Record a new tree via iter_changes.
556
 
 
557
 
        :param tree: The tree to obtain text contents from for changed objects.
558
 
        :param basis_revision_id: The revision id of the tree the iter_changes
559
 
            has been generated against. Currently assumed to be the same
560
 
            as self.parents[0] - if it is not, errors may occur.
561
 
        :param iter_changes: An iter_changes iterator with the changes to apply
562
 
            to basis_revision_id. The iterator must not include any items with
563
 
            a current kind of None - missing items must be either filtered out
564
 
            or errored-on beefore record_iter_changes sees the item.
565
 
        :param _entry_factory: Private method to bind entry_factory locally for
566
 
            performance.
567
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
568
 
            tree._observed_sha1.
569
 
        """
570
 
        # Create an inventory delta based on deltas between all the parents and
571
 
        # deltas between all the parent inventories. We use inventory delta's 
572
 
        # between the inventory objects because iter_changes masks
573
 
        # last-changed-field only changes.
574
 
        # Working data:
575
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
576
 
        # parents, names, kinds, executables
577
 
        merged_ids = {}
578
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
579
 
        # trees that are not parents[0]
580
 
        parent_entries = {}
581
 
        ghost_basis = False
582
 
        try:
583
 
            revtrees = list(self.repository.revision_trees(self.parents))
584
 
        except errors.NoSuchRevision:
585
 
            # one or more ghosts, slow path.
586
 
            revtrees = []
587
 
            for revision_id in self.parents:
588
 
                try:
589
 
                    revtrees.append(self.repository.revision_tree(revision_id))
590
 
                except errors.NoSuchRevision:
591
 
                    if not revtrees:
592
 
                        basis_revision_id = _mod_revision.NULL_REVISION
593
 
                        ghost_basis = True
594
 
                    revtrees.append(self.repository.revision_tree(
595
 
                        _mod_revision.NULL_REVISION))
596
 
        # The basis inventory from a repository 
597
 
        if revtrees:
598
 
            basis_inv = revtrees[0].inventory
599
 
        else:
600
 
            basis_inv = self.repository.revision_tree(
601
 
                _mod_revision.NULL_REVISION).inventory
602
 
        if len(self.parents) > 0:
603
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
604
 
                raise Exception(
605
 
                    "arbitrary basis parents not yet supported with merges")
606
 
            for revtree in revtrees[1:]:
607
 
                for change in revtree.inventory._make_delta(basis_inv):
608
 
                    if change[1] is None:
609
 
                        # Not present in this parent.
610
 
                        continue
611
 
                    if change[2] not in merged_ids:
612
 
                        if change[0] is not None:
613
 
                            basis_entry = basis_inv[change[2]]
614
 
                            merged_ids[change[2]] = [
615
 
                                # basis revid
616
 
                                basis_entry.revision,
617
 
                                # new tree revid
618
 
                                change[3].revision]
619
 
                            parent_entries[change[2]] = {
620
 
                                # basis parent
621
 
                                basis_entry.revision:basis_entry,
622
 
                                # this parent 
623
 
                                change[3].revision:change[3],
624
 
                                }
625
 
                        else:
626
 
                            merged_ids[change[2]] = [change[3].revision]
627
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
628
 
                    else:
629
 
                        merged_ids[change[2]].append(change[3].revision)
630
 
                        parent_entries[change[2]][change[3].revision] = change[3]
631
 
        else:
632
 
            merged_ids = {}
633
 
        # Setup the changes from the tree:
634
 
        # changes maps file_id -> (change, [parent revision_ids])
635
 
        changes= {}
636
 
        for change in iter_changes:
637
 
            # This probably looks up in basis_inv way to much.
638
 
            if change[1][0] is not None:
639
 
                head_candidate = [basis_inv[change[0]].revision]
640
 
            else:
641
 
                head_candidate = []
642
 
            changes[change[0]] = change, merged_ids.get(change[0],
643
 
                head_candidate)
644
 
        unchanged_merged = set(merged_ids) - set(changes)
645
 
        # Extend the changes dict with synthetic changes to record merges of
646
 
        # texts.
647
 
        for file_id in unchanged_merged:
648
 
            # Record a merged version of these items that did not change vs the
649
 
            # basis. This can be either identical parallel changes, or a revert
650
 
            # of a specific file after a merge. The recorded content will be
651
 
            # that of the current tree (which is the same as the basis), but
652
 
            # the per-file graph will reflect a merge.
653
 
            # NB:XXX: We are reconstructing path information we had, this
654
 
            # should be preserved instead.
655
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
656
 
            #   changed_content, versioned, parent, name, kind,
657
 
            #   executable)
658
 
            try:
659
 
                basis_entry = basis_inv[file_id]
660
 
            except errors.NoSuchId:
661
 
                # a change from basis->some_parents but file_id isn't in basis
662
 
                # so was new in the merge, which means it must have changed
663
 
                # from basis -> current, and as it hasn't the add was reverted
664
 
                # by the user. So we discard this change.
665
 
                pass
666
 
            else:
667
 
                change = (file_id,
668
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
669
 
                    False, (True, True),
670
 
                    (basis_entry.parent_id, basis_entry.parent_id),
671
 
                    (basis_entry.name, basis_entry.name),
672
 
                    (basis_entry.kind, basis_entry.kind),
673
 
                    (basis_entry.executable, basis_entry.executable))
674
 
                changes[file_id] = (change, merged_ids[file_id])
675
 
        # changes contains tuples with the change and a set of inventory
676
 
        # candidates for the file.
677
 
        # inv delta is:
678
 
        # old_path, new_path, file_id, new_inventory_entry
679
 
        seen_root = False # Is the root in the basis delta?
680
 
        inv_delta = self._basis_delta
681
 
        modified_rev = self._new_revision_id
682
 
        for change, head_candidates in changes.values():
683
 
            if change[3][1]: # versioned in target.
684
 
                # Several things may be happening here:
685
 
                # We may have a fork in the per-file graph
686
 
                #  - record a change with the content from tree
687
 
                # We may have a change against < all trees  
688
 
                #  - carry over the tree that hasn't changed
689
 
                # We may have a change against all trees
690
 
                #  - record the change with the content from tree
691
 
                kind = change[6][1]
692
 
                file_id = change[0]
693
 
                entry = _entry_factory[kind](file_id, change[5][1],
694
 
                    change[4][1])
695
 
                head_set = self._heads(change[0], set(head_candidates))
696
 
                heads = []
697
 
                # Preserve ordering.
698
 
                for head_candidate in head_candidates:
699
 
                    if head_candidate in head_set:
700
 
                        heads.append(head_candidate)
701
 
                        head_set.remove(head_candidate)
702
 
                carried_over = False
703
 
                if len(heads) == 1:
704
 
                    # Could be a carry-over situation:
705
 
                    parent_entry_revs = parent_entries.get(file_id, None)
706
 
                    if parent_entry_revs:
707
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
708
 
                    else:
709
 
                        parent_entry = None
710
 
                    if parent_entry is None:
711
 
                        # The parent iter_changes was called against is the one
712
 
                        # that is the per-file head, so any change is relevant
713
 
                        # iter_changes is valid.
714
 
                        carry_over_possible = False
715
 
                    else:
716
 
                        # could be a carry over situation
717
 
                        # A change against the basis may just indicate a merge,
718
 
                        # we need to check the content against the source of the
719
 
                        # merge to determine if it was changed after the merge
720
 
                        # or carried over.
721
 
                        if (parent_entry.kind != entry.kind or
722
 
                            parent_entry.parent_id != entry.parent_id or
723
 
                            parent_entry.name != entry.name):
724
 
                            # Metadata common to all entries has changed
725
 
                            # against per-file parent
726
 
                            carry_over_possible = False
727
 
                        else:
728
 
                            carry_over_possible = True
729
 
                        # per-type checks for changes against the parent_entry
730
 
                        # are done below.
731
 
                else:
732
 
                    # Cannot be a carry-over situation
733
 
                    carry_over_possible = False
734
 
                # Populate the entry in the delta
735
 
                if kind == 'file':
736
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
737
 
                    # after iter_changes examines and decides it has changed,
738
 
                    # we will unconditionally record a new version even if some
739
 
                    # other process reverts it while commit is running (with
740
 
                    # the revert happening after iter_changes did it's
741
 
                    # examination).
742
 
                    if change[7][1]:
743
 
                        entry.executable = True
744
 
                    else:
745
 
                        entry.executable = False
746
 
                    if (carry_over_possible and
747
 
                        parent_entry.executable == entry.executable):
748
 
                            # Check the file length, content hash after reading
749
 
                            # the file.
750
 
                            nostore_sha = parent_entry.text_sha1
751
 
                    else:
752
 
                        nostore_sha = None
753
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
754
 
                    try:
755
 
                        text = file_obj.read()
756
 
                    finally:
757
 
                        file_obj.close()
758
 
                    try:
759
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
760
 
                            file_id, text, heads, nostore_sha)
761
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
762
 
                    except errors.ExistingContent:
763
 
                        # No content change against a carry_over parent
764
 
                        # Perhaps this should also yield a fs hash update?
765
 
                        carried_over = True
766
 
                        entry.text_size = parent_entry.text_size
767
 
                        entry.text_sha1 = parent_entry.text_sha1
768
 
                elif kind == 'symlink':
769
 
                    # Wants a path hint?
770
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
771
 
                    if (carry_over_possible and
772
 
                        parent_entry.symlink_target == entry.symlink_target):
773
 
                        carried_over = True
774
 
                    else:
775
 
                        self._add_text_to_weave(change[0], '', heads, None)
776
 
                elif kind == 'directory':
777
 
                    if carry_over_possible:
778
 
                        carried_over = True
779
 
                    else:
780
 
                        # Nothing to set on the entry.
781
 
                        # XXX: split into the Root and nonRoot versions.
782
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
783
 
                            self._add_text_to_weave(change[0], '', heads, None)
784
 
                elif kind == 'tree-reference':
785
 
                    if not self.repository._format.supports_tree_reference:
786
 
                        # This isn't quite sane as an error, but we shouldn't
787
 
                        # ever see this code path in practice: tree's don't
788
 
                        # permit references when the repo doesn't support tree
789
 
                        # references.
790
 
                        raise errors.UnsupportedOperation(tree.add_reference,
791
 
                            self.repository)
792
 
                    reference_revision = tree.get_reference_revision(change[0])
793
 
                    entry.reference_revision = reference_revision
794
 
                    if (carry_over_possible and
795
 
                        parent_entry.reference_revision == reference_revision):
796
 
                        carried_over = True
797
 
                    else:
798
 
                        self._add_text_to_weave(change[0], '', heads, None)
799
 
                else:
800
 
                    raise AssertionError('unknown kind %r' % kind)
801
 
                if not carried_over:
802
 
                    entry.revision = modified_rev
803
 
                else:
804
 
                    entry.revision = parent_entry.revision
805
 
            else:
806
 
                entry = None
807
 
            new_path = change[1][1]
808
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
809
 
            if new_path == '':
810
 
                seen_root = True
811
 
        self.new_inventory = None
812
 
        if len(inv_delta):
813
 
            # This should perhaps be guarded by a check that the basis we
814
 
            # commit against is the basis for the commit and if not do a delta
815
 
            # against the basis.
816
 
            self._any_changes = True
817
 
        if not seen_root:
818
 
            # housekeeping root entry changes do not affect no-change commits.
819
 
            self._require_root_change(tree)
820
 
        self.basis_delta_revision = basis_revision_id
821
 
 
822
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
823
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
824
 
        return self.repository.texts._add_text(
825
 
            (file_id, self._new_revision_id), parent_keys, new_text,
826
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
501
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
502
        # Note: as we read the content directly from the tree, we know its not
 
503
        # been turned into unicode or badly split - but a broken tree
 
504
        # implementation could give us bad output from readlines() so this is
 
505
        # not a guarantee of safety. What would be better is always checking
 
506
        # the content during test suite execution. RBC 20070912
 
507
        parent_keys = tuple((file_id, parent) for parent in parents)
 
508
        return self.repository.texts.add_lines(
 
509
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
510
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
511
            check_content=False)[0:2]
827
512
 
828
513
 
829
514
class RootCommitBuilder(CommitBuilder):
830
515
    """This commitbuilder actually records the root id"""
831
 
 
 
516
    
832
517
    # the root entry gets versioned properly by this builder.
833
518
    _versioned_root = True
834
519
 
841
526
        :param tree: The tree that is being committed.
842
527
        """
843
528
 
844
 
    def _require_root_change(self, tree):
845
 
        """Enforce an appropriate root object change.
846
 
 
847
 
        This is called once when record_iter_changes is called, if and only if
848
 
        the root was not in the delta calculated by record_iter_changes.
849
 
 
850
 
        :param tree: The tree which is being committed.
851
 
        """
852
 
        # versioned roots do not change unless the tree found a change.
853
 
 
854
529
 
855
530
######################################################################
856
531
# Repositories
857
532
 
858
 
 
859
533
class Repository(object):
860
534
    """Repository holding history for one or more branches.
861
535
 
864
538
    which views a particular line of development through that history.
865
539
 
866
540
    The Repository builds on top of some byte storage facilies (the revisions,
867
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
868
 
    which respectively provide byte storage and a means to access the (possibly
 
541
    signatures, inventories and texts attributes) and a Transport, which
 
542
    respectively provide byte storage and a means to access the (possibly
869
543
    remote) disk.
870
544
 
871
545
    The byte storage facilities are addressed via tuples, which we refer to
872
546
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
873
547
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
874
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
875
 
    byte string made up of a hash identifier and a hash value.
876
 
    We use this interface because it allows low friction with the underlying
877
 
    code that implements disk indices, network encoding and other parts of
878
 
    bzrlib.
 
548
    (file_id, revision_id). We use this interface because it allows low
 
549
    friction with the underlying code that implements disk indices, network
 
550
    encoding and other parts of bzrlib.
879
551
 
880
552
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
881
553
        the serialised revisions for the repository. This can be used to obtain
900
572
        The result of trying to insert data into the repository via this store
901
573
        is undefined: it should be considered read-only except for implementors
902
574
        of repositories.
903
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
904
 
        any data the repository chooses to store or have indexed by its hash.
905
 
        The result of trying to insert data into the repository via this store
906
 
        is undefined: it should be considered read-only except for implementors
907
 
        of repositories.
908
575
    :ivar _transport: Transport for file access to repository, typically
909
576
        pointing to .bzr/repository.
910
577
    """
931
598
        """
932
599
        if self._write_group is not self.get_transaction():
933
600
            # has an unlock or relock occured ?
934
 
            if suppress_errors:
935
 
                mutter(
936
 
                '(suppressed) mismatched lock context and write group. %r, %r',
937
 
                self._write_group, self.get_transaction())
938
 
                return
939
 
            raise errors.BzrError(
940
 
                'mismatched lock context and write group. %r, %r' %
941
 
                (self._write_group, self.get_transaction()))
 
601
            raise errors.BzrError('mismatched lock context and write group.')
942
602
        try:
943
603
            self._abort_write_group()
944
604
        except Exception, exc:
952
612
 
953
613
    def _abort_write_group(self):
954
614
        """Template method for per-repository write group cleanup.
955
 
 
956
 
        This is called during abort before the write group is considered to be
 
615
        
 
616
        This is called during abort before the write group is considered to be 
957
617
        finished and should cleanup any internal state accrued during the write
958
618
        group. There is no requirement that data handed to the repository be
959
619
        *not* made available - this is not a rollback - but neither should any
965
625
 
966
626
    def add_fallback_repository(self, repository):
967
627
        """Add a repository to use for looking up data not held locally.
968
 
 
 
628
        
969
629
        :param repository: A repository.
970
630
        """
971
631
        if not self._format.supports_external_lookups:
972
632
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
973
 
        if self.is_locked():
974
 
            # This repository will call fallback.unlock() when we transition to
975
 
            # the unlocked state, so we make sure to increment the lock count
976
 
            repository.lock_read()
977
633
        self._check_fallback_repository(repository)
978
634
        self._fallback_repositories.append(repository)
979
635
        self.texts.add_fallback_versioned_files(repository.texts)
980
636
        self.inventories.add_fallback_versioned_files(repository.inventories)
981
637
        self.revisions.add_fallback_versioned_files(repository.revisions)
982
638
        self.signatures.add_fallback_versioned_files(repository.signatures)
983
 
        if self.chk_bytes is not None:
984
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
 
639
        self._fetch_order = 'topological'
985
640
 
986
641
    def _check_fallback_repository(self, repository):
987
642
        """Check that this repository can fallback to repository safely.
988
643
 
989
644
        Raise an error if not.
990
 
 
 
645
        
991
646
        :param repository: A repository to fallback to.
992
647
        """
993
648
        return InterRepository._assert_same_model(self, repository)
994
649
 
995
650
    def add_inventory(self, revision_id, inv, parents):
996
651
        """Add the inventory inv to the repository as revision_id.
997
 
 
 
652
        
998
653
        :param parents: The revision ids of the parents that revision_id
999
654
                        is known to have and are in the repository already.
1000
655
 
1011
666
                % (inv.revision_id, revision_id))
1012
667
        if inv.root is None:
1013
668
            raise AssertionError()
1014
 
        return self._add_inventory_checked(revision_id, inv, parents)
1015
 
 
1016
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1017
 
        """Add inv to the repository after checking the inputs.
1018
 
 
1019
 
        This function can be overridden to allow different inventory styles.
1020
 
 
1021
 
        :seealso: add_inventory, for the contract.
1022
 
        """
1023
669
        inv_lines = self._serialise_inventory_to_lines(inv)
1024
670
        return self._inventory_add_lines(revision_id, parents,
1025
671
            inv_lines, check_content=False)
1026
672
 
1027
673
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1028
 
                               parents, basis_inv=None, propagate_caches=False):
 
674
                               parents):
1029
675
        """Add a new inventory expressed as a delta against another revision.
1030
676
 
1031
 
        See the inventory developers documentation for the theory behind
1032
 
        inventory deltas.
1033
 
 
1034
677
        :param basis_revision_id: The inventory id the delta was created
1035
678
            against. (This does not have to be a direct parent.)
1036
679
        :param delta: The inventory delta (see Inventory.apply_delta for
1042
685
            for repositories that depend on the inventory graph for revision
1043
686
            graph access, as well as for those that pun ancestry with delta
1044
687
            compression.
1045
 
        :param basis_inv: The basis inventory if it is already known,
1046
 
            otherwise None.
1047
 
        :param propagate_caches: If True, the caches for this inventory are
1048
 
          copied to and updated for the result if possible.
1049
688
 
1050
689
        :returns: (validator, new_inv)
1051
690
            The validator(which is a sha1 digest, though what is sha'd is
1062
701
            # inventory implementations may support: A better idiom would be to
1063
702
            # return a new inventory, but as there is no revision tree cache in
1064
703
            # repository this is safe for now - RBC 20081013
1065
 
            if basis_inv is None:
1066
 
                basis_inv = basis_tree.inventory
 
704
            basis_inv = basis_tree.inventory
1067
705
            basis_inv.apply_delta(delta)
1068
706
            basis_inv.revision_id = new_revision_id
1069
707
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1075
713
        check_content=True):
1076
714
        """Store lines in inv_vf and return the sha1 of the inventory."""
1077
715
        parents = [(parent,) for parent in parents]
1078
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
716
        return self.inventories.add_lines((revision_id,), parents, lines,
1079
717
            check_content=check_content)[0]
1080
 
        self.inventories._access.flush()
1081
 
        return result
1082
718
 
1083
719
    def add_revision(self, revision_id, rev, inv=None, config=None):
1084
720
        """Add rev to the revision store as revision_id.
1121
757
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
1122
758
 
1123
759
    def all_revision_ids(self):
1124
 
        """Returns a list of all the revision ids in the repository.
 
760
        """Returns a list of all the revision ids in the repository. 
1125
761
 
1126
762
        This is conceptually deprecated because code should generally work on
1127
763
        the graph reachable from a particular revision, and ignore any other
1133
769
        return self._all_revision_ids()
1134
770
 
1135
771
    def _all_revision_ids(self):
1136
 
        """Returns a list of all the revision ids in the repository.
 
772
        """Returns a list of all the revision ids in the repository. 
1137
773
 
1138
 
        These are in as much topological order as the underlying store can
 
774
        These are in as much topological order as the underlying store can 
1139
775
        present.
1140
776
        """
1141
777
        raise NotImplementedError(self._all_revision_ids)
1160
796
        # The old API returned a list, should this actually be a set?
1161
797
        return parent_map.keys()
1162
798
 
1163
 
    def _check_inventories(self, checker):
1164
 
        """Check the inventories found from the revision scan.
1165
 
        
1166
 
        This is responsible for verifying the sha1 of inventories and
1167
 
        creating a pending_keys set that covers data referenced by inventories.
1168
 
        """
1169
 
        bar = ui.ui_factory.nested_progress_bar()
1170
 
        try:
1171
 
            self._do_check_inventories(checker, bar)
1172
 
        finally:
1173
 
            bar.finished()
1174
 
 
1175
 
    def _do_check_inventories(self, checker, bar):
1176
 
        """Helper for _check_inventories."""
1177
 
        revno = 0
1178
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1179
 
        kinds = ['chk_bytes', 'texts']
1180
 
        count = len(checker.pending_keys)
1181
 
        bar.update("inventories", 0, 2)
1182
 
        current_keys = checker.pending_keys
1183
 
        checker.pending_keys = {}
1184
 
        # Accumulate current checks.
1185
 
        for key in current_keys:
1186
 
            if key[0] != 'inventories' and key[0] not in kinds:
1187
 
                checker._report_items.append('unknown key type %r' % (key,))
1188
 
            keys[key[0]].add(key[1:])
1189
 
        if keys['inventories']:
1190
 
            # NB: output order *should* be roughly sorted - topo or
1191
 
            # inverse topo depending on repository - either way decent
1192
 
            # to just delta against. However, pre-CHK formats didn't
1193
 
            # try to optimise inventory layout on disk. As such the
1194
 
            # pre-CHK code path does not use inventory deltas.
1195
 
            last_object = None
1196
 
            for record in self.inventories.check(keys=keys['inventories']):
1197
 
                if record.storage_kind == 'absent':
1198
 
                    checker._report_items.append(
1199
 
                        'Missing inventory {%s}' % (record.key,))
1200
 
                else:
1201
 
                    last_object = self._check_record('inventories', record,
1202
 
                        checker, last_object,
1203
 
                        current_keys[('inventories',) + record.key])
1204
 
            del keys['inventories']
1205
 
        else:
1206
 
            return
1207
 
        bar.update("texts", 1)
1208
 
        while (checker.pending_keys or keys['chk_bytes']
1209
 
            or keys['texts']):
1210
 
            # Something to check.
1211
 
            current_keys = checker.pending_keys
1212
 
            checker.pending_keys = {}
1213
 
            # Accumulate current checks.
1214
 
            for key in current_keys:
1215
 
                if key[0] not in kinds:
1216
 
                    checker._report_items.append('unknown key type %r' % (key,))
1217
 
                keys[key[0]].add(key[1:])
1218
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1219
 
            for kind in kinds:
1220
 
                if keys[kind]:
1221
 
                    last_object = None
1222
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1223
 
                        if record.storage_kind == 'absent':
1224
 
                            checker._report_items.append(
1225
 
                                'Missing %s {%s}' % (kind, record.key,))
1226
 
                        else:
1227
 
                            last_object = self._check_record(kind, record,
1228
 
                                checker, last_object, current_keys[(kind,) + record.key])
1229
 
                    keys[kind] = set()
1230
 
                    break
1231
 
 
1232
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1233
 
        """Check a single text from this repository."""
1234
 
        if kind == 'inventories':
1235
 
            rev_id = record.key[0]
1236
 
            inv = self.deserialise_inventory(rev_id,
1237
 
                record.get_bytes_as('fulltext'))
1238
 
            if last_object is not None:
1239
 
                delta = inv._make_delta(last_object)
1240
 
                for old_path, path, file_id, ie in delta:
1241
 
                    if ie is None:
1242
 
                        continue
1243
 
                    ie.check(checker, rev_id, inv)
1244
 
            else:
1245
 
                for path, ie in inv.iter_entries():
1246
 
                    ie.check(checker, rev_id, inv)
1247
 
            if self._format.fast_deltas:
1248
 
                return inv
1249
 
        elif kind == 'chk_bytes':
1250
 
            # No code written to check chk_bytes for this repo format.
1251
 
            checker._report_items.append(
1252
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1253
 
        elif kind == 'texts':
1254
 
            self._check_text(record, checker, item_data)
1255
 
        else:
1256
 
            checker._report_items.append(
1257
 
                'unknown key type %s for %s' % (kind, record.key))
1258
 
 
1259
 
    def _check_text(self, record, checker, item_data):
1260
 
        """Check a single text."""
1261
 
        # Check it is extractable.
1262
 
        # TODO: check length.
1263
 
        if record.storage_kind == 'chunked':
1264
 
            chunks = record.get_bytes_as(record.storage_kind)
1265
 
            sha1 = osutils.sha_strings(chunks)
1266
 
            length = sum(map(len, chunks))
1267
 
        else:
1268
 
            content = record.get_bytes_as('fulltext')
1269
 
            sha1 = osutils.sha_string(content)
1270
 
            length = len(content)
1271
 
        if item_data and sha1 != item_data[1]:
1272
 
            checker._report_items.append(
1273
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1274
 
                (record.key, sha1, item_data[1], item_data[2]))
1275
 
 
1276
799
    @staticmethod
1277
800
    def create(a_bzrdir):
1278
801
        """Construct the current default format repository in a_bzrdir."""
1299
822
        self._reconcile_does_inventory_gc = True
1300
823
        self._reconcile_fixes_text_parents = False
1301
824
        self._reconcile_backsup_inventory = True
1302
 
        # not right yet - should be more semantically clear ?
1303
 
        #
 
825
        # not right yet - should be more semantically clear ? 
 
826
        # 
1304
827
        # TODO: make sure to construct the right store classes, etc, depending
1305
828
        # on whether escaping is required.
1306
829
        self._warn_if_deprecated()
1307
830
        self._write_group = None
1308
831
        # Additional places to query for data.
1309
832
        self._fallback_repositories = []
1310
 
        # An InventoryEntry cache, used during deserialization
1311
 
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
833
        # What order should fetch operations request streams in?
 
834
        # The default is unordered as that is the cheapest for an origin to
 
835
        # provide.
 
836
        self._fetch_order = 'unordered'
 
837
        # Does this repository use deltas that can be fetched as-deltas ?
 
838
        # (E.g. knits, where the knit deltas can be transplanted intact.
 
839
        # We default to False, which will ensure that enough data to get
 
840
        # a full text out of any fetch stream will be grabbed.
 
841
        self._fetch_uses_deltas = False
 
842
        # Should fetch trigger a reconcile after the fetch? Only needed for
 
843
        # some repository formats that can suffer internal inconsistencies.
 
844
        self._fetch_reconcile = False
1312
845
 
1313
846
    def __repr__(self):
1314
 
        if self._fallback_repositories:
1315
 
            return '%s(%r, fallback_repositories=%r)' % (
1316
 
                self.__class__.__name__,
1317
 
                self.base,
1318
 
                self._fallback_repositories)
1319
 
        else:
1320
 
            return '%s(%r)' % (self.__class__.__name__,
1321
 
                               self.base)
1322
 
 
1323
 
    def _has_same_fallbacks(self, other_repo):
1324
 
        """Returns true if the repositories have the same fallbacks."""
1325
 
        my_fb = self._fallback_repositories
1326
 
        other_fb = other_repo._fallback_repositories
1327
 
        if len(my_fb) != len(other_fb):
1328
 
            return False
1329
 
        for f, g in zip(my_fb, other_fb):
1330
 
            if not f.has_same_location(g):
1331
 
                return False
1332
 
        return True
 
847
        return '%s(%r)' % (self.__class__.__name__,
 
848
                           self.base)
1333
849
 
1334
850
    def has_same_location(self, other):
1335
851
        """Returns a boolean indicating if this repository is at the same
1362
878
        This causes caching within the repository obejct to start accumlating
1363
879
        data during reads, and allows a 'write_group' to be obtained. Write
1364
880
        groups must be used for actual data insertion.
1365
 
 
 
881
        
1366
882
        :param token: if this is already locked, then lock_write will fail
1367
883
            unless the token matches the existing lock.
1368
884
        :returns: a token if this instance supports tokens, otherwise None.
1378
894
 
1379
895
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1380
896
        """
1381
 
        locked = self.is_locked()
1382
897
        result = self.control_files.lock_write(token=token)
1383
 
        if not locked:
1384
 
            for repo in self._fallback_repositories:
1385
 
                # Writes don't affect fallback repos
1386
 
                repo.lock_read()
1387
 
            self._refresh_data()
 
898
        for repo in self._fallback_repositories:
 
899
            # Writes don't affect fallback repos
 
900
            repo.lock_read()
 
901
        self._refresh_data()
1388
902
        return result
1389
903
 
1390
904
    def lock_read(self):
1391
 
        locked = self.is_locked()
1392
905
        self.control_files.lock_read()
1393
 
        if not locked:
1394
 
            for repo in self._fallback_repositories:
1395
 
                repo.lock_read()
1396
 
            self._refresh_data()
 
906
        for repo in self._fallback_repositories:
 
907
            repo.lock_read()
 
908
        self._refresh_data()
1397
909
 
1398
910
    def get_physical_lock_status(self):
1399
911
        return self.control_files.get_physical_lock_status()
1401
913
    def leave_lock_in_place(self):
1402
914
        """Tell this repository not to release the physical lock when this
1403
915
        object is unlocked.
1404
 
 
 
916
        
1405
917
        If lock_write doesn't return a token, then this method is not supported.
1406
918
        """
1407
919
        self.control_files.leave_in_place()
1513
1025
    @needs_read_lock
1514
1026
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1515
1027
        """Return the revision ids that other has that this does not.
1516
 
 
 
1028
        
1517
1029
        These are returned in topological order.
1518
1030
 
1519
1031
        revision_id: only return revision ids included by revision_id.
1521
1033
        return InterRepository.get(other, self).search_missing_revision_ids(
1522
1034
            revision_id, find_ghosts)
1523
1035
 
 
1036
    @deprecated_method(one_two)
 
1037
    @needs_read_lock
 
1038
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1039
        """Return the revision ids that other has that this does not.
 
1040
        
 
1041
        These are returned in topological order.
 
1042
 
 
1043
        revision_id: only return revision ids included by revision_id.
 
1044
        """
 
1045
        keys =  self.search_missing_revision_ids(
 
1046
            other, revision_id, find_ghosts).get_keys()
 
1047
        other.lock_read()
 
1048
        try:
 
1049
            parents = other.get_graph().get_parent_map(keys)
 
1050
        finally:
 
1051
            other.unlock()
 
1052
        return tsort.topo_sort(parents)
 
1053
 
1524
1054
    @staticmethod
1525
1055
    def open(base):
1526
1056
        """Open the repository rooted at base.
1533
1063
 
1534
1064
    def copy_content_into(self, destination, revision_id=None):
1535
1065
        """Make a complete copy of the content in self into destination.
1536
 
 
1537
 
        This is a destructive operation! Do not use it on existing
 
1066
        
 
1067
        This is a destructive operation! Do not use it on existing 
1538
1068
        repositories.
1539
1069
        """
1540
1070
        return InterRepository.get(self, destination).copy_content(revision_id)
1543
1073
        """Commit the contents accrued within the current write group.
1544
1074
 
1545
1075
        :seealso: start_write_group.
1546
 
        
1547
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1548
1076
        """
1549
1077
        if self._write_group is not self.get_transaction():
1550
1078
            # has an unlock or relock occured ?
1551
1079
            raise errors.BzrError('mismatched lock context %r and '
1552
1080
                'write group %r.' %
1553
1081
                (self.get_transaction(), self._write_group))
1554
 
        result = self._commit_write_group()
 
1082
        self._commit_write_group()
1555
1083
        self._write_group = None
1556
 
        return result
1557
1084
 
1558
1085
    def _commit_write_group(self):
1559
1086
        """Template method for per-repository write group cleanup.
1560
 
 
1561
 
        This is called before the write group is considered to be
 
1087
        
 
1088
        This is called before the write group is considered to be 
1562
1089
        finished and should ensure that all data handed to the repository
1563
 
        for writing during the write group is safely committed (to the
 
1090
        for writing during the write group is safely committed (to the 
1564
1091
        extent possible considering file system caching etc).
1565
1092
        """
1566
1093
 
1567
 
    def suspend_write_group(self):
1568
 
        raise errors.UnsuspendableWriteGroup(self)
1569
 
 
1570
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1571
 
        """Return the keys of missing inventory parents for revisions added in
1572
 
        this write group.
1573
 
 
1574
 
        A revision is not complete if the inventory delta for that revision
1575
 
        cannot be calculated.  Therefore if the parent inventories of a
1576
 
        revision are not present, the revision is incomplete, and e.g. cannot
1577
 
        be streamed by a smart server.  This method finds missing inventory
1578
 
        parents for revisions added in this write group.
1579
 
        """
1580
 
        if not self._format.supports_external_lookups:
1581
 
            # This is only an issue for stacked repositories
1582
 
            return set()
1583
 
        if not self.is_in_write_group():
1584
 
            raise AssertionError('not in a write group')
1585
 
 
1586
 
        # XXX: We assume that every added revision already has its
1587
 
        # corresponding inventory, so we only check for parent inventories that
1588
 
        # might be missing, rather than all inventories.
1589
 
        parents = set(self.revisions._index.get_missing_parents())
1590
 
        parents.discard(_mod_revision.NULL_REVISION)
1591
 
        unstacked_inventories = self.inventories._index
1592
 
        present_inventories = unstacked_inventories.get_parent_map(
1593
 
            key[-1:] for key in parents)
1594
 
        parents.difference_update(present_inventories)
1595
 
        if len(parents) == 0:
1596
 
            # No missing parent inventories.
1597
 
            return set()
1598
 
        if not check_for_missing_texts:
1599
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1600
 
        # Ok, now we have a list of missing inventories.  But these only matter
1601
 
        # if the inventories that reference them are missing some texts they
1602
 
        # appear to introduce.
1603
 
        # XXX: Texts referenced by all added inventories need to be present,
1604
 
        # but at the moment we're only checking for texts referenced by
1605
 
        # inventories at the graph's edge.
1606
 
        key_deps = self.revisions._index._key_dependencies
1607
 
        key_deps.add_keys(present_inventories)
1608
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1609
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1610
 
        missing_texts = set()
1611
 
        for file_id, version_ids in file_ids.iteritems():
1612
 
            missing_texts.update(
1613
 
                (file_id, version_id) for version_id in version_ids)
1614
 
        present_texts = self.texts.get_parent_map(missing_texts)
1615
 
        missing_texts.difference_update(present_texts)
1616
 
        if not missing_texts:
1617
 
            # No texts are missing, so all revisions and their deltas are
1618
 
            # reconstructable.
1619
 
            return set()
1620
 
        # Alternatively the text versions could be returned as the missing
1621
 
        # keys, but this is likely to be less data.
1622
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1623
 
        return missing_keys
1624
 
 
1625
 
    def refresh_data(self):
1626
 
        """Re-read any data needed to to synchronise with disk.
1627
 
 
1628
 
        This method is intended to be called after another repository instance
1629
 
        (such as one used by a smart server) has inserted data into the
1630
 
        repository. It may not be called during a write group, but may be
1631
 
        called at any other time.
1632
 
        """
1633
 
        if self.is_in_write_group():
1634
 
            raise errors.InternalBzrError(
1635
 
                "May not refresh_data while in a write group.")
1636
 
        self._refresh_data()
1637
 
 
1638
 
    def resume_write_group(self, tokens):
1639
 
        if not self.is_write_locked():
1640
 
            raise errors.NotWriteLocked(self)
1641
 
        if self._write_group:
1642
 
            raise errors.BzrError('already in a write group')
1643
 
        self._resume_write_group(tokens)
1644
 
        # so we can detect unlock/relock - the write group is now entered.
1645
 
        self._write_group = self.get_transaction()
1646
 
 
1647
 
    def _resume_write_group(self, tokens):
1648
 
        raise errors.UnsuspendableWriteGroup(self)
1649
 
 
1650
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1651
 
            fetch_spec=None):
 
1094
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1652
1095
        """Fetch the content required to construct revision_id from source.
1653
1096
 
1654
 
        If revision_id is None and fetch_spec is None, then all content is
1655
 
        copied.
1656
 
 
1657
 
        fetch() may not be used when the repository is in a write group -
1658
 
        either finish the current write group before using fetch, or use
1659
 
        fetch before starting the write group.
1660
 
 
 
1097
        If revision_id is None all content is copied.
1661
1098
        :param find_ghosts: Find and copy revisions in the source that are
1662
1099
            ghosts in the target (and not reachable directly by walking out to
1663
1100
            the first-present revision in target from revision_id).
1664
 
        :param revision_id: If specified, all the content needed for this
1665
 
            revision ID will be copied to the target.  Fetch will determine for
1666
 
            itself which content needs to be copied.
1667
 
        :param fetch_spec: If specified, a SearchResult or
1668
 
            PendingAncestryResult that describes which revisions to copy.  This
1669
 
            allows copying multiple heads at once.  Mutually exclusive with
1670
 
            revision_id.
1671
1101
        """
1672
 
        if fetch_spec is not None and revision_id is not None:
1673
 
            raise AssertionError(
1674
 
                "fetch_spec and revision_id are mutually exclusive.")
1675
 
        if self.is_in_write_group():
1676
 
            raise errors.InternalBzrError(
1677
 
                "May not fetch while in a write group.")
1678
1102
        # fast path same-url fetch operations
1679
 
        # TODO: lift out to somewhere common with RemoteRepository
1680
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1681
 
        if (self.has_same_location(source)
1682
 
            and fetch_spec is None
1683
 
            and self._has_same_fallbacks(source)):
 
1103
        if self.has_same_location(source):
1684
1104
            # check that last_revision is in 'from' and then return a
1685
1105
            # no-operation.
1686
1106
            if (revision_id is not None and
1692
1112
        # IncompatibleRepositories when asked to fetch.
1693
1113
        inter = InterRepository.get(source, self)
1694
1114
        return inter.fetch(revision_id=revision_id, pb=pb,
1695
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1115
            find_ghosts=find_ghosts)
1696
1116
 
1697
1117
    def create_bundle(self, target, base, fileobj, format=None):
1698
1118
        return serializer.write_bundle(self, target, base, fileobj, format)
1701
1121
                           timezone=None, committer=None, revprops=None,
1702
1122
                           revision_id=None):
1703
1123
        """Obtain a CommitBuilder for this repository.
1704
 
 
 
1124
        
1705
1125
        :param branch: Branch to commit to.
1706
1126
        :param parents: Revision ids of the parents of the new revision.
1707
1127
        :param config: Configuration to use.
1711
1131
        :param revprops: Optional dictionary of revision properties.
1712
1132
        :param revision_id: Optional revision id.
1713
1133
        """
1714
 
        if self._fallback_repositories:
1715
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1716
 
                "to a stacked branch. See "
1717
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1718
1134
        result = self._commit_builder_class(self, parents, config,
1719
1135
            timestamp, timezone, committer, revprops, revision_id)
1720
1136
        self.start_write_group()
1729
1145
                raise errors.BzrError(
1730
1146
                    'Must end write groups before releasing write locks.')
1731
1147
        self.control_files.unlock()
1732
 
        if self.control_files._lock_count == 0:
1733
 
            self._inventory_entry_cache.clear()
1734
 
            for repo in self._fallback_repositories:
1735
 
                repo.unlock()
 
1148
        for repo in self._fallback_repositories:
 
1149
            repo.unlock()
1736
1150
 
1737
1151
    @needs_read_lock
1738
1152
    def clone(self, a_bzrdir, revision_id=None):
1773
1187
 
1774
1188
    def _start_write_group(self):
1775
1189
        """Template method for per-repository write group startup.
1776
 
 
1777
 
        This is called before the write group is considered to be
 
1190
        
 
1191
        This is called before the write group is considered to be 
1778
1192
        entered.
1779
1193
        """
1780
1194
 
1801
1215
                dest_repo = a_bzrdir.open_repository()
1802
1216
        return dest_repo
1803
1217
 
1804
 
    def _get_sink(self):
1805
 
        """Return a sink for streaming into this repository."""
1806
 
        return StreamSink(self)
1807
 
 
1808
 
    def _get_source(self, to_format):
1809
 
        """Return a source for streaming from this repository."""
1810
 
        return StreamSource(self, to_format)
1811
 
 
1812
1218
    @needs_read_lock
1813
1219
    def has_revision(self, revision_id):
1814
1220
        """True if this repository has a copy of the revision."""
1837
1243
    @needs_read_lock
1838
1244
    def get_revision_reconcile(self, revision_id):
1839
1245
        """'reconcile' helper routine that allows access to a revision always.
1840
 
 
 
1246
        
1841
1247
        This variant of get_revision does not cross check the weave graph
1842
1248
        against the revision one as get_revision does: but it should only
1843
1249
        be used by reconcile, or reconcile-alike commands that are correcting
1847
1253
 
1848
1254
    @needs_read_lock
1849
1255
    def get_revisions(self, revision_ids):
1850
 
        """Get many revisions at once.
1851
 
        
1852
 
        Repositories that need to check data on every revision read should 
1853
 
        subclass this method.
1854
 
        """
 
1256
        """Get many revisions at once."""
1855
1257
        return self._get_revisions(revision_ids)
1856
1258
 
1857
1259
    @needs_read_lock
1858
1260
    def _get_revisions(self, revision_ids):
1859
1261
        """Core work logic to get many revisions without sanity checks."""
 
1262
        for rev_id in revision_ids:
 
1263
            if not rev_id or not isinstance(rev_id, basestring):
 
1264
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1265
        keys = [(key,) for key in revision_ids]
 
1266
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1860
1267
        revs = {}
1861
 
        for revid, rev in self._iter_revisions(revision_ids):
1862
 
            if rev is None:
1863
 
                raise errors.NoSuchRevision(self, revid)
1864
 
            revs[revid] = rev
 
1268
        for record in stream:
 
1269
            if record.storage_kind == 'absent':
 
1270
                raise errors.NoSuchRevision(self, record.key[0])
 
1271
            text = record.get_bytes_as('fulltext')
 
1272
            rev = self._serializer.read_revision_from_string(text)
 
1273
            revs[record.key[0]] = rev
1865
1274
        return [revs[revid] for revid in revision_ids]
1866
1275
 
1867
 
    def _iter_revisions(self, revision_ids):
1868
 
        """Iterate over revision objects.
1869
 
 
1870
 
        :param revision_ids: An iterable of revisions to examine. None may be
1871
 
            passed to request all revisions known to the repository. Note that
1872
 
            not all repositories can find unreferenced revisions; for those
1873
 
            repositories only referenced ones will be returned.
1874
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1875
 
            those asked for but not available) are returned as (revid, None).
1876
 
        """
1877
 
        if revision_ids is None:
1878
 
            revision_ids = self.all_revision_ids()
1879
 
        else:
1880
 
            for rev_id in revision_ids:
1881
 
                if not rev_id or not isinstance(rev_id, basestring):
1882
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1883
 
        keys = [(key,) for key in revision_ids]
1884
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1885
 
        for record in stream:
1886
 
            revid = record.key[0]
1887
 
            if record.storage_kind == 'absent':
1888
 
                yield (revid, None)
1889
 
            else:
1890
 
                text = record.get_bytes_as('fulltext')
1891
 
                rev = self._serializer.read_revision_from_string(text)
1892
 
                yield (revid, rev)
1893
 
 
1894
1276
    @needs_read_lock
1895
1277
    def get_revision_xml(self, revision_id):
1896
1278
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1897
1279
        #       would have already do it.
1898
1280
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1899
 
        # TODO: this can't just be replaced by:
1900
 
        # return self._serializer.write_revision_to_string(
1901
 
        #     self.get_revision(revision_id))
1902
 
        # as cStringIO preservers the encoding unlike write_revision_to_string
1903
 
        # or some other call down the path.
1904
1281
        rev = self.get_revision(revision_id)
1905
1282
        rev_tmp = cStringIO.StringIO()
1906
1283
        # the current serializer..
1908
1285
        rev_tmp.seek(0)
1909
1286
        return rev_tmp.getvalue()
1910
1287
 
1911
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1288
    def get_deltas_for_revisions(self, revisions):
1912
1289
        """Produce a generator of revision deltas.
1913
 
 
 
1290
        
1914
1291
        Note that the input is a sequence of REVISIONS, not revision_ids.
1915
1292
        Trees will be held in memory until the generator exits.
1916
1293
        Each delta is relative to the revision's lefthand predecessor.
1917
 
 
1918
 
        :param specific_fileids: if not None, the result is filtered
1919
 
          so that only those file-ids, their parents and their
1920
 
          children are included.
1921
1294
        """
1922
 
        # Get the revision-ids of interest
1923
1295
        required_trees = set()
1924
1296
        for revision in revisions:
1925
1297
            required_trees.add(revision.revision_id)
1926
1298
            required_trees.update(revision.parent_ids[:1])
1927
 
 
1928
 
        # Get the matching filtered trees. Note that it's more
1929
 
        # efficient to pass filtered trees to changes_from() rather
1930
 
        # than doing the filtering afterwards. changes_from() could
1931
 
        # arguably do the filtering itself but it's path-based, not
1932
 
        # file-id based, so filtering before or afterwards is
1933
 
        # currently easier.
1934
 
        if specific_fileids is None:
1935
 
            trees = dict((t.get_revision_id(), t) for
1936
 
                t in self.revision_trees(required_trees))
1937
 
        else:
1938
 
            trees = dict((t.get_revision_id(), t) for
1939
 
                t in self._filtered_revision_trees(required_trees,
1940
 
                specific_fileids))
1941
 
 
1942
 
        # Calculate the deltas
 
1299
        trees = dict((t.get_revision_id(), t) for 
 
1300
                     t in self.revision_trees(required_trees))
1943
1301
        for revision in revisions:
1944
1302
            if not revision.parent_ids:
1945
1303
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1948
1306
            yield trees[revision.revision_id].changes_from(old_tree)
1949
1307
 
1950
1308
    @needs_read_lock
1951
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1309
    def get_revision_delta(self, revision_id):
1952
1310
        """Return the delta for one revision.
1953
1311
 
1954
1312
        The delta is relative to the left-hand predecessor of the
1955
1313
        revision.
1956
 
 
1957
 
        :param specific_fileids: if not None, the result is filtered
1958
 
          so that only those file-ids, their parents and their
1959
 
          children are included.
1960
1314
        """
1961
1315
        r = self.get_revision(revision_id)
1962
 
        return list(self.get_deltas_for_revisions([r],
1963
 
            specific_fileids=specific_fileids))[0]
 
1316
        return list(self.get_deltas_for_revisions([r]))[0]
1964
1317
 
1965
1318
    @needs_write_lock
1966
1319
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1975
1328
    def find_text_key_references(self):
1976
1329
        """Find the text key references within the repository.
1977
1330
 
 
1331
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1332
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1333
        altered it listed explicitly.
1978
1334
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1979
1335
            to whether they were referred to by the inventory of the
1980
1336
            revision_id that they contain. The inventory texts from all present
2011
1367
 
2012
1368
        # this code needs to read every new line in every inventory for the
2013
1369
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2014
 
        # not present in one of those inventories is unnecessary but not
 
1370
        # not present in one of those inventories is unnecessary but not 
2015
1371
        # harmful because we are filtering by the revision id marker in the
2016
 
        # inventory lines : we only select file ids altered in one of those
 
1372
        # inventory lines : we only select file ids altered in one of those  
2017
1373
        # revisions. We don't need to see all lines in the inventory because
2018
1374
        # only those added in an inventory in rev X can contain a revision=X
2019
1375
        # line.
2069
1425
                result[key] = True
2070
1426
        return result
2071
1427
 
2072
 
    def _inventory_xml_lines_for_keys(self, keys):
2073
 
        """Get a line iterator of the sort needed for findind references.
2074
 
 
2075
 
        Not relevant for non-xml inventory repositories.
2076
 
 
2077
 
        Ghosts in revision_keys are ignored.
2078
 
 
2079
 
        :param revision_keys: The revision keys for the inventories to inspect.
2080
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2081
 
            all of the xml inventories specified by revision_keys.
2082
 
        """
2083
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2084
 
        for record in stream:
2085
 
            if record.storage_kind != 'absent':
2086
 
                chunks = record.get_bytes_as('chunked')
2087
 
                revid = record.key[-1]
2088
 
                lines = osutils.chunks_to_lines(chunks)
2089
 
                for line in lines:
2090
 
                    yield line, revid
2091
 
 
2092
1428
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2093
 
        revision_keys):
 
1429
        revision_ids):
2094
1430
        """Helper routine for fileids_altered_by_revision_ids.
2095
1431
 
2096
1432
        This performs the translation of xml lines to revision ids.
2097
1433
 
2098
1434
        :param line_iterator: An iterator of lines, origin_version_id
2099
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1435
        :param revision_ids: The revision ids to filter for. This should be a
2100
1436
            set or other type which supports efficient __contains__ lookups, as
2101
 
            the revision key from each parsed line will be looked up in the
2102
 
            revision_keys filter.
 
1437
            the revision id from each parsed line will be looked up in the
 
1438
            revision_ids filter.
2103
1439
        :return: a dictionary mapping altered file-ids to an iterable of
2104
1440
        revision_ids. Each altered file-ids has the exact revision_ids that
2105
1441
        altered it listed explicitly.
2106
1442
        """
2107
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2108
 
                line_iterator).iterkeys())
2109
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2110
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2111
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2112
 
        new_keys = seen - parent_seen
2113
1443
        result = {}
2114
1444
        setdefault = result.setdefault
2115
 
        for key in new_keys:
2116
 
            setdefault(key[0], set()).add(key[-1])
 
1445
        for key in \
 
1446
            self._find_text_key_references_from_xml_inventory_lines(
 
1447
                line_iterator).iterkeys():
 
1448
            # once data is all ensured-consistent; then this is
 
1449
            # if revision_id == version_id
 
1450
            if key[-1:] in revision_ids:
 
1451
                setdefault(key[0], set()).add(key[-1])
2117
1452
        return result
2118
1453
 
2119
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2120
 
        """Find all parent ids that are mentioned in the revision graph.
2121
 
 
2122
 
        :return: set of revisions that are parents of revision_ids which are
2123
 
            not part of revision_ids themselves
2124
 
        """
2125
 
        parent_map = self.get_parent_map(revision_ids)
2126
 
        parent_ids = set()
2127
 
        map(parent_ids.update, parent_map.itervalues())
2128
 
        parent_ids.difference_update(revision_ids)
2129
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2130
 
        return parent_ids
2131
 
 
2132
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2133
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2134
 
 
2135
 
        :param revision_keys: An iterable of revision_keys.
2136
 
        :return: The parents of all revision_keys that are not already in
2137
 
            revision_keys
2138
 
        """
2139
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2140
 
        parent_keys = set()
2141
 
        map(parent_keys.update, parent_map.itervalues())
2142
 
        parent_keys.difference_update(revision_keys)
2143
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2144
 
        return parent_keys
2145
 
 
2146
1454
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2147
1455
        """Find the file ids and versions affected by revisions.
2148
1456
 
2183
1491
        :param desired_files: a list of (file_id, revision_id, identifier)
2184
1492
            triples
2185
1493
        """
 
1494
        transaction = self.get_transaction()
2186
1495
        text_keys = {}
2187
1496
        for file_id, revision_id, callable_data in desired_files:
2188
1497
            text_keys[(file_id, revision_id)] = callable_data
2189
1498
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2190
1499
            if record.storage_kind == 'absent':
2191
1500
                raise errors.RevisionNotPresent(record.key, self)
2192
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1501
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2193
1502
 
2194
1503
    def _generate_text_key_index(self, text_key_references=None,
2195
1504
        ancestors=None):
2244
1553
        batch_size = 10 # should be ~150MB on a 55K path tree
2245
1554
        batch_count = len(revision_order) / batch_size + 1
2246
1555
        processed_texts = 0
2247
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1556
        pb.update("Calculating text parents.", processed_texts, text_count)
2248
1557
        for offset in xrange(batch_count):
2249
1558
            to_query = revision_order[offset * batch_size:(offset + 1) *
2250
1559
                batch_size]
2251
1560
            if not to_query:
2252
1561
                break
2253
 
            for revision_id in to_query:
 
1562
            for rev_tree in self.revision_trees(to_query):
 
1563
                revision_id = rev_tree.get_revision_id()
2254
1564
                parent_ids = ancestors[revision_id]
2255
1565
                for text_key in revision_keys[revision_id]:
2256
 
                    pb.update("Calculating text parents", processed_texts)
 
1566
                    pb.update("Calculating text parents.", processed_texts)
2257
1567
                    processed_texts += 1
2258
1568
                    candidate_parents = []
2259
1569
                    for parent_id in parent_ids:
2275
1585
                            except KeyError:
2276
1586
                                inv = self.revision_tree(parent_id).inventory
2277
1587
                                inventory_cache[parent_id] = inv
2278
 
                            try:
2279
 
                                parent_entry = inv[text_key[0]]
2280
 
                            except (KeyError, errors.NoSuchId):
2281
 
                                parent_entry = None
 
1588
                            parent_entry = inv._byid.get(text_key[0], None)
2282
1589
                            if parent_entry is not None:
2283
1590
                                parent_text_key = (
2284
1591
                                    text_key[0], parent_entry.revision)
2309
1616
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2310
1617
            'revisions'.  file-id is None unless knit-kind is 'file'.
2311
1618
        """
2312
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2313
 
            yield result
2314
 
        del _files_pb
2315
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2316
 
            yield result
2317
 
 
2318
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2319
1619
        # XXX: it's a bit weird to control the inventory weave caching in this
2320
1620
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2321
1621
        # maybe this generator should explicitly have the contract that it
2328
1628
        count = 0
2329
1629
        num_file_ids = len(file_ids)
2330
1630
        for file_id, altered_versions in file_ids.iteritems():
2331
 
            if pb is not None:
2332
 
                pb.update("Fetch texts", count, num_file_ids)
 
1631
            if _files_pb is not None:
 
1632
                _files_pb.update("fetch texts", count, num_file_ids)
2333
1633
            count += 1
2334
1634
            yield ("file", file_id, altered_versions)
 
1635
        # We're done with the files_pb.  Note that it finished by the caller,
 
1636
        # just as it was created by the caller.
 
1637
        del _files_pb
2335
1638
 
2336
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2337
1639
        # inventory
2338
1640
        yield ("inventory", None, revision_ids)
2339
1641
 
2356
1658
        """Get Inventory object by revision id."""
2357
1659
        return self.iter_inventories([revision_id]).next()
2358
1660
 
2359
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1661
    def iter_inventories(self, revision_ids):
2360
1662
        """Get many inventories by revision_ids.
2361
1663
 
2362
1664
        This will buffer some or all of the texts used in constructing the
2363
1665
        inventories in memory, but will only parse a single inventory at a
2364
1666
        time.
2365
1667
 
2366
 
        :param revision_ids: The expected revision ids of the inventories.
2367
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2368
 
            specified, the order of revision_ids will be preserved (by
2369
 
            buffering if necessary).
2370
1668
        :return: An iterator of inventories.
2371
1669
        """
2372
1670
        if ((None in revision_ids)
2373
1671
            or (_mod_revision.NULL_REVISION in revision_ids)):
2374
1672
            raise ValueError('cannot get null revision inventory')
2375
 
        return self._iter_inventories(revision_ids, ordering)
 
1673
        return self._iter_inventories(revision_ids)
2376
1674
 
2377
 
    def _iter_inventories(self, revision_ids, ordering):
 
1675
    def _iter_inventories(self, revision_ids):
2378
1676
        """single-document based inventory iteration."""
2379
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2380
 
        for text, revision_id in inv_xmls:
 
1677
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
2381
1678
            yield self.deserialise_inventory(revision_id, text)
2382
1679
 
2383
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2384
 
        if ordering is None:
2385
 
            order_as_requested = True
2386
 
            ordering = 'unordered'
2387
 
        else:
2388
 
            order_as_requested = False
 
1680
    def _iter_inventory_xmls(self, revision_ids):
2389
1681
        keys = [(revision_id,) for revision_id in revision_ids]
2390
 
        if not keys:
2391
 
            return
2392
 
        if order_as_requested:
2393
 
            key_iter = iter(keys)
2394
 
            next_key = key_iter.next()
2395
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
2396
 
        text_chunks = {}
 
1682
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1683
        texts = {}
2397
1684
        for record in stream:
2398
1685
            if record.storage_kind != 'absent':
2399
 
                chunks = record.get_bytes_as('chunked')
2400
 
                if order_as_requested:
2401
 
                    text_chunks[record.key] = chunks
2402
 
                else:
2403
 
                    yield ''.join(chunks), record.key[-1]
 
1686
                texts[record.key] = record.get_bytes_as('fulltext')
2404
1687
            else:
2405
1688
                raise errors.NoSuchRevision(self, record.key)
2406
 
            if order_as_requested:
2407
 
                # Yield as many results as we can while preserving order.
2408
 
                while next_key in text_chunks:
2409
 
                    chunks = text_chunks.pop(next_key)
2410
 
                    yield ''.join(chunks), next_key[-1]
2411
 
                    try:
2412
 
                        next_key = key_iter.next()
2413
 
                    except StopIteration:
2414
 
                        # We still want to fully consume the get_record_stream,
2415
 
                        # just in case it is not actually finished at this point
2416
 
                        next_key = None
2417
 
                        break
 
1689
        for key in keys:
 
1690
            yield texts[key], key[-1]
2418
1691
 
2419
1692
    def deserialise_inventory(self, revision_id, xml):
2420
 
        """Transform the xml into an inventory object.
 
1693
        """Transform the xml into an inventory object. 
2421
1694
 
2422
1695
        :param revision_id: The expected revision id of the inventory.
2423
1696
        :param xml: A serialised inventory.
2424
1697
        """
2425
 
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2426
 
                    entry_cache=self._inventory_entry_cache)
 
1698
        result = self._serializer.read_inventory_from_string(xml, revision_id)
2427
1699
        if result.revision_id != revision_id:
2428
1700
            raise AssertionError('revision id mismatch %s != %s' % (
2429
1701
                result.revision_id, revision_id))
2441
1713
    @needs_read_lock
2442
1714
    def get_inventory_xml(self, revision_id):
2443
1715
        """Get inventory XML as a file object."""
2444
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1716
        texts = self._iter_inventory_xmls([revision_id])
2445
1717
        try:
2446
1718
            text, revision_id = texts.next()
2447
1719
        except StopIteration:
2454
1726
        """
2455
1727
        return self.get_revision(revision_id).inventory_sha1
2456
1728
 
2457
 
    def get_rev_id_for_revno(self, revno, known_pair):
2458
 
        """Return the revision id of a revno, given a later (revno, revid)
2459
 
        pair in the same history.
2460
 
 
2461
 
        :return: if found (True, revid).  If the available history ran out
2462
 
            before reaching the revno, then this returns
2463
 
            (False, (closest_revno, closest_revid)).
2464
 
        """
2465
 
        known_revno, known_revid = known_pair
2466
 
        partial_history = [known_revid]
2467
 
        distance_from_known = known_revno - revno
2468
 
        if distance_from_known < 0:
2469
 
            raise ValueError(
2470
 
                'requested revno (%d) is later than given known revno (%d)'
2471
 
                % (revno, known_revno))
2472
 
        try:
2473
 
            _iter_for_revno(
2474
 
                self, partial_history, stop_index=distance_from_known)
2475
 
        except errors.RevisionNotPresent, err:
2476
 
            if err.revision_id == known_revid:
2477
 
                # The start revision (known_revid) wasn't found.
2478
 
                raise
2479
 
            # This is a stacked repository with no fallbacks, or a there's a
2480
 
            # left-hand ghost.  Either way, even though the revision named in
2481
 
            # the error isn't in this repo, we know it's the next step in this
2482
 
            # left-hand history.
2483
 
            partial_history.append(err.revision_id)
2484
 
        if len(partial_history) <= distance_from_known:
2485
 
            # Didn't find enough history to get a revid for the revno.
2486
 
            earliest_revno = known_revno - len(partial_history) + 1
2487
 
            return (False, (earliest_revno, partial_history[-1]))
2488
 
        if len(partial_history) - 1 > distance_from_known:
2489
 
            raise AssertionError('_iter_for_revno returned too much history')
2490
 
        return (True, partial_history[-1])
2491
 
 
2492
1729
    def iter_reverse_revision_history(self, revision_id):
2493
1730
        """Iterate backwards through revision ids in the lefthand history
2494
1731
 
2500
1737
        while True:
2501
1738
            if next_id in (None, _mod_revision.NULL_REVISION):
2502
1739
                return
2503
 
            try:
2504
 
                parents = graph.get_parent_map([next_id])[next_id]
2505
 
            except KeyError:
2506
 
                raise errors.RevisionNotPresent(next_id, self)
2507
1740
            yield next_id
 
1741
            # Note: The following line may raise KeyError in the event of
 
1742
            # truncated history. We decided not to have a try:except:raise
 
1743
            # RevisionNotPresent here until we see a use for it, because of the
 
1744
            # cost in an inner loop that is by its very nature O(history).
 
1745
            # Robert Collins 20080326
 
1746
            parents = graph.get_parent_map([next_id])[next_id]
2508
1747
            if len(parents) == 0:
2509
1748
                return
2510
1749
            else:
2545
1784
        for repositories to maintain loaded indices across multiple locks
2546
1785
        by checking inside their implementation of this method to see
2547
1786
        whether their indices are still valid. This depends of course on
2548
 
        the disk format being validatable in this manner. This method is
2549
 
        also called by the refresh_data() public interface to cause a refresh
2550
 
        to occur while in a write lock so that data inserted by a smart server
2551
 
        push operation is visible on the client's instance of the physical
2552
 
        repository.
 
1787
        the disk format being validatable in this manner.
2553
1788
        """
2554
1789
 
2555
1790
    @needs_read_lock
2562
1797
        # TODO: refactor this to use an existing revision object
2563
1798
        # so we don't need to read it in twice.
2564
1799
        if revision_id == _mod_revision.NULL_REVISION:
2565
 
            return RevisionTree(self, Inventory(root_id=None),
 
1800
            return RevisionTree(self, Inventory(root_id=None), 
2566
1801
                                _mod_revision.NULL_REVISION)
2567
1802
        else:
2568
1803
            inv = self.get_revision_inventory(revision_id)
2569
1804
            return RevisionTree(self, inv, revision_id)
2570
1805
 
2571
1806
    def revision_trees(self, revision_ids):
2572
 
        """Return Trees for revisions in this repository.
 
1807
        """Return Tree for a revision on this branch.
2573
1808
 
2574
 
        :param revision_ids: a sequence of revision-ids;
2575
 
          a revision-id may not be None or 'null:'
2576
 
        """
 
1809
        `revision_id` may not be None or 'null:'"""
2577
1810
        inventories = self.iter_inventories(revision_ids)
2578
1811
        for inv in inventories:
2579
1812
            yield RevisionTree(self, inv, inv.revision_id)
2580
1813
 
2581
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2582
 
        """Return Tree for a revision on this branch with only some files.
2583
 
 
2584
 
        :param revision_ids: a sequence of revision-ids;
2585
 
          a revision-id may not be None or 'null:'
2586
 
        :param file_ids: if not None, the result is filtered
2587
 
          so that only those file-ids, their parents and their
2588
 
          children are included.
2589
 
        """
2590
 
        inventories = self.iter_inventories(revision_ids)
2591
 
        for inv in inventories:
2592
 
            # Should we introduce a FilteredRevisionTree class rather
2593
 
            # than pre-filter the inventory here?
2594
 
            filtered_inv = inv.filter(file_ids)
2595
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2596
 
 
2597
1814
    @needs_read_lock
2598
1815
    def get_ancestry(self, revision_id, topo_sorted=True):
2599
1816
        """Return a list of revision-ids integrated by a revision.
2600
1817
 
2601
 
        The first element of the list is always None, indicating the origin
2602
 
        revision.  This might change when we have history horizons, or
 
1818
        The first element of the list is always None, indicating the origin 
 
1819
        revision.  This might change when we have history horizons, or 
2603
1820
        perhaps we should have a new API.
2604
 
 
 
1821
        
2605
1822
        This is topologically sorted.
2606
1823
        """
2607
1824
        if _mod_revision.is_null(revision_id):
2624
1841
            keys = tsort.topo_sort(parent_map)
2625
1842
        return [None] + list(keys)
2626
1843
 
2627
 
    def pack(self, hint=None):
 
1844
    def pack(self):
2628
1845
        """Compress the data within the repository.
2629
1846
 
2630
1847
        This operation only makes sense for some repository types. For other
2631
1848
        types it should be a no-op that just returns.
2632
1849
 
2633
1850
        This stub method does not require a lock, but subclasses should use
2634
 
        @needs_write_lock as this is a long running call its reasonable to
 
1851
        @needs_write_lock as this is a long running call its reasonable to 
2635
1852
        implicitly lock for the user.
 
1853
        """
2636
1854
 
2637
 
        :param hint: If not supplied, the whole repository is packed.
2638
 
            If supplied, the repository may use the hint parameter as a
2639
 
            hint for the parts of the repository to pack. A hint can be
2640
 
            obtained from the result of commit_write_group(). Out of
2641
 
            date hints are simply ignored, because concurrent operations
2642
 
            can obsolete them rapidly.
 
1855
    @needs_read_lock
 
1856
    @deprecated_method(one_six)
 
1857
    def print_file(self, file, revision_id):
 
1858
        """Print `file` to stdout.
 
1859
        
 
1860
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1861
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1862
        by creating a new more flexible convenience function.
2643
1863
        """
 
1864
        tree = self.revision_tree(revision_id)
 
1865
        # use inventory as it was in that revision
 
1866
        file_id = tree.inventory.path2id(file)
 
1867
        if not file_id:
 
1868
            # TODO: jam 20060427 Write a test for this code path
 
1869
            #       it had a bug in it, and was raising the wrong
 
1870
            #       exception.
 
1871
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1872
        tree.print_file(file_id)
2644
1873
 
2645
1874
    def get_transaction(self):
2646
1875
        return self.control_files.get_transaction()
2647
1876
 
 
1877
    @deprecated_method(one_one)
 
1878
    def get_parents(self, revision_ids):
 
1879
        """See StackedParentsProvider.get_parents"""
 
1880
        parent_map = self.get_parent_map(revision_ids)
 
1881
        return [parent_map.get(r, None) for r in revision_ids]
 
1882
 
2648
1883
    def get_parent_map(self, revision_ids):
2649
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1884
        """See graph._StackedParentsProvider.get_parent_map"""
2650
1885
        # revisions index works in keys; this just works in revisions
2651
1886
        # therefore wrap and unwrap
2652
1887
        query_keys = []
2675
1910
        parents_provider = self._make_parents_provider()
2676
1911
        if (other_repository is not None and
2677
1912
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
1913
            parents_provider = graph._StackedParentsProvider(
2679
1914
                [parents_provider, other_repository._make_parents_provider()])
2680
1915
        return graph.Graph(parents_provider)
2681
1916
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
2684
 
        """Return an object suitable for checking versioned files.
2685
 
        
2686
 
        :param text_key_references: if non-None, an already built
2687
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2688
 
            to whether they were referred to by the inventory of the
2689
 
            revision_id that they contain. If None, this will be
2690
 
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
 
        """
2695
 
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
1917
    def _get_versioned_file_checker(self):
 
1918
        """Return an object suitable for checking versioned files."""
 
1919
        return _VersionedFileChecker(self)
2697
1920
 
2698
1921
    def revision_ids_to_search_result(self, result_set):
2699
1922
        """Convert a set of revision ids to a graph SearchResult."""
2719
1942
                          working trees.
2720
1943
        """
2721
1944
        raise NotImplementedError(self.set_make_working_trees)
2722
 
 
 
1945
    
2723
1946
    def make_working_trees(self):
2724
1947
        """Returns the policy for making working trees on new branches."""
2725
1948
        raise NotImplementedError(self.make_working_trees)
2749
1972
        return record.get_bytes_as('fulltext')
2750
1973
 
2751
1974
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1975
    def check(self, revision_ids=None):
2753
1976
        """Check consistency of all history of given revision_ids.
2754
1977
 
2755
1978
        Different repository implementations should override _check().
2756
1979
 
2757
1980
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
1981
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
1982
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
1983
        return self._check(revision_ids)
2767
1984
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
1985
    def _check(self, revision_ids):
 
1986
        result = check.Check(self)
 
1987
        result.check()
2771
1988
        return result
2772
1989
 
2773
1990
    def _warn_if_deprecated(self):
2796
2013
                    revision_id.decode('ascii')
2797
2014
                except UnicodeDecodeError:
2798
2015
                    raise errors.NonAsciiRevisionId(method, self)
2799
 
 
 
2016
    
2800
2017
    def revision_graph_can_have_wrong_parents(self):
2801
2018
        """Is it possible for this repository to have a revision graph with
2802
2019
        incorrect parents?
2856
2073
    """
2857
2074
    repository.start_write_group()
2858
2075
    try:
2859
 
        inventory_cache = lru_cache.LRUCache(10)
2860
2076
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2861
 
            _install_revision(repository, revision, revision_tree, signature,
2862
 
                inventory_cache)
 
2077
            _install_revision(repository, revision, revision_tree, signature)
2863
2078
            if pb is not None:
2864
2079
                pb.update('Transferring revisions', n + 1, num_revisions)
2865
2080
    except:
2869
2084
        repository.commit_write_group()
2870
2085
 
2871
2086
 
2872
 
def _install_revision(repository, rev, revision_tree, signature,
2873
 
    inventory_cache):
 
2087
def _install_revision(repository, rev, revision_tree, signature):
2874
2088
    """Install all revision data into a repository."""
2875
2089
    present_parents = []
2876
2090
    parent_trees = {}
2913
2127
        repository.texts.add_lines(text_key, text_parents, lines)
2914
2128
    try:
2915
2129
        # install the inventory
2916
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2917
 
            # Cache this inventory
2918
 
            inventory_cache[rev.revision_id] = inv
2919
 
            try:
2920
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2921
 
            except KeyError:
2922
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2923
 
            else:
2924
 
                delta = inv._make_delta(basis_inv)
2925
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2926
 
                    rev.revision_id, present_parents)
2927
 
        else:
2928
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2130
        repository.add_inventory(rev.revision_id, inv, present_parents)
2929
2131
    except errors.RevisionAlreadyPresent:
2930
2132
        pass
2931
2133
    if signature is not None:
2935
2137
 
2936
2138
class MetaDirRepository(Repository):
2937
2139
    """Repositories in the new meta-dir layout.
2938
 
 
 
2140
    
2939
2141
    :ivar _transport: Transport for access to repository control files,
2940
2142
        typically pointing to .bzr/repository.
2941
2143
    """
2966
2168
        else:
2967
2169
            self._transport.put_bytes('no-working-trees', '',
2968
2170
                mode=self.bzrdir._get_file_mode())
2969
 
 
 
2171
    
2970
2172
    def make_working_trees(self):
2971
2173
        """Returns the policy for making working trees on new branches."""
2972
2174
        return not self._transport.has('no-working-trees')
2980
2182
            control_files)
2981
2183
 
2982
2184
 
2983
 
network_format_registry = registry.FormatRegistry()
2984
 
"""Registry of formats indexed by their network name.
2985
 
 
2986
 
The network name for a repository format is an identifier that can be used when
2987
 
referring to formats with smart server operations. See
2988
 
RepositoryFormat.network_name() for more detail.
2989
 
"""
2990
 
 
2991
 
 
2992
 
format_registry = registry.FormatRegistry(network_format_registry)
2993
 
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
2185
class RepositoryFormatRegistry(registry.Registry):
 
2186
    """Registry of RepositoryFormats."""
 
2187
 
 
2188
    def get(self, format_string):
 
2189
        r = registry.Registry.get(self, format_string)
 
2190
        if callable(r):
 
2191
            r = r()
 
2192
        return r
 
2193
    
 
2194
 
 
2195
format_registry = RepositoryFormatRegistry()
 
2196
"""Registry of formats, indexed by their identifying format string.
2994
2197
 
2995
2198
This can contain either format instances themselves, or classes/factories that
2996
2199
can be called to obtain one.
3003
2206
class RepositoryFormat(object):
3004
2207
    """A repository format.
3005
2208
 
3006
 
    Formats provide four things:
 
2209
    Formats provide three things:
3007
2210
     * An initialization routine to construct repository data on disk.
3008
 
     * a optional format string which is used when the BzrDir supports
3009
 
       versioned children.
 
2211
     * a format string which is used when the BzrDir supports versioned
 
2212
       children.
3010
2213
     * an open routine which returns a Repository instance.
3011
 
     * A network name for referring to the format in smart server RPC
3012
 
       methods.
3013
2214
 
3014
2215
    There is one and only one Format subclass for each on-disk format. But
3015
2216
    there can be one Repository subclass that is used for several different
3016
2217
    formats. The _format attribute on a Repository instance can be used to
3017
2218
    determine the disk format.
3018
2219
 
3019
 
    Formats are placed in a registry by their format string for reference
3020
 
    during opening. These should be subclasses of RepositoryFormat for
3021
 
    consistency.
 
2220
    Formats are placed in an dict by their format string for reference 
 
2221
    during opening. These should be subclasses of RepositoryFormat
 
2222
    for consistency.
3022
2223
 
3023
2224
    Once a format is deprecated, just deprecate the initialize and open
3024
 
    methods on the format class. Do not deprecate the object, as the
3025
 
    object may be created even when a repository instance hasn't been
3026
 
    created.
 
2225
    methods on the format class. Do not deprecate the object, as the 
 
2226
    object will be created every system load.
3027
2227
 
3028
2228
    Common instance attributes:
3029
2229
    _matchingbzrdir - the bzrdir format that the repository format was
3038
2238
    # Can this repository be given external locations to lookup additional
3039
2239
    # data. Set to True or False in derived classes.
3040
2240
    supports_external_lookups = None
3041
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3042
 
    # derived classes.
3043
 
    supports_chks = None
3044
 
    # Should commit add an inventory, or an inventory delta to the repository.
3045
 
    _commit_inv_deltas = True
3046
 
    # What order should fetch operations request streams in?
3047
 
    # The default is unordered as that is the cheapest for an origin to
3048
 
    # provide.
3049
 
    _fetch_order = 'unordered'
3050
 
    # Does this repository format use deltas that can be fetched as-deltas ?
3051
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3052
 
    # We default to False, which will ensure that enough data to get
3053
 
    # a full text out of any fetch stream will be grabbed.
3054
 
    _fetch_uses_deltas = False
3055
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
3056
 
    # some repository formats that can suffer internal inconsistencies.
3057
 
    _fetch_reconcile = False
3058
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3059
 
    # code path for commit, amongst other things.
3060
 
    fast_deltas = None
3061
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3062
 
    # (so if there is one pack, the operation can still proceed because it may
3063
 
    # help), and for fetching when data won't have come from the same
3064
 
    # compressor.
3065
 
    pack_compresses = False
3066
 
    # Does the repository inventory storage understand references to trees?
3067
 
    supports_tree_reference = None
3068
2241
 
3069
2242
    def __str__(self):
3070
2243
        return "<%s>" % self.__class__.__name__
3079
2252
    @classmethod
3080
2253
    def find_format(klass, a_bzrdir):
3081
2254
        """Return the format for the repository object in a_bzrdir.
3082
 
 
 
2255
        
3083
2256
        This is used by bzr native formats that have a "format" file in
3084
 
        the repository.  Other methods may be used by different types of
 
2257
        the repository.  Other methods may be used by different types of 
3085
2258
        control directory.
3086
2259
        """
3087
2260
        try:
3101
2274
    @classmethod
3102
2275
    def unregister_format(klass, format):
3103
2276
        format_registry.remove(format.get_format_string())
3104
 
 
 
2277
    
3105
2278
    @classmethod
3106
2279
    def get_default_format(klass):
3107
2280
        """Return the current default format."""
3110
2283
 
3111
2284
    def get_format_string(self):
3112
2285
        """Return the ASCII format string that identifies this format.
3113
 
 
3114
 
        Note that in pre format ?? repositories the format string is
 
2286
        
 
2287
        Note that in pre format ?? repositories the format string is 
3115
2288
        not permitted nor written to disk.
3116
2289
        """
3117
2290
        raise NotImplementedError(self.get_format_string)
3148
2321
        :param a_bzrdir: The bzrdir to put the new repository in it.
3149
2322
        :param shared: The repository should be initialized as a sharable one.
3150
2323
        :returns: The new repository object.
3151
 
 
 
2324
        
3152
2325
        This may raise UninitializableFormat if shared repository are not
3153
2326
        compatible the a_bzrdir.
3154
2327
        """
3158
2331
        """Is this format supported?
3159
2332
 
3160
2333
        Supported formats must be initializable and openable.
3161
 
        Unsupported formats may not support initialization or committing or
 
2334
        Unsupported formats may not support initialization or committing or 
3162
2335
        some other features depending on the reason for not being supported.
3163
2336
        """
3164
2337
        return True
3165
2338
 
3166
 
    def network_name(self):
3167
 
        """A simple byte string uniquely identifying this format for RPC calls.
3168
 
 
3169
 
        MetaDir repository formats use their disk format string to identify the
3170
 
        repository over the wire. All in one formats such as bzr < 0.8, and
3171
 
        foreign formats like svn/git and hg should use some marker which is
3172
 
        unique and immutable.
3173
 
        """
3174
 
        raise NotImplementedError(self.network_name)
3175
 
 
3176
2339
    def check_conversion_target(self, target_format):
3177
 
        if self.rich_root_data and not target_format.rich_root_data:
3178
 
            raise errors.BadConversionTarget(
3179
 
                'Does not support rich root data.', target_format,
3180
 
                from_format=self)
3181
 
        if (self.supports_tree_reference and 
3182
 
            not getattr(target_format, 'supports_tree_reference', False)):
3183
 
            raise errors.BadConversionTarget(
3184
 
                'Does not support nested trees', target_format,
3185
 
                from_format=self)
 
2340
        raise NotImplementedError(self.check_conversion_target)
3186
2341
 
3187
2342
    def open(self, a_bzrdir, _found=False):
3188
2343
        """Return an instance of this format for the bzrdir a_bzrdir.
3189
 
 
 
2344
        
3190
2345
        _found is a private parameter, do not use it.
3191
2346
        """
3192
2347
        raise NotImplementedError(self.open)
3236
2391
        finally:
3237
2392
            control_files.unlock()
3238
2393
 
3239
 
    def network_name(self):
3240
 
        """Metadir formats have matching disk and network format strings."""
3241
 
        return self.get_format_string()
3242
 
 
3243
 
 
3244
 
# Pre-0.8 formats that don't have a disk format string (because they are
3245
 
# versioned by the matching control directory). We use the control directories
3246
 
# disk format string as a key for the network_name because they meet the
3247
 
# constraints (simple string, unique, immutable).
3248
 
network_format_registry.register_lazy(
3249
 
    "Bazaar-NG branch, format 5\n",
3250
 
    'bzrlib.repofmt.weaverepo',
3251
 
    'RepositoryFormat5',
3252
 
)
3253
 
network_format_registry.register_lazy(
3254
 
    "Bazaar-NG branch, format 6\n",
3255
 
    'bzrlib.repofmt.weaverepo',
3256
 
    'RepositoryFormat6',
3257
 
)
3258
 
 
3259
 
# formats which have no format string are not discoverable or independently
3260
 
# creatable on disk, so are not registered in format_registry.  They're
 
2394
 
 
2395
# formats which have no format string are not discoverable
 
2396
# and not independently creatable, so are not registered.  They're 
3261
2397
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3262
2398
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3263
2399
# the repository is not separately opened are similar.
3330
2466
    'RepositoryFormatKnitPack6RichRoot',
3331
2467
    )
3332
2468
 
3333
 
# Development formats.
3334
 
# Obsolete but kept pending a CHK based subtree format.
 
2469
# Development formats. 
 
2470
# 1.7->1.8 go below here
 
2471
format_registry.register_lazy(
 
2472
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2473
    'bzrlib.repofmt.pack_repo',
 
2474
    'RepositoryFormatPackDevelopment2',
 
2475
    )
3335
2476
format_registry.register_lazy(
3336
2477
    ("Bazaar development format 2 with subtree support "
3337
2478
        "(needs bzr.dev from before 1.8)\n"),
3339
2480
    'RepositoryFormatPackDevelopment2Subtree',
3340
2481
    )
3341
2482
 
3342
 
# 1.14->1.16 go below here
3343
 
format_registry.register_lazy(
3344
 
    'Bazaar development format - group compression and chk inventory'
3345
 
        ' (needs bzr.dev from 1.14)\n',
3346
 
    'bzrlib.repofmt.groupcompress_repo',
3347
 
    'RepositoryFormatCHK1',
3348
 
    )
3349
 
 
3350
 
format_registry.register_lazy(
3351
 
    'Bazaar development format - chk repository with bencode revision '
3352
 
        'serialization (needs bzr.dev from 1.16)\n',
3353
 
    'bzrlib.repofmt.groupcompress_repo',
3354
 
    'RepositoryFormatCHK2',
3355
 
    )
3356
 
format_registry.register_lazy(
3357
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3358
 
    'bzrlib.repofmt.groupcompress_repo',
3359
 
    'RepositoryFormat2a',
3360
 
    )
3361
 
 
3362
2483
 
3363
2484
class InterRepository(InterObject):
3364
2485
    """This class represents operations taking place between two repositories.
3365
2486
 
3366
2487
    Its instances have methods like copy_content and fetch, and contain
3367
 
    references to the source and target repositories these operations can be
 
2488
    references to the source and target repositories these operations can be 
3368
2489
    carried out on.
3369
2490
 
3370
2491
    Often we will provide convenience methods on 'repository' which carry out
3372
2493
    InterRepository.get(other).method_name(parameters).
3373
2494
    """
3374
2495
 
3375
 
    _walk_to_common_revisions_batch_size = 50
 
2496
    _walk_to_common_revisions_batch_size = 1
3376
2497
    _optimisers = []
3377
2498
    """The available optimised InterRepository types."""
3378
2499
 
3379
 
    @needs_write_lock
 
2500
    def __init__(self, source, target):
 
2501
        InterObject.__init__(self, source, target)
 
2502
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2503
        # provide a faster implementation.
 
2504
        self.target_get_graph = self.target.get_graph
 
2505
        self.target_get_parent_map = self.target.get_parent_map
 
2506
 
3380
2507
    def copy_content(self, revision_id=None):
3381
 
        """Make a complete copy of the content in self into destination.
3382
 
 
3383
 
        This is a destructive operation! Do not use it on existing
3384
 
        repositories.
3385
 
 
3386
 
        :param revision_id: Only copy the content needed to construct
3387
 
                            revision_id and its parents.
3388
 
        """
3389
 
        try:
3390
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3391
 
        except NotImplementedError:
3392
 
            pass
3393
 
        self.target.fetch(self.source, revision_id=revision_id)
3394
 
 
3395
 
    @needs_write_lock
3396
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3397
 
            fetch_spec=None):
 
2508
        raise NotImplementedError(self.copy_content)
 
2509
 
 
2510
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3398
2511
        """Fetch the content required to construct revision_id.
3399
2512
 
3400
2513
        The content is copied from self.source to self.target.
3403
2516
                            content is copied.
3404
2517
        :param pb: optional progress bar to use for progress reports. If not
3405
2518
                   provided a default one will be created.
3406
 
        :return: None.
 
2519
 
 
2520
        :returns: (copied_revision_count, failures).
3407
2521
        """
3408
 
        from bzrlib.fetch import RepoFetcher
3409
 
        f = RepoFetcher(to_repository=self.target,
3410
 
                               from_repository=self.source,
3411
 
                               last_revision=revision_id,
3412
 
                               fetch_spec=fetch_spec,
3413
 
                               pb=pb, find_ghosts=find_ghosts)
 
2522
        # Normally we should find a specific InterRepository subclass to do
 
2523
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2524
        # If none of them is suitable it looks like fetching is not possible;
 
2525
        # we try to give a good message why.  _assert_same_model will probably
 
2526
        # give a helpful message; otherwise a generic one.
 
2527
        self._assert_same_model(self.source, self.target)
 
2528
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2529
            "no suitableInterRepository found")
3414
2530
 
3415
2531
    def _walk_to_common_revisions(self, revision_ids):
3416
2532
        """Walk out from revision_ids in source to revisions target has.
3418
2534
        :param revision_ids: The start point for the search.
3419
2535
        :return: A set of revision ids.
3420
2536
        """
3421
 
        target_graph = self.target.get_graph()
 
2537
        target_graph = self.target_get_graph()
3422
2538
        revision_ids = frozenset(revision_ids)
 
2539
        # Fast path for the case where all the revisions are already in the
 
2540
        # target repo.
 
2541
        # (Although this does incur an extra round trip for the
 
2542
        # fairly common case where the target doesn't already have the revision
 
2543
        # we're pushing.)
 
2544
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2545
            return graph.SearchResult(revision_ids, set(), 0, set())
3423
2546
        missing_revs = set()
3424
2547
        source_graph = self.source.get_graph()
3425
2548
        # ensure we don't pay silly lookup costs.
3464
2587
                break
3465
2588
        return searcher.get_result()
3466
2589
 
 
2590
    @deprecated_method(one_two)
 
2591
    @needs_read_lock
 
2592
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2593
        """Return the revision ids that source has that target does not.
 
2594
        
 
2595
        These are returned in topological order.
 
2596
 
 
2597
        :param revision_id: only return revision ids included by this
 
2598
                            revision_id.
 
2599
        :param find_ghosts: If True find missing revisions in deep history
 
2600
            rather than just finding the surface difference.
 
2601
        """
 
2602
        return list(self.search_missing_revision_ids(
 
2603
            revision_id, find_ghosts).get_keys())
 
2604
 
3467
2605
    @needs_read_lock
3468
2606
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3469
2607
        """Return the revision ids that source has that target does not.
3470
 
 
 
2608
        
3471
2609
        :param revision_id: only return revision ids included by this
3472
2610
                            revision_id.
3473
2611
        :param find_ghosts: If True find missing revisions in deep history
3492
2630
    @staticmethod
3493
2631
    def _same_model(source, target):
3494
2632
        """True if source and target have the same data representation.
3495
 
 
 
2633
        
3496
2634
        Note: this is always called on the base class; overriding it in a
3497
2635
        subclass will have no effect.
3498
2636
        """
3516
2654
 
3517
2655
class InterSameDataRepository(InterRepository):
3518
2656
    """Code for converting between repositories that represent the same data.
3519
 
 
 
2657
    
3520
2658
    Data format and model must match for this to work.
3521
2659
    """
3522
2660
 
3523
2661
    @classmethod
3524
2662
    def _get_repo_format_to_test(self):
3525
2663
        """Repository format for testing with.
3526
 
 
 
2664
        
3527
2665
        InterSameData can pull from subtree to subtree and from non-subtree to
3528
2666
        non-subtree, so we test this with the richest repository format.
3529
2667
        """
3534
2672
    def is_compatible(source, target):
3535
2673
        return InterRepository._same_model(source, target)
3536
2674
 
 
2675
    @needs_write_lock
 
2676
    def copy_content(self, revision_id=None):
 
2677
        """Make a complete copy of the content in self into destination.
 
2678
 
 
2679
        This copies both the repository's revision data, and configuration information
 
2680
        such as the make_working_trees setting.
 
2681
        
 
2682
        This is a destructive operation! Do not use it on existing 
 
2683
        repositories.
 
2684
 
 
2685
        :param revision_id: Only copy the content needed to construct
 
2686
                            revision_id and its parents.
 
2687
        """
 
2688
        try:
 
2689
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2690
        except NotImplementedError:
 
2691
            pass
 
2692
        # but don't bother fetching if we have the needed data now.
 
2693
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2694
            self.target.has_revision(revision_id)):
 
2695
            return
 
2696
        self.target.fetch(self.source, revision_id=revision_id)
 
2697
 
 
2698
    @needs_write_lock
 
2699
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2700
        """See InterRepository.fetch()."""
 
2701
        from bzrlib.fetch import RepoFetcher
 
2702
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2703
               self.source, self.source._format, self.target,
 
2704
               self.target._format)
 
2705
        f = RepoFetcher(to_repository=self.target,
 
2706
                               from_repository=self.source,
 
2707
                               last_revision=revision_id,
 
2708
                               pb=pb, find_ghosts=find_ghosts)
 
2709
        return f.count_copied, f.failed_revisions
 
2710
 
3537
2711
 
3538
2712
class InterWeaveRepo(InterSameDataRepository):
3539
2713
    """Optimised code paths between Weave based repositories.
3540
 
 
 
2714
    
3541
2715
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3542
2716
    implemented lazy inter-object optimisation.
3543
2717
    """
3550
2724
    @staticmethod
3551
2725
    def is_compatible(source, target):
3552
2726
        """Be compatible with known Weave formats.
3553
 
 
 
2727
        
3554
2728
        We don't test for the stores being of specific types because that
3555
 
        could lead to confusing results, and there is no need to be
 
2729
        could lead to confusing results, and there is no need to be 
3556
2730
        overly general.
3557
2731
        """
3558
2732
        from bzrlib.repofmt.weaverepo import (
3569
2743
                                                RepositoryFormat7)))
3570
2744
        except AttributeError:
3571
2745
            return False
3572
 
 
 
2746
    
3573
2747
    @needs_write_lock
3574
2748
    def copy_content(self, revision_id=None):
3575
2749
        """See InterRepository.copy_content()."""
3585
2759
                self.target.texts.insert_record_stream(
3586
2760
                    self.source.texts.get_record_stream(
3587
2761
                        self.source.texts.keys(), 'topological', False))
3588
 
                pb.update('Copying inventory', 0, 1)
 
2762
                pb.update('copying inventory', 0, 1)
3589
2763
                self.target.inventories.insert_record_stream(
3590
2764
                    self.source.inventories.get_record_stream(
3591
2765
                        self.source.inventories.keys(), 'topological', False))
3602
2776
        else:
3603
2777
            self.target.fetch(self.source, revision_id=revision_id)
3604
2778
 
 
2779
    @needs_write_lock
 
2780
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2781
        """See InterRepository.fetch()."""
 
2782
        from bzrlib.fetch import RepoFetcher
 
2783
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2784
               self.source, self.source._format, self.target, self.target._format)
 
2785
        f = RepoFetcher(to_repository=self.target,
 
2786
                               from_repository=self.source,
 
2787
                               last_revision=revision_id,
 
2788
                               pb=pb, find_ghosts=find_ghosts)
 
2789
        return f.count_copied, f.failed_revisions
 
2790
 
3605
2791
    @needs_read_lock
3606
2792
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3607
2793
        """See InterRepository.missing_revision_ids()."""
3608
2794
        # we want all revisions to satisfy revision_id in source.
3609
2795
        # but we don't want to stat every file here and there.
3610
 
        # we want then, all revisions other needs to satisfy revision_id
 
2796
        # we want then, all revisions other needs to satisfy revision_id 
3611
2797
        # checked, but not those that we have locally.
3612
 
        # so the first thing is to get a subset of the revisions to
 
2798
        # so the first thing is to get a subset of the revisions to 
3613
2799
        # satisfy revision_id in source, and then eliminate those that
3614
 
        # we do already have.
3615
 
        # this is slow on high latency connection to self, but as this
3616
 
        # disk format scales terribly for push anyway due to rewriting
 
2800
        # we do already have. 
 
2801
        # this is slow on high latency connection to self, but as as this
 
2802
        # disk format scales terribly for push anyway due to rewriting 
3617
2803
        # inventory.weave, this is considered acceptable.
3618
2804
        # - RBC 20060209
3619
2805
        if revision_id is not None:
3639
2825
            # and the tip revision was validated by get_ancestry.
3640
2826
            result_set = required_revisions
3641
2827
        else:
3642
 
            # if we just grabbed the possibly available ids, then
 
2828
            # if we just grabbed the possibly available ids, then 
3643
2829
            # we only have an estimate of whats available and need to validate
3644
2830
            # that against the revision records.
3645
2831
            result_set = set(
3658
2844
    @staticmethod
3659
2845
    def is_compatible(source, target):
3660
2846
        """Be compatible with known Knit formats.
3661
 
 
 
2847
        
3662
2848
        We don't test for the stores being of specific types because that
3663
 
        could lead to confusing results, and there is no need to be
 
2849
        could lead to confusing results, and there is no need to be 
3664
2850
        overly general.
3665
2851
        """
3666
2852
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3671
2857
            return False
3672
2858
        return are_knits and InterRepository._same_model(source, target)
3673
2859
 
 
2860
    @needs_write_lock
 
2861
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2862
        """See InterRepository.fetch()."""
 
2863
        from bzrlib.fetch import RepoFetcher
 
2864
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2865
               self.source, self.source._format, self.target, self.target._format)
 
2866
        f = RepoFetcher(to_repository=self.target,
 
2867
                            from_repository=self.source,
 
2868
                            last_revision=revision_id,
 
2869
                            pb=pb, find_ghosts=find_ghosts)
 
2870
        return f.count_copied, f.failed_revisions
 
2871
 
3674
2872
    @needs_read_lock
3675
2873
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3676
2874
        """See InterRepository.missing_revision_ids()."""
3697
2895
            # and the tip revision was validated by get_ancestry.
3698
2896
            result_set = required_revisions
3699
2897
        else:
3700
 
            # if we just grabbed the possibly available ids, then
 
2898
            # if we just grabbed the possibly available ids, then 
3701
2899
            # we only have an estimate of whats available and need to validate
3702
2900
            # that against the revision records.
3703
2901
            result_set = set(
3705
2903
        return self.source.revision_ids_to_search_result(result_set)
3706
2904
 
3707
2905
 
3708
 
class InterDifferingSerializer(InterRepository):
 
2906
class InterPackRepo(InterSameDataRepository):
 
2907
    """Optimised code paths between Pack based repositories."""
 
2908
 
 
2909
    @classmethod
 
2910
    def _get_repo_format_to_test(self):
 
2911
        from bzrlib.repofmt import pack_repo
 
2912
        return pack_repo.RepositoryFormatKnitPack1()
 
2913
 
 
2914
    @staticmethod
 
2915
    def is_compatible(source, target):
 
2916
        """Be compatible with known Pack formats.
 
2917
        
 
2918
        We don't test for the stores being of specific types because that
 
2919
        could lead to confusing results, and there is no need to be 
 
2920
        overly general.
 
2921
        """
 
2922
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2923
        try:
 
2924
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2925
                isinstance(target._format, RepositoryFormatPack))
 
2926
        except AttributeError:
 
2927
            return False
 
2928
        return are_packs and InterRepository._same_model(source, target)
 
2929
 
 
2930
    @needs_write_lock
 
2931
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2932
        """See InterRepository.fetch()."""
 
2933
        if (len(self.source._fallback_repositories) > 0 or
 
2934
            len(self.target._fallback_repositories) > 0):
 
2935
            # The pack layer is not aware of fallback repositories, so when
 
2936
            # fetching from a stacked repository or into a stacked repository
 
2937
            # we use the generic fetch logic which uses the VersionedFiles
 
2938
            # attributes on repository.
 
2939
            from bzrlib.fetch import RepoFetcher
 
2940
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2941
                                  pb, find_ghosts)
 
2942
            return fetcher.count_copied, fetcher.failed_revisions
 
2943
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2944
               self.source, self.source._format, self.target, self.target._format)
 
2945
        self.count_copied = 0
 
2946
        if revision_id is None:
 
2947
            # TODO:
 
2948
            # everything to do - use pack logic
 
2949
            # to fetch from all packs to one without
 
2950
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2951
            # till then:
 
2952
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2953
            revision_ids = source_revision_ids - \
 
2954
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2955
            revision_keys = [(revid,) for revid in revision_ids]
 
2956
            target_pack_collection = self._get_target_pack_collection()
 
2957
            index = target_pack_collection.revision_index.combined_index
 
2958
            present_revision_ids = set(item[1][0] for item in
 
2959
                index.iter_entries(revision_keys))
 
2960
            revision_ids = set(revision_ids) - present_revision_ids
 
2961
            # implementing the TODO will involve:
 
2962
            # - detecting when all of a pack is selected
 
2963
            # - avoiding as much as possible pre-selection, so the
 
2964
            # more-core routines such as create_pack_from_packs can filter in
 
2965
            # a just-in-time fashion. (though having a HEADS list on a
 
2966
            # repository might make this a lot easier, because we could
 
2967
            # sensibly detect 'new revisions' without doing a full index scan.
 
2968
        elif _mod_revision.is_null(revision_id):
 
2969
            # nothing to do:
 
2970
            return (0, [])
 
2971
        else:
 
2972
            try:
 
2973
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2974
                    find_ghosts=find_ghosts).get_keys()
 
2975
            except errors.NoSuchRevision:
 
2976
                raise errors.InstallFailed([revision_id])
 
2977
            if len(revision_ids) == 0:
 
2978
                return (0, [])
 
2979
        return self._pack(self.source, self.target, revision_ids)
 
2980
 
 
2981
    def _pack(self, source, target, revision_ids):
 
2982
        from bzrlib.repofmt.pack_repo import Packer
 
2983
        target_pack_collection = self._get_target_pack_collection()
 
2984
        packs = source._pack_collection.all_packs()
 
2985
        pack = Packer(target_pack_collection, packs, '.fetch',
 
2986
            revision_ids).pack()
 
2987
        if pack is not None:
 
2988
            target_pack_collection._save_pack_names()
 
2989
            copied_revs = pack.get_revision_count()
 
2990
            # Trigger an autopack. This may duplicate effort as we've just done
 
2991
            # a pack creation, but for now it is simpler to think about as
 
2992
            # 'upload data, then repack if needed'.
 
2993
            self._autopack()
 
2994
            return (copied_revs, [])
 
2995
        else:
 
2996
            return (0, [])
 
2997
 
 
2998
    def _autopack(self):
 
2999
        self.target._pack_collection.autopack()
 
3000
        
 
3001
    def _get_target_pack_collection(self):
 
3002
        return self.target._pack_collection
 
3003
 
 
3004
    @needs_read_lock
 
3005
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3006
        """See InterRepository.missing_revision_ids().
 
3007
        
 
3008
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3009
            revision_id.
 
3010
        """
 
3011
        if not find_ghosts and revision_id is not None:
 
3012
            return self._walk_to_common_revisions([revision_id])
 
3013
        elif revision_id is not None:
 
3014
            # Find ghosts: search for revisions pointing from one repository to
 
3015
            # the other, and vice versa, anywhere in the history of revision_id.
 
3016
            graph = self.target_get_graph(other_repository=self.source)
 
3017
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3018
            found_ids = set()
 
3019
            while True:
 
3020
                try:
 
3021
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3022
                except StopIteration:
 
3023
                    break
 
3024
                if revision_id in ghosts:
 
3025
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3026
                found_ids.update(next_revs)
 
3027
                found_ids.update(ghosts)
 
3028
            found_ids = frozenset(found_ids)
 
3029
            # Double query here: should be able to avoid this by changing the
 
3030
            # graph api further.
 
3031
            result_set = found_ids - frozenset(
 
3032
                self.target_get_parent_map(found_ids))
 
3033
        else:
 
3034
            source_ids = self.source.all_revision_ids()
 
3035
            # source_ids is the worst possible case we may need to pull.
 
3036
            # now we want to filter source_ids against what we actually
 
3037
            # have in target, but don't try to check for existence where we know
 
3038
            # we do not have a revision as that would be pointless.
 
3039
            target_ids = set(self.target.all_revision_ids())
 
3040
            result_set = set(source_ids).difference(target_ids)
 
3041
        return self.source.revision_ids_to_search_result(result_set)
 
3042
 
 
3043
 
 
3044
class InterModel1and2(InterRepository):
 
3045
 
 
3046
    @classmethod
 
3047
    def _get_repo_format_to_test(self):
 
3048
        return None
 
3049
 
 
3050
    @staticmethod
 
3051
    def is_compatible(source, target):
 
3052
        if not source.supports_rich_root() and target.supports_rich_root():
 
3053
            return True
 
3054
        else:
 
3055
            return False
 
3056
 
 
3057
    @needs_write_lock
 
3058
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3059
        """See InterRepository.fetch()."""
 
3060
        from bzrlib.fetch import Model1toKnit2Fetcher
 
3061
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
3062
                                 from_repository=self.source,
 
3063
                                 last_revision=revision_id,
 
3064
                                 pb=pb, find_ghosts=find_ghosts)
 
3065
        return f.count_copied, f.failed_revisions
 
3066
 
 
3067
    @needs_write_lock
 
3068
    def copy_content(self, revision_id=None):
 
3069
        """Make a complete copy of the content in self into destination.
 
3070
        
 
3071
        This is a destructive operation! Do not use it on existing 
 
3072
        repositories.
 
3073
 
 
3074
        :param revision_id: Only copy the content needed to construct
 
3075
                            revision_id and its parents.
 
3076
        """
 
3077
        try:
 
3078
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3079
        except NotImplementedError:
 
3080
            pass
 
3081
        # but don't bother fetching if we have the needed data now.
 
3082
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
3083
            self.target.has_revision(revision_id)):
 
3084
            return
 
3085
        self.target.fetch(self.source, revision_id=revision_id)
 
3086
 
 
3087
 
 
3088
class InterKnit1and2(InterKnitRepo):
 
3089
 
 
3090
    @classmethod
 
3091
    def _get_repo_format_to_test(self):
 
3092
        return None
 
3093
 
 
3094
    @staticmethod
 
3095
    def is_compatible(source, target):
 
3096
        """Be compatible with Knit1 source and Knit3 target"""
 
3097
        try:
 
3098
            from bzrlib.repofmt.knitrepo import (
 
3099
                RepositoryFormatKnit1,
 
3100
                RepositoryFormatKnit3,
 
3101
                )
 
3102
            from bzrlib.repofmt.pack_repo import (
 
3103
                RepositoryFormatKnitPack1,
 
3104
                RepositoryFormatKnitPack3,
 
3105
                RepositoryFormatKnitPack4,
 
3106
                RepositoryFormatKnitPack5,
 
3107
                RepositoryFormatKnitPack5RichRoot,
 
3108
                RepositoryFormatKnitPack6,
 
3109
                RepositoryFormatKnitPack6RichRoot,
 
3110
                RepositoryFormatPackDevelopment2,
 
3111
                RepositoryFormatPackDevelopment2Subtree,
 
3112
                )
 
3113
            norichroot = (
 
3114
                RepositoryFormatKnit1,            # no rr, no subtree
 
3115
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
3116
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
3117
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
3118
                RepositoryFormatKnitPack6,        # no rr, no subtree
 
3119
                )
 
3120
            richroot = (
 
3121
                RepositoryFormatKnit3,            # rr, subtree
 
3122
                RepositoryFormatKnitPack3,        # rr, subtree
 
3123
                RepositoryFormatKnitPack4,        # rr, no subtree
 
3124
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
3125
                RepositoryFormatKnitPack6RichRoot,# rr, no subtree
 
3126
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
3127
                )
 
3128
            for format in norichroot:
 
3129
                if format.rich_root_data:
 
3130
                    raise AssertionError('Format %s is a rich-root format'
 
3131
                        ' but is included in the non-rich-root list'
 
3132
                        % (format,))
 
3133
            for format in richroot:
 
3134
                if not format.rich_root_data:
 
3135
                    raise AssertionError('Format %s is not a rich-root format'
 
3136
                        ' but is included in the rich-root list'
 
3137
                        % (format,))
 
3138
            # TODO: One alternative is to just check format.rich_root_data,
 
3139
            #       instead of keeping membership lists. However, the formats
 
3140
            #       *also* have to use the same 'Knit' style of storage
 
3141
            #       (line-deltas, fulltexts, etc.)
 
3142
            return (isinstance(source._format, norichroot) and
 
3143
                    isinstance(target._format, richroot))
 
3144
        except AttributeError:
 
3145
            return False
 
3146
 
 
3147
    @needs_write_lock
 
3148
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3149
        """See InterRepository.fetch()."""
 
3150
        from bzrlib.fetch import Knit1to2Fetcher
 
3151
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
3152
               self.source, self.source._format, self.target, 
 
3153
               self.target._format)
 
3154
        f = Knit1to2Fetcher(to_repository=self.target,
 
3155
                            from_repository=self.source,
 
3156
                            last_revision=revision_id,
 
3157
                            pb=pb, find_ghosts=find_ghosts)
 
3158
        return f.count_copied, f.failed_revisions
 
3159
 
 
3160
 
 
3161
class InterDifferingSerializer(InterKnitRepo):
3709
3162
 
3710
3163
    @classmethod
3711
3164
    def _get_repo_format_to_test(self):
3714
3167
    @staticmethod
3715
3168
    def is_compatible(source, target):
3716
3169
        """Be compatible with Knit2 source and Knit3 target"""
3717
 
        # This is redundant with format.check_conversion_target(), however that
3718
 
        # raises an exception, and we just want to say "False" as in we won't
3719
 
        # support converting between these formats.
3720
 
        if 'IDS_never' in debug.debug_flags:
3721
 
            return False
3722
 
        if source.supports_rich_root() and not target.supports_rich_root():
3723
 
            return False
3724
 
        if (source._format.supports_tree_reference
3725
 
            and not target._format.supports_tree_reference):
3726
 
            return False
3727
 
        if target._fallback_repositories and target._format.supports_chks:
3728
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3729
 
            # adds to stacked repos.
3730
 
            return False
3731
 
        if 'IDS_always' in debug.debug_flags:
3732
 
            return True
3733
 
        # Only use this code path for local source and target.  IDS does far
3734
 
        # too much IO (both bandwidth and roundtrips) over a network.
3735
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3736
 
            return False
3737
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3170
        if source.supports_rich_root() != target.supports_rich_root():
 
3171
            return False
 
3172
        # Ideally, we'd support fetching if the source had no tree references
 
3173
        # even if it supported them...
 
3174
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3175
            not getattr(target, '_format.supports_tree_reference', False)):
3738
3176
            return False
3739
3177
        return True
3740
3178
 
3741
 
    def _get_trees(self, revision_ids, cache):
3742
 
        possible_trees = []
3743
 
        for rev_id in revision_ids:
3744
 
            if rev_id in cache:
3745
 
                possible_trees.append((rev_id, cache[rev_id]))
3746
 
            else:
3747
 
                # Not cached, but inventory might be present anyway.
3748
 
                try:
3749
 
                    tree = self.source.revision_tree(rev_id)
3750
 
                except errors.NoSuchRevision:
3751
 
                    # Nope, parent is ghost.
3752
 
                    pass
3753
 
                else:
3754
 
                    cache[rev_id] = tree
3755
 
                    possible_trees.append((rev_id, tree))
3756
 
        return possible_trees
3757
 
 
3758
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3759
 
        """Get the best delta and base for this revision.
3760
 
 
3761
 
        :return: (basis_id, delta)
3762
 
        """
3763
 
        deltas = []
3764
 
        # Generate deltas against each tree, to find the shortest.
3765
 
        texts_possibly_new_in_tree = set()
3766
 
        for basis_id, basis_tree in possible_trees:
3767
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3768
 
            for old_path, new_path, file_id, new_entry in delta:
3769
 
                if new_path is None:
3770
 
                    # This file_id isn't present in the new rev, so we don't
3771
 
                    # care about it.
3772
 
                    continue
3773
 
                if not new_path:
3774
 
                    # Rich roots are handled elsewhere...
3775
 
                    continue
3776
 
                kind = new_entry.kind
3777
 
                if kind != 'directory' and kind != 'file':
3778
 
                    # No text record associated with this inventory entry.
3779
 
                    continue
3780
 
                # This is a directory or file that has changed somehow.
3781
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3782
 
            deltas.append((len(delta), basis_id, delta))
3783
 
        deltas.sort()
3784
 
        return deltas[0][1:]
3785
 
 
3786
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3787
 
        """Find all parent revisions that are absent, but for which the
3788
 
        inventory is present, and copy those inventories.
3789
 
 
3790
 
        This is necessary to preserve correctness when the source is stacked
3791
 
        without fallbacks configured.  (Note that in cases like upgrade the
3792
 
        source may be not have _fallback_repositories even though it is
3793
 
        stacked.)
3794
 
        """
3795
 
        parent_revs = set()
3796
 
        for parents in parent_map.values():
3797
 
            parent_revs.update(parents)
3798
 
        present_parents = self.source.get_parent_map(parent_revs)
3799
 
        absent_parents = set(parent_revs).difference(present_parents)
3800
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3801
 
            (rev_id,) for rev_id in absent_parents)
3802
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3803
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3804
 
            current_revision_id = parent_tree.get_revision_id()
3805
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3806
 
                (current_revision_id,)]
3807
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3808
 
            basis_id = _mod_revision.NULL_REVISION
3809
 
            basis_tree = self.source.revision_tree(basis_id)
3810
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3811
 
            self.target.add_inventory_by_delta(
3812
 
                basis_id, delta, current_revision_id, parents_parents)
3813
 
            cache[current_revision_id] = parent_tree
3814
 
 
3815
 
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3179
    def _fetch_batch(self, revision_ids, basis_id, basis_tree):
3816
3180
        """Fetch across a few revisions.
3817
3181
 
3818
3182
        :param revision_ids: The revisions to copy
3819
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3820
 
            as a basis for delta when no other base is available
3821
 
        :param cache: A cache of RevisionTrees that we can use.
3822
 
        :return: The revision_id of the last converted tree. The RevisionTree
3823
 
            for it will be in cache
 
3183
        :param basis_id: The revision_id of basis_tree
 
3184
        :param basis_tree: A tree that is not in revision_ids which should
 
3185
            already exist in the target.
 
3186
        :return: (basis_id, basis_tree) A new basis to use now that these trees
 
3187
            have been copied.
3824
3188
        """
3825
3189
        # Walk though all revisions; get inventory deltas, copy referenced
3826
3190
        # texts that delta references, insert the delta, revision and
3827
3191
        # signature.
3828
 
        root_keys_to_create = set()
3829
3192
        text_keys = set()
3830
3193
        pending_deltas = []
3831
3194
        pending_revisions = []
3832
 
        parent_map = self.source.get_parent_map(revision_ids)
3833
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3834
3195
        for tree in self.source.revision_trees(revision_ids):
3835
 
            # Find a inventory delta for this revision.
3836
 
            # Find text entries that need to be copied, too.
3837
3196
            current_revision_id = tree.get_revision_id()
3838
 
            parent_ids = parent_map.get(current_revision_id, ())
3839
 
            parent_trees = self._get_trees(parent_ids, cache)
3840
 
            possible_trees = list(parent_trees)
3841
 
            if len(possible_trees) == 0:
3842
 
                # There either aren't any parents, or the parents are ghosts,
3843
 
                # so just use the last converted tree.
3844
 
                possible_trees.append((basis_id, cache[basis_id]))
3845
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3846
 
                                                           possible_trees)
 
3197
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3198
            for old_path, new_path, file_id, entry in delta:
 
3199
                if new_path is not None:
 
3200
                    if not (new_path or self.target.supports_rich_root()):
 
3201
                        # We leave the inventory delta in, because that
 
3202
                        # will have the deserialised inventory root
 
3203
                        # pointer.
 
3204
                        continue
 
3205
                    # TODO: Do we need:
 
3206
                    #       "if entry.revision == current_revision_id" ?
 
3207
                    if entry.revision == current_revision_id:
 
3208
                        text_keys.add((file_id, entry.revision))
3847
3209
            revision = self.source.get_revision(current_revision_id)
3848
3210
            pending_deltas.append((basis_id, delta,
3849
3211
                current_revision_id, revision.parent_ids))
3850
 
            if self._converting_to_rich_root:
3851
 
                self._revision_id_to_root_id[current_revision_id] = \
3852
 
                    tree.get_root_id()
3853
 
            # Determine which texts are in present in this revision but not in
3854
 
            # any of the available parents.
3855
 
            texts_possibly_new_in_tree = set()
3856
 
            for old_path, new_path, file_id, entry in delta:
3857
 
                if new_path is None:
3858
 
                    # This file_id isn't present in the new rev
3859
 
                    continue
3860
 
                if not new_path:
3861
 
                    # This is the root
3862
 
                    if not self.target.supports_rich_root():
3863
 
                        # The target doesn't support rich root, so we don't
3864
 
                        # copy
3865
 
                        continue
3866
 
                    if self._converting_to_rich_root:
3867
 
                        # This can't be copied normally, we have to insert
3868
 
                        # it specially
3869
 
                        root_keys_to_create.add((file_id, entry.revision))
3870
 
                        continue
3871
 
                kind = entry.kind
3872
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3873
 
            for basis_id, basis_tree in possible_trees:
3874
 
                basis_inv = basis_tree.inventory
3875
 
                for file_key in list(texts_possibly_new_in_tree):
3876
 
                    file_id, file_revision = file_key
3877
 
                    try:
3878
 
                        entry = basis_inv[file_id]
3879
 
                    except errors.NoSuchId:
3880
 
                        continue
3881
 
                    if entry.revision == file_revision:
3882
 
                        texts_possibly_new_in_tree.remove(file_key)
3883
 
            text_keys.update(texts_possibly_new_in_tree)
3884
3212
            pending_revisions.append(revision)
3885
 
            cache[current_revision_id] = tree
3886
3213
            basis_id = current_revision_id
 
3214
            basis_tree = tree
3887
3215
        # Copy file texts
3888
3216
        from_texts = self.source.texts
3889
3217
        to_texts = self.target.texts
3890
 
        if root_keys_to_create:
3891
 
            from bzrlib.fetch import _new_root_data_stream
3892
 
            root_stream = _new_root_data_stream(
3893
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3894
 
                self.source)
3895
 
            to_texts.insert_record_stream(root_stream)
3896
3218
        to_texts.insert_record_stream(from_texts.get_record_stream(
3897
 
            text_keys, self.target._format._fetch_order,
3898
 
            not self.target._format._fetch_uses_deltas))
3899
 
        # insert inventory deltas
 
3219
            text_keys, self.target._fetch_order,
 
3220
            not self.target._fetch_uses_deltas))
 
3221
        # insert deltas
3900
3222
        for delta in pending_deltas:
3901
3223
            self.target.add_inventory_by_delta(*delta)
3902
 
        if self.target._fallback_repositories:
3903
 
            # Make sure this stacked repository has all the parent inventories
3904
 
            # for the new revisions that we are about to insert.  We do this
3905
 
            # before adding the revisions so that no revision is added until
3906
 
            # all the inventories it may depend on are added.
3907
 
            # Note that this is overzealous, as we may have fetched these in an
3908
 
            # earlier batch.
3909
 
            parent_ids = set()
3910
 
            revision_ids = set()
3911
 
            for revision in pending_revisions:
3912
 
                revision_ids.add(revision.revision_id)
3913
 
                parent_ids.update(revision.parent_ids)
3914
 
            parent_ids.difference_update(revision_ids)
3915
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3916
 
            parent_map = self.source.get_parent_map(parent_ids)
3917
 
            # we iterate over parent_map and not parent_ids because we don't
3918
 
            # want to try copying any revision which is a ghost
3919
 
            for parent_tree in self.source.revision_trees(parent_map):
3920
 
                current_revision_id = parent_tree.get_revision_id()
3921
 
                parents_parents = parent_map[current_revision_id]
3922
 
                possible_trees = self._get_trees(parents_parents, cache)
3923
 
                if len(possible_trees) == 0:
3924
 
                    # There either aren't any parents, or the parents are
3925
 
                    # ghosts, so just use the last converted tree.
3926
 
                    possible_trees.append((basis_id, cache[basis_id]))
3927
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3928
 
                    parents_parents, possible_trees)
3929
 
                self.target.add_inventory_by_delta(
3930
 
                    basis_id, delta, current_revision_id, parents_parents)
3931
3224
        # insert signatures and revisions
3932
3225
        for revision in pending_revisions:
3933
3226
            try:
3938
3231
            except errors.NoSuchRevision:
3939
3232
                pass
3940
3233
            self.target.add_revision(revision.revision_id, revision)
3941
 
        return basis_id
 
3234
        return basis_id, basis_tree
3942
3235
 
3943
3236
    def _fetch_all_revisions(self, revision_ids, pb):
3944
3237
        """Fetch everything for the list of revisions.
3945
3238
 
3946
3239
        :param revision_ids: The list of revisions to fetch. Must be in
3947
3240
            topological order.
3948
 
        :param pb: A ProgressTask
 
3241
        :param pb: A ProgressBar
3949
3242
        :return: None
3950
3243
        """
3951
3244
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3952
3245
        batch_size = 100
3953
 
        cache = lru_cache.LRUCache(100)
3954
 
        cache[basis_id] = basis_tree
3955
 
        del basis_tree # We don't want to hang on to it here
3956
 
        hints = []
3957
3246
        for offset in range(0, len(revision_ids), batch_size):
3958
3247
            self.target.start_write_group()
3959
3248
            try:
3960
3249
                pb.update('Transferring revisions', offset,
3961
3250
                          len(revision_ids))
3962
3251
                batch = revision_ids[offset:offset+batch_size]
3963
 
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3252
                basis_id, basis_tree = self._fetch_batch(batch,
 
3253
                    basis_id, basis_tree)
3964
3254
            except:
3965
3255
                self.target.abort_write_group()
3966
3256
                raise
3967
3257
            else:
3968
 
                hint = self.target.commit_write_group()
3969
 
                if hint:
3970
 
                    hints.extend(hint)
3971
 
        if hints and self.target._format.pack_compresses:
3972
 
            self.target.pack(hint=hints)
 
3258
                self.target.commit_write_group()
3973
3259
        pb.update('Transferring revisions', len(revision_ids),
3974
3260
                  len(revision_ids))
3975
3261
 
3976
3262
    @needs_write_lock
3977
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3978
 
            fetch_spec=None):
 
3263
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3979
3264
        """See InterRepository.fetch()."""
3980
 
        if fetch_spec is not None:
3981
 
            raise AssertionError("Not implemented yet...")
3982
 
        if (not self.source.supports_rich_root()
3983
 
            and self.target.supports_rich_root()):
3984
 
            self._converting_to_rich_root = True
3985
 
            self._revision_id_to_root_id = {}
3986
 
        else:
3987
 
            self._converting_to_rich_root = False
3988
3265
        revision_ids = self.target.search_missing_revision_ids(self.source,
3989
3266
            revision_id, find_ghosts=find_ghosts).get_keys()
3990
3267
        if not revision_ids:
3991
3268
            return 0, 0
3992
3269
        revision_ids = tsort.topo_sort(
3993
3270
            self.source.get_graph().get_parent_map(revision_ids))
3994
 
        if not revision_ids:
3995
 
            return 0, 0
3996
 
        # Walk though all revisions; get inventory deltas, copy referenced
3997
 
        # texts that delta references, insert the delta, revision and
3998
 
        # signature.
3999
3271
        if pb is None:
4000
3272
            my_pb = ui.ui_factory.nested_progress_bar()
4001
3273
            pb = my_pb
4002
3274
        else:
4003
 
            symbol_versioning.warn(
4004
 
                symbol_versioning.deprecated_in((1, 14, 0))
4005
 
                % "pb parameter to fetch()")
4006
3275
            my_pb = None
4007
3276
        try:
4008
3277
            self._fetch_all_revisions(revision_ids, pb)
4034
3303
        return basis_id, basis_tree
4035
3304
 
4036
3305
 
 
3306
class InterOtherToRemote(InterRepository):
 
3307
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3308
    calculated for (source, target._real_repository).
 
3309
    """
 
3310
 
 
3311
    _walk_to_common_revisions_batch_size = 50
 
3312
 
 
3313
    def __init__(self, source, target):
 
3314
        InterRepository.__init__(self, source, target)
 
3315
        self._real_inter = None
 
3316
 
 
3317
    @staticmethod
 
3318
    def is_compatible(source, target):
 
3319
        if isinstance(target, remote.RemoteRepository):
 
3320
            return True
 
3321
        return False
 
3322
 
 
3323
    def _ensure_real_inter(self):
 
3324
        if self._real_inter is None:
 
3325
            self.target._ensure_real()
 
3326
            real_target = self.target._real_repository
 
3327
            self._real_inter = InterRepository.get(self.source, real_target)
 
3328
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3329
            self._real_inter.target_get_graph = self.target.get_graph
 
3330
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3331
    
 
3332
    def copy_content(self, revision_id=None):
 
3333
        self._ensure_real_inter()
 
3334
        self._real_inter.copy_content(revision_id=revision_id)
 
3335
 
 
3336
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3337
        self._ensure_real_inter()
 
3338
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3339
            find_ghosts=find_ghosts)
 
3340
 
 
3341
    @classmethod
 
3342
    def _get_repo_format_to_test(self):
 
3343
        return None
 
3344
 
 
3345
 
 
3346
class InterRemoteToOther(InterRepository):
 
3347
 
 
3348
    def __init__(self, source, target):
 
3349
        InterRepository.__init__(self, source, target)
 
3350
        self._real_inter = None
 
3351
 
 
3352
    @staticmethod
 
3353
    def is_compatible(source, target):
 
3354
        if not isinstance(source, remote.RemoteRepository):
 
3355
            return False
 
3356
        # Is source's model compatible with target's model?
 
3357
        source._ensure_real()
 
3358
        real_source = source._real_repository
 
3359
        if isinstance(real_source, remote.RemoteRepository):
 
3360
            raise NotImplementedError(
 
3361
                "We don't support remote repos backed by remote repos yet.")
 
3362
        return InterRepository._same_model(real_source, target)
 
3363
 
 
3364
    def _ensure_real_inter(self):
 
3365
        if self._real_inter is None:
 
3366
            self.source._ensure_real()
 
3367
            real_source = self.source._real_repository
 
3368
            self._real_inter = InterRepository.get(real_source, self.target)
 
3369
    
 
3370
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3371
        self._ensure_real_inter()
 
3372
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3373
            find_ghosts=find_ghosts)
 
3374
 
 
3375
    def copy_content(self, revision_id=None):
 
3376
        self._ensure_real_inter()
 
3377
        self._real_inter.copy_content(revision_id=revision_id)
 
3378
 
 
3379
    @classmethod
 
3380
    def _get_repo_format_to_test(self):
 
3381
        return None
 
3382
 
 
3383
 
 
3384
 
 
3385
class InterPackToRemotePack(InterPackRepo):
 
3386
    """A specialisation of InterPackRepo for a target that is a
 
3387
    RemoteRepository.
 
3388
 
 
3389
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3390
    uses an RPC for autopacking.
 
3391
    """
 
3392
 
 
3393
    _walk_to_common_revisions_batch_size = 50
 
3394
 
 
3395
    @staticmethod
 
3396
    def is_compatible(source, target):
 
3397
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3398
        if isinstance(source._format, RepositoryFormatPack):
 
3399
            if isinstance(target, remote.RemoteRepository):
 
3400
                target._ensure_real()
 
3401
                if isinstance(target._real_repository._format,
 
3402
                              RepositoryFormatPack):
 
3403
                    if InterRepository._same_model(source, target):
 
3404
                        return True
 
3405
        return False
 
3406
    
 
3407
    def _autopack(self):
 
3408
        self.target.autopack()
 
3409
        
 
3410
    def _get_target_pack_collection(self):
 
3411
        return self.target._real_repository._pack_collection
 
3412
 
 
3413
    @classmethod
 
3414
    def _get_repo_format_to_test(self):
 
3415
        return None
 
3416
 
 
3417
 
4037
3418
InterRepository.register_optimiser(InterDifferingSerializer)
4038
3419
InterRepository.register_optimiser(InterSameDataRepository)
4039
3420
InterRepository.register_optimiser(InterWeaveRepo)
4040
3421
InterRepository.register_optimiser(InterKnitRepo)
 
3422
InterRepository.register_optimiser(InterModel1and2)
 
3423
InterRepository.register_optimiser(InterKnit1and2)
 
3424
InterRepository.register_optimiser(InterPackRepo)
 
3425
InterRepository.register_optimiser(InterOtherToRemote)
 
3426
InterRepository.register_optimiser(InterRemoteToOther)
 
3427
InterRepository.register_optimiser(InterPackToRemotePack)
4041
3428
 
4042
3429
 
4043
3430
class CopyConverter(object):
4044
3431
    """A repository conversion tool which just performs a copy of the content.
4045
 
 
 
3432
    
4046
3433
    This is slow but quite reliable.
4047
3434
    """
4048
3435
 
4052
3439
        :param target_format: The format the resulting repository should be.
4053
3440
        """
4054
3441
        self.target_format = target_format
4055
 
 
 
3442
        
4056
3443
    def convert(self, repo, pb):
4057
3444
        """Perform the conversion of to_convert, giving feedback via pb.
4058
3445
 
4078
3465
                                                  self.source_repo.is_shared())
4079
3466
        converted.lock_write()
4080
3467
        try:
4081
 
            self.step('Copying content')
 
3468
            self.step('Copying content into repository.')
4082
3469
            self.source_repo.copy_content_into(converted)
4083
3470
        finally:
4084
3471
            converted.unlock()
4085
 
        self.step('Deleting old repository content')
 
3472
        self.step('Deleting old repository content.')
4086
3473
        self.repo_dir.transport.delete_tree('repository.backup')
4087
3474
        self.pb.note('repository converted')
4088
3475
 
4124
3511
 
4125
3512
class _VersionedFileChecker(object):
4126
3513
 
4127
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3514
    def __init__(self, repository):
4128
3515
        self.repository = repository
4129
 
        self.text_index = self.repository._generate_text_key_index(
4130
 
            text_key_references=text_key_references, ancestors=ancestors)
4131
 
 
 
3516
        self.text_index = self.repository._generate_text_key_index()
 
3517
    
4132
3518
    def calculate_file_version_parents(self, text_key):
4133
3519
        """Calculate the correct parents for a file version according to
4134
3520
        the inventories.
4151
3537
            revision_id) tuples for versions that are present in this versioned
4152
3538
            file, but not used by the corresponding inventory.
4153
3539
        """
4154
 
        local_progress = None
4155
 
        if progress_bar is None:
4156
 
            local_progress = ui.ui_factory.nested_progress_bar()
4157
 
            progress_bar = local_progress
4158
 
        try:
4159
 
            return self._check_file_version_parents(texts, progress_bar)
4160
 
        finally:
4161
 
            if local_progress:
4162
 
                local_progress.finished()
4163
 
 
4164
 
    def _check_file_version_parents(self, texts, progress_bar):
4165
 
        """See check_file_version_parents."""
4166
3540
        wrong_parents = {}
4167
3541
        self.file_ids = set([file_id for file_id, _ in
4168
3542
            self.text_index.iterkeys()])
4169
3543
        # text keys is now grouped by file_id
 
3544
        n_weaves = len(self.file_ids)
 
3545
        files_in_revisions = {}
 
3546
        revisions_of_files = {}
4170
3547
        n_versions = len(self.text_index)
4171
3548
        progress_bar.update('loading text store', 0, n_versions)
4172
3549
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4174
3551
        text_keys = self.repository.texts.keys()
4175
3552
        unused_keys = frozenset(text_keys) - set(self.text_index)
4176
3553
        for num, key in enumerate(self.text_index.iterkeys()):
4177
 
            progress_bar.update('checking text graph', num, n_versions)
 
3554
            if progress_bar is not None:
 
3555
                progress_bar.update('checking text graph', num, n_versions)
4178
3556
            correct_parents = self.calculate_file_version_parents(key)
4179
3557
            try:
4180
3558
                knit_parents = parent_map[key]
4203
3581
        revision_graph[key] = tuple(parent for parent in parents if parent
4204
3582
            in revision_graph)
4205
3583
    return revision_graph
4206
 
 
4207
 
 
4208
 
class StreamSink(object):
4209
 
    """An object that can insert a stream into a repository.
4210
 
 
4211
 
    This interface handles the complexity of reserialising inventories and
4212
 
    revisions from different formats, and allows unidirectional insertion into
4213
 
    stacked repositories without looking for the missing basis parents
4214
 
    beforehand.
4215
 
    """
4216
 
 
4217
 
    def __init__(self, target_repo):
4218
 
        self.target_repo = target_repo
4219
 
 
4220
 
    def insert_stream(self, stream, src_format, resume_tokens):
4221
 
        """Insert a stream's content into the target repository.
4222
 
 
4223
 
        :param src_format: a bzr repository format.
4224
 
 
4225
 
        :return: a list of resume tokens and an  iterable of keys additional
4226
 
            items required before the insertion can be completed.
4227
 
        """
4228
 
        self.target_repo.lock_write()
4229
 
        try:
4230
 
            if resume_tokens:
4231
 
                self.target_repo.resume_write_group(resume_tokens)
4232
 
                is_resume = True
4233
 
            else:
4234
 
                self.target_repo.start_write_group()
4235
 
                is_resume = False
4236
 
            try:
4237
 
                # locked_insert_stream performs a commit|suspend.
4238
 
                return self._locked_insert_stream(stream, src_format, is_resume)
4239
 
            except:
4240
 
                self.target_repo.abort_write_group(suppress_errors=True)
4241
 
                raise
4242
 
        finally:
4243
 
            self.target_repo.unlock()
4244
 
 
4245
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
4246
 
        to_serializer = self.target_repo._format._serializer
4247
 
        src_serializer = src_format._serializer
4248
 
        new_pack = None
4249
 
        if to_serializer == src_serializer:
4250
 
            # If serializers match and the target is a pack repository, set the
4251
 
            # write cache size on the new pack.  This avoids poor performance
4252
 
            # on transports where append is unbuffered (such as
4253
 
            # RemoteTransport).  This is safe to do because nothing should read
4254
 
            # back from the target repository while a stream with matching
4255
 
            # serialization is being inserted.
4256
 
            # The exception is that a delta record from the source that should
4257
 
            # be a fulltext may need to be expanded by the target (see
4258
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4259
 
            # explicitly flush any buffered writes first in that rare case.
4260
 
            try:
4261
 
                new_pack = self.target_repo._pack_collection._new_pack
4262
 
            except AttributeError:
4263
 
                # Not a pack repository
4264
 
                pass
4265
 
            else:
4266
 
                new_pack.set_write_cache_size(1024*1024)
4267
 
        for substream_type, substream in stream:
4268
 
            if 'stream' in debug.debug_flags:
4269
 
                mutter('inserting substream: %s', substream_type)
4270
 
            if substream_type == 'texts':
4271
 
                self.target_repo.texts.insert_record_stream(substream)
4272
 
            elif substream_type == 'inventories':
4273
 
                if src_serializer == to_serializer:
4274
 
                    self.target_repo.inventories.insert_record_stream(
4275
 
                        substream)
4276
 
                else:
4277
 
                    self._extract_and_insert_inventories(
4278
 
                        substream, src_serializer)
4279
 
            elif substream_type == 'inventory-deltas':
4280
 
                self._extract_and_insert_inventory_deltas(
4281
 
                    substream, src_serializer)
4282
 
            elif substream_type == 'chk_bytes':
4283
 
                # XXX: This doesn't support conversions, as it assumes the
4284
 
                #      conversion was done in the fetch code.
4285
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4286
 
            elif substream_type == 'revisions':
4287
 
                # This may fallback to extract-and-insert more often than
4288
 
                # required if the serializers are different only in terms of
4289
 
                # the inventory.
4290
 
                if src_serializer == to_serializer:
4291
 
                    self.target_repo.revisions.insert_record_stream(
4292
 
                        substream)
4293
 
                else:
4294
 
                    self._extract_and_insert_revisions(substream,
4295
 
                        src_serializer)
4296
 
            elif substream_type == 'signatures':
4297
 
                self.target_repo.signatures.insert_record_stream(substream)
4298
 
            else:
4299
 
                raise AssertionError('kaboom! %s' % (substream_type,))
4300
 
        # Done inserting data, and the missing_keys calculations will try to
4301
 
        # read back from the inserted data, so flush the writes to the new pack
4302
 
        # (if this is pack format).
4303
 
        if new_pack is not None:
4304
 
            new_pack._write_data('', flush=True)
4305
 
        # Find all the new revisions (including ones from resume_tokens)
4306
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4307
 
            check_for_missing_texts=is_resume)
4308
 
        try:
4309
 
            for prefix, versioned_file in (
4310
 
                ('texts', self.target_repo.texts),
4311
 
                ('inventories', self.target_repo.inventories),
4312
 
                ('revisions', self.target_repo.revisions),
4313
 
                ('signatures', self.target_repo.signatures),
4314
 
                ('chk_bytes', self.target_repo.chk_bytes),
4315
 
                ):
4316
 
                if versioned_file is None:
4317
 
                    continue
4318
 
                missing_keys.update((prefix,) + key for key in
4319
 
                    versioned_file.get_missing_compression_parent_keys())
4320
 
        except NotImplementedError:
4321
 
            # cannot even attempt suspending, and missing would have failed
4322
 
            # during stream insertion.
4323
 
            missing_keys = set()
4324
 
        else:
4325
 
            if missing_keys:
4326
 
                # suspend the write group and tell the caller what we is
4327
 
                # missing. We know we can suspend or else we would not have
4328
 
                # entered this code path. (All repositories that can handle
4329
 
                # missing keys can handle suspending a write group).
4330
 
                write_group_tokens = self.target_repo.suspend_write_group()
4331
 
                return write_group_tokens, missing_keys
4332
 
        hint = self.target_repo.commit_write_group()
4333
 
        if (to_serializer != src_serializer and
4334
 
            self.target_repo._format.pack_compresses):
4335
 
            self.target_repo.pack(hint=hint)
4336
 
        return [], set()
4337
 
 
4338
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4339
 
        target_rich_root = self.target_repo._format.rich_root_data
4340
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4341
 
        for record in substream:
4342
 
            # Insert the delta directly
4343
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4344
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4345
 
            try:
4346
 
                parse_result = deserialiser.parse_text_bytes(
4347
 
                    inventory_delta_bytes)
4348
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4349
 
                trace.mutter("Incompatible delta: %s", err.msg)
4350
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4351
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4352
 
            revision_id = new_id
4353
 
            parents = [key[0] for key in record.parents]
4354
 
            self.target_repo.add_inventory_by_delta(
4355
 
                basis_id, inv_delta, revision_id, parents)
4356
 
 
4357
 
    def _extract_and_insert_inventories(self, substream, serializer,
4358
 
            parse_delta=None):
4359
 
        """Generate a new inventory versionedfile in target, converting data.
4360
 
 
4361
 
        The inventory is retrieved from the source, (deserializing it), and
4362
 
        stored in the target (reserializing it in a different format).
4363
 
        """
4364
 
        target_rich_root = self.target_repo._format.rich_root_data
4365
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4366
 
        for record in substream:
4367
 
            # It's not a delta, so it must be a fulltext in the source
4368
 
            # serializer's format.
4369
 
            bytes = record.get_bytes_as('fulltext')
4370
 
            revision_id = record.key[0]
4371
 
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4372
 
            parents = [key[0] for key in record.parents]
4373
 
            self.target_repo.add_inventory(revision_id, inv, parents)
4374
 
            # No need to keep holding this full inv in memory when the rest of
4375
 
            # the substream is likely to be all deltas.
4376
 
            del inv
4377
 
 
4378
 
    def _extract_and_insert_revisions(self, substream, serializer):
4379
 
        for record in substream:
4380
 
            bytes = record.get_bytes_as('fulltext')
4381
 
            revision_id = record.key[0]
4382
 
            rev = serializer.read_revision_from_string(bytes)
4383
 
            if rev.revision_id != revision_id:
4384
 
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4385
 
            self.target_repo.add_revision(revision_id, rev)
4386
 
 
4387
 
    def finished(self):
4388
 
        if self.target_repo._format._fetch_reconcile:
4389
 
            self.target_repo.reconcile()
4390
 
 
4391
 
 
4392
 
class StreamSource(object):
4393
 
    """A source of a stream for fetching between repositories."""
4394
 
 
4395
 
    def __init__(self, from_repository, to_format):
4396
 
        """Create a StreamSource streaming from from_repository."""
4397
 
        self.from_repository = from_repository
4398
 
        self.to_format = to_format
4399
 
 
4400
 
    def delta_on_metadata(self):
4401
 
        """Return True if delta's are permitted on metadata streams.
4402
 
 
4403
 
        That is on revisions and signatures.
4404
 
        """
4405
 
        src_serializer = self.from_repository._format._serializer
4406
 
        target_serializer = self.to_format._serializer
4407
 
        return (self.to_format._fetch_uses_deltas and
4408
 
            src_serializer == target_serializer)
4409
 
 
4410
 
    def _fetch_revision_texts(self, revs):
4411
 
        # fetch signatures first and then the revision texts
4412
 
        # may need to be a InterRevisionStore call here.
4413
 
        from_sf = self.from_repository.signatures
4414
 
        # A missing signature is just skipped.
4415
 
        keys = [(rev_id,) for rev_id in revs]
4416
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4417
 
            keys,
4418
 
            self.to_format._fetch_order,
4419
 
            not self.to_format._fetch_uses_deltas))
4420
 
        # If a revision has a delta, this is actually expanded inside the
4421
 
        # insert_record_stream code now, which is an alternate fix for
4422
 
        # bug #261339
4423
 
        from_rf = self.from_repository.revisions
4424
 
        revisions = from_rf.get_record_stream(
4425
 
            keys,
4426
 
            self.to_format._fetch_order,
4427
 
            not self.delta_on_metadata())
4428
 
        return [('signatures', signatures), ('revisions', revisions)]
4429
 
 
4430
 
    def _generate_root_texts(self, revs):
4431
 
        """This will be called by get_stream between fetching weave texts and
4432
 
        fetching the inventory weave.
4433
 
        """
4434
 
        if self._rich_root_upgrade():
4435
 
            import bzrlib.fetch
4436
 
            return bzrlib.fetch.Inter1and2Helper(
4437
 
                self.from_repository).generate_root_texts(revs)
4438
 
        else:
4439
 
            return []
4440
 
 
4441
 
    def get_stream(self, search):
4442
 
        phase = 'file'
4443
 
        revs = search.get_keys()
4444
 
        graph = self.from_repository.get_graph()
4445
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4446
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4447
 
        text_keys = []
4448
 
        for knit_kind, file_id, revisions in data_to_fetch:
4449
 
            if knit_kind != phase:
4450
 
                phase = knit_kind
4451
 
                # Make a new progress bar for this phase
4452
 
            if knit_kind == "file":
4453
 
                # Accumulate file texts
4454
 
                text_keys.extend([(file_id, revision) for revision in
4455
 
                    revisions])
4456
 
            elif knit_kind == "inventory":
4457
 
                # Now copy the file texts.
4458
 
                from_texts = self.from_repository.texts
4459
 
                yield ('texts', from_texts.get_record_stream(
4460
 
                    text_keys, self.to_format._fetch_order,
4461
 
                    not self.to_format._fetch_uses_deltas))
4462
 
                # Cause an error if a text occurs after we have done the
4463
 
                # copy.
4464
 
                text_keys = None
4465
 
                # Before we process the inventory we generate the root
4466
 
                # texts (if necessary) so that the inventories references
4467
 
                # will be valid.
4468
 
                for _ in self._generate_root_texts(revs):
4469
 
                    yield _
4470
 
                # we fetch only the referenced inventories because we do not
4471
 
                # know for unselected inventories whether all their required
4472
 
                # texts are present in the other repository - it could be
4473
 
                # corrupt.
4474
 
                for info in self._get_inventory_stream(revs):
4475
 
                    yield info
4476
 
            elif knit_kind == "signatures":
4477
 
                # Nothing to do here; this will be taken care of when
4478
 
                # _fetch_revision_texts happens.
4479
 
                pass
4480
 
            elif knit_kind == "revisions":
4481
 
                for record in self._fetch_revision_texts(revs):
4482
 
                    yield record
4483
 
            else:
4484
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4485
 
 
4486
 
    def get_stream_for_missing_keys(self, missing_keys):
4487
 
        # missing keys can only occur when we are byte copying and not
4488
 
        # translating (because translation means we don't send
4489
 
        # unreconstructable deltas ever).
4490
 
        keys = {}
4491
 
        keys['texts'] = set()
4492
 
        keys['revisions'] = set()
4493
 
        keys['inventories'] = set()
4494
 
        keys['chk_bytes'] = set()
4495
 
        keys['signatures'] = set()
4496
 
        for key in missing_keys:
4497
 
            keys[key[0]].add(key[1:])
4498
 
        if len(keys['revisions']):
4499
 
            # If we allowed copying revisions at this point, we could end up
4500
 
            # copying a revision without copying its required texts: a
4501
 
            # violation of the requirements for repository integrity.
4502
 
            raise AssertionError(
4503
 
                'cannot copy revisions to fill in missing deltas %s' % (
4504
 
                    keys['revisions'],))
4505
 
        for substream_kind, keys in keys.iteritems():
4506
 
            vf = getattr(self.from_repository, substream_kind)
4507
 
            if vf is None and keys:
4508
 
                    raise AssertionError(
4509
 
                        "cannot fill in keys for a versioned file we don't"
4510
 
                        " have: %s needs %s" % (substream_kind, keys))
4511
 
            if not keys:
4512
 
                # No need to stream something we don't have
4513
 
                continue
4514
 
            if substream_kind == 'inventories':
4515
 
                # Some missing keys are genuinely ghosts, filter those out.
4516
 
                present = self.from_repository.inventories.get_parent_map(keys)
4517
 
                revs = [key[0] for key in present]
4518
 
                # Get the inventory stream more-or-less as we do for the
4519
 
                # original stream; there's no reason to assume that records
4520
 
                # direct from the source will be suitable for the sink.  (Think
4521
 
                # e.g. 2a -> 1.9-rich-root).
4522
 
                for info in self._get_inventory_stream(revs, missing=True):
4523
 
                    yield info
4524
 
                continue
4525
 
 
4526
 
            # Ask for full texts always so that we don't need more round trips
4527
 
            # after this stream.
4528
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4529
 
            # records. The Sink is responsible for doing another check to
4530
 
            # ensure that ghosts don't introduce missing data for future
4531
 
            # fetches.
4532
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4533
 
                self.to_format._fetch_order, True))
4534
 
            yield substream_kind, stream
4535
 
 
4536
 
    def inventory_fetch_order(self):
4537
 
        if self._rich_root_upgrade():
4538
 
            return 'topological'
4539
 
        else:
4540
 
            return self.to_format._fetch_order
4541
 
 
4542
 
    def _rich_root_upgrade(self):
4543
 
        return (not self.from_repository._format.rich_root_data and
4544
 
            self.to_format.rich_root_data)
4545
 
 
4546
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4547
 
        from_format = self.from_repository._format
4548
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4549
 
            from_format.network_name() == self.to_format.network_name()):
4550
 
            raise AssertionError(
4551
 
                "this case should be handled by GroupCHKStreamSource")
4552
 
        elif 'forceinvdeltas' in debug.debug_flags:
4553
 
            return self._get_convertable_inventory_stream(revision_ids,
4554
 
                    delta_versus_null=missing)
4555
 
        elif from_format.network_name() == self.to_format.network_name():
4556
 
            # Same format.
4557
 
            return self._get_simple_inventory_stream(revision_ids,
4558
 
                    missing=missing)
4559
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4560
 
                and from_format._serializer == self.to_format._serializer):
4561
 
            # Essentially the same format.
4562
 
            return self._get_simple_inventory_stream(revision_ids,
4563
 
                    missing=missing)
4564
 
        else:
4565
 
            # Any time we switch serializations, we want to use an
4566
 
            # inventory-delta based approach.
4567
 
            return self._get_convertable_inventory_stream(revision_ids,
4568
 
                    delta_versus_null=missing)
4569
 
 
4570
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4571
 
        # NB: This currently reopens the inventory weave in source;
4572
 
        # using a single stream interface instead would avoid this.
4573
 
        from_weave = self.from_repository.inventories
4574
 
        if missing:
4575
 
            delta_closure = True
4576
 
        else:
4577
 
            delta_closure = not self.delta_on_metadata()
4578
 
        yield ('inventories', from_weave.get_record_stream(
4579
 
            [(rev_id,) for rev_id in revision_ids],
4580
 
            self.inventory_fetch_order(), delta_closure))
4581
 
 
4582
 
    def _get_convertable_inventory_stream(self, revision_ids,
4583
 
                                          delta_versus_null=False):
4584
 
        # The source is using CHKs, but the target either doesn't or it has a
4585
 
        # different serializer.  The StreamSink code expects to be able to
4586
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4587
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4588
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4589
 
        yield ('inventory-deltas',
4590
 
           self._stream_invs_as_deltas(revision_ids,
4591
 
                                       delta_versus_null=delta_versus_null))
4592
 
 
4593
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4594
 
        """Return a stream of inventory-deltas for the given rev ids.
4595
 
 
4596
 
        :param revision_ids: The list of inventories to transmit
4597
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4598
 
            entry, instead compute the delta versus the NULL_REVISION. This
4599
 
            effectively streams a complete inventory. Used for stuff like
4600
 
            filling in missing parents, etc.
4601
 
        """
4602
 
        from_repo = self.from_repository
4603
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4604
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4605
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4606
 
        # method...
4607
 
        inventories = self.from_repository.iter_inventories(
4608
 
            revision_ids, 'topological')
4609
 
        format = from_repo._format
4610
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4611
 
        inventory_cache = lru_cache.LRUCache(50)
4612
 
        null_inventory = from_repo.revision_tree(
4613
 
            _mod_revision.NULL_REVISION).inventory
4614
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4615
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4616
 
        # repo back into a non-rich-root repo ought to be allowed)
4617
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4618
 
            versioned_root=format.rich_root_data,
4619
 
            tree_references=format.supports_tree_reference)
4620
 
        for inv in inventories:
4621
 
            key = (inv.revision_id,)
4622
 
            parent_keys = parent_map.get(key, ())
4623
 
            delta = None
4624
 
            if not delta_versus_null and parent_keys:
4625
 
                # The caller did not ask for complete inventories and we have
4626
 
                # some parents that we can delta against.  Make a delta against
4627
 
                # each parent so that we can find the smallest.
4628
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4629
 
                for parent_id in parent_ids:
4630
 
                    if parent_id not in invs_sent_so_far:
4631
 
                        # We don't know that the remote side has this basis, so
4632
 
                        # we can't use it.
4633
 
                        continue
4634
 
                    if parent_id == _mod_revision.NULL_REVISION:
4635
 
                        parent_inv = null_inventory
4636
 
                    else:
4637
 
                        parent_inv = inventory_cache.get(parent_id, None)
4638
 
                        if parent_inv is None:
4639
 
                            parent_inv = from_repo.get_inventory(parent_id)
4640
 
                    candidate_delta = inv._make_delta(parent_inv)
4641
 
                    if (delta is None or
4642
 
                        len(delta) > len(candidate_delta)):
4643
 
                        delta = candidate_delta
4644
 
                        basis_id = parent_id
4645
 
            if delta is None:
4646
 
                # Either none of the parents ended up being suitable, or we
4647
 
                # were asked to delta against NULL
4648
 
                basis_id = _mod_revision.NULL_REVISION
4649
 
                delta = inv._make_delta(null_inventory)
4650
 
            invs_sent_so_far.add(inv.revision_id)
4651
 
            inventory_cache[inv.revision_id] = inv
4652
 
            delta_serialized = ''.join(
4653
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4654
 
            yield versionedfile.FulltextContentFactory(
4655
 
                key, parent_keys, None, delta_serialized)
4656
 
 
4657
 
 
4658
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4659
 
                    stop_revision=None):
4660
 
    """Extend the partial history to include a given index
4661
 
 
4662
 
    If a stop_index is supplied, stop when that index has been reached.
4663
 
    If a stop_revision is supplied, stop when that revision is
4664
 
    encountered.  Otherwise, stop when the beginning of history is
4665
 
    reached.
4666
 
 
4667
 
    :param stop_index: The index which should be present.  When it is
4668
 
        present, history extension will stop.
4669
 
    :param stop_revision: The revision id which should be present.  When
4670
 
        it is encountered, history extension will stop.
4671
 
    """
4672
 
    start_revision = partial_history_cache[-1]
4673
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4674
 
    try:
4675
 
        #skip the last revision in the list
4676
 
        iterator.next()
4677
 
        while True:
4678
 
            if (stop_index is not None and
4679
 
                len(partial_history_cache) > stop_index):
4680
 
                break
4681
 
            if partial_history_cache[-1] == stop_revision:
4682
 
                break
4683
 
            revision_id = iterator.next()
4684
 
            partial_history_cache.append(revision_id)
4685
 
    except StopIteration:
4686
 
        # No more history
4687
 
        return
4688