← 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 06:24:27 UTC
  • Revision ID: mbp@sourcefrog.net-20050913062426-330489777cdc9099
- more progress on fetch on top of weaves

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 import registry
26
 
from bzrlib.trace import mutter, warning
27
 
 
28
25
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
 
26
    from util.cElementTree import (ElementTree, SubElement, Element,
 
27
                                   XMLTreeBuilder)
39
28
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
43
29
    from util.elementtree.ElementTree import (ElementTree, SubElement,
44
 
                                              Element, XMLTreeBuilder,
45
 
                                              fromstring, tostring)
46
 
    import util.elementtree as elementtree
47
 
    from xml.parsers.expat import ExpatError as ParseError
 
30
                                              Element, XMLTreeBuilder)
48
31
 
49
 
from bzrlib import errors
 
32
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
33
from bzrlib.revision import Revision, RevisionReference        
 
34
from bzrlib.errors import BzrError
50
35
 
51
36
 
52
37
class Serializer(object):
53
38
    """Abstract object serialize/deserialize"""
54
 
 
55
39
    def write_inventory(self, inv, f):
56
40
        """Write inventory to a file"""
57
 
        raise NotImplementedError(self.write_inventory)
58
 
 
59
 
    def write_inventory_to_string(self, inv):
60
 
        raise NotImplementedError(self.write_inventory_to_string)
61
 
 
62
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
63
 
                                   entry_cache=None):
64
 
        """Read xml_string into an inventory object.
65
 
 
66
 
        :param xml_string: The xml to read.
67
 
        :param revision_id: If not-None, the expected revision id of the
68
 
            inventory. Some serialisers use this to set the results' root
69
 
            revision. This should be supplied for deserialising all
70
 
            from-repository inventories so that xml5 inventories that were
71
 
            serialised without a revision identifier can be given the right
72
 
            revision id (but not for working tree inventories where users can
73
 
            edit the data without triggering checksum errors or anything).
74
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
75
 
            supplied we will look up entries via (file_id, revision_id) which
76
 
            should map to a valid InventoryEntry (File/Directory/etc) object.
77
 
        """
78
 
        try:
79
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
80
 
                                          entry_cache=entry_cache)
81
 
        except ParseError, e:
82
 
            raise errors.UnexpectedInventoryFormat(e)
83
 
 
84
 
    def read_inventory(self, f, revision_id=None):
85
 
        try:
86
 
            return self._unpack_inventory(self._read_element(f),
87
 
                revision_id=None)
88
 
        except ParseError, e:
89
 
            raise errors.UnexpectedInventoryFormat(e)
 
41
        elt = self._pack_inventory(inv)
 
42
        self._write_element(elt, f)
 
43
 
 
44
    def read_inventory_from_string(self, xml_string):
 
45
        return self._unpack_inventory(self._parse_string(xml_string))
 
46
 
 
47
    def read_inventory(self, f):
 
48
        return self._unpack_inventory(self._read_element(f))
90
49
 
91
50
    def write_revision(self, rev, f):
92
51
        self._write_element(self._pack_revision(rev), f)
93
52
 
94
 
    def write_revision_to_string(self, rev):
95
 
        return tostring(self._pack_revision(rev)) + '\n'
96
 
 
97
53
    def read_revision(self, f):
98
54
        return self._unpack_revision(self._read_element(f))
99
55
 
100
56
    def read_revision_from_string(self, xml_string):
101
 
        return self._unpack_revision(fromstring(xml_string))
 
57
        return self._unpack_revision(self._parse_string(xml_string))
102
58
 
103
59
    def _write_element(self, elt, f):
104
60
        ElementTree(elt).write(f, 'utf-8')
107
63
    def _read_element(self, f):
108
64
        return ElementTree().parse(f)
109
65
 
110
 
 
111
 
# performance tuning for elementree's serialiser. This should be
112
 
# sent upstream - RBC 20060523.
113
 
# the functions here are patched into elementtree at runtime.
114
 
import re
115
 
escape_re = re.compile("[&'\"<>]")
116
 
escape_map = {
117
 
    "&":'&amp;',
118
 
    "'":"&apos;", # FIXME: overkill
119
 
    "\"":"&quot;",
120
 
    "<":"&lt;",
121
 
    ">":"&gt;",
122
 
    }
123
 
def _escape_replace(match, map=escape_map):
124
 
    return map[match.group()]
125
 
 
126
 
def _escape_attrib(text, encoding=None, replace=None):
127
 
    # escape attribute value
128
 
    try:
129
 
        if encoding:
130
 
            try:
