← 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-11-09 17:50:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2988.
  • Revision ID: robertc@robertcollins.net-20071109175031-agaiy6530rvbprmb
Change (without backwards compatibility) the
iter_lines_added_or_present_in_versions VersionedFile API to yield the
text version that each line is being returned from. This is useful for
reconcile in determining what inventories reference what texts.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml4.py
 
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., 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
 
19
import bzrlib.inventory as inventory
 
20
from bzrlib.revision import Revision
 
21
from bzrlib.errors import BzrError
 
22
 
 
23
 
 
24
class _Serializer_v4(Serializer):
 
25
    """Version 0.0.4 serializer
 
26
 
 
27
    You should use the serializer_v4 singleton.
 
28
    
 
29
    v4 serialisation is no longer supported, only deserialisation.
 
30
    """
 
31
    
 
32
    __slots__ = []
 
33
    
 
34
    def _pack_entry(self, ie):
 
35
        """Convert InventoryEntry to XML element"""
 
36
        e = Element('entry')
 
37
        e.set('name', ie.name)
 
38
        e.set('file_id', ie.file_id)
 
39
        e.set('kind', ie.kind)
 
40
 
 
41
        if ie.text_size is not None:
 
42
            e.set('text_size', '%d' % ie.text_size)
 
43
 
 
44
        for f in ['text_id', 'text_sha1', 'symlink_target']:
 
45
            v = getattr(ie, f)
 
46
            if v is not None:
 
47
                e.set(f, v)
 
48
 
 
49
        # to be conservative, we don't externalize the root pointers
 
50
        # for now, leaving them as null in the xml form.  in a future
 
51
        # version it will be implied by nested elements.
 
52
        if ie.parent_id != ROOT_ID:
 
53
            assert isinstance(ie.parent_id, basestring)
 
54
            e.set('parent_id', ie.parent_id)
 
55
 
 
56
        e.tail = '\n'
 
57
 
 
58
        return e
 
59
 
 
60
 
 
61
    def _unpack_inventory(self, elt, revision_id=None):
 
62
        """Construct from XML Element
 
63
 
 
64
        :param revision_id: Ignored parameter used by xml5.
 
65
        """
 
66
        assert elt.tag == 'inventory'
 
67
        root_id = elt.get('file_id') or ROOT_ID
 
68
        inv = Inventory(root_id)
 
69
        for e in elt:
 
70
            ie = self._unpack_entry(e)
 
71
            if ie.parent_id == ROOT_ID:
 
72
                ie.parent_id = root_id
 
73
            inv.add(ie)
 
74
        return inv
 
75
 
 
76
 
 
77
    def _unpack_entry(self, elt):
 
78
        assert elt.tag == 'entry'
 
79
 
 
80
        ## original format inventories don't have a parent_id for
 
81
        ## nodes in the root directory, but it's cleaner to use one
 
82
        ## internally.
 
83
        parent_id = elt.get('parent_id')
 
84
        if parent_id is None:
 
85
            parent_id = ROOT_ID
 
86
 
 
87
        kind = elt.get('kind')
 
88
        if kind == 'directory':
 
89
            ie = inventory.InventoryDirectory(elt.get('file_id'),
 
90
                                              elt.get('name'),
 
91
                                              parent_id)
 
92
        elif kind == 'file':
 
93
            ie = inventory.InventoryFile(elt.get('file_id'),
 
94
                                         elt.get('name'),
 
95
                                         parent_id)
 
96
            ie.text_id = elt.get('text_id')
 
97
            ie.text_sha1 = elt.get('text_sha1')
 
98
            v = elt.get('text_size')
 
99
            ie.text_size = v and int(v)
 
100
        elif kind == 'symlink':
 
101
            ie = inventory.InventoryLink(elt.get('file_id'),
 
102
                                         elt.get('name'),
 
103
                                         parent_id)
 
104
            ie.symlink_target = elt.get('symlink_target')
 
105
        else:
 
106
            raise BzrError("unknown kind %r" % kind)
 
107
 
 
108
        ## mutter("read inventoryentry: %r", elt.attrib)
 
109
 
 
110
        return ie
 
111
 
 
112
 
 
113
    def _pack_revision(self, rev):
 
114
        """Revision object -> xml tree"""
 
115
        root = Element('revision',
 
116
                       committer = rev.committer,
 
117
                       timestamp = '%.9f' % rev.timestamp,
 
118
                       revision_id = rev.revision_id,
 
119
                       inventory_id = rev.inventory_id,
 
120
                       inventory_sha1 = rev.inventory_sha1,
 
121
                       )
 
122
        if rev.timezone:
 
123
            root.set('timezone', str(rev.timezone))
 
124
        root.text = '\n'
 
125
 
 
126
        msg = SubElement(root, 'message')
 
127
        msg.text = rev.message
 
128
        msg.tail = '\n'
 
129
 
 
130
        if rev.parents:
 
131
            pelts = SubElement(root, 'parents')
 
132
            pelts.tail = pelts.text = '\n'
 
133
            for i, parent_id in enumerate(rev.parents):
 
134
                p = SubElement(pelts, 'revision_ref')
 
135
                p.tail = '\n'
 
136
                assert parent_id
 
137
                p.set('revision_id', parent_id)
 
138
                if i < len(rev.parent_sha1s):
 
139
                    p.set('revision_sha1', rev.parent_sha1s[i])
 
140
        return root
 
141
 
 
142
    
 
143
    def _unpack_revision(self, elt):
 
144
        """XML Element -> Revision object"""
 
145
        
 
146
        # <changeset> is deprecated...
 
147
        if elt.tag not in ('revision', 'changeset'):
 
148
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
149
 
 
150
        rev = Revision(committer = elt.get('committer'),
 
151
                       timestamp = float(elt.get('timestamp')),
 
152
                       revision_id = elt.get('revision_id'),
 
153
                       inventory_id = elt.get('inventory_id'),
 
154
                       inventory_sha1 = elt.get('inventory_sha1')
 
155
                       )
 
156
 
 
157
        precursor = elt.get('precursor')
 
158
        precursor_sha1 = elt.get('precursor_sha1')
 
159
 
 
160
        pelts = elt.find('parents')
 
161
 
 
162
        if pelts:
 
163
            for p in pelts:
 
164
                assert p.tag == 'revision_ref', \
 
165
                       "bad parent node tag %r" % p.tag
 
166
                rev.parent_ids.append(p.get('revision_id'))
 
167
                rev.parent_sha1s.append(p.get('revision_sha1'))
 
168
            if precursor:
 
169
                # must be consistent
 
170
                prec_parent = rev.parent_ids[0]
 
171
                assert prec_parent == precursor
 
172
        elif precursor:
 
173
            # revisions written prior to 0.0.5 have a single precursor
 
174
            # give as an attribute
 
175
            rev.parent_ids.append(precursor)
 
176
            rev.parent_sha1s.append(precursor_sha1)
 
177
 
 
178
        v = elt.get('timezone')
 
179
        rev.timezone = v and int(v)
 
180
 
 
181
        rev.message = elt.findtext('message') # text of <message>
 
182
        return rev
 
183
 
 
184
 
 
185
 
 
186
 
 
187
"""singleton instance"""
 
188
serializer_v4 = _Serializer_v4()
 
189