~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin Pool
  • Date: 2008-05-02 07:31:24 UTC
  • mto: (3408.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3410.
  • Revision ID: mbp@sourcefrog.net-20080502073124-nxmeqrzkji6u2m76
Remove code deprecated prior to 1.1 and its tests

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,
 
28
    deprecated_graph,
29
29
    errors,
30
 
    fetch as _mod_fetch,
31
 
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
33
    lazy_regex,
38
34
    lockable_files,
39
35
    lockdir,
40
36
    lru_cache,
41
37
    osutils,
 
38
    registry,
 
39
    remote,
42
40
    revision as _mod_revision,
43
 
    static_tuple,
44
41
    symbol_versioning,
45
 
    trace,
 
42
    transactions,
46
43
    tsort,
47
44
    ui,
48
 
    versionedfile,
49
45
    )
50
46
from bzrlib.bundle import serializer
51
47
from bzrlib.revisiontree import RevisionTree
52
48
from bzrlib.store.versioned import VersionedFileStore
 
49
from bzrlib.store.text import TextStore
53
50
from bzrlib.testament import Testament
 
51
from bzrlib.util import bencode
54
52
""")
55
53
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
54
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
55
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)
 
56
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
57
from bzrlib.symbol_versioning import (
 
58
        deprecated_method,
 
59
        )
 
60
from bzrlib.trace import mutter, mutter_callsite, note, warning
68
61
 
69
62
 
70
63
# Old formats display a warning, but only once
74
67
class CommitBuilder(object):
75
68
    """Provides an interface to build up a commit.
76
69
 
77
 
    This allows describing a tree to be committed without needing to
 
70
    This allows describing a tree to be committed without needing to 
78
71
    know the internals of the format of the repository.
79
72
    """
80
 
 
 
73
    
81
74
    # all clients should supply tree roots.
82
75
    record_root_entry = True
83
76
    # the default CommitBuilder does not manage trees whose root is versioned.
102
95
        if committer is None:
103
96
            self._committer = self._config.username()
104
97
        else:
 
98
            assert isinstance(committer, basestring), type(committer)
105
99
            self._committer = committer
106
100
 
107
101
        self.new_inventory = Inventory(None)
111
105
 
112
106
        self._revprops = {}
113
107
        if revprops is not None:
114
 
            self._validate_revprops(revprops)
115
108
            self._revprops.update(revprops)
116
109
 
117
110
        if timestamp is None:
126
119
 
127
120
        self._generate_revision_if_needed()
128
121
        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
122
 
163
123
    def commit(self, message):
164
124
        """Make the actual commit.
165
125
 
166
126
        :return: The revision id of the recorded revision.
167
127
        """
168
 
        self._validate_unicode_text(message, 'commit message')
169
128
        rev = _mod_revision.Revision(
170
129
                       timestamp=self._timestamp,
171
130
                       timezone=self._timezone,
194
153
        deserializing the inventory, while we already have a copy in
195
154
        memory.
196
155
        """
197
 
        if self.new_inventory is None:
198
 
            self.new_inventory = self.repository.get_inventory(
199
 
                self._new_revision_id)
200
156
        return RevisionTree(self.repository, self.new_inventory,
201
 
            self._new_revision_id)
 
157
                            self._new_revision_id)
202
158
 
203
159
    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
 
160
        """Tell the builder that the inventory is finished."""
 
161
        if self.new_inventory.root is None:
 
162
            raise AssertionError('Root entry should be supplied to'
 
163
                ' record_entry_contents, as of bzr 0.10.',
 
164
                 DeprecationWarning, stacklevel=2)
 
165
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
166
        self.new_inventory.revision_id = self._new_revision_id
 
167
        self.inv_sha1 = self.repository.add_inventory(
 
168
            self._new_revision_id,
 
169
            self.new_inventory,
 
170
            self.parents
 
171
            )
231
172
 
232
173
    def _gen_revision_id(self):
233
174
        """Return new revision-id."""
236
177
 
237
178
    def _generate_revision_if_needed(self):
238
179
        """Create a revision id if None was supplied.
239
 
 
 
180
        
240
181
        If the repository can not support user-specified revision ids
241
182
        they should override this function and raise CannotSetRevisionId
242
183
        if _new_revision_id is not None.
270
211
        # _new_revision_id
271
212
        ie.revision = self._new_revision_id
272
213
 
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
214
    def _get_delta(self, ie, basis_inv, path):
289
215
        """Get a delta against the basis inventory for ie."""
290
216
        if ie.file_id not in basis_inv:
291
217
            # add
292
 
            result = (None, path, ie.file_id, ie)
293
 
            self._basis_delta.append(result)
294
 
            return result
 
218
            return (None, path, ie.file_id, ie)
295
219
        elif ie != basis_inv[ie.file_id]:
296
220
            # common but altered
297
221
            # 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
 
222
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
301
223
        else:
302
224
            # common, unaltered
303
225
            return None
304
226
 
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
227
    def record_entry_contents(self, ie, parent_invs, path, tree,
353
228
        content_summary):
354
229
        """Record the content of ie from tree into the commit if needed.
359
234
        :param parent_invs: The inventories of the parent revisions of the
360
235
            commit.
361
236
        :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
 
237
        :param tree: The tree which contains this entry and should be used to 
363
238
            obtain content.
364
239
        :param content_summary: Summary data from the tree about the paths
365
240
            content - stat, length, exec, sha/link target. This is only
366
241
            accessed when the entry has a revision of None - that is when it is
367
242
            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.
 
243
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
244
            an inventory_delta change for this entry against the basis tree of
 
245
            the commit, or None if no change occured against the basis tree.
372
246
            version_recorded is True if a new version of the entry has been
373
247
            recorded. For instance, committing a merge where a file was only
374
248
            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
249
        """
379
250
        if self.new_inventory.root is None:
380
251
            if ie.parent_id is not None:
406
277
        if ie.revision is not None:
407
278
            if not self._versioned_root and path == '':
408
279
                # 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.
 
280
                # revision to the new commit even when no change occurs, and
 
281
                # this masks when a change may have occurred against the basis,
 
282
                # so calculate if one happened.
415
283
                if ie.file_id in basis_inv:
416
284
                    delta = (basis_inv.id2path(ie.file_id), path,
417
285
                        ie.file_id, ie)
418
286
                else:
419
287
                    # add
420
288
                    delta = (None, path, ie.file_id, ie)
421
 
                self._basis_delta.append(delta)
422
 
                return delta, False, None
 
289
                return delta, False
423
290
            else:
424
291
                # we don't need to commit this, because the caller already
425
292
                # 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
 
293
                # appropriate.
 
294
                return None, (ie.revision == self._new_revision_id)
434
295
        # XXX: Friction: parent_candidates should return a list not a dict
435
296
        #      so that we don't have to walk the inventories again.
436
297
        parent_candiate_entries = ie.parent_candidates(parent_invs)
466
327
            # if the kind changed the content obviously has
467
328
            if kind != parent_entry.kind:
468
329
                store = True
469
 
        # Stat cache fingerprint feedback for the caller - None as we usually
470
 
        # don't generate one.
471
 
        fingerprint = None
472
330
        if kind == 'file':
473
 
            if content_summary[2] is None:
474
 
                raise ValueError("Files must not have executable = None")
 
331
            assert content_summary[2] is not None, \
 
332
                "Files must not have executable = None"
475
333
            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:
 
334
                if (# if the file length changed we have to store:
 
335
                    parent_entry.text_size != content_summary[1] or
 
336
                    # if the exec bit has changed we have to store:
479
337
                    parent_entry.executable != content_summary[2]):
480
338
                    store = True
481
339
                elif parent_entry.text_sha1 == content_summary[3]:
485
343
                    ie.text_size = parent_entry.text_size
486
344
                    ie.text_sha1 = parent_entry.text_sha1
487
345
                    ie.executable = parent_entry.executable
488
 
                    return self._get_delta(ie, basis_inv, path), False, None
 
346
                    return self._get_delta(ie, basis_inv, path), False
489
347
                else:
490
348
                    # Either there is only a hash change(no hash cache entry,
491
349
                    # or same size content change), or there is no change on
498
356
                # absence of a content change in the file.
499
357
                nostore_sha = None
500
358
            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()
 
359
            lines = tree.get_file(ie.file_id, path).readlines()
506
360
            try:
507
361
                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)
 
362
                    ie.file_id, lines, heads, nostore_sha)
511
363
            except errors.ExistingContent:
512
364
                # Turns out that the file content was unchanged, and we were
513
365
                # only going to store a new node if it was changed. Carry over
516
368
                ie.text_size = parent_entry.text_size
517
369
                ie.text_sha1 = parent_entry.text_sha1
518
370
                ie.executable = parent_entry.executable
519
 
                return self._get_delta(ie, basis_inv, path), False, None
 
371
                return self._get_delta(ie, basis_inv, path), False
520
372
        elif kind == 'directory':
521
373
            if not store:
522
374
                # all data is meta here, nothing specific to directory, so
523
375
                # carry over:
524
376
                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)
 
377
                return self._get_delta(ie, basis_inv, path), False
 
378
            lines = []
 
379
            self._add_text_to_weave(ie.file_id, lines, heads, None)
527
380
        elif kind == 'symlink':
528
381
            current_link_target = content_summary[3]
529
382
            if not store:
535
388
                # unchanged, carry over.
536
389
                ie.revision = parent_entry.revision
537
390
                ie.symlink_target = parent_entry.symlink_target
538
 
                return self._get_delta(ie, basis_inv, path), False, None
 
391
                return self._get_delta(ie, basis_inv, path), False
539
392
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
393
            lines = []
 
394
            self._add_text_to_weave(ie.file_id, lines, heads, None)
541
395
        elif kind == 'tree-reference':
542
396
            if not store:
543
397
                if content_summary[3] != parent_entry.reference_revision:
546
400
                # unchanged, carry over.
547
401
                ie.reference_revision = parent_entry.reference_revision
548
402
                ie.revision = parent_entry.revision
549
 
                return self._get_delta(ie, basis_inv, path), False, None
 
403
                return self._get_delta(ie, basis_inv, path), False
550
404
            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)
 
405
            lines = []
 
406
            self._add_text_to_weave(ie.file_id, lines, heads, None)
555
407
        else:
556
408
            raise NotImplementedError('unknown kind')
557
409
        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]
 
410
        return self._get_delta(ie, basis_inv, path), True
 
411
 
 
412
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
413
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
414
            file_id, self.repository.get_transaction())
 
415
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
416
        # than add_lines, and allows committing when a parent is ghosted for
 
417
        # some reason.
 
418
        # Note: as we read the content directly from the tree, we know its not
 
419
        # been turned into unicode or badly split - but a broken tree
 
420
        # implementation could give us bad output from readlines() so this is
 
421
        # not a guarantee of safety. What would be better is always checking
 
422
        # the content during test suite execution. RBC 20070912
 
423
        return versionedfile.add_lines_with_ghosts(
 
424
            self._new_revision_id, parents, new_lines,
 
425
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
426
            check_content=False)[0:2]
835
427
 
836
428
 
837
429
class RootCommitBuilder(CommitBuilder):
838
430
    """This commitbuilder actually records the root id"""
839
 
 
 
431
    
840
432
    # the root entry gets versioned properly by this builder.
841
433
    _versioned_root = True
842
434
 
849
441
        :param tree: The tree that is being committed.
850
442
        """
851
443
 
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
444
 
863
445
######################################################################
864
446
# Repositories
865
447
 
866
 
 
867
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
448
class Repository(object):
868
449
    """Repository holding history for one or more branches.
869
450
 
870
451
    The repository holds and retrieves historical information including
871
452
    revisions and file history.  It's normally accessed only by the Branch,
872
453
    which views a particular line of development through that history.
873
454
 
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
 
455
    The Repository builds on top of Stores and a Transport, which respectively 
 
456
    describe the disk data format and the way of accessing the (possibly 
877
457
    remote) disk.
878
 
 
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
 
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
889
 
        the serialised revisions for the repository. This can be used to obtain
890
 
        revision graph information or to access raw serialised revisions.
891
 
        The result of trying to insert data into the repository via this store
892
 
        is undefined: it should be considered read-only except for implementors
893
 
        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
 
    :ivar _transport: Transport for file access to repository, typically
917
 
        pointing to .bzr/repository.
918
458
    """
919
459
 
920
460
    # What class to use for a CommitBuilder. Often its simpler to change this
928
468
        r'.* revision="(?P<revision_id>[^"]+)"'
929
469
        )
930
470
 
931
 
    def abort_write_group(self, suppress_errors=False):
 
471
    def abort_write_group(self):
932
472
        """Commit the contents accrued within the current write group.
933
473
 
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
474
        :seealso: start_write_group.
939
475
        """
940
476
        if self._write_group is not self.get_transaction():
941
477
            # 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)
 
478
            raise errors.BzrError('mismatched lock context and write group.')
 
479
        self._abort_write_group()
959
480
        self._write_group = None
960
481
 
961
482
    def _abort_write_group(self):
962
483
        """Template method for per-repository write group cleanup.
963
 
 
964
 
        This is called during abort before the write group is considered to be
 
484
        
 
485
        This is called during abort before the write group is considered to be 
965
486
        finished and should cleanup any internal state accrued during the write
966
487
        group. There is no requirement that data handed to the repository be
967
488
        *not* made available - this is not a rollback - but neither should any
971
492
        attempted.
972
493
        """
973
494
 
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
495
    def add_inventory(self, revision_id, inv, parents):
1004
496
        """Add the inventory inv to the repository as revision_id.
1005
 
 
 
497
        
1006
498
        :param parents: The revision ids of the parents that revision_id
1007
499
                        is known to have and are in the repository already.
1008
500
 
1009
501
        :returns: The validator(which is a sha1 digest, though what is sha'd is
1010
502
            repository format specific) of the serialized inventory.
1011
503
        """
1012
 
        if not self.is_in_write_group():
1013
 
            raise AssertionError("%r not in write group" % (self,))
 
