/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-24 16:35:22 UTC
  • mto: This revision was merged to the branch mainline in revision 4198.
  • Revision ID: john@arbash-meinel.com-20090324163522-p0p9s5ahzsnem1oc
A few notes, some updates from ian.

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, 2009 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,
42
37
    revision as _mod_revision,
43
 
    static_tuple,
44
38
    symbol_versioning,
45
 
    trace,
46
39
    tsort,
47
40
    ui,
48
41
    versionedfile,
53
46
from bzrlib.testament import Testament
54
47
""")
55
48
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
50
from bzrlib.inter import InterObject
58
 
from bzrlib.inventory import (
59
 
    Inventory,
60
 
    InventoryDirectory,
61
 
    ROOT_ID,
62
 
    entry_factory,
63
 
    )
64
 
from bzrlib.lock import _RelockDebugMixin
 
51
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
65
52
from bzrlib import registry
 
53
from bzrlib.symbol_versioning import (
 
54
        deprecated_method,
 
55
        one_one,
 
56
        one_two,
 
57
        one_six,
 
58
        )
66
59
from bzrlib.trace import (
67
60
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
61
 
132
125
        # valid. Callers that will call record_delete() should call
133
126
        # .will_record_deletes() to indicate that.
134
127
        self._recording_deletes = False
135
 
        # memo'd check for no-op commits.
136
 
        self._any_changes = False
137
 
 
138
 
    def any_changes(self):
139
 
        """Return True if any entries were changed.
140
 
        
141
 
        This includes merge-only changes. It is the core for the --unchanged
142
 
        detection in commit.
143
 
 
144
 
        :return: True if any changes have occured.
145
 
        """
146
 
        return self._any_changes
147
128
 
148
129
    def _validate_unicode_text(self, text, context):
149
130
        """Verify things like commit messages don't have bogus characters."""
194
175
        deserializing the inventory, while we already have a copy in
195
176
        memory.
196
177
        """
197
 
        if self.new_inventory is None:
198
 
            self.new_inventory = self.repository.get_inventory(
199
 
                self._new_revision_id)
200
178
        return RevisionTree(self.repository, self.new_inventory,
201
 
            self._new_revision_id)
 
179
                            self._new_revision_id)
202
180
 
203
181
    def finish_inventory(self):
204
 
        """Tell the builder that the inventory is finished.
205
 
 
206
 
        :return: The inventory id in the repository, which can be used with
207
 
            repository.get_inventory.
208
 
        """
209
 
        if self.new_inventory is None:
210
 
            # an inventory delta was accumulated without creating a new
211
 
            # inventory.
212
 
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
217
 
                basis_id, self._basis_delta, self._new_revision_id,
218
 
                self.parents)
219
 
        else:
220
 
            if self.new_inventory.root is None:
221
 
                raise AssertionError('Root entry should be supplied to'
222
 
                    ' record_entry_contents, as of bzr 0.10.')
223
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
224
 
            self.new_inventory.revision_id = self._new_revision_id
225
 
            self.inv_sha1 = self.repository.add_inventory(
226
 
                self._new_revision_id,
227
 
                self.new_inventory,
228
 
                self.parents
229
 
                )
230
 
        return self._new_revision_id
 
182
        """Tell the builder that the inventory is finished."""
 
183
        if self.new_inventory.root is None:
 
184
            raise AssertionError('Root entry should be supplied to'
 
185
                ' record_entry_contents, as of bzr 0.10.')
 
186
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
187
        self.new_inventory.revision_id = self._new_revision_id
 
188
        self.inv_sha1 = self.repository.add_inventory(
 
189
            self._new_revision_id,
 
190
            self.new_inventory,
 
191
            self.parents
 
192
            )
231
193
 
232
194
    def _gen_revision_id(self):
233
195
        """Return new revision-id."""
270
232
        # _new_revision_id
271
233
        ie.revision = self._new_revision_id
272
234
 
273
 
    def _require_root_change(self, tree):
274
 
        """Enforce an appropriate root object change.
275
 
 
276
 
        This is called once when record_iter_changes is called, if and only if
277
 
        the root was not in the delta calculated by record_iter_changes.
278
 
 
279
 
        :param tree: The tree which is being committed.
280
 
        """
281
 
        # NB: if there are no parents then this method is not called, so no
282
 
        # need to guard on parents having length.
283
 
        entry = entry_factory['directory'](tree.path2id(''), '',
284
 
            None)
285
 
        entry.revision = self._new_revision_id
286
 
        self._basis_delta.append(('', '', entry.file_id, entry))
287
 
 
288
235
    def _get_delta(self, ie, basis_inv, path):
289
236
        """Get a delta against the basis inventory for ie."""
290
237
        if ie.file_id not in basis_inv:
332
279
            raise AssertionError("recording deletes not activated.")
333
280
        delta = (path, None, file_id, None)
334
281
        self._basis_delta.append(delta)
335
 
        self._any_changes = True
336
282
        return delta
337
283
 
338
284
    def will_record_deletes(self):
343
289
        builder.record_delete().
344
290
        """
345
291
        self._recording_deletes = True
346
 
        try:
347
 
            basis_id = self.parents[0]
348
 
        except IndexError:
349
 
            basis_id = _mod_revision.NULL_REVISION
350
 
        self.basis_delta_revision = basis_id
351
292
 
352
293
    def record_entry_contents(self, ie, parent_invs, path, tree,
353
294
        content_summary):
473
414
            if content_summary[2] is None:
474
415
                raise ValueError("Files must not have executable = None")
475
416
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
417
                if (# if the file length changed we have to store:
 
418
                    parent_entry.text_size != content_summary[1] or
 
419
                    # if the exec bit has changed we have to store:
479
420
                    parent_entry.executable != content_summary[2]):
480
421
                    store = True
481
422
                elif parent_entry.text_sha1 == content_summary[3]:
500
441
            ie.executable = content_summary[2]
501
442
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
502
443
            try:
503
 
                text = file_obj.read()
 
444
                lines = file_obj.readlines()
504
445
            finally:
505
446
                file_obj.close()
506
447
            try:
507
448
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
 
                    ie.file_id, text, heads, nostore_sha)
 
449
                    ie.file_id, lines, heads, nostore_sha)
509
450
                # Let the caller know we generated a stat fingerprint.
510
451
                fingerprint = (ie.text_sha1, stat_value)
511
452
            except errors.ExistingContent:
523
464
                # carry over:
524
465
                ie.revision = parent_entry.revision
525
466
                return self._get_delta(ie, basis_inv, path), False, None
526
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
467
            lines = []
 
468
            self._add_text_to_weave(ie.file_id, lines, heads, None)
527
469
        elif kind == 'symlink':
528
470
            current_link_target = content_summary[3]
529
471
            if not store:
537
479
                ie.symlink_target = parent_entry.symlink_target
538
480
                return self._get_delta(ie, basis_inv, path), False, None
539
481
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
482
            lines = []
 
483
            self._add_text_to_weave(ie.file_id, lines, heads, None)
541
484
        elif kind == 'tree-reference':
542
485
            if not store:
543
486
                if content_summary[3] != parent_entry.reference_revision:
548
491
                ie.revision = parent_entry.revision
549
492
                return self._get_delta(ie, basis_inv, path), False, None
550
493
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
494
            lines = []
 
495
            self._add_text_to_weave(ie.file_id, lines, heads, None)
555
496
        else:
556
497
            raise NotImplementedError('unknown kind')
557
498
        ie.revision = self._new_revision_id
558
 
        self._any_changes = True
559
499
        return self._get_delta(ie, basis_inv, path), True, fingerprint
560
500
 
561
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
562
 
        _entry_factory=entry_factory):
563
 
        """Record a new tree via iter_changes.
564
 
 
565
 
        :param tree: The tree to obtain text contents from for changed objects.
566
 
        :param basis_revision_id: The revision id of the tree the iter_changes
567
 
            has been generated against. Currently assumed to be the same
568
 
            as self.parents[0] - if it is not, errors may occur.
569
 
        :param iter_changes: An iter_changes iterator with the changes to apply
570
 
            to basis_revision_id. The iterator must not include any items with
571
 
            a current kind of None - missing items must be either filtered out
572
 
            or errored-on beefore record_iter_changes sees the item.
573
 
        :param _entry_factory: Private method to bind entry_factory locally for
574
 
            performance.
575
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
576
 
            tree._observed_sha1.
577
 
        """
578
 
        # Create an inventory delta based on deltas between all the parents and
579
 
        # deltas between all the parent inventories. We use inventory delta's 
580
 
        # between the inventory objects because iter_changes masks
581
 
        # last-changed-field only changes.
582
 
        # Working data:
583
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
584
 
        # parents, names, kinds, executables
585
 
        merged_ids = {}
586
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
587
 
        # trees that are not parents[0]
588
 
        parent_entries = {}
589
 
        ghost_basis = False
590
 
        try:
591
 
            revtrees = list(self.repository.revision_trees(self.parents))
592
 
        except errors.NoSuchRevision:
593
 
            # one or more ghosts, slow path.
594
 
            revtrees = []
595
 
            for revision_id in self.parents:
596
 
                try:
597
 
                    revtrees.append(self.repository.revision_tree(revision_id))
598
 
                except errors.NoSuchRevision:
599
 
                    if not revtrees:
600
 
                        basis_revision_id = _mod_revision.NULL_REVISION
601
 
                        ghost_basis = True
602
 
                    revtrees.append(self.repository.revision_tree(
603
 
                        _mod_revision.NULL_REVISION))
604
 
        # The basis inventory from a repository 
605
 
        if revtrees:
606
 
            basis_inv = revtrees[0].inventory
607
 
        else:
608
 
            basis_inv = self.repository.revision_tree(
609
 
                _mod_revision.NULL_REVISION).inventory
610
 
        if len(self.parents) > 0:
611
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
612
 
                raise Exception(
613
 
                    "arbitrary basis parents not yet supported with merges")
614
 
            for revtree in revtrees[1:]:
615
 
                for change in revtree.inventory._make_delta(basis_inv):
616
 
                    if change[1] is None:
617
 
                        # Not present in this parent.
618
 
                        continue
619
 
                    if change[2] not in merged_ids:
620
 
                        if change[0] is not None:
621
 
                            basis_entry = basis_inv[change[2]]
622
 
                            merged_ids[change[2]] = [
623
 
                                # basis revid
624
 
                                basis_entry.revision,
625
 
                                # new tree revid
626
 
                                change[3].revision]
627
 
                            parent_entries[change[2]] = {
628
 
                                # basis parent
629
 
                                basis_entry.revision:basis_entry,
630
 
                                # this parent 
631
 
                                change[3].revision:change[3],
632
 
                                }
633
 
                        else:
634
 
                            merged_ids[change[2]] = [change[3].revision]
635
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
636
 
                    else:
637
 
                        merged_ids[change[2]].append(change[3].revision)
638
 
                        parent_entries[change[2]][change[3].revision] = change[3]
639
 
        else:
640
 
            merged_ids = {}
641
 
        # Setup the changes from the tree:
642
 
        # changes maps file_id -> (change, [parent revision_ids])
643
 
        changes= {}
644
 
        for change in iter_changes:
645
 
            # This probably looks up in basis_inv way to much.
646
 
            if change[1][0] is not None:
647
 
                head_candidate = [basis_inv[change[0]].revision]
648
 
            else:
649
 
                head_candidate = []
650
 
            changes[change[0]] = change, merged_ids.get(change[0],
651
 
                head_candidate)
652
 
        unchanged_merged = set(merged_ids) - set(changes)
653
 
        # Extend the changes dict with synthetic changes to record merges of
654
 
        # texts.
655
 
        for file_id in unchanged_merged:
656
 
            # Record a merged version of these items that did not change vs the
657
 
            # basis. This can be either identical parallel changes, or a revert
658
 
            # of a specific file after a merge. The recorded content will be
659
 
            # that of the current tree (which is the same as the basis), but
660
 
            # the per-file graph will reflect a merge.
661
 
            # NB:XXX: We are reconstructing path information we had, this
662
 
            # should be preserved instead.
663
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
664
 
            #   changed_content, versioned, parent, name, kind,
665
 
            #   executable)
666
 
            try:
667
 
                basis_entry = basis_inv[file_id]
668
 
            except errors.NoSuchId:
669
 
                # a change from basis->some_parents but file_id isn't in basis
670
 
                # so was new in the merge, which means it must have changed
671
 
                # from basis -> current, and as it hasn't the add was reverted
672
 
                # by the user. So we discard this change.
673
 
                pass
674
 
            else:
675
 
                change = (file_id,
676
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
677
 
                    False, (True, True),
678
 
                    (basis_entry.parent_id, basis_entry.parent_id),
679
 
                    (basis_entry.name, basis_entry.name),
680
 
                    (basis_entry.kind, basis_entry.kind),
681
 
                    (basis_entry.executable, basis_entry.executable))
682
 
                changes[file_id] = (change, merged_ids[file_id])
683
 
        # changes contains tuples with the change and a set of inventory
684
 
        # candidates for the file.
685
 
        # inv delta is:
686
 
        # old_path, new_path, file_id, new_inventory_entry
687
 
        seen_root = False # Is the root in the basis delta?
688
 
        inv_delta = self._basis_delta
689
 
        modified_rev = self._new_revision_id
690
 
        for change, head_candidates in changes.values():
691
 
            if change[3][1]: # versioned in target.
692
 
                # Several things may be happening here:
693
 
                # We may have a fork in the per-file graph
694
 
                #  - record a change with the content from tree
695
 
                # We may have a change against < all trees  
696
 
                #  - carry over the tree that hasn't changed
697
 
                # We may have a change against all trees
698
 
                #  - record the change with the content from tree
699
 
                kind = change[6][1]
700
 
                file_id = change[0]
701
 
                entry = _entry_factory[kind](file_id, change[5][1],
702
 
                    change[4][1])
703
 
                head_set = self._heads(change[0], set(head_candidates))
704
 
                heads = []
705
 
                # Preserve ordering.
706
 
                for head_candidate in head_candidates:
707
 
                    if head_candidate in head_set:
708
 
                        heads.append(head_candidate)
709
 
                        head_set.remove(head_candidate)
710
 
                carried_over = False
711
 
                if len(heads) == 1:
712
 
                    # Could be a carry-over situation:
713
 
                    parent_entry_revs = parent_entries.get(file_id, None)
714
 
                    if parent_entry_revs:
715
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
716
 
                    else:
717
 
                        parent_entry = None
718
 
                    if parent_entry is None:
719
 
                        # The parent iter_changes was called against is the one
720
 
                        # that is the per-file head, so any change is relevant
721
 
                        # iter_changes is valid.
722
 
                        carry_over_possible = False
723
 
                    else:
724
 
                        # could be a carry over situation
725
 
                        # A change against the basis may just indicate a merge,
726
 
                        # we need to check the content against the source of the
727
 
                        # merge to determine if it was changed after the merge
728
 
                        # or carried over.
729
 
                        if (parent_entry.kind != entry.kind or
730
 
                            parent_entry.parent_id != entry.parent_id or
731
 
                            parent_entry.name != entry.name):
732
 
                            # Metadata common to all entries has changed
733
 
                            # against per-file parent
734
 
                            carry_over_possible = False
735
 
                        else:
736
 
                            carry_over_possible = True
737
 
                        # per-type checks for changes against the parent_entry
738
 
                        # are done below.
739
 
                else:
740
 
                    # Cannot be a carry-over situation
