~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Aaron Bentley
  • Date: 2008-11-04 19:59:11 UTC
  • mto: This revision was merged to the branch mainline in revision 3823.
  • Revision ID: aaron@aaronbentley.com-20081104195911-oe0co22ksc2bio8p
Update NEWS

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
 
2165
1337
        """
2166
1338
        selected_keys = set((revid,) for revid in revision_ids)
2167
1339
        w = _inv_weave or self.inventories
2168
 
        return self._find_file_ids_from_xml_inventory_lines(
2169
 
            w.iter_lines_added_or_present_in_keys(
2170
 
                selected_keys, pb=None),
2171
 
            selected_keys)
 
1340
        pb = ui.ui_factory.nested_progress_bar()
 
1341
        try:
 
1342
            return self._find_file_ids_from_xml_inventory_lines(
 
1343
                w.iter_lines_added_or_present_in_keys(
 
1344
                    selected_keys, pb=pb),
 
1345
                selected_keys)
 
1346
        finally:
 
1347
            pb.finished()
2172
1348
 
2173
1349
    def iter_files_bytes(self, desired_files):
2174
1350
        """Iterate through file versions.
2189
1365
        :param desired_files: a list of (file_id, revision_id, identifier)
2190
1366
            triples
2191
1367
        """
 
1368
        transaction = self.get_transaction()
2192
1369
        text_keys = {}
2193
1370
        for file_id, revision_id, callable_data in desired_files:
2194
1371
            text_keys[(file_id, revision_id)] = callable_data
2195
1372
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2196
1373
            if record.storage_kind == 'absent':
2197
1374
                raise errors.RevisionNotPresent(record.key, self)
2198
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1375
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2199
1376
 
2200
1377
    def _generate_text_key_index(self, text_key_references=None,
2201
1378
        ancestors=None):
2250
1427
        batch_size = 10 # should be ~150MB on a 55K path tree
2251
1428
        batch_count = len(revision_order) / batch_size + 1
2252
1429
        processed_texts = 0
2253
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1430
        pb.update("Calculating text parents.", processed_texts, text_count)
2254
1431
        for offset in xrange(batch_count):
2255
1432
            to_query = revision_order[offset * batch_size:(offset + 1) *
2256
1433
                batch_size]
2257
1434
            if not to_query:
2258
1435
                break
2259
 
            for revision_id in to_query:
 
1436
            for rev_tree in self.revision_trees(to_query):
 
1437
                revision_id = rev_tree.get_revision_id()
2260
1438
                parent_ids = ancestors[revision_id]
2261
1439
                for text_key in revision_keys[revision_id]:
2262
 
                    pb.update("Calculating text parents", processed_texts)
 
1440
                    pb.update("Calculating text parents.", processed_texts)
2263
1441
                    processed_texts += 1
2264
1442
                    candidate_parents = []
2265
1443
                    for parent_id in parent_ids:
2281
1459
                            except KeyError:
2282
1460
                                inv = self.revision_tree(parent_id).inventory
2283
1461
                                inventory_cache[parent_id] = inv
2284
 
                            try:
2285
 
                                parent_entry = inv[text_key[0]]
2286
 
                            except (KeyError, errors.NoSuchId):
2287
 
                                parent_entry = None
 
1462
                            parent_entry = inv._byid.get(text_key[0], None)
2288
1463
                            if parent_entry is not None:
2289
1464
                                parent_text_key = (
2290
1465
                                    text_key[0], parent_entry.revision)
2315
1490
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2316
1491
            'revisions'.  file-id is None unless knit-kind is 'file'.
2317
1492
        """
2318
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2319
 
            yield result
2320
 
        del _files_pb
2321
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2322
 
            yield result
2323
 
 
2324
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2325
1493
        # XXX: it's a bit weird to control the inventory weave caching in this
2326
1494
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2327
1495
        # maybe this generator should explicitly have the contract that it
2334
1502
        count = 0
2335
1503
        num_file_ids = len(file_ids)
2336
1504
        for file_id, altered_versions in file_ids.iteritems():
2337
 
            if pb is not None:
2338
 
                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)
2339
1507
            count += 1
2340
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
2341
1512
 
2342
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2343
1513
        # inventory
2344
1514
        yield ("inventory", None, revision_ids)
2345
1515
 
2346
1516
        # signatures
2347
 
        # XXX: Note ATM no callers actually pay attention to this return
2348
 
        #      instead they just use the list of revision ids and ignore
2349
 
        #      missing sigs. Consider removing this work entirely
2350
 
        revisions_with_signatures = set(self.signatures.get_parent_map(
2351
 
            [(r,) for r in revision_ids]))
2352
 
        revisions_with_signatures = set(
2353
 
            [r for (r,) in revisions_with_signatures])
2354
 
        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)
2355
1526
        yield ("signatures", None, revisions_with_signatures)
2356
1527
 
2357
1528
        # revisions
2362
1533
        """Get Inventory object by revision id."""
2363
1534
        return self.iter_inventories([revision_id]).next()
2364
1535
 
2365
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1536
    def iter_inventories(self, revision_ids):
2366
1537
        """Get many inventories by revision_ids.
2367
1538
 
2368
1539
        This will buffer some or all of the texts used in constructing the
2369
1540
        inventories in memory, but will only parse a single inventory at a
2370
1541
        time.
2371
1542
 
2372
 
        :param revision_ids: The expected revision ids of the inventories.
2373
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2374
 
            specified, the order of revision_ids will be preserved (by
2375
 
            buffering if necessary).
2376
1543
        :return: An iterator of inventories.
2377
1544
        """
2378
1545
        if ((None in revision_ids)
2379
1546
            or (_mod_revision.NULL_REVISION in revision_ids)):
2380
1547
            raise ValueError('cannot get null revision inventory')
2381
 
        return self._iter_inventories(revision_ids, ordering)
 
1548
        return self._iter_inventories(revision_ids)
2382
1549
 
2383
 
    def _iter_inventories(self, revision_ids, ordering):
 
1550
    def _iter_inventories(self, revision_ids):
2384
1551
        """single-document based inventory iteration."""
2385
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2386
 
        for text, revision_id in inv_xmls:
2387
 
            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)
2388
1554
 
2389
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2390
 
        if ordering is None:
2391
 
            order_as_requested = True
2392
 
            ordering = 'unordered'
2393
 
        else:
2394
 
            order_as_requested = False
 
1555
    def _iter_inventory_xmls(self, revision_ids):
2395
1556
        keys = [(revision_id,) for revision_id in revision_ids]
2396
 
        if not keys:
2397
 
            return
2398
 
        if order_as_requested:
2399
 
            key_iter = iter(keys)
2400
 
            next_key = key_iter.next()
2401
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
2402
 
        text_chunks = {}
 
1557
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1558
        texts = {}
2403
1559
        for record in stream:
2404
1560
            if record.storage_kind != 'absent':
2405
 
                chunks = record.get_bytes_as('chunked')
2406
 
                if order_as_requested:
2407
 
                    text_chunks[record.key] = chunks
2408
 
                else:
2409
 
                    yield ''.join(chunks), record.key[-1]
 
1561
                texts[record.key] = record.get_bytes_as('fulltext')
2410
1562
            else:
2411
1563
                raise errors.NoSuchRevision(self, record.key)
2412
 
            if order_as_requested:
2413
 
                # Yield as many results as we can while preserving order.
2414
 
                while next_key in text_chunks:
2415
 
                    chunks = text_chunks.pop(next_key)
2416
 
                    yield ''.join(chunks), next_key[-1]
2417
 
                    try:
2418
 
                        next_key = key_iter.next()
2419
 
                    except StopIteration:
2420
 
                        # We still want to fully consume the get_record_stream,
2421
 
                        # just in case it is not actually finished at this point
2422
 
                        next_key = None
2423
 
                        break
 
1564
        for key in keys:
 
1565
            yield texts[key], key[-1]
2424
1566
 
2425
 
    def _deserialise_inventory(self, revision_id, xml):
2426
 
        """Transform the xml into an inventory object.
 
1567
    def deserialise_inventory(self, revision_id, xml):
 
1568
        """Transform the xml into an inventory object. 
2427
1569
 
2428
1570
        :param revision_id: The expected revision id of the inventory.
2429
1571
        :param xml: A serialised inventory.
2430
1572
        """
2431
 
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2432
 
                    entry_cache=self._inventory_entry_cache,
2433
 
                    return_from_cache=self._safe_to_return_from_cache)
 
1573
        result = self._serializer.read_inventory_from_string(xml, revision_id)
2434
1574
        if result.revision_id != revision_id:
2435
1575
            raise AssertionError('revision id mismatch %s != %s' % (
2436
1576
                result.revision_id, revision_id))
2437
1577
        return result
2438
1578
 
2439
 
    def _serialise_inventory(self, inv):
 
1579
    def serialise_inventory(self, inv):
2440
1580
        return self._serializer.write_inventory_to_string(inv)
2441
1581
 
2442
1582
    def _serialise_inventory_to_lines(self, inv):
2446
1586
        return self._serializer.format_num
2447
1587
 
2448
1588
    @needs_read_lock
2449
 
    def _get_inventory_xml(self, revision_id):
2450
 
        """Get serialized inventory as a string."""
2451
 
        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])
2452
1592
        try:
2453
1593
            text, revision_id = texts.next()
2454
1594
        except StopIteration:
2455
1595
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2456
1596
        return text
2457
1597
 
2458
 
    def get_rev_id_for_revno(self, revno, known_pair):
2459
 
        """Return the revision id of a revno, given a later (revno, revid)
2460
 
        pair in the same history.
2461
 
 
2462
 
        :return: if found (True, revid).  If the available history ran out
2463
 
            before reaching the revno, then this returns
2464
 
            (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
2465
1601
        """
2466
 
        known_revno, known_revid = known_pair
2467
 
        partial_history = [known_revid]
2468
 
        distance_from_known = known_revno - revno
2469
 
        if distance_from_known < 0:
2470
 
            raise ValueError(
2471
 
                'requested revno (%d) is later than given known revno (%d)'
2472
 
                % (revno, known_revno))
2473
 
        try:
2474
 
            _iter_for_revno(
2475
 
                self, partial_history, stop_index=distance_from_known)
2476
 
        except errors.RevisionNotPresent, err:
2477
 
            if err.revision_id == known_revid:
2478
 
                # The start revision (known_revid) wasn't found.
2479
 
                raise
2480
 
            # This is a stacked repository with no fallbacks, or a there's a
2481
 
            # left-hand ghost.  Either way, even though the revision named in
2482
 
            # the error isn't in this repo, we know it's the next step in this
2483
 
            # left-hand history.
2484
 
            partial_history.append(err.revision_id)
2485
 
        if len(partial_history) <= distance_from_known:
2486
 
            # Didn't find enough history to get a revid for the revno.
2487
 
            earliest_revno = known_revno - len(partial_history) + 1
2488
 
            return (False, (earliest_revno, partial_history[-1]))
2489
 
        if len(partial_history) - 1 > distance_from_known:
2490
 
            raise AssertionError('_iter_for_revno returned too much history')
2491
 
        return (True, partial_history[-1])
 
1602
        return self.get_revision(revision_id).inventory_sha1
2492
1603
 
2493
1604
    def iter_reverse_revision_history(self, revision_id):
2494
1605
        """Iterate backwards through revision ids in the lefthand history
2501
1612
        while True:
2502
1613
            if next_id in (None, _mod_revision.NULL_REVISION):
2503
1614
                return
2504
 
            try:
2505
 
                parents = graph.get_parent_map([next_id])[next_id]
2506
 
            except KeyError:
2507
 
                raise errors.RevisionNotPresent(next_id, self)
2508
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]
2509
1622
            if len(parents) == 0:
2510
1623
                return
2511
1624
            else:
2546
1659
        for repositories to maintain loaded indices across multiple locks
2547
1660
        by checking inside their implementation of this method to see
2548
1661
        whether their indices are still valid. This depends of course on
2549
 
        the disk format being validatable in this manner. This method is
2550
 
        also called by the refresh_data() public interface to cause a refresh
2551
 
        to occur while in a write lock so that data inserted by a smart server
2552
 
        push operation is visible on the client's instance of the physical
2553
 
        repository.
 
1662
        the disk format being validatable in this manner.
2554
1663
        """
2555
1664
 
2556
1665
    @needs_read_lock
2563
1672
        # TODO: refactor this to use an existing revision object
2564
1673
        # so we don't need to read it in twice.
2565
1674
        if revision_id == _mod_revision.NULL_REVISION:
2566
 
            return RevisionTree(self, Inventory(root_id=None),
 
1675
            return RevisionTree(self, Inventory(root_id=None), 
2567
1676
                                _mod_revision.NULL_REVISION)
2568
1677
        else:
2569
1678
            inv = self.get_revision_inventory(revision_id)
2570
1679
            return RevisionTree(self, inv, revision_id)
2571
1680
 
2572
1681
    def revision_trees(self, revision_ids):
2573
 
        """Return Trees for revisions in this repository.
 
