/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-13 04:33:55 UTC
  • mfrom: (5147 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5149.
  • Revision ID: andrew.bennetts@canonical.com-20100413043355-lg3id0uwtju0k3zs
MergeĀ lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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,
26
28
    debug,
27
29
    errors,
 
30
    fetch as _mod_fetch,
 
31
    fifo_cache,
28
32
    generate_ids,
29
33
    gpg,
30
34
    graph,
 
35
    inventory,
 
36
    inventory_delta,
31
37
    lazy_regex,
32
38
    lockable_files,
33
39
    lockdir,
34
40
    lru_cache,
35
41
    osutils,
36
 
    remote,
37
42
    revision as _mod_revision,
 
43
    static_tuple,
38
44
    symbol_versioning,
 
45
    trace,
39
46
    tsort,
40
47
    ui,
 
48
    versionedfile,
41
49
    )
42
50
from bzrlib.bundle import serializer
43
51
from bzrlib.revisiontree import RevisionTree
45
53
from bzrlib.testament import Testament
46
54
""")
47
55
 
 
56
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
57
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
48
65
from bzrlib import registry
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
 
from bzrlib.inter import InterObject
51
 
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
52
 
from bzrlib.symbol_versioning import (
53
 
        deprecated_method,
54
 
        one_one,
55
 
        one_two,
56
 
        one_six,
57
 
        )
58
 
from bzrlib.trace import mutter, mutter_callsite, warning
 
66
from bzrlib.trace import (
 
67
    log_exception_quietly, note, mutter, mutter_callsite, warning)
59
68
 
60
69
 
61
70
# Old formats display a warning, but only once
65
74
class CommitBuilder(object):
66
75
    """Provides an interface to build up a commit.
67
76
 
68
 
    This allows describing a tree to be committed without needing to 
 
77
    This allows describing a tree to be committed without needing to
69
78
    know the internals of the format of the repository.
70
79
    """
71
 
    
 
80
 
72
81
    # all clients should supply tree roots.
73
82
    record_root_entry = True
74
83
    # the default CommitBuilder does not manage trees whose root is versioned.
102
111
 
103
112
        self._revprops = {}
104
113
        if revprops is not None:
 
114
            self._validate_revprops(revprops)
105
115
            self._revprops.update(revprops)
106
116
 
107
117
        if timestamp is None:
116
126
 
117
127
        self._generate_revision_if_needed()
118
128
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
129
        self._basis_delta = []
 
130
        # API compatibility, older code that used CommitBuilder did not call
 
131
        # .record_delete(), which means the delta that is computed would not be
 
132
        # valid. Callers that will call record_delete() should call
 
133
        # .will_record_deletes() to indicate that.
 
134
        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
 
 
148
    def _validate_unicode_text(self, text, context):
 
149
        """Verify things like commit messages don't have bogus characters."""
 
150
        if '\r' in text:
 
151
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
152
 
 
153
    def _validate_revprops(self, revprops):
 
154
        for key, value in revprops.iteritems():
 
155
            # We know that the XML serializers do not round trip '\r'
 
156
            # correctly, so refuse to accept them
 
157
            if not isinstance(value, basestring):
 
158
                raise ValueError('revision property (%s) is not a valid'
 
159
                                 ' (unicode) string: %r' % (key, value))
 
160
            self._validate_unicode_text(value,
 
161
                                        'revision property (%s)' % (key,))
119
162
 
120
163
    def commit(self, message):
121
164
        """Make the actual commit.
122
165
 
123
166
        :return: The revision id of the recorded revision.
124
167
        """
 
168
        self._validate_unicode_text(message, 'commit message')
125
169
        rev = _mod_revision.Revision(
126
170
                       timestamp=self._timestamp,
127
171
                       timezone=self._timezone,
150
194
        deserializing the inventory, while we already have a copy in
151
195
        memory.
152
196
        """
 
197
        if self.new_inventory is None:
 
198
            self.new_inventory = self.repository.get_inventory(
 
199
                self._new_revision_id)
153
200
        return RevisionTree(self.repository, self.new_inventory,
154
 
                            self._new_revision_id)
 
201
            self._new_revision_id)
155
202
 
156
203
    def finish_inventory(self):
157
 
        """Tell the builder that the inventory is finished."""
158
 
        if self.new_inventory.root is None:
159
 
            raise AssertionError('Root entry should be supplied to'
160
 
                ' record_entry_contents, as of bzr 0.10.')
161
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
162
 
        self.new_inventory.revision_id = self._new_revision_id
163
 
        self.inv_sha1 = self.repository.add_inventory(
164
 
            self._new_revision_id,
165
 
            self.new_inventory,
166
 
            self.parents
167
 
            )
 
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
168
231
 
169
232
    def _gen_revision_id(self):
170
233
        """Return new revision-id."""
173
236
 
174
237
    def _generate_revision_if_needed(self):
175
238
        """Create a revision id if None was supplied.
176
 
        
 
239
 
177
240
        If the repository can not support user-specified revision ids
178
241
        they should override this function and raise CannotSetRevisionId
179
242
        if _new_revision_id is not None.
207
270
        # _new_revision_id
208
271
        ie.revision = self._new_revision_id
209
272
 
 
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
 
210
288
    def _get_delta(self, ie, basis_inv, path):
211
289
        """Get a delta against the basis inventory for ie."""
212
290
        if ie.file_id not in basis_inv:
213
291
            # add
214
 
            return (None, path, ie.file_id, ie)
 
292
            result = (None, path, ie.file_id, ie)
 
293
            self._basis_delta.append(result)
 
294
            return result
215
295
        elif ie != basis_inv[ie.file_id]:
216
296
            # common but altered
217
297
            # TODO: avoid tis id2path call.
218
 
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
298
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
299
            self._basis_delta.append(result)
 
300
            return result
219
301
        else:
220
302
            # common, unaltered
221
303
            return None
222
304
 
 
305
    def get_basis_delta(self):
 
306
        """Return the complete inventory delta versus the basis inventory.
 
307
 
 
308
        This has been built up with the calls to record_delete and
 
309
        record_entry_contents. The client must have already called
 
310
        will_record_deletes() to indicate that they will be generating a
 
311
        complete delta.
 
312
 
 
313
        :return: An inventory delta, suitable for use with apply_delta, or
 
314
            Repository.add_inventory_by_delta, etc.
 
315
        """
 
316
        if not self._recording_deletes:
 
317
            raise AssertionError("recording deletes not activated.")
 
318
        return self._basis_delta
 
319
 
 
320
    def record_delete(self, path, file_id):
 
321
        """Record that a delete occured against a basis tree.
 
322
 
 
323
        This is an optional API - when used it adds items to the basis_delta
 
324
        being accumulated by the commit builder. It cannot be called unless the
 
325
        method will_record_deletes() has been called to inform the builder that
 
326
        a delta is being supplied.
 
327
 
 
328
        :param path: The path of the thing deleted.
 
329
        :param file_id: The file id that was deleted.
 
330
        """
 
331
        if not self._recording_deletes:
 
332
            raise AssertionError("recording deletes not activated.")
 
333
        delta = (path, None, file_id, None)
 
334
        self._basis_delta.append(delta)
 
335
        self._any_changes = True
 
336
        return delta
 
337
 
 
338
    def will_record_deletes(self):
 
339
        """Tell the commit builder that deletes are being notified.
 
340
 
 
341
        This enables the accumulation of an inventory delta; for the resulting
 
342
        commit to be valid, deletes against the basis MUST be recorded via
 
343
        builder.record_delete().
 
344
        """
 
345
        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
 
223
352
    def record_entry_contents(self, ie, parent_invs, path, tree,
224
353
        content_summary):
225
354
        """Record the content of ie from tree into the commit if needed.
230
359
        :param parent_invs: The inventories of the parent revisions of the
231
360
            commit.
232
361
        :param path: The path the entry is at in the tree.
233
 
        :param tree: The tree which contains this entry and should be used to 
 
362
        :param tree: The tree which contains this entry and should be used to
234
363
            obtain content.
235
364
        :param content_summary: Summary data from the tree about the paths
236
365
            content - stat, length, exec, sha/link target. This is only
277
406
        if ie.revision is not None:
278
407
            if not self._versioned_root and path == '':
279
408
                # repositories that do not version the root set the root's
280
 
                # revision to the new commit even when no change occurs, and
281
 
                # this masks when a change may have occurred against the basis,
282
 
                # so calculate if one happened.
 
409
                # revision to the new commit even when no change occurs (more
 
410
                # specifically, they do not record a revision on the root; and
 
411
                # the rev id is assigned to the root during deserialisation -
 
412
                # this masks when a change may have occurred against the basis.
 
413
                # To match this we always issue a delta, because the revision
 
414
                # of the root will always be changing.
283
415
                if ie.file_id in basis_inv:
284
416
                    delta = (basis_inv.id2path(ie.file_id), path,
285
417
                        ie.file_id, ie)
286
418
                else:
287
419
                    # add
288
420
                    delta = (None, path, ie.file_id, ie)
 
421
                self._basis_delta.append(delta)
289
422
                return delta, False, None
290
423
            else:
291
424
                # we don't need to commit this, because the caller already
340
473
            if content_summary[2] is None:
341
474
                raise ValueError("Files must not have executable = None")
342
475
            if not store:
343
 
                if (# if the file length changed we have to store:
344
 
                    parent_entry.text_size != content_summary[1] or
345
 
                    # if the exec bit has changed we have to 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:
346
479
                    parent_entry.executable != content_summary[2]):
347
480
                    store = True
348
481
                elif parent_entry.text_sha1 == content_summary[3]:
367
500
            ie.executable = content_summary[2]
368
501
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
369
502
            try:
370
 
                lines = file_obj.readlines()
 
503
                text = file_obj.read()
371
504
            finally:
372
505
                file_obj.close()
373
506
            try:
374
507
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
375
 
                    ie.file_id, lines, heads, nostore_sha)
 
508
                    ie.file_id, text, heads, nostore_sha)
376
509
                # Let the caller know we generated a stat fingerprint.
377
510
                fingerprint = (ie.text_sha1, stat_value)
378
511
            except errors.ExistingContent:
390
523
                # carry over:
391
524
                ie.revision = parent_entry.revision
392
525
                return self._get_delta(ie, basis_inv, path), False, None
393
 
            lines = []
394
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
526
            self._add_text_to_weave(ie.file_id, '', heads, None)
395
527
        elif kind == 'symlink':
396
528
            current_link_target = content_summary[3]
397
529
            if not store:
405
537
                ie.symlink_target = parent_entry.symlink_target
406
538
                return self._get_delta(ie, basis_inv, path), False, None
407
539
            ie.symlink_target = current_link_target
408
 
            lines = []
409
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
540
            self._add_text_to_weave(ie.file_id, '', heads, None)
410
541
        elif kind == 'tree-reference':
411
542
            if not store:
412
543
                if content_summary[3] != parent_entry.reference_revision:
417
548
                ie.revision = parent_entry.revision
418
549
                return self._get_delta(ie, basis_inv, path), False, None
419
550
            ie.reference_revision = content_summary[3]
420
 
            lines = []
421
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
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)
422
555
        else:
423
556
            raise NotImplementedError('unknown kind')
424
557
        ie.revision = self._new_revision_id
 
558
        self._any_changes = True
425
559
        return self._get_delta(ie, basis_inv, path), True, fingerprint
426
560
 
427
 
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
428
 
        # Note: as we read the content directly from the tree, we know its not
429
 
        # been turned into unicode or badly split - but a broken tree
430
 
        # implementation could give us bad output from readlines() so this is
431
 
        # not a guarantee of safety. What would be better is always checking
432
 
        # the content during test suite execution. RBC 20070912
433
 
        parent_keys = tuple((file_id, parent) for parent in parents)
434
 
        return self.repository.texts.add_lines(
435
 
            (file_id, self._new_revision_id), parent_keys, new_lines,
436
 
            nostore_sha=nostore_sha, random_id=self.random_revid,
437
 
            check_content=False)[0:2]
 
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]
438
835
 
439
836
 
440
837
class RootCommitBuilder(CommitBuilder):
441
838
    """This commitbuilder actually records the root id"""
442
 
    
 
839
 
443
840
    # the root entry gets versioned properly by this builder.
444
841
    _versioned_root = True
445
842
 
452
849
        :param tree: The tree that is being committed.
453
850
        """
454
851
 
 
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
 
455
862
 
456
863
######################################################################
457
864
# Repositories
458
865
 
459
 
class Repository(object):
 
866
 
 
867
class Repository(_RelockDebugMixin):
460
868
    """Repository holding history for one or more branches.
461
869
 
462
870
    The repository holds and retrieves historical information including
464
872
    which views a particular line of development through that history.
465
873
 
466
874
    The Repository builds on top of some byte storage facilies (the revisions,
467
 
    signatures, inventories and texts attributes) and a Transport, which
468
 
    respectively provide byte storage and a means to access the (possibly
 
875
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
876
    which respectively provide byte storage and a means to access the (possibly
469
877
    remote) disk.
470
878
 
471
879
    The byte storage facilities are addressed via tuples, which we refer to
472
880
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
473
881
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
474
 
    (file_id, revision_id). We use this interface because it allows low
475
 
    friction with the underlying code that implements disk indices, network
476
 
    encoding and other parts of bzrlib.
 
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.
477
887
 
478
888
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
479
889
        the serialised revisions for the repository. This can be used to obtain
498
908
        The result of trying to insert data into the repository via this store
499
909
        is undefined: it should be considered read-only except for implementors
500
910
        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.
501
916
    :ivar _transport: Transport for file access to repository, typically
502
917
        pointing to .bzr/repository.
503
918
    """
513
928
        r'.* revision="(?P<revision_id>[^"]+)"'
514
929
        )
515
930
 
516
 
    def abort_write_group(self):
 
931
    def abort_write_group(self, suppress_errors=False):
517
932
        """Commit the contents accrued within the current write group.
518
933
 
 
934
        :param suppress_errors: if true, abort_write_group will catch and log
 
935
            unexpected errors that happen during the abort, rather than
 
936
            allowing them to propagate.  Defaults to False.
 
937
 
519
938
        :seealso: start_write_group.
520
939
        """
521
940
        if self._write_group is not self.get_transaction():
522
941
            # has an unlock or relock occured ?
523
 
            raise errors.BzrError('mismatched lock context and write group.')
524
 
        self._abort_write_group()
 
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()))
 
950
        try:
 
951
            self._abort_write_group()
 
952
        except Exception, exc:
 
953
            self._write_group = None
 
954
            if not suppress_errors:
 
955
                raise
 
956
            mutter('abort_write_group failed')
 
957
            log_exception_quietly()
 
958
            note('bzr: ERROR (ignored): %s', exc)
525
959
        self._write_group = None
526
960
 
527
961
    def _abort_write_group(self):
528
962
        """Template method for per-repository write group cleanup.
529
 
        
530
 
        This is called during abort before the write group is considered to be 
 
963
 
 
964
        This is called during abort before the write group is considered to be
531
965
        finished and should cleanup any internal state accrued during the write
532
966
        group. There is no requirement that data handed to the repository be
533
967
        *not* made available - this is not a rollback - but neither should any
539
973
 
540
974
    def add_fallback_repository(self, repository):
541
975
        """Add a repository to use for looking up data not held locally.
542
 
        
 
976
 
543
977
        :param repository: A repository.
544
978
        """
545
979
        if not self._format.supports_external_lookups:
546
980
            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()
547
985
        self._check_fallback_repository(repository)
548
986
        self._fallback_repositories.append(repository)
549
987
        self.texts.add_fallback_versioned_files(repository.texts)
550
988
        self.inventories.add_fallback_versioned_files(repository.inventories)
551
989
        self.revisions.add_fallback_versioned_files(repository.revisions)
552
990
        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)
553
993
 
554
994
    def _check_fallback_repository(self, repository):
555
995
        """Check that this repository can fallback to repository safely.
556
996
 
557
997
        Raise an error if not.
558
 
        
 
998
 
559
999
        :param repository: A repository to fallback to.
560
1000
        """
561
1001
        return InterRepository._assert_same_model(self, repository)
562
1002
 
563
1003
    def add_inventory(self, revision_id, inv, parents):
564
1004
        """Add the inventory inv to the repository as revision_id.
565
 
        
 
1005
 
566
1006
        :param parents: The revision ids of the parents that revision_id
567
1007
                        is known to have and are in the repository already.
568
1008
 
579
1019
                % (inv.revision_id, revision_id))
580
1020
        if inv.root is None:
581
1021
            raise AssertionError()
582
 
        inv_lines = self._serialise_inventory_to_lines(inv)
 
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)
583
1032
        return self._inventory_add_lines(revision_id, parents,
584
1033
            inv_lines, check_content=False)
585
1034
 
 
1035
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1036
                               parents, basis_inv=None, propagate_caches=False):
 
1037
        """Add a new inventory expressed as a delta against another revision.
 
1038
 
 
1039
        See the inventory developers documentation for the theory behind
 
1040
        inventory deltas.
 
1041
 
 
1042
        :param basis_revision_id: The inventory id the delta was created
 
1043
            against. (This does not have to be a direct parent.)
 
1044
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1045
            details).
 
1046
        :param new_revision_id: The revision id that the inventory is being
 
1047
            added for.
 
1048
        :param parents: The revision ids of the parents that revision_id is
 
1049
            known to have and are in the repository already. These are supplied
 
1050
            for repositories that depend on the inventory graph for revision
 
1051
            graph access, as well as for those that pun ancestry with delta
 
1052
            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
 
 
1058
        :returns: (validator, new_inv)
 
1059
            The validator(which is a sha1 digest, though what is sha'd is
 
1060
            repository format specific) of the serialized inventory, and the
 
1061
            resulting inventory.
 
1062
        """
 
1063
        if not self.is_in_write_group():
 
1064
            raise AssertionError("%r not in write group" % (self,))
 
1065
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1066
        basis_tree = self.revision_tree(basis_revision_id)
 
1067
        basis_tree.lock_read()
 
1068
        try:
 
1069
            # Note that this mutates the inventory of basis_tree, which not all
 
1070
            # inventory implementations may support: A better idiom would be to
 
1071
            # return a new inventory, but as there is no revision tree cache in
 
1072
            # repository this is safe for now - RBC 20081013
 
1073
            if basis_inv is None:
 
1074
                basis_inv = basis_tree.inventory
 
1075
            basis_inv.apply_delta(delta)
 
1076
            basis_inv.revision_id = new_revision_id
 
1077
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1078
                    basis_inv)
 
1079
        finally:
 
1080
            basis_tree.unlock()
 
1081
 
586
1082
    def _inventory_add_lines(self, revision_id, parents, lines,
587
1083
        check_content=True):
588
1084
        """Store lines in inv_vf and return the sha1 of the inventory."""
589
1085
        parents = [(parent,) for parent in parents]
590
 
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1086
        result = self.inventories.add_lines((revision_id,), parents, lines,
591
1087
            check_content=check_content)[0]
 
1088
        self.inventories._access.flush()
 
1089
        return result
592
1090
 
593
1091
    def add_revision(self, revision_id, rev, inv=None, config=None):
594
1092
        """Add rev to the revision store as revision_id.
631
1129
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
632
1130
 
633
1131
    def all_revision_ids(self):
634
 
        """Returns a list of all the revision ids in the repository. 
 
1132
        """Returns a list of all the revision ids in the repository.
635
1133
 
636
1134
        This is conceptually deprecated because code should generally work on
637
1135
        the graph reachable from a particular revision, and ignore any other
643
1141
        return self._all_revision_ids()
644
1142
 
645
1143
    def _all_revision_ids(self):
646
 
        """Returns a list of all the revision ids in the repository. 
 
1144
        """Returns a list of all the revision ids in the repository.
647
1145
 
648
 
        These are in as much topological order as the underlying store can 
 
1146
        These are in as much topological order as the underlying store can
649
1147
        present.
650
1148
        """
651
1149
        raise NotImplementedError(self._all_revision_ids)
