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.
22
from __future__ import absolute_import
29
revision as _mod_revision,
31
from .bzr.inventory import Inventory
32
from .bzr.inventorytree import MutableInventoryTree
33
from .osutils import sha_file
34
from .transport.memory import MemoryTransport
37
class MemoryTree(MutableInventoryTree):
38
"""A MemoryTree is a specialisation of MutableTree.
40
It maintains nearly no state outside of read_lock and write_lock
41
transactions. (it keeps a reference to the branch, and its last-revision
45
def __init__(self, branch, revision_id):
46
"""Construct a MemoryTree for branch using revision_id."""
48
self.controldir = branch.controldir
49
self._branch_revision_id = revision_id
51
self._lock_mode = None
53
def get_config_stack(self):
54
return self.branch.get_config_stack()
56
def is_control_filename(self, filename):
57
# Memory tree doesn't have any control filenames
60
def _add(self, files, ids, kinds):
61
"""See MutableTree._add."""
62
with self.lock_tree_write():
63
for f, file_id, kind in zip(files, ids, kinds):
67
self._inventory.add_path(f, kind=kind)
69
self._inventory.add_path(f, kind=kind, file_id=file_id)
72
"""See Tree.basis_tree()."""
73
return self._basis_tree
76
def create_on_branch(branch):
77
"""Create a MemoryTree for branch, using the last-revision of branch."""
78
revision_id = _mod_revision.ensure_null(branch.last_revision())
79
return MemoryTree(branch, revision_id)
81
def _gather_kinds(self, files, kinds):
82
"""See MutableTree._gather_kinds.
84
This implementation does not care about the file kind of
85
missing files, so is a no-op.
88
def get_file(self, path, file_id=None):
89
"""See Tree.get_file."""
90
return self._file_transport.get(path)
92
def get_file_sha1(self, path, file_id=None, stat_value=None):
93
"""See Tree.get_file_sha1()."""
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
def rename_one(self, from_rel, to_rel):
107
with self.lock_tree_write():
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
119
kind = self.kind(path, id)
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 get_parent_ids(self):
135
"""See Tree.get_parent_ids.
137
This implementation returns the current cached value from
140
with self.lock_read():
141
return list(self._parent_ids)
143
def has_filename(self, filename):
144
"""See Tree.has_filename()."""
145
return self._file_transport.has(filename)
147
def is_executable(self, path, file_id=None):
148
return self._inventory[file_id].executable
150
def kind(self, path, file_id=None):
152
file_id = self.path2id(path)
153
return self._inventory[file_id].kind
155
def mkdir(self, path, file_id=None):
156
"""See MutableTree.mkdir()."""
157
self.add(path, file_id, 'directory')
159
file_id = self.path2id(path)
160
self._file_transport.mkdir(path)
163
def last_revision(self):
164
"""See MutableTree.last_revision."""
165
with self.lock_read():
166
return self._branch_revision_id
169
"""Lock the memory tree for reading.
171
This triggers population of data from the branch for its revision.
176
self.branch.lock_read()
177
self._lock_mode = "r"
178
self._populate_from_branch()
179
return lock.LogicalLockResult(self.unlock)
184
def lock_tree_write(self):
185
"""See MutableTree.lock_tree_write()."""
189
self.branch.lock_read()
190
self._lock_mode = "w"
191
self._populate_from_branch()
192
elif self._lock_mode == "r":
193
raise errors.ReadOnlyError(self)
197
return lock.LogicalLockResult(self.unlock)
199
def lock_write(self):
200
"""See MutableTree.lock_write()."""
204
self.branch.lock_write()
205
self._lock_mode = "w"
206
self._populate_from_branch()
207
elif self._lock_mode == "r":
208
raise errors.ReadOnlyError(self)
209
return lock.LogicalLockResult(self.unlock)
214
def _populate_from_branch(self):
215
"""Populate the in-tree state from the branch."""
217
if self._branch_revision_id == _mod_revision.NULL_REVISION:
218
self._parent_ids = []
220
self._parent_ids = [self._branch_revision_id]
221
self._inventory = Inventory(None, self._basis_tree.get_revision_id())
222
self._file_transport = MemoryTransport()
223
# TODO copy the revision trees content, or do it lazy, or something.
224
inventory_entries = self._basis_tree.iter_entries_by_dir()
225
for path, entry in inventory_entries:
226
self._inventory.add(entry.copy())
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(path, entry.file_id))
235
raise NotImplementedError(self._populate_from_branch)
237
def put_file_bytes_non_atomic(self, path, bytes, file_id=None):
238
"""See MutableTree.put_file_bytes_non_atomic."""
239
self._file_transport.put_bytes(path, 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
def unversion(self, paths, file_ids=None):
260
"""Remove the paths from the current versioned set.
262
When a file_id is unversioned, all of its children are automatically
265
:param paths: The paths to stop versioning.
266
:raises: NoSuchId if any fileid is not currently versioned.
268
with self.lock_tree_write():
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.
275
file_id = self.path2id(path)
277
raise errors.NoSuchFile(path)
278
file_ids.add(file_id)
279
for file_id in file_ids:
280
if self._inventory.has_id(file_id):
281
self._inventory.remove_recursive_id(file_id)
283
raise errors.NoSuchId(self, file_id)
285
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
286
"""See MutableTree.set_parent_trees()."""
287
for revision_id in revision_ids:
288
_mod_revision.check_not_reserved_id(revision_id)
289
if len(revision_ids) == 0:
290
self._parent_ids = []
291
self._branch_revision_id = _mod_revision.NULL_REVISION
293
self._parent_ids = revision_ids
294
self._branch_revision_id = revision_ids[0]
295
self._allow_leftmost_as_ghost = allow_leftmost_as_ghost
298
def _set_basis(self):
300
self._basis_tree = self.branch.repository.revision_tree(
301
self._branch_revision_id)
302
except errors.NoSuchRevision:
303
if self._allow_leftmost_as_ghost:
304
self._basis_tree = self.branch.repository.revision_tree(
305
_mod_revision.NULL_REVISION)
309
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
310
"""See MutableTree.set_parent_trees()."""
311
if len(parents_list) == 0:
312
self._parent_ids = []
313
self._basis_tree = self.branch.repository.revision_tree(
314
_mod_revision.NULL_REVISION)
316
if parents_list[0][1] is None and not allow_leftmost_as_ghost:
317
# a ghost in the left most parent
318
raise errors.GhostRevisionUnusableHere(parents_list[0][0])
319
self._parent_ids = [parent_id for parent_id, tree in parents_list]
320
if parents_list[0][1] is None or parents_list[0][1] == 'null:':
321
self._basis_tree = self.branch.repository.revision_tree(
322
_mod_revision.NULL_REVISION)
324
self._basis_tree = parents_list[0][1]
325
self._branch_revision_id = parents_list[0][0]
added
removed
breezy/memorytree.py
