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
assert(ids is None or isinstance(ids, basestring))
100
assert(kinds is None or isinstance(kinds, basestring))
104
if kinds is not None:
107
files = [path.strip('/') for path in files]
110
ids = [None] * len(files)
112
assert(len(ids) == len(files))
114
kinds = [None] * len(files)
116
assert(len(kinds) == len(files))
118
# generic constraint checks:
119
if self.is_control_filename(f):
120
raise errors.ForbiddenControlFileError(filename=f)
122
# fill out file kinds for all files [not needed when we stop
123
# caring about the instantaneous file kind within a uncommmitted tree
125
self._gather_kinds(files, kinds)
126
self._add(files, ids, kinds)
128
def add_reference(self, sub_tree):
129
"""Add a TreeReference to the tree, pointing at sub_tree"""
130
raise errors.UnsupportedOperation(self.add_reference, self)
132
def _add_reference(self, sub_tree):
133
"""Standard add_reference implementation, for use by subclasses"""
135
sub_tree_path = self.relpath(sub_tree.basedir)
136
except errors.PathNotChild:
137
raise errors.BadReferenceTarget(self, sub_tree,
138
'Target not inside tree.')
139
sub_tree_id = sub_tree.get_root_id()
140
if sub_tree_id == self.get_root_id():
141
raise errors.BadReferenceTarget(self, sub_tree,
142
'Trees have the same root id.')
143
if sub_tree_id in self.inventory:
144
raise errors.BadReferenceTarget(self, sub_tree,
145
'Root id already present in tree')
146
self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
148
def _add(self, files, ids, kinds):
149
"""Helper function for add - updates the inventory.
151
:param files: sequence of pathnames, relative to the tree root
152
:param ids: sequence of suggested ids for the files (may be None)
153
:param kinds: sequence of inventory kinds of the files (i.e. may
154
contain "tree-reference")
156
raise NotImplementedError(self._add)
158
@needs_tree_write_lock
159
def apply_inventory_delta(self, changes):
160
"""Apply changes to the inventory as an atomic operation.
162
:param changes: An inventory delta to apply to the working tree's
165
:seealso Inventory.apply_delta: For details on the changes parameter.
169
inv.apply_delta(changes)
170
self._write_inventory(inv)
173
def commit(self, message=None, revprops=None, *args,
175
# avoid circular imports
176
from bzrlib import commit
179
if not 'branch-nick' in revprops:
180
revprops['branch-nick'] = self.branch.nick
181
author = kwargs.pop('author', None)
182
if author is not None:
183
assert 'author' not in revprops
184
revprops['author'] = author
185
# args for wt.commit start at message from the Commit.commit method,
186
args = (message, ) + args
187
for hook in MutableTree.hooks['start_commit']:
189
committed_id = commit.Commit().commit(working_tree=self,
190
revprops=revprops, *args, **kwargs)
193
def _gather_kinds(self, files, kinds):
194
"""Helper function for add - sets the entries of kinds."""
195
raise NotImplementedError(self._gather_kinds)
198
def last_revision(self):
199
"""Return the revision id of the last commit performed in this tree.
201
In early tree formats the result of last_revision is the same as the
202
branch last_revision, but that is no longer the case for modern tree
205
last_revision returns the left most parent id, or None if there are no
208
last_revision was deprecated as of 0.11. Please use get_parent_ids
211
raise NotImplementedError(self.last_revision)
213
def lock_tree_write(self):
214
"""Lock the working tree for write, and the branch for read.
216
This is useful for operations which only need to mutate the working
217
tree. Taking out branch write locks is a relatively expensive process
218
and may fail if the branch is on read only media. So branch write locks
219
should only be taken out when we are modifying branch data - such as in
220
operations like commit, pull, uncommit and update.
222
raise NotImplementedError(self.lock_tree_write)
224
def lock_write(self):
225
"""Lock the tree and its branch. This allows mutating calls to be made.
227
Some mutating methods will take out implicit write locks, but in
228
general you should always obtain a write lock before calling mutating
231
raise NotImplementedError(self.lock_write)
234
def mkdir(self, path, file_id=None):
235
"""Create a directory in the tree. if file_id is None, one is assigned.
237
:param path: A unicode file path.
238
:param file_id: An optional file-id.
239
:return: the file id of the new directory.
241
raise NotImplementedError(self.mkdir)
244
def put_file_bytes_non_atomic(self, file_id, bytes):
245
"""Update the content of a file in the tree.
247
Note that the file is written in-place rather than being
248
written to a temporary location and renamed. As a consequence,
249
readers can potentially see the file half-written.
251
:param file_id: file-id of the file
252
:param bytes: the new file contents
254
raise NotImplementedError(self.put_file_bytes_non_atomic)
256
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
257
"""Set the parents ids of the working tree.
259
:param revision_ids: A list of revision_ids.
261
raise NotImplementedError(self.set_parent_ids)
263
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
264
"""Set the parents of the working tree.
266
:param parents_list: A list of (revision_id, tree) tuples.
267
If tree is None, then that element is treated as an unreachable
268
parent tree - i.e. a ghost.
270
raise NotImplementedError(self.set_parent_trees)
272
@needs_tree_write_lock
273
def smart_add(self, file_list, recurse=True, action=None, save=True):
274
"""Version file_list, optionally recursing into directories.
276
This is designed more towards DWIM for humans than API clarity.
277
For the specific behaviour see the help for cmd_add().
279
:param action: A reporter to be called with the inventory, parent_ie,
280
path and kind of the path being added. It may return a file_id if
281
a specific one should be used.
282
:param save: Save the inventory after completing the adds. If False
283
this provides dry-run functionality by doing the add and not saving
285
:return: A tuple - files_added, ignored_files. files_added is the count
286
of added files, and ignored_files is a dict mapping files that were
287
ignored to the rule that caused them to be ignored.
289
# not in an inner loop; and we want to remove direct use of this,
290
# so here as a reminder for now. RBC 20070703
291
from bzrlib.inventory import InventoryEntry
292
assert isinstance(recurse, bool)
294
action = add.AddAction()
297
# no paths supplied: add the entire tree.
299
# mutter("smart add of %r")
306
# validate user file paths and convert all paths to tree
307
# relative : it's cheaper to make a tree relative path an abspath
308
# than to convert an abspath to tree relative.
309
for filepath in file_list:
310
rf = _FastPath(self.relpath(filepath))
311
# validate user parameters. Our recursive code avoids adding new files
312
# that need such validation
313
if self.is_control_filename(rf.raw_path):
314
raise errors.ForbiddenControlFileError(filename=rf.raw_path)
316
abspath = self.abspath(rf.raw_path)
317
kind = osutils.file_kind(abspath)
318
if kind == 'directory':
319
# schedule the dir for scanning
322
if not InventoryEntry.versionable_kind(kind):
323
raise errors.BadFileKindError(filename=abspath, kind=kind)
324
# ensure the named path is added, so that ignore rules in the later directory
326
# we dont have a parent ie known yet.: use the relatively slower inventory
328
versioned = inv.has_filename(rf.raw_path)
331
added.extend(_add_one_and_parent(self, inv, None, rf, kind, action))
334
# no need to walk any directories at all.
335
if len(added) > 0 and save:
336
self._write_inventory(inv)
337
return added, ignored
339
# only walk the minimal parents needed: we have user_dirs to override
343
is_inside = osutils.is_inside_or_parent_of_any
344
for path in sorted(user_dirs):
345
if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
346
dirs_to_add.append((path, None))
347
prev_dir = path.raw_path
349
# dirs_to_add is initialised to a list of directories, but as we scan
350
# directories we append files to it.
351
# XXX: We should determine kind of files when we scan them rather than
352
# adding to this list. RBC 20070703
353
for directory, parent_ie in dirs_to_add:
354
# directory is tree-relative
355
abspath = self.abspath(directory.raw_path)
357
# get the contents of this directory.
359
# find the kind of the path being added.
360
kind = osutils.file_kind(abspath)
362
if not InventoryEntry.versionable_kind(kind):
363
warning("skipping %s (can't add file of kind '%s')", abspath, kind)
366
if parent_ie is not None:
367
versioned = directory.base_path in parent_ie.children
369
# without the parent ie, use the relatively slower inventory
371
versioned = inv.has_filename(directory.raw_path)
373
if kind == 'directory':
375
sub_branch = bzrdir.BzrDir.open(abspath)
377
except errors.NotBranchError:
379
except errors.UnsupportedFormatError:
384
if directory.raw_path == '':
385
# mutter("tree root doesn't need to be added")
389
# mutter("%r is already versioned", abspath)
391
# XXX: This is wrong; people *might* reasonably be trying to add
392
# subtrees as subtrees. This should probably only be done in formats
393
# which can represent subtrees, and even then perhaps only when
394
# the user asked to add subtrees. At the moment you can add them
395
# specially through 'join --reference', which is perhaps
396
# reasonable: adding a new reference is a special operation and
397
# can have a special behaviour. mbp 20070306
398
mutter("%r is a nested bzr tree", abspath)
400
_add_one(self, inv, parent_ie, directory, kind, action)
401
added.append(directory.raw_path)
403
if kind == 'directory' and not sub_tree:
404
if parent_ie is not None:
406
this_ie = parent_ie.children[directory.base_path]
408
# without the parent ie, use the relatively slower inventory
410
this_id = inv.path2id(directory.raw_path)
414
this_ie = inv[this_id]
416
for subf in sorted(os.listdir(abspath)):
417
# here we could use TreeDirectory rather than
418
# string concatenation.
419
subp = osutils.pathjoin(directory.raw_path, subf)
420
# TODO: is_control_filename is very slow. Make it faster.
421
# TreeDirectory.is_control_filename could also make this
422
# faster - its impossible for a non root dir to have a
424
if self.is_control_filename(subp):
425
mutter("skip control directory %r", subp)
426
elif subf in this_ie.children:
427
# recurse into this already versioned subdir.
428
dirs_to_add.append((_FastPath(subp, subf), this_ie))
430
# user selection overrides ignoes
431
# ignore while selecting files - if we globbed in the
432
# outer loop we would ignore user files.
433
ignore_glob = self.is_ignored(subp)
434
if ignore_glob is not None:
435
# mutter("skip ignored sub-file %r", subp)
436
ignored.setdefault(ignore_glob, []).append(subp)
438
#mutter("queue to add sub-file %r", subp)
439
dirs_to_add.append((_FastPath(subp, subf), this_ie))
443
self._write_inventory(inv)
445
self.read_working_inventory()
446
return added, ignored
448
def update_basis_by_delta(self, new_revid, delta):
449
"""Update the parents of this tree after a commit.
451
This gives the tree one parent, with revision id new_revid. The
452
inventory delta is applied to the current basis tree to generate the
453
inventory for the parent new_revid, and all other parent trees are
456
All the changes in the delta should be changes synchronising the basis
457
tree with some or all of the working tree, with a change to a directory
458
requiring that its contents have been recursively included. That is,
459
this is not a general purpose tree modification routine, but a helper
460
for commit which is not required to handle situations that do not arise
463
:param new_revid: The new revision id for the trees parent.
464
:param delta: An inventory delta (see apply_inventory_delta) describing
465
the changes from the current left most parent revision to new_revid.
467
# if the tree is updated by a pull to the branch, as happens in
468
# WorkingTree2, when there was no separation between branch and tree,
469
# then just clear merges, efficiency is not a concern for now as this
470
# is legacy environments only, and they are slow regardless.
471
if self.last_revision() == new_revid:
472
self.set_parent_ids([new_revid])
474
# generic implementation based on Inventory manipulation. See
475
# WorkingTree classes for optimised versions for specific format trees.
476
basis = self.basis_tree()
478
inventory = basis.inventory
480
inventory.apply_delta(delta)
481
rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
482
self.set_parent_trees([(new_revid, rev_tree)])
485
class MutableTreeHooks(hooks.Hooks):
486
"""A dictionary mapping a hook name to a list of callables for mutabletree
491
"""Create the default hooks.
494
hooks.Hooks.__init__(self)
495
# Invoked before a commit is done in a tree. New in 1.4
496
self['start_commit'] = []
499
# install the default hooks into the MutableTree class.
500
MutableTree.hooks = MutableTreeHooks()
503
class _FastPath(object):
504
"""A path object with fast accessors for things like basename."""
506
__slots__ = ['raw_path', 'base_path']
508
def __init__(self, path, base_path=None):
509
"""Construct a FastPath from path."""
510
if base_path is None:
511
self.base_path = osutils.basename(path)
513
self.base_path = base_path
516
def __cmp__(self, other):
517
return cmp(self.raw_path, other.raw_path)
520
return hash(self.raw_path)
523
def _add_one_and_parent(tree, inv, parent_ie, path, kind, action):
524
"""Add a new entry to the inventory and automatically add unversioned parents.
526
:param inv: Inventory which will receive the new entry.
527
:param parent_ie: Parent inventory entry if known, or None. If
528
None, the parent is looked up by name and used if present, otherwise it
529
is recursively added.
530
:param kind: Kind of new entry (file, directory, etc)
531
:param action: callback(inv, parent_ie, path, kind); return ignored.
532
:return: A list of paths which have been added.
534
# Nothing to do if path is already versioned.
535
# This is safe from infinite recursion because the tree root is
537
if parent_ie is not None:
538
# we have a parent ie already
541
# slower but does not need parent_ie
542
if inv.has_filename(path.raw_path):
544
# its really not there : add the parent
545
# note that the dirname use leads to some extra str copying etc but as
546
# there are a limited number of dirs we can be nested under, it should
547
# generally find it very fast and not recurse after that.
548
added = _add_one_and_parent(tree, inv, None,
549
_FastPath(dirname(path.raw_path)), 'directory', action)
550
parent_id = inv.path2id(dirname(path.raw_path))
551
parent_ie = inv[parent_id]
552
_add_one(tree, inv, parent_ie, path, kind, action)
553
return added + [path.raw_path]
556
def _add_one(tree, inv, parent_ie, path, kind, file_id_callback):
557
"""Add a new entry to the inventory.
559
:param inv: Inventory which will receive the new entry.
560
:param parent_ie: Parent inventory entry.
561
:param kind: Kind of new entry (file, directory, etc)
562
:param file_id_callback: callback(inv, parent_ie, path, kind); return a
563
file_id or None to generate a new file id
566
file_id = file_id_callback(inv, parent_ie, path, kind)
567
entry = inv.make_entry(kind, path.base_path, parent_ie.file_id,
added
removed
bzrlib/mutabletree.py
