/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

More work on roundtrip push support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mapping.py
1
1
# Copyright (C) 2007 Canonical Ltd
2
 
# Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
 
2
# Copyright (C) 2008-2010 Jelmer Vernooij <jelmer@samba.org>
3
3
# Copyright (C) 2008 John Carr
4
4
#
5
5
# This program is free software; you can redistribute it and/or modify
22
22
import stat
23
23
 
24
24
from bzrlib import (
 
25
    bencode,
25
26
    errors,
26
27
    foreign,
27
 
    osutils,
28
28
    trace,
29
 
    urlutils,
30
29
    )
31
 
try:
32
 
    from bzrlib import bencode
33
 
except ImportError:
34
 
    from bzrlib.util import bencode
35
30
from bzrlib.inventory import (
36
31
    ROOT_ID,
37
32
    )
47
42
    format_hg_metadata,
48
43
    extract_hg_metadata,
49
44
    )
 
45
from bzrlib.plugins.git.roundtrip import (
 
46
    extract_bzr_metadata,
 
47
    inject_bzr_metadata,
 
48
    BzrGitRevisionMetadata,
 
49
    deserialize_fileid_map,
 
50
    serialize_fileid_map,
 
51
    )
50
52
 
51
53
DEFAULT_FILE_MODE = stat.S_IFREG | 0644
52
54
 
90
92
                 "property. ", mode, path, commit)
91
93
 
92
94
 
93
 
def squash_revision(target_repo, rev):
94
 
    """Remove characters that can't be stored from a revision, if necessary.
95
 
 
96
 
    :param target_repo: Repository in which the revision will be stored
97
 
    :param rev: Revision object, will be modified in-place
98
 
    """
99
 
    if not getattr(target_repo._serializer, "squashes_xml_invalid_characters", True):
100
 
        return
101
 
    from bzrlib.xml_serializer import escape_invalid_chars
102
 
    rev.message, num_escaped = escape_invalid_chars(rev.message)
103
 
    if num_escaped:
104
 
        warn_escaped(rev.foreign_revid, num_escaped)
105
 
    if 'author' in rev.properties:
106
 
        rev.properties['author'], num_escaped = escape_invalid_chars(
107
 
            rev.properties['author'])
108
 
        if num_escaped:
109
 
            warn_escaped(rev.foreign_revid, num_escaped)
110
 
    rev.committer, num_escaped = escape_invalid_chars(rev.committer)
111
 
    if num_escaped:
112
 
        warn_escaped(rev.foreign_revid, num_escaped)
113
 
 
114
 
 
115
95
class BzrGitMapping(foreign.VcsMapping):
116
96
    """Class that maps between Git and Bazaar semantics."""
117
97
    experimental = False
118
98
 
 
99
    BZR_FILE_IDS_FILE = None
 
100
 
 
101
    BZR_DUMMY_FILE = None
 
102
 
119
103
    def __init__(self):
120
104
        super(BzrGitMapping, self).__init__(foreign_git)
121
105
 
122
106
    def __eq__(self, other):
123
 
        return (type(self) == type(other) and 
 
107
        return (type(self) == type(other) and
124
108
                self.revid_prefix == other.revid_prefix)
125
109
 
126
110
    @classmethod
127
111
    def revision_id_foreign_to_bzr(cls, git_rev_id):
128
112
        """Convert a git revision id handle to a Bazaar revision id."""
129
 
        if git_rev_id == "0" * 40:
 
113
        from dulwich.protocol import ZERO_SHA
 
114
        if git_rev_id == ZERO_SHA:
130
115
            return NULL_REVISION
131
116
        return "%s:%s" % (cls.revid_prefix, git_rev_id)
132
117
 
142
127
        # We must just hope they are valid UTF-8..
143
128
        if path == "":
144
129
            return ROOT_ID
 
130
        if type(path) is unicode:
 
131
            path = path.encode("utf-8")
145
132
        return escape_file_id(path)
146
133
 
 
134
    def is_control_file(self, path):
 
135
        return path in (self.BZR_FILE_IDS_FILE, self.BZR_DUMMY_FILE)
 
136
 
147
137
    def parse_file_id(self, file_id):
148
138
        if file_id == ROOT_ID:
149
139
            return ""
150
140
        return unescape_file_id(file_id)
151
141
 
 
142
    def revid_as_refname(self, revid):
 
143
        import urllib
 
144
        return "refs/bzr/%s" % urllib.quote(revid)
 
145
 
152
146
    def import_unusual_file_modes(self, rev, unusual_file_modes):
153
147
        if unusual_file_modes:
154
 
            ret = [(name, unusual_file_modes[name])
155
 
                   for name in sorted(unusual_file_modes.keys())]
 
148
            ret = [(path, unusual_file_modes[path])
 
149
                   for path in sorted(unusual_file_modes.keys())]
156
150
            rev.properties['file-modes'] = bencode.bencode(ret)
157
151
 
158
152
    def export_unusual_file_modes(self, rev):
159
153
        try:
160
 
            return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(rev.properties['file-modes'].encode("utf-8"))])
 
