1
# Copyright (C) 2006-2011 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
17
"""MutableTree object.
19
See MutableTree for more details.
22
from __future__ import absolute_import
34
class BadReferenceTarget(errors.InternalBzrError):
36
_fmt = "Can't add reference to %(other_tree)s into %(tree)s." \
39
def __init__(self, tree, other_tree, reason):
41
self.other_tree = other_tree
45
class MutableTree(tree.Tree):
46
"""A MutableTree is a specialisation of Tree which is able to be mutated.
48
Generally speaking these mutations are only possible within a lock_write
49
context, and will revert if the lock is broken abnormally - but this cannot
50
be guaranteed - depending on the exact implementation of the mutable state.
52
The most common form of Mutable Tree is WorkingTree, see breezy.workingtree.
53
For tests we also have MemoryTree which is a MutableTree whose contents are
56
For now, we are not treating MutableTree as an interface to provide
57
conformance tests for - rather we are testing MemoryTree specifically, and
58
interface testing implementations of WorkingTree.
60
A mutable tree always has an associated Branch and ControlDir object - the
61
branch and bzrdir attributes.
64
def __init__(self, *args, **kw):
65
super(MutableTree, self).__init__(*args, **kw)
66
# Is this tree on a case-insensitive or case-preserving file-system?
67
# Sub-classes may initialize to False if they detect they are being
68
# used on media which doesn't differentiate the case of names.
69
self.case_sensitive = True
71
def is_control_filename(self, filename):
72
"""True if filename is the name of a control file in this tree.
74
:param filename: A filename within the tree. This is a relative path
75
from the root of this tree.
77
This is true IF and ONLY IF the filename is part of the meta data
78
that bzr controls in this tree. I.E. a random .bzr directory placed
79
on disk will not be a control file for this tree.
81
raise NotImplementedError(self.is_control_filename)
83
def add(self, files, ids=None, kinds=None):
84
"""Add paths to the set of versioned paths.
86
Note that the command line normally calls smart_add instead,
87
which can automatically recurse.
89
This adds the files to the tree, so that they will be
90
recorded by the next commit.
92
:param files: List of paths to add, relative to the base of the tree.
93
:param ids: If set, use these instead of automatically generated ids.
94
Must be the same length as the list of files, but may
95
contain None for ids that are to be autogenerated.
96
:param kinds: Optional parameter to specify the kinds to be used for
99
TODO: Perhaps callback with the ids and paths as they're added.
101
if isinstance(files, str):
102
# XXX: Passing a single string is inconsistent and should be
104
if not (ids is None or isinstance(ids, bytes)):
105
raise AssertionError()
106
if not (kinds is None or isinstance(kinds, str)):
107
raise AssertionError()
111
if kinds is not None:
114
files = [path.strip('/') for path in files]
117
ids = [None] * len(files)
119
if not (len(ids) == len(files)):
120
raise AssertionError()
122
kinds = [None] * len(files)
123
elif not len(kinds) == len(files):
124
raise AssertionError()
125
with self.lock_tree_write():
127
# generic constraint checks:
128
if self.is_control_filename(f):
129
raise errors.ForbiddenControlFileError(filename=f)
130
fp = osutils.splitpath(f)
131
# fill out file kinds for all files [not needed when we stop
132
# caring about the instantaneous file kind within a uncommmitted tree
134
self._gather_kinds(files, kinds)
135
self._add(files, ids, kinds)
137
def add_reference(self, sub_tree):
138
"""Add a TreeReference to the tree, pointing at sub_tree.
140
:param sub_tree: subtree to add.
142
raise errors.UnsupportedOperation(self.add_reference, self)
144
def _add(self, files, ids, kinds):
145
"""Helper function for add - updates the inventory.
147
:param files: sequence of pathnames, relative to the tree root
148
:param ids: sequence of suggested ids for the files (may be None)
149
:param kinds: sequence of inventory kinds of the files (i.e. may
150
contain "tree-reference")
152
raise NotImplementedError(self._add)
154
def commit(self, message=None, revprops=None, *args, **kwargs):
155
# avoid circular imports
156
from breezy import commit
157
possible_master_transports = []
158
with self.lock_write():
159
revprops = commit.Commit.update_revprops(
162
kwargs.pop('authors', None),
163
kwargs.get('local', False),
164
possible_master_transports)
165
# args for wt.commit start at message from the Commit.commit method,
166
args = (message, ) + args
167
for hook in MutableTree.hooks['start_commit']:
169
committed_id = commit.Commit().commit(working_tree=self,
171
possible_master_transports=possible_master_transports,
173
post_hook_params = PostCommitHookParams(self)
174
for hook in MutableTree.hooks['post_commit']:
175
hook(post_hook_params)
178
def _gather_kinds(self, files, kinds):
179
"""Helper function for add - sets the entries of kinds."""
180
raise NotImplementedError(self._gather_kinds)
182
def has_changes(self, _from_tree=None):
183
"""Quickly check that the tree contains at least one commitable change.
185
:param _from_tree: tree to compare against to find changes (default to
186
the basis tree and is intended to be used by tests).
188
:return: True if a change is found. False otherwise
190
with self.lock_read():
191
# Check pending merges
192
if len(self.get_parent_ids()) > 1:
194
if _from_tree is None:
195
_from_tree = self.basis_tree()
196
changes = self.iter_changes(_from_tree)
197
if self.supports_symlinks():
198
# Fast path for has_changes.
200
change = next(changes)
201
# Exclude root (talk about black magic... --vila 20090629)
202
if change.parent_id == (None, None):
203
change = next(changes)
205
except StopIteration:
209
# Slow path for has_changes.
210
# Handle platforms that do not support symlinks in the
211
# conditional below. This is slower than the try/except
212
# approach below that but we don't have a choice as we
213
# need to be sure that all symlinks are removed from the
214
# entire changeset. This is because in platforms that
215
# do not support symlinks, they show up as None in the
216
# working copy as compared to the repository.
217
# Also, exclude root as mention in the above fast path.
219
lambda c: c[6][0] != 'symlink' and c[4] != (None, None),
223
except StopIteration:
227
def check_changed_or_out_of_date(self, strict, opt_name,
228
more_error, more_warning):
229
"""Check the tree for uncommitted changes and branch synchronization.
231
If strict is None and not set in the config files, a warning is issued.
232
If strict is True, an error is raised.
233
If strict is False, no checks are done and no warning is issued.
235
:param strict: True, False or None, searched in branch config if None.
237
:param opt_name: strict option name to search in config file.
239
:param more_error: Details about how to avoid the check.
241
:param more_warning: Details about what is happening.
243
with self.lock_read():
245
strict = self.branch.get_config_stack().get(opt_name)
246
if strict is not False:
248
if (self.has_changes()):
249
err_class = errors.UncommittedChanges
250
elif self.last_revision() != self.branch.last_revision():
251
# The tree has lost sync with its branch, there is little
252
# chance that the user is aware of it but he can still
253
# force the action with --no-strict
254
err_class = errors.OutOfDateTree
255
if err_class is not None:
257
err = err_class(self, more=more_warning)
258
# We don't want to interrupt the user if he expressed
259
# no preference about strict.
260
trace.warning('%s', err._format())
262
err = err_class(self, more=more_error)
265
def last_revision(self):
266
"""Return the revision id of the last commit performed in this tree.
268
In early tree formats the result of last_revision is the same as the
269
branch last_revision, but that is no longer the case for modern tree
272
last_revision returns the left most parent id, or None if there are no
275
last_revision was deprecated as of 0.11. Please use get_parent_ids
278
raise NotImplementedError(self.last_revision)
280
def lock_tree_write(self):
281
"""Lock the working tree for write, and the branch for read.
283
This is useful for operations which only need to mutate the working
284
tree. Taking out branch write locks is a relatively expensive process
285
and may fail if the branch is on read only media. So branch write locks
286
should only be taken out when we are modifying branch data - such as in
287
operations like commit, pull, uncommit and update.
289
raise NotImplementedError(self.lock_tree_write)
291
def lock_write(self):
292
"""Lock the tree and its branch. This allows mutating calls to be made.
294
Some mutating methods will take out implicit write locks, but in
295
general you should always obtain a write lock before calling mutating
298
raise NotImplementedError(self.lock_write)
300
def mkdir(self, path, file_id=None):
301
"""Create a directory in the tree. if file_id is None, one is assigned.
303
:param path: A unicode file path.
304
:param file_id: An optional file-id.
305
:return: the file id of the new directory.
307
raise NotImplementedError(self.mkdir)
309
def _observed_sha1(self, path, sha_and_stat):
310
"""Tell the tree we have observed a paths sha1.
312
The intent of this function is to allow trees that have a hashcache to
313
update the hashcache during commit. If the observed file is too new
314
(based on the stat_value) to be safely hash-cached the tree will ignore
317
The default implementation does nothing.
319
:param path: The file path
320
:param sha_and_stat: The sha 1 and stat result observed.
324
def put_file_bytes_non_atomic(self, path, bytes):
325
"""Update the content of a file in the tree.
327
Note that the file is written in-place rather than being
328
written to a temporary location and renamed. As a consequence,
329
readers can potentially see the file half-written.
331
:param file_id: file-id of the file
332
:param bytes: the new file contents
334
raise NotImplementedError(self.put_file_bytes_non_atomic)
336
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
337
"""Set the parents ids of the working tree.
339
:param revision_ids: A list of revision_ids.
341
raise NotImplementedError(self.set_parent_ids)
343
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
344
"""Set the parents of the working tree.
346
:param parents_list: A list of (revision_id, tree) tuples.
347
If tree is None, then that element is treated as an unreachable
348
parent tree - i.e. a ghost.
350
raise NotImplementedError(self.set_parent_trees)
352
def smart_add(self, file_list, recurse=True, action=None, save=True):
353
"""Version file_list, optionally recursing into directories.
355
This is designed more towards DWIM for humans than API clarity.
356
For the specific behaviour see the help for cmd_add().
358
:param file_list: List of zero or more paths. *NB: these are
359
interpreted relative to the process cwd, not relative to the
360
tree.* (Add and most other tree methods use tree-relative
362
:param action: A reporter to be called with the working tree, parent_ie,
363
path and kind of the path being added. It may return a file_id if
364
a specific one should be used.
365
:param save: Save the changes after completing the adds. If False
366
this provides dry-run functionality by doing the add and not saving
368
:return: A tuple - files_added, ignored_files. files_added is the count
369
of added files, and ignored_files is a dict mapping files that were
370
ignored to the rule that caused them to be ignored.
372
raise NotImplementedError(self.smart_add)
374
def rename_one(self, from_rel, to_rel, after=False):
377
This can change the directory or the filename or both.
379
rename_one has several 'modes' to work. First, it can rename a physical
380
file and change the file_id. That is the normal mode. Second, it can
381
only change the file_id without touching any physical file.
383
rename_one uses the second mode if 'after == True' and 'to_rel' is
384
either not versioned or newly added, and present in the working tree.
386
rename_one uses the second mode if 'after == False' and 'from_rel' is
387
versioned but no longer in the working tree, and 'to_rel' is not
388
versioned but present in the working tree.
390
rename_one uses the first mode if 'after == False' and 'from_rel' is
391
versioned and present in the working tree, and 'to_rel' is not
392
versioned and not present in the working tree.
394
Everything else results in an error.
396
raise NotImplementedError(self.rename_one)
398
def copy_one(self, from_rel, to_rel):
399
"""Copy one file or directory.
401
This can change the directory or the filename or both.
404
raise NotImplementedError(self.copy_one)
406
def get_transform(self, pb=None):
407
"""Return a transform object for use with this tree."""
408
raise NotImplementedError(self.get_transform)
411
class MutableTreeHooks(hooks.Hooks):
412
"""A dictionary mapping a hook name to a list of callables for mutabletree
417
"""Create the default hooks.
420
hooks.Hooks.__init__(self, "breezy.mutabletree", "MutableTree.hooks")
421
self.add_hook('start_commit',
422
"Called before a commit is performed on a tree. The start commit "
423
"hook is able to change the tree before the commit takes place. "
424
"start_commit is called with the breezy.mutabletree.MutableTree "
425
"that the commit is being performed on.", (1, 4))
426
self.add_hook('post_commit',
427
"Called after a commit is performed on a tree. The hook is "
428
"called with a breezy.mutabletree.PostCommitHookParams object. "
429
"The mutable tree the commit was performed on is available via "
430
"the mutable_tree attribute of that object.", (2, 0))
431
self.add_hook('pre_transform',
432
"Called before a tree transform on this tree. The hook is called "
433
"with the tree that is being transformed and the transform.",
435
self.add_hook('post_build_tree',
436
"Called after a completely new tree is built. The hook is "
437
"called with the tree as its only argument.", (2, 5))
438
self.add_hook('post_transform',
439
"Called after a tree transform has been performed on a tree. "
440
"The hook is called with the tree that is being transformed and "
445
# install the default hooks into the MutableTree class.
446
MutableTree.hooks = MutableTreeHooks()
449
class PostCommitHookParams(object):
450
"""Parameters for the post_commit hook.
452
To access the parameters, use the following attributes:
454
* mutable_tree - the MutableTree object
457
def __init__(self, mutable_tree):
458
"""Create the parameters for the post_commit hook."""
459
self.mutable_tree = mutable_tree
added
removed
breezy/mutabletree.py
