← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-07-08 15:43:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4521.
  • Revision ID: john@arbash-meinel.com-20090708154351-u0t41fwjqm28pbnu
Add comments in the finally sections as to why we want them.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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,
24
 
    config,
25
 
    controldir,
 
25
    check,
 
26
    chk_map,
26
27
    debug,
 
28
    errors,
 
29
    fifo_cache,
27
30
    generate_ids,
 
31
    gpg,
28
32
    graph,
 
33
    inventory,
 
34
    lazy_regex,
29
35
    lockable_files,
30
36
    lockdir,
 
37
    lru_cache,
31
38
    osutils,
32
39
    revision as _mod_revision,
33
 
    testament as _mod_testament,
 
40
    symbol_versioning,
34
41
    tsort,
35
 
    gpg,
 
42
    ui,
 
43
    versionedfile,
36
44
    )
37
45
from bzrlib.bundle import serializer
 
46
from bzrlib.revisiontree import RevisionTree
 
47
from bzrlib.store.versioned import VersionedFileStore
 
48
from bzrlib.testament import Testament
38
49
""")
39
50
 
40
 
from bzrlib import (
41
 
    errors,
42
 
    registry,
43
 
    symbol_versioning,
44
 
    ui,
45
 
    )
46
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
52
from bzrlib.inter import InterObject
48
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
53
from bzrlib.inventory import (
 
54
    Inventory,
 
55
    InventoryDirectory,
 
56
    ROOT_ID,
 
57
    entry_factory,
 
58
    )
 
59
from bzrlib import registry
49
60
from bzrlib.trace import (
50
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
51
62
 
54
65
_deprecation_warning_done = False
55
66
 
56
67
 
57
 
class IsInWriteGroupError(errors.InternalBzrError):
58
 
 
59
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
60
 
 
61
 
    def __init__(self, repo):
62
 
        errors.InternalBzrError.__init__(self, repo=repo)
63
 
 
64
 
 
65
68
class CommitBuilder(object):
66
69
    """Provides an interface to build up a commit.
67
70
 
71
74
 
72
75
    # all clients should supply tree roots.
73
76
    record_root_entry = True
74
 
    # whether this commit builder supports the record_entry_contents interface
75
 
    supports_record_entry_contents = False
 
77
    # the default CommitBuilder does not manage trees whose root is versioned.
 
78
    _versioned_root = False
76
79
 
77
80
    def __init__(self, repository, parents, config, timestamp=None,
78
81
                 timezone=None, committer=None, revprops=None,
79
 
                 revision_id=None, lossy=False):
 
82
                 revision_id=None):
80
83
        """Initiate a CommitBuilder.
81
84
 
82
85
        :param repository: Repository to commit to.
83
86
        :param parents: Revision ids of the parents of the new revision.
 
87
        :param config: Configuration to use.
84
88
        :param timestamp: Optional timestamp recorded for commit.
85
89
        :param timezone: Optional timezone for timestamp.
86
90
        :param committer: Optional committer to set for commit.
87
91
        :param revprops: Optional dictionary of revision properties.
88
92
        :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
93
        """
92
94
        self._config = config
93
 
        self._lossy = lossy
94
95
 
95
96
        if committer is None:
96
97
            self._committer = self._config.username()
97
 
        elif not isinstance(committer, unicode):
98
 
            self._committer = committer.decode() # throw if non-ascii
99
98
        else:
100
99
            self._committer = committer
101
100
 
 
101
        self.new_inventory = Inventory(None)
102
102
        self._new_revision_id = revision_id
103
103
        self.parents = parents
104
104
        self.repository = repository
119
119
            self._timezone = int(timezone)
120
120
 
121
121
        self._generate_revision_if_needed()
 
122
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
123
        self._basis_delta = []
 
124
        # API compatibility, older code that used CommitBuilder did not call
 
125
        # .record_delete(), which means the delta that is computed would not be
 
126
        # valid. Callers that will call record_delete() should call
 
127
        # .will_record_deletes() to indicate that.
 
128
        self._recording_deletes = False
 
129
        # memo'd check for no-op commits.
 
130
        self._any_changes = False
122
131
 
123
132
    def any_changes(self):
124
133
        """Return True if any entries were changed.
125
 
 
 
134
        
126
135
        This includes merge-only changes. It is the core for the --unchanged
127
136
        detection in commit.
128
137
 
129
138
        :return: True if any changes have occured.
130
139
        """
131
 
        raise NotImplementedError(self.any_changes)
 
140
        return self._any_changes
132
141
 
133
142
    def _validate_unicode_text(self, text, context):
134
143
        """Verify things like commit messages don't have bogus characters."""
150
159
 
151
160
        :return: The revision id of the recorded revision.
152
161
        """
153
 
        raise NotImplementedError(self.commit)
 
162
        self._validate_unicode_text(message, 'commit message')
 
163
        rev = _mod_revision.Revision(
 
164
                       timestamp=self._timestamp,
 
165
                       timezone=self._timezone,
 
166
                       committer=self._committer,
 
167
                       message=message,
 
168
                       inventory_sha1=self.inv_sha1,
 
169
                       revision_id=self._new_revision_id,
 
170
                       properties=self._revprops)
 
171
        rev.parent_ids = self.parents
 
172
        self.repository.add_revision(self._new_revision_id, rev,
 
173
            self.new_inventory, self._config)
 
174
        self.repository.commit_write_group()
 
175
        return self._new_revision_id
154
176
 
155
177
    def abort(self):
156
178
        """Abort the commit that is being built.
157
179
        """
158
 
        raise NotImplementedError(self.abort)
 
180
        self.repository.abort_write_group()
159
181
 
160
182
    def revision_tree(self):
161
183
        """Return the tree that was just committed.
162
184
 
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
 
185
        After calling commit() this can be called to get a RevisionTree
 
186
        representing the newly committed tree. This is preferred to
 
187
        calling Repository.revision_tree() because that may require
 
188
        deserializing the inventory, while we already have a copy in
167
189
        memory.
168
190
        """
169
 
        raise NotImplementedError(self.revision_tree)
 
191
        if self.new_inventory is None:
 
192
            self.new_inventory = self.repository.get_inventory(
 
193
                self._new_revision_id)
 
194
        return RevisionTree(self.repository, self.new_inventory,
 
195
            self._new_revision_id)
170
196
 
171
197
    def finish_inventory(self):
172
198
        """Tell the builder that the inventory is finished.
174
200
        :return: The inventory id in the repository, which can be used with
175
201
            repository.get_inventory.
176
202
        """
177
 
        raise NotImplementedError(self.finish_inventory)
 
203
        if self.new_inventory is None:
 
204
            # an inventory delta was accumulated without creating a new
 
205
            # inventory.
 
206
            basis_id = self.basis_delta_revision
 
207
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
208
                basis_id, self._basis_delta, self._new_revision_id,
 
209
                self.parents)
 
210
        else:
 
211
            if self.new_inventory.root is None:
 
212
                raise AssertionError('Root entry should be supplied to'
 
213
                    ' record_entry_contents, as of bzr 0.10.')
 
214
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
215
            self.new_inventory.revision_id = self._new_revision_id
 
216
            self.inv_sha1 = self.repository.add_inventory(
 
217
                self._new_revision_id,
 
218
                self.new_inventory,
 
219
                self.parents
 
220
                )
 
221
        return self._new_revision_id
178
222
 
179
223
    def _gen_revision_id(self):
180
224
        """Return new revision-id."""
181
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
225
        return generate_ids.gen_revision_id(self._config.username(),
 
226
                                            self._timestamp)
182
227
 
183
228
    def _generate_revision_if_needed(self):
184
229
        """Create a revision id if None was supplied.
195
240
        else:
196
241
            self.random_revid = False
197
242
 
 
243
    def _heads(self, file_id, revision_ids):
 
244
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
245
 
 
246
        This can use either a per-file graph or a global revision graph as we
 
247
        have an identity relationship between the two graphs.
 
248
        """
 
249
        return self.__heads(revision_ids)
 
250
 
 
251
    def _check_root(self, ie, parent_invs, tree):
 
252
        """Helper for record_entry_contents.
 
253
 
 
254
        :param ie: An entry being added.
 
255
        :param parent_invs: The inventories of the parent revisions of the
 
256
            commit.
 
257
        :param tree: The tree that is being committed.
 
258
        """
 
259
        # In this revision format, root entries have no knit or weave When
 
260
        # serializing out to disk and back in root.revision is always
 
261
        # _new_revision_id
 
262
        ie.revision = self._new_revision_id
 
263
 
 
264
    def _require_root_change(self, tree):
 
265
        """Enforce an appropriate root object change.
 
266
 
 
267
        This is called once when record_iter_changes is called, if and only if
 
268
        the root was not in the delta calculated by record_iter_changes.
 
269
 
 
270
        :param tree: The tree which is being committed.
 
271
        """
 
272
        # NB: if there are no parents then this method is not called, so no
 
273
        # need to guard on parents having length.
 
274
        entry = entry_factory['directory'](tree.path2id(''), '',
 
275
            None)
 
276
        entry.revision = self._new_revision_id
 
277
        self._basis_delta.append(('', '', entry.file_id, entry))
 
278
 
 
279
    def _get_delta(self, ie, basis_inv, path):
 
280
        """Get a delta against the basis inventory for ie."""
 
281
        if ie.file_id not in basis_inv:
 
282
            # add
 
283
            result = (None, path, ie.file_id, ie)
 
284
            self._basis_delta.append(result)
 
285
            return result
 
286
        elif ie != basis_inv[ie.file_id]:
 
287
            # common but altered
 
288
            # TODO: avoid tis id2path call.
 
289
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
290
            self._basis_delta.append(result)
 
291
            return result
 
292
        else:
 
293
            # common, unaltered
 
294
            return None
 
295
 
 
296
    def get_basis_delta(self):
 
297
        """Return the complete inventory delta versus the basis inventory.
 
298
 
 
299
        This has been built up with the calls to record_delete and
 
300
        record_entry_contents. The client must have already called
 
301
        will_record_deletes() to indicate that they will be generating a
 
302
        complete delta.
 
303
 
 
304
        :return: An inventory delta, suitable for use with apply_delta, or
 
305
            Repository.add_inventory_by_delta, etc.
 
306
        """
 
307
        if not self._recording_deletes:
 
308
            raise AssertionError("recording deletes not activated.")
 
309
        return self._basis_delta
 
310
 
 
311
    def record_delete(self, path, file_id):
 
312
        """Record that a delete occured against a basis tree.
 
313
 
 
314
        This is an optional API - when used it adds items to the basis_delta
 
315
        being accumulated by the commit builder. It cannot be called unless the
 
316
        method will_record_deletes() has been called to inform the builder that
 
317
        a delta is being supplied.
 
318
 
 
319
        :param path: The path of the thing deleted.
 
320
        :param file_id: The file id that was deleted.
 
321
        """
 
322
        if not self._recording_deletes:
 
323
            raise AssertionError("recording deletes not activated.")
 
324
        delta = (path, None, file_id, None)
 
325
        self._basis_delta.append(delta)
 
326
        self._any_changes = True
 
327
        return delta
 
328
 
198
329
    def will_record_deletes(self):
199
330
        """Tell the commit builder that deletes are being notified.
200
331
 
202
333
        commit to be valid, deletes against the basis MUST be recorded via
203
334
        builder.record_delete().
204
335
        """
205
 
        raise NotImplementedError(self.will_record_deletes)
206
 
 
207
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
 
336
        self._recording_deletes = True
 
337
        try:
 
338
            basis_id = self.parents[0]
 
339
        except IndexError:
 
340
            basis_id = _mod_revision.NULL_REVISION
 
341
        self.basis_delta_revision = basis_id
 
342
 
 
343
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
344
        content_summary):
 
345
        """Record the content of ie from tree into the commit if needed.
 
346
 
 
347
        Side effect: sets ie.revision when unchanged
 
348
 
 
349
        :param ie: An inventory entry present in the commit.
 
350
        :param parent_invs: The inventories of the parent revisions of the
 
351
            commit.
 
352
        :param path: The path the entry is at in the tree.
 
353
        :param tree: The tree which contains this entry and should be used to
 
354
            obtain content.
 
355
        :param content_summary: Summary data from the tree about the paths
 
356
            content - stat, length, exec, sha/link target. This is only
 
357
            accessed when the entry has a revision of None - that is when it is
 
358
            a candidate to commit.
 
359
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
360
            change_delta is an inventory_delta change for this entry against
 
361
            the basis tree of the commit, or None if no change occured against
 
362
            the basis tree.
 
363
            version_recorded is True if a new version of the entry has been
 
364
            recorded. For instance, committing a merge where a file was only
 
365
            changed on the other side will return (delta, False).
 
366
            fs_hash is either None, or the hash details for the path (currently
 
367
            a tuple of the contents sha1 and the statvalue returned by
 
368
            tree.get_file_with_stat()).
 
369
        """
 
370
        if self.new_inventory.root is None:
 
371
            if ie.parent_id is not None:
 
372
                raise errors.RootMissing()
 
373
            self._check_root(ie, parent_invs, tree)
 
374
        if ie.revision is None:
 
375
            kind = content_summary[0]
 
376
        else:
 
377
            # ie is carried over from a prior commit
 
378
            kind = ie.kind
 
379
        # XXX: repository specific check for nested tree support goes here - if
 
380
        # the repo doesn't want nested trees we skip it ?
 
381
        if (kind == 'tree-reference' and
 
382
            not self.repository._format.supports_tree_reference):
 
383
            # mismatch between commit builder logic and repository:
 
384
            # this needs the entry creation pushed down into the builder.
 
385
            raise NotImplementedError('Missing repository subtree support.')
 
386
        self.new_inventory.add(ie)
 
387
 
 
388
        # TODO: slow, take it out of the inner loop.
 
389
        try:
 
390
            basis_inv = parent_invs[0]
 
391
        except IndexError:
 
392
            basis_inv = Inventory(root_id=None)
 
393
 
 
394
        # ie.revision is always None if the InventoryEntry is considered
 
395
        # for committing. We may record the previous parents revision if the
 
396
        # content is actually unchanged against a sole head.
 
397
        if ie.revision is not None:
 
398
            if not self._versioned_root and path == '':
 
399
                # repositories that do not version the root set the root's
 
400
                # revision to the new commit even when no change occurs (more
 
401
                # specifically, they do not record a revision on the root; and
 
402
                # the rev id is assigned to the root during deserialisation -
 
403
                # this masks when a change may have occurred against the basis.
 
404
                # To match this we always issue a delta, because the revision
 
405
                # of the root will always be changing.
 
406
                if ie.file_id in basis_inv:
 
407
                    delta = (basis_inv.id2path(ie.file_id), path,
 
408
                        ie.file_id, ie)
 
409
                else:
 
410
                    # add
 
411
                    delta = (None, path, ie.file_id, ie)
 
412
                self._basis_delta.append(delta)
 
413
                return delta, False, None
 
414
            else:
 
415
                # we don't need to commit this, because the caller already
 
416
                # determined that an existing revision of this file is
 
417
                # appropriate. If its not being considered for committing then
 
418
                # it and all its parents to the root must be unaltered so
 
419
                # no-change against the basis.
 
420
                if ie.revision == self._new_revision_id:
 
421
                    raise AssertionError("Impossible situation, a skipped "
 
422
                        "inventory entry (%r) claims to be modified in this "
 
423
                        "commit (%r).", (ie, self._new_revision_id))
 
424
                return None, False, None
 
425
        # XXX: Friction: parent_candidates should return a list not a dict
 
426
        #      so that we don't have to walk the inventories again.
 
427
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
428
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
429
        heads = []
 
430
        for inv in parent_invs:
 
431
            if ie.file_id in inv:
 
432
                old_rev = inv[ie.file_id].revision
 
433
                if old_rev in head_set:
 
434
                    heads.append(inv[ie.file_id].revision)
 
435
                    head_set.remove(inv[ie.file_id].revision)
 
436
 
 
437
        store = False
 
438
        # now we check to see if we need to write a new record to the
 
439
        # file-graph.
 
440
        # We write a new entry unless there is one head to the ancestors, and
 
441
        # the kind-derived content is unchanged.
 
442
 
 
443
        # Cheapest check first: no ancestors, or more the one head in the
 
444
        # ancestors, we write a new node.
 
445
        if len(heads) != 1:
 
446
            store = True
 
447
        if not store:
 
448
            # There is a single head, look it up for comparison
 
449
            parent_entry = parent_candiate_entries[heads[0]]
 
450
            # if the non-content specific data has changed, we'll be writing a
 
451
            # node:
 
452
            if (parent_entry.parent_id != ie.parent_id or
 
453
                parent_entry.name != ie.name):
 
454
                store = True
 
455
        # now we need to do content specific checks:
 
456
        if not store:
 
457
            # if the kind changed the content obviously has
 
458
            if kind != parent_entry.kind:
 
459
                store = True
 
460
        # Stat cache fingerprint feedback for the caller - None as we usually
 
461
        # don't generate one.
 
462
        fingerprint = None
 
463
        if kind == 'file':
 
464
            if content_summary[2] is None:
 
465
                raise ValueError("Files must not have executable = None")
 
466
            if not store:
 
467
                if (# if the file length changed we have to store:
 
468
                    parent_entry.text_size != content_summary[1] or
 
469
                    # if the exec bit has changed we have to store:
 
470
                    parent_entry.executable != content_summary[2]):
 
471
                    store = True
 
472
                elif parent_entry.text_sha1 == content_summary[3]:
 
473
                    # all meta and content is unchanged (using a hash cache
 
474
                    # hit to check the sha)
 
475
                    ie.revision = parent_entry.revision
 
476
                    ie.text_size = parent_entry.text_size
 
477
                    ie.text_sha1 = parent_entry.text_sha1
 
478
                    ie.executable = parent_entry.executable
 
479
                    return self._get_delta(ie, basis_inv, path), False, None
 
480
                else:
 
481
                    # Either there is only a hash change(no hash cache entry,
 
482
                    # or same size content change), or there is no change on
 
483
                    # this file at all.
 
484
                    # Provide the parent's hash to the store layer, so that the
 
485
                    # content is unchanged we will not store a new node.
 
486
                    nostore_sha = parent_entry.text_sha1
 
487
            if store:
 
488
                # We want to record a new node regardless of the presence or
 
489
                # absence of a content change in the file.
 
490
                nostore_sha = None
 
491
            ie.executable = content_summary[2]
 
492
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
493
            try:
 
494
                text = file_obj.read()
 
495
            finally:
 
496
                file_obj.close()
 
497
            try:
 
498
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
499
                    ie.file_id, text, heads, nostore_sha)
 
500
                # Let the caller know we generated a stat fingerprint.
 
501
                fingerprint = (ie.text_sha1, stat_value)
 
502
            except errors.ExistingContent:
 
503
                # Turns out that the file content was unchanged, and we were
 
504
                # only going to store a new node if it was changed. Carry over
 
505
                # the entry.
 
506
                ie.revision = parent_entry.revision
 
507
                ie.text_size = parent_entry.text_size
 
508
                ie.text_sha1 = parent_entry.text_sha1
 
509
                ie.executable = parent_entry.executable
 
510
                return self._get_delta(ie, basis_inv, path), False, None
 
511
        elif kind == 'directory':
 
512
            if not store:
 
513
                # all data is meta here, nothing specific to directory, so
 
514
                # carry over:
 
515
                ie.revision = parent_entry.revision
 
516
                return self._get_delta(ie, basis_inv, path), False, None
 
517
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
518
        elif kind == 'symlink':
 
519
            current_link_target = content_summary[3]
 
520
            if not store:
 
521
                # symlink target is not generic metadata, check if it has
 
522
                # changed.
 
523
                if current_link_target != parent_entry.symlink_target:
 
524
                    store = True
 
525
            if not store:
 
526
                # unchanged, carry over.
 
527
                ie.revision = parent_entry.revision
 
528
                ie.symlink_target = parent_entry.symlink_target
 
529
                return self._get_delta(ie, basis_inv, path), False, None
 
530
            ie.symlink_target = current_link_target
 
531
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
532
        elif kind == 'tree-reference':
 
533
            if not store:
 
534
                if content_summary[3] != parent_entry.reference_revision:
 
535
                    store = True
 
536
            if not store:
 
537
                # unchanged, carry over.
 
538
                ie.reference_revision = parent_entry.reference_revision
 
539
                ie.revision = parent_entry.revision
 
540
                return self._get_delta(ie, basis_inv, path), False, None
 
541
            ie.reference_revision = content_summary[3]
 
542
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
543
        else:
 
544
            raise NotImplementedError('unknown kind')
 
545
        ie.revision = self._new_revision_id
 
546
        self._any_changes = True
 
547
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
548
 
 
549
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
 
550
        _entry_factory=entry_factory):
208
551
        """Record a new tree via iter_changes.
