← 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-06-30 21:38:52 UTC
  • mto: (1711.4.39 win32-accepted)
  • mto: This revision was merged to the branch mainline in revision 1836.
  • Revision ID: john@arbash-meinel.com-20060630213852-8a2dd85d080541a1
check_text_file was leaving the file handle open, now it closes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# -*- coding: UTF-8 -*-
 
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
 
# 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
 
 
53
 
from bzrlib import errors
54
 
 
55
 
 
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
 
        """
81
 
        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:
86
 
            raise errors.UnexpectedInventoryFormat(e)
87
 
 
88
 
    def read_inventory(self, f, revision_id=None):
89
 
        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:
96
 
            raise errors.UnexpectedInventoryFormat(e)
 
38
 
 
39
from bzrlib.errors import BzrError
 
40
 
 
41
 
 
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):
 
53
        return self._unpack_inventory(fromstring(xml_string))
 
54
 
 
55
    def read_inventory(self, f):
 
56
        return self._unpack_inventory(self._read_element(f))
97
57
 
98
58
    def write_revision(self, rev, f):
99
59
        self._write_element(self._pack_revision(rev), f)
115
75
        return ElementTree().parse(f)
116
76
 
117
77
 
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)
 
78
# performance tuning for elementree's serialiser. This should be
 
79
# sent upstream - RBC 20060523.
 
80
# the functions here are patched into elementtree at runtime.
 
81
import re
 
82
escape_re = re.compile("[&'\"<>]")
 
83
escape_map = {
 
84
    "&":'&amp;',
 
85
    "'":"&apos;", # FIXME: overkill
 
86
    "\"":"&quot;",
 
87
    "<":"&lt;",
 
88
    ">":"&gt;",
 
89
    }
 
90
def _escape_replace(match, map=escape_map):
 
91
    return map[match.group()]
 
92
 
 
93
def _escape_attrib(text, encoding=None, replace=None):
 
94
    # escape attribute value
 
95
    try:
 
96
        if encoding:
 
97
            try:
 
98
                text = elementtree.ElementTree._encode(text, encoding)
 
99
            except UnicodeError:
 
100
                return elementtree.ElementTree._encode_entity(text)
 
101
        if replace is None:
 
102
            return escape_re.sub(_escape_replace, text)
 
103
        else:
 
104
            text = replace(text, "&", "&amp;")
 
105
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
106
            text = replace(text, "\"", "&quot;")
 
107
            text = replace(text, "<", "&lt;")
 
108
            text = replace(text, ">", "&gt;")
 
109
            return text
 
110
    except (TypeError, AttributeError):
 
111
        elementtree.ElementTree._raise_serialization_error(text)
 
112
 
 
113
elementtree.ElementTree._escape_attrib = _escape_attrib
 
114
 
 
115
escape_cdata_re = re.compile("[&<>]")
 
116
escape_cdata_map = {
 
117
    "&":'&amp;',
 
118
    "<":"&lt;",
 
119
    ">":"&gt;",
 
120
    }
 
121
def _escape_cdata_replace(match, map=escape_cdata_map):
 
122
    return map[match.group()]
 
123
 
 
124
def _escape_cdata(text, encoding=None, replace=None):
 
125
    # escape character data
 
126
    try:
 
127
        if encoding:
 
128
            try:
 
129
                text = elementtree.ElementTree._encode(text, encoding)
 
130
            except UnicodeError:
 
131
                return elementtree.ElementTree._encode_entity(text)
 
132
        if replace is None:
 
133
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
134
        else:
 
135
            text = replace(text, "&", "&amp;")
 
136
            text = replace(text, "<", "&lt;")
 
137
            text = replace(text, ">", "&gt;")
 
138
            return text
 
139
    except (TypeError, AttributeError):
 
140
        elementtree.ElementTree._raise_serialization_error(text)
 
141
 
 
142
elementtree.ElementTree._escape_cdata = _escape_cdata