~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-03 14:14:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: john@arbash-meinel.com-20090603141431-zeurvzs2iezwzdn5
A bit of code restructuring.
Move bzrlib/_bencode_py.py back to bzrlib/util/_bencode_py.py
Leaving it as _bencode_py.py so that people don't accidentally
import the old version.
Renaming _bencode_c.pyx => _bencode_pyx.pyx to conform to new naming scheme.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
19
 
import itertools
 
19
import cStringIO
 
20
import re
20
21
import time
21
22
 
22
23
from bzrlib import (
23
24
    bzrdir,
24
 
    config,
25
 
    controldir,
 
25
    check,
 
26
    chk_map,
26
27
    debug,
 
28
    errors,
 
29
    fifo_cache,
27
30
    generate_ids,
 
31
    gpg,
28
32
    graph,
 
33
    inventory,
 
34
    lazy_regex,
29
35
    lockable_files,
30
36
    lockdir,
 
37
    lru_cache,
31
38
    osutils,
32
39
    revision as _mod_revision,
33
 
    testament as _mod_testament,
 
40
    symbol_versioning,
34
41
    tsort,
35
 
    gpg,
 
42
    ui,
 
43
    versionedfile,
36
44
    )
37
45
from bzrlib.bundle import serializer
 
46
from bzrlib.revisiontree import RevisionTree
 
47
from bzrlib.store.versioned import VersionedFileStore
 
48
from bzrlib.testament import Testament
38
49
""")
39
50
 
40
 
from bzrlib import (
41
 
    errors,
42
 
    registry,
43
 
    symbol_versioning,
44
 
    ui,
45
 
    )
46
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
52
from bzrlib.inter import InterObject
48
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
53
from bzrlib.inventory import (
 
54
    Inventory,
 
55
    InventoryDirectory,
 
56
    ROOT_ID,
 
57
    entry_factory,
 
58
    )
 
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
49
63
from bzrlib.trace import (
50
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
51
65
 
54
68
_deprecation_warning_done = False
55
69
 
56
70
 
57
 
class IsInWriteGroupError(errors.InternalBzrError):
58
 
 
59
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
60
 
 
61
 
    def __init__(self, repo):
62
 
        errors.InternalBzrError.__init__(self, repo=repo)
63
 
 
64
 
 
65
71
class CommitBuilder(object):
66
72
    """Provides an interface to build up a commit.
67
73
 
71
77
 
72
78
    # all clients should supply tree roots.
73
79
    record_root_entry = True
74
 
    # whether this commit builder supports the record_entry_contents interface
75
 
    supports_record_entry_contents = False
 
80
    # the default CommitBuilder does not manage trees whose root is versioned.
 
81
    _versioned_root = False
76
82
 
77
83
    def __init__(self, repository, parents, config, timestamp=None,
78
84
                 timezone=None, committer=None, revprops=None,
79
 
                 revision_id=None, lossy=False):
 
85
                 revision_id=None):
80
86
        """Initiate a CommitBuilder.
81
87
 
82
88
        :param repository: Repository to commit to.
83
89
        :param parents: Revision ids of the parents of the new revision.
 
90
        :param config: Configuration to use.
84
91
        :param timestamp: Optional timestamp recorded for commit.
85
92
        :param timezone: Optional timezone for timestamp.
86
93
        :param committer: Optional committer to set for commit.
87
94
        :param revprops: Optional dictionary of revision properties.
88
95
        :param revision_id: Optional revision id.
89
 
        :param lossy: Whether to discard data that can not be natively
90
 
            represented, when pushing to a foreign VCS 
91
96
        """
92
97
        self._config = config
93
 
        self._lossy = lossy
94
98
 
95
99
        if committer is None:
96
100
            self._committer = self._config.username()
97
 
        elif not isinstance(committer, unicode):
98
 
            self._committer = committer.decode() # throw if non-ascii
99
101
        else:
100
102
            self._committer = committer
101
103
 
 
104
        self.new_inventory = Inventory(None)
102
105
        self._new_revision_id = revision_id
103
106
        self.parents = parents
104
107
        self.repository = repository
119
122
            self._timezone = int(timezone)
120
123
 
121
124
        self._generate_revision_if_needed()
 
125
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
126
        self._basis_delta = []
 
127
        # API compatibility, older code that used CommitBuilder did not call
 
128
        # .record_delete(), which means the delta that is computed would not be
 
129
        # valid. Callers that will call record_delete() should call
 
130
        # .will_record_deletes() to indicate that.
 
131
        self._recording_deletes = False
 
132
        # memo'd check for no-op commits.
 
133
        self._any_changes = False
122
134
 
123
135
    def any_changes(self):
124
136
        """Return True if any entries were changed.
125
 
 
 
137
        
126
138
        This includes merge-only changes. It is the core for the --unchanged
127
139
        detection in commit.
128
140
 
129
141
        :return: True if any changes have occured.
130
142
        """
131
 
        raise NotImplementedError(self.any_changes)
 
143
        return self._any_changes
132
144
 
133
145
    def _validate_unicode_text(self, text, context):
134
146
        """Verify things like commit messages don't have bogus characters."""
150
162
 
151
163
        :return: The revision id of the recorded revision.
152
164
        """
153
 
        raise NotImplementedError(self.commit)
 
165
        self._validate_unicode_text(message, 'commit message')
 
166
        rev = _mod_revision.Revision(
 
167
                       timestamp=self._timestamp,
 
168
                       timezone=self._timezone,
 
169
                       committer=self._committer,
 
170
                       message=message,
 
171
                       inventory_sha1=self.inv_sha1,
 
172
                       revision_id=self._new_revision_id,
 
173
                       properties=self._revprops)
 
174
        rev.parent_ids = self.parents
 
175
        self.repository.add_revision(self._new_revision_id, rev,
 
176
            self.new_inventory, self._config)
 
177
        self.repository.commit_write_group()
 
178
        return self._new_revision_id
154
179
 
155
180
    def abort(self):
156
181
        """Abort the commit that is being built.
157
182
        """
158
 
        raise NotImplementedError(self.abort)
 
183
        self.repository.abort_write_group()
159
184
 
160
185
    def revision_tree(self):
161
186
        """Return the tree that was just committed.
162
187
 
163
 
        After calling commit() this can be called to get a
164
 
        RevisionTree representing the newly committed tree. This is
165
 
        preferred to calling Repository.revision_tree() because that may
166
 
        require deserializing the inventory, while we already have a copy in
 
188
        After calling commit() this can be called to get a RevisionTree
 
189
        representing the newly committed tree. This is preferred to
 
190
        calling Repository.revision_tree() because that may require
 
191
        deserializing the inventory, while we already have a copy in
167
192
        memory.
168
193
        """
169
 
        raise NotImplementedError(self.revision_tree)
 
194
        if self.new_inventory is None:
 
195
            self.new_inventory = self.repository.get_inventory(
 
196
                self._new_revision_id)
 
197
        return RevisionTree(self.repository, self.new_inventory,
 
198
            self._new_revision_id)
170
199
 
171
200
    def finish_inventory(self):
172
201
        """Tell the builder that the inventory is finished.
174
203
        :return: The inventory id in the repository, which can be used with
175
204
            repository.get_inventory.
176
205
        """
177
 
        raise NotImplementedError(self.finish_inventory)
 
206
        if self.new_inventory is None:
 
207
            # an inventory delta was accumulated without creating a new
 
208
            # inventory.
 
209
            basis_id = self.basis_delta_revision
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
211
                basis_id, self._basis_delta, self._new_revision_id,
 
212
                self.parents)
 
213
        else:
 
214
            if self.new_inventory.root is None:
 
215
                raise AssertionError('Root entry should be supplied to'
 
216
                    ' record_entry_contents, as of bzr 0.10.')
 
217
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
218
            self.new_inventory.revision_id = self._new_revision_id
 
219
            self.inv_sha1 = self.repository.add_inventory(
 
220
                self._new_revision_id,
 
221
                self.new_inventory,
 
222
                self.parents
 
223
                )
 
224
        return self._new_revision_id
178
225
 
179
226
    def _gen_revision_id(self):
180
227
        """Return new revision-id."""
181
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
228
        return generate_ids.gen_revision_id(self._config.username(),
 
229
                                            self._timestamp)
182
230
 
183
231
    def _generate_revision_if_needed(self):
184
232
        """Create a revision id if None was supplied.
195
243
        else:
196
244
            self.random_revid = False
197
245
 
 
246
    def _heads(self, file_id, revision_ids):
 
247
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
248
 
 
249
        This can use either a per-file graph or a global revision graph as we
 
250
        have an identity relationship between the two graphs.
 
251
        """
 
252
        return self.__heads(revision_ids)
 
253
 
 
254
    def _check_root(self, ie, parent_invs, tree):
 
255
        """Helper for record_entry_contents.
 
256
 
 
257
        :param ie: An entry being added.
 
258
        :param parent_invs: The inventories of the parent revisions of the
 
259
            commit.
 
260
        :param tree: The tree that is being committed.
 
261
        """
 
262
        # In this revision format, root entries have no knit or weave When
 
263
        # serializing out to disk and back in root.revision is always
 
264
        # _new_revision_id
 
265
        ie.revision = self._new_revision_id
 
266
 
 
267
    def _require_root_change(self, tree):
 
268
        """Enforce an appropriate root object change.
 
269
 
 
270
        This is called once when record_iter_changes is called, if and only if
 
271
        the root was not in the delta calculated by record_iter_changes.
 
272
 
 
273
        :param tree: The tree which is being committed.
 
274
        """
 
275
        # NB: if there are no parents then this method is not called, so no
 
276
        # need to guard on parents having length.
 
277
        entry = entry_factory['directory'](tree.path2id(''), '',
 
278
            None)
 
279
        entry.revision = self._new_revision_id
 
280
        self._basis_delta.append(('', '', entry.file_id, entry))
 
281
 
 
282
    def _get_delta(self, ie, basis_inv, path):
 
283
        """Get a delta against the basis inventory for ie."""
 
284
        if ie.file_id not in basis_inv:
 
285
            # add
 
286
            result = (None, path, ie.file_id, ie)
 
287
            self._basis_delta.append(result)
 
288
            return result
 
289
        elif ie != basis_inv[ie.file_id]:
 
290
            # common but altered
 
291
            # TODO: avoid tis id2path call.
 
292
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
293
            self._basis_delta.append(result)
 
294
            return result
 
295
        else:
 
296
            # common, unaltered
 
297
            return None
 
298
 
 
299
    def get_basis_delta(self):
 
300
        """Return the complete inventory delta versus the basis inventory.
 
301
 
 
302
        This has been built up with the calls to record_delete and
 
303
        record_entry_contents. The client must have already called
 
304
        will_record_deletes() to indicate that they will be generating a
 
305
        complete delta.
 
306
 
 
307
        :return: An inventory delta, suitable for use with apply_delta, or
 
308
            Repository.add_inventory_by_delta, etc.
 
309
        """
 
310
        if not self._recording_deletes:
 
311
            raise AssertionError("recording deletes not activated.")
 
312
        return self._basis_delta
 
313
 
 
314
    def record_delete(self, path, file_id):
 
315
        """Record that a delete occured against a basis tree.
 
316
 
 
317
        This is an optional API - when used it adds items to the basis_delta
 
318
        being accumulated by the commit builder. It cannot be called unless the
 
319
        method will_record_deletes() has been called to inform the builder that
 
320
        a delta is being supplied.
 
321
 
 
322
        :param path: The path of the thing deleted.
 
323
        :param file_id: The file id that was deleted.
 
324
        """
 
325
        if not self._recording_deletes:
 
326
            raise AssertionError("recording deletes not activated.")
 
327
        delta = (path, None, file_id, None)
 
328
        self._basis_delta.append(delta)
 
329
        self._any_changes = True
 
330
        return delta
 
331
 
198
332
    def will_record_deletes(self):
199
333
        """Tell the commit builder that deletes are being notified.
200
334
 
202
336
        commit to be valid, deletes against the basis MUST be recorded via
203
337
        builder.record_delete().
204
338
        """
205
 
        raise NotImplementedError(self.will_record_deletes)
206
 
 
207
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
 
339
        self._recording_deletes = True
 
340
        try:
 
341
            basis_id = self.parents[0]
 
342
        except IndexError:
 
343
            basis_id = _mod_revision.NULL_REVISION
 
344
        self.basis_delta_revision = basis_id
 
345
 
 
346
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
347
        content_summary):
 
348
        """Record the content of ie from tree into the commit if needed.
 
349
 
 
350
        Side effect: sets ie.revision when unchanged
 
351
 
 
352
        :param ie: An inventory entry present in the commit.
 
353
        :param parent_invs: The inventories of the parent revisions of the
 
354
            commit.
 
355
        :param path: The path the entry is at in the tree.
 
356
        :param tree: The tree which contains this entry and should be used to
 
357
            obtain content.
 
358
        :param content_summary: Summary data from the tree about the paths
 
359
            content - stat, length, exec, sha/link target. This is only
 
360
            accessed when the entry has a revision of None - that is when it is
 
361
            a candidate to commit.
 
362
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
363
            change_delta is an inventory_delta change for this entry against
 
364
            the basis tree of the commit, or None if no change occured against
 
365
            the basis tree.
 
366
            version_recorded is True if a new version of the entry has been
 
367
            recorded. For instance, committing a merge where a file was only
 
368
            changed on the other side will return (delta, False).
 
369
            fs_hash is either None, or the hash details for the path (currently
 
370
            a tuple of the contents sha1 and the statvalue returned by
 
371
            tree.get_file_with_stat()).
 
372
        """
 
373
        if self.new_inventory.root is None:
 
374
            if ie.parent_id is not None:
 
375
                raise errors.RootMissing()
 
376
            self._check_root(ie, parent_invs, tree)
 
377
        if ie.revision is None:
 
378
            kind = content_summary[0]
 
379
        else:
 
380
            # ie is carried over from a prior commit
 
381
            kind = ie.kind
 
382
        # XXX: repository specific check for nested tree support goes here - if
 
383
        # the repo doesn't want nested trees we skip it ?
 
384
        if (kind == 'tree-reference' and
 
385
            not self.repository._format.supports_tree_reference):
 
386
            # mismatch between commit builder logic and repository:
 
387
            # this needs the entry creation pushed down into the builder.
 
388
            raise NotImplementedError('Missing repository subtree support.')
 
389
        self.new_inventory.add(ie)
 
390
 
 
391
        # TODO: slow, take it out of the inner loop.
 
392
        try:
 
393
            basis_inv = parent_invs[0]
 
394
        except IndexError:
 
395
            basis_inv = Inventory(root_id=None)
 
396
 
 
397
        # ie.revision is always None if the InventoryEntry is considered
 
398
        # for committing. We may record the previous parents revision if the
 
399
        # content is actually unchanged against a sole head.
 
400
        if ie.revision is not None:
 
401
            if not self._versioned_root and path == '':
 
402
                # repositories that do not version the root set the root's
 
403
                # revision to the new commit even when no change occurs (more
 
404
                # specifically, they do not record a revision on the root; and
 
405
                # the rev id is assigned to the root during deserialisation -
 
406
                # this masks when a change may have occurred against the basis.
 
407
                # To match this we always issue a delta, because the revision
 
408
                # of the root will always be changing.
 
409
                if ie.file_id in basis_inv:
 
410
                    delta = (basis_inv.id2path(ie.file_id), path,
 
411
                        ie.file_id, ie)
 
412
                else:
 
413
                    # add
 
414
                    delta = (None, path, ie.file_id, ie)
 
415
                self._basis_delta.append(delta)
 
416
                return delta, False, None
 
417
            else:
 
418
                # we don't need to commit this, because the caller already
 
419
                # determined that an existing revision of this file is
 
420
                # appropriate. If its not being considered for committing then
 
421
                # it and all its parents to the root must be unaltered so
 
422
                # no-change against the basis.
 
423
                if ie.revision == self._new_revision_id:
 
424
                    raise AssertionError("Impossible situation, a skipped "
 
425
                        "inventory entry (%r) claims to be modified in this "
 
426
                        "commit (%r).", (ie, self._new_revision_id))
 
427
                return None, False, None
 
428
        # XXX: Friction: parent_candidates should return a list not a dict
 
429
        #      so that we don't have to walk the inventories again.
 
430
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
431
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
432
        heads = []
 
433
        for inv in parent_invs:
 
434
            if ie.file_id in inv:
 
435
                old_rev = inv[ie.file_id].revision
 
436
                if old_rev in head_set:
 
437
                    heads.append(inv[ie.file_id].revision)
 
438
                    head_set.remove(inv[ie.file_id].revision)
 
439
 
 
440
        store = False
 
441
        # now we check to see if we need to write a new record to the
 
442
        # file-graph.
 
443
        # We write a new entry unless there is one head to the ancestors, and
 
444
        # the kind-derived content is unchanged.
 
445
 
 
446
        # Cheapest check first: no ancestors, or more the one head in the
 
447
        # ancestors, we write a new node.
 
448
        if len(heads) != 1:
 
449
            store = True
 
450
        if not store:
 
451
            # There is a single head, look it up for comparison
 
452
            parent_entry = parent_candiate_entries[heads[0]]
 
453
            # if the non-content specific data has changed, we'll be writing a
 
454
            # node:
 
455
            if (parent_entry.parent_id != ie.parent_id or
 
456
                parent_entry.name != ie.name):
 
457
                store = True
 
458
        # now we need to do content specific checks:
 
459
        if not store:
 
460
            # if the kind changed the content obviously has
 
461
            if kind != parent_entry.kind:
 
462
                store = True
 
463
        # Stat cache fingerprint feedback for the caller - None as we usually
 
464
        # don't generate one.
 
465
        fingerprint = None
 
466
        if kind == 'file':
 
467
            if content_summary[2] is None:
 
468
                raise ValueError("Files must not have executable = None")
 
469
            if not store:
 
470
                if (# if the file length changed we have to store:
 
471
                    parent_entry.text_size != content_summary[1] or
 
472
                    # if the exec bit has changed we have to store:
 
473
                    parent_entry.executable != content_summary[2]):
 
474
                    store = True
 
475
                elif parent_entry.text_sha1 == content_summary[3]:
 
476
                    # all meta and content is unchanged (using a hash cache
 
477
                    # hit to check the sha)
 
478
                    ie.revision = parent_entry.revision
 
479
                    ie.text_size = parent_entry.text_size
 
480
                    ie.text_sha1 = parent_entry.text_sha1
 
481
                    ie.executable = parent_entry.executable
 
482
                    return self._get_delta(ie, basis_inv, path), False, None
 
483
                else:
 
484
                    # Either there is only a hash change(no hash cache entry,
 
485
                    # or same size content change), or there is no change on
 
486
                    # this file at all.
 
487
                    # Provide the parent's hash to the store layer, so that the
 
488
                    # content is unchanged we will not store a new node.
 
489
                    nostore_sha = parent_entry.text_sha1
 
490
            if store:
 
491
                # We want to record a new node regardless of the presence or
 
492
                # absence of a content change in the file.
 
493
                nostore_sha = None
 
494
            ie.executable = content_summary[2]
 
495
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
496
            try:
 
497
                lines = file_obj.readlines()
 
498
            finally:
 
499
                file_obj.close()
 
500
            try:
 
501
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
502
                    ie.file_id, lines, heads, nostore_sha)
 
503
                # Let the caller know we generated a stat fingerprint.
 
504
                fingerprint = (ie.text_sha1, stat_value)
 
505
            except errors.ExistingContent:
 
506
                # Turns out that the file content was unchanged, and we were
 
507
                # only going to store a new node if it was changed. Carry over
 
508
                # the entry.
 
509
                ie.revision = parent_entry.revision
 
510
                ie.text_size = parent_entry.text_size
 
511
                ie.text_sha1 = parent_entry.text_sha1
 
512
                ie.executable = parent_entry.executable
 
513
                return self._get_delta(ie, basis_inv, path), False, None
 
514
        elif kind == 'directory':
 
515
            if not store:
 
516
                # all data is meta here, nothing specific to directory, so
 
517
                # carry over:
 
518
                ie.revision = parent_entry.revision
 
519
                return self._get_delta(ie, basis_inv, path), False, None
 
520
            lines = []
 
521
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
522
        elif kind == 'symlink':
 
523
            current_link_target = content_summary[3]
 
524
            if not store:
 
525
                # symlink target is not generic metadata, check if it has
 
526
                # changed.
 
527
                if current_link_target != parent_entry.symlink_target:
 
528
                    store = True
 
529
            if not store:
 
530
                # unchanged, carry over.
 
531
                ie.revision = parent_entry.revision
 
532
                ie.symlink_target = parent_entry.symlink_target
 
533
                return self._get_delta(ie, basis_inv, path), False, None
 
534
            ie.symlink_target = current_link_target
 
535
            lines = []
 
536
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
537
        elif kind == 'tree-reference':
 
538
            if not store:
 
539
                if content_summary[3] != parent_entry.reference_revision:
 
540
                    store = True
 
541
            if not store:
 
542
                # unchanged, carry over.
 
543
                ie.reference_revision = parent_entry.reference_revision
 
544
                ie.revision = parent_entry.revision
 
545
                return self._get_delta(ie, basis_inv, path), False, None
 
546
            ie.reference_revision = content_summary[3]
 
547
            lines = []
 
548
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
549
        else:
 
550
            raise NotImplementedError('unknown kind')
 
551
        ie.revision = self._new_revision_id
 
552
        self._any_changes = True
 
553
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
554
 
 
555
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
 
556
        _entry_factory=entry_factory):
208
557
        """Record a new tree via iter_changes.
209
558
 
210
559
        :param tree: The tree to obtain text contents from for changed objects.
215
564
            to basis_revision_id. The iterator must not include any items with
216
565
            a current kind of None - missing items must be either filtered out
217
566
            or errored-on beefore record_iter_changes sees the item.
 
567
        :param _entry_factory: Private method to bind entry_factory locally for
 
568
            performance.
218
569
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
219
570
            tree._observed_sha1.
220
571
        """
221
 
        raise NotImplementedError(self.record_iter_changes)
222
 
 
223
 
 
224
 
class RepositoryWriteLockResult(LogicalLockResult):
225
 
    """The result of write locking a repository.
226
 
 
227
 
    :ivar repository_token: The token obtained from the underlying lock, or
228
 
        None.