209
552
 
210
553
        :param tree: The tree to obtain text contents from for changed objects.
215
558
            to basis_revision_id. The iterator must not include any items with
216
559
            a current kind of None - missing items must be either filtered out
217
560
            or errored-on beefore record_iter_changes sees the item.
 
561
        :param _entry_factory: Private method to bind entry_factory locally for
 
562
            performance.
218
563
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
219
564
            tree._observed_sha1.
220
565
        """
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)
 
566
        # Create an inventory delta based on deltas between all the parents and
 
567
        # deltas between all the parent inventories. We use inventory delta's 
 
568
        # between the inventory objects because iter_changes masks
 
569
        # last-changed-field only changes.
 
570
        # Working data:
 
571
        # file_id -> change map, change is fileid, paths, changed, versioneds,
 
572
        # parents, names, kinds, executables
 
573
        merged_ids = {}
 
574
        # {file_id -> revision_id -> inventory entry, for entries in parent
 
575
        # trees that are not parents[0]
 
576
        parent_entries = {}
 
577
        ghost_basis = False
 
578
        try:
 
579
            revtrees = list(self.repository.revision_trees(self.parents))
 
580
        except errors.NoSuchRevision:
 
581
            # one or more ghosts, slow path.
 
582
            revtrees = []
 
583
            for revision_id in self.parents:
 
584
                try:
 
585
                    revtrees.append(self.repository.revision_tree(revision_id))
 
586
                except errors.NoSuchRevision:
 
587
                    if not revtrees:
 
588
                        basis_revision_id = _mod_revision.NULL_REVISION
 
589
                        ghost_basis = True
 
590
                    revtrees.append(self.repository.revision_tree(
 
591
                        _mod_revision.NULL_REVISION))
 
592
        # The basis inventory from a repository 
 
593
        if revtrees:
 
594
            basis_inv = revtrees[0].inventory
 
595
        else:
 
596
            basis_inv = self.repository.revision_tree(
 
597
                _mod_revision.NULL_REVISION).inventory
 
598
        if len(self.parents) > 0:
 
599
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
600
                raise Exception(
 
601
                    "arbitrary basis parents not yet supported with merges")
 
602
            for revtree in revtrees[1:]:
 
603
                for change in revtree.inventory._make_delta(basis_inv):
 
604
                    if change[1] is None:
 
605
                        # Not present in this parent.
 
606
                        continue
 
607
                    if change[2] not in merged_ids:
 
608
                        if change[0] is not None:
 
609
                            basis_entry = basis_inv[change[2]]
 
610
                            merged_ids[change[2]] = [
 
611
                                # basis revid
 
612
                                basis_entry.revision,
 
613
                                # new tree revid
 
614
                                change[3].revision]
 
615
                            parent_entries[change[2]] = {
 
616
                                # basis parent
 
617
                                basis_entry.revision:basis_entry,
 
618
                                # this parent 
 
619
                                change[3].revision:change[3],
 
620
                                }
 
621
                        else:
 
622
                            merged_ids[change[2]] = [change[3].revision]
 
623
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
624
                    else:
 
625
                        merged_ids[change[2]].append(change[3].revision)
 
626
                        parent_entries[change[2]][change[3].revision] = change[3]
 
627
        else:
 
628
            merged_ids = {}
 
629
        # Setup the changes from the tree:
 
630
        # changes maps file_id -> (change, [parent revision_ids])
 
631
        changes= {}
 
632
        for change in iter_changes:
 
633
            # This probably looks up in basis_inv way to much.
 
634
            if change[1][0] is not None:
 
635
                head_candidate = [basis_inv[change[0]].revision]
 
636
            else:
 
637
                head_candidate = []
 
638
            changes[change[0]] = change, merged_ids.get(change[0],
 
639
                head_candidate)
 
640
        unchanged_merged = set(merged_ids) - set(changes)
 
641
        # Extend the changes dict with synthetic changes to record merges of
 
642
        # texts.
 
643
        for file_id in unchanged_merged:
 
644
            # Record a merged version of these items that did not change vs the
 
645
            # basis. This can be either identical parallel changes, or a revert
 
646
            # of a specific file after a merge. The recorded content will be
 
647
            # that of the current tree (which is the same as the basis), but
 
648
            # the per-file graph will reflect a merge.
 
649
            # NB:XXX: We are reconstructing path information we had, this
 
650
            # should be preserved instead.
 
651
            # inv delta  change: (file_id, (path_in_source, path_in_target),
 
652
            #   changed_content, versioned, parent, name, kind,
 
653
            #   executable)
 
654
            try:
 
655
                basis_entry = basis_inv[file_id]
 
656
            except errors.NoSuchId:
 
657
                # a change from basis->some_parents but file_id isn't in basis
 
658
                # so was new in the merge, which means it must have changed
 
659
                # from basis -> current, and as it hasn't the add was reverted
 
660
                # by the user. So we discard this change.
 
661
                pass
 
662
            else:
 
663
                change = (file_id,
 
664
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
665
                    False, (True, True),
 
666
                    (basis_entry.parent_id, basis_entry.parent_id),
 
667
                    (basis_entry.name, basis_entry.name),
 
668
                    (basis_entry.kind, basis_entry.kind),
 
669
                    (basis_entry.executable, basis_entry.executable))
 
670
                changes[file_id] = (change, merged_ids[file_id])
 
671
        # changes contains tuples with the change and a set of inventory
 
672
        # candidates for the file.
 
673
        # inv delta is:
 
674
        # old_path, new_path, file_id, new_inventory_entry
 
675
        seen_root = False # Is the root in the basis delta?
 
676
        inv_delta = self._basis_delta
 
677
        modified_rev = self._new_revision_id
 
678
        for change, head_candidates in changes.values():
 
679
            if change[3][1]: # versioned in target.
 
680
                # Several things may be happening here:
 
681
                # We may have a fork in the per-file graph
 
682
                #  - record a change with the content from tree
 
683
                # We may have a change against < all trees  
 
684
                #  - carry over the tree that hasn't changed
 
685
                # We may have a change against all trees
 
686
                #  - record the change with the content from tree
 
687
                kind = change[6][1]
 
688
                file_id = change[0]
 
689
                entry = _entry_factory[kind](file_id, change[5][1],
 
690
                    change[4][1])
 
691
                head_set = self._heads(change[0], set(head_candidates))
 
692
                heads = []
 
693
                # Preserve ordering.
 
694
                for head_candidate in head_candidates:
 
695
                    if head_candidate in head_set:
 
696
                        heads.append(head_candidate)
 
697
                        head_set.remove(head_candidate)
 
698
                carried_over = False
 
699
                if len(heads) == 1:
 
700
                    # Could be a carry-over situation:
 
701
                    parent_entry_revs = parent_entries.get(file_id, None)
 
702
                    if parent_entry_revs:
 
703
                        parent_entry = parent_entry_revs.get(heads[0], None)
 
704
                    else:
 
705
                        parent_entry = None
 
706
                    if parent_entry is None:
 
707
                        # The parent iter_changes was called against is the one
 
708
                        # that is the per-file head, so any change is relevant
 
709
                        # iter_changes is valid.
 
710
                        carry_over_possible = False
 
711
                    else:
 
712
                        # could be a carry over situation
 
713
                        # A change against the basis may just indicate a merge,
 
714
                        # we need to check the content against the source of the
 
715
                        # merge to determine if it was changed after the merge
 
716
                        # or carried over.
 
717
                        if (parent_entry.kind != entry.kind or
 
718
                            parent_entry.parent_id != entry.parent_id or
 
719
                            parent_entry.name != entry.name):
 
720
                            # Metadata common to all entries has changed
 
721
                            # against per-file parent
 
722
                            carry_over_possible = False
 
723
                        else:
 
724
                            carry_over_possible = True
 
725
                        # per-type checks for changes against the parent_entry
 
726
                        # are done below.
 
727
                else:
 
728
                    # Cannot be a carry-over situation
 
729
                    carry_over_possible = False
 
730
                # Populate the entry in the delta
 
731
                if kind == 'file':
 
732
                    # XXX: There is still a small race here: If someone reverts the content of a file
 
733
                    # after iter_changes examines and decides it has changed,
 
734
                    # we will unconditionally record a new version even if some
 
735
                    # other process reverts it while commit is running (with
 
736
                    # the revert happening after iter_changes did it's
 
737
                    # examination).
 
738
                    if change[7][1]:
 
739
                        entry.executable = True
 
740
                    else:
 
741
                        entry.executable = False
 
742
                    if (carry_over_possible and
 
743
                        parent_entry.executable == entry.executable):
 
744
                            # Check the file length, content hash after reading
 
745
                            # the file.
 
746
                            nostore_sha = parent_entry.text_sha1
 
747
                    else:
 
748
                        nostore_sha = None
 
749
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
 
750
                    try:
 
751
                        text = file_obj.read()
 
752
                    finally:
 
753
                        file_obj.close()
 
754
                    try:
 
755
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
 
756
                            file_id, text, heads, nostore_sha)
 
757
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
758
                    except errors.ExistingContent:
 
759
                        # No content change against a carry_over parent
 
760
                        # Perhaps this should also yield a fs hash update?
 
761
                        carried_over = True
 
762
                        entry.text_size = parent_entry.text_size
 
763
                        entry.text_sha1 = parent_entry.text_sha1
 
764
                elif kind == 'symlink':
 
765
                    # Wants a path hint?
 
766
                    entry.symlink_target = tree.get_symlink_target(file_id)
 
767
                    if (carry_over_possible and
 
768
                        parent_entry.symlink_target == entry.symlink_target):
 
769
                        carried_over = True
 
770
                    else:
 
771
                        self._add_text_to_weave(change[0], '', heads, None)
 
772
                elif kind == 'directory':
 
773
                    if carry_over_possible:
 
774
                        carried_over = True
 
775
                    else:
 
776
                        # Nothing to set on the entry.
 
777
                        # XXX: split into the Root and nonRoot versions.
 
778
                        if change[1][1] != '' or self.repository.supports_rich_root():
 
779
                            self._add_text_to_weave(change[0], '', heads, None)
 
780
                elif kind == 'tree-reference':
 
781
                    if not self.repository._format.supports_tree_reference:
 
782
                        # This isn't quite sane as an error, but we shouldn't
 
783
                        # ever see this code path in practice: tree's don't
 
784
                        # permit references when the repo doesn't support tree
 
785
                        # references.
 
786
                        raise errors.UnsupportedOperation(tree.add_reference,
 
787
                            self.repository)
 
788
                    reference_revision = tree.get_reference_revision(change[0])
 
789
                    entry.reference_revision = reference_revision
 
790
                    if (carry_over_possible and
 
791
                        parent_entry.reference_revision == reference_revision):
 
792
                        carried_over = True
 
793
                    else:
 
794
                        self._add_text_to_weave(change[0], '', heads, None)
 
795
                else:
 
796
                    raise AssertionError('unknown kind %r' % kind)
 
797
                if not carried_over:
 
798
                    entry.revision = modified_rev
 
799
                else:
 
800
                    entry.revision = parent_entry.revision
 
801
            else:
 
802
                entry = None
 
803
            new_path = change[1][1]
 
804
            inv_delta.append((change[1][0], new_path, change[0], entry))
 
805
            if new_path == '':
 
806
                seen_root = True
 
807
        self.new_inventory = None
 
808
        if len(inv_delta):
 
809
            self._any_changes = True
 
810
        if not seen_root:
 
811
            # housekeeping root entry changes do not affect no-change commits.
 
812
            self._require_root_change(tree)
 
813
        self.basis_delta_revision = basis_revision_id
 
814
 
 
815
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
816
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
817
        return self.repository.texts._add_text(
 
818
            (file_id, self._new_revision_id), parent_keys, new_text,
 
819
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
820
 
 
821
 
 
822
class RootCommitBuilder(CommitBuilder):
 
823
    """This commitbuilder actually records the root id"""
 
824
 
 
825
    # the root entry gets versioned properly by this builder.
 
826
    _versioned_root = True
 
827
 
 
828
    def _check_root(self, ie, parent_invs, tree):
 
829
        """Helper for record_entry_contents.
 
830
 
 
831
        :param ie: An entry being added.
 
832
        :param parent_invs: The inventories of the parent revisions of the
 
833
            commit.
 
834
        :param tree: The tree that is being committed.
 
835
        """
 
836
 
 
837
    def _require_root_change(self, tree):
 
838
        """Enforce an appropriate root object change.
 
839
 
 
840
        This is called once when record_iter_changes is called, if and only if
 
841
        the root was not in the delta calculated by record_iter_changes.
 
842
 
 
843
        :param tree: The tree which is being committed.
 
844
        """
 
845
        # versioned roots do not change unless the tree found a change.
239
846
 
240
847
 
241
848
######################################################################
242
849
# Repositories
243
850
 
244
 
 
245
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
851
class Repository(object):
246
852
    """Repository holding history for one or more branches.
247
853
 
248
854
    The repository holds and retrieves historical information including
249
855
    revisions and file history.  It's normally accessed only by the Branch,
250
856
    which views a particular line of development through that history.
251
857
 
252
 
    See VersionedFileRepository in bzrlib.vf_repository for the
253
 
    base class for most Bazaar repositories.
 
858
    The Repository builds on top of some byte storage facilies (the revisions,
 
859
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
860
    which respectively provide byte storage and a means to access the (possibly
 
861
    remote) disk.
 
862
 
 
863
    The byte storage facilities are addressed via tuples, which we refer to
 
864
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
865
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
866
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
 
867
    byte string made up of a hash identifier and a hash value.
 
868
    We use this interface because it allows low friction with the underlying
 
869
    code that implements disk indices, network encoding and other parts of
 
870
    bzrlib.
 
871
 
 
872
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
873
        the serialised revisions for the repository. This can be used to obtain
 
874
        revision graph information or to access raw serialised revisions.
 
875
        The result of trying to insert data into the repository via this store
 
876
        is undefined: it should be considered read-only except for implementors
 
877
        of repositories.
 
878
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
879
        the serialised signatures for the repository. This can be used to
 
880
        obtain access to raw serialised signatures.  The result of trying to
 
881
        insert data into the repository via this store is undefined: it should
 
882
        be considered read-only except for implementors of repositories.
 
883
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
884
        the serialised inventories for the repository. This can be used to
 
885
        obtain unserialised inventories.  The result of trying to insert data
 
886
        into the repository via this store is undefined: it should be
 
887
        considered read-only except for implementors of repositories.
 
888
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
889
        texts of files and directories for the repository. This can be used to
 
890
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
891
        is usually a better interface for accessing file texts.
 
892
        The result of trying to insert data into the repository via this store
 
893
        is undefined: it should be considered read-only except for implementors
 
894
        of repositories.
 
895
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
 
896
        any data the repository chooses to store or have indexed by its hash.
 
897
        The result of trying to insert data into the repository via this store
 
898
        is undefined: it should be considered read-only except for implementors
 
899
        of repositories.
 
900
    :ivar _transport: Transport for file access to repository, typically
 
901
        pointing to .bzr/repository.
254
902
    """
255
903
 
 
904
    # What class to use for a CommitBuilder. Often its simpler to change this
 
905
    # in a Repository class subclass rather than to override
 
906
    # get_commit_builder.
 
907
    _commit_builder_class = CommitBuilder
 
908
    # The search regex used by xml based repositories to determine what things
 
909
    # where changed in a single commit.
 
910
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
911
        r'file_id="(?P<file_id>[^"]+)"'
 
912
        r'.* revision="(?P<revision_id>[^"]+)"'
 
913
        )
 
914
 
256
915
    def abort_write_group(self, suppress_errors=False):
257
916
        """Commit the contents accrued within the current write group.
258
917
 
264
923
        """
265
924
        if self._write_group is not self.get_transaction():
266
925
            # has an unlock or relock occured ?
267
 
            if suppress_errors:
268
 
                mutter(
269
 
                '(suppressed) mismatched lock context and write group. %r, %r',
270
 
                self._write_group, self.get_transaction())
271
 
                return
272
926
            raise errors.BzrError(
273
927
                'mismatched lock context and write group. %r, %r' %
274
928
                (self._write_group, self.get_transaction()))
301
955
 
302
956
        :param repository: A repository.
303
957
        """
304
 
        raise NotImplementedError(self.add_fallback_repository)
 
958
        if not self._format.supports_external_lookups:
 
959
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
960
        if self.is_locked():
 
961
            # This repository will call fallback.unlock() when we transition to
 
962
            # the unlocked state, so we make sure to increment the lock count
 
963
            repository.lock_read()
 
964
        self._check_fallback_repository(repository)
 
965
        self._fallback_repositories.append(repository)
 
966
        self.texts.add_fallback_versioned_files(repository.texts)
 
967
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
968
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
969
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
970
        if self.chk_bytes is not None:
 
971
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
305
972
 
306
973
    def _check_fallback_repository(self, repository):
307
974
        """Check that this repository can fallback to repository safely.
312
979
        """
313
980
        return InterRepository._assert_same_model(self, repository)
314
981
 
 
982
    def add_inventory(self, revision_id, inv, parents):
 
983
        """Add the inventory inv to the repository as revision_id.
 
984
 
 
985
        :param parents: The revision ids of the parents that revision_id
 
986
                        is known to have and are in the repository already.
 
987
 
 
988
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
989
            repository format specific) of the serialized inventory.
 
990
        """
 
991
        if not self.is_in_write_group():
 
992
            raise AssertionError("%r not in write group" % (self,))
 
993
        _mod_revision.check_not_reserved_id(revision_id)
 
994
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
995
            raise AssertionError(
 
996
                "Mismatch between inventory revision"
 
997
                " id and insertion revid (%r, %r)"
 
998
                % (inv.revision_id, revision_id))
 
999
        if inv.root is None:
 
1000
            raise AssertionError()
 
1001
        return self._add_inventory_checked(revision_id, inv, parents)
 
1002
 
 
1003
    def _add_inventory_checked(self, revision_id, inv, parents):
 
1004
        """Add inv to the repository after checking the inputs.
 
1005
 
 
1006
        This function can be overridden to allow different inventory styles.
 
1007
 
 
1008
        :seealso: add_inventory, for the contract.
 
1009
        """
 
1010
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1011
        return self._inventory_add_lines(revision_id, parents,
 
1012
            inv_lines, check_content=False)
 
1013
 
 
1014
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1015
                               parents, basis_inv=None, propagate_caches=False):
 
1016
        """Add a new inventory expressed as a delta against another revision.
 
1017
 
 
1018
        See the inventory developers documentation for the theory behind
 
1019
        inventory deltas.
 
1020
 
 
1021
        :param basis_revision_id: The inventory id the delta was created
 
1022
            against. (This does not have to be a direct parent.)
 
1023
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1024
            details).
 
1025
        :param new_revision_id: The revision id that the inventory is being
 
1026
            added for.
 
1027
        :param parents: The revision ids of the parents that revision_id is
 
1028
            known to have and are in the repository already. These are supplied
 
1029
            for repositories that depend on the inventory graph for revision
 
1030
            graph access, as well as for those that pun ancestry with delta
 
1031
            compression.
 
1032
        :param basis_inv: The basis inventory if it is already known,
 
1033
            otherwise None.
 
1034
        :param propagate_caches: If True, the caches for this inventory are
 
1035
          copied to and updated for the result if possible.
 
1036
 
 
1037
        :returns: (validator, new_inv)
 
1038
            The validator(which is a sha1 digest, though what is sha'd is
 
1039
            repository format specific) of the serialized inventory, and the
 
1040
            resulting inventory.
 
1041
        """
 
1042
        if not self.is_in_write_group():
 
1043
            raise AssertionError("%r not in write group" % (self,))
 
