← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 06:15:33 UTC
  • mfrom: (5025.1.6 331095-malloc)
  • Revision ID: pqm@pqm.ubuntu.com-20100211061533-5glf4faoutadhql9
(mbp) avoid malloc(0)

Show diffs side-by-side

added added

removed removed

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