504
        assert self.is_in_write_group()
1014
505
        _mod_revision.check_not_reserved_id(revision_id)
1015
 
        if not (inv.revision_id is None or inv.revision_id == revision_id):
1016
 
            raise AssertionError(
1017
 
                "Mismatch between inventory revision"
1018
 
                " id and insertion revid (%r, %r)"
1019
 
                % (inv.revision_id, revision_id))
1020
 
        if inv.root is None:
1021
 
            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)
1032
 
        return self._inventory_add_lines(revision_id, parents,
 
506
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
507
            "Mismatch between inventory revision" \
 
508
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
509
        assert inv.root is not None
 
510
        inv_lines = self._serialise_inventory_to_lines(inv)
 
511
        inv_vf = self.get_inventory_weave()
 
512
        return self._inventory_add_lines(inv_vf, revision_id, parents,
1033
513
            inv_lines, check_content=False)
1034
514
 
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
 
    def _inventory_add_lines(self, revision_id, parents, lines,
 
515
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
1083
516
        check_content=True):
1084
517
        """Store lines in inv_vf and return the sha1 of the inventory."""
1085
 
        parents = [(parent,) for parent in parents]
1086
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
518
        final_parents = []
 
519
        for parent in parents:
 
520
            if parent in inv_vf:
 
521
                final_parents.append(parent)
 
522
        return inv_vf.add_lines(revision_id, final_parents, lines,
1087
523
            check_content=check_content)[0]
1088
 
        self.inventories._access.flush()
1089
 
        return result
1090
524
 
1091
525
    def add_revision(self, revision_id, rev, inv=None, config=None):
1092
526
        """Add rev to the revision store as revision_id.
1108
542
            plaintext = Testament(rev, inv).as_short_text()
1109
543
            self.store_revision_signature(
1110
544
                gpg.GPGStrategy(config), plaintext, revision_id)
1111
 
        # check inventory present
1112
 
        if not self.inventories.get_parent_map([(revision_id,)]):
 
545
        inventory_vf = self.get_inventory_weave()
 
546
        if not revision_id in inventory_vf:
1113
547
            if inv is None:
1114
548
                raise errors.WeaveRevisionNotPresent(revision_id,
1115
 
                                                     self.inventories)
 
549
                                                     inventory_vf)
1116
550
            else:
1117
551
                # yes, this is not suitable for adding with ghosts.
1118
552
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1119
553
                                                        rev.parent_ids)
1120
554
        else:
1121
 
            key = (revision_id,)
1122
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1123
 
        self._add_revision(rev)
 
555
            rev.inventory_sha1 = inventory_vf.get_sha1s([revision_id])[0]
 
556
        self._revision_store.add_revision(rev, self.get_transaction())
1124
557
 
1125
 
    def _add_revision(self, revision):
1126
 
        text = self._serializer.write_revision_to_string(revision)
1127
 
        key = (revision.revision_id,)
1128
 
        parents = tuple((parent,) for parent in revision.parent_ids)
1129
 
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
 
558
    def _add_revision_text(self, revision_id, text):
 
559
        revision = self._revision_store._serializer.read_revision_from_string(
 
560
            text)
 
561
        self._revision_store._add_revision(revision, StringIO(text),
 
562
                                           self.get_transaction())
1130
563
 
1131
564
    def all_revision_ids(self):
1132
 
        """Returns a list of all the revision ids in the repository.
 
565
        """Returns a list of all the revision ids in the repository. 
1133
566
 
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.
 
567
        This is deprecated because code should generally work on the graph
 
568
        reachable from a particular revision, and ignore any other revisions
 
569
        that might be present.  There is no direct replacement method.
1138
570
        """
1139
571
        if 'evil' in debug.debug_flags:
1140
572
            mutter_callsite(2, "all_revision_ids is linear with history.")
1141
573
        return self._all_revision_ids()
1142
574
 
1143
575
    def _all_revision_ids(self):
1144
 
        """Returns a list of all the revision ids in the repository.
 
576
        """Returns a list of all the revision ids in the repository. 
1145
577
 
1146
 
        These are in as much topological order as the underlying store can
 
578
        These are in as much topological order as the underlying store can 
1147
579
        present.
1148
580
        """
1149
581
        raise NotImplementedError(self._all_revision_ids)
1168
600
        # The old API returned a list, should this actually be a set?
1169
601
        return parent_map.keys()
1170
602
 
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
603
    @staticmethod
1285
604
    def create(a_bzrdir):
1286
605
        """Construct the current default format repository in a_bzrdir."""
1287
606
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
1288
607
 
1289
 
    def __init__(self, _format, a_bzrdir, control_files):
 
608
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
1290
609
        """instantiate a Repository.
1291
610
 
1292
611
        :param _format: The format of the repository on disk.
1293
612
        :param a_bzrdir: The BzrDir of the repository.
 
613
 
 
614
        In the future we will have a single api for all stores for
 
615
        getting file texts, inventories and revisions, then
 
616
        this construct will accept instances of those things.
1294
617
        """
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
618
        super(Repository, self).__init__()
1299
619
        self._format = _format
1300
620
        # the following are part of the public API for Repository:
1301
621
        self.bzrdir = a_bzrdir
1302
622
        self.control_files = control_files
1303
 
        self._transport = control_files._transport
1304
 
        self.base = self._transport.base
 
623
        self._revision_store = _revision_store
 
624
        # backwards compatibility
 
625
        self.weave_store = text_store
1305
626
        # for tests
1306
627
        self._reconcile_does_inventory_gc = True
1307
628
        self._reconcile_fixes_text_parents = False
1308
629
        self._reconcile_backsup_inventory = True
 
630
        # not right yet - should be more semantically clear ? 
 
631
        # 
 
632
        self.control_store = control_store
 
633
        self.control_weaves = control_store
 
634
        # TODO: make sure to construct the right store classes, etc, depending
 
635
        # on whether escaping is required.
 
636
        self._warn_if_deprecated()
1309
637
        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
 
638
        self.base = control_files._transport.base
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
1353
650
        """
1354
651
        if self.__class__ is not other.__class__:
1355
652
            return False
1356
 
        return (self._transport.base == other._transport.base)
 
653
        return (self.control_files._transport.base ==
 
654
                other.control_files._transport.base)
1357
655
 
1358
656
    def is_in_write_group(self):
1359
657
        """Return True if there is an open write group.
1375
673
        This causes caching within the repository obejct to start accumlating
1376
674
        data during reads, and allows a 'write_group' to be obtained. Write
1377
675
        groups must be used for actual data insertion.
1378
 
 
 
676
        
1379
677
        :param token: if this is already locked, then lock_write will fail
1380
678
            unless the token matches the existing lock.
1381
679
        :returns: a token if this instance supports tokens, otherwise None.
1391
689
 
1392
690
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1393
691
        """
1394
 
        locked = self.is_locked()
1395
692
        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()
 
693
        self._refresh_data()
1403
694
        return result
1404
695
 
1405
696
    def lock_read(self):
1406
 
        locked = self.is_locked()
1407
697
        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()
 
698
        self._refresh_data()
1414
699
 
1415
700
    def get_physical_lock_status(self):
1416
701
        return self.control_files.get_physical_lock_status()
1418
703
    def leave_lock_in_place(self):
1419
704
        """Tell this repository not to release the physical lock when this
1420
705
        object is unlocked.
1421
 
 
 
706
        
1422
707
        If lock_write doesn't return a token, then this method is not supported.
1423
708
        """
1424
709
        self.control_files.leave_in_place()
1475
760
                last_revision.timezone)
1476
761
 
1477
762
        # now gather global repository information
1478
 
        # XXX: This is available for many repos regardless of listability.
1479
 
        if self.user_transport.listable():
1480
 
            # 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
 
            result['revisions'] = len(self.revisions.keys())
1484
 
            # result['size'] = t
 
763
        if self.bzrdir.root_transport.listable():
 
764
            c, t = self._revision_store.total_size(self.get_transaction())
 
765
            result['revisions'] = c
 
766
            result['size'] = t
1485
767
        return result
1486
768
 
1487
769
    def find_branches(self, using=False):
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
 
811
 
 
812
    def get_data_stream(self, revision_ids):
 
813
        raise NotImplementedError(self.get_data_stream)
 
814
 
 
815
    def get_data_stream_for_search(self, search_result):
 
816
        """Get a data stream that can be inserted to a repository.
 
817
 
 
818
        :param search_result: A bzrlib.graph.SearchResult selecting the
 
819
            revisions to get.
 
820
        :return: A data stream that can be inserted into a repository using
 
821
            insert_data_stream.
 
822
        """
 
823
        raise NotImplementedError(self.get_data_stream_for_search)
 
824
 
 
825
    def insert_data_stream(self, stream):
 
826
        """XXX What does this really do? 
 
827
        
 
828
        Is it a substitute for fetch? 
 
829
        Should it manage its own write group ?
 
830
        """
 
831
        for item_key, bytes in stream:
 
832
            if item_key[0] == 'file':
 
833
                (file_id,) = item_key[1:]
 
834
                knit = self.weave_store.get_weave_or_empty(
 
835
                    file_id, self.get_transaction())
 
836
            elif item_key == ('inventory',):
 
837
                knit = self.get_inventory_weave()
 
838
            elif item_key == ('revisions',):
 
839
                knit = self._revision_store.get_revision_file(
 
840
                    self.get_transaction())
 
841
            elif item_key == ('signatures',):
 
842
                knit = self._revision_store.get_signature_file(
 
843
                    self.get_transaction())
 
844
            else:
 
845
                raise errors.RepositoryDataStreamError(
 
846
                    "Unrecognised data stream key '%s'" % (item_key,))
 
847
            decoded_list = bencode.bdecode(bytes)
 
848
            format = decoded_list.pop(0)
 
849
            data_list = []
 
850
            knit_bytes = ''
 
851
            for version, options, parents, some_bytes in decoded_list:
 
852
                data_list.append((version, options, len(some_bytes), parents))
 
853
                knit_bytes += some_bytes
 
854
            buffer = StringIO(knit_bytes)
 
855
            def reader_func(count):
 
856
                if count is None:
 
857
                    return buffer.read()
 
858
                else:
 
859
                    return buffer.read(count)
 
860
            knit.insert_data_stream(
 
861
                (format, data_list, reader_func))
1523
862
 
1524
863
    @needs_read_lock
1525
864
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1526
865
        """Return the revision ids that other has that this does not.
1527
 
 
 
866
        
1528
867
        These are returned in topological order.
1529
868
 
1530
869
        revision_id: only return revision ids included by revision_id.
1532
871
        return InterRepository.get(other, self).search_missing_revision_ids(
1533
872
            revision_id, find_ghosts)
1534
873
 
 
874
    @deprecated_method(symbol_versioning.one_two)
 
875
    @needs_read_lock
 
876
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
877
        """Return the revision ids that other has that this does not.
 
878
        
 
879
        These are returned in topological order.
 
880
 
 
881
        revision_id: only return revision ids included by revision_id.
 
882
        """
 
883
        keys =  self.search_missing_revision_ids(
 
884
            other, revision_id, find_ghosts).get_keys()
 
885
        other.lock_read()
 
886
        try:
 
887
            parents = other.get_graph().get_parent_map(keys)
 
888
        finally:
 
889
            other.unlock()
 
890
        return tsort.topo_sort(parents)
 
891
 
1535
892
    @staticmethod
1536
893
    def open(base):
1537
894
        """Open the repository rooted at base.
1544
901
 
1545
902
    def copy_content_into(self, destination, revision_id=None):
1546
903
        """Make a complete copy of the content in self into destination.
1547
 
 
1548
 
        This is a destructive operation! Do not use it on existing
 
904
        
 
905
        This is a destructive operation! Do not use it on existing 
1549
906
        repositories.
1550
907
        """
1551
908
        return InterRepository.get(self, destination).copy_content(revision_id)
1554
911
        """Commit the contents accrued within the current write group.
1555
912
 
1556
913
        :seealso: start_write_group.
1557
 
        
1558
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1559
914
        """
1560
915
        if self._write_group is not self.get_transaction():
1561
916
            # has an unlock or relock occured ?
1562
917
            raise errors.BzrError('mismatched lock context %r and '
1563
918
                'write group %r.' %
1564
919
                (self.get_transaction(), self._write_group))
1565
 
        result = self._commit_write_group()
 
920
        self._commit_write_group()
1566
921
        self._write_group = None
1567
 
        return result
1568
922
 
1569
923
    def _commit_write_group(self):
1570
924
        """Template method for per-repository write group cleanup.
1571
 
 
1572
 
        This is called before the write group is considered to be
 
925
        
 
926
        This is called before the write group is considered to be 
1573
927
        finished and should ensure that all data handed to the repository
1574
 
        for writing during the write group is safely committed (to the
 
928
        for writing during the write group is safely committed (to the 
1575
929
        extent possible considering file system caching etc).
1576
930
        """
1577
931
 
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):
 
932
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1663
933
        """Fetch the content required to construct revision_id from source.
1664
934
 
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
 
 
 
935
        If revision_id is None all content is copied.
1672
936
        :param find_ghosts: Find and copy revisions in the source that are
1673
937
            ghosts in the target (and not reachable directly by walking out to
1674
938
            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
939
        """
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
940
        # 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)):
 
941
        if self.has_same_location(source):
1695
942
            # check that last_revision is in 'from' and then return a
1696
943
            # no-operation.
1697
944
            if (revision_id is not None and
1698
945
                not _mod_revision.is_null(revision_id)):
1699
946
                self.get_revision(revision_id)
1700
947
            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
948
        inter = InterRepository.get(source, self)
1705
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1706
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
949
        try:
 
950
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
951
        except NotImplementedError:
 
952
            raise errors.IncompatibleRepositories(source, self)
1707
953
 
1708
954
    def create_bundle(self, target, base, fileobj, format=None):
1709
955
        return serializer.write_bundle(self, target, base, fileobj, format)