1044
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1045
        basis_tree = self.revision_tree(basis_revision_id)
 
1046
        basis_tree.lock_read()
 
1047
        try:
 
1048
            # Note that this mutates the inventory of basis_tree, which not all
 
1049
            # inventory implementations may support: A better idiom would be to
 
1050
            # return a new inventory, but as there is no revision tree cache in
 
1051
            # repository this is safe for now - RBC 20081013
 
1052
            if basis_inv is None:
 
1053
                basis_inv = basis_tree.inventory
 
1054
            basis_inv.apply_delta(delta)
 
1055
            basis_inv.revision_id = new_revision_id
 
1056
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1057
                    basis_inv)
 
1058
        finally:
 
1059
            basis_tree.unlock()
 
1060
 
 
1061
    def _inventory_add_lines(self, revision_id, parents, lines,
 
1062
        check_content=True):
 
1063
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
1064
        parents = [(parent,) for parent in parents]
 
1065
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1066
            check_content=check_content)[0]
 
1067
 
 
1068
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
1069
        """Add rev to the revision store as revision_id.
 
1070
 
 
1071
        :param revision_id: the revision id to use.
 
1072
        :param rev: The revision object.
 
1073
        :param inv: The inventory for the revision. if None, it will be looked
 
1074
                    up in the inventory storer
 
1075
        :param config: If None no digital signature will be created.
 
1076
                       If supplied its signature_needed method will be used
 
1077
                       to determine if a signature should be made.
 
1078
        """
 
1079
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
1080
        #       rev.parent_ids?
 
1081
        _mod_revision.check_not_reserved_id(revision_id)
 
1082
        if config is not None and config.signature_needed():
 
1083
            if inv is None:
 
1084
                inv = self.get_inventory(revision_id)
 
1085
            plaintext = Testament(rev, inv).as_short_text()
 
1086
            self.store_revision_signature(
 
1087
                gpg.GPGStrategy(config), plaintext, revision_id)
 
1088
        # check inventory present
 
1089
        if not self.inventories.get_parent_map([(revision_id,)]):
 
1090
            if inv is None:
 
1091
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1092
                                                     self.inventories)
 
1093
            else:
 
1094
                # yes, this is not suitable for adding with ghosts.
 
1095
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1096
                                                        rev.parent_ids)
 
1097
        else:
 
1098
            key = (revision_id,)
 
1099
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1100
        self._add_revision(rev)
 
1101
 
 
1102
    def _add_revision(self, revision):
 
1103
        text = self._serializer.write_revision_to_string(revision)
 
1104
        key = (revision.revision_id,)
 
1105
        parents = tuple((parent,) for parent in revision.parent_ids)
 
1106
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
 
1107
 
315
1108
    def all_revision_ids(self):
316
1109
        """Returns a list of all the revision ids in the repository.
317
1110
 
340
1133
        """
341
1134
        self.control_files.break_lock()
342
1135
 
 
1136
    @needs_read_lock
 
1137
    def _eliminate_revisions_not_present(self, revision_ids):
 
1138
        """Check every revision id in revision_ids to see if we have it.
 
1139
 
 
1140
        Returns a set of the present revisions.
 
1141
        """
 
1142
        result = []
 
1143
        graph = self.get_graph()
 
1144
        parent_map = graph.get_parent_map(revision_ids)
 
1145
        # The old API returned a list, should this actually be a set?
 
1146
        return parent_map.keys()
 
1147
 
343
1148
    @staticmethod
344
1149
    def create(a_bzrdir):
345
1150
        """Construct the current default format repository in a_bzrdir."""
350
1155
 
351
1156
        :param _format: The format of the repository on disk.
352
1157
        :param a_bzrdir: The BzrDir of the repository.
353
 
        :param control_files: Control files to use for locking, etc.
 
1158
 
 
1159
        In the future we will have a single api for all stores for
 
1160
        getting file texts, inventories and revisions, then
 
1161
        this construct will accept instances of those things.
354
1162
        """
355
 
        # In the future we will have a single api for all stores for
356
 
        # getting file texts, inventories and revisions, then
357
 
        # this construct will accept instances of those things.
358
1163
        super(Repository, self).__init__()
359
1164
        self._format = _format
360
1165
        # the following are part of the public API for Repository:
363
1168
        self._transport = control_files._transport
364
1169
        self.base = self._transport.base
365
1170
        # for tests
 
1171
        self._reconcile_does_inventory_gc = True
 
1172
        self._reconcile_fixes_text_parents = False
 
1173
        self._reconcile_backsup_inventory = True
 
1174
        # not right yet - should be more semantically clear ?
 
1175
        #
 
1176
        # TODO: make sure to construct the right store classes, etc, depending
 
1177
        # on whether escaping is required.
 
1178
        self._warn_if_deprecated()
366
1179
        self._write_group = None
367
1180
        # Additional places to query for data.
368
1181
        self._fallback_repositories = []
369
 
 
370
 
    @property
371
 
    def user_transport(self):
372
 
        return self.bzrdir.user_transport
373
 
 
374
 
    @property
375
 
    def control_transport(self):
376
 
        return self._transport
 
1182
        # An InventoryEntry cache, used during deserialization
 
1183
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
377
1184
 
378
1185
    def __repr__(self):
379
 
        if self._fallback_repositories:
380
 
            return '%s(%r, fallback_repositories=%r)' % (
381
 
                self.__class__.__name__,
382
 
                self.base,
383
 
                self._fallback_repositories)
384
 
        else:
385
 
            return '%s(%r)' % (self.__class__.__name__,
386
 
                               self.base)
387
 
 
388
 
    def _has_same_fallbacks(self, other_repo):
389
 
        """Returns true if the repositories have the same fallbacks."""
390
 
        my_fb = self._fallback_repositories
391
 
        other_fb = other_repo._fallback_repositories
392
 
        if len(my_fb) != len(other_fb):
393
 
            return False
394
 
        for f, g in zip(my_fb, other_fb):
395
 
            if not f.has_same_location(g):
396
 
                return False
397
 
        return True
 
1186
        return '%s(%r)' % (self.__class__.__name__,
 
1187
                           self.base)
398
1188
 
399
1189
    def has_same_location(self, other):
400
1190
        """Returns a boolean indicating if this repository is at the same
428
1218
        data during reads, and allows a 'write_group' to be obtained. Write
429
1219
        groups must be used for actual data insertion.
430
1220
 
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
1221
        :param token: if this is already locked, then lock_write will fail
438
1222
            unless the token matches the existing lock.
439
1223
        :returns: a token if this instance supports tokens, otherwise None.
442
1226
        :raises MismatchedToken: if the specified token doesn't match the token
443
1227
            of the existing lock.
444
1228
        :seealso: start_write_group.
445
 
        :return: A RepositoryWriteLockResult.
 
1229
 
 
1230
        A token should be passed in if you know that you have locked the object
 
1231
        some other way, and need to synchronise this object's state with that
 
1232
        fact.
 
1233
 
 
1234
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
446
1235
        """
447
1236
        locked = self.is_locked()
448
 
        token = self.control_files.lock_write(token=token)
 
1237
        result = self.control_files.lock_write(token=token)
449
1238
        if not locked:
450
 
            self._warn_if_deprecated()
451
 
            self._note_lock('w')
452
1239
            for repo in self._fallback_repositories:
453
1240
                # Writes don't affect fallback repos
454
1241
                repo.lock_read()
455
1242
            self._refresh_data()
456
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1243
        return result
457
1244
 
458
1245
    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
1246
        locked = self.is_locked()
465
1247
        self.control_files.lock_read()
466
1248
        if not locked:
467
 
            self._warn_if_deprecated()
468
 
            self._note_lock('r')
469
1249
            for repo in self._fallback_repositories:
470
1250
                repo.lock_read()
471
1251
            self._refresh_data()
472
 
        return LogicalLockResult(self.unlock)
473
1252
 
474
1253
    def get_physical_lock_status(self):
475
1254
        return self.control_files.get_physical_lock_status()
511
1290
        if revid and committers:
512
1291
            result['committers'] = 0
513
1292
        if revid and revid != _mod_revision.NULL_REVISION:
514
 
            graph = self.get_graph()
515
1293
            if committers:
516
1294
                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
 
1295
            revisions = self.get_ancestry(revid)
 
1296
            # pop the leading None
 
1297
            revisions.pop(0)
 
1298
            first_revision = None
520
1299
            if not committers:
521
1300
                # ignore the revisions in the middle - just grab first and last
522
1301
                revisions = revisions[0], revisions[-1]
523
1302
            for revision in self.get_revisions(revisions):
524
 
                if not last_revision:
525
 
                    last_revision = revision
 
1303
                if not first_revision:
 
1304
                    first_revision = revision
526
1305
                if committers:
527
1306
                    all_committers.add(revision.committer)
528
 
            first_revision = revision
 
1307
            last_revision = revision
529
1308
            if committers:
530
1309
                result['committers'] = len(all_committers)
531
1310
            result['firstrev'] = (first_revision.timestamp,
532
1311
                first_revision.timezone)
533
1312
            result['latestrev'] = (last_revision.timestamp,
534
1313
                last_revision.timezone)
 
1314
 
 
1315
        # now gather global repository information
 
1316
        # XXX: This is available for many repos regardless of listability.
 
1317
        if self.bzrdir.root_transport.listable():
 
1318
            # XXX: do we want to __define len__() ?
 
1319
            # Maybe the versionedfiles object should provide a different
 
1320
            # method to get the number of keys.
 
1321
            result['revisions'] = len(self.revisions.keys())
 
1322
            # result['size'] = t
535
1323
        return result
536
1324
 
537
1325
    def find_branches(self, using=False):
542
1330
        :param using: If True, list only branches using this repository.
543
1331
        """
544
1332
        if using and not self.is_shared():
545
 
            return self.bzrdir.list_branches()
 
1333
            try:
 
1334
                return [self.bzrdir.open_branch()]
 
1335
            except errors.NotBranchError:
 
1336
                return []
546
1337
        class Evaluator(object):
547
1338
 
548
1339
            def __init__(self):
557
1348
                    except errors.NoRepositoryPresent:
558
1349
                        pass
559
1350
                    else:
560
 
                        return False, ([], repository)
 
1351
                        return False, (None, repository)
561
1352
                self.first_call = False
562
 
                value = (bzrdir.list_branches(), None)
 
1353
                try:
 
1354
                    value = (bzrdir.open_branch(), None)
 
1355
                except errors.NotBranchError:
 
1356
                    value = (None, None)
563
1357
                return True, value
564
1358
 
565
 
        ret = []
566
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
567
 
                self.user_transport, evaluate=Evaluator()):
568
 
            if branches is not None:
569
 
                ret.extend(branches)
 
1359
        branches = []
 
1360
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1361
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1362
            if branch is not None:
 
1363
                branches.append(branch)
570
1364
            if not using and repository is not None:
571
 
                ret.extend(repository.find_branches())
572
 
        return ret
 
1365
                branches.extend(repository.find_branches())
 
1366
        return branches
573
1367
 
574
1368
    @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):
 
1369
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
579
1370
        """Return the revision ids that other has that this does not.
580
1371
 
581
1372
        These are returned in topological order.
582
1373
 
583
1374
        revision_id: only return revision ids included by revision_id.
584
1375
        """
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
1376
        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)
 
1377
            revision_id, find_ghosts)
598
1378
 
599
1379
    @staticmethod
600
1380
    def open(base):
618
1398
        """Commit the contents accrued within the current write group.
619
1399
 
620
1400
        :seealso: start_write_group.
621
 
        
622
 
        :return: it may return an opaque hint that can be passed to 'pack'.
623
1401
        """
624
1402
        if self._write_group is not self.get_transaction():
625
1403
            # has an unlock or relock occured ?
642
1420
    def suspend_write_group(self):
643
1421
        raise errors.UnsuspendableWriteGroup(self)
644
1422
 
 
1423
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1424
        """Return the keys of missing inventory parents for revisions added in
 
1425
        this write group.
 
1426
 
 
1427
        A revision is not complete if the inventory delta for that revision
 
1428
        cannot be calculated.  Therefore if the parent inventories of a
 
1429
        revision are not present, the revision is incomplete, and e.g. cannot
 
1430
        be streamed by a smart server.  This method finds missing inventory
 
1431
        parents for revisions added in this write group.
 
1432
        """
 
1433
        if not self._format.supports_external_lookups:
 
1434
            # This is only an issue for stacked repositories
 
1435
            return set()
 
1436
        if not self.is_in_write_group():
 
1437
            raise AssertionError('not in a write group')
 
1438
 
 
1439
        # XXX: We assume that every added revision already has its
 
1440
        # corresponding inventory, so we only check for parent inventories that
 
1441
        # might be missing, rather than all inventories.
 
1442
        parents = set(self.revisions._index.get_missing_parents())
 
1443
        parents.discard(_mod_revision.NULL_REVISION)
 
1444
        unstacked_inventories = self.inventories._index
 
1445
        present_inventories = unstacked_inventories.get_parent_map(
 
1446
            key[-1:] for key in parents)
 
1447
        parents.difference_update(present_inventories)
 
1448
        if len(parents) == 0:
 
1449
            # No missing parent inventories.
 
1450
            return set()
 
1451
        if not check_for_missing_texts:
 
1452
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1453
        # Ok, now we have a list of missing inventories.  But these only matter
 
1454
        # if the inventories that reference them are missing some texts they
 
1455
        # appear to introduce.
 
1456
        # XXX: Texts referenced by all added inventories need to be present,
 
1457
        # but at the moment we're only checking for texts referenced by
 
1458
        # inventories at the graph's edge.
 
1459
        key_deps = self.revisions._index._key_dependencies
 
1460
        key_deps.add_keys(present_inventories)
 
1461
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1462
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1463
        missing_texts = set()
 
1464
        for file_id, version_ids in file_ids.iteritems():
 
1465
            missing_texts.update(
 
1466
                (file_id, version_id) for version_id in version_ids)
 
1467
        present_texts = self.texts.get_parent_map(missing_texts)
 
1468
        missing_texts.difference_update(present_texts)
 
1469
        if not missing_texts:
 
1470
            # No texts are missing, so all revisions and their deltas are
 
1471
            # reconstructable.
 
1472
            return set()
 
1473
        # Alternatively the text versions could be returned as the missing
 
1474
        # keys, but this is likely to be less data.
 
1475
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1476
        return missing_keys
 
1477
 
645
1478
    def refresh_data(self):
646
 
        """Re-read any data needed to synchronise with disk.
 
1479
        """Re-read any data needed to to synchronise with disk.
647
1480
 
648
1481
        This method is intended to be called after another repository instance
649
1482
        (such as one used by a smart server) has inserted data into the
650
 
        repository. On all repositories this will work outside of write groups.
651
 
        Some repository formats (pack and newer for bzrlib native formats)
652
 
        support refresh_data inside write groups. If called inside a write
653
 
        group on a repository that does not support refreshing in a write group
654
 
        IsInWriteGroupError will be raised.
 
1483
        repository. It may not be called during a write group, but may be
 
1484
        called at any other time.
655
1485
        """
 
1486
        if self.is_in_write_group():
 
1487
            raise errors.InternalBzrError(
 
1488
                "May not refresh_data while in a write group.")
656
1489
        self._refresh_data()
657
1490
 
658
1491
    def resume_write_group(self, tokens):
667
1500
    def _resume_write_group(self, tokens):
668
1501
        raise errors.UnsuspendableWriteGroup(self)
669
1502
 
670
 
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
1503
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
671
1504
            fetch_spec=None):
672
1505
        """Fetch the content required to construct revision_id from source.
673
1506
 
696
1529
            raise errors.InternalBzrError(
697
1530
                "May not fetch while in a write group.")
698
1531
        # fast path same-url fetch operations
699
 
        # TODO: lift out to somewhere common with RemoteRepository
700
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
701
 
        if (self.has_same_location(source)
702
 
            and fetch_spec is None
703
 
            and self._has_same_fallbacks(source)):
 
1532
        if self.has_same_location(source) and fetch_spec is None:
704
1533
            # check that last_revision is in 'from' and then return a
705
1534
            # no-operation.
706
1535
            if (revision_id is not None and
707
1536
                not _mod_revision.is_null(revision_id)):
708
1537
                self.get_revision(revision_id)
709
1538
            return 0, []
 
1539
        # if there is no specific appropriate InterRepository, this will get
 
1540
        # the InterRepository base class, which raises an
 
1541
        # IncompatibleRepositories when asked to fetch.
710
1542
        inter = InterRepository.get(source, self)
711
 
        return inter.fetch(revision_id=revision_id,
 
1543
        return inter.fetch(revision_id=revision_id, pb=pb,
712
1544
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
713
1545
 
714
1546
    def create_bundle(self, target, base, fileobj, format=None):
716
1548
 
717
1549
    def get_commit_builder(self, branch, parents, config, timestamp=None,
718
1550
                           timezone=None, committer=None, revprops=None,
719
 
                           revision_id=None, lossy=False):
 
1551
                           revision_id=None):
720
1552
        """Obtain a CommitBuilder for this repository.
721
1553
 
722
1554
        :param branch: Branch to commit to.
727
1559
        :param committer: Optional committer to set for commit.
728
1560
        :param revprops: Optional dictionary of revision properties.
729
1561
        :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
1562
        """
733
 
        raise NotImplementedError(self.get_commit_builder)
 
1563
        result = self._commit_builder_class(self, parents, config,
 
1564
            timestamp, timezone, committer, revprops, revision_id)
 
1565
        self.start_write_group()
 
1566
        return result
734
1567
 
735
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
736
1568
    def unlock(self):
737
1569
        if (self.control_files._lock_count == 1 and
738
1570
            self.control_files._lock_mode == 'w'):
743
1575
                    'Must end write groups before releasing write locks.')
744
1576
        self.control_files.unlock()
745
1577
        if self.control_files._lock_count == 0:
 
1578
            self._inventory_entry_cache.clear()
746
1579
            for repo in self._fallback_repositories:
747
1580
                repo.unlock()
748
1581
 
813
1646
                dest_repo = a_bzrdir.open_repository()
814
1647
        return dest_repo
815
1648
 
 
1649
    def _get_sink(self):
 
1650
        """Return a sink for streaming into this repository."""
 
1651
        return StreamSink(self)
 
1652
 
 
1653
    def _get_source(self, to_format):
 
1654
        """Return a source for streaming from this repository."""
 
1655
        return StreamSource(self, to_format)
 
1656
 
816
1657
    @needs_read_lock
817
1658
    def has_revision(self, revision_id):
818
1659
        """True if this repository has a copy of the revision."""
825
1666
        :param revision_ids: An iterable of revision_ids.
826
1667
        :return: A set of the revision_ids that were present.
827
1668
        """
828
 
        raise NotImplementedError(self.has_revisions)
 
1669
        parent_map = self.revisions.get_parent_map(
 
1670
            [(rev_id,) for rev_id in revision_ids])
 
1671
        result = set()
 
1672
        if _mod_revision.NULL_REVISION in revision_ids:
 
1673
            result.add(_mod_revision.NULL_REVISION)
 
1674
        result.update([key[0] for key in parent_map])
 
1675
        return result
829
1676
 
830
1677
    @needs_read_lock
831
1678
    def get_revision(self, revision_id):
832
1679
        """Return the Revision object for a named revision."""
833
1680
        return self.get_revisions([revision_id])[0]
834
1681
 
 
1682
    @needs_read_lock
835
1683
    def get_revision_reconcile(self, revision_id):
836
1684
        """'reconcile' helper routine that allows access to a revision always.
837
1685
 
840
1688
        be used by reconcile, or reconcile-alike commands that are correcting
841
1689
        or testing the revision graph.
842
1690
        """
843
 
        raise NotImplementedError(self.get_revision_reconcile)
 
1691
        return self._get_revisions([revision_id])[0]
844
1692
 
 
1693
    @needs_read_lock
845
1694
    def get_revisions(self, revision_ids):
846
 
        """Get many revisions at once.
847
 
        
848
 
        Repositories that need to check data on every revision read should 
849
 
        subclass this method.
