/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/xml4.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-20 08:56:45 UTC
  • mfrom: (4526.9.23 apply-inventory-delta)
  • Revision ID: pqm@pqm.ubuntu.com-20090720085645-54mtgybxua0yx6hw
(robertc) Add checks for inventory deltas which try to ensure that
        deltas that are not an exact fit are not applied. (Robert
        Collins, bug 397705, bug 367633)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
from bzrlib.xml_serializer import (
 
18
    Element,
 
19
    ElementTree,
 
20
    SubElement,
 
21
    XMLSerializer,
 
22
    escape_invalid_chars,
 
23
    )
 
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
 
28
 
 
29
 
 
30
class _Serializer_v4(XMLSerializer):
 
31
    """Version 0.0.4 serializer
 
32
 
 
33
    You should use the serializer_v4 singleton.
 
34
 
 
35
    v4 serialisation is no longer supported, only deserialisation.
 
36
    """
 
37
 
 
38
    __slots__ = []
 
39
 
 
40
    def _pack_entry(self, ie):
 
41
        """Convert InventoryEntry to XML element"""
 
42
        e = Element('entry')
 
43
        e.set('name', ie.name)
 
44
        e.set('file_id', ie.file_id)
 
45
        e.set('kind', ie.kind)
 
46
 
 
47
        if ie.text_size is not None:
 
48
            e.set('text_size', '%d' % ie.text_size)
 
49
 
 
50
        for f in ['text_id', 'text_sha1', 'symlink_target']:
 
51
            v = getattr(ie, f)
 
52
            if v is not None:
 
53
                e.set(f, v)
 
54
 
 
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)
 
60
 
 
61
        e.tail = '\n'
 
62
 
 
63
        return e
 
64
 
 
65
 
 
66
    def _unpack_inventory(self, elt, revision_id=None, entry_cache=None):
 
67
        """Construct from XML Element
 
68
 
 
69
        :param revision_id: Ignored parameter used by xml5.
 
70
        """
 
71
        root_id = elt.get('file_id') or ROOT_ID
 
72
        inv = Inventory(root_id)
 
73
        for e in elt:
 
74
            ie = self._unpack_entry(e, entry_cache=entry_cache)
 
75
            if ie.parent_id == ROOT_ID:
 
76
                ie.parent_id = root_id
 
77
            inv.add(ie)
 
78
        return inv
 
79
 
 
80
 
 
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
 
84
        ## internally.
 
85
        parent_id = elt.get('parent_id')
 
86
        if parent_id is None:
 
87
            parent_id = ROOT_ID
 
88
 
 
89
        kind = elt.get('kind')
 
90
        if kind == 'directory':
 
91
            ie = inventory.InventoryDirectory(elt.get('file_id'),
 
92
                                              elt.get('name'),
 
93
                                              parent_id)
 
94
        elif kind == 'file':
 
95
            ie = inventory.InventoryFile(elt.get('file_id'),
 
96
                                         elt.get('name'),
 
97
                                         parent_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'),
 
104
                                         elt.get('name'),
 
105
                                         parent_id)
 
106
            ie.symlink_target = elt.get('symlink_target')
 
107
        else:
 
108
            raise BzrError("unknown kind %r" % kind)
 
109
 
 
110
        ## mutter("read inventoryentry: %r", elt.attrib)
 
111
 
 
112
        return ie
 
113
 
 
114
 
 
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,
 
123
                       )
 
124
        if rev.timezone:
 
125
            root.set('timezone', str(rev.timezone))
 
126
        root.text = '\n'
 
127
 
 
128
        msg = SubElement(root, 'message')
 
129
        msg.text = escape_invalid_chars(rev.message)[0]
 
130
        msg.tail = '\n'
 
131
 
 
132
        if rev.parents:
 
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')
 
137
                p.tail = '\n'
 
138
                p.set('revision_id', parent_id)
 
139
                if i < len(rev.parent_sha1s):
 
140
                    p.set('revision_sha1', rev.parent_sha1s[i])
 
141
        return root
 
142
 
 
143
 
 
144
    def _unpack_revision(self, elt):
 
145
        """XML Element -> Revision object"""
 
146
 
 
147
        # <changeset> is deprecated...
 
148
        if elt.tag not in ('revision', 'changeset'):
 
149
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
150
 
 
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')
 
156
                       )
 
157
 
 
158
        precursor = elt.get('precursor')
 
159
        precursor_sha1 = elt.get('precursor_sha1')
 
160
 
 
161
        pelts = elt.find('parents')
 
162
 
 
163
        if pelts:
 
164
            for p in pelts:
 
165
                rev.parent_ids.append(p.get('revision_id'))
 
166
                rev.parent_sha1s.append(p.get('revision_sha1'))
 
167
            if precursor:
 
168
                # must be consistent
 
169
                prec_parent = rev.parent_ids[0]
 
170
        elif precursor:
 
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)
 
175
 
 
176
        v = elt.get('timezone')
 
177
        rev.timezone = v and int(v)
 
178
 
 
179
        rev.message = elt.findtext('message') # text of <message>
 
180
        return rev
 
181
 
 
182
 
 
183
 
 
184
 
 
185
"""singleton instance"""
 
186
serializer_v4 = _Serializer_v4()
 
187