229
 
    :ivar unlock: A callable which will unlock the lock.
230
 
    """
231
 
 
232
 
    def __init__(self, unlock, repository_token):
233
 
        LogicalLockResult.__init__(self, unlock)
234
 
        self.repository_token = repository_token
235
 
 
236
 
    def __repr__(self):
237
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
238
 
            self.unlock)
 
572
        # Create an inventory delta based on deltas between all the parents and
 
573
        # deltas between all the parent inventories. We use inventory delta's 
 
574
        # between the inventory objects because iter_changes masks
 
575
        # last-changed-field only changes.
 
576
        # Working data:
 
577
        # file_id -> change map, change is fileid, paths, changed, versioneds,
 
578
        # parents, names, kinds, executables
 
579
        merged_ids = {}
 
580
        # {file_id -> revision_id -> inventory entry, for entries in parent
 
581
        # trees that are not parents[0]
 
582
        parent_entries = {}
 
583
        ghost_basis = False
 
584
        try:
 
585
            revtrees = list(self.repository.revision_trees(self.parents))
 
586
        except errors.NoSuchRevision:
 
587
            # one or more ghosts, slow path.
 
588
            revtrees = []
 
589
            for revision_id in self.parents:
 
590
                try:
 
591
                    revtrees.append(self.repository.revision_tree(revision_id))
 
592
                except errors.NoSuchRevision:
 
593
                    if not revtrees:
 
594
                        basis_revision_id = _mod_revision.NULL_REVISION
 
595
                        ghost_basis = True
 
596
                    revtrees.append(self.repository.revision_tree(
 
597
                        _mod_revision.NULL_REVISION))
 
598
        # The basis inventory from a repository 
 
599
        if revtrees:
 
600
            basis_inv = revtrees[0].inventory
 
601
        else:
 
602
            basis_inv = self.repository.revision_tree(
 
603
                _mod_revision.NULL_REVISION).inventory
 
604
        if len(self.parents) > 0:
 
605
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
606
                raise Exception(
 
607
                    "arbitrary basis parents not yet supported with merges")
 
608
            for revtree in revtrees[1:]:
 
609
                for change in revtree.inventory._make_delta(basis_inv):
 
610
                    if change[1] is None:
 
611
                        # Not present in this parent.
 
612
                        continue
 
613
                    if change[2] not in merged_ids:
 
614
                        if change[0] is not None:
 
615
                            basis_entry = basis_inv[change[2]]
 
616
                            merged_ids[change[2]] = [
 
617
                                # basis revid
 
618
                                basis_entry.revision,
 
619
                                # new tree revid
 
620
                                change[3].revision]
 
621
                            parent_entries[change[2]] = {
 
622
                                # basis parent
 
623
                                basis_entry.revision:basis_entry,
 
624
                                # this parent 
 
625
                                change[3].revision:change[3],
 
626
                                }
 
627
                        else:
 
628
                            merged_ids[change[2]] = [change[3].revision]
 
629
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
630
                    else:
 
631
                        merged_ids[change[2]].append(change[3].revision)
 
632
                        parent_entries[change[2]][change[3].revision] = change[3]
 
633
        else:
 
634
            merged_ids = {}
 
635
        # Setup the changes from the tree:
 
636
        # changes maps file_id -> (change, [parent revision_ids])
 
637
        changes= {}
 
638
        for change in iter_changes:
 
639
            # This probably looks up in basis_inv way to much.
 
640
            if change[1][0] is not None:
 
641
                head_candidate = [basis_inv[change[0]].revision]
 
642
            else:
 
643
                head_candidate = []
 
644
            changes[change[0]] = change, merged_ids.get(change[0],
 
645
                head_candidate)
 
646
        unchanged_merged = set(merged_ids) - set(changes)
 
647
        # Extend the changes dict with synthetic changes to record merges of
 
648
        # texts.
 
649
        for file_id in unchanged_merged:
 
650
            # Record a merged version of these items that did not change vs the
 
651
            # basis. This can be either identical parallel changes, or a revert
 
652
            # of a specific file after a merge. The recorded content will be
 
653
            # that of the current tree (which is the same as the basis), but
 
654
            # the per-file graph will reflect a merge.
 
655
            # NB:XXX: We are reconstructing path information we had, this
 
656
            # should be preserved instead.
 
657
            # inv delta  change: (file_id, (path_in_source, path_in_target),
 
658
            #   changed_content, versioned, parent, name, kind,
 
659
            #   executable)
 
660
            try:
 
661
                basis_entry = basis_inv[file_id]
 
662
            except errors.NoSuchId:
 
663
                # a change from basis->some_parents but file_id isn't in basis
 
664
                # so was new in the merge, which means it must have changed
 
665
                # from basis -> current, and as it hasn't the add was reverted
 
666
                # by the user. So we discard this change.
 
667
                pass
 
668
            else:
 
669
                change = (file_id,
 
670
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
671
                    False, (True, True),
 
672
                    (basis_entry.parent_id, basis_entry.parent_id),
 
673
                    (basis_entry.name, basis_entry.name),
 
674
                    (basis_entry.kind, basis_entry.kind),
 
675
                    (basis_entry.executable, basis_entry.executable))
 
676
                changes[file_id] = (change, merged_ids[file_id])
 
677
        # changes contains tuples with the change and a set of inventory
 
678
        # candidates for the file.
 
679
        # inv delta is:
 
680
        # old_path, new_path, file_id, new_inventory_entry
 
681
        seen_root = False # Is the root in the basis delta?
 
682
        inv_delta = self._basis_delta
 
683
        modified_rev = self._new_revision_id
 
684
        for change, head_candidates in changes.values():
 
685
            if change[3][1]: # versioned in target.
 
686
                # Several things may be happening here:
 
687
                # We may have a fork in the per-file graph
 
688
                #  - record a change with the content from tree
 
689
                # We may have a change against < all trees  
 
690
                #  - carry over the tree that hasn't changed
 
691
                # We may have a change against all trees
 
692
                #  - record the change with the content from tree
 
693
                kind = change[6][1]
 
694
                file_id = change[0]
 
695
                entry = _entry_factory[kind](file_id, change[5][1],
 
696
                    change[4][1])
 
697
                head_set = self._heads(change[0], set(head_candidates))
 
698
                heads = []
 
699
                # Preserve ordering.
 
700
                for head_candidate in head_candidates:
 
701
                    if head_candidate in head_set:
 
702
                        heads.append(head_candidate)
 
703
                        head_set.remove(head_candidate)
 
704
                carried_over = False
 
705
                if len(heads) == 1:
 
706
                    # Could be a carry-over situation:
 
707
                    parent_entry_revs = parent_entries.get(file_id, None)
 
708
                    if parent_entry_revs:
 
709
                        parent_entry = parent_entry_revs.get(heads[0], None)
 
710
                    else:
 
711
                        parent_entry = None
 
712
                    if parent_entry is None:
 
713
                        # The parent iter_changes was called against is the one
 
714
                        # that is the per-file head, so any change is relevant
 
715
                        # iter_changes is valid.
 
716
                        carry_over_possible = False
 
717
                    else:
 
718
                        # could be a carry over situation
 
719
                        # A change against the basis may just indicate a merge,
 
720
                        # we need to check the content against the source of the
 
721
                        # merge to determine if it was changed after the merge
 
722
                        # or carried over.
 
723
                        if (parent_entry.kind != entry.kind or
 
724
                            parent_entry.parent_id != entry.parent_id or
 
725
                            parent_entry.name != entry.name):
 
726
                            # Metadata common to all entries has changed
 
727
                            # against per-file parent
 
728
                            carry_over_possible = False
 
729
                        else:
 
730
                            carry_over_possible = True
 
731
                        # per-type checks for changes against the parent_entry
 
732
                        # are done below.
 
733
                else:
 
734
                    # Cannot be a carry-over situation
 
735
                    carry_over_possible = False
 
736
                # Populate the entry in the delta
 
737
                if kind == 'file':
 
738
                    # XXX: There is still a small race here: If someone reverts the content of a file
 
739
                    # after iter_changes examines and decides it has changed,
 
740
                    # we will unconditionally record a new version even if some
 
741
                    # other process reverts it while commit is running (with
 
742
                    # the revert happening after iter_changes did it's
 
743
                    # examination).
 
744
                    if change[7][1]:
 
745
                        entry.executable = True
 
746
                    else:
 
747
                        entry.executable = False
 
748
                    if (carry_over_possible and 
 
749
                        parent_entry.executable == entry.executable):
 
750
                            # Check the file length, content hash after reading
 
751
                            # the file.
 
752
                            nostore_sha = parent_entry.text_sha1
 
753
                    else:
 
754
                        nostore_sha = None
 
755
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
 
756
                    try:
 
757
                        lines = file_obj.readlines()
 
758
                    finally:
 
759
                        file_obj.close()
 
760
                    try:
 
761
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
 
762
                            file_id, lines, heads, nostore_sha)
 
763
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
764
                    except errors.ExistingContent:
 
765
                        # No content change against a carry_over parent
 
766
                        # Perhaps this should also yield a fs hash update?
 
767
                        carried_over = True
 
768
                        entry.text_size = parent_entry.text_size
 
769
                        entry.text_sha1 = parent_entry.text_sha1
 
770
                elif kind == 'symlink':
 
771
                    # Wants a path hint?
 
772
                    entry.symlink_target = tree.get_symlink_target(file_id)
 
773
                    if (carry_over_possible and
 
774
                        parent_entry.symlink_target == entry.symlink_target):
 
775
                        carried_over = True
 
776
                    else:
 
777
                        self._add_text_to_weave(change[0], [], heads, None)
 
778
                elif kind == 'directory':
 
779
                    if carry_over_possible:
 
780
                        carried_over = True
 
781
                    else:
 
782
                        # Nothing to set on the entry.
 
783
                        # XXX: split into the Root and nonRoot versions.
 
784
                        if change[1][1] != '' or self.repository.supports_rich_root():
 
785
                            self._add_text_to_weave(change[0], [], heads, None)
 
786
                elif kind == 'tree-reference':
 
787
                    if not self.repository._format.supports_tree_reference:
 
788
                        # This isn't quite sane as an error, but we shouldn't
 
789
                        # ever see this code path in practice: tree's don't
 
790
                        # permit references when the repo doesn't support tree
 
791
                        # references.
 
792
                        raise errors.UnsupportedOperation(tree.add_reference,
 
793
                            self.repository)
 
794
                    entry.reference_revision = \
 
795
                        tree.get_reference_revision(change[0])
 
796
                    if (carry_over_possible and
 
797
                        parent_entry.reference_revision == reference_revision):
 
798
                        carried_over = True
 
799
                    else:
 
800
                        self._add_text_to_weave(change[0], [], heads, None)
 
801
                else:
 
802
                    raise AssertionError('unknown kind %r' % kind)
 
803
                if not carried_over:
 
804
                    entry.revision = modified_rev
 
805
                else:
 
806
                    entry.revision = parent_entry.revision
 
807
            else:
 
808
                entry = None
 
809
            new_path = change[1][1]
 
810
            inv_delta.append((change[1][0], new_path, change[0], entry))
 
811
            if new_path == '':
 
812
                seen_root = True
 
813
        self.new_inventory = None
 
814
        if len(inv_delta):
 
815
            self._any_changes = True
 
816
        if not seen_root:
 
817
            # housekeeping root entry changes do not affect no-change commits.
 
818
            self._require_root_change(tree)
 
819
        self.basis_delta_revision = basis_revision_id
 
820
 
 
821
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
822
        # Note: as we read the content directly from the tree, we know its not
 
823
        # been turned into unicode or badly split - but a broken tree
 
824
        # implementation could give us bad output from readlines() so this is
 
825
        # not a guarantee of safety. What would be better is always checking
 
826
        # the content during test suite execution. RBC 20070912
 
827
        parent_keys = tuple((file_id, parent) for parent in parents)
 
828
        return self.repository.texts.add_lines(
 
829
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
830
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
831
            check_content=False)[0:2]
 
832
 
 
833
 
 
834
class RootCommitBuilder(CommitBuilder):
 
835
    """This commitbuilder actually records the root id"""
 
836
 
 
837
    # the root entry gets versioned properly by this builder.
 
838
    _versioned_root = True
 
839
 
 
840
    def _check_root(self, ie, parent_invs, tree):
 
841
        """Helper for record_entry_contents.
 
842
 
 
843
        :param ie: An entry being added.
 
844
        :param parent_invs: The inventories of the parent revisions of the
 
845
            commit.
 
846
        :param tree: The tree that is being committed.
 
847
        """
 
848
 
 
849
    def _require_root_change(self, tree):
 
850
        """Enforce an appropriate root object change.
 
851
 
 
852
        This is called once when record_iter_changes is called, if and only if
 
853
        the root was not in the delta calculated by record_iter_changes.
 
854
 
 
855
        :param tree: The tree which is being committed.
 
856
        """
 
857
        # versioned roots do not change unless the tree found a change.
239
858
 
240
859
 
241
860
######################################################################
242
861
# Repositories
243
862
 
244
 
 
245
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
863
class Repository(object):
246
864
    """Repository holding history for one or more branches.
247
865
 
248
866
    The repository holds and retrieves historical information including
249
867
    revisions and file history.  It's normally accessed only by the Branch,
250
868
    which views a particular line of development through that history.
251
869
 
252
 
    See VersionedFileRepository in bzrlib.vf_repository for the
253
 
    base class for most Bazaar repositories.
 
870
    The Repository builds on top of some byte storage facilies (the revisions,
 
871
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
872
    which respectively provide byte storage and a means to access the (possibly
 
873
    remote) disk.
 
874
 
 
875
    The byte storage facilities are addressed via tuples, which we refer to
 
876
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
877
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
878
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
 
879
    byte string made up of a hash identifier and a hash value.
 
880
    We use this interface because it allows low friction with the underlying
 
881
    code that implements disk indices, network encoding and other parts of
 
882
    bzrlib.
 
883
 
 
884
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
885
        the serialised revisions for the repository. This can be used to obtain
 
886
        revision graph information or to access raw serialised revisions.
 
887
        The result of trying to insert data into the repository via this store
 
888
        is undefined: it should be considered read-only except for implementors
 
889
        of repositories.
 
890
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
891
        the serialised signatures for the repository. This can be used to
 
892
        obtain access to raw serialised signatures.  The result of trying to
 
893
        insert data into the repository via this store is undefined: it should
 
894
        be considered read-only except for implementors of repositories.
 
895
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
896
        the serialised inventories for the repository. This can be used to
 
897
        obtain unserialised inventories.  The result of trying to insert data
 
898
        into the repository via this store is undefined: it should be
 
899
        considered read-only except for implementors of repositories.
 
900
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
901
        texts of files and directories for the repository. This can be used to
 
902
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
903
        is usually a better interface for accessing file texts.
 
904
        The result of trying to insert data into the repository via this store
 
905
        is undefined: it should be considered read-only except for implementors
 
906
        of repositories.
 
907
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
 
908
        any data the repository chooses to store or have indexed by its hash.
 
909
        The result of trying to insert data into the repository via this store
 
910
        is undefined: it should be considered read-only except for implementors
 
911
        of repositories.
 
912
    :ivar _transport: Transport for file access to repository, typically
 
913
        pointing to .bzr/repository.
254
914
    """
255
915
 
 
916
    # What class to use for a CommitBuilder. Often its simpler to change this
 
917
    # in a Repository class subclass rather than to override
 
918
    # get_commit_builder.
 
919
    _commit_builder_class = CommitBuilder
 
920
    # The search regex used by xml based repositories to determine what things
 
921
    # where changed in a single commit.
 
922
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
923
        r'file_id="(?P<file_id>[^"]+)"'
 
924
        r'.* revision="(?P<revision_id>[^"]+)"'
 
925
        )
 
926
 
256
927
    def abort_write_group(self, suppress_errors=False):
257
928
        """Commit the contents accrued within the current write group.
258
929
 
264
935
        """
265
936
        if self._write_group is not self.get_transaction():
266
937
            # has an unlock or relock occured ?
267
 
            if suppress_errors:
268
 
                mutter(
269
 
                '(suppressed) mismatched lock context and write group. %r, %r',
270
 
                self._write_group, self.get_transaction())
271
 
                return
272
938
            raise errors.BzrError(
273
939
                'mismatched lock context and write group. %r, %r' %
274
940
                (self._write_group, self.get_transaction()))
301
967
 
302
968
        :param repository: A repository.
303
969
        """
304
 
        raise NotImplementedError(self.add_fallback_repository)
 
970
        if not self._format.supports_external_lookups:
 
971
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
972
        if self.is_locked():
 
973
            # This repository will call fallback.unlock() when we transition to
 
974
            # the unlocked state, so we make sure to increment the lock count
 
975
            repository.lock_read()
 
976
        self._check_fallback_repository(repository)
 
977
        self._fallback_repositories.append(repository)
 
978
        self.texts.add_fallback_versioned_files(repository.texts)
 
979
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
980
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
981
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
982
        if self.chk_bytes is not None:
 
983
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
305
984
 
306
985
    def _check_fallback_repository(self, repository):
307
986
        """Check that this repository can fallback to repository safely.
312
991
        """
313
992
        return InterRepository._assert_same_model(self, repository)
314
993
 
 
994
    def add_inventory(self, revision_id, inv, parents):
 
995
        """Add the inventory inv to the repository as revision_id.
 
996
 
 
997
        :param parents: The revision ids of the parents that revision_id
 
998
                        is known to have and are in the repository already.
 
999
 
 
1000
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
1001
            repository format specific) of the serialized inventory.
 
1002
        """
 
1003
        if not self.is_in_write_group():
 
1004
            raise AssertionError("%r not in write group" % (self,))
 
1005
        _mod_revision.check_not_reserved_id(revision_id)
 
1006
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
1007
            raise AssertionError(
 
1008
                "Mismatch between inventory revision"
 
1009
                " id and insertion revid (%r, %r)"
 
1010
                % (inv.revision_id, revision_id))
 
1011
        if inv.root is None:
 
1012
            raise AssertionError()
 
1013
        return self._add_inventory_checked(revision_id, inv, parents)
 
1014
 
 
1015
    def _add_inventory_checked(self, revision_id, inv, parents):
 
1016
        """Add inv to the repository after checking the inputs.
 
1017
 
 
1018
        This function can be overridden to allow different inventory styles.
 
1019
 
 
1020
        :seealso: add_inventory, for the contract.
 
1021
        """
 
1022
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1023
        return self._inventory_add_lines(revision_id, parents,
 
1024
            inv_lines, check_content=False)
 
1025
 
 
1026
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1027
                               parents, basis_inv=None, propagate_caches=False):
 
1028
        """Add a new inventory expressed as a delta against another revision.
 
1029
 
 
1030
        :param basis_revision_id: The inventory id the delta was created
 
1031
            against. (This does not have to be a direct parent.)
 
1032
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1033
            details).
 
1034
        :param new_revision_id: The revision id that the inventory is being
 
1035
            added for.
 
1036
        :param parents: The revision ids of the parents that revision_id is
 
1037
            known to have and are in the repository already. These are supplied
 
1038
            for repositories that depend on the inventory graph for revision
 
1039
            graph access, as well as for those that pun ancestry with delta
 
1040
            compression.
 
1041
        :param basis_inv: The basis inventory if it is already known,
 
1042
            otherwise None.
 
1043
        :param propagate_caches: If True, the caches for this inventory are
 
1044
          copied to and updated for the result if possible.
 
1045
 
 
1046
        :returns: (validator, new_inv)
 
1047
            The validator(which is a sha1 digest, though what is sha'd is
 
1048
            repository format specific) of the serialized inventory, and the
 
1049
            resulting inventory.
 
1050
        """
 
1051
        if not self.is_in_write_group():
 
1052
            raise AssertionError("%r not in write group" % (self,))
 
1053
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1054
        basis_tree = self.revision_tree(basis_revision_id)
 
1055
        basis_tree.lock_read()
 
1056
        try:
 
1057
            # Note that this mutates the inventory of basis_tree, which not all
 
1058
            # inventory implementations may support: A better idiom would be to
 
1059
            # return a new inventory, but as there is no revision tree cache in
 
1060
            # repository this is safe for now - RBC 20081013
 
1061
            if basis_inv is None:
 
1062
                basis_inv = basis_tree.inventory
 
1063
            basis_inv.apply_delta(delta)
 
1064
            basis_inv.revision_id = new_revision_id
 
1065
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1066
                    basis_inv)
 
1067
        finally:
 
1068
            basis_tree.unlock()
 
1069
 
 
1070
    def _inventory_add_lines(self, revision_id, parents, lines,
 
1071
        check_content=True):
 
1072
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
1073
        parents = [(parent,) for parent in parents]
 
1074
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1075
            check_content=check_content)[0]
 
1076
 
 
1077
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
1078
        """Add rev to the revision store as revision_id.
 
1079
 
 
1080
        :param revision_id: the revision id to use.
 
1081
        :param rev: The revision object.
 
1082
        :param inv: The inventory for the revision. if None, it will be looked
 
1083
                    up in the inventory storer
 
1084
        :param config: If None no digital signature will be created.
 
1085
                       If supplied its signature_needed method will be used
 
1086
                       to determine if a signature should be made.
 
1087
        """
 
1088
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
1089
        #       rev.parent_ids?
 
1090
        _mod_revision.check_not_reserved_id(revision_id)
 
1091
        if config is not None and config.signature_needed():
 
1092
            if inv is None:
 
1093
                inv = self.get_inventory(revision_id)
 
1094
            plaintext = Testament(rev, inv).as_short_text()
 
1095
            self.store_revision_signature(
 
1096
                gpg.GPGStrategy(config), plaintext, revision_id)
 
1097
        # check inventory present
 
1098
        if not self.inventories.get_parent_map([(revision_id,)]):
 
1099
            if inv is None:
 
1100
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1101
                                                     self.inventories)
 
1102
            else:
 
1103
                # yes, this is not suitable for adding with ghosts.
 
1104
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1105
                                                        rev.parent_ids)
 
1106
        else:
 
1107
            key = (revision_id,)
 
1108
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1109
        self._add_revision(rev)
 
1110
 
 
1111
    def _add_revision(self, revision):
 
1112
        text = self._serializer.write_revision_to_string(revision)
 
1113
        key = (revision.revision_id,)
 
1114
        parents = tuple((parent,) for parent in revision.parent_ids)
 
