1
# Copyright (C) 2005-2010 Canonical Ltd
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
11
# GNU General Public License for more details.
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
17
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
18
import bzrlib.inventory as inventory
19
from bzrlib.revision import Revision
20
from bzrlib.errors import BzrError
27
class _Serializer_v4(Serializer):
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from ...bzr.xml_serializer import (
25
from ...bzr.inventory import ROOT_ID, Inventory
26
from ...bzr import inventory
27
from ...revision import Revision
28
from ...errors import BzrError
31
class _Serializer_v4(XMLSerializer):
28
32
"""Version 0.0.4 serializer
30
You should use the serialzer_v4 singleton."""
34
You should use the serializer_v4 singleton.
36
v4 serialisation is no longer supported, only deserialisation.
34
def _pack_inventory(self, inv):
35
"""Convert to XML Element"""
36
e = Element('inventory')
38
if inv.root.file_id not in (None, ROOT_ID):
39
e.set('file_id', inv.root.file_id)
40
for path, ie in inv.iter_entries():
41
e.append(self._pack_entry(ie))
45
41
def _pack_entry(self, ie):
46
42
"""Convert InventoryEntry to XML element"""
47
43
e = Element('entry')
48
44
e.set('name', ie.name)
49
e.set('file_id', ie.file_id)
45
e.set('file_id', ie.file_id.decode('ascii'))
50
46
e.set('kind', ie.kind)
52
if ie.text_size != None:
48
if ie.text_size is not None:
53
49
e.set('text_size', '%d' % ie.text_size)
55
51
for f in ['text_id', 'text_sha1', 'symlink_target']:
60
56
# to be conservative, we don't externalize the root pointers
61
57
# for now, leaving them as null in the xml form. in a future
62
58
# version it will be implied by nested elements.
63
59
if ie.parent_id != ROOT_ID:
64
assert isinstance(ie.parent_id, basestring)
65
60
e.set('parent_id', ie.parent_id)
72
def _unpack_inventory(self, elt):
66
def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
67
return_from_cache=False):
73
68
"""Construct from XML Element
70
:param revision_id: Ignored parameter used by xml5.
75
assert elt.tag == 'inventory'
76
root_id = elt.get('file_id') or ROOT_ID
72
root_id = elt.get('file_id')
73
root_id = (root_id.encode('ascii') if root_id else ROOT_ID)
77
74
inv = Inventory(root_id)
79
ie = self._unpack_entry(e)
76
ie = self._unpack_entry(e, entry_cache=entry_cache,
77
return_from_cache=return_from_cache)
80
78
if ie.parent_id == ROOT_ID:
81
79
ie.parent_id = root_id
86
def _unpack_entry(self, elt):
87
assert elt.tag == 'entry'
89
## original format inventories don't have a parent_id for
90
## nodes in the root directory, but it's cleaner to use one
83
def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
84
# original format inventories don't have a parent_id for
85
# nodes in the root directory, but it's cleaner to use one
92
87
parent_id = elt.get('parent_id')
88
parent_id = (parent_id.encode('ascii') if parent_id else ROOT_ID)
90
file_id = elt.get('file_id').encode('ascii')
96
91
kind = elt.get('kind')
97
92
if kind == 'directory':
98
ie = inventory.InventoryDirectory(elt.get('file_id'),
93
ie = inventory.InventoryDirectory(file_id,
101
96
elif kind == 'file':
102
ie = inventory.InventoryFile(elt.get('file_id'),
97
ie = inventory.InventoryFile(file_id,
105
100
ie.text_id = elt.get('text_id')
101
if ie.text_id is not None:
102
ie.text_id = ie.text_id.encode('utf-8')
106
103
ie.text_sha1 = elt.get('text_sha1')
104
if ie.text_sha1 is not None:
105
ie.text_sha1 = ie.text_sha1.encode('ascii')
107
106
v = elt.get('text_size')
108
107
ie.text_size = v and int(v)
109
108
elif kind == 'symlink':
110
ie = inventory.InventoryLink(elt.get('file_id'),
109
ie = inventory.InventoryLink(file_id,
113
112
ie.symlink_target = elt.get('symlink_target')
122
120
def _pack_revision(self, rev):
123
121
"""Revision object -> xml tree"""
124
122
root = Element('revision',
125
committer = rev.committer,
126
timestamp = '%.9f' % rev.timestamp,
127
revision_id = rev.revision_id,
128
inventory_id = rev.inventory_id,
129
inventory_sha1 = rev.inventory_sha1,
123
committer=rev.committer,
124
timestamp='%.9f' % rev.timestamp,
125
revision_id=rev.revision_id,
126
inventory_id=rev.inventory_id,
127
inventory_sha1=rev.inventory_sha1,
132
130
root.set('timezone', str(rev.timezone))
135
133
msg = SubElement(root, 'message')
136
msg.text = rev.message
134
msg.text = escape_invalid_chars(rev.message)[0]
142
140
for i, parent_id in enumerate(rev.parents):
143
141
p = SubElement(pelts, 'revision_ref')
146
143
p.set('revision_id', parent_id)
147
144
if i < len(rev.parent_sha1s):
148
145
p.set('revision_sha1', rev.parent_sha1s[i])
152
148
def _unpack_revision(self, elt):
153
149
"""XML Element -> Revision object"""
155
151
# <changeset> is deprecated...
156
152
if elt.tag not in ('revision', 'changeset'):
157
153
raise BzrError("unexpected tag in revision file: %r" % elt)
159
rev = Revision(committer = elt.get('committer'),
160
timestamp = float(elt.get('timestamp')),
161
revision_id = elt.get('revision_id'),
162
inventory_id = elt.get('inventory_id'),
163
inventory_sha1 = elt.get('inventory_sha1')
155
rev = Revision(committer=elt.get('committer'),
156
timestamp=float(elt.get('timestamp')),
157
revision_id=elt.get('revision_id'),
158
inventory_id=elt.get('inventory_id'),
159
inventory_sha1=elt.get('inventory_sha1')
166
162
precursor = elt.get('precursor')