~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-05-07 08:01:38 UTC
  • mfrom: (5187.2.12 549310-mandatory-whoami)
  • Revision ID: pqm@pqm.ubuntu.com-20100507080138-doe642wej2tu47t5
(parthm) trivial docstring fix to indicate when errors.NoWhoami is raised.

Show diffs side-by-side

added added

removed removed

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