1682
        """Return Tree for a revision on this branch.
2574
1683
 
2575
 
        :param revision_ids: a sequence of revision-ids;
2576
 
          a revision-id may not be None or 'null:'
2577
 
        """
 
1684
        `revision_id` may not be None or 'null:'"""
2578
1685
        inventories = self.iter_inventories(revision_ids)
2579
1686
        for inv in inventories:
2580
1687
            yield RevisionTree(self, inv, inv.revision_id)
2581
1688
 
2582
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2583
 
        """Return Tree for a revision on this branch with only some files.
2584
 
 
2585
 
        :param revision_ids: a sequence of revision-ids;
2586
 
          a revision-id may not be None or 'null:'
2587
 
        :param file_ids: if not None, the result is filtered
2588
 
          so that only those file-ids, their parents and their
2589
 
          children are included.
2590
 
        """
2591
 
        inventories = self.iter_inventories(revision_ids)
2592
 
        for inv in inventories:
2593
 
            # Should we introduce a FilteredRevisionTree class rather
2594
 
            # than pre-filter the inventory here?
2595
 
            filtered_inv = inv.filter(file_ids)
2596
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2597
 
 
2598
1689
    @needs_read_lock
2599
1690
    def get_ancestry(self, revision_id, topo_sorted=True):
2600
1691
        """Return a list of revision-ids integrated by a revision.
2601
1692
 
2602
 
        The first element of the list is always None, indicating the origin
2603
 
        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 
2604
1695
        perhaps we should have a new API.
2605
 
 
 
1696
        
2606
1697
        This is topologically sorted.
2607
1698
        """
2608
1699
        if _mod_revision.is_null(revision_id):
2625
1716
            keys = tsort.topo_sort(parent_map)
2626
1717
        return [None] + list(keys)
2627
1718
 
2628
 
    def pack(self, hint=None):
 
1719
    def pack(self):
2629
1720
        """Compress the data within the repository.
2630
1721
 
2631
1722
        This operation only makes sense for some repository types. For other
2632
1723
        types it should be a no-op that just returns.
2633
1724
 
2634
1725
        This stub method does not require a lock, but subclasses should use
2635
 
        @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 
2636
1727
        implicitly lock for the user.
 
1728
        """
2637
1729
 
2638
 
        :param hint: If not supplied, the whole repository is packed.
2639
 
            If supplied, the repository may use the hint parameter as a
2640
 
            hint for the parts of the repository to pack. A hint can be
2641
 
            obtained from the result of commit_write_group(). Out of
2642
 
            date hints are simply ignored, because concurrent operations
2643
 
            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.
2644
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)
2645
1748
 
2646
1749
    def get_transaction(self):
2647
1750
        return self.control_files.get_transaction()
2648
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
 
2649
1758
    def get_parent_map(self, revision_ids):
2650
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
1759
        """See graph._StackedParentsProvider.get_parent_map"""
2651
1760
        # revisions index works in keys; this just works in revisions
2652
1761
        # therefore wrap and unwrap
2653
1762
        query_keys = []
2662
1771
        for ((revision_id,), parent_keys) in \
2663
1772
                self.revisions.get_parent_map(query_keys).iteritems():
2664
1773
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
1774
                result[revision_id] = tuple(parent_revid
 
1775
                    for (parent_revid,) in parent_keys)
2667
1776
            else:
2668
1777
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
1778
        return result
2676
1785
        parents_provider = self._make_parents_provider()
2677
1786
        if (other_repository is not None and
2678
1787
            not self.has_same_location(other_repository)):
2679
 
            parents_provider = graph.StackedParentsProvider(
 
1788
            parents_provider = graph._StackedParentsProvider(
2680
1789
                [parents_provider, other_repository._make_parents_provider()])
2681
1790
        return graph.Graph(parents_provider)
2682
1791
 
2683
 
    def _get_versioned_file_checker(self, text_key_references=None,
2684
 
        ancestors=None):
2685
 
        """Return an object suitable for checking versioned files.
2686
 
        
2687
 
        :param text_key_references: if non-None, an already built
2688
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2689
 
            to whether they were referred to by the inventory of the
2690
 
            revision_id that they contain. If None, this will be
2691
 
            calculated.
2692
 
        :param ancestors: Optional result from
2693
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2694
 
            available.
2695
 
        """
2696
 
        return _VersionedFileChecker(self,
2697
 
            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)
2698
1795
 
2699
1796
    def revision_ids_to_search_result(self, result_set):
2700
1797
        """Convert a set of revision ids to a graph SearchResult."""
2720
1817
                          working trees.
2721
1818
        """
2722
1819
        raise NotImplementedError(self.set_make_working_trees)
2723
 
 
 
1820
    
2724
1821
    def make_working_trees(self):
2725
1822
        """Returns the policy for making working trees on new branches."""
2726
1823
        raise NotImplementedError(self.make_working_trees)
2750
1847
        return record.get_bytes_as('fulltext')
2751
1848
 
2752
1849
    @needs_read_lock
2753
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1850
    def check(self, revision_ids=None):
2754
1851
        """Check consistency of all history of given revision_ids.
2755
1852
 
2756
1853
        Different repository implementations should override _check().
2757
1854
 
2758
1855
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2759
1856
             will be checked.  Typically the last revision_id of a branch.
2760
 
        :param callback_refs: A dict of check-refs to resolve and callback
2761
 
            the check/_check method on the items listed as wanting the ref.
2762
 
            see bzrlib.check.
2763
 
        :param check_repo: If False do not check the repository contents, just 
2764
 
            calculate the data callback_refs requires and call them back.
2765
1857
        """
2766
 
        return self._check(revision_ids, callback_refs=callback_refs,
2767
 
            check_repo=check_repo)
 
1858
        return self._check(revision_ids)
2768
1859
 
2769
 
    def _check(self, revision_ids, callback_refs, check_repo):
2770
 
        result = check.Check(self, check_repo=check_repo)
2771
 
        result.check(callback_refs)
 
1860
    def _check(self, revision_ids):
 
1861
        result = check.Check(self)
 
1862
        result.check()
2772
1863
        return result
2773
1864
 
2774
 
    def _warn_if_deprecated(self, branch=None):
 
1865
    def _warn_if_deprecated(self):
2775
1866
        global _deprecation_warning_done
2776
1867
        if _deprecation_warning_done:
2777
1868
            return
2778
 
        try:
2779
 
            if branch is None:
2780
 
                conf = config.GlobalConfig()
2781
 
            else:
2782
 
                conf = branch.get_config()
2783
 
            if conf.suppress_warning('format_deprecation'):
2784
 
                return
2785
 
            warning("Format %s for %s is deprecated -"
2786
 
                    " please use 'bzr upgrade' to get better performance"
2787
 
                    % (self._format, self.bzrdir.transport.base))
2788
 
        finally:
2789
 
            _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))
2790
1872
 
2791
1873
    def supports_rich_root(self):
2792
1874
        return self._format.rich_root_data
2806
1888
                    revision_id.decode('ascii')
2807
1889
                except UnicodeDecodeError:
2808
1890
                    raise errors.NonAsciiRevisionId(method, self)
2809
 
 
 
1891
    
2810
1892
    def revision_graph_can_have_wrong_parents(self):
2811
1893
        """Is it possible for this repository to have a revision graph with
2812
1894
        incorrect parents?
2866
1948
    """
2867
1949
    repository.start_write_group()
2868
1950
    try:
2869
 
        inventory_cache = lru_cache.LRUCache(10)
2870
1951
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2871
 
            _install_revision(repository, revision, revision_tree, signature,
2872
 
                inventory_cache)
 
1952
            _install_revision(repository, revision, revision_tree, signature)
2873
1953
            if pb is not None:
2874
1954
                pb.update('Transferring revisions', n + 1, num_revisions)
2875
1955
    except:
2879
1959
        repository.commit_write_group()
2880
1960
 
2881
1961
 
2882
 
def _install_revision(repository, rev, revision_tree, signature,
2883
 
    inventory_cache):
 
1962
def _install_revision(repository, rev, revision_tree, signature):
2884
1963
    """Install all revision data into a repository."""
2885
1964
    present_parents = []
2886
1965
    parent_trees = {}
2923
2002
        repository.texts.add_lines(text_key, text_parents, lines)
2924
2003
    try:
2925
2004
        # install the inventory
2926
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2927
 
            # Cache this inventory
2928
 
            inventory_cache[rev.revision_id] = inv
2929
 
            try:
2930
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2931
 
            except KeyError:
2932
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2933
 
            else:
2934
 
                delta = inv._make_delta(basis_inv)
2935
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2936
 
                    rev.revision_id, present_parents)
2937
 
        else:
2938
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2005
        repository.add_inventory(rev.revision_id, inv, present_parents)
2939
2006
    except errors.RevisionAlreadyPresent:
2940
2007
        pass
2941
2008
    if signature is not None:
2945
2012
 
2946
2013
class MetaDirRepository(Repository):
2947
2014
    """Repositories in the new meta-dir layout.
2948
 
 
 
2015
    
2949
2016
    :ivar _transport: Transport for access to repository control files,
2950
2017
        typically pointing to .bzr/repository.
2951
2018
    """
2976
2043
        else:
2977
2044
            self._transport.put_bytes('no-working-trees', '',
2978
2045
                mode=self.bzrdir._get_file_mode())
2979
 
 
 
2046
    
2980
2047
    def make_working_trees(self):
2981
2048
        """Returns the policy for making working trees on new branches."""
2982
2049
        return not self._transport.has('no-working-trees')
2990
2057
            control_files)
2991
2058
 
2992
2059
 
2993
 
network_format_registry = registry.FormatRegistry()
2994
 
"""Registry of formats indexed by their network name.
2995
 
 
2996
 
The network name for a repository format is an identifier that can be used when
2997
 
referring to formats with smart server operations. See
2998
 
RepositoryFormat.network_name() for more detail.
2999
 
"""
3000
 
 
3001
 
 
3002
 
format_registry = registry.FormatRegistry(network_format_registry)
3003
 
"""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.
3004
2072
 
3005
2073
This can contain either format instances themselves, or classes/factories that
3006
2074
can be called to obtain one.
3013
2081
class RepositoryFormat(object):
3014
2082
    """A repository format.
3015
2083
 
3016
 
    Formats provide four things:
 
2084
    Formats provide three things:
3017
2085
     * An initialization routine to construct repository data on disk.
3018
 
     * a optional format string which is used when the BzrDir supports
3019
 
       versioned children.
 
2086
     * a format string which is used when the BzrDir supports versioned
 
2087
       children.
3020
2088
     * an open routine which returns a Repository instance.
3021
 
     * A network name for referring to the format in smart server RPC
3022
 
       methods.
3023
2089
 
3024
2090
    There is one and only one Format subclass for each on-disk format. But
3025
2091
    there can be one Repository subclass that is used for several different
3026
2092
    formats. The _format attribute on a Repository instance can be used to
3027
2093
    determine the disk format.
3028
2094
 
3029
 
    Formats are placed in a registry by their format string for reference
3030
 
    during opening. These should be subclasses of RepositoryFormat for
3031
 
    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.
3032
2098
 
3033
2099
    Once a format is deprecated, just deprecate the initialize and open
3034
 
    methods on the format class. Do not deprecate the object, as the
3035
 
    object may be created even when a repository instance hasn't been
3036
 
    created.
 
2100
    methods on the format class. Do not deprecate the object, as the 
 
2101
    object will be created every system load.
3037
2102
 
3038
2103
    Common instance attributes:
3039
2104
    _matchingbzrdir - the bzrdir format that the repository format was
3048
2113
    # Can this repository be given external locations to lookup additional
3049
2114
    # data. Set to True or False in derived classes.
3050
2115
    supports_external_lookups = None
3051
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3052
 
    # derived classes.
3053
 
    supports_chks = None
3054
 
    # Should commit add an inventory, or an inventory delta to the repository.
3055
 
    _commit_inv_deltas = True
3056
 
    # What order should fetch operations request streams in?
3057
 
    # The default is unordered as that is the cheapest for an origin to
3058
 
    # provide.
3059
 
    _fetch_order = 'unordered'
3060
 
    # Does this repository format use deltas that can be fetched as-deltas ?
3061
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3062
 
    # We default to False, which will ensure that enough data to get
3063
 
    # a full text out of any fetch stream will be grabbed.
3064
 
    _fetch_uses_deltas = False
3065
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
3066
 
    # some repository formats that can suffer internal inconsistencies.
3067
 
    _fetch_reconcile = False
3068
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3069
 
    # code path for commit, amongst other things.
3070
 
    fast_deltas = None
3071
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3072
 
    # (so if there is one pack, the operation can still proceed because it may
3073
 
    # help), and for fetching when data won't have come from the same
3074
 
    # compressor.
3075
 
    pack_compresses = False
3076
 
    # Does the repository inventory storage understand references to trees?
3077
 
    supports_tree_reference = None
3078
2116
 
3079
2117
    def __str__(self):
3080
2118
        return "<%s>" % self.__class__.__name__
3089
2127
    @classmethod
3090
2128
    def find_format(klass, a_bzrdir):