741
 
                    carry_over_possible = False
742
 
                # Populate the entry in the delta
743
 
                if kind == 'file':
744
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
745
 
                    # after iter_changes examines and decides it has changed,
746
 
                    # we will unconditionally record a new version even if some
747
 
                    # other process reverts it while commit is running (with
748
 
                    # the revert happening after iter_changes did it's
749
 
                    # examination).
750
 
                    if change[7][1]:
751
 
                        entry.executable = True
752
 
                    else:
753
 
                        entry.executable = False
754
 
                    if (carry_over_possible and
755
 
                        parent_entry.executable == entry.executable):
756
 
                            # Check the file length, content hash after reading
757
 
                            # the file.
758
 
                            nostore_sha = parent_entry.text_sha1
759
 
                    else:
760
 
                        nostore_sha = None
761
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
762
 
                    try:
763
 
                        text = file_obj.read()
764
 
                    finally:
765
 
                        file_obj.close()
766
 
                    try:
767
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
 
                            file_id, text, heads, nostore_sha)
769
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
770
 
                    except errors.ExistingContent:
771
 
                        # No content change against a carry_over parent
772
 
                        # Perhaps this should also yield a fs hash update?
773
 
                        carried_over = True
774
 
                        entry.text_size = parent_entry.text_size
775
 
                        entry.text_sha1 = parent_entry.text_sha1
776
 
                elif kind == 'symlink':
777
 
                    # Wants a path hint?
778
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
779
 
                    if (carry_over_possible and
780
 
                        parent_entry.symlink_target == entry.symlink_target):
781
 
                        carried_over = True
782
 
                    else:
783
 
                        self._add_text_to_weave(change[0], '', heads, None)
784
 
                elif kind == 'directory':
785
 
                    if carry_over_possible:
786
 
                        carried_over = True
787
 
                    else:
788
 
                        # Nothing to set on the entry.
789
 
                        # XXX: split into the Root and nonRoot versions.
790
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
791
 
                            self._add_text_to_weave(change[0], '', heads, None)
792
 
                elif kind == 'tree-reference':
793
 
                    if not self.repository._format.supports_tree_reference:
794
 
                        # This isn't quite sane as an error, but we shouldn't
795
 
                        # ever see this code path in practice: tree's don't
796
 
                        # permit references when the repo doesn't support tree
797
 
                        # references.
798
 
                        raise errors.UnsupportedOperation(tree.add_reference,
799
 
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
802
 
                    if (carry_over_possible and
803
 
                        parent_entry.reference_revision == reference_revision):
804
 
                        carried_over = True
805
 
                    else:
806
 
                        self._add_text_to_weave(change[0], '', heads, None)
807
 
                else:
808
 
                    raise AssertionError('unknown kind %r' % kind)
809
 
                if not carried_over:
810
 
                    entry.revision = modified_rev
811
 
                else:
812
 
                    entry.revision = parent_entry.revision
813
 
            else:
814
 
                entry = None
815
 
            new_path = change[1][1]
816
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
817
 
            if new_path == '':
818
 
                seen_root = True
819
 
        self.new_inventory = None
820
 
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
 
            self._any_changes = True
825
 
        if not seen_root:
826
 
            # housekeeping root entry changes do not affect no-change commits.
827
 
            self._require_root_change(tree)
828
 
        self.basis_delta_revision = basis_revision_id
829
 
 
830
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
832
 
        return self.repository.texts._add_text(
833
 
            (file_id, self._new_revision_id), parent_keys, new_text,
834
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
501
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
502
        # Note: as we read the content directly from the tree, we know its not
 
503
        # been turned into unicode or badly split - but a broken tree
 
504
        # implementation could give us bad output from readlines() so this is
 
505
        # not a guarantee of safety. What would be better is always checking
 
506
        # the content during test suite execution. RBC 20070912
 
507
        parent_keys = tuple((file_id, parent) for parent in parents)
 
508
        return self.repository.texts.add_lines(
 
509
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
510
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
511
            check_content=False)[0:2]
835
512
 
836
513
 
837
514
class RootCommitBuilder(CommitBuilder):
849
526
        :param tree: The tree that is being committed.
850
527
        """
851
528
 
852
 
    def _require_root_change(self, tree):
853
 
        """Enforce an appropriate root object change.
854
 
 
855
 
        This is called once when record_iter_changes is called, if and only if
856
 
        the root was not in the delta calculated by record_iter_changes.
857
 
 
858
 
        :param tree: The tree which is being committed.
859
 
        """
860
 
        # versioned roots do not change unless the tree found a change.
861
 
 
862
 
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
    def __str__(self):
876
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
877
 
            self.unlock)
878
 
 
879
529
 
880
530
######################################################################
881
531
# Repositories
882
532
 
883
 
 
884
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
533
class Repository(object):
885
534
    """Repository holding history for one or more branches.
886
535
 
887
536
    The repository holds and retrieves historical information including
889
538
    which views a particular line of development through that history.
890
539
 
891
540
    The Repository builds on top of some byte storage facilies (the revisions,
892
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
893
 
    which respectively provide byte storage and a means to access the (possibly
 
541
    signatures, inventories and texts attributes) and a Transport, which
 
542
    respectively provide byte storage and a means to access the (possibly
894
543
    remote) disk.
895
544
 
896
545
    The byte storage facilities are addressed via tuples, which we refer to
897
546
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
898
547
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
899
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
900
 
    byte string made up of a hash identifier and a hash value.
901
 
    We use this interface because it allows low friction with the underlying
902
 
    code that implements disk indices, network encoding and other parts of
903
 
    bzrlib.
 
548
    (file_id, revision_id). We use this interface because it allows low
 
549
    friction with the underlying code that implements disk indices, network
 
550
    encoding and other parts of bzrlib.
904
551
 
905
552
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
906
553
        the serialised revisions for the repository. This can be used to obtain
925
572
        The result of trying to insert data into the repository via this store
926
573
        is undefined: it should be considered read-only except for implementors
927
574
        of repositories.
928
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
929
 
        any data the repository chooses to store or have indexed by its hash.
930
 
        The result of trying to insert data into the repository via this store
931
 
        is undefined: it should be considered read-only except for implementors
932
 
        of repositories.
933
575
    :ivar _transport: Transport for file access to repository, typically
934
576
        pointing to .bzr/repository.
935
577
    """
956
598
        """
957
599
        if self._write_group is not self.get_transaction():
958
600
            # has an unlock or relock occured ?
959
 
            if suppress_errors:
960
 
                mutter(
961
 
                '(suppressed) mismatched lock context and write group. %r, %r',
962
 
                self._write_group, self.get_transaction())
963
 
                return
964
 
            raise errors.BzrError(
965
 
                'mismatched lock context and write group. %r, %r' %
966
 
                (self._write_group, self.get_transaction()))
 
601
            raise errors.BzrError('mismatched lock context and write group.')
967
602
        try:
968
603
            self._abort_write_group()
969
604
        except Exception, exc:
995
630
        """
996
631
        if not self._format.supports_external_lookups:
997
632
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
998
 
        if self.is_locked():
999
 
            # This repository will call fallback.unlock() when we transition to
1000
 
            # the unlocked state, so we make sure to increment the lock count
1001
 
            repository.lock_read()
1002
633
        self._check_fallback_repository(repository)
1003
634
        self._fallback_repositories.append(repository)
1004
635
        self.texts.add_fallback_versioned_files(repository.texts)
1005
636
        self.inventories.add_fallback_versioned_files(repository.inventories)
1006
637
        self.revisions.add_fallback_versioned_files(repository.revisions)
1007
638
        self.signatures.add_fallback_versioned_files(repository.signatures)
1008
 
        if self.chk_bytes is not None:
1009
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1010
639
 
1011
640
    def _check_fallback_repository(self, repository):
1012
641
        """Check that this repository can fallback to repository safely.
1036
665
                % (inv.revision_id, revision_id))
1037
666
        if inv.root is None:
1038
667
            raise AssertionError()
1039
 
        return self._add_inventory_checked(revision_id, inv, parents)
1040
 
 
1041
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1042
 
        """Add inv to the repository after checking the inputs.
1043
 
 
1044
 
        This function can be overridden to allow different inventory styles.
1045
 
 
1046
 
        :seealso: add_inventory, for the contract.
1047
 
        """
1048
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
668
        inv_lines = self._serialise_inventory_to_lines(inv)
1049
669
        return self._inventory_add_lines(revision_id, parents,
1050
670
            inv_lines, check_content=False)
1051
671
 
1052
672
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1053
 
                               parents, basis_inv=None, propagate_caches=False):
 
673
                               parents):
1054
674
        """Add a new inventory expressed as a delta against another revision.
1055
675
 
1056
 
        See the inventory developers documentation for the theory behind
1057
 
        inventory deltas.
1058
 
 
1059
676
        :param basis_revision_id: The inventory id the delta was created
1060
677
            against. (This does not have to be a direct parent.)
1061
678
        :param delta: The inventory delta (see Inventory.apply_delta for
1067
684
            for repositories that depend on the inventory graph for revision
1068
685
            graph access, as well as for those that pun ancestry with delta
1069
686
            compression.
1070
 
        :param basis_inv: The basis inventory if it is already known,
1071
 
            otherwise None.
1072
 
        :param propagate_caches: If True, the caches for this inventory are
1073
 
          copied to and updated for the result if possible.
1074
687
 
1075
688
        :returns: (validator, new_inv)
1076
689
            The validator(which is a sha1 digest, though what is sha'd is
1087
700
            # inventory implementations may support: A better idiom would be to
1088
701
            # return a new inventory, but as there is no revision tree cache in
1089
702
            # repository this is safe for now - RBC 20081013
1090
 
            if basis_inv is None:
1091
 
                basis_inv = basis_tree.inventory
 
703
            basis_inv = basis_tree.inventory
1092
704
            basis_inv.apply_delta(delta)
1093
705
            basis_inv.revision_id = new_revision_id
1094
706
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1100
712
        check_content=True):
1101
713
        """Store lines in inv_vf and return the sha1 of the inventory."""
1102
714
        parents = [(parent,) for parent in parents]
1103
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
715
        return self.inventories.add_lines((revision_id,), parents, lines,
1104
716
            check_content=check_content)[0]
1105
 
        self.inventories._access.flush()
1106
 
        return result
1107
717
 
1108
718
    def add_revision(self, revision_id, rev, inv=None, config=None):
1109
719
        """Add rev to the revision store as revision_id.
1185
795
        # The old API returned a list, should this actually be a set?
1186
796
        return parent_map.keys()
1187
797
 
1188
 
    def _check_inventories(self, checker):
1189
 
        """Check the inventories found from the revision scan.
1190
 
        
1191
 
        This is responsible for verifying the sha1 of inventories and
1192
 
        creating a pending_keys set that covers data referenced by inventories.
1193
 
        """
1194
 
        bar = ui.ui_factory.nested_progress_bar()
1195
 
        try:
1196
 
            self._do_check_inventories(checker, bar)
1197
 
        finally:
1198
 
            bar.finished()
1199
 
 
1200
 
    def _do_check_inventories(self, checker, bar):
1201
 
        """Helper for _check_inventories."""
1202
 
        revno = 0
1203
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1204
 
        kinds = ['chk_bytes', 'texts']
1205
 
        count = len(checker.pending_keys)
1206
 
        bar.update("inventories", 0, 2)
1207
 
        current_keys = checker.pending_keys
1208
 
        checker.pending_keys = {}
1209
 
        # Accumulate current checks.
1210
 
        for key in current_keys:
1211
 
            if key[0] != 'inventories' and key[0] not in kinds:
1212
 
                checker._report_items.append('unknown key type %r' % (key,))
1213
 
            keys[key[0]].add(key[1:])
1214
 
        if keys['inventories']:
1215
 
            # NB: output order *should* be roughly sorted - topo or
1216
 
            # inverse topo depending on repository - either way decent
1217
 
            # to just delta against. However, pre-CHK formats didn't
1218
 
            # try to optimise inventory layout on disk. As such the
1219
 
            # pre-CHK code path does not use inventory deltas.
1220
 
            last_object = None
1221
 
            for record in self.inventories.check(keys=keys['inventories']):
1222
 
                if record.storage_kind == 'absent':
1223
 
                    checker._report_items.append(
1224
 
                        'Missing inventory {%s}' % (record.key,))
1225
 
                else:
1226
 
                    last_object = self._check_record('inventories', record,
1227
 
                        checker, last_object,
1228
 
                        current_keys[('inventories',) + record.key])
1229
 
            del keys['inventories']
1230
 
        else:
1231
 
            return
1232
 
        bar.update("texts", 1)
1233
 
        while (checker.pending_keys or keys['chk_bytes']
1234
 
            or keys['texts']):
1235
 
            # Something to check.
1236
 
            current_keys = checker.pending_keys
1237
 
            checker.pending_keys = {}
1238
 
            # Accumulate current checks.
1239
 
            for key in current_keys:
1240
 
                if key[0] not in kinds:
1241
 
                    checker._report_items.append('unknown key type %r' % (key,))
1242
 
                keys[key[0]].add(key[1:])
1243
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1244
 
            for kind in kinds:
1245
 
                if keys[kind]:
1246
 
                    last_object = None
1247
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1248
 
                        if record.storage_kind == 'absent':
1249
 
                            checker._report_items.append(
1250
 
                                'Missing %s {%s}' % (kind, record.key,))
1251
 
                        else:
1252
 
                            last_object = self._check_record(kind, record,
1253
 
                                checker, last_object, current_keys[(kind,) + record.key])
1254
 
                    keys[kind] = set()
1255
 
                    break
1256
 
 
1257
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1258
 
        """Check a single text from this repository."""
1259
 
        if kind == 'inventories':
1260
 
            rev_id = record.key[0]
1261
 
            inv = self._deserialise_inventory(rev_id,
1262
 
                record.get_bytes_as('fulltext'))
1263
 
            if last_object is not None:
1264
 
                delta = inv._make_delta(last_object)
1265
 
                for old_path, path, file_id, ie in delta:
1266
 
                    if ie is None:
1267
 
                        continue
1268
 
                    ie.check(checker, rev_id, inv)
1269
 
            else:
1270
 
                for path, ie in inv.iter_entries():
1271
 
                    ie.check(checker, rev_id, inv)
1272
 
            if self._format.fast_deltas:
1273
 
                return inv
1274
 
        elif kind == 'chk_bytes':
1275
 
            # No code written to check chk_bytes for this repo format.