850
 
        """
851
 
        raise NotImplementedError(self.get_revisions)
 
1695
        """Get many revisions at once."""
 
1696
        return self._get_revisions(revision_ids)
 
1697
 
 
1698
    @needs_read_lock
 
1699
    def _get_revisions(self, revision_ids):
 
1700
        """Core work logic to get many revisions without sanity checks."""
 
1701
        for rev_id in revision_ids:
 
1702
            if not rev_id or not isinstance(rev_id, basestring):
 
1703
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1704
        keys = [(key,) for key in revision_ids]
 
1705
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1706
        revs = {}
 
1707
        for record in stream:
 
1708
            if record.storage_kind == 'absent':
 
1709
                raise errors.NoSuchRevision(self, record.key[0])
 
1710
            text = record.get_bytes_as('fulltext')
 
1711
            rev = self._serializer.read_revision_from_string(text)
 
1712
            revs[record.key[0]] = rev
 
1713
        return [revs[revid] for revid in revision_ids]
 
1714
 
 
1715
    @needs_read_lock
 
1716
    def get_revision_xml(self, revision_id):
 
1717
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1718
        #       would have already do it.
 
1719
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1720
        # TODO: this can't just be replaced by:
 
1721
        # return self._serializer.write_revision_to_string(
 
1722
        #     self.get_revision(revision_id))
 
1723
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1724
        # or some other call down the path.
 
1725
        rev = self.get_revision(revision_id)
 
1726
        rev_tmp = cStringIO.StringIO()
 
1727
        # the current serializer..
 
1728
        self._serializer.write_revision(rev, rev_tmp)
 
1729
        rev_tmp.seek(0)
 
1730
        return rev_tmp.getvalue()
852
1731
 
853
1732
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
854
1733
        """Produce a generator of revision deltas.
909
1788
        signature = gpg_strategy.sign(plaintext)
910
1789
        self.add_signature_text(revision_id, signature)
911
1790
 
 
1791
    @needs_write_lock
912
1792
    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)
 
1793
        self.signatures.add_lines((revision_id,), (),
 
1794
            osutils.split_lines(signature))
 
1795
 
 
1796
    def find_text_key_references(self):
 
1797
        """Find the text key references within the repository.
 
1798
 
 
1799
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1800
            to whether they were referred to by the inventory of the
 
1801
            revision_id that they contain. The inventory texts from all present
 
1802
            revision ids are assessed to generate this report.
 
1803
        """
 
1804
        revision_keys = self.revisions.keys()
 
1805
        w = self.inventories
 
1806
        pb = ui.ui_factory.nested_progress_bar()
 
1807
        try:
 
1808
            return self._find_text_key_references_from_xml_inventory_lines(
 
1809
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1810
        finally:
 
1811
            pb.finished()
 
1812
 
 
1813
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1814
        line_iterator):
 
1815
        """Core routine for extracting references to texts from inventories.
 
1816
 
 
1817
        This performs the translation of xml lines to revision ids.
 
1818
 
 
1819
        :param line_iterator: An iterator of lines, origin_version_id
 
1820
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1821
            to whether they were referred to by the inventory of the
 
1822
            revision_id that they contain. Note that if that revision_id was
 
1823
            not part of the line_iterator's output then False will be given -
 
1824
            even though it may actually refer to that key.
 
1825
        """
 
1826
        if not self._serializer.support_altered_by_hack:
 
1827
            raise AssertionError(
 
1828
                "_find_text_key_references_from_xml_inventory_lines only "
 
1829
                "supported for branches which store inventory as unnested xml"
 
1830
                ", not on %r" % self)
 
1831
        result = {}
 
1832
 
 
1833
        # this code needs to read every new line in every inventory for the
 
1834
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
1835
        # not present in one of those inventories is unnecessary but not
 
1836
        # harmful because we are filtering by the revision id marker in the
 
1837
        # inventory lines : we only select file ids altered in one of those
 
1838
        # revisions. We don't need to see all lines in the inventory because
 
1839
        # only those added in an inventory in rev X can contain a revision=X
 
1840
        # line.
 
1841
        unescape_revid_cache = {}
 
1842
        unescape_fileid_cache = {}
 
1843
 
 
1844
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1845
        # of lines, so it has had a lot of inlining and optimizing done.
 
1846
        # Sorry that it is a little bit messy.
 
1847
        # Move several functions to be local variables, since this is a long
 
1848
        # running loop.
 
1849
        search = self._file_ids_altered_regex.search
 
1850
        unescape = _unescape_xml
 
1851
        setdefault = result.setdefault
 
1852
        for line, line_key in line_iterator:
 
1853
            match = search(line)
 
1854
            if match is None:
 
1855
                continue
 
1856
            # One call to match.group() returning multiple items is quite a
 
1857
            # bit faster than 2 calls to match.group() each returning 1
 
1858
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1859
 
 
1860
            # Inlining the cache lookups helps a lot when you make 170,000
 
1861
            # lines and 350k ids, versus 8.4 unique ids.
 
1862
            # Using a cache helps in 2 ways:
 
1863
            #   1) Avoids unnecessary decoding calls
 
1864
            #   2) Re-uses cached strings, which helps in future set and
 
1865
            #      equality checks.
 
1866
            # (2) is enough that removing encoding entirely along with
 
1867
            # the cache (so we are using plain strings) results in no
 
1868
            # performance improvement.
 
1869
            try:
 
1870
                revision_id = unescape_revid_cache[revision_id]
 
1871
            except KeyError:
 
1872
                unescaped = unescape(revision_id)
 
1873
                unescape_revid_cache[revision_id] = unescaped
 
1874
                revision_id = unescaped
 
1875
 
 
1876
            # Note that unconditionally unescaping means that we deserialise
 
1877
            # every fileid, which for general 'pull' is not great, but we don't
 
1878
            # really want to have some many fulltexts that this matters anyway.
 
1879
            # RBC 20071114.
 
1880
            try:
 
1881
                file_id = unescape_fileid_cache[file_id]
 
1882
            except KeyError:
 
1883
                unescaped = unescape(file_id)
 
1884
                unescape_fileid_cache[file_id] = unescaped
 
1885
                file_id = unescaped
 
1886
 
 
1887
            key = (file_id, revision_id)
 
1888
            setdefault(key, False)
 
1889
            if revision_id == line_key[-1]:
 
1890
                result[key] = True
 
1891
        return result
 
1892
 
 
1893
    def _inventory_xml_lines_for_keys(self, keys):
 
1894
        """Get a line iterator of the sort needed for findind references.
 
1895
 
 
1896
        Not relevant for non-xml inventory repositories.
 
1897
 
 
1898
        Ghosts in revision_keys are ignored.
 
1899
 
 
1900
        :param revision_keys: The revision keys for the inventories to inspect.
 
1901
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
1902
            all of the xml inventories specified by revision_keys.
 
1903
        """
 
1904
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1905
        for record in stream:
 
1906
            if record.storage_kind != 'absent':
 
1907
                chunks = record.get_bytes_as('chunked')
 
1908
                revid = record.key[-1]
 
1909
                lines = osutils.chunks_to_lines(chunks)
 
1910
                for line in lines:
 
1911
                    yield line, revid
 
1912
 
 
1913
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1914
        revision_keys):
 
1915
        """Helper routine for fileids_altered_by_revision_ids.
 
1916
 
 
1917
        This performs the translation of xml lines to revision ids.
 
1918
 
 
1919
        :param line_iterator: An iterator of lines, origin_version_id
 
1920
        :param revision_keys: The revision ids to filter for. This should be a
 
1921
            set or other type which supports efficient __contains__ lookups, as
 
1922
            the revision key from each parsed line will be looked up in the
 
1923
            revision_keys filter.
 
1924
        :return: a dictionary mapping altered file-ids to an iterable of
 
1925
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1926
        altered it listed explicitly.
 
1927
        """
 
1928
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
1929
                line_iterator).iterkeys())
 
1930
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1931
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
1932
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1933
        new_keys = seen - parent_seen
 
1934
        result = {}
 
1935
        setdefault = result.setdefault
 
1936
        for key in new_keys:
 
1937
            setdefault(key[0], set()).add(key[-1])
 
1938
        return result
919
1939
 
920
1940
    def _find_parent_ids_of_revisions(self, revision_ids):
921
1941
        """Find all parent ids that are mentioned in the revision graph.
930
1950
        parent_ids.discard(_mod_revision.NULL_REVISION)
931
1951
        return parent_ids
932
1952
 
933
 
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1953
    def _find_parent_keys_of_revisions(self, revision_keys):
 
1954
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
1955
 
 
1956
        :param revision_keys: An iterable of revision_keys.
 
1957
        :return: The parents of all revision_keys that are not already in
 
1958
            revision_keys
 
1959
        """
 
1960
        parent_map = self.revisions.get_parent_map(revision_keys)
 
1961
        parent_keys = set()
 
1962
        map(parent_keys.update, parent_map.itervalues())
 
1963
        parent_keys.difference_update(revision_keys)
 
1964
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
1965
        return parent_keys
 
1966
 
 
1967
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
934
1968
        """Find the file ids and versions affected by revisions.
935
1969
 
936
1970
        :param revisions: an iterable containing revision ids.
 
1971
        :param _inv_weave: The inventory weave from this repository or None.
 
1972
            If None, the inventory weave will be opened automatically.
937
1973
        :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.
 
1974
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1975
        altered it listed explicitly.
940
1976
        """
941
 
        raise NotImplementedError(self.fileids_altered_by_revision_ids)
 
1977
        selected_keys = set((revid,) for revid in revision_ids)
 
1978
        w = _inv_weave or self.inventories
 
1979
        pb = ui.ui_factory.nested_progress_bar()
 
1980
        try:
 
1981
            return self._find_file_ids_from_xml_inventory_lines(
 
1982
                w.iter_lines_added_or_present_in_keys(
 
1983
                    selected_keys, pb=pb),
 
1984
                selected_keys)
 
1985
        finally:
 
1986
            pb.finished()
942
1987
 
943
1988
    def iter_files_bytes(self, desired_files):
944
1989
        """Iterate through file versions.
951
1996
        uniquely identify the file version in the caller's context.  (Examples:
952
1997
        an index number or a TreeTransform trans_id.)
953
1998
 
 
1999
        bytes_iterator is an iterable of bytestrings for the file.  The
 
2000
        kind of iterable and length of the bytestrings are unspecified, but for
 
2001
        this implementation, it is a list of bytes produced by
 
2002
        VersionedFile.get_record_stream().
 
2003
 
954
2004
        :param desired_files: a list of (file_id, revision_id, identifier)
955
2005
            triples
956
2006
        """
957
 
        raise NotImplementedError(self.iter_files_bytes)
 
2007
        text_keys = {}
 
2008
        for file_id, revision_id, callable_data in desired_files:
 
2009
            text_keys[(file_id, revision_id)] = callable_data
 
2010
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
2011
            if record.storage_kind == 'absent':
 
2012
                raise errors.RevisionNotPresent(record.key, self)
 
2013
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
2014
 
 
2015
    def _generate_text_key_index(self, text_key_references=None,
 
2016
        ancestors=None):
 
2017
        """Generate a new text key index for the repository.
 
2018
 
 
2019
        This is an expensive function that will take considerable time to run.
 
2020
 
 
2021
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
2022
            list of parents, also text keys. When a given key has no parents,
 
2023
            the parents list will be [NULL_REVISION].
 
2024
        """
 
2025
        # All revisions, to find inventory parents.
 
2026
        if ancestors is None:
 
2027
            graph = self.get_graph()
 
2028
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
2029
        if text_key_references is None:
 
2030
            text_key_references = self.find_text_key_references()
 
2031
        pb = ui.ui_factory.nested_progress_bar()
 
2032
        try:
 
2033
            return self._do_generate_text_key_index(ancestors,
 
2034
                text_key_references, pb)
 
2035
        finally:
 
2036
            pb.finished()
 
2037
 
 
2038
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
2039
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
2040
        revision_order = tsort.topo_sort(ancestors)
 
2041
        invalid_keys = set()
 
2042
        revision_keys = {}
 
2043
        for revision_id in revision_order:
 
2044
            revision_keys[revision_id] = set()
 
2045
        text_count = len(text_key_references)
 
2046
        # a cache of the text keys to allow reuse; costs a dict of all the
 
2047
        # keys, but saves a 2-tuple for every child of a given key.
 
2048
        text_key_cache = {}
 
2049
        for text_key, valid in text_key_references.iteritems():
 
2050
            if not valid:
 
2051
                invalid_keys.add(text_key)
 
2052
            else:
 
2053
                revision_keys[text_key[1]].add(text_key)
 
2054
            text_key_cache[text_key] = text_key
 
2055
        del text_key_references
 
2056
        text_index = {}
 
2057
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
2058
        NULL_REVISION = _mod_revision.NULL_REVISION
 
2059
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
2060
        # too small for large or very branchy trees. However, for 55K path
 
2061
        # trees, it would be easy to use too much memory trivially. Ideally we
 
2062
        # could gauge this by looking at available real memory etc, but this is
 
2063
        # always a tricky proposition.
 
2064
        inventory_cache = lru_cache.LRUCache(10)
 
2065
        batch_size = 10 # should be ~150MB on a 55K path tree
 
2066
        batch_count = len(revision_order) / batch_size + 1
 
2067
        processed_texts = 0
 
2068
        pb.update("Calculating text parents", processed_texts, text_count)
 
2069
        for offset in xrange(batch_count):
 
2070
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
2071
                batch_size]
 
2072
            if not to_query:
 
2073
                break
 
2074
            for rev_tree in self.revision_trees(to_query):
 
2075
                revision_id = rev_tree.get_revision_id()
 
2076
                parent_ids = ancestors[revision_id]
 
2077
                for text_key in revision_keys[revision_id]:
 
2078
                    pb.update("Calculating text parents", processed_texts)
 
2079
                    processed_texts += 1
 
2080
                    candidate_parents = []
 
2081
                    for parent_id in parent_ids:
 
2082
                        parent_text_key = (text_key[0], parent_id)
 
2083
                        try:
 
2084
                            check_parent = parent_text_key not in \
 
2085
                                revision_keys[parent_id]
 
2086
                        except KeyError:
 
2087
                            # the parent parent_id is a ghost:
 
2088
                            check_parent = False
 
2089
                            # truncate the derived graph against this ghost.
 
2090
                            parent_text_key = None
 
2091
                        if check_parent:
 
2092
                            # look at the parent commit details inventories to
 
2093
                            # determine possible candidates in the per file graph.
 
2094
                            # TODO: cache here.
 
2095
                            try:
 
2096
                                inv = inventory_cache[parent_id]
 
2097
                            except KeyError:
 
2098
                                inv = self.revision_tree(parent_id).inventory
 
2099
                                inventory_cache[parent_id] = inv
 
2100
                            try:
 
2101
                                parent_entry = inv[text_key[0]]
 
2102
                            except (KeyError, errors.NoSuchId):
 
2103
                                parent_entry = None
 
2104
                            if parent_entry is not None:
 
2105
                                parent_text_key = (
 
2106
                                    text_key[0], parent_entry.revision)
 
2107
                            else:
 
2108
                                parent_text_key = None
 
2109
                        if parent_text_key is not None:
 
2110
                            candidate_parents.append(
 
2111
                                text_key_cache[parent_text_key])
 
2112
                    parent_heads = text_graph.heads(candidate_parents)
 
2113
                    new_parents = list(parent_heads)
 
2114
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
2115
                    if new_parents == []:
 
2116
                        new_parents = [NULL_REVISION]
 
2117
                    text_index[text_key] = new_parents
 
2118
 
 
2119
        for text_key in invalid_keys:
 
2120
            text_index[text_key] = [NULL_REVISION]
 
2121
        return text_index
 
2122
 
 
2123
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
2124
        """Get an iterable listing the keys of all the data introduced by a set
 
2125
        of revision IDs.
 
2126
 
 
2127
        The keys will be ordered so that the corresponding items can be safely
 
2128
        fetched and inserted in that order.
 
2129
 
 
2130
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
2131
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
2132
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
2133
        """
 
2134
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2135
            yield result
 
2136
        del _files_pb
 
2137
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2138
            yield result
 
2139
 
 
2140
    def _find_file_keys_to_fetch(self, revision_ids, pb):
 
2141
        # XXX: it's a bit weird to control the inventory weave caching in this
 
2142
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
2143
        # maybe this generator should explicitly have the contract that it
 
2144
        # should not be iterated until the previously yielded item has been
 
2145
        # processed?
 
2146
        inv_w = self.inventories
 
2147
 
 
2148
        # file ids that changed
 
2149
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
2150
        count = 0
 
2151
        num_file_ids = len(file_ids)
 
2152
        for file_id, altered_versions in file_ids.iteritems():
 
2153
            if pb is not None:
 
2154
                pb.update("fetch texts", count, num_file_ids)
 
2155
            count += 1
 
2156
            yield ("file", file_id, altered_versions)
 
2157
 
 
2158
    def _find_non_file_keys_to_fetch(self, revision_ids):
 
2159
        # inventory
 
2160
        yield ("inventory", None, revision_ids)
 
2161
 
 
2162
        # signatures
 
2163
        # XXX: Note ATM no callers actually pay attention to this return
 
2164
        #      instead they just use the list of revision ids and ignore
 
2165
        #      missing sigs. Consider removing this work entirely
 
2166
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2167
            [(r,) for r in revision_ids]))
 
2168
        revisions_with_signatures = set(
 
2169
            [r for (r,) in revisions_with_signatures])
 
2170
        revisions_with_signatures.intersection_update(revision_ids)
 
2171
        yield ("signatures", None, revisions_with_signatures)
 
2172
 
 
2173
        # revisions
 
2174
        yield ("revisions", None, revision_ids)
 
2175
 
 
2176
    @needs_read_lock
 
2177
    def get_inventory(self, revision_id):
 
2178
        """Get Inventory object by revision id."""
 
2179
        return self.iter_inventories([revision_id]).next()
 
2180
 
 
2181
    def iter_inventories(self, revision_ids):
 
2182
        """Get many inventories by revision_ids.
 
2183
 
 
2184
        This will buffer some or all of the texts used in constructing the
 
2185
        inventories in memory, but will only parse a single inventory at a
 
2186
        time.
 
2187
 
 
2188
        :param revision_ids: The expected revision ids of the inventories.
 
2189
        :return: An iterator of inventories.
 
2190
        """
 
2191
        if ((None in revision_ids)
 
2192
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
2193
            raise ValueError('cannot get null revision inventory')
 
2194
        return self._iter_inventories(revision_ids)
 
2195
 
 
2196
    def _iter_inventories(self, revision_ids):
 
2197
        """single-document based inventory iteration."""
 
2198
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2199
            yield self.deserialise_inventory(revision_id, text)
 
2200
 
 
2201
    def _iter_inventory_xmls(self, revision_ids):
 
2202
        keys = [(revision_id,) for revision_id in revision_ids]
 
2203
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2204
        text_chunks = {}
 
2205
        for record in stream:
 
2206
            if record.storage_kind != 'absent':
 
2207
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
2208
            else:
 
2209
                raise errors.NoSuchRevision(self, record.key)
 
2210
        for key in keys:
 
2211
            chunks = text_chunks.pop(key)
 
2212
            yield ''.join(chunks), key[-1]
 
2213
 
 
2214
    def deserialise_inventory(self, revision_id, xml):
 
2215
        """Transform the xml into an inventory object.
 
2216
 
 
2217
        :param revision_id: The expected revision id of the inventory.
 
2218
        :param xml: A serialised inventory.
 
2219
        """
 
2220
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2221
                    entry_cache=self._inventory_entry_cache)
 
2222
        if result.revision_id != revision_id:
 
2223
            raise AssertionError('revision id mismatch %s != %s' % (
 
2224
                result.revision_id, revision_id))
 
2225
        return result
 
2226
 
 
2227
    def serialise_inventory(self, inv):
 
2228
        return self._serializer.write_inventory_to_string(inv)
 
2229
 
 
2230
    def _serialise_inventory_to_lines(self, inv):
 
2231
        return self._serializer.write_inventory_to_lines(inv)
 
2232
 
 
2233
    def get_serializer_format(self):
 
2234
        return self._serializer.format_num
 
2235
 
 
2236
    @needs_read_lock
 
2237
    def get_inventory_xml(self, revision_id):
 
