~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/memorytree.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:
 
1
# Copyright (C) 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
"""MemoryTree object.
 
18
 
 
19
See MemoryTree for more details.
 
20
"""
 
21
 
 
22
 
 
23
from copy import deepcopy
 
24
 
 
25
from bzrlib import (
 
26
    errors,
 
27
    mutabletree,
 
28
    revision as _mod_revision,
 
29
    )
 
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
31
from bzrlib.osutils import sha_file
 
32
from bzrlib.mutabletree import needs_tree_write_lock
 
33
from bzrlib.transport.memory import MemoryTransport
 
34
 
 
35
 
 
36
class MemoryTree(mutabletree.MutableTree):
 
37
    """A MemoryTree is a specialisation of MutableTree.
 
38
    
 
39
    It maintains nearly no state outside of read_lock and write_lock
 
40
    transactions. (it keeps a reference to the branch, and its last-revision
 
41
    only).
 
42
    """
 
43
 
 
44
    def __init__(self, branch, revision_id):
 
45
        """Construct a MemoryTree for branch using revision_id."""
 
46
        self.branch = branch
 
47
        self.bzrdir = branch.bzrdir
 
48
        self._branch_revision_id = revision_id
 
49
        self._locks = 0
 
50
        self._lock_mode = None
 
51
 
 
52
    @needs_tree_write_lock
 
53
    def _add(self, files, ids, kinds):
 
54
        """See MutableTree._add."""
 
55
        for f, file_id, kind in zip(files, ids, kinds):
 
56
            if kind is None:
 
57
                kind = 'file'
 
58
            if file_id is None:
 
59
                self._inventory.add_path(f, kind=kind)
 
60
            else:
 
61
                self._inventory.add_path(f, kind=kind, file_id=file_id)
 
62
 
 
63
    def basis_tree(self):
 
64
        """See Tree.basis_tree()."""
 
65
        return self._basis_tree
 
66
 
 
67
    @staticmethod
 
68
    def create_on_branch(branch):
 
69
        """Create a MemoryTree for branch, using the last-revision of branch."""
 
70
        revision_id = _mod_revision.ensure_null(branch.last_revision())
 
71
        if _mod_revision.is_null(revision_id):
 
72
            revision_id = None
 
73
        return MemoryTree(branch, revision_id)
 
74
 
 
75
    def _gather_kinds(self, files, kinds):
 
76
        """See MutableTree._gather_kinds.
 
77
        
 
78
        This implementation does not care about the file kind of
 
79
        missing files, so is a no-op.
 
80
        """
 
81
 
 
82
    def get_file(self, file_id, path=None):
 
83
        """See Tree.get_file."""
 
84
        if path is None:
 
85
            path = self.id2path(file_id)
 
86
        return self._file_transport.get(path)
 
87
 
 
88
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
89
        """See Tree.get_file_sha1()."""
 
90
        if path is None:
 
91
            path = self.id2path(file_id)
 
92
        stream = self._file_transport.get(path)
 
93
        return sha_file(stream)
 
94
 
 
95
    def _comparison_data(self, entry, path):
 
96
        """See Tree._comparison_data."""
 
97
        if entry is None:
 
98
            return None, False, None
 
99
        return entry.kind, entry.executable, None
 
100
 
 
101
    def path_content_summary(self, path):
 
102
        """See Tree.path_content_summary."""
 
103
        id = self.path2id(path)
 
104
        if id is None:
 
105
            return 'missing', None, None, None
 
106
        kind = self.kind(id)
 
107
        if kind == 'file':
 
108
            bytes = self._file_transport.get_bytes(path)
 
109
            size = len(bytes)
 
110
            executable = self._inventory[id].executable
 
111
            sha1 = None # no stat cache
 
112
            return (kind, size, executable, sha1)
 
113
        elif kind == 'directory':
 
114
            # memory tree does not support nested trees yet.
 
115
            return kind, None, None, None
 
116
        elif kind == 'symlink':
 
117
            raise NotImplementedError('symlink support')
 
118
        else:
 
119
            raise NotImplementedError('unknown kind')
 
120
 
 
121
    def _file_size(self, entry, stat_value):
 
122
        """See Tree._file_size."""
 
123
        if entry is None:
 
124
            return 0
 
125
        return entry.text_size
 
126
 
 
127
    @needs_read_lock
 
128
    def get_parent_ids(self):
 
129
        """See Tree.get_parent_ids.
 
130
 
 
131
        This implementation returns the current cached value from
 
132
            self._parent_ids.
 
133
        """
 
134
        return list(self._parent_ids)
 
135
 
 
136
    def has_filename(self, filename):
 
137
        """See Tree.has_filename()."""
 
138
        return self._file_transport.has(filename)
 
139
 
 
140
    def is_executable(self, file_id, path=None):
 
141
        return self._inventory[file_id].executable
 
142
 
 
143
    def kind(self, file_id):
 
144
        return self._inventory[file_id].kind
 
145
 
 
146
    def mkdir(self, path, file_id=None):
 
147
        """See MutableTree.mkdir()."""
 
148
        self.add(path, file_id, 'directory')
 
149
        if file_id is None:
 
150
            file_id = self.path2id(path)
 
151
        self._file_transport.mkdir(path)
 
152
        return file_id
 
153
 
 
154
    @needs_read_lock
 
155
    def last_revision(self):
 
156
        """See MutableTree.last_revision."""
 
157
        return self._branch_revision_id
 
158
 
 
159
    def lock_read(self):
 
