1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
# Copyright (C) 2010 Jelmer Vernooij <jelmer@samba.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Roundtripping support.
Bazaar stores more data than Git, which means that in order to preserve
a commit when it is pushed from Bazaar into Git we have to stash
that extra metadata somewhere.
There are two kinds of metadata relevant here:
* per-file metadata (stored by revision+path)
- usually stored per tree
* per-revision metadata (stored by git commit id)
Bazaar revisions have the following information that is not
present in Git commits:
* revision ids
* revision properties
* ghost parents
Tree content:
* empty directories
* path file ids
* path last changed revisions [1]
[1] path last changed revision information can usually
be induced from the existing history, unless
ghost revisions are involved.
This extra metadata is stored in so-called "supplements":
* CommitSupplement
* TreeSupplement
"""
from __future__ import absolute_import
from bzrlib import osutils
from cStringIO import StringIO
class CommitSupplement(object):
"""Supplement for a Bazaar revision roundtripped into Git.
:ivar revision_id: Revision id, as string
:ivar properties: Revision properties, as dictionary
:ivar explicit_parent_ids: Parent ids (needed if there are ghosts)
:ivar verifiers: Verifier information
"""
revision_id = None
explicit_parent_ids = None
def __init__(self):
self.properties = {}
self.verifiers = {}
def __nonzero__(self):
return bool(self.revision_id or self.properties or self.explicit_parent_ids)
class TreeSupplement(object):
"""Supplement for a Bazaar tree roundtripped into Git.
This provides file ids (if they are different from the mapping default)
and can provide text revisions.
"""
def parse_roundtripping_metadata(text):
"""Parse Bazaar roundtripping metadata."""
ret = CommitSupplement()
f = StringIO(text)
for l in f.readlines():
(key, value) = l.split(":", 1)
if key == "revision-id":
ret.revision_id = value.strip()
elif key == "parent-ids":
ret.explicit_parent_ids = tuple(value.strip().split(" "))
elif key == "testament3-sha1":
ret.verifiers["testament3-sha1"] = value.strip()
elif key.startswith("property-"):
name = key[len("property-"):]
if not name in ret.properties:
ret.properties[name] = value[1:].rstrip("\n")
else:
ret.properties[name] += "\n" + value[1:].rstrip("\n")
else:
raise ValueError
return ret
def generate_roundtripping_metadata(metadata, encoding):
"""Serialize the roundtripping metadata.
:param metadata: A `CommitSupplement` instance
:return: String with revision metadata
"""
lines = []
if metadata.revision_id:
lines.append("revision-id: %s\n" % metadata.revision_id)
if metadata.explicit_parent_ids:
lines.append("parent-ids: %s\n" % " ".join(metadata.explicit_parent_ids))
for key in sorted(metadata.properties.keys()):
for l in metadata.properties[key].split("\n"):
lines.append("property-%s: %s\n" % (key.encode(encoding), osutils.safe_utf8(l)))
if "testament3-sha1" in metadata.verifiers:
lines.append("testament3-sha1: %s\n" %
metadata.verifiers["testament3-sha1"])
return "".join(lines)
def extract_bzr_metadata(message):
"""Extract Bazaar metadata from a commit message.
:param message: Commit message to extract from
:return: Tuple with original commit message and metadata object
"""
split = message.split("\n--BZR--\n", 1)
if len(split) != 2:
return message, None
return split[0], parse_roundtripping_metadata(split[1])
def inject_bzr_metadata(message, commit_supplement, encoding):
if not commit_supplement:
return message
rt_data = generate_roundtripping_metadata(commit_supplement, encoding)
if not rt_data:
return message
assert type(rt_data) == str
return message + "\n--BZR--\n" + rt_data
def serialize_fileid_map(file_ids):
"""Serialize a fileid map.
:param file_ids: Path -> fileid map
:return: Serialized fileid map, as sequence of chunks
"""
lines = []
for path in sorted(file_ids.keys()):
lines.append("%s\0%s\n" % (path, file_ids[path]))
return lines
def deserialize_fileid_map(filetext):
"""Deserialize a file id map.
:param file: File
:return: Fileid map (path -> fileid)
"""
ret = {}
f = StringIO(filetext)
lines = f.readlines()
for l in lines:
(path, file_id) = l.rstrip("\n").split("\0")
ret[path] = file_id
return ret
|