1276
 
            checker._report_items.append(
1277
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1278
 
        elif kind == 'texts':
1279
 
            self._check_text(record, checker, item_data)
1280
 
        else:
1281
 
            checker._report_items.append(
1282
 
                'unknown key type %s for %s' % (kind, record.key))
1283
 
 
1284
 
    def _check_text(self, record, checker, item_data):
1285
 
        """Check a single text."""
1286
 
        # Check it is extractable.
1287
 
        # TODO: check length.
1288
 
        if record.storage_kind == 'chunked':
1289
 
            chunks = record.get_bytes_as(record.storage_kind)
1290
 
            sha1 = osutils.sha_strings(chunks)
1291
 
            length = sum(map(len, chunks))
1292
 
        else:
1293
 
            content = record.get_bytes_as('fulltext')
1294
 
            sha1 = osutils.sha_string(content)
1295
 
            length = len(content)
1296
 
        if item_data and sha1 != item_data[1]:
1297
 
            checker._report_items.append(
1298
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1299
 
                (record.key, sha1, item_data[1], item_data[2]))
1300
 
 
1301
798
    @staticmethod
1302
799
    def create(a_bzrdir):
1303
800
        """Construct the current default format repository in a_bzrdir."""
1308
805
 
1309
806
        :param _format: The format of the repository on disk.
1310
807
        :param a_bzrdir: The BzrDir of the repository.
 
808
 
 
809
        In the future we will have a single api for all stores for
 
810
        getting file texts, inventories and revisions, then
 
811
        this construct will accept instances of those things.
1311
812
        """
1312
 
        # In the future we will have a single api for all stores for
1313
 
        # getting file texts, inventories and revisions, then
1314
 
        # this construct will accept instances of those things.
1315
813
        super(Repository, self).__init__()
1316
814
        self._format = _format
1317
815
        # the following are part of the public API for Repository:
1323
821
        self._reconcile_does_inventory_gc = True
1324
822
        self._reconcile_fixes_text_parents = False
1325
823
        self._reconcile_backsup_inventory = True
 
824
        # not right yet - should be more semantically clear ?
 
825
        #
 
826
        # TODO: make sure to construct the right store classes, etc, depending
 
827
        # on whether escaping is required.
 
828
        self._warn_if_deprecated()
1326
829
        self._write_group = None
1327
830
        # Additional places to query for data.
1328
831
        self._fallback_repositories = []
1329
832
        # An InventoryEntry cache, used during deserialization
1330
833
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1331
 
        # Is it safe to return inventory entries directly from the entry cache,
1332
 
        # rather copying them?
1333
 
        self._safe_to_return_from_cache = False
1334
 
 
1335
 
    @property
1336
 
    def user_transport(self):
1337
 
        return self.bzrdir.user_transport
1338
 
 
1339
 
    @property
1340
 
    def control_transport(self):
1341
 
        return self._transport
1342
834
 
1343
835
    def __repr__(self):
1344
 
        if self._fallback_repositories:
1345
 
            return '%s(%r, fallback_repositories=%r)' % (
1346
 
                self.__class__.__name__,
1347
 
                self.base,
1348
 
                self._fallback_repositories)
1349
 
        else:
1350
 
            return '%s(%r)' % (self.__class__.__name__,
1351
 
                               self.base)
1352
 
 
1353
 
    def _has_same_fallbacks(self, other_repo):
1354
 
        """Returns true if the repositories have the same fallbacks."""
1355
 
        my_fb = self._fallback_repositories
1356
 
        other_fb = other_repo._fallback_repositories
1357
 
        if len(my_fb) != len(other_fb):
1358
 
            return False
1359
 
        for f, g in zip(my_fb, other_fb):
1360
 
            if not f.has_same_location(g):
1361
 
                return False
1362
 
        return True
 
836
        return '%s(%r)' % (self.__class__.__name__,
 
837
                           self.base)
1363
838
 
1364
839
    def has_same_location(self, other):
1365
840
        """Returns a boolean indicating if this repository is at the same
1393
868
        data during reads, and allows a 'write_group' to be obtained. Write
1394
869
        groups must be used for actual data insertion.
1395
870
 
1396
 
        A token should be passed in if you know that you have locked the object
1397
 
        some other way, and need to synchronise this object's state with that
1398
 
        fact.
1399
 
 
1400
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1401
 
 
1402
871
        :param token: if this is already locked, then lock_write will fail
1403
872
            unless the token matches the existing lock.
1404
873
        :returns: a token if this instance supports tokens, otherwise None.
1407
876
        :raises MismatchedToken: if the specified token doesn't match the token
1408
877
            of the existing lock.
1409
878
        :seealso: start_write_group.
1410
 
        :return: A RepositoryWriteLockResult.
 
879
 
 
880
        A token should be passed in if you know that you have locked the object
 
881
        some other way, and need to synchronise this object's state with that
 
882
        fact.
 
883
 
 
884
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
885
        """
1412
886
        locked = self.is_locked()
1413
 
        token = self.control_files.lock_write(token=token)
 
887
        result = self.control_files.lock_write(token=token)
 
888
        for repo in self._fallback_repositories:
 
889
            # Writes don't affect fallback repos
 
890
            repo.lock_read()
1414
891
        if not locked:
1415
 
            self._warn_if_deprecated()
1416
 
            self._note_lock('w')
1417
 
            for repo in self._fallback_repositories:
1418
 
                # Writes don't affect fallback repos
1419
 
                repo.lock_read()
1420
892
            self._refresh_data()
1421
 
        return RepositoryWriteLockResult(self.unlock, token)
 
893
        return result
1422
894
 
1423
895
    def lock_read(self):
1424
 
        """Lock the repository for read operations.
1425
 
 
1426
 
        :return: An object with an unlock method which will release the lock
1427
 
            obtained.
1428
 
        """
1429
896
        locked = self.is_locked()
1430
897
        self.control_files.lock_read()
 
898
        for repo in self._fallback_repositories:
 
899
            repo.lock_read()
1431
900
        if not locked:
1432
 
            self._warn_if_deprecated()
1433
 
            self._note_lock('r')
1434
 
            for repo in self._fallback_repositories:
1435
 
                repo.lock_read()
1436
901
            self._refresh_data()
1437
 
        return self
1438
902
 
1439
903
    def get_physical_lock_status(self):
1440
904
        return self.control_files.get_physical_lock_status()
1500
964
 
1501
965
        # now gather global repository information
1502
966
        # XXX: This is available for many repos regardless of listability.
1503
 
        if self.user_transport.listable():
 
967
        if self.bzrdir.root_transport.listable():
1504
968
            # XXX: do we want to __define len__() ?
1505
969
            # Maybe the versionedfiles object should provide a different
1506
970
            # method to get the number of keys.
1516
980
        :param using: If True, list only branches using this repository.
1517
981
        """
1518
982
        if using and not self.is_shared():
1519
 
            return self.bzrdir.list_branches()
 
983
            try:
 
984
                return [self.bzrdir.open_branch()]
 
985
            except errors.NotBranchError:
 
986
                return []
1520
987
        class Evaluator(object):
1521
988
 
1522
989
            def __init__(self):
1531
998
                    except errors.NoRepositoryPresent:
1532
999
                        pass
1533
1000
                    else:
1534
 
                        return False, ([], repository)
 
1001
                        return False, (None, repository)
1535
1002
                self.first_call = False
1536
 
                value = (bzrdir.list_branches(), None)
 
1003
                try:
 
1004
                    value = (bzrdir.open_branch(), None)
 
1005
                except errors.NotBranchError:
 
1006
                    value = (None, None)
1537
1007
                return True, value
1538
1008
 
1539
 
        ret = []
1540
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1541
 
                self.user_transport, evaluate=Evaluator()):
1542
 
            if branches is not None:
1543
 
                ret.extend(branches)
 
1009
        branches = []
 
1010
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1011
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1012
            if branch is not None:
 
1013
                branches.append(branch)
1544
1014
            if not using and repository is not None:
1545
 
                ret.extend(repository.find_branches())
1546
 
        return ret
 
1015
                branches.extend(repository.find_branches())
 
1016
        return branches
1547
1017
 
1548
1018
    @needs_read_lock
1549
1019
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1556
1026
        return InterRepository.get(other, self).search_missing_revision_ids(
1557
1027
            revision_id, find_ghosts)
1558
1028
 
 
1029
    @deprecated_method(one_two)
 
1030
    @needs_read_lock
 
1031
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1032
        """Return the revision ids that other has that this does not.
 
1033
 
 
1034
        These are returned in topological order.
 
1035
 
 
1036
        revision_id: only return revision ids included by revision_id.
 
1037
        """
 
1038
        keys =  self.search_missing_revision_ids(
 
1039
            other, revision_id, find_ghosts).get_keys()
 
1040
        other.lock_read()
 
1041
        try:
 
1042
            parents = other.get_graph().get_parent_map(keys)
 
1043
        finally:
 
1044
            other.unlock()
 
1045
        return tsort.topo_sort(parents)
 
1046
 
1559
1047
    @staticmethod
1560
1048
    def open(base):
1561
1049
        """Open the repository rooted at base.
1578
1066
        """Commit the contents accrued within the current write group.
1579
1067
 
1580
1068
        :seealso: start_write_group.
1581
 
        
1582
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1583
1069
        """
1584
1070
        if self._write_group is not self.get_transaction():
1585
1071
            # has an unlock or relock occured ?
1586
1072
            raise errors.BzrError('mismatched lock context %r and '
1587
1073
                'write group %r.' %
1588
1074
                (self.get_transaction(), self._write_group))
1589
 
        result = self._commit_write_group()
 
1075
        self._commit_write_group()
1590
1076
        self._write_group = None
1591
 
        return result
1592
1077
 
1593
1078
    def _commit_write_group(self):
1594
1079
        """Template method for per-repository write group cleanup.
1602
1087
    def suspend_write_group(self):
1603
1088
        raise errors.UnsuspendableWriteGroup(self)
1604
1089
 
1605
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1606
 
        """Return the keys of missing inventory parents for revisions added in
1607
 
        this write group.
1608
 
 
1609
 
        A revision is not complete if the inventory delta for that revision
1610
 
        cannot be calculated.  Therefore if the parent inventories of a
1611
 
        revision are not present, the revision is incomplete, and e.g. cannot
1612
 
        be streamed by a smart server.  This method finds missing inventory
1613
 
        parents for revisions added in this write group.
1614
 
        """
1615
 
        if not self._format.supports_external_lookups:
1616
 
            # This is only an issue for stacked repositories
1617
 
            return set()
1618
 
        if not self.is_in_write_group():
1619
 
            raise AssertionError('not in a write group')
1620
 
 
1621
 
        # XXX: We assume that every added revision already has its
1622
 
        # corresponding inventory, so we only check for parent inventories that
1623
 
        # might be missing, rather than all inventories.
1624
 
        parents = set(self.revisions._index.get_missing_parents())
1625
 
        parents.discard(_mod_revision.NULL_REVISION)
1626
 
        unstacked_inventories = self.inventories._index
1627
 
        present_inventories = unstacked_inventories.get_parent_map(
1628
 
            key[-1:] for key in parents)
1629
 
        parents.difference_update(present_inventories)
1630
 
        if len(parents) == 0:
1631
 
            # No missing parent inventories.
1632
 
            return set()
1633
 
        if not check_for_missing_texts:
1634
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1635
 
        # Ok, now we have a list of missing inventories.  But these only matter
1636
 
        # if the inventories that reference them are missing some texts they
1637
 
        # appear to introduce.
1638
 
        # XXX: Texts referenced by all added inventories need to be present,
1639
 
        # but at the moment we're only checking for texts referenced by
1640
 
        # inventories at the graph's edge.
1641
 
        key_deps = self.revisions._index._key_dependencies
1642
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1643
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1644
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1645
 
        missing_texts = set()
1646
 
        for file_id, version_ids in file_ids.iteritems():
1647
 
            missing_texts.update(
1648
 
                (file_id, version_id) for version_id in version_ids)
1649
 
        present_texts = self.texts.get_parent_map(missing_texts)
1650
 
        missing_texts.difference_update(present_texts)
1651
 
        if not missing_texts:
1652
 
            # No texts are missing, so all revisions and their deltas are
1653
 
            # reconstructable.
1654
 
            return set()
1655
 
        # Alternatively the text versions could be returned as the missing
1656
 
        # keys, but this is likely to be less data.
1657
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1658
 
        return missing_keys
1659
 
 
1660
1090
    def refresh_data(self):
1661
1091
        """Re-read any data needed to to synchronise with disk.
1662
1092
 
1711
1141
            raise errors.InternalBzrError(
1712
1142
                "May not fetch while in a write group.")
1713
1143
        # fast path same-url fetch operations
1714
 
        # TODO: lift out to somewhere common with RemoteRepository
1715
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1716
 
        if (self.has_same_location(source)
1717
 
            and fetch_spec is None
1718
 
            and self._has_same_fallbacks(source)):
 
1144
        if self.has_same_location(source) and fetch_spec is None:
1719
1145
            # check that last_revision is in 'from' and then return a
1720
1146
            # no-operation.
1721
1147
            if (revision_id is not None and
1746
1172
        :param revprops: Optional dictionary of revision properties.
1747
1173
        :param revision_id: Optional revision id.
1748
1174
        """
1749
 
        if self._fallback_repositories:
1750
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1751
 
                "to a stacked branch. See "
1752
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1753
1175
        result = self._commit_builder_class(self, parents, config,
1754
1176
            timestamp, timezone, committer, revprops, revision_id)
1755
1177
        self.start_write_group()
1756
1178
        return result
1757
1179
 
1758
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1759
1180
    def unlock(self):
1760
1181
        if (self.control_files._lock_count == 1 and
1761
1182
            self.control_files._lock_mode == 'w'):
1767
1188
        self.control_files.unlock()
1768
1189
        if self.control_files._lock_count == 0:
1769
1190
            self._inventory_entry_cache.clear()
1770
 
            for repo in self._fallback_repositories:
1771
 
                repo.unlock()
 
1191
        for repo in self._fallback_repositories:
 
1192
            repo.unlock()
1772
1193
 
1773
1194
    @needs_read_lock
1774
1195
    def clone(self, a_bzrdir, revision_id=None):
1883
1304
 
1884
1305
    @needs_read_lock
1885
1306
    def get_revisions(self, revision_ids):
1886
 
        """Get many revisions at once.
1887
 
        
1888
 
        Repositories that need to check data on every revision read should 
1889
 
        subclass this method.
1890
 
        """
 
1307
        """Get many revisions at once."""
1891
1308
        return self._get_revisions(revision_ids)
1892
1309
 
1893
1310
    @needs_read_lock
1894
1311
    def _get_revisions(self, revision_ids):
1895
1312
        """Core work logic to get many revisions without sanity checks."""
 
1313
        for rev_id in revision_ids:
 
1314
            if not rev_id or not isinstance(rev_id, basestring):
 
1315
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1316
        keys = [(key,) for key in revision_ids]
 
1317
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1896
1318
        revs = {}
1897
 
        for revid, rev in self._iter_revisions(revision_ids):
1898
 
            if rev is None:
1899
 
                raise errors.NoSuchRevision(self, revid)
1900
 
            revs[revid] = rev
 
1319
        for record in stream:
 
1320
            if record.storage_kind == 'absent':
 
1321
                raise errors.NoSuchRevision(self, record.key[0])
 
1322
            text = record.get_bytes_as('fulltext')
 
1323
            rev = self._serializer.read_revision_from_string(text)
 
1324
            revs[record.key[0]] = rev
1901
1325
        return [revs[revid] for revid in revision_ids]
1902
1326
 
1903
 
    def _iter_revisions(self, revision_ids):
1904
 
        """Iterate over revision objects.
1905
 
 
1906
 
        :param revision_ids: An iterable of revisions to examine. None may be
1907
 
            passed to request all revisions known to the repository. Note that
1908
 
            not all repositories can find unreferenced revisions; for those
1909
 
            repositories only referenced ones will be returned.
1910
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1911
 
            those asked for but not available) are returned as (revid, None).
1912
 
        """
1913
 
        if revision_ids is None:
1914
 
            revision_ids = self.all_revision_ids()
1915
 
        else:
1916
 
            for rev_id in revision_ids:
1917
 
                if not rev_id or not isinstance(rev_id, basestring):
1918
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1919
 
        keys = [(key,) for key in revision_ids]