2238
        """Get inventory XML as a file object."""
 
2239
        texts = self._iter_inventory_xmls([revision_id])
 
2240
        try:
 
2241
            text, revision_id = texts.next()
 
2242
        except StopIteration:
 
2243
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
2244
        return text
 
2245
 
 
2246
    @needs_read_lock
 
2247
    def get_inventory_sha1(self, revision_id):
 
2248
        """Return the sha1 hash of the inventory entry
 
2249
        """
 
2250
        return self.get_revision(revision_id).inventory_sha1
958
2251
 
959
2252
    def get_rev_id_for_revno(self, revno, known_pair):
960
2253
        """Return the revision id of a revno, given a later (revno, revid)
991
2284
            raise AssertionError('_iter_for_revno returned too much history')
992
2285
        return (True, partial_history[-1])
993
2286
 
994
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
995
2287
    def iter_reverse_revision_history(self, revision_id):
996
2288
        """Iterate backwards through revision ids in the lefthand history
997
2289
 
999
2291
            ancestors will be traversed.
1000
2292
        """
1001
2293
        graph = self.get_graph()
1002
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
1003
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
 
2294
        next_id = revision_id
 
2295
        while True:
 
2296
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2297
                return
 
2298
            try:
 
2299
                parents = graph.get_parent_map([next_id])[next_id]
 
2300
            except KeyError:
 
2301
                raise errors.RevisionNotPresent(next_id, self)
 
2302
            yield next_id
 
2303
            if len(parents) == 0:
 
2304
                return
 
2305
            else:
 
2306
                next_id = parents[0]
 
2307
 
 
2308
    @needs_read_lock
 
2309
    def get_revision_inventory(self, revision_id):
 
2310
        """Return inventory of a past revision."""
 
2311
        # TODO: Unify this with get_inventory()
 
2312
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2313
        # must be the same as its revision, so this is trivial.
 
2314
        if revision_id is None:
 
2315
            # This does not make sense: if there is no revision,
 
2316
            # then it is the current tree inventory surely ?!
 
2317
            # and thus get_root_id() is something that looks at the last
 
2318
            # commit on the branch, and the get_root_id is an inventory check.
 
2319
            raise NotImplementedError
 
2320
            # return Inventory(self.get_root_id())
 
2321
        else:
 
2322
            return self.get_inventory(revision_id)
1004
2323
 
1005
2324
    def is_shared(self):
1006
2325
        """Return True if this repository is flagged as a shared repository."""
1034
2353
 
1035
2354
        `revision_id` may be NULL_REVISION for the empty tree revision.
1036
2355
        """
1037
 
        raise NotImplementedError(self.revision_tree)
 
2356
        revision_id = _mod_revision.ensure_null(revision_id)
 
2357
        # TODO: refactor this to use an existing revision object
 
2358
        # so we don't need to read it in twice.
 
2359
        if revision_id == _mod_revision.NULL_REVISION:
 
2360
            return RevisionTree(self, Inventory(root_id=None),
 
2361
                                _mod_revision.NULL_REVISION)
 
2362
        else:
 
2363
            inv = self.get_revision_inventory(revision_id)
 
2364
            return RevisionTree(self, inv, revision_id)
1038
2365
 
1039
2366
    def revision_trees(self, revision_ids):
1040
2367
        """Return Trees for revisions in this repository.
1042
2369
        :param revision_ids: a sequence of revision-ids;
1043
2370
          a revision-id may not be None or 'null:'
1044
2371
        """
1045
 
        raise NotImplementedError(self.revision_trees)
 
2372
        inventories = self.iter_inventories(revision_ids)
 
2373
        for inv in inventories:
 
2374
            yield RevisionTree(self, inv, inv.revision_id)
 
2375
 
 
2376
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2377
        """Return Tree for a revision on this branch with only some files.
 
2378
 
 
2379
        :param revision_ids: a sequence of revision-ids;
 
2380
          a revision-id may not be None or 'null:'
 
2381
        :param file_ids: if not None, the result is filtered
 
2382
          so that only those file-ids, their parents and their
 
2383
          children are included.
 
2384
        """
 
2385
        inventories = self.iter_inventories(revision_ids)
 
2386
        for inv in inventories:
 
2387
            # Should we introduce a FilteredRevisionTree class rather
 
2388
            # than pre-filter the inventory here?
 
2389
            filtered_inv = inv.filter(file_ids)
 
2390
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
1046
2391
 
1047
2392
    @needs_read_lock
1048
 
    @symbol_versioning.deprecated_method(
1049
 
        symbol_versioning.deprecated_in((2, 4, 0)))
1050
2393
    def get_ancestry(self, revision_id, topo_sorted=True):
1051
2394
        """Return a list of revision-ids integrated by a revision.
1052
2395
 
1056
2399
 
1057
2400
        This is topologically sorted.
1058
2401
        """
1059
 
        if 'evil' in debug.debug_flags:
1060
 
            mutter_callsite(2, "get_ancestry is linear with history.")
1061
2402
        if _mod_revision.is_null(revision_id):
1062
2403
            return [None]
1063
2404
        if not self.has_revision(revision_id):
1078
2419
            keys = tsort.topo_sort(parent_map)
1079
2420
        return [None] + list(keys)
1080
2421
 
1081
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2422
    def pack(self, hint=None):
1082
2423
        """Compress the data within the repository.
1083
2424
 
1084
2425
        This operation only makes sense for some repository types. For other
1085
2426
        types it should be a no-op that just returns.
1086
2427
 
1087
2428
        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
 
2429
        @needs_write_lock as this is a long running call its reasonable to
1089
2430
        implicitly lock for the user.
1090
2431
 
1091
2432
        :param hint: If not supplied, the whole repository is packed.
1094
2435
            obtained from the result of commit_write_group(). Out of
1095
2436
            date hints are simply ignored, because concurrent operations
1096
2437
            can obsolete them rapidly.
1097
 
 
1098
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
1099
 
            the pack operation.
1100
2438
        """
1101
2439
 
1102
2440
    def get_transaction(self):
1104
2442
 
1105
2443
    def get_parent_map(self, revision_ids):
1106
2444
        """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
2445
        # revisions index works in keys; this just works in revisions
1112
2446
        # therefore wrap and unwrap
1113
2447
        query_keys = []
1119
2453
                raise ValueError('get_parent_map(None) is not valid')
1120
2454
            else:
1121
2455
                query_keys.append((revision_id ,))
1122
 
        vf = self.revisions.without_fallbacks()
1123
2456
        for ((revision_id,), parent_keys) in \
1124
 
                vf.get_parent_map(query_keys).iteritems():
 
2457
                self.revisions.get_parent_map(query_keys).iteritems():
1125
2458
            if parent_keys:
1126
 
                result[revision_id] = tuple([parent_revid
1127
 
                    for (parent_revid,) in parent_keys])
 
2459
                result[revision_id] = tuple(parent_revid
 
2460
                    for (parent_revid,) in parent_keys)
1128
2461
            else:
1129
2462
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1130
2463
        return result
1131
2464
 
1132
2465
    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)
1142
 
 
1143
 
    @needs_read_lock
1144
 
    def get_known_graph_ancestry(self, revision_ids):
1145
 
        """Return the known graph for a set of revision ids and their ancestors.
1146
 
        """
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)
 
2466
        return self
1152
2467
 
1153
2468
    def get_graph(self, other_repository=None):
1154
2469
        """Return the graph walker for this repository format"""
1159
2474
                [parents_provider, other_repository._make_parents_provider()])
1160
2475
        return graph.Graph(parents_provider)
1161
2476
 
 
2477
    def _get_versioned_file_checker(self, text_key_references=None):
 
2478
        """Return an object suitable for checking versioned files.
 
2479
        
 
2480
        :param text_key_references: if non-None, an already built
 
2481
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2482
            to whether they were referred to by the inventory of the
 
2483
            revision_id that they contain. If None, this will be
 
2484
            calculated.
 
2485
        """
 
2486
        return _VersionedFileChecker(self,
 
2487
            text_key_references=text_key_references)
 
2488
 
1162
2489
    def revision_ids_to_search_result(self, result_set):
1163
2490
        """Convert a set of revision ids to a graph SearchResult."""
1164
2491
        result_parents = set()
1190
2517
 
1191
2518
    @needs_write_lock
1192
2519
    def sign_revision(self, revision_id, gpg_strategy):
1193
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1194
 
        plaintext = testament.as_short_text()
 
2520
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1195
2521
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1196
2522
 
1197
2523
    @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
2524
    def has_signature_for_revision_id(self, revision_id):
1216
2525
        """Query for a revision signature for revision_id in the repository."""
1217
 
        raise NotImplementedError(self.has_signature_for_revision_id)
 
2526
        if not self.has_revision(revision_id):
 
2527
            raise errors.NoSuchRevision(self, revision_id)
 
2528
        sig_present = (1 == len(
 
2529
            self.signatures.get_parent_map([(revision_id,)])))
 
2530
        return sig_present
1218
2531
 
 
2532
    @needs_read_lock
1219
2533
    def get_signature_text(self, revision_id):
1220
2534
        """Return the text for a signature."""
1221
 
        raise NotImplementedError(self.get_signature_text)
 
2535
        stream = self.signatures.get_record_stream([(revision_id,)],
 
2536
            'unordered', True)
 
2537
        record = stream.next()
 
2538
        if record.storage_kind == 'absent':
 
2539
            raise errors.NoSuchRevision(self, revision_id)
 
2540
        return record.get_bytes_as('fulltext')
1222
2541
 
1223
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2542
    @needs_read_lock
 
2543
    def check(self, revision_ids=None):
1224
2544
        """Check consistency of all history of given revision_ids.
1225
2545
 
1226
2546
        Different repository implementations should override _check().
1227
2547
 
1228
2548
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1229
2549
             will be checked.  Typically the last revision_id of a branch.
1230
 
        :param callback_refs: A dict of check-refs to resolve and callback
1231
 
            the check/_check method on the items listed as wanting the ref.
1232
 
            see bzrlib.check.
1233
 
        :param check_repo: If False do not check the repository contents, just 
1234
 
            calculate the data callback_refs requires and call them back.
1235
2550
        """
1236
 
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1237
 
            check_repo=check_repo)
1238
 
 
1239
 
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1240
 
        raise NotImplementedError(self.check)
1241
 
 
1242
 
    def _warn_if_deprecated(self, branch=None):
1243
 
        if not self._format.is_deprecated():
1244
 
            return
 
2551
        return self._check(revision_ids)
 
2552
 
 
2553
    def _check(self, revision_ids):
 
2554
        result = check.Check(self)
 
2555
        result.check()
 
2556
        return result
 
2557
 
 
2558
    def _warn_if_deprecated(self):
1245
2559
        global _deprecation_warning_done
1246
2560
        if _deprecation_warning_done:
1247
2561
            return
1248
 
        try:
1249
 
            if branch is None:
1250
 
                conf = config.GlobalConfig()
1251
 
            else:
1252
 
                conf = branch.get_config()
1253
 
            if conf.suppress_warning('format_deprecation'):
1254
 
                return
1255
 
            warning("Format %s for %s is deprecated -"
1256
 
                    " please use 'bzr upgrade' to get better performance"
1257
 
                    % (self._format, self.bzrdir.transport.base))
1258
 
        finally:
1259
 
            _deprecation_warning_done = True
 
2562
        _deprecation_warning_done = True
 
2563
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2564
                % (self._format, self.bzrdir.transport.base))
1260
2565
 
1261
2566
    def supports_rich_root(self):
1262
2567
        return self._format.rich_root_data
1277
2582
                except UnicodeDecodeError:
1278
2583
                    raise errors.NonAsciiRevisionId(method, self)
1279
2584
 
 
2585
    def revision_graph_can_have_wrong_parents(self):
 
2586
        """Is it possible for this repository to have a revision graph with
 
2587
        incorrect parents?
 
2588
 
 
2589
        If True, then this repository must also implement
 
2590
        _find_inconsistent_revision_parents so that check and reconcile can
 
2591
        check for inconsistencies before proceeding with other checks that may
 
2592
        depend on the revision index being consistent.
 
2593
        """
 
2594
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
2595
 
 
2596
 
 
2597
# remove these delegates a while after bzr 0.15
 
2598
def __make_delegated(name, from_module):
 
2599
    def _deprecated_repository_forwarder():
 
2600
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
2601
            % (name, from_module),
 
2602
            DeprecationWarning,
 
2603
            stacklevel=2)
 
2604
        m = __import__(from_module, globals(), locals(), [name])
 
2605
        try:
 
2606
            return getattr(m, name)
 
2607
        except AttributeError:
 
2608
            raise AttributeError('module %s has no name %s'
 
2609
                    % (m, name))
 
2610
    globals()[name] = _deprecated_repository_forwarder
 
2611
 
 
2612
for _name in [
 
2613
        'AllInOneRepository',
 
2614
        'WeaveMetaDirRepository',
 
2615
        'PreSplitOutRepositoryFormat',
 
2616
        'RepositoryFormat4',
 
2617
        'RepositoryFormat5',
 
2618
        'RepositoryFormat6',
 
2619
        'RepositoryFormat7',
 
2620
        ]:
 
2621
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
2622
 
 
2623
for _name in [
 
2624
        'KnitRepository',
 
2625
        'RepositoryFormatKnit',
 
2626
        'RepositoryFormatKnit1',
 
2627
        ]:
 
2628
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
2629
 
 
2630
 
 
2631
def install_revision(repository, rev, revision_tree):
 
2632
    """Install all revision data into a repository."""
 
2633
    install_revisions(repository, [(rev, revision_tree, None)])
 
2634
 
 
2635
 
 
2636
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2637
    """Install all revision data into a repository.
 
2638
 
 
2639
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2640
    may be None.
 
2641
    """
 
2642
    repository.start_write_group()
 
2643
    try:
 
2644
        inventory_cache = lru_cache.LRUCache(10)
 
2645
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2646
            _install_revision(repository, revision, revision_tree, signature,
 
2647
                inventory_cache)
 
2648
            if pb is not None:
 
2649
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2650
    except:
 
2651
        repository.abort_write_group()
 
2652
        raise
 
2653
    else:
 
2654
        repository.commit_write_group()
 
2655
 
 
2656
 
 
2657
def _install_revision(repository, rev, revision_tree, signature,
 
2658
    inventory_cache):
 
2659
    """Install all revision data into a repository."""
 
2660
    present_parents = []
 
2661
    parent_trees = {}
 
2662
    for p_id in rev.parent_ids:
 
2663
        if repository.has_revision(p_id):
 
2664
            present_parents.append(p_id)
 
2665
            parent_trees[p_id] = repository.revision_tree(p_id)
 
2666
        else:
 
2667
            parent_trees[p_id] = repository.revision_tree(
 
2668
                                     _mod_revision.NULL_REVISION)
 
2669
 
 
2670
    inv = revision_tree.inventory
 
2671
    entries = inv.iter_entries()
 
2672
    # backwards compatibility hack: skip the root id.
 
2673
    if not repository.supports_rich_root():
 
2674
        path, root = entries.next()
 
2675
        if root.revision != rev.revision_id:
 
2676
            raise errors.IncompatibleRevision(repr(repository))
 
2677
    text_keys = {}
 
2678
    for path, ie in entries:
 
2679
        text_keys[(ie.file_id, ie.revision)] = ie
 
2680
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2681
    missing_texts = set(text_keys) - set(text_parent_map)
 
2682
    # Add the texts that are not already present
 
2683
    for text_key in missing_texts:
 
2684
        ie = text_keys[text_key]
 
2685
        text_parents = []
 
2686
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2687
        # commit to determine parents. There is a latent/real bug here where
 
2688
        # the parents inserted are not those commit would do - in particular
 
2689
        # they are not filtered by heads(). RBC, AB
 
2690
        for revision, tree in parent_trees.iteritems():
 
2691
            if ie.file_id not in tree:
 
2692
                continue
 
2693
            parent_id = tree.inventory[ie.file_id].revision
 
2694
            if parent_id in text_parents:
 
2695
                continue
 
2696
            text_parents.append((ie.file_id, parent_id))
 
2697
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2698
        repository.texts.add_lines(text_key, text_parents, lines)
 
2699
    try:
 
2700
        # install the inventory
 
2701
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2702
            # Cache this inventory
 
2703
            inventory_cache[rev.revision_id] = inv
 
2704
            try:
 
2705
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2706
            except KeyError:
 
2707
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2708
            else:
 
2709
                delta = inv._make_delta(basis_inv)
 
2710
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2711
                    rev.revision_id, present_parents)
 
2712
        else:
 
2713
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2714
    except errors.RevisionAlreadyPresent:
 
2715
        pass
 
2716
    if signature is not None:
 
2717
        repository.add_signature_text(rev.revision_id, signature)
 
2718
    repository.add_revision(rev.revision_id, rev, inv)
 
2719
 
1280
2720
 
1281
2721
class MetaDirRepository(Repository):
1282
2722
    """Repositories in the new meta-dir layout.
1317
2757
        return not self._transport.has('no-working-trees')
1318
2758
 
1319
2759
 
1320
 
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1321
 
    """Repository format registry."""
 
2760
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2761
    """Repositories in a meta-dir, that work via versioned file objects."""
1322
2762
 
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
 
2763
    def __init__(self, _format, a_bzrdir, control_files):
 
2764
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2765
            control_files)
1327
2766
 
1328
2767
 
1329
2768
network_format_registry = registry.FormatRegistry()
1335
2774
"""
1336
2775
 
1337
2776
 
1338
 
format_registry = RepositoryFormatRegistry(network_format_registry)
 
2777
format_registry = registry.FormatRegistry(network_format_registry)
1339
2778
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1340
2779
 
1341
2780
This can contain either format instances themselves, or classes/factories that
1346
2785
#####################################################################
1347
2786
# Repository Formats
1348
2787
 
1349
 
class RepositoryFormat(controldir.ControlComponentFormat):
 
2788
class RepositoryFormat(object):
1350
2789
    """A repository format.
1351
2790
 
1352
2791
    Formats provide four things:
1387
2826
    # Does this format support CHK bytestring lookups. Set to True or False in
1388
2827
    # derived classes.
1389
2828
    supports_chks = None
 
2829
    # Should commit add an inventory, or an inventory delta to the repository.
 
2830
    _commit_inv_deltas = True
 
2831
    # What order should fetch operations request streams in?
 
2832
    # The default is unordered as that is the cheapest for an origin to
 
2833
    # provide.
 
2834
    _fetch_order = 'unordered'
 
2835
    # Does this repository format use deltas that can be fetched as-deltas ?
 
2836
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
2837
    # We default to False, which will ensure that enough data to get
 
2838
    # a full text out of any fetch stream will be grabbed.
 
2839
    _fetch_uses_deltas = False
1390
2840
    # Should fetch trigger a reconcile after the fetch? Only needed for
1391
2841
    # some repository formats that can suffer internal inconsistencies.
1392
2842
    _fetch_reconcile = False
1398
2848
    # help), and for fetching when data won't have come from the same
1399
2849
    # compressor.
1400
2850
    pack_compresses = False
1401
 
    # Does the repository storage understand references to trees?
1402
 
    supports_tree_reference = None
1403
 
    # Is the format experimental ?
1404
 
    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
2851
 
1422
 
    def __repr__(self):
1423
 
        return "%s()" % self.__class__.__name__
 
2852
    def __str__(self):
 
2853
        return "<%s>" % self.__class__.__name__
1424
2854
 
1425
2855
    def __eq__(self, other):
1426
2856
        # format objects are generally stateless
1439
2869
        """
1440
2870
        try:
1441
2871
            transport = a_bzrdir.get_repository_transport(None)
1442
 
            format_string = transport.get_bytes("format")
 
2872
            format_string = transport.get("format").read()
1443
2873
            return format_registry.get(format_string)
1444
2874
        except errors.NoSuchFile:
1445
2875
            raise errors.NoRepositoryPresent(a_bzrdir)
1448
2878
                                            kind='repository')
1449
2879
 
1450
2880
    @classmethod
1451
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1452
2881
    def register_format(klass, format):
1453
 
        format_registry.register(format)
 
2882
        format_registry.register(format.get_format_string(), format)
1454
2883
 
1455
2884
    @classmethod
1456
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1457
2885
    def unregister_format(klass, format):
1458
 
        format_registry.remove(format)
 
2886
        format_registry.remove(format.get_format_string())
1459
2887
 
1460
2888
    @classmethod
1461
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1462
2889
    def get_default_format(klass):
1463
2890
        """Return the current default format."""
1464
 
        return format_registry.get_default()
 
2891
        from bzrlib import bzrdir
 
2892
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1465
2893
 
1466
2894
    def get_format_string(self):
1467
2895
        """Return the ASCII format string that identifies this format.
