~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Tarmac
  • Author(s): Florent Gallaire
  • Date: 2017-03-17 12:23:47 UTC
  • mfrom: (6621.1.1 fix-gmtime-lite)
  • Revision ID: tarmac-20170317122347-2nnf3cicpgrhux3h
Fix for Windows and 32-bit platforms buggy gmtime(). [r=vila,richard-wilbur]

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
19
 
import cStringIO
20
 
import re
 
21
import itertools
21
22
import time
22
23
 
23
24
from bzrlib import (
24
 
    bzrdir,
25
 
    check,
26
 
    chk_map,
27
25
    config,
28
26
    controldir,
29
27
    debug,
30
 
    fetch as _mod_fetch,
31
 
    fifo_cache,
32
28
    generate_ids,
33
 
    gpg,
34
29
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
30
    lockable_files,
38
31
    lockdir,
39
 
    lru_cache,
40
32
    osutils,
41
 
    pyutils,
42
33
    revision as _mod_revision,
43
 
    static_tuple,
44
 
    trace,
 
34
    testament as _mod_testament,
45
35
    tsort,
46
 
    versionedfile,
 
36
    gpg,
47
37
    )
48
38
from bzrlib.bundle import serializer
49
 
from bzrlib.revisiontree import RevisionTree
50
 
from bzrlib.store.versioned import VersionedFileStore
51
 
from bzrlib.testament import Testament
 
39
from bzrlib.i18n import gettext
52
40
""")
53
41
 
54
42
from bzrlib import (
 
43
    bzrdir,
55
44
    errors,
56
45
    registry,
57
46
    symbol_versioning,
59
48
    )
60
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
61
50
from bzrlib.inter import InterObject
62
 
from bzrlib.inventory import (
63
 
    Inventory,
64
 
    InventoryDirectory,
65
 
    ROOT_ID,
66
 
    entry_factory,
67
 
    )
68
 
from bzrlib.recordcounter import RecordCounter
69
51
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
70
52
from bzrlib.trace import (
71
53
    log_exception_quietly, note, mutter, mutter_callsite, warning)
92
74
 
93
75
    # all clients should supply tree roots.
94
76
    record_root_entry = True
95
 
    # the default CommitBuilder does not manage trees whose root is versioned.
96
 
    _versioned_root = False
 
77
    # whether this commit builder supports the record_entry_contents interface
 
78
    supports_record_entry_contents = False
 
79
    # whether this commit builder will automatically update the branch that is
 
80
    # being committed to
 
81
    updates_branch = False
97
82
 
98
 
    def __init__(self, repository, parents, config, timestamp=None,
 
83
    def __init__(self, repository, parents, config_stack, timestamp=None,
99
84
                 timezone=None, committer=None, revprops=None,
100
 
                 revision_id=None):
 
85
                 revision_id=None, lossy=False):
101
86
        """Initiate a CommitBuilder.
102
87
 
103
88
        :param repository: Repository to commit to.
104
89
        :param parents: Revision ids of the parents of the new revision.
105
 
        :param config: Configuration to use.
106
90
        :param timestamp: Optional timestamp recorded for commit.
107
91
        :param timezone: Optional timezone for timestamp.
108
92
        :param committer: Optional committer to set for commit.
109
93
        :param revprops: Optional dictionary of revision properties.
110
94
        :param revision_id: Optional revision id.
 
95
        :param lossy: Whether to discard data that can not be natively
 
96
            represented, when pushing to a foreign VCS 
111
97
        """
112
 
        self._config = config
 
98
        self._config_stack = config_stack
 
99
        self._lossy = lossy
113
100
 
114
101
        if committer is None:
115
 
            self._committer = self._config.username()
 
102
            self._committer = self._config_stack.get('email')
116
103
        elif not isinstance(committer, unicode):
117
104
            self._committer = committer.decode() # throw if non-ascii
118
105
        else:
119
106
            self._committer = committer
120
107
 
121
 
        self.new_inventory = Inventory(None)
122
108
        self._new_revision_id = revision_id
123
109
        self.parents = parents
124
110
        self.repository = repository
139
125
            self._timezone = int(timezone)
140
126
 
141
127
        self._generate_revision_if_needed()
142
 
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
143
 
        self._basis_delta = []
144
 
        # API compatibility, older code that used CommitBuilder did not call
145
 
        # .record_delete(), which means the delta that is computed would not be
146
 
        # valid. Callers that will call record_delete() should call
147
 
        # .will_record_deletes() to indicate that.
148
 
        self._recording_deletes = False
149
 
        # memo'd check for no-op commits.
150
 
        self._any_changes = False
151
128
 
152
129
    def any_changes(self):
153
130
        """Return True if any entries were changed.
154
 
        
 
131
 
155
132
        This includes merge-only changes. It is the core for the --unchanged
156
133
        detection in commit.
157
134
 
158
135
        :return: True if any changes have occured.
159
136
        """
160
 
        return self._any_changes
 
137
        raise NotImplementedError(self.any_changes)
161
138
 
162
139
    def _validate_unicode_text(self, text, context):
163
140
        """Verify things like commit messages don't have bogus characters."""
174
151
            self._validate_unicode_text(value,
175
152
                                        'revision property (%s)' % (key,))
176
153
 
177
 
    def _ensure_fallback_inventories(self):
178
 
        """Ensure that appropriate inventories are available.
179
 
 
180
 
        This only applies to repositories that are stacked, and is about
181
 
        enusring the stacking invariants. Namely, that for any revision that is
182
 
        present, we either have all of the file content, or we have the parent
183
 
        inventory and the delta file content.
184
 
        """
185
 
        if not self.repository._fallback_repositories:
186
 
            return
187
 
        if not self.repository._format.supports_chks:
188
 
            raise errors.BzrError("Cannot commit directly to a stacked branch"
189
 
                " in pre-2a formats. See "
190
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
191
 
        # This is a stacked repo, we need to make sure we have the parent
192
 
        # inventories for the parents.
193
 
        parent_keys = [(p,) for p in self.parents]
194
 
        parent_map = self.repository.inventories._index.get_parent_map(parent_keys)
195
 
        missing_parent_keys = set([pk for pk in parent_keys
196
 
                                       if pk not in parent_map])
197
 
        fallback_repos = list(reversed(self.repository._fallback_repositories))
198
 
        missing_keys = [('inventories', pk[0])
199
 
                        for pk in missing_parent_keys]
200
 
        resume_tokens = []
201
 
        while missing_keys and fallback_repos:
202
 
            fallback_repo = fallback_repos.pop()
203
 
            source = fallback_repo._get_source(self.repository._format)
204
 
            sink = self.repository._get_sink()
205
 
            stream = source.get_stream_for_missing_keys(missing_keys)
206
 
            missing_keys = sink.insert_stream_without_locking(stream,
207
 
                self.repository._format)
208
 
        if missing_keys:
209
 
            raise errors.BzrError('Unable to fill in parent inventories for a'
210
 
                                  ' stacked branch')
211
 
 
212
154
    def commit(self, message):
213
155
        """Make the actual commit.
214
156
 
215
157
        :return: The revision id of the recorded revision.
216
158
        """
217
 
        self._validate_unicode_text(message, 'commit message')
218
 
        rev = _mod_revision.Revision(
219
 
                       timestamp=self._timestamp,
220
 
                       timezone=self._timezone,
221
 
                       committer=self._committer,
222
 
                       message=message,
223
 
                       inventory_sha1=self.inv_sha1,
224
 
                       revision_id=self._new_revision_id,
225
 
                       properties=self._revprops)
226
 
        rev.parent_ids = self.parents
227
 
        self.repository.add_revision(self._new_revision_id, rev,
228
 
            self.new_inventory, self._config)
229
 
        self._ensure_fallback_inventories()
230
 
        self.repository.commit_write_group()
231
 
        return self._new_revision_id
 
159
        raise NotImplementedError(self.commit)
232
160
 
233
161
    def abort(self):
234
162
        """Abort the commit that is being built.
235
163
        """
236
 
        self.repository.abort_write_group()
 
164
        raise NotImplementedError(self.abort)
237
165
 
238
166
    def revision_tree(self):
239
167
        """Return the tree that was just committed.
240
168
 
241
 
        After calling commit() this can be called to get a RevisionTree
242
 
        representing the newly committed tree. This is preferred to
243
 
        calling Repository.revision_tree() because that may require
244
 
        deserializing the inventory, while we already have a copy in
 
169
        After calling commit() this can be called to get a
 
170
        RevisionTree representing the newly committed tree. This is
 
171
        preferred to calling Repository.revision_tree() because that may
 
172
        require deserializing the inventory, while we already have a copy in
245
173
        memory.
246
174
        """
247
 
        if self.new_inventory is None:
248
 
            self.new_inventory = self.repository.get_inventory(
249
 
                self._new_revision_id)
250
 
        return RevisionTree(self.repository, self.new_inventory,
251
 
            self._new_revision_id)
 
175
        raise NotImplementedError(self.revision_tree)
252
176
 
253
177
    def finish_inventory(self):
254
178
        """Tell the builder that the inventory is finished.
256
180
        :return: The inventory id in the repository, which can be used with
257
181
            repository.get_inventory.
258
182
        """
259
 
        if self.new_inventory is None:
260
 
            # an inventory delta was accumulated without creating a new
261
 
            # inventory.
262
 
            basis_id = self.basis_delta_revision
263
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
264
 
            # because self.new_inventory is used to hint to the rest of the
265
 
            # system what code path was taken
266
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
267
 
                basis_id, self._basis_delta, self._new_revision_id,
268
 
                self.parents)
269
 
        else:
270
 
            if self.new_inventory.root is None:
271
 
                raise AssertionError('Root entry should be supplied to'
272
 
                    ' record_entry_contents, as of bzr 0.10.')
273
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
274
 
            self.new_inventory.revision_id = self._new_revision_id
275
 
            self.inv_sha1 = self.repository.add_inventory(
276
 
                self._new_revision_id,
277
 
                self.new_inventory,
278
 
                self.parents
279
 
                )
280
 
        return self._new_revision_id
 
183
        raise NotImplementedError(self.finish_inventory)
281
184
 
282
185
    def _gen_revision_id(self):
283
186
        """Return new revision-id."""
298
201
        else:
299
202
            self.random_revid = False
300
203
 
301
 
    def _heads(self, file_id, revision_ids):
302
 
        """Calculate the graph heads for revision_ids in the graph of file_id.
303
 
 
304
 
        This can use either a per-file graph or a global revision graph as we
305
 
        have an identity relationship between the two graphs.
306
 
        """
307
 
        return self.__heads(revision_ids)
308
 
 
309
 
    def _check_root(self, ie, parent_invs, tree):
310
 
        """Helper for record_entry_contents.
311
 
 
312
 
        :param ie: An entry being added.
313
 
        :param parent_invs: The inventories of the parent revisions of the
314
 
            commit.
315
 
        :param tree: The tree that is being committed.
316
 
        """
317
 
        # In this revision format, root entries have no knit or weave When
318
 
        # serializing out to disk and back in root.revision is always
319
 
        # _new_revision_id
320
 
        ie.revision = self._new_revision_id
321
 
 
322
 
    def _require_root_change(self, tree):
323
 
        """Enforce an appropriate root object change.
324
 
 
325
 
        This is called once when record_iter_changes is called, if and only if
326
 
        the root was not in the delta calculated by record_iter_changes.
327
 
 
328
 
        :param tree: The tree which is being committed.
329
 
        """
330
 
        if len(self.parents) == 0:
331
 
            raise errors.RootMissing()
332
 
        entry = entry_factory['directory'](tree.path2id(''), '',
333
 
            None)
334
 
        entry.revision = self._new_revision_id
335
 
        self._basis_delta.append(('', '', entry.file_id, entry))
336
 
 
337
 
    def _get_delta(self, ie, basis_inv, path):
338
 
        """Get a delta against the basis inventory for ie."""
339
 
        if ie.file_id not in basis_inv:
340
 
            # add
341
 
            result = (None, path, ie.file_id, ie)
342
 
            self._basis_delta.append(result)
343
 
            return result
344
 
        elif ie != basis_inv[ie.file_id]:
345
 
            # common but altered
346
 
            # TODO: avoid tis id2path call.
347
 
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
348
 
            self._basis_delta.append(result)
349
 
            return result
350
 
        else:
351
 
            # common, unaltered
352
 
            return None
353
 
 
354
 
    def get_basis_delta(self):
355
 
        """Return the complete inventory delta versus the basis inventory.
356
 
 
357
 
        This has been built up with the calls to record_delete and
358
 
        record_entry_contents. The client must have already called
359
 
        will_record_deletes() to indicate that they will be generating a
360
 
        complete delta.
361
 
 
362
 
        :return: An inventory delta, suitable for use with apply_delta, or
363
 
            Repository.add_inventory_by_delta, etc.
364
 
        """
365
 
        if not self._recording_deletes:
366
 
            raise AssertionError("recording deletes not activated.")
367
 
        return self._basis_delta
368
 
 
369
 
    def record_delete(self, path, file_id):
370
 
        """Record that a delete occured against a basis tree.
371
 
 
372
 
        This is an optional API - when used it adds items to the basis_delta
373
 
        being accumulated by the commit builder. It cannot be called unless the
374
 
        method will_record_deletes() has been called to inform the builder that
375
 
        a delta is being supplied.
376
 
 
377
 
        :param path: The path of the thing deleted.
378
 
        :param file_id: The file id that was deleted.
379
 
        """
380
 
        if not self._recording_deletes:
381
 
            raise AssertionError("recording deletes not activated.")
382
 
        delta = (path, None, file_id, None)
383
 
        self._basis_delta.append(delta)
384
 
        self._any_changes = True
385
 
        return delta
386
 
 
387
204
    def will_record_deletes(self):
388
205
        """Tell the commit builder that deletes are being notified.
389
206
 
391
208
        commit to be valid, deletes against the basis MUST be recorded via
392
209
        builder.record_delete().
393
210
        """
394
 
        self._recording_deletes = True
395
 
        try:
396
 
            basis_id = self.parents[0]
397
 
        except IndexError:
398
 
            basis_id = _mod_revision.NULL_REVISION
399
 
        self.basis_delta_revision = basis_id
400
 
 
401
 
    def record_entry_contents(self, ie, parent_invs, path, tree,
402
 
        content_summary):
403
 
        """Record the content of ie from tree into the commit if needed.
404
 
 
405
 
        Side effect: sets ie.revision when unchanged
406
 
 
407
 
        :param ie: An inventory entry present in the commit.
408
 
        :param parent_invs: The inventories of the parent revisions of the
409
 
            commit.
410
 
        :param path: The path the entry is at in the tree.
411
 
        :param tree: The tree which contains this entry and should be used to
412
 
            obtain content.
413
 
        :param content_summary: Summary data from the tree about the paths
414
 
            content - stat, length, exec, sha/link target. This is only
415
 
            accessed when the entry has a revision of None - that is when it is
416
 
            a candidate to commit.
417
 
        :return: A tuple (change_delta, version_recorded, fs_hash).
418
 
            change_delta is an inventory_delta change for this entry against
419
 
            the basis tree of the commit, or None if no change occured against
420
 
            the basis tree.
421
 
            version_recorded is True if a new version of the entry has been
422
 
            recorded. For instance, committing a merge where a file was only
423
 
            changed on the other side will return (delta, False).
424
 
            fs_hash is either None, or the hash details for the path (currently
425
 
            a tuple of the contents sha1 and the statvalue returned by
426
 
            tree.get_file_with_stat()).
427
 
        """
428
 
        if self.new_inventory.root is None:
429
 
            if ie.parent_id is not None:
430
 
                raise errors.RootMissing()
431
 
            self._check_root(ie, parent_invs, tree)
432
 
        if ie.revision is None:
433
 
            kind = content_summary[0]
434
 
        else:
435
 
            # ie is carried over from a prior commit
436
 
            kind = ie.kind
437
 
        # XXX: repository specific check for nested tree support goes here - if
438
 
        # the repo doesn't want nested trees we skip it ?
439
 
        if (kind == 'tree-reference' and
440
 
            not self.repository._format.supports_tree_reference):
441
 
            # mismatch between commit builder logic and repository:
442
 
            # this needs the entry creation pushed down into the builder.
443
 
            raise NotImplementedError('Missing repository subtree support.')
444
 
        self.new_inventory.add(ie)
445
 
 
446
 
        # TODO: slow, take it out of the inner loop.
447
 
        try:
448
 
            basis_inv = parent_invs[0]
449
 
        except IndexError:
450
 
            basis_inv = Inventory(root_id=None)
451
 
 
452
 
        # ie.revision is always None if the InventoryEntry is considered
453
 
        # for committing. We may record the previous parents revision if the
454
 
        # content is actually unchanged against a sole head.
455
 
        if ie.revision is not None:
456
 
            if not self._versioned_root and path == '':
457
 
                # repositories that do not version the root set the root's
458
 
                # revision to the new commit even when no change occurs (more
459
 
                # specifically, they do not record a revision on the root; and
460
 
                # the rev id is assigned to the root during deserialisation -
461
 
                # this masks when a change may have occurred against the basis.
462
 
                # To match this we always issue a delta, because the revision
463
 
                # of the root will always be changing.
464
 
                if ie.file_id in basis_inv:
465
 
                    delta = (basis_inv.id2path(ie.file_id), path,
466
 
                        ie.file_id, ie)
467
 
                else:
468
 
                    # add
469
 
                    delta = (None, path, ie.file_id, ie)
470
 
                self._basis_delta.append(delta)
471
 
                return delta, False, None
472
 
            else:
473
 
                # we don't need to commit this, because the caller already
474
 
                # determined that an existing revision of this file is
475
 
                # appropriate. If it's not being considered for committing then
476
 
                # it and all its parents to the root must be unaltered so
477
 
                # no-change against the basis.
478
 
                if ie.revision == self._new_revision_id:
479
 
                    raise AssertionError("Impossible situation, a skipped "
480
 
                        "inventory entry (%r) claims to be modified in this "
481
 
                        "commit (%r).", (ie, self._new_revision_id))
482
 
                return None, False, None
483
 
        # XXX: Friction: parent_candidates should return a list not a dict
484
 
        #      so that we don't have to walk the inventories again.
485
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
486
 
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
487
 
        heads = []
488
 
        for inv in parent_invs:
489
 
            if ie.file_id in inv:
490
 
                old_rev = inv[ie.file_id].revision
491
 
                if old_rev in head_set:
492
 
                    heads.append(inv[ie.file_id].revision)
493
 
                    head_set.remove(inv[ie.file_id].revision)
494
 
 
495
 
        store = False
496
 
        # now we check to see if we need to write a new record to the
497
 
        # file-graph.
498
 
        # We write a new entry unless there is one head to the ancestors, and
499
 
        # the kind-derived content is unchanged.
500
 
 
501
 
        # Cheapest check first: no ancestors, or more the one head in the
502
 
        # ancestors, we write a new node.
503
 
        if len(heads) != 1:
504
 
            store = True
505
 
        if not store:
506
 
            # There is a single head, look it up for comparison
507
 
            parent_entry = parent_candiate_entries[heads[0]]
508
 
            # if the non-content specific data has changed, we'll be writing a
509
 
            # node:
510
 
            if (parent_entry.parent_id != ie.parent_id or
511
 
                parent_entry.name != ie.name):
512
 
                store = True
513
 
        # now we need to do content specific checks:
514
 
        if not store:
515
 
            # if the kind changed the content obviously has
516
 
            if kind != parent_entry.kind:
517
 
                store = True
518
 
        # Stat cache fingerprint feedback for the caller - None as we usually
519
 
        # don't generate one.
520
 
        fingerprint = None
521
 
        if kind == 'file':
522
 
            if content_summary[2] is None:
523
 
                raise ValueError("Files must not have executable = None")
524
 
            if not store:
525
 
                # We can't trust a check of the file length because of content
526
 
                # filtering...
527
 
                if (# if the exec bit has changed we have to store:
528
 
                    parent_entry.executable != content_summary[2]):
529
 
                    store = True
530
 
                elif parent_entry.text_sha1 == content_summary[3]:
531
 
                    # all meta and content is unchanged (using a hash cache
532
 
                    # hit to check the sha)
533
 
                    ie.revision = parent_entry.revision
534
 
                    ie.text_size = parent_entry.text_size
535
 
                    ie.text_sha1 = parent_entry.text_sha1
536
 
                    ie.executable = parent_entry.executable
537
 
                    return self._get_delta(ie, basis_inv, path), False, None
538
 
                else:
539
 
                    # Either there is only a hash change(no hash cache entry,
540
 
                    # or same size content change), or there is no change on
541
 
                    # this file at all.
542
 
                    # Provide the parent's hash to the store layer, so that the
543
 
                    # content is unchanged we will not store a new node.
544
 
                    nostore_sha = parent_entry.text_sha1
545
 
            if store:
546
 
                # We want to record a new node regardless of the presence or
547
 
                # absence of a content change in the file.
548
 
                nostore_sha = None
549
 
            ie.executable = content_summary[2]
550
 
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
551
 
            try:
552
 
                text = file_obj.read()
553
 
            finally:
554
 
                file_obj.close()
555
 
            try:
556
 
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
557
 
                    ie.file_id, text, heads, nostore_sha)
558
 
                # Let the caller know we generated a stat fingerprint.
559
 
                fingerprint = (ie.text_sha1, stat_value)
