← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/xml5.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-06-18 05:22:35 UTC
  • mfrom: (1551.15.27 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20070618052235-mvns8j28szyzscy0
Turn list-weave into list-versionedfile

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml5.py
21
21
    cache_utf8,
22
22
    errors,
23
23
    inventory,
24
 
    revision as _mod_revision,
25
24
    )
26
25
from bzrlib.xml_serializer import SubElement, Element, Serializer
27
26
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
146
145
    
147
146
    __slots__ = []
148
147
 
149
 
    root_id = ROOT_ID
150
148
    support_altered_by_hack = True
151
149
    # This format supports the altered-by hack that reads file ids directly out
152
150
    # of the versionedfile, without doing XML parsing.
153
151
 
154
152
    supported_kinds = set(['file', 'directory', 'symlink'])
155
 
    format_num = '5'
156
 
 
157
 
    def _check_revisions(self, inv):
158
 
        """Extension point for subclasses to check during serialisation.
159
 
 
160
 
        By default no checking is done.
161
 
 
162
 
        :param inv: An inventory about to be serialised, to be checked.
163
 
        :raises: AssertionError if an error has occured.
164
 
        """
165
 
 
166
 
    def write_inventory_to_lines(self, inv):
167
 
        """Return a list of lines with the encoded inventory."""
168
 
        return self.write_inventory(inv, None)
169
 
 
170
 
    def write_inventory_to_string(self, inv, working=False):
171
 
        """Just call write_inventory with a StringIO and return the value.
172
 
 
173
 
        :param working: If True skip history data - text_sha1, text_size,
174
 
            reference_revision, symlink_target.
175
 
        """
 
153
 
 
154
    def write_inventory_to_string(self, inv):
 
155
        """Just call write_inventory with a StringIO and return the value"""
176
156
        sio = cStringIO.StringIO()
177
 
        self.write_inventory(inv, sio, working)
 
157
        self.write_inventory(inv, sio)
178
158
        return sio.getvalue()
179
159
 
180
 
    def write_inventory(self, inv, f, working=False):
 
160
    def write_inventory(self, inv, f):
181
161
        """Write inventory to a file.
182
162
        
183
163
        :param inv: the inventory to write.
184
 
        :param f: the file to write. (May be None if the lines are the desired
185
 
            output).
186
 
        :param working: If True skip history data - text_sha1, text_size,
187
 
            reference_revision, symlink_target.
188
 
        :return: The inventory as a list of lines.
 
164
        :param f: the file to write.
189
165
        """
190
166
        _ensure_utf8_re()
191
 
        self._check_revisions(inv)
192
167
        output = []
193
168
        append = output.append
194
169
        self._append_inventory_root(append, inv)
196
171
        # Skip the root
197
172
        root_path, root_ie = entries.next()
198
173
        for path, ie in entries:
199
 
            if ie.parent_id != self.root_id:
200
 
                parent_str = ' parent_id="'
201
 
                parent_id  = _encode_and_escape(ie.parent_id)
202
 
            else:
203
 
                parent_str = ''
204
 
                parent_id  = ''
205
 
            if ie.kind == 'file':
206
 
                if ie.executable:
207
 
                    executable = ' executable="yes"'
208
 
                else:
209
 
                    executable = ''
210
 
                if not working:
211
 
                    append('<file%s file_id="%s name="%s%s%s revision="%s '
212
 
                        'text_sha1="%s" text_size="%d" />\n' % (
213
 
                        executable, _encode_and_escape(ie.file_id),
214
 
                        _encode_and_escape(ie.name), parent_str, parent_id,
215
 
                        _encode_and_escape(ie.revision), ie.text_sha1,
216
 
                        ie.text_size))
217
 
                else:
218
 
                    append('<file%s file_id="%s name="%s%s%s />\n' % (
219
 
                        executable, _encode_and_escape(ie.file_id),
220
 
                        _encode_and_escape(ie.name), parent_str, parent_id))
221
 
            elif ie.kind == 'directory':
222
 
                if not working:
223
 
                    append('<directory file_id="%s name="%s%s%s revision="%s '
224
 
                        '/>\n' % (
225
 
                        _encode_and_escape(ie.file_id),
226
 
                        _encode_and_escape(ie.name),
227
 
                        parent_str, parent_id,
228
 
                        _encode_and_escape(ie.revision)))
229
 
                else:
230
 
                    append('<directory file_id="%s name="%s%s%s />\n' % (
231
 
                        _encode_and_escape(ie.file_id),
232
 
                        _encode_and_escape(ie.name),
233
 
                        parent_str, parent_id))
234
 
            elif ie.kind == 'symlink':
235
 
                if not working:
236
 
                    append('<symlink file_id="%s name="%s%s%s revision="%s '
237
 
                        'symlink_target="%s />\n' % (
238
 
                        _encode_and_escape(ie.file_id),
239
 
                        _encode_and_escape(ie.name),
240
 
                        parent_str, parent_id,
241
 
                        _encode_and_escape(ie.revision),
242
 
                        _encode_and_escape(ie.symlink_target)))
243
 
                else:
244
 
                    append('<symlink file_id="%s name="%s%s%s />\n' % (
245
 
                        _encode_and_escape(ie.file_id),
246
 
                        _encode_and_escape(ie.name),
247
 
                        parent_str, parent_id))
248
 
            elif ie.kind == 'tree-reference':
249
 
                if ie.kind not in self.supported_kinds:
250
 
                    raise errors.UnsupportedInventoryKind(ie.kind)
251
 
                if not working:
