1
# Copyright (C) 2006 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
See MemoryTree for more details.
28
revision as _mod_revision,
30
from bzrlib.decorators import needs_read_lock
31
from bzrlib.osutils import sha_file
32
from bzrlib.mutabletree import needs_tree_write_lock
33
from bzrlib.transport.memory import MemoryTransport
36
class MemoryTree(mutabletree.MutableTree):
37
"""A MemoryTree is a specialisation of MutableTree.
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
44
def __init__(self, branch, revision_id):
45
"""Construct a MemoryTree for branch using revision_id."""
47
self.bzrdir = branch.bzrdir
48
self._branch_revision_id = revision_id
50
self._lock_mode = None
52
def is_control_filename(self, filename):
53
# Memory tree doesn't have any control filenames
56
@needs_tree_write_lock
57
def _add(self, files, ids, kinds):
58
"""See MutableTree._add."""
59
for f, file_id, kind in zip(files, ids, kinds):
63
self._inventory.add_path(f, kind=kind)
65
self._inventory.add_path(f, kind=kind, file_id=file_id)
68
"""See Tree.basis_tree()."""
69
return self._basis_tree
72
def create_on_branch(branch):
73
"""Create a MemoryTree for branch, using the last-revision of branch."""
74
revision_id = _mod_revision.ensure_null(branch.last_revision())
75
return MemoryTree(branch, revision_id)
77
def _gather_kinds(self, files, kinds):
78
"""See MutableTree._gather_kinds.
80
This implementation does not care about the file kind of
81
missing files, so is a no-op.
84
def get_file(self, file_id, path=None):
85
"""See Tree.get_file."""
87
path = self.id2path(file_id)
88
return self._file_transport.get(path)
90
def get_file_sha1(self, file_id, path=None, stat_value=None):
91
"""See Tree.get_file_sha1()."""
93
path = self.id2path(file_id)
94
stream = self._file_transport.get(path)
95
return sha_file(stream)
97
def get_root_id(self):
98
return self.path2id('')
100
def _comparison_data(self, entry, path):
101
"""See Tree._comparison_data."""
103
return None, False, None
104
return entry.kind, entry.executable, None
106
@needs_tree_write_lock
107
def rename_one(self, from_rel, to_rel):
108
file_id = self.path2id(from_rel)
109
to_dir, to_tail = os.path.split(to_rel)
110
to_parent_id = self.path2id(to_dir)
111
self._file_transport.move(from_rel, to_rel)
112
self._inventory.rename(file_id, to_parent_id, to_tail)
114
def path_content_summary(self, path):
115
"""See Tree.path_content_summary."""
116
id = self.path2id(path)
118
return 'missing', None, None, None
121
bytes = self._file_transport.get_bytes(path)
123
executable = self._inventory[id].executable
124
sha1 = None # no stat cache
125
return (kind, size, executable, sha1)
126
elif kind == 'directory':
127
# memory tree does not support nested trees yet.
128
return kind, None, None, None
129
elif kind == 'symlink':
130
raise NotImplementedError('symlink support')
132
raise NotImplementedError('unknown kind')
134
def _file_size(self, entry, stat_value):
135
"""See Tree._file_size."""
138
return entry.text_size
141
def get_parent_ids(self):
142
"""See Tree.get_parent_ids.
144
This implementation returns the current cached value from
147
return list(self._parent_ids)
149
def has_filename(self, filename):
150
"""See Tree.has_filename()."""
151
return self._file_transport.has(filename)
153
def is_executable(self, file_id, path=None):
154
return self._inventory[file_id].executable
156
def kind(self, file_id):
157
return self._inventory[file_id].kind
159
def mkdir(self, path, file_id=None):
160
"""See MutableTree.mkdir()."""
161
self.add(path, file_id, 'directory')
163
file_id = self.path2id(path)
164
self._file_transport.mkdir(path)
168
def last_revision(self):
169
"""See MutableTree.last_revision."""
170
return self._branch_revision_id
173
"""Lock the memory tree for reading.
175
This triggers population of data from the branch for its revision.
180
self.branch.lock_read()
181
self._lock_mode = "r"
182
self._populate_from_branch()
187
def lock_tree_write(self):
188
"""See MutableTree.lock_tree_write()."""
192
self.branch.lock_read()
193
self._lock_mode = "w"
194
self._populate_from_branch()
195
elif self._lock_mode == "r":
196
raise errors.ReadOnlyError(self)
201
def lock_write(self):
202
"""See MutableTree.lock_write()."""
206
self.branch.lock_write()
207
self._lock_mode = "w"
208
self._populate_from_branch()
209
elif self._lock_mode == "r":
210
raise errors.ReadOnlyError(self)
215
def _populate_from_branch(self):
216
"""Populate the in-tree state from the branch."""
218
if self._branch_revision_id == _mod_revision.NULL_REVISION:
219
self._parent_ids = []
221
self._parent_ids = [self._branch_revision_id]
222
self._inventory = self._basis_tree._inventory._get_mutable_inventory()
223
self._file_transport = MemoryTransport()
224
# TODO copy the revision trees content, or do it lazy, or something.
225
inventory_entries = self._inventory.iter_entries()
226
for path, entry in inventory_entries:
229
if entry.kind == 'directory':
230
self._file_transport.mkdir(path)
231
elif entry.kind == 'file':
232
self._file_transport.put_file(path,
233
self._basis_tree.get_file(entry.file_id))
235
raise NotImplementedError(self._populate_from_branch)
237
def put_file_bytes_non_atomic(self, file_id, bytes):
238
"""See MutableTree.put_file_bytes_non_atomic."""
239
self._file_transport.put_bytes(self.id2path(file_id), bytes)
244
This frees all cached state when the last lock context for the tree is
248
self._basis_tree = None
249
self._parent_ids = []
250
self._inventory = None
255
self._lock_mode = None
259
@needs_tree_write_lock
260
def unversion(self, file_ids):
261
"""Remove the file ids in file_ids from the current versioned set.
263
When a file_id is unversioned, all of its children are automatically
266
:param file_ids: The file ids to stop versioning.
267
:raises: NoSuchId if any fileid is not currently versioned.
269
# XXX: This should be in mutabletree, but the inventory-save action
270
# is not relevant to memory tree. Until that is done in unlock by
271
# working tree, we cannot share the implementation.
272
for file_id in file_ids:
273
if self._inventory.has_id(file_id):
274
self._inventory.remove_recursive_id(file_id)
276
raise errors.NoSuchId(self, file_id)
278
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
279
"""See MutableTree.set_parent_trees()."""
280
for revision_id in revision_ids:
281
_mod_revision.check_not_reserved_id(revision_id)
282
if len(revision_ids) == 0:
283
self._parent_ids = []
284
self._branch_revision_id = _mod_revision.NULL_REVISION
286
self._parent_ids = revision_ids
287
self._branch_revision_id = revision_ids[0]
288
self._allow_leftmost_as_ghost = allow_leftmost_as_ghost
291
def _set_basis(self):
293
self._basis_tree = self.branch.repository.revision_tree(
294
self._branch_revision_id)
295
except errors.NoSuchRevision:
296
if self._allow_leftmost_as_ghost:
297
self._basis_tree = self.branch.repository.revision_tree(
298
_mod_revision.NULL_REVISION)
302
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
303
"""See MutableTree.set_parent_trees()."""
304
if len(parents_list) == 0:
305
self._parent_ids = []
306
self._basis_tree = self.branch.repository.revision_tree(
307
_mod_revision.NULL_REVISION)
309
if parents_list[0][1] is None and not allow_leftmost_as_ghost:
310
# a ghost in the left most parent
311
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
312
self._parent_ids = [parent_id for parent_id, tree in parents_list]
313
if parents_list[0][1] is None or parents_list[0][1] == 'null:':
314
self._basis_tree = self.branch.repository.revision_tree(
315
_mod_revision.NULL_REVISION)
317
self._basis_tree = parents_list[0][1]
318
self._branch_revision_id = parents_list[0][0]
added
removed
bzrlib/memorytree.py
