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.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
def needs_tree_write_lock(unbound):
46
"""Decorate unbound to take out and release a tree_write lock."""
47
def tree_write_locked(self, *args, **kwargs):
48
self.lock_tree_write()
50
return unbound(self, *args, **kwargs)
53
tree_write_locked.__doc__ = unbound.__doc__
54
tree_write_locked.__name__ = unbound.__name__
55
return tree_write_locked
58
class MutableTree(tree.Tree):
59
"""A MutableTree is a specialisation of Tree which is able to be mutated.
61
Generally speaking these mutations are only possible within a lock_write
62
context, and will revert if the lock is broken abnormally - but this cannot
63
be guaranteed - depending on the exact implementation of the mutable state.
65
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
66
For tests we also have MemoryTree which is a MutableTree whose contents are
69
For now, we are not treating MutableTree as an interface to provide
70
conformance tests for - rather we are testing MemoryTree specifically, and
71
interface testing implementations of WorkingTree.
73
A mutable tree always has an associated Branch and BzrDir object - the
74
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
def is_control_filename(self, filename):
84
"""True if filename is the name of a control file in this tree.
86
:param filename: A filename within the tree. This is a relative path
87
from the root of this tree.
89
This is true IF and ONLY IF the filename is part of the meta data
90
that bzr controls in this tree. I.E. a random .bzr directory placed
91
on disk will not be a control file for this tree.
93
raise NotImplementedError(self.is_control_filename)
95
@needs_tree_write_lock
96
def add(self, files, ids=None, kinds=None):
97
"""Add paths to the set of versioned paths.
99
Note that the command line normally calls smart_add instead,
100
which can automatically recurse.
102
This adds the files to the inventory, so that they will be
103
recorded by the next commit.
105
:param files: List of paths to add, relative to the base of the tree.
106
:param ids: If set, use these instead of automatically generated ids.
107
Must be the same length as the list of files, but may
108
contain None for ids that are to be autogenerated.
109
:param kinds: Optional parameter to specify the kinds to be used for
112
TODO: Perhaps callback with the ids and paths as they're added.
114
if isinstance(files, basestring):
115
# XXX: Passing a single string is inconsistent and should be
117
if not (ids is None or isinstance(ids, basestring)):
118
raise AssertionError()
119
if not (kinds is None or isinstance(kinds, basestring)):
120
raise AssertionError()
124
if kinds is not None:
127
files = [path.strip('/') for path in files]
130
ids = [None] * len(files)
132
if not (len(ids) == len(files)):
133
raise AssertionError()
135
kinds = [None] * len(files)
136
elif not len(kinds) == len(files):
137
raise AssertionError()
139
# generic constraint checks:
140
if self.is_control_filename(f):
141
raise errors.ForbiddenControlFileError(filename=f)
142
fp = osutils.splitpath(f)
143
# fill out file kinds for all files [not needed when we stop
144
# caring about the instantaneous file kind within a uncommmitted tree
146
self._gather_kinds(files, kinds)
147
self._add(files, ids, kinds)
149
def add_reference(self, sub_tree):
150
"""Add a TreeReference to the tree, pointing at sub_tree"""
151
raise errors.UnsupportedOperation(self.add_reference, self)
153
def _add_reference(self, sub_tree):
154
"""Standard add_reference implementation, for use by subclasses"""
156
sub_tree_path = self.relpath(sub_tree.basedir)
157
except errors.PathNotChild:
158
raise errors.BadReferenceTarget(self, sub_tree,
159
'Target not inside tree.')
160
sub_tree_id = sub_tree.get_root_id()
161
if sub_tree_id == self.get_root_id():
162
raise errors.BadReferenceTarget(self, sub_tree,
163
'Trees have the same root id.')
164
if sub_tree_id in self.inventory:
165
raise errors.BadReferenceTarget(self, sub_tree,
166
'Root id already present in tree')
167
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
169
def _add(self, files, ids, kinds):
170
"""Helper function for add - updates the inventory.
172
:param files: sequence of pathnames, relative to the tree root
173
:param ids: sequence of suggested ids for the files (may be None)
174
:param kinds: sequence of inventory kinds of the files (i.e. may
175
contain "tree-reference")
177
raise NotImplementedError(self._add)
179
@needs_tree_write_lock
180
def apply_inventory_delta(self, changes):
181
"""Apply changes to the inventory as an atomic operation.
183
:param changes: An inventory delta to apply to the working tree's
186
:seealso Inventory.apply_delta: For details on the changes parameter.
190
inv.apply_delta(changes)
191
self._write_inventory(inv)
194
def commit(self, message=None, revprops=None, *args,
196
# avoid circular imports
197
from bzrlib import commit
198
possible_master_transports=[]
199
revprops = commit.Commit.update_revprops(
202
kwargs.pop('authors', None),
203
kwargs.pop('author', None),
204
kwargs.get('local', False),
205
possible_master_transports)
206
# args for wt.commit start at message from the Commit.commit method,
207
args = (message, ) + args
208
for hook in MutableTree.hooks['start_commit']:
210
committed_id = commit.Commit().commit(working_tree=self,
212
possible_master_transports=possible_master_transports,
214
post_hook_params = PostCommitHookParams(self)
215
for hook in MutableTree.hooks['post_commit']:
216
hook(post_hook_params)
219
def _gather_kinds(self, files, kinds):
220
"""Helper function for add - sets the entries of kinds."""
221
raise NotImplementedError(self._gather_kinds)
224
def has_changes(self, _from_tree=None):
225
"""Quickly check that the tree contains at least one commitable change.
227
:param _from_tree: tree to compare against to find changes (default to
228
the basis tree and is intended to be used by tests).
230
:return: True if a change is found. False otherwise
232
# Check pending merges
233
if len(self.get_parent_ids()) > 1:
235
if _from_tree is None:
236
_from_tree = self.basis_tree()
237
changes = self.iter_changes(_from_tree)
239
change = changes.next()
240
# Exclude root (talk about black magic... --vila 20090629)
241
if change[4] == (None, None):
242
change = changes.next()
244
except StopIteration:
249
def check_changed_or_out_of_date(self, strict, opt_name,
250
more_error, more_warning):
251
"""Check the tree for uncommitted changes and branch synchronization.
253
If strict is None and not set in the config files, a warning is issued.
254
If strict is True, an error is raised.
255
If strict is False, no checks are done and no warning is issued.
257
:param strict: True, False or None, searched in branch config if None.
259
:param opt_name: strict option name to search in config file.
261
:param more_error: Details about how to avoid the check.
263
:param more_warning: Details about what is happening.
266
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
267
if strict is not False:
269
if (self.has_changes()):
270
err_class = errors.UncommittedChanges
271
elif self.last_revision() != self.branch.last_revision():
272
# The tree has lost sync with its branch, there is little
273
# chance that the user is aware of it but he can still force
274
# the action with --no-strict
275
err_class = errors.OutOfDateTree
276
if err_class is not None:
278
err = err_class(self, more=more_warning)
279
# We don't want to interrupt the user if he expressed no
280
# preference about strict.
281
trace.warning('%s', err._format())
283
err = err_class(self, more=more_error)
287
def last_revision(self):
288
"""Return the revision id of the last commit performed in this tree.
290
In early tree formats the result of last_revision is the same as the
291
branch last_revision, but that is no longer the case for modern tree
294
last_revision returns the left most parent id, or None if there are no
297
last_revision was deprecated as of 0.11. Please use get_parent_ids
300
raise NotImplementedError(self.last_revision)
302
def lock_tree_write(self):
303
"""Lock the working tree for write, and the branch for read.
305
This is useful for operations which only need to mutate the working
306
tree. Taking out branch write locks is a relatively expensive process
307
and may fail if the branch is on read only media. So branch write locks
308
should only be taken out when we are modifying branch data - such as in
309
operations like commit, pull, uncommit and update.
311
raise NotImplementedError(self.lock_tree_write)
313
def lock_write(self):
314
"""Lock the tree and its branch. This allows mutating calls to be made.
316
Some mutating methods will take out implicit write locks, but in
317
general you should always obtain a write lock before calling mutating
320
raise NotImplementedError(self.lock_write)
323
def mkdir(self, path, file_id=None):
324
"""Create a directory in the tree. if file_id is None, one is assigned.
326
:param path: A unicode file path.
327
:param file_id: An optional file-id.
328
:return: the file id of the new directory.
330
raise NotImplementedError(self.mkdir)
332
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
333
"""Tell the tree we have observed a paths sha1.
335
The intent of this function is to allow trees that have a hashcache to
336
update the hashcache during commit. If the observed file is too new
337
(based on the stat_value) to be safely hash-cached the tree will ignore
340
The default implementation does nothing.
342
:param file_id: The file id
343
:param path: The file path
344
:param sha1: The sha 1 that was observed.
345
:param stat_value: A stat result for the file the sha1 was read from.
349
def _fix_case_of_inventory_path(self, path):
350
"""If our tree isn't case sensitive, return the canonical path"""
351
if not self.case_sensitive:
352
path = self.get_canonical_inventory_path(path)
356
def put_file_bytes_non_atomic(self, file_id, bytes):
357
"""Update the content of a file in the tree.
359
Note that the file is written in-place rather than being
360
written to a temporary location and renamed. As a consequence,
361
readers can potentially see the file half-written.
363
:param file_id: file-id of the file
364
:param bytes: the new file contents
366
raise NotImplementedError(self.put_file_bytes_non_atomic)
368
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
369
"""Set the parents ids of the working tree.
371
:param revision_ids: A list of revision_ids.
373
raise NotImplementedError(self.set_parent_ids)
375
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
376
"""Set the parents of the working tree.
378
:param parents_list: A list of (revision_id, tree) tuples.
379
If tree is None, then that element is treated as an unreachable
380
parent tree - i.e. a ghost.
382
raise NotImplementedError(self.set_parent_trees)
384
@needs_tree_write_lock
385
def smart_add(self, file_list, recurse=True, action=None, save=True):
386
"""Version file_list, optionally recursing into directories.
388
This is designed more towards DWIM for humans than API clarity.
389
For the specific behaviour see the help for cmd_add().
391
:param file_list: List of zero or more paths. *NB: these are
392
interpreted relative to the process cwd, not relative to the
393
tree.* (Add and most other tree methods use tree-relative
395
:param action: A reporter to be called with the inventory, parent_ie,
396
path and kind of the path being added. It may return a file_id if
397
a specific one should be used.
398
:param save: Save the inventory after completing the adds. If False
399
this provides dry-run functionality by doing the add and not saving
401
:return: A tuple - files_added, ignored_files. files_added is the count
402
of added files, and ignored_files is a dict mapping files that were
403
ignored to the rule that caused them to be ignored.
405
# not in an inner loop; and we want to remove direct use of this,
406
# so here as a reminder for now. RBC 20070703
407
from bzrlib.inventory import InventoryEntry
409
action = add.AddAction()
412
# no paths supplied: add the entire tree.
413
# FIXME: this assumes we are running in a working tree subdir :-/
416
# mutter("smart add of %r")
422
conflicts_related = set()
423
# Not all mutable trees can have conflicts
424
if getattr(self, 'conflicts', None) is not None:
425
# Collect all related files without checking whether they exist or
426
# are versioned. It's cheaper to do that once for all conflicts
427
# than trying to find the relevant conflict for each added file.
428
for c in self.conflicts():
429
conflicts_related.update(c.associated_filenames())
431
# expand any symlinks in the directory part, while leaving the
433
# only expanding if symlinks are supported avoids windows path bugs
434
if osutils.has_symlinks():
435
file_list = map(osutils.normalizepath, file_list)
437
# validate user file paths and convert all paths to tree
438
# relative : it's cheaper to make a tree relative path an abspath
439
# than to convert an abspath to tree relative, and it's cheaper to
440
# perform the canonicalization in bulk.
441
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
442
rf = _FastPath(filepath)
443
# validate user parameters. Our recursive code avoids adding new
444
# files that need such validation
445
if self.is_control_filename(rf.raw_path):
446
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
448
abspath = self.abspath(rf.raw_path)
449
kind = osutils.file_kind(abspath)
450
if kind == 'directory':
451
# schedule the dir for scanning
454
if not InventoryEntry.versionable_kind(kind):
455
raise errors.BadFileKindError(filename=abspath, kind=kind)
456
# ensure the named path is added, so that ignore rules in the later
457
# directory walk dont skip it.
458
# we dont have a parent ie known yet.: use the relatively slower
459
# inventory probing method
460
versioned = inv.has_filename(rf.raw_path)
463
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
466
# no need to walk any directories at all.
467
if len(added) > 0 and save:
468
self._write_inventory(inv)
469
return added, ignored
471
# only walk the minimal parents needed: we have user_dirs to override
475
is_inside = osutils.is_inside_or_parent_of_any
476
for path in sorted(user_dirs):
477
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
478
dirs_to_add.append((path, None))
479
prev_dir = path.raw_path
481
illegalpath_re = re.compile(r'[\r\n]')
482
# dirs_to_add is initialised to a list of directories, but as we scan
483
# directories we append files to it.
484
# XXX: We should determine kind of files when we scan them rather than
485
# adding to this list. RBC 20070703
486
for directory, parent_ie in dirs_to_add:
487
# directory is tree-relative
488
abspath = self.abspath(directory.raw_path)
490
# get the contents of this directory.
492
# find the kind of the path being added.
493
kind = osutils.file_kind(abspath)
495
if not InventoryEntry.versionable_kind(kind):
496
trace.warning("skipping %s (can't add file of kind '%s')",
499
if illegalpath_re.search(directory.raw_path):
500
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
502
if directory.raw_path in conflicts_related:
503
# If the file looks like one generated for a conflict, don't
506
'skipping %s (generated to help resolve conflicts)',
510
if parent_ie is not None:
511
versioned = directory.base_path in parent_ie.children
513
# without the parent ie, use the relatively slower inventory
515
versioned = inv.has_filename(
516
self._fix_case_of_inventory_path(directory.raw_path))
518
if kind == 'directory':
520
sub_branch = bzrdir.BzrDir.open(abspath)
522
except errors.NotBranchError:
524
except errors.UnsupportedFormatError:
529
if directory.raw_path == '':
530
# mutter("tree root doesn't need to be added")
534
# mutter("%r is already versioned", abspath)
536
# XXX: This is wrong; people *might* reasonably be trying to
537
# add subtrees as subtrees. This should probably only be done
538
# in formats which can represent subtrees, and even then
539
# perhaps only when the user asked to add subtrees. At the
540
# moment you can add them specially through 'join --reference',
541
# which is perhaps reasonable: adding a new reference is a
542
# special operation and can have a special behaviour. mbp
544
trace.mutter("%r is a nested bzr tree", abspath)
546
_add_one(self, inv, parent_ie, directory, kind, action)
547
added.append(directory.raw_path)
549
if kind == 'directory' and not sub_tree:
550
if parent_ie is not None:
552
this_ie = parent_ie.children[directory.base_path]
554
# without the parent ie, use the relatively slower inventory
556
this_id = inv.path2id(
557
self._fix_case_of_inventory_path(directory.raw_path))
561
this_ie = inv[this_id]
562
# Same as in _add_one below, if the inventory doesn't
563
# think this is a directory, update the inventory
564
if this_ie.kind != 'directory':
565
this_ie = inventory.make_entry('directory',
566
this_ie.name, this_ie.parent_id, this_id)
570
for subf in sorted(os.listdir(abspath)):
571
# here we could use TreeDirectory rather than
572
# string concatenation.
573
subp = osutils.pathjoin(directory.raw_path, subf)
574
# TODO: is_control_filename is very slow. Make it faster.
575
# TreeDirectory.is_control_filename could also make this
576
# faster - its impossible for a non root dir to have a
578
if self.is_control_filename(subp):
579
trace.mutter("skip control directory %r", subp)
580
elif subf in this_ie.children:
581
# recurse into this already versioned subdir.
582
dirs_to_add.append((_FastPath(subp, subf), this_ie))
584
# user selection overrides ignoes
585
# ignore while selecting files - if we globbed in the
586
# outer loop we would ignore user files.
587
ignore_glob = self.is_ignored(subp)
588
if ignore_glob is not None:
589
# mutter("skip ignored sub-file %r", subp)
590
ignored.setdefault(ignore_glob, []).append(subp)
592
#mutter("queue to add sub-file %r", subp)
593
dirs_to_add.append((_FastPath(subp, subf), this_ie))
597
self._write_inventory(inv)
599
self.read_working_inventory()
600
return added, ignored
602
def update_basis_by_delta(self, new_revid, delta):
603
"""Update the parents of this tree after a commit.
605
This gives the tree one parent, with revision id new_revid. The
606
inventory delta is applied to the current basis tree to generate the
607
inventory for the parent new_revid, and all other parent trees are
610
All the changes in the delta should be changes synchronising the basis
611
tree with some or all of the working tree, with a change to a directory
612
requiring that its contents have been recursively included. That is,
613
this is not a general purpose tree modification routine, but a helper
614
for commit which is not required to handle situations that do not arise
617
See the inventory developers documentation for the theory behind
620
:param new_revid: The new revision id for the trees parent.
621
:param delta: An inventory delta (see apply_inventory_delta) describing
622
the changes from the current left most parent revision to new_revid.
624
# if the tree is updated by a pull to the branch, as happens in
625
# WorkingTree2, when there was no separation between branch and tree,
626
# then just clear merges, efficiency is not a concern for now as this
627
# is legacy environments only, and they are slow regardless.
628
if self.last_revision() == new_revid:
629
self.set_parent_ids([new_revid])
631
# generic implementation based on Inventory manipulation. See
632
# WorkingTree classes for optimised versions for specific format trees.
633
basis = self.basis_tree()
635
# TODO: Consider re-evaluating the need for this with CHKInventory
636
# we don't strictly need to mutate an inventory for this
637
# it only makes sense when apply_delta is cheaper than get_inventory()
638
inventory = basis.inventory._get_mutable_inventory()
640
inventory.apply_delta(delta)
641
rev_tree = revisiontree.RevisionTree(self.branch.repository,
642
inventory, new_revid)
643
self.set_parent_trees([(new_revid, rev_tree)])
646
class MutableTreeHooks(hooks.Hooks):
647
"""A dictionary mapping a hook name to a list of callables for mutabletree
652
"""Create the default hooks.
655
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
656
self.add_hook('start_commit',
657
"Called before a commit is performed on a tree. The start commit "
658
"hook is able to change the tree before the commit takes place. "
659
"start_commit is called with the bzrlib.mutabletree.MutableTree "
660
"that the commit is being performed on.", (1, 4))
661
self.add_hook('post_commit',
662
"Called after a commit is performed on a tree. The hook is "
663
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
664
"The mutable tree the commit was performed on is available via "
665
"the mutable_tree attribute of that object.", (2, 0))
668
# install the default hooks into the MutableTree class.
669
MutableTree.hooks = MutableTreeHooks()
672
class PostCommitHookParams(object):
673
"""Parameters for the post_commit hook.
675
To access the parameters, use the following attributes:
677
* mutable_tree - the MutableTree object
680
def __init__(self, mutable_tree):
681
"""Create the parameters for the post_commit hook."""
682
self.mutable_tree = mutable_tree
685
class _FastPath(object):
686
"""A path object with fast accessors for things like basename."""
688
__slots__ = ['raw_path', 'base_path']
690
def __init__(self, path, base_path=None):
691
"""Construct a FastPath from path."""
692
if base_path is None:
693
self.base_path = osutils.basename(path)
695
self.base_path = base_path
698
def __cmp__(self, other):
699
return cmp(self.raw_path, other.raw_path)
702
return hash(self.raw_path)
705
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
706
"""Add a new entry to the inventory and automatically add unversioned parents.
708
:param inv: Inventory which will receive the new entry.
709
:param parent_ie: Parent inventory entry if known, or None. If
710
None, the parent is looked up by name and used if present, otherwise it
711
is recursively added.
712
:param kind: Kind of new entry (file, directory, etc)
713
:param action: callback(inv, parent_ie, path, kind); return ignored.
714
:return: A list of paths which have been added.
716
# Nothing to do if path is already versioned.
717
# This is safe from infinite recursion because the tree root is
719
if parent_ie is not None:
720
# we have a parent ie already
723
# slower but does not need parent_ie
724
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
726
# its really not there : add the parent
727
# note that the dirname use leads to some extra str copying etc but as
728
# there are a limited number of dirs we can be nested under, it should
729
# generally find it very fast and not recurse after that.
730
added = _add_one_and_parent(tree, inv, None,
731
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
732
parent_id = inv.path2id(osutils.dirname(path.raw_path))
733
parent_ie = inv[parent_id]
734
_add_one(tree, inv, parent_ie, path, kind, action)
735
return added + [path.raw_path]
738
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
739
"""Add a new entry to the inventory.
741
:param inv: Inventory which will receive the new entry.
742
:param parent_ie: Parent inventory entry.
743
:param kind: Kind of new entry (file, directory, etc)
744
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
745
file_id or None to generate a new file id
748
# if the parent exists, but isn't a directory, we have to do the
749
# kind change now -- really the inventory shouldn't pretend to know
750
# the kind of wt files, but it does.
751
if parent_ie.kind != 'directory':
752
# nb: this relies on someone else checking that the path we're using
753
# doesn't contain symlinks.
754
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
755
parent_ie.parent_id, parent_ie.file_id)
756
del inv[parent_ie.file_id]
757
inv.add(new_parent_ie)
758
parent_ie = new_parent_ie
759
file_id = file_id_callback(inv, parent_ie, path, kind)
760
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