154
            file_modes = rev.properties['file-modes']
161
155
        except KeyError:
162
156
            return {}
 
157
        else:
 
158
            return dict([(self.generate_file_id(path), mode) for (path, mode) in bencode.bdecode(file_modes.encode("utf-8"))])
163
159
 
164
160
    def _generate_git_svn_metadata(self, rev, encoding):
165
161
        try:
166
 
            return "\ngit-svn-id: %s\n" % rev.properties["git-svn-id"].encode(
167
 
                encoding)
 
162
            git_svn_id = rev.properties["git-svn-id"]
168
163
        except KeyError:
169
164
            return ""
 
165
        else:
 
166
            return "\ngit-svn-id: %s\n" % git_svn_id.encode(encoding)
170
167
 
171
168
    def _generate_hg_message_tail(self, rev):
172
169
        extra = {}
188
185
 
189
186
    def _extract_git_svn_metadata(self, rev, message):
190
187
        lines = message.split("\n")
191
 
        if not (lines[-1] == "" and lines[-2].startswith("git-svn-id:")):
 
188
        if not (lines[-1] == "" and len(lines) >= 2 and lines[-2].startswith("git-svn-id:")):
192
189
            return message
193
190
        git_svn_id = lines[-2].split(": ", 1)[1]
194
191
        rev.properties['git-svn-id'] = git_svn_id
209
206
                [(new, old) for (old, new) in renames.iteritems()]))
210
207
        return message
211
208
 
 
209
    def _extract_bzr_metadata(self, rev, message):
 
210
        (message, metadata) = extract_bzr_metadata(message)
 
211
        return message, metadata
 
212
 
212
213
    def _decode_commit_message(self, rev, message, encoding):
213
 
        return message.decode(encoding)
 
214
        return message.decode(encoding), BzrGitRevisionMetadata()
214
215
 
215
216
    def _encode_commit_message(self, rev, message, encoding):
216
217
        return message.encode(encoding)
217
218
 
218
 
    def export_commit(self, rev, tree_sha, parent_lookup):
 
219
    def export_fileid_map(self, fileid_map):
 
220
        """Export a file id map to a fileid map.
 
221
 
 
222
        :param fileid_map: File id map, mapping paths to file ids
 
223
        :return: A Git blob object
 
224
        """
 
225
        from dulwich.objects import Blob
 
226
        b = Blob()
 
227
        b.set_raw_chunks(serialize_fileid_map(fileid_map))
 
228
        return b
 
229
 
 
230
    def export_commit(self, rev, tree_sha, parent_lookup, roundtrip,
 
231
                      verifiers):
219
232
        """Turn a Bazaar revision in to a Git commit
220
233
 
221
234
        :param tree_sha: Tree sha for the commit
222
235
        :param parent_lookup: Function for looking up the GIT sha equiv of a
223
236
            bzr revision
 
237
        :param roundtrip: Whether to store roundtripping information.
 
238
        :param verifiers: Verifiers info
224
239
        :return dulwich.objects.Commit represent the revision:
225
240
        """
226
241
        from dulwich.objects import Commit
227
242
        commit = Commit()
228
243
        commit.tree = tree_sha
 
244
        if roundtrip:
 
245
            metadata = BzrGitRevisionMetadata()
 
246
            metadata.verifiers = verifiers
 
247
        else:
 
248
            metadata = None
 
249
        parents = []
229
250
        for p in rev.parent_ids:
230
251
            try:
231
252
                git_p = parent_lookup(p)
232
253
            except KeyError:
233
254
                git_p = None
 
255
                if metadata is not None:
 
256
                    metadata.explicit_parent_ids = rev.parent_ids