670
1168
        # The old API returned a list, should this actually be a set?
671
1169
        return parent_map.keys()
672
1170
 
 
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
 
673
1284
    @staticmethod
674
1285
    def create(a_bzrdir):
675
1286
        """Construct the current default format repository in a_bzrdir."""
696
1307
        self._reconcile_does_inventory_gc = True
697
1308
        self._reconcile_fixes_text_parents = False
698
1309
        self._reconcile_backsup_inventory = True
699
 
        # not right yet - should be more semantically clear ? 
700
 
        # 
701
 
        # TODO: make sure to construct the right store classes, etc, depending
702
 
        # on whether escaping is required.
703
 
        self._warn_if_deprecated()
704
1310
        self._write_group = None
705
1311
        # Additional places to query for data.
706
1312
        self._fallback_repositories = []
707
 
        # What order should fetch operations request streams in?
708
 
        # The default is unordered as that is the cheapest for an origin to
709
 
        # provide.
710
 
        self._fetch_order = 'unordered'
711
 
        # Does this repository use deltas that can be fetched as-deltas ?
712
 
        # (E.g. knits, where the knit deltas can be transplanted intact.
713
 
        # We default to False, which will ensure that enough data to get
714
 
        # a full text out of any fetch stream will be grabbed.
715
 
        self._fetch_uses_deltas = False
716
 
        # Should fetch trigger a reconcile after the fetch? Only needed for
717
 
        # some repository formats that can suffer internal inconsistencies.
718
 
        self._fetch_reconcile = False
 
1313
        # An InventoryEntry cache, used during deserialization
 
1314
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
1315
        # Is it safe to return inventory entries directly from the entry cache,
 
1316
        # rather copying them?
 
1317
        self._safe_to_return_from_cache = False
719
1318
 
720
1319
    def __repr__(self):
721
 
        return '%s(%r)' % (self.__class__.__name__,
722
 
                           self.base)
 
1320
        if self._fallback_repositories:
 
1321
            return '%s(%r, fallback_repositories=%r)' % (
 
1322
                self.__class__.__name__,
 
1323
                self.base,
 
1324
                self._fallback_repositories)
 
1325
        else:
 
1326
            return '%s(%r)' % (self.__class__.__name__,
 
1327
                               self.base)
 
1328
 
 
1329
    def _has_same_fallbacks(self, other_repo):
 
1330
        """Returns true if the repositories have the same fallbacks."""
 
1331
        my_fb = self._fallback_repositories
 
1332
        other_fb = other_repo._fallback_repositories
 
1333
        if len(my_fb) != len(other_fb):
 
1334
            return False
 
1335
        for f, g in zip(my_fb, other_fb):
 
1336
            if not f.has_same_location(g):
 
1337
                return False
 
1338
        return True
723
1339
 
724
1340
    def has_same_location(self, other):
725
1341
        """Returns a boolean indicating if this repository is at the same
752
1368
        This causes caching within the repository obejct to start accumlating
753
1369
        data during reads, and allows a 'write_group' to be obtained. Write
754
1370
        groups must be used for actual data insertion.
755
 
        
 
1371
 
756
1372
        :param token: if this is already locked, then lock_write will fail
757
1373
            unless the token matches the existing lock.
758
1374
        :returns: a token if this instance supports tokens, otherwise None.
768
1384
 
769
1385
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
770
1386
        """
 
1387
        locked = self.is_locked()
771
1388
        result = self.control_files.lock_write(token=token)
772
 
        for repo in self._fallback_repositories:
773
 
            # Writes don't affect fallback repos
774
 
            repo.lock_read()
775
 
        self._refresh_data()
 
1389
        if not locked:
 
1390
            self._warn_if_deprecated()
 
1391
            self._note_lock('w')
 
1392
            for repo in self._fallback_repositories:
 
1393
                # Writes don't affect fallback repos
 
1394
                repo.lock_read()
 
1395
            self._refresh_data()
776
1396
        return result
777
1397
 
778
1398
    def lock_read(self):
 
1399
        locked = self.is_locked()
779
1400
        self.control_files.lock_read()
780
 
        for repo in self._fallback_repositories:
781
 
            repo.lock_read()
782
 
        self._refresh_data()
 
1401
        if not locked:
 
1402
            self._warn_if_deprecated()
 
1403
            self._note_lock('r')
 
1404
            for repo in self._fallback_repositories:
 
1405
                repo.lock_read()
 
1406
            self._refresh_data()
783
1407
 
784
1408
    def get_physical_lock_status(self):
785
1409
        return self.control_files.get_physical_lock_status()
787
1411
    def leave_lock_in_place(self):
788
1412
        """Tell this repository not to release the physical lock when this
789
1413
        object is unlocked.
790
 
        
 
1414
 
791
1415
        If lock_write doesn't return a token, then this method is not supported.
792
1416
        """
793
1417
        self.control_files.leave_in_place()
861
1485
        :param using: If True, list only branches using this repository.
862
1486
        """
863
1487
        if using and not self.is_shared():
864
 
            try:
865
 
                return [self.bzrdir.open_branch()]
866
 
            except errors.NotBranchError:
867
 
                return []
 
1488
            return self.bzrdir.list_branches()
868
1489
        class Evaluator(object):
869
1490
 
870
1491
            def __init__(self):
879
1500
                    except errors.NoRepositoryPresent:
880
1501
                        pass
881
1502
                    else:
882
 
                        return False, (None, repository)
 
1503
                        return False, ([], repository)
883
1504
                self.first_call = False
884
 
                try:
885
 
                    value = (bzrdir.open_branch(), None)
886
 
                except errors.NotBranchError:
887
 
                    value = (None, None)
 
1505
                value = (bzrdir.list_branches(), None)
888
1506
                return True, value
889
1507
 
890
 
        branches = []
891
 
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1508
        ret = []
 
1509
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
892
1510
                self.bzrdir.root_transport, evaluate=Evaluator()):
893
 
            if branch is not None:
894
 
                branches.append(branch)
 
1511
            if branches is not None:
 
1512
                ret.extend(branches)
895
1513
            if not using and repository is not None:
896
 
                branches.extend(repository.find_branches())
897
 
        return branches
 
1514
                ret.extend(repository.find_branches())
 
1515
        return ret
898
1516
 
899
1517
    @needs_read_lock
900
1518
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
901
1519
        """Return the revision ids that other has that this does not.
902
 
        
 
1520
 
903
1521
        These are returned in topological order.
904
1522
 
905
1523
        revision_id: only return revision ids included by revision_id.
907
1525
        return InterRepository.get(other, self).search_missing_revision_ids(
908
1526
            revision_id, find_ghosts)
909
1527
 
910
 
    @deprecated_method(one_two)
911
 
    @needs_read_lock
912
 
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
913
 
        """Return the revision ids that other has that this does not.
914
 
        
915
 
        These are returned in topological order.
916
 
 
917
 
        revision_id: only return revision ids included by revision_id.
918
 
        """
919
 
        keys =  self.search_missing_revision_ids(
920
 
            other, revision_id, find_ghosts).get_keys()
921
 
        other.lock_read()
922
 
        try:
923
 
            parents = other.get_graph().get_parent_map(keys)
924
 
        finally:
925
 
            other.unlock()
926
 
        return tsort.topo_sort(parents)
927
 
 
928
1528
    @staticmethod
929
1529
    def open(base):
930
1530
        """Open the repository rooted at base.
937
1537
 
938
1538
    def copy_content_into(self, destination, revision_id=None):
939
1539
        """Make a complete copy of the content in self into destination.
940
 
        
941
 
        This is a destructive operation! Do not use it on existing 
 
1540
 
 
1541
        This is a destructive operation! Do not use it on existing
942
1542
        repositories.
943
1543
        """
944
1544
        return InterRepository.get(self, destination).copy_content(revision_id)
947
1547
        """Commit the contents accrued within the current write group.
948
1548
 
949
1549
        :seealso: start_write_group.
 
1550
        
 
1551
        :return: it may return an opaque hint that can be passed to 'pack'.
950
1552
        """
951
1553
        if self._write_group is not self.get_transaction():
952
1554
            # has an unlock or relock occured ?
953
1555
            raise errors.BzrError('mismatched lock context %r and '
954
1556
                'write group %r.' %
955
1557
                (self.get_transaction(), self._write_group))
956
 
        self._commit_write_group()
 
1558
        result = self._commit_write_group()
957
1559
        self._write_group = None
 
1560
        return result
958
1561
 
959
1562
    def _commit_write_group(self):
960
1563
        """Template method for per-repository write group cleanup.
961
 
        
962
 
        This is called before the write group is considered to be 
 
1564
 
 
1565
        This is called before the write group is considered to be
963
1566
        finished and should ensure that all data handed to the repository
