← 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: 2005-09-28 09:35:50 UTC
  • mfrom: (1185.1.47)
  • Revision ID: robertc@robertcollins.net-20050928093550-3ca194dfaffc79f1
merge from integration

Show diffs side-by-side

added added

removed removed

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