~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Matthew Revell
  • Date: 2008-03-05 14:11:35 UTC
  • mto: This revision was merged to the branch mainline in revision 3263.
  • Revision ID: matthew.revell@canonical.com-20080305141135-96jf8j24b9crru6v
Added an admin-guide directory to doc/en and outlined headings for the admin guide in index.txt

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