964
 
        for writing during the write group is safely committed (to the 
 
1567
        for writing during the write group is safely committed (to the
965
1568
        extent possible considering file system caching etc).
966
1569
        """
967
1570
 
968
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
1571
    def suspend_write_group(self):
 
1572
        raise errors.UnsuspendableWriteGroup(self)
 
1573
 
 
1574
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1575
        """Return the keys of missing inventory parents for revisions added in
 
1576
        this write group.
 
1577
 
 
1578
        A revision is not complete if the inventory delta for that revision
 
1579
        cannot be calculated.  Therefore if the parent inventories of a
 
1580
        revision are not present, the revision is incomplete, and e.g. cannot
 
1581
        be streamed by a smart server.  This method finds missing inventory
 
1582
        parents for revisions added in this write group.
 
1583
        """
 
1584
        if not self._format.supports_external_lookups:
 
1585
            # This is only an issue for stacked repositories
 
1586
            return set()
 
1587
        if not self.is_in_write_group():
 
1588
            raise AssertionError('not in a write group')
 
1589
 
 
1590
        # XXX: We assume that every added revision already has its
 
1591
        # corresponding inventory, so we only check for parent inventories that
 
1592
        # might be missing, rather than all inventories.
 
1593
        parents = set(self.revisions._index.get_missing_parents())
 
1594
        parents.discard(_mod_revision.NULL_REVISION)
 
1595
        unstacked_inventories = self.inventories._index
 
1596
        present_inventories = unstacked_inventories.get_parent_map(
 
1597
            key[-1:] for key in parents)
 
1598
        parents.difference_update(present_inventories)
 
1599
        if len(parents) == 0:
 
1600
            # No missing parent inventories.
 
1601
            return set()
 
1602
        if not check_for_missing_texts:
 
1603
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1604
        # Ok, now we have a list of missing inventories.  But these only matter
 
1605
        # if the inventories that reference them are missing some texts they
 
1606
        # appear to introduce.
 
1607
        # XXX: Texts referenced by all added inventories need to be present,
 
1608
        # but at the moment we're only checking for texts referenced by
 
1609
        # inventories at the graph's edge.
 
1610
        key_deps = self.revisions._index._key_dependencies
 
1611
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1612
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1613
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1614
        missing_texts = set()
 
1615
        for file_id, version_ids in file_ids.iteritems():
 
1616
            missing_texts.update(
 
1617
                (file_id, version_id) for version_id in version_ids)
 
1618
        present_texts = self.texts.get_parent_map(missing_texts)
 
1619
        missing_texts.difference_update(present_texts)
 
1620
        if not missing_texts:
 
1621
            # No texts are missing, so all revisions and their deltas are
 
1622
            # reconstructable.
 
1623
            return set()
 
1624
        # Alternatively the text versions could be returned as the missing
 
1625
        # keys, but this is likely to be less data.
 
1626
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1627
        return missing_keys
 
1628
 
 
1629
    def refresh_data(self):
 
1630
        """Re-read any data needed to to synchronise with disk.
 
1631
 
 
1632
        This method is intended to be called after another repository instance
 
1633
        (such as one used by a smart server) has inserted data into the
 
1634
        repository. It may not be called during a write group, but may be
 
1635
        called at any other time.
 
1636
        """
 
1637
        if self.is_in_write_group():
 
1638
            raise errors.InternalBzrError(
 
1639
                "May not refresh_data while in a write group.")
 
1640
        self._refresh_data()
 
1641
 
 
1642
    def resume_write_group(self, tokens):
 
1643
        if not self.is_write_locked():
 
1644
            raise errors.NotWriteLocked(self)
 
1645
        if self._write_group:
 
1646
            raise errors.BzrError('already in a write group')
 
1647
        self._resume_write_group(tokens)
 
1648
        # so we can detect unlock/relock - the write group is now entered.
 
1649
        self._write_group = self.get_transaction()
 
1650
 
 
1651
    def _resume_write_group(self, tokens):
 
1652
        raise errors.UnsuspendableWriteGroup(self)
 
1653
 
 
1654
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1655
            fetch_spec=None):
969
1656
        """Fetch the content required to construct revision_id from source.
970
1657
 
971
 
        If revision_id is None all content is copied.
 
1658
        If revision_id is None and fetch_spec is None, then all content is
 
1659
        copied.
 
1660
 
 
1661
        fetch() may not be used when the repository is in a write group -
 
1662
        either finish the current write group before using fetch, or use
 
1663
        fetch before starting the write group.
 
1664
 
972
1665
        :param find_ghosts: Find and copy revisions in the source that are
973
1666
            ghosts in the target (and not reachable directly by walking out to
974
1667
            the first-present revision in target from revision_id).
 
1668
        :param revision_id: If specified, all the content needed for this
 
1669
            revision ID will be copied to the target.  Fetch will determine for
 
1670
            itself which content needs to be copied.
 
1671
        :param fetch_spec: If specified, a SearchResult or
 
1672
            PendingAncestryResult that describes which revisions to copy.  This
 
1673
            allows copying multiple heads at once.  Mutually exclusive with
 
1674
            revision_id.
975
1675
        """
 
1676
        if fetch_spec is not None and revision_id is not None:
 
1677
            raise AssertionError(
 
1678
                "fetch_spec and revision_id are mutually exclusive.")
 
1679
        if self.is_in_write_group():
 
1680
            raise errors.InternalBzrError(
 
1681
                "May not fetch while in a write group.")
976
1682
        # fast path same-url fetch operations
977
 
        if self.has_same_location(source):
 
1683
        # TODO: lift out to somewhere common with RemoteRepository
 
1684
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1685
        if (self.has_same_location(source)
 
1686
            and fetch_spec is None
 
1687
            and self._has_same_fallbacks(source)):
978
1688
            # check that last_revision is in 'from' and then return a
979
1689
            # no-operation.
980
1690
            if (revision_id is not None and
986
1696
        # IncompatibleRepositories when asked to fetch.
987
1697
        inter = InterRepository.get(source, self)
988
1698
        return inter.fetch(revision_id=revision_id, pb=pb,
989
 
            find_ghosts=find_ghosts)
 
1699
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
990
1700
 
991
1701
    def create_bundle(self, target, base, fileobj, format=None):
992
1702
        return serializer.write_bundle(self, target, base, fileobj, format)
995
1705
                           timezone=None, committer=None, revprops=None,
996
1706
                           revision_id=None):
997
1707
        """Obtain a CommitBuilder for this repository.
998
 
        
 
1708
 
999
1709
        :param branch: Branch to commit to.
1000
1710
        :param parents: Revision ids of the parents of the new revision.
1001
1711
        :param config: Configuration to use.
1005
1715
        :param revprops: Optional dictionary of revision properties.
1006
1716
        :param revision_id: Optional revision id.
1007
1717
        """
 
1718
        if self._fallback_repositories:
 
1719
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1720
                "to a stacked branch. See "
 
1721
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1008
1722
        result = self._commit_builder_class(self, parents, config,
1009
1723
            timestamp, timezone, committer, revprops, revision_id)
1010
1724
        self.start_write_group()
1011
1725
        return result
1012
1726
 
 
1727
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1013
1728
    def unlock(self):
1014
1729
        if (self.control_files._lock_count == 1 and
1015
1730
            self.control_files._lock_mode == 'w'):
1019
1734
                raise errors.BzrError(
1020
1735
                    'Must end write groups before releasing write locks.')
1021
1736
        self.control_files.unlock()
1022
 
        for repo in self._fallback_repositories:
1023
 
            repo.unlock()
 
1737
        if self.control_files._lock_count == 0:
 
1738
            self._inventory_entry_cache.clear()
 
1739
            for repo in self._fallback_repositories:
 
1740
                repo.unlock()
1024
1741
 
1025
1742
    @needs_read_lock
1026
1743
    def clone(self, a_bzrdir, revision_id=None):
1061
1778
 
1062
1779
    def _start_write_group(self):
1063
1780
        """Template method for per-repository write group startup.
1064
 
        
1065
 
        This is called before the write group is considered to be 
 
1781
 
 
1782
        This is called before the write group is considered to be
1066
1783
        entered.
1067
1784
        """
1068
1785
 
1089
1806
                dest_repo = a_bzrdir.open_repository()
1090
1807
        return dest_repo
1091
1808
 
 
1809
    def _get_sink(self):
 
1810
        """Return a sink for streaming into this repository."""
 
1811
        return StreamSink(self)
 
1812
 
 
1813
    def _get_source(self, to_format):
 
1814
        """Return a source for streaming from this repository."""
 
1815
        return StreamSource(self, to_format)
 
1816
 
1092
1817
    @needs_read_lock
1093
1818
    def has_revision(self, revision_id):
1094
1819
        """True if this repository has a copy of the revision."""
1117
1842
    @needs_read_lock
1118
1843
    def get_revision_reconcile(self, revision_id):
1119
1844
        """'reconcile' helper routine that allows access to a revision always.
1120
 
        
 
1845
 
1121
1846
        This variant of get_revision does not cross check the weave graph
1122
1847
        against the revision one as get_revision does: but it should only
1123
1848
        be used by reconcile, or reconcile-alike commands that are correcting
1127
1852
 
1128
1853
    @needs_read_lock
1129
1854
    def get_revisions(self, revision_ids):
1130
 
        """Get many revisions at once."""
 
1855
        """Get many revisions at once.
 
1856
        
 
1857
        Repositories that need to check data on every revision read should 
 
1858
        subclass this method.
 
1859
        """
1131
1860
        return self._get_revisions(revision_ids)
1132
1861
 
1133
1862
    @needs_read_lock
1134
1863
    def _get_revisions(self, revision_ids):
1135
1864
        """Core work logic to get many revisions without sanity checks."""
1136
 
        for rev_id in revision_ids:
1137
 
            if not rev_id or not isinstance(rev_id, basestring):
1138
 
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1865
        revs = {}
 
1866
        for revid, rev in self._iter_revisions(revision_ids):
 
1867
            if rev is None:
 
1868
                raise errors.NoSuchRevision(self, revid)
 
1869
            revs[revid] = rev
 
1870
        return [revs[revid] for revid in revision_ids]
 
1871
 
 
1872
    def _iter_revisions(self, revision_ids):
 
1873
        """Iterate over revision objects.
 
1874
 
 
1875
        :param revision_ids: An iterable of revisions to examine. None may be
 
1876
            passed to request all revisions known to the repository. Note that
 
1877
            not all repositories can find unreferenced revisions; for those
 
1878
            repositories only referenced ones will be returned.
 
1879
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1880
            those asked for but not available) are returned as (revid, None).
 
1881
        """
 
1882
        if revision_ids is None:
 
1883
            revision_ids = self.all_revision_ids()
 
1884
        else:
 
1885
            for rev_id in revision_ids:
 
1886
                if not rev_id or not isinstance(rev_id, basestring):
 
1887
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1139
1888
        keys = [(key,) for key in revision_ids]
1140
1889
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1141
 
        revs = {}
1142
1890
        for record in stream:
 
1891
            revid = record.key[0]
1143
1892
            if record.storage_kind == 'absent':
1144
 
                raise errors.NoSuchRevision(self, record.key[0])
1145
 
            text = record.get_bytes_as('fulltext')
1146
 
            rev = self._serializer.read_revision_from_string(text)
1147
 
            revs[record.key[0]] = rev
1148
 
        return [revs[revid] for revid in revision_ids]
1149
 
 
1150
 
    @needs_read_lock
1151
 
    def get_revision_xml(self, revision_id):
1152
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1153
 
        #       would have already do it.
1154
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1155
 
        rev = self.get_revision(revision_id)
1156
 
        rev_tmp = cStringIO.StringIO()
1157
 
        # the current serializer..
1158
 
        self._serializer.write_revision(rev, rev_tmp)
1159
 
        rev_tmp.seek(0)
1160
 
        return rev_tmp.getvalue()
1161
 
 
1162
 
    def get_deltas_for_revisions(self, revisions):
 
1893
                yield (revid, None)
 
1894
            else:
 
1895
                text = record.get_bytes_as('fulltext')
 
1896
                rev = self._serializer.read_revision_from_string(text)
 
1897
                yield (revid, rev)
 
1898
 
 
1899
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1163
1900
        """Produce a generator of revision deltas.
1164
 
        
 
1901
 
1165
1902
        Note that the input is a sequence of REVISIONS, not revision_ids.
1166
1903
        Trees will be held in memory until the generator exits.
1167
1904
        Each delta is relative to the revision's lefthand predecessor.
 
1905
 
 
1906
        :param specific_fileids: if not None, the result is filtered
 
1907
          so that only those file-ids, their parents and their
 
1908
          children are included.
1168
1909
        """
 
1910
        # Get the revision-ids of interest
1169
1911
        required_trees = set()
1170
1912
        for revision in revisions:
1171
1913
            required_trees.add(revision.revision_id)
1172
1914
            required_trees.update(revision.parent_ids[:1])
1173
 
        trees = dict((t.get_revision_id(), t) for 
1174
 
                     t in self.revision_trees(required_trees))
 
1915
 
 
1916
        # Get the matching filtered trees. Note that it's more
 
1917
        # efficient to pass filtered trees to changes_from() rather
 
1918
        # than doing the filtering afterwards. changes_from() could
 
1919
        # arguably do the filtering itself but it's path-based, not
 
1920
        # file-id based, so filtering before or afterwards is
 
1921
        # currently easier.
 
1922
        if specific_fileids is None:
 
1923
            trees = dict((t.get_revision_id(), t) for
 
1924
                t in self.revision_trees(required_trees))
 
1925
        else:
 
1926
            trees = dict((t.get_revision_id(), t) for
 
1927
                t in self._filtered_revision_trees(required_trees,
 
1928
                specific_fileids))
 
1929
 
 
1930
        # Calculate the deltas
1175
1931
        for revision in revisions:
1176
1932
            if not revision.parent_ids:
1177
1933
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1180
1936
            yield trees[revision.revision_id].changes_from(old_tree)
1181
1937
 
1182
1938
    @needs_read_lock
1183
 
    def get_revision_delta(self, revision_id):
 
1939
    def get_revision_delta(self, revision_id, specific_fileids=None):
1184
1940
        """Return the delta for one revision.
1185
1941
 
1186
1942
        The delta is relative to the left-hand predecessor of the
1187
1943
        revision.
 
1944
 
 
1945
        :param specific_fileids: if not None, the result is filtered
 
1946
          so that only those file-ids, their parents and their
 
1947
          children are included.
1188
1948
        """
1189
1949
        r = self.get_revision(revision_id)
1190
 
        return list(self.get_deltas_for_revisions([r]))[0]
 
1950
        return list(self.get_deltas_for_revisions([r],
 
1951
            specific_fileids=specific_fileids))[0]
1191
1952
 
1192
1953
    @needs_write_lock
1193
1954
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1202
1963
    def find_text_key_references(self):
1203
1964
        """Find the text key references within the repository.
1204
1965
 
1205
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
1206
 
        revision_ids. Each altered file-ids has the exact revision_ids that
1207
 
        altered it listed explicitly.
1208
1966
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1209
1967
            to whether they were referred to by the inventory of the
1210
1968
            revision_id that they contain. The inventory texts from all present
1241
1999
 
1242
2000
        # this code needs to read every new line in every inventory for the
1243
2001
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
1244
 
        # not present in one of those inventories is unnecessary but not 
 
2002
        # not present in one of those inventories is unnecessary but not
1245
2003
        # harmful because we are filtering by the revision id marker in the
1246
 
        # inventory lines : we only select file ids altered in one of those  
 
2004
        # inventory lines : we only select file ids altered in one of those
1247
2005
        # revisions. We don't need to see all lines in the inventory because
1248
2006
        # only those added in an inventory in rev X can contain a revision=X
1249
2007
        # line.
1299
2057
                result[key] = True
1300
2058
        return result
1301
2059
 
 
2060
    def _inventory_xml_lines_for_keys(self, keys):
 
2061
        """Get a line iterator of the sort needed for findind references.
 
2062
 
 
2063
        Not relevant for non-xml inventory repositories.
 
2064
 
 
2065
        Ghosts in revision_keys are ignored.
 
2066
 
 
2067
        :param revision_keys: The revision keys for the inventories to inspect.
 
2068
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
2069
            all of the xml inventories specified by revision_keys.
 
2070
        """
 
2071
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2072
        for record in stream:
 
2073
            if record.storage_kind != 'absent':
 
2074
                chunks = record.get_bytes_as('chunked')
 
2075
                revid = record.key[-1]
 
2076
                lines = osutils.chunks_to_lines(chunks)
 
2077
                for line in lines:
 
2078
                    yield line, revid
 
2079
 
1302
2080
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1303
 
        revision_ids):
 
2081
        revision_keys):
1304
2082
        """Helper routine for fileids_altered_by_revision_ids.
1305
2083
 
1306
2084
        This performs the translation of xml lines to revision ids.
1307
2085
 
1308
2086
        :param line_iterator: An iterator of lines, origin_version_id
1309
 
        :param revision_ids: The revision ids to filter for. This should be a
 
2087
        :param revision_keys: The revision ids to filter for. This should be a
1310
2088
            set or other type which supports efficient __contains__ lookups, as
1311
 
            the revision id from each parsed line will be looked up in the
1312
 
            revision_ids filter.
 
2089
            the revision key from each parsed line will be looked up in the
 
2090
            revision_keys filter.
1313
2091
        :return: a dictionary mapping altered file-ids to an iterable of
1314
2092
        revision_ids. Each altered file-ids has the exact revision_ids that
1315
2093
        altered it listed explicitly.
1316
2094
        """
 
2095
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2096
                line_iterator).iterkeys())
 
2097
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
2098
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2099
            self._inventory_xml_lines_for_keys(parent_keys)))
 
2100
        new_keys = seen - parent_seen
1317
2101
        result = {}
1318
2102
        setdefault = result.setdefault
1319
 
        for key in \
1320
 
            self._find_text_key_references_from_xml_inventory_lines(
1321
 
                line_iterator).iterkeys():
1322
 
            # once data is all ensured-consistent; then this is
1323
 
            # if revision_id == version_id
1324
 
            if key[-1:] in revision_ids:
1325
 
                setdefault(key[0], set()).add(key[-1])
 
2103
        for key in new_keys:
 
2104
            setdefault(key[0], set()).add(key[-1])
1326
2105
        return result
1327
2106
 
 
2107
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2108
        """Find all parent ids that are mentioned in the revision graph.
 
2109
 
 
2110
        :return: set of revisions that are parents of revision_ids which are
 
2111
            not part of revision_ids themselves
 
2112
        """
 
2113
        parent_map = self.get_parent_map(revision_ids)
 
2114
        parent_ids = set()
 
2115
        map(parent_ids.update, parent_map.itervalues())
 
2116
        parent_ids.difference_update(revision_ids)
 
2117
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2118
        return parent_ids
 
2119
 
 
2120
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2121
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2122
 
 
2123
        :param revision_keys: An iterable of revision_keys.
 
2124
        :return: The parents of all revision_keys that are not already in
 
2125
            revision_keys
 
2126
        """
 
2127
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2128
        parent_keys = set()
 
2129
        map(parent_keys.update, parent_map.itervalues())
 
2130
        parent_keys.difference_update(revision_keys)
 
2131
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2132
        return parent_keys
 
2133
 
1328
2134
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1329
2135
        """Find the file ids and versions affected by revisions.
1330
2136
 
1337
2143
        """
1338
2144
        selected_keys = set((revid,) for revid in revision_ids)
1339
2145
        w = _inv_weave or self.inventories
1340
 
        pb = ui.ui_factory.nested_progress_bar()
1341
 
        try:
1342
 
            return self._find_file_ids_from_xml_inventory_lines(
1343
 
                w.iter_lines_added_or_present_in_keys(
1344
 
                    selected_keys, pb=pb),
1345
 
                selected_keys)
1346
 
        finally:
1347
 
            pb.finished()
 
2146
        return self._find_file_ids_from_xml_inventory_lines(
 
2147
            w.iter_lines_added_or_present_in_keys(
 
2148
                selected_keys, pb=None),
 
2149
            selected_keys)
1348
2150
 
1349
2151
    def iter_files_bytes(self, desired_files):
1350
2152
        """Iterate through file versions.
1365
2167
        :param desired_files: a list of (file_id, revision_id, identifier)
1366
2168
            triples
1367
2169
        """
1368
 
        transaction = self.get_transaction()
1369
2170
        text_keys = {}
1370
2171
        for file_id, revision_id, callable_data in desired_files:
1371
2172
            text_keys[(file_id, revision_id)] = callable_data
1372
2173
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
1373
2174
            if record.storage_kind == 'absent':
1374
2175
                raise errors.RevisionNotPresent(record.key, self)
1375
 
            yield text_keys[record.key], record.get_bytes_as('fulltext')
 
2176
            yield text_keys[record.key], record.get_bytes_as('chunked')
1376
2177
 
1377
2178
    def _generate_text_key_index(self, text_key_references=None,
1378
2179
        ancestors=None):
1427
2228
        batch_size = 10 # should be ~150MB on a 55K path tree
1428
2229
        batch_count = len(revision_order) / batch_size + 1
1429
2230
        processed_texts = 0
1430
 
        pb.update("Calculating text parents.", processed_texts, text_count)
 
2231
        pb.update("Calculating text parents", processed_texts, text_count)
1431
2232
        for offset in xrange(batch_count):
1432
2233
            to_query = revision_order[offset * batch_size:(offset + 1) *
1433
2234
                batch_size]
1434
2235
            if not to_query:
1435
2236
                break
1436
 
            for rev_tree in self.revision_trees(to_query):
1437
 
                revision_id = rev_tree.get_revision_id()
 
2237
            for revision_id in to_query:
1438
2238
                parent_ids = ancestors[revision_id]
1439
2239
                for text_key in revision_keys[revision_id]:
1440
 
                    pb.update("Calculating text parents.", processed_texts)
 
2240
                    pb.update("Calculating text parents", processed_texts)
1441
2241
                    processed_texts += 1
1442
2242
                    candidate_parents = []
1443
2243
                    for parent_id in parent_ids:
1459
2259
                            except KeyError:
1460
2260
                                inv = self.revision_tree(parent_id).inventory
1461
2261
                                inventory_cache[parent_id] = inv
1462
 
                            parent_entry = inv._byid.get(text_key[0], None)
 
2262
                            try:
 
2263
                                parent_entry = inv[text_key[0]]
 
2264
                            except (KeyError, errors.NoSuchId):
 
2265
                                parent_entry = None
1463
2266
                            if parent_entry is not None:
1464
2267
                                parent_text_key = (
1465
2268
                                    text_key[0], parent_entry.revision)
1490
2293
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
1491
2294
            'revisions'.  file-id is None unless knit-kind is 'file'.
1492
2295
        """
 
2296
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2297
            yield result
 
2298
        del _files_pb
 
2299
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2300
            yield result
 
2301
 
 
2302
    def _find_file_keys_to_fetch(self, revision_ids, pb):
1493
2303
        # XXX: it's a bit weird to control the inventory weave caching in this
1494
2304
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
1495
2305
        # maybe this generator should explicitly have the contract that it
1502
2312
        count = 0
1503
2313
        num_file_ids = len(file_ids)
1504
2314
        for file_id, altered_versions in file_ids.iteritems():
1505
 
            if _files_pb is not None:
1506
 
                _files_pb.update("fetch texts", count, num_file_ids)
 
2315
            if pb is not None:
 
2316
                pb.update("Fetch texts", count, num_file_ids)
1507
2317
            count += 1
1508
2318
            yield ("file", file_id, altered_versions)
1509
 
        # We're done with the files_pb.  Note that it finished by the caller,
1510
 
        # just as it was created by the caller.
1511
 
        del _files_pb
1512
2319
 
 
2320
    def _find_non_file_keys_to_fetch(self, revision_ids):
1513
2321
        # inventory
1514
2322
        yield ("inventory", None, revision_ids)
1515
2323
 
1516
2324
        # signatures
1517
 
        revisions_with_signatures = set()
1518
 
        for rev_id in revision_ids:
1519
 
            try:
1520
 
                self.get_signature_text(rev_id)
1521
 
            except errors.NoSuchRevision:
1522
 
                # not signed.
1523
 
                pass
1524
 
            else:
1525
 
                revisions_with_signatures.add(rev_id)
 
2325
        # XXX: Note ATM no callers actually pay attention to this return
 
2326
        #      instead they just use the list of revision ids and ignore
 
2327
        #      missing sigs. Consider removing this work entirely
 
2328
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2329
            [(r,) for r in revision_ids]))
 
2330
        revisions_with_signatures = set(
 
2331
            [r for (r,) in revisions_with_signatures])
 
2332
        revisions_with_signatures.intersection_update(revision_ids)
1526
2333
        yield ("signatures", None, revisions_with_signatures)
1527
2334
 
1528
2335
        # revisions
1533
2340
        """Get Inventory object by revision id."""
1534
2341
        return self.iter_inventories([revision_id]).next()
1535
2342
 
1536
 
    def iter_inventories(self, revision_ids):
 
2343
    def iter_inventories(self, revision_ids, ordering=None):
1537
2344
        """Get many inventories by revision_ids.
1538
2345
 
1539
2346
        This will buffer some or all of the texts used in constructing the
1540
2347
        inventories in memory, but will only parse a single inventory at a
1541
2348
        time.
1542
2349
 
 
2350
        :param revision_ids: The expected revision ids of the inventories.
 
2351
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2352
            specified, the order of revision_ids will be preserved (by
 
2353
            buffering if necessary).
1543
2354
        :return: An iterator of inventories.
1544
2355
        """
1545
2356
        if ((None in revision_ids)
1546
2357
            or (_mod_revision.NULL_REVISION in revision_ids)):
1547
2358
            raise ValueError('cannot get null revision inventory')
1548
 
        return self._iter_inventories(revision_ids)
 
2359
        return self._iter_inventories(revision_ids, ordering)
1549
2360
 
1550
 
    def _iter_inventories(self, revision_ids):
 
2361
    def _iter_inventories(self, revision_ids, ordering):
1551
2362
        """single-document based inventory iteration."""
1552
 
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
1553
 
            yield self.deserialise_inventory(revision_id, text)
 
2363
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2364
        for text, revision_id in inv_xmls:
 
2365
            yield self._deserialise_inventory(revision_id, text)
1554
2366
 
1555
 
    def _iter_inventory_xmls(self, revision_ids):
 
2367
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2368
        if ordering is None:
 
2369
            order_as_requested = True
 
2370
            ordering = 'unordered'
 
2371
        else:
 
2372
            order_as_requested = False
1556
2373
        keys = [(revision_id,) for revision_id in revision_ids]
1557
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
1558
 
        texts = {}
 
2374
        if not keys:
 
2375
            return
 
2376
        if order_as_requested:
 
2377
            key_iter = iter(keys)
 
2378
            next_key = key_iter.next()
 
2379
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2380
        text_chunks = {}
1559
2381
        for record in stream:
1560
2382
            if record.storage_kind != 'absent':
1561
 
                texts[record.key] = record.get_bytes_as('fulltext')
 
2383
                chunks = record.get_bytes_as('chunked')
 
2384
                if order_as_requested:
 
2385
                    text_chunks[record.key] = chunks
 
2386
                else:
 
2387
                    yield ''.join(chunks), record.key[-1]
1562
2388
            else:
1563
2389
                raise errors.NoSuchRevision(self, record.key)
1564
 
        for key in keys:
1565
 
            yield texts[key], key[-1]
 
2390
            if order_as_requested:
 
2391
                # Yield as many results as we can while preserving order.
 
2392
                while next_key in text_chunks:
 
2393
                    chunks = text_chunks.pop(next_key)
 
2394
                    yield ''.join(chunks), next_key[-1]
 
2395
                    try:
 
2396
                        next_key = key_iter.next()
 
2397
                    except StopIteration:
 
2398
                        # We still want to fully consume the get_record_stream,
 
2399
                        # just in case it is not actually finished at this point
 
2400
                        next_key = None
 
2401
                        break
1566
2402
 
1567
 
    def deserialise_inventory(self, revision_id, xml):
1568
 
        """Transform the xml into an inventory object. 
 
2403
    def _deserialise_inventory(self, revision_id, xml):
 
2404
        """Transform the xml into an inventory object.
1569
2405
 
1570
2406
        :param revision_id: The expected revision id of the inventory.
1571
2407
        :param xml: A serialised inventory.
1572
2408
        """
1573
 
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
2409
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2410
                    entry_cache=self._inventory_entry_cache,
 
2411
                    return_from_cache=self._safe_to_return_from_cache)
1574
2412
        if result.revision_id != revision_id:
1575
2413
            raise AssertionError('revision id mismatch %s != %s' % (
1576
2414
                result.revision_id, revision_id))
1577
2415
        return result
1578
2416
 
1579
 
    def serialise_inventory(self, inv):
1580
 
        return self._serializer.write_inventory_to_string(inv)
1581
 
 
1582
 
    def _serialise_inventory_to_lines(self, inv):
1583
 
        return self._serializer.write_inventory_to_lines(inv)
1584
 
 
1585
2417
    def get_serializer_format(self):
1586
2418
        return self._serializer.format_num
1587
2419
 
1588
2420
    @needs_read_lock
1589
 
    def get_inventory_xml(self, revision_id):
1590
 
        """Get inventory XML as a file object."""
1591
 
        texts = self._iter_inventory_xmls([revision_id])
 
2421
    def _get_inventory_xml(self, revision_id):
 
2422
        """Get serialized inventory as a string."""
 
2423
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
1592
2424
        try:
1593
2425
            text, revision_id = texts.next()
1594
2426
        except StopIteration:
1595
2427
            raise errors.HistoryMissing(self, 'inventory', revision_id)
1596
2428
        return text
1597
2429
 
1598
 
    @needs_read_lock
1599
 
    def get_inventory_sha1(self, revision_id):
1600
 
        """Return the sha1 hash of the inventory entry
 
2430
    def get_rev_id_for_revno(self, revno, known_pair):
 
2431
        """Return the revision id of a revno, given a later (revno, revid)
 
2432
        pair in the same history.
 
2433
 
 
2434
        :return: if found (True, revid).  If the available history ran out
 
2435
            before reaching the revno, then this returns
 
2436
            (False, (closest_revno, closest_revid)).
1601
2437
        """
1602
 
        return self.get_revision(revision_id).inventory_sha1
 
2438
        known_revno, known_revid = known_pair
 
2439
        partial_history = [known_revid]
 
2440
        distance_from_known = known_revno - revno
 
2441
        if distance_from_known < 0:
 
2442
            raise ValueError(
 
2443
                'requested revno (%d) is later than given known revno (%d)'
 
2444
                % (revno, known_revno))
 
2445
        try:
 
2446
            _iter_for_revno(
 
2447
                self, partial_history, stop_index=distance_from_known)
 
2448
        except errors.RevisionNotPresent, err:
 
2449
            if err.revision_id == known_revid:
 
2450
                # The start revision (known_revid) wasn't found.
 
2451
                raise
 
2452
            # This is a stacked repository with no fallbacks, or a there's a
 
2453
            # left-hand ghost.  Either way, even though the revision named in
 
2454
            # the error isn't in this repo, we know it's the next step in this
 
2455
            # left-hand history.
 
2456
            partial_history.append(err.revision_id)
 
2457
        if len(partial_history) <= distance_from_known:
 
2458
            # Didn't find enough history to get a revid for the revno.
 
2459
            earliest_revno = known_revno - len(partial_history) + 1
 
2460
            return (False, (earliest_revno, partial_history[-1]))
 
2461
        if len(partial_history) - 1 > distance_from_known:
 
2462
            raise AssertionError('_iter_for_revno returned too much history')
 
2463
        return (True, partial_history[-1])
1603
2464
 
1604
2465
    def iter_reverse_revision_history(self, revision_id):
1605
2466
        """Iterate backwards through revision ids in the lefthand history
