~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-06 20:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4088.
  • Revision ID: john@arbash-meinel.com-20090306204240-mzjavv31z3gu1x7i
Fix a small bug in setup.py when an extension fails to build

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
27
    errors,
30
 
    fetch as _mod_fetch,
31
28
    fifo_cache,
32
29
    generate_ids,
33
30
    gpg,
34
31
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
32
    lazy_regex,
38
33
    lockable_files,
39
34
    lockdir,
40
35
    lru_cache,
41
36
    osutils,
 
37
    remote,
42
38
    revision as _mod_revision,
43
39
    symbol_versioning,
44
 
    trace,
45
40
    tsort,
46
41
    ui,
47
42
    versionedfile,
52
47
from bzrlib.testament import Testament
53
48
""")
54
49
 
55
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
51
from bzrlib.inter import InterObject
57
 
from bzrlib.inventory import (
58
 
    Inventory,
59
 
    InventoryDirectory,
60
 
    ROOT_ID,
61
 
    entry_factory,
62
 
    )
63
 
from bzrlib.lock import _RelockDebugMixin
 
52
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
64
53
from bzrlib import registry
 
54
from bzrlib.symbol_versioning import (
 
55
        deprecated_method,
 
56
        one_one,
 
57
        one_two,
 
58
        one_six,
 
59
        )
65
60
from bzrlib.trace import (
66
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
67
62
 
131
126
        # valid. Callers that will call record_delete() should call
132
127
        # .will_record_deletes() to indicate that.
133
128
        self._recording_deletes = False
134
 
        # memo'd check for no-op commits.
135
 
        self._any_changes = False
136
 
 
137
 
    def any_changes(self):
138
 
        """Return True if any entries were changed.
139
 
        
140
 
        This includes merge-only changes. It is the core for the --unchanged
141
 
        detection in commit.
142
 
 
143
 
        :return: True if any changes have occured.
144
 
        """
145
 
        return self._any_changes
146
129
 
147
130
    def _validate_unicode_text(self, text, context):
148
131
        """Verify things like commit messages don't have bogus characters."""
193
176
        deserializing the inventory, while we already have a copy in
194
177
        memory.
195
178
        """
196
 
        if self.new_inventory is None:
197
 
            self.new_inventory = self.repository.get_inventory(
198
 
                self._new_revision_id)
199
179
        return RevisionTree(self.repository, self.new_inventory,
200
 
            self._new_revision_id)
 
180
                            self._new_revision_id)
201
181
 
202
182
    def finish_inventory(self):
203
 
        """Tell the builder that the inventory is finished.
204
 
 
205
 
        :return: The inventory id in the repository, which can be used with
206
 
            repository.get_inventory.
207
 
        """
208
 
        if self.new_inventory is None:
209
 
            # an inventory delta was accumulated without creating a new
210
 
            # inventory.
211
 
            basis_id = self.basis_delta_revision
212
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
213
 
            # because self.new_inventory is used to hint to the rest of the
214
 
            # system what code path was taken
215
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
216
 
                basis_id, self._basis_delta, self._new_revision_id,
217
 
                self.parents)
218
 
        else:
219
 
            if self.new_inventory.root is None:
220
 
                raise AssertionError('Root entry should be supplied to'
221
 
                    ' record_entry_contents, as of bzr 0.10.')
222
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
223
 
            self.new_inventory.revision_id = self._new_revision_id
224
 
            self.inv_sha1 = self.repository.add_inventory(
225
 
                self._new_revision_id,
226
 
                self.new_inventory,
227
 
                self.parents
228
 
                )
229
 
        return self._new_revision_id
 
183
        """Tell the builder that the inventory is finished."""
 
184
        if self.new_inventory.root is None:
 
185
            raise AssertionError('Root entry should be supplied to'
 
186
                ' record_entry_contents, as of bzr 0.10.')
 
187
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
188
        self.new_inventory.revision_id = self._new_revision_id
 
189
        self.inv_sha1 = self.repository.add_inventory(
 
190
            self._new_revision_id,
 
191
            self.new_inventory,
 
192
            self.parents
 
193
            )
230
194
 
231
195
    def _gen_revision_id(self):
232
196
        """Return new revision-id."""
269
233
        # _new_revision_id
270
234
        ie.revision = self._new_revision_id
271
235
 
272
 
    def _require_root_change(self, tree):
273
 
        """Enforce an appropriate root object change.
274
 
 
275
 
        This is called once when record_iter_changes is called, if and only if
276
 
        the root was not in the delta calculated by record_iter_changes.
277
 
 
278
 
        :param tree: The tree which is being committed.
279
 
        """
280
 
        # NB: if there are no parents then this method is not called, so no
281
 
        # need to guard on parents having length.
282
 
        entry = entry_factory['directory'](tree.path2id(''), '',
283
 
            None)
284
 
        entry.revision = self._new_revision_id
285
 
        self._basis_delta.append(('', '', entry.file_id, entry))
286
 
 
287
236
    def _get_delta(self, ie, basis_inv, path):
288
237
        """Get a delta against the basis inventory for ie."""
289
238
        if ie.file_id not in basis_inv:
331
280
            raise AssertionError("recording deletes not activated.")
332
281
        delta = (path, None, file_id, None)
333
282
        self._basis_delta.append(delta)
334
 
        self._any_changes = True
335
283
        return delta
336
284
 
337
285
    def will_record_deletes(self):
342
290
        builder.record_delete().
343
291
        """
344
292
        self._recording_deletes = True
345
 
        try:
346
 
            basis_id = self.parents[0]
347
 
        except IndexError:
348
 
            basis_id = _mod_revision.NULL_REVISION
349
 
        self.basis_delta_revision = basis_id
350
293
 
351
294
    def record_entry_contents(self, ie, parent_invs, path, tree,
352
295
        content_summary):
472
415
            if content_summary[2] is None:
473
416
                raise ValueError("Files must not have executable = None")
474
417
            if not store:
475
 
                # We can't trust a check of the file length because of content
476
 
                # filtering...
477
 
                if (# if the exec bit has changed we have to store:
 
418
                if (# if the file length changed we have to store:
 
419
                    parent_entry.text_size != content_summary[1] or
 
420
                    # if the exec bit has changed we have to store:
478
421
                    parent_entry.executable != content_summary[2]):
479
422
                    store = True
480
423
                elif parent_entry.text_sha1 == content_summary[3]:
499
442
            ie.executable = content_summary[2]
500
443
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
501
444
            try:
502
 
                text = file_obj.read()
 
445
                lines = file_obj.readlines()
503
446
            finally:
504
447
                file_obj.close()
505
448
            try:
506
449
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
507
 
                    ie.file_id, text, heads, nostore_sha)
 
450
                    ie.file_id, lines, heads, nostore_sha)
508
451
                # Let the caller know we generated a stat fingerprint.
509
452
                fingerprint = (ie.text_sha1, stat_value)
510
453
            except errors.ExistingContent:
522
465
                # carry over:
523
466
                ie.revision = parent_entry.revision
524
467
                return self._get_delta(ie, basis_inv, path), False, None
525
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
468
            lines = []
 
469
            self._add_text_to_weave(ie.file_id, lines, heads, None)
526
470
        elif kind == 'symlink':
527
471
            current_link_target = content_summary[3]
528
472
            if not store:
536
480
                ie.symlink_target = parent_entry.symlink_target
537
481
                return self._get_delta(ie, basis_inv, path), False, None
538
482
            ie.symlink_target = current_link_target
539
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
483
            lines = []
 
484
            self._add_text_to_weave(ie.file_id, lines, heads, None)
540
485
        elif kind == 'tree-reference':
541
486
            if not store:
542
487
                if content_summary[3] != parent_entry.reference_revision:
547
492
                ie.revision = parent_entry.revision
548
493
                return self._get_delta(ie, basis_inv, path), False, None
549
494
            ie.reference_revision = content_summary[3]
550
 
            if ie.reference_revision is None:
551
 
                raise AssertionError("invalid content_summary for nested tree: %r"
552
 
                    % (content_summary,))
553
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
495
            lines = []
 
496
            self._add_text_to_weave(ie.file_id, lines, heads, None)
554
497
        else:
555
498
            raise NotImplementedError('unknown kind')
556
499
        ie.revision = self._new_revision_id
557
 
        self._any_changes = True
558
500
        return self._get_delta(ie, basis_inv, path), True, fingerprint
559
501
 
560
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
561
 
        _entry_factory=entry_factory):
562
 
        """Record a new tree via iter_changes.
563
 
 
564
 
        :param tree: The tree to obtain text contents from for changed objects.
565
 
        :param basis_revision_id: The revision id of the tree the iter_changes
566
 
            has been generated against. Currently assumed to be the same
567
 
            as self.parents[0] - if it is not, errors may occur.
568
 
        :param iter_changes: An iter_changes iterator with the changes to apply
569
 
            to basis_revision_id. The iterator must not include any items with
570
 
            a current kind of None - missing items must be either filtered out
571
 
            or errored-on beefore record_iter_changes sees the item.
572
 
        :param _entry_factory: Private method to bind entry_factory locally for
573
 
            performance.
574
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
575
 
            tree._observed_sha1.
576
 
        """
577
 
        # Create an inventory delta based on deltas between all the parents and
578
 
        # deltas between all the parent inventories. We use inventory delta's 
579
 
        # between the inventory objects because iter_changes masks
580
 
        # last-changed-field only changes.
581
 
        # Working data:
582
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
583
 
        # parents, names, kinds, executables
584
 
        merged_ids = {}
585
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
586
 
        # trees that are not parents[0]
587
 
        parent_entries = {}
588
 
        ghost_basis = False
589
 
        try:
590
 
            revtrees = list(self.repository.revision_trees(self.parents))
591
 
        except errors.NoSuchRevision:
592
 
            # one or more ghosts, slow path.
593
 
            revtrees = []
594
 
            for revision_id in self.parents:
595
 
                try:
596
 
                    revtrees.append(self.repository.revision_tree(revision_id))
597
 
                except errors.NoSuchRevision:
598
 
                    if not revtrees:
599
 
                        basis_revision_id = _mod_revision.NULL_REVISION
600
 
                        ghost_basis = True
601
 
                    revtrees.append(self.repository.revision_tree(
602
 
                        _mod_revision.NULL_REVISION))
603
 
        # The basis inventory from a repository 
604
 
        if revtrees:
605
 
            basis_inv = revtrees[0].inventory
606
 
        else:
607
 
            basis_inv = self.repository.revision_tree(
608
 
                _mod_revision.NULL_REVISION).inventory
609
 
        if len(self.parents) > 0:
610
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
611
 
                raise Exception(
612
 
                    "arbitrary basis parents not yet supported with merges")
613
 
            for revtree in revtrees[1:]:
614
 
                for change in revtree.inventory._make_delta(basis_inv):
615
 
                    if change[1] is None:
616
 
                        # Not present in this parent.
617
 
                        continue
618
 
                    if change[2] not in merged_ids:
619
 
                        if change[0] is not None:
620
 
                            basis_entry = basis_inv[change[2]]
621
 
                            merged_ids[change[2]] = [
622
 
                                # basis revid
623
 
                                basis_entry.revision,
624
 
                                # new tree revid
625
 
                                change[3].revision]
626
 
                            parent_entries[change[2]] = {
627
 
                                # basis parent
628
 
                                basis_entry.revision:basis_entry,
629
 
                                # this parent 
630
 
                                change[3].revision:change[3],
631
 
                                }
632
 
                        else:
633
 
                            merged_ids[change[2]] = [change[3].revision]
634
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
635
 
                    else:
636
 
                        merged_ids[change[2]].append(change[3].revision)
637
 
                        parent_entries[change[2]][change[3].revision] = change[3]
638
 
        else:
639
 
            merged_ids = {}
640
 
        # Setup the changes from the tree:
641
 
        # changes maps file_id -> (change, [parent revision_ids])
642
 
        changes= {}
643
 
        for change in iter_changes:
644
 
            # This probably looks up in basis_inv way to much.
645
 
            if change[1][0] is not None:
646
 
                head_candidate = [basis_inv[change[0]].revision]
647
 
            else:
648
 
                head_candidate = []
649
 
            changes[change[0]] = change, merged_ids.get(change[0],
650
 
                head_candidate)
651
 
        unchanged_merged = set(merged_ids) - set(changes)
652
 
        # Extend the changes dict with synthetic changes to record merges of
653
 
        # texts.
654
 
        for file_id in unchanged_merged:
655
 
            # Record a merged version of these items that did not change vs the
656
 
            # basis. This can be either identical parallel changes, or a revert
657
 
            # of a specific file after a merge. The recorded content will be
658
 
            # that of the current tree (which is the same as the basis), but
659
 
            # the per-file graph will reflect a merge.
660
 
            # NB:XXX: We are reconstructing path information we had, this
661
 
            # should be preserved instead.
662
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
663
 
            #   changed_content, versioned, parent, name, kind,
664
 
            #   executable)
665
 
            try:
666
 
                basis_entry = basis_inv[file_id]
667
 
            except errors.NoSuchId:
668
 
                # a change from basis->some_parents but file_id isn't in basis
669
 
                # so was new in the merge, which means it must have changed
670
 
                # from basis -> current, and as it hasn't the add was reverted
671
 
                # by the user. So we discard this change.
672
 
                pass
673
 
            else:
674
 
                change = (file_id,
675
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
676
 
                    False, (True, True),
677
 
                    (basis_entry.parent_id, basis_entry.parent_id),
678
 
                    (basis_entry.name, basis_entry.name),
679
 
                    (basis_entry.kind, basis_entry.kind),
680
 
                    (basis_entry.executable, basis_entry.executable))
681
 
                changes[file_id] = (change, merged_ids[file_id])
682
 
        # changes contains tuples with the change and a set of inventory
683
 
        # candidates for the file.
684
 
        # inv delta is:
685
 
        # old_path, new_path, file_id, new_inventory_entry
686
 
        seen_root = False # Is the root in the basis delta?
687
 
        inv_delta = self._basis_delta
688
 
        modified_rev = self._new_revision_id
689
 
        for change, head_candidates in changes.values():
690
 
            if change[3][1]: # versioned in target.
691
 
                # Several things may be happening here:
692
 
                # We may have a fork in the per-file graph
693
 
                #  - record a change with the content from tree
694
 
                # We may have a change against < all trees  
695
 
                #  - carry over the tree that hasn't changed
696
 
                # We may have a change against all trees
697
 
                #  - record the change with the content from tree
698
 
                kind = change[6][1]
699
 
                file_id = change[0]
700
 
                entry = _entry_factory[kind](file_id, change[5][1],
701
 
                    change[4][1])
702
 
                head_set = self._heads(change[0], set(head_candidates))
703
 
                heads = []
704
 
                # Preserve ordering.
705
 
                for head_candidate in head_candidates:
706
 
                    if head_candidate in head_set:
707
 
                        heads.append(head_candidate)
708
 
                        head_set.remove(head_candidate)
709
 
                carried_over = False
710
 
                if len(heads) == 1:
711
 
                    # Could be a carry-over situation:
712
 
                    parent_entry_revs = parent_entries.get(file_id, None)
713
 
                    if parent_entry_revs:
714
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
715
 
                    else:
716
 
                        parent_entry = None
717
 
                    if parent_entry is None:
718
 
                        # The parent iter_changes was called against is the one
719
 
                        # that is the per-file head, so any change is relevant
720
 
                        # iter_changes is valid.
721
 
                        carry_over_possible = False
722
 
                    else:
723
 
                        # could be a carry over situation
724
 
                        # A change against the basis may just indicate a merge,
725
 
                        # we need to check the content against the source of the
726
 
                        # merge to determine if it was changed after the merge
727
 
                        # or carried over.
728
 
                        if (parent_entry.kind != entry.kind or
729
 
                            parent_entry.parent_id != entry.parent_id or
730
 
                            parent_entry.name != entry.name):
731
 
                            # Metadata common to all entries has changed
732
 
                            # against per-file parent
733
 
                            carry_over_possible = False
734
 
                        else:
735
 
                            carry_over_possible = True
736
 
                        # per-type checks for changes against the parent_entry
737
 
                        # are done below.
738
 
                else:
739
 
                    # Cannot be a carry-over situation
740
 
                    carry_over_possible = False
741
 
                # Populate the entry in the delta
742
 
                if kind == 'file':
743
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
744
 
                    # after iter_changes examines and decides it has changed,
745
 
                    # we will unconditionally record a new version even if some
746
 
                    # other process reverts it while commit is running (with
747
 
                    # the revert happening after iter_changes did it's
748
 
                    # examination).
749
 
                    if change[7][1]:
750
 
                        entry.executable = True
751
 
                    else:
752
 
                        entry.executable = False
753
 
                    if (carry_over_possible and
754
 
                        parent_entry.executable == entry.executable):
