~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Joe Julian
  • Date: 2010-01-10 02:25:31 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: joe@julianfamily.org-20100110022531-wqk61rsagz8xsiga
Added MANIFEST.in to allow bdist_rpm to have all the required include files and tools. bdist_rpm will still fail to build correctly on some distributions due to a disttools bug http://bugs.python.org/issue644744

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