~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-02 10:21:39 UTC
  • mfrom: (4797.2.24 2.1)
  • mto: This revision was merged to the branch mainline in revision 5069.
  • Revision ID: v.ladeuil+lp@free.fr-20100302102139-b5cba7h6xu13mekg
Merge 2.1 into trunk including fixes for #331095, #507557, #185103, #524184 and #369501

Show diffs side-by-side

added added

removed removed

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