1115
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
 
1116
 
315
1117
    def all_revision_ids(self):
316
1118
        """Returns a list of all the revision ids in the repository.
317
1119
 
340
1142
        """
341
1143
        self.control_files.break_lock()
342
1144
 
 
1145
    @needs_read_lock
 
1146
    def _eliminate_revisions_not_present(self, revision_ids):
 
1147
        """Check every revision id in revision_ids to see if we have it.
 
1148
 
 
1149
        Returns a set of the present revisions.
 
1150
        """
 
1151
        result = []
 
1152
        graph = self.get_graph()
 
1153
        parent_map = graph.get_parent_map(revision_ids)
 
1154
        # The old API returned a list, should this actually be a set?
 
1155
        return parent_map.keys()
 
1156
 
343
1157
    @staticmethod
344
1158
    def create(a_bzrdir):
345
1159
        """Construct the current default format repository in a_bzrdir."""
350
1164
 
351
1165
        :param _format: The format of the repository on disk.
352
1166
        :param a_bzrdir: The BzrDir of the repository.
353
 
        :param control_files: Control files to use for locking, etc.
 
1167
 
 
1168
        In the future we will have a single api for all stores for
 
1169
        getting file texts, inventories and revisions, then
 
1170
        this construct will accept instances of those things.
354
1171
        """
355
 
        # In the future we will have a single api for all stores for
356
 
        # getting file texts, inventories and revisions, then
357
 
        # this construct will accept instances of those things.
358
1172
        super(Repository, self).__init__()
359
1173
        self._format = _format
360
1174
        # the following are part of the public API for Repository:
363
1177
        self._transport = control_files._transport
364
1178
        self.base = self._transport.base
365
1179
        # for tests
 
1180
        self._reconcile_does_inventory_gc = True
 
1181
        self._reconcile_fixes_text_parents = False
 
1182
        self._reconcile_backsup_inventory = True
 
1183
        # not right yet - should be more semantically clear ?
 
1184
        #
 
1185
        # TODO: make sure to construct the right store classes, etc, depending
 
1186
        # on whether escaping is required.
 
1187
        self._warn_if_deprecated()
366
1188
        self._write_group = None
367
1189
        # Additional places to query for data.
368
1190
        self._fallback_repositories = []
369
 
 
370
 
    @property
371
 
    def user_transport(self):
372
 
        return self.bzrdir.user_transport
373
 
 
374
 
    @property
375
 
    def control_transport(self):
376
 
        return self._transport
 
1191
        # An InventoryEntry cache, used during deserialization
 
1192
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
377
1193
 
378
1194
    def __repr__(self):
379
 
        if self._fallback_repositories:
380
 
            return '%s(%r, fallback_repositories=%r)' % (
381
 
                self.__class__.__name__,
382
 
                self.base,
383
 
                self._fallback_repositories)
384
 
        else:
385
 
            return '%s(%r)' % (self.__class__.__name__,
386
 
                               self.base)
387
 
 
388
 
    def _has_same_fallbacks(self, other_repo):
389
 
        """Returns true if the repositories have the same fallbacks."""
390
 
        my_fb = self._fallback_repositories
391
 
        other_fb = other_repo._fallback_repositories
392
 
        if len(my_fb) != len(other_fb):
393
 
            return False
394
 
        for f, g in zip(my_fb, other_fb):
395
 
            if not f.has_same_location(g):
396
 
                return False
397
 
        return True
 
1195
        return '%s(%r)' % (self.__class__.__name__,
 
1196
                           self.base)
398
1197
 
399
1198
    def has_same_location(self, other):
400
1199
        """Returns a boolean indicating if this repository is at the same
428
1227
        data during reads, and allows a 'write_group' to be obtained. Write
429
1228
        groups must be used for actual data insertion.
430
1229
 
431
 
        A token should be passed in if you know that you have locked the object
432
 
        some other way, and need to synchronise this object's state with that
433
 
        fact.
434
 
 
435
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
436
 
 
437
1230
        :param token: if this is already locked, then lock_write will fail
438
1231
            unless the token matches the existing lock.
439
1232
        :returns: a token if this instance supports tokens, otherwise None.
442
1235
        :raises MismatchedToken: if the specified token doesn't match the token
443
1236
            of the existing lock.
444
1237
        :seealso: start_write_group.
445
 
        :return: A RepositoryWriteLockResult.
 
1238
 
 
1239
        A token should be passed in if you know that you have locked the object
 
1240
        some other way, and need to synchronise this object's state with that
 
1241
        fact.
 
1242
 
 
1243
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
446
1244
        """
447
1245
        locked = self.is_locked()
448
 
        token = self.control_files.lock_write(token=token)
 
1246
        result = self.control_files.lock_write(token=token)
449
1247
        if not locked:
450
 
            self._warn_if_deprecated()
451
 
            self._note_lock('w')
452
1248
            for repo in self._fallback_repositories:
453
1249
                # Writes don't affect fallback repos
454
1250
                repo.lock_read()
455
1251
            self._refresh_data()
456
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1252
        return result
457
1253
 
458
1254
    def lock_read(self):
459
 
        """Lock the repository for read operations.
460
 
 
461
 
        :return: An object with an unlock method which will release the lock
462
 
            obtained.
463
 
        """
464
1255
        locked = self.is_locked()
465
1256
        self.control_files.lock_read()
466
1257
        if not locked:
467
 
            self._warn_if_deprecated()
468
 
            self._note_lock('r')
469
1258
            for repo in self._fallback_repositories:
470
1259
                repo.lock_read()
471
1260
            self._refresh_data()
472
 
        return LogicalLockResult(self.unlock)
473
1261
 
474
1262
    def get_physical_lock_status(self):
475
1263
        return self.control_files.get_physical_lock_status()
511
1299
        if revid and committers:
512
1300
            result['committers'] = 0
513
1301
        if revid and revid != _mod_revision.NULL_REVISION:
514
 
            graph = self.get_graph()
515
1302
            if committers:
516
1303
                all_committers = set()
517
 
            revisions = [r for (r, p) in graph.iter_ancestry([revid])
518
 
                        if r != _mod_revision.NULL_REVISION]
519
 
            last_revision = None
 
1304
            revisions = self.get_ancestry(revid)
 
1305
            # pop the leading None
 
1306
            revisions.pop(0)
 
1307
            first_revision = None
520
1308
            if not committers:
521
1309
                # ignore the revisions in the middle - just grab first and last
522
1310
                revisions = revisions[0], revisions[-1]
523
1311
            for revision in self.get_revisions(revisions):
524
 
                if not last_revision:
525
 
                    last_revision = revision
 
1312
                if not first_revision:
 
1313
                    first_revision = revision
526
1314
                if committers:
527
1315
                    all_committers.add(revision.committer)
528
 
            first_revision = revision
 
1316
            last_revision = revision
529
1317
            if committers:
530
1318
                result['committers'] = len(all_committers)
531
1319
            result['firstrev'] = (first_revision.timestamp,
532
1320
                first_revision.timezone)
533
1321
            result['latestrev'] = (last_revision.timestamp,
534
1322
                last_revision.timezone)
 
1323
 
 
1324
        # now gather global repository information
 
1325
        # XXX: This is available for many repos regardless of listability.
 
1326
        if self.bzrdir.root_transport.listable():
 
1327
            # XXX: do we want to __define len__() ?
 
1328
            # Maybe the versionedfiles object should provide a different
 
1329
            # method to get the number of keys.
 
1330
            result['revisions'] = len(self.revisions.keys())
 
1331
            # result['size'] = t
535
1332
        return result
536
1333
 
537
1334
    def find_branches(self, using=False):
542
1339
        :param using: If True, list only branches using this repository.
543
1340
        """
544
1341
        if using and not self.is_shared():
545
 
            return self.bzrdir.list_branches()
 
1342
            try:
 
1343
                return [self.bzrdir.open_branch()]
 
1344
            except errors.NotBranchError:
 
1345
                return []
546
1346
        class Evaluator(object):
547
1347
 
548
1348
            def __init__(self):
557
1357
                    except errors.NoRepositoryPresent:
558
1358
                        pass
559
1359
                    else:
560
 
                        return False, ([], repository)
 
1360
                        return False, (None, repository)
561
1361
                self.first_call = False
562
 
                value = (bzrdir.list_branches(), None)
 
1362
                try:
 
1363
                    value = (bzrdir.open_branch(), None)
 
1364
                except errors.NotBranchError:
 
1365
                    value = (None, None)
563
1366
                return True, value
564
1367
 
565
 
        ret = []
566
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
567
 
                self.user_transport, evaluate=Evaluator()):
568
 
            if branches is not None:
569
 
                ret.extend(branches)
 
1368
        branches = []
 
1369
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1370
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1371
            if branch is not None:
 
1372
                branches.append(branch)
570
1373
            if not using and repository is not None:
571
 
                ret.extend(repository.find_branches())
572
 
        return ret
 
1374
                branches.extend(repository.find_branches())
 
1375
        return branches
573
1376
 
574
1377
    @needs_read_lock
575
 
    def search_missing_revision_ids(self, other,
576
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
577
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
578
 
            limit=None):
 
1378
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
579
1379
        """Return the revision ids that other has that this does not.
580
1380
 
581
1381
        These are returned in topological order.
582
1382
 
583
1383
        revision_id: only return revision ids included by revision_id.
584
1384
        """
585
 
        if symbol_versioning.deprecated_passed(revision_id):
586
 
            symbol_versioning.warn(
587
 
                'search_missing_revision_ids(revision_id=...) was '
588
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
589
 
                DeprecationWarning, stacklevel=3)
590
 
            if revision_ids is not None:
591
 
                raise AssertionError(
592
 
                    'revision_ids is mutually exclusive with revision_id')
593
 
            if revision_id is not None:
594
 
                revision_ids = [revision_id]
595
1385
        return InterRepository.get(other, self).search_missing_revision_ids(
596
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
597
 
            if_present_ids=if_present_ids, limit=limit)
 
1386
            revision_id, find_ghosts)
598
1387
 
599
1388
    @staticmethod
600
1389
    def open(base):
618
1407
        """Commit the contents accrued within the current write group.
619
1408
 
620
1409
        :seealso: start_write_group.
621
 
        
622
 
        :return: it may return an opaque hint that can be passed to 'pack'.
623
1410
        """
624
1411
        if self._write_group is not self.get_transaction():
625
1412
            # has an unlock or relock occured ?
626
1413
            raise errors.BzrError('mismatched lock context %r and '
627
1414
                'write group %r.' %
628
1415
                (self.get_transaction(), self._write_group))
629
 
        result = self._commit_write_group()
 
1416
        self._commit_write_group()
630
1417
        self._write_group = None
631
 
        return result
632
1418
 
633
1419
    def _commit_write_group(self):
634
1420
        """Template method for per-repository write group cleanup.
642
1428
    def suspend_write_group(self):
643
1429
        raise errors.UnsuspendableWriteGroup(self)
644
1430
 
 
1431
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1432
        """Return the keys of missing inventory parents for revisions added in
 
1433
        this write group.
 
1434
 
 
1435
        A revision is not complete if the inventory delta for that revision
 
1436
        cannot be calculated.  Therefore if the parent inventories of a
 
1437
        revision are not present, the revision is incomplete, and e.g. cannot
 
1438
        be streamed by a smart server.  This method finds missing inventory
 
1439
        parents for revisions added in this write group.
 
1440
        """
 
1441
        if not self._format.supports_external_lookups:
 
1442
            # This is only an issue for stacked repositories
 
1443
            return set()
 
1444
        if not self.is_in_write_group():
 
1445
            raise AssertionError('not in a write group')
 
1446
 
 
1447
        # XXX: We assume that every added revision already has its
 
1448
        # corresponding inventory, so we only check for parent inventories that
 
1449
        # might be missing, rather than all inventories.
 
1450
        parents = set(self.revisions._index.get_missing_parents())
 
1451
        parents.discard(_mod_revision.NULL_REVISION)
 
1452
        unstacked_inventories = self.inventories._index
 
1453
        present_inventories = unstacked_inventories.get_parent_map(
 
1454
            key[-1:] for key in parents)
 
1455
        parents.difference_update(present_inventories)
 
1456
        if len(parents) == 0:
 
1457
            # No missing parent inventories.
 
1458
            return set()
 
1459
        if not check_for_missing_texts:
 
1460
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1461
        # Ok, now we have a list of missing inventories.  But these only matter
 
1462
        # if the inventories that reference them are missing some texts they
 
1463
        # appear to introduce.
 
1464
        # XXX: Texts referenced by all added inventories need to be present,
 
1465
        # but at the moment we're only checking for texts referenced by
 
1466
        # inventories at the graph's edge.
 
1467
        key_deps = self.revisions._index._key_dependencies
 
1468
        key_deps.add_keys(present_inventories)
 
1469
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1470
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1471
        missing_texts = set()
 
1472
        for file_id, version_ids in file_ids.iteritems():
 
1473
            missing_texts.update(
 
1474
                (file_id, version_id) for version_id in version_ids)
 
1475
        present_texts = self.texts.get_parent_map(missing_texts)
 
1476
        missing_texts.difference_update(present_texts)
 
1477
        if not missing_texts:
 
1478
            # No texts are missing, so all revisions and their deltas are
 
1479
            # reconstructable.
 
1480
            return set()
 
1481
        # Alternatively the text versions could be returned as the missing
 
1482
        # keys, but this is likely to be less data.
 
1483
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1484
        return missing_keys
 
1485
 
645
1486
    def refresh_data(self):
646
 
        """Re-read any data needed to synchronise with disk.
 
1487
        """Re-read any data needed to to synchronise with disk.
647
1488
 
648
1489
        This method is intended to be called after another repository instance
649
1490
        (such as one used by a smart server) has inserted data into the
650
 
        repository. On all repositories this will work outside of write groups.
651
 
        Some repository formats (pack and newer for bzrlib native formats)
652
 
        support refresh_data inside write groups. If called inside a write
653
 
        group on a repository that does not support refreshing in a write group
654
 
        IsInWriteGroupError will be raised.
 
1491
        repository. It may not be called during a write group, but may be
 
1492
        called at any other time.
655
1493
        """
 
1494
        if self.is_in_write_group():
 
1495
            raise errors.InternalBzrError(
 
1496
                "May not refresh_data while in a write group.")
656
1497
        self._refresh_data()
657
1498
 
658
1499
    def resume_write_group(self, tokens):
667
1508
    def _resume_write_group(self, tokens):
668
1509
        raise errors.UnsuspendableWriteGroup(self)
669
1510
 
670
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1511
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
671
1512
            fetch_spec=None):
672
1513
        """Fetch the content required to construct revision_id from source.
673
1514
 
696
1537
            raise errors.InternalBzrError(
697
1538
                "May not fetch while in a write group.")
698
1539
        # fast path same-url fetch operations
699
 
        # TODO: lift out to somewhere common with RemoteRepository
700
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
701
 
        if (self.has_same_location(source)
702
 
            and fetch_spec is None
703
 
            and self._has_same_fallbacks(source)):
 
1540
        if self.has_same_location(source) and fetch_spec is None:
704
1541
            # check that last_revision is in 'from' and then return a
705
1542
            # no-operation.
706
1543
            if (revision_id is not None and
707
1544
                not _mod_revision.is_null(revision_id)):
708
1545
                self.get_revision(revision_id)
709
1546
            return 0, []
 
1547
        # if there is no specific appropriate InterRepository, this will get
 
1548
        # the InterRepository base class, which raises an
 
1549
        # IncompatibleRepositories when asked to fetch.
710
1550
        inter = InterRepository.get(source, self)
711
 
        return inter.fetch(revision_id=revision_id,
 
1551
        return inter.fetch(revision_id=revision_id, pb=pb,
712
1552
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
713
1553
 
714
1554
    def create_bundle(self, target, base, fileobj, format=None):
716
1556
 
717
1557
    def get_commit_builder(self, branch, parents, config, timestamp=None,
718
1558
                           timezone=None, committer=None, revprops=None,
719
 
                           revision_id=None, lossy=False):
 
1559
                           revision_id=None):
720
1560
        """Obtain a CommitBuilder for this repository.
721
1561
 
722
1562
        :param branch: Branch to commit to.
727
1567
        :param committer: Optional committer to set for commit.
728
1568
        :param revprops: Optional dictionary of revision properties.
729
1569
        :param revision_id: Optional revision id.
730
 
        :param lossy: Whether to discard data that can not be natively
731
 
            represented, when pushing to a foreign VCS
732
1570
        """
733
 
        raise NotImplementedError(self.get_commit_builder)
 
1571
        result = self._commit_builder_class(self, parents, config,
 
1572
            timestamp, timezone, committer, revprops, revision_id)
 
1573
        self.start_write_group()
 
1574
        return result
734
1575
 
735
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
736
1576
    def unlock(self):
737
1577
        if (self.control_files._lock_count == 1 and
738
1578
            self.control_files._lock_mode == 'w'):
743
1583
                    'Must end write groups before releasing write locks.')
744
1584
        self.control_files.unlock()
745
1585
        if self.control_files._lock_count == 0:
 
1586
            self._inventory_entry_cache.clear()
746
1587
            for repo in self._fallback_repositories:
747
1588
                repo.unlock()
748
1589
 
813
1654
                dest_repo = a_bzrdir.open_repository()
814
1655
        return dest_repo
815
1656
 
 
1657
    def _get_sink(self):
 
1658
        """Return a sink for streaming into this repository."""
 
1659
        return StreamSink(self)
 
1660
 
 
1661
    def _get_source(self, to_format):
 
1662
        """Return a source for streaming from this repository."""
 
1663
        return StreamSource(self, to_format)
 
1664
 
816
1665
    @needs_read_lock
817
1666
    def has_revision(self, revision_id):
818
1667
        """True if this repository has a copy of the revision."""
825
1674
        :param revision_ids: An iterable of revision_ids.
826
1675
        :return: A set of the revision_ids that were present.
827
1676
        """
828
 
        raise NotImplementedError(self.has_revisions)
 
1677
        parent_map = self.revisions.get_parent_map(
 
1678
            [(rev_id,) for rev_id in revision_ids])
 
1679
        result = set()
 
1680
        if _mod_revision.NULL_REVISION in revision_ids:
 
1681
            result.add(_mod_revision.NULL_REVISION)
 
1682
        result.update([key[0] for key in parent_map])
 
1683
        return result
829
1684
 
830
1685
    @needs_read_lock
831
1686
    def get_revision(self, revision_id):
832
1687
        """Return the Revision object for a named revision."""
833
1688
        return self.get_revisions([revision_id])[0]
834
1689
 
 
1690
    @needs_read_lock
835
1691
    def get_revision_reconcile(self, revision_id):
836
1692
        """'reconcile' helper routine that allows access to a revision always.
837
1693
 
840
1696
        be used by reconcile, or reconcile-alike commands that are correcting
841
1697
        or testing the revision graph.
842
1698
        """
843
 
        raise NotImplementedError(self.get_revision_reconcile)
 
1699
        return self._get_revisions([revision_id])[0]
844
1700
 
 
1701
    @needs_read_lock
845
1702
    def get_revisions(self, revision_ids):
846
 
        """Get many revisions at once.
847
 
        
848
 
        Repositories that need to check data on every revision read should 
849
 
        subclass this method.
850
 
        """
851
 
        raise NotImplementedError(self.get_revisions)
 
1703
        """Get many revisions at once."""
 
1704
        return self._get_revisions(revision_ids)
 
1705
 
 
1706
    @needs_read_lock
 
1707
    def _get_revisions(self, revision_ids):
 
1708
        """Core work logic to get many revisions without sanity checks."""
 
1709
        for rev_id in revision_ids:
 
1710
            if not rev_id or not isinstance(rev_id, basestring):
 
1711
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1712
        keys = [(key,) for key in revision_ids]
 
1713
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1714
        revs = {}
 
1715
        for record in stream:
 
1716
            if record.storage_kind == 'absent':
 
1717
                raise errors.NoSuchRevision(self, record.key[0])
 
1718
            text = record.get_bytes_as('fulltext')
 
1719
            rev = self._serializer.read_revision_from_string(text)
 
1720
            revs[record.key[0]] = rev
 
1721
        return [revs[revid] for revid in revision_ids]
 
1722
 
 
1723
    @needs_read_lock
 
1724
    def get_revision_xml(self, revision_id):
 
1725
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1726
        #       would have already do it.
 
1727
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1728
        # TODO: this can't just be replaced by:
 
1729
        # return self._serializer.write_revision_to_string(
 
1730
        #     self.get_revision(revision_id))
 
1731
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1732
        # or some other call down the path.
 
1733
        rev = self.get_revision(revision_id)
 
1734
        rev_tmp = cStringIO.StringIO()
 
1735
        # the current serializer..
 
1736
        self._serializer.write_revision(rev, rev_tmp)
 
1737
        rev_tmp.seek(0)
 
1738
        return rev_tmp.getvalue()
852
1739
 
853
1740
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
854
1741
        """Produce a generator of revision deltas.
909
1796
        signature = gpg_strategy.sign(plaintext)
910
1797
        self.add_signature_text(revision_id, signature)
911
1798
 
 
1799
    @needs_write_lock
912
1800
    def add_signature_text(self, revision_id, signature):
913
 
        """Store a signature text for a revision.
914
 
 
915
 
        :param revision_id: Revision id of the revision
916
 
        :param signature: Signature text.
917
 
        """
918
 
        raise NotImplementedError(self.add_signature_text)
919
 
 
920
 
    def _find_parent_ids_of_revisions(self, revision_ids):
921
 
        """Find all parent ids that are mentioned in the revision graph.
922
 
 
923
 
        :return: set of revisions that are parents of revision_ids which are
924
 
            not part of revision_ids themselves
925
 
        """
926
 
        parent_map = self.get_parent_map(revision_ids)
927
 
        parent_ids = set()
928
 
        map(parent_ids.update, parent_map.itervalues())
929
 
        parent_ids.difference_update(revision_ids)
930
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
931
 
        return parent_ids
932
 
 
933
 
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1801
        self.signatures.add_lines((revision_id,), (),
 
1802
            osutils.split_lines(signature))
 
1803
 
 
1804
    def find_text_key_references(self):
 
1805
        """Find the text key references within the repository.
 
1806
 
 
1807
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1808
            to whether they were referred to by the inventory of the
 
