← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml.py

  • Committer: Martin Pool
  • Date: 2005-09-13 05:22:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050913052241-52dbd8e8ced620f6
- better BZR_DEBUG trace output

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22
22
# importing this module is fairly slow because it has to load several
23
23
# ElementTree bits
24
24
 
25
 
from bzrlib.trace import mutter, warning
26
 
 
27
25
try:
28
 
    try:
29
 
        # it's in this package in python2.5
30
 
        from xml.etree.cElementTree import (ElementTree, SubElement, Element,
31
 
            XMLTreeBuilder, fromstring, tostring)
32
 
        import xml.etree as elementtree
33
 
    except ImportError:
34
 
        from cElementTree import (ElementTree, SubElement, Element,
35
 
                                  XMLTreeBuilder, fromstring, tostring)
36
 
        import elementtree
37
 
    ParseError = SyntaxError
 
26
    from util.cElementTree import ElementTree, SubElement, Element
38
27
except ImportError:
39
 
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
40
 
           " and make sure it's on your PYTHONPATH")
41
 
    # this copy is shipped with bzr
42
 
    from util.elementtree.ElementTree import (ElementTree, SubElement,
43
 
                                              Element, XMLTreeBuilder,
44
 
                                              fromstring, tostring)
45
 
    import util.elementtree as elementtree
46
 
    from xml.parsers.expat import ExpatError as ParseError
 
28
    from util.elementtree.ElementTree import ElementTree, SubElement, Element
47
29
 
48
 
from bzrlib import errors
 
30
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
31
from bzrlib.revision import Revision, RevisionReference        
 
32
from bzrlib.errors import BzrError
49
33
 
50
34
 
51
35
class Serializer(object):
55
39
        elt = self._pack_inventory(inv)
56
40
        self._write_element(elt, f)
57
41
 
58
 
    def write_inventory_to_string(self, inv):
59
 
        return tostring(self._pack_inventory(inv)) + '\n'
60
 
 
61
 
    def read_inventory_from_string(self, xml_string):
62
 
        try:
63
 
            return self._unpack_inventory(fromstring(xml_string))
64
 
        except ParseError, e:
65
 
            raise errors.UnexpectedInventoryFormat(e)
66
 
 
67
42
    def read_inventory(self, f):
68
 
        try:
69
 
            return self._unpack_inventory(self._read_element(f))
70
 
        except ParseError, e:
71
 
            raise errors.UnexpectedInventoryFormat(e)
 
43
        return self._unpack_inventory(self._read_element(f))
72
44
 
73
45
    def write_revision(self, rev, f):
74
46
        self._write_element(self._pack_revision(rev), f)
75
47
 
76
 
    def write_revision_to_string(self, rev):
77
 
        return tostring(self._pack_revision(rev)) + '\n'
78
 
 
79
48
    def read_revision(self, f):
80
49
        return self._unpack_revision(self._read_element(f))
81
50
 
82
 
    def read_revision_from_string(self, xml_string):
83
 
        return self._unpack_revision(fromstring(xml_string))
84
 
 
85
51
    def _write_element(self, elt, f):
86
52
        ElementTree(elt).write(f, 'utf-8')
87
53
        f.write('\n')
90
56
        return ElementTree().parse(f)
91
57
 
92
58
 
93
 
# performance tuning for elementree's serialiser. This should be
94
 
# sent upstream - RBC 20060523.
95
 
# the functions here are patched into elementtree at runtime.
96
 
import re
97
 
escape_re = re.compile("[&'\"<>]")
98
 
escape_map = {
99
 
    "&":'&amp;',
100
 
    "'":"&apos;", # FIXME: overkill
101
 
    "\"":"&quot;",
102
 
    "<":"&lt;",
103
 
    ">":"&gt;",
104
 
    }
105
 
def _escape_replace(match, map=escape_map):
106
 
    return map[match.group()]
107
 
 
108
 
def _escape_attrib(text, encoding=None, replace=None):
109
 
    # escape attribute value
110
 
    try:
111
 
        if encoding:
112
 
            try:
113
 
                text = elementtree.ElementTree._encode(text, encoding)
114
 
            except UnicodeError:
