13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""MutableTree object.
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
28
27
from bzrlib import (
31
from bzrlib.osutils import dirname
32
from bzrlib.revisiontree import RevisionTree
33
from bzrlib.trace import mutter, warning
42
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
42
from bzrlib.osutils import splitpath
43
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
45
46
def needs_tree_write_lock(unbound):
67
68
entirely in memory.
69
70
For now, we are not treating MutableTree as an interface to provide
70
conformance tests for - rather we are testing MemoryTree specifically, and
71
conformance tests for - rather we are testing MemoryTree specifically, and
71
72
interface testing implementations of WorkingTree.
73
74
A mutable tree always has an associated Branch and BzrDir object - the
74
75
branch and bzrdir attributes.
76
def __init__(self, *args, **kw):
77
super(MutableTree, self).__init__(*args, **kw)
78
# Is this tree on a case-insensitive or case-preserving file-system?
79
# Sub-classes may initialize to False if they detect they are being
80
# used on media which doesn't differentiate the case of names.
81
self.case_sensitive = True
83
78
@needs_tree_write_lock
84
79
def add(self, files, ids=None, kinds=None):
100
95
TODO: Perhaps callback with the ids and paths as they're added.
102
97
if isinstance(files, basestring):
103
# XXX: Passing a single string is inconsistent and should be
105
if not (ids is None or isinstance(ids, basestring)):
106
raise AssertionError()
107
if not (kinds is None or isinstance(kinds, basestring)):
108
raise AssertionError()
98
assert(ids is None or isinstance(ids, basestring))
99
assert(kinds is None or isinstance(kinds, basestring))
110
101
if ids is not None:
118
109
ids = [None] * len(files)
120
if not (len(ids) == len(files)):
121
raise AssertionError()
111
assert(len(ids) == len(files))
122
112
if kinds is None:
123
113
kinds = [None] * len(files)
124
elif not len(kinds) == len(files):
125
raise AssertionError()
115
assert(len(kinds) == len(files))
127
117
# generic constraint checks:
128
118
if self.is_control_filename(f):
129
119
raise errors.ForbiddenControlFileError(filename=f)
130
fp = osutils.splitpath(f)
131
# fill out file kinds for all files [not needed when we stop
121
# fill out file kinds for all files [not needed when we stop
132
122
# caring about the instantaneous file kind within a uncommmitted tree
134
124
self._gather_kinds(files, kinds)
184
174
# avoid circular imports
185
175
from bzrlib import commit
186
possible_master_transports=[]
187
revprops = commit.Commit.update_revprops(
190
kwargs.pop('authors', None),
191
kwargs.pop('author', None),
192
kwargs.get('local', False),
193
possible_master_transports)
178
if not 'branch-nick' in revprops:
179
revprops['branch-nick'] = self.branch.nick
180
author = kwargs.pop('author', None)
181
if author is not None:
182
assert 'author' not in revprops
183
revprops['author'] = author
194
184
# args for wt.commit start at message from the Commit.commit method,
195
185
args = (message, ) + args
196
for hook in MutableTree.hooks['start_commit']:
198
186
committed_id = commit.Commit().commit(working_tree=self,
200
possible_master_transports=possible_master_transports,
202
post_hook_params = PostCommitHookParams(self)
203
for hook in MutableTree.hooks['post_commit']:
204
hook(post_hook_params)
187
revprops=revprops, *args, **kwargs)
205
188
return committed_id
207
190
def _gather_kinds(self, files, kinds):
209
192
raise NotImplementedError(self._gather_kinds)
212
def has_changes(self, _from_tree=None):
213
"""Quickly check that the tree contains at least one commitable change.
215
:param _from_tree: tree to compare against to find changes (default to
216
the basis tree and is intended to be used by tests).
218
:return: True if a change is found. False otherwise
220
# Check pending merges
221
if len(self.get_parent_ids()) > 1:
223
if _from_tree is None:
224
_from_tree = self.basis_tree()
225
changes = self.iter_changes(_from_tree)
227
change = changes.next()
228
# Exclude root (talk about black magic... --vila 20090629)
229
if change[4] == (None, None):
230
change = changes.next()
232
except StopIteration:
237
def check_changed_or_out_of_date(self, strict, opt_name,
238
more_error, more_warning):
239
"""Check the tree for uncommitted changes and branch synchronization.
241
If strict is None and not set in the config files, a warning is issued.
242
If strict is True, an error is raised.
243
If strict is False, no checks are done and no warning is issued.
245
:param strict: True, False or None, searched in branch config if None.
247
:param opt_name: strict option name to search in config file.
249
:param more_error: Details about how to avoid the check.
251
:param more_warning: Details about what is happening.
254
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
255
if strict is not False:
257
if (self.has_changes()):
258
err_class = errors.UncommittedChanges
259
elif self.last_revision() != self.branch.last_revision():
260
# The tree has lost sync with its branch, there is little
261
# chance that the user is aware of it but he can still force
262
# the action with --no-strict
263
err_class = errors.OutOfDateTree
264
if err_class is not None:
266
err = err_class(self, more=more_warning)
267
# We don't want to interrupt the user if he expressed no
268
# preference about strict.
269
trace.warning('%s', err._format())
271
err = err_class(self, more=more_error)
275
195
def last_revision(self):
276
196
"""Return the revision id of the last commit performed in this tree.
278
198
In early tree formats the result of last_revision is the same as the
279
199
branch last_revision, but that is no longer the case for modern tree
282
202
last_revision returns the left most parent id, or None if there are no
318
238
raise NotImplementedError(self.mkdir)
320
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
321
"""Tell the tree we have observed a paths sha1.
323
The intent of this function is to allow trees that have a hashcache to
324
update the hashcache during commit. If the observed file is too new
325
(based on the stat_value) to be safely hash-cached the tree will ignore
328
The default implementation does nothing.
330
:param file_id: The file id
331
:param path: The file path
332
:param sha1: The sha 1 that was observed.
333
:param stat_value: A stat result for the file the sha1 was read from.
337
def _fix_case_of_inventory_path(self, path):
338
"""If our tree isn't case sensitive, return the canonical path"""
339
if not self.case_sensitive:
340
path = self.get_canonical_inventory_path(path)
344
def put_file_bytes_non_atomic(self, file_id, bytes):
345
"""Update the content of a file in the tree.
347
Note that the file is written in-place rather than being
348
written to a temporary location and renamed. As a consequence,
349
readers can potentially see the file half-written.
351
:param file_id: file-id of the file
352
:param bytes: the new file contents
354
raise NotImplementedError(self.put_file_bytes_non_atomic)
356
240
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
357
241
"""Set the parents ids of the working tree.
363
247
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
364
248
"""Set the parents of the working tree.
366
:param parents_list: A list of (revision_id, tree) tuples.
250
:param parents_list: A list of (revision_id, tree) tuples.
367
251
If tree is None, then that element is treated as an unreachable
368
252
parent tree - i.e. a ghost.
376
260
This is designed more towards DWIM for humans than API clarity.
377
261
For the specific behaviour see the help for cmd_add().
379
:param file_list: List of zero or more paths. *NB: these are
380
interpreted relative to the process cwd, not relative to the
381
tree.* (Add and most other tree methods use tree-relative
383
263
:param action: A reporter to be called with the inventory, parent_ie,
384
path and kind of the path being added. It may return a file_id if
264
path and kind of the path being added. It may return a file_id if
385
265
a specific one should be used.
386
266
:param save: Save the inventory after completing the adds. If False
387
267
this provides dry-run functionality by doing the add and not saving
393
273
# not in an inner loop; and we want to remove direct use of this,
394
274
# so here as a reminder for now. RBC 20070703
395
275
from bzrlib.inventory import InventoryEntry
276
assert isinstance(recurse, bool)
396
277
if action is None:
397
278
action = add.AddAction()
399
280
if not file_list:
400
281
# no paths supplied: add the entire tree.
401
# FIXME: this assumes we are running in a working tree subdir :-/
403
282
file_list = [u'.']
404
283
# mutter("smart add of %r")
405
284
inv = self.inventory
409
288
user_dirs = set()
410
conflicts_related = set()
411
# Not all mutable trees can have conflicts
412
if getattr(self, 'conflicts', None) is not None:
413
# Collect all related files without checking whether they exist or
414
# are versioned. It's cheaper to do that once for all conflicts
415
# than trying to find the relevant conflict for each added file.
416
for c in self.conflicts():
417
conflicts_related.update(c.associated_filenames())
419
# expand any symlinks in the directory part, while leaving the
421
file_list = map(osutils.normalizepath, file_list)
423
# validate user file paths and convert all paths to tree
290
# validate user file paths and convert all paths to tree
424
291
# relative : it's cheaper to make a tree relative path an abspath
425
# than to convert an abspath to tree relative, and it's cheaper to
426
# perform the canonicalization in bulk.
427
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
428
rf = _FastPath(filepath)
429
# validate user parameters. Our recursive code avoids adding new
430
# files that need such validation
292
# than to convert an abspath to tree relative.
293
for filepath in file_list:
294
rf = _FastPath(self.relpath(filepath))
295
# validate user parameters. Our recursive code avoids adding new files
296
# that need such validation
431
297
if self.is_control_filename(rf.raw_path):
432
298
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
434
300
abspath = self.abspath(rf.raw_path)
435
301
kind = osutils.file_kind(abspath)
436
302
if kind == 'directory':
440
306
if not InventoryEntry.versionable_kind(kind):
441
307
raise errors.BadFileKindError(filename=abspath, kind=kind)
442
# ensure the named path is added, so that ignore rules in the later
443
# directory walk dont skip it.
444
# we dont have a parent ie known yet.: use the relatively slower
445
# inventory probing method
308
# ensure the named path is added, so that ignore rules in the later directory
310
# we dont have a parent ie known yet.: use the relatively slower inventory
446
312
versioned = inv.has_filename(rf.raw_path)
464
330
dirs_to_add.append((path, None))
465
331
prev_dir = path.raw_path
467
illegalpath_re = re.compile(r'[\r\n]')
468
333
# dirs_to_add is initialised to a list of directories, but as we scan
469
334
# directories we append files to it.
470
335
# XXX: We should determine kind of files when we scan them rather than
479
344
kind = osutils.file_kind(abspath)
481
346
if not InventoryEntry.versionable_kind(kind):
482
trace.warning("skipping %s (can't add file of kind '%s')",
485
if illegalpath_re.search(directory.raw_path):
486
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
488
if directory.raw_path in conflicts_related:
489
# If the file looks like one generated for a conflict, don't
492
'skipping %s (generated to help resolve conflicts)',
347
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
496
350
if parent_ie is not None:
497
351
versioned = directory.base_path in parent_ie.children
499
# without the parent ie, use the relatively slower inventory
353
# without the parent ie, use the relatively slower inventory
501
versioned = inv.has_filename(
502
self._fix_case_of_inventory_path(directory.raw_path))
355
versioned = inv.has_filename(directory.raw_path)
504
357
if kind == 'directory':
520
373
# mutter("%r is already versioned", abspath)
522
# XXX: This is wrong; people *might* reasonably be trying to
523
# add subtrees as subtrees. This should probably only be done
524
# in formats which can represent subtrees, and even then
525
# perhaps only when the user asked to add subtrees. At the
526
# moment you can add them specially through 'join --reference',
527
# which is perhaps reasonable: adding a new reference is a
528
# special operation and can have a special behaviour. mbp
530
trace.mutter("%r is a nested bzr tree", abspath)
375
# XXX: This is wrong; people *might* reasonably be trying to add
376
# subtrees as subtrees. This should probably only be done in formats
377
# which can represent subtrees, and even then perhaps only when
378
# the user asked to add subtrees. At the moment you can add them
379
# specially through 'join --reference', which is perhaps
380
# reasonable: adding a new reference is a special operation and
381
# can have a special behaviour. mbp 20070306
382
mutter("%r is a nested bzr tree", abspath)
532
384
_add_one(self, inv, parent_ie, directory, kind, action)
533
385
added.append(directory.raw_path)
537
389
# must be present:
538
390
this_ie = parent_ie.children[directory.base_path]
540
# without the parent ie, use the relatively slower inventory
392
# without the parent ie, use the relatively slower inventory
542
this_id = inv.path2id(
543
self._fix_case_of_inventory_path(directory.raw_path))
394
this_id = inv.path2id(directory.raw_path)
544
395
if this_id is None:
547
398
this_ie = inv[this_id]
549
400
for subf in sorted(os.listdir(abspath)):
550
# here we could use TreeDirectory rather than
401
# here we could use TreeDirectory rather than
551
402
# string concatenation.
552
403
subp = osutils.pathjoin(directory.raw_path, subf)
553
# TODO: is_control_filename is very slow. Make it faster.
554
# TreeDirectory.is_control_filename could also make this
555
# faster - its impossible for a non root dir to have a
404
# TODO: is_control_filename is very slow. Make it faster.
405
# TreeDirectory.is_control_filename could also make this
406
# faster - its impossible for a non root dir to have a
557
408
if self.is_control_filename(subp):
558
trace.mutter("skip control directory %r", subp)
409
mutter("skip control directory %r", subp)
559
410
elif subf in this_ie.children:
560
411
# recurse into this already versioned subdir.
561
412
dirs_to_add.append((_FastPath(subp, subf), this_ie))
611
459
# WorkingTree classes for optimised versions for specific format trees.
612
460
basis = self.basis_tree()
613
461
basis.lock_read()
614
# TODO: Consider re-evaluating the need for this with CHKInventory
615
# we don't strictly need to mutate an inventory for this
616
# it only makes sense when apply_delta is cheaper than get_inventory()
617
inventory = basis.inventory._get_mutable_inventory()
462
inventory = basis.inventory
619
464
inventory.apply_delta(delta)
620
rev_tree = revisiontree.RevisionTree(self.branch.repository,
621
inventory, new_revid)
465
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
622
466
self.set_parent_trees([(new_revid, rev_tree)])
625
class MutableTreeHooks(hooks.Hooks):
626
"""A dictionary mapping a hook name to a list of callables for mutabletree
631
"""Create the default hooks.
634
hooks.Hooks.__init__(self)
635
self.create_hook(hooks.HookPoint('start_commit',
636
"Called before a commit is performed on a tree. The start commit "
637
"hook is able to change the tree before the commit takes place. "
638
"start_commit is called with the bzrlib.mutabletree.MutableTree "
639
"that the commit is being performed on.", (1, 4), None))
640
self.create_hook(hooks.HookPoint('post_commit',
641
"Called after a commit is performed on a tree. The hook is "
642
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
643
"The mutable tree the commit was performed on is available via "
644
"the mutable_tree attribute of that object.", (2, 0), None))
647
# install the default hooks into the MutableTree class.
648
MutableTree.hooks = MutableTreeHooks()
651
class PostCommitHookParams(object):
652
"""Parameters for the post_commit hook.
654
To access the parameters, use the following attributes:
656
* mutable_tree - the MutableTree object
659
def __init__(self, mutable_tree):
660
"""Create the parameters for the post_commit hook."""
661
self.mutable_tree = mutable_tree
664
469
class _FastPath(object):
665
470
"""A path object with fast accessors for things like basename."""
702
507
# slower but does not need parent_ie
703
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
508
if inv.has_filename(path.raw_path):
705
510
# its really not there : add the parent
706
511
# note that the dirname use leads to some extra str copying etc but as
707
512
# there are a limited number of dirs we can be nested under, it should
708
513
# generally find it very fast and not recurse after that.
709
514
added = _add_one_and_parent(tree, inv, None,
710
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
711
parent_id = inv.path2id(osutils.dirname(path.raw_path))
515
_FastPath(dirname(path.raw_path)), 'directory', action)
516
parent_id = inv.path2id(dirname(path.raw_path))
712
517
parent_ie = inv[parent_id]
713
518
_add_one(tree, inv, parent_ie, path, kind, action)
714
519
return added + [path.raw_path]
724
529
file_id or None to generate a new file id
727
# if the parent exists, but isn't a directory, we have to do the
728
# kind change now -- really the inventory shouldn't pretend to know
729
# the kind of wt files, but it does.
730
if parent_ie.kind != 'directory':
731
# nb: this relies on someone else checking that the path we're using
732
# doesn't contain symlinks.
733
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
734
parent_ie.parent_id, parent_ie.file_id)
735
del inv[parent_ie.file_id]
736
inv.add(new_parent_ie)
737
parent_ie = new_parent_ie
738
532
file_id = file_id_callback(inv, parent_ie, path, kind)
739
533
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
