1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.xml_serializer import (
25
from bzrlib.inventory import ROOT_ID, Inventory
26
import bzrlib.inventory as inventory
27
from bzrlib.revision import Revision
28
from bzrlib.errors import BzrError
31
class _Serializer_v4(XMLSerializer):
32
"""Version 0.0.4 serializer
34
You should use the serializer_v4 singleton.
36
v4 serialisation is no longer supported, only deserialisation.
41
def _pack_entry(self, ie):
42
"""Convert InventoryEntry to XML element"""
44
e.set('name', ie.name)
45
e.set('file_id', ie.file_id)
46
e.set('kind', ie.kind)
48
if ie.text_size is not None:
49
e.set('text_size', '%d' % ie.text_size)
51
for f in ['text_id', 'text_sha1', 'symlink_target']:
56
# to be conservative, we don't externalize the root pointers
57
# for now, leaving them as null in the xml form. in a future
58
# version it will be implied by nested elements.
59
if ie.parent_id != ROOT_ID:
60
e.set('parent_id', ie.parent_id)
67
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
68
return_from_cache=False):
69
"""Construct from XML Element
71
:param revision_id: Ignored parameter used by xml5.
73
root_id = elt.get('file_id') or ROOT_ID
74
inv = Inventory(root_id)
76
ie = self._unpack_entry(e, entry_cache=entry_cache,
77
return_from_cache=return_from_cache)
78
if ie.parent_id == ROOT_ID:
79
ie.parent_id = root_id
84
def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
85
## original format inventories don't have a parent_id for
86
## nodes in the root directory, but it's cleaner to use one
88
parent_id = elt.get('parent_id')
92
kind = elt.get('kind')
93
if kind == 'directory':
94
ie = inventory.InventoryDirectory(elt.get('file_id'),
98
ie = inventory.InventoryFile(elt.get('file_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'),
109
ie.symlink_target = elt.get('symlink_target')
111
raise BzrError("unknown kind %r" % kind)
113
## mutter("read inventoryentry: %r", elt.attrib)
118
def _pack_revision(self, rev):
119
"""Revision object -> xml tree"""
120
root = Element('revision',
121
committer = rev.committer,
122
timestamp = '%.9f' % rev.timestamp,
123
revision_id = rev.revision_id,
124
inventory_id = rev.inventory_id,
125
inventory_sha1 = rev.inventory_sha1,
128
root.set('timezone', str(rev.timezone))
131
msg = SubElement(root, 'message')
132
msg.text = escape_invalid_chars(rev.message)[0]
136
pelts = SubElement(root, 'parents')
137
pelts.tail = pelts.text = '\n'
138
for i, parent_id in enumerate(rev.parents):
139
p = SubElement(pelts, 'revision_ref')
141
p.set('revision_id', parent_id)
142
if i < len(rev.parent_sha1s):
143
p.set('revision_sha1', rev.parent_sha1s[i])
147
def _unpack_revision(self, elt):
148
"""XML Element -> Revision object"""
150
# <changeset> is deprecated...
151
if elt.tag not in ('revision', 'changeset'):
152
raise BzrError("unexpected tag in revision file: %r" % elt)
154
rev = Revision(committer = elt.get('committer'),
155
timestamp = float(elt.get('timestamp')),
156
revision_id = elt.get('revision_id'),
157
inventory_id = elt.get('inventory_id'),
158
inventory_sha1 = elt.get('inventory_sha1')
161
precursor = elt.get('precursor')
162
precursor_sha1 = elt.get('precursor_sha1')
164
pelts = elt.find('parents')
168
rev.parent_ids.append(p.get('revision_id'))
169
rev.parent_sha1s.append(p.get('revision_sha1'))
172
prec_parent = rev.parent_ids[0]
174
# revisions written prior to 0.0.5 have a single precursor
175
# give as an attribute
176
rev.parent_ids.append(precursor)
177
rev.parent_sha1s.append(precursor_sha1)
179
v = elt.get('timezone')
180
rev.timezone = v and int(v)
182
rev.message = elt.findtext('message') # text of <message>
188
"""singleton instance"""
189
serializer_v4 = _Serializer_v4()