1712
958
                           timezone=None, committer=None, revprops=None,
1713
959
                           revision_id=None):
1714
960
        """Obtain a CommitBuilder for this repository.
1715
 
 
 
961
        
1716
962
        :param branch: Branch to commit to.
1717
963
        :param parents: Revision ids of the parents of the new revision.
1718
964
        :param config: Configuration to use.
1722
968
        :param revprops: Optional dictionary of revision properties.
1723
969
        :param revision_id: Optional revision id.
1724
970
        """
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
971
        result = self._commit_builder_class(self, parents, config,
1730
972
            timestamp, timezone, committer, revprops, revision_id)
1731
973
        self.start_write_group()
1732
974
        return result
1733
975
 
1734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1735
976
    def unlock(self):
1736
977
        if (self.control_files._lock_count == 1 and
1737
978
            self.control_files._lock_mode == 'w'):
1741
982
                raise errors.BzrError(
1742
983
                    'Must end write groups before releasing write locks.')
1743
984
        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
985
 
1749
986
    @needs_read_lock
1750
987
    def clone(self, a_bzrdir, revision_id=None):
1785
1022
 
1786
1023
    def _start_write_group(self):
1787
1024
        """Template method for per-repository write group startup.
1788
 
 
1789
 
        This is called before the write group is considered to be
 
1025
        
 
1026
        This is called before the write group is considered to be 
1790
1027
        entered.
1791
1028
        """
1792
1029
 
1813
1050
                dest_repo = a_bzrdir.open_repository()
1814
1051
        return dest_repo
1815
1052
 
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
1053
    @needs_read_lock
1825
1054
    def has_revision(self, revision_id):
1826
1055
        """True if this repository has a copy of the revision."""
1827
1056
        return revision_id in self.has_revisions((revision_id,))
1828
1057
 
1829
 
    @needs_read_lock
1830
1058
    def has_revisions(self, revision_ids):
1831
1059
        """Probe to find out the presence of multiple revisions.
1832
1060
 
1833
1061
        :param revision_ids: An iterable of revision_ids.
1834
1062
        :return: A set of the revision_ids that were present.
1835
1063
        """
1836
 
        parent_map = self.revisions.get_parent_map(
1837
 
            [(rev_id,) for rev_id in revision_ids])
1838
 
        result = set()
1839
 
        if _mod_revision.NULL_REVISION in revision_ids:
1840
 
            result.add(_mod_revision.NULL_REVISION)
1841
 
        result.update([key[0] for key in parent_map])
1842
 
        return result
 
1064
        raise NotImplementedError(self.has_revisions)
 
1065
 
 
1066
        return self._revision_store.has_revision_id(revision_id,
 
1067
                                                    self.get_transaction())
1843
1068
 
1844
1069
    @needs_read_lock
1845
1070
    def get_revision(self, revision_id):
1849
1074
    @needs_read_lock
1850
1075
    def get_revision_reconcile(self, revision_id):
1851
1076
        """'reconcile' helper routine that allows access to a revision always.
1852
 
 
 
1077
        
1853
1078
        This variant of get_revision does not cross check the weave graph
1854
1079
        against the revision one as get_revision does: but it should only
1855
1080
        be used by reconcile, or reconcile-alike commands that are correcting
1859
1084
 
1860
1085
    @needs_read_lock
1861
1086
    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
 
        """
 
1087
        """Get many revisions at once."""
1867
1088
        return self._get_revisions(revision_ids)
1868
1089
 
1869
1090
    @needs_read_lock
1870
1091
    def _get_revisions(self, revision_ids):
1871
1092
        """Core work logic to get many revisions without sanity checks."""
1872
 
        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
1877
 
        return [revs[revid] for revid in revision_ids]
1878
 
 
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):
 
1093
        for rev_id in revision_ids:
 
1094
            if not rev_id or not isinstance(rev_id, basestring):
 
1095
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1096
        revs = self._revision_store.get_revisions(revision_ids,
 
1097
                                                  self.get_transaction())
 
1098
        for rev in revs:
 
1099
            assert not isinstance(rev.revision_id, unicode)
 
1100
            for parent_id in rev.parent_ids:
 
1101
                assert not isinstance(parent_id, unicode)
 
1102
        return revs
 
1103
 
 
1104
    @needs_read_lock
 
1105
    def get_revision_xml(self, revision_id):
 
1106
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1107
        #       would have already do it.
 
1108
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1109
        rev = self.get_revision(revision_id)
 
1110
        rev_tmp = StringIO()
 
1111
        # the current serializer..
 
1112
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1113
        rev_tmp.seek(0)
 
1114
        return rev_tmp.getvalue()
 
1115
 
 
1116
    def get_deltas_for_revisions(self, revisions):
1907
1117
        """Produce a generator of revision deltas.
1908
 
 
 
1118
        
1909
1119
        Note that the input is a sequence of REVISIONS, not revision_ids.
1910
1120
        Trees will be held in memory until the generator exits.
1911
1121
        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
1122
        """
1917
 
        # Get the revision-ids of interest
1918
1123
        required_trees = set()
1919
1124
        for revision in revisions:
1920
1125
            required_trees.add(revision.revision_id)
1921
1126
            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
 
1127
        trees = dict((t.get_revision_id(), t) for 
 
1128
                     t in self.revision_trees(required_trees))
1938
1129
        for revision in revisions:
1939
1130
            if not revision.parent_ids:
1940
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1131
                old_tree = self.revision_tree(None)
1941
1132
            else:
1942
1133
                old_tree = trees[revision.parent_ids[0]]
1943
1134
            yield trees[revision.revision_id].changes_from(old_tree)
1944
1135
 
1945
1136
    @needs_read_lock
1946
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1137
    def get_revision_delta(self, revision_id):
1947
1138
        """Return the delta for one revision.
1948
1139
 
1949
1140
        The delta is relative to the left-hand predecessor of the
1950
1141
        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
1142
        """
1956
1143
        r = self.get_revision(revision_id)
1957
 
        return list(self.get_deltas_for_revisions([r],
1958
 
            specific_fileids=specific_fileids))[0]
 
1144
        return list(self.get_deltas_for_revisions([r]))[0]
1959
1145
 
1960
1146
    @needs_write_lock
1961
1147
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1964
1150
 
1965
1151
    @needs_write_lock
1966
1152
    def add_signature_text(self, revision_id, signature):
1967
 
        self.signatures.add_lines((revision_id,), (),
1968
 
            osutils.split_lines(signature))
 
1153
        self._revision_store.add_revision_signature_text(revision_id,
 
1154
                                                         signature,
 
1155
                                                         self.get_transaction())
1969
1156
 
1970
1157
    def find_text_key_references(self):
1971
1158
        """Find the text key references within the repository.
1972
1159
 
 
1160
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1161
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1162
        altered it listed explicitly.
1973
1163
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1974
1164
            to whether they were referred to by the inventory of the
1975
1165
            revision_id that they contain. The inventory texts from all present
1976
1166
            revision ids are assessed to generate this report.
1977
1167
        """
1978
 
        revision_keys = self.revisions.keys()
1979
 
        w = self.inventories
 
1168
        revision_ids = self.all_revision_ids()
 
1169
        w = self.get_inventory_weave()
1980
1170
        pb = ui.ui_factory.nested_progress_bar()
1981
1171
        try:
1982
1172
            return self._find_text_key_references_from_xml_inventory_lines(
1983
 
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1173
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
1984
1174
        finally:
1985
1175
            pb.finished()
1986
1176
 
2006
1196
 
2007
1197
        # this code needs to read every new line in every inventory for the
2008
1198
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2009
 
        # not present in one of those inventories is unnecessary but not
 
1199
        # not present in one of those inventories is unnecessary but not 
2010
1200
        # 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
 
1201
        # inventory lines : we only select file ids altered in one of those  
2012
1202
        # revisions. We don't need to see all lines in the inventory because
2013
1203
        # only those added in an inventory in rev X can contain a revision=X
2014
1204
        # line.
2023
1213
        search = self._file_ids_altered_regex.search
2024
1214
        unescape = _unescape_xml
2025
1215
        setdefault = result.setdefault
2026
 
        for line, line_key in line_iterator:
 
1216
        for line, version_id in line_iterator:
2027
1217
            match = search(line)
2028
1218
            if match is None:
2029
1219
                continue
2060
1250
 
2061
1251
            key = (file_id, revision_id)
2062
1252
            setdefault(key, False)
2063
 
            if revision_id == line_key[-1]:
 
1253
            if revision_id == version_id:
2064
1254
                result[key] = True
2065
1255
        return result
2066
1256
 
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
1257
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2088
 
        revision_keys):
 
1258
        revision_ids):
2089
1259
        """Helper routine for fileids_altered_by_revision_ids.
2090
1260
 
2091
1261
        This performs the translation of xml lines to revision ids.
2092
1262
 
2093
1263
        :param line_iterator: An iterator of lines, origin_version_id
2094
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1264
        :param revision_ids: The revision ids to filter for. This should be a
2095
1265
            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.
 
1266
            the revision id from each parsed line will be looked up in the
 
1267
            revision_ids filter.
2098
1268
        :return: a dictionary mapping altered file-ids to an iterable of
2099
1269
        revision_ids. Each altered file-ids has the exact revision_ids that
2100
1270
        altered it listed explicitly.
2101
1271
        """
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
1272
        result = {}
2109
1273
        setdefault = result.setdefault
2110
 
        for key in new_keys:
2111
 
            setdefault(key[0], set()).add(key[-1])
 
1274
        for file_id, revision_id in \
 
1275
            self._find_text_key_references_from_xml_inventory_lines(
 
1276
                line_iterator).iterkeys():
 
1277
            # once data is all ensured-consistent; then this is
 
1278
            # if revision_id == version_id
 
1279
            if revision_id in revision_ids:
 
1280
                setdefault(file_id, set()).add(revision_id)
2112
1281
        return result
2113
1282
 
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
1283
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2142
1284
        """Find the file ids and versions affected by revisions.
2143
1285
 
2148
1290
        revision_ids. Each altered file-ids has the exact revision_ids that
2149
1291
        altered it listed explicitly.
2150
1292
        """
2151
 
        selected_keys = set((revid,) for revid in revision_ids)
2152
 
        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)
 
1293
        selected_revision_ids = set(revision_ids)
 
1294
        w = _inv_weave or self.get_inventory_weave()
 
1295
        pb = ui.ui_factory.nested_progress_bar()
 
1296
        try:
 
1297
            return self._find_file_ids_from_xml_inventory_lines(
 
1298
                w.iter_lines_added_or_present_in_versions(
 
1299
                    selected_revision_ids, pb=pb),
 
1300
                selected_revision_ids)
 
1301
        finally:
 
1302
            pb.finished()
2157
1303
 
2158
1304
    def iter_files_bytes(self, desired_files):
2159
1305
        """Iterate through file versions.
2168
1314
 
2169
1315
        bytes_iterator is an iterable of bytestrings for the file.  The
2170
1316
        kind of iterable and length of the bytestrings are unspecified, but for
2171
 
        this implementation, it is a list of bytes produced by
2172
 
        VersionedFile.get_record_stream().
 
1317
        this implementation, it is a list of lines produced by
 
1318
        VersionedFile.get_lines().
2173
1319
 
2174
1320
        :param desired_files: a list of (file_id, revision_id, identifier)
2175
1321
            triples
2176
1322
        """
2177
 
        text_keys = {}
 
1323
        transaction = self.get_transaction()
2178
1324
        for file_id, revision_id, callable_data in desired_files:
2179
 
            text_keys[(file_id, revision_id)] = callable_data
2180
 
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2181
 
            if record.storage_kind == 'absent':
2182
 
                raise errors.RevisionNotPresent(record.key, self)
2183
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1325
            try:
 
1326
                weave = self.weave_store.get_weave(file_id, transaction)
 
1327
            except errors.NoSuchFile:
 
1328
                raise errors.NoSuchIdInRepository(self, file_id)
 
1329
            yield callable_data, weave.get_lines(revision_id)
2184
1330
 
2185
1331
    def _generate_text_key_index(self, text_key_references=None,
2186
1332
        ancestors=None):
2235
1381
        batch_size = 10 # should be ~150MB on a 55K path tree
2236
1382
        batch_count = len(revision_order) / batch_size + 1
2237
1383
        processed_texts = 0
2238
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1384
        pb.update("Calculating text parents.", processed_texts, text_count)
2239
1385
        for offset in xrange(batch_count):
2240
1386
            to_query = revision_order[offset * batch_size:(offset + 1) *
2241
1387
                batch_size]
2242
1388
            if not to_query:
2243
1389
                break
2244
 
            for revision_id in to_query:
 
1390
            for rev_tree in self.revision_trees(to_query):
 
1391
                revision_id = rev_tree.get_revision_id()
2245
1392
                parent_ids = ancestors[revision_id]
2246
1393
                for text_key in revision_keys[revision_id]:
2247
 
                    pb.update("Calculating text parents", processed_texts)
 
1394
                    pb.update("Calculating text parents.", processed_texts)
2248
1395
                    processed_texts += 1
2249
1396
                    candidate_parents = []
2250
1397
                    for parent_id in parent_ids:
2266
1413
                            except KeyError:
2267
1414
                                inv = self.revision_tree(parent_id).inventory
2268
1415
                                inventory_cache[parent_id] = inv
2269
 
                            try:
2270
 
                                parent_entry = inv[text_key[0]]
2271
 
                            except (KeyError, errors.NoSuchId):
2272
 
                                parent_entry = None
 
1416
                            parent_entry = inv._byid.get(text_key[0], None)
2273
1417
                            if parent_entry is not None:
2274
1418
                                parent_text_key = (
2275
1419
                                    text_key[0], parent_entry.revision)
2300
1444
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2301
1445
            'revisions'.  file-id is None unless knit-kind is 'file'.
