1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
39
revision as _mod_revision,
45
from bzrlib.bundle import serializer
46
from bzrlib.revisiontree import RevisionTree
47
from bzrlib.store.versioned import VersionedFileStore
48
from bzrlib.testament import Testament
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
52
from bzrlib.inter import InterObject
53
from bzrlib.inventory import (
59
from bzrlib import registry
60
from bzrlib.trace import (
61
log_exception_quietly, note, mutter, mutter_callsite, warning)
64
# Old formats display a warning, but only once
65
_deprecation_warning_done = False
68
class CommitBuilder(object):
69
"""Provides an interface to build up a commit.
71
This allows describing a tree to be committed without needing to
72
know the internals of the format of the repository.
75
# all clients should supply tree roots.
76
record_root_entry = True
77
# the default CommitBuilder does not manage trees whose root is versioned.
78
_versioned_root = False
80
def __init__(self, repository, parents, config, timestamp=None,
81
timezone=None, committer=None, revprops=None,
83
"""Initiate a CommitBuilder.
85
:param repository: Repository to commit to.
86
:param parents: Revision ids of the parents of the new revision.
87
:param config: Configuration to use.
88
:param timestamp: Optional timestamp recorded for commit.
89
:param timezone: Optional timezone for timestamp.
90
:param committer: Optional committer to set for commit.
91
:param revprops: Optional dictionary of revision properties.
92
:param revision_id: Optional revision id.
97
self._committer = self._config.username()
99
self._committer = committer
101
self.new_inventory = Inventory(None)
102
self._new_revision_id = revision_id
103
self.parents = parents
104
self.repository = repository
107
if revprops is not None:
108
self._validate_revprops(revprops)
109
self._revprops.update(revprops)
111
if timestamp is None:
112
timestamp = time.time()
113
# Restrict resolution to 1ms
114
self._timestamp = round(timestamp, 3)
117
self._timezone = osutils.local_time_offset()
119
self._timezone = int(timezone)
121
self._generate_revision_if_needed()
122
self.__heads = graph.HeadsCache(repository.get_graph()).heads
123
self._basis_delta = []
124
# API compatibility, older code that used CommitBuilder did not call
125
# .record_delete(), which means the delta that is computed would not be
126
# valid. Callers that will call record_delete() should call
127
# .will_record_deletes() to indicate that.
128
self._recording_deletes = False
129
# memo'd check for no-op commits.
130
self._any_changes = False
132
def any_changes(self):
133
"""Return True if any entries were changed.
135
This includes merge-only changes. It is the core for the --unchanged
138
:return: True if any changes have occured.
140
return self._any_changes
142
def _validate_unicode_text(self, text, context):
143
"""Verify things like commit messages don't have bogus characters."""
145
raise ValueError('Invalid value for %s: %r' % (context, text))
147
def _validate_revprops(self, revprops):
148
for key, value in revprops.iteritems():
149
# We know that the XML serializers do not round trip '\r'
150
# correctly, so refuse to accept them
151
if not isinstance(value, basestring):
152
raise ValueError('revision property (%s) is not a valid'
153
' (unicode) string: %r' % (key, value))
154
self._validate_unicode_text(value,
155
'revision property (%s)' % (key,))
157
def commit(self, message):
158
"""Make the actual commit.
160
:return: The revision id of the recorded revision.
162
self._validate_unicode_text(message, 'commit message')
163
rev = _mod_revision.Revision(
164
timestamp=self._timestamp,
165
timezone=self._timezone,
166
committer=self._committer,
168
inventory_sha1=self.inv_sha1,
169
revision_id=self._new_revision_id,
170
properties=self._revprops)
171
rev.parent_ids = self.parents
172
self.repository.add_revision(self._new_revision_id, rev,
173
self.new_inventory, self._config)
174
self.repository.commit_write_group()
175
return self._new_revision_id
178
"""Abort the commit that is being built.
180
self.repository.abort_write_group()
182
def revision_tree(self):
183
"""Return the tree that was just committed.
185
After calling commit() this can be called to get a RevisionTree
186
representing the newly committed tree. This is preferred to
187
calling Repository.revision_tree() because that may require
188
deserializing the inventory, while we already have a copy in
191
if self.new_inventory is None:
192
self.new_inventory = self.repository.get_inventory(
193
self._new_revision_id)
194
return RevisionTree(self.repository, self.new_inventory,
195
self._new_revision_id)
197
def finish_inventory(self):
198
"""Tell the builder that the inventory is finished.
200
:return: The inventory id in the repository, which can be used with
201
repository.get_inventory.
203
if self.new_inventory is None:
204
# an inventory delta was accumulated without creating a new
206
basis_id = self.basis_delta_revision
207
self.inv_sha1 = self.repository.add_inventory_by_delta(
208
basis_id, self._basis_delta, self._new_revision_id,
211
if self.new_inventory.root is None:
212
raise AssertionError('Root entry should be supplied to'
213
' record_entry_contents, as of bzr 0.10.')
214
self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
215
self.new_inventory.revision_id = self._new_revision_id
216
self.inv_sha1 = self.repository.add_inventory(
217
self._new_revision_id,
221
return self._new_revision_id
223
def _gen_revision_id(self):
224
"""Return new revision-id."""
225
return generate_ids.gen_revision_id(self._config.username(),
228
def _generate_revision_if_needed(self):
229
"""Create a revision id if None was supplied.
231
If the repository can not support user-specified revision ids
232
they should override this function and raise CannotSetRevisionId
233
if _new_revision_id is not None.
235
:raises: CannotSetRevisionId
237
if self._new_revision_id is None:
238
self._new_revision_id = self._gen_revision_id()
239
self.random_revid = True
241
self.random_revid = False
243
def _heads(self, file_id, revision_ids):
244
"""Calculate the graph heads for revision_ids in the graph of file_id.
246
This can use either a per-file graph or a global revision graph as we
247
have an identity relationship between the two graphs.
249
return self.__heads(revision_ids)
251
def _check_root(self, ie, parent_invs, tree):
252
"""Helper for record_entry_contents.
254
:param ie: An entry being added.
255
:param parent_invs: The inventories of the parent revisions of the
257
:param tree: The tree that is being committed.
259
# In this revision format, root entries have no knit or weave When
260
# serializing out to disk and back in root.revision is always
262
ie.revision = self._new_revision_id
264
def _require_root_change(self, tree):
265
"""Enforce an appropriate root object change.
267
This is called once when record_iter_changes is called, if and only if
268
the root was not in the delta calculated by record_iter_changes.
270
:param tree: The tree which is being committed.
272
# NB: if there are no parents then this method is not called, so no
273
# need to guard on parents having length.
274
entry = entry_factory['directory'](tree.path2id(''), '',
276
entry.revision = self._new_revision_id
277
self._basis_delta.append(('', '', entry.file_id, entry))
279
def _get_delta(self, ie, basis_inv, path):
280
"""Get a delta against the basis inventory for ie."""
281
if ie.file_id not in basis_inv:
283
result = (None, path, ie.file_id, ie)
284
self._basis_delta.append(result)
286
elif ie != basis_inv[ie.file_id]:
288
# TODO: avoid tis id2path call.
289
result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
290
self._basis_delta.append(result)
296
def get_basis_delta(self):
297
"""Return the complete inventory delta versus the basis inventory.
299
This has been built up with the calls to record_delete and
300
record_entry_contents. The client must have already called
301
will_record_deletes() to indicate that they will be generating a
304
:return: An inventory delta, suitable for use with apply_delta, or
305
Repository.add_inventory_by_delta, etc.
307
if not self._recording_deletes:
308
raise AssertionError("recording deletes not activated.")
309
return self._basis_delta
311
def record_delete(self, path, file_id):
312
"""Record that a delete occured against a basis tree.
314
This is an optional API - when used it adds items to the basis_delta
315
being accumulated by the commit builder. It cannot be called unless the
316
method will_record_deletes() has been called to inform the builder that
317
a delta is being supplied.
319
:param path: The path of the thing deleted.
320
:param file_id: The file id that was deleted.
322
if not self._recording_deletes:
323
raise AssertionError("recording deletes not activated.")
324
delta = (path, None, file_id, None)
325
self._basis_delta.append(delta)
326
self._any_changes = True
329
def will_record_deletes(self):
330
"""Tell the commit builder that deletes are being notified.
332
This enables the accumulation of an inventory delta; for the resulting
333
commit to be valid, deletes against the basis MUST be recorded via
334
builder.record_delete().
336
self._recording_deletes = True
338
basis_id = self.parents[0]
340
basis_id = _mod_revision.NULL_REVISION
341
self.basis_delta_revision = basis_id
343
def record_entry_contents(self, ie, parent_invs, path, tree,
345
"""Record the content of ie from tree into the commit if needed.
347
Side effect: sets ie.revision when unchanged
349
:param ie: An inventory entry present in the commit.
350
:param parent_invs: The inventories of the parent revisions of the
352
:param path: The path the entry is at in the tree.
353
:param tree: The tree which contains this entry and should be used to
355
:param content_summary: Summary data from the tree about the paths
356
content - stat, length, exec, sha/link target. This is only
357
accessed when the entry has a revision of None - that is when it is
358
a candidate to commit.
359
:return: A tuple (change_delta, version_recorded, fs_hash).
360
change_delta is an inventory_delta change for this entry against
361
the basis tree of the commit, or None if no change occured against
363
version_recorded is True if a new version of the entry has been
364
recorded. For instance, committing a merge where a file was only
365
changed on the other side will return (delta, False).
366
fs_hash is either None, or the hash details for the path (currently
367
a tuple of the contents sha1 and the statvalue returned by
368
tree.get_file_with_stat()).
370
if self.new_inventory.root is None:
371
if ie.parent_id is not None:
372
raise errors.RootMissing()
373
self._check_root(ie, parent_invs, tree)
374
if ie.revision is None:
375
kind = content_summary[0]
377
# ie is carried over from a prior commit
379
# XXX: repository specific check for nested tree support goes here - if
380
# the repo doesn't want nested trees we skip it ?
381
if (kind == 'tree-reference' and
382
not self.repository._format.supports_tree_reference):
383
# mismatch between commit builder logic and repository:
384
# this needs the entry creation pushed down into the builder.
385
raise NotImplementedError('Missing repository subtree support.')
386
self.new_inventory.add(ie)
388
# TODO: slow, take it out of the inner loop.
390
basis_inv = parent_invs[0]
392
basis_inv = Inventory(root_id=None)
394
# ie.revision is always None if the InventoryEntry is considered
395
# for committing. We may record the previous parents revision if the
396
# content is actually unchanged against a sole head.
397
if ie.revision is not None:
398
if not self._versioned_root and path == '':
399
# repositories that do not version the root set the root's
400
# revision to the new commit even when no change occurs (more
401
# specifically, they do not record a revision on the root; and
402
# the rev id is assigned to the root during deserialisation -
403
# this masks when a change may have occurred against the basis.
404
# To match this we always issue a delta, because the revision
405
# of the root will always be changing.
406
if ie.file_id in basis_inv:
407
delta = (basis_inv.id2path(ie.file_id), path,
411
delta = (None, path, ie.file_id, ie)
412
self._basis_delta.append(delta)
413
return delta, False, None
415
# we don't need to commit this, because the caller already
416
# determined that an existing revision of this file is
417
# appropriate. If its not being considered for committing then
418
# it and all its parents to the root must be unaltered so
419
# no-change against the basis.
420
if ie.revision == self._new_revision_id:
421
raise AssertionError("Impossible situation, a skipped "
422
"inventory entry (%r) claims to be modified in this "
423
"commit (%r).", (ie, self._new_revision_id))
424
return None, False, None
425
# XXX: Friction: parent_candidates should return a list not a dict
426
# so that we don't have to walk the inventories again.
427
parent_candiate_entries = ie.parent_candidates(parent_invs)
428
head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
430
for inv in parent_invs:
431
if ie.file_id in inv:
432
old_rev = inv[ie.file_id].revision
433
if old_rev in head_set:
434
heads.append(inv[ie.file_id].revision)
435
head_set.remove(inv[ie.file_id].revision)
438
# now we check to see if we need to write a new record to the
440
# We write a new entry unless there is one head to the ancestors, and
441
# the kind-derived content is unchanged.
443
# Cheapest check first: no ancestors, or more the one head in the
444
# ancestors, we write a new node.
448
# There is a single head, look it up for comparison
449
parent_entry = parent_candiate_entries[heads[0]]
450
# if the non-content specific data has changed, we'll be writing a
452
if (parent_entry.parent_id != ie.parent_id or
453
parent_entry.name != ie.name):
455
# now we need to do content specific checks:
457
# if the kind changed the content obviously has
458
if kind != parent_entry.kind:
460
# Stat cache fingerprint feedback for the caller - None as we usually
461
# don't generate one.
464
if content_summary[2] is None:
465
raise ValueError("Files must not have executable = None")
467
if (# if the file length changed we have to store:
468
parent_entry.text_size != content_summary[1] or
469
# if the exec bit has changed we have to store:
470
parent_entry.executable != content_summary[2]):
472
elif parent_entry.text_sha1 == content_summary[3]:
473
# all meta and content is unchanged (using a hash cache
474
# hit to check the sha)
475
ie.revision = parent_entry.revision
476
ie.text_size = parent_entry.text_size
477
ie.text_sha1 = parent_entry.text_sha1
478
ie.executable = parent_entry.executable
479
return self._get_delta(ie, basis_inv, path), False, None
481
# Either there is only a hash change(no hash cache entry,
482
# or same size content change), or there is no change on
484
# Provide the parent's hash to the store layer, so that the
485
# content is unchanged we will not store a new node.
486
nostore_sha = parent_entry.text_sha1
488
# We want to record a new node regardless of the presence or
489
# absence of a content change in the file.
491
ie.executable = content_summary[2]
492
file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
494
text = file_obj.read()
498
ie.text_sha1, ie.text_size = self._add_text_to_weave(
499
ie.file_id, text, heads, nostore_sha)
500
# Let the caller know we generated a stat fingerprint.
501
fingerprint = (ie.text_sha1, stat_value)
502
except errors.ExistingContent:
503
# Turns out that the file content was unchanged, and we were
504
# only going to store a new node if it was changed. Carry over
506
ie.revision = parent_entry.revision
507
ie.text_size = parent_entry.text_size
508
ie.text_sha1 = parent_entry.text_sha1
509
ie.executable = parent_entry.executable
510
return self._get_delta(ie, basis_inv, path), False, None
511
elif kind == 'directory':
513
# all data is meta here, nothing specific to directory, so
515
ie.revision = parent_entry.revision
516
return self._get_delta(ie, basis_inv, path), False, None
517
self._add_text_to_weave(ie.file_id, '', heads, None)
518
elif kind == 'symlink':
519
current_link_target = content_summary[3]
521
# symlink target is not generic metadata, check if it has
523
if current_link_target != parent_entry.symlink_target:
526
# unchanged, carry over.
527
ie.revision = parent_entry.revision
528
ie.symlink_target = parent_entry.symlink_target
529
return self._get_delta(ie, basis_inv, path), False, None
530
ie.symlink_target = current_link_target
531
self._add_text_to_weave(ie.file_id, '', heads, None)
532
elif kind == 'tree-reference':
534
if content_summary[3] != parent_entry.reference_revision:
537
# unchanged, carry over.
538
ie.reference_revision = parent_entry.reference_revision
539
ie.revision = parent_entry.revision
540
return self._get_delta(ie, basis_inv, path), False, None
541
ie.reference_revision = content_summary[3]
542
self._add_text_to_weave(ie.file_id, '', heads, None)
544
raise NotImplementedError('unknown kind')
545
ie.revision = self._new_revision_id
546
self._any_changes = True
547
return self._get_delta(ie, basis_inv, path), True, fingerprint
549
def record_iter_changes(self, tree, basis_revision_id, iter_changes,
550
_entry_factory=entry_factory):
551
"""Record a new tree via iter_changes.
553
:param tree: The tree to obtain text contents from for changed objects.
554
:param basis_revision_id: The revision id of the tree the iter_changes
555
has been generated against. Currently assumed to be the same
556
as self.parents[0] - if it is not, errors may occur.
557
:param iter_changes: An iter_changes iterator with the changes to apply
558
to basis_revision_id. The iterator must not include any items with
559
a current kind of None - missing items must be either filtered out
560
or errored-on beefore record_iter_changes sees the item.
561
:param _entry_factory: Private method to bind entry_factory locally for
563
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
566
# Create an inventory delta based on deltas between all the parents and
567
# deltas between all the parent inventories. We use inventory delta's
568
# between the inventory objects because iter_changes masks
569
# last-changed-field only changes.
571
# file_id -> change map, change is fileid, paths, changed, versioneds,
572
# parents, names, kinds, executables
574
# {file_id -> revision_id -> inventory entry, for entries in parent
575
# trees that are not parents[0]
579
revtrees = list(self.repository.revision_trees(self.parents))
580
except errors.NoSuchRevision:
581
# one or more ghosts, slow path.
583
for revision_id in self.parents:
585
revtrees.append(self.repository.revision_tree(revision_id))
586
except errors.NoSuchRevision:
588
basis_revision_id = _mod_revision.NULL_REVISION
590
revtrees.append(self.repository.revision_tree(
591
_mod_revision.NULL_REVISION))
592
# The basis inventory from a repository
594
basis_inv = revtrees[0].inventory
596
basis_inv = self.repository.revision_tree(
597
_mod_revision.NULL_REVISION).inventory
598
if len(self.parents) > 0:
599
if basis_revision_id != self.parents[0] and not ghost_basis:
601
"arbitrary basis parents not yet supported with merges")
602
for revtree in revtrees[1:]:
603
for change in revtree.inventory._make_delta(basis_inv):
604
if change[1] is None:
605
# Not present in this parent.
607
if change[2] not in merged_ids:
608
if change[0] is not None:
609
basis_entry = basis_inv[change[2]]
610
merged_ids[change[2]] = [
612
basis_entry.revision,
615
parent_entries[change[2]] = {
617
basis_entry.revision:basis_entry,
619
change[3].revision:change[3],
622
merged_ids[change[2]] = [change[3].revision]
623
parent_entries[change[2]] = {change[3].revision:change[3]}
625
merged_ids[change[2]].append(change[3].revision)
626
parent_entries[change[2]][change[3].revision] = change[3]
629
# Setup the changes from the tree:
630
# changes maps file_id -> (change, [parent revision_ids])
632
for change in iter_changes:
633
# This probably looks up in basis_inv way to much.
634
if change[1][0] is not None:
635
head_candidate = [basis_inv[change[0]].revision]
638
changes[change[0]] = change, merged_ids.get(change[0],
640
unchanged_merged = set(merged_ids) - set(changes)
641
# Extend the changes dict with synthetic changes to record merges of
643
for file_id in unchanged_merged:
644
# Record a merged version of these items that did not change vs the
645
# basis. This can be either identical parallel changes, or a revert
646
# of a specific file after a merge. The recorded content will be
647
# that of the current tree (which is the same as the basis), but
648
# the per-file graph will reflect a merge.
649
# NB:XXX: We are reconstructing path information we had, this
650
# should be preserved instead.
651
# inv delta change: (file_id, (path_in_source, path_in_target),
652
# changed_content, versioned, parent, name, kind,
655
basis_entry = basis_inv[file_id]
656
except errors.NoSuchId:
657
# a change from basis->some_parents but file_id isn't in basis
658
# so was new in the merge, which means it must have changed
659
# from basis -> current, and as it hasn't the add was reverted
660
# by the user. So we discard this change.
664
(basis_inv.id2path(file_id), tree.id2path(file_id)),
666
(basis_entry.parent_id, basis_entry.parent_id),
667
(basis_entry.name, basis_entry.name),
668
(basis_entry.kind, basis_entry.kind),
669
(basis_entry.executable, basis_entry.executable))
670
changes[file_id] = (change, merged_ids[file_id])
671
# changes contains tuples with the change and a set of inventory
672
# candidates for the file.
674
# old_path, new_path, file_id, new_inventory_entry
675
seen_root = False # Is the root in the basis delta?
676
inv_delta = self._basis_delta
677
modified_rev = self._new_revision_id
678
for change, head_candidates in changes.values():
679
if change[3][1]: # versioned in target.
680
# Several things may be happening here:
681
# We may have a fork in the per-file graph
682
# - record a change with the content from tree
683
# We may have a change against < all trees
684
# - carry over the tree that hasn't changed
685
# We may have a change against all trees
686
# - record the change with the content from tree
689
entry = _entry_factory[kind](file_id, change[5][1],
691
head_set = self._heads(change[0], set(head_candidates))
694
for head_candidate in head_candidates:
695
if head_candidate in head_set:
696
heads.append(head_candidate)
697
head_set.remove(head_candidate)
700
# Could be a carry-over situation:
701
parent_entry_revs = parent_entries.get(file_id, None)
702
if parent_entry_revs:
703
parent_entry = parent_entry_revs.get(heads[0], None)
706
if parent_entry is None:
707
# The parent iter_changes was called against is the one
708
# that is the per-file head, so any change is relevant
709
# iter_changes is valid.
710
carry_over_possible = False
712
# could be a carry over situation
713
# A change against the basis may just indicate a merge,
714
# we need to check the content against the source of the
715
# merge to determine if it was changed after the merge
717
if (parent_entry.kind != entry.kind or
718
parent_entry.parent_id != entry.parent_id or
719
parent_entry.name != entry.name):
720
# Metadata common to all entries has changed
721
# against per-file parent
722
carry_over_possible = False
724
carry_over_possible = True
725
# per-type checks for changes against the parent_entry
728
# Cannot be a carry-over situation
729
carry_over_possible = False
730
# Populate the entry in the delta
732
# XXX: There is still a small race here: If someone reverts the content of a file
733
# after iter_changes examines and decides it has changed,
734
# we will unconditionally record a new version even if some
735
# other process reverts it while commit is running (with
736
# the revert happening after iter_changes did it's
739
entry.executable = True
741
entry.executable = False
742
if (carry_over_possible and
743
parent_entry.executable == entry.executable):
744
# Check the file length, content hash after reading
746
nostore_sha = parent_entry.text_sha1
749
file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
751
text = file_obj.read()
755
entry.text_sha1, entry.text_size = self._add_text_to_weave(
756
file_id, text, heads, nostore_sha)
757
yield file_id, change[1][1], (entry.text_sha1, stat_value)
758
except errors.ExistingContent:
759
# No content change against a carry_over parent
760
# Perhaps this should also yield a fs hash update?
762
entry.text_size = parent_entry.text_size
763
entry.text_sha1 = parent_entry.text_sha1
764
elif kind == 'symlink':
766
entry.symlink_target = tree.get_symlink_target(file_id)
767
if (carry_over_possible and
768
parent_entry.symlink_target == entry.symlink_target):
771
self._add_text_to_weave(change[0], '', heads, None)
772
elif kind == 'directory':
773
if carry_over_possible:
776
# Nothing to set on the entry.
777
# XXX: split into the Root and nonRoot versions.
778
if change[1][1] != '' or self.repository.supports_rich_root():
779
self._add_text_to_weave(change[0], '', heads, None)
780
elif kind == 'tree-reference':
781
if not self.repository._format.supports_tree_reference:
782
# This isn't quite sane as an error, but we shouldn't
783
# ever see this code path in practice: tree's don't
784
# permit references when the repo doesn't support tree
786
raise errors.UnsupportedOperation(tree.add_reference,
788
reference_revision = tree.get_reference_revision(change[0])
789
entry.reference_revision = reference_revision
790
if (carry_over_possible and
791
parent_entry.reference_revision == reference_revision):
794
self._add_text_to_weave(change[0], '', heads, None)
796
raise AssertionError('unknown kind %r' % kind)
798
entry.revision = modified_rev
800
entry.revision = parent_entry.revision
803
new_path = change[1][1]
804
inv_delta.append((change[1][0], new_path, change[0], entry))
807
self.new_inventory = None
809
self._any_changes = True
811
# housekeeping root entry changes do not affect no-change commits.
812
self._require_root_change(tree)
813
self.basis_delta_revision = basis_revision_id
815
def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
816
parent_keys = tuple([(file_id, parent) for parent in parents])
817
return self.repository.texts._add_text(
818
(file_id, self._new_revision_id), parent_keys, new_text,
819
nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
822
class RootCommitBuilder(CommitBuilder):
823
"""This commitbuilder actually records the root id"""
825
# the root entry gets versioned properly by this builder.
826
_versioned_root = True
828
def _check_root(self, ie, parent_invs, tree):
829
"""Helper for record_entry_contents.
831
:param ie: An entry being added.
832
:param parent_invs: The inventories of the parent revisions of the
834
:param tree: The tree that is being committed.
837
def _require_root_change(self, tree):
838
"""Enforce an appropriate root object change.
840
This is called once when record_iter_changes is called, if and only if
841
the root was not in the delta calculated by record_iter_changes.
843
:param tree: The tree which is being committed.
845
# versioned roots do not change unless the tree found a change.
848
######################################################################
852
class Repository(object):
853
"""Repository holding history for one or more branches.
855
The repository holds and retrieves historical information including
856
revisions and file history. It's normally accessed only by the Branch,
857
which views a particular line of development through that history.
859
The Repository builds on top of some byte storage facilies (the revisions,
860
signatures, inventories, texts and chk_bytes attributes) and a Transport,
861
which respectively provide byte storage and a means to access the (possibly
864
The byte storage facilities are addressed via tuples, which we refer to
865
as 'keys' throughout the code base. Revision_keys, inventory_keys and
866
signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
867
(file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
868
byte string made up of a hash identifier and a hash value.
869
We use this interface because it allows low friction with the underlying
870
code that implements disk indices, network encoding and other parts of
873
:ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
874
the serialised revisions for the repository. This can be used to obtain
875
revision graph information or to access raw serialised revisions.
876
The result of trying to insert data into the repository via this store
877
is undefined: it should be considered read-only except for implementors
879
:ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
880
the serialised signatures for the repository. This can be used to
881
obtain access to raw serialised signatures. The result of trying to
882
insert data into the repository via this store is undefined: it should
883
be considered read-only except for implementors of repositories.
884
:ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
885
the serialised inventories for the repository. This can be used to
886
obtain unserialised inventories. The result of trying to insert data
887
into the repository via this store is undefined: it should be
888
considered read-only except for implementors of repositories.
889
:ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
890
texts of files and directories for the repository. This can be used to
891
obtain file texts or file graphs. Note that Repository.iter_file_bytes
892
is usually a better interface for accessing file texts.
893
The result of trying to insert data into the repository via this store
894
is undefined: it should be considered read-only except for implementors
896
:ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
897
any data the repository chooses to store or have indexed by its hash.
898
The result of trying to insert data into the repository via this store
899
is undefined: it should be considered read-only except for implementors
901
:ivar _transport: Transport for file access to repository, typically
902
pointing to .bzr/repository.
905
# What class to use for a CommitBuilder. Often its simpler to change this
906
# in a Repository class subclass rather than to override
907
# get_commit_builder.
908
_commit_builder_class = CommitBuilder
909
# The search regex used by xml based repositories to determine what things
910
# where changed in a single commit.
911
_file_ids_altered_regex = lazy_regex.lazy_compile(
912
r'file_id="(?P<file_id>[^"]+)"'
913
r'.* revision="(?P<revision_id>[^"]+)"'
916
def abort_write_group(self, suppress_errors=False):
917
"""Commit the contents accrued within the current write group.
919
:param suppress_errors: if true, abort_write_group will catch and log
920
unexpected errors that happen during the abort, rather than
921
allowing them to propagate. Defaults to False.
923
:seealso: start_write_group.
925
if self._write_group is not self.get_transaction():
926
# has an unlock or relock occured ?
927
raise errors.BzrError(
928
'mismatched lock context and write group. %r, %r' %
929
(self._write_group, self.get_transaction()))
931
self._abort_write_group()
932
except Exception, exc:
933
self._write_group = None
934
if not suppress_errors:
936
mutter('abort_write_group failed')
937
log_exception_quietly()
938
note('bzr: ERROR (ignored): %s', exc)
939
self._write_group = None
941
def _abort_write_group(self):
942
"""Template method for per-repository write group cleanup.
944
This is called during abort before the write group is considered to be
945
finished and should cleanup any internal state accrued during the write
946
group. There is no requirement that data handed to the repository be
947
*not* made available - this is not a rollback - but neither should any
948
attempt be made to ensure that data added is fully commited. Abort is
949
invoked when an error has occured so futher disk or network operations
950
may not be possible or may error and if possible should not be
954
def add_fallback_repository(self, repository):
955
"""Add a repository to use for looking up data not held locally.
957
:param repository: A repository.
959
if not self._format.supports_external_lookups:
960
raise errors.UnstackableRepositoryFormat(self._format, self.base)
962
# This repository will call fallback.unlock() when we transition to
963
# the unlocked state, so we make sure to increment the lock count
964
repository.lock_read()
965
self._check_fallback_repository(repository)
966
self._fallback_repositories.append(repository)
967
self.texts.add_fallback_versioned_files(repository.texts)
968
self.inventories.add_fallback_versioned_files(repository.inventories)
969
self.revisions.add_fallback_versioned_files(repository.revisions)
970
self.signatures.add_fallback_versioned_files(repository.signatures)
971
if self.chk_bytes is not None:
972
self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
974
def _check_fallback_repository(self, repository):
975
"""Check that this repository can fallback to repository safely.
977
Raise an error if not.
979
:param repository: A repository to fallback to.
981
return InterRepository._assert_same_model(self, repository)
983
def add_inventory(self, revision_id, inv, parents):
984
"""Add the inventory inv to the repository as revision_id.
986
:param parents: The revision ids of the parents that revision_id
987
is known to have and are in the repository already.
989
:returns: The validator(which is a sha1 digest, though what is sha'd is
990
repository format specific) of the serialized inventory.
992
if not self.is_in_write_group():
993
raise AssertionError("%r not in write group" % (self,))
994
_mod_revision.check_not_reserved_id(revision_id)
995
if not (inv.revision_id is None or inv.revision_id == revision_id):
996
raise AssertionError(
997
"Mismatch between inventory revision"
998
" id and insertion revid (%r, %r)"
999
% (inv.revision_id, revision_id))
1000
if inv.root is None:
1001
raise AssertionError()
1002
return self._add_inventory_checked(revision_id, inv, parents)
1004
def _add_inventory_checked(self, revision_id, inv, parents):
1005
"""Add inv to the repository after checking the inputs.
1007
This function can be overridden to allow different inventory styles.
1009
:seealso: add_inventory, for the contract.
1011
inv_lines = self._serialise_inventory_to_lines(inv)
1012
return self._inventory_add_lines(revision_id, parents,
1013
inv_lines, check_content=False)
1015
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1016
parents, basis_inv=None, propagate_caches=False):
1017
"""Add a new inventory expressed as a delta against another revision.
1019
See the inventory developers documentation for the theory behind
1022
:param basis_revision_id: The inventory id the delta was created
1023
against. (This does not have to be a direct parent.)
1024
:param delta: The inventory delta (see Inventory.apply_delta for
1026
:param new_revision_id: The revision id that the inventory is being
1028
:param parents: The revision ids of the parents that revision_id is
1029
known to have and are in the repository already. These are supplied
1030
for repositories that depend on the inventory graph for revision
1031
graph access, as well as for those that pun ancestry with delta
1033
:param basis_inv: The basis inventory if it is already known,
1035
:param propagate_caches: If True, the caches for this inventory are
1036
copied to and updated for the result if possible.
1038
:returns: (validator, new_inv)
1039
The validator(which is a sha1 digest, though what is sha'd is
1040
repository format specific) of the serialized inventory, and the
1041
resulting inventory.
1043
if not self.is_in_write_group():
1044
raise AssertionError("%r not in write group" % (self,))
1045
_mod_revision.check_not_reserved_id(new_revision_id)
1046
basis_tree = self.revision_tree(basis_revision_id)
1047
basis_tree.lock_read()
1049
# Note that this mutates the inventory of basis_tree, which not all
1050
# inventory implementations may support: A better idiom would be to
1051
# return a new inventory, but as there is no revision tree cache in
1052
# repository this is safe for now - RBC 20081013
1053
if basis_inv is None:
1054
basis_inv = basis_tree.inventory
1055
basis_inv.apply_delta(delta)
1056
basis_inv.revision_id = new_revision_id
1057
return (self.add_inventory(new_revision_id, basis_inv, parents),
1062
def _inventory_add_lines(self, revision_id, parents, lines,
1063
check_content=True):
1064
"""Store lines in inv_vf and return the sha1 of the inventory."""
1065
parents = [(parent,) for parent in parents]
1066
return self.inventories.add_lines((revision_id,), parents, lines,
1067
check_content=check_content)[0]
1069
def add_revision(self, revision_id, rev, inv=None, config=None):
1070
"""Add rev to the revision store as revision_id.
1072
:param revision_id: the revision id to use.
1073
:param rev: The revision object.
1074
:param inv: The inventory for the revision. if None, it will be looked
1075
up in the inventory storer
1076
:param config: If None no digital signature will be created.
1077
If supplied its signature_needed method will be used
1078
to determine if a signature should be made.
1080
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
1082
_mod_revision.check_not_reserved_id(revision_id)
1083
if config is not None and config.signature_needed():
1085
inv = self.get_inventory(revision_id)
1086
plaintext = Testament(rev, inv).as_short_text()
1087
self.store_revision_signature(
1088
gpg.GPGStrategy(config), plaintext, revision_id)
1089
# check inventory present
1090
if not self.inventories.get_parent_map([(revision_id,)]):
1092
raise errors.WeaveRevisionNotPresent(revision_id,
1095
# yes, this is not suitable for adding with ghosts.
1096
rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1099
key = (revision_id,)
1100
rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1101
self._add_revision(rev)
1103
def _add_revision(self, revision):
1104
text = self._serializer.write_revision_to_string(revision)
1105
key = (revision.revision_id,)
1106
parents = tuple((parent,) for parent in revision.parent_ids)
1107
self.revisions.add_lines(key, parents, osutils.split_lines(text))
1109
def all_revision_ids(self):
1110
"""Returns a list of all the revision ids in the repository.
1112
This is conceptually deprecated because code should generally work on
1113
the graph reachable from a particular revision, and ignore any other
1114
revisions that might be present. There is no direct replacement
1117
if 'evil' in debug.debug_flags:
1118
mutter_callsite(2, "all_revision_ids is linear with history.")
1119
return self._all_revision_ids()
1121
def _all_revision_ids(self):
1122
"""Returns a list of all the revision ids in the repository.
1124
These are in as much topological order as the underlying store can
1127
raise NotImplementedError(self._all_revision_ids)
1129
def break_lock(self):
1130
"""Break a lock if one is present from another instance.
1132
Uses the ui factory to ask for confirmation if the lock may be from
1135
self.control_files.break_lock()
1138
def _eliminate_revisions_not_present(self, revision_ids):
1139
"""Check every revision id in revision_ids to see if we have it.
1141
Returns a set of the present revisions.
1144
graph = self.get_graph()
1145
parent_map = graph.get_parent_map(revision_ids)
1146
# The old API returned a list, should this actually be a set?
1147
return parent_map.keys()
1150
def create(a_bzrdir):
1151
"""Construct the current default format repository in a_bzrdir."""
1152
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
1154
def __init__(self, _format, a_bzrdir, control_files):
1155
"""instantiate a Repository.
1157
:param _format: The format of the repository on disk.
1158
:param a_bzrdir: The BzrDir of the repository.
1160
In the future we will have a single api for all stores for
1161
getting file texts, inventories and revisions, then
1162
this construct will accept instances of those things.
1164
super(Repository, self).__init__()
1165
self._format = _format
1166
# the following are part of the public API for Repository:
1167
self.bzrdir = a_bzrdir
1168
self.control_files = control_files
1169
self._transport = control_files._transport
1170
self.base = self._transport.base
1172
self._reconcile_does_inventory_gc = True
1173
self._reconcile_fixes_text_parents = False
1174
self._reconcile_backsup_inventory = True
1175
# not right yet - should be more semantically clear ?
1177
# TODO: make sure to construct the right store classes, etc, depending
1178
# on whether escaping is required.
1179
self._warn_if_deprecated()
1180
self._write_group = None
1181
# Additional places to query for data.
1182
self._fallback_repositories = []
1183
# An InventoryEntry cache, used during deserialization
1184
self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1187
if self._fallback_repositories:
1188
return '%s(%r, fallback_repositories=%r)' % (
1189
self.__class__.__name__,
1191
self._fallback_repositories)
1193
return '%s(%r)' % (self.__class__.__name__,
1196
def _has_same_fallbacks(self, other_repo):
1197
"""Returns true if the repositories have the same fallbacks."""
1198
my_fb = self._fallback_repositories
1199
other_fb = other_repo._fallback_repositories
1200
if len(my_fb) != len(other_fb):
1202
for f, g in zip(my_fb, other_fb):
1203
if not f.has_same_location(g):
1207
def has_same_location(self, other):
1208
"""Returns a boolean indicating if this repository is at the same
1209
location as another repository.
1211
This might return False even when two repository objects are accessing
1212
the same physical repository via different URLs.
1214
if self.__class__ is not other.__class__:
1216
return (self._transport.base == other._transport.base)
1218
def is_in_write_group(self):
1219
"""Return True if there is an open write group.
1221
:seealso: start_write_group.
1223
return self._write_group is not None
1225
def is_locked(self):
1226
return self.control_files.is_locked()
1228
def is_write_locked(self):
1229
"""Return True if this object is write locked."""
1230
return self.is_locked() and self.control_files._lock_mode == 'w'
1232
def lock_write(self, token=None):
1233
"""Lock this repository for writing.
1235
This causes caching within the repository obejct to start accumlating
1236
data during reads, and allows a 'write_group' to be obtained. Write
1237
groups must be used for actual data insertion.
1239
:param token: if this is already locked, then lock_write will fail
1240
unless the token matches the existing lock.
1241
:returns: a token if this instance supports tokens, otherwise None.
1242
:raises TokenLockingNotSupported: when a token is given but this
1243
instance doesn't support using token locks.
1244
:raises MismatchedToken: if the specified token doesn't match the token
1245
of the existing lock.
1246
:seealso: start_write_group.
1248
A token should be passed in if you know that you have locked the object
1249
some other way, and need to synchronise this object's state with that
1252
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1254
locked = self.is_locked()
1255
result = self.control_files.lock_write(token=token)
1257
for repo in self._fallback_repositories:
1258
# Writes don't affect fallback repos
1260
self._refresh_data()
1263
def lock_read(self):
1264
locked = self.is_locked()
1265
self.control_files.lock_read()
1267
for repo in self._fallback_repositories:
1269
self._refresh_data()
1271
def get_physical_lock_status(self):
1272
return self.control_files.get_physical_lock_status()
1274
def leave_lock_in_place(self):
1275
"""Tell this repository not to release the physical lock when this
1278
If lock_write doesn't return a token, then this method is not supported.
1280
self.control_files.leave_in_place()
1282
def dont_leave_lock_in_place(self):
1283
"""Tell this repository to release the physical lock when this
1284
object is unlocked, even if it didn't originally acquire it.
1286
If lock_write doesn't return a token, then this method is not supported.
1288
self.control_files.dont_leave_in_place()
1291
def gather_stats(self, revid=None, committers=None):
1292
"""Gather statistics from a revision id.
1294
:param revid: The revision id to gather statistics from, if None, then
1295
no revision specific statistics are gathered.
1296
:param committers: Optional parameter controlling whether to grab
1297
a count of committers from the revision specific statistics.
1298
:return: A dictionary of statistics. Currently this contains:
1299
committers: The number of committers if requested.
1300
firstrev: A tuple with timestamp, timezone for the penultimate left
1301
most ancestor of revid, if revid is not the NULL_REVISION.
1302
latestrev: A tuple with timestamp, timezone for revid, if revid is
1303
not the NULL_REVISION.
1304
revisions: The total revision count in the repository.
1305
size: An estimate disk size of the repository in bytes.
1308
if revid and committers:
1309
result['committers'] = 0
1310
if revid and revid != _mod_revision.NULL_REVISION:
1312
all_committers = set()
1313
revisions = self.get_ancestry(revid)
1314
# pop the leading None
1316
first_revision = None
1318
# ignore the revisions in the middle - just grab first and last
1319
revisions = revisions[0], revisions[-1]
1320
for revision in self.get_revisions(revisions):
1321
if not first_revision:
1322
first_revision = revision
1324
all_committers.add(revision.committer)
1325
last_revision = revision
1327
result['committers'] = len(all_committers)
1328
result['firstrev'] = (first_revision.timestamp,
1329
first_revision.timezone)
1330
result['latestrev'] = (last_revision.timestamp,
1331
last_revision.timezone)
1333
# now gather global repository information
1334
# XXX: This is available for many repos regardless of listability.
1335
if self.bzrdir.root_transport.listable():
1336
# XXX: do we want to __define len__() ?
1337
# Maybe the versionedfiles object should provide a different
1338
# method to get the number of keys.
1339
result['revisions'] = len(self.revisions.keys())
1340
# result['size'] = t
1343
def find_branches(self, using=False):
1344
"""Find branches underneath this repository.
1346
This will include branches inside other branches.
1348
:param using: If True, list only branches using this repository.
1350
if using and not self.is_shared():
1352
return [self.bzrdir.open_branch()]
1353
except errors.NotBranchError:
1355
class Evaluator(object):
1358
self.first_call = True
1360
def __call__(self, bzrdir):
1361
# On the first call, the parameter is always the bzrdir
1362
# containing the current repo.
1363
if not self.first_call:
1365
repository = bzrdir.open_repository()
1366
except errors.NoRepositoryPresent:
1369
return False, (None, repository)
1370
self.first_call = False
1372
value = (bzrdir.open_branch(), None)
1373
except errors.NotBranchError:
1374
value = (None, None)
1378
for branch, repository in bzrdir.BzrDir.find_bzrdirs(
1379
self.bzrdir.root_transport, evaluate=Evaluator()):
1380
if branch is not None:
1381
branches.append(branch)
1382
if not using and repository is not None:
1383
branches.extend(repository.find_branches())
1387
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1388
"""Return the revision ids that other has that this does not.
1390
These are returned in topological order.
1392
revision_id: only return revision ids included by revision_id.
1394
return InterRepository.get(other, self).search_missing_revision_ids(
1395
revision_id, find_ghosts)
1399
"""Open the repository rooted at base.
1401
For instance, if the repository is at URL/.bzr/repository,
1402
Repository.open(URL) -> a Repository instance.
1404
control = bzrdir.BzrDir.open(base)
1405
return control.open_repository()
1407
def copy_content_into(self, destination, revision_id=None):
1408
"""Make a complete copy of the content in self into destination.
1410
This is a destructive operation! Do not use it on existing
1413
return InterRepository.get(self, destination).copy_content(revision_id)
1415
def commit_write_group(self):
1416
"""Commit the contents accrued within the current write group.
1418
:seealso: start_write_group.
1420
if self._write_group is not self.get_transaction():
1421
# has an unlock or relock occured ?
1422
raise errors.BzrError('mismatched lock context %r and '
1424
(self.get_transaction(), self._write_group))
1425
result = self._commit_write_group()
1426
self._write_group = None
1429
def _commit_write_group(self):
1430
"""Template method for per-repository write group cleanup.
1432
This is called before the write group is considered to be
1433
finished and should ensure that all data handed to the repository
1434
for writing during the write group is safely committed (to the
1435
extent possible considering file system caching etc).
1438
def suspend_write_group(self):
1439
raise errors.UnsuspendableWriteGroup(self)
1441
def get_missing_parent_inventories(self, check_for_missing_texts=True):
1442
"""Return the keys of missing inventory parents for revisions added in
1445
A revision is not complete if the inventory delta for that revision
1446
cannot be calculated. Therefore if the parent inventories of a
1447
revision are not present, the revision is incomplete, and e.g. cannot
1448
be streamed by a smart server. This method finds missing inventory
1449
parents for revisions added in this write group.
1451
if not self._format.supports_external_lookups:
1452
# This is only an issue for stacked repositories
1454
if not self.is_in_write_group():
1455
raise AssertionError('not in a write group')
1457
# XXX: We assume that every added revision already has its
1458
# corresponding inventory, so we only check for parent inventories that
1459
# might be missing, rather than all inventories.
1460
parents = set(self.revisions._index.get_missing_parents())
1461
parents.discard(_mod_revision.NULL_REVISION)
1462
unstacked_inventories = self.inventories._index
1463
present_inventories = unstacked_inventories.get_parent_map(
1464
key[-1:] for key in parents)
1465
parents.difference_update(present_inventories)
1466
if len(parents) == 0:
1467
# No missing parent inventories.
1469
if not check_for_missing_texts:
1470
return set(('inventories', rev_id) for (rev_id,) in parents)
1471
# Ok, now we have a list of missing inventories. But these only matter
1472
# if the inventories that reference them are missing some texts they
1473
# appear to introduce.
1474
# XXX: Texts referenced by all added inventories need to be present,
1475
# but at the moment we're only checking for texts referenced by
1476
# inventories at the graph's edge.
1477
key_deps = self.revisions._index._key_dependencies
1478
key_deps.add_keys(present_inventories)
1479
referrers = frozenset(r[0] for r in key_deps.get_referrers())
1480
file_ids = self.fileids_altered_by_revision_ids(referrers)
1481
missing_texts = set()
1482
for file_id, version_ids in file_ids.iteritems():
1483
missing_texts.update(
1484
(file_id, version_id) for version_id in version_ids)
1485
present_texts = self.texts.get_parent_map(missing_texts)
1486
missing_texts.difference_update(present_texts)
1487
if not missing_texts:
1488
# No texts are missing, so all revisions and their deltas are
1491
# Alternatively the text versions could be returned as the missing
1492
# keys, but this is likely to be less data.
1493
missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1496
def refresh_data(self):
1497
"""Re-read any data needed to to synchronise with disk.
1499
This method is intended to be called after another repository instance
1500
(such as one used by a smart server) has inserted data into the
1501
repository. It may not be called during a write group, but may be
1502
called at any other time.
1504
if self.is_in_write_group():
1505
raise errors.InternalBzrError(
1506
"May not refresh_data while in a write group.")
1507
self._refresh_data()
1509
def resume_write_group(self, tokens):
1510
if not self.is_write_locked():
1511
raise errors.NotWriteLocked(self)
1512
if self._write_group:
1513
raise errors.BzrError('already in a write group')
1514
self._resume_write_group(tokens)
1515
# so we can detect unlock/relock - the write group is now entered.
1516
self._write_group = self.get_transaction()
1518
def _resume_write_group(self, tokens):
1519
raise errors.UnsuspendableWriteGroup(self)
1521
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1523
"""Fetch the content required to construct revision_id from source.
1525
If revision_id is None and fetch_spec is None, then all content is
1528
fetch() may not be used when the repository is in a write group -
1529
either finish the current write group before using fetch, or use
1530
fetch before starting the write group.
1532
:param find_ghosts: Find and copy revisions in the source that are
1533
ghosts in the target (and not reachable directly by walking out to
1534
the first-present revision in target from revision_id).
1535
:param revision_id: If specified, all the content needed for this
1536
revision ID will be copied to the target. Fetch will determine for
1537
itself which content needs to be copied.
1538
:param fetch_spec: If specified, a SearchResult or
1539
PendingAncestryResult that describes which revisions to copy. This
1540
allows copying multiple heads at once. Mutually exclusive with
1543
if fetch_spec is not None and revision_id is not None:
1544
raise AssertionError(
1545
"fetch_spec and revision_id are mutually exclusive.")
1546
if self.is_in_write_group():
1547
raise errors.InternalBzrError(
1548
"May not fetch while in a write group.")
1549
# fast path same-url fetch operations
1550
# TODO: lift out to somewhere common with RemoteRepository
1551
# <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1552
if (self.has_same_location(source)
1553
and fetch_spec is None
1554
and self._has_same_fallbacks(source)):
1555
# check that last_revision is in 'from' and then return a
1557
if (revision_id is not None and
1558
not _mod_revision.is_null(revision_id)):
1559
self.get_revision(revision_id)
1561
# if there is no specific appropriate InterRepository, this will get
1562
# the InterRepository base class, which raises an
1563
# IncompatibleRepositories when asked to fetch.
1564
inter = InterRepository.get(source, self)
1565
return inter.fetch(revision_id=revision_id, pb=pb,
1566
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1568
def create_bundle(self, target, base, fileobj, format=None):
1569
return serializer.write_bundle(self, target, base, fileobj, format)
1571
def get_commit_builder(self, branch, parents, config, timestamp=None,
1572
timezone=None, committer=None, revprops=None,
1574
"""Obtain a CommitBuilder for this repository.
1576
:param branch: Branch to commit to.
1577
:param parents: Revision ids of the parents of the new revision.
1578
:param config: Configuration to use.
1579
:param timestamp: Optional timestamp recorded for commit.
1580
:param timezone: Optional timezone for timestamp.
1581
:param committer: Optional committer to set for commit.
1582
:param revprops: Optional dictionary of revision properties.
1583
:param revision_id: Optional revision id.
1585
result = self._commit_builder_class(self, parents, config,
1586
timestamp, timezone, committer, revprops, revision_id)
1587
self.start_write_group()
1591
if (self.control_files._lock_count == 1 and
1592
self.control_files._lock_mode == 'w'):
1593
if self._write_group is not None:
1594
self.abort_write_group()
1595
self.control_files.unlock()
1596
raise errors.BzrError(
1597
'Must end write groups before releasing write locks.')
1598
self.control_files.unlock()
1599
if self.control_files._lock_count == 0:
1600
self._inventory_entry_cache.clear()
1601
for repo in self._fallback_repositories:
1605
def clone(self, a_bzrdir, revision_id=None):
1606
"""Clone this repository into a_bzrdir using the current format.
1608
Currently no check is made that the format of this repository and
1609
the bzrdir format are compatible. FIXME RBC 20060201.
1611
:return: The newly created destination repository.
1613
# TODO: deprecate after 0.16; cloning this with all its settings is
1614
# probably not very useful -- mbp 20070423
1615
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
1616
self.copy_content_into(dest_repo, revision_id)
1619
def start_write_group(self):
1620
"""Start a write group in the repository.
1622
Write groups are used by repositories which do not have a 1:1 mapping
1623
between file ids and backend store to manage the insertion of data from
1624
both fetch and commit operations.
1626
A write lock is required around the start_write_group/commit_write_group
1627
for the support of lock-requiring repository formats.
1629
One can only insert data into a repository inside a write group.
1633
if not self.is_write_locked():
1634
raise errors.NotWriteLocked(self)
1635
if self._write_group:
1636
raise errors.BzrError('already in a write group')
1637
self._start_write_group()
1638
# so we can detect unlock/relock - the write group is now entered.
1639
self._write_group = self.get_transaction()
1641
def _start_write_group(self):
1642
"""Template method for per-repository write group startup.
1644
This is called before the write group is considered to be
1649
def sprout(self, to_bzrdir, revision_id=None):
1650
"""Create a descendent repository for new development.
1652
Unlike clone, this does not copy the settings of the repository.
1654
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1655
dest_repo.fetch(self, revision_id=revision_id)
1658
def _create_sprouting_repo(self, a_bzrdir, shared):
1659
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1660
# use target default format.
1661
dest_repo = a_bzrdir.create_repository()
1663
# Most control formats need the repository to be specifically
1664
# created, but on some old all-in-one formats it's not needed
1666
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1667
except errors.UninitializableFormat:
1668
dest_repo = a_bzrdir.open_repository()
1671
def _get_sink(self):
1672
"""Return a sink for streaming into this repository."""
1673
return StreamSink(self)
1675
def _get_source(self, to_format):
1676
"""Return a source for streaming from this repository."""
1677
return StreamSource(self, to_format)
1680
def has_revision(self, revision_id):
1681
"""True if this repository has a copy of the revision."""
1682
return revision_id in self.has_revisions((revision_id,))
1685
def has_revisions(self, revision_ids):
1686
"""Probe to find out the presence of multiple revisions.
1688
:param revision_ids: An iterable of revision_ids.
1689
:return: A set of the revision_ids that were present.
1691
parent_map = self.revisions.get_parent_map(
1692
[(rev_id,) for rev_id in revision_ids])
1694
if _mod_revision.NULL_REVISION in revision_ids:
1695
result.add(_mod_revision.NULL_REVISION)
1696
result.update([key[0] for key in parent_map])
1700
def get_revision(self, revision_id):
1701
"""Return the Revision object for a named revision."""
1702
return self.get_revisions([revision_id])[0]
1705
def get_revision_reconcile(self, revision_id):
1706
"""'reconcile' helper routine that allows access to a revision always.
1708
This variant of get_revision does not cross check the weave graph
1709
against the revision one as get_revision does: but it should only
1710
be used by reconcile, or reconcile-alike commands that are correcting
1711
or testing the revision graph.
1713
return self._get_revisions([revision_id])[0]
1716
def get_revisions(self, revision_ids):
1717
"""Get many revisions at once."""
1718
return self._get_revisions(revision_ids)
1721
def _get_revisions(self, revision_ids):
1722
"""Core work logic to get many revisions without sanity checks."""
1723
for rev_id in revision_ids:
1724
if not rev_id or not isinstance(rev_id, basestring):
1725
raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1726
keys = [(key,) for key in revision_ids]
1727
stream = self.revisions.get_record_stream(keys, 'unordered', True)
1729
for record in stream:
1730
if record.storage_kind == 'absent':
1731
raise errors.NoSuchRevision(self, record.key[0])
1732
text = record.get_bytes_as('fulltext')
1733
rev = self._serializer.read_revision_from_string(text)
1734
revs[record.key[0]] = rev
1735
return [revs[revid] for revid in revision_ids]
1738
def get_revision_xml(self, revision_id):
1739
# TODO: jam 20070210 This shouldn't be necessary since get_revision
1740
# would have already do it.
1741
# TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1742
# TODO: this can't just be replaced by:
1743
# return self._serializer.write_revision_to_string(
1744
# self.get_revision(revision_id))
1745
# as cStringIO preservers the encoding unlike write_revision_to_string
1746
# or some other call down the path.
1747
rev = self.get_revision(revision_id)
1748
rev_tmp = cStringIO.StringIO()
1749
# the current serializer..
1750
self._serializer.write_revision(rev, rev_tmp)
1752
return rev_tmp.getvalue()
1754
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1755
"""Produce a generator of revision deltas.
1757
Note that the input is a sequence of REVISIONS, not revision_ids.
1758
Trees will be held in memory until the generator exits.
1759
Each delta is relative to the revision's lefthand predecessor.
1761
:param specific_fileids: if not None, the result is filtered
1762
so that only those file-ids, their parents and their
1763
children are included.
1765
# Get the revision-ids of interest
1766
required_trees = set()
1767
for revision in revisions:
1768
required_trees.add(revision.revision_id)
1769
required_trees.update(revision.parent_ids[:1])
1771
# Get the matching filtered trees. Note that it's more
1772
# efficient to pass filtered trees to changes_from() rather
1773
# than doing the filtering afterwards. changes_from() could
1774
# arguably do the filtering itself but it's path-based, not
1775
# file-id based, so filtering before or afterwards is
1777
if specific_fileids is None:
1778
trees = dict((t.get_revision_id(), t) for
1779
t in self.revision_trees(required_trees))
1781
trees = dict((t.get_revision_id(), t) for
1782
t in self._filtered_revision_trees(required_trees,
1785
# Calculate the deltas
1786
for revision in revisions:
1787
if not revision.parent_ids:
1788
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1790
old_tree = trees[revision.parent_ids[0]]
1791
yield trees[revision.revision_id].changes_from(old_tree)
1794
def get_revision_delta(self, revision_id, specific_fileids=None):
1795
"""Return the delta for one revision.
1797
The delta is relative to the left-hand predecessor of the
1800
:param specific_fileids: if not None, the result is filtered
1801
so that only those file-ids, their parents and their
1802
children are included.
1804
r = self.get_revision(revision_id)
1805
return list(self.get_deltas_for_revisions([r],
1806
specific_fileids=specific_fileids))[0]
1809
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1810
signature = gpg_strategy.sign(plaintext)
1811
self.add_signature_text(revision_id, signature)
1814
def add_signature_text(self, revision_id, signature):
1815
self.signatures.add_lines((revision_id,), (),
1816
osutils.split_lines(signature))
1818
def find_text_key_references(self):
1819
"""Find the text key references within the repository.
1821
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1822
to whether they were referred to by the inventory of the
1823
revision_id that they contain. The inventory texts from all present
1824
revision ids are assessed to generate this report.
1826
revision_keys = self.revisions.keys()
1827
w = self.inventories
1828
pb = ui.ui_factory.nested_progress_bar()
1830
return self._find_text_key_references_from_xml_inventory_lines(
1831
w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
1835
def _find_text_key_references_from_xml_inventory_lines(self,
1837
"""Core routine for extracting references to texts from inventories.
1839
This performs the translation of xml lines to revision ids.
1841
:param line_iterator: An iterator of lines, origin_version_id
1842
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1843
to whether they were referred to by the inventory of the
1844
revision_id that they contain. Note that if that revision_id was
1845
not part of the line_iterator's output then False will be given -
1846
even though it may actually refer to that key.
1848
if not self._serializer.support_altered_by_hack:
1849
raise AssertionError(
1850
"_find_text_key_references_from_xml_inventory_lines only "
1851
"supported for branches which store inventory as unnested xml"
1852
", not on %r" % self)
1855
# this code needs to read every new line in every inventory for the
1856
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
1857
# not present in one of those inventories is unnecessary but not
1858
# harmful because we are filtering by the revision id marker in the
1859
# inventory lines : we only select file ids altered in one of those
1860
# revisions. We don't need to see all lines in the inventory because
1861
# only those added in an inventory in rev X can contain a revision=X
1863
unescape_revid_cache = {}
1864
unescape_fileid_cache = {}
1866
# jam 20061218 In a big fetch, this handles hundreds of thousands
1867
# of lines, so it has had a lot of inlining and optimizing done.
1868
# Sorry that it is a little bit messy.
1869
# Move several functions to be local variables, since this is a long
1871
search = self._file_ids_altered_regex.search
1872
unescape = _unescape_xml
1873
setdefault = result.setdefault
1874
for line, line_key in line_iterator:
1875
match = search(line)
1878
# One call to match.group() returning multiple items is quite a
1879
# bit faster than 2 calls to match.group() each returning 1
1880
file_id, revision_id = match.group('file_id', 'revision_id')
1882
# Inlining the cache lookups helps a lot when you make 170,000
1883
# lines and 350k ids, versus 8.4 unique ids.
1884
# Using a cache helps in 2 ways:
1885
# 1) Avoids unnecessary decoding calls
1886
# 2) Re-uses cached strings, which helps in future set and
1888
# (2) is enough that removing encoding entirely along with
1889
# the cache (so we are using plain strings) results in no
1890
# performance improvement.
1892
revision_id = unescape_revid_cache[revision_id]
1894
unescaped = unescape(revision_id)
1895
unescape_revid_cache[revision_id] = unescaped
1896
revision_id = unescaped
1898
# Note that unconditionally unescaping means that we deserialise
1899
# every fileid, which for general 'pull' is not great, but we don't
1900
# really want to have some many fulltexts that this matters anyway.
1903
file_id = unescape_fileid_cache[file_id]
1905
unescaped = unescape(file_id)
1906
unescape_fileid_cache[file_id] = unescaped
1909
key = (file_id, revision_id)
1910
setdefault(key, False)
1911
if revision_id == line_key[-1]:
1915
def _inventory_xml_lines_for_keys(self, keys):
1916
"""Get a line iterator of the sort needed for findind references.
1918
Not relevant for non-xml inventory repositories.
1920
Ghosts in revision_keys are ignored.
1922
:param revision_keys: The revision keys for the inventories to inspect.
1923
:return: An iterator over (inventory line, revid) for the fulltexts of
1924
all of the xml inventories specified by revision_keys.
1926
stream = self.inventories.get_record_stream(keys, 'unordered', True)
1927
for record in stream:
1928
if record.storage_kind != 'absent':
1929
chunks = record.get_bytes_as('chunked')
1930
revid = record.key[-1]
1931
lines = osutils.chunks_to_lines(chunks)
1935
def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1937
"""Helper routine for fileids_altered_by_revision_ids.
1939
This performs the translation of xml lines to revision ids.
1941
:param line_iterator: An iterator of lines, origin_version_id
1942
:param revision_keys: The revision ids to filter for. This should be a
1943
set or other type which supports efficient __contains__ lookups, as
1944
the revision key from each parsed line will be looked up in the
1945
revision_keys filter.
1946
:return: a dictionary mapping altered file-ids to an iterable of
1947
revision_ids. Each altered file-ids has the exact revision_ids that
1948
altered it listed explicitly.
1950
seen = set(self._find_text_key_references_from_xml_inventory_lines(
1951
line_iterator).iterkeys())
1952
parent_keys = self._find_parent_keys_of_revisions(revision_keys)
1953
parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
1954
self._inventory_xml_lines_for_keys(parent_keys)))
1955
new_keys = seen - parent_seen
1957
setdefault = result.setdefault
1958
for key in new_keys:
1959
setdefault(key[0], set()).add(key[-1])
1962
def _find_parent_ids_of_revisions(self, revision_ids):
1963
"""Find all parent ids that are mentioned in the revision graph.
1965
:return: set of revisions that are parents of revision_ids which are
1966
not part of revision_ids themselves
1968
parent_map = self.get_parent_map(revision_ids)
1970
map(parent_ids.update, parent_map.itervalues())
1971
parent_ids.difference_update(revision_ids)
1972
parent_ids.discard(_mod_revision.NULL_REVISION)
1975
def _find_parent_keys_of_revisions(self, revision_keys):
1976
"""Similar to _find_parent_ids_of_revisions, but used with keys.
1978
:param revision_keys: An iterable of revision_keys.
1979
:return: The parents of all revision_keys that are not already in
1982
parent_map = self.revisions.get_parent_map(revision_keys)
1984
map(parent_keys.update, parent_map.itervalues())
1985
parent_keys.difference_update(revision_keys)
1986
parent_keys.discard(_mod_revision.NULL_REVISION)
1989
def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1990
"""Find the file ids and versions affected by revisions.
1992
:param revisions: an iterable containing revision ids.
1993
:param _inv_weave: The inventory weave from this repository or None.
1994
If None, the inventory weave will be opened automatically.
1995
:return: a dictionary mapping altered file-ids to an iterable of
1996
revision_ids. Each altered file-ids has the exact revision_ids that
1997
altered it listed explicitly.
1999
selected_keys = set((revid,) for revid in revision_ids)
2000
w = _inv_weave or self.inventories
2001
pb = ui.ui_factory.nested_progress_bar()
2003
return self._find_file_ids_from_xml_inventory_lines(
2004
w.iter_lines_added_or_present_in_keys(
2005
selected_keys, pb=pb),
2010
def iter_files_bytes(self, desired_files):
2011
"""Iterate through file versions.
2013
Files will not necessarily be returned in the order they occur in
2014
desired_files. No specific order is guaranteed.
2016
Yields pairs of identifier, bytes_iterator. identifier is an opaque
2017
value supplied by the caller as part of desired_files. It should
2018
uniquely identify the file version in the caller's context. (Examples:
2019
an index number or a TreeTransform trans_id.)
2021
bytes_iterator is an iterable of bytestrings for the file. The
2022
kind of iterable and length of the bytestrings are unspecified, but for
2023
this implementation, it is a list of bytes produced by
2024
VersionedFile.get_record_stream().
2026
:param desired_files: a list of (file_id, revision_id, identifier)
2030
for file_id, revision_id, callable_data in desired_files:
2031
text_keys[(file_id, revision_id)] = callable_data
2032
for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2033
if record.storage_kind == 'absent':
2034
raise errors.RevisionNotPresent(record.key, self)
2035
yield text_keys[record.key], record.get_bytes_as('chunked')
2037
def _generate_text_key_index(self, text_key_references=None,
2039
"""Generate a new text key index for the repository.
2041
This is an expensive function that will take considerable time to run.
2043
:return: A dict mapping text keys ((file_id, revision_id) tuples) to a
2044
list of parents, also text keys. When a given key has no parents,
2045
the parents list will be [NULL_REVISION].
2047
# All revisions, to find inventory parents.
2048
if ancestors is None:
2049
graph = self.get_graph()
2050
ancestors = graph.get_parent_map(self.all_revision_ids())
2051
if text_key_references is None:
2052
text_key_references = self.find_text_key_references()
2053
pb = ui.ui_factory.nested_progress_bar()
2055
return self._do_generate_text_key_index(ancestors,
2056
text_key_references, pb)
2060
def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
2061
"""Helper for _generate_text_key_index to avoid deep nesting."""
2062
revision_order = tsort.topo_sort(ancestors)
2063
invalid_keys = set()
2065
for revision_id in revision_order:
2066
revision_keys[revision_id] = set()
2067
text_count = len(text_key_references)
2068
# a cache of the text keys to allow reuse; costs a dict of all the
2069
# keys, but saves a 2-tuple for every child of a given key.
2071
for text_key, valid in text_key_references.iteritems():
2073
invalid_keys.add(text_key)
2075
revision_keys[text_key[1]].add(text_key)
2076
text_key_cache[text_key] = text_key
2077
del text_key_references
2079
text_graph = graph.Graph(graph.DictParentsProvider(text_index))
2080
NULL_REVISION = _mod_revision.NULL_REVISION
2081
# Set a cache with a size of 10 - this suffices for bzr.dev but may be
2082
# too small for large or very branchy trees. However, for 55K path
2083
# trees, it would be easy to use too much memory trivially. Ideally we
2084
# could gauge this by looking at available real memory etc, but this is
2085
# always a tricky proposition.
2086
inventory_cache = lru_cache.LRUCache(10)
2087
batch_size = 10 # should be ~150MB on a 55K path tree
2088
batch_count = len(revision_order) / batch_size + 1
2090
pb.update("Calculating text parents", processed_texts, text_count)
2091
for offset in xrange(batch_count):
2092
to_query = revision_order[offset * batch_size:(offset + 1) *
2096
for rev_tree in self.revision_trees(to_query):
2097
revision_id = rev_tree.get_revision_id()
2098
parent_ids = ancestors[revision_id]
2099
for text_key in revision_keys[revision_id]:
2100
pb.update("Calculating text parents", processed_texts)
2101
processed_texts += 1
2102
candidate_parents = []
2103
for parent_id in parent_ids:
2104
parent_text_key = (text_key[0], parent_id)
2106
check_parent = parent_text_key not in \
2107
revision_keys[parent_id]
2109
# the parent parent_id is a ghost:
2110
check_parent = False
2111
# truncate the derived graph against this ghost.
2112
parent_text_key = None
2114
# look at the parent commit details inventories to
2115
# determine possible candidates in the per file graph.
2118
inv = inventory_cache[parent_id]
2120
inv = self.revision_tree(parent_id).inventory
2121
inventory_cache[parent_id] = inv
2123
parent_entry = inv[text_key[0]]
2124
except (KeyError, errors.NoSuchId):
2126
if parent_entry is not None:
2128
text_key[0], parent_entry.revision)
2130
parent_text_key = None
2131
if parent_text_key is not None:
2132
candidate_parents.append(
2133
text_key_cache[parent_text_key])
2134
parent_heads = text_graph.heads(candidate_parents)
2135
new_parents = list(parent_heads)
2136
new_parents.sort(key=lambda x:candidate_parents.index(x))
2137
if new_parents == []:
2138
new_parents = [NULL_REVISION]
2139
text_index[text_key] = new_parents
2141
for text_key in invalid_keys:
2142
text_index[text_key] = [NULL_REVISION]
2145
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2146
"""Get an iterable listing the keys of all the data introduced by a set
2149
The keys will be ordered so that the corresponding items can be safely
2150
fetched and inserted in that order.
2152
:returns: An iterable producing tuples of (knit-kind, file-id,
2153
versions). knit-kind is one of 'file', 'inventory', 'signatures',
2154
'revisions'. file-id is None unless knit-kind is 'file'.
2156
for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2159
for result in self._find_non_file_keys_to_fetch(revision_ids):
2162
def _find_file_keys_to_fetch(self, revision_ids, pb):
2163
# XXX: it's a bit weird to control the inventory weave caching in this
2164
# generator. Ideally the caching would be done in fetch.py I think. Or
2165
# maybe this generator should explicitly have the contract that it
2166
# should not be iterated until the previously yielded item has been
2168
inv_w = self.inventories
2170
# file ids that changed
2171
file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2173
num_file_ids = len(file_ids)
2174
for file_id, altered_versions in file_ids.iteritems():
2176
pb.update("fetch texts", count, num_file_ids)
2178
yield ("file", file_id, altered_versions)
2180
def _find_non_file_keys_to_fetch(self, revision_ids):
2182
yield ("inventory", None, revision_ids)
2185
# XXX: Note ATM no callers actually pay attention to this return
2186
# instead they just use the list of revision ids and ignore
2187
# missing sigs. Consider removing this work entirely
2188
revisions_with_signatures = set(self.signatures.get_parent_map(
2189
[(r,) for r in revision_ids]))
2190
revisions_with_signatures = set(
2191
[r for (r,) in revisions_with_signatures])
2192
revisions_with_signatures.intersection_update(revision_ids)
2193
yield ("signatures", None, revisions_with_signatures)
2196
yield ("revisions", None, revision_ids)
2199
def get_inventory(self, revision_id):
2200
"""Get Inventory object by revision id."""
2201
return self.iter_inventories([revision_id]).next()
2203
def iter_inventories(self, revision_ids):
2204
"""Get many inventories by revision_ids.
2206
This will buffer some or all of the texts used in constructing the
2207
inventories in memory, but will only parse a single inventory at a
2210
:param revision_ids: The expected revision ids of the inventories.
2211
:return: An iterator of inventories.
2213
if ((None in revision_ids)
2214
or (_mod_revision.NULL_REVISION in revision_ids)):
2215
raise ValueError('cannot get null revision inventory')
2216
return self._iter_inventories(revision_ids)
2218
def _iter_inventories(self, revision_ids):
2219
"""single-document based inventory iteration."""
2220
for text, revision_id in self._iter_inventory_xmls(revision_ids):
2221
yield self.deserialise_inventory(revision_id, text)
2223
def _iter_inventory_xmls(self, revision_ids):
2224
keys = [(revision_id,) for revision_id in revision_ids]
2225
stream = self.inventories.get_record_stream(keys, 'unordered', True)
2227
for record in stream:
2228
if record.storage_kind != 'absent':
2229
text_chunks[record.key] = record.get_bytes_as('chunked')
2231
raise errors.NoSuchRevision(self, record.key)
2233
chunks = text_chunks.pop(key)
2234
yield ''.join(chunks), key[-1]
2236
def deserialise_inventory(self, revision_id, xml):
2237
"""Transform the xml into an inventory object.
2239
:param revision_id: The expected revision id of the inventory.
2240
:param xml: A serialised inventory.
2242
result = self._serializer.read_inventory_from_string(xml, revision_id,
2243
entry_cache=self._inventory_entry_cache)
2244
if result.revision_id != revision_id:
2245
raise AssertionError('revision id mismatch %s != %s' % (
2246
result.revision_id, revision_id))
2249
def serialise_inventory(self, inv):
2250
return self._serializer.write_inventory_to_string(inv)
2252
def _serialise_inventory_to_lines(self, inv):
2253
return self._serializer.write_inventory_to_lines(inv)
2255
def get_serializer_format(self):
2256
return self._serializer.format_num
2259
def get_inventory_xml(self, revision_id):
2260
"""Get inventory XML as a file object."""
2261
texts = self._iter_inventory_xmls([revision_id])
2263
text, revision_id = texts.next()
2264
except StopIteration:
2265
raise errors.HistoryMissing(self, 'inventory', revision_id)
2269
def get_inventory_sha1(self, revision_id):
2270
"""Return the sha1 hash of the inventory entry
2272
return self.get_revision(revision_id).inventory_sha1
2274
def get_rev_id_for_revno(self, revno, known_pair):
2275
"""Return the revision id of a revno, given a later (revno, revid)
2276
pair in the same history.
2278
:return: if found (True, revid). If the available history ran out
2279
before reaching the revno, then this returns
2280
(False, (closest_revno, closest_revid)).
2282
known_revno, known_revid = known_pair
2283
partial_history = [known_revid]
2284
distance_from_known = known_revno - revno
2285
if distance_from_known < 0:
2287
'requested revno (%d) is later than given known revno (%d)'
2288
% (revno, known_revno))
2291
self, partial_history, stop_index=distance_from_known)
2292
except errors.RevisionNotPresent, err:
2293
if err.revision_id == known_revid:
2294
# The start revision (known_revid) wasn't found.
2296
# This is a stacked repository with no fallbacks, or a there's a
2297
# left-hand ghost. Either way, even though the revision named in
2298
# the error isn't in this repo, we know it's the next step in this
2299
# left-hand history.
2300
partial_history.append(err.revision_id)
2301
if len(partial_history) <= distance_from_known:
2302
# Didn't find enough history to get a revid for the revno.
2303
earliest_revno = known_revno - len(partial_history) + 1
2304
return (False, (earliest_revno, partial_history[-1]))
2305
if len(partial_history) - 1 > distance_from_known:
2306
raise AssertionError('_iter_for_revno returned too much history')
2307
return (True, partial_history[-1])
2309
def iter_reverse_revision_history(self, revision_id):
2310
"""Iterate backwards through revision ids in the lefthand history
2312
:param revision_id: The revision id to start with. All its lefthand
2313
ancestors will be traversed.
2315
graph = self.get_graph()
2316
next_id = revision_id
2318
if next_id in (None, _mod_revision.NULL_REVISION):
2321
parents = graph.get_parent_map([next_id])[next_id]
2323
raise errors.RevisionNotPresent(next_id, self)
2325
if len(parents) == 0:
2328
next_id = parents[0]
2331
def get_revision_inventory(self, revision_id):
2332
"""Return inventory of a past revision."""
2333
# TODO: Unify this with get_inventory()
2334
# bzr 0.0.6 and later imposes the constraint that the inventory_id
2335
# must be the same as its revision, so this is trivial.
2336
if revision_id is None:
2337
# This does not make sense: if there is no revision,
2338
# then it is the current tree inventory surely ?!
2339
# and thus get_root_id() is something that looks at the last
2340
# commit on the branch, and the get_root_id is an inventory check.
2341
raise NotImplementedError
2342
# return Inventory(self.get_root_id())
2344
return self.get_inventory(revision_id)
2346
def is_shared(self):
2347
"""Return True if this repository is flagged as a shared repository."""
2348
raise NotImplementedError(self.is_shared)
2351
def reconcile(self, other=None, thorough=False):
2352
"""Reconcile this repository."""
2353
from bzrlib.reconcile import RepoReconciler
2354
reconciler = RepoReconciler(self, thorough=thorough)
2355
reconciler.reconcile()
2358
def _refresh_data(self):
2359
"""Helper called from lock_* to ensure coherency with disk.
2361
The default implementation does nothing; it is however possible
2362
for repositories to maintain loaded indices across multiple locks
2363
by checking inside their implementation of this method to see
2364
whether their indices are still valid. This depends of course on
2365
the disk format being validatable in this manner. This method is
2366
also called by the refresh_data() public interface to cause a refresh
2367
to occur while in a write lock so that data inserted by a smart server
2368
push operation is visible on the client's instance of the physical
2373
def revision_tree(self, revision_id):
2374
"""Return Tree for a revision on this branch.
2376
`revision_id` may be NULL_REVISION for the empty tree revision.
2378
revision_id = _mod_revision.ensure_null(revision_id)
2379
# TODO: refactor this to use an existing revision object
2380
# so we don't need to read it in twice.
2381
if revision_id == _mod_revision.NULL_REVISION:
2382
return RevisionTree(self, Inventory(root_id=None),
2383
_mod_revision.NULL_REVISION)
2385
inv = self.get_revision_inventory(revision_id)
2386
return RevisionTree(self, inv, revision_id)
2388
def revision_trees(self, revision_ids):
2389
"""Return Trees for revisions in this repository.
2391
:param revision_ids: a sequence of revision-ids;
2392
a revision-id may not be None or 'null:'
2394
inventories = self.iter_inventories(revision_ids)
2395
for inv in inventories:
2396
yield RevisionTree(self, inv, inv.revision_id)
2398
def _filtered_revision_trees(self, revision_ids, file_ids):
2399
"""Return Tree for a revision on this branch with only some files.
2401
:param revision_ids: a sequence of revision-ids;
2402
a revision-id may not be None or 'null:'
2403
:param file_ids: if not None, the result is filtered
2404
so that only those file-ids, their parents and their
2405
children are included.
2407
inventories = self.iter_inventories(revision_ids)
2408
for inv in inventories:
2409
# Should we introduce a FilteredRevisionTree class rather
2410
# than pre-filter the inventory here?
2411
filtered_inv = inv.filter(file_ids)
2412
yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2415
def get_ancestry(self, revision_id, topo_sorted=True):
2416
"""Return a list of revision-ids integrated by a revision.
2418
The first element of the list is always None, indicating the origin
2419
revision. This might change when we have history horizons, or
2420
perhaps we should have a new API.
2422
This is topologically sorted.
2424
if _mod_revision.is_null(revision_id):
2426
if not self.has_revision(revision_id):
2427
raise errors.NoSuchRevision(self, revision_id)
2428
graph = self.get_graph()
2430
search = graph._make_breadth_first_searcher([revision_id])
2433
found, ghosts = search.next_with_ghosts()
2434
except StopIteration:
2437
if _mod_revision.NULL_REVISION in keys:
2438
keys.remove(_mod_revision.NULL_REVISION)
2440
parent_map = graph.get_parent_map(keys)
2441
keys = tsort.topo_sort(parent_map)
2442
return [None] + list(keys)
2444
def pack(self, hint=None):
2445
"""Compress the data within the repository.
2447
This operation only makes sense for some repository types. For other
2448
types it should be a no-op that just returns.
2450
This stub method does not require a lock, but subclasses should use
2451
@needs_write_lock as this is a long running call its reasonable to
2452
implicitly lock for the user.
2454
:param hint: If not supplied, the whole repository is packed.
2455
If supplied, the repository may use the hint parameter as a
2456
hint for the parts of the repository to pack. A hint can be
2457
obtained from the result of commit_write_group(). Out of
2458
date hints are simply ignored, because concurrent operations
2459
can obsolete them rapidly.
2462
def get_transaction(self):
2463
return self.control_files.get_transaction()
2465
def get_parent_map(self, revision_ids):
2466
"""See graph.StackedParentsProvider.get_parent_map"""
2467
# revisions index works in keys; this just works in revisions
2468
# therefore wrap and unwrap
2471
for revision_id in revision_ids:
2472
if revision_id == _mod_revision.NULL_REVISION:
2473
result[revision_id] = ()
2474
elif revision_id is None:
2475
raise ValueError('get_parent_map(None) is not valid')
2477
query_keys.append((revision_id ,))
2478
for ((revision_id,), parent_keys) in \
2479
self.revisions.get_parent_map(query_keys).iteritems():
2481
result[revision_id] = tuple(parent_revid
2482
for (parent_revid,) in parent_keys)
2484
result[revision_id] = (_mod_revision.NULL_REVISION,)
2487
def _make_parents_provider(self):
2490
def get_graph(self, other_repository=None):
2491
"""Return the graph walker for this repository format"""
2492
parents_provider = self._make_parents_provider()
2493
if (other_repository is not None and
2494
not self.has_same_location(other_repository)):
2495
parents_provider = graph.StackedParentsProvider(
2496
[parents_provider, other_repository._make_parents_provider()])
2497
return graph.Graph(parents_provider)
2499
def _get_versioned_file_checker(self, text_key_references=None):
2500
"""Return an object suitable for checking versioned files.
2502
:param text_key_references: if non-None, an already built
2503
dictionary mapping text keys ((fileid, revision_id) tuples)
2504
to whether they were referred to by the inventory of the
2505
revision_id that they contain. If None, this will be
2508
return _VersionedFileChecker(self,
2509
text_key_references=text_key_references)
2511
def revision_ids_to_search_result(self, result_set):
2512
"""Convert a set of revision ids to a graph SearchResult."""
2513
result_parents = set()
2514
for parents in self.get_graph().get_parent_map(
2515
result_set).itervalues():
2516
result_parents.update(parents)
2517
included_keys = result_set.intersection(result_parents)
2518
start_keys = result_set.difference(included_keys)
2519
exclude_keys = result_parents.difference(result_set)
2520
result = graph.SearchResult(start_keys, exclude_keys,
2521
len(result_set), result_set)
2525
def set_make_working_trees(self, new_value):
2526
"""Set the policy flag for making working trees when creating branches.
2528
This only applies to branches that use this repository.
2530
The default is 'True'.
2531
:param new_value: True to restore the default, False to disable making
2534
raise NotImplementedError(self.set_make_working_trees)
2536
def make_working_trees(self):
2537
"""Returns the policy for making working trees on new branches."""
2538
raise NotImplementedError(self.make_working_trees)
2541
def sign_revision(self, revision_id, gpg_strategy):
2542
plaintext = Testament.from_revision(self, revision_id).as_short_text()
2543
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
2546
def has_signature_for_revision_id(self, revision_id):
2547
"""Query for a revision signature for revision_id in the repository."""
2548
if not self.has_revision(revision_id):
2549
raise errors.NoSuchRevision(self, revision_id)
2550
sig_present = (1 == len(
2551
self.signatures.get_parent_map([(revision_id,)])))
2555
def get_signature_text(self, revision_id):
2556
"""Return the text for a signature."""
2557
stream = self.signatures.get_record_stream([(revision_id,)],
2559
record = stream.next()
2560
if record.storage_kind == 'absent':
2561
raise errors.NoSuchRevision(self, revision_id)
2562
return record.get_bytes_as('fulltext')
2565
def check(self, revision_ids=None):
2566
"""Check consistency of all history of given revision_ids.
2568
Different repository implementations should override _check().
2570
:param revision_ids: A non-empty list of revision_ids whose ancestry
2571
will be checked. Typically the last revision_id of a branch.
2573
return self._check(revision_ids)
2575
def _check(self, revision_ids):
2576
result = check.Check(self)
2580
def _warn_if_deprecated(self):
2581
global _deprecation_warning_done
2582
if _deprecation_warning_done:
2584
_deprecation_warning_done = True
2585
warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
2586
% (self._format, self.bzrdir.transport.base))
2588
def supports_rich_root(self):
2589
return self._format.rich_root_data
2591
def _check_ascii_revisionid(self, revision_id, method):
2592
"""Private helper for ascii-only repositories."""
2593
# weave repositories refuse to store revisionids that are non-ascii.
2594
if revision_id is not None:
2595
# weaves require ascii revision ids.
2596
if isinstance(revision_id, unicode):
2598
revision_id.encode('ascii')
2599
except UnicodeEncodeError:
2600
raise errors.NonAsciiRevisionId(method, self)
2603
revision_id.decode('ascii')
2604
except UnicodeDecodeError:
2605
raise errors.NonAsciiRevisionId(method, self)
2607
def revision_graph_can_have_wrong_parents(self):
2608
"""Is it possible for this repository to have a revision graph with
2611
If True, then this repository must also implement
2612
_find_inconsistent_revision_parents so that check and reconcile can
2613
check for inconsistencies before proceeding with other checks that may
2614
depend on the revision index being consistent.
2616
raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2619
# remove these delegates a while after bzr 0.15
2620
def __make_delegated(name, from_module):
2621
def _deprecated_repository_forwarder():
2622
symbol_versioning.warn('%s moved to %s in bzr 0.15'
2623
% (name, from_module),
2626
m = __import__(from_module, globals(), locals(), [name])
2628
return getattr(m, name)
2629
except AttributeError:
2630
raise AttributeError('module %s has no name %s'
2632
globals()[name] = _deprecated_repository_forwarder
2635
'AllInOneRepository',
2636
'WeaveMetaDirRepository',
2637
'PreSplitOutRepositoryFormat',
2638
'RepositoryFormat4',
2639
'RepositoryFormat5',
2640
'RepositoryFormat6',
2641
'RepositoryFormat7',
2643
__make_delegated(_name, 'bzrlib.repofmt.weaverepo')
2647
'RepositoryFormatKnit',
2648
'RepositoryFormatKnit1',
2650
__make_delegated(_name, 'bzrlib.repofmt.knitrepo')
2653
def install_revision(repository, rev, revision_tree):
2654
"""Install all revision data into a repository."""
2655
install_revisions(repository, [(rev, revision_tree, None)])
2658
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2659
"""Install all revision data into a repository.
2661
Accepts an iterable of revision, tree, signature tuples. The signature
2664
repository.start_write_group()
2666
inventory_cache = lru_cache.LRUCache(10)
2667
for n, (revision, revision_tree, signature) in enumerate(iterable):
2668
_install_revision(repository, revision, revision_tree, signature,
2671
pb.update('Transferring revisions', n + 1, num_revisions)
2673
repository.abort_write_group()
2676
repository.commit_write_group()
2679
def _install_revision(repository, rev, revision_tree, signature,
2681
"""Install all revision data into a repository."""
2682
present_parents = []
2684
for p_id in rev.parent_ids:
2685
if repository.has_revision(p_id):
2686
present_parents.append(p_id)
2687
parent_trees[p_id] = repository.revision_tree(p_id)
2689
parent_trees[p_id] = repository.revision_tree(
2690
_mod_revision.NULL_REVISION)
2692
inv = revision_tree.inventory
2693
entries = inv.iter_entries()
2694
# backwards compatibility hack: skip the root id.
2695
if not repository.supports_rich_root():
2696
path, root = entries.next()
2697
if root.revision != rev.revision_id:
2698
raise errors.IncompatibleRevision(repr(repository))
2700
for path, ie in entries:
2701
text_keys[(ie.file_id, ie.revision)] = ie
2702
text_parent_map = repository.texts.get_parent_map(text_keys)
2703
missing_texts = set(text_keys) - set(text_parent_map)
2704
# Add the texts that are not already present
2705
for text_key in missing_texts:
2706
ie = text_keys[text_key]
2708
# FIXME: TODO: The following loop overlaps/duplicates that done by
2709
# commit to determine parents. There is a latent/real bug here where
2710
# the parents inserted are not those commit would do - in particular
2711
# they are not filtered by heads(). RBC, AB
2712
for revision, tree in parent_trees.iteritems():
2713
if ie.file_id not in tree:
2715
parent_id = tree.inventory[ie.file_id].revision
2716
if parent_id in text_parents:
2718
text_parents.append((ie.file_id, parent_id))
2719
lines = revision_tree.get_file(ie.file_id).readlines()
2720
repository.texts.add_lines(text_key, text_parents, lines)
2722
# install the inventory
2723
if repository._format._commit_inv_deltas and len(rev.parent_ids):
2724
# Cache this inventory
2725
inventory_cache[rev.revision_id] = inv
2727
basis_inv = inventory_cache[rev.parent_ids[0]]
2729
repository.add_inventory(rev.revision_id, inv, present_parents)
2731
delta = inv._make_delta(basis_inv)
2732
repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2733
rev.revision_id, present_parents)
2735
repository.add_inventory(rev.revision_id, inv, present_parents)
2736
except errors.RevisionAlreadyPresent:
2738
if signature is not None:
2739
repository.add_signature_text(rev.revision_id, signature)
2740
repository.add_revision(rev.revision_id, rev, inv)
2743
class MetaDirRepository(Repository):
2744
"""Repositories in the new meta-dir layout.
2746
:ivar _transport: Transport for access to repository control files,
2747
typically pointing to .bzr/repository.
2750
def __init__(self, _format, a_bzrdir, control_files):
2751
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
2752
self._transport = control_files._transport
2754
def is_shared(self):
2755
"""Return True if this repository is flagged as a shared repository."""
2756
return self._transport.has('shared-storage')
2759
def set_make_working_trees(self, new_value):
2760
"""Set the policy flag for making working trees when creating branches.
2762
This only applies to branches that use this repository.
2764
The default is 'True'.
2765
:param new_value: True to restore the default, False to disable making
2770
self._transport.delete('no-working-trees')
2771
except errors.NoSuchFile:
2774
self._transport.put_bytes('no-working-trees', '',
2775
mode=self.bzrdir._get_file_mode())
2777
def make_working_trees(self):
2778
"""Returns the policy for making working trees on new branches."""
2779
return not self._transport.has('no-working-trees')
2782
class MetaDirVersionedFileRepository(MetaDirRepository):
2783
"""Repositories in a meta-dir, that work via versioned file objects."""
2785
def __init__(self, _format, a_bzrdir, control_files):
2786
super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2790
network_format_registry = registry.FormatRegistry()
2791
"""Registry of formats indexed by their network name.
2793
The network name for a repository format is an identifier that can be used when
2794
referring to formats with smart server operations. See
2795
RepositoryFormat.network_name() for more detail.
2799
format_registry = registry.FormatRegistry(network_format_registry)
2800
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2802
This can contain either format instances themselves, or classes/factories that
2803
can be called to obtain one.
2807
#####################################################################
2808
# Repository Formats
2810
class RepositoryFormat(object):
2811
"""A repository format.
2813
Formats provide four things:
2814
* An initialization routine to construct repository data on disk.
2815
* a optional format string which is used when the BzrDir supports
2817
* an open routine which returns a Repository instance.
2818
* A network name for referring to the format in smart server RPC
2821
There is one and only one Format subclass for each on-disk format. But
2822
there can be one Repository subclass that is used for several different
2823
formats. The _format attribute on a Repository instance can be used to
2824
determine the disk format.
2826
Formats are placed in a registry by their format string for reference
2827
during opening. These should be subclasses of RepositoryFormat for
2830
Once a format is deprecated, just deprecate the initialize and open
2831
methods on the format class. Do not deprecate the object, as the
2832
object may be created even when a repository instance hasn't been
2835
Common instance attributes:
2836
_matchingbzrdir - the bzrdir format that the repository format was
2837
originally written to work with. This can be used if manually
2838
constructing a bzrdir and repository, or more commonly for test suite
2842
# Set to True or False in derived classes. True indicates that the format
2843
# supports ghosts gracefully.
2844
supports_ghosts = None
2845
# Can this repository be given external locations to lookup additional
2846
# data. Set to True or False in derived classes.
2847
supports_external_lookups = None
2848
# Does this format support CHK bytestring lookups. Set to True or False in
2850
supports_chks = None
2851
# Should commit add an inventory, or an inventory delta to the repository.
2852
_commit_inv_deltas = True
2853
# What order should fetch operations request streams in?
2854
# The default is unordered as that is the cheapest for an origin to
2856
_fetch_order = 'unordered'
2857
# Does this repository format use deltas that can be fetched as-deltas ?
2858
# (E.g. knits, where the knit deltas can be transplanted intact.
2859
# We default to False, which will ensure that enough data to get
2860
# a full text out of any fetch stream will be grabbed.
2861
_fetch_uses_deltas = False
2862
# Should fetch trigger a reconcile after the fetch? Only needed for
2863
# some repository formats that can suffer internal inconsistencies.
2864
_fetch_reconcile = False
2865
# Does this format have < O(tree_size) delta generation. Used to hint what
2866
# code path for commit, amongst other things.
2868
# Does doing a pack operation compress data? Useful for the pack UI command
2869
# (so if there is one pack, the operation can still proceed because it may
2870
# help), and for fetching when data won't have come from the same
2872
pack_compresses = False
2875
return "<%s>" % self.__class__.__name__
2877
def __eq__(self, other):
2878
# format objects are generally stateless
2879
return isinstance(other, self.__class__)
2881
def __ne__(self, other):
2882
return not self == other
2885
def find_format(klass, a_bzrdir):
2886
"""Return the format for the repository object in a_bzrdir.
2888
This is used by bzr native formats that have a "format" file in
2889
the repository. Other methods may be used by different types of
2893
transport = a_bzrdir.get_repository_transport(None)
2894
format_string = transport.get("format").read()
2895
return format_registry.get(format_string)
2896
except errors.NoSuchFile:
2897
raise errors.NoRepositoryPresent(a_bzrdir)
2899
raise errors.UnknownFormatError(format=format_string,
2903
def register_format(klass, format):
2904
format_registry.register(format.get_format_string(), format)
2907
def unregister_format(klass, format):
2908
format_registry.remove(format.get_format_string())
2911
def get_default_format(klass):
2912
"""Return the current default format."""
2913
from bzrlib import bzrdir
2914
return bzrdir.format_registry.make_bzrdir('default').repository_format
2916
def get_format_string(self):
2917
"""Return the ASCII format string that identifies this format.
2919
Note that in pre format ?? repositories the format string is
2920
not permitted nor written to disk.
2922
raise NotImplementedError(self.get_format_string)
2924
def get_format_description(self):
2925
"""Return the short description for this format."""
2926
raise NotImplementedError(self.get_format_description)
2928
# TODO: this shouldn't be in the base class, it's specific to things that
2929
# use weaves or knits -- mbp 20070207
2930
def _get_versioned_file_store(self,
2935
versionedfile_class=None,
2936
versionedfile_kwargs={},
2938
if versionedfile_class is None:
2939
versionedfile_class = self._versionedfile_class
2940
weave_transport = control_files._transport.clone(name)
2941
dir_mode = control_files._dir_mode
2942
file_mode = control_files._file_mode
2943
return VersionedFileStore(weave_transport, prefixed=prefixed,
2945
file_mode=file_mode,
2946
versionedfile_class=versionedfile_class,
2947
versionedfile_kwargs=versionedfile_kwargs,
2950
def initialize(self, a_bzrdir, shared=False):
2951
"""Initialize a repository of this format in a_bzrdir.
2953
:param a_bzrdir: The bzrdir to put the new repository in it.
2954
:param shared: The repository should be initialized as a sharable one.
2955
:returns: The new repository object.
2957
This may raise UninitializableFormat if shared repository are not
2958
compatible the a_bzrdir.
2960
raise NotImplementedError(self.initialize)
2962
def is_supported(self):
2963
"""Is this format supported?
2965
Supported formats must be initializable and openable.
2966
Unsupported formats may not support initialization or committing or
2967
some other features depending on the reason for not being supported.
2971
def network_name(self):
2972
"""A simple byte string uniquely identifying this format for RPC calls.
2974
MetaDir repository formats use their disk format string to identify the
2975
repository over the wire. All in one formats such as bzr < 0.8, and
2976
foreign formats like svn/git and hg should use some marker which is
2977
unique and immutable.
2979
raise NotImplementedError(self.network_name)
2981
def check_conversion_target(self, target_format):
2982
raise NotImplementedError(self.check_conversion_target)
2984
def open(self, a_bzrdir, _found=False):
2985
"""Return an instance of this format for the bzrdir a_bzrdir.
2987
_found is a private parameter, do not use it.
2989
raise NotImplementedError(self.open)
2992
class MetaDirRepositoryFormat(RepositoryFormat):
2993
"""Common base class for the new repositories using the metadir layout."""
2995
rich_root_data = False
2996
supports_tree_reference = False
2997
supports_external_lookups = False
3000
def _matchingbzrdir(self):
3001
matching = bzrdir.BzrDirMetaFormat1()
3002
matching.repository_format = self
3006
super(MetaDirRepositoryFormat, self).__init__()
3008
def _create_control_files(self, a_bzrdir):
3009
"""Create the required files and the initial control_files object."""
3010
# FIXME: RBC 20060125 don't peek under the covers
3011
# NB: no need to escape relative paths that are url safe.
3012
repository_transport = a_bzrdir.get_repository_transport(self)
3013
control_files = lockable_files.LockableFiles(repository_transport,
3014
'lock', lockdir.LockDir)
3015
control_files.create_lock()
3016
return control_files
3018
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
3019
"""Upload the initial blank content."""
3020
control_files = self._create_control_files(a_bzrdir)
3021
control_files.lock_write()
3022
transport = control_files._transport
3024
utf8_files += [('shared-storage', '')]
3026
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
3027
for (filename, content_stream) in files:
3028
transport.put_file(filename, content_stream,
3029
mode=a_bzrdir._get_file_mode())
3030
for (filename, content_bytes) in utf8_files:
3031
transport.put_bytes_non_atomic(filename, content_bytes,
3032
mode=a_bzrdir._get_file_mode())
3034
control_files.unlock()
3036
def network_name(self):
3037
"""Metadir formats have matching disk and network format strings."""
3038
return self.get_format_string()
3041
# Pre-0.8 formats that don't have a disk format string (because they are
3042
# versioned by the matching control directory). We use the control directories
3043
# disk format string as a key for the network_name because they meet the
3044
# constraints (simple string, unique, immutable).
3045
network_format_registry.register_lazy(
3046
"Bazaar-NG branch, format 5\n",
3047
'bzrlib.repofmt.weaverepo',
3048
'RepositoryFormat5',
3050
network_format_registry.register_lazy(
3051
"Bazaar-NG branch, format 6\n",
3052
'bzrlib.repofmt.weaverepo',
3053
'RepositoryFormat6',
3056
# formats which have no format string are not discoverable or independently
3057
# creatable on disk, so are not registered in format_registry. They're
3058
# all in bzrlib.repofmt.weaverepo now. When an instance of one of these is
3059
# needed, it's constructed directly by the BzrDir. Non-native formats where
3060
# the repository is not separately opened are similar.
3062
format_registry.register_lazy(
3063
'Bazaar-NG Repository format 7',
3064
'bzrlib.repofmt.weaverepo',
3068
format_registry.register_lazy(
3069
'Bazaar-NG Knit Repository Format 1',
3070
'bzrlib.repofmt.knitrepo',
3071
'RepositoryFormatKnit1',
3074
format_registry.register_lazy(
3075
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
3076
'bzrlib.repofmt.knitrepo',
3077
'RepositoryFormatKnit3',
3080
format_registry.register_lazy(
3081
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
3082
'bzrlib.repofmt.knitrepo',
3083
'RepositoryFormatKnit4',
3086
# Pack-based formats. There is one format for pre-subtrees, and one for
3087
# post-subtrees to allow ease of testing.
3088
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
3089
format_registry.register_lazy(
3090
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3091
'bzrlib.repofmt.pack_repo',
3092
'RepositoryFormatKnitPack1',
3094
format_registry.register_lazy(
3095
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
3096
'bzrlib.repofmt.pack_repo',
3097
'RepositoryFormatKnitPack3',
3099
format_registry.register_lazy(
3100
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
3101
'bzrlib.repofmt.pack_repo',
3102
'RepositoryFormatKnitPack4',
3104
format_registry.register_lazy(
3105
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
3106
'bzrlib.repofmt.pack_repo',
3107
'RepositoryFormatKnitPack5',
3109
format_registry.register_lazy(
3110
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
3111
'bzrlib.repofmt.pack_repo',
3112
'RepositoryFormatKnitPack5RichRoot',
3114
format_registry.register_lazy(
3115
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
3116
'bzrlib.repofmt.pack_repo',
3117
'RepositoryFormatKnitPack5RichRootBroken',
3119
format_registry.register_lazy(
3120
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3121
'bzrlib.repofmt.pack_repo',
3122
'RepositoryFormatKnitPack6',
3124
format_registry.register_lazy(
3125
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3126
'bzrlib.repofmt.pack_repo',
3127
'RepositoryFormatKnitPack6RichRoot',
3130
# Development formats.
3131
# Obsolete but kept pending a CHK based subtree format.
3132
format_registry.register_lazy(
3133
("Bazaar development format 2 with subtree support "
3134
"(needs bzr.dev from before 1.8)\n"),
3135
'bzrlib.repofmt.pack_repo',
3136
'RepositoryFormatPackDevelopment2Subtree',
3139
# 1.14->1.16 go below here
3140
format_registry.register_lazy(
3141
'Bazaar development format - group compression and chk inventory'
3142
' (needs bzr.dev from 1.14)\n',
3143
'bzrlib.repofmt.groupcompress_repo',
3144
'RepositoryFormatCHK1',
3147
format_registry.register_lazy(
3148
'Bazaar development format - chk repository with bencode revision '
3149
'serialization (needs bzr.dev from 1.16)\n',
3150
'bzrlib.repofmt.groupcompress_repo',
3151
'RepositoryFormatCHK2',
3153
format_registry.register_lazy(
3154
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3155
'bzrlib.repofmt.groupcompress_repo',
3156
'RepositoryFormat2a',
3160
class InterRepository(InterObject):
3161
"""This class represents operations taking place between two repositories.
3163
Its instances have methods like copy_content and fetch, and contain
3164
references to the source and target repositories these operations can be
3167
Often we will provide convenience methods on 'repository' which carry out
3168
operations with another repository - they will always forward to
3169
InterRepository.get(other).method_name(parameters).
3172
_walk_to_common_revisions_batch_size = 50
3174
"""The available optimised InterRepository types."""
3177
def copy_content(self, revision_id=None):
3178
"""Make a complete copy of the content in self into destination.
3180
This is a destructive operation! Do not use it on existing
3183
:param revision_id: Only copy the content needed to construct
3184
revision_id and its parents.
3187
self.target.set_make_working_trees(self.source.make_working_trees())
3188
except NotImplementedError:
3190
self.target.fetch(self.source, revision_id=revision_id)
3193
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3195
"""Fetch the content required to construct revision_id.
3197
The content is copied from self.source to self.target.
3199
:param revision_id: if None all content is copied, if NULL_REVISION no
3201
:param pb: optional progress bar to use for progress reports. If not
3202
provided a default one will be created.
3205
from bzrlib.fetch import RepoFetcher
3206
f = RepoFetcher(to_repository=self.target,
3207
from_repository=self.source,
3208
last_revision=revision_id,
3209
fetch_spec=fetch_spec,
3210
pb=pb, find_ghosts=find_ghosts)
3212
def _walk_to_common_revisions(self, revision_ids):
3213
"""Walk out from revision_ids in source to revisions target has.
3215
:param revision_ids: The start point for the search.
3216
:return: A set of revision ids.
3218
target_graph = self.target.get_graph()
3219
revision_ids = frozenset(revision_ids)
3220
missing_revs = set()
3221
source_graph = self.source.get_graph()
3222
# ensure we don't pay silly lookup costs.
3223
searcher = source_graph._make_breadth_first_searcher(revision_ids)
3224
null_set = frozenset([_mod_revision.NULL_REVISION])
3225
searcher_exhausted = False
3229
# Iterate the searcher until we have enough next_revs
3230
while len(next_revs) < self._walk_to_common_revisions_batch_size:
3232
next_revs_part, ghosts_part = searcher.next_with_ghosts()
3233
next_revs.update(next_revs_part)
3234
ghosts.update(ghosts_part)
3235
except StopIteration:
3236
searcher_exhausted = True
3238
# If there are ghosts in the source graph, and the caller asked for
3239
# them, make sure that they are present in the target.
3240
# We don't care about other ghosts as we can't fetch them and
3241
# haven't been asked to.
3242
ghosts_to_check = set(revision_ids.intersection(ghosts))
3243
revs_to_get = set(next_revs).union(ghosts_to_check)
3245
have_revs = set(target_graph.get_parent_map(revs_to_get))
3246
# we always have NULL_REVISION present.
3247
have_revs = have_revs.union(null_set)
3248
# Check if the target is missing any ghosts we need.
3249
ghosts_to_check.difference_update(have_revs)
3251
# One of the caller's revision_ids is a ghost in both the
3252
# source and the target.
3253
raise errors.NoSuchRevision(
3254
self.source, ghosts_to_check.pop())
3255
missing_revs.update(next_revs - have_revs)
3256
# Because we may have walked past the original stop point, make
3257
# sure everything is stopped
3258
stop_revs = searcher.find_seen_ancestors(have_revs)
3259
searcher.stop_searching_any(stop_revs)
3260
if searcher_exhausted:
3262
return searcher.get_result()
3265
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3266
"""Return the revision ids that source has that target does not.
3268
:param revision_id: only return revision ids included by this
3270
:param find_ghosts: If True find missing revisions in deep history
3271
rather than just finding the surface difference.
3272
:return: A bzrlib.graph.SearchResult.
3274
# stop searching at found target revisions.
3275
if not find_ghosts and revision_id is not None:
3276
return self._walk_to_common_revisions([revision_id])
3277
# generic, possibly worst case, slow code path.
3278
target_ids = set(self.target.all_revision_ids())
3279
if revision_id is not None:
3280
source_ids = self.source.get_ancestry(revision_id)
3281
if source_ids[0] is not None:
3282
raise AssertionError()
3285
source_ids = self.source.all_revision_ids()
3286
result_set = set(source_ids).difference(target_ids)
3287
return self.source.revision_ids_to_search_result(result_set)
3290
def _same_model(source, target):
3291
"""True if source and target have the same data representation.
3293
Note: this is always called on the base class; overriding it in a
3294
subclass will have no effect.
3297
InterRepository._assert_same_model(source, target)
3299
except errors.IncompatibleRepositories, e:
3303
def _assert_same_model(source, target):
3304
"""Raise an exception if two repositories do not use the same model.
3306
if source.supports_rich_root() != target.supports_rich_root():
3307
raise errors.IncompatibleRepositories(source, target,
3308
"different rich-root support")
3309
if source._serializer != target._serializer:
3310
raise errors.IncompatibleRepositories(source, target,
3311
"different serializers")
3314
class InterSameDataRepository(InterRepository):
3315
"""Code for converting between repositories that represent the same data.
3317
Data format and model must match for this to work.
3321
def _get_repo_format_to_test(self):
3322
"""Repository format for testing with.
3324
InterSameData can pull from subtree to subtree and from non-subtree to
3325
non-subtree, so we test this with the richest repository format.
3327
from bzrlib.repofmt import knitrepo
3328
return knitrepo.RepositoryFormatKnit3()
3331
def is_compatible(source, target):
3332
return InterRepository._same_model(source, target)
3335
class InterWeaveRepo(InterSameDataRepository):
3336
"""Optimised code paths between Weave based repositories.
3338
This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3339
implemented lazy inter-object optimisation.
3343
def _get_repo_format_to_test(self):
3344
from bzrlib.repofmt import weaverepo
3345
return weaverepo.RepositoryFormat7()
3348
def is_compatible(source, target):
3349
"""Be compatible with known Weave formats.
3351
We don't test for the stores being of specific types because that
3352
could lead to confusing results, and there is no need to be
3355
from bzrlib.repofmt.weaverepo import (
3361
return (isinstance(source._format, (RepositoryFormat5,
3363
RepositoryFormat7)) and
3364
isinstance(target._format, (RepositoryFormat5,
3366
RepositoryFormat7)))
3367
except AttributeError:
3371
def copy_content(self, revision_id=None):
3372
"""See InterRepository.copy_content()."""
3373
# weave specific optimised path:
3375
self.target.set_make_working_trees(self.source.make_working_trees())
3376
except (errors.RepositoryUpgradeRequired, NotImplemented):
3378
# FIXME do not peek!
3379
if self.source._transport.listable():
3380
pb = ui.ui_factory.nested_progress_bar()
3382
self.target.texts.insert_record_stream(
3383
self.source.texts.get_record_stream(
3384
self.source.texts.keys(), 'topological', False))
3385
pb.update('copying inventory', 0, 1)
3386
self.target.inventories.insert_record_stream(
3387
self.source.inventories.get_record_stream(
3388
self.source.inventories.keys(), 'topological', False))
3389
self.target.signatures.insert_record_stream(
3390
self.source.signatures.get_record_stream(
3391
self.source.signatures.keys(),
3393
self.target.revisions.insert_record_stream(
3394
self.source.revisions.get_record_stream(
3395
self.source.revisions.keys(),
3396
'topological', True))
3400
self.target.fetch(self.source, revision_id=revision_id)
3403
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3404
"""See InterRepository.missing_revision_ids()."""
3405
# we want all revisions to satisfy revision_id in source.
3406
# but we don't want to stat every file here and there.
3407
# we want then, all revisions other needs to satisfy revision_id
3408
# checked, but not those that we have locally.
3409
# so the first thing is to get a subset of the revisions to
3410
# satisfy revision_id in source, and then eliminate those that
3411
# we do already have.
3412
# this is slow on high latency connection to self, but as this
3413
# disk format scales terribly for push anyway due to rewriting
3414
# inventory.weave, this is considered acceptable.
3416
if revision_id is not None:
3417
source_ids = self.source.get_ancestry(revision_id)
3418
if source_ids[0] is not None:
3419
raise AssertionError()
3422
source_ids = self.source._all_possible_ids()
3423
source_ids_set = set(source_ids)
3424
# source_ids is the worst possible case we may need to pull.
3425
# now we want to filter source_ids against what we actually
3426
# have in target, but don't try to check for existence where we know
3427
# we do not have a revision as that would be pointless.
3428
target_ids = set(self.target._all_possible_ids())
3429
possibly_present_revisions = target_ids.intersection(source_ids_set)
3430
actually_present_revisions = set(
3431
self.target._eliminate_revisions_not_present(possibly_present_revisions))
3432
required_revisions = source_ids_set.difference(actually_present_revisions)
3433
if revision_id is not None:
3434
# we used get_ancestry to determine source_ids then we are assured all
3435
# revisions referenced are present as they are installed in topological order.
3436
# and the tip revision was validated by get_ancestry.
3437
result_set = required_revisions
3439
# if we just grabbed the possibly available ids, then
3440
# we only have an estimate of whats available and need to validate
3441
# that against the revision records.
3443
self.source._eliminate_revisions_not_present(required_revisions))
3444
return self.source.revision_ids_to_search_result(result_set)
3447
class InterKnitRepo(InterSameDataRepository):
3448
"""Optimised code paths between Knit based repositories."""
3451
def _get_repo_format_to_test(self):
3452
from bzrlib.repofmt import knitrepo
3453
return knitrepo.RepositoryFormatKnit1()
3456
def is_compatible(source, target):
3457
"""Be compatible with known Knit formats.
3459
We don't test for the stores being of specific types because that
3460
could lead to confusing results, and there is no need to be
3463
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3465
are_knits = (isinstance(source._format, RepositoryFormatKnit) and
3466
isinstance(target._format, RepositoryFormatKnit))
3467
except AttributeError:
3469
return are_knits and InterRepository._same_model(source, target)
3472
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3473
"""See InterRepository.missing_revision_ids()."""
3474
if revision_id is not None:
3475
source_ids = self.source.get_ancestry(revision_id)
3476
if source_ids[0] is not None:
3477
raise AssertionError()
3480
source_ids = self.source.all_revision_ids()
3481
source_ids_set = set(source_ids)
3482
# source_ids is the worst possible case we may need to pull.
3483
# now we want to filter source_ids against what we actually
3484
# have in target, but don't try to check for existence where we know
3485
# we do not have a revision as that would be pointless.
3486
target_ids = set(self.target.all_revision_ids())
3487
possibly_present_revisions = target_ids.intersection(source_ids_set)
3488
actually_present_revisions = set(
3489
self.target._eliminate_revisions_not_present(possibly_present_revisions))
3490
required_revisions = source_ids_set.difference(actually_present_revisions)
3491
if revision_id is not None:
3492
# we used get_ancestry to determine source_ids then we are assured all
3493
# revisions referenced are present as they are installed in topological order.
3494
# and the tip revision was validated by get_ancestry.
3495
result_set = required_revisions
3497
# if we just grabbed the possibly available ids, then
3498
# we only have an estimate of whats available and need to validate
3499
# that against the revision records.
3501
self.source._eliminate_revisions_not_present(required_revisions))
3502
return self.source.revision_ids_to_search_result(result_set)
3505
class InterDifferingSerializer(InterRepository):
3508
def _get_repo_format_to_test(self):
3512
def is_compatible(source, target):
3513
"""Be compatible with Knit2 source and Knit3 target"""
3514
# This is redundant with format.check_conversion_target(), however that
3515
# raises an exception, and we just want to say "False" as in we won't
3516
# support converting between these formats.
3517
if source.supports_rich_root() and not target.supports_rich_root():
3519
if (source._format.supports_tree_reference
3520
and not target._format.supports_tree_reference):
3524
def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3525
"""Get the best delta and base for this revision.
3527
:return: (basis_id, delta)
3529
possible_trees = [(parent_id, cache[parent_id])
3530
for parent_id in parent_ids
3531
if parent_id in cache]
3532
if len(possible_trees) == 0:
3533
# There either aren't any parents, or the parents aren't in the
3534
# cache, so just use the last converted tree
3535
possible_trees.append((basis_id, cache[basis_id]))
3537
for basis_id, basis_tree in possible_trees:
3538
delta = tree.inventory._make_delta(basis_tree.inventory)
3539
deltas.append((len(delta), basis_id, delta))
3541
return deltas[0][1:]
3543
def _get_parent_keys(self, root_key, parent_map):
3544
"""Get the parent keys for a given root id."""
3545
root_id, rev_id = root_key
3546
# Include direct parents of the revision, but only if they used
3547
# the same root_id and are heads.
3549
for parent_id in parent_map[rev_id]:
3550
if parent_id == _mod_revision.NULL_REVISION:
3552
if parent_id not in self._revision_id_to_root_id:
3553
# We probably didn't read this revision, go spend the
3554
# extra effort to actually check
3556
tree = self.source.revision_tree(parent_id)
3557
except errors.NoSuchRevision:
3558
# Ghost, fill out _revision_id_to_root_id in case we
3559
# encounter this again.
3560
# But set parent_root_id to None since we don't really know
3561
parent_root_id = None
3563
parent_root_id = tree.get_root_id()
3564
self._revision_id_to_root_id[parent_id] = None
3566
parent_root_id = self._revision_id_to_root_id[parent_id]
3567
if root_id == parent_root_id:
3568
# With stacking we _might_ want to refer to a non-local
3569
# revision, but this code path only applies when we have the
3570
# full content available, so ghosts really are ghosts, not just
3571
# the edge of local data.
3572
parent_keys.append((parent_id,))
3574
# root_id may be in the parent anyway.
3576
tree = self.source.revision_tree(parent_id)
3577
except errors.NoSuchRevision:
3578
# ghost, can't refer to it.
3582
parent_keys.append((tree.inventory[root_id].revision,))
3583
except errors.NoSuchId:
3586
g = graph.Graph(self.source.revisions)
3587
heads = g.heads(parent_keys)
3589
for key in parent_keys:
3590
if key in heads and key not in selected_keys:
3591
selected_keys.append(key)
3592
return tuple([(root_id,)+ key for key in selected_keys])
3594
def _new_root_data_stream(self, root_keys_to_create, parent_map):
3595
for root_key in root_keys_to_create:
3596
parent_keys = self._get_parent_keys(root_key, parent_map)
3597
yield versionedfile.FulltextContentFactory(root_key,
3598
parent_keys, None, '')
3600
def _fetch_batch(self, revision_ids, basis_id, cache):
3601
"""Fetch across a few revisions.
3603
:param revision_ids: The revisions to copy
3604
:param basis_id: The revision_id of a tree that must be in cache, used
3605
as a basis for delta when no other base is available
3606
:param cache: A cache of RevisionTrees that we can use.
3607
:return: The revision_id of the last converted tree. The RevisionTree
3608
for it will be in cache
3610
# Walk though all revisions; get inventory deltas, copy referenced
3611
# texts that delta references, insert the delta, revision and
3613
root_keys_to_create = set()
3616
pending_revisions = []
3617
parent_map = self.source.get_parent_map(revision_ids)
3618
for tree in self.source.revision_trees(revision_ids):
3619
current_revision_id = tree.get_revision_id()
3620
parent_ids = parent_map.get(current_revision_id, ())
3621
basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3623
if self._converting_to_rich_root:
3624
self._revision_id_to_root_id[current_revision_id] = \
3626
# Find text entries that need to be copied
3627
for old_path, new_path, file_id, entry in delta:
3628
if new_path is not None:
3631
if not self.target.supports_rich_root():
3632
# The target doesn't support rich root, so we don't
3635
if self._converting_to_rich_root:
3636
# This can't be copied normally, we have to insert
3638
root_keys_to_create.add((file_id, entry.revision))
3640
text_keys.add((file_id, entry.revision))
3641
revision = self.source.get_revision(current_revision_id)
3642
pending_deltas.append((basis_id, delta,
3643
current_revision_id, revision.parent_ids))
3644
pending_revisions.append(revision)
3645
cache[current_revision_id] = tree
3646
basis_id = current_revision_id
3648
from_texts = self.source.texts
3649
to_texts = self.target.texts
3650
if root_keys_to_create:
3651
root_stream = self._new_root_data_stream(root_keys_to_create,
3653
to_texts.insert_record_stream(root_stream)
3654
to_texts.insert_record_stream(from_texts.get_record_stream(
3655
text_keys, self.target._format._fetch_order,
3656
not self.target._format._fetch_uses_deltas))
3657
# insert inventory deltas
3658
for delta in pending_deltas:
3659
self.target.add_inventory_by_delta(*delta)
3660
if self.target._fallback_repositories:
3661
# Make sure this stacked repository has all the parent inventories
3662
# for the new revisions that we are about to insert. We do this
3663
# before adding the revisions so that no revision is added until
3664
# all the inventories it may depend on are added.
3666
revision_ids = set()
3667
for revision in pending_revisions:
3668
revision_ids.add(revision.revision_id)
3669
parent_ids.update(revision.parent_ids)
3670
parent_ids.difference_update(revision_ids)
3671
parent_ids.discard(_mod_revision.NULL_REVISION)
3672
parent_map = self.source.get_parent_map(parent_ids)
3673
for parent_tree in self.source.revision_trees(parent_ids):
3674
basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3675
current_revision_id = parent_tree.get_revision_id()
3676
parents_parents = parent_map[current_revision_id]
3677
self.target.add_inventory_by_delta(
3678
basis_id, delta, current_revision_id, parents_parents)
3679
# insert signatures and revisions
3680
for revision in pending_revisions:
3682
signature = self.source.get_signature_text(
3683
revision.revision_id)
3684
self.target.add_signature_text(revision.revision_id,
3686
except errors.NoSuchRevision:
3688
self.target.add_revision(revision.revision_id, revision)
3691
def _fetch_all_revisions(self, revision_ids, pb):
3692
"""Fetch everything for the list of revisions.
3694
:param revision_ids: The list of revisions to fetch. Must be in
3696
:param pb: A ProgressTask
3699
basis_id, basis_tree = self._get_basis(revision_ids[0])
3701
cache = lru_cache.LRUCache(100)
3702
cache[basis_id] = basis_tree
3703
del basis_tree # We don't want to hang on to it here
3705
for offset in range(0, len(revision_ids), batch_size):
3706
self.target.start_write_group()
3708
pb.update('Transferring revisions', offset,
3710
batch = revision_ids[offset:offset+batch_size]
3711
basis_id = self._fetch_batch(batch, basis_id, cache)
3713
self.target.abort_write_group()
3716
hint = self.target.commit_write_group()
3719
if hints and self.target._format.pack_compresses:
3720
self.target.pack(hint=hints)
3721
pb.update('Transferring revisions', len(revision_ids),
3725
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3727
"""See InterRepository.fetch()."""
3728
if fetch_spec is not None:
3729
raise AssertionError("Not implemented yet...")
3730
if (not self.source.supports_rich_root()
3731
and self.target.supports_rich_root()):
3732
self._converting_to_rich_root = True
3733
self._revision_id_to_root_id = {}
3735
self._converting_to_rich_root = False
3736
revision_ids = self.target.search_missing_revision_ids(self.source,
3737
revision_id, find_ghosts=find_ghosts).get_keys()
3738
if not revision_ids:
3740
revision_ids = tsort.topo_sort(
3741
self.source.get_graph().get_parent_map(revision_ids))
3742
if not revision_ids:
3744
# Walk though all revisions; get inventory deltas, copy referenced
3745
# texts that delta references, insert the delta, revision and
3747
first_rev = self.source.get_revision(revision_ids[0])
3749
my_pb = ui.ui_factory.nested_progress_bar()
3752
symbol_versioning.warn(
3753
symbol_versioning.deprecated_in((1, 14, 0))
3754
% "pb parameter to fetch()")
3757
self._fetch_all_revisions(revision_ids, pb)
3759
if my_pb is not None:
3761
return len(revision_ids), 0
3763
def _get_basis(self, first_revision_id):
3764
"""Get a revision and tree which exists in the target.
3766
This assumes that first_revision_id is selected for transmission
3767
because all other ancestors are already present. If we can't find an
3768
ancestor we fall back to NULL_REVISION since we know that is safe.
3770
:return: (basis_id, basis_tree)
3772
first_rev = self.source.get_revision(first_revision_id)
3774
basis_id = first_rev.parent_ids[0]
3775
# only valid as a basis if the target has it
3776
self.target.get_revision(basis_id)
3777
# Try to get a basis tree - if its a ghost it will hit the
3778
# NoSuchRevision case.
3779
basis_tree = self.source.revision_tree(basis_id)
3780
except (IndexError, errors.NoSuchRevision):
3781
basis_id = _mod_revision.NULL_REVISION
3782
basis_tree = self.source.revision_tree(basis_id)
3783
return basis_id, basis_tree
3786
InterRepository.register_optimiser(InterDifferingSerializer)
3787
InterRepository.register_optimiser(InterSameDataRepository)
3788
InterRepository.register_optimiser(InterWeaveRepo)
3789
InterRepository.register_optimiser(InterKnitRepo)
3792
class CopyConverter(object):
3793
"""A repository conversion tool which just performs a copy of the content.
3795
This is slow but quite reliable.
3798
def __init__(self, target_format):
3799
"""Create a CopyConverter.
3801
:param target_format: The format the resulting repository should be.
3803
self.target_format = target_format
3805
def convert(self, repo, pb):
3806
"""Perform the conversion of to_convert, giving feedback via pb.
3808
:param to_convert: The disk object to convert.
3809
:param pb: a progress bar to use for progress information.
3814
# this is only useful with metadir layouts - separated repo content.
3815
# trigger an assertion if not such
3816
repo._format.get_format_string()
3817
self.repo_dir = repo.bzrdir
3818
self.step('Moving repository to repository.backup')
3819
self.repo_dir.transport.move('repository', 'repository.backup')
3820
backup_transport = self.repo_dir.transport.clone('repository.backup')
3821
repo._format.check_conversion_target(self.target_format)
3822
self.source_repo = repo._format.open(self.repo_dir,
3824
_override_transport=backup_transport)
3825
self.step('Creating new repository')
3826
converted = self.target_format.initialize(self.repo_dir,
3827
self.source_repo.is_shared())
3828
converted.lock_write()
3830
self.step('Copying content into repository.')
3831
self.source_repo.copy_content_into(converted)
3834
self.step('Deleting old repository content.')
3835
self.repo_dir.transport.delete_tree('repository.backup')
3836
self.pb.note('repository converted')
3838
def step(self, message):
3839
"""Update the pb by a step."""
3841
self.pb.update(message, self.count, self.total)
3853
def _unescaper(match, _map=_unescape_map):
3854
code = match.group(1)
3858
if not code.startswith('#'):
3860
return unichr(int(code[1:])).encode('utf8')
3866
def _unescape_xml(data):
3867
"""Unescape predefined XML entities in a string of data."""
3869
if _unescape_re is None:
3870
_unescape_re = re.compile('\&([^;]*);')
3871
return _unescape_re.sub(_unescaper, data)
3874
class _VersionedFileChecker(object):
3876
def __init__(self, repository, text_key_references=None):
3877
self.repository = repository
3878
self.text_index = self.repository._generate_text_key_index(
3879
text_key_references=text_key_references)
3881
def calculate_file_version_parents(self, text_key):
3882
"""Calculate the correct parents for a file version according to
3885
parent_keys = self.text_index[text_key]
3886
if parent_keys == [_mod_revision.NULL_REVISION]:
3888
return tuple(parent_keys)
3890
def check_file_version_parents(self, texts, progress_bar=None):
3891
"""Check the parents stored in a versioned file are correct.
3893
It also detects file versions that are not referenced by their
3894
corresponding revision's inventory.
3896
:returns: A tuple of (wrong_parents, dangling_file_versions).
3897
wrong_parents is a dict mapping {revision_id: (stored_parents,
3898
correct_parents)} for each revision_id where the stored parents
3899
are not correct. dangling_file_versions is a set of (file_id,
3900
revision_id) tuples for versions that are present in this versioned
3901
file, but not used by the corresponding inventory.
3904
self.file_ids = set([file_id for file_id, _ in
3905
self.text_index.iterkeys()])
3906
# text keys is now grouped by file_id
3907
n_weaves = len(self.file_ids)
3908
files_in_revisions = {}
3909
revisions_of_files = {}
3910
n_versions = len(self.text_index)
3911
progress_bar.update('loading text store', 0, n_versions)
3912
parent_map = self.repository.texts.get_parent_map(self.text_index)
3913
# On unlistable transports this could well be empty/error...
3914
text_keys = self.repository.texts.keys()
3915
unused_keys = frozenset(text_keys) - set(self.text_index)
3916
for num, key in enumerate(self.text_index.iterkeys()):
3917
if progress_bar is not None:
3918
progress_bar.update('checking text graph', num, n_versions)
3919
correct_parents = self.calculate_file_version_parents(key)
3921
knit_parents = parent_map[key]
3922
except errors.RevisionNotPresent:
3925
if correct_parents != knit_parents:
3926
wrong_parents[key] = (knit_parents, correct_parents)
3927
return wrong_parents, unused_keys
3930
def _old_get_graph(repository, revision_id):
3931
"""DO NOT USE. That is all. I'm serious."""
3932
graph = repository.get_graph()
3933
revision_graph = dict(((key, value) for key, value in
3934
graph.iter_ancestry([revision_id]) if value is not None))
3935
return _strip_NULL_ghosts(revision_graph)
3938
def _strip_NULL_ghosts(revision_graph):
3939
"""Also don't use this. more compatibility code for unmigrated clients."""
3940
# Filter ghosts, and null:
3941
if _mod_revision.NULL_REVISION in revision_graph:
3942
del revision_graph[_mod_revision.NULL_REVISION]
3943
for key, parents in revision_graph.items():
3944
revision_graph[key] = tuple(parent for parent in parents if parent
3946
return revision_graph
3949
class StreamSink(object):
3950
"""An object that can insert a stream into a repository.
3952
This interface handles the complexity of reserialising inventories and
3953
revisions from different formats, and allows unidirectional insertion into
3954
stacked repositories without looking for the missing basis parents
3958
def __init__(self, target_repo):
3959
self.target_repo = target_repo
3961
def insert_stream(self, stream, src_format, resume_tokens):
3962
"""Insert a stream's content into the target repository.
3964
:param src_format: a bzr repository format.
3966
:return: a list of resume tokens and an iterable of keys additional
3967
items required before the insertion can be completed.
3969
self.target_repo.lock_write()
3972
self.target_repo.resume_write_group(resume_tokens)
3975
self.target_repo.start_write_group()
3978
# locked_insert_stream performs a commit|suspend.
3979
return self._locked_insert_stream(stream, src_format, is_resume)
3981
self.target_repo.abort_write_group(suppress_errors=True)
3984
self.target_repo.unlock()
3986
def _locked_insert_stream(self, stream, src_format, is_resume):
3987
to_serializer = self.target_repo._format._serializer
3988
src_serializer = src_format._serializer
3990
if to_serializer == src_serializer:
3991
# If serializers match and the target is a pack repository, set the
3992
# write cache size on the new pack. This avoids poor performance
3993
# on transports where append is unbuffered (such as
3994
# RemoteTransport). This is safe to do because nothing should read
3995
# back from the target repository while a stream with matching
3996
# serialization is being inserted.
3997
# The exception is that a delta record from the source that should
3998
# be a fulltext may need to be expanded by the target (see
3999
# test_fetch_revisions_with_deltas_into_pack); but we take care to
4000
# explicitly flush any buffered writes first in that rare case.
4002
new_pack = self.target_repo._pack_collection._new_pack
4003
except AttributeError:
4004
# Not a pack repository
4007
new_pack.set_write_cache_size(1024*1024)
4008
for substream_type, substream in stream:
4009
if substream_type == 'texts':
4010
self.target_repo.texts.insert_record_stream(substream)
4011
elif substream_type == 'inventories':
4012
if src_serializer == to_serializer:
4013
self.target_repo.inventories.insert_record_stream(
4016
self._extract_and_insert_inventories(
4017
substream, src_serializer)
4018
elif substream_type == 'chk_bytes':
4019
# XXX: This doesn't support conversions, as it assumes the
4020
# conversion was done in the fetch code.
4021
self.target_repo.chk_bytes.insert_record_stream(substream)
4022
elif substream_type == 'revisions':
4023
# This may fallback to extract-and-insert more often than
4024
# required if the serializers are different only in terms of
4026
if src_serializer == to_serializer:
4027
self.target_repo.revisions.insert_record_stream(
4030
self._extract_and_insert_revisions(substream,
4032
elif substream_type == 'signatures':
4033
self.target_repo.signatures.insert_record_stream(substream)
4035
raise AssertionError('kaboom! %s' % (substream_type,))
4036
# Done inserting data, and the missing_keys calculations will try to
4037
# read back from the inserted data, so flush the writes to the new pack
4038
# (if this is pack format).
4039
if new_pack is not None:
4040
new_pack._write_data('', flush=True)
4041
# Find all the new revisions (including ones from resume_tokens)
4042
missing_keys = self.target_repo.get_missing_parent_inventories(
4043
check_for_missing_texts=is_resume)
4045
for prefix, versioned_file in (
4046
('texts', self.target_repo.texts),
4047
('inventories', self.target_repo.inventories),
4048
('revisions', self.target_repo.revisions),
4049
('signatures', self.target_repo.signatures),
4050
('chk_bytes', self.target_repo.chk_bytes),
4052
if versioned_file is None:
4054
missing_keys.update((prefix,) + key for key in
4055
versioned_file.get_missing_compression_parent_keys())
4056
except NotImplementedError:
4057
# cannot even attempt suspending, and missing would have failed
4058
# during stream insertion.
4059
missing_keys = set()
4062
# suspend the write group and tell the caller what we is
4063
# missing. We know we can suspend or else we would not have
4064
# entered this code path. (All repositories that can handle
4065
# missing keys can handle suspending a write group).
4066
write_group_tokens = self.target_repo.suspend_write_group()
4067
return write_group_tokens, missing_keys
4068
hint = self.target_repo.commit_write_group()
4069
if (to_serializer != src_serializer and
4070
self.target_repo._format.pack_compresses):
4071
self.target_repo.pack(hint=hint)
4074
def _extract_and_insert_inventories(self, substream, serializer):
4075
"""Generate a new inventory versionedfile in target, converting data.
4077
The inventory is retrieved from the source, (deserializing it), and
4078
stored in the target (reserializing it in a different format).
4080
for record in substream:
4081
bytes = record.get_bytes_as('fulltext')
4082
revision_id = record.key[0]
4083
inv = serializer.read_inventory_from_string(bytes, revision_id)
4084
parents = [key[0] for key in record.parents]
4085
self.target_repo.add_inventory(revision_id, inv, parents)
4087
def _extract_and_insert_revisions(self, substream, serializer):
4088
for record in substream:
4089
bytes = record.get_bytes_as('fulltext')
4090
revision_id = record.key[0]
4091
rev = serializer.read_revision_from_string(bytes)
4092
if rev.revision_id != revision_id:
4093
raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4094
self.target_repo.add_revision(revision_id, rev)
4097
if self.target_repo._format._fetch_reconcile:
4098
self.target_repo.reconcile()
4101
class StreamSource(object):
4102
"""A source of a stream for fetching between repositories."""
4104
def __init__(self, from_repository, to_format):
4105
"""Create a StreamSource streaming from from_repository."""
4106
self.from_repository = from_repository
4107
self.to_format = to_format
4109
def delta_on_metadata(self):
4110
"""Return True if delta's are permitted on metadata streams.
4112
That is on revisions and signatures.
4114
src_serializer = self.from_repository._format._serializer
4115
target_serializer = self.to_format._serializer
4116
return (self.to_format._fetch_uses_deltas and
4117
src_serializer == target_serializer)
4119
def _fetch_revision_texts(self, revs):
4120
# fetch signatures first and then the revision texts
4121
# may need to be a InterRevisionStore call here.
4122
from_sf = self.from_repository.signatures
4123
# A missing signature is just skipped.
4124
keys = [(rev_id,) for rev_id in revs]
4125
signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4127
self.to_format._fetch_order,
4128
not self.to_format._fetch_uses_deltas))
4129
# If a revision has a delta, this is actually expanded inside the
4130
# insert_record_stream code now, which is an alternate fix for
4132
from_rf = self.from_repository.revisions
4133
revisions = from_rf.get_record_stream(
4135
self.to_format._fetch_order,
4136
not self.delta_on_metadata())
4137
return [('signatures', signatures), ('revisions', revisions)]
4139
def _generate_root_texts(self, revs):
4140
"""This will be called by __fetch between fetching weave texts and
4141
fetching the inventory weave.
4143
Subclasses should override this if they need to generate root texts
4144
after fetching weave texts.
4146
if self._rich_root_upgrade():
4148
return bzrlib.fetch.Inter1and2Helper(
4149
self.from_repository).generate_root_texts(revs)
4153
def get_stream(self, search):
4155
revs = search.get_keys()
4156
graph = self.from_repository.get_graph()
4157
revs = list(graph.iter_topo_order(revs))
4158
data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4160
for knit_kind, file_id, revisions in data_to_fetch:
4161
if knit_kind != phase:
4163
# Make a new progress bar for this phase
4164
if knit_kind == "file":
4165
# Accumulate file texts
4166
text_keys.extend([(file_id, revision) for revision in
4168
elif knit_kind == "inventory":
4169
# Now copy the file texts.
4170
from_texts = self.from_repository.texts
4171
yield ('texts', from_texts.get_record_stream(
4172
text_keys, self.to_format._fetch_order,
4173
not self.to_format._fetch_uses_deltas))
4174
# Cause an error if a text occurs after we have done the
4177
# Before we process the inventory we generate the root
4178
# texts (if necessary) so that the inventories references
4180
for _ in self._generate_root_texts(revs):
4182
# NB: This currently reopens the inventory weave in source;
4183
# using a single stream interface instead would avoid this.
4184
from_weave = self.from_repository.inventories
4185
# we fetch only the referenced inventories because we do not
4186
# know for unselected inventories whether all their required
4187
# texts are present in the other repository - it could be
4189
for info in self._get_inventory_stream(revs):
4191
elif knit_kind == "signatures":
4192
# Nothing to do here; this will be taken care of when
4193
# _fetch_revision_texts happens.
4195
elif knit_kind == "revisions":
4196
for record in self._fetch_revision_texts(revs):
4199
raise AssertionError("Unknown knit kind %r" % knit_kind)
4201
def get_stream_for_missing_keys(self, missing_keys):
4202
# missing keys can only occur when we are byte copying and not
4203
# translating (because translation means we don't send
4204
# unreconstructable deltas ever).
4206
keys['texts'] = set()
4207
keys['revisions'] = set()
4208
keys['inventories'] = set()
4209
keys['chk_bytes'] = set()
4210
keys['signatures'] = set()
4211
for key in missing_keys:
4212
keys[key[0]].add(key[1:])
4213
if len(keys['revisions']):
4214
# If we allowed copying revisions at this point, we could end up
4215
# copying a revision without copying its required texts: a
4216
# violation of the requirements for repository integrity.
4217
raise AssertionError(
4218
'cannot copy revisions to fill in missing deltas %s' % (
4219
keys['revisions'],))
4220
for substream_kind, keys in keys.iteritems():
4221
vf = getattr(self.from_repository, substream_kind)
4222
if vf is None and keys:
4223
raise AssertionError(
4224
"cannot fill in keys for a versioned file we don't"
4225
" have: %s needs %s" % (substream_kind, keys))
4227
# No need to stream something we don't have
4229
# Ask for full texts always so that we don't need more round trips
4230
# after this stream.
4231
# Some of the missing keys are genuinely ghosts, so filter absent
4232
# records. The Sink is responsible for doing another check to
4233
# ensure that ghosts don't introduce missing data for future
4235
stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4236
self.to_format._fetch_order, True))
4237
yield substream_kind, stream
4239
def inventory_fetch_order(self):
4240
if self._rich_root_upgrade():
4241
return 'topological'
4243
return self.to_format._fetch_order
4245
def _rich_root_upgrade(self):
4246
return (not self.from_repository._format.rich_root_data and
4247
self.to_format.rich_root_data)
4249
def _get_inventory_stream(self, revision_ids):
4250
from_format = self.from_repository._format
4251
if (from_format.supports_chks and self.to_format.supports_chks
4252
and (from_format._serializer == self.to_format._serializer)):
4253
# Both sides support chks, and they use the same serializer, so it
4254
# is safe to transmit the chk pages and inventory pages across
4256
return self._get_chk_inventory_stream(revision_ids)
4257
elif (not from_format.supports_chks):
4258
# Source repository doesn't support chks. So we can transmit the
4259
# inventories 'as-is' and either they are just accepted on the
4260
# target, or the Sink will properly convert it.
4261
return self._get_simple_inventory_stream(revision_ids)
4263
# XXX: Hack to make not-chk->chk fetch: copy the inventories as
4264
# inventories. Note that this should probably be done somehow
4265
# as part of bzrlib.repository.StreamSink. Except JAM couldn't
4266
# figure out how a non-chk repository could possibly handle
4267
# deserializing an inventory stream from a chk repo, as it
4268
# doesn't have a way to understand individual pages.
4269
return self._get_convertable_inventory_stream(revision_ids)
4271
def _get_simple_inventory_stream(self, revision_ids):
4272
from_weave = self.from_repository.inventories
4273
yield ('inventories', from_weave.get_record_stream(
4274
[(rev_id,) for rev_id in revision_ids],
4275
self.inventory_fetch_order(),
4276
not self.delta_on_metadata()))
4278
def _get_chk_inventory_stream(self, revision_ids):
4279
"""Fetch the inventory texts, along with the associated chk maps."""
4280
# We want an inventory outside of the search set, so that we can filter
4281
# out uninteresting chk pages. For now we use
4282
# _find_revision_outside_set, but if we had a Search with cut_revs, we
4283
# could use that instead.
4284
start_rev_id = self.from_repository._find_revision_outside_set(
4286
start_rev_key = (start_rev_id,)
4287
inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
4288
if start_rev_id != _mod_revision.NULL_REVISION:
4289
inv_keys_to_fetch.append((start_rev_id,))
4290
# Any repo that supports chk_bytes must also support out-of-order
4291
# insertion. At least, that is how we expect it to work
4292
# We use get_record_stream instead of iter_inventories because we want
4293
# to be able to insert the stream as well. We could instead fetch
4294
# allowing deltas, and then iter_inventories, but we don't know whether
4295
# source or target is more 'local' anway.
4296
inv_stream = self.from_repository.inventories.get_record_stream(
4297
inv_keys_to_fetch, 'unordered',
4298
True) # We need them as full-texts so we can find their references
4299
uninteresting_chk_roots = set()
4300
interesting_chk_roots = set()
4301
def filter_inv_stream(inv_stream):
4302
for idx, record in enumerate(inv_stream):
4303
### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
4304
bytes = record.get_bytes_as('fulltext')
4305
chk_inv = inventory.CHKInventory.deserialise(
4306
self.from_repository.chk_bytes, bytes, record.key)
4307
if record.key == start_rev_key:
4308
uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
4309
p_id_map = chk_inv.parent_id_basename_to_file_id
4310
if p_id_map is not None:
4311
uninteresting_chk_roots.add(p_id_map.key())
4314
interesting_chk_roots.add(chk_inv.id_to_entry.key())
4315
p_id_map = chk_inv.parent_id_basename_to_file_id
4316
if p_id_map is not None:
4317
interesting_chk_roots.add(p_id_map.key())
4318
### pb.update('fetch inventory', 0, 2)
4319
yield ('inventories', filter_inv_stream(inv_stream))
4320
# Now that we have worked out all of the interesting root nodes, grab
4321
# all of the interesting pages and insert them
4322
### pb.update('fetch inventory', 1, 2)
4323
interesting = chk_map.iter_interesting_nodes(
4324
self.from_repository.chk_bytes, interesting_chk_roots,
4325
uninteresting_chk_roots)
4326
def to_stream_adapter():
4327
"""Adapt the iter_interesting_nodes result to a single stream.
4329
iter_interesting_nodes returns records as it processes them, along
4330
with keys. However, we only want to return the records themselves.
4332
for record, items in interesting:
4333
if record is not None:
4335
# XXX: We could instead call get_record_stream(records.keys())
4336
# ATM, this will always insert the records as fulltexts, and
4337
# requires that you can hang on to records once you have gone
4338
# on to the next one. Further, it causes the target to
4339
# recompress the data. Testing shows it to be faster than
4340
# requesting the records again, though.
4341
yield ('chk_bytes', to_stream_adapter())
4342
### pb.update('fetch inventory', 2, 2)
4344
def _get_convertable_inventory_stream(self, revision_ids):
4345
# XXX: One of source or target is using chks, and they don't have
4346
# compatible serializations. The StreamSink code expects to be
4347
# able to convert on the target, so we need to put
4348
# bytes-on-the-wire that can be converted
4349
yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
4351
def _stream_invs_as_fulltexts(self, revision_ids):
4352
from_repo = self.from_repository
4353
from_serializer = from_repo._format._serializer
4354
revision_keys = [(rev_id,) for rev_id in revision_ids]
4355
parent_map = from_repo.inventories.get_parent_map(revision_keys)
4356
for inv in self.from_repository.iter_inventories(revision_ids):
4357
# XXX: This is a bit hackish, but it works. Basically,
4358
# CHKSerializer 'accidentally' supports
4359
# read/write_inventory_to_string, even though that is never
4360
# the format that is stored on disk. It *does* give us a
4361
# single string representation for an inventory, so live with
4363
# This would be far better if we had a 'serialized inventory
4364
# delta' form. Then we could use 'inventory._make_delta', and
4365
# transmit that. This would both be faster to generate, and
4366
# result in fewer bytes-on-the-wire.
4367
as_bytes = from_serializer.write_inventory_to_string(inv)
4368
key = (inv.revision_id,)
4369
parent_keys = parent_map.get(key, ())
4370
yield versionedfile.FulltextContentFactory(
4371
key, parent_keys, None, as_bytes)
4374
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4375
stop_revision=None):
4376
"""Extend the partial history to include a given index
4378
If a stop_index is supplied, stop when that index has been reached.
4379
If a stop_revision is supplied, stop when that revision is
4380
encountered. Otherwise, stop when the beginning of history is
4383
:param stop_index: The index which should be present. When it is
4384
present, history extension will stop.
4385
:param stop_revision: The revision id which should be present. When
4386
it is encountered, history extension will stop.
4388
start_revision = partial_history_cache[-1]
4389
iterator = repo.iter_reverse_revision_history(start_revision)
4391
#skip the last revision in the list
4394
if (stop_index is not None and
4395
len(partial_history_cache) > stop_index):
4397
if partial_history_cache[-1] == stop_revision:
4399
revision_id = iterator.next()
4400
partial_history_cache.append(revision_id)
4401
except StopIteration:
added
removed
bzrlib/repository.py
