← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Martin Pool
  • Date: 2005-05-06 02:34:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050506023454-7118a1b22e8515bc
- ignore any diff files lying around in tree

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
18
 
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
19
 
import bzrlib.inventory as inventory
20
 
from bzrlib.revision import Revision
21
 
from bzrlib.errors import BzrError
22
 
 
23
 
 
24
 
class _Serializer_v4(Serializer):
25
 
    """Version 0.0.4 serializer
26
 
 
27
 
    You should use the serializer_v4 singleton.
28
 
    
29
 
    v4 serialisation is no longer supported, only deserialisation.
30
 
    """
31
 
    
32
 
    __slots__ = []
33
 
    
34
 
    def _pack_entry(self, ie):
35
 
        """Convert InventoryEntry to XML element"""
36
 
        e = Element('entry')
37
 
        e.set('name', ie.name)
38
 
        e.set('file_id', ie.file_id)
39
 
        e.set('kind', ie.kind)
40
 
 
41
 
        if ie.text_size is not None:
42
 
            e.set('text_size', '%d' % ie.text_size)
43
 
 
44
 
        for f in ['text_id', 'text_sha1', 'symlink_target']:
45
 
            v = getattr(ie, f)
46
 
            if v is not None:
47
 
                e.set(f, v)
48
 
 
49
 
        # to be conservative, we don't externalize the root pointers
50
 
        # for now, leaving them as null in the xml form.  in a future
51
 
        # version it will be implied by nested elements.
52
 
        if ie.parent_id != ROOT_ID:
53
 
            e.set('parent_id', ie.parent_id)
54
 
 
55
 
        e.tail = '\n'
56
 
 
57
 
        return e
58
 
 
59
 
 
60
 
    def _unpack_inventory(self, elt, revision_id=None):
61
 
        """Construct from XML Element
62
 
 
63
 
        :param revision_id: Ignored parameter used by xml5.
64
 
        """
65
 
        root_id = elt.get('file_id') or ROOT_ID
66
 
        inv = Inventory(root_id)
67
 
        for e in elt:
68
 
            ie = self._unpack_entry(e)
69
 
            if ie.parent_id == ROOT_ID:
70
 
                ie.parent_id = root_id
71
 
            inv.add(ie)
72
 
        return inv
73
 
 
74
 
 
75
 
    def _unpack_entry(self, elt):
76
 
        ## original format inventories don't have a parent_id for
77
 
        ## nodes in the root directory, but it's cleaner to use one
78
 
        ## internally.
79
 
        parent_id = elt.get('parent_id')
80
 
        if parent_id is None:
81
 
            parent_id = ROOT_ID
82
 
 
83
 
        kind = elt.get('kind')
84
 
        if kind == 'directory':
85
 
            ie = inventory.InventoryDirectory(elt.get('file_id'),
86
 
                                              elt.get('name'),
87
 
                                              parent_id)
88
 
        elif kind == 'file':
89
 
            ie = inventory.InventoryFile(elt.get('file_id'),
90
 
                                         elt.get('name'),
91
 
                                         parent_id)
92
 
            ie.text_id = elt.get('text_id')
93
 
            ie.text_sha1 = elt.get('text_sha1')
94
 
            v = elt.get('text_size')
95
 
            ie.text_size = v and int(v)
96
 
        elif kind == 'symlink':
97
 
            ie = inventory.InventoryLink(elt.get('file_id'),
98
 
                                         elt.get('name'),
99
 
                                         parent_id)
100
 
            ie.symlink_target = elt.get('symlink_target')
101
 
        else:
102
 
            raise BzrError("unknown kind %r" % kind)
103
 
 
104
 
        ## mutter("read inventoryentry: %r", elt.attrib)
105
 
 
106
 
        return ie
107
 
 
108
 
 
109
 
    def _pack_revision(self, rev):
110
 
        """Revision object -> xml tree"""
111
 
        root = Element('revision',
112
 
                       committer = rev.committer,
113
 
                       timestamp = '%.9f' % rev.timestamp,
114
 
                       revision_id = rev.revision_id,
115
 
                       inventory_id = rev.inventory_id,
116
 
                       inventory_sha1 = rev.inventory_sha1,
117
 
                       )
118
 
        if rev.timezone:
119
 
            root.set('timezone', str(rev.timezone))
120
 
        root.text = '\n'
121
 
 
122
 
        msg = SubElement(root, 'message')
123
 
        msg.text = rev.message
124
 
        msg.tail = '\n'
125
 
 
126
 
        if rev.parents:
127
 
            pelts = SubElement(root, 'parents')
128
 
            pelts.tail = pelts.text = '\n'
129
 
            for i, parent_id in enumerate(rev.parents):
130
 
                p = SubElement(pelts, 'revision_ref')
131
 
                p.tail = '\n'
132
 
                p.set('revision_id', parent_id)
133
 
                if i < len(rev.parent_sha1s):
134
 
                    p.set('revision_sha1', rev.parent_sha1s[i])
135
 
        return root
136
 
 
137
 
    
138
 
    def _unpack_revision(self, elt):
139
 
        """XML Element -> Revision object"""
140
 
        
141
 
        # <changeset> is deprecated...
142
 
        if elt.tag not in ('revision', 'changeset'):
143
 
            raise BzrError("unexpected tag in revision file: %r" % elt)
144
 
 
145
 
        rev = Revision(committer = elt.get('committer'),
146
 
                       timestamp = float(elt.get('timestamp')),
147
 
                       revision_id = elt.get('revision_id'),
148
 
                       inventory_id = elt.get('inventory_id'),
149
 
                       inventory_sha1 = elt.get('inventory_sha1')
150
 
                       )
151
 
 
152
 
        precursor = elt.get('precursor')
153
 
        precursor_sha1 = elt.get('precursor_sha1')
154
 
 
155
 
        pelts = elt.find('parents')
156
 
 
157
 
        if pelts:
158
 
            for p in pelts:
159
 
                rev.parent_ids.append(p.get('revision_id'))
160
 
                rev.parent_sha1s.append(p.get('revision_sha1'))
161
 
            if precursor:
162
 
                # must be consistent
163
 
                prec_parent = rev.parent_ids[0]
164
 
        elif precursor:
165
 
            # revisions written prior to 0.0.5 have a single precursor
166
 
            # give as an attribute
167
 
            rev.parent_ids.append(precursor)
168
 
            rev.parent_sha1s.append(precursor_sha1)
169
 
 
170
 
        v = elt.get('timezone')
171
 
        rev.timezone = v and int(v)
172
 
 
173
 
        rev.message = elt.findtext('message') # text of <message>
174
 
        return rev
175
 
 
176
 
 
177
 
 
178
 
 
179
 
"""singleton instance"""
180
 
serializer_v4 = _Serializer_v4()
181