115
 
                return elementtree.ElementTree._encode_entity(text)
116
 
        if replace is None:
117
 
            return escape_re.sub(_escape_replace, text)
118
 
        else:
119
 
            text = replace(text, "&", "&amp;")
120
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
121
 
            text = replace(text, "\"", "&quot;")
122
 
            text = replace(text, "<", "&lt;")
123
 
            text = replace(text, ">", "&gt;")
124
 
            return text
125
 
    except (TypeError, AttributeError):
126
 
        elementtree.ElementTree._raise_serialization_error(text)
127
 
 
128
 
elementtree.ElementTree._escape_attrib = _escape_attrib
129
 
 
130
 
escape_cdata_re = re.compile("[&<>]")
131
 
escape_cdata_map = {
132
 
    "&":'&amp;',
133
 
    "<":"&lt;",
134
 
    ">":"&gt;",
135
 
    }
136
 
def _escape_cdata_replace(match, map=escape_cdata_map):
137
 
    return map[match.group()]
138
 
 
139
 
def _escape_cdata(text, encoding=None, replace=None):
140
 
    # escape character data
141
 
    try:
142
 
        if encoding:
143
 
            try:
144
 
                text = elementtree.ElementTree._encode(text, encoding)
145
 
            except UnicodeError:
146
 
                return elementtree.ElementTree._encode_entity(text)
147
 
        if replace is None:
148
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
149
 
        else:
150
 
            text = replace(text, "&", "&amp;")
151
 
            text = replace(text, "<", "&lt;")
152
 
            text = replace(text, ">", "&gt;")
153
 
            return text
154
 
    except (TypeError, AttributeError):
155
 
        elementtree.ElementTree._raise_serialization_error(text)
156
 
 
157
 
elementtree.ElementTree._escape_cdata = _escape_cdata
 
59
 
 
60
class _Serializer_v4(Serializer):
 
61
    """Version 0.0.4 serializer
 
62
 
 
63
    You should use the serialzer_v4 singleton."""
 
64
    
 
65
    __slots__ = []
 
66
    
 
67
    def _pack_inventory(self, inv):
 
68
        """Convert to XML Element"""
 
69
        e = Element('inventory')
 
70
        e.text = '\n'
 
71
        if inv.root.file_id not in (None, ROOT_ID):
 
72
            e.set('file_id', inv.root.file_id)
 
73
        for path, ie in inv.iter_entries():
 
74
            e.append(self._pack_entry(ie))
 
75
        return e
 
76
 
 
77
 
 
78
    def _pack_entry(self, ie):
 
79
        """Convert InventoryEntry to XML element"""
 
80
        e = Element('entry')
 
81
        e.set('name', ie.name)
 
82
        e.set('file_id', ie.file_id)
 
83
        e.set('kind', ie.kind)
 
84
 
 
85
        if ie.text_size != None:
 
86
            e.set('text_size', '%d' % ie.text_size)
 
87
 
 
88
        for f in ['text_id', 'text_sha1']:
 
89
            v = getattr(ie, f)
 
90
            if v != None:
 
91
                e.set(f, v)
 
92
 
 
93
        # to be conservative, we don't externalize the root pointers
 
94
        # for now, leaving them as null in the xml form.  in a future
 
95
        # version it will be implied by nested elements.
 
96
        if ie.parent_id != ROOT_ID:
 
97
            assert isinstance(ie.parent_id, basestring)
 
98
            e.set('parent_id', ie.parent_id)
 
99
 
 
100
        e.tail = '\n'
 
101
 
 
102
        return e
 
103
 
 
104
 
 
105
    def _unpack_inventory(self, elt):
 
106
        """Construct from XML Element
 
107
        """
 
108
        assert elt.tag == 'inventory'
 
109
        root_id = elt.get('file_id') or ROOT_ID
 
110
        inv = Inventory(root_id)
 
111
        for e in elt:
 
112
            ie = self._unpack_entry(e)
 
113
            if ie.parent_id == ROOT_ID:
 
114
                ie.parent_id = root_id
 
115
            inv.add(ie)
 
116
        return inv
 
117
 
 
118
 
 
119
    def _unpack_entry(self, elt):
 