560
 
            except errors.ExistingContent:
561
 
                # Turns out that the file content was unchanged, and we were
562
 
                # only going to store a new node if it was changed. Carry over
563
 
                # the entry.
564
 
                ie.revision = parent_entry.revision
565
 
                ie.text_size = parent_entry.text_size
566
 
                ie.text_sha1 = parent_entry.text_sha1
567
 
                ie.executable = parent_entry.executable
568
 
                return self._get_delta(ie, basis_inv, path), False, None
569
 
        elif kind == 'directory':
570
 
            if not store:
571
 
                # all data is meta here, nothing specific to directory, so
572
 
                # carry over:
573
 
                ie.revision = parent_entry.revision
574
 
                return self._get_delta(ie, basis_inv, path), False, None
575
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
576
 
        elif kind == 'symlink':
577
 
            current_link_target = content_summary[3]
578
 
            if not store:
579
 
                # symlink target is not generic metadata, check if it has
580
 
                # changed.
581
 
                if current_link_target != parent_entry.symlink_target:
582
 
                    store = True
583
 
            if not store:
584
 
                # unchanged, carry over.
585
 
                ie.revision = parent_entry.revision
586
 
                ie.symlink_target = parent_entry.symlink_target
587
 
                return self._get_delta(ie, basis_inv, path), False, None
588
 
            ie.symlink_target = current_link_target
589
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
590
 
        elif kind == 'tree-reference':
591
 
            if not store:
592
 
                if content_summary[3] != parent_entry.reference_revision:
593
 
                    store = True
594
 
            if not store:
595
 
                # unchanged, carry over.
596
 
                ie.reference_revision = parent_entry.reference_revision
597
 
                ie.revision = parent_entry.revision
598
 
                return self._get_delta(ie, basis_inv, path), False, None
599
 
            ie.reference_revision = content_summary[3]
600
 
            if ie.reference_revision is None:
601
 
                raise AssertionError("invalid content_summary for nested tree: %r"
602
 
                    % (content_summary,))
603
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
604
 
        else:
605
 
            raise NotImplementedError('unknown kind')
606
 
        ie.revision = self._new_revision_id
607
 
        self._any_changes = True
608
 
        return self._get_delta(ie, basis_inv, path), True, fingerprint
609
 
 
610
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
611
 
        _entry_factory=entry_factory):
 
211
        raise NotImplementedError(self.will_record_deletes)
 
212
 
 
213
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
612
214
        """Record a new tree via iter_changes.
613
215
 
614
216
        :param tree: The tree to obtain text contents from for changed objects.
619
221
            to basis_revision_id. The iterator must not include any items with
620
222
            a current kind of None - missing items must be either filtered out
621
223
            or errored-on beefore record_iter_changes sees the item.
622
 
        :param _entry_factory: Private method to bind entry_factory locally for
623
 
            performance.
624
224
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
625
225
            tree._observed_sha1.
626
226
        """
627
 
        # Create an inventory delta based on deltas between all the parents and
628
 
        # deltas between all the parent inventories. We use inventory delta's 
629
 
        # between the inventory objects because iter_changes masks
630
 
        # last-changed-field only changes.
631
 
        # Working data:
632
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
633
 
        # parents, names, kinds, executables
634
 
        merged_ids = {}
635
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
636
 
        # trees that are not parents[0]
637
 
        parent_entries = {}
638
 
        ghost_basis = False
639
 
        try:
640
 
            revtrees = list(self.repository.revision_trees(self.parents))
641
 
        except errors.NoSuchRevision:
642
 
            # one or more ghosts, slow path.
643
 
            revtrees = []
644
 
            for revision_id in self.parents:
645
 
                try:
646
 
                    revtrees.append(self.repository.revision_tree(revision_id))
647
 
                except errors.NoSuchRevision:
648
 
                    if not revtrees:
649
 
                        basis_revision_id = _mod_revision.NULL_REVISION
650
 
                        ghost_basis = True
651
 
                    revtrees.append(self.repository.revision_tree(
652
 
                        _mod_revision.NULL_REVISION))
653
 
        # The basis inventory from a repository 
654
 
        if revtrees:
655
 
            basis_inv = revtrees[0].inventory
656
 
        else:
657
 
            basis_inv = self.repository.revision_tree(
658
 
                _mod_revision.NULL_REVISION).inventory
659
 
        if len(self.parents) > 0:
660
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
661
 
                raise Exception(
662
 
                    "arbitrary basis parents not yet supported with merges")
663
 
            for revtree in revtrees[1:]:
664
 
                for change in revtree.inventory._make_delta(basis_inv):
665
 
                    if change[1] is None:
666
 
                        # Not present in this parent.
667
 
                        continue
668
 
                    if change[2] not in merged_ids:
669
 
                        if change[0] is not None:
670
 
                            basis_entry = basis_inv[change[2]]
671
 
                            merged_ids[change[2]] = [
672
 
                                # basis revid
673
 
                                basis_entry.revision,
674
 
                                # new tree revid
675
 
                                change[3].revision]
676
 
                            parent_entries[change[2]] = {
677
 
                                # basis parent
678
 
                                basis_entry.revision:basis_entry,
679
 
                                # this parent 
680
 
                                change[3].revision:change[3],
681
 
                                }
682
 
                        else:
683
 
                            merged_ids[change[2]] = [change[3].revision]
684
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
685
 
                    else:
686
 
                        merged_ids[change[2]].append(change[3].revision)
687
 
                        parent_entries[change[2]][change[3].revision] = change[3]
688
 
        else:
689
 
            merged_ids = {}
690
 
        # Setup the changes from the tree:
691
 
        # changes maps file_id -> (change, [parent revision_ids])
692
 
        changes= {}
693
 
        for change in iter_changes:
694
 
            # This probably looks up in basis_inv way to much.
695
 
            if change[1][0] is not None:
696
 
                head_candidate = [basis_inv[change[0]].revision]
697
 
            else:
698
 
                head_candidate = []
699
 
            changes[change[0]] = change, merged_ids.get(change[0],
700
 
                head_candidate)
701
 
        unchanged_merged = set(merged_ids) - set(changes)
702
 
        # Extend the changes dict with synthetic changes to record merges of
703
 
        # texts.
704
 
        for file_id in unchanged_merged:
705
 
            # Record a merged version of these items that did not change vs the
706
 
            # basis. This can be either identical parallel changes, or a revert
707
 
            # of a specific file after a merge. The recorded content will be
708
 
            # that of the current tree (which is the same as the basis), but
709
 
            # the per-file graph will reflect a merge.
710
 
            # NB:XXX: We are reconstructing path information we had, this
711
 
            # should be preserved instead.
712
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
713
 
            #   changed_content, versioned, parent, name, kind,
714
 
            #   executable)
715
 
            try:
716
 
                basis_entry = basis_inv[file_id]
717
 
            except errors.NoSuchId:
718
 
                # a change from basis->some_parents but file_id isn't in basis
719
 
                # so was new in the merge, which means it must have changed
720
 
                # from basis -> current, and as it hasn't the add was reverted
721
 
                # by the user. So we discard this change.
722
 
                pass
723
 
            else:
724
 
                change = (file_id,
725
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
726
 
                    False, (True, True),
727
 
                    (basis_entry.parent_id, basis_entry.parent_id),
728
 
                    (basis_entry.name, basis_entry.name),
729
 
                    (basis_entry.kind, basis_entry.kind),
730
 
                    (basis_entry.executable, basis_entry.executable))
731
 
                changes[file_id] = (change, merged_ids[file_id])
732
 
        # changes contains tuples with the change and a set of inventory
733
 
        # candidates for the file.
734
 
        # inv delta is:
735
 
        # old_path, new_path, file_id, new_inventory_entry
736
 
        seen_root = False # Is the root in the basis delta?
737
 
        inv_delta = self._basis_delta
738
 
        modified_rev = self._new_revision_id
739
 
        for change, head_candidates in changes.values():
740
 
            if change[3][1]: # versioned in target.
741
 
                # Several things may be happening here:
742
 
                # We may have a fork in the per-file graph
743
 
                #  - record a change with the content from tree
744
 
                # We may have a change against < all trees  
745
 
                #  - carry over the tree that hasn't changed
746
 
                # We may have a change against all trees
747
 
                #  - record the change with the content from tree
748
 
                kind = change[6][1]
749
 
                file_id = change[0]
750
 
                entry = _entry_factory[kind](file_id, change[5][1],
751
 
                    change[4][1])
752
 
                head_set = self._heads(change[0], set(head_candidates))
753
 
                heads = []
754
 
                # Preserve ordering.
755
 
                for head_candidate in head_candidates:
756
 
                    if head_candidate in head_set:
757
 
                        heads.append(head_candidate)
758
 
                        head_set.remove(head_candidate)
759
 
                carried_over = False
760
 
                if len(heads) == 1:
761
 
                    # Could be a carry-over situation:
762
 
                    parent_entry_revs = parent_entries.get(file_id, None)
763
 
                    if parent_entry_revs:
764
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
765
 
                    else:
766
 
                        parent_entry = None
767
 
                    if parent_entry is None:
768
 
                        # The parent iter_changes was called against is the one
769
 
                        # that is the per-file head, so any change is relevant
770
 
                        # iter_changes is valid.
771
 
                        carry_over_possible = False
772
 
                    else:
773
 
                        # could be a carry over situation
774
 
                        # A change against the basis may just indicate a merge,
775
 
                        # we need to check the content against the source of the
776
 
                        # merge to determine if it was changed after the merge
777
 
                        # or carried over.
778
 
                        if (parent_entry.kind != entry.kind or
779
 
                            parent_entry.parent_id != entry.parent_id or
780
 
                            parent_entry.name != entry.name):
781
 
                            # Metadata common to all entries has changed
782
 
                            # against per-file parent
783
 
                            carry_over_possible = False
784
 
                        else:
785
 
                            carry_over_possible = True
786
 
                        # per-type checks for changes against the parent_entry
787
 
                        # are done below.
788
 
                else:
789
 
                    # Cannot be a carry-over situation
790
 
                    carry_over_possible = False
791
 
                # Populate the entry in the delta
792
 
                if kind == 'file':
793
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
794
 
                    # after iter_changes examines and decides it has changed,
795
 
                    # we will unconditionally record a new version even if some
796
 
                    # other process reverts it while commit is running (with
797
 
                    # the revert happening after iter_changes did its
798
 
                    # examination).
799
 
                    if change[7][1]:
800
 
                        entry.executable = True
801
 
                    else:
802
 
                        entry.executable = False
803
 
                    if (carry_over_possible and
804
 
                        parent_entry.executable == entry.executable):
805
 
                            # Check the file length, content hash after reading
806
 
                            # the file.
807
 
                            nostore_sha = parent_entry.text_sha1
808
 
                    else:
809
 
                        nostore_sha = None
810
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
811
 
                    try:
812
 
                        text = file_obj.read()
813
 
                    finally:
814
 
                        file_obj.close()
815
 
                    try:
816
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
817
 
                            file_id, text, heads, nostore_sha)
818
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
819
 
                    except errors.ExistingContent:
820
 
                        # No content change against a carry_over parent
821
 
                        # Perhaps this should also yield a fs hash update?
822
 
                        carried_over = True
823
 
                        entry.text_size = parent_entry.text_size
824
 
                        entry.text_sha1 = parent_entry.text_sha1
825
 
                elif kind == 'symlink':
826
 
                    # Wants a path hint?
827
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
828
 
                    if (carry_over_possible and
829
 
                        parent_entry.symlink_target == entry.symlink_target):
830
 
                        carried_over = True
831
 
                    else:
832
 
                        self._add_text_to_weave(change[0], '', heads, None)
833
 
                elif kind == 'directory':
834
 
                    if carry_over_possible:
835
 
                        carried_over = True
836
 
                    else:
837
 
                        # Nothing to set on the entry.
838
 
                        # XXX: split into the Root and nonRoot versions.
839
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
840
 
                            self._add_text_to_weave(change[0], '', heads, None)
841
 
                elif kind == 'tree-reference':
842
 
                    if not self.repository._format.supports_tree_reference:
843
 
                        # This isn't quite sane as an error, but we shouldn't
844
 
                        # ever see this code path in practice: tree's don't
845
 
                        # permit references when the repo doesn't support tree
846
 
                        # references.
847
 
                        raise errors.UnsupportedOperation(tree.add_reference,
848
 
                            self.repository)
849
 
                    reference_revision = tree.get_reference_revision(change[0])
850
 
                    entry.reference_revision = reference_revision
851
 
                    if (carry_over_possible and
852
 
                        parent_entry.reference_revision == reference_revision):
853
 
                        carried_over = True
854
 
                    else:
855
 
                        self._add_text_to_weave(change[0], '', heads, None)
856
 
                else:
857
 
                    raise AssertionError('unknown kind %r' % kind)
858
 
                if not carried_over:
859
 
                    entry.revision = modified_rev
860
 
                else:
861
 
                    entry.revision = parent_entry.revision
862
 
            else:
863
 
                entry = None
864
 
            new_path = change[1][1]
865
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
866
 
            if new_path == '':
867
 
                seen_root = True
868
 
        self.new_inventory = None
869
 
        if len(inv_delta):
870
 
            # This should perhaps be guarded by a check that the basis we
871
 
            # commit against is the basis for the commit and if not do a delta
872
 
            # against the basis.
873
 
            self._any_changes = True
874
 
        if not seen_root:
875
 
            # housekeeping root entry changes do not affect no-change commits.
876
 
            self._require_root_change(tree)
877
 
        self.basis_delta_revision = basis_revision_id