755
 
                            # Check the file length, content hash after reading
756
 
                            # the file.
757
 
                            nostore_sha = parent_entry.text_sha1
758
 
                    else:
759
 
                        nostore_sha = None
760
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
761
 
                    try:
762
 
                        text = file_obj.read()
763
 
                    finally:
764
 
                        file_obj.close()
765
 
                    try:
766
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
767
 
                            file_id, text, heads, nostore_sha)
768
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
769
 
                    except errors.ExistingContent:
770
 
                        # No content change against a carry_over parent
771
 
                        # Perhaps this should also yield a fs hash update?
772
 
                        carried_over = True
773
 
                        entry.text_size = parent_entry.text_size
774
 
                        entry.text_sha1 = parent_entry.text_sha1
775
 
                elif kind == 'symlink':
776
 
                    # Wants a path hint?
777
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
778
 
                    if (carry_over_possible and
779
 
                        parent_entry.symlink_target == entry.symlink_target):
780
 
                        carried_over = True
781
 
                    else:
782
 
                        self._add_text_to_weave(change[0], '', heads, None)
783
 
                elif kind == 'directory':
784
 
                    if carry_over_possible:
785
 
                        carried_over = True
786
 
                    else:
787
 
                        # Nothing to set on the entry.
788
 
                        # XXX: split into the Root and nonRoot versions.
789
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
790
 
                            self._add_text_to_weave(change[0], '', heads, None)
791
 
                elif kind == 'tree-reference':
792
 
                    if not self.repository._format.supports_tree_reference:
793
 
                        # This isn't quite sane as an error, but we shouldn't
794
 
                        # ever see this code path in practice: tree's don't
795
 
                        # permit references when the repo doesn't support tree
796
 
                        # references.
797
 
                        raise errors.UnsupportedOperation(tree.add_reference,
798
 
                            self.repository)
799
 
                    reference_revision = tree.get_reference_revision(change[0])
800
 
                    entry.reference_revision = reference_revision
801
 
                    if (carry_over_possible and
802
 
                        parent_entry.reference_revision == reference_revision):
803
 
                        carried_over = True
804
 
                    else:
805
 
                        self._add_text_to_weave(change[0], '', heads, None)
806
 
                else:
807
 
                    raise AssertionError('unknown kind %r' % kind)
808
 
                if not carried_over:
809
 
                    entry.revision = modified_rev
810
 
                else:
811
 
                    entry.revision = parent_entry.revision
812
 
            else:
813
 
                entry = None
814
 
            new_path = change[1][1]
815
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
816
 
            if new_path == '':
817
 
                seen_root = True
818
 
        self.new_inventory = None
819
 
        if len(inv_delta):
820
 
            # This should perhaps be guarded by a check that the basis we
821
 
            # commit against is the basis for the commit and if not do a delta
822
 
            # against the basis.
823
 
            self._any_changes = True
824
 
        if not seen_root:
825
 
            # housekeeping root entry changes do not affect no-change commits.
826
 
            self._require_root_change(tree)
827
 
        self.basis_delta_revision = basis_revision_id
828
 
 
829
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
830
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
831
 
        return self.repository.texts._add_text(
832
 
            (file_id, self._new_revision_id), parent_keys, new_text,
833
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
502
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
503
        # Note: as we read the content directly from the tree, we know its not
 
504
        # been turned into unicode or badly split - but a broken tree
 
505
        # implementation could give us bad output from readlines() so this is
 
506
        # not a guarantee of safety. What would be better is always checking
 
507
        # the content during test suite execution. RBC 20070912
 
508
        parent_keys = tuple((file_id, parent) for parent in parents)
 
509
        return self.repository.texts.add_lines(
 
510
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
511
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
512
            check_content=False)[0:2]
834
513
 
835
514
 
836
515
class RootCommitBuilder(CommitBuilder):
848
527
        :param tree: The tree that is being committed.
849
528
        """
850
529
 
851
 
    def _require_root_change(self, tree):
852
 
        """Enforce an appropriate root object change.
853
 
 
854
 
        This is called once when record_iter_changes is called, if and only if
855
 
        the root was not in the delta calculated by record_iter_changes.
856
 
 
857
 
        :param tree: The tree which is being committed.
858
 
        """
859
 
        # versioned roots do not change unless the tree found a change.
860
 
 
861
530
 
862
531
######################################################################
863
532
# Repositories
864
533
 
865
 
 
866
 
class Repository(_RelockDebugMixin):
 
534
class Repository(object):
867
535
    """Repository holding history for one or more branches.
868
536
 
869
537
    The repository holds and retrieves historical information including
871
539
    which views a particular line of development through that history.
872
540
 
873
541
    The Repository builds on top of some byte storage facilies (the revisions,
874
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
875
 
    which respectively provide byte storage and a means to access the (possibly
 
542
    signatures, inventories and texts attributes) and a Transport, which
 
543
    respectively provide byte storage and a means to access the (possibly
876
544
    remote) disk.
877
545
 
878
546
    The byte storage facilities are addressed via tuples, which we refer to
879
547
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
880
548
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
881
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
882
 
    byte string made up of a hash identifier and a hash value.
883
 
    We use this interface because it allows low friction with the underlying
884
 
    code that implements disk indices, network encoding and other parts of
885
 
    bzrlib.
 
549
    (file_id, revision_id). We use this interface because it allows low
 
550
    friction with the underlying code that implements disk indices, network
 
551
    encoding and other parts of bzrlib.
886
552
 
887
553
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
888
554
        the serialised revisions for the repository. This can be used to obtain
907
573
        The result of trying to insert data into the repository via this store
908
574
        is undefined: it should be considered read-only except for implementors
909
575
        of repositories.
910
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
911
 
        any data the repository chooses to store or have indexed by its hash.
912
 
        The result of trying to insert data into the repository via this store
913
 
        is undefined: it should be considered read-only except for implementors
914
 
        of repositories.
915
576
    :ivar _transport: Transport for file access to repository, typically
916
577
        pointing to .bzr/repository.
917
578
    """
938
599
        """
939
600
        if self._write_group is not self.get_transaction():
940
601
            # has an unlock or relock occured ?
941
 
            if suppress_errors:
942
 
                mutter(
943
 
                '(suppressed) mismatched lock context and write group. %r, %r',
944
 
                self._write_group, self.get_transaction())
945
 
                return
946
 
            raise errors.BzrError(
947
 
                'mismatched lock context and write group. %r, %r' %
948
 
                (self._write_group, self.get_transaction()))
 
602
            raise errors.BzrError('mismatched lock context and write group.')
949
603
        try:
950
604
            self._abort_write_group()
951
605
        except Exception, exc:
977
631
        """
978
632
        if not self._format.supports_external_lookups:
979
633
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
980
 
        if self.is_locked():
981
 
            # This repository will call fallback.unlock() when we transition to
982
 
            # the unlocked state, so we make sure to increment the lock count
983
 
            repository.lock_read()
984
634
        self._check_fallback_repository(repository)
985
635
        self._fallback_repositories.append(repository)
986
636
        self.texts.add_fallback_versioned_files(repository.texts)
987
637
        self.inventories.add_fallback_versioned_files(repository.inventories)
988
638
        self.revisions.add_fallback_versioned_files(repository.revisions)
989
639
        self.signatures.add_fallback_versioned_files(repository.signatures)
990
 
        if self.chk_bytes is not None:
991
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
992
640
 
993
641
    def _check_fallback_repository(self, repository):
994
642
        """Check that this repository can fallback to repository safely.
1018
666
                % (inv.revision_id, revision_id))
1019
667
        if inv.root is None:
1020
668
            raise AssertionError()
1021
 
        return self._add_inventory_checked(revision_id, inv, parents)
1022
 
 
1023
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1024
 
        """Add inv to the repository after checking the inputs.
1025
 
 
1026
 
        This function can be overridden to allow different inventory styles.
1027
 
 
1028
 
        :seealso: add_inventory, for the contract.
1029
 
        """
1030
669
        inv_lines = self._serialise_inventory_to_lines(inv)
1031
670
        return self._inventory_add_lines(revision_id, parents,
1032
671
            inv_lines, check_content=False)
1033
672
 
1034
673
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1035
 
                               parents, basis_inv=None, propagate_caches=False):
 
674
                               parents):
1036
675
        """Add a new inventory expressed as a delta against another revision.
1037
676
 
1038
 
        See the inventory developers documentation for the theory behind
1039
 
        inventory deltas.
1040
 
 
1041
677
        :param basis_revision_id: The inventory id the delta was created
1042
678
            against. (This does not have to be a direct parent.)
1043
679
        :param delta: The inventory delta (see Inventory.apply_delta for
1049
685
            for repositories that depend on the inventory graph for revision
1050
686
            graph access, as well as for those that pun ancestry with delta
1051
687
            compression.
1052
 
        :param basis_inv: The basis inventory if it is already known,
1053
 
            otherwise None.
1054
 
        :param propagate_caches: If True, the caches for this inventory are
1055
 
          copied to and updated for the result if possible.
1056
688
 
1057
689
        :returns: (validator, new_inv)
1058
690
            The validator(which is a sha1 digest, though what is sha'd is
1069
701
            # inventory implementations may support: A better idiom would be to
1070
702
            # return a new inventory, but as there is no revision tree cache in
1071
703
            # repository this is safe for now - RBC 20081013
1072
 
            if basis_inv is None:
1073
 
                basis_inv = basis_tree.inventory
 
704
            basis_inv = basis_tree.inventory
1074
705
            basis_inv.apply_delta(delta)
1075
706
            basis_inv.revision_id = new_revision_id
1076
707
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1082
713
        check_content=True):
1083
714
        """Store lines in inv_vf and return the sha1 of the inventory."""
1084
715
        parents = [(parent,) for parent in parents]
1085
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
716
        return self.inventories.add_lines((revision_id,), parents, lines,
1086
717
            check_content=check_content)[0]
1087
 
        self.inventories._access.flush()
1088
 
        return result
1089
718
 
1090
719
    def add_revision(self, revision_id, rev, inv=None, config=None):
1091
720
        """Add rev to the revision store as revision_id.
1167
796
        # The old API returned a list, should this actually be a set?
1168
797
        return parent_map.keys()
1169
798
 
1170
 
    def _check_inventories(self, checker):
1171
 
        """Check the inventories found from the revision scan.
1172
 
        
1173
 
        This is responsible for verifying the sha1 of inventories and
1174
 
        creating a pending_keys set that covers data referenced by inventories.
1175
 
        """
1176
 
        bar = ui.ui_factory.nested_progress_bar()
1177
 
        try:
1178
 
            self._do_check_inventories(checker, bar)
1179
 
        finally:
1180
 
            bar.finished()
1181
 
 
1182
 
    def _do_check_inventories(self, checker, bar):
1183
 
        """Helper for _check_inventories."""
1184
 
        revno = 0
1185
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1186
 
        kinds = ['chk_bytes', 'texts']
1187
 
        count = len(checker.pending_keys)
1188
 
        bar.update("inventories", 0, 2)
1189
 
        current_keys = checker.pending_keys
1190
 
        checker.pending_keys = {}
1191
 
        # Accumulate current checks.
1192
 
        for key in current_keys:
1193
 
            if key[0] != 'inventories' and key[0] not in kinds:
1194
 
                checker._report_items.append('unknown key type %r' % (key,))
1195
 
            keys[key[0]].add(key[1:])
1196
 
        if keys['inventories']:
1197
 
            # NB: output order *should* be roughly sorted - topo or
1198
 
            # inverse topo depending on repository - either way decent
1199
 
            # to just delta against. However, pre-CHK formats didn't
1200
 
            # try to optimise inventory layout on disk. As such the
1201
 
            # pre-CHK code path does not use inventory deltas.
1202
 
            last_object = None
1203
 
            for record in self.inventories.check(keys=keys['inventories']):
1204
 
                if record.storage_kind == 'absent':
1205
 
                    checker._report_items.append(
1206
 
                        'Missing inventory {%s}' % (record.key,))
1207
 
                else:
1208
 
                    last_object = self._check_record('inventories', record,
1209
 
                        checker, last_object,
1210
 
                        current_keys[('inventories',) + record.key])
1211
 
            del keys['inventories']
1212
 
        else:
1213
 
            return
1214
 
        bar.update("texts", 1)
1215
 
        while (checker.pending_keys or keys['chk_bytes']
1216
 
            or keys['texts']):
1217
 
            # Something to check.
1218
 
            current_keys = checker.pending_keys
1219
 
            checker.pending_keys = {}
1220
 
            # Accumulate current checks.
1221
 
            for key in current_keys:
1222
 
                if key[0] not in kinds:
1223
 
                    checker._report_items.append('unknown key type %r' % (key,))
1224
 
                keys[key[0]].add(key[1:])
1225
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1226
 
            for kind in kinds:
1227
 
                if keys[kind]:
1228
 
                    last_object = None
1229
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1230
 
                        if record.storage_kind == 'absent':
1231
 
                            checker._report_items.append(
1232
 
                                'Missing %s {%s}' % (kind, record.key,))
1233
 
                        else:
1234
 
                            last_object = self._check_record(kind, record,
1235
 
                                checker, last_object, current_keys[(kind,) + record.key])
1236
 
                    keys[kind] = set()
1237
 
                    break
1238
 
 
1239
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1240
 
        """Check a single text from this repository."""
1241
 
        if kind == 'inventories':
1242
 
            rev_id = record.key[0]
1243
 
            inv = self._deserialise_inventory(rev_id,
1244
 
                record.get_bytes_as('fulltext'))
1245
 
            if last_object is not None:
1246
 
                delta = inv._make_delta(last_object)
1247
 
                for old_path, path, file_id, ie in delta:
1248
 
                    if ie is None:
1249
 
                        continue
1250
 
                    ie.check(checker, rev_id, inv)
1251
 
            else:
1252
 
                for path, ie in inv.iter_entries():
1253
 
                    ie.check(checker, rev_id, inv)
1254
 
            if self._format.fast_deltas:
1255
 
                return inv
1256
 
        elif kind == 'chk_bytes':
1257
 
            # No code written to check chk_bytes for this repo format.