1920
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1921
 
        for record in stream:
1922
 
            revid = record.key[0]
1923
 
            if record.storage_kind == 'absent':
1924
 
                yield (revid, None)
1925
 
            else:
1926
 
                text = record.get_bytes_as('fulltext')
1927
 
                rev = self._serializer.read_revision_from_string(text)
1928
 
                yield (revid, rev)
1929
 
 
1930
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1327
    @needs_read_lock
 
1328
    def get_revision_xml(self, revision_id):
 
1329
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1330
        #       would have already do it.
 
1331
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1332
        rev = self.get_revision(revision_id)
 
1333
        rev_tmp = cStringIO.StringIO()
 
1334
        # the current serializer..
 
1335
        self._serializer.write_revision(rev, rev_tmp)
 
1336
        rev_tmp.seek(0)
 
1337
        return rev_tmp.getvalue()
 
1338
 
 
1339
    def get_deltas_for_revisions(self, revisions):
1931
1340
        """Produce a generator of revision deltas.
1932
1341
 
1933
1342
        Note that the input is a sequence of REVISIONS, not revision_ids.
1934
1343
        Trees will be held in memory until the generator exits.
1935
1344
        Each delta is relative to the revision's lefthand predecessor.
1936
 
 
1937
 
        :param specific_fileids: if not None, the result is filtered
1938
 
          so that only those file-ids, their parents and their
1939
 
          children are included.
1940
1345
        """
1941
 
        # Get the revision-ids of interest
1942
1346
        required_trees = set()
1943
1347
        for revision in revisions:
1944
1348
            required_trees.add(revision.revision_id)
1945
1349
            required_trees.update(revision.parent_ids[:1])
1946
 
 
1947
 
        # Get the matching filtered trees. Note that it's more
1948
 
        # efficient to pass filtered trees to changes_from() rather
1949
 
        # than doing the filtering afterwards. changes_from() could
1950
 
        # arguably do the filtering itself but it's path-based, not
1951
 
        # file-id based, so filtering before or afterwards is
1952
 
        # currently easier.
1953
 
        if specific_fileids is None:
1954
 
            trees = dict((t.get_revision_id(), t) for
1955
 
                t in self.revision_trees(required_trees))
1956
 
        else:
1957
 
            trees = dict((t.get_revision_id(), t) for
1958
 
                t in self._filtered_revision_trees(required_trees,
1959
 
                specific_fileids))
1960
 
 
1961
 
        # Calculate the deltas
 
1350
        trees = dict((t.get_revision_id(), t) for
 
1351
                     t in self.revision_trees(required_trees))
1962
1352
        for revision in revisions:
1963
1353
            if not revision.parent_ids:
1964
1354
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1967
1357
            yield trees[revision.revision_id].changes_from(old_tree)
1968
1358
 
1969
1359
    @needs_read_lock
1970
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1360
    def get_revision_delta(self, revision_id):
1971
1361
        """Return the delta for one revision.
1972
1362
 
1973
1363
        The delta is relative to the left-hand predecessor of the
1974
1364
        revision.
1975
 
 
1976
 
        :param specific_fileids: if not None, the result is filtered
1977
 
          so that only those file-ids, their parents and their
1978
 
          children are included.
1979
1365
        """
1980
1366
        r = self.get_revision(revision_id)
1981
 
        return list(self.get_deltas_for_revisions([r],
1982
 
            specific_fileids=specific_fileids))[0]
 
1367
        return list(self.get_deltas_for_revisions([r]))[0]
1983
1368
 
1984
1369
    @needs_write_lock
1985
1370
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2109
1494
                    yield line, revid
2110
1495
 
2111
1496
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2112
 
        revision_keys):
 
1497
        revision_ids):
2113
1498
        """Helper routine for fileids_altered_by_revision_ids.
2114
1499
 
2115
1500
        This performs the translation of xml lines to revision ids.
2116
1501
 
2117
1502
        :param line_iterator: An iterator of lines, origin_version_id
2118
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1503
        :param revision_ids: The revision ids to filter for. This should be a
2119
1504
            set or other type which supports efficient __contains__ lookups, as
2120
 
            the revision key from each parsed line will be looked up in the
2121
 
            revision_keys filter.
 
1505
            the revision id from each parsed line will be looked up in the
 
1506
            revision_ids filter.
2122
1507
        :return: a dictionary mapping altered file-ids to an iterable of
2123
1508
        revision_ids. Each altered file-ids has the exact revision_ids that
2124
1509
        altered it listed explicitly.
2125
1510
        """
2126
1511
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2127
1512
                line_iterator).iterkeys())
2128
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1513
        # Note that revision_ids are revision keys.
 
1514
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1515
        parents = set()
 
1516
        map(parents.update, parent_maps.itervalues())
 
1517
        parents.difference_update(revision_ids)
2129
1518
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2130
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1519
            self._inventory_xml_lines_for_keys(parents)))
2131
1520
        new_keys = seen - parent_seen
2132
1521
        result = {}
2133
1522
        setdefault = result.setdefault
2135
1524
            setdefault(key[0], set()).add(key[-1])
2136
1525
        return result
2137
1526
 
2138
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2139
 
        """Find all parent ids that are mentioned in the revision graph.
2140
 
 
2141
 
        :return: set of revisions that are parents of revision_ids which are
2142
 
            not part of revision_ids themselves
2143
 
        """
2144
 
        parent_map = self.get_parent_map(revision_ids)
2145
 
        parent_ids = set()
2146
 
        map(parent_ids.update, parent_map.itervalues())
2147
 
        parent_ids.difference_update(revision_ids)
2148
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2149
 
        return parent_ids
2150
 
 
2151
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2152
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2153
 
 
2154
 
        :param revision_keys: An iterable of revision_keys.
2155
 
        :return: The parents of all revision_keys that are not already in
2156
 
            revision_keys
2157
 
        """
2158
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2159
 
        parent_keys = set()
2160
 
        map(parent_keys.update, parent_map.itervalues())
2161
 
        parent_keys.difference_update(revision_keys)
2162
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2163
 
        return parent_keys
2164
 
 
2165
1527
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2166
1528
        """Find the file ids and versions affected by revisions.
2167
1529
 
2174
1536
        """
2175
1537
        selected_keys = set((revid,) for revid in revision_ids)
2176
1538
        w = _inv_weave or self.inventories
2177
 
        return self._find_file_ids_from_xml_inventory_lines(
2178
 
            w.iter_lines_added_or_present_in_keys(
2179
 
                selected_keys, pb=None),
2180
 
            selected_keys)
 
1539
        pb = ui.ui_factory.nested_progress_bar()
 
1540
        try:
 
1541
            return self._find_file_ids_from_xml_inventory_lines(
 
1542
                w.iter_lines_added_or_present_in_keys(
 
1543
                    selected_keys, pb=pb),
 
1544
                selected_keys)
 
1545
        finally:
 
1546
            pb.finished()
2181
1547
 
2182
1548
    def iter_files_bytes(self, desired_files):
2183
1549
        """Iterate through file versions.
2204
1570
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2205
1571
            if record.storage_kind == 'absent':
2206
1572
                raise errors.RevisionNotPresent(record.key, self)
2207
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1573
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2208
1574
 
2209
1575
    def _generate_text_key_index(self, text_key_references=None,
2210
1576
        ancestors=None):
2265
1631
                batch_size]
2266
1632
            if not to_query:
2267
1633
                break
2268
 
            for revision_id in to_query:
 
1634
            for rev_tree in self.revision_trees(to_query):
 
1635
                revision_id = rev_tree.get_revision_id()
2269
1636
                parent_ids = ancestors[revision_id]
2270
1637
                for text_key in revision_keys[revision_id]:
2271
1638
                    pb.update("Calculating text parents", processed_texts)
2290
1657
                            except KeyError:
2291
1658
                                inv = self.revision_tree(parent_id).inventory
2292
1659
                                inventory_cache[parent_id] = inv
2293
 
                            try:
2294
 
                                parent_entry = inv[text_key[0]]
2295
 
                            except (KeyError, errors.NoSuchId):
2296
 
                                parent_entry = None
 
1660
                            parent_entry = inv._byid.get(text_key[0], None)
2297
1661
                            if parent_entry is not None:
2298
1662
                                parent_text_key = (
2299
1663
                                    text_key[0], parent_entry.revision)
2324
1688
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2325
1689
            'revisions'.  file-id is None unless knit-kind is 'file'.
2326
1690
        """
2327
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2328
 
            yield result
2329
 
        del _files_pb
2330
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2331
 
            yield result
2332
 
 
2333
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2334
1691
        # XXX: it's a bit weird to control the inventory weave caching in this
2335
1692
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2336
1693
        # maybe this generator should explicitly have the contract that it
2343
1700
        count = 0
2344
1701
        num_file_ids = len(file_ids)
2345
1702
        for file_id, altered_versions in file_ids.iteritems():
2346
 
            if pb is not None:
2347
 
                pb.update("Fetch texts", count, num_file_ids)
 
1703
            if _files_pb is not None:
 
1704
                _files_pb.update("fetch texts", count, num_file_ids)
2348
1705
            count += 1
2349
1706
            yield ("file", file_id, altered_versions)
 
1707
        # We're done with the files_pb.  Note that it finished by the caller,
 
1708
        # just as it was created by the caller.
 
1709
        del _files_pb
2350
1710
 
2351
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2352
1711
        # inventory
2353
1712
        yield ("inventory", None, revision_ids)
2354
1713
 
2371
1730
        """Get Inventory object by revision id."""
2372
1731
        return self.iter_inventories([revision_id]).next()
2373
1732
 
2374
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1733
    def iter_inventories(self, revision_ids):
2375
1734
        """Get many inventories by revision_ids.
2376
1735
 
2377
1736
        This will buffer some or all of the texts used in constructing the
2378
1737
        inventories in memory, but will only parse a single inventory at a
2379
1738
        time.
2380
1739
 
2381
 
        :param revision_ids: The expected revision ids of the inventories.
2382
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2383
 
            specified, the order of revision_ids will be preserved (by
2384
 
            buffering if necessary).
2385
1740
        :return: An iterator of inventories.
2386
1741
        """
2387
1742
        if ((None in revision_ids)
2388
1743
            or (_mod_revision.NULL_REVISION in revision_ids)):
2389
1744
            raise ValueError('cannot get null revision inventory')
2390
 
        return self._iter_inventories(revision_ids, ordering)
 
1745
        return self._iter_inventories(revision_ids)
2391
1746
 
2392
 
    def _iter_inventories(self, revision_ids, ordering):
 
1747
    def _iter_inventories(self, revision_ids):
2393
1748
        """single-document based inventory iteration."""
2394
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2395
 
        for text, revision_id in inv_xmls:
2396
 
            yield self._deserialise_inventory(revision_id, text)
 
1749
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1750
            yield self.deserialise_inventory(revision_id, text)
2397
1751
 
2398
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2399
 
        if ordering is None:
2400
 
            order_as_requested = True
2401
 
            ordering = 'unordered'
2402
 
        else:
2403
 
            order_as_requested = False
 
1752
    def _iter_inventory_xmls(self, revision_ids):
2404
1753
        keys = [(revision_id,) for revision_id in revision_ids]
2405
 
        if not keys:
2406
 
            return
2407
 
        if order_as_requested:
2408
 
            key_iter = iter(keys)
2409
 
            next_key = key_iter.next()
2410
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
1754
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2411
1755
        text_chunks = {}
2412
1756
        for record in stream:
2413
1757
            if record.storage_kind != 'absent':
2414
 
                chunks = record.get_bytes_as('chunked')
2415
 
                if order_as_requested:
2416
 
                    text_chunks[record.key] = chunks
2417
 
                else:
2418
 
                    yield ''.join(chunks), record.key[-1]
 
1758
                text_chunks[record.key] = record.get_bytes_as('chunked')
2419
1759
            else:
2420
1760
                raise errors.NoSuchRevision(self, record.key)
2421
 
            if order_as_requested:
2422
 
                # Yield as many results as we can while preserving order.
2423
 
                while next_key in text_chunks:
2424
 
                    chunks = text_chunks.pop(next_key)
2425
 
                    yield ''.join(chunks), next_key[-1]
2426
 
                    try:
2427
 
                        next_key = key_iter.next()
2428
 
                    except StopIteration:
2429
 
                        # We still want to fully consume the get_record_stream,
2430
 
                        # just in case it is not actually finished at this point
2431
 
                        next_key = None
2432
 
                        break
 
1761
        for key in keys:
 
1762
            chunks = text_chunks.pop(key)
 
1763
            yield ''.join(chunks), key[-1]
2433
1764
 
2434
 
    def _deserialise_inventory(self, revision_id, xml):
 
1765
    def deserialise_inventory(self, revision_id, xml):
2435
1766
        """Transform the xml into an inventory object.
2436
1767
 
2437
1768
        :param revision_id: The expected revision id of the inventory.
2438
1769
        :param xml: A serialised inventory.
2439
1770
        """
2440
1771
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2441
 
                    entry_cache=self._inventory_entry_cache,
2442
 
                    return_from_cache=self._safe_to_return_from_cache)
 
1772
                    entry_cache=self._inventory_entry_cache)
2443
1773
        if result.revision_id != revision_id:
2444
1774
            raise AssertionError('revision id mismatch %s != %s' % (
2445
1775
                result.revision_id, revision_id))
2446
1776
        return result
2447
1777
 
 
1778
    def serialise_inventory(self, inv):
 
1779
        return self._serializer.write_inventory_to_string(inv)
 
1780
 
 
1781
    def _serialise_inventory_to_lines(self, inv):
 
1782
        return self._serializer.write_inventory_to_lines(inv)
 
1783
 
2448
1784
    def get_serializer_format(self):
2449
1785
        return self._serializer.format_num
2450
1786
 
2451
1787
    @needs_read_lock
2452
 
    def _get_inventory_xml(self, revision_id):
2453
 
        """Get serialized inventory as a string."""
2454
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1788
    def get_inventory_xml(self, revision_id):
 
1789
        """Get inventory XML as a file object."""
 
1790
        texts = self._iter_inventory_xmls([revision_id])
2455
1791
        try:
2456
1792
            text, revision_id = texts.next()
2457
1793
        except StopIteration:
2458
1794
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2459
1795
        return text
2460
1796
 
2461
 
    def get_rev_id_for_revno(self, revno, known_pair):
2462
 
        """Return the revision id of a revno, given a later (revno, revid)
2463
 
        pair in the same history.
2464
 
 
2465
 
        :return: if found (True, revid).  If the available history ran out
2466
 
            before reaching the revno, then this returns
2467
 
            (False, (closest_revno, closest_revid)).
 
1797
    @needs_read_lock
 
1798
    def get_inventory_sha1(self, revision_id):
 
1799
        """Return the sha1 hash of the inventory entry
2468
1800
        """
2469
 
        known_revno, known_revid = known_pair
2470
 
        partial_history = [known_revid]
2471
 
        distance_from_known = known_revno - revno
2472
 
        if distance_from_known < 0:
2473
 
            raise ValueError(
2474
 
                'requested revno (%d) is later than given known revno (%d)'
2475
 
                % (revno, known_revno))
2476
 
        try:
2477
 
            _iter_for_revno(
2478
 
                self, partial_history, stop_index=distance_from_known)
2479
 
        except errors.RevisionNotPresent, err:
2480
 
            if err.revision_id == known_revid:
