1
# Copyright (C) 2006-2010 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
@needs_tree_write_lock
83
def add(self, files, ids=None, kinds=None):
84
"""Add paths to the set of versioned paths.
86
Note that the command line normally calls smart_add instead,
87
which can automatically recurse.
89
This adds the files to the inventory, so that they will be
90
recorded by the next commit.
92
:param files: List of paths to add, relative to the base of the tree.
93
:param ids: If set, use these instead of automatically generated ids.
94
Must be the same length as the list of files, but may
95
contain None for ids that are to be autogenerated.
96
:param kinds: Optional parameter to specify the kinds to be used for
99
TODO: Perhaps callback with the ids and paths as they're added.
101
if isinstance(files, basestring):
102
# XXX: Passing a single string is inconsistent and should be
104
if not (ids is None or isinstance(ids, basestring)):
105
raise AssertionError()
106
if not (kinds is None or isinstance(kinds, basestring)):
107
raise AssertionError()
111
if kinds is not None:
114
files = [path.strip('/') for path in files]
117
ids = [None] * len(files)
119
if not (len(ids) == len(files)):
120
raise AssertionError()
122
kinds = [None] * len(files)
123
elif not len(kinds) == len(files):
124
raise AssertionError()
126
# generic constraint checks:
127
if self.is_control_filename(f):
128
raise errors.ForbiddenControlFileError(filename=f)
129
fp = osutils.splitpath(f)
130
# fill out file kinds for all files [not needed when we stop
131
# caring about the instantaneous file kind within a uncommmitted tree
133
self._gather_kinds(files, kinds)
134
self._add(files, ids, kinds)
136
def add_reference(self, sub_tree):
137
"""Add a TreeReference to the tree, pointing at sub_tree"""
138
raise errors.UnsupportedOperation(self.add_reference, self)
140
def _add_reference(self, sub_tree):
141
"""Standard add_reference implementation, for use by subclasses"""
143
sub_tree_path = self.relpath(sub_tree.basedir)
144
except errors.PathNotChild:
145
raise errors.BadReferenceTarget(self, sub_tree,
146
'Target not inside tree.')
147
sub_tree_id = sub_tree.get_root_id()
148
if sub_tree_id == self.get_root_id():
149
raise errors.BadReferenceTarget(self, sub_tree,
150
'Trees have the same root id.')
151
if sub_tree_id in self.inventory:
152
raise errors.BadReferenceTarget(self, sub_tree,
153
'Root id already present in tree')
154
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
156
def _add(self, files, ids, kinds):
157
"""Helper function for add - updates the inventory.
159
:param files: sequence of pathnames, relative to the tree root
160
:param ids: sequence of suggested ids for the files (may be None)
161
:param kinds: sequence of inventory kinds of the files (i.e. may
162
contain "tree-reference")
164
raise NotImplementedError(self._add)
166
@needs_tree_write_lock
167
def apply_inventory_delta(self, changes):
168
"""Apply changes to the inventory as an atomic operation.
170
:param changes: An inventory delta to apply to the working tree's
173
:seealso Inventory.apply_delta: For details on the changes parameter.
177
inv.apply_delta(changes)
178
self._write_inventory(inv)
181
def commit(self, message=None, revprops=None, *args,
183
# avoid circular imports
184
from bzrlib import commit
185
possible_master_transports=[]
186
revprops = commit.Commit.update_revprops(
189
kwargs.pop('authors', None),
190
kwargs.pop('author', None),
191
kwargs.get('local', False),
192
possible_master_transports)
193
# args for wt.commit start at message from the Commit.commit method,
194
args = (message, ) + args
195
for hook in MutableTree.hooks['start_commit']:
197
committed_id = commit.Commit().commit(working_tree=self,
199
possible_master_transports=possible_master_transports,
201
post_hook_params = PostCommitHookParams(self)
202
for hook in MutableTree.hooks['post_commit']:
203
hook(post_hook_params)
206
def _gather_kinds(self, files, kinds):
207
"""Helper function for add - sets the entries of kinds."""
208
raise NotImplementedError(self._gather_kinds)
211
def has_changes(self, _from_tree=None):
212
"""Quickly check that the tree contains at least one commitable change.
214
:param _from_tree: tree to compare against to find changes (default to
215
the basis tree and is intended to be used by tests).
217
:return: True if a change is found. False otherwise
219
# Check pending merges
220
if len(self.get_parent_ids()) > 1:
222
if _from_tree is None:
223
_from_tree = self.basis_tree()
224
changes = self.iter_changes(_from_tree)
226
change = changes.next()
227
# Exclude root (talk about black magic... --vila 20090629)
228
if change[4] == (None, None):
229
change = changes.next()
231
except StopIteration:
236
def check_changed_or_out_of_date(self, strict, opt_name,
237
more_error, more_warning):
238
"""Check the tree for uncommitted changes and branch synchronization.
240
If strict is None and not set in the config files, a warning is issued.
241
If strict is True, an error is raised.
242
If strict is False, no checks are done and no warning is issued.
244
:param strict: True, False or None, searched in branch config if None.
246
:param opt_name: strict option name to search in config file.
248
:param more_error: Details about how to avoid the check.
250
:param more_warning: Details about what is happening.
253
strict = self.branch.get_config().get_user_option_as_bool(opt_name)
254
if strict is not False:
256
if (self.has_changes()):
257
err_class = errors.UncommittedChanges
258
elif self.last_revision() != self.branch.last_revision():
259
# The tree has lost sync with its branch, there is little
260
# chance that the user is aware of it but he can still force
261
# the action with --no-strict
262
err_class = errors.OutOfDateTree
263
if err_class is not None:
265
err = err_class(self, more=more_warning)
266
# We don't want to interrupt the user if he expressed no
267
# preference about strict.
268
trace.warning('%s', err._format())
270
err = err_class(self, more=more_error)
274
def last_revision(self):
275
"""Return the revision id of the last commit performed in this tree.
277
In early tree formats the result of last_revision is the same as the
278
branch last_revision, but that is no longer the case for modern tree
281
last_revision returns the left most parent id, or None if there are no
284
last_revision was deprecated as of 0.11. Please use get_parent_ids
287
raise NotImplementedError(self.last_revision)
289
def lock_tree_write(self):
290
"""Lock the working tree for write, and the branch for read.
292
This is useful for operations which only need to mutate the working
293
tree. Taking out branch write locks is a relatively expensive process
294
and may fail if the branch is on read only media. So branch write locks
295
should only be taken out when we are modifying branch data - such as in
296
operations like commit, pull, uncommit and update.
298
raise NotImplementedError(self.lock_tree_write)
300
def lock_write(self):
301
"""Lock the tree and its branch. This allows mutating calls to be made.
303
Some mutating methods will take out implicit write locks, but in
304
general you should always obtain a write lock before calling mutating
307
raise NotImplementedError(self.lock_write)
310
def mkdir(self, path, file_id=None):
311
"""Create a directory in the tree. if file_id is None, one is assigned.
313
:param path: A unicode file path.
314
:param file_id: An optional file-id.
315
:return: the file id of the new directory.
317
raise NotImplementedError(self.mkdir)
319
def _observed_sha1(self, file_id, path, (sha1, stat_value)):
320
"""Tell the tree we have observed a paths sha1.
322
The intent of this function is to allow trees that have a hashcache to
323
update the hashcache during commit. If the observed file is too new
324
(based on the stat_value) to be safely hash-cached the tree will ignore
327
The default implementation does nothing.
329
:param file_id: The file id
330
:param path: The file path
331
:param sha1: The sha 1 that was observed.
332
:param stat_value: A stat result for the file the sha1 was read from.
336
def _fix_case_of_inventory_path(self, path):
337
"""If our tree isn't case sensitive, return the canonical path"""
338
if not self.case_sensitive:
339
path = self.get_canonical_inventory_path(path)
343
def put_file_bytes_non_atomic(self, file_id, bytes):
344
"""Update the content of a file in the tree.
346
Note that the file is written in-place rather than being
347
written to a temporary location and renamed. As a consequence,
348
readers can potentially see the file half-written.
350
:param file_id: file-id of the file
351
:param bytes: the new file contents
353
raise NotImplementedError(self.put_file_bytes_non_atomic)
355
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
356
"""Set the parents ids of the working tree.
358
:param revision_ids: A list of revision_ids.
360
raise NotImplementedError(self.set_parent_ids)
362
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
363
"""Set the parents of the working tree.
365
:param parents_list: A list of (revision_id, tree) tuples.
366
If tree is None, then that element is treated as an unreachable
367
parent tree - i.e. a ghost.
369
raise NotImplementedError(self.set_parent_trees)
371
@needs_tree_write_lock
372
def smart_add(self, file_list, recurse=True, action=None, save=True):
373
"""Version file_list, optionally recursing into directories.
375
This is designed more towards DWIM for humans than API clarity.
376
For the specific behaviour see the help for cmd_add().
378
:param file_list: List of zero or more paths. *NB: these are
379
interpreted relative to the process cwd, not relative to the
380
tree.* (Add and most other tree methods use tree-relative
382
:param action: A reporter to be called with the inventory, parent_ie,
383
path and kind of the path being added. It may return a file_id if
384
a specific one should be used.
385
:param save: Save the inventory after completing the adds. If False
386
this provides dry-run functionality by doing the add and not saving
388
:return: A tuple - files_added, ignored_files. files_added is the count
389
of added files, and ignored_files is a dict mapping files that were
390
ignored to the rule that caused them to be ignored.
392
# not in an inner loop; and we want to remove direct use of this,
393
# so here as a reminder for now. RBC 20070703
394
from bzrlib.inventory import InventoryEntry
396
action = add.AddAction()
399
# no paths supplied: add the entire tree.
400
# FIXME: this assumes we are running in a working tree subdir :-/
403
# mutter("smart add of %r")
409
conflicts_related = set()
410
# Not all mutable trees can have conflicts
411
if getattr(self, 'conflicts', None) is not None:
412
# Collect all related files without checking whether they exist or
413
# are versioned. It's cheaper to do that once for all conflicts
414
# than trying to find the relevant conflict for each added file.
415
for c in self.conflicts():
416
conflicts_related.update(c.associated_filenames())
418
# validate user file paths and convert all paths to tree
419
# relative : it's cheaper to make a tree relative path an abspath
420
# than to convert an abspath to tree relative, and it's cheaper to
421
# perform the canonicalization in bulk.
422
for filepath in osutils.canonical_relpaths(self.basedir, file_list):
423
rf = _FastPath(filepath)
424
# validate user parameters. Our recursive code avoids adding new
425
# files that need such validation
426
if self.is_control_filename(rf.raw_path):
427
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
429
abspath = self.abspath(rf.raw_path)
430
kind = osutils.file_kind(abspath)
431
if kind == 'directory':
432
# schedule the dir for scanning
435
if not InventoryEntry.versionable_kind(kind):
436
raise errors.BadFileKindError(filename=abspath, kind=kind)
437
# ensure the named path is added, so that ignore rules in the later
438
# directory walk dont skip it.
439
# we dont have a parent ie known yet.: use the relatively slower
440
# inventory probing method
441
versioned = inv.has_filename(rf.raw_path)
444
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
447
# no need to walk any directories at all.
448
if len(added) > 0 and save:
449
self._write_inventory(inv)
450
return added, ignored
452
# only walk the minimal parents needed: we have user_dirs to override
456
is_inside = osutils.is_inside_or_parent_of_any
457
for path in sorted(user_dirs):
458
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
459
dirs_to_add.append((path, None))
460
prev_dir = path.raw_path
462
illegalpath_re = re.compile(r'[\r\n]')
463
# dirs_to_add is initialised to a list of directories, but as we scan
464
# directories we append files to it.
465
# XXX: We should determine kind of files when we scan them rather than
466
# adding to this list. RBC 20070703
467
for directory, parent_ie in dirs_to_add:
468
# directory is tree-relative
469
abspath = self.abspath(directory.raw_path)
471
# get the contents of this directory.
473
# find the kind of the path being added.
474
kind = osutils.file_kind(abspath)
476
if not InventoryEntry.versionable_kind(kind):
477
trace.warning("skipping %s (can't add file of kind '%s')",
480
if illegalpath_re.search(directory.raw_path):
481
trace.warning("skipping %r (contains \\n or \\r)" % abspath)
483
if directory.raw_path in conflicts_related:
484
# If the file looks like one generated for a conflict, don't
487
'skipping %s (generated to help resolve conflicts)',
491
if parent_ie is not None:
492
versioned = directory.base_path in parent_ie.children
494
# without the parent ie, use the relatively slower inventory
496
versioned = inv.has_filename(
497
self._fix_case_of_inventory_path(directory.raw_path))
499
if kind == 'directory':
501
sub_branch = bzrdir.BzrDir.open(abspath)
503
except errors.NotBranchError:
505
except errors.UnsupportedFormatError:
510
if directory.raw_path == '':
511
# mutter("tree root doesn't need to be added")
515
# mutter("%r is already versioned", abspath)
517
# XXX: This is wrong; people *might* reasonably be trying to
518
# add subtrees as subtrees. This should probably only be done
519
# in formats which can represent subtrees, and even then
520
# perhaps only when the user asked to add subtrees. At the
521
# moment you can add them specially through 'join --reference',
522
# which is perhaps reasonable: adding a new reference is a
523
# special operation and can have a special behaviour. mbp
525
trace.mutter("%r is a nested bzr tree", abspath)
527
_add_one(self, inv, parent_ie, directory, kind, action)
528
added.append(directory.raw_path)
530
if kind == 'directory' and not sub_tree:
531
if parent_ie is not None:
533
this_ie = parent_ie.children[directory.base_path]
535
# without the parent ie, use the relatively slower inventory
537
this_id = inv.path2id(
538
self._fix_case_of_inventory_path(directory.raw_path))
542
this_ie = inv[this_id]
544
for subf in sorted(os.listdir(abspath)):
545
# here we could use TreeDirectory rather than
546
# string concatenation.
547
subp = osutils.pathjoin(directory.raw_path, subf)
548
# TODO: is_control_filename is very slow. Make it faster.
549
# TreeDirectory.is_control_filename could also make this
550
# faster - its impossible for a non root dir to have a
552
if self.is_control_filename(subp):
553
trace.mutter("skip control directory %r", subp)
554
elif subf in this_ie.children:
555
# recurse into this already versioned subdir.
556
dirs_to_add.append((_FastPath(subp, subf), this_ie))
558
# user selection overrides ignoes
559
# ignore while selecting files - if we globbed in the
560
# outer loop we would ignore user files.
561
ignore_glob = self.is_ignored(subp)
562
if ignore_glob is not None:
563
# mutter("skip ignored sub-file %r", subp)
564
ignored.setdefault(ignore_glob, []).append(subp)
566
#mutter("queue to add sub-file %r", subp)
567
dirs_to_add.append((_FastPath(subp, subf), this_ie))
571
self._write_inventory(inv)
573
self.read_working_inventory()
574
return added, ignored
576
def update_basis_by_delta(self, new_revid, delta):
577
"""Update the parents of this tree after a commit.
579
This gives the tree one parent, with revision id new_revid. The
580
inventory delta is applied to the current basis tree to generate the
581
inventory for the parent new_revid, and all other parent trees are
584
All the changes in the delta should be changes synchronising the basis
585
tree with some or all of the working tree, with a change to a directory
586
requiring that its contents have been recursively included. That is,
587
this is not a general purpose tree modification routine, but a helper
588
for commit which is not required to handle situations that do not arise
591
See the inventory developers documentation for the theory behind
594
:param new_revid: The new revision id for the trees parent.
595
:param delta: An inventory delta (see apply_inventory_delta) describing
596
the changes from the current left most parent revision to new_revid.
598
# if the tree is updated by a pull to the branch, as happens in
599
# WorkingTree2, when there was no separation between branch and tree,
600
# then just clear merges, efficiency is not a concern for now as this
601
# is legacy environments only, and they are slow regardless.
602
if self.last_revision() == new_revid:
603
self.set_parent_ids([new_revid])
605
# generic implementation based on Inventory manipulation. See
606
# WorkingTree classes for optimised versions for specific format trees.
607
basis = self.basis_tree()
609
# TODO: Consider re-evaluating the need for this with CHKInventory
610
# we don't strictly need to mutate an inventory for this
611
# it only makes sense when apply_delta is cheaper than get_inventory()
612
inventory = basis.inventory._get_mutable_inventory()
614
inventory.apply_delta(delta)
615
rev_tree = revisiontree.RevisionTree(self.branch.repository,
616
inventory, new_revid)
617
self.set_parent_trees([(new_revid, rev_tree)])
620
class MutableTreeHooks(hooks.Hooks):
621
"""A dictionary mapping a hook name to a list of callables for mutabletree
626
"""Create the default hooks.
629
hooks.Hooks.__init__(self)
630
self.create_hook(hooks.HookPoint('start_commit',
631
"Called before a commit is performed on a tree. The start commit "
632
"hook is able to change the tree before the commit takes place. "
633
"start_commit is called with the bzrlib.mutabletree.MutableTree "
634
"that the commit is being performed on.", (1, 4), None))
635
self.create_hook(hooks.HookPoint('post_commit',
636
"Called after a commit is performed on a tree. The hook is "
637
"called with a bzrlib.mutabletree.PostCommitHookParams object. "
638
"The mutable tree the commit was performed on is available via "
639
"the mutable_tree attribute of that object.", (2, 0), None))
642
# install the default hooks into the MutableTree class.
643
MutableTree.hooks = MutableTreeHooks()
646
class PostCommitHookParams(object):
647
"""Parameters for the post_commit hook.
649
To access the parameters, use the following attributes:
651
* mutable_tree - the MutableTree object
654
def __init__(self, mutable_tree):
655
"""Create the parameters for the post_commit hook."""
656
self.mutable_tree = mutable_tree
659
class _FastPath(object):
660
"""A path object with fast accessors for things like basename."""
662
__slots__ = ['raw_path', 'base_path']
664
def __init__(self, path, base_path=None):
665
"""Construct a FastPath from path."""
666
if base_path is None:
667
self.base_path = osutils.basename(path)
669
self.base_path = base_path
672
def __cmp__(self, other):
673
return cmp(self.raw_path, other.raw_path)
676
return hash(self.raw_path)
679
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
680
"""Add a new entry to the inventory and automatically add unversioned parents.
682
:param inv: Inventory which will receive the new entry.
683
:param parent_ie: Parent inventory entry if known, or None. If
684
None, the parent is looked up by name and used if present, otherwise it
685
is recursively added.
686
:param kind: Kind of new entry (file, directory, etc)
687
:param action: callback(inv, parent_ie, path, kind); return ignored.
688
:return: A list of paths which have been added.
690
# Nothing to do if path is already versioned.
691
# This is safe from infinite recursion because the tree root is
693
if parent_ie is not None:
694
# we have a parent ie already
697
# slower but does not need parent_ie
698
if inv.has_filename(tree._fix_case_of_inventory_path(path.raw_path)):
700
# its really not there : add the parent
701
# note that the dirname use leads to some extra str copying etc but as
702
# there are a limited number of dirs we can be nested under, it should
703
# generally find it very fast and not recurse after that.
704
added = _add_one_and_parent(tree, inv, None,
705
_FastPath(osutils.dirname(path.raw_path)), 'directory', action)
706
parent_id = inv.path2id(osutils.dirname(path.raw_path))
707
parent_ie = inv[parent_id]
708
_add_one(tree, inv, parent_ie, path, kind, action)
709
return added + [path.raw_path]
712
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
713
"""Add a new entry to the inventory.
715
:param inv: Inventory which will receive the new entry.
716
:param parent_ie: Parent inventory entry.
717
:param kind: Kind of new entry (file, directory, etc)
718
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
719
file_id or None to generate a new file id
722
file_id = file_id_callback(inv, parent_ie, path, kind)
723
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