3091
2129
        """Return the format for the repository object in a_bzrdir.
3092
 
 
 
2130
        
3093
2131
        This is used by bzr native formats that have a "format" file in
3094
 
        the repository.  Other methods may be used by different types of
 
2132
        the repository.  Other methods may be used by different types of 
3095
2133
        control directory.
3096
2134
        """
3097
2135
        try:
3098
2136
            transport = a_bzrdir.get_repository_transport(None)
3099
 
            format_string = transport.get_bytes("format")
 
2137
            format_string = transport.get("format").read()
3100
2138
            return format_registry.get(format_string)
3101
2139
        except errors.NoSuchFile:
3102
2140
            raise errors.NoRepositoryPresent(a_bzrdir)
3111
2149
    @classmethod
3112
2150
    def unregister_format(klass, format):
3113
2151
        format_registry.remove(format.get_format_string())
3114
 
 
 
2152
    
3115
2153
    @classmethod
3116
2154
    def get_default_format(klass):
3117
2155
        """Return the current default format."""
3120
2158
 
3121
2159
    def get_format_string(self):
3122
2160
        """Return the ASCII format string that identifies this format.
3123
 
 
3124
 
        Note that in pre format ?? repositories the format string is
 
2161
        
 
2162
        Note that in pre format ?? repositories the format string is 
3125
2163
        not permitted nor written to disk.
3126
2164
        """
3127
2165
        raise NotImplementedError(self.get_format_string)
3158
2196
        :param a_bzrdir: The bzrdir to put the new repository in it.
3159
2197
        :param shared: The repository should be initialized as a sharable one.
3160
2198
        :returns: The new repository object.
3161
 
 
 
2199
        
3162
2200
        This may raise UninitializableFormat if shared repository are not
3163
2201
        compatible the a_bzrdir.
3164
2202
        """
3168
2206
        """Is this format supported?
3169
2207
 
3170
2208
        Supported formats must be initializable and openable.
3171
 
        Unsupported formats may not support initialization or committing or
 
2209
        Unsupported formats may not support initialization or committing or 
3172
2210
        some other features depending on the reason for not being supported.
3173
2211
        """
3174
2212
        return True
3175
2213
 
3176
 
    def network_name(self):
3177
 
        """A simple byte string uniquely identifying this format for RPC calls.
3178
 
 
3179
 
        MetaDir repository formats use their disk format string to identify the
3180
 
        repository over the wire. All in one formats such as bzr < 0.8, and
3181
 
        foreign formats like svn/git and hg should use some marker which is
3182
 
        unique and immutable.
3183
 
        """
3184
 
        raise NotImplementedError(self.network_name)
3185
 
 
3186
2214
    def check_conversion_target(self, target_format):
3187
 
        if self.rich_root_data and not target_format.rich_root_data:
3188
 
            raise errors.BadConversionTarget(
3189
 
                'Does not support rich root data.', target_format,
3190
 
                from_format=self)
3191
 
        if (self.supports_tree_reference and 
3192
 
            not getattr(target_format, 'supports_tree_reference', False)):
3193
 
            raise errors.BadConversionTarget(
3194
 
                'Does not support nested trees', target_format,
3195
 
                from_format=self)
 
2215
        raise NotImplementedError(self.check_conversion_target)
3196
2216
 
3197
2217
    def open(self, a_bzrdir, _found=False):
3198
2218
        """Return an instance of this format for the bzrdir a_bzrdir.
3199
 
 
 
2219
        
3200
2220
        _found is a private parameter, do not use it.
3201
2221
        """
3202
2222
        raise NotImplementedError(self.open)
3208
2228
    rich_root_data = False
3209
2229
    supports_tree_reference = False
3210
2230
    supports_external_lookups = False
3211
 
 
3212
 
    @property
3213
 
    def _matchingbzrdir(self):
3214
 
        matching = bzrdir.BzrDirMetaFormat1()
3215
 
        matching.repository_format = self
3216
 
        return matching
 
2231
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3217
2232
 
3218
2233
    def __init__(self):
3219
2234
        super(MetaDirRepositoryFormat, self).__init__()
3246
2261
        finally:
3247
2262
            control_files.unlock()
3248
2263
 
3249
 
    def network_name(self):
3250
 
        """Metadir formats have matching disk and network format strings."""
3251
 
        return self.get_format_string()
3252
 
 
3253
 
 
3254
 
# Pre-0.8 formats that don't have a disk format string (because they are
3255
 
# versioned by the matching control directory). We use the control directories
3256
 
# disk format string as a key for the network_name because they meet the
3257
 
# constraints (simple string, unique, immutable).
3258
 
network_format_registry.register_lazy(
3259
 
    "Bazaar-NG branch, format 5\n",
3260
 
    'bzrlib.repofmt.weaverepo',
3261
 
    'RepositoryFormat5',
3262
 
)
3263
 
network_format_registry.register_lazy(
3264
 
    "Bazaar-NG branch, format 6\n",
3265
 
    'bzrlib.repofmt.weaverepo',
3266
 
    'RepositoryFormat6',
3267
 
)
3268
 
 
3269
 
# formats which have no format string are not discoverable or independently
3270
 
# 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 
3271
2267
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3272
2268
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3273
2269
# the repository is not separately opened are similar.
3340
2336
    'RepositoryFormatKnitPack6RichRoot',
3341
2337
    )
3342
2338
 
3343
 
# Development formats.
3344
 
# Obsolete but kept pending a CHK based subtree format.
 
2339
# Development formats. 
 
2340
# 1.7->1.8 go below here
 
2341
format_registry.register_lazy(
 
2342
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2343
    'bzrlib.repofmt.pack_repo',
 
2344
    'RepositoryFormatPackDevelopment2',
 
2345
    )
3345
2346
format_registry.register_lazy(
3346
2347
    ("Bazaar development format 2 with subtree support "
3347
2348
        "(needs bzr.dev from before 1.8)\n"),
3349
2350
    'RepositoryFormatPackDevelopment2Subtree',
3350
2351
    )
3351
2352
 
3352
 
# 1.14->1.16 go below here
3353
 
format_registry.register_lazy(
3354
 
    'Bazaar development format - group compression and chk inventory'
3355
 
        ' (needs bzr.dev from 1.14)\n',
3356
 
    'bzrlib.repofmt.groupcompress_repo',
3357
 
    'RepositoryFormatCHK1',
3358
 
    )
3359
 
 
3360
 
format_registry.register_lazy(
3361
 
    'Bazaar development format - chk repository with bencode revision '
3362
 
        'serialization (needs bzr.dev from 1.16)\n',
3363
 
    'bzrlib.repofmt.groupcompress_repo',
3364
 
    'RepositoryFormatCHK2',
3365
 
    )
3366
 
format_registry.register_lazy(
3367
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3368
 
    'bzrlib.repofmt.groupcompress_repo',
3369
 
    'RepositoryFormat2a',
3370
 
    )
3371
 
 
3372
2353
 
3373
2354
class InterRepository(InterObject):
3374
2355
    """This class represents operations taking place between two repositories.
3375
2356
 
3376
2357
    Its instances have methods like copy_content and fetch, and contain
3377
 
    references to the source and target repositories these operations can be
 
2358
    references to the source and target repositories these operations can be 
3378
2359
    carried out on.
3379
2360
 
3380
2361
    Often we will provide convenience methods on 'repository' which carry out
3382
2363
    InterRepository.get(other).method_name(parameters).
3383
2364
    """
3384
2365
 
3385
 
    _walk_to_common_revisions_batch_size = 50
 
2366
    _walk_to_common_revisions_batch_size = 1
3386
2367
    _optimisers = []
3387
2368
    """The available optimised InterRepository types."""
3388
2369
 
3389
 
    @needs_write_lock
 
2370
    def __init__(self, source, target):
 
2371
        InterObject.__init__(self, source, target)
 
2372
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2373
        # provide a faster implementation.
 
2374
        self.target_get_graph = self.target.get_graph
 
2375
        self.target_get_parent_map = self.target.get_parent_map
 
2376
 
3390
2377
    def copy_content(self, revision_id=None):
3391
 
        """Make a complete copy of the content in self into destination.
3392
 
 
3393
 
        This is a destructive operation! Do not use it on existing
3394
 
        repositories.
3395
 
 
3396
 
        :param revision_id: Only copy the content needed to construct
3397
 
                            revision_id and its parents.
3398
 
        """
3399
 
        try:
3400
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3401
 
        except NotImplementedError:
3402
 
            pass
3403
 
        self.target.fetch(self.source, revision_id=revision_id)
3404
 
 
3405
 
    @needs_write_lock
3406
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3407
 
            fetch_spec=None):
 
2378
        raise NotImplementedError(self.copy_content)
 
2379
 
 
2380
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3408
2381
        """Fetch the content required to construct revision_id.
3409
2382
 
3410
2383
        The content is copied from self.source to self.target.
3411
2384
 
3412
2385
        :param revision_id: if None all content is copied, if NULL_REVISION no
3413
2386
                            content is copied.
3414
 
        :param pb: ignored.
3415
 
        :return: None.
 
2387
        :param pb: optional progress bar to use for progress reports. If not
 
2388
                   provided a default one will be created.
 
2389
 
 
2390
        :returns: (copied_revision_count, failures).
3416
2391
        """
3417
 
        f = _mod_fetch.RepoFetcher(to_repository=self.target,
3418
 
                               from_repository=self.source,
3419
 
                               last_revision=revision_id,
3420
 
                               fetch_spec=fetch_spec,
3421
 
                               find_ghosts=find_ghosts)
 
2392
        # Normally we should find a specific InterRepository subclass to do
 
2393
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2394
        # If none of them is suitable it looks like fetching is not possible;
 
2395
        # we try to give a good message why.  _assert_same_model will probably
 
2396
        # give a helpful message; otherwise a generic one.
 
2397
        self._assert_same_model(self.source, self.target)
 
2398
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2399
            "no suitableInterRepository found")
3422
2400
 
3423
2401
    def _walk_to_common_revisions(self, revision_ids):
3424
2402
        """Walk out from revision_ids in source to revisions target has.
3426
2404
        :param revision_ids: The start point for the search.
3427
2405
        :return: A set of revision ids.
3428
2406
        """
3429
 
        target_graph = self.target.get_graph()
 
2407
        target_graph = self.target_get_graph()
3430
2408
        revision_ids = frozenset(revision_ids)
 
2409
        # Fast path for the case where all the revisions are already in the
 
2410
        # target repo.
 
2411
        # (Although this does incur an extra round trip for the
 
2412
        # fairly common case where the target doesn't already have the revision
 
2413
        # we're pushing.)
 
2414
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2415
            return graph.SearchResult(revision_ids, set(), 0, set())
3431
2416
        missing_revs = set()
3432
2417
        source_graph = self.source.get_graph()
3433
2418
        # ensure we don't pay silly lookup costs.
3472
2457
                break
3473
2458
        return searcher.get_result()
3474
2459
 
 
2460
    @deprecated_method(one_two)
 
2461
    @needs_read_lock
 
2462
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2463
        """Return the revision ids that source has that target does not.
 
2464
        
 
2465
        These are returned in topological order.
 
2466
 
 
2467
        :param revision_id: only return revision ids included by this
 
2468
                            revision_id.
 
2469
        :param find_ghosts: If True find missing revisions in deep history
 
2470
            rather than just finding the surface difference.
 
2471
        """
 
2472
        return list(self.search_missing_revision_ids(
 
2473
            revision_id, find_ghosts).get_keys())
 
2474
 
3475
2475
    @needs_read_lock
3476
2476
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3477
2477
        """Return the revision ids that source has that target does not.
3478
 
 
 
2478
        
3479
2479
        :param revision_id: only return revision ids included by this
3480
2480
                            revision_id.
3481
2481
        :param find_ghosts: If True find missing revisions in deep history
3500
2500
    @staticmethod
3501
2501
    def _same_model(source, target):
3502
2502
        """True if source and target have the same data representation.
3503
 
 
 
2503
        
3504
2504
        Note: this is always called on the base class; overriding it in a
3505
2505
        subclass will have no effect.
3506
2506
        """
3524
2524
 
3525
2525
class InterSameDataRepository(InterRepository):
3526
2526
    """Code for converting between repositories that represent the same data.
3527
 
 
 
2527
    
3528
2528
    Data format and model must match for this to work.
3529
2529
    """
3530
2530
 
3531
2531
    @classmethod
3532
2532
    def _get_repo_format_to_test(self):
3533
2533
        """Repository format for testing with.
3534
 
 
 
2534
        
3535
2535
        InterSameData can pull from subtree to subtree and from non-subtree to
3536
2536
        non-subtree, so we test this with the richest repository format.
3537
2537
        """
3542
2542
    def is_compatible(source, target):
3543
2543
        return InterRepository._same_model(source, target)
3544
2544
 
 
2545
    @needs_write_lock
 
2546
    def copy_content(self, revision_id=None):
 
2547
        """Make a complete copy of the content in self into destination.
 
2548
 
 
2549
        This copies both the repository's revision data, and configuration information
 
2550
        such as the make_working_trees setting.
 
2551
        
 
2552
        This is a destructive operation! Do not use it on existing 
 
2553
        repositories.
 
2554
 
 
2555
        :param revision_id: Only copy the content needed to construct
 
2556
                            revision_id and its parents.
 
2557
        """
 
