/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-02 18:51:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3680.
  • Revision ID: john@arbash-meinel.com-20080902185103-camvrjyw7a9efpno
Change from using AssertionError to using DirstateCorrupt in a few places

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