/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to mapping.py

Support DWIM git: revspecs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mapping.py
1
 
# Copyright (C) 2007-2008 Canonical Ltd
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
# Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
 
3
# Copyright (C) 2008 John Carr
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
16
18
 
17
19
"""Converters, etc for going between Bazaar and Git ids."""
18
20
 
19
 
from bzrlib import errors, foreign, urlutils
20
 
from bzrlib.inventory import ROOT_ID
 
21
import base64
 
22
import stat
 
23
 
 
24
from bzrlib import (
 
25
    errors,
 
26
    foreign,
 
27
    osutils,
 
28
    trace,
 
29
    urlutils,
 
30
    )
 
31
try:
 
32
    from bzrlib import bencode
 
33
except ImportError:
 
34
    from bzrlib.util import bencode
 
35
from bzrlib.inventory import (
 
36
    ROOT_ID,
 
37
    )
21
38
from bzrlib.foreign import (
22
 
        ForeignVcs, 
23
 
        VcsMappingRegistry, 
24
 
        ForeignRevision,
25
 
        )
 
39
    ForeignVcs, 
 
40
    VcsMappingRegistry, 
 
41
    ForeignRevision,
 
42
    )
 
43
from bzrlib.plugins.git.hg import (
 
44
    format_hg_metadata,
 
45
    extract_hg_metadata,
 
46
    )
 
47
 
 
48
DEFAULT_FILE_MODE = stat.S_IFREG | 0644
 
49
 
26
50
 
27
51
def escape_file_id(file_id):
28
52
    return file_id.replace('_', '__').replace(' ', '_s')
29
53
 
30
54
 
31
55
def unescape_file_id(file_id):
32
 
    return file_id.replace("_s", " ").replace("__", "_")
 
56
    ret = []
 
57
    i = 0
 
58
    while i < len(file_id):
 
59
        if file_id[i] != '_':
 
60
            ret.append(file_id[i])
 
61
        else:
 
62
            if file_id[i+1] == '_':
 
63
                ret.append("_")
 
64
            elif file_id[i+1] == 's':
 
65
                ret.append(" ")
 
66
            else:
 
67
                raise AssertionError("unknown escape character %s" % file_id[i+1])
 
68
            i += 1
 
69
        i += 1
 
70
    return "".join(ret)
 
71
 
 
72
 
 
73
def fix_person_identifier(text):
 
74
    if "<" in text and ">" in text:
 
75
        return text
 
76
    return "%s <%s>" % (text, text)
 
77
 
 
78
 
 
79
def warn_escaped(commit, num_escaped):
 
80
    trace.warning("Escaped %d XML-invalid characters in %s. Will be unable "
 
81
                  "to regenerate the SHA map.", num_escaped, commit)
 
82
 
 
83
 
 
84
def warn_unusual_mode(commit, path, mode):
 
85
    trace.mutter("Unusual file mode %o for %s in %s. Storing as revision property. ",
 
86
                 mode, path, commit)
 
87
 
 
88
 
 
89
def squash_revision(target_repo, rev):
 
90
    """Remove characters that can't be stored from a revision, if necessary.
 
91
    
 
92
    :param target_repo: Repository in which the revision will be stored
 
93
    :param rev: Revision object, will be modified in-place
 
94
    """
 
95
    if not getattr(target_repo._serializer, "squashes_xml_invalid_characters", True):
 
96
        return
 
97
    from bzrlib.xml_serializer import escape_invalid_chars
 
98
    rev.message, num_escaped = escape_invalid_chars(rev.message)
 
99
    if num_escaped:
 
100
        warn_escaped(rev.foreign_revid, num_escaped)
 
101
    if 'author' in rev.properties:
 
102
        rev.properties['author'], num_escaped = escape_invalid_chars(
 
103
            rev.properties['author'])
 
104
        if num_escaped:
 
105
            warn_escaped(rev.foreign_revid, num_escaped)
 
106
    rev.committer, num_escaped = escape_invalid_chars(rev.committer)
 
107
    if num_escaped:
 
108
        warn_escaped(rev.foreign_revid, num_escaped)
33
109
 
34
110
 
35
111
class BzrGitMapping(foreign.VcsMapping):
55
131
        return bzr_rev_id[len(cls.revid_prefix)+1:], cls()