2558
        try:
 
2559
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2560
        except NotImplementedError:
 
2561
            pass
 
2562
        # but don't bother fetching if we have the needed data now.
 
2563
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2564
            self.target.has_revision(revision_id)):
 
2565
            return
 
2566
        self.target.fetch(self.source, revision_id=revision_id)
 
2567
 
 
2568
    @needs_write_lock
 
2569
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2570
        """See InterRepository.fetch()."""
 
2571
        from bzrlib.fetch import RepoFetcher
 
2572
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2573
               self.source, self.source._format, self.target,
 
2574
               self.target._format)
 
2575
        f = RepoFetcher(to_repository=self.target,
 
2576
                               from_repository=self.source,
 
2577
                               last_revision=revision_id,
 
2578
                               pb=pb, find_ghosts=find_ghosts)
 
2579
        return f.count_copied, f.failed_revisions
 
2580
 
3545
2581
 
3546
2582
class InterWeaveRepo(InterSameDataRepository):
3547
2583
    """Optimised code paths between Weave based repositories.
3548
 
 
 
2584
    
3549
2585
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3550
2586
    implemented lazy inter-object optimisation.
3551
2587
    """
3558
2594
    @staticmethod
3559
2595
    def is_compatible(source, target):
3560
2596
        """Be compatible with known Weave formats.
3561
 
 
 
2597
        
3562
2598
        We don't test for the stores being of specific types because that
3563
 
        could lead to confusing results, and there is no need to be
 
2599
        could lead to confusing results, and there is no need to be 
3564
2600
        overly general.
3565
2601
        """
3566
2602
        from bzrlib.repofmt.weaverepo import (
3577
2613
                                                RepositoryFormat7)))
3578
2614
        except AttributeError:
3579
2615
            return False
3580
 
 
 
2616
    
3581
2617
    @needs_write_lock
3582
2618
    def copy_content(self, revision_id=None):
3583
2619
        """See InterRepository.copy_content()."""
3593
2629
                self.target.texts.insert_record_stream(
3594
2630
                    self.source.texts.get_record_stream(
3595
2631
                        self.source.texts.keys(), 'topological', False))
3596
 
                pb.update('Copying inventory', 0, 1)
 
2632
                pb.update('copying inventory', 0, 1)
3597
2633
                self.target.inventories.insert_record_stream(
3598
2634
                    self.source.inventories.get_record_stream(
3599
2635
                        self.source.inventories.keys(), 'topological', False))
3610
2646
        else:
3611
2647
            self.target.fetch(self.source, revision_id=revision_id)
3612
2648
 
 
2649
    @needs_write_lock
 
2650
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2651
        """See InterRepository.fetch()."""
 
2652
        from bzrlib.fetch import RepoFetcher
 
2653
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2654
               self.source, self.source._format, self.target, self.target._format)
 
2655
        f = RepoFetcher(to_repository=self.target,
 
2656
                               from_repository=self.source,
 
2657
                               last_revision=revision_id,
 
2658
                               pb=pb, find_ghosts=find_ghosts)
 
2659
        return f.count_copied, f.failed_revisions
 
2660
 
3613
2661
    @needs_read_lock
3614
2662
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3615
2663
        """See InterRepository.missing_revision_ids()."""
3616
2664
        # we want all revisions to satisfy revision_id in source.
3617
2665
        # but we don't want to stat every file here and there.
3618
 
        # we want then, all revisions other needs to satisfy revision_id
 
2666
        # we want then, all revisions other needs to satisfy revision_id 
3619
2667
        # checked, but not those that we have locally.
3620
 
        # so the first thing is to get a subset of the revisions to
 
2668
        # so the first thing is to get a subset of the revisions to 
3621
2669
        # satisfy revision_id in source, and then eliminate those that
3622
 
        # we do already have.
3623
 
        # this is slow on high latency connection to self, but as this
3624
 
        # disk format scales terribly for push anyway due to rewriting
 
2670
        # we do already have. 
 
2671
        # this is slow on high latency connection to self, but as as this
 
2672
        # disk format scales terribly for push anyway due to rewriting 
3625
2673
        # inventory.weave, this is considered acceptable.
3626
2674
        # - RBC 20060209
3627
2675
        if revision_id is not None:
3647
2695
            # and the tip revision was validated by get_ancestry.
3648
2696
            result_set = required_revisions
3649
2697
        else:
3650
 
            # if we just grabbed the possibly available ids, then
 
2698
            # if we just grabbed the possibly available ids, then 
3651
2699
            # we only have an estimate of whats available and need to validate
3652
2700
            # that against the revision records.
3653
2701
            result_set = set(
3666
2714
    @staticmethod
3667
2715
    def is_compatible(source, target):
3668
2716
        """Be compatible with known Knit formats.
3669
 
 
 
2717
        
3670
2718
        We don't test for the stores being of specific types because that
3671
 
        could lead to confusing results, and there is no need to be
 
2719
        could lead to confusing results, and there is no need to be 
3672
2720
        overly general.
3673
2721
        """
3674
2722
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3679
2727
            return False
3680
2728
        return are_knits and InterRepository._same_model(source, target)
3681
2729
 
 
2730
    @needs_write_lock
 
2731
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2732
        """See InterRepository.fetch()."""
 
2733
        from bzrlib.fetch import RepoFetcher
 
2734
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2735
               self.source, self.source._format, self.target, self.target._format)
 
2736
        f = RepoFetcher(to_repository=self.target,
 
2737
                            from_repository=self.source,
 
2738
                            last_revision=revision_id,
 
2739
                            pb=pb, find_ghosts=find_ghosts)
 
2740
        return f.count_copied, f.failed_revisions
 
2741
 
3682
2742
    @needs_read_lock
3683
2743
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3684
2744
        """See InterRepository.missing_revision_ids()."""
3705
2765
            # and the tip revision was validated by get_ancestry.
3706
2766
            result_set = required_revisions
3707
2767
        else:
3708
 
            # if we just grabbed the possibly available ids, then
 
2768
            # if we just grabbed the possibly available ids, then 
3709
2769
            # we only have an estimate of whats available and need to validate
3710
2770
            # that against the revision records.
3711
2771
            result_set = set(
3713
2773
        return self.source.revision_ids_to_search_result(result_set)
3714
2774
 
3715
2775
 
3716
 
class InterDifferingSerializer(InterRepository):
 
2776
class InterPackRepo(InterSameDataRepository):
 
2777
    """Optimised code paths between Pack based repositories."""
 
2778
 
 
2779
    @classmethod
 
2780
    def _get_repo_format_to_test(self):
 
2781
        from bzrlib.repofmt import pack_repo
 
2782
        return pack_repo.RepositoryFormatKnitPack1()
 
2783
 
 
2784
    @staticmethod
 
2785
    def is_compatible(source, target):
 
2786
        """Be compatible with known Pack formats.
 
2787
        
 
2788
        We don't test for the stores being of specific types because that
 
2789
        could lead to confusing results, and there is no need to be 
 
2790
        overly general.
 
2791
        """
 
2792
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2793
        try:
 
2794
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2795
                isinstance(target._format, RepositoryFormatPack))
 
2796
        except AttributeError:
 
2797
            return False
 
2798
        return are_packs and InterRepository._same_model(source, target)
 
2799
 
 
2800
    @needs_write_lock
 
2801
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2802
        """See InterRepository.fetch()."""
 
2803
        if (len(self.source._fallback_repositories) > 0 or
 
2804
            len(self.target._fallback_repositories) > 0):
 
2805
            # The pack layer is not aware of fallback repositories, so when
 
2806
            # fetching from a stacked repository or into a stacked repository
 
2807
            # we use the generic fetch logic which uses the VersionedFiles
 
2808
            # attributes on repository.
 
2809
            from bzrlib.fetch import RepoFetcher
 
2810
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2811
                                  pb, find_ghosts)
 
2812
            return fetcher.count_copied, fetcher.failed_revisions
 
2813
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2814
               self.source, self.source._format, self.target, self.target._format)
 
2815
        self.count_copied = 0
 
2816
        if revision_id is None:
 
2817
            # TODO:
 
2818
            # everything to do - use pack logic
 
2819
            # to fetch from all packs to one without
 
2820
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2821
            # till then:
 
2822
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2823
            revision_ids = source_revision_ids - \
 
2824
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2825
            revision_keys = [(revid,) for revid in revision_ids]
 
2826
            target_pack_collection = self._get_target_pack_collection()
 
2827
            index = target_pack_collection.revision_index.combined_index
 
2828
            present_revision_ids = set(item[1][0] for item in
 
2829
                index.iter_entries(revision_keys))
 
2830
            revision_ids = set(revision_ids) - present_revision_ids
 
2831
            # implementing the TODO will involve:
 
2832
            # - detecting when all of a pack is selected
 
2833
            # - avoiding as much as possible pre-selection, so the
 
2834
            # more-core routines such as create_pack_from_packs can filter in
 
2835
            # a just-in-time fashion. (though having a HEADS list on a
 
2836
            # repository might make this a lot easier, because we could
 
2837
            # sensibly detect 'new revisions' without doing a full index scan.
 
2838
        elif _mod_revision.is_null(revision_id):
 
2839
            # nothing to do:
 
2840
            return (0, [])
 
2841
        else:
 
2842
            try:
 
2843
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2844
                    find_ghosts=find_ghosts).get_keys()
 
2845
            except errors.NoSuchRevision:
 
2846
                raise errors.InstallFailed([revision_id])
 
2847
            if len(revision_ids) == 0:
 
2848
                return (0, [])
 
2849
        return self._pack(self.source, self.target, revision_ids)
 
2850
 
 
2851
    def _pack(self, source, target, revision_ids):
 
2852
        from bzrlib.repofmt.pack_repo import Packer
 
2853
        target_pack_collection = self._get_target_pack_collection()
 
2854
        packs = source._pack_collection.all_packs()
 
2855
        pack = Packer(target_pack_collection, packs, '.fetch',
 
2856
            revision_ids).pack()
 
2857
        if pack is not None:
 
2858
            target_pack_collection._save_pack_names()
 
2859
            copied_revs = pack.get_revision_count()
 
2860
            # Trigger an autopack. This may duplicate effort as we've just done
 
2861
            # a pack creation, but for now it is simpler to think about as
 
2862
            # 'upload data, then repack if needed'.
 
2863
            self._autopack()
 
2864
            return (copied_revs, [])
 
2865
        else:
 
2866
            return (0, [])
 
2867
 
 
2868
    def _autopack(self):
 
2869
        self.target._pack_collection.autopack()
 
2870
        
 
2871
    def _get_target_pack_collection(self):
 
2872
        return self.target._pack_collection
 
2873
 
 
2874
    @needs_read_lock
 
2875
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2876
        """See InterRepository.missing_revision_ids().
 
2877
        
 
2878
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2879
            revision_id.
 
2880
        """
 
2881
        if not find_ghosts and revision_id is not None:
 
2882
            return self._walk_to_common_revisions([revision_id])
 
2883
        elif revision_id is not None:
 
2884
            # Find ghosts: search for revisions pointing from one repository to
 
2885
            # the other, and vice versa, anywhere in the history of revision_id.
 
2886
            graph = self.target_get_graph(other_repository=self.source)
 
2887
            searcher = graph._make_breadth_first_searcher([revision_id])
 
2888
            found_ids = set()
 
2889
            while True:
 
2890
                try:
 
2891
                    next_revs, ghosts = searcher.next_with_ghosts()
 
2892
                except StopIteration:
 
2893
                    break
 
2894
                if revision_id in ghosts:
 
2895
                    raise errors.NoSuchRevision(self.source, revision_id)
 
2896
                found_ids.update(next_revs)
 
2897
                found_ids.update(ghosts)
 
2898
            found_ids = frozenset(found_ids)
 
2899
            # Double query here: should be able to avoid this by changing the
 
2900
            # graph api further.
 
2901
            result_set = found_ids - frozenset(
 
2902
                self.target_get_parent_map(found_ids))
 
2903
        else:
 
2904
            source_ids = self.source.all_revision_ids()
 
2905
            # source_ids is the worst possible case we may need to pull.
 
2906
            # now we want to filter source_ids against what we actually
 
2907
            # have in target, but don't try to check for existence where we know
 
2908
            # we do not have a revision as that would be pointless.
 
2909
            target_ids = set(self.target.all_revision_ids())
 
2910
            result_set = set(source_ids).difference(target_ids)
 
2911
        return self.source.revision_ids_to_search_result(result_set)
 
2912
 
 
2913
 
 
2914
class InterModel1and2(InterRepository):
 
2915
 
 
2916
    @classmethod
 
2917
    def _get_repo_format_to_test(self):
 
2918
        return None
 
2919
 
 
2920
    @staticmethod
 
2921
    def is_compatible(source, target):
 
2922
        if not source.supports_rich_root() and target.supports_rich_root():
 
2923
            return True
 
2924
        else:
 
2925
            return False
 
2926
 
 
2927
    @needs_write_lock
 