2481
 
                # The start revision (known_revid) wasn't found.
2482
 
                raise
2483
 
            # This is a stacked repository with no fallbacks, or a there's a
2484
 
            # left-hand ghost.  Either way, even though the revision named in
2485
 
            # the error isn't in this repo, we know it's the next step in this
2486
 
            # left-hand history.
2487
 
            partial_history.append(err.revision_id)
2488
 
        if len(partial_history) <= distance_from_known:
2489
 
            # Didn't find enough history to get a revid for the revno.
2490
 
            earliest_revno = known_revno - len(partial_history) + 1
2491
 
            return (False, (earliest_revno, partial_history[-1]))
2492
 
        if len(partial_history) - 1 > distance_from_known:
2493
 
            raise AssertionError('_iter_for_revno returned too much history')
2494
 
        return (True, partial_history[-1])
 
1801
        return self.get_revision(revision_id).inventory_sha1
2495
1802
 
2496
1803
    def iter_reverse_revision_history(self, revision_id):
2497
1804
        """Iterate backwards through revision ids in the lefthand history
2504
1811
        while True:
2505
1812
            if next_id in (None, _mod_revision.NULL_REVISION):
2506
1813
                return
2507
 
            try:
2508
 
                parents = graph.get_parent_map([next_id])[next_id]
2509
 
            except KeyError:
2510
 
                raise errors.RevisionNotPresent(next_id, self)
2511
1814
            yield next_id
 
1815
            # Note: The following line may raise KeyError in the event of
 
1816
            # truncated history. We decided not to have a try:except:raise
 
1817
            # RevisionNotPresent here until we see a use for it, because of the
 
1818
            # cost in an inner loop that is by its very nature O(history).
 
1819
            # Robert Collins 20080326
 
1820
            parents = graph.get_parent_map([next_id])[next_id]
2512
1821
            if len(parents) == 0:
2513
1822
                return
2514
1823
            else:
2515
1824
                next_id = parents[0]
2516
1825
 
 
1826
    @needs_read_lock
 
1827
    def get_revision_inventory(self, revision_id):
 
1828
        """Return inventory of a past revision."""
 
1829
        # TODO: Unify this with get_inventory()
 
1830
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1831
        # must be the same as its revision, so this is trivial.
 
1832
        if revision_id is None:
 
1833
            # This does not make sense: if there is no revision,
 
1834
            # then it is the current tree inventory surely ?!
 
1835
            # and thus get_root_id() is something that looks at the last
 
1836
            # commit on the branch, and the get_root_id is an inventory check.
 
1837
            raise NotImplementedError
 
1838
            # return Inventory(self.get_root_id())
 
1839
        else:
 
1840
            return self.get_inventory(revision_id)
 
1841
 
2517
1842
    def is_shared(self):
2518
1843
        """Return True if this repository is flagged as a shared repository."""
2519
1844
        raise NotImplementedError(self.is_shared)
2553
1878
            return RevisionTree(self, Inventory(root_id=None),
2554
1879
                                _mod_revision.NULL_REVISION)
2555
1880
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
1881
            inv = self.get_revision_inventory(revision_id)
2557
1882
            return RevisionTree(self, inv, revision_id)
2558
1883
 
2559
1884
    def revision_trees(self, revision_ids):
2560
 
        """Return Trees for revisions in this repository.
 
1885
        """Return Tree for a revision on this branch.
2561
1886
 
2562
 
        :param revision_ids: a sequence of revision-ids;
2563
 
          a revision-id may not be None or 'null:'
2564
 
        """
 
1887
        `revision_id` may not be None or 'null:'"""
2565
1888
        inventories = self.iter_inventories(revision_ids)
2566
1889
        for inv in inventories:
2567
1890
            yield RevisionTree(self, inv, inv.revision_id)
2568
1891
 
2569
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2570
 
        """Return Tree for a revision on this branch with only some files.
2571
 
 
2572
 
        :param revision_ids: a sequence of revision-ids;
2573
 
          a revision-id may not be None or 'null:'
2574
 
        :param file_ids: if not None, the result is filtered
2575
 
          so that only those file-ids, their parents and their
2576
 
          children are included.
2577
 
        """
2578
 
        inventories = self.iter_inventories(revision_ids)
2579
 
        for inv in inventories:
2580
 
            # Should we introduce a FilteredRevisionTree class rather
2581
 
            # than pre-filter the inventory here?
2582
 
            filtered_inv = inv.filter(file_ids)
2583
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2584
 
 
2585
1892
    @needs_read_lock
2586
1893
    def get_ancestry(self, revision_id, topo_sorted=True):
2587
1894
        """Return a list of revision-ids integrated by a revision.
2612
1919
            keys = tsort.topo_sort(parent_map)
2613
1920
        return [None] + list(keys)
2614
1921
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1922
    def pack(self):
2616
1923
        """Compress the data within the repository.
2617
1924
 
2618
1925
        This operation only makes sense for some repository types. For other
2621
1928
        This stub method does not require a lock, but subclasses should use
2622
1929
        @needs_write_lock as this is a long running call its reasonable to
2623
1930
        implicitly lock for the user.
2624
 
 
2625
 
        :param hint: If not supplied, the whole repository is packed.
2626
 
            If supplied, the repository may use the hint parameter as a
2627
 
            hint for the parts of the repository to pack. A hint can be
2628
 
            obtained from the result of commit_write_group(). Out of
2629
 
            date hints are simply ignored, because concurrent operations
2630
 
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
 
        """
 
1931
        """
 
1932
 
 
1933
    @needs_read_lock
 
1934
    @deprecated_method(one_six)
 
1935
    def print_file(self, file, revision_id):
 
1936
        """Print `file` to stdout.
 
1937
 
 
1938
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1939
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1940
        by creating a new more flexible convenience function.
 
1941
        """
 
1942
        tree = self.revision_tree(revision_id)
 
1943
        # use inventory as it was in that revision
 
1944
        file_id = tree.inventory.path2id(file)
 
1945
        if not file_id:
 
1946
            # TODO: jam 20060427 Write a test for this code path
 
1947
            #       it had a bug in it, and was raising the wrong
 
1948
            #       exception.
 
1949
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1950
        tree.print_file(file_id)
2635
1951
 
2636
1952
    def get_transaction(self):
2637
1953
        return self.control_files.get_transaction()
2638
1954
 
 
1955
    @deprecated_method(one_one)
 
1956
    def get_parents(self, revision_ids):
 
1957
        """See StackedParentsProvider.get_parents"""
 
1958
        parent_map = self.get_parent_map(revision_ids)
 
1959
        return [parent_map.get(r, None) for r in revision_ids]
 
1960
 
2639
1961
    def get_parent_map(self, revision_ids):
2640
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1962
        """See graph._StackedParentsProvider.get_parent_map"""
2641
1963
        # revisions index works in keys; this just works in revisions
2642
1964
        # therefore wrap and unwrap
2643
1965
        query_keys = []
2652
1974
        for ((revision_id,), parent_keys) in \
2653
1975
                self.revisions.get_parent_map(query_keys).iteritems():
2654
1976
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
1977
                result[revision_id] = tuple(parent_revid
 
1978
                    for (parent_revid,) in parent_keys)
2657
1979
            else:
2658
1980
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
1981
        return result
2661
1983
    def _make_parents_provider(self):
2662
1984
        return self
2663
1985
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
1986
    def get_graph(self, other_repository=None):
2674
1987
        """Return the graph walker for this repository format"""
2675
1988
        parents_provider = self._make_parents_provider()
2676
1989
        if (other_repository is not None and
2677
1990
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
1991
            parents_provider = graph._StackedParentsProvider(
2679
1992
                [parents_provider, other_repository._make_parents_provider()])
2680
1993
        return graph.Graph(parents_provider)
2681
1994
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
1995
    def _get_versioned_file_checker(self, text_key_references=None):
2684
1996
        """Return an object suitable for checking versioned files.
2685
1997
        
2686
1998
        :param text_key_references: if non-None, an already built
2688
2000
            to whether they were referred to by the inventory of the
2689
2001
            revision_id that they contain. If None, this will be
2690
2002
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2003
        """
2695
2004
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2005
            text_key_references=text_key_references)
2697
2006
 
2698
2007
    def revision_ids_to_search_result(self, result_set):
2699
2008
        """Convert a set of revision ids to a graph SearchResult."""
2749
2058
        return record.get_bytes_as('fulltext')
2750
2059
 
2751
2060
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2061
    def check(self, revision_ids=None):
2753
2062
        """Check consistency of all history of given revision_ids.
2754
2063
 
2755
2064
        Different repository implementations should override _check().
2756
2065
 
2757
2066
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2067
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
2068
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2069
        return self._check(revision_ids)
2767
2070
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2071
    def _check(self, revision_ids):
 
2072
        result = check.Check(self)
 
2073
        result.check()
2771
2074
        return result
2772
2075
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2076
    def _warn_if_deprecated(self):
2774
2077
        global _deprecation_warning_done
2775
2078
        if _deprecation_warning_done:
2776
2079
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2080
        _deprecation_warning_done = True
 
2081
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2082
                % (self._format, self.bzrdir.transport.base))
2789
2083
 
2790
2084
    def supports_rich_root(self):
2791
2085
        return self._format.rich_root_data
2865
2159
    """
2866
2160
    repository.start_write_group()
2867
2161
    try:
2868
 
        inventory_cache = lru_cache.LRUCache(10)
2869
2162
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2870
 
            _install_revision(repository, revision, revision_tree, signature,
2871
 
                inventory_cache)
 
2163
            _install_revision(repository, revision, revision_tree, signature)
2872
2164
            if pb is not None:
2873
2165
                pb.update('Transferring revisions', n + 1, num_revisions)
2874
2166
    except:
2878
2170
        repository.commit_write_group()
2879
2171
 
2880
2172
 
2881
 
def _install_revision(repository, rev, revision_tree, signature,
2882
 
    inventory_cache):
 
2173
def _install_revision(repository, rev, revision_tree, signature):
2883
2174
    """Install all revision data into a repository."""
2884
2175
    present_parents = []
2885
2176
    parent_trees = {}
2922
2213
        repository.texts.add_lines(text_key, text_parents, lines)
2923
2214
    try:
2924
2215
        # install the inventory
2925
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2926
 
            # Cache this inventory
2927
 
            inventory_cache[rev.revision_id] = inv
2928
 
            try:
2929
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2930
 
            except KeyError:
2931
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2932
 
            else:
2933
 
                delta = inv._make_delta(basis_inv)
2934
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2935
 
                    rev.revision_id, present_parents)
2936
 
        else:
2937
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2216
        repository.add_inventory(rev.revision_id, inv, present_parents)
2938
2217
    except errors.RevisionAlreadyPresent:
2939
2218
        pass
2940
2219
    if signature is not None:
3031
2310
 
3032
2311
    Once a format is deprecated, just deprecate the initialize and open
3033
2312
    methods on the format class. Do not deprecate the object, as the
3034
 
    object may be created even when a repository instance hasn't been
 
2313
    object may be created even when a repository instnace hasn't been
3035
2314
    created.
3036
2315
 
3037
2316
    Common instance attributes:
3047
2326
    # Can this repository be given external locations to lookup additional
3048
2327
    # data. Set to True or False in derived classes.
3049
2328
    supports_external_lookups = None
3050
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3051
 
    # derived classes.
3052
 
    supports_chks = None
3053
 
    # Should commit add an inventory, or an inventory delta to the repository.
3054
 
    _commit_inv_deltas = True
3055
2329
    # What order should fetch operations request streams in?
3056
2330
    # The default is unordered as that is the cheapest for an origin to
3057
2331
    # provide.
3064
2338
    # Should fetch trigger a reconcile after the fetch? Only needed for
3065
2339
    # some repository formats that can suffer internal inconsistencies.
3066
2340
    _fetch_reconcile = False
3067
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
 
    # code path for commit, amongst other things.
3069
 
    fast_deltas = None
3070
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3071
 
    # (so if there is one pack, the operation can still proceed because it may
3072
 
    # help), and for fetching when data won't have come from the same
3073
 
    # compressor.
3074
 
    pack_compresses = False
3075
 
    # Does the repository inventory storage understand references to trees?
3076
 
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
2341
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2342
    def __str__(self):
 
2343
        return "<%s>" % self.__class__.__name__
3082
2344
 
3083
2345
    def __eq__(self, other):
3084
2346
        # format objects are generally stateless
3097
2359
        """
3098
2360
        try:
3099
2361
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2362
            format_string = transport.get("format").read()
3101
2363
            return format_registry.get(format_string)
3102
2364
        except errors.NoSuchFile:
3103
2365
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2447
        raise NotImplementedError(self.network_name)
3186
2448
 
3187
2449
    def check_conversion_target(self, target_format):
3188
 
        if self.rich_root_data and not target_format.rich_root_data:
3189
 
            raise errors.BadConversionTarget(
3190
 
                'Does not support rich root data.', target_format,
3191
 
                from_format=self)
3192
 
        if (self.supports_tree_reference and 
3193
 
            not getattr(target_format, 'supports_tree_reference', False)):
3194
 
            raise errors.BadConversionTarget(
3195
 
                'Does not support nested trees', target_format,
3196
 
                from_format=self)
 
2450
        raise NotImplementedError(self.check_conversion_target)
3197
2451
 
3198
2452
    def open(self, a_bzrdir, _found=False):
3199
2453
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2456
        """
3203
2457
        raise NotImplementedError(self.open)
3204
2458
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
2459
 
3215
2460
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2461
    """Common base class for the new repositories using the metadir layout."""
3264
2509
# Pre-0.8 formats that don't have a disk format string (because they are
3265
2510
# versioned by the matching control directory). We use the control directories
3266
2511
# disk format string as a key for the network_name because they meet the
3267
 
# constraints (simple string, unique, immutable).
 
2512
# constraints (simple string, unique, immmutable).
3268
2513
network_format_registry.register_lazy(
3269
2514
    "Bazaar-NG branch, format 5\n",
3270
2515
    'bzrlib.repofmt.weaverepo',
3351
2596
    )
3352
2597
 
3353
2598
# Development formats.
3354
 
# Obsolete but kept pending a CHK based subtree format.
 
2599
# 1.7->1.8 go below here
 
2600
format_registry.register_lazy(
 
2601
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2602
    'bzrlib.repofmt.pack_repo',
 
2603
    'RepositoryFormatPackDevelopment2',
 
2604
    )
3355
2605
format_registry.register_lazy(
3356
2606
    ("Bazaar development format 2 with subtree support "
3357
2607
        "(needs bzr.dev from before 1.8)\n"),
3359
2609
    'RepositoryFormatPackDevelopment2Subtree',
3360
2610
    )
3361
2611
 
3362
 
# 1.14->1.16 go below here
3363
 
format_registry.register_lazy(
3364
 
    'Bazaar development format - group compression and chk inventory'
3365
 
        ' (needs bzr.dev from 1.14)\n',
3366
 
    'bzrlib.repofmt.groupcompress_repo',
3367
 
    'RepositoryFormatCHK1',
3368
 
    )
3369
 
 
3370
 
format_registry.register_lazy(
3371
 
    'Bazaar development format - chk repository with bencode revision '
3372
 
        'serialization (needs bzr.dev from 1.16)\n',
3373
 
    'bzrlib.repofmt.groupcompress_repo',
3374
 
    'RepositoryFormatCHK2',
3375
 
    )
3376
 
format_registry.register_lazy(
3377
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3378
 
    'bzrlib.repofmt.groupcompress_repo',
3379
 
    'RepositoryFormat2a',
3380
 
    )
3381
 
 
3382
2612
 
3383
2613
class InterRepository(InterObject):
3384
2614
    """This class represents operations taking place between two repositories.