878
 
 
879
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
880
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
881
 
        return self.repository.texts._add_text(
882
 
            (file_id, self._new_revision_id), parent_keys, new_text,
883
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
884
 
 
885
 
 
886
 
class RootCommitBuilder(CommitBuilder):
887
 
    """This commitbuilder actually records the root id"""
888
 
 
889
 
    # the root entry gets versioned properly by this builder.
890
 
    _versioned_root = True
891
 
 
892
 
    def _check_root(self, ie, parent_invs, tree):
893
 
        """Helper for record_entry_contents.
894
 
 
895
 
        :param ie: An entry being added.
896
 
        :param parent_invs: The inventories of the parent revisions of the
897
 
            commit.
898
 
        :param tree: The tree that is being committed.
899
 
        """
900
 
 
901
 
    def _require_root_change(self, tree):
902
 
        """Enforce an appropriate root object change.
903
 
 
904
 
        This is called once when record_iter_changes is called, if and only if
905
 
        the root was not in the delta calculated by record_iter_changes.
906
 
 
907
 
        :param tree: The tree which is being committed.
908
 
        """
909
 
        # versioned roots do not change unless the tree found a change.
 
227
        raise NotImplementedError(self.record_iter_changes)
910
228
 
911
229
 
912
230
class RepositoryWriteLockResult(LogicalLockResult):
937
255
    revisions and file history.  It's normally accessed only by the Branch,
938
256
    which views a particular line of development through that history.
939
257
 
940
 
    The Repository builds on top of some byte storage facilies (the revisions,
941
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
942
 
    which respectively provide byte storage and a means to access the (possibly
943
 
    remote) disk.
944
 
 
945
 
    The byte storage facilities are addressed via tuples, which we refer to
946
 
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
947
 
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
948
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
949
 
    byte string made up of a hash identifier and a hash value.
950
 
    We use this interface because it allows low friction with the underlying
951
 
    code that implements disk indices, network encoding and other parts of
952
 
    bzrlib.
953
 
 
954
 
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
955
 
        the serialised revisions for the repository. This can be used to obtain
956
 
        revision graph information or to access raw serialised revisions.
957
 
        The result of trying to insert data into the repository via this store
958
 
        is undefined: it should be considered read-only except for implementors
959
 
        of repositories.
960
 
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
961
 
        the serialised signatures for the repository. This can be used to
962
 
        obtain access to raw serialised signatures.  The result of trying to
963
 
        insert data into the repository via this store is undefined: it should
964
 
        be considered read-only except for implementors of repositories.
965
 
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
966
 
        the serialised inventories for the repository. This can be used to
967
 
        obtain unserialised inventories.  The result of trying to insert data
968
 
        into the repository via this store is undefined: it should be
969
 
        considered read-only except for implementors of repositories.
970
 
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
971
 
        texts of files and directories for the repository. This can be used to
972
 
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
973
 
        is usually a better interface for accessing file texts.
974
 
        The result of trying to insert data into the repository via this store
975
 
        is undefined: it should be considered read-only except for implementors
976
 
        of repositories.
977
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
978
 
        any data the repository chooses to store or have indexed by its hash.
979
 
        The result of trying to insert data into the repository via this store
980
 
        is undefined: it should be considered read-only except for implementors
981
 
        of repositories.
982
 
    :ivar _transport: Transport for file access to repository, typically
983
 
        pointing to .bzr/repository.
 
258
    See VersionedFileRepository in bzrlib.vf_repository for the
 
259
    base class for most Bazaar repositories.
984
260
    """
985
261
 
986
 
    # What class to use for a CommitBuilder. Often it's simpler to change this
987
 
    # in a Repository class subclass rather than to override
988
 
    # get_commit_builder.
989
 
    _commit_builder_class = CommitBuilder
990
 
 
991
262
    def abort_write_group(self, suppress_errors=False):
992
263
        """Commit the contents accrued within the current write group.
993
264
 
1015
286
                raise
1016
287
            mutter('abort_write_group failed')
1017
288
            log_exception_quietly()
1018
 
            note('bzr: ERROR (ignored): %s', exc)
 
289
            note(gettext('bzr: ERROR (ignored): %s'), exc)
1019
290
        self._write_group = None
1020
291
 
1021
292
    def _abort_write_group(self):
1036
307
 
1037
308
        :param repository: A repository.
1038
309
        """
1039
 
        if not self._format.supports_external_lookups:
1040
 
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1041
 
        if self.is_locked():
1042
 
            # This repository will call fallback.unlock() when we transition to
1043
 
            # the unlocked state, so we make sure to increment the lock count
1044
 
            repository.lock_read()
1045
 
        self._check_fallback_repository(repository)
1046
 
        self._fallback_repositories.append(repository)
1047
 
        self.texts.add_fallback_versioned_files(repository.texts)
1048
 
        self.inventories.add_fallback_versioned_files(repository.inventories)
1049
 
        self.revisions.add_fallback_versioned_files(repository.revisions)
1050
 
        self.signatures.add_fallback_versioned_files(repository.signatures)
1051
 
        if self.chk_bytes is not None:
1052
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
 
310
        raise NotImplementedError(self.add_fallback_repository)
1053
311
 
1054
312
    def _check_fallback_repository(self, repository):
1055
313
        """Check that this repository can fallback to repository safely.
1060
318
        """
1061
319
        return InterRepository._assert_same_model(self, repository)
1062
320
 
1063
 
    def add_inventory(self, revision_id, inv, parents):
1064
 
        """Add the inventory inv to the repository as revision_id.
1065
 
 
1066
 
        :param parents: The revision ids of the parents that revision_id
1067
 
                        is known to have and are in the repository already.
1068
 
 
1069
 
        :returns: The validator(which is a sha1 digest, though what is sha'd is
1070
 
            repository format specific) of the serialized inventory.
1071
 
        """
1072
 
        if not self.is_in_write_group():
1073
 
            raise AssertionError("%r not in write group" % (self,))
1074
 
        _mod_revision.check_not_reserved_id(revision_id)
1075
 
        if not (inv.revision_id is None or inv.revision_id == revision_id):
1076
 
            raise AssertionError(
1077
 
                "Mismatch between inventory revision"
1078
 
                " id and insertion revid (%r, %r)"
1079
 
                % (inv.revision_id, revision_id))
1080
 
        if inv.root is None:
1081
 
            raise errors.RootMissing()
1082
 
        return self._add_inventory_checked(revision_id, inv, parents)
1083
 
 
1084
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1085
 
        """Add inv to the repository after checking the inputs.
1086
 
 
1087
 
        This function can be overridden to allow different inventory styles.
1088
 
 
1089
 
        :seealso: add_inventory, for the contract.
1090
 
        """
1091
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
1092
 
        return self._inventory_add_lines(revision_id, parents,
1093
 
            inv_lines, check_content=False)
1094
 
 
1095
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1096
 
                               parents, basis_inv=None, propagate_caches=False):
1097
 
        """Add a new inventory expressed as a delta against another revision.
1098
 
 
1099
 
        See the inventory developers documentation for the theory behind
1100
 
        inventory deltas.
1101
 
 
1102
 
        :param basis_revision_id: The inventory id the delta was created
1103
 
            against. (This does not have to be a direct parent.)
1104
 
        :param delta: The inventory delta (see Inventory.apply_delta for
1105
 
            details).
1106
 
        :param new_revision_id: The revision id that the inventory is being
1107
 
            added for.
1108
 
        :param parents: The revision ids of the parents that revision_id is
1109
 
            known to have and are in the repository already. These are supplied
1110
 
            for repositories that depend on the inventory graph for revision
1111
 
            graph access, as well as for those that pun ancestry with delta
1112
 
            compression.
1113
 
        :param basis_inv: The basis inventory if it is already known,
1114
 
            otherwise None.
1115
 
        :param propagate_caches: If True, the caches for this inventory are
1116
 
          copied to and updated for the result if possible.
1117
 
 
1118
 
        :returns: (validator, new_inv)
1119
 
            The validator(which is a sha1 digest, though what is sha'd is
1120
 
            repository format specific) of the serialized inventory, and the
1121
 
            resulting inventory.
1122
 
        """
1123
 
        if not self.is_in_write_group():
1124
 
            raise AssertionError("%r not in write group" % (self,))
1125
 
        _mod_revision.check_not_reserved_id(new_revision_id)
1126
 
        basis_tree = self.revision_tree(basis_revision_id)
1127
 
        basis_tree.lock_read()
1128
 
        try:
1129
 
            # Note that this mutates the inventory of basis_tree, which not all
1130
 
            # inventory implementations may support: A better idiom would be to
1131
 
            # return a new inventory, but as there is no revision tree cache in
1132
 
            # repository this is safe for now - RBC 20081013
1133
 
            if basis_inv is None:
1134
 
                basis_inv = basis_tree.inventory
1135
 
            basis_inv.apply_delta(delta)
1136
 
            basis_inv.revision_id = new_revision_id
1137
 
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1138
 
                    basis_inv)
1139
 
        finally:
1140
 
            basis_tree.unlock()
1141
 
 
1142
 
    def _inventory_add_lines(self, revision_id, parents, lines,
1143
 
        check_content=True):
1144
 
        """Store lines in inv_vf and return the sha1 of the inventory."""
1145
 
        parents = [(parent,) for parent in parents]
1146
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
1147
 
            check_content=check_content)[0]
1148
 
        self.inventories._access.flush()
1149
 
        return result
1150
 
 
1151
 
    def add_revision(self, revision_id, rev, inv=None, config=None):
1152
 
        """Add rev to the revision store as revision_id.
1153
 
 
1154
 
        :param revision_id: the revision id to use.
1155
 
        :param rev: The revision object.
1156
 
        :param inv: The inventory for the revision. if None, it will be looked
1157
 
                    up in the inventory storer
1158
 
        :param config: If None no digital signature will be created.
1159
 
                       If supplied its signature_needed method will be used
1160
 
                       to determine if a signature should be made.
1161
 
        """
1162
 
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
1163
 
        #       rev.parent_ids?
1164
 
        _mod_revision.check_not_reserved_id(revision_id)
1165
 
        if config is not None and config.signature_needed():
1166
 
            if inv is None:
1167
 
                inv = self.get_inventory(revision_id)
1168
 
            plaintext = Testament(rev, inv).as_short_text()
1169
 
            self.store_revision_signature(
1170
 
                gpg.GPGStrategy(config), plaintext, revision_id)
1171
 
        # check inventory present
1172
 
        if not self.inventories.get_parent_map([(revision_id,)]):
1173
 
            if inv is None:
1174
 
                raise errors.WeaveRevisionNotPresent(revision_id,
1175
 
                                                     self.inventories)
1176
 
            else:
1177
 
                # yes, this is not suitable for adding with ghosts.
1178
 
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1179
 
                                                        rev.parent_ids)
1180
 
        else:
1181
 
            key = (revision_id,)
1182
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1183
 
        self._add_revision(rev)
1184
 
 
1185
 
    def _add_revision(self, revision):
1186
 
        text = self._serializer.write_revision_to_string(revision)
1187
 
        key = (revision.revision_id,)
1188
 
        parents = tuple((parent,) for parent in revision.parent_ids)
1189
 
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
1190
 
 
1191
321
    def all_revision_ids(self):
1192
322
        """Returns a list of all the revision ids in the repository.
1193
323
 
1216
346
        """
1217
347
        self.control_files.break_lock()
1218
348
 
1219
 
    @needs_read_lock
1220
 
    def _eliminate_revisions_not_present(self, revision_ids):
1221
 
        """Check every revision id in revision_ids to see if we have it.
1222
 
 
1223
 
        Returns a set of the present revisions.
1224
 
        """
1225
 
        result = []
1226
 
        graph = self.get_graph()
1227
 
        parent_map = graph.get_parent_map(revision_ids)
1228
 
        # The old API returned a list, should this actually be a set?
1229
 
        return parent_map.keys()
1230
 
 
1231
 
    def _check_inventories(self, checker):
1232
 
        """Check the inventories found from the revision scan.
1233
 
        
1234
 
        This is responsible for verifying the sha1 of inventories and
1235
 
        creating a pending_keys set that covers data referenced by inventories.
1236
 
        """
1237
 
        bar = ui.ui_factory.nested_progress_bar()
1238
 
        try:
1239
 
            self._do_check_inventories(checker, bar)
1240
 
        finally:
1241
 
            bar.finished()
1242
 
 
1243
 
    def _do_check_inventories(self, checker, bar):
1244
 
        """Helper for _check_inventories."""
1245
 
        revno = 0
1246
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1247
 
        kinds = ['chk_bytes', 'texts']
1248
 
        count = len(checker.pending_keys)
1249
 
        bar.update("inventories", 0, 2)
1250
 
        current_keys = checker.pending_keys
1251
 
        checker.pending_keys = {}
1252
 
        # Accumulate current checks.
1253
 
        for key in current_keys:
1254
 
            if key[0] != 'inventories' and key[0] not in kinds:
1255
 
                checker._report_items.append('unknown key type %r' % (key,))
1256
 
            keys[key[0]].add(key[1:])
1257
 
        if keys['inventories']:
1258
 
            # NB: output order *should* be roughly sorted - topo or
1259
 
            # inverse topo depending on repository - either way decent
1260
 
            # to just delta against. However, pre-CHK formats didn't
1261
 
            # try to optimise inventory layout on disk. As such the
1262
 
            # pre-CHK code path does not use inventory deltas.
1263
 
            last_object = None
1264
 
            for record in self.inventories.check(keys=keys['inventories']):
1265
 
                if record.storage_kind == 'absent':
1266
 
                    checker._report_items.append(
1267
 
                        'Missing inventory {%s}' % (record.key,))
1268
 
                else:
1269
 
                    last_object = self._check_record('inventories', record,
1270
 
                        checker, last_object,
1271
 
                        current_keys[('inventories',) + record.key])
1272
 
            del keys['inventories']
1273
 
        else:
1274
 
            return
1275
 
        bar.update("texts", 1)
1276
 
        while (checker.pending_keys or keys['chk_bytes']
1277
 
            or keys['texts']):
1278
 
            # Something to check.
1279
 
            current_keys = checker.pending_keys
1280
 
            checker.pending_keys = {}
1281
 
            # Accumulate current checks.
1282
 
            for key in current_keys:
1283
 
                if key[0] not in kinds:
1284
 
                    checker._report_items.append('unknown key type %r' % (key,))
1285
 
                keys[key[0]].add(key[1:])
1286
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1287
 
            for kind in kinds:
1288
 
                if keys[kind]:
1289
 
                    last_object = None
1290
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1291
 
                        if record.storage_kind == 'absent':
1292
 
                            checker._report_items.append(
1293
 
                                'Missing %s {%s}' % (kind, record.key,))
1294
 
                        else:
1295
 
                            last_object = self._check_record(kind, record,
1296
 
                                checker, last_object, current_keys[(kind,) + record.key])
1297
 
                    keys[kind] = set()
1298
 
                    break
1299
 
 
1300
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1301
 
        """Check a single text from this repository."""
1302
 
        if kind == 'inventories':
1303
 
            rev_id = record.key[0]
1304
 
            inv = self._deserialise_inventory(rev_id,
1305
 
                record.get_bytes_as('fulltext'))
1306
 
            if last_object is not None:
1307
 
                delta = inv._make_delta(last_object)
1308
 
                for old_path, path, file_id, ie in delta:
1309
 
                    if ie is None:
1310
 
                        continue
1311
 
                    ie.check(checker, rev_id, inv)
1312
 
            else:
1313
 
                for path, ie in inv.iter_entries():
1314
 
                    ie.check(checker, rev_id, inv)
1315
 
            if self._format.fast_deltas:
1316
 
                return inv
1317
 
        elif kind == 'chk_bytes':
1318
 
            # No code written to check chk_bytes for this repo format.
1319
 
            checker._report_items.append(
1320
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1321
 
        elif kind == 'texts':
1322
 
            self._check_text(record, checker, item_data)
1323
 
        else:
1324
 
            checker._report_items.append(
1325
 
                'unknown key type %s for %s' % (kind, record.key))
1326
 
 
1327
 
    def _check_text(self, record, checker, item_data):
1328
 
        """Check a single text."""
1329
 
        # Check it is extractable.
1330
 
        # TODO: check length.
1331
 
        if record.storage_kind == 'chunked':
1332
 
            chunks = record.get_bytes_as(record.storage_kind)
1333
 
            sha1 = osutils.sha_strings(chunks)
1334
 
            length = sum(map(len, chunks))
1335
 
        else:
1336
 
            content = record.get_bytes_as('fulltext')
1337
 
            sha1 = osutils.sha_string(content)
1338
 
            length = len(content)
1339
 
        if item_data and sha1 != item_data[1]:
1340
 
            checker._report_items.append(
1341
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1342
 
                (record.key, sha1, item_data[1], item_data[2]))
1343
 
 
1344
349
    @staticmethod
1345
 
    def create(a_bzrdir):
1346
 
        """Construct the current default format repository in a_bzrdir."""
1347
 
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
 
350
    def create(controldir):
 
351
        """Construct the current default format repository in controldir."""
 
352
        return RepositoryFormat.get_default_format().initialize(controldir)
1348
353
 
1349
 
    def __init__(self, _format, a_bzrdir, control_files):
 
354
    def __init__(self, _format, controldir, control_files):
1350
355
        """instantiate a Repository.
1351
356
 
1352
357
        :param _format: The format of the repository on disk.
1353
 
        :param a_bzrdir: The BzrDir of the repository.
 
358
        :param controldir: The ControlDir of the repository.
 
359
        :param control_files: Control files to use for locking, etc.
1354
360
        """
1355
361
        # In the future we will have a single api for all stores for
1356
362
        # getting file texts, inventories and revisions, then
1358
364
        super(Repository, self).__init__()
1359
365
        self._format = _format
1360
366
        # the following are part of the public API for Repository:
1361
 
        self.bzrdir = a_bzrdir
 
367
        self.bzrdir = controldir
1362
368
        self.control_files = control_files
1363
 
        self._transport = control_files._transport
1364
 
        self.base = self._transport.base
1365
369
        # for tests
1366
 
        self._reconcile_does_inventory_gc = True
1367
 
        self._reconcile_fixes_text_parents = False
1368
 
        self._reconcile_backsup_inventory = True
1369
370
        self._write_group = None
1370
371
        # Additional places to query for data.
1371
372
        self._fallback_repositories = []
1372
 
        # An InventoryEntry cache, used during deserialization
1373
 
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1374
 
        # Is it safe to return inventory entries directly from the entry cache,
1375
 
        # rather copying them?
1376
 
        self._safe_to_return_from_cache = False
1377
373
 
1378
374
    @property
1379
375
    def user_transport(self):
1413
409
        """
1414
410
        if self.__class__ is not other.__class__:
1415
411
            return False
1416
 
        return (self._transport.base == other._transport.base)
 
412
        return (self.control_url == other.control_url)
1417
413
 
1418
414
    def is_in_write_group(self):
1419
415
        """Return True if there is an open write group.
1519
515
        if revid and committers:
1520
516
            result['committers'] = 0
1521
517
        if revid and revid != _mod_revision.NULL_REVISION:
 
518
            graph = self.get_graph()
1522
519
            if committers:
1523
520
                all_committers = set()
1524
 
            revisions = self.get_ancestry(revid)
1525
 
            # pop the leading None
1526
 
            revisions.pop(0)
1527
 
            first_revision = None
 
521
            revisions = [r for (r, p) in graph.iter_ancestry([revid])
 
522
                        if r != _mod_revision.NULL_REVISION]
 
523
            last_revision = None
1528
524
            if not committers:
1529
525
                # ignore the revisions in the middle - just grab first and last
1530
526
                revisions = revisions[0], revisions[-1]
1531
527
            for revision in self.get_revisions(revisions):
1532
 
                if not first_revision:
1533
 
                    first_revision = revision
 
528
                if not last_revision:
 
529
                    last_revision = revision
1534
530
                if committers:
1535
531
                    all_committers.add(revision.committer)
1536
 
            last_revision = revision
 
532
            first_revision = revision
1537
533
            if committers:
1538
534
                result['committers'] = len(all_committers)
1539
535
            result['firstrev'] = (first_revision.timestamp,
1540
536
                first_revision.timezone)
1541
537
            result['latestrev'] = (last_revision.timestamp,
1542
538
                last_revision.timezone)
1543
 
 
1544
 
        # now gather global repository information
1545
 
        # XXX: This is available for many repos regardless of listability.
1546
 
        if self.user_transport.listable():
1547
 
            # XXX: do we want to __define len__() ?
1548
 
            # Maybe the versionedfiles object should provide a different
1549
 
            # method to get the number of keys.
1550
 
            result['revisions'] = len(self.revisions.keys())
1551
 
            # result['size'] = t
1552
539
        return result
1553
540
 
1554
541
    def find_branches(self, using=False):
1565
552
            def __init__(self):
1566
553
                self.first_call = True
1567
554
 
1568
 
            def __call__(self, bzrdir):
1569
 
                # On the first call, the parameter is always the bzrdir
 
555
            def __call__(self, controldir):
 
556
                # On the first call, the parameter is always the controldir
1570
557
                # containing the current repo.
1571
558
                if not self.first_call:
1572
559
                    try:
1573
 
                        repository = bzrdir.open_repository()
 
560
                        repository = controldir.open_repository()
1574
561
                    except errors.NoRepositoryPresent:
1575
562
                        pass
1576
563
                    else:
1577
564
                        return False, ([], repository)
1578
565
                self.first_call = False
1579
 
                value = (bzrdir.list_branches(), None)
 
566
                value = (controldir.list_branches(), None)
1580
567
                return True, value
1581
568
 
1582
569
        ret = []
1583
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
 
570
        for branches, repository in controldir.ControlDir.find_bzrdirs(
1584
571
                self.user_transport, evaluate=Evaluator()):
1585
572
            if branches is not None:
1586
573
                ret.extend(branches)
1591
578
    @needs_read_lock
1592
579
    def search_missing_revision_ids(self, other,
1593
580
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1594
 
            find_ghosts=True, revision_ids=None, if_present_ids=None):
 
581
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
582
            limit=None):
1595
583
        """Return the revision ids that other has that this does not.
1596
584
 
1597
585
        These are returned in topological order.
1610
598
                revision_ids = [revision_id]
1611
599
        return InterRepository.get(other, self).search_missing_revision_ids(
1612
600
            find_ghosts=find_ghosts, revision_ids=revision_ids,
1613
 
            if_present_ids=if_present_ids)
 
601
            if_present_ids=if_present_ids, limit=limit)
1614
602
 
1615
603
    @staticmethod
1616
604
    def open(base):
1619
607
        For instance, if the repository is at URL/.bzr/repository,
1620
608
        Repository.open(URL) -> a Repository instance.
1621
609
        """
1622
 
        control = bzrdir.BzrDir.open(base)
 
610
        control = controldir.ControlDir.open(base)
1623
611
        return control.open_repository()
1624
612
 
1625
613
    def copy_content_into(self, destination, revision_id=None):
1656
644
        """
1657
645
 
1658
646
    def suspend_write_group(self):
 
647
        """Suspend a write group.
 
648
 
 
649
        :raise UnsuspendableWriteGroup: If the write group can not be
 
650
            suspended.
 
651
        :return: List of tokens
 
652
        """
1659
653
        raise errors.UnsuspendableWriteGroup(self)
1660
654
 
1661
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1662
 
        """Return the keys of missing inventory parents for revisions added in
1663
 
        this write group.
1664
 
 
1665
 
        A revision is not complete if the inventory delta for that revision
1666
 
        cannot be calculated.  Therefore if the parent inventories of a
1667
 
        revision are not present, the revision is incomplete, and e.g. cannot
1668
 
        be streamed by a smart server.  This method finds missing inventory
1669
 
        parents for revisions added in this write group.
1670
 
        """
1671
 
        if not self._format.supports_external_lookups:
1672
 
            # This is only an issue for stacked repositories
1673
 
            return set()
1674
 
        if not self.is_in_write_group():
1675
 
            raise AssertionError('not in a write group')
1676
 
 
1677
 
        # XXX: We assume that every added revision already has its
1678
 
        # corresponding inventory, so we only check for parent inventories that
1679
 
        # might be missing, rather than all inventories.
1680
 
        parents = set(self.revisions._index.get_missing_parents())
1681
 
        parents.discard(_mod_revision.NULL_REVISION)
1682
 
        unstacked_inventories = self.inventories._index
1683
 
        present_inventories = unstacked_inventories.get_parent_map(
1684
 
            key[-1:] for key in parents)
1685
 
        parents.difference_update(present_inventories)
1686
 
        if len(parents) == 0:
1687
 
            # No missing parent inventories.
1688
 
            return set()
1689
 
        if not check_for_missing_texts:
1690
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1691
 
        # Ok, now we have a list of missing inventories.  But these only matter
1692
 
        # if the inventories that reference them are missing some texts they
1693
 
        # appear to introduce.
1694
 
        # XXX: Texts referenced by all added inventories need to be present,
1695
 
        # but at the moment we're only checking for texts referenced by
1696
 
        # inventories at the graph's edge.
1697
 
        key_deps = self.revisions._index._key_dependencies
1698
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1699
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1700
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1701
 
        missing_texts = set()
1702
 
        for file_id, version_ids in file_ids.iteritems():
1703
 
            missing_texts.update(
1704
 
                (file_id, version_id) for version_id in version_ids)
1705
 
        present_texts = self.texts.get_parent_map(missing_texts)
1706
 
        missing_texts.difference_update(present_texts)
1707
 
        if not missing_texts:
1708
 
            # No texts are missing, so all revisions and their deltas are
1709
 
            # reconstructable.
1710
 
            return set()
1711
 
        # Alternatively the text versions could be returned as the missing
1712
 
        # keys, but this is likely to be less data.
1713
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1714
 
        return missing_keys
1715
 
 
1716
655
    def refresh_data(self):
1717
656
        """Re-read any data needed to synchronise with disk.
1718
657
 
1738
677
    def _resume_write_group(self, tokens):
1739
678
        raise errors.UnsuspendableWriteGroup(self)
1740
679
 
1741
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
1742
 
            fetch_spec=None):
 
680
    def fetch(self, source, revision_id=None, find_ghosts=False):
1743
681
        """Fetch the content required to construct revision_id from source.
1744
682
 
1745
 
        If revision_id is None and fetch_spec is None, then all content is
1746
 
        copied.
 
683
        If revision_id is None, then all content is copied.
1747
684
 
1748
685
        fetch() may not be used when the repository is in a write group -
1749
686
        either finish the current write group before using fetch, or use
1755
692
        :param revision_id: If specified, all the content needed for this
1756
693
            revision ID will be copied to the target.  Fetch will determine for
1757
694
            itself which content needs to be copied.
1758
 
        :param fetch_spec: If specified, a SearchResult or
1759
 
            PendingAncestryResult that describes which revisions to copy.  This
1760
 
            allows copying multiple heads at once.  Mutually exclusive with
1761
 
            revision_id.
1762
695
        """
1763
 
        if fetch_spec is not None and revision_id is not None:
1764
 
            raise AssertionError(
1765
 
                "fetch_spec and revision_id are mutually exclusive.")
1766
696
        if self.is_in_write_group():
1767
697
            raise errors.InternalBzrError(
1768
698
                "May not fetch while in a write group.")
1770
700
        # TODO: lift out to somewhere common with RemoteRepository
1771
701
        # <https://bugs.launchpad.net/bzr/+bug/401646>
1772
702
        if (self.has_same_location(source)
1773
 
            and fetch_spec is None
1774
703
            and self._has_same_fallbacks(source)):
1775
704
            # check that last_revision is in 'from' and then return a
1776
705
            # no-operation.
1779
708
                self.get_revision(revision_id)
1780
709
            return 0, []
1781
710
        inter = InterRepository.get(source, self)
1782
 
        return inter.fetch(revision_id=revision_id,
1783
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
711
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
1784
712
 
1785
713
    def create_bundle(self, target, base, fileobj, format=None):
1786
714
        return serializer.write_bundle(self, target, base, fileobj, format)
1787
715
 
1788
 
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
716
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
1789
717
                           timezone=None, committer=None, revprops=None,
1790
 
                           revision_id=None):
 
718
                           revision_id=None, lossy=False):
1791
719
        """Obtain a CommitBuilder for this repository.
1792
720
 
1793
721
        :param branch: Branch to commit to.
1794
722
        :param parents: Revision ids of the parents of the new revision.
1795
 
        :param config: Configuration to use.
 
723
        :param config_stack: Configuration stack to use.
1796
724
        :param timestamp: Optional timestamp recorded for commit.
1797
725
        :param timezone: Optional timezone for timestamp.
1798
726
        :param committer: Optional committer to set for commit.
1799
727
        :param revprops: Optional dictionary of revision properties.
1800
728
        :param revision_id: Optional revision id.
 
729
        :param lossy: Whether to discard data that can not be natively
 
730
            represented, when pushing to a foreign VCS
1801
731
        """
1802
 
        if self._fallback_repositories and not self._format.supports_chks:
1803
 
            raise errors.BzrError("Cannot commit directly to a stacked branch"
1804
 
                " in pre-2a formats. See "
1805
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1806
 
        result = self._commit_builder_class(self, parents, config,
1807
 
            timestamp, timezone, committer, revprops, revision_id)
1808
 
        self.start_write_group()
1809
 
        return result
 
732
        raise NotImplementedError(self.get_commit_builder)
1810
733
 
1811
734
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1812
735
    def unlock(self):
1819
742
                    'Must end write groups before releasing write locks.')
1820
743
        self.control_files.unlock()
1821
744
        if self.control_files._lock_count == 0:
1822
 
            self._inventory_entry_cache.clear()
1823
745
            for repo in self._fallback_repositories:
1824
746
                repo.unlock()
1825
747
 
1826
748
    @needs_read_lock
1827
 
    def clone(self, a_bzrdir, revision_id=None):
1828
 
        """Clone this repository into a_bzrdir using the current format.
 
749
    def clone(self, controldir, revision_id=None):
 
750
        """Clone this repository into controldir using the current format.
1829
751
 
1830
752
        Currently no check is made that the format of this repository and
1831
753
        the bzrdir format are compatible. FIXME RBC 20060201.
1834
756
        """
1835
757
        # TODO: deprecate after 0.16; cloning this with all its settings is
1836
758
        # probably not very useful -- mbp 20070423
1837
 
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
759
        dest_repo = self._create_sprouting_repo(
 
760
            controldir, shared=self.is_shared())
1838
761
        self.copy_content_into(dest_repo, revision_id)
1839
762
        return dest_repo
1840
763
 
1890
813
                dest_repo = a_bzrdir.open_repository()
1891
814
        return dest_repo
1892
815
 
1893
 
    def _get_sink(self):
1894
 
        """Return a sink for streaming into this repository."""
1895
 
        return StreamSink(self)
1896
 
 
1897
 
    def _get_source(self, to_format):
1898
 
        """Return a source for streaming from this repository."""
1899
 
        return StreamSource(self, to_format)
1900
 
 
1901
816
    @needs_read_lock
1902
817
    def has_revision(self, revision_id):
1903
818
        """True if this repository has a copy of the revision."""
1910
825
        :param revision_ids: An iterable of revision_ids.
1911
826
        :return: A set of the revision_ids that were present.
1912
827
        """
1913
 
        parent_map = self.revisions.get_parent_map(
1914
 
            [(rev_id,) for rev_id in revision_ids])
1915
 
        result = set()
1916
 
        if _mod_revision.NULL_REVISION in revision_ids:
1917
 
            result.add(_mod_revision.NULL_REVISION)
1918
 
        result.update([key[0] for key in parent_map])
1919
 
        return result
 
828
        raise NotImplementedError(self.has_revisions)
1920
829
 
1921
830
    @needs_read_lock
1922
831
    def get_revision(self, revision_id):
1923
832
        """Return the Revision object for a named revision."""
1924
833
        return self.get_revisions([revision_id])[0]
1925
834
 
1926
 
    @needs_read_lock
1927
835
    def get_revision_reconcile(self, revision_id):
1928
836
        """'reconcile' helper routine that allows access to a revision always.
1929
837
 
1932
840
        be used by reconcile, or reconcile-alike commands that are correcting
1933
841
        or testing the revision graph.
1934
842
        """
1935
 
        return self._get_revisions([revision_id])[0]
 
843
        raise NotImplementedError(self.get_revision_reconcile)
1936
844
 
1937
 
    @needs_read_lock
1938
845
    def get_revisions(self, revision_ids):
1939
846
        """Get many revisions at once.
1940
847
        
1941
848
        Repositories that need to check data on every revision read should 
1942
849
        subclass this method.
1943
850
        """
1944
 
        return self._get_revisions(revision_ids)
1945
 
 
1946
 
    @needs_read_lock
1947
 
    def _get_revisions(self, revision_ids):
1948
 
        """Core work logic to get many revisions without sanity checks."""
1949
 
        revs = {}
1950
 
        for revid, rev in self._iter_revisions(revision_ids):
1951
 
            if rev is None:
1952
 
                raise errors.NoSuchRevision(self, revid)
1953
 
            revs[revid] = rev
1954
 
        return [revs[revid] for revid in revision_ids]
1955
 
 
1956
 
    def _iter_revisions(self, revision_ids):
1957
 
        """Iterate over revision objects.
1958
 
 
1959
 
        :param revision_ids: An iterable of revisions to examine. None may be
1960
 
            passed to request all revisions known to the repository. Note that
1961
 
            not all repositories can find unreferenced revisions; for those
1962
 
            repositories only referenced ones will be returned.
1963
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1964
 
            those asked for but not available) are returned as (revid, None).