2302
1446
        """
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
1447
        # XXX: it's a bit weird to control the inventory weave caching in this
2311
1448
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2312
1449
        # maybe this generator should explicitly have the contract that it
2313
1450
        # should not be iterated until the previously yielded item has been
2314
1451
        # processed?
2315
 
        inv_w = self.inventories
 
1452
        inv_w = self.get_inventory_weave()
2316
1453
 
2317
1454
        # file ids that changed
2318
1455
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2319
1456
        count = 0
2320
1457
        num_file_ids = len(file_ids)
2321
1458
        for file_id, altered_versions in file_ids.iteritems():
2322
 
            if pb is not None:
2323
 
                pb.update("Fetch texts", count, num_file_ids)
 
1459
            if _files_pb is not None:
 
1460
                _files_pb.update("fetch texts", count, num_file_ids)
2324
1461
            count += 1
2325
1462
            yield ("file", file_id, altered_versions)
 
1463
        # We're done with the files_pb.  Note that it finished by the caller,
 
1464
        # just as it was created by the caller.
 
1465
        del _files_pb
2326
1466
 
2327
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2328
1467
        # inventory
2329
1468
        yield ("inventory", None, revision_ids)
2330
1469
 
2331
1470
        # 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)
 
1471
        revisions_with_signatures = set()
 
1472
        for rev_id in revision_ids:
 
1473
            try:
 
1474
                self.get_signature_text(rev_id)
 
1475
            except errors.NoSuchRevision:
 
1476
                # not signed.
 
1477
                pass
 
1478
            else:
 
1479
                revisions_with_signatures.add(rev_id)
2340
1480
        yield ("signatures", None, revisions_with_signatures)
2341
1481
 
2342
1482
        # revisions
2343
1483
        yield ("revisions", None, revision_ids)
2344
1484
 
2345
1485
    @needs_read_lock
 
1486
    def get_inventory_weave(self):
 
1487
        return self.control_weaves.get_weave('inventory',
 
1488
            self.get_transaction())
 
1489
 
 
1490
    @needs_read_lock
2346
1491
    def get_inventory(self, revision_id):
2347
1492
        """Get Inventory object by revision id."""
2348
1493
        return self.iter_inventories([revision_id]).next()
2349
1494
 
2350
 
    def iter_inventories(self, revision_ids, ordering=None):
 
1495
    def iter_inventories(self, revision_ids):
2351
1496
        """Get many inventories by revision_ids.
2352
1497
 
2353
1498
        This will buffer some or all of the texts used in constructing the
2354
1499
        inventories in memory, but will only parse a single inventory at a
2355
1500
        time.
2356
1501
 
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
1502
        :return: An iterator of inventories.
2362
1503
        """
2363
 
        if ((None in revision_ids)
2364
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
2365
 
            raise ValueError('cannot get null revision inventory')
2366
 
        return self._iter_inventories(revision_ids, ordering)
 
1504
        assert None not in revision_ids
 
1505
        assert _mod_revision.NULL_REVISION not in revision_ids
 
1506
        return self._iter_inventories(revision_ids)
2367
1507
 
2368
 
    def _iter_inventories(self, revision_ids, ordering):
 
1508
    def _iter_inventories(self, revision_ids):
2369
1509
        """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)
2373
 
 
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
2380
 
        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 = {}
2388
 
        for record in stream:
2389
 
            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]
2395
 
            else:
2396
 
                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
2409
 
 
2410
 
    def _deserialise_inventory(self, revision_id, xml):
2411
 
        """Transform the xml into an inventory object.
 
1510
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
1511
        for text, revision_id in zip(texts, revision_ids):
 
1512
            yield self.deserialise_inventory(revision_id, text)
 
1513
 
 
1514
    def deserialise_inventory(self, revision_id, xml):
 
1515
        """Transform the xml into an inventory object. 
2412
1516
 
2413
1517
        :param revision_id: The expected revision id of the inventory.
2414
1518
        :param xml: A serialised inventory.
2415
1519
        """
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)
 
1520
        result = self._serializer.read_inventory_from_string(xml, revision_id)
2419
1521
        if result.revision_id != revision_id:
2420
1522
            raise AssertionError('revision id mismatch %s != %s' % (
2421
1523
                result.revision_id, revision_id))
2422
1524
        return result
2423
1525
 
 
1526
    def serialise_inventory(self, inv):
 
1527
        return self._serializer.write_inventory_to_string(inv)
 
1528
 
 
1529
    def _serialise_inventory_to_lines(self, inv):
 
1530
        return self._serializer.write_inventory_to_lines(inv)
 
1531
 
2424
1532
    def get_serializer_format(self):
2425
1533
        return self._serializer.format_num
2426
1534
 
2427
1535
    @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')
 
1536
    def get_inventory_xml(self, revision_id):
 
1537
        """Get inventory XML as a file object."""
2431
1538
        try:
2432
 
            text, revision_id = texts.next()
2433
 
        except StopIteration:
 
1539
            assert isinstance(revision_id, str), type(revision_id)
 
1540
            iw = self.get_inventory_weave()
 
1541
            return iw.get_text(revision_id)
 
1542
        except IndexError:
2434
1543
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2435
 
        return text
2436
 
 
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)).
2444
 
        """
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])
 
1544
 
 
1545
    @needs_read_lock
 
1546
    def get_inventory_sha1(self, revision_id):
 
1547
        """Return the sha1 hash of the inventory entry
 
1548
        """
 
1549
        return self.get_revision(revision_id).inventory_sha1
 
1550
 
 
1551
    @needs_read_lock
 
1552
    @deprecated_method(symbol_versioning.one_four)
 
1553
    def get_revision_graph(self, revision_id=None):
 
1554
        """Return a dictionary containing the revision graph.
 
1555
 
 
1556
        NB: This method should not be used as it accesses the entire graph all
 
1557
        at once, which is much more data than most operations should require.
 
1558
 
 
1559
        :param revision_id: The revision_id to get a graph from. If None, then
 
1560
        the entire revision graph is returned. This is a deprecated mode of
 
1561
        operation and will be removed in the future.
 
1562
        :return: a dictionary of revision_id->revision_parents_list.
 
1563
        """
 
1564
        raise NotImplementedError(self.get_revision_graph)
 
1565
 
 
1566
    @needs_read_lock
 
1567
    @deprecated_method(symbol_versioning.one_three)
 
1568
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1569
        """Return a graph of the revisions with ghosts marked as applicable.
 
1570
 
 
1571
        :param revision_ids: an iterable of revisions to graph or None for all.
 
1572
        :return: a Graph object with the graph reachable from revision_ids.
 
1573
        """
 
1574
        if 'evil' in debug.debug_flags:
 
1575
            mutter_callsite(3,
 
1576
                "get_revision_graph_with_ghosts scales with size of history.")
 
1577
        result = deprecated_graph.Graph()
 
1578
        if not revision_ids:
 
1579
            pending = set(self.all_revision_ids())
 
1580
            required = set([])
 
1581
        else:
 
1582
            pending = set(revision_ids)
 
1583
            # special case NULL_REVISION
 
1584
            if _mod_revision.NULL_REVISION in pending:
 
1585
                pending.remove(_mod_revision.NULL_REVISION)
 
1586
            required = set(pending)
 
1587
        done = set([])
 
1588
        while len(pending):
 
1589
            revision_id = pending.pop()
 
1590
            try:
 
1591
                rev = self.get_revision(revision_id)
 
1592
            except errors.NoSuchRevision:
 
1593
                if revision_id in required:
 
1594
                    raise
 
1595
                # a ghost
 
1596
                result.add_ghost(revision_id)
 
1597
                continue
 
1598
            for parent_id in rev.parent_ids:
 
1599
                # is this queued or done ?
 
1600
                if (parent_id not in pending and
 
1601
                    parent_id not in done):
 
1602
                    # no, queue it.
 
1603
                    pending.add(parent_id)
 
1604
            result.add_node(revision_id, rev.parent_ids)
 
1605
            done.add(revision_id)
 
1606
        return result
2471
1607
 
2472
1608
    def iter_reverse_revision_history(self, revision_id):
2473
1609
        """Iterate backwards through revision ids in the lefthand history
2480
1616
        while True:
2481
1617
            if next_id in (None, _mod_revision.NULL_REVISION):
2482
1618
                return
2483
 
            try:
2484
 
                parents = graph.get_parent_map([next_id])[next_id]
2485
 
            except KeyError:
2486
 
                raise errors.RevisionNotPresent(next_id, self)
2487
1619
            yield next_id
 
1620
            # Note: The following line may raise KeyError in the event of
 
1621
            # truncated history. We decided not to have a try:except:raise
 
1622
            # RevisionNotPresent here until we see a use for it, because of the
 
1623
            # cost in an inner loop that is by its very nature O(history).
 
1624
            # Robert Collins 20080326
 
1625
            parents = graph.get_parent_map([next_id])[next_id]
2488
1626
            if len(parents) == 0:
2489
1627
                return
2490
1628
            else:
2491
1629
                next_id = parents[0]
2492
1630
 
 
1631
    @needs_read_lock
 
1632
    def get_revision_inventory(self, revision_id):
 
1633
        """Return inventory of a past revision."""
 
1634
        # TODO: Unify this with get_inventory()
 
1635
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1636
        # must be the same as its revision, so this is trivial.
 
1637
        if revision_id is None:
 
1638
            # This does not make sense: if there is no revision,
 
1639
            # then it is the current tree inventory surely ?!
 
1640
            # and thus get_root_id() is something that looks at the last
 
1641
            # commit on the branch, and the get_root_id is an inventory check.
 
1642
            raise NotImplementedError
 
1643
            # return Inventory(self.get_root_id())
 
1644
        else:
 
1645
            return self.get_inventory(revision_id)
 
1646
 
 
1647
    @needs_read_lock
2493
1648
    def is_shared(self):
2494
1649
        """Return True if this repository is flagged as a shared repository."""
2495
1650
        raise NotImplementedError(self.is_shared)
2509
1664
        for repositories to maintain loaded indices across multiple locks
2510
1665
        by checking inside their implementation of this method to see
2511
1666
        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.
 
1667
        the disk format being validatable in this manner.
2517
1668
        """
2518
1669
 
2519
1670
    @needs_read_lock
2520
1671
    def revision_tree(self, revision_id):
2521
1672
        """Return Tree for a revision on this branch.
2522
1673
 
2523
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1674
        `revision_id` may be None for the empty tree revision.
2524
1675
        """
2525
 
        revision_id = _mod_revision.ensure_null(revision_id)
2526
1676
        # TODO: refactor this to use an existing revision object
2527
1677
        # 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),
 
1678
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1679
            return RevisionTree(self, Inventory(root_id=None), 
2530
1680
                                _mod_revision.NULL_REVISION)
2531
1681
        else:
2532
 
            inv = self.get_inventory(revision_id)
 
1682
            inv = self.get_revision_inventory(revision_id)
2533
1683
            return RevisionTree(self, inv, revision_id)
2534
1684
 
2535
1685
    def revision_trees(self, revision_ids):
2536
 
        """Return Trees for revisions in this repository.
 
1686
        """Return Tree for a revision on this branch.
2537
1687
 
2538
 
        :param revision_ids: a sequence of revision-ids;
2539
 
          a revision-id may not be None or 'null:'
2540
 
        """
 
1688
        `revision_id` may not be None or 'null:'"""
2541
1689
        inventories = self.iter_inventories(revision_ids)
2542
1690
        for inv in inventories:
2543
1691
            yield RevisionTree(self, inv, inv.revision_id)
2544
1692
 
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
1693
    @needs_read_lock
2562
1694
    def get_ancestry(self, revision_id, topo_sorted=True):
2563
1695
        """Return a list of revision-ids integrated by a revision.
2564
1696
 
2565
 
        The first element of the list is always None, indicating the origin
2566
 
        revision.  This might change when we have history horizons, or
 
1697
        The first element of the list is always None, indicating the origin 
 
1698
        revision.  This might change when we have history horizons, or 
2567
1699
        perhaps we should have a new API.
2568
 
 
 
1700
        
2569
1701
        This is topologically sorted.
2570
1702
        """
2571
1703
        if _mod_revision.is_null(revision_id):
2572
1704
            return [None]
2573
1705
        if not self.has_revision(revision_id):
2574
1706
            raise errors.NoSuchRevision(self, revision_id)
2575
 
        graph = self.get_graph()
2576
 
        keys = set()
2577
 
        search = graph._make_breadth_first_searcher([revision_id])
2578
 
        while True:
2579
 
            try:
2580
 
                found, ghosts = search.next_with_ghosts()
2581
 
            except StopIteration:
2582
 
                break
2583
 
            keys.update(found)
2584
 
        if _mod_revision.NULL_REVISION in keys:
2585
 
            keys.remove(_mod_revision.NULL_REVISION)
2586
 
        if topo_sorted:
2587
 
            parent_map = graph.get_parent_map(keys)
2588
 
            keys = tsort.topo_sort(parent_map)
2589
 
        return [None] + list(keys)
 
1707
        w = self.get_inventory_weave()
 
1708
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
1709
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
2590
1710
 
2591
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1711
    def pack(self):
2592
1712
        """Compress the data within the repository.
2593
1713
 
2594
1714
        This operation only makes sense for some repository types. For other
2595
1715
        types it should be a no-op that just returns.
2596
1716
 
2597
1717
        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
 
1718
        @needs_write_lock as this is a long running call its reasonable to 
2599
1719
        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
 
        """
 
1720
        """
 
1721
 
 
1722
    @needs_read_lock
 
1723
    def print_file(self, file, revision_id):
 
1724
        """Print `file` to stdout.
 
1725
        
 
1726
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1727
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1728
        by creating a new more flexible convenience function.
 