234
257
            if git_p is not None:
235
258
                assert len(git_p) == 40, "unexpected length for %r" % git_p
236
 
                commit.parents.append(git_p)
 
259
                parents.append(git_p)
 
260
        commit.parents = parents
237
261
        try:
238
262
            encoding = rev.properties['git-explicit-encoding']
239
263
        except KeyError:
248
272
            commit.author_time = long(rev.properties['author-timestamp'])
249
273
        else:
250
274
            commit.author_time = commit.commit_time
 
275
        commit._commit_timezone_neg_utc = "commit-timezone-neg-utc" in rev.properties
251
276
        commit.commit_timezone = rev.timezone
 
277
        commit._author_timezone_neg_utc = "author-timezone-neg-utc" in rev.properties
252
278
        if 'author-timezone' in rev.properties:
253
279
            commit.author_timezone = int(rev.properties['author-timezone'])
254
280
        else:
255
281
            commit.author_timezone = commit.commit_timezone
256
282
        commit.message = self._encode_commit_message(rev, rev.message, 
257
283
            encoding)
 
284
        assert type(commit.message) == str
 
285
        if metadata is not None:
 
286
            try:
 
287
                mapping_registry.parse_revision_id(rev.revision_id)
 
288
            except errors.InvalidRevisionId:
 
289
                metadata.revision_id = rev.revision_id
 
290
            mapping_properties = set(
 
291
                ['author', 'author-timezone', 'author-timezone-neg-utc',
 
292
                 'commit-timezone-neg-utc', 'git-implicit-encoding',
 
293
                 'git-explicit-encoding', 'author-timestamp', 'file-modes'])
 
294
            for k, v in rev.properties.iteritems():
 
295
                if not k in mapping_properties:
 
296
                    metadata.properties[k] = v
 
297
        if self.roundtripping:
 
298
            commit.message = inject_bzr_metadata(commit.message, metadata, 
 
299
                                                 encoding)
 
300
        assert type(commit.message) == str
258
301
        return commit
259
302
 
260
 
    def import_commit(self, commit):
 
303
    def import_fileid_map(self, blob):
 
304
        """Convert a git file id map blob.
 
305
 
 
306
        :param blob: Git blob object with fileid map
 
307
        :return: Dictionary mapping paths to file ids
 
308
        """
 
309
        return deserialize_fileid_map(blob.data)
 
310
 
 
311
    def import_commit(self, commit, lookup_parent_revid):
261
312
        """Convert a git commit to a bzr revision.
262
313
 
263
 
        :return: a `bzrlib.revision.Revision` object.
 
314
        :return: a `bzrlib.revision.Revision` object, foreign revid and a
 
315
            testament sha1
264
316
        """
265
317
        if commit is None:
266
318
            raise AssertionError("Commit object can't be None")
267
319
        rev = ForeignRevision(commit.id, self,
268
320
                self.revision_id_foreign_to_bzr(commit.id))
269
 
        rev.parent_ids = tuple([self.revision_id_foreign_to_bzr(p) for p in commit.parents])
 
321
        rev.parent_ids = tuple([lookup_parent_revid(p) for p in commit.parents])
 
322
        rev.git_metadata = None
270
323
        def decode_using_encoding(rev, commit, encoding):
271
324
            rev.committer = str(commit.committer).decode(encoding)
272
325
            if commit.committer != commit.author:
273
326
                rev.properties['author'] = str(commit.author).decode(encoding)
274
 
            rev.message = self._decode_commit_message(rev, commit.message, 
275
 
                encoding)
 
327
            rev.message, rev.git_metadata = self._decode_commit_message(
 
328
                rev, commit.message, encoding)
276
329
        if commit.encoding is not None:
277
330
            rev.properties['git-explicit-encoding'] = commit.encoding
278
331
            decode_using_encoding(rev, commit, commit.encoding)
290
343
            rev.properties['author-timestamp'] = str(commit.author_time)
291
344
        if commit.commit_timezone != commit.author_timezone:
292
345
            rev.properties['author-timezone'] = "%d" % commit.author_timezone
 
346
        if commit._author_timezone_neg_utc:
 
347
            rev.properties['author-timezone-neg-utc'] = ""
 
348
        if commit._commit_timezone_neg_utc:
 
349
            rev.properties['commit-timezone-neg-utc'] = ""
293
350
        rev.timestamp = commit.commit_time