1258
 
            checker._report_items.append(
1259
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1260
 
        elif kind == 'texts':
1261
 
            self._check_text(record, checker, item_data)
1262
 
        else:
1263
 
            checker._report_items.append(
1264
 
                'unknown key type %s for %s' % (kind, record.key))
1265
 
 
1266
 
    def _check_text(self, record, checker, item_data):
1267
 
        """Check a single text."""
1268
 
        # Check it is extractable.
1269
 
        # TODO: check length.
1270
 
        if record.storage_kind == 'chunked':
1271
 
            chunks = record.get_bytes_as(record.storage_kind)
1272
 
            sha1 = osutils.sha_strings(chunks)
1273
 
            length = sum(map(len, chunks))
1274
 
        else:
1275
 
            content = record.get_bytes_as('fulltext')
1276
 
            sha1 = osutils.sha_string(content)
1277
 
            length = len(content)
1278
 
        if item_data and sha1 != item_data[1]:
1279
 
            checker._report_items.append(
1280
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1281
 
                (record.key, sha1, item_data[1], item_data[2]))
1282
 
 
1283
799
    @staticmethod
1284
800
    def create(a_bzrdir):
1285
801
        """Construct the current default format repository in a_bzrdir."""
1306
822
        self._reconcile_does_inventory_gc = True
1307
823
        self._reconcile_fixes_text_parents = False
1308
824
        self._reconcile_backsup_inventory = True
 
825
        # not right yet - should be more semantically clear ?
 
826
        #
 
827
        # TODO: make sure to construct the right store classes, etc, depending
 
828
        # on whether escaping is required.
 
829
        self._warn_if_deprecated()
1309
830
        self._write_group = None
1310
831
        # Additional places to query for data.
1311
832
        self._fallback_repositories = []
1312
833
        # An InventoryEntry cache, used during deserialization
1313
834
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1314
 
        # Is it safe to return inventory entries directly from the entry cache,
1315
 
        # rather copying them?
1316
 
        self._safe_to_return_from_cache = False
1317
835
 
1318
836
    def __repr__(self):
1319
 
        if self._fallback_repositories:
1320
 
            return '%s(%r, fallback_repositories=%r)' % (
1321
 
                self.__class__.__name__,
1322
 
                self.base,
1323
 
                self._fallback_repositories)
1324
 
        else:
1325
 
            return '%s(%r)' % (self.__class__.__name__,
1326
 
                               self.base)
1327
 
 
1328
 
    def _has_same_fallbacks(self, other_repo):
1329
 
        """Returns true if the repositories have the same fallbacks."""
1330
 
        my_fb = self._fallback_repositories
1331
 
        other_fb = other_repo._fallback_repositories
1332
 
        if len(my_fb) != len(other_fb):
1333
 
            return False
1334
 
        for f, g in zip(my_fb, other_fb):
1335
 
            if not f.has_same_location(g):
1336
 
                return False
1337
 
        return True
 
837
        return '%s(%r)' % (self.__class__.__name__,
 
838
                           self.base)
1338
839
 
1339
840
    def has_same_location(self, other):
1340
841
        """Returns a boolean indicating if this repository is at the same
1383
884
 
1384
885
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1385
886
        """
1386
 
        locked = self.is_locked()
1387
887
        result = self.control_files.lock_write(token=token)
1388
 
        if not locked:
1389
 
            self._warn_if_deprecated()
1390
 
            self._note_lock('w')
1391
 
            for repo in self._fallback_repositories:
1392
 
                # Writes don't affect fallback repos
1393
 
                repo.lock_read()
1394
 
            self._refresh_data()
 
888
        for repo in self._fallback_repositories:
 
889
            # Writes don't affect fallback repos
 
890
            repo.lock_read()
 
891
        self._refresh_data()
1395
892
        return result
1396
893
 
1397
894
    def lock_read(self):
1398
 
        locked = self.is_locked()
1399
895
        self.control_files.lock_read()
1400
 
        if not locked:
1401
 
            self._warn_if_deprecated()
1402
 
            self._note_lock('r')
1403
 
            for repo in self._fallback_repositories:
1404
 
                repo.lock_read()
1405
 
            self._refresh_data()
 
896
        for repo in self._fallback_repositories:
 
897
            repo.lock_read()
 
898
        self._refresh_data()
1406
899
 
1407
900
    def get_physical_lock_status(self):
1408
901
        return self.control_files.get_physical_lock_status()
1530
1023
        return InterRepository.get(other, self).search_missing_revision_ids(
1531
1024
            revision_id, find_ghosts)
1532
1025
 
 
1026
    @deprecated_method(one_two)
 
1027
    @needs_read_lock
 
1028
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1029
        """Return the revision ids that other has that this does not.
 
1030
 
 
1031
        These are returned in topological order.
 
1032
 
 
1033
        revision_id: only return revision ids included by revision_id.
 
1034
        """
 
1035
        keys =  self.search_missing_revision_ids(
 
1036
            other, revision_id, find_ghosts).get_keys()
 
1037
        other.lock_read()
 
1038
        try:
 
1039
            parents = other.get_graph().get_parent_map(keys)
 
1040
        finally:
 
1041
            other.unlock()
 
1042
        return tsort.topo_sort(parents)
 
1043
 
1533
1044
    @staticmethod
1534
1045
    def open(base):
1535
1046
        """Open the repository rooted at base.
1552
1063
        """Commit the contents accrued within the current write group.
1553
1064
 
1554
1065
        :seealso: start_write_group.
1555
 
        
1556
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1557
1066
        """
1558
1067
        if self._write_group is not self.get_transaction():
1559
1068
            # has an unlock or relock occured ?
1560
1069
            raise errors.BzrError('mismatched lock context %r and '
1561
1070
                'write group %r.' %
1562
1071
                (self.get_transaction(), self._write_group))
1563
 
        result = self._commit_write_group()
 
1072
        self._commit_write_group()
1564
1073
        self._write_group = None
1565
 
        return result
1566
1074
 
1567
1075
    def _commit_write_group(self):
1568
1076
        """Template method for per-repository write group cleanup.
1576
1084
    def suspend_write_group(self):
1577
1085
        raise errors.UnsuspendableWriteGroup(self)
1578
1086
 
1579
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1580
 
        """Return the keys of missing inventory parents for revisions added in
1581
 
        this write group.
1582
 
 
1583
 
        A revision is not complete if the inventory delta for that revision
1584
 
        cannot be calculated.  Therefore if the parent inventories of a
1585
 
        revision are not present, the revision is incomplete, and e.g. cannot
1586
 
        be streamed by a smart server.  This method finds missing inventory
1587
 
        parents for revisions added in this write group.
1588
 
        """
1589
 
        if not self._format.supports_external_lookups:
1590
 
            # This is only an issue for stacked repositories
1591
 
            return set()
1592
 
        if not self.is_in_write_group():
1593
 
            raise AssertionError('not in a write group')
1594
 
 
1595
 
        # XXX: We assume that every added revision already has its
1596
 
        # corresponding inventory, so we only check for parent inventories that
1597
 
        # might be missing, rather than all inventories.
1598
 
        parents = set(self.revisions._index.get_missing_parents())
1599
 
        parents.discard(_mod_revision.NULL_REVISION)
1600
 
        unstacked_inventories = self.inventories._index
1601
 
        present_inventories = unstacked_inventories.get_parent_map(
1602
 
            key[-1:] for key in parents)
1603
 
        parents.difference_update(present_inventories)
1604
 
        if len(parents) == 0:
1605
 
            # No missing parent inventories.
1606
 
            return set()
1607
 
        if not check_for_missing_texts:
1608
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1609
 
        # Ok, now we have a list of missing inventories.  But these only matter
1610
 
        # if the inventories that reference them are missing some texts they
1611
 
        # appear to introduce.
1612
 
        # XXX: Texts referenced by all added inventories need to be present,
1613
 
        # but at the moment we're only checking for texts referenced by
1614
 
        # inventories at the graph's edge.
1615
 
        key_deps = self.revisions._index._key_dependencies
1616
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1617
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1618
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1619
 
        missing_texts = set()
1620
 
        for file_id, version_ids in file_ids.iteritems():
1621
 
            missing_texts.update(
1622
 
                (file_id, version_id) for version_id in version_ids)
1623
 
        present_texts = self.texts.get_parent_map(missing_texts)
1624
 
        missing_texts.difference_update(present_texts)
1625
 
        if not missing_texts:
1626
 
            # No texts are missing, so all revisions and their deltas are
1627
 
            # reconstructable.
1628
 
            return set()
1629
 
        # Alternatively the text versions could be returned as the missing
1630
 
        # keys, but this is likely to be less data.
1631
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1632
 
        return missing_keys
1633
 
 
1634
 
    def refresh_data(self):
1635
 
        """Re-read any data needed to to synchronise with disk.
1636
 
 
1637
 
        This method is intended to be called after another repository instance
1638
 
        (such as one used by a smart server) has inserted data into the
1639
 
        repository. It may not be called during a write group, but may be
1640
 
        called at any other time.
1641
 
        """
1642
 
        if self.is_in_write_group():
1643
 
            raise errors.InternalBzrError(
1644
 
                "May not refresh_data while in a write group.")
1645
 
        self._refresh_data()
1646
 
 
1647
1087
    def resume_write_group(self, tokens):
1648
1088
        if not self.is_write_locked():
1649
1089
            raise errors.NotWriteLocked(self)
1656
1096
    def _resume_write_group(self, tokens):
1657
1097
        raise errors.UnsuspendableWriteGroup(self)
1658
1098
 
1659
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1660
 
            fetch_spec=None):
 
1099
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1661
1100
        """Fetch the content required to construct revision_id from source.
1662
1101
 
1663
 
        If revision_id is None and fetch_spec is None, then all content is
1664
 
        copied.
1665
 
 
1666
 
        fetch() may not be used when the repository is in a write group -
1667
 
        either finish the current write group before using fetch, or use
1668
 
        fetch before starting the write group.
1669
 
 
 
1102
        If revision_id is None all content is copied.
1670
1103
        :param find_ghosts: Find and copy revisions in the source that are
1671
1104
            ghosts in the target (and not reachable directly by walking out to
1672
1105
            the first-present revision in target from revision_id).
1673
 
        :param revision_id: If specified, all the content needed for this
1674
 
            revision ID will be copied to the target.  Fetch will determine for
1675
 
            itself which content needs to be copied.
1676
 
        :param fetch_spec: If specified, a SearchResult or
1677
 
            PendingAncestryResult that describes which revisions to copy.  This
1678
 
            allows copying multiple heads at once.  Mutually exclusive with
1679
 
            revision_id.
1680
1106
        """
1681
 
        if fetch_spec is not None and revision_id is not None:
1682
 
            raise AssertionError(
1683
 
                "fetch_spec and revision_id are mutually exclusive.")
1684
 
        if self.is_in_write_group():
1685
 
            raise errors.InternalBzrError(
1686
 
                "May not fetch while in a write group.")
1687
1107
        # fast path same-url fetch operations
1688
 
        # TODO: lift out to somewhere common with RemoteRepository
1689
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1690
 
        if (self.has_same_location(source)
1691
 
            and fetch_spec is None
1692
 
            and self._has_same_fallbacks(source)):
 
1108
        if self.has_same_location(source):
1693
1109
            # check that last_revision is in 'from' and then return a
1694
1110
            # no-operation.
1695
1111
            if (revision_id is not None and
1701
1117
        # IncompatibleRepositories when asked to fetch.
1702
1118
        inter = InterRepository.get(source, self)
1703
1119
        return inter.fetch(revision_id=revision_id, pb=pb,
1704
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1120
            find_ghosts=find_ghosts)
1705
1121
 
1706
1122
    def create_bundle(self, target, base, fileobj, format=None):
1707
1123
        return serializer.write_bundle(self, target, base, fileobj, format)
1720
1136
        :param revprops: Optional dictionary of revision properties.
1721
1137
        :param revision_id: Optional revision id.
1722
1138
        """
1723
 
        if self._fallback_repositories:
1724
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1725
 
                "to a stacked branch. See "
1726
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1727
1139
        result = self._commit_builder_class(self, parents, config,
1728
1140
            timestamp, timezone, committer, revprops, revision_id)
1729
1141
        self.start_write_group()
1730
1142
        return result
1731
1143
 
1732
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1733
1144
    def unlock(self):
1734
1145
        if (self.control_files._lock_count == 1 and
1735
1146
            self.control_files._lock_mode == 'w'):
1741
1152
        self.control_files.unlock()
1742
1153
        if self.control_files._lock_count == 0:
1743
1154
            self._inventory_entry_cache.clear()
1744
 
            for repo in self._fallback_repositories:
1745
 
                repo.unlock()
 
1155
        for repo in self._fallback_repositories:
 
1156
            repo.unlock()
1746
1157
 
1747
1158
    @needs_read_lock
1748
1159
    def clone(self, a_bzrdir, revision_id=None):
1857
1268
 
1858
1269
    @needs_read_lock
1859
1270
    def get_revisions(self, revision_ids):
1860
 
        """Get many revisions at once.
1861
 
        
1862
 
        Repositories that need to check data on every revision read should 
1863
 
        subclass this method.
1864
 
        """
 
1271
        """Get many revisions at once."""
1865
1272
        return self._get_revisions(revision_ids)
1866
1273
 
1867
1274
    @needs_read_lock
1868
1275
    def _get_revisions(self, revision_ids):
1869
1276
        """Core work logic to get many revisions without sanity checks."""
 
1277
        for rev_id in revision_ids:
 
1278
            if not rev_id or not isinstance(rev_id, basestring):
 
1279
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1280
        keys = [(key,) for key in revision_ids]
 
1281
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1870
1282
        revs = {}
1871
 
        for revid, rev in self._iter_revisions(revision_ids):
1872
 
            if rev is None:
1873
 
                raise errors.NoSuchRevision(self, revid)
1874
 
            revs[revid] = rev
 
1283
        for record in stream:
 
1284
            if record.storage_kind == 'absent':
 
1285
                raise errors.NoSuchRevision(self, record.key[0])
 
1286
            text = record.get_bytes_as('fulltext')
 
1287
            rev = self._serializer.read_revision_from_string(text)
 
1288
            revs[record.key[0]] = rev
1875
1289
        return [revs[revid] for revid in revision_ids]
1876
1290
 
1877
 
    def _iter_revisions(self, revision_ids):
1878
 
        """Iterate over revision objects.
1879
 
 
1880
 
        :param revision_ids: An iterable of revisions to examine. None may be
1881
 
            passed to request all revisions known to the repository. Note that
1882
 
            not all repositories can find unreferenced revisions; for those
1883
 
            repositories only referenced ones will be returned.
1884
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1885
 
            those asked for but not available) are returned as (revid, None).
1886
 
        """
1887
 
        if revision_ids is None:
1888
 
            revision_ids = self.all_revision_ids()
1889
 
        else:
1890
 
            for rev_id in revision_ids:
1891
 
                if not rev_id or not isinstance(rev_id, basestring):
1892
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1893
 
        keys = [(key,) for key in revision_ids]
1894
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1895
 
        for record in stream:
1896
 
            revid = record.key[0]
1897
 
            if record.storage_kind == 'absent':
1898
 
                yield (revid, None)
1899
 
            else:
1900
 
                text = record.get_bytes_as('fulltext')
1901
 
                rev = self._serializer.read_revision_from_string(text)
1902
 
                yield (revid, rev)
1903
 
 
1904
1291
    @needs_read_lock
1905
1292
    def get_revision_xml(self, revision_id):
1906
1293
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1907
1294
        #       would have already do it.
1908
1295
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1909
 
        # TODO: this can't just be replaced by:
1910
 
        # return self._serializer.write_revision_to_string(
1911
 
        #     self.get_revision(revision_id))
1912
 
        # as cStringIO preservers the encoding unlike write_revision_to_string
1913
 
        # or some other call down the path.
1914
1296
        rev = self.get_revision(revision_id)
1915
1297
        rev_tmp = cStringIO.StringIO()
1916
1298
        # the current serializer..
1918
1300
        rev_tmp.seek(0)
1919
1301
        return rev_tmp.getvalue()
1920
1302
 
1921
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1303
    def get_deltas_for_revisions(self, revisions):
1922
1304
        """Produce a generator of revision deltas.
1923
1305
 
1924
1306
        Note that the input is a sequence of REVISIONS, not revision_ids.
1925
1307
        Trees will be held in memory until the generator exits.
1926
1308
        Each delta is relative to the revision's lefthand predecessor.
1927
 
 
1928
 
        :param specific_fileids: if not None, the result is filtered
1929
 
          so that only those file-ids, their parents and their
1930
 
          children are included.
1931
1309
        """
1932
 
        # Get the revision-ids of interest
1933
1310
        required_trees = set()
1934
1311
        for revision in revisions:
1935
1312
            required_trees.add(revision.revision_id)
1936
1313
            required_trees.update(revision.parent_ids[:1])
1937
 
 
1938
 
        # Get the matching filtered trees. Note that it's more
1939
 
        # efficient to pass filtered trees to changes_from() rather
1940
 
        # than doing the filtering afterwards. changes_from() could
1941
 
        # arguably do the filtering itself but it's path-based, not
1942
 
        # file-id based, so filtering before or afterwards is
1943
 
        # currently easier.
1944
 
        if specific_fileids is None:
1945
 
            trees = dict((t.get_revision_id(), t) for
1946
 
                t in self.revision_trees(required_trees))
1947
 
        else:
1948
 
            trees = dict((t.get_revision_id(), t) for
1949
 
                t in self._filtered_revision_trees(required_trees,
1950
 
                specific_fileids))
1951
 
 
1952
 
        # Calculate the deltas
 
1314
        trees = dict((t.get_revision_id(), t) for
 
1315
                     t in self.revision_trees(required_trees))
1953
1316
        for revision in revisions:
1954
1317
            if not revision.parent_ids:
1955
1318
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1958
1321
            yield trees[revision.revision_id].changes_from(old_tree)
1959
1322
 
1960
1323
    @needs_read_lock
1961
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1324
    def get_revision_delta(self, revision_id):
1962
1325
        """Return the delta for one revision.
1963
1326
 
1964
1327
        The delta is relative to the left-hand predecessor of the
1965
1328
        revision.
1966
 
 
1967
 
        :param specific_fileids: if not None, the result is filtered
1968
 
          so that only those file-ids, their parents and their
1969
 
          children are included.
1970
1329
        """
1971
1330
        r = self.get_revision(revision_id)
1972
 
        return list(self.get_deltas_for_revisions([r],
1973
 
            specific_fileids=specific_fileids))[0]
 
1331
        return list(self.get_deltas_for_revisions([r]))[0]
1974
1332
 
1975
1333
    @needs_write_lock
1976
1334
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1985
1343
    def find_text_key_references(self):
1986
1344
        """Find the text key references within the repository.
1987
1345
 
 
1346
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1347
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1348
        altered it listed explicitly.
1988
1349
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1989
1350
            to whether they were referred to by the inventory of the
1990
1351
            revision_id that they contain. The inventory texts from all present
2079
1440
                result[key] = True
2080
1441
        return result
2081
1442
 
2082
 
    def _inventory_xml_lines_for_keys(self, keys):
2083
 
        """Get a line iterator of the sort needed for findind references.
2084
 
 
2085
 
        Not relevant for non-xml inventory repositories.
2086
 
 
2087
 
        Ghosts in revision_keys are ignored.
2088
 
 
2089
 
        :param revision_keys: The revision keys for the inventories to inspect.
2090
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2091
 
            all of the xml inventories specified by revision_keys.
2092
 
        """
