/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: 2008-10-30 01:05:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3813.
  • Revision ID: andrew.bennetts@canonical.com-20081030010559-tumoefnsmhg4snxo
Add contrib/bzr_ssh_path_limiter.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
 
    fetch as _mod_fetch,
30
 
    fifo_cache,
 
27
    errors,
31
28
    generate_ids,
32
29
    gpg,
33
30
    graph,
34
 
    inventory,
35
 
    inventory_delta,
36
31
    lazy_regex,
37
32
    lockable_files,
38
33
    lockdir,
39
34
    lru_cache,
40
35
    osutils,
 
36
    remote,
41
37
    revision as _mod_revision,
42
 
    static_tuple,
43
38
    symbol_versioning,
44
 
    trace,
45
39
    tsort,
46
 
    versionedfile,
 
40
    ui,
47
41
    )
48
42
from bzrlib.bundle import serializer
49
43
from bzrlib.revisiontree import RevisionTree
51
45
from bzrlib.testament import Testament
52
46
""")
53
47
 
54
 
from bzrlib import (
55
 
    errors,
56
 
    registry,
57
 
    ui,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
48
from bzrlib import registry
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
50
from bzrlib.inter import InterObject
61
 
from bzrlib.inventory import (
62
 
    Inventory,
63
 
    InventoryDirectory,
64
 
    ROOT_ID,
65
 
    entry_factory,
66
 
    )
67
 
from bzrlib.recordcounter import RecordCounter
68
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
69
 
from bzrlib.trace import (
70
 
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
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
71
59
 
72
60
 
73
61
# Old formats display a warning, but only once
74
62
_deprecation_warning_done = False
75
63
 
76
64
 
77
 
class IsInWriteGroupError(errors.InternalBzrError):
78
 
 
79
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
80
 
 
81
 
    def __init__(self, repo):
82
 
        errors.InternalBzrError.__init__(self, repo=repo)
83
 
 
84
 
 
85
65
class CommitBuilder(object):
86
66
    """Provides an interface to build up a commit.
87
67
 
88
 
    This allows describing a tree to be committed without needing to
 
68
    This allows describing a tree to be committed without needing to 
89
69
    know the internals of the format of the repository.
90
70
    """
91
 
 
 
71
    
92
72
    # all clients should supply tree roots.
93
73
    record_root_entry = True
94
74
    # the default CommitBuilder does not manage trees whose root is versioned.
122
102
 
123
103
        self._revprops = {}
124
104
        if revprops is not None:
125
 
            self._validate_revprops(revprops)
126
105
            self._revprops.update(revprops)
127
106
 
128
107
        if timestamp is None:
137
116
 
138
117
        self._generate_revision_if_needed()
139
118
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
140
 
        self._basis_delta = []
141
 
        # API compatibility, older code that used CommitBuilder did not call
142
 
        # .record_delete(), which means the delta that is computed would not be
143
 
        # valid. Callers that will call record_delete() should call
144
 
        # .will_record_deletes() to indicate that.
145
 
        self._recording_deletes = False
146
 
        # memo'd check for no-op commits.
147
 
        self._any_changes = False
148
 
 
149
 
    def any_changes(self):
150
 
        """Return True if any entries were changed.
151
 
        
152
 
        This includes merge-only changes. It is the core for the --unchanged
153
 
        detection in commit.
154
 
 
155
 
        :return: True if any changes have occured.
156
 
        """
157
 
        return self._any_changes
158
 
 
159
 
    def _validate_unicode_text(self, text, context):
160
 
        """Verify things like commit messages don't have bogus characters."""
161
 
        if '\r' in text:
162
 
            raise ValueError('Invalid value for %s: %r' % (context, text))
163
 
 
164
 
    def _validate_revprops(self, revprops):
165
 
        for key, value in revprops.iteritems():
166
 
            # We know that the XML serializers do not round trip '\r'
167
 
            # correctly, so refuse to accept them
168
 
            if not isinstance(value, basestring):
169
 
                raise ValueError('revision property (%s) is not a valid'
170
 
                                 ' (unicode) string: %r' % (key, value))
171
 
            self._validate_unicode_text(value,
172
 
                                        'revision property (%s)' % (key,))
173
119
 
174
120
    def commit(self, message):
175
121
        """Make the actual commit.
176
122
 
177
123
        :return: The revision id of the recorded revision.
178
124
        """
179
 
        self._validate_unicode_text(message, 'commit message')
180
125
        rev = _mod_revision.Revision(
181
126
                       timestamp=self._timestamp,
182
127
                       timezone=self._timezone,
205
150
        deserializing the inventory, while we already have a copy in
206
151
        memory.
207
152
        """
208
 
        if self.new_inventory is None:
209
 
            self.new_inventory = self.repository.get_inventory(
210
 
                self._new_revision_id)
211
153
        return RevisionTree(self.repository, self.new_inventory,
212
 
            self._new_revision_id)
 
154
                            self._new_revision_id)
213
155
 
214
156
    def finish_inventory(self):
215
 
        """Tell the builder that the inventory is finished.
216
 
 
217
 
        :return: The inventory id in the repository, which can be used with
218
 
            repository.get_inventory.
219
 
        """
220
 
        if self.new_inventory is None:
221
 
            # an inventory delta was accumulated without creating a new
222
 
            # inventory.
223
 
            basis_id = self.basis_delta_revision
224
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
225
 
            # because self.new_inventory is used to hint to the rest of the
226
 
            # system what code path was taken
227
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
228
 
                basis_id, self._basis_delta, self._new_revision_id,
229
 
                self.parents)
230
 
        else:
231
 
            if self.new_inventory.root is None:
232
 
                raise AssertionError('Root entry should be supplied to'
233
 
                    ' record_entry_contents, as of bzr 0.10.')
234
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
235
 
            self.new_inventory.revision_id = self._new_revision_id
236
 
            self.inv_sha1 = self.repository.add_inventory(
237
 
                self._new_revision_id,
238
 
                self.new_inventory,
239
 
                self.parents
240
 
                )
241
 
        return self._new_revision_id
 
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
            )
242
168
 
243
169
    def _gen_revision_id(self):
244
170
        """Return new revision-id."""
247
173
 
248
174
    def _generate_revision_if_needed(self):
249
175
        """Create a revision id if None was supplied.
250
 
 
 
176
        
251
177
        If the repository can not support user-specified revision ids
252
178
        they should override this function and raise CannotSetRevisionId
253
179
        if _new_revision_id is not None.
281
207
        # _new_revision_id
282
208
        ie.revision = self._new_revision_id
283
209
 
284
 
    def _require_root_change(self, tree):
285
 
        """Enforce an appropriate root object change.
286
 
 
287
 
        This is called once when record_iter_changes is called, if and only if
288
 
        the root was not in the delta calculated by record_iter_changes.
289
 
 
290
 
        :param tree: The tree which is being committed.
291
 
        """
292
 
        if len(self.parents) == 0:
293
 
            raise errors.RootMissing()
294
 
        entry = entry_factory['directory'](tree.path2id(''), '',
295
 
            None)
296
 
        entry.revision = self._new_revision_id
297
 
        self._basis_delta.append(('', '', entry.file_id, entry))
298
 
 
299
210
    def _get_delta(self, ie, basis_inv, path):
300
211
        """Get a delta against the basis inventory for ie."""
301
212
        if ie.file_id not in basis_inv:
302
213
            # add
303
 
            result = (None, path, ie.file_id, ie)
304
 
            self._basis_delta.append(result)
305
 
            return result
 
214
            return (None, path, ie.file_id, ie)
306
215
        elif ie != basis_inv[ie.file_id]:
307
216
            # common but altered
308
217
            # TODO: avoid tis id2path call.
309
 
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
310
 
            self._basis_delta.append(result)
311
 
            return result
 
218
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
312
219
        else:
313
220
            # common, unaltered
314
221
            return None
315
222
 
316
 
    def get_basis_delta(self):
317
 
        """Return the complete inventory delta versus the basis inventory.
318
 
 
319
 
        This has been built up with the calls to record_delete and
320
 
        record_entry_contents. The client must have already called
321
 
        will_record_deletes() to indicate that they will be generating a
322
 
        complete delta.
323
 
 
324
 
        :return: An inventory delta, suitable for use with apply_delta, or
325
 
            Repository.add_inventory_by_delta, etc.
326
 
        """
327
 
        if not self._recording_deletes:
328
 
            raise AssertionError("recording deletes not activated.")
329
 
        return self._basis_delta
330
 
 
331
 
    def record_delete(self, path, file_id):
332
 
        """Record that a delete occured against a basis tree.
333
 
 
334
 
        This is an optional API - when used it adds items to the basis_delta
335
 
        being accumulated by the commit builder. It cannot be called unless the
336
 
        method will_record_deletes() has been called to inform the builder that
337
 
        a delta is being supplied.
338
 
 
339
 
        :param path: The path of the thing deleted.
340
 
        :param file_id: The file id that was deleted.
341
 
        """
342
 
        if not self._recording_deletes:
343
 
            raise AssertionError("recording deletes not activated.")
344
 
        delta = (path, None, file_id, None)
345
 
        self._basis_delta.append(delta)
346
 
        self._any_changes = True
347
 
        return delta
348
 
 
349
 
    def will_record_deletes(self):
350
 
        """Tell the commit builder that deletes are being notified.
351
 
 
352
 
        This enables the accumulation of an inventory delta; for the resulting
353
 
        commit to be valid, deletes against the basis MUST be recorded via
354
 
        builder.record_delete().
355
 
        """
356
 
        self._recording_deletes = True
357
 
        try:
358
 
            basis_id = self.parents[0]
359
 
        except IndexError:
360
 
            basis_id = _mod_revision.NULL_REVISION
361
 
        self.basis_delta_revision = basis_id
362
 
 
363
223
    def record_entry_contents(self, ie, parent_invs, path, tree,
364
224
        content_summary):
365
225
        """Record the content of ie from tree into the commit if needed.
370
230
        :param parent_invs: The inventories of the parent revisions of the
371
231
            commit.
372
232
        :param path: The path the entry is at in the tree.
373
 
        :param tree: The tree which contains this entry and should be used to
 
233
        :param tree: The tree which contains this entry and should be used to 
374
234
            obtain content.
375
235
        :param content_summary: Summary data from the tree about the paths
376
236
            content - stat, length, exec, sha/link target. This is only
417
277
        if ie.revision is not None:
418
278
            if not self._versioned_root and path == '':
419
279
                # repositories that do not version the root set the root's
420
 
                # revision to the new commit even when no change occurs (more
421
 
                # specifically, they do not record a revision on the root; and
422
 
                # the rev id is assigned to the root during deserialisation -
423
 
                # this masks when a change may have occurred against the basis.
424
 
                # To match this we always issue a delta, because the revision
425
 
                # of the root will always be changing.
 
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.
426
283
                if ie.file_id in basis_inv:
427
284
                    delta = (basis_inv.id2path(ie.file_id), path,
428
285
                        ie.file_id, ie)
429
286
                else:
430
287
                    # add
431
288
                    delta = (None, path, ie.file_id, ie)
432
 
                self._basis_delta.append(delta)
433
289
                return delta, False, None
434
290
            else:
435
291
                # we don't need to commit this, because the caller already
484
340
            if content_summary[2] is None:
485
341
                raise ValueError("Files must not have executable = None")
486
342
            if not store:
487
 
                # We can't trust a check of the file length because of content
488
 
                # filtering...
489
 
                if (# if the exec bit has changed we have to 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:
490
346
                    parent_entry.executable != content_summary[2]):
491
347
                    store = True
492
348
                elif parent_entry.text_sha1 == content_summary[3]:
511
367
            ie.executable = content_summary[2]
512
368
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
513
369
            try:
514
 
                text = file_obj.read()
 
370
                lines = file_obj.readlines()
515
371
            finally:
516
372
                file_obj.close()
517
373
            try:
518
374
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
519
 
                    ie.file_id, text, heads, nostore_sha)
 
375
                    ie.file_id, lines, heads, nostore_sha)
520
376
                # Let the caller know we generated a stat fingerprint.
521
377
                fingerprint = (ie.text_sha1, stat_value)
522
378
            except errors.ExistingContent:
534
390
                # carry over:
535
391
                ie.revision = parent_entry.revision
536
392
                return self._get_delta(ie, basis_inv, path), False, None
537
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
393
            lines = []
 
394
            self._add_text_to_weave(ie.file_id, lines, heads, None)
538
395
        elif kind == 'symlink':
539
396
            current_link_target = content_summary[3]
540
397
            if not store:
548
405
                ie.symlink_target = parent_entry.symlink_target
549
406
                return self._get_delta(ie, basis_inv, path), False, None
550
407
            ie.symlink_target = current_link_target
551
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
408
            lines = []
 
409
            self._add_text_to_weave(ie.file_id, lines, heads, None)
552
410
        elif kind == 'tree-reference':
553
411
            if not store:
554
412
                if content_summary[3] != parent_entry.reference_revision:
559
417
                ie.revision = parent_entry.revision
560
418
                return self._get_delta(ie, basis_inv, path), False, None
561
419
            ie.reference_revision = content_summary[3]
562
 
            if ie.reference_revision is None:
563
 
                raise AssertionError("invalid content_summary for nested tree: %r"
564
 
                    % (content_summary,))
565
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
420
            lines = []
 
421
            self._add_text_to_weave(ie.file_id, lines, heads, None)
566
422
        else:
567
423
            raise NotImplementedError('unknown kind')
568
424
        ie.revision = self._new_revision_id
569
 
        self._any_changes = True
570
425
        return self._get_delta(ie, basis_inv, path), True, fingerprint
571
426
 
572
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
573
 
        _entry_factory=entry_factory):
574
 
        """Record a new tree via iter_changes.
575
 
 
576
 
        :param tree: The tree to obtain text contents from for changed objects.
577
 
        :param basis_revision_id: The revision id of the tree the iter_changes
578
 
            has been generated against. Currently assumed to be the same
579
 
            as self.parents[0] - if it is not, errors may occur.
580
 
        :param iter_changes: An iter_changes iterator with the changes to apply
581
 
            to basis_revision_id. The iterator must not include any items with
582
 
            a current kind of None - missing items must be either filtered out
583
 
            or errored-on beefore record_iter_changes sees the item.
584
 
        :param _entry_factory: Private method to bind entry_factory locally for
585
 
            performance.
586
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
587
 
            tree._observed_sha1.
588
 
        """
589
 
        # Create an inventory delta based on deltas between all the parents and
590
 
        # deltas between all the parent inventories. We use inventory delta's 
591
 
        # between the inventory objects because iter_changes masks
592
 
        # last-changed-field only changes.
593
 
        # Working data:
594
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
595
 
        # parents, names, kinds, executables
596
 
        merged_ids = {}
597
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
598
 
        # trees that are not parents[0]
599
 
        parent_entries = {}
600
 
        ghost_basis = False
601
 
        try:
602
 
            revtrees = list(self.repository.revision_trees(self.parents))
603
 
        except errors.NoSuchRevision:
604
 
            # one or more ghosts, slow path.
605
 
            revtrees = []
606
 
            for revision_id in self.parents:
607
 
                try:
608
 
                    revtrees.append(self.repository.revision_tree(revision_id))
609
 
                except errors.NoSuchRevision:
610
 
                    if not revtrees:
611
 
                        basis_revision_id = _mod_revision.NULL_REVISION
612
 
                        ghost_basis = True
613
 
                    revtrees.append(self.repository.revision_tree(
614
 
                        _mod_revision.NULL_REVISION))
615
 
        # The basis inventory from a repository 
616
 
        if revtrees:
617
 
            basis_inv = revtrees[0].inventory
618
 
        else:
619
 
            basis_inv = self.repository.revision_tree(
620
 
                _mod_revision.NULL_REVISION).inventory
621
 
        if len(self.parents) > 0:
622
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
623
 
                raise Exception(
624
 
                    "arbitrary basis parents not yet supported with merges")
625
 
            for revtree in revtrees[1:]:
626
 
                for change in revtree.inventory._make_delta(basis_inv):
627
 
                    if change[1] is None:
628
 
                        # Not present in this parent.
629
 
                        continue
630
 
                    if change[2] not in merged_ids:
631
 
                        if change[0] is not None:
632
 
                            basis_entry = basis_inv[change[2]]
633
 
                            merged_ids[change[2]] = [
634
 
                                # basis revid
635
 
                                basis_entry.revision,
636
 
                                # new tree revid
637
 
                                change[3].revision]
638
 
                            parent_entries[change[2]] = {
639
 
                                # basis parent
640
 
                                basis_entry.revision:basis_entry,
641
 
                                # this parent 
642
 
                                change[3].revision:change[3],
643
 
                                }
644
 
                        else:
645
 
                            merged_ids[change[2]] = [change[3].revision]
646
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
647
 
                    else:
648
 
                        merged_ids[change[2]].append(change[3].revision)
649
 
                        parent_entries[change[2]][change[3].revision] = change[3]
650
 
        else:
651
 
            merged_ids = {}
652
 
        # Setup the changes from the tree:
653
 
        # changes maps file_id -> (change, [parent revision_ids])
654
 
        changes= {}
655
 
        for change in iter_changes:
656
 
            # This probably looks up in basis_inv way to much.
657
 
            if change[1][0] is not None:
658
 
                head_candidate = [basis_inv[change[0]].revision]
659
 
            else:
660
 
                head_candidate = []
661
 
            changes[change[0]] = change, merged_ids.get(change[0],
662
 
                head_candidate)
663
 
        unchanged_merged = set(merged_ids) - set(changes)
664
 
        # Extend the changes dict with synthetic changes to record merges of
665
 
        # texts.
666
 
        for file_id in unchanged_merged:
667
 
            # Record a merged version of these items that did not change vs the
668
 
            # basis. This can be either identical parallel changes, or a revert
669
 
            # of a specific file after a merge. The recorded content will be
670
 
            # that of the current tree (which is the same as the basis), but
671
 
            # the per-file graph will reflect a merge.
672
 
            # NB:XXX: We are reconstructing path information we had, this
673
 
            # should be preserved instead.
674
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
675
 
            #   changed_content, versioned, parent, name, kind,
676
 
            #   executable)
677
 
            try:
678
 
                basis_entry = basis_inv[file_id]
679
 
            except errors.NoSuchId:
680
 
                # a change from basis->some_parents but file_id isn't in basis
681
 
                # so was new in the merge, which means it must have changed
682
 
                # from basis -> current, and as it hasn't the add was reverted
683
 
                # by the user. So we discard this change.
684
 
                pass
685
 
            else:
686
 
                change = (file_id,
687
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
688
 
                    False, (True, True),
689
 
                    (basis_entry.parent_id, basis_entry.parent_id),
690
 
                    (basis_entry.name, basis_entry.name),
691
 
                    (basis_entry.kind, basis_entry.kind),
692
 
                    (basis_entry.executable, basis_entry.executable))
693
 
                changes[file_id] = (change, merged_ids[file_id])
694
 
        # changes contains tuples with the change and a set of inventory
695
 
        # candidates for the file.
696
 
        # inv delta is:
697
 
        # old_path, new_path, file_id, new_inventory_entry
698
 
        seen_root = False # Is the root in the basis delta?
699
 
        inv_delta = self._basis_delta
700
 
        modified_rev = self._new_revision_id
701
 
        for change, head_candidates in changes.values():
702
 
            if change[3][1]: # versioned in target.
703
 
                # Several things may be happening here:
704
 
                # We may have a fork in the per-file graph
705
 
                #  - record a change with the content from tree
706
 
                # We may have a change against < all trees  
707
 
                #  - carry over the tree that hasn't changed
708
 
                # We may have a change against all trees
709
 
                #  - record the change with the content from tree
710
 
                kind = change[6][1]
711
 
                file_id = change[0]
712
 
                entry = _entry_factory[kind](file_id, change[5][1],
713
 
                    change[4][1])
714
 
                head_set = self._heads(change[0], set(head_candidates))
715
 
                heads = []
716
 
                # Preserve ordering.
717
 
                for head_candidate in head_candidates:
718
 
                    if head_candidate in head_set:
719
 
                        heads.append(head_candidate)
720
 
                        head_set.remove(head_candidate)
721
 
                carried_over = False
722
 
                if len(heads) == 1:
723
 
                    # Could be a carry-over situation:
724
 
                    parent_entry_revs = parent_entries.get(file_id, None)
725
 
                    if parent_entry_revs:
726
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
727
 
                    else:
728
 
                        parent_entry = None
729
 
                    if parent_entry is None:
730
 
                        # The parent iter_changes was called against is the one
731
 
                        # that is the per-file head, so any change is relevant
732
 
                        # iter_changes is valid.
733
 
                        carry_over_possible = False
734
 
                    else:
735
 
                        # could be a carry over situation
736
 
                        # A change against the basis may just indicate a merge,
737
 
                        # we need to check the content against the source of the
738
 
                        # merge to determine if it was changed after the merge
739
 
                        # or carried over.
740
 
                        if (parent_entry.kind != entry.kind or
741
 
                            parent_entry.parent_id != entry.parent_id or
742
 
                            parent_entry.name != entry.name):
743
 
                            # Metadata common to all entries has changed
744
 
                            # against per-file parent
745
 
                            carry_over_possible = False
746
 
                        else:
747
 
                            carry_over_possible = True
748
 
                        # per-type checks for changes against the parent_entry
749
 
                        # are done below.
750
 
                else:
751
 
                    # Cannot be a carry-over situation
752
 
                    carry_over_possible = False
753
 
                # Populate the entry in the delta
754
 
                if kind == 'file':
755
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
756
 
                    # after iter_changes examines and decides it has changed,
757
 
                    # we will unconditionally record a new version even if some
758
 
                    # other process reverts it while commit is running (with
759
 
                    # the revert happening after iter_changes did it's
760
 
                    # examination).
761
 
                    if change[7][1]:
762
 
                        entry.executable = True
763
 
                    else:
764
 
                        entry.executable = False
765
 
                    if (carry_over_possible and
766
 
                        parent_entry.executable == entry.executable):
767
 
                            # Check the file length, content hash after reading
768
 
                            # the file.
769
 
                            nostore_sha = parent_entry.text_sha1
770
 
                    else:
771
 
                        nostore_sha = None
772
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
773
 
                    try:
774
 
                        text = file_obj.read()
775
 
                    finally:
776
 
                        file_obj.close()
777
 
                    try:
778
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
779
 
                            file_id, text, heads, nostore_sha)
780
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
781
 
                    except errors.ExistingContent:
782
 
                        # No content change against a carry_over parent
783
 
                        # Perhaps this should also yield a fs hash update?
784
 
                        carried_over = True
785
 
                        entry.text_size = parent_entry.text_size
786
 
                        entry.text_sha1 = parent_entry.text_sha1
787
 
                elif kind == 'symlink':
788
 
                    # Wants a path hint?
789
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
790
 
                    if (carry_over_possible and
791
 
                        parent_entry.symlink_target == entry.symlink_target):
792
 
                        carried_over = True
793
 
                    else:
794
 
                        self._add_text_to_weave(change[0], '', heads, None)
795
 
                elif kind == 'directory':
796
 
                    if carry_over_possible:
797
 
                        carried_over = True
798
 
                    else:
799
 
                        # Nothing to set on the entry.
800
 
                        # XXX: split into the Root and nonRoot versions.
801
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
802
 
                            self._add_text_to_weave(change[0], '', heads, None)
803
 
                elif kind == 'tree-reference':
804
 
                    if not self.repository._format.supports_tree_reference:
805
 
                        # This isn't quite sane as an error, but we shouldn't
806
 
                        # ever see this code path in practice: tree's don't
807
 
                        # permit references when the repo doesn't support tree
808
 
                        # references.
809
 
                        raise errors.UnsupportedOperation(tree.add_reference,
810
 
                            self.repository)
811
 
                    reference_revision = tree.get_reference_revision(change[0])
812
 
                    entry.reference_revision = reference_revision
813
 
                    if (carry_over_possible and
814
 
                        parent_entry.reference_revision == reference_revision):
815
 
                        carried_over = True
816
 
                    else:
817
 
                        self._add_text_to_weave(change[0], '', heads, None)
818
 
                else:
819
 
                    raise AssertionError('unknown kind %r' % kind)
820
 
                if not carried_over:
821
 
                    entry.revision = modified_rev
822
 
                else:
823
 
                    entry.revision = parent_entry.revision
824
 
            else:
825
 
                entry = None
826
 
            new_path = change[1][1]
827
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
828
 
            if new_path == '':
829
 
                seen_root = True
830
 
        self.new_inventory = None
831
 
        if len(inv_delta):
832
 
            # This should perhaps be guarded by a check that the basis we
833
 
            # commit against is the basis for the commit and if not do a delta
834
 
            # against the basis.
835
 
            self._any_changes = True
836
 
        if not seen_root:
837
 
            # housekeeping root entry changes do not affect no-change commits.
838
 
            self._require_root_change(tree)
839
 
        self.basis_delta_revision = basis_revision_id
840
 
 
841
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
842
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
843
 
        return self.repository.texts._add_text(
844
 
            (file_id, self._new_revision_id), parent_keys, new_text,
845
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
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]
846
438
 
847
439
 
848
440
class RootCommitBuilder(CommitBuilder):
849
441
    """This commitbuilder actually records the root id"""
850
 
 
 
442
    
851
443
    # the root entry gets versioned properly by this builder.
852
444
    _versioned_root = True
853
445
 
860
452
        :param tree: The tree that is being committed.
861
453
        """
862
454
 
863
 
    def _require_root_change(self, tree):
864
 
        """Enforce an appropriate root object change.
865
 
 
866
 
        This is called once when record_iter_changes is called, if and only if
867
 
        the root was not in the delta calculated by record_iter_changes.
868
 
 
869
 
        :param tree: The tree which is being committed.
870
 
        """
871
 
        # versioned roots do not change unless the tree found a change.
872
 
 
873
 
 
874
 
class RepositoryWriteLockResult(LogicalLockResult):
875
 
    """The result of write locking a repository.
876
 
 
877
 
    :ivar repository_token: The token obtained from the underlying lock, or
878
 
        None.
879
 
    :ivar unlock: A callable which will unlock the lock.
880
 
    """
881
 
 
882
 
    def __init__(self, unlock, repository_token):
883
 
        LogicalLockResult.__init__(self, unlock)
884
 
        self.repository_token = repository_token
885
 
 
886
 
    def __repr__(self):
887
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
888
 
            self.unlock)