294
351
        rev.timezone = commit.commit_timezone
295
 
        return rev
 
352
        if rev.git_metadata is not None:
 
353
            md = rev.git_metadata
 
354
            roundtrip_revid = md.revision_id
 
355
            if md.explicit_parent_ids:
 
356
                rev.parent_ids = md.explicit_parent_ids
 
357
            rev.properties.update(md.properties)
 
358
            verifiers = md.verifiers
 
359
        else:
 
360
            roundtrip_revid = None
 
361
            verifiers = {}
 
362
        return rev, roundtrip_revid, verifiers
 
363
 
 
364
    def get_fileid_map(self, lookup_object, tree_sha):
 
365
        """Obtain a fileid map for a particular tree.
 
366
 
 
367
        :param lookup_object: Function for looking up an object
 
368
        :param tree_sha: SHA of the root tree
 
369
        :return: GitFileIdMap instance
 
370
        """
 
371
        try:
 
372
            file_id_map_sha = lookup_object(tree_sha)[self.BZR_FILE_IDS_FILE][1]
 
373
        except KeyError:
 
374
            file_ids = {}
 
375
        else:
 
376
            file_ids = self.import_fileid_map(lookup_object(file_id_map_sha))
 
377
        return GitFileIdMap(file_ids, self)
296
378
 
297
379
 
298
380
class BzrGitMappingv1(BzrGitMapping):
306
388
class BzrGitMappingExperimental(BzrGitMappingv1):
307
389
    revid_prefix = 'git-experimental'
308
390
    experimental = True
 
391
    roundtripping = True
 
392
 
 
393
    BZR_FILE_IDS_FILE = '.bzrfileids'
 
394
 
 
395
    BZR_DUMMY_FILE = '.bzrdummy'
309
396
 
310
397
    def _decode_commit_message(self, rev, message, encoding):
311
398
        message = self._extract_hg_metadata(rev, message)
312
399
        message = self._extract_git_svn_metadata(rev, message)
313
 
        return message.decode(encoding)
 
400
        message, metadata = self._extract_bzr_metadata(rev, message)
 
401
        return message.decode(encoding), metadata
314
402
 
315
403
    def _encode_commit_message(self, rev, message, encoding):
316
404
        ret = message.encode(encoding)
318
406
        ret += self._generate_git_svn_metadata(rev, encoding)
319
407
        return ret
320
408
 
321
 
    def import_commit(self, commit):
322
 
        rev = super(BzrGitMappingExperimental, self).import_commit(commit)
 
409
    def import_commit(self, commit, lookup_parent_revid):
 
410
        rev, roundtrip_revid, verifiers = super(BzrGitMappingExperimental, self).import_commit(commit, lookup_parent_revid)
323
411
        rev.properties['converted_revision'] = "git %s\n" % commit.id
324
 
        return rev
 
412
        return rev, roundtrip_revid, verifiers
325
413
 
326
414
 
327
415
class GitMappingRegistry(VcsMappingRegistry):
329
417
 
330
418
    def revision_id_bzr_to_foreign(self, bzr_revid):
331
419
        if bzr_revid == NULL_REVISION:
332
 
            return "0" * 20, None
 
420
            from dulwich.protocol import ZERO_SHA
 
421
            return ZERO_SHA, None
333
422
        if not bzr_revid.startswith("git-"):
334
423
            raise errors.InvalidRevisionId(bzr_revid, None)
335
424
        (mapping_version, git_sha) = bzr_revid.split(":", 1)
438
527
    return object_mode(entry.kind, entry.executable)
439
528
 
440
529
 
441
 
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes):
442
 
    from dulwich.objects import Tree
 
530
def directory_to_tree(entry, lookup_ie_sha1, unusual_modes, empty_file_name):
 
531
    """Create a Git Tree object from a Bazaar directory.
 
532
 
 
533
    :param entry: Inventory entry
 
534
    :param lookup_ie_sha1: Lookup the Git SHA1 for a inventory entry
 
535
    :param unusual_modes: Dictionary with unusual file modes by file ids
 
536
    :param empty_file_name: Name to use for dummy files in empty directories,
 
537
        None to ignore empty directories.
 
538
    """
 
539
    from dulwich.objects import Blob, Tree
443
540
    tree = Tree()
444
541
    for name, value in entry.children.iteritems():
445
542
        ie = entry.children[name]
452
549
            tree.add(mode, name.encode("utf-8"), hexsha)
