~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-07-17 09:40:51 UTC
  • mfrom: (3518.1.2 virtualvf)
  • Revision ID: pqm@pqm.ubuntu.com-20080717094051-cgyo1zagozwcd4mm
(Jelmer) Add VirtualVersionedFiles class.

Show diffs side-by-side

added added

removed removed

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