~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Ian Clatworthy
  • Date: 2007-11-28 00:07:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071128000756-kqm8iqmc9281roii
more cleanups and creation of tutorials directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from cStringIO import StringIO
16
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
19
 
import cStringIO
20
21
import re
21
22
import time
22
23
 
23
24
from bzrlib import (
24
25
    bzrdir,
25
26
    check,
26
 
    chk_map,
27
 
    config,
28
27
    debug,
 
28
    deprecated_graph,
29
29
    errors,
30
 
    fetch as _mod_fetch,
31
 
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
33
    lazy_regex,
38
34
    lockable_files,
39
35
    lockdir,
40
36
    lru_cache,
41
37
    osutils,
 
38
    registry,
 
39
    remote,
42
40
    revision as _mod_revision,
43
41
    symbol_versioning,
44
 
    trace,
 
42
    transactions,
45
43
    tsort,
46
44
    ui,
47
 
    versionedfile,
48
45
    )
49
46
from bzrlib.bundle import serializer
50
47
from bzrlib.revisiontree import RevisionTree
51
48
from bzrlib.store.versioned import VersionedFileStore
 
49
from bzrlib.store.text import TextStore
52
50
from bzrlib.testament import Testament
 
51
from bzrlib.util import bencode
53
52
""")
54
53
 
55
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
54
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
55
from bzrlib.inter import InterObject
57
 
from bzrlib.inventory import (
58
 
    Inventory,
59
 
    InventoryDirectory,
60
 
    ROOT_ID,
61
 
    entry_factory,
62
 
    )
63
 
from bzrlib.lock import _RelockDebugMixin
64
 
from bzrlib import registry
65
 
from bzrlib.trace import (
66
 
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
56
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
57
from bzrlib.symbol_versioning import (
 
58
        deprecated_method,
 
59
        )
 
60
from bzrlib.trace import mutter, mutter_callsite, note, warning
67
61
 
68
62
 
69
63
# Old formats display a warning, but only once
73
67
class CommitBuilder(object):
74
68
    """Provides an interface to build up a commit.
75
69
 
76
 
    This allows describing a tree to be committed without needing to
 
70
    This allows describing a tree to be committed without needing to 
77
71
    know the internals of the format of the repository.
78
72
    """
79
 
 
 
73
    
80
74
    # all clients should supply tree roots.
81
75
    record_root_entry = True
82
76
    # the default CommitBuilder does not manage trees whose root is versioned.
83
77
    _versioned_root = False
84
78
 
85
 
    def __init__(self, repository, parents, config, timestamp=None,
86
 
                 timezone=None, committer=None, revprops=None,
 
79
    def __init__(self, repository, parents, config, timestamp=None, 
 
80
                 timezone=None, committer=None, revprops=None, 
87
81
                 revision_id=None):
88
82
        """Initiate a CommitBuilder.
89
83
 
101
95
        if committer is None:
102
96
            self._committer = self._config.username()
103
97
        else:
 
98
            assert isinstance(committer, basestring), type(committer)
104
99
            self._committer = committer
105
100
 
106
101
        self.new_inventory = Inventory(None)
110
105
 
111
106
        self._revprops = {}
112
107
        if revprops is not None:
113
 
            self._validate_revprops(revprops)
114
108
            self._revprops.update(revprops)
115
109
 
116
110
        if timestamp is None:
124
118
            self._timezone = int(timezone)
125
119
 
126
120
        self._generate_revision_if_needed()
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,))
 
121
        self._heads = graph.HeadsCache(repository.get_graph()).heads
161
122
 
162
123
    def commit(self, message):
163
124
        """Make the actual commit.
164
125
 
165
126
        :return: The revision id of the recorded revision.
166
127
        """
167
 
        self._validate_unicode_text(message, 'commit message')
