~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

Show diffs side-by-side

added added

removed removed

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