131
 
                text = elementtree.ElementTree._encode(text, encoding)
132
 
            except UnicodeError:
133
 
                return elementtree.ElementTree._encode_entity(text)
134
 
        if replace is None:
135
 
            return escape_re.sub(_escape_replace, text)
136
 
        else:
137
 
            text = replace(text, "&", "&amp;")
138
 
            text = replace(text, "'", "&apos;") # FIXME: overkill
139
 
            text = replace(text, "\"", "&quot;")
140
 
            text = replace(text, "<", "&lt;")
141
 
            text = replace(text, ">", "&gt;")
142
 
            return text
143
 
    except (TypeError, AttributeError):
144
 
        elementtree.ElementTree._raise_serialization_error(text)
145
 
 
146
 
elementtree.ElementTree._escape_attrib = _escape_attrib
147
 
 
148
 
escape_cdata_re = re.compile("[&<>]")
149
 
escape_cdata_map = {
150
 
    "&":'&amp;',
151
 
    "<":"&lt;",
152
 
    ">":"&gt;",
153
 
    }
154
 
def _escape_cdata_replace(match, map=escape_cdata_map):
155
 
    return map[match.group()]
156
 
 
157
 
def _escape_cdata(text, encoding=None, replace=None):
158
 
    # escape character data
159
 
    try:
160
 
        if encoding:
161
 
            try:
162
 
                text = elementtree.ElementTree._encode(text, encoding)
163
 
            except UnicodeError:
164
 
                return elementtree.ElementTree._encode_entity(text)
165
 
        if replace is None:
166
 
            return escape_cdata_re.sub(_escape_cdata_replace, text)
167
 
        else:
168
 
            text = replace(text, "&", "&amp;")
169
 
            text = replace(text, "<", "&lt;")
170
 
            text = replace(text, ">", "&gt;")
171
 
            return text
172
 
    except (TypeError, AttributeError):
173
 
        elementtree.ElementTree._raise_serialization_error(text)
174
 
 
175
 
elementtree.ElementTree._escape_cdata = _escape_cdata
176
 
 
177
 
 
178
 
class SerializerRegistry(registry.Registry):
179
 
    """Registry for serializer objects"""
180
 
 
181
 
 
182
 
format_registry = SerializerRegistry()
183
 
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
184
 
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
185
 
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
186
 
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')
187
 
format_registry.register_lazy('8', 'bzrlib.xml8', 'serializer_v8')
 
66
    def _parse_string(self, xml_string):
 
67
        parser = XMLTreeBuilder()
 
68
        parser.feed(xml_string)
 
69
        return parser.close()
 
70
        
 
71
 
 
72
 
 
73
class _Serializer_v4(Serializer):
 
74
    """Version 0.0.4 serializer
 
75
 
 
76
    You should use the serialzer_v4 singleton."""
 
77
    
 
78
    __slots__ = []
 
79
    
 
80
    def _pack_inventory(self, inv):
 
81
        """Convert to XML Element"""
 
82
        e = Element('inventory')
 
83
        e.text = '\n'
 
84
        if inv.root.file_id not in (None, ROOT_ID):
 
85
            e.set('file_id', inv.root.file_id)
 
86
        for path, ie in inv.iter_entries():
 
87
            e.append(self._pack_entry(ie))
 
88
        return e
 
89
 
 
90
 
 
91
    def _pack_entry(self, ie):
 
92
        """Convert InventoryEntry to XML element"""
 
93
        e = Element('entry')
 
94
        e.set('name', ie.name)
 
95
        e.set('file_id', ie.file_id)
 
96
        e.set('kind', ie.kind)
 
97
 
 
98
        if ie.text_size != None:
 
99
            e.set('text_size', '%d' % ie.text_size)
 
100
 
 
101
        for f in ['text_id', 'text_sha1']:
 
102
            v = getattr(ie, f)
 
103
            if v != None:
 
104
                e.set(f, v)
 
105
 
 
106
        # to be conservative, we don't externalize the root pointers
 
107
        # for now, leaving them as null in the xml form.  in a future
 
108
        # version it will be implied by nested elements.
 
109
        if ie.parent_id != ROOT_ID:
 
110
            assert isinstance(ie.parent_id, basestring)
 
111
            e.set('parent_id', ie.parent_id)
 
112
 
 
113
        e.tail = '\n'
 
114
 
 
115
        return e
 
116
 
 
117
 
 
118
    def _unpack_inventory(self, elt):
 
119
        """Construct from XML Element
 
120
        """
 
121
        assert elt.tag == 'inventory'
 