56
132
 
57
133
    def generate_file_id(self, path):
 
134
        # Git paths are just bytestrings
 
135
        # We must just hope they are valid UTF-8..
58
136
        if path == "":
59
137
            return ROOT_ID
60
 
        return escape_file_id(path.encode('utf-8'))
 
138
        return escape_file_id(path)
 
139
 
 
140
    def parse_file_id(self, file_id):
 
141
        if file_id == ROOT_ID:
 
142
            return ""
 
143
        return unescape_file_id(file_id)
 
144
 
 
145
    def import_unusual_file_modes(self, rev, unusual_file_modes):
 
146
        if unusual_file_modes:
 
147
            ret = [(name, unusual_file_modes[name]) for name in sorted(unusual_file_modes.keys())]
 
148
            rev.properties['file-modes'] = bencode.bencode(ret)
 
149
 
 
150
    def export_unusual_file_modes(self, rev):
 
151
        try:
 
152
            return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(rev.properties['file-modes'])])
 
153
        except KeyError:
 
154
            return {}
 
155
 
 
156
    def _generate_git_svn_metadata(self, rev):
 
157
        try:
 
158
            return "\ngit-svn-id: %s\n" % rev.properties["git-svn-id"]
 
159
        except KeyError:
 
160
            return ""
 
161
 
 
162
    def _generate_hg_message_tail(self, rev):
 
163
        extra = {}
 
164
        renames = []
 
165
        branch = 'default'
 
166
        for name in rev.properties:
 
167
            if name == 'hg:extra:branch':
 
168
                branch = rev.properties['hg:extra:branch']
 
169
            elif name.startswith('hg:extra'):
 
170
                extra[name[len('hg:extra:'):]] = base64.b64decode(rev.properties[name])
 
171
            elif name == 'hg:renames':
 
172
                renames = bencode.bdecode(base64.b64decode(rev.properties['hg:renames']))
 
173
            # TODO: Export other properties as 'bzr:' extras?
 
174
        return format_hg_metadata(renames, branch, extra)
 
175
 
 
176
    def _extract_git_svn_metadata(self, rev, message):
 
177
        lines = message.split("\n")
 
178
        if not (lines[-1] == "" and lines[-2].startswith("git-svn-id ")):
 
179
            return message
 
180
        git_svn_id = lines[-2].split(": ", 1)
 
181
        rev.properties['git-svn-id'] = git_svn_id
 
182
        (head, uuid) = git_svn_id.rsplit(" ", 1)
 
183
        (full_url, rev) = head.rsplit("@", 1)
 
184
        # FIXME: Convert this to converted-from property somehow..
 
185
        return "\n".join(lines[:-2])
 
186
 
 
187
    def _extract_hg_metadata(self, rev, message):
 
188
        (message, renames, branch, extra) = extract_hg_metadata(message)
 
189
        if branch is not None:
 
190
            rev.properties['hg:extra:branch'] = branch
 
191
        for name, value in extra.iteritems():
 
192
            rev.properties['hg:extra:' + name] = base64.b64encode(value)
 
193
        if renames:
 
194
            rev.properties['hg:renames'] = base64.b64encode(bencode.bencode([(new, old) for (old, new) in renames.iteritems()]))
 
195
        return message
 
196
 
 
197
    def _decode_commit_message(self, rev, message):
 
198
        return message.decode("utf-8", "replace")
 
199
 
 
200
    def _encode_commit_message(self, rev, message):
 
201
        return message.encode("utf-8")
 
202
 
 
203
    def export_commit(self, rev, tree_sha, parent_lookup):
 
204
        """Turn a Bazaar revision in to a Git commit
 
205
 
 
206
        :param tree_sha: Tree sha for the commit
 
207
        :param parent_lookup: Function for looking up the GIT sha equiv of a bzr revision
 
208
        :return dulwich.objects.Commit represent the revision:
 
209
        """
 
210
        from dulwich.objects import Commit
 
211
        commit = Commit()
 
212
        commit.tree = tree_sha
 
213
        for p in rev.parent_ids:
 
214
            git_p = parent_lookup(p)
 
215
            if git_p is not None:
 
216
                assert len(git_p) == 40, "unexpected length for %r" % git_p
 
217
                commit.parents.append(git_p)
 
