~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml8.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
import cStringIO
 
18
import re
17
19
 
18
 
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
 
20
from bzrlib import (
 
21
    cache_utf8,
 
22
    errors,
 
23
    inventory,
 
24
    revision as _mod_revision,
 
25
    )
 
26
from bzrlib.xml_serializer import SubElement, Element, Serializer
19
27
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
20
 
import bzrlib.inventory as inventory
21
 
from bzrlib.revision import Revision        
 
28
from bzrlib.revision import Revision
22
29
from bzrlib.errors import BzrError
23
30
 
24
31
 
25
 
class Serializer_v5(Serializer):
26
 
    """Version 5 serializer
27
 
 
28
 
    Packs objects into XML and vice versa.
29
 
    """
30
 
    
 
32
_utf8_re = None
 
33
_unicode_re = None
 
34
_xml_escape_map = {
 
35
    "&":'&',
 
36
    "'":"'", # FIXME: overkill
 
37
    "\"":""",
 
38
    "<":"&lt;",
 
39
    ">":"&gt;",
 
40
    }
 
41
 
 
42
 
 
43
def _ensure_utf8_re():
 
44
    """Make sure the _utf8_re and _unicode_re regexes have been compiled."""
 
45
    global _utf8_re, _unicode_re
 
46
    if _utf8_re is None:
 
47
        _utf8_re = re.compile('[&<>\'\"]|[\x80-\xff]+')
 
48
    if _unicode_re is None:
 
49
        _unicode_re = re.compile(u'[&<>\'\"\u0080-\uffff]')
 
50
 
 
51
 
 
52
def _unicode_escape_replace(match, _map=_xml_escape_map):
 
53
    """Replace a string of non-ascii, non XML safe characters with their escape
 
54
 
 
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.
 
59
    """
 
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.
 
65
    try:
 
66
        return _map[match.group()]
 
67
    except KeyError:
 
68
        return "&#%d;" % ord(match.group())
 
69
 
 
70
 
 
71
def _utf8_escape_replace(match, _map=_xml_escape_map):
 
72
    """Escape utf8 characters into XML safe ones.
 
73
 
 
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.
 
78
    """
 
79
    try:
 
80
        return _map[match.group()]
 
81
    except KeyError:
 
82
        return ''.join('&#%d;' % ord(uni_chr)
 
83
                       for uni_chr in match.group().decode('utf8'))
 
84
 
 
85
 
 
86
_to_escaped_map = {}
 
87
 
 
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)
 
93
    if text is None:
 
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
 
101
            # either way)
 
102
            text = str(_unicode_re.sub(_unicode_escape_replace,
 
103
                                       unicode_or_utf8_str)) + '"'
 
104
        else:
 
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
 
110
    return text
 
111
 
 
112
 
 
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.
 
117
 
 
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.
 
122
 
 
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.
 
126
    """
 
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)
 
132
    else:
 
133
        return _get_cached_ascii(a_str)
 
134
 
 
135
 
 
136
def _clear_cache():
 
137
    """Clean out the unicode => escaped map"""
 
138
    _to_escaped_map.clear()
 
139
 
 
140
 
 
141
class Serializer_v8(Serializer):
 
142
    """This serialiser adds rich roots.
 
143
 
 
144
    Its revision format number matches its inventory number.
 
145
    """
 
146
 
31
147
    __slots__ = []
32
 
    
33
 
    def _pack_inventory(self, inv):
34
 
        """Convert to XML Element"""
35
 
        e = Element('inventory',
36
 
                    format='5')
37
 
        e.text = '\n'
38
 
        if inv.root.file_id not in (None, ROOT_ID):
39
 
            e.set('file_id', inv.root.file_id)
40
 
        for path, ie in inv.iter_entries():
41
 
            e.append(self._pack_entry(ie))
42
 
        return e
43
 
 
44
 
 
45
 
    def _pack_entry(self, ie):
46
 
        """Convert InventoryEntry to XML element"""
47
 
        if not InventoryEntry.versionable_kind(ie.kind):
48
 
            raise AssertionError('unsupported entry kind %s' % ie.kind)
49
 
        e = Element(ie.kind)
