1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
from bzrlib import cache_utf8, inventory, errors, xml5
 
 
20
class Serializer_v6(xml5.Serializer_v5):
 
 
21
    """This serialiser adds rich roots."""
 
 
26
    def _append_inventory_root(self, append, inv):
 
 
27
        """Append the inventory root to output."""
 
 
28
        if inv.revision_id is not None:
 
 
29
            revid1 = ' revision_id="'
 
 
30
            revid2 = xml5._encode_and_escape(inv.revision_id)
 
 
34
        append('<inventory format="%s"%s%s>\n' % (
 
 
35
            self.format_num, revid1, revid2))
 
 
36
        append('<directory file_id="%s name="%s revision="%s />\n' % (
 
 
37
            xml5._encode_and_escape(inv.root.file_id),
 
 
38
            xml5._encode_and_escape(inv.root.name),
 
 
39
            xml5._encode_and_escape(inv.root.revision)))
 
 
41
    def _check_revisions(self, inv):
 
 
42
        """Extension point for subclasses to check during serialisation.
 
 
44
        By default no checking is done.
 
 
46
        :param inv: An inventory about to be serialised, to be checked.
 
 
47
        :raises: AssertionError if an error has occured.
 
 
49
        assert inv.revision_id is not None
 
 
50
        assert inv.root.revision is not None
 
 
52
    def _unpack_inventory(self, elt, revision_id=None):
 
 
53
        """Construct from XML Element"""
 
 
54
        if elt.tag != 'inventory':
 
 
55
            raise errors.UnexpectedInventoryFormat('Root tag is %r' % elt.tag)
 
 
56
        format = elt.get('format')
 
 
57
        if format != self.format_num:
 
 
58
            raise errors.UnexpectedInventoryFormat('Invalid format version %r'
 
 
60
        revision_id = elt.get('revision_id')
 
 
61
        if revision_id is not None:
 
 
62
            revision_id = cache_utf8.encode(revision_id)
 
 
63
        inv = inventory.Inventory(root_id=None, revision_id=revision_id)
 
 
65
            ie = self._unpack_entry(e)
 
 
67
        assert inv.root.revision is not None
 
 
71
serializer_v6 = Serializer_v6()