← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-10-12 21:44:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4737.
  • Revision ID: john@arbash-meinel.com-20091012214427-zddi1kmc2jlf7v31
Py_ssize_t and its associated function typedefs are not available w/ python 2.4

So we define them in python-compat.h
Even further, gcc issued a warning for:
static int
_workaround_pyrex_096()
So we changed it to:
_workaround_pyrex_096(void)

Also, some python api funcs were incorrectly defined as 'char *' when they meant
'const char *'. Work around that with a (char *) cast, to avoid compiler warnings.

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