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, stat_value=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)
93
def _comparison_data(self, entry, path):
94
"""See Tree._comparison_data."""
96
return None, False, None
97
return entry.kind, entry.executable, None
99
def _file_size(self, entry, stat_value):
100
"""See Tree._file_size."""
103
return entry.text_size
106
def get_parent_ids(self):
107
"""See Tree.get_parent_ids.
109
This implementation returns the current cached value from
112
return list(self._parent_ids)
114
def has_filename(self, filename):
115
"""See Tree.has_filename()."""
116
return self._file_transport.has(filename)
118
def is_executable(self, file_id, path=None):
119
return self._inventory[file_id].executable
121
def kind(self, file_id):
122
return self._inventory[file_id].kind
124
def mkdir(self, path, file_id=None):
125
"""See MutableTree.mkdir()."""
126
self.add(path, file_id, 'directory')
128
file_id = self.path2id(path)
129
self._file_transport.mkdir(path)
133
def last_revision(self):
134
"""See MutableTree.last_revision."""
135
return self._branch_revision_id
138
"""Lock the memory tree for reading.
140
This triggers population of data from the branch for its revision.
145
self.branch.lock_read()
146
self._lock_mode = "r"
147
self._populate_from_branch()
152
def lock_tree_write(self):
153
"""See MutableTree.lock_tree_write()."""
157
self.branch.lock_read()
158
self._lock_mode = "w"
159
self._populate_from_branch()
160
elif self._lock_mode == "r":
161
raise errors.ReadOnlyError(self)
166
def lock_write(self):
167
"""See MutableTree.lock_write()."""
171
self.branch.lock_write()
172
self._lock_mode = "w"
173
self._populate_from_branch()
174
elif self._lock_mode == "r":
175
raise errors.ReadOnlyError(self)
180
def _populate_from_branch(self):
181
"""Populate the in-tree state from the branch."""
182
self._basis_tree = self.branch.repository.revision_tree(
183
self._branch_revision_id)
184
if self._branch_revision_id is None:
185
self._parent_ids = []
187
self._parent_ids = [self._branch_revision_id]
188
self._inventory = deepcopy(self._basis_tree._inventory)
189
self._file_transport = MemoryTransport()
190
# TODO copy the revision trees content, or do it lazy, or something.
191
inventory_entries = self._inventory.iter_entries()
192
for path, entry in inventory_entries:
195
if entry.kind == 'directory':
196
self._file_transport.mkdir(path)
197
elif entry.kind == 'file':
198
self._file_transport.put_file(path,
199
self._basis_tree.get_file(entry.file_id))
201
raise NotImplementedError(self._populate_from_branch)
203
def put_file_bytes_non_atomic(self, file_id, bytes):
204
"""See MutableTree.put_file_bytes_non_atomic."""
205
self._file_transport.put_bytes(self.id2path(file_id), bytes)
210
This frees all cached state when the last lock context for the tree is
214
self._basis_tree = None
215
self._parent_ids = []
216
self._inventory = None
221
self._lock_mode = None
225
@needs_tree_write_lock
226
def unversion(self, file_ids):
227
"""Remove the file ids in file_ids from the current versioned set.
229
When a file_id is unversioned, all of its children are automatically
232
:param file_ids: The file ids to stop versioning.
233
:raises: NoSuchId if any fileid is not currently versioned.
235
# XXX: This should be in mutabletree, but the inventory-save action
236
# is not relevant to memory tree. Until that is done in unlock by
237
# working tree, we cannot share the implementation.
238
for file_id in file_ids:
239
if self._inventory.has_id(file_id):
240
self._inventory.remove_recursive_id(file_id)
242
raise errors.NoSuchId(self, file_id)
244
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
245
"""See MutableTree.set_parent_trees()."""
246
for revision_id in revision_ids:
247
_mod_revision.check_not_reserved_id(revision_id)
248
if len(revision_ids) == 0:
249
self._parent_ids = []
250
self._basis_tree = self.branch.repository.revision_tree(None)
252
self._parent_ids = revision_ids
253
self._basis_tree = self.branch.repository.revision_tree(
255
self._branch_revision_id = revision_ids[0]
257
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
258
"""See MutableTree.set_parent_trees()."""
259
if len(parents_list) == 0:
260
self._parent_ids = []
261
self._basis_tree = self.branch.repository.revision_tree(None)
263
if parents_list[0][1] is None and not allow_leftmost_as_ghost:
264
# a ghost in the left most parent
265
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
266
self._parent_ids = [parent_id for parent_id, tree in parents_list]
267
if parents_list[0][1] is None or parents_list[0][1] == 'null:':
268
import pdb; pdb.set_trace()
269
self._basis_tree = self.branch.repository.revision_tree(None)
271
self._basis_tree = parents_list[0][1]
272
self._branch_revision_id = parents_list[0][0]