160
        """Lock the memory tree for reading.
 
161
 
 
162
        This triggers population of data from the branch for its revision.
 
163
        """
 
164
        self._locks += 1
 
165
        try:
 
166
            if self._locks == 1:
 
167
                self.branch.lock_read()
 
168
                self._lock_mode = "r"
 
169
                self._populate_from_branch()
 
170
        except:
 
171
            self._locks -= 1
 
172
            raise
 
173
 
 
174
    def lock_tree_write(self):
 
175
        """See MutableTree.lock_tree_write()."""
 
176
        self._locks += 1
 
177
        try:
 
178
            if self._locks == 1:
 
179
                self.branch.lock_read()
 
180
                self._lock_mode = "w"
 
181
                self._populate_from_branch()
 
182
            elif self._lock_mode == "r":
 
183
                raise errors.ReadOnlyError(self)
 
184
        except:
 
185
            self._locks -= 1
 
186
            raise
 
187
 
 
188
    def lock_write(self):
 
189
        """See MutableTree.lock_write()."""
 
190
        self._locks += 1
 
191
        try:
 
192
            if self._locks == 1:
 
193
                self.branch.lock_write()
 
194
                self._lock_mode = "w"
 
195
                self._populate_from_branch()
 
196
            elif self._lock_mode == "r":
 
197
                raise errors.ReadOnlyError(self)
 
198
        except:
 
199
            self._locks -= 1
 
200
            raise
 
201
 
 
202
    def _populate_from_branch(self):
 
203
        """Populate the in-tree state from the branch."""
 
204
        self._basis_tree = self.branch.repository.revision_tree(
 
205
            self._branch_revision_id)
 
206
        if self._branch_revision_id is None:
 
207
            self._parent_ids = []
 
208
        else:
 
209
            self._parent_ids = [self._branch_revision_id]
 
210
        self._inventory = deepcopy(self._basis_tree._inventory)
 
211
        self._file_transport = MemoryTransport()
 
212
        # TODO copy the revision trees content, or do it lazy, or something.
 
213
        inventory_entries = self._inventory.iter_entries()
 
214
        for path, entry in inventory_entries:
 
215
            if path == '':
 
216
                continue
 
217
            if entry.kind == 'directory':
 
218
                self._file_transport.mkdir(path)
 
219
            elif entry.kind == 'file':
 
220
                self._file_transport.put_file(path,
 
221
                    self._basis_tree.get_file(entry.file_id))
 
222
            else:
 
223
                raise NotImplementedError(self._populate_from_branch)
 
224
 
 
225
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
226
        """See MutableTree.put_file_bytes_non_atomic."""
 
227
        self._file_transport.put_bytes(self.id2path(file_id), bytes)
 
228
 
 
229
    def unlock(self):
 
230
        """Release a lock.
 
231
 
 
232
        This frees all cached state when the last lock context for the tree is
 
233
        left.
 
234
        """
 
235
        if self._locks == 1:
 
236
            self._basis_tree = None
 
237
            self._parent_ids = []
 
238
            self._inventory = None
 
239
            try:
 
240
                self.branch.unlock()
 
241
            finally:
 
242
                self._locks = 0
 
243
                self._lock_mode = None
 
244
        else:
 
245
            self._locks -= 1
 
246
 
 
247
    @needs_tree_write_lock
 
248
    def unversion(self, file_ids):
 
249
        """Remove the file ids in file_ids from the current versioned set.
 
250
 
 
251
        When a file_id is unversioned, all of its children are automatically
 
252
        unversioned.
 
253
 
 
254
        :param file_ids: The file ids to stop versioning.
 
255
        :raises: NoSuchId if any fileid is not currently versioned.
 
256
        """
 
257
        # XXX: This should be in mutabletree, but the inventory-save action
 
258
        # is not relevant to memory tree. Until that is done in unlock by
 
259
        # working tree, we cannot share the implementation.
 
260
        for file_id in file_ids:
 
261
            if self._inventory.has_id(file_id):
 
262
                self._inventory.remove_recursive_id(file_id)
 
263
            else:
 
264
                raise errors.NoSuchId(self, file_id)
 
265
 
 
266
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
267
        """See MutableTree.set_parent_trees()."""
 
268
        for revision_id in revision_ids:
 
269
            _mod_revision.check_not_reserved_id(revision_id)
 
270
        if len(revision_ids) == 0:
 
271
            self._parent_ids = []
 
272
            self._basis_tree = self.branch.repository.revision_tree(None)
 
273
        else:
 
274
            self._parent_ids = revision_ids
 
275
            self._basis_tree = self.branch.repository.revision_tree(
 
276
                                    revision_ids[0])
 
277
            self._branch_revision_id = revision_ids[0]
 
278
 
 
279
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
280
        """See MutableTree.set_parent_trees()."""
 
281
        if len(parents_list) == 0:
 
282
            self._parent_ids = []
 
283
            self._basis_tree = self.branch.repository.revision_tree(None)
 
284
        else:
 
285
            if parents_list[0][1] is None and not allow_leftmost_as_ghost:
 
286
                # a ghost in the left most parent
 
287
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
 
288
            self._parent_ids = [parent_id for parent_id, tree in parents_list]
 
289
            if parents_list[0][1] is None or parents_list[0][1] == 'null:':
 
290
                import pdb; pdb.set_trace()
 
291
                self._basis_tree = self.branch.repository.revision_tree(None)
 
292
            else:
 
293
                self._basis_tree = parents_list[0][1]
 
294
            self._branch_revision_id = parents_list[0][0]