1612
2473
        while True:
1613
2474
            if next_id in (None, _mod_revision.NULL_REVISION):
1614
2475
                return
 
2476
            try:
 
2477
                parents = graph.get_parent_map([next_id])[next_id]
 
2478
            except KeyError:
 
2479
                raise errors.RevisionNotPresent(next_id, self)
1615
2480
            yield next_id
1616
 
            # Note: The following line may raise KeyError in the event of
1617
 
            # truncated history. We decided not to have a try:except:raise
1618
 
            # RevisionNotPresent here until we see a use for it, because of the
1619
 
            # cost in an inner loop that is by its very nature O(history).
1620
 
            # Robert Collins 20080326
1621
 
            parents = graph.get_parent_map([next_id])[next_id]
1622
2481
            if len(parents) == 0:
1623
2482
                return
1624
2483
            else:
1625
2484
                next_id = parents[0]
1626
2485
 
1627
 
    @needs_read_lock
1628
 
    def get_revision_inventory(self, revision_id):
1629
 
        """Return inventory of a past revision."""
1630
 
        # TODO: Unify this with get_inventory()
1631
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
1632
 
        # must be the same as its revision, so this is trivial.
1633
 
        if revision_id is None:
1634
 
            # This does not make sense: if there is no revision,
1635
 
            # then it is the current tree inventory surely ?!
1636
 
            # and thus get_root_id() is something that looks at the last
1637
 
            # commit on the branch, and the get_root_id is an inventory check.
1638
 
            raise NotImplementedError
1639
 
            # return Inventory(self.get_root_id())
1640
 
        else:
1641
 
            return self.get_inventory(revision_id)
1642
 
 
1643
2486
    def is_shared(self):
1644
2487
        """Return True if this repository is flagged as a shared repository."""
1645
2488
        raise NotImplementedError(self.is_shared)
1659
2502
        for repositories to maintain loaded indices across multiple locks
1660
2503
        by checking inside their implementation of this method to see
1661
2504
        whether their indices are still valid. This depends of course on
1662
 
        the disk format being validatable in this manner.
 
2505
        the disk format being validatable in this manner. This method is
 
2506
        also called by the refresh_data() public interface to cause a refresh
 
2507
        to occur while in a write lock so that data inserted by a smart server
 
2508
        push operation is visible on the client's instance of the physical
 
2509
        repository.
1663
2510
        """
1664
2511
 
1665
2512
    @needs_read_lock
1672
2519
        # TODO: refactor this to use an existing revision object
1673
2520
        # so we don't need to read it in twice.
1674
2521
        if revision_id == _mod_revision.NULL_REVISION:
1675
 
            return RevisionTree(self, Inventory(root_id=None), 
 
2522
            return RevisionTree(self, Inventory(root_id=None),
1676
2523
                                _mod_revision.NULL_REVISION)
1677
2524
        else:
1678
 
            inv = self.get_revision_inventory(revision_id)
 
2525
            inv = self.get_inventory(revision_id)
1679
2526
            return RevisionTree(self, inv, revision_id)
1680
2527
 
1681
2528
    def revision_trees(self, revision_ids):
1682
 
        """Return Tree for a revision on this branch.
 
2529
        """Return Trees for revisions in this repository.
1683
2530
 
1684
 
        `revision_id` may not be None or 'null:'"""
 
2531
        :param revision_ids: a sequence of revision-ids;
 
2532
          a revision-id may not be None or 'null:'
 
2533
        """
1685
2534
        inventories = self.iter_inventories(revision_ids)
1686
2535
        for inv in inventories:
1687
2536
            yield RevisionTree(self, inv, inv.revision_id)
1688
2537
 
 
2538
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2539
        """Return Tree for a revision on this branch with only some files.
 
2540
 
 
2541
        :param revision_ids: a sequence of revision-ids;
 
2542
          a revision-id may not be None or 'null:'
 
2543
        :param file_ids: if not None, the result is filtered
 
2544
          so that only those file-ids, their parents and their
 
2545
          children are included.
 
2546
        """
 
2547
        inventories = self.iter_inventories(revision_ids)
 
2548
        for inv in inventories:
 
2549
            # Should we introduce a FilteredRevisionTree class rather
 
2550
            # than pre-filter the inventory here?
 
2551
            filtered_inv = inv.filter(file_ids)
 
2552
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
2553
 
1689
2554
    @needs_read_lock
1690
2555
    def get_ancestry(self, revision_id, topo_sorted=True):
1691
2556
        """Return a list of revision-ids integrated by a revision.
1692
2557
 
1693
 
        The first element of the list is always None, indicating the origin 
1694
 
        revision.  This might change when we have history horizons, or 
 
2558
        The first element of the list is always None, indicating the origin
 
2559
        revision.  This might change when we have history horizons, or
1695
2560
        perhaps we should have a new API.
1696
 
        
 
2561
 
1697
2562
        This is topologically sorted.
1698
2563
        """
1699
2564
        if _mod_revision.is_null(revision_id):
1716
2581
            keys = tsort.topo_sort(parent_map)
1717
2582
        return [None] + list(keys)
1718
2583
 
1719
 
    def pack(self):
 
2584
    def pack(self, hint=None):
1720
2585
        """Compress the data within the repository.
1721
2586
 
1722
2587
        This operation only makes sense for some repository types. For other
1723
2588
        types it should be a no-op that just returns.
1724
2589
 
1725
2590
        This stub method does not require a lock, but subclasses should use
1726
 
        @needs_write_lock as this is a long running call its reasonable to 
 
2591
        @needs_write_lock as this is a long running call its reasonable to
1727
2592
        implicitly lock for the user.
1728
 
        """
1729
2593
 
1730
 
    @needs_read_lock
1731
 
    @deprecated_method(one_six)
1732
 
    def print_file(self, file, revision_id):
1733
 
        """Print `file` to stdout.
1734
 
        
1735
 
        FIXME RBC 20060125 as John Meinel points out this is a bad api
1736
 
        - it writes to stdout, it assumes that that is valid etc. Fix
1737
 
        by creating a new more flexible convenience function.
 
2594
        :param hint: If not supplied, the whole repository is packed.
 
2595
            If supplied, the repository may use the hint parameter as a
 
2596
            hint for the parts of the repository to pack. A hint can be
 
2597
            obtained from the result of commit_write_group(). Out of
 
2598
            date hints are simply ignored, because concurrent operations
 
2599
            can obsolete them rapidly.
1738
2600
        """
1739
 
        tree = self.revision_tree(revision_id)
1740
 
        # use inventory as it was in that revision
1741
 
        file_id = tree.inventory.path2id(file)
1742
 
        if not file_id:
1743
 
            # TODO: jam 20060427 Write a test for this code path
1744
 
            #       it had a bug in it, and was raising the wrong
1745
 
            #       exception.
1746
 
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
1747
 
        tree.print_file(file_id)
1748
2601
 
1749
2602
    def get_transaction(self):
1750
2603
        return self.control_files.get_transaction()
1751
2604
 
1752
 
    @deprecated_method(one_one)
1753
 
    def get_parents(self, revision_ids):
1754
 
        """See StackedParentsProvider.get_parents"""
1755
 
        parent_map = self.get_parent_map(revision_ids)
1756
 
        return [parent_map.get(r, None) for r in revision_ids]
1757
 
 
1758
2605
    def get_parent_map(self, revision_ids):
1759
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
2606
        """See graph.StackedParentsProvider.get_parent_map"""
1760
2607
        # revisions index works in keys; this just works in revisions
1761
2608
        # therefore wrap and unwrap
1762
2609
        query_keys = []
1771
2618
        for ((revision_id,), parent_keys) in \
1772
2619
                self.revisions.get_parent_map(query_keys).iteritems():
1773
2620
            if parent_keys:
1774
 
                result[revision_id] = tuple(parent_revid
1775
 
                    for (parent_revid,) in parent_keys)
 
2621
                result[revision_id] = tuple([parent_revid
 
2622
                    for (parent_revid,) in parent_keys])
1776
2623
            else:
1777
2624
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1778
2625
        return result
1780
2627
    def _make_parents_provider(self):
1781
2628
        return self
1782
2629
 
 
2630
    @needs_read_lock
 
2631
    def get_known_graph_ancestry(self, revision_ids):
 
2632
        """Return the known graph for a set of revision ids and their ancestors.
 
2633
        """
 
2634
        st = static_tuple.StaticTuple
 
2635
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
 
2636
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
 
2637
        return graph.GraphThunkIdsToKeys(known_graph)
 
2638
 
1783
2639
    def get_graph(self, other_repository=None):
1784
2640
        """Return the graph walker for this repository format"""
1785
2641
        parents_provider = self._make_parents_provider()
1786
2642
        if (other_repository is not None and
1787
2643
            not self.has_same_location(other_repository)):
1788
 
            parents_provider = graph._StackedParentsProvider(
 
2644
            parents_provider = graph.StackedParentsProvider(
1789
2645
                [parents_provider, other_repository._make_parents_provider()])
1790
2646
        return graph.Graph(parents_provider)
1791
2647
 
1792
 
    def _get_versioned_file_checker(self):
1793
 
        """Return an object suitable for checking versioned files."""
1794
 
        return _VersionedFileChecker(self)
 
2648
    def _get_versioned_file_checker(self, text_key_references=None,
 
2649
        ancestors=None):
 
2650
        """Return an object suitable for checking versioned files.
 
2651
        
 
2652
        :param text_key_references: if non-None, an already built
 
2653
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2654
            to whether they were referred to by the inventory of the
 
2655
            revision_id that they contain. If None, this will be
 
2656
            calculated.
 
2657
        :param ancestors: Optional result from
 
2658
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2659
            available.
 
2660
        """
 
2661
        return _VersionedFileChecker(self,
 
2662
            text_key_references=text_key_references, ancestors=ancestors)
1795
2663
 
1796
2664
    def revision_ids_to_search_result(self, result_set):
1797
2665
        """Convert a set of revision ids to a graph SearchResult."""
1817
2685
                          working trees.
1818
2686
        """
1819
2687
        raise NotImplementedError(self.set_make_working_trees)
1820
 
    
 
2688
 
1821
2689
    def make_working_trees(self):
1822
2690
        """Returns the policy for making working trees on new branches."""
1823
2691
        raise NotImplementedError(self.make_working_trees)
1847
2715
        return record.get_bytes_as('fulltext')
1848
2716
 
1849
2717
    @needs_read_lock
1850
 
    def check(self, revision_ids=None):
 
2718
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1851
2719
        """Check consistency of all history of given revision_ids.
1852
2720
 
1853
2721
        Different repository implementations should override _check().
1854
2722
 
1855
2723
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1856
2724
             will be checked.  Typically the last revision_id of a branch.
 
2725
        :param callback_refs: A dict of check-refs to resolve and callback
 
2726
            the check/_check method on the items listed as wanting the ref.
 
2727
            see bzrlib.check.
 
2728
        :param check_repo: If False do not check the repository contents, just 
 
2729
            calculate the data callback_refs requires and call them back.
1857
2730
        """
1858
 
        return self._check(revision_ids)
 
2731
        return self._check(revision_ids, callback_refs=callback_refs,
 
2732
            check_repo=check_repo)
1859
2733
 
1860
 
    def _check(self, revision_ids):
1861
 
        result = check.Check(self)
1862
 
        result.check()
 
2734
    def _check(self, revision_ids, callback_refs, check_repo):
 
2735
        result = check.Check(self, check_repo=check_repo)
 
2736
        result.check(callback_refs)
1863
2737
        return result
1864
2738
 
1865
 
    def _warn_if_deprecated(self):
 
2739
    def _warn_if_deprecated(self, branch=None):
1866
2740
        global _deprecation_warning_done
1867
2741
        if _deprecation_warning_done:
1868
2742
            return
1869
 
        _deprecation_warning_done = True
1870
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
1871
 
                % (self._format, self.bzrdir.transport.base))
 
2743
        try:
 
2744
            if branch is None:
 
2745
                conf = config.GlobalConfig()
 
2746
            else:
 
2747
                conf = branch.get_config()
 
2748
            if conf.suppress_warning('format_deprecation'):
 
2749
                return
 
2750
            warning("Format %s for %s is deprecated -"
 
2751
                    " please use 'bzr upgrade' to get better performance"
 
2752
                    % (self._format, self.bzrdir.transport.base))
 
2753
        finally:
 
2754
            _deprecation_warning_done = True
1872
2755
 
1873
2756
    def supports_rich_root(self):
1874
2757
        return self._format.rich_root_data
1888
2771
                    revision_id.decode('ascii')
1889
2772
                except UnicodeDecodeError:
1890
2773
                    raise errors.NonAsciiRevisionId(method, self)
1891
 
    
 
2774
 
1892
2775
    def revision_graph_can_have_wrong_parents(self):
1893
2776
        """Is it possible for this repository to have a revision graph with
1894
2777
        incorrect parents?
1948
2831
    """
1949
2832
    repository.start_write_group()
1950
2833
    try:
 
2834
        inventory_cache = lru_cache.LRUCache(10)
1951
2835
        for n, (revision, revision_tree, signature) in enumerate(iterable):
1952
 
            _install_revision(repository, revision, revision_tree, signature)
 
2836
            _install_revision(repository, revision, revision_tree, signature,
 
2837
                inventory_cache)
1953
2838
            if pb is not None:
1954
2839
                pb.update('Transferring revisions', n + 1, num_revisions)
1955
2840
    except:
1959
2844
        repository.commit_write_group()
1960
2845
 
1961
2846
 
1962
 
def _install_revision(repository, rev, revision_tree, signature):
 
2847
def _install_revision(repository, rev, revision_tree, signature,
 
2848
    inventory_cache):
1963
2849
    """Install all revision data into a repository."""
1964
2850
    present_parents = []
1965
2851
    parent_trees = {}
2002
2888
        repository.texts.add_lines(text_key, text_parents, lines)
2003
2889
    try:
2004
2890
        # install the inventory
2005
 
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
2891
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2892
            # Cache this inventory
 
2893
            inventory_cache[rev.revision_id] = inv
 
2894
            try:
 
2895
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2896
            except KeyError:
 
2897
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2898
            else:
 
2899
                delta = inv._make_delta(basis_inv)
 
2900
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2901
                    rev.revision_id, present_parents)
 
2902
        else:
 
2903
            repository.add_inventory(rev.revision_id, inv, present_parents)
2006
2904
    except errors.RevisionAlreadyPresent:
2007
2905
        pass
2008
2906
    if signature is not None:
2012
2910
 
2013
2911
class MetaDirRepository(Repository):
2014
2912
    """Repositories in the new meta-dir layout.
2015
 
    
 
2913
 
2016
2914
    :ivar _transport: Transport for access to repository control files,
2017
2915
        typically pointing to .bzr/repository.
2018
2916
    """
2043
2941
        else:
2044
2942
            self._transport.put_bytes('no-working-trees', '',
2045
2943
                mode=self.bzrdir._get_file_mode())
2046
 
    
 
2944
 
2047
2945
    def make_working_trees(self):
2048
2946
        """Returns the policy for making working trees on new branches."""
2049
2947
        return not self._transport.has('no-working-trees')
2057
2955
            control_files)
2058
2956
 
2059
2957
 
2060
 
class RepositoryFormatRegistry(registry.Registry):
2061
 
    """Registry of RepositoryFormats."""
2062
 
 
2063
 
    def get(self, format_string):
2064
 
        r = registry.Registry.get(self, format_string)
2065
 
        if callable(r):
2066
 
            r = r()
2067
 
        return r
2068
 
    
2069
 
 
2070
 
format_registry = RepositoryFormatRegistry()
2071
 
"""Registry of formats, indexed by their identifying format string.
 
2958
network_format_registry = registry.FormatRegistry()
 
2959
"""Registry of formats indexed by their network name.
 
2960
 
 
2961
The network name for a repository format is an identifier that can be used when
 
2962
referring to formats with smart server operations. See
 
2963
RepositoryFormat.network_name() for more detail.
 
2964
"""
 
2965
 
 
2966
 
 
2967
format_registry = registry.FormatRegistry(network_format_registry)
 
2968
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2072
2969
 
2073
2970
This can contain either format instances themselves, or classes/factories that
2074
2971
can be called to obtain one.
2081
2978
class RepositoryFormat(object):
2082
2979
    """A repository format.
2083
2980
 
2084
 
    Formats provide three things:
 
2981
    Formats provide four things:
2085
2982
     * An initialization routine to construct repository data on disk.
2086
 
     * a format string which is used when the BzrDir supports versioned
2087
 
       children.
 
2983
     * a optional format string which is used when the BzrDir supports
 
2984
       versioned children.
2088
2985
     * an open routine which returns a Repository instance.
 
2986
     * A network name for referring to the format in smart server RPC
 
2987
       methods.
2089
2988
 
2090
2989
    There is one and only one Format subclass for each on-disk format. But
2091
2990
    there can be one Repository subclass that is used for several different
2092
2991
    formats. The _format attribute on a Repository instance can be used to
2093
2992
    determine the disk format.
2094
2993
 
2095
 
    Formats are placed in an dict by their format string for reference 
2096
 
    during opening. These should be subclasses of RepositoryFormat
2097
 
    for consistency.
 
2994
    Formats are placed in a registry by their format string for reference
 
2995
    during opening. These should be subclasses of RepositoryFormat for
 
2996
    consistency.
2098
2997
 
2099
2998
    Once a format is deprecated, just deprecate the initialize and open
2100
 
    methods on the format class. Do not deprecate the object, as the 
2101
 
    object will be created every system load.
 
2999
    methods on the format class. Do not deprecate the object, as the
 
3000
    object may be created even when a repository instance hasn't been
 
3001
    created.
2102
3002
 
2103
3003
    Common instance attributes:
2104
3004
    _matchingbzrdir - the bzrdir format that the repository format was
2113
3013
    # Can this repository be given external locations to lookup additional
2114
3014
    # data. Set to True or False in derived classes.
2115
3015
    supports_external_lookups = None
 
3016
    # Does this format support CHK bytestring lookups. Set to True or False in
 
3017
    # derived classes.
 
3018
    supports_chks = None
 
3019
    # Should commit add an inventory, or an inventory delta to the repository.
 
3020
    _commit_inv_deltas = True
 
3021
    # What order should fetch operations request streams in?
 
3022
    # The default is unordered as that is the cheapest for an origin to
 
3023
    # provide.
 
3024
    _fetch_order = 'unordered'
 
3025
    # Does this repository format use deltas that can be fetched as-deltas ?
 
3026
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
3027
    # We default to False, which will ensure that enough data to get
 
3028
    # a full text out of any fetch stream will be grabbed.
 
3029
    _fetch_uses_deltas = False
 
3030
    # Should fetch trigger a reconcile after the fetch? Only needed for
 
3031
    # some repository formats that can suffer internal inconsistencies.
 
3032
    _fetch_reconcile = False
 
3033
    # Does this format have < O(tree_size) delta generation. Used to hint what
 
3034
    # code path for commit, amongst other things.
 
3035
    fast_deltas = None
 
3036
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3037
    # (so if there is one pack, the operation can still proceed because it may
 
3038
    # help), and for fetching when data won't have come from the same
 
3039
    # compressor.
 
3040
    pack_compresses = False
 
3041
    # Does the repository inventory storage understand references to trees?
 
3042
    supports_tree_reference = None
 
3043
    # Is the format experimental ?
 
3044
    experimental = False
