/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

Run bzrlib foreign tests.

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)[1]
 
181
        rev.properties['git-svn-id'] = git_svn_id
 
182
        (url, rev, uuid) = parse_git_svn_id(git_svn_id)
 
183
        # FIXME: Convert this to converted-from property somehow..
 
184
        return "\n".join(lines[:-2])
 
185
 
 
186
    def _extract_hg_metadata(self, rev, message):
 
187
        (message, renames, branch, extra) = extract_hg_metadata(message)
 
188
        if branch is not None:
 
189
            rev.properties['hg:extra:branch'] = branch
 
190
        for name, value in extra.iteritems():
 
191
            rev.properties['hg:extra:' + name] = base64.b64encode(value)
 
192
        if renames:
 
193
            rev.properties['hg:renames'] = base64.b64encode(bencode.bencode([(new, old) for (old, new) in renames.iteritems()]))
 
194
        return message
 
195
 
 
196
    def _decode_commit_message(self, rev, message):
 
197
        return message.decode("utf-8", "replace")
 
198
 
 
199
    def _encode_commit_message(self, rev, message):
 
200
        return message.encode("utf-8")
 
201
 
 
202
    def export_commit(self, rev, tree_sha, parent_lookup):
 
203
        """Turn a Bazaar revision in to a Git commit
 
204
 
 
205
        :param tree_sha: Tree sha for the commit
 
206
        :param parent_lookup: Function for looking up the GIT sha equiv of a bzr revision
 
207
        :return dulwich.objects.Commit represent the revision:
 
208
        """
 
209
        from dulwich.objects import Commit
 
210
        commit = Commit()
 
211
        commit.tree = tree_sha
 
212
        for p in rev.parent_ids:
 
213
            git_p = parent_lookup(p)
 
214
            if git_p is not None:
 
215
                assert len(git_p) == 40, "unexpected length for %r" % git_p
 
216
                commit.parents.append(git_p)
 
217
        commit.committer = fix_person_identifier(rev.committer.encode("utf-8"))
 
218
        commit.author = fix_person_identifier(rev.get_apparent_authors()[0].encode("utf-8"))
 
219
        commit.commit_time = long(rev.timestamp)
 
220
        if 'author-timestamp' in rev.properties:
 
221
            commit.author_time = long(rev.properties['author-timestamp'])
 
222
        else:
 
223
            commit.author_time = commit.commit_time
 
224
        commit.commit_timezone = rev.timezone
 
225
        if 'author-timezone' in rev.properties:
 
226
            commit.author_timezone = int(rev.properties['author-timezone'])
 
227
        else:
 
228
            commit.author_timezone = commit.commit_timezone 
 
229
        commit.message = self._encode_commit_message(rev, rev.message)
 
230
        return commit
61
231
 
62
232
    def import_commit(self, commit):