1475
2903
        """Return the short description for this format."""
1476
2904
        raise NotImplementedError(self.get_format_description)
1477
2905
 
 
2906
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2907
    # use weaves or knits -- mbp 20070207
 
2908
    def _get_versioned_file_store(self,
 
2909
                                  name,
 
2910
                                  transport,
 
2911
                                  control_files,
 
2912
                                  prefixed=True,
 
2913
                                  versionedfile_class=None,
 
2914
                                  versionedfile_kwargs={},
 
2915
                                  escaped=False):
 
2916
        if versionedfile_class is None:
 
2917
            versionedfile_class = self._versionedfile_class
 
2918
        weave_transport = control_files._transport.clone(name)
 
2919
        dir_mode = control_files._dir_mode
 
2920
        file_mode = control_files._file_mode
 
2921
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
2922
                                  dir_mode=dir_mode,
 
2923
                                  file_mode=file_mode,
 
2924
                                  versionedfile_class=versionedfile_class,
 
2925
                                  versionedfile_kwargs=versionedfile_kwargs,
 
2926
                                  escaped=escaped)
 
2927
 
1478
2928
    def initialize(self, a_bzrdir, shared=False):
1479
2929
        """Initialize a repository of this format in a_bzrdir.
1480
2930
 
1496
2946
        """
1497
2947
        return True
1498
2948
 
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
2949
    def network_name(self):
1508
2950
        """A simple byte string uniquely identifying this format for RPC calls.
1509
2951
 
1515
2957
        raise NotImplementedError(self.network_name)
1516
2958
 
1517
2959
    def check_conversion_target(self, target_format):
1518
 
        if self.rich_root_data and not target_format.rich_root_data:
1519
 
            raise errors.BadConversionTarget(
1520
 
                'Does not support rich root data.', target_format,
1521
 
                from_format=self)
1522
 
        if (self.supports_tree_reference and 
1523
 
            not getattr(target_format, 'supports_tree_reference', False)):
1524
 
            raise errors.BadConversionTarget(
1525
 
                'Does not support nested trees', target_format,
1526
 
                from_format=self)
 
2960
        raise NotImplementedError(self.check_conversion_target)
1527
2961
 
1528
2962
    def open(self, a_bzrdir, _found=False):
1529
2963
        """Return an instance of this format for the bzrdir a_bzrdir.
1532
2966
        """
1533
2967
        raise NotImplementedError(self.open)
1534
2968
 
1535
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
1536
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
1537
 
        hooks = BzrDir.hooks['post_repo_init']
1538
 
        if not hooks:
1539
 
            return
1540
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
1541
 
        for hook in hooks:
1542
 
            hook(params)
1543
 
 
1544
2969
 
1545
2970
class MetaDirRepositoryFormat(RepositoryFormat):
1546
2971
    """Common base class for the new repositories using the metadir layout."""
1548
2973
    rich_root_data = False
1549
2974
    supports_tree_reference = False
1550
2975
    supports_external_lookups = False
1551
 
    supports_leaving_lock = True
1552
2976
 
1553
2977
    @property
1554
2978
    def _matchingbzrdir(self):
1592
3016
        return self.get_format_string()
1593
3017
 
1594
3018
 
 
3019
# Pre-0.8 formats that don't have a disk format string (because they are
 
3020
# versioned by the matching control directory). We use the control directories
 
3021
# disk format string as a key for the network_name because they meet the
 
3022
# constraints (simple string, unique, immutable).
 
3023
network_format_registry.register_lazy(
 
3024
    "Bazaar-NG branch, format 5\n",
 
3025
    'bzrlib.repofmt.weaverepo',
 
3026
    'RepositoryFormat5',
 
3027
)
 
3028
network_format_registry.register_lazy(
 
3029
    "Bazaar-NG branch, format 6\n",
 
3030
    'bzrlib.repofmt.weaverepo',
 
3031
    'RepositoryFormat6',
 
3032
)
 
3033
 
1595
3034
# formats which have no format string are not discoverable or independently
1596
3035
# 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
 
3036
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
1598
3037
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1599
3038
# the repository is not separately opened are similar.
1600
3039
 
1601
3040
format_registry.register_lazy(
 
3041
    'Bazaar-NG Repository format 7',
 
3042
    'bzrlib.repofmt.weaverepo',
 
3043
    'RepositoryFormat7'
 
3044
    )
 
3045
 
 
3046
format_registry.register_lazy(
1602
3047
    'Bazaar-NG Knit Repository Format 1',
1603
3048
    'bzrlib.repofmt.knitrepo',
1604
3049
    'RepositoryFormatKnit1',
1621
3066
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1622
3067
format_registry.register_lazy(
1623
3068
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1624
 
    'bzrlib.repofmt.knitpack_repo',
 
3069
    'bzrlib.repofmt.pack_repo',
1625
3070
    'RepositoryFormatKnitPack1',
1626
3071
    )
1627
3072
format_registry.register_lazy(
1628
3073
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1629
 
    'bzrlib.repofmt.knitpack_repo',
 
3074
    'bzrlib.repofmt.pack_repo',
1630
3075
    'RepositoryFormatKnitPack3',
1631
3076
    )
1632
3077
format_registry.register_lazy(
1633
3078
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1634
 
    'bzrlib.repofmt.knitpack_repo',
 
3079
    'bzrlib.repofmt.pack_repo',
1635
3080
    'RepositoryFormatKnitPack4',
1636
3081
    )
1637
3082
format_registry.register_lazy(
1638
3083
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1639
 
    'bzrlib.repofmt.knitpack_repo',
 
3084
    'bzrlib.repofmt.pack_repo',
1640
3085
    'RepositoryFormatKnitPack5',
1641
3086
    )
1642
3087
format_registry.register_lazy(
1643
3088
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1644
 
    'bzrlib.repofmt.knitpack_repo',
 
3089
    'bzrlib.repofmt.pack_repo',
1645
3090
    'RepositoryFormatKnitPack5RichRoot',
1646
3091
    )
1647
3092
format_registry.register_lazy(
1648
3093
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1649
 
    'bzrlib.repofmt.knitpack_repo',
 
3094
    'bzrlib.repofmt.pack_repo',
1650
3095
    'RepositoryFormatKnitPack5RichRootBroken',
1651
3096
    )
1652
3097
format_registry.register_lazy(
1653
3098
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1654
 
    'bzrlib.repofmt.knitpack_repo',
 
3099
    'bzrlib.repofmt.pack_repo',
1655
3100
    'RepositoryFormatKnitPack6',
1656
3101
    )
1657
3102
format_registry.register_lazy(
1658
3103
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1659
 
    'bzrlib.repofmt.knitpack_repo',
 
3104
    'bzrlib.repofmt.pack_repo',
1660
3105
    'RepositoryFormatKnitPack6RichRoot',
1661
3106
    )
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
3107
 
1668
3108
# Development formats.
1669
 
# Check their docstrings to see if/when they are obsolete.
 
3109
# Obsolete but kept pending a CHK based subtree format.
1670
3110
format_registry.register_lazy(
1671
3111
    ("Bazaar development format 2 with subtree support "
1672
3112
        "(needs bzr.dev from before 1.8)\n"),
1673
 
    'bzrlib.repofmt.knitpack_repo',
 
3113
    'bzrlib.repofmt.pack_repo',
1674
3114
    'RepositoryFormatPackDevelopment2Subtree',
1675
3115
    )
1676
 
format_registry.register_lazy(
1677
 
    'Bazaar development format 8\n',
1678
 
    'bzrlib.repofmt.groupcompress_repo',
1679
 
    'RepositoryFormat2aSubtree',
 
3116
 
 
3117
# 1.14->1.16 go below here
 
3118
format_registry.register_lazy(
 
3119
    'Bazaar development format - group compression and chk inventory'
 
3120
        ' (needs bzr.dev from 1.14)\n',
 
3121
    'bzrlib.repofmt.groupcompress_repo',
 
3122
    'RepositoryFormatCHK1',
 
3123
    )
 
3124
 
 
3125
format_registry.register_lazy(
 
3126
    'Bazaar development format - chk repository with bencode revision '
 
3127
        'serialization (needs bzr.dev from 1.16)\n',
 
3128
    'bzrlib.repofmt.groupcompress_repo',
 
3129
    'RepositoryFormatCHK2',
 
3130
    )
 
3131
format_registry.register_lazy(
 
3132
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3133
    'bzrlib.repofmt.groupcompress_repo',
 
3134
    'RepositoryFormat2a',
1680
3135
    )
1681
3136
 
1682
3137
 
1692
3147
    InterRepository.get(other).method_name(parameters).
1693
3148
    """
1694
3149
 
 
3150
    _walk_to_common_revisions_batch_size = 50
1695
3151
    _optimisers = []
1696
3152
    """The available optimised InterRepository types."""
1697
3153
 
1712
3168
        self.target.fetch(self.source, revision_id=revision_id)
1713
3169
 
1714
3170
    @needs_write_lock
1715
 
    def fetch(self, revision_id=None, find_ghosts=False,
 
3171
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
1716
3172
            fetch_spec=None):
1717
3173
        """Fetch the content required to construct revision_id.
1718
3174
 
1720
3176
 
1721
3177
        :param revision_id: if None all content is copied, if NULL_REVISION no
1722
3178
                            content is copied.
 
3179
        :param pb: optional progress bar to use for progress reports. If not
 
3180
                   provided a default one will be created.
1723
3181
        :return: None.
1724
3182
        """
1725
 
        raise NotImplementedError(self.fetch)
 
3183
        from bzrlib.fetch import RepoFetcher
 
3184
        f = RepoFetcher(to_repository=self.target,
 
3185
                               from_repository=self.source,
 
3186
                               last_revision=revision_id,
 
3187
                               fetch_spec=fetch_spec,
 
3188
                               pb=pb, find_ghosts=find_ghosts)
 
3189
 
 
3190
    def _walk_to_common_revisions(self, revision_ids):
 
3191
        """Walk out from revision_ids in source to revisions target has.
 
3192
 
 
3193
        :param revision_ids: The start point for the search.
 
3194
        :return: A set of revision ids.
 
3195
        """
 
3196
        target_graph = self.target.get_graph()
 
3197
        revision_ids = frozenset(revision_ids)
 
3198
        missing_revs = set()
 
3199
        source_graph = self.source.get_graph()
 
3200
        # ensure we don't pay silly lookup costs.
 
3201
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
3202
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3203
        searcher_exhausted = False
 
3204
        while True:
 
3205
            next_revs = set()
 
3206
            ghosts = set()
 
3207
            # Iterate the searcher until we have enough next_revs
 
3208
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3209
                try:
 
3210
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3211
                    next_revs.update(next_revs_part)
 
3212
                    ghosts.update(ghosts_part)
 
3213
                except StopIteration:
 
3214
                    searcher_exhausted = True
 
3215
                    break
 
3216
            # If there are ghosts in the source graph, and the caller asked for
 
3217
            # them, make sure that they are present in the target.
 
3218
            # We don't care about other ghosts as we can't fetch them and
 
3219
            # haven't been asked to.
 
3220
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3221
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3222
            if revs_to_get:
 
3223
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3224
                # we always have NULL_REVISION present.
 
3225
                have_revs = have_revs.union(null_set)
 
3226
                # Check if the target is missing any ghosts we need.
 
3227
                ghosts_to_check.difference_update(have_revs)
 
3228
                if ghosts_to_check:
 
3229
                    # One of the caller's revision_ids is a ghost in both the
 
3230
                    # source and the target.
 
3231
                    raise errors.NoSuchRevision(
 
3232
                        self.source, ghosts_to_check.pop())
 
3233
                missing_revs.update(next_revs - have_revs)
 
3234
                # Because we may have walked past the original stop point, make
 
3235
                # sure everything is stopped
 
3236
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3237
                searcher.stop_searching_any(stop_revs)
 
3238
            if searcher_exhausted:
 
3239
                break
 
3240
        return searcher.get_result()
1726
3241
 
1727
3242
    @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):
 
3243
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1732
3244
        """Return the revision ids that source has that target does not.
1733
3245
 
1734
3246
        :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.
 
3247
                            revision_id.
1743
3248
        :param find_ghosts: If True find missing revisions in deep history
1744
3249
            rather than just finding the surface difference.
1745
 
        :param limit: Maximum number of revisions to return, topologically
1746
 
            ordered
1747
3250
        :return: A bzrlib.graph.SearchResult.
1748
3251
        """
1749
 
        raise NotImplementedError(self.search_missing_revision_ids)
 
3252
        # stop searching at found target revisions.
 
3253
        if not find_ghosts and revision_id is not None:
 
3254
            return self._walk_to_common_revisions([revision_id])
 
3255
        # generic, possibly worst case, slow code path.
 
3256
        target_ids = set(self.target.all_revision_ids())
 
3257
        if revision_id is not None:
 
3258
            source_ids = self.source.get_ancestry(revision_id)
 
3259
            if source_ids[0] is not None:
 
3260
                raise AssertionError()
 
3261
            source_ids.pop(0)
 
3262
        else:
 
3263
            source_ids = self.source.all_revision_ids()
 
3264
        result_set = set(source_ids).difference(target_ids)
 
3265
        return self.source.revision_ids_to_search_result(result_set)
1750
3266
 
1751
3267
    @staticmethod
1752
3268
    def _same_model(source, target):
1773
3289
                "different serializers")
1774
3290
 
1775
3291
 
 
3292
class InterSameDataRepository(InterRepository):
 
3293
    """Code for converting between repositories that represent the same data.
 
3294
 
 
3295
    Data format and model must match for this to work.
 
3296
    """
 
3297
 
 
3298
    @classmethod
 
3299
    def _get_repo_format_to_test(self):
 
3300
        """Repository format for testing with.
 
3301
 
 
3302
        InterSameData can pull from subtree to subtree and from non-subtree to
 
3303
        non-subtree, so we test this with the richest repository format.
 
3304
        """
 
3305
        from bzrlib.repofmt import knitrepo
 
3306
        return knitrepo.RepositoryFormatKnit3()
 
3307
 
 
3308
    @staticmethod
 
3309
    def is_compatible(source, target):
 
3310
        return InterRepository._same_model(source, target)
 
3311
 
 
3312
 
 
3313
class InterWeaveRepo(InterSameDataRepository):
 
3314
    """Optimised code paths between Weave based repositories.
 
3315
 
 
3316
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
3317
    implemented lazy inter-object optimisation.
 
3318
    """
 
3319
 
 
3320
    @classmethod
 
3321
    def _get_repo_format_to_test(self):
 
3322
        from bzrlib.repofmt import weaverepo
 
3323
        return weaverepo.RepositoryFormat7()
 
3324
 
 
3325
    @staticmethod
 
3326
    def is_compatible(source, target):
 
3327
        """Be compatible with known Weave formats.
 
3328
 
 
3329
        We don't test for the stores being of specific types because that
 
3330
        could lead to confusing results, and there is no need to be
 
3331
        overly general.
 
3332
        """
 
3333
        from bzrlib.repofmt.weaverepo import (
 
3334
                RepositoryFormat5,
 
3335
                RepositoryFormat6,
 
3336
                RepositoryFormat7,
 
3337
                )
 
3338
        try:
 
3339
            return (isinstance(source._format, (RepositoryFormat5,
 
3340
                                                RepositoryFormat6,
 
3341
                                                RepositoryFormat7)) and
 
3342
                    isinstance(target._format, (RepositoryFormat5,
 
3343
                                                RepositoryFormat6,
 
3344
                                                RepositoryFormat7)))
 
3345
        except AttributeError:
 
3346
            return False
 
3347
 
 
3348
    @needs_write_lock
 
3349
    def copy_content(self, revision_id=None):
 
3350
        """See InterRepository.copy_content()."""
 
3351
        # weave specific optimised path:
 
3352
        try:
 
3353
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3354
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
3355
            pass
 
3356
        # FIXME do not peek!
 
3357
        if self.source._transport.listable():
 
3358
            pb = ui.ui_factory.nested_progress_bar()
 
3359
            try:
 
3360
                self.target.texts.insert_record_stream(
 
3361
                    self.source.texts.get_record_stream(
 
3362
                        self.source.texts.keys(), 'topological', False))
 
3363
                pb.update('copying inventory', 0, 1)
 
3364
                self.target.inventories.insert_record_stream(
 
3365
                    self.source.inventories.get_record_stream(
 
3366
                        self.source.inventories.keys(), 'topological', False))
 
3367
                self.target.signatures.insert_record_stream(
 
3368
                    self.source.signatures.get_record_stream(
 
3369
                        self.source.signatures.keys(),
 
3370
                        'unordered', True))
 
3371
                self.target.revisions.insert_record_stream(
 
3372
                    self.source.revisions.get_record_stream(
 
3373
                        self.source.revisions.keys(),
 
3374
                        'topological', True))
 
3375
            finally:
 
3376
                pb.finished()
 
3377
        else:
 
3378
            self.target.fetch(self.source, revision_id=revision_id)
 
3379
 
 
3380
    @needs_read_lock
 
3381
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3382
        """See InterRepository.missing_revision_ids()."""
 
3383
        # we want all revisions to satisfy revision_id in source.
 
3384
        # but we don't want to stat every file here and there.
 
3385
        # we want then, all revisions other needs to satisfy revision_id
 
3386
        # checked, but not those that we have locally.
 
3387
        # so the first thing is to get a subset of the revisions to
 
3388
        # satisfy revision_id in source, and then eliminate those that
 
3389
        # we do already have.
 
3390
        # this is slow on high latency connection to self, but as this
 
3391
        # disk format scales terribly for push anyway due to rewriting
 
3392
        # inventory.weave, this is considered acceptable.
 
3393
        # - RBC 20060209
 
3394
        if revision_id is not None:
 
3395
            source_ids = self.source.get_ancestry(revision_id)
 
3396
            if source_ids[0] is not None:
 
3397
                raise AssertionError()
 
3398
            source_ids.pop(0)
 
3399
        else:
 
3400
            source_ids = self.source._all_possible_ids()
 
3401
        source_ids_set = set(source_ids)
 
3402
        # source_ids is the worst possible case we may need to pull.
 
3403
        # now we want to filter source_ids against what we actually
 
3404
        # have in target, but don't try to check for existence where we know
 
3405
        # we do not have a revision as that would be pointless.
 
3406
        target_ids = set(self.target._all_possible_ids())
 
3407
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
3408
        actually_present_revisions = set(
 
3409
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3410
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
3411
        if revision_id is not None:
 
3412
            # we used get_ancestry to determine source_ids then we are assured all
 
3413
            # revisions referenced are present as they are installed in topological order.
 
3414
            # and the tip revision was validated by get_ancestry.
 
3415
            result_set = required_revisions
 
3416
        else:
 
3417
            # if we just grabbed the possibly available ids, then
 
3418
            # we only have an estimate of whats available and need to validate
 
3419
            # that against the revision records.
 
3420
            result_set = set(
 
3421
                self.source._eliminate_revisions_not_present(required_revisions))
 
3422
        return self.source.revision_ids_to_search_result(result_set)
 
3423
 
 
3424
 
 
3425
class InterKnitRepo(InterSameDataRepository):
 
3426
    """Optimised code paths between Knit based repositories."""
 
3427
 
 
3428
    @classmethod
 
3429
    def _get_repo_format_to_test(self):
 
3430
        from bzrlib.repofmt import knitrepo
 
3431
        return knitrepo.RepositoryFormatKnit1()
 
3432
 
 
3433
    @staticmethod
 
3434
    def is_compatible(source, target):
 
3435
        """Be compatible with known Knit formats.
 
3436
 
 
3437
        We don't test for the stores being of specific types because that
 
3438
        could lead to confusing results, and there is no need to be
 
3439
        overly general.
 
3440
        """
 
3441
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
3442
        try:
 
3443
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
3444
                isinstance(target._format, RepositoryFormatKnit))
 