168
128
        rev = _mod_revision.Revision(
169
129
                       timestamp=self._timestamp,
170
130
                       timezone=self._timezone,
193
153
        deserializing the inventory, while we already have a copy in
194
154
        memory.
195
155
        """
196
 
        if self.new_inventory is None:
197
 
            self.new_inventory = self.repository.get_inventory(
198
 
                self._new_revision_id)
199
156
        return RevisionTree(self.repository, self.new_inventory,
200
 
            self._new_revision_id)
 
157
                            self._new_revision_id)
201
158
 
202
159
    def finish_inventory(self):
203
 
        """Tell the builder that the inventory is finished.
204
 
 
205
 
        :return: The inventory id in the repository, which can be used with
206
 
            repository.get_inventory.
207
 
        """
208
 
        if self.new_inventory is None:
209
 
            # an inventory delta was accumulated without creating a new
210
 
            # inventory.
211
 
            basis_id = self.basis_delta_revision
212
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
213
 
            # because self.new_inventory is used to hint to the rest of the
214
 
            # system what code path was taken
215
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
216
 
                basis_id, self._basis_delta, self._new_revision_id,
217
 
                self.parents)
218
 
        else:
219
 
            if self.new_inventory.root is None:
220
 
                raise AssertionError('Root entry should be supplied to'
221
 
                    ' record_entry_contents, as of bzr 0.10.')
222
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
223
 
            self.new_inventory.revision_id = self._new_revision_id
224
 
            self.inv_sha1 = self.repository.add_inventory(
225
 
                self._new_revision_id,
226
 
                self.new_inventory,
227
 
                self.parents
228
 
                )
229
 
        return self._new_revision_id
 
160
        """Tell the builder that the inventory is finished."""
 
161
        if self.new_inventory.root is None:
 
162
            raise AssertionError('Root entry should be supplied to'
 
163
                ' record_entry_contents, as of bzr 0.10.',
 
164
                 DeprecationWarning, stacklevel=2)
 
165
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
166
        self.new_inventory.revision_id = self._new_revision_id
 
167
        self.inv_sha1 = self.repository.add_inventory(
 
168
            self._new_revision_id,
 
169
            self.new_inventory,
 
170
            self.parents
 
171
            )
230
172
 
231
173
    def _gen_revision_id(self):
232
174
        """Return new revision-id."""
235
177
 
236
178
    def _generate_revision_if_needed(self):
237
179
        """Create a revision id if None was supplied.
238
 
 
 
180
        
239
181
        If the repository can not support user-specified revision ids
240
182
        they should override this function and raise CannotSetRevisionId
241
183
        if _new_revision_id is not None.
248
190
        else:
249
191
            self.random_revid = False
250
192
 
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
 
 
259
193
    def _check_root(self, ie, parent_invs, tree):
260
194
        """Helper for record_entry_contents.
261
195
 
269
203
        # _new_revision_id
270
204
        ie.revision = self._new_revision_id
271
205
 
272
 
    def _require_root_change(self, tree):
273
 
        """Enforce an appropriate root object change.
274
 
 
275
 
        This is called once when record_iter_changes is called, if and only if
276
 
        the root was not in the delta calculated by record_iter_changes.
277
 
 
278
 
        :param tree: The tree which is being committed.
279
 
        """
280
 
        # NB: if there are no parents then this method is not called, so no
281
 
        # need to guard on parents having length.
282
 
        entry = entry_factory['directory'](tree.path2id(''), '',
283
 
            None)
284
 
        entry.revision = self._new_revision_id
285
 
        self._basis_delta.append(('', '', entry.file_id, entry))
286
 
 
287
206
    def _get_delta(self, ie, basis_inv, path):
288
207
        """Get a delta against the basis inventory for ie."""
289
208
        if ie.file_id not in basis_inv:
290
209
            # add
291
 
            result = (None, path, ie.file_id, ie)
292
 
            self._basis_delta.append(result)
293
 
            return result
 
210
            return (None, path, ie.file_id, ie)
294
211
        elif ie != basis_inv[ie.file_id]:
295
212
            # common but altered
296
213
            # TODO: avoid tis id2path call.
297
 
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
298
 
            self._basis_delta.append(result)
299
 
            return result
 
214
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
300
215
        else:
301
216
            # common, unaltered
302
217
            return None
303
218
 
304
 
    def get_basis_delta(self):
305
 
        """Return the complete inventory delta versus the basis inventory.
306
 
 
307
 
        This has been built up with the calls to record_delete and
308
 
        record_entry_contents. The client must have already called
309
 
        will_record_deletes() to indicate that they will be generating a
310
 
        complete delta.
311
 
 
312
 
        :return: An inventory delta, suitable for use with apply_delta, or
313
 
            Repository.add_inventory_by_delta, etc.
314
 
        """
315
 
        if not self._recording_deletes:
316
 
            raise AssertionError("recording deletes not activated.")
317
 
        return self._basis_delta
318
 
 
319
 
    def record_delete(self, path, file_id):
320
 
        """Record that a delete occured against a basis tree.
321
 
 
322
 
        This is an optional API - when used it adds items to the basis_delta
323
 
        being accumulated by the commit builder. It cannot be called unless the
324
 
        method will_record_deletes() has been called to inform the builder that
325
 
        a delta is being supplied.
326
 
 
327
 
        :param path: The path of the thing deleted.
328
 
        :param file_id: The file id that was deleted.
329
 
        """
330
 
        if not self._recording_deletes:
331
 
            raise AssertionError("recording deletes not activated.")
332
 
        delta = (path, None, file_id, None)
333
 
        self._basis_delta.append(delta)
334
 
        self._any_changes = True
335
 
        return delta
336
 
 
337
 
    def will_record_deletes(self):
338
 
        """Tell the commit builder that deletes are being notified.
339
 
 
340
 
        This enables the accumulation of an inventory delta; for the resulting
341
 
        commit to be valid, deletes against the basis MUST be recorded via
342
 
        builder.record_delete().
343
 
        """
344
 
        self._recording_deletes = True
345
 
        try:
346
 
            basis_id = self.parents[0]
347
 
        except IndexError:
348
 
            basis_id = _mod_revision.NULL_REVISION
349
 
        self.basis_delta_revision = basis_id
350
 
 
351
219
    def record_entry_contents(self, ie, parent_invs, path, tree,
352
220
        content_summary):
353
221
        """Record the content of ie from tree into the commit if needed.
358
226
        :param parent_invs: The inventories of the parent revisions of the
359
227
            commit.
360
228
        :param path: The path the entry is at in the tree.
361
 
        :param tree: The tree which contains this entry and should be used to
 
229
        :param tree: The tree which contains this entry and should be used to 
362
230
            obtain content.
363
231
        :param content_summary: Summary data from the tree about the paths
364
232
            content - stat, length, exec, sha/link target. This is only
365
233
            accessed when the entry has a revision of None - that is when it is
366
234
            a candidate to commit.
367
 
        :return: A tuple (change_delta, version_recorded, fs_hash).
368
 
            change_delta is an inventory_delta change for this entry against
369
 
            the basis tree of the commit, or None if no change occured against
370
 
            the basis tree.
 
235
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
236
            an inventory_delta change for this entry against the basis tree of
 
237
            the commit, or None if no change occured against the basis tree.
371
238
            version_recorded is True if a new version of the entry has been
372
239
            recorded. For instance, committing a merge where a file was only
373
240
            changed on the other side will return (delta, False).
374
 
            fs_hash is either None, or the hash details for the path (currently
375
 
            a tuple of the contents sha1 and the statvalue returned by
376
 
            tree.get_file_with_stat()).
377
241
        """
378
242
        if self.new_inventory.root is None:
379
243
            if ie.parent_id is not None:
405
269
        if ie.revision is not None:
406
270
            if not self._versioned_root and path == '':
407
271
                # repositories that do not version the root set the root's
408
 
                # revision to the new commit even when no change occurs (more
409
 
                # specifically, they do not record a revision on the root; and
410
 
                # the rev id is assigned to the root during deserialisation -
411
 
                # this masks when a change may have occurred against the basis.
412
 
                # To match this we always issue a delta, because the revision
413
 
                # of the root will always be changing.
 
272
                # revision to the new commit even when no change occurs, and
 
273
                # this masks when a change may have occurred against the basis,
 
274
                # so calculate if one happened.
414
275
                if ie.file_id in basis_inv:
415
276
                    delta = (basis_inv.id2path(ie.file_id), path,
416
277
                        ie.file_id, ie)
417
278
                else:
418
279
                    # add
419
280
                    delta = (None, path, ie.file_id, ie)
420
 
                self._basis_delta.append(delta)
421
 
                return delta, False, None
 
281
                return delta, False
422
282
            else:
423
283
                # we don't need to commit this, because the caller already
424
284
                # determined that an existing revision of this file is
425
 
                # appropriate. If its not being considered for committing then
426
 
                # it and all its parents to the root must be unaltered so
427
 
                # no-change against the basis.
428
 
                if ie.revision == self._new_revision_id:
429
 
                    raise AssertionError("Impossible situation, a skipped "
430
 
                        "inventory entry (%r) claims to be modified in this "
431
 
                        "commit (%r).", (ie, self._new_revision_id))
432
 
                return None, False, None
 
285
                # appropriate.
 
286
                return None, (ie.revision == self._new_revision_id)
433
287
        # XXX: Friction: parent_candidates should return a list not a dict
434
288
        #      so that we don't have to walk the inventories again.
435
289
        parent_candiate_entries = ie.parent_candidates(parent_invs)
436
 
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
290
        head_set = self._heads(parent_candiate_entries.keys())
437
291
        heads = []
438
292
        for inv in parent_invs:
439
293
            if ie.file_id in inv:
465
319
            # if the kind changed the content obviously has
466
320
            if kind != parent_entry.kind:
467
321
                store = True
468
 
        # Stat cache fingerprint feedback for the caller - None as we usually
469
 
        # don't generate one.
470
 
        fingerprint = None
471
322
        if kind == 'file':
472
 
            if content_summary[2] is None:
473
 
                raise ValueError("Files must not have executable = None")
 
323
            assert content_summary[2] is not None, \
 
324
                "Files must not have executable = None"
474
325
            if not store:
475
 
                # We can't trust a check of the file length because of content
476
 
                # filtering...
477
 
                if (# if the exec bit has changed we have to store:
 
326
                if (# if the file length changed we have to store:
 
327
                    parent_entry.text_size != content_summary[1] or
 
328
                    # if the exec bit has changed we have to store:
478
329
                    parent_entry.executable != content_summary[2]):
479
330
                    store = True
480
331
                elif parent_entry.text_sha1 == content_summary[3]:
484
335
                    ie.text_size = parent_entry.text_size
485
336
                    ie.text_sha1 = parent_entry.text_sha1
486
337
                    ie.executable = parent_entry.executable
487
 
                    return self._get_delta(ie, basis_inv, path), False, None
 
338
                    return self._get_delta(ie, basis_inv, path), False
488
339
                else:
489
340
                    # Either there is only a hash change(no hash cache entry,
490
341
                    # or same size content change), or there is no change on
497
348
                # absence of a content change in the file.
498
349
                nostore_sha = None
499
350
            ie.executable = content_summary[2]
500
 
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
501
 
            try:
502
 
                text = file_obj.read()
503
 
            finally:
504
 
                file_obj.close()
 
351
            lines = tree.get_file(ie.file_id, path).readlines()
505
352
            try:
506
353
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
507
 
                    ie.file_id, text, heads, nostore_sha)
508
 
                # Let the caller know we generated a stat fingerprint.
509
 
                fingerprint = (ie.text_sha1, stat_value)
 
354
                    ie.file_id, lines, heads, nostore_sha)
510
355
            except errors.ExistingContent:
511
356
                # Turns out that the file content was unchanged, and we were
512
357
                # only going to store a new node if it was changed. Carry over
515
360
                ie.text_size = parent_entry.text_size
516
361
                ie.text_sha1 = parent_entry.text_sha1
517
362
                ie.executable = parent_entry.executable
518
 
                return self._get_delta(ie, basis_inv, path), False, None
 
363
                return self._get_delta(ie, basis_inv, path), False
519
364
        elif kind == 'directory':
520
365
            if not store:
521
366
                # all data is meta here, nothing specific to directory, so
522
367
                # carry over:
523
368
                ie.revision = parent_entry.revision
524
 
                return self._get_delta(ie, basis_inv, path), False, None
525
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
369
                return self._get_delta(ie, basis_inv, path), False
 
370
            lines = []
 
371
            self._add_text_to_weave(ie.file_id, lines, heads, None)
526
372
        elif kind == 'symlink':
527
373
            current_link_target = content_summary[3]
528
374
            if not store:
534
380
                # unchanged, carry over.
535
381
                ie.revision = parent_entry.revision
536
382
                ie.symlink_target = parent_entry.symlink_target
537
 
                return self._get_delta(ie, basis_inv, path), False, None
 
383
                return self._get_delta(ie, basis_inv, path), False
538
384
            ie.symlink_target = current_link_target
539
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
385
            lines = []
 
386
            self._add_text_to_weave(ie.file_id, lines, heads, None)
540
387
        elif kind == 'tree-reference':
541
388
            if not store:
542
389
                if content_summary[3] != parent_entry.reference_revision:
545
392
                # unchanged, carry over.
546
393
                ie.reference_revision = parent_entry.reference_revision
547
394
                ie.revision = parent_entry.revision
548
 
                return self._get_delta(ie, basis_inv, path), False, None
 
395
                return self._get_delta(ie, basis_inv, path), False
549
396
            ie.reference_revision = content_summary[3]
550
 
            if ie.reference_revision is None:
551
 
                raise AssertionError("invalid content_summary for nested tree: %r"
552
 
                    % (content_summary,))
553
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
397
            lines = []
 
398
            self._add_text_to_weave(ie.file_id, lines, heads, None)
554
399
        else:
555
400
            raise NotImplementedError('unknown kind')
556
401
        ie.revision = self._new_revision_id
557
 
        self._any_changes = True
558
 
        return self._get_delta(ie, basis_inv, path), True, fingerprint
559
 
 
560
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
561
 
        _entry_factory=entry_factory):
562
 
        """Record a new tree via iter_changes.
563
 
 
564
 
        :param tree: The tree to obtain text contents from for changed objects.
565
 
        :param basis_revision_id: The revision id of the tree the iter_changes
566
 
            has been generated against. Currently assumed to be the same
567
 
            as self.parents[0] - if it is not, errors may occur.
568
 
        :param iter_changes: An iter_changes iterator with the changes to apply
569
 
            to basis_revision_id. The iterator must not include any items with
570
 
            a current kind of None - missing items must be either filtered out
571
 
            or errored-on beefore record_iter_changes sees the item.
572
 
        :param _entry_factory: Private method to bind entry_factory locally for
573
 
            performance.
574
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
575
 
            tree._observed_sha1.
576
 
        """
577
 
        # Create an inventory delta based on deltas between all the parents and
578
 
        # deltas between all the parent inventories. We use inventory delta's 
579
 
        # between the inventory objects because iter_changes masks
580
 
        # last-changed-field only changes.
581
 
        # Working data:
582
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
583
 
        # parents, names, kinds, executables
584
 
        merged_ids = {}
585
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
586
 
        # trees that are not parents[0]
587
 
        parent_entries = {}
588
 
        ghost_basis = False
 
402
        return self._get_delta(ie, basis_inv, path), True
 
403
 
 
404
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
405
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
406
            file_id, self.repository.get_transaction())
 
407
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
408
        # than add_lines, and allows committing when a parent is ghosted for
 
409
        # some reason.
 
410
        # Note: as we read the content directly from the tree, we know its not
 
411
        # been turned into unicode or badly split - but a broken tree
 
412
        # implementation could give us bad output from readlines() so this is
 
413
        # not a guarantee of safety. What would be better is always checking
 
414
        # the content during test suite execution. RBC 20070912
589
415
        try:
590
 
            revtrees = list(self.repository.revision_trees(self.parents))
591
 
        except errors.NoSuchRevision:
592
 
            # one or more ghosts, slow path.
593
 
            revtrees = []
594
 
            for revision_id in self.parents:
595
 
                try:
596
 
                    revtrees.append(self.repository.revision_tree(revision_id))
597
 
                except errors.NoSuchRevision:
598
 
                    if not revtrees:
599
 
                        basis_revision_id = _mod_revision.NULL_REVISION
600
 
                        ghost_basis = True
601
 
                    revtrees.append(self.repository.revision_tree(
602
 
                        _mod_revision.NULL_REVISION))
603
 
        # The basis inventory from a repository 
604
 
        if revtrees:
605
 
            basis_inv = revtrees[0].inventory
606
 
        else:
607
 
            basis_inv = self.repository.revision_tree(
608
 
                _mod_revision.NULL_REVISION).inventory
609
 
        if len(self.parents) > 0:
610
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
611
 
                raise Exception(
612
 
                    "arbitrary basis parents not yet supported with merges")
613
 
            for revtree in revtrees[1:]:
614
 
                for change in revtree.inventory._make_delta(basis_inv):
615
 
                    if change[1] is None:
616
 
                        # Not present in this parent.
617
 
                        continue
618
 
                    if change[2] not in merged_ids:
619
 
                        if change[0] is not None:
620
 
                            basis_entry = basis_inv[change[2]]
621
 
                            merged_ids[change[2]] = [
622
 
                                # basis revid
623
 
                                basis_entry.revision,
624
 
                                # new tree revid
625
 
                                change[3].revision]
626
 
                            parent_entries[change[2]] = {
627
 
                                # basis parent
628
 
                                basis_entry.revision:basis_entry,
629
 
                                # this parent 
630
 
                                change[3].revision:change[3],
631
 
                                }
632
 
                        else:
633
 
                            merged_ids[change[2]] = [change[3].revision]
634
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
635
 
                    else:
636
 
                        merged_ids[change[2]].append(change[3].revision)
637
 
                        parent_entries[change[2]][change[3].revision] = change[3]
638
 
        else:
639
 
            merged_ids = {}
640
 
        # Setup the changes from the tree:
641
 
        # changes maps file_id -> (change, [parent revision_ids])
642
 
        changes= {}
643
 
        for change in iter_changes:
644
 
            # This probably looks up in basis_inv way to much.
645
 
            if change[1][0] is not None:
646
 
                head_candidate = [basis_inv[change[0]].revision]
647
 
            else:
648
 
                head_candidate = []
649
 
            changes[change[0]] = change, merged_ids.get(change[0],
650
 
                head_candidate)
651
 
        unchanged_merged = set(merged_ids) - set(changes)
652
 
        # Extend the changes dict with synthetic changes to record merges of
653
 
        # texts.
654
 
        for file_id in unchanged_merged:
655
 
            # Record a merged version of these items that did not change vs the
656
 
            # basis. This can be either identical parallel changes, or a revert
657
 
            # of a specific file after a merge. The recorded content will be
658
 
            # that of the current tree (which is the same as the basis), but
659
 
            # the per-file graph will reflect a merge.
660
 
            # NB:XXX: We are reconstructing path information we had, this
661
 
            # should be preserved instead.
662
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
663
 
            #   changed_content, versioned, parent, name, kind,
664
 
            #   executable)
665
 
            try:
666
 
                basis_entry = basis_inv[file_id]
667
 
            except errors.NoSuchId:
668
 
                # a change from basis->some_parents but file_id isn't in basis
669
 
                # so was new in the merge, which means it must have changed
670
 
                # from basis -> current, and as it hasn't the add was reverted
671
 
                # by the user. So we discard this change.
672
 
                pass
673
 
            else:
674
 
                change = (file_id,
675
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
676
 
                    False, (True, True),
677
 
                    (basis_entry.parent_id, basis_entry.parent_id),
678
 
                    (basis_entry.name, basis_entry.name),
679
 
                    (basis_entry.kind, basis_entry.kind),
680
 
                    (basis_entry.executable, basis_entry.executable))
681
 
                changes[file_id] = (change, merged_ids[file_id])
682
 
        # changes contains tuples with the change and a set of inventory
683
 
        # candidates for the file.
684
 
        # inv delta is:
685
 
        # old_path, new_path, file_id, new_inventory_entry
686
 
        seen_root = False # Is the root in the basis delta?
687
 
        inv_delta = self._basis_delta
688
 
        modified_rev = self._new_revision_id
689
 
        for change, head_candidates in changes.values():
690
 
            if change[3][1]: # versioned in target.
691
 
                # Several things may be happening here:
692
 
                # We may have a fork in the per-file graph
693
 
                #  - record a change with the content from tree
694
 
                # We may have a change against < all trees  
695
 
                #  - carry over the tree that hasn't changed
696
 
                # We may have a change against all trees
697
 
                #  - record the change with the content from tree
698
 
                kind = change[6][1]
699
 
                file_id = change[0]
700
 
                entry = _entry_factory[kind](file_id, change[5][1],
701
 
                    change[4][1])
702
 
                head_set = self._heads(change[0], set(head_candidates))
703
 
                heads = []
704
 
                # Preserve ordering.
705
 
                for head_candidate in head_candidates:
706
 
                    if head_candidate in head_set:
707
 
                        heads.append(head_candidate)
708
 
                        head_set.remove(head_candidate)
709
 
                carried_over = False
710
 
                if len(heads) == 1:
711
 
                    # Could be a carry-over situation:
712
 
                    parent_entry_revs = parent_entries.get(file_id, None)
713
 
                    if parent_entry_revs:
714
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
715
 
                    else:
716
 
                        parent_entry = None
717
 
                    if parent_entry is None:
718
 
                        # The parent iter_changes was called against is the one
719
 
                        # that is the per-file head, so any change is relevant
720
 
                        # iter_changes is valid.
721
 
                        carry_over_possible = False
722
 
                    else:
723
 
                        # could be a carry over situation
724
 
                        # A change against the basis may just indicate a merge,
725
 
                        # we need to check the content against the source of the
726
 
                        # merge to determine if it was changed after the merge
727
 
                        # or carried over.
728
 
                        if (parent_entry.kind != entry.kind or
729
 
                            parent_entry.parent_id != entry.parent_id or
730
 
                            parent_entry.name != entry.name):
731
 
                            # Metadata common to all entries has changed
732
 
                            # against per-file parent
733
 
                            carry_over_possible = False
734
 
                        else:
735
 
                            carry_over_possible = True
736
 
                        # per-type checks for changes against the parent_entry
737
 
                        # are done below.
738
 
                else:
739
 
                    # Cannot be a carry-over situation
740
 
                    carry_over_possible = False
741
 
                # Populate the entry in the delta
742
 
                if kind == 'file':
743
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
744
 
                    # after iter_changes examines and decides it has changed,
745
 
                    # we will unconditionally record a new version even if some
746
 
                    # other process reverts it while commit is running (with
747
 
                    # the revert happening after iter_changes did it's
748
 
                    # examination).
749
 
                    if change[7][1]:
750
 
                        entry.executable = True
751
 
                    else:
752
 
                        entry.executable = False
753
 
                    if (carry_over_possible and
754
 
                        parent_entry.executable == entry.executable):
755
 
                            # Check the file length, content hash after reading
756
 
                            # the file.
757
 
                            nostore_sha = parent_entry.text_sha1
758
 
                    else:
759
 
                        nostore_sha = None
760
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
761
 
                    try:
762
 
                        text = file_obj.read()
763
 
                    finally:
764
 
                        file_obj.close()
765
 
                    try:
766
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
767
 
                            file_id, text, heads, nostore_sha)
768
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
769
 
                    except errors.ExistingContent:
770
 
                        # No content change against a carry_over parent
771
 
                        # Perhaps this should also yield a fs hash update?
772
 
                        carried_over = True
773
 
                        entry.text_size = parent_entry.text_size
774
 
                        entry.text_sha1 = parent_entry.text_sha1
775
 
                elif kind == 'symlink':
776
 
                    # Wants a path hint?
777
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
778
 
                    if (carry_over_possible and
779
 
                        parent_entry.symlink_target == entry.symlink_target):
780
 
                        carried_over = True
781
 
                    else:
782
 
                        self._add_text_to_weave(change[0], '', heads, None)
783
 
                elif kind == 'directory':
784
 
                    if carry_over_possible:
785
 
                        carried_over = True
786
 
                    else:
787
 
                        # Nothing to set on the entry.
788
 
                        # XXX: split into the Root and nonRoot versions.
789
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
790
 
                            self._add_text_to_weave(change[0], '', heads, None)
791
 
                elif kind == 'tree-reference':
792
 
                    if not self.repository._format.supports_tree_reference:
793
 
                        # This isn't quite sane as an error, but we shouldn't
794
 
                        # ever see this code path in practice: tree's don't
795
 
                        # permit references when the repo doesn't support tree
796
 
                        # references.
797
 
                        raise errors.UnsupportedOperation(tree.add_reference,
798
 
                            self.repository)
799
 
                    reference_revision = tree.get_reference_revision(change[0])
800
 
                    entry.reference_revision = reference_revision
801
 
                    if (carry_over_possible and
802
 
                        parent_entry.reference_revision == reference_revision):
803
 
                        carried_over = True
804
 
                    else:
805
 
                        self._add_text_to_weave(change[0], '', heads, None)
806
 
                else:
807
 
                    raise AssertionError('unknown kind %r' % kind)
808
 
                if not carried_over:
809
 
                    entry.revision = modified_rev
810
 
                else:
811
 
                    entry.revision = parent_entry.revision
812
 
            else:
813
 
                entry = None
814
 
            new_path = change[1][1]
815
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
816
 
            if new_path == '':
817
 
                seen_root = True
818
 
        self.new_inventory = None
819
 
        if len(inv_delta):
820
 
            # This should perhaps be guarded by a check that the basis we
821
 
            # commit against is the basis for the commit and if not do a delta
822
 
            # against the basis.
823
 
            self._any_changes = True
824
 
        if not seen_root:
825
 
            # housekeeping root entry changes do not affect no-change commits.
826
 
            self._require_root_change(tree)
827
 
        self.basis_delta_revision = basis_revision_id
828
 
 
829
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
830
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
831
 
        return self.repository.texts._add_text(
832
 
            (file_id, self._new_revision_id), parent_keys, new_text,
833
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
416
            return versionedfile.add_lines_with_ghosts(
 
417
                self._new_revision_id, parents, new_lines,
 
418
                nostore_sha=nostore_sha, random_id=self.random_revid,
 
419
                check_content=False)[0:2]
 
420
        finally:
 
421
            versionedfile.clear_cache()
834
422
 
835
423
 
836
424
class RootCommitBuilder(CommitBuilder):
837
425
    """This commitbuilder actually records the root id"""
838
 
 
 
426
    
839
427
    # the root entry gets versioned properly by this builder.
840
428
    _versioned_root = True
841
429
 
848
436
        :param tree: The tree that is being committed.
849
437
        """
850
438
 
851
 
    def _require_root_change(self, tree):
852
 
        """Enforce an appropriate root object change.
853
 
 
854
 
        This is called once when record_iter_changes is called, if and only if
855
 
        the root was not in the delta calculated by record_iter_changes.
856
 
 
857
 
        :param tree: The tree which is being committed.
858
 
        """
859
 
        # versioned roots do not change unless the tree found a change.
860
 
 
861
439
 
862
440
######################################################################
863
441
# Repositories
864
442
 
865
 
 
866
 
class Repository(_RelockDebugMixin):
 
443
class Repository(object):
867
444
    """Repository holding history for one or more branches.
868
445
 
869
446
    The repository holds and retrieves historical information including
870
447
    revisions and file history.  It's normally accessed only by the Branch,
871
448
    which views a particular line of development through that history.
872
449
 
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
    The Repository builds on top of Stores and a Transport, which respectively 
 
451
    describe the disk data format and the way of accessing the (possibly 
876
452
    remote) disk.
877
 
 
878
 
    The byte storage facilities are addressed via tuples, which we refer to
879
 
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
880
 
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
881
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
882
 
    byte string made up of a hash identifier and a hash value.
883
 
    We use this interface because it allows low friction with the underlying
884
 
    code that implements disk indices, network encoding and other parts of
885
 
    bzrlib.
886
 
 
887
 
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
888
 
        the serialised revisions for the repository. This can be used to obtain
889
 
        revision graph information or to access raw serialised revisions.
890
 
        The result of trying to insert data into the repository via this store
891
 
        is undefined: it should be considered read-only except for implementors
892
 
        of repositories.
893
 
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
894
 
        the serialised signatures for the repository. This can be used to
895
 
        obtain access to raw serialised signatures.  The result of trying to
896
 
        insert data into the repository via this store is undefined: it should
897
 
        be considered read-only except for implementors of repositories.
898
 
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
899
 
        the serialised inventories for the repository. This can be used to
900
 
        obtain unserialised inventories.  The result of trying to insert data
901
 
        into the repository via this store is undefined: it should be
902
 
        considered read-only except for implementors of repositories.
903
 
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
904
 
        texts of files and directories for the repository. This can be used to
905
 
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
906
 
        is usually a better interface for accessing file texts.
907
 
        The result of trying to insert data into the repository via this store
908
 
        is undefined: it should be considered read-only except for implementors
909
 
        of repositories.
910
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
911
 
        any data the repository chooses to store or have indexed by its hash.
912
 
        The result of trying to insert data into the repository via this store
913
 
        is undefined: it should be considered read-only except for implementors
914
 
        of repositories.
915
 
    :ivar _transport: Transport for file access to repository, typically
916
 
        pointing to .bzr/repository.
917
453
    """
918
454
 
919
455
    # What class to use for a CommitBuilder. Often its simpler to change this
927
463
        r'.* revision="(?P<revision_id>[^"]+)"'
928
464
        )