3421
2651
 
3422
2652
        :param revision_id: if None all content is copied, if NULL_REVISION no
3423
2653
                            content is copied.
3424
 
        :param pb: ignored.
 
2654
        :param pb: optional progress bar to use for progress reports. If not
 
2655
                   provided a default one will be created.
3425
2656
        :return: None.
3426
2657
        """
3427
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3428
2658
        from bzrlib.fetch import RepoFetcher
3429
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3430
 
        if self.source._format.network_name() != self.target._format.network_name():
3431
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3432
 
                from_format=self.source._format,
3433
 
                to_format=self.target._format)
3434
2659
        f = RepoFetcher(to_repository=self.target,
3435
2660
                               from_repository=self.source,
3436
2661
                               last_revision=revision_id,
3437
2662
                               fetch_spec=fetch_spec,
3438
 
                               find_ghosts=find_ghosts)
 
2663
                               pb=pb, find_ghosts=find_ghosts)
3439
2664
 
3440
2665
    def _walk_to_common_revisions(self, revision_ids):
3441
2666
        """Walk out from revision_ids in source to revisions target has.
3445
2670
        """
3446
2671
        target_graph = self.target.get_graph()
3447
2672
        revision_ids = frozenset(revision_ids)
 
2673
        # Fast path for the case where all the revisions are already in the
 
2674
        # target repo.
 
2675
        # (Although this does incur an extra round trip for the
 
2676
        # fairly common case where the target doesn't already have the revision
 
2677
        # we're pushing.)
 
2678
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2679
            return graph.SearchResult(revision_ids, set(), 0, set())
3448
2680
        missing_revs = set()
3449
2681
        source_graph = self.source.get_graph()
3450
2682
        # ensure we don't pay silly lookup costs.
3489
2721
                break
3490
2722
        return searcher.get_result()
3491
2723
 
 
2724
    @deprecated_method(one_two)
 
2725
    @needs_read_lock
 
2726
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2727
        """Return the revision ids that source has that target does not.
 
2728
 
 
2729
        These are returned in topological order.
 
2730
 
 
2731
        :param revision_id: only return revision ids included by this
 
2732
                            revision_id.
 
2733
        :param find_ghosts: If True find missing revisions in deep history
 
2734
            rather than just finding the surface difference.
 
2735
        """
 
2736
        return list(self.search_missing_revision_ids(
 
2737
            revision_id, find_ghosts).get_keys())
 
2738
 
3492
2739
    @needs_read_lock
3493
2740
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3494
2741
        """Return the revision ids that source has that target does not.
3610
2857
                self.target.texts.insert_record_stream(
3611
2858
                    self.source.texts.get_record_stream(
3612
2859
                        self.source.texts.keys(), 'topological', False))
3613
 
                pb.update('Copying inventory', 0, 1)
 
2860
                pb.update('copying inventory', 0, 1)
3614
2861
                self.target.inventories.insert_record_stream(
3615
2862
                    self.source.inventories.get_record_stream(
3616
2863
                        self.source.inventories.keys(), 'topological', False))
3637
2884
        # so the first thing is to get a subset of the revisions to
3638
2885
        # satisfy revision_id in source, and then eliminate those that
3639
2886
        # we do already have.
3640
 
        # this is slow on high latency connection to self, but as this
 
2887
        # this is slow on high latency connection to self, but as as this
3641
2888
        # disk format scales terribly for push anyway due to rewriting
3642
2889
        # inventory.weave, this is considered acceptable.
3643
2890
        # - RBC 20060209
3730
2977
        return self.source.revision_ids_to_search_result(result_set)
3731
2978
 
3732
2979
 
3733
 
class InterDifferingSerializer(InterRepository):
 
2980
class InterPackRepo(InterSameDataRepository):
 
2981
    """Optimised code paths between Pack based repositories."""
 
2982
 
 
2983
    @classmethod
 
2984
    def _get_repo_format_to_test(self):
 
2985
        from bzrlib.repofmt import pack_repo
 
2986
        return pack_repo.RepositoryFormatKnitPack1()
 
2987
 
 
2988
    @staticmethod
 
2989
    def is_compatible(source, target):
 
2990
        """Be compatible with known Pack formats.
 
2991
 
 
2992
        We don't test for the stores being of specific types because that
 
2993
        could lead to confusing results, and there is no need to be
 
2994
        overly general.
 
2995
        """
 
2996
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2997
        try:
 
2998
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2999
                isinstance(target._format, RepositoryFormatPack))
 
3000
        except AttributeError:
 
3001
            return False
 
3002
        return are_packs and InterRepository._same_model(source, target)
 
3003
 
 
3004
    @needs_write_lock
 
3005
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3006
            fetch_spec=None):
 
3007
        """See InterRepository.fetch()."""
 
3008
        if (len(self.source._fallback_repositories) > 0 or
 
3009
            len(self.target._fallback_repositories) > 0):
 
3010
            # The pack layer is not aware of fallback repositories, so when
 
3011
            # fetching from a stacked repository or into a stacked repository
 
3012
            # we use the generic fetch logic which uses the VersionedFiles
 
3013
            # attributes on repository.
 
3014
            from bzrlib.fetch import RepoFetcher
 
3015
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3016
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3017
        if fetch_spec is not None:
 
3018
            if len(list(fetch_spec.heads)) != 1:
 
3019
                raise AssertionError(
 
3020
                    "InterPackRepo.fetch doesn't support "
 
3021
                    "fetching multiple heads yet.")
 
3022
            revision_id = list(fetch_spec.heads)[0]
 
3023
            fetch_spec = None
 
3024
        if revision_id is None:
 
3025
            # TODO:
 
3026
            # everything to do - use pack logic
 
3027
            # to fetch from all packs to one without
 
3028
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3029
            # till then:
 
3030
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3031
            revision_ids = source_revision_ids - \
 
3032
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3033
            revision_keys = [(revid,) for revid in revision_ids]
 
3034
            index = self.target._pack_collection.revision_index.combined_index
 
3035
            present_revision_ids = set(item[1][0] for item in
 
3036
                index.iter_entries(revision_keys))
 
3037
            revision_ids = set(revision_ids) - present_revision_ids
 
3038
            # implementing the TODO will involve:
 
3039
            # - detecting when all of a pack is selected
 
3040
            # - avoiding as much as possible pre-selection, so the
 
3041
            # more-core routines such as create_pack_from_packs can filter in
 
3042
            # a just-in-time fashion. (though having a HEADS list on a
 
3043
            # repository might make this a lot easier, because we could
 
3044
            # sensibly detect 'new revisions' without doing a full index scan.
 
3045
        elif _mod_revision.is_null(revision_id):
 
3046
            # nothing to do:
 
3047
            return (0, [])
 
3048
        else:
 
3049
            try:
 
3050
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3051
                    find_ghosts=find_ghosts).get_keys()
 
3052
            except errors.NoSuchRevision:
 
3053
                raise errors.InstallFailed([revision_id])
 
3054
            if len(revision_ids) == 0:
 
3055
                return (0, [])
 
3056
        return self._pack(self.source, self.target, revision_ids)
 
3057
 
 
3058
    def _pack(self, source, target, revision_ids):
 
3059
        from bzrlib.repofmt.pack_repo import Packer
 
3060
        packs = source._pack_collection.all_packs()
 
3061
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3062
            revision_ids).pack()
 
3063
        if pack is not None:
 
3064
            self.target._pack_collection._save_pack_names()
 
3065
            copied_revs = pack.get_revision_count()
 
3066
            # Trigger an autopack. This may duplicate effort as we've just done
 
3067
            # a pack creation, but for now it is simpler to think about as
 
3068
            # 'upload data, then repack if needed'.
 
3069
            self.target._pack_collection.autopack()
 
3070
            return (copied_revs, [])
 
3071
        else:
 
3072
            return (0, [])
 
3073
 
 
3074
    @needs_read_lock
 
3075
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3076
        """See InterRepository.missing_revision_ids().
 
3077
 
 
3078
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3079
            revision_id.
 
3080
        """
 
3081
        if not find_ghosts and revision_id is not None:
 
3082
            return self._walk_to_common_revisions([revision_id])
 
3083
        elif revision_id is not None:
 
3084
            # Find ghosts: search for revisions pointing from one repository to
 
3085
            # the other, and vice versa, anywhere in the history of revision_id.
 
3086
            graph = self.target.get_graph(other_repository=self.source)
 
3087
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3088
            found_ids = set()
 
3089
            while True:
 
3090
                try:
 
3091
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3092
                except StopIteration:
 
3093
                    break
 
3094
                if revision_id in ghosts:
 
3095
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3096
                found_ids.update(next_revs)
 
3097
                found_ids.update(ghosts)
 
3098
            found_ids = frozenset(found_ids)
 
3099
            # Double query here: should be able to avoid this by changing the
 
3100
            # graph api further.
 
3101
            result_set = found_ids - frozenset(
 
3102
                self.target.get_parent_map(found_ids))
 
3103
        else:
 
3104
            source_ids = self.source.all_revision_ids()
 
3105
            # source_ids is the worst possible case we may need to pull.
 
3106
            # now we want to filter source_ids against what we actually
 
3107
            # have in target, but don't try to check for existence where we know
 
3108
            # we do not have a revision as that would be pointless.
 
3109
            target_ids = set(self.target.all_revision_ids())
 
3110
            result_set = set(source_ids).difference(target_ids)
 
3111
        return self.source.revision_ids_to_search_result(result_set)
 
3112
 
 
3113
 
 
3114
class InterDifferingSerializer(InterKnitRepo):
3734
3115
 
3735
3116
    @classmethod
3736
3117
    def _get_repo_format_to_test(self):
3739
3120
    @staticmethod
3740
3121
    def is_compatible(source, target):
3741
3122
        """Be compatible with Knit2 source and Knit3 target"""
3742
 
        # This is redundant with format.check_conversion_target(), however that
3743
 
        # raises an exception, and we just want to say "False" as in we won't
3744
 
        # support converting between these formats.
3745
 
        if 'IDS_never' in debug.debug_flags:
3746
 
            return False
3747
 
        if source.supports_rich_root() and not target.supports_rich_root():
3748
 
            return False
3749
 
        if (source._format.supports_tree_reference
3750
 
            and not target._format.supports_tree_reference):
3751
 
            return False
3752
 
        if target._fallback_repositories and target._format.supports_chks:
3753
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3754
 
            # adds to stacked repos.
3755
 
            return False
3756
 
        if 'IDS_always' in debug.debug_flags:
3757
 
            return True
3758
 
        # Only use this code path for local source and target.  IDS does far
3759
 
        # too much IO (both bandwidth and roundtrips) over a network.
3760
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3761
 
            return False
3762
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3123
        if source.supports_rich_root() != target.supports_rich_root():
 
3124
            return False
 
3125
        # Ideally, we'd support fetching if the source had no tree references
 
3126
        # even if it supported them...
 
3127
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3128
            not getattr(target, '_format.supports_tree_reference', False)):
3763
3129
            return False
3764
3130
        return True
3765
3131
 
3766
 
    def _get_trees(self, revision_ids, cache):
3767
 
        possible_trees = []
3768
 
        for rev_id in revision_ids:
3769
 
            if rev_id in cache:
3770
 
                possible_trees.append((rev_id, cache[rev_id]))
3771
 
            else:
3772
 
                # Not cached, but inventory might be present anyway.
3773
 
                try:
3774
 
                    tree = self.source.revision_tree(rev_id)
3775
 
                except errors.NoSuchRevision:
3776
 
                    # Nope, parent is ghost.
3777
 
                    pass
3778
 
                else:
3779
 
                    cache[rev_id] = tree
3780
 
                    possible_trees.append((rev_id, tree))
3781
 
        return possible_trees
3782
 
 
3783
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3132
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3784
3133
        """Get the best delta and base for this revision.
3785
3134
 
3786
3135
        :return: (basis_id, delta)
3787
3136
        """
 
3137
        possible_trees = [(parent_id, cache[parent_id])
 
3138
                          for parent_id in parent_ids
 
3139
                           if parent_id in cache]
 
3140
        if len(possible_trees) == 0:
 
3141
            # There either aren't any parents, or the parents aren't in the
 
3142
            # cache, so just use the last converted tree
 
3143
            possible_trees.append((basis_id, cache[basis_id]))
3788
3144
        deltas = []
3789
 
        # Generate deltas against each tree, to find the shortest.
3790
 
        texts_possibly_new_in_tree = set()
3791
3145
        for basis_id, basis_tree in possible_trees:
3792
3146
            delta = tree.inventory._make_delta(basis_tree.inventory)
3793
 
            for old_path, new_path, file_id, new_entry in delta:
3794
 
                if new_path is None:
3795
 
                    # This file_id isn't present in the new rev, so we don't
3796
 
                    # care about it.
3797
 
                    continue
3798
 
                if not new_path:
3799
 
                    # Rich roots are handled elsewhere...
3800
 
                    continue
3801
 
                kind = new_entry.kind
3802
 
                if kind != 'directory' and kind != 'file':
3803
 
                    # No text record associated with this inventory entry.
3804
 
                    continue
3805
 
                # This is a directory or file that has changed somehow.
3806
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3807
3147
            deltas.append((len(delta), basis_id, delta))
3808
3148
        deltas.sort()
3809
3149
        return deltas[0][1:]
3810
3150
 
3811
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3812
 
        """Find all parent revisions that are absent, but for which the
3813
 
        inventory is present, and copy those inventories.
3814
 
 
3815
 
        This is necessary to preserve correctness when the source is stacked
3816
 
        without fallbacks configured.  (Note that in cases like upgrade the
3817
 
        source may be not have _fallback_repositories even though it is
3818
 
        stacked.)
3819
 
        """
3820
 
        parent_revs = set()
3821
 
        for parents in parent_map.values():
3822
 
            parent_revs.update(parents)
3823
 
        present_parents = self.source.get_parent_map(parent_revs)
3824
 
        absent_parents = set(parent_revs).difference(present_parents)
3825
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3826
 
            (rev_id,) for rev_id in absent_parents)
3827
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3828
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3829
 
            current_revision_id = parent_tree.get_revision_id()
3830
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3831
 
                (current_revision_id,)]
3832
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3833
 
            basis_id = _mod_revision.NULL_REVISION
3834
 
            basis_tree = self.source.revision_tree(basis_id)
3835
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3836
 
            self.target.add_inventory_by_delta(
3837
 
                basis_id, delta, current_revision_id, parents_parents)
3838
 
            cache[current_revision_id] = parent_tree
3839
 
 
3840
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3151
    def _fetch_batch(self, revision_ids, basis_id, cache):
3841
3152
        """Fetch across a few revisions.
3842
3153
 
3843
3154
        :param revision_ids: The revisions to copy
3844
3155
        :param basis_id: The revision_id of a tree that must be in cache, used
3845
3156
            as a basis for delta when no other base is available
3846
3157
        :param cache: A cache of RevisionTrees that we can use.
3847
 
        :param a_graph: A Graph object to determine the heads() of the
3848
 
            rich-root data stream.
3849
3158
        :return: The revision_id of the last converted tree. The RevisionTree
3850
3159
            for it will be in cache
3851
3160
        """