63
233
        """Convert a git commit to a bzr revision.
68
238
            raise AssertionError("Commit object can't be None")
69
239
        rev = ForeignRevision(commit.id, self, self.revision_id_foreign_to_bzr(commit.id))
70
240
        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
241
        rev.committer = str(commit.committer).decode("utf-8", "replace")
73
242
        if commit.committer != commit.author:
74
243
            rev.properties['author'] = str(commit.author).decode("utf-8", "replace")
 
244
 
 
245
        if commit.commit_time != commit.author_time:
 
246
            rev.properties['author-timestamp'] = str(commit.author_time)
 
247
        if commit.commit_timezone != commit.author_timezone:
 
248
            rev.properties['author-timezone'] = "%d" % (commit.author_timezone, )
75
249
        rev.timestamp = commit.commit_time
76
 
        rev.timezone = 0
 
250
        rev.timezone = commit.commit_timezone
 
251
        rev.message = self._decode_commit_message(rev, commit.message)
77
252
        return rev
78
253
 
79
254
 
81
256
    revid_prefix = 'git-v1'
82
257
    experimental = False
83
258
 
 
259
    def __str__(self):
 
260
        return self.revid_prefix
 
261
 
84
262
 
85
263
class BzrGitMappingExperimental(BzrGitMappingv1):
86
264
    revid_prefix = 'git-experimental'
87
265
    experimental = True
88
266
 
 
267
    def _decode_commit_message(self, rev, message):
 
268
        message = self._extract_hg_metadata(rev, message)
 
269
        message = self._extract_git_svn_metadata(rev, message)
 
270
        return message.decode("utf-8", "replace")
 
271
 
 
272
    def _encode_commit_message(self, rev, message):
 
273
        ret = message.encode("utf-8")
 
274
        ret += self._generate_hg_message_tail(rev)
 
275
        ret += self._generate_git_svn_metadata(rev)
 
276
        return ret
 
277
 
 
278
    def import_commit(self, commit):
 
279
        rev = super(BzrGitMappingExperimental, self).import_commit(commit)
 
280
        rev.properties['converted_revision'] = "git %s\n" % commit.id
 
281
        return rev
 
282
 
89
283
 
90
284
class GitMappingRegistry(VcsMappingRegistry):
 
285
    """Registry with available git mappings."""
91
286
 
92
287
    def revision_id_bzr_to_foreign(self, bzr_revid):
93
288
        if not bzr_revid.startswith("git-"):
104
299
                                   "BzrGitMappingv1")
105
300
mapping_registry.register_lazy('git-experimental', "bzrlib.plugins.git.mapping",
106
301
                                   "BzrGitMappingExperimental")
 
302
mapping_registry.set_default('git-v1')
107
303
 
108
304
 
109
305
class ForeignGit(ForeignVcs):
110
 
    """Foreign Git."""
 
306
    """The Git Stupid Content Tracker"""
 
307
 
 
308
    @property
 
309
    def branch_format(self):
 
310
        from bzrlib.plugins.git.branch import GitBranchFormat
 
311
        return GitBranchFormat()
111
312
 
112
313
    def __init__(self):
113
314
        super(ForeignGit, self).__init__(mapping_registry)
 
315
        self.abbreviation = "git"
 
316
 
 
317
    @classmethod
 
318
    def serialize_foreign_revid(self, foreign_revid):
 
319
        return foreign_revid
114
320
 
115
321
    @classmethod
116
322
    def show_foreign_revid(cls, foreign_revid):
118
324
 
119
325
 
120
326
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
 
327
default_mapping = mapping_registry.get_default()()
 
328
 
 
329
 
 
330
def text_to_blob(texts, entry):
 
331
    from dulwich.objects import Blob
 
332
    text = texts.get_record_stream([(entry.file_id, entry.revision)], 'unordered', True).next().get_bytes_as('fulltext')
 
333
    blob = Blob()
 
334
    blob._text = text
 
335
    return blob
 
336
 
 
337
 
 
338
def symlink_to_blob(entry):
 
339
    from dulwich.objects import Blob
 
340
    blob = Blob()
 
341
    blob._text = entry.symlink_target
 
342
    return blob
 
343
 
 
344
 
 
345
def mode_is_executable(mode):
 
346
    """Check if mode should be considered executable."""
 
347
    return bool(mode & 0111)
 
348
 
 
349
 
 
350
def mode_kind(mode):
 
351
    """Determine the Bazaar inventory kind based on Unix file mode."""
 
352
    entry_kind = (mode & 0700000) / 0100000
 
353
    if entry_kind == 0:
 
354
        return 'directory'
 
355
    elif entry_kind == 1:
 
356
        file_kind = (mode & 070000) / 010000
 
357
        if file_kind == 0:
 
358
            return 'file'
 
359
        elif file_kind == 2:
 
360
            return 'symlink'
 
361
        elif file_kind == 6:
 
362
            return 'tree-reference'
 
363
        else:
 
364
            raise AssertionError(
 
365
                "Unknown file kind %d, perms=%o." % (file_kind, mode,))
 
366
    else:
 
367
        raise AssertionError(
 
368
            "Unknown kind, perms=%r." % (mode,))
 
369
 
 
370
 
 
371
def object_mode(kind, executable):
 
372
    if kind == 'directory':
 
373
        return stat.S_IFDIR
 
374
    elif kind == 'symlink':
 
375
        return stat.S_IFLNK
 
376
    elif kind == 'file':
 
377
        mode = stat.S_IFREG | 0644
 
378
        if executable:
 
379
            mode |= 0111
 
380
        return mode
 
381
    else:
 
382
        raise AssertionError
 
383
 
 
384
 
 
385
def entry_mode(entry):
 
386
    """Determine the git file mode for an inventory entry."""
 
387
    return object_mode(entry.kind, entry.executable)
 
388
 
 
389
 
 
390
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
 
391
    from dulwich.objects import Tree
 
392
    tree = Tree()
 
393
    for name in sorted(entry.children.keys()):
 
394
        ie = entry.children[name]
 
395
        try:
 
396
            mode = unusual_modes[ie.file_id]
 
397
        except KeyError:
 
398
            mode = entry_mode(ie)
 
399
        hexsha = lookup_ie_sha1(ie)
 
400
        if hexsha is not None:
 
401
            tree.add(mode, name.encode("utf-8"), hexsha)
 
402
    if entry.parent_id is not None and len(tree) == 0:
 
403
        # Only the root can be an empty tree
 
404
        return None
 
405
    tree.serialize()
 
406
    return tree
 
407
 
 
408
 
 
409
def extract_unusual_modes(rev):
 
410
    try:
 
411
        foreign_revid, mapping = mapping_registry.parse_revision_id(rev.revision_id)
 
412
    except errors.InvalidRevisionId:
 
413
        return {}
 
414
    else:
 
415
        return mapping.export_unusual_file_modes(rev)
 
416
 
 
417
 
 
418
def inventory_to_tree_and_blobs(inventory, texts, mapping, unusual_modes, cur=None):
 
419
    """Convert a Bazaar tree to a Git tree.
 
