1
# Copyright (C) 2007 Canonical Ltd
2
# Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Converters, etc for going between Bazaar and Git ids."""
32
from bzrlib import bencode
34
from bzrlib.util import bencode
35
from bzrlib.inventory import (
38
from bzrlib.foreign import (
43
from bzrlib.revision import (
46
from bzrlib.plugins.git.hg import (
51
DEFAULT_FILE_MODE = stat.S_IFREG | 0644
54
def escape_file_id(file_id):
55
return file_id.replace('_', '__').replace(' ', '_s')
58
def unescape_file_id(file_id):
61
while i < len(file_id):
63
ret.append(file_id[i])
65
if file_id[i+1] == '_':
67
elif file_id[i+1] == 's':
70
raise AssertionError("unknown escape character %s" % file_id[i+1])
76
def fix_person_identifier(text):
77
if "<" in text and ">" in text:
79
return "%s <%s>" % (text, text)
82
def warn_escaped(commit, num_escaped):
83
trace.warning("Escaped %d XML-invalid characters in %s. Will be unable "
84
"to regenerate the SHA map.", num_escaped, commit)
87
def warn_unusual_mode(commit, path, mode):
88
trace.mutter("Unusual file mode %o for %s in %s. Storing as revision property. ",
92
def squash_revision(target_repo, rev):
93
"""Remove characters that can't be stored from a revision, if necessary.
95
:param target_repo: Repository in which the revision will be stored
96
:param rev: Revision object, will be modified in-place
98
if not getattr(target_repo._serializer, "squashes_xml_invalid_characters", True):
100
from bzrlib.xml_serializer import escape_invalid_chars
101
rev.message, num_escaped = escape_invalid_chars(rev.message)
103
warn_escaped(rev.foreign_revid, num_escaped)
104
if 'author' in rev.properties:
105
rev.properties['author'], num_escaped = escape_invalid_chars(
106
rev.properties['author'])
108
warn_escaped(rev.foreign_revid, num_escaped)
109
rev.committer, num_escaped = escape_invalid_chars(rev.committer)
111
warn_escaped(rev.foreign_revid, num_escaped)
114
class BzrGitMapping(foreign.VcsMapping):
115
"""Class that maps between Git and Bazaar semantics."""
119
super(BzrGitMapping, self).__init__(foreign_git)
121
def __eq__(self, other):
122
return type(self) == type(other) and self.revid_prefix == other.revid_prefix
125
def revision_id_foreign_to_bzr(cls, git_rev_id):
126
"""Convert a git revision id handle to a Bazaar revision id."""
127
return "%s:%s" % (cls.revid_prefix, git_rev_id)
130
def revision_id_bzr_to_foreign(cls, bzr_rev_id):
131
"""Convert a Bazaar revision id to a git revision id handle."""
132
if not bzr_rev_id.startswith("%s:" % cls.revid_prefix):
133
raise errors.InvalidRevisionId(bzr_rev_id, cls)
134
return bzr_rev_id[len(cls.revid_prefix)+1:], cls()
136
def generate_file_id(self, path):
137
# Git paths are just bytestrings
138
# We must just hope they are valid UTF-8..
141
return escape_file_id(path)
143
def parse_file_id(self, file_id):
144
if file_id == ROOT_ID:
146
return unescape_file_id(file_id)
148
def import_unusual_file_modes(self, rev, unusual_file_modes):
149
if unusual_file_modes:
150
ret = [(name, unusual_file_modes[name]) for name in sorted(unusual_file_modes.keys())]
151
rev.properties['file-modes'] = bencode.bencode(ret)
153
def export_unusual_file_modes(self, rev):
155
return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(rev.properties['file-modes'].encode("utf-8"))])
159
def _generate_git_svn_metadata(self, rev):
161
return "\ngit-svn-id: %s\n" % rev.properties["git-svn-id"].encode("utf-8")
165
def _generate_hg_message_tail(self, rev):
169
for name in rev.properties:
170
if name == 'hg:extra:branch':
171
branch = rev.properties['hg:extra:branch']
172
elif name.startswith('hg:extra'):
173
extra[name[len('hg:extra:'):]] = base64.b64decode(rev.properties[name])
174
elif name == 'hg:renames':
175
renames = bencode.bdecode(base64.b64decode(rev.properties['hg:renames']))
176
# TODO: Export other properties as 'bzr:' extras?
177
ret = format_hg_metadata(renames, branch, extra)
178
assert isinstance(ret, str)
181
def _extract_git_svn_metadata(self, rev, message):
182
lines = message.split("\n")
183
if not (lines[-1] == "" and lines[-2].startswith("git-svn-id:")):
185
git_svn_id = lines[-2].split(": ", 1)[1]
186
rev.properties['git-svn-id'] = git_svn_id
187
(url, rev, uuid) = parse_git_svn_id(git_svn_id)
188
# FIXME: Convert this to converted-from property somehow..
189
ret = "\n".join(lines[:-2])
190
assert isinstance(ret, str)
193
def _extract_hg_metadata(self, rev, message):
194
(message, renames, branch, extra) = extract_hg_metadata(message)
195
if branch is not None:
196
rev.properties['hg:extra:branch'] = branch
197
for name, value in extra.iteritems():
198
rev.properties['hg:extra:' + name] = base64.b64encode(value)
200
rev.properties['hg:renames'] = base64.b64encode(bencode.bencode([(new, old) for (old, new) in renames.iteritems()]))
203
def _decode_commit_message(self, rev, message):
204
return message.decode("utf-8", "replace")
206
def _encode_commit_message(self, rev, message):
207
return message.encode("utf-8")
209
def export_commit(self, rev, tree_sha, parent_lookup):
210
"""Turn a Bazaar revision in to a Git commit
212
:param tree_sha: Tree sha for the commit
213
:param parent_lookup: Function for looking up the GIT sha equiv of a bzr revision
214
:return dulwich.objects.Commit represent the revision:
216
from dulwich.objects import Commit
218
commit.tree = tree_sha
219
for p in rev.parent_ids:
220
git_p = parent_lookup(p)
221
if git_p is not None:
222
assert len(git_p) == 40, "unexpected length for %r" % git_p
223
commit.parents.append(git_p)
224
commit.committer = fix_person_identifier(rev.committer.encode("utf-8"))
225
commit.author = fix_person_identifier(rev.get_apparent_authors()[0].encode("utf-8"))
226
commit.commit_time = long(rev.timestamp)
227
if 'author-timestamp' in rev.properties:
228
commit.author_time = long(rev.properties['author-timestamp'])
230
commit.author_time = commit.commit_time
231
commit.commit_timezone = rev.timezone
232
if 'author-timezone' in rev.properties:
233
commit.author_timezone = int(rev.properties['author-timezone'])
235
commit.author_timezone = commit.commit_timezone
236
commit.message = self._encode_commit_message(rev, rev.message)
239
def import_commit(self, commit):
240
"""Convert a git commit to a bzr revision.
242
:return: a `bzrlib.revision.Revision` object.
245
raise AssertionError("Commit object can't be None")
246
rev = ForeignRevision(commit.id, self, self.revision_id_foreign_to_bzr(commit.id))
247
rev.parent_ids = tuple([self.revision_id_foreign_to_bzr(p) for p in commit.parents])
248
rev.committer = str(commit.committer).decode("utf-8", "replace")
249
if commit.committer != commit.author:
250
rev.properties['author'] = str(commit.author).decode("utf-8", "replace")
252
if commit.commit_time != commit.author_time:
253
rev.properties['author-timestamp'] = str(commit.author_time)
254
if commit.commit_timezone != commit.author_timezone:
255
rev.properties['author-timezone'] = "%d" % (commit.author_timezone, )
256
rev.timestamp = commit.commit_time
257
rev.timezone = commit.commit_timezone
258
rev.message = self._decode_commit_message(rev, commit.message)
262
class BzrGitMappingv1(BzrGitMapping):
263
revid_prefix = 'git-v1'
267
return self.revid_prefix
270
class BzrGitMappingExperimental(BzrGitMappingv1):
271
revid_prefix = 'git-experimental'
274
def _decode_commit_message(self, rev, message):
275
message = self._extract_hg_metadata(rev, message)
276
message = self._extract_git_svn_metadata(rev, message)
277
return message.decode("utf-8", "replace")
279
def _encode_commit_message(self, rev, message):
280
ret = message.encode("utf-8")
281
ret += self._generate_hg_message_tail(rev)
282
ret += self._generate_git_svn_metadata(rev)
285
def import_commit(self, commit):
286
rev = super(BzrGitMappingExperimental, self).import_commit(commit)
287
rev.properties['converted_revision'] = "git %s\n" % commit.id
291
class GitMappingRegistry(VcsMappingRegistry):
292
"""Registry with available git mappings."""
294
def revision_id_bzr_to_foreign(self, bzr_revid):
295
if bzr_revid == NULL_REVISION:
296
return "0" * 20, None
297
if not bzr_revid.startswith("git-"):
298
raise errors.InvalidRevisionId(bzr_revid, None)
299
(mapping_version, git_sha) = bzr_revid.split(":", 1)
300
mapping = self.get(mapping_version)
301
return mapping.revision_id_bzr_to_foreign(bzr_revid)
303
parse_revision_id = revision_id_bzr_to_foreign
306
mapping_registry = GitMappingRegistry()
307
mapping_registry.register_lazy('git-v1', "bzrlib.plugins.git.mapping",
309
mapping_registry.register_lazy('git-experimental', "bzrlib.plugins.git.mapping",
310
"BzrGitMappingExperimental")
311
mapping_registry.set_default('git-v1')
314
class ForeignGit(ForeignVcs):
315
"""The Git Stupid Content Tracker"""
318
def branch_format(self):
319
from bzrlib.plugins.git.branch import GitBranchFormat
320
return GitBranchFormat()
323
def repository_format(self):
324
from bzrlib.plugins.git.repository import GitRepositoryFormat
325
return GitRepositoryFormat()
328
super(ForeignGit, self).__init__(mapping_registry)
329
self.abbreviation = "git"
332
def serialize_foreign_revid(self, foreign_revid):
336
def show_foreign_revid(cls, foreign_revid):
337
return { "git commit": foreign_revid }
340
foreign_git = ForeignGit()
341
default_mapping = mapping_registry.get_default()()
344
def text_to_blob(texts, entry):
345
from dulwich.objects import Blob
346
text = texts.get_record_stream([(entry.file_id, entry.revision)], 'unordered', True).next().get_bytes_as('fulltext')
352
def symlink_to_blob(entry):
353
from dulwich.objects import Blob
355
blob._text = entry.symlink_target
359
def mode_is_executable(mode):
360
"""Check if mode should be considered executable."""
361
return bool(mode & 0111)
365
"""Determine the Bazaar inventory kind based on Unix file mode."""
366
entry_kind = (mode & 0700000) / 0100000
369
elif entry_kind == 1:
370
file_kind = (mode & 070000) / 010000
376
return 'tree-reference'
378
raise AssertionError(
379
"Unknown file kind %d, perms=%o." % (file_kind, mode,))
381
raise AssertionError(
382
"Unknown kind, perms=%r." % (mode,))
385
def object_mode(kind, executable):
386
if kind == 'directory':
388
elif kind == 'symlink':
394
mode = stat.S_IFREG | 0644
398
elif kind == 'tree-reference':
399
from dulwich.objects import S_IFGITLINK
405
def entry_mode(entry):
406
"""Determine the git file mode for an inventory entry."""
407
return object_mode(entry.kind, entry.executable)
410
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
411
from dulwich.objects import Tree
413
for name in sorted(entry.children.keys()):
414
ie = entry.children[name]
416
mode = unusual_modes[ie.file_id]
418
mode = entry_mode(ie)
419
hexsha = lookup_ie_sha1(ie)
420
if hexsha is not None:
421
tree.add(mode, name.encode("utf-8"), hexsha)
422
if entry.parent_id is not None and len(tree) == 0:
423
# Only the root can be an empty tree
429
def extract_unusual_modes(rev):
431
foreign_revid, mapping = mapping_registry.parse_revision_id(rev.revision_id)
432
except errors.InvalidRevisionId:
435
return mapping.export_unusual_file_modes(rev)
438
def inventory_to_tree_and_blobs(inventory, texts, mapping, unusual_modes, cur=None):
439
"""Convert a Bazaar tree to a Git tree.
441
:return: Yields tuples with object sha1, object and path
443
from dulwich.objects import Tree
450
# stack contains the set of trees that we haven't
451
# finished constructing
452
for path, entry in inventory.iter_entries():
453
while stack and not path.startswith(osutils.pathjoin(cur, "")):
454
# We've hit a file that's not a child of the previous path
457
yield sha, tree, cur.encode("utf-8")
458
mode = unusual_modes.get(cur.encode("utf-8"), stat.S_IFDIR)
459
t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
460
cur, tree = stack.pop()
463
if entry.kind == "directory":
464
stack.append((cur, tree))
468
if entry.kind == "file":
469
blob = text_to_blob(texts, entry)
470
elif entry.kind == "symlink":
471
blob = symlink_to_blob(entry)
473
raise AssertionError("Unknown kind %s" % entry.kind)
475
yield sha, blob, path.encode("utf-8")
476
name = urlutils.basename(path).encode("utf-8")
477
mode = unusual_modes.get(path.encode("utf-8"), entry_mode(entry))
478
tree.add(mode, name, sha)
480
while len(stack) > 1:
483
yield sha, tree, cur.encode("utf-8")
484
mode = unusual_modes.get(cur.encode('utf-8'), stat.S_IFDIR)
485
t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
486
cur, tree = stack.pop()
490
yield tree.id, tree, cur.encode("utf-8")
493
def parse_git_svn_id(text):
494
(head, uuid) = text.rsplit(" ", 1)
495
(full_url, rev) = head.rsplit("@", 1)
496
return (full_url, int(rev), uuid)
added
removed
mapping.py