889
 
 
890
455
 
891
456
######################################################################
892
457
# Repositories
893
458
 
894
 
 
895
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
459
class Repository(object):
896
460
    """Repository holding history for one or more branches.
897
461
 
898
462
    The repository holds and retrieves historical information including
900
464
    which views a particular line of development through that history.
901
465
 
902
466
    The Repository builds on top of some byte storage facilies (the revisions,
903
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
904
 
    which respectively provide byte storage and a means to access the (possibly
 
467
    signatures, inventories and texts attributes) and a Transport, which
 
468
    respectively provide byte storage and a means to access the (possibly
905
469
    remote) disk.
906
470
 
907
471
    The byte storage facilities are addressed via tuples, which we refer to
908
472
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
909
473
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
910
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
911
 
    byte string made up of a hash identifier and a hash value.
912
 
    We use this interface because it allows low friction with the underlying
913
 
    code that implements disk indices, network encoding and other parts of
914
 
    bzrlib.
 
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.
915
477
 
916
478
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
917
479
        the serialised revisions for the repository. This can be used to obtain
936
498
        The result of trying to insert data into the repository via this store
937
499
        is undefined: it should be considered read-only except for implementors
938
500
        of repositories.
939
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
940
 
        any data the repository chooses to store or have indexed by its hash.
941
 
        The result of trying to insert data into the repository via this store
942
 
        is undefined: it should be considered read-only except for implementors
943
 
        of repositories.
944
501
    :ivar _transport: Transport for file access to repository, typically
945
502
        pointing to .bzr/repository.
946
503
    """
956
513
        r'.* revision="(?P<revision_id>[^"]+)"'
957
514
        )
958
515
 
959
 
    def abort_write_group(self, suppress_errors=False):
 
516
    def abort_write_group(self):
960
517
        """Commit the contents accrued within the current write group.
961
518
 
962
 
        :param suppress_errors: if true, abort_write_group will catch and log
963
 
            unexpected errors that happen during the abort, rather than
964
 
            allowing them to propagate.  Defaults to False.
965
 
 
966
519
        :seealso: start_write_group.
967
520
        """
968
521
        if self._write_group is not self.get_transaction():
969
522
            # has an unlock or relock occured ?
970
 
            if suppress_errors:
971
 
                mutter(
972
 
                '(suppressed) mismatched lock context and write group. %r, %r',
973
 
                self._write_group, self.get_transaction())
974
 
                return
975
 
            raise errors.BzrError(
976
 
                'mismatched lock context and write group. %r, %r' %
977
 
                (self._write_group, self.get_transaction()))
978
 
        try:
979
 
            self._abort_write_group()
980
 
        except Exception, exc:
981
 
            self._write_group = None
982
 
            if not suppress_errors:
983
 
                raise
984
 
            mutter('abort_write_group failed')
985
 
            log_exception_quietly()
986
 
            note('bzr: ERROR (ignored): %s', exc)
 
523
            raise errors.BzrError('mismatched lock context and write group.')
 
524
        self._abort_write_group()
987
525
        self._write_group = None
988
526
 
989
527
    def _abort_write_group(self):
990
528
        """Template method for per-repository write group cleanup.
991
 
 
992
 
        This is called during abort before the write group is considered to be
 
529
        
 
530
        This is called during abort before the write group is considered to be 
993
531
        finished and should cleanup any internal state accrued during the write
994
532
        group. There is no requirement that data handed to the repository be
995
533
        *not* made available - this is not a rollback - but neither should any
1001
539
 
1002
540
    def add_fallback_repository(self, repository):
1003
541
        """Add a repository to use for looking up data not held locally.
1004
 
 
 
542
        
1005
543
        :param repository: A repository.
1006
544
        """
1007
545
        if not self._format.supports_external_lookups:
1008
546
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1009
 
        if self.is_locked():
1010
 
            # This repository will call fallback.unlock() when we transition to
1011
 
            # the unlocked state, so we make sure to increment the lock count
1012
 
            repository.lock_read()
1013
547
        self._check_fallback_repository(repository)
1014
548
        self._fallback_repositories.append(repository)
1015
549
        self.texts.add_fallback_versioned_files(repository.texts)
1016
550
        self.inventories.add_fallback_versioned_files(repository.inventories)
1017
551
        self.revisions.add_fallback_versioned_files(repository.revisions)
1018
552
        self.signatures.add_fallback_versioned_files(repository.signatures)
1019
 
        if self.chk_bytes is not None:
1020
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1021
553
 
1022
554
    def _check_fallback_repository(self, repository):
1023
555
        """Check that this repository can fallback to repository safely.
1024
556
 
1025
557
        Raise an error if not.
1026
 
 
 
558
        
1027
559
        :param repository: A repository to fallback to.
1028
560
        """
1029
561
        return InterRepository._assert_same_model(self, repository)
1030
562
 
1031
563
    def add_inventory(self, revision_id, inv, parents):
1032
564
        """Add the inventory inv to the repository as revision_id.
1033
 
 
 
565
        
1034
566
        :param parents: The revision ids of the parents that revision_id
1035
567
                        is known to have and are in the repository already.
1036
568
 
1046
578
                " id and insertion revid (%r, %r)"
1047
579
                % (inv.revision_id, revision_id))
1048
580
        if inv.root is None:
1049
 
            raise errors.RootMissing()
1050
 
        return self._add_inventory_checked(revision_id, inv, parents)
1051
 
 
1052
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1053
 
        """Add inv to the repository after checking the inputs.
1054
 
 
1055
 
        This function can be overridden to allow different inventory styles.
1056
 
 
1057
 
        :seealso: add_inventory, for the contract.
1058
 
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
581
            raise AssertionError()
 
582
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
583
        return self._inventory_add_lines(revision_id, parents,
1061
584
            inv_lines, check_content=False)
1062
585
 
1063
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1064
 
                               parents, basis_inv=None, propagate_caches=False):
1065
 
        """Add a new inventory expressed as a delta against another revision.
1066
 
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
 
        :param basis_revision_id: The inventory id the delta was created
1071
 
            against. (This does not have to be a direct parent.)
1072
 
        :param delta: The inventory delta (see Inventory.apply_delta for
1073
 
            details).
1074
 
        :param new_revision_id: The revision id that the inventory is being
1075
 
            added for.
1076
 
        :param parents: The revision ids of the parents that revision_id is
1077
 
            known to have and are in the repository already. These are supplied
1078
 
            for repositories that depend on the inventory graph for revision
1079
 
            graph access, as well as for those that pun ancestry with delta
1080
 
            compression.
1081
 
        :param basis_inv: The basis inventory if it is already known,
1082
 
            otherwise None.
1083
 
        :param propagate_caches: If True, the caches for this inventory are
1084
 
          copied to and updated for the result if possible.
1085
 
 
1086
 
        :returns: (validator, new_inv)
1087
 
            The validator(which is a sha1 digest, though what is sha'd is
1088
 
            repository format specific) of the serialized inventory, and the
1089
 
            resulting inventory.
1090
 
        """
1091
 
        if not self.is_in_write_group():
1092
 
            raise AssertionError("%r not in write group" % (self,))
1093
 
        _mod_revision.check_not_reserved_id(new_revision_id)
1094
 
        basis_tree = self.revision_tree(basis_revision_id)
1095
 
        basis_tree.lock_read()
1096
 
        try:
1097
 
            # Note that this mutates the inventory of basis_tree, which not all
1098
 
            # inventory implementations may support: A better idiom would be to
1099
 
            # return a new inventory, but as there is no revision tree cache in
1100
 
            # repository this is safe for now - RBC 20081013
1101
 
            if basis_inv is None:
1102
 
                basis_inv = basis_tree.inventory
1103
 
            basis_inv.apply_delta(delta)
1104
 
            basis_inv.revision_id = new_revision_id
1105
 
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1106
 
                    basis_inv)
1107
 
        finally:
1108
 
            basis_tree.unlock()
1109
 
 
1110
586
    def _inventory_add_lines(self, revision_id, parents, lines,
1111
587
        check_content=True):
1112
588
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
589
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
590
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
591
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
592
 
1119
593
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
594
        """Add rev to the revision store as revision_id.
1157
631
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
1158
632
 
1159
633
    def all_revision_ids(self):
1160
 
        """Returns a list of all the revision ids in the repository.
 
634
        """Returns a list of all the revision ids in the repository. 
1161
635
 
1162
636
        This is conceptually deprecated because code should generally work on
1163
637
        the graph reachable from a particular revision, and ignore any other
1169
643
        return self._all_revision_ids()
1170
644
 
1171
645
    def _all_revision_ids(self):
1172
 
        """Returns a list of all the revision ids in the repository.
 
646
        """Returns a list of all the revision ids in the repository. 
1173
647
 
1174
 
        These are in as much topological order as the underlying store can
 
648
        These are in as much topological order as the underlying store can 
1175
649
        present.
1176
650
        """
1177
651
        raise NotImplementedError(self._all_revision_ids)
1196
670
        # The old API returned a list, should this actually be a set?
1197
671
        return parent_map.keys()
1198
672
 
1199
 
    def _check_inventories(self, checker):
1200
 
        """Check the inventories found from the revision scan.
1201
 
        
1202
 
        This is responsible for verifying the sha1 of inventories and
1203
 
        creating a pending_keys set that covers data referenced by inventories.
1204
 
        """
1205
 
        bar = ui.ui_factory.nested_progress_bar()
1206
 
        try:
1207
 
            self._do_check_inventories(checker, bar)
1208
 
        finally:
1209
 
            bar.finished()
1210
 
 
1211
 
    def _do_check_inventories(self, checker, bar):
1212
 
        """Helper for _check_inventories."""
1213
 
        revno = 0
1214
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1215
 
        kinds = ['chk_bytes', 'texts']
1216
 
        count = len(checker.pending_keys)
1217
 
        bar.update("inventories", 0, 2)
1218
 
        current_keys = checker.pending_keys
1219
 
        checker.pending_keys = {}
1220
 
        # Accumulate current checks.
1221
 
        for key in current_keys:
1222
 
            if key[0] != 'inventories' and key[0] not in kinds:
1223
 
                checker._report_items.append('unknown key type %r' % (key,))
1224
 
            keys[key[0]].add(key[1:])
1225
 
        if keys['inventories']:
1226
 
            # NB: output order *should* be roughly sorted - topo or
1227
 
            # inverse topo depending on repository - either way decent
1228
 
            # to just delta against. However, pre-CHK formats didn't
1229
 
            # try to optimise inventory layout on disk. As such the
1230
 
            # pre-CHK code path does not use inventory deltas.
1231
 
            last_object = None
1232
 
            for record in self.inventories.check(keys=keys['inventories']):
1233
 
                if record.storage_kind == 'absent':
1234
 
                    checker._report_items.append(
1235
 
                        'Missing inventory {%s}' % (record.key,))
1236
 
                else:
1237
 
                    last_object = self._check_record('inventories', record,
1238
 
                        checker, last_object,
1239
 
                        current_keys[('inventories',) + record.key])
1240
 
            del keys['inventories']
1241
 
        else:
1242
 
            return
1243
 
        bar.update("texts", 1)
1244
 
        while (checker.pending_keys or keys['chk_bytes']
1245
 
            or keys['texts']):
1246
 
            # Something to check.
1247
 
            current_keys = checker.pending_keys
1248
 
            checker.pending_keys = {}
1249
 
            # Accumulate current checks.
1250
 
            for key in current_keys:
1251
 
                if key[0] not in kinds:
1252
 
                    checker._report_items.append('unknown key type %r' % (key,))
1253
 
                keys[key[0]].add(key[1:])
1254
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1255
 
            for kind in kinds:
1256
 
                if keys[kind]:
1257
 
                    last_object = None
1258
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1259
 
                        if record.storage_kind == 'absent':
1260
 
                            checker._report_items.append(
1261
 
                                'Missing %s {%s}' % (kind, record.key,))
1262
 
                        else:
1263
 
                            last_object = self._check_record(kind, record,
1264
 
                                checker, last_object, current_keys[(kind,) + record.key])
1265
 
                    keys[kind] = set()
1266
 
                    break
1267
 
 
1268
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1269
 
        """Check a single text from this repository."""
1270
 
        if kind == 'inventories':
1271
 
            rev_id = record.key[0]
1272
 
            inv = self._deserialise_inventory(rev_id,
1273
 
                record.get_bytes_as('fulltext'))
1274
 
            if last_object is not None:
1275
 
                delta = inv._make_delta(last_object)
1276
 
                for old_path, path, file_id, ie in delta:
1277
 
                    if ie is None:
1278
 
                        continue
1279
 
                    ie.check(checker, rev_id, inv)
1280
 
            else:
1281
 
                for path, ie in inv.iter_entries():
1282
 
                    ie.check(checker, rev_id, inv)
1283
 
            if self._format.fast_deltas:
1284
 
                return inv
1285
 
        elif kind == 'chk_bytes':
1286
 
            # No code written to check chk_bytes for this repo format.
1287
 
            checker._report_items.append(
1288
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1289
 
        elif kind == 'texts':
1290
 
            self._check_text(record, checker, item_data)
1291
 
        else:
1292
 
            checker._report_items.append(
1293
 
                'unknown key type %s for %s' % (kind, record.key))
1294
 
 
1295
 
    def _check_text(self, record, checker, item_data):
1296
 
        """Check a single text."""
1297
 
        # Check it is extractable.
1298
 
        # TODO: check length.
1299
 
        if record.storage_kind == 'chunked':
1300
 
            chunks = record.get_bytes_as(record.storage_kind)
1301
 
            sha1 = osutils.sha_strings(chunks)
1302
 
            length = sum(map(len, chunks))
1303
 
        else:
1304
 
            content = record.get_bytes_as('fulltext')
1305
 
            sha1 = osutils.sha_string(content)
1306
 
            length = len(content)
1307
 
        if item_data and sha1 != item_data[1]:
1308
 
            checker._report_items.append(
1309
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1310
 
                (record.key, sha1, item_data[1], item_data[2]))
1311
 
 
1312
673
    @staticmethod
1313
674
    def create(a_bzrdir):
1314
675
        """Construct the current default format repository in a_bzrdir."""
1319
680
 
1320
681
        :param _format: The format of the repository on disk.
1321
682
        :param a_bzrdir: The BzrDir of the repository.
 
683
 
 
684
        In the future we will have a single api for all stores for
 
685
        getting file texts, inventories and revisions, then
 
686
        this construct will accept instances of those things.
1322
687
        """
1323
 
        # In the future we will have a single api for all stores for
1324
 
        # getting file texts, inventories and revisions, then
1325
 
        # this construct will accept instances of those things.
1326
688
        super(Repository, self).__init__()
1327
689
        self._format = _format
1328
690
        # the following are part of the public API for Repository:
1334
696
        self._reconcile_does_inventory_gc = True
1335
697
        self._reconcile_fixes_text_parents = False
1336
698
        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()
1337
704
        self._write_group = None
1338
705
        # Additional places to query for data.
1339
706
        self._fallback_repositories = []
1340
 
        # An InventoryEntry cache, used during deserialization
1341
 
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1342
 
        # Is it safe to return inventory entries directly from the entry cache,
1343
 
        # rather copying them?
1344
 
        self._safe_to_return_from_cache = False
1345
 
 
1346
 
    @property
1347
 
    def user_transport(self):
1348
 
        return self.bzrdir.user_transport
1349
 
 
1350
 
    @property
1351
 
    def control_transport(self):
1352
 
        return self._transport
 
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
1353
719
 
1354
720
    def __repr__(self):
1355
 
        if self._fallback_repositories:
1356
 
            return '%s(%r, fallback_repositories=%r)' % (
1357
 
                self.__class__.__name__,
1358
 
                self.base,
1359
 
                self._fallback_repositories)
1360
 
        else:
1361
 
            return '%s(%r)' % (self.__class__.__name__,
1362
 
                               self.base)
1363
 
 
1364
 
    def _has_same_fallbacks(self, other_repo):
1365
 
        """Returns true if the repositories have the same fallbacks."""
1366
 
        my_fb = self._fallback_repositories
