← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

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