1809
            revision_id that they contain. The inventory texts from all present
 
1810
            revision ids are assessed to generate this report.
 
1811
        """
 
1812
        revision_keys = self.revisions.keys()
 
1813
        w = self.inventories
 
1814
        pb = ui.ui_factory.nested_progress_bar()
 
1815
        try:
 
1816
            return self._find_text_key_references_from_xml_inventory_lines(
 
1817
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1818
        finally:
 
1819
            pb.finished()
 
1820
 
 
1821
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1822
        line_iterator):
 
1823
        """Core routine for extracting references to texts from inventories.
 
1824
 
 
1825
        This performs the translation of xml lines to revision ids.
 
1826
 
 
1827
        :param line_iterator: An iterator of lines, origin_version_id
 
1828
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1829
            to whether they were referred to by the inventory of the
 
1830
            revision_id that they contain. Note that if that revision_id was
 
1831
            not part of the line_iterator's output then False will be given -
 
1832
            even though it may actually refer to that key.
 
1833
        """
 
1834
        if not self._serializer.support_altered_by_hack:
 
1835
            raise AssertionError(
 
1836
                "_find_text_key_references_from_xml_inventory_lines only "
 
1837
                "supported for branches which store inventory as unnested xml"
 
1838
                ", not on %r" % self)
 
1839
        result = {}
 
1840
 
 
1841
        # this code needs to read every new line in every inventory for the
 
1842
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
1843
        # not present in one of those inventories is unnecessary but not
 
1844
        # harmful because we are filtering by the revision id marker in the
 
1845
        # inventory lines : we only select file ids altered in one of those
 
1846
        # revisions. We don't need to see all lines in the inventory because
 
1847
        # only those added in an inventory in rev X can contain a revision=X
 
1848
        # line.
 
1849
        unescape_revid_cache = {}
 
1850
        unescape_fileid_cache = {}
 
1851
 
 
1852
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1853
        # of lines, so it has had a lot of inlining and optimizing done.
 
1854
        # Sorry that it is a little bit messy.
 
1855
        # Move several functions to be local variables, since this is a long
 
1856
        # running loop.
 
1857
        search = self._file_ids_altered_regex.search
 
1858
        unescape = _unescape_xml
 
1859
        setdefault = result.setdefault
 
1860
        for line, line_key in line_iterator:
 
1861
            match = search(line)
 
1862
            if match is None:
 
1863
                continue
 
1864
            # One call to match.group() returning multiple items is quite a
 
1865
            # bit faster than 2 calls to match.group() each returning 1
 
1866
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1867
 
 
1868
            # Inlining the cache lookups helps a lot when you make 170,000
 
1869
            # lines and 350k ids, versus 8.4 unique ids.
 
1870
            # Using a cache helps in 2 ways:
 
1871
            #   1) Avoids unnecessary decoding calls
 
1872
            #   2) Re-uses cached strings, which helps in future set and
 
1873
            #      equality checks.
 
1874
            # (2) is enough that removing encoding entirely along with
 
1875
            # the cache (so we are using plain strings) results in no
 
1876
            # performance improvement.
 
1877
            try:
 
1878
                revision_id = unescape_revid_cache[revision_id]
 
1879
            except KeyError:
 
1880
                unescaped = unescape(revision_id)
 
1881
                unescape_revid_cache[revision_id] = unescaped
 
1882
                revision_id = unescaped
 
1883
 
 
1884
            # Note that unconditionally unescaping means that we deserialise
 
1885
            # every fileid, which for general 'pull' is not great, but we don't
 
1886
            # really want to have some many fulltexts that this matters anyway.
 
1887
            # RBC 20071114.
 
1888
            try:
 
1889
                file_id = unescape_fileid_cache[file_id]
 
1890
            except KeyError:
 
1891
                unescaped = unescape(file_id)
 
1892
                unescape_fileid_cache[file_id] = unescaped
 
1893
                file_id = unescaped
 
1894
 
 
1895
            key = (file_id, revision_id)
 
1896
            setdefault(key, False)
 
1897
            if revision_id == line_key[-1]:
 
1898
                result[key] = True
 
1899
        return result
 
1900
 
 
1901
    def _inventory_xml_lines_for_keys(self, keys):
 
1902
        """Get a line iterator of the sort needed for findind references.
 
1903
 
 
1904
        Not relevant for non-xml inventory repositories.
 
1905
 
 
1906
        Ghosts in revision_keys are ignored.
 
1907
 
 
1908
        :param revision_keys: The revision keys for the inventories to inspect.
 
1909
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
1910
            all of the xml inventories specified by revision_keys.
 
1911
        """
 
1912
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1913
        for record in stream:
 
1914
            if record.storage_kind != 'absent':
 
1915
                chunks = record.get_bytes_as('chunked')
 
1916
                revid = record.key[-1]
 
1917
                lines = osutils.chunks_to_lines(chunks)
 
1918
                for line in lines:
 
1919
                    yield line, revid
 
1920
 
 
1921
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1922
        revision_ids):
 
1923
        """Helper routine for fileids_altered_by_revision_ids.
 
1924
 
 
1925
        This performs the translation of xml lines to revision ids.
 
1926
 
 
1927
        :param line_iterator: An iterator of lines, origin_version_id
 
1928
        :param revision_ids: The revision ids to filter for. This should be a
 
1929
            set or other type which supports efficient __contains__ lookups, as
 
1930
            the revision id from each parsed line will be looked up in the
 
1931
            revision_ids filter.
 
1932
        :return: a dictionary mapping altered file-ids to an iterable of
 
1933
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1934
        altered it listed explicitly.
 
1935
        """
 
1936
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
1937
                line_iterator).iterkeys())
 
1938
        # Note that revision_ids are revision keys.
 
1939
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1940
        parents = set()
 
1941
        map(parents.update, parent_maps.itervalues())
 
1942
        parents.difference_update(revision_ids)
 
1943
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
1944
            self._inventory_xml_lines_for_keys(parents)))
 
1945
        new_keys = seen - parent_seen
 
1946
        result = {}
 
1947
        setdefault = result.setdefault
 
1948
        for key in new_keys:
 
1949
            setdefault(key[0], set()).add(key[-1])
 
1950
        return result
 
1951
 
 
1952
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
934
1953
        """Find the file ids and versions affected by revisions.
935
1954
 
936
1955
        :param revisions: an iterable containing revision ids.
 
1956
        :param _inv_weave: The inventory weave from this repository or None.
 
1957
            If None, the inventory weave will be opened automatically.
937
1958
        :return: a dictionary mapping altered file-ids to an iterable of
938
 
            revision_ids. Each altered file-ids has the exact revision_ids
939
 
            that altered it listed explicitly.
 
1959
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1960
        altered it listed explicitly.
940
1961
        """
941
 
        raise NotImplementedError(self.fileids_altered_by_revision_ids)
 
1962
        selected_keys = set((revid,) for revid in revision_ids)
 
1963
        w = _inv_weave or self.inventories
 
1964
        pb = ui.ui_factory.nested_progress_bar()
 
1965
        try:
 
1966
            return self._find_file_ids_from_xml_inventory_lines(
 
1967
                w.iter_lines_added_or_present_in_keys(
 
1968
                    selected_keys, pb=pb),
 
1969
                selected_keys)
 
1970
        finally:
 
1971
            pb.finished()
942
1972
 
943
1973
    def iter_files_bytes(self, desired_files):
944
1974
        """Iterate through file versions.
951
1981
        uniquely identify the file version in the caller's context.  (Examples:
952
1982
        an index number or a TreeTransform trans_id.)
953
1983
 
 
1984
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1985
        kind of iterable and length of the bytestrings are unspecified, but for
 
1986
        this implementation, it is a list of bytes produced by
 
1987
        VersionedFile.get_record_stream().
 
1988
 
954
1989
        :param desired_files: a list of (file_id, revision_id, identifier)
955
1990
            triples
956
1991
        """
957
 
        raise NotImplementedError(self.iter_files_bytes)
958
 
 
959
 
    def get_rev_id_for_revno(self, revno, known_pair):
960
 
        """Return the revision id of a revno, given a later (revno, revid)
961
 
        pair in the same history.
962
 
 
963
 
        :return: if found (True, revid).  If the available history ran out
964
 
            before reaching the revno, then this returns
965
 
            (False, (closest_revno, closest_revid)).
966
 
        """
967
 
        known_revno, known_revid = known_pair
968
 
        partial_history = [known_revid]
969
 
        distance_from_known = known_revno - revno
970
 
        if distance_from_known < 0:
971
 
            raise ValueError(
972
 
                'requested revno (%d) is later than given known revno (%d)'
973
 
                % (revno, known_revno))
974
 
        try:
975
 
            _iter_for_revno(
976
 
                self, partial_history, stop_index=distance_from_known)
977
 
        except errors.RevisionNotPresent, err:
978
 
            if err.revision_id == known_revid:
979
 
                # The start revision (known_revid) wasn't found.
980
 
                raise
981
 
            # This is a stacked repository with no fallbacks, or a there's a
982
 
            # left-hand ghost.  Either way, even though the revision named in
983
 
            # the error isn't in this repo, we know it's the next step in this
984
 
            # left-hand history.
985
 
            partial_history.append(err.revision_id)
986
 
        if len(partial_history) <= distance_from_known:
987
 
            # Didn't find enough history to get a revid for the revno.
988
 
            earliest_revno = known_revno - len(partial_history) + 1
989
 
            return (False, (earliest_revno, partial_history[-1]))
990
 
        if len(partial_history) - 1 > distance_from_known:
991
 
            raise AssertionError('_iter_for_revno returned too much history')
992
 
        return (True, partial_history[-1])
993
 
 
994
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
 
1992
        text_keys = {}
 
1993
        for file_id, revision_id, callable_data in desired_files:
 
1994
            text_keys[(file_id, revision_id)] = callable_data
 
1995
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
1996
            if record.storage_kind == 'absent':
 
1997
                raise errors.RevisionNotPresent(record.key, self)
 
1998
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1999
 
 
2000
    def _generate_text_key_index(self, text_key_references=None,
 
2001
        ancestors=None):
 
2002
        """Generate a new text key index for the repository.
 
2003
 
 
2004
        This is an expensive function that will take considerable time to run.
 
2005
 
 
2006
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
2007
            list of parents, also text keys. When a given key has no parents,
 
2008
            the parents list will be [NULL_REVISION].
 
2009
        """
 
2010
        # All revisions, to find inventory parents.
 
2011
        if ancestors is None:
 
2012
            graph = self.get_graph()
 
2013
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
2014
        if text_key_references is None:
 
2015
            text_key_references = self.find_text_key_references()
 
2016
        pb = ui.ui_factory.nested_progress_bar()
 
2017
        try:
 
2018
            return self._do_generate_text_key_index(ancestors,
 
2019
                text_key_references, pb)
 
2020
        finally:
 
2021
            pb.finished()
 
2022
 
 
2023
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
2024
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
2025
        revision_order = tsort.topo_sort(ancestors)
 
2026
        invalid_keys = set()
 
2027
        revision_keys = {}
 
2028
        for revision_id in revision_order:
 
2029
            revision_keys[revision_id] = set()
 
2030
        text_count = len(text_key_references)
 
2031
        # a cache of the text keys to allow reuse; costs a dict of all the
 
2032
        # keys, but saves a 2-tuple for every child of a given key.
 
2033
        text_key_cache = {}
 
2034
        for text_key, valid in text_key_references.iteritems():
 
2035
            if not valid:
 
2036
                invalid_keys.add(text_key)
 
2037
            else:
 
2038
                revision_keys[text_key[1]].add(text_key)
 
2039
            text_key_cache[text_key] = text_key
 
2040
        del text_key_references
 
2041
        text_index = {}
 
2042
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
2043
        NULL_REVISION = _mod_revision.NULL_REVISION
 
2044
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
2045
        # too small for large or very branchy trees. However, for 55K path
 
2046
        # trees, it would be easy to use too much memory trivially. Ideally we
 
2047
        # could gauge this by looking at available real memory etc, but this is
 
2048
        # always a tricky proposition.
 
2049
        inventory_cache = lru_cache.LRUCache(10)
 
2050
        batch_size = 10 # should be ~150MB on a 55K path tree
 
2051
        batch_count = len(revision_order) / batch_size + 1
 
2052
        processed_texts = 0
 
2053
        pb.update("Calculating text parents", processed_texts, text_count)
 
2054
        for offset in xrange(batch_count):
 
2055
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
2056
                batch_size]
 
2057
            if not to_query:
 
2058
                break
 
2059
            for rev_tree in self.revision_trees(to_query):
 
2060
                revision_id = rev_tree.get_revision_id()
 
2061
                parent_ids = ancestors[revision_id]
 
2062
                for text_key in revision_keys[revision_id]:
 
2063
                    pb.update("Calculating text parents", processed_texts)
 
2064
                    processed_texts += 1
 
2065
                    candidate_parents = []
 
2066
                    for parent_id in parent_ids:
 
2067
                        parent_text_key = (text_key[0], parent_id)
 
2068
                        try:
 
2069
                            check_parent = parent_text_key not in \
 
2070
                                revision_keys[parent_id]
 
2071
                        except KeyError:
 
2072
                            # the parent parent_id is a ghost:
 
2073
                            check_parent = False
 
2074
                            # truncate the derived graph against this ghost.
 
2075
                            parent_text_key = None
 
2076
                        if check_parent:
 
2077
                            # look at the parent commit details inventories to
 
2078
                            # determine possible candidates in the per file graph.
 
2079
                            # TODO: cache here.
 
2080
                            try:
 
2081
                                inv = inventory_cache[parent_id]
 
2082
                            except KeyError:
 
2083
                                inv = self.revision_tree(parent_id).inventory
 
2084
                                inventory_cache[parent_id] = inv
 
2085
                            try:
 
2086
                                parent_entry = inv[text_key[0]]
 
2087
                            except (KeyError, errors.NoSuchId):
 
2088
                                parent_entry = None
 
2089
                            if parent_entry is not None:
 
2090
                                parent_text_key = (
 
2091
                                    text_key[0], parent_entry.revision)
 
2092
                            else:
 
2093
                                parent_text_key = None
 
2094
                        if parent_text_key is not None:
 
2095
                            candidate_parents.append(
 
2096
                                text_key_cache[parent_text_key])
 
2097
                    parent_heads = text_graph.heads(candidate_parents)
 
2098
                    new_parents = list(parent_heads)
 
2099
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
2100
                    if new_parents == []:
 
2101
                        new_parents = [NULL_REVISION]
 
2102
                    text_index[text_key] = new_parents
 
2103
 
 
2104
        for text_key in invalid_keys:
 
2105
            text_index[text_key] = [NULL_REVISION]
 
2106
        return text_index
 
2107
 
 
2108
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
2109
        """Get an iterable listing the keys of all the data introduced by a set
 
2110
        of revision IDs.
 
2111
 
 
2112
        The keys will be ordered so that the corresponding items can be safely
 
2113
        fetched and inserted in that order.
 
2114
 
 
2115
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
2116
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
2117
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
2118
        """
 
2119
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2120
            yield result
 
2121
        del _files_pb
 
2122
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2123
            yield result
 
2124
 
 
2125
    def _find_file_keys_to_fetch(self, revision_ids, pb):
 
2126
        # XXX: it's a bit weird to control the inventory weave caching in this
 
2127
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
2128
        # maybe this generator should explicitly have the contract that it
 
2129
        # should not be iterated until the previously yielded item has been
 
2130
        # processed?
 
2131
        inv_w = self.inventories
 
2132
 
 
2133
        # file ids that changed
 
2134
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
2135
        count = 0
 
2136
        num_file_ids = len(file_ids)
 
2137
        for file_id, altered_versions in file_ids.iteritems():
 
2138
            if pb is not None:
 
2139
                pb.update("fetch texts", count, num_file_ids)
 
2140
            count += 1
 
2141
            yield ("file", file_id, altered_versions)
 
2142
 
 
2143
    def _find_non_file_keys_to_fetch(self, revision_ids):
 
2144
        # inventory
 
2145
        yield ("inventory", None, revision_ids)
 
2146
 
 
2147
        # signatures
 
2148
        # XXX: Note ATM no callers actually pay attention to this return
 
2149
        #      instead they just use the list of revision ids and ignore
 
2150
        #      missing sigs. Consider removing this work entirely
 
2151
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2152
            [(r,) for r in revision_ids]))
 
2153
        revisions_with_signatures = set(
 
2154
            [r for (r,) in revisions_with_signatures])
 
2155
        revisions_with_signatures.intersection_update(revision_ids)
 
2156
        yield ("signatures", None, revisions_with_signatures)
 
2157
 
 
2158
        # revisions
 
2159
        yield ("revisions", None, revision_ids)
 
2160
 
 
2161
    @needs_read_lock
 
2162
    def get_inventory(self, revision_id):
 
2163
        """Get Inventory object by revision id."""
 
2164
        return self.iter_inventories([revision_id]).next()
 
2165
 
 
2166
    def iter_inventories(self, revision_ids):
 
2167
        """Get many inventories by revision_ids.
 
2168
 
 
2169
        This will buffer some or all of the texts used in constructing the
 
2170
        inventories in memory, but will only parse a single inventory at a
 
2171
        time.
 
2172
 
 
2173
        :param revision_ids: The expected revision ids of the inventories.
 
2174
        :return: An iterator of inventories.
 
2175
        """
 
2176
        if ((None in revision_ids)
 
2177
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
2178
            raise ValueError('cannot get null revision inventory')
 
2179
        return self._iter_inventories(revision_ids)
 
2180
 
 
2181
    def _iter_inventories(self, revision_ids):
 
2182
        """single-document based inventory iteration."""
 
2183
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2184
            yield self.deserialise_inventory(revision_id, text)
 
2185
 
 
2186
    def _iter_inventory_xmls(self, revision_ids):
 
2187
        keys = [(revision_id,) for revision_id in revision_ids]
 
2188
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2189
        text_chunks = {}
 
2190
        for record in stream:
 
2191
            if record.storage_kind != 'absent':
 
2192
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
2193
            else:
 
2194
                raise errors.NoSuchRevision(self, record.key)
 
2195
        for key in keys:
 
2196
            chunks = text_chunks.pop(key)
 
2197
            yield ''.join(chunks), key[-1]
 
2198
 
 
2199
    def deserialise_inventory(self, revision_id, xml):
 
2200
        """Transform the xml into an inventory object.
 
2201
 
 
2202
        :param revision_id: The expected revision id of the inventory.
 
2203
        :param xml: A serialised inventory.
 
2204
        """
 
2205
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2206
                    entry_cache=self._inventory_entry_cache)
 
2207
        if result.revision_id != revision_id:
 
2208
            raise AssertionError('revision id mismatch %s != %s' % (
 
2209
                result.revision_id, revision_id))
 
2210
        return result
 
2211
 
 
2212
    def serialise_inventory(self, inv):
 
2213
        return self._serializer.write_inventory_to_string(inv)
 
2214
 
 
2215
    def _serialise_inventory_to_lines(self, inv):
 
2216
        return self._serializer.write_inventory_to_lines(inv)
 
2217
 
 
2218
    def get_serializer_format(self):
 
2219
        return self._serializer.format_num
 
2220
 
 
2221
    @needs_read_lock
 
2222
    def get_inventory_xml(self, revision_id):
 
2223
        """Get inventory XML as a file object."""
 
2224
        texts = self._iter_inventory_xmls([revision_id])
 
2225
        try:
 
2226
            text, revision_id = texts.next()
 
2227
        except StopIteration:
 
2228
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
2229
        return text
 
2230
 
 
2231
    @needs_read_lock
 
2232
    def get_inventory_sha1(self, revision_id):
 
2233
        """Return the sha1 hash of the inventory entry
 
2234
        """
 
2235
        return self.get_revision(revision_id).inventory_sha1
 
2236
 
995
2237
    def iter_reverse_revision_history(self, revision_id):
996
2238
        """Iterate backwards through revision ids in the lefthand history
997
2239
 
999
2241
            ancestors will be traversed.
1000
2242
        """
1001
2243
        graph = self.get_graph()
1002
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
1003
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
 
2244
        next_id = revision_id
 
2245
        while True:
 
2246
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2247
                return
 
2248
            yield next_id
 
2249
            # Note: The following line may raise KeyError in the event of
 
2250
            # truncated history. We decided not to have a try:except:raise
 
2251
            # RevisionNotPresent here until we see a use for it, because of the
 
2252
            # cost in an inner loop that is by its very nature O(history).
 
2253
            # Robert Collins 20080326
 
2254
            parents = graph.get_parent_map([next_id])[next_id]
 
2255
            if len(parents) == 0:
 
2256
                return
 
2257
            else:
 
2258
                next_id = parents[0]
 
2259
 
 
2260
    @needs_read_lock
 
2261
    def get_revision_inventory(self, revision_id):
 
2262
        """Return inventory of a past revision."""
 
2263
        # TODO: Unify this with get_inventory()
 
2264
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2265
        # must be the same as its revision, so this is trivial.
 
2266
        if revision_id is None:
 
2267
            # This does not make sense: if there is no revision,
 
2268
            # then it is the current tree inventory surely ?!
 
2269
            # and thus get_root_id() is something that looks at the last
 
2270
            # commit on the branch, and the get_root_id is an inventory check.
 
2271
            raise NotImplementedError
 
2272
            # return Inventory(self.get_root_id())
 
2273
        else:
 
2274
            return self.get_inventory(revision_id)
1004
2275
 
1005
2276
    def is_shared(self):
1006
2277
        """Return True if this repository is flagged as a shared repository."""
1034
2305
 
1035
2306
        `revision_id` may be NULL_REVISION for the empty tree revision.
1036
2307
        """
1037
 
        raise NotImplementedError(self.revision_tree)
 
2308
        revision_id = _mod_revision.ensure_null(revision_id)
 
2309
        # TODO: refactor this to use an existing revision object
 
2310
        # so we don't need to read it in twice.
 
2311
        if revision_id == _mod_revision.NULL_REVISION:
 
2312
            return RevisionTree(self, Inventory(root_id=None),
 
2313
                                _mod_revision.NULL_REVISION)
 
2314
        else:
 
2315
            inv = self.get_revision_inventory(revision_id)
 
2316
            return RevisionTree(self, inv, revision_id)
1038
2317
 