1965
 
        """
1966
 
        if revision_ids is None:
1967
 
            revision_ids = self.all_revision_ids()
1968
 
        else:
1969
 
            for rev_id in revision_ids:
1970
 
                if not rev_id or not isinstance(rev_id, basestring):
1971
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1972
 
        keys = [(key,) for key in revision_ids]
1973
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1974
 
        for record in stream:
1975
 
            revid = record.key[0]
1976
 
            if record.storage_kind == 'absent':
1977
 
                yield (revid, None)
1978
 
            else:
1979
 
                text = record.get_bytes_as('fulltext')
1980
 
                rev = self._serializer.read_revision_from_string(text)
1981
 
                yield (revid, rev)
 
851
        raise NotImplementedError(self.get_revisions)
1982
852
 
1983
853
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1984
854
        """Produce a generator of revision deltas.
2039
909
        signature = gpg_strategy.sign(plaintext)
2040
910
        self.add_signature_text(revision_id, signature)
2041
911
 
2042
 
    @needs_write_lock
2043
912
    def add_signature_text(self, revision_id, signature):
2044
 
        self.signatures.add_lines((revision_id,), (),
2045
 
            osutils.split_lines(signature))
2046
 
 
2047
 
    def find_text_key_references(self):
2048
 
        """Find the text key references within the repository.
2049
 
 
2050
 
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
2051
 
            to whether they were referred to by the inventory of the
2052
 
            revision_id that they contain. The inventory texts from all present
2053
 
            revision ids are assessed to generate this report.
2054
 
        """
2055
 
        revision_keys = self.revisions.keys()
2056
 
        w = self.inventories
2057
 
        pb = ui.ui_factory.nested_progress_bar()
2058
 
        try:
2059
 
            return self._serializer._find_text_key_references(
2060
 
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
2061
 
        finally:
2062
 
            pb.finished()
2063
 
 
2064
 
    def _inventory_xml_lines_for_keys(self, keys):
2065
 
        """Get a line iterator of the sort needed for findind references.
2066
 
 
2067
 
        Not relevant for non-xml inventory repositories.
2068
 
 
2069
 
        Ghosts in revision_keys are ignored.
2070
 
 
2071
 
        :param revision_keys: The revision keys for the inventories to inspect.
2072
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2073
 
            all of the xml inventories specified by revision_keys.
2074
 
        """
2075
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2076
 
        for record in stream:
2077
 
            if record.storage_kind != 'absent':
2078
 
                chunks = record.get_bytes_as('chunked')
2079
 
                revid = record.key[-1]
2080
 
                lines = osutils.chunks_to_lines(chunks)
2081
 
                for line in lines:
2082
 
                    yield line, revid
2083
 
 
2084
 
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2085
 
        revision_keys):
2086
 
        """Helper routine for fileids_altered_by_revision_ids.
2087
 
 
2088
 
        This performs the translation of xml lines to revision ids.
2089
 
 
2090
 
        :param line_iterator: An iterator of lines, origin_version_id
2091
 
        :param revision_keys: The revision ids to filter for. This should be a
2092
 
            set or other type which supports efficient __contains__ lookups, as
2093
 
            the revision key from each parsed line will be looked up in the
2094
 
            revision_keys filter.
2095
 
        :return: a dictionary mapping altered file-ids to an iterable of
2096
 
        revision_ids. Each altered file-ids has the exact revision_ids that
2097
 
        altered it listed explicitly.
2098
 
        """
2099
 
        seen = set(self._serializer._find_text_key_references(
2100
 
                line_iterator).iterkeys())
2101
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2102
 
        parent_seen = set(self._serializer._find_text_key_references(
2103
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2104
 
        new_keys = seen - parent_seen
2105
 
        result = {}
2106
 
        setdefault = result.setdefault
2107
 
        for key in new_keys:
2108
 
            setdefault(key[0], set()).add(key[-1])
2109
 
        return result
 
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)
2110
919
 
2111
920
    def _find_parent_ids_of_revisions(self, revision_ids):
2112
921
        """Find all parent ids that are mentioned in the revision graph.
2121
930
        parent_ids.discard(_mod_revision.NULL_REVISION)
2122
931
        return parent_ids
2123
932
 
2124
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2125
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2126
 
 
2127
 
        :param revision_keys: An iterable of revision_keys.
2128
 
        :return: The parents of all revision_keys that are not already in
2129
 
            revision_keys
2130
 
        """
2131
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2132
 
        parent_keys = set()
2133
 
        map(parent_keys.update, parent_map.itervalues())
2134
 
        parent_keys.difference_update(revision_keys)
2135
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2136
 
        return parent_keys
2137
 
 
2138
 
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2139
 
        """Find the file ids and versions affected by revisions.
2140
 
 
2141
 
        :param revisions: an iterable containing revision ids.
2142
 
        :param _inv_weave: The inventory weave from this repository or None.
2143
 
            If None, the inventory weave will be opened automatically.
2144
 
        :return: a dictionary mapping altered file-ids to an iterable of
2145
 
        revision_ids. Each altered file-ids has the exact revision_ids that
2146
 
        altered it listed explicitly.
2147
 
        """
2148
 
        selected_keys = set((revid,) for revid in revision_ids)
2149
 
        w = _inv_weave or self.inventories
2150
 
        return self._find_file_ids_from_xml_inventory_lines(
2151
 
            w.iter_lines_added_or_present_in_keys(
2152
 
                selected_keys, pb=None),
2153
 
            selected_keys)
2154
 
 
2155
933
    def iter_files_bytes(self, desired_files):
2156
934
        """Iterate through file versions.
2157
935
 
2163
941
        uniquely identify the file version in the caller's context.  (Examples:
2164
942
        an index number or a TreeTransform trans_id.)
2165
943
 
2166
 
        bytes_iterator is an iterable of bytestrings for the file.  The
2167
 
        kind of iterable and length of the bytestrings are unspecified, but for
2168
 
        this implementation, it is a list of bytes produced by
2169
 
        VersionedFile.get_record_stream().
2170
 
 
2171
944
        :param desired_files: a list of (file_id, revision_id, identifier)
2172
945
            triples
2173
946
        """
2174
 
        text_keys = {}
2175
 
        for file_id, revision_id, callable_data in desired_files:
2176
 
            text_keys[(file_id, revision_id)] = callable_data
2177
 
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2178
 
            if record.storage_kind == 'absent':
2179
 
                raise errors.RevisionNotPresent(record.key, self)
2180
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
2181
 
 
2182
 
    def _generate_text_key_index(self, text_key_references=None,
2183
 
        ancestors=None):
2184
 
        """Generate a new text key index for the repository.
2185
 
 
2186
 
        This is an expensive function that will take considerable time to run.
2187
 
 
2188
 
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
2189
 
            list of parents, also text keys. When a given key has no parents,
2190
 
            the parents list will be [NULL_REVISION].
2191
 
        """
2192
 
        # All revisions, to find inventory parents.
2193
 
        if ancestors is None:
2194
 
            graph = self.get_graph()
2195
 
            ancestors = graph.get_parent_map(self.all_revision_ids())
2196
 
        if text_key_references is None:
2197
 
            text_key_references = self.find_text_key_references()
2198
 
        pb = ui.ui_factory.nested_progress_bar()
2199
 
        try:
2200
 
            return self._do_generate_text_key_index(ancestors,
2201
 
                text_key_references, pb)
2202
 
        finally:
2203
 
            pb.finished()
2204
 
 
2205
 
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
2206
 
        """Helper for _generate_text_key_index to avoid deep nesting."""
2207
 
        revision_order = tsort.topo_sort(ancestors)
2208
 
        invalid_keys = set()
2209
 
        revision_keys = {}
2210
 
        for revision_id in revision_order:
2211
 
            revision_keys[revision_id] = set()
2212
 
        text_count = len(text_key_references)
2213
 
        # a cache of the text keys to allow reuse; costs a dict of all the
2214
 
        # keys, but saves a 2-tuple for every child of a given key.
2215
 
        text_key_cache = {}
2216
 
        for text_key, valid in text_key_references.iteritems():
2217
 
            if not valid:
2218
 
                invalid_keys.add(text_key)
2219
 
            else:
2220
 
                revision_keys[text_key[1]].add(text_key)
2221
 
            text_key_cache[text_key] = text_key
2222
 
        del text_key_references
2223
 
        text_index = {}
2224
 
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
2225
 
        NULL_REVISION = _mod_revision.NULL_REVISION
2226
 
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
2227
 
        # too small for large or very branchy trees. However, for 55K path
2228
 
        # trees, it would be easy to use too much memory trivially. Ideally we
2229
 
        # could gauge this by looking at available real memory etc, but this is
2230
 
        # always a tricky proposition.
2231
 
        inventory_cache = lru_cache.LRUCache(10)
2232
 
        batch_size = 10 # should be ~150MB on a 55K path tree
2233
 
        batch_count = len(revision_order) / batch_size + 1
2234
 
        processed_texts = 0
2235
 
        pb.update("Calculating text parents", processed_texts, text_count)
2236
 
        for offset in xrange(batch_count):
2237
 
            to_query = revision_order[offset * batch_size:(offset + 1) *
2238
 
                batch_size]
2239
 
            if not to_query:
2240
 
                break
2241
 
            for revision_id in to_query:
2242
 
                parent_ids = ancestors[revision_id]
2243
 
                for text_key in revision_keys[revision_id]:
2244
 
                    pb.update("Calculating text parents", processed_texts)
2245
 
                    processed_texts += 1
2246
 
                    candidate_parents = []
2247
 
                    for parent_id in parent_ids:
2248
 
                        parent_text_key = (text_key[0], parent_id)
2249
 
                        try:
2250
 
                            check_parent = parent_text_key not in \
2251
 
                                revision_keys[parent_id]
2252
 
                        except KeyError:
2253
 
                            # the parent parent_id is a ghost:
2254
 
                            check_parent = False
2255
 
                            # truncate the derived graph against this ghost.
2256
 
                            parent_text_key = None
2257
 
                        if check_parent:
2258
 
                            # look at the parent commit details inventories to
2259
 
                            # determine possible candidates in the per file graph.
2260
 
                            # TODO: cache here.
2261
 
                            try:
2262
 
                                inv = inventory_cache[parent_id]
2263
 
                            except KeyError:
2264
 
                                inv = self.revision_tree(parent_id).inventory
2265
 
                                inventory_cache[parent_id] = inv
2266
 
                            try:
2267
 
                                parent_entry = inv[text_key[0]]
2268
 
                            except (KeyError, errors.NoSuchId):
2269
 
                                parent_entry = None
2270
 
                            if parent_entry is not None:
2271
 
                                parent_text_key = (
2272
 
                                    text_key[0], parent_entry.revision)
2273
 
                            else:
2274
 
                                parent_text_key = None
2275
 
                        if parent_text_key is not None:
2276
 
                            candidate_parents.append(
2277
 
                                text_key_cache[parent_text_key])
2278
 
                    parent_heads = text_graph.heads(candidate_parents)
2279
 
                    new_parents = list(parent_heads)
2280
 
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
2281
 
                    if new_parents == []:
2282
 
                        new_parents = [NULL_REVISION]
2283
 
                    text_index[text_key] = new_parents
2284
 
 
2285
 
        for text_key in invalid_keys:
2286
 
            text_index[text_key] = [NULL_REVISION]
2287
 
        return text_index
2288
 
 
2289
 
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2290
 
        """Get an iterable listing the keys of all the data introduced by a set
2291
 
        of revision IDs.
2292
 
 
2293
 
        The keys will be ordered so that the corresponding items can be safely
2294
 
        fetched and inserted in that order.
2295
 
 
2296
 
        :returns: An iterable producing tuples of (knit-kind, file-id,
2297
 
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2298
 
            'revisions'.  file-id is None unless knit-kind is 'file'.
2299
 
        """
2300
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2301
 
            yield result
2302
 
        del _files_pb
2303
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2304
 
            yield result
2305
 
 
2306
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2307
 
        # XXX: it's a bit weird to control the inventory weave caching in this
2308
 
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2309
 
        # maybe this generator should explicitly have the contract that it
2310
 
        # should not be iterated until the previously yielded item has been
2311
 
        # processed?
2312
 
        inv_w = self.inventories
2313
 
 
2314
 
        # file ids that changed
2315
 
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2316
 
        count = 0
2317
 
        num_file_ids = len(file_ids)
2318
 
        for file_id, altered_versions in file_ids.iteritems():
2319
 
            if pb is not None:
2320
 
                pb.update("Fetch texts", count, num_file_ids)
2321
 
            count += 1
2322
 
            yield ("file", file_id, altered_versions)
2323
 
 
2324
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2325
 
        # inventory
2326
 
        yield ("inventory", None, revision_ids)
2327
 
 
2328
 
        # signatures
2329
 
        # XXX: Note ATM no callers actually pay attention to this return
2330
 
        #      instead they just use the list of revision ids and ignore
2331
 
        #      missing sigs. Consider removing this work entirely
2332
 
        revisions_with_signatures = set(self.signatures.get_parent_map(
2333
 
            [(r,) for r in revision_ids]))
2334
 
        revisions_with_signatures = set(
2335
 
            [r for (r,) in revisions_with_signatures])
2336
 
        revisions_with_signatures.intersection_update(revision_ids)
2337
 
        yield ("signatures", None, revisions_with_signatures)
2338
 
 
2339
 
        # revisions
2340
 
        yield ("revisions", None, revision_ids)
2341
 
 
2342
 
    @needs_read_lock
2343
 
    def get_inventory(self, revision_id):
2344
 
        """Get Inventory object by revision id."""
2345
 
        return self.iter_inventories([revision_id]).next()
2346
 
 
2347
 
    def iter_inventories(self, revision_ids, ordering=None):
2348
 
        """Get many inventories by revision_ids.
2349
 
 
2350
 
        This will buffer some or all of the texts used in constructing the
2351
 
        inventories in memory, but will only parse a single inventory at a
2352
 
        time.
2353
 
 
2354
 
        :param revision_ids: The expected revision ids of the inventories.
2355
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2356
 
            specified, the order of revision_ids will be preserved (by
2357
 
            buffering if necessary).
2358
 
        :return: An iterator of inventories.
2359
 
        """
2360
 
        if ((None in revision_ids)
2361
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
2362
 
            raise ValueError('cannot get null revision inventory')
2363
 
        return self._iter_inventories(revision_ids, ordering)
2364
 
 
2365
 
    def _iter_inventories(self, revision_ids, ordering):
2366
 
        """single-document based inventory iteration."""
2367
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2368
 
        for text, revision_id in inv_xmls:
2369
 
            yield self._deserialise_inventory(revision_id, text)
2370
 
 
2371
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2372
 
        if ordering is None:
2373
 
            order_as_requested = True
2374
 
            ordering = 'unordered'
2375
 
        else:
2376
 
            order_as_requested = False
2377
 
        keys = [(revision_id,) for revision_id in revision_ids]
2378
 
        if not keys:
2379
 
            return
2380
 
        if order_as_requested:
2381
 
            key_iter = iter(keys)
2382
 
            next_key = key_iter.next()
2383
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
2384
 
        text_chunks = {}
2385
 
        for record in stream:
2386
 
            if record.storage_kind != 'absent':
2387
 
                chunks = record.get_bytes_as('chunked')
2388
 
                if order_as_requested:
2389
 
                    text_chunks[record.key] = chunks
2390
 
                else:
2391
 
                    yield ''.join(chunks), record.key[-1]
2392
 
            else:
2393
 
                raise errors.NoSuchRevision(self, record.key)
2394
 
            if order_as_requested:
2395
 
                # Yield as many results as we can while preserving order.
2396
 
                while next_key in text_chunks:
2397
 
                    chunks = text_chunks.pop(next_key)
2398
 
                    yield ''.join(chunks), next_key[-1]
2399
 
                    try:
2400
 
                        next_key = key_iter.next()
2401
 
                    except StopIteration:
2402
 
                        # We still want to fully consume the get_record_stream,
2403
 
                        # just in case it is not actually finished at this point
2404
 
                        next_key = None
2405
 
                        break
2406
 
 
2407
 
    def _deserialise_inventory(self, revision_id, xml):
2408
 
        """Transform the xml into an inventory object.
2409
 
 
2410
 
        :param revision_id: The expected revision id of the inventory.
2411
 
        :param xml: A serialised inventory.
2412
 
        """
2413
 
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2414
 
                    entry_cache=self._inventory_entry_cache,
2415
 
                    return_from_cache=self._safe_to_return_from_cache)
2416
 
        if result.revision_id != revision_id:
2417
 
            raise AssertionError('revision id mismatch %s != %s' % (
2418
 
                result.revision_id, revision_id))
2419
 
        return result
2420
 
 
2421
 
    def get_serializer_format(self):
2422
 
        return self._serializer.format_num
2423
 
 
2424
 
    @needs_read_lock
2425
 
    def _get_inventory_xml(self, revision_id):
2426
 
        """Get serialized inventory as a string."""
2427
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2428
 
        try:
2429
 
            text, revision_id = texts.next()
2430
 
        except StopIteration:
2431
 
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2432
 
        return text
 
947
        raise NotImplementedError(self.iter_files_bytes)
2433
948
 
2434
949
    def get_rev_id_for_revno(self, revno, known_pair):
2435
950
        """Return the revision id of a revno, given a later (revno, revid)
2466
981
            raise AssertionError('_iter_for_revno returned too much history')
2467
982
        return (True, partial_history[-1])
2468
983
 
2469
 
    def iter_reverse_revision_history(self, revision_id):
2470
 
        """Iterate backwards through revision ids in the lefthand history
2471
 
 
2472
 
        :param revision_id: The revision id to start with.  All its lefthand
2473
 
            ancestors will be traversed.
2474
 
        """
2475
 
        graph = self.get_graph()
2476
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
2477
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
2478
 
 
2479
984
    def is_shared(self):
2480
985
        """Return True if this repository is flagged as a shared repository."""
2481
986
        raise NotImplementedError(self.is_shared)
2508
1013
 
2509
1014
        `revision_id` may be NULL_REVISION for the empty tree revision.
2510
1015
        """
2511
 
        revision_id = _mod_revision.ensure_null(revision_id)
2512
 
        # TODO: refactor this to use an existing revision object
2513
 
        # so we don't need to read it in twice.
2514
 
        if revision_id == _mod_revision.NULL_REVISION:
2515
 
            return RevisionTree(self, Inventory(root_id=None),
2516
 
                                _mod_revision.NULL_REVISION)
2517
 
        else:
2518
 
            inv = self.get_inventory(revision_id)
2519
 
            return RevisionTree(self, inv, revision_id)
 
1016
        raise NotImplementedError(self.revision_tree)
2520
1017
 
2521
1018
    def revision_trees(self, revision_ids):
2522
1019
        """Return Trees for revisions in this repository.
2524
1021
        :param revision_ids: a sequence of revision-ids;
2525
1022
          a revision-id may not be None or 'null:'
2526
1023
        """
2527
 
        inventories = self.iter_inventories(revision_ids)
2528
 
        for inv in inventories:
2529
 
            yield RevisionTree(self, inv, inv.revision_id)
2530
 
 
2531
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2532
 
        """Return Tree for a revision on this branch with only some files.
2533
 
 
2534
 
        :param revision_ids: a sequence of revision-ids;
2535
 
          a revision-id may not be None or 'null:'
2536
 
        :param file_ids: if not None, the result is filtered
2537
 
          so that only those file-ids, their parents and their
2538
 
          children are included.
2539
 
        """
2540
 
        inventories = self.iter_inventories(revision_ids)
2541
 
        for inv in inventories:
2542
 
            # Should we introduce a FilteredRevisionTree class rather
2543
 
            # than pre-filter the inventory here?
2544
 
            filtered_inv = inv.filter(file_ids)
2545
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2546
 
 
2547
 
    @needs_read_lock
2548
 
    def get_ancestry(self, revision_id, topo_sorted=True):
2549
 
        """Return a list of revision-ids integrated by a revision.
2550
 
 
2551
 
        The first element of the list is always None, indicating the origin
2552
 
        revision.  This might change when we have history horizons, or
2553
 
        perhaps we should have a new API.
2554
 
 
2555
 
        This is topologically sorted.
2556
 
        """
2557
 
        if _mod_revision.is_null(revision_id):
2558
 
            return [None]
2559
 
        if not self.has_revision(revision_id):
2560
 
            raise errors.NoSuchRevision(self, revision_id)
2561
 
        graph = self.get_graph()
2562
 
        keys = set()
2563
 
        search = graph._make_breadth_first_searcher([revision_id])
2564
 
        while True:
2565
 
            try:
2566
 
                found, ghosts = search.next_with_ghosts()
2567
 
            except StopIteration:
2568
 
                break
2569
 
            keys.update(found)
2570
 
        if _mod_revision.NULL_REVISION in keys:
2571
 
            keys.remove(_mod_revision.NULL_REVISION)
2572
 
        if topo_sorted:
2573
 
            parent_map = graph.get_parent_map(keys)
2574
 
            keys = tsort.topo_sort(parent_map)
2575
 
        return [None] + list(keys)
 
1024
        raise NotImplementedError(self.revision_trees)
2576
1025
 
2577
1026
    def pack(self, hint=None, clean_obsolete_packs=False):
2578
1027
        """Compress the data within the repository.
2600
1049
 
2601
1050
    def get_parent_map(self, revision_ids):
2602
1051
        """See graph.StackedParentsProvider.get_parent_map"""
 
1052
        raise NotImplementedError(self.get_parent_map)
 
1053
 
 
1054
    def _get_parent_map_no_fallbacks(self, revision_ids):
 
1055
        """Same as Repository.get_parent_map except doesn't query fallbacks."""
2603
1056
        # revisions index works in keys; this just works in revisions
2604
1057
        # therefore wrap and unwrap
2605
1058
        query_keys = []
2611
1064
                raise ValueError('get_parent_map(None) is not valid')
2612
1065
            else:
2613
1066
                query_keys.append((revision_id ,))
 
1067
        vf = self.revisions.without_fallbacks()
2614
1068
        for ((revision_id,), parent_keys) in \
2615
 
                self.revisions.get_parent_map(query_keys).iteritems():
 
1069
                vf.get_parent_map(query_keys).iteritems():
2616
1070
            if parent_keys:
2617
1071
                result[revision_id] = tuple([parent_revid
2618
1072
                    for (parent_revid,) in parent_keys])
2621
1075
        return result
2622
1076
 
2623
1077
    def _make_parents_provider(self):
2624
 
        return self
 
1078
        if not self._format.supports_external_lookups:
 
1079
            return self
 
1080
        return graph.StackedParentsProvider(_LazyListJoin(
 
1081
            [self._make_parents_provider_unstacked()],
 
1082
            self._fallback_repositories))
 
1083
 
 
1084
    def _make_parents_provider_unstacked(self):
 
1085
        return graph.CallableToParentsProviderAdapter(
 
1086
            self._get_parent_map_no_fallbacks)
2625
1087
 
2626
1088
    @needs_read_lock
2627
1089
    def get_known_graph_ancestry(self, revision_ids):
2628
1090
        """Return the known graph for a set of revision ids and their ancestors.
2629
1091
        """
2630
 
        st = static_tuple.StaticTuple
2631
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2632
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2633
 
        return graph.GraphThunkIdsToKeys(known_graph)
 
1092
        raise NotImplementedError(self.get_known_graph_ancestry)
 
1093
 
 
1094
    def get_file_graph(self):
 
1095
        """Return the graph walker for files."""
 
1096
        raise NotImplementedError(self.get_file_graph)
2634
1097
 
2635
1098
    def get_graph(self, other_repository=None):
2636
1099
        """Return the graph walker for this repository format"""
2641
1104
                [parents_provider, other_repository._make_parents_provider()])