3445
        except AttributeError:
 
3446
            return False
 
3447
        return are_knits and InterRepository._same_model(source, target)
 
3448
 
 
3449
    @needs_read_lock
 
3450
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3451
        """See InterRepository.missing_revision_ids()."""
 
3452
        if revision_id is not None:
 
3453
            source_ids = self.source.get_ancestry(revision_id)
 
3454
            if source_ids[0] is not None:
 
3455
                raise AssertionError()
 
3456
            source_ids.pop(0)
 
3457
        else:
 
3458
            source_ids = self.source.all_revision_ids()
 
3459
        source_ids_set = set(source_ids)
 
3460
        # source_ids is the worst possible case we may need to pull.
 
3461
        # now we want to filter source_ids against what we actually
 
3462
        # have in target, but don't try to check for existence where we know
 
3463
        # we do not have a revision as that would be pointless.
 
3464
        target_ids = set(self.target.all_revision_ids())
 
3465
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
3466
        actually_present_revisions = set(
 
3467
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3468
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
3469
        if revision_id is not None:
 
3470
            # we used get_ancestry to determine source_ids then we are assured all
 
3471
            # revisions referenced are present as they are installed in topological order.
 
3472
            # and the tip revision was validated by get_ancestry.
 
3473
            result_set = required_revisions
 
3474
        else:
 
3475
            # if we just grabbed the possibly available ids, then
 
3476
            # we only have an estimate of whats available and need to validate
 
3477
            # that against the revision records.
 
3478
            result_set = set(
 
3479
                self.source._eliminate_revisions_not_present(required_revisions))
 
3480
        return self.source.revision_ids_to_search_result(result_set)
 
3481
 
 
3482
 
 
3483
class InterDifferingSerializer(InterRepository):
 
3484
 
 
3485
    @classmethod
 
3486
    def _get_repo_format_to_test(self):
 
3487
        return None
 
3488
 
 
3489
    @staticmethod
 
3490
    def is_compatible(source, target):
 
3491
        """Be compatible with Knit2 source and Knit3 target"""
 
3492
        # This is redundant with format.check_conversion_target(), however that
 
3493
        # raises an exception, and we just want to say "False" as in we won't
 
3494
        # support converting between these formats.
 
3495
        if source.supports_rich_root() and not target.supports_rich_root():
 
3496
            return False
 
3497
        if (source._format.supports_tree_reference
 
3498
            and not target._format.supports_tree_reference):
 
3499
            return False
 
3500
        return True
 
3501
 
 
3502
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
 
3503
        """Get the best delta and base for this revision.
 
3504
 
 
3505
        :return: (basis_id, delta)
 
3506
        """
 
3507
        possible_trees = [(parent_id, cache[parent_id])
 
3508
                          for parent_id in parent_ids
 
3509
                           if parent_id in cache]
 
3510
        if len(possible_trees) == 0:
 
3511
            # There either aren't any parents, or the parents aren't in the
 
3512
            # cache, so just use the last converted tree
 
3513
            possible_trees.append((basis_id, cache[basis_id]))
 
3514
        deltas = []
 
3515
        for basis_id, basis_tree in possible_trees:
 
3516
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3517
            deltas.append((len(delta), basis_id, delta))
 
3518
        deltas.sort()
 
3519
        return deltas[0][1:]
 
3520
 
 
3521
    def _get_parent_keys(self, root_key, parent_map):
 
3522
        """Get the parent keys for a given root id."""
 
3523
        root_id, rev_id = root_key
 
3524
        # Include direct parents of the revision, but only if they used
 
3525
        # the same root_id and are heads.
 
3526
        parent_keys = []
 
3527
        for parent_id in parent_map[rev_id]:
 
3528
            if parent_id == _mod_revision.NULL_REVISION:
 
3529
                continue
 
3530
            if parent_id not in self._revision_id_to_root_id:
 
3531
                # We probably didn't read this revision, go spend the
 
3532
                # extra effort to actually check
 
3533
                try:
 
3534
                    tree = self.source.revision_tree(parent_id)
 
3535
                except errors.NoSuchRevision:
 
3536
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3537
                    # encounter this again.
 
3538
                    # But set parent_root_id to None since we don't really know
 
3539
                    parent_root_id = None
 
3540
                else:
 
3541
                    parent_root_id = tree.get_root_id()
 
3542
                self._revision_id_to_root_id[parent_id] = None
 
3543
            else:
 
3544
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3545
            if root_id == parent_root_id:
 
3546
                # With stacking we _might_ want to refer to a non-local
 
3547
                # revision, but this code path only applies when we have the
 
3548
                # full content available, so ghosts really are ghosts, not just
 
3549
                # the edge of local data.
 
3550
                parent_keys.append((parent_id,))
 
3551
            else:
 
3552
                # root_id may be in the parent anyway.
 
3553
                try:
 
3554
                    tree = self.source.revision_tree(parent_id)
 
3555
                except errors.NoSuchRevision:
 
3556
                    # ghost, can't refer to it.
 
3557
                    pass
 
3558
                else:
 
3559
                    try:
 
3560
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3561
                    except errors.NoSuchId:
 
3562
                        # not in the tree
 
3563
                        pass
 
3564
        g = graph.Graph(self.source.revisions)
 
3565
        heads = g.heads(parent_keys)
 
3566
        selected_keys = []
 
3567
        for key in parent_keys:
 
3568
            if key in heads and key not in selected_keys:
 
3569
                selected_keys.append(key)
 
3570
        return tuple([(root_id,)+ key for key in selected_keys])
 
3571
 
 
3572
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3573
        for root_key in root_keys_to_create:
 
3574
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3575
            yield versionedfile.FulltextContentFactory(root_key,
 
3576
                parent_keys, None, '')
 
3577
 
 
3578
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3579
        """Fetch across a few revisions.
 
3580
 
 
3581
        :param revision_ids: The revisions to copy
 
3582
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3583
            as a basis for delta when no other base is available
 
3584
        :param cache: A cache of RevisionTrees that we can use.
 
3585
        :return: The revision_id of the last converted tree. The RevisionTree
 
3586
            for it will be in cache
 
3587
        """
 
3588
        # Walk though all revisions; get inventory deltas, copy referenced
 
3589
        # texts that delta references, insert the delta, revision and
 
3590
        # signature.
 
3591
        root_keys_to_create = set()
 
3592
        text_keys = set()
 
3593
        pending_deltas = []
 
3594
        pending_revisions = []
 
3595
        parent_map = self.source.get_parent_map(revision_ids)
 
3596
        for tree in self.source.revision_trees(revision_ids):
 
3597
            current_revision_id = tree.get_revision_id()
 
3598
            parent_ids = parent_map.get(current_revision_id, ())
 
3599
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3600
                                                           basis_id, cache)
 
3601
            if self._converting_to_rich_root:
 
3602
                self._revision_id_to_root_id[current_revision_id] = \
 
3603
                    tree.get_root_id()
 
3604
            # Find text entries that need to be copied
 
3605
            for old_path, new_path, file_id, entry in delta:
 
3606
                if new_path is not None:
 
3607
                    if not new_path:
 
3608
                        # This is the root
 
3609
                        if not self.target.supports_rich_root():
 
3610
                            # The target doesn't support rich root, so we don't
 
3611
                            # copy
 
3612
                            continue
 
3613
                        if self._converting_to_rich_root:
 
3614
                            # This can't be copied normally, we have to insert
 
3615
                            # it specially
 
3616
                            root_keys_to_create.add((file_id, entry.revision))
 
3617
                            continue
 
3618
                    text_keys.add((file_id, entry.revision))
 
3619
            revision = self.source.get_revision(current_revision_id)
 
3620
            pending_deltas.append((basis_id, delta,
 
3621
                current_revision_id, revision.parent_ids))
 
3622
            pending_revisions.append(revision)
 
3623
            cache[current_revision_id] = tree
 
3624
            basis_id = current_revision_id
 
3625
        # Copy file texts
 
3626
        from_texts = self.source.texts
 
3627
        to_texts = self.target.texts
 
3628
        if root_keys_to_create:
 
3629
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3630
                                                     parent_map)
 
3631
            to_texts.insert_record_stream(root_stream)
 
3632
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3633
            text_keys, self.target._format._fetch_order,
 
3634
            not self.target._format._fetch_uses_deltas))
 
3635
        # insert inventory deltas
 
3636
        for delta in pending_deltas:
 
3637
            self.target.add_inventory_by_delta(*delta)
 
3638
        if self.target._fallback_repositories:
 
3639
            # Make sure this stacked repository has all the parent inventories
 
3640
            # for the new revisions that we are about to insert.  We do this
 
3641
            # before adding the revisions so that no revision is added until
 
3642
            # all the inventories it may depend on are added.
 
3643
            parent_ids = set()
 
3644
            revision_ids = set()
 
3645
            for revision in pending_revisions:
 
3646
                revision_ids.add(revision.revision_id)
 
3647
                parent_ids.update(revision.parent_ids)
 
3648
            parent_ids.difference_update(revision_ids)
 
3649
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3650
            parent_map = self.source.get_parent_map(parent_ids)
 
3651
            for parent_tree in self.source.revision_trees(parent_ids):
 
3652
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
 
3653
                current_revision_id = parent_tree.get_revision_id()
 
3654
                parents_parents = parent_map[current_revision_id]
 
3655
                self.target.add_inventory_by_delta(
 
3656
                    basis_id, delta, current_revision_id, parents_parents)
 
3657
        # insert signatures and revisions
 
3658
        for revision in pending_revisions:
 
3659
            try:
 
3660
                signature = self.source.get_signature_text(
 
3661
                    revision.revision_id)
 
3662
                self.target.add_signature_text(revision.revision_id,
 
3663
                    signature)
 
3664
            except errors.NoSuchRevision:
 
3665
                pass
 
3666
            self.target.add_revision(revision.revision_id, revision)
 
3667
        return basis_id
 
3668
 
 
3669
    def _fetch_all_revisions(self, revision_ids, pb):
 
3670
        """Fetch everything for the list of revisions.
 
3671
 
 
3672
        :param revision_ids: The list of revisions to fetch. Must be in
 
3673
            topological order.
 
3674
        :param pb: A ProgressBar
 
3675
        :return: None
 
3676
        """
 
3677
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3678
        batch_size = 100
 
3679
        cache = lru_cache.LRUCache(100)
 
3680
        cache[basis_id] = basis_tree
 
3681
        del basis_tree # We don't want to hang on to it here
 
3682
        hints = []
 
3683
        for offset in range(0, len(revision_ids), batch_size):
 
3684
            self.target.start_write_group()
 
3685
            try:
 
3686
                pb.update('Transferring revisions', offset,
 
3687
                          len(revision_ids))
 
3688
                batch = revision_ids[offset:offset+batch_size]
 
3689
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3690
            except:
 
3691
                self.target.abort_write_group()
 
3692
                raise
 
3693
            else:
 
3694
                hint = self.target.commit_write_group()
 
3695
                if hint:
 
3696
                    hints.extend(hint)
 
3697
        if hints and self.target._format.pack_compresses:
 
3698
            self.target.pack(hint=hints)
 
3699
        pb.update('Transferring revisions', len(revision_ids),
 
3700
                  len(revision_ids))
 
3701
 
 
3702
    @needs_write_lock
 
3703
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3704
            fetch_spec=None):
 
3705
        """See InterRepository.fetch()."""
 
3706
        if fetch_spec is not None:
 
3707
            raise AssertionError("Not implemented yet...")
 
3708
        if (not self.source.supports_rich_root()
 
3709
            and self.target.supports_rich_root()):
 
3710
            self._converting_to_rich_root = True
 
3711
            self._revision_id_to_root_id = {}
 
3712
        else:
 
3713
            self._converting_to_rich_root = False
 
3714
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3715
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3716
        if not revision_ids:
 
3717
            return 0, 0
 
3718
        revision_ids = tsort.topo_sort(
 
3719
            self.source.get_graph().get_parent_map(revision_ids))
 
3720
        if not revision_ids:
 
3721
            return 0, 0
 
3722
        # Walk though all revisions; get inventory deltas, copy referenced
 
3723
        # texts that delta references, insert the delta, revision and
 
3724
        # signature.
 
3725
        first_rev = self.source.get_revision(revision_ids[0])
 
3726
        if pb is None:
 
3727
            my_pb = ui.ui_factory.nested_progress_bar()
 
3728
            pb = my_pb
 
3729
        else:
 
3730
            symbol_versioning.warn(
 
3731
                symbol_versioning.deprecated_in((1, 14, 0))
 
3732
                % "pb parameter to fetch()")
 
3733
            my_pb = None
 
3734
        try:
 
3735
            self._fetch_all_revisions(revision_ids, pb)
 
3736
        finally:
 
3737
            if my_pb is not None:
 
3738
                my_pb.finished()
 
3739
        return len(revision_ids), 0
 
3740
 
 
3741
    def _get_basis(self, first_revision_id):
 
3742
        """Get a revision and tree which exists in the target.
 
3743
 
 
3744
        This assumes that first_revision_id is selected for transmission
 
3745
        because all other ancestors are already present. If we can't find an
 
3746
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
3747
 
 
3748
        :return: (basis_id, basis_tree)
 
3749
        """
 
3750
        first_rev = self.source.get_revision(first_revision_id)
 
3751
        try:
 
3752
            basis_id = first_rev.parent_ids[0]
 
3753
            # only valid as a basis if the target has it
 
3754
            self.target.get_revision(basis_id)
 
3755
            # Try to get a basis tree - if its a ghost it will hit the
 
3756
            # NoSuchRevision case.
 
3757
            basis_tree = self.source.revision_tree(basis_id)
 
3758
        except (IndexError, errors.NoSuchRevision):
 
3759
            basis_id = _mod_revision.NULL_REVISION
 
3760
            basis_tree = self.source.revision_tree(basis_id)
 
3761
        return basis_id, basis_tree
 
3762
 
 
3763
 
 
3764
InterRepository.register_optimiser(InterDifferingSerializer)
 
3765
InterRepository.register_optimiser(InterSameDataRepository)
 
3766
InterRepository.register_optimiser(InterWeaveRepo)
 
3767
InterRepository.register_optimiser(InterKnitRepo)
 
3768
 
 
3769
 
1776
3770
class CopyConverter(object):
1777
3771
    """A repository conversion tool which just performs a copy of the content.
1778
3772
 
1792
3786
        :param to_convert: The disk object to convert.
1793
3787
        :param pb: a progress bar to use for progress information.
1794
3788
        """
1795
 
        pb = ui.ui_factory.nested_progress_bar()
 
3789
        self.pb = pb
1796
3790
        self.count = 0
1797
3791
        self.total = 4
1798
3792
        # this is only useful with metadir layouts - separated repo content.
1799
3793
        # trigger an assertion if not such
1800
3794
        repo._format.get_format_string()
1801
3795
        self.repo_dir = repo.bzrdir
1802
 
        pb.update('Moving repository to repository.backup')
 
3796
        self.step('Moving repository to repository.backup')
1803
3797
        self.repo_dir.transport.move('repository', 'repository.backup')
1804
3798
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1805
3799
        repo._format.check_conversion_target(self.target_format)
1806
3800
        self.source_repo = repo._format.open(self.repo_dir,
1807
3801
            _found=True,
1808
3802
            _override_transport=backup_transport)
1809
 
        pb.update('Creating new repository')
 
3803
        self.step('Creating new repository')
1810
3804
        converted = self.target_format.initialize(self.repo_dir,
1811
3805
                                                  self.source_repo.is_shared())
1812
3806
        converted.lock_write()
1813
3807
        try:
1814
 
            pb.update('Copying content')
 
3808
            self.step('Copying content into repository.')
1815
3809
            self.source_repo.copy_content_into(converted)
1816
3810
        finally:
1817
3811
            converted.unlock()
1818
 
        pb.update('Deleting old repository content')
 
3812
        self.step('Deleting old repository content.')
1819
3813
        self.repo_dir.transport.delete_tree('repository.backup')
1820
 
        ui.ui_factory.note('repository converted')
1821
 
        pb.finished()
 
3814
        self.pb.note('repository converted')
 
3815
 
 
3816
    def step(self, message):
 
3817
        """Update the pb by a step."""
 
3818
        self.count +=1
 
3819
        self.pb.update(message, self.count, self.total)
 
3820
 
 
3821
 
 
3822
_unescape_map = {
 
3823
    'apos':"'",
 
3824
    'quot':'"',
 
3825
    'amp':'&',
 
3826
    'lt':'<',
 
3827
    'gt':'>'
 
3828
}
 
3829
 
 
3830
 
 
3831
def _unescaper(match, _map=_unescape_map):
 
3832
    code = match.group(1)
 
3833
    try:
 
3834
        return _map[code]
 
3835
    except KeyError:
 
3836
        if not code.startswith('#'):
 
3837
            raise
 
3838
        return unichr(int(code[1:])).encode('utf8')
 
3839
 
 
3840
 
 
3841
_unescape_re = None
 
3842
 
 
3843
 
 
3844
def _unescape_xml(data):
 
3845
    """Unescape predefined XML entities in a string of data."""
 
3846
    global _unescape_re
 
3847
    if _unescape_re is None:
 
3848
        _unescape_re = re.compile('\&([^;]*);')
 
3849
    return _unescape_re.sub(_unescaper, data)
 
3850
 
 
3851
 
 
3852
class _VersionedFileChecker(object):
 
3853
 
 
3854
    def __init__(self, repository, text_key_references=None):
 
3855
        self.repository = repository
 
3856
        self.text_index = self.repository._generate_text_key_index(
 
3857
            text_key_references=text_key_references)
 
3858
 
 
3859
    def calculate_file_version_parents(self, text_key):
 
3860
        """Calculate the correct parents for a file version according to
 
3861
        the inventories.
 
3862
        """
 
3863
        parent_keys = self.text_index[text_key]
 
3864
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3865
            return ()
 
3866
        return tuple(parent_keys)
 
3867
 
 
3868
    def check_file_version_parents(self, texts, progress_bar=None):
 
3869
        """Check the parents stored in a versioned file are correct.
 
3870
 
 
3871
        It also detects file versions that are not referenced by their
 
3872
        corresponding revision's inventory.
 
3873
 
 
3874
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3875
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3876
            correct_parents)} for each revision_id where the stored parents
 
3877
            are not correct.  dangling_file_versions is a set of (file_id,
 
3878
            revision_id) tuples for versions that are present in this versioned
 
3879
            file, but not used by the corresponding inventory.
 
3880
        """
 
3881
        wrong_parents = {}
 
3882
        self.file_ids = set([file_id for file_id, _ in
 
3883
            self.text_index.iterkeys()])
 
3884
        # text keys is now grouped by file_id
 
3885
        n_weaves = len(self.file_ids)
 
3886
        files_in_revisions = {}
 
3887
        revisions_of_files = {}
 
3888
        n_versions = len(self.text_index)
 
3889
        progress_bar.update('loading text store', 0, n_versions)
 
3890
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
3891
        # On unlistable transports this could well be empty/error...
 
3892
        text_keys = self.repository.texts.keys()
 
3893
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
3894
        for num, key in enumerate(self.text_index.iterkeys()):
 
3895
            if progress_bar is not None:
 
3896
                progress_bar.update('checking text graph', num, n_versions)
 
3897
            correct_parents = self.calculate_file_version_parents(key)
 
3898
            try:
 
3899
                knit_parents = parent_map[key]
 
3900
            except errors.RevisionNotPresent:
 
3901
                # Missing text!
 
3902
                knit_parents = None
 
3903
            if correct_parents != knit_parents:
 
3904
                wrong_parents[key] = (knit_parents, correct_parents)
 
3905
        return wrong_parents, unused_keys
 
3906
 
 
3907
 
 
3908
def _old_get_graph(repository, revision_id):
 
3909
    """DO NOT USE. That is all. I'm serious."""
 
3910
    graph = repository.get_graph()
 
3911
    revision_graph = dict(((key, value) for key, value in
 
3912
        graph.iter_ancestry([revision_id]) if value is not None))
 
3913
    return _strip_NULL_ghosts(revision_graph)
1822
3914
 
1823
3915
 