1367
 
        other_fb = other_repo._fallback_repositories
1368
 
        if len(my_fb) != len(other_fb):
1369
 
            return False
1370
 
        for f, g in zip(my_fb, other_fb):
1371
 
            if not f.has_same_location(g):
1372
 
                return False
1373
 
        return True
 
721
        return '%s(%r)' % (self.__class__.__name__,
 
722
                           self.base)
1374
723
 
1375
724
    def has_same_location(self, other):
1376
725
        """Returns a boolean indicating if this repository is at the same
1403
752
        This causes caching within the repository obejct to start accumlating
1404
753
        data during reads, and allows a 'write_group' to be obtained. Write
1405
754
        groups must be used for actual data insertion.
1406
 
 
1407
 
        A token should be passed in if you know that you have locked the object
1408
 
        some other way, and need to synchronise this object's state with that
1409
 
        fact.
1410
 
 
1411
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
 
 
 
755
        
1413
756
        :param token: if this is already locked, then lock_write will fail
1414
757
            unless the token matches the existing lock.
1415
758
        :returns: a token if this instance supports tokens, otherwise None.
1418
761
        :raises MismatchedToken: if the specified token doesn't match the token
1419
762
            of the existing lock.
1420
763
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
764
 
 
765
        A token should be passed in if you know that you have locked the object
 
766
        some other way, and need to synchronise this object's state with that
 
767
        fact.
 
768
 
 
769
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
770
        """
1423
 
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
1425
 
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
 
            for repo in self._fallback_repositories:
1429
 
                # Writes don't affect fallback repos
1430
 
                repo.lock_read()
1431
 
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
771
        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()
 
776
        return result
1433
777
 
1434
778
    def lock_read(self):
1435
 
        """Lock the repository for read operations.
1436
 
 
1437
 
        :return: An object with an unlock method which will release the lock
1438
 
            obtained.
1439
 
        """
1440
 
        locked = self.is_locked()
1441
779
        self.control_files.lock_read()
1442
 
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
 
            for repo in self._fallback_repositories:
1446
 
                repo.lock_read()
1447
 
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
 
780
        for repo in self._fallback_repositories:
 
781
            repo.lock_read()
 
782
        self._refresh_data()
1449
783
 
1450
784
    def get_physical_lock_status(self):
1451
785
        return self.control_files.get_physical_lock_status()
1453
787
    def leave_lock_in_place(self):
1454
788
        """Tell this repository not to release the physical lock when this
1455
789
        object is unlocked.
1456
 
 
 
790
        
1457
791
        If lock_write doesn't return a token, then this method is not supported.
1458
792
        """
1459
793
        self.control_files.leave_in_place()
1511
845
 
1512
846
        # now gather global repository information
1513
847
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
848
        if self.bzrdir.root_transport.listable():
1515
849
            # XXX: do we want to __define len__() ?
1516
850
            # Maybe the versionedfiles object should provide a different
1517
851
            # method to get the number of keys.
1527
861
        :param using: If True, list only branches using this repository.
1528
862
        """
1529
863
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
864
            try:
 
865
                return [self.bzrdir.open_branch()]
 
866
            except errors.NotBranchError:
 
867
                return []
1531
868
        class Evaluator(object):
1532
869
 
1533
870
            def __init__(self):
1542
879
                    except errors.NoRepositoryPresent:
1543
880
                        pass
1544
881
                    else:
1545
 
                        return False, ([], repository)
 
882
                        return False, (None, repository)
1546
883
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
884
                try:
 
885
                    value = (bzrdir.open_branch(), None)
 
886
                except errors.NotBranchError:
 
887
                    value = (None, None)
1548
888
                return True, value
1549
889
 
1550
 
        ret = []
1551
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1552
 
                self.user_transport, evaluate=Evaluator()):
1553
 
            if branches is not None:
1554
 
                ret.extend(branches)
 
890
        branches = []
 
891
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
892
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
893
            if branch is not None:
 
894
                branches.append(branch)
1555
895
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
896
                branches.extend(repository.find_branches())
 
897
        return branches
1558
898
 
1559
899
    @needs_read_lock
1560
900
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1561
901
        """Return the revision ids that other has that this does not.
1562
 
 
 
902
        
1563
903
        These are returned in topological order.
1564
904
 
1565
905
        revision_id: only return revision ids included by revision_id.
1567
907
        return InterRepository.get(other, self).search_missing_revision_ids(
1568
908
            revision_id, find_ghosts)
1569
909
 
 
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
 
1570
928
    @staticmethod
1571
929
    def open(base):
1572
930
        """Open the repository rooted at base.
1579
937
 
1580
938
    def copy_content_into(self, destination, revision_id=None):
1581
939
        """Make a complete copy of the content in self into destination.
1582
 
 
1583
 
        This is a destructive operation! Do not use it on existing
 
940
        
 
941
        This is a destructive operation! Do not use it on existing 
1584
942
        repositories.
1585
943
        """
1586
944
        return InterRepository.get(self, destination).copy_content(revision_id)
1589
947
        """Commit the contents accrued within the current write group.
1590
948
 
1591
949
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
950
        """
1595
951
        if self._write_group is not self.get_transaction():
1596
952
            # has an unlock or relock occured ?
1597
953
            raise errors.BzrError('mismatched lock context %r and '
1598
954
                'write group %r.' %
1599
955
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
956
        self._commit_write_group()
1601
957
        self._write_group = None
1602
 
        return result
1603
958
 
1604
959
    def _commit_write_group(self):
1605
960
        """Template method for per-repository write group cleanup.
1606
 
 
1607
 
        This is called before the write group is considered to be
 
961
        
 
962
        This is called before the write group is considered to be 
1608
963
        finished and should ensure that all data handed to the repository
1609
 
        for writing during the write group is safely committed (to the
 
964
        for writing during the write group is safely committed (to the 
1610
965
        extent possible considering file system caching etc).
1611
966
        """
1612
967
 
1613
 
    def suspend_write_group(self):
1614
 
        raise errors.UnsuspendableWriteGroup(self)
1615
 
 
1616
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1617
 
        """Return the keys of missing inventory parents for revisions added in
1618
 
        this write group.
1619
 
 
1620
 
        A revision is not complete if the inventory delta for that revision
1621
 
        cannot be calculated.  Therefore if the parent inventories of a
1622
 
        revision are not present, the revision is incomplete, and e.g. cannot
1623
 
        be streamed by a smart server.  This method finds missing inventory
1624
 
        parents for revisions added in this write group.
1625
 
        """
1626
 
        if not self._format.supports_external_lookups:
1627
 
            # This is only an issue for stacked repositories
1628
 
            return set()
1629
 
        if not self.is_in_write_group():
1630
 
            raise AssertionError('not in a write group')
1631
 
 
1632
 
        # XXX: We assume that every added revision already has its
1633
 
        # corresponding inventory, so we only check for parent inventories that
1634
 
        # might be missing, rather than all inventories.
1635
 
        parents = set(self.revisions._index.get_missing_parents())
1636
 
        parents.discard(_mod_revision.NULL_REVISION)
1637
 
        unstacked_inventories = self.inventories._index
1638
 
        present_inventories = unstacked_inventories.get_parent_map(
1639
 
            key[-1:] for key in parents)
1640
 
        parents.difference_update(present_inventories)
1641
 
        if len(parents) == 0:
1642
 
            # No missing parent inventories.
1643
 
            return set()
1644
 
        if not check_for_missing_texts:
1645
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1646
 
        # Ok, now we have a list of missing inventories.  But these only matter
1647
 
        # if the inventories that reference them are missing some texts they
1648
 
        # appear to introduce.
1649
 
        # XXX: Texts referenced by all added inventories need to be present,
1650
 
        # but at the moment we're only checking for texts referenced by
1651
 
        # inventories at the graph's edge.
1652
 
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1654
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
 
        missing_texts = set()
1657
 
        for file_id, version_ids in file_ids.iteritems():
1658
 
            missing_texts.update(
1659
 
                (file_id, version_id) for version_id in version_ids)
1660
 
        present_texts = self.texts.get_parent_map(missing_texts)
1661
 
        missing_texts.difference_update(present_texts)
1662
 
        if not missing_texts:
1663
 
            # No texts are missing, so all revisions and their deltas are
1664
 
            # reconstructable.
1665
 
            return set()
1666
 
        # Alternatively the text versions could be returned as the missing
1667
 
        # keys, but this is likely to be less data.
1668
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1669
 
        return missing_keys
1670
 
 
1671
 
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
1673
 
 
1674
 
        This method is intended to be called after another repository instance
1675
 
        (such as one used by a smart server) has inserted data into the
1676
 
        repository. On all repositories this will work outside of write groups.
1677
 
        Some repository formats (pack and newer for bzrlib native formats)
1678
 
        support refresh_data inside write groups. If called inside a write
1679
 
        group on a repository that does not support refreshing in a write group
1680
 
        IsInWriteGroupError will be raised.
1681
 
        """
1682
 
        self._refresh_data()
1683
 
 
1684
 
    def resume_write_group(self, tokens):
1685
 
        if not self.is_write_locked():
1686
 
            raise errors.NotWriteLocked(self)
1687
 
        if self._write_group:
1688
 
            raise errors.BzrError('already in a write group')
1689
 
        self._resume_write_group(tokens)
1690
 
        # so we can detect unlock/relock - the write group is now entered.
1691
 
        self._write_group = self.get_transaction()
1692
 
 
1693
 
    def _resume_write_group(self, tokens):
1694
 
        raise errors.UnsuspendableWriteGroup(self)
1695
 
 
1696
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1697
 
            fetch_spec=None):
 
968
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1698
969
        """Fetch the content required to construct revision_id from source.
1699
970
 
1700
 
        If revision_id is None and fetch_spec is None, then all content is
1701
 
        copied.
1702
 
 
1703
 
        fetch() may not be used when the repository is in a write group -
1704
 
        either finish the current write group before using fetch, or use
1705
 
        fetch before starting the write group.
1706
 
 
 
971
        If revision_id is None all content is copied.
1707
972
        :param find_ghosts: Find and copy revisions in the source that are
1708
973
            ghosts in the target (and not reachable directly by walking out to
1709
974
            the first-present revision in target from revision_id).
1710
 
        :param revision_id: If specified, all the content needed for this
1711
 
            revision ID will be copied to the target.  Fetch will determine for
1712
 
            itself which content needs to be copied.
1713
 
        :param fetch_spec: If specified, a SearchResult or
1714
 
            PendingAncestryResult that describes which revisions to copy.  This
1715
 
            allows copying multiple heads at once.  Mutually exclusive with
1716
 
            revision_id.
1717
975
        """
1718
 
        if fetch_spec is not None and revision_id is not None:
1719
 
            raise AssertionError(
1720
 
                "fetch_spec and revision_id are mutually exclusive.")
1721
 
        if self.is_in_write_group():
1722
 
            raise errors.InternalBzrError(
1723
 
                "May not fetch while in a write group.")
1724
976
        # fast path same-url fetch operations
1725
 
        # TODO: lift out to somewhere common with RemoteRepository
1726
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
1727
 
        if (self.has_same_location(source)
1728
 
            and fetch_spec is None
1729
 
            and self._has_same_fallbacks(source)):
 
977
        if self.has_same_location(source):
1730
978
            # check that last_revision is in 'from' and then return a
1731
979
            # no-operation.
1732
980
            if (revision_id is not None and
1738
986
        # IncompatibleRepositories when asked to fetch.
1739
987
        inter = InterRepository.get(source, self)
1740
988
        return inter.fetch(revision_id=revision_id, pb=pb,
1741
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
989
            find_ghosts=find_ghosts)
1742
990
 
1743
991
    def create_bundle(self, target, base, fileobj, format=None):
1744
992
        return serializer.write_bundle(self, target, base, fileobj, format)
1747
995
                           timezone=None, committer=None, revprops=None,
1748
996
                           revision_id=None):
1749
997
        """Obtain a CommitBuilder for this repository.
1750
 
 
 
998
        
1751
999
        :param branch: Branch to commit to.
1752
1000
        :param parents: Revision ids of the parents of the new revision.
1753
1001
        :param config: Configuration to use.
1757
1005
        :param revprops: Optional dictionary of revision properties.
1758
1006
        :param revision_id: Optional revision id.
1759
1007
        """
1760
 
        if self._fallback_repositories:
1761
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1762
 
                "to a stacked branch. See "
1763
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1764
1008
        result = self._commit_builder_class(self, parents, config,
1765
1009
            timestamp, timezone, committer, revprops, revision_id)
1766
1010
        self.start_write_group()
1767
1011
        return result
1768
1012
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1013
    def unlock(self):
1771
1014
        if (self.control_files._lock_count == 1 and
1772
1015
            self.control_files._lock_mode == 'w'):
1776
1019
                raise errors.BzrError(
1777
1020
                    'Must end write groups before releasing write locks.')
1778
1021
        self.control_files.unlock()
1779
 
        if self.control_files._lock_count == 0:
1780
 
            self._inventory_entry_cache.clear()
1781
 
            for repo in self._fallback_repositories:
1782
 
                repo.unlock()
 
1022
        for repo in self._fallback_repositories:
 
1023
            repo.unlock()
1783
1024
 
1784
1025
    @needs_read_lock
1785
1026
    def clone(self, a_bzrdir, revision_id=None):
1820
1061
 
1821
1062
    def _start_write_group(self):
1822
1063
        """Template method for per-repository write group startup.
1823
 
 
1824
 
        This is called before the write group is considered to be
 
1064
        
 
1065
        This is called before the write group is considered to be 
1825
1066
        entered.
1826
1067
        """
1827
1068
 
1848
1089
                dest_repo = a_bzrdir.open_repository()
1849
1090
        return dest_repo
1850
1091
 
1851
 
    def _get_sink(self):
1852
 
        """Return a sink for streaming into this repository."""
1853
 
        return StreamSink(self)
1854
 
 
1855
 
    def _get_source(self, to_format):
1856
 
        """Return a source for streaming from this repository."""
1857
 
        return StreamSource(self, to_format)
1858
 
 
1859
1092
    @needs_read_lock
1860
1093
    def has_revision(self, revision_id):
1861
1094
        """True if this repository has a copy of the revision."""
1884
1117
    @needs_read_lock
1885
1118
    def get_revision_reconcile(self, revision_id):
1886
1119
        """'reconcile' helper routine that allows access to a revision always.
1887
 
 
 
1120
        
1888
1121
        This variant of get_revision does not cross check the weave graph
1889
1122
        against the revision one as get_revision does: but it should only
1890
1123
        be used by reconcile, or reconcile-alike commands that are correcting
1894
1127
 
1895
1128
    @needs_read_lock
1896
1129
    def get_revisions(self, revision_ids):
1897
 
        """Get many revisions at once.
1898
 
        
1899
 
        Repositories that need to check data on every revision read should 
1900
 
        subclass this method.
1901
 
        """
 
1130
        """Get many revisions at once."""
1902
1131
        return self._get_revisions(revision_ids)
1903
1132
 
1904
1133
    @needs_read_lock
1905
1134
    def _get_revisions(self, revision_ids):
1906
1135
        """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)
 
1139
        keys = [(key,) for key in revision_ids]
 
1140
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1141
        revs = {}
1908
 
        for revid, rev in self._iter_revisions(revision_ids):
1909
 
            if rev is None:
1910
 
                raise errors.NoSuchRevision(self, revid)
1911
 
            revs[revid] = rev
 
1142
        for record in stream:
 
1143
            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
1912
1148
        return [revs[revid] for revid in revision_ids]
1913
1149
 
1914
 
    def _iter_revisions(self, revision_ids):
1915
 
        """Iterate over revision objects.
1916
 
 
1917
 
        :param revision_ids: An iterable of revisions to examine. None may be
1918
 
            passed to request all revisions known to the repository. Note that
1919
 
            not all repositories can find unreferenced revisions; for those
1920
 
            repositories only referenced ones will be returned.
1921
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1922
 
            those asked for but not available) are returned as (revid, None).
1923
 
        """
1924
 
        if revision_ids is None:
1925
 
            revision_ids = self.all_revision_ids()
1926
 
        else:
1927
 
            for rev_id in revision_ids:
1928
 
                if not rev_id or not isinstance(rev_id, basestring):
1929
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1930
 
        keys = [(key,) for key in revision_ids]
1931
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1932
 
        for record in stream:
1933
 
            revid = record.key[0]
1934
 
            if record.storage_kind == 'absent':
1935
 
                yield (revid, None)
1936
 
            else:
1937
 
                text = record.get_bytes_as('fulltext')
1938
 
                rev = self._serializer.read_revision_from_string(text)
1939
 
                yield (revid, rev)
1940
 
 
1941
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
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):
1942
1163
        """Produce a generator of revision deltas.
1943
 
 
 
1164
        
1944
1165
        Note that the input is a sequence of REVISIONS, not revision_ids.
1945
1166
        Trees will be held in memory until the generator exits.
1946
1167
        Each delta is relative to the revision's lefthand predecessor.
1947
 
 
1948
 
        :param specific_fileids: if not None, the result is filtered
1949
 
          so that only those file-ids, their parents and their
1950
 
          children are included.
1951
1168
        """
1952
 
        # Get the revision-ids of interest
1953
1169
        required_trees = set()
1954
1170
        for revision in revisions:
1955
1171
            required_trees.add(revision.revision_id)
1956
1172
            required_trees.update(revision.parent_ids[:1])
1957
 
 
1958
 
        # Get the matching filtered trees. Note that it's more
1959
 
        # efficient to pass filtered trees to changes_from() rather
1960
 
        # than doing the filtering afterwards. changes_from() could
1961
 
        # arguably do the filtering itself but it's path-based, not
1962
 
        # file-id based, so filtering before or afterwards is
1963
 
        # currently easier.
1964
 
        if specific_fileids is None:
1965
 
            trees = dict((t.get_revision_id(), t) for
1966
 
                t in self.revision_trees(required_trees))
1967
 
        else:
1968
 
            trees = dict((t.get_revision_id(), t) for
1969
 
                t in self._filtered_revision_trees(required_trees,
1970
 
                specific_fileids))
1971
 
 
1972
 
        # Calculate the deltas
 
1173
        trees = dict((t.get_revision_id(), t) for 
 
1174
                     t in self.revision_trees(required_trees))
1973
1175
        for revision in revisions:
1974
1176
            if not revision.parent_ids:
1975
1177
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1978
1180
            yield trees[revision.revision_id].changes_from(old_tree)
1979
1181
 
1980
1182
    @needs_read_lock
1981
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1183
    def get_revision_delta(self, revision_id):
1982
1184
        """Return the delta for one revision.
1983
1185
 
1984
1186
        The delta is relative to the left-hand predecessor of the
1985
1187
        revision.
1986
 
 
1987
 
        :param specific_fileids: if not None, the result is filtered
1988
 
          so that only those file-ids, their parents and their
1989
 
          children are included.
1990
1188
        """
1991
1189
        r = self.get_revision(revision_id)
1992
 
        return list(self.get_deltas_for_revisions([r],
1993
 
            specific_fileids=specific_fileids))[0]
 
1190
        return list(self.get_deltas_for_revisions([r]))[0]
1994
1191
 
1995
1192
    @needs_write_lock
1996
1193
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
2005
1202
    def find_text_key_references(self):
2006
1203
        """Find the text key references within the repository.
2007
1204
 
 
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.
2008
1208
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
2009
1209
            to whether they were referred to by the inventory of the
2010
1210
            revision_id that they contain. The inventory texts from all present
2041
1241
 
2042
1242
        # this code needs to read every new line in every inventory for the
2043
1243
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2044
 
        # not present in one of those inventories is unnecessary but not
 
1244
        # not present in one of those inventories is unnecessary but not 
2045
1245
        # harmful because we are filtering by the revision id marker in the
2046
 
        # inventory lines : we only select file ids altered in one of those
 
1246
        # inventory lines : we only select file ids altered in one of those  
2047
1247
        # revisions. We don't need to see all lines in the inventory because
2048
1248
        # only those added in an inventory in rev X can contain a revision=X
2049
1249
        # line.
2099
1299
                result[key] = True
2100
1300
        return result
2101
1301
 
2102
 
    def _inventory_xml_lines_for_keys(self, keys):
2103
 
        """Get a line iterator of the sort needed for findind references.
2104
 
 
2105
 
        Not relevant for non-xml inventory repositories.
2106
 
 
2107
 
        Ghosts in revision_keys are ignored.
2108
 
 
2109
 
        :param revision_keys: The revision keys for the inventories to inspect.
2110
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2111
 
            all of the xml inventories specified by revision_keys.
2112
 
        """
2113
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2114
 
        for record in stream:
2115
 
            if record.storage_kind != 'absent':
2116
 
                chunks = record.get_bytes_as('chunked')
2117
 
                revid = record.key[-1]
2118
 
                lines = osutils.chunks_to_lines(chunks)
2119
 
                for line in lines:
2120
 
                    yield line, revid
2121
 
 
2122
1302
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1303
        revision_ids):
2124
1304
        """Helper routine for fileids_altered_by_revision_ids.
2125
1305
 
2126
1306
        This performs the translation of xml lines to revision ids.
2127
1307
 
2128
1308
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1309
        :param revision_ids: The revision ids to filter for. This should be a
2130
1310
            set or other type which supports efficient __contains__ lookups, as
