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(), """
41
from bzrlib.decorators import needs_read_lock, needs_write_lock
44
def needs_tree_write_lock(unbound):
45
"""Decorate unbound to take out and release a tree_write lock."""
46
def tree_write_locked(self, *args, **kwargs):
47
self.lock_tree_write()
49
return unbound(self, *args, **kwargs)
52
tree_write_locked.__doc__ = unbound.__doc__
53
tree_write_locked.__name__ = unbound.__name__
54
return tree_write_locked
57
class MutableTree(tree.Tree):
58
"""A MutableTree is a specialisation of Tree which is able to be mutated.
60
Generally speaking these mutations are only possible within a lock_write
61
context, and will revert if the lock is broken abnormally - but this cannot
62
be guaranteed - depending on the exact implementation of the mutable state.
64
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
65
For tests we also have MemoryTree which is a MutableTree whose contents are
68
For now, we are not treating MutableTree as an interface to provide
69
conformance tests for - rather we are testing MemoryTree specifically, and
70
interface testing implementations of WorkingTree.
72
A mutable tree always has an associated Branch and BzrDir object - the
73
branch and bzrdir attributes.
75
def __init__(self, *args, **kw):
76
super(MutableTree, self).__init__(*args, **kw)
77
# Is this tree on a case-insensitive or case-preserving file-system?
78
# Sub-classes may initialize to False if they detect they are being
79
# used on media which doesn't differentiate the case of names.
80
self.case_sensitive = True
82
def is_control_filename(self, filename):
83
"""True if filename is the name of a control file in this tree.
85
:param filename: A filename within the tree. This is a relative path
86
from the root of this tree.
88
This is true IF and ONLY IF the filename is part of the meta data
89
that bzr controls in this tree. I.E. a random .bzr directory placed
90
on disk will not be a control file for this tree.
92
raise NotImplementedError(self.is_control_filename)
94
@needs_tree_write_lock
95
def add(self, files, ids=None, kinds=None):
96
"""Add paths to the set of versioned paths.
98
Note that the command line normally calls smart_add instead,
99
which can automatically recurse.
101
This adds the files to the inventory, so that they will be
102
recorded by the next commit.
104
:param files: List of paths to add, relative to the base of the tree.
105
:param ids: If set, use these instead of automatically generated ids.
106
Must be the same length as the list of files, but may
107
contain None for ids that are to be autogenerated.
108
:param kinds: Optional parameter to specify the kinds to be used for
111
TODO: Perhaps callback with the ids and paths as they're added.
113
if isinstance(files, basestring):
114
# XXX: Passing a single string is inconsistent and should be
116
if not (ids is None or isinstance(ids, basestring)):
117
raise AssertionError()
118
if not (kinds is None or isinstance(kinds, basestring)):
119
raise AssertionError()
123
if kinds is not None:
126
files = [path.strip('/') for path in files]
129
ids = [None] * len(files)
131
if not (len(ids) == len(files)):
132
raise AssertionError()
134
kinds = [None] * len(files)
135
elif not len(kinds) == len(files):
136
raise AssertionError()
138
# generic constraint checks:
139
if self.is_control_filename(f):
140
raise errors.ForbiddenControlFileError(filename=f)
141
fp = osutils.splitpath(f)
142
# fill out file kinds for all files [not needed when we stop
143
# caring about the instantaneous file kind within a uncommmitted tree
145
self._gather_kinds(files, kinds)
146
self._add(files, ids, kinds)
148
def add_reference(self, sub_tree):
149
"""Add a TreeReference to the tree, pointing at sub_tree"""
150
raise errors.UnsupportedOperation(self.add_reference, self)
152
def _add_reference(self, sub_tree):
153
"""Standard add_reference implementation, for use by subclasses"""
155
sub_tree_path = self.relpath(sub_tree.basedir)
156
except errors.PathNotChild:
157
raise errors.BadReferenceTarget(self, sub_tree,
158
'Target not inside tree.')
159
sub_tree_id = sub_tree.get_root_id()
160
if sub_tree_id == self.get_root_id():
161
raise errors.BadReferenceTarget(self, sub_tree,
162
'Trees have the same root id.')
163
if sub_tree_id in self.inventory:
164
raise errors.BadReferenceTarget(self, sub_tree,
165
'Root id already present in tree')
166
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
168
def _add(self, files, ids, kinds):
169
"""Helper function for add - updates the inventory.
171
:param files: sequence of pathnames, relative to the tree root
172
:param ids: sequence of suggested ids for the files (may be None)
173
:param kinds: sequence of inventory kinds of the files (i.e. may
174
contain "tree-reference")
176
raise NotImplementedError(self._add)
178
@needs_tree_write_lock
179
def apply_inventory_delta(self, changes):
180
"""Apply changes to the inventory as an atomic operation.
182
:param changes: An inventory delta to apply to the working tree's
185
:seealso Inventory.apply_delta: For details on the changes parameter.
189
inv.apply_delta(changes)
190
self._write_inventory(inv)
193
def commit(self, message=None, revprops=None, *args,
195
# avoid circular imports
196
from bzrlib import commit
197
possible_master_transports=[]
198
revprops = commit.Commit.update_revprops(
201
kwargs.pop('authors', None),
202
kwargs.pop('author', None),
203
kwargs.get('local', False),
204
possible_master_transports)
205
# args for wt.commit start at message from the Commit.commit method,
206
args = (message, ) + args
207
for hook in MutableTree.hooks['start_commit']:
209
committed_id = commit.Commit().commit(working_tree=self,
211
possible_master_transports=possible_master_transports,
213
post_hook_params = PostCommitHookParams(self)
214
for hook in MutableTree.hooks['post_commit']:
215
hook(post_hook_params)
218
def _gather_kinds(self, files, kinds):
219
"""Helper function for add - sets the entries of kinds."""
220
raise NotImplementedError(self._gather_kinds)
223
def has_changes(self, _from_tree=None):
224
"""Quickly check that the tree contains at least one commitable change.
226
:param _from_tree: tree to compare against to find changes (default to
227
the basis tree and is intended to be used by tests).
229
:return: True if a change is found. False otherwise
231
# Check pending merges
232
if len(self.get_parent_ids()) > 1:
234
if _from_tree is None:
235
_from_tree = self.basis_tree()
236
changes = self.iter_changes(_from_tree)
238
change = changes.next()
239
# Exclude root (talk about black magic... --vila 20090629)
240
if change[4] == (None, None):
241
change = changes.next()
243
except StopIteration:
248
def check_changed_or_out_of_date(self, strict, opt_name,
249
more_error, more_warning):
250
"""Check the tree for uncommitted changes and branch synchronization.
252
If strict is None and not set in the config files, a warning is issued.
253
If strict is True, an error is raised.
254
If strict is False, no checks are done and no warning is issued.
256
:param strict: True, False or None, searched in branch config if None.
258
:param opt_name: strict option name to search in config file.
260
:param more_error: Details about how to avoid the check.
262
:param more_warning: Details about what is happening.
265
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
266
if strict is not False:
268
if (self.has_changes()):
269
err_class = errors.UncommittedChanges
270
elif self.last_revision() != self.branch.last_revision():
271
# The tree has lost sync with its branch, there is little
272
# chance that the user is aware of it but he can still force
273
# the action with --no-strict
274
err_class = errors.OutOfDateTree
275
if err_class is not None:
277
err = err_class(self, more=more_warning)
278
# We don't want to interrupt the user if he expressed no
279
# preference about strict.
280
trace.warning('%s', err._format())
282
err = err_class(self, more=more_error)
286
def last_revision(self):
287
"""Return the revision id of the last commit performed in this tree.
289
In early tree formats the result of last_revision is the same as the
290
branch last_revision, but that is no longer the case for modern tree
293
last_revision returns the left most parent id, or None if there are no
296
last_revision was deprecated as of 0.11. Please use get_parent_ids
299
raise NotImplementedError(self.last_revision)
301
def lock_tree_write(self):
302
"""Lock the working tree for write, and the branch for read.
304
This is useful for operations which only need to mutate the working
305
tree. Taking out branch write locks is a relatively expensive process
306
and may fail if the branch is on read only media. So branch write locks
307
should only be taken out when we are modifying branch data - such as in
308
operations like commit, pull, uncommit and update.
310
raise NotImplementedError(self.lock_tree_write)
312
def lock_write(self):
313
"""Lock the tree and its branch. This allows mutating calls to be made.
315
Some mutating methods will take out implicit write locks, but in
316
general you should always obtain a write lock before calling mutating
319
raise NotImplementedError(self.lock_write)
322
def mkdir(self, path, file_id=None):
323
"""Create a directory in the tree. if file_id is None, one is assigned.
325
:param path: A unicode file path.
326
:param file_id: An optional file-id.
327
:return: the file id of the new directory.
329
raise NotImplementedError(self.mkdir)
331
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
332
"""Tell the tree we have observed a paths sha1.
334
The intent of this function is to allow trees that have a hashcache to
335
update the hashcache during commit. If the observed file is too new
336
(based on the stat_value) to be safely hash-cached the tree will ignore
339
The default implementation does nothing.
341
:param file_id: The file id
342
:param path: The file path
343
:param sha1: The sha 1 that was observed.
344
:param stat_value: A stat result for the file the sha1 was read from.
348
def _fix_case_of_inventory_path(self, path):
349
"""If our tree isn't case sensitive, return the canonical path"""
350
if not self.case_sensitive:
351
path = self.get_canonical_inventory_path(path)
355
def put_file_bytes_non_atomic(self, file_id, bytes):
356
"""Update the content of a file in the tree.
358
Note that the file is written in-place rather than being
359
written to a temporary location and renamed. As a consequence,
360
readers can potentially see the file half-written.
362
:param file_id: file-id of the file
363
:param bytes: the new file contents
365
raise NotImplementedError(self.put_file_bytes_non_atomic)
367
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
368
"""Set the parents ids of the working tree.
370
:param revision_ids: A list of revision_ids.
372
raise NotImplementedError(self.set_parent_ids)
374
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
375
"""Set the parents of the working tree.
377
:param parents_list: A list of (revision_id, tree) tuples.
378
If tree is None, then that element is treated as an unreachable
379
parent tree - i.e. a ghost.
381
raise NotImplementedError(self.set_parent_trees)
383
@needs_tree_write_lock
384
def smart_add(self, file_list, recurse=True, action=None, save=True):
385
"""Version file_list, optionally recursing into directories.
387
This is designed more towards DWIM for humans than API clarity.
388
For the specific behaviour see the help for cmd_add().
390
:param file_list: List of zero or more paths. *NB: these are
391
interpreted relative to the process cwd, not relative to the
392
tree.* (Add and most other tree methods use tree-relative
394
:param action: A reporter to be called with the inventory, parent_ie,
395
path and kind of the path being added. It may return a file_id if
396
a specific one should be used.
397
:param save: Save the inventory after completing the adds. If False
398
this provides dry-run functionality by doing the add and not saving
400
:return: A tuple - files_added, ignored_files. files_added is the count
401
of added files, and ignored_files is a dict mapping files that were
402
ignored to the rule that caused them to be ignored.
404
# not in an inner loop; and we want to remove direct use of this,
405
# so here as a reminder for now. RBC 20070703
406
from bzrlib.inventory import InventoryEntry
408
action = add.AddAction()
411
# no paths supplied: add the entire tree.
412
# FIXME: this assumes we are running in a working tree subdir :-/
415
# mutter("smart add of %r")
421
conflicts_related = set()
422
# Not all mutable trees can have conflicts
423
if getattr(self, 'conflicts', None) is not None:
424
# Collect all related files without checking whether they exist or
425
# are versioned. It's cheaper to do that once for all conflicts
426
# than trying to find the relevant conflict for each added file.
427
for c in self.conflicts():
428
conflicts_related.update(c.associated_filenames())
430
# expand any symlinks in the directory part, while leaving the
432
# only expanding if symlinks are supported avoids windows path bugs
433
if osutils.has_symlinks():
434
file_list = map(osutils.normalizepath, file_list)
436
# validate user file paths and convert all paths to tree
437
# relative : it's cheaper to make a tree relative path an abspath
438
# than to convert an abspath to tree relative, and it's cheaper to
439
# perform the canonicalization in bulk.
440
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
441
rf = _FastPath(filepath)
442
# validate user parameters. Our recursive code avoids adding new
443
# files that need such validation
444
if self.is_control_filename(rf.raw_path):
445
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
447
abspath = self.abspath(rf.raw_path)
448
kind = osutils.file_kind(abspath)
449
if kind == 'directory':
450
# schedule the dir for scanning
453
if not InventoryEntry.versionable_kind(kind):
454
raise errors.BadFileKindError(filename=abspath, kind=kind)
455
# ensure the named path is added, so that ignore rules in the later
456
# directory walk dont skip it.
457
# we dont have a parent ie known yet.: use the relatively slower
458
# inventory probing method
459
versioned = inv.has_filename(rf.raw_path)
462
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
465
# no need to walk any directories at all.
466
if len(added) > 0 and save:
467
self._write_inventory(inv)
468
return added, ignored
470
# only walk the minimal parents needed: we have user_dirs to override
474
is_inside = osutils.is_inside_or_parent_of_any
475
for path in sorted(user_dirs):
476
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
477
dirs_to_add.append((path, None))
478
prev_dir = path.raw_path
480
illegalpath_re = re.compile(r'[\r\n]')
481
# dirs_to_add is initialised to a list of directories, but as we scan
482
# directories we append files to it.
483
# XXX: We should determine kind of files when we scan them rather than
484
# adding to this list. RBC 20070703
485
for directory, parent_ie in dirs_to_add:
486
# directory is tree-relative
487
abspath = self.abspath(directory.raw_path)
489
# get the contents of this directory.
491
# find the kind of the path being added.
492
kind = osutils.file_kind(abspath)
494
if not InventoryEntry.versionable_kind(kind):
495
trace.warning("skipping %s (can't add file of kind '%s')",
498
if illegalpath_re.search(directory.raw_path):
499
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
501
if directory.raw_path in conflicts_related:
502
# If the file looks like one generated for a conflict, don't
505
'skipping %s (generated to help resolve conflicts)',
509
if parent_ie is not None:
510
versioned = directory.base_path in parent_ie.children
512
# without the parent ie, use the relatively slower inventory
514
versioned = inv.has_filename(
515
self._fix_case_of_inventory_path(directory.raw_path))
517
if kind == 'directory':
519
sub_branch = bzrdir.BzrDir.open(abspath)
521
except errors.NotBranchError:
523
except errors.UnsupportedFormatError:
528
if directory.raw_path == '':
529
# mutter("tree root doesn't need to be added")
533
# mutter("%r is already versioned", abspath)
535
# XXX: This is wrong; people *might* reasonably be trying to
536
# add subtrees as subtrees. This should probably only be done
537
# in formats which can represent subtrees, and even then
538
# perhaps only when the user asked to add subtrees. At the
539
# moment you can add them specially through 'join --reference',
540
# which is perhaps reasonable: adding a new reference is a
541
# special operation and can have a special behaviour. mbp
543
trace.mutter("%r is a nested bzr tree", abspath)
545
_add_one(self, inv, parent_ie, directory, kind, action)
546
added.append(directory.raw_path)
548
if kind == 'directory' and not sub_tree:
549
if parent_ie is not None:
551
this_ie = parent_ie.children[directory.base_path]
553
# without the parent ie, use the relatively slower inventory
555
this_id = inv.path2id(
556
self._fix_case_of_inventory_path(directory.raw_path))
560
this_ie = inv[this_id]
561
# Same as in _add_one below, if the inventory doesn't
562
# think this is a directory, update the inventory
563
if this_ie.kind != 'directory':
564
this_ie = inventory.make_entry('directory',
565
this_ie.name, this_ie.parent_id, this_id)
569
for subf in sorted(os.listdir(abspath)):
570
# here we could use TreeDirectory rather than
571
# string concatenation.
572
subp = osutils.pathjoin(directory.raw_path, subf)
573
# TODO: is_control_filename is very slow. Make it faster.
574
# TreeDirectory.is_control_filename could also make this
575
# faster - its impossible for a non root dir to have a
577
if self.is_control_filename(subp):
578
trace.mutter("skip control directory %r", subp)
579
elif subf in this_ie.children:
580
# recurse into this already versioned subdir.
581
dirs_to_add.append((_FastPath(subp, subf), this_ie))
583
# user selection overrides ignoes
584
# ignore while selecting files - if we globbed in the
585
# outer loop we would ignore user files.
586
ignore_glob = self.is_ignored(subp)
587
if ignore_glob is not None:
588
# mutter("skip ignored sub-file %r", subp)
589
ignored.setdefault(ignore_glob, []).append(subp)
591
#mutter("queue to add sub-file %r", subp)
592
dirs_to_add.append((_FastPath(subp, subf), this_ie))
596
self._write_inventory(inv)
598
self.read_working_inventory()
599
return added, ignored
601
def update_basis_by_delta(self, new_revid, delta):
602
"""Update the parents of this tree after a commit.
604
This gives the tree one parent, with revision id new_revid. The
605
inventory delta is applied to the current basis tree to generate the
606
inventory for the parent new_revid, and all other parent trees are
609
All the changes in the delta should be changes synchronising the basis
610
tree with some or all of the working tree, with a change to a directory
611
requiring that its contents have been recursively included. That is,
612
this is not a general purpose tree modification routine, but a helper
613
for commit which is not required to handle situations that do not arise
616
See the inventory developers documentation for the theory behind
619
:param new_revid: The new revision id for the trees parent.
620
:param delta: An inventory delta (see apply_inventory_delta) describing
621
the changes from the current left most parent revision to new_revid.
623
# if the tree is updated by a pull to the branch, as happens in
624
# WorkingTree2, when there was no separation between branch and tree,
625
# then just clear merges, efficiency is not a concern for now as this
626
# is legacy environments only, and they are slow regardless.
627
if self.last_revision() == new_revid:
628
self.set_parent_ids([new_revid])
630
# generic implementation based on Inventory manipulation. See
631
# WorkingTree classes for optimised versions for specific format trees.
632
basis = self.basis_tree()
634
# TODO: Consider re-evaluating the need for this with CHKInventory
635
# we don't strictly need to mutate an inventory for this
636
# it only makes sense when apply_delta is cheaper than get_inventory()
637
inventory = basis.inventory._get_mutable_inventory()
639
inventory.apply_delta(delta)
640
rev_tree = revisiontree.RevisionTree(self.branch.repository,
641
inventory, new_revid)
642
self.set_parent_trees([(new_revid, rev_tree)])
645
class MutableTreeHooks(hooks.Hooks):
646
"""A dictionary mapping a hook name to a list of callables for mutabletree
651
"""Create the default hooks.
654
hooks.Hooks.__init__(self, "bzrlib.mutabletree", "MutableTree.hooks")
655
self.add_hook('start_commit',
656
"Called before a commit is performed on a tree. The start commit "
657
"hook is able to change the tree before the commit takes place. "
658
"start_commit is called with the bzrlib.mutabletree.MutableTree "
659
"that the commit is being performed on.", (1, 4))
660
self.add_hook('post_commit',
661
"Called after a commit is performed on a tree. The hook is "
662
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
663
"The mutable tree the commit was performed on is available via "
664
"the mutable_tree attribute of that object.", (2, 0))
667
# install the default hooks into the MutableTree class.
668
MutableTree.hooks = MutableTreeHooks()
671
class PostCommitHookParams(object):
672
"""Parameters for the post_commit hook.
674
To access the parameters, use the following attributes:
676
* mutable_tree - the MutableTree object
679
def __init__(self, mutable_tree):
680
"""Create the parameters for the post_commit hook."""
681
self.mutable_tree = mutable_tree
684
class _FastPath(object):
685
"""A path object with fast accessors for things like basename."""
687
__slots__ = ['raw_path', 'base_path']
689
def __init__(self, path, base_path=None):
690
"""Construct a FastPath from path."""
691
if base_path is None:
692
self.base_path = osutils.basename(path)
694
self.base_path = base_path
697
def __cmp__(self, other):
698
return cmp(self.raw_path, other.raw_path)
701
return hash(self.raw_path)
704
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
705
"""Add a new entry to the inventory and automatically add unversioned parents.
707
:param inv: Inventory which will receive the new entry.
708
:param parent_ie: Parent inventory entry if known, or None. If
709
None, the parent is looked up by name and used if present, otherwise it
710
is recursively added.
711
:param kind: Kind of new entry (file, directory, etc)
712
:param action: callback(inv, parent_ie, path, kind); return ignored.
713
:return: A list of paths which have been added.
715
# Nothing to do if path is already versioned.
716
# This is safe from infinite recursion because the tree root is
718
if parent_ie is not None:
719
# we have a parent ie already
722
# slower but does not need parent_ie
723
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
725
# its really not there : add the parent
726
# note that the dirname use leads to some extra str copying etc but as
727
# there are a limited number of dirs we can be nested under, it should
728
# generally find it very fast and not recurse after that.
729
added = _add_one_and_parent(tree, inv, None,
730
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
731
parent_id = inv.path2id(osutils.dirname(path.raw_path))
732
parent_ie = inv[parent_id]
733
_add_one(tree, inv, parent_ie, path, kind, action)
734
return added + [path.raw_path]
737
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
738
"""Add a new entry to the inventory.
740
:param inv: Inventory which will receive the new entry.
741
:param parent_ie: Parent inventory entry.
742
:param kind: Kind of new entry (file, directory, etc)
743
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
744
file_id or None to generate a new file id
747
# if the parent exists, but isn't a directory, we have to do the
748
# kind change now -- really the inventory shouldn't pretend to know
749
# the kind of wt files, but it does.
750
if parent_ie.kind != 'directory':
751
# nb: this relies on someone else checking that the path we're using
752
# doesn't contain symlinks.
753
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
754
parent_ie.parent_id, parent_ie.file_id)
755
del inv[parent_ie.file_id]
756
inv.add(new_parent_ie)
757
parent_ie = new_parent_ie
758
file_id = file_id_callback(inv, parent_ie, path, kind)
759
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