2928
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2929
        """See InterRepository.fetch()."""
 
2930
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2931
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2932
                                 from_repository=self.source,
 
2933
                                 last_revision=revision_id,
 
2934
                                 pb=pb, find_ghosts=find_ghosts)
 
2935
        return f.count_copied, f.failed_revisions
 
2936
 
 
2937
    @needs_write_lock
 
2938
    def copy_content(self, revision_id=None):
 
2939
        """Make a complete copy of the content in self into destination.
 
2940
        
 
2941
        This is a destructive operation! Do not use it on existing 
 
2942
        repositories.
 
2943
 
 
2944
        :param revision_id: Only copy the content needed to construct
 
2945
                            revision_id and its parents.
 
2946
        """
 
2947
        try:
 
2948
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2949
        except NotImplementedError:
 
2950
            pass
 
2951
        # but don't bother fetching if we have the needed data now.
 
2952
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2953
            self.target.has_revision(revision_id)):
 
2954
            return
 
2955
        self.target.fetch(self.source, revision_id=revision_id)
 
2956
 
 
2957
 
 
2958
class InterKnit1and2(InterKnitRepo):
 
2959
 
 
2960
    @classmethod
 
2961
    def _get_repo_format_to_test(self):
 
2962
        return None
 
2963
 
 
2964
    @staticmethod
 
2965
    def is_compatible(source, target):
 
2966
        """Be compatible with Knit1 source and Knit3 target"""
 
2967
        try:
 
2968
            from bzrlib.repofmt.knitrepo import (
 
2969
                RepositoryFormatKnit1,
 
2970
                RepositoryFormatKnit3,
 
2971
                )
 
2972
            from bzrlib.repofmt.pack_repo import (
 
2973
                RepositoryFormatKnitPack1,
 
2974
                RepositoryFormatKnitPack3,
 
2975
                RepositoryFormatKnitPack4,
 
2976
                RepositoryFormatKnitPack5,
 
2977
                RepositoryFormatKnitPack5RichRoot,
 
2978
                RepositoryFormatKnitPack6,
 
2979
                RepositoryFormatKnitPack6RichRoot,
 
2980
                RepositoryFormatPackDevelopment2,
 
2981
                RepositoryFormatPackDevelopment2Subtree,
 
2982
                )
 
2983
            norichroot = (
 
2984
                RepositoryFormatKnit1,            # no rr, no subtree
 
2985
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
2986
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
2987
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
2988
                RepositoryFormatKnitPack6,        # no rr, no subtree
 
2989
                )
 
2990
            richroot = (
 
2991
                RepositoryFormatKnit3,            # rr, subtree
 
2992
                RepositoryFormatKnitPack3,        # rr, subtree
 
2993
                RepositoryFormatKnitPack4,        # rr, no subtree
 
2994
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
2995
                RepositoryFormatKnitPack6RichRoot,# rr, no subtree
 
2996
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
2997
                )
 
2998
            for format in norichroot:
 
2999
                if format.rich_root_data:
 
3000
                    raise AssertionError('Format %s is a rich-root format'
 
3001
                        ' but is included in the non-rich-root list'
 
3002
                        % (format,))
 
3003
            for format in richroot:
 
3004
                if not format.rich_root_data:
 
3005
                    raise AssertionError('Format %s is not a rich-root format'
 
3006
                        ' but is included in the rich-root list'
 
3007
                        % (format,))
 
3008
            # TODO: One alternative is to just check format.rich_root_data,
 
3009
            #       instead of keeping membership lists. However, the formats
 
3010
            #       *also* have to use the same 'Knit' style of storage
 
3011
            #       (line-deltas, fulltexts, etc.)
 
3012
            return (isinstance(source._format, norichroot) and
 
3013
                    isinstance(target._format, richroot))
 
3014
        except AttributeError:
 
3015
            return False
 
3016
 
 
3017
    @needs_write_lock
 
3018
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3019
        """See InterRepository.fetch()."""
 
3020
        from bzrlib.fetch import Knit1to2Fetcher
 
3021
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
3022
               self.source, self.source._format, self.target, 
 
3023
               self.target._format)
 
3024
        f = Knit1to2Fetcher(to_repository=self.target,
 
3025
                            from_repository=self.source,
 
3026
                            last_revision=revision_id,
 
3027
                            pb=pb, find_ghosts=find_ghosts)
 
3028
        return f.count_copied, f.failed_revisions
 
3029
 
 
3030
 
 
3031
class InterDifferingSerializer(InterKnitRepo):
3717
3032
 
3718
3033
    @classmethod
3719
3034
    def _get_repo_format_to_test(self):
3722
3037
    @staticmethod
3723
3038
    def is_compatible(source, target):
3724
3039
        """Be compatible with Knit2 source and Knit3 target"""
3725
 
        # This is redundant with format.check_conversion_target(), however that
3726
 
        # raises an exception, and we just want to say "False" as in we won't
3727
 
        # support converting between these formats.
3728
 
        if 'IDS_never' in debug.debug_flags:
3729
 
            return False
3730
 
        if source.supports_rich_root() and not target.supports_rich_root():
3731
 
            return False
3732
 
        if (source._format.supports_tree_reference
3733
 
            and not target._format.supports_tree_reference):
3734
 
            return False
3735
 
        if target._fallback_repositories and target._format.supports_chks:
3736
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3737
 
            # adds to stacked repos.
3738
 
            return False
3739
 
        if 'IDS_always' in debug.debug_flags:
3740
 
            return True
3741
 
        # Only use this code path for local source and target.  IDS does far
3742
 
        # too much IO (both bandwidth and roundtrips) over a network.
3743
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3744
 
            return False
3745
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3040
        if source.supports_rich_root() != target.supports_rich_root():
 
3041
            return False
 
3042
        # Ideally, we'd support fetching if the source had no tree references
 
3043
        # even if it supported them...
 
3044
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3045
            not getattr(target, '_format.supports_tree_reference', False)):
3746
3046
            return False
3747
3047
        return True
3748
3048
 
3749
 
    def _get_trees(self, revision_ids, cache):
3750
 
        possible_trees = []
3751
 
        for rev_id in revision_ids:
3752
 
            if rev_id in cache:
3753
 
                possible_trees.append((rev_id, cache[rev_id]))
3754
 
            else:
3755
 
                # Not cached, but inventory might be present anyway.
3756
 
                try:
3757
 
                    tree = self.source.revision_tree(rev_id)
3758
 
                except errors.NoSuchRevision:
3759
 
                    # Nope, parent is ghost.
3760
 
                    pass
3761
 
                else:
3762
 
                    cache[rev_id] = tree
3763
 
                    possible_trees.append((rev_id, tree))
3764
 
        return possible_trees
3765
 
 
3766
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3767
 
        """Get the best delta and base for this revision.
3768
 
 
3769
 
        :return: (basis_id, delta)
3770
 
        """
3771
 
        deltas = []
3772
 
        # Generate deltas against each tree, to find the shortest.
3773
 
        texts_possibly_new_in_tree = set()
3774
 
        for basis_id, basis_tree in possible_trees:
3775
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3776
 
            for old_path, new_path, file_id, new_entry in delta:
3777
 
                if new_path is None:
3778
 
                    # This file_id isn't present in the new rev, so we don't
3779
 
                    # care about it.
3780
 
                    continue
3781
 
                if not new_path:
3782
 
                    # Rich roots are handled elsewhere...
3783
 
                    continue
3784
 
                kind = new_entry.kind
3785
 
                if kind != 'directory' and kind != 'file':
3786
 
                    # No text record associated with this inventory entry.
3787
 
                    continue
3788
 
                # This is a directory or file that has changed somehow.
3789
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3790
 
            deltas.append((len(delta), basis_id, delta))
3791
 
        deltas.sort()
3792
 
        return deltas[0][1:]
3793
 
 
3794
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3795
 
        """Find all parent revisions that are absent, but for which the
3796
 
        inventory is present, and copy those inventories.
3797
 
 
3798
 
        This is necessary to preserve correctness when the source is stacked
3799
 
        without fallbacks configured.  (Note that in cases like upgrade the
3800
 
        source may be not have _fallback_repositories even though it is
3801
 
        stacked.)
3802
 
        """
3803
 
        parent_revs = set()
3804
 
        for parents in parent_map.values():
3805
 
            parent_revs.update(parents)
3806
 
        present_parents = self.source.get_parent_map(parent_revs)
3807
 
        absent_parents = set(parent_revs).difference(present_parents)
3808
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3809
 
            (rev_id,) for rev_id in absent_parents)
3810
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3811
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3812
 
            current_revision_id = parent_tree.get_revision_id()
3813
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3814
 
                (current_revision_id,)]
3815
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3816
 
            basis_id = _mod_revision.NULL_REVISION
3817
 
            basis_tree = self.source.revision_tree(basis_id)
3818
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3819
 
            self.target.add_inventory_by_delta(
3820
 
                basis_id, delta, current_revision_id, parents_parents)
3821
 
            cache[current_revision_id] = parent_tree
3822
 
 
3823
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3824
 
        """Fetch across a few revisions.
3825
 
 
3826
 
        :param revision_ids: The revisions to copy
3827
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3828
 
            as a basis for delta when no other base is available
3829
 
        :param cache: A cache of RevisionTrees that we can use.
3830
 
        :param a_graph: A Graph object to determine the heads() of the
3831
 
            rich-root data stream.
3832
 
        :return: The revision_id of the last converted tree. The RevisionTree
3833
 
            for it will be in cache
3834
 
        """
3835
 
        # Walk though all revisions; get inventory deltas, copy referenced
3836
 
        # texts that delta references, insert the delta, revision and
3837
 
        # signature.
3838
 
        root_keys_to_create = set()
3839
 
        text_keys = set()
3840
 
        pending_deltas = []
3841
 
        pending_revisions = []
3842
 
        parent_map = self.source.get_parent_map(revision_ids)
3843
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3844
 
        self.source._safe_to_return_from_cache = True
3845
 
        for tree in self.source.revision_trees(revision_ids):
3846
 
            # Find a inventory delta for this revision.
3847
 
            # Find text entries that need to be copied, too.
3848
 
            current_revision_id = tree.get_revision_id()
3849
 
            parent_ids = parent_map.get(current_revision_id, ())
3850
 
            parent_trees = self._get_trees(parent_ids, cache)
3851
 
            possible_trees = list(parent_trees)
3852
 
            if len(possible_trees) == 0:
3853
 
                # There either aren't any parents, or the parents are ghosts,
3854
 
                # so just use the last converted tree.
3855
 
                possible_trees.append((basis_id, cache[basis_id]))
3856
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3857
 
                                                           possible_trees)
3858
 
            revision = self.source.get_revision(current_revision_id)
3859
 
            pending_deltas.append((basis_id, delta,
3860
 
                current_revision_id, revision.parent_ids))
3861
 
            if self._converting_to_rich_root:
3862
 
                self._revision_id_to_root_id[current_revision_id] = \
3863
 
                    tree.get_root_id()
3864
 
            # Determine which texts are in present in this revision but not in
3865
 
            # any of the available parents.
3866
 
            texts_possibly_new_in_tree = set()
3867
 
            for old_path, new_path, file_id, entry in delta:
3868
 
                if new_path is None:
3869
 
                    # This file_id isn't present in the new rev
3870
 
                    continue
3871
 
                if not new_path:
3872
 
                    # This is the root
3873
 
                    if not self.target.supports_rich_root():
3874
 
                        # The target doesn't support rich root, so we don't
3875
 
                        # copy
3876
 
                        continue
3877
 
                    if self._converting_to_rich_root:
3878
 
                        # This can't be copied normally, we have to insert
3879
 
                        # it specially
3880
 
                        root_keys_to_create.add((file_id, entry.revision))
3881
 
                        continue
3882
 
                kind = entry.kind
3883
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3884
 
            for basis_id, basis_tree in possible_trees:
3885
 
                basis_inv = basis_tree.inventory
3886
 
                for file_key in list(texts_possibly_new_in_tree):
3887
 
                    file_id, file_revision = file_key
3888
 
                    try:
3889
 
                        entry = basis_inv[file_id]
3890
 
                    except errors.NoSuchId:
3891
 
                        continue
3892
 
                    if entry.revision == file_revision:
3893
 
                        texts_possibly_new_in_tree.remove(file_key)
3894
 
            text_keys.update(texts_possibly_new_in_tree)
3895
 
            pending_revisions.append(revision)
3896
 
            cache[current_revision_id] = tree
3897
 
            basis_id = current_revision_id
3898
 
        self.source._safe_to_return_from_cache = False
3899
 
        # Copy file texts
3900
 
        from_texts = self.source.texts
3901
 
        to_texts = self.target.texts
3902
 
        if root_keys_to_create:
3903
 
            root_stream = _mod_fetch._new_root_data_stream(
3904
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3905
 
                self.source, graph=a_graph)
3906
 
            to_texts.insert_record_stream(root_stream)
3907
 
        to_texts.insert_record_stream(from_texts.get_record_stream(
3908
 
            text_keys, self.target._format._fetch_order,
3909
 
            not self.target._format._fetch_uses_deltas))
