1
# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""MutableTree object.
19
See MutableTree for more details.
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
32
from bzrlib.osutils import dirname
33
from bzrlib.revisiontree import RevisionTree
34
from bzrlib.trace import mutter, warning
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.osutils import splitpath
44
from bzrlib.symbol_versioning import DEPRECATED_PARAMETER
47
def needs_tree_write_lock(unbound):
48
"""Decorate unbound to take out and release a tree_write lock."""
49
def tree_write_locked(self, *args, **kwargs):
50
self.lock_tree_write()
52
return unbound(self, *args, **kwargs)
55
tree_write_locked.__doc__ = unbound.__doc__
56
tree_write_locked.__name__ = unbound.__name__
57
return tree_write_locked
60
class MutableTree(tree.Tree):
61
"""A MutableTree is a specialisation of Tree which is able to be mutated.
63
Generally speaking these mutations are only possible within a lock_write
64
context, and will revert if the lock is broken abnormally - but this cannot
65
be guaranteed - depending on the exact implementation of the mutable state.
67
The most common form of Mutable Tree is WorkingTree, see bzrlib.workingtree.
68
For tests we also have MemoryTree which is a MutableTree whose contents are
71
For now, we are not treating MutableTree as an interface to provide
72
conformance tests for - rather we are testing MemoryTree specifically, and
73
interface testing implementations of WorkingTree.
75
A mutable tree always has an associated Branch and BzrDir object - the
76
branch and bzrdir attributes.
79
@needs_tree_write_lock
80
def add(self, files, ids=None, kinds=None):
81
"""Add paths to the set of versioned paths.
83
Note that the command line normally calls smart_add instead,
84
which can automatically recurse.
86
This adds the files to the inventory, so that they will be
87
recorded by the next commit.
89
:param files: List of paths to add, relative to the base of the tree.
90
:param ids: If set, use these instead of automatically generated ids.
91
Must be the same length as the list of files, but may
92
contain None for ids that are to be autogenerated.
93
:param kinds: Optional parameter to specify the kinds to be used for
96
TODO: Perhaps callback with the ids and paths as they're added.
98
if isinstance(files, basestring):
99
# XXX: Passing a single string is inconsistent and should be
101
if not (ids is None or isinstance(ids, basestring)):
102
raise AssertionError()
103
if not (kinds is None or isinstance(kinds, basestring)):
104
raise AssertionError()
108
if kinds is not None:
111
files = [path.strip('/') for path in files]
114
ids = [None] * len(files)
116
if not (len(ids) == len(files)):
117
raise AssertionError()
119
kinds = [None] * len(files)
120
elif not len(kinds) == len(files):
121
raise AssertionError()
123
# generic constraint checks:
124
if self.is_control_filename(f):
125
raise errors.ForbiddenControlFileError(filename=f)
127
# fill out file kinds for all files [not needed when we stop
128
# caring about the instantaneous file kind within a uncommmitted tree
130
self._gather_kinds(files, kinds)
131
self._add(files, ids, kinds)
133
def add_reference(self, sub_tree):
134
"""Add a TreeReference to the tree, pointing at sub_tree"""
135
raise errors.UnsupportedOperation(self.add_reference, self)
137
def _add_reference(self, sub_tree):
138
"""Standard add_reference implementation, for use by subclasses"""
140
sub_tree_path = self.relpath(sub_tree.basedir)
141
except errors.PathNotChild:
142
raise errors.BadReferenceTarget(self, sub_tree,
143
'Target not inside tree.')
144
sub_tree_id = sub_tree.get_root_id()
145
if sub_tree_id == self.get_root_id():
146
raise errors.BadReferenceTarget(self, sub_tree,
147
'Trees have the same root id.')
148
if sub_tree_id in self.inventory:
149
raise errors.BadReferenceTarget(self, sub_tree,
150
'Root id already present in tree')
151
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
153
def _add(self, files, ids, kinds):
154
"""Helper function for add - updates the inventory.
156
:param files: sequence of pathnames, relative to the tree root
157
:param ids: sequence of suggested ids for the files (may be None)
158
:param kinds: sequence of inventory kinds of the files (i.e. may
159
contain "tree-reference")
161
raise NotImplementedError(self._add)
163
@needs_tree_write_lock
164
def apply_inventory_delta(self, changes):
165
"""Apply changes to the inventory as an atomic operation.
167
:param changes: An inventory delta to apply to the working tree's
170
:seealso Inventory.apply_delta: For details on the changes parameter.
174
inv.apply_delta(changes)
175
self._write_inventory(inv)
178
def commit(self, message=None, revprops=None, *args,
180
# avoid circular imports
181
from bzrlib import commit
184
if not 'branch-nick' in revprops:
185
revprops['branch-nick'] = self.branch.nick
186
author = kwargs.pop('author', None)
187
if author is not None:
188
if 'author' in revprops:
189
# XXX: maybe we should just accept one of them?
190
raise AssertionError('author property given twice')
191
revprops['author'] = author
192
# args for wt.commit start at message from the Commit.commit method,
193
args = (message, ) + args
194
for hook in MutableTree.hooks['start_commit']:
196
committed_id = commit.Commit().commit(working_tree=self,
197
revprops=revprops, *args, **kwargs)
200
def _gather_kinds(self, files, kinds):
201
"""Helper function for add - sets the entries of kinds."""
202
raise NotImplementedError(self._gather_kinds)
205
def last_revision(self):
206
"""Return the revision id of the last commit performed in this tree.
208
In early tree formats the result of last_revision is the same as the
209
branch last_revision, but that is no longer the case for modern tree
212
last_revision returns the left most parent id, or None if there are no
215
last_revision was deprecated as of 0.11. Please use get_parent_ids
218
raise NotImplementedError(self.last_revision)
220
def lock_tree_write(self):
221
"""Lock the working tree for write, and the branch for read.
223
This is useful for operations which only need to mutate the working
224
tree. Taking out branch write locks is a relatively expensive process
225
and may fail if the branch is on read only media. So branch write locks
226
should only be taken out when we are modifying branch data - such as in
227
operations like commit, pull, uncommit and update.
229
raise NotImplementedError(self.lock_tree_write)
231
def lock_write(self):
232
"""Lock the tree and its branch. This allows mutating calls to be made.
234
Some mutating methods will take out implicit write locks, but in
235
general you should always obtain a write lock before calling mutating
238
raise NotImplementedError(self.lock_write)
241
def mkdir(self, path, file_id=None):
242
"""Create a directory in the tree. if file_id is None, one is assigned.
244
:param path: A unicode file path.
245
:param file_id: An optional file-id.
246
:return: the file id of the new directory.
248
raise NotImplementedError(self.mkdir)
250
def _observed_sha1(self, file_id, path, sha1):
251
"""Tell the tree we have observed a paths sha1.
253
The intent of this function is to allow trees that have a hashcache to
254
update the hashcache during commit. If the observed file is too new to
255
be safely hash-cached the tree will ignore it; this will likewise mean
256
that a file changed subsequent to the file's being read and sha'd will
257
not lead to a false cache entry. A file move could cause this, and
258
in future work it would be better to pass the cache fingerprint around
259
so that its never separated from the sha, and we can supply the
260
fingerprint back to the tree during this code path.
262
The default implementation does nothing.
264
:param file_id: The file id
265
:param path: The file path
266
:param sha1: The sha 1 that was observed.
271
def put_file_bytes_non_atomic(self, file_id, bytes):
272
"""Update the content of a file in the tree.
274
Note that the file is written in-place rather than being
275
written to a temporary location and renamed. As a consequence,
276
readers can potentially see the file half-written.
278
:param file_id: file-id of the file
279
:param bytes: the new file contents
281
raise NotImplementedError(self.put_file_bytes_non_atomic)
283
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
284
"""Set the parents ids of the working tree.
286
:param revision_ids: A list of revision_ids.
288
raise NotImplementedError(self.set_parent_ids)
290
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
291
"""Set the parents of the working tree.
293
:param parents_list: A list of (revision_id, tree) tuples.
294
If tree is None, then that element is treated as an unreachable
295
parent tree - i.e. a ghost.
297
raise NotImplementedError(self.set_parent_trees)
299
@needs_tree_write_lock
300
def smart_add(self, file_list, recurse=True, action=None, save=True):
301
"""Version file_list, optionally recursing into directories.
303
This is designed more towards DWIM for humans than API clarity.
304
For the specific behaviour see the help for cmd_add().
306
:param action: A reporter to be called with the inventory, parent_ie,
307
path and kind of the path being added. It may return a file_id if
308
a specific one should be used.
309
:param save: Save the inventory after completing the adds. If False
310
this provides dry-run functionality by doing the add and not saving
312
:return: A tuple - files_added, ignored_files. files_added is the count
313
of added files, and ignored_files is a dict mapping files that were
314
ignored to the rule that caused them to be ignored.
316
# not in an inner loop; and we want to remove direct use of this,
317
# so here as a reminder for now. RBC 20070703
318
from bzrlib.inventory import InventoryEntry
320
action = add.AddAction()
323
# no paths supplied: add the entire tree.
325
# mutter("smart add of %r")
332
# validate user file paths and convert all paths to tree
333
# relative : it's cheaper to make a tree relative path an abspath
334
# than to convert an abspath to tree relative.
335
for filepath in file_list:
336
rf = _FastPath(self.relpath(filepath))
337
# validate user parameters. Our recursive code avoids adding new files
338
# that need such validation
339
if self.is_control_filename(rf.raw_path):
340
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
342
abspath = self.abspath(rf.raw_path)
343
kind = osutils.file_kind(abspath)
344
if kind == 'directory':
345
# schedule the dir for scanning
348
if not InventoryEntry.versionable_kind(kind):
349
raise errors.BadFileKindError(filename=abspath, kind=kind)
350
# ensure the named path is added, so that ignore rules in the later directory
352
# we dont have a parent ie known yet.: use the relatively slower inventory
354
versioned = inv.has_filename(rf.raw_path)
357
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
360
# no need to walk any directories at all.
361
if len(added) > 0 and save:
362
self._write_inventory(inv)
363
return added, ignored
365
# only walk the minimal parents needed: we have user_dirs to override
369
is_inside = osutils.is_inside_or_parent_of_any
370
for path in sorted(user_dirs):
371
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
372
dirs_to_add.append((path, None))
373
prev_dir = path.raw_path
375
# dirs_to_add is initialised to a list of directories, but as we scan
376
# directories we append files to it.
377
# XXX: We should determine kind of files when we scan them rather than
378
# adding to this list. RBC 20070703
379
for directory, parent_ie in dirs_to_add:
380
# directory is tree-relative
381
abspath = self.abspath(directory.raw_path)
383
# get the contents of this directory.
385
# find the kind of the path being added.
386
kind = osutils.file_kind(abspath)
388
if not InventoryEntry.versionable_kind(kind):
389
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
392
if parent_ie is not None:
393
versioned = directory.base_path in parent_ie.children
395
# without the parent ie, use the relatively slower inventory
397
versioned = inv.has_filename(directory.raw_path)
399
if kind == 'directory':
401
sub_branch = bzrdir.BzrDir.open(abspath)
403
except errors.NotBranchError:
405
except errors.UnsupportedFormatError:
410
if directory.raw_path == '':
411
# mutter("tree root doesn't need to be added")
415
# mutter("%r is already versioned", abspath)
417
# XXX: This is wrong; people *might* reasonably be trying to add
418
# subtrees as subtrees. This should probably only be done in formats
419
# which can represent subtrees, and even then perhaps only when
420
# the user asked to add subtrees. At the moment you can add them
421
# specially through 'join --reference', which is perhaps
422
# reasonable: adding a new reference is a special operation and
423
# can have a special behaviour. mbp 20070306
424
mutter("%r is a nested bzr tree", abspath)
426
_add_one(self, inv, parent_ie, directory, kind, action)
427
added.append(directory.raw_path)
429
if kind == 'directory' and not sub_tree:
430
if parent_ie is not None:
432
this_ie = parent_ie.children[directory.base_path]
434
# without the parent ie, use the relatively slower inventory
436
this_id = inv.path2id(directory.raw_path)
440
this_ie = inv[this_id]
442
for subf in sorted(os.listdir(abspath)):
443
# here we could use TreeDirectory rather than
444
# string concatenation.
445
subp = osutils.pathjoin(directory.raw_path, subf)
446
# TODO: is_control_filename is very slow. Make it faster.
447
# TreeDirectory.is_control_filename could also make this
448
# faster - its impossible for a non root dir to have a
450
if self.is_control_filename(subp):
451
mutter("skip control directory %r", subp)
452
elif subf in this_ie.children:
453
# recurse into this already versioned subdir.
454
dirs_to_add.append((_FastPath(subp, subf), this_ie))
456
# user selection overrides ignoes
457
# ignore while selecting files - if we globbed in the
458
# outer loop we would ignore user files.
459
ignore_glob = self.is_ignored(subp)
460
if ignore_glob is not None:
461
# mutter("skip ignored sub-file %r", subp)
462
ignored.setdefault(ignore_glob, []).append(subp)
464
#mutter("queue to add sub-file %r", subp)
465
dirs_to_add.append((_FastPath(subp, subf), this_ie))
469
self._write_inventory(inv)
471
self.read_working_inventory()
472
return added, ignored
474
def update_basis_by_delta(self, new_revid, delta):
475
"""Update the parents of this tree after a commit.
477
This gives the tree one parent, with revision id new_revid. The
478
inventory delta is applied to the current basis tree to generate the
479
inventory for the parent new_revid, and all other parent trees are
482
All the changes in the delta should be changes synchronising the basis
483
tree with some or all of the working tree, with a change to a directory
484
requiring that its contents have been recursively included. That is,
485
this is not a general purpose tree modification routine, but a helper
486
for commit which is not required to handle situations that do not arise
489
:param new_revid: The new revision id for the trees parent.
490
:param delta: An inventory delta (see apply_inventory_delta) describing
491
the changes from the current left most parent revision to new_revid.
493
# if the tree is updated by a pull to the branch, as happens in
494
# WorkingTree2, when there was no separation between branch and tree,
495
# then just clear merges, efficiency is not a concern for now as this
496
# is legacy environments only, and they are slow regardless.
497
if self.last_revision() == new_revid:
498
self.set_parent_ids([new_revid])
500
# generic implementation based on Inventory manipulation. See
501
# WorkingTree classes for optimised versions for specific format trees.
502
basis = self.basis_tree()
504
inventory = basis.inventory
506
inventory.apply_delta(delta)
507
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
508
self.set_parent_trees([(new_revid, rev_tree)])
511
class MutableTreeHooks(hooks.Hooks):
512
"""A dictionary mapping a hook name to a list of callables for mutabletree
517
"""Create the default hooks.
520
hooks.Hooks.__init__(self)
521
# Invoked before a commit is done in a tree. New in 1.4
522
self['start_commit'] = []
525
# install the default hooks into the MutableTree class.
526
MutableTree.hooks = MutableTreeHooks()
529
class _FastPath(object):
530
"""A path object with fast accessors for things like basename."""
532
__slots__ = ['raw_path', 'base_path']
534
def __init__(self, path, base_path=None):
535
"""Construct a FastPath from path."""
536
if base_path is None:
537
self.base_path = osutils.basename(path)
539
self.base_path = base_path
542
def __cmp__(self, other):
543
return cmp(self.raw_path, other.raw_path)
546
return hash(self.raw_path)
549
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
550
"""Add a new entry to the inventory and automatically add unversioned parents.
552
:param inv: Inventory which will receive the new entry.
553
:param parent_ie: Parent inventory entry if known, or None. If
554
None, the parent is looked up by name and used if present, otherwise it
555
is recursively added.
556
:param kind: Kind of new entry (file, directory, etc)
557
:param action: callback(inv, parent_ie, path, kind); return ignored.
558
:return: A list of paths which have been added.
560
# Nothing to do if path is already versioned.
561
# This is safe from infinite recursion because the tree root is
563
if parent_ie is not None:
564
# we have a parent ie already
567
# slower but does not need parent_ie
568
if inv.has_filename(path.raw_path):
570
# its really not there : add the parent
571
# note that the dirname use leads to some extra str copying etc but as
572
# there are a limited number of dirs we can be nested under, it should
573
# generally find it very fast and not recurse after that.
574
added = _add_one_and_parent(tree, inv, None,
575
_FastPath(dirname(path.raw_path)), 'directory', action)
576
parent_id = inv.path2id(dirname(path.raw_path))
577
parent_ie = inv[parent_id]
578
_add_one(tree, inv, parent_ie, path, kind, action)
579
return added + [path.raw_path]
582
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
583
"""Add a new entry to the inventory.
585
:param inv: Inventory which will receive the new entry.
586
:param parent_ie: Parent inventory entry.
587
:param kind: Kind of new entry (file, directory, etc)
588
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
589
file_id or None to generate a new file id
592
file_id = file_id_callback(inv, parent_ie, path, kind)
593
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