1039
2318
    def revision_trees(self, revision_ids):
1040
2319
        """Return Trees for revisions in this repository.
1042
2321
        :param revision_ids: a sequence of revision-ids;
1043
2322
          a revision-id may not be None or 'null:'
1044
2323
        """
1045
 
        raise NotImplementedError(self.revision_trees)
 
2324
        inventories = self.iter_inventories(revision_ids)
 
2325
        for inv in inventories:
 
2326
            yield RevisionTree(self, inv, inv.revision_id)
 
2327
 
 
2328
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2329
        """Return Tree for a revision on this branch with only some files.
 
2330
 
 
2331
        :param revision_ids: a sequence of revision-ids;
 
2332
          a revision-id may not be None or 'null:'
 
2333
        :param file_ids: if not None, the result is filtered
 
2334
          so that only those file-ids, their parents and their
 
2335
          children are included.
 
2336
        """
 
2337
        inventories = self.iter_inventories(revision_ids)
 
2338
        for inv in inventories:
 
2339
            # Should we introduce a FilteredRevisionTree class rather
 
2340
            # than pre-filter the inventory here?
 
2341
            filtered_inv = inv.filter(file_ids)
 
2342
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
1046
2343
 
1047
2344
    @needs_read_lock
1048
 
    @symbol_versioning.deprecated_method(
1049
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1050
2345
    def get_ancestry(self, revision_id, topo_sorted=True):
1051
2346
        """Return a list of revision-ids integrated by a revision.
1052
2347
 
1056
2351
 
1057
2352
        This is topologically sorted.
1058
2353
        """
1059
 
        if 'evil' in debug.debug_flags:
1060
 
            mutter_callsite(2, "get_ancestry is linear with history.")
1061
2354
        if _mod_revision.is_null(revision_id):
1062
2355
            return [None]
1063
2356
        if not self.has_revision(revision_id):
1078
2371
            keys = tsort.topo_sort(parent_map)
1079
2372
        return [None] + list(keys)
1080
2373
 
1081
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2374
    def pack(self):
1082
2375
        """Compress the data within the repository.
1083
2376
 
1084
2377
        This operation only makes sense for some repository types. For other
1085
2378
        types it should be a no-op that just returns.
1086
2379
 
1087
2380
        This stub method does not require a lock, but subclasses should use
1088
 
        @needs_write_lock as this is a long running call it's reasonable to
 
2381
        @needs_write_lock as this is a long running call its reasonable to
1089
2382
        implicitly lock for the user.
1090
 
 
1091
 
        :param hint: If not supplied, the whole repository is packed.
1092
 
            If supplied, the repository may use the hint parameter as a
1093
 
            hint for the parts of the repository to pack. A hint can be
1094
 
            obtained from the result of commit_write_group(). Out of
1095
 
            date hints are simply ignored, because concurrent operations
1096
 
            can obsolete them rapidly.
1097
 
 
1098
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
1099
 
            the pack operation.
1100
2383
        """
1101
2384
 
1102
2385
    def get_transaction(self):
1103
2386
        return self.control_files.get_transaction()
1104
2387
 
1105
2388
    def get_parent_map(self, revision_ids):
1106
 
        """See graph.StackedParentsProvider.get_parent_map"""
1107
 
        raise NotImplementedError(self.get_parent_map)
1108
 
 
1109
 
    def _get_parent_map_no_fallbacks(self, revision_ids):
1110
 
        """Same as Repository.get_parent_map except doesn't query fallbacks."""
 
2389
        """See graph._StackedParentsProvider.get_parent_map"""
1111
2390
        # revisions index works in keys; this just works in revisions
1112
2391
        # therefore wrap and unwrap
1113
2392
        query_keys = []
1119
2398
                raise ValueError('get_parent_map(None) is not valid')
1120
2399
            else:
1121
2400
                query_keys.append((revision_id ,))
1122
 
        vf = self.revisions.without_fallbacks()
1123
2401
        for ((revision_id,), parent_keys) in \
1124
 
                vf.get_parent_map(query_keys).iteritems():
 
2402
                self.revisions.get_parent_map(query_keys).iteritems():
1125
2403
            if parent_keys:
1126
 
                result[revision_id] = tuple([parent_revid
1127
 
                    for (parent_revid,) in parent_keys])
 
2404
                result[revision_id] = tuple(parent_revid
 
2405
                    for (parent_revid,) in parent_keys)
1128
2406
            else:
1129
2407
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1130
2408
        return result
1131
2409
 
1132
2410
    def _make_parents_provider(self):
1133
 
        if not self._format.supports_external_lookups:
1134
 
            return self
1135
 
        return graph.StackedParentsProvider(_LazyListJoin(
1136
 
            [self._make_parents_provider_unstacked()],
1137
 
            self._fallback_repositories))
1138
 
 
1139
 
    def _make_parents_provider_unstacked(self):
1140
 
        return graph.CallableToParentsProviderAdapter(
1141
 
            self._get_parent_map_no_fallbacks)
1142
 
 
1143
 
    @needs_read_lock
1144
 
    def get_known_graph_ancestry(self, revision_ids):
1145
 
        """Return the known graph for a set of revision ids and their ancestors.
1146
 
        """
1147
 
        raise NotImplementedError(self.get_known_graph_ancestry)
1148
 
 
1149
 
    def get_file_graph(self):
1150
 
        """Return the graph walker for files."""
1151
 
        raise NotImplementedError(self.get_file_graph)
 
2411
        return self
1152
2412
 
1153
2413
    def get_graph(self, other_repository=None):
1154
2414
        """Return the graph walker for this repository format"""
1155
2415
        parents_provider = self._make_parents_provider()
1156
2416
        if (other_repository is not None and
1157
2417
            not self.has_same_location(other_repository)):
1158
 
            parents_provider = graph.StackedParentsProvider(
 
2418
            parents_provider = graph._StackedParentsProvider(
1159
2419
                [parents_provider, other_repository._make_parents_provider()])
1160
2420
        return graph.Graph(parents_provider)
1161
2421
 
 
2422
    def _get_versioned_file_checker(self, text_key_references=None):
 
2423
        """Return an object suitable for checking versioned files.
 
2424
        
 
2425
        :param text_key_references: if non-None, an already built
 
2426
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2427
            to whether they were referred to by the inventory of the
 
2428
            revision_id that they contain. If None, this will be
 
2429
            calculated.
 
2430
        """
 
2431
        return _VersionedFileChecker(self,
 
2432
            text_key_references=text_key_references)
 
2433
 
1162
2434
    def revision_ids_to_search_result(self, result_set):
1163
2435
        """Convert a set of revision ids to a graph SearchResult."""
1164
2436
        result_parents = set()
1190
2462
 
1191
2463
    @needs_write_lock
1192
2464
    def sign_revision(self, revision_id, gpg_strategy):
1193
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1194
 
        plaintext = testament.as_short_text()
 
2465
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1195
2466
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1196
2467
 
1197
2468
    @needs_read_lock
1198
 
    def verify_revision(self, revision_id, gpg_strategy):
1199
 
        """Verify the signature on a revision.
1200
 
        
1201
 
        :param revision_id: the revision to verify
1202
 
        :gpg_strategy: the GPGStrategy object to used
1203
 
        
1204
 
        :return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1205
 
        """
1206
 
        if not self.has_signature_for_revision_id(revision_id):
1207
 
            return gpg.SIGNATURE_NOT_SIGNED, None
1208
 
        signature = self.get_signature_text(revision_id)
1209
 
 
1210
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1211
 
        plaintext = testament.as_short_text()
1212
 
 
1213
 
        return gpg_strategy.verify(signature, plaintext)
1214
 
 
1215
2469
    def has_signature_for_revision_id(self, revision_id):
1216
2470
        """Query for a revision signature for revision_id in the repository."""
1217
 
        raise NotImplementedError(self.has_signature_for_revision_id)
 
2471
        if not self.has_revision(revision_id):
 
2472
            raise errors.NoSuchRevision(self, revision_id)
 
2473
        sig_present = (1 == len(
 
2474
            self.signatures.get_parent_map([(revision_id,)])))
 
2475
        return sig_present
1218
2476
 
 
2477
    @needs_read_lock
1219
2478
    def get_signature_text(self, revision_id):
1220
2479
        """Return the text for a signature."""
1221
 
        raise NotImplementedError(self.get_signature_text)
 
2480
        stream = self.signatures.get_record_stream([(revision_id,)],
 
2481
            'unordered', True)
 
2482
        record = stream.next()
 
2483
        if record.storage_kind == 'absent':
 
2484
            raise errors.NoSuchRevision(self, revision_id)
 
2485
        return record.get_bytes_as('fulltext')
1222
2486
 
1223
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2487
    @needs_read_lock
 
2488
    def check(self, revision_ids=None):
1224
2489
        """Check consistency of all history of given revision_ids.
1225
2490
 
1226
2491
        Different repository implementations should override _check().
1227
2492
 
1228
2493
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1229
2494
             will be checked.  Typically the last revision_id of a branch.
1230
 
        :param callback_refs: A dict of check-refs to resolve and callback
1231
 
            the check/_check method on the items listed as wanting the ref.
1232
 
            see bzrlib.check.
1233
 
        :param check_repo: If False do not check the repository contents, just 
1234
 
            calculate the data callback_refs requires and call them back.
1235
2495
        """
1236
 
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1237
 
            check_repo=check_repo)
1238
 
 
1239
 
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1240
 
        raise NotImplementedError(self.check)
1241
 
 
1242
 
    def _warn_if_deprecated(self, branch=None):
1243
 
        if not self._format.is_deprecated():
1244
 
            return
 
2496
        return self._check(revision_ids)
 
2497
 
 
2498
    def _check(self, revision_ids):
 
2499
        result = check.Check(self)
 
2500
        result.check()
 
2501
        return result
 
2502
 
 
2503
    def _warn_if_deprecated(self):
1245
2504
        global _deprecation_warning_done
1246
2505
        if _deprecation_warning_done:
1247
2506
            return
1248
 
        try:
1249
 
            if branch is None:
1250
 
                conf = config.GlobalConfig()
1251
 
            else:
1252
 
                conf = branch.get_config()
1253
 
            if conf.suppress_warning('format_deprecation'):
1254
 
                return
1255
 
            warning("Format %s for %s is deprecated -"
1256
 
                    " please use 'bzr upgrade' to get better performance"
1257
 
                    % (self._format, self.bzrdir.transport.base))
1258
 
        finally:
1259
 
            _deprecation_warning_done = True
 
2507
        _deprecation_warning_done = True
 
2508
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2509
                % (self._format, self.bzrdir.transport.base))
1260
2510
 
1261
2511
    def supports_rich_root(self):
1262
2512
        return self._format.rich_root_data
1277
2527
                except UnicodeDecodeError:
1278
2528
                    raise errors.NonAsciiRevisionId(method, self)
1279
2529
 
 
2530
    def revision_graph_can_have_wrong_parents(self):
 
2531
        """Is it possible for this repository to have a revision graph with
 
2532
        incorrect parents?
 
2533
 
 
2534
        If True, then this repository must also implement
 
2535
        _find_inconsistent_revision_parents so that check and reconcile can
 
2536
        check for inconsistencies before proceeding with other checks that may
 
2537
        depend on the revision index being consistent.
 
2538
        """
 
2539
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
2540
 
 
2541
 
 
2542
# remove these delegates a while after bzr 0.15
 
2543
def __make_delegated(name, from_module):
 
2544
    def _deprecated_repository_forwarder():
 
2545
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
2546
            % (name, from_module),
 
2547
            DeprecationWarning,
 
2548
            stacklevel=2)
 
2549
        m = __import__(from_module, globals(), locals(), [name])
 
2550
        try:
 
2551
            return getattr(m, name)
 
2552
        except AttributeError:
 
2553
            raise AttributeError('module %s has no name %s'
 
2554
                    % (m, name))
 
2555
    globals()[name] = _deprecated_repository_forwarder
 
2556
 
 
2557
for _name in [
 
2558
        'AllInOneRepository',
 
2559
        'WeaveMetaDirRepository',
 
2560
        'PreSplitOutRepositoryFormat',
 
2561
        'RepositoryFormat4',
 
2562
        'RepositoryFormat5',
 
2563
        'RepositoryFormat6',
 
2564
        'RepositoryFormat7',
 
2565
        ]:
 
2566
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
2567
 
 
2568
for _name in [
 
2569
        'KnitRepository',
 
2570
        'RepositoryFormatKnit',
 
2571
        'RepositoryFormatKnit1',
 
2572
        ]:
 
2573
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
2574
 
 
2575
 
 
2576
def install_revision(repository, rev, revision_tree):
 
2577
    """Install all revision data into a repository."""
 
2578
    install_revisions(repository, [(rev, revision_tree, None)])
 
2579
 
 
2580
 
 
2581
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2582
    """Install all revision data into a repository.
 
2583
 
 
2584
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2585
    may be None.
 
2586
    """
 
2587
    repository.start_write_group()
 
2588
    try:
 
2589
        inventory_cache = lru_cache.LRUCache(10)
 
2590
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2591
            _install_revision(repository, revision, revision_tree, signature,
 
2592
                inventory_cache)
 
2593
            if pb is not None:
 
2594
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2595
    except:
 
2596
        repository.abort_write_group()
 
2597
        raise
 
2598
    else:
 
2599
        repository.commit_write_group()
 
2600
 
 
2601
 
 
2602
def _install_revision(repository, rev, revision_tree, signature,
 
2603
    inventory_cache):
 
2604
    """Install all revision data into a repository."""
 
2605
    present_parents = []
 
2606
    parent_trees = {}
 
2607
    for p_id in rev.parent_ids:
 
2608
        if repository.has_revision(p_id):
 
2609
            present_parents.append(p_id)
 
2610
            parent_trees[p_id] = repository.revision_tree(p_id)
 
2611
        else:
 
2612
            parent_trees[p_id] = repository.revision_tree(
 
2613
                                     _mod_revision.NULL_REVISION)
 
2614
 
 
2615
    inv = revision_tree.inventory
 
2616
    entries = inv.iter_entries()
 
2617
    # backwards compatibility hack: skip the root id.
 
2618
    if not repository.supports_rich_root():
 
2619
        path, root = entries.next()
 
2620
        if root.revision != rev.revision_id:
 
2621
            raise errors.IncompatibleRevision(repr(repository))
 
2622
    text_keys = {}
 
2623
    for path, ie in entries:
 
2624
        text_keys[(ie.file_id, ie.revision)] = ie
 
2625
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2626
    missing_texts = set(text_keys) - set(text_parent_map)
 
2627
    # Add the texts that are not already present
 
2628
    for text_key in missing_texts:
 
2629
        ie = text_keys[text_key]
 
2630
        text_parents = []
 
2631
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2632
        # commit to determine parents. There is a latent/real bug here where
 
2633
        # the parents inserted are not those commit would do - in particular
 
2634
        # they are not filtered by heads(). RBC, AB
 
2635
        for revision, tree in parent_trees.iteritems():
 
2636
            if ie.file_id not in tree:
 
2637
                continue
 
2638
            parent_id = tree.inventory[ie.file_id].revision
 
2639
            if parent_id in text_parents:
 
2640
                continue
 
2641
            text_parents.append((ie.file_id, parent_id))
 
2642
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2643
        repository.texts.add_lines(text_key, text_parents, lines)
 
2644
    try:
 
2645
        # install the inventory
 
2646
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2647
            # Cache this inventory
 
2648
            inventory_cache[rev.revision_id] = inv
 
2649
            try:
 
2650
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2651
            except KeyError:
 
2652
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2653
            else:
 
2654
                delta = inv._make_delta(basis_inv)
 
2655
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2656
                    rev.revision_id, present_parents)
 
2657
        else:
 
2658
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2659
    except errors.RevisionAlreadyPresent:
 
2660
        pass
 
2661
    if signature is not None:
 
2662
        repository.add_signature_text(rev.revision_id, signature)
 
2663
    repository.add_revision(rev.revision_id, rev, inv)
 
2664
 
1280
2665
 
1281
2666
class MetaDirRepository(Repository):
1282
2667
    """Repositories in the new meta-dir layout.
1317
2702
        return not self._transport.has('no-working-trees')
1318
2703
 
1319
2704
 
1320
 
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1321
 
    """Repository format registry."""
 
2705
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2706
    """Repositories in a meta-dir, that work via versioned file objects."""
1322
2707
 
1323
 
    def get_default(self):
1324
 
        """Return the current default format."""
1325
 
        from bzrlib import bzrdir
1326
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
2708
    def __init__(self, _format, a_bzrdir, control_files):
 
2709
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2710
            control_files)
1327
2711
 
1328
2712
 
1329
2713
network_format_registry = registry.FormatRegistry()
1335
2719
"""
1336
2720
 
1337
2721
 
1338
 
format_registry = RepositoryFormatRegistry(network_format_registry)
 
2722
format_registry = registry.FormatRegistry(network_format_registry)
1339
2723
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1340
2724
 
1341
2725
This can contain either format instances themselves, or classes/factories that
1346
2730
#####################################################################
1347
2731
# Repository Formats
1348
2732
 
1349
 
class RepositoryFormat(controldir.ControlComponentFormat):
 
2733
class RepositoryFormat(object):
1350
2734
    """A repository format.
1351
2735
 
1352
2736
    Formats provide four things:
1387
2771
    # Does this format support CHK bytestring lookups. Set to True or False in
1388
2772
    # derived classes.
1389
2773
    supports_chks = None
 
2774
    # Should commit add an inventory, or an inventory delta to the repository.
 
2775
    _commit_inv_deltas = True
 
2776
    # What order should fetch operations request streams in?
 
2777
    # The default is unordered as that is the cheapest for an origin to
 
2778
    # provide.
 
2779
    _fetch_order = 'unordered'
 
2780
    # Does this repository format use deltas that can be fetched as-deltas ?
 
2781
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
2782
    # We default to False, which will ensure that enough data to get
 
2783
    # a full text out of any fetch stream will be grabbed.
 
2784
    _fetch_uses_deltas = False
1390
2785
    # Should fetch trigger a reconcile after the fetch? Only needed for
1391
2786
    # some repository formats that can suffer internal inconsistencies.
1392
2787
    _fetch_reconcile = False
1393
2788
    # Does this format have < O(tree_size) delta generation. Used to hint what
1394
2789
    # code path for commit, amongst other things.
1395
2790
    fast_deltas = None
1396
 
    # Does doing a pack operation compress data? Useful for the pack UI command
1397
 
    # (so if there is one pack, the operation can still proceed because it may
1398
 
    # help), and for fetching when data won't have come from the same
1399
 
    # compressor.
1400
 
    pack_compresses = False
1401
 
    # Does the repository storage understand references to trees?
1402
 
    supports_tree_reference = None
1403
 
    # Is the format experimental ?
1404
 
    experimental = False
1405
 
    # Does this repository format escape funky characters, or does it create
1406
 
    # files with similar names as the versioned files in its contents on disk
1407
 
    # ?
1408
 
    supports_funky_characters = None
1409
 
    # Does this repository format support leaving locks?
1410
 
    supports_leaving_lock = None
1411
 
    # Does this format support the full VersionedFiles interface?
1412
 
    supports_full_versioned_files = None
1413
 
    # Does this format support signing revision signatures?
1414
 
    supports_revision_signatures = True
1415
 
    # Can the revision graph have incorrect parents?
1416
 
    revision_graph_can_have_wrong_parents = None
1417
 
    # Does this format support rich root data?
1418
 
    rich_root_data = None
1419
 
    # Does this format support explicitly versioned directories?
1420
 
    supports_versioned_directories = None
1421
2791
 
1422
 
    def __repr__(self):
1423
 
        return "%s()" % self.__class__.__name__
 
2792
    def __str__(self):
 
2793
        return "<%s>" % self.__class__.__name__
1424
2794
 
1425
2795
    def __eq__(self, other):
1426
2796
        # format objects are generally stateless
1439
2809
        """
1440
2810
        try:
1441
2811
            transport = a_bzrdir.get_repository_transport(None)
1442
 
            format_string = transport.get_bytes("format")
 
2812
            format_string = transport.get("format").read()
1443
2813
            return format_registry.get(format_string)
1444
2814
        except errors.NoSuchFile:
1445
2815
            raise errors.NoRepositoryPresent(a_bzrdir)
1448
2818
                                            kind='repository')
1449
2819
 
1450
2820
    @classmethod
1451
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1452
2821
    def register_format(klass, format):
1453
 
        format_registry.register(format)
 
2822
        format_registry.register(format.get_format_string(), format)
1454
2823
 
1455
2824
    @classmethod
1456
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1457
2825
    def unregister_format(klass, format):
1458
 
        format_registry.remove(format)
 
2826
        format_registry.remove(format.get_format_string())
1459
2827
 
1460
2828
    @classmethod
1461
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1462
2829
    def get_default_format(klass):
1463
2830
        """Return the current default format."""
1464
 
        return format_registry.get_default()
 
2831
        from bzrlib import bzrdir
 
2832
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1465
2833
 
1466
2834
    def get_format_string(self):
1467
2835
        """Return the ASCII format string that identifies this format.
1475
2843
        """Return the short description for this format."""
1476
2844
        raise NotImplementedError(self.get_format_description)
1477
2845
 
 
2846
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2847
    # use weaves or knits -- mbp 20070207
 
2848
    def _get_versioned_file_store(self,
 
2849
                                  name,
 
2850
                                  transport,
 
2851
                                  control_files,
 
2852
                                  prefixed=True,
 
2853
                                  versionedfile_class=None,
 
2854
                                  versionedfile_kwargs={},
 
2855
                                  escaped=False):
 
2856
        if versionedfile_class is None:
 
2857
            versionedfile_class = self._versionedfile_class
 
2858
        weave_transport = control_files._transport.clone(name)
 
2859
        dir_mode = control_files._dir_mode
 
2860
        file_mode = control_files._file_mode
 
2861
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
2862
                                  dir_mode=dir_mode,
 
2863
                                  file_mode=file_mode,
 
2864
                                  versionedfile_class=versionedfile_class,
 
2865
                                  versionedfile_kwargs=versionedfile_kwargs,
 
2866
                                  escaped=escaped)
 
2867
 
1478
2868
    def initialize(self, a_bzrdir, shared=False):
1479
2869
        """Initialize a repository of this format in a_bzrdir.
1480
2870
 