3852
3161
        # Walk though all revisions; get inventory deltas, copy referenced
3853
3162
        # texts that delta references, insert the delta, revision and
3854
3163
        # signature.
3855
 
        root_keys_to_create = set()
3856
3164
        text_keys = set()
3857
3165
        pending_deltas = []
3858
3166
        pending_revisions = []
3859
3167
        parent_map = self.source.get_parent_map(revision_ids)
3860
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3861
 
        self.source._safe_to_return_from_cache = True
3862
3168
        for tree in self.source.revision_trees(revision_ids):
3863
 
            # Find a inventory delta for this revision.
3864
 
            # Find text entries that need to be copied, too.
3865
3169
            current_revision_id = tree.get_revision_id()
3866
3170
            parent_ids = parent_map.get(current_revision_id, ())
3867
 
            parent_trees = self._get_trees(parent_ids, cache)
3868
 
            possible_trees = list(parent_trees)
3869
 
            if len(possible_trees) == 0:
3870
 
                # There either aren't any parents, or the parents are ghosts,
3871
 
                # so just use the last converted tree.
3872
 
                possible_trees.append((basis_id, cache[basis_id]))
3873
3171
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3874
 
                                                           possible_trees)
 
3172
                                                           basis_id, cache)
 
3173
            # Find text entries that need to be copied
 
3174
            for old_path, new_path, file_id, entry in delta:
 
3175
                if new_path is not None:
 
3176
                    if not (new_path or self.target.supports_rich_root()):
 
3177
                        # We don't copy the text for the root node unless the
 
3178
                        # target supports_rich_root.
 
3179
                        continue
 
3180
                    text_keys.add((file_id, entry.revision))
3875
3181
            revision = self.source.get_revision(current_revision_id)
3876
3182
            pending_deltas.append((basis_id, delta,
3877
3183
                current_revision_id, revision.parent_ids))
3878
 
            if self._converting_to_rich_root:
3879
 
                self._revision_id_to_root_id[current_revision_id] = \
3880
 
                    tree.get_root_id()
3881
 
            # Determine which texts are in present in this revision but not in
3882
 
            # any of the available parents.
3883
 
            texts_possibly_new_in_tree = set()
3884
 
            for old_path, new_path, file_id, entry in delta:
3885
 
                if new_path is None:
3886
 
                    # This file_id isn't present in the new rev
3887
 
                    continue
3888
 
                if not new_path:
3889
 
                    # This is the root
3890
 
                    if not self.target.supports_rich_root():
3891
 
                        # The target doesn't support rich root, so we don't
3892
 
                        # copy
3893
 
                        continue
3894
 
                    if self._converting_to_rich_root:
3895
 
                        # This can't be copied normally, we have to insert
3896
 
                        # it specially
3897
 
                        root_keys_to_create.add((file_id, entry.revision))
3898
 
                        continue
3899
 
                kind = entry.kind
3900
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3901
 
            for basis_id, basis_tree in possible_trees:
3902
 
                basis_inv = basis_tree.inventory
3903
 
                for file_key in list(texts_possibly_new_in_tree):
3904
 
                    file_id, file_revision = file_key
3905
 
                    try:
3906
 
                        entry = basis_inv[file_id]
3907
 
                    except errors.NoSuchId:
3908
 
                        continue
3909
 
                    if entry.revision == file_revision:
3910
 
                        texts_possibly_new_in_tree.remove(file_key)
3911
 
            text_keys.update(texts_possibly_new_in_tree)
3912
3184
            pending_revisions.append(revision)
3913
3185
            cache[current_revision_id] = tree
3914
3186
            basis_id = current_revision_id
3915
 
        self.source._safe_to_return_from_cache = False
3916
3187
        # Copy file texts
3917
3188
        from_texts = self.source.texts
3918
3189
        to_texts = self.target.texts
3919
 
        if root_keys_to_create:
3920
 
            root_stream = _mod_fetch._new_root_data_stream(
3921
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3922
 
                self.source, graph=a_graph)
3923
 
            to_texts.insert_record_stream(root_stream)
3924
3190
        to_texts.insert_record_stream(from_texts.get_record_stream(
3925
3191
            text_keys, self.target._format._fetch_order,
3926
3192
            not self.target._format._fetch_uses_deltas))
3927
 
        # insert inventory deltas
 
3193
        # insert deltas
3928
3194
        for delta in pending_deltas:
3929
3195
            self.target.add_inventory_by_delta(*delta)
3930
 
        if self.target._fallback_repositories:
3931
 
            # Make sure this stacked repository has all the parent inventories
3932
 
            # for the new revisions that we are about to insert.  We do this
3933
 
            # before adding the revisions so that no revision is added until
3934
 
            # all the inventories it may depend on are added.
3935
 
            # Note that this is overzealous, as we may have fetched these in an
3936
 
            # earlier batch.
3937
 
            parent_ids = set()
3938
 
            revision_ids = set()
3939
 
            for revision in pending_revisions:
3940
 
                revision_ids.add(revision.revision_id)
3941
 
                parent_ids.update(revision.parent_ids)
3942
 
            parent_ids.difference_update(revision_ids)
3943
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3944
 
            parent_map = self.source.get_parent_map(parent_ids)
3945
 
            # we iterate over parent_map and not parent_ids because we don't
3946
 
            # want to try copying any revision which is a ghost
3947
 
            for parent_tree in self.source.revision_trees(parent_map):
3948
 
                current_revision_id = parent_tree.get_revision_id()
3949
 
                parents_parents = parent_map[current_revision_id]
3950
 
                possible_trees = self._get_trees(parents_parents, cache)
3951
 
                if len(possible_trees) == 0:
3952
 
                    # There either aren't any parents, or the parents are
3953
 
                    # ghosts, so just use the last converted tree.
3954
 
                    possible_trees.append((basis_id, cache[basis_id]))
3955
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3956
 
                    parents_parents, possible_trees)
3957
 
                self.target.add_inventory_by_delta(
3958
 
                    basis_id, delta, current_revision_id, parents_parents)
3959
3196
        # insert signatures and revisions
3960
3197
        for revision in pending_revisions:
3961
3198
            try:
3973
3210
 
3974
3211
        :param revision_ids: The list of revisions to fetch. Must be in
3975
3212
            topological order.
3976
 
        :param pb: A ProgressTask
 
3213
        :param pb: A ProgressBar
3977
3214
        :return: None
3978
3215
        """
3979
3216
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3981
3218
        cache = lru_cache.LRUCache(100)
3982
3219
        cache[basis_id] = basis_tree
3983
3220
        del basis_tree # We don't want to hang on to it here
3984
 
        hints = []
3985
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3986
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3987
 
                                                            revision_ids)
3988
 
        else:
3989
 
            a_graph = None
3990
 
 
3991
3221
        for offset in range(0, len(revision_ids), batch_size):
3992
3222
            self.target.start_write_group()
3993
3223
            try:
3994
3224
                pb.update('Transferring revisions', offset,
3995
3225
                          len(revision_ids))
3996
3226
                batch = revision_ids[offset:offset+batch_size]
3997
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3998
 
                                             a_graph=a_graph)
 
3227
                basis_id = self._fetch_batch(batch, basis_id, cache)
3999
3228
            except:
4000
 
                self.source._safe_to_return_from_cache = False
4001
3229
                self.target.abort_write_group()
4002
3230
                raise
4003
3231
            else:
4004
 
                hint = self.target.commit_write_group()
4005
 
                if hint:
4006
 
                    hints.extend(hint)
4007
 
        if hints and self.target._format.pack_compresses:
4008
 
            self.target.pack(hint=hints)
 
3232
                self.target.commit_write_group()
4009
3233
        pb.update('Transferring revisions', len(revision_ids),
4010
3234
                  len(revision_ids))
4011
3235
 
4015
3239
        """See InterRepository.fetch()."""
4016
3240
        if fetch_spec is not None:
4017
3241
            raise AssertionError("Not implemented yet...")
4018
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4019
 
        if (not self.source.supports_rich_root()
4020
 
            and self.target.supports_rich_root()):
4021
 
            self._converting_to_rich_root = True
4022
 
            self._revision_id_to_root_id = {}
4023
 
        else:
4024
 
            self._converting_to_rich_root = False
4025
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4026
 
        if self.source._format.network_name() != self.target._format.network_name():
4027
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4028
 
                from_format=self.source._format,
4029
 
                to_format=self.target._format)
4030
3242
        revision_ids = self.target.search_missing_revision_ids(self.source,
4031
3243
            revision_id, find_ghosts=find_ghosts).get_keys()
4032
3244
        if not revision_ids:
4033
3245
            return 0, 0
4034
3246
        revision_ids = tsort.topo_sort(
4035
3247
            self.source.get_graph().get_parent_map(revision_ids))
4036
 
        if not revision_ids:
4037
 
            return 0, 0
4038
 
        # Walk though all revisions; get inventory deltas, copy referenced
4039
 
        # texts that delta references, insert the delta, revision and
4040
 
        # signature.
4041
3248
        if pb is None:
4042
3249
            my_pb = ui.ui_factory.nested_progress_bar()
4043
3250
            pb = my_pb
4080
3287
InterRepository.register_optimiser(InterSameDataRepository)
4081
3288
InterRepository.register_optimiser(InterWeaveRepo)
4082
3289
InterRepository.register_optimiser(InterKnitRepo)
 
3290
InterRepository.register_optimiser(InterPackRepo)
4083
3291
 
4084
3292
 
4085
3293
class CopyConverter(object):
4101
3309
        :param to_convert: The disk object to convert.
4102
3310
        :param pb: a progress bar to use for progress information.
4103
3311
        """
4104
 
        pb = ui.ui_factory.nested_progress_bar()
 
3312
        self.pb = pb
4105
3313
        self.count = 0
4106
3314
        self.total = 4
4107
3315
        # this is only useful with metadir layouts - separated repo content.
4108
3316
        # trigger an assertion if not such
4109
3317
        repo._format.get_format_string()
4110
3318
        self.repo_dir = repo.bzrdir
4111
 
        pb.update('Moving repository to repository.backup')
 
3319
        self.step('Moving repository to repository.backup')
4112
3320
        self.repo_dir.transport.move('repository', 'repository.backup')
4113
3321
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4114
3322
        repo._format.check_conversion_target(self.target_format)
4115
3323
        self.source_repo = repo._format.open(self.repo_dir,
4116
3324
            _found=True,
4117
3325
            _override_transport=backup_transport)
4118
 
        pb.update('Creating new repository')
 
3326
        self.step('Creating new repository')
4119
3327
        converted = self.target_format.initialize(self.repo_dir,
4120
3328
                                                  self.source_repo.is_shared())
4121
3329
        converted.lock_write()
4122
3330
        try:
4123
 
            pb.update('Copying content')
 
3331
            self.step('Copying content into repository.')
4124
3332
            self.source_repo.copy_content_into(converted)
4125
3333
        finally:
4126
3334
            converted.unlock()
4127
 
        pb.update('Deleting old repository content')
 
3335
        self.step('Deleting old repository content.')
4128
3336
        self.repo_dir.transport.delete_tree('repository.backup')
4129
 
        ui.ui_factory.note('repository converted')
4130
 
        pb.finished()
 
3337
        self.pb.note('repository converted')
 
3338
 
 
3339
    def step(self, message):
 
3340
        """Update the pb by a step."""
 
3341
        self.count +=1
 
3342
        self.pb.update(message, self.count, self.total)
4131
3343
 
4132
3344
 
4133
3345
_unescape_map = {
4162
3374
 
4163
3375
class _VersionedFileChecker(object):
4164
3376
 
4165
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3377
    def __init__(self, repository, text_key_references=None):
4166
3378
        self.repository = repository
4167
3379
        self.text_index = self.repository._generate_text_key_index(
4168
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3380
            text_key_references=text_key_references)
4169
3381
 
4170
3382
    def calculate_file_version_parents(self, text_key):
4171
3383
        """Calculate the correct parents for a file version according to
4189
3401
            revision_id) tuples for versions that are present in this versioned
4190
3402
            file, but not used by the corresponding inventory.
4191
3403
        """
4192
 
        local_progress = None
4193
 
        if progress_bar is None:
4194
 
            local_progress = ui.ui_factory.nested_progress_bar()
4195
 
            progress_bar = local_progress
4196
 
        try:
4197
 
            return self._check_file_version_parents(texts, progress_bar)
4198
 
        finally:
4199
 
            if local_progress:
4200
 
                local_progress.finished()
4201
 
 
4202
 
    def _check_file_version_parents(self, texts, progress_bar):
4203
 
        """See check_file_version_parents."""
4204
3404
        wrong_parents = {}
4205
3405
        self.file_ids = set([file_id for file_id, _ in
4206
3406
            self.text_index.iterkeys()])
4207
3407
        # text keys is now grouped by file_id
 
3408
        n_weaves = len(self.file_ids)
 
3409
        files_in_revisions = {}
 
3410
        revisions_of_files = {}
4208
3411
        n_versions = len(self.text_index)
4209
3412
        progress_bar.update('loading text store', 0, n_versions)
4210
3413
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4212
3415
        text_keys = self.repository.texts.keys()
4213
3416
        unused_keys = frozenset(text_keys) - set(self.text_index)
4214
3417
        for num, key in enumerate(self.text_index.iterkeys()):
4215
 
            progress_bar.update('checking text graph', num, n_versions)
 
3418
            if progress_bar is not None:
 
3419
                progress_bar.update('checking text graph', num, n_versions)
4216
3420
            correct_parents = self.calculate_file_version_parents(key)
4217
3421
            try:
4218
3422
                knit_parents = parent_map[key]
4267
3471
        try:
4268
3472
            if resume_tokens:
4269
3473
                self.target_repo.resume_write_group(resume_tokens)
4270
 
                is_resume = True
4271
3474
            else:
4272
3475
                self.target_repo.start_write_group()
4273
 
                is_resume = False
4274
3476
            try:
4275
3477
                # locked_insert_stream performs a commit|suspend.
4276
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3478
                return self._locked_insert_stream(stream, src_format)
4277
3479
            except:
4278
3480
                self.target_repo.abort_write_group(suppress_errors=True)
4279
3481
                raise
4280
3482
        finally:
4281
3483
            self.target_repo.unlock()
4282
3484
 
4283
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3485
    def _locked_insert_stream(self, stream, src_format):
4284
3486
        to_serializer = self.target_repo._format._serializer
4285
3487
        src_serializer = src_format._serializer
4286
 
        new_pack = None
4287
 
        if to_serializer == src_serializer:
4288
 
            # If serializers match and the target is a pack repository, set the
4289
 
            # write cache size on the new pack.  This avoids poor performance
4290
 
            # on transports where append is unbuffered (such as
4291
 
            # RemoteTransport).  This is safe to do because nothing should read
4292
 
            # back from the target repository while a stream with matching
4293
 
            # serialization is being inserted.
4294
 
            # The exception is that a delta record from the source that should
4295
 
            # be a fulltext may need to be expanded by the target (see
4296
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4297
 
            # explicitly flush any buffered writes first in that rare case.
4298
 
            try:
4299
 
                new_pack = self.target_repo._pack_collection._new_pack
4300
 
            except AttributeError:
4301
 
                # Not a pack repository
4302
 
                pass
4303
 
            else:
4304
 
                new_pack.set_write_cache_size(1024*1024)
4305
3488
        for substream_type, substream in stream:
4306
 
            if 'stream' in debug.debug_flags:
4307
 
                mutter('inserting substream: %s', substream_type)
4308
3489
            if substream_type == 'texts':
4309
3490
                self.target_repo.texts.insert_record_stream(substream)
4310
3491
            elif substream_type == 'inventories':
4314
3495
                else:
4315
3496
                    self._extract_and_insert_inventories(
4316
3497
                        substream, src_serializer)
4317
 
            elif substream_type == 'inventory-deltas':
4318
 
                self._extract_and_insert_inventory_deltas(
4319
 
                    substream, src_serializer)
4320
 
            elif substream_type == 'chk_bytes':
4321
 
                # XXX: This doesn't support conversions, as it assumes the
4322
 
                #      conversion was done in the fetch code.
4323
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4324
3498
            elif substream_type == 'revisions':
4325
3499
                # This may fallback to extract-and-insert more often than
4326
3500
                # required if the serializers are different only in terms of
4335
3509
                self.target_repo.signatures.insert_record_stream(substream)
4336
3510
            else:
4337
3511
                raise AssertionError('kaboom! %s' % (substream_type,))
4338
 
        # Done inserting data, and the missing_keys calculations will try to
4339
 
        # read back from the inserted data, so flush the writes to the new pack
4340
 
        # (if this is pack format).
4341
 
        if new_pack is not None:
4342
 
            new_pack._write_data('', flush=True)
4343
 
        # Find all the new revisions (including ones from resume_tokens)
4344
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4345
 
            check_for_missing_texts=is_resume)