929
465
 
930
 
    def abort_write_group(self, suppress_errors=False):
 
466
    def abort_write_group(self):
931
467
        """Commit the contents accrued within the current write group.
932
468
 
933
 
        :param suppress_errors: if true, abort_write_group will catch and log
934
 
            unexpected errors that happen during the abort, rather than
935
 
            allowing them to propagate.  Defaults to False.
936
 
 
937
469
        :seealso: start_write_group.
938
470
        """
939
471
        if self._write_group is not self.get_transaction():
940
472
            # has an unlock or relock occured ?
941
 
            if suppress_errors:
942
 
                mutter(
943
 
                '(suppressed) mismatched lock context and write group. %r, %r',
944
 
                self._write_group, self.get_transaction())
945
 
                return
946
 
            raise errors.BzrError(
947
 
                'mismatched lock context and write group. %r, %r' %
948
 
                (self._write_group, self.get_transaction()))
949
 
        try:
950
 
            self._abort_write_group()
951
 
        except Exception, exc:
952
 
            self._write_group = None
953
 
            if not suppress_errors:
954
 
                raise
955
 
            mutter('abort_write_group failed')
956
 
            log_exception_quietly()
957
 
            note('bzr: ERROR (ignored): %s', exc)
 
473
            raise errors.BzrError('mismatched lock context and write group.')
 
474
        self._abort_write_group()
958
475
        self._write_group = None
959
476
 
960
477
    def _abort_write_group(self):
961
478
        """Template method for per-repository write group cleanup.
962
 
 
963
 
        This is called during abort before the write group is considered to be
 
479
        
 
480
        This is called during abort before the write group is considered to be 
964
481
        finished and should cleanup any internal state accrued during the write
965
482
        group. There is no requirement that data handed to the repository be
966
483
        *not* made available - this is not a rollback - but neither should any
970
487
        attempted.
971
488
        """
972
489
 
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
 
 
 
490
    @needs_write_lock
1002
491
    def add_inventory(self, revision_id, inv, parents):
1003
492
        """Add the inventory inv to the repository as revision_id.
1004
 
 
 
493
        
1005
494
        :param parents: The revision ids of the parents that revision_id
1006
495
                        is known to have and are in the repository already.
1007
496
 
1008
 
        :returns: The validator(which is a sha1 digest, though what is sha'd is
1009
 
            repository format specific) of the serialized inventory.
 
497
        returns the sha1 of the serialized inventory.
1010
498
        """
1011
 
        if not self.is_in_write_group():
1012
 
            raise AssertionError("%r not in write group" % (self,))
 
499
        assert self.is_in_write_group()
1013
500
        _mod_revision.check_not_reserved_id(revision_id)
1014
 
        if not (inv.revision_id is None or inv.revision_id == revision_id):
1015
 
            raise AssertionError(
1016
 
                "Mismatch between inventory revision"
1017
 
                " id and insertion revid (%r, %r)"
1018
 
                % (inv.revision_id, revision_id))
1019
 
        if inv.root is None:
1020
 
            raise AssertionError()
1021
 
        return self._add_inventory_checked(revision_id, inv, parents)
1022
 
 
1023
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1024
 
        """Add inv to the repository after checking the inputs.
1025
 
 
1026
 
        This function can be overridden to allow different inventory styles.
1027
 
 
1028
 
        :seealso: add_inventory, for the contract.
1029
 
        """
1030
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
1031
 
        return self._inventory_add_lines(revision_id, parents,
 
501
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
502
            "Mismatch between inventory revision" \
 
503
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
504
        assert inv.root is not None
 
505
        inv_lines = self._serialise_inventory_to_lines(inv)
 
506
        inv_vf = self.get_inventory_weave()
 
507
        return self._inventory_add_lines(inv_vf, revision_id, parents,
1032
508
            inv_lines, check_content=False)
1033
509
 
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,
 
510
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
1082
511
        check_content=True):
1083
512
        """Store lines in inv_vf and return the sha1 of the inventory."""
1084
 
        parents = [(parent,) for parent in parents]
1085
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
513
        final_parents = []
 
514
        for parent in parents:
 
515
            if parent in inv_vf:
 
516
                final_parents.append(parent)
 
517
        return inv_vf.add_lines(revision_id, final_parents, lines,
1086
518
            check_content=check_content)[0]
1087
 
        self.inventories._access.flush()
1088
 
        return result
1089
519
 
 
520
    @needs_write_lock
1090
521
    def add_revision(self, revision_id, rev, inv=None, config=None):
1091
522
        """Add rev to the revision store as revision_id.
1092
523
 
1107
538
            plaintext = Testament(rev, inv).as_short_text()
1108
539
            self.store_revision_signature(
1109
540
                gpg.GPGStrategy(config), plaintext, revision_id)
1110
 
        # check inventory present
1111
 
        if not self.inventories.get_parent_map([(revision_id,)]):
 
541
        if not revision_id in self.get_inventory_weave():
1112
542
            if inv is None:
1113
543
                raise errors.WeaveRevisionNotPresent(revision_id,
1114
 
                                                     self.inventories)
 
544
                                                     self.get_inventory_weave())
1115
545
            else:
1116
546
                # yes, this is not suitable for adding with ghosts.
1117
 
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1118
 
                                                        rev.parent_ids)
1119
 
        else:
1120
 
            key = (revision_id,)
1121
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1122
 
        self._add_revision(rev)
 
547
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
548
        self._revision_store.add_revision(rev, self.get_transaction())
1123
549
 
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))
 
550
    def _add_revision_text(self, revision_id, text):
 
551
        revision = self._revision_store._serializer.read_revision_from_string(
 
552
            text)
 
553
        self._revision_store._add_revision(revision, StringIO(text),
 
554
                                           self.get_transaction())
1129
555
 
1130
556
    def all_revision_ids(self):
1131
 
        """Returns a list of all the revision ids in the repository.
 
557
        """Returns a list of all the revision ids in the repository. 
1132
558
 
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.
 
559
        This is deprecated because code should generally work on the graph
 
560
        reachable from a particular revision, and ignore any other revisions
 
561
        that might be present.  There is no direct replacement method.
1137
562
        """
1138
563
        if 'evil' in debug.debug_flags:
1139
564
            mutter_callsite(2, "all_revision_ids is linear with history.")
1140
565
        return self._all_revision_ids()
1141
566
 
1142
567
    def _all_revision_ids(self):
1143
 
        """Returns a list of all the revision ids in the repository.
 
568
        """Returns a list of all the revision ids in the repository. 
1144
569
 
1145
 
        These are in as much topological order as the underlying store can
 
570
        These are in as much topological order as the underlying store can 
1146
571
        present.
1147
572
        """
1148
573
        raise NotImplementedError(self._all_revision_ids)
1162
587
        Returns a set of the present revisions.
1163
588
        """
1164
589
        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]))
 
590
        for id in revision_ids:
 
591
            if self.has_revision(id):
 
592
               result.append(id)
 
593
        return result
1282
594
 
1283
595
    @staticmethod
1284
596
    def create(a_bzrdir):
1285
597
        """Construct the current default format repository in a_bzrdir."""
1286
598
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
1287
599
 
1288
 
    def __init__(self, _format, a_bzrdir, control_files):
 
600
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
1289
601
        """instantiate a Repository.
1290
602
 
1291
603
        :param _format: The format of the repository on disk.
1300
612
        # the following are part of the public API for Repository:
1301
613
        self.bzrdir = a_bzrdir
1302
614
        self.control_files = control_files
1303
 
        self._transport = control_files._transport
1304
 
        self.base = self._transport.base
 
615
        self._revision_store = _revision_store
 
616
        # backwards compatibility
 
617
        self.weave_store = text_store
1305
618
        # for tests
1306
619
        self._reconcile_does_inventory_gc = True
1307
620
        self._reconcile_fixes_text_parents = False
1308
621
        self._reconcile_backsup_inventory = True
 
622
        # not right yet - should be more semantically clear ? 
 
623
        # 
 
624
        self.control_store = control_store
 
625
        self.control_weaves = control_store
 
626
        # TODO: make sure to construct the right store classes, etc, depending
 
627
        # on whether escaping is required.
 
628
        self._warn_if_deprecated()
1309
629
        self._write_group = None
1310
 
        # Additional places to query for data.
1311
 
        self._fallback_repositories = []
1312
 
        # An InventoryEntry cache, used during deserialization
1313
 
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1314
 
        # Is it safe to return inventory entries directly from the entry cache,
1315
 
        # rather copying them?
1316
 
        self._safe_to_return_from_cache = False
 
630
        self.base = control_files._transport.base
1317
631
 
1318
632
    def __repr__(self):
1319
 
        if self._fallback_repositories:
1320
 
            return '%s(%r, fallback_repositories=%r)' % (
1321
 
                self.__class__.__name__,
1322
 
                self.base,
1323
 
                self._fallback_repositories)
1324
 
        else:
1325
 
            return '%s(%r)' % (self.__class__.__name__,
1326
 
                               self.base)
1327
 
 
1328
 
    def _has_same_fallbacks(self, other_repo):
1329
 
        """Returns true if the repositories have the same fallbacks."""
1330
 
        my_fb = self._fallback_repositories
1331
 
        other_fb = other_repo._fallback_repositories
1332
 
        if len(my_fb) != len(other_fb):
1333
 
            return False
1334
 
        for f, g in zip(my_fb, other_fb):
1335
 
            if not f.has_same_location(g):
1336
 
                return False
1337
 
        return True
 
633
        return '%s(%r)' % (self.__class__.__name__,
 
634
                           self.base)
1338
635
 
1339
636
    def has_same_location(self, other):
1340
637
        """Returns a boolean indicating if this repository is at the same
1345
642
        """
1346
643
        if self.__class__ is not other.__class__:
1347
644
            return False
1348
 
        return (self._transport.base == other._transport.base)
 
645
        return (self.control_files._transport.base ==
 
646
                other.control_files._transport.base)
1349
647
 
1350
648
    def is_in_write_group(self):
1351
649
        """Return True if there is an open write group.
1367
665
        This causes caching within the repository obejct to start accumlating
1368
666
        data during reads, and allows a 'write_group' to be obtained. Write
1369
667
        groups must be used for actual data insertion.
1370
 
 
 
668
        
1371
669
        :param token: if this is already locked, then lock_write will fail
1372
670
            unless the token matches the existing lock.
1373
671
        :returns: a token if this instance supports tokens, otherwise None.
1383
681
 
1384
682
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1385
683
        """
1386
 
        locked = self.is_locked()
1387
684
        result = self.control_files.lock_write(token=token)
1388
 
        if not locked:
1389
 
            self._warn_if_deprecated()
1390
 
            self._note_lock('w')
1391
 
            for repo in self._fallback_repositories:
1392
 
                # Writes don't affect fallback repos
1393
 
                repo.lock_read()
1394
 
            self._refresh_data()
 
685
        self._refresh_data()
1395
686
        return result
1396
687
 
1397
688
    def lock_read(self):
1398
 
        locked = self.is_locked()
1399
689
        self.control_files.lock_read()
1400
 
        if not locked:
1401
 
            self._warn_if_deprecated()
1402
 
            self._note_lock('r')
1403
 
            for repo in self._fallback_repositories:
1404
 
                repo.lock_read()
1405
 
            self._refresh_data()
 
690
        self._refresh_data()
1406
691
 
1407
692
    def get_physical_lock_status(self):
1408
693
        return self.control_files.get_physical_lock_status()
1410
695
    def leave_lock_in_place(self):
1411
696
        """Tell this repository not to release the physical lock when this
1412
697
        object is unlocked.
1413
 
 
 
698
        
1414
699
        If lock_write doesn't return a token, then this method is not supported.
1415
700
        """
1416
701
        self.control_files.leave_in_place()
1467
752
                last_revision.timezone)
1468
753
 
1469
754
        # now gather global repository information
1470
 
        # XXX: This is available for many repos regardless of listability.
1471
755
        if self.bzrdir.root_transport.listable():
1472
 
            # XXX: do we want to __define len__() ?
1473
 
            # Maybe the versionedfiles object should provide a different
1474
 
            # method to get the number of keys.
1475
 
            result['revisions'] = len(self.revisions.keys())
1476
 
            # result['size'] = t
 
756
            c, t = self._revision_store.total_size(self.get_transaction())
 
757
            result['revisions'] = c
 
758
            result['size'] = t
1477
759
        return result
1478
760
 
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.
 
761
    def get_data_stream(self, revision_ids):
 
762
        raise NotImplementedError(self.get_data_stream)
 
763
 
 
764
    def insert_data_stream(self, stream):
 
765
        """XXX What does this really do? 
 
766
        
 
767
        Is it a substitute for fetch? 
 
768
        Should it manage its own write group ?
1485
769
        """
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
 
770
        for item_key, bytes in stream:
 
771
            if item_key[0] == 'file':
 
772
                (file_id,) = item_key[1:]
 
773
                knit = self.weave_store.get_weave_or_empty(
 
774
                    file_id, self.get_transaction())
 
775
            elif item_key == ('inventory',):
 
776
                knit = self.get_inventory_weave()
 
777
            elif item_key == ('revisions',):
 
778
                knit = self._revision_store.get_revision_file(
 
779
                    self.get_transaction())
 
780
            elif item_key == ('signatures',):
 
781
                knit = self._revision_store.get_signature_file(
 
782
                    self.get_transaction())
 
783
            else:
 
784
                raise RepositoryDataStreamError(
 
785
                    "Unrecognised data stream key '%s'" % (item_key,))
 
786
            decoded_list = bencode.bdecode(bytes)
 
787
            format = decoded_list.pop(0)
 
788
            data_list = []
 
789
            knit_bytes = ''
 
790
            for version, options, parents, some_bytes in decoded_list:
 
791
                data_list.append((version, options, len(some_bytes), parents))
 
792
                knit_bytes += some_bytes
 
793
            knit.insert_data_stream(
 
794
                (format, data_list, StringIO(knit_bytes).read))
1515
795
 
1516
796
    @needs_read_lock
1517
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
797
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1518
798
        """Return the revision ids that other has that this does not.
1519
 
 
 
799
        
1520
800
        These are returned in topological order.
1521
801
 
1522
802
        revision_id: only return revision ids included by revision_id.
1523
803
        """
1524
 
        return InterRepository.get(other, self).search_missing_revision_ids(
 
804
        return InterRepository.get(other, self).missing_revision_ids(
1525
805
            revision_id, find_ghosts)
1526
806
 
1527
807
    @staticmethod
1536
816
 
1537
817
    def copy_content_into(self, destination, revision_id=None):
1538
818
        """Make a complete copy of the content in self into destination.
1539
 
 
1540
 
        This is a destructive operation! Do not use it on existing
 
819
        
 
820
        This is a destructive operation! Do not use it on existing 
1541
821
        repositories.
1542
822
        """
1543
823
        return InterRepository.get(self, destination).copy_content(revision_id)
1546
826
        """Commit the contents accrued within the current write group.
1547
827
 
1548
828
        :seealso: start_write_group.
1549
 
        
1550
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1551
829
        """
1552
830
        if self._write_group is not self.get_transaction():
1553
831
            # has an unlock or relock occured ?
1554
832
            raise errors.BzrError('mismatched lock context %r and '
1555
833
                'write group %r.' %
1556
834
                (self.get_transaction(), self._write_group))
1557
 
        result = self._commit_write_group()
 
835
        self._commit_write_group()
1558
836
        self._write_group = None
1559
 
        return result
1560
837
 
1561
838
    def _commit_write_group(self):
1562
839
        """Template method for per-repository write group cleanup.