2116
3045
 
2117
 
    def __str__(self):
2118
 
        return "<%s>" % self.__class__.__name__
 
3046
    def __repr__(self):
 
3047
        return "%s()" % self.__class__.__name__
2119
3048
 
2120
3049
    def __eq__(self, other):
2121
3050
        # format objects are generally stateless
2127
3056
    @classmethod
2128
3057
    def find_format(klass, a_bzrdir):
2129
3058
        """Return the format for the repository object in a_bzrdir.
2130
 
        
 
3059
 
2131
3060
        This is used by bzr native formats that have a "format" file in
2132
 
        the repository.  Other methods may be used by different types of 
 
3061
        the repository.  Other methods may be used by different types of
2133
3062
        control directory.
2134
3063
        """
2135
3064
        try:
2136
3065
            transport = a_bzrdir.get_repository_transport(None)
2137
 
            format_string = transport.get("format").read()
 
3066
            format_string = transport.get_bytes("format")
2138
3067
            return format_registry.get(format_string)
2139
3068
        except errors.NoSuchFile:
2140
3069
            raise errors.NoRepositoryPresent(a_bzrdir)
2149
3078
    @classmethod
2150
3079
    def unregister_format(klass, format):
2151
3080
        format_registry.remove(format.get_format_string())
2152
 
    
 
3081
 
2153
3082
    @classmethod
2154
3083
    def get_default_format(klass):
2155
3084
        """Return the current default format."""
2158
3087
 
2159
3088
    def get_format_string(self):
2160
3089
        """Return the ASCII format string that identifies this format.
2161
 
        
2162
 
        Note that in pre format ?? repositories the format string is 
 
3090
 
 
3091
        Note that in pre format ?? repositories the format string is
2163
3092
        not permitted nor written to disk.
2164
3093
        """
2165
3094
        raise NotImplementedError(self.get_format_string)
2196
3125
        :param a_bzrdir: The bzrdir to put the new repository in it.
2197
3126
        :param shared: The repository should be initialized as a sharable one.
2198
3127
        :returns: The new repository object.
2199
 
        
 
3128
 
2200
3129
        This may raise UninitializableFormat if shared repository are not
2201
3130
        compatible the a_bzrdir.
2202
3131
        """
2206
3135
        """Is this format supported?
2207
3136
 
2208
3137
        Supported formats must be initializable and openable.
2209
 
        Unsupported formats may not support initialization or committing or 
 
3138
        Unsupported formats may not support initialization or committing or
2210
3139
        some other features depending on the reason for not being supported.
2211
3140
        """
2212
3141
        return True
2213
3142
 
 
3143
    def network_name(self):
 
3144
        """A simple byte string uniquely identifying this format for RPC calls.
 
3145
 
 
3146
        MetaDir repository formats use their disk format string to identify the
 
3147
        repository over the wire. All in one formats such as bzr < 0.8, and
 
3148
        foreign formats like svn/git and hg should use some marker which is
 
3149
        unique and immutable.
 
3150
        """
 
3151
        raise NotImplementedError(self.network_name)
 
3152
 
2214
3153
    def check_conversion_target(self, target_format):
2215
 
        raise NotImplementedError(self.check_conversion_target)
 
3154
        if self.rich_root_data and not target_format.rich_root_data:
 
3155
            raise errors.BadConversionTarget(
 
3156
                'Does not support rich root data.', target_format,
 
3157
                from_format=self)
 
3158
        if (self.supports_tree_reference and 
 
3159
            not getattr(target_format, 'supports_tree_reference', False)):
 
3160
            raise errors.BadConversionTarget(
 
3161
                'Does not support nested trees', target_format,
 
3162
                from_format=self)
2216
3163
 
2217
3164
    def open(self, a_bzrdir, _found=False):
2218
3165
        """Return an instance of this format for the bzrdir a_bzrdir.
2219
 
        
 
3166
 
2220
3167
        _found is a private parameter, do not use it.
2221
3168
        """
2222
3169
        raise NotImplementedError(self.open)
2228
3175
    rich_root_data = False
2229
3176
    supports_tree_reference = False
2230
3177
    supports_external_lookups = False
2231
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
3178
 
 
3179
    @property
 
3180
    def _matchingbzrdir(self):
 
3181
        matching = bzrdir.BzrDirMetaFormat1()
 
3182
        matching.repository_format = self
 
3183
        return matching
2232
3184
 
2233
3185
    def __init__(self):
2234
3186
        super(MetaDirRepositoryFormat, self).__init__()
2261
3213
        finally:
2262
3214
            control_files.unlock()
2263
3215
 
2264
 
 
2265
 
# formats which have no format string are not discoverable
2266
 
# and not independently creatable, so are not registered.  They're 
 
3216
    def network_name(self):
 
3217
        """Metadir formats have matching disk and network format strings."""
 
3218
        return self.get_format_string()
 
3219
 
 
3220
 
 
3221
# Pre-0.8 formats that don't have a disk format string (because they are
 
3222
# versioned by the matching control directory). We use the control directories
 
3223
# disk format string as a key for the network_name because they meet the
 
3224
# constraints (simple string, unique, immutable).
 
3225
network_format_registry.register_lazy(
 
3226
    "Bazaar-NG branch, format 5\n",
 
3227
    'bzrlib.repofmt.weaverepo',
 
3228
    'RepositoryFormat5',
 
3229
)
 
3230
network_format_registry.register_lazy(
 
3231
    "Bazaar-NG branch, format 6\n",
 
3232
    'bzrlib.repofmt.weaverepo',
 
3233
    'RepositoryFormat6',
 
3234
)
 
3235
 
 
3236
# formats which have no format string are not discoverable or independently
 
3237
# creatable on disk, so are not registered in format_registry.  They're
2267
3238
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
2268
3239
# needed, it's constructed directly by the BzrDir.  Non-native formats where
2269
3240
# the repository is not separately opened are similar.
2325
3296
    'bzrlib.repofmt.pack_repo',
2326
3297
    'RepositoryFormatKnitPack5RichRootBroken',
2327
3298
    )
 
3299
format_registry.register_lazy(
 
3300
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
3301
    'bzrlib.repofmt.pack_repo',
 
3302
    'RepositoryFormatKnitPack6',
 
3303
    )
 
3304
format_registry.register_lazy(
 
3305
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
3306
    'bzrlib.repofmt.pack_repo',
 
3307
    'RepositoryFormatKnitPack6RichRoot',
 
3308
    )
2328
3309
 
2329
 
# Development formats. 
2330
 
# 1.7->1.8 go below here
2331
 
format_registry.register_lazy(
2332
 
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
2333
 
    'bzrlib.repofmt.pack_repo',
2334
 
    'RepositoryFormatPackDevelopment2',
2335
 
    )
 
3310
# Development formats.
 
3311
# Obsolete but kept pending a CHK based subtree format.
2336
3312
format_registry.register_lazy(
2337
3313
    ("Bazaar development format 2 with subtree support "
2338
3314
        "(needs bzr.dev from before 1.8)\n"),
2340
3316
    'RepositoryFormatPackDevelopment2Subtree',
2341
3317
    )
2342
3318
 
 
3319
# 1.14->1.16 go below here
 
3320
format_registry.register_lazy(
 
3321
    'Bazaar development format - group compression and chk inventory'
 
3322
        ' (needs bzr.dev from 1.14)\n',
 
3323
    'bzrlib.repofmt.groupcompress_repo',
 
3324
    'RepositoryFormatCHK1',
 
3325
    )
 
3326
 
 
3327
format_registry.register_lazy(
 
3328
    'Bazaar development format - chk repository with bencode revision '
 
3329
        'serialization (needs bzr.dev from 1.16)\n',
 
3330
    'bzrlib.repofmt.groupcompress_repo',
 
3331
    'RepositoryFormatCHK2',
 
3332
    )
 
3333
format_registry.register_lazy(
 
3334
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3335
    'bzrlib.repofmt.groupcompress_repo',
 
3336
    'RepositoryFormat2a',
 
3337
    )
 
3338
 
2343
3339
 
2344
3340
class InterRepository(InterObject):
2345
3341
    """This class represents operations taking place between two repositories.
2346
3342
 
2347
3343
    Its instances have methods like copy_content and fetch, and contain
2348
 
    references to the source and target repositories these operations can be 
 
3344
    references to the source and target repositories these operations can be
2349
3345
    carried out on.
2350
3346
 
2351
3347
    Often we will provide convenience methods on 'repository' which carry out
2353
3349
    InterRepository.get(other).method_name(parameters).
2354
3350
    """
2355
3351
 
 
3352
    _walk_to_common_revisions_batch_size = 50
2356
3353
    _optimisers = []
2357
3354
    """The available optimised InterRepository types."""
2358
3355
 
 
3356
    @needs_write_lock
2359
3357
    def copy_content(self, revision_id=None):
2360
 
        raise NotImplementedError(self.copy_content)
2361
 
 
2362
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3358
        """Make a complete copy of the content in self into destination.
 
3359
 
 
3360
        This is a destructive operation! Do not use it on existing
 
3361
        repositories.
 
3362
 
 
3363
        :param revision_id: Only copy the content needed to construct
 
3364
                            revision_id and its parents.
 
3365
        """
 
3366
        try:
 
3367
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3368
        except NotImplementedError:
 
3369
            pass
 
3370
        self.target.fetch(self.source, revision_id=revision_id)
 
3371
 
 
3372
    @needs_write_lock
 
3373
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3374
            fetch_spec=None):
2363
3375
        """Fetch the content required to construct revision_id.
2364
3376
 
2365
3377
        The content is copied from self.source to self.target.
2366
3378
 
2367
3379
        :param revision_id: if None all content is copied, if NULL_REVISION no
2368
3380
                            content is copied.
2369
 
        :param pb: optional progress bar to use for progress reports. If not
2370
 
                   provided a default one will be created.
2371
 
 
2372
 
        :returns: (copied_revision_count, failures).
 
3381
        :param pb: ignored.
 
3382
        :return: None.
2373
3383
        """
2374
 
        # Normally we should find a specific InterRepository subclass to do
2375
 
        # the fetch; if nothing else then at least InterSameDataRepository.
2376
 
        # If none of them is suitable it looks like fetching is not possible;
2377
 
        # we try to give a good message why.  _assert_same_model will probably
2378
 
        # give a helpful message; otherwise a generic one.
2379
 
        self._assert_same_model(self.source, self.target)
2380
 
        raise errors.IncompatibleRepositories(self.source, self.target,
2381
 
            "no suitableInterRepository found")
 
3384
        ui.ui_factory.warn_experimental_format_fetch(self)
 
3385
        from bzrlib.fetch import RepoFetcher
 
3386
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3387
        if self.source._format.network_name() != self.target._format.network_name():
 
3388
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
3389
                from_format=self.source._format,
 
3390
                to_format=self.target._format)
 
3391
        f = RepoFetcher(to_repository=self.target,
 
3392
                               from_repository=self.source,
 
3393
                               last_revision=revision_id,
 
3394
                               fetch_spec=fetch_spec,
 
3395
                               find_ghosts=find_ghosts)
2382
3396
 
2383
3397
    def _walk_to_common_revisions(self, revision_ids):
2384
3398
        """Walk out from revision_ids in source to revisions target has.
2388
3402
        """
2389
3403
        target_graph = self.target.get_graph()
2390
3404
        revision_ids = frozenset(revision_ids)
2391
 
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
2392
 
            return graph.SearchResult(revision_ids, set(), 0, set())
2393
3405
        missing_revs = set()
2394
3406
        source_graph = self.source.get_graph()
2395
3407
        # ensure we don't pay silly lookup costs.
2396
3408
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
2397
3409
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3410
        searcher_exhausted = False
2398
3411
        while True:
2399
 
            try:
2400
 
                next_revs, ghosts = searcher.next_with_ghosts()
2401
 
            except StopIteration:
2402
 
                break
2403
 
            if revision_ids.intersection(ghosts):
2404
 
                absent_ids = set(revision_ids.intersection(ghosts))
2405
 
                # If all absent_ids are present in target, no error is needed.
2406
 
                absent_ids.difference_update(
2407
 
                    set(target_graph.get_parent_map(absent_ids)))
2408
 
                if absent_ids:
2409
 
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
2410
 
            # we don't care about other ghosts as we can't fetch them and
 
3412
            next_revs = set()
 
3413
            ghosts = set()
 
3414
            # Iterate the searcher until we have enough next_revs
 
3415
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3416
                try:
 
3417
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3418
                    next_revs.update(next_revs_part)
 
3419
                    ghosts.update(ghosts_part)
 
3420
                except StopIteration:
 
3421
                    searcher_exhausted = True
 
3422
                    break
 
3423
            # If there are ghosts in the source graph, and the caller asked for
 
3424
            # them, make sure that they are present in the target.
 
3425
            # We don't care about other ghosts as we can't fetch them and
2411
3426
            # haven't been asked to.
2412
 
            next_revs = set(next_revs)
2413
 
            # we always have NULL_REVISION present.
2414
 
            have_revs = set(target_graph.get_parent_map(next_revs)).union(null_set)
2415
 
            missing_revs.update(next_revs - have_revs)
2416
 
            searcher.stop_searching_any(have_revs)
 
3427
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3428
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3429
            if revs_to_get:
 
3430
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3431
                # we always have NULL_REVISION present.
 
3432
                have_revs = have_revs.union(null_set)
 
3433
                # Check if the target is missing any ghosts we need.
 
3434
                ghosts_to_check.difference_update(have_revs)
 
3435
                if ghosts_to_check:
 
3436
                    # One of the caller's revision_ids is a ghost in both the
 
3437
                    # source and the target.
 
3438
                    raise errors.NoSuchRevision(
 
3439
                        self.source, ghosts_to_check.pop())
 
3440
                missing_revs.update(next_revs - have_revs)
 
3441
                # Because we may have walked past the original stop point, make
 
3442
                # sure everything is stopped
 
3443
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3444
                searcher.stop_searching_any(stop_revs)
 
3445
            if searcher_exhausted:
 
3446
                break
2417
3447
        return searcher.get_result()
2418
 
   
2419
 
    @deprecated_method(one_two)
2420
 
    @needs_read_lock
2421
 
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
2422
 
        """Return the revision ids that source has that target does not.
2423
 
        
2424
 
        These are returned in topological order.
2425
 
 
2426
 
        :param revision_id: only return revision ids included by this
2427
 
                            revision_id.
2428
 
        :param find_ghosts: If True find missing revisions in deep history
2429
 
            rather than just finding the surface difference.
2430
 
        """
2431
 
        return list(self.search_missing_revision_ids(
2432
 
            revision_id, find_ghosts).get_keys())
2433
3448
 
2434
3449
    @needs_read_lock
2435
3450
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2436
3451
        """Return the revision ids that source has that target does not.
2437
 
        
 
3452
 
2438
3453
        :param revision_id: only return revision ids included by this
2439
3454
                            revision_id.
2440
3455
        :param find_ghosts: If True find missing revisions in deep history
2459
3474
    @staticmethod
2460
3475
    def _same_model(source, target):
2461
3476
        """True if source and target have the same data representation.
2462
 
        
 
3477
 
2463
3478
        Note: this is always called on the base class; overriding it in a
2464
3479
        subclass will have no effect.
2465
3480
        """
2483
3498
 
2484
3499
class InterSameDataRepository(InterRepository):
2485
3500
    """Code for converting between repositories that represent the same data.
2486
 
    
 
3501
 
2487
3502
    Data format and model must match for this to work.
2488
3503
    """
2489
3504
 
2490
3505
    @classmethod
2491
3506
    def _get_repo_format_to_test(self):
2492
3507
        """Repository format for testing with.
2493
 
        
 
3508
 
2494
3509
        InterSameData can pull from subtree to subtree and from non-subtree to
2495
3510
        non-subtree, so we test this with the richest repository format.
2496
3511
        """
2501
3516
    def is_compatible(source, target):
2502
3517
        return InterRepository._same_model(source, target)
2503
3518
 
2504
 
    @needs_write_lock
2505
 
    def copy_content(self, revision_id=None):
2506
 
        """Make a complete copy of the content in self into destination.
2507
 
 
2508
 
        This copies both the repository's revision data, and configuration information
2509
 
        such as the make_working_trees setting.
2510
 
        
2511
 
        This is a destructive operation! Do not use it on existing 
2512
 
        repositories.
2513
 
 
2514
 
        :param revision_id: Only copy the content needed to construct
2515
 
                            revision_id and its parents.
2516
 
        """
2517
 
        try:
2518
 
            self.target.set_make_working_trees(self.source.make_working_trees())
2519
 
        except NotImplementedError:
2520
 
            pass
2521
 
        # but don't bother fetching if we have the needed data now.
2522
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
2523
 
            self.target.has_revision(revision_id)):
2524
 
            return
2525
 
        self.target.fetch(self.source, revision_id=revision_id)
2526
 
 
2527
 
    @needs_write_lock
2528
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2529
 
        """See InterRepository.fetch()."""
2530
 
        from bzrlib.fetch import RepoFetcher
2531
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2532
 
               self.source, self.source._format, self.target,
2533
 
               self.target._format)
2534
 
        f = RepoFetcher(to_repository=self.target,
2535
 
                               from_repository=self.source,
2536
 
                               last_revision=revision_id,
2537
 
                               pb=pb, find_ghosts=find_ghosts)
2538
 
        return f.count_copied, f.failed_revisions
2539
 
 
2540
3519
 
2541
3520
class InterWeaveRepo(InterSameDataRepository):
2542
3521
    """Optimised code paths between Weave based repositories.
2543
 
    
 
3522
 
2544
3523
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
2545
3524
    implemented lazy inter-object optimisation.
2546
3525
    """
2553
3532
    @staticmethod
2554
3533
    def is_compatible(source, target):
2555
3534
        """Be compatible with known Weave formats.
2556
 
        
 
3535
 
2557
3536
        We don't test for the stores being of specific types because that
2558
 
        could lead to confusing results, and there is no need to be 
 
3537
        could lead to confusing results, and there is no need to be
2559
3538
        overly general.
2560
3539
        """
2561
3540
        from bzrlib.repofmt.weaverepo import (
2572
3551
                                                RepositoryFormat7)))
2573
3552
        except AttributeError:
2574
3553
            return False
2575
 
    
 
3554
 
2576
3555
    @needs_write_lock
2577
3556
    def copy_content(self, revision_id=None):
2578
3557
        """See InterRepository.copy_content()."""
2588
3567
                self.target.texts.insert_record_stream(
2589
3568
                    self.source.texts.get_record_stream(
2590
3569
                        self.source.texts.keys(), 'topological', False))
2591
 
                pb.update('copying inventory', 0, 1)
 
3570
                pb.update('Copying inventory', 0, 1)
2592
3571
                self.target.inventories.insert_record_stream(
2593
3572
                    self.source.inventories.get_record_stream(
2594
3573
                        self.source.inventories.keys(), 'topological', False))
2605
3584
        else:
2606
3585
            self.target.fetch(self.source, revision_id=revision_id)
2607
3586
 
2608
 
    @needs_write_lock
2609
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2610
 
        """See InterRepository.fetch()."""
2611
 
        from bzrlib.fetch import RepoFetcher
2612
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2613
 
               self.source, self.source._format, self.target, self.target._format)
2614
 
        f = RepoFetcher(to_repository=self.target,
2615
 
                               from_repository=self.source,
2616
 
                               last_revision=revision_id,
2617
 
                               pb=pb, find_ghosts=find_ghosts)
2618
 
        return f.count_copied, f.failed_revisions
2619
 
 
2620
3587
    @needs_read_lock
2621
3588
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2622
3589
        """See InterRepository.missing_revision_ids()."""
2623
3590
        # we want all revisions to satisfy revision_id in source.
2624
3591
        # but we don't want to stat every file here and there.
2625
 
        # we want then, all revisions other needs to satisfy revision_id 
 
3592
        # we want then, all revisions other needs to satisfy revision_id
2626
3593
        # checked, but not those that we have locally.