2131
 
            the revision key from each parsed line will be looked up in the
2132
 
            revision_keys filter.
 
1311
            the revision id from each parsed line will be looked up in the
 
1312
            revision_ids filter.
2133
1313
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1314
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1315
        altered it listed explicitly.
2136
1316
        """
2137
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
 
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2140
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2142
 
        new_keys = seen - parent_seen
2143
1317
        result = {}
2144
1318
        setdefault = result.setdefault
2145
 
        for key in new_keys:
2146
 
            setdefault(key[0], set()).add(key[-1])
 
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])
2147
1326
        return result
2148
1327
 
2149
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2150
 
        """Find all parent ids that are mentioned in the revision graph.
2151
 
 
2152
 
        :return: set of revisions that are parents of revision_ids which are
2153
 
            not part of revision_ids themselves
2154
 
        """
2155
 
        parent_map = self.get_parent_map(revision_ids)
2156
 
        parent_ids = set()
2157
 
        map(parent_ids.update, parent_map.itervalues())
2158
 
        parent_ids.difference_update(revision_ids)
2159
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2160
 
        return parent_ids
2161
 
 
2162
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2163
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2164
 
 
2165
 
        :param revision_keys: An iterable of revision_keys.
2166
 
        :return: The parents of all revision_keys that are not already in
2167
 
            revision_keys
2168
 
        """
2169
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2170
 
        parent_keys = set()
2171
 
        map(parent_keys.update, parent_map.itervalues())
2172
 
        parent_keys.difference_update(revision_keys)
2173
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2174
 
        return parent_keys
2175
 
 
2176
1328
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1329
        """Find the file ids and versions affected by revisions.
2178
1330
 
2185
1337
        """
2186
1338
        selected_keys = set((revid,) for revid in revision_ids)
2187
1339
        w = _inv_weave or self.inventories
2188
 
        return self._find_file_ids_from_xml_inventory_lines(
2189
 
            w.iter_lines_added_or_present_in_keys(
2190
 
                selected_keys, pb=None),
2191
 
            selected_keys)
 
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()
2192
1348
 
2193
1349
    def iter_files_bytes(self, desired_files):
2194
1350
        """Iterate through file versions.
2209
1365
        :param desired_files: a list of (file_id, revision_id, identifier)
2210
1366
            triples
2211
1367
        """
 
1368
        transaction = self.get_transaction()
2212
1369
        text_keys = {}
2213
1370
        for file_id, revision_id, callable_data in desired_files:
2214
1371
            text_keys[(file_id, revision_id)] = callable_data
2215
1372
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2216
1373
            if record.storage_kind == 'absent':
2217
1374
                raise errors.RevisionNotPresent(record.key, self)
2218
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1375
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2219
1376
 
2220
1377
    def _generate_text_key_index(self, text_key_references=None,
2221
1378
        ancestors=None):
2270
1427
        batch_size = 10 # should be ~150MB on a 55K path tree
2271
1428
        batch_count = len(revision_order) / batch_size + 1
2272
1429
        processed_texts = 0
2273
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1430
        pb.update("Calculating text parents.", processed_texts, text_count)
2274
1431
        for offset in xrange(batch_count):
2275
1432
            to_query = revision_order[offset * batch_size:(offset + 1) *
2276
1433
                batch_size]
2277
1434
            if not to_query:
2278
1435
                break
2279
 
            for revision_id in to_query:
 
1436
            for rev_tree in self.revision_trees(to_query):
 
1437
                revision_id = rev_tree.get_revision_id()
2280
1438
                parent_ids = ancestors[revision_id]
2281
1439
                for text_key in revision_keys[revision_id]:
2282
 
                    pb.update("Calculating text parents", processed_texts)
 
1440
                    pb.update("Calculating text parents.", processed_texts)
2283
1441
                    processed_texts += 1
2284
1442
                    candidate_parents = []
2285
1443
                    for parent_id in parent_ids:
2301
1459
                            except KeyError:
2302
1460
                                inv = self.revision_tree(parent_id).inventory
2303
1461
                                inventory_cache[parent_id] = inv
2304
 
                            try:
2305
 
                                parent_entry = inv[text_key[0]]
2306
 
                            except (KeyError, errors.NoSuchId):
2307
 
                                parent_entry = None
 
1462
                            parent_entry = inv._byid.get(text_key[0], None)
2308
1463
                            if parent_entry is not None:
2309
1464
                                parent_text_key = (
2310
1465
                                    text_key[0], parent_entry.revision)
2335
1490
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2336
1491
            'revisions'.  file-id is None unless knit-kind is 'file'.
2337
1492
        """
2338
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2339
 
            yield result
2340
 
        del _files_pb
2341
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2342
 
            yield result
2343
 
 
2344
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2345
1493
        # XXX: it's a bit weird to control the inventory weave caching in this
2346
1494
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2347
1495
        # maybe this generator should explicitly have the contract that it
2354
1502
        count = 0
2355
1503
        num_file_ids = len(file_ids)
2356
1504
        for file_id, altered_versions in file_ids.iteritems():
2357
 
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
1505
            if _files_pb is not None:
 
1506
                _files_pb.update("fetch texts", count, num_file_ids)
2359
1507
            count += 1
2360
1508
            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
2361
1512
 
2362
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2363
1513
        # inventory
2364
1514
        yield ("inventory", None, revision_ids)
2365
1515
 
2366
1516
        # signatures
2367
 
        # XXX: Note ATM no callers actually pay attention to this return
2368
 
        #      instead they just use the list of revision ids and ignore
2369
 
        #      missing sigs. Consider removing this work entirely
2370
 
        revisions_with_signatures = set(self.signatures.get_parent_map(
2371
 
            [(r,) for r in revision_ids]))
2372
 
        revisions_with_signatures = set(
2373
 
            [r for (r,) in revisions_with_signatures])
2374
 
        revisions_with_signatures.intersection_update(revision_ids)
 
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)
2375
1526
        yield ("signatures", None, revisions_with_signatures)
2376
1527
 
2377
1528
        # revisions
2382
1533
        """Get Inventory object by revision id."""
2383
1534
        return self.iter_inventories([revision_id]).next()
2384
1535
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1536
    def iter_inventories(self, revision_ids):
2386
1537
        """Get many inventories by revision_ids.
2387
1538
 
2388
1539
        This will buffer some or all of the texts used in constructing the
2389
1540
        inventories in memory, but will only parse a single inventory at a
2390
1541
        time.
2391
1542
 
2392
 
        :param revision_ids: The expected revision ids of the inventories.
2393
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2394
 
            specified, the order of revision_ids will be preserved (by
2395
 
            buffering if necessary).
2396
1543
        :return: An iterator of inventories.
2397
1544
        """
2398
1545
        if ((None in revision_ids)
2399
1546
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
1547
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
1548
        return self._iter_inventories(revision_ids)
2402
1549
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
1550
    def _iter_inventories(self, revision_ids):
2404
1551
        """single-document based inventory iteration."""
2405
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2406
 
        for text, revision_id in inv_xmls:
2407
 
            yield self._deserialise_inventory(revision_id, text)
 
1552
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1553
            yield self.deserialise_inventory(revision_id, text)
2408
1554
 
2409
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2410
 
        if ordering is None:
2411
 
            order_as_requested = True
2412
 
            ordering = 'unordered'
2413
 
        else:
2414
 
            order_as_requested = False
 
1555
    def _iter_inventory_xmls(self, revision_ids):
2415
1556
        keys = [(revision_id,) for revision_id in revision_ids]
2416
 
        if not keys:
2417
 
            return
2418
 
        if order_as_requested:
2419
 
            key_iter = iter(keys)
2420
 
            next_key = key_iter.next()
2421
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
2422
 
        text_chunks = {}
 
1557
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1558
        texts = {}
2423
1559
        for record in stream:
2424
1560
            if record.storage_kind != 'absent':
2425
 
                chunks = record.get_bytes_as('chunked')
2426
 
                if order_as_requested:
2427
 
                    text_chunks[record.key] = chunks
2428
 
                else:
2429
 
                    yield ''.join(chunks), record.key[-1]
 
1561
                texts[record.key] = record.get_bytes_as('fulltext')
2430
1562
            else:
2431
1563
                raise errors.NoSuchRevision(self, record.key)
2432
 
            if order_as_requested:
2433
 
                # Yield as many results as we can while preserving order.
2434
 
                while next_key in text_chunks:
2435
 
                    chunks = text_chunks.pop(next_key)
2436
 
                    yield ''.join(chunks), next_key[-1]
2437
 
                    try:
2438
 
                        next_key = key_iter.next()
2439
 
                    except StopIteration:
2440
 
                        # We still want to fully consume the get_record_stream,
2441
 
                        # just in case it is not actually finished at this point
2442
 
                        next_key = None
2443
 
                        break
 
1564
        for key in keys:
 
1565
            yield texts[key], key[-1]
2444
1566
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
2446
 
        """Transform the xml into an inventory object.
 
1567
    def deserialise_inventory(self, revision_id, xml):
 
1568
        """Transform the xml into an inventory object. 
2447
1569
 
2448
1570
        :param revision_id: The expected revision id of the inventory.
2449
1571
        :param xml: A serialised inventory.
2450
1572
        """
2451
 
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2452
 
                    entry_cache=self._inventory_entry_cache,
2453
 
                    return_from_cache=self._safe_to_return_from_cache)
 
1573
        result = self._serializer.read_inventory_from_string(xml, revision_id)
2454
1574
        if result.revision_id != revision_id:
2455
1575
            raise AssertionError('revision id mismatch %s != %s' % (
2456
1576
                result.revision_id, revision_id))
2457
1577
        return result
2458
1578
 
 
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
 
2459
1585
    def get_serializer_format(self):
2460
1586
        return self._serializer.format_num
2461
1587
 
2462
1588
    @needs_read_lock
2463
 
    def _get_inventory_xml(self, revision_id):
2464
 
        """Get serialized inventory as a string."""
2465
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1589
    def get_inventory_xml(self, revision_id):
 
1590
        """Get inventory XML as a file object."""
 
1591
        texts = self._iter_inventory_xmls([revision_id])
2466
1592
        try:
2467
1593
            text, revision_id = texts.next()
2468
1594
        except StopIteration:
2469
1595
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
1596
        return text
2471
1597
 
2472
 
    def get_rev_id_for_revno(self, revno, known_pair):
2473
 
        """Return the revision id of a revno, given a later (revno, revid)
2474
 
        pair in the same history.
2475
 
 
2476
 
        :return: if found (True, revid).  If the available history ran out
2477
 
            before reaching the revno, then this returns
2478
 
            (False, (closest_revno, closest_revid)).
 
1598
    @needs_read_lock
 
1599
    def get_inventory_sha1(self, revision_id):
 
1600
        """Return the sha1 hash of the inventory entry
2479
1601
        """
2480
 
        known_revno, known_revid = known_pair
2481
 
        partial_history = [known_revid]
2482
 
        distance_from_known = known_revno - revno
2483
 
        if distance_from_known < 0:
2484
 
            raise ValueError(
2485
 
                'requested revno (%d) is later than given known revno (%d)'
2486
 
                % (revno, known_revno))
2487
 
        try:
2488
 
            _iter_for_revno(
2489
 
                self, partial_history, stop_index=distance_from_known)
2490
 
        except errors.RevisionNotPresent, err:
2491
 
            if err.revision_id == known_revid:
2492
 
                # The start revision (known_revid) wasn't found.
2493
 
                raise
2494
 
            # This is a stacked repository with no fallbacks, or a there's a
2495
 
            # left-hand ghost.  Either way, even though the revision named in
2496
 
            # the error isn't in this repo, we know it's the next step in this
2497
 
            # left-hand history.
2498
 
            partial_history.append(err.revision_id)
2499
 
        if len(partial_history) <= distance_from_known:
2500
 
            # Didn't find enough history to get a revid for the revno.
2501
 
            earliest_revno = known_revno - len(partial_history) + 1
2502
 
            return (False, (earliest_revno, partial_history[-1]))
2503
 
        if len(partial_history) - 1 > distance_from_known:
2504
 
            raise AssertionError('_iter_for_revno returned too much history')
2505
 
        return (True, partial_history[-1])
 
1602
        return self.get_revision(revision_id).inventory_sha1
2506
1603
 
2507
1604
    def iter_reverse_revision_history(self, revision_id):
2508
1605
        """Iterate backwards through revision ids in the lefthand history
2515
1612
        while True:
2516
1613
            if next_id in (None, _mod_revision.NULL_REVISION):
2517
1614
                return
2518
 
            try:
2519
 
                parents = graph.get_parent_map([next_id])[next_id]
2520
 
            except KeyError:
2521
 
                raise errors.RevisionNotPresent(next_id, self)
2522
1615
            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]
2523
1622
            if len(parents) == 0:
2524
1623
                return
2525
1624
            else:
2526
1625
                next_id = parents[0]
2527
1626
 
 
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
 
2528
1643
    def is_shared(self):
2529
1644
        """Return True if this repository is flagged as a shared repository."""
2530
1645
        raise NotImplementedError(self.is_shared)
2544
1659
        for repositories to maintain loaded indices across multiple locks
2545
1660
        by checking inside their implementation of this method to see
2546
1661
        whether their indices are still valid. This depends of course on
2547
 
        the disk format being validatable in this manner. This method is
2548
 
        also called by the refresh_data() public interface to cause a refresh
2549
 
        to occur while in a write lock so that data inserted by a smart server
2550
 
        push operation is visible on the client's instance of the physical
2551
 
        repository.
 
1662
        the disk format being validatable in this manner.
2552
1663
        """
2553
1664
 
2554
1665
    @needs_read_lock
2561
1672
        # TODO: refactor this to use an existing revision object
2562
1673
        # so we don't need to read it in twice.
2563
1674
        if revision_id == _mod_revision.NULL_REVISION:
2564
 
            return RevisionTree(self, Inventory(root_id=None),
 
1675
            return RevisionTree(self, Inventory(root_id=None), 
2565
1676
                                _mod_revision.NULL_REVISION)
2566
1677
        else:
2567
 
            inv = self.get_inventory(revision_id)
 
1678
            inv = self.get_revision_inventory(revision_id)
2568
1679
            return RevisionTree(self, inv, revision_id)
2569
1680
 
2570
1681
    def revision_trees(self, revision_ids):
2571
 
        """Return Trees for revisions in this repository.
 
1682
        """Return Tree for a revision on this branch.
2572
1683
 
2573
 
        :param revision_ids: a sequence of revision-ids;
2574
 
          a revision-id may not be None or 'null:'
2575
 
        """
 
1684
        `revision_id` may not be None or 'null:'"""
2576
1685
        inventories = self.iter_inventories(revision_ids)
2577
1686
        for inv in inventories:
2578
1687
            yield RevisionTree(self, inv, inv.revision_id)
2579
1688
 
2580
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2581
 
        """Return Tree for a revision on this branch with only some files.
2582
 
 
2583
 
        :param revision_ids: a sequence of revision-ids;
2584
 
          a revision-id may not be None or 'null:'
2585
 
        :param file_ids: if not None, the result is filtered
2586
 
          so that only those file-ids, their parents and their
2587
 
          children are included.
2588
 
        """
2589
 
        inventories = self.iter_inventories(revision_ids)
2590
 
        for inv in inventories:
2591
 
            # Should we introduce a FilteredRevisionTree class rather
2592
 
            # than pre-filter the inventory here?
2593
 
            filtered_inv = inv.filter(file_ids)
2594
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2595
 
 
2596
1689
    @needs_read_lock
2597
1690
    def get_ancestry(self, revision_id, topo_sorted=True):
2598
1691
        """Return a list of revision-ids integrated by a revision.
2599
1692
 
2600
 
        The first element of the list is always None, indicating the origin
2601
 
        revision.  This might change when we have history horizons, or
 
1693
        The first element of the list is always None, indicating the origin 
 
1694
        revision.  This might change when we have history horizons, or 
2602
1695
        perhaps we should have a new API.
2603
 
 
 
1696
        
2604
1697
        This is topologically sorted.
2605
1698
        """
2606
1699
        if _mod_revision.is_null(revision_id):
2623
1716
            keys = tsort.topo_sort(parent_map)
2624
1717
        return [None] + list(keys)
2625
1718
 
2626
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1719
    def pack(self):
2627
1720
        """Compress the data within the repository.
2628
1721
 
2629
1722
        This operation only makes sense for some repository types. For other
2630
1723
        types it should be a no-op that just returns.
2631
1724
 
2632
1725
        This stub method does not require a lock, but subclasses should use
2633
 
        @needs_write_lock as this is a long running call its reasonable to
 
1726
        @needs_write_lock as this is a long running call its reasonable to 
2634
1727
        implicitly lock for the user.
2635
 
 
2636
 
        :param hint: If not supplied, the whole repository is packed.
2637
 
            If supplied, the repository may use the hint parameter as a
2638
 
            hint for the parts of the repository to pack. A hint can be
2639
 
            obtained from the result of commit_write_group(). Out of
2640
 
            date hints are simply ignored, because concurrent operations
2641
 
            can obsolete them rapidly.
2642
 
 
2643
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2644
 
            the pack operation.
2645
 
        """
 
1728
        """
 
1729
 
 
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.
 
1738
        """
 
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)
2646
1748
 
2647
1749
    def get_transaction(self):
2648
1750
        return self.control_files.get_transaction()
2649
1751
 
 
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
 
2650
1758
    def get_parent_map(self, revision_ids):
2651
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1759
        """See graph._StackedParentsProvider.get_parent_map"""
2652
1760
        # revisions index works in keys; this just works in revisions
2653
1761
        # therefore wrap and unwrap
2654
1762
        query_keys = []
2663
1771
        for ((revision_id,), parent_keys) in \
2664
1772
                self.revisions.get_parent_map(query_keys).iteritems():
2665
1773
            if parent_keys:
2666
 
                result[revision_id] = tuple([parent_revid
2667
 
                    for (parent_revid,) in parent_keys])
 
1774
                result[revision_id] = tuple(parent_revid
 
1775
                    for (parent_revid,) in parent_keys)
2668
1776
            else:
2669
1777
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2670
1778
        return result
2672
1780
    def _make_parents_provider(self):
2673
1781
        return self
2674
1782
 
2675
 
    @needs_read_lock
2676
 
    def get_known_graph_ancestry(self, revision_ids):
2677
 
        """Return the known graph for a set of revision ids and their ancestors.
2678
 
        """
2679
 
        st = static_tuple.StaticTuple
2680
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2681
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2682
 
        return graph.GraphThunkIdsToKeys(known_graph)
2683
 
 
2684
1783
    def get_graph(self, other_repository=None):
2685
1784
        """Return the graph walker for this repository format"""
2686
1785
        parents_provider = self._make_parents_provider()
2687
1786
        if (other_repository is not None and
2688
1787
            not self.has_same_location(other_repository)):
2689
 
            parents_provider = graph.StackedParentsProvider(
 
1788
            parents_provider = graph._StackedParentsProvider(
2690
1789
                [parents_provider, other_repository._make_parents_provider()])
2691
1790
        return graph.Graph(parents_provider)
2692
1791
 
2693
 
    def _get_versioned_file_checker(self, text_key_references=None,
2694
 
        ancestors=None):
2695
 
        """Return an object suitable for checking versioned files.
2696
 
        
2697
 
        :param text_key_references: if non-None, an already built
2698
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2699
 
            to whether they were referred to by the inventory of the
2700
 
            revision_id that they contain. If None, this will be
2701
 
            calculated.
2702
 
        :param ancestors: Optional result from
2703
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2704
 
            available.
2705
 
        """
2706
 
        return _VersionedFileChecker(self,
2707
 
            text_key_references=text_key_references, ancestors=ancestors)
 
1792
    def _get_versioned_file_checker(self):
 
1793
        """Return an object suitable for checking versioned files."""
 
1794
        return _VersionedFileChecker(self)
2708
1795
 
2709
1796
    def revision_ids_to_search_result(self, result_set):
2710
1797
        """Convert a set of revision ids to a graph SearchResult."""
2730
1817
                          working trees.
2731
1818
        """
2732
1819
        raise NotImplementedError(self.set_make_working_trees)
2733
 
 
 
1820
    
2734
1821
    def make_working_trees(self):
2735
1822
        """Returns the policy for making working trees on new branches."""
2736
1823
        raise NotImplementedError(self.make_working_trees)
2760
1847
        return record.get_bytes_as('fulltext')
2761
1848
 
2762
1849
    @needs_read_lock
2763
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1850
    def check(self, revision_ids=None):
2764
1851
        """Check consistency of all history of given revision_ids.
2765
1852
 
2766
1853
        Different repository implementations should override _check().
2767
1854
 
2768
1855
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2769
1856
             will be checked.  Typically the last revision_id of a branch.
2770
 
        :param callback_refs: A dict of check-refs to resolve and callback
2771
 
            the check/_check method on the items listed as wanting the ref.
2772
 
            see bzrlib.check.
2773
 
        :param check_repo: If False do not check the repository contents, just 
2774
 
            calculate the data callback_refs requires and call them back.
2775
1857
        """
2776
 
        return self._check(revision_ids, callback_refs=callback_refs,
2777
 
            check_repo=check_repo)
 
1858
        return self._check(revision_ids)
