← 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-10 14:53:51 UTC
  • mto: (1711.7.2 win32)
  • mto: This revision was merged to the branch mainline in revision 1796.
  • Revision ID: john@arbash-meinel.com-20060610145351-9da0c1f8ba8a57e0
the _posix_* routines should use posixpath not os.path, so tests pass on win32

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)
43
30
except ImportError:
44
31
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
45
32
           " and make sure it's on your PYTHONPATH")
46
 
    # this copy is shipped with bzr
47
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
48
34
                                              Element, XMLTreeBuilder,
49
35
                                              fromstring, tostring)
50
 
    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)
 
36
 
 
37
from bzrlib.errors import BzrError
 
38
 
 
39
 
 
40
class Serializer(object):
 
41
    """Abstract object serialize/deserialize"""
 
42
    def write_inventory(self, inv, f):
 
43
        """Write inventory to a file"""
 
44
        elt = self._pack_inventory(inv)
 
45
        self._write_element(elt, f)
 
46
 
 
47
    def write_inventory_to_string(self, inv):
 
48
        return tostring(self._pack_inventory(inv)) + '\n'
 
49
 
 
50
    def read_inventory_from_string(self, xml_string):
 
51
        return self._unpack_inventory(fromstring(xml_string))
 
52
 
 
53
    def read_inventory(self, f):
 
54
        return self._unpack_inventory(self._read_element(f))
97
55
 
98
56
    def write_revision(self, rev, f):
99
57
        self._write_element(self._pack_revision(rev), f)
115
73
        return ElementTree().parse(f)
116
74
 
117
75
 
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)
 
76
# performance tuning for elementree's serialiser. THis should be
 
77
# sent upstream - RBC 20060523.
 
78
# the functions here are patched into elementree at runtime.
 
79
import elementtree.ElementTree
 
80
import re
 
81
escape_re = re.compile("[&'\"<>]")
 
82
escape_map = {
 
83
    "&":'&amp;',
 
84
    "'":"&apos;", # FIXME: overkill
 
85
    "\"":"&quot;",
 
86
    "<":"&lt;",
 
87
    ">":"&gt;",
 
88
    }
 
89
def _escape_replace(match, map=escape_map):
 
90
    return map[match.group()]
 
91
 
 
92
def _escape_attrib(text, encoding=None, replace=None):
 
93
    # escape attribute value
 
94
    try:
 
95
        if encoding:
 
96
            try:
 
97
                text = elementtree.ElementTree._encode(text, encoding)
 
98
            except UnicodeError:
 
99
                return elementtree.ElementTree._encode_entity(text)
 
100
        if replace is None:
 
101
            return escape_re.sub(_escape_replace, text)
 
102
        else:
 
103
            text = replace(text, "&", "&amp;")
 
104
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
105
            text = replace(text, "\"", "&quot;")
 
106
            text = replace(text, "<", "&lt;")
 
107
            text = replace(text, ">", "&gt;")
 
108
            return text
 
109
    except (TypeError, AttributeError):
 
110
        elementtree.ElementTree._raise_serialization_error(text)
 
111
 
 
112
elementtree.ElementTree._escape_attrib = _escape_attrib
 
113
 
 
114
escape_cdata_re = re.compile("[&<>]")
 
115
escape_cdata_map = {
 
116
    "&":'&amp;',
 
117
    "<":"&lt;",
 
118
    ">":"&gt;",
 
119
    }
 
120
def _escape_cdata_replace(match, map=escape_cdata_map):
 
121
    return map[match.group()]
 
122
 
 
123
def _escape_cdata(text, encoding=None, replace=None):
 
124
    # escape character data
 
125
    try:
 
126
        if encoding:
 
127
            try:
 
128
                text = elementtree.ElementTree._encode(text, encoding)
 
129
            except UnicodeError:
 
130
                return elementtree.ElementTree._encode_entity(text)
 
131
        if replace is None:
 
132
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
133
        else:
 
134
            text = replace(text, "&", "&amp;")
 
135
            text = replace(text, "<", "&lt;")
 
136
            text = replace(text, ">", "&gt;")
 
137
            return text
 
138
    except (TypeError, AttributeError):
 
139
        elementtree.ElementTree._raise_serialization_error(text)
 
140
 
 
141
elementtree.ElementTree._escape_cdata = _escape_cdata