1
# Copyright (C) 2008-2018 Jelmer Vernooij <jelmer@jelmer.uk>
2
# Copyright (C) 2007 Canonical Ltd
3
# Copyright (C) 2008 John Carr
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Converters, etc for going between Bazaar and Git ids."""
21
from __future__ import absolute_import
32
from ..bzr.inventory import (
35
from ..foreign import (
40
from ..revision import (
46
UnknownMercurialCommitExtra,
52
from .roundtrip import (
56
deserialize_fileid_map,
61
from urllib.parse import quote
63
from urllib import quote
65
DEFAULT_FILE_MODE = stat.S_IFREG | 0o644
66
HG_RENAME_SOURCE = "HG:rename-source"
69
# This HG extra is used to indicate the commit that this commit was based on.
70
HG_EXTRA_AMEND_SOURCE = "amend_source"
72
FILE_ID_PREFIX = b'git:'
75
def escape_file_id(file_id):
76
return file_id.replace('_', '__').replace(' ', '_s').replace('\x0c', '_c')
79
def unescape_file_id(file_id):
82
while i < len(file_id):
84
ret.append(file_id[i])
86
if file_id[i+1] == '_':
88
elif file_id[i+1] == 's':
90
elif file_id[i+1] == 'c':
93
raise ValueError("unknown escape character %s" %
100
def fix_person_identifier(text):
101
if not "<" in text and not ">" in text:
105
if text.rindex(">") < text.rindex("<"):
106
raise ValueError(text)
107
username, email = text.split("<", 2)[-2:]
108
email = email.split(">", 1)[0]
109
if username.endswith(" "):
110
username = username[:-1]
111
return "%s <%s>" % (username, email)
114
def warn_escaped(commit, num_escaped):
115
trace.warning("Escaped %d XML-invalid characters in %s. Will be unable "
116
"to regenerate the SHA map.", num_escaped, commit)
119
def warn_unusual_mode(commit, path, mode):
120
trace.mutter("Unusual file mode %o for %s in %s. Storing as revision "
121
"property. ", mode, path, commit)
124
class BzrGitMapping(foreign.VcsMapping):
125
"""Class that maps between Git and Bazaar semantics."""
128
BZR_FILE_IDS_FILE = None
130
BZR_DUMMY_FILE = None
132
def is_special_file(self, filename):
133
return (filename in (self.BZR_FILE_IDS_FILE, self.BZR_DUMMY_FILE))
136
super(BzrGitMapping, self).__init__(foreign_vcs_git)
138
def __eq__(self, other):
139
return (type(self) == type(other) and
140
self.revid_prefix == other.revid_prefix)
143
def revision_id_foreign_to_bzr(cls, git_rev_id):
144
"""Convert a git revision id handle to a Bazaar revision id."""
145
from dulwich.protocol import ZERO_SHA
146
if git_rev_id == ZERO_SHA:
148
return "%s:%s" % (cls.revid_prefix, git_rev_id)
151
def revision_id_bzr_to_foreign(cls, bzr_rev_id):
152
"""Convert a Bazaar revision id to a git revision id handle."""
153
if not bzr_rev_id.startswith("%s:" % cls.revid_prefix):
154
raise errors.InvalidRevisionId(bzr_rev_id, cls)
155
return bzr_rev_id[len(cls.revid_prefix)+1:], cls()
157
def generate_file_id(self, path):
158
# Git paths are just bytestrings
159
# We must just hope they are valid UTF-8..
162
if type(path) is unicode:
163
path = path.encode("utf-8")
164
return FILE_ID_PREFIX + escape_file_id(path)
166
def parse_file_id(self, file_id):
167
if file_id == ROOT_ID:
169
if not file_id.startswith(FILE_ID_PREFIX):
171
return unescape_file_id(file_id[len(FILE_ID_PREFIX):])
173
def revid_as_refname(self, revid):
174
return "refs/bzr/%s" % quote(revid)
176
def import_unusual_file_modes(self, rev, unusual_file_modes):
177
if unusual_file_modes:
178
ret = [(path, unusual_file_modes[path])
179
for path in sorted(unusual_file_modes.keys())]
180
rev.properties['file-modes'] = bencode.bencode(ret)
182
def export_unusual_file_modes(self, rev):
184
file_modes = rev.properties['file-modes']
188
return dict(bencode.bdecode(file_modes.encode("utf-8")))
190
def _generate_git_svn_metadata(self, rev, encoding):
192
git_svn_id = rev.properties["git-svn-id"]
196
return "\ngit-svn-id: %s\n" % git_svn_id.encode(encoding)
198
def _generate_hg_message_tail(self, rev):
202
for name in rev.properties:
203
if name == 'hg:extra:branch':
204
branch = rev.properties['hg:extra:branch']
205
elif name.startswith('hg:extra'):
206
extra[name[len('hg:extra:'):]] = base64.b64decode(
207
rev.properties[name])
208
elif name == 'hg:renames':
209
renames = bencode.bdecode(base64.b64decode(
210
rev.properties['hg:renames']))
211
# TODO: Export other properties as 'bzr:' extras?
212
ret = format_hg_metadata(renames, branch, extra)
213
if type(ret) is not str:
217
def _extract_git_svn_metadata(self, rev, message):
218
lines = message.split("\n")
219
if not (lines[-1] == "" and len(lines) >= 2 and lines[-2].startswith("git-svn-id:")):
221
git_svn_id = lines[-2].split(": ", 1)[1]
222
rev.properties['git-svn-id'] = git_svn_id
223
(url, rev, uuid) = parse_git_svn_id(git_svn_id)
224
# FIXME: Convert this to converted-from property somehow..
225
return "\n".join(lines[:-2])
227
def _extract_hg_metadata(self, rev, message):
228
(message, renames, branch, extra) = extract_hg_metadata(message)
229
if branch is not None:
230
rev.properties['hg:extra:branch'] = branch
231
for name, value in extra.iteritems():
232
rev.properties['hg:extra:' + name] = base64.b64encode(value)
234
rev.properties['hg:renames'] = base64.b64encode(bencode.bencode(
235
[(new, old) for (old, new) in renames.iteritems()]))
238
def _extract_bzr_metadata(self, rev, message):
239
(message, metadata) = extract_bzr_metadata(message)
240
return message, metadata
242
def _decode_commit_message(self, rev, message, encoding):
243
return message.decode(encoding), CommitSupplement()
245
def _encode_commit_message(self, rev, message, encoding):
246
return message.encode(encoding)
248
def export_fileid_map(self, fileid_map):
249
"""Export a file id map to a fileid map.
251
:param fileid_map: File id map, mapping paths to file ids
252
:return: A Git blob object (or None if there are no entries)
254
from dulwich.objects import Blob
256
b.set_raw_chunks(serialize_fileid_map(fileid_map))
259
def export_commit(self, rev, tree_sha, parent_lookup, lossy,
261
"""Turn a Bazaar revision in to a Git commit
263
:param tree_sha: Tree sha for the commit
264
:param parent_lookup: Function for looking up the GIT sha equiv of a
266
:param lossy: Whether to store roundtripping information.
267
:param verifiers: Verifiers info
268
:return dulwich.objects.Commit represent the revision:
270
from dulwich.objects import Commit, Tag
272
commit.tree = tree_sha
274
metadata = CommitSupplement()
275
metadata.verifiers = verifiers
279
for p in rev.parent_ids:
281
git_p = parent_lookup(p)
284
if metadata is not None:
285
metadata.explicit_parent_ids = rev.parent_ids
286
if git_p is not None:
288
raise AssertionError("unexpected length for %r" % git_p)
289
parents.append(git_p)
290
commit.parents = parents
292
encoding = rev.properties['git-explicit-encoding']
294
encoding = rev.properties.get('git-implicit-encoding', 'utf-8')
296
commit.encoding = rev.properties['git-explicit-encoding'].encode('ascii')
299
commit.committer = fix_person_identifier(rev.committer.encode(
301
commit.author = fix_person_identifier(
302
rev.get_apparent_authors()[0].encode(encoding))
303
commit.commit_time = long(rev.timestamp)
304
if 'author-timestamp' in rev.properties:
305
commit.author_time = long(rev.properties['author-timestamp'])
307
commit.author_time = commit.commit_time
308
commit._commit_timezone_neg_utc = "commit-timezone-neg-utc" in rev.properties
309
commit.commit_timezone = rev.timezone
310
commit._author_timezone_neg_utc = "author-timezone-neg-utc" in rev.properties
311
if 'author-timezone' in rev.properties:
312
commit.author_timezone = int(rev.properties['author-timezone'])
314
commit.author_timezone = commit.commit_timezone
315
if 'git-gpg-signature' in rev.properties:
316
commit.gpgsig = rev.properties['git-gpg-signature'].encode('ascii')
317
commit.message = self._encode_commit_message(rev, rev.message,
319
if type(commit.message) is not str:
320
raise TypeError(commit.message)
321
if metadata is not None:
323
mapping_registry.parse_revision_id(rev.revision_id)
324
except errors.InvalidRevisionId:
325
metadata.revision_id = rev.revision_id
326
mapping_properties = set(
327
['author', 'author-timezone', 'author-timezone-neg-utc',
328
'commit-timezone-neg-utc', 'git-implicit-encoding',
329
'git-gpg-signature', 'git-explicit-encoding',
330
'author-timestamp', 'file-modes'])
331
for k, v in rev.properties.iteritems():
332
if not k in mapping_properties:
333
metadata.properties[k] = v
334
if not lossy and metadata:
335
if self.roundtripping:
336
commit.message = inject_bzr_metadata(commit.message, metadata,
339
raise NoPushSupport()
340
if type(commit.message) is not str:
341
raise TypeError(commit.message)
343
propname = 'git-mergetag-0'
344
while propname in rev.properties:
345
commit.mergetag.append(Tag.from_string(rev.properties[propname].encode(encoding)))
347
propname = 'git-mergetag-%d' % i
348
if 'git-extra' in rev.properties:
349
commit.extra.extend([l.split(' ', 1) for l in rev.properties['git-extra'].splitlines()])
352
def import_fileid_map(self, blob):
353
"""Convert a git file id map blob.
355
:param blob: Git blob object with fileid map
356
:return: Dictionary mapping paths to file ids
358
return deserialize_fileid_map(blob.data)
360
def import_commit(self, commit, lookup_parent_revid):
361
"""Convert a git commit to a bzr revision.
363
:return: a `breezy.revision.Revision` object, foreign revid and a
367
raise AssertionError("Commit object can't be None")
368
rev = ForeignRevision(commit.id, self,
369
self.revision_id_foreign_to_bzr(commit.id))
370
rev.git_metadata = None
371
def decode_using_encoding(rev, commit, encoding):
372
rev.committer = str(commit.committer).decode(encoding)
373
if commit.committer != commit.author:
374
rev.properties['author'] = str(commit.author).decode(encoding)
375
rev.message, rev.git_metadata = self._decode_commit_message(
376
rev, commit.message, encoding)
377
if commit.encoding is not None:
378
rev.properties['git-explicit-encoding'] = commit.encoding
379
decode_using_encoding(rev, commit, commit.encoding)
381
for encoding in ('utf-8', 'latin1'):
383
decode_using_encoding(rev, commit, encoding)
384
except UnicodeDecodeError:
387
if encoding != 'utf-8':
388
rev.properties['git-implicit-encoding'] = encoding
390
if commit.commit_time != commit.author_time:
391
rev.properties['author-timestamp'] = str(commit.author_time)
392
if commit.commit_timezone != commit.author_timezone:
393
rev.properties['author-timezone'] = "%d" % commit.author_timezone
394
if commit._author_timezone_neg_utc:
395
rev.properties['author-timezone-neg-utc'] = ""
396
if commit._commit_timezone_neg_utc:
397
rev.properties['commit-timezone-neg-utc'] = ""
399
rev.properties['git-gpg-signature'] = commit.gpgsig.decode('ascii')
401
for i, tag in enumerate(commit.mergetag):
402
rev.properties['git-mergetag-%d' % i] = tag.as_raw_string()
403
rev.timestamp = commit.commit_time
404
rev.timezone = commit.commit_timezone
405
rev.parent_ids = None
406
if rev.git_metadata is not None:
407
md = rev.git_metadata
408
roundtrip_revid = md.revision_id
409
if md.explicit_parent_ids:
410
rev.parent_ids = md.explicit_parent_ids
411
rev.properties.update(md.properties)
412
verifiers = md.verifiers
414
roundtrip_revid = None
416
if rev.parent_ids is None:
418
for p in commit.parents:
420
parents.append(lookup_parent_revid(p))
422
parents.append(self.revision_id_foreign_to_bzr(p))
423
rev.parent_ids = tuple(parents)
424
unknown_extra_fields = []
426
for k, v in commit.extra:
427
if k == HG_RENAME_SOURCE:
428
extra_lines.append(k + ' ' + v + '\n')
430
hgk, hgv = v.split(':', 1)
431
if hgk not in (HG_EXTRA_AMEND_SOURCE, ):
432
raise UnknownMercurialCommitExtra(commit, hgk)
433
extra_lines.append(k + ' ' + v + '\n')
435
unknown_extra_fields.append(k)
436
if unknown_extra_fields:
437
raise UnknownCommitExtra(commit, unknown_extra_fields)
439
rev.properties['git-extra'] = ''.join(extra_lines)
440
return rev, roundtrip_revid, verifiers
442
def get_fileid_map(self, lookup_object, tree_sha):
443
"""Obtain a fileid map for a particular tree.
445
:param lookup_object: Function for looking up an object
446
:param tree_sha: SHA of the root tree
447
:return: GitFileIdMap instance
450
file_id_map_sha = lookup_object(tree_sha)[self.BZR_FILE_IDS_FILE][1]
454
file_ids = self.import_fileid_map(lookup_object(file_id_map_sha))
455
return GitFileIdMap(file_ids, self)
458
class BzrGitMappingv1(BzrGitMapping):
459
revid_prefix = 'git-v1'
463
return self.revid_prefix
466
class BzrGitMappingExperimental(BzrGitMappingv1):
467
revid_prefix = 'git-experimental'
471
BZR_FILE_IDS_FILE = '.bzrfileids'
473
BZR_DUMMY_FILE = '.bzrdummy'
475
def _decode_commit_message(self, rev, message, encoding):
476
message = self._extract_hg_metadata(rev, message)
477
message = self._extract_git_svn_metadata(rev, message)
478
message, metadata = self._extract_bzr_metadata(rev, message)
479
return message.decode(encoding), metadata
481
def _encode_commit_message(self, rev, message, encoding):
482
ret = message.encode(encoding)
483
ret += self._generate_hg_message_tail(rev)
484
ret += self._generate_git_svn_metadata(rev, encoding)
487
def import_commit(self, commit, lookup_parent_revid):
488
rev, roundtrip_revid, verifiers = super(BzrGitMappingExperimental, self).import_commit(commit, lookup_parent_revid)
489
rev.properties['converted_revision'] = "git %s\n" % commit.id
490
return rev, roundtrip_revid, verifiers
493
class GitMappingRegistry(VcsMappingRegistry):
494
"""Registry with available git mappings."""
496
def revision_id_bzr_to_foreign(self, bzr_revid):
497
if bzr_revid == NULL_REVISION:
498
from dulwich.protocol import ZERO_SHA
499
return ZERO_SHA, None
500
if not bzr_revid.startswith("git-"):
501
raise errors.InvalidRevisionId(bzr_revid, None)
502
(mapping_version, git_sha) = bzr_revid.split(":", 1)
503
mapping = self.get(mapping_version)
504
return mapping.revision_id_bzr_to_foreign(bzr_revid)
506
parse_revision_id = revision_id_bzr_to_foreign
509
mapping_registry = GitMappingRegistry()
510
mapping_registry.register_lazy('git-v1', __name__,
512
mapping_registry.register_lazy('git-experimental',
513
__name__, "BzrGitMappingExperimental")
514
# Uncomment the next line to enable the experimental bzr-git mappings.
515
# This will make sure all bzr metadata is pushed into git, allowing for
516
# full roundtripping later.
517
# NOTE: THIS IS EXPERIMENTAL. IT MAY EAT YOUR DATA OR CORRUPT
518
# YOUR BZR OR GIT REPOSITORIES. USE WITH CARE.
519
#mapping_registry.set_default('git-experimental')
520
mapping_registry.set_default('git-v1')
523
class ForeignGit(ForeignVcs):
524
"""The Git Stupid Content Tracker"""
527
def branch_format(self):
528
from .branch import LocalGitBranchFormat
529
return LocalGitBranchFormat()
532
def repository_format(self):
533
from .repository import GitRepositoryFormat
534
return GitRepositoryFormat()
537
super(ForeignGit, self).__init__(mapping_registry)
538
self.abbreviation = "git"
541
def serialize_foreign_revid(self, foreign_revid):
545
def show_foreign_revid(cls, foreign_revid):
546
return { "git commit": foreign_revid }
549
foreign_vcs_git = ForeignGit()
550
default_mapping = mapping_registry.get_default()()
553
def symlink_to_blob(symlink_target):
554
from dulwich.objects import Blob
556
if type(symlink_target) == unicode:
557
symlink_target = symlink_target.encode('utf-8')
558
blob.data = symlink_target
562
def mode_is_executable(mode):
563
"""Check if mode should be considered executable."""
564
return bool(mode & 0o111)
568
"""Determine the Bazaar inventory kind based on Unix file mode."""
571
entry_kind = (mode & 0o700000) / 0o100000
574
elif entry_kind == 1:
575
file_kind = (mode & 0o70000) / 0o10000
581
return 'tree-reference'
583
raise AssertionError(
584
"Unknown file kind %d, perms=%o." % (file_kind, mode,))
586
raise AssertionError(
587
"Unknown kind, perms=%r." % (mode,))
590
def object_mode(kind, executable):
591
if kind == 'directory':
593
elif kind == 'symlink':
599
mode = stat.S_IFREG | 0o644
603
elif kind == 'tree-reference':
604
from dulwich.objects import S_IFGITLINK
610
def entry_mode(entry):
611
"""Determine the git file mode for an inventory entry."""
612
return object_mode(entry.kind, getattr(entry, 'executable', False))
615
def extract_unusual_modes(rev):
617
foreign_revid, mapping = mapping_registry.parse_revision_id(
619
except errors.InvalidRevisionId:
622
return mapping.export_unusual_file_modes(rev)
625
def parse_git_svn_id(text):
626
(head, uuid) = text.rsplit(" ", 1)
627
(full_url, rev) = head.rsplit("@", 1)
628
return (full_url, int(rev), uuid)
631
class GitFileIdMap(object):
633
def __init__(self, file_ids, mapping):
634
self.file_ids = file_ids
636
self.mapping = mapping
638
def all_file_ids(self):
639
return self.file_ids.values()
641
def set_file_id(self, path, file_id):
642
if type(path) is not str:
643
raise TypeError(path)
644
if type(file_id) is not str:
645
raise TypeError(file_id)
646
self.file_ids[path] = file_id
648
def lookup_file_id(self, path):
649
if type(path) is not str:
650
raise TypeError(path)
652
file_id = self.file_ids[path]
654
file_id = self.mapping.generate_file_id(path)
655
if type(file_id) is not str:
656
raise TypeError(file_id)
659
def lookup_path(self, file_id):
660
if self.paths is None:
662
for k, v in self.file_ids.iteritems():
665
path = self.paths[file_id]
667
return self.mapping.parse_file_id(file_id)
669
if type(path) is not str:
670
raise TypeError(path)
674
return self.__class__(dict(self.file_ids), self.mapping)
677
def needs_roundtripping(repo, revid):
679
mapping_registry.parse_revision_id(revid)
680
except errors.InvalidRevisionId: