← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml_serializer.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# -*- coding: UTF-8 -*-
2
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
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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""XML externalization support."""
18
18
 
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
25
 
import re
26
 
 
27
 
from bzrlib.serializer import Serializer
28
 
from bzrlib.trace import mutter
 
25
from bzrlib.trace import mutter, warning
29
26
 
30
27
try:
31
 
    try:
32
 
        # it's in this package in python2.5
33
 
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
34
 
            XMLTreeBuilder, fromstring, tostring)
35
 
        import xml.etree as elementtree
36
 
        # Also import ElementTree module so monkey-patching below always works
37
 
        import xml.etree.ElementTree
38
 
    except ImportError:
39
 
        from cElementTree import (ElementTree, SubElement, Element,
40
 
                                  XMLTreeBuilder, fromstring, tostring)
41
 
        import elementtree.ElementTree
42
 
    ParseError = SyntaxError
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
 
30
    import elementtree
43
31
except ImportError:
44
32
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
45
33
           " and make sure it's on your PYTHONPATH")
46
 
    # this copy is shipped with bzr
47
34
    from util.elementtree.ElementTree import (ElementTree, SubElement,
48
35
                                              Element, XMLTreeBuilder,
49
36
                                              fromstring, tostring)
50
37
    import util.elementtree as elementtree
51
 
    from xml.parsers.expat import ExpatError as ParseError
52
38
 
53
39
from bzrlib import errors
54
40
 
55
41
 
56
 
class XMLSerializer(Serializer):
57
 
    """Abstract XML object serialize/deserialize"""
58
 
 
59
 
    squashes_xml_invalid_characters = True
60
 
 
61
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
62
 
                                   entry_cache=None, return_from_cache=False):
63
 
        """Read xml_string into an inventory object.
64
 
 
65
 
        :param xml_string: The xml to read.
66
 
        :param revision_id: If not-None, the expected revision id of the
67
 
            inventory. Some serialisers use this to set the results' root
68
 
            revision. This should be supplied for deserialising all
69
 
            from-repository inventories so that xml5 inventories that were
70
 
            serialised without a revision identifier can be given the right
71
 
            revision id (but not for working tree inventories where users can
72
 
            edit the data without triggering checksum errors or anything).
73
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
74
 
            supplied we will look up entries via (file_id, revision_id) which
75
 
            should map to a valid InventoryEntry (File/Directory/etc) object.
76
 
        :param return_from_cache: Return entries directly from the cache,
77
 
            rather than copying them first. This is only safe if the caller
78
 
            promises not to mutate the returned inventory entries, but it can
79
 
            make some operations significantly faster.
80
 
        """
 
42
class Serializer(object):
 
43
    """Abstract object serialize/deserialize"""
 
44
    def write_inventory(self, inv, f):
 
45
        """Write inventory to a file"""
 
46
        elt = self._pack_inventory(inv)
 
47
        self._write_element(elt, f)
 
48
 
 
49
    def write_inventory_to_string(self, inv):
 
50
        return tostring(self._pack_inventory(inv)) + '\n'
 
51
 
 
52
    def read_inventory_from_string(self, xml_string):
81
53
        try:
82
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
83
 
                                          entry_cache=entry_cache,
84
 
                                          return_from_cache=return_from_cache)
85
 
        except ParseError, e:
 
54
            return self._unpack_inventory(fromstring(xml_string))
 
55
        except SyntaxError, e:
86
56
            raise errors.UnexpectedInventoryFormat(e)
87
57
 
88
 
    def read_inventory(self, f, revision_id=None):
 
58
    def read_inventory(self, f):
89
59
        try:
90
 
            try:
91
 
                return self._unpack_inventory(self._read_element(f),
92
 
                    revision_id=None)
93
 
            finally:
94
 
                f.close()
95
 
        except ParseError, e:
 
60
            return self._unpack_inventory(self._read_element(f))
 
61
        except SyntaxError, e:
96
62
            raise errors.UnexpectedInventoryFormat(e)
97
63
 
98
64
    def write_revision(self, rev, f):
115
81
        return ElementTree().parse(f)
116
82
 
117
83
 
118
 
def escape_invalid_chars(message):
119
 
    """Escape the XML-invalid characters in a commit message.
120
 
 
121
 
    :param message: Commit message to escape
122
 
    :return: tuple with escaped message and number of characters escaped
123
 
    """
124
 
    if message is None:
125
 
        return None, 0
126
 
    # Python strings can include characters that can't be
127
 
    # represented in well-formed XML; escape characters that
128
 
    # aren't listed in the XML specification
129
 
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
130
 
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
131
 
            lambda match: match.group(0).encode('unicode_escape'),
132
 
            message)
 
84
# performance tuning for elementree's serialiser. This should be
 
85
# sent upstream - RBC 20060523.
 
86
# the functions here are patched into elementtree at runtime.
 
87
import re
 
88
escape_re = re.compile("[&'\"<>]")
 
89
escape_map = {
 
90
    "&":'&amp;',
 
91
    "'":"&apos;", # FIXME: overkill
 
92
    "\"":"&quot;",
 
93
    "<":"&lt;",
 
94
    ">":"&gt;",
 
95
    }
 
96
def _escape_replace(match, map=escape_map):
 
97
    return map[match.group()]
 
98
 
 
99
def _escape_attrib(text, encoding=None, replace=None):
 
100
    # escape attribute value
 
101
    try:
 
102
        if encoding:
 
103
            try:
 
104
                text = elementtree.ElementTree._encode(text, encoding)
 
105
            except UnicodeError:
 
106
                return elementtree.ElementTree._encode_entity(text)
 
107
        if replace is None:
 
108
            return escape_re.sub(_escape_replace, text)
 
109
        else:
 
110
            text = replace(text, "&", "&amp;")
 
111
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
112
            text = replace(text, "\"", "&quot;")
 
113
            text = replace(text, "<", "&lt;")
 
114
            text = replace(text, ">", "&gt;")
 
115
            return text
 
116
    except (TypeError, AttributeError):
 
117
        elementtree.ElementTree._raise_serialization_error(text)
 
118
 
 
119
elementtree.ElementTree._escape_attrib = _escape_attrib
 
120
 
 
121
escape_cdata_re = re.compile("[&<>]")
 
122
escape_cdata_map = {
 
123
    "&":'&amp;',
 
124
    "<":"&lt;",
 
125
    ">":"&gt;",
 
126
    }
 
127
def _escape_cdata_replace(match, map=escape_cdata_map):
 
128
    return map[match.group()]
 
129
 
 
130
def _escape_cdata(text, encoding=None, replace=None):
 
131
    # escape character data
 
132
    try:
 
133
        if encoding:
 
134
            try:
 
135
                text = elementtree.ElementTree._encode(text, encoding)
 
136
            except UnicodeError:
 
137
                return elementtree.ElementTree._encode_entity(text)
 
138
        if replace is None:
 
139
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
140
        else:
 
141
            text = replace(text, "&", "&amp;")
 
142
            text = replace(text, "<", "&lt;")
 
143
            text = replace(text, ">", "&gt;")
 
144
            return text
 
145
    except (TypeError, AttributeError):
 
146
        elementtree.ElementTree._raise_serialization_error(text)
 
147
 
 
148
elementtree.ElementTree._escape_cdata = _escape_cdata