2642
1105
        return graph.Graph(parents_provider)
2643
1106
 
2644
 
    def _get_versioned_file_checker(self, text_key_references=None,
2645
 
        ancestors=None):
2646
 
        """Return an object suitable for checking versioned files.
2647
 
        
2648
 
        :param text_key_references: if non-None, an already built
2649
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2650
 
            to whether they were referred to by the inventory of the
2651
 
            revision_id that they contain. If None, this will be
2652
 
            calculated.
2653
 
        :param ancestors: Optional result from
2654
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2655
 
            available.
2656
 
        """
2657
 
        return _VersionedFileChecker(self,
2658
 
            text_key_references=text_key_references, ancestors=ancestors)
2659
 
 
2660
 
    def revision_ids_to_search_result(self, result_set):
2661
 
        """Convert a set of revision ids to a graph SearchResult."""
2662
 
        result_parents = set()
2663
 
        for parents in self.get_graph().get_parent_map(
2664
 
            result_set).itervalues():
2665
 
            result_parents.update(parents)
2666
 
        included_keys = result_set.intersection(result_parents)
2667
 
        start_keys = result_set.difference(included_keys)
2668
 
        exclude_keys = result_parents.difference(result_set)
2669
 
        result = graph.SearchResult(start_keys, exclude_keys,
2670
 
            len(result_set), result_set)
2671
 
        return result
2672
 
 
2673
1107
    @needs_write_lock
2674
1108
    def set_make_working_trees(self, new_value):
2675
1109
        """Set the policy flag for making working trees when creating branches.
2688
1122
 
2689
1123
    @needs_write_lock
2690
1124
    def sign_revision(self, revision_id, gpg_strategy):
2691
 
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
1125
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
1126
        plaintext = testament.as_short_text()
2692
1127
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
2693
1128
 
2694
1129
    @needs_read_lock
 
1130
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
1131
        """Verify the signature on a revision.
 
1132
 
 
1133
        :param revision_id: the revision to verify
 
1134
        :gpg_strategy: the GPGStrategy object to used
 
1135
 
 
1136
        :return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
 
1137
        """
 
1138
        if not self.has_signature_for_revision_id(revision_id):
 
1139
            return gpg.SIGNATURE_NOT_SIGNED, None
 
1140
        signature = self.get_signature_text(revision_id)
 
1141
 
 
1142
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
1143
        plaintext = testament.as_short_text()
 
1144
 
 
1145
        return gpg_strategy.verify(signature, plaintext)
 
1146
 
 
1147
    @needs_read_lock
 
1148
    def verify_revision_signatures(self, revision_ids, gpg_strategy):
 
1149
        """Verify revision signatures for a number of revisions.
 
1150
 
 
1151
        :param revision_id: the revision to verify
 
1152
        :gpg_strategy: the GPGStrategy object to used
 
1153
        :return: Iterator over tuples with revision id, result and keys
 
1154
        """
 
1155
        for revid in revision_ids:
 
1156
            (result, key) = self.verify_revision_signature(revid, gpg_strategy)
 
1157
            yield revid, result, key
 
1158
 
2695
1159
    def has_signature_for_revision_id(self, revision_id):
2696
1160
        """Query for a revision signature for revision_id in the repository."""
2697
 
        if not self.has_revision(revision_id):
2698
 
            raise errors.NoSuchRevision(self, revision_id)
2699
 
        sig_present = (1 == len(
2700
 
            self.signatures.get_parent_map([(revision_id,)])))
2701
 
        return sig_present
 
1161
        raise NotImplementedError(self.has_signature_for_revision_id)
2702
1162
 
2703
 
    @needs_read_lock
2704
1163
    def get_signature_text(self, revision_id):
2705
1164
        """Return the text for a signature."""
2706
 
        stream = self.signatures.get_record_stream([(revision_id,)],
2707
 
            'unordered', True)
2708
 
        record = stream.next()
2709
 
        if record.storage_kind == 'absent':
2710
 
            raise errors.NoSuchRevision(self, revision_id)
2711
 
        return record.get_bytes_as('fulltext')
 
1165
        raise NotImplementedError(self.get_signature_text)
2712
1166
 
2713
 
    @needs_read_lock
2714
1167
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
2715
1168
        """Check consistency of all history of given revision_ids.
2716
1169
 
2724
1177
        :param check_repo: If False do not check the repository contents, just 
2725
1178
            calculate the data callback_refs requires and call them back.
2726
1179
        """
2727
 
        return self._check(revision_ids, callback_refs=callback_refs,
 
1180
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
2728
1181
            check_repo=check_repo)
2729
1182
 
2730
 
    def _check(self, revision_ids, callback_refs, check_repo):
2731
 
        result = check.Check(self, check_repo=check_repo)
2732
 
        result.check(callback_refs)
2733
 
        return result
 
1183
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1184
        raise NotImplementedError(self.check)
2734
1185
 
2735
1186
    def _warn_if_deprecated(self, branch=None):
2736
1187
        if not self._format.is_deprecated():
2740
1191
            return
2741
1192
        try:
2742
1193
            if branch is None:
2743
 
                conf = config.GlobalConfig()
 
1194
                conf = config.GlobalStack()
2744
1195
            else:
2745
 
                conf = branch.get_config()
2746
 
            if conf.suppress_warning('format_deprecation'):
 
1196
                conf = branch.get_config_stack()
 
1197
            if 'format_deprecation' in conf.get('suppress_warnings'):
2747
1198
                return
2748
1199
            warning("Format %s for %s is deprecated -"
2749
1200
                    " please use 'bzr upgrade' to get better performance"
2770
1221
                except UnicodeDecodeError:
2771
1222
                    raise errors.NonAsciiRevisionId(method, self)
2772
1223
 
2773
 
    def revision_graph_can_have_wrong_parents(self):
2774
 
        """Is it possible for this repository to have a revision graph with
2775
 
        incorrect parents?
2776
 
 
2777
 
        If True, then this repository must also implement
2778
 
        _find_inconsistent_revision_parents so that check and reconcile can
2779
 
        check for inconsistencies before proceeding with other checks that may
2780
 
        depend on the revision index being consistent.
2781
 
        """
2782
 
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2783
 
 
2784
 
 
2785
 
def install_revision(repository, rev, revision_tree):
2786
 
    """Install all revision data into a repository."""
2787
 
    install_revisions(repository, [(rev, revision_tree, None)])
2788
 
 
2789
 
 
2790
 
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2791
 
    """Install all revision data into a repository.
2792
 
 
2793
 
    Accepts an iterable of revision, tree, signature tuples.  The signature
2794
 
    may be None.
2795
 
    """
2796
 
    repository.start_write_group()
2797
 
    try:
2798
 
        inventory_cache = lru_cache.LRUCache(10)
2799
 
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2800
 
            _install_revision(repository, revision, revision_tree, signature,
2801
 
                inventory_cache)
2802
 
            if pb is not None:
2803
 
                pb.update('Transferring revisions', n + 1, num_revisions)
2804
 
    except:
2805
 
        repository.abort_write_group()
2806
 
        raise
2807
 
    else:
2808
 
        repository.commit_write_group()
2809
 
 
2810
 
 
2811
 
def _install_revision(repository, rev, revision_tree, signature,
2812
 
    inventory_cache):
2813
 
    """Install all revision data into a repository."""
2814
 
    present_parents = []
2815
 
    parent_trees = {}
2816
 
    for p_id in rev.parent_ids:
2817
 
        if repository.has_revision(p_id):
2818
 
            present_parents.append(p_id)
2819
 
            parent_trees[p_id] = repository.revision_tree(p_id)
2820
 
        else:
2821
 
            parent_trees[p_id] = repository.revision_tree(
2822
 
                                     _mod_revision.NULL_REVISION)
2823
 
 
2824
 
    inv = revision_tree.inventory
2825
 
    entries = inv.iter_entries()
2826
 
    # backwards compatibility hack: skip the root id.
2827
 
    if not repository.supports_rich_root():
2828
 
        path, root = entries.next()
2829
 
        if root.revision != rev.revision_id:
2830
 
            raise errors.IncompatibleRevision(repr(repository))
2831
 
    text_keys = {}
2832
 
    for path, ie in entries:
2833
 
        text_keys[(ie.file_id, ie.revision)] = ie
2834
 
    text_parent_map = repository.texts.get_parent_map(text_keys)
2835
 
    missing_texts = set(text_keys) - set(text_parent_map)
2836
 
    # Add the texts that are not already present
2837
 
    for text_key in missing_texts:
2838
 
        ie = text_keys[text_key]
2839
 
        text_parents = []
2840
 
        # FIXME: TODO: The following loop overlaps/duplicates that done by
2841
 
        # commit to determine parents. There is a latent/real bug here where
2842
 
        # the parents inserted are not those commit would do - in particular
2843
 
        # they are not filtered by heads(). RBC, AB
2844
 
        for revision, tree in parent_trees.iteritems():
2845
 
            if ie.file_id not in tree:
2846
 
                continue
2847
 
            parent_id = tree.inventory[ie.file_id].revision
2848
 
            if parent_id in text_parents:
2849
 
                continue
2850
 
            text_parents.append((ie.file_id, parent_id))
2851
 
        lines = revision_tree.get_file(ie.file_id).readlines()
2852
 
        repository.texts.add_lines(text_key, text_parents, lines)
2853
 
    try:
2854
 
        # install the inventory
2855
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2856
 
            # Cache this inventory
2857
 
            inventory_cache[rev.revision_id] = inv
2858
 
            try:
2859
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2860
 
            except KeyError:
2861
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2862
 
            else:
2863
 
                delta = inv._make_delta(basis_inv)
2864
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2865
 
                    rev.revision_id, present_parents)
2866
 
        else:
2867
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
2868
 
    except errors.RevisionAlreadyPresent:
2869
 
        pass
2870
 
    if signature is not None:
2871
 
        repository.add_signature_text(rev.revision_id, signature)
2872
 
    repository.add_revision(rev.revision_id, rev, inv)
2873
 
 
2874
1224
 
2875
1225
class MetaDirRepository(Repository):
2876
1226
    """Repositories in the new meta-dir layout.
2910
1260
        """Returns the policy for making working trees on new branches."""
2911
1261
        return not self._transport.has('no-working-trees')
2912
1262
 
2913
 
 
2914
 
class MetaDirVersionedFileRepository(MetaDirRepository):
2915
 
    """Repositories in a meta-dir, that work via versioned file objects."""
2916
 
 
2917
 
    def __init__(self, _format, a_bzrdir, control_files):
2918
 
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2919
 
            control_files)
 
1263
    @needs_write_lock
 
1264
    def update_feature_flags(self, updated_flags):
 
1265
        """Update the feature flags for this branch.
 
1266
 
 
1267
        :param updated_flags: Dictionary mapping feature names to necessities
 
1268
            A necessity can be None to indicate the feature should be removed
 
1269
        """
 
1270
        self._format._update_feature_flags(updated_flags)
 
1271
        self.control_transport.put_bytes('format', self._format.as_string())
2920
1272
 
2921
1273
 
2922
1274
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
2924
1276
 
2925
1277
    def get_default(self):
2926
1278
        """Return the current default format."""
2927
 
        from bzrlib import bzrdir
2928
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
1279
        return controldir.format_registry.make_bzrdir('default').repository_format
2929
1280
 
2930
1281
 
2931
1282
network_format_registry = registry.FormatRegistry()
2974
1325
    created.
2975
1326
 
2976
1327
    Common instance attributes:
2977
 
    _matchingbzrdir - the bzrdir format that the repository format was
 
1328
    _matchingbzrdir - the controldir format that the repository format was
2978
1329
    originally written to work with. This can be used if manually
2979
1330
    constructing a bzrdir and repository, or more commonly for test suite
2980
1331
    parameterization.
2989
1340
    # Does this format support CHK bytestring lookups. Set to True or False in
2990
1341
    # derived classes.
2991
1342
    supports_chks = None
2992
 
    # Should commit add an inventory, or an inventory delta to the repository.
2993
 
    _commit_inv_deltas = True
2994
 
    # What order should fetch operations request streams in?
2995
 
    # The default is unordered as that is the cheapest for an origin to
2996
 
    # provide.
2997
 
    _fetch_order = 'unordered'
2998
 
    # Does this repository format use deltas that can be fetched as-deltas ?
2999
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3000
 
    # We default to False, which will ensure that enough data to get
3001
 
    # a full text out of any fetch stream will be grabbed.
3002
 
    _fetch_uses_deltas = False
3003
1343
    # Should fetch trigger a reconcile after the fetch? Only needed for
3004
1344
    # some repository formats that can suffer internal inconsistencies.
3005
1345
    _fetch_reconcile = False
3011
1351
    # help), and for fetching when data won't have come from the same
3012
1352
    # compressor.
3013
1353
    pack_compresses = False
3014
 
    # Does the repository inventory storage understand references to trees?
 
1354
    # Does the repository storage understand references to trees?
3015
1355
    supports_tree_reference = None
3016
1356
    # Is the format experimental ?
3017
1357
    experimental = False
3018
 
    # Does this repository format escape funky characters, or does it create files with
3019
 
    # similar names as the versioned files in its contents on disk ?
3020
 
    supports_funky_characters = True
 
1358
    # Does this repository format escape funky characters, or does it create
 
1359
    # files with similar names as the versioned files in its contents on disk
 
1360
    # ?
 
1361
    supports_funky_characters = None
3021
1362
    # Does this repository format support leaving locks?
3022
 
    supports_leaving_lock = True
 
1363
    supports_leaving_lock = None
 
1364
    # Does this format support the full VersionedFiles interface?
 
1365
    supports_full_versioned_files = None
 
1366
    # Does this format support signing revision signatures?
 
1367
    supports_revision_signatures = True
 
1368
    # Can the revision graph have incorrect parents?
 
1369
    revision_graph_can_have_wrong_parents = None
 
1370
    # Does this format support rich root data?
 
1371
    rich_root_data = None
 
1372
    # Does this format support explicitly versioned directories?
 
1373
    supports_versioned_directories = None
 
1374
    # Can other repositories be nested into one of this format?
 
1375
    supports_nesting_repositories = None
 
1376
    # Is it possible for revisions to be present without being referenced
 
1377
    # somewhere ?
 
1378
    supports_unreferenced_revisions = None
3023
1379
 
3024
1380
    def __repr__(self):
3025
1381
        return "%s()" % self.__class__.__name__
3031
1387
    def __ne__(self, other):
3032
1388
        return not self == other
3033
1389
 
3034
 
    @classmethod
