13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
20
21
from bzrlib import (
24
24
revision as _mod_revision,
26
from bzrlib.xml_serializer import SubElement, Element, Serializer
27
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
27
from bzrlib.xml_serializer import (
34
serialize_inventory_flat,
35
unpack_inventory_entry,
36
unpack_inventory_flat,
28
38
from bzrlib.revision import Revision
29
39
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
class Serializer_v5(Serializer):
142
"""Version 5 serializer
144
Packs objects into XML and vice versa.
51
def _unescaper(match, _map=_xml_unescape_map):
56
if not code.startswith('#'):
58
return unichr(int(code[1:])).encode('utf8')
61
_unescape_re = lazy_regex.lazy_compile('\&([^;]*);')
63
def _unescape_xml(data):
64
"""Unescape predefined XML entities in a string of data."""
65
return _unescape_re.sub(_unescaper, data)
68
class Serializer_v8(XMLSerializer):
69
"""This serialiser adds rich roots.
71
Its revision format number matches its inventory number.
150
77
support_altered_by_hack = True
151
78
# This format supports the altered-by hack that reads file ids directly out
152
79
# of the versionedfile, without doing XML parsing.
154
81
supported_kinds = set(['file', 'directory', 'symlink'])
83
revision_format_num = None
85
# The search regex used by xml based repositories to determine what things
86
# where changed in a single commit.
87
_file_ids_altered_regex = lazy_regex.lazy_compile(
88
r'file_id="(?P<file_id>[^"]+)"'
89
r'.* revision="(?P<revision_id>[^"]+)"'
157
92
def _check_revisions(self, inv):
158
93
"""Extension point for subclasses to check during serialisation.
160
By default no checking is done.
162
95
:param inv: An inventory about to be serialised, to be checked.
163
:raises: AssertionError if an error has occured.
96
:raises: AssertionError if an error has occurred.
98
if inv.revision_id is None:
99
raise AssertionError("inv.revision_id is None")
100
if inv.root.revision is None:
101
raise AssertionError("inv.root.revision is None")
103
def _check_cache_size(self, inv_size, entry_cache):
104
"""Check that the entry_cache is large enough.
106
We want the cache to be ~2x the size of an inventory. The reason is
107
because we use a FIFO cache, and how Inventory records are likely to
108
change. In general, you have a small number of records which change
109
often, and a lot of records which do not change at all. So when the
110
cache gets full, you actually flush out a lot of the records you are
111
interested in, which means you need to recreate all of those records.
112
An LRU Cache would be better, but the overhead negates the cache
115
One way to look at it, only the size of the cache > len(inv) is your
116
'working' set. And in general, it shouldn't be a problem to hold 2
117
inventories in memory anyway.
119
:param inv_size: The number of entries in an inventory.
121
if entry_cache is None:
123
# 1.5 times might also be reasonable.
124
recommended_min_cache_size = inv_size * 1.5
125
if entry_cache.cache_size() < recommended_min_cache_size:
126
recommended_cache_size = inv_size * 2
127
trace.mutter('Resizing the inventory entry cache from %d to %d',
128
entry_cache.cache_size(), recommended_cache_size)
129
entry_cache.resize(recommended_cache_size)
166
131
def write_inventory_to_lines(self, inv):
167
132
"""Return a list of lines with the encoded inventory."""
187
152
reference_revision, symlink_target.
188
153
:return: The inventory as a list of lines.
191
self._check_revisions(inv)
193
156
append = output.append
194
157
self._append_inventory_root(append, inv)
195
entries = inv.iter_entries()
197
root_path, root_ie = entries.next()
198
for path, ie in entries:
199
if ie.parent_id != self.root_id:
200
parent_str = ' parent_id="'
201
parent_id = _encode_and_escape(ie.parent_id)
205
if ie.kind == 'file':
207
executable = ' executable="yes"'
211
append('<file%s file_id="%s name="%s%s%s revision="%s '
212
'text_sha1="%s" text_size="%d" />\n' % (
213
executable, _encode_and_escape(ie.file_id),
214
_encode_and_escape(ie.name), parent_str, parent_id,
215
_encode_and_escape(ie.revision), ie.text_sha1,
218
append('<file%s file_id="%s name="%s%s%s />\n' % (
219
executable, _encode_and_escape(ie.file_id),
220
_encode_and_escape(ie.name), parent_str, parent_id))
221
elif ie.kind == 'directory':
223
append('<directory file_id="%s name="%s%s%s revision="%s '
225
_encode_and_escape(ie.file_id),
226
_encode_and_escape(ie.name),
227
parent_str, parent_id,
228
_encode_and_escape(ie.revision)))
230
append('<directory file_id="%s name="%s%s%s />\n' % (
231
_encode_and_escape(ie.file_id),
232
_encode_and_escape(ie.name),
233
parent_str, parent_id))
234
elif ie.kind == 'symlink':
236
append('<symlink file_id="%s name="%s%s%s revision="%s '
237
'symlink_target="%s />\n' % (
238
_encode_and_escape(ie.file_id),
239
_encode_and_escape(ie.name),
240
parent_str, parent_id,
241
_encode_and_escape(ie.revision),
242
_encode_and_escape(ie.symlink_target)))
244
append('<symlink file_id="%s name="%s%s%s />\n' % (
245
_encode_and_escape(ie.file_id),
246
_encode_and_escape(ie.name),
247
parent_str, parent_id))
248
elif ie.kind == 'tree-reference':
249
if ie.kind not in self.supported_kinds:
250
raise errors.UnsupportedInventoryKind(ie.kind)
252
append('<tree-reference file_id="%s name="%s%s%s '
253
'revision="%s reference_revision="%s />\n' % (
254
_encode_and_escape(ie.file_id),
255
_encode_and_escape(ie.name),
256
parent_str, parent_id,
257
_encode_and_escape(ie.revision),
258
_encode_and_escape(ie.reference_revision)))
260
append('<tree-reference file_id="%s name="%s%s%s />\n' % (
261
_encode_and_escape(ie.file_id),
262
_encode_and_escape(ie.name),
263
parent_str, parent_id))
265
raise errors.UnsupportedInventoryKind(ie.kind)
266
append('</inventory>\n')
158
serialize_inventory_flat(inv, append,
159
self.root_id, self.supported_kinds, working)
267
160
if f is not None:
268
161
f.writelines(output)
269
162
# Just to keep the cache from growing without bounds
328
221
def _pack_revision_properties(self, rev, under_element):
329
222
top_elt = SubElement(under_element, 'properties')
330
223
for prop_name, prop_value in sorted(rev.properties.items()):
331
assert isinstance(prop_name, basestring)
332
assert isinstance(prop_value, basestring)
333
224
prop_elt = SubElement(top_elt, 'property')
334
225
prop_elt.set('name', prop_name)
335
226
prop_elt.text = prop_value
336
227
prop_elt.tail = '\n'
337
228
top_elt.tail = '\n'
339
def _unpack_inventory(self, elt, revision_id):
340
"""Construct from XML Element
342
assert elt.tag == 'inventory'
343
root_id = elt.get('file_id') or ROOT_ID
344
root_id = _get_utf8_or_ascii(root_id)
230
def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
231
# This is here because it's overridden by xml7
232
return unpack_inventory_entry(elt, entry_cache,
346
format = elt.get('format')
347
if format is not None:
349
raise BzrError("invalid format version %r on inventory"
351
data_revision_id = elt.get('revision_id')
352
if data_revision_id is not None:
353
revision_id = cache_utf8.encode(data_revision_id)
354
inv = Inventory(root_id, revision_id=revision_id)
356
ie = self._unpack_entry(e)
357
if ie.parent_id is None:
358
ie.parent_id = root_id
360
if revision_id is not None:
361
inv.root.revision = revision_id
235
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
236
return_from_cache=False):
237
"""Construct from XML Element"""
238
inv = unpack_inventory_flat(elt, self.format_num, self._unpack_entry,
239
entry_cache, return_from_cache)
240
self._check_cache_size(len(inv), entry_cache)
364
def _unpack_entry(self, elt):
366
if not InventoryEntry.versionable_kind(kind):
367
raise AssertionError('unsupported entry kind %s' % kind)
369
get_cached = _get_utf8_or_ascii
371
parent_id = elt.get('parent_id')
372
if parent_id is not None:
373
parent_id = get_cached(parent_id)
374
file_id = get_cached(elt.get('file_id'))
376
if kind == 'directory':
377
ie = inventory.InventoryDirectory(file_id,
381
ie = inventory.InventoryFile(file_id,
384
ie.text_sha1 = elt.get('text_sha1')
385
if elt.get('executable') == 'yes':
387
v = elt.get('text_size')
388
ie.text_size = v and int(v)
389
elif kind == 'symlink':
390
ie = inventory.InventoryLink(file_id,
393
ie.symlink_target = elt.get('symlink_target')
395
raise errors.UnsupportedInventoryKind(kind)
396
revision = elt.get('revision')
397
if revision is not None:
398
revision = get_cached(revision)
399
ie.revision = revision
403
243
def _unpack_revision(self, elt):
404
244
"""XML Element -> Revision object"""
405
assert elt.tag == 'revision'
406
245
format = elt.get('format')
246
format_num = self.format_num
247
if self.revision_format_num is not None:
248
format_num = self.revision_format_num
407
249
if format is not None:
409
raise BzrError("invalid format version %r on inventory"
250
if format != format_num:
251
raise BzrError("invalid format version %r on revision"
411
get_cached = _get_utf8_or_ascii
253
get_cached = get_utf8_or_ascii
412
254
rev = Revision(committer = elt.get('committer'),
413
255
timestamp = float(elt.get('timestamp')),
414
256
revision_id = get_cached(elt.get('revision_id')),
444
284
# properties have string values
445
285
if value is None:
447
assert name not in rev.properties, \
448
"repeated property %r" % name
287
if name in rev.properties:
288
raise AssertionError("repeated property %r" % name)
449
289
rev.properties[name] = value
452
serializer_v5 = Serializer_v5()
291
def _find_text_key_references(self, line_iterator):
292
"""Core routine for extracting references to texts from inventories.
294
This performs the translation of xml lines to revision ids.
296
:param line_iterator: An iterator of lines, origin_version_id
297
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
298
to whether they were referred to by the inventory of the
299
revision_id that they contain. Note that if that revision_id was
300
not part of the line_iterator's output then False will be given -
301
even though it may actually refer to that key.
303
if not self.support_altered_by_hack:
304
raise AssertionError(
305
"_find_text_key_references only "
306
"supported for branches which store inventory as unnested xml"
307
", not on %r" % self)
310
# this code needs to read every new line in every inventory for the
311
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
312
# not present in one of those inventories is unnecessary but not
313
# harmful because we are filtering by the revision id marker in the
314
# inventory lines : we only select file ids altered in one of those
315
# revisions. We don't need to see all lines in the inventory because
316
# only those added in an inventory in rev X can contain a revision=X
318
unescape_revid_cache = {}
319
unescape_fileid_cache = {}
321
# jam 20061218 In a big fetch, this handles hundreds of thousands
322
# of lines, so it has had a lot of inlining and optimizing done.
323
# Sorry that it is a little bit messy.
324
# Move several functions to be local variables, since this is a long
326
search = self._file_ids_altered_regex.search
327
unescape = _unescape_xml
328
setdefault = result.setdefault
329
for line, line_key in line_iterator:
333
# One call to match.group() returning multiple items is quite a
334
# bit faster than 2 calls to match.group() each returning 1
335
file_id, revision_id = match.group('file_id', 'revision_id')
337
# Inlining the cache lookups helps a lot when you make 170,000
338
# lines and 350k ids, versus 8.4 unique ids.
339
# Using a cache helps in 2 ways:
340
# 1) Avoids unnecessary decoding calls
341
# 2) Re-uses cached strings, which helps in future set and
343
# (2) is enough that removing encoding entirely along with
344
# the cache (so we are using plain strings) results in no
345
# performance improvement.
347
revision_id = unescape_revid_cache[revision_id]
349
unescaped = unescape(revision_id)
350
unescape_revid_cache[revision_id] = unescaped
351
revision_id = unescaped
353
# Note that unconditionally unescaping means that we deserialise
354
# every fileid, which for general 'pull' is not great, but we don't
355
# really want to have some many fulltexts that this matters anyway.
358
file_id = unescape_fileid_cache[file_id]
360
unescaped = unescape(file_id)
361
unescape_fileid_cache[file_id] = unescaped
364
key = (file_id, revision_id)
365
setdefault(key, False)
366
if revision_id == line_key[-1]:
371
serializer_v8 = Serializer_v8()
added
removed
bzrlib/xml8.py