2093
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2094
 
        for record in stream:
2095
 
            if record.storage_kind != 'absent':
2096
 
                chunks = record.get_bytes_as('chunked')
2097
 
                revid = record.key[-1]
2098
 
                lines = osutils.chunks_to_lines(chunks)
2099
 
                for line in lines:
2100
 
                    yield line, revid
2101
 
 
2102
1443
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2103
 
        revision_keys):
 
1444
        revision_ids):
2104
1445
        """Helper routine for fileids_altered_by_revision_ids.
2105
1446
 
2106
1447
        This performs the translation of xml lines to revision ids.
2107
1448
 
2108
1449
        :param line_iterator: An iterator of lines, origin_version_id
2109
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1450
        :param revision_ids: The revision ids to filter for. This should be a
2110
1451
            set or other type which supports efficient __contains__ lookups, as
2111
 
            the revision key from each parsed line will be looked up in the
2112
 
            revision_keys filter.
 
1452
            the revision id from each parsed line will be looked up in the
 
1453
            revision_ids filter.
2113
1454
        :return: a dictionary mapping altered file-ids to an iterable of
2114
1455
        revision_ids. Each altered file-ids has the exact revision_ids that
2115
1456
        altered it listed explicitly.
2116
1457
        """
2117
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2118
 
                line_iterator).iterkeys())
2119
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2120
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2121
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2122
 
        new_keys = seen - parent_seen
2123
1458
        result = {}
2124
1459
        setdefault = result.setdefault
2125
 
        for key in new_keys:
2126
 
            setdefault(key[0], set()).add(key[-1])
 
1460
        for key in \
 
1461
            self._find_text_key_references_from_xml_inventory_lines(
 
1462
                line_iterator).iterkeys():
 
1463
            # once data is all ensured-consistent; then this is
 
1464
            # if revision_id == version_id
 
1465
            if key[-1:] in revision_ids:
 
1466
                setdefault(key[0], set()).add(key[-1])
2127
1467
        return result
2128
1468
 
2129
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2130
 
        """Find all parent ids that are mentioned in the revision graph.
2131
 
 
2132
 
        :return: set of revisions that are parents of revision_ids which are
2133
 
            not part of revision_ids themselves
2134
 
        """
2135
 
        parent_map = self.get_parent_map(revision_ids)
2136
 
        parent_ids = set()
2137
 
        map(parent_ids.update, parent_map.itervalues())
2138
 
        parent_ids.difference_update(revision_ids)
2139
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2140
 
        return parent_ids
2141
 
 
2142
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2143
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2144
 
 
2145
 
        :param revision_keys: An iterable of revision_keys.
2146
 
        :return: The parents of all revision_keys that are not already in
2147
 
            revision_keys
2148
 
        """
2149
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2150
 
        parent_keys = set()
2151
 
        map(parent_keys.update, parent_map.itervalues())
2152
 
        parent_keys.difference_update(revision_keys)
2153
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2154
 
        return parent_keys
2155
 
 
2156
1469
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2157
1470
        """Find the file ids and versions affected by revisions.
2158
1471
 
2165
1478
        """
2166
1479
        selected_keys = set((revid,) for revid in revision_ids)
2167
1480
        w = _inv_weave or self.inventories
2168
 
        return self._find_file_ids_from_xml_inventory_lines(
2169
 
            w.iter_lines_added_or_present_in_keys(
2170
 
                selected_keys, pb=None),
2171
 
            selected_keys)
 
1481
        pb = ui.ui_factory.nested_progress_bar()
 
1482
        try:
 
1483
            return self._find_file_ids_from_xml_inventory_lines(
 
1484
                w.iter_lines_added_or_present_in_keys(
 
1485
                    selected_keys, pb=pb),
 
1486
                selected_keys)
 
1487
        finally:
 
1488
            pb.finished()
2172
1489
 
2173
1490
    def iter_files_bytes(self, desired_files):
2174
1491
        """Iterate through file versions.
2195
1512
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2196
1513
            if record.storage_kind == 'absent':
2197
1514
                raise errors.RevisionNotPresent(record.key, self)
2198
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1515
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2199
1516
 
2200
1517
    def _generate_text_key_index(self, text_key_references=None,
2201
1518
        ancestors=None):
2250
1567
        batch_size = 10 # should be ~150MB on a 55K path tree
2251
1568
        batch_count = len(revision_order) / batch_size + 1
2252
1569
        processed_texts = 0
2253
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1570
        pb.update("Calculating text parents.", processed_texts, text_count)
2254
1571
        for offset in xrange(batch_count):
2255
1572
            to_query = revision_order[offset * batch_size:(offset + 1) *
2256
1573
                batch_size]
2257
1574
            if not to_query:
2258
1575
                break
2259
 
            for revision_id in to_query:
 
1576
            for rev_tree in self.revision_trees(to_query):
 
1577
                revision_id = rev_tree.get_revision_id()
2260
1578
                parent_ids = ancestors[revision_id]
2261
1579
                for text_key in revision_keys[revision_id]:
2262
 
                    pb.update("Calculating text parents", processed_texts)
 
1580
                    pb.update("Calculating text parents.", processed_texts)
2263
1581
                    processed_texts += 1
2264
1582
                    candidate_parents = []
2265
1583
                    for parent_id in parent_ids:
2281
1599
                            except KeyError:
2282
1600
                                inv = self.revision_tree(parent_id).inventory
2283
1601
                                inventory_cache[parent_id] = inv
2284
 
                            try:
2285
 
                                parent_entry = inv[text_key[0]]
2286
 
                            except (KeyError, errors.NoSuchId):
2287
 
                                parent_entry = None
 
1602
                            parent_entry = inv._byid.get(text_key[0], None)
2288
1603
                            if parent_entry is not None:
2289
1604
                                parent_text_key = (
2290
1605
                                    text_key[0], parent_entry.revision)
2315
1630
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2316
1631
            'revisions'.  file-id is None unless knit-kind is 'file'.
2317
1632
        """
2318
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2319
 
            yield result
2320
 
        del _files_pb
2321
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2322
 
            yield result
2323
 
 
2324
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2325
1633
        # XXX: it's a bit weird to control the inventory weave caching in this
2326
1634
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2327
1635
        # maybe this generator should explicitly have the contract that it
2334
1642
        count = 0
2335
1643
        num_file_ids = len(file_ids)
2336
1644
        for file_id, altered_versions in file_ids.iteritems():
2337
 
            if pb is not None:
2338
 
                pb.update("Fetch texts", count, num_file_ids)
 
1645
            if _files_pb is not None:
 
1646
                _files_pb.update("fetch texts", count, num_file_ids)
2339
1647
            count += 1
2340
1648
            yield ("file", file_id, altered_versions)
 
1649
        # We're done with the files_pb.  Note that it finished by the caller,
 
1650
        # just as it was created by the caller.
 
1651
        del _files_pb
2341
1652
 
2342
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2343
1653
        # inventory
2344
1654
        yield ("inventory", None, revision_ids)
2345
1655
 
2362
1672
        """Get Inventory object by revision id."""
2363
1673
        return self.iter_inventories([revision_id]).next()
2364
1674
 
2365
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1675
    def iter_inventories(self, revision_ids):
2366
1676
        """Get many inventories by revision_ids.
2367
1677
 
2368
1678
        This will buffer some or all of the texts used in constructing the
2369
1679
        inventories in memory, but will only parse a single inventory at a
2370
1680
        time.
2371
1681
 
2372
 
        :param revision_ids: The expected revision ids of the inventories.
2373
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2374
 
            specified, the order of revision_ids will be preserved (by
2375
 
            buffering if necessary).
2376
1682
        :return: An iterator of inventories.
2377
1683
        """
2378
1684
        if ((None in revision_ids)
2379
1685
            or (_mod_revision.NULL_REVISION in revision_ids)):
2380
1686
            raise ValueError('cannot get null revision inventory')
2381
 
        return self._iter_inventories(revision_ids, ordering)
 
1687
        return self._iter_inventories(revision_ids)
2382
1688
 
2383
 
    def _iter_inventories(self, revision_ids, ordering):
 
1689
    def _iter_inventories(self, revision_ids):
2384
1690
        """single-document based inventory iteration."""
2385
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2386
 
        for text, revision_id in inv_xmls:
2387
 
            yield self._deserialise_inventory(revision_id, text)
 
1691
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1692
            yield self.deserialise_inventory(revision_id, text)
2388
1693
 
2389
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2390
 
        if ordering is None:
2391
 
            order_as_requested = True
2392
 
            ordering = 'unordered'
2393
 
        else:
2394
 
            order_as_requested = False
 
1694
    def _iter_inventory_xmls(self, revision_ids):
2395
1695
        keys = [(revision_id,) for revision_id in revision_ids]
2396
 
        if not keys:
2397
 
            return
2398
 
        if order_as_requested:
2399
 
            key_iter = iter(keys)
2400
 
            next_key = key_iter.next()
2401
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
1696
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2402
1697
        text_chunks = {}
2403
1698
        for record in stream:
2404
1699
            if record.storage_kind != 'absent':
2405
 
                chunks = record.get_bytes_as('chunked')
2406
 
                if order_as_requested:
2407
 
                    text_chunks[record.key] = chunks
2408
 
                else:
2409
 
                    yield ''.join(chunks), record.key[-1]
 
1700
                text_chunks[record.key] = record.get_bytes_as('chunked')
2410
1701
            else:
2411
1702
                raise errors.NoSuchRevision(self, record.key)
2412
 
            if order_as_requested:
2413
 
                # Yield as many results as we can while preserving order.
2414
 
                while next_key in text_chunks:
2415
 
                    chunks = text_chunks.pop(next_key)
2416
 
                    yield ''.join(chunks), next_key[-1]
2417
 
                    try:
2418
 
                        next_key = key_iter.next()
2419
 
                    except StopIteration:
2420
 
                        # We still want to fully consume the get_record_stream,
2421
 
                        # just in case it is not actually finished at this point
2422
 
                        next_key = None
2423
 
                        break
 
1703
        for key in keys:
 
1704
            chunks = text_chunks.pop(key)
 
1705
            yield ''.join(chunks), key[-1]
2424
1706
 
2425
 
    def _deserialise_inventory(self, revision_id, xml):
 
1707
    def deserialise_inventory(self, revision_id, xml):
2426
1708
        """Transform the xml into an inventory object.
2427
1709
 
2428
1710
        :param revision_id: The expected revision id of the inventory.
2429
1711
        :param xml: A serialised inventory.
2430
1712
        """
2431
1713
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2432
 
                    entry_cache=self._inventory_entry_cache,
2433
 
                    return_from_cache=self._safe_to_return_from_cache)
 
1714
                    entry_cache=self._inventory_entry_cache)
2434
1715
        if result.revision_id != revision_id:
2435
1716
            raise AssertionError('revision id mismatch %s != %s' % (
2436
1717
                result.revision_id, revision_id))
2437
1718
        return result
2438
1719
 
2439
 
    def _serialise_inventory(self, inv):
 
1720
    def serialise_inventory(self, inv):
2440
1721
        return self._serializer.write_inventory_to_string(inv)
2441
1722
 
2442
1723
    def _serialise_inventory_to_lines(self, inv):
2446
1727
        return self._serializer.format_num
2447
1728
 
2448
1729
    @needs_read_lock
2449
 
    def _get_inventory_xml(self, revision_id):
2450
 
        """Get serialized inventory as a string."""
2451
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1730
    def get_inventory_xml(self, revision_id):
 
1731
        """Get inventory XML as a file object."""
 
1732
        texts = self._iter_inventory_xmls([revision_id])
2452
1733
        try:
2453
1734
            text, revision_id = texts.next()
2454
1735
        except StopIteration:
2455
1736
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2456
1737
        return text
2457
1738
 
2458
 
    def get_rev_id_for_revno(self, revno, known_pair):
2459
 
        """Return the revision id of a revno, given a later (revno, revid)
2460
 
        pair in the same history.
2461
 
 
2462
 
        :return: if found (True, revid).  If the available history ran out
2463
 
            before reaching the revno, then this returns
2464
 
            (False, (closest_revno, closest_revid)).
 
1739
    @needs_read_lock
 
1740
    def get_inventory_sha1(self, revision_id):
 
1741
        """Return the sha1 hash of the inventory entry
2465
1742
        """
2466
 
        known_revno, known_revid = known_pair
2467
 
        partial_history = [known_revid]
2468
 
        distance_from_known = known_revno - revno
2469
 
        if distance_from_known < 0:
2470
 
            raise ValueError(
2471
 
                'requested revno (%d) is later than given known revno (%d)'
2472
 
                % (revno, known_revno))
2473
 
        try:
2474
 
            _iter_for_revno(
2475
 
                self, partial_history, stop_index=distance_from_known)
2476
 
        except errors.RevisionNotPresent, err:
2477
 
            if err.revision_id == known_revid:
2478
 
                # The start revision (known_revid) wasn't found.
2479
 
                raise
2480
 
            # This is a stacked repository with no fallbacks, or a there's a
2481
 
            # left-hand ghost.  Either way, even though the revision named in
2482
 
            # the error isn't in this repo, we know it's the next step in this
2483
 
            # left-hand history.
2484
 
            partial_history.append(err.revision_id)
2485
 
        if len(partial_history) <= distance_from_known:
2486
 
            # Didn't find enough history to get a revid for the revno.
2487
 
            earliest_revno = known_revno - len(partial_history) + 1
2488
 
            return (False, (earliest_revno, partial_history[-1]))
2489
 
        if len(partial_history) - 1 > distance_from_known:
2490
 
            raise AssertionError('_iter_for_revno returned too much history')
2491
 
        return (True, partial_history[-1])
 
1743
        return self.get_revision(revision_id).inventory_sha1
2492
1744
 
2493
1745
    def iter_reverse_revision_history(self, revision_id):
2494
1746
        """Iterate backwards through revision ids in the lefthand history
2501
1753
        while True:
2502
1754
            if next_id in (None, _mod_revision.NULL_REVISION):
2503
1755
                return
2504
 
            try:
2505
 
                parents = graph.get_parent_map([next_id])[next_id]
2506
 
            except KeyError:
2507
 
                raise errors.RevisionNotPresent(next_id, self)
2508
1756
            yield next_id
 
1757
            # Note: The following line may raise KeyError in the event of
 
1758
            # truncated history. We decided not to have a try:except:raise
 
1759
            # RevisionNotPresent here until we see a use for it, because of the
 
1760
            # cost in an inner loop that is by its very nature O(history).
 
1761
            # Robert Collins 20080326
 
1762
            parents = graph.get_parent_map([next_id])[next_id]
2509
1763
            if len(parents) == 0:
2510
1764
                return
2511
1765
            else:
2546
1800
        for repositories to maintain loaded indices across multiple locks
2547
1801
        by checking inside their implementation of this method to see
2548
1802
        whether their indices are still valid. This depends of course on
2549
 
        the disk format being validatable in this manner. This method is
2550
 
        also called by the refresh_data() public interface to cause a refresh
2551
 
        to occur while in a write lock so that data inserted by a smart server
2552
 
        push operation is visible on the client's instance of the physical
2553
 
        repository.
 
1803
        the disk format being validatable in this manner.
2554
1804
        """
2555
1805
 
2556
1806
    @needs_read_lock
2570
1820
            return RevisionTree(self, inv, revision_id)
2571
1821
 
2572
1822
    def revision_trees(self, revision_ids):
2573
 
        """Return Trees for revisions in this repository.
 
1823
        """Return Tree for a revision on this branch.
2574
1824
 
2575
 
        :param revision_ids: a sequence of revision-ids;
2576
 
          a revision-id may not be None or 'null:'
2577
 
        """
 
1825
        `revision_id` may not be None or 'null:'"""
2578
1826
        inventories = self.iter_inventories(revision_ids)
2579
1827
        for inv in inventories:
2580
1828
            yield RevisionTree(self, inv, inv.revision_id)
2581
1829
 
2582
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2583
 
        """Return Tree for a revision on this branch with only some files.
2584
 
 
2585
 
        :param revision_ids: a sequence of revision-ids;
2586
 
          a revision-id may not be None or 'null:'
2587
 
        :param file_ids: if not None, the result is filtered
2588
 
          so that only those file-ids, their parents and their
2589
 
          children are included.
2590
 
        """
2591
 
        inventories = self.iter_inventories(revision_ids)
2592
 
        for inv in inventories:
2593
 
            # Should we introduce a FilteredRevisionTree class rather
2594
 
            # than pre-filter the inventory here?
2595
 
            filtered_inv = inv.filter(file_ids)
2596
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2597
 
 
2598
1830
    @needs_read_lock
