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
20
19
from bzrlib import (
25
from bzrlib.xml_serializer import SubElement, Element, Serializer
26
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
22
revision as _mod_revision,
25
from bzrlib.xml_serializer import (
32
serialize_inventory_flat,
33
unpack_inventory_entry,
34
unpack_inventory_flat,
27
36
from bzrlib.revision import Revision
28
37
from bzrlib.errors import BzrError
35
"'":"'", # FIXME: overkill
42
def _ensure_utf8_re():
43
"""Make sure the _utf8_re and _unicode_re regexes have been compiled."""
44
global _utf8_re, _unicode_re
46
_utf8_re = re.compile('[&<>\'\"]|[\x80-\xff]+')
47
if _unicode_re is None:
48
_unicode_re = re.compile(u'[&<>\'\"\u0080-\uffff]')
51
def _unicode_escape_replace(match, _map=_xml_escape_map):
52
"""Replace a string of non-ascii, non XML safe characters with their escape
54
This will escape both Standard XML escapes, like <>"', etc.
55
As well as escaping non ascii characters, because ElementTree did.
56
This helps us remain compatible to older versions of bzr. We may change
57
our policy in the future, though.
59
# jam 20060816 Benchmarks show that try/KeyError is faster if you
60
# expect the entity to rarely miss. There is about a 10% difference
61
# in overall time. But if you miss frequently, then if None is much
62
# faster. For our use case, we *rarely* have a revision id, file id
63
# or path name that is unicode. So use try/KeyError.
65
return _map[match.group()]
67
return "&#%d;" % ord(match.group())
70
def _utf8_escape_replace(match, _map=_xml_escape_map):
71
"""Escape utf8 characters into XML safe ones.
73
This uses 2 tricks. It is either escaping "standard" characters, like "&<>,
74
or it is handling characters with the high-bit set. For ascii characters,
75
we just lookup the replacement in the dictionary. For everything else, we
76
decode back into Unicode, and then use the XML escape code.
79
return _map[match.group()]
81
return ''.join('&#%d;' % ord(uni_chr)
82
for uni_chr in match.group().decode('utf8'))
87
def _encode_and_escape(unicode_or_utf8_str, _map=_to_escaped_map):
88
"""Encode the string into utf8, and escape invalid XML characters"""
89
# We frequently get entities we have not seen before, so it is better
90
# to check if None, rather than try/KeyError
91
text = _map.get(unicode_or_utf8_str)
93
if unicode_or_utf8_str.__class__ == unicode:
94
# The alternative policy is to do a regular UTF8 encoding
95
# and then escape only XML meta characters.
96
# Performance is equivalent once you use cache_utf8. *However*
97
# this makes the serialized texts incompatible with old versions
98
# of bzr. So no net gain. (Perhaps the read code would handle utf8
99
# better than entity escapes, but cElementTree seems to do just fine
101
text = str(_unicode_re.sub(_unicode_escape_replace,
102
unicode_or_utf8_str)) + '"'
104
# Plain strings are considered to already be in utf-8 so we do a
105
# slightly different method for escaping.
106
text = _utf8_re.sub(_utf8_escape_replace,
107
unicode_or_utf8_str) + '"'
108
_map[unicode_or_utf8_str] = text
112
def _get_utf8_or_ascii(a_str,
113
_encode_utf8=cache_utf8.encode,
114
_get_cached_ascii=cache_utf8.get_cached_ascii):
115
"""Return a cached version of the string.
117
cElementTree will return a plain string if the XML is plain ascii. It only
118
returns Unicode when it needs to. We want to work in utf-8 strings. So if
119
cElementTree returns a plain string, we can just return the cached version.
120
If it is Unicode, then we need to encode it.
122
:param a_str: An 8-bit string or Unicode as returned by
123
cElementTree.Element.get()
124
:return: A utf-8 encoded 8-bit string.
126
# This is fairly optimized because we know what cElementTree does, this is
127
# not meant as a generic function for all cases. Because it is possible for
128
# an 8-bit string to not be ascii or valid utf8.
129
if a_str.__class__ == unicode:
130
return _encode_utf8(a_str)
132
return _get_cached_ascii(a_str)
136
"""Clean out the unicode => escaped map"""
137
_to_escaped_map.clear()
140
class Serializer_v5(Serializer):
141
"""Version 5 serializer
143
Packs objects into XML and vice versa.
49
def _unescaper(match, _map=_xml_unescape_map):
54
if not code.startswith('#'):
56
return unichr(int(code[1:])).encode('utf8')
59
_unescape_re = lazy_regex.lazy_compile('\&([^;]*);')
61
def _unescape_xml(data):
62
"""Unescape predefined XML entities in a string of data."""
63
return _unescape_re.sub(_unescaper, data)
66
class Serializer_v8(XMLSerializer):
67
"""This serialiser adds rich roots.
69
Its revision format number matches its inventory number.
148
75
support_altered_by_hack = True
149
76
# This format supports the altered-by hack that reads file ids directly out
150
77
# of the versionedfile, without doing XML parsing.
152
79
supported_kinds = set(['file', 'directory', 'symlink'])
154
def write_inventory_to_string(self, inv):
155
"""Just call write_inventory with a StringIO and return the value"""
81
revision_format_num = None
83
# The search regex used by xml based repositories to determine what things
84
# where changed in a single commit.
85
_file_ids_altered_regex = lazy_regex.lazy_compile(
86
r'file_id="(?P<file_id>[^"]+)"'
87
r'.* revision="(?P<revision_id>[^"]+)"'
90
def _check_revisions(self, inv):
91
"""Extension point for subclasses to check during serialisation.
93
:param inv: An inventory about to be serialised, to be checked.
94
:raises: AssertionError if an error has occurred.
96
if inv.revision_id is None:
97
raise AssertionError("inv.revision_id is None")
98
if inv.root.revision is None:
99
raise AssertionError("inv.root.revision is None")
101
def _check_cache_size(self, inv_size, entry_cache):
102
"""Check that the entry_cache is large enough.
104
We want the cache to be ~2x the size of an inventory. The reason is
105
because we use a FIFO cache, and how Inventory records are likely to
106
change. In general, you have a small number of records which change
107
often, and a lot of records which do not change at all. So when the
108
cache gets full, you actually flush out a lot of the records you are
109
interested in, which means you need to recreate all of those records.
110
An LRU Cache would be better, but the overhead negates the cache
113
One way to look at it, only the size of the cache > len(inv) is your
114
'working' set. And in general, it shouldn't be a problem to hold 2
115
inventories in memory anyway.
117
:param inv_size: The number of entries in an inventory.
119
if entry_cache is None:
121
# 1.5 times might also be reasonable.
122
recommended_min_cache_size = inv_size * 1.5
123
if entry_cache.cache_size() < recommended_min_cache_size:
124
recommended_cache_size = inv_size * 2
125
trace.mutter('Resizing the inventory entry cache from %d to %d',
126
entry_cache.cache_size(), recommended_cache_size)
127
entry_cache.resize(recommended_cache_size)
129
def write_inventory_to_lines(self, inv):
130
"""Return a list of lines with the encoded inventory."""
131
return self.write_inventory(inv, None)
133
def write_inventory_to_string(self, inv, working=False):
134
"""Just call write_inventory with a StringIO and return the value.
136
:param working: If True skip history data - text_sha1, text_size,
137
reference_revision, symlink_target.
156
139
sio = cStringIO.StringIO()
157
self.write_inventory(inv, sio)
140
self.write_inventory(inv, sio, working)
158
141
return sio.getvalue()
160
def write_inventory(self, inv, f):
143
def write_inventory(self, inv, f, working=False):
161
144
"""Write inventory to a file.
163
146
:param inv: the inventory to write.
164
:param f: the file to write.
147
:param f: the file to write. (May be None if the lines are the desired
149
:param working: If True skip history data - text_sha1, text_size,
150
reference_revision, symlink_target.
151
:return: The inventory as a list of lines.
168
154
append = output.append
169
155
self._append_inventory_root(append, inv)
170
entries = inv.iter_entries()
172
root_path, root_ie = entries.next()
173
for path, ie in entries:
174
self._append_entry(append, ie)
175
append('</inventory>\n')
156
serialize_inventory_flat(inv, append,
157
self.root_id, self.supported_kinds, working)
177
160
# Just to keep the cache from growing without bounds
178
161
# but we may actually not want to do clear the cache
181
165
def _append_inventory_root(self, append, inv):
182
166
"""Append the inventory root to output."""
184
if inv.root.file_id not in (None, ROOT_ID):
186
append(_encode_and_escape(inv.root.file_id))
187
append(' format="5"')
188
167
if inv.revision_id is not None:
189
append(' revision_id="')
190
append(_encode_and_escape(inv.revision_id))
193
def _append_entry(self, append, ie):
194
"""Convert InventoryEntry to XML element and append to output."""
195
# TODO: should just be a plain assertion
196
if ie.kind not in self.supported_kinds:
197
raise errors.UnsupportedInventoryKind(ie.kind)
202
append(' executable="yes"')
204
append(_encode_and_escape(ie.file_id))
206
append(_encode_and_escape(ie.name))
207
if self._parent_condition(ie):
208
assert isinstance(ie.parent_id, basestring)
209
append(' parent_id="')
210
append(_encode_and_escape(ie.parent_id))
211
if ie.revision is not None:
212
append(' revision="')
213
append(_encode_and_escape(ie.revision))
214
if ie.symlink_target is not None:
215
append(' symlink_target="')
216
append(_encode_and_escape(ie.symlink_target))
217
if ie.text_sha1 is not None:
218
append(' text_sha1="')
221
if ie.text_size is not None:
222
append(' text_size="%d"' % ie.text_size)
223
if getattr(ie, 'reference_revision', None) is not None:
224
append(' reference_revision="')
225
append(_encode_and_escape(ie.reference_revision))
229
def _parent_condition(self, ie):
230
return ie.parent_id != ROOT_ID
168
revid1 = ' revision_id="'
169
revid2 = encode_and_escape(inv.revision_id)
173
append('<inventory format="%s"%s%s>\n' % (
174
self.format_num, revid1, revid2))
175
append('<directory file_id="%s name="%s revision="%s />\n' % (
176
encode_and_escape(inv.root.file_id),
177
encode_and_escape(inv.root.name),
178
encode_and_escape(inv.root.revision)))
232
180
def _pack_revision(self, rev):
233
181
"""Revision object -> xml tree"""
268
219
def _pack_revision_properties(self, rev, under_element):
269
220
top_elt = SubElement(under_element, 'properties')
270
221
for prop_name, prop_value in sorted(rev.properties.items()):
271
assert isinstance(prop_name, basestring)
272
assert isinstance(prop_value, basestring)
273
222
prop_elt = SubElement(top_elt, 'property')
274
223
prop_elt.set('name', prop_name)
275
224
prop_elt.text = prop_value
276
225
prop_elt.tail = '\n'
277
226
top_elt.tail = '\n'
279
def _unpack_inventory(self, elt):
280
"""Construct from XML Element
282
assert elt.tag == 'inventory'
283
root_id = elt.get('file_id') or ROOT_ID
284
root_id = _get_utf8_or_ascii(root_id)
228
def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
229
# This is here because it's overridden by xml7
230
return unpack_inventory_entry(elt, entry_cache,
286
format = elt.get('format')
287
if format is not None:
289
raise BzrError("invalid format version %r on inventory"
291
revision_id = elt.get('revision_id')
292
if revision_id is not None:
293
revision_id = cache_utf8.encode(revision_id)
294
inv = Inventory(root_id, revision_id=revision_id)
296
ie = self._unpack_entry(e)
297
if ie.parent_id is None:
298
ie.parent_id = root_id
233
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
234
return_from_cache=False):
235
"""Construct from XML Element"""
236
inv = unpack_inventory_flat(elt, self.format_num, self._unpack_entry,
237
entry_cache, return_from_cache)
238
self._check_cache_size(len(inv), entry_cache)
302
def _unpack_entry(self, elt):
304
if not InventoryEntry.versionable_kind(kind):
305
raise AssertionError('unsupported entry kind %s' % kind)
307
get_cached = _get_utf8_or_ascii
309
parent_id = elt.get('parent_id')
310
if parent_id is not None:
311
parent_id = get_cached(parent_id)
312
file_id = get_cached(elt.get('file_id'))
314
if kind == 'directory':
315
ie = inventory.InventoryDirectory(file_id,
319
ie = inventory.InventoryFile(file_id,
322
ie.text_sha1 = elt.get('text_sha1')
323
if elt.get('executable') == 'yes':
325
v = elt.get('text_size')
326
ie.text_size = v and int(v)
327
elif kind == 'symlink':
328
ie = inventory.InventoryLink(file_id,
331
ie.symlink_target = elt.get('symlink_target')
333
raise errors.UnsupportedInventoryKind(kind)
334
revision = elt.get('revision')
335
if revision is not None:
336
revision = get_cached(revision)
337
ie.revision = revision
341
241
def _unpack_revision(self, elt):
342
242
"""XML Element -> Revision object"""
343
assert elt.tag == 'revision'
344
243
format = elt.get('format')
244
format_num = self.format_num
245
if self.revision_format_num is not None:
246
format_num = self.revision_format_num
345
247
if format is not None:
347
raise BzrError("invalid format version %r on inventory"
248
if format != format_num:
249
raise BzrError("invalid format version %r on revision"
349
get_cached = _get_utf8_or_ascii
251
get_cached = get_utf8_or_ascii
350
252
rev = Revision(committer = elt.get('committer'),
351
253
timestamp = float(elt.get('timestamp')),
352
254
revision_id = get_cached(elt.get('revision_id')),
382
282
# properties have string values
383
283
if value is None:
385
assert name not in rev.properties, \
386
"repeated property %r" % name
285
if name in rev.properties:
286
raise AssertionError("repeated property %r" % name)
387
287
rev.properties[name] = value
390
serializer_v5 = Serializer_v5()
289
def _find_text_key_references(self, line_iterator):
290
"""Core routine for extracting references to texts from inventories.
292
This performs the translation of xml lines to revision ids.
294
:param line_iterator: An iterator of lines, origin_version_id
295
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
296
to whether they were referred to by the inventory of the
297
revision_id that they contain. Note that if that revision_id was
298
not part of the line_iterator's output then False will be given -
299
even though it may actually refer to that key.
301
if not self.support_altered_by_hack:
302
raise AssertionError(
303
"_find_text_key_references only "
304
"supported for branches which store inventory as unnested xml"
305
", not on %r" % self)
308
# this code needs to read every new line in every inventory for the
309
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
310
# not present in one of those inventories is unnecessary but not
311
# harmful because we are filtering by the revision id marker in the
312
# inventory lines : we only select file ids altered in one of those
313
# revisions. We don't need to see all lines in the inventory because
314
# only those added in an inventory in rev X can contain a revision=X
316
unescape_revid_cache = {}
317
unescape_fileid_cache = {}
319
# jam 20061218 In a big fetch, this handles hundreds of thousands
320
# of lines, so it has had a lot of inlining and optimizing done.
321
# Sorry that it is a little bit messy.
322
# Move several functions to be local variables, since this is a long
324
search = self._file_ids_altered_regex.search
325
unescape = _unescape_xml
326
setdefault = result.setdefault
327
for line, line_key in line_iterator:
331
# One call to match.group() returning multiple items is quite a
332
# bit faster than 2 calls to match.group() each returning 1
333
file_id, revision_id = match.group('file_id', 'revision_id')
335
# Inlining the cache lookups helps a lot when you make 170,000
336
# lines and 350k ids, versus 8.4 unique ids.
337
# Using a cache helps in 2 ways:
338
# 1) Avoids unnecessary decoding calls
339
# 2) Re-uses cached strings, which helps in future set and
341
# (2) is enough that removing encoding entirely along with
342
# the cache (so we are using plain strings) results in no
343
# performance improvement.
345
revision_id = unescape_revid_cache[revision_id]
347
unescaped = unescape(revision_id)
348
unescape_revid_cache[revision_id] = unescaped
349
revision_id = unescaped
351
# Note that unconditionally unescaping means that we deserialise
352
# every fileid, which for general 'pull' is not great, but we don't
353
# really want to have some many fulltexts that this matters anyway.
356
file_id = unescape_fileid_cache[file_id]
358
unescaped = unescape(file_id)
359
unescape_fileid_cache[file_id] = unescaped
362
key = (file_id, revision_id)
363
setdefault(key, False)
364
if revision_id == line_key[-1]:
369
serializer_v8 = Serializer_v8()
added
removed
bzrlib/xml8.py
