~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

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