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 __future__ import absolute_import
22
from dulwich.objects import (
29
from dulwich.object_store import (
32
from dulwich.pack import (
45
from ..tree import find_previous_path
46
from ..lock import LogicalLockResult
47
from ..revision import (
50
from ..sixish import viewitems
51
from ..bzr.testament import (
56
from_repository as cache_from_repository,
58
from .mapping import (
61
extract_unusual_modes,
65
from .unpeel_map import (
73
BANNED_FILENAMES = ['.git']
76
def get_object_store(repo, mapping=None):
77
git = getattr(repo, "_git", None)
79
git.object_store.unlock = lambda: None
80
git.object_store.lock_read = lambda: LogicalLockResult(lambda: None)
81
git.object_store.lock_write = lambda: LogicalLockResult(lambda: None)
82
return git.object_store
83
return BazaarObjectStore(repo, mapping)
86
MAX_TREE_CACHE_SIZE = 50 * 1024 * 1024
89
class LRUTreeCache(object):
91
def __init__(self, repository):
92
def approx_tree_size(tree):
93
# Very rough estimate, 250 per inventory entry
95
inv = tree.root_inventory
96
except AttributeError:
99
self.repository = repository
100
self._cache = lru_cache.LRUSizeCache(
101
max_size=MAX_TREE_CACHE_SIZE, after_cleanup_size=None,
102
compute_size=approx_tree_size)
104
def revision_tree(self, revid):
106
tree = self._cache[revid]
108
tree = self.repository.revision_tree(revid)
112
def iter_revision_trees(self, revids):
117
tree = self._cache[revid]
121
if tree.get_revision_id() != revid:
122
raise AssertionError(
123
"revision id did not match: %s != %s" % (
124
tree.get_revision_id(), revid))
126
for tree in self.repository.revision_trees(todo):
127
trees[tree.get_revision_id()] = tree
129
return (trees[r] for r in revids)
131
def revision_trees(self, revids):
132
return list(self.iter_revision_trees(revids))
135
self._cache[tree.get_revision_id()] = tree
138
def _find_missing_bzr_revids(graph, want, have):
139
"""Find the revisions that have to be pushed.
141
:param get_parent_map: Function that returns the parents for a sequence
143
:param want: Revisions the target wants
144
:param have: Revisions the target already has
145
:return: Set of revisions to fetch
150
extra_todo = graph.find_unique_ancestors(rev, handled)
151
todo.update(extra_todo)
152
handled.update(extra_todo)
153
if NULL_REVISION in todo:
154
todo.remove(NULL_REVISION)
158
def _check_expected_sha(expected_sha, object):
159
"""Check whether an object matches an expected SHA.
161
:param expected_sha: None or expected SHA as either binary or as hex digest
162
:param object: Object to verify
164
if expected_sha is None:
166
if len(expected_sha) == 40:
167
if expected_sha != object.sha().hexdigest().encode('ascii'):
168
raise AssertionError("Invalid sha for %r: %s" % (object,
170
elif len(expected_sha) == 20:
171
if expected_sha != object.sha().digest():
172
raise AssertionError("Invalid sha for %r: %s" % (
173
object, sha_to_hex(expected_sha)))
175
raise AssertionError("Unknown length %d for %r" % (len(expected_sha),
179
def directory_to_tree(path, children, lookup_ie_sha1, unusual_modes,
180
empty_file_name, allow_empty=False):
181
"""Create a Git Tree object from a Bazaar directory.
183
:param path: directory path
184
:param children: Children inventory entries
185
:param lookup_ie_sha1: Lookup the Git SHA1 for a inventory entry
186
:param unusual_modes: Dictionary with unusual file modes by file ids
187
:param empty_file_name: Name to use for dummy files in empty directories,
188
None to ignore empty directories.
191
for value in children:
192
if value.name in BANNED_FILENAMES:
194
child_path = osutils.pathjoin(path, value.name)
196
mode = unusual_modes[child_path]
198
mode = entry_mode(value)
199
hexsha = lookup_ie_sha1(child_path, value)
200
if hexsha is not None:
201
tree.add(value.name.encode("utf-8"), mode, hexsha)
202
if not allow_empty and len(tree) == 0:
203
# Only the root can be an empty tree
204
if empty_file_name is not None:
205
tree.add(empty_file_name, stat.S_IFREG | 0o644, Blob().id)
211
def _tree_to_objects(tree, parent_trees, idmap, unusual_modes,
212
dummy_file_name=None, add_cache_entry=None):
213
"""Iterate over the objects that were introduced in a revision.
216
:param parent_trees: Parent revision trees
217
:param unusual_modes: Unusual file modes dictionary
218
:param dummy_file_name: File name to use for dummy files
219
in empty directories. None to skip empty directories
220
:return: Yields (path, object, ie) entries
226
base_tree = parent_trees[0]
227
other_parent_trees = parent_trees[1:]
229
base_tree = tree._repository.revision_tree(NULL_REVISION)
230
other_parent_trees = []
232
def find_unchanged_parent_ie(path, kind, other, parent_trees):
233
for ptree in parent_trees:
234
ppath = find_previous_path(tree, ptree, path)
235
if ppath is not None:
236
pkind = ptree.kind(ppath)
238
if (pkind == "file" and
239
ptree.get_file_sha1(ppath) == other):
241
ptree.path2id(ppath), ptree.get_file_revision(ppath))
242
if kind == "symlink":
243
if (pkind == "symlink" and
244
ptree.get_symlink_target(ppath) == other):
246
ptree.path2id(ppath), ptree.get_file_revision(ppath))
249
# Find all the changed blobs
250
for change in tree.iter_changes(base_tree):
251
if change.name[1] in BANNED_FILENAMES:
253
if change.kind[1] == "file":
254
sha1 = tree.get_file_sha1(change.path[1])
257
(pfile_id, prevision) = find_unchanged_parent_ie(
258
change.path[1], change.kind[1], sha1, other_parent_trees)
262
# It existed in one of the parents, with the same contents.
263
# So no need to yield any new git objects.
265
blob_id = idmap.lookup_blob_id(
268
if not changed_content:
271
blob.data = tree.get_file_text(change.path[1])
274
new_blobs.append((change.path[1], change.file_id))
276
# TODO(jelmer): This code path does not have any test coverage.
277
shamap[change.path[1]] = blob_id
278
if add_cache_entry is not None:
281
(change.file_id, tree.get_file_revision(change.path[1])), change.path[1])
282
elif change.kind[1] == "symlink":
283
target = tree.get_symlink_target(change.path[1])
284
blob = symlink_to_blob(target)
285
shamap[change.path[1]] = blob.id
286
if add_cache_entry is not None:
288
blob, (change.file_id, tree.get_file_revision(change.path[1])), change.path[1])
290
find_unchanged_parent_ie(
291
change.path[1], change.kind[1], target, other_parent_trees)
293
if change.changed_content:
294
yield (change.path[1], blob,
295
(change.file_id, tree.get_file_revision(change.path[1])))
296
elif change.kind[1] is None:
297
shamap[change.path[1]] = None
298
elif change.kind[1] != 'directory':
299
raise AssertionError(change.kind[1])
300
for p in change.path:
303
dirty_dirs.add(osutils.dirname(p))
305
# Fetch contents of the blobs that were changed
306
for (path, file_id), chunks in tree.iter_files_bytes(
307
[(path, (path, file_id)) for (path, file_id) in new_blobs]):
310
if add_cache_entry is not None:
311
add_cache_entry(obj, (file_id, tree.get_file_revision(path)), path)
312
yield path, obj, (file_id, tree.get_file_revision(path))
313
shamap[path] = obj.id
315
for path in unusual_modes:
316
dirty_dirs.add(posixpath.dirname(path))
318
for dir in list(dirty_dirs):
319
for parent in osutils.parent_directories(dir):
320
if parent in dirty_dirs:
322
dirty_dirs.add(parent)
327
def ie_to_hexsha(path, ie):
332
# FIXME: Should be the same as in parent
333
if ie.kind == "file":
335
return idmap.lookup_blob_id(ie.file_id, ie.revision)
339
blob.data = tree.get_file_text(path)
340
if add_cache_entry is not None:
341
add_cache_entry(blob, (ie.file_id, ie.revision), path)
343
elif ie.kind == "symlink":
345
return idmap.lookup_blob_id(ie.file_id, ie.revision)
348
target = tree.get_symlink_target(path)
349
blob = symlink_to_blob(target)
350
if add_cache_entry is not None:
351
add_cache_entry(blob, (ie.file_id, ie.revision), path)
353
elif ie.kind == "directory":
354
# Not all cache backends store the tree information,
355
# calculate again from scratch
356
ret = directory_to_tree(
357
path, ie.children.values(), ie_to_hexsha, unusual_modes,
358
dummy_file_name, ie.parent_id is None)
365
for path in sorted(dirty_dirs, reverse=True):
366
if not tree.has_filename(path):
369
if tree.kind(path) != 'directory':
372
obj = directory_to_tree(
373
path, tree.iter_child_entries(path), ie_to_hexsha, unusual_modes,
374
dummy_file_name, path == '')
377
file_id = tree.path2id(path)
378
if add_cache_entry is not None:
379
add_cache_entry(obj, (file_id, tree.get_revision_id()), path)
380
yield path, obj, (file_id, tree.get_revision_id())
381
shamap[path] = obj.id
384
class PackTupleIterable(object):
386
def __init__(self, store):
388
self.store.lock_read()
394
def add(self, sha, path):
395
self.objects[sha] = path
398
return len(self.objects)
401
return ((self.store[object_id], path) for (object_id, path) in
402
viewitems(self.objects))
405
class BazaarObjectStore(BaseObjectStore):
406
"""A Git-style object store backed onto a Bazaar repository."""
408
def __init__(self, repository, mapping=None):
409
self.repository = repository
410
self._map_updated = False
413
self.mapping = default_mapping
415
self.mapping = mapping
416
self._cache = cache_from_repository(repository)
417
self._content_cache_types = ("tree",)
418
self.start_write_group = self._cache.idmap.start_write_group
419
self.abort_write_group = self._cache.idmap.abort_write_group
420
self.commit_write_group = self._cache.idmap.commit_write_group
421
self.tree_cache = LRUTreeCache(self.repository)
422
self.unpeel_map = UnpeelMap.from_repository(self.repository)
424
def _missing_revisions(self, revisions):
425
return self._cache.idmap.missing_revisions(revisions)
427
def _update_sha_map(self, stop_revision=None):
428
if not self.is_locked():
429
raise errors.LockNotHeld(self)
430
if self._map_updated:
432
if (stop_revision is not None and
433
not self._missing_revisions([stop_revision])):
435
graph = self.repository.get_graph()
436
if stop_revision is None:
437
all_revids = self.repository.all_revision_ids()
438
missing_revids = self._missing_revisions(all_revids)
440
heads = set([stop_revision])
441
missing_revids = self._missing_revisions(heads)
443
parents = graph.get_parent_map(heads)
445
for p in parents.values():
446
todo.update([x for x in p if x not in missing_revids])
447
heads = self._missing_revisions(todo)
448
missing_revids.update(heads)
449
if NULL_REVISION in missing_revids:
450
missing_revids.remove(NULL_REVISION)
451
missing_revids = self.repository.has_revisions(missing_revids)
452
if not missing_revids:
453
if stop_revision is None:
454
self._map_updated = True
456
self.start_write_group()
458
with ui.ui_factory.nested_progress_bar() as pb:
459
for i, revid in enumerate(graph.iter_topo_order(
461
trace.mutter('processing %r', revid)
462
pb.update("updating git map", i, len(missing_revids))
463
self._update_sha_map_revision(revid)
464
if stop_revision is None:
465
self._map_updated = True
466
except BaseException:
467
self.abort_write_group()
470
self.commit_write_group()
473
self._update_sha_map()
474
return iter(self._cache.idmap.sha1s())
476
def _reconstruct_commit(self, rev, tree_sha, lossy, verifiers):
477
"""Reconstruct a Commit object.
479
:param rev: Revision object
480
:param tree_sha: SHA1 of the root tree object
481
:param lossy: Whether or not to roundtrip bzr metadata
482
:param verifiers: Verifiers for the commits
483
:return: Commit object
485
def parent_lookup(revid):
487
return self._lookup_revision_sha1(revid)
488
except errors.NoSuchRevision:
490
return self.mapping.export_commit(rev, tree_sha, parent_lookup,
493
def _revision_to_objects(self, rev, tree, lossy, add_cache_entry=None):
494
"""Convert a revision to a set of git objects.
496
:param rev: Bazaar revision object
497
:param tree: Bazaar revision tree
498
:param lossy: Whether to not roundtrip all Bazaar revision data
500
unusual_modes = extract_unusual_modes(rev)
501
present_parents = self.repository.has_revisions(rev.parent_ids)
502
parent_trees = self.tree_cache.revision_trees(
503
[p for p in rev.parent_ids if p in present_parents])
505
for path, obj, bzr_key_data in _tree_to_objects(
506
tree, parent_trees, self._cache.idmap, unusual_modes,
507
self.mapping.BZR_DUMMY_FILE, add_cache_entry):
510
root_key_data = bzr_key_data
511
# Don't yield just yet
514
if root_tree is None:
515
# Pointless commit - get the tree sha elsewhere
516
if not rev.parent_ids:
519
base_sha1 = self._lookup_revision_sha1(rev.parent_ids[0])
520
root_tree = self[self[base_sha1].tree]
521
root_key_data = (tree.path2id(''), tree.get_revision_id())
522
if add_cache_entry is not None:
523
add_cache_entry(root_tree, root_key_data, "")
526
testament3 = StrictTestament3(rev, tree)
527
verifiers = {"testament3-sha1": testament3.as_sha1()}
530
commit_obj = self._reconstruct_commit(rev, root_tree.id,
531
lossy=lossy, verifiers=verifiers)
533
foreign_revid, mapping = mapping_registry.parse_revision_id(
535
except errors.InvalidRevisionId:
538
_check_expected_sha(foreign_revid, commit_obj)
539
if add_cache_entry is not None:
540
add_cache_entry(commit_obj, verifiers, None)
542
yield None, commit_obj
544
def _get_updater(self, rev):
545
return self._cache.get_updater(rev)
547
def _update_sha_map_revision(self, revid):
548
rev = self.repository.get_revision(revid)
549
tree = self.tree_cache.revision_tree(rev.revision_id)
550
updater = self._get_updater(rev)
551
# FIXME JRV 2011-12-15: Shouldn't we try both values for lossy ?
552
for path, obj in self._revision_to_objects(
553
rev, tree, lossy=(not self.mapping.roundtripping),
554
add_cache_entry=updater.add_object):
555
if isinstance(obj, Commit):
557
commit_obj = updater.finish()
560
def _reconstruct_blobs(self, keys):
561
"""Return a Git Blob object from a fileid and revision stored in bzr.
563
:param fileid: File id of the text
564
:param revision: Revision of the text
566
stream = self.repository.iter_files_bytes(
567
((key[0], key[1], key) for key in keys))
568
for (file_id, revision, expected_sha), chunks in stream:
570
blob.chunked = chunks
571
if blob.id != expected_sha and blob.data == b"":
572
# Perhaps it's a symlink ?
573
tree = self.tree_cache.revision_tree(revision)
574
path = tree.id2path(file_id)
575
if tree.kind(path) == 'symlink':
576
blob = symlink_to_blob(tree.get_symlink_target(path))
577
_check_expected_sha(expected_sha, blob)
580
def _reconstruct_tree(self, fileid, revid, bzr_tree, unusual_modes,
582
"""Return a Git Tree object from a file id and a revision stored in bzr.
584
:param fileid: fileid in the tree.
585
:param revision: Revision of the tree.
587
def get_ie_sha1(path, entry):
588
if entry.kind == "directory":
590
return self._cache.idmap.lookup_tree_id(entry.file_id,
592
except (NotImplementedError, KeyError):
593
obj = self._reconstruct_tree(
594
entry.file_id, revid, bzr_tree, unusual_modes)
599
elif entry.kind in ("file", "symlink"):
601
return self._cache.idmap.lookup_blob_id(entry.file_id,
605
return next(self._reconstruct_blobs(
606
[(entry.file_id, entry.revision, None)])).id
607
elif entry.kind == 'tree-reference':
608
# FIXME: Make sure the file id is the root id
609
return self._lookup_revision_sha1(entry.reference_revision)
611
raise AssertionError("unknown entry kind '%s'" % entry.kind)
612
path = bzr_tree.id2path(fileid)
613
tree = directory_to_tree(
615
bzr_tree.iter_child_entries(path),
616
get_ie_sha1, unusual_modes, self.mapping.BZR_DUMMY_FILE,
617
bzr_tree.path2id('') == fileid)
619
_check_expected_sha(expected_sha, tree)
622
def get_parents(self, sha):
623
"""Retrieve the parents of a Git commit by SHA1.
625
:param sha: SHA1 of the commit
626
:raises: KeyError, NotCommitError
628
return self[sha].parents
630
def _lookup_revision_sha1(self, revid):
631
"""Return the SHA1 matching a Bazaar revision."""
632
if revid == NULL_REVISION:
635
return self._cache.idmap.lookup_commit(revid)
638
return mapping_registry.parse_revision_id(revid)[0]
639
except errors.InvalidRevisionId:
640
self._update_sha_map(revid)
641
return self._cache.idmap.lookup_commit(revid)
643
def get_raw(self, sha):
644
"""Get the raw representation of a Git object by SHA1.
646
:param sha: SHA1 of the git object
649
sha = sha_to_hex(sha)
651
return (obj.type, obj.as_raw_string())
653
def __contains__(self, sha):
654
# See if sha is in map
656
for (type, type_data) in self.lookup_git_sha(sha):
658
if self.repository.has_revision(type_data[0]):
661
if type_data in self.repository.texts:
664
if self.repository.has_revision(type_data[1]):
667
raise AssertionError("Unknown object type '%s'" % type)
675
self._map_updated = False
676
self.repository.lock_read()
677
return LogicalLockResult(self.unlock)
679
def lock_write(self):
681
self._map_updated = False
682
self.repository.lock_write()
683
return LogicalLockResult(self.unlock)
686
return (self._locked is not None)
690
self._map_updated = False
691
self.repository.unlock()
693
def lookup_git_shas(self, shas):
697
ret[sha] = [("commit", (NULL_REVISION, None, {}))]
700
ret[sha] = list(self._cache.idmap.lookup_git_sha(sha))
702
# if not, see if there are any unconverted revisions and
703
# add them to the map, search for sha in map again
704
self._update_sha_map()
706
ret[sha] = list(self._cache.idmap.lookup_git_sha(sha))
711
def lookup_git_sha(self, sha):
712
return self.lookup_git_shas([sha])[sha]
714
def __getitem__(self, sha):
715
for (kind, type_data) in self.lookup_git_sha(sha):
716
# convert object to git object
718
(revid, tree_sha, verifiers) = type_data
720
rev = self.repository.get_revision(revid)
721
except errors.NoSuchRevision:
722
if revid == NULL_REVISION:
723
raise AssertionError(
724
"should not try to look up NULL_REVISION")
725
trace.mutter('entry for %s %s in shamap: %r, but not '
726
'found in repository', kind, sha, type_data)
728
# FIXME: the type data should say whether conversion was
730
commit = self._reconstruct_commit(
731
rev, tree_sha, lossy=(not self.mapping.roundtripping),
733
_check_expected_sha(sha, commit)
736
(fileid, revision) = type_data
737
blobs = self._reconstruct_blobs([(fileid, revision, sha)])
740
(fileid, revid) = type_data
742
tree = self.tree_cache.revision_tree(revid)
743
rev = self.repository.get_revision(revid)
744
except errors.NoSuchRevision:
746
'entry for %s %s in shamap: %r, but not found in '
747
'repository', kind, sha, type_data)
749
unusual_modes = extract_unusual_modes(rev)
751
return self._reconstruct_tree(
752
fileid, revid, tree, unusual_modes, expected_sha=sha)
753
except errors.NoSuchRevision:
756
raise AssertionError("Unknown object type '%s'" % kind)
760
def generate_lossy_pack_data(self, have, want, progress=None,
761
get_tagged=None, ofs_delta=False):
762
return pack_objects_to_data(
763
self.generate_pack_contents(have, want, progress, get_tagged,
766
def generate_pack_contents(self, have, want, progress=None,
767
ofs_delta=False, get_tagged=None, lossy=False):
768
"""Iterate over the contents of a pack file.
770
:param have: List of SHA1s of objects that should not be sent
771
:param want: List of SHA1s of objects that should be sent
774
ret = self.lookup_git_shas(have + want)
775
for commit_sha in have:
776
commit_sha = self.unpeel_map.peel_tag(commit_sha, commit_sha)
778
for (type, type_data) in ret[commit_sha]:
780
raise AssertionError("Type was %s, not commit" % type)
781
processed.add(type_data[0])
783
trace.mutter("unable to find remote ref %s", commit_sha)
785
for commit_sha in want:
786
if commit_sha in have:
789
for (type, type_data) in ret[commit_sha]:
791
raise AssertionError("Type was %s, not commit" % type)
792
pending.add(type_data[0])
796
graph = self.repository.get_graph()
797
todo = _find_missing_bzr_revids(graph, pending, processed)
798
ret = PackTupleIterable(self)
799
with ui.ui_factory.nested_progress_bar() as pb:
800
for i, revid in enumerate(graph.iter_topo_order(todo)):
801
pb.update("generating git objects", i, len(todo))
803
rev = self.repository.get_revision(revid)
804
except errors.NoSuchRevision:
806
tree = self.tree_cache.revision_tree(revid)
807
for path, obj in self._revision_to_objects(
808
rev, tree, lossy=lossy):
809
ret.add(obj.id, path)
812
def add_thin_pack(self):
815
fd, path = tempfile.mkstemp(suffix=".pack")
816
f = os.fdopen(fd, 'wb')
819
from .fetch import import_git_objects
822
if os.path.getsize(path) == 0:
825
pd.create_index_v2(path[:-5] + ".idx", self.object_store.get_raw)
828
with self.repository.lock_write():
829
self.repository.start_write_group()
831
import_git_objects(self.repository, self.mapping,
832
p.iterobjects(get_raw=self.get_raw),
834
except BaseException:
835
self.repository.abort_write_group()
838
self.repository.commit_write_group()
841
# The pack isn't kept around anyway, so no point
842
# in treating full packs different from thin packs
843
add_pack = add_thin_pack