3035
 
    def find_format(klass, a_bzrdir):
3036
 
        """Return the format for the repository object in a_bzrdir.
3037
 
 
3038
 
        This is used by bzr native formats that have a "format" file in
3039
 
        the repository.  Other methods may be used by different types of
3040
 
        control directory.
3041
 
        """
3042
 
        try:
3043
 
            transport = a_bzrdir.get_repository_transport(None)
3044
 
            format_string = transport.get_bytes("format")
3045
 
            return format_registry.get(format_string)
3046
 
        except errors.NoSuchFile:
3047
 
            raise errors.NoRepositoryPresent(a_bzrdir)
3048
 
        except KeyError:
3049
 
            raise errors.UnknownFormatError(format=format_string,
3050
 
                                            kind='repository')
3051
 
 
3052
 
    @classmethod
3053
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3054
 
    def register_format(klass, format):
3055
 
        format_registry.register(format)
3056
 
 
3057
 
    @classmethod
3058
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3059
 
    def unregister_format(klass, format):
3060
 
        format_registry.remove(format)
3061
 
 
3062
 
    @classmethod
3063
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3064
 
    def get_default_format(klass):
3065
 
        """Return the current default format."""
3066
 
        return format_registry.get_default()
3067
 
 
3068
 
    def get_format_string(self):
3069
 
        """Return the ASCII format string that identifies this format.
3070
 
 
3071
 
        Note that in pre format ?? repositories the format string is
3072
 
        not permitted nor written to disk.
3073
 
        """
3074
 
        raise NotImplementedError(self.get_format_string)
3075
 
 
3076
1390
    def get_format_description(self):
3077
1391
        """Return the short description for this format."""
3078
1392
        raise NotImplementedError(self.get_format_description)
3079
1393
 
3080
 
    # TODO: this shouldn't be in the base class, it's specific to things that
3081
 
    # use weaves or knits -- mbp 20070207
3082
 
    def _get_versioned_file_store(self,
3083
 
                                  name,
3084
 
                                  transport,
3085
 
                                  control_files,
3086
 
                                  prefixed=True,
3087
 
                                  versionedfile_class=None,
3088
 
                                  versionedfile_kwargs={},
3089
 
                                  escaped=False):
3090
 
        if versionedfile_class is None:
3091
 
            versionedfile_class = self._versionedfile_class
3092
 
        weave_transport = control_files._transport.clone(name)
3093
 
        dir_mode = control_files._dir_mode
3094
 
        file_mode = control_files._file_mode
3095
 
        return VersionedFileStore(weave_transport, prefixed=prefixed,
3096
 
                                  dir_mode=dir_mode,
3097
 
                                  file_mode=file_mode,
3098
 
                                  versionedfile_class=versionedfile_class,
3099
 
                                  versionedfile_kwargs=versionedfile_kwargs,
3100
 
                                  escaped=escaped)
3101
 
 
3102
 
    def initialize(self, a_bzrdir, shared=False):
3103
 
        """Initialize a repository of this format in a_bzrdir.
3104
 
 
3105
 
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
1394
    def initialize(self, controldir, shared=False):
 
1395
        """Initialize a repository of this format in controldir.
 
1396
 
 
1397
        :param controldir: The controldir to put the new repository in it.
3106
1398
        :param shared: The repository should be initialized as a sharable one.
3107
1399
        :returns: The new repository object.
3108
1400
 
3109
1401
        This may raise UninitializableFormat if shared repository are not
3110
 
        compatible the a_bzrdir.
 
1402
        compatible the controldir.
3111
1403
        """
3112
1404
        raise NotImplementedError(self.initialize)
3113
1405
 
3149
1441
                'Does not support nested trees', target_format,
3150
1442
                from_format=self)
3151
1443
 
3152
 
    def open(self, a_bzrdir, _found=False):
3153
 
        """Return an instance of this format for the bzrdir a_bzrdir.
 
1444
    def open(self, controldir, _found=False):
 
1445
        """Return an instance of this format for a controldir.
3154
1446
 
3155
1447
        _found is a private parameter, do not use it.
3156
1448
        """
3157
1449
        raise NotImplementedError(self.open)
3158
1450
 
3159
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3160
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3161
 
        hooks = BzrDir.hooks['post_repo_init']
 
1451
    def _run_post_repo_init_hooks(self, repository, controldir, shared):
 
1452
        from bzrlib.controldir import ControlDir, RepoInitHookParams
 
1453
        hooks = ControlDir.hooks['post_repo_init']
3162
1454
        if not hooks:
3163
1455
            return
3164
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
 
1456
        params = RepoInitHookParams(repository, self, controldir, shared)
3165
1457
        for hook in hooks:
3166
1458
            hook(params)
3167
1459
 
3168
1460
 
3169
 
class MetaDirRepositoryFormat(RepositoryFormat):
 
1461
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
3170
1462
    """Common base class for the new repositories using the metadir layout."""
3171
1463
 
3172
1464
    rich_root_data = False
3173
1465
    supports_tree_reference = False
3174
1466
    supports_external_lookups = False
3175
1467
    supports_leaving_lock = True
 
1468
    supports_nesting_repositories = True
3176
1469
 
3177
1470
    @property
3178
1471
    def _matchingbzrdir(self):
3181
1474
        return matching
3182
1475
 
3183
1476
    def __init__(self):
3184
 
        super(MetaDirRepositoryFormat, self).__init__()
 
1477
        RepositoryFormat.__init__(self)
 
1478
        bzrdir.BzrFormat.__init__(self)
3185
1479
 
3186
1480
    def _create_control_files(self, a_bzrdir):
3187
1481
        """Create the required files and the initial control_files object."""
3211
1505
        finally:
3212
1506
            control_files.unlock()
3213
1507
 
3214
 
    def network_name(self):
3215
 
        """Metadir formats have matching disk and network format strings."""
3216
 
        return self.get_format_string()
3217
 
 
3218
 
 
3219
 
# Pre-0.8 formats that don't have a disk format string (because they are
3220
 
# versioned by the matching control directory). We use the control directories
3221
 
# disk format string as a key for the network_name because they meet the
3222
 
# constraints (simple string, unique, immutable).
3223
 
network_format_registry.register_lazy(
3224
 
    "Bazaar-NG branch, format 5\n",
3225
 
    'bzrlib.repofmt.weaverepo',
3226
 
    'RepositoryFormat5',
3227
 
)
3228
 
network_format_registry.register_lazy(
3229
 
    "Bazaar-NG branch, format 6\n",
3230
 
    'bzrlib.repofmt.weaverepo',
3231
 
    'RepositoryFormat6',
3232
 
)
3233
 
 
3234
 
format_registry.register_extra_lazy(
3235
 
    'bzrlib.repofmt.weaverepo',
3236
 
    'RepositoryFormat4')
3237
 
format_registry.register_extra_lazy(
3238
 
    'bzrlib.repofmt.weaverepo',
3239
 
    'RepositoryFormat5')
3240
 
format_registry.register_extra_lazy(
3241
 
    'bzrlib.repofmt.weaverepo',
3242
 
    'RepositoryFormat6')
 
1508
    @classmethod
 
1509
    def find_format(klass, a_bzrdir):
 
1510
        """Return the format for the repository object in a_bzrdir.
 
1511
 
 
1512
        This is used by bzr native formats that have a "format" file in
 
1513
        the repository.  Other methods may be used by different types of
 
1514
        control directory.
 
1515
        """
 
1516
        try:
 
1517
            transport = a_bzrdir.get_repository_transport(None)
 
1518
            format_string = transport.get_bytes("format")
 
1519
        except errors.NoSuchFile:
 
1520
            raise errors.NoRepositoryPresent(a_bzrdir)
 
1521
        return klass._find_format(format_registry, 'repository', format_string)
 
1522
 
 
1523
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1524
            basedir=None):
 
1525
        RepositoryFormat.check_support_status(self,
 
1526
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1527
            basedir=basedir)
 
1528
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1529
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
1530
 
3243
1531
 
3244
1532
# formats which have no format string are not discoverable or independently
3245
1533
# creatable on disk, so are not registered in format_registry.  They're
3246
 
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3247
 
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
1534
# all in bzrlib.repofmt.knitreponow.  When an instance of one of these is
 
1535
# needed, it's constructed directly by the ControlDir.  Non-native formats where
3248
1536
# the repository is not separately opened are similar.
3249
1537
 
3250
1538
format_registry.register_lazy(
3251
 
    'Bazaar-NG Repository format 7',
3252
 
    'bzrlib.repofmt.weaverepo',
3253
 
    'RepositoryFormat7'
3254
 
    )
3255
 
 
3256
 
