~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

(jelmer) Use the absolute_import feature everywhere in bzrlib,
 and add a source test to make sure it's used everywhere. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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