/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: John Arbash Meinel
  • Date: 2005-11-19 04:22:51 UTC
  • mto: (1185.82.108 w-changeset)
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: john@arbash-meinel.com-20051119042251-aaa8514b7d68c29f
Working on creating a factor for serializing changesets.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.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
 
from bzrlib.serializer import Serializer
26
 
from bzrlib.trace import mutter
 
25
from bzrlib.trace import mutter, warning
27
26
 
28
27
try:
29
 
    try:
30
 
        # it's in this package in python2.5
31
 
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
32
 
            XMLTreeBuilder, fromstring, tostring)
33
 
        import xml.etree as elementtree
34
 
    except ImportError:
35
 
        from cElementTree import (ElementTree, SubElement, Element,
36
 
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree.ElementTree
38
 
    ParseError = SyntaxError
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
39
30
except ImportError:
40
 
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
41
 
           " and make sure it's on your PYTHONPATH")
42
 
    # this copy is shipped with bzr
 
31
    ## from warnings import warn
 
32
    ## warn('using slower ElementTree; consider installing cElementTree')
43
33
    from util.elementtree.ElementTree import (ElementTree, SubElement,
44
34
                                              Element, XMLTreeBuilder,
45
35
                                              fromstring, tostring)
46
 
    import util.elementtree as elementtree
47
 
    from xml.parsers.expat import ExpatError as ParseError
48
 
 
49
 
from bzrlib import errors
50
 
 
51
 
 
52
 
class XMLSerializer(Serializer):
53
 
    """Abstract XML object serialize/deserialize"""
54
 
 
55
 
    squashes_xml_invalid_characters = True
56
 
 
57
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
58
 
                                   entry_cache=None, return_from_cache=False):
59
 
        """Read xml_string into an inventory object.
60
 
 
61
 
        :param xml_string: The xml to read.
62
 
        :param revision_id: If not-None, the expected revision id of the
63
 
            inventory. Some serialisers use this to set the results' root
64
 
            revision. This should be supplied for deserialising all
65
 
            from-repository inventories so that xml5 inventories that were
66
 
            serialised without a revision identifier can be given the right
67
 
            revision id (but not for working tree inventories where users can
68
 
            edit the data without triggering checksum errors or anything).
69
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
70
 
            supplied we will look up entries via (file_id, revision_id) which
71
 
            should map to a valid InventoryEntry (File/Directory/etc) object.
72
 
        :param return_from_cache: Return entries directly from the cache,
73
 
            rather than copying them first. This is only safe if the caller
74
 
            promises not to mutate the returned inventory entries, but it can
75
 
            make some operations significantly faster.
76
 
        """
77
 
        try:
78
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
79
 
                                          entry_cache=entry_cache,
80
 
                                          return_from_cache=return_from_cache)
81
 
        except ParseError, e:
82
 
            raise errors.UnexpectedInventoryFormat(e)
83
 
 
84
 
    def read_inventory(self, f, revision_id=None):
85
 
        try:
86
 
            try:
87
 
                return self._unpack_inventory(self._read_element(f),
88
 
                    revision_id=None)
89
 
            finally:
90
 
                f.close()
91
 
        except ParseError, e:
92
 
            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))
93
55
 
94
56
    def write_revision(self, rev, f):
95
57
        self._write_element(self._pack_revision(rev), f)
109
71
 
110
72
    def _read_element(self, f):
111
73
        return ElementTree().parse(f)
112
 
 
113
 
 
114
 
# performance tuning for elementree's serialiser. This should be
115
 
# sent upstream - RBC 20060523.
116
 
# the functions here are patched into elementtree at runtime.
117
 
import re
118
 
escape_re = re.compile("[&'\"<>]")
119
 
escape_map = {
120
 
    "&":'&amp;',
121
 
    "'":"&apos;", # FIXME: overkill
122
 
    "\"":"&quot;",
123
 
    "<":"&lt;",
124
 
    ">":"&gt;",
125
 
    }
126
 
def _escape_replace(match, map=escape_map):
127
 
    return map[match.group()]
128
 
 
129
 
def _escape_attrib(text, encoding=None, replace=None):
130
 
    # escape attribute value
131
 
    try:
132
 
        if encoding:
133
 
            try:
134
 
                text = elementtree.ElementTree._encode(text, encoding)
135
 
            except UnicodeError:
136
 
                return elementtree.ElementTree._encode_entity(text)
137
 
        if replace is None:
138
 
            return escape_re.sub(_escape_replace, text)
139
 
        else:
140
 
            text = replace(text, "&", "&amp;")
141
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
142
 
            text = replace(text, "\"", "&quot;")
143
 
            text = replace(text, "<", "&lt;")
144
 
            text = replace(text, ">", "&gt;")
145
 
            return text
146
 
    except (TypeError, AttributeError):
147
 
        elementtree.ElementTree._raise_serialization_error(text)
148
 
 
149
 
elementtree.ElementTree._escape_attrib = _escape_attrib
150
 
 
151
 
escape_cdata_re = re.compile("[&<>]")
152
 
escape_cdata_map = {
153
 
    "&":'&amp;',
154
 
    "<":"&lt;",
155
 
    ">":"&gt;",
156
 
    }
157
 
def _escape_cdata_replace(match, map=escape_cdata_map):
158
 
    return map[match.group()]
159
 
 
160
 
def _escape_cdata(text, encoding=None, replace=None):
161
 
    # escape character data
162
 
    try:
163
 
        if encoding:
164
 
            try:
165
 
                text = elementtree.ElementTree._encode(text, encoding)
166
 
            except UnicodeError:
167
 
                return elementtree.ElementTree._encode_entity(text)
168
 
        if replace is None:
169
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
170
 
        else:
171
 
            text = replace(text, "&", "&amp;")
172
 
            text = replace(text, "<", "&lt;")
173
 
            text = replace(text, ">", "&gt;")
174
 
            return text
175
 
    except (TypeError, AttributeError):
176
 
        elementtree.ElementTree._raise_serialization_error(text)
177
 
 
178
 
elementtree.ElementTree._escape_cdata = _escape_cdata
179
 
 
180
 
 
181
 
def escape_invalid_chars(message):
182
 
    """Escape the XML-invalid characters in a commit message.
183
 
 
184
 
    :param message: Commit message to escape
185
 
    :return: tuple with escaped message and number of characters escaped
186
 
    """
187
 
    if message is None:
188
 
        return None, 0
189
 
    # Python strings can include characters that can't be
190
 
    # represented in well-formed XML; escape characters that
191
 
    # aren't listed in the XML specification
192
 
    # (http://www.w3.org/TR/REC-xml/#NT-Char).
193
 
    return re.subn(u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
194
 
            lambda match: match.group(0).encode('unicode_escape'),
195
 
            message)