~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2007-10-23 22:14:32 UTC
  • mto: (2592.6.3 repository)
  • mto: This revision was merged to the branch mainline in revision 2967.
  • Revision ID: robertc@robertcollins.net-20071023221432-j8zndh1oiegql3cu
* Commit updates the state of the working tree via a delta rather than
  supplying entirely new basis trees. For commit of a single specified file
  this reduces the wall clock time for commit by roughly a 30%.
  (Robert Collins, Martin Pool)

Show diffs side-by-side

added added

removed removed

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