~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-09 16:48:55 UTC
  • mto: (6437.23.24 2.5)
  • mto: This revision was merged to the branch mainline in revision 6499.
  • Revision ID: v.ladeuil+lp@free.fr-20120309164855-htdn25hp7x65mmir
Rely on sphinx for texinfo doc generation

Show diffs side-by-side

added added

removed removed

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