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):
83
"""See Tree.get_file."""
84
return self._file_transport.get(self.id2path(file_id))
86
def get_file_sha1(self, file_id, path=None):
87
"""See Tree.get_file_sha1()."""
89
path = self.id2path(file_id)
90
stream = self._file_transport.get(path)
91
return sha_file(stream)
94
def get_parent_ids(self):
95
"""See Tree.get_parent_ids.
97
This implementation returns the current cached value from
100
return list(self._parent_ids)
102
def has_filename(self, filename):
103
"""See Tree.has_filename()."""
104
return self._file_transport.has(filename)
106
def is_executable(self, file_id, path=None):
107
return self._inventory[file_id].executable
109
def kind(self, file_id):
110
return self._inventory[file_id].kind
112
def mkdir(self, path, file_id=None):
113
"""See MutableTree.mkdir()."""
114
self.add(path, file_id, 'directory')
116
file_id = self.path2id(path)
117
self._file_transport.mkdir(path)
121
def last_revision(self):
122
"""See MutableTree.last_revision."""
123
return self._branch_revision_id
126
"""Lock the memory tree for reading.
128
This triggers population of data from the branch for its revision.
133
self.branch.lock_read()
134
self._lock_mode = "r"
135
self._populate_from_branch()
140
def lock_tree_write(self):
141
"""See MutableTree.lock_tree_write()."""
145
self.branch.lock_read()
146
self._lock_mode = "w"
147
self._populate_from_branch()
148
elif self._lock_mode == "r":
149
raise errors.ReadOnlyError(self)
154
def lock_write(self):
155
"""See MutableTree.lock_write()."""
159
self.branch.lock_write()
160
self._lock_mode = "w"
161
self._populate_from_branch()
162
elif self._lock_mode == "r":
163
raise errors.ReadOnlyError(self)
168
def _populate_from_branch(self):
169
"""Populate the in-tree state from the branch."""
170
self._basis_tree = self.branch.repository.revision_tree(
171
self._branch_revision_id)
172
if self._branch_revision_id is None:
173
self._parent_ids = []
175
self._parent_ids = [self._branch_revision_id]
176
self._inventory = deepcopy(self._basis_tree._inventory)
177
self._file_transport = MemoryTransport()
178
# TODO copy the revision trees content, or do it lazy, or something.
179
inventory_entries = self._inventory.iter_entries()
180
for path, entry in inventory_entries:
183
if entry.kind == 'directory':
184
self._file_transport.mkdir(path)
185
elif entry.kind == 'file':
186
self._file_transport.put_file(path,
187
self._basis_tree.get_file(entry.file_id))
189
raise NotImplementedError(self._populate_from_branch)
191
def put_file_bytes_non_atomic(self, file_id, bytes):
192
"""See MutableTree.put_file_bytes_non_atomic."""
193
self._file_transport.put_bytes(self.id2path(file_id), bytes)
198
This frees all cached state when the last lock context for the tree is
202
self._basis_tree = None
203
self._parent_ids = []
204
self._inventory = None
209
self._lock_mode = None
213
@needs_tree_write_lock
214
def unversion(self, file_ids):
215
"""Remove the file ids in file_ids from the current versioned set.
217
When a file_id is unversioned, all of its children are automatically
220
:param file_ids: The file ids to stop versioning.
221
:raises: NoSuchId if any fileid is not currently versioned.
223
# XXX: This should be in mutabletree, but the inventory-save action
224
# is not relevant to memory tree. Until that is done in unlock by
225
# working tree, we cannot share the implementation.
226
for file_id in file_ids:
227
if self._inventory.has_id(file_id):
228
self._inventory.remove_recursive_id(file_id)
230
raise errors.NoSuchId(self, file_id)
232
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
233
"""See MutableTree.set_parent_trees()."""
234
for revision_id in revision_ids:
235
_mod_revision.check_not_reserved_id(revision_id)
236
if len(revision_ids) == 0:
237
self._parent_ids = []
238
self._basis_tree = self.branch.repository.revision_tree(None)
240
self._parent_ids = revision_ids
241
self._basis_tree = self.branch.repository.revision_tree(
243
self._branch_revision_id = revision_ids[0]
245
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
246
"""See MutableTree.set_parent_trees()."""
247
if len(parents_list) == 0:
248
self._parent_ids = []
249
self._basis_tree = self.branch.repository.revision_tree(None)
251
if parents_list[0][1] is None and not allow_leftmost_as_ghost:
252
# a ghost in the left most parent
253
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
254
self._parent_ids = [parent_id for parent_id, tree in parents_list]
255
if parents_list[0][1] is None or parents_list[0][1] == 'null:':
256
import pdb; pdb.set_trace()
257
self._basis_tree = self.branch.repository.revision_tree(None)
259
self._basis_tree = parents_list[0][1]
260
self._branch_revision_id = parents_list[0][0]