218
        commit.committer = fix_person_identifier(rev.committer.encode("utf-8"))
 
219
        commit.author = fix_person_identifier(rev.get_apparent_authors()[0].encode("utf-8"))
 
220
        commit.commit_time = long(rev.timestamp)
 
221
        if 'author-timestamp' in rev.properties:
 
222
            commit.author_time = long(rev.properties['author-timestamp'])
 
223
        else:
 
224
            commit.author_time = commit.commit_time
 
225
        commit.commit_timezone = rev.timezone
 
226
        if 'author-timezone' in rev.properties:
 
227
            commit.author_timezone = int(rev.properties['author-timezone'])
 
228
        else:
 
229
            commit.author_timezone = commit.commit_timezone 
 
230
        commit.message = self._encode_commit_message(rev, rev.message)
 
231
        return commit
61
232
 
62
233
    def import_commit(self, commit):
63
234
        """Convert a git commit to a bzr revision.
68
239
            raise AssertionError("Commit object can't be None")
69
240
        rev = ForeignRevision(commit.id, self, self.revision_id_foreign_to_bzr(commit.id))
70
241
        rev.parent_ids = tuple([self.revision_id_foreign_to_bzr(p) for p in commit.parents])
71
 
        rev.message = commit.message.decode("utf-8", "replace")
72
242
        rev.committer = str(commit.committer).decode("utf-8", "replace")
73
243
        if commit.committer != commit.author:
74
244
            rev.properties['author'] = str(commit.author).decode("utf-8", "replace")
 
245
 
 
246
        if commit.commit_time != commit.author_time:
 
247
            rev.properties['author-timestamp'] = str(commit.author_time)
 
248
        if commit.commit_timezone != commit.author_timezone:
 
249
            rev.properties['author-timezone'] = "%d" % (commit.author_timezone, )
75
250
        rev.timestamp = commit.commit_time
76
 
        rev.timezone = 0
 
251
        rev.timezone = commit.commit_timezone
 
252
        rev.message = self._decode_commit_message(rev, commit.message)
77
253
        return rev
78
254
 
79
255
 
81
257
    revid_prefix = 'git-v1'
82
258
    experimental = False
83
259
 
 
260
    def __str__(self):
 
261
        return self.revid_prefix
 
262
 
84
263
 
85
264
class BzrGitMappingExperimental(BzrGitMappingv1):
86
265
    revid_prefix = 'git-experimental'
87
266
    experimental = True
88
267
 
 
268
    def _decode_commit_message(self, rev, message):
 
269
        message = self._extract_hg_metadata(rev, message)
 
270
        message = self._extract_git_svn_metadata(rev, message)
 
271
        return message.decode("utf-8", "replace")
 
272
 
 
273
    def _encode_commit_message(self, rev, message):
 
274
        ret = message.encode("utf-8")
 
275
        ret += self._generate_hg_message_tail(rev)
 
276
        ret += self._generate_git_svn_metadata(rev)
 
277
        return ret
 
278
 
 
279
    def import_commit(self, commit):
 
280
        rev = super(BzrGitMappingExperimental, self).import_commit(commit)
 
281
        rev.properties['converted_revision'] = "git %s\n" % commit.id
 
282
        return rev
 
283
 
89
284
 
90
285
class GitMappingRegistry(VcsMappingRegistry):
 
286
    """Registry with available git mappings."""
91
287
 
92
288
    def revision_id_bzr_to_foreign(self, bzr_revid):
93
289
        if not bzr_revid.startswith("git-"):
104
300
                                   "BzrGitMappingv1")
105
301
mapping_registry.register_lazy('git-experimental', "bzrlib.plugins.git.mapping",
106
302
                                   "BzrGitMappingExperimental")
 
303
mapping_registry.set_default('git-v1')
107
304
 
108
305
 
109
306
class ForeignGit(ForeignVcs):
110
 
    """Foreign Git."""
 
307
    """The Git Stupid Content Tracker"""
 
308
 
 
309
    @property
 
310
    def branch_format(self):
 
311
        from bzrlib.plugins.git.branch import GitBranchFormat
 
312
        return GitBranchFormat()
111
313
 
112
314
    def __init__(self):
113
315
        super(ForeignGit, self).__init__(mapping_registry)
118
320
 
119
321
 
120
322
foreign_git = ForeignGit()
121
 
default_mapping = BzrGitMappingv1()
122
 
 
123
 
 
124
 
def inventory_to_tree_and_blobs(repo, mapping, revision_id):
125
 
    from dulwich.objects import Tree, Blob
126
 
    from bzrlib.inventory import InventoryDirectory, InventoryFile
 
323
default_mapping = mapping_registry.get_default()()
 
324
 
 
325
 
 
326
def text_to_blob(texts, entry):
 
327
    from dulwich.objects import Blob
 
328
    text = texts.get_record_stream([(entry.file_id, entry.revision)], 'unordered', True).next().get_bytes_as('fulltext')
 
329
    blob = Blob()
 
330
    blob._text = text
 
331
    return blob
 
332
 
 
333
 
 
334
def symlink_to_blob(entry):
 
335
    from dulwich.objects import Blob
 
336
    blob = Blob()
 
337
    blob._text = entry.symlink_target
 
338
    return blob
 
339
 
 
340
 
 
341
def mode_is_executable(mode):
 
342
    """Check if mode should be considered executable."""
 
343
    return bool(mode & 0111)
 
344
 
 
345
 
 
346
def mode_kind(mode):
 
347
    """Determine the Bazaar inventory kind based on Unix file mode."""
 
348
    entry_kind = (mode & 0700000) / 0100000
 
349
    if entry_kind == 0:
 
350
        return 'directory'
 
351
    elif entry_kind == 1:
 
352
        file_kind = (mode & 070000) / 010000
 
353
        if file_kind == 0:
 
354
            return 'file'
 
355
        elif file_kind == 2:
 
356
            return 'symlink'
 
357
        elif file_kind == 6:
 
358
            return 'tree-reference'
 
359
        else:
 
360
            raise AssertionError(
 
361
                "Unknown file kind %d, perms=%o." % (file_kind, mode,))
 
362
    else:
 
363
        raise AssertionError(
 
364
            "Unknown kind, perms=%r." % (mode,))
 
365
 
 
366
 
 
367
def object_mode(kind, executable):
 
368
    if kind == 'directory':
 
369
        return stat.S_IFDIR
 
370
    elif kind == 'symlink':
 
371
        return stat.S_IFLNK
 
372
    elif kind == 'file':
 
373
        mode = stat.S_IFREG | 0644
 
374
        if executable:
 
375
            mode |= 0111
 
376
        return mode
 
377
    else:
 
378
        raise AssertionError
 
379
 
 
380
 
 
381
def entry_mode(entry):
 
382
    """Determine the git file mode for an inventory entry."""
 
383
    return object_mode(entry.kind, entry.executable)
 
384
 
 
385
 
 
386
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
 
387
    from dulwich.objects import Tree
 
388
    tree = Tree()
 
389
    for name in sorted(entry.children.keys()):
 
390
        ie = entry.children[name]
 
391
        try:
 
392
            mode = unusual_modes[ie.file_id]
 
393
        except KeyError:
 
394
            mode = entry_mode(ie)
 
395
        hexsha = lookup_ie_sha1(ie)
 
396
        if hexsha is not None:
 
397
            tree.add(mode, name.encode("utf-8"), hexsha)
 
398
    if entry.parent_id is not None and len(tree) == 0:
 
399
        # Only the root can be an empty tree
 
400
        return None
 
401
    tree.serialize()
 
402
    return tree
 
403
 
 
404
 
 
405
def extract_unusual_modes(rev):
 
406
    try:
 
407
        foreign_revid, mapping = mapping_registry.parse_revision_id(rev.revision_id)
 
408
    except errors.InvalidRevisionId:
 
409
        return {}
 
410
    else:
 
411
        return mapping.export_unusual_file_modes(rev)
 
412
 
 
413
 
 
414
def inventory_to_tree_and_blobs(inventory, texts, mapping, unusual_modes, cur=None):
 
415
    """Convert a Bazaar tree to a Git tree.
 
