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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
See MemoryTree for more details.
23
from copy import deepcopy
28
revision as _mod_revision,
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
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
@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):
59
self._inventory.add_path(f, kind=kind)
61
self._inventory.add_path(f, kind=kind, file_id=file_id)
64
"""See Tree.basis_tree()."""
65
return self._basis_tree
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):
73
return MemoryTree(branch, revision_id)
75
def _gather_kinds(self, files, kinds):
76
"""See MutableTree._gather_kinds.
78
This implementation does not care about the file kind of
79
missing files, so is a no-op.
82
def get_file(self, file_id, path=None):
83
"""See Tree.get_file."""
85
path = self.id2path(file_id)
86
return self._file_transport.get(path)
88
def get_file_sha1(self, file_id, path=None, stat_value=None):
89
"""See Tree.get_file_sha1()."""
91
path = self.id2path(file_id)
92
stream = self._file_transport.get(path)
93
return sha_file(stream)
95
def get_root_id(self):
96
return self.path2id('')
98
def _comparison_data(self, entry, path):
99
"""See Tree._comparison_data."""
101
return None, False, None
102
return entry.kind, entry.executable, None
104
def path_content_summary(self, path):
105
"""See Tree.path_content_summary."""
106
id = self.path2id(path)
108
return 'missing', None, None, None
111
bytes = self._file_transport.get_bytes(path)
113
executable = self._inventory[id].executable
114
sha1 = None # no stat cache
115
return (kind, size, executable, sha1)
116
elif kind == 'directory':
117
# memory tree does not support nested trees yet.
118
return kind, None, None, None
119
elif kind == 'symlink':
120
raise NotImplementedError('symlink support')
122
raise NotImplementedError('unknown kind')
124
def _file_size(self, entry, stat_value):
125
"""See Tree._file_size."""
128
return entry.text_size
131
def get_parent_ids(self):
132
"""See Tree.get_parent_ids.
134
This implementation returns the current cached value from
137
return list(self._parent_ids)
139
def has_filename(self, filename):
140
"""See Tree.has_filename()."""
141
return self._file_transport.has(filename)
143
def is_executable(self, file_id, path=None):
144
return self._inventory[file_id].executable
146
def kind(self, file_id):
147
return self._inventory[file_id].kind
149
def mkdir(self, path, file_id=None):
150
"""See MutableTree.mkdir()."""
151
self.add(path, file_id, 'directory')
153
file_id = self.path2id(path)
154
self._file_transport.mkdir(path)
158
def last_revision(self):
159
"""See MutableTree.last_revision."""
160
return self._branch_revision_id
163
"""Lock the memory tree for reading.
165
This triggers population of data from the branch for its revision.
170
self.branch.lock_read()
171
self._lock_mode = "r"
172
self._populate_from_branch()
177
def lock_tree_write(self):
178
"""See MutableTree.lock_tree_write()."""
182
self.branch.lock_read()
183
self._lock_mode = "w"
184
self._populate_from_branch()
185
elif self._lock_mode == "r":
186
raise errors.ReadOnlyError(self)
191
def lock_write(self):
192
"""See MutableTree.lock_write()."""
196
self.branch.lock_write()
197
self._lock_mode = "w"
198
self._populate_from_branch()
199
elif self._lock_mode == "r":
200
raise errors.ReadOnlyError(self)
205
def _populate_from_branch(self):
206
"""Populate the in-tree state from the branch."""
207
self._basis_tree = self.branch.repository.revision_tree(
208
self._branch_revision_id)
209
if self._branch_revision_id is None:
210
self._parent_ids = []
212
self._parent_ids = [self._branch_revision_id]
213
self._inventory = deepcopy(self._basis_tree._inventory)
214
self._file_transport = MemoryTransport()
215
# TODO copy the revision trees content, or do it lazy, or something.
216
inventory_entries = self._inventory.iter_entries()
217
for path, entry in inventory_entries:
220
if entry.kind == 'directory':
221
self._file_transport.mkdir(path)
222
elif entry.kind == 'file':
223
self._file_transport.put_file(path,
224
self._basis_tree.get_file(entry.file_id))
226
raise NotImplementedError(self._populate_from_branch)
228
def put_file_bytes_non_atomic(self, file_id, bytes):
229
"""See MutableTree.put_file_bytes_non_atomic."""
230
self._file_transport.put_bytes(self.id2path(file_id), bytes)
235
This frees all cached state when the last lock context for the tree is
239
self._basis_tree = None
240
self._parent_ids = []
241
self._inventory = None
246
self._lock_mode = None
250
@needs_tree_write_lock
251
def unversion(self, file_ids):
252
"""Remove the file ids in file_ids from the current versioned set.
254
When a file_id is unversioned, all of its children are automatically
257
:param file_ids: The file ids to stop versioning.
258
:raises: NoSuchId if any fileid is not currently versioned.
260
# XXX: This should be in mutabletree, but the inventory-save action
261
# is not relevant to memory tree. Until that is done in unlock by
262
# working tree, we cannot share the implementation.
263
for file_id in file_ids:
264
if self._inventory.has_id(file_id):
265
self._inventory.remove_recursive_id(file_id)
267
raise errors.NoSuchId(self, file_id)
269
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
270
"""See MutableTree.set_parent_trees()."""
271
for revision_id in revision_ids:
272
_mod_revision.check_not_reserved_id(revision_id)
273
if len(revision_ids) == 0:
274
self._parent_ids = []
275
self._basis_tree = self.branch.repository.revision_tree(None)
277
self._parent_ids = revision_ids
278
self._basis_tree = self.branch.repository.revision_tree(
280
self._branch_revision_id = revision_ids[0]
282
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
283
"""See MutableTree.set_parent_trees()."""
284
if len(parents_list) == 0:
285
self._parent_ids = []
286
self._basis_tree = self.branch.repository.revision_tree(None)
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(None)
295
self._basis_tree = parents_list[0][1]
296
self._branch_revision_id = parents_list[0][0]
added
removed
bzrlib/memorytree.py