50
 
        e.set('name', ie.name)
51
 
        e.set('file_id', ie.file_id)
52
 
 
53
 
        if ie.text_size != None:
54
 
            e.set('text_size', '%d' % ie.text_size)
55
 
 
56
 
        for f in ['text_sha1', 'revision', 'symlink_target']:
57
 
            v = getattr(ie, f)
58
 
            if v != None:
59
 
                e.set(f, v)
60
 
 
61
 
        if ie.executable:
62
 
            e.set('executable', 'yes')
63
 
 
64
 
        # to be conservative, we don't externalize the root pointers
65
 
        # for now, leaving them as null in the xml form.  in a future
66
 
        # version it will be implied by nested elements.
67
 
        if ie.parent_id != ROOT_ID:
68
 
            assert isinstance(ie.parent_id, basestring)
69
 
            e.set('parent_id', ie.parent_id)
70
 
 
71
 
        e.tail = '\n'
72
 
 
73
 
        return e
74
 
 
 
148
 
 
149
    root_id = None
 
150
    support_altered_by_hack = True
 
151
    # This format supports the altered-by hack that reads file ids directly out
 
152
    # of the versionedfile, without doing XML parsing.
 
153
 
 
154
    supported_kinds = set(['file', 'directory', 'symlink'])
 
155
    format_num = '8'
 
156
    revision_format_num = None
 
157
 
 
158
    def _check_revisions(self, inv):
 
159
        """Extension point for subclasses to check during serialisation.
 
160
 
 
161
        :param inv: An inventory about to be serialised, to be checked.
 
162
        :raises: AssertionError if an error has occured.
 
163
        """
 
164
        if inv.revision_id is None:
 
165
            raise AssertionError()
 
166
        if inv.root.revision is None:
 
167
            raise AssertionError()
 
168
 
 
169
    def write_inventory_to_lines(self, inv):
 
170
        """Return a list of lines with the encoded inventory."""
 
171
        return self.write_inventory(inv, None)
 
172
 
 
173
    def write_inventory_to_string(self, inv, working=False):
 
174
        """Just call write_inventory with a StringIO and return the value.
 
175
 
 
176
        :param working: If True skip history data - text_sha1, text_size,
 
177
            reference_revision, symlink_target.
 
178
        """
 
179
        sio = cStringIO.StringIO()
 
180
        self.write_inventory(inv, sio, working)
 
181
        return sio.getvalue()
 
182
 
 
183
    def write_inventory(self, inv, f, working=False):
 
184
        """Write inventory to a file.
 
185
        
 
186
        :param inv: the inventory to write.
 
187
        :param f: the file to write. (May be None if the lines are the desired
 
188
            output).
 
189
        :param working: If True skip history data - text_sha1, text_size,
 
190
            reference_revision, symlink_target.
 
191
        :return: The inventory as a list of lines.
 
192
        """
 
193
        _ensure_utf8_re()
 
194
        self._check_revisions(inv)
 
195
        output = []
 
196
        append = output.append
 
197
        self._append_inventory_root(append, inv)
 
198
        entries = inv.iter_entries()
 
199
        # Skip the root
 
200
        root_path, root_ie = entries.next()
 
201
        for path, ie in entries:
 
202
            if ie.parent_id != self.root_id:
 
203
                parent_str = ' parent_id="'
 
204
                parent_id  = _encode_and_escape(ie.parent_id)
 
205
            else:
 
206
                parent_str = ''
 
207
                parent_id  = ''
 
208
            if ie.kind == 'file':
 
209
                if ie.executable:
 
210
                    executable = ' executable="yes"'
 
211
                else:
 
212
                    executable = ''
 
213
                if not working:
 
214
                    append('<file%s file_id="%s name="%s%s%s revision="%s '
 
215
                        'text_sha1="%s" text_size="%d" />\n' % (
 
216
                        executable, _encode_and_escape(ie.file_id),
 
217
                        _encode_and_escape(ie.name), parent_str, parent_id,
 
218
                        _encode_and_escape(ie.revision), ie.text_sha1,
 
219
                        ie.text_size))
 
220
                else:
 