1563
 
 
1564
 
        This is called before the write group is considered to be
 
840
        
 
841
        This is called before the write group is considered to be 
1565
842
        finished and should ensure that all data handed to the repository
1566
 
        for writing during the write group is safely committed (to the
 
843
        for writing during the write group is safely committed (to the 
1567
844
        extent possible considering file system caching etc).
1568
845
        """
1569
846
 
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):
 
847
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
1655
848
        """Fetch the content required to construct revision_id from source.
1656
849
 
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
 
 
 
850
        If revision_id is None all content is copied.
1664
851
        :param find_ghosts: Find and copy revisions in the source that are
1665
852
            ghosts in the target (and not reachable directly by walking out to
1666
853
            the first-present revision in target from revision_id).
1667
 
        :param revision_id: If specified, all the content needed for this
1668
 
            revision ID will be copied to the target.  Fetch will determine for
1669
 
            itself which content needs to be copied.
1670
 
        :param fetch_spec: If specified, a SearchResult or
1671
 
            PendingAncestryResult that describes which revisions to copy.  This
1672
 
            allows copying multiple heads at once.  Mutually exclusive with
1673
 
            revision_id.
1674
854
        """
1675
 
        if fetch_spec is not None and revision_id is not None:
1676
 
            raise AssertionError(
1677
 
                "fetch_spec and revision_id are mutually exclusive.")
1678
 
        if self.is_in_write_group():
1679
 
            raise errors.InternalBzrError(
1680
 
                "May not fetch while in a write group.")
1681
855
        # fast path same-url fetch operations
1682
 
        # TODO: lift out to somewhere common with RemoteRepository
1683
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1684
 
        if (self.has_same_location(source)
1685
 
            and fetch_spec is None
1686
 
            and self._has_same_fallbacks(source)):
 
856
        if self.has_same_location(source):
1687
857
            # check that last_revision is in 'from' and then return a
1688
858
            # no-operation.
1689
859
            if (revision_id is not None and
1690
860
                not _mod_revision.is_null(revision_id)):
1691
861
                self.get_revision(revision_id)
1692
862
            return 0, []
1693
 
        # if there is no specific appropriate InterRepository, this will get
1694
 
        # the InterRepository base class, which raises an
1695
 
        # IncompatibleRepositories when asked to fetch.
1696
863
        inter = InterRepository.get(source, self)
1697
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1698
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
864
        try:
 
865
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
866
        except NotImplementedError:
 
867
            raise errors.IncompatibleRepositories(source, self)
1699
868
 
1700
869
    def create_bundle(self, target, base, fileobj, format=None):
1701
870
        return serializer.write_bundle(self, target, base, fileobj, format)
1704
873
                           timezone=None, committer=None, revprops=None,
1705
874
                           revision_id=None):
1706
875
        """Obtain a CommitBuilder for this repository.
1707
 
 
 
876
        
1708
877
        :param branch: Branch to commit to.
1709
878
        :param parents: Revision ids of the parents of the new revision.
1710
879
        :param config: Configuration to use.
1714
883
        :param revprops: Optional dictionary of revision properties.
1715
884
        :param revision_id: Optional revision id.
1716
885
        """
1717
 
        if self._fallback_repositories:
1718
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1719
 
                "to a stacked branch. See "
1720
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1721
886
        result = self._commit_builder_class(self, parents, config,
1722
887
            timestamp, timezone, committer, revprops, revision_id)
1723
888
        self.start_write_group()
1724
889
        return result
1725
890
 
1726
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1727
891
    def unlock(self):
1728
892
        if (self.control_files._lock_count == 1 and
1729
893
            self.control_files._lock_mode == 'w'):
1733
897
                raise errors.BzrError(
1734
898
                    'Must end write groups before releasing write locks.')
1735
899
        self.control_files.unlock()
1736
 
        if self.control_files._lock_count == 0:
1737
 
            self._inventory_entry_cache.clear()
1738
 
            for repo in self._fallback_repositories:
1739
 
                repo.unlock()
1740
900
 
1741
901
    @needs_read_lock
1742
902
    def clone(self, a_bzrdir, revision_id=None):
1777
937
 
1778
938
    def _start_write_group(self):
1779
939
        """Template method for per-repository write group startup.
1780
 
 
1781
 
        This is called before the write group is considered to be
 
940
        
 
941
        This is called before the write group is considered to be 
1782
942
        entered.
1783
943
        """
1784
944
 
1805
965
                dest_repo = a_bzrdir.open_repository()
1806
966
        return dest_repo
1807
967
 
1808
 
    def _get_sink(self):
1809
 
        """Return a sink for streaming into this repository."""
1810
 
        return StreamSink(self)
1811
 
 
1812
 
    def _get_source(self, to_format):
1813
 
        """Return a source for streaming from this repository."""
1814
 
        return StreamSource(self, to_format)
1815
 
 
1816
968
    @needs_read_lock
1817
969
    def has_revision(self, revision_id):
1818
970
        """True if this repository has a copy of the revision."""
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
        if 'evil' in debug.debug_flags:
 
972
            mutter_callsite(3, "has_revision is a LBYL symptom.")
 
973
        return self._revision_store.has_revision_id(revision_id,
 
974
                                                    self.get_transaction())
1835
975
 
1836
976
    @needs_read_lock
1837
977
    def get_revision(self, revision_id):
1841
981
    @needs_read_lock
1842
982
    def get_revision_reconcile(self, revision_id):
1843
983
        """'reconcile' helper routine that allows access to a revision always.
1844
 
 
 
984
        
1845
985
        This variant of get_revision does not cross check the weave graph
1846
986
        against the revision one as get_revision does: but it should only
1847
987
        be used by reconcile, or reconcile-alike commands that are correcting
1851
991
 
1852
992
    @needs_read_lock
1853
993
    def get_revisions(self, revision_ids):
1854
 
        """Get many revisions at once.
1855
 
        
1856
 
        Repositories that need to check data on every revision read should 
1857
 
        subclass this method.
1858
 
        """
 
994
        """Get many revisions at once."""
1859
995
        return self._get_revisions(revision_ids)
1860
996
 
1861
997
    @needs_read_lock
1862
998
    def _get_revisions(self, revision_ids):
1863
999
        """Core work logic to get many revisions without sanity checks."""
1864
 
        revs = {}
1865
 
        for revid, rev in self._iter_revisions(revision_ids):
1866
 
            if rev is None:
1867
 
                raise errors.NoSuchRevision(self, revid)
1868
 
            revs[revid] = rev
1869
 
        return [revs[revid] for revid in revision_ids]
1870
 
 
1871
 
    def _iter_revisions(self, revision_ids):
1872
 
        """Iterate over revision objects.
1873
 
 
1874
 
        :param revision_ids: An iterable of revisions to examine. None may be
1875
 
            passed to request all revisions known to the repository. Note that
1876
 
            not all repositories can find unreferenced revisions; for those
1877
 
            repositories only referenced ones will be returned.
1878
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1879
 
            those asked for but not available) are returned as (revid, None).
1880
 
        """
1881
 
        if revision_ids is None:
1882
 
            revision_ids = self.all_revision_ids()
1883
 
        else:
1884
 
            for rev_id in revision_ids:
1885
 
                if not rev_id or not isinstance(rev_id, basestring):
1886
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1887
 
        keys = [(key,) for key in revision_ids]
1888
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1889
 
        for record in stream:
1890
 
            revid = record.key[0]
1891
 
            if record.storage_kind == 'absent':
1892
 
                yield (revid, None)
1893
 
            else:
1894
 
                text = record.get_bytes_as('fulltext')
1895
 
                rev = self._serializer.read_revision_from_string(text)
1896
 
                yield (revid, rev)
1897
 
 
1898
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1000
        for rev_id in revision_ids:
 
1001
            if not rev_id or not isinstance(rev_id, basestring):
 
1002
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1003
        revs = self._revision_store.get_revisions(revision_ids,
 
1004
                                                  self.get_transaction())
 
1005
        for rev in revs:
 
1006
            assert not isinstance(rev.revision_id, unicode)
 
1007
            for parent_id in rev.parent_ids:
 
1008
                assert not isinstance(parent_id, unicode)
 
1009
        return revs
 
1010
 
 
1011
    @needs_read_lock
 
1012
    def get_revision_xml(self, revision_id):
 
1013
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1014
        #       would have already do it.
 
1015
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1016
        rev = self.get_revision(revision_id)
 
1017
        rev_tmp = StringIO()
 
1018
        # the current serializer..
 
1019
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1020
        rev_tmp.seek(0)
 
1021
        return rev_tmp.getvalue()
 
1022
 
 
1023
    @needs_read_lock
 
1024
    def get_deltas_for_revisions(self, revisions):
1899
1025
        """Produce a generator of revision deltas.
1900
 
 
 
1026
        
1901
1027
        Note that the input is a sequence of REVISIONS, not revision_ids.
1902
1028
        Trees will be held in memory until the generator exits.
1903
1029
        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.
1908
1030
        """
1909
 
        # Get the revision-ids of interest
1910
1031
        required_trees = set()
1911
1032
        for revision in revisions:
1912
1033
            required_trees.add(revision.revision_id)
1913
1034
            required_trees.update(revision.parent_ids[:1])
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
 
1035
        trees = dict((t.get_revision_id(), t) for 
 
1036
                     t in self.revision_trees(required_trees))
1930
1037
        for revision in revisions:
1931
1038
            if not revision.parent_ids:
1932
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1039
                old_tree = self.revision_tree(None)
1933
1040
            else:
1934
1041
                old_tree = trees[revision.parent_ids[0]]
1935
1042
            yield trees[revision.revision_id].changes_from(old_tree)
1936
1043
 
1937
1044
    @needs_read_lock
1938
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1045
    def get_revision_delta(self, revision_id):
1939
1046
        """Return the delta for one revision.
1940
1047
 
1941
1048
        The delta is relative to the left-hand predecessor of the
1942
1049
        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.
1947
1050
        """
1948
1051
        r = self.get_revision(revision_id)
1949
 
        return list(self.get_deltas_for_revisions([r],
1950
 
            specific_fileids=specific_fileids))[0]
 
1052
        return list(self.get_deltas_for_revisions([r]))[0]
1951
1053
 
1952
1054
    @needs_write_lock
1953
1055
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1956
1058
 
1957
1059
    @needs_write_lock
1958
1060
    def add_signature_text(self, revision_id, signature):
1959
 
        self.signatures.add_lines((revision_id,), (),
1960
 
            osutils.split_lines(signature))
 
1061
        self._revision_store.add_revision_signature_text(revision_id,
 
1062
                                                         signature,
 
1063
                                                         self.get_transaction())
1961
1064
 
1962
1065
    def find_text_key_references(self):
1963
1066
        """Find the text key references within the repository.
1964
1067
 
 
1068
        :return: a dictionary mapping (file_id, revision_id) tuples to 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.
1965
1071
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1966
1072
            to whether they were referred to by the inventory of the
1967
1073
            revision_id that they contain. The inventory texts from all present
1968
1074
            revision ids are assessed to generate this report.
1969
1075
        """
1970
 
        revision_keys = self.revisions.keys()
1971
 
        w = self.inventories
 
1076
        revision_ids = self.all_revision_ids()
 
1077
        w = self.get_inventory_weave()
1972
1078
        pb = ui.ui_factory.nested_progress_bar()
1973
1079
        try:
1974
1080
            return self._find_text_key_references_from_xml_inventory_lines(
1975
 
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1081
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
1976
1082
        finally:
1977
1083
            pb.finished()
1978
1084
 
1998
1104
 
1999
1105
        # this code needs to read every new line in every inventory for the
2000
1106
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2001
 
        # not present in one of those inventories is unnecessary but not
 
1107
        # not present in one of those inventories is unnecessary but not 
2002
1108
        # harmful because we are filtering by the revision id marker in the
2003
 
        # inventory lines : we only select file ids altered in one of those
 
1109
        # inventory lines : we only select file ids altered in one of those  
2004
1110
        # revisions. We don't need to see all lines in the inventory because
2005
1111
        # only those added in an inventory in rev X can contain a revision=X
2006
1112
        # line.
2015
1121
        search = self._file_ids_altered_regex.search
2016
1122
        unescape = _unescape_xml
2017
1123
        setdefault = result.setdefault
2018
 
        for line, line_key in line_iterator:
 
1124
        for line, version_id in line_iterator:
2019
1125
            match = search(line)
2020
1126
            if match is None:
2021
1127
                continue
2052
1158
 
2053
1159
            key = (file_id, revision_id)
2054
1160
            setdefault(key, False)
2055
 
            if revision_id == line_key[-1]:
 
1161
            if revision_id == version_id:
2056
1162
                result[key] = True
2057
1163
        return result
2058
1164
 
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
1165
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2080
 
        revision_keys):
 
1166
        revision_ids):
2081
1167
        """Helper routine for fileids_altered_by_revision_ids.
2082
1168
 
2083
1169
        This performs the translation of xml lines to revision ids.
2084
1170
 
2085
1171
        :param line_iterator: An iterator of lines, origin_version_id
2086
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1172
        :param revision_ids: The revision ids to filter for. This should be a
2087
1173
            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.
 
1174
            the revision id from each parsed line will be looked up in the
 
1175
            revision_ids filter.
2090
1176
        :return: a dictionary mapping altered file-ids to an iterable of
2091
1177
        revision_ids. Each altered file-ids has the exact revision_ids that
2092
1178
        altered it listed explicitly.
2093
1179
        """
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
1180
        result = {}
2101
1181
        setdefault = result.setdefault
2102
 
        for key in new_keys:
2103
 
            setdefault(key[0], set()).add(key[-1])
 
1182
        for file_id, revision_id in \
 
1183
            self._find_text_key_references_from_xml_inventory_lines(
 
1184
                line_iterator).iterkeys():
 
1185
            # once data is all ensured-consistent; then this is
 
1186
            # if revision_id == version_id
 
1187
            if revision_id in revision_ids:
 
1188
                setdefault(file_id, set()).add(revision_id)
2104
1189
        return result
2105
1190
 
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):
 
1191
    def fileids_altered_by_revision_ids(self, revision_ids):
2134
1192
        """Find the file ids and versions affected by revisions.
2135
1193
 
2136
1194
        :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.
2139
1195
        :return: a dictionary mapping altered file-ids to an iterable of
2140
1196
        revision_ids. Each altered file-ids has the exact revision_ids that
2141
1197
        altered it listed explicitly.
2142
1198
        """
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)
 
1199
        selected_revision_ids = set(revision_ids)
 
1200
        w = self.get_inventory_weave()
 
1201
        pb = ui.ui_factory.nested_progress_bar()
 
1202
        try:
 
1203
            return self._find_file_ids_from_xml_inventory_lines(
 
1204
                w.iter_lines_added_or_present_in_versions(
 
1205
                    selected_revision_ids, pb=pb),
 
1206
                selected_revision_ids)
 
1207
        finally:
 
1208
            pb.finished()
2149
1209
 
2150
1210
    def iter_files_bytes(self, desired_files):
2151
1211
        """Iterate through file versions.
2160
1220
 
2161
1221
        bytes_iterator is an iterable of bytestrings for the file.  The
2162
1222
        kind of iterable and length of the bytestrings are unspecified, but for
2163
 
        this implementation, it is a list of bytes produced by
2164
 
        VersionedFile.get_record_stream().
 
1223
        this implementation, it is a list of lines produced by
 
1224
        VersionedFile.get_lines().
2165
1225
 
2166
1226
        :param desired_files: a list of (file_id, revision_id, identifier)
2167
1227
            triples
2168
1228
        """
2169
 
        text_keys = {}
 
1229
        transaction = self.get_transaction()
2170
1230
        for file_id, revision_id, callable_data in desired_files:
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')
 
1231
            try:
 
1232
                weave = self.weave_store.get_weave(file_id, transaction)
 
1233
            except errors.NoSuchFile:
 
1234
                raise errors.NoSuchIdInRepository(self, file_id)
 
1235
            yield callable_data, weave.get_lines(revision_id)
2176
1236
 
2177
 
    def _generate_text_key_index(self, text_key_references=None,
2178
 
        ancestors=None):
 
1237
    def _generate_text_key_index(self):
2179
1238
        """Generate a new text key index for the repository.
2180
1239
 
2181
1240
        This is an expensive function that will take considerable time to run.
2185
1244
            the parents list will be [NULL_REVISION].
2186
1245
        """
