1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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
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
24
class _Serializer_v4(Serializer):
25
"""Version 0.0.4 serializer
27
You should use the serializer_v4 singleton."""
31
def _pack_inventory(self, inv):
32
"""Convert to XML Element"""
33
# v4 serialization is not used any more.
34
raise NotImplementedError(self._pack_inventory)
35
e = Element('inventory')
37
if inv.root.file_id not in (None, ROOT_ID):
38
e.set('file_id', inv.root.file_id)
39
for path, ie in inv.iter_entries():
40
e.append(self._pack_entry(ie))
44
def _pack_entry(self, ie):
45
"""Convert InventoryEntry to XML element"""
47
e.set('name', ie.name)
48
e.set('file_id', ie.file_id)
49
e.set('kind', ie.kind)
51
if ie.text_size is not None:
52
e.set('text_size', '%d' % ie.text_size)
54
for f in ['text_id', 'text_sha1', 'symlink_target']:
59
# to be conservative, we don't externalize the root pointers
60
# for now, leaving them as null in the xml form. in a future
61
# version it will be implied by nested elements.
62
if ie.parent_id != ROOT_ID:
63
assert isinstance(ie.parent_id, basestring)
64
e.set('parent_id', ie.parent_id)
71
def _unpack_inventory(self, elt):
72
"""Construct from XML Element
74
assert elt.tag == 'inventory'
75
root_id = elt.get('file_id') or ROOT_ID
76
inv = Inventory(root_id)
78
ie = self._unpack_entry(e)
79
if ie.parent_id == ROOT_ID:
80
ie.parent_id = root_id
85
def _unpack_entry(self, elt):
86
assert elt.tag == 'entry'
88
## original format inventories don't have a parent_id for
89
## nodes in the root directory, but it's cleaner to use one
91
parent_id = elt.get('parent_id')
95
kind = elt.get('kind')
96
if kind == 'directory':
97
ie = inventory.InventoryDirectory(elt.get('file_id'),
101
ie = inventory.InventoryFile(elt.get('file_id'),
104
ie.text_id = elt.get('text_id')
105
ie.text_sha1 = elt.get('text_sha1')
106
v = elt.get('text_size')
107
ie.text_size = v and int(v)
108
elif kind == 'symlink':
109
ie = inventory.InventoryLink(elt.get('file_id'),
112
ie.symlink_target = elt.get('symlink_target')
114
raise BzrError("unknown kind %r" % kind)
116
## mutter("read inventoryentry: %r", elt.attrib)
121
def _pack_revision(self, rev):
122
"""Revision object -> xml tree"""
123
root = Element('revision',
124
committer = rev.committer,
125
timestamp = '%.9f' % rev.timestamp,
126
revision_id = rev.revision_id,
127
inventory_id = rev.inventory_id,
128
inventory_sha1 = rev.inventory_sha1,
131
root.set('timezone', str(rev.timezone))
134
msg = SubElement(root, 'message')
135
msg.text = rev.message
139
pelts = SubElement(root, 'parents')
140
pelts.tail = pelts.text = '\n'
141
for i, parent_id in enumerate(rev.parents):
142
p = SubElement(pelts, 'revision_ref')
145
p.set('revision_id', parent_id)
146
if i < len(rev.parent_sha1s):
147
p.set('revision_sha1', rev.parent_sha1s[i])
151
def _unpack_revision(self, elt):
152
"""XML Element -> Revision object"""
154
# <changeset> is deprecated...
155
if elt.tag not in ('revision', 'changeset'):
156
raise BzrError("unexpected tag in revision file: %r" % elt)
158
rev = Revision(committer = elt.get('committer'),
159
timestamp = float(elt.get('timestamp')),
160
revision_id = elt.get('revision_id'),
161
inventory_id = elt.get('inventory_id'),
162
inventory_sha1 = elt.get('inventory_sha1')
165
precursor = elt.get('precursor')
166
precursor_sha1 = elt.get('precursor_sha1')
168
pelts = elt.find('parents')
172
assert p.tag == 'revision_ref', \
173
"bad parent node tag %r" % p.tag
174
rev.parent_ids.append(p.get('revision_id'))
175
rev.parent_sha1s.append(p.get('revision_sha1'))
178
prec_parent = rev.parent_ids[0]
179
assert prec_parent == precursor
181
# revisions written prior to 0.0.5 have a single precursor
182
# give as an attribute
183
rev.parent_ids.append(precursor)
184
rev.parent_sha1s.append(precursor_sha1)
186
v = elt.get('timezone')
187
rev.timezone = v and int(v)
189
rev.message = elt.findtext('message') # text of <message>
195
"""singleton instance"""
196
serializer_v4 = _Serializer_v4()