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
33
from ..foreign import (
38
from ..revision import (
42
from ..sixish import (
54
from .roundtrip import (
61
DEFAULT_FILE_MODE = stat.S_IFREG | 0o644
62
HG_RENAME_SOURCE = b"HG:rename-source"
63
HG_EXTRA = b"HG:extra"
65
# This HG extra is used to indicate the commit that this commit was based on.
66
HG_EXTRA_AMEND_SOURCE = b"amend_source"
68
FILE_ID_PREFIX = b'git:'
71
ROOT_ID = b"TREE_ROOT"
74
class UnknownCommitExtra(errors.BzrError):
75
_fmt = "Unknown extra fields in %(object)r: %(fields)r."
77
def __init__(self, object, fields):
78
errors.BzrError.__init__(self)
80
self.fields = ",".join(fields)
83
class UnknownMercurialCommitExtra(errors.BzrError):
84
_fmt = "Unknown mercurial extra fields in %(object)r: %(fields)r."
86
def __init__(self, object, fields):
87
errors.BzrError.__init__(self)
89
self.fields = b",".join(fields)
92
def escape_file_id(file_id):
93
file_id = file_id.replace(b'_', b'__')
94
file_id = file_id.replace(b' ', b'_s')
95
file_id = file_id.replace(b'\x0c', b'_c')
99
def unescape_file_id(file_id):
102
while i < len(file_id):
103
if file_id[i:i + 1] != b'_':
104
ret.append(file_id[i])
106
if file_id[i + 1:i + 2] == b'_':
108
elif file_id[i + 1:i + 2] == b's':
110
elif file_id[i + 1:i + 2] == b'c':
111
ret.append(b"\x0c"[0])
113
raise ValueError("unknown escape character %s" %
114
file_id[i + 1:i + 2])
120
def fix_person_identifier(text):
121
if b"<" not in text and b">" not in text:
124
elif b">" not in text:
127
if text.rindex(b">") < text.rindex(b"<"):
128
raise ValueError(text)
129
username, email = text.split(b"<", 2)[-2:]
130
email = email.split(b">", 1)[0]
131
if username.endswith(b" "):
132
username = username[:-1]
133
return b"%s <%s>" % (username, email)
136
def decode_git_path(path):
137
"""Take a git path and decode it."""
139
return path.decode('utf-8')
140
except UnicodeDecodeError:
142
return path.decode('utf-8', 'surrogateescape')
146
def encode_git_path(path):
147
"""Take a regular path and encode it for git."""
149
return path.encode('utf-8')
150
except UnicodeEncodeError:
152
return path.encode('utf-8', 'surrogateescape')
156
def warn_escaped(commit, num_escaped):
157
trace.warning("Escaped %d XML-invalid characters in %s. Will be unable "
158
"to regenerate the SHA map.", num_escaped, commit)
161
def warn_unusual_mode(commit, path, mode):
162
trace.mutter("Unusual file mode %o for %s in %s. Storing as revision "
163
"property. ", mode, path, commit)
166
class BzrGitMapping(foreign.VcsMapping):
167
"""Class that maps between Git and Bazaar semantics."""
170
BZR_DUMMY_FILE = None
172
def is_special_file(self, filename):
173
return (filename in (self.BZR_DUMMY_FILE, ))
176
super(BzrGitMapping, self).__init__(foreign_vcs_git)
178
def __eq__(self, other):
179
return (type(self) == type(other)
180
and self.revid_prefix == other.revid_prefix)
183
def revision_id_foreign_to_bzr(cls, git_rev_id):
184
"""Convert a git revision id handle to a Bazaar revision id."""
185
from dulwich.protocol import ZERO_SHA
186
if git_rev_id == ZERO_SHA:
188
return b"%s:%s" % (cls.revid_prefix, git_rev_id)
191
def revision_id_bzr_to_foreign(cls, bzr_rev_id):
192
"""Convert a Bazaar revision id to a git revision id handle."""
193
if not bzr_rev_id.startswith(b"%s:" % cls.revid_prefix):
194
raise errors.InvalidRevisionId(bzr_rev_id, cls)
195
return bzr_rev_id[len(cls.revid_prefix) + 1:], cls()
197
def generate_file_id(self, path):
198
# Git paths are just bytestrings
199
# We must just hope they are valid UTF-8..
200
if isinstance(path, text_type):
201
path = encode_git_path(path)
204
return FILE_ID_PREFIX + escape_file_id(path)
206
def parse_file_id(self, file_id):
207
if file_id == ROOT_ID:
209
if not file_id.startswith(FILE_ID_PREFIX):
211
return decode_git_path(unescape_file_id(file_id[len(FILE_ID_PREFIX):]))
213
def revid_as_refname(self, revid):
214
if not isinstance(revid, bytes):
215
raise TypeError(revid)
217
revid = revid.decode('utf-8')
218
quoted_revid = urlutils.quote(revid)
219
return b"refs/bzr/" + quoted_revid.encode('utf-8')
221
def import_unusual_file_modes(self, rev, unusual_file_modes):
222
if unusual_file_modes:
223
ret = [(path, unusual_file_modes[path])
224
for path in sorted(unusual_file_modes.keys())]
225
rev.properties[u'file-modes'] = bencode.bencode(ret)
227
def export_unusual_file_modes(self, rev):
229
file_modes = rev.properties[u'file-modes']
233
return dict(bencode.bdecode(file_modes.encode("utf-8")))
235
def _generate_git_svn_metadata(self, rev, encoding):
237
git_svn_id = rev.properties[u"git-svn-id"]
241
return "\ngit-svn-id: %s\n" % git_svn_id.encode(encoding)
243
def _generate_hg_message_tail(self, rev):
247
for name in rev.properties:
248
if name == u'hg:extra:branch':
249
branch = rev.properties[u'hg:extra:branch']
250
elif name.startswith(u'hg:extra'):
251
extra[name[len(u'hg:extra:'):]] = base64.b64decode(
252
rev.properties[name])
253
elif name == u'hg:renames':
254
renames = bencode.bdecode(base64.b64decode(
255
rev.properties[u'hg:renames']))
256
# TODO: Export other properties as 'bzr:' extras?
257
ret = format_hg_metadata(renames, branch, extra)
258
if not isinstance(ret, bytes):
262
def _extract_git_svn_metadata(self, rev, message):
263
lines = message.split("\n")
264
if not (lines[-1] == "" and len(lines) >= 2 and
265
lines[-2].startswith("git-svn-id:")):
267
git_svn_id = lines[-2].split(": ", 1)[1]
268
rev.properties[u'git-svn-id'] = git_svn_id
269
(url, rev, uuid) = parse_git_svn_id(git_svn_id)
270
# FIXME: Convert this to converted-from property somehow..
271
return "\n".join(lines[:-2])
273
def _extract_hg_metadata(self, rev, message):
274
(message, renames, branch, extra) = extract_hg_metadata(message)
275
if branch is not None:
276
rev.properties[u'hg:extra:branch'] = branch
277
for name, value in viewitems(extra):
278
rev.properties[u'hg:extra:' + name] = base64.b64encode(value)
280
rev.properties[u'hg:renames'] = base64.b64encode(bencode.bencode(
281
[(new, old) for (old, new) in viewitems(renames)]))
284
def _extract_bzr_metadata(self, rev, message):
285
(message, metadata) = extract_bzr_metadata(message)
286
return message, metadata
288
def _decode_commit_message(self, rev, message, encoding):
289
return message.decode(encoding), CommitSupplement()
291
def _encode_commit_message(self, rev, message, encoding):
292
return message.encode(encoding)
294
def export_commit(self, rev, tree_sha, parent_lookup, lossy,
296
"""Turn a Bazaar revision in to a Git commit
298
:param tree_sha: Tree sha for the commit
299
:param parent_lookup: Function for looking up the GIT sha equiv of a
301
:param lossy: Whether to store roundtripping information.
302
:param verifiers: Verifiers info
303
:return dulwich.objects.Commit represent the revision:
305
from dulwich.objects import Commit, Tag
307
commit.tree = tree_sha
309
metadata = CommitSupplement()
310
metadata.verifiers = verifiers
314
for p in rev.parent_ids:
316
git_p = parent_lookup(p)
319
if metadata is not None:
320
metadata.explicit_parent_ids = rev.parent_ids
321
if git_p is not None:
323
raise AssertionError("unexpected length for %r" % git_p)
324
parents.append(git_p)
325
commit.parents = parents
327
encoding = rev.properties[u'git-explicit-encoding']
329
encoding = rev.properties.get(u'git-implicit-encoding', 'utf-8')
331
commit.encoding = rev.properties[u'git-explicit-encoding'].encode(
335
commit.committer = fix_person_identifier(rev.committer.encode(
337
commit.author = fix_person_identifier(
338
rev.get_apparent_authors()[0].encode(encoding))
339
# TODO(jelmer): Don't use this hack.
340
long = getattr(__builtins__, 'long', int)
341
commit.commit_time = long(rev.timestamp)
342
if u'author-timestamp' in rev.properties:
343
commit.author_time = long(rev.properties[u'author-timestamp'])
345
commit.author_time = commit.commit_time
346
commit._commit_timezone_neg_utc = (
347
u"commit-timezone-neg-utc" in rev.properties)
348
commit.commit_timezone = rev.timezone
349
commit._author_timezone_neg_utc = (
350
u"author-timezone-neg-utc" in rev.properties)
351
if u'author-timezone' in rev.properties:
352
commit.author_timezone = int(rev.properties[u'author-timezone'])
354
commit.author_timezone = commit.commit_timezone
355
if u'git-gpg-signature' in rev.properties:
356
commit.gpgsig = rev.properties[u'git-gpg-signature'].encode(
357
'utf-8', 'surrogateescape')
358
commit.message = self._encode_commit_message(rev, rev.message,
360
if not isinstance(commit.message, bytes):
361
raise TypeError(commit.message)
362
if metadata is not None:
364
mapping_registry.parse_revision_id(rev.revision_id)
365
except errors.InvalidRevisionId:
366
metadata.revision_id = rev.revision_id
367
mapping_properties = set(
368
[u'author', u'author-timezone', u'author-timezone-neg-utc',
369
u'commit-timezone-neg-utc', u'git-implicit-encoding',
370
u'git-gpg-signature', u'git-explicit-encoding',
371
u'author-timestamp', u'file-modes'])
372
for k, v in viewitems(rev.properties):
373
if k not in mapping_properties:
374
metadata.properties[k] = v
375
if not lossy and metadata:
376
if self.roundtripping:
377
commit.message = inject_bzr_metadata(commit.message, metadata,
381
None, None, self, revision_id=rev.revision_id)
382
if not isinstance(commit.message, bytes):
383
raise TypeError(commit.message)
385
propname = u'git-mergetag-0'
386
while propname in rev.properties:
387
commit.mergetag.append(Tag.from_string(rev.properties[propname]))
389
propname = u'git-mergetag-%d' % i
390
if u'git-extra' in rev.properties:
393
for l in rev.properties[u'git-extra'].splitlines()])
396
def get_revision_id(self, commit):
398
encoding = commit.encoding.decode('ascii')
402
message, metadata = self._decode_commit_message(
403
None, commit.message, encoding)
404
except UnicodeDecodeError:
407
if metadata.revision_id:
408
return metadata.revision_id
409
return self.revision_id_foreign_to_bzr(commit.id)
411
def import_commit(self, commit, lookup_parent_revid, strict=True):
412
"""Convert a git commit to a bzr revision.
414
:return: a `breezy.revision.Revision` object, foreign revid and a
418
raise AssertionError("Commit object can't be None")
419
rev = ForeignRevision(commit.id, self,
420
self.revision_id_foreign_to_bzr(commit.id))
421
rev.git_metadata = None
423
def decode_using_encoding(rev, commit, encoding):
424
rev.committer = commit.committer.decode(encoding)
425
if commit.committer != commit.author:
426
rev.properties[u'author'] = commit.author.decode(encoding)
427
rev.message, rev.git_metadata = self._decode_commit_message(
428
rev, commit.message, encoding)
429
if commit.encoding is not None:
430
rev.properties[u'git-explicit-encoding'] = commit.encoding.decode(
432
decode_using_encoding(rev, commit, commit.encoding.decode('ascii'))
434
for encoding in ('utf-8', 'latin1'):
436
decode_using_encoding(rev, commit, encoding)
437
except UnicodeDecodeError:
440
if encoding != 'utf-8':
441
rev.properties[u'git-implicit-encoding'] = encoding
443
if commit.commit_time != commit.author_time:
444
rev.properties[u'author-timestamp'] = str(commit.author_time)
445
if commit.commit_timezone != commit.author_timezone:
446
rev.properties[u'author-timezone'] = "%d" % commit.author_timezone
447
if commit._author_timezone_neg_utc:
448
rev.properties[u'author-timezone-neg-utc'] = ""
449
if commit._commit_timezone_neg_utc:
450
rev.properties[u'commit-timezone-neg-utc'] = ""
452
rev.properties[u'git-gpg-signature'] = commit.gpgsig.decode(
453
'utf-8', 'surrogateescape')
455
for i, tag in enumerate(commit.mergetag):
456
rev.properties[u'git-mergetag-%d' % i] = tag.as_raw_string()
457
rev.timestamp = commit.commit_time
458
rev.timezone = commit.commit_timezone
459
rev.parent_ids = None
460
if rev.git_metadata is not None:
461
md = rev.git_metadata
462
roundtrip_revid = md.revision_id
463
if md.explicit_parent_ids:
464
rev.parent_ids = md.explicit_parent_ids
465
rev.properties.update(md.properties)
466
verifiers = md.verifiers
468
roundtrip_revid = None
470
if rev.parent_ids is None:
472
for p in commit.parents:
474
parents.append(lookup_parent_revid(p))
476
parents.append(self.revision_id_foreign_to_bzr(p))
477
rev.parent_ids = list(parents)
478
unknown_extra_fields = []
480
for k, v in commit.extra:
481
if k == HG_RENAME_SOURCE:
482
extra_lines.append(k + b' ' + v + b'\n')
484
hgk, hgv = v.split(b':', 1)
485
if hgk not in (HG_EXTRA_AMEND_SOURCE, ) and strict:
486
raise UnknownMercurialCommitExtra(commit, [hgk])
487
extra_lines.append(k + b' ' + v + b'\n')
489
unknown_extra_fields.append(k)
490
if unknown_extra_fields and strict:
491
raise UnknownCommitExtra(
493
[f.decode('ascii', 'replace') for f in unknown_extra_fields])
495
rev.properties[u'git-extra'] = b''.join(extra_lines)
496
return rev, roundtrip_revid, verifiers
499
class BzrGitMappingv1(BzrGitMapping):
500
revid_prefix = b'git-v1'
504
return self.revid_prefix
507
class BzrGitMappingExperimental(BzrGitMappingv1):
508
revid_prefix = b'git-experimental'
510
roundtripping = False
512
BZR_DUMMY_FILE = '.bzrdummy'
514
def _decode_commit_message(self, rev, message, encoding):
517
message = self._extract_hg_metadata(rev, message)
518
message = self._extract_git_svn_metadata(rev, message)
519
message, metadata = self._extract_bzr_metadata(rev, message)
520
return message.decode(encoding), metadata
522
def _encode_commit_message(self, rev, message, encoding):
523
ret = message.encode(encoding)
524
ret += self._generate_hg_message_tail(rev)
525
ret += self._generate_git_svn_metadata(rev, encoding)
528
def import_commit(self, commit, lookup_parent_revid, strict=True):
529
rev, roundtrip_revid, verifiers = super(
530
BzrGitMappingExperimental, self).import_commit(
531
commit, lookup_parent_revid, strict)
532
rev.properties[u'converted_revision'] = "git %s\n" % commit.id
533
return rev, roundtrip_revid, verifiers
536
class GitMappingRegistry(VcsMappingRegistry):
537
"""Registry with available git mappings."""
539
def revision_id_bzr_to_foreign(self, bzr_revid):
540
if bzr_revid == NULL_REVISION:
541
from dulwich.protocol import ZERO_SHA
542
return ZERO_SHA, None
543
if not bzr_revid.startswith(b"git-"):
544
raise errors.InvalidRevisionId(bzr_revid, None)
545
(mapping_version, git_sha) = bzr_revid.split(b":", 1)
546
mapping = self.get(mapping_version)
547
return mapping.revision_id_bzr_to_foreign(bzr_revid)
549
parse_revision_id = revision_id_bzr_to_foreign
552
mapping_registry = GitMappingRegistry()
553
mapping_registry.register_lazy(b'git-v1', __name__,
555
mapping_registry.register_lazy(b'git-experimental',
556
__name__, "BzrGitMappingExperimental")
557
# Uncomment the next line to enable the experimental bzr-git mappings.
558
# This will make sure all bzr metadata is pushed into git, allowing for
559
# full roundtripping later.
560
# NOTE: THIS IS EXPERIMENTAL. IT MAY EAT YOUR DATA OR CORRUPT
561
# YOUR BZR OR GIT REPOSITORIES. USE WITH CARE.
562
# mapping_registry.set_default('git-experimental')
563
mapping_registry.set_default(b'git-v1')
566
class ForeignGit(ForeignVcs):
567
"""The Git Stupid Content Tracker"""
570
def branch_format(self):
571
from .branch import LocalGitBranchFormat
572
return LocalGitBranchFormat()
575
def repository_format(self):
576
from .repository import GitRepositoryFormat
577
return GitRepositoryFormat()
580
super(ForeignGit, self).__init__(mapping_registry)
581
self.abbreviation = "git"
584
def serialize_foreign_revid(self, foreign_revid):
588
def show_foreign_revid(cls, foreign_revid):
589
return {"git commit": foreign_revid.decode('utf-8')}
592
foreign_vcs_git = ForeignGit()
593
default_mapping = mapping_registry.get_default()()
596
def symlink_to_blob(symlink_target):
597
from dulwich.objects import Blob
599
if isinstance(symlink_target, text_type):
600
symlink_target = encode_git_path(symlink_target)
601
blob.data = symlink_target
605
def mode_is_executable(mode):
606
"""Check if mode should be considered executable."""
607
return bool(mode & 0o111)
611
"""Determine the Bazaar inventory kind based on Unix file mode."""
614
entry_kind = (mode & 0o700000) / 0o100000
617
elif entry_kind == 1:
618
file_kind = (mode & 0o70000) / 0o10000
624
return 'tree-reference'
626
raise AssertionError(
627
"Unknown file kind %d, perms=%o." % (file_kind, mode,))
629
raise AssertionError(
630
"Unknown kind, perms=%r." % (mode,))
633
def object_mode(kind, executable):
634
if kind == 'directory':
636
elif kind == 'symlink':
642
mode = stat.S_IFREG | 0o644
646
elif kind == 'tree-reference':
647
from dulwich.objects import S_IFGITLINK
653
def entry_mode(entry):
654
"""Determine the git file mode for an inventory entry."""
655
return object_mode(entry.kind, getattr(entry, 'executable', False))
658
def extract_unusual_modes(rev):
660
foreign_revid, mapping = mapping_registry.parse_revision_id(
662
except errors.InvalidRevisionId:
665
return mapping.export_unusual_file_modes(rev)
668
def parse_git_svn_id(text):
669
(head, uuid) = text.rsplit(" ", 1)
670
(full_url, rev) = head.rsplit("@", 1)
671
return (full_url, int(rev), uuid)
674
def needs_roundtripping(repo, revid):
676
mapping_registry.parse_revision_id(revid)
677
except errors.InvalidRevisionId: