← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
10
12
#
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
 
 
15
 
 
16
 
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from bzrlib.xml_serializer import (
 
18
    Element,
 
19
    ElementTree,
 
20
    SubElement,
 
21
    XMLSerializer,
 
22
    escape_invalid_chars,
 
23
    )
17
24
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
18
25
import bzrlib.inventory as inventory
19
 
from bzrlib.revision import Revision        
 
26
from bzrlib.revision import Revision
20
27
from bzrlib.errors import BzrError
21
28
 
22
29
 
23
 
 
24
 
 
25
 
 
26
 
 
27
 
class _Serializer_v4(Serializer):
 
30
class _Serializer_v4(XMLSerializer):
28
31
    """Version 0.0.4 serializer
29
32
 
30
 
    You should use the serializer_v4 singleton."""
31
 
    
 
33
    You should use the serializer_v4 singleton.
 
34
 
 
35
    v4 serialisation is no longer supported, only deserialisation.
 
36
    """
 
37
 
32
38
    __slots__ = []
33
 
    
34
 
    def _pack_inventory(self, inv):
35
 
        """Convert to XML Element"""
36
 
        # v4 serialization is not used any more.
37
 
        raise NotImplementedError(self._pack_inventory)
38
 
        e = Element('inventory')
39
 
        e.text = '\n'
40
 
        if inv.root.file_id not in (None, ROOT_ID):
41
 
            e.set('file_id', inv.root.file_id)
42
 
        for path, ie in inv.iter_entries():
43
 
            e.append(self._pack_entry(ie))
44
 
        return e
45
 
 
46
39
 
47
40
    def _pack_entry(self, ie):
48
41
        """Convert InventoryEntry to XML element"""
51
44
        e.set('file_id', ie.file_id)
52
45
        e.set('kind', ie.kind)
53
46
 
54
 
        if ie.text_size != None:
 
47
        if ie.text_size is not None:
55
48
            e.set('text_size', '%d' % ie.text_size)
56
49
 
57
50
        for f in ['text_id', 'text_sha1', 'symlink_target']:
58
51
            v = getattr(ie, f)
59
 
            if v != None:
 
52
            if v is not None:
60
53
                e.set(f, v)
61
54
 
62
55
        # to be conservative, we don't externalize the root pointers
63
56
        # for now, leaving them as null in the xml form.  in a future
64
57
        # version it will be implied by nested elements.
65
58
        if ie.parent_id != ROOT_ID:
66
 
            assert isinstance(ie.parent_id, basestring)
67
59
            e.set('parent_id', ie.parent_id)
68
60
 
69
61
        e.tail = '\n'
71
63
        return e
72
64
 
73
65
 
74
 
    def _unpack_inventory(self, elt):
 
66
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None):
75
67
        """Construct from XML Element
 
68
 
 
69
        :param revision_id: Ignored parameter used by xml5.
76
70
        """
77
 
        assert elt.tag == 'inventory'
78
71
        root_id = elt.get('file_id') or ROOT_ID
79
72
        inv = Inventory(root_id)
80
73
        for e in elt:
81
 
            ie = self._unpack_entry(e)
 
74
            ie = self._unpack_entry(e, entry_cache=entry_cache)
82
75
            if ie.parent_id == ROOT_ID:
83
76
                ie.parent_id = root_id
84
77
            inv.add(ie)
85
78
        return inv
86
79
 
87
80
 
88
 
    def _unpack_entry(self, elt):
89
 
        assert elt.tag == 'entry'
90
 
 
 
81
    def _unpack_entry(self, elt, entry_cache=None):
91
82
        ## original format inventories don't have a parent_id for
92
83
        ## nodes in the root directory, but it's cleaner to use one
93
84
        ## internally.
94
85
        parent_id = elt.get('parent_id')
95
 
        if parent_id == None:
 
86
        if parent_id is None:
96
87
            parent_id = ROOT_ID
97
88
 
98
89
        kind = elt.get('kind')
135
126
        root.text = '\n'
136
127
 
137
128
        msg = SubElement(root, 'message')
138
 
        msg.text = rev.message
 
129
        msg.text = escape_invalid_chars(rev.message)[0]
139
130
        msg.tail = '\n'
140
131
 
141
132
        if rev.parents:
144
135
            for i, parent_id in enumerate(rev.parents):
145
136
                p = SubElement(pelts, 'revision_ref')
146
137
                p.tail = '\n'
147
 
                assert parent_id
148
138
                p.set('revision_id', parent_id)
149
139
                if i < len(rev.parent_sha1s):
150
140
                    p.set('revision_sha1', rev.parent_sha1s[i])
151
141
        return root
152
142
 
153
 
    
 
143
 
154
144
    def _unpack_revision(self, elt):
155
145
        """XML Element -> Revision object"""
156
 
        
 
146
 
157
147
        # <changeset> is deprecated...
158
148
        if elt.tag not in ('revision', 'changeset'):
159
149
            raise BzrError("unexpected tag in revision file: %r" % elt)
172
162
 
173
163
        if pelts:
174
164
            for p in pelts:
175
 
                assert p.tag == 'revision_ref', \
176
 
                       "bad parent node tag %r" % p.tag
177
165
                rev.parent_ids.append(p.get('revision_id'))
178
166
                rev.parent_sha1s.append(p.get('revision_sha1'))
179
167
            if precursor:
180
168
                # must be consistent
181
169
                prec_parent = rev.parent_ids[0]
182
 
                assert prec_parent == precursor
183
170
        elif precursor:
184
171
            # revisions written prior to 0.0.5 have a single precursor
185
172
            # give as an attribute