1496
2886
        """
1497
2887
        return True
1498
2888
 
1499
 
    def is_deprecated(self):
1500
 
        """Is this format deprecated?
1501
 
 
1502
 
        Deprecated formats may trigger a user-visible warning recommending
1503
 
        the user to upgrade. They are still fully supported.
1504
 
        """
1505
 
        return False
1506
 
 
1507
2889
    def network_name(self):
1508
2890
        """A simple byte string uniquely identifying this format for RPC calls.
1509
2891
 
1515
2897
        raise NotImplementedError(self.network_name)
1516
2898
 
1517
2899
    def check_conversion_target(self, target_format):
1518
 
        if self.rich_root_data and not target_format.rich_root_data:
1519
 
            raise errors.BadConversionTarget(
1520
 
                'Does not support rich root data.', target_format,
1521
 
                from_format=self)
1522
 
        if (self.supports_tree_reference and 
1523
 
            not getattr(target_format, 'supports_tree_reference', False)):
1524
 
            raise errors.BadConversionTarget(
1525
 
                'Does not support nested trees', target_format,
1526
 
                from_format=self)
 
2900
        raise NotImplementedError(self.check_conversion_target)
1527
2901
 
1528
2902
    def open(self, a_bzrdir, _found=False):
1529
2903
        """Return an instance of this format for the bzrdir a_bzrdir.
1532
2906
        """
1533
2907
        raise NotImplementedError(self.open)
1534
2908
 
1535
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
1536
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
1537
 
        hooks = BzrDir.hooks['post_repo_init']
1538
 
        if not hooks:
1539
 
            return
1540
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
1541
 
        for hook in hooks:
1542
 
            hook(params)
1543
 
 
1544
2909
 
1545
2910
class MetaDirRepositoryFormat(RepositoryFormat):
1546
2911
    """Common base class for the new repositories using the metadir layout."""
1548
2913
    rich_root_data = False
1549
2914
    supports_tree_reference = False
1550
2915
    supports_external_lookups = False
1551
 
    supports_leaving_lock = True
1552
2916
 
1553
2917
    @property
1554
2918
    def _matchingbzrdir(self):
1592
2956
        return self.get_format_string()
1593
2957
 
1594
2958
 
 
2959
# Pre-0.8 formats that don't have a disk format string (because they are
 
2960
# versioned by the matching control directory). We use the control directories
 
2961
# disk format string as a key for the network_name because they meet the
 
2962
# constraints (simple string, unique, immutable).
 
2963
network_format_registry.register_lazy(
 
2964
    "Bazaar-NG branch, format 5\n",
 
2965
    'bzrlib.repofmt.weaverepo',
 
2966
    'RepositoryFormat5',
 
2967
)
 
2968
network_format_registry.register_lazy(
 
2969
    "Bazaar-NG branch, format 6\n",
 
2970
    'bzrlib.repofmt.weaverepo',
 
2971
    'RepositoryFormat6',
 
2972
)
 
2973
 
1595
2974
# formats which have no format string are not discoverable or independently
1596
2975
# creatable on disk, so are not registered in format_registry.  They're
1597
 
# all in bzrlib.repofmt.knitreponow.  When an instance of one of these is
 
2976
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
1598
2977
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1599
2978
# the repository is not separately opened are similar.
1600
2979
 
1601
2980
format_registry.register_lazy(
 
2981
    'Bazaar-NG Repository format 7',
 
2982
    'bzrlib.repofmt.weaverepo',
 
2983
    'RepositoryFormat7'
 
2984
    )
 
