/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

Update to bzr.dev.

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