1824
3916
def _strip_NULL_ghosts(revision_graph):
1832
3924
    return revision_graph
1833
3925
 
1834
3926
 
 
3927
class StreamSink(object):
 
3928
    """An object that can insert a stream into a repository.
 
3929
 
 
3930
    This interface handles the complexity of reserialising inventories and
 
3931
    revisions from different formats, and allows unidirectional insertion into
 
3932
    stacked repositories without looking for the missing basis parents
 
3933
    beforehand.
 
3934
    """
 
3935
 
 
3936
    def __init__(self, target_repo):
 
3937
        self.target_repo = target_repo
 
3938
 
 
3939
    def insert_stream(self, stream, src_format, resume_tokens):
 
3940
        """Insert a stream's content into the target repository.
 
3941
 
 
3942
        :param src_format: a bzr repository format.
 
3943
 
 
3944
        :return: a list of resume tokens and an  iterable of keys additional
 
3945
            items required before the insertion can be completed.
 
3946
        """
 
3947
        self.target_repo.lock_write()
 
3948
        try:
 
3949
            if resume_tokens:
 
3950
                self.target_repo.resume_write_group(resume_tokens)
 
3951
                is_resume = True
 
3952
            else:
 
3953
                self.target_repo.start_write_group()
 
3954
                is_resume = False
 
3955
            try:
 
3956
                # locked_insert_stream performs a commit|suspend.
 
3957
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3958
            except:
 
3959
                self.target_repo.abort_write_group(suppress_errors=True)
 
3960
                raise
 
3961
        finally:
 
3962
            self.target_repo.unlock()
 
3963
 
 
3964
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3965
        to_serializer = self.target_repo._format._serializer
 
3966
        src_serializer = src_format._serializer
 
3967
        new_pack = None
 
3968
        if to_serializer == src_serializer:
 
3969
            # If serializers match and the target is a pack repository, set the
 
3970
            # write cache size on the new pack.  This avoids poor performance
 
3971
            # on transports where append is unbuffered (such as
 
3972
            # RemoteTransport).  This is safe to do because nothing should read
 
3973
            # back from the target repository while a stream with matching
 
3974
            # serialization is being inserted.
 
3975
            # The exception is that a delta record from the source that should
 
3976
            # be a fulltext may need to be expanded by the target (see
 
3977
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
3978
            # explicitly flush any buffered writes first in that rare case.
 
3979
            try:
 
3980
                new_pack = self.target_repo._pack_collection._new_pack
 
3981
            except AttributeError:
 
3982
                # Not a pack repository
 
3983
                pass
 
3984
            else:
 
3985
                new_pack.set_write_cache_size(1024*1024)
 
3986
        for substream_type, substream in stream:
 
3987
            if substream_type == 'texts':
 
3988
                self.target_repo.texts.insert_record_stream(substream)
 
3989
            elif substream_type == 'inventories':
 
3990
                if src_serializer == to_serializer:
 
3991
                    self.target_repo.inventories.insert_record_stream(
 
3992
                        substream)
 
3993
                else:
 
3994
                    self._extract_and_insert_inventories(
 
3995
                        substream, src_serializer)
 
3996
            elif substream_type == 'chk_bytes':
 
3997
                # XXX: This doesn't support conversions, as it assumes the
 
3998
                #      conversion was done in the fetch code.
 
3999
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4000
            elif substream_type == 'revisions':
 
4001
                # This may fallback to extract-and-insert more often than
 
4002
                # required if the serializers are different only in terms of
 
4003
                # the inventory.
 
4004
                if src_serializer == to_serializer:
 
4005
                    self.target_repo.revisions.insert_record_stream(
 
4006
                        substream)
 
4007
                else:
 
4008
                    self._extract_and_insert_revisions(substream,
 
4009
                        src_serializer)
 
4010
            elif substream_type == 'signatures':
 
4011
                self.target_repo.signatures.insert_record_stream(substream)
 
4012
            else:
 
4013
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4014
        # Done inserting data, and the missing_keys calculations will try to
 
4015
        # read back from the inserted data, so flush the writes to the new pack
 
4016
        # (if this is pack format).
 
4017
        if new_pack is not None:
 
4018
            new_pack._write_data('', flush=True)
 
4019
        # Find all the new revisions (including ones from resume_tokens)
 
4020
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4021
            check_for_missing_texts=is_resume)
 
4022
        try:
 
4023
            for prefix, versioned_file in (
 
4024
                ('texts', self.target_repo.texts),
 
4025
                ('inventories', self.target_repo.inventories),
 
4026
                ('revisions', self.target_repo.revisions),
 
4027
                ('signatures', self.target_repo.signatures),
 
4028
                ('chk_bytes', self.target_repo.chk_bytes),
 
4029
                ):
 
4030
                if versioned_file is None:
 
4031
                    continue
 
4032
                missing_keys.update((prefix,) + key for key in
 
4033
                    versioned_file.get_missing_compression_parent_keys())
 
4034
        except NotImplementedError:
 
4035
            # cannot even attempt suspending, and missing would have failed
 
4036
            # during stream insertion.
 
4037
            missing_keys = set()
 
4038
        else:
 
4039
            if missing_keys:
 
4040
                # suspend the write group and tell the caller what we is
 
4041
                # missing. We know we can suspend or else we would not have
 
4042
                # entered this code path. (All repositories that can handle
 
4043
                # missing keys can handle suspending a write group).
 
4044
                write_group_tokens = self.target_repo.suspend_write_group()
 
4045
                return write_group_tokens, missing_keys
 
4046
        hint = self.target_repo.commit_write_group()
 
4047
        if (to_serializer != src_serializer and
 
4048
            self.target_repo._format.pack_compresses):
 
4049
            self.target_repo.pack(hint=hint)
 
4050
        return [], set()
 
4051
 
 
4052
    def _extract_and_insert_inventories(self, substream, serializer):
 
4053
        """Generate a new inventory versionedfile in target, converting data.
 
4054
 
 
4055
        The inventory is retrieved from the source, (deserializing it), and
 
4056
        stored in the target (reserializing it in a different format).
 
4057
        """
 
4058
        for record in substream:
 
4059
            bytes = record.get_bytes_as('fulltext')
 
4060
            revision_id = record.key[0]
 
4061
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4062
            parents = [key[0] for key in record.parents]
 
4063
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4064
 
 
4065
    def _extract_and_insert_revisions(self, substream, serializer):
 
4066
        for record in substream:
 
4067
            bytes = record.get_bytes_as('fulltext')
 
4068
            revision_id = record.key[0]
 
4069
            rev = serializer.read_revision_from_string(bytes)
 
4070
            if rev.revision_id != revision_id:
 
4071
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4072
            self.target_repo.add_revision(revision_id, rev)
 
4073
 
 
4074
    def finished(self):
 
4075
        if self.target_repo._format._fetch_reconcile:
 
4076
            self.target_repo.reconcile()
 
4077
 
 
4078
 
 
4079
class StreamSource(object):
 
4080
    """A source of a stream for fetching between repositories."""
 
4081
 
 
4082
    def __init__(self, from_repository, to_format):
 
4083
        """Create a StreamSource streaming from from_repository."""
 
4084
        self.from_repository = from_repository
 
4085
        self.to_format = to_format
 
4086
 
 
4087
    def delta_on_metadata(self):
 
4088
        """Return True if delta's are permitted on metadata streams.
 
4089
 
 
4090
        That is on revisions and signatures.
 
4091
        """
 
4092
        src_serializer = self.from_repository._format._serializer
 
4093
        target_serializer = self.to_format._serializer
 
4094
        return (self.to_format._fetch_uses_deltas and
 
4095
            src_serializer == target_serializer)
 
4096
 
 
4097
    def _fetch_revision_texts(self, revs):
 
4098
        # fetch signatures first and then the revision texts
 
4099
        # may need to be a InterRevisionStore call here.
 
4100
        from_sf = self.from_repository.signatures
 
4101
        # A missing signature is just skipped.
 
4102
        keys = [(rev_id,) for rev_id in revs]
 
4103
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4104
            keys,
 
4105
            self.to_format._fetch_order,
 
4106
            not self.to_format._fetch_uses_deltas))
 
4107
        # If a revision has a delta, this is actually expanded inside the
 
4108
        # insert_record_stream code now, which is an alternate fix for
 
4109
        # bug #261339
 
4110
        from_rf = self.from_repository.revisions
 
4111
        revisions = from_rf.get_record_stream(
 
4112
            keys,
 
4113
            self.to_format._fetch_order,
 
4114
            not self.delta_on_metadata())
 
4115
        return [('signatures', signatures), ('revisions', revisions)]
 
4116
 
 
4117
    def _generate_root_texts(self, revs):
 
4118
        """This will be called by __fetch between fetching weave texts and
 
4119
        fetching the inventory weave.
 
4120
 
 
4121
        Subclasses should override this if they need to generate root texts
 
4122
        after fetching weave texts.
 
4123
        """
 
4124
        if self._rich_root_upgrade():
 
4125
            import bzrlib.fetch
 
4126
            return bzrlib.fetch.Inter1and2Helper(
 
4127
                self.from_repository).generate_root_texts(revs)
 
4128
        else:
 
4129
            return []
 
4130
 
 
4131
    def get_stream(self, search):
 
4132
        phase = 'file'
 
4133
        revs = search.get_keys()
 
4134
        graph = self.from_repository.get_graph()
 
4135
        revs = list(graph.iter_topo_order(revs))
 
4136
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4137
        text_keys = []
 
4138
        for knit_kind, file_id, revisions in data_to_fetch:
 
4139
            if knit_kind != phase:
 
4140
                phase = knit_kind
 
4141
                # Make a new progress bar for this phase
 
4142
            if knit_kind == "file":
 
4143
                # Accumulate file texts
 
4144
                text_keys.extend([(file_id, revision) for revision in
 
4145
                    revisions])
 
4146
            elif knit_kind == "inventory":
 
4147
                # Now copy the file texts.
 
4148
                from_texts = self.from_repository.texts
 
4149
                yield ('texts', from_texts.get_record_stream(
 
4150
                    text_keys, self.to_format._fetch_order,
 
4151
                    not self.to_format._fetch_uses_deltas))
 
4152
                # Cause an error if a text occurs after we have done the
 
4153
                # copy.
 
4154
                text_keys = None
 
4155
                # Before we process the inventory we generate the root
 
4156
                # texts (if necessary) so that the inventories references
 
4157
                # will be valid.
 
4158
                for _ in self._generate_root_texts(revs):
 
4159
                    yield _
 
4160
                # NB: This currently reopens the inventory weave in source;
 
4161
                # using a single stream interface instead would avoid this.
 
4162
                from_weave = self.from_repository.inventories
 
4163
                # we fetch only the referenced inventories because we do not
 
4164
                # know for unselected inventories whether all their required
 
4165
                # texts are present in the other repository - it could be
 
4166
                # corrupt.
 
4167
                for info in self._get_inventory_stream(revs):
 
4168
                    yield info
 
4169
            elif knit_kind == "signatures":
 
4170
                # Nothing to do here; this will be taken care of when
 
4171
                # _fetch_revision_texts happens.
 
4172
                pass
 
4173
            elif knit_kind == "revisions":
 
4174
                for record in self._fetch_revision_texts(revs):
 
4175
                    yield record
 
4176
            else:
 
4177
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4178
 
 
4179
    def get_stream_for_missing_keys(self, missing_keys):
 
4180
        # missing keys can only occur when we are byte copying and not
 
4181
        # translating (because translation means we don't send
 
4182
        # unreconstructable deltas ever).
 
4183
        keys = {}
 
4184
        keys['texts'] = set()
 
4185
        keys['revisions'] = set()
 
4186
        keys['inventories'] = set()
 
4187
        keys['chk_bytes'] = set()
 
4188
        keys['signatures'] = set()
 
4189
        for key in missing_keys:
 
4190
            keys[key[0]].add(key[1:])
 
4191
        if len(keys['revisions']):
 
4192
            # If we allowed copying revisions at this point, we could end up
 
4193
            # copying a revision without copying its required texts: a
 
4194
            # violation of the requirements for repository integrity.
 
4195
            raise AssertionError(
 
4196
                'cannot copy revisions to fill in missing deltas %s' % (
 
4197
                    keys['revisions'],))
 
4198
        for substream_kind, keys in keys.iteritems():
 
4199
            vf = getattr(self.from_repository, substream_kind)
 
4200
            if vf is None and keys:
 
4201
                    raise AssertionError(
 
4202
                        "cannot fill in keys for a versioned file we don't"
 
4203
                        " have: %s needs %s" % (substream_kind, keys))
 
4204
            if not keys:
 
4205
                # No need to stream something we don't have
 
4206
                continue
 
4207
            # Ask for full texts always so that we don't need more round trips
 
4208
            # after this stream.
 
4209
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4210
            # records. The Sink is responsible for doing another check to
 
4211
            # ensure that ghosts don't introduce missing data for future
 
4212
            # fetches.
 
4213
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4214
                self.to_format._fetch_order, True))
 
4215
            yield substream_kind, stream
 
4216
 
 
4217
    def inventory_fetch_order(self):
 
4218
        if self._rich_root_upgrade():
 
4219
            return 'topological'
 
4220
        else:
 
4221
            return self.to_format._fetch_order
 
4222
 
 
4223
    def _rich_root_upgrade(self):
 
4224
        return (not self.from_repository._format.rich_root_data and
 
4225
            self.to_format.rich_root_data)
 
4226
 
 
4227
    def _get_inventory_stream(self, revision_ids):
 
4228
        from_format = self.from_repository._format
 
4229
        if (from_format.supports_chks and self.to_format.supports_chks
 
4230
            and (from_format._serializer == self.to_format._serializer)):
 
4231
            # Both sides support chks, and they use the same serializer, so it
 
4232
            # is safe to transmit the chk pages and inventory pages across
 
4233
            # as-is.
 
4234
            return self._get_chk_inventory_stream(revision_ids)
 
4235
        elif (not from_format.supports_chks):
 
4236
            # Source repository doesn't support chks. So we can transmit the
 
4237
            # inventories 'as-is' and either they are just accepted on the
 
4238
            # target, or the Sink will properly convert it.
 
4239
            return self._get_simple_inventory_stream(revision_ids)
 
4240
        else:
 
4241
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4242
            #      inventories. Note that this should probably be done somehow
 
4243
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4244
            #      figure out how a non-chk repository could possibly handle
 
4245
            #      deserializing an inventory stream from a chk repo, as it
 
4246
            #      doesn't have a way to understand individual pages.
 
4247
            return self._get_convertable_inventory_stream(revision_ids)
 
4248
 
 
4249
    def _get_simple_inventory_stream(self, revision_ids):
 
4250
        from_weave = self.from_repository.inventories
 
4251
        yield ('inventories', from_weave.get_record_stream(
 
4252
            [(rev_id,) for rev_id in revision_ids],
 
4253
            self.inventory_fetch_order(),
 
4254
            not self.delta_on_metadata()))
 
4255
 
 
4256
    def _get_chk_inventory_stream(self, revision_ids):
 
4257
        """Fetch the inventory texts, along with the associated chk maps."""
 
4258
        # We want an inventory outside of the search set, so that we can filter
 
4259
        # out uninteresting chk pages. For now we use
 
4260
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4261
        # could use that instead.
 
4262
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4263
                            revision_ids)
 
4264
        start_rev_key = (start_rev_id,)
 
4265
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4266
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4267
            inv_keys_to_fetch.append((start_rev_id,))
 
4268
        # Any repo that supports chk_bytes must also support out-of-order
 
4269
        # insertion. At least, that is how we expect it to work
 
4270
        # We use get_record_stream instead of iter_inventories because we want
 
4271
        # to be able to insert the stream as well. We could instead fetch
 
4272
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4273
        # source or target is more 'local' anway.
 
4274
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4275
            inv_keys_to_fetch, 'unordered',
 
4276
            True) # We need them as full-texts so we can find their references
 
4277
        uninteresting_chk_roots = set()
 
4278
        interesting_chk_roots = set()
 
4279
        def filter_inv_stream(inv_stream):
 
4280
            for idx, record in enumerate(inv_stream):
 
4281
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4282
                bytes = record.get_bytes_as('fulltext')
 
4283
                chk_inv = inventory.CHKInventory.deserialise(
 
4284
                    self.from_repository.chk_bytes, bytes, record.key)
 
4285
                if record.key == start_rev_key:
 
4286
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4287
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4288
                    if p_id_map is not None:
 
4289
                        uninteresting_chk_roots.add(p_id_map.key())
 
4290
                else:
 
4291
                    yield record
 
4292
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4293
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4294
                    if p_id_map is not None:
 
4295
                        interesting_chk_roots.add(p_id_map.key())
 
4296
        ### pb.update('fetch inventory', 0, 2)
 
4297
        yield ('inventories', filter_inv_stream(inv_stream))
 
4298
        # Now that we have worked out all of the interesting root nodes, grab
 
4299
        # all of the interesting pages and insert them
 
4300
        ### pb.update('fetch inventory', 1, 2)
 
4301
        interesting = chk_map.iter_interesting_nodes(
 
4302
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4303
            uninteresting_chk_roots)
 
4304
        def to_stream_adapter():
 
4305
            """Adapt the iter_interesting_nodes result to a single stream.
 
4306
 
 
4307
            iter_interesting_nodes returns records as it processes them, along
 
4308
            with keys. However, we only want to return the records themselves.
 
4309
            """
 
4310
            for record, items in interesting:
 
4311
                if record is not None:
 
4312
                    yield record
 
4313
        # XXX: We could instead call get_record_stream(records.keys())
 
4314
        #      ATM, this will always insert the records as fulltexts, and
 
4315
        #      requires that you can hang on to records once you have gone
 
4316
        #      on to the next one. Further, it causes the target to
 
4317
        #      recompress the data. Testing shows it to be faster than
 
4318
        #      requesting the records again, though.
 
4319
        yield ('chk_bytes', to_stream_adapter())
 
4320
        ### pb.update('fetch inventory', 2, 2)
 
4321
 
 
4322
    def _get_convertable_inventory_stream(self, revision_ids):
 
4323
        # XXX: One of source or target is using chks, and they don't have
 
4324
        #      compatible serializations. The StreamSink code expects to be
 
4325
        #      able to convert on the target, so we need to put
 
4326
        #      bytes-on-the-wire that can be converted
 
4327
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4328
 
 
4329
    def _stream_invs_as_fulltexts(self, revision_ids):
 
4330
        from_repo = self.from_repository
 
4331
        from_serializer = from_repo._format._serializer
 
4332
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4333
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4334
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4335
            # XXX: This is a bit hackish, but it works. Basically,
 
4336
            #      CHKSerializer 'accidentally' supports
 
4337
            #      read/write_inventory_to_string, even though that is never
 
4338
            #      the format that is stored on disk. It *does* give us a
 
4339
            #      single string representation for an inventory, so live with
 
4340
            #      it for now.
 
4341
            #      This would be far better if we had a 'serialized inventory
 
4342
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4343
            #      transmit that. This would both be faster to generate, and
 
4344
            #      result in fewer bytes-on-the-wire.
 
4345
            as_bytes = from_serializer.write_inventory_to_string(inv)
 
4346
            key = (inv.revision_id,)
 
4347
            parent_keys = parent_map.get(key, ())
 
4348
            yield versionedfile.FulltextContentFactory(
 
4349
                key, parent_keys, None, as_bytes)
 
4350
 
 
4351
 
1835
4352
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1836
4353
                    stop_revision=None):
1837
4354
    """Extend the partial history to include a given index
1847
4364
        it is encountered, history extension will stop.
1848
4365
    """
1849
4366
    start_revision = partial_history_cache[-1]
1850
 
    graph = repo.get_graph()
1851
 
    iterator = graph.iter_lefthand_ancestry(start_revision,
1852
 
        (_mod_revision.NULL_REVISION,))
 
4367
    iterator = repo.iter_reverse_revision_history(start_revision)
1853
4368
    try:
1854
 
        # skip the last revision in the list
 
4369
        #skip the last revision in the list
1855
4370
        iterator.next()
1856
4371
        while True:
1857
4372
            if (stop_index is not None and
1865
4380
        # No more history
1866
4381
        return
1867
4382
 
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)