2627
 
        # so the first thing is to get a subset of the revisions to 
 
3594
        # so the first thing is to get a subset of the revisions to
2628
3595
        # satisfy revision_id in source, and then eliminate those that
2629
 
        # we do already have. 
2630
 
        # this is slow on high latency connection to self, but as as this
2631
 
        # disk format scales terribly for push anyway due to rewriting 
 
3596
        # we do already have.
 
3597
        # this is slow on high latency connection to self, but as this
 
3598
        # disk format scales terribly for push anyway due to rewriting
2632
3599
        # inventory.weave, this is considered acceptable.
2633
3600
        # - RBC 20060209
2634
3601
        if revision_id is not None:
2654
3621
            # and the tip revision was validated by get_ancestry.
2655
3622
            result_set = required_revisions
2656
3623
        else:
2657
 
            # if we just grabbed the possibly available ids, then 
 
3624
            # if we just grabbed the possibly available ids, then
2658
3625
            # we only have an estimate of whats available and need to validate
2659
3626
            # that against the revision records.
2660
3627
            result_set = set(
2673
3640
    @staticmethod
2674
3641
    def is_compatible(source, target):
2675
3642
        """Be compatible with known Knit formats.
2676
 
        
 
3643
 
2677
3644
        We don't test for the stores being of specific types because that
2678
 
        could lead to confusing results, and there is no need to be 
 
3645
        could lead to confusing results, and there is no need to be
2679
3646
        overly general.
2680
3647
        """
2681
3648
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
2686
3653
            return False
2687
3654
        return are_knits and InterRepository._same_model(source, target)
2688
3655
 
2689
 
    @needs_write_lock
2690
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2691
 
        """See InterRepository.fetch()."""
2692
 
        from bzrlib.fetch import RepoFetcher
2693
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2694
 
               self.source, self.source._format, self.target, self.target._format)
2695
 
        f = RepoFetcher(to_repository=self.target,
2696
 
                            from_repository=self.source,
2697
 
                            last_revision=revision_id,
2698
 
                            pb=pb, find_ghosts=find_ghosts)
2699
 
        return f.count_copied, f.failed_revisions
2700
 
 
2701
3656
    @needs_read_lock
2702
3657
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2703
3658
        """See InterRepository.missing_revision_ids()."""
2724
3679
            # and the tip revision was validated by get_ancestry.
2725
3680
            result_set = required_revisions
2726
3681
        else:
2727
 
            # if we just grabbed the possibly available ids, then 
 
3682
            # if we just grabbed the possibly available ids, then
2728
3683
            # we only have an estimate of whats available and need to validate
2729
3684
            # that against the revision records.
2730
3685
            result_set = set(
2732
3687
        return self.source.revision_ids_to_search_result(result_set)
2733
3688
 
2734
3689
 
2735
 
class InterPackRepo(InterSameDataRepository):
2736
 
    """Optimised code paths between Pack based repositories."""
2737
 
 
2738
 
    @classmethod
2739
 
    def _get_repo_format_to_test(self):
2740
 
        from bzrlib.repofmt import pack_repo
2741
 
        return pack_repo.RepositoryFormatKnitPack1()
2742
 
 
2743
 
    @staticmethod
2744
 
    def is_compatible(source, target):
2745
 
        """Be compatible with known Pack formats.
2746
 
        
2747
 
        We don't test for the stores being of specific types because that
2748
 
        could lead to confusing results, and there is no need to be 
2749
 
        overly general.
2750
 
        """
2751
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
2752
 
        try:
2753
 
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
2754
 
                isinstance(target._format, RepositoryFormatPack))
2755
 
        except AttributeError:
2756
 
            return False
2757
 
        return are_packs and InterRepository._same_model(source, target)
2758
 
 
2759
 
    @needs_write_lock
2760
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2761
 
        """See InterRepository.fetch()."""
2762
 
        if (len(self.source._fallback_repositories) > 0 or
2763
 
            len(self.target._fallback_repositories) > 0):
2764
 
            # The pack layer is not aware of fallback repositories, so when
2765
 
            # fetching from a stacked repository or into a stacked repository
2766
 
            # we use the generic fetch logic which uses the VersionedFiles
2767
 
            # attributes on repository.
2768
 
            from bzrlib.fetch import RepoFetcher
2769
 
            fetcher = RepoFetcher(self.target, self.source, revision_id,
2770
 
                                  pb, find_ghosts)
2771
 
            return fetcher.count_copied, fetcher.failed_revisions
2772
 
        from bzrlib.repofmt.pack_repo import Packer
2773
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2774
 
               self.source, self.source._format, self.target, self.target._format)
2775
 
        self.count_copied = 0
2776
 
        if revision_id is None:
2777
 
            # TODO:
2778
 
            # everything to do - use pack logic
2779
 
            # to fetch from all packs to one without
2780
 
            # inventory parsing etc, IFF nothing to be copied is in the target.
2781
 
            # till then:
2782
 
            source_revision_ids = frozenset(self.source.all_revision_ids())
2783
 
            revision_ids = source_revision_ids - \
2784
 
                frozenset(self.target.get_parent_map(source_revision_ids))
2785
 
            revision_keys = [(revid,) for revid in revision_ids]
2786
 
            index = self.target._pack_collection.revision_index.combined_index
2787
 
            present_revision_ids = set(item[1][0] for item in
2788
 
                index.iter_entries(revision_keys))
2789
 
            revision_ids = set(revision_ids) - present_revision_ids
2790
 
            # implementing the TODO will involve:
2791
 
            # - detecting when all of a pack is selected
2792
 
            # - avoiding as much as possible pre-selection, so the
2793
 
            # more-core routines such as create_pack_from_packs can filter in
2794
 
            # a just-in-time fashion. (though having a HEADS list on a
2795
 
            # repository might make this a lot easier, because we could
2796
 
            # sensibly detect 'new revisions' without doing a full index scan.
2797
 
        elif _mod_revision.is_null(revision_id):
2798
 
            # nothing to do:
2799
 
            return (0, [])
2800
 
        else:
2801
 
            try:
2802
 
                revision_ids = self.search_missing_revision_ids(revision_id,
2803
 
                    find_ghosts=find_ghosts).get_keys()
2804
 
            except errors.NoSuchRevision:
2805
 
                raise errors.InstallFailed([revision_id])
2806
 
            if len(revision_ids) == 0:
2807
 
                return (0, [])
2808
 
        packs = self.source._pack_collection.all_packs()
2809
 
        pack = Packer(self.target._pack_collection, packs, '.fetch',
2810
 
            revision_ids).pack()
2811
 
        if pack is not None:
2812
 
            self.target._pack_collection._save_pack_names()
2813
 
            # Trigger an autopack. This may duplicate effort as we've just done
2814
 
            # a pack creation, but for now it is simpler to think about as
2815
 
            # 'upload data, then repack if needed'.
2816
 
            self.target._pack_collection.autopack()
2817
 
            return (pack.get_revision_count(), [])
2818
 
        else:
2819
 
            return (0, [])
2820
 
 
2821
 
    @needs_read_lock
2822
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2823
 
        """See InterRepository.missing_revision_ids().
2824
 
        
2825
 
        :param find_ghosts: Find ghosts throughout the ancestry of
2826
 
            revision_id.
2827
 
        """
2828
 
        if not find_ghosts and revision_id is not None:
2829
 
            return self._walk_to_common_revisions([revision_id])
2830
 
        elif revision_id is not None:
2831
 
            # Find ghosts: search for revisions pointing from one repository to
2832
 
            # the other, and vice versa, anywhere in the history of revision_id.
2833
 
            graph = self.target.get_graph(other_repository=self.source)
2834
 
            searcher = graph._make_breadth_first_searcher([revision_id])
2835
 
            found_ids = set()
2836
 
            while True:
2837
 
                try:
2838
 
                    next_revs, ghosts = searcher.next_with_ghosts()
2839
 
                except StopIteration:
2840
 
                    break
2841
 
                if revision_id in ghosts:
2842
 
                    raise errors.NoSuchRevision(self.source, revision_id)
2843
 
                found_ids.update(next_revs)
2844
 
                found_ids.update(ghosts)
2845
 
            found_ids = frozenset(found_ids)
2846
 
            # Double query here: should be able to avoid this by changing the
2847
 
            # graph api further.
2848
 
            result_set = found_ids - frozenset(
2849
 
                self.target.get_parent_map(found_ids))
2850
 
        else:
2851
 
            source_ids = self.source.all_revision_ids()
2852
 
            # source_ids is the worst possible case we may need to pull.
2853
 
            # now we want to filter source_ids against what we actually
2854
 
            # have in target, but don't try to check for existence where we know
2855
 
            # we do not have a revision as that would be pointless.
2856
 
            target_ids = set(self.target.all_revision_ids())
2857
 
            result_set = set(source_ids).difference(target_ids)
2858
 
        return self.source.revision_ids_to_search_result(result_set)
2859
 
 
2860
 
 
2861
 
class InterModel1and2(InterRepository):
2862
 
 
2863
 
    @classmethod
2864
 
    def _get_repo_format_to_test(self):
2865
 
        return None
2866
 
 
2867
 
    @staticmethod
2868
 
    def is_compatible(source, target):
2869
 
        if not source.supports_rich_root() and target.supports_rich_root():
2870
 
            return True
2871
 
        else:
2872
 
            return False
2873
 
 
2874
 
    @needs_write_lock
2875
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2876
 
        """See InterRepository.fetch()."""
2877
 
        from bzrlib.fetch import Model1toKnit2Fetcher
2878
 
        f = Model1toKnit2Fetcher(to_repository=self.target,
2879
 
                                 from_repository=self.source,
2880
 
                                 last_revision=revision_id,
2881
 
                                 pb=pb, find_ghosts=find_ghosts)
2882
 
        return f.count_copied, f.failed_revisions
2883
 
 
2884
 
    @needs_write_lock
2885
 
    def copy_content(self, revision_id=None):
2886
 
        """Make a complete copy of the content in self into destination.
2887
 
        
2888
 
        This is a destructive operation! Do not use it on existing 
2889
 
        repositories.
2890
 
 
2891
 
        :param revision_id: Only copy the content needed to construct
2892
 
                            revision_id and its parents.
2893
 
        """
2894
 
        try:
2895
 
            self.target.set_make_working_trees(self.source.make_working_trees())
2896
 
        except NotImplementedError:
2897
 
            pass
2898
 
        # but don't bother fetching if we have the needed data now.
2899
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
2900
 
            self.target.has_revision(revision_id)):
2901
 
            return
2902
 
        self.target.fetch(self.source, revision_id=revision_id)
2903
 
 
2904
 
 
2905
 
class InterKnit1and2(InterKnitRepo):
2906
 
 
2907
 
    @classmethod
2908
 
    def _get_repo_format_to_test(self):
2909
 
        return None
2910
 
 
2911
 
    @staticmethod
2912
 
    def is_compatible(source, target):
2913
 
        """Be compatible with Knit1 source and Knit3 target"""
2914
 
        try:
2915
 
            from bzrlib.repofmt.knitrepo import (
2916
 
                RepositoryFormatKnit1,
2917
 
                RepositoryFormatKnit3,
2918
 
                )
2919
 
            from bzrlib.repofmt.pack_repo import (
2920
 
                RepositoryFormatKnitPack1,
2921
 
                RepositoryFormatKnitPack3,
2922
 
                RepositoryFormatKnitPack4,
2923
 
                RepositoryFormatKnitPack5,
2924
 
                RepositoryFormatKnitPack5RichRoot,
2925
 
                RepositoryFormatPackDevelopment2,
2926
 
                RepositoryFormatPackDevelopment2Subtree,
2927
 
                )
2928
 
            norichroot = (
2929
 
                RepositoryFormatKnit1,            # no rr, no subtree
2930
 
                RepositoryFormatKnitPack1,        # no rr, no subtree
2931
 
                RepositoryFormatPackDevelopment2, # no rr, no subtree
2932
 
                RepositoryFormatKnitPack5,        # no rr, no subtree
2933
 
                )
2934
 
            richroot = (
2935
 
                RepositoryFormatKnit3,            # rr, subtree
2936
 
                RepositoryFormatKnitPack3,        # rr, subtree
2937
 
                RepositoryFormatKnitPack4,        # rr, no subtree
2938
 
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
2939
 
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
2940
 
                )
2941
 
            for format in norichroot:
2942
 
                if format.rich_root_data:
2943
 
                    raise AssertionError('Format %s is a rich-root format'
2944
 
                        ' but is included in the non-rich-root list'
2945
 
                        % (format,))
2946
 
            for format in richroot:
2947
 
                if not format.rich_root_data:
2948
 
                    raise AssertionError('Format %s is not a rich-root format'
2949
 
                        ' but is included in the rich-root list'
2950
 
                        % (format,))
2951
 
            # TODO: One alternative is to just check format.rich_root_data,
2952
 
            #       instead of keeping membership lists. However, the formats
2953
 
            #       *also* have to use the same 'Knit' style of storage
2954
 
            #       (line-deltas, fulltexts, etc.)
2955
 
            return (isinstance(source._format, norichroot) and
2956
 
                    isinstance(target._format, richroot))
2957
 
        except AttributeError:
2958
 
            return False
2959
 
 
2960
 
    @needs_write_lock
2961
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2962
 
        """See InterRepository.fetch()."""
2963
 
        from bzrlib.fetch import Knit1to2Fetcher
2964
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2965
 
               self.source, self.source._format, self.target, 
2966
 
               self.target._format)
2967
 
        f = Knit1to2Fetcher(to_repository=self.target,
2968
 
                            from_repository=self.source,
2969
 
                            last_revision=revision_id,
2970
 
                            pb=pb, find_ghosts=find_ghosts)
2971
 
        return f.count_copied, f.failed_revisions
2972
 
 
2973
 
 
2974
 
class InterDifferingSerializer(InterKnitRepo):
 
3690
class InterDifferingSerializer(InterRepository):
2975
3691
 
2976
3692
    @classmethod
2977
3693
    def _get_repo_format_to_test(self):
2980
3696
    @staticmethod
2981
3697
    def is_compatible(source, target):
2982
3698
        """Be compatible with Knit2 source and Knit3 target"""
2983
 
        if source.supports_rich_root() != target.supports_rich_root():
2984
 
            return False
2985
 
        # Ideally, we'd support fetching if the source had no tree references
2986
 
        # even if it supported them...
2987
 
        if (getattr(source, '_format.supports_tree_reference', False) and
2988
 
            not getattr(target, '_format.supports_tree_reference', False)):
 
3699
        # This is redundant with format.check_conversion_target(), however that
 
3700
        # raises an exception, and we just want to say "False" as in we won't
 
3701
        # support converting between these formats.
 
3702
        if 'IDS_never' in debug.debug_flags:
 
3703
            return False
 
3704
        if source.supports_rich_root() and not target.supports_rich_root():
 
3705
            return False
 
3706
        if (source._format.supports_tree_reference
 
3707
            and not target._format.supports_tree_reference):
 
3708
            return False
 
3709
        if target._fallback_repositories and target._format.supports_chks:
 
3710
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3711
            # adds to stacked repos.
 
3712
            return False
 
3713
        if 'IDS_always' in debug.debug_flags:
 
3714
            return True
 
3715
        # Only use this code path for local source and target.  IDS does far
 
3716
        # too much IO (both bandwidth and roundtrips) over a network.
 
3717
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3718
            return False
 
3719
        if not target.bzrdir.transport.base.startswith('file:///'):
2989
3720
            return False
2990
3721
        return True
2991
3722
 
 
3723
    def _get_trees(self, revision_ids, cache):
 
3724
        possible_trees = []
 
3725
        for rev_id in revision_ids:
 
3726
            if rev_id in cache:
 
3727
                possible_trees.append((rev_id, cache[rev_id]))
 
3728
            else:
 
3729
                # Not cached, but inventory might be present anyway.
 
3730
                try:
 
3731
                    tree = self.source.revision_tree(rev_id)
 
3732
                except errors.NoSuchRevision:
 
3733
                    # Nope, parent is ghost.
 
3734
                    pass
 
3735
                else:
 
3736
                    cache[rev_id] = tree
 
3737
                    possible_trees.append((rev_id, tree))
 
3738
        return possible_trees
 
3739
 
 
3740
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3741
        """Get the best delta and base for this revision.
 
3742
 
 
3743
        :return: (basis_id, delta)
 
3744
        """
 
3745
        deltas = []
 
3746
        # Generate deltas against each tree, to find the shortest.
 
3747
        texts_possibly_new_in_tree = set()
 
3748
        for basis_id, basis_tree in possible_trees:
 
3749
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3750
            for old_path, new_path, file_id, new_entry in delta:
 
3751
                if new_path is None:
 
3752
                    # This file_id isn't present in the new rev, so we don't
 
3753
                    # care about it.
 
3754
                    continue
 
3755
                if not new_path:
 
3756
                    # Rich roots are handled elsewhere...
 
3757
                    continue
 
3758
                kind = new_entry.kind
 
3759
                if kind != 'directory' and kind != 'file':
 
3760
                    # No text record associated with this inventory entry.
 
3761
                    continue
 
3762
                # This is a directory or file that has changed somehow.
 
3763
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
 
3764
            deltas.append((len(delta), basis_id, delta))
 
3765
        deltas.sort()
 
3766
        return deltas[0][1:]
 
3767
 
 
3768
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3769
        """Find all parent revisions that are absent, but for which the
 
3770
        inventory is present, and copy those inventories.
 
3771
 
 
3772
        This is necessary to preserve correctness when the source is stacked
 
3773
        without fallbacks configured.  (Note that in cases like upgrade the
 
3774
        source may be not have _fallback_repositories even though it is
 
3775
        stacked.)
 
3776
        """
 
3777
        parent_revs = set()
 
3778
        for parents in parent_map.values():
 
3779
            parent_revs.update(parents)
 
3780
        present_parents = self.source.get_parent_map(parent_revs)
 
3781
        absent_parents = set(parent_revs).difference(present_parents)
 
3782
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3783
            (rev_id,) for rev_id in absent_parents)
 
3784
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3785
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3786
            current_revision_id = parent_tree.get_revision_id()
 
3787
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3788
                (current_revision_id,)]
 
3789
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3790
            basis_id = _mod_revision.NULL_REVISION
 
3791
            basis_tree = self.source.revision_tree(basis_id)
 
3792
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3793
            self.target.add_inventory_by_delta(
 
3794
                basis_id, delta, current_revision_id, parents_parents)
 
3795
            cache[current_revision_id] = parent_tree
 
3796
 
 
3797
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3798
        """Fetch across a few revisions.
 
3799
 
 
3800
        :param revision_ids: The revisions to copy
 
3801
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3802
            as a basis for delta when no other base is available
 
3803
        :param cache: A cache of RevisionTrees that we can use.
 
3804
        :param a_graph: A Graph object to determine the heads() of the
 
3805
            rich-root data stream.
 
3806
        :return: The revision_id of the last converted tree. The RevisionTree
 
3807
            for it will be in cache
 
3808
        """
 
3809
        # Walk though all revisions; get inventory deltas, copy referenced
 
3810
        # texts that delta references, insert the delta, revision and
 
3811
        # signature.
 
3812
        root_keys_to_create = set()
 
3813
        text_keys = set()
 
3814
        pending_deltas = []
 
3815
        pending_revisions = []
 
3816
        parent_map = self.source.get_parent_map(revision_ids)
 
3817
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3818
        self.source._safe_to_return_from_cache = True
 
3819
        for tree in self.source.revision_trees(revision_ids):
 
3820
            # Find a inventory delta for this revision.
 
3821
            # Find text entries that need to be copied, too.
 
3822
            current_revision_id = tree.get_revision_id()
 
3823
            parent_ids = parent_map.get(current_revision_id, ())
 
3824
            parent_trees = self._get_trees(parent_ids, cache)
 
3825
            possible_trees = list(parent_trees)
 
3826
            if len(possible_trees) == 0:
 
3827
                # There either aren't any parents, or the parents are ghosts,
 
