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
18
from bzrlib.xml import ElementTree, SubElement, Element, Serializer
19
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
20
from bzrlib.revision import Revision
21
from bzrlib.errors import BzrError
27
class Serializer_v5(Serializer):
28
"""Version 5 serializer
30
Packs objects into XML and vice versa.
35
def _pack_inventory(self, inv):
36
"""Convert to XML Element"""
37
e = Element('inventory')
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))
46
def _pack_entry(self, ie):
47
"""Convert InventoryEntry to XML element"""
48
assert ie.kind in ('directory', 'file', 'symlink')
50
e.set('name', ie.name)
51
e.set('file_id', ie.file_id)
53
if ie.text_size != None:
54
e.set('text_size', '%d' % ie.text_size)
56
for f in ['text_sha1', 'revision', 'symlink_target']:
62
e.set('executable', 'yes')
64
# to be conservative, we don't externalize the root pointers
65
# for now, leaving them as null in the xml form. in a future
66
# version it will be implied by nested elements.
67
if ie.parent_id != ROOT_ID:
68
assert isinstance(ie.parent_id, basestring)
69
e.set('parent_id', ie.parent_id)
76
def _pack_revision(self, rev):
77
"""Revision object -> xml tree"""
78
root = Element('revision',
79
committer = rev.committer,
80
timestamp = '%.9f' % rev.timestamp,
81
revision_id = rev.revision_id,
82
inventory_sha1 = rev.inventory_sha1,
85
root.set('timezone', str(rev.timezone))
88
msg = SubElement(root, 'message')
89
msg.text = rev.message
93
pelts = SubElement(root, 'parents')
94
pelts.tail = pelts.text = '\n'
95
for parent_id in rev.parent_ids:
96
assert isinstance(parent_id, basestring)
97
p = SubElement(pelts, 'revision_ref')
99
p.set('revision_id', parent_id)
104
def _unpack_inventory(self, elt):
105
"""Construct from XML Element
107
assert elt.tag == 'inventory'
108
root_id = elt.get('file_id') or ROOT_ID
109
inv = Inventory(root_id)
111
ie = self._unpack_entry(e)
112
if ie.parent_id == ROOT_ID:
113
ie.parent_id = root_id
118
def _unpack_entry(self, elt):
120
if not kind in ('directory', 'file', 'symlink'):
121
raise AssertionError('unsupported entry kind %s' % kind)
123
parent_id = elt.get('parent_id')
124
if parent_id == None:
127
ie = InventoryEntry(elt.get('file_id'),
131
ie.revision = elt.get('revision')
132
ie.text_sha1 = elt.get('text_sha1')
133
ie.symlink_target = elt.get('symlink_target')
134
if elt.get('executable') == 'yes':
136
v = elt.get('text_size')
137
ie.text_size = v and int(v)
142
def _unpack_revision(self, elt):
143
"""XML Element -> Revision object"""
144
assert elt.tag == 'revision'
146
rev = Revision(committer = elt.get('committer'),
147
timestamp = float(elt.get('timestamp')),
148
revision_id = elt.get('revision_id'),
149
inventory_sha1 = elt.get('inventory_sha1')
152
parents = elt.find('parents') or []
154
assert p.tag == 'revision_ref', \
155
"bad parent node tag %r" % p.tag
156
rev.parent_ids.append(p.get('revision_id'))
158
v = elt.get('timezone')
159
rev.timezone = v and int(v)
161
rev.message = elt.findtext('message') # text of <message>
166
serializer_v5 = Serializer_v5()