2778
1859
 
2779
 
    def _check(self, revision_ids, callback_refs, check_repo):
2780
 
        result = check.Check(self, check_repo=check_repo)
2781
 
        result.check(callback_refs)
 
1860
    def _check(self, revision_ids):
 
1861
        result = check.Check(self)
 
1862
        result.check()
2782
1863
        return result
2783
1864
 
2784
 
    def _warn_if_deprecated(self, branch=None):
 
1865
    def _warn_if_deprecated(self):
2785
1866
        global _deprecation_warning_done
2786
1867
        if _deprecation_warning_done:
2787
1868
            return
2788
 
        try:
2789
 
            if branch is None:
2790
 
                conf = config.GlobalConfig()
2791
 
            else:
2792
 
                conf = branch.get_config()
2793
 
            if conf.suppress_warning('format_deprecation'):
2794
 
                return
2795
 
            warning("Format %s for %s is deprecated -"
2796
 
                    " please use 'bzr upgrade' to get better performance"
2797
 
                    % (self._format, self.bzrdir.transport.base))
2798
 
        finally:
2799
 
            _deprecation_warning_done = True
 
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))
2800
1872
 
2801
1873
    def supports_rich_root(self):
2802
1874
        return self._format.rich_root_data
2816
1888
                    revision_id.decode('ascii')
2817
1889
                except UnicodeDecodeError:
2818
1890
                    raise errors.NonAsciiRevisionId(method, self)
2819
 
 
 
1891
    
2820
1892
    def revision_graph_can_have_wrong_parents(self):
2821
1893
        """Is it possible for this repository to have a revision graph with
2822
1894
        incorrect parents?
2876
1948
    """
2877
1949
    repository.start_write_group()
2878
1950
    try:
2879
 
        inventory_cache = lru_cache.LRUCache(10)
2880
1951
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2881
 
            _install_revision(repository, revision, revision_tree, signature,
2882
 
                inventory_cache)
 
1952
            _install_revision(repository, revision, revision_tree, signature)
2883
1953
            if pb is not None:
2884
1954
                pb.update('Transferring revisions', n + 1, num_revisions)
2885
1955
    except:
2889
1959
        repository.commit_write_group()
2890
1960
 
2891
1961
 
2892
 
def _install_revision(repository, rev, revision_tree, signature,
2893
 
    inventory_cache):
 
1962
def _install_revision(repository, rev, revision_tree, signature):
2894
1963
    """Install all revision data into a repository."""
2895
1964
    present_parents = []
2896
1965
    parent_trees = {}
2933
2002
        repository.texts.add_lines(text_key, text_parents, lines)
2934
2003
    try:
2935
2004
        # install the inventory
2936
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2937
 
            # Cache this inventory
2938
 
            inventory_cache[rev.revision_id] = inv
2939
 
            try:
2940
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2941
 
            except KeyError:
2942
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2943
 
            else:
2944
 
                delta = inv._make_delta(basis_inv)
2945
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2946
 
                    rev.revision_id, present_parents)
2947
 
        else:
2948
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2005
        repository.add_inventory(rev.revision_id, inv, present_parents)
2949
2006
    except errors.RevisionAlreadyPresent:
2950
2007
        pass
2951
2008
    if signature is not None:
2955
2012
 
2956
2013
class MetaDirRepository(Repository):
2957
2014
    """Repositories in the new meta-dir layout.
2958
 
 
 
2015
    
2959
2016
    :ivar _transport: Transport for access to repository control files,
2960
2017
        typically pointing to .bzr/repository.
2961
2018
    """
2986
2043
        else:
2987
2044
            self._transport.put_bytes('no-working-trees', '',
2988
2045
                mode=self.bzrdir._get_file_mode())
2989
 
 
 
2046
    
2990
2047
    def make_working_trees(self):
2991
2048
        """Returns the policy for making working trees on new branches."""
2992
2049
        return not self._transport.has('no-working-trees')
3000
2057
            control_files)
3001
2058
 
3002
2059
 
3003
 
network_format_registry = registry.FormatRegistry()
3004
 
"""Registry of formats indexed by their network name.
3005
 
 
3006
 
The network name for a repository format is an identifier that can be used when
3007
 
referring to formats with smart server operations. See
3008
 
RepositoryFormat.network_name() for more detail.
3009
 
"""
3010
 
 
3011
 
 
3012
 
format_registry = registry.FormatRegistry(network_format_registry)
3013
 
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
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.
3014
2072
 
3015
2073
This can contain either format instances themselves, or classes/factories that
3016
2074
can be called to obtain one.
3023
2081
class RepositoryFormat(object):
3024
2082
    """A repository format.
3025
2083
 
3026
 
    Formats provide four things:
 
2084
    Formats provide three things:
3027
2085
     * An initialization routine to construct repository data on disk.
3028
 
     * a optional format string which is used when the BzrDir supports
3029
 
       versioned children.
 
2086
     * a format string which is used when the BzrDir supports versioned
 
2087
       children.
3030
2088
     * an open routine which returns a Repository instance.
3031
 
     * A network name for referring to the format in smart server RPC
3032
 
       methods.
3033
2089
 
3034
2090
    There is one and only one Format subclass for each on-disk format. But
3035
2091
    there can be one Repository subclass that is used for several different
3036
2092
    formats. The _format attribute on a Repository instance can be used to
3037
2093
    determine the disk format.
3038
2094
 
3039
 
    Formats are placed in a registry by their format string for reference
3040
 
    during opening. These should be subclasses of RepositoryFormat for
3041
 
    consistency.
 
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.
3042
2098
 
3043
2099
    Once a format is deprecated, just deprecate the initialize and open
3044
 
    methods on the format class. Do not deprecate the object, as the
3045
 
    object may be created even when a repository instance hasn't been
3046
 
    created.
 
2100
    methods on the format class. Do not deprecate the object, as the 
 
2101
    object will be created every system load.
3047
2102
 
3048
2103
    Common instance attributes:
3049
2104
    _matchingbzrdir - the bzrdir format that the repository format was
3058
2113
    # Can this repository be given external locations to lookup additional
3059
2114
    # data. Set to True or False in derived classes.
3060
2115
    supports_external_lookups = None
3061
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3062
 
    # derived classes.
3063
 
    supports_chks = None
3064
 
    # Should commit add an inventory, or an inventory delta to the repository.
3065
 
    _commit_inv_deltas = True
3066
 
    # What order should fetch operations request streams in?
3067
 
    # The default is unordered as that is the cheapest for an origin to
3068
 
    # provide.
3069
 
    _fetch_order = 'unordered'
3070
 
    # Does this repository format use deltas that can be fetched as-deltas ?
3071
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3072
 
    # We default to False, which will ensure that enough data to get
3073
 
    # a full text out of any fetch stream will be grabbed.
3074
 
    _fetch_uses_deltas = False
3075
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
3076
 
    # some repository formats that can suffer internal inconsistencies.
3077
 
    _fetch_reconcile = False
3078
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3079
 
    # code path for commit, amongst other things.
3080
 
    fast_deltas = None
3081
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3082
 
    # (so if there is one pack, the operation can still proceed because it may
3083
 
    # help), and for fetching when data won't have come from the same
3084
 
    # compressor.
3085
 
    pack_compresses = False
3086
 
    # Does the repository inventory storage understand references to trees?
3087
 
    supports_tree_reference = None
3088
 
    # Is the format experimental ?
3089
 
    experimental = False
3090
2116
 
3091
 
    def __repr__(self):
3092
 
        return "%s()" % self.__class__.__name__
 
2117
    def __str__(self):
 
2118
        return "<%s>" % self.__class__.__name__
3093
2119
 
3094
2120
    def __eq__(self, other):
3095
2121
        # format objects are generally stateless
3101
2127
    @classmethod
3102
2128
    def find_format(klass, a_bzrdir):
3103
2129
        """Return the format for the repository object in a_bzrdir.
3104
 
 
 
2130
        
3105
2131
        This is used by bzr native formats that have a "format" file in
3106
 
        the repository.  Other methods may be used by different types of
 
2132
        the repository.  Other methods may be used by different types of 
3107
2133
        control directory.
3108
2134
        """
3109
2135
        try:
3110
2136
            transport = a_bzrdir.get_repository_transport(None)
3111
 
            format_string = transport.get_bytes("format")
 
2137
            format_string = transport.get("format").read()
3112
2138
            return format_registry.get(format_string)
3113
2139
        except errors.NoSuchFile:
3114
2140
            raise errors.NoRepositoryPresent(a_bzrdir)
3123
2149
    @classmethod
3124
2150
    def unregister_format(klass, format):
3125
2151
        format_registry.remove(format.get_format_string())
3126
 
 
 
2152
    
3127
2153
    @classmethod
3128
2154
    def get_default_format(klass):
3129
2155
        """Return the current default format."""
3132
2158
 
3133
2159
    def get_format_string(self):
3134
2160
        """Return the ASCII format string that identifies this format.
3135
 
 
3136
 
        Note that in pre format ?? repositories the format string is
 
2161
        
 
2162
        Note that in pre format ?? repositories the format string is 
3137
2163
        not permitted nor written to disk.
3138
2164
        """
3139
2165
        raise NotImplementedError(self.get_format_string)
3170
2196
        :param a_bzrdir: The bzrdir to put the new repository in it.
3171
2197
        :param shared: The repository should be initialized as a sharable one.
3172
2198
        :returns: The new repository object.
3173
 
 
 
2199
        
3174
2200
        This may raise UninitializableFormat if shared repository are not
3175
2201
        compatible the a_bzrdir.
3176
2202
        """
3180
2206
        """Is this format supported?
3181
2207
 
3182
2208
        Supported formats must be initializable and openable.
3183
 
        Unsupported formats may not support initialization or committing or
 
2209
        Unsupported formats may not support initialization or committing or 
3184
2210
        some other features depending on the reason for not being supported.
3185
2211
        """
3186
2212
        return True
3187
2213
 
3188
 
    def network_name(self):
3189
 
        """A simple byte string uniquely identifying this format for RPC calls.
3190
 
 
3191
 
        MetaDir repository formats use their disk format string to identify the
3192
 
        repository over the wire. All in one formats such as bzr < 0.8, and
3193
 
        foreign formats like svn/git and hg should use some marker which is
3194
 
        unique and immutable.
3195
 
        """
3196
 
        raise NotImplementedError(self.network_name)
3197
 
 
3198
2214
    def check_conversion_target(self, target_format):
3199
 
        if self.rich_root_data and not target_format.rich_root_data:
3200
 
            raise errors.BadConversionTarget(
3201
 
                'Does not support rich root data.', target_format,
3202
 
                from_format=self)
3203
 
        if (self.supports_tree_reference and 
3204
 
            not getattr(target_format, 'supports_tree_reference', False)):
3205
 
            raise errors.BadConversionTarget(
3206
 
                'Does not support nested trees', target_format,
3207
 
                from_format=self)
 
2215
        raise NotImplementedError(self.check_conversion_target)
3208
2216
 
3209
2217
    def open(self, a_bzrdir, _found=False):
3210
2218
        """Return an instance of this format for the bzrdir a_bzrdir.
3211
 
 
 
2219
        
3212
2220
        _found is a private parameter, do not use it.
3213
2221
        """
3214
2222
        raise NotImplementedError(self.open)
3215
2223
 
3216
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3217
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3218
 
        hooks = BzrDir.hooks['post_repo_init']
3219
 
        if not hooks:
3220
 
            return
3221
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3222
 
        for hook in hooks:
3223
 
            hook(params)
3224
 
 
3225
2224
 
3226
2225
class MetaDirRepositoryFormat(RepositoryFormat):
3227
2226
    """Common base class for the new repositories using the metadir layout."""
3229
2228
    rich_root_data = False
3230
2229
    supports_tree_reference = False
3231
2230
    supports_external_lookups = False
3232
 
 
3233
 
    @property
3234
 
    def _matchingbzrdir(self):
3235
 
        matching = bzrdir.BzrDirMetaFormat1()
3236
 
        matching.repository_format = self
3237
 
        return matching
 
2231
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3238
2232
 
3239
2233
    def __init__(self):
3240
2234
        super(MetaDirRepositoryFormat, self).__init__()
3267
2261
        finally:
3268
2262
            control_files.unlock()
3269
2263
 
3270
 
    def network_name(self):
3271
 
        """Metadir formats have matching disk and network format strings."""
3272
 
        return self.get_format_string()
3273
 
 
3274
 
 
3275
 
# Pre-0.8 formats that don't have a disk format string (because they are
3276
 
# versioned by the matching control directory). We use the control directories
3277
 
# disk format string as a key for the network_name because they meet the
3278
 
# constraints (simple string, unique, immutable).
3279
 
network_format_registry.register_lazy(
3280
 
    "Bazaar-NG branch, format 5\n",
3281
 
    'bzrlib.repofmt.weaverepo',
3282
 
    'RepositoryFormat5',
3283
 
)
3284
 
network_format_registry.register_lazy(
3285
 
    "Bazaar-NG branch, format 6\n",
3286
 
    'bzrlib.repofmt.weaverepo',
3287
 
    'RepositoryFormat6',
3288
 
)
3289
 
 
3290
 
# formats which have no format string are not discoverable or independently
3291
 
# creatable on disk, so are not registered in format_registry.  They're
 
2264
 
 
2265
# formats which have no format string are not discoverable
 
2266
# and not independently creatable, so are not registered.  They're 
3292
2267
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3293
2268
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3294
2269
# the repository is not separately opened are similar.
3350
2325
    'bzrlib.repofmt.pack_repo',
3351
2326
    'RepositoryFormatKnitPack5RichRootBroken',
3352
2327
    )
3353
 
format_registry.register_lazy(
3354
 
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3355
 
    'bzrlib.repofmt.pack_repo',
3356
 
    'RepositoryFormatKnitPack6',
3357
 
    )
3358
 
format_registry.register_lazy(
3359
 
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3360
 
    'bzrlib.repofmt.pack_repo',
3361
 
    'RepositoryFormatKnitPack6RichRoot',
3362
 
    )
3363
2328
 
3364
 
# Development formats.
3365
 
# Obsolete but kept pending a CHK based subtree format.
 
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
    )
3366
2336
format_registry.register_lazy(
3367
2337
    ("Bazaar development format 2 with subtree support "
3368
2338
        "(needs bzr.dev from before 1.8)\n"),
3370
2340
    'RepositoryFormatPackDevelopment2Subtree',
3371
2341
    )
3372
2342
 
3373
 
# 1.14->1.16 go below here
3374
 
format_registry.register_lazy(
3375
 
    'Bazaar development format - group compression and chk inventory'
3376
 
        ' (needs bzr.dev from 1.14)\n',
3377
 
    'bzrlib.repofmt.groupcompress_repo',
3378
 
    'RepositoryFormatCHK1',
3379
 
    )
3380
 
 
3381
 
format_registry.register_lazy(
3382
 
    'Bazaar development format - chk repository with bencode revision '
3383
 
        'serialization (needs bzr.dev from 1.16)\n',
3384
 
    'bzrlib.repofmt.groupcompress_repo',
3385
 
    'RepositoryFormatCHK2',
3386
 
    )
3387
 
format_registry.register_lazy(
3388
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3389
 
    'bzrlib.repofmt.groupcompress_repo',
3390
 
    'RepositoryFormat2a',
3391
 
    )
3392
 
 
3393
2343
 
3394
2344
class InterRepository(InterObject):
3395
2345
    """This class represents operations taking place between two repositories.
3396
2346
 
3397
2347
    Its instances have methods like copy_content and fetch, and contain
3398
 
    references to the source and target repositories these operations can be
 
2348
    references to the source and target repositories these operations can be 
3399
2349
    carried out on.
3400
2350
 
3401
2351
    Often we will provide convenience methods on 'repository' which carry out
3403
2353
    InterRepository.get(other).method_name(parameters).
3404
2354
    """
3405
2355
 
3406
 
    _walk_to_common_revisions_batch_size = 50
 
2356
    _walk_to_common_revisions_batch_size = 1
3407
2357
    _optimisers = []
3408
2358
    """The available optimised InterRepository types."""
3409
2359
 
3410
 
    @needs_write_lock
 
2360
    def __init__(self, source, target):
 
2361
        InterObject.__init__(self, source, target)
 
2362
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2363
        # provide a faster implementation.
 
2364
        self.target_get_graph = self.target.get_graph
 
2365
        self.target_get_parent_map = self.target.get_parent_map
 
2366
 
3411
2367
    def copy_content(self, revision_id=None):
3412
 
        """Make a complete copy of the content in self into destination.
3413
 
 
3414
 
        This is a destructive operation! Do not use it on existing
3415
 
        repositories.
3416
 
 
3417
 
        :param revision_id: Only copy the content needed to construct
3418
 
                            revision_id and its parents.
3419
 
        """
3420
 
        try:
3421
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3422
 
        except NotImplementedError:
3423
 
            pass
3424
 
        self.target.fetch(self.source, revision_id=revision_id)
3425
 
 
3426
 
    @needs_write_lock
3427
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3428
 
            fetch_spec=None):
 
2368
        raise NotImplementedError(self.copy_content)
 
2369
 
 
2370
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3429
2371
        """Fetch the content required to construct revision_id.
3430
2372
 
3431
2373
        The content is copied from self.source to self.target.
3432
2374
 
3433
2375
        :param revision_id: if None all content is copied, if NULL_REVISION no
3434
2376
                            content is copied.
3435
 
        :param pb: ignored.
3436
 
        :return: None.
 
2377
        :param pb: optional progress bar to use for progress reports. If not
 
2378
                   provided a default one will be created.
 
2379
 
 
2380
        :returns: (copied_revision_count, failures).
3437
2381
        """
3438
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3439
 
        from bzrlib.fetch import RepoFetcher
3440
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3441
 
        if self.source._format.network_name() != self.target._format.network_name():
3442
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3443
 
                from_format=self.source._format,
3444
 
                to_format=self.target._format)
3445
 
        f = RepoFetcher(to_repository=self.target,
3446
 
                               from_repository=self.source,
3447
 
                               last_revision=revision_id,
3448
 
                               fetch_spec=fetch_spec,
3449
 
                               find_ghosts=find_ghosts)
 
2382
        # Normally we should find a specific InterRepository subclass to do
 
2383
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2384
        # If none of them is suitable it looks like fetching is not possible;
 
2385
        # we try to give a good message why.  _assert_same_model will probably
 
2386
        # give a helpful message; otherwise a generic one.
 
2387
        self._assert_same_model(self.source, self.target)
 
2388
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2389
            "no suitableInterRepository found")
3450
2390
 
3451
2391
    def _walk_to_common_revisions(self, revision_ids):
3452
2392
        """Walk out from revision_ids in source to revisions target has.
3454
2394
        :param revision_ids: The start point for the search.
3455
2395
        :return: A set of revision ids.
3456
2396
        """
3457
 
        target_graph = self.target.get_graph()
 
2397
        target_graph = self.target_get_graph()
3458
2398
        revision_ids = frozenset(revision_ids)
 
2399
        # Fast path for the case where all the revisions are already in the
 
2400
        # target repo.
 
2401
        # (Although this does incur an extra round trip for the
 
2402
        # fairly common case where the target doesn't already have the revision
 
2403
        # we're pushing.)
 
2404
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2405
            return graph.SearchResult(revision_ids, set(), 0, set())
3459
2406
        missing_revs = set()
3460
2407
        source_graph = self.source.get_graph()
3461
2408
        # ensure we don't pay silly lookup costs.
3492
2439
                    raise errors.NoSuchRevision(
3493
2440
                        self.source, ghosts_to_check.pop())
3494
2441
                missing_revs.update(next_revs - have_revs)
3495
 
                # Because we may have walked past the original stop point, make
3496
 
                # sure everything is stopped
3497
 
                stop_revs = searcher.find_seen_ancestors(have_revs)
3498
 
                searcher.stop_searching_any(stop_revs)
 
2442
                searcher.stop_searching_any(have_revs)
3499
2443
            if searcher_exhausted:
3500
2444
                break
3501
2445
        return searcher.get_result()
 
2446
   
 
2447
    @deprecated_method(one_two)
 
2448
    @needs_read_lock
 
2449
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2450
        """Return the revision ids that source has that target does not.
 
2451
        
 
2452
        These are returned in topological order.
 
2453
 
 
2454
        :param revision_id: only return revision ids included by this
 
2455
                            revision_id.
 
2456
        :param find_ghosts: If True find missing revisions in deep history
 
2457
            rather than just finding the surface difference.
 
2458
        """
 
2459
        return list(self.search_missing_revision_ids(
 
2460
            revision_id, find_ghosts).get_keys())
3502
2461
 
3503
2462
    @needs_read_lock
3504
2463
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3505
2464
        """Return the revision ids that source has that target does not.
3506
 
 
 
2465
        
3507
2466
        :param revision_id: only return revision ids included by this
3508
2467
                            revision_id.
3509
2468
        :param find_ghosts: If True find missing revisions in deep history
3528
2487
    @staticmethod
3529
2488
    def _same_model(source, target):
3530
2489
        """True if source and target have the same data representation.
3531
 
 
 
2490
        
3532
2491
        Note: this is always called on the base class; overriding it in a
3533
2492
        subclass will have no effect.
