~bzr-pqm/bzr/bzr.dev

1189 by Martin Pool
- BROKEN: partial support for commit into weave
1
# This program is free software; you can redistribute it and/or modify
2
# it under the terms of the GNU General Public License as published by
3
# the Free Software Foundation; either version 2 of the License, or
4
# (at your option) any later version.
5
6
# This program is distributed in the hope that it will be useful,
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
# GNU General Public License for more details.
10
11
# You should have received a copy of the GNU General Public License
12
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
15
1540.1.6 by John Arbash Meinel
fileid_involved needs to unescape the file id and revision id
16
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
1189 by Martin Pool
- BROKEN: partial support for commit into weave
17
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
18
import bzrlib.inventory as inventory
1311 by Martin Pool
- remove RevisionReference; just hold parent ids directly
19
from bzrlib.revision import Revision        
1189 by Martin Pool
- BROKEN: partial support for commit into weave
20
from bzrlib.errors import BzrError
21
22
23
class Serializer_v5(Serializer):
24
    """Version 5 serializer
25
26
    Packs objects into XML and vice versa.
27
    """
28
    
29
    __slots__ = []
30
    
31
    def _pack_inventory(self, inv):
32
        """Convert to XML Element"""
1393.1.59 by Martin Pool
- put 'format=5' on inventory and revision xml
33
        e = Element('inventory',
34
                    format='5')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
35
        e.text = '\n'
36
        if inv.root.file_id not in (None, ROOT_ID):
37
            e.set('file_id', inv.root.file_id)
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
38
        if inv.revision_id is not None:
39
            e.set('revision_id', inv.revision_id)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
40
        for path, ie in inv.iter_entries():
41
            e.append(self._pack_entry(ie))
42
        return e
43
44
    def _pack_entry(self, ie):
45
        """Convert InventoryEntry to XML element"""
1704.2.24 by Martin Pool
todo
46
        # TODO: should just be a plain assertion
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
47
        if not InventoryEntry.versionable_kind(ie.kind):
48
            raise AssertionError('unsupported entry kind %s' % ie.kind)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
49
        e = Element(ie.kind)
50
        e.set('name', ie.name)
51
        e.set('file_id', ie.file_id)
52
53
        if ie.text_size != None:
54
            e.set('text_size', '%d' % ie.text_size)
55
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
56
        for f in ['text_sha1', 'revision', 'symlink_target']:
1189 by Martin Pool
- BROKEN: partial support for commit into weave
57
            v = getattr(ie, f)
58
            if v != None:
59
                e.set(f, v)
60
1398 by Robert Collins
integrate in Gustavos x-bit patch
61
        if ie.executable:
62
            e.set('executable', 'yes')
63
1189 by Martin Pool
- BROKEN: partial support for commit into weave
64
        # to be conservative, we don't externalize the root pointers
65
        # for now, leaving them as null in the xml form.  in a future
66
        # version it will be implied by nested elements.
67
        if ie.parent_id != ROOT_ID:
68
            assert isinstance(ie.parent_id, basestring)
69
            e.set('parent_id', ie.parent_id)
70
        e.tail = '\n'
71
        return e
72
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,
1393.1.59 by Martin Pool
- put 'format=5' on inventory and revision xml
80
                       format='5',
1189 by Martin Pool
- BROKEN: partial support for commit into weave
81
                       )
82
        if rev.timezone:
83
            root.set('timezone', str(rev.timezone))
84
        root.text = '\n'
85
        msg = SubElement(root, 'message')
86
        msg.text = rev.message
87
        msg.tail = '\n'
1313 by Martin Pool
- rename to Revision.parent_ids to avoid confusion with old usage
88
        if rev.parent_ids:
1189 by Martin Pool
- BROKEN: partial support for commit into weave
89
            pelts = SubElement(root, 'parents')
90
            pelts.tail = pelts.text = '\n'
1313 by Martin Pool
- rename to Revision.parent_ids to avoid confusion with old usage
91
            for parent_id in rev.parent_ids:
1311 by Martin Pool
- remove RevisionReference; just hold parent ids directly
92
                assert isinstance(parent_id, basestring)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
93
                p = SubElement(pelts, 'revision_ref')
94
                p.tail = '\n'
1311 by Martin Pool
- remove RevisionReference; just hold parent ids directly
95
                p.set('revision_id', parent_id)
1185.16.36 by Martin Pool
- store revision properties in revision xml
96
        if rev.properties:
97
            self._pack_revision_properties(rev, root)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
98
        return root
1185.16.36 by Martin Pool
- store revision properties in revision xml
99
100
101
    def _pack_revision_properties(self, rev, under_element):
