~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

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