420
 
 
421
    :return: Yields tuples with object sha1, object and path
 
422
    """
 
423
    from dulwich.objects import Tree
127
424
    import stat
128
425
    stack = []
129
 
    cur = ""
 
426
    if cur is None:
 
427
        cur = ""
130
428
    tree = Tree()
131
429
 
132
 
    inv = repo.get_inventory(revision_id)
133
 
 
134
430
    # stack contains the set of trees that we haven't 
135
431
    # finished constructing
136
 
 
137
 
    for path, entry in inv.iter_entries():
138
 
        while stack and not path.startswith(cur):
 
432
    for path, entry in inventory.iter_entries():
 
433
        while stack and not path.startswith(osutils.pathjoin(cur, "")):
 
434
            # We've hit a file that's not a child of the previous path
139
435
            tree.serialize()
140
 
            sha = tree.sha().hexdigest()
141
 
            yield sha, tree, cur
142
 
            t = (stat.S_IFDIR, urlutils.basename(cur).encode('UTF-8'), sha)
 
436
            sha = tree.id
 
437
            yield sha, tree, cur.encode("utf-8")
 
438
            mode = unusual_modes.get(cur.encode("utf-8"), stat.S_IFDIR)
 
439
            t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
143
440
            cur, tree = stack.pop()
144
441
            tree.add(*t)
145
442
 
146
 
        if type(entry) == InventoryDirectory:
 
443
        if entry.kind == "directory":
147
444
            stack.append((cur, tree))
148
445
            cur = path
149
446
            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
 
 
 
447
        else:
 
448
            if entry.kind == "file":
 
449
                blob = text_to_blob(texts, entry)
 
450
            elif entry.kind == "symlink":
 
451
                blob = symlink_to_blob(entry)
 
452
            else:
 
453
                raise AssertionError("Unknown kind %s" % entry.kind)
 
454
            sha = blob.id
 
455
            yield sha, blob, path.encode("utf-8")
159
456
            name = urlutils.basename(path).encode("utf-8")
160
 
            mode = stat.S_IFREG | 0644
161
 
            if entry.executable:
162
 
                mode |= 0111
 
457
            mode = unusual_modes.get(path.encode("utf-8"), entry_mode(entry))
163
458
            tree.add(mode, name, sha)
164
459
 
165
460
    while len(stack) > 1:
166
461
        tree.serialize()
167
 
        sha = tree.sha().hexdigest()
168
 
        yield sha, tree, cur
169
 
        t = (stat.S_IFDIR, urlutils.basename(cur).encode('UTF-8'), sha)
 
462
        sha = tree.id
 
463
        yield sha, tree, cur.encode("utf-8")
 
464
        mode = unusual_modes.get(cur.encode('utf-8'), stat.S_IFDIR)
 
465
        t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
170
466
        cur, tree = stack.pop()
171
467
        tree.add(*t)
172
468
 
173
469
    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
 
470
    yield tree.id, tree, cur.encode("utf-8")
 
471
 
 
472
 
 
473
def parse_git_svn_id(text):
 
474
    (head, uuid) = text.rsplit(" ", 1)
 
475
    (full_url, rev) = head.rsplit("@", 1)
 
476
    return (full_url, int(rev), uuid)