1
# Copyright (C) 2006, 2007 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
17
"""MutableTree object.
19
See MutableTree for more details.
28
from bzrlib.decorators import needs_read_lock, needs_write_lock
29
from bzrlib.osutils import splitpath
30
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
33
def needs_tree_write_lock(unbound):
34
"""Decorate unbound to take out and release a tree_write lock."""
35
def tree_write_locked(self, *args, **kwargs):
36
self.lock_tree_write()
38
return unbound(self, *args, **kwargs)
41
tree_write_locked.__doc__ = unbound.__doc__
42
tree_write_locked.__name__ = unbound.__name__
43
return tree_write_locked
46
class MutableTree(tree.Tree):
47
"""A MutableTree is a specialisation of Tree which is able to be mutated.
49
Generally speaking these mutations are only possible within a lock_write
50
context, and will revert if the lock is broken abnormally - but this cannot
51
be guaranteed - depending on the exact implementation of the mutable state.
53
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
54
For tests we also have MemoryTree which is a MutableTree whose contents are
57
For now, we are not treating MutableTree as an interface to provide
58
conformance tests for - rather we are testing MemoryTree specifically, and
59
interface testing implementations of WorkingTree.
61
A mutable tree always has an associated Branch and BzrDir object - the
62
branch and bzrdir attributes.
65
@needs_tree_write_lock
66
def add(self, files, ids=None, kinds=None):
67
"""Add paths to the set of versioned paths.
69
Note that the command line normally calls smart_add instead,
70
which can automatically recurse.
72
This adds the files to the inventory, so that they will be
73
recorded by the next commit.
75
:param files: List of paths to add, relative to the base of the tree.
76
:param ids: If set, use these instead of automatically generated ids.
77
Must be the same length as the list of files, but may
78
contain None for ids that are to be autogenerated.
79
:param kinds: Optional parameter to specify the kinds to be used for
82
TODO: Perhaps callback with the ids and paths as they're added.
84
if isinstance(files, basestring):
85
assert(ids is None or isinstance(ids, basestring))
86
assert(kinds is None or isinstance(kinds, basestring))
94
ids = [None] * len(files)
96
assert(len(ids) == len(files))
97
ids = [osutils.safe_file_id(file_id) for file_id in ids]
100
kinds = [None] * len(files)
102
assert(len(kinds) == len(files))
104
# generic constraint checks:
105
if self.is_control_filename(f):
106
raise errors.ForbiddenControlFileError(filename=f)
108
# fill out file kinds for all files [not needed when we stop
109
# caring about the instantaneous file kind within a uncommmitted tree
111
self._gather_kinds(files, kinds)
112
self._add(files, ids, kinds)
114
def add_reference(self, sub_tree):
115
"""Add a TreeReference to the tree, pointing at sub_tree"""
116
raise errors.UnsupportedOperation(self.add_reference, self)
118
def _add_reference(self, sub_tree):
119
"""Standard add_reference implementation, for use by subclasses"""
121
sub_tree_path = self.relpath(sub_tree.basedir)
122
except errors.PathNotChild:
123
raise errors.BadReferenceTarget(self, sub_tree,
124
'Target not inside tree.')
125
sub_tree_id = sub_tree.get_root_id()
126
if sub_tree_id == self.get_root_id():
127
raise errors.BadReferenceTarget(self, sub_tree,
128
'Trees have the same root id.')
129
if sub_tree_id in self.inventory:
130
raise errors.BadReferenceTarget(self, sub_tree,
131
'Root id already present in tree')
132
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
134
def _add(self, files, ids, kinds):
135
"""Helper function for add - updates the inventory.
137
:param files: sequence of pathnames, relative to the tree root
138
:param ids: sequence of suggested ids for the files (may be None)
139
:param kinds: sequence of inventory kinds of the files (i.e. may
140
contain "tree-reference")
142
raise NotImplementedError(self._add)
145
def commit(self, message=None, revprops=None, *args,
147
# avoid circular imports
148
from bzrlib import commit
151
if not 'branch-nick' in revprops:
152
revprops['branch-nick'] = self.branch.nick
153
# args for wt.commit start at message from the Commit.commit method,
154
# but with branch a kwarg now, passing in args as is results in the
155
#message being used for the branch
156
args = (DEPRECATED_PARAMETER, message, ) + args
157
committed_id = commit.Commit().commit(working_tree=self,
158
revprops=revprops, *args, **kwargs)
161
def _gather_kinds(self, files, kinds):
162
"""Helper function for add - sets the entries of kinds."""
163
raise NotImplementedError(self._gather_kinds)
166
def last_revision(self):
167
"""Return the revision id of the last commit performed in this tree.
169
In early tree formats the result of last_revision is the same as the
170
branch last_revision, but that is no longer the case for modern tree
173
last_revision returns the left most parent id, or None if there are no
176
last_revision was deprecated as of 0.11. Please use get_parent_ids
179
raise NotImplementedError(self.last_revision)
181
def lock_tree_write(self):
182
"""Lock the working tree for write, and the branch for read.
184
This is useful for operations which only need to mutate the working
185
tree. Taking out branch write locks is a relatively expensive process
186
and may fail if the branch is on read only media. So branch write locks
187
should only be taken out when we are modifying branch data - such as in
188
operations like commit, pull, uncommit and update.
190
raise NotImplementedError(self.lock_tree_write)
192
def lock_write(self):
193
"""Lock the tree and its branch. This allows mutating calls to be made.
195
Some mutating methods will take out implicit write locks, but in
196
general you should always obtain a write lock before calling mutating
199
raise NotImplementedError(self.lock_write)
202
def mkdir(self, path, file_id=None):
203
"""Create a directory in the tree. if file_id is None, one is assigned.
205
:param path: A unicode file path.
206
:param file_id: An optional file-id.
207
:return: the file id of the new directory.
209
raise NotImplementedError(self.mkdir)
211
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
212
"""Set the parents of the working tree.
214
:param parents_list: A list of (revision_id, tree) tuples.
215
If tree is None, then that element is treated as an unreachable
216
parent tree - i.e. a ghost.
218
raise NotImplementedError(self.set_parent_trees)
added
removed
bzrlib/mutabletree.py
