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 == 'directory' or ie.kind == 'file'
 
 
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_version', 'text_sha1', 'name_version']:
 
 
61
        # to be conservative, we don't externalize the root pointers
 
 
62
        # for now, leaving them as null in the xml form.  in a future
 
 
63
        # version it will be implied by nested elements.
 
 
64
        if ie.parent_id != ROOT_ID:
 
 
65
            assert isinstance(ie.parent_id, basestring)
 
 
66
            e.set('parent_id', ie.parent_id)
 
 
73
    def _pack_revision(self, rev):
 
 
74
        """Revision object -> xml tree"""
 
 
75
        root = Element('revision',
 
 
76
                       committer = rev.committer,
 
 
77
                       timestamp = '%.9f' % rev.timestamp,
 
 
78
                       revision_id = rev.revision_id,
 
 
79
                       inventory_sha1 = rev.inventory_sha1,
 
 
82
            root.set('timezone', str(rev.timezone))
 
 
85
        msg = SubElement(root, 'message')
 
 
86
        msg.text = rev.message
 
 
90
            pelts = SubElement(root, 'parents')
 
 
91
            pelts.tail = pelts.text = '\n'
 
 
92
            for parent_id in rev.parent_ids:
 
 
93
                assert isinstance(parent_id, basestring)
 
 
94
                p = SubElement(pelts, 'revision_ref')
 
 
96
                p.set('revision_id', parent_id)
 
 
101
    def _unpack_inventory(self, elt):
 
 
102
        """Construct from XML Element
 
 
104
        assert elt.tag == 'inventory'
 
 
105
        root_id = elt.get('file_id') or ROOT_ID
 
 
106
        inv = Inventory(root_id)
 
 
108
            ie = self._unpack_entry(e)
 
 
109
            if ie.parent_id == ROOT_ID:
 
 
110
                ie.parent_id = root_id
 
 
115
    def _unpack_entry(self, elt):
 
 
117
        assert kind == 'directory' or kind == 'file', \
 
 
118
            'unsupported entry kind %s' % kind
 
 
120
        parent_id = elt.get('parent_id')
 
 
121
        if parent_id == None:
 
 
124
        ie = InventoryEntry(elt.get('file_id'),
 
 
128
        ie.text_version = elt.get('text_version')
 
 
129
        ie.name_version = elt.get('name_version')
 
 
130
        ie.text_sha1 = elt.get('text_sha1')
 
 
131
        v = elt.get('text_size')
 
 
132
        ie.text_size = v and int(v)
 
 
137
    def _unpack_revision(self, elt):
 
 
138
        """XML Element -> Revision object"""
 
 
139
        assert elt.tag == 'revision'
 
 
141
        rev = Revision(committer = elt.get('committer'),
 
 
142
                       timestamp = float(elt.get('timestamp')),
 
 
143
                       revision_id = elt.get('revision_id'),
 
 
144
                       inventory_sha1 = elt.get('inventory_sha1')
 
 
147
        parents = elt.find('parents') or []
 
 
149
            assert p.tag == 'revision_ref', \
 
 
150
                   "bad parent node tag %r" % p.tag
 
 
151
            rev.parent_ids.append(p.get('revision_id'))
 
 
153
        v = elt.get('timezone')
 
 
154
        rev.timezone = v and int(v)
 
 
156
        rev.message = elt.findtext('message') # text of <message>
 
 
161
serializer_v5 = Serializer_v5()