14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24
revision as _mod_revision,
26
18
from bzrlib.xml_serializer import SubElement, Element, Serializer
27
19
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
20
import bzrlib.inventory as inventory
28
21
from bzrlib.revision import Revision
29
22
from bzrlib.errors import BzrError
36
"'":"'", # FIXME: overkill
43
def _ensure_utf8_re():
44
"""Make sure the _utf8_re and _unicode_re regexes have been compiled."""
45
global _utf8_re, _unicode_re
47
_utf8_re = re.compile('[&<>\'\"]|[\x80-\xff]+')
48
if _unicode_re is None:
49
_unicode_re = re.compile(u'[&<>\'\"\u0080-\uffff]')
52
def _unicode_escape_replace(match, _map=_xml_escape_map):
53
"""Replace a string of non-ascii, non XML safe characters with their escape
55
This will escape both Standard XML escapes, like <>"', etc.
56
As well as escaping non ascii characters, because ElementTree did.
57
This helps us remain compatible to older versions of bzr. We may change
58
our policy in the future, though.
60
# jam 20060816 Benchmarks show that try/KeyError is faster if you
61
# expect the entity to rarely miss. There is about a 10% difference
62
# in overall time. But if you miss frequently, then if None is much
63
# faster. For our use case, we *rarely* have a revision id, file id
64
# or path name that is unicode. So use try/KeyError.
66
return _map[match.group()]
68
return "&#%d;" % ord(match.group())
71
def _utf8_escape_replace(match, _map=_xml_escape_map):
72
"""Escape utf8 characters into XML safe ones.
74
This uses 2 tricks. It is either escaping "standard" characters, like "&<>,
75
or it is handling characters with the high-bit set. For ascii characters,
76
we just lookup the replacement in the dictionary. For everything else, we
77
decode back into Unicode, and then use the XML escape code.
80
return _map[match.group()]
82
return ''.join('&#%d;' % ord(uni_chr)
83
for uni_chr in match.group().decode('utf8'))
88
def _encode_and_escape(unicode_or_utf8_str, _map=_to_escaped_map):
89
"""Encode the string into utf8, and escape invalid XML characters"""
90
# We frequently get entities we have not seen before, so it is better
91
# to check if None, rather than try/KeyError
92
text = _map.get(unicode_or_utf8_str)
94
if unicode_or_utf8_str.__class__ == unicode:
95
# The alternative policy is to do a regular UTF8 encoding
96
# and then escape only XML meta characters.
97
# Performance is equivalent once you use cache_utf8. *However*
98
# this makes the serialized texts incompatible with old versions
99
# of bzr. So no net gain. (Perhaps the read code would handle utf8
100
# better than entity escapes, but cElementTree seems to do just fine
102
text = str(_unicode_re.sub(_unicode_escape_replace,
103
unicode_or_utf8_str)) + '"'
105
# Plain strings are considered to already be in utf-8 so we do a
106
# slightly different method for escaping.
107
text = _utf8_re.sub(_utf8_escape_replace,
108
unicode_or_utf8_str) + '"'
109
_map[unicode_or_utf8_str] = text
113
def _get_utf8_or_ascii(a_str,
114
_encode_utf8=cache_utf8.encode,
115
_get_cached_ascii=cache_utf8.get_cached_ascii):
116
"""Return a cached version of the string.
118
cElementTree will return a plain string if the XML is plain ascii. It only
119
returns Unicode when it needs to. We want to work in utf-8 strings. So if
120
cElementTree returns a plain string, we can just return the cached version.
121
If it is Unicode, then we need to encode it.
123
:param a_str: An 8-bit string or Unicode as returned by
124
cElementTree.Element.get()
125
:return: A utf-8 encoded 8-bit string.
127
# This is fairly optimized because we know what cElementTree does, this is
128
# not meant as a generic function for all cases. Because it is possible for
129
# an 8-bit string to not be ascii or valid utf8.
130
if a_str.__class__ == unicode:
131
return _encode_utf8(a_str)
133
return _get_cached_ascii(a_str)
137
"""Clean out the unicode => escaped map"""
138
_to_escaped_map.clear()
141
25
class Serializer_v5(Serializer):
142
26
"""Version 5 serializer
149
support_altered_by_hack = True
150
# This format supports the altered-by hack that reads file ids directly out
151
# of the versionedfile, without doing XML parsing.
153
supported_kinds = set(['file', 'directory', 'symlink'])
156
def write_inventory_to_string(self, inv):
157
"""Just call write_inventory with a StringIO and return the value"""
158
sio = cStringIO.StringIO()
159
self.write_inventory(inv, sio)
160
return sio.getvalue()
162
def write_inventory(self, inv, f):
163
"""Write inventory to a file.
165
:param inv: the inventory to write.
166
:param f: the file to write.
170
append = output.append
171
self._append_inventory_root(append, inv)
33
def _pack_inventory(self, inv):
34
"""Convert to XML Element"""
172
35
entries = inv.iter_entries()
174
root_path, root_ie = entries.next()
36
e = Element('inventory',
39
path, root = entries.next()
40
if root.file_id not in (None, ROOT_ID):
41
e.set('file_id', root.file_id)
42
if inv.revision_id is not None:
43
e.set('revision_id', inv.revision_id)
175
44
for path, ie in entries:
176
self._append_entry(append, ie)
177
append('</inventory>\n')
179
# Just to keep the cache from growing without bounds
180
# but we may actually not want to do clear the cache
45
e.append(self._pack_entry(ie))
183
def _append_inventory_root(self, append, inv):
184
"""Append the inventory root to output."""
186
if inv.root.file_id not in (None, ROOT_ID):
188
append(_encode_and_escape(inv.root.file_id))
189
append(' format="5"')
190
if inv.revision_id is not None:
191
append(' revision_id="')
192
append(_encode_and_escape(inv.revision_id))
195
def _append_entry(self, append, ie):
196
"""Convert InventoryEntry to XML element and append to output."""
48
def _pack_entry(self, ie):
49
"""Convert InventoryEntry to XML element"""
197
50
# TODO: should just be a plain assertion
198
if ie.kind not in self.supported_kinds:
199
raise errors.UnsupportedInventoryKind(ie.kind)
51
if not InventoryEntry.versionable_kind(ie.kind):
52
raise AssertionError('unsupported entry kind %s' % ie.kind)
54
e.set('name', ie.name)
55
e.set('file_id', ie.file_id)
57
if ie.text_size != None:
58
e.set('text_size', '%d' % ie.text_size)
60
for f in ['text_sha1', 'revision', 'symlink_target']:
204
append(' executable="yes"')
206
append(_encode_and_escape(ie.file_id))
208
append(_encode_and_escape(ie.name))
209
if self._parent_condition(ie):
66
e.set('executable', 'yes')
68
# to be conservative, we don't externalize the root pointers
69
# for now, leaving them as null in the xml form. in a future
70
# version it will be implied by nested elements.
71
if ie.parent_id != ROOT_ID:
210
72
assert isinstance(ie.parent_id, basestring)
211
append(' parent_id="')
212
append(_encode_and_escape(ie.parent_id))
213
if ie.revision is not None:
214
append(' revision="')
215
append(_encode_and_escape(ie.revision))
216
if ie.symlink_target is not None:
217
append(' symlink_target="')
218
append(_encode_and_escape(ie.symlink_target))
219
if ie.text_sha1 is not None:
220
append(' text_sha1="')
223
if ie.text_size is not None:
224
append(' text_size="%d"' % ie.text_size)
225
if getattr(ie, 'reference_revision', None) is not None:
226
append(' reference_revision="')
227
append(_encode_and_escape(ie.reference_revision))
231
def _parent_condition(self, ie):
232
return ie.parent_id != ROOT_ID
73
e.set('parent_id', ie.parent_id)
234
77
def _pack_revision(self, rev):
235
78
"""Revision object -> xml tree"""
236
# For the XML format, we need to write them as Unicode rather than as
237
# utf-8 strings. So that cElementTree can handle properly escaping
239
decode_utf8 = cache_utf8.decode
240
revision_id = rev.revision_id
241
if isinstance(revision_id, str):
242
revision_id = decode_utf8(revision_id)
243
79
root = Element('revision',
244
80
committer = rev.committer,
245
timestamp = '%.3f' % rev.timestamp,
246
revision_id = revision_id,
81
timestamp = '%.9f' % rev.timestamp,
82
revision_id = rev.revision_id,
247
83
inventory_sha1 = rev.inventory_sha1,
250
if rev.timezone is not None:
251
87
root.set('timezone', str(rev.timezone))
253
89
msg = SubElement(root, 'message')
279
113
prop_elt.tail = '\n'
280
114
top_elt.tail = '\n'
282
117
def _unpack_inventory(self, elt):
283
118
"""Construct from XML Element
285
120
assert elt.tag == 'inventory'
286
121
root_id = elt.get('file_id') or ROOT_ID
287
root_id = _get_utf8_or_ascii(root_id)
289
122
format = elt.get('format')
290
123
if format is not None:
291
124
if format != '5':
292
125
raise BzrError("invalid format version %r on inventory"
294
127
revision_id = elt.get('revision_id')
295
if revision_id is not None:
296
revision_id = cache_utf8.encode(revision_id)
297
128
inv = Inventory(root_id, revision_id=revision_id)
299
130
ie = self._unpack_entry(e)
300
if ie.parent_id is None:
131
if ie.parent_id == ROOT_ID:
301
132
ie.parent_id = root_id
305
137
def _unpack_entry(self, elt):
307
139
if not InventoryEntry.versionable_kind(kind):
308
140
raise AssertionError('unsupported entry kind %s' % kind)
310
get_cached = _get_utf8_or_ascii
312
142
parent_id = elt.get('parent_id')
313
if parent_id is not None:
314
parent_id = get_cached(parent_id)
315
file_id = get_cached(elt.get('file_id'))
143
if parent_id == None:
317
146
if kind == 'directory':
318
ie = inventory.InventoryDirectory(file_id,
147
ie = inventory.InventoryDirectory(elt.get('file_id'),
321
150
elif kind == 'file':
322
ie = inventory.InventoryFile(file_id,
151
ie = inventory.InventoryFile(elt.get('file_id'),
325
154
ie.text_sha1 = elt.get('text_sha1')
349
176
if format != '5':
350
177
raise BzrError("invalid format version %r on inventory"
352
get_cached = _get_utf8_or_ascii
353
179
rev = Revision(committer = elt.get('committer'),
354
180
timestamp = float(elt.get('timestamp')),
355
revision_id = get_cached(elt.get('revision_id')),
181
revision_id = elt.get('revision_id'),
356
182
inventory_sha1 = elt.get('inventory_sha1')
358
184
parents = elt.find('parents') or []
359
185
for p in parents:
360
186
assert p.tag == 'revision_ref', \
361
187
"bad parent node tag %r" % p.tag
362
rev.parent_ids.append(get_cached(p.get('revision_id')))
188
rev.parent_ids.append(p.get('revision_id'))
363
189
self._unpack_revision_properties(elt, rev)
364
190
v = elt.get('timezone')
368
rev.timezone = int(v)
191
rev.timezone = v and int(v)
369
192
rev.message = elt.findtext('message') # text of <message>
372
196
def _unpack_revision_properties(self, elt, rev):
373
197
"""Unpack properties onto a revision."""
374
198
props_elt = elt.find('properties')
added
removed
bzrlib/xml5.py