122
        root_id = elt.get('file_id') or ROOT_ID
 
123
        inv = Inventory(root_id)
 
124
        for e in elt:
 
125
            ie = self._unpack_entry(e)
 
126
            if ie.parent_id == ROOT_ID:
 
127
                ie.parent_id = root_id
 
128
            inv.add(ie)
 
129
        return inv
 
130
 
 
131
 
 
132
    def _unpack_entry(self, elt):
 
133
        assert elt.tag == 'entry'
 
134
 
 
135
        ## original format inventories don't have a parent_id for
 
136
        ## nodes in the root directory, but it's cleaner to use one
 
137
        ## internally.
 
138
        parent_id = elt.get('parent_id')
 
139
        if parent_id == None:
 
140
            parent_id = ROOT_ID
 
141
 
 
142
        ie = InventoryEntry(elt.get('file_id'),
 
143
                            elt.get('name'),
 
144
                            elt.get('kind'),
 
145
                            parent_id)
 
146
        ie.text_id = elt.get('text_id')
 
147
        ie.text_sha1 = elt.get('text_sha1')
 
148
 
 
149
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
150
 
 
151
        v = elt.get('text_size')
 
152
        ie.text_size = v and int(v)
 
153
 
 
154
        return ie
 
155
 
 
156
 
 
157
    def _pack_revision(self, rev):
 
158
        """Revision object -> xml tree"""
 
159
        root = Element('revision',
 
160
                       committer = rev.committer,
 
161
                       timestamp = '%.9f' % rev.timestamp,
 
162
                       revision_id = rev.revision_id,
 
163
                       inventory_id = rev.inventory_id,
 
164
                       inventory_sha1 = rev.inventory_sha1,
 
165
                       )
 
166
        if rev.timezone:
 
167
            root.set('timezone', str(rev.timezone))
 
168
        root.text = '\n'
 
169
 
 
170
        msg = SubElement(root, 'message')
 
171
        msg.text = rev.message
 
172
        msg.tail = '\n'
 
173
 
 
174
        if rev.parents:
 
175
            pelts = SubElement(root, 'parents')
 
176
            pelts.tail = pelts.text = '\n'
 
177
            for rr in rev.parents:
 
178
                assert isinstance(rr, RevisionReference)
 
179
                p = SubElement(pelts, 'revision_ref')
 
180
                p.tail = '\n'
 
181
                assert rr.revision_id
 
182
                p.set('revision_id', rr.revision_id)
 
183
                if rr.revision_sha1:
 
184
                    p.set('revision_sha1', rr.revision_sha1)
 
185
 
 
186
        return root
 
187
 
 
188
    
 
189
    def _unpack_revision(self, elt):
 
190
        """XML Element -> Revision object"""
 
191
        
 
192
        # <changeset> is deprecated...
 
193
        if elt.tag not in ('revision', 'changeset'):
 
194
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
195
 
 
196
        rev = Revision(committer = elt.get('committer'),
 
197
                       timestamp = float(elt.get('timestamp')),
 
198
                       revision_id = elt.get('revision_id'),
 
199
                       inventory_id = elt.get('inventory_id'),
 
200
                       inventory_sha1 = elt.get('inventory_sha1')
 
201
                       )
 
202
 
 
203
        precursor = elt.get('precursor')
 
204
        precursor_sha1 = elt.get('precursor_sha1')
 
205
 
 
206
        pelts = elt.find('parents')
 
207
 
 
208
        if pelts:
 
209
            for p in pelts:
 
210
                assert p.tag == 'revision_ref', \
 
211
                       "bad parent node tag %r" % p.tag
 
212
                rev_ref = RevisionReference(p.get('revision_id'),
 
213
                                            p.get('revision_sha1'))
 
214
                rev.parents.append(rev_ref)
 
215
 
 
216
            if precursor:
 
217
                # must be consistent
 
218
                prec_parent = rev.parents[0].revision_id
 
219
                assert prec_parent == precursor
 
220
        elif precursor:
 
221
            # revisions written prior to 0.0.5 have a single precursor
 
222
            # give as an attribute
 
223
            rev_ref = RevisionReference(precursor, precursor_sha1)
 
224
            rev.parents.append(rev_ref)
 
225
 
 
226
        v = elt.get('timezone')
 
227
        rev.timezone = v and int(v)
 
228
 
 
229
        rev.message = elt.findtext('message') # text of <message>
 
230
        return rev
 
231
 
 
232
 
 
233
 
 
234
 
 
235
"""singleton instance"""
 
236
serializer_v4 = _Serializer_v4()
 
237