2187
1246
        # 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()
 
1247
        revision_graph = self.get_revision_graph_with_ghosts()
 
1248
        ancestors = revision_graph.get_ancestors()
 
1249
        text_key_references = self.find_text_key_references()
2193
1250
        pb = ui.ui_factory.nested_progress_bar()
2194
1251
        try:
2195
1252
            return self._do_generate_text_key_index(ancestors,
2227
1284
        batch_size = 10 # should be ~150MB on a 55K path tree
2228
1285
        batch_count = len(revision_order) / batch_size + 1
2229
1286
        processed_texts = 0
2230
 
        pb.update("Calculating text parents", processed_texts, text_count)
 
1287
        pb.update("Calculating text parents.", processed_texts, text_count)
2231
1288
        for offset in xrange(batch_count):
2232
1289
            to_query = revision_order[offset * batch_size:(offset + 1) *
2233
1290
                batch_size]
2234
1291
            if not to_query:
2235
1292
                break
2236
 
            for revision_id in to_query:
 
1293
            for rev_tree in self.revision_trees(to_query):
 
1294
                revision_id = rev_tree.get_revision_id()
2237
1295
                parent_ids = ancestors[revision_id]
2238
1296
                for text_key in revision_keys[revision_id]:
2239
 
                    pb.update("Calculating text parents", processed_texts)
 
1297
                    pb.update("Calculating text parents.", processed_texts)
2240
1298
                    processed_texts += 1
2241
1299
                    candidate_parents = []
2242
1300
                    for parent_id in parent_ids:
2258
1316
                            except KeyError:
2259
1317
                                inv = self.revision_tree(parent_id).inventory
2260
1318
                                inventory_cache[parent_id] = inv
2261
 
                            try:
2262
 
                                parent_entry = inv[text_key[0]]
2263
 
                            except (KeyError, errors.NoSuchId):
2264
 
                                parent_entry = None
 
1319
                            parent_entry = inv._byid.get(text_key[0], None)
2265
1320
                            if parent_entry is not None:
2266
1321
                                parent_text_key = (
2267
1322
                                    text_key[0], parent_entry.revision)
2292
1347
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2293
1348
            'revisions'.  file-id is None unless knit-kind is 'file'.
2294
1349
        """
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):
2302
1350
        # XXX: it's a bit weird to control the inventory weave caching in this
2303
1351
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2304
1352
        # maybe this generator should explicitly have the contract that it
2305
1353
        # should not be iterated until the previously yielded item has been
2306
1354
        # processed?
2307
 
        inv_w = self.inventories
 
1355
        self.lock_read()
 
1356
        inv_w = self.get_inventory_weave()
 
1357
        inv_w.enable_cache()
2308
1358
 
2309
1359
        # file ids that changed
2310
 
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
1360
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
2311
1361
        count = 0
2312
1362
        num_file_ids = len(file_ids)
2313
1363
        for file_id, altered_versions in file_ids.iteritems():
2314
 
            if pb is not None:
2315
 
                pb.update("Fetch texts", count, num_file_ids)
 
1364
            if _files_pb is not None:
 
1365
                _files_pb.update("fetch texts", count, num_file_ids)
2316
1366
            count += 1
2317
1367
            yield ("file", file_id, altered_versions)
 
1368
        # We're done with the files_pb.  Note that it finished by the caller,
 
1369
        # just as it was created by the caller.
 
1370
        del _files_pb
2318
1371
 
2319
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2320
1372
        # inventory
2321
1373
        yield ("inventory", None, revision_ids)
 
1374
        inv_w.clear_cache()
2322
1375
 
2323
1376
        # signatures
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)
 
1377
        revisions_with_signatures = set()
 
1378
        for rev_id in revision_ids:
 
1379
            try:
 
1380
                self.get_signature_text(rev_id)
 
1381
            except errors.NoSuchRevision:
 
1382
                # not signed.
 
1383
                pass
 
1384
            else:
 
1385
                revisions_with_signatures.add(rev_id)
 
1386
        self.unlock()
2332
1387
        yield ("signatures", None, revisions_with_signatures)
2333
1388
 
2334
1389
        # revisions
2335
1390
        yield ("revisions", None, revision_ids)
2336
1391
 
2337
1392
    @needs_read_lock
 
1393
    def get_inventory_weave(self):
 
1394
        return self.control_weaves.get_weave('inventory',
 
1395
            self.get_transaction())
 
1396
 
 
1397
    @needs_read_lock
2338
1398
    def get_inventory(self, revision_id):
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.
 
1399
        """Get Inventory object by hash."""
 
1400
        return self.deserialise_inventory(
 
1401
            revision_id, self.get_inventory_xml(revision_id))
 
1402
 
 
1403
    def deserialise_inventory(self, revision_id, xml):
 
1404
        """Transform the xml into an inventory object. 
2404
1405
 
2405
1406
        :param revision_id: The expected revision id of the inventory.
2406
1407
        :param xml: A serialised inventory.
2407
1408
        """
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
 
1409
        return self._serializer.read_inventory_from_string(xml, revision_id)
 
1410
 
 
1411
    def serialise_inventory(self, inv):
 
1412
        return self._serializer.write_inventory_to_string(inv)
 
1413
 
 
1414
    def _serialise_inventory_to_lines(self, inv):
 
1415
        return self._serializer.write_inventory_to_lines(inv)
2415
1416
 
2416
1417
    def get_serializer_format(self):
2417
1418
        return self._serializer.format_num
2418
1419
 
2419
1420
    @needs_read_lock
2420
 
    def _get_inventory_xml(self, revision_id):
2421
 
        """Get serialized inventory as a string."""
2422
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
1421
    def get_inventory_xml(self, revision_id):
 
1422
        """Get inventory XML as a file object."""
2423
1423
        try:
2424
 
            text, revision_id = texts.next()
2425
 
        except StopIteration:
 
1424
            assert isinstance(revision_id, str), type(revision_id)
 
1425
            iw = self.get_inventory_weave()
 
1426
            return iw.get_text(revision_id)
 
1427
        except IndexError:
2426
1428
            raise errors.HistoryMissing(self, 'inventory', revision_id)
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])
 
1429
 
 
1430
    @needs_read_lock
 
1431
    def get_inventory_sha1(self, revision_id):
 
1432
        """Return the sha1 hash of the inventory entry
 
1433
        """
 
1434
        return self.get_revision(revision_id).inventory_sha1
 
1435
 
 
1436
    @needs_read_lock
 
1437
    def get_revision_graph(self, revision_id=None):
 
1438
        """Return a dictionary containing the revision graph.
 
1439
 
 
1440
        NB: This method should not be used as it accesses the entire graph all
 
1441
        at once, which is much more data than most operations should require.
 
1442
 
 
1443
        :param revision_id: The revision_id to get a graph from. If None, then
 
1444
        the entire revision graph is returned. This is a deprecated mode of
 
1445
        operation and will be removed in the future.
 
1446
        :return: a dictionary of revision_id->revision_parents_list.
 
1447
        """
 
1448
        raise NotImplementedError(self.get_revision_graph)
 
1449
 
 
1450
    @needs_read_lock
 
1451
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1452
        """Return a graph of the revisions with ghosts marked as applicable.
 
1453
 
 
1454
        :param revision_ids: an iterable of revisions to graph or None for all.
 
1455
        :return: a Graph object with the graph reachable from revision_ids.
 
1456
        """
 
1457
        if 'evil' in debug.debug_flags:
 
1458
            mutter_callsite(3,
 
1459
                "get_revision_graph_with_ghosts scales with size of history.")
 
1460
        result = deprecated_graph.Graph()
 
1461
        if not revision_ids:
 
1462
            pending = set(self.all_revision_ids())
 
1463
            required = set([])
 
1464
        else:
 
1465
            pending = set(revision_ids)
 
1466
            # special case NULL_REVISION
 
1467
            if _mod_revision.NULL_REVISION in pending:
 
1468
                pending.remove(_mod_revision.NULL_REVISION)
 
1469
            required = set(pending)
 
1470
        done = set([])
 
1471
        while len(pending):
 
1472
            revision_id = pending.pop()
 
1473
            try:
 
1474
                rev = self.get_revision(revision_id)
 
1475
            except errors.NoSuchRevision:
 
1476
                if revision_id in required:
 
1477
                    raise
 
1478
                # a ghost
 
1479
                result.add_ghost(revision_id)
 
1480
                continue
 
1481
            for parent_id in rev.parent_ids:
 
1482
                # is this queued or done ?
 
1483
                if (parent_id not in pending and
 
1484
                    parent_id not in done):
 
1485
                    # no, queue it.
 
1486
                    pending.add(parent_id)
 
1487
            result.add_node(revision_id, rev.parent_ids)
 
1488
            done.add(revision_id)
 
1489
        return result
 
1490
 
 
1491
    def _get_history_vf(self):
 
1492
        """Get a versionedfile whose history graph reflects all revisions.
 
1493
 
 
1494
        For weave repositories, this is the inventory weave.
 
1495
        """
 
1496
        return self.get_inventory_weave()
2463
1497
 
2464
1498
    def iter_reverse_revision_history(self, revision_id):
2465
1499
        """Iterate backwards through revision ids in the lefthand history
2467
1501
        :param revision_id: The revision id to start with.  All its lefthand
2468
1502
            ancestors will be traversed.
2469
1503
        """
2470
 
        graph = self.get_graph()
 
1504
        if revision_id in (None, _mod_revision.NULL_REVISION):
 
1505
            return
2471
1506
        next_id = revision_id
 
1507
        versionedfile = self._get_history_vf()
2472
1508
        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)
2479
1509
            yield next_id
 
1510
            parents = versionedfile.get_parents(next_id)
2480
1511
            if len(parents) == 0:
2481
1512
                return
2482
1513
            else:
2483
1514
                next_id = parents[0]
2484
1515
 
 
1516
    @needs_read_lock
 
1517
    def get_revision_inventory(self, revision_id):
 
1518
        """Return inventory of a past revision."""
 
1519
        # TODO: Unify this with get_inventory()
 
1520
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1521
        # must be the same as its revision, so this is trivial.
 
1522
        if revision_id is None:
 
1523
            # This does not make sense: if there is no revision,
 
1524
            # then it is the current tree inventory surely ?!
 
1525
            # and thus get_root_id() is something that looks at the last
 
1526
            # commit on the branch, and the get_root_id is an inventory check.
 
1527
            raise NotImplementedError
 
1528
            # return Inventory(self.get_root_id())
 
1529
        else:
 
1530
            return self.get_inventory(revision_id)
 
1531
 
 
1532
    @needs_read_lock
2485
1533
    def is_shared(self):
2486
1534
        """Return True if this repository is flagged as a shared repository."""
2487
1535
        raise NotImplementedError(self.is_shared)
2501
1549
        for repositories to maintain loaded indices across multiple locks
2502
1550
        by checking inside their implementation of this method to see
2503
1551
        whether their indices are still valid. This depends of course on
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.
 
1552
        the disk format being validatable in this manner.
2509
1553
        """
2510
1554
 
2511
1555
    @needs_read_lock
2512
1556
    def revision_tree(self, revision_id):
2513
1557
        """Return Tree for a revision on this branch.
2514
1558
 
2515
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1559
        `revision_id` may be None for the empty tree revision.
2516
1560
        """
2517
 
        revision_id = _mod_revision.ensure_null(revision_id)
2518
1561
        # TODO: refactor this to use an existing revision object
2519
1562
        # so we don't need to read it in twice.
2520
 
        if revision_id == _mod_revision.NULL_REVISION:
2521
 
            return RevisionTree(self, Inventory(root_id=None),
 
1563
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1564
            return RevisionTree(self, Inventory(root_id=None), 
2522
1565
                                _mod_revision.NULL_REVISION)
2523
1566
        else:
2524
 
            inv = self.get_inventory(revision_id)
 
1567
            inv = self.get_revision_inventory(revision_id)
2525
1568
            return RevisionTree(self, inv, revision_id)
2526
1569
 
 
1570
    @needs_read_lock
2527
1571
    def revision_trees(self, revision_ids):
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)
 
1572
        """Return Tree for a revision on this branch.
 
1573
 
 
1574
        `revision_id` may not be None or 'null:'"""
 
1575
        assert None not in revision_ids
 
1576
        assert _mod_revision.NULL_REVISION not in revision_ids
 
1577
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
1578
        for text, revision_id in zip(texts, revision_ids):
 
1579
            inv = self.deserialise_inventory(revision_id, text)
 
1580
            yield RevisionTree(self, inv, revision_id)
2552
1581
 
2553
1582
    @needs_read_lock
2554
1583
    def get_ancestry(self, revision_id, topo_sorted=True):
2555
1584
        """Return a list of revision-ids integrated by a revision.
2556
1585
 
2557
 
        The first element of the list is always None, indicating the origin
2558
 
        revision.  This might change when we have history horizons, or
 
1586
        The first element of the list is always None, indicating the origin 
 
1587
        revision.  This might change when we have history horizons, or 
2559
1588
        perhaps we should have a new API.
2560
 
 
 
1589
        
2561
1590
        This is topologically sorted.
2562
1591
        """
2563
1592
        if _mod_revision.is_null(revision_id):
2564
1593
            return [None]
2565
1594
        if not self.has_revision(revision_id):
2566
1595
            raise errors.NoSuchRevision(self, revision_id)
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)
 
1596
        w = self.get_inventory_weave()
 
1597
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
1598
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
2582
1599
 
2583
 
    def pack(self, hint=None):
 
1600
    def pack(self):
2584
1601
        """Compress the data within the repository.
2585
1602
 
2586
1603
        This operation only makes sense for some repository types. For other
2587
1604
        types it should be a no-op that just returns.
2588
1605
 
2589
1606
        This stub method does not require a lock, but subclasses should use
2590
 
        @needs_write_lock as this is a long running call its reasonable to
 
1607
        @needs_write_lock as this is a long running call its reasonable to 
2591
1608
        implicitly lock for the user.
 
1609
        """
2592
1610
 
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.
 
1611
    @needs_read_lock
 
1612
    def print_file(self, file, revision_id):
 
1613
        """Print `file` to stdout.
 
1614
        
 
1615
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1616
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1617
        by creating a new more flexible convenience function.
2599
1618
        """
 
1619
        tree = self.revision_tree(revision_id)
 
1620
        # use inventory as it was in that revision
 
1621
        file_id = tree.inventory.path2id(file)
 
1622
        if not file_id:
 
1623
            # TODO: jam 20060427 Write a test for this code path
 
1624
            #       it had a bug in it, and was raising the wrong
 
1625
            #       exception.
 
1626
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1627
        tree.print_file(file_id)
2600
1628
 
2601
1629
    def get_transaction(self):
2602
1630
        return self.control_files.get_transaction()
2603
1631
 
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 = {}
 
1632
    def revision_parents(self, revision_id):
 
1633
        return self.get_inventory_weave().parent_names(revision_id)
 
1634
 
 
1635
    def get_parents(self, revision_ids):
 
1636
        """See StackedParentsProvider.get_parents"""
 
1637
        parents_list = []
2610
1638
        for revision_id in revision_ids:
2611
1639
            if revision_id == _mod_revision.NULL_REVISION:
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
 
1640
                parents = []
 
1641
            else:
 
1642
                try:
 
1643
                    parents = self.get_revision(revision_id).parent_ids
 
1644
                except errors.NoSuchRevision:
 
1645
                    parents = None
 
1646
                else:
 
1647
                    if len(parents) == 0:
 
1648
                        parents = [_mod_revision.NULL_REVISION]
 
1649
            parents_list.append(parents)
 
1650
        return parents_list
2625
1651
 
2626
1652
    def _make_parents_provider(self):
2627
1653
        return self
2630
1656
        """Return the graph walker for this repository format"""
2631
1657
        parents_provider = self._make_parents_provider()
2632
1658
        if (other_repository is not None and
2633
 
            not self.has_same_location(other_repository)):
2634
 
            parents_provider = graph.StackedParentsProvider(
 
1659
            other_repository.bzrdir.transport.base !=
 
1660
            self.bzrdir.transport.base):
 
1661
            parents_provider = graph._StackedParentsProvider(
2635
1662
                [parents_provider, other_repository._make_parents_provider()])
2636
1663
        return graph.Graph(parents_provider)
2637
1664
 
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
 