1729
        """
 
1730
        tree = self.revision_tree(revision_id)
 
1731
        # use inventory as it was in that revision
 
1732
        file_id = tree.inventory.path2id(file)
 
1733
        if not file_id:
 
1734
            # TODO: jam 20060427 Write a test for this code path
 
1735
            #       it had a bug in it, and was raising the wrong
 
1736
            #       exception.
 
1737
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1738
        tree.print_file(file_id)
2611
1739
 
2612
1740
    def get_transaction(self):
2613
1741
        return self.control_files.get_transaction()
2614
1742
 
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:
 
1743
    def revision_parents(self, revision_id):
 
1744
        return self.get_inventory_weave().parent_names(revision_id)
 
1745
 
 
1746
    @deprecated_method(symbol_versioning.one_one)
 
1747
    def get_parents(self, revision_ids):
 
1748
        """See StackedParentsProvider.get_parents"""
 
1749
        parent_map = self.get_parent_map(revision_ids)
 
1750
        return [parent_map.get(r, None) for r in revision_ids]
 
1751
 
 
1752
    def get_parent_map(self, keys):
 
1753
        """See graph._StackedParentsProvider.get_parent_map"""
 
1754
        parent_map = {}
 
1755
        for revision_id in keys:
2622
1756
            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
 
1757
                parent_map[revision_id] = ()
 
1758
            else:
 
1759
                try:
 
1760
                    parent_id_list = self.get_revision(revision_id).parent_ids
 
1761
                except errors.NoSuchRevision:
 
1762
                    pass
 
1763
                else:
 
1764
                    if len(parent_id_list) == 0:
 
1765
                        parent_ids = (_mod_revision.NULL_REVISION,)
 
1766
                    else:
 
1767
                        parent_ids = tuple(parent_id_list)
 
1768
                    parent_map[revision_id] = parent_ids
 
1769
        return parent_map
2636
1770
 
2637
1771
    def _make_parents_provider(self):
2638
1772
        return self
2639
1773
 
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
1774
    def get_graph(self, other_repository=None):
2650
1775
        """Return the graph walker for this repository format"""
2651
1776
        parents_provider = self._make_parents_provider()
2652
1777
        if (other_repository is not None and
2653
1778
            not self.has_same_location(other_repository)):
2654
 
            parents_provider = graph.StackedParentsProvider(
 
1779
            parents_provider = graph._StackedParentsProvider(
2655
1780
                [parents_provider, other_repository._make_parents_provider()])
2656
1781
        return graph.Graph(parents_provider)
2657
1782
 
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)
 
1783
    def _get_versioned_file_checker(self):
 
1784
        """Return an object suitable for checking versioned files."""
 
1785
        return _VersionedFileChecker(self)
2673
1786
 
2674
1787
    def revision_ids_to_search_result(self, result_set):
2675
1788
        """Convert a set of revision ids to a graph SearchResult."""
2695
1808
                          working trees.
2696
1809
        """
2697
1810
        raise NotImplementedError(self.set_make_working_trees)
2698
 
 
 
1811
    
2699
1812
    def make_working_trees(self):
2700
1813
        """Returns the policy for making working trees on new branches."""
2701
1814
        raise NotImplementedError(self.make_working_trees)
2708
1821
    @needs_read_lock
2709
1822
    def has_signature_for_revision_id(self, revision_id):
2710
1823
        """Query for a revision signature for revision_id in the repository."""
2711
 
        if not self.has_revision(revision_id):
2712
 
            raise errors.NoSuchRevision(self, revision_id)
2713
 
        sig_present = (1 == len(
2714
 
            self.signatures.get_parent_map([(revision_id,)])))
2715
 
        return sig_present
 
1824
        return self._revision_store.has_signature(revision_id,
 
1825
                                                  self.get_transaction())
2716
1826
 
2717
1827
    @needs_read_lock
2718
1828
    def get_signature_text(self, revision_id):
2719
1829
        """Return the text for a signature."""
2720
 
        stream = self.signatures.get_record_stream([(revision_id,)],
2721
 
            'unordered', True)
2722
 
        record = stream.next()
2723
 
        if record.storage_kind == 'absent':
2724
 
            raise errors.NoSuchRevision(self, revision_id)
2725
 
        return record.get_bytes_as('fulltext')
 
1830
        return self._revision_store.get_signature_text(revision_id,
 
1831
                                                       self.get_transaction())
2726
1832
 
2727
1833
    @needs_read_lock
2728
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1834
    def check(self, revision_ids=None):
2729
1835
        """Check consistency of all history of given revision_ids.
2730
1836
 
2731
1837
        Different repository implementations should override _check().
2732
1838
 
2733
1839
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2734
1840
             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
1841
        """
2741
 
        return self._check(revision_ids, callback_refs=callback_refs,
2742
 
            check_repo=check_repo)
 
1842
        return self._check(revision_ids)
2743
1843
 
2744
 
    def _check(self, revision_ids, callback_refs, check_repo):
2745
 
        result = check.Check(self, check_repo=check_repo)
2746
 
        result.check(callback_refs)
 
1844
    def _check(self, revision_ids):
 
1845
        result = check.Check(self)
 
1846
        result.check()
2747
1847
        return result
2748
1848
 
2749
 
    def _warn_if_deprecated(self, branch=None):
 
1849
    def _warn_if_deprecated(self):
2750
1850
        global _deprecation_warning_done
2751
1851
        if _deprecation_warning_done:
2752
1852
            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
 
1853
        _deprecation_warning_done = True
 
1854
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
1855
                % (self._format, self.bzrdir.transport.base))
2765
1856
 
2766
1857
    def supports_rich_root(self):
2767
1858
        return self._format.rich_root_data
2781
1872
                    revision_id.decode('ascii')
2782
1873
                except UnicodeDecodeError:
2783
1874
                    raise errors.NonAsciiRevisionId(method, self)
2784
 
 
 
1875
    
2785
1876
    def revision_graph_can_have_wrong_parents(self):
2786
1877
        """Is it possible for this repository to have a revision graph with
2787
1878
        incorrect parents?
2841
1932
    """
2842
1933
    repository.start_write_group()
2843
1934
    try:
2844
 
        inventory_cache = lru_cache.LRUCache(10)
2845
1935
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2846
 
            _install_revision(repository, revision, revision_tree, signature,
2847
 
                inventory_cache)
 
1936
            _install_revision(repository, revision, revision_tree, signature)
2848
1937
            if pb is not None:
2849
1938
                pb.update('Transferring revisions', n + 1, num_revisions)
2850
1939
    except:
2854
1943
        repository.commit_write_group()
2855
1944
 
2856
1945
 
2857
 
def _install_revision(repository, rev, revision_tree, signature,
2858
 
    inventory_cache):
 
1946
def _install_revision(repository, rev, revision_tree, signature):
2859
1947
    """Install all revision data into a repository."""
2860
1948
    present_parents = []
2861
1949
    parent_trees = {}
2864
1952
            present_parents.append(p_id)
2865
1953
            parent_trees[p_id] = repository.revision_tree(p_id)
2866
1954
        else:
2867
 
            parent_trees[p_id] = repository.revision_tree(
2868
 
                                     _mod_revision.NULL_REVISION)
 
1955
            parent_trees[p_id] = repository.revision_tree(None)
2869
1956
 
2870
1957
    inv = revision_tree.inventory
2871
1958
    entries = inv.iter_entries()
2874
1961
        path, root = entries.next()
2875
1962
        if root.revision != rev.revision_id:
2876
1963
            raise errors.IncompatibleRevision(repr(repository))
2877
 
    text_keys = {}
 
1964
    # Add the texts that are not already present
2878
1965
    for path, ie in entries:
2879
 
        text_keys[(ie.file_id, ie.revision)] = ie
2880
 
    text_parent_map = repository.texts.get_parent_map(text_keys)
2881
 
    missing_texts = set(text_keys) - set(text_parent_map)
2882
 
    # Add the texts that are not already present
2883
 
    for text_key in missing_texts:
2884
 
        ie = text_keys[text_key]
2885
 
        text_parents = []
2886
 
        # FIXME: TODO: The following loop overlaps/duplicates that done by
2887
 
        # commit to determine parents. There is a latent/real bug here where
2888
 
        # the parents inserted are not those commit would do - in particular
2889
 
        # they are not filtered by heads(). RBC, AB
2890
 
        for revision, tree in parent_trees.iteritems():
2891
 
            if ie.file_id not in tree:
2892
 
                continue
2893
 
            parent_id = tree.inventory[ie.file_id].revision
2894
 
            if parent_id in text_parents:
2895
 
                continue
2896
 
            text_parents.append((ie.file_id, parent_id))
2897
 
        lines = revision_tree.get_file(ie.file_id).readlines()
2898
 
        repository.texts.add_lines(text_key, text_parents, lines)
 
1966
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
1967
                repository.get_transaction())
 
1968
        if ie.revision not in w:
 
1969
            text_parents = []
 
1970
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
1971
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
1972
            # is a latent bug here where the parents may have ancestors of each
 
1973
            # other. RBC, AB
 
1974
            for revision, tree in parent_trees.iteritems():
 
1975
                if ie.file_id not in tree:
 
1976
                    continue
 
1977
                parent_id = tree.inventory[ie.file_id].revision
 
1978
                if parent_id in text_parents:
 
1979
                    continue
 
1980
                text_parents.append(parent_id)
 
1981
                    
 
1982
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
1983
                repository.get_transaction())
 
1984
            lines = revision_tree.get_file(ie.file_id).readlines()
 
1985
            vfile.add_lines(rev.revision_id, text_parents, lines)
2899
1986
    try:
2900
1987
        # 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)
 
1988
        repository.add_inventory(rev.revision_id, inv, present_parents)
2914
1989
    except errors.RevisionAlreadyPresent:
2915
1990
        pass
2916
1991
    if signature is not None:
2919
1994
 
2920
1995
 
2921
1996
class MetaDirRepository(Repository):
2922
 
    """Repositories in the new meta-dir layout.
2923
 
 
2924
 
    :ivar _transport: Transport for access to repository control files,
2925
 
        typically pointing to .bzr/repository.
2926
 
    """
2927
 
 
2928
 
    def __init__(self, _format, a_bzrdir, control_files):
2929
 
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
2930
 
        self._transport = control_files._transport
2931
 
 
 
1997
    """Repositories in the new meta-dir layout."""
 
1998
 
 
1999
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
2000
        super(MetaDirRepository, self).__init__(_format,
 
2001
                                                a_bzrdir,
 
2002
                                                control_files,
 
2003
                                                _revision_store,
 
2004
                                                control_store,
 
2005
                                                text_store)
 
2006
        dir_mode = self.control_files._dir_mode
 
2007
        file_mode = self.control_files._file_mode
 
2008
 
 
2009
    @needs_read_lock
2932
2010
    def is_shared(self):
2933
2011
        """Return True if this repository is flagged as a shared repository."""
2934
 
        return self._transport.has('shared-storage')
 
2012
        return self.control_files._transport.has('shared-storage')
2935
2013
 
2936
2014
    @needs_write_lock
2937
2015
    def set_make_working_trees(self, new_value):
2945
2023
        """
2946
2024
        if new_value:
2947
2025
            try:
2948
 
                self._transport.delete('no-working-trees')
 
2026
                self.control_files._transport.delete('no-working-trees')
2949
2027
            except errors.NoSuchFile:
2950
2028
                pass
2951
2029
        else:
2952
 
            self._transport.put_bytes('no-working-trees', '',
2953
 
                mode=self.bzrdir._get_file_mode())
2954
 
 
 
2030
            self.control_files.put_utf8('no-working-trees', '')
 
2031
    
2955
2032
    def make_working_trees(self):
2956
2033
        """Returns the policy for making working trees on new branches."""
2957
 
        return not self._transport.has('no-working-trees')
 
2034
        return not self.control_files._transport.has('no-working-trees')
2958
2035
 
2959
2036
 
2960
2037
class MetaDirVersionedFileRepository(MetaDirRepository):
2961
2038
    """Repositories in a meta-dir, that work via versioned file objects."""
2962
2039
 
2963
 
    def __init__(self, _format, a_bzrdir, control_files):
 
2040
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
2964
2041
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2965
 
            control_files)
2966
 
 
2967
 
 
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.
 
2042
            control_files, _revision_store, control_store, text_store)
 
2043
        _revision_store.get_scope = self.get_transaction
 
2044
        control_store.get_scope = self.get_transaction
 
2045
        text_store.get_scope = self.get_transaction
 
2046
 
 
2047
 
 
2048
class RepositoryFormatRegistry(registry.Registry):
 
2049
    """Registry of RepositoryFormats."""
 
2050
 
 
2051
    def get(self, format_string):
 
2052
        r = registry.Registry.get(self, format_string)
 
2053
        if callable(r):
 
2054
            r = r()
 
2055
        return r
 
2056
    
 
2057
 
 
2058
format_registry = RepositoryFormatRegistry()
 
2059
"""Registry of formats, indexed by their identifying format string.
2979
2060
 
2980
2061
This can contain either format instances themselves, or classes/factories that
2981
2062
can be called to obtain one.
2988
2069
class RepositoryFormat(object):
2989
2070
    """A repository format.
2990
2071
 
2991
 
    Formats provide four things:
 
2072
    Formats provide three things:
2992
2073
     * An initialization routine to construct repository data on disk.
2993
 
     * a optional format string which is used when the BzrDir supports
2994
 
       versioned children.
 
2074
     * a format string which is used when the BzrDir supports versioned
 
2075
       children.
2995
2076
     * an open routine which returns a Repository instance.
2996
 
     * A network name for referring to the format in smart server RPC
2997
 
       methods.
2998
2077
 
2999
2078
    There is one and only one Format subclass for each on-disk format. But
3000
2079
    there can be one Repository subclass that is used for several different
3001
2080
    formats. The _format attribute on a Repository instance can be used to
3002
2081
    determine the disk format.
3003
2082
 
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.
 
2083
    Formats are placed in an dict by their format string for reference 
 
2084
    during opening. These should be subclasses of RepositoryFormat
 
2085
    for consistency.
3007
2086
 
3008
2087
    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.
 
2088
    methods on the format class. Do not deprecate the object, as the 
 
2089
    object will be created every system load.
3012
2090
 
3013
2091
    Common instance attributes:
3014
2092
    _matchingbzrdir - the bzrdir format that the repository format was
3023
2101
    # Can this repository be given external locations to lookup additional
3024
2102
    # data. Set to True or False in derived classes.
3025
2103
    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
2104
 
3056
 
    def __repr__(self):
3057
 
        return "%s()" % self.__class__.__name__
 
2105
    def __str__(self):
 
2106
        return "<%s>" % self.__class__.__name__
3058
2107
 
3059
2108
    def __eq__(self, other):
3060
2109
        # format objects are generally stateless
3066
2115
    @classmethod
3067
2116
    def find_format(klass, a_bzrdir):
3068
2117
        """Return the format for the repository object in a_bzrdir.
