← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/memorytree.py

  • Committer: Robert Collins
  • Date: 2005-10-08 00:39:04 UTC
  • mfrom: (1185.1.52)
  • Revision ID: robertc@robertcollins.net-20051008003904-aaffaea2778efe3e
merge in martins reweave, integrated to fetch, and a bugfix for commit and upgrade with executable files

Show diffs side-by-side

added added

removed removed

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