221
                    append('<file%s file_id="%s name="%s%s%s />\n' % (
 
222
                        executable, _encode_and_escape(ie.file_id),
 
223
                        _encode_and_escape(ie.name), parent_str, parent_id))
 
224
            elif ie.kind == 'directory':
 
225
                if not working:
 
226
                    append('<directory file_id="%s name="%s%s%s revision="%s '
 
227
                        '/>\n' % (
 
228
                        _encode_and_escape(ie.file_id),
 
229
                        _encode_and_escape(ie.name),
 
230
                        parent_str, parent_id,
 
231
                        _encode_and_escape(ie.revision)))
 
232
                else:
 
233
                    append('<directory file_id="%s name="%s%s%s />\n' % (
 
234
                        _encode_and_escape(ie.file_id),
 
235
                        _encode_and_escape(ie.name),
 
236
                        parent_str, parent_id))
 
237
            elif ie.kind == 'symlink':
 
238
                if not working:
 
239
                    append('<symlink file_id="%s name="%s%s%s revision="%s '
 
240
                        'symlink_target="%s />\n' % (
 
241
                        _encode_and_escape(ie.file_id),
 
242
                        _encode_and_escape(ie.name),
 
243
                        parent_str, parent_id,
 
244
                        _encode_and_escape(ie.revision),
 
245
                        _encode_and_escape(ie.symlink_target)))
 
246
                else:
 
247
                    append('<symlink file_id="%s name="%s%s%s />\n' % (
 
248
                        _encode_and_escape(ie.file_id),
 
249
                        _encode_and_escape(ie.name),
 
250
                        parent_str, parent_id))
 
251
            elif ie.kind == 'tree-reference':
 
252
                if ie.kind not in self.supported_kinds:
 
253
                    raise errors.UnsupportedInventoryKind(ie.kind)
 
254
                if not working:
 
255
                    append('<tree-reference file_id="%s name="%s%s%s '
 
256
                        'revision="%s reference_revision="%s />\n' % (
 
257
                        _encode_and_escape(ie.file_id),
 
258
                        _encode_and_escape(ie.name),
 
259
                        parent_str, parent_id,
 
260
                        _encode_and_escape(ie.revision),
 
261
                        _encode_and_escape(ie.reference_revision)))
 
262
                else:
 
263
                    append('<tree-reference file_id="%s name="%s%s%s />\n' % (
 
264
                        _encode_and_escape(ie.file_id),
 
265
                        _encode_and_escape(ie.name),
 
266
                        parent_str, parent_id))
 
267
            else:
 
268
                raise errors.UnsupportedInventoryKind(ie.kind)
 
269
        append('</inventory>\n')
 
270
        if f is not None:
 
271
            f.writelines(output)
 
272
        # Just to keep the cache from growing without bounds
 
273
        # but we may actually not want to do clear the cache
 
274
        #_clear_cache()
 
275
        return output
 
276
 
 
277
    def _append_inventory_root(self, append, inv):
 
278
        """Append the inventory root to output."""
 
279
        if inv.revision_id is not None:
 
280
            revid1 = ' revision_id="'
 
281
            revid2 = _encode_and_escape(inv.revision_id)
 
282
        else:
 
283
            revid1 = ""
 
284
            revid2 = ""
 
285
        append('<inventory format="%s"%s%s>\n' % (
 
286
            self.format_num, revid1, revid2))
 
287
        append('<directory file_id="%s name="%s revision="%s />\n' % (
 
288
            _encode_and_escape(inv.root.file_id),
 
289
            _encode_and_escape(inv.root.name),
 
290
            _encode_and_escape(inv.root.revision)))
75
291
 
76
292
    def _pack_revision(self, rev):
77
293
        """Revision object -> xml tree"""
 
294
        # For the XML format, we need to write them as Unicode rather than as
 
295
        # utf-8 strings. So that cElementTree can handle properly escaping
 
296
        # them.
 
297
        decode_utf8 = cache_utf8.decode
 
298
        revision_id = rev.revision_id
 
299
        if isinstance(revision_id, str):
 
300
            revision_id = decode_utf8(revision_id)
 
301
        format_num = self.format_num
 
302
        if self.revision_format_num is not None:
 
303
            format_num = self.revision_format_num