1665
    def get_versioned_file_checker(self):
 
1666
        """Return an object suitable for checking versioned files."""
 
1667
        return VersionedFileChecker(self)
2666
1668
 
2667
1669
    @needs_write_lock
2668
1670
    def set_make_working_trees(self, new_value):
2675
1677
                          working trees.
2676
1678
        """
2677
1679
        raise NotImplementedError(self.set_make_working_trees)
2678
 
 
 
1680
    
2679
1681
    def make_working_trees(self):
2680
1682
        """Returns the policy for making working trees on new branches."""
2681
1683
        raise NotImplementedError(self.make_working_trees)
2688
1690
    @needs_read_lock
2689
1691
    def has_signature_for_revision_id(self, revision_id):
2690
1692
        """Query for a revision signature for revision_id in the repository."""
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
 
1693
        return self._revision_store.has_signature(revision_id,
 
1694
                                                  self.get_transaction())
2696
1695
 
2697
1696
    @needs_read_lock
2698
1697
    def get_signature_text(self, revision_id):
2699
1698
        """Return the text for a signature."""
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')
 
1699
        return self._revision_store.get_signature_text(revision_id,
 
1700
                                                       self.get_transaction())
2706
1701
 
2707
1702
    @needs_read_lock
2708
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1703
    def check(self, revision_ids=None):
2709
1704
        """Check consistency of all history of given revision_ids.
2710
1705
 
2711
1706
        Different repository implementations should override _check().
2712
1707
 
2713
1708
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2714
1709
             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.
2720
1710
        """
2721
 
        return self._check(revision_ids, callback_refs=callback_refs,
2722
 
            check_repo=check_repo)
 
1711
        return self._check(revision_ids)
2723
1712
 
2724
 
    def _check(self, revision_ids, callback_refs, check_repo):
2725
 
        result = check.Check(self, check_repo=check_repo)
2726
 
        result.check(callback_refs)
 
1713
    def _check(self, revision_ids):
 
1714
        result = check.Check(self)
 
1715
        result.check()
2727
1716
        return result
2728
1717
 
2729
 
    def _warn_if_deprecated(self, branch=None):
 
1718
    def _warn_if_deprecated(self):
2730
1719
        global _deprecation_warning_done
2731
1720
        if _deprecation_warning_done:
2732
1721
            return
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
 
1722
        _deprecation_warning_done = True
 
1723
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
1724
                % (self._format, self.bzrdir.transport.base))
2745
1725
 
2746
1726
    def supports_rich_root(self):
2747
1727
        return self._format.rich_root_data
2761
1741
                    revision_id.decode('ascii')
2762
1742
                except UnicodeDecodeError:
2763
1743
                    raise errors.NonAsciiRevisionId(method, self)
2764
 
 
 
1744
    
2765
1745
    def revision_graph_can_have_wrong_parents(self):
2766
1746
        """Is it possible for this repository to have a revision graph with
2767
1747
        incorrect parents?
2772
1752
        depend on the revision index being consistent.
2773
1753
        """
2774
1754
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2775
 
 
2776
 
 
 
1755
        
2777
1756
# remove these delegates a while after bzr 0.15
2778
1757
def __make_delegated(name, from_module):
2779
1758
    def _deprecated_repository_forwarder():
2813
1792
    install_revisions(repository, [(rev, revision_tree, None)])
2814
1793
 
2815
1794
 
2816
 
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
1795
def install_revisions(repository, iterable):
2817
1796
    """Install all revision data into a repository.
2818
1797
 
2819
1798
    Accepts an iterable of revision, tree, signature tuples.  The signature
2821
1800
    """
2822
1801
    repository.start_write_group()
2823
1802
    try:
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)
 
1803
        for revision, revision_tree, signature in iterable:
 
1804
            _install_revision(repository, revision, revision_tree, signature)
2830
1805
    except:
2831
1806
        repository.abort_write_group()
2832
1807
        raise
2834
1809
        repository.commit_write_group()
2835
1810
 
2836
1811
 
2837
 
def _install_revision(repository, rev, revision_tree, signature,
2838
 
    inventory_cache):
 
1812
def _install_revision(repository, rev, revision_tree, signature):
2839
1813
    """Install all revision data into a repository."""
2840
1814
    present_parents = []
2841
1815
    parent_trees = {}
2844
1818
            present_parents.append(p_id)
2845
1819
            parent_trees[p_id] = repository.revision_tree(p_id)
2846
1820
        else:
2847
 
            parent_trees[p_id] = repository.revision_tree(
2848
 
                                     _mod_revision.NULL_REVISION)
 
1821
            parent_trees[p_id] = repository.revision_tree(None)
2849
1822
 
2850
1823
    inv = revision_tree.inventory
2851
1824
    entries = inv.iter_entries()
2854
1827
        path, root = entries.next()
2855
1828
        if root.revision != rev.revision_id:
2856
1829
            raise errors.IncompatibleRevision(repr(repository))
2857
 
    text_keys = {}
 
1830
    # Add the texts that are not already present
2858
1831
    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)
2862
 
    # Add the texts that are not already present
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)
 
1832
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
1833
                repository.get_transaction())
 
1834
        if ie.revision not in w:
 
1835
            text_parents = []
 
1836
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
1837
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
1838
            # is a latent bug here where the parents may have ancestors of each
 
1839
            # other. RBC, AB
 
1840
            for revision, tree in parent_trees.iteritems():
 
1841
                if ie.file_id not in tree:
 
1842
                    continue
 
1843
                parent_id = tree.inventory[ie.file_id].revision
 
1844
                if parent_id in text_parents:
 
1845
                    continue
 
1846
                text_parents.append(parent_id)
 
1847
                    
 
1848
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
1849
                repository.get_transaction())
 
1850
            lines = revision_tree.get_file(ie.file_id).readlines()
 
1851
            vfile.add_lines(rev.revision_id, text_parents, lines)
2879
1852
    try:
2880
1853
        # install the inventory
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)
 
1854
        repository.add_inventory(rev.revision_id, inv, present_parents)
2894
1855
    except errors.RevisionAlreadyPresent:
2895
1856
        pass
2896
1857
    if signature is not None:
2899
1860
 
2900
1861
 
2901
1862
class MetaDirRepository(Repository):
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
 
 
 
1863
    """Repositories in the new meta-dir layout."""
 
1864
 
 
1865
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1866
        super(MetaDirRepository, self).__init__(_format,
 
1867
                                                a_bzrdir,
 
1868
                                                control_files,
 
1869
                                                _revision_store,
 
1870
                                                control_store,
 
1871
                                                text_store)
 
1872
        dir_mode = self.control_files._dir_mode
 
1873
        file_mode = self.control_files._file_mode
 
1874
 
 
1875
    @needs_read_lock
2912
1876
    def is_shared(self):
2913
1877
        """Return True if this repository is flagged as a shared repository."""
2914
 
        return self._transport.has('shared-storage')
 
1878
        return self.control_files._transport.has('shared-storage')
2915
1879
 
2916
1880
    @needs_write_lock
2917
1881
    def set_make_working_trees(self, new_value):
2925
1889
        """
2926
1890
        if new_value:
2927
1891
            try:
2928
 
                self._transport.delete('no-working-trees')
 
1892
                self.control_files._transport.delete('no-working-trees')
2929
1893
            except errors.NoSuchFile:
2930
1894
                pass
2931
1895
        else:
2932
 
            self._transport.put_bytes('no-working-trees', '',
2933
 
                mode=self.bzrdir._get_file_mode())
2934
 
 
 
1896
            self.control_files.put_utf8('no-working-trees', '')
 
1897
    
2935
1898
    def make_working_trees(self):
2936
1899
        """Returns the policy for making working trees on new branches."""
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.
 
1900
        return not self.control_files._transport.has('no-working-trees')
 
1901
 
 
1902
 
 
1903
class RepositoryFormatRegistry(registry.Registry):
 
1904
    """Registry of RepositoryFormats."""
 
1905
 
 
1906
    def get(self, format_string):
 
1907
        r = registry.Registry.get(self, format_string)
 
1908
        if callable(r):
 
1909
            r = r()
 
1910
        return r
 
1911
    
 
1912
 
 
1913
format_registry = RepositoryFormatRegistry()
 
1914
"""Registry of formats, indexed by their identifying format string.
2959
1915
 
2960
1916
This can contain either format instances themselves, or classes/factories that
2961
1917
can be called to obtain one.
2968
1924
class RepositoryFormat(object):
2969
1925
    """A repository format.
2970
1926
 
2971
 
    Formats provide four things:
 
1927
    Formats provide three things:
2972
1928
     * An initialization routine to construct repository data on disk.
2973
 
     * a optional format string which is used when the BzrDir supports
2974
 
       versioned children.
 
1929
     * a format string which is used when the BzrDir supports versioned
 
1930
       children.
2975
1931
     * an open routine which returns a Repository instance.
2976
 
     * A network name for referring to the format in smart server RPC
2977
 
       methods.
2978
1932
 
2979
1933
    There is one and only one Format subclass for each on-disk format. But
2980
1934
    there can be one Repository subclass that is used for several different
2981
1935
    formats. The _format attribute on a Repository instance can be used to
2982
1936
    determine the disk format.
2983
1937
 
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.
 
1938
    Formats are placed in an dict by their format string for reference 
 
1939
    during opening. These should be subclasses of RepositoryFormat
 
1940
    for consistency.
2987
1941
 
2988
1942
    Once a format is deprecated, just deprecate the initialize and open
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.
 
1943
    methods on the format class. Do not deprecate the object, as the 
 
1944
    object will be created every system load.
2992
1945
 
2993
1946
    Common instance attributes:
2994
1947
    _matchingbzrdir - the bzrdir format that the repository format was
2995
1948
    originally written to work with. This can be used if manually
2996
1949
    constructing a bzrdir and repository, or more commonly for test suite
2997
 
    parameterization.
 
1950
    parameterisation.
2998
1951
    """
2999
1952
 
3000
1953
    # Set to True or False in derived classes. True indicates that the format
3001
1954
    # supports ghosts gracefully.
3002
1955
    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
3035
1956
 
3036
1957
    def __str__(self):
3037
1958
        return "<%s>" % self.__class__.__name__
3046
1967
    @classmethod
3047
1968
    def find_format(klass, a_bzrdir):
3048
1969
        """Return the format for the repository object in a_bzrdir.
3049
 
 
 
1970
        
3050
1971
        This is used by bzr native formats that have a "format" file in
3051
 
        the repository.  Other methods may be used by different types of
 
1972
        the repository.  Other methods may be used by different types of 
3052
1973
        control directory.
3053
1974
        """
3054
1975
        try:
3055
1976
            transport = a_bzrdir.get_repository_transport(None)
3056
 
            format_string = transport.get_bytes("format")
 
1977
            format_string = transport.get("format").read()
3057
1978
            return format_registry.get(format_string)
3058
1979
        except errors.NoSuchFile:
3059
1980
            raise errors.NoRepositoryPresent(a_bzrdir)
3060
1981
        except KeyError:
3061
 
            raise errors.UnknownFormatError(format=format_string,
3062
 
                                            kind='repository')
 
1982
            raise errors.UnknownFormatError(format=format_string)
3063
1983
 
3064
1984
    @classmethod
3065
1985
    def register_format(klass, format):
3068
1988
    @classmethod
3069
1989
    def unregister_format(klass, format):
3070
1990
        format_registry.remove(format.get_format_string())
3071
 
 
 
1991
    
3072
1992
    @classmethod
3073
1993
    def get_default_format(klass):
3074
1994
        """Return the current default format."""
3075
1995
        from bzrlib import bzrdir
3076
1996
        return bzrdir.format_registry.make_bzrdir('default').repository_format
3077
1997
 
 
1998
    def _get_control_store(self, repo_transport, control_files):
 
1999
        """Return the control store for this repository."""
 
2000
        raise NotImplementedError(self._get_control_store)
 
2001
 
3078
2002
    def get_format_string(self):
3079
2003
        """Return the ASCII format string that identifies this format.
3080
 
 
3081
 
        Note that in pre format ?? repositories the format string is
 
2004
        
 
2005
        Note that in pre format ?? repositories the format string is 
3082
2006
        not permitted nor written to disk.
3083
2007
        """
3084
2008
        raise NotImplementedError(self.get_format_string)
3087
2011
        """Return the short description for this format."""
3088
2012
        raise NotImplementedError(self.get_format_description)
3089
2013
 
 
2014
    def _get_revision_store(self, repo_transport, control_files):
 
2015
        """Return the revision store object for this a_bzrdir."""
 
2016
        raise NotImplementedError(self._get_revision_store)
 
2017
 
 
2018
    def _get_text_rev_store(self,
 
2019
                            transport,
 
2020
                            control_files,
 
2021
                            name,
 
2022
                            compressed=True,
 
2023
                            prefixed=False,
 
2024
                            serializer=None):
 
2025
        """Common logic for getting a revision store for a repository.
 
2026
        
 
2027
        see self._get_revision_store for the subclass-overridable method to 
 
2028
        get the store for a repository.
 
2029
        """
 
2030
        from bzrlib.store.revision.text import TextRevisionStore
 
2031
        dir_mode = control_files._dir_mode
 
2032
        file_mode = control_files._file_mode
 
2033
        text_store = TextStore(transport.clone(name),
 
2034
                              prefixed=prefixed,
 
2035
                              compressed=compressed,
 
2036
                              dir_mode=dir_mode,
 
2037
                              file_mode=file_mode)
 
2038
        _revision_store = TextRevisionStore(text_store, serializer)
 
2039
        return _revision_store
 
2040
 
3090
2041
    # TODO: this shouldn't be in the base class, it's specific to things that
3091
2042
    # use weaves or knits -- mbp 20070207
3092
2043
    def _get_versioned_file_store(self,
3115
2066
        :param a_bzrdir: The bzrdir to put the new repository in it.
3116
2067
        :param shared: The repository should be initialized as a sharable one.
3117
2068
        :returns: The new repository object.
3118
 
 
 
2069
        
3119
2070
        This may raise UninitializableFormat if shared repository are not
3120
2071
        compatible the a_bzrdir.
3121
2072
        """
3125
2076
        """Is this format supported?
3126
2077
 
3127
2078
        Supported formats must be initializable and openable.
3128
 
        Unsupported formats may not support initialization or committing or
 
2079
        Unsupported formats may not support initialization or committing or 
3129
2080
        some other features depending on the reason for not being supported.
3130
2081
        """
3131
2082
        return True
3132
2083
 
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
 
 
3143
2084
    def check_conversion_target(self, target_format):
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)
 
2085
        raise NotImplementedError(self.check_conversion_target)
3153
2086
 
3154
2087
    def open(self, a_bzrdir, _found=False):
3155
2088
        """Return an instance of this format for the bzrdir a_bzrdir.
3156
 
 
 
2089
        
3157
2090
        _found is a private parameter, do not use it.
3158
2091
        """
3159
2092
        raise NotImplementedError(self.open)
3164
2097
 
3165
2098
    rich_root_data = False
3166
2099
    supports_tree_reference = False
3167
 
    supports_external_lookups = False
3168
 
 
3169
 
    @property
3170
 
    def _matchingbzrdir(self):
3171
 
        matching = bzrdir.BzrDirMetaFormat1()
3172
 
        matching.repository_format = self
3173
 
        return matching
 
2100
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3174
2101
 
3175
2102
    def __init__(self):
3176
2103
        super(MetaDirRepositoryFormat, self).__init__()
3189
2116
        """Upload the initial blank content."""
3190
2117
        control_files = self._create_control_files(a_bzrdir)
3191
2118
        control_files.lock_write()
3192
 
        transport = control_files._transport
3193
 
        if shared == True:
3194
 
            utf8_files += [('shared-storage', '')]
3195
2119
        try:
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())
 
2120
            control_files._transport.mkdir_multi(dirs,
 
2121
                    mode=control_files._dir_mode)
 
2122
            for file, content in files:
 
2123
                control_files.put(file, content)
 
2124
            for file, content in utf8_files:
 
2125
                control_files.put_utf8(file, content)
 
2126
            if shared == True:
 
2127
                control_files.put_utf8('shared-storage', '')
3203
2128
        finally:
3204
2129
            control_files.unlock()
3205
2130
 
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
 
2131
 
 
2132
# formats which have no format string are not discoverable
 