102
        top_elt = SubElement(under_element, 'properties')
103
        for prop_name, prop_value in sorted(rev.properties.items()):
104
            assert isinstance(prop_name, basestring) 
105
            assert isinstance(prop_value, basestring) 
106
            prop_elt = SubElement(top_elt, 'property')
107
            prop_elt.set('name', prop_name)
108
            prop_elt.text = prop_value
109
            prop_elt.tail = '\n'
110
        top_elt.tail = '\n'
111
1189 by Martin Pool
- BROKEN: partial support for commit into weave
112
113
    def _unpack_inventory(self, elt):
114
        """Construct from XML Element
115
        """
116
        assert elt.tag == 'inventory'
117
        root_id = elt.get('file_id') or ROOT_ID
1393.1.59 by Martin Pool
- put 'format=5' on inventory and revision xml
118
        format = elt.get('format')
119
        if format is not None:
120
            if format != '5':
121
                raise BzrError("invalid format version %r on inventory"
122
                                % format)
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
123
        revision_id = elt.get('revision_id')
124
        inv = Inventory(root_id, revision_id=revision_id)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
125
        for e in elt:
126
            ie = self._unpack_entry(e)
127
            if ie.parent_id == ROOT_ID:
128
                ie.parent_id = root_id
129
            inv.add(ie)
130
        return inv
131
132
133
    def _unpack_entry(self, elt):
134
        kind = elt.tag
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
135
        if not InventoryEntry.versionable_kind(kind):
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
136
            raise AssertionError('unsupported entry kind %s' % kind)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
137
138
        parent_id = elt.get('parent_id')
139
        if parent_id == None:
140
            parent_id = ROOT_ID
141
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
142
        if kind == 'directory':
143
            ie = inventory.InventoryDirectory(elt.get('file_id'),
144
                                              elt.get('name'),
145
                                              parent_id)
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
146
        elif kind == 'file':
147
            ie = inventory.InventoryFile(elt.get('file_id'),
148
                                         elt.get('name'),
149
                                         parent_id)
150
            ie.text_sha1 = elt.get('text_sha1')
151
            if elt.get('executable') == 'yes':
152
                ie.executable = True
153
            v = elt.get('text_size')
154
            ie.text_size = v and int(v)
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
155
        elif kind == 'symlink':
156
            ie = inventory.InventoryLink(elt.get('file_id'),
157
                                         elt.get('name'),
158
                                         parent_id)
159
            ie.symlink_target = elt.get('symlink_target')
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
160
        else:
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
161
            raise BzrError("unknown kind %r" % kind)
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
162
        ie.revision = elt.get('revision')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
163
164
        return ie
165
166
167
    def _unpack_revision(self, elt):
168
        """XML Element -> Revision object"""
169
        assert elt.tag == 'revision'
1393.1.59 by Martin Pool
- put 'format=5' on inventory and revision xml
170
        format = elt.get('format')
171
        if format is not None:
172
            if format != '5':
173
                raise BzrError("invalid format version %r on inventory"
174
                                % format)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
175
        rev = Revision(committer = elt.get('committer'),
176
                       timestamp = float(elt.get('timestamp')),
177
                       revision_id = elt.get('revision_id'),
178
                       inventory_sha1 = elt.get('inventory_sha1')
179
                       )
180
        parents = elt.find('parents') or []
181
        for p in parents:
182
            assert p.tag == 'revision_ref', \
183
                   "bad parent node tag %r" % p.tag
1313 by Martin Pool
- rename to Revision.parent_ids to avoid confusion with old usage
184
            rev.parent_ids.append(p.get('revision_id'))
1185.16.37 by Martin Pool
- properties are retrieved when revisions are loaded
185
        self._unpack_revision_properties(elt, rev)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
186
        v = elt.get('timezone')
187
        rev.timezone = v and int(v)
188
        rev.message = elt.findtext('message') # text of <message>
189
        return rev
190
191
1185.16.37 by Martin Pool
- properties are retrieved when revisions are loaded
192
    def _unpack_revision_properties(self, elt, rev):
193
        """Unpack properties onto a revision."""
194
        props_elt = elt.find('properties')
195
        assert len(rev.properties) == 0
196
        if not props_elt:
197
            return
198
        for prop_elt in props_elt:
199
            assert prop_elt.tag == 'property', \
200
                "bad tag under properties list: %r" % p.tag
201
            name = prop_elt.get('name')
202
            value = prop_elt.text
203
            assert name not in rev.properties, \
204
                "repeated property %r" % p.name
205
            rev.properties[name] = value
206
207
1189 by Martin Pool
- BROKEN: partial support for commit into weave
208
serializer_v5 = Serializer_v5()