3069
 
 
 
2118
        
3070
2119
        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
 
2120
        the repository.  Other methods may be used by different types of 
3072
2121
        control directory.
3073
2122
        """
3074
2123
        try:
3075
2124
            transport = a_bzrdir.get_repository_transport(None)
3076
 
            format_string = transport.get_bytes("format")
 
2125
            format_string = transport.get("format").read()
3077
2126
            return format_registry.get(format_string)
3078
2127
        except errors.NoSuchFile:
3079
2128
            raise errors.NoRepositoryPresent(a_bzrdir)
3088
2137
    @classmethod
3089
2138
    def unregister_format(klass, format):
3090
2139
        format_registry.remove(format.get_format_string())
3091
 
 
 
2140
    
3092
2141
    @classmethod
3093
2142
    def get_default_format(klass):
3094
2143
        """Return the current default format."""
3095
2144
        from bzrlib import bzrdir
3096
2145
        return bzrdir.format_registry.make_bzrdir('default').repository_format
3097
2146
 
 
2147
    def _get_control_store(self, repo_transport, control_files):
 
2148
        """Return the control store for this repository."""
 
2149
        raise NotImplementedError(self._get_control_store)
 
2150
 
3098
2151
    def get_format_string(self):
3099
2152
        """Return the ASCII format string that identifies this format.
3100
 
 
3101
 
        Note that in pre format ?? repositories the format string is
 
2153
        
 
2154
        Note that in pre format ?? repositories the format string is 
3102
2155
        not permitted nor written to disk.
3103
2156
        """
3104
2157
        raise NotImplementedError(self.get_format_string)
3107
2160
        """Return the short description for this format."""
3108
2161
        raise NotImplementedError(self.get_format_description)
3109
2162
 
 
2163
    def _get_revision_store(self, repo_transport, control_files):
 
2164
        """Return the revision store object for this a_bzrdir."""
 
2165
        raise NotImplementedError(self._get_revision_store)
 
2166
 
 
2167
    def _get_text_rev_store(self,
 
2168
                            transport,
 
2169
                            control_files,
 
2170
                            name,
 
2171
                            compressed=True,
 
2172
                            prefixed=False,
 
2173
                            serializer=None):
 
2174
        """Common logic for getting a revision store for a repository.
 
2175
        
 
2176
        see self._get_revision_store for the subclass-overridable method to 
 
2177
        get the store for a repository.
 
2178
        """
 
2179
        from bzrlib.store.revision.text import TextRevisionStore
 
2180
        dir_mode = control_files._dir_mode
 
2181
        file_mode = control_files._file_mode
 
2182
        text_store = TextStore(transport.clone(name),
 
2183
                              prefixed=prefixed,
 
2184
                              compressed=compressed,
 
2185
                              dir_mode=dir_mode,
 
2186
                              file_mode=file_mode)
 
2187
        _revision_store = TextRevisionStore(text_store, serializer)
 
2188
        return _revision_store
 
2189
 
3110
2190
    # TODO: this shouldn't be in the base class, it's specific to things that
3111
2191
    # use weaves or knits -- mbp 20070207
3112
2192
    def _get_versioned_file_store(self,
3135
2215
        :param a_bzrdir: The bzrdir to put the new repository in it.
3136
2216
        :param shared: The repository should be initialized as a sharable one.
3137
2217
        :returns: The new repository object.
3138
 
 
 
2218
        
3139
2219
        This may raise UninitializableFormat if shared repository are not
3140
2220
        compatible the a_bzrdir.
3141
2221
        """
3145
2225
        """Is this format supported?
3146
2226
 
3147
2227
        Supported formats must be initializable and openable.
3148
 
        Unsupported formats may not support initialization or committing or
 
2228
        Unsupported formats may not support initialization or committing or 
3149
2229
        some other features depending on the reason for not being supported.
3150
2230
        """
3151
2231
        return True
3152
2232
 
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
2233
    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)
 
2234
        raise NotImplementedError(self.check_conversion_target)
3173
2235
 
3174
2236
    def open(self, a_bzrdir, _found=False):
3175
2237
        """Return an instance of this format for the bzrdir a_bzrdir.
3176
 
 
 
2238
        
3177
2239
        _found is a private parameter, do not use it.
3178
2240
        """
3179
2241
        raise NotImplementedError(self.open)
3180
2242
 
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
2243
 
3191
2244
class MetaDirRepositoryFormat(RepositoryFormat):
3192
2245
    """Common base class for the new repositories using the metadir layout."""
3194
2247
    rich_root_data = False
3195
2248
    supports_tree_reference = False
3196
2249
    supports_external_lookups = False
3197
 
 
3198
 
    @property
3199
 
    def _matchingbzrdir(self):
3200
 
        matching = bzrdir.BzrDirMetaFormat1()
3201
 
        matching.repository_format = self
3202
 
        return matching
 
2250
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3203
2251
 
3204
2252
    def __init__(self):
3205
2253
        super(MetaDirRepositoryFormat, self).__init__()
3218
2266
        """Upload the initial blank content."""
3219
2267
        control_files = self._create_control_files(a_bzrdir)
3220
2268
        control_files.lock_write()
3221
 
        transport = control_files._transport
3222
 
        if shared == True:
3223
 
            utf8_files += [('shared-storage', '')]
3224
2269
        try:
3225
 
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
3226
 
            for (filename, content_stream) in files:
3227
 
                transport.put_file(filename, content_stream,
3228
 
                    mode=a_bzrdir._get_file_mode())
3229
 
            for (filename, content_bytes) in utf8_files:
3230
 
                transport.put_bytes_non_atomic(filename, content_bytes,
3231
 
                    mode=a_bzrdir._get_file_mode())
 
2270
            control_files._transport.mkdir_multi(dirs,
 
2271
                    mode=control_files._dir_mode)
 
2272
            for file, content in files:
 
2273
                control_files.put(file, content)
 
2274
            for file, content in utf8_files:
 
2275
                control_files.put_utf8(file, content)
 
2276
            if shared == True:
 
2277
                control_files.put_utf8('shared-storage', '')
3232
2278
        finally:
3233
2279
            control_files.unlock()
3234
2280
 
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
 
2281
 
 
2282
# formats which have no format string are not discoverable
 
2283
# and not independently creatable, so are not registered.  They're 
3257
2284
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3258
2285
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3259
2286
# the repository is not separately opened are similar.
3300
2327
    'bzrlib.repofmt.pack_repo',
3301
2328
    'RepositoryFormatKnitPack4',
3302
2329
    )
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
 
    )
 
2330
# Development formats. 
 
2331
# 1.2->1.3
 
2332
# development 0 - stub to introduce development versioning scheme.
 
2333
format_registry.register_lazy(
 
2334
    "Bazaar development format 0 (needs bzr.dev from before 1.3)\n",
 
2335
    'bzrlib.repofmt.pack_repo',
 
2336
    'RepositoryFormatPackDevelopment0',
 
2337
    )
 
2338
format_registry.register_lazy(
 
2339
    ("Bazaar development format 0 with subtree support "
 
2340
        "(needs bzr.dev from before 1.3)\n"),
 
2341
    'bzrlib.repofmt.pack_repo',
 
2342
    'RepositoryFormatPackDevelopment0Subtree',
 
2343
    )
 
2344
# 1.3->1.4 go below here
3357
2345
 
3358
2346
 
3359
2347
class InterRepository(InterObject):
3360
2348
    """This class represents operations taking place between two repositories.
3361
2349
 
3362
2350
    Its instances have methods like copy_content and fetch, and contain
3363
 
    references to the source and target repositories these operations can be
 
2351
    references to the source and target repositories these operations can be 
3364
2352
    carried out on.
3365
2353
 
3366
2354
    Often we will provide convenience methods on 'repository' which carry out
3368
2356
    InterRepository.get(other).method_name(parameters).
3369
2357
    """
3370
2358
 
3371
 
    _walk_to_common_revisions_batch_size = 50
3372
2359
    _optimisers = []
3373
2360
    """The available optimised InterRepository types."""
3374
2361
 
3375
 
    @needs_write_lock
3376
2362
    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):
 
2363
        raise NotImplementedError(self.copy_content)
 
2364
 
 
2365
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3394
2366
        """Fetch the content required to construct revision_id.
3395
2367
 
3396
2368
        The content is copied from self.source to self.target.
3397
2369
 
3398
2370
        :param revision_id: if None all content is copied, if NULL_REVISION no
3399
2371
                            content is copied.
3400
 
        :param pb: ignored.
3401
 
        :return: None.
 
2372
        :param pb: optional progress bar to use for progress reports. If not
 
2373
                   provided a default one will be created.
 
2374
 
 
2375
        Returns the copied revision count and the failed revisions in a tuple:
 
2376
        (copied, failures).
3402
2377
        """
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)
 
2378
        raise NotImplementedError(self.fetch)
3415
2379
 
3416
2380
    def _walk_to_common_revisions(self, revision_ids):
3417
2381
        """Walk out from revision_ids in source to revisions target has.
3421
2385
        """
3422
2386
        target_graph = self.target.get_graph()
3423
2387
        revision_ids = frozenset(revision_ids)
 
2388
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2389
            return graph.SearchResult(revision_ids, set(), 0, set())
3424
2390
        missing_revs = set()
3425
2391
        source_graph = self.source.get_graph()
3426
2392
        # ensure we don't pay silly lookup costs.
3427
2393
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
3428
2394
        null_set = frozenset([_mod_revision.NULL_REVISION])
3429
 
        searcher_exhausted = False
3430
2395
        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
 
2396
            try:
 
2397
                next_revs, ghosts = searcher.next_with_ghosts()
 
2398
            except StopIteration:
 
2399
                break
 
2400
            if revision_ids.intersection(ghosts):
 
2401
                absent_ids = set(revision_ids.intersection(ghosts))
 
2402
                # If all absent_ids are present in target, no error is needed.
 
2403
                absent_ids.difference_update(
 
2404
                    set(target_graph.get_parent_map(absent_ids)))
 
2405
                if absent_ids:
 
2406
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
 
2407
            # we don't care about other ghosts as we can't fetch them and
3445
2408
            # 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
 
2409
            next_revs = set(next_revs)
 
2410
            # we always have NULL_REVISION present.
 
2411
            have_revs = set(target_graph.get_parent_map(next_revs)).union(null_set)
 
2412
            missing_revs.update(next_revs - have_revs)
 
2413
            searcher.stop_searching_any(have_revs)
3466
2414
        return searcher.get_result()
 
2415
   
 
2416
    @deprecated_method(symbol_versioning.one_two)
 
2417
    @needs_read_lock
 
2418
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2419
        """Return the revision ids that source has that target does not.
 
2420
        
 
2421
        These are returned in topological order.
 
2422
 
 
2423
        :param revision_id: only return revision ids included by this
 
2424
                            revision_id.
 
2425
        :param find_ghosts: If True find missing revisions in deep history
 
2426
            rather than just finding the surface difference.
 
2427
        """
 
2428
        return list(self.search_missing_revision_ids(
 
2429
            revision_id, find_ghosts).get_keys())
3467
2430
 
3468
2431
    @needs_read_lock
3469
2432
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3470
2433
        """Return the revision ids that source has that target does not.
3471
 
 
 
2434
        
3472
2435
        :param revision_id: only return revision ids included by this
3473
2436
                            revision_id.
3474
2437
        :param find_ghosts: If True find missing revisions in deep history
3482
2445
        target_ids = set(self.target.all_revision_ids())
3483
2446
        if revision_id is not None:
3484
2447
            source_ids = self.source.get_ancestry(revision_id)
3485
 
            if source_ids[0] is not None:
3486
 
                raise AssertionError()
 
2448
            assert source_ids[0] is None
3487
2449
            source_ids.pop(0)
3488
2450
        else:
3489
2451
            source_ids = self.source.all_revision_ids()
3492
2454
 
3493
2455
    @staticmethod
3494
2456
    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:
 
2457
        """True if source and target have the same data representation."""
 
2458
        if source.supports_rich_root() != target.supports_rich_root():
3504
2459
            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
2460
        if source._serializer != target._serializer:
3514
 
            raise errors.IncompatibleRepositories(source, target,
3515
 
                "different serializers")
 
2461
            return False
 
2462
        return True
3516
2463
 
3517
2464
 
3518
2465
class InterSameDataRepository(InterRepository):
3519
2466
    """Code for converting between repositories that represent the same data.
3520
 
 
 
2467
    
3521
2468
    Data format and model must match for this to work.
3522
2469
    """
3523
2470
 
3524
2471
    @classmethod
3525
2472
    def _get_repo_format_to_test(self):
3526
2473
        """Repository format for testing with.
3527
 
 
 
2474
        
3528
2475
        InterSameData can pull from subtree to subtree and from non-subtree to
3529
2476
        non-subtree, so we test this with the richest repository format.
3530
2477
        """
3535
2482
    def is_compatible(source, target):
3536
2483
        return InterRepository._same_model(source, target)
3537
2484
 
 
2485
    @needs_write_lock
 
2486
    def copy_content(self, revision_id=None):
 
2487
        """Make a complete copy of the content in self into destination.
 
2488
 
 
2489
        This copies both the repository's revision data, and configuration information
 
2490
        such as the make_working_trees setting.
 
2491
        
 
2492
        This is a destructive operation! Do not use it on existing 
 
2493
        repositories.
 