3828
                # so just use the last converted tree.
 
3829
                possible_trees.append((basis_id, cache[basis_id]))
 
3830
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3831
                                                           possible_trees)
 
3832
            revision = self.source.get_revision(current_revision_id)
 
3833
            pending_deltas.append((basis_id, delta,
 
3834
                current_revision_id, revision.parent_ids))
 
3835
            if self._converting_to_rich_root:
 
3836
                self._revision_id_to_root_id[current_revision_id] = \
 
3837
                    tree.get_root_id()
 
3838
            # Determine which texts are in present in this revision but not in
 
3839
            # any of the available parents.
 
3840
            texts_possibly_new_in_tree = set()
 
3841
            for old_path, new_path, file_id, entry in delta:
 
3842
                if new_path is None:
 
3843
                    # This file_id isn't present in the new rev
 
3844
                    continue
 
3845
                if not new_path:
 
3846
                    # This is the root
 
3847
                    if not self.target.supports_rich_root():
 
3848
                        # The target doesn't support rich root, so we don't
 
3849
                        # copy
 
3850
                        continue
 
3851
                    if self._converting_to_rich_root:
 
3852
                        # This can't be copied normally, we have to insert
 
3853
                        # it specially
 
3854
                        root_keys_to_create.add((file_id, entry.revision))
 
3855
                        continue
 
3856
                kind = entry.kind
 
3857
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3858
            for basis_id, basis_tree in possible_trees:
 
3859
                basis_inv = basis_tree.inventory
 
3860
                for file_key in list(texts_possibly_new_in_tree):
 
3861
                    file_id, file_revision = file_key
 
3862
                    try:
 
3863
                        entry = basis_inv[file_id]
 
3864
                    except errors.NoSuchId:
 
3865
                        continue
 
3866
                    if entry.revision == file_revision:
 
3867
                        texts_possibly_new_in_tree.remove(file_key)
 
3868
            text_keys.update(texts_possibly_new_in_tree)
 
3869
            pending_revisions.append(revision)
 
3870
            cache[current_revision_id] = tree
 
3871
            basis_id = current_revision_id
 
3872
        self.source._safe_to_return_from_cache = False
 
3873
        # Copy file texts
 
3874
        from_texts = self.source.texts
 
3875
        to_texts = self.target.texts
 
3876
        if root_keys_to_create:
 
3877
            root_stream = _mod_fetch._new_root_data_stream(
 
3878
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3879
                self.source, graph=a_graph)
 
3880
            to_texts.insert_record_stream(root_stream)
 
3881
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3882
            text_keys, self.target._format._fetch_order,
 
3883
            not self.target._format._fetch_uses_deltas))
 
3884
        # insert inventory deltas
 
3885
        for delta in pending_deltas:
 
3886
            self.target.add_inventory_by_delta(*delta)
 
3887
        if self.target._fallback_repositories:
 
3888
            # Make sure this stacked repository has all the parent inventories
 
3889
            # for the new revisions that we are about to insert.  We do this
 
3890
            # before adding the revisions so that no revision is added until
 
3891
            # all the inventories it may depend on are added.
 
3892
            # Note that this is overzealous, as we may have fetched these in an
 
3893
            # earlier batch.
 
3894
            parent_ids = set()
 
3895
            revision_ids = set()
 
3896
            for revision in pending_revisions:
 
3897
                revision_ids.add(revision.revision_id)
 
3898
                parent_ids.update(revision.parent_ids)
 
3899
            parent_ids.difference_update(revision_ids)
 
3900
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3901
            parent_map = self.source.get_parent_map(parent_ids)
 
3902
            # we iterate over parent_map and not parent_ids because we don't
 
3903
            # want to try copying any revision which is a ghost
 
3904
            for parent_tree in self.source.revision_trees(parent_map):
 
3905
                current_revision_id = parent_tree.get_revision_id()
 
3906
                parents_parents = parent_map[current_revision_id]
 
3907
                possible_trees = self._get_trees(parents_parents, cache)
 
3908
                if len(possible_trees) == 0:
 
3909
                    # There either aren't any parents, or the parents are
 
3910
                    # ghosts, so just use the last converted tree.
 
3911
                    possible_trees.append((basis_id, cache[basis_id]))
 
3912
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3913
                    parents_parents, possible_trees)
 
3914
                self.target.add_inventory_by_delta(
 
3915
                    basis_id, delta, current_revision_id, parents_parents)
 
3916
        # insert signatures and revisions
 
3917
        for revision in pending_revisions:
 
3918
            try:
 
3919
                signature = self.source.get_signature_text(
 
3920
                    revision.revision_id)
 
3921
                self.target.add_signature_text(revision.revision_id,
 
3922
                    signature)
 
3923
            except errors.NoSuchRevision:
 
3924
                pass
 
3925
            self.target.add_revision(revision.revision_id, revision)
 
3926
        return basis_id
 
3927
 
 
3928
    def _fetch_all_revisions(self, revision_ids, pb):
 
3929
        """Fetch everything for the list of revisions.
 
3930
 
 
3931
        :param revision_ids: The list of revisions to fetch. Must be in
 
3932
            topological order.
 
3933
        :param pb: A ProgressTask
 
3934
        :return: None
 
3935
        """
 
3936
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3937
        batch_size = 100
 
3938
        cache = lru_cache.LRUCache(100)
 
3939
        cache[basis_id] = basis_tree
 
3940
        del basis_tree # We don't want to hang on to it here
 
3941
        hints = []
 
3942
        if self._converting_to_rich_root and len(revision_ids) > 100:
 
3943
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
 
3944
                                                            revision_ids)
 
3945
        else:
 
3946
            a_graph = None
 
3947
 
 
3948
        for offset in range(0, len(revision_ids), batch_size):
 
3949
            self.target.start_write_group()
 
3950
            try:
 
3951
                pb.update('Transferring revisions', offset,
 
3952
                          len(revision_ids))
 
3953
                batch = revision_ids[offset:offset+batch_size]
 
3954
                basis_id = self._fetch_batch(batch, basis_id, cache,
 
3955
                                             a_graph=a_graph)
 
3956
            except:
 
3957
                self.source._safe_to_return_from_cache = False
 
3958
                self.target.abort_write_group()
 
3959
                raise
 
3960
            else:
 
3961
                hint = self.target.commit_write_group()
 
3962
                if hint:
 
3963
                    hints.extend(hint)
 
3964
        if hints and self.target._format.pack_compresses:
 
3965
            self.target.pack(hint=hints)
 
3966
        pb.update('Transferring revisions', len(revision_ids),
 
3967
                  len(revision_ids))
 
3968
 
2992
3969
    @needs_write_lock
2993
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3970
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3971
            fetch_spec=None):
2994
3972
        """See InterRepository.fetch()."""
 
3973
        if fetch_spec is not None:
 
3974
            raise AssertionError("Not implemented yet...")
 
3975
        ui.ui_factory.warn_experimental_format_fetch(self)
 
3976
        if (not self.source.supports_rich_root()
 
3977
            and self.target.supports_rich_root()):
 
3978
            self._converting_to_rich_root = True
 
3979
            self._revision_id_to_root_id = {}
 
3980
        else:
 
3981
            self._converting_to_rich_root = False
 
3982
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3983
        if self.source._format.network_name() != self.target._format.network_name():
 
3984
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
3985
                from_format=self.source._format,
 
3986
                to_format=self.target._format)
2995
3987
        revision_ids = self.target.search_missing_revision_ids(self.source,
2996
3988
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3989
        if not revision_ids:
 
3990
            return 0, 0
2997
3991
        revision_ids = tsort.topo_sort(
2998
3992
            self.source.get_graph().get_parent_map(revision_ids))
2999
 
        def revisions_iterator():
3000
 
            for current_revision_id in revision_ids:
3001
 
                revision = self.source.get_revision(current_revision_id)
3002
 
                tree = self.source.revision_tree(current_revision_id)
3003
 
                try:
3004
 
                    signature = self.source.get_signature_text(
3005
 
                        current_revision_id)
3006
 
                except errors.NoSuchRevision:
3007
 
                    signature = None
3008
 
                yield revision, tree, signature
 
3993
        if not revision_ids:
 
3994
            return 0, 0
 
3995
        # Walk though all revisions; get inventory deltas, copy referenced
 
3996
        # texts that delta references, insert the delta, revision and
 
3997
        # signature.
3009
3998
        if pb is None:
3010
3999
            my_pb = ui.ui_factory.nested_progress_bar()
3011
4000
            pb = my_pb
3012
4001
        else:
 
4002
            symbol_versioning.warn(
 
4003
                symbol_versioning.deprecated_in((1, 14, 0))
 
4004
                % "pb parameter to fetch()")
3013
4005
            my_pb = None
3014
4006
        try:
3015
 
            install_revisions(self.target, revisions_iterator(),
3016
 
                              len(revision_ids), pb)
 
4007
            self._fetch_all_revisions(revision_ids, pb)
3017
4008
        finally:
3018
4009
            if my_pb is not None:
3019
4010
                my_pb.finished()
3020
4011
        return len(revision_ids), 0
3021
4012
 
3022
 
 
3023
 
class InterOtherToRemote(InterRepository):
3024
 
 
3025
 
    def __init__(self, source, target):
3026
 
        InterRepository.__init__(self, source, target)
3027
 
        self._real_inter = None
3028
 
 
3029
 
    @staticmethod
3030
 
    def is_compatible(source, target):
3031
 
        if isinstance(target, remote.RemoteRepository):
3032
 
            return True
3033
 
        return False
3034
 
 
3035
 
    def _ensure_real_inter(self):
3036
 
        if self._real_inter is None:
3037
 
            self.target._ensure_real()
3038
 
            real_target = self.target._real_repository
3039
 
            self._real_inter = InterRepository.get(self.source, real_target)
3040
 
    
3041
 
    def copy_content(self, revision_id=None):
3042
 
        self._ensure_real_inter()
3043
 
        self._real_inter.copy_content(revision_id=revision_id)
3044
 
 
3045
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3046
 
        self._ensure_real_inter()
3047
 
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
3048
 
            find_ghosts=find_ghosts)
3049
 
 
3050
 
    @classmethod
3051
 
    def _get_repo_format_to_test(self):
3052
 
        return None
3053
 
 
3054
 
 
3055
 
class InterRemoteToOther(InterRepository):
3056
 
 
3057
 
    def __init__(self, source, target):
3058
 
        InterRepository.__init__(self, source, target)
3059
 
        self._real_inter = None
3060
 
 
3061
 
    @staticmethod
3062
 
    def is_compatible(source, target):
3063
 
        if not isinstance(source, remote.RemoteRepository):
3064
 
            return False
3065
 
        # Is source's model compatible with target's model?
3066
 
        source._ensure_real()
3067
 
        real_source = source._real_repository
3068
 
        if isinstance(real_source, remote.RemoteRepository):
3069
 
            raise NotImplementedError(
3070
 
                "We don't support remote repos backed by remote repos yet.")
3071
 
        return InterRepository._same_model(real_source, target)
3072
 
 
3073
 
    def _ensure_real_inter(self):
3074
 
        if self._real_inter is None:
3075
 
            self.source._ensure_real()
3076
 
            real_source = self.source._real_repository
3077
 
            self._real_inter = InterRepository.get(real_source, self.target)
3078
 
    
3079
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3080
 
        self._ensure_real_inter()
3081
 
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
3082
 
            find_ghosts=find_ghosts)
3083
 
 
3084
 
    def copy_content(self, revision_id=None):
3085
 
        self._ensure_real_inter()
3086
 
        self._real_inter.copy_content(revision_id=revision_id)
3087
 
 
3088
 
    @classmethod
3089
 
    def _get_repo_format_to_test(self):
3090
 
        return None
3091
 
 
 
4013
    def _get_basis(self, first_revision_id):
 
4014
        """Get a revision and tree which exists in the target.
 
4015
 
 
4016
        This assumes that first_revision_id is selected for transmission
 
4017
        because all other ancestors are already present. If we can't find an
 
4018
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
4019
 
 
4020
        :return: (basis_id, basis_tree)
 
4021
        """
 
4022
        first_rev = self.source.get_revision(first_revision_id)
 
4023
        try:
 
4024
            basis_id = first_rev.parent_ids[0]
 
4025
            # only valid as a basis if the target has it
 
4026
            self.target.get_revision(basis_id)
 
4027
            # Try to get a basis tree - if its a ghost it will hit the
 
4028
            # NoSuchRevision case.
 
4029
            basis_tree = self.source.revision_tree(basis_id)
 
4030
        except (IndexError, errors.NoSuchRevision):
 
4031
            basis_id = _mod_revision.NULL_REVISION
 
4032
            basis_tree = self.source.revision_tree(basis_id)
 
4033
        return basis_id, basis_tree
3092
4034
 
3093
4035
 
3094
4036
InterRepository.register_optimiser(InterDifferingSerializer)
3095
4037
InterRepository.register_optimiser(InterSameDataRepository)
3096
4038
InterRepository.register_optimiser(InterWeaveRepo)
3097
4039
InterRepository.register_optimiser(InterKnitRepo)
3098
 
InterRepository.register_optimiser(InterModel1and2)
3099
 
InterRepository.register_optimiser(InterKnit1and2)
3100
 
InterRepository.register_optimiser(InterPackRepo)
3101
 
InterRepository.register_optimiser(InterOtherToRemote)
3102
 
InterRepository.register_optimiser(InterRemoteToOther)
3103
4040
 
3104
4041
 
3105
4042
class CopyConverter(object):
3106
4043
    """A repository conversion tool which just performs a copy of the content.
3107
 
    
 
4044
 
3108
4045
    This is slow but quite reliable.
3109
4046
    """
3110
4047
 
3114
4051
        :param target_format: The format the resulting repository should be.
3115
4052
        """
3116
4053
        self.target_format = target_format
3117
 
        
 
4054
 
3118
4055
    def convert(self, repo, pb):
3119
4056
        """Perform the conversion of to_convert, giving feedback via pb.
3120
4057
 
3121
4058
        :param to_convert: The disk object to convert.
3122
4059
        :param pb: a progress bar to use for progress information.
3123
4060
        """
3124
 
        self.pb = pb
 
4061
        pb = ui.ui_factory.nested_progress_bar()
3125
4062
        self.count = 0
3126
4063
        self.total = 4
3127
4064
        # this is only useful with metadir layouts - separated repo content.
3128
4065
        # trigger an assertion if not such
3129
4066
        repo._format.get_format_string()
3130
4067
        self.repo_dir = repo.bzrdir
3131
 
        self.step('Moving repository to repository.backup')
 
4068
        pb.update('Moving repository to repository.backup')
3132
4069
        self.repo_dir.transport.move('repository', 'repository.backup')
3133
4070
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3134
4071
        repo._format.check_conversion_target(self.target_format)
3135
4072
        self.source_repo = repo._format.open(self.repo_dir,
3136
4073
            _found=True,
3137
4074
            _override_transport=backup_transport)
3138
 
        self.step('Creating new repository')
 
4075
        pb.update('Creating new repository')
3139
4076
        converted = self.target_format.initialize(self.repo_dir,
3140
4077
                                                  self.source_repo.is_shared())
3141
4078
        converted.lock_write()
3142
4079
        try:
3143
 
            self.step('Copying content into repository.')
 
4080
            pb.update('Copying content')
3144
4081
            self.source_repo.copy_content_into(converted)
3145
4082
        finally:
3146
4083
            converted.unlock()
3147
 
        self.step('Deleting old repository content.')
 
4084
        pb.update('Deleting old repository content')
3148
4085
        self.repo_dir.transport.delete_tree('repository.backup')
3149
 
        self.pb.note('repository converted')
3150
 
 
3151
 
    def step(self, message):
3152
 
        """Update the pb by a step."""
3153
 
        self.count +=1
3154
 
        self.pb.update(message, self.count, self.total)
 
4086
        ui.ui_factory.note('repository converted')
 
4087
        pb.finished()
3155
4088
 
3156
4089
 
3157
4090
_unescape_map = {
3186
4119
 
3187
4120
class _VersionedFileChecker(object):
3188
4121
 
3189
 
    def __init__(self, repository):
 
4122
    def __init__(self, repository, text_key_references=None, ancestors=None):
3190
4123
        self.repository = repository
3191
 
        self.text_index = self.repository._generate_text_key_index()
3192
 
    
 
4124
        self.text_index = self.repository._generate_text_key_index(
 
4125
            text_key_references=text_key_references, ancestors=ancestors)
 
4126
 
3193
4127
    def calculate_file_version_parents(self, text_key):
3194
4128
        """Calculate the correct parents for a file version according to
3195
4129
        the inventories.
3212
4146
            revision_id) tuples for versions that are present in this versioned
3213
4147
            file, but not used by the corresponding inventory.
3214
4148
        """
 
4149
        local_progress = None
 
4150
        if progress_bar is None:
 
4151
            local_progress = ui.ui_factory.nested_progress_bar()
 
4152
            progress_bar = local_progress
 
4153
        try:
 
4154
            return self._check_file_version_parents(texts, progress_bar)
 
4155
        finally:
 
4156
            if local_progress:
 
4157
                local_progress.finished()
 
4158
 
 
4159
    def _check_file_version_parents(self, texts, progress_bar):
 
4160
        """See check_file_version_parents."""
3215
4161
        wrong_parents = {}
3216
4162
        self.file_ids = set([file_id for file_id, _ in
3217
4163
            self.text_index.iterkeys()])
3218
4164
        # text keys is now grouped by file_id
3219
 
        n_weaves = len(self.file_ids)
3220
 
        files_in_revisions = {}
3221
 
        revisions_of_files = {}
3222
4165
        n_versions = len(self.text_index)
3223
4166
        progress_bar.update('loading text store', 0, n_versions)
3224
4167
        parent_map = self.repository.texts.get_parent_map(self.text_index)
3226
4169
        text_keys = self.repository.texts.keys()
3227
4170
        unused_keys = frozenset(text_keys) - set(self.text_index)
3228
4171
        for num, key in enumerate(self.text_index.iterkeys()):
3229
 
            if progress_bar is not None:
3230
 
                progress_bar.update('checking text graph', num, n_versions)
 
4172
            progress_bar.update('checking text graph', num, n_versions)
3231
4173
            correct_parents = self.calculate_file_version_parents(key)
3232
4174
            try:
3233
4175
                knit_parents = parent_map[key]
3256
4198
        revision_graph[key] = tuple(parent for parent in parents if parent
3257
4199
            in revision_graph)
3258
4200
    return revision_graph
 
4201
 
 
4202
 
 
4203
class StreamSink(object):
 
4204
    """An object that can insert a stream into a repository.
 
4205
 
 
4206
    This interface handles the complexity of reserialising inventories and
 
4207
    revisions from different formats, and allows unidirectional insertion into
 
4208
    stacked repositories without looking for the missing basis parents
 
4209
    beforehand.
 
4210
    """
 
4211
 
 
4212
    def __init__(self, target_repo):
 
4213
        self.target_repo = target_repo
 
4214
 
 
4215
    def insert_stream(self, stream, src_format, resume_tokens):
 
4216
        """Insert a stream's content into the target repository.
 
4217
 
 
4218
        :param src_format: a bzr repository format.
 
4219
 
 
4220
        :return: a list of resume tokens and an  iterable of keys additional
 
4221
            items required before the insertion can be completed.
 
