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
@needs_tree_write_lock
84
def add(self, files, ids=None, kinds=None):
85
"""Add paths to the set of versioned paths.
87
Note that the command line normally calls smart_add instead,
88
which can automatically recurse.
90
This adds the files to the inventory, so that they will be
91
recorded by the next commit.
93
:param files: List of paths to add, relative to the base of the tree.
94
:param ids: If set, use these instead of automatically generated ids.
95
Must be the same length as the list of files, but may
96
contain None for ids that are to be autogenerated.
97
:param kinds: Optional parameter to specify the kinds to be used for
100
TODO: Perhaps callback with the ids and paths as they're added.
102
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()
112
if kinds is not None:
115
files = [path.strip('/') for path in files]
118
ids = [None] * len(files)
120
if not (len(ids) == len(files)):
121
raise AssertionError()
123
kinds = [None] * len(files)
124
elif not len(kinds) == len(files):
125
raise AssertionError()
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"""
139
raise errors.UnsupportedOperation(self.add_reference, self)
141
def _add_reference(self, sub_tree):
142
"""Standard add_reference implementation, for use by subclasses"""
144
sub_tree_path = self.relpath(sub_tree.basedir)
145
except errors.PathNotChild:
146
raise errors.BadReferenceTarget(self, sub_tree,
147
'Target not inside tree.')
148
sub_tree_id = sub_tree.get_root_id()
149
if sub_tree_id == self.get_root_id():
150
raise errors.BadReferenceTarget(self, sub_tree,
151
'Trees have the same root id.')
152
if sub_tree_id in self.inventory:
153
raise errors.BadReferenceTarget(self, sub_tree,
154
'Root id already present in tree')
155
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
157
def _add(self, files, ids, kinds):
158
"""Helper function for add - updates the inventory.
160
:param files: sequence of pathnames, relative to the tree root
161
:param ids: sequence of suggested ids for the files (may be None)
162
:param kinds: sequence of inventory kinds of the files (i.e. may
163
contain "tree-reference")
165
raise NotImplementedError(self._add)
167
@needs_tree_write_lock
168
def apply_inventory_delta(self, changes):
169
"""Apply changes to the inventory as an atomic operation.
171
:param changes: An inventory delta to apply to the working tree's
174
:seealso Inventory.apply_delta: For details on the changes parameter.
178
inv.apply_delta(changes)
179
self._write_inventory(inv)
182
def commit(self, message=None, revprops=None, *args,
184
# avoid circular imports
185
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)
194
# args for wt.commit start at message from the Commit.commit method,
195
args = (message, ) + args
196
for hook in MutableTree.hooks['start_commit']:
198
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)
207
def _gather_kinds(self, files, kinds):
208
"""Helper function for add - sets the entries of kinds."""
209
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
def last_revision(self):
276
"""Return the revision id of the last commit performed in this tree.
278
In early tree formats the result of last_revision is the same as the
279
branch last_revision, but that is no longer the case for modern tree
282
last_revision returns the left most parent id, or None if there are no
285
last_revision was deprecated as of 0.11. Please use get_parent_ids
288
raise NotImplementedError(self.last_revision)
290
def lock_tree_write(self):
291
"""Lock the working tree for write, and the branch for read.
293
This is useful for operations which only need to mutate the working
294
tree. Taking out branch write locks is a relatively expensive process
295
and may fail if the branch is on read only media. So branch write locks
296
should only be taken out when we are modifying branch data - such as in
297
operations like commit, pull, uncommit and update.
299
raise NotImplementedError(self.lock_tree_write)
301
def lock_write(self):
302
"""Lock the tree and its branch. This allows mutating calls to be made.
304
Some mutating methods will take out implicit write locks, but in
305
general you should always obtain a write lock before calling mutating
308
raise NotImplementedError(self.lock_write)
311
def mkdir(self, path, file_id=None):
312
"""Create a directory in the tree. if file_id is None, one is assigned.
314
:param path: A unicode file path.
315
:param file_id: An optional file-id.
316
:return: the file id of the new directory.
318
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
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
357
"""Set the parents ids of the working tree.
359
:param revision_ids: A list of revision_ids.
361
raise NotImplementedError(self.set_parent_ids)
363
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
364
"""Set the parents of the working tree.
366
:param parents_list: A list of (revision_id, tree) tuples.
367
If tree is None, then that element is treated as an unreachable
368
parent tree - i.e. a ghost.
370
raise NotImplementedError(self.set_parent_trees)
372
@needs_tree_write_lock
373
def smart_add(self, file_list, recurse=True, action=None, save=True):
374
"""Version file_list, optionally recursing into directories.
376
This is designed more towards DWIM for humans than API clarity.
377
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
: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
385
a specific one should be used.
386
:param save: Save the inventory after completing the adds. If False
387
this provides dry-run functionality by doing the add and not saving
389
:return: A tuple - files_added, ignored_files. files_added is the count
390
of added files, and ignored_files is a dict mapping files that were
391
ignored to the rule that caused them to be ignored.
393
# not in an inner loop; and we want to remove direct use of this,
394
# so here as a reminder for now. RBC 20070703
395
from bzrlib.inventory import InventoryEntry
397
action = add.AddAction()
400
# no paths supplied: add the entire tree.
401
# FIXME: this assumes we are running in a working tree subdir :-/
404
# mutter("smart add of %r")
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
# only expanding if symlinks are supported avoids windows path bugs
422
if osutils.has_symlinks():
423
file_list = map(osutils.normalizepath, file_list)
425
# validate user file paths and convert all paths to tree
426
# relative : it's cheaper to make a tree relative path an abspath
427
# than to convert an abspath to tree relative, and it's cheaper to
428
# perform the canonicalization in bulk.
429
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
430
rf = _FastPath(filepath)
431
# validate user parameters. Our recursive code avoids adding new
432
# files that need such validation
433
if self.is_control_filename(rf.raw_path):
434
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
436
abspath = self.abspath(rf.raw_path)
437
kind = osutils.file_kind(abspath)
438
if kind == 'directory':
439
# schedule the dir for scanning
442
if not InventoryEntry.versionable_kind(kind):
443
raise errors.BadFileKindError(filename=abspath, kind=kind)
444
# ensure the named path is added, so that ignore rules in the later
445
# directory walk dont skip it.
446
# we dont have a parent ie known yet.: use the relatively slower
447
# inventory probing method
448
versioned = inv.has_filename(rf.raw_path)
451
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
454
# no need to walk any directories at all.
455
if len(added) > 0 and save:
456
self._write_inventory(inv)
457
return added, ignored
459
# only walk the minimal parents needed: we have user_dirs to override
463
is_inside = osutils.is_inside_or_parent_of_any
464
for path in sorted(user_dirs):
465
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
466
dirs_to_add.append((path, None))
467
prev_dir = path.raw_path
469
illegalpath_re = re.compile(r'[\r\n]')
470
# dirs_to_add is initialised to a list of directories, but as we scan
471
# directories we append files to it.
472
# XXX: We should determine kind of files when we scan them rather than
473
# adding to this list. RBC 20070703
474
for directory, parent_ie in dirs_to_add:
475
# directory is tree-relative
476
abspath = self.abspath(directory.raw_path)
478
# get the contents of this directory.
480
# find the kind of the path being added.
481
kind = osutils.file_kind(abspath)
483
if not InventoryEntry.versionable_kind(kind):
484
trace.warning("skipping %s (can't add file of kind '%s')",
487
if illegalpath_re.search(directory.raw_path):
488
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
490
if directory.raw_path in conflicts_related:
491
# If the file looks like one generated for a conflict, don't
494
'skipping %s (generated to help resolve conflicts)',
498
if parent_ie is not None:
499
versioned = directory.base_path in parent_ie.children
501
# without the parent ie, use the relatively slower inventory
503
versioned = inv.has_filename(
504
self._fix_case_of_inventory_path(directory.raw_path))
506
if kind == 'directory':
508
sub_branch = bzrdir.BzrDir.open(abspath)
510
except errors.NotBranchError:
512
except errors.UnsupportedFormatError:
517
if directory.raw_path == '':
518
# mutter("tree root doesn't need to be added")
522
# mutter("%r is already versioned", abspath)
524
# XXX: This is wrong; people *might* reasonably be trying to
525
# add subtrees as subtrees. This should probably only be done
526
# in formats which can represent subtrees, and even then
527
# perhaps only when the user asked to add subtrees. At the
528
# moment you can add them specially through 'join --reference',
529
# which is perhaps reasonable: adding a new reference is a
530
# special operation and can have a special behaviour. mbp
532
trace.mutter("%r is a nested bzr tree", abspath)
534
_add_one(self, inv, parent_ie, directory, kind, action)
535
added.append(directory.raw_path)
537
if kind == 'directory' and not sub_tree:
538
if parent_ie is not None:
540
this_ie = parent_ie.children[directory.base_path]
542
# without the parent ie, use the relatively slower inventory
544
this_id = inv.path2id(
545
self._fix_case_of_inventory_path(directory.raw_path))
549
this_ie = inv[this_id]
550
# Same as in _add_one below, if the inventory doesn't
551
# think this is a directory, update the inventory
552
if this_ie.kind != 'directory':
553
this_ie = inventory.make_entry('directory',
554
this_ie.name, this_ie.parent_id, this_id)
558
for subf in sorted(os.listdir(abspath)):
559
# here we could use TreeDirectory rather than
560
# string concatenation.
561
subp = osutils.pathjoin(directory.raw_path, subf)
562
# TODO: is_control_filename is very slow. Make it faster.
563
# TreeDirectory.is_control_filename could also make this
564
# faster - its impossible for a non root dir to have a
566
if self.is_control_filename(subp):
567
trace.mutter("skip control directory %r", subp)
568
elif subf in this_ie.children:
569
# recurse into this already versioned subdir.
570
dirs_to_add.append((_FastPath(subp, subf), this_ie))
572
# user selection overrides ignoes
573
# ignore while selecting files - if we globbed in the
574
# outer loop we would ignore user files.
575
ignore_glob = self.is_ignored(subp)
576
if ignore_glob is not None:
577
# mutter("skip ignored sub-file %r", subp)
578
ignored.setdefault(ignore_glob, []).append(subp)
580
#mutter("queue to add sub-file %r", subp)
581
dirs_to_add.append((_FastPath(subp, subf), this_ie))
585
self._write_inventory(inv)
587
self.read_working_inventory()
588
return added, ignored
590
def update_basis_by_delta(self, new_revid, delta):
591
"""Update the parents of this tree after a commit.
593
This gives the tree one parent, with revision id new_revid. The
594
inventory delta is applied to the current basis tree to generate the
595
inventory for the parent new_revid, and all other parent trees are
598
All the changes in the delta should be changes synchronising the basis
599
tree with some or all of the working tree, with a change to a directory
600
requiring that its contents have been recursively included. That is,
601
this is not a general purpose tree modification routine, but a helper
602
for commit which is not required to handle situations that do not arise
605
See the inventory developers documentation for the theory behind
608
:param new_revid: The new revision id for the trees parent.
609
:param delta: An inventory delta (see apply_inventory_delta) describing
610
the changes from the current left most parent revision to new_revid.
612
# if the tree is updated by a pull to the branch, as happens in
613
# WorkingTree2, when there was no separation between branch and tree,
614
# then just clear merges, efficiency is not a concern for now as this
615
# is legacy environments only, and they are slow regardless.
616
if self.last_revision() == new_revid:
617
self.set_parent_ids([new_revid])
619
# generic implementation based on Inventory manipulation. See
620
# WorkingTree classes for optimised versions for specific format trees.
621
basis = self.basis_tree()
623
# TODO: Consider re-evaluating the need for this with CHKInventory
624
# we don't strictly need to mutate an inventory for this
625
# it only makes sense when apply_delta is cheaper than get_inventory()
626
inventory = basis.inventory._get_mutable_inventory()
628
inventory.apply_delta(delta)
629
rev_tree = revisiontree.RevisionTree(self.branch.repository,
630
inventory, new_revid)
631
self.set_parent_trees([(new_revid, rev_tree)])
634
class MutableTreeHooks(hooks.Hooks):
635
"""A dictionary mapping a hook name to a list of callables for mutabletree
640
"""Create the default hooks.
643
hooks.Hooks.__init__(self)
644
self.create_hook(hooks.HookPoint('start_commit',
645
"Called before a commit is performed on a tree. The start commit "
646
"hook is able to change the tree before the commit takes place. "
647
"start_commit is called with the bzrlib.mutabletree.MutableTree "
648
"that the commit is being performed on.", (1, 4), None))
649
self.create_hook(hooks.HookPoint('post_commit',
650
"Called after a commit is performed on a tree. The hook is "
651
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
652
"The mutable tree the commit was performed on is available via "
653
"the mutable_tree attribute of that object.", (2, 0), None))
656
# install the default hooks into the MutableTree class.
657
MutableTree.hooks = MutableTreeHooks()
660
class PostCommitHookParams(object):
661
"""Parameters for the post_commit hook.
663
To access the parameters, use the following attributes:
665
* mutable_tree - the MutableTree object
668
def __init__(self, mutable_tree):
669
"""Create the parameters for the post_commit hook."""
670
self.mutable_tree = mutable_tree
673
class _FastPath(object):
674
"""A path object with fast accessors for things like basename."""
676
__slots__ = ['raw_path', 'base_path']
678
def __init__(self, path, base_path=None):
679
"""Construct a FastPath from path."""
680
if base_path is None:
681
self.base_path = osutils.basename(path)
683
self.base_path = base_path
686
def __cmp__(self, other):
687
return cmp(self.raw_path, other.raw_path)
690
return hash(self.raw_path)
693
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
694
"""Add a new entry to the inventory and automatically add unversioned parents.
696
:param inv: Inventory which will receive the new entry.
697
:param parent_ie: Parent inventory entry if known, or None. If
698
None, the parent is looked up by name and used if present, otherwise it
699
is recursively added.
700
:param kind: Kind of new entry (file, directory, etc)
701
:param action: callback(inv, parent_ie, path, kind); return ignored.
702
:return: A list of paths which have been added.
704
# Nothing to do if path is already versioned.
705
# This is safe from infinite recursion because the tree root is
707
if parent_ie is not None:
708
# we have a parent ie already
711
# slower but does not need parent_ie
712
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
714
# its really not there : add the parent
715
# note that the dirname use leads to some extra str copying etc but as
716
# there are a limited number of dirs we can be nested under, it should
717
# generally find it very fast and not recurse after that.
718
added = _add_one_and_parent(tree, inv, None,
719
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
720
parent_id = inv.path2id(osutils.dirname(path.raw_path))
721
parent_ie = inv[parent_id]
722
_add_one(tree, inv, parent_ie, path, kind, action)
723
return added + [path.raw_path]
726
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
727
"""Add a new entry to the inventory.
729
:param inv: Inventory which will receive the new entry.
730
:param parent_ie: Parent inventory entry.
731
:param kind: Kind of new entry (file, directory, etc)
732
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
733
file_id or None to generate a new file id
736
# if the parent exists, but isn't a directory, we have to do the
737
# kind change now -- really the inventory shouldn't pretend to know
738
# the kind of wt files, but it does.
739
if parent_ie.kind != 'directory':
740
# nb: this relies on someone else checking that the path we're using
741
# doesn't contain symlinks.
742
new_parent_ie = inventory.make_entry('directory', parent_ie.name,
743
parent_ie.parent_id, parent_ie.file_id)
744
del inv[parent_ie.file_id]
745
inv.add(new_parent_ie)
746
parent_ie = new_parent_ie
747
file_id = file_id_callback(inv, parent_ie, path, kind)
748
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
