~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin Pool
  • Date: 2008-10-20 23:58:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3787.
  • Revision ID: mbp@sourcefrog.net-20081020235812-itg90mk0u4dez92z
lp-upload-release now handles names like bzr-1.8.tar.gz

Show diffs side-by-side

added added

removed removed

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