4346
3512
        try:
 
3513
            missing_keys = set()
4347
3514
            for prefix, versioned_file in (
4348
3515
                ('texts', self.target_repo.texts),
4349
3516
                ('inventories', self.target_repo.inventories),
4350
3517
                ('revisions', self.target_repo.revisions),
4351
3518
                ('signatures', self.target_repo.signatures),
4352
 
                ('chk_bytes', self.target_repo.chk_bytes),
4353
3519
                ):
4354
 
                if versioned_file is None:
4355
 
                    continue
4356
 
                # TODO: key is often going to be a StaticTuple object
4357
 
                #       I don't believe we can define a method by which
4358
 
                #       (prefix,) + StaticTuple will work, though we could
4359
 
                #       define a StaticTuple.sq_concat that would allow you to
4360
 
                #       pass in either a tuple or a StaticTuple as the second
4361
 
                #       object, so instead we could have:
4362
 
                #       StaticTuple(prefix) + key here...
4363
3520
                missing_keys.update((prefix,) + key for key in
4364
3521
                    versioned_file.get_missing_compression_parent_keys())
4365
3522
        except NotImplementedError:
4374
3531
                # missing keys can handle suspending a write group).
4375
3532
                write_group_tokens = self.target_repo.suspend_write_group()
4376
3533
                return write_group_tokens, missing_keys
4377
 
        hint = self.target_repo.commit_write_group()
4378
 
        if (to_serializer != src_serializer and
4379
 
            self.target_repo._format.pack_compresses):
4380
 
            self.target_repo.pack(hint=hint)
 
3534
        self.target_repo.commit_write_group()
4381
3535
        return [], set()
4382
3536
 
4383
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4384
 
        target_rich_root = self.target_repo._format.rich_root_data
4385
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4386
 
        for record in substream:
4387
 
            # Insert the delta directly
4388
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4389
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4390
 
            try:
4391
 
                parse_result = deserialiser.parse_text_bytes(
4392
 
                    inventory_delta_bytes)
4393
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4394
 
                trace.mutter("Incompatible delta: %s", err.msg)
4395
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4396
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4397
 
            revision_id = new_id
4398
 
            parents = [key[0] for key in record.parents]
4399
 
            self.target_repo.add_inventory_by_delta(
4400
 
                basis_id, inv_delta, revision_id, parents)
4401
 
 
4402
 
    def _extract_and_insert_inventories(self, substream, serializer,
4403
 
            parse_delta=None):
 
3537
    def _extract_and_insert_inventories(self, substream, serializer):
4404
3538
        """Generate a new inventory versionedfile in target, converting data.
4405
3539
 
4406
3540
        The inventory is retrieved from the source, (deserializing it), and
4407
3541
        stored in the target (reserializing it in a different format).
4408
3542
        """
4409
 
        target_rich_root = self.target_repo._format.rich_root_data
4410
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4411
3543
        for record in substream:
4412
 
            # It's not a delta, so it must be a fulltext in the source
4413
 
            # serializer's format.
4414
3544
            bytes = record.get_bytes_as('fulltext')
4415
3545
            revision_id = record.key[0]
4416
3546
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4417
3547
            parents = [key[0] for key in record.parents]
4418
3548
            self.target_repo.add_inventory(revision_id, inv, parents)
4419
 
            # No need to keep holding this full inv in memory when the rest of
4420
 
            # the substream is likely to be all deltas.
4421
 
            del inv
4422
3549
 
4423
3550
    def _extract_and_insert_revisions(self, substream, serializer):
4424
3551
        for record in substream:
4473
3600
        return [('signatures', signatures), ('revisions', revisions)]
4474
3601
 
4475
3602
    def _generate_root_texts(self, revs):
4476
 
        """This will be called by get_stream between fetching weave texts and
 
3603
        """This will be called by __fetch between fetching weave texts and
4477
3604
        fetching the inventory weave.
 
3605
 
 
3606
        Subclasses should override this if they need to generate root texts
 
3607
        after fetching weave texts.
4478
3608
        """
4479
3609
        if self._rich_root_upgrade():
4480
 
            return _mod_fetch.Inter1and2Helper(
 
3610
            import bzrlib.fetch
 
3611
            return bzrlib.fetch.Inter1and2Helper(
4481
3612
                self.from_repository).generate_root_texts(revs)
4482
3613
        else:
4483
3614
            return []
4486
3617
        phase = 'file'
4487
3618
        revs = search.get_keys()
4488
3619
        graph = self.from_repository.get_graph()
4489
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3620
        revs = list(graph.iter_topo_order(revs))
4490
3621
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4491
3622
        text_keys = []
4492
3623
        for knit_kind, file_id, revisions in data_to_fetch:
4511
3642
                # will be valid.
4512
3643
                for _ in self._generate_root_texts(revs):
4513
3644
                    yield _
 
3645
                # NB: This currently reopens the inventory weave in source;
 
3646
                # using a single stream interface instead would avoid this.
 
3647
                from_weave = self.from_repository.inventories
4514
3648
                # we fetch only the referenced inventories because we do not
4515
3649
                # know for unselected inventories whether all their required
4516
3650
                # texts are present in the other repository - it could be
4517
3651
                # corrupt.
4518
 
                for info in self._get_inventory_stream(revs):
4519
 
                    yield info
 
3652
                yield ('inventories', from_weave.get_record_stream(
 
3653
                    [(rev_id,) for rev_id in revs],
 
3654
                    self.inventory_fetch_order(),
 
3655
                    not self.delta_on_metadata()))
4520
3656
            elif knit_kind == "signatures":
4521
3657
                # Nothing to do here; this will be taken care of when
4522
3658
                # _fetch_revision_texts happens.
4535
3671
        keys['texts'] = set()
4536
3672
        keys['revisions'] = set()
4537
3673
        keys['inventories'] = set()
4538
 
        keys['chk_bytes'] = set()
4539
3674
        keys['signatures'] = set()
4540
3675
        for key in missing_keys:
4541
3676
            keys[key[0]].add(key[1:])
4548
3683
                    keys['revisions'],))
4549
3684
        for substream_kind, keys in keys.iteritems():
4550
3685
            vf = getattr(self.from_repository, substream_kind)
4551
 
            if vf is None and keys:
4552
 
                    raise AssertionError(
4553
 
                        "cannot fill in keys for a versioned file we don't"
4554
 
                        " have: %s needs %s" % (substream_kind, keys))
4555
 
            if not keys:
4556
 
                # No need to stream something we don't have
4557
 
                continue
4558
 
            if substream_kind == 'inventories':
4559
 
                # Some missing keys are genuinely ghosts, filter those out.
4560
 
                present = self.from_repository.inventories.get_parent_map(keys)
4561
 
                revs = [key[0] for key in present]
4562
 
                # Get the inventory stream more-or-less as we do for the
4563
 
                # original stream; there's no reason to assume that records
4564
 
                # direct from the source will be suitable for the sink.  (Think
4565
 
                # e.g. 2a -> 1.9-rich-root).
4566
 
                for info in self._get_inventory_stream(revs, missing=True):
4567
 
                    yield info
4568
 
                continue
4569
 
 
4570
3686
            # Ask for full texts always so that we don't need more round trips
4571
3687
            # after this stream.
4572
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4573
 
            # records. The Sink is responsible for doing another check to
4574
 
            # ensure that ghosts don't introduce missing data for future
4575
 
            # fetches.
4576
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4577
 
                self.to_format._fetch_order, True))
 
3688
            stream = vf.get_record_stream(keys,
 
3689
                self.to_format._fetch_order, True)
4578
3690
            yield substream_kind, stream
4579
3691
 
4580
3692
    def inventory_fetch_order(self):
4587
3699
        return (not self.from_repository._format.rich_root_data and
4588
3700
            self.to_format.rich_root_data)
4589
3701
 
4590
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4591
 
        from_format = self.from_repository._format
4592
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4593
 
            from_format.network_name() == self.to_format.network_name()):
4594
 
            raise AssertionError(
4595
 
                "this case should be handled by GroupCHKStreamSource")
4596
 
        elif 'forceinvdeltas' in debug.debug_flags:
4597
 
            return self._get_convertable_inventory_stream(revision_ids,
4598
 
                    delta_versus_null=missing)
4599
 
        elif from_format.network_name() == self.to_format.network_name():
4600
 
            # Same format.
4601
 
            return self._get_simple_inventory_stream(revision_ids,
4602
 
                    missing=missing)
4603
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4604
 
                and from_format._serializer == self.to_format._serializer):
4605
 
            # Essentially the same format.
4606
 
            return self._get_simple_inventory_stream(revision_ids,
4607
 
                    missing=missing)
4608
 
        else:
4609
 
            # Any time we switch serializations, we want to use an
4610
 
            # inventory-delta based approach.
4611
 
            return self._get_convertable_inventory_stream(revision_ids,
4612
 
                    delta_versus_null=missing)
4613
 
 
4614
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4615
 
        # NB: This currently reopens the inventory weave in source;
4616
 
        # using a single stream interface instead would avoid this.
4617
 
        from_weave = self.from_repository.inventories
4618
 
        if missing:
4619
 
            delta_closure = True
4620
 
        else:
4621
 
            delta_closure = not self.delta_on_metadata()
4622
 
        yield ('inventories', from_weave.get_record_stream(
4623
 
            [(rev_id,) for rev_id in revision_ids],
4624
 
            self.inventory_fetch_order(), delta_closure))
4625
 
 
4626
 
    def _get_convertable_inventory_stream(self, revision_ids,
4627
 
                                          delta_versus_null=False):
4628
 
        # The two formats are sufficiently different that there is no fast
4629
 
        # path, so we need to send just inventorydeltas, which any
4630
 
        # sufficiently modern client can insert into any repository.
4631
 
        # The StreamSink code expects to be able to
4632
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4633
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4634
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4635
 
        yield ('inventory-deltas',
4636
 
           self._stream_invs_as_deltas(revision_ids,
4637
 
                                       delta_versus_null=delta_versus_null))
4638
 
 
4639
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4640
 
        """Return a stream of inventory-deltas for the given rev ids.
4641
 
 
4642
 
        :param revision_ids: The list of inventories to transmit
4643
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4644
 
            entry, instead compute the delta versus the NULL_REVISION. This
4645
 
            effectively streams a complete inventory. Used for stuff like
4646
 
            filling in missing parents, etc.
4647
 
        """
4648
 
        from_repo = self.from_repository
4649
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4650
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4651
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4652
 
        # method...
4653
 
        inventories = self.from_repository.iter_inventories(
4654
 
            revision_ids, 'topological')
4655
 
        format = from_repo._format
4656
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4657
 
        inventory_cache = lru_cache.LRUCache(50)
4658
 
        null_inventory = from_repo.revision_tree(
4659
 
            _mod_revision.NULL_REVISION).inventory
4660
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4661
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4662
 
        # repo back into a non-rich-root repo ought to be allowed)
4663
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4664
 
            versioned_root=format.rich_root_data,
4665
 
            tree_references=format.supports_tree_reference)
4666
 
        for inv in inventories:
4667
 
            key = (inv.revision_id,)
4668
 
            parent_keys = parent_map.get(key, ())
4669
 
            delta = None
4670
 
            if not delta_versus_null and parent_keys:
4671
 
                # The caller did not ask for complete inventories and we have
4672
 
                # some parents that we can delta against.  Make a delta against
4673
 
                # each parent so that we can find the smallest.
4674
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4675
 
                for parent_id in parent_ids:
4676
 
                    if parent_id not in invs_sent_so_far:
4677
 
                        # We don't know that the remote side has this basis, so
4678
 
                        # we can't use it.
4679
 
                        continue
4680
 
                    if parent_id == _mod_revision.NULL_REVISION:
4681
 
                        parent_inv = null_inventory
4682
 
                    else:
4683
 
                        parent_inv = inventory_cache.get(parent_id, None)
4684
 
                        if parent_inv is None:
4685
 
                            parent_inv = from_repo.get_inventory(parent_id)
4686
 
                    candidate_delta = inv._make_delta(parent_inv)
4687
 
                    if (delta is None or
4688
 
                        len(delta) > len(candidate_delta)):
4689
 
                        delta = candidate_delta
4690
 
                        basis_id = parent_id
4691
 
            if delta is None:
4692
 
                # Either none of the parents ended up being suitable, or we
4693
 
                # were asked to delta against NULL
4694
 
                basis_id = _mod_revision.NULL_REVISION
4695
 
                delta = inv._make_delta(null_inventory)
4696
 
            invs_sent_so_far.add(inv.revision_id)
4697
 
            inventory_cache[inv.revision_id] = inv
4698
 
            delta_serialized = ''.join(
4699
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4700
 
            yield versionedfile.FulltextContentFactory(
4701
 
                key, parent_keys, None, delta_serialized)
4702
 
 
4703
 
 
4704
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4705
 
                    stop_revision=None):
4706
 
    """Extend the partial history to include a given index
4707
 
 
4708
 
    If a stop_index is supplied, stop when that index has been reached.
4709
 
    If a stop_revision is supplied, stop when that revision is
4710
 
    encountered.  Otherwise, stop when the beginning of history is
4711
 
    reached.
4712
 
 
4713
 
    :param stop_index: The index which should be present.  When it is
4714
 
        present, history extension will stop.
4715
 
    :param stop_revision: The revision id which should be present.  When
4716
 
        it is encountered, history extension will stop.
4717
 
    """
4718
 
    start_revision = partial_history_cache[-1]
4719
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4720
 
    try:
4721
 
        #skip the last revision in the list
4722
 
        iterator.next()
4723
 
        while True:
4724
 
            if (stop_index is not None and
4725
 
                len(partial_history_cache) > stop_index):
4726
 
                break
4727
 
            if partial_history_cache[-1] == stop_revision:
4728
 
                break
4729
 
            revision_id = iterator.next()
4730
 
            partial_history_cache.append(revision_id)
4731
 
    except StopIteration:
4732
 
        # No more history
4733
 
        return
4734