3910
 
        # insert inventory deltas
3911
 
        for delta in pending_deltas:
3912
 
            self.target.add_inventory_by_delta(*delta)
3913
 
        if self.target._fallback_repositories:
3914
 
            # Make sure this stacked repository has all the parent inventories
3915
 
            # for the new revisions that we are about to insert.  We do this
3916
 
            # before adding the revisions so that no revision is added until
3917
 
            # all the inventories it may depend on are added.
3918
 
            # Note that this is overzealous, as we may have fetched these in an
3919
 
            # earlier batch.
3920
 
            parent_ids = set()
3921
 
            revision_ids = set()
3922
 
            for revision in pending_revisions:
3923
 
                revision_ids.add(revision.revision_id)
3924
 
                parent_ids.update(revision.parent_ids)
3925
 
            parent_ids.difference_update(revision_ids)
3926
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3927
 
            parent_map = self.source.get_parent_map(parent_ids)
3928
 
            # we iterate over parent_map and not parent_ids because we don't
3929
 
            # want to try copying any revision which is a ghost
3930
 
            for parent_tree in self.source.revision_trees(parent_map):
3931
 
                current_revision_id = parent_tree.get_revision_id()
3932
 
                parents_parents = parent_map[current_revision_id]
3933
 
                possible_trees = self._get_trees(parents_parents, cache)
3934
 
                if len(possible_trees) == 0:
3935
 
                    # There either aren't any parents, or the parents are
3936
 
                    # ghosts, so just use the last converted tree.
3937
 
                    possible_trees.append((basis_id, cache[basis_id]))
3938
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3939
 
                    parents_parents, possible_trees)
3940
 
                self.target.add_inventory_by_delta(
3941
 
                    basis_id, delta, current_revision_id, parents_parents)
3942
 
        # insert signatures and revisions
3943
 
        for revision in pending_revisions:
3944
 
            try:
3945
 
                signature = self.source.get_signature_text(
3946
 
                    revision.revision_id)
3947
 
                self.target.add_signature_text(revision.revision_id,
3948
 
                    signature)
3949
 
            except errors.NoSuchRevision:
3950
 
                pass
3951
 
            self.target.add_revision(revision.revision_id, revision)
3952
 
        return basis_id
3953
 
 
3954
 
    def _fetch_all_revisions(self, revision_ids, pb):
3955
 
        """Fetch everything for the list of revisions.
3956
 
 
3957
 
        :param revision_ids: The list of revisions to fetch. Must be in
3958
 
            topological order.
3959
 
        :param pb: A ProgressTask
3960
 
        :return: None
3961
 
        """
3962
 
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3963
 
        batch_size = 100
3964
 
        cache = lru_cache.LRUCache(100)
3965
 
        cache[basis_id] = basis_tree
3966
 
        del basis_tree # We don't want to hang on to it here
3967
 
        hints = []
3968
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3969
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3970
 
                                                            revision_ids)
3971
 
        else:
3972
 
            a_graph = None
3973
 
 
3974
 
        for offset in range(0, len(revision_ids), batch_size):
3975
 
            self.target.start_write_group()
3976
 
            try:
3977
 
                pb.update('Transferring revisions', offset,
3978
 
                          len(revision_ids))
3979
 
                batch = revision_ids[offset:offset+batch_size]
3980
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3981
 
                                             a_graph=a_graph)
3982
 
            except:
3983
 
                self.source._safe_to_return_from_cache = False
3984
 
                self.target.abort_write_group()
3985
 
                raise
3986
 
            else:
3987
 
                hint = self.target.commit_write_group()
3988
 
                if hint:
3989
 
                    hints.extend(hint)
3990
 
        if hints and self.target._format.pack_compresses:
3991
 
            self.target.pack(hint=hints)
3992
 
        pb.update('Transferring revisions', len(revision_ids),
3993
 
                  len(revision_ids))
3994
 
 
3995
3049
    @needs_write_lock
3996
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3997
 
            fetch_spec=None):
 
3050
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3998
3051
        """See InterRepository.fetch()."""
3999
 
        if fetch_spec is not None:
4000
 
            raise AssertionError("Not implemented yet...")
4001
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4002
 
        #
4003
 
        # nb this is only active for local-local fetches; other things using
4004
 
        # streaming.
4005
 
        ui.ui_factory.warn_cross_format_fetch(self.source._format,
4006
 
            self.target._format)
4007
 
        if (not self.source.supports_rich_root()
4008
 
            and self.target.supports_rich_root()):
4009
 
            self._converting_to_rich_root = True
4010
 
            self._revision_id_to_root_id = {}
4011
 
        else:
4012
 
            self._converting_to_rich_root = False
4013
3052
        revision_ids = self.target.search_missing_revision_ids(self.source,
4014
3053
            revision_id, find_ghosts=find_ghosts).get_keys()
4015
 
        if not revision_ids:
4016
 
            return 0, 0
4017
3054
        revision_ids = tsort.topo_sort(
4018
3055
            self.source.get_graph().get_parent_map(revision_ids))
4019
 
        if not revision_ids:
4020
 
            return 0, 0
4021
 
        # Walk though all revisions; get inventory deltas, copy referenced
4022
 
        # texts that delta references, insert the delta, revision and
4023
 
        # signature.
 
3056
        def revisions_iterator():
 
3057
            for current_revision_id in revision_ids:
 
3058
                revision = self.source.get_revision(current_revision_id)
 
3059
                tree = self.source.revision_tree(current_revision_id)
 
3060
                try:
 
3061
                    signature = self.source.get_signature_text(
 
3062
                        current_revision_id)
 
3063
                except errors.NoSuchRevision:
 
3064
                    signature = None
 
3065
                yield revision, tree, signature
4024
3066
        if pb is None:
4025
3067
            my_pb = ui.ui_factory.nested_progress_bar()
4026
3068
            pb = my_pb
4027
3069
        else:
4028
 
            symbol_versioning.warn(
4029
 
                symbol_versioning.deprecated_in((1, 14, 0))
4030
 
                % "pb parameter to fetch()")
4031
3070
            my_pb = None
4032
3071
        try:
4033
 
            self._fetch_all_revisions(revision_ids, pb)
 
3072
            install_revisions(self.target, revisions_iterator(),
 
3073
                              len(revision_ids), pb)
4034
3074
        finally:
4035
3075
            if my_pb is not None:
4036
3076
                my_pb.finished()
4037
3077
        return len(revision_ids), 0
4038
3078
 
4039
 
    def _get_basis(self, first_revision_id):
4040
 
        """Get a revision and tree which exists in the target.
4041
 
 
4042
 
        This assumes that first_revision_id is selected for transmission
4043
 
        because all other ancestors are already present. If we can't find an
4044
 
        ancestor we fall back to NULL_REVISION since we know that is safe.
4045
 
 
4046
 
        :return: (basis_id, basis_tree)
4047
 
        """
4048
 
        first_rev = self.source.get_revision(first_revision_id)
4049
 
        try:
4050
 
            basis_id = first_rev.parent_ids[0]
4051
 
            # only valid as a basis if the target has it
4052
 
            self.target.get_revision(basis_id)
4053
 
            # Try to get a basis tree - if its a ghost it will hit the
4054
 
            # NoSuchRevision case.
4055
 
            basis_tree = self.source.revision_tree(basis_id)
4056
 
        except (IndexError, errors.NoSuchRevision):
4057
 
            basis_id = _mod_revision.NULL_REVISION
4058
 
            basis_tree = self.source.revision_tree(basis_id)
4059
 
        return basis_id, basis_tree
 
3079
 
 
3080
class InterOtherToRemote(InterRepository):
 
3081
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3082
    calculated for (source, target._real_repository).
 
3083
    """
 
3084
 
 
3085
    _walk_to_common_revisions_batch_size = 50
 
3086
 
 
3087
    def __init__(self, source, target):
 
3088
        InterRepository.__init__(self, source, target)
 
3089
        self._real_inter = None
 
3090
 
 
3091
    @staticmethod
 
3092
    def is_compatible(source, target):
 
3093
        if isinstance(target, remote.RemoteRepository):
 
3094
            return True
 
3095
        return False
 
3096
 
 
3097
    def _ensure_real_inter(self):
 
3098
        if self._real_inter is None:
 
3099
            self.target._ensure_real()
 
3100
            real_target = self.target._real_repository
 
3101
            self._real_inter = InterRepository.get(self.source, real_target)
 
3102
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3103
            self._real_inter.target_get_graph = self.target.get_graph
 
3104
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3105
    
 
3106
    def copy_content(self, revision_id=None):
 
3107
        self._ensure_real_inter()
 
3108
        self._real_inter.copy_content(revision_id=revision_id)
 
3109
 
 
3110
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3111
        self._ensure_real_inter()
 
3112
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3113
            find_ghosts=find_ghosts)
 
3114
 
 
3115
    @classmethod
 
3116
    def _get_repo_format_to_test(self):
 
3117
        return None
 
3118
 
 
3119
 
 
3120
class InterRemoteToOther(InterRepository):
 
3121
 
 
3122
    def __init__(self, source, target):
 
3123
        InterRepository.__init__(self, source, target)
 
3124
        self._real_inter = None
 
3125
 
 
3126
    @staticmethod
 
3127
    def is_compatible(source, target):
 
3128
        if not isinstance(source, remote.RemoteRepository):
 
3129
            return False
 
3130
        # Is source's model compatible with target's model?
 
3131
        source._ensure_real()
 
3132
        real_source = source._real_repository
 
3133
        if isinstance(real_source, remote.RemoteRepository):
 
3134
            raise NotImplementedError(
 
3135
                "We don't support remote repos backed by remote repos yet.")
 
3136
        return InterRepository._same_model(real_source, target)
 
3137
 
 
3138
    def _ensure_real_inter(self):
 
3139
        if self._real_inter is None:
 
3140
            self.source._ensure_real()
 
3141
            real_source = self.source._real_repository
 
3142
            self._real_inter = InterRepository.get(real_source, self.target)
 
3143
    
 
3144
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3145
        self._ensure_real_inter()
 
3146
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3147
            find_ghosts=find_ghosts)
 
3148
 
 
3149
    def copy_content(self, revision_id=None):
 
3150
        self._ensure_real_inter()
 
3151
        self._real_inter.copy_content(revision_id=revision_id)
 
3152
 
 
3153
    @classmethod
 
3154
    def _get_repo_format_to_test(self):
 
3155
        return None
 
3156
 
 
3157
 
 
3158
 
 
3159
class InterPackToRemotePack(InterPackRepo):
 
3160
    """A specialisation of InterPackRepo for a target that is a
 
3161
    RemoteRepository.
 
3162
 
 
3163
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3164
    uses an RPC for autopacking.
 
3165
    """
 
3166
 
 
3167
    _walk_to_common_revisions_batch_size = 50
 
3168
 
 
3169
    @staticmethod
 
3170
    def is_compatible(source, target):
 
3171
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3172
        if isinstance(source._format, RepositoryFormatPack):
 
3173
            if isinstance(target, remote.RemoteRepository):
 
3174
                target._ensure_real()
 
3175
                if isinstance(target._real_repository._format,
 
3176
                              RepositoryFormatPack):
 
3177
                    if InterRepository._same_model(source, target):
 
3178
                        return True
 
3179
        return False
 
3180
    
 
3181
    def _autopack(self):
 
3182
        self.target.autopack()
 
3183
        
 
3184
    def _get_target_pack_collection(self):
 
3185
        return self.target._real_repository._pack_collection
 
3186
 
 
3187
    @classmethod
 
3188
    def _get_repo_format_to_test(self):
 
3189
        return None
4060
3190
 
4061
3191
 
4062
3192
InterRepository.register_optimiser(InterDifferingSerializer)
4063
3193
InterRepository.register_optimiser(InterSameDataRepository)
4064
3194
InterRepository.register_optimiser(InterWeaveRepo)
4065
3195
InterRepository.register_optimiser(InterKnitRepo)
 
3196
InterRepository.register_optimiser(InterModel1and2)
 
3197
InterRepository.register_optimiser(InterKnit1and2)
 
3198
InterRepository.register_optimiser(InterPackRepo)
 
3199
InterRepository.register_optimiser(InterOtherToRemote)
 
3200
InterRepository.register_optimiser(InterRemoteToOther)
 
3201
InterRepository.register_optimiser(InterPackToRemotePack)
4066
3202
 
4067
3203
 
4068
3204
class CopyConverter(object):
4069
3205
    """A repository conversion tool which just performs a copy of the content.
4070
 
 
 
3206
    
4071
3207
    This is slow but quite reliable.
4072
3208
    """
4073
3209
 
4077
3213
        :param target_format: The format the resulting repository should be.
4078
3214
        """
4079
3215
        self.target_format = target_format
4080
 
 
 
3216
        
4081
3217
    def convert(self, repo, pb):
4082
3218
        """Perform the conversion of to_convert, giving feedback via pb.
4083
3219
 
4084
3220
        :param to_convert: The disk object to convert.
4085
3221
        :param pb: a progress bar to use for progress information.
4086
3222
        """
