~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

Added support for branch nicks

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
# 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
 
    )
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
24
19
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
25
20
import bzrlib.inventory as inventory
26
 
from bzrlib.revision import Revision
 
21
from bzrlib.revision import Revision        
27
22
from bzrlib.errors import BzrError
28
23
 
29
24
 
30
 
class _Serializer_v4(XMLSerializer):
 
25
 
 
26
 
 
27
 
 
28
 
 
29
class _Serializer_v4(Serializer):
31
30
    """Version 0.0.4 serializer
32
31
 
33
 
    You should use the serializer_v4 singleton.
34
 
 
35
 
    v4 serialisation is no longer supported, only deserialisation.
36
 
    """
37
 
 
 
32
    You should use the serialzer_v4 singleton."""
 
33
    
38
34
    __slots__ = []
 
35
    
 
36
    def _pack_inventory(self, inv):
 
37
        """Convert to XML Element"""
 
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
 
39
46
 
40
47
    def _pack_entry(self, ie):
41
48
        """Convert InventoryEntry to XML element"""
44
51
        e.set('file_id', ie.file_id)
45
52
        e.set('kind', ie.kind)
46
53
 
47
 
        if ie.text_size is not None:
 
54
        if ie.text_size != None:
48
55
            e.set('text_size', '%d' % ie.text_size)
49
56
 
50
57
        for f in ['text_id', 'text_sha1', 'symlink_target']:
51
58
            v = getattr(ie, f)
52
 
            if v is not None:
 
59
            if v != None:
53
60
                e.set(f, v)
54
61
 
55
62
        # to be conservative, we don't externalize the root pointers
56
63
        # for now, leaving them as null in the xml form.  in a future
57
64
        # version it will be implied by nested elements.
58
65
        if ie.parent_id != ROOT_ID:
 
66
            assert isinstance(ie.parent_id, basestring)
59
67
            e.set('parent_id', ie.parent_id)
60
68
 
61
69
        e.tail = '\n'
63
71
        return e
64
72
 
65
73
 
66
 
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None):
 
74
    def _unpack_inventory(self, elt):
67
75
        """Construct from XML Element
68
 
 
69
 
        :param revision_id: Ignored parameter used by xml5.
70
76
        """
 
77
        assert elt.tag == 'inventory'
71
78
        root_id = elt.get('file_id') or ROOT_ID
72
79
        inv = Inventory(root_id)
73
80
        for e in elt:
74
 
            ie = self._unpack_entry(e, entry_cache=entry_cache)
 
81
            ie = self._unpack_entry(e)
75
82
            if ie.parent_id == ROOT_ID:
76
83
                ie.parent_id = root_id
77
84
            inv.add(ie)
78
85
        return inv
79
86
 
80
87
 
81
 
    def _unpack_entry(self, elt, entry_cache=None):
 
88
    def _unpack_entry(self, elt):
 
89
        assert elt.tag == 'entry'
 
90
 
82
91
        ## original format inventories don't have a parent_id for
83
92
        ## nodes in the root directory, but it's cleaner to use one
84
93
        ## internally.
85
94
        parent_id = elt.get('parent_id')
86
 
        if parent_id is None:
 
95
        if parent_id == None:
87
96
            parent_id = ROOT_ID
88
97
 
89
98
        kind = elt.get('kind')
107
116
        else:
108
117
            raise BzrError("unknown kind %r" % kind)
109
118
 
110
 
        ## mutter("read inventoryentry: %r", elt.attrib)
 
119
        ## mutter("read inventoryentry: %r" % (elt.attrib))
111
120
 
112
121
        return ie
113
122
 
126
135
        root.text = '\n'
127
136
 
128
137
        msg = SubElement(root, 'message')
129
 
        msg.text = escape_invalid_chars(rev.message)[0]
 
138
        msg.text = rev.message
130
139
        msg.tail = '\n'
131
140
 
132
141
        if rev.parents:
135
144
            for i, parent_id in enumerate(rev.parents):
136
145
                p = SubElement(pelts, 'revision_ref')
137
146
                p.tail = '\n'
 
147
                assert parent_id
138
148
                p.set('revision_id', parent_id)
139
149
                if i < len(rev.parent_sha1s):
140
150
                    p.set('revision_sha1', rev.parent_sha1s[i])
141
151
        return root
142
152
 
143
 
 
 
153
    
144
154
    def _unpack_revision(self, elt):
145
155
        """XML Element -> Revision object"""
146
 
 
 
156
        
147
157
        # <changeset> is deprecated...
148
158
        if elt.tag not in ('revision', 'changeset'):
149
159
            raise BzrError("unexpected tag in revision file: %r" % elt)
162
172
 
163
173
        if pelts:
164
174
            for p in pelts:
 
175
                assert p.tag == 'revision_ref', \
 
176
                       "bad parent node tag %r" % p.tag
165
177
                rev.parent_ids.append(p.get('revision_id'))
166
178
                rev.parent_sha1s.append(p.get('revision_sha1'))
167
179
            if precursor:
168
180
                # must be consistent
169
181
                prec_parent = rev.parent_ids[0]
 
182
                assert prec_parent == precursor
170
183
        elif precursor:
171
184
            # revisions written prior to 0.0.5 have a single precursor
172
185
            # give as an attribute