/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_serializer.py

  • Committer: Aaron Bentley
  • Date: 2006-08-24 18:58:29 UTC
  • mto: (1910.2.43 format-bumps)
  • mto: This revision was merged to the branch mainline in revision 1997.
  • Revision ID: abentley@panoramicfeedback.com-20060824185829-16911fcce7b8e50b
Fix info test to use knit1 for bound branches

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.py
 
1
# -*- coding: UTF-8 -*-
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""XML externalization support."""
 
18
 
 
19
# "XML is like violence: if it doesn't solve your problem, you aren't
 
20
# using enough of it." -- various
 
21
 
 
22
# importing this module is fairly slow because it has to load several
 
23
# ElementTree bits
 
24
 
 
25
from bzrlib.trace import mutter, warning
 
26
 
 
27
try:
 
28
    from cElementTree import (ElementTree, SubElement, Element,
 
29
                              XMLTreeBuilder, fromstring, tostring)
 
30
    import elementtree
 
31
except ImportError:
 
32
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
 
33
           " and make sure it's on your PYTHONPATH")
 
34
    from util.elementtree.ElementTree import (ElementTree, SubElement,
 
35
                                              Element, XMLTreeBuilder,
 
36
                                              fromstring, tostring)
 
37
    import util.elementtree as elementtree
 
38
 
 
39
from bzrlib.errors import BzrError
 
40
from bzrlib import errors
 
41
 
 
42
 
 
43
class Serializer(object):
 
44
    """Abstract object serialize/deserialize"""
 
45
    def write_inventory(self, inv, f):
 
46
        """Write inventory to a file"""
 
47
        elt = self._pack_inventory(inv)
 
48
        self._write_element(elt, f)
 
49
 
 
50
    def write_inventory_to_string(self, inv):
 
51
        return tostring(self._pack_inventory(inv)) + '\n'
 
52
 
 
53
    def read_inventory_from_string(self, xml_string):
 
54
        try:
 
55
            return self._unpack_inventory(fromstring(xml_string))
 
56
        except SyntaxError, e:
 
57
            raise errors.UnexpectedInventoryFormat(e)
 
58
 
 
59
    def read_inventory(self, f):
 
60
        try:
 
61
            return self._unpack_inventory(self._read_element(f))
 
62
        except SyntaxError, e:
 
63
            raise errors.UnexpectedInventoryFormat(e)
 
64
 
 
65
    def write_revision(self, rev, f):
 
66
        self._write_element(self._pack_revision(rev), f)
 
67
 
 
68
    def write_revision_to_string(self, rev):
 
69
        return tostring(self._pack_revision(rev)) + '\n'
 
70
 
 
71
    def read_revision(self, f):
 
72
        return self._unpack_revision(self._read_element(f))
 
73
 
 
74
    def read_revision_from_string(self, xml_string):
 
75
        return self._unpack_revision(fromstring(xml_string))
 
76
 
 
77
    def _write_element(self, elt, f):
 
78
        ElementTree(elt).write(f, 'utf-8')
 
79
        f.write('\n')
 
80
 
 
81
    def _read_element(self, f):
 
82
        return ElementTree().parse(f)
 
83
 
 
84
 
 
85
# performance tuning for elementree's serialiser. This should be
 
86
# sent upstream - RBC 20060523.
 
87
# the functions here are patched into elementtree at runtime.
 
88
import re
 
89
escape_re = re.compile("[&'\"<>]")
 
90
escape_map = {
 
91
    "&":'&amp;',
 
92
    "'":"&apos;", # FIXME: overkill
 
93
    "\"":"&quot;",
 
94
    "<":"&lt;",
 
95
    ">":"&gt;",
 
96
    }
 
97
def _escape_replace(match, map=escape_map):
 
98
    return map[match.group()]
 
99
 
 
100
def _escape_attrib(text, encoding=None, replace=None):
 
101
    # escape attribute value
 
102
    try:
 
103
        if encoding:
 
104
            try:
 
105
                text = elementtree.ElementTree._encode(text, encoding)
 
106
            except UnicodeError:
 
107
                return elementtree.ElementTree._encode_entity(text)
 
108
        if replace is None:
 
109
            return escape_re.sub(_escape_replace, text)
 
110
        else:
 
111
            text = replace(text, "&", "&amp;")
 
112
            text = replace(text, "'", "&apos;") # FIXME: overkill
 
113
            text = replace(text, "\"", "&quot;")
 
114
            text = replace(text, "<", "&lt;")
 
115
            text = replace(text, ">", "&gt;")
 
116
            return text
 
117
    except (TypeError, AttributeError):
 
118
        elementtree.ElementTree._raise_serialization_error(text)
 
119
 
 
120
elementtree.ElementTree._escape_attrib = _escape_attrib
 
121
 
 
122
escape_cdata_re = re.compile("[&<>]")
 
123
escape_cdata_map = {
 
124
    "&":'&amp;',
 
125
    "<":"&lt;",
 
126
    ">":"&gt;",
 
127
    }
 
128
def _escape_cdata_replace(match, map=escape_cdata_map):
 
129
    return map[match.group()]
 
130
 
 
131
def _escape_cdata(text, encoding=None, replace=None):
 
132
    # escape character data
 
133
    try:
 
134
        if encoding:
 
135
            try:
 
136
                text = elementtree.ElementTree._encode(text, encoding)
 
137
            except UnicodeError:
 
138
                return elementtree.ElementTree._encode_entity(text)
 
139
        if replace is None:
 
140
            return escape_cdata_re.sub(_escape_cdata_replace, text)
 
141
        else:
 
142
            text = replace(text, "&", "&amp;")
 
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_cdata = _escape_cdata