78
304
        root = Element('revision',
79
305
                       committer = rev.committer,
80
 
                       timestamp = '%.9f' % rev.timestamp,
81
 
                       revision_id = rev.revision_id,
 
306
                       timestamp = '%.3f' % rev.timestamp,
 
307
                       revision_id = revision_id,
82
308
                       inventory_sha1 = rev.inventory_sha1,
83
 
                       format='5',
 
309
                       format=format_num,
84
310
                       )
85
 
        if rev.timezone:
 
311
        if rev.timezone is not None:
86
312
            root.set('timezone', str(rev.timezone))
87
313
        root.text = '\n'
88
314
        msg = SubElement(root, 'message')
92
318
            pelts = SubElement(root, 'parents')
93
319
            pelts.tail = pelts.text = '\n'
94
320
            for parent_id in rev.parent_ids:
95
 
                assert isinstance(parent_id, basestring)
 
321
                _mod_revision.check_not_reserved_id(parent_id)
96
322
                p = SubElement(pelts, 'revision_ref')
97
323
                p.tail = '\n'
 
324
                if isinstance(parent_id, str):
 
325
                    parent_id = decode_utf8(parent_id)
98
326
                p.set('revision_id', parent_id)
99
327
        if rev.properties:
100
328
            self._pack_revision_properties(rev, root)
101
329
        return root
102
330
 
103
 
 
104
331
    def _pack_revision_properties(self, rev, under_element):
105
332
        top_elt = SubElement(under_element, 'properties')
106
333
        for prop_name, prop_value in sorted(rev.properties.items()):
107
 
            assert isinstance(prop_name, basestring) 
108
 
            assert isinstance(prop_value, basestring) 
109
334
            prop_elt = SubElement(top_elt, 'property')
110
335
            prop_elt.set('name', prop_name)
111
336
            prop_elt.text = prop_value
112
337
            prop_elt.tail = '\n'
113
338
        top_elt.tail = '\n'
114
339
 
115
 
 
116
 
    def _unpack_inventory(self, elt):
117
 
        """Construct from XML Element
118
 
        """
119
 
        assert elt.tag == 'inventory'
120
 
        root_id = elt.get('file_id') or ROOT_ID
 
340
    def _unpack_inventory(self, elt, revision_id=None):
 
341
        """Construct from XML Element"""
 
342
        if elt.tag != 'inventory':
 
343
            raise errors.UnexpectedInventoryFormat('Root tag is %r' % elt.tag)
121
344
        format = elt.get('format')
122
 
        if format is not None:
123
 
            if format != '5':
124
 
                raise BzrError("invalid format version %r on inventory"
125
 
                                % format)
126
 
        inv = Inventory(root_id)
 
345
        if format != self.format_num:
 
346
            raise errors.UnexpectedInventoryFormat('Invalid format version %r'
 
347
                                                   % format)
 
348
        revision_id = elt.get('revision_id')
 
349
        if revision_id is not None:
 
350
            revision_id = cache_utf8.encode(revision_id)
 
351
        inv = inventory.Inventory(root_id=None, revision_id=revision_id)
127
352
        for e in elt:
128
353
            ie = self._unpack_entry(e)
129
 
            if ie.parent_id == ROOT_ID:
130
 
                ie.parent_id = root_id
131
354
            inv.add(ie)
132
355
        return inv
133
356
 
134
 
 
135
357
    def _unpack_entry(self, elt):
136
358
        kind = elt.tag
137
359
        if not InventoryEntry.versionable_kind(kind):
138
360
            raise AssertionError('unsupported entry kind %s' % kind)
139
361
 
 
362
        get_cached = _get_utf8_or_ascii
 
363
 
140
364
        parent_id = elt.get('parent_id')
141
 
        if parent_id == None:
142
 
            parent_id = ROOT_ID
 
365
        if parent_id is not None:
 
366
            parent_id = get_cached(parent_id)
 
367
        file_id = get_cached(elt.get('file_id'))
143
368
 
144
369
        if kind == 'directory':
