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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib.xml_serializer import (
24
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
25
import bzrlib.inventory as inventory
26
from bzrlib.revision import Revision
27
from bzrlib.errors import BzrError
30
class _Serializer_v4(XMLSerializer):
31
"""Version 0.0.4 serializer
33
You should use the serializer_v4 singleton.
35
v4 serialisation is no longer supported, only deserialisation.
40
def _pack_entry(self, ie):
41
"""Convert InventoryEntry to XML element"""
43
e.set('name', ie.name)
44
e.set('file_id', ie.file_id)
45
e.set('kind', ie.kind)
47
if ie.text_size is not None:
48
e.set('text_size', '%d' % ie.text_size)
50
for f in ['text_id', 'text_sha1', 'symlink_target']:
55
# to be conservative, we don't externalize the root pointers
56
# for now, leaving them as null in the xml form. in a future
57
# version it will be implied by nested elements.
58
if ie.parent_id != ROOT_ID:
59
e.set('parent_id', ie.parent_id)
66
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None):
67
"""Construct from XML Element
69
:param revision_id: Ignored parameter used by xml5.
71
root_id = elt.get('file_id') or ROOT_ID
72
inv = Inventory(root_id)
74
ie = self._unpack_entry(e, entry_cache=entry_cache)
75
if ie.parent_id == ROOT_ID:
76
ie.parent_id = root_id
81
def _unpack_entry(self, elt, entry_cache=None):
82
## original format inventories don't have a parent_id for
83
## nodes in the root directory, but it's cleaner to use one
85
parent_id = elt.get('parent_id')
89
kind = elt.get('kind')
90
if kind == 'directory':
91
ie = inventory.InventoryDirectory(elt.get('file_id'),
95
ie = inventory.InventoryFile(elt.get('file_id'),
98
ie.text_id = elt.get('text_id')
99
ie.text_sha1 = elt.get('text_sha1')
100
v = elt.get('text_size')
101
ie.text_size = v and int(v)
102
elif kind == 'symlink':
103
ie = inventory.InventoryLink(elt.get('file_id'),
106
ie.symlink_target = elt.get('symlink_target')
108
raise BzrError("unknown kind %r" % kind)
110
## mutter("read inventoryentry: %r", elt.attrib)
115
def _pack_revision(self, rev):
116
"""Revision object -> xml tree"""
117
root = Element('revision',
118
committer = rev.committer,
119
timestamp = '%.9f' % rev.timestamp,
120
revision_id = rev.revision_id,
121
inventory_id = rev.inventory_id,
122
inventory_sha1 = rev.inventory_sha1,
125
root.set('timezone', str(rev.timezone))
128
msg = SubElement(root, 'message')
129
msg.text = escape_invalid_chars(rev.message)[0]
133
pelts = SubElement(root, 'parents')
134
pelts.tail = pelts.text = '\n'
135
for i, parent_id in enumerate(rev.parents):
136
p = SubElement(pelts, 'revision_ref')
138
p.set('revision_id', parent_id)
139
if i < len(rev.parent_sha1s):
140
p.set('revision_sha1', rev.parent_sha1s[i])
144
def _unpack_revision(self, elt):
145
"""XML Element -> Revision object"""
147
# <changeset> is deprecated...
148
if elt.tag not in ('revision', 'changeset'):
149
raise BzrError("unexpected tag in revision file: %r" % elt)
151
rev = Revision(committer = elt.get('committer'),
152
timestamp = float(elt.get('timestamp')),
153
revision_id = elt.get('revision_id'),
154
inventory_id = elt.get('inventory_id'),
155
inventory_sha1 = elt.get('inventory_sha1')
158
precursor = elt.get('precursor')
159
precursor_sha1 = elt.get('precursor_sha1')
161
pelts = elt.find('parents')
165
rev.parent_ids.append(p.get('revision_id'))
166
rev.parent_sha1s.append(p.get('revision_sha1'))
169
prec_parent = rev.parent_ids[0]
171
# revisions written prior to 0.0.5 have a single precursor
172
# give as an attribute
173
rev.parent_ids.append(precursor)
174
rev.parent_sha1s.append(precursor_sha1)
176
v = elt.get('timezone')
177
rev.timezone = v and int(v)
179
rev.message = elt.findtext('message') # text of <message>
185
"""singleton instance"""
186
serializer_v4 = _Serializer_v4()