format_registry.register_lazy(
3257
1539
    'Bazaar-NG Knit Repository Format 1',
3258
1540
    'bzrlib.repofmt.knitrepo',
3259
1541
    'RepositoryFormatKnit1',
3276
1558
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
3277
1559
format_registry.register_lazy(
3278
1560
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3279
 
    'bzrlib.repofmt.pack_repo',
 
1561
    'bzrlib.repofmt.knitpack_repo',
3280
1562
    'RepositoryFormatKnitPack1',
3281
1563
    )
3282
1564
format_registry.register_lazy(
3283
1565
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
3284
 
    'bzrlib.repofmt.pack_repo',
 
1566
    'bzrlib.repofmt.knitpack_repo',
3285
1567
    'RepositoryFormatKnitPack3',
3286
1568
    )
3287
1569
format_registry.register_lazy(
3288
1570
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
3289
 
    'bzrlib.repofmt.pack_repo',
 
1571
    'bzrlib.repofmt.knitpack_repo',
3290
1572
    'RepositoryFormatKnitPack4',
3291
1573
    )
3292
1574
format_registry.register_lazy(
3293
1575
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
3294
 
    'bzrlib.repofmt.pack_repo',
 
1576
    'bzrlib.repofmt.knitpack_repo',
3295
1577
    'RepositoryFormatKnitPack5',
3296
1578
    )
3297
1579
format_registry.register_lazy(
3298
1580
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
3299
 
    'bzrlib.repofmt.pack_repo',
 
1581
    'bzrlib.repofmt.knitpack_repo',
3300
1582
    'RepositoryFormatKnitPack5RichRoot',
3301
1583
    )
3302
1584
format_registry.register_lazy(
3303
1585
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
3304
 
    'bzrlib.repofmt.pack_repo',
 
1586
    'bzrlib.repofmt.knitpack_repo',
3305
1587
    'RepositoryFormatKnitPack5RichRootBroken',
3306
1588
    )
3307
1589
format_registry.register_lazy(
3308
1590
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3309
 
    'bzrlib.repofmt.pack_repo',
 
1591
    'bzrlib.repofmt.knitpack_repo',
3310
1592
    'RepositoryFormatKnitPack6',
3311
1593
    )
3312
1594
format_registry.register_lazy(
3313
1595
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3314
 
    'bzrlib.repofmt.pack_repo',
 
1596
    'bzrlib.repofmt.knitpack_repo',
3315
1597
    'RepositoryFormatKnitPack6RichRoot',
3316
1598
    )
3317
1599
format_registry.register_lazy(
3325
1607
format_registry.register_lazy(
3326
1608
    ("Bazaar development format 2 with subtree support "
3327
1609
        "(needs bzr.dev from before 1.8)\n"),
3328
 
    'bzrlib.repofmt.pack_repo',
 
1610
    'bzrlib.repofmt.knitpack_repo',
3329
1611
    'RepositoryFormatPackDevelopment2Subtree',
3330
1612
    )
3331
1613
format_registry.register_lazy(
3347
1629
    InterRepository.get(other).method_name(parameters).
3348
1630
    """
3349
1631
 
3350
 
    _walk_to_common_revisions_batch_size = 50
3351
1632
    _optimisers = []
3352
1633
    """The available optimised InterRepository types."""
3353
1634
 
3368
1649
        self.target.fetch(self.source, revision_id=revision_id)
3369
1650
 
3370
1651
    @needs_write_lock
3371
 
    def fetch(self, revision_id=None, find_ghosts=False,
3372
 
            fetch_spec=None):
 
1652
    def fetch(self, revision_id=None, find_ghosts=False):
3373
1653
        """Fetch the content required to construct revision_id.
3374
1654
 
3375
1655
        The content is copied from self.source to self.target.
3378
1658
                            content is copied.
3379
1659
        :return: None.
3380
1660
        """
3381
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3382
 
        from bzrlib.fetch import RepoFetcher
3383
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3384
 
        if self.source._format.network_name() != self.target._format.network_name():
3385
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3386
 
                from_format=self.source._format,
3387
 
                to_format=self.target._format)
3388
 
        f = RepoFetcher(to_repository=self.target,
3389
 
                               from_repository=self.source,
3390
 
                               last_revision=revision_id,
3391
 
                               fetch_spec=fetch_spec,
3392
 
                               find_ghosts=find_ghosts)
3393
 
 
3394
 
    def _walk_to_common_revisions(self, revision_ids, if_present_ids=None):
3395
 
        """Walk out from revision_ids in source to revisions target has.
3396
 
 
3397
 
        :param revision_ids: The start point for the search.
3398
 
        :return: A set of revision ids.
3399
 
        """
3400
 
        target_graph = self.target.get_graph()
3401
 
        revision_ids = frozenset(revision_ids)
3402
 
        if if_present_ids:
3403
 
            all_wanted_revs = revision_ids.union(if_present_ids)
3404
 
        else:
3405
 
            all_wanted_revs = revision_ids
3406
 
        missing_revs = set()
3407
 
        source_graph = self.source.get_graph()
3408
 
        # ensure we don't pay silly lookup costs.
3409
 
        searcher = source_graph._make_breadth_first_searcher(all_wanted_revs)
3410
 
        null_set = frozenset([_mod_revision.NULL_REVISION])
3411
 
        searcher_exhausted = False
3412
 
        while True:
3413
 
            next_revs = set()
3414
 
            ghosts = set()
3415
 
            # Iterate the searcher until we have enough next_revs
3416
 
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
3417
 
                try:
3418
 
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
3419
 
                    next_revs.update(next_revs_part)
3420
 
                    ghosts.update(ghosts_part)
3421
 
                except StopIteration:
3422
 
                    searcher_exhausted = True
3423
 
                    break
3424
 
            # If there are ghosts in the source graph, and the caller asked for
3425
 
            # them, make sure that they are present in the target.
3426
 
            # We don't care about other ghosts as we can't fetch them and
3427
 
            # haven't been asked to.
3428
 
            ghosts_to_check = set(revision_ids.intersection(ghosts))
3429
 
            revs_to_get = set(next_revs).union(ghosts_to_check)
3430
 
            if revs_to_get:
3431
 
                have_revs = set(target_graph.get_parent_map(revs_to_get))
3432
 
                # we always have NULL_REVISION present.
3433
 
                have_revs = have_revs.union(null_set)
3434
 
                # Check if the target is missing any ghosts we need.
3435
 
                ghosts_to_check.difference_update(have_revs)
3436
 
                if ghosts_to_check:
3437
 
                    # One of the caller's revision_ids is a ghost in both the
3438
 
                    # source and the target.
3439
 
                    raise errors.NoSuchRevision(
3440
 
                        self.source, ghosts_to_check.pop())
3441
 
                missing_revs.update(next_revs - have_revs)
3442
 
                # Because we may have walked past the original stop point, make
3443
 
                # sure everything is stopped
3444
 
                stop_revs = searcher.find_seen_ancestors(have_revs)
3445
 
                searcher.stop_searching_any(stop_revs)
3446
 
            if searcher_exhausted:
3447
 
                break
3448
 
        return searcher.get_result()
 
1661
        raise NotImplementedError(self.fetch)
3449
1662
 
3450
1663
    @needs_read_lock
3451
1664
    def search_missing_revision_ids(self,
3452
1665
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
3453
 
            find_ghosts=True, revision_ids=None, if_present_ids=None):
 
1666
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
1667
            limit=None):
3454
1668
        """Return the revision ids that source has that target does not.
3455
1669
 
3456
1670
        :param revision_id: only return revision ids included by this
3464
1678
            to fetch for tags, which may reference absent revisions.
3465
1679
        :param find_ghosts: If True find missing revisions in deep history
3466
1680
            rather than just finding the surface difference.
 
1681
        :param limit: Maximum number of revisions to return, topologically
 
1682
            ordered
3467
1683
        :return: A bzrlib.graph.SearchResult.
3468
1684
        """
3469
 
        if symbol_versioning.deprecated_passed(revision_id):
3470
 
            symbol_versioning.warn(
3471
 
                'search_missing_revision_ids(revision_id=...) was '
3472
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
3473
 
                DeprecationWarning, stacklevel=2)
3474
 
            if revision_ids is not None:
3475
 
                raise AssertionError(
3476
 
                    'revision_ids is mutually exclusive with revision_id')
3477
 
            if revision_id is not None:
3478
 
                revision_ids = [revision_id]
3479
 
        del revision_id
3480
 
        # stop searching at found target revisions.
3481
 
        if not find_ghosts and (revision_ids is not None or if_present_ids is
3482
 
                not None):
3483
 
            return self._walk_to_common_revisions(revision_ids,
3484
 
                    if_present_ids=if_present_ids)
3485
 
        # generic, possibly worst case, slow code path.
3486
 
        target_ids = set(self.target.all_revision_ids())
3487
 
        source_ids = self._present_source_revisions_for(
3488
 
            revision_ids, if_present_ids)
3489
 
        result_set = set(source_ids).difference(target_ids)
3490
 
        return self.source.revision_ids_to_search_result(result_set)
3491
 
 
3492
 
    def _present_source_revisions_for(self, revision_ids, if_present_ids=None):
3493
 
        """Returns set of all revisions in ancestry of revision_ids present in
3494
 
        the source repo.
3495
 
 
3496
 
        :param revision_ids: if None, all revisions in source are returned.
3497
 
        :param if_present_ids: like revision_ids, but if any/all of these are
3498
 
            absent no error is raised.
3499
 
        """
3500
 
        if revision_ids is not None or if_present_ids is not None:
3501
 
            # First, ensure all specified revisions exist.  Callers expect
3502
 
            # NoSuchRevision when they pass absent revision_ids here.
3503
 
            if revision_ids is None:
3504
 
                revision_ids = set()
3505
 
            if if_present_ids is None:
3506
 
                if_present_ids = set()
3507
 
            revision_ids = set(revision_ids)
3508
 
            if_present_ids = set(if_present_ids)
3509
 
            all_wanted_ids = revision_ids.union(if_present_ids)
3510
 
            graph = self.source.get_graph()
3511
 
            present_revs = set(graph.get_parent_map(all_wanted_ids))
3512
 
            missing = revision_ids.difference(present_revs)
3513
 
            if missing:
3514
 
                raise errors.NoSuchRevision(self.source, missing.pop())
3515
 
            found_ids = all_wanted_ids.intersection(present_revs)
3516
 
            source_ids = [rev_id for (rev_id, parents) in
3517
 
                          graph.iter_ancestry(found_ids)
3518
 
                          if rev_id != _mod_revision.NULL_REVISION
3519
 
                          and parents is not None]
3520
 
        else:
3521
 
            source_ids = self.source.all_revision_ids()
3522
 
        return set(source_ids)
 
1685
        raise NotImplementedError(self.search_missing_revision_ids)
3523
1686
 
3524
1687
    @staticmethod
3525
1688
    def _same_model(source, target):
3546
1709
                "different serializers")
3547
1710
 
3548
1711
 
3549
 
class InterSameDataRepository(InterRepository):
3550
 
    """Code for converting between repositories that represent the same data.
3551
 
 
3552
 
    Data format and model must match for this to work.
3553
 
    """
3554
 
 
3555
 
    @classmethod
3556
 
    def _get_repo_format_to_test(self):
3557
 
        """Repository format for testing with.
3558
 
 
3559
 
        InterSameData can pull from subtree to subtree and from non-subtree to
3560
 
        non-subtree, so we test this with the richest repository format.
3561
 
        """
3562
 
        from bzrlib.repofmt import knitrepo
3563
 
        return knitrepo.RepositoryFormatKnit3()
3564
 
 
3565
 
    @staticmethod
3566
 
    def is_compatible(source, target):
3567
 
        return InterRepository._same_model(source, target)
3568
 
 
3569
 
 
3570
 
class InterDifferingSerializer(InterRepository):
3571
 
 
3572
 
    @classmethod
3573
 
    def _get_repo_format_to_test(self):
3574
 
        return None
3575
 
 
3576
 
    @staticmethod
3577
 
    def is_compatible(source, target):
3578
 
        """Be compatible with Knit2 source and Knit3 target"""
3579
 
        # This is redundant with format.check_conversion_target(), however that
3580
 
        # raises an exception, and we just want to say "False" as in we won't
3581
 
        # support converting between these formats.
3582
 
        if 'IDS_never' in debug.debug_flags:
3583
 
            return False
3584
 
        if source.supports_rich_root() and not target.supports_rich_root():
3585
 
            return False
3586
 
        if (source._format.supports_tree_reference
3587
 
            and not target._format.supports_tree_reference):
3588
 
            return False
3589
 
        if target._fallback_repositories and target._format.supports_chks:
3590
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3591
 
            # adds to stacked repos.
3592
 
            return False
3593
 
        if 'IDS_always' in debug.debug_flags:
3594
 
            return True
3595
 
        # Only use this code path for local source and target.  IDS does far
3596
 
        # too much IO (both bandwidth and roundtrips) over a network.
3597
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3598
 
            return False
3599
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3600
 
            return False
3601
 
        return True
3602
 
 
3603
 
    def _get_trees(self, revision_ids, cache):
3604
 
        possible_trees = []
3605
 
        for rev_id in revision_ids:
3606
 
            if rev_id in cache:
3607
 
                possible_trees.append((rev_id, cache[rev_id]))
3608
 
            else:
3609
 
                # Not cached, but inventory might be present anyway.
3610
 
                try:
3611
 
                    tree = self.source.revision_tree(rev_id)
3612
 
                except errors.NoSuchRevision:
3613
 
                    # Nope, parent is ghost.
3614
 
                    pass
3615
 
                else:
3616
 
                    cache[rev_id] = tree
3617
 
                    possible_trees.append((rev_id, tree))
3618
 
        return possible_trees
3619
 
 
3620
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3621
 
        """Get the best delta and base for this revision.
3622
 
 
3623
 
        :return: (basis_id, delta)
3624
 
        """
3625
 
        deltas = []
3626
 
        # Generate deltas against each tree, to find the shortest.
3627
 
        texts_possibly_new_in_tree = set()
3628
 
        for basis_id, basis_tree in possible_trees:
3629
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3630
 
            for old_path, new_path, file_id, new_entry in delta:
3631
 
                if new_path is None:
3632
 
                    # This file_id isn't present in the new rev, so we don't
3633
 
                    # care about it.
3634
 
                    continue
3635
 
                if not new_path:
3636
 
                    # Rich roots are handled elsewhere...
3637
 
                    continue
3638
 
                kind = new_entry.kind
3639
 
                if kind != 'directory' and kind != 'file':
3640
 
                    # No text record associated with this inventory entry.
3641
 
                    continue
3642
 
                # This is a directory or file that has changed somehow.
3643
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3644
 
            deltas.append((len(delta), basis_id, delta))
3645
 
        deltas.sort()
3646
 
        return deltas[0][1:]
3647
 
 
3648
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3649
 
        """Find all parent revisions that are absent, but for which the
3650
 
        inventory is present, and copy those inventories.
3651
 
 
3652
 
        This is necessary to preserve correctness when the source is stacked
3653
 
        without fallbacks configured.  (Note that in cases like upgrade the
3654
 
        source may be not have _fallback_repositories even though it is
3655
 
        stacked.)
3656
 
        """
3657
 
        parent_revs = set()
3658
 
        for parents in parent_map.values():
3659
 
            parent_revs.update(parents)
3660
 
        present_parents = self.source.get_parent_map(parent_revs)
3661
 
        absent_parents = set(parent_revs).difference(present_parents)
3662
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3663
 
            (rev_id,) for rev_id in absent_parents)
3664
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3665
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3666
 
            current_revision_id = parent_tree.get_revision_id()
3667
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3668
 
                (current_revision_id,)]
3669
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3670
 
            basis_id = _mod_revision.NULL_REVISION
3671
 
            basis_tree = self.source.revision_tree(basis_id)
3672
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3673
 
            self.target.add_inventory_by_delta(
3674
 
                basis_id, delta, current_revision_id, parents_parents)
3675
 
            cache[current_revision_id] = parent_tree
3676
 
 
3677
 
    def _fetch_batch(self, revision_ids, basis_id, cache):
3678
 
        """Fetch across a few revisions.
3679
 
 
3680
 
        :param revision_ids: The revisions to copy
3681
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3682
 
            as a basis for delta when no other base is available
3683
 
        :param cache: A cache of RevisionTrees that we can use.
3684
 
        :return: The revision_id of the last converted tree. The RevisionTree
3685
 
            for it will be in cache
3686
 
        """
3687
 
        # Walk though all revisions; get inventory deltas, copy referenced
3688
 
        # texts that delta references, insert the delta, revision and
3689
 
        # signature.
3690
 
        root_keys_to_create = set()
3691
 
        text_keys = set()
3692
 
        pending_deltas = []
3693
 
        pending_revisions = []
3694
 
        parent_map = self.source.get_parent_map(revision_ids)
3695
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3696
 
        self.source._safe_to_return_from_cache = True
3697
 
        for tree in self.source.revision_trees(revision_ids):
3698
 
            # Find a inventory delta for this revision.
3699
 
            # Find text entries that need to be copied, too.
3700
 
            current_revision_id = tree.get_revision_id()
3701
 
            parent_ids = parent_map.get(current_revision_id, ())
3702
 
            parent_trees = self._get_trees(parent_ids, cache)
3703
 
            possible_trees = list(parent_trees)
3704
 
            if len(possible_trees) == 0:
3705
 
                # There either aren't any parents, or the parents are ghosts,
3706
 
                # so just use the last converted tree.
3707
 
                possible_trees.append((basis_id, cache[basis_id]))
3708
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3709
 
                                                           possible_trees)
3710
 
            revision = self.source.get_revision(current_revision_id)
3711
 
            pending_deltas.append((basis_id, delta,
3712
 
                current_revision_id, revision.parent_ids))
3713
 
            if self._converting_to_rich_root:
3714
 
                self._revision_id_to_root_id[current_revision_id] = \
3715
 
                    tree.get_root_id()
3716
 
            # Determine which texts are in present in this revision but not in
3717
 
            # any of the available parents.
3718
 
            texts_possibly_new_in_tree = set()
3719
 
            for old_path, new_path, file_id, entry in delta:
3720
 
                if new_path is None:
3721
 
                    # This file_id isn't present in the new rev
3722
 
                    continue
3723
 
                if not new_path:
3724
 
                    # This is the root
3725
 
                    if not self.target.supports_rich_root():
3726
 
                        # The target doesn't support rich root, so we don't
3727
 
                        # copy
3728
 
                        continue
3729
 
                    if self._converting_to_rich_root:
3730
 
                        # This can't be copied normally, we have to insert
3731
 
                        # it specially
3732
 
                        root_keys_to_create.add((file_id, entry.revision))
3733
 
                        continue
3734
 
                kind = entry.kind
3735
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3736
 
            for basis_id, basis_tree in possible_trees:
3737
 
                basis_inv = basis_tree.inventory
3738
 
                for file_key in list(texts_possibly_new_in_tree):
3739
 
                    file_id, file_revision = file_key
3740
 
                    try:
3741
 
                        entry = basis_inv[file_id]
3742
 
                    except errors.NoSuchId:
3743
 
                        continue
3744
 
                    if entry.revision == file_revision:
3745
 
                        texts_possibly_new_in_tree.remove(file_key)
3746
 
            text_keys.update(texts_possibly_new_in_tree)
3747
 
            pending_revisions.append(revision)
3748
 
            cache[current_revision_id] = tree
3749
 
            basis_id = current_revision_id
3750
 
        self.source._safe_to_return_from_cache = False
3751
 
        # Copy file texts
3752
 
        from_texts = self.source.texts
3753
 
        to_texts = self.target.texts
3754
 
        if root_keys_to_create:
3755
 
            root_stream = _mod_fetch._new_root_data_stream(
3756
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3757
 
                self.source)
3758
 
            to_texts.insert_record_stream(root_stream)
3759
 
        to_texts.insert_record_stream(from_texts.get_record_stream(
3760
 
            text_keys, self.target._format._fetch_order,
3761
 
            not self.target._format._fetch_uses_deltas))
3762
 
        # insert inventory deltas
3763
 
        for delta in pending_deltas:
3764
 
            self.target.add_inventory_by_delta(*delta)
3765
 
        if self.target._fallback_repositories:
3766
 
            # Make sure this stacked repository has all the parent inventories
3767
 
            # for the new revisions that we are about to insert.  We do this
3768
 
            # before adding the revisions so that no revision is added until
3769
 
            # all the inventories it may depend on are added.
3770
 
            # Note that this is overzealous, as we may have fetched these in an
3771
 
            # earlier batch.
3772
 
            parent_ids = set()
3773
 
            revision_ids = set()
3774
 
            for revision in pending_revisions:
3775
 
                revision_ids.add(revision.revision_id)
3776
 
                parent_ids.update(revision.parent_ids)
3777
 
            parent_ids.difference_update(revision_ids)
3778
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3779
 
            parent_map = self.source.get_parent_map(parent_ids)
3780
 
            # we iterate over parent_map and not parent_ids because we don't
3781
 
            # want to try copying any revision which is a ghost
3782
 
            for parent_tree in self.source.revision_trees(parent_map):
3783
 
                current_revision_id = parent_tree.get_revision_id()
3784
 
                parents_parents = parent_map[current_revision_id]
3785
 
                possible_trees = self._get_trees(parents_parents, cache)
3786
 
                if len(possible_trees) == 0:
3787
 
                    # There either aren't any parents, or the parents are
3788
 
                    # ghosts, so just use the last converted tree.
3789
 
                    possible_trees.append((basis_id, cache[basis_id]))
3790
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3791
 
                    parents_parents, possible_trees)
3792
 
                self.target.add_inventory_by_delta(
3793
 
                    basis_id, delta, current_revision_id, parents_parents)
3794
 
        # insert signatures and revisions
3795
 
        for revision in pending_revisions:
3796
 
            try:
3797
 
                signature = self.source.get_signature_text(
3798
 
                    revision.revision_id)
3799
 
                self.target.add_signature_text(revision.revision_id,
3800
 
                    signature)
3801
 
            except errors.NoSuchRevision:
3802
 
                pass
3803
 
            self.target.add_revision(revision.revision_id, revision)
3804
 
        return basis_id
3805
 
 
3806
 
    def _fetch_all_revisions(self, revision_ids, pb):
3807
 
        """Fetch everything for the list of revisions.
3808
 
 
3809
 
        :param revision_ids: The list of revisions to fetch. Must be in
3810
 
            topological order.
3811
 
        :param pb: A ProgressTask
3812
 
        :return: None
3813
 
        """
3814
 
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3815
 
        batch_size = 100
3816
 
        cache = lru_cache.LRUCache(100)
3817
 
        cache[basis_id] = basis_tree
3818
 
        del basis_tree # We don't want to hang on to it here
3819
 
        hints = []
3820
 
        a_graph = None
3821
 
 
3822
 
        for offset in range(0, len(revision_ids), batch_size):
3823
 
            self.target.start_write_group()
3824
 
            try:
3825
 
                pb.update('Transferring revisions', offset,
3826
 
                          len(revision_ids))
3827
 
                batch = revision_ids[offset:offset+batch_size]
3828
 
                basis_id = self._fetch_batch(batch, basis_id, cache)
3829
 
            except:
3830
 
                self.source._safe_to_return_from_cache = False
3831
 
                self.target.abort_write_group()
3832
 
                raise
3833
 
            else:
3834
 
                hint = self.target.commit_write_group()
3835
 
                if hint:
3836
 
                    hints.extend(hint)
3837
 
        if hints and self.target._format.pack_compresses:
3838
 
            self.target.pack(hint=hints)
3839
 
        pb.update('Transferring revisions', len(revision_ids),
3840
 
                  len(revision_ids))
3841
 
 
3842
 
    @needs_write_lock
3843
 
    def fetch(self, revision_id=None, find_ghosts=False,
3844
 
            fetch_spec=None):
3845
 
        """See InterRepository.fetch()."""
3846
 
        if fetch_spec is not None:
3847
 
            revision_ids = fetch_spec.get_keys()
3848
 
        else:
3849
 
            revision_ids = None
3850
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3851
 
        if (not self.source.supports_rich_root()
3852
 
            and self.target.supports_rich_root()):
3853
 
            self._converting_to_rich_root = True
3854
 
            self._revision_id_to_root_id = {}
3855
 
        else:
3856
 
            self._converting_to_rich_root = False
3857
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3858
 
        if self.source._format.network_name() != self.target._format.network_name():
3859
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3860
 
                from_format=self.source._format,
3861
 
                to_format=self.target._format)
3862
 
        if revision_ids is None:
3863
 
            if revision_id:
3864
 
                search_revision_ids = [revision_id]
3865
 
            else:
3866
 
                search_revision_ids = None
3867
 
            revision_ids = self.target.search_missing_revision_ids(self.source,
3868
 
                revision_ids=search_revision_ids,
3869
 
                find_ghosts=find_ghosts).get_keys()
3870
 
        if not revision_ids:
3871
 
            return 0, 0
3872
 
        revision_ids = tsort.topo_sort(
3873
 
            self.source.get_graph().get_parent_map(revision_ids))
3874
 
        if not revision_ids:
3875
 
            return 0, 0
3876
 
        # Walk though all revisions; get inventory deltas, copy referenced
3877
 
        # texts that delta references, insert the delta, revision and
3878
 
        # signature.
3879
 
        pb = ui.ui_factory.nested_progress_bar()
3880
 
        try:
3881
 
            self._fetch_all_revisions(revision_ids, pb)
3882
 
        finally:
3883
 
            pb.finished()
3884
 
        return len(revision_ids), 0
3885
 
 
3886
 
    def _get_basis(self, first_revision_id):
3887
 
        """Get a revision and tree which exists in the target.
3888
 
 
3889
 
        This assumes that first_revision_id is selected for transmission
3890
 
        because all other ancestors are already present. If we can't find an
3891
 
        ancestor we fall back to NULL_REVISION since we know that is safe.
3892
 
 
3893
 
        :return: (basis_id, basis_tree)
3894
 
        """
3895
 
        first_rev = self.source.get_revision(first_revision_id)
3896
 
        try:
3897
 
            basis_id = first_rev.parent_ids[0]
3898
 
            # only valid as a basis if the target has it
3899
 
            self.target.get_revision(basis_id)
3900
 
            # Try to get a basis tree - if it's a ghost it will hit the
3901
 
            # NoSuchRevision case.
3902
 
            basis_tree = self.source.revision_tree(basis_id)
3903
 
        except (IndexError, errors.NoSuchRevision):
3904
 
            basis_id = _mod_revision.NULL_REVISION
3905
 
            basis_tree = self.source.revision_tree(basis_id)
3906
 
        return basis_id, basis_tree
3907
 
 
3908
 
 
3909
 
InterRepository.register_optimiser(InterDifferingSerializer)
3910
 
InterRepository.register_optimiser(InterSameDataRepository)
3911
 
 
3912
 
 
3913
1712
class CopyConverter(object):
3914
1713
    """A repository conversion tool which just performs a copy of the content.
3915
1714
 
3936
1735
        # trigger an assertion if not such
3937
1736
        repo._format.get_format_string()
3938
1737
        self.repo_dir = repo.bzrdir
3939
 
        pb.update('Moving repository to repository.backup')
 
1738
        pb.update(gettext('Moving repository to repository.backup'))
3940
1739
        self.repo_dir.transport.move('repository', 'repository.backup')
3941
1740
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3942
1741
        repo._format.check_conversion_target(self.target_format)
3943
1742
        self.source_repo = repo._format.open(self.repo_dir,
3944
1743
            _found=True,
3945
1744
            _override_transport=backup_transport)
3946
 
        pb.update('Creating new repository')
 
1745
        pb.update(gettext('Creating new repository'))
3947
1746
        converted = self.target_format.initialize(self.repo_dir,
3948
1747
                                                  self.source_repo.is_shared())
3949
1748
        converted.lock_write()
3950
1749
        try:
3951
 
            pb.update('Copying content')
 
1750
            pb.update(gettext('Copying content'))
3952
1751
            self.source_repo.copy_content_into(converted)
3953
1752
        finally:
3954
1753
            converted.unlock()
3955
 
        pb.update('Deleting old repository content')
 
1754
        pb.update(gettext('Deleting old repository content'))
3956
1755
        self.repo_dir.transport.delete_tree('repository.backup')
3957
 
        ui.ui_factory.note('repository converted')
 
1756
        ui.ui_factory.note(gettext('repository converted'))
3958
1757
        pb.finished()
3959
1758
 
3960
1759
 
3961
 
class _VersionedFileChecker(object):
3962
 
 
3963
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
3964
 
        self.repository = repository
3965
 
        self.text_index = self.repository._generate_text_key_index(
3966
 
            text_key_references=text_key_references, ancestors=ancestors)
3967
 
 
3968
 
    def calculate_file_version_parents(self, text_key):
3969
 
        """Calculate the correct parents for a file version according to
3970
 
        the inventories.
3971
 
        """
3972
 
        parent_keys = self.text_index[text_key]
3973
 
        if parent_keys == [_mod_revision.NULL_REVISION]:
3974
 
            return ()
3975
 
        return tuple(parent_keys)
3976
 
 
3977
 
    def check_file_version_parents(self, texts, progress_bar=None):
3978
 
        """Check the parents stored in a versioned file are correct.
3979
 
 
3980
 
        It also detects file versions that are not referenced by their
3981
 
        corresponding revision's inventory.
3982
 
 
3983
 
        :returns: A tuple of (wrong_parents, dangling_file_versions).
3984
 
            wrong_parents is a dict mapping {revision_id: (stored_parents,
3985
 
            correct_parents)} for each revision_id where the stored parents
3986
 
            are not correct.  dangling_file_versions is a set of (file_id,
3987
 
            revision_id) tuples for versions that are present in this versioned
3988
 
            file, but not used by the corresponding inventory.
3989
 
        """
3990
 
        local_progress = None
3991
 
        if progress_bar is None:
3992
 
            local_progress = ui.ui_factory.nested_progress_bar()
3993
 
            progress_bar = local_progress
3994
 
        try:
3995
 
            return self._check_file_version_parents(texts, progress_bar)
3996
 
        finally:
3997
 
            if local_progress:
3998
 
                local_progress.finished()
3999
 
 
4000
 
    def _check_file_version_parents(self, texts, progress_bar):
4001
 
        """See check_file_version_parents."""
4002
 
        wrong_parents = {}
4003
 
        self.file_ids = set([file_id for file_id, _ in
4004
 
            self.text_index.iterkeys()])
4005
 
        # text keys is now grouped by file_id
4006
 
        n_versions = len(self.text_index)
4007
 
        progress_bar.update('loading text store', 0, n_versions)
4008
 
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4009
 
        # On unlistable transports this could well be empty/error...
4010
 
        text_keys = self.repository.texts.keys()
4011
 
        unused_keys = frozenset(text_keys) - set(self.text_index)
4012
 
        for num, key in enumerate(self.text_index.iterkeys()):
4013
 
            progress_bar.update('checking text graph', num, n_versions)
4014
 
            correct_parents = self.calculate_file_version_parents(key)
4015
 
            try:
4016
 
                knit_parents = parent_map[key]
4017
 
            except errors.RevisionNotPresent:
4018
 
                # Missing text!
4019
 
                knit_parents = None
4020
 
            if correct_parents != knit_parents:
4021
 
                wrong_parents[key] = (knit_parents, correct_parents)
4022
 
        return wrong_parents, unused_keys
4023
 
 
4024
 
 
4025
 
def _old_get_graph(repository, revision_id):
4026
 
    """DO NOT USE. That is all. I'm serious."""
4027
 
    graph = repository.get_graph()
4028
 
    revision_graph = dict(((key, value) for key, value in
4029
 
        graph.iter_ancestry([revision_id]) if value is not None))
4030
 
    return _strip_NULL_ghosts(revision_graph)
4031
 
 
4032
 
 
4033
1760
def _strip_NULL_ghosts(revision_graph):
4034
1761
    """Also don't use this. more compatibility code for unmigrated clients."""
4035
1762
    # Filter ghosts, and null:
4041
1768
    return revision_graph
4042
1769
 
4043
1770
 
4044
 
class StreamSink(object):
4045
 
    """An object that can insert a stream into a repository.
4046
 
 
4047
 
    This interface handles the complexity of reserialising inventories and
4048
 
    revisions from different formats, and allows unidirectional insertion into
4049
 
    stacked repositories without looking for the missing basis parents
4050
 
    beforehand.
4051
 
    """
4052
 
 
4053
 
    def __init__(self, target_repo):
4054
 
        self.target_repo = target_repo
4055
 
 
4056
 
    def insert_stream(self, stream, src_format, resume_tokens):
4057
 
        """Insert a stream's content into the target repository.
4058
 
 
4059
 
        :param src_format: a bzr repository format.
4060
 
 
4061
 
        :return: a list of resume tokens and an  iterable of keys additional
4062
 
            items required before the insertion can be completed.
4063
 
        """
4064
 
        self.target_repo.lock_write()
4065
 
        try:
4066
 
            if resume_tokens:
4067
 
                self.target_repo.resume_write_group(resume_tokens)
4068
 
                is_resume = True
4069
 
            else:
4070
 
                self.target_repo.start_write_group()
4071
 
                is_resume = False
4072
 
            try:
4073
 
                # locked_insert_stream performs a commit|suspend.
4074
 
                missing_keys = self.insert_stream_without_locking(stream,
4075
 
                                    src_format, is_resume)
4076
 
                if missing_keys:
4077
 
                    # suspend the write group and tell the caller what we is
4078
 
                    # missing. We know we can suspend or else we would not have
4079
 
                    # entered this code path. (All repositories that can handle
4080
 
                    # missing keys can handle suspending a write group).
4081
 
                    write_group_tokens = self.target_repo.suspend_write_group()
4082
 
                    return write_group_tokens, missing_keys
4083
 
                hint = self.target_repo.commit_write_group()
4084
 
                to_serializer = self.target_repo._format._serializer
4085
 
                src_serializer = src_format._serializer
4086
 
                if (to_serializer != src_serializer and
4087
 
                    self.target_repo._format.pack_compresses):
4088
 
                    self.target_repo.pack(hint=hint)
4089
 
                return [], set()
4090
 
            except:
4091
 
                self.target_repo.abort_write_group(suppress_errors=True)
4092
 
                raise
4093
 
        finally:
4094
 
            self.target_repo.unlock()
4095
 
 
4096
 
    def insert_stream_without_locking(self, stream, src_format,
4097
 
                                      is_resume=False):
4098
 
        """Insert a stream's content into the target repository.
4099
 
 
4100
 
        This assumes that you already have a locked repository and an active
4101
 
        write group.
4102
 
 
4103
 
        :param src_format: a bzr repository format.
4104
 
        :param is_resume: Passed down to get_missing_parent_inventories to
4105
 
            indicate if we should be checking for missing texts at the same
4106
 
            time.
4107
 
 
4108
 
        :return: A set of keys that are missing.
4109
 
        """
4110
 
        if not self.target_repo.is_write_locked():
4111
 
            raise errors.ObjectNotLocked(self)
4112
 
        if not self.target_repo.is_in_write_group():
4113
 
            raise errors.BzrError('you must already be in a write group')
4114
 
        to_serializer = self.target_repo._format._serializer
4115
 
        src_serializer = src_format._serializer
4116
 
        new_pack = None
4117
 
        if to_serializer == src_serializer:
4118
 
            # If serializers match and the target is a pack repository, set the
4119
 
            # write cache size on the new pack.  This avoids poor performance
4120
 
            # on transports where append is unbuffered (such as
4121
 
            # RemoteTransport).  This is safe to do because nothing should read
4122
 
            # back from the target repository while a stream with matching
4123
 
            # serialization is being inserted.
4124
 
            # The exception is that a delta record from the source that should
4125
 
            # be a fulltext may need to be expanded by the target (see
4126
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4127
 
            # explicitly flush any buffered writes first in that rare case.
4128
 
            try:
4129
 
                new_pack = self.target_repo._pack_collection._new_pack
4130
 
            except AttributeError:
4131
 
                # Not a pack repository
4132
 
                pass
4133
 
            else:
4134
 
                new_pack.set_write_cache_size(1024*1024)
4135
 
        for substream_type, substream in stream:
4136
 
            if 'stream' in debug.debug_flags:
4137
 
                mutter('inserting substream: %s', substream_type)
4138
 
            if substream_type == 'texts':
4139
 
                self.target_repo.texts.insert_record_stream(substream)
4140
 
            elif substream_type == 'inventories':
4141
 
                if src_serializer == to_serializer:
4142
 
                    self.target_repo.inventories.insert_record_stream(
4143
 
                        substream)
4144
 
                else:
4145
 
                    self._extract_and_insert_inventories(
4146
 
                        substream, src_serializer)
4147
 
            elif substream_type == 'inventory-deltas':
4148
 
                self._extract_and_insert_inventory_deltas(
4149
 
                    substream, src_serializer)
4150
 
            elif substream_type == 'chk_bytes':
4151
 
                # XXX: This doesn't support conversions, as it assumes the
4152
 
                #      conversion was done in the fetch code.
4153
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4154
 
            elif substream_type == 'revisions':
4155
 
                # This may fallback to extract-and-insert more often than
4156
 
                # required if the serializers are different only in terms of
4157
 
                # the inventory.
4158
 
                if src_serializer == to_serializer:
4159
 
                    self.target_repo.revisions.insert_record_stream(substream)
4160
 
                else:
4161
 
                    self._extract_and_insert_revisions(substream,
4162
 
                        src_serializer)
4163
 
            elif substream_type == 'signatures':
4164
 
                self.target_repo.signatures.insert_record_stream(substream)
4165
 
            else:
4166
 
                raise AssertionError('kaboom! %s' % (substream_type,))
4167
 
        # Done inserting data, and the missing_keys calculations will try to
4168
 
        # read back from the inserted data, so flush the writes to the new pack
4169
 
        # (if this is pack format).
4170
 
        if new_pack is not None:
4171
 
            new_pack._write_data('', flush=True)
4172
 
        # Find all the new revisions (including ones from resume_tokens)
4173
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4174
 
            check_for_missing_texts=is_resume)
4175
 
        try:
4176
 
            for prefix, versioned_file in (
4177
 
                ('texts', self.target_repo.texts),
4178
 
                ('inventories', self.target_repo.inventories),
4179
 
                ('revisions', self.target_repo.revisions),
4180
 
                ('signatures', self.target_repo.signatures),
4181
 
                ('chk_bytes', self.target_repo.chk_bytes),
4182
 
                ):
4183
 
                if versioned_file is None:
4184
 
                    continue
4185
 
                # TODO: key is often going to be a StaticTuple object
4186
 
                #       I don't believe we can define a method by which
4187
 
                #       (prefix,) + StaticTuple will work, though we could
4188
 
                #       define a StaticTuple.sq_concat that would allow you to
4189
 
                #       pass in either a tuple or a StaticTuple as the second
4190
 
                #       object, so instead we could have:
4191
 
                #       StaticTuple(prefix) + key here...
4192
 
                missing_keys.update((prefix,) + key for key in
4193
 
                    versioned_file.get_missing_compression_parent_keys())
4194
 
        except NotImplementedError:
4195
 
            # cannot even attempt suspending, and missing would have failed
4196
 
            # during stream insertion.
4197
 
            missing_keys = set()
4198
 
        return missing_keys
4199
 
 
4200
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4201
 
        target_rich_root = self.target_repo._format.rich_root_data
4202
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4203
 
        for record in substream:
4204
 
            # Insert the delta directly
4205
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4206
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4207
 
            try:
4208
 
                parse_result = deserialiser.parse_text_bytes(
4209
 
                    inventory_delta_bytes)
4210
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4211
 
                trace.mutter("Incompatible delta: %s", err.msg)
4212
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4213
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4214
 
            revision_id = new_id
4215
 
            parents = [key[0] for key in record.parents]
4216
 
            self.target_repo.add_inventory_by_delta(
4217
 
                basis_id, inv_delta, revision_id, parents)
4218
 
 
4219
 
    def _extract_and_insert_inventories(self, substream, serializer,
4220
 
            parse_delta=None):
4221
 
        """Generate a new inventory versionedfile in target, converting data.
4222
 
 
4223
 
        The inventory is retrieved from the source, (deserializing it), and
4224
 
        stored in the target (reserializing it in a different format).
4225
 
        """
4226
 
        target_rich_root = self.target_repo._format.rich_root_data
4227
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4228
 
        for record in substream:
4229
 
            # It's not a delta, so it must be a fulltext in the source
4230
 
            # serializer's format.
4231
 
            bytes = record.get_bytes_as('fulltext')
4232
 
            revision_id = record.key[0]
4233
 
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4234
 
            parents = [key[0] for key in record.parents]
4235
 
            self.target_repo.add_inventory(revision_id, inv, parents)
4236
 
            # No need to keep holding this full inv in memory when the rest of
4237
 
            # the substream is likely to be all deltas.
4238
 
            del inv
4239
 
 
4240
 
    def _extract_and_insert_revisions(self, substream, serializer):
4241
 
        for record in substream:
4242
 
            bytes = record.get_bytes_as('fulltext')
4243
 
            revision_id = record.key[0]
4244
 
            rev = serializer.read_revision_from_string(bytes)
4245
 
            if rev.revision_id != revision_id:
4246
 
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4247
 
            self.target_repo.add_revision(revision_id, rev)
4248
 
 
4249
 
    def finished(self):
4250
 
        if self.target_repo._format._fetch_reconcile:
4251
 
            self.target_repo.reconcile()
4252
 
 
4253
 
 
4254
 
class StreamSource(object):
4255
 
    """A source of a stream for fetching between repositories."""
4256
 
 
4257
 
    def __init__(self, from_repository, to_format):
4258
 
        """Create a StreamSource streaming from from_repository."""
4259
 
        self.from_repository = from_repository
4260
 
        self.to_format = to_format
4261
 
        self._record_counter = RecordCounter()
4262
 
 
4263
 
    def delta_on_metadata(self):
4264
 
        """Return True if delta's are permitted on metadata streams.
4265
 
 
4266
 
        That is on revisions and signatures.
4267
 
        """
4268
 
        src_serializer = self.from_repository._format._serializer
4269
 
        target_serializer = self.to_format._serializer
4270
 
        return (self.to_format._fetch_uses_deltas and
4271
 
            src_serializer == target_serializer)
4272
 
 
4273
 
    def _fetch_revision_texts(self, revs):
4274
 
        # fetch signatures first and then the revision texts
4275
 
        # may need to be a InterRevisionStore call here.
4276
 
        from_sf = self.from_repository.signatures
4277
 
        # A missing signature is just skipped.
4278
 
        keys = [(rev_id,) for rev_id in revs]
4279
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4280
 
            keys,
4281
 
            self.to_format._fetch_order,
4282
 
            not self.to_format._fetch_uses_deltas))