3534
2493
        """
3552
2511
 
3553
2512
class InterSameDataRepository(InterRepository):
3554
2513
    """Code for converting between repositories that represent the same data.
3555
 
 
 
2514
    
3556
2515
    Data format and model must match for this to work.
3557
2516
    """
3558
2517
 
3559
2518
    @classmethod
3560
2519
    def _get_repo_format_to_test(self):
3561
2520
        """Repository format for testing with.
3562
 
 
 
2521
        
3563
2522
        InterSameData can pull from subtree to subtree and from non-subtree to
3564
2523
        non-subtree, so we test this with the richest repository format.
3565
2524
        """
3570
2529
    def is_compatible(source, target):
3571
2530
        return InterRepository._same_model(source, target)
3572
2531
 
 
2532
    @needs_write_lock
 
2533
    def copy_content(self, revision_id=None):
 
2534
        """Make a complete copy of the content in self into destination.
 
2535
 
 
2536
        This copies both the repository's revision data, and configuration information
 
2537
        such as the make_working_trees setting.
 
2538
        
 
2539
        This is a destructive operation! Do not use it on existing 
 
2540
        repositories.
 
2541
 
 
2542
        :param revision_id: Only copy the content needed to construct
 
2543
                            revision_id and its parents.
 
2544
        """
 
2545
        try:
 
2546
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2547
        except NotImplementedError:
 
2548
            pass
 
2549
        # but don't bother fetching if we have the needed data now.
 
2550
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2551
            self.target.has_revision(revision_id)):
 
2552
            return
 
2553
        self.target.fetch(self.source, revision_id=revision_id)
 
2554
 
 
2555
    @needs_write_lock
 
2556
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2557
        """See InterRepository.fetch()."""
 
2558
        from bzrlib.fetch import RepoFetcher
 
2559
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2560
               self.source, self.source._format, self.target,
 
2561
               self.target._format)
 
2562
        f = RepoFetcher(to_repository=self.target,
 
2563
                               from_repository=self.source,
 
2564
                               last_revision=revision_id,
 
2565
                               pb=pb, find_ghosts=find_ghosts)
 
2566
        return f.count_copied, f.failed_revisions
 
2567
 
3573
2568
 
3574
2569
class InterWeaveRepo(InterSameDataRepository):
3575
2570
    """Optimised code paths between Weave based repositories.
3576
 
 
 
2571
    
3577
2572
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3578
2573
    implemented lazy inter-object optimisation.
3579
2574
    """
3586
2581
    @staticmethod
3587
2582
    def is_compatible(source, target):
3588
2583
        """Be compatible with known Weave formats.
3589
 
 
 
2584
        
3590
2585
        We don't test for the stores being of specific types because that
3591
 
        could lead to confusing results, and there is no need to be
 
2586
        could lead to confusing results, and there is no need to be 
3592
2587
        overly general.
3593
2588
        """
3594
2589
        from bzrlib.repofmt.weaverepo import (
3605
2600
                                                RepositoryFormat7)))
3606
2601
        except AttributeError:
3607
2602
            return False
3608
 
 
 
2603
    
3609
2604
    @needs_write_lock
3610
2605
    def copy_content(self, revision_id=None):
3611
2606
        """See InterRepository.copy_content()."""
3621
2616
                self.target.texts.insert_record_stream(
3622
2617
                    self.source.texts.get_record_stream(
3623
2618
                        self.source.texts.keys(), 'topological', False))
3624
 
                pb.update('Copying inventory', 0, 1)
 
2619
                pb.update('copying inventory', 0, 1)
3625
2620
                self.target.inventories.insert_record_stream(
3626
2621
                    self.source.inventories.get_record_stream(
3627
2622
                        self.source.inventories.keys(), 'topological', False))
3638
2633
        else:
3639
2634
            self.target.fetch(self.source, revision_id=revision_id)
3640
2635
 
 
2636
    @needs_write_lock
 
2637
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2638
        """See InterRepository.fetch()."""
 
2639
        from bzrlib.fetch import RepoFetcher
 
2640
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2641
               self.source, self.source._format, self.target, self.target._format)
 
2642
        f = RepoFetcher(to_repository=self.target,
 
2643
                               from_repository=self.source,
 
2644
                               last_revision=revision_id,
 
2645
                               pb=pb, find_ghosts=find_ghosts)
 
2646
        return f.count_copied, f.failed_revisions
 
2647
 
3641
2648
    @needs_read_lock
3642
2649
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3643
2650
        """See InterRepository.missing_revision_ids()."""
3644
2651
        # we want all revisions to satisfy revision_id in source.
3645
2652
        # but we don't want to stat every file here and there.
3646
 
        # we want then, all revisions other needs to satisfy revision_id
 
2653
        # we want then, all revisions other needs to satisfy revision_id 
3647
2654
        # checked, but not those that we have locally.
3648
 
        # so the first thing is to get a subset of the revisions to
 
2655
        # so the first thing is to get a subset of the revisions to 
3649
2656
        # satisfy revision_id in source, and then eliminate those that
3650
 
        # we do already have.
3651
 
        # this is slow on high latency connection to self, but as this
3652
 
        # disk format scales terribly for push anyway due to rewriting
 
2657
        # we do already have. 
 
2658
        # this is slow on high latency connection to self, but as as this
 
2659
        # disk format scales terribly for push anyway due to rewriting 
3653
2660
        # inventory.weave, this is considered acceptable.
3654
2661
        # - RBC 20060209
3655
2662
        if revision_id is not None:
3675
2682
            # and the tip revision was validated by get_ancestry.
3676
2683
            result_set = required_revisions
3677
2684
        else:
3678
 
            # if we just grabbed the possibly available ids, then
 
2685
            # if we just grabbed the possibly available ids, then 
3679
2686
            # we only have an estimate of whats available and need to validate
3680
2687
            # that against the revision records.
3681
2688
            result_set = set(
3694
2701
    @staticmethod
3695
2702
    def is_compatible(source, target):
3696
2703
        """Be compatible with known Knit formats.
3697
 
 
 
2704
        
3698
2705
        We don't test for the stores being of specific types because that
3699
 
        could lead to confusing results, and there is no need to be
 
2706
        could lead to confusing results, and there is no need to be 
3700
2707
        overly general.
3701
2708
        """
3702
2709
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3707
2714
            return False
3708
2715
        return are_knits and InterRepository._same_model(source, target)
3709
2716
 
 
2717
    @needs_write_lock
 
2718
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2719
        """See InterRepository.fetch()."""
 
2720
        from bzrlib.fetch import RepoFetcher
 
2721
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2722
               self.source, self.source._format, self.target, self.target._format)
 
2723
        f = RepoFetcher(to_repository=self.target,
 
2724
                            from_repository=self.source,
 
2725
                            last_revision=revision_id,
 
2726
                            pb=pb, find_ghosts=find_ghosts)
 
2727
        return f.count_copied, f.failed_revisions
 
2728
 
3710
2729
    @needs_read_lock
3711
2730
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3712
2731
        """See InterRepository.missing_revision_ids()."""
3733
2752
            # and the tip revision was validated by get_ancestry.
3734
2753
            result_set = required_revisions
3735
2754
        else:
3736
 
            # if we just grabbed the possibly available ids, then
 
2755
            # if we just grabbed the possibly available ids, then 
3737
2756
            # we only have an estimate of whats available and need to validate
3738
2757
            # that against the revision records.
3739
2758
            result_set = set(
3741
2760
        return self.source.revision_ids_to_search_result(result_set)
3742
2761
 
3743
2762
 
3744
 
class InterDifferingSerializer(InterRepository):
 
2763
class InterPackRepo(InterSameDataRepository):
 
2764
    """Optimised code paths between Pack based repositories."""
 
2765
 
 
2766
    @classmethod
 
2767
    def _get_repo_format_to_test(self):
 
2768
        from bzrlib.repofmt import pack_repo
 
2769
        return pack_repo.RepositoryFormatKnitPack1()
 
2770
 
 
2771
    @staticmethod
 
2772
    def is_compatible(source, target):
 
2773
        """Be compatible with known Pack formats.
 
2774
        
 
2775
        We don't test for the stores being of specific types because that
 
2776
        could lead to confusing results, and there is no need to be 
 
2777
        overly general.
 
2778
        """
 
2779
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2780
        try:
 
2781
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2782
                isinstance(target._format, RepositoryFormatPack))
 
2783
        except AttributeError:
 
2784
            return False
 
2785
        return are_packs and InterRepository._same_model(source, target)
 
2786
 
 
2787
    @needs_write_lock
 
2788
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2789
        """See InterRepository.fetch()."""
 
2790
        if (len(self.source._fallback_repositories) > 0 or
 
2791
            len(self.target._fallback_repositories) > 0):
 
2792
            # The pack layer is not aware of fallback repositories, so when
 
2793
            # fetching from a stacked repository or into a stacked repository
 
2794
            # we use the generic fetch logic which uses the VersionedFiles
 
2795
            # attributes on repository.
 
2796
            from bzrlib.fetch import RepoFetcher
 
2797
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2798
                                  pb, find_ghosts)
 
2799
            return fetcher.count_copied, fetcher.failed_revisions
 
2800
        from bzrlib.repofmt.pack_repo import Packer
 
2801
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2802
               self.source, self.source._format, self.target, self.target._format)
 
2803
        self.count_copied = 0
 
2804
        if revision_id is None:
 
2805
            # TODO:
 
2806
            # everything to do - use pack logic
 
2807
            # to fetch from all packs to one without
 
2808
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2809
            # till then:
 
2810
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2811
            revision_ids = source_revision_ids - \
 
2812
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2813
            revision_keys = [(revid,) for revid in revision_ids]
 
2814
            index = self.target._pack_collection.revision_index.combined_index
 
2815
            present_revision_ids = set(item[1][0] for item in
 
2816
                index.iter_entries(revision_keys))
 
2817
            revision_ids = set(revision_ids) - present_revision_ids
 
2818
            # implementing the TODO will involve:
 
2819
            # - detecting when all of a pack is selected
 
2820
            # - avoiding as much as possible pre-selection, so the
 
2821
            # more-core routines such as create_pack_from_packs can filter in
 
2822
            # a just-in-time fashion. (though having a HEADS list on a
 
2823
            # repository might make this a lot easier, because we could
 
2824
            # sensibly detect 'new revisions' without doing a full index scan.
 
2825
        elif _mod_revision.is_null(revision_id):
 
2826
            # nothing to do:
 
2827
            return (0, [])
 
2828
        else:
 
2829
            try:
 
2830
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2831
                    find_ghosts=find_ghosts).get_keys()
 
2832
            except errors.NoSuchRevision:
 
2833
                raise errors.InstallFailed([revision_id])
 
2834
            if len(revision_ids) == 0:
 
2835
                return (0, [])
 
2836
        packs = self.source._pack_collection.all_packs()
 
2837
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2838
            revision_ids).pack()
 
2839
        if pack is not None:
 
2840
            self.target._pack_collection._save_pack_names()
 
2841
            # Trigger an autopack. This may duplicate effort as we've just done
 
2842
            # a pack creation, but for now it is simpler to think about as
 
2843
            # 'upload data, then repack if needed'.
 
2844
            self.target._pack_collection.autopack()
 
2845
            return (pack.get_revision_count(), [])
 
2846
        else:
 
2847
            return (0, [])
 
2848
 
 
2849
    @needs_read_lock
 
2850
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2851
        """See InterRepository.missing_revision_ids().
 
2852
        
 
2853
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2854
            revision_id.
 
2855
        """
 
2856
        if not find_ghosts and revision_id is not None:
 
2857
            return self._walk_to_common_revisions([revision_id])
 
2858
        elif revision_id is not None:
 
2859
            # Find ghosts: search for revisions pointing from one repository to
 
2860
            # the other, and vice versa, anywhere in the history of revision_id.
 
2861
            graph = self.target_get_graph(other_repository=self.source)
 
2862
            searcher = graph._make_breadth_first_searcher([revision_id])
 
2863
            found_ids = set()
 
2864
            while True:
 
2865
                try:
 
2866
                    next_revs, ghosts = searcher.next_with_ghosts()
 
2867
                except StopIteration:
 
2868
                    break
 
2869
                if revision_id in ghosts:
 
2870
                    raise errors.NoSuchRevision(self.source, revision_id)
 
2871
                found_ids.update(next_revs)
 
2872
                found_ids.update(ghosts)
 
2873
            found_ids = frozenset(found_ids)
 
2874
            # Double query here: should be able to avoid this by changing the
 
2875
            # graph api further.
 
2876
            result_set = found_ids - frozenset(
 
2877
                self.target_get_parent_map(found_ids))
 
2878
        else:
 
2879
            source_ids = self.source.all_revision_ids()
 
2880
            # source_ids is the worst possible case we may need to pull.
 
2881
            # now we want to filter source_ids against what we actually
 
2882
            # have in target, but don't try to check for existence where we know
 
2883
            # we do not have a revision as that would be pointless.
 
2884
            target_ids = set(self.target.all_revision_ids())
 
2885
            result_set = set(source_ids).difference(target_ids)
 
2886
        return self.source.revision_ids_to_search_result(result_set)
 
2887
 
 
2888
 
 
2889
class InterModel1and2(InterRepository):
 
2890
 
 
2891
    @classmethod
 
2892
    def _get_repo_format_to_test(self):
 
2893
        return None
 
2894
 
 
2895
    @staticmethod
 
2896
    def is_compatible(source, target):
 
2897
        if not source.supports_rich_root() and target.supports_rich_root():
 
2898
            return True
 
2899
        else:
 
2900
            return False
 
2901
 
 
2902
    @needs_write_lock
 
2903
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2904
        """See InterRepository.fetch()."""
 
2905
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2906
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2907
                                 from_repository=self.source,
 
2908
                                 last_revision=revision_id,
 
2909
                                 pb=pb, find_ghosts=find_ghosts)
 
2910
        return f.count_copied, f.failed_revisions
 
2911
 
 
2912
    @needs_write_lock
 
2913
    def copy_content(self, revision_id=None):
 
2914
        """Make a complete copy of the content in self into destination.
 
2915
        
 
2916
        This is a destructive operation! Do not use it on existing 
 
2917
        repositories.
 
2918
 
 
2919
        :param revision_id: Only copy the content needed to construct
 
2920
                            revision_id and its parents.
 
2921
        """
 
2922
        try:
 
2923
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2924
        except NotImplementedError:
 
2925
            pass
 
2926
        # but don't bother fetching if we have the needed data now.
 
2927
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2928
            self.target.has_revision(revision_id)):
 
2929
            return
 
2930
        self.target.fetch(self.source, revision_id=revision_id)
 
2931
 
 
2932
 
 
2933
class InterKnit1and2(InterKnitRepo):
 
2934
 
 
2935
    @classmethod
 
2936
    def _get_repo_format_to_test(self):
 
2937
        return None
 
2938
 
 
2939
    @staticmethod
 
2940
    def is_compatible(source, target):
 
2941
        """Be compatible with Knit1 source and Knit3 target"""
 
2942
        try:
 
2943
            from bzrlib.repofmt.knitrepo import (
 
2944
                RepositoryFormatKnit1,
 
2945
                RepositoryFormatKnit3,
 
2946
                )
 
2947
            from bzrlib.repofmt.pack_repo import (
 
2948
                RepositoryFormatKnitPack1,
 
2949
                RepositoryFormatKnitPack3,
 
2950
                RepositoryFormatKnitPack4,
 
2951
                RepositoryFormatKnitPack5,
 
2952
                RepositoryFormatKnitPack5RichRoot,
 
2953
                RepositoryFormatPackDevelopment2,
 
2954
                RepositoryFormatPackDevelopment2Subtree,
 
2955
                )
 
2956
            norichroot = (
 
2957
                RepositoryFormatKnit1,            # no rr, no subtree
 
2958
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
2959
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
2960
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
2961
                )
 
2962
            richroot = (
 
2963
                RepositoryFormatKnit3,            # rr, subtree
 
2964
                RepositoryFormatKnitPack3,        # rr, subtree
 
2965
                RepositoryFormatKnitPack4,        # rr, no subtree
 
2966
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
2967
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
2968
                )
 
2969
            for format in norichroot:
 
2970
                if format.rich_root_data:
 
2971
                    raise AssertionError('Format %s is a rich-root format'
 
2972
                        ' but is included in the non-rich-root list'
 
2973
                        % (format,))
 
2974
            for format in richroot:
 
2975
                if not format.rich_root_data:
 
2976
                    raise AssertionError('Format %s is not a rich-root format'
 
2977
                        ' but is included in the rich-root list'
 
2978
                        % (format,))
 
2979
            # TODO: One alternative is to just check format.rich_root_data,
 
2980
            #       instead of keeping membership lists. However, the formats
 
2981
            #       *also* have to use the same 'Knit' style of storage
 
2982
            #       (line-deltas, fulltexts, etc.)
 
2983
            return (isinstance(source._format, norichroot) and
 
2984
                    isinstance(target._format, richroot))
 
2985
        except AttributeError:
 
2986
            return False
 
2987
 
 
2988
    @needs_write_lock
 
2989
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2990
        """See InterRepository.fetch()."""
 
2991
        from bzrlib.fetch import Knit1to2Fetcher
 
2992
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2993
               self.source, self.source._format, self.target, 
 
2994
               self.target._format)
 
2995
        f = Knit1to2Fetcher(to_repository=self.target,
 
2996
                            from_repository=self.source,
 
2997
                            last_revision=revision_id,
 
2998
                            pb=pb, find_ghosts=find_ghosts)
 
2999
        return f.count_copied, f.failed_revisions
 
3000
 
 
3001
 
 
3002
class InterDifferingSerializer(InterKnitRepo):
3745
3003
 
3746
3004
    @classmethod
3747
3005
    def _get_repo_format_to_test(self):
3750
3008
    @staticmethod
3751
3009
    def is_compatible(source, target):
3752
3010
        """Be compatible with Knit2 source and Knit3 target"""
3753
 
        # This is redundant with format.check_conversion_target(), however that
3754
 
        # raises an exception, and we just want to say "False" as in we won't
3755
 
        # support converting between these formats.
3756
 
        if 'IDS_never' in debug.debug_flags:
3757
 
            return False
3758
 
        if source.supports_rich_root() and not target.supports_rich_root():
3759
 
            return False
3760
 
        if (source._format.supports_tree_reference
3761
 
            and not target._format.supports_tree_reference):
3762
 
            return False
3763
 
        if target._fallback_repositories and target._format.supports_chks:
3764
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3765
 
            # adds to stacked repos.
3766
 
            return False
3767
 
        if 'IDS_always' in debug.debug_flags:
3768
 
            return True
3769
 
        # Only use this code path for local source and target.  IDS does far
3770
 
        # too much IO (both bandwidth and roundtrips) over a network.
3771
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3772
 
            return False
3773
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3011
        if source.supports_rich_root() != target.supports_rich_root():
 
3012
            return False
 
3013
        # Ideally, we'd support fetching if the source had no tree references
 
3014
        # even if it supported them...
 
3015
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3016
            not getattr(target, '_format.supports_tree_reference', False)):
3774
3017
            return False
3775
3018
        return True
3776
3019
 
3777
 
    def _get_trees(self, revision_ids, cache):
3778
 
        possible_trees = []
3779
 
        for rev_id in revision_ids:
3780
 
            if rev_id in cache:
3781
 
                possible_trees.append((rev_id, cache[rev_id]))
3782
 
            else:
3783
 
                # Not cached, but inventory might be present anyway.
3784
 
                try:
3785
 
                    tree = self.source.revision_tree(rev_id)
3786
 
                except errors.NoSuchRevision:
3787
 
                    # Nope, parent is ghost.
3788
 
                    pass
3789
 
                else:
3790
 
                    cache[rev_id] = tree
3791
 
                    possible_trees.append((rev_id, tree))
3792
 
        return possible_trees
3793
 
 
3794
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3795
 
        """Get the best delta and base for this revision.
3796
 
 
3797
 
        :return: (basis_id, delta)
3798
 
        """
3799
 
        deltas = []
3800
 
        # Generate deltas against each tree, to find the shortest.
3801
 
        texts_possibly_new_in_tree = set()
3802
 
        for basis_id, basis_tree in possible_trees:
3803
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3804
 
            for old_path, new_path, file_id, new_entry in delta:
3805
 
                if new_path is None:
3806
 
                    # This file_id isn't present in the new rev, so we don't
3807
 
                    # care about it.
3808
 
                    continue
3809
 
                if not new_path:
3810
 
                    # Rich roots are handled elsewhere...
3811
 
                    continue
3812
 
                kind = new_entry.kind
3813
 
                if kind != 'directory' and kind != 'file':
3814
 
                    # No text record associated with this inventory entry.
3815
 
                    continue
3816
 
                # This is a directory or file that has changed somehow.
3817
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3818
 
            deltas.append((len(delta), basis_id, delta))
3819
 
        deltas.sort()
3820
 
        return deltas[0][1:]
3821
 
 
3822
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3823
 
        """Find all parent revisions that are absent, but for which the
3824
 
        inventory is present, and copy those inventories.
3825
 
 
3826
 
        This is necessary to preserve correctness when the source is stacked
3827
 
        without fallbacks configured.  (Note that in cases like upgrade the
3828
 
        source may be not have _fallback_repositories even though it is
3829
 
        stacked.)