120
        assert elt.tag == 'entry'
 
121
 
 
122
        ## original format inventories don't have a parent_id for
 
123
        ## nodes in the root directory, but it's cleaner to use one
 
124
        ## internally.
 
125
        parent_id = elt.get('parent_id')
 
126
        if parent_id == None:
 
127
            parent_id = ROOT_ID
 
128
 
 
129
        ie = InventoryEntry(elt.get('file_id'),
 
130
                            elt.get('name'),
 
131
                            elt.get('kind'),
 
132
                            parent_id)
 
133
        ie.text_id = elt.get('text_id')
 
134
        ie.text_sha1 = elt.get('text_sha1')
 
135
 
 
136
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
137
 
 
138
        v = elt.get('text_size')
 
139
        ie.text_size = v and int(v)
 
140
 
 
141
        return ie
 
142
 
 
143
 
 
144
    def _pack_revision(self, rev):
 
145
        """Revision object -> xml tree"""
 
146
        root = Element('revision',
 
147
                       committer = rev.committer,
 
148
                       timestamp = '%.9f' % rev.timestamp,
 
149
                       revision_id = rev.revision_id,
 
150
                       inventory_id = rev.inventory_id,
 
151
                       inventory_sha1 = rev.inventory_sha1,
 
152
                       )
 
153
        if rev.timezone:
 
154
            root.set('timezone', str(rev.timezone))
 
155
        root.text = '\n'
 
156
 
 
157
        msg = SubElement(root, 'message')
 
158
        msg.text = rev.message
 
159
        msg.tail = '\n'
 
160
 
 
161
        if rev.parents:
 
162
            pelts = SubElement(root, 'parents')
 
163
            pelts.tail = pelts.text = '\n'
 
164
            for rr in rev.parents:
 
165
                assert isinstance(rr, RevisionReference)
 
166
                p = SubElement(pelts, 'revision_ref')
 
167
                p.tail = '\n'
 
168
                assert rr.revision_id
 
169
                p.set('revision_id', rr.revision_id)
 
170
                if rr.revision_sha1:
 
171
                    p.set('revision_sha1', rr.revision_sha1)
 
172
 
 
173
        return root
 
174
 
 
175
    
 
176
    def _unpack_revision(self, elt):
 
177
        """XML Element -> Revision object"""
 
178
        
 
179
        # <changeset> is deprecated...
 
180
        if elt.tag not in ('revision', 'changeset'):
 
181
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
182
 
 
183
        rev = Revision(committer = elt.get('committer'),
 
184
                       timestamp = float(elt.get('timestamp')),
 
185
                       revision_id = elt.get('revision_id'),
 
186
                       inventory_id = elt.get('inventory_id'),
 
187
                       inventory_sha1 = elt.get('inventory_sha1')
 
188
                       )
 
189
 
 
190
        precursor = elt.get('precursor')
 
191
        precursor_sha1 = elt.get('precursor_sha1')
 
192
 
 
193
        pelts = elt.find('parents')
 
194
 
 
195
        if pelts:
 
196
            for p in pelts:
 
197
                assert p.tag == 'revision_ref', \
 
198
                       "bad parent node tag %r" % p.tag
 
199
                rev_ref = RevisionReference(p.get('revision_id'),
 
200
                                            p.get('revision_sha1'))
 
201
                rev.parents.append(rev_ref)
 
202
 
 
203
            if precursor:
 
204
                # must be consistent
 
205
                prec_parent = rev.parents[0].revision_id
 
206
                assert prec_parent == precursor
 
207
        elif precursor:
 
208
            # revisions written prior to 0.0.5 have a single precursor
 
209
            # give as an attribute
 
210
            rev_ref = RevisionReference(precursor, precursor_sha1)
 
211
            rev.parents.append(rev_ref)
 
212
 
 
213
        v = elt.get('timezone')
 
214
        rev.timezone = v and int(v)
 
215
 
 
216
        rev.message = elt.findtext('message') # text of <message>
 
217
        return rev
 
218
 
 
219
 
 
220
 
 
221
 
 
222
"""singleton instance"""
 
223
serializer_v4 = _Serializer_v4()
 
224