4283
 
        # If a revision has a delta, this is actually expanded inside the
4284
 
        # insert_record_stream code now, which is an alternate fix for
4285
 
        # bug #261339
4286
 
        from_rf = self.from_repository.revisions
4287
 
        revisions = from_rf.get_record_stream(
4288
 
            keys,
4289
 
            self.to_format._fetch_order,
4290
 
            not self.delta_on_metadata())
4291
 
        return [('signatures', signatures), ('revisions', revisions)]
4292
 
 
4293
 
    def _generate_root_texts(self, revs):
4294
 
        """This will be called by get_stream between fetching weave texts and
4295
 
        fetching the inventory weave.
4296
 
        """
4297
 
        if self._rich_root_upgrade():
4298
 
            return _mod_fetch.Inter1and2Helper(
4299
 
                self.from_repository).generate_root_texts(revs)
4300
 
        else:
4301
 
            return []
4302
 
 
4303
 
    def get_stream(self, search):
4304
 
        phase = 'file'
4305
 
        revs = search.get_keys()
4306
 
        graph = self.from_repository.get_graph()
4307
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4308
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4309
 
        text_keys = []
4310
 
        for knit_kind, file_id, revisions in data_to_fetch:
4311
 
            if knit_kind != phase:
4312
 
                phase = knit_kind
4313
 
                # Make a new progress bar for this phase
4314
 
            if knit_kind == "file":
4315
 
                # Accumulate file texts
4316
 
                text_keys.extend([(file_id, revision) for revision in
4317
 
                    revisions])
4318
 
            elif knit_kind == "inventory":
4319
 
                # Now copy the file texts.
4320
 
                from_texts = self.from_repository.texts
4321
 
                yield ('texts', from_texts.get_record_stream(
4322
 
                    text_keys, self.to_format._fetch_order,
4323
 
                    not self.to_format._fetch_uses_deltas))
4324
 
                # Cause an error if a text occurs after we have done the
4325
 
                # copy.
4326
 
                text_keys = None
4327
 
                # Before we process the inventory we generate the root
4328
 
                # texts (if necessary) so that the inventories references
4329
 
                # will be valid.
4330
 
                for _ in self._generate_root_texts(revs):
4331
 
                    yield _
4332
 
                # we fetch only the referenced inventories because we do not
4333
 
                # know for unselected inventories whether all their required
4334
 
                # texts are present in the other repository - it could be
4335
 
                # corrupt.
4336
 
                for info in self._get_inventory_stream(revs):
4337
 
                    yield info
4338
 
            elif knit_kind == "signatures":
4339
 
                # Nothing to do here; this will be taken care of when
4340
 
                # _fetch_revision_texts happens.
4341
 
                pass
4342
 
            elif knit_kind == "revisions":
4343
 
                for record in self._fetch_revision_texts(revs):
4344
 
                    yield record
4345
 
            else:
4346
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4347
 
 
4348
 
    def get_stream_for_missing_keys(self, missing_keys):
4349
 
        # missing keys can only occur when we are byte copying and not
4350
 
        # translating (because translation means we don't send
4351
 
        # unreconstructable deltas ever).
4352
 
        keys = {}
4353
 
        keys['texts'] = set()
4354
 
        keys['revisions'] = set()
4355
 
        keys['inventories'] = set()
4356
 
        keys['chk_bytes'] = set()
4357
 
        keys['signatures'] = set()
4358
 
        for key in missing_keys:
4359
 
            keys[key[0]].add(key[1:])
4360
 
        if len(keys['revisions']):
4361
 
            # If we allowed copying revisions at this point, we could end up
4362
 
            # copying a revision without copying its required texts: a
4363
 
            # violation of the requirements for repository integrity.
4364
 
            raise AssertionError(
4365
 
                'cannot copy revisions to fill in missing deltas %s' % (
4366
 
                    keys['revisions'],))
4367
 
        for substream_kind, keys in keys.iteritems():
4368
 
            vf = getattr(self.from_repository, substream_kind)
4369
 
            if vf is None and keys:
4370
 
                    raise AssertionError(
4371
 
                        "cannot fill in keys for a versioned file we don't"
4372
 
                        " have: %s needs %s" % (substream_kind, keys))
4373
 
            if not keys:
4374
 
                # No need to stream something we don't have
4375
 
                continue
4376
 
            if substream_kind == 'inventories':
4377
 
                # Some missing keys are genuinely ghosts, filter those out.
4378
 
                present = self.from_repository.inventories.get_parent_map(keys)
4379
 
                revs = [key[0] for key in present]
4380
 
                # Get the inventory stream more-or-less as we do for the
4381
 
                # original stream; there's no reason to assume that records
4382
 
                # direct from the source will be suitable for the sink.  (Think
4383
 
                # e.g. 2a -> 1.9-rich-root).
4384
 
                for info in self._get_inventory_stream(revs, missing=True):
4385
 
                    yield info
4386
 
                continue
4387
 
 
4388
 
            # Ask for full texts always so that we don't need more round trips
4389
 
            # after this stream.
4390
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4391
 
            # records. The Sink is responsible for doing another check to
4392
 
            # ensure that ghosts don't introduce missing data for future
4393
 
            # fetches.
4394
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4395
 
                self.to_format._fetch_order, True))
4396
 
            yield substream_kind, stream
4397
 
 
4398
 
    def inventory_fetch_order(self):
4399
 
        if self._rich_root_upgrade():
4400
 
            return 'topological'
4401
 
        else:
4402
 
            return self.to_format._fetch_order
4403
 
 
4404
 
    def _rich_root_upgrade(self):
4405
 
        return (not self.from_repository._format.rich_root_data and
4406
 
            self.to_format.rich_root_data)
4407
 
 
4408
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4409
 
        from_format = self.from_repository._format
4410
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4411
 
            from_format.network_name() == self.to_format.network_name()):
4412
 
            raise AssertionError(
4413
 
                "this case should be handled by GroupCHKStreamSource")
4414
 
        elif 'forceinvdeltas' in debug.debug_flags:
4415
 
            return self._get_convertable_inventory_stream(revision_ids,
4416
 
                    delta_versus_null=missing)
4417
 
        elif from_format.network_name() == self.to_format.network_name():
4418
 
            # Same format.
4419
 
            return self._get_simple_inventory_stream(revision_ids,
4420
 
                    missing=missing)
4421
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4422
 
                and from_format._serializer == self.to_format._serializer):
4423
 
            # Essentially the same format.
4424
 
            return self._get_simple_inventory_stream(revision_ids,
4425
 
                    missing=missing)
4426
 
        else:
4427
 
            # Any time we switch serializations, we want to use an
4428
 
            # inventory-delta based approach.
4429
 
            return self._get_convertable_inventory_stream(revision_ids,
4430
 
                    delta_versus_null=missing)
4431
 
 
4432
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4433
 
        # NB: This currently reopens the inventory weave in source;
4434
 
        # using a single stream interface instead would avoid this.
4435
 
        from_weave = self.from_repository.inventories
4436
 
        if missing:
4437
 
            delta_closure = True
4438
 
        else:
4439
 
            delta_closure = not self.delta_on_metadata()
4440
 
        yield ('inventories', from_weave.get_record_stream(
4441
 
            [(rev_id,) for rev_id in revision_ids],
4442
 
            self.inventory_fetch_order(), delta_closure))
4443
 
 
4444
 
    def _get_convertable_inventory_stream(self, revision_ids,
4445
 
                                          delta_versus_null=False):
4446
 
        # The two formats are sufficiently different that there is no fast
4447
 
        # path, so we need to send just inventorydeltas, which any
4448
 
        # sufficiently modern client can insert into any repository.
4449
 
        # The StreamSink code expects to be able to
4450
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4451
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4452
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4453
 
        yield ('inventory-deltas',
4454
 
           self._stream_invs_as_deltas(revision_ids,
4455
 
                                       delta_versus_null=delta_versus_null))
4456
 
 
4457
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4458
 
        """Return a stream of inventory-deltas for the given rev ids.
4459
 
 
4460
 
        :param revision_ids: The list of inventories to transmit
4461
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4462
 
            entry, instead compute the delta versus the NULL_REVISION. This
4463
 
            effectively streams a complete inventory. Used for stuff like
4464
 
            filling in missing parents, etc.
4465
 
        """
4466
 
        from_repo = self.from_repository
4467
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4468
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4469
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4470
 
        # method...
4471
 
        inventories = self.from_repository.iter_inventories(
4472
 
            revision_ids, 'topological')
4473
 
        format = from_repo._format
4474
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4475
 
        inventory_cache = lru_cache.LRUCache(50)
4476
 
        null_inventory = from_repo.revision_tree(
4477
 
            _mod_revision.NULL_REVISION).inventory
4478
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4479
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4480
 
        # repo back into a non-rich-root repo ought to be allowed)
4481
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4482
 
            versioned_root=format.rich_root_data,
4483
 
            tree_references=format.supports_tree_reference)
4484
 
        for inv in inventories:
4485
 
            key = (inv.revision_id,)
4486
 
            parent_keys = parent_map.get(key, ())
4487
 
            delta = None
4488
 
            if not delta_versus_null and parent_keys:
4489
 
                # The caller did not ask for complete inventories and we have
4490
 
                # some parents that we can delta against.  Make a delta against
4491
 
                # each parent so that we can find the smallest.
4492
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4493
 
                for parent_id in parent_ids:
4494
 
                    if parent_id not in invs_sent_so_far:
4495
 
                        # We don't know that the remote side has this basis, so
4496
 
                        # we can't use it.
4497
 
                        continue
4498
 
                    if parent_id == _mod_revision.NULL_REVISION:
4499
 
                        parent_inv = null_inventory
4500
 
                    else:
4501
 
                        parent_inv = inventory_cache.get(parent_id, None)
4502
 
                        if parent_inv is None:
4503
 
                            parent_inv = from_repo.get_inventory(parent_id)
4504
 
                    candidate_delta = inv._make_delta(parent_inv)
4505
 
                    if (delta is None or
4506
 
                        len(delta) > len(candidate_delta)):
4507
 
                        delta = candidate_delta
4508
 
                        basis_id = parent_id
4509
 
            if delta is None:
4510
 
                # Either none of the parents ended up being suitable, or we
4511
 
                # were asked to delta against NULL
4512
 
                basis_id = _mod_revision.NULL_REVISION
4513
 
                delta = inv._make_delta(null_inventory)
4514
 
            invs_sent_so_far.add(inv.revision_id)
4515
 
            inventory_cache[inv.revision_id] = inv
4516
 
            delta_serialized = ''.join(
4517
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4518
 
            yield versionedfile.FulltextContentFactory(
4519
 
                key, parent_keys, None, delta_serialized)
4520
 
 
4521
 
 
4522
1771
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4523
1772
                    stop_revision=None):
4524
1773
    """Extend the partial history to include a given index
4534
1783
        it is encountered, history extension will stop.
4535
1784
    """
4536
1785
    start_revision = partial_history_cache[-1]
4537
 
    iterator = repo.iter_reverse_revision_history(start_revision)
 
1786
    graph = repo.get_graph()
 
1787
    iterator = graph.iter_lefthand_ancestry(start_revision,
 
1788
        (_mod_revision.NULL_REVISION,))
4538
1789
    try:
4539
 
        #skip the last revision in the list
 
1790
        # skip the last revision in the list
4540
1791
        iterator.next()
4541
1792
        while True:
4542
1793
            if (stop_index is not None and
4551
1802
        return
4552
1803
 
4553
1804
 
4554
 
 
 
1805
class _LazyListJoin(object):
 
1806
    """An iterable yielding the contents of many lists as one list.
 
1807
 
 
1808
    Each iterator made from this will reflect the current contents of the lists
 
1809
    at the time the iterator is made.
 
1810
    
 
1811
    This is used by Repository's _make_parents_provider implementation so that
 
1812
    it is safe to do::
 
1813
 
 
1814
      pp = repo._make_parents_provider()      # uses a list of fallback repos
 
1815
      pp.add_fallback_repository(other_repo)  # appends to that list
 
1816
      result = pp.get_parent_map(...)
 
1817
      # The result will include revs from other_repo
 
1818
    """
 
1819
 
 
1820
    def __init__(self, *list_parts):
 
1821
        self.list_parts = list_parts
 
1822
 
 
1823
    def __iter__(self):
 
1824
        full_list = []
 
1825
        for list_part in self.list_parts:
 
1826
            full_list.extend(list_part)
 
1827
        return iter(full_list)
 
1828
 
 
1829
    def __repr__(self):
 
1830
        return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
 
1831
                              self.list_parts)