← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-27 22:07:03 UTC
  • mfrom: (4301.2.5 bzr.ab.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090427220703-oy9b0mxobrksvuyq
(gbache) Handle symlinks better in bzr add

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