2494
 
 
2495
        :param revision_id: Only copy the content needed to construct
 
2496
                            revision_id and its parents.
 
2497
        """
 
2498
        try:
 
2499
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2500
        except NotImplementedError:
 
2501
            pass
 
2502
        # but don't bother fetching if we have the needed data now.
 
2503
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2504
            self.target.has_revision(revision_id)):
 
2505
            return
 
2506
        self.target.fetch(self.source, revision_id=revision_id)
 
2507
 
 
2508
    @needs_write_lock
 
2509
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2510
        """See InterRepository.fetch()."""
 
2511
        from bzrlib.fetch import GenericRepoFetcher
 
2512
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2513
               self.source, self.source._format, self.target,
 
2514
               self.target._format)
 
2515
        f = GenericRepoFetcher(to_repository=self.target,
 
2516
                               from_repository=self.source,
 
2517
                               last_revision=revision_id,
 
2518
                               pb=pb, find_ghosts=find_ghosts)
 
2519
        return f.count_copied, f.failed_revisions
 
2520
 
3538
2521
 
3539
2522
class InterWeaveRepo(InterSameDataRepository):
3540
2523
    """Optimised code paths between Weave based repositories.
3541
 
 
 
2524
    
3542
2525
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3543
2526
    implemented lazy inter-object optimisation.
3544
2527
    """
3551
2534
    @staticmethod
3552
2535
    def is_compatible(source, target):
3553
2536
        """Be compatible with known Weave formats.
3554
 
 
 
2537
        
3555
2538
        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
 
2539
        could lead to confusing results, and there is no need to be 
3557
2540
        overly general.
3558
2541
        """
3559
2542
        from bzrlib.repofmt.weaverepo import (
3570
2553
                                                RepositoryFormat7)))
3571
2554
        except AttributeError:
3572
2555
            return False
3573
 
 
 
2556
    
3574
2557
    @needs_write_lock
3575
2558
    def copy_content(self, revision_id=None):
3576
2559
        """See InterRepository.copy_content()."""
3580
2563
        except (errors.RepositoryUpgradeRequired, NotImplemented):
3581
2564
            pass
3582
2565
        # FIXME do not peek!
3583
 
        if self.source._transport.listable():
 
2566
        if self.source.control_files._transport.listable():
3584
2567
            pb = ui.ui_factory.nested_progress_bar()
3585
2568
            try:
3586
 
                self.target.texts.insert_record_stream(
3587
 
                    self.source.texts.get_record_stream(
3588
 
                        self.source.texts.keys(), 'topological', False))
3589
 
                pb.update('Copying inventory', 0, 1)
3590
 
                self.target.inventories.insert_record_stream(
3591
 
                    self.source.inventories.get_record_stream(
3592
 
                        self.source.inventories.keys(), 'topological', False))
3593
 
                self.target.signatures.insert_record_stream(
3594
 
                    self.source.signatures.get_record_stream(
3595
 
                        self.source.signatures.keys(),
3596
 
                        'unordered', True))
3597
 
                self.target.revisions.insert_record_stream(
3598
 
                    self.source.revisions.get_record_stream(
3599
 
                        self.source.revisions.keys(),
3600
 
                        'topological', True))
 
2569
                self.target.weave_store.copy_all_ids(
 
2570
                    self.source.weave_store,
 
2571
                    pb=pb,
 
2572
                    from_transaction=self.source.get_transaction(),
 
2573
                    to_transaction=self.target.get_transaction())
 
2574
                pb.update('copying inventory', 0, 1)
 
2575
                self.target.control_weaves.copy_multi(
 
2576
                    self.source.control_weaves, ['inventory'],
 
2577
                    from_transaction=self.source.get_transaction(),
 
2578
                    to_transaction=self.target.get_transaction())
 
2579
                self.target._revision_store.text_store.copy_all_ids(
 
2580
                    self.source._revision_store.text_store,
 
2581
                    pb=pb)
3601
2582
            finally:
3602
2583
                pb.finished()
3603
2584
        else:
3604
2585
            self.target.fetch(self.source, revision_id=revision_id)
3605
2586
 
 
2587
    @needs_write_lock
 
2588
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2589
        """See InterRepository.fetch()."""
 
2590
        from bzrlib.fetch import GenericRepoFetcher
 
2591
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2592
               self.source, self.source._format, self.target, self.target._format)
 
2593
        f = GenericRepoFetcher(to_repository=self.target,
 
2594
                               from_repository=self.source,
 
2595
                               last_revision=revision_id,
 
2596
                               pb=pb, find_ghosts=find_ghosts)
 
2597
        return f.count_copied, f.failed_revisions
 
2598
 
3606
2599
    @needs_read_lock
3607
2600
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3608
2601
        """See InterRepository.missing_revision_ids()."""
3609
2602
        # we want all revisions to satisfy revision_id in source.
3610
2603
        # but we don't want to stat every file here and there.
3611
 
        # we want then, all revisions other needs to satisfy revision_id
 
2604
        # we want then, all revisions other needs to satisfy revision_id 
3612
2605
        # checked, but not those that we have locally.
3613
 
        # so the first thing is to get a subset of the revisions to
 
2606
        # so the first thing is to get a subset of the revisions to 
3614
2607
        # 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
 
2608
        # we do already have. 
 
2609
        # this is slow on high latency connection to self, but as as this
 
2610
        # disk format scales terribly for push anyway due to rewriting 
3618
2611
        # inventory.weave, this is considered acceptable.
3619
2612
        # - RBC 20060209
3620
2613
        if revision_id is not None:
3621
2614
            source_ids = self.source.get_ancestry(revision_id)
3622
 
            if source_ids[0] is not None:
3623
 
                raise AssertionError()
 
2615
            assert source_ids[0] is None
3624
2616
            source_ids.pop(0)
3625
2617
        else:
3626
2618
            source_ids = self.source._all_possible_ids()
3640
2632
            # and the tip revision was validated by get_ancestry.
3641
2633
            result_set = required_revisions
3642
2634
        else:
3643
 
            # if we just grabbed the possibly available ids, then
 
2635
            # if we just grabbed the possibly available ids, then 
3644
2636
            # we only have an estimate of whats available and need to validate
3645
2637
            # that against the revision records.
3646
2638
            result_set = set(
3659
2651
    @staticmethod
3660
2652
    def is_compatible(source, target):
3661
2653
        """Be compatible with known Knit formats.
3662
 
 
 
2654
        
3663
2655
        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
 
2656
        could lead to confusing results, and there is no need to be 
3665
2657
        overly general.
3666
2658
        """
3667
2659
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3672
2664
            return False
3673
2665
        return are_knits and InterRepository._same_model(source, target)
3674
2666
 
 
2667
    @needs_write_lock
 
2668
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2669
        """See InterRepository.fetch()."""
 
2670
        from bzrlib.fetch import KnitRepoFetcher
 
2671
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2672
               self.source, self.source._format, self.target, self.target._format)
 
2673
        f = KnitRepoFetcher(to_repository=self.target,
 
2674
                            from_repository=self.source,
 
2675
                            last_revision=revision_id,
 
2676
                            pb=pb, find_ghosts=find_ghosts)
 
2677
        return f.count_copied, f.failed_revisions
 
2678
 
3675
2679
    @needs_read_lock
3676
2680
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3677
2681
        """See InterRepository.missing_revision_ids()."""
3678
2682
        if revision_id is not None:
3679
2683
            source_ids = self.source.get_ancestry(revision_id)
3680
 
            if source_ids[0] is not None:
3681
 
                raise AssertionError()
 
2684
            assert source_ids[0] is None
3682
2685
            source_ids.pop(0)
3683
2686
        else:
3684
2687
            source_ids = self.source.all_revision_ids()
3698
2701
            # and the tip revision was validated by get_ancestry.
3699
2702
            result_set = required_revisions
3700
2703
        else:
3701
 
            # if we just grabbed the possibly available ids, then
 
2704
            # if we just grabbed the possibly available ids, then 
3702
2705
            # we only have an estimate of whats available and need to validate
3703
2706
            # that against the revision records.
3704
2707
            result_set = set(
3706
2709
        return self.source.revision_ids_to_search_result(result_set)
3707
2710
 
3708
2711
 
3709
 
class InterDifferingSerializer(InterRepository):
 
2712
class InterPackRepo(InterSameDataRepository):
 
2713
    """Optimised code paths between Pack based repositories."""
 
2714
 
 
2715
    @classmethod
 
2716
    def _get_repo_format_to_test(self):
 
2717
        from bzrlib.repofmt import pack_repo
 
2718
        return pack_repo.RepositoryFormatKnitPack1()
 
2719
 
 
2720
    @staticmethod
 
2721
    def is_compatible(source, target):
 
2722
        """Be compatible with known Pack formats.
 
2723
        
 
2724
        We don't test for the stores being of specific types because that
 
2725
        could lead to confusing results, and there is no need to be 
 
2726
        overly general.
 
2727
        """
 
2728
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2729
        try:
 
2730
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2731
                isinstance(target._format, RepositoryFormatPack))
 
2732
        except AttributeError:
 
2733
            return False
 
2734
        return are_packs and InterRepository._same_model(source, target)
 
2735
 
 
2736
    @needs_write_lock
 
2737
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2738
        """See InterRepository.fetch()."""
 
2739
        from bzrlib.repofmt.pack_repo import Packer
 
2740
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2741
               self.source, self.source._format, self.target, self.target._format)
 
2742
        self.count_copied = 0
 
2743
        if revision_id is None:
 
2744
            # TODO:
 
2745
            # everything to do - use pack logic
 
2746
            # to fetch from all packs to one without
 
2747
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2748
            # till then:
 
2749
            revision_ids = self.source.all_revision_ids()
 
2750
            revision_keys = [(revid,) for revid in revision_ids]
 
2751
            index = self.target._pack_collection.revision_index.combined_index
 
2752
            present_revision_ids = set(item[1][0] for item in
 
2753
                index.iter_entries(revision_keys))
 
2754
            revision_ids = set(revision_ids) - present_revision_ids
 
2755
            # implementing the TODO will involve:
 
2756
            # - detecting when all of a pack is selected
 
2757
            # - avoiding as much as possible pre-selection, so the
 
2758
            # more-core routines such as create_pack_from_packs can filter in
 
2759
            # a just-in-time fashion. (though having a HEADS list on a
 
2760
            # repository might make this a lot easier, because we could
 
2761
            # sensibly detect 'new revisions' without doing a full index scan.
 
2762
        elif _mod_revision.is_null(revision_id):
 
2763
            # nothing to do:
 
2764
            return (0, [])
 
2765
        else:
 
2766
            try:
 
2767
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2768
                    find_ghosts=find_ghosts).get_keys()
 
2769
            except errors.NoSuchRevision:
 
2770
                raise errors.InstallFailed([revision_id])
 
2771
            if len(revision_ids) == 0:
 
2772
                return (0, [])
 
2773
        packs = self.source._pack_collection.all_packs()
 
2774
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2775
            revision_ids).pack()
 
2776
        if pack is not None:
 
2777
            self.target._pack_collection._save_pack_names()
 
2778
            # Trigger an autopack. This may duplicate effort as we've just done
 
2779
            # a pack creation, but for now it is simpler to think about as
 
2780
            # 'upload data, then repack if needed'.
 
2781
            self.target._pack_collection.autopack()
 
2782
            return (pack.get_revision_count(), [])
 
2783
        else:
 
2784
            return (0, [])
 
2785
 
 
2786
    @needs_read_lock
 
2787
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2788
        """See InterRepository.missing_revision_ids().
 
2789
        
 
2790
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2791
            revision_id.
 
2792
        """
 
2793
        if not find_ghosts and revision_id is not None:
 
2794
            return self._walk_to_common_revisions([revision_id])
 
2795
        elif revision_id is not None:
 
2796
            source_ids = self.source.get_ancestry(revision_id)
 
2797
            assert source_ids[0] is None
 
2798
            source_ids.pop(0)
 
2799
        else:
 
2800
            source_ids = self.source.all_revision_ids()
 
2801
        # source_ids is the worst possible case we may need to pull.
 
2802
        # now we want to filter source_ids against what we actually
 
2803
        # have in target, but don't try to check for existence where we know
 
2804
        # we do not have a revision as that would be pointless.
 
2805
        target_ids = set(self.target.all_revision_ids())
 
2806
        result_set = set(source_ids).difference(target_ids)
 
2807
        return self.source.revision_ids_to_search_result(result_set)
 
2808
 
 
2809
 
 
2810
class InterModel1and2(InterRepository):
 
2811
 
 
2812
    @classmethod
 
2813
    def _get_repo_format_to_test(self):
 
2814
        return None
 
2815
 
 
2816
    @staticmethod
 
2817
    def is_compatible(source, target):
 
2818
        if not source.supports_rich_root() and target.supports_rich_root():
 
2819
            return True
 
2820
        else:
 
2821
            return False
 
2822
 
 
2823
    @needs_write_lock
 
2824
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2825
        """See InterRepository.fetch()."""
 
2826
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2827
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2828
                                 from_repository=self.source,
 
2829
                                 last_revision=revision_id,
 
2830
                                 pb=pb, find_ghosts=find_ghosts)
 
2831
        return f.count_copied, f.failed_revisions
 
2832
 
 
2833
    @needs_write_lock
 
2834
    def copy_content(self, revision_id=None):
 
2835
        """Make a complete copy of the content in self into destination.
 
2836
        
 
2837
        This is a destructive operation! Do not use it on existing 
 
2838
        repositories.
 
2839
 
 
2840
        :param revision_id: Only copy the content needed to construct
 
2841
                            revision_id and its parents.
 
