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."""
31
from bzrlib.inventory import (
34
from bzrlib.foreign import (
40
DEFAULT_FILE_MODE = stat.S_IFREG | 0644
43
def escape_file_id(file_id):
44
return file_id.replace('_', '__').replace(' ', '_s')
47
def unescape_file_id(file_id):
50
while i < len(file_id):
52
ret.append(file_id[i])
54
if file_id[i+1] == '_':
56
elif file_id[i+1] == 's':
59
raise AssertionError("unknown escape character %s" % file_id[i+1])
65
def fix_person_identifier(text):
66
if "<" in text and ">" in text:
68
return "%s <%s>" % (text, text)
71
def warn_escaped(commit, num_escaped):
72
trace.warning("Escaped %d XML-invalid characters in %s. Will be unable "
73
"to regenerate the SHA map.", num_escaped, commit)
76
def warn_unusual_mode(commit, path, mode):
77
trace.mutter("Unusual file mode %o for %s in %s. Storing as revision property. ",
81
def squash_revision(target_repo, rev):
82
"""Remove characters that can't be stored from a revision, if necessary.
84
:param target_repo: Repository in which the revision will be stored
85
:param rev: Revision object, will be modified in-place
87
if not getattr(target_repo._serializer, "squashes_xml_invalid_characters", True):
89
from bzrlib.xml_serializer import escape_invalid_chars
90
rev.message, num_escaped = escape_invalid_chars(rev.message)
92
warn_escaped(rev.foreign_revid, num_escaped)
93
if 'author' in rev.properties:
94
rev.properties['author'], num_escaped = escape_invalid_chars(
95
rev.properties['author'])
97
warn_escaped(rev.foreign_revid, num_escaped)
98
rev.committer, num_escaped = escape_invalid_chars(rev.committer)
100
warn_escaped(rev.foreign_revid, num_escaped)
103
class BzrGitMapping(foreign.VcsMapping):
104
"""Class that maps between Git and Bazaar semantics."""
108
super(BzrGitMapping, self).__init__(foreign_git)
110
def __eq__(self, other):
111
return type(self) == type(other) and self.revid_prefix == other.revid_prefix
114
def revision_id_foreign_to_bzr(cls, git_rev_id):
115
"""Convert a git revision id handle to a Bazaar revision id."""
116
return "%s:%s" % (cls.revid_prefix, git_rev_id)
119
def revision_id_bzr_to_foreign(cls, bzr_rev_id):
120
"""Convert a Bazaar revision id to a git revision id handle."""
121
if not bzr_rev_id.startswith("%s:" % cls.revid_prefix):
122
raise errors.InvalidRevisionId(bzr_rev_id, cls)
123
return bzr_rev_id[len(cls.revid_prefix)+1:], cls()
125
def generate_file_id(self, path):
126
# Git paths are just bytestrings
127
# We must just hope they are valid UTF-8..
130
return escape_file_id(path)
132
def parse_file_id(self, file_id):
133
if file_id == ROOT_ID:
135
return unescape_file_id(file_id)
137
def import_unusual_file_modes(self, rev, unusual_file_modes):
138
if unusual_file_modes:
139
ret = [(name, unusual_file_modes[name]) for name in sorted(unusual_file_modes.keys())]
140
rev.properties['file-modes'] = bencode.bencode(ret)
142
def export_unusual_file_modes(self, rev):
144
return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(rev.properties['file-modes'])])
148
def import_commit(self, commit):
149
"""Convert a git commit to a bzr revision.
151
:return: a `bzrlib.revision.Revision` object.
154
raise AssertionError("Commit object can't be None")
155
rev = ForeignRevision(commit.id, self, self.revision_id_foreign_to_bzr(commit.id))
156
rev.parent_ids = tuple([self.revision_id_foreign_to_bzr(p) for p in commit.parents])
157
rev.message = commit.message.decode("utf-8", "replace")
158
rev.committer = str(commit.committer).decode("utf-8", "replace")
159
if commit.committer != commit.author:
160
rev.properties['author'] = str(commit.author).decode("utf-8", "replace")
162
if commit.commit_time != commit.author_time:
163
rev.properties['author-timestamp'] = str(commit.author_time)
164
if commit.commit_timezone != commit.author_timezone:
165
rev.properties['author-timezone'] = "%d" % (commit.author_timezone, )
166
rev.timestamp = commit.commit_time
167
rev.timezone = commit.commit_timezone
171
class BzrGitMappingv1(BzrGitMapping):
172
revid_prefix = 'git-v1'
176
return self.revid_prefix
179
class BzrGitMappingExperimental(BzrGitMappingv1):
180
revid_prefix = 'git-experimental'
184
class GitMappingRegistry(VcsMappingRegistry):
185
"""Registry with available git mappings."""
187
def revision_id_bzr_to_foreign(self, bzr_revid):
188
if not bzr_revid.startswith("git-"):
189
raise errors.InvalidRevisionId(bzr_revid, None)
190
(mapping_version, git_sha) = bzr_revid.split(":", 1)
191
mapping = self.get(mapping_version)
192
return mapping.revision_id_bzr_to_foreign(bzr_revid)
194
parse_revision_id = revision_id_bzr_to_foreign
197
mapping_registry = GitMappingRegistry()
198
mapping_registry.register_lazy('git-v1', "bzrlib.plugins.git.mapping",
200
mapping_registry.register_lazy('git-experimental', "bzrlib.plugins.git.mapping",
201
"BzrGitMappingExperimental")
204
class ForeignGit(ForeignVcs):
205
"""The Git Stupid Content Tracker"""
208
super(ForeignGit, self).__init__(mapping_registry)
211
def show_foreign_revid(cls, foreign_revid):
212
return { "git commit": foreign_revid }
215
foreign_git = ForeignGit()
216
default_mapping = BzrGitMappingv1()
219
def text_to_blob(texts, entry):
220
from dulwich.objects import Blob
221
text = texts.get_record_stream([(entry.file_id, entry.revision)], 'unordered', True).next().get_bytes_as('fulltext')
227
def symlink_to_blob(entry):
228
from dulwich.objects import Blob
230
blob._text = entry.symlink_target
234
def mode_is_executable(mode):
235
"""Check if mode should be considered executable."""
236
return bool(mode & 0111)
240
"""Determine the Bazaar inventory kind based on Unix file mode."""
241
entry_kind = (mode & 0700000) / 0100000
244
elif entry_kind == 1:
245
file_kind = (mode & 070000) / 010000
251
return 'tree-reference'
253
raise AssertionError(
254
"Unknown file kind %d, perms=%o." % (file_kind, mode,))
256
raise AssertionError(
257
"Unknown kind, perms=%r." % (mode,))
260
def entry_mode(entry):
261
"""Determine the git file mode for an inventory entry."""
262
if entry.kind == 'directory':
264
elif entry.kind == 'symlink':
266
elif entry.kind == 'file':
267
mode = stat.S_IFREG | 0644
275
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
276
from dulwich.objects import Tree
278
for name in sorted(entry.children.keys()):
279
ie = entry.children[name]
281
mode = unusual_modes[ie.file_id]
283
mode = entry_mode(ie)
284
tree.add(mode, name.encode("utf-8"), lookup_ie_sha1(ie))
289
def extract_unusual_modes(rev):
291
foreign_revid, mapping = mapping_registry.parse_revision_id(rev.revision_id)
292
except errors.InvalidRevisionId:
295
return mapping.export_unusual_file_modes(rev)
298
def inventory_to_tree_and_blobs(inventory, texts, mapping, unusual_modes, cur=None):
299
"""Convert a Bazaar tree to a Git tree.
301
:return: Yields tuples with object sha1, object and path
303
from dulwich.objects import Tree
310
# stack contains the set of trees that we haven't
311
# finished constructing
312
for path, entry in inventory.iter_entries():
313
while stack and not path.startswith(osutils.pathjoin(cur, "")):
314
# We've hit a file that's not a child of the previous path
317
yield sha, tree, cur.encode("utf-8")
318
mode = unusual_modes.get(cur.encode("utf-8"), stat.S_IFDIR)
319
t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
320
cur, tree = stack.pop()
323
if entry.kind == "directory":
324
stack.append((cur, tree))
328
if entry.kind == "file":
329
blob = text_to_blob(texts, entry)
330
elif entry.kind == "symlink":
331
blob = symlink_to_blob(entry)
333
raise AssertionError("Unknown kind %s" % entry.kind)
335
yield sha, blob, path.encode("utf-8")
336
name = urlutils.basename(path).encode("utf-8")
337
mode = unusual_modes.get(path.encode("utf-8"), entry_mode(entry))
338
tree.add(mode, name, sha)
340
while len(stack) > 1:
343
yield sha, tree, cur.encode("utf-8")
344
mode = unusual_modes.get(cur.encode('utf-8'), stat.S_IFDIR)
345
t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
346
cur, tree = stack.pop()
350
yield tree.id, tree, cur.encode("utf-8")
353
def revision_to_commit(rev, tree_sha, parent_lookup):
354
"""Turn a Bazaar revision in to a Git commit
356
:param tree_sha: Tree sha for the commit
357
:param parent_lookup: Function for looking up the GIT sha equiv of a bzr revision
358
:return dulwich.objects.Commit represent the revision:
360
from dulwich.objects import Commit
362
commit.tree = tree_sha
363
for p in rev.parent_ids:
364
git_p = parent_lookup(p)
365
if git_p is not None:
366
assert len(git_p) == 40, "unexpected length for %r" % git_p
367
commit.parents.append(git_p)
368
commit.message = rev.message.encode("utf-8")
369
commit.committer = fix_person_identifier(rev.committer.encode("utf-8"))
370
commit.author = fix_person_identifier(rev.get_apparent_authors()[0].encode("utf-8"))
371
commit.commit_time = long(rev.timestamp)
372
if 'author-timestamp' in rev.properties:
373
commit.author_time = long(rev.properties['author-timestamp'])
375
commit.author_time = commit.commit_time
376
commit.commit_timezone = rev.timezone
377
if 'author-timezone' in rev.properties:
378
commit.author_timezone = int(rev.properties['author-timezone'])
380
commit.author_timezone = commit.commit_timezone