/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

 * ``InterRepository.missing_revision_ids`` is now deprecated in favour of
   ``InterRepository.search_missing_revision_ids`` which returns a 
   ``bzrlib.graph.SearchResult`` suitable for making requests from the smart
   server. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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