1
# Copyright (C) 2009-2018 Jelmer Vernooij <jelmer@jelmer.uk>
2
# Copyright (C) 2012 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Map from Git sha's to Bazaar objects."""
20
from dulwich.objects import (
27
from dulwich.object_store import (
30
from dulwich.pack import (
43
from ..lock import LogicalLockResult
44
from ..revision import (
47
from ..tree import InterTree
48
from ..bzr.testament import (
53
from_repository as cache_from_repository,
55
from .mapping import (
58
extract_unusual_modes,
62
from .unpeel_map import (
70
BANNED_FILENAMES = ['.git']
73
def get_object_store(repo, mapping=None):
74
git = getattr(repo, "_git", None)
76
git.object_store.unlock = lambda: None
77
git.object_store.lock_read = lambda: LogicalLockResult(lambda: None)
78
git.object_store.lock_write = lambda: LogicalLockResult(lambda: None)
79
return git.object_store
80
return BazaarObjectStore(repo, mapping)
83
MAX_TREE_CACHE_SIZE = 50 * 1024 * 1024
86
class LRUTreeCache(object):
88
def __init__(self, repository):
89
def approx_tree_size(tree):
90
# Very rough estimate, 250 per inventory entry
92
inv = tree.root_inventory
93
except AttributeError:
96
self.repository = repository
97
self._cache = lru_cache.LRUSizeCache(
98
max_size=MAX_TREE_CACHE_SIZE, after_cleanup_size=None,
99
compute_size=approx_tree_size)
101
def revision_tree(self, revid):
103
tree = self._cache[revid]
105
tree = self.repository.revision_tree(revid)
109
def iter_revision_trees(self, revids):
114
tree = self._cache[revid]
118
if tree.get_revision_id() != revid:
119
raise AssertionError(
120
"revision id did not match: %s != %s" % (
121
tree.get_revision_id(), revid))
123
for tree in self.repository.revision_trees(todo):
124
trees[tree.get_revision_id()] = tree
126
return (trees[r] for r in revids)
128
def revision_trees(self, revids):
129
return list(self.iter_revision_trees(revids))
132
self._cache[tree.get_revision_id()] = tree
135
def _find_missing_bzr_revids(graph, want, have, shallow=None):
136
"""Find the revisions that have to be pushed.
138
:param get_parent_map: Function that returns the parents for a sequence
140
:param want: Revisions the target wants
141
:param have: Revisions the target already has
142
:return: Set of revisions to fetch
146
# Shallows themselves still need to be fetched, but let's exclude their
148
for ps in graph.get_parent_map(shallow).values():
150
handled.add(NULL_REVISION)
153
extra_todo = graph.find_unique_ancestors(rev, handled)
154
todo.update(extra_todo)
155
handled.update(extra_todo)
159
def _check_expected_sha(expected_sha, object):
160
"""Check whether an object matches an expected SHA.
162
:param expected_sha: None or expected SHA as either binary or as hex digest
163
:param object: Object to verify
165
if expected_sha is None:
167
if len(expected_sha) == 40:
168
if expected_sha != object.sha().hexdigest().encode('ascii'):
169
raise AssertionError("Invalid sha for %r: %s" % (object,
171
elif len(expected_sha) == 20:
172
if expected_sha != object.sha().digest():
173
raise AssertionError("Invalid sha for %r: %s" % (
174
object, sha_to_hex(expected_sha)))
176
raise AssertionError("Unknown length %d for %r" % (len(expected_sha),
180
def directory_to_tree(path, children, lookup_ie_sha1, unusual_modes,
181
empty_file_name, allow_empty=False):
182
"""Create a Git Tree object from a Bazaar directory.
184
:param path: directory path
185
:param children: Children inventory entries
186
:param lookup_ie_sha1: Lookup the Git SHA1 for a inventory entry
187
:param unusual_modes: Dictionary with unusual file modes by file ids
188
:param empty_file_name: Name to use for dummy files in empty directories,
189
None to ignore empty directories.
192
for value in children:
193
if value.name in BANNED_FILENAMES:
195
child_path = osutils.pathjoin(path, value.name)
197
mode = unusual_modes[child_path]
199
mode = entry_mode(value)
200
hexsha = lookup_ie_sha1(child_path, value)
201
if hexsha is not None:
202
tree.add(value.name.encode("utf-8"), mode, hexsha)
203
if not allow_empty and len(tree) == 0:
204
# Only the root can be an empty tree
205
if empty_file_name is not None:
206
tree.add(empty_file_name, stat.S_IFREG | 0o644, Blob().id)
212
def _tree_to_objects(tree, parent_trees, idmap, unusual_modes,
213
dummy_file_name=None, add_cache_entry=None):
214
"""Iterate over the objects that were introduced in a revision.
217
:param parent_trees: Parent revision trees
218
:param unusual_modes: Unusual file modes dictionary
219
:param dummy_file_name: File name to use for dummy files
220
in empty directories. None to skip empty directories
221
:return: Yields (path, object, ie) entries
227
base_tree = parent_trees[0]
228
other_parent_trees = parent_trees[1:]
230
base_tree = tree._repository.revision_tree(NULL_REVISION)
231
other_parent_trees = []
233
def find_unchanged_parent_ie(path, kind, other, parent_trees):
234
for ptree in parent_trees:
235
intertree = InterTree.get(ptree, tree)
236
ppath = intertree.find_source_path(path)
237
if ppath is not None:
238
pkind = ptree.kind(ppath)
240
if (pkind == "file" and
241
ptree.get_file_sha1(ppath) == other):
243
ptree.path2id(ppath), ptree.get_file_revision(ppath))
244
if kind == "symlink":
245
if (pkind == "symlink" and
246
ptree.get_symlink_target(ppath) == other):
248
ptree.path2id(ppath), ptree.get_file_revision(ppath))
251
# Find all the changed blobs
252
for change in tree.iter_changes(base_tree):
253
if change.name[1] in BANNED_FILENAMES:
255
if change.kind[1] == "file":
256
sha1 = tree.get_file_sha1(change.path[1])
259
(pfile_id, prevision) = find_unchanged_parent_ie(
260
change.path[1], change.kind[1], sha1, other_parent_trees)
264
# It existed in one of the parents, with the same contents.
265
# So no need to yield any new git objects.
267
blob_id = idmap.lookup_blob_id(
270
if not change.changed_content:
273
blob.data = tree.get_file_text(change.path[1])
276
new_blobs.append((change.path[1], change.file_id))
278
# TODO(jelmer): This code path does not have any test coverage.
279
shamap[change.path[1]] = blob_id
280
if add_cache_entry is not None:
283
(change.file_id, tree.get_file_revision(change.path[1])), change.path[1])
284
elif change.kind[1] == "symlink":
285
target = tree.get_symlink_target(change.path[1])
286
blob = symlink_to_blob(target)
287
shamap[change.path[1]] = blob.id
288
if add_cache_entry is not None:
290
blob, (change.file_id, tree.get_file_revision(change.path[1])), change.path[1])
292
find_unchanged_parent_ie(
293
change.path[1], change.kind[1], target, other_parent_trees)
295
if change.changed_content:
296
yield (change.path[1], blob,
297
(change.file_id, tree.get_file_revision(change.path[1])))
298
elif change.kind[1] is None:
299
shamap[change.path[1]] = None
300
elif change.kind[1] != 'directory':
301
raise AssertionError(change.kind[1])
302
for p in change.path:
305
dirty_dirs.add(osutils.dirname(p))
307
# Fetch contents of the blobs that were changed
308
for (path, file_id), chunks in tree.iter_files_bytes(
309
[(path, (path, file_id)) for (path, file_id) in new_blobs]):
312
if add_cache_entry is not None:
313
add_cache_entry(obj, (file_id, tree.get_file_revision(path)), path)
314
yield path, obj, (file_id, tree.get_file_revision(path))
315
shamap[path] = obj.id
317
for path in unusual_modes:
318
dirty_dirs.add(posixpath.dirname(path))
320
for dir in list(dirty_dirs):
321
for parent in osutils.parent_directories(dir):
322
if parent in dirty_dirs:
324
dirty_dirs.add(parent)
329
def ie_to_hexsha(path, ie):
334
# FIXME: Should be the same as in parent
335
if ie.kind == "file":
337
return idmap.lookup_blob_id(ie.file_id, ie.revision)
341
blob.data = tree.get_file_text(path)
342
if add_cache_entry is not None:
343
add_cache_entry(blob, (ie.file_id, ie.revision), path)
345
elif ie.kind == "symlink":
347
return idmap.lookup_blob_id(ie.file_id, ie.revision)
350
target = tree.get_symlink_target(path)
351
blob = symlink_to_blob(target)
352
if add_cache_entry is not None:
353
add_cache_entry(blob, (ie.file_id, ie.revision), path)
355
elif ie.kind == "directory":
356
# Not all cache backends store the tree information,
357
# calculate again from scratch
358
ret = directory_to_tree(
359
path, ie.children.values(), ie_to_hexsha, unusual_modes,
360
dummy_file_name, ie.parent_id is None)
367
for path in sorted(dirty_dirs, reverse=True):
368
if not tree.has_filename(path):
371
if tree.kind(path) != 'directory':
374
obj = directory_to_tree(
375
path, tree.iter_child_entries(path), ie_to_hexsha, unusual_modes,
376
dummy_file_name, path == '')
379
file_id = tree.path2id(path)
380
if add_cache_entry is not None:
381
add_cache_entry(obj, (file_id, tree.get_revision_id()), path)
382
yield path, obj, (file_id, tree.get_revision_id())
383
shamap[path] = obj.id
386
class PackTupleIterable(object):
388
def __init__(self, store):
390
self.store.lock_read()
396
def add(self, sha, path):
397
self.objects[sha] = path
400
return len(self.objects)
403
return ((self.store[object_id], path) for (object_id, path) in
404
self.objects.items())
407
class BazaarObjectStore(BaseObjectStore):
408
"""A Git-style object store backed onto a Bazaar repository."""
410
def __init__(self, repository, mapping=None):
411
self.repository = repository
412
self._map_updated = False
415
self.mapping = default_mapping
417
self.mapping = mapping
418
self._cache = cache_from_repository(repository)
419
self._content_cache_types = ("tree",)
420
self.start_write_group = self._cache.idmap.start_write_group
421
self.abort_write_group = self._cache.idmap.abort_write_group
422
self.commit_write_group = self._cache.idmap.commit_write_group
423
self.tree_cache = LRUTreeCache(self.repository)
424
self.unpeel_map = UnpeelMap.from_repository(self.repository)
426
def _missing_revisions(self, revisions):
427
return self._cache.idmap.missing_revisions(revisions)
429
def _update_sha_map(self, stop_revision=None):
430
if not self.is_locked():
431
raise errors.LockNotHeld(self)
432
if self._map_updated:
434
if (stop_revision is not None and
435
not self._missing_revisions([stop_revision])):
437
graph = self.repository.get_graph()
438
if stop_revision is None:
439
all_revids = self.repository.all_revision_ids()
440
missing_revids = self._missing_revisions(all_revids)
442
heads = set([stop_revision])
443
missing_revids = self._missing_revisions(heads)
445
parents = graph.get_parent_map(heads)
447
for p in parents.values():
448
todo.update([x for x in p if x not in missing_revids])
449
heads = self._missing_revisions(todo)
450
missing_revids.update(heads)
451
if NULL_REVISION in missing_revids:
452
missing_revids.remove(NULL_REVISION)
453
missing_revids = self.repository.has_revisions(missing_revids)
454
if not missing_revids:
455
if stop_revision is None:
456
self._map_updated = True
458
self.start_write_group()
460
with ui.ui_factory.nested_progress_bar() as pb:
461
for i, revid in enumerate(graph.iter_topo_order(
463
trace.mutter('processing %r', revid)
464
pb.update("updating git map", i, len(missing_revids))
465
self._update_sha_map_revision(revid)
466
if stop_revision is None:
467
self._map_updated = True
468
except BaseException:
469
self.abort_write_group()
472
self.commit_write_group()
475
self._update_sha_map()
476
return iter(self._cache.idmap.sha1s())
478
def _reconstruct_commit(self, rev, tree_sha, lossy, verifiers):
479
"""Reconstruct a Commit object.
481
:param rev: Revision object
482
:param tree_sha: SHA1 of the root tree object
483
:param lossy: Whether or not to roundtrip bzr metadata
484
:param verifiers: Verifiers for the commits
485
:return: Commit object
487
def parent_lookup(revid):
489
return self._lookup_revision_sha1(revid)
490
except errors.NoSuchRevision:
492
return self.mapping.export_commit(rev, tree_sha, parent_lookup,
495
def _revision_to_objects(self, rev, tree, lossy, add_cache_entry=None):
496
"""Convert a revision to a set of git objects.
498
:param rev: Bazaar revision object
499
:param tree: Bazaar revision tree
500
:param lossy: Whether to not roundtrip all Bazaar revision data
502
unusual_modes = extract_unusual_modes(rev)
503
present_parents = self.repository.has_revisions(rev.parent_ids)
504
parent_trees = self.tree_cache.revision_trees(
505
[p for p in rev.parent_ids if p in present_parents])
507
for path, obj, bzr_key_data in _tree_to_objects(
508
tree, parent_trees, self._cache.idmap, unusual_modes,
509
self.mapping.BZR_DUMMY_FILE, add_cache_entry):
512
root_key_data = bzr_key_data
513
# Don't yield just yet
516
if root_tree is None:
517
# Pointless commit - get the tree sha elsewhere
518
if not rev.parent_ids:
521
base_sha1 = self._lookup_revision_sha1(rev.parent_ids[0])
522
root_tree = self[self[base_sha1].tree]
523
root_key_data = (tree.path2id(''), tree.get_revision_id())
524
if add_cache_entry is not None:
525
add_cache_entry(root_tree, root_key_data, "")
528
testament3 = StrictTestament3(rev, tree)
529
verifiers = {"testament3-sha1": testament3.as_sha1()}
532
commit_obj = self._reconstruct_commit(rev, root_tree.id,
533
lossy=lossy, verifiers=verifiers)
535
foreign_revid, mapping = mapping_registry.parse_revision_id(
537
except errors.InvalidRevisionId:
540
_check_expected_sha(foreign_revid, commit_obj)
541
if add_cache_entry is not None:
542
add_cache_entry(commit_obj, verifiers, None)
544
yield None, commit_obj
546
def _get_updater(self, rev):
547
return self._cache.get_updater(rev)
549
def _update_sha_map_revision(self, revid):
550
rev = self.repository.get_revision(revid)
551
tree = self.tree_cache.revision_tree(rev.revision_id)
552
updater = self._get_updater(rev)
553
# FIXME JRV 2011-12-15: Shouldn't we try both values for lossy ?
554
for path, obj in self._revision_to_objects(
555
rev, tree, lossy=(not self.mapping.roundtripping),
556
add_cache_entry=updater.add_object):
557
if isinstance(obj, Commit):
559
commit_obj = updater.finish()
562
def _reconstruct_blobs(self, keys):
563
"""Return a Git Blob object from a fileid and revision stored in bzr.
565
:param fileid: File id of the text
566
:param revision: Revision of the text
568
stream = self.repository.iter_files_bytes(
569
((key[0], key[1], key) for key in keys))
570
for (file_id, revision, expected_sha), chunks in stream:
572
blob.chunked = chunks
573
if blob.id != expected_sha and blob.data == b"":
574
# Perhaps it's a symlink ?
575
tree = self.tree_cache.revision_tree(revision)
576
path = tree.id2path(file_id)
577
if tree.kind(path) == 'symlink':
578
blob = symlink_to_blob(tree.get_symlink_target(path))
579
_check_expected_sha(expected_sha, blob)
582
def _reconstruct_tree(self, fileid, revid, bzr_tree, unusual_modes,
584
"""Return a Git Tree object from a file id and a revision stored in bzr.
586
:param fileid: fileid in the tree.
587
:param revision: Revision of the tree.
589
def get_ie_sha1(path, entry):
590
if entry.kind == "directory":
592
return self._cache.idmap.lookup_tree_id(entry.file_id,
594
except (NotImplementedError, KeyError):
595
obj = self._reconstruct_tree(
596
entry.file_id, revid, bzr_tree, unusual_modes)
601
elif entry.kind in ("file", "symlink"):
603
return self._cache.idmap.lookup_blob_id(entry.file_id,
607
return next(self._reconstruct_blobs(
608
[(entry.file_id, entry.revision, None)])).id
609
elif entry.kind == 'tree-reference':
610
# FIXME: Make sure the file id is the root id
611
return self._lookup_revision_sha1(entry.reference_revision)
613
raise AssertionError("unknown entry kind '%s'" % entry.kind)
614
path = bzr_tree.id2path(fileid)
615
tree = directory_to_tree(
617
bzr_tree.iter_child_entries(path),
618
get_ie_sha1, unusual_modes, self.mapping.BZR_DUMMY_FILE,
619
bzr_tree.path2id('') == fileid)
621
_check_expected_sha(expected_sha, tree)
624
def get_parents(self, sha):
625
"""Retrieve the parents of a Git commit by SHA1.
627
:param sha: SHA1 of the commit
628
:raises: KeyError, NotCommitError
630
return self[sha].parents
632
def _lookup_revision_sha1(self, revid):
633
"""Return the SHA1 matching a Bazaar revision."""
634
if revid == NULL_REVISION:
637
return self._cache.idmap.lookup_commit(revid)
640
return mapping_registry.parse_revision_id(revid)[0]
641
except errors.InvalidRevisionId:
642
self._update_sha_map(revid)
643
return self._cache.idmap.lookup_commit(revid)
645
def get_raw(self, sha):
646
"""Get the raw representation of a Git object by SHA1.
648
:param sha: SHA1 of the git object
651
sha = sha_to_hex(sha)
653
return (obj.type, obj.as_raw_string())
655
def __contains__(self, sha):
656
# See if sha is in map
658
for (type, type_data) in self.lookup_git_sha(sha):
660
if self.repository.has_revision(type_data[0]):
663
if type_data in self.repository.texts:
666
if self.repository.has_revision(type_data[1]):
669
raise AssertionError("Unknown object type '%s'" % type)
677
self._map_updated = False
678
self.repository.lock_read()
679
return LogicalLockResult(self.unlock)
681
def lock_write(self):
683
self._map_updated = False
684
self.repository.lock_write()
685
return LogicalLockResult(self.unlock)
688
return (self._locked is not None)
692
self._map_updated = False
693
self.repository.unlock()
695
def lookup_git_shas(self, shas):
699
ret[sha] = [("commit", (NULL_REVISION, None, {}))]
702
ret[sha] = list(self._cache.idmap.lookup_git_sha(sha))
704
# if not, see if there are any unconverted revisions and
705
# add them to the map, search for sha in map again
706
self._update_sha_map()
708
ret[sha] = list(self._cache.idmap.lookup_git_sha(sha))
713
def lookup_git_sha(self, sha):
714
return self.lookup_git_shas([sha])[sha]
716
def __getitem__(self, sha):
717
for (kind, type_data) in self.lookup_git_sha(sha):
718
# convert object to git object
720
(revid, tree_sha, verifiers) = type_data
722
rev = self.repository.get_revision(revid)
723
except errors.NoSuchRevision:
724
if revid == NULL_REVISION:
725
raise AssertionError(
726
"should not try to look up NULL_REVISION")
727
trace.mutter('entry for %s %s in shamap: %r, but not '
728
'found in repository', kind, sha, type_data)
730
# FIXME: the type data should say whether conversion was
732
commit = self._reconstruct_commit(
733
rev, tree_sha, lossy=(not self.mapping.roundtripping),
735
_check_expected_sha(sha, commit)
738
(fileid, revision) = type_data
739
blobs = self._reconstruct_blobs([(fileid, revision, sha)])
742
(fileid, revid) = type_data
744
tree = self.tree_cache.revision_tree(revid)
745
rev = self.repository.get_revision(revid)
746
except errors.NoSuchRevision:
748
'entry for %s %s in shamap: %r, but not found in '
749
'repository', kind, sha, type_data)
751
unusual_modes = extract_unusual_modes(rev)
753
return self._reconstruct_tree(
754
fileid, revid, tree, unusual_modes, expected_sha=sha)
755
except errors.NoSuchRevision:
758
raise AssertionError("Unknown object type '%s'" % kind)
762
def generate_lossy_pack_data(self, have, want, shallow=None,
764
get_tagged=None, ofs_delta=False):
765
return pack_objects_to_data(
766
self.generate_pack_contents(have, want, progress=progress,
767
shallow=shallow, get_tagged=get_tagged,
770
def generate_pack_contents(self, have, want, shallow=None, progress=None,
771
ofs_delta=False, get_tagged=None, lossy=False):
772
"""Iterate over the contents of a pack file.
774
:param have: List of SHA1s of objects that should not be sent
775
:param want: List of SHA1s of objects that should be sent
778
ret = self.lookup_git_shas(have + want)
779
for commit_sha in have:
780
commit_sha = self.unpeel_map.peel_tag(commit_sha, commit_sha)
782
for (type, type_data) in ret[commit_sha]:
784
raise AssertionError("Type was %s, not commit" % type)
785
processed.add(type_data[0])
787
trace.mutter("unable to find remote ref %s", commit_sha)
789
for commit_sha in want:
790
if commit_sha in have:
793
for (type, type_data) in ret[commit_sha]:
795
raise AssertionError("Type was %s, not commit" % type)
796
pending.add(type_data[0])
800
for commit_sha in shallow or set():
802
for (type, type_data) in ret[commit_sha]:
804
raise AssertionError("Type was %s, not commit" % type)
805
shallows.add(type_data[0])
809
graph = self.repository.get_graph()
810
todo = _find_missing_bzr_revids(graph, pending, processed, shallow)
811
ret = PackTupleIterable(self)
812
with ui.ui_factory.nested_progress_bar() as pb:
813
for i, revid in enumerate(graph.iter_topo_order(todo)):
814
pb.update("generating git objects", i, len(todo))
816
rev = self.repository.get_revision(revid)
817
except errors.NoSuchRevision:
819
tree = self.tree_cache.revision_tree(revid)
820
for path, obj in self._revision_to_objects(
821
rev, tree, lossy=lossy):
822
ret.add(obj.id, path)
825
def add_thin_pack(self):
828
fd, path = tempfile.mkstemp(suffix=".pack")
829
f = os.fdopen(fd, 'wb')
832
from .fetch import import_git_objects
835
if os.path.getsize(path) == 0:
838
pd.create_index_v2(path[:-5] + ".idx", self.object_store.get_raw)
841
with self.repository.lock_write():
842
self.repository.start_write_group()
844
import_git_objects(self.repository, self.mapping,
845
p.iterobjects(get_raw=self.get_raw),
847
except BaseException:
848
self.repository.abort_write_group()
851
self.repository.commit_write_group()
854
# The pack isn't kept around anyway, so no point
855
# in treating full packs different from thin packs
856
add_pack = add_thin_pack