2133
# and not independently creatable, so are not registered.  They're 
3228
2134
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3229
2135
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3230
2136
# the repository is not separately opened are similar.
3235
2141
    'RepositoryFormat7'
3236
2142
    )
3237
2143
 
 
2144
# KEEP in sync with bzrdir.format_registry default, which controls the overall
 
2145
# default control directory format
3238
2146
format_registry.register_lazy(
3239
2147
    'Bazaar-NG Knit Repository Format 1',
3240
2148
    'bzrlib.repofmt.knitrepo',
3241
2149
    'RepositoryFormatKnit1',
3242
2150
    )
 
2151
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
3243
2152
 
3244
2153
format_registry.register_lazy(
3245
2154
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
3255
2164
 
3256
2165
# Pack-based formats. There is one format for pre-subtrees, and one for
3257
2166
# post-subtrees to allow ease of testing.
3258
 
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
2167
# NOTE: These are experimental in 0.92.
3259
2168
format_registry.register_lazy(
3260
2169
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3261
2170
    'bzrlib.repofmt.pack_repo',
3271
2180
    'bzrlib.repofmt.pack_repo',
3272
2181
    'RepositoryFormatKnitPack4',
3273
2182
    )
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
 
    )
3328
2183
 
3329
2184
 
3330
2185
class InterRepository(InterObject):
3331
2186
    """This class represents operations taking place between two repositories.
3332
2187
 
3333
2188
    Its instances have methods like copy_content and fetch, and contain
3334
 
    references to the source and target repositories these operations can be
 
2189
    references to the source and target repositories these operations can be 
3335
2190
    carried out on.
3336
2191
 
3337
2192
    Often we will provide convenience methods on 'repository' which carry out
3339
2194
    InterRepository.get(other).method_name(parameters).
3340
2195
    """
3341
2196
 
3342
 
    _walk_to_common_revisions_batch_size = 50
3343
2197
    _optimisers = []
3344
2198
    """The available optimised InterRepository types."""
3345
2199
 
3346
 
    @needs_write_lock
3347
2200
    def copy_content(self, revision_id=None):
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):
 
2201
        raise NotImplementedError(self.copy_content)
 
2202
 
 
2203
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
3365
2204
        """Fetch the content required to construct revision_id.
3366
2205
 
3367
2206
        The content is copied from self.source to self.target.
3368
2207
 
3369
2208
        :param revision_id: if None all content is copied, if NULL_REVISION no
3370
2209
                            content is copied.
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
 
 
 
2210
        :param pb: optional progress bar to use for progress reports. If not
 
2211
                   provided a default one will be created.
 
2212
 
 
2213
        Returns the copied revision count and the failed revisions in a tuple:
 
2214
        (copied, failures).
 
2215
        """
 
2216
        raise NotImplementedError(self.fetch)
 
2217
   
3433
2218
    @needs_read_lock
3434
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2219
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
3435
2220
        """Return the revision ids that source has that target does not.
 
2221
        
 
2222
        These are returned in topological order.
3436
2223
 
3437
2224
        :param revision_id: only return revision ids included by this
3438
2225
                            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.
3442
2226
        """
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])
3446
2227
        # generic, possibly worst case, slow code path.
3447
2228
        target_ids = set(self.target.all_revision_ids())
3448
2229
        if revision_id is not None:
3449
2230
            source_ids = self.source.get_ancestry(revision_id)
3450
 
            if source_ids[0] is not None:
3451
 
                raise AssertionError()
 
2231
            assert source_ids[0] is None
3452
2232
            source_ids.pop(0)
3453
2233
        else:
3454
2234
            source_ids = self.source.all_revision_ids()
3455
2235
        result_set = set(source_ids).difference(target_ids)
3456
 
        return self.source.revision_ids_to_search_result(result_set)
 
2236
        # this may look like a no-op: its not. It preserves the ordering
 
2237
        # other_ids had while only returning the members from other_ids
 
2238
        # that we've decided we need.
 
2239
        return [rev_id for rev_id in source_ids if rev_id in result_set]
3457
2240
 
3458
2241
    @staticmethod
3459
2242
    def _same_model(source, target):
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:
 
2243
        """True if source and target have the same data representation."""
 
2244
        if source.supports_rich_root() != target.supports_rich_root():
3469
2245
            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
 
        """
3475
 
        if source.supports_rich_root() != target.supports_rich_root():
3476
 
            raise errors.IncompatibleRepositories(source, target,
3477
 
                "different rich-root support")
3478
2246
        if source._serializer != target._serializer:
3479
 
            raise errors.IncompatibleRepositories(source, target,
3480
 
                "different serializers")
 
2247
            return False
 
2248
        return True
3481
2249
 
3482
2250
 
3483
2251
class InterSameDataRepository(InterRepository):
3484
2252
    """Code for converting between repositories that represent the same data.
3485
 
 
 
2253
    
3486
2254
    Data format and model must match for this to work.
3487
2255
    """
3488
2256
 
3489
2257
    @classmethod
3490
2258
    def _get_repo_format_to_test(self):
3491
2259
        """Repository format for testing with.
3492
 
 
 
2260
        
3493
2261
        InterSameData can pull from subtree to subtree and from non-subtree to
3494
2262
        non-subtree, so we test this with the richest repository format.
3495
2263
        """
3500
2268
    def is_compatible(source, target):
3501
2269
        return InterRepository._same_model(source, target)
3502
2270
 
 
2271
    @needs_write_lock
 
2272
    def copy_content(self, revision_id=None):
 
2273
        """Make a complete copy of the content in self into destination.
 
2274
 
 
2275
        This copies both the repository's revision data, and configuration information
 
2276
        such as the make_working_trees setting.
 
2277
        
 
2278
        This is a destructive operation! Do not use it on existing 
 
2279
        repositories.
 
2280
 
 
2281
        :param revision_id: Only copy the content needed to construct
 
2282
                            revision_id and its parents.
 
2283
        """
 
2284
        try:
 
2285
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2286
        except NotImplementedError:
 
2287
            pass
 
2288
        # but don't bother fetching if we have the needed data now.
 
2289
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2290
            self.target.has_revision(revision_id)):
 
2291
            return
 
2292
        self.target.fetch(self.source, revision_id=revision_id)
 
2293
 
 
2294
    @needs_write_lock
 
2295
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2296
        """See InterRepository.fetch()."""
 
2297
        from bzrlib.fetch import GenericRepoFetcher
 
2298
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2299
               self.source, self.source._format, self.target,
 
2300
               self.target._format)
 
2301
        f = GenericRepoFetcher(to_repository=self.target,
 
2302
                               from_repository=self.source,
 
2303
                               last_revision=revision_id,
 
2304
                               pb=pb)
 
2305
        return f.count_copied, f.failed_revisions
 
2306
 
3503
2307
 
3504
2308
class InterWeaveRepo(InterSameDataRepository):
3505
2309
    """Optimised code paths between Weave based repositories.
3506
 
 
 
2310
    
3507
2311
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3508
2312
    implemented lazy inter-object optimisation.
3509
2313
    """
3516
2320
    @staticmethod
3517
2321
    def is_compatible(source, target):
3518
2322
        """Be compatible with known Weave formats.
3519
 
 
 
2323
        
3520
2324
        We don't test for the stores being of specific types because that
3521
 
        could lead to confusing results, and there is no need to be
 
2325
        could lead to confusing results, and there is no need to be 
3522
2326
        overly general.
3523
2327
        """
3524
2328
        from bzrlib.repofmt.weaverepo import (
3535
2339
                                                RepositoryFormat7)))
3536
2340
        except AttributeError:
3537
2341
            return False
3538
 
 
 
2342
    
3539
2343
    @needs_write_lock
3540
2344
    def copy_content(self, revision_id=None):
3541
2345
        """See InterRepository.copy_content()."""
3542
2346
        # weave specific optimised path:
3543
2347
        try:
3544
2348
            self.target.set_make_working_trees(self.source.make_working_trees())
3545
 
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
2349
        except NotImplementedError:
3546
2350
            pass
3547
2351
        # FIXME do not peek!
3548
 
        if self.source._transport.listable():
 
2352
        if self.source.control_files._transport.listable():
3549
2353
            pb = ui.ui_factory.nested_progress_bar()
3550
2354
            try:
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))
 
2355
                self.target.weave_store.copy_all_ids(
 
2356
                    self.source.weave_store,
 
2357
                    pb=pb,
 
2358
                    from_transaction=self.source.get_transaction(),
 
2359
                    to_transaction=self.target.get_transaction())
 
2360
                pb.update('copying inventory', 0, 1)
 
2361
                self.target.control_weaves.copy_multi(
 
2362
                    self.source.control_weaves, ['inventory'],
 
2363
                    from_transaction=self.source.get_transaction(),
 
2364
                    to_transaction=self.target.get_transaction())
 
2365
                self.target._revision_store.text_store.copy_all_ids(
 
2366
                    self.source._revision_store.text_store,
 
2367
                    pb=pb)
3566
2368
            finally:
3567
2369
                pb.finished()
3568
2370
        else:
3569
2371
            self.target.fetch(self.source, revision_id=revision_id)
3570
2372
 
 
2373
    @needs_write_lock
 
2374
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2375
        """See InterRepository.fetch()."""
 
2376
        from bzrlib.fetch import GenericRepoFetcher
 
2377
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2378
               self.source, self.source._format, self.target, self.target._format)
 
2379
        f = GenericRepoFetcher(to_repository=self.target,
 
2380
                               from_repository=self.source,
 
2381
                               last_revision=revision_id,
 
2382
                               pb=pb)
 
2383
        return f.count_copied, f.failed_revisions
 
2384
 
3571
2385
    @needs_read_lock
3572
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2386
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
3573
2387
        """See InterRepository.missing_revision_ids()."""
3574
2388
        # we want all revisions to satisfy revision_id in source.
3575
2389
        # but we don't want to stat every file here and there.
3576
 
        # we want then, all revisions other needs to satisfy revision_id
 
2390
        # we want then, all revisions other needs to satisfy revision_id 
3577
2391
        # checked, but not those that we have locally.
3578
 
        # so the first thing is to get a subset of the revisions to
 
2392
        # so the first thing is to get a subset of the revisions to 
3579
2393
        # satisfy revision_id in source, and then eliminate those that
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
 
2394
        # we do already have. 
 
2395
        # this is slow on high latency connection to self, but as as this
 
2396
        # disk format scales terribly for push anyway due to rewriting 
3583
2397
        # inventory.weave, this is considered acceptable.
3584
2398
        # - RBC 20060209
3585
2399
        if revision_id is not None:
3586
2400
            source_ids = self.source.get_ancestry(revision_id)
3587
 
            if source_ids[0] is not None:
3588
 
                raise AssertionError()
 
2401
            assert source_ids[0] is None
3589
2402
            source_ids.pop(0)
3590
2403
        else:
3591
2404
            source_ids = self.source._all_possible_ids()
3596
2409
        # we do not have a revision as that would be pointless.
3597
2410
        target_ids = set(self.target._all_possible_ids())
3598
2411
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3599
 
        actually_present_revisions = set(
3600
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2412
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
3601
2413
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2414
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
3602
2415
        if revision_id is not None:
3603
2416
            # we used get_ancestry to determine source_ids then we are assured all
3604
2417
            # revisions referenced are present as they are installed in topological order.
3605
2418
            # and the tip revision was validated by get_ancestry.
3606
 
            result_set = required_revisions
 
2419
            return required_topo_revisions
3607
2420
        else:
3608
 
            # if we just grabbed the possibly available ids, then
 
2421
            # if we just grabbed the possibly available ids, then 
3609
2422
            # we only have an estimate of whats available and need to validate
3610
2423
            # that against the revision records.
3611
 
            result_set = set(
3612
 
                self.source._eliminate_revisions_not_present(required_revisions))
3613
 
        return self.source.revision_ids_to_search_result(result_set)
 
2424
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
3614
2425
 
3615
2426
 
3616
2427
class InterKnitRepo(InterSameDataRepository):
3624
2435
    @staticmethod
3625
2436
    def is_compatible(source, target):
3626
2437
        """Be compatible with known Knit formats.
3627
 
 
 
2438
        
3628
2439
        We don't test for the stores being of specific types because that
3629
 
        could lead to confusing results, and there is no need to be
 
2440
        could lead to confusing results, and there is no need to be 
3630
2441
        overly general.
3631
2442
        """
3632
2443
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3637
2448
            return False
3638
2449
        return are_knits and InterRepository._same_model(source, target)
3639
2450
 
 
2451
    @needs_write_lock
 
2452
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2453
        """See InterRepository.fetch()."""
 
2454
        from bzrlib.fetch import KnitRepoFetcher
 
2455
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2456
               self.source, self.source._format, self.target, self.target._format)
 
2457
        f = KnitRepoFetcher(to_repository=self.target,
 
2458
                            from_repository=self.source,
 
2459
                            last_revision=revision_id,
 
2460
                            pb=pb)
 
2461
        return f.count_copied, f.failed_revisions
 
2462
 
3640
2463
    @needs_read_lock
3641
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2464
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
3642
2465
        """See InterRepository.missing_revision_ids()."""
3643
2466
        if revision_id is not None:
3644
2467
            source_ids = self.source.get_ancestry(revision_id)
3645
 
            if source_ids[0] is not None:
3646
 
                raise AssertionError()
 
2468
            assert source_ids[0] is None
3647
2469
            source_ids.pop(0)
3648
2470
        else:
3649
2471
            source_ids = self.source.all_revision_ids()
3654
2476
        # we do not have a revision as that would be pointless.
3655
2477
        target_ids = set(self.target.all_revision_ids())
3656
2478
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3657
 
        actually_present_revisions = set(
3658
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2479
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
3659
2480
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2481
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
3660
2482
        if revision_id is not None:
3661
2483
            # we used get_ancestry to determine source_ids then we are assured all
3662
2484
            # revisions referenced are present as they are installed in topological order.
3663
2485
            # and the tip revision was validated by get_ancestry.
3664
 
            result_set = required_revisions
 
2486
            return required_topo_revisions
3665
2487
        else:
3666
 
            # if we just grabbed the possibly available ids, then
 
2488
            # if we just grabbed the possibly available ids, then 
3667
2489
            # we only have an estimate of whats available and need to validate
3668
2490
            # that against the revision records.
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):
 
2491
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
2492
 
 
2493
 
 
2494
class InterPackRepo(InterSameDataRepository):
 
2495
    """Optimised code paths between Pack based repositories."""
 
2496
 
 
2497
    @classmethod
 
2498
    def _get_repo_format_to_test(self):
 
2499
        from bzrlib.repofmt import pack_repo
 
2500
        return pack_repo.RepositoryFormatKnitPack1()
 
2501
 
 
2502
    @staticmethod
 
2503
    def is_compatible(source, target):
 
2504
        """Be compatible with known Pack formats.
 
2505
        
 
2506
        We don't test for the stores being of specific types because that
 
2507
        could lead to confusing results, and there is no need to be 
 
2508
        overly general.
 
2509
        """
 
2510
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2511
        try:
 
2512
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2513
                isinstance(target._format, RepositoryFormatPack))
 
2514
        except AttributeError:
 
2515
            return False
 
2516
        return are_packs and InterRepository._same_model(source, target)
 
2517
 
 
2518
    @needs_write_lock
 
2519
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2520
        """See InterRepository.fetch()."""
 
2521
        from bzrlib.repofmt.pack_repo import Packer
 
2522
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2523
               self.source, self.source._format, self.target, self.target._format)
 
2524
        self.count_copied = 0
 
2525
        if revision_id is None:
 
2526
            # TODO:
 
2527
            # everything to do - use pack logic
 
2528
            # to fetch from all packs to one without
 
2529
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2530
            # till then:
 
2531
            revision_ids = self.source.all_revision_ids()
 
2532
            # implementing the TODO will involve:
 
2533
            # - detecting when all of a pack is selected
 
2534
            # - avoiding as much as possible pre-selection, so the
 
2535
            # more-core routines such as create_pack_from_packs can filter in
 
2536
            # a just-in-time fashion. (though having a HEADS list on a
 
2537
            # repository might make this a lot easier, because we could
 
2538
            # sensibly detect 'new revisions' without doing a full index scan.
 
2539
        elif _mod_revision.is_null(revision_id):
 
2540
            # nothing to do:
 
2541
            return (0, [])
 
2542
        else:
 
2543
            try:
 
2544
                revision_ids = self.missing_revision_ids(revision_id,
 
2545
                    find_ghosts=find_ghosts)
 
2546
            except errors.NoSuchRevision:
 
2547
                raise errors.InstallFailed([revision_id])
 
2548
        packs = self.source._pack_collection.all_packs()
 
2549
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2550
            revision_ids).pack()
 
2551
        if pack is not None:
 
2552
            self.target._pack_collection._save_pack_names()
 
2553
            # Trigger an autopack. This may duplicate effort as we've just done
 
2554
            # a pack creation, but for now it is simpler to think about as
 
2555
            # 'upload data, then repack if needed'.
 
2556
            self.target._pack_collection.autopack()
 
2557
            return (pack.get_revision_count(), [])
 
2558
        else:
 
2559
            return (0, [])
 
2560
 
 
2561
    @needs_read_lock
 
2562
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2563
        """See InterRepository.missing_revision_ids().
 