2599
1831
    def get_ancestry(self, revision_id, topo_sorted=True):
2600
1832
        """Return a list of revision-ids integrated by a revision.
2625
1857
            keys = tsort.topo_sort(parent_map)
2626
1858
        return [None] + list(keys)
2627
1859
 
2628
 
    def pack(self, hint=None):
 
1860
    def pack(self):
2629
1861
        """Compress the data within the repository.
2630
1862
 
2631
1863
        This operation only makes sense for some repository types. For other
2634
1866
        This stub method does not require a lock, but subclasses should use
2635
1867
        @needs_write_lock as this is a long running call its reasonable to
2636
1868
        implicitly lock for the user.
2637
 
 
2638
 
        :param hint: If not supplied, the whole repository is packed.
2639
 
            If supplied, the repository may use the hint parameter as a
2640
 
            hint for the parts of the repository to pack. A hint can be
2641
 
            obtained from the result of commit_write_group(). Out of
2642
 
            date hints are simply ignored, because concurrent operations
2643
 
            can obsolete them rapidly.
2644
 
        """
 
1869
        """
 
1870
 
 
1871
    @needs_read_lock
 
1872
    @deprecated_method(one_six)
 
1873
    def print_file(self, file, revision_id):
 
1874
        """Print `file` to stdout.
 
1875
 
 
1876
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1877
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1878
        by creating a new more flexible convenience function.
 
1879
        """
 
1880
        tree = self.revision_tree(revision_id)
 
1881
        # use inventory as it was in that revision
 
1882
        file_id = tree.inventory.path2id(file)
 
1883
        if not file_id:
 
1884
            # TODO: jam 20060427 Write a test for this code path
 
1885
            #       it had a bug in it, and was raising the wrong
 
1886
            #       exception.
 
1887
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1888
        tree.print_file(file_id)
2645
1889
 
2646
1890
    def get_transaction(self):
2647
1891
        return self.control_files.get_transaction()
2648
1892
 
 
1893
    @deprecated_method(one_one)
 
1894
    def get_parents(self, revision_ids):
 
1895
        """See StackedParentsProvider.get_parents"""
 
1896
        parent_map = self.get_parent_map(revision_ids)
 
1897
        return [parent_map.get(r, None) for r in revision_ids]
 
1898
 
2649
1899
    def get_parent_map(self, revision_ids):
2650
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1900
        """See graph._StackedParentsProvider.get_parent_map"""
2651
1901
        # revisions index works in keys; this just works in revisions
2652
1902
        # therefore wrap and unwrap
2653
1903
        query_keys = []
2662
1912
        for ((revision_id,), parent_keys) in \
2663
1913
                self.revisions.get_parent_map(query_keys).iteritems():
2664
1914
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
1915
                result[revision_id] = tuple(parent_revid
 
1916
                    for (parent_revid,) in parent_keys)
2667
1917
            else:
2668
1918
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
1919
        return result
2676
1926
        parents_provider = self._make_parents_provider()
2677
1927
        if (other_repository is not None and
2678
1928
            not self.has_same_location(other_repository)):
2679
 
            parents_provider = graph.StackedParentsProvider(
 
1929
            parents_provider = graph._StackedParentsProvider(
2680
1930
                [parents_provider, other_repository._make_parents_provider()])
2681
1931
        return graph.Graph(parents_provider)
2682
1932
 
2683
 
    def _get_versioned_file_checker(self, text_key_references=None,
2684
 
        ancestors=None):
2685
 
        """Return an object suitable for checking versioned files.
2686
 
        
2687
 
        :param text_key_references: if non-None, an already built
2688
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2689
 
            to whether they were referred to by the inventory of the
2690
 
            revision_id that they contain. If None, this will be
2691
 
            calculated.
2692
 
        :param ancestors: Optional result from
2693
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2694
 
            available.
2695
 
        """
2696
 
        return _VersionedFileChecker(self,
2697
 
            text_key_references=text_key_references, ancestors=ancestors)
 
1933
    def _get_versioned_file_checker(self):
 
1934
        """Return an object suitable for checking versioned files."""
 
1935
        return _VersionedFileChecker(self)
2698
1936
 
2699
1937
    def revision_ids_to_search_result(self, result_set):
2700
1938
        """Convert a set of revision ids to a graph SearchResult."""
2750
1988
        return record.get_bytes_as('fulltext')
2751
1989
 
2752
1990
    @needs_read_lock
2753
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1991
    def check(self, revision_ids=None):
2754
1992
        """Check consistency of all history of given revision_ids.
2755
1993
 
2756
1994
        Different repository implementations should override _check().
2757
1995
 
2758
1996
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2759
1997
             will be checked.  Typically the last revision_id of a branch.
2760
 
        :param callback_refs: A dict of check-refs to resolve and callback
2761
 
            the check/_check method on the items listed as wanting the ref.
2762
 
            see bzrlib.check.
2763
 
        :param check_repo: If False do not check the repository contents, just 
2764
 
            calculate the data callback_refs requires and call them back.
2765
1998
        """
2766
 
        return self._check(revision_ids, callback_refs=callback_refs,
2767
 
            check_repo=check_repo)
 
1999
        return self._check(revision_ids)
2768
2000
 
2769
 
    def _check(self, revision_ids, callback_refs, check_repo):
2770
 
        result = check.Check(self, check_repo=check_repo)
2771
 
        result.check(callback_refs)
 
2001
    def _check(self, revision_ids):
 
2002
        result = check.Check(self)
 
2003
        result.check()
2772
2004
        return result
2773
2005
 
2774
 
    def _warn_if_deprecated(self, branch=None):
 
2006
    def _warn_if_deprecated(self):
2775
2007
        global _deprecation_warning_done
2776
2008
        if _deprecation_warning_done:
2777
2009
            return
2778
 
        try:
2779
 
            if branch is None:
2780
 
                conf = config.GlobalConfig()
2781
 
            else:
2782
 
                conf = branch.get_config()
2783
 
            if conf.suppress_warning('format_deprecation'):
2784
 
                return
2785
 
            warning("Format %s for %s is deprecated -"
2786
 
                    " please use 'bzr upgrade' to get better performance"
2787
 
                    % (self._format, self.bzrdir.transport.base))
2788
 
        finally:
2789
 
            _deprecation_warning_done = True
 
2010
        _deprecation_warning_done = True
 
2011
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2012
                % (self._format, self.bzrdir.transport.base))
2790
2013
 
2791
2014
    def supports_rich_root(self):
2792
2015
        return self._format.rich_root_data
2866
2089
    """
2867
2090
    repository.start_write_group()
2868
2091
    try:
2869
 
        inventory_cache = lru_cache.LRUCache(10)
2870
2092
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2871
 
            _install_revision(repository, revision, revision_tree, signature,
2872
 
                inventory_cache)
 
2093
            _install_revision(repository, revision, revision_tree, signature)
2873
2094
            if pb is not None:
2874
2095
                pb.update('Transferring revisions', n + 1, num_revisions)
2875
2096
    except:
2879
2100
        repository.commit_write_group()
2880
2101
 
2881
2102
 
2882
 
def _install_revision(repository, rev, revision_tree, signature,
2883
 
    inventory_cache):
 
2103
def _install_revision(repository, rev, revision_tree, signature):
2884
2104
    """Install all revision data into a repository."""
2885
2105
    present_parents = []
2886
2106
    parent_trees = {}
2923
2143
        repository.texts.add_lines(text_key, text_parents, lines)
2924
2144
    try:
2925
2145
        # install the inventory
2926
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2927
 
            # Cache this inventory
2928
 
            inventory_cache[rev.revision_id] = inv
2929
 
            try:
2930
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2931
 
            except KeyError:
2932
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2933
 
            else:
2934
 
                delta = inv._make_delta(basis_inv)
2935
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2936
 
                    rev.revision_id, present_parents)
2937
 
        else:
2938
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2146
        repository.add_inventory(rev.revision_id, inv, present_parents)
2939
2147
    except errors.RevisionAlreadyPresent:
2940
2148
        pass
2941
2149
    if signature is not None:
3032
2240
 
3033
2241
    Once a format is deprecated, just deprecate the initialize and open
3034
2242
    methods on the format class. Do not deprecate the object, as the
3035
 
    object may be created even when a repository instance hasn't been
 
2243
    object may be created even when a repository instnace hasn't been
3036
2244
    created.
3037
2245
 
3038
2246
    Common instance attributes:
3048
2256
    # Can this repository be given external locations to lookup additional
3049
2257
    # data. Set to True or False in derived classes.
3050
2258
    supports_external_lookups = None
3051
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3052
 
    # derived classes.
3053
 
    supports_chks = None
3054
 
    # Should commit add an inventory, or an inventory delta to the repository.
3055
 
    _commit_inv_deltas = True
3056
2259
    # What order should fetch operations request streams in?
3057
2260
    # The default is unordered as that is the cheapest for an origin to
3058
2261
    # provide.
3065
2268
    # Should fetch trigger a reconcile after the fetch? Only needed for
3066
2269
    # some repository formats that can suffer internal inconsistencies.
3067
2270
    _fetch_reconcile = False
3068
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3069
 
    # code path for commit, amongst other things.
3070
 
    fast_deltas = None
3071
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3072
 
    # (so if there is one pack, the operation can still proceed because it may
3073
 
    # help), and for fetching when data won't have come from the same
3074
 
    # compressor.
3075
 
    pack_compresses = False
3076
 
    # Does the repository inventory storage understand references to trees?
3077
 
    supports_tree_reference = None
3078
2271
 
3079
2272
    def __str__(self):
3080
2273
        return "<%s>" % self.__class__.__name__
3096
2289
        """
3097
2290
        try:
3098
2291
            transport = a_bzrdir.get_repository_transport(None)
3099
 
            format_string = transport.get_bytes("format")
 
2292
            format_string = transport.get("format").read()
3100
2293
            return format_registry.get(format_string)
3101
2294
        except errors.NoSuchFile:
3102
2295
            raise errors.NoRepositoryPresent(a_bzrdir)
3184
2377
        raise NotImplementedError(self.network_name)
3185
2378
 
3186
2379
    def check_conversion_target(self, target_format):
3187
 
        if self.rich_root_data and not target_format.rich_root_data:
3188
 
            raise errors.BadConversionTarget(
3189
 
                'Does not support rich root data.', target_format,
3190
 
                from_format=self)
3191
 
        if (self.supports_tree_reference and 
3192
 
            not getattr(target_format, 'supports_tree_reference', False)):
3193
 
            raise errors.BadConversionTarget(
3194
 
                'Does not support nested trees', target_format,
3195
 
                from_format=self)
 
2380
        raise NotImplementedError(self.check_conversion_target)
3196
2381
 
3197
2382
    def open(self, a_bzrdir, _found=False):
3198
2383
        """Return an instance of this format for the bzrdir a_bzrdir.
3254
2439
# Pre-0.8 formats that don't have a disk format string (because they are
3255
2440
# versioned by the matching control directory). We use the control directories
3256
2441
# disk format string as a key for the network_name because they meet the
3257
 
# constraints (simple string, unique, immutable).
 
2442
# constraints (simple string, unique, immmutable).
3258
2443
network_format_registry.register_lazy(
3259
2444
    "Bazaar-NG branch, format 5\n",
3260
2445
    'bzrlib.repofmt.weaverepo',
3341
2526
    )
3342
2527
 
3343
2528
# Development formats.
3344
 
# Obsolete but kept pending a CHK based subtree format.
 
2529
# 1.7->1.8 go below here
 
2530
format_registry.register_lazy(
 
2531
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2532
    'bzrlib.repofmt.pack_repo',
 
2533
    'RepositoryFormatPackDevelopment2',
 
2534
    )
3345
2535
format_registry.register_lazy(
3346
2536
    ("Bazaar development format 2 with subtree support "
3347
2537
        "(needs bzr.dev from before 1.8)\n"),
3349
2539
    'RepositoryFormatPackDevelopment2Subtree',
3350
2540
    )
3351
2541
 
3352
 
# 1.14->1.16 go below here
3353
 
format_registry.register_lazy(
3354
 
    'Bazaar development format - group compression and chk inventory'
3355
 
        ' (needs bzr.dev from 1.14)\n',
3356
 
    'bzrlib.repofmt.groupcompress_repo',
3357
 
    'RepositoryFormatCHK1',
3358
 
    )
3359
 
 
3360
 
format_registry.register_lazy(
3361
 
    'Bazaar development format - chk repository with bencode revision '
3362
 
        'serialization (needs bzr.dev from 1.16)\n',
3363
 
    'bzrlib.repofmt.groupcompress_repo',
3364
 
    'RepositoryFormatCHK2',
3365
 
    )
3366
 
format_registry.register_lazy(
3367
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3368
 
    'bzrlib.repofmt.groupcompress_repo',
3369
 
    'RepositoryFormat2a',
3370
 
    )
3371
 
 
3372
2542
 
3373
2543
class InterRepository(InterObject):
3374
2544
    """This class represents operations taking place between two repositories.
3382
2552
    InterRepository.get(other).method_name(parameters).
3383
2553
    """
3384
2554
 
3385
 
    _walk_to_common_revisions_batch_size = 50
 
2555
    _walk_to_common_revisions_batch_size = 1
3386
2556
    _optimisers = []
3387
2557
    """The available optimised InterRepository types."""
3388
2558
 
 
2559
    def __init__(self, source, target):
 
2560
        InterObject.__init__(self, source, target)
 
2561
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2562
        # provide a faster implementation.
 
2563
        self.target_get_graph = self.target.get_graph
 
2564
        self.target_get_parent_map = self.target.get_parent_map
 
2565
 
3389
2566
    @needs_write_lock
3390
2567
    def copy_content(self, revision_id=None):
3391
2568
        """Make a complete copy of the content in self into destination.
3402
2579
            pass
3403
2580
        self.target.fetch(self.source, revision_id=revision_id)
3404
2581
 
3405
 
    @needs_write_lock
3406
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3407
 
            fetch_spec=None):
 
2582
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3408
2583
        """Fetch the content required to construct revision_id.
3409
2584
 
3410
2585
        The content is copied from self.source to self.target.
3411
2586
 
3412
2587
        :param revision_id: if None all content is copied, if NULL_REVISION no
3413
2588
                            content is copied.
3414
 
        :param pb: ignored.
 
2589
        :param pb: optional progress bar to use for progress reports. If not
 
2590
                   provided a default one will be created.
3415
2591
        :return: None.
3416
2592
        """
3417
 
        f = _mod_fetch.RepoFetcher(to_repository=self.target,
 
2593
        from bzrlib.fetch import RepoFetcher
 
2594
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2595
               self.source, self.source._format, self.target,
 
2596
               self.target._format)
 
2597
        f = RepoFetcher(to_repository=self.target,
3418
2598
                               from_repository=self.source,
3419
2599
                               last_revision=revision_id,
3420
 
                               fetch_spec=fetch_spec,
3421
 
                               find_ghosts=find_ghosts)
 
2600
                               pb=pb, find_ghosts=find_ghosts)
3422
2601
 
3423
2602
    def _walk_to_common_revisions(self, revision_ids):
3424
2603
        """Walk out from revision_ids in source to revisions target has.
3426
2605
        :param revision_ids: The start point for the search.
3427
2606
        :return: A set of revision ids.
3428
2607
        """
3429
 
        target_graph = self.target.get_graph()
 
2608
        target_graph = self.target_get_graph()
3430
2609
        revision_ids = frozenset(revision_ids)
 
2610
        # Fast path for the case where all the revisions are already in the
 
2611
        # target repo.
 
2612
        # (Although this does incur an extra round trip for the
 
2613
        # fairly common case where the target doesn't already have the revision
 
2614
        # we're pushing.)
 
2615
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2616
            return graph.SearchResult(revision_ids, set(), 0, set())
3431
2617
        missing_revs = set()
3432
2618
        source_graph = self.source.get_graph()
3433
2619
        # ensure we don't pay silly lookup costs.
3472
2658
                break
3473
2659
        return searcher.get_result()
3474
2660
 
 
2661
    @deprecated_method(one_two)
 
2662
    @needs_read_lock
 
2663
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2664
        """Return the revision ids that source has that target does not.
 
2665
 
 
2666
        These are returned in topological order.
 
2667
 
 
2668
        :param revision_id: only return revision ids included by this
 
2669
                            revision_id.
 
2670
        :param find_ghosts: If True find missing revisions in deep history
 
2671
            rather than just finding the surface difference.
 
2672
        """
 
2673
        return list(self.search_missing_revision_ids(
 
2674
            revision_id, find_ghosts).get_keys())
 
2675
 
3475
2676
    @needs_read_lock