145
 
            ie = inventory.InventoryDirectory(elt.get('file_id'),
 
370
            ie = inventory.InventoryDirectory(file_id,
146
371
                                              elt.get('name'),
147
372
                                              parent_id)
148
373
        elif kind == 'file':
149
 
            ie = inventory.InventoryFile(elt.get('file_id'),
 
374
            ie = inventory.InventoryFile(file_id,
150
375
                                         elt.get('name'),
151
376
                                         parent_id)
152
377
            ie.text_sha1 = elt.get('text_sha1')
155
380
            v = elt.get('text_size')
156
381
            ie.text_size = v and int(v)
157
382
        elif kind == 'symlink':
158
 
            ie = inventory.InventoryLink(elt.get('file_id'),
 
383
            ie = inventory.InventoryLink(file_id,
159
384
                                         elt.get('name'),
160
385
                                         parent_id)
161
386
            ie.symlink_target = elt.get('symlink_target')
162
387
        else:
163
 
            raise BzrError("unknown kind %r" % kind)
164
 
        ie.revision = elt.get('revision')
 
388
            raise errors.UnsupportedInventoryKind(kind)
 
389
        revision = elt.get('revision')
 
390
        if revision is not None:
 
391
            revision = get_cached(revision)
 
392
        ie.revision = revision
165
393
 
166
394
        return ie
167
395
 
168
 
 
169
396
    def _unpack_revision(self, elt):
170
397
        """XML Element -> Revision object"""
171
 
        assert elt.tag == 'revision'
172
398
        format = elt.get('format')
 
399
        format_num = self.format_num
 
400
        if self.revision_format_num is not None:
 
401
            format_num = self.revision_format_num
173
402
        if format is not None:
174
 
            if format != '5':
175
 
                raise BzrError("invalid format version %r on inventory"
 
403
            if format != format_num:
 
404
                raise BzrError("invalid format version %r on revision"
176
405
                                % format)
 
406
        get_cached = _get_utf8_or_ascii
177
407
        rev = Revision(committer = elt.get('committer'),
178
408
                       timestamp = float(elt.get('timestamp')),
179
 
                       revision_id = elt.get('revision_id'),
 
409
                       revision_id = get_cached(elt.get('revision_id')),
180
410
                       inventory_sha1 = elt.get('inventory_sha1')
181
411
                       )
182
412
        parents = elt.find('parents') or []
183
413
        for p in parents:
184
 
            assert p.tag == 'revision_ref', \
185
 
                   "bad parent node tag %r" % p.tag
186
 
            rev.parent_ids.append(p.get('revision_id'))
 
414
            rev.parent_ids.append(get_cached(p.get('revision_id')))
187
415
        self._unpack_revision_properties(elt, rev)
188
416
        v = elt.get('timezone')
189
 
        rev.timezone = v and int(v)
 
417
        if v is None:
 
418
            rev.timezone = 0
 
419
        else:
 
420
            rev.timezone = int(v)
190
421
        rev.message = elt.findtext('message') # text of <message>
191
422
        return rev
192
423
 
193
 
 
194
424
    def _unpack_revision_properties(self, elt, rev):
195
425
        """Unpack properties onto a revision."""
196
426
        props_elt = elt.find('properties')
197
 
        assert len(rev.properties) == 0
198
427
        if not props_elt:
199
428
            return
200
429
        for prop_elt in props_elt:
201
 
            assert prop_elt.tag == 'property', \
202
 
                "bad tag under properties list: %r" % p.tag
 
430
            if prop_elt.tag != 'property':
 
431
                raise AssertionError(
 
432
                    "bad tag under properties list: %r" % prop_elt.tag)
203
433
            name = prop_elt.get('name')
204
434
            value = prop_elt.text
205
 
            assert name not in rev.properties, \
206
 
                "repeated property %r" % p.name
 
435
            # If a property had an empty value ('') cElementTree reads
 
436
            # that back as None, convert it back to '', so that all
 
437
            # properties have string values
 
438
            if value is None:
 
439
                value = ''
 
440
            if name in rev.properties:
 
441
                raise AssertionError("repeated property %r" % name)
207
442
            rev.properties[name] = value
208
443
 
209
444
 
210
 
serializer_v5 = Serializer_v5()
 
445
serializer_v8 = Serializer_v8()