453
550
    if entry.parent_id is not None and len(tree) == 0:
454
551
        # Only the root can be an empty tree
455
 
        return None
 
552
        if empty_file_name is not None:
 
553
            tree.add(stat.S_IFREG | 0644, empty_file_name, 
 
554
                Blob().id)
 
555
        else:
 
556
            return None
456
557
    return tree
457
558
 
458
559
 
466
567
        return mapping.export_unusual_file_modes(rev)
467
568
 
468
569
 
469
 
def inventory_to_tree_and_blobs(inventory, texts, mapping, unusual_modes,
470
 
                                cur=None):
471
 
    """Convert a Bazaar tree to a Git tree.
472
 
 
473
 
    :return: Yields tuples with object sha1, object and path
474
 
    """
475
 
    from dulwich.objects import Tree
476
 
    import stat
477
 
    stack = []
478
 
    if cur is None:
479
 
        cur = ""
480
 
    tree = Tree()
481
 
 
482
 
    # stack contains the set of trees that we haven't
483
 
    # finished constructing
484
 
    for path, entry in inventory.iter_entries():
485
 
        while stack and not path.startswith(osutils.pathjoin(cur, "")):
486
 
            # We've hit a file that's not a child of the previous path
487
 
            sha = tree.id
488
 
            yield sha, tree, cur.encode("utf-8")
489
 
            mode = unusual_modes.get(cur.encode("utf-8"), stat.S_IFDIR)
490
 
            t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
491
 
            cur, tree = stack.pop()
492
 
            tree.add(*t)
493
 
 
494
 
        if entry.kind == "directory":
495
 
            stack.append((cur, tree))
496
 
            cur = path
497
 
            tree = Tree()
498
 
        else:
499
 
            if entry.kind == "file":
500
 
                from dulwich.objects import Blob
501
 
                stream = texts.get_record_stream(
502
 
                    [(entry.file_id, entry.revision)], 'unordered', True)
503
 
                blob = Blob()
504
 
                blob.chunked = stream.next().get_bytes_as('chunks')
505
 
            elif entry.kind == "symlink":
506
 
                blob = symlink_to_blob(entry)
507
 
            else:
508
 
                raise AssertionError("Unknown kind %s" % entry.kind)
509
 
            sha = blob.id
510
 
            yield sha, blob, path.encode("utf-8")
511
 
            name = urlutils.basename(path).encode("utf-8")
512
 
            mode = unusual_modes.get(path.encode("utf-8"), entry_mode(entry))
513
 
            tree.add(mode, name, sha)
514
 
 
515
 
    while len(stack) > 1:
516
 
        sha = tree.id
517
 
        yield sha, tree, cur.encode("utf-8")
518
 
        mode = unusual_modes.get(cur.encode('utf-8'), stat.S_IFDIR)
519
 
        t = (mode, urlutils.basename(cur).encode('UTF-8'), sha)
520
 
        cur, tree = stack.pop()
521
 
        tree.add(*t)
522
 
 
523
 
    yield tree.id, tree, cur.encode("utf-8")
524
 
 
525
 
 
526
570
def parse_git_svn_id(text):
527
571
    (head, uuid) = text.rsplit(" ", 1)
528
572
    (full_url, rev) = head.rsplit("@", 1)
529
573
    return (full_url, int(rev), uuid)
 
574
 
 
575
 
 
576
class GitFileIdMap(object):
 
577
 
 
578
    def __init__(self, file_ids, mapping):
 
579
        self.file_ids = file_ids
 
580
        self.paths = None
 
581
        self.mapping = mapping
 
582
 
 
583
    def lookup_file_id(self, path):
 
584
        assert type(path) is str
 
585
        try:
 
586
            file_id = self.file_ids[path]
 
587
        except KeyError:
 
588
            file_id = self.mapping.generate_file_id(path)
 
589
        assert type(file_id) is str
 
590
        return file_id
 
591
 
 
592
    def lookup_path(self, file_id):
 
593
        if self.paths is None:
 
594
            self.paths = {}
 
595
            for k, v in self.file_ids.iteritems():
 
596
                self.paths[v] = k
 
597
        try:
 
598
            path = self.paths[file_id]
 
599
        except KeyError:
 
600
            return self.mapping.parse_file_id(file_id)
 
601
        else:
 
602
            assert type(path) is str
 
603
            return path