2842
        """
 
2843
        try:
 
2844
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2845
        except NotImplementedError:
 
2846
            pass
 
2847
        # but don't bother fetching if we have the needed data now.
 
2848
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2849
            self.target.has_revision(revision_id)):
 
2850
            return
 
2851
        self.target.fetch(self.source, revision_id=revision_id)
 
2852
 
 
2853
 
 
2854
class InterKnit1and2(InterKnitRepo):
 
2855
 
 
2856
    @classmethod
 
2857
    def _get_repo_format_to_test(self):
 
2858
        return None
 
2859
 
 
2860
    @staticmethod
 
2861
    def is_compatible(source, target):
 
2862
        """Be compatible with Knit1 source and Knit3 target"""
 
2863
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
2864
        try:
 
2865
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
2866
                RepositoryFormatKnit3)
 
2867
            from bzrlib.repofmt.pack_repo import (
 
2868
                RepositoryFormatKnitPack1,
 
2869
                RepositoryFormatKnitPack3,
 
2870
                RepositoryFormatPackDevelopment0,
 
2871
                RepositoryFormatPackDevelopment0Subtree,
 
2872
                )
 
2873
            nosubtrees = (
 
2874
                RepositoryFormatKnit1,
 
2875
                RepositoryFormatKnitPack1,
 
2876
                RepositoryFormatPackDevelopment0,
 
2877
                )
 
2878
            subtrees = (
 
2879
                RepositoryFormatKnit3,
 
2880
                RepositoryFormatKnitPack3,
 
2881
                RepositoryFormatPackDevelopment0Subtree,
 
2882
                )
 
2883
            return (isinstance(source._format, nosubtrees) and
 
2884
                isinstance(target._format, subtrees))
 
2885
        except AttributeError:
 
2886
            return False
 
2887
 
 
2888
    @needs_write_lock
 
2889
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2890
        """See InterRepository.fetch()."""
 
2891
        from bzrlib.fetch import Knit1to2Fetcher
 
2892
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2893
               self.source, self.source._format, self.target, 
 
2894
               self.target._format)
 
2895
        f = Knit1to2Fetcher(to_repository=self.target,
 
2896
                            from_repository=self.source,
 
2897
                            last_revision=revision_id,
 
2898
                            pb=pb, find_ghosts=find_ghosts)
 
2899
        return f.count_copied, f.failed_revisions
 
2900
 
 
2901
 
 
2902
class InterDifferingSerializer(InterKnitRepo):
3710
2903
 
3711
2904
    @classmethod
3712
2905
    def _get_repo_format_to_test(self):
3715
2908
    @staticmethod
3716
2909
    def is_compatible(source, target):
3717
2910
        """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:///'):
 
2911
        if source.supports_rich_root() != target.supports_rich_root():
 
2912
            return False
 
2913
        # Ideally, we'd support fetching if the source had no tree references
 
2914
        # even if it supported them...
 
2915
        if (getattr(source, '_format.supports_tree_reference', False) and
 
2916
            not getattr(target, '_format.supports_tree_reference', False)):
3739
2917
            return False
3740
2918
        return True
3741
2919
 
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
2920
    @needs_write_lock
3989
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3990
 
            fetch_spec=None):
 
2921
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3991
2922
        """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
2923
        revision_ids = self.target.search_missing_revision_ids(self.source,
4007
2924
            revision_id, find_ghosts=find_ghosts).get_keys()
4008
 
        if not revision_ids:
4009
 
            return 0, 0
4010
2925
        revision_ids = tsort.topo_sort(
4011
2926
            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.
 
2927
        def revisions_iterator():
 
2928
            for current_revision_id in revision_ids:
 
2929
                revision = self.source.get_revision(current_revision_id)
 
2930
                tree = self.source.revision_tree(current_revision_id)
 
2931
                try:
 
2932
                    signature = self.source.get_signature_text(
 
2933
                        current_revision_id)
 
2934
                except errors.NoSuchRevision:
 
2935
                    signature = None
 
2936
                yield revision, tree, signature
4017
2937
        if pb is None:
4018
2938
            my_pb = ui.ui_factory.nested_progress_bar()
4019
2939
            pb = my_pb
4020
2940
        else:
4021
 
            symbol_versioning.warn(
4022
 
                symbol_versioning.deprecated_in((1, 14, 0))
4023
 
                % "pb parameter to fetch()")
4024
2941
            my_pb = None
4025
2942
        try:
4026
 
            self._fetch_all_revisions(revision_ids, pb)
 
2943
            install_revisions(self.target, revisions_iterator(),
 
2944
                              len(revision_ids), pb)
4027
2945
        finally:
4028
2946
            if my_pb is not None:
4029
2947
                my_pb.finished()
4030
2948
        return len(revision_ids), 0
4031
2949
 
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
 
2950
 
 
2951
class InterRemoteToOther(InterRepository):
 
2952
 
 
2953
    def __init__(self, source, target):
 
2954
        InterRepository.__init__(self, source, target)
 
2955
        self._real_inter = None
 
2956
 
 
2957
    @staticmethod
 
2958
    def is_compatible(source, target):
 
2959
        if not isinstance(source, remote.RemoteRepository):
 
2960
            return False
 
2961
        # Is source's model compatible with target's model?
 
2962
        source._ensure_real()
 
2963
        real_source = source._real_repository
 
2964
        assert not isinstance(real_source, remote.RemoteRepository), (
 
2965
            "We don't support remote repos backed by remote repos yet.")
 
2966
        return InterRepository._same_model(real_source, target)
 
2967
 
 
2968
    @needs_write_lock
 
2969
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2970
        """See InterRepository.fetch()."""
 
2971
        from bzrlib.fetch import RemoteToOtherFetcher
 
2972
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
2973
               self.source, self.target, self.target._format)
 
2974
        # TODO: jam 20070210 This should be an assert, not a translate
 
2975
        revision_id = osutils.safe_revision_id(revision_id)
 
2976
        f = RemoteToOtherFetcher(to_repository=self.target,
 
2977
                                 from_repository=self.source,
 
2978
                                 last_revision=revision_id,
 
2979
                                 pb=pb, find_ghosts=find_ghosts)
 
2980
        return f.count_copied, f.failed_revisions
 
2981
 
 
2982
    @classmethod
 
2983
    def _get_repo_format_to_test(self):
 
2984
        return None
 
2985
 
 
2986
 
 
2987
class InterOtherToRemote(InterRepository):
 
2988
 
 
2989
    def __init__(self, source, target):
 
2990
        InterRepository.__init__(self, source, target)
 
2991
        self._real_inter = None
 
2992
 
 
2993
    @staticmethod
 
2994
    def is_compatible(source, target):
 
2995
        if isinstance(target, remote.RemoteRepository):
 
2996
            return True
 
2997
        return False
 
2998
 
 
2999
    def _ensure_real_inter(self):
 
3000
        if self._real_inter is None:
 
3001
            self.target._ensure_real()
 
3002
            real_target = self.target._real_repository
 
3003
            self._real_inter = InterRepository.get(self.source, real_target)
 
3004
    
 
3005
    def copy_content(self, revision_id=None):
 
3006
        self._ensure_real_inter()
 
3007
        self._real_inter.copy_content(revision_id=revision_id)
 
3008
 
 
3009
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3010
        self._ensure_real_inter()
 
3011
        self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3012
            find_ghosts=find_ghosts)
 
3013
 
 
3014
    @classmethod
 
3015
    def _get_repo_format_to_test(self):
 
3016
        return None
4053
3017
 
4054
3018
 
4055
3019
InterRepository.register_optimiser(InterDifferingSerializer)
4056
3020
InterRepository.register_optimiser(InterSameDataRepository)
4057
3021
InterRepository.register_optimiser(InterWeaveRepo)
4058
3022
InterRepository.register_optimiser(InterKnitRepo)
 
3023
InterRepository.register_optimiser(InterModel1and2)
 
3024
InterRepository.register_optimiser(InterKnit1and2)
 
3025
InterRepository.register_optimiser(InterPackRepo)
 
3026
InterRepository.register_optimiser(InterRemoteToOther)
 
3027
InterRepository.register_optimiser(InterOtherToRemote)
4059
3028
 
4060
3029
 
4061
3030
class CopyConverter(object):
4062
3031
    """A repository conversion tool which just performs a copy of the content.
4063
 
 
 
3032
    
4064
3033
    This is slow but quite reliable.
4065
3034
    """
4066
3035
 
4070
3039
        :param target_format: The format the resulting repository should be.
4071
3040
        """
4072
3041
        self.target_format = target_format
4073
 
 
 
3042
        
4074
3043
    def convert(self, repo, pb):
4075
3044
        """Perform the conversion of to_convert, giving feedback via pb.
4076
3045
 
4077
3046
        :param to_convert: The disk object to convert.
4078
3047
        :param pb: a progress bar to use for progress information.
4079
3048
        """
4080
 
        pb = ui.ui_factory.nested_progress_bar()
 
3049
        self.pb = pb
4081
3050
        self.count = 0
4082
3051
        self.total = 4
4083
3052
        # this is only useful with metadir layouts - separated repo content.
4084
3053
        # trigger an assertion if not such
4085
3054
        repo._format.get_format_string()
4086
3055
        self.repo_dir = repo.bzrdir
4087
 
        pb.update('Moving repository to repository.backup')
 
3056
        self.step('Moving repository to repository.backup')
4088
3057
        self.repo_dir.transport.move('repository', 'repository.backup')
4089
3058
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4090
3059
        repo._format.check_conversion_target(self.target_format)
4091
3060
        self.source_repo = repo._format.open(self.repo_dir,
4092
3061
            _found=True,
4093
3062
            _override_transport=backup_transport)
4094
 
        pb.update('Creating new repository')
 
3063
        self.step('Creating new repository')
4095
3064
        converted = self.target_format.initialize(self.repo_dir,
4096
3065
                                                  self.source_repo.is_shared())
4097
3066
        converted.lock_write()
4098
3067
        try:
4099
 
            pb.update('Copying content')
 
3068
            self.step('Copying content into repository.')
4100
3069
            self.source_repo.copy_content_into(converted)
4101
3070
        finally:
4102
3071
            converted.unlock()
4103
 
        pb.update('Deleting old repository content')
 
3072
        self.step('Deleting old repository content.')
4104
3073
        self.repo_dir.transport.delete_tree('repository.backup')
4105
 
        ui.ui_factory.note('repository converted')
4106
 
        pb.finished()
 
3074
        self.pb.note('repository converted')
 
3075
 
 
3076
    def step(self, message):
 
3077
        """Update the pb by a step."""
 
3078
        self.count +=1
 
3079
        self.pb.update(message, self.count, self.total)
4107
3080
 
4108
3081
 
4109
3082
_unescape_map = {
4138
3111
 
4139
3112
class _VersionedFileChecker(object):
4140
3113
 
4141
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3114
    def __init__(self, repository):
4142
3115
        self.repository = repository
4143
 
        self.text_index = self.repository._generate_text_key_index(
4144
 
            text_key_references=text_key_references, ancestors=ancestors)
4145
 
 
4146
 
    def calculate_file_version_parents(self, text_key):
 
3116
        self.text_index = self.repository._generate_text_key_index()
 
3117
    
 
3118
    def calculate_file_version_parents(self, revision_id, file_id):
4147
3119
        """Calculate the correct parents for a file version according to
4148
3120
        the inventories.
4149
3121
        """
4150
 
        parent_keys = self.text_index[text_key]
 
3122
        parent_keys = self.text_index[(file_id, revision_id)]
4151
3123
        if parent_keys == [_mod_revision.NULL_REVISION]:
4152
3124
            return ()
4153
 
        return tuple(parent_keys)
 
3125
        # strip the file_id, for the weave api
 
3126
        return tuple([revision_id for file_id, revision_id in parent_keys])
4154
3127
 
4155
 
    def check_file_version_parents(self, texts, progress_bar=None):
 
3128
    def check_file_version_parents(self, weave, file_id):
4156
3129
        """Check the parents stored in a versioned file are correct.
4157
3130
 
4158
3131
        It also detects file versions that are not referenced by their
4165
3138
            revision_id) tuples for versions that are present in this versioned
4166
3139
            file, but not used by the corresponding inventory.
4167
3140
        """
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
3141
        wrong_parents = {}
4181
 
        self.file_ids = set([file_id for file_id, _ in
4182
 
            self.text_index.iterkeys()])
4183
 
        # text keys is now grouped by file_id
4184
 
        n_versions = len(self.text_index)
4185
 
        progress_bar.update('loading text store', 0, n_versions)
4186
 
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4187
 
        # On unlistable transports this could well be empty/error...
4188
 
        text_keys = self.repository.texts.keys()
4189
 
        unused_keys = frozenset(text_keys) - set(self.text_index)
4190
 
        for num, key in enumerate(self.text_index.iterkeys()):
4191
 
            progress_bar.update('checking text graph', num, n_versions)
4192
 
            correct_parents = self.calculate_file_version_parents(key)
 
3142
        unused_versions = set()
 
3143
        versions = weave.versions()
 
3144
        parent_map = weave.get_parent_map(versions)
 
3145
        for num, revision_id in enumerate(versions):
4193
3146
            try:
4194
 
                knit_parents = parent_map[key]
4195
 
            except errors.RevisionNotPresent:
4196
 
                # Missing text!
4197
 
                knit_parents = None
4198
 
            if correct_parents != knit_parents:
4199
 
                wrong_parents[key] = (knit_parents, correct_parents)
4200
 
        return wrong_parents, unused_keys
 
3147
                correct_parents = self.calculate_file_version_parents(
 
3148
                    revision_id, file_id)
 
3149
            except KeyError:
 
3150
                # The version is not part of the used keys.
 
3151
                unused_versions.add(revision_id)
 
3152
            else:
 
3153
                try:
 
3154
                    knit_parents = tuple(parent_map[revision_id])
 
3155
                except errors.RevisionNotPresent:
 
3156
                    knit_parents = None
 
3157
                if correct_parents != knit_parents:
 
3158
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
3159
        return wrong_parents, unused_versions
4201
3160
 
4202
3161
 
4203
3162
def _old_get_graph(repository, revision_id):
4217
3176
        revision_graph[key] = tuple(parent for parent in parents if parent
4218
3177
            in revision_graph)
4219
3178
    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