3830
 
        """
3831
 
        parent_revs = set()
3832
 
        for parents in parent_map.values():
3833
 
            parent_revs.update(parents)
3834
 
        present_parents = self.source.get_parent_map(parent_revs)
3835
 
        absent_parents = set(parent_revs).difference(present_parents)
3836
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3837
 
            (rev_id,) for rev_id in absent_parents)
3838
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3839
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3840
 
            current_revision_id = parent_tree.get_revision_id()
3841
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3842
 
                (current_revision_id,)]
3843
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3844
 
            basis_id = _mod_revision.NULL_REVISION
3845
 
            basis_tree = self.source.revision_tree(basis_id)
3846
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3847
 
            self.target.add_inventory_by_delta(
3848
 
                basis_id, delta, current_revision_id, parents_parents)
3849
 
            cache[current_revision_id] = parent_tree
3850
 
 
3851
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3852
 
        """Fetch across a few revisions.
3853
 
 
3854
 
        :param revision_ids: The revisions to copy
3855
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3856
 
            as a basis for delta when no other base is available
3857
 
        :param cache: A cache of RevisionTrees that we can use.
3858
 
        :param a_graph: A Graph object to determine the heads() of the
3859
 
            rich-root data stream.
3860
 
        :return: The revision_id of the last converted tree. The RevisionTree
3861
 
            for it will be in cache
3862
 
        """
3863
 
        # Walk though all revisions; get inventory deltas, copy referenced
3864
 
        # texts that delta references, insert the delta, revision and
3865
 
        # signature.
3866
 
        root_keys_to_create = set()
3867
 
        text_keys = set()
3868
 
        pending_deltas = []
3869
 
        pending_revisions = []
3870
 
        parent_map = self.source.get_parent_map(revision_ids)
3871
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3872
 
        self.source._safe_to_return_from_cache = True
3873
 
        for tree in self.source.revision_trees(revision_ids):
3874
 
            # Find a inventory delta for this revision.
3875
 
            # Find text entries that need to be copied, too.
3876
 
            current_revision_id = tree.get_revision_id()
3877
 
            parent_ids = parent_map.get(current_revision_id, ())
3878
 
            parent_trees = self._get_trees(parent_ids, cache)
3879
 
            possible_trees = list(parent_trees)
3880
 
            if len(possible_trees) == 0:
3881
 
                # There either aren't any parents, or the parents are ghosts,
3882
 
                # so just use the last converted tree.
3883
 
                possible_trees.append((basis_id, cache[basis_id]))
3884
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3885
 
                                                           possible_trees)
3886
 
            revision = self.source.get_revision(current_revision_id)
3887
 
            pending_deltas.append((basis_id, delta,
3888
 
                current_revision_id, revision.parent_ids))
3889
 
            if self._converting_to_rich_root:
3890
 
                self._revision_id_to_root_id[current_revision_id] = \
3891
 
                    tree.get_root_id()
3892
 
            # Determine which texts are in present in this revision but not in
3893
 
            # any of the available parents.
3894
 
            texts_possibly_new_in_tree = set()
3895
 
            for old_path, new_path, file_id, entry in delta:
3896
 
                if new_path is None:
3897
 
                    # This file_id isn't present in the new rev
3898
 
                    continue
3899
 
                if not new_path:
3900
 
                    # This is the root
3901
 
                    if not self.target.supports_rich_root():
3902
 
                        # The target doesn't support rich root, so we don't
3903
 
                        # copy
3904
 
                        continue
3905
 
                    if self._converting_to_rich_root:
3906
 
                        # This can't be copied normally, we have to insert
3907
 
                        # it specially
3908
 
                        root_keys_to_create.add((file_id, entry.revision))
3909
 
                        continue
3910
 
                kind = entry.kind
3911
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3912
 
            for basis_id, basis_tree in possible_trees:
3913
 
                basis_inv = basis_tree.inventory
3914
 
                for file_key in list(texts_possibly_new_in_tree):
3915
 
                    file_id, file_revision = file_key
3916
 
                    try:
3917
 
                        entry = basis_inv[file_id]
3918
 
                    except errors.NoSuchId:
3919
 
                        continue
3920
 
                    if entry.revision == file_revision:
3921
 
                        texts_possibly_new_in_tree.remove(file_key)
3922
 
            text_keys.update(texts_possibly_new_in_tree)
3923
 
            pending_revisions.append(revision)
3924
 
            cache[current_revision_id] = tree
3925
 
            basis_id = current_revision_id
3926
 
        self.source._safe_to_return_from_cache = False
3927
 
        # Copy file texts
3928
 
        from_texts = self.source.texts
3929
 
        to_texts = self.target.texts
3930
 
        if root_keys_to_create:
3931
 
            root_stream = _mod_fetch._new_root_data_stream(
3932
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3933
 
                self.source, graph=a_graph)
3934
 
            to_texts.insert_record_stream(root_stream)
3935
 
        to_texts.insert_record_stream(from_texts.get_record_stream(
3936
 
            text_keys, self.target._format._fetch_order,
3937
 
            not self.target._format._fetch_uses_deltas))
3938
 
        # insert inventory deltas
3939
 
        for delta in pending_deltas:
3940
 
            self.target.add_inventory_by_delta(*delta)
3941
 
        if self.target._fallback_repositories:
3942
 
            # Make sure this stacked repository has all the parent inventories
3943
 
            # for the new revisions that we are about to insert.  We do this
3944
 
            # before adding the revisions so that no revision is added until
3945
 
            # all the inventories it may depend on are added.
3946
 
            # Note that this is overzealous, as we may have fetched these in an
3947
 
            # earlier batch.
3948
 
            parent_ids = set()
3949
 
            revision_ids = set()
3950
 
            for revision in pending_revisions:
3951
 
                revision_ids.add(revision.revision_id)
3952
 
                parent_ids.update(revision.parent_ids)
3953
 
            parent_ids.difference_update(revision_ids)
3954
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3955
 
            parent_map = self.source.get_parent_map(parent_ids)
3956
 
            # we iterate over parent_map and not parent_ids because we don't
3957
 
            # want to try copying any revision which is a ghost
3958
 
            for parent_tree in self.source.revision_trees(parent_map):
3959
 
                current_revision_id = parent_tree.get_revision_id()
3960
 
                parents_parents = parent_map[current_revision_id]
3961
 
                possible_trees = self._get_trees(parents_parents, cache)
3962
 
                if len(possible_trees) == 0:
3963
 
                    # There either aren't any parents, or the parents are
3964
 
                    # ghosts, so just use the last converted tree.
3965
 
                    possible_trees.append((basis_id, cache[basis_id]))
3966
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3967
 
                    parents_parents, possible_trees)
3968
 
                self.target.add_inventory_by_delta(
3969
 
                    basis_id, delta, current_revision_id, parents_parents)
3970
 
        # insert signatures and revisions
3971
 
        for revision in pending_revisions:
3972
 
            try:
3973
 
                signature = self.source.get_signature_text(
3974
 
                    revision.revision_id)
3975
 
                self.target.add_signature_text(revision.revision_id,
3976
 
                    signature)
3977
 
            except errors.NoSuchRevision:
3978
 
                pass
3979
 
            self.target.add_revision(revision.revision_id, revision)
3980
 
        return basis_id
3981
 
 
3982
 
    def _fetch_all_revisions(self, revision_ids, pb):
3983
 
        """Fetch everything for the list of revisions.
3984
 
 
3985
 
        :param revision_ids: The list of revisions to fetch. Must be in
3986
 
            topological order.
3987
 
        :param pb: A ProgressTask
3988
 
        :return: None
3989
 
        """
3990
 
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3991
 
        batch_size = 100
3992
 
        cache = lru_cache.LRUCache(100)
3993
 
        cache[basis_id] = basis_tree
3994
 
        del basis_tree # We don't want to hang on to it here
3995
 
        hints = []
3996
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3997
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3998
 
                                                            revision_ids)
3999
 
        else:
4000
 
            a_graph = None
4001
 
 
4002
 
        for offset in range(0, len(revision_ids), batch_size):
4003
 
            self.target.start_write_group()
4004
 
            try:
4005
 
                pb.update('Transferring revisions', offset,
4006
 
                          len(revision_ids))
4007
 
                batch = revision_ids[offset:offset+batch_size]
4008
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4009
 
                                             a_graph=a_graph)
4010
 
            except:
4011
 
                self.source._safe_to_return_from_cache = False
4012
 
                self.target.abort_write_group()
4013
 
                raise
4014
 
            else:
4015
 
                hint = self.target.commit_write_group()
4016
 
                if hint:
4017
 
                    hints.extend(hint)
4018
 
        if hints and self.target._format.pack_compresses:
4019
 
            self.target.pack(hint=hints)
4020
 
        pb.update('Transferring revisions', len(revision_ids),
4021
 
                  len(revision_ids))
4022
 
 
4023
3020
    @needs_write_lock
4024
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
4025
 
            fetch_spec=None):
 
3021
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
4026
3022
        """See InterRepository.fetch()."""
4027
 
        if fetch_spec is not None:
4028
 
            raise AssertionError("Not implemented yet...")
4029
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4030
 
        if (not self.source.supports_rich_root()
4031
 
            and self.target.supports_rich_root()):
4032
 
            self._converting_to_rich_root = True
4033
 
            self._revision_id_to_root_id = {}
4034
 
        else:
4035
 
            self._converting_to_rich_root = False
4036
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4037
 
        if self.source._format.network_name() != self.target._format.network_name():
4038
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4039
 
                from_format=self.source._format,
4040
 
                to_format=self.target._format)
4041
3023
        revision_ids = self.target.search_missing_revision_ids(self.source,
4042
3024
            revision_id, find_ghosts=find_ghosts).get_keys()
4043
 
        if not revision_ids:
4044
 
            return 0, 0
4045
3025
        revision_ids = tsort.topo_sort(
4046
3026
            self.source.get_graph().get_parent_map(revision_ids))
4047
 
        if not revision_ids:
4048
 
            return 0, 0
4049
 
        # Walk though all revisions; get inventory deltas, copy referenced
4050
 
        # texts that delta references, insert the delta, revision and
4051
 
        # signature.
 
3027
        def revisions_iterator():
 
3028
            for current_revision_id in revision_ids:
 
3029
                revision = self.source.get_revision(current_revision_id)
 
3030
                tree = self.source.revision_tree(current_revision_id)
 
3031
                try:
 
3032
                    signature = self.source.get_signature_text(
 
3033
                        current_revision_id)
 
3034
                except errors.NoSuchRevision:
 
3035
                    signature = None
 
3036
                yield revision, tree, signature
4052
3037
        if pb is None:
4053
3038
            my_pb = ui.ui_factory.nested_progress_bar()
4054
3039
            pb = my_pb
4055
3040
        else:
4056
 
            symbol_versioning.warn(
4057
 
                symbol_versioning.deprecated_in((1, 14, 0))
4058
 
                % "pb parameter to fetch()")
4059
3041
            my_pb = None
4060
3042
        try:
4061
 
            self._fetch_all_revisions(revision_ids, pb)
 
3043
            install_revisions(self.target, revisions_iterator(),
 
3044
                              len(revision_ids), pb)
4062
3045
        finally:
4063
3046
            if my_pb is not None:
4064
3047
                my_pb.finished()
4065
3048
        return len(revision_ids), 0
4066
3049
 
4067
 
    def _get_basis(self, first_revision_id):
4068
 
        """Get a revision and tree which exists in the target.
4069
 
 
4070
 
        This assumes that first_revision_id is selected for transmission
4071
 
        because all other ancestors are already present. If we can't find an
4072
 
        ancestor we fall back to NULL_REVISION since we know that is safe.
4073
 
 
4074
 
        :return: (basis_id, basis_tree)
4075
 
        """
4076
 
        first_rev = self.source.get_revision(first_revision_id)
4077
 
        try:
4078
 
            basis_id = first_rev.parent_ids[0]
4079
 
            # only valid as a basis if the target has it
4080
 
            self.target.get_revision(basis_id)
4081
 
            # Try to get a basis tree - if its a ghost it will hit the
4082
 
            # NoSuchRevision case.
4083
 
            basis_tree = self.source.revision_tree(basis_id)
4084
 
        except (IndexError, errors.NoSuchRevision):
4085
 
            basis_id = _mod_revision.NULL_REVISION
4086
 
            basis_tree = self.source.revision_tree(basis_id)
4087
 
        return basis_id, basis_tree
 
3050
 
 
3051
class InterOtherToRemote(InterRepository):
 
3052
 
 
3053
    _walk_to_common_revisions_batch_size = 50
 
3054
 
 
3055
    def __init__(self, source, target):
 
3056
        InterRepository.__init__(self, source, target)
 
3057
        self._real_inter = None
 
3058
 
 
3059
    @staticmethod
 
3060
    def is_compatible(source, target):
 
3061
        if isinstance(target, remote.RemoteRepository):
 
3062
            return True
 
3063
        return False
 
3064
 
 
3065
    def _ensure_real_inter(self):
 
3066
        if self._real_inter is None:
 
3067
            self.target._ensure_real()
 
3068
            real_target = self.target._real_repository
 
3069
            self._real_inter = InterRepository.get(self.source, real_target)
 
3070
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3071
            self._real_inter.target_get_graph = self.target.get_graph
 
3072
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3073
    
 
3074
    def copy_content(self, revision_id=None):
 
3075
        self._ensure_real_inter()
 
3076
        self._real_inter.copy_content(revision_id=revision_id)
 
3077
 
 
3078
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3079
        self._ensure_real_inter()
 
3080
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3081
            find_ghosts=find_ghosts)
 
3082
 
 
3083
    @classmethod
 
3084
    def _get_repo_format_to_test(self):
 
3085
        return None
 
3086
 
 
3087
 
 
3088
class InterRemoteToOther(InterRepository):
 
3089
 
 
3090
    def __init__(self, source, target):
 
3091
        InterRepository.__init__(self, source, target)
 
3092
        self._real_inter = None
 
3093
 
 
3094
    @staticmethod
 
3095
    def is_compatible(source, target):
 
3096
        if not isinstance(source, remote.RemoteRepository):
 
3097
            return False
 
3098
        # Is source's model compatible with target's model?
 
3099
        source._ensure_real()
 
3100
        real_source = source._real_repository
 
3101
        if isinstance(real_source, remote.RemoteRepository):
 
3102
            raise NotImplementedError(
 
3103
                "We don't support remote repos backed by remote repos yet.")
 
3104
        return InterRepository._same_model(real_source, target)
 
3105
 
 
3106
    def _ensure_real_inter(self):
 
3107
        if self._real_inter is None:
 
3108
            self.source._ensure_real()
 
3109
            real_source = self.source._real_repository
 
3110
            self._real_inter = InterRepository.get(real_source, self.target)
 
3111
    
 
3112
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3113
        self._ensure_real_inter()
 
3114
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3115
            find_ghosts=find_ghosts)
 
3116
 
 
3117
    def copy_content(self, revision_id=None):
 
3118
        self._ensure_real_inter()
 
3119
        self._real_inter.copy_content(revision_id=revision_id)
 
3120
 
 
3121
    @classmethod
 
3122
    def _get_repo_format_to_test(self):
 
3123
        return None
 
3124
 
4088
3125
 
4089
3126
 
4090
3127
InterRepository.register_optimiser(InterDifferingSerializer)
4091
3128
InterRepository.register_optimiser(InterSameDataRepository)
4092
3129
InterRepository.register_optimiser(InterWeaveRepo)
4093
3130
InterRepository.register_optimiser(InterKnitRepo)
 
3131
InterRepository.register_optimiser(InterModel1and2)
 
3132
InterRepository.register_optimiser(InterKnit1and2)
 
3133
InterRepository.register_optimiser(InterPackRepo)
 
3134
InterRepository.register_optimiser(InterOtherToRemote)
 
3135
InterRepository.register_optimiser(InterRemoteToOther)
4094
3136
 
4095
3137
 
4096
3138
class CopyConverter(object):
4097
3139
    """A repository conversion tool which just performs a copy of the content.
4098
 
 
 
3140
    
4099
3141
    This is slow but quite reliable.
4100
3142
    """
4101
3143
 
4105
3147
        :param target_format: The format the resulting repository should be.
4106
3148
        """
4107
3149
        self.target_format = target_format
4108
 
 
 
3150
        
4109
3151
    def convert(self, repo, pb):
4110
3152
        """Perform the conversion of to_convert, giving feedback via pb.
4111
3153
 
4112
3154
        :param to_convert: The disk object to convert.
4113
3155
        :param pb: a progress bar to use for progress information.
4114
3156
        """
4115
 
        pb = ui.ui_factory.nested_progress_bar()
 
3157
        self.pb = pb
4116
3158
        self.count = 0
4117
3159
        self.total = 4
4118
3160
        # this is only useful with metadir layouts - separated repo content.
4119
3161
        # trigger an assertion if not such
4120
3162
        repo._format.get_format_string()
4121
3163
        self.repo_dir = repo.bzrdir
4122
 
        pb.update('Moving repository to repository.backup')
 
3164
        self.step('Moving repository to repository.backup')
4123
3165
        self.repo_dir.transport.move('repository', 'repository.backup')
4124
3166
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4125
3167
        repo._format.check_conversion_target(self.target_format)
4126
3168
        self.source_repo = repo._format.open(self.repo_dir,
4127
3169
            _found=True,
4128
3170
            _override_transport=backup_transport)
4129
 
        pb.update('Creating new repository')
 
3171
        self.step('Creating new repository')
4130
3172
        converted = self.target_format.initialize(self.repo_dir,
4131
3173
                                                  self.source_repo.is_shared())
4132
3174
        converted.lock_write()
4133
3175
        try:
4134
 
            pb.update('Copying content')
 
3176
            self.step('Copying content into repository.')
4135
3177
            self.source_repo.copy_content_into(converted)
4136
3178
        finally:
4137
3179
            converted.unlock()
4138
 
        pb.update('Deleting old repository content')
 
3180
        self.step('Deleting old repository content.')
4139
3181
        self.repo_dir.transport.delete_tree('repository.backup')
4140
 
        ui.ui_factory.note('repository converted')
4141
 
        pb.finished()
 
3182
        self.pb.note('repository converted')
 
3183
 
 
3184
    def step(self, message):
 
3185
        """Update the pb by a step."""
 
3186
        self.count +=1
 
3187
        self.pb.update(message, self.count, self.total)
4142
3188
 
4143
3189
 