2985
 
 
2986
format_registry.register_lazy(
1602
2987
    'Bazaar-NG Knit Repository Format 1',
1603
2988
    'bzrlib.repofmt.knitrepo',
1604
2989
    'RepositoryFormatKnit1',
1621
3006
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1622
3007
format_registry.register_lazy(
1623
3008
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1624
 
    'bzrlib.repofmt.knitpack_repo',
 
3009
    'bzrlib.repofmt.pack_repo',
1625
3010
    'RepositoryFormatKnitPack1',
1626
3011
    )
1627
3012
format_registry.register_lazy(
1628
3013
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1629
 
    'bzrlib.repofmt.knitpack_repo',
 
3014
    'bzrlib.repofmt.pack_repo',
1630
3015
    'RepositoryFormatKnitPack3',
1631
3016
    )
1632
3017
format_registry.register_lazy(
1633
3018
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1634
 
    'bzrlib.repofmt.knitpack_repo',
 
3019
    'bzrlib.repofmt.pack_repo',
1635
3020
    'RepositoryFormatKnitPack4',
1636
3021
    )
1637
3022
format_registry.register_lazy(
1638
3023
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1639
 
    'bzrlib.repofmt.knitpack_repo',
 
3024
    'bzrlib.repofmt.pack_repo',
1640
3025
    'RepositoryFormatKnitPack5',
1641
3026
    )
1642
3027
format_registry.register_lazy(
1643
3028
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1644
 
    'bzrlib.repofmt.knitpack_repo',
 
3029
    'bzrlib.repofmt.pack_repo',
1645
3030
    'RepositoryFormatKnitPack5RichRoot',
1646
3031
    )
1647
3032
format_registry.register_lazy(
1648
3033
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1649
 
    'bzrlib.repofmt.knitpack_repo',
 
3034
    'bzrlib.repofmt.pack_repo',
1650
3035
    'RepositoryFormatKnitPack5RichRootBroken',
1651
3036
    )
1652
3037
format_registry.register_lazy(
1653
3038
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1654
 
    'bzrlib.repofmt.knitpack_repo',
 
3039
    'bzrlib.repofmt.pack_repo',
1655
3040
    'RepositoryFormatKnitPack6',
1656
3041
    )
1657
3042
format_registry.register_lazy(
1658
3043
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1659
 
    'bzrlib.repofmt.knitpack_repo',
 
3044
    'bzrlib.repofmt.pack_repo',
1660
3045
    'RepositoryFormatKnitPack6RichRoot',
1661
3046
    )
1662
 
format_registry.register_lazy(
1663
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1664
 
    'bzrlib.repofmt.groupcompress_repo',
1665
 
    'RepositoryFormat2a',
1666
 
    )
1667
3047
 
1668
3048
# Development formats.
1669
 
# Check their docstrings to see if/when they are obsolete.
 
3049
# Obsolete but kept pending a CHK based subtree format.
1670
3050
format_registry.register_lazy(
1671
3051
    ("Bazaar development format 2 with subtree support "
1672
3052
        "(needs bzr.dev from before 1.8)\n"),
1673
 
    'bzrlib.repofmt.knitpack_repo',
 
3053
    'bzrlib.repofmt.pack_repo',
1674
3054
    'RepositoryFormatPackDevelopment2Subtree',
1675
3055
    )
1676
 
format_registry.register_lazy(
1677
 
    'Bazaar development format 8\n',
1678
 
    'bzrlib.repofmt.groupcompress_repo',
1679
 
    'RepositoryFormat2aSubtree',
 
3056
 
 
3057
# 1.14->1.16 go below here
 
3058
format_registry.register_lazy(
 
3059
    'Bazaar development format - group compression and chk inventory'
 
3060
        ' (needs bzr.dev from 1.14)\n',
 
3061
    'bzrlib.repofmt.groupcompress_repo',
 
3062
    'RepositoryFormatCHK1',
 
3063
    )
 
3064
 
 
3065
format_registry.register_lazy(
 
3066
    'Bazaar development format - chk repository with bencode revision '
 
3067
        'serialization (needs bzr.dev from 1.15)\n',
 
3068
    'bzrlib.repofmt.groupcompress_repo',
 
3069
    'RepositoryFormatCHK2',
1680
3070
    )
1681
3071
 
1682
3072
 
1692
3082
    InterRepository.get(other).method_name(parameters).
1693
3083
    """
1694
3084
 
 
3085
    _walk_to_common_revisions_batch_size = 50
1695
3086
    _optimisers = []
1696
3087
    """The available optimised InterRepository types."""
1697
3088
 
1712
3103
        self.target.fetch(self.source, revision_id=revision_id)
1713
3104
 
1714
3105
    @needs_write_lock
1715
 
    def fetch(self, revision_id=None, find_ghosts=False,
 
3106
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
1716
3107
            fetch_spec=None):
1717
3108
        """Fetch the content required to construct revision_id.
1718
3109
 
1720
3111
 
1721
3112
        :param revision_id: if None all content is copied, if NULL_REVISION no
1722
3113
                            content is copied.
 
3114
        :param pb: optional progress bar to use for progress reports. If not
 
3115
                   provided a default one will be created.
1723
3116
        :return: None.
1724
3117
        """
1725
 
        raise NotImplementedError(self.fetch)
 
3118
        from bzrlib.fetch import RepoFetcher
 
3119
        f = RepoFetcher(to_repository=self.target,
 
3120
                               from_repository=self.source,
 
3121
                               last_revision=revision_id,
 
3122
                               fetch_spec=fetch_spec,
 
3123
                               pb=pb, find_ghosts=find_ghosts)
 
3124
 
 
3125
    def _walk_to_common_revisions(self, revision_ids):
 
3126
        """Walk out from revision_ids in source to revisions target has.
 
3127
 
 
3128
        :param revision_ids: The start point for the search.
 
3129
        :return: A set of revision ids.
 
3130
        """
 
3131
        target_graph = self.target.get_graph()
 
3132
        revision_ids = frozenset(revision_ids)
 
3133
        missing_revs = set()
 
3134
        source_graph = self.source.get_graph()
 
3135
        # ensure we don't pay silly lookup costs.
 
3136
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
3137
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3138
        searcher_exhausted = False
 
3139
        while True:
 
3140
            next_revs = set()
 
3141
            ghosts = set()
 
3142
            # Iterate the searcher until we have enough next_revs
 
3143
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3144
                try:
 
3145
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3146
                    next_revs.update(next_revs_part)
 
3147
                    ghosts.update(ghosts_part)
 
3148
                except StopIteration:
 
3149
                    searcher_exhausted = True
 
3150
                    break
 
3151
            # If there are ghosts in the source graph, and the caller asked for
 
3152
            # them, make sure that they are present in the target.
 
3153
            # We don't care about other ghosts as we can't fetch them and
 
3154
            # haven't been asked to.
 
3155
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3156
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3157
            if revs_to_get:
 
3158
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3159
                # we always have NULL_REVISION present.
 
3160
                have_revs = have_revs.union(null_set)
 
3161
                # Check if the target is missing any ghosts we need.
 
3162
                ghosts_to_check.difference_update(have_revs)
 
3163
                if ghosts_to_check:
 
3164
                    # One of the caller's revision_ids is a ghost in both the
 
3165
                    # source and the target.
 
3166
                    raise errors.NoSuchRevision(
 
3167
                        self.source, ghosts_to_check.pop())
 
3168
                missing_revs.update(next_revs - have_revs)
 
3169
                # Because we may have walked past the original stop point, make
 
3170
                # sure everything is stopped
 
3171
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3172
                searcher.stop_searching_any(stop_revs)
 
3173
            if searcher_exhausted:
 
3174
                break
 
3175
        return searcher.get_result()
1726
3176
 
1727
3177
    @needs_read_lock
1728
 
    def search_missing_revision_ids(self,
1729
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1730
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1731
 
            limit=None):
 
3178
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1732
3179
        """Return the revision ids that source has that target does not.
1733
3180
 
1734
3181
        :param revision_id: only return revision ids included by this
1735
 
            revision_id.
1736
 
        :param revision_ids: return revision ids included by these
1737
 
            revision_ids.  NoSuchRevision will be raised if any of these
1738
 
            revisions are not present.
1739
 
        :param if_present_ids: like revision_ids, but will not cause
1740
 
            NoSuchRevision if any of these are absent, instead they will simply
1741
 
            not be in the result.  This is useful for e.g. finding revisions
1742
 
            to fetch for tags, which may reference absent revisions.
 
3182
                            revision_id.
1743
3183
        :param find_ghosts: If True find missing revisions in deep history
1744
3184
            rather than just finding the surface difference.
1745
 
        :param limit: Maximum number of revisions to return, topologically
1746
 
            ordered
1747
3185
        :return: A bzrlib.graph.SearchResult.
1748
3186
        """
1749
 
        raise NotImplementedError(self.search_missing_revision_ids)
 
3187
        # stop searching at found target revisions.
 
3188
        if not find_ghosts and revision_id is not None:
 
3189
            return self._walk_to_common_revisions([revision_id])
 
3190
        # generic, possibly worst case, slow code path.
 
3191
        target_ids = set(self.target.all_revision_ids())
 
3192
        if revision_id is not None:
 
3193
            source_ids = self.source.get_ancestry(revision_id)
 
3194
            if source_ids[0] is not None:
 
3195
                raise AssertionError()
 
3196
            source_ids.pop(0)
 
3197
        else:
 
3198
            source_ids = self.source.all_revision_ids()
 
3199
        result_set = set(source_ids).difference(target_ids)
 
3200
        return self.source.revision_ids_to_search_result(result_set)
1750
3201
 
1751
3202
    @staticmethod
1752
3203
    def _same_model(source, target):
1773
3224
                "different serializers")
1774
3225
 
1775
3226
 
 
3227
class InterSameDataRepository(InterRepository):
 
3228
    """Code for converting between repositories that represent the same data.
 
3229
 
 
3230
    Data format and model must match for this to work.
 
3231
    """
 
3232
 
 
3233
    @classmethod
 
3234
    def _get_repo_format_to_test(self):
 
3235
        """Repository format for testing with.
 
3236
 
 
3237
        InterSameData can pull from subtree to subtree and from non-subtree to
 
3238
        non-subtree, so we test this with the richest repository format.
 
3239
        """
 
3240
        from bzrlib.repofmt import knitrepo
 
3241
        return knitrepo.RepositoryFormatKnit3()
 
3242
 
 
3243
    @staticmethod
 
3244
    def is_compatible(source, target):
 
3245
        return InterRepository._same_model(source, target)
 
3246
 
 
3247
 
 
3248
class InterWeaveRepo(InterSameDataRepository):
 
3249
    """Optimised code paths between Weave based repositories.
 
3250
 
 
3251
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
3252
    implemented lazy inter-object optimisation.
 
3253
    """
 
3254
 
 
3255
    @classmethod
 
3256
    def _get_repo_format_to_test(self):
 
3257
        from bzrlib.repofmt import weaverepo
 
3258
        return weaverepo.RepositoryFormat7()
 
3259
 
 
3260
    @staticmethod
 
3261
    def is_compatible(source, target):
 
3262
        """Be compatible with known Weave formats.
 
3263
 
 
3264
        We don't test for the stores being of specific types because that
 
3265
        could lead to confusing results, and there is no need to be
 
3266
        overly general.
 
3267
        """
 
3268
        from bzrlib.repofmt.weaverepo import (
 
3269
                RepositoryFormat5,
 
3270
                RepositoryFormat6,
 
3271
                RepositoryFormat7,
 
3272
                )
 
3273
        try:
 
3274
            return (isinstance(source._format, (RepositoryFormat5,
 
3275
                                                RepositoryFormat6,
 
3276
                                                RepositoryFormat7)) and
 
3277
                    isinstance(target._format, (RepositoryFormat5,
 
3278
                                                RepositoryFormat6,
 
3279
                                                RepositoryFormat7)))
 
3280
        except AttributeError:
 
3281
            return False
 
3282
 
 
3283
    @needs_write_lock
 
3284
    def copy_content(self, revision_id=None):
 
3285
        """See InterRepository.copy_content()."""
 
3286
        # weave specific optimised path:
 
3287
        try:
 
3288
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3289
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
3290
            pass
 
3291
        # FIXME do not peek!
 
3292
        if self.source._transport.listable():
 
3293
            pb = ui.ui_factory.nested_progress_bar()
 
3294
            try:
 
3295
                self.target.texts.insert_record_stream(
 
3296
                    self.source.texts.get_record_stream(
 
3297
                        self.source.texts.keys(), 'topological', False))
 
3298
                pb.update('copying inventory', 0, 1)
 
3299
                self.target.inventories.insert_record_stream(
 
3300
                    self.source.inventories.get_record_stream(
 
3301
                        self.source.inventories.keys(), 'topological', False))
 
3302
                self.target.signatures.insert_record_stream(
 
3303
                    self.source.signatures.get_record_stream(
 
3304
                        self.source.signatures.keys(),
 
3305
                        'unordered', True))
 
3306
                self.target.revisions.insert_record_stream(
 
3307
                    self.source.revisions.get_record_stream(
 
3308
                        self.source.revisions.keys(),
 
3309
                        'topological', True))
 
3310
            finally:
 
3311
                pb.finished()
 
3312
        else:
 
3313
            self.target.fetch(self.source, revision_id=revision_id)
 
3314
 
 
3315
    @needs_read_lock
 
3316
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3317
        """See InterRepository.missing_revision_ids()."""
 
3318
        # we want all revisions to satisfy revision_id in source.
 
3319
        # but we don't want to stat every file here and there.
 
3320
        # we want then, all revisions other needs to satisfy revision_id
 
3321
        # checked, but not those that we have locally.
 
3322
        # so the first thing is to get a subset of the revisions to
 
3323
        # satisfy revision_id in source, and then eliminate those that
 
3324
        # we do already have.
 
3325
        # this is slow on high latency connection to self, but as this
 
3326
        # disk format scales terribly for push anyway due to rewriting
 
3327
        # inventory.weave, this is considered acceptable.
 
3328
        # - RBC 20060209
 
3329
        if revision_id is not None:
 
3330
            source_ids = self.source.get_ancestry(revision_id)
 
3331
            if source_ids[0] is not None:
 
3332
                raise AssertionError()
 
3333
            source_ids.pop(0)
 
3334
        else:
 
3335
            source_ids = self.source._all_possible_ids()
 
3336
        source_ids_set = set(source_ids)
 
3337
        # source_ids is the worst possible case we may need to pull.
 
3338
        # now we want to filter source_ids against what we actually
 
3339
        # have in target, but don't try to check for existence where we know
 
3340
        # we do not have a revision as that would be pointless.
 
3341
        target_ids = set(self.target._all_possible_ids())
 
3342
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
3343
        actually_present_revisions = set(
 
3344
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3345
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
3346
        if revision_id is not None:
 
3347
            # we used get_ancestry to determine source_ids then we are assured all
 
3348
            # revisions referenced are present as they are installed in topological order.
 
3349
            # and the tip revision was validated by get_ancestry.
 
3350
            result_set = required_revisions
 
3351
        else:
 
3352
            # if we just grabbed the possibly available ids, then
 
3353
            # we only have an estimate of whats available and need to validate
 
3354
            # that against the revision records.
 
3355
            result_set = set(
 
3356
                self.source._eliminate_revisions_not_present(required_revisions))
 
3357
        return self.source.revision_ids_to_search_result(result_set)
 
3358
 
 
3359
 
 
3360
class InterKnitRepo(InterSameDataRepository):
 
3361
    """Optimised code paths between Knit based repositories."""
 
3362
 
 
3363
    @classmethod
 
3364
    def _get_repo_format_to_test(self):
 
3365
        from bzrlib.repofmt import knitrepo
 
3366
        return knitrepo.RepositoryFormatKnit1()
 
3367
 
 
3368
    @staticmethod
 
3369
    def is_compatible(source, target):
 
3370
        """Be compatible with known Knit formats.
 
3371
 
 
3372
        We don't test for the stores being of specific types because that
 
3373
        could lead to confusing results, and there is no need to be
 
3374
        overly general.
 
3375
        """
 
3376
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
3377
        try:
 
3378
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
3379
                isinstance(target._format, RepositoryFormatKnit))
 
3380
        except AttributeError:
 
3381
            return False
 
3382
        return are_knits and InterRepository._same_model(source, target)
 
3383
 
 
3384
    @needs_read_lock
 
3385
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3386
        """See InterRepository.missing_revision_ids()."""
 
3387
        if revision_id is not None:
 
3388
            source_ids = self.source.get_ancestry(revision_id)
 
3389
            if source_ids[0] is not None:
 
3390
                raise AssertionError()
 
3391
            source_ids.pop(0)
 
3392
        else:
 
3393
            source_ids = self.source.all_revision_ids()
 
3394
        source_ids_set = set(source_ids)
 
3395
        # source_ids is the worst possible case we may need to pull.
 
3396
        # now we want to filter source_ids against what we actually
 
3397
        # have in target, but don't try to check for existence where we know
 
3398
        # we do not have a revision as that would be pointless.
 
3399
        target_ids = set(self.target.all_revision_ids())
 
3400
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
3401
        actually_present_revisions = set(
 
3402
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3403
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
3404
        if revision_id is not None:
 
3405
            # we used get_ancestry to determine source_ids then we are assured all
 
3406
            # revisions referenced are present as they are installed in topological order.
 
3407
            # and the tip revision was validated by get_ancestry.
 
3408
            result_set = required_revisions
 
3409
        else:
 
3410
            # if we just grabbed the possibly available ids, then
 
3411
            # we only have an estimate of whats available and need to validate
 
3412
            # that against the revision records.
 
3413
            result_set = set(
 
3414
                self.source._eliminate_revisions_not_present(required_revisions))
 
3415
        return self.source.revision_ids_to_search_result(result_set)
 
3416
 
 
3417
 
 
3418
class InterPackRepo(InterSameDataRepository):
 
3419
    """Optimised code paths between Pack based repositories."""
 
3420
 
 
3421
    @classmethod
 
3422
    def _get_repo_format_to_test(self):
 
3423
        from bzrlib.repofmt import pack_repo
 
3424
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3425
 
 
3426
    @staticmethod
 
3427
    def is_compatible(source, target):
 
3428
        """Be compatible with known Pack formats.
 
3429
 
 
3430
        We don't test for the stores being of specific types because that
 
3431
        could lead to confusing results, and there is no need to be
 
3432
        overly general.
 
3433
 
 
3434
        InterPackRepo does not support CHK based repositories.
 
3435
        """
 
3436
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3437
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3438
        try:
 
3439
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3440
                isinstance(target._format, RepositoryFormatPack))
 
3441
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3442
                isinstance(target._format, RepositoryFormatCHK1))
 
3443
        except AttributeError:
 
3444
            return False
 
3445
        if not_packs or not are_packs:
 
3446
            return False
 
3447
        return InterRepository._same_model(source, target)
 
3448
 
 
3449
    @needs_write_lock
 
3450
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3451
            fetch_spec=None):
 
3452
        """See InterRepository.fetch()."""
 
3453
        if (len(self.source._fallback_repositories) > 0 or
 
3454
            len(self.target._fallback_repositories) > 0):
 
3455
            # The pack layer is not aware of fallback repositories, so when
 
3456
            # fetching from a stacked repository or into a stacked repository
 
3457
            # we use the generic fetch logic which uses the VersionedFiles
 
3458
            # attributes on repository.
 
3459
            from bzrlib.fetch import RepoFetcher
 
3460
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3461
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3462
        if fetch_spec is not None:
 
3463
            if len(list(fetch_spec.heads)) != 1:
 
3464
                raise AssertionError(
 
3465
                    "InterPackRepo.fetch doesn't support "
 
3466
                    "fetching multiple heads yet.")
 
3467
            revision_id = list(fetch_spec.heads)[0]
 
3468
            fetch_spec = None
 
3469
        if revision_id is None:
 
3470
            # TODO:
 
3471
            # everything to do - use pack logic
 
3472
            # to fetch from all packs to one without
 
3473
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3474
            # till then:
 
3475
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3476
            revision_ids = source_revision_ids - \
 
3477
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3478
            revision_keys = [(revid,) for revid in revision_ids]
 
3479
            index = self.target._pack_collection.revision_index.combined_index
 
3480
            present_revision_ids = set(item[1][0] for item in
 
3481
                index.iter_entries(revision_keys))
 
3482
            revision_ids = set(revision_ids) - present_revision_ids
 
3483
            # implementing the TODO will involve:
 
3484
            # - detecting when all of a pack is selected
 
3485
            # - avoiding as much as possible pre-selection, so the
 
3486
            # more-core routines such as create_pack_from_packs can filter in
 
3487
            # a just-in-time fashion. (though having a HEADS list on a
 
3488
            # repository might make this a lot easier, because we could
 
3489
            # sensibly detect 'new revisions' without doing a full index scan.
 
3490
        elif _mod_revision.is_null(revision_id):
 
3491
            # nothing to do:
 
3492
            return (0, [])
 
3493
        else:
 
3494
            revision_ids = self.search_missing_revision_ids(revision_id,
 
3495
                find_ghosts=find_ghosts).get_keys()
 
3496
            if len(revision_ids) == 0:
 
3497
                return (0, [])
 
3498
        return self._pack(self.source, self.target, revision_ids)
 
3499
 
 
3500
    def _pack(self, source, target, revision_ids):
 
3501
        from bzrlib.repofmt.pack_repo import Packer
 
3502
        packs = source._pack_collection.all_packs()
 
3503
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3504
            revision_ids).pack()
 
3505
        if pack is not None:
 
3506
            self.target._pack_collection._save_pack_names()
 
3507
            copied_revs = pack.get_revision_count()
 
3508
            # Trigger an autopack. This may duplicate effort as we've just done
 
3509
            # a pack creation, but for now it is simpler to think about as
 
3510
            # 'upload data, then repack if needed'.
 
3511
            self.target._pack_collection.autopack()
 
3512
            return (copied_revs, [])
 
3513
        else:
 
3514
            return (0, [])
 
3515
 
 
3516
    @needs_read_lock
 
3517
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3518
        """See InterRepository.missing_revision_ids().
 
3519
 
 
3520
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3521
            revision_id.
 
3522
        """
 
3523
        if not find_ghosts and revision_id is not None:
 
3524
            return self._walk_to_common_revisions([revision_id])
 
3525
        elif revision_id is not None:
 
3526
            # Find ghosts: search for revisions pointing from one repository to
 
3527
            # the other, and vice versa, anywhere in the history of revision_id.
 
3528
            graph = self.target.get_graph(other_repository=self.source)
 
3529
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3530
            found_ids = set()
 
3531
            while True:
 
3532
                try:
 
3533
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3534
                except StopIteration:
 
3535
                    break
 
3536
                if revision_id in ghosts:
 
3537
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3538
                found_ids.update(next_revs)
 
3539
                found_ids.update(ghosts)
 
3540
            found_ids = frozenset(found_ids)
 
3541
            # Double query here: should be able to avoid this by changing the
 
3542
            # graph api further.
 
3543
            result_set = found_ids - frozenset(
 
3544
                self.target.get_parent_map(found_ids))
 
3545
        else:
 
3546
            source_ids = self.source.all_revision_ids()
 
3547
            # source_ids is the worst possible case we may need to pull.
 
3548
            # now we want to filter source_ids against what we actually
 
3549
            # have in target, but don't try to check for existence where we know
 
3550
            # we do not have a revision as that would be pointless.
 
3551
            target_ids = set(self.target.all_revision_ids())
 
3552
            result_set = set(source_ids).difference(target_ids)
 
3553
        return self.source.revision_ids_to_search_result(result_set)
 
3554
 
 
3555
 
 
3556
class InterDifferingSerializer(InterRepository):
 
3557
 
 
3558
    @classmethod
 
3559
    def _get_repo_format_to_test(self):
 
3560
        return None
 
3561
 
 
3562
    @staticmethod
 
3563
    def is_compatible(source, target):
 
3564
        """Be compatible with Knit2 source and Knit3 target"""
 
3565
        # This is redundant with format.check_conversion_target(), however that
 
3566
        # raises an exception, and we just want to say "False" as in we won't
 
3567
        # support converting between these formats.
 
3568
        if source.supports_rich_root() and not target.supports_rich_root():
 
3569
            return False
 
3570
        if (source._format.supports_tree_reference
 
3571
            and not target._format.supports_tree_reference):
 
3572
            return False
 
3573
        return True
 
3574
 
 
3575
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
 
3576
        """Get the best delta and base for this revision.
 
3577
 
 
3578
        :return: (basis_id, delta)
 
3579
        """
 
3580
        possible_trees = [(parent_id, cache[parent_id])
 
3581
                          for parent_id in parent_ids
 
3582
                           if parent_id in cache]
 
3583
        if len(possible_trees) == 0:
 
3584
            # There either aren't any parents, or the parents aren't in the
 
3585
            # cache, so just use the last converted tree
 
3586
            possible_trees.append((basis_id, cache[basis_id]))
 
3587
        deltas = []
 
3588
        for basis_id, basis_tree in possible_trees:
 
3589
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3590
            deltas.append((len(delta), basis_id, delta))
 
3591
        deltas.sort()
 
3592
        return deltas[0][1:]
 
3593
 
 
3594
    def _get_parent_keys(self, root_key, parent_map):
 
3595
        """Get the parent keys for a given root id."""
 
3596
        root_id, rev_id = root_key
 
3597
        # Include direct parents of the revision, but only if they used
 
3598
        # the same root_id and are heads.
 
3599
        parent_keys = []
 
3600
        for parent_id in parent_map[rev_id]:
 
3601
            if parent_id == _mod_revision.NULL_REVISION:
 
3602
                continue
 
3603
            if parent_id not in self._revision_id_to_root_id:
 
3604
                # We probably didn't read this revision, go spend the
 
3605
                # extra effort to actually check
 
3606
                try:
 
3607
                    tree = self.source.revision_tree(parent_id)
 
3608
                except errors.NoSuchRevision:
 
3609
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3610
                    # encounter this again.
 
3611
                    # But set parent_root_id to None since we don't really know
 
3612
                    parent_root_id = None
 
3613
                else:
 
3614
                    parent_root_id = tree.get_root_id()
 
3615
                self._revision_id_to_root_id[parent_id] = None
 
3616
            else:
 
3617
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3618
            if root_id == parent_root_id:
 
3619
                # With stacking we _might_ want to refer to a non-local
 
3620
                # revision, but this code path only applies when we have the
 
3621
                # full content available, so ghosts really are ghosts, not just
 
3622
                # the edge of local data.
 
3623
                parent_keys.append((parent_id,))
 
3624
            else:
 
3625
                # root_id may be in the parent anyway.
 
3626
                try:
 
3627
                    tree = self.source.revision_tree(parent_id)
 
3628
                except errors.NoSuchRevision:
 
3629
                    # ghost, can't refer to it.
 
3630
                    pass
 
3631
                else:
 
3632
                    try:
 
3633
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3634
                    except errors.NoSuchId:
 
3635
                        # not in the tree
 
3636
                        pass
 
3637
        g = graph.Graph(self.source.revisions)
 
3638
        heads = g.heads(parent_keys)
 
3639
        selected_keys = []
 
3640
        for key in parent_keys:
 
3641
            if key in heads and key not in selected_keys:
 
3642
                selected_keys.append(key)
 
3643
        return tuple([(root_id,)+ key for key in selected_keys])
 
3644
 
 
3645
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3646
        for root_key in root_keys_to_create:
 
3647
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3648
            yield versionedfile.FulltextContentFactory(root_key,
 
3649
                parent_keys, None, '')
 
3650
 
 
3651
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3652
        """Fetch across a few revisions.
 
3653
 
 
3654
        :param revision_ids: The revisions to copy
 
3655
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3656
            as a basis for delta when no other base is available
 
3657
        :param cache: A cache of RevisionTrees that we can use.
 
3658
        :return: The revision_id of the last converted tree. The RevisionTree
 
3659
            for it will be in cache
 
3660
        """
 
3661
        # Walk though all revisions; get inventory deltas, copy referenced
 
3662
        # texts that delta references, insert the delta, revision and
 
3663
        # signature.
 
3664
        root_keys_to_create = set()
 
3665
        text_keys = set()
 
3666
        pending_deltas = []
 
3667
        pending_revisions = []
 
3668
        parent_map = self.source.get_parent_map(revision_ids)
 
3669
        for tree in self.source.revision_trees(revision_ids):
 
3670
            current_revision_id = tree.get_revision_id()
 
3671
            parent_ids = parent_map.get(current_revision_id, ())
 
3672
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3673
                                                           basis_id, cache)
 
3674
            if self._converting_to_rich_root:
 
3675
                self._revision_id_to_root_id[current_revision_id] = \
 
3676
                    tree.get_root_id()
 
3677
            # Find text entries that need to be copied
 
3678
            for old_path, new_path, file_id, entry in delta:
 
3679
                if new_path is not None:
 
3680
                    if not new_path:
 
3681
                        # This is the root
 
3682
                        if not self.target.supports_rich_root():
 
3683
                            # The target doesn't support rich root, so we don't
 
3684
                            # copy
 
3685
                            continue
 
3686
                        if self._converting_to_rich_root:
 
3687
                            # This can't be copied normally, we have to insert
 
3688
                            # it specially
 
3689
                            root_keys_to_create.add((file_id, entry.revision))
 
3690
                            continue
 
3691
                    text_keys.add((file_id, entry.revision))
 
3692
            revision = self.source.get_revision(current_revision_id)
 
3693
            pending_deltas.append((basis_id, delta,
 
3694
                current_revision_id, revision.parent_ids))
 
3695
            pending_revisions.append(revision)
 
3696
            cache[current_revision_id] = tree
 
3697
            basis_id = current_revision_id
 
3698
        # Copy file texts
 
3699
        from_texts = self.source.texts
 
3700
        to_texts = self.target.texts
 
3701
        if root_keys_to_create:
 
3702
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3703
                                                     parent_map)
 
3704
            to_texts.insert_record_stream(root_stream)
 
3705
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3706
            text_keys, self.target._format._fetch_order,
 
3707
            not self.target._format._fetch_uses_deltas))
 
3708
        # insert inventory deltas
 
3709
        for delta in pending_deltas:
 
3710
            self.target.add_inventory_by_delta(*delta)
 
3711
        if self.target._fallback_repositories:
 
3712
            # Make sure this stacked repository has all the parent inventories
 
3713
            # for the new revisions that we are about to insert.  We do this
 
3714
            # before adding the revisions so that no revision is added until
 
3715
            # all the inventories it may depend on are added.
 
3716
            parent_ids = set()
 
3717
            revision_ids = set()
 
3718
            for revision in pending_revisions:
 
3719
                revision_ids.add(revision.revision_id)
 
3720
                parent_ids.update(revision.parent_ids)
 
3721
            parent_ids.difference_update(revision_ids)
 
3722
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3723
            parent_map = self.source.get_parent_map(parent_ids)
 
3724
            for parent_tree in self.source.revision_trees(parent_ids):
 
3725
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
 
3726
                current_revision_id = parent_tree.get_revision_id()
 
3727
                parents_parents = parent_map[current_revision_id]
 
3728
                self.target.add_inventory_by_delta(
 
3729
                    basis_id, delta, current_revision_id, parents_parents)
 
3730
        # insert signatures and revisions
 
3731
        for revision in pending_revisions:
 
3732
            try:
 
3733
                signature = self.source.get_signature_text(
 
3734
                    revision.revision_id)
 
3735
                self.target.add_signature_text(revision.revision_id,
 
3736
                    signature)
 
3737
            except errors.NoSuchRevision:
 
3738
                pass
 
3739
            self.target.add_revision(revision.revision_id, revision)
 
3740
        return basis_id
 
3741
 
 
3742
    def _fetch_all_revisions(self, revision_ids, pb):
 
3743
        """Fetch everything for the list of revisions.
 
3744
 
 
3745
        :param revision_ids: The list of revisions to fetch. Must be in
 
3746
            topological order.
 
3747
        :param pb: A ProgressBar
 
3748
        :return: None
 
3749
        """
 
3750
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3751
        batch_size = 100
 
3752
        cache = lru_cache.LRUCache(100)
 
3753
        cache[basis_id] = basis_tree
 
3754
        del basis_tree # We don't want to hang on to it here
 
3755
        for offset in range(0, len(revision_ids), batch_size):
 
3756
            self.target.start_write_group()
 
3757
            try:
 
3758
                pb.update('Transferring revisions', offset,
 
3759
                          len(revision_ids))
 
3760
                batch = revision_ids[offset:offset+batch_size]
 
3761
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3762
            except:
 
3763
                self.target.abort_write_group()
 
3764
                raise
 
3765
            else:
 
3766
                self.target.commit_write_group()
 
3767
        pb.update('Transferring revisions', len(revision_ids),
 
3768
                  len(revision_ids))
 
3769
 
 
3770
    @needs_write_lock
 
3771
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3772
            fetch_spec=None):
 
3773
        """See InterRepository.fetch()."""
 
3774
        if fetch_spec is not None:
 
3775
            raise AssertionError("Not implemented yet...")
 
3776
        if (not self.source.supports_rich_root()
 
3777
            and self.target.supports_rich_root()):
 
3778
            self._converting_to_rich_root = True
 
3779
            self._revision_id_to_root_id = {}
 
3780
        else:
 
3781
            self._converting_to_rich_root = False
 
3782
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3783
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3784
        if not revision_ids:
 
3785
            return 0, 0
 
3786
        revision_ids = tsort.topo_sort(
 
3787
            self.source.get_graph().get_parent_map(revision_ids))
 
3788
        if not revision_ids:
 
3789
            return 0, 0
 
3790
        # Walk though all revisions; get inventory deltas, copy referenced
 
3791
        # texts that delta references, insert the delta, revision and
 
3792
        # signature.
 
3793
        first_rev = self.source.get_revision(revision_ids[0])
 
3794
        if pb is None:
 
3795
            my_pb = ui.ui_factory.nested_progress_bar()
 
3796
            pb = my_pb
 
3797
        else:
 
3798
            symbol_versioning.warn(
 
3799
                symbol_versioning.deprecated_in((1, 14, 0))
 
3800
                % "pb parameter to fetch()")
 
3801
            my_pb = None
 
3802
        try:
 
3803
            self._fetch_all_revisions(revision_ids, pb)
 
3804
        finally:
 
3805
            if my_pb is not None:
 
3806
                my_pb.finished()
 
3807
        return len(revision_ids), 0
 
3808
 
 
3809
    def _get_basis(self, first_revision_id):
 
3810
        """Get a revision and tree which exists in the target.
 
3811
 
 
3812
        This assumes that first_revision_id is selected for transmission
 
3813
        because all other ancestors are already present. If we can't find an
 
3814
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
3815
 
 
3816
        :return: (basis_id, basis_tree)
 
3817
        """
 
3818
        first_rev = self.source.get_revision(first_revision_id)
 
3819
        try:
 
3820
            basis_id = first_rev.parent_ids[0]
 
3821
            # only valid as a basis if the target has it
 
3822
            self.target.get_revision(basis_id)
 
3823
            # Try to get a basis tree - if its a ghost it will hit the
 
3824
            # NoSuchRevision case.
 
3825
            basis_tree = self.source.revision_tree(basis_id)
 
3826
        except (IndexError, errors.NoSuchRevision):
 
3827
            basis_id = _mod_revision.NULL_REVISION
 
3828
            basis_tree = self.source.revision_tree(basis_id)
 
3829
        return basis_id, basis_tree
 
3830
 
 
3831
 
 
3832
InterRepository.register_optimiser(InterDifferingSerializer)
 
3833
InterRepository.register_optimiser(InterSameDataRepository)
 
3834
InterRepository.register_optimiser(InterWeaveRepo)
 
3835
InterRepository.register_optimiser(InterKnitRepo)
 
3836
InterRepository.register_optimiser(InterPackRepo)
 
3837
 
 
3838
 
1776
3839
class CopyConverter(object):
1777
3840
    """A repository conversion tool which just performs a copy of the content.
1778
3841
 
1792
3855
        :param to_convert: The disk object to convert.
1793
3856
        :param pb: a progress bar to use for progress information.
1794
3857
        """
1795
 
        pb = ui.ui_factory.nested_progress_bar()
 
3858
        self.pb = pb
1796
3859
        self.count = 0
1797
3860
        self.total = 4
1798
3861
        # this is only useful with metadir layouts - separated repo content.
1799
3862
        # trigger an assertion if not such
1800
3863
        repo._format.get_format_string()
1801
3864
        self.repo_dir = repo.bzrdir
1802
 
        pb.update('Moving repository to repository.backup')
 
3865
        self.step('Moving repository to repository.backup')
1803
3866
        self.repo_dir.transport.move('repository', 'repository.backup')
1804
3867
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1805
3868
        repo._format.check_conversion_target(self.target_format)
1806
3869
        self.source_repo = repo._format.open(self.repo_dir,
1807
3870
            _found=True,
1808
3871
            _override_transport=backup_transport)
1809
 
        pb.update('Creating new repository')
 
3872
        self.step('Creating new repository')
1810
3873
        converted = self.target_format.initialize(self.repo_dir,
1811
3874
                                                  self.source_repo.is_shared())
1812
3875
        converted.lock_write()
1813
3876
        try:
1814
 
            pb.update('Copying content')
 
3877
            self.step('Copying content into repository.')
1815
3878
            self.source_repo.copy_content_into(converted)
1816
3879
        finally:
1817
3880
            converted.unlock()
1818
 
        pb.update('Deleting old repository content')
 
3881
        self.step('Deleting old repository content.')
1819
3882
        self.repo_dir.transport.delete_tree('repository.backup')
1820
 
        ui.ui_factory.note('repository converted')
1821
 
        pb.finished()
 
3883
        self.pb.note('repository converted')
 
3884
 
 
3885
    def step(self, message):
 
3886
        """Update the pb by a step."""
 
3887
        self.count +=1
 
3888
        self.pb.update(message, self.count, self.total)
 
3889
 
 
3890
 
 
3891
_unescape_map = {
 
3892
    'apos':"'",
 
3893
    'quot':'"',
 
3894
    'amp':'&',
 
3895
    'lt':'<',
 
3896
    'gt':'>'
 
3897
}
 
3898
 
 
3899
 
 
3900
def _unescaper(match, _map=_unescape_map):
 
3901
    code = match.group(1)
 
3902
    try:
 
3903
        return _map[code]
 
3904
    except KeyError:
 
3905
        if not code.startswith('#'):
 
3906
            raise
 
3907
        return unichr(int(code[1:])).encode('utf8')
 
3908
 
 
3909
 
 
3910
_unescape_re = None
 
3911
 
 
3912
 
 
3913
def _unescape_xml(data):
 
3914
    """Unescape predefined XML entities in a string of data."""
 
3915
    global _unescape_re
 
3916
    if _unescape_re is None:
 
3917
        _unescape_re = re.compile('\&([^;]*);')
 
3918
    return _unescape_re.sub(_unescaper, data)
 
3919
 
 
3920
 
 
3921
class _VersionedFileChecker(object):
 
3922
 
 
3923
    def __init__(self, repository, text_key_references=None):
 
3924
        self.repository = repository
 
3925
        self.text_index = self.repository._generate_text_key_index(
 
3926
            text_key_references=text_key_references)
 
3927
 
 
3928
    def calculate_file_version_parents(self, text_key):
 
3929
        """Calculate the correct parents for a file version according to
 
3930
        the inventories.
 
3931
        """
 
3932
        parent_keys = self.text_index[text_key]
 
3933
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3934
            return ()
 
3935
        return tuple(parent_keys)
 
3936
 
 
3937
    def check_file_version_parents(self, texts, progress_bar=None):
 
3938
        """Check the parents stored in a versioned file are correct.
 
3939
 
 
3940
        It also detects file versions that are not referenced by their
 
3941
        corresponding revision's inventory.
 
3942
 
 
3943
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3944
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3945
            correct_parents)} for each revision_id where the stored parents
 
3946
            are not correct.  dangling_file_versions is a set of (file_id,
 
3947
            revision_id) tuples for versions that are present in this versioned
 
3948
            file, but not used by the corresponding inventory.
 
3949
        """
 
3950
        wrong_parents = {}
 
3951
        self.file_ids = set([file_id for file_id, _ in
 
3952
            self.text_index.iterkeys()])
 
3953
        # text keys is now grouped by file_id
 
3954
        n_weaves = len(self.file_ids)
 
3955
        files_in_revisions = {}
 
3956
        revisions_of_files = {}
 
3957
        n_versions = len(self.text_index)
 
3958
        progress_bar.update('loading text store', 0, n_versions)
 
3959
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
3960
        # On unlistable transports this could well be empty/error...
 
3961
        text_keys = self.repository.texts.keys()
 
3962
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
3963
        for num, key in enumerate(self.text_index.iterkeys()):
 
3964
            if progress_bar is not None:
 
3965
                progress_bar.update('checking text graph', num, n_versions)
 
3966
            correct_parents = self.calculate_file_version_parents(key)
 
3967
            try:
 
3968
                knit_parents = parent_map[key]
 
3969
            except errors.RevisionNotPresent:
 
3970
                # Missing text!
 
3971
                knit_parents = None
 
3972
            if correct_parents != knit_parents:
 
3973
                wrong_parents[key] = (knit_parents, correct_parents)
 
3974
        return wrong_parents, unused_keys
 
3975
 
 
3976
 
 
3977
def _old_get_graph(repository, revision_id):
 
3978
    """DO NOT USE. That is all. I'm serious."""
 
