← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Robert Collins
  • Date: 2007-05-07 16:48:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2485.
  • Revision ID: robertc@robertcollins.net-20070507164814-wpagonutf4b5cf8s
Move HACKING to docs/developers/HACKING and adjust Makefile to accomodate this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
16
 
 
17
 
from __future__ import absolute_import
18
 
 
19
 
from bzrlib.xml_serializer import (
20
 
    Element,
21
 
    SubElement,
22
 
    XMLSerializer,
23
 
    escape_invalid_chars,
24
 
    )
25
 
from bzrlib.inventory import ROOT_ID, Inventory
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
 
18
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
26
19
import bzrlib.inventory as inventory
27
 
from bzrlib.revision import Revision
 
20
from bzrlib.revision import Revision        
28
21
from bzrlib.errors import BzrError
29
22
 
30
23
 
31
 
class _Serializer_v4(XMLSerializer):
 
24
class _Serializer_v4(Serializer):
32
25
    """Version 0.0.4 serializer
33
26
 
34
 
    You should use the serializer_v4 singleton.
35
 
 
36
 
    v4 serialisation is no longer supported, only deserialisation.
37
 
    """
38
 
 
 
27
    You should use the serializer_v4 singleton."""
 
28
    
39
29
    __slots__ = []
 
30
    
 
31
    def _pack_inventory(self, inv):
 
32
        """Convert to XML Element"""
 
33
        # v4 serialization is not used any more.
 
34
        raise NotImplementedError(self._pack_inventory)
 
35
        e = Element('inventory')
 
36
        e.text = '\n'
 
37
        if inv.root.file_id not in (None, ROOT_ID):
 
38
            e.set('file_id', inv.root.file_id)
 
39
        for path, ie in inv.iter_entries():
 
40
            e.append(self._pack_entry(ie))
 
41
        return e
 
42
 
40
43
 
41
44
    def _pack_entry(self, ie):
42
45
        """Convert InventoryEntry to XML element"""
57
60
        # for now, leaving them as null in the xml form.  in a future
58
61
        # version it will be implied by nested elements.
59
62
        if ie.parent_id != ROOT_ID:
 
63
            assert isinstance(ie.parent_id, basestring)
60
64
            e.set('parent_id', ie.parent_id)
61
65
 
62
66
        e.tail = '\n'
64
68
        return e
65
69
 
66
70
 
67
 
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None,
68
 
                          return_from_cache=False):
 
71
    def _unpack_inventory(self, elt):
69
72
        """Construct from XML Element
70
 
 
71
 
        :param revision_id: Ignored parameter used by xml5.
72
73
        """
 
74
        assert elt.tag == 'inventory'
73
75
        root_id = elt.get('file_id') or ROOT_ID
74
76
        inv = Inventory(root_id)
75
77
        for e in elt:
76
 
            ie = self._unpack_entry(e, entry_cache=entry_cache,
77
 
                                    return_from_cache=return_from_cache)
 
78
            ie = self._unpack_entry(e)
78
79
            if ie.parent_id == ROOT_ID:
79
80
                ie.parent_id = root_id
80
81
            inv.add(ie)
81
82
        return inv
82
83
 
83
84
 
84
 
    def _unpack_entry(self, elt, entry_cache=None, return_from_cache=False):
 
85
    def _unpack_entry(self, elt):
 
86
        assert elt.tag == 'entry'
 
87
 
85
88
        ## original format inventories don't have a parent_id for
86
89
        ## nodes in the root directory, but it's cleaner to use one
87
90
        ## internally.
129
132
        root.text = '\n'
130
133
 
131
134
        msg = SubElement(root, 'message')
132
 
        msg.text = escape_invalid_chars(rev.message)[0]
 
135
        msg.text = rev.message
133
136
        msg.tail = '\n'
134
137
 
135
138
        if rev.parents:
138
141
            for i, parent_id in enumerate(rev.parents):
139
142
                p = SubElement(pelts, 'revision_ref')
140
143
                p.tail = '\n'
 
144
                assert parent_id
141
145
                p.set('revision_id', parent_id)
142
146
                if i < len(rev.parent_sha1s):
143
147
                    p.set('revision_sha1', rev.parent_sha1s[i])
144
148
        return root
145
149
 
146
 
 
 
150
    
147
151
    def _unpack_revision(self, elt):
148
152
        """XML Element -> Revision object"""
149
 
 
 
153
        
150
154
        # <changeset> is deprecated...
151
155
        if elt.tag not in ('revision', 'changeset'):
152
156
            raise BzrError("unexpected tag in revision file: %r" % elt)
165
169
 
166
170
        if pelts:
167
171
            for p in pelts:
 
172
                assert p.tag == 'revision_ref', \
 
173
                       "bad parent node tag %r" % p.tag
168
174
                rev.parent_ids.append(p.get('revision_id'))
169
175
                rev.parent_sha1s.append(p.get('revision_sha1'))
170
176
            if precursor:
171
177
                # must be consistent
172
178
                prec_parent = rev.parent_ids[0]
 
179
                assert prec_parent == precursor
173
180
        elif precursor:
174
181
            # revisions written prior to 0.0.5 have a single precursor
175
182
            # give as an attribute