← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Robert Collins
  • Date: 2009-09-07 03:08:30 UTC
  • mto: This revision was merged to the branch mainline in revision 4690.
  • Revision ID: robertc@robertcollins.net-20090907030830-rf59kt28d550eauj
Milestones language tightning, internal consistency.

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
4
6
# (at your option) any later version.
5
 
 
 
7
#
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
11
# GNU General Public License for more details.
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 serialzer_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
 
        e = Element('inventory')
37
 
        e.text = '\n'
38
 
        if inv.root.file_id not in (None, ROOT_ID):
39
 
            e.set('file_id', inv.root.file_id)
40
 
        for path, ie in inv.iter_entries():
41
 
            e.append(self._pack_entry(ie))
42
 
        return e
43
 
 
44
39
 
45
40
    def _pack_entry(self, ie):
46
41
        """Convert InventoryEntry to XML element"""
49
44
        e.set('file_id', ie.file_id)
50
45
        e.set('kind', ie.kind)
51
46
 
52
 
        if ie.text_size != None:
 
47
        if ie.text_size is not None:
53
48
            e.set('text_size', '%d' % ie.text_size)
54
49
 
55
50
        for f in ['text_id', 'text_sha1', 'symlink_target']:
56
51
            v = getattr(ie, f)
57
 
            if v != None:
 
52
            if v is not None:
58
53
                e.set(f, v)
59
54
 
60
55
        # to be conservative, we don't externalize the root pointers
61
56
        # for now, leaving them as null in the xml form.  in a future
62
57
        # version it will be implied by nested elements.
63
58
        if ie.parent_id != ROOT_ID:
64
 
            assert isinstance(ie.parent_id, basestring)
65
59
            e.set('parent_id', ie.parent_id)
66
60
 
67
61
        e.tail = '\n'
69
63
        return e
70
64
 
71
65
 
72
 
    def _unpack_inventory(self, elt):
 
66
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None):
73
67
        """Construct from XML Element
 
68
 
 
69
        :param revision_id: Ignored parameter used by xml5.
74
70
        """
75
 
        assert elt.tag == 'inventory'
76
71
        root_id = elt.get('file_id') or ROOT_ID
77
72
        inv = Inventory(root_id)
78
73
        for e in elt:
79
 
            ie = self._unpack_entry(e)
 
74
            ie = self._unpack_entry(e, entry_cache=entry_cache)
80
75
            if ie.parent_id == ROOT_ID:
81
76
                ie.parent_id = root_id
82
77
            inv.add(ie)
83
78
        return inv
84
79
 
85
80
 
86
 
    def _unpack_entry(self, elt):
87
 
        assert elt.tag == 'entry'
88
 
 
 
81
    def _unpack_entry(self, elt, entry_cache=None):
89
82
        ## original format inventories don't have a parent_id for
90
83
        ## nodes in the root directory, but it's cleaner to use one
91
84
        ## internally.
92
85
        parent_id = elt.get('parent_id')
93
 
        if parent_id == None:
 
86
        if parent_id is None:
94
87
            parent_id = ROOT_ID
95
88
 
96
89
        kind = elt.get('kind')
133
126
        root.text = '\n'
134
127
 
135
128
        msg = SubElement(root, 'message')
136
 
        msg.text = rev.message
 
129
        msg.text = escape_invalid_chars(rev.message)[0]
137
130
        msg.tail = '\n'
138
131
 
139
132
        if rev.parents:
142
135
            for i, parent_id in enumerate(rev.parents):
143
136
                p = SubElement(pelts, 'revision_ref')
144
137
                p.tail = '\n'
145
 
                assert parent_id
146
138
                p.set('revision_id', parent_id)
147
139
                if i < len(rev.parent_sha1s):
148
140
                    p.set('revision_sha1', rev.parent_sha1s[i])
149
141
        return root
150
142
 
151
 
    
 
143
 
152
144
    def _unpack_revision(self, elt):
153
145
        """XML Element -> Revision object"""
154
 
        
 
146
 
155
147
        # <changeset> is deprecated...
156
148
        if elt.tag not in ('revision', 'changeset'):
157
149
            raise BzrError("unexpected tag in revision file: %r" % elt)
170
162
 
171
163
        if pelts:
172
164
            for p in pelts:
173
 
                assert p.tag == 'revision_ref', \
174
 
                       "bad parent node tag %r" % p.tag
175
165
                rev.parent_ids.append(p.get('revision_id'))
176
166
                rev.parent_sha1s.append(p.get('revision_sha1'))
177
167
            if precursor:
178
168
                # must be consistent
179
169
                prec_parent = rev.parent_ids[0]
180
 
                assert prec_parent == precursor
181
170
        elif precursor:
182
171
            # revisions written prior to 0.0.5 have a single precursor
183
172
            # give as an attribute