4144
3190
_unescape_map = {
4173
3219
 
4174
3220
class _VersionedFileChecker(object):
4175
3221
 
4176
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3222
    def __init__(self, repository):
4177
3223
        self.repository = repository
4178
 
        self.text_index = self.repository._generate_text_key_index(
4179
 
            text_key_references=text_key_references, ancestors=ancestors)
4180
 
 
 
3224
        self.text_index = self.repository._generate_text_key_index()
 
3225
    
4181
3226
    def calculate_file_version_parents(self, text_key):
4182
3227
        """Calculate the correct parents for a file version according to
4183
3228
        the inventories.
4200
3245
            revision_id) tuples for versions that are present in this versioned
4201
3246
            file, but not used by the corresponding inventory.
4202
3247
        """
4203
 
        local_progress = None
4204
 
        if progress_bar is None:
4205
 
            local_progress = ui.ui_factory.nested_progress_bar()
4206
 
            progress_bar = local_progress
4207
 
        try:
4208
 
            return self._check_file_version_parents(texts, progress_bar)
4209
 
        finally:
4210
 
            if local_progress:
4211
 
                local_progress.finished()
4212
 
 
4213
 
    def _check_file_version_parents(self, texts, progress_bar):
4214
 
        """See check_file_version_parents."""
4215
3248
        wrong_parents = {}
4216
3249
        self.file_ids = set([file_id for file_id, _ in
4217
3250
            self.text_index.iterkeys()])
4218
3251
        # text keys is now grouped by file_id
 
3252
        n_weaves = len(self.file_ids)
 
3253
        files_in_revisions = {}
 
3254
        revisions_of_files = {}
4219
3255
        n_versions = len(self.text_index)
4220
3256
        progress_bar.update('loading text store', 0, n_versions)
4221
3257
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4223
3259
        text_keys = self.repository.texts.keys()
4224
3260
        unused_keys = frozenset(text_keys) - set(self.text_index)
4225
3261
        for num, key in enumerate(self.text_index.iterkeys()):
4226
 
            progress_bar.update('checking text graph', num, n_versions)
 
3262
            if progress_bar is not None:
 
3263
                progress_bar.update('checking text graph', num, n_versions)
4227
3264
            correct_parents = self.calculate_file_version_parents(key)
4228
3265
            try:
4229
3266
                knit_parents = parent_map[key]
4252
3289
        revision_graph[key] = tuple(parent for parent in parents if parent
4253
3290
            in revision_graph)
4254
3291
    return revision_graph
4255
 
 
4256
 
 
4257
 
class StreamSink(object):
4258
 
    """An object that can insert a stream into a repository.
4259
 
 
4260
 
    This interface handles the complexity of reserialising inventories and
4261
 
    revisions from different formats, and allows unidirectional insertion into
4262
 
    stacked repositories without looking for the missing basis parents
4263
 
    beforehand.
4264
 
    """
4265
 
 
4266
 
    def __init__(self, target_repo):
4267
 
        self.target_repo = target_repo
4268
 
 
4269
 
    def insert_stream(self, stream, src_format, resume_tokens):
4270
 
        """Insert a stream's content into the target repository.
4271
 
 
4272
 
        :param src_format: a bzr repository format.
4273
 
 
4274
 
        :return: a list of resume tokens and an  iterable of keys additional
4275
 
            items required before the insertion can be completed.
4276
 
        """
4277
 
        self.target_repo.lock_write()
4278
 
        try:
4279
 
            if resume_tokens:
4280
 
                self.target_repo.resume_write_group(resume_tokens)
4281
 
                is_resume = True
4282
 
            else:
4283
 
                self.target_repo.start_write_group()
4284
 
                is_resume = False
4285
 
            try:
4286
 
                # locked_insert_stream performs a commit|suspend.
4287
 
                return self._locked_insert_stream(stream, src_format,
4288
 
                    is_resume)
4289
 
            except:
4290
 
                self.target_repo.abort_write_group(suppress_errors=True)
4291
 
                raise
4292
 
        finally:
4293
 
            self.target_repo.unlock()
4294
 
 
4295
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
4296
 
        to_serializer = self.target_repo._format._serializer
4297
 
        src_serializer = src_format._serializer
4298
 
        new_pack = None
4299
 
        if to_serializer == src_serializer:
4300
 
            # If serializers match and the target is a pack repository, set the
4301
 
            # write cache size on the new pack.  This avoids poor performance
4302
 
            # on transports where append is unbuffered (such as
4303
 
            # RemoteTransport).  This is safe to do because nothing should read
4304
 
            # back from the target repository while a stream with matching
4305
 
            # serialization is being inserted.
4306
 
            # The exception is that a delta record from the source that should
4307
 
            # be a fulltext may need to be expanded by the target (see
4308
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4309
 
            # explicitly flush any buffered writes first in that rare case.
4310
 
            try:
4311
 
                new_pack = self.target_repo._pack_collection._new_pack
4312
 
            except AttributeError:
4313
 
                # Not a pack repository
4314
 
                pass
4315
 
            else:
4316
 
                new_pack.set_write_cache_size(1024*1024)
4317
 
        for substream_type, substream in stream:
4318
 
            if 'stream' in debug.debug_flags:
4319
 
                mutter('inserting substream: %s', substream_type)
4320
 
            if substream_type == 'texts':
4321
 
                self.target_repo.texts.insert_record_stream(substream)
4322
 
            elif substream_type == 'inventories':
4323
 
                if src_serializer == to_serializer:
4324
 
                    self.target_repo.inventories.insert_record_stream(
4325
 
                        substream)
4326
 
                else:
4327
 
                    self._extract_and_insert_inventories(
4328
 
                        substream, src_serializer)
4329
 
            elif substream_type == 'inventory-deltas':
4330
 
                self._extract_and_insert_inventory_deltas(
4331
 
                    substream, src_serializer)
4332
 
            elif substream_type == 'chk_bytes':
4333
 
                # XXX: This doesn't support conversions, as it assumes the
4334
 
                #      conversion was done in the fetch code.
4335
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4336
 
            elif substream_type == 'revisions':
4337
 
                # This may fallback to extract-and-insert more often than
4338
 
                # required if the serializers are different only in terms of
4339
 
                # the inventory.
4340
 
                if src_serializer == to_serializer:
4341
 
                    self.target_repo.revisions.insert_record_stream(substream)
4342
 
                else:
4343
 
                    self._extract_and_insert_revisions(substream,
4344
 
                        src_serializer)
4345
 
            elif substream_type == 'signatures':
4346
 
                self.target_repo.signatures.insert_record_stream(substream)
4347
 
            else:
4348
 
                raise AssertionError('kaboom! %s' % (substream_type,))
4349
 
        # Done inserting data, and the missing_keys calculations will try to
4350
 
        # read back from the inserted data, so flush the writes to the new pack
4351
 
        # (if this is pack format).
4352
 
        if new_pack is not None:
4353
 
            new_pack._write_data('', flush=True)
4354
 
        # Find all the new revisions (including ones from resume_tokens)
4355
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4356
 
            check_for_missing_texts=is_resume)
4357
 
        try:
4358
 
            for prefix, versioned_file in (
4359
 
                ('texts', self.target_repo.texts),
4360
 
                ('inventories', self.target_repo.inventories),
4361
 
                ('revisions', self.target_repo.revisions),
4362
 
                ('signatures', self.target_repo.signatures),
4363
 
                ('chk_bytes', self.target_repo.chk_bytes),
4364
 
                ):
4365
 
                if versioned_file is None:
4366
 
                    continue
4367
 
                # TODO: key is often going to be a StaticTuple object
4368
 
                #       I don't believe we can define a method by which
4369
 
                #       (prefix,) + StaticTuple will work, though we could
4370
 
                #       define a StaticTuple.sq_concat that would allow you to
4371
 
                #       pass in either a tuple or a StaticTuple as the second
4372
 
                #       object, so instead we could have:
4373
 
                #       StaticTuple(prefix) + key here...
4374
 
                missing_keys.update((prefix,) + key for key in
4375
 
                    versioned_file.get_missing_compression_parent_keys())
4376
 
        except NotImplementedError:
4377
 
            # cannot even attempt suspending, and missing would have failed
4378
 
            # during stream insertion.
4379
 
            missing_keys = set()
4380
 
        else:
4381
 
            if missing_keys:
4382
 
                # suspend the write group and tell the caller what we is
4383
 
                # missing. We know we can suspend or else we would not have
4384
 
                # entered this code path. (All repositories that can handle
4385
 
                # missing keys can handle suspending a write group).
4386
 
                write_group_tokens = self.target_repo.suspend_write_group()
4387
 
                return write_group_tokens, missing_keys
4388
 
        hint = self.target_repo.commit_write_group()
4389
 
        if (to_serializer != src_serializer and
4390
 
            self.target_repo._format.pack_compresses):
4391
 
            self.target_repo.pack(hint=hint)
4392
 
        return [], set()
4393
 
 
4394
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4395
 
        target_rich_root = self.target_repo._format.rich_root_data
4396
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4397
 
        for record in substream:
4398
 
            # Insert the delta directly
4399
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4400
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4401
 
            try:
4402
 
                parse_result = deserialiser.parse_text_bytes(
4403
 
                    inventory_delta_bytes)
4404
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4405
 
                trace.mutter("Incompatible delta: %s", err.msg)
4406
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4407
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4408
 
            revision_id = new_id
4409
 
            parents = [key[0] for key in record.parents]
4410
 
            self.target_repo.add_inventory_by_delta(
4411
 
                basis_id, inv_delta, revision_id, parents)
4412
 
 
4413
 
    def _extract_and_insert_inventories(self, substream, serializer,
4414
 
            parse_delta=None):
4415
 
        """Generate a new inventory versionedfile in target, converting data.
4416
 
 
4417
 
        The inventory is retrieved from the source, (deserializing it), and
4418
 
        stored in the target (reserializing it in a different format).
4419
 
        """
4420
 
        target_rich_root = self.target_repo._format.rich_root_data
4421
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4422
 
        for record in substream:
4423
 
            # It's not a delta, so it must be a fulltext in the source
4424
 
            # serializer's format.
4425
 
            bytes = record.get_bytes_as('fulltext')
4426
 
            revision_id = record.key[0]
4427
 
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4428
 
            parents = [key[0] for key in record.parents]
4429
 
            self.target_repo.add_inventory(revision_id, inv, parents)
4430
 
            # No need to keep holding this full inv in memory when the rest of
4431
 
            # the substream is likely to be all deltas.
4432
 
            del inv
4433
 
 
4434
 
    def _extract_and_insert_revisions(self, substream, serializer):
4435
 
        for record in substream:
4436
 
            bytes = record.get_bytes_as('fulltext')
4437
 
            revision_id = record.key[0]
4438
 
            rev = serializer.read_revision_from_string(bytes)
4439
 
            if rev.revision_id != revision_id:
4440
 
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4441
 
            self.target_repo.add_revision(revision_id, rev)
4442
 
 
4443
 
    def finished(self):
4444
 
        if self.target_repo._format._fetch_reconcile:
4445
 
            self.target_repo.reconcile()
4446
 
 
4447
 
 
4448
 
class StreamSource(object):
4449
 
    """A source of a stream for fetching between repositories."""
4450
 
 
4451
 
    def __init__(self, from_repository, to_format):
4452
 
        """Create a StreamSource streaming from from_repository."""
4453
 
        self.from_repository = from_repository
4454
 
        self.to_format = to_format
4455
 
        self._record_counter = RecordCounter()
4456
 
 
4457
 
    def delta_on_metadata(self):
4458
 
        """Return True if delta's are permitted on metadata streams.
4459
 
 
4460
 
        That is on revisions and signatures.
4461
 
        """
4462
 
        src_serializer = self.from_repository._format._serializer
4463
 
        target_serializer = self.to_format._serializer
4464
 
        return (self.to_format._fetch_uses_deltas and
4465
 
            src_serializer == target_serializer)
4466
 
 
4467
 
    def _fetch_revision_texts(self, revs):
4468
 
        # fetch signatures first and then the revision texts
4469
 
        # may need to be a InterRevisionStore call here.
4470
 
        from_sf = self.from_repository.signatures
4471
 
        # A missing signature is just skipped.
4472
 
        keys = [(rev_id,) for rev_id in revs]
4473
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4474
 
            keys,
4475
 
            self.to_format._fetch_order,
4476
 
            not self.to_format._fetch_uses_deltas))
4477
 
        # If a revision has a delta, this is actually expanded inside the
4478
 
        # insert_record_stream code now, which is an alternate fix for
4479
 
        # bug #261339
4480
 
        from_rf = self.from_repository.revisions
4481
 
        revisions = from_rf.get_record_stream(
4482
 
            keys,
4483
 
            self.to_format._fetch_order,
4484
 
            not self.delta_on_metadata())
4485
 
        return [('signatures', signatures), ('revisions', revisions)]
4486
 
 
4487
 
    def _generate_root_texts(self, revs):
4488
 
        """This will be called by get_stream between fetching weave texts and
4489
 
        fetching the inventory weave.
4490
 
        """
4491
 
        if self._rich_root_upgrade():
4492
 
            return _mod_fetch.Inter1and2Helper(
4493
 
                self.from_repository).generate_root_texts(revs)
4494
 
        else:
4495
 
            return []
4496
 
 
4497
 
    def get_stream(self, search):
4498
 
        phase = 'file'
4499
 
        revs = search.get_keys()
4500
 
        graph = self.from_repository.get_graph()
4501
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4502
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4503
 
        text_keys = []
4504
 
        for knit_kind, file_id, revisions in data_to_fetch:
4505
 
            if knit_kind != phase:
4506
 
                phase = knit_kind
4507
 
                # Make a new progress bar for this phase
4508
 
            if knit_kind == "file":
4509
 
                # Accumulate file texts
4510
 
                text_keys.extend([(file_id, revision) for revision in
4511
 
                    revisions])
4512
 
            elif knit_kind == "inventory":
4513
 
                # Now copy the file texts.
4514
 
                from_texts = self.from_repository.texts
4515
 
                yield ('texts', from_texts.get_record_stream(
4516
 
                    text_keys, self.to_format._fetch_order,
4517
 
                    not self.to_format._fetch_uses_deltas))
4518
 
                # Cause an error if a text occurs after we have done the
4519
 
                # copy.
4520
 
                text_keys = None
4521
 
                # Before we process the inventory we generate the root
4522
 
                # texts (if necessary) so that the inventories references
4523
 
                # will be valid.
4524
 
                for _ in self._generate_root_texts(revs):
4525
 
                    yield _
4526
 
                # we fetch only the referenced inventories because we do not
4527
 
                # know for unselected inventories whether all their required
4528
 
                # texts are present in the other repository - it could be
4529
 
                # corrupt.
4530
 
                for info in self._get_inventory_stream(revs):
4531
 
                    yield info
4532
 
            elif knit_kind == "signatures":
4533
 
                # Nothing to do here; this will be taken care of when
4534
 
                # _fetch_revision_texts happens.
4535
 
                pass
4536
 
            elif knit_kind == "revisions":
4537
 
                for record in self._fetch_revision_texts(revs):
4538
 
                    yield record
4539
 
            else:
4540
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4541
 
 
4542
 
    def get_stream_for_missing_keys(self, missing_keys):
4543
 
        # missing keys can only occur when we are byte copying and not
4544
 
        # translating (because translation means we don't send
4545
 
        # unreconstructable deltas ever).
4546
 
        keys = {}
4547
 
        keys['texts'] = set()
4548
 
        keys['revisions'] = set()
4549
 
        keys['inventories'] = set()
4550
 
        keys['chk_bytes'] = set()
4551
 
        keys['signatures'] = set()
4552
 
        for key in missing_keys:
4553
 
            keys[key[0]].add(key[1:])
4554
 
        if len(keys['revisions']):
4555
 
            # If we allowed copying revisions at this point, we could end up
4556
 
            # copying a revision without copying its required texts: a
4557
 
            # violation of the requirements for repository integrity.
4558
 
            raise AssertionError(
4559
 
                'cannot copy revisions to fill in missing deltas %s' % (
4560
 
                    keys['revisions'],))
4561
 
        for substream_kind, keys in keys.iteritems():
4562
 
            vf = getattr(self.from_repository, substream_kind)
4563
 
            if vf is None and keys:
4564
 
                    raise AssertionError(
4565
 
                        "cannot fill in keys for a versioned file we don't"
4566
 
                        " have: %s needs %s" % (substream_kind, keys))
4567
 
            if not keys:
4568
 
                # No need to stream something we don't have
4569
 
                continue
4570
 
            if substream_kind == 'inventories':
4571
 
                # Some missing keys are genuinely ghosts, filter those out.
4572
 
                present = self.from_repository.inventories.get_parent_map(keys)
4573
 
                revs = [key[0] for key in present]
4574
 
                # Get the inventory stream more-or-less as we do for the
4575
 
                # original stream; there's no reason to assume that records
4576
 
                # direct from the source will be suitable for the sink.  (Think
4577
 
                # e.g. 2a -> 1.9-rich-root).
4578
 
                for info in self._get_inventory_stream(revs, missing=True):
4579
 
                    yield info
4580
 
                continue
4581
 
 
4582
 
            # Ask for full texts always so that we don't need more round trips
4583
 
            # after this stream.
4584
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4585
 
            # records. The Sink is responsible for doing another check to
4586
 
            # ensure that ghosts don't introduce missing data for future
4587
 
            # fetches.
4588
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4589
 
                self.to_format._fetch_order, True))
4590
 
            yield substream_kind, stream
4591
 
 
4592
 
    def inventory_fetch_order(self):
4593
 
        if self._rich_root_upgrade():
4594
 
            return 'topological'
4595
 
        else:
4596
 
            return self.to_format._fetch_order
4597
 
 
4598
 
    def _rich_root_upgrade(self):
4599
 
        return (not self.from_repository._format.rich_root_data and
4600
 
            self.to_format.rich_root_data)
4601
 
 
4602
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4603
 
        from_format = self.from_repository._format
4604
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4605
 
            from_format.network_name() == self.to_format.network_name()):
4606
 
            raise AssertionError(
4607
 
                "this case should be handled by GroupCHKStreamSource")
4608
 
        elif 'forceinvdeltas' in debug.debug_flags:
4609
 
            return self._get_convertable_inventory_stream(revision_ids,
4610
 
                    delta_versus_null=missing)
4611
 
        elif from_format.network_name() == self.to_format.network_name():
4612
 
            # Same format.
4613
 
            return self._get_simple_inventory_stream(revision_ids,
4614
 
                    missing=missing)
4615
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4616
 
                and from_format._serializer == self.to_format._serializer):
4617
 
            # Essentially the same format.
4618
 
            return self._get_simple_inventory_stream(revision_ids,
4619
 
                    missing=missing)
4620
 
        else:
4621
 
            # Any time we switch serializations, we want to use an
4622
 
            # inventory-delta based approach.
4623
 
            return self._get_convertable_inventory_stream(revision_ids,
4624
 
                    delta_versus_null=missing)
4625
 
 
4626
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4627
 
        # NB: This currently reopens the inventory weave in source;
4628
 
        # using a single stream interface instead would avoid this.
4629
 
        from_weave = self.from_repository.inventories
4630
 
        if missing:
4631
 
            delta_closure = True
4632
 
        else:
4633
 
            delta_closure = not self.delta_on_metadata()
4634
 
        yield ('inventories', from_weave.get_record_stream(
4635
 
            [(rev_id,) for rev_id in revision_ids],
4636
 
            self.inventory_fetch_order(), delta_closure))
4637
 
 
4638
 
    def _get_convertable_inventory_stream(self, revision_ids,
4639
 
                                          delta_versus_null=False):
4640
 
        # The two formats are sufficiently different that there is no fast
4641
 
        # path, so we need to send just inventorydeltas, which any
4642
 
        # sufficiently modern client can insert into any repository.
4643
 
        # The StreamSink code expects to be able to
4644
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4645
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4646
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4647
 
        yield ('inventory-deltas',
4648
 
           self._stream_invs_as_deltas(revision_ids,
4649
 
                                       delta_versus_null=delta_versus_null))
4650
 
 
4651
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4652
 
        """Return a stream of inventory-deltas for the given rev ids.
4653
 
 
4654
 
        :param revision_ids: The list of inventories to transmit
4655
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4656
 
            entry, instead compute the delta versus the NULL_REVISION. This
4657
 
            effectively streams a complete inventory. Used for stuff like
4658
 
            filling in missing parents, etc.
4659
 
        """
4660
 
        from_repo = self.from_repository
4661
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4662
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4663
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4664
 
        # method...
4665
 
        inventories = self.from_repository.iter_inventories(
4666
 
            revision_ids, 'topological')
4667
 
        format = from_repo._format
4668
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4669
 
        inventory_cache = lru_cache.LRUCache(50)
4670
 
        null_inventory = from_repo.revision_tree(
4671
 
            _mod_revision.NULL_REVISION).inventory
4672
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4673
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4674
 
        # repo back into a non-rich-root repo ought to be allowed)
4675
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4676
 
            versioned_root=format.rich_root_data,
4677
 
            tree_references=format.supports_tree_reference)
4678
 
        for inv in inventories:
4679
 
            key = (inv.revision_id,)
4680
 
            parent_keys = parent_map.get(key, ())
4681
 
            delta = None
4682
 
            if not delta_versus_null and parent_keys:
4683
 
                # The caller did not ask for complete inventories and we have
4684
 
                # some parents that we can delta against.  Make a delta against
4685
 
                # each parent so that we can find the smallest.
4686
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4687
 
                for parent_id in parent_ids:
4688
 
                    if parent_id not in invs_sent_so_far:
4689
 
                        # We don't know that the remote side has this basis, so
4690
 
                        # we can't use it.
4691
 
                        continue
4692
 
                    if parent_id == _mod_revision.NULL_REVISION:
4693
 
                        parent_inv = null_inventory
4694
 
                    else:
4695
 
                        parent_inv = inventory_cache.get(parent_id, None)
4696
 
                        if parent_inv is None:
4697
 
                            parent_inv = from_repo.get_inventory(parent_id)
4698
 
                    candidate_delta = inv._make_delta(parent_inv)
4699
 
                    if (delta is None or
4700
 
                        len(delta) > len(candidate_delta)):
4701
 
                        delta = candidate_delta
4702
 
                        basis_id = parent_id
4703
 
            if delta is None:
4704
 
                # Either none of the parents ended up being suitable, or we
4705
 
                # were asked to delta against NULL
4706
 
                basis_id = _mod_revision.NULL_REVISION
4707
 
                delta = inv._make_delta(null_inventory)
4708
 
            invs_sent_so_far.add(inv.revision_id)
4709
 
            inventory_cache[inv.revision_id] = inv
4710
 
            delta_serialized = ''.join(
4711
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4712
 
            yield versionedfile.FulltextContentFactory(
4713
 
                key, parent_keys, None, delta_serialized)
4714
 
 
4715
 
 
4716
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4717
 
                    stop_revision=None):
4718
 
    """Extend the partial history to include a given index
4719
 
 
4720
 
    If a stop_index is supplied, stop when that index has been reached.
4721
 
    If a stop_revision is supplied, stop when that revision is
4722
 
    encountered.  Otherwise, stop when the beginning of history is
4723
 
    reached.
4724
 
 
4725
 
    :param stop_index: The index which should be present.  When it is
4726
 
        present, history extension will stop.
4727
 
    :param stop_revision: The revision id which should be present.  When
4728
 
        it is encountered, history extension will stop.
4729
 
    """
4730
 
    start_revision = partial_history_cache[-1]
4731
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4732
 
    try:
4733
 
        #skip the last revision in the list
4734
 
        iterator.next()
4735
 
        while True:
4736
 
            if (stop_index is not None and
4737
 
                len(partial_history_cache) > stop_index):
4738
 
                break
4739
 
            if partial_history_cache[-1] == stop_revision:
4740
 
                break
4741
 
            revision_id = iterator.next()
4742
 
            partial_history_cache.append(revision_id)
4743
 
    except StopIteration:
4744
 
        # No more history
4745
 
        return
4746