3476
2677
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3477
2678
        """Return the revision ids that source has that target does not.
3593
2794
                self.target.texts.insert_record_stream(
3594
2795
                    self.source.texts.get_record_stream(
3595
2796
                        self.source.texts.keys(), 'topological', False))
3596
 
                pb.update('Copying inventory', 0, 1)
 
2797
                pb.update('copying inventory', 0, 1)
3597
2798
                self.target.inventories.insert_record_stream(
3598
2799
                    self.source.inventories.get_record_stream(
3599
2800
                        self.source.inventories.keys(), 'topological', False))
3610
2811
        else:
3611
2812
            self.target.fetch(self.source, revision_id=revision_id)
3612
2813
 
 
2814
    @needs_write_lock
 
2815
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2816
        """See InterRepository.fetch()."""
 
2817
        from bzrlib.fetch import RepoFetcher
 
2818
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2819
               self.source, self.source._format, self.target, self.target._format)
 
2820
        f = RepoFetcher(to_repository=self.target,
 
2821
                               from_repository=self.source,
 
2822
                               last_revision=revision_id,
 
2823
                               pb=pb, find_ghosts=find_ghosts)
 
2824
 
3613
2825
    @needs_read_lock
3614
2826
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3615
2827
        """See InterRepository.missing_revision_ids()."""
3620
2832
        # so the first thing is to get a subset of the revisions to
3621
2833
        # satisfy revision_id in source, and then eliminate those that
3622
2834
        # we do already have.
3623
 
        # this is slow on high latency connection to self, but as this
 
2835
        # this is slow on high latency connection to self, but as as this
3624
2836
        # disk format scales terribly for push anyway due to rewriting
3625
2837
        # inventory.weave, this is considered acceptable.
3626
2838
        # - RBC 20060209
3679
2891
            return False
3680
2892
        return are_knits and InterRepository._same_model(source, target)
3681
2893
 
 
2894
    @needs_write_lock
 
2895
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2896
        """See InterRepository.fetch()."""
 
2897
        from bzrlib.fetch import RepoFetcher
 
2898
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2899
               self.source, self.source._format, self.target, self.target._format)
 
2900
        f = RepoFetcher(to_repository=self.target,
 
2901
                            from_repository=self.source,
 
2902
                            last_revision=revision_id,
 
2903
                            pb=pb, find_ghosts=find_ghosts)
 
2904
 
3682
2905
    @needs_read_lock
3683
2906
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3684
2907
        """See InterRepository.missing_revision_ids()."""
3713
2936
        return self.source.revision_ids_to_search_result(result_set)
3714
2937
 
3715
2938
 
3716
 
class InterDifferingSerializer(InterRepository):
 
2939
class InterPackRepo(InterSameDataRepository):
 
2940
    """Optimised code paths between Pack based repositories."""
 
2941
 
 
2942
    @classmethod
 
2943
    def _get_repo_format_to_test(self):
 
2944
        from bzrlib.repofmt import pack_repo
 
2945
        return pack_repo.RepositoryFormatKnitPack1()
 
2946
 
 
2947
    @staticmethod
 
2948
    def is_compatible(source, target):
 
2949
        """Be compatible with known Pack formats.
 
2950
 
 
2951
        We don't test for the stores being of specific types because that
 
2952
        could lead to confusing results, and there is no need to be
 
2953
        overly general.
 
2954
        """
 
2955
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2956
        try:
 
2957
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2958
                isinstance(target._format, RepositoryFormatPack))
 
2959
        except AttributeError:
 
2960
            return False
 
2961
        return are_packs and InterRepository._same_model(source, target)
 
2962
 
 
2963
    @needs_write_lock
 
2964
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2965
        """See InterRepository.fetch()."""
 
2966
        if (len(self.source._fallback_repositories) > 0 or
 
2967
            len(self.target._fallback_repositories) > 0):
 
2968
            # The pack layer is not aware of fallback repositories, so when
 
2969
            # fetching from a stacked repository or into a stacked repository
 
2970
            # we use the generic fetch logic which uses the VersionedFiles
 
2971
            # attributes on repository.
 
2972
            from bzrlib.fetch import RepoFetcher
 
2973
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2974
                                  pb, find_ghosts)
 
2975
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2976
               self.source, self.source._format, self.target, self.target._format)
 
2977
        if revision_id is None:
 
2978
            # TODO:
 
2979
            # everything to do - use pack logic
 
2980
            # to fetch from all packs to one without
 
2981
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2982
            # till then:
 
2983
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2984
            revision_ids = source_revision_ids - \
 
2985
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2986
            revision_keys = [(revid,) for revid in revision_ids]
 
2987
            target_pack_collection = self._get_target_pack_collection()
 
2988
            index = target_pack_collection.revision_index.combined_index
 
2989
            present_revision_ids = set(item[1][0] for item in
 
2990
                index.iter_entries(revision_keys))
 
2991
            revision_ids = set(revision_ids) - present_revision_ids
 
2992
            # implementing the TODO will involve:
 
2993
            # - detecting when all of a pack is selected
 
2994
            # - avoiding as much as possible pre-selection, so the
 
2995
            # more-core routines such as create_pack_from_packs can filter in
 
2996
            # a just-in-time fashion. (though having a HEADS list on a
 
2997
            # repository might make this a lot easier, because we could
 
2998
            # sensibly detect 'new revisions' without doing a full index scan.
 
2999
        elif _mod_revision.is_null(revision_id):
 
3000
            # nothing to do:
 
3001
            return (0, [])
 
3002
        else:
 
3003
            try:
 
3004
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3005
                    find_ghosts=find_ghosts).get_keys()
 
3006
            except errors.NoSuchRevision:
 
3007
                raise errors.InstallFailed([revision_id])
 
3008
            if len(revision_ids) == 0:
 
3009
                return (0, [])
 
3010
        return self._pack(self.source, self.target, revision_ids)
 
3011
 
 
3012
    def _pack(self, source, target, revision_ids):
 
3013
        from bzrlib.repofmt.pack_repo import Packer
 
3014
        target_pack_collection = self._get_target_pack_collection()
 
3015
        packs = source._pack_collection.all_packs()
 
3016
        pack = Packer(target_pack_collection, packs, '.fetch',
 
3017
            revision_ids).pack()
 
3018
        if pack is not None:
 
3019
            target_pack_collection._save_pack_names()
 
3020
            copied_revs = pack.get_revision_count()
 
3021
            # Trigger an autopack. This may duplicate effort as we've just done
 
3022
            # a pack creation, but for now it is simpler to think about as
 
3023
            # 'upload data, then repack if needed'.
 
3024
            self._autopack()
 
3025
            return (copied_revs, [])
 
3026
        else:
 
3027
            return (0, [])
 
3028
 
 
3029
    def _autopack(self):
 
3030
        self.target._pack_collection.autopack()
 
3031
 
 
3032
    def _get_target_pack_collection(self):
 
3033
        return self.target._pack_collection
 
3034
 
 
3035
    @needs_read_lock
 
3036
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3037
        """See InterRepository.missing_revision_ids().
 
3038
 
 
3039
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3040
            revision_id.
 
3041
        """
 
3042
        if not find_ghosts and revision_id is not None:
 
3043
            return self._walk_to_common_revisions([revision_id])
 
3044
        elif revision_id is not None:
 
3045
            # Find ghosts: search for revisions pointing from one repository to
 
3046
            # the other, and vice versa, anywhere in the history of revision_id.
 
3047
            graph = self.target_get_graph(other_repository=self.source)
 
3048
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3049
            found_ids = set()
 
3050
            while True:
 
3051
                try:
 
3052
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3053
                except StopIteration:
 
3054
                    break
 
3055
                if revision_id in ghosts:
 
3056
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3057
                found_ids.update(next_revs)
 
3058
                found_ids.update(ghosts)
 
3059
            found_ids = frozenset(found_ids)
 
3060
            # Double query here: should be able to avoid this by changing the
 
3061
            # graph api further.
 
3062
            result_set = found_ids - frozenset(
 
3063
                self.target_get_parent_map(found_ids))
 
3064
        else:
 
3065
            source_ids = self.source.all_revision_ids()
 
3066
            # source_ids is the worst possible case we may need to pull.
 
3067
            # now we want to filter source_ids against what we actually
 
3068
            # have in target, but don't try to check for existence where we know
 
3069
            # we do not have a revision as that would be pointless.
 
3070
            target_ids = set(self.target.all_revision_ids())
 
3071
            result_set = set(source_ids).difference(target_ids)
 
3072
        return self.source.revision_ids_to_search_result(result_set)
 
3073
 
 
3074
 
 
3075
class InterDifferingSerializer(InterKnitRepo):
3717
3076
 
3718
3077
    @classmethod
3719
3078
    def _get_repo_format_to_test(self):
3722
3081
    @staticmethod
3723
3082
    def is_compatible(source, target):
3724
3083
        """Be compatible with Knit2 source and Knit3 target"""
3725
 
        # This is redundant with format.check_conversion_target(), however that
3726
 
        # raises an exception, and we just want to say "False" as in we won't
3727
 
        # support converting between these formats.
3728
 
        if 'IDS_never' in debug.debug_flags:
3729
 
            return False
3730
 
        if source.supports_rich_root() and not target.supports_rich_root():
3731
 
            return False
3732
 
        if (source._format.supports_tree_reference
3733
 
            and not target._format.supports_tree_reference):
3734
 
            return False
3735
 
        if target._fallback_repositories and target._format.supports_chks:
3736
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3737
 
            # adds to stacked repos.
3738
 
            return False
3739
 
        if 'IDS_always' in debug.debug_flags:
3740
 
            return True
3741
 
        # Only use this code path for local source and target.  IDS does far
3742
 
        # too much IO (both bandwidth and roundtrips) over a network.
3743
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3744
 
            return False
3745
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3084
        if source.supports_rich_root() != target.supports_rich_root():
 
3085
            return False
 
3086
        # Ideally, we'd support fetching if the source had no tree references
 
3087
        # even if it supported them...
 
3088
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3089
            not getattr(target, '_format.supports_tree_reference', False)):
3746
3090
            return False
3747
3091
        return True
3748
3092
 
3749
 
    def _get_trees(self, revision_ids, cache):
3750
 
        possible_trees = []
3751
 
        for rev_id in revision_ids:
3752
 
            if rev_id in cache:
3753
 
                possible_trees.append((rev_id, cache[rev_id]))
3754
 
            else:
3755
 
                # Not cached, but inventory might be present anyway.
3756
 
                try:
3757
 
                    tree = self.source.revision_tree(rev_id)
3758
 
                except errors.NoSuchRevision:
3759
 
                    # Nope, parent is ghost.
3760
 
                    pass
3761
 
                else:
3762
 
                    cache[rev_id] = tree
3763
 
                    possible_trees.append((rev_id, tree))
3764
 
        return possible_trees
3765
 
 
3766
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3093
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3767
3094
        """Get the best delta and base for this revision.
3768
3095
 
3769
3096
        :return: (basis_id, delta)
3770
3097
        """
 
3098
        possible_trees = [(parent_id, cache[parent_id])
 
3099
                          for parent_id in parent_ids
 
3100
                           if parent_id in cache]
 
3101
        if len(possible_trees) == 0:
 
3102
            # There either aren't any parents, or the parents aren't in the
 
3103
            # cache, so just use the last converted tree
 
3104
            possible_trees.append((basis_id, cache[basis_id]))
3771
3105
        deltas = []
3772
 
        # Generate deltas against each tree, to find the shortest.
3773
 
        texts_possibly_new_in_tree = set()
3774
3106
        for basis_id, basis_tree in possible_trees:
3775
3107
            delta = tree.inventory._make_delta(basis_tree.inventory)
3776
 
            for old_path, new_path, file_id, new_entry in delta:
3777
 
                if new_path is None:
3778
 
                    # This file_id isn't present in the new rev, so we don't
3779
 
                    # care about it.
3780
 
                    continue
3781
 
                if not new_path:
3782
 
                    # Rich roots are handled elsewhere...
3783
 
                    continue
3784
 
                kind = new_entry.kind
3785
 
                if kind != 'directory' and kind != 'file':
3786
 
                    # No text record associated with this inventory entry.
3787
 
                    continue
3788
 
                # This is a directory or file that has changed somehow.
3789
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3790
3108
            deltas.append((len(delta), basis_id, delta))
3791
3109
        deltas.sort()
3792
3110
        return deltas[0][1:]
3793
3111
 
3794
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3795
 
        """Find all parent revisions that are absent, but for which the
3796
 
        inventory is present, and copy those inventories.
3797
 
 
3798
 
        This is necessary to preserve correctness when the source is stacked
3799
 
        without fallbacks configured.  (Note that in cases like upgrade the
3800
 
        source may be not have _fallback_repositories even though it is
3801
 
        stacked.)
3802
 
        """
3803
 
        parent_revs = set()
3804
 
        for parents in parent_map.values():
3805
 
            parent_revs.update(parents)
3806
 
        present_parents = self.source.get_parent_map(parent_revs)
3807
 
        absent_parents = set(parent_revs).difference(present_parents)
3808
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3809
 
            (rev_id,) for rev_id in absent_parents)
3810
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3811
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3812
 
            current_revision_id = parent_tree.get_revision_id()
3813
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3814
 
                (current_revision_id,)]
3815
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3816
 
            basis_id = _mod_revision.NULL_REVISION
3817
 
            basis_tree = self.source.revision_tree(basis_id)
3818
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3819
 
            self.target.add_inventory_by_delta(
3820
 
                basis_id, delta, current_revision_id, parents_parents)
3821
 
            cache[current_revision_id] = parent_tree
3822
 
 
3823
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3112
    def _fetch_batch(self, revision_ids, basis_id, cache):
3824
3113
        """Fetch across a few revisions.
3825
3114
 
3826
3115
        :param revision_ids: The revisions to copy
3827
3116
        :param basis_id: The revision_id of a tree that must be in cache, used
3828
3117
            as a basis for delta when no other base is available
3829
3118
        :param cache: A cache of RevisionTrees that we can use.
3830
 
        :param a_graph: A Graph object to determine the heads() of the
3831
 
            rich-root data stream.
3832
3119
        :return: The revision_id of the last converted tree. The RevisionTree
3833
3120
            for it will be in cache