4222
        """
 
4223
        self.target_repo.lock_write()
 
4224
        try:
 
4225
            if resume_tokens:
 
4226
                self.target_repo.resume_write_group(resume_tokens)
 
4227
                is_resume = True
 
4228
            else:
 
4229
                self.target_repo.start_write_group()
 
4230
                is_resume = False
 
4231
            try:
 
4232
                # locked_insert_stream performs a commit|suspend.
 
4233
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4234
            except:
 
4235
                self.target_repo.abort_write_group(suppress_errors=True)
 
4236
                raise
 
4237
        finally:
 
4238
            self.target_repo.unlock()
 
4239
 
 
4240
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4241
        to_serializer = self.target_repo._format._serializer
 
4242
        src_serializer = src_format._serializer
 
4243
        new_pack = None
 
4244
        if to_serializer == src_serializer:
 
4245
            # If serializers match and the target is a pack repository, set the
 
4246
            # write cache size on the new pack.  This avoids poor performance
 
4247
            # on transports where append is unbuffered (such as
 
4248
            # RemoteTransport).  This is safe to do because nothing should read
 
4249
            # back from the target repository while a stream with matching
 
4250
            # serialization is being inserted.
 
4251
            # The exception is that a delta record from the source that should
 
4252
            # be a fulltext may need to be expanded by the target (see
 
4253
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
4254
            # explicitly flush any buffered writes first in that rare case.
 
4255
            try:
 
4256
                new_pack = self.target_repo._pack_collection._new_pack
 
4257
            except AttributeError:
 
4258
                # Not a pack repository
 
4259
                pass
 
4260
            else:
 
4261
                new_pack.set_write_cache_size(1024*1024)
 
4262
        for substream_type, substream in stream:
 
4263
            if 'stream' in debug.debug_flags:
 
4264
                mutter('inserting substream: %s', substream_type)
 
4265
            if substream_type == 'texts':
 
4266
                self.target_repo.texts.insert_record_stream(substream)
 
4267
            elif substream_type == 'inventories':
 
4268
                if src_serializer == to_serializer:
 
4269
                    self.target_repo.inventories.insert_record_stream(
 
4270
                        substream)
 
4271
                else:
 
4272
                    self._extract_and_insert_inventories(
 
4273
                        substream, src_serializer)
 
4274
            elif substream_type == 'inventory-deltas':
 
4275
                self._extract_and_insert_inventory_deltas(
 
4276
                    substream, src_serializer)
 
4277
            elif substream_type == 'chk_bytes':
 
4278
                # XXX: This doesn't support conversions, as it assumes the
 
4279
                #      conversion was done in the fetch code.
 
4280
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4281
            elif substream_type == 'revisions':
 
4282
                # This may fallback to extract-and-insert more often than
 
4283
                # required if the serializers are different only in terms of
 
4284
                # the inventory.
 
4285
                if src_serializer == to_serializer:
 
4286
                    self.target_repo.revisions.insert_record_stream(
 
4287
                        substream)
 
4288
                else:
 
4289
                    self._extract_and_insert_revisions(substream,
 
4290
                        src_serializer)
 
4291
            elif substream_type == 'signatures':
 
4292
                self.target_repo.signatures.insert_record_stream(substream)
 
4293
            else:
 
4294
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4295
        # Done inserting data, and the missing_keys calculations will try to
 
4296
        # read back from the inserted data, so flush the writes to the new pack
 
4297
        # (if this is pack format).
 
4298
        if new_pack is not None:
 
4299
            new_pack._write_data('', flush=True)
 
4300
        # Find all the new revisions (including ones from resume_tokens)
 
4301
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4302
            check_for_missing_texts=is_resume)
 
4303
        try:
 
4304
            for prefix, versioned_file in (
 
4305
                ('texts', self.target_repo.texts),
 
4306
                ('inventories', self.target_repo.inventories),
 
4307
                ('revisions', self.target_repo.revisions),
 
4308
                ('signatures', self.target_repo.signatures),
 
4309
                ('chk_bytes', self.target_repo.chk_bytes),
 
4310
                ):
 
4311
                if versioned_file is None:
 
4312
                    continue
 
4313
                # TODO: key is often going to be a StaticTuple object
 
4314
                #       I don't believe we can define a method by which
 
4315
                #       (prefix,) + StaticTuple will work, though we could
 
4316
                #       define a StaticTuple.sq_concat that would allow you to
 
4317
                #       pass in either a tuple or a StaticTuple as the second
 
4318
                #       object, so instead we could have:
 
4319
                #       StaticTuple(prefix) + key here...
 
4320
                missing_keys.update((prefix,) + key for key in
 
4321
                    versioned_file.get_missing_compression_parent_keys())
 
4322
        except NotImplementedError:
 
4323
            # cannot even attempt suspending, and missing would have failed
 
4324
            # during stream insertion.
 
4325
            missing_keys = set()
 
4326
        else:
 
4327
            if missing_keys:
 
4328
                # suspend the write group and tell the caller what we is
 
4329
                # missing. We know we can suspend or else we would not have
 
4330
                # entered this code path. (All repositories that can handle
 
4331
                # missing keys can handle suspending a write group).
 
4332
                write_group_tokens = self.target_repo.suspend_write_group()
 
4333
                return write_group_tokens, missing_keys
 
4334
        hint = self.target_repo.commit_write_group()
 
4335
        if (to_serializer != src_serializer and
 
4336
            self.target_repo._format.pack_compresses):
 
4337
            self.target_repo.pack(hint=hint)
 
4338
        return [], set()
 
4339
 
 
4340
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4341
        target_rich_root = self.target_repo._format.rich_root_data
 
4342
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4343
        for record in substream:
 
4344
            # Insert the delta directly
 
4345
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4346
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4347
            try:
 
4348
                parse_result = deserialiser.parse_text_bytes(
 
4349
                    inventory_delta_bytes)
 
4350
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4351
                trace.mutter("Incompatible delta: %s", err.msg)
 
4352
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4353
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4354
            revision_id = new_id
 
4355
            parents = [key[0] for key in record.parents]
 
4356
            self.target_repo.add_inventory_by_delta(
 
4357
                basis_id, inv_delta, revision_id, parents)
 
4358
 
 
4359
    def _extract_and_insert_inventories(self, substream, serializer,
 
4360
            parse_delta=None):
 
4361
        """Generate a new inventory versionedfile in target, converting data.
 
4362
 
 
4363
        The inventory is retrieved from the source, (deserializing it), and
 
4364
        stored in the target (reserializing it in a different format).
 
4365
        """
 
4366
        target_rich_root = self.target_repo._format.rich_root_data
 
4367
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4368
        for record in substream:
 
4369
            # It's not a delta, so it must be a fulltext in the source
 
4370
            # serializer's format.
 
4371
            bytes = record.get_bytes_as('fulltext')
 
4372
            revision_id = record.key[0]
 
4373
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4374
            parents = [key[0] for key in record.parents]
 
4375
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4376
            # No need to keep holding this full inv in memory when the rest of
 
4377
            # the substream is likely to be all deltas.
 
4378
            del inv
 
4379
 
 
4380
    def _extract_and_insert_revisions(self, substream, serializer):
 
4381
        for record in substream:
 
4382
            bytes = record.get_bytes_as('fulltext')
 
4383
            revision_id = record.key[0]
 
4384
            rev = serializer.read_revision_from_string(bytes)
 
4385
            if rev.revision_id != revision_id:
 
4386
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4387
            self.target_repo.add_revision(revision_id, rev)
 
4388
 
 
4389
    def finished(self):
 
4390
        if self.target_repo._format._fetch_reconcile:
 
4391
            self.target_repo.reconcile()
 
4392
 
 
4393
 
 
4394
class StreamSource(object):
 
4395
    """A source of a stream for fetching between repositories."""
 
4396
 
 
4397
    def __init__(self, from_repository, to_format):
 
4398
        """Create a StreamSource streaming from from_repository."""
 
4399
        self.from_repository = from_repository
 
4400
        self.to_format = to_format
 
4401
 
 
4402
    def delta_on_metadata(self):
 
4403
        """Return True if delta's are permitted on metadata streams.
 
4404
 
 
4405
        That is on revisions and signatures.
 
4406
        """
 
4407
        src_serializer = self.from_repository._format._serializer
 
4408
        target_serializer = self.to_format._serializer
 
4409
        return (self.to_format._fetch_uses_deltas and
 
4410
            src_serializer == target_serializer)
 
4411
 
 
4412
    def _fetch_revision_texts(self, revs):
 
4413
        # fetch signatures first and then the revision texts
 
4414
        # may need to be a InterRevisionStore call here.
 
4415
        from_sf = self.from_repository.signatures
 
4416
        # A missing signature is just skipped.
 
4417
        keys = [(rev_id,) for rev_id in revs]
 
4418
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4419
            keys,
 
4420
            self.to_format._fetch_order,
 
4421
            not self.to_format._fetch_uses_deltas))
 
4422
        # If a revision has a delta, this is actually expanded inside the
 
4423
        # insert_record_stream code now, which is an alternate fix for
 
4424
        # bug #261339
 
4425
        from_rf = self.from_repository.revisions
 
4426
        revisions = from_rf.get_record_stream(
 
4427
            keys,
 
4428
            self.to_format._fetch_order,
 
4429
            not self.delta_on_metadata())
 
4430
        return [('signatures', signatures), ('revisions', revisions)]
 
4431
 
 
4432
    def _generate_root_texts(self, revs):
 
4433
        """This will be called by get_stream between fetching weave texts and
 
4434
        fetching the inventory weave.
 
4435
        """
 
4436
        if self._rich_root_upgrade():
 
4437
            return _mod_fetch.Inter1and2Helper(
 
4438
                self.from_repository).generate_root_texts(revs)
 
4439
        else:
 
4440
            return []
 
4441
 
 
4442
    def get_stream(self, search):
 
4443
        phase = 'file'
 
4444
        revs = search.get_keys()
 
4445
        graph = self.from_repository.get_graph()
 
4446
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4447
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4448
        text_keys = []
 
4449
        for knit_kind, file_id, revisions in data_to_fetch:
 
4450
            if knit_kind != phase:
 
4451
                phase = knit_kind
 
4452
                # Make a new progress bar for this phase
 
4453
            if knit_kind == "file":
 
4454
                # Accumulate file texts
 
4455
                text_keys.extend([(file_id, revision) for revision in
 
4456
                    revisions])
 
4457
            elif knit_kind == "inventory":
 
4458
                # Now copy the file texts.
 
4459
                from_texts = self.from_repository.texts
 
4460
                yield ('texts', from_texts.get_record_stream(
 
4461
                    text_keys, self.to_format._fetch_order,
 
4462
                    not self.to_format._fetch_uses_deltas))
 
4463
                # Cause an error if a text occurs after we have done the
 
4464
                # copy.
 
4465
                text_keys = None
 
4466
                # Before we process the inventory we generate the root
 
4467
                # texts (if necessary) so that the inventories references
 
4468
                # will be valid.
 
4469
                for _ in self._generate_root_texts(revs):
 
4470
                    yield _
 
4471
                # we fetch only the referenced inventories because we do not
 
4472
                # know for unselected inventories whether all their required
 
4473
                # texts are present in the other repository - it could be
 
4474
                # corrupt.
 
4475
                for info in self._get_inventory_stream(revs):
 
4476
                    yield info
 
4477
            elif knit_kind == "signatures":
 
4478
                # Nothing to do here; this will be taken care of when
 
4479
                # _fetch_revision_texts happens.
 
4480
                pass
 
4481
            elif knit_kind == "revisions":
 
4482
                for record in self._fetch_revision_texts(revs):
 
4483
                    yield record
 
4484
            else:
 
4485
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4486
 
 
4487
    def get_stream_for_missing_keys(self, missing_keys):
 
4488
        # missing keys can only occur when we are byte copying and not
 
4489
        # translating (because translation means we don't send
 
4490
        # unreconstructable deltas ever).
 
4491
        keys = {}
 
4492
        keys['texts'] = set()
 
4493
        keys['revisions'] = set()
 
4494
        keys['inventories'] = set()
 
4495
        keys['chk_bytes'] = set()
 
4496
        keys['signatures'] = set()
 
4497
        for key in missing_keys:
 
4498
            keys[key[0]].add(key[1:])
 
4499
        if len(keys['revisions']):
 
4500
            # If we allowed copying revisions at this point, we could end up
 
4501
            # copying a revision without copying its required texts: a
 
4502
            # violation of the requirements for repository integrity.
 
4503
            raise AssertionError(
 
4504
                'cannot copy revisions to fill in missing deltas %s' % (
 
4505
                    keys['revisions'],))
 
4506
        for substream_kind, keys in keys.iteritems():
 
4507
            vf = getattr(self.from_repository, substream_kind)
 
4508
            if vf is None and keys:
 
4509
                    raise AssertionError(
 
4510
                        "cannot fill in keys for a versioned file we don't"
 
4511
                        " have: %s needs %s" % (substream_kind, keys))
 
4512
            if not keys:
 
4513
                # No need to stream something we don't have
 
4514
                continue
 
4515
            if substream_kind == 'inventories':
 
4516
                # Some missing keys are genuinely ghosts, filter those out.
 
4517
                present = self.from_repository.inventories.get_parent_map(keys)
 
4518
                revs = [key[0] for key in present]
 
4519
                # Get the inventory stream more-or-less as we do for the
 
4520
                # original stream; there's no reason to assume that records
 
4521
                # direct from the source will be suitable for the sink.  (Think
 
4522
                # e.g. 2a -> 1.9-rich-root).
 
4523
                for info in self._get_inventory_stream(revs, missing=True):
 
4524
                    yield info
 
4525
                continue
 
4526
 
 
4527
            # Ask for full texts always so that we don't need more round trips
 
4528
            # after this stream.
 
4529
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4530
            # records. The Sink is responsible for doing another check to
 
4531
            # ensure that ghosts don't introduce missing data for future
 
4532
            # fetches.
 
4533
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4534
                self.to_format._fetch_order, True))
 
4535
            yield substream_kind, stream
 
4536
 
 
4537
    def inventory_fetch_order(self):
 
4538
        if self._rich_root_upgrade():
 
4539
            return 'topological'
 
4540
        else:
 
4541
            return self.to_format._fetch_order
 
4542
 
 
4543
    def _rich_root_upgrade(self):
 
4544
        return (not self.from_repository._format.rich_root_data and
 
4545
            self.to_format.rich_root_data)
 
4546
 
 
4547
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4548
        from_format = self.from_repository._format
 
4549
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4550
            from_format.network_name() == self.to_format.network_name()):
 
4551
            raise AssertionError(
 
4552
                "this case should be handled by GroupCHKStreamSource")
 
4553
        elif 'forceinvdeltas' in debug.debug_flags:
 
4554
            return self._get_convertable_inventory_stream(revision_ids,
 
4555
                    delta_versus_null=missing)
 
4556
        elif from_format.network_name() == self.to_format.network_name():
 
4557
            # Same format.
 
4558
            return self._get_simple_inventory_stream(revision_ids,
 
4559
                    missing=missing)
 
4560
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4561
                and from_format._serializer == self.to_format._serializer):
 
4562
            # Essentially the same format.
 
4563
            return self._get_simple_inventory_stream(revision_ids,
 
4564
                    missing=missing)
 
4565
        else:
 
4566
            # Any time we switch serializations, we want to use an
 
4567
            # inventory-delta based approach.
 
4568
            return self._get_convertable_inventory_stream(revision_ids,
 
4569
                    delta_versus_null=missing)
 
4570
 
 
4571
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4572
        # NB: This currently reopens the inventory weave in source;
 
4573
        # using a single stream interface instead would avoid this.
 
4574
        from_weave = self.from_repository.inventories
 
4575
        if missing:
 
4576
            delta_closure = True
 
4577
        else:
 
4578
            delta_closure = not self.delta_on_metadata()
 
4579
        yield ('inventories', from_weave.get_record_stream(
 
4580
            [(rev_id,) for rev_id in revision_ids],
 
4581
            self.inventory_fetch_order(), delta_closure))
 
4582
 
 
4583
    def _get_convertable_inventory_stream(self, revision_ids,
 
4584
                                          delta_versus_null=False):
 
4585
        # The two formats are sufficiently different that there is no fast
 
4586
        # path, so we need to send just inventorydeltas, which any
 
4587
        # sufficiently modern client can insert into any repository.
 
4588
        # The StreamSink code expects to be able to
 
4589
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4590
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4591
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4592
        yield ('inventory-deltas',
 
4593
           self._stream_invs_as_deltas(revision_ids,
 
4594
                                       delta_versus_null=delta_versus_null))
 
4595
 
 
4596
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4597
        """Return a stream of inventory-deltas for the given rev ids.
 
4598
 
 
4599
        :param revision_ids: The list of inventories to transmit
 
4600
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4601
            entry, instead compute the delta versus the NULL_REVISION. This
 
4602
            effectively streams a complete inventory. Used for stuff like
 
4603
            filling in missing parents, etc.
 
4604
        """
 
4605
        from_repo = self.from_repository
 
4606
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4607
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4608
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4609
        # method...
 
4610
        inventories = self.from_repository.iter_inventories(
 
4611
            revision_ids, 'topological')
 
4612
        format = from_repo._format
 
4613
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4614
        inventory_cache = lru_cache.LRUCache(50)
 
4615
        null_inventory = from_repo.revision_tree(
 
4616
            _mod_revision.NULL_REVISION).inventory
 
4617
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4618
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4619
        # repo back into a non-rich-root repo ought to be allowed)
 
4620
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4621
            versioned_root=format.rich_root_data,
 
4622
            tree_references=format.supports_tree_reference)
 
4623
        for inv in inventories:
 
4624
            key = (inv.revision_id,)
 
4625
            parent_keys = parent_map.get(key, ())
 
4626
            delta = None
 
4627
            if not delta_versus_null and parent_keys:
 
4628
                # The caller did not ask for complete inventories and we have
 
4629
                # some parents that we can delta against.  Make a delta against
 
4630
                # each parent so that we can find the smallest.
 
4631
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4632
                for parent_id in parent_ids:
 
4633
                    if parent_id not in invs_sent_so_far:
 
4634
                        # We don't know that the remote side has this basis, so
 
4635
                        # we can't use it.
 
4636
                        continue
 
4637
                    if parent_id == _mod_revision.NULL_REVISION:
 
4638
                        parent_inv = null_inventory
 
4639
                    else:
 
4640
                        parent_inv = inventory_cache.get(parent_id, None)
 
4641
                        if parent_inv is None:
 
4642
                            parent_inv = from_repo.get_inventory(parent_id)
 
4643
                    candidate_delta = inv._make_delta(parent_inv)
 
4644
                    if (delta is None or
 
4645
                        len(delta) > len(candidate_delta)):
 
4646
                        delta = candidate_delta
 
4647
                        basis_id = parent_id
 
4648
            if delta is None:
 
4649
                # Either none of the parents ended up being suitable, or we
 
4650
                # were asked to delta against NULL
 
4651
                basis_id = _mod_revision.NULL_REVISION
 
4652
                delta = inv._make_delta(null_inventory)
 
4653
            invs_sent_so_far.add(inv.revision_id)
 
4654
            inventory_cache[inv.revision_id] = inv
 
4655
            delta_serialized = ''.join(
 
4656
                serializer.delta_to_lines(basis_id, key[-1], delta))
 
4657
            yield versionedfile.FulltextContentFactory(
 
4658
                key, parent_keys, None, delta_serialized)
 
4659
 
 
4660
 
 
4661
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4662
                    stop_revision=None):
 
4663
    """Extend the partial history to include a given index
 
4664
 
 
4665
    If a stop_index is supplied, stop when that index has been reached.
 
4666
    If a stop_revision is supplied, stop when that revision is
 
4667
    encountered.  Otherwise, stop when the beginning of history is
 
4668
    reached.
 
4669
 
 
4670
    :param stop_index: The index which should be present.  When it is
 
4671
        present, history extension will stop.
 
4672
    :param stop_revision: The revision id which should be present.  When
 
4673
        it is encountered, history extension will stop.
 
4674
    """
 
4675
    start_revision = partial_history_cache[-1]
 
4676
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4677
    try:
 
4678
        #skip the last revision in the list
 
4679
        iterator.next()
 
4680
        while True:
 
4681
            if (stop_index is not None and
 
4682
                len(partial_history_cache) > stop_index):
 
4683
                break
 
4684
            if partial_history_cache[-1] == stop_revision:
 
4685
                break
 
4686
            revision_id = iterator.next()
 
4687
            partial_history_cache.append(revision_id)
 
4688
    except StopIteration:
 
4689
        # No more history
 
4690
        return
 
4691