2564
        
 
2565
        :param find_ghosts: Find ghosts throughough the ancestry of
 
2566
            revision_id.
 
2567
        """
 
2568
        if not find_ghosts and revision_id is not None:
 
2569
            graph = self.source.get_graph()
 
2570
            missing_revs = set()
 
2571
            searcher = graph._make_breadth_first_searcher([revision_id])
 
2572
            target_index = \
 
2573
                self.target._pack_collection.revision_index.combined_index
 
2574
            null_set = frozenset([_mod_revision.NULL_REVISION])
 
2575
            while True:
 
2576
                try:
 
2577
                    next_revs = set(searcher.next())
 
2578
                except StopIteration:
 
2579
                    break
 
2580
                next_revs.difference_update(null_set)
 
2581
                target_keys = [(key,) for key in next_revs]
 
2582
                have_revs = frozenset(node[1][0] for node in
 
2583
                    target_index.iter_entries(target_keys))
 
2584
                missing_revs.update(next_revs - have_revs)
 
2585
                searcher.stop_searching_any(have_revs)
 
2586
            if next_revs - have_revs == set([revision_id]):
 
2587
                # we saw the start rev itself, but no parents from it (or
 
2588
                # next_revs would have been updated to e.g. set(). We remove
 
2589
                # have_revs because if we found revision_id locally we
 
2590
                # stop_searching at the first time around.
 
2591
                raise errors.NoSuchRevision(self.source, revision_id)
 
2592
            return missing_revs
 
2593
        elif revision_id is not None:
 
2594
            source_ids = self.source.get_ancestry(revision_id)
 
2595
            assert source_ids[0] is None
 
2596
            source_ids.pop(0)
 
2597
        else:
 
2598
            source_ids = self.source.all_revision_ids()
 
2599
        # source_ids is the worst possible case we may need to pull.
 
2600
        # now we want to filter source_ids against what we actually
 
2601
        # have in target, but don't try to check for existence where we know
 
2602
        # we do not have a revision as that would be pointless.
 
2603
        target_ids = set(self.target.all_revision_ids())
 
2604
        return [r for r in source_ids if (r not in target_ids)]
 
2605
 
 
2606
 
 
2607
class InterModel1and2(InterRepository):
 
2608
 
 
2609
    @classmethod
 
2610
    def _get_repo_format_to_test(self):
 
2611
        return None
 
2612
 
 
2613
    @staticmethod
 
2614
    def is_compatible(source, target):
 
2615
        if not source.supports_rich_root() and target.supports_rich_root():
 
2616
            return True
 
2617
        else:
 
2618
            return False
 
2619
 
 
2620
    @needs_write_lock
 
2621
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2622
        """See InterRepository.fetch()."""
 
2623
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2624
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2625
                                 from_repository=self.source,
 
2626
                                 last_revision=revision_id,
 
2627
                                 pb=pb)
 
2628
        return f.count_copied, f.failed_revisions
 
2629
 
 
2630
    @needs_write_lock
 
2631
    def copy_content(self, revision_id=None):
 
2632
        """Make a complete copy of the content in self into destination.
 
2633
        
 
2634
        This is a destructive operation! Do not use it on existing 
 
2635
        repositories.
 
2636
 
 
2637
        :param revision_id: Only copy the content needed to construct
 
2638
                            revision_id and its parents.
 
2639
        """
 
2640
        try:
 
2641
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2642
        except NotImplementedError:
 
2643
            pass
 
2644
        # but don't bother fetching if we have the needed data now.
 
2645
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2646
            self.target.has_revision(revision_id)):
 
2647
            return
 
2648
        self.target.fetch(self.source, revision_id=revision_id)
 
2649
 
 
2650
 
 
2651
class InterKnit1and2(InterKnitRepo):
 
2652
 
 
2653
    @classmethod
 
2654
    def _get_repo_format_to_test(self):
 
2655
        return None
 
2656
 
 
2657
    @staticmethod
 
2658
    def is_compatible(source, target):
 
2659
        """Be compatible with Knit1 source and Knit3 target"""
 
2660
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
2661
        try:
 
2662
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
2663
                RepositoryFormatKnit3)
 
2664
            from bzrlib.repofmt.pack_repo import (RepositoryFormatKnitPack1,
 
2665
                RepositoryFormatKnitPack3)
 
2666
            return (isinstance(source._format,
 
2667
                    (RepositoryFormatKnit1, RepositoryFormatKnitPack1)) and
 
2668
                isinstance(target._format,
 
2669
                    (RepositoryFormatKnit3, RepositoryFormatKnitPack3))
 
2670
                )
 
2671
        except AttributeError:
 
2672
            return False
 
2673
 
 
2674
    @needs_write_lock
 
2675
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2676
        """See InterRepository.fetch()."""
 
2677
        from bzrlib.fetch import Knit1to2Fetcher
 
2678
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2679
               self.source, self.source._format, self.target, 
 
2680
               self.target._format)
 
2681
        f = Knit1to2Fetcher(to_repository=self.target,
 
2682
                            from_repository=self.source,
 
2683
                            last_revision=revision_id,
 
2684
                            pb=pb)
 
2685
        return f.count_copied, f.failed_revisions
 
2686
 
 
2687
 
 
2688
class InterDifferingSerializer(InterKnitRepo):
3675
2689
 
3676
2690
    @classmethod
3677
2691
    def _get_repo_format_to_test(self):
3680
2694
    @staticmethod
3681
2695
    def is_compatible(source, target):
3682
2696
        """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:///'):
 
2697
        if source.supports_rich_root() != target.supports_rich_root():
 
2698
            return False
 
2699
        # Ideally, we'd support fetching if the source had no tree references
 
2700
        # even if it supported them...
 
2701
        if (getattr(source, '_format.supports_tree_reference', False) and
 
2702
            not getattr(target, '_format.supports_tree_reference', False)):
3704
2703
            return False
3705
2704
        return True
3706
2705
 
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.
 
2706
    @needs_write_lock
 
2707
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2708
        """See InterRepository.fetch()."""
 
2709
        revision_ids = self.target.missing_revision_ids(self.source,
 
2710
                                                        revision_id)
 
2711
        def revisions_iterator():
 
2712
            for current_revision_id in revision_ids:
 
2713
                revision = self.source.get_revision(current_revision_id)
 
2714
                tree = self.source.revision_tree(current_revision_id)
3714
2715
                try:
3715
 
                    tree = self.source.revision_tree(rev_id)
 
2716
                    signature = self.source.get_signature_text(
 
2717
                        current_revision_id)
3716
2718
                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:
3902
 
            try:
3903
 
                signature = self.source.get_signature_text(
3904
 
                    revision.revision_id)
3905
 
                self.target.add_signature_text(revision.revision_id,
3906
 
                    signature)
3907
 
            except errors.NoSuchRevision:
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()
 
2719
                    signature = None
 
2720
                yield revision, tree, signature
 
2721
        install_revisions(self.target, revisions_iterator())
3996
2722
        return len(revision_ids), 0
3997
2723
 
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
 
2724
 
 
2725
class InterRemoteToOther(InterRepository):
 
2726
 
 
2727
    def __init__(self, source, target):
 
2728
        InterRepository.__init__(self, source, target)
 
2729
        self._real_inter = None
 
2730
 
 
2731
    @staticmethod
 
2732
    def is_compatible(source, target):
 
2733
        if not isinstance(source, remote.RemoteRepository):
 
2734
            return False
 
2735
        source._ensure_real()
 
2736
        real_source = source._real_repository
 
2737
        # Is source's model compatible with target's model, and are they the
 
2738
        # same format?  Currently we can only optimise fetching from an
 
2739
        # identical model & format repo.
 
2740
        assert not isinstance(real_source, remote.RemoteRepository), (
 
2741
            "We don't support remote repos backed by remote repos yet.")
 
2742
        return real_source._format == target._format
 
2743
 
 
2744
    @needs_write_lock
 
2745
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2746
        """See InterRepository.fetch()."""
 
2747
        from bzrlib.fetch import RemoteToOtherFetcher
 
2748
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
2749
               self.source, self.target, self.target._format)
 
2750
        # TODO: jam 20070210 This should be an assert, not a translate
 
2751
        revision_id = osutils.safe_revision_id(revision_id)
 
2752
        f = RemoteToOtherFetcher(to_repository=self.target,
 
2753
                                 from_repository=self.source,
 
2754
                                 last_revision=revision_id,
 
2755
                                 pb=pb)
 
2756
        return f.count_copied, f.failed_revisions
 
2757
 
 
2758
    @classmethod
 
2759
    def _get_repo_format_to_test(self):
 
2760
        return None
 
2761
 
 
2762
 
 
2763
class InterOtherToRemote(InterRepository):
 
2764
 
 
2765
    def __init__(self, source, target):
 
2766
        InterRepository.__init__(self, source, target)
 
2767
        self._real_inter = None
 
2768
 
 
2769
    @staticmethod
 
2770
    def is_compatible(source, target):
 
2771
        if isinstance(target, remote.RemoteRepository):
 
2772
            return True
 
2773
        return False
 
2774
 
 
2775
    def _ensure_real_inter(self):
 
2776
        if self._real_inter is None:
 
2777
            self.target._ensure_real()
 
2778
            real_target = self.target._real_repository
 
2779
            self._real_inter = InterRepository.get(self.source, real_target)
 
2780
    
 
2781
    def copy_content(self, revision_id=None):
 
2782
        self._ensure_real_inter()
 
2783
        self._real_inter.copy_content(revision_id=revision_id)
 
2784
 
 
2785
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2786
        self._ensure_real_inter()
 
2787
        self._real_inter.fetch(revision_id=revision_id, pb=pb)
 
2788
 
 
2789
    @classmethod
 
2790
    def _get_repo_format_to_test(self):
 
2791
        return None
4019
2792
 
4020
2793
 
4021
2794
InterRepository.register_optimiser(InterDifferingSerializer)
4022
2795
InterRepository.register_optimiser(InterSameDataRepository)
4023
2796
InterRepository.register_optimiser(InterWeaveRepo)
4024
2797
InterRepository.register_optimiser(InterKnitRepo)
 
2798
InterRepository.register_optimiser(InterModel1and2)
 
2799
InterRepository.register_optimiser(InterKnit1and2)
 
2800
InterRepository.register_optimiser(InterPackRepo)
 
2801
InterRepository.register_optimiser(InterRemoteToOther)
 
2802
InterRepository.register_optimiser(InterOtherToRemote)
4025
2803
 
4026
2804
 
4027
2805
class CopyConverter(object):
4028
2806
    """A repository conversion tool which just performs a copy of the content.
4029
 
 
 
2807
    
4030
2808
    This is slow but quite reliable.
4031
2809
    """
4032
2810
 
4036
2814
        :param target_format: The format the resulting repository should be.
4037
2815
        """
4038
2816
        self.target_format = target_format
4039
 
 
 
2817
        
4040
2818
    def convert(self, repo, pb):
4041
2819
        """Perform the conversion of to_convert, giving feedback via pb.
4042
2820
 
4043
2821
        :param to_convert: The disk object to convert.
4044
2822
        :param pb: a progress bar to use for progress information.
4045
2823
        """
4046
 
        pb = ui.ui_factory.nested_progress_bar()
 
2824
        self.pb = pb
4047
2825
        self.count = 0
4048
2826
        self.total = 4
4049
2827
        # this is only useful with metadir layouts - separated repo content.
4050
2828
        # trigger an assertion if not such
4051
2829
        repo._format.get_format_string()
4052
2830
        self.repo_dir = repo.bzrdir
4053
 
        pb.update('Moving repository to repository.backup')
 
2831
        self.step('Moving repository to repository.backup')
4054
2832
        self.repo_dir.transport.move('repository', 'repository.backup')
4055
2833
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4056
2834
        repo._format.check_conversion_target(self.target_format)
4057
2835
        self.source_repo = repo._format.open(self.repo_dir,
4058
2836
            _found=True,
4059
2837
            _override_transport=backup_transport)
4060
 
        pb.update('Creating new repository')
 
2838
        self.step('Creating new repository')
4061
2839
        converted = self.target_format.initialize(self.repo_dir,
4062
2840
                                                  self.source_repo.is_shared())
4063
2841
        converted.lock_write()
4064
2842
        try:
4065
 
            pb.update('Copying content')
 
2843
            self.step('Copying content into repository.')
4066
2844
            self.source_repo.copy_content_into(converted)
4067
2845
        finally:
4068
2846
            converted.unlock()
4069
 
        pb.update('Deleting old repository content')
 
2847
        self.step('Deleting old repository content.')
4070
2848
        self.repo_dir.transport.delete_tree('repository.backup')
4071
 
        ui.ui_factory.note('repository converted')
4072
 
        pb.finished()
 
2849
        self.pb.note('repository converted')
 
2850
 
 
2851
    def step(self, message):
 
2852
        """Update the pb by a step."""
 
2853
        self.count +=1
 
2854
        self.pb.update(message, self.count, self.total)
4073
2855
 
4074
2856
 
4075
2857
_unescape_map = {
4102
2884
    return _unescape_re.sub(_unescaper, data)
4103
2885
 
4104
2886
 
4105
 
class _VersionedFileChecker(object):
 
2887
class VersionedFileChecker(object):
4106
2888
 
4107
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
2889
    def __init__(self, repository):
4108
2890
        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):
 
2891
        self.text_index = self.repository._generate_text_key_index()
 
2892
    
 
2893
    def calculate_file_version_parents(self, revision_id, file_id):
4113
2894
        """Calculate the correct parents for a file version according to
4114
2895
        the inventories.
4115
2896
        """
4116
 
        parent_keys = self.text_index[text_key]
 
2897
        parent_keys = self.text_index[(file_id, revision_id)]
4117
2898
        if parent_keys == [_mod_revision.NULL_REVISION]:
4118
2899
            return ()
4119
 
        return tuple(parent_keys)
 
2900
        # strip the file_id, for the weave api
 
2901
        return tuple([revision_id for file_id, revision_id in parent_keys])
4120
2902
 
4121
 
    def check_file_version_parents(self, texts, progress_bar=None):
 
2903
    def check_file_version_parents(self, weave, file_id, planned_revisions):
4122
2904
        """Check the parents stored in a versioned file are correct.
4123
2905
 
4124
2906
        It also detects file versions that are not referenced by their
4131
2913
            revision_id) tuples for versions that are present in this versioned
4132
2914
            file, but not used by the corresponding inventory.
4133
2915
        """
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."""
4146
2916
        wrong_parents = {}
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)
4159
 
            try:
4160
 
                knit_parents = parent_map[key]
4161
 
            except errors.RevisionNotPresent:
4162
 
                # Missing text!
4163
 
                knit_parents = None
4164
 
            if correct_parents != knit_parents:
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
 
 
 
2917
        unused_versions = set()
 
2918
        for num, revision_id in enumerate(planned_revisions):
 
2919
            try:
 
2920
                correct_parents = self.calculate_file_version_parents(
 
2921
                    revision_id, file_id)
 
2922
            except KeyError:
 
2923
                # we were asked to investigate a non-existant version.
 
2924
                unused_versions.add(revision_id)
 
2925
            else:
 
2926
                try:
 
2927
                    knit_parents = tuple(weave.get_parents(revision_id))
 
2928
                except errors.RevisionNotPresent:
 
2929
                    knit_parents = None
 
2930
                if correct_parents != knit_parents:
 
2931
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
2932
        return wrong_parents, unused_versions