3979
    graph = repository.get_graph()
 
3980
    revision_graph = dict(((key, value) for key, value in
 
3981
        graph.iter_ancestry([revision_id]) if value is not None))
 
3982
    return _strip_NULL_ghosts(revision_graph)
1822
3983
 
1823
3984
 
1824
3985
def _strip_NULL_ghosts(revision_graph):
1832
3993
    return revision_graph
1833
3994
 
1834
3995
 
1835
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1836
 
                    stop_revision=None):
1837
 
    """Extend the partial history to include a given index
1838
 
 
1839
 
    If a stop_index is supplied, stop when that index has been reached.
1840
 
    If a stop_revision is supplied, stop when that revision is
1841
 
    encountered.  Otherwise, stop when the beginning of history is
1842
 
    reached.
1843
 
 
1844
 
    :param stop_index: The index which should be present.  When it is
1845
 
        present, history extension will stop.
1846
 
    :param stop_revision: The revision id which should be present.  When
1847
 
        it is encountered, history extension will stop.
1848
 
    """
1849
 
    start_revision = partial_history_cache[-1]
1850
 
    graph = repo.get_graph()
1851
 
    iterator = graph.iter_lefthand_ancestry(start_revision,
1852
 
        (_mod_revision.NULL_REVISION,))
1853
 
    try:
1854
 
        # skip the last revision in the list
1855
 
        iterator.next()
1856
 
        while True:
1857
 
            if (stop_index is not None and
1858
 
                len(partial_history_cache) > stop_index):
1859
 
                break
1860
 
            if partial_history_cache[-1] == stop_revision:
1861
 
                break
1862
 
            revision_id = iterator.next()
1863
 
            partial_history_cache.append(revision_id)
1864
 
    except StopIteration:
1865
 
        # No more history
1866
 
        return
1867
 
 
1868
 
 
1869
 
class _LazyListJoin(object):
1870
 
    """An iterable yielding the contents of many lists as one list.
1871
 
 
1872
 
    Each iterator made from this will reflect the current contents of the lists
1873
 
    at the time the iterator is made.
1874
 
    
1875
 
    This is used by Repository's _make_parents_provider implementation so that
1876
 
    it is safe to do::
1877
 
 
1878
 
      pp = repo._make_parents_provider()      # uses a list of fallback repos
1879
 
      pp.add_fallback_repository(other_repo)  # appends to that list
1880
 
      result = pp.get_parent_map(...)
1881
 
      # The result will include revs from other_repo
1882
 
    """
1883
 
 
1884
 
    def __init__(self, *list_parts):
1885
 
        self.list_parts = list_parts
1886
 
 
1887
 
    def __iter__(self):
1888
 
        full_list = []
1889
 
        for list_part in self.list_parts:
1890
 
            full_list.extend(list_part)
1891
 
        return iter(full_list)
 
3996
class StreamSink(object):
 
3997
    """An object that can insert a stream into a repository.
 
3998
 
 
3999
    This interface handles the complexity of reserialising inventories and
 
4000
    revisions from different formats, and allows unidirectional insertion into
 
4001
    stacked repositories without looking for the missing basis parents
 
4002
    beforehand.
 
4003
    """
 
4004
 
 
4005
    def __init__(self, target_repo):
 
4006
        self.target_repo = target_repo
 
4007
 
 
4008
    def insert_stream(self, stream, src_format, resume_tokens):
 
4009
        """Insert a stream's content into the target repository.
 
4010
 
 
4011
        :param src_format: a bzr repository format.
 
4012
 
 
4013
        :return: a list of resume tokens and an  iterable of keys additional
 
4014
            items required before the insertion can be completed.
 
4015
        """
 
4016
        self.target_repo.lock_write()
 
4017
        try:
 
4018
            if resume_tokens:
 
4019
                self.target_repo.resume_write_group(resume_tokens)
 
4020
                is_resume = True
 
4021
            else:
 
4022
                self.target_repo.start_write_group()
 
4023
                is_resume = False
 
4024
            try:
 
4025
                # locked_insert_stream performs a commit|suspend.
 
4026
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4027
            except:
 
4028
                self.target_repo.abort_write_group(suppress_errors=True)
 
4029
                raise
 
4030
        finally:
 
4031
            self.target_repo.unlock()
 
4032
 
 
4033
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4034
        to_serializer = self.target_repo._format._serializer
 
4035
        src_serializer = src_format._serializer
 
4036
        new_pack = None
 
4037
        if to_serializer == src_serializer:
 
4038
            # If serializers match and the target is a pack repository, set the
 
4039
            # write cache size on the new pack.  This avoids poor performance
 
4040
            # on transports where append is unbuffered (such as
 
4041
            # RemoteTransport).  This is safe to do because nothing should read
 
4042
            # back from the target repository while a stream with matching
 
4043
            # serialization is being inserted.
 
4044
            # The exception is that a delta record from the source that should
 
4045
            # be a fulltext may need to be expanded by the target (see
 
4046
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
4047
            # explicitly flush any buffered writes first in that rare case.
 
4048
            try:
 
4049
                new_pack = self.target_repo._pack_collection._new_pack
 
4050
            except AttributeError:
 
4051
                # Not a pack repository
 
4052
                pass
 
4053
            else:
 
4054
                new_pack.set_write_cache_size(1024*1024)
 
4055
        for substream_type, substream in stream:
 
4056
            if substream_type == 'texts':
 
4057
                self.target_repo.texts.insert_record_stream(substream)
 
4058
            elif substream_type == 'inventories':
 
4059
                if src_serializer == to_serializer:
 
4060
                    self.target_repo.inventories.insert_record_stream(
 
4061
                        substream)
 
4062
                else:
 
4063
                    self._extract_and_insert_inventories(
 
4064
                        substream, src_serializer)
 
4065
            elif substream_type == 'chk_bytes':
 
4066
                # XXX: This doesn't support conversions, as it assumes the
 
4067
                #      conversion was done in the fetch code.
 
4068
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4069
            elif substream_type == 'revisions':
 
4070
                # This may fallback to extract-and-insert more often than
 
4071
                # required if the serializers are different only in terms of
 
4072
                # the inventory.
 
4073
                if src_serializer == to_serializer:
 
4074
                    self.target_repo.revisions.insert_record_stream(
 
4075
                        substream)
 
4076
                else:
 
4077
                    self._extract_and_insert_revisions(substream,
 
4078
                        src_serializer)
 
4079
            elif substream_type == 'signatures':
 
4080
                self.target_repo.signatures.insert_record_stream(substream)
 
4081
            else:
 
4082
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4083
        # Done inserting data, and the missing_keys calculations will try to
 
4084
        # read back from the inserted data, so flush the writes to the new pack
 
4085
        # (if this is pack format).
 
4086
        if new_pack is not None:
 
4087
            new_pack._write_data('', flush=True)
 
4088
        # Find all the new revisions (including ones from resume_tokens)
 
4089
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4090
            check_for_missing_texts=is_resume)
 
4091
        try:
 
4092
            for prefix, versioned_file in (
 
4093
                ('texts', self.target_repo.texts),
 
4094
                ('inventories', self.target_repo.inventories),
 
4095
                ('revisions', self.target_repo.revisions),
 
4096
                ('signatures', self.target_repo.signatures),
 
4097
                ('chk_bytes', self.target_repo.chk_bytes),
 
4098
                ):
 
4099
                if versioned_file is None:
 
4100
                    continue
 
4101
                missing_keys.update((prefix,) + key for key in
 
4102
                    versioned_file.get_missing_compression_parent_keys())
 
4103
        except NotImplementedError:
 
4104
            # cannot even attempt suspending, and missing would have failed
 
4105
            # during stream insertion.
 
4106
            missing_keys = set()
 
4107
        else:
 
4108
            if missing_keys:
 
4109
                # suspend the write group and tell the caller what we is
 
4110
                # missing. We know we can suspend or else we would not have
 
4111
                # entered this code path. (All repositories that can handle
 
4112
                # missing keys can handle suspending a write group).
 
4113
                write_group_tokens = self.target_repo.suspend_write_group()
 
4114
                return write_group_tokens, missing_keys
 
4115
        self.target_repo.commit_write_group()
 
4116
        return [], set()
 
4117
 
 
4118
    def _extract_and_insert_inventories(self, substream, serializer):
 
4119
        """Generate a new inventory versionedfile in target, converting data.
 
4120
 
 
4121
        The inventory is retrieved from the source, (deserializing it), and
 
4122
        stored in the target (reserializing it in a different format).
 
4123
        """
 
4124
        for record in substream:
 
4125
            bytes = record.get_bytes_as('fulltext')
 
4126
            revision_id = record.key[0]
 
4127
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4128
            parents = [key[0] for key in record.parents]
 
4129
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4130
 
 
4131
    def _extract_and_insert_revisions(self, substream, serializer):
 
4132
        for record in substream:
 
4133
            bytes = record.get_bytes_as('fulltext')
 
4134
            revision_id = record.key[0]
 
4135
            rev = serializer.read_revision_from_string(bytes)
 
4136
            if rev.revision_id != revision_id:
 
4137
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4138
            self.target_repo.add_revision(revision_id, rev)
 
4139
 
 
4140
    def finished(self):
 
4141
        if self.target_repo._format._fetch_reconcile:
 
4142
            self.target_repo.reconcile()
 
4143
 
 
4144
 
 
4145
class StreamSource(object):
 
4146
    """A source of a stream for fetching between repositories."""
 
4147
 
 
4148
    def __init__(self, from_repository, to_format):
 
4149
        """Create a StreamSource streaming from from_repository."""
 
4150
        self.from_repository = from_repository
 
4151
        self.to_format = to_format
 
4152
 
 
4153
    def delta_on_metadata(self):
 
4154
        """Return True if delta's are permitted on metadata streams.
 
4155
 
 
4156
        That is on revisions and signatures.
 
4157
        """
 
4158
        src_serializer = self.from_repository._format._serializer
 
4159
        target_serializer = self.to_format._serializer
 
4160
        return (self.to_format._fetch_uses_deltas and
 
4161
            src_serializer == target_serializer)
 
4162
 
 
4163
    def _fetch_revision_texts(self, revs):
 
4164
        # fetch signatures first and then the revision texts
 
4165
        # may need to be a InterRevisionStore call here.
 
4166
        from_sf = self.from_repository.signatures
 
4167
        # A missing signature is just skipped.
 
4168
        keys = [(rev_id,) for rev_id in revs]
 
4169
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4170
            keys,
 
4171
            self.to_format._fetch_order,
 
4172
            not self.to_format._fetch_uses_deltas))
 
4173
        # If a revision has a delta, this is actually expanded inside the
 
4174
        # insert_record_stream code now, which is an alternate fix for
 
4175
        # bug #261339
 
4176
        from_rf = self.from_repository.revisions
 
4177
        revisions = from_rf.get_record_stream(
 
4178
            keys,
 
4179
            self.to_format._fetch_order,
 
4180
            not self.delta_on_metadata())
 
4181
        return [('signatures', signatures), ('revisions', revisions)]
 
4182
 
 
4183
    def _generate_root_texts(self, revs):
 
4184
        """This will be called by __fetch between fetching weave texts and
 
4185
        fetching the inventory weave.
 
4186
 
 
4187
        Subclasses should override this if they need to generate root texts
 
4188
        after fetching weave texts.
 
4189
        """
 
4190
        if self._rich_root_upgrade():
 
4191
            import bzrlib.fetch
 
4192
            return bzrlib.fetch.Inter1and2Helper(
 
4193
                self.from_repository).generate_root_texts(revs)
 
4194
        else:
 
4195
            return []
 
4196
 
 
4197
    def get_stream(self, search):
 
4198
        phase = 'file'
 
4199
        revs = search.get_keys()
 
4200
        graph = self.from_repository.get_graph()
 
4201
        revs = list(graph.iter_topo_order(revs))
 
4202
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4203
        text_keys = []
 
4204
        for knit_kind, file_id, revisions in data_to_fetch:
 
4205
            if knit_kind != phase:
 
4206
                phase = knit_kind
 
4207
                # Make a new progress bar for this phase
 
4208
            if knit_kind == "file":
 
4209
                # Accumulate file texts
 
4210
                text_keys.extend([(file_id, revision) for revision in
 
4211
                    revisions])
 
4212
            elif knit_kind == "inventory":
 
4213
                # Now copy the file texts.
 
4214
                from_texts = self.from_repository.texts
 
4215
                yield ('texts', from_texts.get_record_stream(
 
4216
                    text_keys, self.to_format._fetch_order,
 
4217
                    not self.to_format._fetch_uses_deltas))
 
4218
                # Cause an error if a text occurs after we have done the
 
4219
                # copy.
 
4220
                text_keys = None
 
4221
                # Before we process the inventory we generate the root
 
4222
                # texts (if necessary) so that the inventories references
 
4223
                # will be valid.
 
4224
                for _ in self._generate_root_texts(revs):
 
4225
                    yield _
 
4226
                # NB: This currently reopens the inventory weave in source;
 
4227
                # using a single stream interface instead would avoid this.
 
4228
                from_weave = self.from_repository.inventories
 
4229
                # we fetch only the referenced inventories because we do not
 
4230
                # know for unselected inventories whether all their required
 
4231
                # texts are present in the other repository - it could be
 
4232
                # corrupt.
 
4233
                for info in self._get_inventory_stream(revs):
 
4234
                    yield info
 
4235
            elif knit_kind == "signatures":
 
4236
                # Nothing to do here; this will be taken care of when
 
4237
                # _fetch_revision_texts happens.
 
4238
                pass
 
4239
            elif knit_kind == "revisions":
 
4240
                for record in self._fetch_revision_texts(revs):
 
4241
                    yield record
 
4242
            else:
 
4243
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4244
 
 
4245
    def get_stream_for_missing_keys(self, missing_keys):
 
4246
        # missing keys can only occur when we are byte copying and not
 
4247
        # translating (because translation means we don't send
 
4248
        # unreconstructable deltas ever).
 
4249
        keys = {}
 
4250
        keys['texts'] = set()
 
4251
        keys['revisions'] = set()
 
4252
        keys['inventories'] = set()
 
4253
        keys['chk_bytes'] = set()
 
4254
        keys['signatures'] = set()
 
4255
        for key in missing_keys:
 
4256
            keys[key[0]].add(key[1:])
 
4257
        if len(keys['revisions']):
 
4258
            # If we allowed copying revisions at this point, we could end up
 
4259
            # copying a revision without copying its required texts: a
 
4260
            # violation of the requirements for repository integrity.
 
4261
            raise AssertionError(
 
4262
                'cannot copy revisions to fill in missing deltas %s' % (
 
4263
                    keys['revisions'],))
 
4264
        for substream_kind, keys in keys.iteritems():
 
4265
            vf = getattr(self.from_repository, substream_kind)
 
4266
            if vf is None and keys:
 
4267
                    raise AssertionError(
 
4268
                        "cannot fill in keys for a versioned file we don't"
 
4269
                        " have: %s needs %s" % (substream_kind, keys))
 
4270
            if not keys:
 
4271
                # No need to stream something we don't have
 
4272
                continue
 
4273
            # Ask for full texts always so that we don't need more round trips
 
4274
            # after this stream.
 
4275
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4276
            # records. The Sink is responsible for doing another check to
 
4277
            # ensure that ghosts don't introduce missing data for future
 
4278
            # fetches.
 
4279
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4280
                self.to_format._fetch_order, True))
 
4281
            yield substream_kind, stream
 
4282
 
 
4283
    def inventory_fetch_order(self):
 
4284
        if self._rich_root_upgrade():
 
4285
            return 'topological'
 
4286
        else:
 
4287
            return self.to_format._fetch_order
 
4288
 
 
4289
    def _rich_root_upgrade(self):
 
4290
        return (not self.from_repository._format.rich_root_data and
 
4291
            self.to_format.rich_root_data)
 
4292
 
 
4293
    def _get_inventory_stream(self, revision_ids):
 
4294
        from_format = self.from_repository._format
 
4295
        if (from_format.supports_chks and self.to_format.supports_chks
 
4296
            and (from_format._serializer == self.to_format._serializer)):
 
4297
            # Both sides support chks, and they use the same serializer, so it
 
4298
            # is safe to transmit the chk pages and inventory pages across
 
4299
            # as-is.
 
4300
            return self._get_chk_inventory_stream(revision_ids)
 
4301
        elif (not from_format.supports_chks):
 
4302
            # Source repository doesn't support chks. So we can transmit the
 
4303
            # inventories 'as-is' and either they are just accepted on the
 
4304
            # target, or the Sink will properly convert it.
 
4305
            return self._get_simple_inventory_stream(revision_ids)
 
4306
        else:
 
4307
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4308
            #      inventories. Note that this should probably be done somehow
 
4309
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4310
            #      figure out how a non-chk repository could possibly handle
 
4311
            #      deserializing an inventory stream from a chk repo, as it
 
4312
            #      doesn't have a way to understand individual pages.
 
4313
            return self._get_convertable_inventory_stream(revision_ids)
 
4314
 
 
4315
    def _get_simple_inventory_stream(self, revision_ids):
 
4316
        from_weave = self.from_repository.inventories
 
4317
        yield ('inventories', from_weave.get_record_stream(
 
4318
            [(rev_id,) for rev_id in revision_ids],
 
4319
            self.inventory_fetch_order(),
 
4320
            not self.delta_on_metadata()))
 
4321
 
 
4322
    def _get_chk_inventory_stream(self, revision_ids):
 
4323
        """Fetch the inventory texts, along with the associated chk maps."""
 
4324
        # We want an inventory outside of the search set, so that we can filter
 
4325
        # out uninteresting chk pages. For now we use
 
4326
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4327
        # could use that instead.
 
4328
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4329
                            revision_ids)
 
4330
        start_rev_key = (start_rev_id,)
 
4331
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4332
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4333
            inv_keys_to_fetch.append((start_rev_id,))
 
4334
        # Any repo that supports chk_bytes must also support out-of-order
 
4335
        # insertion. At least, that is how we expect it to work
 
4336
        # We use get_record_stream instead of iter_inventories because we want
 
4337
        # to be able to insert the stream as well. We could instead fetch
 
4338
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4339
        # source or target is more 'local' anway.
 
4340
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4341
            inv_keys_to_fetch, 'unordered',
 
4342
            True) # We need them as full-texts so we can find their references
 
4343
        uninteresting_chk_roots = set()
 
4344
        interesting_chk_roots = set()
 
4345
        def filter_inv_stream(inv_stream):
 
4346
            for idx, record in enumerate(inv_stream):
 
4347
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4348
                bytes = record.get_bytes_as('fulltext')
 
4349
                chk_inv = inventory.CHKInventory.deserialise(
 
4350
                    self.from_repository.chk_bytes, bytes, record.key)
 
4351
                if record.key == start_rev_key:
 
4352
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4353
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4354
                    if p_id_map is not None:
 
4355
                        uninteresting_chk_roots.add(p_id_map.key())
 
4356
                else:
 
4357
                    yield record
 
4358
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4359
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4360
                    if p_id_map is not None:
 
4361
                        interesting_chk_roots.add(p_id_map.key())
 
4362
        ### pb.update('fetch inventory', 0, 2)
 
4363
        yield ('inventories', filter_inv_stream(inv_stream))
 
4364
        # Now that we have worked out all of the interesting root nodes, grab
 
4365
        # all of the interesting pages and insert them
 
4366
        ### pb.update('fetch inventory', 1, 2)
 
4367
        interesting = chk_map.iter_interesting_nodes(
 
4368
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4369
            uninteresting_chk_roots)
 
4370
        def to_stream_adapter():
 
4371
            """Adapt the iter_interesting_nodes result to a single stream.
 
4372
 
 
4373
            iter_interesting_nodes returns records as it processes them, along
 
4374
            with keys. However, we only want to return the records themselves.
 
4375
            """
 
4376
            for record, items in interesting:
 
4377
                if record is not None:
 
4378
                    yield record
 
4379
        # XXX: We could instead call get_record_stream(records.keys())
 
4380
        #      ATM, this will always insert the records as fulltexts, and
 
4381
        #      requires that you can hang on to records once you have gone
 
4382
        #      on to the next one. Further, it causes the target to
 
4383
        #      recompress the data. Testing shows it to be faster than
 
4384
        #      requesting the records again, though.
 
4385
        yield ('chk_bytes', to_stream_adapter())
 
4386
        ### pb.update('fetch inventory', 2, 2)
 
4387
 
 
4388
    def _get_convertable_inventory_stream(self, revision_ids):
 
4389
        # XXX: One of source or target is using chks, and they don't have
 
4390
        #      compatible serializations. The StreamSink code expects to be
 
4391
        #      able to convert on the target, so we need to put
 
4392
        #      bytes-on-the-wire that can be converted
 
4393
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4394
 
 
4395
    def _stream_invs_as_fulltexts(self, revision_ids):
 
4396
        from_repo = self.from_repository
 
4397
        from_serializer = from_repo._format._serializer
 
4398
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4399
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4400
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4401
            # XXX: This is a bit hackish, but it works. Basically,
 
4402
            #      CHKSerializer 'accidentally' supports
 
4403
            #      read/write_inventory_to_string, even though that is never
 
4404
            #      the format that is stored on disk. It *does* give us a
 
4405
            #      single string representation for an inventory, so live with
 
4406
            #      it for now.
 
4407
            #      This would be far better if we had a 'serialized inventory
 
4408
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4409
            #      transmit that. This would both be faster to generate, and
 
4410
            #      result in fewer bytes-on-the-wire.
 
4411
            as_bytes = from_serializer.write_inventory_to_string(inv)
 
4412
            key = (inv.revision_id,)
 
4413
            parent_keys = parent_map.get(key, ())
 
4414
            yield versionedfile.FulltextContentFactory(
 
4415
                key, parent_keys, None, as_bytes)
 
4416