4087
 
        pb = ui.ui_factory.nested_progress_bar()
 
3223
        self.pb = pb
4088
3224
        self.count = 0
4089
3225
        self.total = 4
4090
3226
        # this is only useful with metadir layouts - separated repo content.
4091
3227
        # trigger an assertion if not such
4092
3228
        repo._format.get_format_string()
4093
3229
        self.repo_dir = repo.bzrdir
4094
 
        pb.update('Moving repository to repository.backup')
 
3230
        self.step('Moving repository to repository.backup')
4095
3231
        self.repo_dir.transport.move('repository', 'repository.backup')
4096
3232
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4097
3233
        repo._format.check_conversion_target(self.target_format)
4098
3234
        self.source_repo = repo._format.open(self.repo_dir,
4099
3235
            _found=True,
4100
3236
            _override_transport=backup_transport)
4101
 
        pb.update('Creating new repository')
 
3237
        self.step('Creating new repository')
4102
3238
        converted = self.target_format.initialize(self.repo_dir,
4103
3239
                                                  self.source_repo.is_shared())
4104
3240
        converted.lock_write()
4105
3241
        try:
4106
 
            pb.update('Copying content')
 
3242
            self.step('Copying content into repository.')
4107
3243
            self.source_repo.copy_content_into(converted)
4108
3244
        finally:
4109
3245
            converted.unlock()
4110
 
        pb.update('Deleting old repository content')
 
3246
        self.step('Deleting old repository content.')
4111
3247
        self.repo_dir.transport.delete_tree('repository.backup')
4112
 
        ui.ui_factory.note('repository converted')
4113
 
        pb.finished()
 
3248
        self.pb.note('repository converted')
 
3249
 
 
3250
    def step(self, message):
 
3251
        """Update the pb by a step."""
 
3252
        self.count +=1
 
3253
        self.pb.update(message, self.count, self.total)
4114
3254
 
4115
3255
 
4116
3256
_unescape_map = {
4145
3285
 
4146
3286
class _VersionedFileChecker(object):
4147
3287
 
4148
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3288
    def __init__(self, repository):
4149
3289
        self.repository = repository
4150
 
        self.text_index = self.repository._generate_text_key_index(
4151
 
            text_key_references=text_key_references, ancestors=ancestors)
4152
 
 
 
3290
        self.text_index = self.repository._generate_text_key_index()
 
3291
    
4153
3292
    def calculate_file_version_parents(self, text_key):
4154
3293
        """Calculate the correct parents for a file version according to
4155
3294
        the inventories.
4172
3311
            revision_id) tuples for versions that are present in this versioned
4173
3312
            file, but not used by the corresponding inventory.
4174
3313
        """
4175
 
        local_progress = None
4176
 
        if progress_bar is None:
4177
 
            local_progress = ui.ui_factory.nested_progress_bar()
4178
 
            progress_bar = local_progress
4179
 
        try:
4180
 
            return self._check_file_version_parents(texts, progress_bar)
4181
 
        finally:
4182
 
            if local_progress:
4183
 
                local_progress.finished()
4184
 
 
4185
 
    def _check_file_version_parents(self, texts, progress_bar):
4186
 
        """See check_file_version_parents."""
4187
3314
        wrong_parents = {}
4188
3315
        self.file_ids = set([file_id for file_id, _ in
4189
3316
            self.text_index.iterkeys()])
4190
3317
        # text keys is now grouped by file_id
 
3318
        n_weaves = len(self.file_ids)
 
3319
        files_in_revisions = {}
 
3320
        revisions_of_files = {}
4191
3321
        n_versions = len(self.text_index)
4192
3322
        progress_bar.update('loading text store', 0, n_versions)
4193
3323
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4195
3325
        text_keys = self.repository.texts.keys()
4196
3326
        unused_keys = frozenset(text_keys) - set(self.text_index)
4197
3327
        for num, key in enumerate(self.text_index.iterkeys()):
4198
 
            progress_bar.update('checking text graph', num, n_versions)
 
3328
            if progress_bar is not None:
 
3329
                progress_bar.update('checking text graph', num, n_versions)
4199
3330
            correct_parents = self.calculate_file_version_parents(key)
4200
3331
            try:
4201
3332
                knit_parents = parent_map[key]
4224
3355
        revision_graph[key] = tuple(parent for parent in parents if parent
4225
3356
            in revision_graph)
4226
3357
    return revision_graph
4227
 
 
4228
 
 
4229
 
class StreamSink(object):
4230
 
    """An object that can insert a stream into a repository.
4231
 
 
4232
 
    This interface handles the complexity of reserialising inventories and
4233
 
    revisions from different formats, and allows unidirectional insertion into
4234
 
    stacked repositories without looking for the missing basis parents
4235
 
    beforehand.
4236
 
    """
4237
 
 
4238
 
    def __init__(self, target_repo):
4239
 
        self.target_repo = target_repo
4240
 
 
4241
 
    def insert_stream(self, stream, src_format, resume_tokens):
4242
 
        """Insert a stream's content into the target repository.
4243
 
 
4244
 
        :param src_format: a bzr repository format.
4245
 
 
4246
 
        :return: a list of resume tokens and an  iterable of keys additional
4247
 
            items required before the insertion can be completed.
4248
 
        """
4249
 
        self.target_repo.lock_write()
4250
 
        try:
4251
 
            if resume_tokens:
4252
 
                self.target_repo.resume_write_group(resume_tokens)
4253
 
                is_resume = True
4254
 
            else:
4255
 
                self.target_repo.start_write_group()
4256
 
                is_resume = False
4257
 
            try:
4258
 
                # locked_insert_stream performs a commit|suspend.
4259
 
                return self._locked_insert_stream(stream, src_format, is_resume)
4260
 
            except:
4261
 
                self.target_repo.abort_write_group(suppress_errors=True)
4262
 
                raise
4263
 
        finally:
4264
 
            self.target_repo.unlock()
4265
 
 
4266
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
4267
 
        to_serializer = self.target_repo._format._serializer
4268
 
        src_serializer = src_format._serializer
4269
 
        new_pack = None
4270
 
        if to_serializer == src_serializer:
4271
 
            # If serializers match and the target is a pack repository, set the
4272
 
            # write cache size on the new pack.  This avoids poor performance
4273
 
            # on transports where append is unbuffered (such as
4274
 
            # RemoteTransport).  This is safe to do because nothing should read
4275
 
            # back from the target repository while a stream with matching
4276
 
            # serialization is being inserted.
4277
 
            # The exception is that a delta record from the source that should
4278
 
            # be a fulltext may need to be expanded by the target (see
4279
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4280
 
            # explicitly flush any buffered writes first in that rare case.
4281
 
            try:
4282
 
                new_pack = self.target_repo._pack_collection._new_pack
4283
 
            except AttributeError:
4284
 
                # Not a pack repository
4285
 
                pass
4286
 
            else:
4287
 
                new_pack.set_write_cache_size(1024*1024)
4288
 
        for substream_type, substream in stream:
4289
 
            if 'stream' in debug.debug_flags:
4290
 
                mutter('inserting substream: %s', substream_type)
4291
 
            if substream_type == 'texts':
4292
 
                self.target_repo.texts.insert_record_stream(substream)
4293
 
            elif substream_type == 'inventories':
4294
 
                if src_serializer == to_serializer:
4295
 
                    self.target_repo.inventories.insert_record_stream(
4296
 
                        substream)
4297
 
                else:
4298
 
                    self._extract_and_insert_inventories(
4299
 
                        substream, src_serializer)
4300
 
            elif substream_type == 'inventory-deltas':
4301
 
                ui.ui_factory.warn_cross_format_fetch(src_format,
4302
 
                    self.target_repo._format)
4303
 
                self._extract_and_insert_inventory_deltas(
4304
 
                    substream, src_serializer)
4305
 
            elif substream_type == 'chk_bytes':
4306
 
                # XXX: This doesn't support conversions, as it assumes the
4307
 
                #      conversion was done in the fetch code.
4308
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4309
 
            elif substream_type == 'revisions':
4310
 
                # This may fallback to extract-and-insert more often than
4311
 
                # required if the serializers are different only in terms of
4312
 
                # the inventory.
4313
 
                if src_serializer == to_serializer:
4314
 
                    self.target_repo.revisions.insert_record_stream(
4315
 
                        substream)
4316
 
                else:
4317
 
                    self._extract_and_insert_revisions(substream,
4318
 
                        src_serializer)
4319
 
            elif substream_type == 'signatures':
4320
 
                self.target_repo.signatures.insert_record_stream(substream)
4321
 
            else:
4322
 
                raise AssertionError('kaboom! %s' % (substream_type,))
4323
 
        # Done inserting data, and the missing_keys calculations will try to
4324
 
        # read back from the inserted data, so flush the writes to the new pack
4325
 
        # (if this is pack format).
4326
 
        if new_pack is not None:
4327
 
            new_pack._write_data('', flush=True)
4328
 
        # Find all the new revisions (including ones from resume_tokens)
4329
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4330
 
            check_for_missing_texts=is_resume)
4331
 
        try:
4332
 
            for prefix, versioned_file in (
4333
 
                ('texts', self.target_repo.texts),
4334
 
                ('inventories', self.target_repo.inventories),
4335
 
                ('revisions', self.target_repo.revisions),
4336
 
                ('signatures', self.target_repo.signatures),
4337
 
                ('chk_bytes', self.target_repo.chk_bytes),
4338
 
                ):
4339
 
                if versioned_file is None:
4340
 
                    continue
4341
 
                # TODO: key is often going to be a StaticTuple object
4342
 
                #       I don't believe we can define a method by which
4343
 
                #       (prefix,) + StaticTuple will work, though we could
4344
 
                #       define a StaticTuple.sq_concat that would allow you to
4345
 
                #       pass in either a tuple or a StaticTuple as the second
4346
 
                #       object, so instead we could have:
4347
 
                #       StaticTuple(prefix) + key here...
4348
 
                missing_keys.update((prefix,) + key for key in
4349
 
                    versioned_file.get_missing_compression_parent_keys())
4350
 
        except NotImplementedError:
4351
 
            # cannot even attempt suspending, and missing would have failed
4352
 
            # during stream insertion.
4353
 
            missing_keys = set()
4354
 
        else:
4355
 
            if missing_keys:
4356
 
                # suspend the write group and tell the caller what we is
4357
 
                # missing. We know we can suspend or else we would not have
4358
 
                # entered this code path. (All repositories that can handle
4359
 
                # missing keys can handle suspending a write group).
4360
 
                write_group_tokens = self.target_repo.suspend_write_group()
4361
 
                return write_group_tokens, missing_keys
4362
 
        hint = self.target_repo.commit_write_group()
4363
 
        if (to_serializer != src_serializer and
4364
 
            self.target_repo._format.pack_compresses):
4365
 
            self.target_repo.pack(hint=hint)
4366
 
        return [], set()
4367
 
 
4368
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4369
 
        target_rich_root = self.target_repo._format.rich_root_data
4370
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4371
 
        for record in substream:
4372
 
            # Insert the delta directly
4373
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4374
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4375
 
            try:
4376
 
                parse_result = deserialiser.parse_text_bytes(
4377
 
                    inventory_delta_bytes)
4378
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4379
 
                trace.mutter("Incompatible delta: %s", err.msg)
4380
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4381
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4382
 
            revision_id = new_id
4383
 
            parents = [key[0] for key in record.parents]
4384
 
            self.target_repo.add_inventory_by_delta(
4385
 
                basis_id, inv_delta, revision_id, parents)
4386
 
 
4387
 
    def _extract_and_insert_inventories(self, substream, serializer,
4388
 
            parse_delta=None):
4389
 
        """Generate a new inventory versionedfile in target, converting data.
4390
 
 
4391
 
        The inventory is retrieved from the source, (deserializing it), and
4392
 
        stored in the target (reserializing it in a different format).
4393
 
        """
4394
 
        target_rich_root = self.target_repo._format.rich_root_data
4395
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4396
 
        for record in substream:
4397
 
            # It's not a delta, so it must be a fulltext in the source
4398
 
            # serializer's format.
4399
 
            bytes = record.get_bytes_as('fulltext')
4400
 
            revision_id = record.key[0]
4401
 
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4402
 
            parents = [key[0] for key in record.parents]
4403
 
            self.target_repo.add_inventory(revision_id, inv, parents)
4404
 
            # No need to keep holding this full inv in memory when the rest of
4405
 
            # the substream is likely to be all deltas.
4406
 
            del inv
4407
 
 
4408
 
    def _extract_and_insert_revisions(self, substream, serializer):
4409
 
        for record in substream:
4410
 
            bytes = record.get_bytes_as('fulltext')
4411
 
            revision_id = record.key[0]
4412
 
            rev = serializer.read_revision_from_string(bytes)
4413
 
            if rev.revision_id != revision_id:
4414
 
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4415
 
            self.target_repo.add_revision(revision_id, rev)
4416
 
 
4417
 
    def finished(self):
4418
 
        if self.target_repo._format._fetch_reconcile:
4419
 
            self.target_repo.reconcile()
4420
 
 
4421
 
 
4422
 
