202
389
commit to be valid, deletes against the basis MUST be recorded via
203
390
builder.record_delete().
205
raise NotImplementedError(self.will_record_deletes)
207
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
392
self._recording_deletes = True
394
basis_id = self.parents[0]
396
basis_id = _mod_revision.NULL_REVISION
397
self.basis_delta_revision = basis_id
399
def record_entry_contents(self, ie, parent_invs, path, tree,
401
"""Record the content of ie from tree into the commit if needed.
403
Side effect: sets ie.revision when unchanged
405
:param ie: An inventory entry present in the commit.
406
:param parent_invs: The inventories of the parent revisions of the
408
:param path: The path the entry is at in the tree.
409
:param tree: The tree which contains this entry and should be used to
411
:param content_summary: Summary data from the tree about the paths
412
content - stat, length, exec, sha/link target. This is only
413
accessed when the entry has a revision of None - that is when it is
414
a candidate to commit.
415
:return: A tuple (change_delta, version_recorded, fs_hash).
416
change_delta is an inventory_delta change for this entry against
417
the basis tree of the commit, or None if no change occured against
419
version_recorded is True if a new version of the entry has been
420
recorded. For instance, committing a merge where a file was only
421
changed on the other side will return (delta, False).
422
fs_hash is either None, or the hash details for the path (currently
423
a tuple of the contents sha1 and the statvalue returned by
424
tree.get_file_with_stat()).
426
if self.new_inventory.root is None:
427
if ie.parent_id is not None:
428
raise errors.RootMissing()
429
self._check_root(ie, parent_invs, tree)
430
if ie.revision is None:
431
kind = content_summary[0]
433
# ie is carried over from a prior commit
435
# XXX: repository specific check for nested tree support goes here - if
436
# the repo doesn't want nested trees we skip it ?
437
if (kind == 'tree-reference' and
438
not self.repository._format.supports_tree_reference):
439
# mismatch between commit builder logic and repository:
440
# this needs the entry creation pushed down into the builder.
441
raise NotImplementedError('Missing repository subtree support.')
442
self.new_inventory.add(ie)
444
# TODO: slow, take it out of the inner loop.
446
basis_inv = parent_invs[0]
448
basis_inv = Inventory(root_id=None)
450
# ie.revision is always None if the InventoryEntry is considered
451
# for committing. We may record the previous parents revision if the
452
# content is actually unchanged against a sole head.
453
if ie.revision is not None:
454
if not self._versioned_root and path == '':
455
# repositories that do not version the root set the root's
456
# revision to the new commit even when no change occurs (more
457
# specifically, they do not record a revision on the root; and
458
# the rev id is assigned to the root during deserialisation -
459
# this masks when a change may have occurred against the basis.
460
# To match this we always issue a delta, because the revision
461
# of the root will always be changing.
462
if ie.file_id in basis_inv:
463
delta = (basis_inv.id2path(ie.file_id), path,
467
delta = (None, path, ie.file_id, ie)
468
self._basis_delta.append(delta)
469
return delta, False, None
471
# we don't need to commit this, because the caller already
472
# determined that an existing revision of this file is
473
# appropriate. If it's not being considered for committing then
474
# it and all its parents to the root must be unaltered so
475
# no-change against the basis.
476
if ie.revision == self._new_revision_id:
477
raise AssertionError("Impossible situation, a skipped "
478
"inventory entry (%r) claims to be modified in this "
479
"commit (%r).", (ie, self._new_revision_id))
480
return None, False, None
481
# XXX: Friction: parent_candidates should return a list not a dict
482
# so that we don't have to walk the inventories again.
483
parent_candiate_entries = ie.parent_candidates(parent_invs)
484
head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
486
for inv in parent_invs:
487
if ie.file_id in inv:
488
old_rev = inv[ie.file_id].revision
489
if old_rev in head_set:
490
heads.append(inv[ie.file_id].revision)
491
head_set.remove(inv[ie.file_id].revision)
494
# now we check to see if we need to write a new record to the
496
# We write a new entry unless there is one head to the ancestors, and
497
# the kind-derived content is unchanged.
499
# Cheapest check first: no ancestors, or more the one head in the
500
# ancestors, we write a new node.
504
# There is a single head, look it up for comparison
505
parent_entry = parent_candiate_entries[heads[0]]
506
# if the non-content specific data has changed, we'll be writing a
508
if (parent_entry.parent_id != ie.parent_id or
509
parent_entry.name != ie.name):
511
# now we need to do content specific checks:
513
# if the kind changed the content obviously has
514
if kind != parent_entry.kind:
516
# Stat cache fingerprint feedback for the caller - None as we usually
517
# don't generate one.
520
if content_summary[2] is None:
521
raise ValueError("Files must not have executable = None")
523
# We can't trust a check of the file length because of content
525
if (# if the exec bit has changed we have to store:
526
parent_entry.executable != content_summary[2]):
528
elif parent_entry.text_sha1 == content_summary[3]:
529
# all meta and content is unchanged (using a hash cache
530
# hit to check the sha)
531
ie.revision = parent_entry.revision
532
ie.text_size = parent_entry.text_size
533
ie.text_sha1 = parent_entry.text_sha1
534
ie.executable = parent_entry.executable
535
return self._get_delta(ie, basis_inv, path), False, None
537
# Either there is only a hash change(no hash cache entry,
538
# or same size content change), or there is no change on
540
# Provide the parent's hash to the store layer, so that the
541
# content is unchanged we will not store a new node.
542
nostore_sha = parent_entry.text_sha1
544
# We want to record a new node regardless of the presence or
545
# absence of a content change in the file.
547
ie.executable = content_summary[2]
548
file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
550
text = file_obj.read()
554
ie.text_sha1, ie.text_size = self._add_text_to_weave(
555
ie.file_id, text, heads, nostore_sha)
556
# Let the caller know we generated a stat fingerprint.
557
fingerprint = (ie.text_sha1, stat_value)
558
except errors.ExistingContent:
559
# Turns out that the file content was unchanged, and we were
560
# only going to store a new node if it was changed. Carry over
562
ie.revision = parent_entry.revision
563
ie.text_size = parent_entry.text_size
564
ie.text_sha1 = parent_entry.text_sha1
565
ie.executable = parent_entry.executable
566
return self._get_delta(ie, basis_inv, path), False, None
567
elif kind == 'directory':
569
# all data is meta here, nothing specific to directory, so
571
ie.revision = parent_entry.revision
572
return self._get_delta(ie, basis_inv, path), False, None
573
self._add_text_to_weave(ie.file_id, '', heads, None)
574
elif kind == 'symlink':
575
current_link_target = content_summary[3]
577
# symlink target is not generic metadata, check if it has
579
if current_link_target != parent_entry.symlink_target:
582
# unchanged, carry over.
583
ie.revision = parent_entry.revision
584
ie.symlink_target = parent_entry.symlink_target
585
return self._get_delta(ie, basis_inv, path), False, None
586
ie.symlink_target = current_link_target
587
self._add_text_to_weave(ie.file_id, '', heads, None)
588
elif kind == 'tree-reference':
590
if content_summary[3] != parent_entry.reference_revision:
593
# unchanged, carry over.
594
ie.reference_revision = parent_entry.reference_revision
595
ie.revision = parent_entry.revision
596
return self._get_delta(ie, basis_inv, path), False, None
597
ie.reference_revision = content_summary[3]
598
if ie.reference_revision is None:
599
raise AssertionError("invalid content_summary for nested tree: %r"
600
% (content_summary,))
601
self._add_text_to_weave(ie.file_id, '', heads, None)
603
raise NotImplementedError('unknown kind')
604
ie.revision = self._new_revision_id
605
self._any_changes = True
606
return self._get_delta(ie, basis_inv, path), True, fingerprint
608
def record_iter_changes(self, tree, basis_revision_id, iter_changes,
609
_entry_factory=entry_factory):
208
610
"""Record a new tree via iter_changes.
210
612
:param tree: The tree to obtain text contents from for changed objects.
215
617
to basis_revision_id. The iterator must not include any items with
216
618
a current kind of None - missing items must be either filtered out
217
619
or errored-on beefore record_iter_changes sees the item.
620
:param _entry_factory: Private method to bind entry_factory locally for
218
622
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
219
623
tree._observed_sha1.
221
raise NotImplementedError(self.record_iter_changes)
625
# Create an inventory delta based on deltas between all the parents and
626
# deltas between all the parent inventories. We use inventory delta's
627
# between the inventory objects because iter_changes masks
628
# last-changed-field only changes.
630
# file_id -> change map, change is fileid, paths, changed, versioneds,
631
# parents, names, kinds, executables
633
# {file_id -> revision_id -> inventory entry, for entries in parent
634
# trees that are not parents[0]
638
revtrees = list(self.repository.revision_trees(self.parents))
639
except errors.NoSuchRevision:
640
# one or more ghosts, slow path.
642
for revision_id in self.parents:
644
revtrees.append(self.repository.revision_tree(revision_id))
645
except errors.NoSuchRevision:
647
basis_revision_id = _mod_revision.NULL_REVISION
649
revtrees.append(self.repository.revision_tree(
650
_mod_revision.NULL_REVISION))
651
# The basis inventory from a repository
653
basis_inv = revtrees[0].inventory
655
basis_inv = self.repository.revision_tree(
656
_mod_revision.NULL_REVISION).inventory
657
if len(self.parents) > 0:
658
if basis_revision_id != self.parents[0] and not ghost_basis:
660
"arbitrary basis parents not yet supported with merges")
661
for revtree in revtrees[1:]:
662
for change in revtree.inventory._make_delta(basis_inv):
663
if change[1] is None:
664
# Not present in this parent.
666
if change[2] not in merged_ids:
667
if change[0] is not None:
668
basis_entry = basis_inv[change[2]]
669
merged_ids[change[2]] = [
671
basis_entry.revision,
674
parent_entries[change[2]] = {
676
basis_entry.revision:basis_entry,
678
change[3].revision:change[3],
681
merged_ids[change[2]] = [change[3].revision]
682
parent_entries[change[2]] = {change[3].revision:change[3]}
684
merged_ids[change[2]].append(change[3].revision)
685
parent_entries[change[2]][change[3].revision] = change[3]
688
# Setup the changes from the tree:
689
# changes maps file_id -> (change, [parent revision_ids])
691
for change in iter_changes:
692
# This probably looks up in basis_inv way to much.
693
if change[1][0] is not None:
694
head_candidate = [basis_inv[change[0]].revision]
697
changes[change[0]] = change, merged_ids.get(change[0],
699
unchanged_merged = set(merged_ids) - set(changes)
700
# Extend the changes dict with synthetic changes to record merges of
702
for file_id in unchanged_merged:
703
# Record a merged version of these items that did not change vs the
704
# basis. This can be either identical parallel changes, or a revert
705
# of a specific file after a merge. The recorded content will be
706
# that of the current tree (which is the same as the basis), but
707
# the per-file graph will reflect a merge.
708
# NB:XXX: We are reconstructing path information we had, this
709
# should be preserved instead.
710
# inv delta change: (file_id, (path_in_source, path_in_target),
711
# changed_content, versioned, parent, name, kind,
714
basis_entry = basis_inv[file_id]
715
except errors.NoSuchId:
716
# a change from basis->some_parents but file_id isn't in basis
717
# so was new in the merge, which means it must have changed
718
# from basis -> current, and as it hasn't the add was reverted
719
# by the user. So we discard this change.
723
(basis_inv.id2path(file_id), tree.id2path(file_id)),
725
(basis_entry.parent_id, basis_entry.parent_id),
726
(basis_entry.name, basis_entry.name),
727
(basis_entry.kind, basis_entry.kind),
728
(basis_entry.executable, basis_entry.executable))
729
changes[file_id] = (change, merged_ids[file_id])
730
# changes contains tuples with the change and a set of inventory
731
# candidates for the file.
733
# old_path, new_path, file_id, new_inventory_entry
734
seen_root = False # Is the root in the basis delta?
735
inv_delta = self._basis_delta
736
modified_rev = self._new_revision_id
737
for change, head_candidates in changes.values():
738
if change[3][1]: # versioned in target.
739
# Several things may be happening here:
740
# We may have a fork in the per-file graph
741
# - record a change with the content from tree
742
# We may have a change against < all trees
743
# - carry over the tree that hasn't changed
744
# We may have a change against all trees
745
# - record the change with the content from tree
748
entry = _entry_factory[kind](file_id, change[5][1],
750
head_set = self._heads(change[0], set(head_candidates))
753
for head_candidate in head_candidates:
754
if head_candidate in head_set:
755
heads.append(head_candidate)
756
head_set.remove(head_candidate)
759
# Could be a carry-over situation:
760
parent_entry_revs = parent_entries.get(file_id, None)
761
if parent_entry_revs:
762
parent_entry = parent_entry_revs.get(heads[0], None)
765
if parent_entry is None:
766
# The parent iter_changes was called against is the one
767
# that is the per-file head, so any change is relevant
768
# iter_changes is valid.
769
carry_over_possible = False
771
# could be a carry over situation
772
# A change against the basis may just indicate a merge,
773
# we need to check the content against the source of the
774
# merge to determine if it was changed after the merge
776
if (parent_entry.kind != entry.kind or
777
parent_entry.parent_id != entry.parent_id or
778
parent_entry.name != entry.name):
779
# Metadata common to all entries has changed
780
# against per-file parent
781
carry_over_possible = False
783
carry_over_possible = True
784
# per-type checks for changes against the parent_entry
787
# Cannot be a carry-over situation
788
carry_over_possible = False
789
# Populate the entry in the delta
791
# XXX: There is still a small race here: If someone reverts the content of a file
792
# after iter_changes examines and decides it has changed,
793
# we will unconditionally record a new version even if some
794
# other process reverts it while commit is running (with
795
# the revert happening after iter_changes did its
798
entry.executable = True
800
entry.executable = False
801
if (carry_over_possible and
802
parent_entry.executable == entry.executable):
803
# Check the file length, content hash after reading
805
nostore_sha = parent_entry.text_sha1
808
file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
810
text = file_obj.read()
814
entry.text_sha1, entry.text_size = self._add_text_to_weave(
815
file_id, text, heads, nostore_sha)
816
yield file_id, change[1][1], (entry.text_sha1, stat_value)
817
except errors.ExistingContent:
818
# No content change against a carry_over parent
819
# Perhaps this should also yield a fs hash update?
821
entry.text_size = parent_entry.text_size
822
entry.text_sha1 = parent_entry.text_sha1
823
elif kind == 'symlink':
825
entry.symlink_target = tree.get_symlink_target(file_id)
826
if (carry_over_possible and
827
parent_entry.symlink_target == entry.symlink_target):
830
self._add_text_to_weave(change[0], '', heads, None)
831
elif kind == 'directory':
832
if carry_over_possible:
835
# Nothing to set on the entry.
836
# XXX: split into the Root and nonRoot versions.
837
if change[1][1] != '' or self.repository.supports_rich_root():
838
self._add_text_to_weave(change[0], '', heads, None)
839
elif kind == 'tree-reference':
840
if not self.repository._format.supports_tree_reference:
841
# This isn't quite sane as an error, but we shouldn't
842
# ever see this code path in practice: tree's don't
843
# permit references when the repo doesn't support tree
845
raise errors.UnsupportedOperation(tree.add_reference,
847
reference_revision = tree.get_reference_revision(change[0])
848
entry.reference_revision = reference_revision
849
if (carry_over_possible and
850
parent_entry.reference_revision == reference_revision):
853
self._add_text_to_weave(change[0], '', heads, None)
855
raise AssertionError('unknown kind %r' % kind)
857
entry.revision = modified_rev
859
entry.revision = parent_entry.revision
862
new_path = change[1][1]
863
inv_delta.append((change[1][0], new_path, change[0], entry))
866
self.new_inventory = None
868
# This should perhaps be guarded by a check that the basis we
869
# commit against is the basis for the commit and if not do a delta
871
self._any_changes = True
873
# housekeeping root entry changes do not affect no-change commits.
874
self._require_root_change(tree)
875
self.basis_delta_revision = basis_revision_id
877
def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
878
parent_keys = tuple([(file_id, parent) for parent in parents])
879
return self.repository.texts._add_text(
880
(file_id, self._new_revision_id), parent_keys, new_text,
881
nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
884
class RootCommitBuilder(CommitBuilder):
885
"""This commitbuilder actually records the root id"""
887
# the root entry gets versioned properly by this builder.
888
_versioned_root = True
890
def _check_root(self, ie, parent_invs, tree):
891
"""Helper for record_entry_contents.
893
:param ie: An entry being added.
894
:param parent_invs: The inventories of the parent revisions of the
896
:param tree: The tree that is being committed.
899
def _require_root_change(self, tree):
900
"""Enforce an appropriate root object change.
902
This is called once when record_iter_changes is called, if and only if
903
the root was not in the delta calculated by record_iter_changes.
905
:param tree: The tree which is being committed.
907
# versioned roots do not change unless the tree found a change.
224
910
class RepositoryWriteLockResult(LogicalLockResult):
313
1059
return InterRepository._assert_same_model(self, repository)
1061
def add_inventory(self, revision_id, inv, parents):
1062
"""Add the inventory inv to the repository as revision_id.
1064
:param parents: The revision ids of the parents that revision_id
1065
is known to have and are in the repository already.
1067
:returns: The validator(which is a sha1 digest, though what is sha'd is
1068
repository format specific) of the serialized inventory.
1070
if not self.is_in_write_group():
1071
raise AssertionError("%r not in write group" % (self,))
1072
_mod_revision.check_not_reserved_id(revision_id)
1073
if not (inv.revision_id is None or inv.revision_id == revision_id):
1074
raise AssertionError(
1075
"Mismatch between inventory revision"
1076
" id and insertion revid (%r, %r)"
1077
% (inv.revision_id, revision_id))
1078
if inv.root is None:
1079
raise errors.RootMissing()
1080
return self._add_inventory_checked(revision_id, inv, parents)
1082
def _add_inventory_checked(self, revision_id, inv, parents):
1083
"""Add inv to the repository after checking the inputs.
1085
This function can be overridden to allow different inventory styles.
1087
:seealso: add_inventory, for the contract.
1089
inv_lines = self._serializer.write_inventory_to_lines(inv)
1090
return self._inventory_add_lines(revision_id, parents,
1091
inv_lines, check_content=False)
1093
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1094
parents, basis_inv=None, propagate_caches=False):
1095
"""Add a new inventory expressed as a delta against another revision.
1097
See the inventory developers documentation for the theory behind
1100
:param basis_revision_id: The inventory id the delta was created
1101
against. (This does not have to be a direct parent.)
1102
:param delta: The inventory delta (see Inventory.apply_delta for
1104
:param new_revision_id: The revision id that the inventory is being
1106
:param parents: The revision ids of the parents that revision_id is
1107
known to have and are in the repository already. These are supplied
1108
for repositories that depend on the inventory graph for revision
1109
graph access, as well as for those that pun ancestry with delta
1111
:param basis_inv: The basis inventory if it is already known,
1113
:param propagate_caches: If True, the caches for this inventory are
1114
copied to and updated for the result if possible.
1116
:returns: (validator, new_inv)
1117
The validator(which is a sha1 digest, though what is sha'd is
1118
repository format specific) of the serialized inventory, and the
1119
resulting inventory.
1121
if not self.is_in_write_group():
1122
raise AssertionError("%r not in write group" % (self,))
1123
_mod_revision.check_not_reserved_id(new_revision_id)
1124
basis_tree = self.revision_tree(basis_revision_id)
1125
basis_tree.lock_read()
1127
# Note that this mutates the inventory of basis_tree, which not all
1128
# inventory implementations may support: A better idiom would be to
1129
# return a new inventory, but as there is no revision tree cache in
1130
# repository this is safe for now - RBC 20081013
1131
if basis_inv is None:
1132
basis_inv = basis_tree.inventory
1133
basis_inv.apply_delta(delta)
1134
basis_inv.revision_id = new_revision_id
1135
return (self.add_inventory(new_revision_id, basis_inv, parents),
1140
def _inventory_add_lines(self, revision_id, parents, lines,
1141
check_content=True):
1142
"""Store lines in inv_vf and return the sha1 of the inventory."""
1143
parents = [(parent,) for parent in parents]
1144
result = self.inventories.add_lines((revision_id,), parents, lines,
1145
check_content=check_content)[0]
1146
self.inventories._access.flush()
1149
def add_revision(self, revision_id, rev, inv=None, config=None):
1150
"""Add rev to the revision store as revision_id.
1152
:param revision_id: the revision id to use.
1153
:param rev: The revision object.
1154
:param inv: The inventory for the revision. if None, it will be looked
1155
up in the inventory storer
1156
:param config: If None no digital signature will be created.
1157
If supplied its signature_needed method will be used
1158
to determine if a signature should be made.
1160
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
1162
_mod_revision.check_not_reserved_id(revision_id)
1163
if config is not None and config.signature_needed():
1165
inv = self.get_inventory(revision_id)
1166
tree = InventoryRevisionTree(self, inv, revision_id)
1167
testament = Testament(rev, tree)
1168
plaintext = testament.as_short_text()
1169
self.store_revision_signature(
1170
gpg.GPGStrategy(config), plaintext, revision_id)
1171
# check inventory present
1172
if not self.inventories.get_parent_map([(revision_id,)]):
1174
raise errors.WeaveRevisionNotPresent(revision_id,
1177
# yes, this is not suitable for adding with ghosts.
1178
rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1181
key = (revision_id,)
1182
rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1183
self._add_revision(rev)
1185
def _add_revision(self, revision):
1186
text = self._serializer.write_revision_to_string(revision)
1187
key = (revision.revision_id,)
1188
parents = tuple((parent,) for parent in revision.parent_ids)
1189
self.revisions.add_lines(key, parents, osutils.split_lines(text))
315
1191
def all_revision_ids(self):
316
1192
"""Returns a list of all the revision ids in the repository.
341
1217
self.control_files.break_lock()
1220
def _eliminate_revisions_not_present(self, revision_ids):
1221
"""Check every revision id in revision_ids to see if we have it.
1223
Returns a set of the present revisions.
1226
graph = self.get_graph()
1227
parent_map = graph.get_parent_map(revision_ids)
1228
# The old API returned a list, should this actually be a set?
1229
return parent_map.keys()
1231
def _check_inventories(self, checker):
1232
"""Check the inventories found from the revision scan.
1234
This is responsible for verifying the sha1 of inventories and
1235
creating a pending_keys set that covers data referenced by inventories.
1237
bar = ui.ui_factory.nested_progress_bar()
1239
self._do_check_inventories(checker, bar)
1243
def _do_check_inventories(self, checker, bar):
1244
"""Helper for _check_inventories."""
1246
keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1247
kinds = ['chk_bytes', 'texts']
1248
count = len(checker.pending_keys)
1249
bar.update("inventories", 0, 2)
1250
current_keys = checker.pending_keys
1251
checker.pending_keys = {}
1252
# Accumulate current checks.
1253
for key in current_keys:
1254
if key[0] != 'inventories' and key[0] not in kinds:
1255
checker._report_items.append('unknown key type %r' % (key,))
1256
keys[key[0]].add(key[1:])
1257
if keys['inventories']:
1258
# NB: output order *should* be roughly sorted - topo or
1259
# inverse topo depending on repository - either way decent
1260
# to just delta against. However, pre-CHK formats didn't
1261
# try to optimise inventory layout on disk. As such the
1262
# pre-CHK code path does not use inventory deltas.
1264
for record in self.inventories.check(keys=keys['inventories']):
1265
if record.storage_kind == 'absent':
1266
checker._report_items.append(
1267
'Missing inventory {%s}' % (record.key,))
1269
last_object = self._check_record('inventories', record,
1270
checker, last_object,
1271
current_keys[('inventories',) + record.key])
1272
del keys['inventories']
1275
bar.update("texts", 1)
1276
while (checker.pending_keys or keys['chk_bytes']
1278
# Something to check.
1279
current_keys = checker.pending_keys
1280
checker.pending_keys = {}
1281
# Accumulate current checks.
1282
for key in current_keys:
1283
if key[0] not in kinds:
1284
checker._report_items.append('unknown key type %r' % (key,))
1285
keys[key[0]].add(key[1:])
1286
# Check the outermost kind only - inventories || chk_bytes || texts
1290
for record in getattr(self, kind).check(keys=keys[kind]):
1291
if record.storage_kind == 'absent':
1292
checker._report_items.append(
1293
'Missing %s {%s}' % (kind, record.key,))
1295
last_object = self._check_record(kind, record,
1296
checker, last_object, current_keys[(kind,) + record.key])
1300
def _check_record(self, kind, record, checker, last_object, item_data):
1301
"""Check a single text from this repository."""
1302
if kind == 'inventories':
1303
rev_id = record.key[0]
1304
inv = self._deserialise_inventory(rev_id,
1305
record.get_bytes_as('fulltext'))
1306
if last_object is not None:
1307
delta = inv._make_delta(last_object)
1308
for old_path, path, file_id, ie in delta:
1311
ie.check(checker, rev_id, inv)
1313
for path, ie in inv.iter_entries():
1314
ie.check(checker, rev_id, inv)
1315
if self._format.fast_deltas:
1317
elif kind == 'chk_bytes':
1318
# No code written to check chk_bytes for this repo format.
1319
checker._report_items.append(
1320
'unsupported key type chk_bytes for %s' % (record.key,))
1321
elif kind == 'texts':
1322
self._check_text(record, checker, item_data)
1324
checker._report_items.append(
1325
'unknown key type %s for %s' % (kind, record.key))
1327
def _check_text(self, record, checker, item_data):
1328
"""Check a single text."""
1329
# Check it is extractable.
1330
# TODO: check length.
1331
if record.storage_kind == 'chunked':
1332
chunks = record.get_bytes_as(record.storage_kind)
1333
sha1 = osutils.sha_strings(chunks)
1334
length = sum(map(len, chunks))
1336
content = record.get_bytes_as('fulltext')
1337
sha1 = osutils.sha_string(content)
1338
length = len(content)
1339
if item_data and sha1 != item_data[1]:
1340
checker._report_items.append(
1341
'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1342
(record.key, sha1, item_data[1], item_data[2]))
344
1345
def create(a_bzrdir):
345
1346
"""Construct the current default format repository in a_bzrdir."""
951
2166
uniquely identify the file version in the caller's context. (Examples:
952
2167
an index number or a TreeTransform trans_id.)
2169
bytes_iterator is an iterable of bytestrings for the file. The
2170
kind of iterable and length of the bytestrings are unspecified, but for
2171
this implementation, it is a list of bytes produced by
2172
VersionedFile.get_record_stream().
954
2174
:param desired_files: a list of (file_id, revision_id, identifier)
957
raise NotImplementedError(self.iter_files_bytes)
2178
for file_id, revision_id, callable_data in desired_files:
2179
text_keys[(file_id, revision_id)] = callable_data
2180
for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2181
if record.storage_kind == 'absent':
2182
raise errors.RevisionNotPresent(record.key, self)
2183
yield text_keys[record.key], record.get_bytes_as('chunked')
2185
def _generate_text_key_index(self, text_key_references=None,
2187
"""Generate a new text key index for the repository.
2189
This is an expensive function that will take considerable time to run.
2191
:return: A dict mapping text keys ((file_id, revision_id) tuples) to a
2192
list of parents, also text keys. When a given key has no parents,
2193
the parents list will be [NULL_REVISION].
2195
# All revisions, to find inventory parents.
2196
if ancestors is None:
2197
graph = self.get_graph()
2198
ancestors = graph.get_parent_map(self.all_revision_ids())
2199
if text_key_references is None:
2200
text_key_references = self.find_text_key_references()
2201
pb = ui.ui_factory.nested_progress_bar()
2203
return self._do_generate_text_key_index(ancestors,
2204
text_key_references, pb)
2208
def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
2209
"""Helper for _generate_text_key_index to avoid deep nesting."""
2210
revision_order = tsort.topo_sort(ancestors)
2211
invalid_keys = set()
2213
for revision_id in revision_order:
2214
revision_keys[revision_id] = set()
2215
text_count = len(text_key_references)
2216
# a cache of the text keys to allow reuse; costs a dict of all the
2217
# keys, but saves a 2-tuple for every child of a given key.
2219
for text_key, valid in text_key_references.iteritems():
2221
invalid_keys.add(text_key)
2223
revision_keys[text_key[1]].add(text_key)
2224
text_key_cache[text_key] = text_key
2225
del text_key_references
2227
text_graph = graph.Graph(graph.DictParentsProvider(text_index))
2228
NULL_REVISION = _mod_revision.NULL_REVISION
2229
# Set a cache with a size of 10 - this suffices for bzr.dev but may be
2230
# too small for large or very branchy trees. However, for 55K path
2231
# trees, it would be easy to use too much memory trivially. Ideally we
2232
# could gauge this by looking at available real memory etc, but this is
2233
# always a tricky proposition.
2234
inventory_cache = lru_cache.LRUCache(10)
2235
batch_size = 10 # should be ~150MB on a 55K path tree
2236
batch_count = len(revision_order) / batch_size + 1
2238
pb.update("Calculating text parents", processed_texts, text_count)
2239
for offset in xrange(batch_count):
2240
to_query = revision_order[offset * batch_size:(offset + 1) *
2244
for revision_id in to_query:
2245
parent_ids = ancestors[revision_id]
2246
for text_key in revision_keys[revision_id]:
2247
pb.update("Calculating text parents", processed_texts)
2248
processed_texts += 1
2249
candidate_parents = []
2250
for parent_id in parent_ids:
2251
parent_text_key = (text_key[0], parent_id)
2253
check_parent = parent_text_key not in \
2254
revision_keys[parent_id]
2256
# the parent parent_id is a ghost:
2257
check_parent = False
2258
# truncate the derived graph against this ghost.
2259
parent_text_key = None
2261
# look at the parent commit details inventories to
2262
# determine possible candidates in the per file graph.
2265
inv = inventory_cache[parent_id]
2267
inv = self.revision_tree(parent_id).inventory
2268
inventory_cache[parent_id] = inv
2270
parent_entry = inv[text_key[0]]
2271
except (KeyError, errors.NoSuchId):
2273
if parent_entry is not None:
2275
text_key[0], parent_entry.revision)
2277
parent_text_key = None
2278
if parent_text_key is not None:
2279
candidate_parents.append(
2280
text_key_cache[parent_text_key])
2281
parent_heads = text_graph.heads(candidate_parents)
2282
new_parents = list(parent_heads)
2283
new_parents.sort(key=lambda x:candidate_parents.index(x))
2284
if new_parents == []:
2285
new_parents = [NULL_REVISION]
2286
text_index[text_key] = new_parents
2288
for text_key in invalid_keys:
2289
text_index[text_key] = [NULL_REVISION]
2292
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2293
"""Get an iterable listing the keys of all the data introduced by a set
2296
The keys will be ordered so that the corresponding items can be safely
2297
fetched and inserted in that order.
2299
:returns: An iterable producing tuples of (knit-kind, file-id,
2300
versions). knit-kind is one of 'file', 'inventory', 'signatures',
2301
'revisions'. file-id is None unless knit-kind is 'file'.
2303
for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2306
for result in self._find_non_file_keys_to_fetch(revision_ids):
2309
def _find_file_keys_to_fetch(self, revision_ids, pb):
2310
# XXX: it's a bit weird to control the inventory weave caching in this
2311
# generator. Ideally the caching would be done in fetch.py I think. Or
2312
# maybe this generator should explicitly have the contract that it
2313
# should not be iterated until the previously yielded item has been
2315
inv_w = self.inventories
2317
# file ids that changed
2318
file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2320
num_file_ids = len(file_ids)
2321
for file_id, altered_versions in file_ids.iteritems():
2323
pb.update("Fetch texts", count, num_file_ids)
2325
yield ("file", file_id, altered_versions)
2327
def _find_non_file_keys_to_fetch(self, revision_ids):
2329
yield ("inventory", None, revision_ids)
2332
# XXX: Note ATM no callers actually pay attention to this return
2333
# instead they just use the list of revision ids and ignore
2334
# missing sigs. Consider removing this work entirely
2335
revisions_with_signatures = set(self.signatures.get_parent_map(
2336
[(r,) for r in revision_ids]))
2337
revisions_with_signatures = set(
2338
[r for (r,) in revisions_with_signatures])
2339
revisions_with_signatures.intersection_update(revision_ids)
2340
yield ("signatures", None, revisions_with_signatures)
2343
yield ("revisions", None, revision_ids)
2346
def get_inventory(self, revision_id):
2347
"""Get Inventory object by revision id."""
2348
return self.iter_inventories([revision_id]).next()
2350
def iter_inventories(self, revision_ids, ordering=None):
2351
"""Get many inventories by revision_ids.
2353
This will buffer some or all of the texts used in constructing the
2354
inventories in memory, but will only parse a single inventory at a
2357
:param revision_ids: The expected revision ids of the inventories.
2358
:param ordering: optional ordering, e.g. 'topological'. If not
2359
specified, the order of revision_ids will be preserved (by
2360
buffering if necessary).
2361
:return: An iterator of inventories.
2363
if ((None in revision_ids)
2364
or (_mod_revision.NULL_REVISION in revision_ids)):
2365
raise ValueError('cannot get null revision inventory')
2366
return self._iter_inventories(revision_ids, ordering)
2368
def _iter_inventories(self, revision_ids, ordering):
2369
"""single-document based inventory iteration."""
2370
inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2371
for text, revision_id in inv_xmls:
2372
yield self._deserialise_inventory(revision_id, text)
2374
def _iter_inventory_xmls(self, revision_ids, ordering):
2375
if ordering is None:
2376
order_as_requested = True
2377
ordering = 'unordered'
2379
order_as_requested = False
2380
keys = [(revision_id,) for revision_id in revision_ids]
2383
if order_as_requested:
2384
key_iter = iter(keys)
2385
next_key = key_iter.next()
2386
stream = self.inventories.get_record_stream(keys, ordering, True)
2388
for record in stream:
2389
if record.storage_kind != 'absent':
2390
chunks = record.get_bytes_as('chunked')
2391
if order_as_requested:
2392
text_chunks[record.key] = chunks
2394
yield ''.join(chunks), record.key[-1]
2396
raise errors.NoSuchRevision(self, record.key)
2397
if order_as_requested:
2398
# Yield as many results as we can while preserving order.
2399
while next_key in text_chunks:
2400
chunks = text_chunks.pop(next_key)
2401
yield ''.join(chunks), next_key[-1]
2403
next_key = key_iter.next()
2404
except StopIteration:
2405
# We still want to fully consume the get_record_stream,
2406
# just in case it is not actually finished at this point
2410
def _deserialise_inventory(self, revision_id, xml):
2411
"""Transform the xml into an inventory object.
2413
:param revision_id: The expected revision id of the inventory.
2414
:param xml: A serialised inventory.
2416
result = self._serializer.read_inventory_from_string(xml, revision_id,
2417
entry_cache=self._inventory_entry_cache,
2418
return_from_cache=self._safe_to_return_from_cache)
2419
if result.revision_id != revision_id:
2420
raise AssertionError('revision id mismatch %s != %s' % (
2421
result.revision_id, revision_id))
2424
def get_serializer_format(self):
2425
return self._serializer.format_num
2428
def _get_inventory_xml(self, revision_id):
2429
"""Get serialized inventory as a string."""
2430
texts = self._iter_inventory_xmls([revision_id], 'unordered')
2432
text, revision_id = texts.next()
2433
except StopIteration:
2434
raise errors.HistoryMissing(self, 'inventory', revision_id)
959
2437
def get_rev_id_for_revno(self, revno, known_pair):
960
2438
"""Return the revision id of a revno, given a later (revno, revid)
1277
2773
except UnicodeDecodeError:
1278
2774
raise errors.NonAsciiRevisionId(method, self)
2776
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2777
"""Find revisions with different parent lists in the revision object
2778
and in the index graph.
2780
:param revisions_iterator: None, or an iterator of (revid,
2781
Revision-or-None). This iterator controls the revisions checked.
2782
:returns: an iterator yielding tuples of (revison-id, parents-in-index,
2783
parents-in-revision).
2785
if not self.is_locked():
2786
raise AssertionError()
2788
if revisions_iterator is None:
2789
revisions_iterator = self._iter_revisions(None)
2790
for revid, revision in revisions_iterator:
2791
if revision is None:
2793
parent_map = vf.get_parent_map([(revid,)])
2794
parents_according_to_index = tuple(parent[-1] for parent in
2795
parent_map[(revid,)])
2796
parents_according_to_revision = tuple(revision.parent_ids)
2797
if parents_according_to_index != parents_according_to_revision:
2798
yield (revid, parents_according_to_index,
2799
parents_according_to_revision)
2801
def _check_for_inconsistent_revision_parents(self):
2802
inconsistencies = list(self._find_inconsistent_revision_parents())
2804
raise errors.BzrCheckError(
2805
"Revision knit has inconsistent parents.")
2808
def install_revision(repository, rev, revision_tree):
2809
"""Install all revision data into a repository."""
2810
install_revisions(repository, [(rev, revision_tree, None)])
2813
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2814
"""Install all revision data into a repository.
2816
Accepts an iterable of revision, tree, signature tuples. The signature
2819
repository.start_write_group()
2821
inventory_cache = lru_cache.LRUCache(10)
2822
for n, (revision, revision_tree, signature) in enumerate(iterable):
2823
_install_revision(repository, revision, revision_tree, signature,
2826
pb.update('Transferring revisions', n + 1, num_revisions)
2828
repository.abort_write_group()
2831
repository.commit_write_group()
2834
def _install_revision(repository, rev, revision_tree, signature,
2836
"""Install all revision data into a repository."""
2837
present_parents = []
2839
for p_id in rev.parent_ids:
2840
if repository.has_revision(p_id):
2841
present_parents.append(p_id)
2842
parent_trees[p_id] = repository.revision_tree(p_id)
2844
parent_trees[p_id] = repository.revision_tree(
2845
_mod_revision.NULL_REVISION)
2847
inv = revision_tree.inventory
2848
entries = inv.iter_entries()
2849
# backwards compatibility hack: skip the root id.
2850
if not repository.supports_rich_root():
2851
path, root = entries.next()
2852
if root.revision != rev.revision_id:
2853
raise errors.IncompatibleRevision(repr(repository))
2855
for path, ie in entries:
2856
text_keys[(ie.file_id, ie.revision)] = ie
2857
text_parent_map = repository.texts.get_parent_map(text_keys)
2858
missing_texts = set(text_keys) - set(text_parent_map)
2859
# Add the texts that are not already present
2860
for text_key in missing_texts:
2861
ie = text_keys[text_key]
2863
# FIXME: TODO: The following loop overlaps/duplicates that done by
2864
# commit to determine parents. There is a latent/real bug here where
2865
# the parents inserted are not those commit would do - in particular
2866
# they are not filtered by heads(). RBC, AB
2867
for revision, tree in parent_trees.iteritems():
2868
if ie.file_id not in tree:
2870
parent_id = tree.get_file_revision(ie.file_id)
2871
if parent_id in text_parents:
2873
text_parents.append((ie.file_id, parent_id))
2874
lines = revision_tree.get_file(ie.file_id).readlines()
2875
repository.texts.add_lines(text_key, text_parents, lines)
2877
# install the inventory
2878
if repository._format._commit_inv_deltas and len(rev.parent_ids):
2879
# Cache this inventory
2880
inventory_cache[rev.revision_id] = inv
2882
basis_inv = inventory_cache[rev.parent_ids[0]]
2884
repository.add_inventory(rev.revision_id, inv, present_parents)
2886
delta = inv._make_delta(basis_inv)
2887
repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2888
rev.revision_id, present_parents)
2890
repository.add_inventory(rev.revision_id, inv, present_parents)
2891
except errors.RevisionAlreadyPresent:
2893
if signature is not None:
2894
repository.add_signature_text(rev.revision_id, signature)
2895
repository.add_revision(rev.revision_id, rev, inv)
1281
2898
class MetaDirRepository(Repository):
1282
2899
"""Repositories in the new meta-dir layout.
1773
3522
"different serializers")
3525
class InterSameDataRepository(InterRepository):
3526
"""Code for converting between repositories that represent the same data.
3528
Data format and model must match for this to work.
3532
def _get_repo_format_to_test(self):
3533
"""Repository format for testing with.
3535
InterSameData can pull from subtree to subtree and from non-subtree to
3536
non-subtree, so we test this with the richest repository format.
3538
from bzrlib.repofmt import knitrepo
3539
return knitrepo.RepositoryFormatKnit3()
3542
def is_compatible(source, target):
3543
return InterRepository._same_model(source, target)
3546
class InterDifferingSerializer(InterRepository):
3549
def _get_repo_format_to_test(self):
3553
def is_compatible(source, target):
3554
"""Be compatible with Knit2 source and Knit3 target"""
3555
# This is redundant with format.check_conversion_target(), however that
3556
# raises an exception, and we just want to say "False" as in we won't
3557
# support converting between these formats.
3558
if 'IDS_never' in debug.debug_flags:
3560
if source.supports_rich_root() and not target.supports_rich_root():
3562
if (source._format.supports_tree_reference
3563
and not target._format.supports_tree_reference):
3565
if target._fallback_repositories and target._format.supports_chks:
3566
# IDS doesn't know how to copy CHKs for the parent inventories it
3567
# adds to stacked repos.
3569
if 'IDS_always' in debug.debug_flags:
3571
# Only use this code path for local source and target. IDS does far
3572
# too much IO (both bandwidth and roundtrips) over a network.
3573
if not source.bzrdir.transport.base.startswith('file:///'):
3575
if not target.bzrdir.transport.base.startswith('file:///'):
3579
def _get_trees(self, revision_ids, cache):
3581
for rev_id in revision_ids:
3583
possible_trees.append((rev_id, cache[rev_id]))
3585
# Not cached, but inventory might be present anyway.
3587
tree = self.source.revision_tree(rev_id)
3588
except errors.NoSuchRevision:
3589
# Nope, parent is ghost.
3592
cache[rev_id] = tree
3593
possible_trees.append((rev_id, tree))
3594
return possible_trees
3596
def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3597
"""Get the best delta and base for this revision.
3599
:return: (basis_id, delta)
3602
# Generate deltas against each tree, to find the shortest.
3603
texts_possibly_new_in_tree = set()
3604
for basis_id, basis_tree in possible_trees:
3605
delta = tree.inventory._make_delta(basis_tree.inventory)
3606
for old_path, new_path, file_id, new_entry in delta:
3607
if new_path is None:
3608
# This file_id isn't present in the new rev, so we don't
3612
# Rich roots are handled elsewhere...
3614
kind = new_entry.kind
3615
if kind != 'directory' and kind != 'file':
3616
# No text record associated with this inventory entry.
3618
# This is a directory or file that has changed somehow.
3619
texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3620
deltas.append((len(delta), basis_id, delta))
3622
return deltas[0][1:]
3624
def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3625
"""Find all parent revisions that are absent, but for which the
3626
inventory is present, and copy those inventories.
3628
This is necessary to preserve correctness when the source is stacked
3629
without fallbacks configured. (Note that in cases like upgrade the
3630
source may be not have _fallback_repositories even though it is
3634
for parents in parent_map.values():
3635
parent_revs.update(parents)
3636
present_parents = self.source.get_parent_map(parent_revs)
3637
absent_parents = set(parent_revs).difference(present_parents)
3638
parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3639
(rev_id,) for rev_id in absent_parents)
3640
parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3641
for parent_tree in self.source.revision_trees(parent_inv_ids):
3642
current_revision_id = parent_tree.get_revision_id()
3643
parents_parents_keys = parent_invs_keys_for_stacking[
3644
(current_revision_id,)]
3645
parents_parents = [key[-1] for key in parents_parents_keys]
3646
basis_id = _mod_revision.NULL_REVISION
3647
basis_tree = self.source.revision_tree(basis_id)
3648
delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3649
self.target.add_inventory_by_delta(
3650
basis_id, delta, current_revision_id, parents_parents)
3651
cache[current_revision_id] = parent_tree
3653
def _fetch_batch(self, revision_ids, basis_id, cache):
3654
"""Fetch across a few revisions.
3656
:param revision_ids: The revisions to copy
3657
:param basis_id: The revision_id of a tree that must be in cache, used
3658
as a basis for delta when no other base is available
3659
:param cache: A cache of RevisionTrees that we can use.
3660
:return: The revision_id of the last converted tree. The RevisionTree
3661
for it will be in cache
3663
# Walk though all revisions; get inventory deltas, copy referenced
3664
# texts that delta references, insert the delta, revision and
3666
root_keys_to_create = set()
3669
pending_revisions = []
3670
parent_map = self.source.get_parent_map(revision_ids)
3671
self._fetch_parent_invs_for_stacking(parent_map, cache)
3672
self.source._safe_to_return_from_cache = True
3673
for tree in self.source.revision_trees(revision_ids):
3674
# Find a inventory delta for this revision.
3675
# Find text entries that need to be copied, too.
3676
current_revision_id = tree.get_revision_id()
3677
parent_ids = parent_map.get(current_revision_id, ())
3678
parent_trees = self._get_trees(parent_ids, cache)
3679
possible_trees = list(parent_trees)
3680
if len(possible_trees) == 0:
3681
# There either aren't any parents, or the parents are ghosts,
3682
# so just use the last converted tree.
3683
possible_trees.append((basis_id, cache[basis_id]))
3684
basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3686
revision = self.source.get_revision(current_revision_id)
3687
pending_deltas.append((basis_id, delta,
3688
current_revision_id, revision.parent_ids))
3689
if self._converting_to_rich_root:
3690
self._revision_id_to_root_id[current_revision_id] = \
3692
# Determine which texts are in present in this revision but not in
3693
# any of the available parents.
3694
texts_possibly_new_in_tree = set()
3695
for old_path, new_path, file_id, entry in delta:
3696
if new_path is None:
3697
# This file_id isn't present in the new rev
3701
if not self.target.supports_rich_root():
3702
# The target doesn't support rich root, so we don't
3705
if self._converting_to_rich_root:
3706
# This can't be copied normally, we have to insert
3708
root_keys_to_create.add((file_id, entry.revision))
3711
texts_possibly_new_in_tree.add((file_id, entry.revision))
3712
for basis_id, basis_tree in possible_trees:
3713
basis_inv = basis_tree.inventory
3714
for file_key in list(texts_possibly_new_in_tree):
3715
file_id, file_revision = file_key
3717
entry = basis_inv[file_id]
3718
except errors.NoSuchId:
3720
if entry.revision == file_revision:
3721
texts_possibly_new_in_tree.remove(file_key)
3722
text_keys.update(texts_possibly_new_in_tree)
3723
pending_revisions.append(revision)
3724
cache[current_revision_id] = tree
3725
basis_id = current_revision_id
3726
self.source._safe_to_return_from_cache = False
3728
from_texts = self.source.texts
3729
to_texts = self.target.texts
3730
if root_keys_to_create:
3731
root_stream = _mod_fetch._new_root_data_stream(
3732
root_keys_to_create, self._revision_id_to_root_id, parent_map,
3734
to_texts.insert_record_stream(root_stream)
3735
to_texts.insert_record_stream(from_texts.get_record_stream(
3736
text_keys, self.target._format._fetch_order,
3737
not self.target._format._fetch_uses_deltas))
3738
# insert inventory deltas
3739
for delta in pending_deltas:
3740
self.target.add_inventory_by_delta(*delta)
3741
if self.target._fallback_repositories:
3742
# Make sure this stacked repository has all the parent inventories
3743
# for the new revisions that we are about to insert. We do this
3744
# before adding the revisions so that no revision is added until
3745
# all the inventories it may depend on are added.
3746
# Note that this is overzealous, as we may have fetched these in an
3749
revision_ids = set()
3750
for revision in pending_revisions:
3751
revision_ids.add(revision.revision_id)
3752
parent_ids.update(revision.parent_ids)
3753
parent_ids.difference_update(revision_ids)
3754
parent_ids.discard(_mod_revision.NULL_REVISION)
3755
parent_map = self.source.get_parent_map(parent_ids)
3756
# we iterate over parent_map and not parent_ids because we don't
3757
# want to try copying any revision which is a ghost
3758
for parent_tree in self.source.revision_trees(parent_map):
3759
current_revision_id = parent_tree.get_revision_id()
3760
parents_parents = parent_map[current_revision_id]
3761
possible_trees = self._get_trees(parents_parents, cache)
3762
if len(possible_trees) == 0:
3763
# There either aren't any parents, or the parents are
3764
# ghosts, so just use the last converted tree.
3765
possible_trees.append((basis_id, cache[basis_id]))
3766
basis_id, delta = self._get_delta_for_revision(parent_tree,
3767
parents_parents, possible_trees)
3768
self.target.add_inventory_by_delta(
3769
basis_id, delta, current_revision_id, parents_parents)
3770
# insert signatures and revisions
3771
for revision in pending_revisions:
3773
signature = self.source.get_signature_text(
3774
revision.revision_id)
3775
self.target.add_signature_text(revision.revision_id,
3777
except errors.NoSuchRevision:
3779
self.target.add_revision(revision.revision_id, revision)
3782
def _fetch_all_revisions(self, revision_ids, pb):
3783
"""Fetch everything for the list of revisions.
3785
:param revision_ids: The list of revisions to fetch. Must be in
3787
:param pb: A ProgressTask
3790
basis_id, basis_tree = self._get_basis(revision_ids[0])
3792
cache = lru_cache.LRUCache(100)
3793
cache[basis_id] = basis_tree
3794
del basis_tree # We don't want to hang on to it here
3798
for offset in range(0, len(revision_ids), batch_size):
3799
self.target.start_write_group()
3801
pb.update('Transferring revisions', offset,
3803
batch = revision_ids[offset:offset+batch_size]
3804
basis_id = self._fetch_batch(batch, basis_id, cache)
3806
self.source._safe_to_return_from_cache = False
3807
self.target.abort_write_group()
3810
hint = self.target.commit_write_group()
3813
if hints and self.target._format.pack_compresses:
3814
self.target.pack(hint=hints)
3815
pb.update('Transferring revisions', len(revision_ids),
3819
def fetch(self, revision_id=None, find_ghosts=False,
3821
"""See InterRepository.fetch()."""
3822
if fetch_spec is not None:
3823
revision_ids = fetch_spec.get_keys()
3826
ui.ui_factory.warn_experimental_format_fetch(self)
3827
if (not self.source.supports_rich_root()
3828
and self.target.supports_rich_root()):
3829
self._converting_to_rich_root = True
3830
self._revision_id_to_root_id = {}
3832
self._converting_to_rich_root = False
3833
# See <https://launchpad.net/bugs/456077> asking for a warning here
3834
if self.source._format.network_name() != self.target._format.network_name():
3835
ui.ui_factory.show_user_warning('cross_format_fetch',
3836
from_format=self.source._format,
3837
to_format=self.target._format)
3838
if revision_ids is None:
3840
search_revision_ids = [revision_id]
3842
search_revision_ids = None
3843
revision_ids = self.target.search_missing_revision_ids(self.source,
3844
revision_ids=search_revision_ids,
3845
find_ghosts=find_ghosts).get_keys()
3846
if not revision_ids:
3848
revision_ids = tsort.topo_sort(
3849
self.source.get_graph().get_parent_map(revision_ids))
3850
if not revision_ids:
3852
# Walk though all revisions; get inventory deltas, copy referenced
3853
# texts that delta references, insert the delta, revision and
3855
pb = ui.ui_factory.nested_progress_bar()
3857
self._fetch_all_revisions(revision_ids, pb)
3860
return len(revision_ids), 0
3862
def _get_basis(self, first_revision_id):
3863
"""Get a revision and tree which exists in the target.
3865
This assumes that first_revision_id is selected for transmission
3866
because all other ancestors are already present. If we can't find an
3867
ancestor we fall back to NULL_REVISION since we know that is safe.
3869
:return: (basis_id, basis_tree)
3871
first_rev = self.source.get_revision(first_revision_id)
3873
basis_id = first_rev.parent_ids[0]
3874
# only valid as a basis if the target has it
3875
self.target.get_revision(basis_id)
3876
# Try to get a basis tree - if it's a ghost it will hit the
3877
# NoSuchRevision case.
3878
basis_tree = self.source.revision_tree(basis_id)
3879
except (IndexError, errors.NoSuchRevision):
3880
basis_id = _mod_revision.NULL_REVISION
3881
basis_tree = self.source.revision_tree(basis_id)
3882
return basis_id, basis_tree
3885
InterRepository.register_optimiser(InterDifferingSerializer)
3886
InterRepository.register_optimiser(InterSameDataRepository)
1776
3889
class CopyConverter(object):
1777
3890
"""A repository conversion tool which just performs a copy of the content.
1832
4009
return revision_graph
4012
class StreamSink(object):
4013
"""An object that can insert a stream into a repository.
4015
This interface handles the complexity of reserialising inventories and
4016
revisions from different formats, and allows unidirectional insertion into
4017
stacked repositories without looking for the missing basis parents
4021
def __init__(self, target_repo):
4022
self.target_repo = target_repo
4024
def insert_stream(self, stream, src_format, resume_tokens):
4025
"""Insert a stream's content into the target repository.
4027
:param src_format: a bzr repository format.
4029
:return: a list of resume tokens and an iterable of keys additional
4030
items required before the insertion can be completed.
4032
self.target_repo.lock_write()
4035
self.target_repo.resume_write_group(resume_tokens)
4038
self.target_repo.start_write_group()
4041
# locked_insert_stream performs a commit|suspend.
4042
missing_keys = self.insert_stream_without_locking(stream,
4043
src_format, is_resume)
4045
# suspend the write group and tell the caller what we is
4046
# missing. We know we can suspend or else we would not have
4047
# entered this code path. (All repositories that can handle
4048
# missing keys can handle suspending a write group).
4049
write_group_tokens = self.target_repo.suspend_write_group()
4050
return write_group_tokens, missing_keys
4051
hint = self.target_repo.commit_write_group()
4052
to_serializer = self.target_repo._format._serializer
4053
src_serializer = src_format._serializer
4054
if (to_serializer != src_serializer and
4055
self.target_repo._format.pack_compresses):
4056
self.target_repo.pack(hint=hint)
4059
self.target_repo.abort_write_group(suppress_errors=True)
4062
self.target_repo.unlock()
4064
def insert_stream_without_locking(self, stream, src_format,
4066
"""Insert a stream's content into the target repository.
4068
This assumes that you already have a locked repository and an active
4071
:param src_format: a bzr repository format.
4072
:param is_resume: Passed down to get_missing_parent_inventories to
4073
indicate if we should be checking for missing texts at the same
4076
:return: A set of keys that are missing.
4078
if not self.target_repo.is_write_locked():
4079
raise errors.ObjectNotLocked(self)
4080
if not self.target_repo.is_in_write_group():
4081
raise errors.BzrError('you must already be in a write group')
4082
to_serializer = self.target_repo._format._serializer
4083
src_serializer = src_format._serializer
4085
if to_serializer == src_serializer:
4086
# If serializers match and the target is a pack repository, set the
4087
# write cache size on the new pack. This avoids poor performance
4088
# on transports where append is unbuffered (such as
4089
# RemoteTransport). This is safe to do because nothing should read
4090
# back from the target repository while a stream with matching
4091
# serialization is being inserted.
4092
# The exception is that a delta record from the source that should
4093
# be a fulltext may need to be expanded by the target (see
4094
# test_fetch_revisions_with_deltas_into_pack); but we take care to
4095
# explicitly flush any buffered writes first in that rare case.
4097
new_pack = self.target_repo._pack_collection._new_pack
4098
except AttributeError:
4099
# Not a pack repository
4102
new_pack.set_write_cache_size(1024*1024)
4103
for substream_type, substream in stream:
4104
if 'stream' in debug.debug_flags:
4105
mutter('inserting substream: %s', substream_type)
4106
if substream_type == 'texts':
4107
self.target_repo.texts.insert_record_stream(substream)
4108
elif substream_type == 'inventories':
4109
if src_serializer == to_serializer:
4110
self.target_repo.inventories.insert_record_stream(
4113
self._extract_and_insert_inventories(
4114
substream, src_serializer)
4115
elif substream_type == 'inventory-deltas':
4116
self._extract_and_insert_inventory_deltas(
4117
substream, src_serializer)
4118
elif substream_type == 'chk_bytes':
4119
# XXX: This doesn't support conversions, as it assumes the
4120
# conversion was done in the fetch code.
4121
self.target_repo.chk_bytes.insert_record_stream(substream)
4122
elif substream_type == 'revisions':
4123
# This may fallback to extract-and-insert more often than
4124
# required if the serializers are different only in terms of
4126
if src_serializer == to_serializer:
4127
self.target_repo.revisions.insert_record_stream(substream)
4129
self._extract_and_insert_revisions(substream,
4131
elif substream_type == 'signatures':
4132
self.target_repo.signatures.insert_record_stream(substream)
4134
raise AssertionError('kaboom! %s' % (substream_type,))
4135
# Done inserting data, and the missing_keys calculations will try to
4136
# read back from the inserted data, so flush the writes to the new pack
4137
# (if this is pack format).
4138
if new_pack is not None:
4139
new_pack._write_data('', flush=True)
4140
# Find all the new revisions (including ones from resume_tokens)
4141
missing_keys = self.target_repo.get_missing_parent_inventories(
4142
check_for_missing_texts=is_resume)
4144
for prefix, versioned_file in (
4145
('texts', self.target_repo.texts),
4146
('inventories', self.target_repo.inventories),
4147
('revisions', self.target_repo.revisions),
4148
('signatures', self.target_repo.signatures),
4149
('chk_bytes', self.target_repo.chk_bytes),
4151
if versioned_file is None:
4153
# TODO: key is often going to be a StaticTuple object
4154
# I don't believe we can define a method by which
4155
# (prefix,) + StaticTuple will work, though we could
4156
# define a StaticTuple.sq_concat that would allow you to
4157
# pass in either a tuple or a StaticTuple as the second
4158
# object, so instead we could have:
4159
# StaticTuple(prefix) + key here...
4160
missing_keys.update((prefix,) + key for key in
4161
versioned_file.get_missing_compression_parent_keys())
4162
except NotImplementedError:
4163
# cannot even attempt suspending, and missing would have failed
4164
# during stream insertion.
4165
missing_keys = set()
4168
def _extract_and_insert_inventory_deltas(self, substream, serializer):
4169
target_rich_root = self.target_repo._format.rich_root_data
4170
target_tree_refs = self.target_repo._format.supports_tree_reference
4171
for record in substream:
4172
# Insert the delta directly
4173
inventory_delta_bytes = record.get_bytes_as('fulltext')
4174
deserialiser = inventory_delta.InventoryDeltaDeserializer()
4176
parse_result = deserialiser.parse_text_bytes(
4177
inventory_delta_bytes)
4178
except inventory_delta.IncompatibleInventoryDelta, err:
4179
mutter("Incompatible delta: %s", err.msg)
4180
raise errors.IncompatibleRevision(self.target_repo._format)
4181
basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4182
revision_id = new_id
4183
parents = [key[0] for key in record.parents]
4184
self.target_repo.add_inventory_by_delta(
4185
basis_id, inv_delta, revision_id, parents)
4187
def _extract_and_insert_inventories(self, substream, serializer,
4189
"""Generate a new inventory versionedfile in target, converting data.
4191
The inventory is retrieved from the source, (deserializing it), and
4192
stored in the target (reserializing it in a different format).
4194
target_rich_root = self.target_repo._format.rich_root_data
4195
target_tree_refs = self.target_repo._format.supports_tree_reference
4196
for record in substream:
4197
# It's not a delta, so it must be a fulltext in the source
4198
# serializer's format.
4199
bytes = record.get_bytes_as('fulltext')
4200
revision_id = record.key[0]
4201
inv = serializer.read_inventory_from_string(bytes, revision_id)
4202
parents = [key[0] for key in record.parents]
4203
self.target_repo.add_inventory(revision_id, inv, parents)
4204
# No need to keep holding this full inv in memory when the rest of
4205
# the substream is likely to be all deltas.
4208
def _extract_and_insert_revisions(self, substream, serializer):
4209
for record in substream:
4210
bytes = record.get_bytes_as('fulltext')
4211
revision_id = record.key[0]
4212
rev = serializer.read_revision_from_string(bytes)
4213
if rev.revision_id != revision_id:
4214
raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4215
self.target_repo.add_revision(revision_id, rev)
4218
if self.target_repo._format._fetch_reconcile:
4219
self.target_repo.reconcile()
4222
class StreamSource(object):
4223
"""A source of a stream for fetching between repositories."""
4225
def __init__(self, from_repository, to_format):
4226
"""Create a StreamSource streaming from from_repository."""
4227
self.from_repository = from_repository
4228
self.to_format = to_format
4229
self._record_counter = RecordCounter()
4231
def delta_on_metadata(self):
4232
"""Return True if delta's are permitted on metadata streams.
4234
That is on revisions and signatures.
4236
src_serializer = self.from_repository._format._serializer
4237
target_serializer = self.to_format._serializer
4238
return (self.to_format._fetch_uses_deltas and
4239
src_serializer == target_serializer)
4241
def _fetch_revision_texts(self, revs):
4242
# fetch signatures first and then the revision texts
4243
# may need to be a InterRevisionStore call here.
4244
from_sf = self.from_repository.signatures
4245
# A missing signature is just skipped.
4246
keys = [(rev_id,) for rev_id in revs]
4247
signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4249
self.to_format._fetch_order,
4250
not self.to_format._fetch_uses_deltas))
4251
# If a revision has a delta, this is actually expanded inside the
4252
# insert_record_stream code now, which is an alternate fix for
4254
from_rf = self.from_repository.revisions
4255
revisions = from_rf.get_record_stream(
4257
self.to_format._fetch_order,
4258
not self.delta_on_metadata())
4259
return [('signatures', signatures), ('revisions', revisions)]
4261
def _generate_root_texts(self, revs):
4262
"""This will be called by get_stream between fetching weave texts and
4263
fetching the inventory weave.
4265
if self._rich_root_upgrade():
4266
return _mod_fetch.Inter1and2Helper(
4267
self.from_repository).generate_root_texts(revs)
4271
def get_stream(self, search):
4273
revs = search.get_keys()
4274
graph = self.from_repository.get_graph()
4275
revs = tsort.topo_sort(graph.get_parent_map(revs))
4276
data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4278
for knit_kind, file_id, revisions in data_to_fetch:
4279
if knit_kind != phase:
4281
# Make a new progress bar for this phase
4282
if knit_kind == "file":
4283
# Accumulate file texts
4284
text_keys.extend([(file_id, revision) for revision in
4286
elif knit_kind == "inventory":
4287
# Now copy the file texts.
4288
from_texts = self.from_repository.texts
4289
yield ('texts', from_texts.get_record_stream(
4290
text_keys, self.to_format._fetch_order,
4291
not self.to_format._fetch_uses_deltas))
4292
# Cause an error if a text occurs after we have done the
4295
# Before we process the inventory we generate the root
4296
# texts (if necessary) so that the inventories references
4298
for _ in self._generate_root_texts(revs):
4300
# we fetch only the referenced inventories because we do not
4301
# know for unselected inventories whether all their required
4302
# texts are present in the other repository - it could be
4304
for info in self._get_inventory_stream(revs):
4306
elif knit_kind == "signatures":
4307
# Nothing to do here; this will be taken care of when
4308
# _fetch_revision_texts happens.
4310
elif knit_kind == "revisions":
4311
for record in self._fetch_revision_texts(revs):
4314
raise AssertionError("Unknown knit kind %r" % knit_kind)
4316
def get_stream_for_missing_keys(self, missing_keys):
4317
# missing keys can only occur when we are byte copying and not
4318
# translating (because translation means we don't send
4319
# unreconstructable deltas ever).
4321
keys['texts'] = set()
4322
keys['revisions'] = set()
4323
keys['inventories'] = set()
4324
keys['chk_bytes'] = set()
4325
keys['signatures'] = set()
4326
for key in missing_keys:
4327
keys[key[0]].add(key[1:])
4328
if len(keys['revisions']):
4329
# If we allowed copying revisions at this point, we could end up
4330
# copying a revision without copying its required texts: a
4331
# violation of the requirements for repository integrity.
4332
raise AssertionError(
4333
'cannot copy revisions to fill in missing deltas %s' % (
4334
keys['revisions'],))
4335
for substream_kind, keys in keys.iteritems():
4336
vf = getattr(self.from_repository, substream_kind)
4337
if vf is None and keys:
4338
raise AssertionError(
4339
"cannot fill in keys for a versioned file we don't"
4340
" have: %s needs %s" % (substream_kind, keys))
4342
# No need to stream something we don't have
4344
if substream_kind == 'inventories':
4345
# Some missing keys are genuinely ghosts, filter those out.
4346
present = self.from_repository.inventories.get_parent_map(keys)
4347
revs = [key[0] for key in present]
4348
# Get the inventory stream more-or-less as we do for the
4349
# original stream; there's no reason to assume that records
4350
# direct from the source will be suitable for the sink. (Think
4351
# e.g. 2a -> 1.9-rich-root).
4352
for info in self._get_inventory_stream(revs, missing=True):
4356
# Ask for full texts always so that we don't need more round trips
4357
# after this stream.
4358
# Some of the missing keys are genuinely ghosts, so filter absent
4359
# records. The Sink is responsible for doing another check to
4360
# ensure that ghosts don't introduce missing data for future
4362
stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4363
self.to_format._fetch_order, True))
4364
yield substream_kind, stream
4366
def inventory_fetch_order(self):
4367
if self._rich_root_upgrade():
4368
return 'topological'
4370
return self.to_format._fetch_order
4372
def _rich_root_upgrade(self):
4373
return (not self.from_repository._format.rich_root_data and
4374
self.to_format.rich_root_data)
4376
def _get_inventory_stream(self, revision_ids, missing=False):
4377
from_format = self.from_repository._format
4378
if (from_format.supports_chks and self.to_format.supports_chks and
4379
from_format.network_name() == self.to_format.network_name()):
4380
raise AssertionError(
4381
"this case should be handled by GroupCHKStreamSource")
4382
elif 'forceinvdeltas' in debug.debug_flags:
4383
return self._get_convertable_inventory_stream(revision_ids,
4384
delta_versus_null=missing)
4385
elif from_format.network_name() == self.to_format.network_name():
4387
return self._get_simple_inventory_stream(revision_ids,
4389
elif (not from_format.supports_chks and not self.to_format.supports_chks
4390
and from_format._serializer == self.to_format._serializer):
4391
# Essentially the same format.
4392
return self._get_simple_inventory_stream(revision_ids,
4395
# Any time we switch serializations, we want to use an
4396
# inventory-delta based approach.
4397
return self._get_convertable_inventory_stream(revision_ids,
4398
delta_versus_null=missing)
4400
def _get_simple_inventory_stream(self, revision_ids, missing=False):
4401
# NB: This currently reopens the inventory weave in source;
4402
# using a single stream interface instead would avoid this.
4403
from_weave = self.from_repository.inventories
4405
delta_closure = True
4407
delta_closure = not self.delta_on_metadata()
4408
yield ('inventories', from_weave.get_record_stream(
4409
[(rev_id,) for rev_id in revision_ids],
4410
self.inventory_fetch_order(), delta_closure))
4412
def _get_convertable_inventory_stream(self, revision_ids,
4413
delta_versus_null=False):
4414
# The two formats are sufficiently different that there is no fast
4415
# path, so we need to send just inventorydeltas, which any
4416
# sufficiently modern client can insert into any repository.
4417
# The StreamSink code expects to be able to
4418
# convert on the target, so we need to put bytes-on-the-wire that can
4419
# be converted. That means inventory deltas (if the remote is <1.19,
4420
# RemoteStreamSink will fallback to VFS to insert the deltas).
4421
yield ('inventory-deltas',
4422
self._stream_invs_as_deltas(revision_ids,
4423
delta_versus_null=delta_versus_null))
4425
def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4426
"""Return a stream of inventory-deltas for the given rev ids.
4428
:param revision_ids: The list of inventories to transmit
4429
:param delta_versus_null: Don't try to find a minimal delta for this
4430
entry, instead compute the delta versus the NULL_REVISION. This
4431
effectively streams a complete inventory. Used for stuff like
4432
filling in missing parents, etc.
4434
from_repo = self.from_repository
4435
revision_keys = [(rev_id,) for rev_id in revision_ids]
4436
parent_map = from_repo.inventories.get_parent_map(revision_keys)
4437
# XXX: possibly repos could implement a more efficient iter_inv_deltas
4439
inventories = self.from_repository.iter_inventories(
4440
revision_ids, 'topological')
4441
format = from_repo._format
4442
invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4443
inventory_cache = lru_cache.LRUCache(50)
4444
null_inventory = from_repo.revision_tree(
4445
_mod_revision.NULL_REVISION).inventory
4446
# XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4447
# per-repo (e.g. streaming a non-rich-root revision out of a rich-root
4448
# repo back into a non-rich-root repo ought to be allowed)
4449
serializer = inventory_delta.InventoryDeltaSerializer(
4450
versioned_root=format.rich_root_data,
4451
tree_references=format.supports_tree_reference)
4452
for inv in inventories:
4453
key = (inv.revision_id,)
4454
parent_keys = parent_map.get(key, ())
4456
if not delta_versus_null and parent_keys:
4457
# The caller did not ask for complete inventories and we have
4458
# some parents that we can delta against. Make a delta against
4459
# each parent so that we can find the smallest.
4460
parent_ids = [parent_key[0] for parent_key in parent_keys]
4461
for parent_id in parent_ids:
4462
if parent_id not in invs_sent_so_far:
4463
# We don't know that the remote side has this basis, so
4466
if parent_id == _mod_revision.NULL_REVISION:
4467
parent_inv = null_inventory
4469
parent_inv = inventory_cache.get(parent_id, None)
4470
if parent_inv is None:
4471
parent_inv = from_repo.get_inventory(parent_id)
4472
candidate_delta = inv._make_delta(parent_inv)
4473
if (delta is None or
4474
len(delta) > len(candidate_delta)):
4475
delta = candidate_delta
4476
basis_id = parent_id
4478
# Either none of the parents ended up being suitable, or we
4479
# were asked to delta against NULL
4480
basis_id = _mod_revision.NULL_REVISION
4481
delta = inv._make_delta(null_inventory)
4482
invs_sent_so_far.add(inv.revision_id)
4483
inventory_cache[inv.revision_id] = inv
4484
delta_serialized = ''.join(
4485
serializer.delta_to_lines(basis_id, key[-1], delta))
4486
yield versionedfile.FulltextContentFactory(
4487
key, parent_keys, None, delta_serialized)
1835
4490
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1836
4491
stop_revision=None):
1837
4492
"""Extend the partial history to include a given index