3834
3121
        """
3835
3122
        # Walk though all revisions; get inventory deltas, copy referenced
3836
3123
        # texts that delta references, insert the delta, revision and
3837
3124
        # signature.
3838
 
        root_keys_to_create = set()
3839
3125
        text_keys = set()
3840
3126
        pending_deltas = []
3841
3127
        pending_revisions = []
3842
3128
        parent_map = self.source.get_parent_map(revision_ids)
3843
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3844
 
        self.source._safe_to_return_from_cache = True
3845
3129
        for tree in self.source.revision_trees(revision_ids):
3846
 
            # Find a inventory delta for this revision.
3847
 
            # Find text entries that need to be copied, too.
3848
3130
            current_revision_id = tree.get_revision_id()
3849
3131
            parent_ids = parent_map.get(current_revision_id, ())
3850
 
            parent_trees = self._get_trees(parent_ids, cache)
3851
 
            possible_trees = list(parent_trees)
3852
 
            if len(possible_trees) == 0:
3853
 
                # There either aren't any parents, or the parents are ghosts,
3854
 
                # so just use the last converted tree.
3855
 
                possible_trees.append((basis_id, cache[basis_id]))
3856
3132
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3857
 
                                                           possible_trees)
 
3133
                                                           basis_id, cache)
 
3134
            # Find text entries that need to be copied
 
3135
            for old_path, new_path, file_id, entry in delta:
 
3136
                if new_path is not None:
 
3137
                    if not (new_path or self.target.supports_rich_root()):
 
3138
                        # We don't copy the text for the root node unless the
 
3139
                        # target supports_rich_root.
 
3140
                        continue
 
3141
                    # TODO: Do we need:
 
3142
                    #       "if entry.revision == current_revision_id" ?
 
3143
                    if entry.revision == current_revision_id:
 
3144
                        text_keys.add((file_id, entry.revision))
3858
3145
            revision = self.source.get_revision(current_revision_id)
3859
3146
            pending_deltas.append((basis_id, delta,
3860
3147
                current_revision_id, revision.parent_ids))
3861
 
            if self._converting_to_rich_root:
3862
 
                self._revision_id_to_root_id[current_revision_id] = \
3863
 
                    tree.get_root_id()
3864
 
            # Determine which texts are in present in this revision but not in
3865
 
            # any of the available parents.
3866
 
            texts_possibly_new_in_tree = set()
3867
 
            for old_path, new_path, file_id, entry in delta:
3868
 
                if new_path is None:
3869
 
                    # This file_id isn't present in the new rev
3870
 
                    continue
3871
 
                if not new_path:
3872
 
                    # This is the root
3873
 
                    if not self.target.supports_rich_root():
3874
 
                        # The target doesn't support rich root, so we don't
3875
 
                        # copy
3876
 
                        continue
3877
 
                    if self._converting_to_rich_root:
3878
 
                        # This can't be copied normally, we have to insert
3879
 
                        # it specially
3880
 
                        root_keys_to_create.add((file_id, entry.revision))
3881
 
                        continue
3882
 
                kind = entry.kind
3883
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3884
 
            for basis_id, basis_tree in possible_trees:
3885
 
                basis_inv = basis_tree.inventory
3886
 
                for file_key in list(texts_possibly_new_in_tree):
3887
 
                    file_id, file_revision = file_key
3888
 
                    try:
3889
 
                        entry = basis_inv[file_id]
3890
 
                    except errors.NoSuchId:
3891
 
                        continue
3892
 
                    if entry.revision == file_revision:
3893
 
                        texts_possibly_new_in_tree.remove(file_key)
3894
 
            text_keys.update(texts_possibly_new_in_tree)
3895
3148
            pending_revisions.append(revision)
3896
3149
            cache[current_revision_id] = tree
3897
3150
            basis_id = current_revision_id
3898
 
        self.source._safe_to_return_from_cache = False
3899
3151
        # Copy file texts
3900
3152
        from_texts = self.source.texts
3901
3153
        to_texts = self.target.texts
3902
 
        if root_keys_to_create:
3903
 
            root_stream = _mod_fetch._new_root_data_stream(
3904
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3905
 
                self.source, graph=a_graph)
3906
 
            to_texts.insert_record_stream(root_stream)
3907
3154
        to_texts.insert_record_stream(from_texts.get_record_stream(
3908
3155
            text_keys, self.target._format._fetch_order,
3909
3156
            not self.target._format._fetch_uses_deltas))
3910
 
        # insert inventory deltas
 
3157
        # insert deltas
3911
3158
        for delta in pending_deltas:
3912
3159
            self.target.add_inventory_by_delta(*delta)
3913
 
        if self.target._fallback_repositories:
3914
 
            # Make sure this stacked repository has all the parent inventories
3915
 
            # for the new revisions that we are about to insert.  We do this
3916
 
            # before adding the revisions so that no revision is added until
3917
 
            # all the inventories it may depend on are added.
3918
 
            # Note that this is overzealous, as we may have fetched these in an
3919
 
            # earlier batch.
3920
 
            parent_ids = set()
3921
 
            revision_ids = set()
3922
 
            for revision in pending_revisions:
3923
 
                revision_ids.add(revision.revision_id)
3924
 
                parent_ids.update(revision.parent_ids)
3925
 
            parent_ids.difference_update(revision_ids)
3926
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3927
 
            parent_map = self.source.get_parent_map(parent_ids)
3928
 
            # we iterate over parent_map and not parent_ids because we don't
3929
 
            # want to try copying any revision which is a ghost
3930
 
            for parent_tree in self.source.revision_trees(parent_map):
3931
 
                current_revision_id = parent_tree.get_revision_id()
3932
 
                parents_parents = parent_map[current_revision_id]
3933
 
                possible_trees = self._get_trees(parents_parents, cache)
3934
 
                if len(possible_trees) == 0:
3935
 
                    # There either aren't any parents, or the parents are
3936
 
                    # ghosts, so just use the last converted tree.
3937
 
                    possible_trees.append((basis_id, cache[basis_id]))
3938
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3939
 
                    parents_parents, possible_trees)
3940
 
                self.target.add_inventory_by_delta(
3941
 
                    basis_id, delta, current_revision_id, parents_parents)
3942
3160
        # insert signatures and revisions
3943
3161
        for revision in pending_revisions:
3944
3162
            try:
3956
3174
 
3957
3175
        :param revision_ids: The list of revisions to fetch. Must be in
3958
3176
            topological order.
3959
 
        :param pb: A ProgressTask
 
3177
        :param pb: A ProgressBar
3960
3178
        :return: None
3961
3179
        """
3962
3180
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3964
3182
        cache = lru_cache.LRUCache(100)
3965
3183
        cache[basis_id] = basis_tree
3966
3184
        del basis_tree # We don't want to hang on to it here
3967
 
        hints = []
3968
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3969
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3970
 
                                                            revision_ids)
3971
 
        else:
3972
 
            a_graph = None
3973
 
 
3974
3185
        for offset in range(0, len(revision_ids), batch_size):
3975
3186
            self.target.start_write_group()
3976
3187
            try:
3977
3188
                pb.update('Transferring revisions', offset,
3978
3189
                          len(revision_ids))
3979
3190
                batch = revision_ids[offset:offset+batch_size]
3980
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3981
 
                                             a_graph=a_graph)
 
3191
                basis_id = self._fetch_batch(batch, basis_id, cache)
3982
3192
            except:
3983
 
                self.source._safe_to_return_from_cache = False
3984
3193
                self.target.abort_write_group()
3985
3194
                raise
3986
3195
            else:
3987
 
                hint = self.target.commit_write_group()
3988
 
                if hint:
3989
 
                    hints.extend(hint)
3990
 
        if hints and self.target._format.pack_compresses:
3991
 
            self.target.pack(hint=hints)
 
3196
                self.target.commit_write_group()
3992
3197
        pb.update('Transferring revisions', len(revision_ids),
3993
3198
                  len(revision_ids))
3994
3199
 
3995
3200
    @needs_write_lock
3996
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3997
 
            fetch_spec=None):
 
3201
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3998
3202
        """See InterRepository.fetch()."""
3999
 
        if fetch_spec is not None:
4000
 
            raise AssertionError("Not implemented yet...")
4001
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4002
 
        #
4003
 
        # nb this is only active for local-local fetches; other things using
4004
 
        # streaming.
4005
 
        ui.ui_factory.warn_cross_format_fetch(self.source._format,
4006
 
            self.target._format)
4007
 
        if (not self.source.supports_rich_root()
4008
 
            and self.target.supports_rich_root()):
4009
 
            self._converting_to_rich_root = True
4010
 
            self._revision_id_to_root_id = {}
4011
 
        else:
4012
 
            self._converting_to_rich_root = False
4013
3203
        revision_ids = self.target.search_missing_revision_ids(self.source,
4014
3204
            revision_id, find_ghosts=find_ghosts).get_keys()
4015
3205
        if not revision_ids:
4016
3206
            return 0, 0
4017
3207
        revision_ids = tsort.topo_sort(
4018
3208
            self.source.get_graph().get_parent_map(revision_ids))
4019
 
        if not revision_ids:
4020
 
            return 0, 0
4021
 
        # Walk though all revisions; get inventory deltas, copy referenced
4022
 
        # texts that delta references, insert the delta, revision and
4023
 
        # signature.
4024
3209
        if pb is None:
4025
3210
            my_pb = ui.ui_factory.nested_progress_bar()
4026
3211
            pb = my_pb
4027
3212
        else:
4028
 
            symbol_versioning.warn(
4029
 
                symbol_versioning.deprecated_in((1, 14, 0))
4030
 
                % "pb parameter to fetch()")
4031
3213
            my_pb = None
4032
3214
        try:
4033
3215
            self._fetch_all_revisions(revision_ids, pb)
4059
3241
        return basis_id, basis_tree
4060
3242
 
4061
3243
 
 
3244
class InterOtherToRemote(InterRepository):
 
3245
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3246
    calculated for (source, target._real_repository).
 
3247
    """
 
3248
 
 
3249
    _walk_to_common_revisions_batch_size = 50
 
3250
 
 
3251
    def __init__(self, source, target):
 
3252
        InterRepository.__init__(self, source, target)
 
3253
        self._real_inter = None
 
3254
 
 
3255
    @staticmethod
 
3256
    def is_compatible(source, target):
 
3257
        if isinstance(target, remote.RemoteRepository):
 
3258
            return True
 
3259
        return False
 
3260
 
 
3261
    def _ensure_real_inter(self):
 
3262
        if self._real_inter is None:
 
3263
            self.target._ensure_real()
 
3264
            real_target = self.target._real_repository
 
3265
            self._real_inter = InterRepository.get(self.source, real_target)
 
3266
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3267
            self._real_inter.target_get_graph = self.target.get_graph
 
3268
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3269
 
 
3270
    def copy_content(self, revision_id=None):
 
3271
        self._ensure_real_inter()
 
3272
        self._real_inter.copy_content(revision_id=revision_id)
 
3273
 
 
3274
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3275
        self._ensure_real_inter()
 
3276
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3277
            find_ghosts=find_ghosts)
 
3278
 
 
3279
    @classmethod
 
3280
    def _get_repo_format_to_test(self):
 
3281
        return None
 
3282
 
 
3283
 
 
3284
class InterRemoteToOther(InterRepository):
 
3285
 
 
3286
    def __init__(self, source, target):
 
3287
        InterRepository.__init__(self, source, target)
 
3288
        self._real_inter = None
 
3289
 
 
3290
    @staticmethod
 
3291
    def is_compatible(source, target):
 
3292
        if not isinstance(source, remote.RemoteRepository):
 
3293
            return False
 
3294
        return InterRepository._same_model(source, target)
 
3295
 
 
3296
    def _ensure_real_inter(self):
 
3297
        if self._real_inter is None:
 
3298
            self.source._ensure_real()
 
3299
            real_source = self.source._real_repository
 
3300
            self._real_inter = InterRepository.get(real_source, self.target)
 
3301
 
 
3302
    @needs_write_lock
 
3303
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3304
        """See InterRepository.fetch()."""
 
3305
        # Always fetch using the generic streaming fetch code, to allow
 
3306
        # streaming fetching from remote servers.
 
3307
        from bzrlib.fetch import RepoFetcher
 
3308
        fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3309
                              pb, find_ghosts)
 
3310
 
 
3311
    def copy_content(self, revision_id=None):
 
3312
        self._ensure_real_inter()
 
3313
        self._real_inter.copy_content(revision_id=revision_id)
 
3314
 
 
3315
    @classmethod
 
3316
    def _get_repo_format_to_test(self):
 
3317
        return None
 
3318
 
 
3319
 
 
3320
 
 
3321
class InterPackToRemotePack(InterPackRepo):
 
3322
    """A specialisation of InterPackRepo for a target that is a
 
3323
    RemoteRepository.
 
3324
 
 
3325
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3326
    uses an RPC for autopacking.
 
3327
    """
 
3328
 
 
3329
    _walk_to_common_revisions_batch_size = 50
 
3330
 
 
3331
    @staticmethod
 
3332
    def is_compatible(source, target):
 
3333
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3334
        if isinstance(source._format, RepositoryFormatPack):
 
3335
            if isinstance(target, remote.RemoteRepository):
 
3336
                target._format._ensure_real()
 
3337
                if isinstance(target._format._custom_format,
 
3338
                              RepositoryFormatPack):
 
3339
                    if InterRepository._same_model(source, target):
 
3340
                        return True
 
3341
        return False
 
3342
 
 
3343
    def _autopack(self):
 
3344
        self.target.autopack()
 
3345
 
 
3346
    @needs_write_lock
 
3347
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3348
        """See InterRepository.fetch()."""
 
3349
        # Always fetch using the generic streaming fetch code, to allow
 
3350
        # streaming fetching into remote servers.
 
3351
        from bzrlib.fetch import RepoFetcher
 
3352
        fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3353
                              pb, find_ghosts)
 
3354
 
 
3355
    def _get_target_pack_collection(self):
 
3356
        return self.target._real_repository._pack_collection
 
3357
 
 
3358
    @classmethod
 
3359
    def _get_repo_format_to_test(self):
 
3360
        return None
 
3361
 
 
3362
 
4062
3363
InterRepository.register_optimiser(InterDifferingSerializer)
4063
3364
InterRepository.register_optimiser(InterSameDataRepository)
4064
3365
InterRepository.register_optimiser(InterWeaveRepo)
4065
3366
InterRepository.register_optimiser(InterKnitRepo)
 
3367
InterRepository.register_optimiser(InterPackRepo)
 
3368
InterRepository.register_optimiser(InterOtherToRemote)
 
3369
InterRepository.register_optimiser(InterRemoteToOther)
 
3370
InterRepository.register_optimiser(InterPackToRemotePack)
4066
3371
 
4067
3372
 
4068
3373
class CopyConverter(object):
4084
3389
        :param to_convert: The disk object to convert.
4085
3390
        :param pb: a progress bar to use for progress information.
4086
3391
        """
4087
 
        pb = ui.ui_factory.nested_progress_bar()
 
3392
        self.pb = pb
4088
3393
        self.count = 0
4089
3394
        self.total = 4
4090
3395
        # this is only useful with metadir layouts - separated repo content.
4091
3396
        # trigger an assertion if not such
4092
3397
        repo._format.get_format_string()
4093
3398
        self.repo_dir = repo.bzrdir
4094
 
        pb.update('Moving repository to repository.backup')
 
3399
        self.step('Moving repository to repository.backup')
4095
3400
        self.repo_dir.transport.move('repository', 'repository.backup')
4096
3401
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4097
3402
        repo._format.check_conversion_target(self.target_format)
4098
3403
        self.source_repo = repo._format.open(self.repo_dir,
4099
3404
            _found=True,
4100
3405
            _override_transport=backup_transport)
4101
 
        pb.update('Creating new repository')
 
3406
        self.step('Creating new repository')
4102
3407
        converted = self.target_format.initialize(self.repo_dir,
4103
3408
                                                  self.source_repo.is_shared())
4104
3409
        converted.lock_write()
4105
3410
        try:
4106
 
            pb.update('Copying content')
 
3411
            self.step('Copying content into repository.')
4107
3412
            self.source_repo.copy_content_into(converted)
4108
3413
        finally:
4109
3414
            converted.unlock()
4110
 
        pb.update('Deleting old repository content')
 
3415
        self.step('Deleting old repository content.')
4111
3416
        self.repo_dir.transport.delete_tree('repository.backup')
4112
 
        ui.ui_factory.note('repository converted')
4113
 
        pb.finished()
 
3417
        self.pb.note('repository converted')
 
3418
 
 
3419
    def step(self, message):
 
3420
        """Update the pb by a step."""
 
3421
        self.count +=1
 
3422
        self.pb.update(message, self.count, self.total)
4114
3423
 
4115
3424
 