class StreamSource(object):
4423
 
    """A source of a stream for fetching between repositories."""
4424
 
 
4425
 
    def __init__(self, from_repository, to_format):
4426
 
        """Create a StreamSource streaming from from_repository."""
4427
 
        self.from_repository = from_repository
4428
 
        self.to_format = to_format
4429
 
 
4430
 
    def delta_on_metadata(self):
4431
 
        """Return True if delta's are permitted on metadata streams.
4432
 
 
4433
 
        That is on revisions and signatures.
4434
 
        """
4435
 
        src_serializer = self.from_repository._format._serializer
4436
 
        target_serializer = self.to_format._serializer
4437
 
        return (self.to_format._fetch_uses_deltas and
4438
 
            src_serializer == target_serializer)
4439
 
 
4440
 
    def _fetch_revision_texts(self, revs):
4441
 
        # fetch signatures first and then the revision texts
4442
 
        # may need to be a InterRevisionStore call here.
4443
 
        from_sf = self.from_repository.signatures
4444
 
        # A missing signature is just skipped.
4445
 
        keys = [(rev_id,) for rev_id in revs]
4446
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4447
 
            keys,
4448
 
            self.to_format._fetch_order,
4449
 
            not self.to_format._fetch_uses_deltas))
4450
 
        # If a revision has a delta, this is actually expanded inside the
4451
 
        # insert_record_stream code now, which is an alternate fix for
4452
 
        # bug #261339
4453
 
        from_rf = self.from_repository.revisions
4454
 
        revisions = from_rf.get_record_stream(
4455
 
            keys,
4456
 
            self.to_format._fetch_order,
4457
 
            not self.delta_on_metadata())
4458
 
        return [('signatures', signatures), ('revisions', revisions)]
4459
 
 
4460
 
    def _generate_root_texts(self, revs):
4461
 
        """This will be called by get_stream between fetching weave texts and
4462
 
        fetching the inventory weave.
4463
 
        """
4464
 
        if self._rich_root_upgrade():
4465
 
            return _mod_fetch.Inter1and2Helper(
4466
 
                self.from_repository).generate_root_texts(revs)
4467
 
        else:
4468
 
            return []
4469
 
 
4470
 
    def get_stream(self, search):
4471
 
        phase = 'file'
4472
 
        revs = search.get_keys()
4473
 
        graph = self.from_repository.get_graph()
4474
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4475
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4476
 
        text_keys = []
4477
 
        for knit_kind, file_id, revisions in data_to_fetch:
4478
 
            if knit_kind != phase:
4479
 
                phase = knit_kind
4480
 
                # Make a new progress bar for this phase
4481
 
            if knit_kind == "file":
4482
 
                # Accumulate file texts
4483
 
                text_keys.extend([(file_id, revision) for revision in
4484
 
                    revisions])
4485
 
            elif knit_kind == "inventory":
4486
 
                # Now copy the file texts.
4487
 
                from_texts = self.from_repository.texts
4488
 
                yield ('texts', from_texts.get_record_stream(
4489
 
                    text_keys, self.to_format._fetch_order,
4490
 
                    not self.to_format._fetch_uses_deltas))
4491
 
                # Cause an error if a text occurs after we have done the
4492
 
                # copy.
4493
 
                text_keys = None
4494
 
                # Before we process the inventory we generate the root
4495
 
                # texts (if necessary) so that the inventories references
4496
 
                # will be valid.
4497
 
                for _ in self._generate_root_texts(revs):
4498
 
                    yield _
4499
 
                # we fetch only the referenced inventories because we do not
4500
 
                # know for unselected inventories whether all their required
4501
 
                # texts are present in the other repository - it could be
4502
 
                # corrupt.
4503
 
                for info in self._get_inventory_stream(revs):
4504
 
                    yield info
4505
 
            elif knit_kind == "signatures":
4506
 
                # Nothing to do here; this will be taken care of when
4507
 
                # _fetch_revision_texts happens.
4508
 
                pass
4509
 
            elif knit_kind == "revisions":
4510
 
                for record in self._fetch_revision_texts(revs):
4511
 
                    yield record
4512
 
            else:
4513
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4514
 
 
4515
 
    def get_stream_for_missing_keys(self, missing_keys):
4516
 
        # missing keys can only occur when we are byte copying and not
4517
 
        # translating (because translation means we don't send
4518
 
        # unreconstructable deltas ever).
4519
 
        keys = {}
4520
 
        keys['texts'] = set()
4521
 
        keys['revisions'] = set()
4522
 
        keys['inventories'] = set()
4523
 
        keys['chk_bytes'] = set()
4524
 
        keys['signatures'] = set()
4525
 
        for key in missing_keys:
4526
 
            keys[key[0]].add(key[1:])
4527
 
        if len(keys['revisions']):
4528
 
            # If we allowed copying revisions at this point, we could end up
4529
 
            # copying a revision without copying its required texts: a
4530
 
            # violation of the requirements for repository integrity.
4531
 
            raise AssertionError(
4532
 
                'cannot copy revisions to fill in missing deltas %s' % (
4533
 
                    keys['revisions'],))
4534
 
        for substream_kind, keys in keys.iteritems():
4535
 
            vf = getattr(self.from_repository, substream_kind)
4536
 
            if vf is None and keys:
4537
 
                    raise AssertionError(
4538
 
                        "cannot fill in keys for a versioned file we don't"
4539
 
                        " have: %s needs %s" % (substream_kind, keys))
4540
 
            if not keys:
4541
 
                # No need to stream something we don't have
4542
 
                continue
4543
 
            if substream_kind == 'inventories':
4544
 
                # Some missing keys are genuinely ghosts, filter those out.
4545
 
                present = self.from_repository.inventories.get_parent_map(keys)
4546
 
                revs = [key[0] for key in present]
4547
 
                # Get the inventory stream more-or-less as we do for the
4548
 
                # original stream; there's no reason to assume that records
4549
 
                # direct from the source will be suitable for the sink.  (Think
4550
 
                # e.g. 2a -> 1.9-rich-root).
4551
 
                for info in self._get_inventory_stream(revs, missing=True):
4552
 
                    yield info
4553
 
                continue
4554
 
 
4555
 
            # Ask for full texts always so that we don't need more round trips
4556
 
            # after this stream.
4557
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4558
 
            # records. The Sink is responsible for doing another check to
4559
 
            # ensure that ghosts don't introduce missing data for future
4560
 
            # fetches.
4561
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4562
 
                self.to_format._fetch_order, True))
4563
 
            yield substream_kind, stream
4564
 
 
4565
 
    def inventory_fetch_order(self):
4566
 
        if self._rich_root_upgrade():
4567
 
            return 'topological'
4568
 
        else:
4569
 
            return self.to_format._fetch_order
4570
 
 
4571
 
    def _rich_root_upgrade(self):
4572
 
        return (not self.from_repository._format.rich_root_data and
4573
 
            self.to_format.rich_root_data)
4574
 
 
4575
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4576
 
        from_format = self.from_repository._format
4577
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4578
 
            from_format.network_name() == self.to_format.network_name()):
4579
 
            raise AssertionError(
4580
 
                "this case should be handled by GroupCHKStreamSource")
4581
 
        elif 'forceinvdeltas' in debug.debug_flags:
4582
 
            return self._get_convertable_inventory_stream(revision_ids,
4583
 
                    delta_versus_null=missing)
4584
 
        elif from_format.network_name() == self.to_format.network_name():
4585
 
            # Same format.
4586
 
            return self._get_simple_inventory_stream(revision_ids,
4587
 
                    missing=missing)
4588
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4589
 
                and from_format._serializer == self.to_format._serializer):
4590
 
            # Essentially the same format.
4591
 
            return self._get_simple_inventory_stream(revision_ids,
4592
 
                    missing=missing)
4593
 
        else:
4594
 
            # Any time we switch serializations, we want to use an
4595
 
            # inventory-delta based approach.
4596
 
            return self._get_convertable_inventory_stream(revision_ids,
4597
 
                    delta_versus_null=missing)
4598
 
 
4599
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4600
 
        # NB: This currently reopens the inventory weave in source;
4601
 
        # using a single stream interface instead would avoid this.
4602
 
        from_weave = self.from_repository.inventories
4603
 
        if missing:
4604
 
            delta_closure = True
4605
 
        else:
4606
 
            delta_closure = not self.delta_on_metadata()
4607
 
        yield ('inventories', from_weave.get_record_stream(
4608
 
            [(rev_id,) for rev_id in revision_ids],
4609
 
            self.inventory_fetch_order(), delta_closure))
4610
 
 
4611
 
    def _get_convertable_inventory_stream(self, revision_ids,
4612
 
                                          delta_versus_null=False):
4613
 
        # The two formats are sufficiently different that there is no fast
4614
 
        # path, so we need to send just inventorydeltas, which any
4615
 
        # sufficiently modern client can insert into any repository.
4616
 
        # The StreamSink code expects to be able to
4617
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4618
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4619
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4620
 
        yield ('inventory-deltas',
4621
 
           self._stream_invs_as_deltas(revision_ids,
4622
 
                                       delta_versus_null=delta_versus_null))
4623
 
 
4624
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4625
 
        """Return a stream of inventory-deltas for the given rev ids.
4626
 
 
4627
 
        :param revision_ids: The list of inventories to transmit
4628
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4629
 
            entry, instead compute the delta versus the NULL_REVISION. This
4630
 
            effectively streams a complete inventory. Used for stuff like
4631
 
            filling in missing parents, etc.
4632
 
        """
4633
 
        from_repo = self.from_repository
4634
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4635
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4636
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4637
 
        # method...
4638
 
        inventories = self.from_repository.iter_inventories(
4639
 
            revision_ids, 'topological')
4640
 
        format = from_repo._format
4641
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4642
 
        inventory_cache = lru_cache.LRUCache(50)
4643
 
        null_inventory = from_repo.revision_tree(
4644
 
            _mod_revision.NULL_REVISION).inventory
4645
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4646
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4647
 
        # repo back into a non-rich-root repo ought to be allowed)
4648
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4649
 
            versioned_root=format.rich_root_data,
4650
 
            tree_references=format.supports_tree_reference)
4651
 
        for inv in inventories:
4652
 
            key = (inv.revision_id,)
4653
 
            parent_keys = parent_map.get(key, ())
4654
 
            delta = None
4655
 
            if not delta_versus_null and parent_keys:
4656
 
                # The caller did not ask for complete inventories and we have
4657
 
                # some parents that we can delta against.  Make a delta against
4658
 
                # each parent so that we can find the smallest.
4659
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4660
 
                for parent_id in parent_ids:
4661
 
                    if parent_id not in invs_sent_so_far:
4662
 
                        # We don't know that the remote side has this basis, so
4663
 
                        # we can't use it.
4664
 
                        continue
4665
 
                    if parent_id == _mod_revision.NULL_REVISION:
4666
 
                        parent_inv = null_inventory
4667
 
                    else:
4668
 
                        parent_inv = inventory_cache.get(parent_id, None)
4669
 
                        if parent_inv is None:
4670
 
                            parent_inv = from_repo.get_inventory(parent_id)
4671
 
                    candidate_delta = inv._make_delta(parent_inv)
4672
 
                    if (delta is None or
4673
 
                        len(delta) > len(candidate_delta)):
4674
 
                        delta = candidate_delta
4675
 
                        basis_id = parent_id
4676
 
            if delta is None:
4677
 
                # Either none of the parents ended up being suitable, or we
4678
 
                # were asked to delta against NULL
4679
 
                basis_id = _mod_revision.NULL_REVISION
4680
 
                delta = inv._make_delta(null_inventory)
4681
 
            invs_sent_so_far.add(inv.revision_id)
4682
 
            inventory_cache[inv.revision_id] = inv
4683
 
            delta_serialized = ''.join(
4684
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4685
 
            yield versionedfile.FulltextContentFactory(
4686
 
                key, parent_keys, None, delta_serialized)
4687
 
 
4688
 
 
4689
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4690
 
                    stop_revision=None):
4691
 
    """Extend the partial history to include a given index
4692
 
 
4693
 
    If a stop_index is supplied, stop when that index has been reached.
4694
 
    If a stop_revision is supplied, stop when that revision is
4695
 
    encountered.  Otherwise, stop when the beginning of history is
4696
 
    reached.
4697
 
 
4698
 
    :param stop_index: The index which should be present.  When it is
4699
 
        present, history extension will stop.
4700
 
    :param stop_revision: The revision id which should be present.  When
4701
 
        it is encountered, history extension will stop.
4702
 
    """
4703
 
    start_revision = partial_history_cache[-1]
4704
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4705
 
    try:
4706
 
        #skip the last revision in the list
4707
 
        iterator.next()
4708
 
        while True:
4709
 
            if (stop_index is not None and
4710
 
                len(partial_history_cache) > stop_index):
4711
 
                break
4712
 
            if partial_history_cache[-1] == stop_revision:
4713
 
                break
4714
 
            revision_id = iterator.next()
4715
 
            partial_history_cache.append(revision_id)
4716
 
    except StopIteration:
4717
 
        # No more history
4718
 
        return
4719