252
 
                    append('<tree-reference file_id="%s name="%s%s%s '
253
 
                        'revision="%s reference_revision="%s />\n' % (
254
 
                        _encode_and_escape(ie.file_id),
255
 
                        _encode_and_escape(ie.name),
256
 
                        parent_str, parent_id,
257
 
                        _encode_and_escape(ie.revision),
258
 
                        _encode_and_escape(ie.reference_revision)))
259
 
                else:
260
 
                    append('<tree-reference file_id="%s name="%s%s%s />\n' % (
261
 
                        _encode_and_escape(ie.file_id),
262
 
                        _encode_and_escape(ie.name),
263
 
                        parent_str, parent_id))
264
 
            else:
265
 
                raise errors.UnsupportedInventoryKind(ie.kind)
 
174
            self._append_entry(append, ie)
266
175
        append('</inventory>\n')
267
 
        if f is not None:
268
 
            f.writelines(output)
 
176
        f.writelines(output)
269
177
        # Just to keep the cache from growing without bounds
270
178
        # but we may actually not want to do clear the cache
271
179
        #_clear_cache()
272
 
        return output
273
180
 
274
181
    def _append_inventory_root(self, append, inv):
275
182
        """Append the inventory root to output."""
 
183
        append('<inventory')
276
184
        if inv.root.file_id not in (None, ROOT_ID):
277
 
            fileid1 = ' file_id="'
278
 
            fileid2 = _encode_and_escape(inv.root.file_id)
279
 
        else:
280
 
            fileid1 = ""
281
 
            fileid2 = ""
 
185
            append(' file_id="')
 
186
            append(_encode_and_escape(inv.root.file_id))
 
187
        append(' format="5"')
282
188
        if inv.revision_id is not None:
283
 
            revid1 = ' revision_id="'
284
 
            revid2 = _encode_and_escape(inv.revision_id)
285
 
        else:
286
 
            revid1 = ""
287
 
            revid2 = ""
288
 
        append('<inventory%s%s format="5"%s%s>\n' % (
289
 
            fileid1, fileid2, revid1, revid2))
 
189
            append(' revision_id="')
 
190
            append(_encode_and_escape(inv.revision_id))
 
191
        append('>\n')
290
192
        
 
193
    def _append_entry(self, append, ie):
 
194
        """Convert InventoryEntry to XML element and append to output."""
 
195
        # TODO: should just be a plain assertion
 
196
        if ie.kind not in self.supported_kinds:
 
197
            raise errors.UnsupportedInventoryKind(ie.kind)
 
198
 
 
199
        append("<")
 
200
        append(ie.kind)
 
201
        if ie.executable:
 
202
            append(' executable="yes"')
 
203
        append(' file_id="')
 
204
        append(_encode_and_escape(ie.file_id))
 
205
        append(' name="')
 
206
        append(_encode_and_escape(ie.name))
 
207
        if self._parent_condition(ie):
 
208
            assert isinstance(ie.parent_id, basestring)
 
209
            append(' parent_id="')
 
210
            append(_encode_and_escape(ie.parent_id))
 
211
        if ie.revision is not None:
 
212
            append(' revision="')
 
213
            append(_encode_and_escape(ie.revision))
 
214
        if ie.symlink_target is not None:
 
215
            append(' symlink_target="')
 
216
            append(_encode_and_escape(ie.symlink_target))
 
217
        if ie.text_sha1 is not None:
 
218
            append(' text_sha1="')
 
219
            append(ie.text_sha1)
 
220
            append('"')
 
221
        if ie.text_size is not None:
 
222
            append(' text_size="%d"' % ie.text_size)
 
223
        if getattr(ie, 'reference_revision', None) is not None:
 
224
            append(' reference_revision="')
 
225
            append(_encode_and_escape(ie.reference_revision))
 
226
        append(" />\n")
 
227
        return
 
228
 
 
229
    def _parent_condition(self, ie):
 
230
        return ie.parent_id != ROOT_ID
 
231
 
291
232
    def _pack_revision(self, rev):
292
233
        """Revision object -> xml tree"""
293
234
        # For the XML format, we need to write them as Unicode rather than as
315
256
            pelts.tail = pelts.text = '\n'
316
257
            for parent_id in rev.parent_ids:
317
258
                assert isinstance(parent_id, basestring)
318
 
                _mod_revision.check_not_reserved_id(parent_id)
319
259
                p = SubElement(pelts, 'revision_ref')
320
260
                p.tail = '\n'
321
261
                if isinstance(parent_id, str):
336
276
            prop_elt.tail = '\n'
337
277
        top_elt.tail = '\n'
338
278
 
339
 
    def _unpack_inventory(self, elt, revision_id):
 
279
    def _unpack_inventory(self, elt):
340
280
        """Construct from XML Element
341
281
        """
342
282
        assert elt.tag == 'inventory'
348
288
            if format != '5':
349
289
                raise BzrError("invalid format version %r on inventory"
350
290
                                % format)
351
 
        data_revision_id = elt.get('revision_id')
352
 
        if data_revision_id is not None:
353
 
            revision_id = cache_utf8.encode(data_revision_id)
 
291
        revision_id = elt.get('revision_id')
 
292
        if revision_id is not None:
 
293
            revision_id = cache_utf8.encode(revision_id)
354
294
        inv = Inventory(root_id, revision_id=revision_id)
355
295
        for e in elt:
356
296
            ie = self._unpack_entry(e)
357
297
            if ie.parent_id is None:
358
298
                ie.parent_id = root_id
359
299
            inv.add(ie)
360
 
        if revision_id is not None:
361
 
            inv.root.revision = revision_id
362
300
        return inv
363
301
 
364
302
    def _unpack_entry(self, elt):