416
 
 
417
    :return: Yields tuples with object sha1, object and path
 
418
    """
 
419
    from dulwich.objects import Tree
127
420
    import stat
128
421
    stack = []
129
 
    cur = ""
 
422
    if cur is None:
 
423
        cur = ""
130
424
    tree = Tree()
131
425
 
132
 
    inv = repo.get_inventory(revision_id)
133
 
 
134
426
    # stack contains the set of trees that we haven't 
135
427
    # finished constructing
136
 
 
137
 
    for path, entry in inv.iter_entries():
138
 
        while stack and not path.startswith(cur):
 
428
    for path, entry in inventory.iter_entries():
 
429
        while stack and not path.startswith(osutils.pathjoin(cur, "")):
 
430
            # We've hit a file that's not a child of the previous path
139
431
            tree.serialize()
140
 
            sha = tree.sha().hexdigest()
141
 
            yield sha, tree, cur
142
 
            t = (stat.S_IFDIR, urlutils.basename(cur).encode('UTF-8'), sha)
 
432
            sha = tree.id
 
433
            yield sha, tree, cur.encode("utf-8")
 
434
            mode = unusual_modes.get(cur.encode("utf-8"), stat.S_IFDIR)
 
435
            t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
143
436
            cur, tree = stack.pop()
144
437
            tree.add(*t)
145
438
 
146
 
        if type(entry) == InventoryDirectory:
 
439
        if entry.kind == "directory":
147
440
            stack.append((cur, tree))
148
441
            cur = path
149
442
            tree = Tree()
150
 
 
151
 
        if type(entry) == InventoryFile:
152
 
            #FIXME: We can make potentially make this Lazy to avoid shaing lots of stuff
153
 
            # and having all these objects in memory at once
154
 
            blob = Blob()
155
 
            _, blob._text = repo.iter_files_bytes([(entry.file_id, entry.revision, path)]).next()
156
 
            sha = blob.sha().hexdigest()
157
 
            yield sha, blob, path
158
 
 
 
443
        else:
 
444
            if entry.kind == "file":
 
445
                blob = text_to_blob(texts, entry)
 
446
            elif entry.kind == "symlink":
 
447
                blob = symlink_to_blob(entry)
 
448
            else:
 
449
                raise AssertionError("Unknown kind %s" % entry.kind)
 
450
            sha = blob.id
 
451
            yield sha, blob, path.encode("utf-8")
159
452
            name = urlutils.basename(path).encode("utf-8")
160
 
            mode = stat.S_IFREG | 0644
161
 
            if entry.executable:
162
 
                mode |= 0111
 
453
            mode = unusual_modes.get(path.encode("utf-8"), entry_mode(entry))
163
454
            tree.add(mode, name, sha)
164
455
 
165
456
    while len(stack) > 1:
166
457
        tree.serialize()
167
 
        sha = tree.sha().hexdigest()
168
 
        yield sha, tree, cur
169
 
        t = (stat.S_IFDIR, urlutils.basename(cur).encode('UTF-8'), sha)
 
458
        sha = tree.id
 
459
        yield sha, tree, cur.encode("utf-8")
 
460
        mode = unusual_modes.get(cur.encode('utf-8'), stat.S_IFDIR)
 
461
        t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
170
462
        cur, tree = stack.pop()
171
463
        tree.add(*t)
172
464
 
173
465
    tree.serialize()
174
 
    yield tree.sha().hexdigest(), tree, cur
175
 
 
176
 
 
177
 
def revision_to_commit(rev, tree_sha, parent_lookup):
178
 
    """Turn a Bazaar revision in to a Git commit
179
 
 
180
 
    :param tree_sha: Tree sha for the commit
181
 
    :param parent_lookup: Function for looking up the GIT sha equiv of a bzr revision
182
 
    :return dulwich.objects.Commit represent the revision:
183
 
    """
184
 
    from dulwich.objects import Commit
185
 
    commit = Commit()
186
 
    commit._tree = tree_sha
187
 
    for p in rev.parent_ids:
188
 
        git_p = parent_lookup(p)
189
 
        if git_p is not None:
190
 
            commit._parents.append(git_p)
191
 
    commit._message = rev.message.encode("utf-8")
192
 
    commit._committer = rev.committer.encode("utf-8")
193
 
    commit._author = rev.get_apparent_author().encode("utf-8")
194
 
    commit._commit_time = long(rev.timestamp)
195
 
    commit.serialize()
196
 
    return commit
 
466
    yield tree.id, tree, cur.encode("utf-8")
 
467