4116
3425
_unescape_map = {
4145
3454
 
4146
3455
class _VersionedFileChecker(object):
4147
3456
 
4148
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3457
    def __init__(self, repository):
4149
3458
        self.repository = repository
4150
 
        self.text_index = self.repository._generate_text_key_index(
4151
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3459
        self.text_index = self.repository._generate_text_key_index()
4152
3460
 
4153
3461
    def calculate_file_version_parents(self, text_key):
4154
3462
        """Calculate the correct parents for a file version according to
4172
3480
            revision_id) tuples for versions that are present in this versioned
4173
3481
            file, but not used by the corresponding inventory.
4174
3482
        """
4175
 
        local_progress = None
4176
 
        if progress_bar is None:
4177
 
            local_progress = ui.ui_factory.nested_progress_bar()
4178
 
            progress_bar = local_progress
4179
 
        try:
4180
 
            return self._check_file_version_parents(texts, progress_bar)
4181
 
        finally:
4182
 
            if local_progress:
4183
 
                local_progress.finished()
4184
 
 
4185
 
    def _check_file_version_parents(self, texts, progress_bar):
4186
 
        """See check_file_version_parents."""
4187
3483
        wrong_parents = {}
4188
3484
        self.file_ids = set([file_id for file_id, _ in
4189
3485
            self.text_index.iterkeys()])
4190
3486
        # text keys is now grouped by file_id
 
3487
        n_weaves = len(self.file_ids)
 
3488
        files_in_revisions = {}
 
3489
        revisions_of_files = {}
4191
3490
        n_versions = len(self.text_index)
4192
3491
        progress_bar.update('loading text store', 0, n_versions)
4193
3492
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4195
3494
        text_keys = self.repository.texts.keys()
4196
3495
        unused_keys = frozenset(text_keys) - set(self.text_index)
4197
3496
        for num, key in enumerate(self.text_index.iterkeys()):
4198
 
            progress_bar.update('checking text graph', num, n_versions)
 
3497
            if progress_bar is not None:
 
3498
                progress_bar.update('checking text graph', num, n_versions)
4199
3499
            correct_parents = self.calculate_file_version_parents(key)
4200
3500
            try:
4201
3501
                knit_parents = parent_map[key]
4250
3550
        try:
4251
3551
            if resume_tokens:
4252
3552
                self.target_repo.resume_write_group(resume_tokens)
4253
 
                is_resume = True
4254
3553
            else:
4255
3554
                self.target_repo.start_write_group()
4256
 
                is_resume = False
4257
3555
            try:
4258
3556
                # locked_insert_stream performs a commit|suspend.
4259
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3557
                return self._locked_insert_stream(stream, src_format)
4260
3558
            except:
4261
3559
                self.target_repo.abort_write_group(suppress_errors=True)
4262
3560
                raise
4263
3561
        finally:
4264
3562
            self.target_repo.unlock()
4265
3563
 
4266
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3564
    def _locked_insert_stream(self, stream, src_format):
4267
3565
        to_serializer = self.target_repo._format._serializer
4268
3566
        src_serializer = src_format._serializer
4269
 
        new_pack = None
4270
 
        if to_serializer == src_serializer:
4271
 
            # If serializers match and the target is a pack repository, set the
4272
 
            # write cache size on the new pack.  This avoids poor performance
4273
 
            # on transports where append is unbuffered (such as
4274
 
            # RemoteTransport).  This is safe to do because nothing should read
4275
 
            # back from the target repository while a stream with matching
4276
 
            # serialization is being inserted.
4277
 
            # The exception is that a delta record from the source that should
4278
 
            # be a fulltext may need to be expanded by the target (see
4279
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4280
 
            # explicitly flush any buffered writes first in that rare case.
4281
 
            try:
4282
 
                new_pack = self.target_repo._pack_collection._new_pack
4283
 
            except AttributeError:
4284
 
                # Not a pack repository
4285
 
                pass
4286
 
            else:
4287
 
                new_pack.set_write_cache_size(1024*1024)
4288
3567
        for substream_type, substream in stream:
4289
 
            if 'stream' in debug.debug_flags:
4290
 
                mutter('inserting substream: %s', substream_type)
4291
3568
            if substream_type == 'texts':
4292
3569
                self.target_repo.texts.insert_record_stream(substream)
4293
3570
            elif substream_type == 'inventories':
4297
3574
                else:
4298
3575
                    self._extract_and_insert_inventories(
4299
3576
                        substream, src_serializer)
4300
 
            elif substream_type == 'inventory-deltas':
4301
 
                ui.ui_factory.warn_cross_format_fetch(src_format,
4302
 
                    self.target_repo._format)
4303
 
                self._extract_and_insert_inventory_deltas(
4304
 
                    substream, src_serializer)
4305
 
            elif substream_type == 'chk_bytes':
4306
 
                # XXX: This doesn't support conversions, as it assumes the
4307
 
                #      conversion was done in the fetch code.
4308
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4309
3577
            elif substream_type == 'revisions':
4310
3578
                # This may fallback to extract-and-insert more often than
4311
3579
                # required if the serializers are different only in terms of
4320
3588
                self.target_repo.signatures.insert_record_stream(substream)
4321
3589
            else:
4322
3590
                raise AssertionError('kaboom! %s' % (substream_type,))
4323
 
        # Done inserting data, and the missing_keys calculations will try to
4324
 
        # read back from the inserted data, so flush the writes to the new pack
4325
 
        # (if this is pack format).
4326
 
        if new_pack is not None:
4327
 
            new_pack._write_data('', flush=True)
4328
 
        # Find all the new revisions (including ones from resume_tokens)
4329
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4330
 
            check_for_missing_texts=is_resume)
4331
3591
        try:
 
3592
            missing_keys = set()
4332
3593
            for prefix, versioned_file in (
4333
3594
                ('texts', self.target_repo.texts),
4334
3595
                ('inventories', self.target_repo.inventories),
4335
3596
                ('revisions', self.target_repo.revisions),
4336
3597
                ('signatures', self.target_repo.signatures),
4337
 
                ('chk_bytes', self.target_repo.chk_bytes),
4338
3598
                ):
4339
 
                if versioned_file is None:
4340
 
                    continue
4341
 
                # TODO: key is often going to be a StaticTuple object
4342
 
                #       I don't believe we can define a method by which
4343
 
                #       (prefix,) + StaticTuple will work, though we could
4344
 
                #       define a StaticTuple.sq_concat that would allow you to
4345
 
                #       pass in either a tuple or a StaticTuple as the second
4346
 
                #       object, so instead we could have:
4347
 
                #       StaticTuple(prefix) + key here...
4348
3599
                missing_keys.update((prefix,) + key for key in
4349
3600
                    versioned_file.get_missing_compression_parent_keys())
4350
3601
        except NotImplementedError:
4359
3610
                # missing keys can handle suspending a write group).
4360
3611
                write_group_tokens = self.target_repo.suspend_write_group()
4361
3612
                return write_group_tokens, missing_keys
4362
 
        hint = self.target_repo.commit_write_group()
4363
 
        if (to_serializer != src_serializer and
4364
 
            self.target_repo._format.pack_compresses):
4365
 
            self.target_repo.pack(hint=hint)
 
3613
        self.target_repo.commit_write_group()
4366
3614
        return [], set()
4367
3615
 
4368
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4369
 
        target_rich_root = self.target_repo._format.rich_root_data
4370
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4371
 
        for record in substream:
4372
 
            # Insert the delta directly
4373
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4374
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4375
 
            try:
4376
 
                parse_result = deserialiser.parse_text_bytes(
4377
 
                    inventory_delta_bytes)
4378
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4379
 
                trace.mutter("Incompatible delta: %s", err.msg)
4380
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4381
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4382
 
            revision_id = new_id
4383
 
            parents = [key[0] for key in record.parents]
4384
 
            self.target_repo.add_inventory_by_delta(
4385
 
                basis_id, inv_delta, revision_id, parents)
4386
 
 
4387
 
    def _extract_and_insert_inventories(self, substream, serializer,
4388
 
            parse_delta=None):
 
3616
    def _extract_and_insert_inventories(self, substream, serializer):
4389
3617
        """Generate a new inventory versionedfile in target, converting data.
4390
3618
 
4391
3619
        The inventory is retrieved from the source, (deserializing it), and
4392
3620
        stored in the target (reserializing it in a different format).
4393
3621
        """
4394
 
        target_rich_root = self.target_repo._format.rich_root_data
4395
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4396
3622
        for record in substream:
4397
 
            # It's not a delta, so it must be a fulltext in the source
4398
 
            # serializer's format.
4399
3623
            bytes = record.get_bytes_as('fulltext')
4400
3624
            revision_id = record.key[0]
4401
3625
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4402
3626
            parents = [key[0] for key in record.parents]
4403
3627
            self.target_repo.add_inventory(revision_id, inv, parents)
4404
 
            # No need to keep holding this full inv in memory when the rest of
4405
 
            # the substream is likely to be all deltas.
4406
 
            del inv
4407
3628
 
4408
3629
    def _extract_and_insert_revisions(self, substream, serializer):
4409
3630
        for record in substream:
4458
3679
        return [('signatures', signatures), ('revisions', revisions)]
4459
3680
 
4460
3681
    def _generate_root_texts(self, revs):
4461
 
        """This will be called by get_stream between fetching weave texts and
 
3682
        """This will be called by __fetch between fetching weave texts and
4462
3683
        fetching the inventory weave.
 
3684
 
 
3685
        Subclasses should override this if they need to generate root texts
 
3686
        after fetching weave texts.
4463
3687
        """
4464
3688
        if self._rich_root_upgrade():
4465
 
            return _mod_fetch.Inter1and2Helper(
 
3689
            import bzrlib.fetch
 
3690
            return bzrlib.fetch.Inter1and2Helper(
4466
3691
                self.from_repository).generate_root_texts(revs)
4467
3692
        else:
4468
3693
            return []
4471
3696
        phase = 'file'
4472
3697
        revs = search.get_keys()
4473
3698
        graph = self.from_repository.get_graph()
4474
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3699
        revs = list(graph.iter_topo_order(revs))
4475
3700
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4476
3701
        text_keys = []
4477
3702
        for knit_kind, file_id, revisions in data_to_fetch:
4496
3721
                # will be valid.
4497
3722
                for _ in self._generate_root_texts(revs):
4498
3723
                    yield _
 
3724
                # NB: This currently reopens the inventory weave in source;
 
3725
                # using a single stream interface instead would avoid this.
 
3726
                from_weave = self.from_repository.inventories
4499
3727
                # we fetch only the referenced inventories because we do not
4500
3728
                # know for unselected inventories whether all their required
4501
3729
                # texts are present in the other repository - it could be
4502
3730
                # corrupt.
4503
 
                for info in self._get_inventory_stream(revs):
4504
 
                    yield info
 
3731
                yield ('inventories', from_weave.get_record_stream(
 
3732
                    [(rev_id,) for rev_id in revs],
 
3733
                    self.inventory_fetch_order(),
 
3734
                    not self.delta_on_metadata()))
4505
3735
            elif knit_kind == "signatures":
4506
3736
                # Nothing to do here; this will be taken care of when
4507
3737
                # _fetch_revision_texts happens.
4520
3750
        keys['texts'] = set()
4521
3751
        keys['revisions'] = set()
4522
3752
        keys['inventories'] = set()
4523
 
        keys['chk_bytes'] = set()
4524
3753
        keys['signatures'] = set()
4525
3754
        for key in missing_keys:
4526
3755
            keys[key[0]].add(key[1:])
4533
3762
                    keys['revisions'],))
4534
3763
        for substream_kind, keys in keys.iteritems():
4535
3764
            vf = getattr(self.from_repository, substream_kind)
4536
 
            if vf is None and keys:
4537
 
                    raise AssertionError(
4538
 
                        "cannot fill in keys for a versioned file we don't"
4539
 
                        " have: %s needs %s" % (substream_kind, keys))
4540
 
            if not keys:
4541
 
                # No need to stream something we don't have
4542
 
                continue
4543
 
            if substream_kind == 'inventories':
4544
 
                # Some missing keys are genuinely ghosts, filter those out.
4545
 
                present = self.from_repository.inventories.get_parent_map(keys)
4546
 
                revs = [key[0] for key in present]
4547
 
                # Get the inventory stream more-or-less as we do for the
4548
 
                # original stream; there's no reason to assume that records
4549
 
                # direct from the source will be suitable for the sink.  (Think
4550
 
                # e.g. 2a -> 1.9-rich-root).
4551
 
                for info in self._get_inventory_stream(revs, missing=True):
4552
 
                    yield info
4553
 
                continue
4554
 
 
4555
3765
            # Ask for full texts always so that we don't need more round trips
4556
3766
            # after this stream.
4557
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4558
 
            # records. The Sink is responsible for doing another check to
4559
 
            # ensure that ghosts don't introduce missing data for future
4560
 
            # fetches.
4561
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4562
 
                self.to_format._fetch_order, True))
 
3767
            stream = vf.get_record_stream(keys,
 
3768
                self.to_format._fetch_order, True)
4563
3769
            yield substream_kind, stream
4564
3770
 
4565
3771
    def inventory_fetch_order(self):
4572
3778
        return (not self.from_repository._format.rich_root_data and
4573
3779
            self.to_format.rich_root_data)
4574
3780
 
4575
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4576
 
        from_format = self.from_repository._format
4577
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4578
 
            from_format.network_name() == self.to_format.network_name()):
4579
 
            raise AssertionError(
4580
 
                "this case should be handled by GroupCHKStreamSource")
4581
 
        elif 'forceinvdeltas' in debug.debug_flags:
4582
 
            return self._get_convertable_inventory_stream(revision_ids,
4583
 
                    delta_versus_null=missing)
4584
 
        elif from_format.network_name() == self.to_format.network_name():
4585
 
            # Same format.
4586
 
            return self._get_simple_inventory_stream(revision_ids,
4587
 
                    missing=missing)
4588
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4589
 
                and from_format._serializer == self.to_format._serializer):
4590
 
            # Essentially the same format.
4591
 
            return self._get_simple_inventory_stream(revision_ids,
4592
 
                    missing=missing)
4593
 
        else:
4594
 
            # Any time we switch serializations, we want to use an
4595
 
            # inventory-delta based approach.
4596
 
            return self._get_convertable_inventory_stream(revision_ids,
4597
 
                    delta_versus_null=missing)
4598
 
 
4599
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4600
 
        # NB: This currently reopens the inventory weave in source;
4601
 
        # using a single stream interface instead would avoid this.
4602
 
        from_weave = self.from_repository.inventories
4603
 
        if missing:
4604
 
            delta_closure = True
4605
 
        else:
4606
 
            delta_closure = not self.delta_on_metadata()
4607
 
        yield ('inventories', from_weave.get_record_stream(
4608
 
            [(rev_id,) for rev_id in revision_ids],
4609
 
            self.inventory_fetch_order(), delta_closure))
4610
 
 
4611
 
    def _get_convertable_inventory_stream(self, revision_ids,
4612
 
                                          delta_versus_null=False):
4613
 
        # The two formats are sufficiently different that there is no fast
4614
 
        # path, so we need to send just inventorydeltas, which any
4615
 
        # sufficiently modern client can insert into any repository.
4616
 
        # The StreamSink code expects to be able to
4617
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4618
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4619
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4620
 
        yield ('inventory-deltas',
4621
 
           self._stream_invs_as_deltas(revision_ids,
4622
 
                                       delta_versus_null=delta_versus_null))
4623
 
 
4624
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4625
 
        """Return a stream of inventory-deltas for the given rev ids.
4626
 
 
4627
 
        :param revision_ids: The list of inventories to transmit
4628
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4629
 
            entry, instead compute the delta versus the NULL_REVISION. This
4630
 
            effectively streams a complete inventory. Used for stuff like
4631
 
            filling in missing parents, etc.
4632
 
        """
4633
 
        from_repo = self.from_repository
4634
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4635
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4636
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4637
 
        # method...
4638
 
        inventories = self.from_repository.iter_inventories(
4639
 
            revision_ids, 'topological')
4640
 
        format = from_repo._format
4641
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4642
 
        inventory_cache = lru_cache.LRUCache(50)
4643
 
        null_inventory = from_repo.revision_tree(
4644
 
            _mod_revision.NULL_REVISION).inventory
4645
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4646
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4647
 
        # repo back into a non-rich-root repo ought to be allowed)
4648
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4649
 
            versioned_root=format.rich_root_data,
4650
 
            tree_references=format.supports_tree_reference)
4651
 
        for inv in inventories:
4652
 
            key = (inv.revision_id,)
4653
 
            parent_keys = parent_map.get(key, ())
4654
 
            delta = None
4655
 
            if not delta_versus_null and parent_keys:
4656
 
                # The caller did not ask for complete inventories and we have
4657
 
                # some parents that we can delta against.  Make a delta against
4658
 
                # each parent so that we can find the smallest.
4659
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4660
 
                for parent_id in parent_ids:
4661
 
                    if parent_id not in invs_sent_so_far:
4662
 
                        # We don't know that the remote side has this basis, so
4663
 
                        # we can't use it.
4664
 
                        continue
4665
 
                    if parent_id == _mod_revision.NULL_REVISION:
4666
 
                        parent_inv = null_inventory
4667
 
                    else:
4668
 
                        parent_inv = inventory_cache.get(parent_id, None)
4669
 
                        if parent_inv is None:
4670
 
                            parent_inv = from_repo.get_inventory(parent_id)
4671
 
                    candidate_delta = inv._make_delta(parent_inv)
4672
 
                    if (delta is None or
4673
 
                        len(delta) > len(candidate_delta)):
4674
 
                        delta = candidate_delta
4675
 
                        basis_id = parent_id
4676
 
            if delta is None:
4677
 
                # Either none of the parents ended up being suitable, or we
4678
 
                # were asked to delta against NULL
4679
 
                basis_id = _mod_revision.NULL_REVISION
4680
 
                delta = inv._make_delta(null_inventory)
4681
 
            invs_sent_so_far.add(inv.revision_id)
4682
 
            inventory_cache[inv.revision_id] = inv
4683
 
            delta_serialized = ''.join(
4684
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4685
 
            yield versionedfile.FulltextContentFactory(
4686
 
                key, parent_keys, None, delta_serialized)
4687
 
 
4688
 
 
4689
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4690
 
                    stop_revision=None):
4691
 
    """Extend the partial history to include a given index
4692
 
 
4693
 
    If a stop_index is supplied, stop when that index has been reached.
4694
 
    If a stop_revision is supplied, stop when that revision is
4695
 
    encountered.  Otherwise, stop when the beginning of history is
4696
 
    reached.
4697
 
 
4698
 
    :param stop_index: The index which should be present.  When it is
4699
 
        present, history extension will stop.
4700
 
    :param stop_revision: The revision id which should be present.  When
4701
 
        it is encountered, history extension will stop.
4702
 
    """
4703
 
    start_revision = partial_history_cache[-1]
4704
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4705
 
    try:
4706
 
        #skip the last revision in the list
4707
 
        iterator.next()
4708
 
        while True:
4709
 
            if (stop_index is not None and
4710
 
                len(partial_history_cache) > stop_index):
4711
 
                break
4712
 
            if partial_history_cache[-1] == stop_revision:
4713
 
                break
4714
 
            revision_id = iterator.next()
4715
 
            partial_history_cache.append(revision_id)
4716
 
    except StopIteration:
4717
 
        # No more history
4718
 
        return
4719